FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
zipprovider.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library 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 GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 // Standard C++ library includes
23 #include <iostream>
24 
25 // 3rd party library includes
26 
27 // FIFE includes
28 // These includes are split up in two parts, separated by one empty line
29 // First block: files included from the FIFE root src directory
30 // Second block: files included from the same folder
31 #include "util/base/exception.h"
32 #include "vfs/vfs.h"
33 
34 #include "zipprovider.h"
35 #include "zipsource.h"
36 
37 namespace FIFE {
38  bool ZipProvider::isReadable(const std::string& file) const {
39  // File name must have a .zip extension:
40  // TODO: Case sensitive?
41  if (file.find(".zip") == std::string::npos)
42  return false;
43 
44  // File should exist:
45  if (!getVFS()->exists(file))
46  return false;
47 
48  // File should start with the bytes "PK":
49  // TODO: ...
50 
51  return true;
52  }
53 
54  FIFE::VFSSource* ZipProvider::createSource(const std::string& file) {
55  if (isReadable(file)) {
56  VFSSource* source = NULL;
57  if ( hasSource(file)) {
58  source = m_sources[file];
59  } else {
60  source = new ZipSource(getVFS(), file);
61  m_sources[file] = source;
62  }
63  return source;
64  }
65  else
66  throw Exception("File " + file + " is not readable.");
67  }
68 
69  VFSSource* ZipProvider::getSource(const std::string& path) const {
70  VFSSource* source = NULL;
71  if (hasSource(path)) {
72  source = m_sources.find(path)->second;
73  }
74  return source;
75  }
76 
77  bool ZipProvider::hasSource(const std::string & path) const {
78  return m_sources.count(path) > 0;
79  }
80 }
bool exists(const std::string &file) const
Check if the given file exists.
Definition: vfs.cpp:146
VFSSource abstract baseclass.
Definition: vfssource.h:46
bool isReadable(const std::string &file) const
Check if a given file is readable for this VFSSource.
Definition: zipprovider.cpp:38
Exception base class.
Definition: exception.h:43
Implements a Zip archive file source.
Definition: zipsource.h:46
std::map< std::string, VFSSource * > m_sources
Definition: zipprovider.h:52
VFSSource * getSource(const std::string &path) const
Get the source instance of the path.
Definition: zipprovider.cpp:69
virtual bool hasSource(const std::string &path) const
Check whether the provider already has created a source with that path.
Definition: zipprovider.cpp:77
VFSSource * createSource(const std::string &file)
Create a new instance of a VFSSource initialized with the given file.
Definition: zipprovider.cpp:54