Abstract base class for 'physical' MediaHandler like MediaCD, etc. More...

#include <media/MediaHandler.h>

Inheritance diagram for zypp::media::MediaHandler:

Public Types
typedef shared_ptr< MediaHandler >	Ptr

typedef shared_ptr< const MediaHandler >	constPtr

Public Member Functions
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.

Static Public Member Functions
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 Member Functions
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.

Protected Attributes
const Url	_url
	Url to handle.

MediaAccessId	_parentId
	Access Id of media handler we depend on.

Private Attributes
MediaSourceRef	_mediaSource
	The attached media source description reference.

AttachPointRef	_attachPoint
	This is where the media will be actually attached ("mounted").

AttachPoint	_attachPointHint
	The user provided attach preferred point.

Pathname	_relativeRoot
	The relative root directory of the data on the media.

bool	_does_download
	True if concrete handler downloads files to the local filesystem.

time_t	_attach_mtime
	timestamp of the the last attach verification

Static Private Attributes
static Pathname	_attachPrefix
	User defined default attach point prefix.

Friends
std::ostream &	operator<< (std::ostream &str, const MediaHandler &obj)

Detailed Description

Abstract base class for 'physical' MediaHandler like MediaCD, etc.

Handles the requests forwarded by MediaAccess. The public interface contains nonvirtual methods, which should do common sanitychecks and logging. For the real action they call virtual methods overloaded by the concrete handler.

Definition at line 51 of file MediaHandler.h.

Member Typedef Documentation

◆ Ptr

typedef shared_ptr<MediaHandler> zypp::media::MediaHandler::Ptr

Definition at line 55 of file MediaHandler.h.

◆ constPtr

typedef shared_ptr<const MediaHandler> zypp::media::MediaHandler::constPtr

Definition at line 56 of file MediaHandler.h.

Constructor & Destructor Documentation

◆ MediaHandler()

zypp::media::MediaHandler::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.

On an empty attach_point, MediaHandler will create a temporay directory, which will be erased from destructor.

On any error, the attach_point is set to an empty Pathname, which should lead to E_bad_attachpoint.

Definition at line 54 of file MediaHandler.cc.

◆ ~MediaHandler()

zypp::media::MediaHandler::~MediaHandler ( )

virtual

Contolling MediaAccess takes care, that attached media is released prior to deleting this.

Definition at line 105 of file MediaHandler.cc.

Member Function Documentation

◆ setAttachPrefix()

bool zypp::media::MediaHandler::setAttachPrefix ( const Pathname & attach_prefix )

static

Definition at line 282 of file MediaHandler.cc.

◆ getRealPath() [1/2]

std::string zypp::media::MediaHandler::getRealPath ( const std::string & path )

static

Definition at line 121 of file MediaHandler.cc.

◆ getRealPath() [2/2]

zypp::Pathname zypp::media::MediaHandler::getRealPath ( const Pathname & path )

static

Definition at line 127 of file MediaHandler.cc.

◆ dependsOnParent() [1/2]

bool zypp::media::MediaHandler::dependsOnParent	(	MediaAccessId	parentId,
		bool	exactIdMatch
	)

Check if the current media handler depends on an another handler specified by media access id.

Parameters

parentId The id of the parent handler to check against.

Returns: true if it depends, false if not.

Definition at line 927 of file MediaHandler.cc.

◆ dependsOnParent() [2/2]

bool zypp::media::MediaHandler::dependsOnParent ( )

Definition at line 921 of file MediaHandler.cc.

◆ resetParentId()

void zypp::media::MediaHandler::resetParentId ( )

Called in case, where the media manager takes over the destruction of the parent id (e.g.

while destruction of the media manager).

Definition at line 115 of file MediaHandler.cc.

◆ attachPoint()

Pathname zypp::media::MediaHandler::attachPoint ( ) const

Return the currently used attach point.

Definition at line 184 of file MediaHandler.cc.

◆ setAttachPoint() [1/2]

void zypp::media::MediaHandler::setAttachPoint	(	const Pathname &	path,
		bool	temp
	)

Set a new attach point.

Parameters

path	The attach point directory path.
temp	If to remove the attach point while cleanup.

Definition at line 199 of file MediaHandler.cc.

◆ setAttachPoint() [2/2]

void zypp::media::MediaHandler::setAttachPoint ( const AttachPointRef & ref )

Set a (shared) attach point.

Parameters

ref	New attach point reference.

Definition at line 222 of file MediaHandler.cc.

◆ attachPointHint() [1/2]

AttachPoint zypp::media::MediaHandler::attachPointHint ( ) const

Get the actual attach point hint.

Definition at line 254 of file MediaHandler.cc.

◆ attachPointHint() [2/2]

void zypp::media::MediaHandler::attachPointHint	(	const Pathname &	path,
		bool	temp
	)

Set the attach point hint as specified by the user.

Parameters

path	The attach point directory path.
temp	If to remove the attach point while cleanup.

Definition at line 239 of file MediaHandler.cc.

◆ createAttachPoint() [1/2]

Pathname zypp::media::MediaHandler::createAttachPoint ( ) const

Try to create a default / temporary attach point.

It tries to create it in attachPrefix if avaliable, then in built-in directories.

Exceptions

MediaBadAttachPointException if no attach point can be created

Returns: The name of the new attach point

Definition at line 311 of file MediaHandler.cc.

◆ createAttachPoint() [2/2]

Pathname zypp::media::MediaHandler::createAttachPoint ( const Pathname & attach_root ) const

Try to create a temporary attach point in specified root.

Parameters

attach_root The attach root dir where to create the attach point in.

Returns: The name of the new attach point or empty path name.

Definition at line 347 of file MediaHandler.cc.

◆ removeAttachPoint()

void zypp::media::MediaHandler::removeAttachPoint ( )

Remove unused attach point.

If the attach point is temporary, the attach point directory and all it content will be removed.

Definition at line 142 of file MediaHandler.cc.

◆ checkAttachPoint() [1/2]

bool zypp::media::MediaHandler::checkAttachPoint ( const Pathname & apoint ) const

virtual

Verify if the specified directory as attach point (root) as requires by the particular media handler implementation.

Parameters

apoint The directory to check.

Returns: True, if the directory checks succeeded.

Reimplemented in zypp::media::MediaCurl, and zypp::media::MediaNetwork.

Definition at line 847 of file MediaHandler.cc.

◆ checkAttachPoint() [2/2]

bool zypp::media::MediaHandler::checkAttachPoint	(	const Pathname &	apoint,
		bool	empty_dir,
		bool	writeable
	)

static

Verify if the specified directory as attach point (root) using requested checks.

Parameters

apoint	The directory to check.
empty_dir	Check if the directory is empty.
writeable	Check if the directory is writeable.

Returns: True, if the directory checks succeeded.

Definition at line 854 of file MediaHandler.cc.

◆ isUseableAttachPoint()

bool zypp::media::MediaHandler::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.

Parameters

path	The attach point path to check.
mtab	Whether to check against the mtab, too.

Returns: True, if the path can be used as attach point.

Definition at line 415 of file MediaHandler.cc.

◆ mediaSourceName()

std::string zypp::media::MediaHandler::mediaSourceName ( ) const

inline

Get the media source name or an empty string.

Returns: media source name or empty string.

Definition at line 226 of file MediaHandler.h.

◆ setMediaSource()

void zypp::media::MediaHandler::setMediaSource ( const MediaSourceRef & ref )

Set new media source reference.

Parameters

ref	The new reference.

Definition at line 431 of file MediaHandler.cc.

◆ findAttachedMedia()

AttachedMedia zypp::media::MediaHandler::findAttachedMedia ( const MediaSourceRef & media ) const

Ask the media manager if specified media source is already attached.

Definition at line 268 of file MediaHandler.cc.

◆ attachedMedia()

AttachedMedia zypp::media::MediaHandler::attachedMedia ( ) const

Returns the attached media.

Used by MediaManager to find other handlers using the same source.

Note: This function increments reference counters on the mediaSource and attachPoint references it contains, for the life time of the returned object. That is, it enables a (temporary) sharing of them.

Returns: The AttachedMedia struct containing (shared) references to media source and attach point.

Definition at line 447 of file MediaHandler.cc.

◆ isSharedMedia()

bool zypp::media::MediaHandler::isSharedMedia ( ) const

Returns a hint if the media is shared or not.

Returns: true, if media is shared.

Definition at line 464 of file MediaHandler.cc.

◆ checkAttached()

bool zypp::media::MediaHandler::checkAttached ( bool matchMountFs ) const

Check actual mediaSource attachment against the current mount table of the system.

Used to implement isAttached().

Parameters

matchMountFs If to use the filesystem type from the mount table (nfs, smb and cifs) or from mediaSource while compare of a mount entry with mediaSource.

Returns: true, if the media appears in the mount table.

Definition at line 478 of file MediaHandler.cc.

◆ forceRelaseAllMedia() [1/2]

void zypp::media::MediaHandler::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.

This means also foreign (user) mounts!

Parameters

matchMountFs If to use the filesystem type from the mount table (nfs, smb and cifs) or from mediaSource while compare of a mount entry with mediaSource.

Definition at line 777 of file MediaHandler.cc.

◆ forceRelaseAllMedia() [2/2]

void zypp::media::MediaHandler::forceRelaseAllMedia	(	const MediaSourceRef &	ref,
		bool	matchMountFs
	)

Definition at line 782 of file MediaHandler.cc.

◆ attachTo()

virtual void zypp::media::MediaHandler::attachTo ( bool next = false )

protectedpure virtual

Call concrete handler to attach the media.

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

Parameters

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

Exceptions

void zypp::media::MediaHandler::provideFileCopy	(	const OnMediaLocation &	srcFile,
		Pathname	targetFilename
	)		const

srcFilename	Filename of source file on the media
targetFilename	Filename for the target in the file system

void zypp::media::MediaHandler::dirInfo	(	std::list< std::string > &	retlist,
		const Pathname &	dirname,
		bool	dots = `true`
	)		const

void zypp::media::MediaHandler::dirInfo	(	filesystem::DirContent &	retlist,
		const Pathname &	dirname,
		bool	dots = `true`
	)		const

devices	vector to load with the device names
index	index of the currently used device in the devices vector

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Ptr

◆ constPtr

Constructor & Destructor Documentation

◆ MediaHandler()

◆ ~MediaHandler()

Member Function Documentation

◆ setAttachPrefix()

◆ getRealPath() [1/2]

◆ getRealPath() [2/2]

◆ dependsOnParent() [1/2]

◆ dependsOnParent() [2/2]

◆ resetParentId()

◆ attachPoint()

◆ setAttachPoint() [1/2]

◆ setAttachPoint() [2/2]

◆ attachPointHint() [1/2]

◆ attachPointHint() [2/2]

◆ createAttachPoint() [1/2]

◆ createAttachPoint() [2/2]

◆ removeAttachPoint()

◆ checkAttachPoint() [1/2]

◆ checkAttachPoint() [2/2]

◆ isUseableAttachPoint()

◆ mediaSourceName()

◆ setMediaSource()

◆ findAttachedMedia()

◆ attachedMedia()

◆ isSharedMedia()

◆ checkAttached()

◆ forceRelaseAllMedia() [1/2]

◆ forceRelaseAllMedia() [2/2]

◆ attachTo()

◆ disconnectFrom()

◆ releaseFrom()

◆ forceEject()

◆ getFile()

◆ getFileCopy()

◆ getDir()

◆ getDirInfo() [1/2]

◆ getDirInfo() [2/2]

◆ getDoesFileExist()

◆ getDirectoryYast() [1/2]

◆ getDirectoryYast() [2/2]

◆ downloads()

◆ protocol()

◆ url()

◆ attach()

◆ isAttached()

◆ localRoot()

◆ localPath()

◆ disconnect()

◆ release()

◆ provideFile()

◆ provideFileCopy()

◆ provideDir()

◆ provideDirTree()

◆ releaseFile()

◆ releaseDir()

◆ releasePath()

◆ dirInfo() [1/2]

◆ dirInfo() [2/2]

◆ doesFileExist()

◆ hasMoreDevices()

◆ getDetectedDevices()

◆ precacheFiles()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ _attachPrefix

◆ _mediaSource