zypp/MediaSetAccess.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9
  10 #ifndef ZYPP_MediaSetAccess_H
  11 #define ZYPP_MediaSetAccess_H
  12
  13 #include <iosfwd>
  14 #include <string>
  15 #include <vector>
  16 #include <zypp/base/Function.h>
  17
  18 #include "zypp/base/ReferenceCounted.h"
  19 #include "zypp/base/NonCopyable.h"
  20 #include "zypp/base/Flags.h"
  21 #include "zypp/base/PtrTypes.h"
  22 #include "zypp/media/MediaManager.h"
  23 #include "zypp/Pathname.h"
  24 #include "zypp/CheckSum.h"
  25 #include "zypp/OnMediaLocation.h"
  26
  27 ///////////////////////////////////////////////////////////////////
  28 namespace zypp
  29 { /////////////////////////////////////////////////////////////////
  30
  31     DEFINE_PTR_TYPE(MediaSetAccess);
  32
  33     ///////////////////////////////////////////////////////////////////
  34     //
  35     //  CLASS NAME : MediaSetAccess
  36     //
  37     /**
  38      * Media access layer responsible for handling files distributed on a set
  39      * of media with media change and abort/retry/ingore user callback handling.
  40      *
  41      * This is provided as a means to handle CD or DVD sets accessible through
  42      * dir, iso, nfs or other URL schemes other than cd/dvd (see
  43      * \ref MediaManager for info on different implemented media backends).
  44      * Currently it handles URLs containing cdN, CDN, dvdN, and DVDN strings,
  45      * where N is the number of particular media in the set.
  46      *
  47      * Examples:
  48      * \code
  49      * "iso:/?iso=/path/to/iso/images/openSUSE-10.3-Alpha2plus-DVD-x86_64-DVD1.iso"
  50      * "dir:/path/to/cdset/sources/openSUSE-10.3/Alpha2plus/CD1"
  51      * \endcode
  52      *
  53      * MediaSetAccess accesses files on desired media by rewriting
  54      * the original URL, replacing the digit (usually) 1 with requested media
  55      * number and uses \ref MediaManager to get the files from the new URL.
  56      *
  57      * Additionaly, each media number can be assined a media verifier which
  58      * checks if the media we are trying to access is the desired one. See
  59      * \ref MediaVerifierBase for more info.
  60      *
  61      * Code example:
  62      * \code
  63      * Url url("dir:/path/to/cdset/sources/openSUSE-10.3/Alpha2plus/CD1");
  64      *
  65      * MediaSetAccess access(url);
  66      *
  67      * access.setVerifier(1, media1VerifierRef);
  68      * access.setVerifier(2, media2VerifierRef);
  69      *
  70      * Pathname file1 = "/some/file/on/media1";
  71      * Pathname providedfile1 = access.provideFile(file1, 1);
  72      * Pathname file2 = "/some/file/on/media2";
  73      * Pathname providedfile2 = access.provideFile(file1, 2);
  74      *
  75      * \endcode
  76      */
  77     class MediaSetAccess : public base::ReferenceCounted, private base::NonCopyable
  78     {
  79       friend std::ostream & operator<<( std::ostream & str, const MediaSetAccess & obj );
  80
  81     public:
  82       /**
  83        * Creates a callback enabled media access for specified \a url.
  84        *
  85        * \param url
  86        * \param prefered_attach_point Prefered attach (mount) point. Use, if
  87        *        you want to mount the media to a specific directory.
  88        */
  89       MediaSetAccess( const Url &url, const Pathname & prefered_attach_point = "" );
  90       /** \overload Also taking a \ref label. */
  91       MediaSetAccess( const std::string & label_r, const Url &url, const Pathname & prefered_attach_point = "" );
  92       ~MediaSetAccess();
  93
  94       /**
  95        * Sets a \ref MediaVerifier verifier for given media number.
  96        */
  97       void setVerifier( unsigned media_nr, media::MediaVerifierRef verifier );
  98
  99       /**
 100        * The label identifing this media set and to be sent in a media change request.
 101        */
 102       const std::string & label() const
 103       { return _label; }
 104
 105       /**
 106        * Set the label identifing this media set and to be sent in a media change request.
 107        */
 108       void setLabel( const std::string & label_r )
 109       { _label = label_r; }
 110
 111       enum ProvideFileOption
 112       {
 113         /**
 114          * The user is not asked anything, and the error
 115          * exception is just propagated */
 116         PROVIDE_DEFAULT = 0x0,
 117         PROVIDE_NON_INTERACTIVE = 0x1
 118       };
 119       ZYPP_DECLARE_FLAGS(ProvideFileOptions,ProvideFileOption);
 120
 121       /**
 122        * Provides a file from a media location.
 123        *
 124        * \param resource location of the file on media
 125        * \return local pathname of the requested file
 126        *
 127        * \throws MediaException if a problem occured and user has chosen to
 128        *         abort the operation. The calling code should take care
 129        *         to quit the current operation.
 130        * \throws SkipRequestException if a problem occured and user has chosen
 131        *         to skip the current operation. The calling code should continue
 132        *         with the next one, if possible.
 133        *
 134        *
 135        * If the resource is marked as optional, no Exception is thrown
 136        * and Pathname() is returned
 137        *
 138        * \note interaction with the user does not ocurr if
 139        * \ref ProvideFileOptions::NON_INTERACTIVE is set.
 140        *
 141        * \note OnMediaLocation::optional() hint has no effect on the transfer.
 142        *
 143        * \see zypp::media::MediaManager::provideFile()
 144        */
 145       Pathname provideFile( const OnMediaLocation & resource, ProvideFileOptions options = PROVIDE_DEFAULT );
 146
 147       /**
 148        * Provides \a file from media \a media_nr.
 149        *
 150        * \param file path to the file relative to media URL
 151        * \param media_nr the media number in the media set
 152        * \return local pathname of the requested file
 153        *
 154        * \note interaction with the user does not ocurr if
 155        * \ref ProvideFileOptions::NON_INTERACTIVE is set.
 156        *
 157        * \note OnMediaLocation::optional() hint has no effect on the transfer.
 158        *
 159        * \throws MediaException if a problem occured and user has chosen to
 160        *         abort the operation. The calling code should take care
 161        *         to quit the current operation.
 162        * \throws SkipRequestException if a problem occured and user has chosen
 163        *         to skip the current operation. The calling code should continue
 164        *         with the next one, if possible.
 165        * \see zypp::media::MediaManager::provideFile()
 166        */
 167       Pathname provideFile(const Pathname & file, unsigned media_nr = 1, ProvideFileOptions options = PROVIDE_DEFAULT );
 168
 169       /**
 170        * \deprecated
 171        * The same as provideFile(Pathname,unsigned) but this method does not
 172        * call the user callbacks, except of the case of
 173        * wrong media in the drive, and it won't throw an exception in any case.
 174        *
 175        * \return Path to the provided file on success, an empty Pathname() otherwise.
 176        * This method is obsolete.
 177        *
 178        * To avoid interaction with the user,
 179        * use \ref provideFile with \ref ProvideFileOptions::NON_INTERACTIVE
 180        * as an option. However you need to handle the exceptions yourself
 181        * in case of error. If you need ignore functionality, try
 182        * \ref Fetcher and set \ref OnMediaLocation::setOptional
 183        */
 184       ZYPP_DEPRECATED Pathname provideOptionalFile( const Pathname & file, unsigned media_nr = 1 );
 185
 186       /**
 187        * Release file from media.
 188        * This signal that file is not needed anymore.
 189        *
 190        * \param resource location of the file on media
 191        */
 192       void releaseFile( const OnMediaLocation &resource );
 193
 194
 195       /**
 196        * Release file from media.
 197        * This signal that file is not needed anymore.
 198        *
 199        * \param file path to the file relative to media URL
 200        * \param media_nr the media number in the media set
 201        */
 202       void releaseFile(const Pathname & file, unsigned media_nr = 1 );
 203
 204       /**
 205        * Provides direcotry \a dir from media number \a media_nr.
 206        *
 207        * \param dir path to the directory relative to media URL
 208        * \param recursive whether to provide the whole directory subtree
 209        * \param media_nr the media number in the media set
 210        * \return local pathname of the requested directory
 211        *
 212        * \throws MediaException if a problem occured and user has chosen to
 213        *         abort the operation. The calling code should take care
 214        *         to quit the current operation.
 215        * \todo throw SkipRequestException if a problem occured and user has chosen
 216        *         to skip the current operation. The calling code should continue
 217        *         with the next one, if possible.
 218        * \see zypp::media::MediaManager::provideDir()
 219        * \see zypp::media::MediaManager::provideDirTree()
 220        */
 221       Pathname provideDir(const Pathname & dir, bool recursive, unsigned media_nr = 1, ProvideFileOptions options = PROVIDE_DEFAULT );
 222
 223       /**
 224        * Checks if a file exists on the specified media, with user callbacks.
 225        *
 226        * \param file file to check
 227        * \param media_nr Media number
 228        *
 229        * \throws MediaException if a problem occured and user has chosen to
 230        *         abort the operation. The calling code should take care
 231        *         to quit the current operation.
 232        * \throws SkipRequestException if a problem occured and user has chosen
 233        *         to skip the current operation. The calling code should continue
 234        *         with the next one, if possible.
 235        * \see zypp::media::MediaManager::doesFileExist(MediaAccessId,const Pathname&)
 236        */
 237       bool doesFileExist(const Pathname & file, unsigned media_nr = 1 );
 238
 239       /**
 240        * Fills \ref retlist with directory information.
 241        */
 242       void dirInfo( filesystem::DirContent &retlist, const Pathname &dirname,
 243                     bool dots = true, unsigned media_nr = 1 );
 244
 245       /**
 246        * Release all attached media of this set.
 247        *
 248        * \throws MediaNotOpenException for invalid access IDs.
 249        */
 250       void release();
 251
 252       /**
 253        * Replaces media number in specified url with given \a medianr.
 254        *
 255        * Media number in the URL is searched for with regex
 256        * <tt> "^(.*(cd|dvd))([0-9]+)(\\.iso)$" </tt> for iso scheme and
 257        * with <tt> "^(.*(cd|dvd))([0-9]+)(/?)$" </tt> for other schemes.
 258        *
 259        * For cd and dvd scheme it returns the original URL, as well as for
 260        * URL which do not match the above regexes.
 261        *
 262        * \param url_r   original URL
 263        * \param medianr requested media number
 264        * \return        rewritten URL if applicable, the original URL otherwise
 265        */
 266       static Url rewriteUrl (const Url & url_r, const media::MediaNr medianr);
 267
 268     protected:
 269       /**
 270        * Provides the \a file from medium number \a media_nr and returns its
 271        * local path.
 272        *
 273        * \note   The method must not throw if \a checkonly is <tt>true</tt>.
 274        *
 275        * \throws MediaException \a checkonly is <tt>false</tt> and
 276        *         a problem occured and user has chosen to
 277        *         abort the operation. The calling code should take care
 278        *         to quit the current operation.
 279        * \throws SkipRequestException \a checkonly is <tt>false</tt> and
 280        *         a problem occured and user has chosen
 281        *         to skip the current operation. The calling code should continue
 282        *         with the next one, if possible.
 283        */
 284       Pathname provideFileInternal( const OnMediaLocation &resource, ProvideFileOptions options );
 285
 286       typedef function<void( media::MediaAccessId, const Pathname & )> ProvideOperation;
 287
 288       void provide( ProvideOperation op, const OnMediaLocation &resource, ProvideFileOptions options );
 289
 290       media::MediaAccessId getMediaAccessId (media::MediaNr medianr);
 291       virtual std::ostream & dumpOn( std::ostream & str ) const;
 292
 293     private:
 294       /** Media or media set URL */
 295       Url _url;
 296
 297       /**
 298        * Prefered mount point.
 299        *
 300        * \see MediaManager::open(Url,Pathname)
 301        * \see MediaHandler::_attachPoint
 302        */
 303       Pathname _prefAttachPoint;
 304
 305       std::string _label;
 306
 307       typedef std::map<media::MediaNr, media::MediaAccessId> MediaMap;
 308       typedef std::map<media::MediaNr, media::MediaVerifierRef > VerifierMap;
 309
 310       /** Mapping between media number and Media Access ID */
 311       MediaMap _medias;
 312       /** Mapping between media number and corespondent verifier */
 313       VerifierMap _verifiers;
 314     };
 315     ///////////////////////////////////////////////////////////////////
 316     ZYPP_DECLARE_OPERATORS_FOR_FLAGS(MediaSetAccess::ProvideFileOptions);
 317
 318     /** \relates MediaSetAccess Stream output */
 319     inline std::ostream & operator<<( std::ostream & str, const MediaSetAccess & obj )
 320     { return obj.dumpOn( str ); }
 321
 322
 323 } // namespace zypp
 324 ///////////////////////////////////////////////////////////////////
 325 #endif // ZYPP_SOURCE_MediaSetAccess_H