1 /* 2 * libjingle 3 * Copyright 2004--2006, Google Inc. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 3. The name of the author may not be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef _TALK_BASE_UNIXFILESYSTEM_H__ 29 #define _TALK_BASE_UNIXFILESYSTEM_H__ 30 31 #include "fileutils.h" 32 33 namespace talk_base { 34 35 class UnixFilesystem : public FilesystemInterface { 36 public: 37 38 // Opens a file. Returns an open StreamInterface if function succeeds. Otherwise, 39 // returns NULL. 40 virtual FileStream *OpenFile(const Pathname &filename, 41 const std::string &mode); 42 43 // Atomically creates an empty file accessible only to the current user if one 44 // does not already exist at the given path, otherwise fails. 45 virtual bool CreatePrivateFile(const Pathname &filename); 46 47 // This will attempt to delete the file located at filename. 48 // It will fail with VERIY if you pass it a non-existant file, or a directory. 49 virtual bool DeleteFile(const Pathname &filename); 50 51 // This will attempt to delete the folder located at 'folder' 52 // It ASSERTs and returns false if you pass it a non-existant folder or a plain file. 53 virtual bool DeleteEmptyFolder(const Pathname &folder); 54 55 // Creates a directory. This will call itself recursively to create /foo/bar even if 56 // /foo does not exist. 57 // Returns TRUE if function succeeds 58 virtual bool CreateFolder(const Pathname &pathname); 59 60 // This moves a file from old_path to new_path, where "file" can be a plain file 61 // or directory, which will be moved recursively. 62 // Returns true if function succeeds. 63 virtual bool MoveFile(const Pathname &old_path, const Pathname &new_path); 64 virtual bool MoveFolder(const Pathname &old_path, const Pathname &new_path); 65 66 // This copies a file from old_path to _new_path where "file" can be a plain file 67 // or directory, which will be copied recursively. 68 // Returns true if function succeeds 69 virtual bool CopyFile(const Pathname &old_path, const Pathname &new_path); 70 71 // Returns true if a pathname is a directory 72 virtual bool IsFolder(const Pathname& pathname); 73 74 // Returns true if pathname represents a temporary location on the system. 75 virtual bool IsTemporaryPath(const Pathname& pathname); 76 77 // Returns true of pathname represents an existing file 78 virtual bool IsFile(const Pathname& pathname); 79 80 // Returns true if pathname refers to no filesystem object, every parent 81 // directory either exists, or is also absent. 82 virtual bool IsAbsent(const Pathname& pathname); 83 84 virtual std::string TempFilename(const Pathname &dir, const std::string &prefix); 85 86 // A folder appropriate for storing temporary files (Contents are 87 // automatically deleted when the program exists) 88 virtual bool GetTemporaryFolder(Pathname &path, bool create, 89 const std::string *append); 90 91 virtual bool GetFileSize(const Pathname& path, size_t* size); 92 virtual bool GetFileTime(const Pathname& path, FileTimeType which, 93 time_t* time); 94 95 // Returns the path to the running application. 96 virtual bool GetAppPathname(Pathname* path); 97 98 virtual bool GetAppDataFolder(Pathname* path, bool per_user); 99 100 // Get a temporary folder that is unique to the current user and application. 101 virtual bool GetAppTempFolder(Pathname* path); 102 103 virtual bool GetDiskFreeSpace(const Pathname& path, int64 *freebytes); 104 105 // Returns the absolute path of the current directory. 106 virtual Pathname GetCurrentDirectory(); 107 108 private: 109 static std::string app_temp_path_; 110 }; 111 112 } // namespace talk_base 113 114 #endif // _UNIXFILESYSTEM_H__ 115
