InstSrc.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:       InstSrc.h

  Author:     Michael Andres <ma@suse.de>
  Maintainer: Michael Andres <ma@suse.de>

  Purpose:      Class for installation sources
                Defines (provides access to)
                - media access (a pointer to MediaAccess)
                - source description (product, version, vendor, ...)
                - contents (list of package, list of selections, ...)
/-*/
#ifndef InstSrc_h
#define InstSrc_h

#include <iosfwd>
#include <list>
#include <string>

#include <y2util/Pathname.h>
#include <y2util/Url.h>

#include <y2pm/PMTypes.h>

#include <y2pm/PMPackagePtr.h>
#include <y2pm/PMSelectionPtr.h>
#include <y2pm/PMYouPatchPtr.h>

#include <y2pm/InstSrcPtr.h>
#include <y2pm/InstSrcError.h>

#include <y2pm/MediaAccessPtr.h>
#include <y2pm/InstSrcDescrPtr.h>
#include <y2pm/InstSrcDataPtr.h>

//
//      CLASS NAME : InstSrc
class InstSrc: public CountedRep {
  REP_BODY(InstSrc);

  private:

    friend class InstSrcManager;

    void _mgr_attach();

  public:

    typedef InstSrcError Error;

  public:

    typedef PM::NumericISrcID NumericISrcID;
    typedef PM::NumericISrcID UniqueID;

    static const NumericISrcID noID;

    NumericISrcID srcID() const { return _srcID; }

  private:

    static NumericISrcID _SRCID;

    const NumericISrcID _srcID;

  public:
    enum Type {
      T_UNKNOWN,
      // :first entry
      T_UnitedLinux,
      T_YUM,
      // one but last entry:
      T_PlainDir,
      // last entry:
      T_AUTODETECT
    };

    static std::string toString( const Type t );

    static Type fromString( std::string s );

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

  private:

    Pathname _cache;

    bool _cache_deleteOnExit;

    bool _may_use_cache;

    static const Pathname _c_descr_dir;

    static const Pathname _c_data_dir;

    static const Pathname _c_media_dir;

    Pathname cachePath( const Pathname & sub_r ) const { return( _cache + sub_r ); }

    mutable Pathname previouslyDnlPackage;


    mutable int _specialCache;

  public:

    bool specialCache() const;

    void rememberPreviouslyDnlPackage( const Pathname & newpath_r ) const;

    Pathname cache_dir() const { return _cache; }

    Pathname cache_descr_dir() const { return cachePath( _c_descr_dir ); }

    Pathname cache_data_dir() const { return cachePath( _c_data_dir ); }

    Pathname cache_media_dir() const { return cachePath( _c_media_dir ); }

  private:

    PMError _init_openCache( const Pathname & cachedir_r );

    PMError _init_newCache( const Pathname & cachedir_r );

    PMError _init_newMedia( const Url & mediaurl_r, const Pathname & produduct_dir_r,
                            Type type_r );

    PMError writeDescrCache();

  protected:

    InstSrc();

    ~InstSrc();

  private:

    MediaAccessPtr _media;

    InstSrcDescrPtr _descr;

    InstSrcDataPtr _data;

  public:

    constInstSrcDescrPtr descr() const { return _descr; }

    InstSrcDescrPtr descr() { return _descr; }

    constInstSrcDataPtr data() const { return _data; }

    InstSrcDataPtr data() { return _data; }

    constMediaAccessPtr media() const { return _media; }

    MediaAccessPtr media() { return _media; }

    void preferredLocaleChanged() const;

  private:

    PMError enableSource( bool checkRefresh_r );

  public:

    PMError enableSource() { return enableSource( true ); }

    PMError disableSource();

    PMError refreshSource( bool force_r = false );

    bool enabled() const { return _data; }

  private:

        mutable int _medianr;

        PMError provideMedia (int medianr) const;

  public:

        PMError providePackage (int medianr, const Pathname& name, const Pathname& dir, Pathname& path_r) const;

        PMError provideFile (int medianr, const Pathname& path, Pathname& file_r) const;

        PMError provideDir (int medianr, const Pathname& path, Pathname& dir_r) const;

        bool isRemote (void) const;

        PMError changeUrl (const Url & newUrl_r);


        PMError releaseMedia( bool if_removable_r = false ) const;

  public:

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

  public:

    static PMError vconstruct( InstSrcPtr & nsrc_r, const Pathname & cachedir_r );

    static PMError vconstruct( InstSrcPtr & nsrc_r, const Pathname & cachedir_r,
                               const Url & mediaurl_r, const Pathname & produduct_dir_r,
                               Type type_r = T_AUTODETECT );

};


#endif // InstSrc_h

---