Add logout function, reset high limits on auth

[python-simplemediawiki.debian] / simplemediawiki.py

diff --git a/simplemediawiki.py b/simplemediawiki.py
index b3e7f1def9fdb1ef6a844f8a69b5b1433698a970..05dd471456e83d6f31b73de2b95342017a5f9dfd 100644 (file)
--- a/simplemediawiki.py
+++ b/simplemediawiki.py
@@ -50,7 +50,7 @@ class MediaWiki():
     _namespaces = None
     _psuedo_namespaces = None
 
-    def __init__(self, api_url, cookie_file=None):
+    def __init__(self, api_url, cookie_file=None, user_agent=DEFAULT_UA):
         self._api_url = api_url
         if cookie_file:
             self._cj = cookielib.MozillaCookieJar(cookie_file)
@@ -62,6 +62,7 @@ class MediaWiki():
         else:
             self._cj = cookielib.CookieJar()
         self._opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self._cj))
+        self._opener.addheaders = [('User-agent', user_agent)]
 
     def _fetch_http(self, url, params):
         request = urllib2.Request(url, urllib.urlencode(params))
@@ -137,12 +138,22 @@ class MediaWiki():
             data['lgtoken'] = token
         result = self.call(data)
         if result['login']['result'] == 'Success':
+            self._high_limits = None
             return True
         elif result['login']['result'] == 'NeedToken' and not token:
             return self.login(user, passwd, result['login']['token'])
         else:
             return False
 
+    def logout(self):
+        """
+        Conveinence function for logging out of the wiki.
+        """
+        data = {'action': 'logout'}
+        self.call(data)
+        self._high_limits = None
+        return True
+
     def limits(self, low, high):
         """
         Convenience function for determining appropriate limits in the API. If
@@ -196,3 +207,6 @@ class MediaWiki():
 
 __author__ = 'Ian Weller <ian@ianweller.org>'
 __version__ = '1.0.1'
+DEFAULT_UA = 'python-simplemediawiki/%s ' + \
+        '+https://github.com/ianweller/python-simplemediawiki' \
+        % __version__