docs/include/vitals.inc.php

   1 <?php
   2 /************************************************************************/
   3 /* AContent                                                             */
   4 /************************************************************************/
   5 /* Copyright (c) 2010                                                   */
   6 /* Inclusive Design Institute                                           */
   7 /*                                                                      */
   8 /* This program is free software. You can redistribute it and/or        */
   9 /* modify it under the terms of the GNU General Public License          */
  10 /* as published by the Free Software Foundation.                        */
  11 /************************************************************************/
  12
  13 if (!defined('TR_INCLUDE_PATH')) { exit; }
  14
  15 define('TR_DEVEL', 1);
  16 define('TR_ERROR_REPORTING', E_ALL ^ E_NOTICE); // default is E_ALL ^ E_NOTICE, use E_ALL or E_ALL + E_STRICT for developing
  17
  18 // Emulate register_globals off. src: http://php.net/manual/en/faq.misc.php#faq.misc.registerglobals
  19 function unregister_GLOBALS() {
  20    if (!ini_get('register_globals')) { return; }
  21
  22    // Might want to change this perhaps to a nicer error
  23    if (isset($_REQUEST['GLOBALS'])) { die('GLOBALS overwrite attempt detected'); }
  24
  25    // Variables that shouldn't be unset
  26    $noUnset = array('GLOBALS','_GET','_POST','_COOKIE','_REQUEST','_SERVER','_ENV', '_FILES');
  27    $input = array_merge($_GET,$_POST,$_COOKIE,$_SERVER,$_ENV,$_FILES,isset($_SESSION) && is_array($_SESSION) ? $_SESSION : array());
  28
  29    foreach ($input as $k => $v) {
  30        if (!in_array($k, $noUnset) && isset($GLOBALS[$k])) { unset($GLOBALS[$k]); }
  31    }
  32 }
  33
  34 /*
  35  * structure of this document (in order):
  36  *
  37  * 0. load config.inc.php
  38  * 1. initilize db connection
  39  * 2. load constants
  40  * 3. initilize session
  41  * 4. load $_config from table 'config'
  42  * 5. start language block
  43  * 6. load common libraries
  44  * 7. initialize theme and template management
  45  * 8. initialize a user instance without user id.
  46  *    if $_SESSION['user_id'] is set, it's assigned to instance in include/header.inc.php
  47  * 9. register pages based on current user's priviledge
  48  * 10. initialize course information if $_SESSION['course_id'] is set
  49  ***/
  50
  51 /**** 0. start system configuration options block ****/
  52 error_reporting(0);
  53 include_once(TR_INCLUDE_PATH.'config.inc.php');
  54 error_reporting(TR_ERROR_REPORTING);
  55
  56 if (!defined('TR_INSTALL') || !TR_INSTALL) {
  57         header('Cache-Control: no-store, no-cache, must-revalidate');
  58         header('Pragma: no-cache');
  59
  60         $relative_path = substr(TR_INCLUDE_PATH, 0, -strlen('include/'));
  61         header('Location: ' . $relative_path . 'install/not_installed.php');
  62         exit;
  63 }
  64 /*** end system config block ****/
  65
  66 /***** 1. database connection *****/
  67 //if (!defined('TR_REDIRECT_LOADED')){
  68 //      require_once(TR_INCLUDE_PATH.'lib/mysql_connect.inc.php');
  69 //}
  70 /***** end database connection ****/
  71
  72 /*** 2. constants ***/
  73 require_once(TR_INCLUDE_PATH.'constants.inc.php');
  74
  75 /*** 3. initilize session ***/
  76 @set_time_limit(0);
  77 @ini_set('session.gc_maxlifetime', '36000'); /* 10 hours */
  78 @session_cache_limiter('private, must-revalidate');
  79
  80 session_name('TransformableID');
  81 error_reporting(TR_ERROR_REPORTING);
  82
  83 ob_start();
  84 session_set_cookie_params(0, $_base_path);
  85 session_start();
  86 $str = ob_get_contents();
  87 ob_end_clean();
  88 unregister_GLOBALS();
  89
  90 // $_user_id could be set in home/ims/ims_import.php
  91 // @see home/ims/ims_import.php
  92 if (isset($_user_id) && $_user_id > 0) $_SESSION['user_id'] = $_user_id;
  93 /***** end session initilization block ****/
  94
  95 /***** 4. load $_config from table 'config' *****/
  96 require(TR_INCLUDE_PATH.'phpCache/phpCache.inc.php'); // cache library
  97 require(TR_INCLUDE_PATH.'classes/DAO/ThemesDAO.class.php');
  98 require(TR_INCLUDE_PATH.'classes/DAO/ConfigDAO.class.php');
  99
 100 $configDAO = new ConfigDAO();
 101 $rows = $configDAO->getAll();
 102 if (is_array($rows))
 103 {
 104         foreach ($rows as $id => $row)
 105         {
 106                 $_config[$row['name']] = $row['value'];
 107         }
 108 }
 109
 110 //set the timezone, php 5.3+ problem. http://atutor.ca/atutor/mantis/view.php?id=4409
 111 date_default_timezone_set('UTC');
 112
 113 // define as constants. more constants are defined in include/constants.inc.php
 114 define('EMAIL', $_config['contact_email']);
 115 define('SITE_NAME', $_config['site_name']);
 116 $MaxFileSize = $_config['max_file_size'];
 117 $MaxCourseSize = $_config['max_course_size'];
 118 $MaxFileSize = $_config['max_file_size'];
 119 $IllegalExtentions = explode('|',$_config['illegal_extentions']);
 120 /***** end loading $_config *****/
 121
 122 /***** 5. start language block *****/
 123 // set current language
 124 require(TR_INCLUDE_PATH . 'classes/Language/LanguageManager.class.php');
 125 $languageManager = new LanguageManager();
 126
 127 $myLang = $languageManager->getMyLanguage();
 128
 129 if ($myLang === FALSE) {
 130         echo 'There are no languages installed!';
 131         exit;
 132 }
 133
 134 $myLang->saveToSession();
 135
 136 /* set right-to-left language */
 137 $rtl = '';
 138 if ($myLang->isRTL()) {
 139         $rtl = 'rtl_'; /* basically the prefix to a rtl variant directory/filename. eg. rtl_atee */
 140 }
 141 /***** end language block ****/
 142
 143 /***** 6. load common libraries *****/
 144         require(TR_INCLUDE_PATH.'lib/output.inc.php');           /* output functions */
 145 /***** end load common libraries ****/
 146
 147 /***** 7. initialize theme and template management *****/
 148         require(TR_INCLUDE_PATH.'classes/Savant2/Savant2.php');
 149
 150         // set default template paths:
 151         $savant = new Savant2();
 152
 153         if (isset($_SESSION['prefs']['PREF_THEME']) && file_exists(TR_INCLUDE_PATH . '../themes/' . $_SESSION['prefs']['PREF_THEME']) && $_SESSION['user_id']>0)
 154         {
 155                 if (!is_dir(TR_INCLUDE_PATH . '../themes/' . $_SESSION['prefs']['PREF_THEME']))
 156                 {
 157                         $_SESSION['prefs']['PREF_THEME'] = 'default';
 158                 }
 159                 else
 160                 {
 161                         //check if enabled
 162                         $themesDAO = new ThemesDAO();
 163                         $row = $themesDAO->getByID($_SESSION['prefs']['PREF_THEME']);
 164
 165                         if ($row['status'] == 0)
 166                         {
 167                                 // get default
 168                                 $_SESSION['prefs']['PREF_THEME'] = get_default_theme();
 169                         }
 170                 }
 171         } else
 172         {
 173                 $_SESSION['prefs']['PREF_THEME'] = get_default_theme();
 174         }
 175
 176         $savant->addPath('template', TR_INCLUDE_PATH . '../themes/' . $_SESSION['prefs']['PREF_THEME'] . '/');
 177
 178         require(TR_INCLUDE_PATH . '../themes/' . $_SESSION['prefs']['PREF_THEME'] . '/theme.cfg.php');
 179
 180         require(TR_INCLUDE_PATH.'classes/Message/Message.class.php');
 181         $msg = new Message($savant);
 182
 183 /***** end of initialize theme and template management *****/
 184
 185 /***** 8. initialize user instance *****/
 186 // used as global var
 187 if (isset($_SESSION['user_id']) && $_SESSION['user_id'] > 0)
 188 {
 189         // check if $_SESSION['user_id'] is valid
 190         include_once(TR_INCLUDE_PATH.'classes/DAO/UsersDAO.class.php');
 191         $usersDAO = new UsersDAO();
 192         $user = $usersDAO->getUserByID($_SESSION['user_id']);
 193
 194         if (!$user)  // invalid user
 195                 unset($_SESSION['user_id']);
 196         else
 197         {
 198                 include_once(TR_INCLUDE_PATH.'classes/User.class.php');
 199                 $_current_user = new User($_SESSION['user_id']);
 200         }
 201 }
 202 /***** end of initialize user instance *****/
 203
 204 /* 9. initialize course information if $course_id or $cid is set
 205  * This section generates global variables:
 206  * $_content_id if set,
 207  * $_course_id if set or $cid is set
 208  * $_SESSION['s_cid']: record the last content_id on (user_id + course_id) basis
 209  * $_sequence_links: resume/first/next/previous content links
 210  */
 211 if (intval($_REQUEST['_cid']) > 0) $_content_id = intval($_REQUEST['_cid']);
 212 else if (intval($_POST['_cid']) > 0) $_content_id = intval($_POST['_cid']);
 213
 214 if (intval($_REQUEST['_course_id']) > 0) $_course_id = intval($_REQUEST['_course_id']);
 215 else if (intval($_POST['_course_id']) > 0) $_course_id = intval($_POST['_course_id']);
 216
 217 // find course_id thru content_id
 218 if ($_content_id > 0)
 219 {
 220         include_once(TR_INCLUDE_PATH.'classes/DAO/ContentDAO.class.php');
 221         $contentDAO = new ContentDAO();
 222         $content_row = $contentDAO->get($_content_id);
 223         $_course_id = $content_row['course_id'];
 224 }
 225
 226 // Generate $_SESSION['s_cid']: record the last visited content_id
 227 // for authors and the users who have the current course in "my courses" list,
 228 //     save the last visited content_id into user_courses and set the session var.
 229 //     @see ContentUtility::saveLastCid()
 230 // for the users who don't have the current course in "my courses" list,
 231 //     set the session var as $_GET['cid']
 232 if ($_course_id > 0)
 233 {
 234         if ($_SESSION['user_id'] > 0)
 235         {
 236                 include_once(TR_INCLUDE_PATH.'classes/DAO/UserCoursesDAO.class.php');
 237                 $userCoursesDAO = new UserCoursesDAO();
 238                 $user_courses_row = $userCoursesDAO->get($_SESSION['user_id'], $_course_id);
 239
 240                 if ($user_courses_row && $user_courses_row['last_cid'] > 0)
 241                         $_SESSION['s_cid'] = $user_courses_row['last_cid'];
 242                 else if ($_content_id > 0)
 243                         $_SESSION['s_cid'] = $_content_id;
 244                 else // first time accessing this course, no last cid yet
 245                         unset($_SESSION['s_cid']);
 246         }
 247         else // guest
 248         {
 249                 $_SESSION['s_cid'] = $_content_id;
 250         }
 251 }
 252
 253 // Generate contentManager.
 254 // Must be called after generating $_SESSION['s_cid'] as it's used in contentManager class
 255 if ($_course_id > 0)
 256 {
 257         global $contentManager;
 258
 259         include_once(TR_INCLUDE_PATH. '../home/classes/ContentManager.class.php');
 260
 261         $contentManager = new ContentManager($_course_id);
 262         $_sequence_links = $contentManager->generateSequenceCrumbs($_content_id);
 263 }
 264
 265 /*** 10. register pages based on user's priviledge ***/
 266 require_once(TR_INCLUDE_PATH.'page_constants.inc.php');
 267
 268 /**
 269  * This function is used for printing variables for debugging.
 270  * @access  public
 271  * @param   mixed $var  The variable to output
 272  * @param   string $title       The name of the variable, or some mark-up identifier.
 273  * @author  Joel Kronenberg
 274  */
 275 function debug($var, $title='') {
 276         if (!defined('TR_DEVEL') || !TR_DEVEL) {
 277                 return;
 278         }
 279
 280         echo '<pre style="border: 1px black solid; padding: 0px; margin: 10px;" title="debugging box">';
 281         if ($title) {
 282                 echo '<h4>'.$title.'</h4>';
 283         }
 284
 285         ob_start();
 286         print_r($var);
 287         $str = ob_get_contents();
 288         ob_end_clean();
 289
 290         $str = str_replace('<', '&lt;', $str);
 291
 292         $str = str_replace('[', '<span style="color: red; font-weight: bold;">[', $str);
 293         $str = str_replace(']', ']</span>', $str);
 294         $str = str_replace('=>', '<span style="color: blue; font-weight: bold;">=></span>', $str);
 295         $str = str_replace('Array', '<span style="color: purple; font-weight: bold;">Array</span>', $str);
 296         echo $str;
 297         echo '</pre>';
 298 }
 299
 300 /**
 301 * This function is used for printing variables into log file for debugging.
 302 * @access  public
 303 * @param   mixed $var   The variable to output
 304 * @param   string $log  The location of the log file. If not provided, use the default one.
 305 * @author  Cindy Qi Li
 306 */
 307 function debug_to_log($var, $log='') {
 308         if (!defined('TR_DEVEL') || !TR_DEVEL) {
 309                 return;
 310         }
 311
 312         if ($log == '') $log = TR_CONTENT_DIR. 'debug.log';
 313         $handle = fopen($log, 'a');
 314         fwrite($handle, "\n\n");
 315         fwrite($handle, date("F j, Y, g:i a"));
 316         fwrite($handle, "\n");
 317         fwrite($handle, var_export($var,1));
 318
 319         fclose($handle);
 320 }
 321
 322 /****************************************************/
 323 /* compute the $_my_uri variable                                        */
 324         $bits     = explode(SEP, getenv('QUERY_STRING'));
 325         $num_bits = count($bits);
 326         $_my_uri  = '';
 327
 328         for ($i=0; $i<$num_bits; $i++) {
 329 //              if (    (strpos($bits[$i], 'enable=')   === 0)
 330 //                      ||      (strpos($bits[$i], 'disable=')  === 0)
 331 //                      ||      (strpos($bits[$i], 'expand=')   === 0)
 332 //                      ||      (strpos($bits[$i], 'collapse=') === 0)
 333 //                      ||      (strpos($bits[$i], 'lang=')             === 0)
 334 //                      ) {
 335                 if (    (strpos($bits[$i], 'lang=')             === 0)
 336                         ) {
 337                         /* we don't want this variable added to $_my_uri */
 338                         continue;
 339                 }
 340
 341                 if (($_my_uri == '') && ($bits[$i] != '')) {
 342                         $_my_uri .= '?';
 343                 } else if ($bits[$i] != ''){
 344                         $_my_uri .= SEP;
 345                 }
 346                 $_my_uri .= $bits[$i];
 347         }
 348         if ($_my_uri == '') {
 349                 $_my_uri .= '?';
 350         } else {
 351                 $_my_uri .= SEP;
 352         }
 353         $_my_uri = $_SERVER['PHP_SELF'].$_my_uri;
 354
 355 function my_add_null_slashes( $string ) {
 356 //    return mysql_real_escape_string(stripslashes($string));
 357     return addslashes(stripslashes($string));
 358 }
 359
 360 function my_null_slashes($string) {
 361         return $string;
 362 }
 363
 364 if ( get_magic_quotes_gpc() == 1 ) {
 365         $addslashes   = 'my_add_null_slashes';
 366         $stripslashes = 'stripslashes';
 367 } else {
 368         $addslashes   = 'mysql_real_escape_string';
 369         $stripslashes = 'my_null_slashes';
 370 }
 371
 372 /**
 373  * If MBString extension is loaded, then use it.
 374  * Otherwise we will have to use include/utf8 library
 375  */
 376  if (extension_loaded('mbstring')){
 377          $strtolower = 'mb_strtolower';
 378          $strtoupper = 'mb_strtoupper';
 379          $substr = 'mb_substr';
 380          $strpos = 'mb_strpos';
 381          $strrpos = 'mb_strrpos';
 382          $strlen = 'mb_strlen';
 383  } else {
 384          $strtolower = 'utf8_strtolower';
 385          $strtoupper = 'utf8_strtoupper';
 386          $substr = 'utf8_substr';
 387          $strpos = 'utf8_strpos';
 388          $strrpos = 'utf8_strrpos';
 389          $strlen = 'utf8_strlen';
 390  }
 391
 392 function get_default_theme() {
 393         $themesDAO = new ThemesDAO();
 394
 395         $rows = $themesDAO->getDefaultTheme();
 396
 397         if (!is_dir(TR_INCLUDE_PATH . '../themes/' . $rows[0]['dir_name']))
 398                 return 'default';
 399         else
 400                 return $rows[0]['dir_name'];
 401 }
 402
 403 /**
 404  * Convert all '&' to '&amp;' from the input
 405  * @param   string  any string input, mainly URLs.
 406  * @return  input with & replaced to '&amp;'
 407  * @author  Harris Wong
 408  * @date    Oct 7, 2010
 409  */
 410 function convertAmp($input){
 411     $input = str_replace('&amp;', '&', $input); //convert everything to '&' first
 412     return str_replace('&', '&amp;', $input);
 413 }
 414
 415 ?>