0.6.0-1 release

[manu/suphp.git] / src / File.hpp

diff --git a/src/File.hpp b/src/File.hpp
new file mode 100644 (file)
index 0000000..3268fb7
--- /dev/null
+++ b/src/File.hpp
@@ -0,0 +1,150 @@
+/*
+    suPHP - (c)2002-2005 Sebastian Marsching <sebastian@marsching.com>
+
+    This file is part of suPHP.
+
+    suPHP is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    suPHP 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with suPHP; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+#ifndef SUPHP_FILE_H
+
+namespace suPHP {
+    class File;
+
+    enum FileMode {
+       FILEMODE_USER_READ,
+       FILEMODE_USER_WRITE,
+       FILEMODE_USER_EXEC,
+       FILEMODE_GROUP_READ,
+       FILEMODE_GROUP_WRITE,
+       FILEMODE_GROUP_EXEC,
+       FILEMODE_OTHERS_READ,
+       FILEMODE_OTHERS_WRITE,
+       FILEMODE_OTHERS_EXEC
+    };
+};
+
+#define SUPHP_FILE_H
+
+#include <string>
+#include <iostream>
+#include <fstream>
+
+#include "IOException.hpp"
+#include "SystemException.hpp"
+#include "SmartPtr.hpp"
+#include "UserInfo.hpp"
+#include "GroupInfo.hpp"
+
+
+namespace suPHP {
+    /**
+     * Class encapsulating file information and access.
+     */
+    class File {
+    private:
+       std::string path;
+       bool hasPermissionBit(FileMode perm) const throw (SystemException);
+       
+    public:
+       /**
+        * Constructor
+        */
+       File(std::string path);
+       
+       /**
+        * Returns path to file
+        */
+       std::string getPath() const;
+
+       /**
+        * Returns input stream to read from file
+        */
+       SmartPtr<std::ifstream> getInputStream() throw (IOException);
+       
+       /**
+        * Does file exists?
+        */
+       bool exists() const;
+
+       /**
+        * Returns real path to file (without symlinks in path)
+        */
+       std::string getRealPath() const throw (SystemException);
+
+       /**
+        * Returns File object representing parent directory
+        */
+       File getParentDirectory() const;
+
+       /**
+        * Returns permission bit
+        */
+       bool hasUserReadBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasUserWriteBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasUserExecuteBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasGroupReadBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasGroupWriteBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasGroupExecuteBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasOthersReadBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasOthersWriteBit() const throw (SystemException);
+
+       /**
+        * Returns permission bit
+        */
+       bool hasOthersExecuteBit() const throw (SystemException);
+
+       /**
+        * Returns owner (user) of file
+        */
+       UserInfo getUser() const throw (SystemException);
+       
+       /**
+        * Returns owning group of file
+        */
+       GroupInfo getGroup() const throw (SystemException);
+       
+    };
+};
+
+#endif // SUPHP_FILE_H