Source code for scripts.cfd

#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
This script processes the Categories for discussion working page.

It parses out the actions that need to be taken as a result of CFD discussions
(as posted to the working page by an administrator) and performs them.

Syntax:

    python pwb.py cfd

"""
#
# (C) Ben McIlwain, 2008
# (C) Pywikibot team, 2009-2019
#
# Distributed under the terms of the MIT license.
#
from __future__ import absolute_import, division, unicode_literals

import re
import sys

import pywikibot

from scripts.category import CategoryMoveRobot as CategoryMoveBot


DEFAULT_CFD_PAGE = 'Wikipedia:Categories for discussion/Working'

# A list of templates that are used on category pages as part of the CFD
# process that contain information such as the link to the per-day discussion
#  page.
cfd_templates = ['Cfd full', 'Cfr full']

# Regular expression declarations
# See the en-wiki CFD working page at
# [[Wikipedia:Categories for discussion/Working]]
# to see how these work in context. To get this bot working on other wikis you
# will need to adjust these regular expressions at the very least.
nobots = re.compile(r'NO\s*BOTS', re.IGNORECASE)
example = re.compile(r'\[\[:Category:(.)\1\1\1\1\]\]', re.IGNORECASE)
speedymode = re.compile(r'^===*\s*Speedy Moves\s*===*\s*$', re.IGNORECASE)
movemode = re.compile(r'^===*\s*Move/Merge then delete\s*===*\s*$',
                      re.IGNORECASE)
emptymode = re.compile(r'^===*\s*Empty then delete\s*===*\s*$', re.IGNORECASE)
deletemode = re.compile(r'^===*\s*Ready for deletion\s*===*\s*$',
                        re.IGNORECASE)
maintenance = re.compile(
    r'^===*\s*Old by month categories with entries\s*===*\s*$', re.IGNORECASE)
dateheader = re.compile(
    r'(\[\[Wikipedia:Categories[_ ]for[_ ]'
    r'(?:discussion|deletion)/Log/([^\]]*?)\]\])', re.IGNORECASE)
movecat = re.compile(
    (r'\[\[:Category:([^\]]*?)\]\][^\]]*?\[\[:Category:([^\]]*?)\]\]'),
    re.IGNORECASE)
deletecat = re.compile(r'\[\[:Category:([^\]]*?)\]\]', re.IGNORECASE)
findday = re.compile(r'\[\[(Wikipedia:Categories for '
                     r'(?:discussion|deletion)/Log/\d{4} \w+ \d+)#',
                     re.IGNORECASE)


[docs]class ReCheck(object): """Helper class."""
[docs] def __init__(self): """Initializer.""" self.result = None
[docs] def check(self, pattern, text): """Search pattern.""" self.result = pattern.search(text) return self.result
[docs]def main(*args): """ Process command line arguments and perform task. If args is an empty list, sys.argv is used. @param args: command line arguments @type args: str """ cfd_page = DEFAULT_CFD_PAGE local_args = pywikibot.handle_args(args) for arg in local_args: if arg.startswith('-page'): if len(arg) == len('-page'): cfd_page = pywikibot.input( 'Enter the CFD working page to use:') else: cfd_page = arg[len('-page:'):] page = pywikibot.Page(pywikibot.Site(), cfd_page) try: page.get() except pywikibot.NoPage: pywikibot.error( 'CFD working page "{0}" does not exist!'.format(cfd_page)) sys.exit(1) # Variable declarations day = 'None' mode = 'None' summary = '' robot = None m = ReCheck() for line in page.text.split('\n'): if nobots.search(line) or example.search(line): # NO BOTS or example line continue if speedymode.search(line): mode = 'Speedy' day = 'None' elif movemode.search(line): mode = 'Move' day = 'None' elif emptymode.search(line): mode = 'Empty' day = 'None' elif deletemode.search(line): mode = 'Delete' day = 'None' elif maintenance.search(line): # It's probably best not to try to handle these in an automated # fashion. mode = 'None' day = 'None' elif m.check(dateheader, line): day = m.result.group(1) pywikibot.output('Found day header: {}'.format(day)) elif m.check(movecat, line): src = m.result.group(1) dest = m.result.group(2) thisDay = findDay(src, day) if mode == 'Move' and thisDay != 'None': summary = ( 'Robot - Moving category ' + src + ' to [[:Category:' + dest + ']] per [[WP:CFD|CFD]] at ' + thisDay + '.') action_summary = \ 'Robot - Result of [[WP:CFD|CFD]] at ' + thisDay + '.' elif mode == 'Speedy': summary = ( 'Robot - Speedily moving category ' + src + ' to [[:Category:' + dest + ']] per [[WP:CFDS|CFDS]].') action_summary = 'Robot - Speedily moved per [[WP:CFDS|CFDS]].' else: continue # If the category is redirect, we do NOT want to move articles to # it. The safest thing to do here is abort and wait for human # intervention. destpage = pywikibot.Page(page.site, dest, ns=14) if destpage.isCategoryRedirect(): summary = 'CANCELED. Destination is redirect: ' + summary pywikibot.stdout(summary) robot = None else: deletion_comment_same = ( CategoryMoveBot.DELETION_COMMENT_SAME_AS_EDIT_COMMENT) robot = CategoryMoveBot(oldcat=src, newcat=dest, batch=True, comment=summary, inplace=True, move_oldcat=True, delete_oldcat=True, deletion_comment=deletion_comment_same, move_comment=action_summary) elif m.check(deletecat, line): src = m.result.group(1) # I currently don't see any reason to handle these two cases # separately, though if are guaranteed that the category in the # "Delete" case is empty, it might be easier to call delete.py on # it. thisDay = findDay(src, day) if (mode == 'Empty' or mode == 'Delete') and thisDay != 'None': summary = ( 'Robot - Removing category {0} per [[WP:CFD|CFD]] ' 'at {1}.'.format(src, thisDay)) action_summary = \ 'Robot - Result of [[WP:CFD|CFD]] at ' + thisDay + '.' else: continue robot = CategoryMoveBot(oldcat=src, batch=True, comment=summary, deletion_comment=action_summary, inplace=True) if summary and robot is not None: pywikibot.stdout(summary) # Run, robot, run! robot.run() summary = '' robot = None
[docs]def findDay(pageTitle, oldDay): """ Find day link from CFD template. This function grabs the wiki source of a category page and attempts to extract a link to the CFD per-day discussion page from the CFD template. If the CFD template is not there, it will return the value of the second parameter, which is essentially a fallback that is extracted from the per-day subheadings on the working page. """ page = pywikibot.Page(pywikibot.Site(), 'Category:' + pageTitle) try: pageSrc = page.text except pywikibot.NoPage: m = None else: m = findday.search(pageSrc) if m is not None: return '[[{}]]'.format(m.group(1)) # Try to parse day link from CFD template parameters. templates = page.templatesWithParams() for template, params in templates: if template.title() in cfd_templates: period = {'year': None, 'day': None, 'month': None} for param in params: name, _, val = param.partition('=') if name in period: period[name] = val if all(period.values()): return ('[[Wikipedia:Categories for discussion/Log/' '{year} {month} {day}]]'.format(**period)) return oldDay
if __name__ == '__main__': main()