common/fs.cpp

   1 /* ScummVM - Graphic Adventure Engine
   2  *
   3  * ScummVM is the legal property of its developers, whose names
   4  * are too numerous to list here. Please refer to the COPYRIGHT
   5  * file distributed with this source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  *
  21  * $URL$
  22  * $Id$
  23  */
  24
  25 #include "common/util.h"
  26 #include "common/system.h"
  27 #include "backends/fs/abstract-fs.h"
  28 #include "backends/fs/fs-factory.h"
  29
  30 namespace Common {
  31
  32 FSNode::FSNode() {
  33 }
  34
  35 FSNode::FSNode(AbstractFSNode *realNode)
  36         : _realNode(realNode) {
  37 }
  38
  39 FSNode::FSNode(const Common::String &p) {
  40         assert(g_system);
  41         FilesystemFactory *factory = g_system->getFilesystemFactory();
  42         AbstractFSNode *tmp = 0;
  43
  44         if (p.empty() || p == ".")
  45                 tmp = factory->makeCurrentDirectoryFileNode();
  46         else
  47                 tmp = factory->makeFileNodePath(p);
  48         _realNode = Common::SharedPtr<AbstractFSNode>(tmp);
  49 }
  50
  51 bool FSNode::operator<(const FSNode& node) const {
  52         if (isDirectory() != node.isDirectory())
  53                 return isDirectory();
  54
  55         return getDisplayName().compareToIgnoreCase(node.getDisplayName()) < 0;
  56 }
  57
  58 bool FSNode::exists() const {
  59         if (_realNode == 0)
  60                 return false;
  61
  62         return _realNode->exists();
  63 }
  64
  65 FSNode FSNode::getChild(const Common::String &n) const {
  66         // If this node is invalid or not a directory, return an invalid node
  67         if (_realNode == 0 || !_realNode->isDirectory())
  68                 return FSNode();
  69
  70         AbstractFSNode *node = _realNode->getChild(n);
  71         return FSNode(node);
  72 }
  73
  74 bool FSNode::getChildren(FSList &fslist, ListMode mode, bool hidden) const {
  75         if (!_realNode || !_realNode->isDirectory())
  76                 return false;
  77
  78         AbstractFSList tmp;
  79
  80         if (!_realNode->getChildren(tmp, mode, hidden))
  81                 return false;
  82
  83         fslist.clear();
  84         for (AbstractFSList::iterator i = tmp.begin(); i != tmp.end(); ++i) {
  85                 fslist.push_back(FSNode(*i));
  86         }
  87
  88         return true;
  89 }
  90
  91 Common::String FSNode::getDisplayName() const {
  92         assert(_realNode);
  93         return _realNode->getDisplayName();
  94 }
  95
  96 Common::String FSNode::getName() const {
  97         assert(_realNode);
  98         return _realNode->getName();
  99 }
 100
 101 FSNode FSNode::getParent() const {
 102         if (_realNode == 0)
 103                 return *this;
 104
 105         AbstractFSNode *node = _realNode->getParent();
 106         if (node == 0) {
 107                 return *this;
 108         } else {
 109                 return FSNode(node);
 110         }
 111 }
 112
 113 Common::String FSNode::getPath() const {
 114         assert(_realNode);
 115         return _realNode->getPath();
 116 }
 117
 118 bool FSNode::isDirectory() const {
 119         if (_realNode == 0)
 120                 return false;
 121
 122         return _realNode->isDirectory();
 123 }
 124
 125 bool FSNode::isReadable() const {
 126         if (_realNode == 0)
 127                 return false;
 128
 129         return _realNode->isReadable();
 130 }
 131
 132 bool FSNode::isWritable() const {
 133         if (_realNode == 0)
 134                 return false;
 135
 136         return _realNode->isWritable();
 137 }
 138
 139 Common::SeekableReadStream *FSNode::createReadStream() const {
 140         if (_realNode == 0)
 141                 return 0;
 142
 143         if (!_realNode->exists()) {
 144                 warning("FSNode::createReadStream: FSNode does not exist");
 145                 return false;
 146         } else if (_realNode->isDirectory()) {
 147                 warning("FSNode::createReadStream: FSNode is a directory");
 148                 return false;
 149         }
 150
 151         return _realNode->createReadStream();
 152 }
 153
 154 Common::WriteStream *FSNode::createWriteStream() const {
 155         if (_realNode == 0)
 156                 return 0;
 157
 158         if (_realNode->isDirectory()) {
 159                 warning("FSNode::createWriteStream: FSNode is a directory");
 160                 return 0;
 161         }
 162
 163         return _realNode->createWriteStream();
 164 }
 165
 166 FSDirectory::FSDirectory(const FSNode &node, int depth, bool flat)
 167   : _node(node), _cached(false), _depth(depth), _flat(flat) {
 168 }
 169
 170 FSDirectory::FSDirectory(const String &prefix, const FSNode &node, int depth, bool flat)
 171   : _node(node), _cached(false), _depth(depth), _flat(flat) {
 172
 173         setPrefix(prefix);
 174 }
 175
 176 FSDirectory::FSDirectory(const String &name, int depth, bool flat)
 177   : _node(name), _cached(false), _depth(depth), _flat(flat) {
 178 }
 179
 180 FSDirectory::FSDirectory(const String &prefix, const String &name, int depth, bool flat)
 181   : _node(name), _cached(false), _depth(depth), _flat(flat) {
 182
 183         setPrefix(prefix);
 184 }
 185
 186 FSDirectory::~FSDirectory() {
 187 }
 188
 189 void FSDirectory::setPrefix(const String &prefix) {
 190         _prefix = prefix;
 191
 192         if (!_prefix.empty() && !_prefix.hasSuffix("/"))
 193                 _prefix += "/";
 194 }
 195
 196 FSNode FSDirectory::getFSNode() const {
 197         return _node;
 198 }
 199
 200 FSNode *FSDirectory::lookupCache(NodeCache &cache, const String &name) const {
 201         // make caching as lazy as possible
 202         if (!name.empty()) {
 203                 ensureCached();
 204
 205                 if (cache.contains(name))
 206                         return &cache[name];
 207         }
 208
 209         return 0;
 210 }
 211
 212 bool FSDirectory::hasFile(const String &name) {
 213         if (name.empty() || !_node.isDirectory())
 214                 return false;
 215
 216         FSNode *node = lookupCache(_fileCache, name);
 217         return node && node->exists();
 218 }
 219
 220 ArchiveMemberPtr FSDirectory::getMember(const String &name) {
 221         if (name.empty() || !_node.isDirectory())
 222                 return ArchiveMemberPtr();
 223
 224         FSNode *node = lookupCache(_fileCache, name);
 225
 226         if (!node || !node->exists()) {
 227                 warning("FSDirectory::getMember: FSNode does not exist");
 228                 return ArchiveMemberPtr();
 229         } else if (node->isDirectory()) {
 230                 warning("FSDirectory::getMember: FSNode is a directory");
 231                 return ArchiveMemberPtr();
 232         }
 233
 234         return ArchiveMemberPtr(new FSNode(*node));
 235 }
 236
 237 SeekableReadStream *FSDirectory::createReadStreamForMember(const String &name) const {
 238         if (name.empty() || !_node.isDirectory())
 239                 return 0;
 240
 241         FSNode *node = lookupCache(_fileCache, name);
 242         if (!node)
 243                 return 0;
 244         SeekableReadStream *stream = node->createReadStream();
 245         if (!stream)
 246                 warning("FSDirectory::createReadStreamForMember: Can't create stream for file '%s'", name.c_str());
 247
 248         return stream;
 249 }
 250
 251 FSDirectory *FSDirectory::getSubDirectory(const String &name, int depth, bool flat) {
 252         return getSubDirectory(String::emptyString, name, depth, flat);
 253 }
 254
 255 FSDirectory *FSDirectory::getSubDirectory(const String &prefix, const String &name, int depth, bool flat) {
 256         if (name.empty() || !_node.isDirectory())
 257                 return 0;
 258
 259         FSNode *node = lookupCache(_subDirCache, name);
 260         if (!node)
 261                 return 0;
 262
 263         return new FSDirectory(prefix, *node, depth, flat);
 264 }
 265
 266 void FSDirectory::cacheDirectoryRecursive(FSNode node, int depth, const String& prefix) const {
 267         if (depth <= 0)
 268                 return;
 269
 270         FSList list;
 271         node.getChildren(list, FSNode::kListAll, false);
 272
 273         FSList::iterator it = list.begin();
 274         for ( ; it != list.end(); ++it) {
 275                 String name = prefix + it->getName();
 276
 277                 // don't touch name as it might be used for warning messages
 278                 String lowercaseName = name;
 279                 lowercaseName.toLowercase();
 280
 281                 // since the hashmap is case insensitive, we need to check for clashes when caching
 282                 if (it->isDirectory()) {
 283                         if (!_flat && _subDirCache.contains(lowercaseName)) {
 284                                 warning("FSDirectory::cacheDirectory: name clash when building cache, ignoring sub-directory '%s'", name.c_str());
 285                         } else {
 286                                 if (_subDirCache.contains(lowercaseName)) {
 287                                         warning("FSDirectory::cacheDirectory: name clash when building subDirCache with subdirectory '%s'", name.c_str());
 288                                 }
 289                                 cacheDirectoryRecursive(*it, depth - 1, _flat ? prefix : lowercaseName + "/");
 290                                 _subDirCache[lowercaseName] = *it;
 291                         }
 292                 } else {
 293                         if (_fileCache.contains(lowercaseName)) {
 294                                 warning("FSDirectory::cacheDirectory: name clash when building cache, ignoring file '%s'", name.c_str());
 295                         } else {
 296                                 _fileCache[lowercaseName] = *it;
 297                         }
 298                 }
 299         }
 300
 301 }
 302
 303 void FSDirectory::ensureCached() const  {
 304         if (_cached)
 305                 return;
 306         cacheDirectoryRecursive(_node, _depth, _prefix);
 307         _cached = true;
 308 }
 309
 310 int FSDirectory::listMatchingMembers(ArchiveMemberList &list, const String &pattern) {
 311         if (!_node.isDirectory())
 312                 return 0;
 313
 314         // Cache dir data
 315         ensureCached();
 316
 317         String lowercasePattern(pattern);
 318         lowercasePattern.toLowercase();
 319
 320         int matches = 0;
 321         NodeCache::iterator it = _fileCache.begin();
 322         for ( ; it != _fileCache.end(); ++it) {
 323                 if (it->_key.matchString(lowercasePattern, true)) {
 324                         list.push_back(ArchiveMemberPtr(new FSNode(it->_value)));
 325                         matches++;
 326                 }
 327         }
 328         return matches;
 329 }
 330
 331 int FSDirectory::listMembers(ArchiveMemberList &list) {
 332         if (!_node.isDirectory())
 333                 return 0;
 334
 335         // Cache dir data
 336         ensureCached();
 337
 338         int files = 0;
 339         for (NodeCache::iterator it = _fileCache.begin(); it != _fileCache.end(); ++it) {
 340                 list.push_back(ArchiveMemberPtr(new FSNode(it->_value)));
 341                 ++files;
 342         }
 343
 344         return files;
 345 }
 346
 347
 348 }       // End of namespace Common