eeUj d Z ddlZddlmZ ddlmZ ddlmZ ddlm Z ddl
m Z e j j Z G d d
e j Z G d d ej" Zy)
a
Copyright (c) 2022, Ian Santopietro
All rights reserved.
This file is part of RepoLib.
RepoLib is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
RepoLib is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with RepoLib. If not, see .
N)Pathdeb822 )ParseDeb) SourceKey)utilc ( e Zd ZdZdd fd
Z xZS ) SourceErrorz Exception from a source object.r )codec 2 t | |i | || _ y)zException with a source object
Arguments:
code (:obj:`int`, optional, default=1): Exception error code.
N)super__init__r )selfr argskwargs __class__s 0/usr/lib/python3/dist-packages/repolib/source.pyr zSourceError.__init__% s $)&) )__name__
__module__ __qualname____doc__r
__classcell__r s @r r r " s *#$ r r c f e Zd ZdZeZededefd Z dddZ fdZ
d Z defd Z defd
Z
d[d edefd ZdZd
Zdeddf fd Zedefd Zej* dZd Zd\defdZdefdZd]deddfdZdZdZdefdZdefdZdefdZ dededdfd Z dZd Z edefd Z edefd Z e j* d eddfd! Z edefd" Z!e!j* d#eddfd$ Z!ede"jF fd% Z$e$j* dZd& Z$edefd' Z%e%j* d(eddfd) Z%edefd* Z&e&j* d+eddfd, Z&edefd- Z'e'j* d.eddfd/ Z'edefd0 Z(e(j* d1eddfd2 Z(edefd3 Z)e)j* d4eddfd5 Z)ed6 Z*e*j* d7 Z*edefd8 Z+e+j* dZd9 Z+edefd: Z,e,j* dZd; Z,edefd< Z-e-j* dZd= Z-edefd> Z.e.j* dZd? Z.edefd@ Z/e/j* dZdA Z/edefdB Z0e0j* dZdC Z0edefdD Z1e1j* dZdE Z1edefdF Z2e2j* dZdG Z2edefdH Z3e3j* dZdI Z3edefdJ Z4e4j* dZdK Z4edefdL Z5e5j* dZdM Z5edefdN Z6e6j* dZdO Z6edefdP Z7e7j* dZdQ Z7edefdR Z8e8j* dZdS Z8edefdT Z9edefdU Z:edefdV Z;d^defdWZ xZ?S )_Sourcea A DEB822 object representing a single software source.
Attributes:
ident(str): The unique id for this source
name(str): The user-readable name for this source
enabled(bool): Whether or not the source is enabled
types([SourceType]): A list of repository types for this source
uris([str]): A list of possible URIs for this source
suites([str]): A list of enabled suites for this source
components([str]): A list of enabled components for this source
comments(str): Comments for this source
signed_by(Path): The path to this source's key file
file(SourceFile): The file this source belongs to
key(SourceKey): The key which signs this source
shortcutreturnc | j }| j d syt | dkD syt j syt | dk( rd|d vryy)zDetermine whether a deb line is valid.
Arguments:
shortcut(str): The shortcut to validate
Returns: bool
`True` if the PPA is valid, otherwise False
debF /T)split
startswithlenr validate_debline)r
shortcut_lists r validatorzSource.validatorA s\ &^^ -
""5)=!A%$$ } "s-2C'Cr N)filec t j t | _ t | |i | | j
|| _ d| _ d| _ y)z Initialize this source objectFN)
logging getLoggerr logr r reset_valuesr+ twin_source twin_enabled)r r+ r r r s r r zSource.__init__[ sJ $$X.
$)&) !r c
| j r+d| d< | dxx dj | j z
cc< ddj | j D cg c] \ }}|d| c}} z }d}| D ]! }|t j d| d | | d
z
}# |d d }|t j j d
d z
}|dz
}| j r| j
d |S c c}}w )ztype: () -> str# Comments # z{%s}z, z: {'z': 'z', N })commentsjoinitemsr PRETTY_PRINTreplacepop)r kvrepkeys r __repr__zSource.__repr__d s
== #D
4== 9 9 499DJJL%QDAq!Q&7%QRR BC d''(#d49+SA AC B #2h $##++C456 s
== HHZ
&Rs C' c t | j dkD }t | j dkD }t | j dkD }|r|r|ryy)Nr TF)r' urissuites
components)r has_uri has_suite
has_components r __bool__zSource.__bool__| sG 499~) T[[)A- 1A 5
y]r c | j S )z~Get a UI-compatible description for a source.
Returns: (str)
The formatted description.
)namer s r get_descriptionzSource.get_description s yyr halt_errorsc | j r{| j j j }t | dkD rDd| j dt | d}|r t | | j j | |d S i S )ae Get a dictionary containing information for the signing key for
this source.
Arguments:
halt_errors (bool): if there are errors or other unexpected data,
raise a SourceError exception. Otherwise, simply log a warning.
Returns: dict
The dictionary from gnupg with key info.
r zThe keyring for z
contains z; keys. Check the keyring object for details about the keys.r )rF gpg list_keysr' identr r/ warning)r rT keys error_msgs r get_key_infozSource.get_key_info s 88 ..0D4y1}*4::,jT LQ Q %i00 +7N r c | j j d d| _ d| _ d| _ t
j j g| _ g | _ g | _
g | _ g | _ d| _
d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _
d| _ d| _ d| _ d| _ | j7 d| _ d| _ y)z+Reset the default values for all attributeszResetting source infor; TN) r/ inforX rQ enabledr
SourceTypeBINARYtypesrI rJ rK r= signed_by
architectures languagestargetspdiffsby_hashallow_insecure
allow_weakallow_downgrade_to_insecuretrustedcheck_valid_untilvalid_until_minvalid_until_maxprefs_update_legacy_optionsr+ rF rR s r r0 zSource.reset_values s
-.
oo,,-
+-( !# ! !
##% r datac > | j j d | j t j |d r,t | dkD rt
dt | d t }|j |d }|d | _ |d | _
|d | _ |d g| _ |d
g| _
|d g| _ |d | _ |d
D ]
}|d
| | |< | j! |d D ] }| j" j% | | j" dgk( rg | _ | j s| j' | _
| j( r| j+ yt, | ] | | j( r| j+ y)a Loads source information from the provided data
Should correctly load either a lecagy Deb line (optionally with
preceeding comment) or a DEB822 source.
Arguments:
data(list): the data to load into the source.
zLoading source from datar r z+The source is a legacy source but contains z( entries. It may only contain one entry.rX rQ r_ repo_typeurisuiterK optionsr= r; N)sequence)r/ r^ r0 r r( r' r r
parse_linerX rQ r_ rb rI rJ rK rq r= appendgenerate_default_namerc load_keyr r )r rr
deb_parserparsed_deblinerF commentr s r load_from_datazSource.load_from_data s
01 a )4y1}!A#d) M5 5 "J ' 2 247 ;N'0DJ&v.DI))4DL(56DJ'./DI)'23DK ,\ :DO%i0
; *9 5c :S
; ' ' ))*5
.
$$W-
.}}$ "
99 6 6 8 ~~
$' >> MMOr c R t j j | j v ryy)zB`True` if this source also provides source code, otherwise `False`TF)r r`
SOURCECODErb rR s r sourcecode_enabledzSource.sourcecode_enabled s ?? % % 3r c t j j g}|t j v r)|j t j j
|| _ y)z Accept a variety of input valuesN)r r` ra true_valuesrz r rb )r r_ rb s r r zSource.sourcecode_enabled sA ''( d&& & LL 33 4
r c | d}t | j dkD r^| j d j dd }|j }dj |dd }t j | }| | }|d| j d j z
} | d s|| d< |S # t $ r || d< Y |S w xY w) zkGenerates a suitable ID for the source
Returns: str
A sane default-id
r; r r# r: -r N X-Repolib-ID)
r' rI rA r% r> r scrub_filenamerb rX KeyError)r prefixrX ru uri_listuri_str branch_names r generate_default_identz Source.generate_default_ident s tyy>A iil**34C IIKH ((8AB<0G " 1 1' :K h{m,E
1TZZ]((*+,, )'',^$ )#(D )s
B) )B;:B;c | j } | d }|s| j | d< | d S # t $ r | j | d< | d cY S w xY w)zwGenerate a default name based on the ident
Returns: str
A name based on the ident
X-Repolib-Name)rX r r rQ s r r{ z Source.generate_default_name si :: *()D
%)ZZD! "$%% *%)ZZD! "() ) *s ) A A
ignore_errorsc | j j d| j | j s4|r'| j j d| j n t d | j t j vrTt }|j | j || _
|t j t |j < yt j | j | _
y)zFinds and loads the signing key from the system
Arguments:
ignore_errors(bool): If `False`, throw a SourceError exception if
the key can't be found/doesn't exist (Default: `True`)
zFinding key for source %sz No key configured for source %sz)No key configured for source {self.ident})pathN)
r/ r^ rX rc rY r r rZ r
reset_pathrF strr )r r new_keys r r| zSource.load_key, s
14::>~~ !BDJJO!"MNN >> * kG DNN 3 DH+2DIIc',,' (yy 0DHr c X | j dk( s| j j yy)z Proxy method to save the sourceN)r+ saverR s r r z Source.saveB s! yyD IINN !r c | j S )a8 Outputs a legacy representation of this source
Note: this is expected to fail if there is more than one type, URI, or
Suite; the one-line format does not support having multiple of these
properties.
Returns: str
The source output formatted as Legacy
)legacyrR s r
output_legacyzSource.output_legacyG s {{r c | j S )zOutputs a DEB822 representation of this source
Returns: str
The source output formatted as Deb822
r rR s r
output_822zSource.output_822S s {{r c | j S )zOutputs a string representation of this source for use in UIs
Returns: str
The source output string
)uirR s r output_uizSource.output_ui[ s
wwr propitemc . |}|j | |}y)a Appends an item to a list property of this source.
NOTE: List properties are `types`, `uris`, `suites`, and `components`.
Arguments:
prop(list): The property on which to append the item.
item(str): The item to append to the propery
N)rz )r r r _lists r prop_appendzSource.prop_appendc s
Tr c y)z+Extra tasks to perform when saving a sourceN )r r r s r
tasks_savezSource.tasks_saveo s r c N g d}|D ] }t t | | dk s y y)z>(RO) True if all required attributes are set, otherwise false.)rI rJ rX r FT)r' getattr)r required_partsattrs r has_required_partszSource.has_required_partst s4 5" D74&'!+ r c , | d S # t $ r Y yw xY w)z)The ident for this source within the filer r; r rR s r rX z Source.ident s$ ' ' rX c 8 t j | }|| d< y )Nr )r r )r rX s r rX z Source.ident s ##E* $^ r c ^ | d }|s| j | d S # t $ r d}Y $w xY w)z'The human-friendly name for this sourcer r; )r r{ )r _names r rQ z Source.name sE )*E & & ($%% E ,,rQ c || d< y )Nr r r s r rQ z Source.name s
!%
r c | d t j v }|r&| j
rt j j S t j j S # t $ r t j j cY S w xY w)z+Whether or not the source is enabled/activeEnabled)r r r AptSourceEnabledFALSEr TRUEr r_ s r r_ zSource.enabled so /9o)9)99G t..((-- -$$*** /((.. . /s A #A?>A?c > d| d< |t j v rd| d< yy)z r )r rI s r rI z Source.uris s xx~++-V r c L | d j S # t $ r g cY S w xY w)r Suitesr rR s r rJ z
Source.suites s. >'') ) I r rJ c H dj | j | d< y )Nr: r r )r rJ s r rJ z
Source.suites s &)//1Xr c L | d j S # t $ r g cY S w xY w)r
Componentsr rR s r rK zSource.components s/ %++- - I r rK c H dj | j | d< y )Nr: r r )r rK s r rK zSource.components s XXj 1 7 7 9\r c | j S )zThe options for this source)_optionsrR s r rw zSource.options s }} r rw c h d|v r'|d | _ | j r|j d || _ y N Signed-By)rc rB r )r rw s r rw zSource.options s0 ' ! $[ 1DN~~ K(
r c ^ | d }|r t | S t S # t $ r d}Y $w xY w)z6The path to any apt preferences files for this source.X-Repolib-Prefsr; )r r )r rp s r rp z Source.prefs s> *+E ; v
E r c P | d= |rt | }|| d< yy# t $ r Y w xY w)z"Accept a str or a Path-like objectr N)r r )r rp prefs_strs r rp z Source.prefs sB &' E
I&/D" # s %%c , | d S # t $ r Y yw xY w)zarchitectures option
Architecturesr; r rR s r rd zSource.architectures s$ ( ( r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr rB r rq r rr s r rd zSource.architectures# sB HH_ % $(D ! ##% + 77c , | d S # t $ r Y yw xY w)zlanguages option Languagesr; r rR s r re zSource.languages/ $ $ $ r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r re zSource.languages7 B HH[ ! $D ##% r c , | d S # t $ r Y yw xY w)ztargets optionTargetsr; r rR s r rf zSource.targetsC # ? " r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rf zSource.targetsK A HHY "DO ##% r c , | d S # t $ r Y yw xY w)z
pdiffs optionPdiffsr; r rR s r rg z
Source.pdiffsW s# > ! r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rg z
Source.pdiffs_ sA HHX !DN ##% r c , | d S # t $ r Y yw xY w)zby_hash optionBy-Hashr; r rR s r rh zSource.by_hashk r r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rh zSource.by_hashs r r c , | d S # t $ r Y yw xY w)zallow_insecure optionAllow-Insecurer; r rR s r ri zSource.allow_insecure s% () ) r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r ri zSource.allow_insecure sD HH% & %)D! " ##% r c , | d S # t $ r Y yw xY w)zallow_weak option
Allow-Weakr; r rR s r rj zSource.allow_weak s$ % % r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rj zSource.allow_weak sB HH\ " !%D ##% r c , | d S # t $ r Y yw xY w)z"allow_downgrade_to_insecure optionAllow-Downgrade-To-Insecurer; r rR s r rk z"Source.allow_downgrade_to_insecure s% 56 6 r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rk z"Source.allow_downgrade_to_insecure sD HH2 3 26D. / ##% r c , | d S # t $ r Y yw xY w)ztrusted optionTrustedr; r rR s r rl zSource.trusted r r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rl zSource.trusted r r c , | d S # t $ r Y yw xY w)zsigned_by optionr r; r rR s r rc zSource.signed_by r r c t | j d |r|| d< | j y # t $ r Y #w xY wr r r s r rc zSource.signed_by r r c , | d S # t $ r Y yw xY w)zcheck_valid_until optionCheck-Valid-Untilr; r rR s r rm zSource.check_valid_until s% +, , r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rm zSource.check_valid_until sD HH( ) (,D$ % ##% r c , | d S # t $ r Y yw xY w)zvalid_until_min optionValid-Until-Minr; r rR s r rn zSource.valid_until_min % )* * r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r rn zSource.valid_until_min D HH& ' &*D" # ##% r c , | d S # t $ r Y yw xY w)zvalid_until_max optionValid-Until-Maxr; r rR s r ro zSource.valid_until_max r r c t | j d |r|| d< | j y # t $ r Y #w xY w)Nr r r s r ro zSource.valid_until_max r r c , | d S # t $ r Y yw xY w)z%The default mirror/URI for the sourceX-Repolib-Default-Mirrorr; r rR s r default_mirrorzSource.default_mirror s% 23 3 r c |r|| d< y d| d< y )Nr r; r )r mirrors r r zSource.default_mirror& s /5D+ ,/1D+ ,r c | j | j r+d| d< | dxx dj | j z
cc< | j }| j r| j d |r|S y)z(The DEB822 representation of this sourcer4 zX-Repolib-Commentsr6 r; )rq r= r> dumprB )r _deb822s r r z
Source.deb822/ sl
##% ==)-D% & % &%**T]]*C C &))+ == HH) * Nr c \ | j | j j d }| j d}|D ]4 }|j d d }|t j
vs*|s-|| dz
}6 t j D ]% }|j |t j | }' |S )z-The UI-friendly representation of this source
z:
:r )rq r r% rX r output_skip_keyskeys_maprA )r _ui_list ui_outputlinerF s r r z Source.ui? s
##% ))$/ JJ rK )r r r_ r r msgoptions_strings r r z Source._generate_legacy_outputg sm tzz?Q #D //001DJ/ 'D74&'!+0a8;D"I;fMM!#&& ' ||$$&z dNF g dNF j F djjm)) )F cMF --/ cMF n $F\\^F dNFTYYq\N!$$T[[^$A&& #((4??++
r c d}| j D ]= }| j | dk7 s|| d| j | j dd dz
}? |S )zTurn the current options into a oneline-style string
Returns: str
The one-line-format options string
r; =r: ,)rw rA )r options_strrF s r r$ zSource._legacy_options se << OC||C B&#a S(9(A(A#s(K'LA NN O r c 2 | j | j | j | j | j | j
| j | j | j | j | j | j | j d
| _
y)z)Updates the current set of legacy options)
archlangtargetrg zby-hashzallow-insecurez
allow-weakzallow-downgrade-to-insecurerl z signed-byzcheck-valid-untilzvalid-until-minzvalid-until-maxN)rd re rf rg rh ri rj rk rl rc rm rn ro rw rR s r rq z Source._update_legacy_options st &&NNllkk|| " 1 1 //+/+K+K|| !%!7!7 # 3 3 # 3 3
r )r N)F)r; )T)FT)@r r r r DEFAULT_FORMATdefault_format staticmethodr boolr* r rG rO rS dictr\ r0 listr propertyr setterr r{ r| r r r r r r r rX rQ r r r_ rb rI rJ rK rw rp rd re rf rg rh ri rj rk rl rc rm rn ro r r r r r r$ rq r r s @r r r . s $N3 4 2 $( "0$ 2 <.$ .4 .` D 3 *&s &$1T 1T 1,
s
C 3
t
#
$
D s \\%3 %4 % %
&c & &
[[& & & & +.. + +
^^$ $ t \\ .4 .D . . d
[[. .$ . . ]]2T 2d 2 2 D :T :d : :
^^ d t \\ 0 0 & & C & & #
^^& & ]]& & #
^^& & & & S & & c !''& (& #
^^& & C & & C & & # & & # & & 2 2
C 0, ,\
r r )r r- pathlibr debianr parsedebr rF r r; r SourceFormatLEGACYr/ RepoErrorr Deb822r r r r r> sQ ( ""))
$..
C
V]] C
r