hphp/runtime/base/file-util.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 //////////////////////////////////////////////////////////////////////
  18
  19 #ifndef incl_HPHP_FILE_UTIL_H_
  20 #define incl_HPHP_FILE_UTIL_H_
  21
  22 #include "hphp/util/file.h"
  23
  24 #include "hphp/runtime/base/type-string.h"
  25
  26 #include <set>
  27 #include <string>
  28 #include <vector>
  29
  30 namespace HPHP { namespace FileUtil {
  31
  32 ///////////////////////////////////////////////////////////////////////////////
  33
  34 /**
  35  * Make sure path exists. Same as "mkdir -p", but "a/b" will only make sure
  36  * "a/" exists, treating "b" as a file name.
  37  */
  38 bool mkdir(const std::string &path, int mode = 0777);
  39
  40 /**
  41  * Make dest directory look identical to src by copying files and directories,
  42  * without copying identical files (so they keep the same timestamp as before).
  43  */
  44 void syncdir(const std::string &dest, const std::string &src,
  45              bool keepSrc = false);
  46
  47 /**
  48  * Copy srcfile to dstfile, return 0 on success, -1 otherwise
  49  */
  50 int copy(const char *srcfile, const char *dstfile);
  51
  52 /**
  53  * Like copy but using little disk-cache
  54  */
  55 int directCopy(const char *srcfile, const char *dstfile);
  56
  57 /**
  58  * Like rename(2), but takes care of cross-filesystem rename.
  59  */
  60 int rename(const char *oldname, const char *newname);
  61
  62 /**
  63  * Like rename but using little disk-cache
  64  */
  65 int directRename(const char *oldname, const char *newname);
  66
  67 /**
  68  * Like system(3), but automatically print errors if execution fails.
  69  */
  70 int ssystem(const char *command);
  71
  72 /**
  73  * Find the relative path from a directory with trailing slash to the file
  74  */
  75 String relativePath(const std::string& fromDir, const String& toFile);
  76
  77 /**
  78  * Canonicalize path to remove "..", "." and "\/", etc..
  79  */
  80 String canonicalize(const String& path);
  81 String canonicalize(const std::string& path);
  82 String canonicalize(const char* path, size_t len,
  83                     bool collapse_slashes = true);
  84
  85 std::string expandUser(const std::string& path,
  86                        const std::string& sysUser = "");
  87 /**
  88  * Makes sure there is ending slash by changing "path/name" to "path/name/".
  89  */
  90 std::string normalizeDir(const std::string &dirname);
  91
  92 /**
  93  * Thread-safe dirname().
  94  */
  95 String dirname(const String& path);
  96
  97 /**
  98  * Search for PHP, JS, or other files under a directory.
  99  */
 100 void find(std::vector<std::string> &out,
 101           const std::string &root, const std::string& path, bool php,
 102           const std::set<std::string> *excludeDirs = nullptr,
 103           const std::set<std::string> *excludeFiles = nullptr);
 104
 105 /**
 106  * Search for PHP or non-PHP files under a directory, calling callback for
 107  * each one found.
 108  */
 109 template <typename F>
 110 void find(std::vector<std::string> &out,
 111           const std::string &root, const std::string& path, bool php,
 112           const F& callback);
 113
 114 /**
 115  * Determines if a given string is a valid path or not
 116  * (ie: contains no null bytes)
 117  */
 118 bool isValidPath(const String& path);
 119
 120 /**
 121  * Helper functions for use with FileUtil::isValidPath
 122  */
 123 bool checkPathAndWarn(const String& path,
 124                       const char* func_name,
 125                       int param_pos);
 126 void checkPathAndError(const String& path,
 127                        const char* func_name,
 128                        int param_pos);
 129
 130 /**
 131  * If any parent of the directory the script cmd was run from includes the
 132  * relative path suffix, and the file at that path is readable, then perform
 133  * action() on that file. Continues processing up the directory tree until
 134  * action() returns true.
 135  */
 136 template <class Action>
 137 bool runRelative(std::string suffix, String cmd,
 138                  const char* currentDir, Action action);
 139
 140 bool isSystemName(folly::StringPiece path);
 141
 142 ///////////////////////////////////////////////////////////////////////////////
 143 }
 144 }
 145
 146 #endif