zypp::filesystem

zypp::filesystem Namespace Reference

Types and functions for filesystem operations. More...


Classes

class  StatMode
 Wrapper class for mode_t values as derived from stat. More...
class  DevInoCache
 Simple cache remembering device/inode to detect hardlinks. More...
class  PathInfo
 Wrapper class for stat/lstat. More...
struct  DirEntry
 Listentry returned by readdir. More...
class  Pathname
 Pathname. More...
class  TmpPath
 Automaticaly deletes files or directories when no longer needed. More...
class  TmpFile
 Provide a new empty temporary file and delete it when no longer needed. More...
class  TmpDir
 Provide a new empty temporary directory and recursively delete it when no longer needed. More...

Misc.

enum  ZIP_TYPE { ZT_NONE, ZT_GZ, ZT_BZ2 }
 Test whether a file is compressed (gzip/bzip2). More...
int erase (const Pathname &path)
 Erase whatever happens to be located at path (file or directory).
ZIP_TYPE zipType (const Pathname &file)
ByteCount df (const Pathname &path)
 Report free disk space on a mounted file system.

Directory related functions.

typedef std::list< DirEntry > DirContent
 Returned by readdir.
int mkdir (const Pathname &path, unsigned mode=0755)
 Like 'mkdir'.
int assert_dir (const Pathname &path, unsigned mode=0755)
 Like 'mkdir -p'.
int rmdir (const Pathname &path)
 Like 'rmdir'.
int recursive_rmdir (const Pathname &path)
 Like 'rm -r DIR'.
int clean_dir (const Pathname &path)
 Like 'rm -r DIR/ *'.
int copy_dir (const Pathname &srcpath, const Pathname &destpath)
 Like 'cp -a srcpath destpath'.
int copy_dir_content (const Pathname &srcpath, const Pathname &destpath)
 Like 'cp -a srcpath/.
int readdir (std::list< std::string > &retlist, const Pathname &path, bool dots=true)
 Return content of directory via retlist.
int readdir (std::list< Pathname > &retlist, const Pathname &path, bool dots=true)
 Return content of directory via retlist.
int readdir (DirContent &retlist, const Pathname &path, bool dots=true, PathInfo::Mode statmode=PathInfo::STAT)
 Return content of directory via retlist.
int is_empty_dir (const Pathname &path)
 Check if the specified directory is empty.

Enumerations

enum  FileType {
  FT_NOT_AVAIL = 0x00, FT_NOT_EXIST = 0x01, FT_FILE = 0x02, FT_DIR = 0x04,
  FT_CHARDEV = 0x08, FT_BLOCKDEV = 0x10, FT_FIFO = 0x20, FT_LINK = 0x40,
  FT_SOCKET = 0x80
}
 File type information. More...

Functions

std::ostream & operator<< (std::ostream &str, FileType obj)
std::ostream & operator<< (std::ostream &str, const StatMode &obj)
std::ostream & operator<< (std::ostream &str, const PathInfo &obj)
int _Log_Result (const int res, const char *rclass="errno")
std::string checksum (const Pathname &file, const std::string &algorithm)
 Compute a files checksum.
bool is_checksum (const Pathname &file, const CheckSum &checksum)
 check files checksum
std::ostream & operator<< (std::ostream &str, const TmpPath &obj)
 Stream output as pathname.
File related functions.
int unlink (const Pathname &path)
 Like 'unlink'.
int rename (const Pathname &oldpath, const Pathname &newpath)
 Like 'rename'.
int copy (const Pathname &file, const Pathname &dest)
 Like 'cp file dest'.
int symlink (const Pathname &oldpath, const Pathname &newpath)
 Like 'symlink'.
int hardlink (const Pathname &oldpath, const Pathname &newpath)
 Like 'link'.
int copy_file2dir (const Pathname &file, const Pathname &dest)
 Like 'cp file dest'.
Digest computaion.
Todo:
check cooperation with zypp::Digest


std::string md5sum (const Pathname &file)
 Compute a files md5sum.
std::string sha1sum (const Pathname &file)
 Compute a files sha1sum.
Changing permissions.
int chmod (const Pathname &path, mode_t mode)
 Like 'chmod'.

Detailed Description

Types and functions for filesystem operations.

Todo:
move zypp::filesystem stuff into separate header
Todo:
Add tmpfile and tmpdir handling.
Todo:
think about using Exceptions in zypp::filesystem
Todo:
provide a readdir iterator; at least provide an interface using an insert_iterator to be independent from std::container.

Typedef Documentation

typedef std::list<DirEntry> zypp::filesystem::DirContent

Returned by readdir.

Definition at line 493 of file PathInfo.h.

Enumeration Type Documentation

enum zypp::filesystem::FileType

File type information.

Todo:
Think about an Enumeration Class
Enumerator:
FT_NOT_AVAIL 
FT_NOT_EXIST 
FT_FILE 
FT_DIR 
FT_CHARDEV 
FT_BLOCKDEV 
FT_FIFO 
FT_LINK 
FT_SOCKET 

Definition at line 53 of file PathInfo.h.

enum zypp::filesystem::ZIP_TYPE

Test whether a file is compressed (gzip/bzip2).

Returns:
ZT_GZ, ZT_BZ2 if file is compressed, otherwise ZT_NONE.
Enumerator:
ZT_NONE 
ZT_GZ 
ZT_BZ2 

Definition at line 621 of file PathInfo.h.

Function Documentation

std::ostream& zypp::filesystem::operator<< ( std::ostream &  str,
FileType  obj 
)

Definition at line 46 of file PathInfo.cc.

References EMUMOUT, FT_BLOCKDEV, FT_CHARDEV, FT_DIR, FT_FIFO, FT_FILE, FT_LINK, FT_NOT_AVAIL, FT_NOT_EXIST, and FT_SOCKET.

std::ostream& zypp::filesystem::operator<< ( std::ostream &  str,
const StatMode &  obj 
)

Definition at line 94 of file PathInfo.cc.

References zypp::filesystem::StatMode::isBlk(), zypp::filesystem::StatMode::isChr(), zypp::filesystem::StatMode::isDir(), zypp::filesystem::StatMode::isFifo(), zypp::filesystem::StatMode::isFile(), zypp::filesystem::StatMode::isLink(), zypp::filesystem::StatMode::isSock(), and zypp::filesystem::StatMode::perm().

std::ostream& zypp::filesystem::operator<< ( std::ostream &  str,
const PathInfo &  obj 
)

Definition at line 260 of file PathInfo.cc.

References zypp::filesystem::PathInfo::asStatMode(), zypp::filesystem::PathInfo::asString(), zypp::filesystem::PathInfo::group(), zypp::filesystem::PathInfo::isExist(), zypp::filesystem::PathInfo::isFile(), zypp::filesystem::PathInfo::owner(), and zypp::filesystem::PathInfo::size().

int zypp::filesystem::_Log_Result ( const int  res,
const char *  rclass = "errno" 
) [inline]

Definition at line 292 of file PathInfo.cc.

References DBG.

Referenced by chmod(), clean_dir(), copy(), copy_dir(), copy_dir_content(), copy_file2dir(), hardlink(), is_empty_dir(), mkdir(), readdir(), recursive_rmdir(), rename(), rmdir(), symlink(), and unlink().

int zypp::filesystem::mkdir ( const Pathname &  path,
unsigned  mode = 0755 
)

Like 'mkdir'.

Attempt to create a new directory named path. mode specifies the permissions to use. It is modified by the process's umask in the usual way.

Returns:
0 on success, errno on failure

Definition at line 305 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), DBG, and zypp::str::octstring().

Referenced by assert_dir(), zypp::media::MediaHandler::createAttachPoint(), zypp::solver::detail::Testcase::createTestcase(), and zypp::source::susetags::SuseTagsImpl::initCacheDir().

int zypp::filesystem::assert_dir ( const Pathname &  path,
unsigned  mode = 0755 
)

Like 'mkdir -p'.

No error if directory exists. Make parent directories as needed. mode specifies the permissions to use, if directories have to be created. It is modified by the process's umask in the usual way.

Returns:
0 on success, errno on failure

Definition at line 319 of file PathInfo.cc.

References zypp::filesystem::Pathname::asString(), zypp::filesystem::Pathname::empty(), mkdir(), and zypp::filesystem::Pathname::relative().

Referenced by zypp::source::SourceImpl::copyLocalMetadata(), zypp::media::MediaCurl::doGetFileCopy(), zypp::source::yum::YUMSourceImpl::downloadMetadata(), zypp::source::susetags::SuseTagsImpl::downloadMetadata(), zypp::media::MediaCurl::getDir(), zypp::storage::XMLFilesBackend::initBackend(), zypp::source::susetags::SuseTagsImpl::initCacheDir(), zypp::SourceManager::store(), and zypp::SourceCache::storeSource().

int zypp::filesystem::rmdir ( const Pathname &  path  ) 

Like 'rmdir'.

Delete a directory, which must be empty.

Returns:
0 on success, errno on failure

Definition at line 359 of file PathInfo.cc.

References _Log_Result(), and DBG.

Referenced by zypp::media::MediaHandler::checkAttachPoint(), zypp::media::MediaHandler::createAttachPoint(), and zypp::media::MediaCurl::MediaCurl().

int zypp::filesystem::recursive_rmdir ( const Pathname &  path  ) 

Like 'rm -r DIR'.

Delete a directory, recursively removing its contents.

Returns:
0 on success, ENOTDIR if path is not a directory, otherwise the commands return value.

Definition at line 373 of file PathInfo.cc.

References _Log_Result(), DBG, zypp::filesystem::PathInfo::isDir(), and zypp::filesystem::PathInfo::isExist().

Referenced by erase(), zypp::media::MediaHandler::releasePath(), zypp::media::MediaHandler::removeAttachPoint(), zypp::SourceCache::removeSource(), zypp::SourceManager::store(), and zypp::filesystem::TmpPath::Impl::~Impl().

int zypp::filesystem::clean_dir ( const Pathname &  path  ) 

Like 'rm -r DIR/ *'.

Delete directory contents, but keep the directory itself.

Returns:
0 on success, ENOTDIR if path is not a directory, otherwise the commands return value.

Definition at line 405 of file PathInfo.cc.

References _Log_Result(), zypp::ExternalProgram::close(), DBG, zypp::str::form(), zypp::filesystem::PathInfo::isDir(), zypp::filesystem::PathInfo::isExist(), zypp::externalprogram::ExternalDataSource::receiveLine(), and zypp::ExternalProgram::Stderr_To_Stdout.

Referenced by zypp::source::SourceImpl::copyLocalMetadata(), zypp::solver::detail::Testcase::createTestcase(), zypp::source::susetags::SuseTagsImpl::initCacheDir(), zypp::source::SourceImpl::refresh(), zypp::media::MediaHandler::releasePath(), and zypp::filesystem::TmpPath::Impl::~Impl().

int zypp::filesystem::copy_dir ( const Pathname &  srcpath,
const Pathname &  destpath 
)

Like 'cp -a srcpath destpath'.

Copy directory tree. srcpath/destpath must be directories. 'basename srcpath' must not exist in destpath.

Returns:
0 on success, ENOTDIR if srcpath/destpath is not a directory, EEXIST if 'basename srcpath' exists in destpath, otherwise the commands return value.

Definition at line 432 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), zypp::filesystem::Pathname::basename(), zypp::ExternalProgram::close(), DBG, zypp::filesystem::PathInfo::isDir(), zypp::externalprogram::ExternalDataSource::receiveLine(), and zypp::ExternalProgram::Stderr_To_Stdout.

Referenced by zypp::source::susetags::SuseTagsImpl::downloadMetadata().

int zypp::filesystem::copy_dir_content ( const Pathname &  srcpath,
const Pathname &  destpath 
)

Like 'cp -a srcpath/.

destpath'. Copy the content of srcpath recursively into destpath. Both srcpath and destpath has to exists.

Returns:
0 on success, ENOTDIR if srcpath/destpath is not a directory, EEXIST if srcpath and destpath are equal, otherwise the commands return value.

Definition at line 473 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), zypp::ExternalProgram::close(), DBG, zypp::filesystem::PathInfo::isDir(), zypp::externalprogram::ExternalDataSource::receiveLine(), and zypp::ExternalProgram::Stderr_To_Stdout.

Referenced by zypp::source::SourceImpl::copyLocalMetadata().

int zypp::filesystem::readdir ( std::list< std::string > &  retlist,
const Pathname &  path,
bool  dots = true 
)

Return content of directory via retlist.

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

Returns just the directory entries as string.

Returns:
0 on success, errno on failure.
Todo:
provide some readdirIterator.

Definition at line 514 of file PathInfo.cc.

References _Log_Result(), and DBG.

Referenced by zypp::source::plaindir::PlaindirImpl::extract_packages_from_directory(), is_empty_dir(), readdir(), and zypp::media::MediaDISK::verifyIfDiskVolume().

int zypp::filesystem::readdir ( std::list< Pathname > &  retlist,
const Pathname &  path,
bool  dots = true 
)

Return content of directory via retlist.

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

Returns the directory entries prefixed with path.

Returns:
0 on success, errno on failure.
Todo:
provide some readdirIterator.

Definition at line 551 of file PathInfo.cc.

References readdir().

int zypp::filesystem::readdir ( DirContent &  retlist,
const Pathname &  path,
bool  dots = true,
PathInfo::Mode  statmode = PathInfo::STAT 
)

Return content of directory via retlist.

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

The type of individual directory entries is determined accoding to statmode (i.e. via stat or lstat).

Returns:
0 on success, errno on failure.

Definition at line 573 of file PathInfo.cc.

References readdir().

Referenced by zypp::target::modalias::foreach_file(), zypp::media::MediaHandler::getDirInfo(), zypp::source::susetags::SuseTagsImpl::providePackages(), zypp::source::susetags::SuseTagsImpl::publicKeys(), zypp::SourceCache::removeSource(), zypp::SourceCache::restoreSources(), and zypp::storage::XMLFilesBackend::storedObjects().

int zypp::filesystem::is_empty_dir ( const Pathname &  path  ) 

Check if the specified directory is empty.

Parameters:
path The path of the directory to check.
Returns:
0 if directory is empty, -1 if not, errno > 0 on failure.

Definition at line 596 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), name, and readdir().

Referenced by zypp::media::MediaHandler::checkAttachPoint().

int zypp::filesystem::unlink ( const Pathname &  path  ) 

Like 'unlink'.

Delete a file (symbolic link, socket, fifo or device).

Returns:
0 on success, errno on failure

Definition at line 623 of file PathInfo.cc.

References _Log_Result(), and DBG.

Referenced by zypp::storage::XMLFilesBackend::deleteFileObject(), zypp::target::CommitPackageCacheReadAhead::doCacheLastInteractive(), zypp::media::MediaCurl::doGetFileCopy(), erase(), zypp::applydeltarpm::provide(), zypp::media::MediaHandler::releasePath(), zypp::target::rpm::RpmDb::removeV3(), zypp::target::rpm::RpmDb::removeV4(), zypp::source::PackageProvider::tryDelta(), zypp::ZYppGlobalLock::zyppLocked(), zypp::filesystem::TmpPath::Impl::~Impl(), and zypp::ZYppGlobalLock::~ZYppGlobalLock().

int zypp::filesystem::rename ( const Pathname &  oldpath,
const Pathname &  newpath 
)

Like 'rename'.

Renames a file, moving it between directories if required.

Returns:
0 on success, errno on failure

Definition at line 637 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), and DBG.

Referenced by zypp::media::MediaCurl::doGetFileCopy(), and zypp::target::rpm::RpmDb::removeV3().

int zypp::filesystem::copy ( const Pathname &  file,
const Pathname &  dest 
)

Like 'cp file dest'.

Copy file to destination file.

Returns:
0 on success, EINVAL if file is not a file, EISDIR if destiantion is a directory, otherwise the commands return value.

Definition at line 651 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), zypp::ExternalProgram::close(), DBG, zypp::filesystem::PathInfo::isDir(), zypp::filesystem::PathInfo::isFile(), zypp::externalprogram::ExternalDataSource::receiveLine(), and zypp::ExternalProgram::Stderr_To_Stdout.

Referenced by zypp::url::UrlBase::cleanupPathName(), zypp::target::CommitPackageCacheReadAhead::doCacheLastInteractive(), zypp::source::yum::YUMSourceImpl::downloadMetadata(), zypp::source::susetags::SuseTagsImpl::downloadMetadata(), zypp::media::MediaHandler::getFileCopy(), zypp::source::SourceImpl::getPossiblyCachedMetadataFile(), zypp::target::rpm::RpmDb::internal_initDatabase(), zypp::operator<<(), zypp::MediaSetAccess::providePossiblyCachedMetadataFile(), zypp::PublicKey::Impl::readFromFile(), and zypp::target::rpm::RpmDb::run_rpm().

int zypp::filesystem::symlink ( const Pathname &  oldpath,
const Pathname &  newpath 
)

Like 'symlink'.

Creates a symbolic link named newpath which contains the string oldpath. If newpath exists it will not be overwritten.

Returns:
0 on success, errno on failure.

Definition at line 685 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), and DBG.

int zypp::filesystem::hardlink ( const Pathname &  oldpath,
const Pathname &  newpath 
)

Like 'link'.

Creates a hard link named newpath to an existing file oldpath. If newpath exists it will not be overwritten.

Returns:
0 on success, errno on failure.

Definition at line 699 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), and DBG.

int zypp::filesystem::copy_file2dir ( const Pathname &  file,
const Pathname &  dest 
)

Like 'cp file dest'.

Copy file to dest dir.

Returns:
0 on success, EINVAL if file is not a file, ENOTDIR if dest is no directory, otherwise the commands return value.

Definition at line 713 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), zypp::ExternalProgram::close(), DBG, zypp::filesystem::PathInfo::isDir(), zypp::filesystem::PathInfo::isFile(), zypp::externalprogram::ExternalDataSource::receiveLine(), and zypp::ExternalProgram::Stderr_To_Stdout.

std::string zypp::filesystem::md5sum ( const Pathname &  file  ) 

Compute a files md5sum.

Returns:
the files md5sum on success, otherwise an empty string..

Definition at line 747 of file PathInfo.cc.

References zypp::filesystem::Pathname::asString(), and zypp::Digest::digest().

std::string zypp::filesystem::sha1sum ( const Pathname &  file  ) 

Compute a files sha1sum.

Returns:
the files sha1sum on success, otherwise an empty string..

Definition at line 764 of file PathInfo.cc.

References checksum().

Referenced by zypp::source::yum::YUMSourceImpl::downloadNeeded(), and zypp::source::susetags::SuseTagsImpl::downloadNeeded().

std::string zypp::filesystem::checksum ( const Pathname &  file,
const std::string &  algorithm 
)

Compute a files checksum.

Returns:
the files checksum on success, otherwise an empty string..

Definition at line 774 of file PathInfo.cc.

References zypp::filesystem::Pathname::asString(), and zypp::Digest::digest().

Referenced by zypp::source::PackageProvider::doProvidePackage(), is_checksum(), zypp::ChecksumFileChecker::operator()(), zypp::MediaSetAccess::providePossiblyCachedMetadataFile(), zypp::PublicKey::Impl::readFromFile(), and sha1sum().

bool zypp::filesystem::is_checksum ( const Pathname &  file,
const CheckSum &  checksum 
)

check files checksum

Returns:
true if the checksum matchs

Definition at line 786 of file PathInfo.cc.

References checksum().

Referenced by zypp::source::yum::YUMScriptImpl::do_script(), zypp::source::SourceImpl::getPossiblyCachedMetadataFile(), zypp::MediaSetAccess::providePossiblyCachedMetadataFile(), and zypp::source::yum::YUMScriptImpl::undo_script().

int zypp::filesystem::erase ( const Pathname &  path  ) 

Erase whatever happens to be located at path (file or directory).

Returns:
0 on success.
Todo:
check cooperation with zypp::TmpFile and zypp::TmpDir

Definition at line 796 of file PathInfo.cc.

References zypp::filesystem::PathInfo::isDir(), zypp::filesystem::PathInfo::isExist(), zypp::filesystem::PathInfo::LSTAT, recursive_rmdir(), and unlink().

int zypp::filesystem::chmod ( const Pathname &  path,
mode_t  mode 
)

Like 'chmod'.

The mode of the file given by path is changed.

Returns:
0 on success, errno on failure

Definition at line 815 of file PathInfo.cc.

References _Log_Result(), zypp::filesystem::Pathname::asString(), DBG, and zypp::str::octstring().

Referenced by zypp::target::ExecuteScriptHelper(), zypp::base::logger::FileWriter::FileWriter(), and zypp::storage::XMLFilesBackend::isBackendInitialized().

ZIP_TYPE zypp::filesystem::zipType ( const Pathname &  file  ) 

Definition at line 829 of file PathInfo.cc.

References zypp::filesystem::Pathname::asString(), zypp::base::sysconfig::read(), ZT_BZ2, ZT_GZ, and ZT_NONE.

ByteCount zypp::filesystem::df ( const Pathname &  path  ) 

Report free disk space on a mounted file system.

path is the path name of any file within the mounted filesystem.

Returns:
Free disk space or -1 on error.

Definition at line 857 of file PathInfo.cc.

References zypp::filesystem::Pathname::c_str().

Referenced by zypp::target::CommitPackageCacheReadAhead::doCacheLastInteractive().

std::ostream& zypp::filesystem::operator<< ( std::ostream &  str,
const TmpPath &  obj 
) [inline]

Stream output as pathname.

Definition at line 95 of file TmpPath.h.

Generated on Fri Jul 4 16:58:04 2008 for zypp by  doxygen 1.5.0