MediaHandler.h

Go to the documentation of this file.

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

   File:        MediaHandler.h

   Author:      Klaus Kaempf <kkaempf@suse.de>
   Maintainer:  Klaus Kaempf <kkaempf@suse.de>

   Purpose:     Abstract base class for 'physical' MediaHandler
                like MediaCD, MediaDIR, ...

/-*/
#ifndef MediaHandler_h
#define MediaHandler_h

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

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

#include <y2pm/MediaAccess.h>

//
//      CLASS NAME : MediaHandler
class MediaHandler {
    friend std::ostream & operator<<( std::ostream & str, const MediaHandler & obj );

    public:

        typedef MediaError Error;

    private:

        Pathname _attachPoint;

        bool _tmp_attachPoint;

        Pathname _localRoot;

        bool _does_download;

        bool _isAttached;

    protected:

        const Url _url;

        const Pathname & attachPoint() const { return _attachPoint; }

    protected:

        //
        // Real action interface to be overloaded by concrete handler.
        //

        virtual PMError attachTo(bool next = false) = 0;

        virtual PMError disconnectFrom() { return Error::E_ok; }

        virtual PMError releaseFrom( bool eject ) = 0;

        virtual void forceEject() {}

        virtual PMError getFile( const Pathname & filename ) const = 0;

        virtual PMError getFileCopy( const Pathname & srcFilename, const Pathname & targetFilename ) const;
                         

        virtual PMError getDir( const Pathname & dirname, bool recurse_r ) const = 0;

        virtual PMError getDirInfo( std::list<std::string> & retlist,
                                    const Pathname & dirname, bool dots = true ) const = 0;

        virtual PMError getDirInfo( PathInfo::dircontent & retlist,
                                    const Pathname & dirname, bool dots = true ) const = 0;

  protected:

        PMError getDirectoryYast( std::list<std::string> & retlist,
                                  const Pathname & dirname, bool dots = true ) const;

        PMError getDirectoryYast( PathInfo::dircontent & retlist,
                                  const Pathname & dirname, bool dots = true ) const;

  public:

        MediaHandler ( const Url&       url_r,
                       const Pathname & attach_point_r,
                       const Pathname & urlpath_below_attachpoint_r,
                       const bool       does_download_r );

        virtual ~MediaHandler();

    public:

        //
        // MediaAccess interface. Does common checks and logging.
        // Invokes real action if necessary.
        //

        Url::Protocol protocol() const { return _url.protocol(); }

        Url url() const { return _url; }

        PMError attach(bool next);

        bool isAttached() const { return _isAttached; }

        const Pathname & localRoot() const { return _localRoot; }

         Pathname localPath( const Pathname & pathname ) const;

        PMError disconnect();

        PMError release( bool eject = false );

        PMError provideFile( Pathname filename ) const;
    
        PMError provideFileCopy( Pathname srcFilename, Pathname targetFilename) const;
    
        PMError provideDir( Pathname dirname ) const;

        PMError provideDirTree( Pathname dirname ) const;

        PMError releaseFile( const Pathname & filename ) const { return releasePath( filename ); }

        PMError releaseDir( const Pathname & dirname ) const { return releasePath( dirname ); }

        PMError releasePath( Pathname pathname ) const;

    public:

        PMError dirInfo( std::list<std::string> & retlist,
                         const Pathname & dirname, bool dots = true ) const;

        PMError dirInfo( PathInfo::dircontent & retlist,
                         const Pathname & dirname, bool dots = true ) const;
};


#define MEDIA_HANDLER_API                                               \
    protected:                                                          \
        virtual PMError attachTo (bool next = false);                   \
        virtual PMError releaseFrom( bool eject );                      \
        virtual PMError getFile( const Pathname & filename ) const;     \
        virtual PMError getDir( const Pathname & dirname, bool recurse_r ) const;       \
        virtual PMError getDirInfo( std::list<std::string> & retlist,   \
                                    const Pathname & dirname, bool dots = true ) const; \
        virtual PMError getDirInfo( PathInfo::dircontent & retlist,     \
                                    const Pathname & dirname, bool dots = true ) const;


#endif // MediaHandler_h

---