This repository has been archived by the owner on Feb 21, 2019. It is now read-only.
/
module.cpp
496 lines (448 loc) · 14.7 KB
/
module.cpp
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
/*
* #%L
* OME-COMMON C++ library for C++ compatibility/portability
* %%
* Copyright © 2006 - 2016 Open Microscopy Environment:
* - Massachusetts Institute of Technology
* - National Institutes of Health
* - University of Dundee
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
#include <boost/filesystem/operations.hpp>
#include <boost/filesystem/path.hpp>
#include <boost/format.hpp>
#include <boost/range/size.hpp>
#include <ome/common/config-internal.h>
#include <ome/common/filesystem.h>
#define OME_COMMON_MODULE_INTROSPECTION 1
#include <ome/common/module.h>
#include <cstring>
#include <map>
#include <stdexcept>
namespace fs = boost::filesystem;
namespace
{
using ome::common::RegisterModule;
typedef std::map<std::string, ome::common::Module> path_map;
path_map&
module_paths()
{
static path_map pmap;
return pmap;
}
bool
validate_path(const fs::path& path)
{
return (fs::exists(path) && fs::is_directory(path));
}
void register_paths()
{
// Global paths (not specific to any component)
static RegisterModule bin
("bin",
"OME_BINDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_BINDIR,
OME_COMMON_INSTALL_BINDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule sbin
("sbin",
"OME_SBINDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_SBINDIR,
OME_COMMON_INSTALL_SBINDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule libexec
("libexec",
"OME_LIBEXECDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_LIBEXECDIR,
OME_COMMON_INSTALL_LIBEXECDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule sysconf
("sysconf",
"OME_SYSCONFDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_SYSCONFDIR,
OME_COMMON_INSTALL_SYSCONFDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule sharedstate
("sharedstate",
"OME_SHAREDSTATEDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_SHAREDSTATEDIR,
OME_COMMON_INSTALL_SHAREDSTATEDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule localstate
("localstate",
"OME_LOCALSTATEDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_LOCALSTATEDIR,
OME_COMMON_INSTALL_LOCALSTATEDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule lib
("lib",
"OME_LIBDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_LIBDIR,
OME_COMMON_INSTALL_LIBDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule include
("include",
"OME_INCLUDEDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_INCLUDEDIR,
OME_COMMON_INSTALL_INCLUDEDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule oldinclude
("oldinclude",
"OME_OLDINCLUDEDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_OLDINCLUDEDIR,
OME_COMMON_INSTALL_OLDINCLUDEDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule dataroot
("dataroot",
"OME_DATAROOTDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_DATAROOTDIR,
OME_COMMON_INSTALL_DATAROOTDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule data
("data",
"OME_DATADIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_DATADIR,
OME_COMMON_INSTALL_DATADIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule info
("info",
"OME_INFODIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_INFODIR,
OME_COMMON_INSTALL_INFODIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule locale
("locale",
"OME_LOCALEDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_LOCALEDIR,
OME_COMMON_INSTALL_LOCALEDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule man
("man",
"OME_MANDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_MANDIR,
OME_COMMON_INSTALL_MANDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
static RegisterModule doc
("doc",
"OME_DOCDIR",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_FULL_DOCDIR,
OME_COMMON_INSTALL_DOCDIR,
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
// OME-Common package-specific paths.
static RegisterModule bf_root
("ome-common-root",
"OME_COMMON_HOME",
"OME_COMMON_HOME",
"OME_HOME",
OME_COMMON_INSTALL_PREFIX,
"",
OME_COMMON_INSTALL_PREFIX,
OME_COMMON_SHLIBDIR,
module_path);
}
struct AutoRegister
{
AutoRegister()
{
register_paths();
}
};
AutoRegister path_register;
}
namespace ome
{
namespace common
{
Module::Module(const std::string& name,
const std::string& envvar,
const std::string& module_envvar,
const std::string& root_envvar,
const boost::filesystem::path& abspath,
const boost::filesystem::path& relpath,
const boost::filesystem::path& install_prefix,
const boost::filesystem::path& shlibpath,
boost::filesystem::path (*module_path)()):
name(name),
envvar(envvar),
module_envvar(module_envvar),
root_envvar(root_envvar),
abspath(abspath),
relpath(relpath),
install_prefix(install_prefix),
shlibpath(shlibpath),
realpath(),
module_path(module_path)
{
}
RegisterModule::RegisterModule(const std::string& name,
const std::string& envvar,
const std::string& module_envvar,
const std::string& root_envvar,
const boost::filesystem::path& abspath,
const boost::filesystem::path& relpath,
const boost::filesystem::path& install_prefix,
const boost::filesystem::path& shlibpath,
boost::filesystem::path (*module_path)()):
name(name),
registered(false)
{
Module m(name,
envvar, module_envvar, root_envvar,
abspath, relpath, install_prefix, shlibpath,
module_path);
path_map& map = module_paths();
registered = map.insert(std::make_pair(name, m)).second;
}
RegisterModule::~RegisterModule()
{
if (registered)
{
path_map& map = module_paths();
map.erase(name);
}
}
/* TESTING NOTE
* ────────────
*
* This code can't be unit tested since it is used after
* installation. This section documents the expected paths for
* different configurations.
*
* CMAKE_INSTALL_PREFIX=$install_path
* - will fail unless "make install" has run and the install tree
* is present and relocatable-install is OFF.
* - will work in the install tree and build tree if "make"
* install has run.
* - OME_COMMON_HOME or OME_HOME can override the hardcoded
* install prefix, but only if the new path contains an install
* tree.
*
* [install prefix ignored for self-contained distributions]
* - used for prepackaged builds
* - will fail in the build tree since there is no valid install
* - will work in the install tree since it will introspect the
* correct path if relocatable-install is OFF or ON and dladdr
* or GetModuleFileNameW are available (required to determine
* the library path)
* - OME_COMMON_HOME or OME_HOME can override the
* autodetected install prefix, but only if the new path
* contains an install tree.
*
* Testing:
* - With and without CMAKE_INSTALL_PREFIX set [default is /usr/local]
* - With relocatable-install set to OFF and ON
* - In the install and build trees
* - With and without OME_COMMON_HOME or OME_HOME
* - With and without OME_COMMON_HOME or OME_HOME set to a
* valid path
*
* Testing in the build tree verifies it fails correctly.
*
* The sequence of checking dtype "foo" is:
* - OME_$FOO env var
* - OME_COMMON_HOME or OME_HOME env var [if set] + FOO_RELATIVE_PATH
* - FOO_ABSOLUTE_PATH
* - OME_COMMON_INSTALL_PREFIX [if set] + FOO_RELATIVE_PATH
* - introspection [if possible] + FOO_RELATIVE_PATH
* - throw exception
*/
const fs::path&
module_runtime_path(const std::string& dtype)
{
path_map& paths(module_paths());
path_map::iterator ipath(paths.find(dtype));
// Is this a valid dtype?
if (ipath == paths.end())
{
boost::format fmt("Invalid runtime path type “%1%”");
fmt % dtype;
throw std::logic_error(fmt.str());
}
Module& module = ipath->second;
// Return cached result if previously determined.
if(!module.realpath.empty())
return module.realpath;
// dtype set explicitly in environment.
if (getenv(module.envvar.c_str()))
{
fs::path dir(getenv(module.envvar.c_str()));
if (validate_path(dir))
{
module.realpath = ome::common::canonical(dir);
return module.realpath;
}
}
// Full module path in environment + relative component
if (getenv(module.module_envvar.c_str()))
{
fs::path home(getenv(module.module_envvar.c_str()));
home /= module.relpath;
if (validate_path(home))
{
module.realpath = ome::common::canonical(home);
return module.realpath;
}
}
// Full root path in environment + relative component
if (getenv(module.root_envvar.c_str()))
{
fs::path home(getenv(module.root_envvar.c_str()));
home /= module.relpath;
if (validate_path(home))
{
module.realpath = ome::common::canonical(home);
return module.realpath;
}
}
// Full prefix is available only when configured explicitly.
if (validate_path(module.install_prefix))
{
// Full specific path.
if (validate_path(module.abspath))
{
module.realpath = ome::common::canonical(module.abspath);
return module.realpath;
}
// Full root path + relative component
fs::path home(module.install_prefix);
home /= module.relpath;
if (validate_path(home))
{
module.realpath = ome::common::canonical(home);
return module.realpath;
}
}
else
{
fs::path module_lib_path;
if (module.module_path)
{
module_lib_path = module.module_path();
}
if (module_lib_path.has_parent_path())
{
fs::path moduledir(module_lib_path.parent_path());
bool match = true;
fs::path libdir(module.shlibpath);
while(!libdir.empty())
{
if (libdir.filename() == moduledir.filename())
{
libdir = libdir.parent_path();
moduledir = moduledir.parent_path();
}
else
{
match = false;
break;
}
}
if (match && validate_path(moduledir))
{
moduledir /= module.relpath;
if (validate_path(moduledir))
{
module.realpath = ome::common::canonical(moduledir);
return module.realpath;
}
}
}
}
boost::format fmt("Could not determine runtime path for “%1%” directory");
fmt % dtype;
throw std::runtime_error(fmt.str());
}
void
register_module_paths()
{
register_paths();
}
}
}