File: //usr/lib/python3/dist-packages/trac/db/__pycache__/api.cpython-310.pyc
o
�k�`�f � @ sL d dl Z d dlZd dlZd dlZd dlmZmZ d dlm Z d dl
m Z m Z d dl
mZmZmZmZ d dlT d dlmZ d dlmZ d d lmZ d d
lmZ d d lm Z d d l m Z d d
l m Z m!Z! G dd� de"�Z#G dd� de#�Z$G dd� de#�Z%G dd� de"ed�Z&G dd� de'�Z(G dd� de)�Z*dd � Z+d d � Z,d d � Z-d!d"� Z.dS )#� N)�ABCMeta�abstractmethod)�
db_default)� IEnvironmentSetupParticipant�ISystemInfoProvider)�
BoolOption�ConfigurationError� IntOption�Option)�*)�ConnectionPool)�Table)�ConnectionWrapper)� ThreadLocal)�tag)�unicode_passwd)�_�tag_c @ s4 e Zd ZdZdZdd� Zd dd�ZeZd dd�ZdS )
�DbContextManagerz^Database Context Manager
The outermost `DbContextManager` will close the connection.
Nc C s t |�| _d S �N)�DatabaseManager�dbmgr)�self�env� r �-/usr/lib/python3/dist-packages/trac/db/api.py�__init__, s zDbContextManager.__init__c C �4 | �}|� ||�W d � S 1 sw Y dS )z(Shortcut for directly executing a query.N)�execute�r �query�params�dbr r r r / �
$�zDbContextManager.executec C r )z7Shortcut for directly calling "executemany" on a query.N)� executemanyr r r r r$ 6 r# z DbContextManager.executemanyr ) �__name__�
__module__� __qualname__�__doc__r" r r �__call__r$ r r r r r $ s
r c @ � e Zd ZdZdd� Zdd� ZdS )�TransactionContextManagerz�Transactioned Database Context Manager for retrieving a
`~trac.db.util.ConnectionWrapper`.
The outermost such context manager will perform a commit upon
normal exit or a rollback after an exception.
c C sJ | j jj}|s#| j jj}|rt|j|j�}n| j �� }| | j j_| _|S r ) r �_transaction_local�wdb�rdbr �cnx�log�get_connectionr" �r r" r r r � __enter__D s
z#TransactionContextManager.__enter__c C sN | j r#d | jj_|d u r| j �� n| j �� | jjjs%| j �� d S d S d S r )r" r r, r- �commit�rollbackr. �close�r �et�ev�tbr r r �__exit__O s
�z"TransactionContextManager.__exit__N�r% r& r' r( r3 r; r r r r r+ < s r+ c @ r* )�QueryContextManagerz_Database Context Manager for retrieving a read-only
`~trac.db.util.ConnectionWrapper`.
c C sR | j jj}|s'| j jj}|rt|j|jdd�}n| j jdd�}| | j j_| _|S )NT��readonly) r r, r. r- r r/ r0 r1 r" r2 r r r r3 _ s
z QueryContextManager.__enter__c C s0 | j rd | jj_| jjjs| j �� d S d S d S r )r" r r, r. r- r6 r7 r r r r; j s
�z QueryContextManager.__exit__Nr< r r r r r= Z s r= c @ s� e Zd ZdZedd� �Zedd� �Zedd� �Zedd � �Zed
d � �Z ed$d
d��Z
edd� �Z edd� �Z edd� �Z
edd� �Zedd� �Zedd� �Zedd � �Zed d � �Zed d � �Zed$d!d"��Zd#S )%�ConnectionBasez4Abstract base class for database connection classes.c C � dS )z,Returns a clause casting `column` as `type`.Nr )r �column�typer r r �castt � zConnectionBase.castc G rA )z3Returns a clause concatenating the sequence `args`.Nr )r �argsr r r �concaty rE zConnectionBase.concatc C rA )z Drops the `column` from `table`.Nr )r �tablerB r r r � drop_column~ rE zConnectionBase.drop_columnc C rA )zDrops the `table`.Nr �r rH r r r �
drop_table� rE zConnectionBase.drop_tablec C rA )z0Returns the list of the column names in `table`.Nr rJ r r r �get_column_names� rE z ConnectionBase.get_column_names�idc C rA )z�Returns the current value of the primary key sequence for `table`.
The `column` of the primary key may be specified, which defaults
to `id`.Nr �r �cursorrH rB r r r � get_last_id� � zConnectionBase.get_last_idc C rA )z%Returns a list of the sequence names.Nr �r r r r �get_sequence_names� rE z!ConnectionBase.get_sequence_namesc C rA )z"Returns a list of the table names.Nr rR r r r �get_table_names� rE z ConnectionBase.get_table_namesc C rA �z!Returns whether the table exists.Nr rJ r r r � has_table� rE zConnectionBase.has_tablec C rA )z)Returns a case-insensitive `LIKE` clause.Nr rR r r r �like� rE zConnectionBase.likec C rA )z2Returns `text` escaped for use in a `LIKE` clause.Nr )r �textr r r � like_escape� rE zConnectionBase.like_escapec C rA )z1Return a case sensitive prefix-matching operator.Nr rR r r r � prefix_match� rE zConnectionBase.prefix_matchc C rA )z;Return a value for case sensitive prefix-matching operator.Nr )r �prefixr r r �prefix_match_value� rE z!ConnectionBase.prefix_match_valuec C rA )z Returns the quoted `identifier`.Nr )r �
identifierr r r �quote� rE zConnectionBase.quotec C rA )z�Deletes all data from the tables and resets autoincrement indexes.
:return: list of names of the tables that were reset.
Nr rR r r r � reset_tables� s zConnectionBase.reset_tablesc C rA )z�Updates the current value of the primary key sequence for `table`.
The `column` of the primary key may be specified, which defaults
to `id`.Nr rN r r r �update_sequence� rQ z ConnectionBase.update_sequenceN)rM )r% r& r' r( r rD rG rI rK rL rP rS rT rV rW rY rZ r\ r^ r_ r` r r r r r@ q sD
r@ )� metaclassc @ s` e Zd ZdZdd� Zddd�Zdd� Zdd d
�Zdd d �Zdd
d�Z dd� Z
dd� Z dd� Z dS )�IDatabaseConnectorzfExtension point interface for components that support the
connection to relational databases.
c C rA )al Return the connection URL schemes supported by the
connector, and their relative priorities as an iterable of
`(scheme, priority)` tuples.
If `priority` is a negative number, this is indicative of an
error condition with the connector. An error message should be
attached to the `error` attribute of the connector.
Nr r r r r �get_supported_schemes� � z(IDatabaseConnector.get_supported_schemesNc K rA )z(Create a new connection to the database.Nr )�pathr0 �kwargsr r r r1 � rd z!IDatabaseConnector.get_connectionc C rA )z�Return an object (typically a module) containing all the
backend-specific exception types as attributes, named
according to the Python Database API
(http://www.python.org/dev/peps/pep-0249/).
Nr r r r r �get_exceptions� rd z!IDatabaseConnector.get_exceptionsc K rA )zInitialize the database.Nr )re �schemar0 rf r r r �init_db� rd zIDatabaseConnector.init_dbc K rA )zDestroy the database.Nr �r re r0 rf r r r �
destroy_db� rd z IDatabaseConnector.destroy_dbc K rA )z%Return `True` if the database exists.Nr rj r r r � db_exists� rd z IDatabaseConnector.db_existsc C rA )z]Return the DDL statements necessary to create the specified
table, including indices.Nr )rH r r r �to_sql� rd zIDatabaseConnector.to_sqlc C rA )zDBackup the database to a location defined by
trac.backup_dirNr )�destr r r �backup� rd zIDatabaseConnector.backupc C rA )z�Yield a sequence of `(name, version)` tuples describing the
name and version information of external packages used by the
connector.
Nr r r r r �get_system_info� rd z"IDatabaseConnector.get_system_infor )NN)
r% r& r' r( rc r1 rg ri rk rl rm ro rp r r r r rb � s
rb c @ sH e Zd ZdZeee� ee�Z e
dddd�Z e
dddd�Z e
dd d
d �Zedd d
d�Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� ZdJd%d&�Z dKd(d)�Z d*d+� Z d,d-� Z d.d/� Z d0d1� Z!d2d3� Z"dKd4d5�Z#dKd6d7�Z$dLd9d:�Z%dMd<d=�Z&dMd>d?�Z'd@dA� Z(dBdC� Z)dDdE� Z*dFdG� Z+dHdI� Z,d;S )Nr zBComponent used to manage the `IDatabaseConnector` implementations.�trac�databasezsqlite:db/trac.dbzlDatabase connection
[wiki:TracEnvironment#DatabaseConnectionStrings string] for this
project�
backup_dirr" zDatabase backup location�timeout�20z]Timeout value for database connection, in seconds.
Use '0' to specify ''no timeout''.� debug_sqlFz>Show the SQL queries in the Trac log, at DEBUG level.
c C s d | _ td d d�| _d S )N)r- r. )� _cnx_poolr r, rR r r r r s zDatabaseManager.__init__c C sF | � � \}}tj|d< |jdi |�� tj}| �|d� | �|� d S )Nrh �initial_database_versionr )�
get_connectorr rh ri �
db_version�set_database_version)r � connectorrF �versionr r r ri s
zDatabaseManager.init_dbc C � | � tj� d S r )�insert_into_tablesr �get_datarR r r r �insert_default_data � z#DatabaseManager.insert_default_datac C s( | � � \}}| �� |jdi |�� d S �Nr )ry �shutdownrk �r r| rF r r r rk # s zDatabaseManager.destroy_dbc C s | � � \}}|jdi |��S r� )ry rl r� r r r rl ) s zDatabaseManager.db_existsc C s\ | � � d }| jj�}|D ]}|�|�D ]}||� qq
W d � dS 1 s'w Y dS )zzCreate the specified tables.
:param schema: an iterable of table objects.
:since: version 1.0.2
r N)ry r �db_transactionrm )r rh r| r" rH �sqlr r r �
create_tables- s
��"�z DatabaseManager.create_tablesc C sz t |t�r|jn|}| jj�%}|�|�s | jj�d|�|� ��|D ]}|� ||� q"W d � dS 1 s6w Y dS )zMDrops the specified columns from table.
:since: version 1.2
�Table %s not foundN)
�
isinstancer
�namer r� rV �db_exc�OperationalErrorr^ rI )r rH �columns�
table_namer" �colr r r � drop_columns: s
��"�z DatabaseManager.drop_columnsc C sV | j j� }|D ]}t|t�r|jn|}|�|� qW d � dS 1 s$w Y dS )z�Drop the specified tables.
:param schema: an iterable of `Table` objects or table names.
:since: version 1.0.2
N)r r� r� r
r� rK )r rh r" rH r� r r r � drop_tablesG s
�"�zDatabaseManager.drop_tablesc C s� | j j�4}t|�r
||�n|}|D ] \}}}|�d|�|�d�|�d�dgt|� �f |� qW d � dS 1 s;w Y dS )a� Insert data into existing tables.
:param data_or_callable: Nested tuples of table names, column names
and row data::
(table1,
(column1, column2),
((row1col1, row1col2),
(row2col1, row2col2)),
table2, ...)
or a callable that takes a single parameter
`db` and returns the aforementioned nested
tuple.
:since: version 1.1.3
z INSERT INTO %s (%s) VALUES (%s)�,z%sN)r r� �callabler$ r^ �join�len)r �data_or_callabler" �datarH �cols�valsr r r r S s
�����"�z"DatabaseManager.insert_into_tablesc C �4 | j j� }|�� W d � S 1 sw Y dS )z�Deletes all data from the tables and resets autoincrement indexes.
:return: list of names of the tables that were reset.
:since: version 1.1.3
N)r r� r_ r2 r r r r_ l s
$�z DatabaseManager.reset_tablesc s. | j j��� � �� }|D ]y}|jd }| �|�}|rPt| �|��}dd� |jD �}||@ }|rJd�� fdd�|D ��} |� d� �
|�� �
|j�f � | � |f� | � |f� |r�|r�|� d� �
|j�| | � �
|�f � |jD ]}
|
j
r}� �||j|
j� qo| � |f� q W d � d S 1 s�w Y d S )
z�Upgrade table schema to `new_schema`, preserving data in
columns that exist in the current schema and `new_schema`.
:param new_schema: tuple or list of `Table` objects
:since: version 1.2
�_oldc S s h | ]}|j �qS r �r� )�.0r� r r r � <setcomp>� s z1DatabaseManager.upgrade_tables.<locals>.<setcomp>r� c 3 s � | ]}� � |�V qd S r )r^ )r� r� �r" r r � <genexpr>� s � �z1DatabaseManager.upgrade_tables.<locals>.<genexpr>zg
CREATE TEMPORARY TABLE %s AS SELECT * FROM %s
zW
INSERT INTO %s (%s) SELECT %s FROM %s
N)r r� rO r� rV �setrL r� r� r r^ r� r� �auto_incrementr` ) r �
new_schemarO � new_table�temp_table_namerV �old_column_names�new_column_names� column_names� cols_to_copyr� r r� r �upgrade_tablesv sH
�
��
��
�� ��"�z DatabaseManager.upgrade_tablesc C sL | j s| �� \}}td|fi |��| _ | j �| jpd�}|r$t|dd�}|S )z�Get a database connection from the pool.
If `readonly` is `True`, the returned connection will purposely
lack the `rollback` and `commit` methods.
� NTr> )rw ry r �get_cnxrt r )r r? r| rF r" r r r r1 � s z DatabaseManager.get_connection�database_versionc C sh | j j�&}|d�|�d��|f�D ]\}t|� W d � S W d � dS 1 s-w Y dS )aP Returns the database version from the SYSTEM table as an int,
or `False` if the entry is not found.
:param name: The name of the entry that contains the database version
in the SYSTEM table. Defaults to `database_version`,
which contains the database version for Trac.
zM
SELECT value FROM {0} WHERE name=%s
�systemNF)r �db_query�formatr^ �int)r r� r" �valuer r r �get_database_version� s
�
�$�z$DatabaseManager.get_database_versionc C s | � � d �� S �Nr )ry rg rR r r r rg � r� z DatabaseManager.get_exceptionsc C r� )zEReturns a list of the sequence names.
:since: 1.3.2
N)r r� rS r2 r r r rS � �
$�z"DatabaseManager.get_sequence_namesc C r� )zBReturns a list of the table names.
:since: 1.1.6
N)r r� rT r2 r r r rT � r� z DatabaseManager.get_table_namesc C sl t |t�r|jn|}| jj� }|�|�s | jj�d|�|� ��|� |�W d � S 1 s/w Y dS )z�Returns a list of the column names for `table`.
:param table: a `Table` object or table name.
:since: 1.2
r� N)
r� r
r� r r� rV r� r� r^ rL �r rH r� r" r r r rL � s
�$�z DatabaseManager.get_column_namesc C sJ t |t�r|jn|}| jj�
}|�|�W d � S 1 s w Y dS rU )r� r
r� r r� rV r� r r r rV � s
$�zDatabaseManager.has_tablec C s� | � |�}|du r-| jj�}|d�|�d��||f� W d � dS 1 s&w Y dS || � |�kr`| jj�}|d�|�d��||f� W d � n1 sPw Y | j�d|||� dS dS )aH Sets the database version in the SYSTEM table.
:param version: an integer database version.
:param name: The name of the entry that contains the database version
in the SYSTEM table. Defaults to `database_version`,
which contains the database version for Trac.
FzW
INSERT INTO {0} (name, value) VALUES (%s, %s)
r� NzO
UPDATE {0} SET value=%s WHERE name=%s
zUpgraded %s from %d to %d)r� r r� r� r^ r0 �info)r r} r� �current_database_versionr" r r r r{ � s"
�"�
� ���z$DatabaseManager.set_database_versionc C sD | � |�}||kr dS ||krttd|d���| j�d|||� dS )ak Checks the database version to determine if an upgrade is needed.
:param version: the expected integer database version.
:param name: the name of the entry in the SYSTEM table that contains
the database version. Defaults to `database_version`,
which contains the database version for Trac.
:return: `True` if the stored version is less than the expected
version, `False` if it is equal to the expected version.
:raises TracError: if the stored version is greater than the expected
version.
FzNeed to downgrade %(name)s.r� z Need to upgrade %s from %d to %dT)r� � TracErrorr r0 r� )r r} r� �dbverr r r �
needs_upgrade� s
�z DatabaseManager.needs_upgrade�
trac.upgradesc
C s� | � |�}t|d |d �D ]E}d||f }zt�|�}W n ty, ttd|d���w | jj�}|� � } |�
| j|| � | � ||� W d � n1 sNw Y qdS )a( Invokes `do_upgrade(env, version, cursor)` in module
`"%s/db%i.py" % (pkg, version)`, for each required version upgrade.
:param version: the expected integer database version.
:param name: the name of the entry in the SYSTEM table that contains
the database version. Defaults to `database_version`,
which contains the database version for Trac.
:param pkg: the package containing the upgrade modules.
:raises TracError: if the package or module doesn't exist.
� z%s.db%iz No upgrade module %(module)s.py)�moduleN) r� �range� importlib�
import_module� ImportErrorr� r r r� rO �
do_upgrader{ )
r r} r� �pkgr� �ir� �upgraderr" rO r r r �upgrade s"
��
���zDatabaseManager.upgradeNc C s( | j r| j �|� |sd | _ d S d S d S r )rw r� )r �tidr r r r� % s
�zDatabaseManager.shutdownc C s� | � � \}}|s>| j}tj�|�stj�| jj|�}| j�dd�}|� dd�\}}d|| jj
t t � � �f }tj�||�}ntj�
|�}tj�|�sOt�|� |�|�S )z�Save a backup of the database.
:param dest: base filename to write to.
Returns the file actually written.
rq rr �:r� z %s.%i.%d.bak)ry rs �osre �isabsr� r �config�get�splitr� r� �time�dirname�exists�makedirsro ) r rn r| rF rs �db_str�db_name�db_path� dest_namer r r ro + s
�
zDatabaseManager.backupc s� t | j�\� }� fdd�| jD �}|sttd� d���t|�\}}|dk r*t|j��� dkrM|d dkr5ntj� |d �sMtj�
| j j|d � d ��|d< | j
rU| j|d
< ||fS ) Nc s. g | ]}|� � D ] \}}|� kr||f�qqS r )rc )r� r| �scheme_�priority��schemer r �
<listcomp>D s ��z1DatabaseManager.get_connector.<locals>.<listcomp>z&Unsupported database type "%(scheme)s"r� r �sqlitere z:memory:�/r0 )�parse_connection_uri�connection_uri�
connectorsr� r �max�errorr� re r� r� r �lstriprv r0 )r rF �
candidatesr� r| r r� r ry B s*
��
�
z DatabaseManager.get_connectorc C s d S r r rR r r r �environment_createdb s z#DatabaseManager.environment_createdc C s | � tj�S r )r� r rz rR r r r �environment_needs_upgradee s z)DatabaseManager.environment_needs_upgradec C r~ r )r� r rz rR r r r �upgrade_environmenth r� z#DatabaseManager.upgrade_environmentc c s& � | � � d }|�� D ]}|V q d S r� )ry rp )r r| r� r r r rp m s
� �z DatabaseManager.get_system_info)F)r� )r� r� r )-r% r& r' r( �
implementsr r �ExtensionPointrb r� r
r� rs r rt r rv r ri r� rk rl r� r� r� r r_ r� r1 r� rg rS rT rL rV r{ r� r� r� ro ry r� r� r� rp r r r r r � sX
����
%
r c C s | j r dd� | j D �S g S )z1Retrieve column names from a cursor, if possible.c S s0 g | ]}t |d t�rt|d d�n|d �qS )r zutf-8)r� �bytes�str)r� �dr r r r� u s (�z$get_column_names.<locals>.<listcomp>)� description)rO r r r rL s s ���rL c C s� | st jdtd�ddd�}ttdt �d�|t� d���z
| �d d
�\}}W n ty0 t | ��w |�
d �sE|d krA|rAd
}|}n9t | ��|�
d�sSd
}|d
d
� }n%|�
d�rad
}|dd
� }n|dd
� }d |v rt|�d d
�\}}n|}d}d
}|r�d|v r�|�dd
�\}}d |v r�|�d d
�\}}nd
}|r�t j �
|�}|r�tt j �
|��}nd
}}|r�d |v r�|�d d
�\}}zt|�}W n
ty� t | ��w d
}|s�d | }tjdkr�t|�d
kr�|d
dkr�d|d |dd
� f }i } d|v �r.|�dd
�\}}
|
�d�}
|
D ]$} z
| �dd
�\} }
W n t�y! t | ��w t j �
|
�}
|
| | < �q td|||||| f�}|d d � |D �fS ) aV Parse the database connection string.
The database connection string for an environment is specified through
the `database` option in the `[trac]` section of trac.ini.
:return: a tuple containing the scheme and a dictionary of attributes:
`user`, `password`, `host`, `port`, `path`, `params`.
:since: 1.1.3
z[trac]zTracIni documentation�trac-target-newz3https://trac.edgewall.org/wiki/TracIni#trac-section��title�class_�hrefz�Database connection string is empty. Set the %(option)s configuration option in the %(section)s section of trac.ini. Please refer to the %(doc)s for help.rr )�option�section�docr� r� r� r� Nz//z///� � � �@�nt�|z%s:%sr �?�&�=)�user�password�host�portre r! c S s i | ] \}}|r||�qS r r )r� �keyr� r r r �
<dictcomp>� s z(parse_connection_uri.<locals>.<dictcomp>)r �ar r r �code� _doc_db_strr� �
ValueError�_invalid_db_str�
startswith�urllib�parse�unquoter r� r� r� r� �zip)r� r� r� �restr re r r r r! �qs�paramr� r� rF r r r r� y s�
�
�� �
� �
� �r� c C s t tdt�| �t� d��S )NzcInvalid format %(db_str)s for the database connection string. Please refer to the %(doc)s for help.)r� r� )r r r r r )r� r r r r
� s
��r
c C s t jtd�td�ddd�S )N�
documentationz)Database Connection Strings documentationr� z@https://trac.edgewall.org/wiki/TracIni#DatabaseConnectionStringsr� )r r r r r r r r � s
�r )/r� r� r� � urllib.parser �abcr r rq r �trac.apir r � trac.configr r r r
� trac.core� trac.db.poolr �trac.db.schemar
� trac.db.utilr �trac.util.concurrencyr �trac.util.htmlr �trac.util.textr �trac.util.translationr r �objectr r+ r= r@ � Interfacerb � Componentr rL r� r
r r r r r �<module> s8 [1 xa