File: //usr/lib/python3/dist-packages/trac/web/__pycache__/chrome.cpython-310.pyc
o
�k�`� � @ s� d Z ddlmZ ddlZddlZddlZddlZddlZddl Z ddl
Z
ddl m Z ddl
mZ ddlmZmZ ddlT ddlT ddlmZmZ dd lmZ ddlT dd
lmZm Z m Z m Z m Z m Z m!Z!m"Z"m#Z# dd l$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+ dd l,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6 dd
l7m8Z8m9Z9m:Z:m;Z;m<Z<m=Z=m>Z>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJ ddlKmLZLmMZM ddlNmOZOmPZP ddlQmRZR ddlSmTZT ddlUmVZVmWZWmXZX dZYdZZG dd� de[�Z\G dd� de[�Z]dd� Z^d@dd �Z_dAd d �Z`dBd d!�ZadCd#d$�Zbi fd%d&�Zcd'd(� Zdd)d*� Zed+d,� ZfdDd-d.�ZgdEd/d0�Zh 1 1dFd2d3�Zid4d5� ZjdEd6d7�Zkd8d9� Zld:d;� Zmed<d=� �ZnG d>d?� d?eo�ZpdS )Gz�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.
� )�contextmanagerN)�partial)�FileSystemLoader)� IEnvironmentSetupParticipant�ISystemInfoProvider)�*)�RenderingContext� get_mimetype)�IPermissionRequestor) �as_bool�as_int� get_pkginfo�get_reporter_id�html�pathjoin� presentation�to_list� translation)�Element�Markup�escape� plaintext�tag� to_fragment�valid_html_bytes)
�exception_to_unicode�
is_obfuscated�javascript_quote� jinja2env�obfuscate_email_address� pretty_size� shorten_line� to_js_string�
to_unicode�unicode_quote_plus)�pretty_timedelta� datetime_now�format_datetime� format_date� format_time�from_utimestamp� http_date�utc�get_date_format_jquery_ui� is_24_hours�get_time_format_jquery_ui� user_time�get_month_names_jquery_ui�get_day_names_jquery_ui�get_timezone_list_jquery_ui� get_first_week_day_jquery_ui�"get_timepicker_separator_jquery_ui�get_period_names_jquery_ui�localtz)�_�get_available_locales)�IRequestHandler� HTTPNotFound)�Href)�IWikiSyntaxProvider)� format_to�format_to_html�format_to_oneliner)�wiki�timeline�roadmap�browser�tickets� newticket�search�admin)�login�logout�prefs�help�aboutc @ � e Zd ZdZdd� Zdd� ZdS )�INavigationContributorzZExtension point interface for components that contribute items to the
navigation.
c C � dS )z�This method is only called for the `IRequestHandler` processing
the request.
It should return the name of the navigation item to be highlighted
as active/current.
N� ��reqrQ rQ �1/usr/lib/python3/dist-packages/trac/web/chrome.py�get_active_navigation_itemJ � z1INavigationContributor.get_active_navigation_itemc C rP )a� Should return an iterable object over the list of navigation items
to add, each being a tuple in the form (category, name, text).
The category determines the location of the navigation item and
can be `mainnav` or `metanav`. The name is a unique identifier that
must match the string returned by get_active_navigation_item.
The text is typically a link element with text that corresponds
to the desired label for the navigation item, and an href.
NrQ rR rQ rQ rT �get_navigation_itemsR rV z+INavigationContributor.get_navigation_itemsN)�__name__�
__module__� __qualname__�__doc__rU rW rQ rQ rQ rT rO E s rO c @ rN )�ITemplateProviderz�Extension point interface for components that provide their own
Jinja2 templates and/or accompanying static resources.
c C rP )a� 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.
NrQ rQ rQ rQ rT �get_htdocs_dirsd rV z!ITemplateProvider.get_htdocs_dirsc C rP )zUReturn a list of directories containing the provided template
files.
NrQ rQ rQ rQ rT �get_templates_dirsp rV z$ITemplateProvider.get_templates_dirsN)rX rY rZ r[ r] r^ rQ rQ rQ rT r\ ^ s r\ c C s | j �d�r|S dS )zXHelper function for creating accesskey HTML attribute according
to preference values�
accesskeysN)�sessionr )rS �keyrQ rQ rT � accesskeyv s rb c C s* ||||||d�}| j �dg ��|� dS )z;Add a `<meta>` tag into the `<head>` of the generated HTML.)�contentz
http-equiv�name�scheme�langzxml:lang�metasN)�chrome�
setdefault�append)rS rc �
http_equivrd re rf �metarQ rQ rT �add_meta| s �rm c K sn d||f }| j �dt� �}||v rdS ||||d�} | �|� | j �di �}
|
�|g ��| � |�|� dS )zrAdd a link to the chrome info that will be inserted as <link> element in
the <head> of the generated HTML
z%s:%s�linksetN)�href�title�type�class�links)rh ri �set�updaterj �add) rS �relro rp �mimetype� classname�attrs�linkidrn �linkrs rQ rQ rT �add_link� s
r} �text/cssc K s& t | |�}t| d|fd|i|�� dS )a� Add a link to a style sheet to the chrome info so that it gets included
in the generated HTML page.
If `filename` is a network-path reference (i.e. starts with a protocol
or `//`), the return value will not be modified. If `filename` is absolute
(i.e. starts with `/`), the generated link will be based off the
application root path. If it is relative, the link will be based off the
`/chrome/` path.
�
stylesheetrx N)�chrome_resource_pathr} )rS �filenamerx rz ro rQ rQ rT �add_stylesheet� s
r� �text/javascriptc C sp | j �dt� �}||v rdS t| |�}dd|ii}|dkr'|dur'||d d< | j �dg ��|� |�|� dS ) a� Add a reference to an external javascript file to the template.
If `filename` is a network-path reference (i.e. starts with a protocol
or `//`), the return value will not be modified. If `filename` is absolute
(i.e. starts with `/`), the generated link will be based off the
application root path. If it is relative, the link will be based off the
`/chrome/` path.
� scriptsetFrz �srcr� Nrq �scripts)rh ri rt r� rj rv )rS r� rx r� ro �scriptrQ rQ rT �
add_script� s
r� c K s& | j �di �}|�|� |�|� dS )a Add data to be made available in javascript scripts as global variables.
The keys in `data` and the keyword argument names provide the names of the
global variables. The values are converted to JSON and assigned to the
corresponding variables.
� script_dataN)rh ri ru )rS �data�kwargsr� rQ rQ rT �add_script_data� s
r� c G � t | d||� dS )z�Add a non-fatal warning to the request object.
When rendering pages, all warnings will be rendered to the user. Note that
the message is escaped (and therefore converted to `Markup`) before it is
stored in the request object.
�warningsN�� _add_message�rS �msg�argsrQ rQ rT � add_warning� � r� c G r� )z�Add an informational notice to the request object.
When rendering pages, all notices will be rendered to the user. Note that
the message is escaped (and therefore converted to `Markup`) before it is
stored in the request object.
�noticesNr� r� rQ rQ rT �
add_notice� r� r� c C sH |r||; }t |t�stt|��}|| j| vr"| j| �|� d S d S �N)�
isinstancer r rh rj )rS rd r� r� rQ rQ rT r� � s
�r� c C s2 |r t j|||d�}n|}| j�dg ��|� dS )z/Add an entry to the current page's ctxtnav bar.�ro rp �ctxtnavN)r �arh ri rj )rS � elm_or_labelro rp �elmrQ rQ rT � add_ctxtnav� s r� c s | j d � d }}t� fdd�dD ��sdS d� v r-� d d }tj||d |d dd
�}t| tjtd �|p7||s;d ndd
�� |r[d� v r[� d d }t| tj||d |d d�� d� v rr� d d }tj||d |d dd
�}t| tj|py|td�|s�d ndd
�� dS )a" 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
rs Nc 3 s � | ]}|� v V qd S r� rQ )�.0�lnk�rs rQ rT � <genexpr>� s � z prevnext_nav.<locals>.<genexpr>)�prev�up�nextr� r ro rp )ro rp �class_z← �missing�r� r� r� r� z →)rh �anyr r� r� �spanr ) rS �
prev_label�
next_label�up_label� prev_link� next_linkr� r� �next_rQ r� rT � prevnext_nav� s.
�
� �
�r� Fc C sH | r|r| j n| j}| j}nd}d}tt||||d�||d�}| |_|S )aO 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`
:since: version 1.0
N)�id�version�parent)ro �perm)�abs_hrefro r� r �ResourcerS ) rS �resourcer� r� r� �absurlsro r� �selfrQ rQ rT � web_context
s
��r� c C s | j r
| jj|d�S |S )z�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.
)�referer)�is_authenticatedro rI )rS r| rQ rQ rT � auth_link4 s r� c
C s< | j }|r |�di ��dg �}|�dg �}|�di �}n4|�di ��dg �|�di ��dg � }|�dg �|�dg � }i }|�|�d i �� |�|�d
i �� g }|�d d � |pZd
D �� |�dd � |pfi �� D �� t� }|r~|�tjd�|�dd�� |D ]}|d } |�t�dt | d �t | �d��f �� q�|S )z�Get script elements from chrome info of the request object during
rendering template or after rendering.
:param req: the HTTP request object.
:param use_late: if True, `late_links` will be used instead of `links`.
�
late_linksr � late_scripts�late_script_data� early_linksrs �
early_scriptsr� �early_script_datar� c s s, � | ]}d t |d �t |d �f V qdS )z jQuery.loadStyleSheet(%s, %s);ro rq N)r" )r� r| rQ rQ rT r� U s � � �z%chrome_info_script.<locals>.<genexpr>rQ c s s& � | ]\}}d |t �|�f V qdS )z
var %s=%s;N)r �to_json)r� rd �valuerQ rQ rT r� X s � ��
r� )rq rz zjQuery.loadScript(%s, %s)r� rq )
rh �getru �extend�itemsr rj r� �joinr" )
rS �use_laterh rs r� r� rc �fragmentr� rz rQ rQ rT �chrome_info_script@ s< �
�
� ��r� c C s\ |� d�r|S |� d�r d| jv r t| jd �|dd� �S |� d�r&| jn| jj}||�S )a Get the path for a chrome resource given its `filename`.
If `filename` is a network-path reference (i.e. starts with a protocol
or `//`), the return value will not be modified. If `filename` is absolute
(i.e. starts with `/`), the generated link will be based off the
application root path. If it is relative, the link will be based off the
`/chrome/` path.
)�http://�https://z//zcommon/�htdocs_location� N�/)�
startswithrh r< ro )rS r� ro rQ rQ rT r� g s
r� c C s> dD ]}t | j| �D ]\}}t|d�| jd||f < q qdS )zdSave warnings and notices in case of redirect, so that they can
be displayed after the redirect.�r� r� F� chrome.%s.%dN)� enumeraterh r r` )rS �url� permanent�type_�i�messagerQ rQ rT �_save_messagesy s
��r� c c st � | � |��* zdV W n ty' } zt|td|jjt|�d�� � d}~ww W d � dS 1 s3w Y dS )z{Traps any runtime exception raised when working with a
component, logs the error and adds a warning for the user.
Nz!%(component)s failed with %(exc)s)� component�exc)�component_guard� Exceptionr� r8 � __class__rX r )�envrS r� �erQ rQ rT r� � s �
����"�r� c @ s| e Zd ZdZeeeeee e
� dZ dZ e
e�Ze
e �Zedddd�Zedddd �Zed
d dd �Zed
d
dd�Zed
dddddid�Zed
dddddid�Zed
dddddid�Zedd�Z edd �Z ed d dd �Z ed d d!d"�Z ed d#d$d%�Z e!d d&d'd(�Z"e!d d)d'd*�Z#ed
d+d,d-�Z$ed
d.d/d0�Z%ed
d1d,d2�Z&ed
d3d/d4�Z'ed
d5d/d6�Z(e)d
d7d8d9�Z*e+d
d:d;d<�Z,ed
d=d/d>�Z-d?Z.d?Z/d?Z0i d@e1�dAe2�dBe3�dCe4�dDe5j6�dEe5j5�dFe7j8�dGe9�dHe:j;�dIe<�dJe=�dKe>�dLe?�dMe@�dNeA�dOeB�dPeCjD�eEeFeGeHeIeJe5jKe5jLeMeNdQ�
�ZOdRdS� ZPdTdU� ZQdVdW� ZRdXdY� ZSdZd[� ZTd\d]� ZUd^d_� ZVd`da� ZWdbdc� ZXddde� ZYdfdg� ZZdhdi� Z[djdk� Z\d�dldm�Z]dndo� Z^d�dpdq�Z_drds� Z`dtdu� Zadvdw� Zbd�dxdy�Zcdzd{� Zdee�fd|�Zgd}d~� Zhdd�� Zid�d�d��Zjd�d�d��Zkd�d�� Zld�d�� Zmd�d�� Znd�d�� Zod�d�� Zpd�d�d��Zqd�d�d��Zrd�d�� Zsd�d�d��Ztd�d�d��Zud�d�d��Zv ?d�d�d��Zwd�d�d��Zxd�d�d��Zyd?S )��ChromezaWeb site chrome assembly manager.
Chrome is everything that is not actual page content.
TF�inherit�
templates_dir� a" 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.
Non-absolute paths are relative to the Environment `conf`
directory.
�
htdocs_dira� 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.
Non-absolute paths are relative to the Environment `conf`
directory.
(''since 1.0'')�trac� auto_reloadz7Automatically reload template files after modification.r� as 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 <deploydir>] to allow serving the
static resources for Trac directly from the web server.
Note however that this only applies to the `<deploydir>/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_locationa� Location of the jQuery !JavaScript library (version %(version)s).
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-%(version)s.min.js,
http://ajax.aspnetcdn.com/ajax/jQuery/jquery-%(version)s.min.js or
https://ajax.googleapis.com/ajax/libs/jquery/%(version)s/jquery.min.js.
(''since 1.0'')r� z1.12.4)�doc_args�jquery_ui_locationa� Location of the jQuery UI !JavaScript library (version %(version)s).
An empty value loads jQuery UI from the copy bundled with Trac.
Alternatively, jQuery UI could be loaded from a CDN, for example:
https://ajax.googleapis.com/ajax/libs/jqueryui/%(version)s/jquery-ui.min.js
or
http://ajax.aspnetcdn.com/ajax/jquery.ui/%(version)s/jquery-ui.min.js.
(''since 1.0'')z1.12.1�jquery_ui_theme_locationa Location of the theme to be used with the jQuery UI !JavaScript
library (version %(version)s).
An empty value loads the custom Trac jQuery UI theme from the copy
bundled with Trac.
Alternatively, a jQuery UI theme could be loaded from a CDN, for
example:
https://ajax.googleapis.com/ajax/libs/jqueryui/%(version)s/themes/start/jquery-ui.css
or
http://ajax.aspnetcdn.com/ajax/jquery.ui/%(version)s/themes/start/jquery-ui.css.
(''since 1.0'')�mainnava� Configures the main navigation bar,
which by default contains //Wiki//, //Timeline//, //Roadmap//,
//Browse Source//, //View Tickets//, //New Ticket//, //Search// and
//Admin//.
The `label`, `href`, and `order` attributes can be specified. Entries
can be disabled by setting the value of the navigation item to
`disabled`.
The following example renames the link to WikiStart to //Home//,
links the //View Tickets// entry to a specific report and disables
the //Search// entry.
{{{#!ini
[mainnav]
wiki.label = Home
tickets.href = /report/24
search = disabled
}}}
See TracNavigation for more details.
�metanava� Configures the meta navigation
entries, which by default are //Login//, //Logout//, //Preferences//,
''!Help/Guide'' and //About Trac//. The allowed attributes are the
same as for `[mainnav]`. Additionally, a special entry is supported -
`logout.redirect` is the page the user sees after hitting the logout
button. For example:
{{{#!ini
[metanav]
logout.redirect = wiki/Logout
}}}
See TracNavigation for more details.
� header_logor| z%URL to link to, from the header logo.r� zsite/your_project_logo.pnga� 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.�altz8(please configure the [header_logo] section in trac.ini)z%Alternative text for the header logo.�width���z)Width of the header logo image in pixels.�heightz*Height of the header logo image in pixels.�show_email_addresses�falsez�Show email addresses instead of usernames. If false, email
addresses are obfuscated for users that don't have EMAIL_VIEW
permission.
�show_full_names�truez5Show full names instead of usernames. (//since 1.2//)�never_obfuscate_mailtoz�Never obfuscate `mailto:` links explicitly written in the wiki,
even if `show_email_addresses` is false or the user doesn't have
EMAIL_VIEW permission.
�resizable_textareaszBMake `<textarea>` fields resizable. Requires !JavaScript.
�
wiki_toolbarszJAdd a simple toolbar on top of Wiki <textarea>s.
(''since 1.0.2'')�auto_preview_timeoutg @a Inactivity timeout in seconds after which the automatic wiki preview
triggers an update. This option can contain floating-point values. The
lower the setting, the more requests will be made to the server. Set
this to 0 to disable automatic preview.
�default_dateinfo_format)�relative�absolutez�The date information format. Valid options are 'relative' for
displaying relative format and 'absolute' for displaying absolute
format. (''since 1.0'')�use_chunked_encodingz�If enabled, send contents as chunked encoding in HTTP/1.1.
Otherwise, send contents with `Content-Length` header after entire of
the contents are rendered. (''since 1.0.6'')N�allr� r r �date�datetime� find_elementr �groupbyr+ r r �operatorr r r �pprint)
r r% �
quote_plus�reversedr! �sorted�time� timedeltar# r, c c s� � dd l }t|��d�}d|fV zdd l}W n ty" d }Y nw |d urBt|��d�}t� s;|d7 }| j�d� d|fV d S d S )Nr r� �Jinja2z (translations unavailable)zLocale data is missing�Babel)�jinja2r
r� �babel� ImportErrorr9 �log�warning)r� r �infor rQ rQ rT �get_system_info} s �
� �zChrome.get_system_infoc sR d� fdd� }|ddd� |dd� |d d
� � fd d �}|d
t � |dt� dS )z:Add the sample templates to the environment templates dir.r� c s` t j�� jj| d �}t|ddd��}|�d|| | |f � W d � d S 1 s)w Y d S )Nz.sample�w�utf-8)�encodinga� {# This file allows customizing the appearance of the Trac installation.
Add your customizations to the %s here
and rename the file to %s.
Note that it will take precedence over a global %s placed
in the directory specified by [inherit] templates_dir.
More information about site appearance customization can be found here:
https://trac.edgewall.org/wiki/TracInterfaceCustomization#SiteAppearance
#}
%s
)�os�pathr� r� r� �open�write)r� �kind�example� site_path�fileobj�r� rQ rT �write_sample_template� s �
�"�z9Chrome.environment_created.<locals>.write_sample_templatezsite_head.htmlzthe end of the HTML <head>zR
<link rel="stylesheet" type="text/css" href="${href.chrome('site/style.css')}"/>
zsite_header.htmlz$the start of the HTML <body> contentzsite_footer.htmlz"the end of the HTML <body> contentc s2 t |d�D ]\}}� jj�| |d t|�� qd S )N� �.order)r� r� �configrt �float)�section�defaultr� rd r$ rQ rT �add_nav_order_options� s �z9Chrome.environment_created.<locals>.add_nav_order_optionsr� r� N)r� )�default_mainnav_order�default_metanav_order)r� r% r, rQ r$ rT �environment_created� s ���
zChrome.environment_createdc C rP �NFrQ r$ rQ rQ rT �environment_needs_upgrade� � z Chrome.environment_needs_upgradec C s d S r� rQ r$ rQ rQ rT �upgrade_environment� r2 zChrome.upgrade_environmentc C s: t �d|j�}|r|�d�|jd< |�d�|jd< dS d S )Nz+/chrome/(?P<prefix>[^/]+)/+(?P<filename>.+)�prefixr� T)�re�match� path_info�groupr� )r� rS r6 rQ rQ rT �
match_request� s ��zChrome.match_requestc s� |j d � |j d }g }| jD ]B}� fdd�|�� pg D �D ]2}|�|� tj�tj�||��}tj�||g�|krBt t
d|d���tj� |�rP|� |t
|�� q q| j�d||� td|��) Nr4 r� c s0 g | ]}|d � kr|d rt j�|d ��qS )r r& )r r �normpath)r� �dir�r4 rQ rT �
<listcomp>� s �z*Chrome.process_request.<locals>.<listcomp>z Invalid chrome path %(path)s.)r z File %s not found in any of %szFile %s not found)r� �template_providersr] rj r r r: r� � commonprefix� TracErrorr8 �isfile� send_filer r r r; )r� rS r� �dirs�providerr; r rQ r< rT �process_request� s&
�
� ��
zChrome.process_requestc C s dgS )zt`EMAIL_VIEW` permission allows for showing email addresses even
if `[trac] show_email_addresses` is `false`.�
EMAIL_VIEWrQ r$ rQ rQ rT �get_permission_actions� s z Chrome.get_permission_actionsc C s$ dt �dd�fd| jfd| jjfgS )N�commonr� �htdocs�shared�site)�
pkg_resources�resource_filename�shared_htdocs_dirr� r� r$ rQ rQ rT r] � s
�zChrome.get_htdocs_dirsc C s" t td | jj| jt�dd�g��S )Nr� � templates)�list�filterr� r� �shared_templates_dirrL rM r$ rQ rQ rT r^ � s
�zChrome.get_templates_dirsc C s g S r� rQ r$ rQ rQ rT �get_wiki_syntax� r2 zChrome.get_wiki_syntaxc c s � d| j fV d S )NrI )� _format_linkr$ rQ rQ rT �get_link_resolvers� s �zChrome.get_link_resolversc C s4 |� |�\}}}|j�d|�| | }tj||d�S )NrK �ro )�
split_linkro rh r r� )r� � formatter�ns�file�label�queryr� ro rQ rQ rT rT � s zChrome._format_linkc C s& g }| j D ] }|�|�� pg � q|S )z>Return a list of the names of all known templates directories.)r> r� r^ )r� rC rD rQ rQ rT �get_all_templates_dirs� s
z Chrome.get_all_templates_dirsc C s� | j �d� g i g i g g g d�}||_| jp|j�d�}|�d�d |d< t|d|j�� � t|d|j�� � t|d|j�d �� t |d
� t
|| j pLd � |d ur^t |j
d
d�r^t
|d� t
|d� |jd urwt|j�dkrwt
|d|j � t
|d� t
|d� t
|d� | �|�|d< |d r�|d d }|d d }t|d||d� | �|j|j�|d< | �||�|d< d |d < |�t� |S ) z�Prepare the basic chrome data for the request.
:param req: the request object
:param handler: the `IRequestHandler` instance that is processing the
request
z Prepare chrome data for request)rg rs r� r� r� r� r� rH r� r� �startrG rL � TracGuidezcommon/css/trac.csszcommon/js/jquery.jsN�jquery_noconflictFzcommon/js/noconflict.jszcommon/js/babel.js�en_USzcommon/js/messages/%s.jszcommon/js/trac.jszcommon/js/search.jszcommon/js/folding.js�iconr� rx )rx �logo�navz
theme.html�theme)r �debugrh r� ro �rstripr} rA rG r� r� r� �getattrr� �locale�str�
get_icon_data�
get_logo_datar� rW �add_redirect_listenerr� )r� rS �handlerrh r� r� rx rQ rQ rT �prepare_request s@ �
�
zChrome.prepare_requestc C s� i }| j j }}|r?|�d�s5|�d�dkr5d|v r'|j�|�}|j�|�}n|j�d|�}|j�d|�}t|�}|||d�}|S )Nr� z://r� rH )r� �abs_srcrx )r� � project_iconr� �findr� rh ro r )r� rS rb �icon_src� icon_abs_srcrx rQ rQ rT rk < s �zChrome.get_icon_datac C s� i }| j }|rO|p
|}|�d�r|}nd|v r"|�|�}|�|�}n |�d|�}|�d|�}| jdkr6| jnd }| jdkr@| jnd }| j||| j||d�}|S | j| jd�}|S )N)r� r� r� r� rH r� )r| r� �src_absr� r� r� )r| r� )�logo_srcr� rh �
logo_width� logo_height� logo_link�logo_alt)r� ro r� rc rv � logo_src_absr� r� rQ rQ rT rl L s(
��zChrome.get_logo_datac s� � �fdd�}i }d }�j D ];}t�j� |��* |�� �p g D ]\}}} |||| �|�|i �|< q ||u r:|�� �}W d � n1 sDw Y qd}
t|
t|
��D ]\\}} �j| } | D ]P}d|vr�||� |g �vr�d } | |v r�||| v r�|| | || |< || |= || | � d�} |||| �}
|
|�|i �|< |
d r�|
d � �
� j �kr�|}q^qSi }|� � D ]=\}}|�|g � t
t|� � �dd� d �D ]&\}}
|
d
r�|
d r�|
d r�|
d � jv r�|| �||
d ||kd �� q�q�|S )
Nc s� �j | }|�|d �}|�|d �}|r |�d�r � j| }t|t�r:|jdkr:|}|r2||jd< |r9||d�}n|s>|rJtj|pE|pE||d�}n|}|� |d�|�
|d t d ��||||�|d
�d �S ) Nz.hrefz.labelr� r� r rV Tr' �infz .permission)�enabled�orderr[ ro r| r� ) r( r� r� ro r� r r �childrenr� �getbool�getfloatr) )�categoryrd �textr* ro r[ r| �rS r� rQ rT �get_item_attributesj s,
�
�z8Chrome.get_navigation_items.<locals>.get_item_attributes)r� r� �.r| ro c S s | d d | d fS )Nr& r~ r rQ )� name_attrrQ rQ rT �<lambda>� s z-Chrome.get_navigation_items.<locals>.<lambda>�ra r} r� )rd r[ �active)�navigation_contributorsr� r� rW ri rU �zipr r( r� ro r7 r� r
�iterr� rj )r� rS rn r� � all_itemsr� � contributorr� rd r� �
categories�other_categoryr* �
attributes� nav_items�category_itemsrQ r� rT rW h sj
�
�
� ��
�
�� �
����� zChrome.get_navigation_itemsc C sd ddd�}i }d}|| j j|�}|| j|�}|| j j�}|| j�}t||||f�r0||||d�}|S )z�Returns a dictionary containing the lists of files present in the
site and shared templates and htdocs directories.
Nc s, t j�| �sg S t� fdd�t �| �D ��S )Nc 3 s* � | ]}� d u s
|� � �rt|�V qd S r� )�endswithr# )r� rd ��suffixrQ rT r� � s � ��zMChrome.get_interface_customization_files.<locals>.list_dir.<locals>.<genexpr>)r r �isdirr
�listdir)r r� rQ r� rT �list_dir� s z:Chrome.get_interface_customization_files.<locals>.list_dir)z.htmlz.txt)zsite-templateszshared-templatesz site-htdocsz
shared-htdocsr� )r� r� rR r� rN r� )r� r� �files�exts�site_templates�shared_templates� site_htdocs�
shared_htdocsrQ rQ rT �!get_interface_customization_files� s
�z(Chrome.get_interface_customization_filesc C s$ |rd|vr|� |�r|� |�}|S )zeReturns the author email from the `email_map` if `author`
doesn't look like an email address.�@)r� )r� �author� email_maprQ rQ rT � author_email� s
zChrome.author_emailc C s, | � ||�}tj| �|||�| �||�d�S )a` Format a username to HTML.
Calls `Chrome.format_author` to format the username, and wraps
the formatted username in a `span` with class `trac-author`,
`trac-author-anonymous` or `trac-author-none`.
:param req: the `Request` object.
:param author: the author string to be formatted.
:param email_map: dictionary mapping usernames to email addresses.
:param resource: optional `Resource` object for `EMAIL_VIEW`
fine-grained permissions checks.
:since 1.1.6: accepts the optional `resource` keyword parameter.
r� )r� r r� �
format_author� author_class)r� rS r� r� r� rQ rQ rT �
authorinfo� s
�zChrome.authorinfoc C sB d}|dkr d}d| S |sd}d| S |r ||j kr d}d| S )Nr� � anonymousz
-anonymousz-nonez-userz trac-author)�authname)r� rS r� r� rQ rQ rT r� � s ��zChrome.author_classz".*<([^@]+)@[^@]+>\s*|([^@]+)@[^@]+c C s< d }| j �|pd�}|r|�d�p|�d�}| �d |p |�S )Nr� r& � )�_long_author_rer6 r8 r� )r� r� � shortenedr6 rQ rQ rT �authorinfo_short� s
zChrome.authorinfo_shortc C s
t |d�S )z)Split a CC: value in a list of addresses.z[;,])r )r� �cc_fieldrQ rQ rT �cc_list s
zChrome.cc_listc C s� |dkrt d�S |st d�S | jjdd�}| jr&||v r&|| d }|r&|S |du r8| j}|s8|r8d|�|�v }|r<|S t|�S )a� Format a username in plain text.
If `[trac]` `show_email_addresses` is `False`, email addresses
will be obfuscated when the user doesn't have `EMAIL_VIEW`
(for the resource) and the optional parameter `show_email` is
`None`. Returns translated `anonymous` or `none`, when the
author string is `anonymous` or evaluates to `False`,
respectively.
:param req: a `Request` or `RenderingContext` object.
:param author: the author string to be formatted.
:param resource: an optional `Resource` object for performing
fine-grained permission checks for `EMAIL_VIEW`.
:param show_email: an optional parameter that allows explicit
control of e-mail obfuscation.
:since 1.1.6: accepts the optional `resource` keyword parameter.
:since 1.2: Full name is returned when `[trac]` `show_full_names`
is `True`.
:since 1.2: Email addresses are obfuscated when
`show_email_addresses` is False and `req` is Falsy.
Previously email addresses would not be obfuscated
whenever `req` was Falsy (typically `None`).
r� z(none)T)�as_dictr NrF )r8 r� �get_known_usersr� r� r� r )r� rS r� r� �
show_email�usersrd rQ rQ rT r� s zChrome.format_author�, c s$ � �fdd��� |�D �}|�|�S )aJ Normalize a list of e-mails and obfuscate them if needed.
:param context: the context in which the check for obfuscation should
be done
:param value: a string containing a comma-separated list of e-mails
:param sep: the separator to use when rendering the list again
c s g | ]}�� � |��qS rQ )r� )r� r� ��contextr� rQ rT r= 4 s �z(Chrome.format_emails.<locals>.<listcomp>)r� r� )r� r� r� �sep� formattedrQ r� rT �
format_emails, s �
zChrome.format_emailsc C s0 i }| j r| j�� D ] \}}}|r|||< q
|S )z+Get the email addresses of all known users.)r� r� r� )r� r� �usernamerd �emailrQ rQ rT �
get_email_map8 s �zChrome.get_email_mapc C s | j r
t|d� dS dS )z^Make `<textarea class="trac-resizable">` fields resizable if enabled
by configuration.zcommon/js/resizer.jsN)r� r� �r� rS rQ rQ rT �add_textarea_gripsC s �zChrome.add_textarea_gripsc C s | j rt|d� | �|� dS )z:Add wiki toolbars to `<textarea class="wikitext">` fields.zcommon/js/wikitoolbar.jsN)r� r� r� r� rQ rQ rT �add_wiki_toolbarsI s
zChrome.add_wiki_toolbarsc C s2 t |d� |jjd| jdd�}t|||jd� dS )z+Setup auto-preview for `<textarea>` fields.zcommon/js/auto_preview.jszui.auto_preview_timeoutr )�min)r� �
form_tokenN)r� r` �as_floatr� r� r� )r� rS r� rQ rQ rT �add_auto_previewO s
�
�zChrome.add_auto_previewc C s� t || jpd� t|| jpd� t |d� t|d� |jdk}t|j�}|�d�}|�d�r0dnd t |d d
� �d t |d
d � � }|rJt
|�nd
}t |t |�t
|�t|j�t|j�t|j� t|�t|�t|�||||d� d� t |d� d
S )z@Add a reference to the jQuery UI script and link the stylesheet.zcommon/js/jquery-ui.jsz"common/css/jquery-ui/jquery-ui.cssz common/js/jquery-ui-addons.jsz common/css/jquery-ui-addons.css�iso8601z%z�-r� r& � �< � N) � month_names� day_names� date_format� time_format�ampm� period_names�first_week_day�timepicker_separator�
show_timezone�default_timezone�
timezone_list�timezone_iso8601)� jquery_uizcommon/js/jquery-ui-i18n.js)r� r� r� r� �lc_timer& �tz�strftimer� �intr3 r� r1 r2 r- r/ r. r6 r4 r5 )r� rS �
is_iso8601�now�tzoffsetr� r� rQ rQ rT �
add_jquery_uiX sB
�
�
"�
��
�zChrome.add_jquery_uic
s |du ri }�j jdd�|d< �o�j��r�jn�j j� d}�j jdkr(�}n
�j jr2t�j j�}�j j�j j�j j�j j |�j jd�|d< �j j
}dt |oSt �
|��i|d < �rc|d ��j� n|d ��j���j j�d
�� d>��fd d
� ��fdd�}��fdd�}� �fdd�}�fdd�} �r��j�d�j�n�j}
�o��j} | r�| j} | jr�| d| j 7 } nd} |�i d�j �d�r�t��nd�dt�d |�d |�d tt�j ��d tt �j ��d tt �j ��d!tt �j ��d"��d#� �d$��d%�o��j �d&��o�j �d'��r �j!nd(�d)| �d*| �i d+t�j"��#� d,��d-t�j$���d.�j%�d/t�j&���d0�j'�d1tt(j)���d2| �d|�d3|
�d4��d5tt*�t+��d6tt*�t,��d7tt*�t-��d8tt.j.j/��of�j0d9��d:t1�d;tt2�j ��d<tt3�j ���d=tt4�j �i�� |�r�|�|� |S )?a� Fills a dictionary with the standard set of fields expected
by templates.
:param req: a `Request` object; if `None`, no request related fields
will be set
:param data: user-provided `dict`, which can be used to override
the defaults; if `None`, the defaults will be returned
:param d: `dict` which is populated with the defaults; if `None`,
an empty `dict` will be used
Nzhttps://trac.edgewall.org/)r� �homepager� r� )rd �descrr� rH �
admin_href�admin_trac_url�project�footerrh )r� rc Fc s� | sdS |dkrt � t| �}nt � t| �}tt�}t| |�}|s(� j�d�j�}| |kr2t d|d�nt d|d�}|dkrE|s@|n|}|}n-|rJ|}n&� j
dkrVt d |d
�}n|dkrat d |d �}nt d
t � t| �t � t | �d�}|}t j
||d�S )Nr� r �dateinfozin %(relative)s)r z%(relative)s agor r� zat %(iso8601)s)r� z on %(date)s�r zon %(date)s at %(time)s)r r )rp )r0 r( r' r& r7 r% r` r� r r8 r� r) r r� ) r �format�dateonlyr r� r � in_or_agor[ rp r� rQ rT �pretty_dateinfo� s<
� �
�
�z-Chrome.populate_data.<locals>.pretty_dateinfoc s � | ddd�S )Nr T)r� r� rQ r� )r� rQ rT r� � s z&Chrome.populate_data.<locals>.dateinfoc � t �j| � fi |��S r� ��get_resource_urlr� �r� r� )ro r� rQ rT � get_rel_url� � z)Chrome.populate_data.<locals>.get_rel_urlc r� r� r� r� )r� r� rQ rT � get_abs_url� r� z)Chrome.populate_data.<locals>.get_abs_urlc s t � | �} | r
td�| S dS )Nzaccesskey="%s"r� )rb r r� rR rQ rT �accesskey_attr� s
z,Chrome.populate_data.<locals>.accesskey_attrr� r� �enr� r� r� �url_of�
abs_url_of�name_of� shortname_of�
summary_of�
resource_linkrS r� ro r� r� r� z<trac>ri � trac_langr� )r� r� r� r� r� �captioned_buttonrb �dateinfo_formatr� r' r( r) �
fromtimestamp)r� r* �wiki_to� wiki_to_html�wiki_to_onelinerr0 )5r� � trac_versionro r� �project_admin_trac_urlr< � project_name�project_description� project_url�
project_admin�project_footerr r �gettextru rh r� rl r` r� r ri �language� territoryr� r� r �get_resource_name�get_resource_shortname�get_resource_summary�render_resource_linkr� r� r� r� r� r� r� r� r� r r� r0 r' r( r) r r� r� r* r> r? r@ )
r� rS r� �dr� r� r� r� r� r� r� ri r� rQ )r� ro r� rS r� rT �
populate_datay s�
�
�� � ��
������ � � � �
� � �
� ������ �� �� �� � � � � � !�
"
��$� '� (� )�-
zChrome.populate_datac C s� | j s:| �� }tt|�| jdd�| _ | j j�| j�� � | j j�t j
� | j jjt d� t �
| j � | j jdd�| _|rB| j�|�S | j �|�S )a� Retrieves a template with the given name.
This simply loads the template. If you want to make use of the
"standard" Trac API for templates, also call `populate_data`,
or consider using the shortcut method `prepare_template`
instead.
:param text: in text mode (``True``) XML/HTML auto-escape of
variable expansion is disabled.
T)�loaderr� �
autoescape)�unicodeF)r )�jenvr] r r r� �globalsru �_default_context_data�copyr � functionsr# r �
jinja2_update�overlay� jenv_text� get_template)r� r� r� � jinja2_dirsrQ rQ rT �
load_template s � zChrome.load_templatec C s� |� d�}|� d�}|� d�}|� d�}|� d�} |du r d}ddd �� |d
�}
|
dkr^d D ]/} z$t�� D ] } t|j�d | | f ��}
|
|j| vrR|j| �|
� q5W q. ty] Y q.w |du rf|
dk}| � |||||�\}}|j� d
�}|j� d�}|j� d�}|j�
|||i g i d�� |� di ��
|jd
|jd |jd d�� |s�|r�| r�| � |||| �S | �
|||�}|�d�S ||d d< z | � |||| �W S ty� |j�
ddd|||d�� � w )a� Renders the ``filename`` template using ``data`` for the context.
It attempts to load a Jinja2 template, augments the provided
*data* with standard data, and renders it according to the
options provided in *metadata*.
The options that can be specified in ``metadata`` are
``content_type``, ``text``, ``domain``, ``fragment`` and ``iterable``.
When ``fragment`` is ``True``, or ``text`` is ``True``, we generate
some content which does not need all of the chrome related data,
typically HTML fragments, XML or plain text.
If ``iterable`` is ``True``, we use `generate_template_stream` to
produce the output (iterable of UTF-8 encoded bytes),
otherwise we use `render_template_string` and UTF-8 encode the
result.
:since 1.5.1: The ``fragment``, ``iterable`` and ``method`` parameters
have been removed. Use the ``metadata`` dictionary with keys of
the same name. The ``method`` key of ``metadata`` is no longer
supported, use ``text=True`` to indicate that the template is a
plain text one, with no need for HTML/XML escaping to take place.
� content_typer� �domainr� �iterableN� text/htmlr )r" z
text/plain�xmlr� r� rs r� r� )r� r� r� rs r� r� rh )r� r� r� r )r� � itertools�countr r` �poprh rj �KeyError�prepare_templateru ri �generate_template_stream�render_template_string�encoder� )r� rS r� r� �metadatar r� r r� r! �methodr� r� r� �templaters r� r� �srQ rQ rT �render_template- s|
��
��� � �
� �
�
�
��zChrome.render_templatec C �$ | � |||||�\}}| �|||�S )a� Produces content ready to be sent from the given template
*filename* and input *data*, with minimal overhead.
It calls `prepare_template` to augment the *data* with the
usual helper functions that can be expected in Trac templates,
including the translation helper functions adapted to the given
*domain*, except for some of the chrome "late" data.
If you don't need that and don't want the overhead, use
`load_template` and `generate_template_stream` directly.
The generated output is suitable to pass directly to
`Request.send`, see `generate_template_stream` for details.
See also `render_fragment`, which returns a string instead.
)r( r) �r� rS r� r� r� r r. rQ rQ rT �generate_fragment� s �zChrome.generate_fragmentc C r1 )a� Produces a string from given template *filename* and input *data*,
with minimal overhead.
It calls `prepare_template` to augment the *data* with the
usual helper functions that can be expected in Trac templates,
including the translation helper functions adapted to the given
*domain*, except for some of the chrome "late" data.
If you don't need that and don't want the overhead, use
`load_template` and `render_template_string` directly.
:rtype: the generated output is a `str` string if *text*
is ``True``, or a `Markup` string otherwise.
See also `generate_fragment`, which produces an output
suitable to pass directly to `Request.send` instead.
)r( r* r2 rQ rQ rT �render_fragment� s �zChrome.render_fragmentc C sN | � ||�}|r ttj�}t�||�}|�tt||��� | �||�}||fS )a Prepares the rendering of a Jinja2 template.
This loads the template and prepopulates a data `dict` with
the "standard" Trac API for templates.
:param req: a `Request` instance (optional)
:param filename: the name of a Jinja2 template, which must be
found in one of the template directories (see
`get_templates_dirs`)
:param data: user specified data dictionary, used to override
the default context set from the request *req*
(see `populate_data`)
:param text: in text mode (``True``) XML/HTML auto-escape of
variable expansion is disabled.
:rtype: a pair of Jinja2 `Template` and a `dict`.
) r rP r r �domain_functionsru �dictr� r ) r� rS r� r� r� r r. �symbolsr5 rQ rQ rT r( � s
zChrome.prepare_templatec s\ |� |�� � �d� |s|du r| jr| �� |�S |r"� fdd�}n� fdd�}d�|� �S )a� Returns the rendered template in a form that can be "sent".
This will be either a single UTF-8 encoded `btyes` object, or an
iterable made of chunks of the above.
:param template: the Jinja2 template
:type template: ``jinja2.Template``
:param text: in text mode (``True``) the generated bytes will
not be sanitized (see `valid_html_bytes`).
:param iterable: determine whether the output should be
generated in chunks or as a single `btyes`; if
`None`, the `use_chunked_encoding` property
will be used to determine this instead
:rtype: `btyes` or an iterable of `btyes`, depending on *iterable*
.. note:
Turning off the XML/HTML auto-escape feature for variable
expansions has to be disabled when loading the template (see
`load_template`), so remember to stay consistent with the
*text* parameter.
�K Nc 3 s � � D ]} | � d�V qd S �Nr )r+ ��chunk��streamrQ rT �generate� s ��z1Chrome.generate_template_stream.<locals>.generatec 3 s � � D ]
} t | �d��V qd S r9 )r r+ r: r< rQ rT r> � s ��� )r= �enable_bufferingr �iterable_contentr� )r� r. r� r� r! r> rQ r< rT r) � s
z Chrome.generate_template_streamc C s |� |�}|r |S t|�S )aC Renders the template as a str or Markup string.
:param template: the Jinja2 template
:type template: ``jinja2.Template``
:param text: in text mode (``True``) the generated string
will not be wrapped in `Markup`
:rtype: `str` if *text* is ``True``, `Markup` otherwise.
.. note:
Turning off the XML/HTML auto-escape feature for variable
expansions has to be disabled when loading the template (see
`load_template`), so remember to stay consistent with the
*text* parameter.
)�renderr )r� r. r� r� �stringrQ rQ rT r* � s
z Chrome.render_template_stringc k s� � z |r|D ]}|� d�V qW dS |D ]
}t|� d��V qW dS ty) � tyN } z| j�d|jj|r;dndt|dd�� W Y d}~dS d}~ww )z�Generate an iterable object which iterates `btyes` instances
from the given stream instance.
:param text: in text mode (``True``) XML/HTML auto-escape of
variable expansion is disabled.
r z.Jinja2 %s error while rendering %s template %sr� zXML/HTMLT)� tracebackN) r+ r �
TracBaseErrorr� r �errorr� rX r )r� r= r� r� r; r� rQ rQ rT rA s& ���
���zChrome.iterable_contentr� �NN)r� �NNN)F)FN)zrX rY rZ r[ �
implementsr r r
r: r\ r= �required�is_valid_default_handler�ExtensionPointrO r� r> �
PathOptionrR rN �
BoolOptionr� �Optionr� r� r� r� �
ConfigSectionr� r� ry rv rz � IntOptionrw rx r� r� r� r� r� � FloatOptionr� � ChoiceOptionr r rO r r r r� r r r r r r r r$ r r+ r r r r r r r
�pformatr r% r$ r r! r
r r r# r, r r r/ r1 r3 r9 rE rG r] r^ rS rU rT r] ro rk rl rW r� r� r� r� r5 �compiler� r� r� r� r� r� r� r� r� r� r r r0 r3 r4 r( r) r* rA rQ rQ rQ rT r� � sT ��
�
�� � � �
�� ������������������� �
� � �
������ '
6
L
(
!
[
�
+r� )NNNNrH )r~ )r� rG r� )NFFFF)qr[ �
contextlibr r r$ r �os.pathr rL r
r5 � functoolsr r r �trac.apir r � trac.config� trac.core�trac.mimeview.apir r � trac.permr
�
trac.resource� trac.utilr r r
r r r r r r �trac.util.htmlr r r r r r r �trac.util.textr r r r r r r! r" r# r$ �trac.util.datefmtr% r& r' r( r) r* r+ r, r- r. r/ r0 r1 r2 r3 r4 r5 r6 r7 �trac.util.translationr8 r9 � trac.web.apir: r; �
trac.web.hrefr< � trac.wikir= �trac.wiki.formatterr> r? r@ r- r. � InterfacerO r\ rb rm r} r� r� r� r� r� r� r� r� r� r� r� r� r� r� � Componentr� rQ rQ rQ rT �<module> sf ,$0T
#
�'
'