File: //kunden/lib/python3/dist-packages/breezy/__pycache__/url_policy_open.cpython-39.pyc
a
�*�^�/ � @ s d Z ddlmZ ddlZddlmZmZmZ ddlm Z ddl
m Z m Z ddl
mZmZ G d d
� d
ej�ZG d d � d ej�ZG d
d� dej�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�ZG dd� de�Zdd � Ze� � dS ) z+Branch opening with URL-based restrictions.� )�absolute_importN� )�errors�trace�urlutils)�Branch)�
ControlDir�ControlDirFormat)�do_catching_redirections�
get_transportc @ s e Zd ZdZdS )�BadUrlz.Tried to access a branch from bad URL %(url)s.N��__name__�
__module__� __qualname__�_fmt� r r �8/usr/lib/python3/dist-packages/breezy/url_policy_open.pyr ' s r c @ s e Zd ZdZdS )�BranchReferenceForbiddenzRTrying to mirror a branch reference and the branch type does not allow references.Nr
r r r r r , s r c @ s e Zd ZdZdZdS )�BranchLoopErrorz�Encountered a branch cycle.
A URL may point to a branch reference or it may point to a stacked branch.
In either case, it's possible for there to be a cycle in these references,
and this exception is raised when we detect such a cycle.
zEncountered a branch cycleN)r r r �__doc__r r r r r r 2 s r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �BranchOpenPolicyz�Policy on how to open branches.
In particular, a policy determines which branches are okay to open by
checking their URLs and deciding whether or not to follow branch
references.
c C s t | j��dS )a Whether we traverse references when mirroring.
Subclasses must override this method.
If we encounter a branch reference and this returns false, an error is
raised.
:returns: A boolean to indicate whether to follow a branch reference.
N)�NotImplementedError�should_follow_references��selfr r r r E s
z)BranchOpenPolicy.should_follow_referencesc C s t | j��dS )a� Validate, maybe modify, 'url' to be used as a stacked-on location.
:param branch: The branch that is being opened.
:param url: The URL that the branch provides for its stacked-on
location.
:return: (new_url, check) where 'new_url' is the URL of the branch to
actually open and 'check' is true if 'new_url' needs to be
validated by check_and_follow_branch_reference.
N)r �transform_fallback_location�r �branch�urlr r r r Q s
z,BranchOpenPolicy.transform_fallback_locationc C s t | j��dS )z�Check a URL.
Subclasses must override this method.
:param url: The source URL to check.
:raise BadUrl: subclasses are expected to raise this or a subclass
when it finds a URL it deems to be unacceptable.
N)r �
check_one_url�r r r r r r ] s z BranchOpenPolicy.check_one_urlN)r r r r r r r r r r r r = s r c @ s2 e Zd ZdZd dd�Zdd� Zdd� Zd d
� ZdS ) �_BlacklistPolicyz�Branch policy that forbids certain URLs.
This doesn't cope with various alternative spellings of URLs,
with e.g. url encoding. It's mostly useful for tests.
Nc C s |d u rt � }|| _|| _d S �N)�set� _bad_urls�_should_follow_references)r r Zbad_urlsr r r �__init__p s z_BlacklistPolicy.__init__c C s | j S r# �r& r r r r r v s z)_BlacklistPolicy.should_follow_referencesc C s || j v rt|��d S r# )r% r r! r r r r y s
z _BlacklistPolicy.check_one_urlc C s t �|j|�dfS )z�See `BranchOpenPolicy.transform_fallback_location`.
This class is not used for testing our smarter stacking features so we
just do the simplest thing: return the URL that would be used anyway
and don't check it.
F�r �join�baser r r r r } s z,_BlacklistPolicy.transform_fallback_location)N�r r r r r' r r r r r r r r" i s
r" c s e Zd ZdZ� fdd�Z� ZS )�AcceptAnythingPolicyz(Accept anything, to make testing easier.c s t t| ��dt� � d S �NT)�superr- r' r$ r �� __class__r r r' � s z AcceptAnythingPolicy.__init__)r r r r r' �
__classcell__r r r0 r r- � s r- c @ s2 e Zd ZdZd dd�Zdd� Zdd � Zd
d � ZdS )
�WhitelistPolicyz,Branch policy that only allows certain URLs.NFc C s* |d u r g }t dd� |D ��| _|| _d S )Nc s s | ]}|� d �V qdS )�/N)�rstrip)�.0r r r r � <genexpr>� � z+WhitelistPolicy.__init__.<locals>.<genexpr>)r$ � allowed_urls�check)r r r9 r: r r r r' � s zWhitelistPolicy.__init__c C s | j S r# r( r r r r r � s z(WhitelistPolicy.should_follow_referencesc C s |� d�| jvrt|��d S )Nr4 )r5 r9 r r! r r r r � s z WhitelistPolicy.check_one_urlc C s t �|j|�| jfS )z�See `BranchOpenPolicy.transform_fallback_location`.
Here we return the URL that would be used anyway and optionally check
it.
)r r* r+ r: r r r r r � s z+WhitelistPolicy.transform_fallback_location)NFr, r r r r r3 � s �
r3 c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �SingleSchemePolicyz=Branch open policy that rejects URLs not on the given scheme.c C s
|| _ d S r# )�allowed_scheme)r r< r r r r' � s zSingleSchemePolicy.__init__c C s dS r. r r r r r r � s z+SingleSchemePolicy.should_follow_referencesc C s t �|j|�dfS r. r) r r r r r � s z.SingleSchemePolicy.transform_fallback_locationc C s$ t j�t|��j| jkr t|��dS )z!Check that `url` is okay to open.N)r ZURLZ from_string�strZschemer< r r! r r r r � s z SingleSchemePolicy.check_one_urlN)r r r r r' r r r r r r r r; � s
r; c @ sd e Zd ZdZe�� Zddd�Zedd� �Z dd� Z
ed d
� �Z d d � Z d
d� Z
dd� Zddd�ZdS )� BranchOpenera0 Branch opener which uses a URL policy.
All locations that are opened (stacked-on branches, references) are
checked against a policy object.
The policy object is expected to have the following methods:
* check_one_url
* should_follow_references
* transform_fallback_location
Nc C s( || _ t� | _|du r t�� }|| _dS )z�Create a new BranchOpener.
:param policy: The opener policy to use.
:param probers: Optional list of probers to allow.
Defaults to local and remote bzr probers.
N)�policyr$ �
_seen_urlsr Z all_probers�probers)r r? rA r r r r' � s
zBranchOpener.__init__c C s t j�d| jd� dS )a� Install the ``transform_fallback_location`` hook.
This is done at module import time, but transform_fallback_locationHook
doesn't do anything unless the `_active_openers` threading.Local
object has a 'opener' attribute in this thread.
This is in a module-level function rather than performed at module
level so that it can be called in setUp for testing `BranchOpener`
as breezy.tests.TestCase.setUp clears hooks.
r �,BranchOpener.transform_fallback_locationHookN)r �hooksZinstall_named_hook� transform_fallback_locationHook)�clsr r r � install_hook� s
�zBranchOpener.install_hookc C sZ || j v rt� �| j �|� | j�|� | �|�}|du r>|S |}| j�� s t|��q dS )a Check URL (and possibly the referenced URL).
This method checks that `url` passes the policy's `check_one_url`
method, and if `url` refers to a branch reference, it checks whether
references are allowed and whether the reference's URL passes muster
also -- recursively, until a real branch is found.
:param url: URL to check
:raise BranchLoopError: If the branch references form a loop.
:raise BranchReferenceForbidden: If this opener forbids branch
references.
N)r@ r �addr? r �follow_referencer r )r r Znext_urlr r r �!check_and_follow_branch_reference� s
z.BranchOpener.check_and_follow_branch_referencec C sP zt | jd�}W n ty& | Y S 0 |j�||�\}}|rH|�|�S |S dS )a Installed as the 'transform_fallback_location' Branch hook.
This method calls `transform_fallback_location` on the policy object
and either returns the url it provides or passes it back to
check_and_follow_branch_reference.
�openerN)�getattr�_threading_data�AttributeErrorr? r rI )rE r r rJ Znew_urlr: r r r rD � s
rB c O sT | j tjd vrtd��| | j_z ||i |��W | j`t� | _S | j`t� | _0 d S )Nr zhook not installed)rD r rC �AssertionErrorrL rJ r$ r@ )r �callable�args�kwr r r �3run_with_transform_fallback_location_hook_installed s �� �z@BranchOpener.run_with_transform_fallback_location_hook_installedc s: � fdd�}� fdd�}t |�}t|||�\}}|�|�S )z�Simple BzrDir.open clone that only uses specific probers.
:param url: URL to open
:return: ControlDir instance
c sL � j �|j� | �|j|j�}|d u r2t�|j��t�d| j |j
|j � |S )Nz%s is%s redirected to %s) r? r �targetZ_redirected_to�sourcer �NotBranchErrorr Znoter+ Z permanently)� transport�eZredirection_noticeZredirected_transportr r r �
redirected% s � �z*BranchOpener._open_dir.<locals>.redirectedc sf t �| j�}� jD ]J}|� }z| |�| �fW S t jyZ } z|}W Y d }~qd }~0 0 q|�d S r# )r rU r+ rA Zprobe_transport)rV Z
last_errorZ
prober_klsZproberrW r r r � find_format0 s
z+BranchOpener._open_dir.<locals>.find_format)r r
�open)r r rX rY rV �formatr r r � _open_dir s
�zBranchOpener._open_dirc C s | � |�}|�� S )z�Get the branch-reference value at the specified url.
This exists as a separate method only to be overriden in unit tests.
)r\ Zget_branch_reference)r r �
controldirr r r rH ? s
z BranchOpener.follow_referenceFc s2 t |t�st�� �|�}� fdd�}� �|||�S )z�Open the Bazaar branch at url, first checking it.
What is acceptable means is defined by the policy's `follow_reference`
and `check_one_url` methods.
c s � � | �}|j|d�S )N)�ignore_fallbacks)r\ � open_branch)r r^ �dirr r r r_ R s
z&BranchOpener.open.<locals>.open_branch)�
isinstancer= � TypeErrorrI rR )r r r^ r_ r r r rZ G s
�zBranchOpener.open)N)F)r r r r � threadingZlocalrL r' � classmethodrF rI rD rR r\ rH rZ r r r r r> � s
r> c C s t t| ���|�S )z�Open the branch at `url`, only accessing URLs on `allowed_scheme`.
:raises BadUrl: An attempt was made to open a URL that was not on
`allowed_scheme`.
)r> r; rZ )r< r r r r �open_only_schemeY s re ) r Z
__future__r rc � r r r r r r] r r rV r
r ZBzrErrorr r r �objectr r" r- r3 r; r> re rF r r r r �<module> s$ ,