libzypp 17.25.7
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>
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
33namespace zypp
34{
35
37 //
38 // CLASS NAME : ZConfig
39 //
59 class ZConfig : private base::NonCopyable
60 {
61 public:
62
64 static ZConfig & instance();
65
67 std::ostream & about( std::ostream & str ) const;
68
69 public:
70
74 Pathname systemRoot() const;
75
80
84 void setRepoManagerRoot ( const Pathname &root );
85
86 public:
87
90
93
100 void setSystemArchitecture( const Arch & arch_r );
101
105
106 public:
109 static Locale defaultTextLocale();
110
113 Locale textLocale() const;
114
116 void setTextLocale( const Locale & locale_r );
117
121
122 public:
128 bool hasUserData() const;
129
131 std::string userData() const;
132
137 bool setUserData( const std::string & str_r );
139
140 public:
145 Pathname repoCachePath() const;
146
150 void setRepoCachePath ( const Pathname &path_r );
151
156
162
163
167 void setRepoMetadataPath ( const Pathname &path_r );
168
174
178 void setRepoSolvfilesPath ( const Pathname &path_r );
179
185
189 void setRepoPackagesPath ( const Pathname &path_r );
190
195 Pathname configPath() const;
196
201 Pathname knownReposPath() const;
202
208
213 Pathname needrebootFile() const;
214
219 Pathname needrebootPath() const;
220
226 Pathname varsPath() const;
227
233 bool repo_add_probe() const;
234
238 unsigned repo_refresh_delay() const;
239
244
250 bool repoLabelIsAlias() const;
251
259 void repoLabelIsAlias( bool yesno_r );
260
265
270 long download_min_download_speed() const;
271
275 long download_max_download_speed() const;
276
280 long download_max_silent_tries() const;
281
285 long download_transfer_timeout() const;
286
287
291 bool download_use_deltarpm() const;
292
297 bool download_use_deltarpm_always() const;
298
306 { return ! download_media_prefer_download(); }
310 void set_download_media_prefer_download( bool yesno_r );
315
322 void set_download_mediaMountdir( Pathname newval_r );
325
330
344 bool gpgCheck() const;
345 TriBool repoGpgCheck() const;
346 TriBool pkgGpgCheck() const;
347
348 void setGpgCheck( bool val_r );
349 void setRepoGpgCheck( TriBool val_r );
350 void setPkgGpgCheck( TriBool val_r );
351
352 void resetGpgCheck();
353 void resetRepoGpgCheck();
354 void resetPkgGpgCheck();
356 //
361 Pathname vendorPath() const;
362
367
371 bool solver_onlyRequires() const;
372
378
385
389 bool solver_allowVendorChange() const;
390
392 bool solver_dupAllowDowngrade() const;
393
395 bool solver_dupAllowNameChange() const;
396
398 bool solver_dupAllowArchChange() const;
399
401 bool solver_dupAllowVendorChange() const;
402
406 bool solver_cleandepsOnRemove() const;
407
415 unsigned solver_upgradeTestcasesToKeep() const;
416
432 void setSolverUpgradeRemoveDroppedPackages( bool val_r );
435
446 const std::set<std::string> & multiversionSpec() const;
447 void multiversionSpec( std::set<std::string> new_r );
449 void addMultiversionSpec( const std::string & name_r );
450 void removeMultiversionSpec( const std::string & name_r );
452
457 Pathname locksFile() const;
458
462 bool apply_locks_file() const;
463
468
474
480
484 std::string updateMessagesNotify() const;
486 void setUpdateMessagesNotify( const std::string & val_r );
490
499 target::rpm::RpmInstFlags rpmInstallFlags() const;
501
508 Pathname historyLogFile() const;
509
514
519
528 std::string distroverpkg() const;
529
535 Pathname pluginsPath() const;
536
540 std::string multiversionKernels() const;
541
543 public:
544 class Impl;
546 ~ZConfig();
547 private:
548 friend class Impl;
550 ZConfig();
553 };
555
557} // namespace zypp
559#endif // ZYPP_ZCONFIG_H
Architecture.
Definition: Arch.h:37
'Language[_Country]' codes.
Definition: Locale.h:50
ZConfig implementation.
Definition: ZConfig.cc:304
Interim helper class to collect global options and settings.
Definition: ZConfig.h:60
bool hasUserData() const
Whether a (non empty) user data sting is defined.
Definition: ZConfig.cc:891
bool solver_cleandepsOnRemove() const
Whether removing a package should also remove no longer needed requirements.
Definition: ZConfig.cc:1088
std::string userData() const
User defined string value to be passed to log, history, plugins...
Definition: ZConfig.cc:894
Pathname knownServicesPath() const
Path where the known services .service files are kept (configPath()/services.d).
Definition: ZConfig.cc:978
void removeMultiversionSpec(const std::string &name_r)
Definition: ZConfig.cc:1118
Pathname repoPackagesPath() const
Path where the repo packages are downloaded and kept (repoCachePath()/packages).
Definition: ZConfig.cc:953
unsigned repo_refresh_delay() const
Amount of time in minutes that must pass before another refresh.
Definition: ZConfig.cc:1013
Arch systemArchitecture() const
The system architecture zypp uses.
Definition: ZConfig.cc:849
Locale textLocale() const
The locale for translated texts zypp uses.
Definition: ZConfig.cc:873
Pathname update_dataPath() const
Path where the update items are kept (/var/adm)
Definition: ZConfig.cc:1123
ResolverFocus solver_focus() const
The resolvers general attitude when resolving jobs.
Definition: ZConfig.cc:1075
Pathname update_messagesPath() const
Path where the repo solv files are created and kept (update_dataPath()/solv).
Definition: ZConfig.cc:1129
Pathname pluginsPath() const
Defaults to /usr/lib/zypp/plugins.
Definition: ZConfig.cc:1181
Pathname repoManagerRoot() const
The RepoManager root directory.
Definition: ZConfig.cc:828
void resetSystemArchitecture()
Reset the zypp system architecture to the default.
Definition: ZConfig.h:103
void resetRepoGpgCheck()
Reset to the zconfig default.
Definition: ZConfig.cc:1072
bool gpgCheck() const
Turn signature checking on/off (on)
Definition: ZConfig.cc:1063
Pathname knownReposPath() const
Path where the known repositories .repo files are kept (configPath()/repos.d).
Definition: ZConfig.cc:972
Pathname update_scriptsPath() const
Path where the repo metadata is downloaded and kept (update_dataPath()/).
Definition: ZConfig.cc:1135
long download_transfer_timeout() const
Maximum time in seconds that you allow a transfer operation to take.
Definition: ZConfig.cc:1052
void setRepoManagerRoot(const Pathname &root)
Sets the RepoManager root directory.
Definition: ZConfig.cc:834
bool solver_dupAllowArchChange() const
DUP tune: Whether to allow package arch changes upon DUP.
Definition: ZConfig.cc:1085
void setTextLocale(const Locale &locale_r)
Set the preferred locale for translated texts.
Definition: ZConfig.cc:876
bool solverUpgradeRemoveDroppedPackages() const
Whether dist upgrade should remove a products dropped packages (true).
Definition: ZConfig.cc:1102
static Locale defaultTextLocale()
The autodetected preferred locale for translated texts.
Definition: ZConfig.cc:867
Pathname download_mediaMountdir() const
Path where media are preferably mounted or downloaded.
Definition: ZConfig.cc:1055
void resetSolverUpgradeRemoveDroppedPackages()
Reset solverUpgradeRemoveDroppedPackages to the zypp.conf default.
Definition: ZConfig.cc:1104
bool apply_locks_file() const
Whether locks file should be read and applied after start (true)
Definition: ZConfig.cc:1120
bool solver_allowVendorChange() const
Whether vendor check is by default enabled.
Definition: ZConfig.cc:1080
void set_default_download_mediaMountdir()
Reset to zypp.cong default.
Definition: ZConfig.cc:1057
Pathname repoCachePath() const
Path where the caches are kept (/var/cache/zypp)
Definition: ZConfig.cc:914
void setPkgGpgCheck(TriBool val_r)
Change the value.
Definition: ZConfig.cc:1069
Pathname needrebootPath() const
Path where the custom needreboot config files are kept (configPath()/needreboot.d).
Definition: ZConfig.cc:987
bool setUserData(const std::string &str_r)
Set a new userData string.
Definition: ZConfig.cc:897
Pathname systemRoot() const
The target root directory.
Definition: ZConfig.cc:824
long download_max_silent_tries() const
Maximum silent tries.
Definition: ZConfig.cc:1049
bool repo_add_probe() const
Whether repository urls should be probed.
Definition: ZConfig.cc:1010
target::rpm::RpmInstFlags rpmInstallFlags() const
The default target::rpm::RpmInstFlags for ZYppCommitPolicy.
Definition: ZConfig.cc:1152
void setUpdateMessagesNotify(const std::string &val_r)
Set a new command definition (see update.messages.notify in zypp.conf).
Definition: ZConfig.cc:1144
unsigned solver_upgradeTestcasesToKeep() const
When committing a dist upgrade (e.g.
Definition: ZConfig.cc:1099
Pathname repoMetadataPath() const
Path where the repo metadata is downloaded and kept (repoCachePath()/raw).
Definition: ZConfig.cc:931
Pathname vendorPath() const
Directory for equivalent vendor definitions (configPath()/vendors.d)
Definition: ZConfig.cc:996
long download_min_download_speed() const
Minimum download speed (bytes per second) until the connection is dropped.
Definition: ZConfig.cc:1043
DownloadMode commit_downloadMode() const
Commit download policy to use as default.
Definition: ZConfig.cc:1059
Pathname needrebootFile() const
Path of the default needreboot config file (configPath()/needreboot).
Definition: ZConfig.cc:984
void setGpgCheck(bool val_r)
Change the value.
Definition: ZConfig.cc:1067
bool solver_dupAllowVendorChange() const
DUP tune: Whether to allow package vendor changes upon DUP.
Definition: ZConfig.cc:1086
~ZConfig()
Dtor.
Definition: ZConfig.cc:821
Pathname locksFile() const
Path where zypp can find or create lock file (configPath()/locks)
Definition: ZConfig.cc:1002
RW_pointer< Impl, rw_pointer::Scoped< Impl > > _pimpl
Pointer to implementation.
Definition: ZConfig.h:552
Pathname repoSolvfilesPath() const
Path where the repo solv files are created and kept (repoCachePath()/solv).
Definition: ZConfig.cc:942
Pathname historyLogFile() const
Path where ZYpp install history is logged.
Definition: ZConfig.cc:1156
void setSystemArchitecture(const Arch &arch_r)
Override the zypp system architecture.
Definition: ZConfig.cc:852
TriBool pkgGpgCheck() const
Check rpm package signatures (indeterminate - according to gpgcheck)
Definition: ZConfig.cc:1065
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:959
void setRepoSolvfilesPath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:948
void resetUpdateMessagesNotify()
Reset to the zypp.conf default.
Definition: ZConfig.cc:1147
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:1114
void set_download_mediaMountdir(Pathname newval_r)
Set alternate value.
Definition: ZConfig.cc:1056
bool download_use_deltarpm() const
Whether to consider using a deltarpm when downloading a package.
Definition: ZConfig.cc:1025
TriBool repoGpgCheck() const
Check repo matadata signatures (indeterminate - according to gpgcheck)
Definition: ZConfig.cc:1064
void set_download_media_prefer_download(bool yesno_r)
Set download_media_prefer_download to a specific value.
Definition: ZConfig.cc:1034
std::string updateMessagesNotify() const
Command definition for sending update messages.
Definition: ZConfig.cc:1141
void addMultiversionSpec(const std::string &name_r)
Definition: ZConfig.cc:1117
Pathname solver_checkSystemFile() const
File in which dependencies described which has to be fulfilled for a running system.
Definition: ZConfig.cc:1091
void set_default_download_media_prefer_download()
Set download_media_prefer_download to the configfiles default.
Definition: ZConfig.cc:1037
Pathname solver_checkSystemFileDir() const
Directory, which may or may not contain files in which dependencies described which has to be fulfill...
Definition: ZConfig.cc:1095
void resetGpgCheck()
Reset to the zconfig default.
Definition: ZConfig.cc:1071
void setSolverUpgradeRemoveDroppedPackages(bool val_r)
Set solverUpgradeRemoveDroppedPackages to val_r.
Definition: ZConfig.cc:1103
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:305
void resetTextLocale()
Reset the locale for translated texts to the default.
Definition: ZConfig.h:119
Pathname configPath() const
Path where the configfiles are kept (/etc/zypp).
Definition: ZConfig.cc:966
static Arch defaultSystemArchitecture()
The autodetected system architecture.
Definition: ZConfig.cc:843
ZConfig()
Default ctor.
Definition: ZConfig.cc:810
Pathname pubkeyCachePath() const
Path where the pubkey caches.
Definition: ZConfig.cc:920
long download_max_concurrent_connections() const
Maximum number of concurrent connections for a single transfer.
Definition: ZConfig.cc:1040
void resetPkgGpgCheck()
Reset to the zconfig default.
Definition: ZConfig.cc:1073
bool solver_onlyRequires() const
Solver regards required packages,patterns,... only.
Definition: ZConfig.cc:1077
Pathname varsPath() const
Path containing custom repo variable definitions (configPath()/vars.d).
Definition: ZConfig.cc:990
bool solver_dupAllowNameChange() const
DUP tune: Whether to follow package renames upon DUP.
Definition: ZConfig.cc:1084
bool repoLabelIsAlias() const
Whether to use repository alias or name in user messages (progress, exceptions, .....
Definition: ZConfig.cc:1019
void clearMultiversionSpec()
Definition: ZConfig.cc:1116
LocaleSet repoRefreshLocales() const
List of locales for which translated package descriptions should be downloaded.
Definition: ZConfig.cc:1016
long download_max_download_speed() const
Maximum download speed (bytes per second)
Definition: ZConfig.cc:1046
void setRepoMetadataPath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:937
bool solver_dupAllowDowngrade() const
DUP tune: Whether to allow version downgrades upon DUP.
Definition: ZConfig.cc:1083
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:1028
void setRepoCachePath(const Pathname &path_r)
Set a new path as the default repo cache path.
Definition: ZConfig.cc:926
void setRepoGpgCheck(TriBool val_r)
Change the value.
Definition: ZConfig.cc:1068
Pathname credentialsGlobalDir() const
Defaults to /etc/zypp/credentials.d.
Definition: ZConfig.cc:1162
bool download_media_prefer_download() const
Hint which media to prefer when installing packages (download vs.
Definition: ZConfig.cc:1031
Pathname credentialsGlobalFile() const
Defaults to /etc/zypp/credentials.cat.
Definition: ZConfig.cc:1168
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 resolvers general attitude.
Definition: ResolverFocus.h:22
std::unordered_set< Locale > LocaleSet
Definition: Locale.h:28
DownloadMode
Supported commit download policies.
Definition: DownloadMode.h:23
Wrapper for const correct access via Smart pointer types.
Definition: PtrTypes.h:286