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