1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
Ousía
Copyright (C) 2014, 2015 Benjamin Paaßen, Andreas Stöckel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef NDEBUG
//#define FILELOCATOR_DEBUG_PRINT
#endif
#ifdef FILELOCATOR_DEBUG_PRINT
#include <iostream>
#endif
#include <algorithm>
#include <fstream>
#include <boost/filesystem.hpp>
#include "FileLocator.hpp"
#include "SpecialPaths.hpp"
namespace fs = boost::filesystem;
namespace ousia {
void FileLocator::addPath(const std::string &path,
std::vector<std::string> &paths)
{
auto it = std::find(paths.begin(), paths.end(), path);
if (it == paths.end()) {
paths.push_back(path);
}
}
void FileLocator::addSearchPath(const std::string &path,
std::set<ResourceType> types)
{
// Skip empty or non-existant paths
if (path.empty() || !fs::exists(path) || !fs::is_directory(path)) {
return;
}
// Canonicalize the given path, check whether it exists
std::string canonicalPath = fs::canonical(path).generic_string();
#ifdef FILELOCATOR_DEBUG_PRINT
std::cout << "FileLocator: Adding search path " << canonicalPath
<< std::endl;
#endif
// Insert the path for all given types.
for (auto &type : types) {
auto it = searchPaths.find(type);
if (it != searchPaths.end()) {
addPath(canonicalPath, it->second);
} else {
searchPaths.insert({type, {canonicalPath}});
}
}
}
void FileLocator::addSearchPath(const std::string &path, ResourceType type)
{
addSearchPath(path, std::set<ResourceType>{type});
}
void FileLocator::addDefaultSearchPaths(const std::string &relativeTo)
{
// Abort if the base directory is empty
if (relativeTo.empty() || !fs::exists(relativeTo) ||
!fs::is_directory(relativeTo)) {
return;
}
// Add the search paths
fs::path base{relativeTo};
addSearchPath(base.generic_string(), ResourceType::UNKNOWN);
addSearchPath((base / "domain").generic_string(),
ResourceType::DOMAIN_DESC);
addSearchPath((base / "typesystem").generic_string(),
ResourceType::TYPESYSTEM);
}
void FileLocator::addDefaultSearchPaths()
{
addDefaultSearchPaths(SpecialPaths::getGlobalDataDir());
addDefaultSearchPaths(SpecialPaths::getLocalDataDir());
#ifndef NDEBUG
addDefaultSearchPaths(SpecialPaths::getDebugDataDir());
#endif
// also add working directory.
addSearchPath(".", {ResourceType::UNKNOWN, ResourceType::DOMAIN_DESC,
ResourceType::TYPESYSTEM, ResourceType::DOCUMENT,
ResourceType::ATTRIBUTES, ResourceType::STYLESHEET,
ResourceType::SCRIPT, ResourceType::DATA});
}
void FileLocator::addUnittestSearchPath(const std::string &subdir,
ResourceType type)
{
addSearchPath((fs::path{SpecialPaths::getDebugTestdataDir()} / subdir)
.generic_string(),
type);
}
static bool checkPath(Resource &resource, const ResourceLocator &locator,
fs::path p, const ResourceType type)
{
if (fs::exists(p) && fs::is_regular_file(p)) {
std::string location = fs::canonical(p).generic_string();
#ifdef FILELOCATOR_DEBUG_PRINT
std::cout << "FileLocator: Found at " << location << std::endl;
#endif
resource = Resource(true, locator, type, location);
return true;
}
return false;
}
bool FileLocator::doLocate(Resource &resource, const std::string &path,
const ResourceType type,
const std::string &relativeTo) const
{
#ifdef FILELOCATOR_DEBUG_PRINT
std::cout << "FileLocator: Searching for \"" << path << "\"" << std::endl;
#endif
// TODO: Check if with ./book.oxm relative paths are used and otherwise
// global search paths take precedence.
// If the path is an absolute path, look at this exact point.
{
fs::path p{path};
if (p.is_absolute()) {
if (checkPath(resource, *this, p, type)) {
return true;
} else {
return false;
}
}
}
// If the path starts with "./" or "../" only perform relative lookups!
if (path.substr(0, 2) != "./" && path.substr(0, 3) != "../") {
// Look in the search paths, search backwards, last defined search
// paths have a higher precedence
auto it = searchPaths.find(type);
if (it != searchPaths.end()) {
const auto &paths = it->second;
for (auto it = paths.rbegin(); it != paths.rend(); it++) {
#ifdef FILELOCATOR_DEBUG_PRINT
std::cout << "FileLocator: Entering " << *it << std::endl;
#endif
fs::path p{*it};
p /= path;
if (checkPath(resource, *this, p, type)) {
return true;
}
}
}
}
if (!relativeTo.empty()) {
fs::path base(relativeTo);
if (fs::exists(base)) {
// Look if 'relativeTo' is a directory already.
if (!fs::is_directory(base)) {
// If not we use the parent directory.
base = base.parent_path();
}
// Use the / operator to append the path.
base /= path;
// If we already found a fitting resource there, use that.
if (checkPath(resource, *this, base, type)) {
return true;
}
}
}
return false;
}
std::unique_ptr<std::istream> FileLocator::doStream(
const std::string &location) const
{
return std::unique_ptr<std::istream>{new std::ifstream(location)};
}
}
|
