diff options
Diffstat (limited to 'src/mailman/app/templates.py')
| -rw-r--r-- | src/mailman/app/templates.py | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/src/mailman/app/templates.py b/src/mailman/app/templates.py new file mode 100644 index 000000000..61880da12 --- /dev/null +++ b/src/mailman/app/templates.py @@ -0,0 +1,107 @@ +# Copyright (C) 2012 by the Free Software Foundation, Inc. +# +# This file is part of GNU Mailman. +# +# GNU Mailman is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# GNU Mailman 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 General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# GNU Mailman. If not, see <http://www.gnu.org/licenses/>. + +"""Template loader.""" + +from __future__ import absolute_import, print_function, unicode_literals + +__metaclass__ = type +__all__ = [ + 'TemplateLoader', + ] + + +import urllib2 + +from contextlib import closing +from urllib import addinfourl +from urlparse import urlparse +from zope.component import getUtility +from zope.interface import implements + +from mailman.utilities.i18n import TemplateNotFoundError, find +from mailman.interfaces.languages import ILanguageManager +from mailman.interfaces.listmanager import IListManager +from mailman.interfaces.templates import ITemplateLoader + + + +class MailmanHandler(urllib2.BaseHandler): + # Handle internal mailman: URLs. + def mailman_open(self, req): + # Parse urls of the form: + # + # mailman:///<fqdn_listname>/<language>/<template_name> + # + # where only the template name is required. + mlist = code = template = None + # Parse the full requested URL and be sure it's something we handle. + original_url = req.get_full_url() + parsed = urlparse(original_url) + assert(parsed.scheme == 'mailman') + # The path can contain one, two, or three components. Since no empty + # path components are legal, filter them out. + parts = filter(None, parsed.path.split('/')) + if len(parts) == 0: + raise urllib2.URLError('No template specified') + elif len(parts) == 1: + template = parts[0] + elif len(parts) == 2: + part0, template = parts + # Is part0 a language code or a mailing list? It better be one or + # the other, and there's no possibility of namespace collisions + # because language codes don't contain @ and mailing list names + # MUST contain @. + language = getUtility(ILanguageManager).get(part0) + mlist = getUtility(IListManager).get(part0) + if language is None and mlist is None: + raise urllib2.URLError('Bad language or list name') + elif mlist is None: + code = language.code + elif len(parts) == 3: + fqdn_listname, code, template = parts + mlist = getUtility(IListManager).get(fqdn_listname) + if mlist is None: + raise urllib2.URLError('Missing list') + language = getUtility(ILanguageManager).get(code) + if language is None: + raise urllib2.URLError('No such language') + code = language.code + else: + raise urllib2.URLError('No such file') + # Find the template, mutating any missing template exception. + try: + path, fp = find(template, mlist, code) + except TemplateNotFoundError: + raise urllib2.URLError('No such file') + return addinfourl(fp, {}, original_url) + + + +class TemplateLoader: + """Loader of templates, with caching and support for mailman:// URIs.""" + + implements(ITemplateLoader) + + def __init__(self): + opener = urllib2.build_opener(MailmanHandler()) + urllib2.install_opener(opener) + + def get(self, uri): + """See `ITemplateLoader`.""" + with closing(urllib2.urlopen(uri)) as fp: + return fp.read() |
