Class EntropyRepository

EntropyRepository constructor.

Parameters:

• readOnly (bool) - open file in read-only mode
• noUpload (bool) - server-side setting for not allowing database uploads when remote revision is lower than local
• dbFile (string) - path to database to open
• clientDatabase (bool) - state that EntropyRepository instance is a client-side one
• xcache (bool) - enable on-disk cache
• dbname (string) - EntropyRepository instance identifier
• indexing (bool) - enable database indexes
• OutputInterface (entropy.output.TextInterface based instance) - interface used to communicate with the user. must inherit entropy.output.TextInterface
• skipChecks (bool) - if True, skip integrity checks
• useBranch (string) - if True, it won't use SystemSettings' branch setting but rather the one provided
• lockRemote (bool) - determine whether remote server-side database should be locked when updating the local version

Change low-level, storage engine based cache size.

Parameters:

• size (int) - new size

Change default low-level, storage engine based cache size.

Parameters:

• size (int) - new default size

Close repository storage communication. Note: once issues this, you won't be able to use such instance anymore.

Server-side function used to determine whether repository database has been modified.

Returns: bool

taint status

WARNING: it will erase your database. This method (re)initialize the repository, dropping all its content.

This method should be considered internal and not suited for general audience. Given a raw package name/slot updates list, it returns the action that should be really taken because not applied.

Parameters:

• actions (list) - list of raw treeupdates actions, for example: ['move x11-foo/bar app-foo/bar', 'slotmove x11-foo/bar 2 3']

Returns: list

list of raw treeupdates actions that should be really worked out

docstring_title

Parameters:

• actions ()

docstring_title

Parameters:

• move_command ()
• quickpkg_queue ()

docstring_title

Parameters:

• slotmove_command ()
• quickpkg_queue ()

Erase dead Source Package Manager db entries.

Parameters:

• spm_moves (list) - list of raw package name/slot update actions.

Update or add a package to repository automatically handling
its scope and thus removal of previous versions if requested by
the given metadata.
etpData is a dict() containing all the information bound to
a package:

    {
        'signatures':
            {
                'sha256': u'zzz',
                'sha1': u'zzz',
                'sha512': u'zzz'
         },
        'slot': u'0',
        'datecreation': u'1247681752.93',
        'description': u'Standard (de)compression library',
        'useflags': set([u'kernel_linux']),
        'eclasses': set([u'multilib']),
        'config_protect_mask': u'string string', 'etpapi': 3,
        'mirrorlinks': [],
        'cxxflags': u'-Os -march=x86-64 -pipe',
        'injected': False,
        'licensedata': {u'ZLIB': u"lictext"},
        'dependencies': {},
        'chost': u'x86_64-pc-linux-gnu',
        'config_protect': u'string string',
        'download': u'packages/amd64/4/sys-libs:zlib-1.2.3-r1.tbz2',
        'conflicts': set([]),
        'digest': u'fd54248ae060c287b1ec939de3e55332',
        'size': u'136302',
        'category': u'sys-libs',
        'license': u'ZLIB',
        'needed_paths': {},
        'sources': set(),
        'name': u'zlib',
        'versiontag': u'',
        'changelog': u"text",
        'provide': set([]),
        'trigger': u'text',
        'counter': 22331,
        'messages': [],
        'branch': u'4',
        'content': {},
        'needed': [(u'libc.so.6', 2)],
        'version': u'1.2.3-r1',
        'keywords': set(),
        'cflags': u'-Os -march=x86-64 -pipe',
        'disksize': 932206, 'spm_phases': None,
        'homepage': u'http://www.zlib.net/',
        'systempackage': True,
        'revision': 0
    }

@param etpData: Entropy package metadata dict
@type etpData: dict
@keyword forcedRevision: force a specific package revision
@type forcedRevision: int
@keyword formattedContent: tells whether content metadata is already
    formatted for insertion
@type formattedContent: bool
@return: tuple composed by
    - idpackage: unique Entropy Repository package identifier
    - revision: final package revision selected
    - etpData: new Entropy package metadata dict
@rtype: tuple

Return a list of packages that would be removed given name, category, slot and injection status.

Parameters:

• name (string) - package name
• category (string) - package category
• slot (string) - package slot
• injected (bool) - injection status (packages marked as injected are always considered not automatically removable)

Returns: set

list (set) of removable packages (idpackages)

Add package to this Entropy repository. The main difference between handlePackage and this is that from here, no packages are going to be removed, in any case. For more information about etpData layout, please see handlePackage().

Parameters:

• etpData (dict) - Entropy package metadata
• revision (int) - force a specific Entropy package revision
• idpackage (int) - add package to Entropy repository using the provided package identifier, this is very dangerous and could cause packages with the same identifier to be removed.
• do_commit (bool) - if True, automatically commits the executed transaction (could cause slowness)
• formatted_content (bool) - if True, determines whether the content metadata (usually the biggest part) in etpData is already prepared for insertion

Returns: tuple

tuple composed by

• idpackage: unique Entropy Repository package identifier
• revision: final package revision selected
• etpData: new Entropy package metadata dict

Remove package from this Entropy repository using it's identifier (idpackage).

Parameters:

• idpackage (int) - Entropy repository package indentifier
• do_cleanup (bool) - if True, executes repository metadata cleanup at the end
• do_commit (bool) - if True, commits the transaction (could cause slowness)
• do_rss (bool) - triggered only for server-side repositories, if True, generates information about the removal in RSS form, dumping data to cache (used internally to handle RSS support for repositories).

Remove source packages mirror entries from database for the given mirror name. This is a representation of Portage's "thirdpartymirrors".

Parameters:

• mirrorname (string) - mirror name

Add source package mirror entry to database. This is a representation of Portage's "thirdpartymirrors".

Parameters:

• mirrorname (string) - name of the mirror from which "mirrorlist" belongs
• mirrorlist (list) - list of URLs belonging to the given mirror name

Add package category string to repository. Return its identifier (idcategory).

Parameters:

• category (string) - name of the category to add

Returns: int

category identifier (idcategory)

Add a single, generic CONFIG_PROTECT (not defined as _MASK/whatever here) path. Return its identifier (idprotect).

Parameters:

• protect (string) - CONFIG_PROTECT path to add

Returns: int

protect identifier (idprotect)

Add source code package download path to repository. Return its identifier (idsource).

Parameters:

• source (string) - source package download path

Returns: int

source identifier (idprotect)

Add dependency string to repository. Return its identifier (iddependency).

Parameters:

• dependency (string) - dependency string

Returns: int

dependency identifier (iddependency)

Add package SPM keyword string to repository. Return its identifier (idkeyword).

Parameters:

• keyword (string) - keyword string

Returns: int

keyword identifier (idkeyword)

Add package USE flag string to repository. Return its identifier (iduseflag).

Parameters:

• useflag (string) - useflag string

Returns: int

useflag identifier (iduseflag)

Add package SPM Eclass string to repository. Return its identifier (ideclass).

Parameters:

• eclass (string) - eclass string

Returns: int

eclass identifier (ideclass)

Add package libraries' ELF object NEEDED string to repository. Return its identifier (idneeded).

Parameters:

• needed (string) - NEEDED string (as shown in `readelf -d elf.so`)

Returns: int

needed identifier (idneeded)

Add package license name string to repository. Return its identifier (idlicense).

Parameters:

• pkglicense (string) - license name string

Returns: int

license name identifier (idlicense)

Add package Compiler flags used to repository. Return its identifier (idflags).

Parameters:

• chost (string) - CHOST string
• cflags (string) - CFLAGS string
• cxxflags (string) - CXXFLAGS string

Returns: int

Compiler flags triple identifier (idflags)

Mark a package as system package, which means that entropy.client will deny its removal.

Parameters:

• idpackage (int) - package identifier
• do_commit (bool) - determine whether executing commit or not

Mark package as injected, injection is usually set for packages manually added to repository. Injected packages are not removed automatically even when featuring conflicting scope with other that are being added. If a package is injected, it means that maintainers have to handle it manually.

Parameters:

• idpackage (int) - package indentifier
• do_commit (bool) - determine whether executing commit or not

Update the creation date for package. Creation date is stored in string based unix time format.

Parameters:

• idpackage (int) - package indentifier
• date (string) - unix time in string form

Set package file md5sum for package. This information is used by entropy.client when downloading packages.

Parameters:

• idpackage (int) - package indentifier
• digest (string) - md5 hash for package file

Set package file extra hashes (sha1, sha256, sha512) for package.

Parameters:

• idpackage (int) - package indentifier
• sha1 (string) - SHA1 hash for package file
• sha256 (string) - SHA256 hash for package file
• sha512 (string) - SHA512 hash for package file

Set download URL prefix for package.

Parameters:

• idpackage (int) - package indentifier
• url (string) - URL prefix to set

Set category name for package.

Parameters:

• idpackage (int) - package indentifier
• category (string) - category to set

Set description for given category name.

Parameters:

• category (string) - category name
• description_data (dict) - category description for several locales. {'en': "This is blah", 'it': "Questo e' blah", ... }

Set name for package.

Parameters:

• idpackage (int) - package indentifier
• name (string) - package name

Set dependency string for iddependency (dependency identifier).

Parameters:

• iddependency (int) - dependency string identifier
• dependency (string) - dependency string

Set atom string for package. "Atom" is the full, unique name of a package.

Parameters:

• idpackage (int) - package indentifier
• atom (string) - atom string

Set slot string for package. Please refer to Portage SLOT documentation for more info.

Parameters:

• idpackage (int) - package indentifier
• slot (string) - slot string

Remove license text for given license name identifier.

Parameters:

• license_name (string) - available license name identifier

Remove all the dependencies of package.

Parameters:

• idpackage (int) - package indentifier

Insert dependencies for package. "depdata" is a dict() with dependency strings as keys and dependency type as values.

Parameters:

• idpackage (int) - package indentifier
• depdata (dict) - dependency dictionary {'app-foo/foo': dep_type_integer, ...}

Insert manually added dependencies to dep. list of package.

Parameters:

• idpackage (int) - package indentifier
• manual_deps (list) - list of dependency strings

Remove content metadata for package.

Parameters:

• idpackage (int) - package indentifier

Insert content metadata for package. "content" can either be a dict() or a list of triples (tuples of length 3, (idpackage, path, type,)).

Parameters:

• idpackage (int) - package indentifier
• content (dict, list) - content metadata to insert. {'/path/to/foo': 'obj(content type)',} or [(idpackage, path, type,) ...]
• already_formatted (bool) - if True, "content" is expected to be already formatted for insertion, this means that "content" must be a list of tuples of length 3.

Insert paths where given ELF obj (library) name can be located. "library" is an ELF object name.

Parameters:

• library (string) - library name
• paths (list) - list of paths (list of strings)

Insert configuration files automerge information for package. "automerge_data" contains configuration files paths and their belonging md5 hash. This features allows entropy.client to "auto-merge" or "auto-remove" configuration files never touched by user.

Parameters:

• idpackage (int) - package indentifier
• automerge_data (list) - list of tuples of length 2. [('/path/to/conf/file', 'md5_checksum_string',) ... ]

Remove configuration files automerge information for package. "automerge_data" contains configuration files paths and their belonging md5 hash. This features allows entropy.client to "auto-merge" or "auto-remove" configuration files never touched by user.

Parameters:

• idpackage (int) - package indentifier

Remove extra package file hashes (SHA1, SHA256, SHA512) for package.
Entropy package files metadata contains up to 4 hashes:
    md5, sha1, sha256, sha512
While md5 is here for historical reasons (being the first supported)
sha1, sha256, sha512 have been added recently and located into a
separate database table called "packagesignatures". Such hashes
can be not available for older packages, so don't be scared, aliens
are not to blame.

@param idpackage: package indentifier
@type idpackage: int

Remove Source Package Manager phases for package. Entropy can call several Source Package Manager (the PM which Entropy relies on) package installation/removal phases. Such phase names are listed here.

Parameters:

• idpackage (int) - package indentifier

Insert package changelog for package (in this case using category + name as key).

Parameters:

• category (string) - package category
• name (string) - package name
• changelog_txt (string) - changelog text

Remove ChangeLog for package (in this case using category + name as key)

Parameters:

• category (string) - package category
• name (string) - package name

insert license data (license names and text) into repository.

Parameters:

• licenses_data (dict) - dictionary containing license names as keys and text as values

Insert CONFIG_PROTECT (configuration files protection) entry identifier for package. This entry is usually a space separated string of directory and files which are used to handle user-protected configuration files or directories, those that are going to be stashed in separate paths waiting for user merge decisions.

Parameters:

• idpackage (int) - package indentifier
• idprotect (int) - configuration files protection identifier
• mask (bool) - if True, idproctect will be considered a "mask" entry, meaning that configuration files starting with paths referenced by idprotect will be forcefully merged.

Insert list of "mirror name" and "mirror list" into repository. The term "mirror" in this case references to Source Package Manager package download mirrors. Argument format is like this for historical reasons and may change in future.

Parameters:

• mirrors (list) - list of tuples of length 2 containing string as first item and list as second. [('openoffice', ['http://openoffice1', 'http://..."],), ...]

Insert keywords for package. Keywords are strings contained in package metadata stating what architectures or subarchitectures are supported by package. It is historically used also for masking packages (making them not available).

Parameters:

• idpackage (int) - package indentifier
• keywords (list) - list of keywords

Insert Source Package Manager USE (components build) flags for package.

Parameters:

• idpackage (int) - package indentifier
• useflags (list) - list of use flags strings

Insert package file extra hashes (sha1, sha256, sha512) for package.

Parameters:

• idpackage (int) - package indentifier
• sha1 (string) - SHA1 hash for package file
• sha256 (string) - SHA256 hash for package file
• sha512 (string) - SHA512 hash for package file

Insert Source Package Manager phases for package. Entropy can call several Source Package Manager (the PM which Entropy relies on) package installation/removal phases. Such phase names are listed here.

Parameters:

• idpackage (int) - package indentifier
• phases (list) - list of available Source Package Manager phases

Insert source code package download URLs for idpackage.

Parameters:

• idpackage (int) - package indentifier
• sources (list) - list of source URLs

Insert dependency conflicts for package.

Parameters:

• idpackage (int) - package indentifier
• conflicts (list) - list of dep. conflicts

Insert user messages for package.

Parameters:

• idpackage (int) - package indentifier
• messages (list) - list of messages

docstring_title

Parameters:

• idpackage (int) - package indentifier
• provides ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• neededs ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• eclasses ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• mysize ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• trigger ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• counter ()
• branch ()
• injected ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• counter ()
• branch ()

docstring_title

Parameters:

• counter ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• counter ()
• branch ()

docstring_title

Parameters:

• idpackage (int) - package indentifier
• dbconn ()
• dbconn_idpackage ()

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

docstring_title

Parameters:

• category ()

docstring_title

Parameters:

• atom ()
• branch ()

docstring_title

Parameters:

• category ()

docstring_title

Parameters:

• idpackage (int) - package indentifier

docstring_title

Parameters:

• idpackage (int) - package indentifier
• content ()

docstring_title

Parameters:

• item ()

docstring_title

Parameters:

• item ()

docstring_title

Parameters:

• item ()

docstring_title

Parameters:

• item ()