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