# Refer pywikobot.bot for generic bot classes

SingleSiteBot, # A bot only working on one site

# CurrentPageBot, # Sets 'current_page'. Process it in treat_page method.

# # Not needed here because we have subclasses

ExistingPageBot, # CurrentPageBot which only treats existing pages

NoRedirectPageBot, # CurrentPageBot which only treats non-redirects

AutomaticTWSummaryBot, # Automatically defines summary; needs summary_key

):

"""

An incomplete sample bot.

@ivar summary_key: Edit summary message key. The message that should be used

is placed on /i18n subdirectory. The file containing these messages

should have the same name as the caller script (i.e. basic.py in this

case). Use summary_key to set a default edit summary message.

@type summary_key: str

"""

summary_key = 'basic-changing'

results = {}

ranges = [(100,'100+'),

(50,'50-99'),

(40,'40-49'),

(30, '30-39'),

(25, '25-29'),

(22, '22-24'),

(20, '20-21'),

(18, '18-19'),

(16, '16-17'),

(15, '15'),

(14, '14'),

(13, '13'),

(12, '12'),

(11, '11'),

(10, '10'),

(5, '5+'),

]

def __init__(self, generator, **kwargs):

"""

Constructor.

@param generator: the page generator that determines on which pages

to work

@type generator: generator

"""

# Add your own options to the bot and set their defaults

# -always option is predefined by BaseBot class

self.availableOptions.update({

'replace': False, # delete old text and write the new text

'summary': None, # your own bot summary

'text': 'Test', # add this text from option. 'Test' is default

'top': False, # append text on top of the page

'outpage': u'User:mastiBot/test', #default output page

'maxlines': 1000, #default number of entries per page

'testprint': False, # print testoutput

'negative': False, #if True negate behavior i.e. mark pages that DO NOT contain search string

'test': False, #test printouts

'testlinks': False, #test printouts

'progress': False, #show progress

'resprogress': False, #show progress in generating results

'minlinks': 50, #print only >minlinks results

'reset': False, #reset saved data

})

# call constructor of the super class

super(BasicBot, self).__init__(site=True, **kwargs)

# handle old -dry paramter

self._handle_dry_param(**kwargs)

# assign the generator to the bot

self.generator = generator

if not self.getOption('reset'):

try:

pywikibot.output('READING PICKLE at %s' % datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))

with open('masti/reqlinks.dat', 'rb') as datfile:

self.results = pickle.load(datfile)

except (IOError, EOFError):

# no saved history exists yet, or history dump broken

pywikibot.output('NO SAVED FILE at %s' % datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))

self.results = {}

def _handle_dry_param(self, **kwargs):

"""

Read the dry parameter and set the simulate variable instead.

This is a private method. It prints a deprecation warning for old

-dry paramter and sets the global simulate variable and informs

the user about this setting.

The constuctor of the super class ignores it because it is not

part of self.availableOptions.

@note: You should ommit this method in your own application.

@keyword dry: deprecated option to prevent changes on live wiki.

Use -simulate instead.

@type dry: bool

"""

if 'dry' in kwargs:

issue_deprecation_warning('dry argument',

'pywikibot.config.simulate', 1)

# use simulate variable instead

pywikibot.config.simulate = True

pywikibot.output('config.simulate was set to True')

def run(self):

#prepare new page

# replace @@ with number of pages

header = 'Na tej stronie znajdują się najbardziej potrzebne strony, do których linki pojawiają się na @@ stronach.\n\n'

header += 'Po prawej podana jest liczba dolinkowanych. Niebieskie linki do wycięcia. Czerwone do ewentualnego przenoszenia na podstrony [[Wikipedia:Prpozycje tematów|propozycji tematów]].\n\n'

header += "Ta strona jest okresowo uaktualniana przez [[Wikipedysta:MastiBot|MastiBota]]. Ostatnia aktualizacja przez bota: '''~~~~~'''. \n\n"

header += u'Wszelkie uwagi proszę zgłaszać w [[Dyskusja_Wikipedysty:Masti|dyskusji operatora]].\n\n'

#footer = u'\n\n[[Kategoria:Najbardziej potrzebne strony]]'

footer = ''

counter = 1

refscounter = 0

for page in self.generator:

if self.getOption('progress'):

pywikibot.output(u'%s #%i Treating:%s' % (datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), counter, page.title(asLink=True)) )

refs = self.treat(page)

if refs == 'STOP':

return

if self.getOption('progress'):

pywikibot.output('%s #%i refs found:%i' % (datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), counter, refs))

counter += 1

# pickle before generating result

pywikibot.output('END PICKLING at %s' % datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))

with open('masti/reqlinks.dat', 'wb') as f:

pickle.dump(self.results, f, protocol=config.pickle_protocol)

result = self.generateresultspage(self.results,self.getOption('outpage'),header,footer)

return

def redirCount(self,article):

#return number of linkined redirs

return(article['count'])

def generateresultspage(self, redirlist, pagename, header, footer):

"""

Generates results page from redirlist

Starting with header, ending with footer

Output page is pagename

"""

finalpage = ''

res = sorted(redirlist, key=redirlist.__getitem__, reverse=True)

if self.getOption('test'):

pywikibot.output('***** INPUT *****')

pywikibot.output(redirlist)

pywikibot.output('***** RESULT *****')

pywikibot.output(res)

linkcount = 0

rangenumber = 0

limit,subpage = self.ranges[rangenumber]

for i in res:

count = self.redirCount(redirlist[i])

l = redirlist[i]['list']

if self.getOption('resprogress'):

pywikibot.output('i:[[%s]], count:%i, l:%s' % (i,count,l))

if count < int(self.getOption('minlinks')):

return

while count < limit:

self.savepart(finalpage,subpage,self.getOption('outpage'),header,footer)

rangenumber += 1

limit,subpage = self.ranges[rangenumber]

finalpage = ''

suffix = self.suffix(count)

finalpage += u'\n# [[%s]] ([[Specjalna:Linkujące/%s|%s link%s]]) &larr; [[%s]]' % (i,i,str(count),suffix,']], [['.join(l))

#finalpage += u'\n# [[%s]] ([[Specjalna:Linkujące/%s|%i link%s]])' % (i,i,count,self.suffix(count))

return

def suffix(self,count):

strcount = str(count)

if count == 1:

return('')

elif strcount[len(strcount)-1] in (u'2',u'3',u'4') and (count>20 or count<10) :

return('i')

else:

return('ów')

def savepart(self, body, suffix, pagename, header, footer):

if self.getOption('test'):

pywikibot.output('***** FINALPAGE *****')

pywikibot.output(body)

outpage = pywikibot.Page(pywikibot.Site(), pagename+'/'+suffix)

outpage.text = re.sub(r'@@',suffix,header) + body + footer

outpage.save(summary=self.getOption('summary'))

#if self.getOption('test'):

# pywikibot.output(redirlist)

return

def addResult(self,what,where):

if not where in self.results.keys():

self.results[where] = {'count':0,'list':[]}

self.results[where]['count'] += 1

self.results[where]['list'].append(what)

return

def treat(self, page):

#get all linkedPages

# check for disambigs

linkR = re.compile(ur'\[\[(?P<title>.*?)(#(?P<section>.*?))?(\|(?P<label>.*?))?\]\]')

counter = 0

reqcounter = 0

checkedpages = []

for p in linkR.finditer(textlib.removeDisabledParts(page.text)):

counter += 1

t = p.group('title')

if t in checkedpages or t == '':

continue

try:

rp = pywikibot.Page(pywikibot.Site(),t)

if not rp.namespace()==0:

continue

if self.getOption('testlinks'):

pywikibot.output(u'%s #%i (%i) In %s checking:%s' % (datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), counter, reqcounter,page.title(asLink=True), rp.title(asLink=True)) )

if not rp.exists():

reqcounter += 1

self.addResult(page.title(),rp.title())

checkedpages.append(t)

except KeyboardInterrupt:

pywikibot.output('PICKLING at %s' % datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"))

with open('masti/reqlinks.dat', 'wb') as f:

pickle.dump(self.results, f, protocol=config.pickle_protocol)

return('STOP')

except:

continue

"""

Process command line arguments and invoke bot.

If args is an empty list, sys.argv is used.

@param args: command line arguments

@type args: list of unicode

"""

options = {}

# Process global arguments to determine desired site

local_args = pywikibot.handle_args(args)

# This factory is responsible for processing command line arguments

# that are also used by other scripts and that determine on which pages

# to work on.

genFactory = pagegenerators.GeneratorFactory()

# Parse command line arguments

for arg in local_args:

# Catch the pagegenerators options

if genFactory.handleArg(arg):

continue # nothing to do here

# Now pick up your own options

arg, sep, value = arg.partition(':')

option = arg[1:]

if option in ('summary', 'text', 'outpage', 'maxlines','minlinks'):

if not value:

pywikibot.input('Please enter a value for ' + arg)

options[option] = value

# take the remaining options as booleans.

# You will get a hint if they aren't pre-definded in your bot class

else:

options[option] = True

gen = genFactory.getCombinedGenerator()

if gen:

# The preloading generator is responsible for downloading multiple

# pages from the wiki simultaneously.

gen = pagegenerators.PreloadingGenerator(gen)

# pass generator and private options to the bot

bot = BasicBot(gen, **options)

bot.run() # guess what it does

return True

else:

pywikibot.bot.suggest_help(missing_generator=True)