m-orphan.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
An incomplete sample script.

This is a bot to check for orphaned pages adding {{Sierotka|{{subst:#time:Y-m}}}} templates to it's discussion page.
Call:
mark:
   python pwb.py masti/m-orphan.py -start:'!' -summary:"Bot oznacza [[:Kategoria:Artykuły_osierocone|artykuł osierocony]]" -pt:0
remove:
   python pwb.py masti/m-orphan.py -catr:"Artykuły osierocone" -cleanup -summary:"Bot usuwa oznaczenie [[:Kategoria:Artykuły_osierocone|artykułu osieroconego]]" -pt:0

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.

-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.

-cleanup:        Remove template if no longer needed
"""
#
# (C) Pywikibot team, 2006-2016
#
# Distributed under the terms of the MIT license.
#
from __future__ import absolute_import, unicode_literals

__version__ = '$Id: c1795dd2fb2de670c0b4bddb289ea9d13b1e9b3f $'
#

import re
import pywikibot
from pywikibot import pagegenerators

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

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

    """
    @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
            'test': False, #switch on test functionality
            'cleanup': False, #remove template if no longer needed
        })

        # 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):
        counter = 1
        marked = 0
        for page in self.generator:
            pywikibot.output(u'Processing #%i (%i marked):%s' % (counter, marked, page.title(asLink=True)))
            counter += 1
            if self.getOption('cleanup'):
                if not page.namespace() == 1:
                    if self.getOption('test'):
                        pywikibot.output('Skipping nondiscussion...')
                    continue
                if not self.checkOrphan(page.toggleTalkPage()):
                    marked += 1
                    self.unmarkOrphan(page)
            else:
                if page.isDisambig():
                    if self.getOption('test'):
                        pywikibot.output('Skipping disambig...')
                elif page.isRedirectPage():
                    if self.getOption('test'):
                        pywikibot.output('Skipping redirect...')
                elif self.checkOrphan(page):
                    marked += 1
                    self.markOrphan(page)

    def checkOrphan(self, page):
        """
        check if the page is linked from other articles
        if not place {{Sierotka|data={{subst:#time:Y-m}}}} in talk page
        """
        if page.namespace() == 1:
            page = page.toggleTalkPage()
        refs = list(page.getReferences(namespaces=0))
        if self.getOption('test'):
            pywikibot.output(u'refs#:%i' % len(refs))
        if self.getOption('cleanup'):
            return(not len(refs) or (len(refs) == 1 and self.selfRef(page,refs)))
        else:
            return(not len(refs))

    def selfRef(self,page,refs):
        #check if page is selfreferenced
        for p in refs:
            if p.title() == page.title():
                if self.getOption('test'):
                    pywikibot.output('SelfReference found...')
                return(True)
        return(False)

    def markOrphan(self, page):
        '''
        if {{Sierotka}} not present add it
        '''
        talkPage = page.toggleTalkPage()
        if not u'{{Sierotka' in page.text:
            page.text = u'{{Sierotka|data={{subst:#time:Y-m}}}}\n' + page.text
            if self.getOption('test'):
                pywikibot.output(page.text)
            page.save(summary=self.getOption('summary'))

    def unmarkOrphan(self, page):
        '''
        if {{Sierotka}} present remove it
        '''
        if u'{{Sierotka' in page.text:
            page.text = re.sub(ur'(?i)\{\{sierotka.*?\}\}\n*','',page.text)
            if self.getOption('test'):
                pywikibot.output(page.text)
            page.save(summary=self.getOption('summary'))

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