#include <set>
#include "zypp/base/Iterator.h"
-#include "zypp/base/Deprecated.h"
+#include "zypp/APIConfig.h"
#include "zypp/Url.h"
+#include "zypp/Locale.h"
+#include "zypp/TriBool.h"
#include "zypp/repo/RepoType.h"
#include "zypp/repo/RepoVariables.h"
* name=Ruby repository (openSUSE_10.2)
* type=rpm-md
* baseurl=http://software.opensuse.org/download/ruby/openSUSE_10.2/
+ * http://some.opensuse.mirror/ruby/openSUSE_10.2/
* gpgcheck=1
* gpgkey=http://software.opensuse.org/openSUSE-Build-Service.asc
* enabled=1
*
* \note A RepoInfo is a hint about how
* to create a Repository.
+ *
+ * \note Name, baseUrls and mirrorUrl are subject to repo variable replacement
+ * (\see \ref RepoVariablesStringReplacer).
*/
class RepoInfo : public repo::RepoInfoBase
{
friend std::ostream & operator<<( std::ostream & str, const RepoInfo & obj );
public:
- RepoInfo();
- ~RepoInfo();
-
- /**
- * Repository priority for solver.
- * Some number between \c 1 (highest priority) and \c 99 (\ref defaultPriority).
- */
- unsigned priority() const;
- /**
- * The default priority (\c 99).
- */
- static unsigned defaultPriority();
- /**
- * Set repository priority for solver.
- * A \c newval_r of \c 0 sets the default priority.
- * \see \ref priority.
- */
- void setPriority( unsigned newval_r );
-
- /**
- * A Url under which the metadata are located, or a set of mirrors.
- *
- * This can't be empty in order the repository to be valid
- * unless the download of the mirror list succeeds and it
- * contains a valid url.
- *
- * \deprecated IMO superfluous as we provide begin/end iterator.
- */
- ZYPP_DEPRECATED std::set<Url> baseUrls() const;
-
- /**
- * \short Repository path
- *
- * Pathname relative to the base Url where the product/repository
- * is located
- *
- * For medias containing more than one product, or repositories not
- * located at the root of the media it is important to
- * know the path of the media root relative to the product directory
- * so a media verifier can be set for that media.
- *
- * It is not mandatory, and the default is /
- *
- * \note As a repository can have multiple Urls, the path is unique and
- * the same for all Urls, so it is assumed all the Urls have the
- * same media layout.
- *
- */
- Pathname path() const;
-
- /**
- * Url of a file which contains a list of Urls
- * If empty, the base url will be used.
- */
- Url mirrorListUrl() const;
-
- typedef std::set<Url> url_set;
- //typedef url_set::const_iterator urls_const_iterator;
- typedef url_set::size_type urls_size_type;
- typedef transform_iterator<repo::RepoVariablesUrlReplacer, url_set::const_iterator> urls_const_iterator;
-
- /**
- * iterator that points at begin of repository urls
- */
- urls_const_iterator baseUrlsBegin() const;
-
- /**
- * iterator that points at end of repository urls
- */
- urls_const_iterator baseUrlsEnd() const;
-
- /**
- * number of repository urls
- */
- urls_size_type baseUrlsSize() const;
-
- /**
- * whether repository urls are available
+ RepoInfo();
+ virtual ~RepoInfo();
+
+ /** Represents no Repository (one with an empty alias). */
+ static const RepoInfo noRepo;
+
+ public:
+ /**
+ * The default priority (\c 99).
+ */
+ static unsigned defaultPriority();
+ /**
+ * Repository priority for solver.
+ * Some number between \c 1 (highest priority) and \c 99 (\ref defaultPriority).
+ */
+ unsigned priority() const;
+ /**
+ * Set repository priority for solver.
+ * A \c newval_r of \c 0 sets the default priority.
+ * \see \ref priority.
+ */
+ void setPriority( unsigned newval_r );
+
+ typedef std::list<Url> url_set;
+ typedef url_set::size_type urls_size_type;
+ typedef transform_iterator<repo::RepoVariablesUrlReplacer, url_set::const_iterator> urls_const_iterator;
+ /**
+ * whether repository urls are available
+ */
+ bool baseUrlsEmpty() const;
+ /**
+ * Whether there are manualy configured repository urls.
+ * If \c false, a mirrorlist might be used.
+ */
+ bool baseUrlSet() const;
+ /**
+ * number of repository urls
+ */
+ urls_size_type baseUrlsSize() const;
+ /**
+ * iterator that points at begin of repository urls
+ */
+ urls_const_iterator baseUrlsBegin() const;
+ /**
+ * iterator that points at end of repository urls
+ */
+ urls_const_iterator baseUrlsEnd() const;
+
+ /**
+ * Pars pro toto: The first repository url
+ */
+ Url url() const
+ { return( baseUrlsEmpty() ? Url() : *baseUrlsBegin()); }
+ /**
+ * Pars pro toto: The first repository raw url (no variables replaced)
+ */
+ Url rawUrl() const;
+
+ /**
+ * The complete set of repository urls
+ *
+ * These are either the configured baseurls, or if empty, the downloaded
+ * mirror list (\see \ref mirrorListUrl)
+ */
+ url_set baseUrls() const;
+ /**
+ * The complete set of raw repository urls (no variables replaced)
+ */
+ url_set rawBaseUrls() const;
+
+ /**
+ * Add a base url. \see baseUrls
+ * \param url The base url for the repository.
+ *
+ * To recreate the base URLs list, use \ref setBaseUrl(const Url &) followed
+ * by addBaseUrl().
+ */
+ void addBaseUrl( const Url &url );
+ /**
+ * Clears current base URL list and adds \a url.
+ */
+ void setBaseUrl( const Url &url );
+ /**
+ * Clears current base URL list and adds an \ref url_set.
+ */
+ void setBaseUrls( url_set urls );
+
+ /**
+ * \short Repository path
+ *
+ * Pathname relative to the base Url where the product/repository
+ * is located
+ *
+ * For media containing more than one product, or repositories not
+ * located at the root of the media it is important to know the path
+ * to the product directory relative to the media root. So a media
+ * verifier can be set for that media. You may also read it as
+ * <tt>baseUrl = url to mount</tt> and <tt>path = path on the
+ * mounted media</tt>.
+ *
+ * It is not mandatory, and the default is \c /.
+ *
+ * \note As a repository can have multiple Urls, the path is unique and
+ * the same for all Urls, so it is assumed all the Urls have the
+ * same media layout.
+ *
+ */
+ Pathname path() const;
+ /**
+ * set the product path. \see path()
+ * \param path the path to the product
+ */
+ void setPath( const Pathname &path );
+
+ /**
+ * Url of a file which contains a list of repository urls
+ */
+ Url mirrorListUrl() const;
+ /**
+ * The raw mirrorListUrl (no variables replaced).
+ */
+ Url rawMirrorListUrl() const;
+ /**
+ * Set mirror list url. \see mirrorListUrl
+ * \param url The base url for the list
+ */
+ void setMirrorListUrl( const Url &url );
+
+ /**
+ * Type of repository,
+ *
+ */
+ repo::RepoType type() const;
+ /**
+ * This allows to adjust the \ref RepoType lazy, from \c NONE to
+ * some probed value, even for const objects.
+ *
+ * This is a NOOP if the current type is not \c NONE.
+ */
+ void setProbedType( const repo::RepoType &t ) const;
+ /**
+ * set the repository type \see type
+ * \param t
+ */
+ void setType( const repo::RepoType &t );
+
+ /**
+ * \short Path where this repo metadata was read from
+ *
+ * \note could be an empty pathname for repo
+ * infos created in memory.
+ */
+ Pathname metadataPath() const;
+ /**
+ * \short set the path where the local metadata is stored
+ *
+ * The path to the metadata of this repository
+ * was defined, or empty if nowhere.
+ *
+ * \param path directory path
+ */
+ void setMetadataPath( const Pathname &path );
+
+ /**
+ * \short Path where this repo packages are cached
+ */
+ Pathname packagesPath() const;
+ /**
+ * \short set the path where the local packages are stored
+ *
+ * \param path directory path
+ */
+ void setPackagesPath( const Pathname &path );
+
+
+ /** Whether default signature checking should be performed for this repo.
+ *
+ * This will turn on \ref repoGpgCheck for signed repos and
+ * \ref pkgGpgCheck for unsigned ones or if \ref repoGpgCheck is off.
+ *
+ * The default is \c true but may be overwritten by \c zypp.conf or a \ref .repo file.
+ */
+ bool gpgCheck() const;
+ /** Set the value for \ref gpgCheck (or \c indeterminate to use the default). */
+ void setGpgCheck( TriBool value_r );
+ /** \overload \deprecated legacy and for squid */
+ void setGpgCheck( bool value_r );
+
+ /** Whether the signature of repo metadata should be checked for this repo.
+ * The default is defined by \ref gpgCheck but may be overwritten by \c zypp.conf or a \ref .repo file.
+ */
+ bool repoGpgCheck() const;
+ /** Set the value for \ref repoGpgCheck (or \c indeterminate to use the default). */
+ void setRepoGpgCheck( TriBool value_r );
+
+ /** Whether the signature of rpm packages should be checked for this repo.
+ * The default is defined by \ref gpgCheck but may be overwritten by \c zypp.conf or a \ref .repo file.
+ */
+ bool pkgGpgCheck() const;
+ /** Set the value for \ref pkgGpgCheck (or \c indeterminate to use the default). */
+ void setPkgGpgCheck( TriBool value_r );
+
+ /** Whether the repo metadata are signed and successfully validated or \c indeterminate if unsigned.
+ * The value is usually set by \ref repo::Downloader when retrieving the metadata.
+ */
+ TriBool validRepoSignature() const;
+ /** Set the value for \ref validRepoSignature (or \c indeterminate if unsigned). */
+ void setValidRepoSignature( TriBool value_r );
+
+
+ /** Whether gpgkey URLs are defined */
+ bool gpgKeyUrlsEmpty() const;
+ /** Number of gpgkey URLs defined */
+ urls_size_type gpgKeyUrlsSize() const;
+
+ /** The list of gpgkey URLs defined for this repo */
+ url_set gpgKeyUrls() const;
+ /** The list of raw gpgkey URLs defined for this repo (no variables replaced) */
+ url_set rawGpgKeyUrls() const;
+ /** Set a list of gpgkey URLs defined for this repo */
+ void setGpgKeyUrls( url_set urls );
+
+ /** (leagcy API) The 1st gpgkey URL defined for this repo */
+ Url gpgKeyUrl() const;
+ /** (leagcy API) The 1st raw gpgkey URL defined for this repo (no variables replaced) */
+ Url rawGpgKeyUrl() const;
+ /** (leagcy API) Set the gpgkey URL defined for this repo */
+ void setGpgKeyUrl( const Url &gpgkey );
+
+
+ /**
+ * \short Whether packages downloaded from this repository will be kept in local cache
+ */
+ bool keepPackages() const;
+ /**
+ * \short Set if packaqes downloaded from this repository will be kept in local cache
+ *
+ * If the setting is true, all downloaded packages from this repository will be
+ * copied to the local raw cache.
+ *
+ * \param keep true (keep the downloaded packages) or false (delete them after installation)
+ *
+ */
+ void setKeepPackages( bool keep );
+
+ /**
+ * Gets name of the service to which this repository belongs or empty string
+ * if it has been added manually.
+ */
+ std::string service() const;
+ /**
+ * sets service which added this repository
+ */
+ void setService( const std::string& name );
+
+ /**
+ * Distribution for which is this repository meant.
+ */
+ std::string targetDistribution() const;
+ /**
+ * Sets the distribution for which is this repository meant. This is
+ * an in-memory value only, does not get written to the .repo file upon
+ * saving.
+ */
+ void setTargetDistribution(const std::string & targetDistribution);
+
+ /** Add content keywords */
+ void addContent( const std::string & keyword_r );
+ /** \overload add keywords from container */
+ template <class _Iterator>
+ void addContentFrom( _Iterator begin_r, _Iterator end_r )
+ { for_( it, begin_r, end_r ) addContent( *it ); }
+ /** \overload */
+ template <class _Container>
+ void addContentFrom( const _Container & container_r )
+ { addContentFrom( container_r.begin(), container_r.end() ); }
+
+ /** Check for content keywords.
+ * Checking for an empty string returns whether content kewords are
+ * known at all. They may be missing due to missing metadata in disabled
+ * repos.
+ */
+ bool hasContent( const std::string & keyword_r = std::string() ) const;
+ /** \overload check for \b all keywords being present */
+ template <class _Iterator>
+ bool hasContentAll( _Iterator begin_r, _Iterator end_r ) const
+ { for_( it, begin_r, end_r ) if ( ! hasContent( *it ) ) return false; return true; }
+ /** \overload */
+ template <class _Container>
+ bool hasContentAll( const _Container & container_r ) const
+ { return hasContentAll( container_r.begin(), container_r.end() ); }
+ /** \overload check for \b any keyword being present */
+ template <class _Iterator>
+ bool hasContentAny( _Iterator begin_r, _Iterator end_r ) const
+ { for_( it, begin_r, end_r ) if ( hasContent( *it ) ) return true; return false; }
+ /** \overload */
+ template <class _Container>
+ bool hasContentAny( const _Container & container_r ) const
+ { return hasContentAny( container_r.begin(), container_r.end() ); }
+
+ public:
+ /** \name Repository license
*/
- bool baseUrlsEmpty() const;
-
- /**
- * Type of repository,
- *
- */
- repo::RepoType type() const;
-
- /**
- * \short Path where this repo metadata was read from
- *
- * \note could be an empty pathname for repo
- * infos created in memory.
- */
- Pathname metadataPath() const;
-
- /**
- * \short Path where this repo packages are cached
- */
- Pathname packagesPath() const;
-
- /**
- * \short Whether to check or not this repository with gpg
- *
- * \note This is a just a hint to the application and can
- * be ignored.
- *
- */
- bool gpgCheck() const;
-
- /**
- * \short Key to use for gpg checking of this repository
- *
- * \param url Url to the key in ASCII armored format
- *
- * \note This is a just a hint to the application and can
- * be ignored.
- *
- */
- Url gpgKeyUrl() const;
-
- /**
- * \short Whether to keep the packages downloaded from this repository will be kept in local cache
- */
- bool keepPackages() const;
-
- /**
- * Gets name of the service to which this repository belongs or empty string
- * if it has been added manually.
- */
- std::string service() const;
-
- /**
- * Distribution for which is this repository meant.
- */
- std::string targetDistribution() const;
+ //@{
+ /** Whether there is a license associated with the repo. */
+ bool hasLicense() const;
+
+ /** Whether the repo license has to be accepted, e.g. there is no
+ * no acceptance needed for openSUSE.
+ */
+ bool needToAcceptLicense() const;
+
+ /** Return the best license for the current (or a specified) locale. */
+ std::string getLicense( const Locale & lang_r = Locale() ) const;
+ std::string getLicense( const Locale & lang_r = Locale() ); // LEGACY API
+
+ /** Return the locales the license is available for.
+ * \ref Locale::noCode is included in case of \c license.txt which does
+ * not specify a specific locale.
+ */
+ LocaleSet getLicenseLocales() const;
+ //@}
public:
- /**
- * Add a base url. \see baseUrls
- * \param url The base url for the repository.
- * \note can change keepPackages,so change it after this call
- *
- * To recreate the base URLs list, use \ref setBaseUrl(const Url &) followed
- * by addBaseUrl().
- */
- void addBaseUrl( const Url &url );
-
- /**
- * Clears current base URL list and adds \a url.
- * \note can change keepPackages,so change it after this call
- */
- void setBaseUrl( const Url &url );
-
- /**
- * set the product path. \see path()
- * \param path the path to the product
- */
- void setPath( const Pathname &path );
-
- /**
- * Set mirror list url. \see mirrorListUrl
- * \param url The base url for the list
- */
- void setMirrorListUrl( const Url &url );
-
- /**
- * set the repository type \see type
- * \param t
- */
- void setType( const repo::RepoType &t );
-
- /**
- * This allows to adjust the \ref RepoType lazy, from \c NONE to
- * some probed value, even for const objects.
- *
- * This is a NOOP if the current type is not \c NONE.
- */
- void setProbedType( const repo::RepoType &t ) const;
-
- /**
- * \short set the path where the local metadata is stored
- *
- * The path to the metadata of this repository
- * was defined, or empty if nowhere.
- *
- * \param path directory path
- */
- void setMetadataPath( const Pathname &path );
-
- /**
- * \short set the path where the local packages are stored
- *
- * \param path directory path
- */
- void setPackagesPath( const Pathname &path );
-
- /**
- * \short Whether to check or not this repository with gpg
- *
- * \param check true (check) or false (dont'check)
- *
- * \note This is a just a hint to the application and can
- * be ignored.
- *
- */
- void setGpgCheck( bool check );
-
- /**
- * \short Key to use for gpg checking of this repository
- *
- * \param url Url to the key in ASCII armored format
- *
- * \note This is a just a hint to the application and can
- * be ignored.
- *
- */
- void setGpgKeyUrl( const Url &gpgkey );
-
- /**
- * \short Set if the packaqes downloaded from this repository will be kept in local cache
- *
- * If the setting is true, all downloaded packages from this repository will be
- * copied to the local raw cache.
- *
- * \param keep true (keep the downloaded packages) or false (delete them after installation)
- *
- */
- void setKeepPackages( bool keep );
-
- /**
- * sets service which added this repository
- */
- void setService( const std::string& name );
-
- /**
- * Sets the distribution for which is this repository meant. This is
- * an in-memory value only, does not get written to the .repo file upon
- * saving.
- */
- void setTargetDistribution(const std::string & targetDistribution);
-
- /**
- * Write a human-readable representation of this RepoInfo object
- * into the \a str stream. Useful for logging.
- */
- virtual std::ostream & dumpOn( std::ostream & str ) const;
-
- /**
- * Write this RepoInfo object into \a str in a <tr>.repo</tt> file format.
- */
- virtual std::ostream & dumpAsIniOn( std::ostream & str ) const;
- /** \deprecated use dumpAsIniOn(ostream) instead */
- ZYPP_DEPRECATED virtual std::ostream & dumpRepoOn( std::ostream & str ) const;
-
- /**
- * Write an XML representation of this RepoInfo object.
- */
- virtual std::ostream & dumpAsXMLOn( std::ostream & str) const;
-
- class Impl;
- private:
- /** Pointer to implementation */
- RWCOW_pointer<Impl> _pimpl;
+ /**
+ * Write a human-readable representation of this RepoInfo object
+ * into the \a str stream. Useful for logging.
+ */
+ virtual std::ostream & dumpOn( std::ostream & str ) const;
+
+ /**
+ * Write this RepoInfo object into \a str in a <tr>.repo</tt> file format.
+ * Raw values, no variable replacement.
+ */
+ virtual std::ostream & dumpAsIniOn( std::ostream & str ) const;
+
+ /**
+ * Write an XML representation of this RepoInfo object.
+ * Repo variables replaced.
+ *
+ * \param str
+ * \param content this argument is ignored (used in other classed derived
+ * from RepoInfoBase.
+ */
+ virtual std::ostream & dumpAsXmlOn( std::ostream & str, const std::string & content = "" ) const;
+
+ class Impl;
+ private:
+ friend class RepoManager;
+ /** Raw values for RepoManager */
+ void getRawGpgChecks( TriBool & g_r, TriBool & r_r, TriBool & p_r ) const;
+
+ /** Pointer to implementation */
+ RWCOW_pointer<Impl> _pimpl;
};
///////////////////////////////////////////////////////////////////
+ /** \relates RepoInfo */
+ typedef shared_ptr<RepoInfo> RepoInfo_Ptr;
+ /** \relates RepoInfo */
+ typedef shared_ptr<const RepoInfo> RepoInfo_constPtr;
+ /** \relates RepoInfo */
+ typedef std::list<RepoInfo> RepoInfoList;
+
/** \relates RepoInfo Stream output */
std::ostream & operator<<( std::ostream & str, const RepoInfo & obj );
- inline bool operator<( const RepoInfo& lhs, const RepoInfo & rhs )
- { return lhs.alias() < rhs.alias(); }
-
- typedef shared_ptr<RepoInfo> RepoInfo_Ptr;
-
- typedef std::list<RepoInfo> RepoInfoList;
/////////////////////////////////////////////////////////////////
} // namespace zypp
projects / platform / upstream / libzypp.git / blobdiff