src/filecache.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2012 Jonathan Neuschäfer <j.neuschaefer@gmx.net>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #ifndef FILECACHE_HEADER
  22 #define FILECACHE_HEADER
  23
  24 #include <string>
  25 #include <iostream>
  26
  27 class FileCache
  28 {
  29 public:
  30         /*
  31                 'dir' is the file cache directory to use.
  32         */
  33         FileCache(std::string dir):
  34                 m_dir(dir)
  35         {
  36         }
  37
  38         /*
  39                 Searches the cache for a file with a given name.
  40                 If the file is found, lookup copies it into 'os' and
  41                 returns true. Otherwise false is returned.
  42         */
  43         bool loadByName(const std::string &name, std::ostream &os);
  44
  45         /*
  46                 Stores a file in the cache based on its name.
  47                 Returns true on success, false otherwise.
  48         */
  49         bool updateByName(const std::string &name, const std::string &data);
  50
  51         /*
  52                 Loads a file based on a check sum, which may be any kind of
  53                 rather unique byte sequence. Returns true, if the file could
  54                 be written into os, false otherwise.
  55                 A file name is required to give the disk file a name that
  56                 has the right file name extension (e.g. ".png").
  57         */
  58         bool loadByChecksum(const std::string &name, std::ostream &os,
  59                         const std::string &checksum);
  60
  61         /*
  62                 Stores a file in the cache based on its checksum.
  63                 Returns true on success, false otherwise.
  64         */
  65         bool updateByChecksum(const std::string &name, const std::string &data,
  66                         const std::string &checksum);
  67
  68 private:
  69         std::string m_dir;
  70
  71         bool loadByPath(const std::string &name, std::ostream &os,
  72                         const std::string &path);
  73         bool updateByPath(const std::string &name, const std::string &data,
  74                         const std::string &path);
  75         std::string getPathFromChecksum(const std::string &name,
  76                         const std::string &checksum);
  77 };
  78
  79 #endif