r3698 init.php: get rid of RuntimeException
[racktables] / inc / config.php
CommitLineData
b325120a 1<?php
e673ee24 2/*
9c0b0016
DO
3 *
4 * This file used to hold a collection of constants, variables and arrays,
5 * which drived the way misc RackTables functions performed. Now most of
201056a2 6 * them have gone into the database, and there is a user interface
9c0b0016
DO
7 * for changing them. This file now provides a couple of functions to
8 * access the new config storage.
9 *
8d07e3e0
DO
10 */
11
8d07e3e0 12
9c0b0016 13// Current code version is subject to change with each new release.
1a228714 14define ('CODE_VERSION', '0.18.0');
7fa7047a
DO
15define ('CHAP_OBJTYPE', 1);
16define ('CHAP_PORTTYPE', 2);
e673ee24 17
ca3d68bd
DO
18$max_dict_key = array
19(
20 '0.17.0' => 988,
21 '0.17.1' => 988,
22 '0.17.2' => 1150,
70992855 23 '0.17.3' => 1150,
681f2138 24 '0.17.4' => 1150,
2803fbe6 25 '0.17.5' => 1322,
63811a09 26 '0.17.6' => 1326,
026a79ee 27 '0.17.7' => 1326,
ad9da675 28 '0.17.8' => 1334,
0e87ece7 29 '0.17.9' => 1334,
4b43f713 30 '0.17.10' => 1349,
4a4a5440
DO
31 '0.17.11' => 1349,
32 '0.18.0' => 1349,
4eeadb79 33 '0.18.1' => 1352,
ca3d68bd
DO
34);
35
b7b4b225
DO
36define ('TAGNAME_REGEXP', '/^[\p{L}0-9]([. _~-]?[\p{L}0-9])*$/u');
37define ('AUTOTAGNAME_REGEXP', '/^\$[\p{L}0-9]([. _~-]?[\p{L}0-9])*$/u');
05771508 38// The latter matches both SunOS and Linux-styled formats.
b7b4b225
DO
39define ('RE_L2_IFCFG', '/^[0-9a-f]{1,2}(:[0-9a-f]{1,2}){5}$/i');
40define ('RE_L2_CISCO', '/^[0-9a-f]{4}(\.[0-9a-f]{4}){2}$/i');
41define ('RE_L2_SOLID', '/^[0-9a-f]{12}$/i');
42define ('RE_L2_IPCFG', '/^[0-9a-f]{2}(-[0-9a-f]{2}){5}$/i');
43define ('RE_L2_WWN_COLON', '/^[0-9a-f]{1,2}(:[0-9a-f]{1,2}){7}$/i');
44define ('RE_L2_WWN_HYPHEN', '/^[0-9a-f]{2}(-[0-9a-f]{2}){7}$/i');
45define ('RE_L2_WWN_SOLID', '/^[0-9a-f]{16}$/i');
aeaf5779
DO
46define ('RE_IP4_ADDR', '#^[0-9]{1,3}(\.[0-9]{1,3}){3}$#');
47define ('RE_IP4_NET', '#^[0-9]{1,3}(\.[0-9]{1,3}){3}/[0-9]{1,2}$#');
52ce8bd7 48define ('E_8021Q_NOERROR', 0);
d973196a
DO
49define ('E_8021Q_VERSION_CONFLICT', 101);
50define ('E_8021Q_PULL_REMOTE_ERROR', 102);
51define ('E_8021Q_PUSH_REMOTE_ERROR', 103);
5701baec 52define ('E_8021Q_SYNC_DISABLED', 104);
65bff861 53define ('E_BAD_RACKCODE', 1);
e8900a2b 54define ('E_INTERNAL', 2);
bc90c415
DO
55define ('VLAN_MIN_ID', 1);
56define ('VLAN_MAX_ID', 4094);
57define ('VLAN_DFL_ID', 1);
26131670 58
3540d15c
DY
59function loadConfigDefaults() {
60 global $configCache;
61 $configCache = loadConfigCache();
62 if (!count ($configCache)) {
63 throw new RuntimeException('Failed to load configuration from the database.');
64 }
65 foreach ($configCache as $varname => &$row) {
66 $row['is_altered'] = 'no';
67 if ($row['vartype'] == 'uint') $row['varvalue'] = 0 + $row['varvalue'];
68 $row['defaultvalue'] = $row['varvalue'];
69 }
70}
71
72function alterConfigWithUserPreferences() {
73 global $configCache;
74 global $userConfigCache;
75 global $remote_username;
76 $userConfigCache = loadUserConfigCache($remote_username);
77 foreach($userConfigCache as $key => $row) {
78 if ($configCache[$key]['is_userdefined'] == 'yes') {
79 $configCache[$key]['varvalue'] = $row['varvalue'];
80 $configCache[$key]['is_altered'] = 'yes';
81 }
82 }
83}
84
85// Returns true if varname has a different value or varname is new
86function isConfigVarChanged($varname, $varvalue) {
87 global $configCache;
88 if (!isset ($configCache))
89 throw new RuntimeException ("Configuration cache is unavailable");
90 if ($varname == '')
91 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
92 if (!isset ($configCache[$varname])) return true;
93 if ($configCache[$varname]['vartype'] == 'uint')
ed941e67 94 return $configCache[$varname]['varvalue'] !== 0 + $varvalue;
3540d15c 95 else
ed941e67 96 return $configCache[$varname]['varvalue'] !== $varvalue;
3540d15c
DY
97}
98
9c0b0016
DO
99function getConfigVar ($varname = '')
100{
101 global $configCache;
102 // We assume the only point of cache init, and it is init.php. If it
103 // has failed, we don't retry loading.
104 if (!isset ($configCache))
105 {
0cc24e9a 106 throw new RuntimeException ("Configuration cache is unavailable");
9c0b0016
DO
107 }
108 if ($varname == '')
109 {
0cc24e9a 110 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
9c0b0016
DO
111 }
112 if (isset ($configCache[$varname]))
113 {
114 // Try casting to int, if possible.
3540d15c 115 return $configCache[$varname]['varvalue'];
9c0b0016
DO
116 }
117 return NULL;
118}
119
c461c579
DO
120// In softfail mode die only on fatal errors, letting the user check
121// and resubmit his input.
122function setConfigVar ($varname = '', $varvalue = '', $softfail = FALSE)
9c0b0016
DO
123{
124 global $configCache;
125 if (!isset ($configCache))
0cc24e9a 126 throw new RuntimeException ("Configuration cache is unavailable");
59a83bd8 127 if (!strlen ($varname))
0cc24e9a 128 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
9c0b0016
DO
129 // We don't operate on unknown data.
130 if (!isset ($configCache[$varname]))
0cc24e9a 131 throw new InvalidArgException('$varname', $varname, "Don't know how to handle '${varname}'");
dc2f1801 132 if ($configCache[$varname]['is_hidden'] != 'no')
3540d15c 133 throw new InvalidArgException('$varname', $varname, "'${varname}' is a system variable and cannot be changed by user.");
59a83bd8 134 if (!strlen ($varvalue) && $configCache[$varname]['emptyok'] != 'yes')
3540d15c 135 throw new InvalidArgException('$varname', $varname, "'${varname}' is configured to take non-empty value. Perhaps there was a reason to do so.");
59a83bd8 136 if (strlen ($varvalue) && $configCache[$varname]['vartype'] == 'uint' && (!is_numeric ($varvalue) or $varvalue < 0 ))
3540d15c 137 throw new InvalidArgException('$varname', $varname, "'${varname}' can accept UINT values only");
9c0b0016 138 // Update cache only if the changes went into DB.
3540d15c
DY
139 storeConfigVar ($varname, $varvalue);
140 $configCache[$varname]['varvalue'] = $varvalue;
141}
142
143function setUserConfigVar ($varname = '', $varvalue = '')
144{
145 global $configCache;
146 global $remote_username;
147 if (!isset ($configCache))
148 throw new RuntimeException ("Configuration cache is unavailable");
149 if (!strlen ($varname))
150 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
151 // We don't operate on unknown data.
152 if (!isset ($configCache[$varname]))
153 throw new InvalidArgException('$varname', $varname, "Don't know how to handle '${varname}'");
154 if ($configCache[$varname]['is_userdefined'] != 'yes')
155 throw new InvalidArgException('$varname', $varname, "'${varname}' cannot be changed by user.");
156 if ($configCache[$varname]['is_hidden'] != 'no')
157 throw new InvalidArgException('$varname', $varname, "'${varname}' is a system variable and cannot be changed by user.");
158 if (!strlen ($varvalue) && $configCache[$varname]['emptyok'] != 'yes')
159 throw new InvalidArgException('$varname', $varname, "'${varname}' is configured to take non-empty value. Perhaps there was a reason to do so.");
160 if (strlen ($varvalue) && $configCache[$varname]['vartype'] == 'uint' && (!is_numeric ($varvalue) or $varvalue < 0 ))
161 throw new InvalidArgException('$varname', $varname, "'${varname}' can accept UINT values only");
162 // Update cache only if the changes went into DB.
163 storeUserConfigVar ($remote_username, $varname, $varvalue);
164 $configCache[$varname]['varvalue'] = $varvalue;
3540d15c
DY
165}
166
167function resetUserConfigVar ($varname = '')
168{
169 global $configCache;
170 global $remote_username;
171 if (!isset ($configCache))
172 throw new RuntimeException ("Configuration cache is unavailable");
173 if (!strlen ($varname))
174 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
175 // We don't operate on unknown data.
176 if (!isset ($configCache[$varname]))
177 throw new InvalidArgException('$varname', $varname, "Don't know how to handle '${varname}'");
178 if ($configCache[$varname]['is_userdefined'] != 'yes')
179 throw new InvalidArgException('$varname', $varname, "'${varname}' cannot be changed by user.");
180 if ($configCache[$varname]['is_hidden'] != 'no')
181 throw new InvalidArgException('$varname', $varname, "'${varname}' is a system variable and cannot be changed by user.");
182 // Update cache only if the changes went into DB.
183 deleteUserConfigVar ($remote_username, $varname);
9c0b0016 184}
8d07e3e0 185
e673ee24 186?>