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 URLs 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>ssl_clientcert</tt>
 412      *       Path to the ssl client certificate for authentication to a repo (CURLOPT_SSLCERT).
 413      *     - <tt>ssl_clientkey</tt>
 414      *       Path to the ssl client key for authentication to a repo (CURLOPT_SSLKEY).
 415      *     - <tt>timeout</tt>:
 416      *       Transfer timeout in seconds between 0 and 3600, 0 disables
 417      *       the timeout, default timeout is 180 seconds.
 418      *     - <tt>auth</tt>: A comma separated list of http authentication
 419      *       method names to use: 'basic', 'digest', 'ntlm', 'negotiate',
 420      *       'spnego', 'gssnego'.
 421      *       Note, that this list depends on the list of methods supported
 422      *       by the curl library.
 423      *     - <tt>mediahandler</tt>: Set the mediahandler for this url
 424      *     Valid values are: 'curl', 'multicurl'
 425      *   - Authority:
 426      *     The authority component has to provide a hostname. Optionally
 427      *     also a username and password. In case of the 'ftp' scheme,
 428      *     username and password defaults to 'anonymous' and 'yast2@'.
 429      *   - Path name:
 430      *     Mandatory URL component, that specifies the path name on the
 431      *     server, where the desired files are located.
 432      *
 433      *   Proxy settings: If no proxy settings are present in tha URLs
 434      *   query parameters, the media handler reads the system wide proxy
 435      *   settings from the <tt>/etc/sysconfig/proxy</tt> file.
 436      *   If a proxy setting was present, but the proxy password not,
 437      *   it attempts to read the <tt>proxy-user</tt> variable from the
 438      *   <tt>~/.curlrc</tt> (<tt>/root/.curlrc</tt>) file.
 439      *   <br>
 440      *   If no proxy setting was present, then libzypp does not pass any
 441      *   proxy settings to curl, but curl fallbacks to use the content of
 442      *   the <tt>http_proxy</tt>, <tt>ftp_proxy</tt>, etc environment
 443      *   variables.
 444      *
 445      * \subsection MediaPlugin_Url MediaPlugin - custom media handler
 446      * Media access is delegated to a script located in the libzypp
 447      * media plugin directory. The URLs query options are translated
 448      * into commandline arguments passed to the script.
 449      *   - Scheme:
 450      *     - <b>plugin</b>
 451      *   - Examples:
 452      *     \code
 453      *       "plugin:script?loptv=lvalue&v=optv&lopt=&o&=foo"
 454      *                      \__________/ \____/ \___/ | \_/
 455      *                __________/__    ____/_    _|_  \   \___
 456      *              /              \ /       \ /    \ /\ /    \
 457      *       script --loptv "lvalue" -v "optv" --lopt -o -- foo
 458      *     \endcode
 459      *   - Query parameters:
 460      *     - The URLs query options are translated into commandline
 461      *       arguments passed to the script.
 462      *     - \b Note: No option may appear twice, as the <tt>(option,value)</tt>
 463      *       pairs are stored in a hash.
 464      *     - \b Note: The order in which the query options are passes to the
 465      *       script is arbitrary, except for an option with an empty key, which
 466      *       is translated into <tt>'-- value'</tt> and passed as final option.
 467      *     - <tt>'c[=[value]]'</tt> ist passed as <tt>'-c [value]'</tt>
 468      *     - <tt>'word[=[value]]'</tt> ist passed as <tt>'--word [value]'</tt>
 469      *     - <tt>'[=value]'</tt> ist passed as last args as <tt>'-- [value]'</tt>
 470      *   - \c script<->libzypp communication:
 471      *     - \TODO to be documented.
 472      */
 473     class MediaManager: private zypp::base::NonCopyable
 474     {
 475     public:
 476       /**
 477        * Creates a MediaManager envelope instance.
 478        *
 479        * In the case, that the inner implementation is not already
 480        * allocated, and the MediaManager constructor was unable to
 481        * allocate it, a std::bad_alloc exception is thrown.
 482        *
 483        * All further instances increase the use counter only.
 484        *
 485        * \throws std::bad_alloc
 486        */
 487       MediaManager();
 488
 489       /**
 490        * Destroys MediaManager envelope instance.
 491        * Decreases the use counter of the inner implementation.
 492        */
 493       ~MediaManager();
 494
 495       /**
 496        * Opens the media access for specified with the url.
 497        *
 498        * If the \p preferred_attach_point parameter does not
 499        * point to a usable attach point directory, the media
 500        * manager automatically creates a temporary attach
 501        * point in a default directory. This default directory
 502        * can be changed using setAttachPrefix() function.
 503        *
 504        * Remember to close() each id you've opened and not
 505        * need any more. It is like a new and delete!
 506        *
 507        * \param  url The \ref MediaAccessUrl.
 508        * \param  preferred_attach_point The preferred, already
 509        *         existing directory, where the media should be
 510        *         attached.
 511        * \return a new media access id.
 512        * \throws std::bad_alloc
 513        * \throws MediaException
 514        */
 515       MediaAccessId
 516       open(const Url &url, const Pathname & preferred_attach_point = "");
 517
 518       /**
 519        * Close the media access with specified id.
 520        * \param accessId The media access id to close.
 521        */
 522       void
 523       close(MediaAccessId accessId);
 524
 525       /**
 526        * Query if the media access is open / exists.
 527        *
 528        * \param accessId The media access id to query.
 529        * \return true, if access id is known and open.
 530        */
 531       bool
 532       isOpen(MediaAccessId accessId) const;
 533
 534       /**
 535        * Query the protocol name used by the media access
 536        * handler. Similar to url().getScheme().
 537        *
 538        * \param accessId The media access id to query.
 539        * \return The protocol name used by the media access
 540        *         handler, otherwise 'unknown'.
 541        * \throws MediaNotOpenException for invalid access id.
 542        */
 543       std::string
 544       protocol(MediaAccessId accessId) const;
 545
 546       /**
 547        * Hint if files are downloaded or not.
 548        * \param accessId The media access id to query.
 549        * \return True, if provideFile downloads files.
 550        */
 551       bool
 552       downloads(MediaAccessId accessId) const;
 553
 554       /**
 555        * Returns the \ref MediaAccessUrl of the media access id.
 556        *
 557        * \param accessId The media access id to query.
 558        * \return The \ref MediaAccessUrl used by the media access id.
 559        * \throws MediaNotOpenException for invalid access id.
 560        */
 561       Url
 562       url(MediaAccessId accessId) const;
 563
 564     public:
 565       /**
 566        * Add verifier implementation for the specified media id.
 567        * By default, the NoVerifier is used.
 568        *
 569        * \param accessId A media access id.
 570        * \param verifier The new verifier.
 571        * \throws MediaNotOpenException for invalid access id.
 572        */
 573       void
 574       addVerifier(MediaAccessId accessId,
 575                   const MediaVerifierRef &verifier);
 576
 577       /**
 578        * Remove verifier for specified media id.
 579        * It resets the verifier to NoVerifier.
 580        *
 581        * \param accessId A media access id.
 582        * \throws MediaNotOpenException for invalid access id.
 583        */
 584       void
 585       delVerifier(MediaAccessId accessId);
 586
 587     public:
 588       /**
 589        * Set or resets the directory name, where the media manager
 590        * handlers create their temporary attach points (see open()
 591        * function).
 592        * It has effect to newly created temporary attach points only.
 593        *
 594        * \param attach_prefix The new prefix for temporary attach
 595        *        points, or empty pathname to reset to defaults.
 596        * \return True on success, false if the \p attach_prefix
 597        *         parameters contains a path name, that does not
 598        *         point to a writable directory.
 599        */
 600       bool
 601       setAttachPrefix(const Pathname &attach_prefix);
 602
 603       /**
 604        * Attach the media using the concrete handler (checks all devices).
 605        *
 606        * Remember to release() or close() each id you've attached
 607        * and not need any more. Attach is like an open of a file!
 608        *
 609        * \param accessId A media access id.
 610        * \throws MediaNotOpenException for invalid access id.
 611        */
 612       void
 613       attach(MediaAccessId accessId);
 614
 615       /**
 616        * Release the attached media and optionally eject.
 617        *
 618        * If the \p ejectDev parameter is not empty all other access
 619        * id's are released and the specified drive (CD/DVD drive) is
 620        * ejected.
 621        *
 622        * \param accessId A media access id.
 623        * \param ejectDev Device to eject. None if empty.
 624        * \throws MediaNotOpenException for invalid access id.
 625        */
 626       void
 627       release(MediaAccessId accessId, const std::string & ejectDev = "");
 628
 629       /**
 630        * Release all attached media.
 631        */
 632       void
 633       releaseAll();
 634
 635       /**
 636        * Disconnect a remote media.
 637        *
 638        * This is useful for media which e.g. holds open a connection
 639        * to a server like FTP. After calling disconnect() the media
 640        * object (attach point) is still valid and files are present.
 641        *
 642        * But after calling disconnect() it's not possible to call
 643        * fetch more data using the provideFile() or provideDir()
 644        * functions anymore.
 645        *
 646        * \param accessId A media access id.
 647        * \throws MediaNotOpenException for invalid access id.
 648        */
 649       void
 650       disconnect(MediaAccessId accessId);
 651
 652       /**
 653        * Check if media is attached or not.
 654        *
 655        * \param accessId A media access id.
 656        * \return True if media is attached.
 657        * \throws MediaNotOpenException for invalid access id.
 658        */
 659       bool
 660       isAttached(MediaAccessId accessId) const;
 661
 662       /**
 663        * Returns information if media is on a shared
 664        * physical device or not.
 665        *
 666        * \param accessId A media access id.
 667        * \return True if it is shared, false if not.
 668        * \throws MediaNotOpenException for invalid access id.
 669        */
 670       bool
 671       isSharedMedia(MediaAccessId accessId) const;
 672
 673       /**
 674        * Ask the registered verifier if the attached
 675        * media is the desired one or not.
 676        *
 677        * \param accessId A media access id.
 678        * \return True if media is attached and desired
 679        *         according to the actual verifier.
 680        * \throws MediaNotOpenException for invalid access id.
 681        */
 682       bool
 683       isDesiredMedia(MediaAccessId accessId) const;
 684
 685       /**
 686        * Ask the specified verifier if the attached
 687        * media is the desired one or not.
 688        *
 689        * \param accessId A media access id.
 690        * \param verifier A verifier to use.
 691        * \return True if media is attached and desired
 692        *         according to the specified verifier.
 693        * \throws MediaNotOpenException for invalid access id.
 694        */
 695       bool
 696       isDesiredMedia(MediaAccessId           accessId,
 697                      const MediaVerifierRef &verifier) const;
 698
 699       /**
 700        * Simple check, based on media's URL scheme, telling whether the
 701        * it is possible to physically change the media inside its drive, like
 702        * CDs or DVDs. Useful to decide whether to request media change from
 703        * user or not.
 704        *
 705        * \param accessId The media access id.
 706        * \return <tt>false</tt> if the media is not changeable,
 707        *         <tt>true</tt> otherwise.
 708        * \throws MediaNotOpenException for invalid access id.
 709        */
 710       bool
 711       isChangeable(MediaAccessId accessId);
 712
 713       /**
 714        * Return the local directory that corresponds to medias url,
 715        * no matter if media isAttached or not. Files requested will
 716        * be available at 'localRoot() + filename' or even better
 717        * 'localPath( filename )'
 718        *
 719        * \param accessId A media access id.
 720        * \returns The directory name pointing to the media root
 721        *          in local filesystem or an empty pathname if the
 722        *          media is not attached.
 723        * \throws MediaNotOpenException for invalid access id.
 724        */
 725       Pathname
 726       localRoot(MediaAccessId accessId) const;
 727
 728       /**
 729        * Shortcut for 'localRoot() + pathname', but returns an empty
 730        * pathname if media is not attached.
 731        * Files provided will be available at 'localPath(filename)'.
 732        *
 733        * \param accessId A media access id.
 734        * \param pathname A path name relative to the localRoot().
 735        * \returns The directory name in local filesystem pointing
 736        *          to the desired relative pathname on the media
 737        *          or an empty pathname if the media is not attached.
 738        * \throws MediaNotOpenException for invalid access id.
 739        */
 740       Pathname
 741       localPath(MediaAccessId accessId, const Pathname & pathname) const;
 742
 743     public:
 744       /**
 745        * Provide provide file denoted by relative path below of the
 746        * 'attach point' of the specified media and the path prefix
 747        * on the media.
 748        *
 749        * \param accessId  The media access id to use.
 750        * \param filename  The filename to provide, relative to localRoot().
 751        *
 752        * \throws MediaNotOpenException in case of invalid access id.
 753        * \throws MediaNotAttachedException in case, that the media is not attached.
 754        * \throws MediaNotDesiredException in case, that the media verification failed.
 755        * \throws MediaNotAFileException in case, that the requested filename is not a file.
 756        * \throws MediaFileNotFoundException in case, that the requested filenamedoes not exists.
 757        * \throws MediaWriteException in case, that the file can't be copied from from remote source.
 758        * \throws MediaSystemException in case a system operation fails.
 759        * \throws MediaException derived exception, depending on the url (handler).
 760        */
 761
 762       void
 763       provideFile(MediaAccessId   accessId,
 764                   const Pathname &filename ) const;
 765
 766       /**
 767        * FIXME: see MediaAccess class.
 768        */
 769       void
 770       provideDir(MediaAccessId   accessId,
 771                  const Pathname &dirname) const;
 772
 773       /**
 774        * FIXME: see MediaAccess class.
 775        */
 776       void
 777       provideDirTree(MediaAccessId  accessId,
 778                      const Pathname &dirname) const;
 779
 780       /**
 781        * FIXME: see MediaAccess class.
 782        */
 783       void
 784       releaseFile(MediaAccessId   accessId,
 785                   const Pathname &filename) const;
 786
 787       /**
 788        * FIXME: see MediaAccess class.
 789        */
 790       void
 791       releaseDir(MediaAccessId   accessId,
 792                  const Pathname &dirname) const;
 793
 794       /**
 795        * FIXME: see MediaAccess class.
 796        */
 797       void
 798       releasePath(MediaAccessId   accessId,
 799                   const Pathname &pathname) const;
 800
 801       /**
 802        * FIXME: see MediaAccess class.
 803        */
 804       void
 805       dirInfo(MediaAccessId           accessId,
 806               std::list<std::string> &retlist,
 807               const Pathname         &dirname,
 808               bool                    dots = true) const;
 809
 810       /**
 811        * FIXME: see MediaAccess class.
 812        */
 813       void
 814       dirInfo(MediaAccessId           accessId,
 815               filesystem::DirContent &retlist,
 816               const Pathname         &dirname,
 817               bool                   dots = true) const;
 818
 819       /**
 820        * FIXME: see MediaAccess class.
 821        */
 822       bool doesFileExist(MediaAccessId  accessId,
 823                          const Pathname & filename ) const;
 824
 825       /**
 826        * Fill in a vector of detected ejectable devices and the index of the
 827        * currently attached device within the vector. The contents of the vector
 828        * are the device names (/dev/cdrom and such).
 829        *
 830        * \param accessId Medium id.
 831        * \param devices  vector to load with the device names
 832        * \param index    index of the currently used device in the devices vector
 833        */
 834       void
 835       getDetectedDevices(MediaAccessId accessId,
 836                          std::vector<std::string> & devices,
 837                          unsigned int & index) const;
 838
 839       void
 840       setDeltafile(MediaAccessId   accessId,
 841                   const Pathname &filename ) const;
 842
 843     public:
 844       /**
 845        * Get the modification time of the /etc/mtab file.
 846        * \return Modification time of the /etc/mtab file.
 847        */
 848       static time_t
 849       getMountTableMTime();
 850
 851       /**
 852        * Get current mount entries from /etc/mtab file.
 853        * \return Current mount entries from /etc/mtab file.
 854        */
 855       static std::vector<MountEntry>
 856       getMountEntries();
 857
 858       /**
 859        * Check if the specified \p path is useable as
 860        * attach point.
 861        *
 862        * \param path The attach point to check.
 863        * \param mtab Whether to check against the mtab, too.
 864        * \return True, if it is a directory and there are
 865        *         no another attach points bellow of it.
 866        */
 867       bool
 868       isUseableAttachPoint(const Pathname &path,
 869                            bool            mtab=true) const;
 870
 871     private:
 872       friend class MediaHandler;
 873
 874       /**
 875        * \internal
 876        * Return the attached media reference of the specified
 877        * media access id. Used to resolve nested attachments
 878        * as used in the MediaISO (iso-loop) handler.
 879        * Causes temporary creation of a shared attachment
 880        * (increases reference counters on attachedMedia).
 881        * \param media A media access id.
 882        */
 883       AttachedMedia
 884       getAttachedMedia(MediaAccessId &accessId) const;
 885
 886       /**
 887        * \internal
 888        * Called by media handler in while attach() to retrieve
 889        * attached media reference matching the specified media
 890        * source reference.
 891        * Causes temporary creation of a shared attachment
 892        * (increases reference counters on attachedMedia).
 893        * \param media The media source reference to search for.
 894        */
 895       AttachedMedia
 896       findAttachedMedia(const MediaSourceRef &media) const;
 897
 898       /**
 899        * \internal
 900        * Called by media handler in case of relase(eject=true)
 901        * to release all access id's using the specified media.
 902        * Causes temporary creation of a shared attachment
 903        * (increases reference counters on attachedMedia).
 904        * \param media The media source reference to release.
 905        */
 906       void
 907       forceReleaseShared(const MediaSourceRef &media);
 908
 909     private:
 910       /**
 911        * Static reference to the implementation (singleton).
 912        */
 913       static zypp::RW_pointer<MediaManager_Impl> m_impl;
 914     };
 915
 916
 917     //////////////////////////////////////////////////////////////////
 918   } // namespace media
 919   ////////////////////////////////////////////////////////////////////
 920
 921   ////////////////////////////////////////////////////////////////////
 922 } // namespace zypp
 923 //////////////////////////////////////////////////////////////////////
 924
 925 #endif // ZYPP_MEDIA_MEDIAMANAGER_H
 926
 927 /*
 928 ** vim: set ts=2 sts=2 sw=2 ai et:
 929 */