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
|
<?php
/**
* Via this class Zoph can read configurations from the database
* the configurations themselves are stored in conf\item objects
*
* This file is part of Zoph.
*
* Zoph 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 2 of the License, or
* (at your option) any later version.
*
* Zoph 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 Zoph; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @package Zoph
* @author Jeroen Roos
*/
namespace conf;
use PDO;
use db\select;
use db\param;
use db\delete;
use db\db;
use db\clause;
use log;
use zoph\app;
/**
* conf is the main object for access to Zoph's configuration
* in the database
*
* @package Zoph
* @author Jeroen Roos
*/
class conf {
/**
* @var array Groups are one or more configuration objects that
* belong together;
*/
private static $groups=array();
/** @var bool whether or not the configuration has been loaded from the db */
private static $loaded=false;
/** @var array During loading from database this will be filled with warnings (if any)
These can later be displayed through conf::getWarnings() */
private static $warnings=array();
/**
* Get the Id of the conf item
*/
public function getId() {
return $this->get("conf_id");
}
/**
* Read configuration from database
*/
public static function loadFromDB() {
confDefault::getConfig();
$qry=new select(array("co" => "conf"));
$qry->addFields(array("conf_id", "value"));
try {
$result=db::query($qry);
} catch (\PDOException $e) {
log::msg("Cannot load configuration from database", log::FATAL, log::CONFIG | log::DB);
}
while ($row = $result->fetch(PDO::FETCH_NUM)) {
$key=$row[0];
$value=$row[1];
try {
$item=static::getItemByName($key);
try {
$item->setValue($value);
if ($item->isDeprecated() && $value != $item->getDefault()) {
static::$warnings[]="Deprecated configuration item <b>" . $key . "</b> is used!";
}
} catch (\configurationException $e) {
/* An illegal value is automatically set to the default */
log::msg($e->getMessage(), log::ERROR, log::CONF);
}
} catch (\configurationException $e) {
/* An unknown item will automatically be deleted from the
database, so we can remove items without leaving a mess */
log::msg($e->getMessage(), log::NOTIFY, log::CONF);
$qry=new delete(array("co" => "conf"));
$qry->where(new clause("conf_id=:confid"));
$qry->addParam(new param(":confid", $key, PDO::PARAM_STR));
$qry->execute();
}
}
static::$loaded=true;
}
/**
* Read configuration from submitted form
* @param array of $_GET or $_POST variables
*/
public static function loadFromRequestVars(array $vars) {
conf::loadFromDB();
foreach ($vars as $key => $value) {
if (substr($key, 0, 1) == "_") {
if (substr($key, 0, 7) == "_reset_") {
$key=substr(str_replace("_", ".", $key), 7);
$item=static::getItemByName($key);
$item->delete();
}
continue;
}
$key=str_replace("_", ".", $key);
try {
if (!isset($vars["_reset_" . $key])) {
$item=static::getItemByName($key);
$item->setValue($value);
$item->update();
}
} catch (\configurationException $e) {
log::msg("Configuration cannot be updated: " .
$e->getMessage(), log::ERROR, log::CONFIG);
}
}
static::$loaded=true;
}
/**
* Get a configuration item by name
* @param string Name of item to return
* @return \conf\item\item Configuration item
* @throws \configurationException
*/
public static function getItemByName($name) {
$nameArr=explode(".", $name);
$group=array_shift($nameArr);
if (isset(static::$groups[$group])) {
$items=static::$groups[$group]->getItems();
if (isset($items[$name])) {
return $items[$name];
}
}
throw new \configurationException("Unknown configuration item " . $name);
}
/**
* Get the value of a configuration item
* @param string Name of item to return
* @return string Value of parameter
*/
public static function get($key) {
if (app::getMode(app::INSTALL)) {
minimal::getConfig();
} else if (!static::$loaded) {
static::loadFromDB();
}
$item=static::getItemByName($key);
return $item->getValue();
}
/**
* Set the value of a configuration item
* Does not store this value in the database as this is mainly
* used for runtime-overriding a stored value. This function returns
* the object so the calling function can do a $item->update() if
* it should be stored in the db.
* @param string Name of item to change
* @param string Value to set
* @return \conf\item\item the item that has been updated
*/
public static function set($key, $value) {
if (!static::$loaded) {
static::loadFromDB();
}
$item=static::getItemByName($key);
$item->setValue($value);
return $item;
}
/**
* Get all configuration items (in groups)
* @return array Array of group objects
*/
public static function getAll() {
if (!static::$loaded) {
static::loadFromDB();
}
return static::$groups;
}
/**
* Create a new conf\group and add it to the list
* @param collection collection to add as group
* @param string name
* @param string label
* @param string description
*/
public static function addGroup(collection $collection, $name, $label, $desc = "", $hidden = false) {
$group = new group($collection);
$group->setName($name);
$group->setLabel($label);
$group->setDesc($desc);
if ($hidden) {
$group->setHidden();
}
static::$groups[$name]=$group;
return $group;
}
/**
* Return warnings generated while loading configuration
*/
public static function getWarnings() {
return static::$warnings;
}
}
|
