RepoInfo.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP2_REPOSITORYINFO_H
#define ZYPP2_REPOSITORYINFO_H
 
#include <list>
#include <set>
 
#include <zypp-core/base/Iterator.h>
#include <zypp-core/Globals.h>
#include <zypp-core/MirroredOrigin.h>
#include <zypp-core/TriBool.h>
#include <zypp-core/Url.h>
 
#include <zypp/Locale.h>
#include <zypp/repo/RepoType.h>
#include <zypp/repo/RepoVariables.h>
#include <zypp/repo/RepoInfoBase.h>

namespace zypp
{ 

  //
  //    CLASS NAME : RepoInfo
  //
  class ZYPP_API RepoInfo : public repo::RepoInfoBase
  {
    friend std::ostream & operator<<( std::ostream & str, const RepoInfo & obj );
 
    public:
      RepoInfo();
      ~RepoInfo() override;
 
      RepoInfo(const RepoInfo &) = default;
      RepoInfo(RepoInfo &&) = default;
      RepoInfo &operator=(const RepoInfo &) = default;
      RepoInfo &operator=(RepoInfo &&) = default;

      static const RepoInfo noRepo;
 
    public:
      static unsigned defaultPriority();
      static unsigned noPriority();
      unsigned priority() const;
      void setPriority( unsigned newval_r );
 
      using url_set = std::list<Url>;
      using urls_size_type = url_set::size_type;
      using urls_const_iterator = transform_iterator<repo::RepoVariablesUrlReplacer, url_set::const_iterator>;
      bool baseUrlsEmpty() const;
      bool baseUrlSet() const;
      urls_size_type baseUrlsSize() const;
      urls_const_iterator baseUrlsBegin() const;
      urls_const_iterator baseUrlsEnd() const;

      Url url() const;
      Url rawUrl() const;

      Url location() const;

      url_set baseUrls() const;
      url_set rawBaseUrls() const;

      void addBaseUrl( Url url );
      void setBaseUrl( Url url );
      void setBaseUrls( url_set urls );

      MirroredOriginSet repoOrigins() const;

      bool repoOriginsEmpty() const;

      Pathname path() const;
      void setPath( const Pathname &path );

      Url mirrorListUrl() const;
      Url rawMirrorListUrl() const;

      void setMirrorlistUrl( const Url &url );
      void setMetalinkUrl( const Url &url );

      Url rawCfgMirrorlistUrl() const;
      Url rawCfgMetalinkUrl() const;
 
#if LEGACY(1735)
      void setMirrorListUrl( const Url &url ) ZYPP_DEPRECATED;
      void setMetalinkUrls( url_set urls ) ZYPP_DEPRECATED;
      void setMirrorListUrls( url_set urls ) ZYPP_DEPRECATED;
#endif

      repo::RepoType type() const;
      void setProbedType( const repo::RepoType &t ) const;
      void setType( const repo::RepoType &t );

      Pathname metadataPath() const;
      void setMetadataPath( const Pathname &path );

      bool usesAutoMetadataPaths() const;

      Pathname systemPackagesPath() const;

      Pathname packagesPath() const;

      void setPackagesPath( const Pathname &path );

      Pathname predownloadPath() const;
 


      bool gpgCheck() const;
      void setGpgCheck( TriBool value_r );
      void setGpgCheck( bool value_r );

      bool repoGpgCheck() const;
      bool repoGpgCheckIsMandatory() const;
      void setRepoGpgCheck( TriBool value_r );

      bool pkgGpgCheck() const;
      bool pkgGpgCheckIsMandatory() const;
      void setPkgGpgCheck( TriBool value_r );

      TriBool validRepoSignature() const;
      void setValidRepoSignature( TriBool value_r );

      enum class GpgCheck {
        indeterminate,             //< not specified
        On,                   //< 1** --gpgcheck
        Strict,                   //< 111 --gpgcheck-strict
        AllowUnsigned,             //< 100 --gpgcheck-allow-unsigned
        AllowUnsignedRepo,     //< 10* --gpgcheck-allow-unsigned-repo
        AllowUnsignedPackage,       //< 1*0 --gpgcheck-allow-unsigned-package
        Default,         //< *** --default-gpgcheck
        Off,                 //< 0** --no-gpgcheck
      };

      bool setGpgCheck( GpgCheck mode_r );
 

      bool gpgKeyUrlsEmpty() const;
      urls_size_type gpgKeyUrlsSize() const;

      url_set gpgKeyUrls() const;
      url_set rawGpgKeyUrls() const;
      void setGpgKeyUrls( url_set urls );

      Url gpgKeyUrl() const;
      Url rawGpgKeyUrl() const;
      void setGpgKeyUrl( const Url &gpgkey );

      bool keepPackages() const;
      void setKeepPackages( bool keep );

      bool effectiveKeepPackages() const;

      std::string service() const;
      void setService( const std::string& name );

      std::string targetDistribution() const;
      void setTargetDistribution(const std::string & targetDistribution);
 

      const std::set<std::string> & contentKeywords() const;

      void addContent( const std::string & keyword_r );
      template <class TIterator>
      void addContentFrom( TIterator begin_r, TIterator end_r )
      { for_( it, begin_r, end_r ) addContent( *it ); }

      template <class TContainer>
      void addContentFrom( const TContainer & container_r )
      { addContentFrom( container_r.begin(), container_r.end() ); }

      bool hasContent() const;
      bool hasContent( const std::string & keyword_r ) const;
      template <class TIterator>
      bool hasContentAll( TIterator begin_r, TIterator end_r ) const
      { for_( it, begin_r, end_r ) if ( ! hasContent( *it ) ) return false; return true; }

      template <class TContainer>
      bool hasContentAll( const TContainer & container_r ) const
      { return hasContentAll( container_r.begin(), container_r.end() ); }

      template <class TIterator>
      bool hasContentAny( TIterator begin_r, TIterator end_r ) const
      { for_( it, begin_r, end_r ) if ( hasContent( *it ) ) return true; return false; }

      template <class TContainer>
      bool hasContentAny( const TContainer & container_r ) const
      { return hasContentAny( container_r.begin(), container_r.end() ); }
 
    public:

      bool hasLicense() const;
      bool hasLicense( const std::string & name_r ) const;

      bool needToAcceptLicense() const;
      bool needToAcceptLicense( const std::string & name_r ) const;

      std::string getLicense( const Locale & lang_r = Locale() ) const;
      std::string getLicense( const Locale & lang_r = Locale() ); // LEGACY API
      std::string getLicense( const std::string & name_r, const Locale & lang_r = Locale() ) const;

      LocaleSet getLicenseLocales() const;
      LocaleSet getLicenseLocales( const std::string & name_r ) const;

      bool requireStatusWithMediaFile () const;
 
    public:

      bool hasExtraValue( const std::string & key_r ) const;

      std::string extraValue( const std::string & key_r ) const;

      bool setExtraValue( const std::string & key_r, std::string value_r );

      template <typename Fnc>
      std::string extraValue( const std::string & key_r, Fnc && genDefault_r ) const
      { return hasExtraValue( key_r ) ? extraValue( key_r ) : genDefault_r();  }

 
    public:
      std::ostream & dumpOn( std::ostream & str ) const override;

      std::ostream & dumpAsIniOn( std::ostream & str ) const override;

      std::ostream & dumpAsXmlOn( std::ostream & str, const std::string & content = "" ) const override;

      void getRawGpgChecks( TriBool & g_r, TriBool & r_r, TriBool & p_r ) const;

      std::string repoStatusString() const;
 
      struct Impl;
    private:
      friend class RepoManager;

      RWCOW_pointer<Impl> _pimpl;
  };


  using RepoInfo_Ptr = shared_ptr<RepoInfo>;
  using RepoInfo_constPtr = shared_ptr<const RepoInfo>;
  using RepoInfoList = std::list<RepoInfo>;

  std::ostream & operator<<( std::ostream & str, const RepoInfo & obj ) ZYPP_API;

  std::ostream & operator<<( std::ostream & str, const RepoInfo::GpgCheck & obj ) ZYPP_API;

} // namespace zypp
#endif // ZYPP2_REPOSITORYINFO_H