[Pywikipedia-l] SVN: [5700] trunk/pywikipedia

[btongminh at svn.wikimedia.org]

Revision: 5700
Author:   btongminh
Date:     2008-07-09 12:34:42 +0000 (Wed, 09 Jul 2008)

Log Message:
-----------
Add RevertBot to version control. Add Site.username function

Modified Paths:
--------------
    trunk/pywikipedia/wikipedia.py

Added Paths:
-----------
    trunk/pywikipedia/revertbot.py

Added: trunk/pywikipedia/revertbot.py
===================================================================
--- trunk/pywikipedia/revertbot.py	                        (rev 0)
+++ trunk/pywikipedia/revertbot.py	2008-07-09 12:34:42 UTC (rev 5700)
@@ -0,0 +1,106 @@
+import wikipedia
+import simplejson
+
+__version__ = '$Id:$'
+
+"""
+    Copyright 2008 - Bryan Tong Minh
+    Licensed under the terms of the MIT license.
+"""
+
+class BaseRevertBot(object):
+    """ Base revert bot
+    
+    Subclass this bot and override callback to get it to do something useful.
+    """
+    def __init__(self, site, comment = None):
+        self.site = site
+        self.comment = comment
+        
+    def get_contributions(self, max = -1, ns = None):
+        address = self.site.api_address()
+        predata = {
+            'action': 'query',
+            'list': 'usercontribs',
+            'uclimit': '500',
+            'ucuser': self.site.username(),
+            'format': 'json'
+        }
+        if ns is not None: predata['ucnamespace'] = ns
+        if max < 500 and max != -1: predata['uclimit'] = str(max)
+            
+        count = 0
+        iterator = iter(xrange(0))
+        never_continue = False
+        while count != max or never_continue:
+            try:
+                item = iterator.next()
+            except StopIteration:
+                self.log(u'Fetching new batch of contributions')
+                response, data = self.site.postForm(address, predata)
+                data = simplejson.loads(data)
+                if 'error' in data:
+                    raise RuntimeError(data['error'])
+                if 'usercontribs' in data.get('query-continue', ()):
+                    predata.update(data['query-continue']['usercontribs'])
+                else:
+                    never_continue = True
+                iterator = iter(data['query']['usercontribs'])
+            else:
+                count += 1
+                yield item
+    
+    def revert_contribs(self, callback = None):
+        self.site.forceLogin()
+        
+        if callback is None:
+            callback = self.callback
+        
+        contribs = self.get_contributions()
+        for item in contribs:
+            try:
+                if callback(item):
+                    result = self.revert(item)
+                    if result:
+                        self.log(u'%s: %s' % (item['title'], result))
+                    else:
+                        self.log(u'Skipped %s' % item['title'])
+            except StopIteration:
+                return
+    
+    def callback(self, item):
+        return 'top' in item
+    
+    def revert(self, item):
+        predata = {
+            'action': 'query',
+            'titles': item['title'],
+            'prop': 'revisions',
+            'rvprop': 'ids|timestamp|user|content',
+            'rvlimit': '2',
+            'rvstart': item['timestamp'],
+            'format': 'json'
+        }
+        response, data = self.site.postForm(self.site.api_address(), predata)
+        data = simplejson.loads(data)
+        
+        if 'error' in data:
+            raise RuntimeError(data['error'])
+        
+        pages = data['query'].get('pages', ())
+        if not pages: return False
+        page = pages.itervalues().next()
+        if len(page.get('revisions', ())) != 2: return False
+        rev = page['revisions'][1]
+        
+        comment = u'Reverted to revision %s by %s on %s' % (rev['revid'], 
+            rev['user'], rev['timestamp'])
+        if self.comment: comment += ': ' + self.comment
+        
+        page = wikipedia.Page(self.site, item['title'])
+        page.put(rev['*'], comment)
+        return comment
+        
+    def log(self, msg):
+        wikipedia.output(msg)
+        


Property changes on: trunk/pywikipedia/revertbot.py
___________________________________________________________________
Name: svn:keywords
   + id
Name: svn:eol-style
   + native

Modified: trunk/pywikipedia/wikipedia.py
===================================================================
--- trunk/pywikipedia/wikipedia.py	2008-07-09 09:31:33 UTC (rev 5699)
+++ trunk/pywikipedia/wikipedia.py	2008-07-09 12:34:42 UTC (rev 5700)
@@ -4051,6 +4051,8 @@
             return 1
         else:
             return 0
+    def username(self, sysop = False):
+        return self._userName[self._userIndex(sysop = sysop)]
 
     def loggedInAs(self, sysop = False):
         """Return the current username if logged in, otherwise return None.