Return to FileSystem.h CVS log

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

Merged dev branch into main trunk.

//%/////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// 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:
//
//%/////////////////////////////////////////////////////////////////////////////

#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/Exception.h>
#include <fstream>

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:

    /** Determines whether file exists.
	@param path path of the file.
	@return true if the file exists.
    */
    static Boolean exists(const String& path);

    /** Determine whether the file exists. Ignores case 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 existsNoCase(const String& path, String& pathOut);

    /** 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);

    /** 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);

    /** 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);

    /** 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);

    /** 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);

    /** Removes a file.
	@param path of file to be removed.
	@return true on sucess.
    */
    static Boolean removeFile(const String& path);

    /** Removes a file. Ignores case of file.
	@param path of file to be removed.
	@return true on sucess.
    */
    static Boolean removeFileNoCase(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(
	Array<Sint8>& array,
	const String& fileName);

    /** 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);

    /** 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.
    */
    Boolean openNoCase(PEGASUS_STD(ifstream)& is, const String& path);

    /** 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);

    /** Remove the given directory. The directory must be empty
	to be eligible for removal
	@param String path is the relative or ablsolute path to
	the directory to remove
	@return true if directory removed
    */
    static Boolean removeDirectory(const String& path);

    /** Remove a directory and all files and directories under it.
	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.
	@return true on success.
    */
    static Boolean removeDirectoryHier(const String& path);

    /** Gets names of all entries (files and directories) of a directory.
	Note that this function excludes the "." and ".." entries.
	@param path path path of directory.
	@param paths contains list of entry names upon return. Note that
	    the entry names only are provided (no path part).
	@return true on success.
    */
    static Boolean getDirectoryContents(
	const String& path,
	Array<String>& paths);

    /** Determines whether the given directory is empty. A directory is
	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);

    /** Translate backward slashes to forward slashes.
	@param path to be translated.
    */
    static void translateSlashes(String& path);

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::getFileSizeNoCase(const String& path, Uint32& size)
{
    String realPath;

    if (!existsNoCase(path, realPath))
	return false;

    return FileSystem::getFileSize(realPath, size);
}

PEGASUS_NAMESPACE_END

#endif /* Pegasus_FileSystem_h */