Dashboard
PHP:
8.2.30
OS:
Linux
User:
dh_nv8b2m
/
/
usr
/
lib
/
python3
/
dist-packages
/
trac
/
notification
/
__pycache__
📤 Upload
📝 New File
📁 New Folder
Close
Editing: api.cpython-310.pyc
o �k�`:A � @ s� d dl mZ d dlmZmZmZmZmZ d dlm Z m Z m Z d dl m Z mZmZ g d�ZG dd� de �ZG dd � d e �ZG d d � d e �ZG d d � d e �ZG dd� de �ZG dd� de �Zdd� Zdd� ZG dd� de�ZG dd� de �ZdS )� )� defaultdict)� BoolOption� ConfigSection�ExtensionOption� ListOption�Option)� Component� Interface�ExtensionPoint)�as_bool�lazy�to_list) �IEmailAddressResolver�IEmailDecorator� IEmailSender�INotificationDistributor�INotificationFormatter�INotificationSubscriber�NotificationEvent�NotificationSystem� get_target_id�parse_subscriber_configc @ � e Zd ZdZdd� Zdd� ZdS )r z=Deliver events over some transport (i.e. messaging protocol).c C � dS )z+Return a list of supported transport names.N� r r r �7/usr/lib/python3/dist-packages/trac/notification/api.py� transports$ � z#INotificationDistributor.transportsc C r )aK Distribute the notification event. :param transport: the name of a supported transport :param recipients: a list of (sid, authenticated, address, format) tuples, where either `sid` or `address` can be `None` :param event: a `NotificationEvent` Nr )� transport� recipients�eventr r r � distribute' r z#INotificationDistributor.distributeN)�__name__� __module__� __qualname__�__doc__r r! r r r r r ! s r c @ r )r z?Convert events into messages appropriate for a given transport.c C r )z�Return a list of supported styles. :param transport: the name of a transport :return: a list of tuples (style, realm) Nr )r r r r �get_supported_styles5 r z+INotificationFormatter.get_supported_stylesc C r )ah Convert the event to an appropriate message. :param transport: the name of a transport :param style: the name of a supported style :return: The return type of this method depends on transport and must be compatible with the `INotificationDistributor` that handles messages for this transport. Nr )r �styler r r r �format< r z INotificationFormatter.formatN)r" r# r$ r% r& r( r r r r r 2 s r c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd S ) r z!Subscribe to notification events.c C r )aq Return a list of subscriptions that match the given event. :param event: a `NotificationEvent` :return: a list of tuples (class, distributor, sid, authenticated, address, format, priority, adverb), where small `priority` values override larger ones and `adverb` is either 'always' or 'never'. Nr )r r r r �matchesJ r z INotificationSubscriber.matchesc C r )z<Description of the subscription shown in the preferences UI.Nr r r r r � descriptionT r z#INotificationSubscriber.descriptionc C r )z'Can only authenticated users subscribe?Nr r r r r �requires_authenticationW r z/INotificationSubscriber.requires_authenticationc C r )a� Optionally return a list of default subscriptions. Default subscriptions that the module will automatically generate. This should only be used in reasonable situations, where users can be determined by the event itself. For instance, ticket author has a default subscription that is controlled via trac.ini. This is because we can lookup the ticket author during the event and create a subscription for them. Default subscriptions should be low priority so that the user can easily override them. :return: a list of tuples (class, distributor, format, priority, adverb) Nr r r r r �default_subscriptionsZ r z-INotificationSubscriber.default_subscriptionsN)r" r# r$ r% r) r* r+ r, r r r r r G s r c @ � e Zd ZdZdd� ZdS )r z Map sessions to email addresses.c C r )z�Map a session id and authenticated flag to an e-mail address. :param sid: the session id :param authenticated: 1 for authenticated sessions, 0 otherwise :return: an email address or `None` Nr )�sid� authenticatedr r r �get_address_for_sessionm r z-IEmailAddressResolver.get_address_for_sessionN)r" r# r$ r% r0 r r r r r j � r c @ s e Zd Zdd� ZdS )r c C r )z�Manipulate the message before it is sent on it's way. :param event: a `NotificationEvent` :param message: an `email.message.Message` to manipulate :param charset: the `email.charset.Charset` to use Nr )r �message�charsetr r r �decorate_messagew r z IEmailDecorator.decorate_messageN)r" r# r$ r4 r r r r r v s r c @ r- )r zCExtension point interface for components that allow sending e-mail.c C r )zSend message to recipients.Nr )� from_addrr r2 r r r �send� r zIEmailSender.sendN)r" r# r$ r% r6 r r r r r � r1 r c C s, t | d�r t| j�S t | d�r| jS t| �S )z�Extract the resource ID from event targets. :param target: a resource model (e.g. `Ticket` or `WikiPage`) :return: the resource ID �id�name)�hasattr�strr7 r8 )�targetr r r r � s r c C sL ddddd�}i }|� � }|�|� tt�}| D ]W\}}|�dd�}|d }t|�dkr9|| �||�� d �� q|d } |�| �} | du sKt| t �rLn t| t �rVt |�}nt| t �r`t |�}n t| t �rit|�}||| | < qtt �} |�� D ] \}} |�� D ] \} }| �| |� q�| | d �| � qx| �� D ] }|jd d � d � q�| S )z6Given a list of options from [notification-subscriber]�email�d �alwaysN)� distributor�priority�adverbr( �.� r )r8 �classrD c S s | d | d fS )Nr@ r8 r )�valuer r r �<lambda>� s z)parse_subscriber_config.<locals>.<lambda>��key)�copy�updater �dict�split�len�strip�get� isinstancer: �int�boolr �listr �items� setdefault�append�values�sort)�rawsubscriptions�required_attrs�optional_attrs� known_attrs�byname�optionrE �partsr8 � attribute�known�byclass� attributesrH rW r r r r � sB � r c @ s e Zd ZdZddd�ZdS )r a~ All data related to a particular notification event. :param realm: the resource realm (e.g. 'ticket' or 'wiki') :param category: the kind of event that happened to the resource (e.g. 'created', 'changed' or 'deleted') :param target: the resource model (e.g. Ticket or WikiPage) or `None` :param time: the `datetime` when the event happened � c C s" || _ || _|| _|| _|| _d S �N)�realm�categoryr; �time�author)�selfrf rg r; rh ri r r r �__init__� s zNotificationEvent.__init__N)rd )r" r# r$ r% rk r r r r r � s r c @ sX e Zd Zeddedd�Zedddd�Zeddd d �Z edd d d �Z edddd�Z eddd d�Z e ddd ddd�Ze ddd ddd�Zeddd d�Ze ddd dd �Ze dd d d d �Zedd d d!�Zedd"dd#�Zedd$dd%�Zedd&d'd(�Zedd)d*d+�Zed,d-�Zee�Z ee �Z e d.d/� �Z d0d1� Z!d2d3� Z"d4d5� Z#d6d7� Z$d8d9� Z%d:d;� Z&d<d=� Z'd>S )?r � notification� email_sender�SmtpEmailSendera4 Name of the component implementing `IEmailSender`. This component is used by the notification system to send emails. Trac currently provides `SmtpEmailSender` for connecting to an SMTP server, and `SendmailEmailSender` for running a `sendmail`-compatible executable. � smtp_enabled�falsezEnable email notification.� smtp_fromztrac@localhostz�Sender address to use in notification emails. At least one of `smtp_from` and `smtp_replyto` must be set, otherwise Trac refuses to send notification mails.�smtp_from_namerd z*Sender name to use in notification emails.�smtp_from_authora Use the author of the change as the sender in notification emails (e.g. reporter of a new ticket, author of a comment). If the author hasn't set an email address, `smtp_from` and `smtp_from_name` are used instead. (''since 1.0'')� smtp_replytoz�Reply-To address to use in notification emails. At least one of `smtp_from` and `smtp_replyto` must be set, otherwise Trac refuses to send notification mails.�smtp_always_cc)�,� z�Comma-separated list of email addresses to always send notifications to. Addresses can be seen by all recipients (Cc:).)�sep�doc�smtp_always_bccz�Comma-separated list of email addresses to always send notifications to. Addresses are not public (Bcc:). �smtp_default_domaina Default host/domain to append to addresses that do not specify one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found in the user settings.�ignore_domainsz�Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).)ry � admit_domainszuComma-separated list of domains that should be considered as valid for email addresses (such as localdomain).� mime_encoding�nonea� Specifies the MIME encoding scheme for emails. Supported values are: `none`, the default value which uses 7-bit encoding if the text is plain ASCII or 8-bit otherwise. `base64`, which works with any kind of content but may cause some issues with touchy anti-spam/anti-virus engine. `qp` or `quoted-printable`, which works best for european languages (more compact than base64) if 8-bit encoding cannot be used. � use_public_ccz�Addresses in the To and Cc fields are visible to all recipients. If this option is disabled, recipients are put in the Bcc list. �use_short_addra Permit email address without a host/domain (i.e. username only). The SMTP server should accept those addresses, and either append a FQDN or use local delivery. See also `smtp_default_domain`. Do not use this option with a public SMTP server. �smtp_subject_prefix� __default__z�Text to prepend to subject line of notification emails. If the setting is not defined, then `[$project_name]` is used as the prefix. If no prefix is desired, then specifying an empty option will disable it. �message_id_hash�md5zMHash algorithm to create unique Message-ID header. ''(since 1.0.13)''znotification-subscriberaK The notifications subscriptions are controlled by plugins. All `INotificationSubscriber` components are in charge. These components may allow to be configured via this section in the `trac.ini` file. See TracNotification for more details. Available subscribers: [[SubscriberList]] c C s | j �� }t|�S re )� notification_subscriber_section�optionsr )rj rY r r r �subscriber_defaultsG s z&NotificationSystem.subscriber_defaultsc c s6 � | j | D ]}||d |d |d |d fV qd S )Nr? r( r@ rA )r� )rj �klass�dr r r r, L s ���z(NotificationSystem.default_subscriptionsc C s | j �dd| �p dS )Nrl zdefault_format.z text/plain)�configrO )rj r r r r �get_default_formatQ s ��z%NotificationSystem.get_default_formatc C s& ddl m} || j|||�p| �|�S )Nr )�get_preferred_format)�trac.notification.prefsr� �envr� )rj r. r/ r r� r r r r� U s ��z'NotificationSystem.get_preferred_formatc C s | j �|||� dS )z&Send message to recipients via e-mail.N)rm r6 )rj r5 r r2 r r r � send_email[ s z NotificationSystem.send_emailc C s | � || �|�� dS )z_Distribute an event to all subscriptions. :param event: a `NotificationEvent` N)�distribute_event� subscriptions)rj r r r r �notify_ s zNotificationSystem.notifyc C s� i }|D ]"\}}}}}|� |i �} |||f} | | v rq|p#| �|||�| | < q| jD ] } | �� D ]}||v rHdd� || �� D �} | �|| |� q0q*dS )a$ Distribute a event to all subscriptions. :param event: a `NotificationEvent` :param subscriptions: a list of tuples (sid, authenticated, address, transport, format) where either sid or address can be `None` c S s( g | ]\}}|d |d |d |f�qS )r rC � r )�.0�kr( r r r � <listcomp>y s �z7NotificationSystem.distribute_event.<locals>.<listcomp>N)rU r� � distributorsr rT r! ) rj r r� �packagesr. r/ �addressr r( �packagerH r? r r r r r� f s& � ����z#NotificationSystem.distribute_eventc c s� � g }| j D ]+}|jdkr$|�| j�D ]}|�dd� |�|�D �� qq|�dd� |�|�D �� qt|dd� d�}d}|D ]:\}}} } } } } }|| | f|krPq>|d krg| j�d | | ||� | | | || fV n | j�d | | ||� | rx|| | f}q>dS ) z�Return all subscriptions for a given event. :return: a list of (sid, authenticated, address, transport, format) � batchmodifyc s � � | ]}|r|V qd S re r �r� �xr r r � <genexpr>� � � z3NotificationSystem.subscriptions.<locals>.<genexpr>c s r� re r r� r r r r� � r� c S s, | d | d d u r dn| d | d | d fS )NrC r� rd � � r )�vr r r rF � s �z2NotificationSystem.subscriptions.<locals>.<lambda>rG Nr> z3Adding (%s [%s]) for 'always' on rule (%s) for (%s)z4Ignoring (%s [%s]) for 'never' on rule (%s) for (%s)) � subscribersrg �get_ticket_change_eventsr� �extendr) �sorted�log�debug)rj r r� � subscriber� ticket_event�ordered�previous_combination�ruler r. �auth�addr�fmt�priorA r r r r� ~ s6 � � ��� ��z NotificationSystem.subscriptionsN)(r" r# r$ r r rm r ro r rq rr rs rt r �smtp_always_cc_list�smtp_always_bcc_listr{ �ignore_domains_list�admit_domains_listr~ r� r� r� r� r r� r r r� r r� r r� r, r� r� r� r� r� r� r r r r r � s� � ����������� ��� �� r N) � collectionsr � trac.configr r r r r � trac.corer r r � trac.utilr r r �__all__r r r r r r r r �objectr r r r r r �<module> s # +
Save
Cancel