source: tags/2.0.2/lib/App.inc.php @ 480

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