3
گa�' � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z y ddl
Z
W n e k
rp ddl Z dZ
Y nX dZ
eje�ZG d d
� d
�ZG d d � d �ZG d
d� de�ZG dd� de�Zeed�dd�ZdS )zZImplements file locks compatible with Linux and Windows for locking files and directories.� N)�Optional)�errors)�
filesystem)�osFTc @ sX e Zd ZdZedd�dd�Zed�dd�Zdd�d d
�Zdd�d d �Ze d�d
d�Z
dS )�LockFilea�
Platform independent file lock system.
LockFile accepts a parameter, the path to a file acting as a lock. Once the LockFile,
instance is created, the associated file is 'locked from the point of view of the OS,
meaning that if another instance of Certbot try at the same time to acquire the same lock,
it will raise an Exception. Calling release method will release the lock, and make it
available to every other instance.
Upon exit, Certbot will also release all the locks.
This allows us to protect a file or directory from being concurrently accessed
or modified by two Certbot instances.
LockFile is platform independent: it will proceed to the appropriate OS lock mechanism
depending on Linux or Windows.
N)�path�returnc C s( || _ trtnt}||�| _| j� dS )z�
Create a LockFile instance on the given file path, and acquire lock.
:param str path: the path to the file that will hold a lock
N)�_path�
POSIX_MODE�_UnixLockMechanism�_WindowsLockMechanism�_lock_mechanism�acquire)�selfr Z mechanism� r �/usr/lib/python3.6/lock.py�__init__$ s
zLockFile.__init__)r c C s0 dj | jj| j�}| j� r$|d7 }n|d7 }|S )Nz
{0}({1}) <z acquired>z released>)�format� __class__�__name__r � is_locked)r �repr_strr r r �__repr__/ s
zLockFile.__repr__c C s | j j� dS )z�
Acquire the lock on the file, forbidding any other Certbot instance to acquire it.
:raises errors.LockError: if unable to acquire the lock
N)r
r )r r r r r 7 s zLockFile.acquirec C s | j j� dS )zb
Release the lock on the file, allowing any other Certbot instance to acquire it.
N)r
�release)r r r r r > s zLockFile.releasec C s
| j j� S )zu
Check if the file is currently locked.
:return: True if the file is locked, False otherwise
)r
r )r r r r r D s zLockFile.is_locked) r �
__module__� __qualname__�__doc__�strr r r r �boolr r r r r r s
r c @ sF e Zd Zedd�dd�Zed�dd�Zdd�dd �Zdd�d
d �ZdS ) �_BaseLockMechanismN)r r c C s || _ d| _dS )zk
Create a lock file mechanism for Unix.
:param str path: the path to the lock file
N)r �_fd)r r r r r r M s z_BaseLockMechanism.__init__)r c C s
| j dk S )zvCheck if lock file is currently locked.
:return: True if the lock file is locked
:rtype: bool
N)r )r r r r r U s z _BaseLockMechanism.is_lockedc C s d S )Nr )r r r r r \ s z_BaseLockMechanism.acquirec C s d S )Nr )r r r r r _ s z_BaseLockMechanism.release) r r r r r r r r r r r r r r L s r c @ sL e Zd ZdZdd�dd�Zedd�dd�Zeed�d d
�Zdd�d d �Z dS )
r z�
A UNIX lock file mechanism.
This lock file is released when the locked file is closed or the
process exits. It cannot be used to provide synchronization between
threads. It is based on the lock_file package by Martin Horcicka.
N)r c C sb x\| j dkr\tj| jtjtjB d�}z | j|� | j|�r@|| _ W d| j dkrXtj |� X qW dS )zAcquire the lock.Ni� )
r r �openr r �O_CREAT�O_WRONLY� _try_lock�
_lock_success�close)r �fdr r r r j s
z_UnixLockMechanism.acquire)r' r c C sl yt j|t jt jB � W nN tk
rf } z2|jtjtjfkrTtj d| j
� t j d��� W Y dd}~X nX dS )z�
Try to acquire the lock file without blocking.
:param int fd: file descriptor of the opened file to lock
z(A lock on %s is held by another process.z/Another instance of Certbot is already running.N)
�fcntl�lockfZLOCK_EXZLOCK_NB�IOError�errno�EACCESZEAGAIN�logger�debugr r � LockError)r r' �errr r r r$ x s
z _UnixLockMechanism._try_lockc C s| ddl m} ddl m} y|| j�}W n4 tk
rZ } z|jtjkrHdS � W Y dd}~X nX ||�}|j|jkoz|j|jkS )a�
Did we successfully grab the lock?
Because this class deletes the locked file when the lock is
released, it is possible another process removed and recreated
the file between us opening the file and acquiring the lock.
:param int fd: file descriptor of the opened file to lock
:returns: True if the lock was successfully acquired
:rtype: bool
r )�fstat)�statFN) r r1 r2 r �OSErrorr+ �ENOENT�st_dev�st_ino)r r' r1 r2 Zstat1r0 Zstat2r r r r% � s
z _UnixLockMechanism._lock_successc C sD zt j| j� W d| jdkr$td��zt j| j� W dd| _X X dS )z)Remove, close, and release the lock file.NzError, self._fd is None.)r �remover r � TypeErrorr& )r r r r r � s
z_UnixLockMechanism.release)
r r r r r �intr$ r r% r r r r r r c s
r c @ s, e Zd ZdZdd�dd�Zdd�dd�ZdS )r a"
A Windows lock file mechanism.
By default on Windows, acquiring a file handler gives exclusive access to the process
and results in an effective lock. However, it is possible to explicitly acquire the
file handler in shared access in terms of read and write, and this is done by os.open
and io.open in Python. So an explicit lock needs to be done through the call of
msvcrt.locking, that will lock the first byte of the file. In theory, it is also
possible to access a file in shared delete access, allowing other processes to delete an
opened file. But this needs also to be done explicitly by all processes using the Windows
low level APIs, and Python does not do it. As of Python 3.7 and below, Python developers
state that deleting a file opened by a process from another process is not possible with
os.open and io.open.
Consequently, mscvrt.locking is sufficient to obtain an effective lock, and the race
condition encountered on Linux is not possible on Windows, leading to a simpler workflow.
N)r c C s� t jt jB t jB }d}y$tj| j|d�}tj|tj d� W nZ t
t fk
r� } z:|r^t j |� |j
t
jkrl� tjd| j� tjd��W Y dd}~X nX || _dS )zAcquire the lockNi� � z(A lock on %s is held by another process.z/Another instance of Certbot is already running.)r �O_RDWRr" �O_TRUNCr r! r �msvcrt�lockingZLK_NBLCKr* r3 r& r+ r, r- r. r r/ r )r Z open_moder' r0 r r r r � s
z _WindowsLockMechanism.acquirec C s� zt| j stjd��tj| j tjd� tj| j � ytj| j � W n0 t
k
rp } zt j t
|�� W Y dd}~X nX W dd| _ X dS )zRelease the lock.z%The lock has not been acquired first.r: N)r r �Errorr= r> ZLK_UNLCKr r& r7 r r3 r- r. r )r �er r r r � s
$z _WindowsLockMechanism.release)r r r r r r r r r r r � s r )�dir_pathr c C s t tjj| d��S )a3 Place a lock file on the directory at dir_path.
The lock file is placed in the root of dir_path with the name
.certbot.lock.
:param str dir_path: path to directory
:returns: the locked LockFile object
:rtype: LockFile
:raises errors.LockError: if unable to acquire the lock
z
.certbot.lock)r r r �join)rA r r r �lock_dir� s rC )r r+ ZloggingZtypingr Zcertbotr Zcertbot.compatr r r( � ImportErrorr= r
Z getLoggerr r- r r r r r rC r r r r �<module> s$
6U=