providespec.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_MEDIA_PROVIDESPEC_H_INCLUDED
#define ZYPP_MEDIA_PROVIDESPEC_H_INCLUDED

#include <iosfwd>

#include <zypp-core/Url.h>
#include <zypp-core/ByteCount.h>
#include <zypp-core/CheckSum.h>
#include <zypp-core/TriBool.h>
#include <zypp-core/OnMediaLocation>
#include <zypp-core/MirroredOrigin.h>
#include <zypp-media/ng/ProvideFwd>
#include <zypp-media/ng/HeaderValueMap>
#include <boost/iterator/iterator_adaptor.hpp>

namespace zyppng
{

  class ProvideMediaSpec
  {
  public:

    ProvideMediaSpec(std::string label="", zypp::Pathname verifyData = zypp::Pathname(), unsigned medianr = 1 );

    const std::string &label() const;

    ProvideMediaSpec &setLabel( const std::string &label );

    unsigned medianr() const;

    ProvideMediaSpec & setMedianr( unsigned medianr );

    zypp::Pathname mediaFile () const;

    ProvideMediaSpec &setMediaFile( const zypp::Pathname &pName );

    HeaderValueMap &customHeaders();
    const HeaderValueMap &customHeaders() const;

    ProvideMediaSpec &setCustomHeaderValue (  const std::string &key, const HeaderValueMap::Value &val );

    ProvideMediaSpec &addCustomHeaderValue (  const std::string &key, const HeaderValueMap::Value &val );

    zypp::TriBool isSameMedium ( const ProvideMediaSpec &other ) const;

    static bool isSameMedium ( const zypp::MirroredOrigin &originA, const ProvideMediaSpec &specA, const zypp::MirroredOrigin &originB, const ProvideMediaSpec &specB );

  public:
    class Impl;                 
  private:
    zypp::RWCOW_pointer<Impl> _pimpl; 
  };


  class ProvideFileSpec
  {
    friend std::ostream & operator<<( std::ostream &str, const ProvideFileSpec &obj );
    friend std::ostream & dumpOn( std::ostream &str, const ProvideFileSpec &obj );

  public:
    ProvideFileSpec();

    ProvideFileSpec(const zypp::OnMediaLocation &loc);

    ProvideFileSpec(const ProvideFileSpec &) = default;
    ProvideFileSpec(ProvideFileSpec &&) noexcept = default;

    ProvideFileSpec &operator=(const ProvideFileSpec &) = default;
    ProvideFileSpec &operator=(ProvideFileSpec &&) noexcept = default;

    ~ProvideFileSpec();

    template <typename... T>
    static ProvideFileSpecRef create ( T... args ) {
      return std::make_shared<ProvideFileSpec>( std::forward<T>(args)... );
    }

    const zypp::Pathname &destFilenameHint() const;
    ProvideFileSpec &setDestFilenameHint ( const zypp::Pathname &filename );

    bool checkExistsOnly () const;
    ProvideFileSpec & setCheckExistsOnly( const bool set = true );


    bool optional() const;
    ProvideFileSpec & setOptional( bool val );

    const zypp::ByteCount &downloadSize() const;
    ProvideFileSpec &setDownloadSize( const zypp::ByteCount &val_r );

    const zypp::CheckSum &checksum() const;
    ProvideFileSpec &setChecksum( const zypp::CheckSum &val_r );


    const zypp::ByteCount &openSize() const;
    ProvideFileSpec &setOpenSize( const zypp::ByteCount &val_r );

    const zypp::CheckSum &openChecksum() const;
    ProvideFileSpec &setOpenChecksum( const zypp::CheckSum &val_r );

    const zypp::ByteCount &headerSize() const;
    ProvideFileSpec &setHeaderSize( const zypp::ByteCount &val_r );

    const zypp::CheckSum &headerChecksum() const;
    ProvideFileSpec &setHeaderChecksum( const zypp::CheckSum &val_r );

    const zypp::Pathname &deltafile() const;
    ProvideFileSpec &setDeltafile( const zypp::Pathname &path );

    bool mirrorsAllowed() const;

    ProvideFileSpec &setMirrorsAllowed( bool set = true );

    HeaderValueMap &customHeaders();
    const HeaderValueMap &customHeaders() const;

    ProvideFileSpec &setCustomHeaderValue (  const std::string &key, const HeaderValueMap::Value &val );

    ProvideFileSpec &addCustomHeaderValue (  const std::string &key, const HeaderValueMap::Value &val );

    zypp::OnMediaLocation asOnMediaLocation ( const zypp::Pathname &path, unsigned int mediaNr ) const;

  public:
    class Impl;                 
  private:
    zypp::RWCOW_pointer<Impl> _pimpl; 
  };

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

  std::ostream & dumpOn( std::ostream &str, const ProvideFileSpec &obj );

} // namespace zypp

#endif // ZYPP_MEDIA_PROVIDESPEC_H_INCLUDED