275 lines
8.6 KiB
Python
275 lines
8.6 KiB
Python
|
#!/usr/bin/python3
|
||
|
|
|
||
|
|
"""
|
||
|
|
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 <https://www.gnu.org/licenses/>.
|
||
|
|
"""
|
||
|
|
|
||
|
|
import logging
|
||
|
|
|
||
|
|
from repolib.key import SourceKey
|
||
|
|
|
||
|
|
from ..source import Source, SourceError
|
||
|
|
from ..file import SourceFile
|
||
|
|
from .. import util
|
||
|
|
|
||
|
|
try:
|
||
|
|
from launchpadlib.launchpad import Launchpad
|
||
|
|
from lazr.restfulclient.errors import BadRequest, NotFound, Unauthorized
|
||
|
|
except ImportError:
|
||
|
|
raise SourceError(
|
||
|
|
'Missing optional dependency "launchpadlib". Try `sudo apt install '
|
||
|
|
'python3-launchpadlib` to install it.'
|
||
|
|
)
|
||
|
|
|
||
|
|
BASE_FORMAT = util.SourceFormat.LEGACY
|
||
|
|
BASE_URL = 'http://ppa.launchpad.net'
|
||
|
|
BASE_DIST = 'ubuntu'
|
||
|
|
BASE_COMPS = 'main'
|
||
|
|
|
||
|
|
DEFAULT_FORMAT = util.SourceFormat.LEGACY
|
||
|
|
|
||
|
|
prefix = 'ppa'
|
||
|
|
delineator = ':'
|
||
|
|
|
||
|
|
class PPASource(Source):
|
||
|
|
""" PPA Source shortcut
|
||
|
|
|
||
|
|
These are given in the format ppa:owner/name. Much of this code is adapted
|
||
|
|
from SoftwareProperties.
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
shortcut (str): The ppa: shortcut to process
|
||
|
|
fetch_data (bool): Whether to try and fetch metadata from Launchpad.
|
||
|
|
"""
|
||
|
|
|
||
|
|
default_format = BASE_FORMAT
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def validator(shortcut:str) -> bool:
|
||
|
|
"""Determine whether a PPA shortcut is valid.
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
shortcut(str): The shortcut to validate
|
||
|
|
|
||
|
|
Returns: bool
|
||
|
|
`True` if the PPA is valid, otherwise False
|
||
|
|
"""
|
||
|
|
|
||
|
|
if shortcut.startswith(f'{prefix}:'):
|
||
|
|
shortlist = shortcut.split('/')
|
||
|
|
if len(shortlist) > 1:
|
||
|
|
return True
|
||
|
|
return False
|
||
|
|
|
||
|
|
def __init__(self, *args, line='', fetch_data=True, **kwargs):
|
||
|
|
if line:
|
||
|
|
if not line.startswith('ppa:'):
|
||
|
|
raise SourceError(f'The PPA shortcut {line} is malformed')
|
||
|
|
super().__init__(args, kwargs)
|
||
|
|
self.log = logging.getLogger(__name__)
|
||
|
|
self.line = line
|
||
|
|
self.ppa = None
|
||
|
|
self.twin_source = True
|
||
|
|
self._displayname = ''
|
||
|
|
self._description = ''
|
||
|
|
if line:
|
||
|
|
self.load_from_shortcut(self.line)
|
||
|
|
|
||
|
|
def get_description(self) -> str:
|
||
|
|
output:str = ''
|
||
|
|
output += self.displayname
|
||
|
|
output += '\n\n'
|
||
|
|
output += self.description
|
||
|
|
return output
|
||
|
|
|
||
|
|
def load_from_data(self, data: list) -> None:
|
||
|
|
self.load_from_shortcut(shortcut=data[0])
|
||
|
|
|
||
|
|
def load_from_shortcut(self, shortcut:str='', meta:bool=True, key:bool=True) -> None:
|
||
|
|
"""Translates the shortcut line into a full repo.
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
shortcut(str): The shortcut to load, if one hasn't been loaded yet.
|
||
|
|
meta(bool): Whether to fetch repo metadata from Launchpad
|
||
|
|
key(bool): Whether to fetch and install a signing key
|
||
|
|
"""
|
||
|
|
self.reset_values()
|
||
|
|
if shortcut:
|
||
|
|
self.line = shortcut
|
||
|
|
|
||
|
|
if not self.line:
|
||
|
|
raise SourceError('No PPA shortcut provided')
|
||
|
|
|
||
|
|
if not self.validator(self.line):
|
||
|
|
raise SourceError(f'The line {self.line} is malformed')
|
||
|
|
|
||
|
|
line = self.line.replace(prefix + delineator, '')
|
||
|
|
self.info_parts = line.split('/')
|
||
|
|
ppa_owner = self.info_parts[0]
|
||
|
|
ppa_name = self.info_parts[1]
|
||
|
|
|
||
|
|
self.ident = f'{prefix}-{ppa_owner}-{ppa_name}'
|
||
|
|
if f'{self.ident}.{BASE_FORMAT.value}' not in util.files:
|
||
|
|
new_file = SourceFile(name=self.ident)
|
||
|
|
new_file.format = BASE_FORMAT
|
||
|
|
self.file = new_file
|
||
|
|
util.files[str(self.file.path)] = self.file
|
||
|
|
else:
|
||
|
|
self.file = util.files[str(self.file.path)]
|
||
|
|
|
||
|
|
self.file.add_source(self)
|
||
|
|
|
||
|
|
self.name = self.ident
|
||
|
|
self.uris = [f'{BASE_URL}/{ppa_owner}/{ppa_name}/{BASE_DIST}']
|
||
|
|
self.suites = [util.DISTRO_CODENAME]
|
||
|
|
self.components = [BASE_COMPS]
|
||
|
|
|
||
|
|
if meta or key:
|
||
|
|
self.ppa = get_info_from_lp(ppa_owner, ppa_name)
|
||
|
|
self.displayname = self.ppa.displayname
|
||
|
|
self.description = self.ppa.description
|
||
|
|
|
||
|
|
if self.ppa and meta:
|
||
|
|
self.name = self.ppa.displayname
|
||
|
|
|
||
|
|
if self.ppa and key:
|
||
|
|
repo_key = SourceKey(name=self.ident)
|
||
|
|
if str(repo_key.path) not in util.keys:
|
||
|
|
repo_key.load_key_data(fingerprint=self.ppa.fingerprint)
|
||
|
|
util.keys[str(repo_key.path)] = repo_key
|
||
|
|
self.key:SourceKey = repo_key
|
||
|
|
else:
|
||
|
|
self.key = util.keys[repo_key.path]
|
||
|
|
self.signed_by = str(self.key.path)
|
||
|
|
|
||
|
|
self.enabled = True
|
||
|
|
|
||
|
|
@property
|
||
|
|
def displayname(self) -> str:
|
||
|
|
"""The name of the PPA provided by launchpad"""
|
||
|
|
if self._displayname:
|
||
|
|
return self._displayname
|
||
|
|
if self.ppa:
|
||
|
|
self._displayname = self.ppa.displayname
|
||
|
|
return self._displayname
|
||
|
|
|
||
|
|
@displayname.setter
|
||
|
|
def displayname(self, displayname) -> None:
|
||
|
|
"""Cache this for use without hitting LP"""
|
||
|
|
self._displayname = displayname
|
||
|
|
|
||
|
|
@property
|
||
|
|
def description(self) -> str:
|
||
|
|
"""The description of the PPA provided by Launchpad"""
|
||
|
|
if self._description:
|
||
|
|
return self._description
|
||
|
|
if self.ppa:
|
||
|
|
self._description = self.ppa.description
|
||
|
|
return self._description
|
||
|
|
|
||
|
|
@description.setter
|
||
|
|
def description(self, desc) -> None:
|
||
|
|
"""Cache this for use without hitting LP"""
|
||
|
|
self._description = desc
|
||
|
|
|
||
|
|
class PPA:
|
||
|
|
""" An object to fetch data from PPAs.
|
||
|
|
|
||
|
|
Portions of this class were adapted from Software Properties
|
||
|
|
"""
|
||
|
|
|
||
|
|
def __init__(self, teamname, ppaname):
|
||
|
|
self.teamname = teamname
|
||
|
|
self.ppaname = ppaname
|
||
|
|
self._lap = None
|
||
|
|
self._lpteam = None
|
||
|
|
self._lpppa = None
|
||
|
|
self._signing_key_data = None
|
||
|
|
self._fingerprint = None
|
||
|
|
|
||
|
|
@property
|
||
|
|
def lap(self):
|
||
|
|
""" The Launchpad Object."""
|
||
|
|
if not self._lap:
|
||
|
|
self._lap = Launchpad.login_anonymously(
|
||
|
|
f'{self.__module__}.{self.__class__.__name__}',
|
||
|
|
service_root='production',
|
||
|
|
version='devel'
|
||
|
|
)
|
||
|
|
return self._lap
|
||
|
|
|
||
|
|
@property
|
||
|
|
def lpteam(self):
|
||
|
|
""" The Launchpad object for the PPA's owner."""
|
||
|
|
if not self._lpteam:
|
||
|
|
try:
|
||
|
|
self._lpteam = self.lap.people(self.teamname) # type: ignore (This won't actually be unbound because of the property)
|
||
|
|
except NotFound as err:
|
||
|
|
msg = f'User/Team "{self.teamname}" not found'
|
||
|
|
raise SourceError(msg) from err
|
||
|
|
except Unauthorized as err:
|
||
|
|
msg = f'Invalid user/team name "{self.teamname}"'
|
||
|
|
raise SourceError(msg) from err
|
||
|
|
return self._lpteam
|
||
|
|
|
||
|
|
@property
|
||
|
|
def lpppa(self):
|
||
|
|
""" The Launchpad object for the PPA."""
|
||
|
|
if not self._lpppa:
|
||
|
|
try:
|
||
|
|
self._lpppa = self.lpteam.getPPAByName(name=self.ppaname)
|
||
|
|
except NotFound as err:
|
||
|
|
msg = f'PPA "{self.teamname}/{self.ppaname}"" not found'
|
||
|
|
raise SourceError(msg) from err
|
||
|
|
except BadRequest as err:
|
||
|
|
msg = f'Invalid PPA name "{self.ppaname}"'
|
||
|
|
raise SourceError(msg) from err
|
||
|
|
return self._lpppa
|
||
|
|
|
||
|
|
@property
|
||
|
|
def description(self) -> str:
|
||
|
|
"""str: The description of the PPA."""
|
||
|
|
return self.lpppa.description or ''
|
||
|
|
|
||
|
|
@property
|
||
|
|
def displayname(self) -> str:
|
||
|
|
""" str: the fancy name of the PPA."""
|
||
|
|
return self.lpppa.displayname or ''
|
||
|
|
|
||
|
|
@property
|
||
|
|
def fingerprint(self):
|
||
|
|
""" str: the fingerprint of the signing key."""
|
||
|
|
if not self._fingerprint:
|
||
|
|
self._fingerprint = self.lpppa.signing_key_fingerprint
|
||
|
|
return self._fingerprint
|
||
|
|
|
||
|
|
|
||
|
|
def get_info_from_lp(owner_name, ppa):
|
||
|
|
""" Attempt to get information on a PPA from launchpad over the internet.
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
owner_name (str): The Launchpad user owning the PPA.
|
||
|
|
ppa (str): The name of the PPA
|
||
|
|
|
||
|
|
Returns:
|
||
|
|
json: The PPA information as a JSON object.
|
||
|
|
"""
|
||
|
|
ppa = PPA(owner_name, ppa)
|
||
|
|
return ppa
|