zypp/media/MediaManager.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9 /** \file zypp/media/MediaManager.h
  10  *
  11 */
  12 #ifndef ZYPP_MEDIA_MEDIAMANAGER_H
  13 #define ZYPP_MEDIA_MEDIAMANAGER_H
  14
  15 #include "zypp/media/MediaAccess.h"
  16
  17 #include "zypp/APIConfig.h"
  18 #include "zypp/base/NonCopyable.h"
  19 #include "zypp/base/PtrTypes.h"
  20 #include "zypp/Pathname.h"
  21 #include "zypp/Url.h"
  22
  23 #include <list>
  24
  25
  26 //////////////////////////////////////////////////////////////////////
  27 namespace zypp
  28 { ////////////////////////////////////////////////////////////////////
  29
  30   ////////////////////////////////////////////////////////////////////
  31   namespace media
  32   { //////////////////////////////////////////////////////////////////
  33
  34
  35     ///////////////////////////////////////////////////////////////////
  36     typedef zypp::RW_pointer<MediaAccess> MediaAccessRef;
  37
  38     // OBSOLETE HERE:
  39     typedef MediaAccessId                 MediaId;
  40     typedef unsigned int                  MediaNr;
  41
  42
  43     ///////////////////////////////////////////////////////////////////
  44     // forward declaration
  45     class MountEntry;
  46     class MediaManager_Impl;
  47
  48     ///////////////////////////////////////////////////////////////////
  49     //
  50     // CLASS NAME : MediaVerifierBase
  51     //
  52     /**
  53      * Interface to implement a media verifier.
  54      */
  55     class MediaVerifierBase //: private zypp::NonCopyable
  56     {
  57     public:
  58       MediaVerifierBase()
  59       {}
  60
  61       virtual
  62       ~MediaVerifierBase()
  63       {}
  64
  65       /**
  66        * Returns a string with some info about the verifier.
  67        * By default, the type info name is returned.
  68        */
  69       virtual std::string
  70       info() const;
  71
  72       /*
  73       ** Check if the specified attached media contains
  74       ** the desired media (e.g. SLES10 CD1).
  75       */
  76       virtual bool
  77       isDesiredMedia(const MediaAccessRef &ref) = 0;
  78     };
  79
  80
  81     ///////////////////////////////////////////////////////////////////
  82     //
  83     // CLASS NAME : NoVerifier
  84     //
  85     /**
  86      * Dummy default media verifier, which is always happy.
  87      */
  88     class NoVerifier : public MediaVerifierBase
  89     {
  90     public:
  91       NoVerifier(): MediaVerifierBase()
  92       {}
  93
  94       virtual
  95       ~NoVerifier()
  96       {}
  97
  98       /**
  99        * Returns the "zypp::media::NoVerifier" string.
 100        */
 101       virtual std::string
 102       info() const;
 103
 104       /*
 105       ** Don't check if the specified attached media contains
 106       ** the desired media number. Always return true.
 107       */
 108       virtual bool
 109       isDesiredMedia(const MediaAccessRef &ref)
 110       {
 111         (void)ref;
 112         return true;
 113       }
 114     };
 115
 116
 117     ///////////////////////////////////////////////////////////////////
 118     //
 119     // CLASS NAME : MediaVerifierRef
 120     //
 121     /**
 122      * A shared reference to the MediaVerifier implementation.
 123      */
 124     typedef zypp::RW_pointer<MediaVerifierBase> MediaVerifierRef;
 125
 126
 127     ///////////////////////////////////////////////////////////////////
 128     //
 129     // CLASS NAME : MediaManager
 130     //
 131     /**
 132      * Manages access to the 'physical' media, e.g CDROM drives,
 133      * Disk volumes, directory trees, etc, using \ref MediaAccessUrl's.
 134      *
 135      * \note The MediaManager class is just an envelope around an
 136      *       inner singleton like implementation.<br>
 137      *       That is, you can create as many managers as you want,
 138      *       also temporary in a function call.<br>
 139      *       But <b>don't</b> declare static MediaManager instances,
 140      *       unless you want to force (mutex) initialization order
 141      *       problems!
 142      *
 143      * \section MediaAccessUrl Media Access Url
 144      * The MediaManager uses several media access handlers (backends),
 145      * that can be specified by a Media Access URL in its open() method.
 146      *
 147      * All URL's may contain following query parameters, that are
 148      * reserved by the Source classes and unused/ignored by the media
 149      * manager:
 150      * - <tt>alias</tt>: A source specific media alias string.
 151      *
 152      * Currently, following access handlers (backends) are implemented:
 153      *   - \ref MediaCD_Url
 154      *   - \ref MediaDISK_Url
 155      * .
 156      *   - \ref MediaISO_Url
 157      *   - \ref MediaDIR_Url
 158      * .
 159      *   - \ref MediaNFS_Url
 160      *   - \ref MediaCIFS_Url
 161      *   - \ref MediaCurl_Url
 162      *
 163      * \subsection MediaCD_Url MediaCD - CD/DVD drives (cd, dvd)
 164      * The access handler for media on CD / DVD drives.
 165      *   - Scheme:
 166      *     - <b>cd</b>: Requires a drive supporting CD media.
 167      *     - <b>dvd</b>: Prefers a drive supporting DVD media.
 168      *   - Examples:
 169      *     \code
 170      *       "cd:/"
 171      *       "cd:/?devices=/dev/hda,/dev/hdb"
 172      *       "cd:/subdir?devices=/dev/hda,/dev/hdb"
 173      *
 174      *       "dvd:/"
 175      *       "dvd:/?devices=/dev/hda,/dev/hdb"
 176      *       "dvd:/subdir?devices=/dev/hda,/dev/hdb"
 177      *     \endcode
 178      *     Note: You can use either "dvd:/" (just path, no authority)
 179      *           or "dvd:///" (path and empty authority).
 180      *   - Query parameters:
 181      *     - <tt>devices</tt>:
 182      *       Optional parameter, containing a comma separated list of
 183      *       block device names to use, e.g.: "/dev/sr0,/dev/sr1".
 184      *       <br>
 185      *       The device names will be verified using a HAL query. If one
 186      *       of the provided devices is not usable (not a block device,
 187      *       or does not support required media type), an exception is
 188      *       thrown.
 189      *       <br>
 190      *       If the devices parameter is not provided (or empty), all
 191      *       avaliable CD/DVD drives 'detected' using a HAL query. The
 192      *       preferred drive (used as first drive) is the drive pointed
 193      *       to by the symlink "/dev/dvd" ("dvd" scheme only) or
 194      *       "/dev/cdrom".
 195      *   - Authority:
 196      *     A non-empty authority URL component (e.g. containing a host
 197      *     name) is not allowed.
 198      *   - Path name:
 199      *     Mandatory URL component, that specifies a subdirectory on the
 200      *     CD/DVD, where the desired files are located.
 201      *
 202      * \subsection MediaDISK_Url MediaDISK - HD disk volumes (hd)
 203      * The access handler for media on a disk volume (partition).
 204      *   - Scheme:
 205      *     - <b>hd</b>
 206      *   - Examples:
 207      *     \code
 208      *       "hd:/?device=/dev/hda1"
 209      *       "hd:/subdir?device=/dev/sda1"
 210      *       "hd:/subdir?device=/dev/sda1&filesystem=reiserfs"
 211      *     \endcode
 212      *     Note: You can use either "hd:/" (just path, no authority)
 213      *     or "hd:///" (path and empty authority).
 214      *   - Query parameters:
 215      *     - <tt>device</tt>:
 216      *       Mandatory parameter specifying the name of the block device of
 217      *       the partition to mount.
 218      *     - <tt>filesystem</tt>:
 219      *       The name of the filesystem. Defaults to "auto".
 220      *   - Authority:
 221      *     A non-empty authority URL component is not allowed.
 222      *   - Path name:
 223      *     Mandatory URL component, that specifies a subdirectory on the disk
 224      *     partition, where the desired files are located.
 225      *
 226      * \subsection MediaDIR_Url MediaDIR - Local directory tree (dir, file)
 227      * The access handler to media stored in a local directory tree.
 228      *   - Scheme:
 229      *     - <b>dir</b>
 230      *     - <b>file</b>
 231      *   - Examples:
 232      *     \code
 233      *       "dir:/directory/name"
 234      *       "file:/directory/name"
 235      *     \endcode
 236      *   - Query parameters:
 237      *     none
 238      *   - Authority:
 239      *     A non-empty authority URL component (e.g. containing
 240      *     a host name) is not allowed.
 241      *   - Path name:
 242      *     Mandatory URL component, that specifies a directory, where
 243      *     the desired files are located.
 244      *
 245      * \subsection MediaISO_Url MediaISO - Loopback ISO images (iso)
 246      * The access handler for media in a ISO image (loopback mount).
 247      *   - Scheme:
 248      *     - <b>iso</b>
 249      *   - Examples:
 250      *     \code
 251      *       "iso:/?iso=/path/to/CD1.iso"
 252      *       "iso:/?iso=CD1.iso&url=dir:/path/to"
 253      *
 254      *       "iso:/?iso=CD1.iso&url=nfs://server/path/to/media"
 255      *       "iso:/?iso=CD1.iso&url=hd:/?device=/dev/hda"
 256      *
 257      *        "iso:/subdir?iso=DVD1.iso&url=nfs://nfs-server/directory&mnt=/nfs/attach/point&filesystem=udf"
 258      *     \endcode
 259      *   - Query parameters:
 260      *     - <tt>iso</tt>:
 261      *       Mandatory parameter specifying the name of the iso file.<br>
 262      *       If the url parameter is missed, the iso parameter has to contain
 263      *       an absolute iso file name.
 264      *     - <tt>url</tt>:
 265      *       Optional parameter specifying the URL to the directory containing
 266      *       the iso file.<br>
 267      *       The supported URL schemes are: <i><b>hd</b>, <b>dir</b>,
 268      *       <b>file</b>, <b>nfs</b>, <b>nfs4</b>, <b>smb</b>, <b>cifs</b>.</i>
 269      *     - <tt>mnt</tt>:
 270      *       Optional parameter specifying the prefered attach point for the
 271      *       source media url.
 272      *     - <tt>filesystem</tt>:
 273      *       Optional name of the filesystem used in the iso file. Defaults
 274      *       to "auto".
 275      *   - Authority:
 276      *     A non-empty authority URL component is not allowed.
 277      *   - Path name:
 278      *     Mandatory URL component, that specifies a subdirectory inside of
 279      *     the iso file, where the desired files are located.
 280      *
 281      * \subsection MediaNFS_Url MediaNFS  - NFS directory tree (nfs)
 282      * The access handler for media on NFS exported directory tree.
 283      *   - Scheme:
 284      *     - <b>nfs</b>
 285      *     - <b>nfs</b>
 286      *   - Examples:
 287      *     \code
 288      *        "nfs://nfs-server/exported/path"
 289      *        "nfs://nfs-server/exported/path?mountoptions=ro"
 290      *        "nfs://nfs-server/exported/path&type=nfs4"
 291      *        "nfs4://nfs-server/exported/path"
 292      *     \endcode
 293      *   - Query parameters:
 294      *     - <tt>mountoptions</tt>:
 295      *       The mount options separated by comma ','.
 296      *       Default is the "ro" option.
 297      *     - <tt>type=nfs4</tt>:
 298      *       Whether to mount as nfs4. This is the default for scheme nfs4.
 299       *   - Authority:
 300      *     The authority component has to provide a hostname.
 301      *     Username, password and port are currently ignored.
 302      *   - Path name:
 303      *     Mandatory URL component, that specifies the exported
 304      *     (sub-)directory on the NFS server, where the desired
 305      *     files are located.
 306      *
 307      * \subsection MediaCIFS_Url MediaCIFS - CIFS/SMB directory tree (cifs, smb)
 308      * The access handler for media in a CIFS/SMB shared directory tree.
 309      *   - Scheme:
 310      *     - <b>cifs</b>
 311      *     - <b>smb</b>
 312      *   - Examples:
 313      *     \code
 314      *       "cifs://servername/share/path/on/the/share"
 315      *       "cifs://username:passwd@servername/share/path/on/the/share?mountoptions=ro"
 316      *       "cifs://username:passwd@servername/share/path/on/the/share?mountoptions=noguest"
 317      *       "smb://servername/share/path/on/the/share"
 318      *       "smb://username:passwd@servername/share/path/on/the/share?mountoptions=ro"
 319      *     \endcode
 320      *     Note: There is no difference between cifs and smb scheme
 321      *     (any more). In both cases the 'cifs' filesystem is used.
 322      *   - Query parameters:
 323      *     - <tt>mountoptions</tt>:
 324      *       The mount options separated by a comma ','. Default are the
 325      *       "ro" and "guest" options. Specify "noguest" to turn off
 326      *       "guest". This is necessary if Samba is configured to reject
 327      *       guest connections.
 328      *     - <tt>workgroup</tt> or <tt>domain</tt>:
 329      *       The name of the workgroup.
 330      *     - <tt>username</tt>:
 331      *       Alternative username to username in URL authority.
 332      *     - <tt>password</tt>:
 333      *       Alternative password to password in URL authority.
 334      *     - <tt>user</tt>:
 335      *       Alternative username (cifs specific variant)
 336      *     - <tt>pass</tt>:
 337      *       Alternative password (cifs specific variant)
 338      *   - Authority:
 339      *     The authority component has to provide a hostname. Optionally
 340      *     also a username and password.
 341      *   - Path name:
 342      *     Mandatory URL component, that specifies the share name with
 343      *     optional subdirectory, where the desired files are located.
 344      *
 345      * \subsection MediaCurl_Url MediaCurl - FTP/HTTP directory tree (ftp, tftp, http, https)
 346      * The access handler to media directory tree on a ftp/http server.
 347      *   - Scheme:
 348      *     - <b>ftp</b>
 349      *     - <b>tftp</b>
 350      *     - <b>http</b>
 351      *     - <b>https</b>
 352      *   - Examples:
 353      *     \code
 354      *       "ftp://server/relative/path/to/media/dir"
 355      *       "ftp://server/%2fabsolute/path/to/media/dir"
 356      *
 357      *       "ftp://user:pass@server/path/to/media/dir"
 358      *       "ftp://user:pass@server/%2f/home/user/path/to/media/dir"
 359      *
 360      *       "http://server/path/on/server"
 361      *       "http://user:pass@server/path"
 362      *       "https://user:pass@server/path?proxy=foo&proxyuser=me&proxypass=pw"
 363      *     \endcode
 364      *     Note: The "ftp" url scheme supports absolute and relative
 365      *     paths to the default ftp server directory
 366      *     (<a href="http://rfc.net/rfc1738.html">RFC1738, Section 3.2.2</a>).<br>
 367      *     To use an absolute path, you have to prepend the path with an
 368      *     additional slash, what results in a "/%2f" combination
 369      *     (second "/" encoded to "%2f") at the begin of the URL path.
 370      *     <br>
 371      *     This is important, especially in user authenticated ftp,
 372      *     where the users home is usually the default directory of the
 373      *     server (except when the server chroots into the users home
 374      *     directory).
 375      *     <br>
 376      *     For example, if the user "user" has a home directory
 377      *     "/home/user", you can use either an URL with a relative path
 378      *     to the home directory "ftp://user:pass@server/path/to/media"
 379      *     or the absolute path
 380      *     "ftp://user:pass@server/%2fhome/user/path/to/media" -- both
 381      *     URLs points to the same directory on the server.
 382      *   - Query parameters:
 383      *     - <tt>cookies</tt>:
 384      *       Turn off using cookies by setting it to "0" (or false, no, off).
 385      *     - <tt>proxy</tt>:
 386      *       A proxy hostname or hostname and port separated by ':'.
 387      *       Setting the hostname to '_none_' explicitly disables the use of a
 388      *       proxy even if configured in /etc/sysconfig/proxy or the environment.
 389      *     - <tt>proxyport</tt>:
 390      *       Alternative way to provide the proxy port.
 391      *     - <tt>proxyuser</tt>:
 392      *       The proxy username.
 393      *     - <tt>proxypass</tt>:
 394      *       The proxy password.
 395      *     - <tt>ssl_capath</tt>:
 396      *       The absolute CA directory to use, default is /etc/ssl/certs.
 397      *     - <tt>ssl_verify</tt>: Flag to modify the ssl verify behaviour.
 398      *       Valid values are: 'yes', 'no' and a comma separated list of
 399      *       'host' and 'peer' flags.
 400      *       - 'no':
 401      *         disables ssl verify
 402      *       - 'yes':
 403      *         enables ssl verify, this is the default
 404      *         and is equivalent to 'host,peer'.
 405      *       - 'host': The server is considered the intended one, when the
 406      *         'Common Name' field or a 'Subject Alternate Name' field in
 407      *         the certificate matches the host name in the URL.
 408      *       - 'peer': Verifies whether the certificate provided by the
 409      *         server is authentic against the chain of digital signatures
 410      *         found in <tt>ssl_capath</tt>.
 411      *     - <tt>timeout</tt>:
 412      *       Transfer timeout in seconds between 0 and 3600, 0 disables
 413      *       the timeout, default timeout is 180 seconds.
 414      *     - <tt>auth</tt>: A comma separated list of http authentication
 415      *       method names to use: 'basic', 'digest', 'ntlm', 'negotiate',
 416      *       'spnego', 'gssnego'.
 417      *       Note, that this list depends on the list of methods supported
 418      *       by the curl library.
 419      *     - <tt>mediahandler</tt>: Set the mediahandler for this url
 420      *     Valid values are: 'curl', 'multicurl'
 421      *   - Authority:
 422      *     The authority component has to provide a hostname. Optionally
 423      *     also a username and password. In case of the 'ftp' scheme,
 424      *     username and password defaults to 'anonymous' and 'yast2@'.
 425      *   - Path name:
 426      *     Mandatory URL component, that specifies the path name on the
 427      *     server, where the desired files are located.
 428      *
 429      *   Proxy settings: If no proxy settings are present in tha URLs
 430      *   query parameters, the media handler reads the system wide proxy
 431      *   settings from the <tt>/etc/sysconfig/proxy</tt> file.
 432      *   If a proxy setting was present, but the proxy password not,
 433      *   it attempts to read the <tt>proxy-user</tt> variable from the
 434      *   <tt>~/.curlrc</tt> (<tt>/root/.curlrc</tt>) file.
 435      *   <br>
 436      *   If no proxy setting was present, then libzypp does not pass any
 437      *   proxy settings to curl, but curl fallbacks to use the content of
 438      *   the <tt>http_proxy</tt>, <tt>ftp_proxy</tt>, etc environment
 439      *   variables.
 440      *
 441      * \subsection MediaPlugin_Url MediaPlugin - custom media handler
 442      * Media access is delegated to a script located in the libzypp
 443      * media plugin directory. The URLs query options are translated
 444      * into commandline arguments passed to the script.
 445      *   - Scheme:
 446      *     - <b>plugin</b>
 447      *   - Examples:
 448      *     \code
 449      *       "plugin:script?loptv=lvalue&v=optv&lopt=&o&=foo"
 450      *                      \__________/ \____/ \___/ | \_/
 451      *                __________/__    ____/_    _|_  \   \___
 452      *              /              \ /       \ /    \ /\ /    \
 453      *       script --loptv "lvalue" -v "optv" --lopt -o -- foo
 454      *     \endcode
 455      *   - Query parameters:
 456      *     - The URLs query options are translated into commandline
 457      *       arguments passed to the script.
 458      *     - \b Note: No option may appear twice, as the <tt>(option,value)</tt>
 459      *       pairs are stored in a hash.
 460      *     - \b Note: The order in which the query options are passes to the
 461      *       script is arbitrary, except for an option with an empty key, which
 462      *       is translated into <tt>'-- value'</tt> and passed as final option.
 463      *     - <tt>'c[=[value]]'</tt> ist passed as <tt>'-c [value]'</tt>
 464      *     - <tt>'word[=[value]]'</tt> ist passed as <tt>'--word [value]'</tt>
 465      *     - <tt>'[=value]'</tt> ist passed as last args as <tt>'-- [value]'</tt>
 466      *   - \c script<->libzypp communication:
 467      *     - \TODO to be documented.
 468      */
 469     class MediaManager: private zypp::base::NonCopyable
 470     {
 471     public:
 472       /**
 473        * Creates a MediaManager envelope instance.
 474        *
 475        * In the case, that the inner implementation is not already
 476        * allocated, and the MediaManager constructor was unable to
 477        * allocate it, a std::bad_alloc exception is thrown.
 478        *
 479        * All further instances increase the use counter only.
 480        *
 481        * \throws std::bad_alloc
 482        */
 483       MediaManager();
 484
 485       /**
 486        * Destroys MediaManager envelope instance.
 487        * Decreases the use counter of the inner implementation.
 488        */
 489       ~MediaManager();
 490
 491       /**
 492        * Opens the media access for specified with the url.
 493        *
 494        * If the \p preferred_attach_point parameter does not
 495        * point to a usable attach point directory, the media
 496        * manager automatically creates a temporary attach
 497        * point in a default directory. This default directory
 498        * can be changed using setAttachPrefix() function.
 499        *
 500        * Remember to close() each id you've opened and not
 501        * need any more. It is like a new and delete!
 502        *
 503        * \param  url The \ref MediaAccessUrl.
 504        * \param  preferred_attach_point The preferred, already
 505        *         existing directory, where the media should be
 506        *         attached.
 507        * \return a new media access id.
 508        * \throws std::bad_alloc
 509        * \throws MediaException
 510        */
 511       MediaAccessId
 512       open(const Url &url, const Pathname & preferred_attach_point = "");
 513
 514       /**
 515        * Close the media access with specified id.
 516        * \param accessId The media access id to close.
 517        */
 518       void
 519       close(MediaAccessId accessId);
 520
 521       /**
 522        * Query if the media access is open / exists.
 523        *
 524        * \param accessId The media access id to query.
 525        * \return true, if access id is known and open.
 526        */
 527       bool
 528       isOpen(MediaAccessId accessId) const;
 529
 530       /**
 531        * Query the protocol name used by the media access
 532        * handler. Similar to url().getScheme().
 533        *
 534        * \param accessId The media access id to query.
 535        * \return The protocol name used by the media access
 536        *         handler, otherwise 'unknown'.
 537        * \throws MediaNotOpenException for invalid access id.
 538        */
 539       std::string
 540       protocol(MediaAccessId accessId) const;
 541
 542       /**
 543        * Hint if files are downloaded or not.
 544        * \param accessId The media access id to query.
 545        * \return True, if provideFile downloads files.
 546        */
 547       bool
 548       downloads(MediaAccessId accessId) const;
 549
 550       /**
 551        * Returns the \ref MediaAccessUrl of the media access id.
 552        *
 553        * \param accessId The media access id to query.
 554        * \return The \ref MediaAccessUrl used by the media access id.
 555        * \throws MediaNotOpenException for invalid access id.
 556        */
 557       Url
 558       url(MediaAccessId accessId) const;
 559
 560     public:
 561       /**
 562        * Add verifier implementation for the specified media id.
 563        * By default, the NoVerifier is used.
 564        *
 565        * \param accessId A media access id.
 566        * \param verifier The new verifier.
 567        * \throws MediaNotOpenException for invalid access id.
 568        */
 569       void
 570       addVerifier(MediaAccessId accessId,
 571                   const MediaVerifierRef &verifier);
 572
 573       /**
 574        * Remove verifier for specified media id.
 575        * It resets the verifier to NoVerifier.
 576        *
 577        * \param accessId A media access id.
 578        * \throws MediaNotOpenException for invalid access id.
 579        */
 580       void
 581       delVerifier(MediaAccessId accessId);
 582
 583     public:
 584       /**
 585        * Set or resets the directory name, where the media manager
 586        * handlers create their temporary attach points (see open()
 587        * function).
 588        * It has effect to newly created temporary attach points only.
 589        *
 590        * \param attach_prefix The new prefix for temporary attach
 591        *        points, or empty pathname to reset to defaults.
 592        * \return True on success, false if the \p attach_prefix
 593        *         parameters contains a path name, that does not
 594        *         point to a writable directory.
 595        */
 596       bool
 597       setAttachPrefix(const Pathname &attach_prefix);
 598
 599       /**
 600        * Attach the media using the concrete handler (checks all devices).
 601        *
 602        * Remember to release() or close() each id you've attached
 603        * and not need any more. Attach is like an open of a file!
 604        *
 605        * \param accessId A media access id.
 606        * \throws MediaNotOpenException for invalid access id.
 607        */
 608       void
 609       attach(MediaAccessId accessId);
 610
 611       /**
 612        * Release the attached media and optionally eject.
 613        *
 614        * If the \p ejectDev parameter is not empty all other access
 615        * id's are released and the specified drive (CD/DVD drive) is
 616        * ejected.
 617        *
 618        * \param accessId A media access id.
 619        * \param ejectDev Device to eject. None if empty.
 620        * \throws MediaNotOpenException for invalid access id.
 621        */
 622       void
 623       release(MediaAccessId accessId, const std::string & ejectDev = "");
 624
 625       /**
 626        * Release all attached media.
 627        */
 628       void
 629       releaseAll();
 630
 631       /**
 632        * Disconnect a remote media.
 633        *
 634        * This is useful for media which e.g. holds open a connection
 635        * to a server like FTP. After calling disconnect() the media
 636        * object (attach point) is still valid and files are present.
 637        *
 638        * But after calling disconnect() it's not possible to call
 639        * fetch more data using the provideFile() or provideDir()
 640        * functions anymore.
 641        *
 642        * \param accessId A media access id.
 643        * \throws MediaNotOpenException for invalid access id.
 644        */
 645       void
 646       disconnect(MediaAccessId accessId);
 647
 648       /**
 649        * Check if media is attached or not.
 650        *
 651        * \param accessId A media access id.
 652        * \return True if media is attached.
 653        * \throws MediaNotOpenException for invalid access id.
 654        */
 655       bool
 656       isAttached(MediaAccessId accessId) const;
 657
 658       /**
 659        * Returns information if media is on a shared
 660        * physical device or not.
 661        *
 662        * \param accessId A media access id.
 663        * \return True if it is shared, false if not.
 664        * \throws MediaNotOpenException for invalid access id.
 665        */
 666       bool
 667       isSharedMedia(MediaAccessId accessId) const;
 668
 669       /**
 670        * Ask the registered verifier if the attached
 671        * media is the desired one or not.
 672        *
 673        * \param accessId A media access id.
 674        * \return True if media is attached and desired
 675        *         according to the actual verifier.
 676        * \throws MediaNotOpenException for invalid access id.
 677        */
 678       bool
 679       isDesiredMedia(MediaAccessId accessId) const;
 680
 681       /**
 682        * Ask the specified verifier if the attached
 683        * media is the desired one or not.
 684        *
 685        * \param accessId A media access id.
 686        * \param verifier A verifier to use.
 687        * \return True if media is attached and desired
 688        *         according to the specified verifier.
 689        * \throws MediaNotOpenException for invalid access id.
 690        */
 691       bool
 692       isDesiredMedia(MediaAccessId           accessId,
 693                      const MediaVerifierRef &verifier) const;
 694
 695       /**
 696        * Simple check, based on media's URL scheme, telling whether the
 697        * it is possible to physically change the media inside its drive, like
 698        * CDs or DVDs. Useful to decide whether to request media change from
 699        * user or not.
 700        *
 701        * \param accessId The media access id.
 702        * \return <tt>false</tt> if the media is not changeable,
 703        *         <tt>true</tt> otherwise.
 704        * \throws MediaNotOpenException for invalid access id.
 705        */
 706       bool
 707       isChangeable(MediaAccessId accessId);
 708
 709       /**
 710        * Return the local directory that corresponds to medias url,
 711        * no matter if media isAttached or not. Files requested will
 712        * be available at 'localRoot() + filename' or even better
 713        * 'localPath( filename )'
 714        *
 715        * \param accessId A media access id.
 716        * \returns The directory name pointing to the media root
 717        *          in local filesystem or an empty pathname if the
 718        *          media is not attached.
 719        * \throws MediaNotOpenException for invalid access id.
 720        */
 721       Pathname
 722       localRoot(MediaAccessId accessId) const;
 723
 724       /**
 725        * Shortcut for 'localRoot() + pathname', but returns an empty
 726        * pathname if media is not attached.
 727        * Files provided will be available at 'localPath(filename)'.
 728        *
 729        * \param accessId A media access id.
 730        * \param pathname A path name relative to the localRoot().
 731        * \returns The directory name in local filesystem pointing
 732        *          to the desired relative pathname on the media
 733        *          or an empty pathname if the media is not attached.
 734        * \throws MediaNotOpenException for invalid access id.
 735        */
 736       Pathname
 737       localPath(MediaAccessId accessId, const Pathname & pathname) const;
 738
 739     public:
 740       /**
 741        * Provide provide file denoted by relative path below of the
 742        * 'attach point' of the specified media and the path prefix
 743        * on the media.
 744        *
 745        * \param accessId  The media access id to use.
 746        * \param filename  The filename to provide, relative to localRoot().
 747        *
 748        * \throws MediaNotOpenException in case of invalid access id.
 749        * \throws MediaNotAttachedException in case, that the media is not attached.
 750        * \throws MediaNotDesiredException in case, that the media verification failed.
 751        * \throws MediaNotAFileException in case, that the requested filename is not a file.
 752        * \throws MediaFileNotFoundException in case, that the requested filenamedoes not exists.
 753        * \throws MediaWriteException in case, that the file can't be copied from from remote source.
 754        * \throws MediaSystemException in case a system operation fails.
 755        * \throws MediaException derived exception, depending on the url (handler).
 756        */
 757
 758       void
 759       provideFile(MediaAccessId   accessId,
 760                   const Pathname &filename ) const;
 761
 762       /**
 763        * FIXME: see MediaAccess class.
 764        */
 765       void
 766       provideDir(MediaAccessId   accessId,
 767                  const Pathname &dirname) const;
 768
 769       /**
 770        * FIXME: see MediaAccess class.
 771        */
 772       void
 773       provideDirTree(MediaAccessId  accessId,
 774                      const Pathname &dirname) const;
 775
 776       /**
 777        * FIXME: see MediaAccess class.
 778        */
 779       void
 780       releaseFile(MediaAccessId   accessId,
 781                   const Pathname &filename) const;
 782
 783       /**
 784        * FIXME: see MediaAccess class.
 785        */
 786       void
 787       releaseDir(MediaAccessId   accessId,
 788                  const Pathname &dirname) const;
 789
 790       /**
 791        * FIXME: see MediaAccess class.
 792        */
 793       void
 794       releasePath(MediaAccessId   accessId,
 795                   const Pathname &pathname) const;
 796
 797       /**
 798        * FIXME: see MediaAccess class.
 799        */
 800       void
 801       dirInfo(MediaAccessId           accessId,
 802               std::list<std::string> &retlist,
 803               const Pathname         &dirname,
 804               bool                    dots = true) const;
 805
 806       /**
 807        * FIXME: see MediaAccess class.
 808        */
 809       void
 810       dirInfo(MediaAccessId           accessId,
 811               filesystem::DirContent &retlist,
 812               const Pathname         &dirname,
 813               bool                   dots = true) const;
 814
 815       /**
 816        * FIXME: see MediaAccess class.
 817        */
 818       bool doesFileExist(MediaAccessId  accessId,
 819                          const Pathname & filename ) const;
 820
 821       /**
 822        * Fill in a vector of detected ejectable devices and the index of the
 823        * currently attached device within the vector. The contents of the vector
 824        * are the device names (/dev/cdrom and such).
 825        *
 826        * \param accessId Medium id.
 827        * \param devices  vector to load with the device names
 828        * \param index    index of the currently used device in the devices vector
 829        */
 830       void
 831       getDetectedDevices(MediaAccessId accessId,
 832                          std::vector<std::string> & devices,
 833                          unsigned int & index) const;
 834
 835       void
 836       setDeltafile(MediaAccessId   accessId,
 837                   const Pathname &filename ) const;
 838
 839     public:
 840       /**
 841        * Get the modification time of the /etc/mtab file.
 842        * \return Modification time of the /etc/mtab file.
 843        */
 844       static time_t
 845       getMountTableMTime();
 846
 847       /**
 848        * Get current mount entries from /etc/mtab file.
 849        * \return Current mount entries from /etc/mtab file.
 850        */
 851       static std::vector<MountEntry>
 852       getMountEntries();
 853
 854       /**
 855        * Check if the specified \p path is useable as
 856        * attach point.
 857        *
 858        * \param path The attach point to check.
 859        * \param mtab Whether to check against the mtab, too.
 860        * \return True, if it is a directory and there are
 861        *         no another attach points bellow of it.
 862        */
 863       bool
 864       isUseableAttachPoint(const Pathname &path,
 865                            bool            mtab=true) const;
 866
 867     private:
 868       friend class MediaHandler;
 869
 870       /**
 871        * \internal
 872        * Return the attached media reference of the specified
 873        * media access id. Used to resolve nested attachments
 874        * as used in the MediaISO (iso-loop) handler.
 875        * Causes temporary creation of a shared attachment
 876        * (increases reference counters on attachedMedia).
 877        * \param media A media access id.
 878        */
 879       AttachedMedia
 880       getAttachedMedia(MediaAccessId &accessId) const;
 881
 882       /**
 883        * \internal
 884        * Called by media handler in while attach() to retrieve
 885        * attached media reference matching the specified media
 886        * source reference.
 887        * Causes temporary creation of a shared attachment
 888        * (increases reference counters on attachedMedia).
 889        * \param media The media source reference to search for.
 890        */
 891       AttachedMedia
 892       findAttachedMedia(const MediaSourceRef &media) const;
 893
 894       /**
 895        * \internal
 896        * Called by media handler in case of relase(eject=true)
 897        * to release all access id's using the specified media.
 898        * Causes temporary creation of a shared attachment
 899        * (increases reference counters on attachedMedia).
 900        * \param media The media source reference to release.
 901        */
 902       void
 903       forceReleaseShared(const MediaSourceRef &media);
 904
 905     private:
 906       /**
 907        * Static reference to the implementation (singleton).
 908        */
 909       static zypp::RW_pointer<MediaManager_Impl> m_impl;
 910     };
 911
 912
 913     //////////////////////////////////////////////////////////////////
 914   } // namespace media
 915   ////////////////////////////////////////////////////////////////////
 916
 917   ////////////////////////////////////////////////////////////////////
 918 } // namespace zypp
 919 //////////////////////////////////////////////////////////////////////
 920
 921 #endif // ZYPP_MEDIA_MEDIAMANAGER_H
 922
 923 /*
 924 ** vim: set ts=2 sts=2 sw=2 ai et:
 925 */