libzypp: zypp::media::MediaAccess Class Reference

List of all members.


Public Types
typedef intrusive_ptr < MediaAccess >	Ptr
typedef intrusive_ptr< const MediaAccess >	constPtr
Public Member Functions
	MediaAccess ()
	constructor
void	open (const Url &url, const Pathname &preferred_attach_point="")
	open url.
bool	isOpen () const
	True if media is open.
bool	downloads () const
	Hint if files are downloaded or not.
std::string	protocol () const
	Used Protocol if media is opened, otherwise 'unknown'.
Url	url () const
	Url if media is opened, otherwise empty.
void	close ()
	close url
void	attach (bool next=false)
	Use concrete handler to attach the media.
bool	isAttached () const
	True if media is attached.
bool	hasMoreDevices () const
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
	Short for 'localRoot() + pathname', but returns an empty pathname if media is not open.
void	disconnect ()
	Use concrete handler to disconnect the media.
void	release (bool eject=false)
	Use concrete handler to release the media.
void	provideFile (const Pathname &filename, bool cached=false, bool checkonly=false) const
	Use concrete handler to provide file denoted by path below 'attach point'.
void	releaseFile (const Pathname &filename) const
	Remove filename below attach point IFF handler downloads files to the local filesystem.
void	provideDir (const Pathname &dirname) const
	Use concrete handler to provide directory denoted by path below 'attach point' (not recursive!).
void	provideDirTree (const Pathname &dirname) const
	Use concrete handler to provide directory tree denoted by path below 'attach point' (recursive!!).
void	releaseDir (const Pathname &dirname) const
	Remove directory tree below attach point IFF handler downloads files to the local filesystem.
void	releasePath (const Pathname &pathname) const
	Remove pathname below attach point 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	~MediaAccess ()
	Destructor.
virtual std::ostream &	dumpOn (std::ostream &str) const
	Overload to realize std::ostream & operator<<.
void	getFile (const Url &from, const Pathname &to)
	Get file from location at specified by URL and copy it to destination.
Static Public Member Functions
static bool	downloads (const Url &url)
	Hint if files will be downloaded when using the specified media `url`.
static bool	canBeVolatile (const Url &url)
	Hint whether the media can provide volatile contents.
Private Member Functions
AttachedMedia	attachedMedia () const
bool	isSharedMedia () const
void	resetParentId ()
bool	dependsOnParent () const
bool	dependsOnParent (MediaAccessId parentId, bool exactIdMatch) const
Private Attributes
MediaHandler *	_handler
	handler for 'physical' media == 0 if not open
Static Private Attributes
static const Pathname	_noPath
Friends
class	MediaManager
class	MediaManager_Impl
Classes
class	FileProvider
	Helper class that provides file on construction and cleans up on destruction. More...

Detailed Description

The inteface here basically checks whether the handler exists, then forwards the request to MediaHandler.

Member Typedef Documentation

typedef intrusive_ptr<MediaAccess> zypp::media::MediaAccess::Ptr

Definition at line 52 of file MediaAccess.h.

typedef intrusive_ptr<const MediaAccess> zypp::media::MediaAccess::constPtr

Definition at line 53 of file MediaAccess.h.

Constructor & Destructor Documentation

zypp::media::MediaAccess::MediaAccess ( )

constructor

Definition at line 47 of file MediaAccess.cc.

zypp::media::MediaAccess::~MediaAccess ( ) [virtual]

Destructor.

Definition at line 53 of file MediaAccess.cc.

References close().

Member Function Documentation

AttachedMedia zypp::media::MediaAccess::attachedMedia ( ) const [private]

Definition at line 63 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::attachedMedia().

bool zypp::media::MediaAccess::isSharedMedia ( ) const [private]

Definition at line 70 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::isSharedMedia().

void zypp::media::MediaAccess::resetParentId ( ) [private]

Definition at line 77 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::resetParentId().

bool zypp::media::MediaAccess::dependsOnParent ( ) const [private]

Definition at line 83 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::dependsOnParent().

bool zypp::media::MediaAccess::dependsOnParent	(	MediaAccessId	parentId,
		bool	exactIdMatch
	)			const `[private]`

Definition at line 89 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::dependsOnParent().

void zypp::media::MediaAccess::open	(	const Url &	url,
		const Pathname &	preferred_attach_point = `""`
	)

open url.

If preferred_attach_point is given, try to use it as attach point.

Caution: The medium can choose a different attach point. Only getAttachPoint() knows the real attach point.

Exceptions:

MediaException

Definition at line 98 of file MediaAccess.cc.

References _handler, close(), ERR, zypp::Url::getScheme(), zypp::Url::isValid(), MIL, and ZYPP_THROW.

Referenced by getFile().

bool zypp::media::MediaAccess::isOpen ( ) const [inline]

True if media is open.

Definition at line 99 of file MediaAccess.h.

References _handler.

bool zypp::media::MediaAccess::downloads ( ) const

Hint if files are downloaded or not.

Returns:: True, if the files are downloaded.

Definition at line 171 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::downloads().

Referenced by zypp::media::MediaManager::downloads().

bool zypp::media::MediaAccess::downloads ( const Url & url ) [static]

Hint if files will be downloaded when using the specified media url.

Note:: This hint is based on the url scheme only and does not imply, that the URL is valid.

Parameters:

url

The media URL to check.

Returns:: True, if the files are downloaded.

Definition at line 146 of file MediaAccess.cc.

References zypp::Url::getScheme().

bool zypp::media::MediaAccess::canBeVolatile ( const Url & url ) [static]

Hint whether the media can provide volatile contents.

Note:: This hint is based on the url scheme only and does not imply, that the URL is valid.

Parameters:

url

The media URL to check.

Returns:: True, if the files are downloaded.

Definition at line 154 of file MediaAccess.cc.

References zypp::Url::getScheme().

std::string zypp::media::MediaAccess::protocol ( ) const

Used Protocol if media is opened, otherwise 'unknown'.

Definition at line 162 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::protocol().

Url zypp::media::MediaAccess::url ( ) const

Url if media is opened, otherwise empty.

Definition at line 182 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::url().

Referenced by provideFile().

void zypp::media::MediaAccess::close ( )

close url

Exceptions:

MediaException

Definition at line 192 of file MediaAccess.cc.

References _handler, MIL, zypp::media::MediaHandler::release(), WAR, ZYPP_CAUGHT, and ZYPP_RETHROW.

Referenced by open(), and ~MediaAccess().

void zypp::media::MediaAccess::attach ( bool next = false )

Use concrete handler to attach the media.

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:

MediaException

Definition at line 216 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::attach(), and ZYPP_THROW.

Referenced by getFile().

bool zypp::media::MediaAccess::isAttached ( ) const

True if media is attached.

Exceptions:

MediaException

Definition at line 226 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::isAttached().

bool zypp::media::MediaAccess::hasMoreDevices ( ) const

Definition at line 232 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::hasMoreDevices().

Pathname zypp::media::MediaAccess::localRoot ( ) const

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 better 'localPath( filename )'.

If media is not open an empty pathname is returned.

Definition at line 241 of file MediaAccess.cc.

References _handler, _noPath, and zypp::media::MediaHandler::localRoot().

Pathname zypp::media::MediaAccess::localPath ( const Pathname & pathname ) const

Short for 'localRoot() + pathname', but returns an empty pathname if media is not open.

Files provided will be available at 'localPath(filename)'.

Definition at line 252 of file MediaAccess.cc.

References _handler, _noPath, and zypp::media::MediaHandler::localPath().

Referenced by provideFile().

void zypp::media::MediaAccess::disconnect ( )

Use concrete handler to disconnect the media.

This is useful for media which e.g. holds open a connection to a server like FTP. After calling disconnect() the media object still is valid and files are present.

After calling disconnect() it's not possible to call provideFile() or provideDir() anymore.

Exceptions:

MediaException

Definition at line 261 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::disconnect(), and ZYPP_THROW.

void zypp::media::MediaAccess::release ( bool eject = false )

Use concrete handler to release the media.

Parameters:

eject

if true, physically eject the media * (i.e. CD-ROM)

Exceptions:

MediaException

Definition at line 271 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::release().

Referenced by getFile().

void zypp::media::MediaAccess::provideFile	(	const Pathname &	filename,
		bool	cached = `false`,
		bool	checkonly = `false`
	)			const

Use concrete handler to provide file denoted by path below 'attach point'.

Filename is interpreted relative to the attached url and a path prefix is preserved.

Parameters:

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

Exceptions:

MediaException

Definition at line 285 of file MediaAccess.cc.

References _handler, localPath(), zypp::media::MediaHandler::provideFile(), url(), and ZYPP_THROW.

void zypp::media::MediaAccess::releaseFile ( const Pathname & filename ) const

Remove filename below attach point IFF handler downloads files to the local filesystem.

Never remove anything from media.

Exceptions:

MediaException

Definition at line 304 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::releaseFile().

void zypp::media::MediaAccess::provideDir ( const Pathname & dirname ) const

Use concrete handler to provide directory denoted by path below 'attach point' (not recursive!).

'dirname' is interpreted relative to the attached url and a path prefix is preserved.

Exceptions:

MediaException

Definition at line 317 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::provideDir(), and ZYPP_THROW.

void zypp::media::MediaAccess::provideDirTree ( const Pathname & dirname ) const

Use concrete handler to provide directory tree denoted by path below 'attach point' (recursive!!).

'dirname' is interpreted relative to the attached url and a path prefix is preserved.

Exceptions:

MediaException

Definition at line 327 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::provideDirTree(), and ZYPP_THROW.

void zypp::media::MediaAccess::releaseDir ( const Pathname & dirname ) const

Remove directory tree below attach point IFF handler downloads files to the local filesystem.

Never remove anything from media.

Exceptions:

MediaException

Definition at line 337 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::releaseDir().

void zypp::media::MediaAccess::releasePath ( const Pathname & pathname ) const

Remove pathname below attach point IFF handler downloads files to the local filesystem.

Never remove anything from media.

If pathname denotes a directory it is recursively removed. If pathname is empty or '/' everything below the attachpoint is recursively removed.

Exceptions:

MediaException

Definition at line 346 of file MediaAccess.cc.

References _handler, and zypp::media::MediaHandler::releasePath().

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

Return content of directory on media via retlist.

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

The request is forwarded to the concrete handler, which may atempt to retieve the content e.g. via 'readdir'

Caution: This is not supported by all media types. Be prepared to handle E_not_supported_by_media.

Exceptions:

MediaException

Definition at line 356 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::dirInfo(), and ZYPP_THROW.

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

Basically the same as dirInfo above.

The content 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.

Caution: This is not supported by all media types. Be prepared to handle E_not_supported_by_media.

Exceptions:

MediaException

Definition at line 369 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::dirInfo(), and ZYPP_THROW.

bool zypp::media::MediaAccess::doesFileExist ( const Pathname & filename ) const

check if a file exists

Asserted that url is a file and not a dir.

Exceptions:

MediaException

Definition at line 382 of file MediaAccess.cc.

References _handler, zypp::media::MediaHandler::doesFileExist(), and ZYPP_THROW.