libzypp  17.35.16
zypp::RepoManager Class Reference

creates and provides information about known sources. More...

#include <zypp/RepoManager.h>

Inheritance diagram for zypp::RepoManager:

Classes

struct  MatchServiceAlias
 Functor thats filter RepoInfo by service which it belongs to. More...
 

Public Types

using ServiceSet = std::set< ServiceInfo >
 ServiceInfo typedefs. More...
 
using ServiceConstIterator = ServiceSet::const_iterator
 
using ServiceSizeType = ServiceSet::size_type
 
using RepoSet = std::set< RepoInfo >
 RepoInfo typedefs. More...
 
using RepoConstIterator = RepoSet::const_iterator
 
using RepoSizeType = RepoSet::size_type
 
using RawMetadataRefreshPolicy = RepoManagerFlags::RawMetadataRefreshPolicy
 
using CacheBuildPolicy = RepoManagerFlags::CacheBuildPolicy
 
using RefreshServiceBit = RepoManagerFlags::RefreshServiceBit
 Flags for tuning RefreshService. More...
 
using RefreshServiceFlags = RepoManagerFlags::RefreshServiceFlags
 
using RefreshServiceOptions = RepoManagerFlags::RefreshServiceFlags
 Options tuning RefreshService. More...
 
using RefreshCheckStatus = RepoManagerFlags::RefreshCheckStatus
 

Public Member Functions

 Impl (zyppng::SyncContextRef &&ctx, RepoManagerOptions &&opt)
 
 Impl (const Impl &)=delete
 
 Impl (Impl &&)=delete
 
Imploperator= (const Impl &)=delete
 
Imploperator= (Impl &&)=delete
 
const zyppng::SyncRepoManagerngMgr () const
 
zyppng::SyncRepoManagerngMgr ()
 
 RepoManager (RepoManagerOptions options=RepoManagerOptions())
 
 ~RepoManager ()
 Dtor. More...
 
RepoStatus metadataStatus (const RepoInfo &info) const
 Status of local metadata. More...
 
RefreshCheckStatus checkIfToRefreshMetadata (const RepoInfo &info, const Url &url, RawMetadataRefreshPolicy policy=RefreshIfNeeded)
 Checks whether to refresh metadata for specified repository and url. More...
 
Pathname metadataPath (const RepoInfo &info) const
 Path where the metadata is downloaded and kept. More...
 
Pathname packagesPath (const RepoInfo &info) const
 Path where the rpm packages are downloaded and kept. More...
 
void refreshMetadata (const RepoInfo &info, RawMetadataRefreshPolicy policy=RefreshIfNeeded, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Refresh local raw cache. More...
 
void cleanMetadata (const RepoInfo &info, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Clean local metadata. More...
 
void cleanPackages (const RepoInfo &info, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Clean local package cache. More...
 
RepoStatus cacheStatus (const RepoInfo &info) const
 Status of metadata cache. More...
 
void buildCache (const RepoInfo &info, CacheBuildPolicy policy=BuildIfNeeded, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Refresh local cache. More...
 
void cleanCache (const RepoInfo &info, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 clean local cache More...
 
bool isCached (const RepoInfo &info) const
 Whether a repository exists in cache. More...
 
void loadFromCache (const RepoInfo &info, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Load resolvables into the pool. More...
 
void cleanCacheDirGarbage (const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Remove any subdirectories of cache directories which no longer belong to any of known repositories. More...
 
repo::RepoType probe (const Url &url, const Pathname &path) const
 Probe repo metadata type. More...
 
repo::RepoType probe (const Url &url) const
 
void addRepository (const RepoInfo &info, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Adds a repository to the list of known repositories. More...
 
void addRepositories (const Url &url, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Adds repositores from a repo file to the list of known repositories. More...
 
void removeRepository (const RepoInfo &info, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Remove the best matching repository from known repos list. More...
 
void modifyRepository (const std::string &alias, const RepoInfo &newinfo, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Modify repository attributes. More...
 
void modifyRepository (const RepoInfo &newinfo, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 
RepoInfo getRepositoryInfo (const std::string &alias, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Find a matching repository info. More...
 
RepoInfo getRepositoryInfo (const Url &url, const url::ViewOption &urlview=url::ViewOption::DEFAULTS, const ProgressData::ReceiverFnc &progressrcv=ProgressData::ReceiverFnc())
 Find repository info by URL. More...
 
repo::ServiceType probeService (const Url &url) const
 Probe the type or the service. More...
 
void addService (const std::string &alias, const Url &url)
 Adds a new service by its alias and URL. More...
 
void addService (const ServiceInfo &service)
 Adds new service. More...
 
void removeService (const std::string &alias)
 Removes service specified by its name. More...
 
void removeService (const ServiceInfo &service)
 
void refreshServices (const RefreshServiceOptions &options_r=RefreshServiceOptions())
 Refreshes all enabled services. More...
 
void refreshService (const std::string &alias, const RefreshServiceOptions &options_r=RefreshServiceOptions())
 Refresh specific service. More...
 
void refreshService (const ServiceInfo &service, const RefreshServiceOptions &options_r=RefreshServiceOptions())
 
void modifyService (const std::string &oldAlias, const ServiceInfo &service)
 Modifies service file (rewrites it with new values) and underlying repositories if needed. More...
 
void modifyService (const ServiceInfo &service)
 
void refreshGeoIp (const RepoInfo::url_set &urls)
 
template<typename OutputIterator >
void getRepositoriesInService (const std::string &alias, OutputIterator out) const
 fill to output iterator repositories in service name. More...
 
Known services.

The known services are read from RepoManagerOptions::knownServicesPath passed on the Ctor.

Which defaults to ZYpp global settings.

bool serviceEmpty () const
 Gets true if no service is in RepoManager (so no one in specified location) More...
 
ServiceSizeType serviceSize () const
 Gets count of service in RepoManager (in specified location) More...
 
ServiceConstIterator serviceBegin () const
 Iterator to first service in internal storage. More...
 
ServiceConstIterator serviceEnd () const
 Iterator to place behind last service in internal storage. More...
 
Iterable< ServiceConstIteratorservices () const
 Iterate the known services. More...
 
std::list< ServiceInfoknownServices () const
 List of known services. More...
 
ServiceInfo getService (const std::string &alias) const
 Finds ServiceInfo by alias or return ServiceInfo::noService. More...
 
bool hasService (const std::string &alias) const
 Return whether there is a known service for alias. More...
 

Static Public Attributes

static constexpr RawMetadataRefreshPolicy RefreshIfNeeded = RepoManagerFlags::RefreshIfNeeded
 
static constexpr RawMetadataRefreshPolicy RefreshForced = RepoManagerFlags::RefreshForced
 
static constexpr RawMetadataRefreshPolicy RefreshIfNeededIgnoreDelay = RepoManagerFlags::RefreshIfNeededIgnoreDelay
 
static constexpr CacheBuildPolicy BuildIfNeeded = CacheBuildPolicy::BuildIfNeeded
 
static constexpr CacheBuildPolicy BuildForced = CacheBuildPolicy::BuildForced
 
static constexpr RefreshServiceBit RefreshService_restoreStatus = RefreshServiceBit::RefreshService_restoreStatus
 
static constexpr RefreshServiceBit RefreshService_forceRefresh = RefreshServiceBit::RefreshService_forceRefresh
 
static constexpr RefreshCheckStatus REFRESH_NEEDED = RefreshCheckStatus::REFRESH_NEEDED
 refresh is needed More...
 
static constexpr RefreshCheckStatus REPO_UP_TO_DATE = RefreshCheckStatus::REPO_UP_TO_DATE
 repository not changed More...
 
static constexpr RefreshCheckStatus REPO_CHECK_DELAYED = RefreshCheckStatus::REPO_CHECK_DELAYED
 refresh is delayed due to settings More...
 

Private Member Functions

Implclone () const
 clone for RWCOW_pointer More...
 

Private Attributes

zyppng::SyncRepoManagerRef _ngMgr
 
RWCOW_pointer< Impl_pimpl
 Pointer to implementation. More...
 

Friends

ImplrwcowClone (const Impl *rhs)
 
std::ostream & operator<< (std::ostream &str, const RepoManager &obj)
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &str, const RepoManager &obj) ZYPP_API
 

Known repositories.

The known repositories are read from RepoManagerOptions::knownReposPath passed on the Ctor.

Which defaults to ZYpp global settings.

bool repoEmpty () const
 
RepoSizeType repoSize () const
 
RepoConstIterator repoBegin () const
 
RepoConstIterator repoEnd () const
 
Iterable< RepoConstIteratorrepos () const
 Iterate the known repositories. More...
 
std::list< RepoInfoknownRepositories () const
 List of known repositories. More...
 
RepoInfo getRepo (const std::string &alias) const
 Find RepoInfo by alias or return RepoInfo::noRepo. More...
 
RepoInfo getRepo (const RepoInfo &info_r) const
 
bool hasRepo (const std::string &alias) const
 Return whether there is a known repository for alias. More...
 
bool hasRepo (const RepoInfo &info_r) const
 
static std::string makeStupidAlias (const Url &url_r=Url())
 Some stupid string but suitable as alias for your url if nothing better is available. More...
 

Detailed Description

creates and provides information about known sources.

Definition at line 38 of file RepoManager.cc.

Member Typedef Documentation

◆ ServiceSet

ServiceInfo typedefs.

Definition at line 67 of file RepoManager.h.

◆ ServiceConstIterator

using zypp::RepoManager::ServiceConstIterator = ServiceSet::const_iterator

Definition at line 68 of file RepoManager.h.

◆ ServiceSizeType

using zypp::RepoManager::ServiceSizeType = ServiceSet::size_type

Definition at line 69 of file RepoManager.h.

◆ RepoSet

RepoInfo typedefs.

Definition at line 72 of file RepoManager.h.

◆ RepoConstIterator

using zypp::RepoManager::RepoConstIterator = RepoSet::const_iterator

Definition at line 73 of file RepoManager.h.

◆ RepoSizeType

using zypp::RepoManager::RepoSizeType = RepoSet::size_type

Definition at line 74 of file RepoManager.h.

◆ RawMetadataRefreshPolicy

◆ CacheBuildPolicy

◆ RefreshServiceBit

Flags for tuning RefreshService.

Definition at line 91 of file RepoManager.h.

◆ RefreshServiceFlags

using zypp::RepoManager::RefreshServiceFlags = RepoManagerFlags::RefreshServiceFlags

Definition at line 95 of file RepoManager.h.

◆ RefreshServiceOptions

using zypp::RepoManager::RefreshServiceOptions = RepoManagerFlags::RefreshServiceFlags

Options tuning RefreshService.

Definition at line 98 of file RepoManager.h.

◆ RefreshCheckStatus

Constructor & Destructor Documentation

◆ RepoManager()

zypp::RepoManager::RepoManager ( RepoManagerOptions  options = RepoManagerOptions())

Definition at line 239 of file repomanager.cc.

◆ ~RepoManager()

zypp::RepoManager::~RepoManager ( )

Dtor.

Definition at line 84 of file RepoManager.cc.

Member Function Documentation

◆ Impl() [1/3]

zypp::RepoManager::Impl ( zyppng::SyncContextRef &&  ctx,
RepoManagerOptions &&  opt 
)
inline

Definition at line 41 of file RepoManager.cc.

◆ Impl() [2/3]

zypp::RepoManager::Impl ( const Impl )
delete

◆ Impl() [3/3]

zypp::RepoManager::Impl ( Impl &&  )
delete

◆ operator=() [1/2]

Impl& zypp::RepoManager::operator= ( const Impl )
delete

◆ operator=() [2/2]

Impl& zypp::RepoManager::operator= ( Impl &&  )
delete

◆ ngMgr() [1/2]

const zyppng::SyncRepoManager& zypp::RepoManager::ngMgr ( ) const
inline

Definition at line 51 of file RepoManager.cc.

◆ ngMgr() [2/2]

zyppng::SyncRepoManager& zypp::RepoManager::ngMgr ( )
inline

Definition at line 55 of file RepoManager.cc.

◆ clone()

Impl* zypp::RepoManager::clone ( ) const
inlineprivate

clone for RWCOW_pointer

Definition at line 65 of file RepoManager.cc.

◆ repoEmpty()

bool zypp::RepoManager::repoEmpty ( ) const

Definition at line 87 of file RepoManager.cc.

◆ repoSize()

RepoManager::RepoSizeType zypp::RepoManager::repoSize ( ) const

Definition at line 90 of file RepoManager.cc.

◆ repoBegin()

RepoManager::RepoConstIterator zypp::RepoManager::repoBegin ( ) const

Definition at line 93 of file RepoManager.cc.

◆ repoEnd()

RepoManager::RepoConstIterator zypp::RepoManager::repoEnd ( ) const

Definition at line 96 of file RepoManager.cc.

◆ repos()

Iterable< RepoManager::RepoConstIterator > zypp::RepoManager::repos ( ) const
inline

Iterate the known repositories.

Definition at line 657 of file RepoManager.h.

◆ knownRepositories()

std::list<RepoInfo> zypp::RepoManager::knownRepositories ( ) const
inline

List of known repositories.

Definition at line 114 of file RepoManager.h.

◆ getRepo() [1/2]

RepoInfo zypp::RepoManager::getRepo ( const std::string &  alias) const

Find RepoInfo by alias or return RepoInfo::noRepo.

Definition at line 99 of file RepoManager.cc.

◆ getRepo() [2/2]

RepoInfo zypp::RepoManager::getRepo ( const RepoInfo info_r) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 120 of file RepoManager.h.

◆ hasRepo() [1/2]

bool zypp::RepoManager::hasRepo ( const std::string &  alias) const

Return whether there is a known repository for alias.

Definition at line 102 of file RepoManager.cc.

◆ hasRepo() [2/2]

bool zypp::RepoManager::hasRepo ( const RepoInfo info_r) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 126 of file RepoManager.h.

◆ makeStupidAlias()

std::string zypp::RepoManager::makeStupidAlias ( const Url url_r = Url())
static

Some stupid string but suitable as alias for your url if nothing better is available.

Something like "http-download.opensuse.org-83df67e5"

Definition at line 105 of file RepoManager.cc.

◆ metadataStatus()

RepoStatus zypp::RepoManager::metadataStatus ( const RepoInfo info) const

Status of local metadata.

Definition at line 125 of file RepoManager.cc.

◆ checkIfToRefreshMetadata()

RepoManager::RefreshCheckStatus zypp::RepoManager::checkIfToRefreshMetadata ( const RepoInfo info,
const Url url,
RawMetadataRefreshPolicy  policy = RefreshIfNeeded 
)

Checks whether to refresh metadata for specified repository and url.

The need for refresh is evaluated according to the following conditions, in that order:

  • the refresh policy (refresh may be forced)
  • the repo.refresh.delay ZConfig value compared to the difference between cached index file timestamp and actual time
  • the timestamp of cached repo index file compared to the remote index file timestamp.

This method checks the status against the specified url only. If more baseurls are defined for in the RepoInfo, each one must be check individually. Example:

RepoInfo info; // try urls one by one for ( RepoInfo::urls_const_iterator it = info.baseUrlsBegin(); it != info.baseUrlsEnd(); ++it ) { try { // check whether to refresh metadata // if the check fails for this url, it throws, so another url will be checked if (checkIfToRefreshMetadata(info, *it, policy)!=RepoInfo::REFRESH_NEEDED) return;

// do the actual refresh } catch (const Exception & e) { ZYPP_CAUGHT(e); ERR << *it << " doesn't look good. Trying another url." << endl; } } // for all urls

handle("No more URLs.");

Parameters
info
url
policy
Returns
state of repository
See also
RefreshCheckStatus
Exceptions
RepoUnknownTypeException
repo::RepoNoAliasExceptionif can't figure an alias
Exceptionon unknown error

Definition at line 128 of file RepoManager.cc.

◆ metadataPath()

Pathname zypp::RepoManager::metadataPath ( const RepoInfo info) const

Path where the metadata is downloaded and kept.

Given a repoinfo, tells where RepoManager will download and keep the raw metadata.

Parameters
infoRepository information
Exceptions
repo::RepoNoAliasExceptionif can't figure an alias

Definition at line 131 of file RepoManager.cc.

◆ packagesPath()

Pathname zypp::RepoManager::packagesPath ( const RepoInfo info) const

Path where the rpm packages are downloaded and kept.

Given a repoinfo, tells where RepoProvidePackage will download and keep the .rpm files.

Parameters
infoRepository information
Exceptions
repo::RepoNoAliasExceptionif can't figure an alias

Definition at line 134 of file RepoManager.cc.

◆ refreshMetadata()

void zypp::RepoManager::refreshMetadata ( const RepoInfo info,
RawMetadataRefreshPolicy  policy = RefreshIfNeeded,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Refresh local raw cache.

Will try to download the metadata

In case of falure the metadata remains as it was before.

Exceptions
repo::RepoNoUrlExceptionif no urls are available.
repo::RepoNoAliasExceptionif can't figure an alias
repo::RepoUnknownTypeExceptionif the metadata is unknown
repo::RepoNoPermissionExceptionif the user has no permission to update(write) the caches
repo::RepoExceptionif the repository is invalid (no valid metadata found at any of baseurls)

Definition at line 137 of file RepoManager.cc.

◆ cleanMetadata()

void zypp::RepoManager::cleanMetadata ( const RepoInfo info,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Clean local metadata.

Empty local metadata.

Exceptions
repo::RepoNoAliasExceptionif can't figure an alias
Exceptionon unknown error.

Definition at line 144 of file RepoManager.cc.

◆ cleanPackages()

void zypp::RepoManager::cleanPackages ( const RepoInfo info,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Clean local package cache.

Empty local directory with downloaded packages

Exceptions
repo::RepoNoAliasExceptionif can't figure an alias
Exceptionon unknown error.

Definition at line 147 of file RepoManager.cc.

◆ cacheStatus()

RepoStatus zypp::RepoManager::cacheStatus ( const RepoInfo info) const

Status of metadata cache.

Definition at line 150 of file RepoManager.cc.

◆ buildCache()

void zypp::RepoManager::buildCache ( const RepoInfo info,
CacheBuildPolicy  policy = BuildIfNeeded,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Refresh local cache.

Will try to build the cache from local metadata.

If the cache exists it will be overwriten.

Note
the local metadata must be valid.
Exceptions
repo::RepoNoAliasExceptionif can't figure an alias to look in cache
repo::RepoMetadataExceptionif the metadata is not enough to build a cache (empty, incorrect, or refresh needed)
repo::RepoNoPermissionExceptionif the user has no permission to update(write) the caches
repo::RepoUnknownTypeException
parser::ParseExceptionif parser encounters an error.
Exceptionon unknown error.

Definition at line 153 of file RepoManager.cc.

◆ cleanCache()

void zypp::RepoManager::cleanCache ( const RepoInfo info,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

clean local cache

Clean the cached version of the metadata

Note
the local metadata must be valid.
Exceptions
repo::RepoNoAliasExceptionif can't figure an alias to look in cache
cache::CacheRecordNotFoundExceptionif the cache could not be cleaned because of repository record not found.
Exceptionon unknown error.

Definition at line 160 of file RepoManager.cc.

◆ isCached()

bool zypp::RepoManager::isCached ( const RepoInfo info) const

Whether a repository exists in cache.

Parameters
RepoInfoto be checked.

Definition at line 163 of file RepoManager.cc.

◆ loadFromCache()

void zypp::RepoManager::loadFromCache ( const RepoInfo info,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Load resolvables into the pool.

Creating from cache requires that the repository is refreshed (metadata downloaded) and cached

Exceptions
repo::RepoNoAliasExceptionif can't figure an alias to look in cache
RepoNotCachedExceptionWhen the source is not cached.

Definition at line 166 of file RepoManager.cc.

◆ cleanCacheDirGarbage()

void zypp::RepoManager::cleanCacheDirGarbage ( const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc())

Remove any subdirectories of cache directories which no longer belong to any of known repositories.

These can be temporary directories left by interrupted refresh, or dirs left after changing .repo files outside of libzypp.

Definition at line 169 of file RepoManager.cc.

◆ probe() [1/2]

repo::RepoType zypp::RepoManager::probe ( const Url url,
const Pathname path 
) const

Probe repo metadata type.

The location to probe consists of the base url (you may think of it as a mountpoint) and the path to the repository on the mounted media (ususally / ).

Definition at line 172 of file RepoManager.cc.

◆ probe() [2/2]

repo::RepoType zypp::RepoManager::probe ( const Url url) const

Definition at line 175 of file RepoManager.cc.

◆ addRepository()

void zypp::RepoManager::addRepository ( const RepoInfo info,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Adds a repository to the list of known repositories.

Exceptions
repo::RepoAlreadyExistsExceptionIf the repo clash some unique attribute like alias
RepoUnknownTypeIf RepoManagerOptions::probe is true and repository type can't be determined.
RepoExceptionIf RepoManagerOptions::probe is true and access to the url fails.
ExceptionOn other errors.

Definition at line 178 of file RepoManager.cc.

◆ addRepositories()

void zypp::RepoManager::addRepositories ( const Url url,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Adds repositores from a repo file to the list of known repositories.

Parameters
urlUrl of the repo file. The URL is subject to repo variable expansion.
Exceptions
repo::RepoAlreadyExistsExceptionIf the repo clash some unique attribute like alias
MediaExceptionIf the access to the url fails
ParseExceptionIf the file parsing fails
RepoUnknownTypeIf repository type can't be determined
RepoExceptionON other repository related errors
ExceptionOn other errors.

Definition at line 192 of file RepoManager.cc.

◆ removeRepository()

void zypp::RepoManager::removeRepository ( const RepoInfo info,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Remove the best matching repository from known repos list.

Exceptions
RepoNotFoundExceptionIf no repo match

Definition at line 195 of file RepoManager.cc.

◆ modifyRepository() [1/2]

void zypp::RepoManager::modifyRepository ( const std::string &  alias,
const RepoInfo newinfo,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Modify repository attributes.

Exceptions
RepoAlreadyExistsExceptionif the alias specified in newinfo is already used by another repository
RepoNotFoundExceptionIf no repo match
ParseExceptionIf the file parsing fails
ExceptionOn other errors.

Definition at line 202 of file RepoManager.cc.

◆ modifyRepository() [2/2]

void zypp::RepoManager::modifyRepository ( const RepoInfo newinfo,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 408 of file RepoManager.h.

◆ getRepositoryInfo() [1/2]

RepoInfo zypp::RepoManager::getRepositoryInfo ( const std::string &  alias,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Find a matching repository info.

Note
if multiple repositories incorrectly share the same alias, the first one found will be returned.
Parameters
aliasRepository alias
progressrcvProgress reporting function
Returns
RepoInfo of the found repository
Exceptions
RepoNotFoundExceptionIf no repo match the alias
ParseExceptionIf the file parsing fails
ExceptionOn other errors.

Definition at line 213 of file RepoManager.cc.

◆ getRepositoryInfo() [2/2]

RepoInfo zypp::RepoManager::getRepositoryInfo ( const Url url,
const url::ViewOption urlview = url::ViewOption::DEFAULTS,
const ProgressData::ReceiverFnc progressrcv = ProgressData::ReceiverFnc() 
)

Find repository info by URL.

Parameters
urlURL to find.
urlviewurl::ViewOption to influence URL matching.
progressrcvProgress receiver function.
Returns
RepoInfo of the found repository.
Note
if multpile repositories incorrectly share the same URL, the first one found will be returned.
the string representation of the URLs are compared. The urlview can be used to influence which parts of the URL are to be compared.
Exceptions
RepoNotFoundExceptionIf no repo match
ParseExceptionIf the file parsing fails
ExceptionOn other errors.

Definition at line 216 of file RepoManager.cc.

◆ serviceEmpty()

bool zypp::RepoManager::serviceEmpty ( ) const

Gets true if no service is in RepoManager (so no one in specified location)

Returns
true if any ServiceInfo is in RepoManager

Definition at line 219 of file RepoManager.cc.

◆ serviceSize()

RepoManager::ServiceSizeType zypp::RepoManager::serviceSize ( ) const

Gets count of service in RepoManager (in specified location)

Returns
count of service

Definition at line 222 of file RepoManager.cc.

◆ serviceBegin()

RepoManager::ServiceConstIterator zypp::RepoManager::serviceBegin ( ) const

Iterator to first service in internal storage.

Note
Iterator is immutable, so you cannot change pointed ServiceInfo
Returns
Iterator to first service

Definition at line 225 of file RepoManager.cc.

◆ serviceEnd()

RepoManager::ServiceConstIterator zypp::RepoManager::serviceEnd ( ) const

Iterator to place behind last service in internal storage.

Returns
iterator to end

Definition at line 228 of file RepoManager.cc.

◆ services()

Iterable< RepoManager::ServiceConstIterator > zypp::RepoManager::services ( ) const
inline

Iterate the known services.

Definition at line 661 of file RepoManager.h.

◆ knownServices()

std::list<ServiceInfo> zypp::RepoManager::knownServices ( ) const
inline

List of known services.

Definition at line 490 of file RepoManager.h.

◆ getService()

ServiceInfo zypp::RepoManager::getService ( const std::string &  alias) const

Finds ServiceInfo by alias or return ServiceInfo::noService.

Parameters
aliasunique identifier of service
Returns
information about service

Definition at line 231 of file RepoManager.cc.

◆ hasService()

bool zypp::RepoManager::hasService ( const std::string &  alias) const

Return whether there is a known service for alias.

Definition at line 234 of file RepoManager.cc.

◆ probeService()

repo::ServiceType zypp::RepoManager::probeService ( const Url url) const

Probe the type or the service.

Definition at line 237 of file RepoManager.cc.

◆ addService() [1/2]

void zypp::RepoManager::addService ( const std::string &  alias,
const Url url 
)

Adds a new service by its alias and URL.

Parameters
aliasunique identifier of the service
urlurl to service
Exceptions
FIXMERepoAlreadyExistException and as reponame is service name

Definition at line 240 of file RepoManager.cc.

◆ addService() [2/2]

void zypp::RepoManager::addService ( const ServiceInfo service)

Adds new service.

Parameters
serviceservice info
Exceptions
FIXMERepoAlreadyExistException and as reponame is service name

Definition at line 243 of file RepoManager.cc.

◆ removeService() [1/2]

void zypp::RepoManager::removeService ( const std::string &  alias)

Removes service specified by its name.

Parameters
aliasunique indientifier of the service to remove
Exceptions
RepoExceptionif service is not found or file with ServiceInfo cannot be deleted
Exceptionif file contain more services and rewrite file failed

Definition at line 246 of file RepoManager.cc.

◆ removeService() [2/2]

void zypp::RepoManager::removeService ( const ServiceInfo service)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 249 of file RepoManager.cc.

◆ refreshServices()

void zypp::RepoManager::refreshServices ( const RefreshServiceOptions options_r = RefreshServiceOptions())

Refreshes all enabled services.

See also
refreshService(ServiceInfo)

Definition at line 252 of file RepoManager.cc.

◆ refreshService() [1/2]

void zypp::RepoManager::refreshService ( const std::string &  alias,
const RefreshServiceOptions options_r = RefreshServiceOptions() 
)

Refresh specific service.

Parameters
aliasunique indientifier of the service to refresh
Exceptions
RepoExceptionif service is not found.
MediaExceptionIf there's a problem downloading the repo index file.

Definition at line 255 of file RepoManager.cc.

◆ refreshService() [2/2]

void zypp::RepoManager::refreshService ( const ServiceInfo service,
const RefreshServiceOptions options_r = RefreshServiceOptions() 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 258 of file RepoManager.cc.

◆ modifyService() [1/2]

void zypp::RepoManager::modifyService ( const std::string &  oldAlias,
const ServiceInfo service 
)

Modifies service file (rewrites it with new values) and underlying repositories if needed.

Modifications of a service can lead to rewrite of all .repo files of contained repositories. Particularily, disabling a service (changing ServiceInfo::enabled() from true to false) will disable all contained repositories. Renaming of a service will modify the "service" key of all contained repositories.

Parameters
oldAliasOld alias of the service
serviceServiceInfo object containing new data
Exceptions
RepoExceptionif sservice with oldAlias is not known
Exceptionif have problems with files

Definition at line 261 of file RepoManager.cc.

◆ modifyService() [2/2]

void zypp::RepoManager::modifyService ( const ServiceInfo service)
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 579 of file RepoManager.h.

◆ refreshGeoIp()

void zypp::RepoManager::refreshGeoIp ( const RepoInfo::url_set urls)

Checks for any of the given urls if there is no geoip data available, caches the results in the metadata cache for 24hrs. The given urls need to be configured as valid geoIP targets ( usually download.opensuse.org )

Definition at line 264 of file RepoManager.cc.

◆ getRepositoriesInService()

template<typename OutputIterator >
void zypp::RepoManager::getRepositoriesInService ( const std::string &  alias,
OutputIterator  out 
) const
inline

fill to output iterator repositories in service name.

This output iterator can perform any action on with Repo or service Container, because it is sets and it isn't dynamic recreate.

Note
Don't use this function with RepoManager::removeRepository(), it will lead to segfaults due to invalidated internal iterators. FIXME can this be solved (using STL) so that this warning would not be needed?
Parameters
aliasservice alias
outoutput iterator which get all the repositories belonging to specified service

example how set priority for each RepoInfo in this service:

//functor
class ChangePriority
{
private:
int priority;
public:
ChangePriority(int prio) : priority(prio) {}
// missing rewrite priority back via RepoManager::modifyRepo
void doIt( RepoInfo info ) { info.setPriority(priority); }
}
//somewhere in code
ChangePriority changer(10);
boost::make_function_output_iterator(
bind(&ChangePriority::doIt, &changer, _1)));

Definition at line 637 of file RepoManager.h.

Friends And Related Function Documentation

◆ rwcowClone

Impl* rwcowClone ( const Impl rhs)
friend

◆ operator<< [1/2]

std::ostream& operator<< ( std::ostream &  str,
const RepoManager obj 
)
friend

Definition at line 269 of file RepoManager.cc.

◆ operator<<() [2/2]

std::ostream & operator<< ( std::ostream &  str,
const RepoManager obj 
)
related

Stream output

Definition at line 269 of file RepoManager.cc.

Member Data Documentation

◆ _ngMgr

zyppng::SyncRepoManagerRef zypp::RepoManager::_ngMgr
private

Definition at line 60 of file RepoManager.cc.

◆ RefreshIfNeeded

constexpr RawMetadataRefreshPolicy zypp::RepoManager::RefreshIfNeeded = RepoManagerFlags::RefreshIfNeeded
static

Definition at line 82 of file RepoManager.h.

◆ RefreshForced

constexpr RawMetadataRefreshPolicy zypp::RepoManager::RefreshForced = RepoManagerFlags::RefreshForced
static

Definition at line 83 of file RepoManager.h.

◆ RefreshIfNeededIgnoreDelay

constexpr RawMetadataRefreshPolicy zypp::RepoManager::RefreshIfNeededIgnoreDelay = RepoManagerFlags::RefreshIfNeededIgnoreDelay
static

Definition at line 84 of file RepoManager.h.

◆ BuildIfNeeded

constexpr CacheBuildPolicy zypp::RepoManager::BuildIfNeeded = CacheBuildPolicy::BuildIfNeeded
static

Definition at line 87 of file RepoManager.h.

◆ BuildForced

constexpr CacheBuildPolicy zypp::RepoManager::BuildForced = CacheBuildPolicy::BuildForced
static

Definition at line 88 of file RepoManager.h.

◆ RefreshService_restoreStatus

constexpr RefreshServiceBit zypp::RepoManager::RefreshService_restoreStatus = RefreshServiceBit::RefreshService_restoreStatus
static

Definition at line 92 of file RepoManager.h.

◆ RefreshService_forceRefresh

constexpr RefreshServiceBit zypp::RepoManager::RefreshService_forceRefresh = RefreshServiceBit::RefreshService_forceRefresh
static

Definition at line 93 of file RepoManager.h.

◆ REFRESH_NEEDED

constexpr RefreshCheckStatus zypp::RepoManager::REFRESH_NEEDED = RefreshCheckStatus::REFRESH_NEEDED
static

refresh is needed

Definition at line 141 of file RepoManager.h.

◆ REPO_UP_TO_DATE

constexpr RefreshCheckStatus zypp::RepoManager::REPO_UP_TO_DATE = RefreshCheckStatus::REPO_UP_TO_DATE
static

repository not changed

Definition at line 142 of file RepoManager.h.

◆ REPO_CHECK_DELAYED

constexpr RefreshCheckStatus zypp::RepoManager::REPO_CHECK_DELAYED = RefreshCheckStatus::REPO_CHECK_DELAYED
static

refresh is delayed due to settings

Definition at line 143 of file RepoManager.h.

◆ _pimpl

RWCOW_pointer<Impl> zypp::RepoManager::_pimpl
private

Pointer to implementation.

Definition at line 649 of file RepoManager.h.


The documentation for this class was generated from the following files: