hphp/util/file-cache.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-2013 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 #ifndef incl_HPHP_FILE_CACHE_H_
  18 #define incl_HPHP_FILE_CACHE_H_
  19
  20 #include <memory>
  21 #include <string>
  22
  23 #include "hphp/util/base.h"
  24
  25 namespace HPHP {
  26
  27 /**
  28  * Stores file contents in memory. Used by web server for faster static
  29  * content serving.
  30  */
  31 DECLARE_BOOST_TYPES(FileCache);
  32
  33 class CacheManager;
  34
  35 class FileCache {
  36  public:
  37   static std::string SourceRoot;
  38   static bool UseNewCache;
  39
  40  public:
  41   FileCache();
  42   ~FileCache();
  43
  44   /**
  45    * Archiving data.
  46    */
  47
  48   void write(const char *name);   // just the name
  49   void write(const char *name, const char *fullpath); // name + data
  50
  51   void save(const char *filename);
  52
  53   /**
  54    * Reading data.
  55    */
  56   void loadMmap(const char *filename);
  57   bool fileExists(const char *name, bool isRelative = true) const;
  58   bool dirExists(const char *name, bool isRelative = true) const;
  59   bool exists(const char *name, bool isRelative = true) const;
  60   char *read(const char *name, int &len, bool &compressed) const;
  61   int64_t fileSize(const char *name, bool isRelative) const;
  62   void dump() const;
  63
  64   static std::string GetRelativePath(const char *path);
  65
  66  private:
  67   std::unique_ptr<CacheManager> cache_manager_;
  68 };
  69
  70 }   // namespace HPHP
  71
  72 #endif  // incl_HPHP_FILE_CACHE_H_