source: trunk/lib/App.inc.php @ 167

Last change on this file since 167 was 167, checked in by scdev, 18 years ago

Q - moved sc-msg div out of the foreach loop in App::printRaisedMessages.
File size: 43.4 KB
Line 
1<?php
2/**
3 * App.inc.php
4 * code by strangecode :: www.strangecode.com :: this document contains copyrighted information
5 *
6 * Primary application framework class.
7 *
8 * @author  Quinn Comendant <quinn@strangecode.com>
9 * @version 2.1
10 */
11
12// Message Types.
13define('MSG_ERR', 1);
14define('MSG_ERROR', MSG_ERR);
15define('MSG_WARNING', 2);
16define('MSG_NOTICE', 4);
17define('MSG_SUCCESS', 8);
18define('MSG_ALL', MSG_SUCCESS | MSG_NOTICE | MSG_WARNING | MSG_ERROR);
19
20require_once dirname(__FILE__) . '/Utilities.inc.php';
21
22class App {
23
24    // Namespace of this application instance.
25    var $_ns;
26
27    // If $app->start has run successfully.
28    var $running = false;
29
30    // Instance of database object.
31    var $db;
32
33    // Array of query arguments will be carried persistently between requests.
34    var $_carry_queries = array();
35
36    // Dictionary of global application parameters.
37    var $_params = array();
38
39    // Default parameters.
40    var $_param_defaults = array(
41
42        // Public name and email address for this application.
43        'site_name' => null,
44        'site_email' => null,
45        'site_url' => '', // URL automatically determined by _SERVER['HTTP_HOST'] if not set here.
46
47        // The location the user will go if the system doesn't know where else to send them.
48        'redirect_home_url' => '/',
49
50        // SSL URL used when redirecting with $app->sslOn().
51        'ssl_domain' => null,
52        'ssl_enabled' => false,
53
54        // Character set for page output. Used in the Content-Type header and the HTML <meta content-type> tag.
55        'character_set' => 'utf-8',
56
57        // Human-readable format used to display dates.
58        'date_format' => 'd M Y',
59        'time_format' => 'h:i:s A',
60        'sql_date_format' => '%e %b %Y',
61        'sql_time_format' => '%k:%i',
62
63        // Use php sessions?
64        'enable_session' => false,
65        'session_name' => 'Strangecode',
66        'session_use_cookies' => true,
67
68        // Use database?
69        'enable_db' => false,
70
71        // Use db-based sessions?
72        'enable_db_session_handler' => false,
73
74        // DB passwords should be set as apache environment variables in httpd.conf, readable only by root.
75        'db_server' => 'localhost',
76        'db_name' => null,
77        'db_user' => null,
78        'db_pass' => null,
79
80        // Database debugging.
81        'db_always_debug' => false, // TRUE = display all SQL queries.
82        'db_debug' => false, // TRUE = display db errors.
83        'db_die_on_failure' => false, // TRUE = script stops on db error.
84
85        // For classes that require db tables, do we check that a table exists and create if missing?
86        'db_create_tables' => true,
87
88        // The level of error reporting. Don't change this to suppress messages, instead use display_errors to control display.
89        'error_reporting' => E_ALL,
90
91        // Don't display errors by default; it is preferable to log them to a file.
92        'display_errors' => false,
93
94        // Directory in which to store log files.
95        'log_directory' => '',
96
97        // PHP error log.
98        'php_error_log' => 'php_error_log',
99
100        // General application log.
101        'log_filename' => 'app_log',
102
103        // Logging priority can be any of the following, or false to deactivate:
104        // LOG_EMERG     system is unusable
105        // LOG_ALERT     action must be taken immediately
106        // LOG_CRIT      critical conditions
107        // LOG_ERR       error conditions
108        // LOG_WARNING   warning conditions
109        // LOG_NOTICE    normal, but significant, condition
110        // LOG_INFO      informational message
111        // LOG_DEBUG     debug-level message
112        'log_file_priority' => false,
113        'log_email_priority' => false,
114        'log_sms_priority' => false,
115        'log_screen_priority' => false,
116
117        // Email address to receive log event emails.
118        'log_to_email_address' => null,
119
120        // SMS Email address to receive log event SMS messages.
121        'log_to_sms_address' => null,
122
123        // A key for calculating simple cryptographic signatures. Set using as an environment variables in the httpd.conf with 'SetEnv SIGNING_KEY <key>'.
124        // Existing password hashes rely on the same key/salt being used to compare encryptions.
125        // Don't change this unless you know existing hashes or signatures will not be affected!
126        'signing_key' => 'aae6abd6209d82a691a9f96384a7634a',
127    );
128
129    /**
130     * This method enforces the singleton pattern for this class. Only one application is running at a time.
131     *
132     * $param   string  $namespace  Name of this application.
133     * @return  object  Reference to the global Cache object.
134     * @access  public
135     * @static
136     */
137    function &getInstance($namespace='')
138    {
139        static $instance = null;
140
141        if ($instance === null) {
142            $instance = new App($namespace);
143        }
144
145        return $instance;
146    }
147
148    /**
149     * Constructor.
150     */
151    function App($namespace='')
152    {
153        // Set namespace of application instance.
154        $this->_ns = $namespace;
155
156        // Initialize default parameters.
157        $this->_params = array_merge($this->_params, $this->_param_defaults);
158    }
159
160    /**
161     * Set (or overwrite existing) parameters by passing an array of new parameters.
162     *
163     * @access public
164     * @param  array    $param     Array of parameters (key => val pairs).
165     */
166    function setParam($param=null)
167    {
168        if (isset($param) && is_array($param)) {
169            // Merge new parameters with old overriding only those passed.
170            $this->_params = array_merge($this->_params, $param);
171        }
172    }
173
174    /**
175     * Return the value of a parameter.
176     *
177     * @access  public
178     * @param   string  $param      The key of the parameter to return.
179     * @return  mixed               Parameter value, or null if not existing.
180     */
181    function getParam($param=null)
182    {
183        if ($param === null) {
184            return $this->_params;
185        } else if (isset($this->_params[$param])) {
186            return $this->_params[$param];
187        } else {
188            trigger_error(sprintf('Parameter is not set: %s', $param), E_USER_NOTICE);
189            return null;
190        }
191    }
192
193    /**
194     * Begin running this application.
195     *
196     * @access  public
197     * @author  Quinn Comendant <quinn@strangecode.com>
198     * @since   15 Jul 2005 00:32:21
199     */
200    function start()
201    {
202        if ($this->running) {
203            return false;
204        }
205
206        // Error reporting.
207        ini_set('error_reporting', $this->getParam('error_reporting'));
208        ini_set('display_errors', $this->getParam('display_errors'));
209        ini_set('log_errors', true);
210        if (is_dir($this->getParam('log_directory')) && is_writable($this->getParam('log_directory'))) {
211            ini_set('error_log', $this->getParam('log_directory') . '/' . $this->getParam('php_error_log'));
212        }
213
214
215        /**
216         * 1. Start Database.
217         */
218
219        if (true === $this->getParam('enable_db')) {
220
221            // DB connection parameters taken from environment variables in the httpd.conf file, readable only by root.
222            if (!empty($_SERVER['DB_SERVER'])) {
223                $this->setParam(array('db_server' => $_SERVER['DB_SERVER']));
224            }
225            if (!empty($_SERVER['DB_NAME'])) {
226                $this->setParam(array('db_name' => $_SERVER['DB_NAME']));
227            }
228            if (!empty($_SERVER['DB_USER'])) {
229                $this->setParam(array('db_user' => $_SERVER['DB_USER']));
230            }
231            if (!empty($_SERVER['DB_PASS'])) {
232                $this->setParam(array('db_pass' => $_SERVER['DB_PASS']));
233            }
234
235            // There will ever only be one instance of the DB object, and here is where it is instantiated.
236            require_once dirname(__FILE__) . '/DB.inc.php';
237            $this->db =& DB::getInstance();
238            $this->db->setParam(array(
239                'db_server' => $this->getParam('db_server'),
240                'db_name' => $this->getParam('db_name'),
241                'db_user' => $this->getParam('db_user'),
242                'db_pass' => $this->getParam('db_pass'),
243                'db_always_debug' => $this->getParam('db_always_debug'),
244                'db_debug' => $this->getParam('db_debug'),
245                'db_die_on_failure' => $this->getParam('db_die_on_failure'),
246            ));
247
248            // Connect to database.
249            $this->db->connect();
250        }
251
252
253        /**
254         * 2. Start PHP session.
255         */
256
257        // Skip session for some user agents.
258        if (preg_match('/Atomz|ApacheBench|Wget/i', getenv('HTTP_USER_AGENT'))) {
259            $this->setParam(array('enable_session' => false));
260        }
261
262        if (true === $this->getParam('enable_session')) {
263
264            if (true === $this->getParam('enable_db_session_handler') && true === $this->getParam('enable_db')) {
265                // Database session handling.
266                require_once dirname(__FILE__) . '/DBSessionHandler.inc.php';
267                $db_save_handler = new DBSessionHandler($this->db, array(
268                    'db_table' => 'session_tbl',
269                    'create_table' => $this->getParam('db_create_tables'),
270                ));
271            }
272
273            // Session parameters.
274            ini_set('session.use_cookies', $this->getParam('session_use_cookies'));
275            ini_set('session.use_trans_sid', false);
276            ini_set('session.entropy_file', '/dev/urandom');
277            ini_set('session.entropy_length', '512');
278            session_name($this->getParam('session_name'));
279
280            // Start the session.
281            session_start();
282
283            if (!isset($_SESSION['_app'][$this->_ns])) {
284                // Access session data using: $_SESSION['...'].
285                // Initialize here _after_ session has started.
286                $_SESSION['_app'][$this->_ns] = array(
287                    'messages' => array(),
288                    'boomerang' => array('url'),
289                );
290            }
291        }
292
293
294        /**
295         * 3. Misc setup.
296         */
297
298        // Script URI will be something like http://host.name.tld (no ending slash)
299        // and is used whenever a URL need be used to the current site.
300        // Not available on cli scripts obviously.
301        if (isset($_SERVER['HTTP_HOST']) && '' != $_SERVER['HTTP_HOST'] && '' == $this->getParam('site_url')) {
302            $this->setParam(array('site_url' => sprintf('%s://%s', ('on' == getenv('HTTPS') ? 'https' : 'http'), getenv('HTTP_HOST'))));
303        }
304
305        // A key for calculating simple cryptographic signatures.
306        if (isset($_SERVER['SIGNING_KEY'])) {
307            $this->setParam(array('signing_key' => $_SERVER['SIGNING_KEY']));
308        }
309
310        // Character set. This should also be printed in the html header template.
311        header('Content-type: text/html; charset=' . $this->getParam('character_set'));
312       
313        // Set the version of the codebase we're using.
314        $codebase_version_file = dirname(__FILE__) . '/../docs/version.txt';
315        if (is_readable($codebase_version_file)) {
316            $codebase_version = trim(file_get_contents($codebase_version_file));
317            $this->setParam(array('codebase_version' => $codebase_version));
318            header('X-Codebase-Version: ' . $codebase_version);
319        }
320
321        $this->running = true;
322    }
323
324    /**
325     * Stop running this application.
326     *
327     * @access  public
328     * @author  Quinn Comendant <quinn@strangecode.com>
329     * @since   17 Jul 2005 17:20:18
330     */
331    function stop()
332    {
333        session_write_close();
334        restore_include_path();
335        $this->running = false;
336        if (true === $this->getParam('enable_db')) {
337            $this->db->close();
338        }
339    }
340
341
342    /**
343     * Add a message to the session, which is printed in the header.
344     * Just a simple way to print messages to the user.
345     *
346     * @access public
347     *
348     * @param string $message The text description of the message.
349     * @param int    $type    The type of message: MSG_NOTICE,
350     *                        MSG_SUCCESS, MSG_WARNING, or MSG_ERR.
351     * @param string $file    __FILE__.
352     * @param string $line    __LINE__.
353     */
354    function raiseMsg($message, $type=MSG_NOTICE, $file=null, $line=null)
355    {
356        $message = trim($message);
357
358        if (!$this->running || '' == $message) {
359            $this->logMsg(sprintf('Canceled method call %s, application not running or message is an empty string.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
360            return false;
361        }
362
363        // Save message in session under unique key to avoid duplicate messages.
364        $msg_id = md5($type . $message . $file . $line);
365        $_SESSION['_app'][$this->_ns]['messages'][$msg_id] = array(
366            'type'    => $type,
367            'message' => $message,
368            'file'    => $file,
369            'line'    => $line,
370            'count'   => (isset($_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) ? (1 + $_SESSION['_app'][$this->_ns]['messages'][$msg_id]['count']) : 1)
371        );
372
373        if (!in_array($type, array(MSG_NOTICE, MSG_SUCCESS, MSG_WARNING, MSG_ERR))) {
374            $this->logMsg(sprintf('Invalid MSG_* type: %s', $type), LOG_NOTICE, __FILE__, __LINE__);
375        }
376    }
377   
378    /**
379     * Returns an array of the raised messages.
380     *
381     * @access  public
382     * @return  array   List of messags in FIFO order.
383     * @author  Quinn Comendant <quinn@strangecode.com>
384     * @since   21 Dec 2005 13:09:20
385     */
386    function getRaisedMessages()
387    {
388        if (!$this->running) {
389            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
390            return false;
391        }
392
393        return isset($_SESSION['_app'][$this->_ns]['messages']) ? $_SESSION['_app'][$this->_ns]['messages'] : array();
394    }
395   
396    /**
397     * Resets the message list.
398     *
399     * @access  public
400     * @author  Quinn Comendant <quinn@strangecode.com>
401     * @since   21 Dec 2005 13:21:54
402     */
403    function clearRaisedMessages()
404    {
405        if (!$this->running) {
406            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
407            return false;
408        }
409       
410        $_SESSION['_app'][$this->_ns]['messages'] = array();
411    }
412
413    /**
414     * Prints the HTML for displaying raised messages.
415     *
416     * @access  public
417     * @author  Quinn Comendant <quinn@strangecode.com>
418     * @since   15 Jul 2005 01:39:14
419     */
420    function printRaisedMessages()
421    {
422        if (!$this->running) {
423            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
424            return false;
425        }
426       
427        $messages = $this->getRaisedMessages();
428        if (!empty($messages)) {
429            ?><div id="sc-msg" class="sc-msg"><?php
430            foreach ($messages as $m) {
431                if (error_reporting() > 0 && $this->getParam('display_errors') && isset($m['file']) && isset($m['line'])) {
432                    echo "\n<!-- [" . $m['file'] . ' : ' . $m['line'] . '] -->';
433                }
434                switch ($m['type']) {
435                case MSG_ERR:
436                    echo '<div class="sc-msg-error">' . $m['message'] . '</div>';
437                    break;
438
439                case MSG_WARNING:
440                    echo '<div class="sc-msg-warning">' . $m['message'] . '</div>';
441                    break;
442
443                case MSG_SUCCESS:
444                    echo '<div class="sc-msg-success">' . $m['message'] . '</div>';
445                    break;
446
447                case MSG_NOTICE:
448                default:
449                    echo '<div class="sc-msg-notice">' . $m['message'] . '</div>';
450                    break;
451
452                }
453            }
454            ?></div><?php
455        }
456        $this->clearRaisedMessages();
457    }
458
459    /**
460     * Logs messages to defined channels: file, email, sms, and screen. Repeated messages are
461     * not repeated but printed once with count.
462     *
463     * @access public
464     * @param string $message   The text description of the message.
465     * @param int    $priority  The type of message priority (in descending order):
466     *                          LOG_EMERG     system is unusable
467     *                          LOG_ALERT     action must be taken immediately
468     *                          LOG_CRIT      critical conditions
469     *                          LOG_ERR       error conditions
470     *                          LOG_WARNING   warning conditions
471     *                          LOG_NOTICE    normal, but significant, condition
472     *                          LOG_INFO      informational message
473     *                          LOG_DEBUG     debug-level message
474     * @param string $file      The file where the log event occurs.
475     * @param string $line      The line of the file where the log event occurs.
476     */
477    function logMsg($message, $priority=LOG_INFO, $file=null, $line=null)
478    {
479        static $previous_events = array();
480
481        // If priority is not specified, assume the worst.
482        if (!$this->logPriorityToString($priority)) {
483            $this->logMsg(sprintf('Log priority %s not defined. (Message: %s)', $priority, $message), LOG_EMERG, $file, $line);
484            $priority = LOG_EMERG;
485        }
486
487        // If log file is not specified, don't log to a file.
488        if (!$this->getParam('log_directory') || !$this->getParam('log_filename') || !is_dir($this->getParam('log_directory')) || !is_writable($this->getParam('log_directory'))) {
489            $this->setParam(array('log_file_priority' => false));
490            // We must use trigger_error to report this problem rather than calling $app->logMsg, which might lead to an infinite loop.
491            trigger_error(sprintf('Codebase error: log directory (%s) not found or writable.', $this->getParam('log_directory')), E_USER_NOTICE);
492        }
493
494        // Make sure to log in the system's locale.
495        $locale = setlocale(LC_TIME, 0);
496        setlocale(LC_TIME, 'C');
497
498        // Strip HTML tags except any with more than 7 characters because that's probably not a HTML tag, e.g. <email@address.com>.
499        preg_match_all('/(<[^>\s]{7,})[^>]*>/', $message, $strip_tags_allow);
500        $message = strip_tags(preg_replace('/\s+/', ' ', $message), (!empty($strip_tags_allow[1]) ? join('> ', $strip_tags_allow[1]) . '>' : null));
501
502        // Store this event under a unique key, counting each time it occurs so that it only gets reported a limited number of times.
503        $msg_id = md5($message . $priority . $file . $line);
504        if (isset($previous_events[$msg_id])) {
505            $previous_events[$msg_id]++;
506            if ($previous_events[$msg_id] == 2) {
507                $this->logMsg(sprintf('%s (Event repeated %s or more times)', $message, $previous_events[$msg_id]), $priority, $file, $line);
508            }
509            return false;
510        } else {
511            $previous_events[$msg_id] = 1;
512        }
513       
514        // Data to be stored for a log event.
515        $event = array(
516            'date'      => date('Y-m-d H:i:s'),
517            'remote ip' => getRemoteAddr(),
518            'pid'       => (substr(PHP_OS, 0, 3) != 'WIN' ? posix_getpid() : ''),
519            'type'      => $this->logPriorityToString($priority),
520            'file:line' => "$file : $line",
521            'url'       => (isset($_SERVER['REQUEST_URI']) ? $_SERVER['REQUEST_URI'] : ''),
522            'message'   => $message
523        );
524
525        // FILE ACTION
526        if ($this->getParam('log_file_priority') && $priority <= $this->getParam('log_file_priority')) {
527            $event_str = '[' . join('] [', $event) . ']';
528            error_log($event_str . "\n", 3, $this->getParam('log_directory') . '/' . $this->getParam('log_filename'));
529        }
530
531        // EMAIL ACTION
532        if ($this->getParam('log_email_priority') && $priority <= $this->getParam('log_email_priority')) {
533            $subject = sprintf('[%s %s] %s', getenv('HTTP_HOST'), $event['type'], $message);
534            $email_msg = sprintf("A %s log event occured on %s\n\n", $event['type'], getenv('HTTP_HOST'));
535            $headers = "From: codebase@strangecode.com";
536            foreach ($event as $k=>$v) {
537                $email_msg .= sprintf("%-11s%s\n", $k, $v);
538            }
539            mail($this->getParam('log_to_email_address'), $subject, $email_msg, $headers, '-f codebase@strangecode.com');
540        }
541
542        // SMS ACTION
543        if ($this->getParam('log_sms_priority') && $priority <= $this->getParam('log_sms_priority')) {
544            $subject = sprintf('[%s %s]', getenv('HTTP_HOST'), $priority);
545            $sms_msg = sprintf('%s [%s:%s]', $event['message'], basename($file), $line);
546            $headers = "From: codebase@strangecode.com";
547            mail($this->getParam('log_to_sms_address'), $subject, $sms_msg, $headers, '-f codebase@strangecode.com');
548        }
549
550        // SCREEN ACTION
551        if ($this->getParam('log_screen_priority') && $priority <= $this->getParam('log_screen_priority')) {
552            echo "[{$event['date']}] [{$event['type']}] [{$event['file:line']}] [{$event['message']}]\n";
553        }
554
555        // Restore original locale.
556        setlocale(LC_TIME, $locale);
557    }
558
559    /**
560     * Returns the string representation of a LOG_* integer constant.
561     *
562     * @param int  $priority  The LOG_* integer constant.
563     *
564     * @return                The string representation of $priority.
565     */
566    function logPriorityToString ($priority) {
567        $priorities = array(
568            LOG_EMERG   => 'emergency',
569            LOG_ALERT   => 'alert',
570            LOG_CRIT    => 'critical',
571            LOG_ERR     => 'error',
572            LOG_WARNING => 'warning',
573            LOG_NOTICE  => 'notice',
574            LOG_INFO    => 'info',
575            LOG_DEBUG   => 'debug'
576        );
577        if (isset($priorities[$priority])) {
578            return $priorities[$priority];
579        } else {
580            return false;
581        }
582    }
583
584    /**
585     * Sets which query arguments will be carried persistently between requests.
586     * Values in the _carry_queries array will be copied to URLs (via $app->url()) and
587     * to hidden input values (via printHiddenSession()).
588     *
589     * @access  public
590     * @param   string  $query_key  The key of the query argument to save.
591     * @author  Quinn Comendant <quinn@strangecode.com>
592     * @since   14 Nov 2005 19:24:52
593     */
594    function carryQuery($query_key)
595    {
596        // If not already set, and there is a non-empty value provided in the request...
597        if (!isset($this->_carry_queries[$query_key]) && getFormData($query_key, false)) {
598            // Copy the value of the specified query argument into the _carry_queries array.
599            $this->_carry_queries[$query_key] = getFormData($query_key);
600        }
601    }
602
603    /**
604     * Outputs a fully qualified URL with a query of all the used (ie: not empty)
605     * keys and values, including optional queries. This allows mindless retention
606     * of query arguments across page requests. If cookies are not
607     * used, the session id will be propogated in the URL.
608     *
609     * @param  string $url              The initial url
610     * @param  mixed  $carry_args       Additional url arguments to carry in the query,
611     *                                  or FALSE to prevent carrying queries. Can be any of the following formats:
612     *                                      array('key1', key2', key3')  <-- to save these keys if in the form data.
613     *                                      array('key1'=>'value', key2'='value')  <-- to set keys to default values if not present in form data.
614     *                                      false  <-- To not carry any queries. If URL already has queries those will be retained.
615     *
616     * @param  mixed  $always_include_sid  Always add the session id, even if using_trans_sid = true. This is required when
617     *                                     URL starts with http, since PHP using_trans_sid doesn't do those and also for
618     *                                     header('Location...') redirections.
619     *
620     * @return string url with attached queries and, if not using cookies, the session id
621     */
622    function url($url, $carry_args=null, $always_include_sid=false)
623    {
624        if (!$this->running) {
625            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
626            return false;
627        }
628
629        // Get any provided query arguments to include in the final URL.
630        // If FALSE is a provided here, DO NOT carry the queries.
631        $do_carry_queries = true;
632        $one_time_carry_queries = array();
633        if (!is_null($carry_args)) {
634            if (is_array($carry_args) && !empty($carry_args)) {
635                foreach ($carry_args as $key=>$arg) {
636                    // Get query from appropriate source.
637                    if (false === $arg) {
638                        $do_carry_queries = false;
639                    } else if (false !== getFormData($arg, false)) {
640                        $one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available.
641                    } else if (!is_numeric($key) && '' != $arg) {
642                        $one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data).
643                    }
644                }
645            } else if (false !== getFormData($carry_args, false)) {
646                $one_time_carry_queries[$carry_args] = getFormData($carry_args);
647            } else if (false === $carry_args) {
648                $do_carry_queries = false;
649            }
650        }
651
652        // Get the first delimiter that is needed in the url.
653        $delim = strpos($url, '?') !== false ? ini_get('arg_separator.output') : '?';
654
655
656        $q = '';
657        if ($do_carry_queries) {
658            // Join the global _carry_queries and local one_time_carry_queries.
659            $query_args = urlEncodeArray(array_merge($this->_carry_queries, $one_time_carry_queries));
660            foreach ($query_args as $key=>$val) {
661                // Check value is set and value does not already exist in the url.
662                if (!preg_match('/[?&]' . preg_quote($key) . '=/', $url)) {
663                    $q .= $delim . $key . '=' . $val;
664                    $delim = ini_get('arg_separator.output');
665                }
666            }
667        }
668
669        // Include the necessary SID if the following is true:
670        // - no cookie in http request OR cookies disabled in App
671        // - sessions are enabled
672        // - the link stays on our site
673        // - transparent SID propogation with session.use_trans_sid is not being used OR url begins with protocol (using_trans_sid has no effect here)
674        // OR
675        // - 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)
676        // AND
677        // - the SID is not already in the query.
678        if (
679            (
680                (
681                    (
682                        !isset($_COOKIE[session_name()])
683                        || !$this->getParam('session_use_cookies')
684                    )
685                    && $this->getParam('enable_session')
686                    && isMyDomain($url)
687                    &&
688                    (
689                        !ini_get('session.use_trans_sid')
690                        || preg_match('!^(http|https)://!i', $url)
691                    )
692                )
693                || $always_include_sid
694            )
695            && !preg_match('/[?&]' . preg_quote(session_name()) . '=/', $url)
696        ) {
697            $url .= $q . $delim . session_name() . '=' . session_id();
698            return $url;
699        } else {
700            $url .= $q;
701            return $url;
702        }
703    }
704
705    /**
706     * Returns a HTML-friendly URL processed with $app->url and & replaced with &amp;
707     *
708     * @access  public
709     * @param   string  $url    Input URL to parse.
710     * @return  string          URL with $app->url() and htmlentities() applied.
711     * @author  Quinn Comendant <quinn@strangecode.com>
712     * @since   09 Dec 2005 17:58:45
713     */
714    function oHREF($url, $carry_args=null, $always_include_sid=false)
715    {
716        $url = $this->url($url, $carry_args, $always_include_sid);
717
718        // Replace any & not followed by an html or unicode entity with it's &amp; equivalent.
719        $url = preg_replace('/&(?![\w\d#]{1,10};)/', '&amp;', $url);
720
721        return $url;
722    }
723
724    /**
725     * Prints a hidden form element with the PHPSESSID when cookies are not used, as well
726     * as hidden form elements for GET_VARS that might be in use.
727     *
728     * @param  mixed  $carry_args        Additional url arguments to carry in the query,
729     *                                   or FALSE to prevent carrying queries. Can be any of the following formats:
730     *                                      array('key1', key2', key3')  <-- to save these keys if in the form data.
731     *                                      array('key1'=>'value', key2'='value')  <-- to set keys to default values if not present in form data.
732     *                                      false  <-- To not carry any queries. If URL already has queries those will be retained.
733     */
734    function printHiddenSession($carry_args=null)
735    {
736        if (!$this->running) {
737            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
738            return false;
739        }
740
741        // Get any provided query arguments to include in the final hidden form data.
742        // If FALSE is a provided here, DO NOT carry the queries.
743        $do_carry_queries = true;
744        $one_time_carry_queries = array();
745        if (!is_null($carry_args)) {
746            if (is_array($carry_args) && !empty($carry_args)) {
747                foreach ($carry_args as $key=>$arg) {
748                    // Get query from appropriate source.
749                    if (false === $arg) {
750                        $do_carry_queries = false;
751                    } else if (false !== getFormData($arg, false)) {
752                        $one_time_carry_queries[$arg] = getFormData($arg); // Set arg to form data if available.
753                    } else if (!is_numeric($key) && '' != $arg) {
754                        $one_time_carry_queries[$key] = getFormData($key, $arg); // Set to arg to default if specified (overwritten by form data).
755                    }
756                }
757            } else if (false !== getFormData($carry_args, false)) {
758                $one_time_carry_queries[$carry_args] = getFormData($carry_args);
759            } else if (false === $carry_args) {
760                $do_carry_queries = false;
761            }
762        }
763
764        // For each existing POST value, we create a hidden input to carry it through a form.
765        if ($do_carry_queries) {
766            // Join the global _carry_queries and local one_time_carry_queries.
767            // urlencode is not used here, not for form data!
768            $query_args = array_merge($this->_carry_queries, $one_time_carry_queries);
769            foreach ($query_args as $key=>$val) {
770                printf('<input type="hidden" name="%s" value="%s" />', $key, $val);
771            }
772        }
773
774        // Include the SID if cookies are disabled.
775        if (!isset($_COOKIE[session_name()]) && !ini_get('session.use_trans_sid')) {
776            printf('<input type="hidden" name="%s" value="%s" />', session_name(), session_id());
777        }
778    }
779
780    /**
781     * Uses an http header to redirect the client to the given $url. If sessions are not used
782     * and the session is not already defined in the given $url, the SID is appended as a URI query.
783     * As with all header generating functions, make sure this is called before any other output.
784     *
785     * @param   string  $url                    The URL the client will be redirected to.
786     * @param   mixed   $carry_args             Additional url arguments to carry in the query,
787     *                                          or FALSE to prevent carrying queries. Can be any of the following formats:
788     *                                          -array('key1', key2', key3')  <-- to save these keys if in the form data.
789     *                                          -array('key1' => 'value', key2' => 'value')  <-- to set keys to default values if not present in form data.
790     *                                          -false  <-- To not carry any queries. If URL already has queries those will be retained.
791     * @param   bool    $always_include_sid     Force session id to be added to Location header.
792     */
793    function dieURL($url, $carry_args=null, $always_include_sid=false)
794    {
795        if (!$this->running) {
796            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
797            return false;
798        }
799
800        if ('' == $url) {
801            // If URL is not specified, use the redirect_home_url.
802            $url = $this->getParam('redirect_home_url');
803        }
804
805        if (preg_match('!^/!', $url)) {
806            // If relative URL is given, prepend correct local hostname.
807            $scheme = 'on' == getenv('HTTPS') ? 'https' : 'http';
808            $host = getenv('HTTP_HOST');
809            $url = sprintf('%s://%s%s', $scheme, $host, $url);
810        }
811
812        $url = $this->url($url, $carry_args, $always_include_sid);
813
814        header(sprintf('Location: %s', $url));
815        $this->logMsg(sprintf('dieURL: %s', $url), LOG_DEBUG, __FILE__, __LINE__);
816
817        // End this application.
818        // Recommended, although I'm not sure it's necessary: http://cn2.php.net/session_write_close
819        $this->stop();
820        die;
821    }
822
823    /*
824    * Redirects a user by calling $app->dieURL(). It will use:
825    * 1. the stored boomerang URL, it it exists
826    * 2. a specified $default_url, it it exists
827    * 3. the referring URL, it it exists.
828    * 4. redirect_home_url configuration variable.
829    *
830    * @access   public
831    * @param    string  $id             Identifier for this script.
832    * @param    mixed   $carry_args     Additional arguments to carry in the URL automatically (see $app->oHREF()).
833    * @param    string  $default_url    A default URL if there is not a valid specified boomerang URL.
834    * @param    bool    $queryless_referrer_comparison   Exclude the URL query from the refererIsMe() comparison.
835    * @return   bool                    False if the session is not running. No return otherwise.
836    * @author   Quinn Comendant <quinn@strangecode.com>
837    * @since    31 Mar 2006 19:17:00
838    */
839    function dieBoomerangURL($id=null, $carry_args=null, $default_url=null, $queryless_referrer_comparison=false)
840    {
841        if (!$this->running) {
842            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
843            return false;
844        }
845
846        // Get URL from stored boomerang. Allow non specific URL if ID not valid.
847        if ($this->validBoomerangURL($id, true)) {
848            if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
849                $url = $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id];
850                $this->logMsg(sprintf('dieBoomerangURL(%s) found: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
851            } else {
852                $url = end($_SESSION['_app'][$this->_ns]['boomerang']['url']);
853                $this->logMsg(sprintf('dieBoomerangURL(%s) using: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
854            }
855            // Delete stored boomerang.
856            $this->deleteBoomerangURL($id);
857        } else if (isset($default_url)) {
858            $url = $default_url;
859        } else if (!refererIsMe(true === $queryless_referrer_comparison)) {
860            // Ensure that the redirecting page is not also the referrer.
861            $url = getenv('HTTP_REFERER');
862            $this->logMsg(sprintf('dieBoomerangURL(%s) using referrer: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
863        } else {
864            // If URL is not specified, use the redirect_home_url.
865            $url = $this->getParam('redirect_home_url');
866            $this->logMsg(sprintf('dieBoomerangURL(%s) not found, using redirect_home_url: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
867        }
868
869        // A redirection will never happen immediately twice.
870        // Set the time so ensure this doesn't happen.
871        $_SESSION['_app'][$this->_ns]['boomerang']['time'] = time();
872        $this->dieURL($url, $carry_args);
873    }
874
875    /**
876     * Set the URL to return to when $app->dieBoomerangURL() is called.
877     *
878     * @param string  $url  A fully validated URL.
879     * @param bool  $id     An identification tag for this url.
880     * FIXME: url garbage collection?
881     */
882    function setBoomerangURL($url=null, $id=null)
883    {
884        if (!$this->running) {
885            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
886            return false;
887        }
888        // A redirection will never happen immediately after setting the boomerangURL.
889        // Set the time so ensure this doesn't happen. See $app->validBoomerangURL for more.
890
891        if ('' != $url && is_string($url)) {
892            // Delete any boomerang request keys in the query string.
893            $url = preg_replace('/[&?]?boomerang=[\w]+/', '', $url);
894
895            if (isset($_SESSION['_app'][$this->_ns]['boomerang']['url']) && is_array($_SESSION['_app'][$this->_ns]['boomerang']['url']) && !empty($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
896                // If the URL currently exists in the boomerang array, delete.
897                while ($existing_key = array_search($url, $_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
898                    unset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$existing_key]);
899                }
900            }
901
902            if (isset($id)) {
903                $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id] = $url;
904            } else {
905                $_SESSION['_app'][$this->_ns]['boomerang']['url'][] = $url;
906            }
907            $this->logMsg(sprintf('setBoomerangURL(%s): %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
908            return true;
909        } else {
910            $this->logMsg(sprintf('setBoomerangURL(%s) is empty!', $id, $url), LOG_NOTICE, __FILE__, __LINE__);
911            return false;
912        }
913    }
914
915    /**
916     * Return the URL set for the specified $id.
917     *
918     * @param string  $id     An identification tag for this url.
919     */
920    function getBoomerangURL($id=null)
921    {
922        if (!$this->running) {
923            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
924            return false;
925        }
926
927        if (isset($id)) {
928            if (isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
929                return $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id];
930            } else {
931                return '';
932            }
933        } else if (is_array($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
934            return end($_SESSION['_app'][$this->_ns]['boomerang']['url']);
935        } else {
936            return false;
937        }
938    }
939
940    /**
941     * Delete the URL set for the specified $id.
942     *
943     * @param string  $id     An identification tag for this url.
944     */
945    function deleteBoomerangURL($id=null)
946    {
947        if (!$this->running) {
948            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
949            return false;
950        }
951
952        $this->logMsg(sprintf('deleteBoomerangURL(%s): %s', $id, $this->getBoomerangURL($id)), LOG_DEBUG, __FILE__, __LINE__);
953
954        if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
955            unset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id]);
956        } else if (is_array($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
957            array_pop($_SESSION['_app'][$this->_ns]['boomerang']['url']);
958        }
959    }
960
961    /**
962     * Check if a valid boomerang URL value has been set. A boomerang URL is considered
963     * valid if: 1) it is not empty, 2) it is not the current URL, and 3) has not been accessed within n seconds.
964     *
965     * @return bool  True if it is set and valid, false otherwise.
966     */
967    function validBoomerangURL($id=null, $use_nonspecificboomerang=false)
968    {
969        if (!$this->running) {
970            $this->logMsg(sprintf('Canceled method call %s, application not running.', __FUNCTION__), LOG_NOTICE, __FILE__, __LINE__);
971            return false;
972        }
973
974        if (!isset($_SESSION['_app'][$this->_ns]['boomerang']['url'])) {
975            $this->logMsg(sprintf('validBoomerangURL(%s) no boomerang URL set.', $id), LOG_DEBUG, __FILE__, __LINE__);
976            return false;
977        }
978
979        // Time is the timestamp of a boomerangURL redirection, or setting of a boomerangURL.
980        // a boomerang redirection will always occur at least several seconds after the last boomerang redirect
981        // or a boomerang being set.
982        $boomerang_time = isset($_SESSION['_app'][$this->_ns]['boomerang']['time']) ? $_SESSION['_app'][$this->_ns]['boomerang']['time'] : 0;
983
984        $url = '';
985        if (isset($id) && isset($_SESSION['_app'][$this->_ns]['boomerang']['url'][$id])) {
986            $url = $_SESSION['_app'][$this->_ns]['boomerang']['url'][$id];
987        } else if (!isset($id) || $use_nonspecificboomerang) {
988            // Use non specific boomerang if available.
989            $url = end($_SESSION['_app'][$this->_ns]['boomerang']['url']);
990        }
991
992        $this->logMsg(sprintf('validBoomerangURL(%s) testing: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
993
994        if ('' == $url) {
995            $this->logMsg(sprintf('validBoomerangURL(%s) not valid, empty!', $id), LOG_DEBUG, __FILE__, __LINE__);
996            return false;
997        }
998        if ($url == absoluteMe()) {
999            // The URL we are directing to is the current page.
1000            $this->logMsg(sprintf('validBoomerangURL(%s) not valid, same as absoluteMe: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1001            return false;
1002        }
1003        if ($boomerang_time >= (time() - 2)) {
1004            // Last boomerang direction was less than 2 seconds ago.
1005            $this->logMsg(sprintf('validBoomerangURL(%s) not valid, boomerang_time too short: %s seconds', $id, time() - $boomerang_time), LOG_DEBUG, __FILE__, __LINE__);
1006            return false;
1007        }
1008
1009        $this->logMsg(sprintf('validBoomerangURL(%s) is valid: %s', $id, $url), LOG_DEBUG, __FILE__, __LINE__);
1010        return true;
1011    }
1012
1013    /**
1014     * Force the user to connect via https (port 443) by redirecting them to
1015     * the same page but with https.
1016     */
1017    function sslOn()
1018    {
1019        if (function_exists('apache_get_modules')) {
1020            $modules = apache_get_modules();
1021        } else {
1022            // It's safe to assume we have mod_ssl if we can't determine otherwise.
1023            $modules = array('mod_ssl');
1024        }
1025
1026        if ('' == getenv('HTTPS') && $this->getParam('ssl_enabled') && in_array('mod_ssl', $modules)) {
1027            $this->raiseMsg(sprintf(_("Secure SSL connection made to %s"), $this->getParam('ssl_domain')), MSG_NOTICE, __FILE__, __LINE__);
1028            // Always append session because some browsers do not send cookie when crossing to SSL URL.
1029            $this->dieURL('https://' . $this->getParam('ssl_domain') . getenv('REQUEST_URI'), null, true);
1030        }
1031    }
1032
1033
1034    /**
1035     * to enforce the user to connect via http (port 80) by redirecting them to
1036     * a http version of the current url.
1037     */
1038    function sslOff()
1039    {
1040        if ('' != getenv('HTTPS')) {
1041            $this->dieURL('http://' . getenv('HTTP_HOST') . getenv('REQUEST_URI'), null, true);
1042        }
1043    }
1044
1045
1046} // End.
1047
1048?>
Note: See TracBrowser for help on using the repository browser.