source: tags/2.1.1/lib/App.inc.php @ 653

Last change on this file since 653 was 242, checked in by quinn, 17 years ago

Fixed some warnings in Prefs.
Fixed boomerang=\w+ removal code.
Added feature to disable trans_sess_id.

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