ms-refsnumber.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
This bot creates pages listing count of references to article from list:
Wikipedysta:Andrzei111/nazwiska z inicjałem

Call: python pwb.py masti/ms-refsnumber.py -page:'Wikipedysta:Andrzei111/nazwiska z inicjałem' -summary:"Bot aktualizuje stronę" -outpage:'Wikipedysta:Andrzei111/nazwiska z inicjałem/licznik'

Use global -simulate option for test purposes. No changes to live wiki
will be done.

The following parameters are supported:

&params;

-always           If used, the bot won't ask if it should file the message
                  onto user talk page.   

-outpage          Results page; otherwise "Wikipedysta:mastiBot/test" is used

-maxlines         Max number of entries before new subpage is created; default 1000

-text:            Use this text to be added; otherwise 'Test' is used

-replace:         Dont add text but replace it

-top              Place additional text on top of the page

-summary:         Set the action summary message for the edit.

-negative:        mark if text not in page
"""
#
# (C) Pywikibot team, 2006-2016
#
# Distributed under the terms of the MIT license.
#
from __future__ import absolute_import, unicode_literals

__version__ = '$Id: c1795dd2fb2de670c0b4bddb289ea9d13b1e9b3f $'
#

import pywikibot
from pywikibot import pagegenerators
from pywikibot import textlib

from pywikibot.bot import (
    SingleSiteBot, ExistingPageBot, NoRedirectPageBot, AutomaticTWSummaryBot)
from pywikibot.tools import issue_deprecation_warning

import re
import datetime
import pickle
from pywikibot import (
    comms, i18n, config, pagegenerators, textlib, config2,
)

# This is required for the text that is shown when you run this script
# with the parameter -help.
docuReplacements = {
    '&params;': pagegenerators.parameterHelp
}


class BasicBot(
    # 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


    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 = 'Lista linkujących do artykułów z listy na stronie [[Wikipedysta:Andrzei111/nazwiska z inicjałem]].\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'

        header += '{| class="wikitable sortable"\n|-\n'
        header += '! Nr !! nazwa !! odwołania !! krótka nazwa !! odwołania\n|-\n'
        #footer = u'\n\n[[Kategoria:Najbardziej potrzebne strony]]'
        footer = '|}\n'

        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)

            counter += 1

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

        return

    def generateresultspage(self, redirlist, pagename, header, footer):
        """
        Generates results page from redirlist
        Starting with header, ending with footer
        Output page is pagename
        """
        finalpage = header
        #res = sorted(redirlist, key=redirlist.__getitem__, reverse=True)
        res = redirlist
        if self.getOption('test'):
            pywikibot.output('***** INPUT *****')
            pywikibot.output(redirlist)
            pywikibot.output('***** RESULT *****')
            pywikibot.output(res)
        linkcount = 0
        for i in res:
            linkcount += 1
            finalpage += "| %i || [[%s]] || %s || [[%s]] || %s\n|-\n" % (linkcount, i['long'], str(i['refl'])+' link'+self.suffix(i['refl']), i['short'], str(i['refs'])+' link'+self.suffix(i['refs']))

        if self.getOption('test'):
            pywikibot.output('***** FINALPAGE *****')
            pywikibot.output(finalpage)

        outpage = pywikibot.Page(pywikibot.Site(), pagename)
        outpage.text = finalpage
        outpage.save(summary=self.getOption('summary'))

        #if self.getOption('test'):
        #    pywikibot.output(redirlist)
        return(res)

    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 treat(self, page):
        #get all linkedPages
        # check for disambigs
        linksR = re.compile('\[\[(?P<short>[^\]]*)\]\] *\|\| *\[\[(?P<long>[^\]]*)\]\]')
        res = []
        counter = 0
        if self.getOption('test'):
            pywikibot.output('Treat(%s)' % page.title(asLink=True))
        for p in linksR.finditer(textlib.removeDisabledParts(page.text)):
            counter += 1
            longn = p.group('long')
            shortn = p.group('short')
            if self.getOption('testlinks'):
                pywikibot.output('[%s][#%i] S:%s L:%s' % (datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), counter, shortn, longn))
            rpl = pywikibot.Page(pywikibot.Site(),longn)
            rplcount = len(list(rpl.getReferences(namespaces=0)))
            if self.getOption('testlinks'):
                pywikibot.output(u'L:%s #%i In %s checking:%s - referenced by %i' % 
                    (datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), counter, page.title(asLink=True), rpl.title(asLink=True), rplcount ))
            rps = pywikibot.Page(pywikibot.Site(),shortn)
            rpscount = len(list(rps.getReferences(namespaces=0)))
            if self.getOption('testlinks'):
                pywikibot.output(u'S:%s #%i In %s checking:%s - referenced by %i' % 
                    (datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"), counter, page.title(asLink=True), rps.title(asLink=True), rpscount ))

            res.append({"long":longn,"refl":rplcount,"short":shortn,"refs":rpscount})

        print(res)
        return(res)

def main(*args):
    """
    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)
        return False

if __name__ == '__main__':
    main()