o
cxR @ s. d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z dd
lm
Z
dd l m Z dd l
mZ dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ G dd dejZG dd deZG dd deZG dd deZej e ej e ej e dS )aU
Augeas implementation of the ParserNode interfaces.
Augeas works internally by using XPATH notation. The following is a short example
of how this all works internally, to better understand what's going on under the
hood.
A configuration file /etc/apache2/apache2.conf with the following content:
# First comment line
# Second comment line
WhateverDirective whatevervalue
DirectiveInABlock dirvalue
SomeDirective somedirectivevalue
AnotherDirectiveInABlock dirvalue
# Yet another comment
Translates over to Augeas path notation (of immediate children), when calling
for example: aug.match("/files/etc/apache2/apache2.conf/*")
[
"/files/etc/apache2/apache2.conf/#comment[1]",
"/files/etc/apache2/apache2.conf/#comment[2]",
"/files/etc/apache2/apache2.conf/directive[1]",
"/files/etc/apache2/apache2.conf/ABlock[1]",
"/files/etc/apache2/apache2.conf/directive[2]",
"/files/etc/apache2/apache2.conf/ABlock[2]",
"/files/etc/apache2/apache2.conf/#comment[3]"
]
Regardless of directives name, its key in the Augeas tree is always "directive",
with index where needed of course. Comments work similarly, while blocks
have their own key in the Augeas XPATH notation.
It's important to note that all of the unique keys have their own indices.
Augeas paths are case sensitive, while Apache configuration is case insensitive.
It looks like this:
directive value
Directive Value
directive value
DiReCtiVe VaLuE
Translates over to:
[
"/files/etc/apache2/apache2.conf/block[1]",
"/files/etc/apache2/apache2.conf/Block[1]",
"/files/etc/apache2/apache2.conf/block[2]",
"/files/etc/apache2/apache2.conf/bLoCk[1]",
]
)Any)cast)Dict)Iterable)List)Optional)Set)Tuple)Union)errors)os) apache_util)
assertions)
interfaces)parser)parsernode_utilc sz e Zd ZdZdeddf fdd Zdee ddfdd Zd
ede d fd d Z
d
eddfddZ d
edefddZ Z
S )AugeasParserNodez/ Augeas implementation of ParserNode interface kwargsreturnNc s t |\}}}}t jdi | || _|| _|| _|| _tt j
| j d| _ z| jd dr=t
d| jd W d S tyK t
dw )N augeasparser
augeaspath/z$Augeas path: {} has a trailing slashzAugeas path is required )utilparsernode_kwargssuper__init__ancestorfilepathdirtymetadatar r ApacheParsergetendswithr PluginErrorformatKeyError)selfr r r r r __class__r R/opt/certbot/lib/python3.10/site-packages/certbot_apache/_internal/augeasparser.pyr Y s(
zAugeasParserNode.__init__msgc C s | j | d S N)r save)r' r+ r r r* r- m s zAugeasParserNode.savenamec C sb g }| j d } |dd }|r|dkr |S | |}|jdur0|j | kr0|| q)z
Searches for ancestor BlockNodes with a given name.
:param str name: Name of the BlockNode parent to search for
:returns: List of matching ancestor nodes.
:rtype: list of AugeasParserNode
r Tr r z/filesN)r
rpartition_create_blocknoder. lowerappend)r' r. ancestorsparentancr r r* find_ancestorsp s
z AugeasParserNode.find_ancestorspathAugeasBlockNodec C sX | |}| j|d}t|}|du r td| d| j|}t||tj||dS )z
Helper function to create a BlockNode from Augeas path. This is used by
AugeasParserNode.find_ancestors and AugeasBlockNode.
and AugeasBlockNode.find_blocks
r r N No file path found for vhost: .)r. enabledr r r )
_aug_get_namer r
get_file_path
ValueErrorparsed_in_originalr8 r PASS)r' r7 r. r file_pathr< r r r* r0 s
z"AugeasParserNode._create_blocknodec C s4 |d dkr |dd }| dd }| dd S )z]
Helper function to get name of a configuration block or variable from path.
r N[r )split)r' r7 r. r r r* r= s z AugeasParserNode._aug_get_name)__name__
__module__ __qualname____doc__r r r strr- r r6 r0 r=
__classcell__r r r( r* r V s r c s< e Zd ZdZdeddf fdd Zdedefdd Z ZS )
AugeasCommentNodez0 Augeas implementation of CommentNode interface r r Nc s* t |\}}t jdi | || _d S Nr )r commentnode_kwargsr r comment)r' r rO r( r r* r s
zAugeasCommentNode.__init__otherc C sL t || jr$| j|jko#| j|jko#| j|jko#| j|jko#| j|jkS dS NF)
isinstancer) rO r r r r r' rP r r r* __eq__ s
zAugeasCommentNode.__eq__) rF rG rH rI r r boolrT rK r r r( r* rL s rL c s e Zd ZdZdeddf fdd Zdedefdd Zd
ee ddfd d Z
e de e d
f fddZ
de dee fddZ ZS )AugeasDirectiveNodez2 Augeas implementation of DirectiveNode interface r r Nc sF t |\}}}}t jdi | || _|| _|r!| | d S d S rM )r directivenode_kwargsr r r. r< set_parameters)r' r r.
parametersr< r( r r* r s z AugeasDirectiveNode.__init__rP c C sd t || jr0| j|jko/| j|jko/| j|jko/| j|jko/| j|jko/| j|jko/| j|jkS dS rQ ) rR r) r. r rY r< r r r rS r r r* rT s
zAugeasDirectiveNode.__eq__rY c C st | | jd }|D ]}d| jd }| jj| q
t|D ]\}}d| jd |d }| jj|| q dS )z
Sets parameters of a DirectiveNode or BlockNode object.
:param list parameters: List of all parameters for the node to set.
r z {}/arg[1]z
{}/arg[{}] N)_aug_get_paramsr r% r augremove enumerateset)r' rY orig_params_
param_pathpiparamr r r* rX s z"AugeasDirectiveNode.set_parameters.c C s t | | jd S )z
Fetches the parameters from Augeas tree, ensuring that the sequence always
represents the current state
:returns: Tuple of parameters for this DirectiveNode
:rtype: tuple:
r )tupler[ r r' r r r* rY s z AugeasDirectiveNode.parametersr7 c s2 j j|d } fdd|D }dd |D S )zCHelper function to get parameters for DirectiveNodes and BlockNodes/argc s g | ]} j |qS r )r get_arg).0apathrf r r*
z7AugeasDirectiveNode._aug_get_params..c S s g | ]}|d ur|qS r, r )ri argr r r* rk rl )r r\ match)r' r7 arg_pathsargsr rf r* r[ s z#AugeasDirectiveNode._aug_get_params)rF rG rH rI r r rU rT r rJ rX propertyr rY r r[ rK r r r( r* rV s
rV c s e Zd ZdZdeddf fdd Zdedefdd Z d0d
ed e e
e d e e dd fd
dZ d0d
ed e e
e d e e de
fddZ d1ded e e ddfddZd2d
edede
d fddZd2d
edede
d fdd Zdede
d fd d Zd3d!d"Zdee fd#d$Zde
e fd%d&Zd'eddfd(d)Zd'eddfd*d+Zd
edee fd,d-Zd
ed e e deeeef fd.d/Z Z S )4r8 z. Augeas implementation of BlockNode interface r r Nc s t jdi | d| _d S rM )r r children)r' r r( r r* r s
zAugeasBlockNode.__init__rP c C sp t || jr6| j|jko5| j|jko5| j|jko5| j|jko5| j|jko5| j|jko5| j|jko5| j |j kS dS rQ )
rR r) r. r rY rr r< r r r rS r r r* rT s"
zAugeasBlockNode.__eq__r. rY positionc
C st | ||\}}}| j|d}| jj||| t|}|du r)td| | j|} t ||| t
j ||dS )z0Adds a new BlockNode to the sequence of childrenr9 Nr: r. rY r< r r r ) _aug_resolve_child_positionr r\ insertr
r> r Errorr@ r8 r rA
r' r. rY rs
insertpathrealpathbefore new_metadatarB r< r r r* add_child_block s$
z AugeasBlockNode.add_child_blockc
C s |st d| d|\}}}| j|d}| jj|d| | jj|| t|}|du r8t d| | j
|} t ||| t j
||dS )z4Adds a new DirectiveNode to the sequence of childrenz0Directive requires parameters and none were set. directiver9 Nr: rt )r r$ ru r r\ rv r_ r
r> rw r@ rV r rA rx r r r* add_child_directive3 s*
z#AugeasBlockNode.add_child_directive rO rL c C sX | d|\}}}| j|d}| jj|d| | jj|| t|tjt ||dS )z2Adds a new CommentNode to the sequence of childrenz#commentr9 rO r r r )
ru r r\ rv r_ rL r rA r
r> )r' rO rs ry rz r{ r| r r r* add_child_commentT s
z!AugeasBlockNode.add_child_commentTexcludec C s< g }| |}|r| j|}|D ]
}|| | q|S )z g }| j d}| jj||d}|D ]
}|| | q|S )z
Recursive search of DirectiveNodes from the sequence of children.
:param str comment: Comment content to search for.
r )r )r r" r
find_commentsr2 _create_commentnode)r' rO r r commentscomr r r* r s z AugeasBlockNode.find_commentschildr c C s. | j j|jd std|jd dS )z
Deletes a ParserNode from the sequence of children, and raises an
exception if it's unable to do so.
:param AugeasParserNode child: A node to delete.
r zGCould not delete child node, the Augeas path: {} doesn't seem to exist.N)r r\ r] r r r$ r% )r' r r r r* delete_child s z AugeasBlockNode.delete_childc C s
| j S )z#Returns a list of unsaved filepaths)r
unsaved_filesrf r r r* r s
z AugeasBlockNode.unsaved_filesc C s< g }| j j}|D ]}|| D ] }|tj|| qq|S )an
Returns a list of file paths that have currently been parsed into the parser
tree. The returned list may include paths with wildcard characters, for
example: ['/etc/apache2/conf.d/*.load']
This is typically called on the root node of the ParserNode tree.
:returns: list of file paths of files that have been parsed
)r existing_pathsr2 r r7 join)r' res_pathsr directoryfilenamer r r* parsed_paths s z AugeasBlockNode.parsed_pathsr7 c C s2 | j j|}| j |d}t|tjt||dS )z8Helper function to create a CommentNode from Augeas pathr9 r )r r\ r" rL r rA r
r> )r' r7 rO r r r r* r s z#AugeasBlockNode._create_commentnodec C sD | j |}| j |d}| j t|}t|tj|t||dS )z:Helper function to create a DirectiveNode from Augeas pathr9 )r. r r< r r )r rh r@ r
r> rV r rA )r' r7 r. r r< r r r* r s z%AugeasBlockNode._create_directivenodec sP t }t| jjD ] }| jjd|t f }| fdd|D q |S )zoHelper function to perform a search to Augeas DOM tree to search
configuration blocks with a given namez"/files%s//*[label()=~regexp('%s')]c s( g | ]} tj| v r|qS r )r1 r r7 basename)ri r7 r. r r* rk s
z4AugeasBlockNode._aug_find_blocks..)r_ listr parser_pathsr\ rn case_iupdate)r' r. blk_paths
vhost_pathr r r r* r s z AugeasBlockNode._aug_find_blocksc C s d}| j jd| jd }d}t|D ]\}}|dur#||kr# n| |}||kr0|d7 }qd| jd ||} | pG|du pG|t|k}
|
rSd| jd } n|dkr^|d } d }n d
| jd |} | | |fS ) a2
Helper function that iterates through the immediate children and figures
out the insertion path for a new AugeasParserNode.
Augeas also generalizes indices for directives and comments, simply by
using "directive" or "comment" respectively as their names.
This function iterates over the existing children of the AugeasBlockNode,
returning their insertion path, resulting Augeas path and if the new node
should be inserted before or after the returned insertion path.
Note: while Apache is case insensitive, Augeas is not, and blocks like
Nameofablock and NameOfABlock have different indices.
:param str name: Name of the AugeasBlockNode to insert, "directive" for
AugeasDirectiveNode or "comment" for AugeasCommentNode
:param int position: The position to insert the child AugeasParserNode to
:returns: Tuple of insert path, resulting path and a boolean if the new
node should be inserted before it.
:rtype: tuple of str, str, bool
Fz{}/*r rZ Nz {}/{}[{}]z {}/*[last()]r Tz{}/*[{}])r r\ rn r% r r^ r= len) r' r. rs r{ all_childrencounterir childnameresulting_pathr2 insert_pathr r r* ru s<
z+AugeasBlockNode._aug_resolve_child_position)NN)r N)T)r r r N) rF rG rH rI r r rU rT rJ r r intr} rV r r r r r r r r r r r r r ru rK r r r( r* r8 s\
"
r8 N) rI typingr r r r r r r r r
certbotr certbot.compatr certbot_apache._internalr
r r r r r
ParserNoder rL rV r8 CommentNoderegister
DirectiveNode BlockNoder r r r* s4 B ^; 6