zypp/ZConfig.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9 /** \file       zypp/ZConfig.h
  10  *
  11 */
  12 #ifndef ZYPP_ZCONFIG_H
  13 #define ZYPP_ZCONFIG_H
  14
  15 #include <iosfwd>
  16 #include <set>
  17 #include <string>
  18
  19 #include "zypp/APIConfig.h"
  20 #include "zypp/base/NonCopyable.h"
  21 #include "zypp/base/PtrTypes.h"
  22
  23 #include "zypp/Arch.h"
  24 #include "zypp/Locale.h"
  25 #include "zypp/Pathname.h"
  26 #include "zypp/IdString.h"
  27 #include "zypp/TriBool.h"
  28
  29 #include "zypp/DownloadMode.h"
  30 #include "zypp/target/rpm/RpmFlags.h"
  31
  32 ///////////////////////////////////////////////////////////////////
  33 namespace zypp
  34 { /////////////////////////////////////////////////////////////////
  35
  36   ///////////////////////////////////////////////////////////////////
  37   //
  38   //    CLASS NAME : ZConfig
  39   //
  40   /** Interim helper class to collect global options and settings.
  41    * Use it to avoid hardcoded values and calls to getZYpp() just
  42    * to retrieve some value like architecture, languages or tmppath.
  43    *
  44    * It reads /etc/zypp/zypp.conf, the filename can be overridden by
  45    * setting the ZYPP_CONF environment variable to a different file.
  46    *
  47    * Note, if you add settings to this file, please follow the following
  48    * convention:
  49    *
  50    * namespace.settingname
  51    *
  52    * should become
  53    *
  54    * namespace_settingName()
  55    *
  56    * \ingroup ZyppConfig
  57    * \ingroup Singleton
  58   */
  59   class ZConfig : private base::NonCopyable
  60   {
  61     public:
  62
  63       /** Singleton ctor */
  64       static ZConfig & instance();
  65
  66       /** Print some detail about the current libzypp version.*/
  67       std::ostream & about( std::ostream & str ) const;
  68
  69     public:
  70
  71       /** The target root directory.
  72        * Returns an empty path if no target is set.
  73        */
  74       Pathname systemRoot() const;
  75
  76     public:
  77
  78       /** The autodetected system architecture. */
  79       static Arch defaultSystemArchitecture();
  80
  81       /** The system architecture zypp uses. */
  82       Arch systemArchitecture() const;
  83
  84       /** Override the zypp system architecture.
  85        * This is useful for test scenarious. <b>But be warned</b>, zypp does
  86        * not expect the system architecture to change at runtime. So
  87        * set it at the verry beginning before you acess any other
  88        * zypp component.
  89       */
  90       void setSystemArchitecture( const Arch & arch_r );
  91
  92       /** Reset the zypp system architecture to the default. */
  93       void resetSystemArchitecture()
  94       { setSystemArchitecture( defaultSystemArchitecture() ); }
  95
  96     public:
  97       /** The autodetected prefered locale for translated texts.
  98        */
  99       static Locale defaultTextLocale();
 100
 101       /** The locale for translated texts zypp uses.
 102        */
 103       Locale textLocale() const;
 104
 105       /** Set the prefered locale for translated texts. */
 106       void setTextLocale( const Locale & locale_r );
 107
 108       /** Reset the locale for translated texts to the default. */
 109       void resetTextLocale()
 110       { setTextLocale( defaultTextLocale() ); }
 111
 112     public:
 113       /** \name Maintain user data
 114        * \see \ref zypp-userdata
 115        */
 116       //@{
 117       /** Whether a (non empty) user data sting is defined. */
 118       bool hasUserData() const;
 119
 120       /** User defined string value to be passed to log, history, plugins... */
 121       std::string userData() const;
 122
 123       /** Set a new \ref userData string.
 124        * \returns \c TRUE if the string was accepted; \c FALSE if the
 125        * string was rejected due to nonprintable characters or newlines.
 126        */
 127       bool setUserData( const std::string & str_r );
 128       //@}
 129
 130     public:
 131       /**
 132        * Path where the caches are kept (/var/cache/zypp)
 133        * \ingroup g_ZC_REPOCACHE
 134        */
 135       Pathname repoCachePath() const;
 136
 137      /**
 138        * Path where the repo metadata is downloaded and kept (repoCachePath()/raw).
 139         * \ingroup g_ZC_REPOCACHE
 140       */
 141       Pathname repoMetadataPath() const;
 142
 143      /**
 144        * Path where the repo solv files are created and kept (repoCachePath()/solv).
 145         * \ingroup g_ZC_REPOCACHE
 146       */
 147       Pathname repoSolvfilesPath() const;
 148
 149       /**
 150        * Path where the repo packages are downloaded and kept (repoCachePath()/packages).
 151         * \ingroup g_ZC_REPOCACHE
 152       */
 153       Pathname repoPackagesPath() const;
 154
 155       /**
 156        * Path where the configfiles are kept (/etc/zypp).
 157        * \ingroup g_ZC_CONFIGFILES
 158        */
 159       Pathname configPath() const;
 160
 161       /**
 162        * Path where the known repositories .repo files are kept (configPath()/repos.d).
 163        * \ingroup g_ZC_CONFIGFILES
 164        */
 165       Pathname knownReposPath() const;
 166
 167       /**
 168        * Path where the known services .service files are kept (configPath()/services.d).
 169        * \ingroup g_ZC_CONFIGFILES
 170        */
 171       Pathname knownServicesPath() const;
 172
 173       /**
 174        * Whether repository urls should be probed.
 175        / config option
 176        * repo.add.probe
 177        */
 178       bool repo_add_probe() const;
 179
 180       /**
 181        * Amount of time in minutes that must pass before another refresh.
 182        */
 183       unsigned repo_refresh_delay() const;
 184
 185       /**
 186        * List of locales for which translated package descriptions should be downloaded.
 187        */
 188       LocaleSet repoRefreshLocales() const;
 189
 190       /**
 191        * Whether to use repository alias or name in user messages (progress,
 192        * exceptions, ...).
 193        * True: use alias, false: use name.
 194        */
 195       bool repoLabelIsAlias() const;
 196
 197       /**
 198        * Whether to use repository alias or name in user messages (progress,
 199        * exceptions, ...). Console applications might prefer to use and display
 200        * the shorter alias instead of full repository name.
 201        *
 202        * Default: false; i.e. repo label is 'name'
 203        */
 204       void repoLabelIsAlias( bool yesno_r );
 205
 206       /**
 207        * Maximum number of concurrent connections for a single transfer
 208        */
 209       long download_max_concurrent_connections() const;
 210
 211       /**
 212        * Minimum download speed (bytes per second)
 213        * until the connection is dropped
 214        */
 215       long download_min_download_speed() const;
 216
 217       /**
 218        * Maximum download speed (bytes per second)
 219        */
 220       long download_max_download_speed() const;
 221
 222       /**
 223        * Maximum silent tries
 224        */
 225       long download_max_silent_tries() const;
 226
 227       /**
 228        * Maximum time in seconds that you allow a transfer operation to take.
 229        */
 230       long download_transfer_timeout() const;
 231
 232
 233       /** Whether to consider using a deltarpm when downloading a package.
 234        * Config option <tt>download.use_deltarpm (true)</tt>
 235        */
 236       bool download_use_deltarpm() const;
 237
 238       /** Whether to consider using a deltarpm even when rpm is local.
 239        * This requires \ref download_use_deltarpm being \c true.
 240        * Config option <tt>download.use_deltarpm.always (false)</tt>
 241        */
 242       bool download_use_deltarpm_always() const;
 243
 244       /**
 245        * Hint which media to prefer when installing packages (download vs. CD).
 246        * \see class \ref media::MediaPriority
 247        */
 248       bool download_media_prefer_download() const;
 249       /** \overload */
 250       bool download_media_prefer_volatile() const
 251       { return ! download_media_prefer_download(); }
 252       /**
 253        * Set \ref download_media_prefer_download to a specific value.
 254        */
 255       void set_download_media_prefer_download( bool yesno_r );
 256       /**
 257        * Set \ref download_media_prefer_download to the configfiles default.
 258        */
 259       void set_default_download_media_prefer_download();
 260
 261       /**
 262        * Commit download policy to use as default.
 263        */
 264       DownloadMode commit_downloadMode() const;
 265
 266       /** \name Signature checking (repodata and packages)
 267        * If \ref gpgcheck is \c on (the default) we will either check the signature
 268        * of repo metadata (packages are secured via checksum in the metadata), or the
 269        * signature of an rpm package to install if it's repo metadata are not signed
 270        * or not checked. If \ref gpgcheck is \c off, no checks are performed.
 271        *
 272        * The default behavior can be altered by explicitly setting \ref repo_gpgcheck and/or
 273        * \ref pkg_gpgcheck to perform those checks always (\c on) or never (\c off).
 274        *
 275        * Explicitly setting \c gpgcheck, \c repo_gpgcheck or \c pkg_gpgcheck in a
 276        * repositories \a .repo file will overwrite the defaults here.
 277        */
 278       //@{
 279       bool gpgCheck() const;                    ///< Turn signature checking on/off (on)
 280       TriBool repoGpgCheck() const;             ///< Check repo matadata signatures (indeterminate - according to gpgcheck)
 281       TriBool pkgGpgCheck() const;              ///< Check rpm package signatures (indeterminate - according to gpgcheck)
 282
 283       void setGpgCheck( bool val_r );           ///< Change the value
 284       void setRepoGpgCheck( TriBool val_r );    ///< Change the value
 285       void setPkgGpgCheck( TriBool val_r );     ///< Change the value
 286
 287       void resetGpgCheck();                     ///< Reset to the zconfig default
 288       void resetRepoGpgCheck();                 ///< Reset to the zconfig default
 289       void resetPkgGpgCheck();                  ///< Reset to the zconfig default
 290      //@}
 291       //
 292       /**
 293        * Directory for equivalent vendor definitions  (configPath()/vendors.d)
 294        * \ingroup g_ZC_CONFIGFILES
 295        */
 296       Pathname vendorPath() const;
 297
 298       /**
 299        * Solver regards required packages,patterns,... only
 300        */
 301       bool solver_onlyRequires() const;
 302
 303       /**
 304        * File in which dependencies described which has to be
 305        * fulfilled for a running system.
 306        */
 307       Pathname solver_checkSystemFile() const;
 308
 309       /**
 310        * Whether vendor check is by default enabled.
 311        */
 312       bool solver_allowVendorChange() const;
 313
 314       /**
 315        * Whether removing a package should also remove no longer needed requirements.
 316        */
 317       bool solver_cleandepsOnRemove() const;
 318
 319       /**
 320        * When committing a dist upgrade (e.g. <tt>zypper dup</tt>)
 321        * a solver testcase is written. It is needed in bugreports,
 322        * in case something went wrong. This returns the number of
 323        * testcases to keep on the system. Old cases will be deleted,
 324        * as new ones are created. Use \c 0 to write no testcase at all.
 325        */
 326       unsigned solver_upgradeTestcasesToKeep() const;
 327
 328       /** Whether dist upgrade should remove a products dropped packages (true).
 329        *
 330        * A new product may suggest a list of old and no longer supported
 331        * packages (dropped packages). Performing a dist upgrade the solver
 332        * may try to delete them, even if they do not cause any dependency
 333        * problem.
 334        *
 335        * Turning this option off, the solver will not try to remove those
 336        * packages unless they actually do cause dependency trouble. At any
 337        * time you may use zypper to detect orphaned packages, and do the
 338        * cleanup manually. Or simply leave them installed as long as you don't
 339        * need the disk space.
 340        */
 341       bool solverUpgradeRemoveDroppedPackages() const;
 342       /** Set \ref solverUpgradeRemoveDroppedPackages to \a val_r. */
 343       void setSolverUpgradeRemoveDroppedPackages( bool val_r );
 344       /** Reset \ref solverUpgradeRemoveDroppedPackages to the \c zypp.conf default. */
 345       void resetSolverUpgradeRemoveDroppedPackages();
 346
 347       /** \name Packages which can be installed in different versions at the same time.
 348        * This returns the config file values (\c names or \c provides:...). For the corresponding
 349        * packages use e.g \ref sat::Pool::multiversionBegin, or \ref sat::Solbale::multiversionInstall
 350        * (\ref ui::Selectable::multiversionInstall).
 351        */
 352       //@{
 353       const std::set<std::string> & multiversionSpec() const;
 354       void multiversionSpec( std::set<std::string> new_r );
 355       void clearMultiversionSpec();
 356       void addMultiversionSpec( const std::string & name_r );
 357       void removeMultiversionSpec( const std::string & name_r );
 358       //@}
 359
 360       /**
 361        * Path where zypp can find or create lock file (configPath()/locks)
 362        * \ingroup g_ZC_CONFIGFILES
 363        */
 364       Pathname locksFile() const;
 365
 366       /**
 367        * Whether locks file should be read and applied after start (true)
 368        */
 369       bool apply_locks_file() const;
 370
 371       /**
 372        * Path where the update items are kept (/var/adm)
 373        */
 374       Pathname update_dataPath() const;
 375
 376      /**
 377       * Path where the repo metadata is downloaded and kept (update_dataPath()/).
 378       * \ingroup g_ZC_REPOCACHE
 379       */
 380       Pathname update_scriptsPath() const;
 381
 382      /**
 383       * Path where the repo solv files are created and kept (update_dataPath()/solv).
 384       * \ingroup g_ZC_REPOCACHE
 385       */
 386       Pathname update_messagesPath() const;
 387
 388       /** \name Command to be invoked to send update messages. */
 389       //@{
 390       /** Command definition for sending update messages.*/
 391       std::string updateMessagesNotify() const;
 392       /** Set a new command definition (see update.messages.notify in zypp.conf). */
 393       void setUpdateMessagesNotify( const std::string & val_r );
 394       /** Reset to the zypp.conf default. */
 395       void resetUpdateMessagesNotify();
 396      //@}
 397
 398       /** \name Options for package installation */
 399       //@{
 400       /** The default \ref target::rpm::RpmInstFlags for \ref ZYppCommitPolicy.
 401        * Or-combination of \ref target::rpm::RpmInstFlag.
 402        * \code
 403        * ZConfig.instance().rpmInstallFlags().testFlag( target::rpm::RPMINST_EXCLUDEDOCS );
 404        * \endcode
 405        */
 406       target::rpm::RpmInstFlags rpmInstallFlags() const;
 407       //@}
 408
 409       /**
 410        * Path where ZYpp install history is logged. Defaults to
 411        * /var/log/zypp/history.
 412        *
 413        * \see http://en.opensuse.org/Libzypp/Package_History
 414        */
 415       Pathname historyLogFile() const;
 416
 417       /**
 418        * Defaults to /etc/zypp/credentials.d
 419        */
 420       Pathname credentialsGlobalDir() const;
 421
 422       /**
 423        * Defaults to /etc/zypp/credentials.cat
 424        */
 425       Pathname credentialsGlobalFile() const;
 426
 427       /** Package telling the "product version" on systems not using /etc/product.d/baseproduct.
 428        *
 429        * On RHEL, Fedora and others the "product version" is determined by the first package
 430        * providing 'redhat-release'. This value is not hardcoded in YUM and can be configured
 431        * with the $distroverpkg variable.
 432        *
 433        * Defaults to 'redhat-release'.
 434        */
 435       std::string distroverpkg() const;
 436
 437       /** \name Plugins */
 438       //@{
 439       /**
 440        * Defaults to \c /usr/lib/zypp/plugins
 441        */
 442       Pathname pluginsPath() const;
 443
 444       //@}
 445     public:
 446       class Impl;
 447       /** Dtor */
 448       ~ZConfig();
 449     private:
 450       friend class Impl;
 451       /** Default ctor. */
 452       ZConfig();
 453       /** Pointer to implementation */
 454       RW_pointer<Impl, rw_pointer::Scoped<Impl> > _pimpl;
 455   };
 456   ///////////////////////////////////////////////////////////////////
 457
 458   /////////////////////////////////////////////////////////////////
 459 } // namespace zypp
 460 ///////////////////////////////////////////////////////////////////
 461 #endif // ZYPP_ZCONFIG_H