#ifndef ZYPP_MEDIA_MEDIAMANAGER_H
#define ZYPP_MEDIA_MEDIAMANAGER_H
-#include <zypp/media/MediaAccess.h>
+#include "zypp/media/MediaAccess.h"
-#include <zypp/base/NonCopyable.h>
-#include <zypp/base/PtrTypes.h>
-#include <zypp/Pathname.h>
-#include <zypp/Url.h>
+#include "zypp/APIConfig.h"
+#include "zypp/base/NonCopyable.h"
+#include "zypp/base/PtrTypes.h"
+#include "zypp/Pathname.h"
+#include "zypp/Url.h"
#include <list>
///////////////////////////////////////////////////////////////////
typedef zypp::RW_pointer<MediaAccess> MediaAccessRef;
- typedef unsigned int MediaAccessId;
// OBSOLETE HERE:
typedef MediaAccessId MediaId;
///////////////////////////////////////////////////////////////////
+ // forward declaration
+ class MountEntry;
+ class MediaManager_Impl;
+
+ ///////////////////////////////////////////////////////////////////
//
// CLASS NAME : MediaVerifierBase
//
/**
* Interface to implement a media verifier.
*/
- class MediaVerifierBase //: public zypp::NonCopyable
+ class MediaVerifierBase //: private zypp::NonCopyable
{
public:
MediaVerifierBase()
~MediaVerifierBase()
{}
+ /**
+ * Returns a string with some info about the verifier.
+ * By default, the type info name is returned.
+ */
+ virtual std::string
+ info() const;
+
/*
** Check if the specified attached media contains
** the desired media (e.g. SLES10 CD1).
// CLASS NAME : NoVerifier
//
/**
- * Dummy media verifier, which is always happy.
+ * Dummy default media verifier, which is always happy.
*/
class NoVerifier : public MediaVerifierBase
{
public:
- NoVerifier()
+ NoVerifier(): MediaVerifierBase()
{}
virtual
~NoVerifier()
{}
+ /**
+ * Returns the "zypp::media::NoVerifier" string.
+ */
+ virtual std::string
+ info() const;
+
/*
** Don't check if the specified attached media contains
** the desired media number. Always return true.
// CLASS NAME : MediaManager
//
/**
- * Manages coordinated access to media, e.g. CDROM drives.
- * \todo document me!
+ * Manages access to the 'physical' media, e.g CDROM drives,
+ * Disk volumes, directory trees, etc, using \ref MediaAccessUrl's.
+ *
+ * \note The MediaManager class is just an envelope around an
+ * inner singleton like implementation.<br>
+ * That is, you can create as many managers as you want,
+ * also temporary in a function call.<br>
+ * But <b>don't</b> declare static MediaManager instances,
+ * unless you want to force (mutex) initialization order
+ * problems!
+ *
+ * \section MediaAccessUrl Media Access Url
+ * The MediaManager uses several media access handlers (backends),
+ * that can be specified by a Media Access URL in its open() method.
+ *
+ * All URL's may contain following query parameters, that are
+ * reserved by the Source classes and unused/ignored by the media
+ * manager:
+ * - <tt>alias</tt>: A source specific media alias string.
+ *
+ * Currently, following access handlers (backends) are implemented:
+ * - \ref MediaCD_Url
+ * - \ref MediaDISK_Url
+ * .
+ * - \ref MediaISO_Url
+ * - \ref MediaDIR_Url
+ * .
+ * - \ref MediaNFS_Url
+ * - \ref MediaCIFS_Url
+ * - \ref MediaCurl_Url
+ *
+ * \subsection MediaCD_Url MediaCD - CD/DVD drives (cd, dvd)
+ * The access handler for media on CD / DVD drives.
+ * - Scheme:
+ * - <b>cd</b>: Requires a drive supporting CD media.
+ * - <b>dvd</b>: Prefers a drive supporting DVD media.
+ * - Examples:
+ * \code
+ * "cd:/"
+ * "cd:/?devices=/dev/hda,/dev/hdb"
+ * "cd:/subdir?devices=/dev/hda,/dev/hdb"
+ *
+ * "dvd:/"
+ * "dvd:/?devices=/dev/hda,/dev/hdb"
+ * "dvd:/subdir?devices=/dev/hda,/dev/hdb"
+ * \endcode
+ * Note: You can use either "dvd:/" (just path, no authority)
+ * or "dvd:///" (path and empty authority).
+ * - Query parameters:
+ * - <tt>devices</tt>:
+ * Optional parameter, containing a comma separated list of
+ * block device names to use, e.g.: "/dev/sr0,/dev/sr1".
+ * <br>
+ * The device names will be verified using a HAL query. If one
+ * of the provided devices is not usable (not a block device,
+ * or does not support required media type), an exception is
+ * thrown.
+ * <br>
+ * If the devices parameter is not provided (or empty), all
+ * avaliable CD/DVD drives 'detected' using a HAL query. The
+ * preferred drive (used as first drive) is the drive pointed
+ * to by the symlink "/dev/dvd" ("dvd" scheme only) or
+ * "/dev/cdrom".
+ * - Authority:
+ * A non-empty authority URL component (e.g. containing a host
+ * name) is not allowed.
+ * - Path name:
+ * Mandatory URL component, that specifies a subdirectory on the
+ * CD/DVD, where the desired files are located.
+ *
+ * \subsection MediaDISK_Url MediaDISK - HD disk volumes (hd)
+ * The access handler for media on a disk volume (partition).
+ * - Scheme:
+ * - <b>hd</b>
+ * - Examples:
+ * \code
+ * "hd:/?device=/dev/hda1"
+ * "hd:/subdir?device=/dev/sda1"
+ * "hd:/subdir?device=/dev/sda1&filesystem=reiserfs"
+ * \endcode
+ * Note: You can use either "hd:/" (just path, no authority)
+ * or "hd:///" (path and empty authority).
+ * - Query parameters:
+ * - <tt>device</tt>:
+ * Mandatory parameter specifying the name of the block device of
+ * the partition to mount.
+ * - <tt>filesystem</tt>:
+ * The name of the filesystem. Defaults to "auto".
+ * - Authority:
+ * A non-empty authority URL component is not allowed.
+ * - Path name:
+ * Mandatory URL component, that specifies a subdirectory on the disk
+ * partition, where the desired files are located.
+ *
+ * \subsection MediaDIR_Url MediaDIR - Local directory tree (dir, file)
+ * The access handler to media stored in a local directory tree.
+ * - Scheme:
+ * - <b>dir</b>
+ * - <b>file</b>
+ * - Examples:
+ * \code
+ * "dir:/directory/name"
+ * "file:/directory/name"
+ * \endcode
+ * - Query parameters:
+ * none
+ * - Authority:
+ * A non-empty authority URL component (e.g. containing
+ * a host name) is not allowed.
+ * - Path name:
+ * Mandatory URL component, that specifies a directory, where
+ * the desired files are located.
+ *
+ * \subsection MediaISO_Url MediaISO - Loopback ISO images (iso)
+ * The access handler for media in a ISO image (loopback mount).
+ * - Scheme:
+ * - <b>iso</b>
+ * - Examples:
+ * \code
+ * "iso:/?iso=/path/to/CD1.iso"
+ * "iso:/?iso=CD1.iso&url=dir:/path/to"
+ *
+ * "iso:/?iso=CD1.iso&url=nfs://server/path/to/media"
+ * "iso:/?iso=CD1.iso&url=hd:/?device=/dev/hda"
+ *
+ * "iso:/subdir?iso=DVD1.iso&url=nfs://nfs-server/directory&mnt=/nfs/attach/point&filesystem=udf"
+ * \endcode
+ * - Query parameters:
+ * - <tt>iso</tt>:
+ * Mandatory parameter specifying the name of the iso file.<br>
+ * If the url parameter is missed, the iso parameter has to contain
+ * an absolute iso file name.
+ * - <tt>url</tt>:
+ * Optional parameter specifying the URL to the directory containing
+ * the iso file.<br>
+ * The supported URL schemes are: <i><b>hd</b>, <b>dir</b>,
+ * <b>file</b>, <b>nfs</b>, <b>nfs4</b>, <b>smb</b>, <b>cifs</b>.</i>
+ * - <tt>mnt</tt>:
+ * Optional parameter specifying the prefered attach point for the
+ * source media url.
+ * - <tt>filesystem</tt>:
+ * Optional name of the filesystem used in the iso file. Defaults
+ * to "auto".
+ * - Authority:
+ * A non-empty authority URL component is not allowed.
+ * - Path name:
+ * Mandatory URL component, that specifies a subdirectory inside of
+ * the iso file, where the desired files are located.
+ *
+ * \subsection MediaNFS_Url MediaNFS - NFS directory tree (nfs)
+ * The access handler for media on NFS exported directory tree.
+ * - Scheme:
+ * - <b>nfs</b>
+ * - <b>nfs</b>
+ * - Examples:
+ * \code
+ * "nfs://nfs-server/exported/path"
+ * "nfs://nfs-server/exported/path?mountoptions=ro"
+ * "nfs://nfs-server/exported/path&type=nfs4"
+ * "nfs4://nfs-server/exported/path"
+ * \endcode
+ * - Query parameters:
+ * - <tt>mountoptions</tt>:
+ * The mount options separated by comma ','.
+ * Default is the "ro" option.
+ * - <tt>type=nfs4</tt>:
+ * Whether to mount as nfs4. This is the default for scheme nfs4.
+ * - Authority:
+ * The authority component has to provide a hostname.
+ * Username, password and port are currently ignored.
+ * - Path name:
+ * Mandatory URL component, that specifies the exported
+ * (sub-)directory on the NFS server, where the desired
+ * files are located.
+ *
+ * \subsection MediaCIFS_Url MediaCIFS - CIFS/SMB directory tree (cifs, smb)
+ * The access handler for media in a CIFS/SMB shared directory tree.
+ * - Scheme:
+ * - <b>cifs</b>
+ * - <b>smb</b>
+ * - Examples:
+ * \code
+ * "cifs://servername/share/path/on/the/share"
+ * "cifs://username:passwd@servername/share/path/on/the/share?mountoptions=ro"
+ * "cifs://username:passwd@servername/share/path/on/the/share?mountoptions=noguest"
+ * "smb://servername/share/path/on/the/share"
+ * "smb://username:passwd@servername/share/path/on/the/share?mountoptions=ro"
+ * \endcode
+ * Note: There is no difference between cifs and smb scheme
+ * (any more). In both cases the 'cifs' filesystem is used.
+ * - Query parameters:
+ * - <tt>mountoptions</tt>:
+ * The mount options separated by a comma ','. Default are the
+ * "ro" and "guest" options. Specify "noguest" to turn off
+ * "guest". This is necessary if Samba is configured to reject
+ * guest connections.
+ * - <tt>workgroup</tt> or <tt>domain</tt>:
+ * The name of the workgroup.
+ * - <tt>username</tt>:
+ * Alternative username to username in URL authority.
+ * - <tt>password</tt>:
+ * Alternative password to password in URL authority.
+ * - <tt>user</tt>:
+ * Alternative username (cifs specific variant)
+ * - <tt>pass</tt>:
+ * Alternative password (cifs specific variant)
+ * - Authority:
+ * The authority component has to provide a hostname. Optionally
+ * also a username and password.
+ * - Path name:
+ * Mandatory URL component, that specifies the share name with
+ * optional subdirectory, where the desired files are located.
+ *
+ * \subsection MediaCurl_Url MediaCurl - FTP/HTTP directory tree (ftp, tftp, http, https)
+ * The access handler to media directory tree on a ftp/http server.
+ * - Scheme:
+ * - <b>ftp</b>
+ * - <b>tftp</b>
+ * - <b>http</b>
+ * - <b>https</b>
+ * - Examples:
+ * \code
+ * "ftp://server/relative/path/to/media/dir"
+ * "ftp://server/%2fabsolute/path/to/media/dir"
+ *
+ * "ftp://user:pass@server/path/to/media/dir"
+ * "ftp://user:pass@server/%2f/home/user/path/to/media/dir"
+ *
+ * "http://server/path/on/server"
+ * "http://user:pass@server/path"
+ * "https://user:pass@server/path?proxy=foo&proxyuser=me&proxypass=pw"
+ * \endcode
+ * Note: The "ftp" url scheme supports absolute and relative
+ * paths to the default ftp server directory
+ * (<a href="http://rfc.net/rfc1738.html">RFC1738, Section 3.2.2</a>).<br>
+ * To use an absolute path, you have to prepend the path with an
+ * additional slash, what results in a "/%2f" combination
+ * (second "/" encoded to "%2f") at the begin of the URL path.
+ * <br>
+ * This is important, especially in user authenticated ftp,
+ * where the users home is usually the default directory of the
+ * server (except when the server chroots into the users home
+ * directory).
+ * <br>
+ * For example, if the user "user" has a home directory
+ * "/home/user", you can use either an URL with a relative path
+ * to the home directory "ftp://user:pass@server/path/to/media"
+ * or the absolute path
+ * "ftp://user:pass@server/%2fhome/user/path/to/media" -- both
+ * URLs points to the same directory on the server.
+ * - Query parameters:
+ * - <tt>cookies</tt>:
+ * Turn off using cookies by setting it to "0" (or false, no, off).
+ * - <tt>proxy</tt>:
+ * A proxy hostname or hostname and port separated by ':'.
+ * Setting the hostname to '_none_' explicitly disables the use of a
+ * proxy even if configured in /etc/sysconfig/proxy or the environment.
+ * - <tt>proxyport</tt>:
+ * Alternative way to provide the proxy port.
+ * - <tt>proxyuser</tt>:
+ * The proxy username.
+ * - <tt>proxypass</tt>:
+ * The proxy password.
+ * - <tt>ssl_capath</tt>:
+ * The absolute CA directory to use, default is /etc/ssl/certs.
+ * - <tt>ssl_verify</tt>: Flag to modify the ssl verify behaviour.
+ * Valid values are: 'yes', 'no' and a comma separated list of
+ * 'host' and 'peer' flags.
+ * - 'no':
+ * disables ssl verify
+ * - 'yes':
+ * enables ssl verify, this is the default
+ * and is equivalent to 'host,peer'.
+ * - 'host': The server is considered the intended one, when the
+ * 'Common Name' field or a 'Subject Alternate Name' field in
+ * the certificate matches the host name in the URL.
+ * - 'peer': Verifies whether the certificate provided by the
+ * server is authentic against the chain of digital signatures
+ * found in <tt>ssl_capath</tt>.
+ * - <tt>ssl_clientcert</tt>
+ * Path to the ssl client certificate for authentication to a repo (CURLOPT_SSLCERT).
+ * - <tt>ssl_clientkey</tt>
+ * Path to the ssl client key for authentication to a repo (CURLOPT_SSLKEY).
+ * - <tt>timeout</tt>:
+ * Transfer timeout in seconds between 0 and 3600, 0 disables
+ * the timeout, default timeout is 180 seconds.
+ * - <tt>auth</tt>: A comma separated list of http authentication
+ * method names to use: 'basic', 'digest', 'ntlm', 'negotiate',
+ * 'spnego', 'gssnego'.
+ * Note, that this list depends on the list of methods supported
+ * by the curl library.
+ * - <tt>mediahandler</tt>: Set the mediahandler for this url
+ * Valid values are: 'curl', 'multicurl'
+ * - Authority:
+ * The authority component has to provide a hostname. Optionally
+ * also a username and password. In case of the 'ftp' scheme,
+ * username and password defaults to 'anonymous' and 'yast2@'.
+ * - Path name:
+ * Mandatory URL component, that specifies the path name on the
+ * server, where the desired files are located.
+ *
+ * Proxy settings: If no proxy settings are present in tha URLs
+ * query parameters, the media handler reads the system wide proxy
+ * settings from the <tt>/etc/sysconfig/proxy</tt> file.
+ * If a proxy setting was present, but the proxy password not,
+ * it attempts to read the <tt>proxy-user</tt> variable from the
+ * <tt>~/.curlrc</tt> (<tt>/root/.curlrc</tt>) file.
+ * <br>
+ * If no proxy setting was present, then libzypp does not pass any
+ * proxy settings to curl, but curl fallbacks to use the content of
+ * the <tt>http_proxy</tt>, <tt>ftp_proxy</tt>, etc environment
+ * variables.
+ *
+ * \subsection MediaPlugin_Url MediaPlugin - custom media handler
+ * Media access is delegated to a script located in the libzypp
+ * media plugin directory. The URLs query options are translated
+ * into commandline arguments passed to the script.
+ * - Scheme:
+ * - <b>plugin</b>
+ * - Examples:
+ * \code
+ * "plugin:script?loptv=lvalue&v=optv&lopt=&o&=foo"
+ * \__________/ \____/ \___/ | \_/
+ * __________/__ ____/_ _|_ \ \___
+ * / \ / \ / \ /\ / \
+ * script --loptv "lvalue" -v "optv" --lopt -o -- foo
+ * \endcode
+ * - Query parameters:
+ * - The URLs query options are translated into commandline
+ * arguments passed to the script.
+ * - \b Note: No option may appear twice, as the <tt>(option,value)</tt>
+ * pairs are stored in a hash.
+ * - \b Note: The order in which the query options are passes to the
+ * script is arbitrary, except for an option with an empty key, which
+ * is translated into <tt>'-- value'</tt> and passed as final option.
+ * - <tt>'c[=[value]]'</tt> ist passed as <tt>'-c [value]'</tt>
+ * - <tt>'word[=[value]]'</tt> ist passed as <tt>'--word [value]'</tt>
+ * - <tt>'[=value]'</tt> ist passed as last args as <tt>'-- [value]'</tt>
+ * - \c script<->libzypp communication:
+ * - \TODO to be documented.
*/
- class MediaManager: public zypp::base::NonCopyable
+ class MediaManager: private zypp::base::NonCopyable
{
public:
- MediaManager();
- ~MediaManager();
-
/**
- * open the media, return the ID, throw exception on fail
+ * Creates a MediaManager envelope instance.
+ *
+ * In the case, that the inner implementation is not already
+ * allocated, and the MediaManager constructor was unable to
+ * allocate it, a std::bad_alloc exception is thrown.
+ *
+ * All further instances increase the use counter only.
+ *
+ * \throws std::bad_alloc
*/
- MediaAccessId
- open(const Url &url, const Pathname & preferred_attach_point = "");
+ MediaManager();
/**
- * Open new access handler with specifier url and attach
- * point reusing the specified accessId.
- void
- reopen(MediaAccessId accessId, const Url &url,
- const Pathname & preferred_attach_point = "");
+ * Destroys MediaManager envelope instance.
+ * Decreases the use counter of the inner implementation.
*/
+ ~MediaManager();
/**
- * Swap access handlers of idOne and idTwo.
+ * Opens the media access for specified with the url.
*
- * \returns True, if idOne and and idTwo was both valid.
- bool
- swap(MediaAccessId idOne, MediaAccessId idTwo);
+ * If the \p preferred_attach_point parameter does not
+ * point to a usable attach point directory, the media
+ * manager automatically creates a temporary attach
+ * point in a default directory. This default directory
+ * can be changed using setAttachPrefix() function.
+ *
+ * Remember to close() each id you've opened and not
+ * need any more. It is like a new and delete!
+ *
+ * \param url The \ref MediaAccessUrl.
+ * \param preferred_attach_point The preferred, already
+ * existing directory, where the media should be
+ * attached.
+ * \return a new media access id.
+ * \throws std::bad_alloc
+ * \throws MediaException
*/
+ MediaAccessId
+ open(const Url &url, const Pathname & preferred_attach_point = "");
/**
- * close the media
+ * Close the media access with specified id.
+ * \param accessId The media access id to close.
*/
void
close(MediaAccessId accessId);
/**
- * Query if media is open.
- * \return true, if media id is known.
+ * Query if the media access is open / exists.
+ *
+ * \param accessId The media access id to query.
+ * \return true, if access id is known and open.
*/
bool
isOpen(MediaAccessId accessId) const;
/**
- * Used Protocol if media is opened, otherwise 'unknown'.
+ * Query the protocol name used by the media access
+ * handler. Similar to url().getScheme().
+ *
+ * \param accessId The media access id to query.
+ * \return The protocol name used by the media access
+ * handler, otherwise 'unknown'.
+ * \throws MediaNotOpenException for invalid access id.
*/
std::string
protocol(MediaAccessId accessId) const;
/**
- * Url of the media, otherwise empty.
+ * Hint if files are downloaded or not.
+ * \param accessId The media access id to query.
+ * \return True, if provideFile downloads files.
+ */
+ bool
+ downloads(MediaAccessId accessId) const;
+
+ /**
+ * Returns the \ref MediaAccessUrl of the media access id.
+ *
+ * \param accessId The media access id to query.
+ * \return The \ref MediaAccessUrl used by the media access id.
+ * \throws MediaNotOpenException for invalid access id.
*/
Url
url(MediaAccessId accessId) const;
public:
/**
- * Add verifier for specified media id.
+ * Add verifier implementation for the specified media id.
+ * By default, the NoVerifier is used.
+ *
+ * \param accessId A media access id.
+ * \param verifier The new verifier.
+ * \throws MediaNotOpenException for invalid access id.
*/
void
addVerifier(MediaAccessId accessId,
/**
* Remove verifier for specified media id.
+ * It resets the verifier to NoVerifier.
+ *
+ * \param accessId A media access id.
+ * \throws MediaNotOpenException for invalid access id.
*/
void
delVerifier(MediaAccessId accessId);
public:
/**
- * Attach the media using the concrete handler.
+ * Set or resets the directory name, where the media manager
+ * handlers create their temporary attach points (see open()
+ * function).
+ * It has effect to newly created temporary attach points only.
+ *
+ * \param attach_prefix The new prefix for temporary attach
+ * points, or empty pathname to reset to defaults.
+ * \return True on success, false if the \p attach_prefix
+ * parameters contains a path name, that does not
+ * point to a writable directory.
*/
- void
- attach(MediaAccessId accessId, bool next = false);
+ bool
+ setAttachPrefix(const Pathname &attach_prefix);
/**
- * FIXME: Jiri, do you want this one?
+ * Attach the media using the concrete handler (checks all devices).
*
- * Attach the media if needed and verify, if desired
- * media is avaliable. If the access handler supports
- * multiple drives (e.g. CD/DVD), all drives will be
- * verified.
- * On success, the media is attached and verified.
- * On failure, the media is released and optionally
- * ejected if possible (not shared).
+ * Remember to release() or close() each id you've attached
+ * and not need any more. Attach is like an open of a file!
*
- * \throws MediaNotDesiredException if unable to find
- * desired media in any drive.
- * \throws FIXME if all drives are in use and no one
- * was ejected.
- void
- attachDesiredMedia(MediaAccessId accessId, bool eject = true);
+ * \param accessId A media access id.
+ * \throws MediaNotOpenException for invalid access id.
*/
+ void
+ attach(MediaAccessId accessId);
/**
* Release the attached media and optionally eject.
- * \throws MediaIsSharedException if eject is true
- * and media is shared.
+ *
+ * If the \p ejectDev parameter is not empty all other access
+ * id's are released and the specified drive (CD/DVD drive) is
+ * ejected.
+ *
+ * \param accessId A media access id.
+ * \param ejectDev Device to eject. None if empty.
+ * \throws MediaNotOpenException for invalid access id.
*/
void
- release(MediaAccessId accessId, bool eject = false);
+ release(MediaAccessId accessId, const std::string & ejectDev = "");
+
+ /**
+ * Release all attached media.
+ */
+ void
+ releaseAll();
/**
* Disconnect a remote media.
* fetch more data using the provideFile() or provideDir()
* functions anymore.
*
- * \throws MediaException
+ * \param accessId A media access id.
+ * \throws MediaNotOpenException for invalid access id.
*/
void
disconnect(MediaAccessId accessId);
/**
* Check if media is attached or not.
+ *
+ * \param accessId A media access id.
* \return True if media is attached.
+ * \throws MediaNotOpenException for invalid access id.
*/
bool
isAttached(MediaAccessId accessId) const;
/**
+ * Returns information if media is on a shared
+ * physical device or not.
+ *
+ * \param accessId A media access id.
+ * \return True if it is shared, false if not.
+ * \throws MediaNotOpenException for invalid access id.
+ */
+ bool
+ isSharedMedia(MediaAccessId accessId) const;
+
+ /**
* Ask the registered verifier if the attached
* media is the desired one or not.
- * \return True if desired media is attached.
+ *
+ * \param accessId A media access id.
+ * \return True if media is attached and desired
+ * according to the actual verifier.
+ * \throws MediaNotOpenException for invalid access id.
*/
bool
isDesiredMedia(MediaAccessId accessId) const;
/**
* Ask the specified verifier if the attached
* media is the desired one or not.
- * \return True if desired media is attached.
+ *
+ * \param accessId A media access id.
+ * \param verifier A verifier to use.
+ * \return True if media is attached and desired
+ * according to the specified verifier.
+ * \throws MediaNotOpenException for invalid access id.
*/
bool
isDesiredMedia(MediaAccessId accessId,
const MediaVerifierRef &verifier) const;
/**
+ * Simple check, based on media's URL scheme, telling whether the
+ * it is possible to physically change the media inside its drive, like
+ * CDs or DVDs. Useful to decide whether to request media change from
+ * user or not.
+ *
+ * \param accessId The media access id.
+ * \return <tt>false</tt> if the media is not changeable,
+ * <tt>true</tt> otherwise.
+ * \throws MediaNotOpenException for invalid access id.
+ */
+ bool
+ isChangeable(MediaAccessId accessId);
+
+ /**
* Return the local directory that corresponds to medias url,
* no matter if media isAttached or not. Files requested will
* be available at 'localRoot() + filename' or even better
* 'localPath( filename )'
*
- * If media is not open an empty pathname is returned.
+ * \param accessId A media access id.
+ * \returns The directory name pointing to the media root
+ * in local filesystem or an empty pathname if the
+ * media is not attached.
+ * \throws MediaNotOpenException for invalid access id.
*/
Pathname
localRoot(MediaAccessId accessId) const;
/**
* Shortcut for 'localRoot() + pathname', but returns an empty
- * pathname if media is not open.
+ * pathname if media is not attached.
* Files provided will be available at 'localPath(filename)'.
+ *
+ * \param accessId A media access id.
+ * \param pathname A path name relative to the localRoot().
+ * \returns The directory name in local filesystem pointing
+ * to the desired relative pathname on the media
+ * or an empty pathname if the media is not attached.
+ * \throws MediaNotOpenException for invalid access id.
*/
Pathname
localPath(MediaAccessId accessId, const Pathname & pathname) const;
* on the media.
*
* \param accessId The media access id to use.
- * \param cached If cached is set to true, the function checks, if
- * the file already exists and doesn't download it again
- * if it does. Currently only the existence is checked,
- * no other file attributes.
- * \param checkonly If this and 'cached' are set to true only the
- * existence of the file is checked but it's not
- * downloaded. If 'cached' is unset an errer is
- * returned always.
+ * \param filename The filename to provide, relative to localRoot().
*
* \throws MediaNotOpenException in case of invalid access id.
* \throws MediaNotAttachedException in case, that the media is not attached.
* \throws MediaSystemException in case a system operation fails.
* \throws MediaException derived exception, depending on the url (handler).
*/
+
void
provideFile(MediaAccessId accessId,
- const Pathname &filename,
- bool cached = false,
- bool checkonly = false) const;
+ const Pathname &filename ) const;
/**
+ * FIXME: see MediaAccess class.
*/
void
provideDir(MediaAccessId accessId,
const Pathname &dirname) const;
/**
+ * FIXME: see MediaAccess class.
*/
void
provideDirTree(MediaAccessId accessId,
const Pathname &dirname) const;
/**
+ * FIXME: see MediaAccess class.
*/
void
releaseFile(MediaAccessId accessId,
const Pathname &filename) const;
/**
+ * FIXME: see MediaAccess class.
*/
void
releaseDir(MediaAccessId accessId,
const Pathname &dirname) const;
/**
+ * FIXME: see MediaAccess class.
*/
void
releasePath(MediaAccessId accessId,
const Pathname &pathname) const;
/**
+ * FIXME: see MediaAccess class.
+ */
+ void
+ dirInfo(MediaAccessId accessId,
+ std::list<std::string> &retlist,
+ const Pathname &dirname,
+ bool dots = true) const;
+
+ /**
+ * FIXME: see MediaAccess class.
*/
- void dirInfo(MediaAccessId accessId,
- std::list<std::string> &retlist,
- const Pathname &dirname,
- bool dots = true) const;
+ void
+ dirInfo(MediaAccessId accessId,
+ filesystem::DirContent &retlist,
+ const Pathname &dirname,
+ bool dots = true) const;
/**
+ * FIXME: see MediaAccess class.
*/
- void dirInfo(MediaAccessId accessId,
- filesystem::DirContent &retlist,
- const Pathname &dirname,
- bool dots = true) const;
+ bool doesFileExist(MediaAccessId accessId,
+ const Pathname & filename ) const;
+ /**
+ * Fill in a vector of detected ejectable devices and the index of the
+ * currently attached device within the vector. The contents of the vector
+ * are the device names (/dev/cdrom and such).
+ *
+ * \param accessId Medium id.
+ * \param devices vector to load with the device names
+ * \param index index of the currently used device in the devices vector
+ */
+ void
+ getDetectedDevices(MediaAccessId accessId,
+ std::vector<std::string> & devices,
+ unsigned int & index) const;
+
+ void
+ setDeltafile(MediaAccessId accessId,
+ const Pathname &filename ) const;
+
+ public:
+ /**
+ * Get the modification time of the /etc/mtab file.
+ * \return Modification time of the /etc/mtab file.
+ */
+ static time_t
+ getMountTableMTime();
+
+ /**
+ * Get current mount entries from /etc/mtab file.
+ * \return Current mount entries from /etc/mtab file.
+ */
+ static std::vector<MountEntry>
+ getMountEntries();
+
+ /**
+ * Check if the specified \p path is useable as
+ * attach point.
+ *
+ * \param path The attach point to check.
+ * \param mtab Whether to check against the mtab, too.
+ * \return True, if it is a directory and there are
+ * no another attach points bellow of it.
+ */
+ bool
+ isUseableAttachPoint(const Pathname &path,
+ bool mtab=true) const;
private:
friend class MediaHandler;
+ /**
+ * \internal
+ * Return the attached media reference of the specified
+ * media access id. Used to resolve nested attachments
+ * as used in the MediaISO (iso-loop) handler.
+ * Causes temporary creation of a shared attachment
+ * (increases reference counters on attachedMedia).
+ * \param media A media access id.
+ */
+ AttachedMedia
+ getAttachedMedia(MediaAccessId &accessId) const;
+
+ /**
+ * \internal
+ * Called by media handler in while attach() to retrieve
+ * attached media reference matching the specified media
+ * source reference.
+ * Causes temporary creation of a shared attachment
+ * (increases reference counters on attachedMedia).
+ * \param media The media source reference to search for.
+ */
AttachedMedia
findAttachedMedia(const MediaSourceRef &media) const;
+ /**
+ * \internal
+ * Called by media handler in case of relase(eject=true)
+ * to release all access id's using the specified media.
+ * Causes temporary creation of a shared attachment
+ * (increases reference counters on attachedMedia).
+ * \param media The media source reference to release.
+ */
void
- forceMediaRelease(const MediaSourceRef &media);
+ forceReleaseShared(const MediaSourceRef &media);
private:
- class Impl;
- static zypp::RW_pointer<MediaManager::Impl> m_impl;
+ /**
+ * Static reference to the implementation (singleton).
+ */
+ static zypp::RW_pointer<MediaManager_Impl> m_impl;
};
projects / platform / upstream / libzypp.git / blobdiff