libzypp  17.29.1
ZConfig.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
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 #include <zypp/ResolverFocus.h>
29 #include <zypp/DownloadMode.h>
31 
33 namespace zypp
34 {
35 
36  class RepoManager;
37 
39  //
40  // CLASS NAME : ZConfig
41  //
63  class ZConfig : private base::NonCopyable
64  {
65  public:
66 
68  static ZConfig & instance();
69 
71  std::ostream & about( std::ostream & str ) const;
72 
73  public:
74 
78  Pathname systemRoot() const;
79 
83  Pathname repoManagerRoot() const;
84 
88  void setRepoManagerRoot ( const Pathname &root );
89 
90  public:
91 
94 
96  Arch systemArchitecture() const;
97 
104  void setSystemArchitecture( const Arch & arch_r );
105 
109 
110  public:
113  static Locale defaultTextLocale();
114 
117  Locale textLocale() const;
118 
120  void setTextLocale( const Locale & locale_r );
121 
125 
126  public:
132  bool hasUserData() const;
133 
135  std::string userData() const;
136 
141  bool setUserData( const std::string & str_r );
143 
144  public:
149  Pathname repoCachePath() const;
150 
154  void setRepoCachePath ( const Pathname &path_r );
155 
159  Pathname pubkeyCachePath() const;
160 
165  Pathname repoMetadataPath() const;
166 
167 
171  void setRepoMetadataPath ( const Pathname &path_r );
172 
177  Pathname repoSolvfilesPath() const;
178 
182  void setRepoSolvfilesPath ( const Pathname &path_r );
183 
188  Pathname repoPackagesPath() const;
189 
190 
194  void setRepoPackagesPath ( const Pathname &path_r );
195 
200  Pathname configPath() const;
201 
206  Pathname knownReposPath() const;
207 
212  Pathname knownServicesPath() const;
213 
218  Pathname needrebootFile() const;
219 
224  Pathname needrebootPath() const;
225 
231  Pathname varsPath() const;
232 
238  bool repo_add_probe() const;
239 
243  unsigned repo_refresh_delay() const;
244 
249 
255  bool repoLabelIsAlias() const;
256 
264  void repoLabelIsAlias( bool yesno_r );
265 
270 
275  long download_min_download_speed() const;
276 
280  long download_max_download_speed() const;
281 
285  long download_max_silent_tries() const;
286 
290  long download_transfer_timeout() const;
291 
292 
296  bool download_use_deltarpm() const;
297 
302  bool download_use_deltarpm_always() const;
303 
308  bool download_media_prefer_download() const;
311  { return ! download_media_prefer_download(); }
315  void set_download_media_prefer_download( bool yesno_r );
320 
327  void set_download_mediaMountdir( Pathname newval_r );
330 
335 
349  bool gpgCheck() const;
350  TriBool repoGpgCheck() const;
351  TriBool pkgGpgCheck() const;
352 
353  void setGpgCheck( bool val_r );
354  void setRepoGpgCheck( TriBool val_r );
355  void setPkgGpgCheck( TriBool val_r );
356 
357  void resetGpgCheck();
358  void resetRepoGpgCheck();
359  void resetPkgGpgCheck();
361  //
366  Pathname vendorPath() const;
367 
371  ResolverFocus solver_focus() const;
372 
376  bool solver_onlyRequires() const;
377 
383 
390 
394  bool solver_allowVendorChange() const;
395 
397  bool solver_dupAllowDowngrade() const;
398 
400  bool solver_dupAllowNameChange() const;
401 
403  bool solver_dupAllowArchChange() const;
404 
406  bool solver_dupAllowVendorChange() const;
407 
411  bool solver_cleandepsOnRemove() const;
412 
420  unsigned solver_upgradeTestcasesToKeep() const;
421 
437  void setSolverUpgradeRemoveDroppedPackages( bool val_r );
440 
451  const std::set<std::string> & multiversionSpec() const;
452  void multiversionSpec( std::set<std::string> new_r );
453  void clearMultiversionSpec();
454  void addMultiversionSpec( const std::string & name_r );
455  void removeMultiversionSpec( const std::string & name_r );
457 
462  Pathname locksFile() const;
463 
467  bool apply_locks_file() const;
468 
472  Pathname update_dataPath() const;
473 
479 
485 
489  std::string updateMessagesNotify() const;
491  void setUpdateMessagesNotify( const std::string & val_r );
495 
504  target::rpm::RpmInstFlags rpmInstallFlags() const;
506 
513  Pathname historyLogFile() const;
514 
519 
524 
533  std::string distroverpkg() const;
534 
540  Pathname pluginsPath() const;
541 
545  std::string multiversionKernels() const;
546 
548 
549  public:
550  class Impl;
552  ~ZConfig();
553  private:
554  friend class RepoManager;
563 
564  private:
565  friend class Impl;
567  ZConfig();
570  };
572 
574 } // namespace zypp
576 #endif // ZYPP_ZCONFIG_H
Architecture.
Definition: Arch.h:37
'Language[_Country]' codes.
Definition: Locale.h:50
creates and provides information about known sources.
Definition: RepoManager.h:106
ZConfig implementation.
Definition: ZConfig.cc:315
Interim helper class to collect global options and settings.
Definition: ZConfig.h:64
bool hasUserData() const
Whether a (non empty) user data sting is defined.
Definition: ZConfig.cc:882
bool solver_cleandepsOnRemove() const
Whether removing a package should also remove no longer needed requirements.
Definition: ZConfig.cc:1090
std::string userData() const
User defined string value to be passed to log, history, plugins...
Definition: ZConfig.cc:885
Pathname knownServicesPath() const
Path where the known services .service files are kept (configPath()/services.d).
Definition: ZConfig.cc:980
void removeMultiversionSpec(const std::string &name_r)
Definition: ZConfig.cc:1120
Pathname repoPackagesPath() const
Path where the repo packages are downloaded and kept (repoCachePath()/packages).
Definition: ZConfig.cc:943
unsigned repo_refresh_delay() const
Amount of time in minutes that must pass before another refresh.
Definition: ZConfig.cc:1015
Arch systemArchitecture() const
The system architecture zypp uses.
Definition: ZConfig.cc:840
Locale textLocale() const
The locale for translated texts zypp uses.
Definition: ZConfig.cc:864
Pathname update_dataPath() const
Path where the update items are kept (/var/adm)
Definition: ZConfig.cc:1125
ResolverFocus solver_focus() const
The resolver's general attitude when resolving jobs.
Definition: ZConfig.cc:1077
Pathname update_messagesPath() const
Path where the repo solv files are created and kept (update_dataPath()/solv).
Definition: ZConfig.cc:1131
Pathname builtinRepoSolvfilesPath() const
The builtin config file value.
Definition: ZConfig.cc:960
Pathname pluginsPath() const
Defaults to /usr/lib/zypp/plugins.
Definition: ZConfig.cc:1181
Pathname repoManagerRoot() const
The RepoManager root directory.
Definition: ZConfig.cc:819
void resetSystemArchitecture()
Reset the zypp system architecture to the default.
Definition: ZConfig.h:107
void resetRepoGpgCheck()
Reset to the zconfig default.
Definition: ZConfig.cc:1074
bool gpgCheck() const
Turn signature checking on/off (on)
Definition: ZConfig.cc:1065
Pathname knownReposPath() const
Path where the known repositories .repo files are kept (configPath()/repos.d).
Definition: ZConfig.cc:974
Pathname update_scriptsPath() const
Path where the repo metadata is downloaded and kept (update_dataPath()/).
Definition: ZConfig.cc:1137
long download_transfer_timeout() const
Maximum time in seconds that you allow a transfer operation to take.
Definition: ZConfig.cc:1054
void setRepoManagerRoot(const Pathname &root)
Sets the RepoManager root directory.
Definition: ZConfig.cc:825
bool solver_dupAllowArchChange() const
DUP tune: Whether to allow package arch changes upon DUP.
Definition: ZConfig.cc:1087
void setTextLocale(const Locale &locale_r)
Set the preferred locale for translated texts.
Definition: ZConfig.cc:867
bool solverUpgradeRemoveDroppedPackages() const
Whether dist upgrade should remove a products dropped packages (true).
Definition: ZConfig.cc:1104
static Locale defaultTextLocale()
The autodetected preferred locale for translated texts.
Definition: ZConfig.cc:858
Pathname download_mediaMountdir() const
Path where media are preferably mounted or downloaded.
Definition: ZConfig.cc:1057
void resetSolverUpgradeRemoveDroppedPackages()
Reset solverUpgradeRemoveDroppedPackages to the zypp.conf default.
Definition: ZConfig.cc:1106
bool apply_locks_file() const
Whether locks file should be read and applied after start (true)
Definition: ZConfig.cc:1122
bool solver_allowVendorChange() const
Whether vendor check is by default enabled.
Definition: ZConfig.cc:1082
void set_default_download_mediaMountdir()
Reset to zypp.cong default.
Definition: ZConfig.cc:1059
Pathname repoCachePath() const
Path where the caches are kept (/var/cache/zypp)
Definition: ZConfig.cc:905
void setPkgGpgCheck(TriBool val_r)
Change the value.
Definition: ZConfig.cc:1071
Pathname needrebootPath() const
Path where the custom needreboot config files are kept (configPath()/needreboot.d).
Definition: ZConfig.cc:989
bool setUserData(const std::string &str_r)
Set a new userData string.
Definition: ZConfig.cc:888
Pathname systemRoot() const
The target root directory.
Definition: ZConfig.cc:815
long download_max_silent_tries() const
Maximum silent tries.
Definition: ZConfig.cc:1051
bool repo_add_probe() const
Whether repository urls should be probed.
Definition: ZConfig.cc:1012
target::rpm::RpmInstFlags rpmInstallFlags() const
The default target::rpm::RpmInstFlags for ZYppCommitPolicy.
Definition: ZConfig.cc:1154
void setUpdateMessagesNotify(const std::string &val_r)
Set a new command definition (see update.messages.notify in zypp.conf).
Definition: ZConfig.cc:1146
unsigned solver_upgradeTestcasesToKeep() const
When committing a dist upgrade (e.g.
Definition: ZConfig.cc:1101
Pathname repoMetadataPath() const
Path where the repo metadata is downloaded and kept (repoCachePath()/raw).
Definition: ZConfig.cc:921
Pathname vendorPath() const
Directory for equivalent vendor definitions (configPath()/vendors.d)
Definition: ZConfig.cc:998
long download_min_download_speed() const
Minimum download speed (bytes per second) until the connection is dropped.
Definition: ZConfig.cc:1045
DownloadMode commit_downloadMode() const
Commit download policy to use as default.
Definition: ZConfig.cc:1061
Pathname needrebootFile() const
Path of the default needreboot config file (configPath()/needreboot).
Definition: ZConfig.cc:986
void setGpgCheck(bool val_r)
Change the value.
Definition: ZConfig.cc:1069
bool solver_dupAllowVendorChange() const
DUP tune: Whether to allow package vendor changes upon DUP.
Definition: ZConfig.cc:1088
~ZConfig()
Dtor.
Definition: ZConfig.cc:812
Pathname locksFile() const
Path where zypp can find or create lock file (configPath()/locks)
Definition: ZConfig.cc:1004
RW_pointer< Impl, rw_pointer::Scoped< Impl > > _pimpl
Pointer to implementation.
Definition: ZConfig.h:569
Pathname repoSolvfilesPath() const
Path where the repo solv files are created and kept (repoCachePath()/solv).
Definition: ZConfig.cc:932
Pathname historyLogFile() const
Path where ZYpp install history is logged.
Definition: ZConfig.cc:1158
void setSystemArchitecture(const Arch &arch_r)
Override the zypp system architecture.
Definition: ZConfig.cc:843
TriBool pkgGpgCheck() const
Check rpm package signatures (indeterminate - according to gpgcheck)
Definition: ZConfig.cc:1067
static ZConfig & instance()
Singleton ctor.
Definition: Resolver.cc:126
void setRepoPackagesPath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:949
void setRepoSolvfilesPath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:938
void resetUpdateMessagesNotify()
Reset to the zypp.conf default.
Definition: ZConfig.cc:1149
std::ostream & about(std::ostream &str) const
Print some detail about the current libzypp version.
Definition: ZConfig.cc:1191
const std::set< std::string > & multiversionSpec() const
Definition: ZConfig.cc:1116
void set_download_mediaMountdir(Pathname newval_r)
Set alternate value.
Definition: ZConfig.cc:1058
bool download_use_deltarpm() const
Whether to consider using a deltarpm when downloading a package.
Definition: ZConfig.cc:1027
TriBool repoGpgCheck() const
Check repo matadata signatures (indeterminate - according to gpgcheck)
Definition: ZConfig.cc:1066
void set_download_media_prefer_download(bool yesno_r)
Set download_media_prefer_download to a specific value.
Definition: ZConfig.cc:1036
std::string updateMessagesNotify() const
Command definition for sending update messages.
Definition: ZConfig.cc:1143
void addMultiversionSpec(const std::string &name_r)
Definition: ZConfig.cc:1119
Pathname builtinRepoCachePath() const
The builtin config file value.
Definition: ZConfig.cc:954
Pathname builtinRepoPackagesPath() const
The builtin config file value.
Definition: ZConfig.cc:963
Pathname solver_checkSystemFile() const
File in which dependencies described which has to be fulfilled for a running system.
Definition: ZConfig.cc:1093
Pathname builtinRepoMetadataPath() const
The builtin config file value.
Definition: ZConfig.cc:957
void set_default_download_media_prefer_download()
Set download_media_prefer_download to the configfiles default.
Definition: ZConfig.cc:1039
Pathname solver_checkSystemFileDir() const
Directory, which may or may not contain files in which dependencies described which has to be fulfill...
Definition: ZConfig.cc:1097
void resetGpgCheck()
Reset to the zconfig default.
Definition: ZConfig.cc:1073
void setSolverUpgradeRemoveDroppedPackages(bool val_r)
Set solverUpgradeRemoveDroppedPackages to val_r.
Definition: ZConfig.cc:1105
bool download_media_prefer_volatile() const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: ZConfig.h:310
void resetTextLocale()
Reset the locale for translated texts to the default.
Definition: ZConfig.h:123
Pathname configPath() const
Path where the configfiles are kept (/etc/zypp).
Definition: ZConfig.cc:968
static Arch defaultSystemArchitecture()
The autodetected system architecture.
Definition: ZConfig.cc:834
ZConfig()
Default ctor.
Definition: ZConfig.cc:801
Pathname pubkeyCachePath() const
Path where the pubkey caches.
Definition: ZConfig.cc:911
long download_max_concurrent_connections() const
Maximum number of concurrent connections for a single transfer.
Definition: ZConfig.cc:1042
void resetPkgGpgCheck()
Reset to the zconfig default.
Definition: ZConfig.cc:1075
bool solver_onlyRequires() const
Solver regards required packages,patterns,...
Definition: ZConfig.cc:1079
Pathname varsPath() const
Path containing custom repo variable definitions (configPath()/vars.d).
Definition: ZConfig.cc:992
bool solver_dupAllowNameChange() const
DUP tune: Whether to follow package renames upon DUP.
Definition: ZConfig.cc:1086
bool repoLabelIsAlias() const
Whether to use repository alias or name in user messages (progress, exceptions, .....
Definition: ZConfig.cc:1021
void clearMultiversionSpec()
Definition: ZConfig.cc:1118
LocaleSet repoRefreshLocales() const
List of locales for which translated package descriptions should be downloaded.
Definition: ZConfig.cc:1018
long download_max_download_speed() const
Maximum download speed (bytes per second)
Definition: ZConfig.cc:1048
void setRepoMetadataPath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:927
bool solver_dupAllowDowngrade() const
DUP tune: Whether to allow version downgrades upon DUP.
Definition: ZConfig.cc:1085
std::string multiversionKernels() const
Definition: ZConfig.cc:1184
std::string distroverpkg() const
Package telling the "product version" on systems not using /etc/product.d/baseproduct.
Definition: ZConfig.cc:1176
bool download_use_deltarpm_always() const
Whether to consider using a deltarpm even when rpm is local.
Definition: ZConfig.cc:1030
void setRepoCachePath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:916
void setRepoGpgCheck(TriBool val_r)
Change the value.
Definition: ZConfig.cc:1070
Pathname credentialsGlobalDir() const
Defaults to /etc/zypp/credentials.d.
Definition: ZConfig.cc:1164
bool download_media_prefer_download() const
Hint which media to prefer when installing packages (download vs.
Definition: ZConfig.cc:1033
Pathname credentialsGlobalFile() const
Defaults to /etc/zypp/credentials.cat.
Definition: ZConfig.cc:1169
boost::logic::tribool TriBool
3-state boolean logic (true, false and indeterminate).
Definition: String.h:30
String related utilities and Regular expression matching.
boost::noncopyable NonCopyable
Ensure derived classes cannot be copied.
Definition: NonCopyable.h:26
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:2
ResolverFocus
The resolver's general attitude.
Definition: ResolverFocus.h:22
std::unordered_set< Locale > LocaleSet
Definition: Locale.h:27
DownloadMode
Supported commit download policies.
Definition: DownloadMode.h:23
Wrapper for const correct access via Smart pointer types.
Definition: PtrTypes.h:286