libzypp 17.31.23
zypp::media::MediaCD Class Reference

Implementation class for CD/DVD MediaHandler. More...

#include <media/MediaCD.h>

Inheritance diagram for zypp::media::MediaCD:

Public Member Functions

 MediaCD (const Url &url_r, const Pathname &attach_point_hint_r)
 
virtual ~MediaCD () override
 
virtual bool isAttached () const override
 True if media is attached.
 
- Public Member Functions inherited from zypp::media::MediaHandler
bool dependsOnParent (MediaAccessId parentId, bool exactIdMatch)
 Check if the current media handler depends on an another handler specified by media access id.
 
bool dependsOnParent ()
 
void resetParentId ()
 Called in case, where the media manager takes over the destruction of the parent id (e.g.
 
Pathname attachPoint () const
 Return the currently used attach point.
 
void setAttachPoint (const Pathname &path, bool temp)
 Set a new attach point.
 
void setAttachPoint (const AttachPointRef &ref)
 Set a (shared) attach point.
 
AttachPoint attachPointHint () const
 Get the actual attach point hint.
 
void attachPointHint (const Pathname &path, bool temp)
 Set the attach point hint as specified by the user.
 
Pathname createAttachPoint () const
 Try to create a default / temporary attach point.
 
Pathname createAttachPoint (const Pathname &attach_root) const
 Try to create a temporary attach point in specified root.
 
void removeAttachPoint ()
 Remove unused attach point.
 
virtual bool checkAttachPoint (const Pathname &apoint) const
 Verify if the specified directory as attach point (root) as requires by the particular media handler implementation.
 
bool isUseableAttachPoint (const Pathname &path, bool mtab=true) const
 Ask media manager, if the specified path is already used as attach point or if there are another attach points bellow of it.
 
std::string mediaSourceName () const
 Get the media source name or an empty string.
 
void setMediaSource (const MediaSourceRef &ref)
 Set new media source reference.
 
AttachedMedia findAttachedMedia (const MediaSourceRef &media) const
 Ask the media manager if specified media source is already attached.
 
AttachedMedia attachedMedia () const
 Returns the attached media.
 
bool isSharedMedia () const
 Returns a hint if the media is shared or not.
 
bool checkAttached (bool matchMountFs) const
 Check actual mediaSource attachment against the current mount table of the system.
 
void forceRelaseAllMedia (bool matchMountFs)
 Call to this function will try to release all media matching the currenlty attached media source, that it is able to find in the mount table.
 
void forceRelaseAllMedia (const MediaSourceRef &ref, bool matchMountFs)
 
 MediaHandler (const Url &url_r, const Pathname &attach_point_r, const Pathname &urlpath_below_attachpoint_r, const bool does_download_r)
 If the concrete media handler provides a nonempty attach_point, it must be an existing directory.
 
virtual ~MediaHandler ()
 Contolling MediaAccess takes care, that attached media is released prior to deleting this.
 
bool downloads () const
 Hint if files are downloaded or not.
 
std::string protocol () const
 Protocol hint for MediaAccess.
 
Url url () const
 Url used.
 
void attach (bool next)
 Use concrete handler to attach the media.
 
virtual bool isAttached () const
 True if media is attached.
 
Pathname localRoot () const
 Return the local directory that corresponds to medias url, no matter if media isAttached or not.
 
Pathname localPath (const Pathname &pathname) const
 Files provided will be available at 'localPath(filename)'.
 
void disconnect ()
 Use concrete handler to isconnect media.
 
void release (const std::string &ejectDev="")
 Use concrete handler to release the media.
 
void provideFile (const OnMediaLocation &file) const
 Use concrete handler to provide file denoted by path below 'localRoot'.
 
void provideFileCopy (const OnMediaLocation &srcFile, Pathname targetFilename) const
 Call concrete handler to provide a copy of a file under a different place in the file system (usually not under attach point) as a copy.
 
void provideDir (Pathname dirname) const
 Use concrete handler to provide directory denoted by path below 'localRoot' (not recursive!).
 
void provideDirTree (Pathname dirname) const
 Use concrete handler to provide directory tree denoted by path below 'localRoot' (recursive!!).
 
void releaseFile (const Pathname &filename) const
 Remove filename below localRoot IFF handler downloads files to the local filesystem.
 
void releaseDir (const Pathname &dirname) const
 Remove directory tree below localRoot IFF handler downloads files to the local filesystem.
 
void releasePath (Pathname pathname) const
 Remove pathname below localRoot IFF handler downloads files to the local filesystem.
 
void dirInfo (std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const
 Return content of directory on media via retlist.
 
void dirInfo (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const
 Basically the same as dirInfo above.
 
bool doesFileExist (const Pathname &filename) const
 check if a file exists
 
virtual bool hasMoreDevices ()
 Check if the media has one more device available for attach(true).
 
virtual void getDetectedDevices (std::vector< std::string > &devices, unsigned int &index) const
 Fill in a vector of detected ejectable devices and the index of the currently attached device within the vector.
 
virtual void precacheFiles (const std::vector< OnMediaLocation > &files)
 Tries to fetch the given files and precaches them.
 

Protected Member Functions

virtual void attachTo (bool next=false) override
 Call concrete handler to attach the media.
 
virtual void releaseFrom (const std::string &ejectDev) override
 Call concrete handler to release the media.
 
virtual void getFile (const OnMediaLocation &file) const override
 Call concrete handler to provide file below attach point.
 
virtual void getDir (const Pathname &dirname, bool recurse_r) const override
 Call concrete handler to provide directory content (not recursive!) below attach point.
 
virtual void getDirInfo (std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const override
 Call concrete handler to provide a content list of directory on media via retlist.
 
virtual void getDirInfo (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const override
 Basically the same as getDirInfo above.
 
virtual bool getDoesFileExist (const Pathname &filename) const override
 check if a file exists
 
virtual void forceEject (const std::string &ejectDev) override
 Call concrete handler to physically eject the media (i.e.
 
virtual bool hasMoreDevices () override
 Check if the media has one more device available for attach(true).
 
virtual void getDetectedDevices (std::vector< std::string > &devices, unsigned int &index) const override
 Fill in a vector of detected ejectable devices and the index of the currently attached device within the vector.
 
- Protected Member Functions inherited from zypp::media::MediaHandler
virtual void attachTo (bool next=false)=0
 Call concrete handler to attach the media.
 
virtual void disconnectFrom ()
 Call concrete handler to disconnect media.
 
virtual void releaseFrom (const std::string &ejectDev="")=0
 Call concrete handler to release the media.
 
virtual void forceEject (const std::string &device)
 Call concrete handler to physically eject the media (i.e.
 
virtual void getFile (const OnMediaLocation &file) const
 Call concrete handler to provide file below attach point.
 
virtual void getFileCopy (const OnMediaLocation &file, const Pathname &targetFilename) const
 Call concrete handler to provide a file under a different place in the file system (usually not under attach point) as a copy.
 
virtual void getDir (const Pathname &dirname, bool recurse_r) const =0
 Call concrete handler to provide directory content (not recursive!) below attach point.
 
virtual void getDirInfo (std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const =0
 Call concrete handler to provide a content list of directory on media via retlist.
 
virtual void getDirInfo (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const =0
 Basically the same as getDirInfo above.
 
virtual bool getDoesFileExist (const Pathname &filename) const =0
 check if a file exists
 
void getDirectoryYast (std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const
 Retrieve and if available scan dirname/directory.yast.
 
void getDirectoryYast (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const
 Retrieve and if available scan dirname/directory.yast.
 

Private Types

typedef std::list< MediaSourceDeviceList
 

Private Member Functions

DeviceList detectDevices (bool supportingDVD) const
 

Static Private Member Functions

static bool openTray (const std::string &device_r)
 
static bool closeTray (const std::string &device_r)
 

Private Attributes

DeviceList _devices
 list of devices to try to mount
 
int _lastdev
 number of last successful mounted device in list
 
int _lastdev_tried
 

Additional Inherited Members

- Public Types inherited from zypp::media::MediaHandler
typedef shared_ptr< MediaHandlerPtr
 
typedef shared_ptr< const MediaHandlerconstPtr
 
- Static Public Member Functions inherited from zypp::media::MediaHandler
static bool setAttachPrefix (const Pathname &attach_prefix)
 
static std::string getRealPath (const std::string &path)
 
static Pathname getRealPath (const Pathname &path)
 
static bool checkAttachPoint (const Pathname &apoint, bool empty_dir, bool writeable)
 Verify if the specified directory as attach point (root) using requested checks.
 
- Protected Attributes inherited from zypp::media::MediaHandler
const Url _url
 Url to handle.
 
MediaAccessId _parentId
 Access Id of media handler we depend on.
 

Detailed Description

Implementation class for CD/DVD MediaHandler.

See also
MediaHandler

Definition at line 28 of file MediaCD.h.

Member Typedef Documentation

◆ DeviceList

typedef std::list<MediaSource> zypp::media::MediaCD::DeviceList
private

Definition at line 31 of file MediaCD.h.

Constructor & Destructor Documentation

◆ MediaCD()

zypp::media::MediaCD::MediaCD ( const Url url_r,
const Pathname attach_point_hint_r 
)

Definition at line 130 of file MediaCD.cc.

◆ ~MediaCD()

virtual zypp::media::MediaCD::~MediaCD ( )
inlineoverridevirtual

Definition at line 69 of file MediaCD.h.

Member Function Documentation

◆ openTray()

bool zypp::media::MediaCD::openTray ( const std::string &  device_r)
staticprivate

Definition at line 177 of file MediaCD.cc.

◆ closeTray()

bool zypp::media::MediaCD::closeTray ( const std::string &  device_r)
staticprivate

Definition at line 188 of file MediaCD.cc.

◆ detectDevices()

MediaCD::DeviceList zypp::media::MediaCD::detectDevices ( bool  supportingDVD) const
private

Definition at line 194 of file MediaCD.cc.

◆ attachTo()

void zypp::media::MediaCD::attachTo ( bool  next = false)
overrideprotectedvirtual

Call concrete handler to attach the media.

Asserted that not already attached, and attachPoint is a directory.

Parameters
nexttry next available device in turn until end of device list is reached (for media which are accessible through multiple devices like cdroms).
Exceptions
MediaException

Implements zypp::media::MediaHandler.

Definition at line 270 of file MediaCD.cc.

◆ releaseFrom()

void zypp::media::MediaCD::releaseFrom ( const std::string &  ejectDev)
overrideprotectedvirtual

Call concrete handler to release the media.

If eject is true, and the media is used in one handler instance only, physically eject the media (i.e. CD-ROM).

Asserted that media is attached.

Parameters
ejectDevDevice to eject. None if empty.
Exceptions
MediaException

Implements zypp::media::MediaHandler.

Definition at line 479 of file MediaCD.cc.

◆ getFile()

void zypp::media::MediaCD::getFile ( const OnMediaLocation file) const
overrideprotectedvirtual

Call concrete handler to provide file below attach point.

Default implementation provided, that returns whether a file is located at 'localRoot + filename'.

Asserted that media is attached.

Exceptions
MediaException

Reimplemented from zypp::media::MediaHandler.

Definition at line 590 of file MediaCD.cc.

◆ getDir()

void zypp::media::MediaCD::getDir ( const Pathname dirname,
bool  recurse_r 
) const
overrideprotectedvirtual

Call concrete handler to provide directory content (not recursive!) below attach point.

Return E_not_supported_by_media if media does not support retrieval of directory content.

Default implementation provided, that returns whether a directory is located at 'localRoot + dirname'.

Asserted that media is attached.

Exceptions
MediaException

Implements zypp::media::MediaHandler.

Definition at line 602 of file MediaCD.cc.

◆ getDirInfo() [1/2]

void zypp::media::MediaCD::getDirInfo ( std::list< std::string > &  retlist,
const Pathname dirname,
bool  dots = true 
) const
overrideprotectedvirtual

Call concrete handler to provide a content list of directory on media via retlist.

If dots is false entries starting with '.' are not reported.

Return E_not_supported_by_media if media does not support retrieval of directory content.

Default implementation provided, that returns the content of a directory at 'localRoot + dirnname' retrieved via 'readdir'.

Asserted that media is attached and retlist is empty.

Exceptions
MediaException

Implements zypp::media::MediaHandler.

Definition at line 615 of file MediaCD.cc.

◆ getDirInfo() [2/2]

void zypp::media::MediaCD::getDirInfo ( filesystem::DirContent retlist,
const Pathname dirname,
bool  dots = true 
) const
overrideprotectedvirtual

Basically the same as getDirInfo above.

The content list is returned as filesystem::DirContent, which includes name and filetype of each directory entry. Retrieving the filetype usg. requires an additional ::stat call for each entry, thus it's more expensive than a simple readdir.

Asserted that media is attached and retlist is empty.

Exceptions
MediaException

Implements zypp::media::MediaHandler.

Definition at line 629 of file MediaCD.cc.

◆ getDoesFileExist()

bool zypp::media::MediaCD::getDoesFileExist ( const Pathname filename) const
overrideprotectedvirtual

check if a file exists

Asserted that url is a file and not a dir.

Exceptions
MediaException

Implements zypp::media::MediaHandler.

Definition at line 635 of file MediaCD.cc.

◆ forceEject()

void zypp::media::MediaCD::forceEject ( const std::string &  device)
overrideprotectedvirtual

Call concrete handler to physically eject the media (i.e.

CD-ROM) in case the media is not attached..

Asserted that media is not attached.

Reimplemented from zypp::media::MediaHandler.

Definition at line 521 of file MediaCD.cc.

◆ hasMoreDevices()

bool zypp::media::MediaCD::hasMoreDevices ( )
overrideprotectedvirtual

Check if the media has one more device available for attach(true).

Reimplemented from zypp::media::MediaHandler.

Definition at line 641 of file MediaCD.cc.

◆ getDetectedDevices()

void zypp::media::MediaCD::getDetectedDevices ( std::vector< std::string > &  devices,
unsigned int &  index 
) const
overrideprotectedvirtual

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).

Parameters
devicesvector to load with the device names
indexindex of the currently used device in the devices vector

Reimplemented from zypp::media::MediaHandler.

Definition at line 652 of file MediaCD.cc.

◆ isAttached()

bool zypp::media::MediaCD::isAttached ( ) const
overridevirtual

True if media is attached.

Reimplemented from zypp::media::MediaHandler.

Definition at line 578 of file MediaCD.cc.

Member Data Documentation

◆ _devices

DeviceList zypp::media::MediaCD::_devices
mutableprivate

list of devices to try to mount

Definition at line 33 of file MediaCD.h.

◆ _lastdev

int zypp::media::MediaCD::_lastdev
private

number of last successful mounted device in list

Definition at line 36 of file MediaCD.h.

◆ _lastdev_tried

int zypp::media::MediaCD::_lastdev_tried
private

Definition at line 37 of file MediaCD.h.


The documentation for this class was generated from the following files: