# -*- coding: utf-8 -*-

"""

Script to welcome new users. This script works out of the box for Wikis that

have been defined in the script. It is currently used on the Dutch, Norwegian,

Albanian, Italian Wikipedia, Wikimedia Commons and English Wikiquote.

Note: You can download the latest version available

from here: http://botwiki.sno.cc/wiki/Python:Welcome.py

Ensure you have community support before running this bot!

URLs to current implementations:

* Wikimedia Commons: http://commons.wikimedia.org/wiki/Commons:Welcome_log

* Dutch Wikipedia: http://nl.wikipedia.org/wiki/Wikipedia:Logboek_welkom

* Italian Wikipedia: http://it.wikipedia.org/wiki/Wikipedia:Benvenuto_log

* English Wikiquote: http://en.wikiquote.org/wiki/Wikiquote:Welcome_log

* Persian Wikipedia: http://fa.wikipedia.org/wiki/ویکی‌پدیا:سیاهه_خوشامد

* Korean Wikipedia: http://ko.wikipedia.org/wiki/위키백과:Welcome_log

Everything that needs customisation to support additional projects is

indicated by comments.

Description of basic functionality:

* Request a list of new users every period (default: 3600 seconds)

You can choose to break the script after the first check (see arguments)

* Check if new user has passed a threshold for a number of edits

(default: 1 edit)

* Optional: check username for bad words in the username or if the username

consists solely of numbers; log this somewhere on the wiki (default: False)

Update: Added a whitelist (explanation below).

* If user has made enough edits (it can be also 0), check if user has an empty

talk page

* If user has an empty talk page, add a welcome message.

* Optional: Once the set number of users have been welcomed, add this to the

configured log page, one for each day (default: True)

* If no log page exists, create a header for the log page first.

This script (by default not yet implemented) uses two templates that need to

be on the local wiki:

* {{WLE}}: contains mark up code for log entries (just copy it from Commons)

* {{welcome}}: contains the information for new users

This script understands the following command-line arguments:

-edit[:#] Define how many edits a new user needs to be welcomed

(default: 1, max: 50)

-time[:#] Define how many seconds the bot sleeps before restart

(default: 3600)

-break Use it if you don't want that the Bot restart at the end

(it will break) (default: False)

-nlog Use this parameter if you do not want the bot to log all

welcomed users (default: False)

-limit[:#] Use this parameter to define how may users should be

checked (default:50)

-offset[:TIME] Skip the latest new users (those newer than TIME)

to give interactive users a chance to welcome the

new users (default: now)

Timezone is the server timezone, GMT for Wikimedia

TIME format : yyyymmddhhmmss

-timeoffset[:#] Skip the latest new users, accounts newer than

# minutes

-numberlog[:#] The number of users to welcome before refreshing the

welcome log (default: 4)

-filter Enable the username checks for bad names (default: False)

-ask Use this parameter if you want to confirm each possible

bad username (default: False)

-random Use a random signature, taking the signatures from a wiki

page (for instruction, see below).

-file[:#] Use a file instead of a wikipage to take the random sign.

If you use this parameter, you don't need to use -random.

-sign Use one signature from command line instead of the default

-savedata This feature saves the random signature index to allow to

continue to welcome with the last signature used.

-sul Welcome the auto-created users (default: False)

-quiet Prevents users without contributions are displayed

-quick Provide quick check by API bulk-retrieve user datas

********************************* GUIDE ***********************************

Report, Bad and white list guide:

1) Set in the code which page it will use to load the badword, the

whitelist and the report

2) In these page you have to add a "tuple" with the names that you want to

add in the two list. For example: ('cat', 'mouse', 'dog')

You can write also other text in the page, it will work without problem.

3) What will do the two pages? Well, the Bot will check if a badword is in

the username and set the "warning" as True. Then the Bot check if a word

of the whitelist is in the username. If yes it remove the word and

recheck in the bad word list to see if there are other badword in the

username.

Example:

* dio is a badword

* Claudio is a normal name

* The username is "Claudio90 fuck!"

* The Bot find dio and set "warning"

* The Bot find Claudio and set "ok"

* The Bot find fuck at the end and set "warning"

* Result: The username is reported.

4) When a user is reported you have to check him and do:

* If he's ok, put the {{welcome}}

* If he's not, block him

* You can decide to put a "you are blocked, change another username"

template or not.

* Delete the username from the page.

IMPORTANT : The Bot check the user in this order:

* Search if he has a talkpage (if yes, skip)

* Search if he's blocked, if yes he will be skipped

* Search if he's in the report page, if yes he will be skipped

* If no, he will be reported.

Random signature guide:

Some welcomed users will answer to the one who has signed the welcome message.

When you welcome many new users, you might be overwhelmed with such answers.

Therefore you can define usernames of other users who are willing to receive

some of these messages from newbies.

1) Set the page that the bot will load

2) Add the signatures in this way:

*<SPACE>SIGNATURE

<NEW LINE>

Example:

<pre>

* [[User:Filnik|Filnik]]

* [[User:Rock|Rock]]

</pre>

NOTE: The white space and <pre></pre> aren't required but I suggest you to

use them.

*************************** Known issues/FIXMEs ****************************

* *

* The regex to load the user might be slightly different from project to *

* project. (In this case, write to Filnik or the PWRF for help...) *

* Use a class to group toghether the functions used. *

* *

******************************** Badwords **********************************

The list of Badwords of the code is opened. If you think that a word is

international and it must be blocked in all the projects feel free to add it.

If also you think that a word isn't so international, feel free to delete it.

However, there is a dinamic-wikipage to load that badwords of your project or

you can add them directly in the source code that you are using without adding

or deleting.

Some words, like "Administrator" or "Dio" (God in italian) or "Jimbo" aren't

badword at all but can be used for some bad-nickname.

"""

#

# (C) Alfio, 2005

# (C) Kyle/Orgullomoore, 2006-2007

# (C) Siebrand Mazeland, 2006-2007

# (C) Filnik, 2007-2010

# (C) Daniel Herding, 2007

# (C) Alex Shih-Han Lin, 2009

# (C) xqt, 2009-2011

#

# Distributed under the terms of the MIT license.

#

__version__ = '$Id: welcome.py 9418 2011-07-21 16:45:20Z filnik $'

#

import time, re, urllib, locale

import codecs

from datetime import timedelta

from random import choice

from string import capitalize

import wikipedia as pywikibot

from pywikibot import i18n

import config, query, userlib

locale.setlocale(locale.LC_ALL, '')

# Script users the class pywikibot.translate() to find the right

# page/user/summary/etc so the need to specify language and project have

# been eliminated.

# FIXME: Not all language/project combinations have been defined yet.

# Add the following strings to customise for a language:

# logbook, talk_page, netext, user, con, report_page

# bad_pag, report_text, logt, random_sign and whitelist_pg.

############################################################################

############################################################################

############################################################################

# The text below are dictionaries. Copy the 'en' line, change 'en' in your

# language (e.g. 'de') and modify/translate the text.

# The page where the bot will save the log (e.g. Wikipedia:Welcome log).

#

# ATTENTION: "Log disabled comment is listed the projects not to log welcomed users, and no necessary to set deatils.

logbook = {

}

# The text for the welcome message (e.g. {{welcome}}) and %s at the end

# that is your signature (the bot has a random parameter to add different

# sign, so in this way it will change according to your parameters).

netext = {

}

# The page where the bot will report users with a possibly bad username.

report_page = {

}

# The page where the bot reads the real-time bad words page

# (this parameter is optional).

bad_pag = {

}

timeselected = u' ~~~~~' # Defining the time used after the signature

# The text for reporting a possibly bad username (e.g. *[[Talk_page:Username|Username]]).

report_text = {

}

# Set where you load your list of signatures that the bot will load if you use

# the random argument (this parameter is optional).

random_sign = {

}

# The page where the bot reads the real-time whitelist page.

# (this parameter is optional).

whitelist_pg = {

}

# Text after the {{welcome}} template, if you want to add something

# Default (en): nothing.

final_new_text_additions = {

'it':u'\n<!-- fine template di benvenuto -->',

'zh':'<small>(via ~~~)</small>',

}

#

#

logpage_header = {

}

# Ok, that's all. What is below, is the rest of code, now the code is fixed

# and it will run correctly in your project ;)

############################################################################

############################################################################

############################################################################

class FilenameNotSet(pywikibot.Error):

"""An exception indicating that a signature filename was not specifed."""

class Global(object):

#fileOption = False # check if the user wants to use a file or the wikipage

class WelcomeBot(object):

# self._checkQueue = []

def showStatus(n = 0):

pywikibot.output("\03{%s}[%s]\03{default} " % (staColor[n], staMsg[n]) , newline = False)

def load_word_function(raw):

return list_loaded

globalvar = Global()

if __name__ == "__main__":

try:

number_user = 0

for arg in pywikibot.handleArgs():

if arg.startswith('-edit'):

if len(arg) == 5:

globalvar.attachEditCount = int(pywikibot.input(u'After how many edits would you like to welcome new users? (0 is allowed)'))

else:

globalvar.attachEditCount = int(arg[6:])

elif arg.startswith('-timeoffset'):

if len(arg) == 11:

globalvar.timeoffset = int(pywikibot.input(u'Which time offset (in minutest) for new users would you like to use?'))

else:

globalvar.timeoffset = int(arg[12:])

elif arg.startswith('-time'):

if len(arg) == 5:

globalvar.timeRecur = int(pywikibot.input(u'For how many seconds would you like to bot to sleep before checking again?'))

else:

globalvar.timeRecur = int(arg[6:])

elif arg.startswith('-offset'):

if len(arg) == 7:

globalvar.offset = int(pywikibot.input(u'Which time offset for new users would you like to use? (yyyymmddhhmmss)'))

else:

globalvar.offset = int(arg[8:])

if len(str(globalvar.offset)) != 14:

# upon request, we might want to check for software version here

raise ValueError("Mediawiki has changed, -offset:# is not supported anymore, but -offset:TIMESTAMP is, assuming TIMESTAMP is yyyymmddhhmmss. -timeoffset is now also supported. Please read this script source header for documentation.")

elif arg.startswith('-file:'):

globalvar.randomSign = True

if len(arg) == 6:

globalvar.signFileName = pywikibot.input(u'Where have you saved your signatures?')

else:

globalvar.signFileName = arg[6:]

elif arg.startswith('-sign:'):

if len(arg) == 6:

globalvar.defaultSign = pywikibot.input(u'Which signature to use?')

else:

globalvar.defaultSign = arg[6:]

globalvar.defaultSign += timeselected

elif arg == '-break':

globalvar.recursive = False

elif arg == '-nlog':

globalvar.makeWelcomeLog = False

elif arg == '-ask':

globalvar.confirm = True

elif arg == '-filter':

globalvar.filtBadName = True

#elif arg == '-savedata':

# globalvar.saveSignIndex = True

elif arg == '-random':

globalvar.randomSign = True

elif arg == '-sul':

globalvar.welcomeAuto = True

elif arg.startswith('-limit'):

if len(arg) == 6:

globalvar.queryLimit = int(pywikibot.input(u'How many of the latest new users would you like to load?'))

else:

globalvar.queryLimit = int(arg[7:])

elif arg.startswith('-numberlog'):

if len(arg) == 10:

globalvar.dumpToLog = int(pywikibot.input(u'After how many welcomed users would you like to update the welcome log?'))

else:

globalvar.dumpToLog = int(arg[11:])

elif arg == '-quiet':

globalvar.quiet = True

elif arg == '-quick':

globalvar.quick = True

# Filename and pywikipedia path

# file where is stored the random signature index

filename = pywikibot.config.datafilepath('welcome-%s-%s.data' % (pywikibot.default_family, pywikibot.default_code))

if globalvar.offset and globalvar.timeoffset:

pywikibot.output('WARING: both -offset and -timeoffset were provided, ignoring -offset')

globalvar.offset = 0

bot = WelcomeBot()

try:

bot.run()

except KeyboardInterrupt:

if bot.welcomed_users:

showStatus()

pywikibot.output("Put welcomed users before quit...")

bot.makelogpage(bot.welcomed_users)

pywikibot.output("\nQuitting...")

finally:

# If there is the savedata, the script must save the number_user.

if globalvar.randomSign and globalvar.saveSignIndex and bot.welcomed_users:

import cPickle

f = file(filename, 'w')

cPickle.dump(bot.welcomed_users, f)

f.close()

pywikibot.stopme()