DirectoryUtil.h

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
#ifndef __AGG_UTIL__DIRECTORY_UTIL_H__
#define __AGG_UTIL__DIRECTORY_UTIL_H__
 
#include <iostream>
#include <string>
#include <vector>
 
#include <time.h> // for time_t
 
class BESRegex;
 
namespace agg_util {
class FileInfo {
public:
    FileInfo(const std::string& path, const std::string& basename, bool isDir, time_t modTime);
    ~FileInfo();

    const std::string& path() const;
    const std::string& basename() const;
    bool isDir() const;
    time_t modTime() const;

    std::string getModTimeAsString() const;

    const std::string& getFullPath() const;
 
    std::string toString() const;

    inline bool operator<(const FileInfo& rhs) const
    {
        return (getFullPath() < rhs.getFullPath());
    }
 
private:
    std::string _path; // path portion with no trailing "/"
    std::string _basename; // just the basename
    mutable std::string _fullPath; // cache of the full pathname, path + "/" + basename
    bool _isDir; // true if a directory, else a file.
    time_t _modTime; // last modification time
};

class DirectoryUtil {
public:
    DirectoryUtil();
    ~DirectoryUtil();

    const std::string& getRootDir() const;

    void setRootDir(const std::string& rootDir, bool allowRelativePaths = false, bool allowSymLinks = false);

    void setFilterSuffix(const std::string& suffix);

    void setFilterRegExp(const std::string& regexp);

    void clearRegExp();

    void setFilterModTimeOlderThan(time_t newestModTime);

    void getListingForPath(const std::string& path, std::vector<FileInfo>* pRegularFiles,
        std::vector<FileInfo>* pDirectories);

    void getListingForPathRecursive(const std::string& path, std::vector<FileInfo>* pRegularFiles,
        std::vector<FileInfo>* pDirectories);

    void getListingOfRegularFilesRecursive(const std::string& path, std::vector<FileInfo>& rRegularFiles);

    static bool hasRelativePath(const std::string& path);

    static void removeTrailingSlashes(std::string& path);

    static void removePrecedingSlashes(std::string& path);

    static void printFileInfoList(std::ostream& os, const std::vector<FileInfo>& listing);

    static void printFileInfoList(const std::vector<FileInfo>& listing);

    static std::string getBESRootDir();
 
    static bool matchesSuffix(const std::string& filename, const std::string& suffix);
 
private:
    // helper methods

    void throwErrorForOpendirFail(const std::string& fullPath);

    bool matchesAllFilters(const std::string& path, time_t modTime) const;
 
private:
 
    // The search rootdir with no trailing slash
    // defaults to "/" if not set.
    std::string _rootDir;
 
    // if !empty(), files returned will end in this suffix.
    std::string _suffix;
 
    // If a regular expression is specified, this will be
    // non-null and used to match each filename.
    BESRegex* _pRegExp;
 
    // True if there was a newest modtime filter set.
    bool _filteringModTimes;
 
    // If _filteringModTimes, this will contain the
    // newest modtime of files we want to include.
    time_t _newestModTime;
 
    // Name to use in BESDEBUG channel for this class.
    static const std::string _sDebugChannel;
};
}
 
#endif /* __AGG_UTIL__DIRECTORY_UTIL_H__ */