###
# Copyright (c) 2011, Valentin Lorentz
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
import os
import json
import urllib
import urllib2
import tarfile
from cStringIO import StringIO
import supybot.log as log
import supybot.conf as conf
import supybot.utils as utils
from supybot.commands import *
import supybot.plugins as plugins
import supybot.ircutils as ircutils
import supybot.callbacks as callbacks
from supybot.i18n import PluginInternationalization, internationalizeDocstring
_ = PluginInternationalization('PluginDownloader')
class Repository:
pass
class VersionnedRepository(Repository):
pass
class GitRepository(VersionnedRepository):
pass
class GithubRepository(GitRepository):
def __init__(self, username, reponame, path='/'):
self._username = username
self._reponame = reponame
if not path.startswith('/'):
path = '/' + path
if not path.endswith('/'):
path += '/'
self._path = path
self._downloadUrl = 'https://github.com/%s/%s/tarball/master' % \
(
self._username,
self._reponame,
)
_apiUrl = 'http://github.com/api/v2/json'
def _query(self, type_, uri_end, args={}):
args = dict([(x,y) for x,y in args.items() if y is not None])
url = '%s/%s/%s?%s' % (self._apiUrl, type_, uri_end,
urllib.urlencode(args))
return json.load(utils.web.getUrlFd(url))
def getPluginList(self):
latestCommit = self._query(
'repos',
'show/%s/%s/branches' % (
self._username,
self._reponame,
)
)['branches']['master']
path = [x for x in self._path.split('/') if x != '']
treeHash = self._navigate(latestCommit, path)
if treeHash is None:
log.error((
'Cannot get plugins list from repository %s/%s '
'at Github'
) % (self._username, self._reponame))
return []
nodes = self._query(
'tree',
'show/%s/%s/%s' % (
self._username,
self._reponame,
treeHash,
)
)['tree']
plugins = [x['name'] for x in nodes if x['type'] == 'tree']
return plugins
def _navigate(self, treeHash, path):
if path == []:
return treeHash
tree = self._query(
'tree',
'show/%s/%s/%s' % (
self._username,
self._reponame,
treeHash,
)
)['tree']
nodeName = path.pop(0)
for node in tree:
if node['name'] != nodeName:
continue
if node['type'] != 'tree':
return None
else:
return self._navigate(node['sha'], path)
# Remember we pop(0)ed the path
return None
def install(self, plugin):
directories = conf.supybot.directories.plugins()
directory = self._getWritableDirectoryFromList(directories)
assert directory is not None
dirname = ''.join((self._path, plugin))
fileObject = urllib2.urlopen(self._downloadUrl)
fileObject2 = StringIO()
fileObject2.write(fileObject.read())
fileObject.close()
fileObject2.seek(0)
archive = tarfile.open(fileobj=fileObject2, mode='r:gz')
prefix = archive.getnames()[0]
try:
assert archive.getmember(prefix + dirname).isdir()
for file in archive.getmembers():
if file.name.startswith(prefix + dirname):
extractedFile = archive.extractfile(file)
newFileName = os.path.join(*file.name.split('/')[1:])
newFileName = newFileName[len(self._path)-1:]
newFileName = os.path.join(directory, newFileName)
if extractedFile is None:
os.mkdir(newFileName)
else:
open(newFileName, 'a').write(extractedFile.read())
finally:
archive.close()
fileObject2.close()
del archive, fileObject, fileObject2
def _getWritableDirectoryFromList(self, directories):
for directory in directories:
if os.access(directory, os.W_OK):
return directory
return None
repositories = {
'ProgVal': GithubRepository(
'ProgVal',
'Supybot-plugins'
),
'quantumlemur': GithubRepository(
'quantumlemur',
'Supybot-plugins',
),
'stepnem': GithubRepository(
'stepnem',
'supybot-plugins',
),
'gsf-snapshot': GithubRepository(
'gsf',
'supybot-plugins',
'Supybot-plugins-20060723',
),
'gsf-edsu': GithubRepository(
'gsf',
'supybot-plugins',
'edsu-plugins',
),
'gsf': GithubRepository(
'gsf',
'supybot-plugins',
'plugins',
),
'nanotube-bitcoin': GithubRepository(
'nanotube',
'supybot-bitcoin-'
'marketmonitor',
),
'mtughan-weather': GithubRepository(
'mtughan',
'Supybot-Weather',
),
'SpiderDave': GithubRepository(
'SpiderDave',
'spidey-supybot-plugins',
'Plugins',
),
}
class PluginDownloader(callbacks.Plugin):
"""Add the help for "@plugin help PluginDownloader" here
This should describe *how* to use this plugin."""
@internationalizeDocstring
def repolist(self, irc, msg, args, repository):
"""[<repository>]
Displays the list of plugins in the <repository>.
If <repository> is not given, returns a list of available
repositories."""
global repositories
if repository is None:
irc.reply(_(', ').join([x for x in repositories]))
elif repository not in repositories:
irc.error(_(
'This repository does not exist or is not known by '
'this bot.'
))
else:
plugins = repositories[repository].getPluginList()
if plugins == []:
irc.error(_('No plugin found in this repository.'))
else:
irc.reply(_(', ').join([x for x in plugins]))
repolist = wrap(repolist, [optional('something')])
@internationalizeDocstring
def install(self, irc, msg, args, repository, plugin):
"""<repository> <plugin>
Downloads and installs the <plugin> from the <repository>."""
global repositories
if repository not in repositories:
irc.error(_(
'This repository does not exist or is not known by '
'this bot.'
))
elif plugin not in repositories[repository].getPluginList():
irc.error(_('This plugin does not exist in this repository.'))
else:
try:
repositories[repository].install(plugin)
irc.replySuccess()
except Exception as e:
#FIXME: more detailed error message
log.error(str(e))
irc.error('The plugin could not be installed.')
install = wrap(install, ['owner', 'something', 'something'])
PluginDownloader = internationalizeDocstring(PluginDownloader)
Class = PluginDownloader
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: