src/third_party/libjingle/source/talk/base/unixfilesystem.h

   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 <sys/types.h>
  32
  33 #include "talk/base/fileutils.h"
  34
  35 namespace talk_base {
  36
  37 class UnixFilesystem : public FilesystemInterface {
  38  public:
  39
  40 #if defined(ANDROID) || defined(IOS)
  41 // Android does not have a native code API to fetch the app data or temp
  42 // folders. That needs to be passed into this class from Java. Similarly, iOS
  43 // only supports an Objective-C API for fetching the folder locations, so that
  44 // needs to be passed in here from Objective-C.
  45
  46   static void SetAppDataFolder(const std::string& folder);
  47   static void SetAppTempFolder(const std::string& folder);
  48 #endif
  49
  50   // Opens a file. Returns an open StreamInterface if function succeeds.
  51   // Otherwise, returns NULL.
  52   virtual FileStream *OpenFile(const Pathname &filename,
  53                                const std::string &mode);
  54
  55   // Atomically creates an empty file accessible only to the current user if one
  56   // does not already exist at the given path, otherwise fails.
  57   virtual bool CreatePrivateFile(const Pathname &filename);
  58
  59   // This will attempt to delete the file located at filename.
  60   // It will fail with VERIY if you pass it a non-existant file, or a directory.
  61   virtual bool DeleteFile(const Pathname &filename);
  62
  63   // This will attempt to delete the folder located at 'folder'
  64   // It ASSERTs and returns false if you pass it a non-existant folder or a
  65   // plain file.
  66   virtual bool DeleteEmptyFolder(const Pathname &folder);
  67
  68   // Creates a directory. This will call itself recursively to create /foo/bar
  69   // even if /foo does not exist. All created directories are created with the
  70   // given mode.
  71   // Returns TRUE if function succeeds
  72   virtual bool CreateFolder(const Pathname &pathname, mode_t mode);
  73
  74   // As above, with mode = 0755.
  75   virtual bool CreateFolder(const Pathname &pathname);
  76
  77   // This moves a file from old_path to new_path, where "file" can be a plain
  78   // file or directory, which will be moved recursively.
  79   // Returns true if function succeeds.
  80   virtual bool MoveFile(const Pathname &old_path, const Pathname &new_path);
  81   virtual bool MoveFolder(const Pathname &old_path, const Pathname &new_path);
  82
  83   // This copies a file from old_path to _new_path where "file" can be a plain
  84   // file or directory, which will be copied recursively.
  85   // Returns true if function succeeds
  86   virtual bool CopyFile(const Pathname &old_path, const Pathname &new_path);
  87
  88   // Returns true if a pathname is a directory
  89   virtual bool IsFolder(const Pathname& pathname);
  90
  91   // Returns true if pathname represents a temporary location on the system.
  92   virtual bool IsTemporaryPath(const Pathname& pathname);
  93
  94   // Returns true of pathname represents an existing file
  95   virtual bool IsFile(const Pathname& pathname);
  96
  97   // Returns true if pathname refers to no filesystem object, every parent
  98   // directory either exists, or is also absent.
  99   virtual bool IsAbsent(const Pathname& pathname);
 100
 101   virtual std::string TempFilename(const Pathname &dir,
 102                                    const std::string &prefix);
 103
 104   // A folder appropriate for storing temporary files (Contents are
 105   // automatically deleted when the program exists)
 106   virtual bool GetTemporaryFolder(Pathname &path, bool create,
 107                                  const std::string *append);
 108
 109   virtual bool GetFileSize(const Pathname& path, size_t* size);
 110   virtual bool GetFileTime(const Pathname& path, FileTimeType which,
 111                            time_t* time);
 112
 113   // Returns the path to the running application.
 114   virtual bool GetAppPathname(Pathname* path);
 115
 116   virtual bool GetAppDataFolder(Pathname* path, bool per_user);
 117
 118   // Get a temporary folder that is unique to the current user and application.
 119   virtual bool GetAppTempFolder(Pathname* path);
 120
 121   virtual bool GetDiskFreeSpace(const Pathname& path, int64 *freebytes);
 122
 123   // Returns the absolute path of the current directory.
 124   virtual Pathname GetCurrentDirectory();
 125
 126  private:
 127 #if defined(ANDROID) || defined(IOS)
 128   static char* provided_app_data_folder_;
 129   static char* provided_app_temp_folder_;
 130 #else
 131   static char* app_temp_path_;
 132 #endif
 133
 134   static char* CopyString(const std::string& str);
 135 };
 136
 137 }  // namespace talk_base
 138
 139 #endif  // TALK_BASE_UNIXFILESYSTEM_H_