ms-reviewstats.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
AThis bot creates a pages with article reviewer's statistics on pl.wikipedia

Call: time python pwb.py masti/ms-reviewstats.py -page:'!' -outpage:'review.html' ; cp ~/pw/compat/masti/html/review.html ~/public_html/review.html


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.bot import (
    SingleSiteBot, ExistingPageBot, NoRedirectPageBot, AutomaticTWSummaryBot)
from pywikibot.tools import issue_deprecation_warning

import urllib
import datetime
from time import strftime

# 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
            'test': False, # print testoutput
            'negative': False, #if True negate behavior i.e. mark pages that DO NOT contain search string
            'automatic' : False, #include automatic reviews in stats
        })

        # 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):

        # Dict of tuples (review total, initial, other, unreview)
        reviews24 = {}
        reviews168 = {}

        currtime = datetime.datetime.now()
        starttime = currtime - datetime.timedelta(hours=4)

        reviews24 = self.countReviews(currtime, 24)
        reviews168 = self.countReviews(currtime, 168)

        if self.getOption('test'):
            pywikibot.output(u'Results24: %s' % reviews24)
            pywikibot.output(u'Results168: %s' % reviews168)

        self.generateresultspage(reviews24,reviews168)

    def countReviews(self,starttime, hours):

        if self.getOption('test'):
            pywikibot.output(u'Analyzing review log last %i hours.' % hours)

        # Dict of tuples (review total, initial, other, unreview)
        reviews = {}
        count = 0

        for le in self.site.logevents(end=starttime, start=starttime-datetime.timedelta(hours=hours), reverse=True, logtype='review'):
        #for le in self.site.logevents(end=starttime, start=starttime-datetime.timedelta(hours=hours), reverse=True):
            #if le.action().startswith('unapprove'):
            count += 1
            if self.getOption('test'):
                #pywikibot.output(le)
                pywikibot.output(u'%i>>%s>>%s>>%s>>%s>>%s>>%s' % (count, le.type(), le.logid(),le.timestamp(),le.action(),le.user(),le.page()))
            r = self.addreview(reviews,le.user(),le.action())
            total, initial, other, unreview = r
            if total != 0:
                reviews[le.user()] = r

        return(reviews)

    def addreview(self, dictionary, user, action):
        #tuple (review total, initial, other, unreview)

        if user in dictionary.keys():
            total, initial, other, unreview = dictionary[user]
        else:
            total = 0
            initial = 0 
            other = 0
            unreview = 0
        if self.getOption('test'):
            pywikibot.output(u'IN:%s>>%s>>%i>>%i>>%i>>%i' % (action, user, total, initial, other, unreview))
        # distinguish automatic review
        if self.getOption('automatic') or not action.endswith('a'):
            total += 1
            if action.startswith('unapprove'):
                unreview += 1
            elif '-i' in action:
                initial += 1
            else:
                other += 1
        else:
            if self.getOption('test'):
                pywikibot.output(u'Skipped automatic review')
        if self.getOption('test'):
            pywikibot.output(u'OUT:%s>>%s>>%i>>%i>>%i>>%i' % (action, user, total, initial, other, unreview))
        return (total, initial, other, unreview)

    def mainheader(self):
        # create main header
        header =u'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n'
        header +=u'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="pl" lang="pl" dir="ltr">\n'
        header +=u'        <head>\n'
        header +=u'                <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />\n'
        header +=u'                <title>Statystyki redaktorów - tools.wikimedia.pl</title>\n'
        header +=u'                <link rel="stylesheet" type="text/css" href="/~masti/modern.css" />\n'
        header +=u'        </head>\n'
        header +=u'<body>\n'
        header +=u'\n'
        header +=u'        <!-- heading -->\n'
        header +=u'        <div id="mw_header">\n'
        header +=u'                <h1 id="firstHeading">Statystyki redaktorów</h1>\n'
        header +=u'        </div>\n'
        header +=u'\n'
        header +=u'        <div id="mw_main">\n'
        header +=u'        <div id="mw_contentwrapper">\n'
        header +=u'\n'
        header +=u'        <!-- content -->\n'
        header +=u'        <div id="mw_content">\n'
        header +=u'\n'
        header +=u'                <table class="infobox">\n'
        header +=u'                        <tr><th>Statystyki</th></tr>\n'
        header +=u'                        <tr><td><a href="#reviewers24h">Redaktorzy - 24h</a></td></tr>\n'
        header +=u'                        <tr><td><a href="#reviewers168h">Redaktorzy - 168h</a></td></tr>\n'
        header +=u'                </table>\n'
        header +=u'                <p>Strona przedstawia statystyki dotyczące działań redaktorów. Podsumowanie jest generowane na podstawie danych z ostatnich 24h i 7 dni (168h) . Strona jest aktualizowana co pięć minut.</p>\n'
        # add creation time
        header += u'        <p>Ostatnia aktualizacja: <b>' + strftime('%A %d %B %Y %X %Z') + u'</b></p>\n'
        header += u'\n'
        header += u'<center><b><a class="external text" href="http://tools.wikimedia.pl/~masti/review.html">ODŚWIEŻ</a></b></center>\n'
        return(header)

    def mainfooter(self):
        # create main footer
        footer = u'                </table>\n'
        footer +=u'\n'
        footer +=u'        </div><!-- mw_content -->\n'
        footer +=u'        </div><!-- mw_contentwrapper -->\n'
        footer +=u'\n'
        footer +=u'        </div><!-- main -->\n'
        footer +=u'\n'
        footer +=u'        <div class="mw_clear"></div>\n'
        footer +=u'\n'
        footer +=u'        <!-- personal portlet -->\n'
        footer +=u'        <div class="portlet" id="p-personal">\n'
        footer +=u'                <div class="pBody">\n'
        footer +=u'                        <ul>\n'
        footer +=u'                                <li><a href="//pl.wikipedia.org">wiki</a></li>\n'
        footer +=u'                                <li><a href="/">tools</a></li>\n'
        footer +=u'                                <li><a href="/~masti/">masti</a></li>\n'
        footer +=u'</ul>\n'
        footer +=u'                </div>\n'
        footer +=u'        </div>\n'
        footer +=u'<div class="stopka">layout by <a href="../~beau/">Beau</a></div>\n'
        footer +=u'</body></html>\n'
        footer +=u'\n'
        return(footer)

    def reviewheader(self,hours):
        #create section header
        header  =u'                <h2><a name="reviewers'+ str(hours) + u'h"></a>Najaktywniejsi redaktorzy w ostatnich ' + str(hours) + u'h</h2>\n'
        header +=u'                <table class="wikitable sortable">\n'
        header +=u'                        <colgroup span="1"></colgroup>\n'
        header +=u'                        <colgroup span="1" style="width: 20%; text-align: center"></colgroup>\n'
        header +=u'                        <colgroup span="1" style="width: 20%; text-align: center"></colgroup>\n'
        header +=u'                        <colgroup span="1" style="width: 20%; text-align: center"></colgroup>\n'
        header +=u'                        <colgroup span="1" style="width: 20%; text-align: center"></colgroup>\n'
        header +=u'                        <tr>\n'
        header +=u'                                <th>Redaktor</th>\n'
        header +=u'                                <th>Oznaczeń</th>\n'
        header +=u'                                <th>Pierwsze</th>\n'
        header +=u'                                <th>Ponowne</th>\n'
        header +=u'                                <th>Wycofanie</th>\n'
        header +=u'                        </tr>\n'
        return(header)

    def reviewfooter(self):
        return(u'                </table>\n')

    def generatesection(self, reviews, hours):
        # generate one section with stats i.e.24h, 168h
        output = self.reviewheader(hours)

        res = sorted(reviews, key=reviews.__getitem__, reverse=True)
        for i in res:
            if self.getOption('test'):
                pywikibot.output(u'%s->%s' % (i, reviews[i]))
            total, initial, other, unreview = reviews[i]
            output += u'\t\t\t<tr>\n'
            link = urllib.quote((u'//pl.wikipedia.org/wiki/Wikipedysta:' + i).encode('UTF-8'))
            output += u'\t\t\t\t<td><a href="' + link + u'">' + i + u'</a></td><td>' + str(total) + u'</td><td>' + str(initial) + u'</td><td>' + str(other) + u'</td><td>' + str(unreview) + u'</td>\n'
            output += u'\t\t\t</tr>\n'
        output += self.reviewfooter()
        return(output)

    def generateresultspage(self,rev1, rev2):

        output = self.mainheader()

        output += self.generatesection(rev1,24)
        output += self.generatesection(rev2,168)

        output += self.mainfooter()

        # write ready file
        #test
        #pywikibot.output(u'Writing file: %s' % self.getOption('outpage'))
        rf= open(u'masti/html/'+self.getOption('outpage'),'w')
        rf.write(output.encode('UTF-8'))
        rf.close()
        return

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