Revision: 6447
Author: russblau
Date: 2009-02-27 13:39:21 +0000 (Fri, 27 Feb 2009)
Log Message:
-----------
Creating copy for porting to rewrite.
Added Paths:
-----------
branches/rewrite/pywikibot/scripts/category_redirect.py
Copied: branches/rewrite/pywikibot/scripts/category_redirect.py (from rev 6446,
trunk/pywikipedia/category_redirect.py)
===================================================================
--- branches/rewrite/pywikibot/scripts/category_redirect.py (rev
0)
+++ branches/rewrite/pywikibot/scripts/category_redirect.py 2009-02-27 13:39:21 UTC (rev
6447)
@@ -0,0 +1,645 @@
+# -*- coding: utf-8 -*-
+"""This bot will move pages out of redirected categories
+
+Usage: category-redirect.py [options]
+
+The bot will look for categories that are marked with a category redirect
+template, take the first parameter of the template as the target of the
+redirect, and move all pages and subcategories of the category there. It
+also changes hard redirects into soft redirects, and fixes double redirects.
+A log is written under <userpage>/category_redirect_log. Only category pages
+that haven't been edited for a certain cooldown period (currently 7 days)
+are taken into account.
+
+"""
+__version__ = '$Id$'
+
+import wikipedia, catlib
+import pagegenerators
+import simplejson
+import cPickle
+import math
+import re
+import sys, traceback
+import time
+from datetime import datetime, timedelta
+
+
+class APIError(Exception):
+ """The wiki API returned an error message."""
+
+ def __init__(self, errordict):
+ """Save error dict returned by MW API."""
+ self.errors = errordict
+
+ def __str__(self):
+ return "%(code)s: %(info)s" % self.errors
+
+
+class CategoryRedirectBot(object):
+ def __init__(self):
+ self.cooldown = 7 # days
+ self.site = wikipedia.getSite()
+ self.catprefix = self.site.namespace(14)+":"
+ self.log_text = []
+ self.edit_requests = []
+ self.log_page = wikipedia.Page(self.site,
+ u"User:%(user)s/category redirect log" %
+ {'user': self.site.loggedInAs()})
+
+ # Localization:
+
+ # Category that contains all redirected category pages
+ self.cat_redirect_cat = {
+ 'wikipedia': {
+ 'en': "Category:Wikipedia category redirects",
+ 'ar': "تصنيف:تحويلات تصنيفات ويكيبيديا",
+ 'hu': "Kategória:Kategóriaátirányítások",
+ 'ja': "Category:移行中のカテゴリ",
+ 'no': "Kategori:Wikipedia omdirigertekategorier",
+ 'simple': "Category:Category redirects",
+ },
+ 'commons': {
+ 'commons': "Category:Category redirects"
+ }
+ }
+
+ # List of all templates that are used to mark category redirects
+ # (put the most preferred form first)
+ self.redir_templates = {
+ 'wikipedia': {
+ 'en': ("Category redirect",
+ "Category redirect3",
+ "Categoryredirect",
+ "Empty category",
+ "CR",
+ "Catredirect",
+ "Cat redirect",
+ "Emptycat",
+ "Emptycategory",
+ "Empty cat",
+ "Seecat",),
+ 'ar': ("تحويل تصنيف",
+ "Category redirect",
+ "تحويلة تصنيف",),
+ 'hu': ("Kat-redir",
+ "Katredir",),
+ 'ja': ("Category redirect",),
+ 'no': ("Kategoriomdirigering",),
+ 'simple': ("Category redirect",
+ "Catredirect"),
+ },
+ 'commons': {
+ 'commons': (u'Category redirect',
+ u'Categoryredirect',
+ u'See cat',
+ u'Seecat',
+ u'Catredirect',
+ u'Cat redirect',
+ u'CatRed',
+ u'Cat-red',
+ u'Catredir',
+ u'Redirect category',),
+ }
+ }
+
+ self.move_comment = {
+ 'en':
+u"Robot: moving pages out of redirected category",
+ 'ar':
+u"روبوت: نقل الصفحات من تصنيف محول",
+ 'hu':
+u"Bot: Lapok automatikus áthelyezése átirányított kategóriából",
+ 'ja':
+u"ロボットによる: 移行中のカテゴリからのカテゴリ変更",
+ 'no':
+u"Robot: Flytter sider ut av omdirigeringskategori",
+ 'commons':
+u'Robot: Changing category link (following [[Template:Category redirect|category
redirect]])'
+ }
+
+ self.redir_comment = {
+ 'en':
+u"Robot: adding category redirect template for maintenance",
+ 'ar':
+u"روبوت: إضافة قالب تحويل تصنيف للصيانة",
+ 'hu':
+u"Bot: kategóriaátirányítás sablon hozzáadása",
+ 'ja':
+u"ロボットによる: 移行中のカテゴリとしてタグ付け",
+ 'no':
+u"Robot: Legger til vedlikeholdsmal for kategoriomdirigering",
+ }
+
+ self.dbl_redir_comment = {
+ 'en': u"Robot: fixing double-redirect",
+ 'ar': u"روبوت: تصليح تحويلة مزدوجة",
+ 'hu': u"Bot: Kettős átirányítás javítása",
+ 'ja': u"ロボットによる: 二重リダイレクト修正",
+ 'no': u"Robot: Ordner doble omdirigeringer",
+ }
+
+ self.maint_comment = {
+ 'en': u"Category redirect maintenance bot",
+ 'ar': u"بوت صيانة تحويل التصنيف",
+ 'hu': u"Kategóriaátirányítás-karbantartó bot",
+ 'ja': u"移行中のカテゴリのメンテナンス・ボット",
+ 'no': u"Bot for vedlikehold av kategoriomdirigeringer",
+ }
+
+ self.edit_request_text = wikipedia.translate(self.site.lang,
+ {'en': u"""\
+The following protected pages have been detected as requiring updates to \
+category links:
+%s
+~~~~
+""",
+ })
+
+ self.edit_request_item = wikipedia.translate(self.site.lang,
+ {'en': u"* %s is in %s, which is a redirect to %s",
+ })
+
+ def change_category(self, article, oldCat, newCat, comment=None,
+ sortKey=None):
+ """Given an article in category oldCat, moves it to category
newCat.
+ Moves subcategories of oldCat as well. oldCat and newCat should be
+ Category objects. If newCat is None, the category will be removed.
+
+ This is a copy of portions of catlib.change_category(), with some
+ changes.
+
+ """
+ oldtext = article.get(get_redirect=True, force=True)
+ newtext = wikipedia.replaceCategoryInPlace(oldtext, oldCat, newCat)
+ try:
+ # even if no changes, still save the page, in case it needs
+ # an update due to changes in a transcluded template
+ article.put(newtext, comment)
+ if newtext == oldtext:
+ wikipedia.output(
+ u'No changes in made in page %s.' % article.aslink())
+ return False
+ return True
+ except wikipedia.EditConflict:
+ wikipedia.output(
+ u'Skipping %s because of edit conflict' % article.aslink())
+ except wikipedia.LockedPage:
+ wikipedia.output(u'Skipping locked page %s' % article.aslink())
+ self.edit_requests.append((article.aslink(),
+ oldCat.aslink(textlink=True),
+ newCat.aslink(textlink=True)))
+ except wikipedia.SpamfilterError, error:
+ wikipedia.output(
+ u'Changing page %s blocked by spam filter (URL=%s)'
+ % (article.aslink(), error.url))
+ except wikipedia.NoUsername:
+ wikipedia.output(
+ u"Page %s not saved; sysop privileges required."
+ % article.aslink())
+ self.edit_requests.append((article.aslink(textlink=True),
+ oldCat.aslink(textlink=True),
+ newCat.aslink(textlink=True)))
+ except wikipedia.PageNotSaved, error:
+ wikipedia.output(u"Saving page %s failed: %s"
+ % (article.aslink(), error.message))
+ return False
+
+ def move_contents(self, oldCatTitle, newCatTitle, editSummary):
+ """The worker function that moves pages out of oldCat into
newCat"""
+ while True:
+ try:
+ oldCat = catlib.Category(self.site,
+ self.catprefix + oldCatTitle)
+ newCat = catlib.Category(self.site,
+ self.catprefix + newCatTitle)
+
+ # Move articles
+ found, moved = 0, 0
+ for result in self.query_results(list="categorymembers",
+ cmtitle=oldCat.title(),
+ cmprop="title|sortkey",
+ cmlimit="max"):
+ found += len(result['categorymembers'])
+ for item in result['categorymembers']:
+ article = wikipedia.Page(self.site, item['title'])
+ changed = self.change_category(article, oldCat, newCat,
+ comment=editSummary)
+ if changed: moved += 1
+
+ # pass 2: look for template doc pages
+ for result in self.query_results(list="categorymembers",
+ cmtitle=oldCat.title(),
+ cmprop="title|sortkey",
+ cmnamespace="10",
+ cmlimit="max"):
+ for item in result['categorymembers']:
+ doc = wikipedia.Page(self.site,
item['title']+"/doc")
+ try:
+ old_text = doc.get()
+ except wikipedia.Error:
+ continue
+ changed = self.change_category(doc, oldCat, newCat,
+ comment=editSummary)
+ if changed: moved += 1
+
+ if found:
+ wikipedia.output(u"%s: %s found, %s moved"
+ % (oldCat.title(), found, moved))
+ return (found, moved)
+ except wikipedia.ServerError:
+ wikipedia.output(u"Server error: retrying in 5 seconds...")
+ time.sleep(5)
+ continue
+ except KeyboardInterrupt:
+ raise
+ except:
+ return (None, None)
+
+ def readyToEdit(self, cat):
+ """Return True if cat not edited during cooldown period, else
False."""
+ dateformat ="%Y%m%d%H%M%S"
+ today = datetime.now()
+ deadline = today + timedelta(days=-self.cooldown)
+ if cat.editTime() is None:
+ raise RuntimeError
+ return (deadline.strftime(dateformat) > cat.editTime())
+
+ def query_results(self, **data):
+ """Iterate results from API action=query, using data as
parameters."""
+ addr = self.site.apipath()
+ querydata = {'action': 'query',
+ 'format': 'json',
+ 'maxlag': str(wikipedia.config.maxlag)}
+ querydata.update(data)
+ if not querydata.has_key("action")\
+ or not querydata['action'] == 'query':
+ raise ValueError(
+ "query_results: 'action' set to value other than
'query'"
+ )
+ waited = 0
+ while True:
+ response, data = self.site.postForm(addr, querydata)
+ if response.status != 200:
+ # WARNING: if the server is down, this could
+ # cause an infinite loop
+ wikipedia.output(u"HTTP error %i received; retrying..."
+ % response.status)
+ time.sleep(5)
+ continue
+ if data.startswith(u"unknown_action"):
+ e = {'code': data[:14], 'info': data[16:]}
+ raise APIError(e)
+ try:
+ result = simplejson.loads(data)
+ except ValueError:
+ # if the result isn't valid JSON, there must be a server
+ # problem. Wait a few seconds and try again
+ # WARNING: if the server is down, this could
+ # cause an infinite loop
+ wikipedia.output(u"Invalid API response received;
retrying...")
+ time.sleep(5)
+ continue
+ if type(result) is dict and result.has_key("error"):
+ if result['error']['code'] == "maxlag":
+ print "Pausing due to server lag.\r",
+ time.sleep(5)
+ waited += 5
+ if waited % 30 == 0:
+ wikipedia.output(
+ u"(Waited %i seconds due to server lag.)"
+ % waited)
+ continue
+ else:
+ # raise error
+ raise APIError(result['error'])
+ waited = 0
+ if type(result) is list:
+ # query returned no results
+ return
+ assert type(result) is dict, \
+ "Unexpected result of type '%s' received." %
type(result)
+ if "query" not in result:
+ # query returned no results
+ return
+ yield result['query']
+ if result.has_key("query-continue"):
+ assert len(result['query-continue'].keys()) == 1, \
+ "More than one query-continue key returned: %s" \
+ % result['query-continue'].keys()
+ query_type = result['query-continue'].keys()[0]
+ assert (query_type in querydata.keys()
+ or query_type in querydata.values()), \
+ "Site returned unknown query-continue type
'%s'"\
+ % query_type
+ querydata.update(result['query-continue'][query_type])
+ else:
+ return
+
+ def get_log_text(self):
+ """Rotate log text and return the most recent
text."""
+ LOG_SIZE = 7 # Number of items to keep in active log
+ try:
+ log_text = self.log_page.get()
+ except wikipedia.NoPage:
+ log_text = u""
+ log_items = {}
+ header = None
+ for line in log_text.splitlines():
+ if line.startswith("==") and line.endswith("=="):
+ header = line[2:-2].strip()
+ if header is not None:
+ log_items.setdefault(header, [])
+ log_items[header].append(line)
+ if len(log_items) < LOG_SIZE:
+ return log_text
+ # sort by keys and keep the first (LOG_SIZE-1) values
+ keep = [text for (key, text)
+ in sorted(log_items.items(), reverse=True)[ : LOG_SIZE-1]]
+ log_text = "\n".join("\n".join(line for line in text) for
text in keep)
+ # get permalink to older logs
+ history = self.log_page.getVersionHistory(revCount=LOG_SIZE)
+ # get the id of the newest log being archived
+ rotate_revid = history[-1][0]
+ # append permalink
+ log_text = log_text + (
+ "\n\n'''[%s://%s%s/index.php?title=%s&oldid=%s Older
logs]'''"
+ % (self.site.protocol(),
+ self.site.hostname(),
+ self.site.scriptpath(),
+ self.log_page.urlname(),
+ rotate_revid))
+ return log_text
+
+ def run(self):
+ """Run the bot"""
+ user = self.site.loggedInAs()
+ redirect_magicwords = ["redirect"]
+ other_words = self.site.redirect()
+ if other_words:
+ redirect_magicwords.extend(other_words)
+ problems = []
+
+ l = time.localtime()
+ today = "%04d-%02d-%02d" % l[:3]
+ edit_request_page = wikipedia.Page(self.site,
+ u"User:%(user)s/category edit requests" %
locals())
+ datafile = wikipedia.config.datafilepath(
+ "%s-catmovebot-data" % self.site.dbName())
+ try:
+ inp = open(datafile, "rb")
+ record = cPickle.load(inp)
+ inp.close()
+ except IOError:
+ record = {}
+ if record:
+ cPickle.dump(record, open(datafile + ".bak", "wb"))
+
+ try:
+ template_list = self.redir_templates[self.site.family.name
+ ][self.site.lang]
+ except KeyError:
+ wikipedia.output(u"No redirect templates defined for %s"
+ % self.site.sitename())
+ return
+ # regex to match soft category redirects
+ # note that any templates containing optional "category:" are
+ # incorrect and will be fixed by the bot
+ template_regex = re.compile(
+ ur"""{{\s*(?:%(prefix)s\s*:\s*)? # optional
"template:"
+ (?:%(template)s)\s*\| # catredir template name
+ (\s*%(catns)s\s*:\s*)? # optional "category:"
+ ([^|}]+) # redirect target cat
+ (?:\|[^|}]*)*}} # optional arguments 2+, ignored
+ """ % {'prefix': self.site.namespace(10).lower(),
+ 'template': "|".join(item.replace(" ",
"[ _]+")
+ for item in template_list),
+ 'catns': self.site.namespace(14)},
+ re.I|re.X)
+
+ # check for hard-redirected categories that are not already marked
+ # with an appropriate template
+ comment = wikipedia.translate(self.site.lang, self.redir_comment)
+ for result in self.query_results(list='allpages',
+ apnamespace='14', # Category:
+ apfrom='!',
+ apfilterredir='redirects',
+ aplimit='max'):
+ gen = (wikipedia.Page(self.site, page_item['title'])
+ for page_item in result['allpages'])
+ # gen yields all hard redirect pages in namespace 14
+ for page in pagegenerators.PreloadingGenerator(gen, 120):
+ if page.isCategoryRedirect():
+ # this is already a soft-redirect, so skip it (for now)
+ continue
+ target = page.getRedirectTarget()
+ if target.namespace() == 14:
+ # this is a hard-redirect to a category page
+ newtext = (u"{{%(template)s|%(cat)s}}"
+ % {'cat': target.titleWithoutNamespace(),
+ 'template': template_list[0]})
+ try:
+ page.put(newtext, comment, minorEdit=True)
+ self.log_text.append(u"* Added {{tl|%s}} to %s"
+ % (template_list[0],
+ page.aslink(textlink=True)))
+ except wikipedia.Error, e:
+ self.log_text.append(
+ u"* Failed to add {{tl|%s}} to %s (%s)"
+ % (template_list[0],
+ page.aslink(textlink=True),
+ e))
+ else:
+ problems.append(
+ u"# %s is a hard redirect to %s"
+ % (page.aslink(textlink=True),
+ target.aslink(textlink=True)))
+
+ wikipedia.output("Done checking hard-redirect category pages.")
+
+ comment = wikipedia.translate(self.site.lang, self.move_comment)
+ scan_data = {
+ u'action': 'query',
+ u'list': 'embeddedin',
+ u'einamespace': '14', # Category:
+ u'eilimit': 'max',
+ u'format': 'json'
+ }
+ counts, destmap, catmap = {}, {}, {}
+ catlist, catpages, nonemptypages = [], [], []
+ target = self.cat_redirect_cat[self.site.family.name][self.site.lang]
+
+ # get a list of all members of the category-redirect category
+ for result in self.query_results(generator=u'categorymembers',
+ gcmtitle=target,
+ gcmnamespace=u'14', # CATEGORY
+ gcmlimit=u'max',
+ prop='info|categoryinfo'):
+ for catdata in result['pages'].values():
+ thispage = wikipedia.Page(self.site, catdata['title'])
+ catpages.append(thispage)
+ if 'categoryinfo' in catdata \
+ and catdata['categoryinfo']['size'] !=
"0":
+ # save those categories that have contents
+ nonemptypages.append(thispage)
+
+ # preload the category pages for redirected categories
+ wikipedia.output(u"")
+ wikipedia.output(u"Preloading %s category redirect pages"
+ % len(catpages))
+ for cat in pagegenerators.PreloadingGenerator(catpages, 120):
+ cat_title = cat.titleWithoutNamespace()
+ if "category redirect" in cat_title:
+ self.log_text.append(u"* Ignoring %s"
+ % cat.aslink(textlink=True))
+ continue
+ try:
+ text = cat.get(get_redirect=True)
+ except wikipedia.Error:
+ self.log_text.append(u"* Could not load %s; ignoring"
+ % cat.aslink(textlink=True))
+ continue
+ if not cat.isCategoryRedirect():
+ self.log_text.append(u"* False positive: %s"
+ % cat.aslink(textlink=True))
+ continue
+ if cat_title not in record:
+ # make sure every redirect has a record entry
+ record[cat_title] = {today: None}
+ catlist.append(cat)
+ target = cat.getCategoryRedirectTarget()
+ destination = target.titleWithoutNamespace()
+ destmap.setdefault(target, []).append(cat)
+ catmap[cat] = destination
+## if match.group(1):
+## # category redirect target starts with "Category:" - fix it
+## text = text[ :match.start(1)] + text[match.end(1): ]
+## try:
+## cat.put(text,
+## u"Robot: fixing category redirect parameter
format")
+## self.log_text.append(
+## u"* Removed category prefix from parameter in %s"
+## % cat.aslink(textlink=True))
+## except wikipedia.Error:
+## self.log_text.append(
+## u"* Unable to save changes to %s"
+## % cat.aslink(textlink=True))
+
+ # delete record entries for non-existent categories
+ for cat_name in list(record.keys()):
+ if catlib.Category(self.site,
+ self.catprefix+cat_name) not in catmap:
+ del record[cat_name]
+
+ wikipedia.output(u"")
+ wikipedia.output(u"Checking %s destination categories" % len(destmap))
+ for dest in pagegenerators.PreloadingGenerator(destmap.keys(), 120):
+ if not dest.exists():
+ for d in destmap[dest]:
+ problems.append("# %s redirects to %s"
+ % (d.aslink(textlink=True),
+ dest.aslink(textlink=True)))
+ catlist.remove(d)
+ # do a null edit on d to make it appear in the
+ # "needs repair" category (if this wiki has one)
+ try:
+ d.put(d.get(get_redirect=True))
+ except:
+ pass
+ if dest in catlist:
+ for d in destmap[dest]:
+ # is catmap[dest] also a redirect?
+ newcat = catlib.Category(self.site,
+ self.catprefix+catmap[dest])
+ while newcat in catlist:
+ if newcat == d or newcat == dest:
+ self.log_text.append(u"* Redirect loop from %s"
+ % newcat.aslink(textlink=True))
+ break
+ newcat = catlib.Category(self.site,
+ self.catprefix+catmap[newcat])
+ else:
+ self.log_text.append(
+ u"* Fixed double-redirect: %s -> %s -> %s"
+ % (d.aslink(textlink=True),
+ dest.aslink(textlink=True),
+ newcat.aslink(textlink=True)))
+ oldtext = d.get(get_redirect=True)
+ # remove the old redirect from the old text,
+ # leaving behind any non-redirect text
+ oldtext = template_regex.sub("", oldtext)
+ newtext = (u"{{%(redirtemp)s|%(ncat)s}}"
+ % {'redirtemp': template_list[0],
+ 'ncat': newcat.titleWithoutNamespace()})
+ newtext = newtext + oldtext.strip()
+ try:
+ d.put(newtext,
+ wikipedia.translate(self.site.lang,
+ self.dbl_redir_comment),
+ minorEdit=True)
+ except wikipedia.Error, e:
+ self.log_text.append("** Failed: %s" % str(e))
+
+ # only scan those pages that have contents (nonemptypages)
+ # and that haven't been removed from catlist as broken redirects
+ cats_to_empty = set(catlist) & set(nonemptypages)
+ wikipedia.output(u"")
+ wikipedia.output(u"Moving pages out of %s redirected categories."
+ % len(cats_to_empty))
+# thread_limit = int(math.log(len(cats_to_empty), 8) + 1)
+# threadpool = ThreadList(limit=1) # disabling multi-threads
+
+ for cat in cats_to_empty:
+ cat_title = cat.titleWithoutNamespace()
+ if not self.readyToEdit(cat):
+ counts[cat_title] = None
+ self.log_text.append(
+ u"* Skipping %s; in cooldown period."
+ % cat.aslink(textlink=True))
+ continue
+ found, moved = self.move_contents(cat_title, catmap[cat],
+ editSummary=comment)
+ if found is None:
+ self.log_text.append(
+ u"* [[:%s%s]]: error in move_contents"
+ % (self.catprefix, cat_title))
+ elif found:
+ record[cat_title][today] = found
+ self.log_text.append(
+ u"* [[:%s%s]]: %d found, %d moved"
+ % (self.catprefix, cat_title, found, moved))
+ counts[cat_title] = found
+
+ cPickle.dump(record, open(datafile, "wb"))
+
+ wikipedia.setAction(wikipedia.translate(self.site.lang,
+ self.maint_comment))
+ self.log_text.sort()
+ self.log_page.put(u"\n==%i-%02i-%02iT%02i:%02i:%02iZ==\n"
+ % time.gmtime()[:6]
+ + u"\n".join(self.log_text)
+ + "\n" + "\n".join(problems)
+ + "\n" + self.get_log_text())
+ if self.edit_requests:
+ edit_request_page.put(self.edit_request_text
+ % u"\n".join((self.edit_request_item % item)
+ for item in self.edit_requests))
+
+
+def main(*args):
+ global bot
+ try:
+ a = wikipedia.handleArgs(*args)
+ if len(a) == 1:
+ raise RuntimeError('Unrecognized argument "%s"' % a[0])
+ elif a:
+ raise RuntimeError('Unrecognized arguments: ' +
+ " ".join(('"%s"' % arg) for
arg in a))
+ bot = CategoryRedirectBot()
+ bot.run()
+ finally:
+ wikipedia.stopme()
+
+
+if __name__ == "__main__":
+ main()