Fetcher.h

Go to the documentation of this file.

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

#include <iosfwd>
#include <list>

#include <zypp-core/base/Flags.h>
#include <zypp-core/base/PtrTypes.h>
#include <zypp-core/Pathname.h>
#include <zypp-core/Url.h>
#include <zypp-core/OnMediaLocation>
#include <zypp/Digest.h>
#include <zypp/MediaSetAccess.h>
#include <zypp/FileChecker.h>
#include <zypp-core/ui/ProgressData>

namespace zypp
{ 

  class ZYPP_API Fetcher
  {
    friend std::ostream & operator<<( std::ostream & str,
                                      const Fetcher & obj );
  public:
    class Impl;
  public:

    enum Option
    {
      AutoAddContentFileIndexes = 0x0001,
      AutoAddChecksumsIndexes = 0x0002,
      AutoAddIndexes = AutoAddContentFileIndexes | AutoAddChecksumsIndexes,
    };
    ZYPP_DECLARE_FLAGS(Options, Option);

    Fetcher();
    virtual ~Fetcher();

  public:

    void setOptions( Options options );

    Options options() const;

    void addIndex( const OnMediaLocation &resource );

    void enqueue( const OnMediaLocation &resource,
                  const FileChecker &checker = FileChecker() );

     void enqueueDigested( const OnMediaLocation &resource, const FileChecker &checker = FileChecker() );


    ZYPP_DEPRECATED void enqueueDigested( const OnMediaLocation &resource,
                          const FileChecker &checker, const Pathname &deltafile );


    void enqueueDir( const OnMediaLocation &resource,
                     bool recursive = false,
                     const FileChecker &checker = FileChecker() );

    void enqueueDigestedDir( const OnMediaLocation &resource,
                             bool recursive = false,
                             const FileChecker &checker = FileChecker() );

    void addCachePath( const Pathname &cache_dir );


    enum CacheOptions {
      Default     = 0,
      CleanFiles  = 1
    };
    void addCachePath( const Pathname &cache_dir, CacheOptions options );

    void reset();

    void setMediaSetAccess ( MediaSetAccess &media );

    void start( const Pathname &dest_dir,
      const ProgressData::ReceiverFnc & progress = ProgressData::ReceiverFnc() );

    void start( const Pathname &dest_dir,
                MediaSetAccess &media,
                const ProgressData::ReceiverFnc & progress = ProgressData::ReceiverFnc() );

  public:
    static Pathname mapToCachePath( Pathname remotePath_r );
    static Pathname mapToCachePath( const OnMediaLocation & resource_r )
    { return mapToCachePath( resource_r.filename() ); }

  private:
    RWCOW_pointer<Impl> _pimpl;
  };
  ZYPP_DECLARE_OPERATORS_FOR_FLAGS(Fetcher::Options);

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

} // namespace zypp
#endif // ZYPP_FETCHER_H