2 /************************************************************************
3 * MXChange v0.2.1 Start: 02/28/2009 *
4 * =============== Last change: 02/28/2009 *
6 * -------------------------------------------------------------------- *
7 * File : config-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Many non-MySQL functions (also file access) *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2008 by Roland Haeder *
21 * For more information visit: http://www.mxchange.org *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the Free Software *
35 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
41 $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
45 // Merges $GLOBALS['config'] with data in given array
46 function mergeConfig ($newConfig) {
47 $GLOBALS['config'] = merge_array(getConfigArray(), $newConfig);
50 // Getter for $GLOBALS['config'] entries
51 function getConfig ($configEntry) {
55 // Is the entry there?
56 if (isConfigEntrySet($configEntry)) {
58 $value = $GLOBALS['config'][$configEntry];
65 // Setter for $GLOBALS['config'] entries
66 function setConfigEntry ($configEntry, $value) {
67 // Secure the entry name
68 if (function_exists('SQL_ESCAPE')) {
69 // Use our secure function
70 $configEntry = SQL_ESCAPE($configEntry);
72 // Use maybe insecure function
73 $configEntry = smartAddSlashes($configEntry);
77 $GLOBALS['config'][$configEntry] = $value;
80 // Checks wether the given config entry is set
81 function isConfigEntrySet ($configEntry) {
82 return (isset($GLOBALS['config'][$configEntry]));
85 // Increment or init with given value or 1 as default the given config entry
86 function incrementConfigEntry ($configEntry, $value=1) {
87 // Increment it if set or init it with 1
88 if (getConfig($configEntry) > 0) {
89 $GLOBALS['config'][$configEntry] += $value;
91 $GLOBALS['config'][$configEntry] = $value;
95 // Checks wether the configuration array is set so the config is loaded
96 function isConfigLoaded () {
98 return ((isset($GLOBALS['config'])) && (is_array($GLOBALS['config'])) && (count($GLOBALS['config']) > 0));
101 // Init the config array
102 function initConfig () {
103 // Set a minimum dummy configuration
104 $GLOBALS['config'] = array(
107 'last_update' => time()
111 // Load configuration and return it as an arry
112 function loadConfiguration ($no = '0') {
113 // Check for cache extension, cache-array and if the requested configuration is in cache
114 if ((isset($GLOBALS['cache_array'])) && (is_array($GLOBALS['cache_array'])) && (isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {
115 // Load config from cache
116 //* DEBUG: */ OUTPUT_HTML(gettype($GLOBALS['cache_array']['config'][$no])."<br />");
117 foreach ($GLOBALS['cache_array']['config'][$no] as $key => $value) {
118 setConfigEntry($key, $value);
121 // Count cache hits if exists
122 if ((isConfigEntrySet('cache_hits')) && (EXT_IS_ACTIVE('cache'))) {
123 incrementConfigEntry('cache_hits');
125 } elseif ((!EXT_IS_ACTIVE('cache')) || (!isset($GLOBALS['cache_array']['config'][$no]))) {
126 // Load config from DB
127 $result_config = SQL_QUERY_ESC("SELECT * FROM `{!_MYSQL_PREFIX!}_config` WHERE config=%d LIMIT 1",
128 array(bigintval($no)), __FUNCTION__, __LINE__);
130 // Is the config there?
131 if (SQL_NUMROWS($result_config) == 1) {
132 // Get config from database
133 mergeConfig(SQL_FETCHARRAY($result_config));
137 SQL_FREERESULT($result_config);
139 // Remember this config in the array
140 $GLOBALS['cache_array']['config'][$no] = getConfigArray();
144 // Getter for whole $GLOBALS['config'] array
145 function getConfigArray () {
149 // Is the config set?
150 if (isConfigLoaded()) {
152 $return = $GLOBALS['config'];
159 // Updates an old inc/config.php to a inc/cache/config-local.php file
160 function updateOldConfigFile () {
161 // Watch out for these lines and execute them as single command
162 // @TODO Make this all better... :-/
164 "define('SITE_KEY'," => 'SITE_KEY',
165 "define('DEFAULT_LANG'," => 'DEFAULT_LANG',
166 "define('warn_no_pass'," => 'WARN_NO_PASS',
167 "define('WRITE_FOOTER'," => 'WRITE_FOOTER',
168 "define('OUTPUT_MODE'," => 'OUTPUT_MODE',
169 "define('MAIN_TITLE'," => 'MAIN_TITLE',
170 "define('SLOGAN'," => 'SLOGAN',
171 "define('WEBMASTER'," => 'WEBMASTER',
172 "define('mxchange_installed'," => 'MXCHANGE_INSTALLED',
173 "define('admin_registered'," => 'ADMIN_REGISTERED',
174 "define('_MYSQL_PREFIX'," => '_MYSQL_PREFIX',
175 "define('_TABLE_TYPE'," => '_TABLE_TYPE',
176 "define('_DB_TYPE'," => '_DB_TYPE',
177 "define('SMTP_HOSTNAME'," => 'SMTP_HOSTNAME',
178 "define('SMTP_USER'" => 'SMTP_USER',
179 "define('SMTP_PASSWORD'," => 'SMTP_PASSWORD',
180 "define('ENABLE_BACKLINK'," => 'ENABLE_BACKLINK',
183 // Make these lower-case! (damn stupid code...)
184 $lowerCase = array('WARN_NO_PASS', 'MXCHANGE_INSTALLED', 'ADMIN_REGISTERED');
186 // These are still constants...
187 // @TODO Rewrite these all to config entries, if somehow possible
188 $constants = array('MAIN_TITLE', 'SLOGAN', 'WEBMASTER');
190 // Special comments...
192 'WARN_NO_PASS' => 'NULLPASS-WARNING',
193 'MXCHANGE_INSTALLED' => 'INSTALLED',
194 'ADMIN_REGISTERED' => 'ADMIN-SETUP',
195 '_MYSQL_PREFIX' => 'MYSQL-PREFIX',
196 '_TABLE_TYPE' => 'TABLE-TYPE',
197 '_DB_TYPE' => 'DATABASE-TYPE',
198 'ENABLE_BACKLINK' => 'BACKLINK',
199 'host' => 'MYSQL-HOST',
200 'dbase' => 'MYSQL-DBASE',
201 'login' => 'MYSQL-LOGIN',
202 'password' => 'MYSQL-PASSWORD'
205 // Copy template to new file destionation
206 copyFileVerified(constant('PATH') . 'inc/config-local.php.dist', constant('PATH') . 'inc/cache/config-local.php', 0644);
208 // First of all, load the old one!
209 $oldConfig = explode("\n", readFromFile(constant('PATH') . 'inc/config.php'));
211 // Now, analyze every entry
213 foreach ($oldConfig as $line) {
214 // Check all watch lines
215 foreach ($watchLines as $old => $new) {
216 // Is the line found?
217 if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
219 //* DEBUG: */ OUTPUT_HTML(htmlentities($line) . " - FOUND!<br />");
224 // Setting config entry is new default behaviour!
225 $function = 'setConfigEntry';
227 // Still some old constants left?
228 if (in_array($new, $constants)) {
229 // Then switch over...
230 $function = 'define';
234 $comment = str_replace('_', '-', $new);
236 // Do we have a special comment?
237 if (isset($comments[$new])) {
239 $comment = $comments[$new];
242 // Do we need to make $new lowercase?
244 if (in_array($new, $lowerCase)) {
246 $new = strtolower($new);
249 /// ... and write it to the new config
250 //* DEBUG: */ OUTPUT_HTML('function=' . $function . ',new=' . $new . ',comment=' . $comment . "<br />");
251 changeDataInFile(constant('PATH') . 'inc/cache/config-local.php', $comment, $function . "('" . $oldNew . "', \"", "\");", constant($new), 0);
252 //* DEBUG: */ OUTPUT_HTML("CHANGED!<br />");
260 // By default the old array $MySQL was not found
263 // Analyze every entry again for the MySQL configuration
264 foreach ($oldConfig as $line) {
268 // Is the $MySQL found?
269 if (substr($line, 0, 6) == "\$MySQL") {
272 } elseif ($found === true) {
273 // Now check this row
274 if (substr($line, 0, 2) == ');') {
275 // MySQL array is closed so stop looking for it
277 } elseif (substr($line, 0, 2) == '//') {
283 //* DEBUG: */ OUTPUT_HTML(htmlentities($line) . " - MySQL!<br />");
285 // Split parts so we can check them and prepare them
286 $parts = explode('=>', $line);
287 $key = substr(trim($parts[0]), 1, -1); $value = substr(trim($parts[1]), 1, -2);
289 // We can now save the right part in new config file
290 changeDataInFile(constant('PATH') . 'inc/cache/config-local.php', $comments[$key], " '".$key."' => \"", "\",", $value, 0);
294 // Finally remove old config file
295 removeFile(constant('PATH') . 'inc/config.php');
297 // Redirect to same URL to reload our new config
298 redirectToUrl($_SERVER['REQUEST_URI']);