-
Notifications
You must be signed in to change notification settings - Fork 7
/
smSiteConfig.inc
353 lines (285 loc) · 11.8 KB
/
smSiteConfig.inc
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
<?php
/**
* Roadsend SiteManager
*******************************************************************
* Copyright (c) 2001-2003 Roadsend, Inc.(http://www.roadsend.com)
*******************************************************************
*
* This source file is subject to version 1.0 of the Roadsend Public
* License, that is bundled with this package in the file
* LICENSE, and is available through the world wide web at
* http://www.roadsend.com/license/rpl1.txt
*
*******************************************************************
* Author(s): Shannon Weyrick (weyrick@roadsend.com)
*
*/
/**
* the main interface to the Global Configuration System
*
* @author Shannon Weyrick <weyrick@roadsend.com>
* @package roadsend_siteManager
* @subpackage siteManager_config
*/
class SM_siteConfig {
/**
* GLOBAL site configuration, from SM_GLOBAL_CONFIG_FILE
* @var SM_config
*/
var $globalConfig = NULL;
/**
* LOCAL site configuration, possibly from mutliple files
* @var SM_config
*/
var $localConfig = NULL;
/**
* constructor, will load SM_GLOBAL_CONFIG_FILE if not passed as global
*/
function SM_siteConfig($globalFile=NULL) {
global $SM_rootDir;
if ($globalFile == NULL) {
$globalFile = $SM_rootDir.SM_GLOBAL_CONFIG_FILE;
}
// local global config file, no caching
$this->globalConfig = new SM_config($globalFile, false);
}
/**
* load a local site configuration into $localConfig object
* @param string $file the SMCONFIG XSM file to load
*/
function loadSite($file,$tryCache=true) {
if (!isset($this->localConfig)) {
// if we can't find it, set SM_develState by hand
// since it might not be set appropriately yet
if (!file_exists($file)) {
$GLOBALS['SM_develState'] = true;
}
$this->localConfig = new SM_config($file);
}
else {
$this->localConfig->loadSite($file,$tryCache);
}
}
/**
* dump config values for this SITE and GLOBAL
*/
function dumpInfo() {
$_dOp = '';
$_dOp .= get_class($this)." :: configuration information:<br />\n";
$_dOp .= "<br />- GLOBAL VALUES -<br />\n";
$_dOp .= $this->globalConfig->dumpInfo();
$_dOp .= '<hr />';
$_dOp .= "<br />- LOCAL SITE VALUES -<br />\n";
$_dOp .= $this->localConfig->dumpInfo();
return $_dOp;
}
/**
* get a value from the GLOBAL config file (only)
* @param string $section the section to use for lookup
* @param string $name the "key" from the key/value pair you're looking for
* @param string $sectionID the sectionID to examine
* @param string $attr the attribute to retrieve from this VAR tag. default: VALUE
*/
function getGlobalVar($section, $name, $sectionID='default', $attr='VALUE') {
return $this->globalConfig->getVar($section,$name,$sectionID,$attr);
}
/**
* get a value from the LOCAL config file (only)
* @param string $section the section to use for lookup
* @param string $name the "key" from the key/value pair you're looking for
* @param string $sectionID the sectionID to examine
* @param string $attr the attribute to retrieve from this VAR tag. default: VALUE
*/
function getLocalVar($section, $name, $sectionID='default', $attr='VALUE') {
return $this->localConfig->getVar($section,$name,$sectionID,$attr);
}
/**
* get a variable from this config class
* TODO optimize this (weyrick)
* @param string $section the section to use for lookup
* @param string $name the "key" from the key/value pair you're looking for
* @param bool $mergeGlobal when true, GLOBAL and local siteID values will be merged,
* and the results returned as an array. otherwise, local
* siteID would be used by default, only going to GLOBAL if
* a local value wasn't set
* @param string $sectionID the sectionID to examine
* @param string $attr the attribute to retrieve from this VAR tag. default: VALUE
* @return mixed the value for the variable requested
*/
function getVar($section, $name, $mergeGlobal=false, $sectionID='', $attr='VALUE') {
// get global value first
$gVar = $this->globalConfig->getVar($section,$name,$sectionID,$attr);
// if for some reason a local site hasn't been loaded, just return global
if (!isset($this->localConfig)) {
return $gVar;
}
// get local value
$lVar = $this->localConfig->getVar($section,$name,$sectionID,$attr);
if ($mergeGlobal && isset($lVar)) {
// we should mergeglobal, AND there's already a value in
// siteID -- so merge
// local must come before global in the array
// four possibilities:
// 1) global is single, local is single
// 2) global is an array, local is array
// 3) global is an array, local is single
// 4) global is single, local is an array
// Get the values once, insted of in each if block
$gVarIsArray = is_array($gVar);
$lVarIsArray = is_array($lVar);
// 1
if (!$gVarIsArray && !is_array($lVar)) {
// both single, so merge to array
$endVar = array($lVar, $gVar);
}
// 2
elseif ($gVarIsArray && $lVarIsArray) {
// both arrays, so merge arrays
$endVar = array_merge($lVar, $gVar);
}
// 3
elseif ($gVarIsArray && !$lVarIsArray) {
// GLOBAL is array, local is not
$endVar = $gVar;
$endVar[] = $lVar;
$endVar = array_reverse($endVar); // reverse so local overrides global
}
// 4
elseif (!$gVarIsArray && $lVarIsArray) {
// GLOBAL is single, local is array
$lVar[] = $gVar;
$endVar = $lVar;
}
// whew!
return $endVar;
}
elseif (!isset($lVar)) {
// they want mergeglobal, but local wasn't set, just return global
// OR
// they only want local, but it's not set, return global instead
return $gVar;
}
elseif (!$mergeGlobal && isset($lVar)) {
// they only want local, and it's set so return it
return $lVar;
}
else {
// shouldn't get here!
$this->fatalErrorPage("getVar(): shouldn't reach this!");
}
}
/**
* return an entire section at a time
* it will combine GLOBAL with the current SITEID, with SITEID takeing precedence over GLOBAL
* @param string $section the section to return
* @param string $sectionID the section ID to examine
* @param string $attr the attribute to retrieve from VARs in this section. default; VALUE
* @return array a hash of all values in the section requested
*/
function getSection($section, $sectionID='',$attr='VALUE') {
$gSection = $this->globalConfig->getSection($section, $sectionID, $attr);
if (!is_array($gSection))
$gSection = array();
if (isset($this->localConfig)) {
$sSection = $this->localConfig->getSection($section, $sectionID, $attr);
$section = array_merge((array)$gSection, (array)$sSection);
}
else {
$section = $gSection;
}
return $section;
}
/**
* return an entire section at a time, from LOCAL config only
* it will combine GLOBAL with the current SITEID, with SITEID takeing precedence over GLOBAL
* @param string $section the section to return
* @param string $sectionID the section ID to examine
* @param string $attr the attribute to retrieve from VARs in this section. default; VALUE
* @return array a hash of all values in the section requested
*/
function getLocalSection($section, $sectionID='',$attr='VALUE') {
if (isset($this->localConfig)) {
return $this->localConfig->getSection($section, $sectionID, $attr);
}
else {
return NULL;
}
}
/**
* return an entire section at a time, from LOCAL config only
* it will combine GLOBAL with the current SITEID, with SITEID takeing precedence over GLOBAL
* @param string $section the section to return
* @param string $sectionID the section ID to examine
* @param string $attr the attribute to retrieve from VARs in this section. default; VALUE
* @return array a hash of all values in the section requested
*/
function getGlobalSection($section, $sectionID='',$attr='VALUE') {
return $this->globalConfig->getSection($section, $sectionID, $attr);
}
/**
* discover whether a particular section has mutltiple ID's
* @param string $section the SECTION to examine
* @return bool true if this SECTION has mutliple ID's in either GLOBAL or LOCAL
*/
function hasMultipleID($section) {
if ($this->globalConfig->hasMultipleID($section) ||
$this->localConfig->hasMultipleID($section))
return true;
else
return false;
}
/**
* retrieve the list of ID's a SECTION contains
* @param string $section the SECTION to examine
* @return array a list of id's
*/
function getIDlist($section) {
$lList = $this->localConfig->getIDlist($section);
$gList = $this->globalConfig->getIDlist($section);
if (($lList === NULL)&&($gList === NULL)) {
return NULL;
}
if ($lList === NULL) {
return $gList;
}
if ($gList === NULL) {
return $lList;
}
// fall through - both not null
$idList = array_merge($gList, $lList);
return array_unique($idList);
}
/**
* set a variable, based on section, name and siteID
* @param string $section the section to use for lookup
* @param string $name the "key" from the key/value pair you want to write
* @param mixed $newVal the new value of the key specified
* @param string $siteID the siteID to use. current SITEID by default (deprecated)
* @param string $sectionID the section ID to update
* @param bool $replace if the value already exists, should it be replaced or appended to (as array)?
* @param string $attr the attribute to update, defaults to VALUE
*/
function setVar($section, $name, $newVal, $siteID='SITEID', $sectionID='default', $replace=false, $attr='VALUE') {
// must have local site loaded first
if (!isset($this->localConfig))
return;
// add it in (replace)
$this->localConfig->addVar($section, $sectionID, $name, array($attr => $newVal), $replace);
}
/**
* a wrapper method for replacing a simple variable
* @param string $section the section to use for lookup
* @param string $name the "key" from the key/value pair you want to write
* @param mixed $newVal the new value of the key specified
* @param string $sectionID the section ID to update
* @param string $attr the attribute to update, defaults to VALUE
*/
function replaceVar($section, $name, $newVal, $sectionID='default', $attr='VALUE') {
// must have local site loaded first
if (!isset($this->localConfig))
return;
// add it in (replace)
$this->localConfig->addVar($section, $sectionID, $name, array($attr => $newVal), true);
}
}
?>