pegasus/src/Pegasus/Common/FileSystem.h - diff

Return to FileSystem.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/FileSystem.h between version 1.6 and 1.48.6.1

version 1.6, 2001/04/25 22:20:55

version 1.48.6.1, 2007/09/12 15:46:57

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%2006////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a

// Permission is hereby granted, free of charge, to any person obtaining a copy

// copy of this software and associated documentation files (the "Software"),

// of this software and associated documentation files (the "Software"), to

// to deal in the Software without restriction, including without limitation

// deal in the Software without restriction, including without limitation the

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// and/or sell copies of the Software, and to permit persons to whom the

// sell copies of the Software, and to permit persons to whom the Software is

// Software is furnished to do so, subject to the following conditions:

// furnished to do so, subject to the following conditions:

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// DEALINGS IN THE SOFTWARE.

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By:

//%/////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////

// FileSystem.h

// This class provides utilities for manipulating and interrogating the

// file system.

////////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_FileSystem_h

#define Pegasus_FileSystem_h

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/ArrayInternal.h>

#include <Pegasus/Common/Exception.h>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/System.h>

#include <Pegasus/Common/Linkage.h>

#include <fstream>

#include <cstdio>

#include <Pegasus/Common/Buffer.h>

PEGASUS_NAMESPACE_BEGIN

/** The FileSystem class provides methods for manipulating the file system.

This class provides an methods for:

<ul>

<li>Manipulating directories (create, remove, change).</li>

<li>Checking files for ability to read and write.</li>

<li>Removing files.</li>

<li>Comparing files.</li>

<li>Loading files into memory.</li>

</ul>

The methods of this class are all static. So there is no need to

instantiate this class to use it. In fact, instantiation is precluded

by a private default constructor.

A word about the "NoCase" extensions. Some methods of this class have

a "NoCase" version. For example, there is a canRead() and a canReadNoCase().

The "NoCase" variation ignores the case of the file while it is being

located. For example, suppose there is a file called "File1". Then

canReadNoCase("file1") finds the file called "File1" and returns true (of

course there is a possibility that there really is a file called "file1"

in the same directory in which case the behavior of this method is

undefined). Notice that Windows does this anyway. These methods were

developed primarily for Unix which is case sensitive with respect to file

names. It should be noted that the no-case methods are slower (since they

must stat the directory and look at the file names).

The no-case variations are used by the repository which--according to

CIM--must treat two classes names with different case characterisits, but

othererwise similar, as identical. For example, "MyClass", "myclass", and

"MYCLASS" all refer to the same class. Since the default repository

implementation uses disk file names to represent class names (e.g., there

may be a file called "MyClass.#) that there must be a way of opening

a file without regard to its case.

class PEGASUS_COMMON_LINKAGE FileSystem

{

public:

/// Return true if the file exists (and false otherwise).

/** Determines whether file exists.

@param path path of the file.

@return true if the file exists.

static Boolean exists(const String& path);

/** Return true if the file exists (and false otherwise). Ignore the

/** Determine whether the file exists. Ignores case of the file.

case of the file and return the real name of the file.

@param path path of the file.

@param pathOut path of the file with actual case.

@return true if the file exists; false otherwise.

static Boolean existsIgnoreCase(const String& path, String& realPath);

static Boolean existsNoCase(const String& path, String& pathOut);

// Returns true if the file exists and can be read:

/** Determine whether the file exists. Ignores the case of the file.

@param path path of the file.

@return true if the file exists; false otherwise.

static Boolean existsNoCase(const String& path);

/** Determines whether the file can be read.

@param path path of the file.

@return true if the file can be read.

static Boolean canRead(const String& path);

// Returns true if the file exists and can be written:

/** Determines whether the file can be read. Ignores case of file.

@param path path of the file.

@return true if the file can be read.

static Boolean canReadNoCase(const String& path);

/** Determines whether the file can be written.

@param path path of the file.

@return true if the file can be written.

static Boolean canWrite(const String& path);

// Returns true if the file exists and can be executed:

/** Determines whether the file can be written. Ignores case of file.

@param path path of the file.

@return true if the file can be written.

static Boolean canWriteNoCase(const String& path);

// static Boolean canExecute(const String& path);

/** Get the size of the file in bytes.

@param path path of file.

@param size set to size of file.

@return true on success.

static Boolean getFileSize(const String& path, Uint32& size);

// Returns true if file exists and is a directory:

/** Get the size of the file in bytes.

@param path path of file.

@param size set to size of file.

@return true on success.

static Boolean getFileSizeNoCase(const String& path, Uint32& size);

static Boolean isDirectory(const String& path);

/** Removes a file.

@param path of file to be removed.

@return true on sucess.

static Boolean removeFile(const String& path);

// Change to the given directory:

/** Removes a file. Ignores case of file.

@param path of file to be removed.

@return true on sucess.

static Boolean removeFileNoCase(const String& path);

static Boolean changeDirectory(const String& path);

/** Produces an array of filenames that match the given pattern under

the directory given by path. The pattern is limited to asterisks

only. Examples: "*.txt", "hello*world.c". Returns true on success.

Return false if the base diretory does not exist or cannot be

accessed.

static Boolean FileSystem::glob(

const String& path,

const String& pattern,

Array<String>& filenames);

// Create a directory:

/** Removes all files located under the directory given by *path* that

match the given pattern. Uses FileSystem::glob() to match file names.

Example: removeMatchingFiles("/tmp", "*.txt"). Fails if the pattern

matches a directory. May only remove ordinary files.

static Boolean removeMatchingFiles(

const String& path, const String& pattern);

static Boolean makeDirectory(const String& path);

/** Loads contents of the file into the array. Note that the file is

opened using binary mode (newline sequences are not expanded to

carriage-return-line-feed sequences on Windows).

@param array set to the contents of the file upon return.

@param fileName name of file to be loaded.

@exception CannotOpenFile

static void loadFileToMemory(

Buffer& array,

const String& fileName);

// Get the size of the file in bytes:

/** Determines whether two files have exactly the same content.

@param path1 path of first file.

@param path2 path of second file.

@return true if files are identical.

@exception CannotOpenFile

static Boolean compareFiles(

const String& path1,

const String& path2);

/** Renames a file.

@param oldPath old name of file.

@param newPath new name of file.

@return true on success.

static Boolean renameFile(

const String& oldPath,

const String& newPath);

static Boolean getFileSize(const String& path, Uint32& size);

/** Same as rename file except that the case of the file referred to

/** Get the current working Directory

by oldPath is ignored.

static Boolean renameFileNoCase(

const String& oldPath,

const String& newPath);

/** Copy a file.

@param fromPath name of existing file.

@param toPath name of new file.

@return true on success.

static Boolean copyFile(

const String& fromPath,

const String& toPath);

/** Opens a file and ignores the case of the file. Note that the file

will be opend in binary mode (no translation of carriage-return-line-

feed sequences on Windows).

@param os file stream to be opend.

@param path path of file to be opened.

@return true on success.

static Boolean openNoCase(PEGASUS_STD(ifstream)& is, const String& path);

/** Opens a file and ignores the case of the file. Note that the file

open mode of the file must be passed in.

@param os file stream to be opend.

@param path path of file to be opened.

@param mode mode to open the file in.

@return true on success.

static Boolean openNoCase(

PEGASUS_STD(fstream)& fs,

const String& path,

int mode);

/** Determines whether the path refers to a directory.

@param path path of the directory.

@return true if path refers to a directory.

static Boolean isDirectory(const String& path);

/** Changes the current directory.

@param path path of directory to be changed to.

@return true on success.

static Boolean changeDirectory(const String& path);

/** Creates a directory.

@param path path of directory to be created.

@return true on success.

static Boolean makeDirectory(const String& path);

/** Get the path of the current working Directory.

@param path set to current working directory upon return.

@return true on success (operation may fail if the current

working directory becomes stale; this can happen on

Unix if it is removed but is impossible on Windows

due to reference counting).

static Boolean getCurrentDirectory(String& path);

Line 95

Line 275

static Boolean removeDirectory(const String& path);

/** Remove a directory hiearchy. Removes a complete hiearchy of

/** Remove a directory and all files and directories under it.

directories and files.

WARNING: This differs significantly from the <tt>removeDirectory</tt>

WARNING: This differs significantly from the <TT>removeDirectory</TT>

function in that it removes both directories and files and

removes a complete hiearchy. Use with caution.

@param path path of directory to be removed.

@parm path defines the high level directory to be removed

@return true on success.

@return Boolean - ATTN.

@exception - ATTN: Not sure if there is any exception

static Boolean removeDirectoryHier(const String& path);

/** Remove the file defined by the input parameter

/** Gets names of all entries (files and directories) of a directory.

@param path of file to remove

Note that this function excludes the "." and ".." entries.

@return Boolean true if directory removed

@param path path path of directory.

@param paths contains list of entry names upon return. Note that

static Boolean removeFile(const String& path);

the entry names only are provided (no path part).

@return true on success.

/** Get the names of the files (and directories) in the given directory:

@param path - the path of the directory from which we will get filenames

@param paths - On return, this Array contains the names of the files

in the directory

ATTN: Is this local names or fully qualified names with paths.

@return Boolean that is today only true.

@exception Throws "NoSuchDirectory" if the directory defined in path does

not exist.

static Boolean getDirectoryContents(

const String& path,

Array<String>& paths);

/** Load the contents of the file into the array. Throws CannotOpenFile if

/** Determines whether the given directory is empty. A directory is

unable to open file.

empty if it contains no files or directories.

@param path path of directory.

@return true if directory is empty.

static Boolean isDirectoryEmpty(const String& path);

static void loadFileToMemory(

/** Translate backward slashes to forward slashes.

Array<Sint8>& array,

@param path to be translated.

const String& fileName);

static void translateSlashes(String& path);

/** Compare two file for content.

/** Get an absolute path from an absolute directory and a relative or

@param filename of first file

absolute file name. If the file name is fully specified, it is

@param filename of second file

returned unchanged. Otherwise, the specified directory is prepended

ATTN: are filenames local or global???

to the file name.

@return Return true if the two files are identical.

static String getAbsolutePath(const char* path, const String& filename);

@exception Throws CannotOpenFile if either file cannot be opened.

/** Return the just the filename to the file name into base.

static String extractFileName(const String& base);

static Boolean compare(

/** Return the just the path to the file name into path.

const String& fileName1,

const String& fileName2);

static String extractFilePath(const String& path);

// Rename the given file to the new name:

/** Changes file permissions on the given file.

@param path path of the file.

@param mode the bit-wise inclusive OR of the values for the

desired permissions.

@return true on success, false on error and errno is set appropriately.

static Boolean changeFilePermissions(const String& path, mode_t mode);

static Boolean renameFile(

/**

const String& oldFileName,

Return OS path specific delimiter.

const String& newFileName);

// Translate backward slashes to forward slashes:

@return delimiter specific to the platform

static String getPathDelimiter();

static void translateSlashes(String& path);

/**

Returns the absolute pathname for the specified filename.

@param paths directories seperated by an OS specific delimiter to search

@param filename filename to search for in the paths

@return the full absolute pathname to the found filename or an empty

string on failure.

static String getAbsoluteFileName(

const String& paths,

const String& filename);

/**

Convert a library name to its corresponding file name by adding the

appropriate prefix and suffix.

@param libraryName The name of the library for which to build the file

name.

@return The file name corresponding to the specified library name.

static String buildLibraryFileName(const String &libraryName);

static Boolean changeFileOwner(

const String& fileName,

const String& userName);

/**

Flushes the data from the iostream buffers to the OS buffers and

then flushes the data from the OS buffers to the disk.

This will avoid the possible data loss in case of an OS crash when

OS filesystem commit directory-level changes immediately while

file-level changes remain cached (e.g. HP-UX).

@param fstream. The iostream that we want to flush data.

static void syncWithDirectoryUpdates(PEGASUS_STD(fstream)&);

private:

FileSystem() { }

};

inline Boolean FileSystem::existsNoCase(const String& path)

{

String dummy;

return existsNoCase(path, dummy);

}

inline Boolean FileSystem::canReadNoCase(const String& path)

{

String realPath;

if (!existsNoCase(path, realPath))

return false;

return FileSystem::canRead(realPath);

}

inline Boolean FileSystem::canWriteNoCase(const String& path)

{

String realPath;

if (!existsNoCase(path, realPath))

return false;

return FileSystem::canWrite(realPath);

}

inline Boolean FileSystem::removeFileNoCase(const String& path)

{

String realPath;

if (!existsNoCase(path, realPath))

return false;

return FileSystem::removeFile(realPath);

}

inline Boolean FileSystem::renameFileNoCase(

const String& oldPath,

const String& newPath)

{

String realPath;

if (!existsNoCase(oldPath, realPath))

return false;

return FileSystem::renameFile(realPath, newPath);

}

inline Boolean FileSystem::getFileSizeNoCase(const String& path, Uint32& size)

{

String realPath;

if (!existsNoCase(path, realPath))

return false;

return FileSystem::getFileSize(realPath, size);

}

inline String FileSystem::getAbsolutePath(

const char* path,

const String& filename)

{

String absolutePath;

if (filename != String::EMPTY)

{

if (!System::is_absolute_path(filename.getCString()) && path && path[0])

{

absolutePath.append(path);

absolutePath.append('/');

}

absolutePath.append(filename);

}

translateSlashes(absolutePath);

return absolutePath;

}

inline Boolean Open(PEGASUS_STD(ifstream)& is, const String& path)

{

is.open(path.getCString());

return !!is;

}

inline Boolean Open(PEGASUS_STD(ofstream)& os, const String& path)

{

os.open(path.getCString());

return !!os;

}

inline Boolean OpenAppend(PEGASUS_STD(ofstream)& os, const String& path)

{

os.open(path.getCString(), PEGASUS_STD(ios::app));

return !!os;

}

inline String FileSystem::getPathDelimiter()

{

#if defined(PEGASUS_OS_TYPE_WINDOWS)

return String(";");

#else

return String(":");

#endif

}

/** Get the next line from the input file.

PEGASUS_COMMON_LINKAGE Boolean GetLine(PEGASUS_STD(istream)& is, String& line);

PEGASUS_NAMESPACE_END

#endif /* Pegasus_FileSystem_h */

Legend:

Removed from v.1.6
changed lines
	Added in v.1.48.6.1

No CVS admin address has been configured