[1] | 1 | <?php |
---|
| 2 | /** |
---|
[362] | 3 | * The Strangecode Codebase - a general application development framework for PHP |
---|
| 4 | * For details visit the project site: <http://trac.strangecode.com/codebase/> |
---|
[396] | 5 | * Copyright 2001-2012 Strangecode, LLC |
---|
[452] | 6 | * |
---|
[362] | 7 | * This file is part of The Strangecode Codebase. |
---|
| 8 | * |
---|
| 9 | * The Strangecode Codebase is free software: you can redistribute it and/or |
---|
| 10 | * modify it under the terms of the GNU General Public License as published by the |
---|
| 11 | * Free Software Foundation, either version 3 of the License, or (at your option) |
---|
| 12 | * any later version. |
---|
[452] | 13 | * |
---|
[362] | 14 | * The Strangecode Codebase is distributed in the hope that it will be useful, but |
---|
| 15 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
| 16 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
---|
| 17 | * details. |
---|
[452] | 18 | * |
---|
[362] | 19 | * You should have received a copy of the GNU General Public License along with |
---|
| 20 | * The Strangecode Codebase. If not, see <http://www.gnu.org/licenses/>. |
---|
| 21 | */ |
---|
| 22 | |
---|
| 23 | /** |
---|
[1] | 24 | * App.inc.php |
---|
| 25 | * |
---|
| 26 | * Primary application framework class. |
---|
| 27 | * |
---|
| 28 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
[136] | 29 | * @version 2.1 |
---|
[1] | 30 | */ |
---|
[42] | 31 | |
---|
[37] | 32 | // Message Types. |
---|
| 33 | define('MSG_ERR', 1); |
---|
| 34 | define('MSG_ERROR', MSG_ERR); |
---|
[1] | 35 | define('MSG_WARNING', 2); |
---|
[37] | 36 | define('MSG_NOTICE', 4); |
---|
| 37 | define('MSG_SUCCESS', 8); |
---|
[119] | 38 | define('MSG_ALL', MSG_SUCCESS | MSG_NOTICE | MSG_WARNING | MSG_ERROR); |
---|
[1] | 39 | |
---|
| 40 | require_once dirname(__FILE__) . '/Utilities.inc.php'; |
---|
| 41 | |
---|
| 42 | class App { |
---|
[42] | 43 | |
---|
[136] | 44 | // Namespace of this application instance. |
---|
| 45 | var $_ns; |
---|
[1] | 46 | |
---|
[136] | 47 | // If $app->start has run successfully. |
---|
[1] | 48 | var $running = false; |
---|
| 49 | |
---|
| 50 | // Instance of database object. |
---|
| 51 | var $db; |
---|
[42] | 52 | |
---|
[20] | 53 | // Array of query arguments will be carried persistently between requests. |
---|
| 54 | var $_carry_queries = array(); |
---|
[1] | 55 | |
---|
[136] | 56 | // Dictionary of global application parameters. |
---|
[1] | 57 | var $_params = array(); |
---|
| 58 | |
---|
| 59 | // Default parameters. |
---|
| 60 | var $_param_defaults = array( |
---|
| 61 | |
---|
| 62 | // Public name and email address for this application. |
---|
| 63 | 'site_name' => null, |
---|
[390] | 64 | 'site_email' => '', // Set to no-reply@HTTP_HOST if not set here. |
---|
[39] | 65 | 'site_url' => '', // URL automatically determined by _SERVER['HTTP_HOST'] if not set here. |
---|
[318] | 66 | 'images_path' => '', // Location for codebase-generated interface widgets (ex: "/admin/i"). |
---|
[1] | 67 | |
---|
[136] | 68 | // The location the user will go if the system doesn't know where else to send them. |
---|
[1] | 69 | 'redirect_home_url' => '/', |
---|
[42] | 70 | |
---|
[136] | 71 | // SSL URL used when redirecting with $app->sslOn(). |
---|
[1] | 72 | 'ssl_domain' => null, |
---|
| 73 | 'ssl_enabled' => false, |
---|
[42] | 74 | |
---|
[20] | 75 | // Character set for page output. Used in the Content-Type header and the HTML <meta content-type> tag. |
---|
[1] | 76 | 'character_set' => 'utf-8', |
---|
| 77 | |
---|
| 78 | // Human-readable format used to display dates. |
---|
| 79 | 'date_format' => 'd M Y', |
---|
[101] | 80 | 'time_format' => 'h:i:s A', |
---|
[1] | 81 | 'sql_date_format' => '%e %b %Y', |
---|
| 82 | 'sql_time_format' => '%k:%i', |
---|
| 83 | |
---|
| 84 | // Use php sessions? |
---|
| 85 | 'enable_session' => false, |
---|
[242] | 86 | 'session_name' => '_session', |
---|
[1] | 87 | 'session_use_cookies' => true, |
---|
[452] | 88 | |
---|
[293] | 89 | // Pass the session-id through URLs if cookies are not enabled? |
---|
| 90 | // Disable this to prevent session ID theft. |
---|
[242] | 91 | 'session_use_trans_sid' => false, |
---|
[42] | 92 | |
---|
[1] | 93 | // Use database? |
---|
| 94 | 'enable_db' => false, |
---|
| 95 | |
---|
| 96 | // Use db-based sessions? |
---|
| 97 | 'enable_db_session_handler' => false, |
---|
[42] | 98 | |
---|
[1] | 99 | // DB passwords should be set as apache environment variables in httpd.conf, readable only by root. |
---|
| 100 | 'db_server' => 'localhost', |
---|
| 101 | 'db_name' => null, |
---|
| 102 | 'db_user' => null, |
---|
| 103 | 'db_pass' => null, |
---|
| 104 | |
---|
| 105 | // Database debugging. |
---|
| 106 | 'db_always_debug' => false, // TRUE = display all SQL queries. |
---|
| 107 | 'db_debug' => false, // TRUE = display db errors. |
---|
| 108 | 'db_die_on_failure' => false, // TRUE = script stops on db error. |
---|
[42] | 109 | |
---|
[1] | 110 | // For classes that require db tables, do we check that a table exists and create if missing? |
---|
[32] | 111 | 'db_create_tables' => true, |
---|
[1] | 112 | |
---|
[136] | 113 | // The level of error reporting. Don't change this to suppress messages, instead use display_errors to control display. |
---|
[1] | 114 | 'error_reporting' => E_ALL, |
---|
| 115 | |
---|
| 116 | // Don't display errors by default; it is preferable to log them to a file. |
---|
| 117 | 'display_errors' => false, |
---|
[42] | 118 | |
---|
[1] | 119 | // Directory in which to store log files. |
---|
[19] | 120 | 'log_directory' => '', |
---|
[1] | 121 | |
---|
| 122 | // PHP error log. |
---|
| 123 | 'php_error_log' => 'php_error_log', |
---|
| 124 | |
---|
| 125 | // General application log. |
---|
[136] | 126 | 'log_filename' => 'app_log', |
---|
[1] | 127 | |
---|
[390] | 128 | // Don't email or SMS duplicate messages that happen more often than this value (in seconds). |
---|
| 129 | 'log_multiple_timeout' => 3600, // Hourly |
---|
[341] | 130 | |
---|
[1] | 131 | // Logging priority can be any of the following, or false to deactivate: |
---|
| 132 | // LOG_EMERG system is unusable |
---|
| 133 | // LOG_ALERT action must be taken immediately |
---|
| 134 | // LOG_CRIT critical conditions |
---|
| 135 | // LOG_ERR error conditions |
---|
| 136 | // LOG_WARNING warning conditions |
---|
| 137 | // LOG_NOTICE normal, but significant, condition |
---|
| 138 | // LOG_INFO informational message |
---|
| 139 | // LOG_DEBUG debug-level message |
---|
[174] | 140 | 'log_file_priority' => LOG_INFO, |
---|
[342] | 141 | 'log_email_priority' => false, |
---|
[1] | 142 | 'log_sms_priority' => false, |
---|
| 143 | 'log_screen_priority' => false, |
---|
[42] | 144 | |
---|
[390] | 145 | // Email address to receive log event emails. Use multiple addresses by separating them with commas. |
---|
[342] | 146 | 'log_to_email_address' => null, |
---|
[42] | 147 | |
---|
[392] | 148 | // SMS Email address to receive log event SMS messages. Use multiple addresses by separating them with commas. |
---|
[1] | 149 | 'log_to_sms_address' => null, |
---|
[42] | 150 | |
---|
[406] | 151 | // Should we avoid logging repeated logMsg() events? You might want to set this false if you need to see more accurate logging, particularly for long-running scripts. |
---|
| 152 | 'log_ignore_repeated_events' => true, |
---|
| 153 | |
---|
[348] | 154 | // Temporary files directory. |
---|
| 155 | 'tmp_dir' => '/tmp', |
---|
[343] | 156 | |
---|
[19] | 157 | // A key for calculating simple cryptographic signatures. Set using as an environment variables in the httpd.conf with 'SetEnv SIGNING_KEY <key>'. |
---|
[136] | 158 | // Existing password hashes rely on the same key/salt being used to compare encryptions. |
---|
| 159 | // Don't change this unless you know existing hashes or signatures will not be affected! |
---|
[1] | 160 | 'signing_key' => 'aae6abd6209d82a691a9f96384a7634a', |
---|
| 161 | ); |
---|
[42] | 162 | |
---|
[1] | 163 | /** |
---|
| 164 | * This method enforces the singleton pattern for this class. Only one application is running at a time. |
---|
| 165 | * |
---|
[136] | 166 | * $param string $namespace Name of this application. |
---|
| 167 | * @return object Reference to the global Cache object. |
---|
[1] | 168 | * @access public |
---|
| 169 | * @static |
---|
| 170 | */ |
---|
[380] | 171 | static function &getInstance($namespace='') |
---|
[1] | 172 | { |
---|
| 173 | static $instance = null; |
---|
| 174 | |
---|
| 175 | if ($instance === null) { |
---|
[136] | 176 | $instance = new App($namespace); |
---|
[1] | 177 | } |
---|
| 178 | |
---|
| 179 | return $instance; |
---|
| 180 | } |
---|
[42] | 181 | |
---|
[1] | 182 | /** |
---|
| 183 | * Constructor. |
---|
| 184 | */ |
---|
[136] | 185 | function App($namespace='') |
---|
[1] | 186 | { |
---|
[136] | 187 | // Set namespace of application instance. |
---|
[154] | 188 | $this->_ns = $namespace; |
---|
[42] | 189 | |
---|
[1] | 190 | // Initialize default parameters. |
---|
| 191 | $this->_params = array_merge($this->_params, $this->_param_defaults); |
---|
[452] | 192 | |
---|
[172] | 193 | // Begin timing script. |
---|
| 194 | require_once dirname(__FILE__) . '/ScriptTimer.inc.php'; |
---|
| 195 | $this->timer = new ScriptTimer(); |
---|
| 196 | $this->timer->start('_app'); |
---|
[1] | 197 | } |
---|
| 198 | |
---|
| 199 | /** |
---|
| 200 | * Set (or overwrite existing) parameters by passing an array of new parameters. |
---|
| 201 | * |
---|
| 202 | * @access public |
---|
| 203 | * @param array $param Array of parameters (key => val pairs). |
---|
| 204 | */ |
---|
| 205 | function setParam($param=null) |
---|
| 206 | { |
---|
| 207 | if (isset($param) && is_array($param)) { |
---|
| 208 | // Merge new parameters with old overriding only those passed. |
---|
[136] | 209 | $this->_params = array_merge($this->_params, $param); |
---|
[1] | 210 | } |
---|
| 211 | } |
---|
| 212 | |
---|
| 213 | /** |
---|
| 214 | * Return the value of a parameter. |
---|
| 215 | * |
---|
| 216 | * @access public |
---|
| 217 | * @param string $param The key of the parameter to return. |
---|
| 218 | * @return mixed Parameter value, or null if not existing. |
---|
| 219 | */ |
---|
[136] | 220 | function getParam($param=null) |
---|
[1] | 221 | { |
---|
| 222 | if ($param === null) { |
---|
[136] | 223 | return $this->_params; |
---|
| 224 | } else if (isset($this->_params[$param])) { |
---|
| 225 | return $this->_params[$param]; |
---|
[1] | 226 | } else { |
---|
[19] | 227 | trigger_error(sprintf('Parameter is not set: %s', $param), E_USER_NOTICE); |
---|
[1] | 228 | return null; |
---|
| 229 | } |
---|
| 230 | } |
---|
[42] | 231 | |
---|
[1] | 232 | /** |
---|
| 233 | * Begin running this application. |
---|
| 234 | * |
---|
| 235 | * @access public |
---|
| 236 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 237 | * @since 15 Jul 2005 00:32:21 |
---|
| 238 | */ |
---|
| 239 | function start() |
---|
| 240 | { |
---|
| 241 | if ($this->running) { |
---|
| 242 | return false; |
---|
| 243 | } |
---|
[42] | 244 | |
---|
[1] | 245 | // Error reporting. |
---|
| 246 | ini_set('error_reporting', $this->getParam('error_reporting')); |
---|
| 247 | ini_set('display_errors', $this->getParam('display_errors')); |
---|
| 248 | ini_set('log_errors', true); |
---|
| 249 | if (is_dir($this->getParam('log_directory')) && is_writable($this->getParam('log_directory'))) { |
---|
| 250 | ini_set('error_log', $this->getParam('log_directory') . '/' . $this->getParam('php_error_log')); |
---|
| 251 | } |
---|
[42] | 252 | |
---|
[248] | 253 | // Set character set to use for multi-byte string functions. |
---|
| 254 | mb_internal_encoding($this->getParam('character_set')); |
---|
[249] | 255 | switch (mb_strtolower($this->getParam('character_set'))) { |
---|
| 256 | case 'utf-8' : |
---|
| 257 | mb_language('uni'); |
---|
| 258 | break; |
---|
[42] | 259 | |
---|
[249] | 260 | case 'iso-2022-jp' : |
---|
| 261 | mb_language('ja'); |
---|
| 262 | break; |
---|
| 263 | |
---|
| 264 | case 'iso-8859-1' : |
---|
| 265 | default : |
---|
| 266 | mb_language('en'); |
---|
| 267 | break; |
---|
| 268 | } |
---|
| 269 | |
---|
[1] | 270 | /** |
---|
| 271 | * 1. Start Database. |
---|
| 272 | */ |
---|
[42] | 273 | |
---|
[103] | 274 | if (true === $this->getParam('enable_db')) { |
---|
[42] | 275 | |
---|
[1] | 276 | // DB connection parameters taken from environment variables in the httpd.conf file, readable only by root. |
---|
| 277 | if (!empty($_SERVER['DB_SERVER'])) { |
---|
| 278 | $this->setParam(array('db_server' => $_SERVER['DB_SERVER'])); |
---|
| 279 | } |
---|
| 280 | if (!empty($_SERVER['DB_NAME'])) { |
---|
| 281 | $this->setParam(array('db_name' => $_SERVER['DB_NAME'])); |
---|
| 282 | } |
---|
| 283 | if (!empty($_SERVER['DB_USER'])) { |
---|
| 284 | $this->setParam(array('db_user' => $_SERVER['DB_USER'])); |
---|
| 285 | } |
---|
| 286 | if (!empty($_SERVER['DB_PASS'])) { |
---|
| 287 | $this->setParam(array('db_pass' => $_SERVER['DB_PASS'])); |
---|
| 288 | } |
---|
[42] | 289 | |
---|
[136] | 290 | // There will ever only be one instance of the DB object, and here is where it is instantiated. |
---|
[1] | 291 | require_once dirname(__FILE__) . '/DB.inc.php'; |
---|
| 292 | $this->db =& DB::getInstance(); |
---|
| 293 | $this->db->setParam(array( |
---|
| 294 | 'db_server' => $this->getParam('db_server'), |
---|
| 295 | 'db_name' => $this->getParam('db_name'), |
---|
| 296 | 'db_user' => $this->getParam('db_user'), |
---|
| 297 | 'db_pass' => $this->getParam('db_pass'), |
---|
| 298 | 'db_always_debug' => $this->getParam('db_always_debug'), |
---|
| 299 | 'db_debug' => $this->getParam('db_debug'), |
---|
| 300 | 'db_die_on_failure' => $this->getParam('db_die_on_failure'), |
---|
| 301 | )); |
---|
| 302 | |
---|
| 303 | // Connect to database. |
---|
| 304 | $this->db->connect(); |
---|
| 305 | } |
---|
[42] | 306 | |
---|
| 307 | |
---|
[1] | 308 | /** |
---|
| 309 | * 2. Start PHP session. |
---|
| 310 | */ |
---|
[42] | 311 | |
---|
[1] | 312 | // Skip session for some user agents. |
---|
| 313 | if (preg_match('/Atomz|ApacheBench|Wget/i', getenv('HTTP_USER_AGENT'))) { |
---|
| 314 | $this->setParam(array('enable_session' => false)); |
---|
| 315 | } |
---|
[42] | 316 | |
---|
[433] | 317 | // Skip sessions if disabled or automatically skip if run in a CLI script. |
---|
| 318 | if (true === $this->getParam('enable_session') && !defined('_CLI')) { |
---|
[42] | 319 | |
---|
[373] | 320 | // Session parameters. |
---|
| 321 | ini_set('session.gc_probability', 1); |
---|
| 322 | ini_set('session.gc_divisor', 1000); |
---|
| 323 | ini_set('session.gc_maxlifetime', 43200); // 12 hours |
---|
| 324 | ini_set('session.use_cookies', $this->getParam('session_use_cookies')); |
---|
| 325 | ini_set('session.use_trans_sid', false); |
---|
| 326 | ini_set('session.entropy_file', '/dev/urandom'); |
---|
| 327 | ini_set('session.entropy_length', '512'); |
---|
[410] | 328 | ini_set('session.cookie_httponly', true); |
---|
[373] | 329 | session_name($this->getParam('session_name')); |
---|
| 330 | |
---|
[1] | 331 | if (true === $this->getParam('enable_db_session_handler') && true === $this->getParam('enable_db')) { |
---|
| 332 | // Database session handling. |
---|
| 333 | require_once dirname(__FILE__) . '/DBSessionHandler.inc.php'; |
---|
| 334 | $db_save_handler = new DBSessionHandler($this->db, array( |
---|
| 335 | 'db_table' => 'session_tbl', |
---|
| 336 | 'create_table' => $this->getParam('db_create_tables'), |
---|
| 337 | )); |
---|
| 338 | } |
---|
[42] | 339 | |
---|
[22] | 340 | // Start the session. |
---|
[1] | 341 | session_start(); |
---|
[42] | 342 | |
---|
[154] | 343 | if (!isset($_SESSION['_app'][$this->_ns])) { |
---|
[22] | 344 | // Access session data using: $_SESSION['...']. |
---|
| 345 | // Initialize here _after_ session has started. |
---|
[154] | 346 | $_SESSION['_app'][$this->_ns] = array( |
---|
[22] | 347 | 'messages' => array(), |
---|
| 348 | 'boomerang' => array('url'), |
---|
| 349 | ); |
---|
| 350 | } |
---|
[1] | 351 | } |
---|
[42] | 352 | |
---|
| 353 | |
---|
[1] | 354 | /** |
---|
| 355 | * 3. Misc setup. |
---|
| 356 | */ |
---|
| 357 | |
---|
| 358 | // Script URI will be something like http://host.name.tld (no ending slash) |
---|
| 359 | // and is used whenever a URL need be used to the current site. |
---|
| 360 | // Not available on cli scripts obviously. |
---|
[41] | 361 | if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_url')) { |
---|
[14] | 362 | $this->setParam(array('site_url' => sprintf('%s://%s', ('on' == getenv('HTTPS') ? 'https' : 'http'), getenv('HTTP_HOST')))); |
---|
[1] | 363 | } |
---|
[452] | 364 | |
---|
[390] | 365 | // In case site_email isn't set, use something halfway presentable. |
---|
| 366 | if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_email')) { |
---|
| 367 | $this->setParam(array('site_email' => sprintf('no-reply@%s', getenv('HTTP_HOST')))); |
---|
| 368 | } |
---|
[1] | 369 | |
---|
| 370 | // A key for calculating simple cryptographic signatures. |
---|
| 371 | if (isset($_SERVER['SIGNING_KEY'])) { |
---|
| 372 | $this->setParam(array('signing_key' => $_SERVER['SIGNING_KEY'])); |
---|
| 373 | } |
---|
[42] | 374 | |
---|
[1] | 375 | // Character set. This should also be printed in the html header template. |
---|
| 376 | header('Content-type: text/html; charset=' . $this->getParam('character_set')); |
---|
[452] | 377 | |
---|
[136] | 378 | // Set the version of the codebase we're using. |
---|
| 379 | $codebase_version_file = dirname(__FILE__) . '/../docs/version.txt'; |
---|
| 380 | if (is_readable($codebase_version_file)) { |
---|
| 381 | $codebase_version = trim(file_get_contents($codebase_version_file)); |
---|
[144] | 382 | $this->setParam(array('codebase_version' => $codebase_version)); |
---|
[136] | 383 | header('X-Codebase-Version: ' . $codebase_version); |
---|
| 384 | } |
---|
[42] | 385 | |
---|
[1] | 386 | $this->running = true; |
---|
| 387 | } |
---|
[42] | 388 | |
---|
[1] | 389 | /** |
---|
| 390 | * Stop running this application. |
---|
| 391 | * |
---|
| 392 | * @access public |
---|
| 393 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 394 | * @since 17 Jul 2005 17:20:18 |
---|
| 395 | */ |
---|
| 396 | function stop() |
---|
| 397 | { |
---|
| 398 | session_write_close(); |
---|
| 399 | restore_include_path(); |
---|
| 400 | $this->running = false; |
---|
[172] | 401 | $num_queries = 0; |
---|
[103] | 402 | if (true === $this->getParam('enable_db')) { |
---|
[172] | 403 | $num_queries = $this->db->numQueries(); |
---|
[103] | 404 | $this->db->close(); |
---|
| 405 | } |
---|
[452] | 406 | $mem_current = memory_get_usage(); |
---|
| 407 | $mem_peak = memory_get_peak_usage(); |
---|
[172] | 408 | $this->timer->stop('_app'); |
---|
[452] | 409 | $this->logMsg(sprintf('Script ended gracefully. Execution time: %s. Number of db queries: %s. Memory usage: %s. Peak memory: %s.', $this->timer->getTime('_app'), $num_queries, $mem_current, $mem_peak), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 410 | } |
---|
[42] | 411 | |
---|
| 412 | |
---|
[1] | 413 | /** |
---|
[84] | 414 | * Add a message to the session, which is printed in the header. |
---|
[1] | 415 | * Just a simple way to print messages to the user. |
---|
| 416 | * |
---|
| 417 | * @access public |
---|
| 418 | * |
---|
| 419 | * @param string $message The text description of the message. |
---|
| 420 | * @param int $type The type of message: MSG_NOTICE, |
---|
| 421 | * MSG_SUCCESS, MSG_WARNING, or MSG_ERR. |
---|
| 422 | * @param string $file __FILE__. |
---|
| 423 | * @param string $line __LINE__. |
---|
| 424 | */ |
---|
| 425 | function raiseMsg($message, $type=MSG_NOTICE, $file=null, $line=null) |
---|
| 426 | { |
---|
[32] | 427 | $message = trim($message); |
---|
[1] | 428 | |
---|
[203] | 429 | if (!$this->running) { |
---|
| 430 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 431 | return false; |
---|
| 432 | } |
---|
[42] | 433 | |
---|
[203] | 434 | if ('' == trim($message)) { |
---|
| 435 | $this->logMsg(sprintf('Raised message is an empty string.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
| 436 | return false; |
---|
| 437 | } |
---|
[452] | 438 | |
---|
[406] | 439 | // Avoid duplicate full-stops.. |
---|
| 440 | $message = trim(preg_replace('/\.{2}$/', '.', $message)); |
---|
[203] | 441 | |
---|
[37] | 442 | // Save message in session under unique key to avoid duplicate messages. |
---|
[177] | 443 | $msg_id = md5($type . $message); |
---|
| 444 | if (!isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id])) { |
---|
| 445 | $_SESSION['_app'][$this->_ns]['messages'][$msg_id] = array( |
---|
| 446 | 'type' => $type, |
---|
| 447 | 'message' => $message, |
---|
| 448 | 'file' => $file, |
---|
| 449 | 'line' => $line, |
---|
| 450 | 'count' => (isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) ? (1 + $_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) : 1) |
---|
| 451 | ); |
---|
| 452 | } |
---|
[42] | 453 | |
---|
[1] | 454 | if (!in_array($type, array(MSG_NOTICE, MSG_SUCCESS, MSG_WARNING, MSG_ERR))) { |
---|
[136] | 455 | $this->logMsg(sprintf('Invalid MSG_* type: %s', $type), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 456 | } |
---|
| 457 | } |
---|
[452] | 458 | |
---|
[46] | 459 | /** |
---|
| 460 | * Returns an array of the raised messages. |
---|
| 461 | * |
---|
| 462 | * @access public |
---|
[334] | 463 | * @return array List of messages in FIFO order. |
---|
[46] | 464 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 465 | * @since 21 Dec 2005 13:09:20 |
---|
| 466 | */ |
---|
| 467 | function getRaisedMessages() |
---|
| 468 | { |
---|
[136] | 469 | if (!$this->running) { |
---|
| 470 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
| 471 | return false; |
---|
[46] | 472 | } |
---|
[42] | 473 | |
---|
[154] | 474 | return isset($_SESSION['_app'][$this->_ns]['messages']) ? $_SESSION['_app'][$this->_ns]['messages'] : array(); |
---|
[46] | 475 | } |
---|
[452] | 476 | |
---|
[1] | 477 | /** |
---|
[46] | 478 | * Resets the message list. |
---|
| 479 | * |
---|
| 480 | * @access public |
---|
| 481 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 482 | * @since 21 Dec 2005 13:21:54 |
---|
| 483 | */ |
---|
| 484 | function clearRaisedMessages() |
---|
| 485 | { |
---|
[136] | 486 | if (!$this->running) { |
---|
| 487 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[46] | 488 | return false; |
---|
| 489 | } |
---|
[452] | 490 | |
---|
[154] | 491 | $_SESSION['_app'][$this->_ns]['messages'] = array(); |
---|
[46] | 492 | } |
---|
| 493 | |
---|
| 494 | /** |
---|
[1] | 495 | * Prints the HTML for displaying raised messages. |
---|
| 496 | * |
---|
[413] | 497 | * @param string $above Additional message to print above error messages (e.g. "Oops!"). |
---|
| 498 | * @param string $below Additional message to print below error messages (e.g. "Please fix and resubmit"). |
---|
| 499 | * @param string $print_gotohash_js Print a line of javascript that scrolls the browser window down to view any error messages. |
---|
| 500 | * @param string $hash The #hashtag to scroll to. |
---|
[1] | 501 | * @access public |
---|
| 502 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 503 | * @since 15 Jul 2005 01:39:14 |
---|
| 504 | */ |
---|
[413] | 505 | function printRaisedMessages($above='', $below='', $print_gotohash_js=false, $hash='sc-msg') |
---|
[1] | 506 | { |
---|
[136] | 507 | if (!$this->running) { |
---|
| 508 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 509 | return false; |
---|
| 510 | } |
---|
[452] | 511 | |
---|
[136] | 512 | $messages = $this->getRaisedMessages(); |
---|
[167] | 513 | if (!empty($messages)) { |
---|
[163] | 514 | ?><div id="sc-msg" class="sc-msg"><?php |
---|
[413] | 515 | if ('' != $above) { |
---|
| 516 | ?><div class="sc-above"><?php echo oTxt($above); ?></div><?php |
---|
| 517 | } |
---|
[167] | 518 | foreach ($messages as $m) { |
---|
| 519 | if (error_reporting() > 0 && $this->getParam('display_errors') && isset($m['file']) && isset($m['line'])) { |
---|
| 520 | echo "\n<!-- [" . $m['file'] . ' : ' . $m['line'] . '] -->'; |
---|
| 521 | } |
---|
| 522 | switch ($m['type']) { |
---|
| 523 | case MSG_ERR: |
---|
| 524 | echo '<div class="sc-msg-error">' . $m['message'] . '</div>'; |
---|
| 525 | break; |
---|
[42] | 526 | |
---|
[167] | 527 | case MSG_WARNING: |
---|
| 528 | echo '<div class="sc-msg-warning">' . $m['message'] . '</div>'; |
---|
| 529 | break; |
---|
[42] | 530 | |
---|
[167] | 531 | case MSG_SUCCESS: |
---|
| 532 | echo '<div class="sc-msg-success">' . $m['message'] . '</div>'; |
---|
| 533 | break; |
---|
[42] | 534 | |
---|
[167] | 535 | case MSG_NOTICE: |
---|
| 536 | default: |
---|
| 537 | echo '<div class="sc-msg-notice">' . $m['message'] . '</div>'; |
---|
| 538 | break; |
---|
[42] | 539 | |
---|
[167] | 540 | } |
---|
[1] | 541 | } |
---|
[413] | 542 | if ('' != $below) { |
---|
| 543 | ?><div class="sc-below"><?php echo oTxt($below); ?></div><?php |
---|
| 544 | } |
---|
[1] | 545 | ?></div><?php |
---|
[413] | 546 | if ($print_gotohash_js) { |
---|
| 547 | ?> |
---|
| 548 | <script type="text/javascript"> |
---|
| 549 | /* <![CDATA[ */ |
---|
| 550 | window.location.hash = '#<?php echo urlencode($hash); ?>'; |
---|
| 551 | /* ]]> */ |
---|
| 552 | </script> |
---|
| 553 | <?php |
---|
| 554 | } |
---|
[1] | 555 | } |
---|
[136] | 556 | $this->clearRaisedMessages(); |
---|
[1] | 557 | } |
---|
[42] | 558 | |
---|
[1] | 559 | /** |
---|
[44] | 560 | * Logs messages to defined channels: file, email, sms, and screen. Repeated messages are |
---|
[390] | 561 | * not repeated but printed once with count. Log events that match a sendable channel (email or SMS) |
---|
| 562 | * are sent once per 'log_multiple_timeout' setting (to avoid a flood of error emails). |
---|
[1] | 563 | * |
---|
| 564 | * @access public |
---|
| 565 | * @param string $message The text description of the message. |
---|
| 566 | * @param int $priority The type of message priority (in descending order): |
---|
[390] | 567 | * LOG_EMERG 0 system is unusable |
---|
| 568 | * LOG_ALERT 1 action must be taken immediately |
---|
| 569 | * LOG_CRIT 2 critical conditions |
---|
| 570 | * LOG_ERR 3 error conditions |
---|
| 571 | * LOG_WARNING 4 warning conditions |
---|
| 572 | * LOG_NOTICE 5 normal, but significant, condition |
---|
| 573 | * LOG_INFO 6 informational message |
---|
| 574 | * LOG_DEBUG 7 debug-level message |
---|
[1] | 575 | * @param string $file The file where the log event occurs. |
---|
| 576 | * @param string $line The line of the file where the log event occurs. |
---|
| 577 | */ |
---|
| 578 | function logMsg($message, $priority=LOG_INFO, $file=null, $line=null) |
---|
| 579 | { |
---|
[44] | 580 | static $previous_events = array(); |
---|
| 581 | |
---|
[1] | 582 | // If priority is not specified, assume the worst. |
---|
[136] | 583 | if (!$this->logPriorityToString($priority)) { |
---|
| 584 | $this->logMsg(sprintf('Log priority %s not defined. (Message: %s)', $priority, $message), LOG_EMERG, $file, $line); |
---|
[1] | 585 | $priority = LOG_EMERG; |
---|
| 586 | } |
---|
[42] | 587 | |
---|
[15] | 588 | // If log file is not specified, don't log to a file. |
---|
[136] | 589 | if (!$this->getParam('log_directory') || !$this->getParam('log_filename') || !is_dir($this->getParam('log_directory')) || !is_writable($this->getParam('log_directory'))) { |
---|
| 590 | $this->setParam(array('log_file_priority' => false)); |
---|
| 591 | // We must use trigger_error to report this problem rather than calling $app->logMsg, which might lead to an infinite loop. |
---|
| 592 | trigger_error(sprintf('Codebase error: log directory (%s) not found or writable.', $this->getParam('log_directory')), E_USER_NOTICE); |
---|
[1] | 593 | } |
---|
[452] | 594 | |
---|
[390] | 595 | // Before we get any further, let's see if ANY log events are configured to be reported. |
---|
| 596 | if ((false === $this->getParam('log_file_priority') || $priority > $this->getParam('log_file_priority')) |
---|
| 597 | && (false === $this->getParam('log_email_priority') || $priority > $this->getParam('log_email_priority')) |
---|
| 598 | && (false === $this->getParam('log_sms_priority') || $priority > $this->getParam('log_sms_priority')) |
---|
| 599 | && (false === $this->getParam('log_screen_priority') || $priority > $this->getParam('log_screen_priority'))) { |
---|
| 600 | // This event would not be recorded, skip it entirely. |
---|
| 601 | return false; |
---|
| 602 | } |
---|
[42] | 603 | |
---|
[1] | 604 | // Make sure to log in the system's locale. |
---|
| 605 | $locale = setlocale(LC_TIME, 0); |
---|
| 606 | setlocale(LC_TIME, 'C'); |
---|
[42] | 607 | |
---|
[44] | 608 | // Strip HTML tags except any with more than 7 characters because that's probably not a HTML tag, e.g. <email@address.com>. |
---|
| 609 | preg_match_all('/(<[^>\s]{7,})[^>]*>/', $message, $strip_tags_allow); |
---|
| 610 | $message = strip_tags(preg_replace('/\s+/', ' ', $message), (!empty($strip_tags_allow[1]) ? join('> ', $strip_tags_allow[1]) . '>' : null)); |
---|
| 611 | |
---|
| 612 | // Store this event under a unique key, counting each time it occurs so that it only gets reported a limited number of times. |
---|
| 613 | $msg_id = md5($message . $priority . $file . $line); |
---|
[406] | 614 | if ($this->getParam('log_ignore_repeated_events') && isset($previous_events[$msg_id])) { |
---|
[44] | 615 | $previous_events[$msg_id]++; |
---|
| 616 | if ($previous_events[$msg_id] == 2) { |
---|
[136] | 617 | $this->logMsg(sprintf('%s (Event repeated %s or more times)', $message, $previous_events[$msg_id]), $priority, $file, $line); |
---|
[44] | 618 | } |
---|
| 619 | return false; |
---|
| 620 | } else { |
---|
| 621 | $previous_events[$msg_id] = 1; |
---|
| 622 | } |
---|
[341] | 623 | |
---|
[390] | 624 | // For email and SMS notification types use "lock" files to prevent sending email and SMS notices ad infinitum. |
---|
| 625 | if ((false !== $this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority')) |
---|
| 626 | || (false !== $this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority'))) { |
---|
| 627 | // This event will generate a "send" notification. Prepare lock file. |
---|
| 628 | $site_hash = md5(empty($_SERVER['SERVER_NAME']) ? $_SERVER['SCRIPT_FILENAME'] : $_SERVER['SERVER_NAME']); |
---|
| 629 | $lock_dir = $this->getParam('tmp_dir') . "/codebase_msgs_$site_hash/"; |
---|
[452] | 630 | // Just use the file and line for the msg_id to limit the number of possible messages |
---|
[390] | 631 | // (the message string itself shan't be used as it may contain innumerable combinations). |
---|
| 632 | $lock_file = $lock_dir . md5($file . ':' . $line); |
---|
| 633 | if (!is_dir($lock_dir)) { |
---|
| 634 | mkdir($lock_dir); |
---|
| 635 | } |
---|
| 636 | $send_notifications = true; |
---|
| 637 | if (is_file($lock_file)) { |
---|
| 638 | $msg_last_sent = filectime($lock_file); |
---|
| 639 | // Has this message been sent more recently than the timeout? |
---|
| 640 | if ((time() - $msg_last_sent) <= $this->getParam('log_multiple_timeout')) { |
---|
| 641 | // This message was already sent recently. |
---|
| 642 | $send_notifications = false; |
---|
| 643 | } else { |
---|
| 644 | // Timeout has expired; send notifications again and reset timeout. |
---|
| 645 | touch($lock_file); |
---|
| 646 | } |
---|
[341] | 647 | } else { |
---|
[390] | 648 | touch($lock_file); |
---|
[341] | 649 | } |
---|
| 650 | } |
---|
[452] | 651 | |
---|
[1] | 652 | // Data to be stored for a log event. |
---|
[44] | 653 | $event = array( |
---|
| 654 | 'date' => date('Y-m-d H:i:s'), |
---|
| 655 | 'remote ip' => getRemoteAddr(), |
---|
[414] | 656 | 'pid' => getmypid(), |
---|
[136] | 657 | 'type' => $this->logPriorityToString($priority), |
---|
[44] | 658 | 'file:line' => "$file : $line", |
---|
[247] | 659 | 'url' => mb_substr(isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : '', 0, 128), |
---|
[44] | 660 | 'message' => $message |
---|
| 661 | ); |
---|
[42] | 662 | |
---|
[1] | 663 | // FILE ACTION |
---|
[390] | 664 | if (false !== $this->getParam('log_file_priority') && $priority <= $this->getParam('log_file_priority')) { |
---|
[44] | 665 | $event_str = '[' . join('] [', $event) . ']'; |
---|
[247] | 666 | error_log(mb_substr($event_str, 0, 1024) . "\n", 3, $this->getParam('log_directory') . '/' . $this->getParam('log_filename')); |
---|
[1] | 667 | } |
---|
[42] | 668 | |
---|
[390] | 669 | // EMAIL ACTION |
---|
| 670 | if (false !== $this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority') && $send_notifications) { |
---|
[422] | 671 | $hostname = (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : php_uname('n'); |
---|
| 672 | $subject = sprintf('[%s %s] %s', $hostname, $event['type'], mb_substr($message, 0, 64)); |
---|
| 673 | $email_msg = sprintf("A %s log event occurred on %s\n\n", $event['type'], $hostname); |
---|
[390] | 674 | $headers = 'From: ' . $this->getParam('site_email'); |
---|
| 675 | foreach ($event as $k=>$v) { |
---|
| 676 | $email_msg .= sprintf("%-11s%s\n", $k, $v); |
---|
[1] | 677 | } |
---|
[390] | 678 | mb_send_mail($this->getParam('log_to_email_address'), $subject, $email_msg, $headers); |
---|
[1] | 679 | } |
---|
[390] | 680 | |
---|
| 681 | // SMS ACTION |
---|
| 682 | if (false !== $this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority') && $send_notifications) { |
---|
[422] | 683 | $hostname = (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : php_uname('n'); |
---|
| 684 | $subject = sprintf('[%s %s]', $hostname, $priority); |
---|
[390] | 685 | $sms_msg = sprintf('%s [%s:%s]', mb_substr($event['message'], 0, 64), basename($file), $line); |
---|
| 686 | $headers = 'From: ' . $this->getParam('site_email'); |
---|
| 687 | mb_send_mail($this->getParam('log_to_sms_address'), $subject, $sms_msg, $headers); |
---|
| 688 | } |
---|
[452] | 689 | |
---|
[1] | 690 | // SCREEN ACTION |
---|
[390] | 691 | if (false !== $this->getParam('log_screen_priority') && $priority <= $this->getParam('log_screen_priority')) { |
---|
[189] | 692 | echo "[{$event['type']}] [{$event['message']}]\n"; |
---|
[1] | 693 | } |
---|
[42] | 694 | |
---|
[1] | 695 | // Restore original locale. |
---|
| 696 | setlocale(LC_TIME, $locale); |
---|
[452] | 697 | |
---|
[390] | 698 | return true; |
---|
[1] | 699 | } |
---|
[42] | 700 | |
---|
[1] | 701 | /** |
---|
| 702 | * Returns the string representation of a LOG_* integer constant. |
---|
| 703 | * |
---|
| 704 | * @param int $priority The LOG_* integer constant. |
---|
| 705 | * |
---|
| 706 | * @return The string representation of $priority. |
---|
| 707 | */ |
---|
[259] | 708 | function logPriorityToString($priority) { |
---|
[1] | 709 | $priorities = array( |
---|
| 710 | LOG_EMERG => 'emergency', |
---|
| 711 | LOG_ALERT => 'alert', |
---|
| 712 | LOG_CRIT => 'critical', |
---|
| 713 | LOG_ERR => 'error', |
---|
| 714 | LOG_WARNING => 'warning', |
---|
| 715 | LOG_NOTICE => 'notice', |
---|
| 716 | LOG_INFO => 'info', |
---|
| 717 | LOG_DEBUG => 'debug' |
---|
| 718 | ); |
---|
| 719 | if (isset($priorities[$priority])) { |
---|
| 720 | return $priorities[$priority]; |
---|
| 721 | } else { |
---|
| 722 | return false; |
---|
| 723 | } |
---|
| 724 | } |
---|
[42] | 725 | |
---|
[1] | 726 | /** |
---|
[334] | 727 | * Forcefully set a query argument even if one currently exists in the request. |
---|
[136] | 728 | * Values in the _carry_queries array will be copied to URLs (via $app->url()) and |
---|
[20] | 729 | * to hidden input values (via printHiddenSession()). |
---|
| 730 | * |
---|
| 731 | * @access public |
---|
[282] | 732 | * @param mixed $query_key The key (or keys, as an array) of the query argument to save. |
---|
| 733 | * @param mixed $val The new value of the argument key. |
---|
| 734 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 735 | * @since 13 Oct 2007 11:34:51 |
---|
| 736 | */ |
---|
| 737 | function setQuery($query_key, $val) |
---|
| 738 | { |
---|
| 739 | if (!is_array($query_key)) { |
---|
| 740 | $query_key = array($query_key); |
---|
| 741 | } |
---|
| 742 | foreach ($query_key as $k) { |
---|
| 743 | // Set the value of the specified query argument into the _carry_queries array. |
---|
| 744 | $this->_carry_queries[$k] = $val; |
---|
| 745 | } |
---|
| 746 | } |
---|
| 747 | |
---|
| 748 | /** |
---|
| 749 | * Specify which query arguments will be carried persistently between requests. |
---|
| 750 | * Values in the _carry_queries array will be copied to URLs (via $app->url()) and |
---|
| 751 | * to hidden input values (via printHiddenSession()). |
---|
| 752 | * |
---|
| 753 | * @access public |
---|
[259] | 754 | * @param mixed $query_key The key (or keys, as an array) of the query argument to save. |
---|
[170] | 755 | * @param mixed $default If the key is not available, set to this default value. |
---|
[20] | 756 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 757 | * @since 14 Nov 2005 19:24:52 |
---|
| 758 | */ |
---|
[170] | 759 | function carryQuery($query_key, $default=false) |
---|
[20] | 760 | { |
---|
[259] | 761 | if (!is_array($query_key)) { |
---|
| 762 | $query_key = array($query_key); |
---|
[20] | 763 | } |
---|
[259] | 764 | foreach ($query_key as $k) { |
---|
| 765 | // If not already set, and there is a non-empty value provided in the request... |
---|
| 766 | if (!isset($this->_carry_queries[$k]) && false !== getFormData($k, $default)) { |
---|
| 767 | // Copy the value of the specified query argument into the _carry_queries array. |
---|
| 768 | $this->_carry_queries[$k] = getFormData($k, $default); |
---|
[331] | 769 | $this->logMsg(sprintf('Carrying query: %s => %s', $k, truncate(getDump($this->_carry_queries[$k], true), 128, 'end')), LOG_DEBUG, __FILE__, __LINE__); |
---|
[259] | 770 | } |
---|
| 771 | } |
---|
[20] | 772 | } |
---|
[42] | 773 | |
---|
[20] | 774 | /** |
---|
[452] | 775 | * dropQuery() is the opposite of carryQuery(). The specified value will not appear in |
---|
[259] | 776 | * url()/ohref()/printHiddenSession() modified URLs unless explicitly written in. |
---|
[452] | 777 | * |
---|
[259] | 778 | * @access public |
---|
| 779 | * @param mixed $query_key The key (or keys, as an array) of the query argument to remove. |
---|
[407] | 780 | * @param bool $unset Remove any values set in the request matching the given $query_key. |
---|
[259] | 781 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 782 | * @since 18 Jun 2007 20:57:29 |
---|
| 783 | */ |
---|
[325] | 784 | function dropQuery($query_key, $unset=false) |
---|
[259] | 785 | { |
---|
| 786 | if (!is_array($query_key)) { |
---|
| 787 | $query_key = array($query_key); |
---|
| 788 | } |
---|
| 789 | foreach ($query_key as $k) { |
---|
[260] | 790 | if (isset($this->_carry_queries[$k])) { |
---|
[259] | 791 | // Remove the value of the specified query argument from the _carry_queries array. |
---|
[325] | 792 | $this->logMsg(sprintf('Dropping carried query: %s => %s', $k, $this->_carry_queries[$k]), LOG_DEBUG, __FILE__, __LINE__); |
---|
[260] | 793 | unset($this->_carry_queries[$k]); |
---|
[259] | 794 | } |
---|
[325] | 795 | if ($unset && isset($_REQUEST[$k])) { |
---|
| 796 | unset($_REQUEST[$k], $_GET[$k], $_POST[$k], $_COOKIE[$k]); |
---|
| 797 | } |
---|
[259] | 798 | } |
---|
| 799 | } |
---|
| 800 | |
---|
| 801 | /** |
---|
[1] | 802 | * Outputs a fully qualified URL with a query of all the used (ie: not empty) |
---|
[42] | 803 | * keys and values, including optional queries. This allows mindless retention |
---|
[32] | 804 | * of query arguments across page requests. If cookies are not |
---|
[325] | 805 | * used, the session id will be propagated in the URL. |
---|
[1] | 806 | * |
---|
[32] | 807 | * @param string $url The initial url |
---|
| 808 | * @param mixed $carry_args Additional url arguments to carry in the query, |
---|
| 809 | * or FALSE to prevent carrying queries. Can be any of the following formats: |
---|
| 810 | * array('key1', key2', key3') <-- to save these keys if in the form data. |
---|
| 811 | * array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data. |
---|
| 812 | * false <-- To not carry any queries. If URL already has queries those will be retained. |
---|
[1] | 813 | * |
---|
| 814 | * @param mixed $always_include_sid Always add the session id, even if using_trans_sid = true. This is required when |
---|
| 815 | * URL starts with http, since PHP using_trans_sid doesn't do those and also for |
---|
| 816 | * header('Location...') redirections. |
---|
| 817 | * |
---|
| 818 | * @return string url with attached queries and, if not using cookies, the session id |
---|
| 819 | */ |
---|
[32] | 820 | function url($url, $carry_args=null, $always_include_sid=false) |
---|
[1] | 821 | { |
---|
[136] | 822 | if (!$this->running) { |
---|
| 823 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 824 | return false; |
---|
| 825 | } |
---|
[42] | 826 | |
---|
[20] | 827 | // Get any provided query arguments to include in the final URL. |
---|
| 828 | // If FALSE is a provided here, DO NOT carry the queries. |
---|
[1] | 829 | $do_carry_queries = true; |
---|
| 830 | $one_time_carry_queries = array(); |
---|
| 831 | if (!is_null($carry_args)) { |
---|
| 832 | if (is_array($carry_args) && !empty($carry_args)) { |
---|
| 833 | foreach ($carry_args as $key=>$arg) { |
---|
| 834 | // Get query from appropriate source. |
---|
| 835 | if (false === $arg) { |
---|
| 836 | $do_carry_queries = false; |
---|
| 837 | } else if (false !== getFormData($arg, false)) { |
---|
| 838 | $one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available. |
---|
| 839 | } else if (!is_numeric($key) && '' != $arg) { |
---|
| 840 | $one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data). |
---|
| 841 | } |
---|
| 842 | } |
---|
| 843 | } else if (false !== getFormData($carry_args, false)) { |
---|
| 844 | $one_time_carry_queries[$carry_args] = getFormData($carry_args); |
---|
| 845 | } else if (false === $carry_args) { |
---|
| 846 | $do_carry_queries = false; |
---|
| 847 | } |
---|
| 848 | } |
---|
[42] | 849 | |
---|
[1] | 850 | // Get the first delimiter that is needed in the url. |
---|
[247] | 851 | $delim = mb_strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?'; |
---|
[32] | 852 | |
---|
[1] | 853 | $q = ''; |
---|
| 854 | if ($do_carry_queries) { |
---|
[20] | 855 | // Join the global _carry_queries and local one_time_carry_queries. |
---|
[136] | 856 | $query_args = urlEncodeArray(array_merge($this->_carry_queries, $one_time_carry_queries)); |
---|
[1] | 857 | foreach ($query_args as $key=>$val) { |
---|
| 858 | // Check value is set and value does not already exist in the url. |
---|
| 859 | if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) { |
---|
| 860 | $q .= $delim . $key . '=' . $val; |
---|
| 861 | $delim = ini_get('arg_separator.output'); |
---|
| 862 | } |
---|
| 863 | } |
---|
| 864 | } |
---|
[42] | 865 | |
---|
[1] | 866 | // Include the necessary SID if the following is true: |
---|
| 867 | // - no cookie in http request OR cookies disabled in App |
---|
| 868 | // - sessions are enabled |
---|
| 869 | // - the link stays on our site |
---|
[334] | 870 | // - transparent SID propagation with session.use_trans_sid is not being used OR url begins with protocol (using_trans_sid has no effect here) |
---|
[42] | 871 | // OR |
---|
[1] | 872 | // - we must include the SID because we say so (it's used in a context where cookies will not be effective, ie. moving from http to https) |
---|
| 873 | // AND |
---|
| 874 | // - the SID is not already in the query. |
---|
| 875 | if ( |
---|
| 876 | ( |
---|
| 877 | ( |
---|
| 878 | ( |
---|
[42] | 879 | !isset($_COOKIE[session_name()]) |
---|
[136] | 880 | || !$this->getParam('session_use_cookies') |
---|
[42] | 881 | ) |
---|
[242] | 882 | && $this->getParam('session_use_trans_sid') |
---|
[136] | 883 | && $this->getParam('enable_session') |
---|
[42] | 884 | && isMyDomain($url) |
---|
[242] | 885 | && ( |
---|
[20] | 886 | !ini_get('session.use_trans_sid') |
---|
[1] | 887 | || preg_match('!^(http|https)://!i', $url) |
---|
| 888 | ) |
---|
[42] | 889 | ) |
---|
[1] | 890 | || $always_include_sid |
---|
| 891 | ) |
---|
| 892 | && !preg_match('/[?&]' . preg_quote(session_name()) . '=/', $url) |
---|
| 893 | ) { |
---|
| 894 | $url .= $q . $delim . session_name() . '=' . session_id(); |
---|
| 895 | return $url; |
---|
| 896 | } else { |
---|
| 897 | $url .= $q; |
---|
| 898 | return $url; |
---|
| 899 | } |
---|
| 900 | } |
---|
[32] | 901 | |
---|
| 902 | /** |
---|
[136] | 903 | * Returns a HTML-friendly URL processed with $app->url and & replaced with & |
---|
[32] | 904 | * |
---|
| 905 | * @access public |
---|
| 906 | * @param string $url Input URL to parse. |
---|
[334] | 907 | * @return string URL passed through $app->url() and then & turned to $amp;. |
---|
[32] | 908 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 909 | * @since 09 Dec 2005 17:58:45 |
---|
| 910 | */ |
---|
| 911 | function oHREF($url, $carry_args=null, $always_include_sid=false) |
---|
| 912 | { |
---|
[136] | 913 | $url = $this->url($url, $carry_args, $always_include_sid); |
---|
[42] | 914 | |
---|
[32] | 915 | // Replace any & not followed by an html or unicode entity with it's & equivalent. |
---|
| 916 | $url = preg_replace('/&(?![\w\d#]{1,10};)/', '&', $url); |
---|
[42] | 917 | |
---|
[32] | 918 | return $url; |
---|
| 919 | } |
---|
[42] | 920 | |
---|
[1] | 921 | /** |
---|
| 922 | * Prints a hidden form element with the PHPSESSID when cookies are not used, as well |
---|
[42] | 923 | * as hidden form elements for GET_VARS that might be in use. |
---|
[1] | 924 | * |
---|
| 925 | * @param mixed $carry_args Additional url arguments to carry in the query, |
---|
| 926 | * or FALSE to prevent carrying queries. Can be any of the following formats: |
---|
[32] | 927 | * array('key1', key2', key3') <-- to save these keys if in the form data. |
---|
| 928 | * array('key1'=>'value', key2'='value') <-- to set keys to default values if not present in form data. |
---|
| 929 | * false <-- To not carry any queries. If URL already has queries those will be retained. |
---|
[1] | 930 | */ |
---|
| 931 | function printHiddenSession($carry_args=null) |
---|
[32] | 932 | { |
---|
[136] | 933 | if (!$this->running) { |
---|
| 934 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 935 | return false; |
---|
| 936 | } |
---|
[42] | 937 | |
---|
[20] | 938 | // Get any provided query arguments to include in the final hidden form data. |
---|
| 939 | // If FALSE is a provided here, DO NOT carry the queries. |
---|
[1] | 940 | $do_carry_queries = true; |
---|
| 941 | $one_time_carry_queries = array(); |
---|
| 942 | if (!is_null($carry_args)) { |
---|
| 943 | if (is_array($carry_args) && !empty($carry_args)) { |
---|
| 944 | foreach ($carry_args as $key=>$arg) { |
---|
| 945 | // Get query from appropriate source. |
---|
| 946 | if (false === $arg) { |
---|
| 947 | $do_carry_queries = false; |
---|
| 948 | } else if (false !== getFormData($arg, false)) { |
---|
| 949 | $one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available. |
---|
| 950 | } else if (!is_numeric($key) && '' != $arg) { |
---|
| 951 | $one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data). |
---|
| 952 | } |
---|
| 953 | } |
---|
| 954 | } else if (false !== getFormData($carry_args, false)) { |
---|
| 955 | $one_time_carry_queries[$carry_args] = getFormData($carry_args); |
---|
| 956 | } else if (false === $carry_args) { |
---|
| 957 | $do_carry_queries = false; |
---|
| 958 | } |
---|
| 959 | } |
---|
[42] | 960 | |
---|
[313] | 961 | // For each existing request value, we create a hidden input to carry it through a form. |
---|
[1] | 962 | if ($do_carry_queries) { |
---|
[20] | 963 | // Join the global _carry_queries and local one_time_carry_queries. |
---|
| 964 | // urlencode is not used here, not for form data! |
---|
[136] | 965 | $query_args = array_merge($this->_carry_queries, $one_time_carry_queries); |
---|
[453] | 966 | foreach ($query_args as $key => $val) { |
---|
| 967 | if (is_array($val)) { |
---|
| 968 | foreach ($val as $subval) { |
---|
| 969 | printf('<input type="hidden" name="%s[]" value="%s" />', $key, $subval); |
---|
| 970 | } |
---|
| 971 | } else { |
---|
| 972 | printf('<input type="hidden" name="%s" value="%s" />', $key, $val); |
---|
| 973 | } |
---|
[1] | 974 | } |
---|
[453] | 975 | unset($query_args, $key, $val, $subval); |
---|
[1] | 976 | } |
---|
[42] | 977 | |
---|
[1] | 978 | // Include the SID if cookies are disabled. |
---|
[20] | 979 | if (!isset($_COOKIE[session_name()]) && !ini_get('session.use_trans_sid')) { |
---|
[136] | 980 | printf('<input type="hidden" name="%s" value="%s" />', session_name(), session_id()); |
---|
[1] | 981 | } |
---|
| 982 | } |
---|
[42] | 983 | |
---|
[1] | 984 | /** |
---|
| 985 | * Uses an http header to redirect the client to the given $url. If sessions are not used |
---|
| 986 | * and the session is not already defined in the given $url, the SID is appended as a URI query. |
---|
| 987 | * As with all header generating functions, make sure this is called before any other output. |
---|
| 988 | * |
---|
| 989 | * @param string $url The URL the client will be redirected to. |
---|
| 990 | * @param mixed $carry_args Additional url arguments to carry in the query, |
---|
| 991 | * or FALSE to prevent carrying queries. Can be any of the following formats: |
---|
| 992 | * -array('key1', key2', key3') <-- to save these keys if in the form data. |
---|
[136] | 993 | * -array('key1' => 'value', key2' => 'value') <-- to set keys to default values if not present in form data. |
---|
[1] | 994 | * -false <-- To not carry any queries. If URL already has queries those will be retained. |
---|
| 995 | * @param bool $always_include_sid Force session id to be added to Location header. |
---|
| 996 | */ |
---|
| 997 | function dieURL($url, $carry_args=null, $always_include_sid=false) |
---|
| 998 | { |
---|
[136] | 999 | if (!$this->running) { |
---|
| 1000 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1001 | return false; |
---|
| 1002 | } |
---|
[42] | 1003 | |
---|
[1] | 1004 | if ('' == $url) { |
---|
| 1005 | // If URL is not specified, use the redirect_home_url. |
---|
[136] | 1006 | $url = $this->getParam('redirect_home_url'); |
---|
[1] | 1007 | } |
---|
[42] | 1008 | |
---|
[1] | 1009 | if (preg_match('!^/!', $url)) { |
---|
| 1010 | // If relative URL is given, prepend correct local hostname. |
---|
[22] | 1011 | $scheme = 'on' == getenv('HTTPS') ? 'https' : 'http'; |
---|
| 1012 | $host = getenv('HTTP_HOST'); |
---|
| 1013 | $url = sprintf('%s://%s%s', $scheme, $host, $url); |
---|
[1] | 1014 | } |
---|
[22] | 1015 | |
---|
[136] | 1016 | $url = $this->url($url, $carry_args, $always_include_sid); |
---|
[42] | 1017 | |
---|
[202] | 1018 | // Should we send a "303 See Other" header here instead of relying on the 302 sent automatically by PHP? |
---|
[1] | 1019 | header(sprintf('Location: %s', $url)); |
---|
[136] | 1020 | $this->logMsg(sprintf('dieURL: %s', $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[42] | 1021 | |
---|
[202] | 1022 | // End application. |
---|
[1] | 1023 | // Recommended, although I'm not sure it's necessary: http://cn2.php.net/session_write_close |
---|
[136] | 1024 | $this->stop(); |
---|
[1] | 1025 | die; |
---|
| 1026 | } |
---|
[42] | 1027 | |
---|
[84] | 1028 | /* |
---|
[136] | 1029 | * Redirects a user by calling $app->dieURL(). It will use: |
---|
[84] | 1030 | * 1. the stored boomerang URL, it it exists |
---|
| 1031 | * 2. a specified $default_url, it it exists |
---|
| 1032 | * 3. the referring URL, it it exists. |
---|
| 1033 | * 4. redirect_home_url configuration variable. |
---|
| 1034 | * |
---|
| 1035 | * @access public |
---|
| 1036 | * @param string $id Identifier for this script. |
---|
[136] | 1037 | * @param mixed $carry_args Additional arguments to carry in the URL automatically (see $app->oHREF()). |
---|
[84] | 1038 | * @param string $default_url A default URL if there is not a valid specified boomerang URL. |
---|
[159] | 1039 | * @param bool $queryless_referrer_comparison Exclude the URL query from the refererIsMe() comparison. |
---|
[84] | 1040 | * @return bool False if the session is not running. No return otherwise. |
---|
| 1041 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 1042 | * @since 31 Mar 2006 19:17:00 |
---|
| 1043 | */ |
---|
[159] | 1044 | function dieBoomerangURL($id=null, $carry_args=null, $default_url=null, $queryless_referrer_comparison=false) |
---|
[1] | 1045 | { |
---|
[136] | 1046 | if (!$this->running) { |
---|
| 1047 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1048 | return false; |
---|
| 1049 | } |
---|
[42] | 1050 | |
---|
[1] | 1051 | // Get URL from stored boomerang. Allow non specific URL if ID not valid. |
---|
[136] | 1052 | if ($this->validBoomerangURL($id, true)) { |
---|
[154] | 1053 | if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) { |
---|
| 1054 | $url = $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id]; |
---|
[136] | 1055 | $this->logMsg(sprintf('dieBoomerangURL(%s) found: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1056 | } else { |
---|
[154] | 1057 | $url = end($_SESSION['_app'][$this->_ns]['boomerang']['url']); |
---|
[136] | 1058 | $this->logMsg(sprintf('dieBoomerangURL(%s) using: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1059 | } |
---|
[22] | 1060 | // Delete stored boomerang. |
---|
[136] | 1061 | $this->deleteBoomerangURL($id); |
---|
[84] | 1062 | } else if (isset($default_url)) { |
---|
| 1063 | $url = $default_url; |
---|
[159] | 1064 | } else if (!refererIsMe(true === $queryless_referrer_comparison)) { |
---|
[1] | 1065 | // Ensure that the redirecting page is not also the referrer. |
---|
| 1066 | $url = getenv('HTTP_REFERER'); |
---|
[136] | 1067 | $this->logMsg(sprintf('dieBoomerangURL(%s) using referrer: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1068 | } else { |
---|
[22] | 1069 | // If URL is not specified, use the redirect_home_url. |
---|
[136] | 1070 | $url = $this->getParam('redirect_home_url'); |
---|
[203] | 1071 | $this->logMsg(sprintf('dieBoomerangURL(%s) using redirect_home_url: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1072 | } |
---|
[42] | 1073 | |
---|
[84] | 1074 | // A redirection will never happen immediately twice. |
---|
[1] | 1075 | // Set the time so ensure this doesn't happen. |
---|
[154] | 1076 | $_SESSION['_app'][$this->_ns]['boomerang']['time'] = time(); |
---|
[136] | 1077 | $this->dieURL($url, $carry_args); |
---|
[1] | 1078 | } |
---|
[42] | 1079 | |
---|
[1] | 1080 | /** |
---|
[136] | 1081 | * Set the URL to return to when $app->dieBoomerangURL() is called. |
---|
[1] | 1082 | * |
---|
| 1083 | * @param string $url A fully validated URL. |
---|
| 1084 | * @param bool $id An identification tag for this url. |
---|
| 1085 | * FIXME: url garbage collection? |
---|
| 1086 | */ |
---|
| 1087 | function setBoomerangURL($url=null, $id=null) |
---|
| 1088 | { |
---|
[136] | 1089 | if (!$this->running) { |
---|
| 1090 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1091 | return false; |
---|
| 1092 | } |
---|
[84] | 1093 | // A redirection will never happen immediately after setting the boomerangURL. |
---|
[136] | 1094 | // Set the time so ensure this doesn't happen. See $app->validBoomerangURL for more. |
---|
[359] | 1095 | /// FIXME: Why isn't the time set here under setBoomerangURL() and only under dieBoomerangURL()? |
---|
[42] | 1096 | |
---|
[22] | 1097 | if ('' != $url && is_string($url)) { |
---|
[242] | 1098 | // Delete any boomerang request keys in the query string (along with any trailing delimiters after the deletion). |
---|
| 1099 | $url = preg_replace(array('/([&?])boomerang=\w+[&?]?/', '/[&?]$/'), array('$1', ''), $url); |
---|
[42] | 1100 | |
---|
[154] | 1101 | if (isset($_SESSION['_app'][$this->_ns]['boomerang']['url']) && is_array($_SESSION['_app'][$this->_ns]['boomerang']['url']) && !empty($_SESSION['_app'][$this->_ns]['boomerang']['url'])) { |
---|
[1] | 1102 | // If the URL currently exists in the boomerang array, delete. |
---|
[154] | 1103 | while ($existing_key = array_search($url, $_SESSION['_app'][$this->_ns]['boomerang']['url'])) { |
---|
| 1104 | unset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$existing_key]); |
---|
[1] | 1105 | } |
---|
| 1106 | } |
---|
[42] | 1107 | |
---|
[1] | 1108 | if (isset($id)) { |
---|
[154] | 1109 | $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id] = $url; |
---|
[1] | 1110 | } else { |
---|
[154] | 1111 | $_SESSION['_app'][$this->_ns]['boomerang']['url'][] = $url; |
---|
[1] | 1112 | } |
---|
[136] | 1113 | $this->logMsg(sprintf('setBoomerangURL(%s): %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1114 | return true; |
---|
| 1115 | } else { |
---|
[136] | 1116 | $this->logMsg(sprintf('setBoomerangURL(%s) is empty!', $id, $url), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1117 | return false; |
---|
| 1118 | } |
---|
| 1119 | } |
---|
[42] | 1120 | |
---|
[1] | 1121 | /** |
---|
[333] | 1122 | * Return the URL set for the specified $id, or an empty string if one isn't set. |
---|
[1] | 1123 | * |
---|
| 1124 | * @param string $id An identification tag for this url. |
---|
| 1125 | */ |
---|
| 1126 | function getBoomerangURL($id=null) |
---|
| 1127 | { |
---|
[136] | 1128 | if (!$this->running) { |
---|
| 1129 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1130 | return false; |
---|
| 1131 | } |
---|
[42] | 1132 | |
---|
[1] | 1133 | if (isset($id)) { |
---|
[154] | 1134 | if (isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) { |
---|
| 1135 | return $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id]; |
---|
[1] | 1136 | } else { |
---|
| 1137 | return ''; |
---|
| 1138 | } |
---|
[154] | 1139 | } else if (is_array($_SESSION['_app'][$this->_ns]['boomerang']['url'])) { |
---|
| 1140 | return end($_SESSION['_app'][$this->_ns]['boomerang']['url']); |
---|
[1] | 1141 | } else { |
---|
| 1142 | return false; |
---|
| 1143 | } |
---|
| 1144 | } |
---|
[42] | 1145 | |
---|
[1] | 1146 | /** |
---|
| 1147 | * Delete the URL set for the specified $id. |
---|
| 1148 | * |
---|
| 1149 | * @param string $id An identification tag for this url. |
---|
| 1150 | */ |
---|
| 1151 | function deleteBoomerangURL($id=null) |
---|
| 1152 | { |
---|
[136] | 1153 | if (!$this->running) { |
---|
| 1154 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1155 | return false; |
---|
| 1156 | } |
---|
[42] | 1157 | |
---|
[136] | 1158 | $this->logMsg(sprintf('deleteBoomerangURL(%s): %s', $id, $this->getBoomerangURL($id)), LOG_DEBUG, __FILE__, __LINE__); |
---|
[22] | 1159 | |
---|
[154] | 1160 | if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) { |
---|
| 1161 | unset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id]); |
---|
| 1162 | } else if (is_array($_SESSION['_app'][$this->_ns]['boomerang']['url'])) { |
---|
| 1163 | array_pop($_SESSION['_app'][$this->_ns]['boomerang']['url']); |
---|
[1] | 1164 | } |
---|
| 1165 | } |
---|
[42] | 1166 | |
---|
[1] | 1167 | /** |
---|
[103] | 1168 | * Check if a valid boomerang URL value has been set. A boomerang URL is considered |
---|
| 1169 | * valid if: 1) it is not empty, 2) it is not the current URL, and 3) has not been accessed within n seconds. |
---|
[1] | 1170 | * |
---|
[103] | 1171 | * @return bool True if it is set and valid, false otherwise. |
---|
[1] | 1172 | */ |
---|
| 1173 | function validBoomerangURL($id=null, $use_nonspecificboomerang=false) |
---|
| 1174 | { |
---|
[136] | 1175 | if (!$this->running) { |
---|
| 1176 | $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1177 | return false; |
---|
| 1178 | } |
---|
[42] | 1179 | |
---|
[154] | 1180 | if (!isset($_SESSION['_app'][$this->_ns]['boomerang']['url'])) { |
---|
[136] | 1181 | $this->logMsg(sprintf('validBoomerangURL(%s) no boomerang URL set.', $id), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1182 | return false; |
---|
| 1183 | } |
---|
[42] | 1184 | |
---|
[334] | 1185 | // Time is the time stamp of a boomerangURL redirection, or setting of a boomerangURL. |
---|
[1] | 1186 | // a boomerang redirection will always occur at least several seconds after the last boomerang redirect |
---|
| 1187 | // or a boomerang being set. |
---|
[154] | 1188 | $boomerang_time = isset($_SESSION['_app'][$this->_ns]['boomerang']['time']) ? $_SESSION['_app'][$this->_ns]['boomerang']['time'] : 0; |
---|
[42] | 1189 | |
---|
[22] | 1190 | $url = ''; |
---|
[154] | 1191 | if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) { |
---|
| 1192 | $url = $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id]; |
---|
[1] | 1193 | } else if (!isset($id) || $use_nonspecificboomerang) { |
---|
| 1194 | // Use non specific boomerang if available. |
---|
[154] | 1195 | $url = end($_SESSION['_app'][$this->_ns]['boomerang']['url']); |
---|
[1] | 1196 | } |
---|
[42] | 1197 | |
---|
[136] | 1198 | $this->logMsg(sprintf('validBoomerangURL(%s) testing: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[22] | 1199 | |
---|
| 1200 | if ('' == $url) { |
---|
[136] | 1201 | $this->logMsg(sprintf('validBoomerangURL(%s) not valid, empty!', $id), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1202 | return false; |
---|
| 1203 | } |
---|
| 1204 | if ($url == absoluteMe()) { |
---|
| 1205 | // The URL we are directing to is the current page. |
---|
[136] | 1206 | $this->logMsg(sprintf('validBoomerangURL(%s) not valid, same as absoluteMe: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1207 | return false; |
---|
| 1208 | } |
---|
| 1209 | if ($boomerang_time >= (time() - 2)) { |
---|
[159] | 1210 | // Last boomerang direction was less than 2 seconds ago. |
---|
| 1211 | $this->logMsg(sprintf('validBoomerangURL(%s) not valid, boomerang_time too short: %s seconds', $id, time() - $boomerang_time), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1212 | return false; |
---|
| 1213 | } |
---|
[42] | 1214 | |
---|
[136] | 1215 | $this->logMsg(sprintf('validBoomerangURL(%s) is valid: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__); |
---|
[1] | 1216 | return true; |
---|
| 1217 | } |
---|
| 1218 | |
---|
| 1219 | /** |
---|
| 1220 | * Force the user to connect via https (port 443) by redirecting them to |
---|
| 1221 | * the same page but with https. |
---|
| 1222 | */ |
---|
| 1223 | function sslOn() |
---|
| 1224 | { |
---|
[38] | 1225 | if (function_exists('apache_get_modules')) { |
---|
[42] | 1226 | $modules = apache_get_modules(); |
---|
[38] | 1227 | } else { |
---|
| 1228 | // It's safe to assume we have mod_ssl if we can't determine otherwise. |
---|
| 1229 | $modules = array('mod_ssl'); |
---|
| 1230 | } |
---|
[42] | 1231 | |
---|
[136] | 1232 | if ('' == getenv('HTTPS') && $this->getParam('ssl_enabled') && in_array('mod_ssl', $modules)) { |
---|
| 1233 | $this->raiseMsg(sprintf(_("Secure SSL connection made to %s"), $this->getParam('ssl_domain')), MSG_NOTICE, __FILE__, __LINE__); |
---|
[1] | 1234 | // Always append session because some browsers do not send cookie when crossing to SSL URL. |
---|
[136] | 1235 | $this->dieURL('https://' . $this->getParam('ssl_domain') . getenv('REQUEST_URI'), null, true); |
---|
[1] | 1236 | } |
---|
| 1237 | } |
---|
[42] | 1238 | |
---|
| 1239 | |
---|
[1] | 1240 | /** |
---|
| 1241 | * to enforce the user to connect via http (port 80) by redirecting them to |
---|
| 1242 | * a http version of the current url. |
---|
| 1243 | */ |
---|
| 1244 | function sslOff() |
---|
| 1245 | { |
---|
[53] | 1246 | if ('' != getenv('HTTPS')) { |
---|
[1] | 1247 | $this->dieURL('http://' . getenv('HTTP_HOST') . getenv('REQUEST_URI'), null, true); |
---|
| 1248 | } |
---|
| 1249 | } |
---|
| 1250 | |
---|
[42] | 1251 | |
---|
[1] | 1252 | } // End. |
---|
| 1253 | |
---|
[441] | 1254 | ?> |
---|