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

Last change on this file since 294 was 293, checked in by quinn, 16 years ago

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