ms-artrevisions.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
This bot creates a sorted table of number of edits per page including anon(IP) and bot edits
Call: 
    python pwb.py masti/ms-artrevisions.py -start:'!' -maxlines:1000 -summary:"Bot uaktualnia stronę" -outpage:"Wikipedia:Statystyki/2016"

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

-test:            Switch on test prinouts
"""
#
# (C) Pywikibot team, 2006-2016
#
# Distributed under the terms of the MIT license.
#
from __future__ import absolute_import, unicode_literals

__version__ = '$Id: m-artdisamblist.py masti $'
#

import pywikibot
from pywikibot import pagegenerators

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

import re
import datetime

# 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'

    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, #switch on test functionality 
        })

        # 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 with table
        header = u"Ta strona jest okresowo uaktualniana przez [[Wikipedysta:MastiBot|bota]]. Ostatnia aktualizacja ~~~~~. \nWszelkie uwagi proszę zgłaszać w [[Dyskusja_Wikipedysty:Masti|dyskusji operatora]]."
        header +=u'\n{| class="wikitable sortable" style="font-size:85%; text-align: center"'
        header +=u'\n|-'
        header +=u'\n!rowspan=2 | #'
        header +=u'\n!rowspan=2 | Artykuł'
        header +=u'\n!rowspan=2 | Liczba edycji'
        header +=u'\n!colspan=2 | w tym'
        header +=u'\n|-'
        header +=u'\n!użytkownicy<br />anonimowi'
        header +=u'\n!boty'


        footer = u'\n|}'

        results = {}

        finalpage = header
        counter = 0
        marked = 0
        for page in self.generator:
            counter += 1
            #finalpage = finalpage + self.treat(page)
            if self.getOption('test'):
                pywikibot.output(u'Processing page #%i (%i marked): %s' % (counter, marked, page.title(asLink=True)) )
            result = self.treat(page)
            if result:
               results = self.addResult(results, page.title(withNamespace=False), result, mlines=self.getOption('maxlines'))
               marked += 1
               pywikibot.output(u'Added line #%i: %s elements: %i/%i/%i' % ( marked, page.title(asLink=True), result[0],result[1],result[2] ))

        pywikibot.output(results)
        self.generateresultspage(results, self.getOption('outpage'), header, footer)
        return

    def addResult(self, resultsDict, pageT, result, mlines=1000):
        '''
        if resultDict has less elements then max add result
        check if the result has more edits then last element then add it and remove last element
        '''
        if self.getOption('test'):
            pywikibot.output(u'addResult: %s, %s, %s/%s:%s' % (pageT, result, len(list(resultsDict)), mlines, len(list(resultsDict))<int(mlines) ) )
            pywikibot.output(resultsDict)
        if len(list(resultsDict)) < int(mlines):
            if self.getOption('test'):
                pywikibot.output(u'adding element')
            resultsDict[pageT] = result
        else:
            if self.getOption('test'):
                pywikibot.output(u'processing long list')
            res = sorted(resultsDict, key=resultsDict.__getitem__, reverse=False)
            if self.getOption('test'):
                pywikibot.output(res)
            deleted = False
            for r in res:
                if resultsDict[r][0] < result[0]:
                    if self.getOption('test'):
                        pywikibot.output(u'deleting element: %s' % r)
                    del resultsDict[r]
                    deleted = True
                else:
                    break
            if deleted:
                resultsDict[pageT] = result

        if self.getOption('test'):
            pywikibot.output(resultsDict)
            pywikibot.input(u'Waiting...')

        return(resultsDict)
        '''
        results[page.title(withNamespace=False)] = result
        '''

    def treat(self, page):
        """
        Loads the given page, looks for revision history
        returns number of revisions
        """

        #text = page.text
        #if self.getOption('test'):
        #    pywikibot.output(text)
        #if not text or page.isDisambig():
        #    return(None)

        anon = 0
        bot = 0

        revisions = page.revisions(reverse=True, starttime='2016-01-01T01:00:00Z')
        revisionsNumber = 0
        for r in revisions:
            revisionsNumber += 1
            rev = self.revisionAnalyze(r)
            if self.getOption('test'):
                pywikibot.output(r)
                pywikibot.output(rev)
            (anone, bote, username, month) = self.revisionAnalyze(r)
            if anone:
                anon += 1
            if bote:
                bot += 1

        return(revisionsNumber, anon, bot)

    def revisionAnalyze(self, revision):
        '''
        analyze given revision
        print data
        return (anon, bot, user, month)
        '''
        if self.getOption('test'):
            pywikibot.output(u'Comment:%s' % revision['comment'])
            pywikibot.output(u'IP edit:%s' % revision['anon'])
            pywikibot.output(u'Username:%s' % revision['user'])
            pywikibot.output(u'Bot edit:%s' % self.site.isBot(revision['user']))
            pywikibot.output(u'Date:%s: Month:%s' % (revision['timestamp'], revision['timestamp'].month))
        return(revision['anon'], self.site.isBot(revision['user']), revision['user'], revision['timestamp'].month)

    def generateresultspage(self, redirlist, pagename, header, footer):
        """
        Generates results page from redirlist
        Starting with header, ending with footer
        Output page is pagename
        """
        finalpage = header
        lineN = 1

        pywikibot.output(u'Generating results page: sorting')

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

        pywikibot.output(u'Generating results page: creating table')

        for i in res:
            rev, anon, bot = redirlist[i]
            pywikibot.output(u'Processed line #%i: %s elements: %i/%i/%i' % ( lineN, i, rev, anon, bot ))
            finalpage += u'\n|-\n| ' + str(lineN) + u' || [[' + i + u']] || ' + str(rev) + u' || ' + str(anon) + u' || ' + str(bot)
            lineN += 1
            if lineN > int(self.getOption('maxlines')):
                break

        finalpage += footer

        outpage = pywikibot.Page(pywikibot.Site(), pagename)
        outpage.text = finalpage
        outpage.save(summary=self.getOption('summary'))
        
        if self.getOption('test'):
            pywikibot.output(finalpage)
        return(redirlist)


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'):
            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()