import logging
from urllib import basejoin
from tg import expose, redirect, flash
from tg.decorators import without_trailing_slash
from pylons import c, g
from pymongo.bson import ObjectId
from ming.orm import session
from allura.lib.helpers import push_config
from allura.lib.security import require, has_artifact_access
from allura import model
from allura.controllers import BaseController
log = logging.getLogger(__name__)
class ConfigOption(object):
def __init__(self, name, ming_type, default):
self.name, self.ming_type, self._default = (
name, ming_type, default)
@property
def default(self):
if callable(self._default):
return self._default()
return self._default
class WSGIHook(object):
def handles(self, environ):
return False
def __call__(self, environ, start_response):
raise NotImplementedError, '__call__' # pragma no cover
class SitemapEntry(object):
def __init__(self, label, url=None, children=None, className=None, ui_icon=None, small=None):
self.label = label
self.className = className
self.url = url
self.small = small
self.ui_icon = ui_icon
if children is None:
children = []
self.children = children
def __getitem__(self, x):
if isinstance(x, (list, tuple)):
self.children.extend(list(x))
else:
self.children.append(x)
return self
def __repr__(self):
l = ['<SitemapEntry ']
l.append(' label=%r' % self.label)
l.append(' children=%s' % repr(self.children).replace('\n', '\n '))
l.append('>')
return '\n'.join(l)
def bind_app(self, app):
lbl = self.label
url = self.url
if callable(lbl):
lbl = lbl(app)
if url is not None:
url = basejoin(app.url, url)
return SitemapEntry(lbl, url, [
ch.bind_app(app) for ch in self.children], className=self.className)
def extend(self, sitemap):
child_index = dict(
(ch.label, ch) for ch in self.children)
for e in sitemap:
lbl = e.label
match = child_index.get(e.label)
if match and match.url == e.url:
match.extend(e.children)
else:
self.children.append(e)
child_index[lbl] = e
class WidgetController(BaseController):
widgets=[]
def __init__(self, app): pass
def portlet(self, content):
return '<div class="portlet">%s</div>' % content
class Application(object):
'base allura pluggable application'
__version__ = None
config_options = [
ConfigOption('mount_point', str, 'app'),
ConfigOption('mount_label', str, 'app'),
ConfigOption('ordinal', int, '0') ]
templates=None # path to templates
script_name=None
root=None # root controller
api_root=None
permissions=[]
sitemap = [ ]
installable=True
wsgi = WSGIHook()
widget = WidgetController
searchable = False
DiscussionClass = model.Discussion
PostClass = model.Post
AttachmentClass = model.Attachment
tool_label='Tool'
default_mount_label='Tool Name'
default_mount_point='tool'
ordinal=0
def __init__(self, project, app_config_object):
self.project = project
self.config = app_config_object # pragma: no cover
self.admin = DefaultAdminController(self)
self.url = self.config.url()
def has_access(self, user, topic):
'''Whether the user has access to send email to the given topic'''
return False
def is_visible_to(self, user):
'''Whether the user can view the app.'''
return has_artifact_access('read', app=self)(user=user)
@classmethod
def default_options(cls):
return dict(
(co.name, co.default)
for co in cls.config_options)
def install(self, project):
'Whatever logic is required to initially set up a tool'
# Create the discussion object
discussion = self.DiscussionClass(
shortname=self.config.options.mount_point,
name='%s Discussion' % self.config.options.mount_point,
description='Forum for %s comments' % self.config.options.mount_point)
session(discussion).flush()
self.config.discussion_id = discussion._id
def uninstall(self, project=None, project_id=None):
'Whatever logic is required to tear down a tool'
if project_id is None: project_id = project._id
# De-index all the artifacts belonging to this tool in one fell swoop
g.solr.delete('project_id_s:%s AND mount_point_s:%s' % (
project_id, self.config.options['mount_point']))
for d in model.Discussion.query.find({
'project_id':project_id,
'app_config_id':self.config._id}):
d.delete()
# Remove all tags referring to this tool
q_aref ={
'artifact_ref.project_id':project_id,
'artifact_ref.mount_point':self.config.options['mount_point']}
model.Tag.query.remove(q_aref)
model.TagEvent.query.remove(q_aref)
model.UserTags.query.remove(q_aref)
self.config.delete()
def sidebar_menu(self):
return []
def admin_menu(self):
admin_url = c.project.url()+'admin/'+self.config.options.mount_point+'/'
links = []
# if self.permissions and has_artifact_access('configure', app=self)():
# links.append(SitemapEntry('Permissions', admin_url + 'permissions', className='nav_child'))
if len(self.config_options) > 3:
links.append(SitemapEntry('Options', admin_url + 'options', className='nav_child'))
return links
def message_auditor(self, routing_key, data, artifact, **kw):
# Find ancestor comment
in_reply_to = data.get('in_reply_to', [])
if in_reply_to:
parent_id = in_reply_to[0]
else:
parent_id = None
thd = artifact.discussion_thread(data)
# Handle attachments
message_id = data['message_id'][0]
if data.get('filename'):
log.info('Saving attachment %s', data['filename'])
self.AttachmentClass.save(data['filename'],
data.get('content_type', 'application/octet-stream'),
data['payload'],
discussion_id=self.config.discussion_id,
post_id=message_id)
return
# Handle duplicates
original = self.PostClass.query.get(_id=message_id)
if original:
log.info('Saving text attachment')
self.AttachmentClass.save('alternate',
data.get('content_type', 'application/octet-stream'),
data['payload'],
discussion_id=self.config.discussion_id,
post_id=message_id)
return
thd.post(
text=data['payload'] or '--no text body--',
message_id=message_id,
parent_id=parent_id,
**kw)
class DefaultAdminController(BaseController):
def __init__(self, app):
self.app = app
@expose()
def index(self, **kw):
return redirect('permissions')
@expose('allura.templates.app_admin_permissions')
@without_trailing_slash
def permissions(self):
return dict(app=self.app,
allow_config=has_artifact_access('configure', app=self.app)())
@expose('allura.templates.app_admin_options')
def options(self):
return dict(app=self.app,
allow_config=has_artifact_access('configure', app=self.app)())
@expose()
def configure(self, **kw):
with push_config(c, app=self.app):
require(has_artifact_access('configure', app=self.app), 'Must have configure permission')
is_admin = self.app.config.tool_name == 'admin'
if kw.pop('delete', False):
if is_admin:
flash('Cannot delete the admin tool, sorry....')
redirect('.')
c.project.uninstall_app(self.app.config.options.mount_point)
redirect('..')
for k,v in kw.iteritems():
self.app.config.options[k] = v
if is_admin:
# possibly moving admin mount point
redirect('/'
+ c.project._id
+ self.app.config.options.mount_point
+ '/'
+ self.app.config.options.mount_point
+ '/')
else:
redirect('../' + self.app.config.options.mount_point + '/')
@expose()
def add_perm(self, permission=None, role=None):
require(has_artifact_access('configure', app=self.app))
self.app.config.acl.setdefault(permission, []).append(ObjectId(role))
redirect('permissions')
@expose()
def del_perm(self, permission=None, role=None):
require(has_artifact_access('configure', app=self.app))
self.app.config.acl[permission].remove(ObjectId(role))
redirect('permissions')