#define ZYPP_ZCONFIG_H
#include <iosfwd>
+#include <set>
+#include <string>
-#include "zypp/base/Deprecated.h"
-
+#include "zypp/APIConfig.h"
#include "zypp/base/NonCopyable.h"
#include "zypp/base/PtrTypes.h"
#include "zypp/Arch.h"
#include "zypp/Locale.h"
#include "zypp/Pathname.h"
+#include "zypp/IdString.h"
+#include "zypp/TriBool.h"
+#include "zypp/ResolverFocus.h"
+#include "zypp/DownloadMode.h"
+#include "zypp/target/rpm/RpmFlags.h"
///////////////////////////////////////////////////////////////////
namespace zypp
//
/** 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.
+ * to retrieve some value like architecture, languages or temppath.
*
* 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()
+ *
+ * \ingroup ZyppConfig
* \ingroup Singleton
*/
class ZConfig : private base::NonCopyable
{
public:
+
/** Singleton ctor */
static ZConfig & instance();
+ /** Print some detail about the current libzypp version.*/
+ std::ostream & about( std::ostream & str ) const;
+
+ public:
+
+ /** The target root directory.
+ * Returns an empty path if no target is set.
+ */
+ Pathname systemRoot() const;
+
+ /** The RepoManager root directory.
+ * Returns the same as \ref systemRoot() if not explicitly set.
+ */
+ Pathname repoManagerRoot() const;
+
+ /** Sets the RepoManager root directory.
+ * \sa repoManagerRoot()
+ */
+ void setRepoManagerRoot ( const Pathname &root );
+
public:
/** The autodetected system architecture. */
/** Override the zypp system architecture.
* This is useful for test scenarious. <b>But be warned</b>, zypp does
* not expect the system architecture to change at runtime. So
- * set it at the verry beginning before you acess any other
+ * set it at the very beginning before you access any other
* zypp component.
*/
void setSystemArchitecture( const Arch & arch_r );
{ setSystemArchitecture( defaultSystemArchitecture() ); }
public:
- /** The autodetected prefered locale for translated texts.
+ /** The autodetected preferred locale for translated texts.
*/
static Locale defaultTextLocale();
*/
Locale textLocale() const;
- /** Set the prefered locale for translated texts. */
+ /** Set the preferred locale for translated texts. */
void setTextLocale( const Locale & locale_r );
/** Reset the locale for translated texts to the default. */
{ setTextLocale( defaultTextLocale() ); }
public:
- /**
- * Path where the repo metadata is downloaded and kept.
+ /** \name Maintain user data
+ * \see \ref zypp-userdata
+ */
+ //@{
+ /** Whether a (non empty) user data sting is defined. */
+ bool hasUserData() const;
+
+ /** User defined string value to be passed to log, history, plugins... */
+ std::string userData() const;
+
+ /** Set a new \ref userData string.
+ * \returns \c TRUE if the string was accepted; \c FALSE if the
+ * string was rejected due to nonprintable characters or newlines.
+ */
+ bool setUserData( const std::string & str_r );
+ //@}
+
+ public:
+ /**
+ * Path where the caches are kept (/var/cache/zypp)
+ * \ingroup g_ZC_REPOCACHE
+ */
+ Pathname repoCachePath() const;
+
+ /**
+ * Set a new \a path as the default repo cache path
+ */
+ void setRepoCachePath ( const Pathname &path_r );
+
+ /**
+ * Path where the pubkey caches
*/
+ Pathname pubkeyCachePath() const;
+
+ /**
+ * Path where the repo metadata is downloaded and kept (repoCachePath()/raw).
+ * \ingroup g_ZC_REPOCACHE
+ */
Pathname repoMetadataPath() const;
+
+ /**
+ * Set a new \a path as the default repo cache path
+ */
+ void setRepoMetadataPath ( const Pathname &path_r );
+
+ /**
+ * Path where the repo solv files are created and kept (repoCachePath()/solv).
+ * \ingroup g_ZC_REPOCACHE
+ */
+ Pathname repoSolvfilesPath() const;
+
/**
- * Path where the repo packages are downloaded and kept.
+ * Set a new \a path as the default repo cache path
*/
+ void setRepoSolvfilesPath ( const Pathname &path_r );
+
+ /**
+ * Path where the repo packages are downloaded and kept (repoCachePath()/packages).
+ * \ingroup g_ZC_REPOCACHE
+ */
Pathname repoPackagesPath() const;
/**
- * Path where the processed cache is kept
- * (this is where zypp.db is located.
+ * Set a new \a path as the default repo cache path
*/
- Pathname repoCachePath() const;
+ void setRepoPackagesPath ( const Pathname &path_r );
+
+ /**
+ * Path where the configfiles are kept (/etc/zypp).
+ * \ingroup g_ZC_CONFIGFILES
+ */
+ Pathname configPath() const;
/**
- * Path where the known repositories
- * .repo files are kept
+ * Path where the known repositories .repo files are kept (configPath()/repos.d).
+ * \ingroup g_ZC_CONFIGFILES
*/
Pathname knownReposPath() const;
/**
- * Separator string for storing/reading sets of strings to/from
- * metadata cache DB.
+ * Path where the known services .service files are kept (configPath()/services.d).
+ * \ingroup g_ZC_CONFIGFILES
+ */
+ Pathname knownServicesPath() const;
+
+ /**
+ * Path of the default needreboot config file (configPath()/needreboot).
+ * \ingroup g_ZC_CONFIGFILES
*/
- const std::string & cacheDBSplitJoinSeparator() const;
+ Pathname needrebootFile() const;
+
+ /**
+ * Path where the custom needreboot config files are kept (configPath()/needreboot.d).
+ * \ingroup g_ZC_CONFIGFILES
+ */
+ Pathname needrebootPath() const;
+
+ /**
+ * Path containing custom repo variable definitions (configPath()/vars.d).
+ * \see \ref zypp::repo::RepoVarExpand Repo variable expander
+ * \ingroup g_ZC_CONFIGFILES
+ */
+ Pathname varsPath() const;
/**
* Whether repository urls should be probed.
*/
unsigned repo_refresh_delay() const;
- /** Whether to consider using a patchrpm when downloading a package.
- * Config option <tt>download.use_patchrpm (true)</tt>
- */
- bool download_use_patchrpm() const;
+ /**
+ * List of locales for which translated package descriptions should be downloaded.
+ */
+ LocaleSet repoRefreshLocales() const;
+
+ /**
+ * Whether to use repository alias or name in user messages (progress,
+ * exceptions, ...).
+ * True: use alias, false: use name.
+ */
+ bool repoLabelIsAlias() const;
+
+ /**
+ * 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'
+ */
+ void repoLabelIsAlias( bool yesno_r );
+
+ /**
+ * Maximum number of concurrent connections for a single transfer
+ */
+ long download_max_concurrent_connections() const;
+
+ /**
+ * Minimum download speed (bytes per second)
+ * until the connection is dropped
+ */
+ long download_min_download_speed() const;
+
+ /**
+ * Maximum download speed (bytes per second)
+ */
+ long download_max_download_speed() const;
+
+ /**
+ * Maximum silent tries
+ */
+ long download_max_silent_tries() const;
+
+ /**
+ * Maximum time in seconds that you allow a transfer operation to take.
+ */
+ long download_transfer_timeout() const;
+
/** Whether to consider using a deltarpm when downloading a package.
* Config option <tt>download.use_deltarpm (true)</tt>
*/
bool download_use_deltarpm() const;
+ /** Whether to consider using a deltarpm even when rpm is local.
+ * This requires \ref download_use_deltarpm being \c true.
+ * Config option <tt>download.use_deltarpm.always (false)</tt>
+ */
+ bool download_use_deltarpm_always() const;
+
+ /**
+ * Hint which media to prefer when installing packages (download vs. CD).
+ * \see class \ref media::MediaPriority
+ */
+ bool download_media_prefer_download() const;
+ /** \overload */
+ bool download_media_prefer_volatile() const
+ { return ! download_media_prefer_download(); }
+ /**
+ * Set \ref download_media_prefer_download to a specific value.
+ */
+ void set_download_media_prefer_download( bool yesno_r );
+ /**
+ * Set \ref download_media_prefer_download to the configfiles default.
+ */
+ void set_default_download_media_prefer_download();
+
+ /** Path where media are preferably mounted or downloaded.
+ * Config option <tt>download.media_mountdir (/var/adm/mount)</tt>
+ * Needs to be a (writable) directory, otherwise /var/tmp is fallback.
+ */
+ Pathname download_mediaMountdir() const;
+ /** Set alternate value. */
+ void set_download_mediaMountdir( Pathname newval_r );
+ /** Reset to zypp.cong default. */
+ void set_default_download_mediaMountdir();
+
+ /**
+ * Commit download policy to use as default.
+ */
+ DownloadMode commit_downloadMode() const;
+
+ /** \name Signature checking (repodata and packages)
+ * If \ref gpgcheck is \c on (the default) we will either check the signature
+ * of repo metadata (packages are secured via checksum in the metadata), or the
+ * signature of an rpm package to install if it's repo metadata are not signed
+ * or not checked. If \ref gpgcheck is \c off, no checks are performed.
+ *
+ * The default behavior can be altered by explicitly setting \ref repo_gpgcheck and/or
+ * \ref pkg_gpgcheck to perform those checks always (\c on) or never (\c off).
+ *
+ * Explicitly setting \c gpgcheck, \c repo_gpgcheck or \c pkg_gpgcheck in a
+ * repositories \a .repo file will overwrite the defaults here.
+ */
+ //@{
+ bool gpgCheck() const; ///< Turn signature checking on/off (on)
+ TriBool repoGpgCheck() const; ///< Check repo matadata signatures (indeterminate - according to gpgcheck)
+ TriBool pkgGpgCheck() const; ///< Check rpm package signatures (indeterminate - according to gpgcheck)
+
+ void setGpgCheck( bool val_r ); ///< Change the value
+ void setRepoGpgCheck( TriBool val_r ); ///< Change the value
+ void setPkgGpgCheck( TriBool val_r ); ///< Change the value
+
+ void resetGpgCheck(); ///< Reset to the zconfig default
+ void resetRepoGpgCheck(); ///< Reset to the zconfig default
+ void resetPkgGpgCheck(); ///< Reset to the zconfig default
+ //@}
+ //
/**
- * Directory for equivalent vendor definitions
+ * Directory for equivalent vendor definitions (configPath()/vendors.d)
+ * \ingroup g_ZC_CONFIGFILES
*/
Pathname vendorPath() const;
/**
+ * The resolvers general attitude when resolving jobs.
+ */
+ ResolverFocus solver_focus() const;
+
+ /**
* Solver regards required packages,patterns,... only
- */
+ */
bool solver_onlyRequires() const;
+ /**
+ * File in which dependencies described which has to be
+ * fulfilled for a running system.
+ */
+ Pathname solver_checkSystemFile() const;
+
+ /**
+ * Directory, which may or may not contain files in which
+ * dependencies described which has to be fulfilled for a
+ * running system.
+ */
+ Pathname solver_checkSystemFileDir() const;
+
+ /**
+ * Whether vendor check is by default enabled.
+ */
+ bool solver_allowVendorChange() const;
+
+ /** DUP tune: Whether to allow version downgrades upon DUP. */
+ bool solver_dupAllowDowngrade() const;
+
+ /** DUP tune: Whether to follow package renames upon DUP. */
+ bool solver_dupAllowNameChange() const;
+
+ /** DUP tune: Whether to allow package arch changes upon DUP. */
+ bool solver_dupAllowArchChange() const;
+
+ /** DUP tune: Whether to allow package vendor changes upon DUP. */
+ bool solver_dupAllowVendorChange() const;
+
+ /**
+ * Whether removing a package should also remove no longer needed requirements.
+ */
+ bool solver_cleandepsOnRemove() const;
+
+ /**
+ * When committing a dist upgrade (e.g. <tt>zypper dup</tt>)
+ * 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 \c 0 to write no testcase at all.
+ */
+ unsigned solver_upgradeTestcasesToKeep() 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.
+ */
+ bool solverUpgradeRemoveDroppedPackages() const;
+ /** Set \ref solverUpgradeRemoveDroppedPackages to \a val_r. */
+ void setSolverUpgradeRemoveDroppedPackages( bool val_r );
+ /** Reset \ref solverUpgradeRemoveDroppedPackages to the \c zypp.conf default. */
+ void resetSolverUpgradeRemoveDroppedPackages();
+
+ /** \name Packages which can be installed in different versions at the same time.
+ *
+ * This returns the config file values (\c names or \c provides:...). The
+ * corresponding packages have the \c multiversionInstall property set. Those
+ * packages will be installed using 'rpm -i', so they will not implicitly obsolete
+ * other installed versions.
+ *
+ * \see \ref sat::SolvableType
+ */
+ //@{
+ 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 );
+ //@}
+
+ /**
+ * Path where zypp can find or create lock file (configPath()/locks)
+ * \ingroup g_ZC_CONFIGFILES
+ */
+ Pathname locksFile() const;
+
+ /**
+ * Whether locks file should be read and applied after start (true)
+ */
+ bool apply_locks_file() const;
+
+ /**
+ * Path where the update items are kept (/var/adm)
+ */
+ Pathname update_dataPath() const;
+
+ /**
+ * Path where the repo metadata is downloaded and kept (update_dataPath()/).
+ * \ingroup g_ZC_REPOCACHE
+ */
+ Pathname update_scriptsPath() const;
+
+ /**
+ * Path where the repo solv files are created and kept (update_dataPath()/solv).
+ * \ingroup g_ZC_REPOCACHE
+ */
+ Pathname update_messagesPath() const;
+
+ /** \name Command to be invoked to send update messages. */
+ //@{
+ /** Command definition for sending update messages.*/
+ std::string updateMessagesNotify() const;
+ /** Set a new command definition (see update.messages.notify in zypp.conf). */
+ void setUpdateMessagesNotify( const std::string & val_r );
+ /** Reset to the zypp.conf default. */
+ void resetUpdateMessagesNotify();
+ //@}
+
+ /** \name Options for package installation */
+ //@{
+ /** The default \ref target::rpm::RpmInstFlags for \ref ZYppCommitPolicy.
+ * Or-combination of \ref target::rpm::RpmInstFlag.
+ * \code
+ * ZConfig.instance().rpmInstallFlags().testFlag( target::rpm::RPMINST_EXCLUDEDOCS );
+ * \endcode
+ */
+ target::rpm::RpmInstFlags rpmInstallFlags() const;
+ //@}
+
+ /**
+ * Path where ZYpp install history is logged. Defaults to
+ * /var/log/zypp/history.
+ *
+ * \see http://en.opensuse.org/Libzypp/Package_History
+ */
+ Pathname historyLogFile() const;
+
+ /**
+ * Defaults to /etc/zypp/credentials.d
+ */
+ Pathname credentialsGlobalDir() const;
+
+ /**
+ * Defaults to /etc/zypp/credentials.cat
+ */
+ Pathname credentialsGlobalFile() 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 'system-release'. This value is not hardcoded in YUM and can be configured
+ * with the $distroverpkg variable.
+ *
+ * Defaults to 'system-release'.
+ */
+ std::string distroverpkg() const;
+
+ /** \name Plugins */
+ //@{
+ /**
+ * Defaults to \c /usr/lib/zypp/plugins
+ */
+ Pathname pluginsPath() const;
+
+ //@}
public:
class Impl;
/** Dtor */
~ZConfig();
- private:
+ private:
friend class Impl;
/** Default ctor. */
ZConfig();
projects / platform / upstream / libzypp.git / blobdiff