zypp::ZConfig Class Reference

Interim helper class to collect global options and settings. More...

#include <ZConfig.h>

Inheritance diagram for zypp::ZConfig:

Classes
class	Impl
	ZConfig implementation. More...

Public Member Functions
std::ostream &	about (std::ostream &str) const
	Print some detail about the current libzypp version. More...
Pathname	systemRoot () const
	The target root directory. More...
Arch	systemArchitecture () const
	The system architecture zypp uses. More...
void	setSystemArchitecture (const Arch &arch_r)
	Override the zypp system architecture. More...
void	resetSystemArchitecture ()
	Reset the zypp system architecture to the default. More...
Locale	textLocale () const
	The locale for translated texts zypp uses. More...
void	setTextLocale (const Locale &locale_r)
	Set the prefered locale for translated texts. More...
void	resetTextLocale ()
	Reset the locale for translated texts to the default. More...
Pathname	repoCachePath () const
	Path where the caches are kept (/var/cache/zypp) More...
Pathname	repoMetadataPath () const
	Path where the repo metadata is downloaded and kept (repoCachePath()/raw). More...
Pathname	repoSolvfilesPath () const
	Path where the repo solv files are created and kept (repoCachePath()/solv). More...
Pathname	repoPackagesPath () const
	Path where the repo packages are downloaded and kept (repoCachePath()/packages). More...
Pathname	configPath () const
	Path where the configfiles are kept (/etc/zypp). More...
Pathname	knownReposPath () const
	Path where the known repositories .repo files are kept (configPath()/repos.d). More...
Pathname	knownServicesPath () const
	Path where the known services .service files are kept (configPath()/services.d). More...
bool	repo_add_probe () const
	Whether repository urls should be probed. More...
unsigned	repo_refresh_delay () const
	Amount of time in minutes that must pass before another refresh. More...
LocaleSet	repoRefreshLocales () const
	List of locales for which translated package descriptions should be downloaded. More...
bool	repoLabelIsAlias () const
	Whether to use repository alias or name in user messages (progress, exceptions, ...). More...
void	repoLabelIsAlias (bool yesno_r)
	Whether to use repository alias or name in user messages (progress, exceptions, ...). More...
long	download_max_concurrent_connections () const
	Maximum number of concurrent connections for a single transfer. More...
long	download_min_download_speed () const
	Minimum download speed (bytes per second) until the connection is dropped. More...
long	download_max_download_speed () const
	Maximum download speed (bytes per second) More...
long	download_max_silent_tries () const
	Maximum silent tries. More...
long	download_transfer_timeout () const
	Maximum time in seconds that you allow a transfer operation to take. More...
bool	download_use_deltarpm () const
	Whether to consider using a deltarpm when downloading a package. More...
bool	download_use_deltarpm_always () const
	Whether to consider using a deltarpm even when rpm is local. More...
bool	download_media_prefer_download () const
	Hint which media to prefer when installing packages (download vs. More...
bool	download_media_prefer_volatile () const
void	set_download_media_prefer_download (bool yesno_r)
	Set download_media_prefer_download to a specific value. More...
void	set_default_download_media_prefer_download ()
	Set download_media_prefer_download to the configfiles default. More...
DownloadMode	commit_downloadMode () const
	Commit download policy to use as default. More...
Pathname	vendorPath () const
	Directory for equivalent vendor definitions (configPath()/vendors.d) More...
bool	solver_onlyRequires () const
	Solver regards required packages,patterns,... More...
Pathname	solver_checkSystemFile () const
	File in which dependencies described which has to be fulfilled for a running system. More...
bool	solver_allowVendorChange () const
	Whether vendor check is by default enabled. More...
bool	solver_cleandepsOnRemove () const
	Whether removing a package should also remove no longer needed requirements. More...
unsigned	solver_upgradeTestcasesToKeep () const
	When committing a dist upgrade (e.g. More...
bool	solverUpgradeRemoveDroppedPackages () const
	Whether dist upgrade should remove a products dropped packages (true). More...
void	setSolverUpgradeRemoveDroppedPackages (bool val_r)
	Set solverUpgradeRemoveDroppedPackages to val_r. More...
void	resetSolverUpgradeRemoveDroppedPackages ()
	Reset solverUpgradeRemoveDroppedPackages to the zypp.conf default. More...
Pathname	locksFile () const
	Path where zypp can find or create lock file (configPath()/locks) More...
bool	apply_locks_file () const
	Whether locks file should be read and applied after start (true) More...
Pathname	update_dataPath () const
	Path where the update items are kept (/var/adm) More...
Pathname	update_scriptsPath () const
	Path where the repo metadata is downloaded and kept (update_dataPath()/). More...
Pathname	update_messagesPath () const
	Path where the repo solv files are created and kept (update_dataPath()/solv). More...
Pathname	historyLogFile () const
	Path where ZYpp install history is logged. More...
Pathname	credentialsGlobalDir () const
	Defaults to /etc/zypp/credentials.d. More...
Pathname	credentialsGlobalFile () const
	Defaults to /etc/zypp/credentials.cat. More...
std::string	distroverpkg () const
	Package telling the "product version" on systems not using /etc/product.d/baseproduct. More...
	~ZConfig ()
	Dtor. More...
Maintain user data
See Also User data as transaction id
bool	hasUserData () const
	Whether a (non empty) user data sting is defined. More...
std::string	userData () const
	User defined string value to be passed to log, history, plugins... More...
bool	setUserData (const std::string &str_r)
	Set a new userData string. More...
Packages which can be installed in different versions at the same time.
This returns the config file values (names or provides:...). For the corresponding packages use e.g sat::Pool::multiversionBegin, or sat::Solbale::multiversionInstall (ui::Selectable::multiversionInstall).
const std::set< std::string > &	multiversionSpec () const
void	multiversionSpec (std::set< std::string > new_r)
void	clearMultiversionSpec ()
void	addMultiversionSpec (const std::string &name_r)
void	removeMultiversionSpec (const std::string &name_r)
Command to be invoked to send update messages.
std::string	updateMessagesNotify () const
	Command definition for sending update messages. More...
void	setUpdateMessagesNotify (const std::string &val_r)
	Set a new command definition (see update.messages.notify in zypp.conf). More...
void	resetUpdateMessagesNotify ()
	Reset to the zypp.conf default. More...
Options for package installation
target::rpm::RpmInstFlags	rpmInstallFlags () const
	The default target::rpm::RpmInstFlags for ZYppCommitPolicy. More...
Plugins
Pathname	pluginsPath () const
	Defaults to /usr/lib/zypp/plugins. More...

Static Public Member Functions
static ZConfig &	instance ()
	Singleton ctor. More...
static Arch	defaultSystemArchitecture ()
	The autodetected system architecture. More...
static Locale	defaultTextLocale ()
	The autodetected prefered locale for translated texts. More...

Private Member Functions
	ZConfig ()
	Default ctor. More...

Private Attributes
RW_pointer< Impl, rw_pointer::Scoped< Impl > >	_pimpl
	Pointer to implementation. More...

Friends
class	Impl

Detailed Description

Interim helper class to collect global options and settings.

Use it to avoid hardcoded values and calls to getZYpp() just to retrieve some value like architecture, languages or tmppath.

It reads /etc/zypp/zypp.conf, the filename can be overridden by setting the ZYPP_CONF environment variable to a different file.

Note, if you add settings to this file, please follow the following convention:

namespace.settingname

should become

namespace_settingName()

Definition at line 58 of file ZConfig.h.

Constructor & Destructor Documentation

zypp::ZConfig::~ZConfig

(

)

Dtor.

Definition at line 677 of file ZConfig.cc.

zypp::ZConfig::ZConfig ( )

private

Default ctor.

Definition at line 666 of file ZConfig.cc.

Member Function Documentation

ZConfig & zypp::ZConfig::instance ( )

static

Singleton ctor.

Definition at line 655 of file ZConfig.cc.

std::ostream & zypp::ZConfig::about

(

std::ostream &

str

)

const

Print some detail about the current libzypp version.

Definition at line 961 of file ZConfig.cc.

Pathname zypp::ZConfig::systemRoot

(

)

const

The target root directory.

Returns an empty path if no target is set.

Definition at line 680 of file ZConfig.cc.

Arch zypp::ZConfig::defaultSystemArchitecture ( )

static

The autodetected system architecture.

Definition at line 692 of file ZConfig.cc.

Arch zypp::ZConfig::systemArchitecture

(

)

const

The system architecture zypp uses.

Definition at line 698 of file ZConfig.cc.

void zypp::ZConfig::setSystemArchitecture

(

const Arch &

arch_r

)

Override the zypp system architecture.

This is useful for test scenarious. But be warned, zypp does not expect the system architecture to change at runtime. So set it at the verry beginning before you acess any other zypp component.

Definition at line 701 of file ZConfig.cc.

void zypp::ZConfig::resetSystemArchitecture ( )

inline

Reset the zypp system architecture to the default.

Definition at line 92 of file ZConfig.h.

Locale zypp::ZConfig::defaultTextLocale ( )

static

The autodetected prefered locale for translated texts.

Definition at line 716 of file ZConfig.cc.

Locale zypp::ZConfig::textLocale

(

)

const

The locale for translated texts zypp uses.

Definition at line 722 of file ZConfig.cc.

void zypp::ZConfig::setTextLocale

(

const Locale &

locale_r

)

Set the prefered locale for translated texts.

Definition at line 725 of file ZConfig.cc.

void zypp::ZConfig::resetTextLocale ( )

inline

Reset the locale for translated texts to the default.

Definition at line 108 of file ZConfig.h.

bool zypp::ZConfig::hasUserData

(

)

const

Whether a (non empty) user data sting is defined.

Definition at line 740 of file ZConfig.cc.

std::string zypp::ZConfig::userData

(

)

const

User defined string value to be passed to log, history, plugins...

Definition at line 743 of file ZConfig.cc.

bool zypp::ZConfig::setUserData

(

const std::string &

str_r

)

Set a new userData string.

Returns

TRUE if the string was accepted; FALSE if the string was rejected due to nonprintable characters or newlines.

Definition at line 746 of file ZConfig.cc.

Pathname zypp::ZConfig::repoCachePath

(

)

const

Path where the caches are kept (/var/cache/zypp)

Definition at line 763 of file ZConfig.cc.

Pathname zypp::ZConfig::repoMetadataPath

(

)

const

Path where the repo metadata is downloaded and kept (repoCachePath()/raw).

Definition at line 769 of file ZConfig.cc.

Pathname zypp::ZConfig::repoSolvfilesPath

(

)

const

Path where the repo solv files are created and kept (repoCachePath()/solv).

Definition at line 775 of file ZConfig.cc.

Pathname zypp::ZConfig::repoPackagesPath

(

)

const

Path where the repo packages are downloaded and kept (repoCachePath()/packages).

Definition at line 781 of file ZConfig.cc.

Pathname zypp::ZConfig::configPath

(

)

const

Path where the configfiles are kept (/etc/zypp).

Definition at line 789 of file ZConfig.cc.

Pathname zypp::ZConfig::knownReposPath

(

)

const

Path where the known repositories .repo files are kept (configPath()/repos.d).

Definition at line 795 of file ZConfig.cc.

Pathname zypp::ZConfig::knownServicesPath

(

)

const

Path where the known services .service files are kept (configPath()/services.d).

Definition at line 801 of file ZConfig.cc.

bool zypp::ZConfig::repo_add_probe

(

)

const

Whether repository urls should be probed.

/ config option repo.add.probe

Definition at line 821 of file ZConfig.cc.

unsigned zypp::ZConfig::repo_refresh_delay

(

)

const

Amount of time in minutes that must pass before another refresh.

Definition at line 824 of file ZConfig.cc.

LocaleSet zypp::ZConfig::repoRefreshLocales

(

)

const

List of locales for which translated package descriptions should be downloaded.

Definition at line 827 of file ZConfig.cc.

bool zypp::ZConfig::repoLabelIsAlias

(

)

const

Whether to use repository alias or name in user messages (progress, exceptions, ...).

True: use alias, false: use name.

Definition at line 830 of file ZConfig.cc.

void zypp::ZConfig::repoLabelIsAlias

(

bool

yesno_r

)

Whether to use repository alias or name in user messages (progress, exceptions, ...).

Console applications might prefer to use and display the shorter alias instead of full repository name.

Default: false; i.e. repo label is 'name'

Definition at line 833 of file ZConfig.cc.

long zypp::ZConfig::download_max_concurrent_connections

(

)

const

Maximum number of concurrent connections for a single transfer.

Definition at line 851 of file ZConfig.cc.

long zypp::ZConfig::download_min_download_speed

(

)

const

Minimum download speed (bytes per second) until the connection is dropped.

Definition at line 854 of file ZConfig.cc.

long zypp::ZConfig::download_max_download_speed

(

)

const

Maximum download speed (bytes per second)

Definition at line 857 of file ZConfig.cc.

long zypp::ZConfig::download_max_silent_tries

(

)

const

Maximum silent tries.

Definition at line 860 of file ZConfig.cc.

long zypp::ZConfig::download_transfer_timeout

(

)

const

Maximum time in seconds that you allow a transfer operation to take.

Definition at line 863 of file ZConfig.cc.

bool zypp::ZConfig::download_use_deltarpm

(

)

const

Whether to consider using a deltarpm when downloading a package.

Config option download.use_deltarpm (true)

Definition at line 836 of file ZConfig.cc.

bool zypp::ZConfig::download_use_deltarpm_always

(

)

const

Whether to consider using a deltarpm even when rpm is local.

This requires download_use_deltarpm being true. Config option download.use_deltarpm.always (false)

Definition at line 839 of file ZConfig.cc.

bool zypp::ZConfig::download_media_prefer_download

(

)

const

Hint which media to prefer when installing packages (download vs.

CD).

See Also

class media::MediaPriority

Definition at line 842 of file ZConfig.cc.

bool zypp::ZConfig::download_media_prefer_volatile ( ) 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 249 of file ZConfig.h.

void zypp::ZConfig::set_download_media_prefer_download

(

bool

yesno_r

)

Set download_media_prefer_download to a specific value.

Definition at line 845 of file ZConfig.cc.

void zypp::ZConfig::set_default_download_media_prefer_download

(

)

Set download_media_prefer_download to the configfiles default.

Definition at line 848 of file ZConfig.cc.

DownloadMode zypp::ZConfig::commit_downloadMode

(

)

const

Commit download policy to use as default.

Definition at line 866 of file ZConfig.cc.

Pathname zypp::ZConfig::vendorPath

(

)

const

Directory for equivalent vendor definitions (configPath()/vendors.d)

Definition at line 807 of file ZConfig.cc.

bool zypp::ZConfig::solver_onlyRequires

(

)

const

Solver regards required packages,patterns,...

only

Definition at line 869 of file ZConfig.cc.

Pathname zypp::ZConfig::solver_checkSystemFile

(

)

const

File in which dependencies described which has to be fulfilled for a running system.

Definition at line 878 of file ZConfig.cc.

bool zypp::ZConfig::solver_allowVendorChange

(

)

const

Whether vendor check is by default enabled.

Definition at line 872 of file ZConfig.cc.

bool zypp::ZConfig::solver_cleandepsOnRemove

(

)

const

Whether removing a package should also remove no longer needed requirements.

Definition at line 875 of file ZConfig.cc.

unsigned zypp::ZConfig::solver_upgradeTestcasesToKeep

(

)

const

When committing a dist upgrade (e.g.

zypper dup) a solver testcase is written. It is needed in bugreports, in case something went wrong. This returns the number of testcases to keep on the system. Old cases will be deleted, as new ones are created. Use 0 to write no testcase at all.

Definition at line 882 of file ZConfig.cc.

bool zypp::ZConfig::solverUpgradeRemoveDroppedPackages

(

)

const

Whether dist upgrade should remove a products dropped packages (true).

A new product may suggest a list of old and no longer supported packages (dropped packages). Performing a dist upgrade the solver may try to delete them, even if they do not cause any dependency problem.

Turning this option off, the solver will not try to remove those packages unless they actually do cause dependency trouble. At any time you may use zypper to detect orphaned packages, and do the cleanup manually. Or simply leave them installed as long as you don't need the disk space.

Definition at line 885 of file ZConfig.cc.

void zypp::ZConfig::setSolverUpgradeRemoveDroppedPackages

(

bool

val_r

)

Set solverUpgradeRemoveDroppedPackages to val_r.

Definition at line 886 of file ZConfig.cc.

void zypp::ZConfig::resetSolverUpgradeRemoveDroppedPackages

(

)

Reset solverUpgradeRemoveDroppedPackages to the zypp.conf default.

Definition at line 887 of file ZConfig.cc.

const std::set< std::string > & zypp::ZConfig::multiversionSpec

(

)

const

Definition at line 889 of file ZConfig.cc.

void zypp::ZConfig::multiversionSpec

(

std::set< std::string >

new_r

)

Definition at line 890 of file ZConfig.cc.

void zypp::ZConfig::clearMultiversionSpec

(

)

Definition at line 891 of file ZConfig.cc.

void zypp::ZConfig::addMultiversionSpec

(

const std::string &

name_r

)

Definition at line 892 of file ZConfig.cc.

void zypp::ZConfig::removeMultiversionSpec

(

const std::string &

name_r

)

Definition at line 893 of file ZConfig.cc.

Pathname zypp::ZConfig::locksFile

(

)

const

Path where zypp can find or create lock file (configPath()/locks)

Definition at line 813 of file ZConfig.cc.

bool zypp::ZConfig::apply_locks_file

(

)

const

Whether locks file should be read and applied after start (true)

Definition at line 895 of file ZConfig.cc.

Pathname zypp::ZConfig::update_dataPath

(

)

const

Path where the update items are kept (/var/adm)

Definition at line 898 of file ZConfig.cc.

Pathname zypp::ZConfig::update_scriptsPath

(

)

const

Path where the repo metadata is downloaded and kept (update_dataPath()/).

Definition at line 910 of file ZConfig.cc.

Pathname zypp::ZConfig::update_messagesPath

(

)

const

Path where the repo solv files are created and kept (update_dataPath()/solv).

Definition at line 904 of file ZConfig.cc.

std::string zypp::ZConfig::updateMessagesNotify

(

)

const

Command definition for sending update messages.

Definition at line 916 of file ZConfig.cc.

void zypp::ZConfig::setUpdateMessagesNotify

(

const std::string &

val_r

)

Set a new command definition (see update.messages.notify in zypp.conf).

Definition at line 919 of file ZConfig.cc.

void zypp::ZConfig::resetUpdateMessagesNotify

(

)

Reset to the zypp.conf default.

Definition at line 922 of file ZConfig.cc.

target::rpm::RpmInstFlags zypp::ZConfig::rpmInstallFlags

(

)

const

The default target::rpm::RpmInstFlags for ZYppCommitPolicy.

Or-combination of target::rpm::RpmInstFlag.

* ZConfig.instance().rpmInstallFlags().testFlag( target::rpm::RPMINST_EXCLUDEDOCS );
* 

Definition at line 927 of file ZConfig.cc.

Pathname zypp::ZConfig::historyLogFile

(

)

const

Path where ZYpp install history is logged.

Defaults to /var/log/zypp/history.

See Also

http://en.opensuse.org/Libzypp/Package_History

Definition at line 931 of file ZConfig.cc.

Pathname zypp::ZConfig::credentialsGlobalDir

(

)

const

Defaults to /etc/zypp/credentials.d.

Definition at line 937 of file ZConfig.cc.

Pathname zypp::ZConfig::credentialsGlobalFile

(

)

const

Defaults to /etc/zypp/credentials.cat.

Definition at line 943 of file ZConfig.cc.

std::string zypp::ZConfig::distroverpkg

(

)

const

Package telling the "product version" on systems not using /etc/product.d/baseproduct.

On RHEL, Fedora and others the "product version" is determined by the first package providing 'redhat-release'. This value is not hardcoded in YUM and can be configured with the $distroverpkg variable.

Defaults to 'redhat-release'.

Definition at line 951 of file ZConfig.cc.

Pathname zypp::ZConfig::pluginsPath

(

)

const

Defaults to /usr/lib/zypp/plugins.

Definition at line 956 of file ZConfig.cc.

Friends And Related Function Documentation

friend class Impl

friend

Definition at line 423 of file ZConfig.h.

Member Data Documentation

RW_pointer<Impl, rw_pointer::Scoped<Impl> > zypp::ZConfig::_pimpl

private

Pointer to implementation.

Definition at line 427 of file ZConfig.h.

---

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

• zypp/ZConfig.h
• zypp/ZConfig.cc