File: //usr/lib/python3/dist-packages/tracopt/ticket/__pycache__/commit_updater.cpython-310.pyc
o
�k�`�4 � @ s d dl Z d dlZd dlmZmZ d dlmZmZ d dlm Z d dl
m Z d dl m
Z
d dlmZ d dlmZ d d lmZ d d
lmZmZ d d lmZ d d lmZ d d
lm Z m Z d dl m Z m Z d dl!m"Z" d dl#m$Z$ d dl%m&Z& G dd� de�Z'G dd� de&�Z(dS )� N)�
BoolOption�Option)� Component�
implements)�NotificationSystem)�PermissionCache)�Resource)�Ticket)�TicketChangeEvent)�as_int)� datetime_now�utc)�tag)�exception_to_unicode)�_� cleandoc_)�IRepositoryChangeListener�RepositoryManager)�ChangesetModule)�format_to_html)�
WikiMacroBasec @ s� e Zd ZdZee� edddd�Zedddd�Zedd d
d �Z e
dd d
d�Z e
ddd
d�Z dZ
e
d Zdeef Zedd� �Ze�e
d �ZdZdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Z d&d'� Z d(d)� Z d*d+� Z d,d-� Z dS ).�CommitTicketUpdatera� Update tickets based on commit messages.
This component hooks into changeset notifications and searches commit
messages for text in the form of:
{{{
command #1
command #1, #2
command #1 & #2
command #1 and #2
}}}
Instead of the short-hand syntax "#1", "ticket:1" can be used as well,
e.g.:
{{{
command ticket:1
command ticket:1, ticket:2
command ticket:1 & ticket:2
command ticket:1 and ticket:2
}}}
Using the long-form syntax allows a comment to be included in the
reference, e.g.:
{{{
command ticket:1#comment:1
command ticket:1#comment:description
}}}
In addition, the ':' character can be omitted and issue or bug can be used
instead of ticket.
You can have more than one command in a message. The following commands
are supported. There is more than one spelling for each command, to make
this as user-friendly as possible.
close, closed, closes, fix, fixed, fixes::
The specified tickets are closed, and the commit message is added to
them as a comment.
references, refs, addresses, re, see::
The specified tickets are left in their current status, and the commit
message is added to them as a comment.
A fairly complicated example of what you can do is with a commit message
of:
Changed blah and foo to do this or that. Fixes #10 and #12,
and refs #12.
This will close #10 and #12, and add a note to #12.
�ticket� commit_ticket_update_envelope� z�Require commands to be enclosed in an envelope.
Must be empty or contain two characters. For example, if set to `[]`,
then commands must be in the form of `[closes #4]`.z#commit_ticket_update_commands.closez#close closed closes fix fixed fixesz7Commands that close tickets, as a space-separated list.z"commit_ticket_update_commands.refsz addresses re references refs seez�Commands that add a reference, as a space-separated list.
If set to the special value `<ALL>`, all tickets referenced by the
message will get a reference to the changeset.� commit_ticket_update_check_perms�truez�Check that the committer has permission to perform the requested
operations on the referenced tickets.
This requires that the user names be the same for Trac and repository
operations.�commit_ticket_update_notifyz7Send ticket change notification when updating a ticket.z (?:#|(?:ticket|issue|bug)[: ]?)z([0-9]+(?:#comment:([0-9]+|description))?zH(?P<action>[A-Za-z]*)\s*.?\s*(?P<ticket>%s(?:(?:[, &]*|[ ]?and[ ]?)%s)*)c C s> t �| jdd� �t �| jdd� �}}t �|| j | �S )Nr � � )�re�escape�envelope�compile�ticket_command)�self�begin�end� r( �?/usr/lib/python3/dist-packages/tracopt/ticket/commit_updater.py�
command_re� s �z CommitTicketUpdater.command_rez([0-9]+)Nc C s> | � |�rd S | �|j�}| �||�}| �|||tt�� d S �N)�
_is_duplicate�_parse_message�message�make_ticket_comment�_update_ticketsr r
)r% �repos� changeset�tickets�commentr( r( r) �changeset_added� s
z#CommitTicketUpdater.changeset_addedc sp | � |�rd S | �|j�}i � |d ur| �|j�� t� fdd�|�� D ��}| �||�}| �|||tt�� d S )Nc 3 s � | ] }|d � vr|V qdS )r Nr( )�.0�each�� old_ticketsr( r) � <genexpr>� s � ��z9CommitTicketUpdater.changeset_modified.<locals>.<genexpr>) r, r- r. �dict�itemsr/ r0 r r
)r% r1 r2 �
old_changesetr3 r4 r( r8 r) �changeset_modified� s
z&CommitTicketUpdater.changeset_modifiedc C s, |j |j|j|jf}|| jkr|| _dS dS )NFT)�revr. �author�date�
_last_cset_id)r% r2 �cset_idr( r( r) r, � s �
z!CommitTicketUpdater._is_duplicatec
C s� | j �|�}| �� }i }|D ]3}|�dd�\}}|�|�� �}|s+| j�� dkr+| j}|rA| j �
|�D ]
} |� t | �g ��
|� q3q|S )z:Parse the commit message and return the ticket references.�actionr z<ALL>)r* �finditer�_get_functions�group�get�lower�
commands_refs�strip�cmd_refs� ticket_re�findall�
setdefault�int�append)
r% r. �
cmd_groups� functionsr3 �m�cmd�tkts�func�tkt_idr( r( r) r- � s �z"CommitTicketUpdater._parse_messagec C s^ |j }t|�}t|�|��}|jr |d|j 7 }|d|j 7 }t�d�|||j||j�� f S )z2Create the ticket comment from the changeset data.�/z� In [changeset:"%s" %s]:
{{{#!CommitTicketReference repository="%s" revision="%s"
%s
}}})r? �str� display_rev�reponame�textwrap�dedentr. rK )r% r1 r2 r? � revstring�drevr( r( r) r/ � s
��z'CommitTicketUpdater.make_ticket_commentc C s� | � |�}t| j|�}|�� D ]m\}}| j�d|� d} zD| jj�+ t| j|�}
||
j�} |D ] } | |
|| �dur;d} q/| rE|
� |||� W d � n1 sOw Y | r_| �
|
||j |� W q t y| }
z| j�
d|t|
�� W Y d}
~
qd}
~
ww dS )z*Update the tickets with the given comment.zUpdating ticket #%dFTNz0Unexpected error while processing ticket #%s: %s)� _authnamer �envr< �log�debug�db_transactionr �resource� save_changes�_notifyr@ � Exception�errorr )r% r3 r2 r4 rA �authname�permrX �cmds�saver � ticket_permrU �er( r( r) r0 � s6
�� ������z#CommitTicketUpdater._update_ticketsc
C sn | j sdS td||||�}z t| j�� |� W dS ty6 } z| j�d|jt|�� W Y d}~dS d}~ww )z"Send a ticket update notification.N�changedz8Failure sending notification on change to ticket #%s: %s) �notifyr
r rb ri rc rj �idr )r% r rA r@ r4 �eventrp r( r( r) rh � s ���zCommitTicketUpdater._notifyc C sV i }t | �D ]"}|�d�sqt| |�}t| d|dd� d��� D ]}|||< q!q|S )z4Create a mapping from commands to command functions.�cmd_� commands_� Nr )�dir�
startswith�getattr�split)r% rS r7 rW rU r( r( r) rF � s
�z"CommitTicketUpdater._get_functionsc C s | j j�dd�r
|j�� S |jS )ziReturns the author of the changeset, normalizing the casing if
[trac] ignore_author_case is true.�trac�ignore_auth_case)rb �config�getboolr@ rI )r% r2 r( r( r) ra s ��z CommitTicketUpdater._authnamec C sV | � |�}| jrd|vr| j�d||j� dS d|d< d|d< |d s)||d< d S d S ) N�
TICKET_MODIFYz0%s doesn't have TICKET_MODIFY permission for #%dF�closed�status�fixed�
resolution�owner)ra � check_permsrc �infors )r% r r2 rl rk r( r( r) � cmd_close s
� �z CommitTicketUpdater.cmd_closec C s2 | j rd|vr| j�d| �|�|j� dS d S d S )N�
TICKET_APPENDz0%s doesn't have TICKET_APPEND permission for #%dF)r� rc r� ra rs )r% r r2 rl r( r( r) rL s ��z CommitTicketUpdater.cmd_refs)!�__name__�
__module__� __qualname__�__doc__r r r r" �commands_closerJ r r� rr �
ticket_prefix�ticket_referencer$ �propertyr* r r# rM rB r5 r> r, r- r/ r0 rh rF ra r� rL r( r( r( r) r ; sV 3�������
r c @ s( e Zd ZdZed�ZejZddd�ZdS )�CommitTicketReferenceMacro�messagesay Insert a changeset message into the output.
This macro must be called using wiki processor syntax as follows:
{{{
{{{
#!CommitTicketReference repository="reponame" revision="rev"
}}}
}}}
where the arguments are the following:
- `repository`: the repository containing the changeset
- `revision`: the revision of the desired changeset
Nc s |pi }|� d�p
d}|� d�}t| j��|�}z|�|�}W n ty/ |} td|�}
Y n
w |j} |j}|j }
|j
j j dkrat |j
j j
�� � rXt� fdd�| j�| �D ��satjtd�dd �S t| j�jr|tjt| j|j
jd
||
d �| d d
�dd �S tj| dd �S )N�
repositoryr �revisionr c 3 s � | ] }t |�� kV qd S r+ )rP )r6 rX �� resource_idr( r) r: E s � �z:CommitTicketReferenceMacro.expand_macro.<locals>.<genexpr>z5(The changeset message doesn't reference this ticket)�hint)�class_r2 )�parentT)�escape_newlinesr. )rH r rb �get_repository�
get_changesetri r r. r? rf �context�realmr rs �anyrM rN r �pr r �wiki_format_messages�divr �child�pre) r% � formatter�name�content�argsr\ r? r1 r2 r. rf r( r� r) � expand_macro5 s:
�
�
�
��z'CommitTicketReferenceMacro.expand_macror+ ) r� r� r� �_domainr � _descriptionr rM r� r( r( r( r) r� # s �r� ))r r] � trac.configr r � trac.corer r �trac.notification.apir � trac.permr �
trac.resourcer � trac.ticketr �trac.ticket.notificationr
� trac.utilr �trac.util.datefmtr r
�trac.util.htmlr �trac.util.textr �trac.util.translationr r �trac.versioncontrolr r �$trac.versioncontrol.web_ui.changesetr �trac.wiki.formatterr �trac.wiki.macrosr r r� r( r( r( r) �<module> s* % i