# -*- coding: utf-8 -*- # # Copyright (C) 2005-2010 Edgewall Software # Copyright (C) 2005-2006 Christopher Lenz # All rights reserved. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms # are also available at http://trac.edgewall.org/wiki/TracLicense. # # This software consists of voluntary contributions made by many # individuals. For the exact contribution history, see the revision # history and logs, available at http://trac.edgewall.org/log/. # # Author: Christopher Lenz """Content presentation for the web layer. The Chrome module deals with delivering and shaping content to the end user, mostly targeting (X)HTML generation but not exclusively, RSS or other forms of web content are also using facilities provided here. """ from __future__ import with_statement import datetime from functools import partial import itertools import os.path import pkg_resources import pprint import re try: from cStringIO import StringIO except ImportError: from StringIO import StringIO from genshi import Markup from genshi.builder import tag, Element from genshi.core import Attrs, START from genshi.filters import Translator from genshi.output import DocType from genshi.template import TemplateLoader, MarkupTemplate, NewTextTemplate from trac import __version__ as VERSION from trac.config import * from trac.core import * from trac.env import IEnvironmentSetupParticipant, ISystemInfoProvider from trac.mimeview.api import RenderingContext, get_mimetype from trac.resource import * from trac.util import compat, get_reporter_id, presentation, get_pkginfo, \ lazy, pathjoin, sha1, translation from trac.util.html import escape, plaintext from trac.util.text import pretty_size, obfuscate_email_address, \ shorten_line, unicode_quote_plus, to_unicode, \ javascript_quote, exception_to_unicode from trac.util.datefmt import pretty_timedelta, format_datetime, format_date, \ format_time, from_utimestamp, http_date, utc, \ user_time from trac.util.translation import _, get_available_locales from trac.web.api import IRequestHandler, ITemplateStreamFilter, HTTPNotFound from trac.web.href import Href from trac.wiki import IWikiSyntaxProvider from trac.wiki.formatter import format_to, format_to_html, format_to_oneliner class INavigationContributor(Interface): """Extension point interface for components that contribute items to the navigation. """ def get_active_navigation_item(req): """This method is only called for the `IRequestHandler` processing the request. It should return the name of the navigation item that should be highlighted as active/current. """ def get_navigation_items(req): """Should return an iterable object over the list of navigation items to add, each being a tuple in the form (category, name, text). """ class ITemplateProvider(Interface): """Extension point interface for components that provide their own Genshi templates and accompanying static resources. """ def get_htdocs_dirs(): """Return a list of directories with static resources (such as style sheets, images, etc.) Each item in the list must be a `(prefix, abspath)` tuple. The `prefix` part defines the path in the URL that requests to these resources are prefixed with. The `abspath` is the absolute path to the directory containing the resources on the local file system. """ def get_templates_dirs(): """Return a list of directories containing the provided template files. """ def add_meta(req, content, http_equiv=None, name=None, scheme=None, lang=None): """Add a `` tag into the `` of the generated HTML.""" meta = {'content': content, 'http-equiv': http_equiv, 'name': name, 'scheme': scheme, 'lang': lang, 'xml:lang': lang} req.chrome.setdefault('metas', []).append(meta) def add_link(req, rel, href, title=None, mimetype=None, classname=None, **attrs): """Add a link to the chrome info that will be inserted as element in the of the generated HTML """ linkid = '%s:%s' % (rel, href) linkset = req.chrome.setdefault('linkset', set()) if linkid in linkset: return # Already added that link link = {'href': href, 'title': title, 'type': mimetype, 'class': classname} link.update(attrs) links = req.chrome.setdefault('links', {}) links.setdefault(rel, []).append(link) linkset.add(linkid) def add_stylesheet(req, filename, mimetype='text/css', media=None): """Add a link to a style sheet to the chrome info so that it gets included in the generated HTML page. If the filename is absolute (i.e. starts with a slash), the generated link will be based off the application root path. If it is relative, the link will be based off the `/chrome/` path. """ if filename.startswith(('http://', 'https://')): href = filename elif filename.startswith('common/') and 'htdocs_location' in req.chrome: href = Href(req.chrome['htdocs_location'])(filename[7:]) else: if filename.startswith('/'): href = req.href(filename) else: href = req.href.chrome(req.chrome['static_hash'], filename) add_link(req, 'stylesheet', href, mimetype=mimetype, media=media) def add_script(req, filename, mimetype='text/javascript', charset='utf-8', ie_if=None): """Add a reference to an external javascript file to the template. If the filename is absolute (i.e. starts with a slash), the generated link will be based off the application root path. If it is relative, the link will be based off the `/chrome/` path. """ scriptset = req.chrome.setdefault('scriptset', set()) if filename in scriptset: return False # Already added that script if filename.startswith(('http://', 'https://')): href = filename elif filename.startswith('common/') and 'htdocs_location' in req.chrome: href = Href(req.chrome['htdocs_location'])(filename[7:]) else: if filename.startswith('/'): href = req.href(filename) else: href = req.href.chrome(req.chrome['static_hash'], filename) script = {'href': href, 'type': mimetype, 'charset': charset, 'prefix': Markup('') if ie_if else None} req.chrome.setdefault('scripts', []).append(script) scriptset.add(filename) def add_script_data(req, data): """Add data to be made available in javascript scripts as global variables. The keys in `data` provide the names of the global variables. The values are converted to JSON and assigned to the corresponding variables. """ req.chrome.setdefault('script_data', {}).update(data) def add_javascript(req, filename): """:deprecated: use `add_script` instead.""" add_script(req, filename, mimetype='text/javascript') def add_warning(req, msg, *args): """Add a non-fatal warning to the request object. When rendering pages, any warnings will be rendered to the user.""" if args: msg %= args req.chrome['warnings'].append(msg) def add_notice(req, msg, *args): """Add an informational notice to the request object. When rendering pages, any notice will be rendered to the user.""" if args: msg %= args req.chrome['notices'].append(msg) def add_ctxtnav(req, elm_or_label, href=None, title=None): """Add an entry to the current page's ctxtnav bar.""" if href: elm = tag.a(elm_or_label, href=href, title=title) else: elm = elm_or_label req.chrome.setdefault('ctxtnav', []).append(elm) def prevnext_nav(req, prev_label, next_label, up_label=None): """Add Previous/Up/Next navigation links. :param req: a `Request` object :param prev_label: the label to use for left (previous) link :param up_label: the label to use for the middle (up) link :param next_label: the label to use for right (next) link """ links = req.chrome['links'] prev_link = next_link = None if not any(lnk in links for lnk in ('prev', 'up', 'next')): # Short circuit return if 'prev' in links: prev = links['prev'][0] prev_link = tag.a(prev_label, href=prev['href'], title=prev['title'], class_='prev') add_ctxtnav(req, tag.span(Markup('← '), prev_link or prev_label, class_='missing' if not prev_link else None)) if up_label and 'up' in links: up = links['up'][0] add_ctxtnav(req, tag.a(up_label, href=up['href'], title=up['title'])) if 'next' in links: next_ = links['next'][0] next_link = tag.a(next_label, href=next_['href'], title=next_['title'], class_='next') add_ctxtnav(req, tag.span(next_link or next_label, Markup(' →'), class_='missing' if not next_link else None)) def web_context(req, resource=None, id=False, version=False, parent=False, absurls=False): """Create a rendering context from a request. The `perm` and `href` properties of the context will be initialized from the corresponding properties of the request object. >>> from trac.test import Mock, MockPerm >>> req = Mock(href=Mock(), perm=MockPerm()) >>> context = web_context(req) >>> context.href is req.href True >>> context.perm is req.perm True :param req: the HTTP request object :param resource: the `Resource` object or realm :param id: the resource identifier :param version: the resource version :param absurls: whether URLs generated by the ``href`` object should be absolute (including the protocol scheme and host name) :return: a new rendering context :rtype: `RenderingContext` """ if req: href = req.abs_href if absurls else req.href perm = req.perm else: href = None perm = None self = RenderingContext(Resource(resource, id=id, version=version, parent=parent), href=href, perm=perm) self.req = req return self def auth_link(req, link): """Return an "authenticated" link to `link` for authenticated users. If the user is anonymous, returns `link` unchanged. For authenticated users, returns a link to `/login` that redirects to `link` after authentication. """ if req.authname != 'anonymous': return req.href.login(referer=link) return link def _save_messages(req, url, permanent): """Save warnings and notices in case of redirect, so that they can be displayed after the redirect.""" for type_ in ['warnings', 'notices']: for (i, message) in enumerate(req.chrome[type_]): req.session['chrome.%s.%d' % (type_, i)] = escape(message) # Mappings for removal of control characters _translate_nop = "".join([chr(i) for i in range(256)]) _invalid_control_chars = "".join([chr(i) for i in range(32) if i not in [0x09, 0x0a, 0x0d]]) class Chrome(Component): """Web site chrome assembly manager. Chrome is everything that is not actual page content. """ required = True implements(ISystemInfoProvider, IEnvironmentSetupParticipant, IRequestHandler, ITemplateProvider, IWikiSyntaxProvider) navigation_contributors = ExtensionPoint(INavigationContributor) template_providers = ExtensionPoint(ITemplateProvider) stream_filters = ExtensionPoint(ITemplateStreamFilter) shared_templates_dir = PathOption('inherit', 'templates_dir', '', """Path to the //shared templates directory//. Templates in that directory are loaded in addition to those in the environments `templates` directory, but the latter take precedence. (''since 0.11'')""") shared_htdocs_dir = PathOption('inherit', 'htdocs_dir', '', """Path to the //shared htdocs directory//. Static resources in that directory are mapped to /chrome/shared under the environment URL, in addition to common and site locations. This can be useful in site.html for common interface customization of multiple Trac environments. (''since 0.13'')""") auto_reload = BoolOption('trac', 'auto_reload', False, """Automatically reload template files after modification.""") fingerprint_resources = ChoiceOption('trac', 'fingerprint_resources', ['content', 'meta', 'disabled'], """Control the fingerprinting of static resources. URLs to static resources below `/chrome` have the form `/chrome/![0-9a-f]{8}/.*`, where the second element is a fingerprint of the ''content'' of all resources (for "content") or their ''metadata'' (size and mtime, for "meta"). This allows aggressive caching of static resources on the browser, while still ensuring that they are reloaded when they change. Setting this option to "disabled" disables fingerprinting, and reverts the URLs to static resources to `/chrome/.*`. (''since 0.13'')""") genshi_cache_size = IntOption('trac', 'genshi_cache_size', 128, """The maximum number of templates that the template loader will cache in memory. The default value is 128. You may want to choose a higher value if your site uses a larger number of templates, and you have enough memory to spare, or you can reduce it if you are short on memory.""") htdocs_location = Option('trac', 'htdocs_location', '', """Base URL for serving the core static resources below `/chrome/common/`. It can be left empty, and Trac will simply serve those resources itself. Advanced users can use this together with [TracAdmin trac-admin ... deploy ] to allow serving the static resources for Trac directly from the web server. Note however that this only applies to the `/htdocs/common` directory, the other deployed resources (i.e. those from plugins) will not be made available this way and additional rewrite rules will be needed in the web server.""") jquery_location = Option('trac', 'jquery_location', '', """Location of the jQuery !JavaScript library (version 1.5.1). An empty value loads jQuery from the copy bundled with Trac. Alternatively, jQuery could be loaded from a CDN, for example: http://code.jquery.com/jquery-1.5.1.min.js, http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.5.1.min.js or https://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js. (''since 0.13'')""") metanav_order = ListOption('trac', 'metanav', 'login, logout, prefs, help, about', doc= """Order of the items to display in the `metanav` navigation bar, listed by IDs. See also TracNavigation.""") mainnav_order = ListOption('trac', 'mainnav', 'wiki, timeline, roadmap, browser, tickets, ' 'newticket, search', doc= """Order of the items to display in the `mainnav` navigation bar, listed by IDs. See also TracNavigation.""") logo_link = Option('header_logo', 'link', '', """URL to link to, from the header logo.""") logo_src = Option('header_logo', 'src', 'site/your_project_logo.png', """URL of the image to use as header logo. It can be absolute, server relative or relative. If relative, it is relative to one of the `/chrome` locations: `site/your-logo.png` if `your-logo.png` is located in the `htdocs` folder within your TracEnvironment; `common/your-logo.png` if `your-logo.png` is located in the folder mapped to the [#trac-section htdocs_location] URL. Only specifying `your-logo.png` is equivalent to the latter.""") logo_alt = Option('header_logo', 'alt', "(please configure the [header_logo] section in trac.ini)", """Alternative text for the header logo.""") logo_width = IntOption('header_logo', 'width', -1, """Width of the header logo image in pixels.""") logo_height = IntOption('header_logo', 'height', -1, """Height of the header logo image in pixels.""") show_email_addresses = BoolOption('trac', 'show_email_addresses', 'false', """Show email addresses instead of usernames. If false, we obfuscate email addresses. (''since 0.11'')""") never_obfuscate_mailto = BoolOption('trac', 'never_obfuscate_mailto', 'false', """Never obfuscate `mailto:` links explicitly written in the wiki, even if `show_email_addresses` is false or the user has not the EMAIL_VIEW permission (''since 0.11.6'').""") show_ip_addresses = BoolOption('trac', 'show_ip_addresses', 'false', """Show IP addresses for resource edits (e.g. wiki). (''since 0.11.3'')""") resizable_textareas = BoolOption('trac', 'resizable_textareas', 'true', """Make `