File: //usr/lib/python3/dist-packages/duplicity/__pycache__/selection.cpython-310.pyc
o
��`�W � @ s� d dl mZ d dl mZ d dl mZ d dlZd dlZd dlZd dlZd dlm Z d dlm
Z
d dlm Z d dlm Z d d l
mZmZmZ d d
lT G d d � d e�ZdS )
� )�next)�str)�objectN)�config)�diffdir)�log)�util)�
GlobbingError�FilePrefixError�select_fn_from_glob)�*c @ s� e Zd ZdZe�dejejB �Zdd� Z dd� Z
dd� Z d d
� Z d d � Z
d
d� Zdd� Zdd� Zdd� Zd*dd�Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� ZdS )+�Selectay Iterate appropriate Paths in given directory
This class acts as an iterator on account of its next() method.
Basically, it just goes through all the files in a directory in
order (depth-first) and subjects each file to a bunch of tests
(selection functions) in order. The first test that includes or
excludes the file means that the file gets included (iterated) or
excluded. The default is include, so with no tests we would just
iterate all the files in the directory in order.
The one complication to this is that sometimes we don't know
whether or not to include a directory until we examine its
contents. For instance, if we want to include all the **.py
files. If /home/ben/foo.py exists, we should also include /home
and /home/ben, but if these directories contain no **.py files,
they shouldn't be included. For this reason, a test may not
include or exclude a directory, but merely "scan" it. If later a
file in the directory gets included, so does the directory.
As mentioned above, each test takes the form of a selection
function. The selection function takes a path, and returns:
None - means the test has nothing to say about the related file
0 - the file is excluded by the test
1 - the file is included
2 - the test says the file (must be directory) should be scanned
Also, a selection function f has a variable f.exclude which should
be true iff f could potentially exclude some file. This is used
to signal an error if the last function only includes, which would
be redundant and presumably isn't what the user intends.
z(.*[*?[]|ignorecase\:)c C s0 t |t�s J t|���g | _|| _| jj| _dS )z/Initializer, called with Path of root directoryN)�
isinstance�Pathr �selection_functions�rootpath�uc_name�prefix)�self�path� r �5/usr/lib/python3/dist-packages/duplicity/selection.py�__init__T s zSelect.__init__c C s | S �Nr �r r r r �__iter__[ s zSelect.__iter__c C s
t | j�S r )r �iterr r r r �__next__^ s
zSelect.__next__c C s | j �� | �| j �| _| S )z)Initialize generator, prepare to iterate.)r �setdata�Iterater r r r r �set_itera s
zSelect.set_iterc # sD � dd� � � �fdd�}|j st�td�|j � dS t�td�|j � |V |�� s.dS ||�g}g }|r�z
t|d �\}}W n tyT |� � |rR|� � Y q5w |d kr�|rs|D ]}t�
td�|j d
� |V q]|dd�= t�td�|j � |V |�� r�|� ||�� n|d kr�|� |� |� ||�� |s7dS dS ) a Return iterator yielding paths in path
This function looks a bit more complicated than it needs to be
because it avoids extra recursion (and no extra function calls
for non-directory files) while still doing the "directory
scanning" bit.
c
S s� t j�|j|�}z9t �|�tj }t�|�r,t�t d�t
� |� tj j
t
�|�� W d S t�t d�t
� |� tjjt
�|�� W d S ty^ t�t d�t
� |� tjjt
�|�� Y d S w )NzSkipping socket %szError initializing file %s�'Error accessing possibly locked file %s)�osr �join�name�stat�ST_MODE�S_ISSOCKr �Info�_r �fsdecode�InfoCode�skipping_socket�escape�Warn� WarningCode�cannot_iterate�OSError� cannot_stat)�excr �filename�fullpath�moder r r �
error_handlerr s(
�
�� ���z%Select.Iterate.<locals>.error_handlerc 3 s� � ddl m} |�| �D ]]}|�� tj| |f�}|ri��|�}|jdv rRt� |j
tj �sR|dks4|dkrRt �
td�|j t jjt�|j
�� tjrQtj jd7 _q |dkr\|dfV q |dkri|�� ri|dfV q dS )a Generate relevant files in directory path
Returns (path, num) where num == 0 means path should be
generated normally, num == 1 means the path is a directory
and should be included iff something inside is included.
r )�robust)�reg�dir� � r! N)� duplicityr8 �listpath�check_common_errorr �appendr
�typer" �accessr$ �R_OKr r. r) r r/ � cannot_readr r- r �stats�Errors�isdir)r r8 r4 �new_path�s�r7 r r r �diryield� s6 �
�
�
�
��
��z Select.Iterate.<locals>.diryieldz*Warning: base %s doesn't exist, continuingNz Selecting %s���r � r; ) rA r r. r) r �DebugrG r �
StopIteration�pop�Logr@ )r r rK �diryield_stack�delayed_path_stack�subpath�val� delayed_pathr rJ r r h sL �
"
�
�
�
�zSelect.Iteratec C s� t �d|j � | jst �d� dS d}| jD ]#}||�}t �dt|�|jf � |dkr0d}q|dks8|dkr: nq|rC|dkrCd}|d u rId}|dkrTt �d
� |S |dkr_t �d � |S |dkseJ �t �d � |S )
zARun through the selection functions and return dominant val 0/1/2z Selection: examining path %sz8Selection: + no selection functions found. Includingr; Fz,Selection: result: %4s from function: %sr< Tr Nz Selection: - excluding filez Selection: + including filez/Selection: ? scanning directory for matches)r rN r r r r$ )r r � scan_pending�sf�resultr r r r
� s8
��
�
�
z
Select.Selectc
C s� d}z�|D ]�\}}|dkr| � | �|d�� q|dkr'| j | �|d�dd� q|dkr5| j | �� dd� q|dks=|dkrS| �|| d|�D ]}| � |� qF|d 7 }q|d
kr`| � | �d�� q|d krn| � | �|d�� q|d kr{| � | �|�� q|d
kr�| � | �|d �� q|dks�|dkr�| �|| d |�D ]}| � |� q�|d 7 }q|dkr�| � | �|d �� qJ d| ��W n ty� } z | � |� W Y d}~nd}~ww |t
|�ks�J �| � � dS )aC Create selection functions based on list of tuples
The tuples are created when the initial commandline arguments
are read. They have the form (option string, additional
argument) except for the filelist tuples, which should be
(option-string, (additional argument, filelist_fp)).
r z --excludez--exclude-if-presentT)� add_to_startz--exclude-device-filesz--exclude-filelistz--exclude-globbing-filelistr; z--exclude-other-filesystemsz--exclude-regexpz--exclude-older-thanz --includez--include-filelistz--include-globbing-filelistz--include-regexpzBad selection option %sN) �add_selection_func� glob_get_sf�present_get_sf�devfiles_get_sf�filelist_globbing_get_sfs�other_filesystems_get_sf�
regexp_get_sf�exclude_older_get_sfr �parse_catch_error�len�parse_last_excludes)r � argtuples� filelists�filelists_index�opt�argrX �er r r � ParseArgs� sF
� �� zSelect.ParseArgsc C sT t |t�rt�td�|| jf tjj� dS t |t�r)t�td�| tjj � dS � )z Deal with selection error excz�Fatal Error: The file specification
%s
cannot match any files in the base directory
%s
Useful file specifications begin with the base directory or some
pattern (such as '**') which matches the base directory.z*Fatal Error while processing expression
%sN)
r r
r �
FatalErrorr) r � ErrorCode�file_prefix_errorr �globbing_error)r r3 r r r rc s
��
��zSelect.parse_catch_errorc C s@ | j r | j d js t�td�| j d jf tjj� dS dS dS )z;Exit with error if last selection function isn't an excluderL z�Last selection expression:
%s
only specifies that files be included. Because the default is to
include all files, the expression is redundant. Exiting because this
probably isn't what you meant.N)r �excluder rm r) r$ rn �redundant_inclusionr r r r re . s
���zSelect.parse_last_excludesNc C s& |r | j �d|� dS | j �|� dS )z6Add another selection function at the end or beginningr N)r �insertr@ )r �sel_funcrZ r r r r[ ; s zSelect.add_selection_funcc C s� |� � }|s
d|fS |�d�rd|fS |}|�d�r#d}|dd� }n
|�d�r0d}|dd� }|�d�r:|�d�sD|�d �rJ|�d �rJ|dd
� }||fS ) aZ
Sanitises lines of both normal and globbing filelists, returning (line, include) and line=None if blank/comment
The aim is to parse filelists in a consistent way, prior to the interpretation of globbing statements.
The function removes whitespace, comment lines and processes modifiers (leading +/-) and quotes.
N�#z+ r; r< z- r �'�"rL )�strip�
startswith�endswith)r �line�include_default�includer r r �filelist_sanitise_lineC s
( z Select.filelist_sanitise_linec c sv � t �td�| � tjrdpd}z|�d� W n Y |�� �|�D ]}| �||�\}}|s1q$| � ||�V q$dS )a- Return list of selection functions by reading fileobj
filelist_fp should be an open file object
inc_default is true iff this is an include list
list_name is just the name of the list, used for logging
See the man page on --[include/exclude]-globbing-filelist
z Reading globbing filelist %s� �
r N)
r �Noticer) r �null_separator�seek�read�splitr~ r\ )r � filelist_fp� inc_default� list_name� separatorr{ r} r r r r_ ` s �
�z Select.filelist_globbing_get_sfsc s> � dks
� dks
J �| j �� �� �fdd�}� |_d|_|S )z=Return selection function matching files on other filesystemsr r; c s | � � r | �� �kr � S d S r )�exists� getdevloc�r �r} � root_devlocr r rt } s z1Select.other_filesystems_get_sf.<locals>.sel_funczMatch other filesystems)r r� rq r$ )r r} rt r r� r r` w s
z Select.other_filesystems_get_sfc sj � dks
� dks
J �zt �|��W n ty" t�td�| � � w � �fdd�}� |_d| |_|S )z0Return selection function given by regexp_stringr r; z%Error compiling regular expression %sc s �� | j�r� S d S r )�searchr r� �r} �regexpr r rt � s z&Select.regexp_get_sf.<locals>.sel_funczRegular expression: %s)�re�compile� Exceptionr r. r) rq r$ )r �
regexp_stringr} rt r r� r ra � s �
zSelect.regexp_get_sfc C s dd� }d|_ d|_|S )z4Return a selection function to exclude all dev filesc S s | � � rdS d S �Nr )�isdevr� r r r rt � s z(Select.devfiles_get_sf.<locals>.sel_funcr; zExclude device files�rq r$ )r rt r r r r^ � s zSelect.devfiles_get_sfc sf � dks
� dks
J �t |t�sJ �|dkr � fdd�}n| �|� �}� |_d� r+dp,d|f |_|S ) z.Return selection function given by glob stringr r; z**c s � S r r r� �r} r r �<lambda>� s z$Select.glob_get_sf.<locals>.<lambda>zCommand-line %s glob: %sr} rq )r r �glob_get_normal_sfrq r$ )r �glob_strr} rt r r� r r\ � s �zSelect.glob_get_sfc sn |dks
|dks
J �ddl m� � �fdd�}|dkr |}nt�dtjj� | |_d|r/dp0d �f |_|S )
zEReturn selection function given by existence of a file in a directoryr r; )r? c s0 � � � r� fdd�}�|� j�g�rdS d S d S )Nc s> t �td�� j t jjt�� j�� tj r tj j
d7 _
dS )Nr! r; F) r r. r) r r/ rD r r- r rE rF )�_exc� _filenamer� r r r7 � s ���zFSelect.present_get_sf.<locals>.exclude_sel_func.<locals>.error_handlerr )rG �contains)r r7 �r? r4 r� r �exclude_sel_func� s �z/Select.present_get_sf.<locals>.exclude_sel_funcz<--include-if-present not implemented (would it make sense?).z Command-line %s filename: %szinclude-if-presentzexclude-if-present)�duplicity.robustr? r rm rn �not_implementedrq r$ )r r4 r} r� rt r r� r r] � s ��zSelect.present_get_sfc C sz t |t�sJ d|�t�� d� d ��d}|�� �d�r(|td�d� �� }d}t|dd �| j �}|s7t
|��t|||�S )
aM Return selection function based on glob_str
The basic idea is to turn glob_str into a regular expression,
and just use the normal regular expression. There is a
complication because the selection function should return '2'
(scan) for directories which may contain a file which matches
the glob_str. So we break up the glob string into parts, and
any file which matches an initial sequence of glob parts gets
scanned.
Thanks to Donovan Baarda who provided some code which did some
things similar to this.
zThe glob string �ignorez is not unicodeFz ignorecase:NTr; r� ) r r �decode�sys�getfilesystemencoding�lowerry rd r r r
)r r� r} � ignore_case�file_prefix_selectionr r r r� � s � zSelect.glob_get_normal_sfc s" � fdd�}d|_ d� f |_|S )zFReturn selection function based on files older than modification date c
sR | � � sd S ztj�| j�� k rW dS W d S ty( } zW Y d }~d S d }~ww r� )�isregr" r �getmtimer$ r1 )r rk ��dater r rt s ��
��z-Select.exclude_older_get_sf.<locals>.sel_funcTzSelect older than %sr� )r r� rt r r� r rb s
zSelect.exclude_older_get_sfr ) �__name__�
__module__� __qualname__�__doc__r� r� �I�S�glob_rer r r r r r
rl rc re r[ r~ r_ r` ra r^ r\ r] r� rb r r r r r
/ s, "_%0
' "r
)�builtinsr r r r" r% r� r� r= r r r r �duplicity.globmatchr r
r �duplicity.pathr
r r r r �<module> s