weboob-devel/weboob/backends/mediawiki/browser.py
Laurent Bachelier 44f6189ca5 mediawiki backend: Use readurl instead of openurl
So that requests can be shown and saved if the debug options are activated.
json.load(fp) is just calling json.loads(fp.read) so there is no
performance loss.
2011-04-14 16:19:51 +02:00

179 lines
6.1 KiB
Python

# -*- coding: utf-8 -*-
# Copyright(C) 2011 Clément Schreiner
#
# This file is part of weboob.
#
# weboob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# weboob is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with weboob. If not, see <http://www.gnu.org/licenses/>.
from urlparse import urlsplit
import urllib
import datetime
from weboob.tools.browser import BaseBrowser, BrowserIncorrectPassword
from weboob.capabilities.content import Revision
try:
import simplejson
except ImportError:
# Python 2.6+ has a module similar to simplejson
import json as simplejson
__all__ = ['MediawikiBrowser']
# Browser
class MediawikiBrowser(BaseBrowser):
ENCODING = 'utf-8'
def __init__(self, url, apiurl, *args, **kwargs):
url_parsed = urlsplit(url)
self.PROTOCOL = url_parsed.scheme
self.DOMAIN = url_parsed.netloc
self.BASEPATH = url_parsed.path
if self.BASEPATH.endswith('/'):
self.BASEPATH = self.BASEPATH[:-1]
self.apiurl = apiurl
BaseBrowser.__init__(self, *args, **kwargs)
def get_wiki_source(self, page):
assert isinstance(self.apiurl, basestring)
data = {'action': 'query',
'prop': 'revisions|info',
'titles': page,
'rvprop': 'content|timestamp',
'rvlimit': '1',
'intoken': 'edit',
}
result = self.API_get(data)
pageid = result['query']['pages'].keys()[0]
if pageid == "-1": # Page does not exist
return ""
return result['query']['pages'][str(pageid)]['revisions'][0]['*']
def get_token(self, page, _type):
''' _type can be edit, delete, protect, move, block, unblock, email or import'''
if len(self.username) > 0 and not self.is_logged():
self.login()
data = {'action': 'query',
'prop': 'info',
'titles': page,
'intoken': _type,
}
result = self.API_get(data)
pageid = result['query']['pages'].keys()[0]
return result['query']['pages'][str(pageid)][_type+'token']
def set_wiki_source(self, content, message=None, minor=False):
if len(self.username) > 0 and not self.is_logged():
self.login()
page = content.id
token = self.get_token(page, 'edit')
data = {'action': 'edit',
'title': page,
'token': token,
'text': content.content.encode('utf-8'),
'summary': message,
}
if minor:
data['minor'] = 'true'
self.API_post(data)
def get_wiki_preview(self, content, message=None):
data = {'action': 'parse',
'title': content.id,
'text': content.content.encode('utf-8'),
'summary': message,
}
result = self.API_post(data)
return result['parse']['text']['*']
def is_logged(self):
data = {'action': 'query',
'meta': 'userinfo',
}
result = self.API_get(data)
return result['query']['userinfo']['id'] != 0
def login(self):
assert isinstance(self.username, basestring)
assert isinstance(self.password, basestring)
assert isinstance(self.apiurl, basestring)
data = {'action': 'login',
'lgname': self.username,
'lgpassword': self.password,
}
result = self.API_post(data)
if result['login']['result'] == 'WrongPass':
raise BrowserIncorrectPassword()
if result['login']['result'] == 'NeedToken':
data['lgtoken'] = result['login']['token']
self.API_post(data)
def iter_wiki_revisions(self, page, nb_entries):
'''Yield 'Revision' objects for the last <nb_entries> revisions of the specified page.'''
if len(self.username) > 0 and not self.is_logged():
self.login()
data = {'action': 'query',
'titles': page,
'prop': 'revisions',
'rvprop': 'ids|timestamp|comment|user|flags',
'rvlimit': str(nb_entries),
}
result = self.API_get(data)
pageid = str(result['query']['pages'].keys()[0])
if pageid != "-1":
for rev in result['query']['pages'][pageid]['revisions']:
rev_content = Revision(str(rev['revid']))
rev_content.comment = rev['comment']
rev_content.revision = str(rev['revid'])
rev_content.author = rev['user']
rev_content.timestamp = datetime.datetime.strptime(rev['timestamp'], '%Y-%m-%dT%H:%M:%SZ')
if rev.has_key('minor'):
rev_content.minor = True
else:
rev_content.minor = False
yield rev_content
def home(self):
'''We don't need to change location, we're using the JSON API here.'''
pass
def API_get(self, data):
'''Submit a GET request to the website
The JSON data is parsed and returned as a dictionary'''
data['format'] = 'json'
return simplejson.loads(self.readurl(self.buildurl(self.apiurl, **data)), 'utf-8')
def API_post(self, data):
'''Submit a POST request to the website
The JSON data is parsed and returned as a dictionary'''
data['format'] = 'json'
return simplejson.loads(self.readurl(self.apiurl, urllib.urlencode(data)), 'utf-8')