r3667 pre-release justifications
[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,
ca3d68bd
DO
33);
34
b7b4b225
DO
35define ('TAGNAME_REGEXP', '/^[\p{L}0-9]([. _~-]?[\p{L}0-9])*$/u');
36define ('AUTOTAGNAME_REGEXP', '/^\$[\p{L}0-9]([. _~-]?[\p{L}0-9])*$/u');
05771508 37// The latter matches both SunOS and Linux-styled formats.
b7b4b225
DO
38define ('RE_L2_IFCFG', '/^[0-9a-f]{1,2}(:[0-9a-f]{1,2}){5}$/i');
39define ('RE_L2_CISCO', '/^[0-9a-f]{4}(\.[0-9a-f]{4}){2}$/i');
40define ('RE_L2_SOLID', '/^[0-9a-f]{12}$/i');
41define ('RE_L2_IPCFG', '/^[0-9a-f]{2}(-[0-9a-f]{2}){5}$/i');
42define ('RE_L2_WWN_COLON', '/^[0-9a-f]{1,2}(:[0-9a-f]{1,2}){7}$/i');
43define ('RE_L2_WWN_HYPHEN', '/^[0-9a-f]{2}(-[0-9a-f]{2}){7}$/i');
44define ('RE_L2_WWN_SOLID', '/^[0-9a-f]{16}$/i');
aeaf5779
DO
45define ('RE_IP4_ADDR', '#^[0-9]{1,3}(\.[0-9]{1,3}){3}$#');
46define ('RE_IP4_NET', '#^[0-9]{1,3}(\.[0-9]{1,3}){3}/[0-9]{1,2}$#');
52ce8bd7 47define ('E_8021Q_NOERROR', 0);
d973196a
DO
48define ('E_8021Q_VERSION_CONFLICT', 101);
49define ('E_8021Q_PULL_REMOTE_ERROR', 102);
50define ('E_8021Q_PUSH_REMOTE_ERROR', 103);
5701baec 51define ('E_8021Q_SYNC_DISABLED', 104);
bc90c415
DO
52define ('VLAN_MIN_ID', 1);
53define ('VLAN_MAX_ID', 4094);
54define ('VLAN_DFL_ID', 1);
26131670 55
3540d15c
DY
56function loadConfigDefaults() {
57 global $configCache;
58 $configCache = loadConfigCache();
59 if (!count ($configCache)) {
60 throw new RuntimeException('Failed to load configuration from the database.');
61 }
62 foreach ($configCache as $varname => &$row) {
63 $row['is_altered'] = 'no';
64 if ($row['vartype'] == 'uint') $row['varvalue'] = 0 + $row['varvalue'];
65 $row['defaultvalue'] = $row['varvalue'];
66 }
67}
68
69function alterConfigWithUserPreferences() {
70 global $configCache;
71 global $userConfigCache;
72 global $remote_username;
73 $userConfigCache = loadUserConfigCache($remote_username);
74 foreach($userConfigCache as $key => $row) {
75 if ($configCache[$key]['is_userdefined'] == 'yes') {
76 $configCache[$key]['varvalue'] = $row['varvalue'];
77 $configCache[$key]['is_altered'] = 'yes';
78 }
79 }
80}
81
82// Returns true if varname has a different value or varname is new
83function isConfigVarChanged($varname, $varvalue) {
84 global $configCache;
85 if (!isset ($configCache))
86 throw new RuntimeException ("Configuration cache is unavailable");
87 if ($varname == '')
88 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
89 if (!isset ($configCache[$varname])) return true;
90 if ($configCache[$varname]['vartype'] == 'uint')
ed941e67 91 return $configCache[$varname]['varvalue'] !== 0 + $varvalue;
3540d15c 92 else
ed941e67 93 return $configCache[$varname]['varvalue'] !== $varvalue;
3540d15c
DY
94}
95
9c0b0016
DO
96function getConfigVar ($varname = '')
97{
98 global $configCache;
99 // We assume the only point of cache init, and it is init.php. If it
100 // has failed, we don't retry loading.
101 if (!isset ($configCache))
102 {
0cc24e9a 103 throw new RuntimeException ("Configuration cache is unavailable");
9c0b0016
DO
104 }
105 if ($varname == '')
106 {
0cc24e9a 107 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
9c0b0016
DO
108 }
109 if (isset ($configCache[$varname]))
110 {
111 // Try casting to int, if possible.
3540d15c 112 return $configCache[$varname]['varvalue'];
9c0b0016
DO
113 }
114 return NULL;
115}
116
c461c579
DO
117// In softfail mode die only on fatal errors, letting the user check
118// and resubmit his input.
119function setConfigVar ($varname = '', $varvalue = '', $softfail = FALSE)
9c0b0016
DO
120{
121 global $configCache;
122 if (!isset ($configCache))
0cc24e9a 123 throw new RuntimeException ("Configuration cache is unavailable");
59a83bd8 124 if (!strlen ($varname))
0cc24e9a 125 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
9c0b0016
DO
126 // We don't operate on unknown data.
127 if (!isset ($configCache[$varname]))
0cc24e9a 128 throw new InvalidArgException('$varname', $varname, "Don't know how to handle '${varname}'");
dc2f1801 129 if ($configCache[$varname]['is_hidden'] != 'no')
3540d15c 130 throw new InvalidArgException('$varname', $varname, "'${varname}' is a system variable and cannot be changed by user.");
59a83bd8 131 if (!strlen ($varvalue) && $configCache[$varname]['emptyok'] != 'yes')
3540d15c 132 throw new InvalidArgException('$varname', $varname, "'${varname}' is configured to take non-empty value. Perhaps there was a reason to do so.");
59a83bd8 133 if (strlen ($varvalue) && $configCache[$varname]['vartype'] == 'uint' && (!is_numeric ($varvalue) or $varvalue < 0 ))
3540d15c 134 throw new InvalidArgException('$varname', $varname, "'${varname}' can accept UINT values only");
9c0b0016 135 // Update cache only if the changes went into DB.
3540d15c
DY
136 storeConfigVar ($varname, $varvalue);
137 $configCache[$varname]['varvalue'] = $varvalue;
138}
139
140function setUserConfigVar ($varname = '', $varvalue = '')
141{
142 global $configCache;
143 global $remote_username;
144 if (!isset ($configCache))
145 throw new RuntimeException ("Configuration cache is unavailable");
146 if (!strlen ($varname))
147 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
148 // We don't operate on unknown data.
149 if (!isset ($configCache[$varname]))
150 throw new InvalidArgException('$varname', $varname, "Don't know how to handle '${varname}'");
151 if ($configCache[$varname]['is_userdefined'] != 'yes')
152 throw new InvalidArgException('$varname', $varname, "'${varname}' cannot be changed by user.");
153 if ($configCache[$varname]['is_hidden'] != 'no')
154 throw new InvalidArgException('$varname', $varname, "'${varname}' is a system variable and cannot be changed by user.");
155 if (!strlen ($varvalue) && $configCache[$varname]['emptyok'] != 'yes')
156 throw new InvalidArgException('$varname', $varname, "'${varname}' is configured to take non-empty value. Perhaps there was a reason to do so.");
157 if (strlen ($varvalue) && $configCache[$varname]['vartype'] == 'uint' && (!is_numeric ($varvalue) or $varvalue < 0 ))
158 throw new InvalidArgException('$varname', $varname, "'${varname}' can accept UINT values only");
159 // Update cache only if the changes went into DB.
160 storeUserConfigVar ($remote_username, $varname, $varvalue);
161 $configCache[$varname]['varvalue'] = $varvalue;
3540d15c
DY
162}
163
164function resetUserConfigVar ($varname = '')
165{
166 global $configCache;
167 global $remote_username;
168 if (!isset ($configCache))
169 throw new RuntimeException ("Configuration cache is unavailable");
170 if (!strlen ($varname))
171 throw new InvalidArgException('$varname', $varname, 'Empty variable name');
172 // We don't operate on unknown data.
173 if (!isset ($configCache[$varname]))
174 throw new InvalidArgException('$varname', $varname, "Don't know how to handle '${varname}'");
175 if ($configCache[$varname]['is_userdefined'] != 'yes')
176 throw new InvalidArgException('$varname', $varname, "'${varname}' cannot be changed by user.");
177 if ($configCache[$varname]['is_hidden'] != 'no')
178 throw new InvalidArgException('$varname', $varname, "'${varname}' is a system variable and cannot be changed by user.");
179 // Update cache only if the changes went into DB.
180 deleteUserConfigVar ($remote_username, $varname);
9c0b0016 181}
8d07e3e0 182
e673ee24 183?>