docs/include/lib/constants.inc.php

   1 <?php
   2 /************************************************************************/
   3 /* ATutor                                                                                                                               */
   4 /************************************************************************/
   5 /* Copyright (c) 2002-2006 by Greg Gay, Joel Kronenberg & Heidi Hazelton*/
   6 /* Adaptive Technology Resource Centre / University of Toronto                  */
   7 /* http://atutor.ca                                                                                                             */
   8 /*                                                                                                                                              */
   9 /* This program is free software. You can redistribute it and/or                */
  10 /* modify it under the terms of the GNU General Public License                  */
  11 /* as published by the Free Software Foundation.                                                */
  12 /************************************************************************/
  13 // $Id$
  14
  15 if (!defined('AT_INCLUDE_PATH')) { exit; }
  16
  17 /***************
  18  * constants
  19  ******/
  20
  21 /* config variables. if they're not in the db then it uses the installation default values: */
  22 $_config_defaults = array();
  23 $_config_defaults['contact_email']             = '';
  24 $_config_defaults['email_notification']        = 1;
  25 $_config_defaults['allow_instructor_requests'] = 1;
  26 $_config_defaults['auto_approve_instructors']  = 0;
  27 $_config_defaults['max_file_size']             = 1048576;  // 1MB
  28 $_config_defaults['max_course_size']           = 10485760; // 10 MB
  29 $_config_defaults['max_course_float']          = 2097152;  // 2MB
  30 $_config_defaults['illegal_extentions']        = 'exe|asp|php|php3|bat|cgi|pl|com|vbs|reg|pcd|pif|scr|bas|inf|vb|vbe|wsc|wsf|wsh';
  31 $_config_defaults['site_name']                 = '';
  32 $_config_defaults['home_url']                  = '';
  33 $_config_defaults['default_language']          = 'en';
  34 $_config_defaults['cache_dir']                 = '';
  35 $_config_defaults['enable_category_themes']    = 0;
  36 $_config_defaults['course_backups']            = 5;
  37 $_config_defaults['email_confirmation']        = 0;
  38 $_config_defaults['master_list']               = 0;
  39 $_config_defaults['user_notes']                = 0; // whether to enable the user contributed handbook notes
  40 $_config_defaults['theme_categories']          = 0;
  41 $_config_defaults['main_defaults']                 = 'forum/list.php|glossary/index.php|file_storage/index.php';
  42 $_config_defaults['home_defaults']             = 'forum/list.php|file_storage/index.php|glossary/index.php|chat/index.php|tile.php|faq/index.php|links/index.php|tools/my_tests.php|sitemap.php|export.php|my_stats.php|polls/index.php|directory.php|groups.php|reading_list/index.php|blogs/index.php';
  43 $_config_defaults['side_defaults']             = 'menu_menu|related_topics|users_online|glossary|search|poll|posts';
  44 $_config_defaults['pref_defaults']                         = 'a:4:{s:10:"PREF_THEME";s:7:"default";s:14:"PREF_NUMBERING";i:1;s:18:"PREF_JUMP_REDIRECT";i:1;s:15:"PREF_FORM_FOCUS";i:1;}';
  45 $_config_defaults['pref_inbox_notify']             = 0;
  46 $_config_defaults['check_version']                 = 0;
  47 $_config_defaults['fs_versioning']             = 1;
  48 $_config_defaults['display_full_name']         = 1; // not currently a config option
  49 $_config_defaults['last_cron']                 = 0; // cron has to be enabled manually
  50 $_config_defaults['enable_mail_queue']         = 0; // mail queue can only be enabled if cron is running
  51
  52 $_config = $_config_defaults;
  53
  54 /* links */
  55 define('LINK_CAT_COURSE',       1);
  56 define('LINK_CAT_GROUP',        2);
  57 define('LINK_CAT_SELF',         3);
  58
  59 define('LINK_CAT_AUTH_NONE',    0);
  60 define('LINK_CAT_AUTH_ALL',             1);
  61 define('LINK_CAT_AUTH_COURSE',  2);
  62 define('LINK_CAT_AUTH_GROUP',   3);
  63
  64 /* drafting room constants */
  65 define('WORKSPACE_COURSE',     1);
  66 define('WORKSPACE_PERSONAL',   2);
  67 define('WORKSPACE_ASSIGNMENT', 3);
  68 define('WORKSPACE_GROUP',      4);
  69 define('WORKSPACE_PATH_DEPTH', 1); // how deep the directories should be
  70 define('WORKSPACE_FILE_PATH',  AT_CONTENT_DIR . 'file_storage/');
  71
  72 /* how many related topics can be listed */
  73 define('NUM_RELATED_TOPICS', 5);
  74
  75 /* how many days until the password reminder link expires */
  76 define('AT_PASSWORD_REMINDER_EXPIRY', 2);
  77
  78 /* taking a test an unlimited # of times */
  79 define('AT_TESTS_TAKE_UNLIMITED', 0);
  80
  81 /* how many announcements listed */
  82 define('NUM_ANNOUNCEMENTS', 10);
  83
  84 /* how long cache objects can persist   */
  85 /* in seconds. should be low initially, but doesn't really matter. */
  86 /* in practice should be 0 (ie. INF)    */
  87 define('CACHE_TIME_OUT',        60);
  88
  89 /* member status field options */
  90 define('AT_STATUS_DISABLED',    0);
  91 define('AT_STATUS_UNCONFIRMED', 1);
  92 define('AT_STATUS_STUDENT',     2);
  93 define('AT_STATUS_INSTRUCTOR',  3);
  94
  95 /* $_pages sections */
  96 define('AT_NAV_PUBLIC', 'AT_NAV_PUBLIC');
  97 define('AT_NAV_START',  'AT_NAV_START');
  98 define('AT_NAV_COURSE', 'AT_NAV_COURSE');
  99 define('AT_NAV_HOME',   'AT_NAV_HOME');
 100 define('AT_NAV_ADMIN',  'AT_NAV_ADMIN');
 101
 102 /* user permissions */
 103
 104 /* $_privs[priv number] = array(String name, Boolean pen, Boolean tools) */
 105 define('AT_PRIV_RETURN',                true);
 106 define('AT_PRIV_NONE',                  0);
 107
 108 define('AT_PRIV_ADMIN',                 1);
 109
 110 /* admin privs: */
 111 define('AT_ADMIN_PRIV_NONE',        0);
 112 define('AT_ADMIN_PRIV_ADMIN',       1);
 113
 114 /* admin log (type of operations) */
 115 define('AT_ADMIN_LOG_UPDATE',  1);
 116 define('AT_ADMIN_LOG_DELETE',  2);
 117 define('AT_ADMIN_LOG_INSERT',  3);
 118 define('AT_ADMIN_LOG_REPLACE', 4);
 119 define('AT_ADMIN_LOG_OTHER',   5); //for non-db operations
 120
 121 if (strpos(@ini_get('arg_separator.input'), ';') !== false) {
 122         define('SEP', ';');
 123 } else {
 124         define('SEP', '&');
 125 }
 126
 127 /* the URL to the AChecker server of choice. must include trailing slash. */
 128 define('AT_ACHECKER_URL', 'http://checker.atrc.utoronto.ca/servlet/');
 129
 130 if (!isset($_SERVER['REQUEST_URI'])) {
 131         $REQUEST_URI = $_SERVER['SCRIPT_NAME'];
 132         if ($_SERVER['QUERY_STRING'] != '') {
 133                 $REQUEST_URI .= '?'.$_SERVER['QUERY_STRING'];
 134         }
 135         $_SERVER['REQUEST_URI'] = $REQUEST_URI;
 136 }
 137
 138 /* get the base url     */
 139 if (isset($_SERVER['HTTPS']) && (strtolower($_SERVER['HTTPS']) == 'on')) {
 140         $server_protocol = 'https://';
 141 } else {
 142         $server_protocol = 'http://';
 143 }
 144
 145 $dir_deep        = substr_count(AT_INCLUDE_PATH, '..');
 146 $url_parts       = explode('/', $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF']);
 147 $_base_href      = array_slice($url_parts, 0, count($url_parts) - $dir_deep-1);
 148 $_base_href      = $server_protocol . implode('/', $_base_href).'/';
 149 $_base_path  = substr($_base_href, strlen($server_protocol . $_SERVER['HTTP_HOST']));
 150
 151 /* relative uri */
 152 $_rel_url = '/'.implode('/', array_slice($url_parts, count($url_parts) - $dir_deep-1));
 153
 154 /* where the gudes are (could be a full URL if needed): */
 155 define('AT_GUIDES_PATH', $_base_path . 'documentation/');
 156
 157 define('AT_BACKUP_DIR', AT_CONTENT_DIR . 'backups/'); // where the backups get stored
 158
 159 define('VERSION',               '1.5.3');
 160 define('ONLINE_UPDATE', 3); /* update the user expiry every 3 min */
 161
 162 /* valid date format_types:                                             */
 163 /* @see ./include/lib/date_functions.inc.php    */
 164 define('AT_DATE_MYSQL_DATETIME',                1); /* YYYY-MM-DD HH:MM:SS      */
 165 define('AT_DATE_MYSQL_TIMESTAMP_14',    2); /* YYYYMMDDHHMMSS           */
 166 define('AT_DATE_UNIX_TIMESTAMP',                3); /* seconds since epoch      */
 167 define('AT_DATE_INDEX_VALUE',                   4); /* index to the date arrays */
 168
 169 define('AT_ROLE_STUDENT',                               0);
 170 define('AT_ROLE_INSTRUCTOR',                    1);
 171
 172 define('AT_KBYTE_SIZE',                  1024);
 173
 174 define('AT_COURSESIZE_UNLIMITED',          -1);
 175 define('AT_COURSESIZE_DEFAULT',            -2);  /* can be changed in config.inc.php */
 176 define('AT_FILESIZE_DEFAULT',              -3);  /* this too */
 177 define('AT_FILESIZE_SYSTEM_MAX',           -4);
 178 $editable_file_types = array('txt', 'html', 'htm', 'xml', 'css', 'asc', 'csv', 'sql');
 179
 180 /* how many poll choices are available: */
 181 define('AT_NUM_POLL_CHOICES',   7);
 182
 183 /* ways of releasing a test */
 184 define('AT_RELEASE_NEVER',                 0); // do not release
 185 define('AT_RELEASE_IMMEDIATE',     1); // release after submitted
 186 define('AT_RELEASE_MARKED',                2); // release after all q's marked
 187
 188 /* types of test questions */
 189 define('AT_TESTS_MC',                           1); // multiple choice
 190 define('AT_TESTS_TF',                           2); // true/false
 191 define('AT_TESTS_LONG',                         3); // long answer
 192 define('AT_TESTS_LIKERT',                       4); // likert
 193
 194 /* QPROP = question property: */
 195 define('AT_TESTS_QPROP_WORD',       1);
 196 define('AT_TESTS_QPROP_SENTENCE',   2);
 197 define('AT_TESTS_QPROP_PARAGRAPH',  3);
 198 define('AT_TESTS_QPROP_PAGE',       4);
 199 define('AT_TESTS_QPROP_ALIGN_VERT',     5); // align question options vertically
 200 define('AT_TESTS_QPROP_ALIGN_HORT',     6); // align question options horizontally
 201
 202 /* enrollment types for $_SESSION['enroll'] */
 203 define('AT_ENROLL_NO',                  0);
 204 define('AT_ENROLL_YES',                 1);
 205 define('AT_ENROLL_ALUMNUS',             2);
 206
 207 // constants for reading list module
 208 define ('RL_TYPE_BOOK', 1);
 209 define ('RL_TYPE_URL',  2);
 210 define ('RL_TYPE_HANDOUT', 3);
 211 define ('RL_TYPE_AV', 4);
 212 define ('RL_TYPE_FILE', 5);
 213
 214 $_rl_types = array ();
 215 $_rl_types[RL_TYPE_BOOK]        = 'rl_book';
 216 $_rl_types[RL_TYPE_URL]         = 'rl_url';
 217 $_rl_types[RL_TYPE_HANDOUT]     = 'rl_handout';
 218 $_rl_types[RL_TYPE_AV]          = 'rl_av';
 219 $_rl_types[RL_TYPE_FILE]        = 'rl_file';
 220
 221 /* control how user inputs get formatted on output: */
 222 /* note: v131 not all formatting options are available on each section. */
 223
 224 define('AT_FORMAT_NONE',              0); /* LEQ to ~AT_FORMAT_ALL */
 225 define('AT_FORMAT_EMOTICONS',     1);
 226 define('AT_FORMAT_LINKS',         2);
 227 define('AT_FORMAT_IMAGES',        4);
 228 define('AT_FORMAT_HTML',          8);
 229 define('AT_FORMAT_GLOSSARY',     16);
 230 define('AT_FORMAT_ATCODES',      32);
 231 define('AT_FORMAT_CONTENT_DIR', 64); /* remove CONTENT_DIR */
 232 define('AT_FORMAT_QUOTES',      128); /* remove double quotes (does this get used?) */
 233 define('AT_FORMAT_ALL',       AT_FORMAT_EMOTICONS
 234                                                            + AT_FORMAT_LINKS
 235                                                        + AT_FORMAT_IMAGES
 236                                                        + AT_FORMAT_HTML
 237                                                        + AT_FORMAT_GLOSSARY
 238                                                            + AT_FORMAT_ATCODES
 239                                                            + AT_FORMAT_CONTENT_DIR);
 240
 241 $_field_formatting = array();
 242
 243 $_field_formatting['content.keywords']                  = AT_FORMAT_NONE;
 244 $_field_formatting['content.title']                             = AT_FORMAT_ALL & ~AT_FORMAT_HTML | AT_FORMAT_QUOTES;
 245 $_field_formatting['content.text']                              = AT_FORMAT_ALL;
 246
 247 $_field_formatting['course_cats.cat_name']              = AT_FORMAT_NONE;
 248
 249 $_field_formatting['courses.*']                             = AT_FORMAT_ALL & ~AT_FORMAT_EMOTICONS & ~AT_FORMAT_ATCODES & ~AT_FORMAT_LINKS & ~AT_FORMAT_IMAGES;
 250
 251 $_field_formatting['forums.title']                              = AT_FORMAT_NONE;
 252 $_field_formatting['forums.description']                = AT_FORMAT_ALL;
 253
 254 $_field_formatting['forums_threads.subject']    = AT_FORMAT_ALL & ~AT_FORMAT_HTML;
 255 $_field_formatting['forums_threads.body']               = AT_FORMAT_ALL & ~AT_FORMAT_HTML;
 256
 257 $_field_formatting['glossary.word']                             = AT_FORMAT_NONE;
 258 $_field_formatting['glossary.definition']               = AT_FORMAT_ALL & ~AT_FORMAT_HTML;
 259
 260 $_field_formatting['instructor_approvals.notes']= AT_FORMAT_NONE;
 261
 262 $_field_formatting['members.*']                 = AT_FORMAT_NONE; /* wildcards are okay */
 263
 264 $_field_formatting['messages.subject']                  = AT_FORMAT_EMOTICONS + AT_FORMAT_LINKS + AT_FORMAT_IMAGES;
 265 $_field_formatting['messages.body']                             = AT_FORMAT_EMOTICONS + AT_FORMAT_LINKS + AT_FORMAT_IMAGES + AT_FORMAT_ATCODES;
 266
 267 $_field_formatting['news.title']                                = AT_FORMAT_EMOTICONS | AT_FORMAT_LINKS & ~AT_FORMAT_HTML;
 268 $_field_formatting['news.body']                                 = AT_FORMAT_ALL;
 269
 270 $_field_formatting['resource_categories.CatName']= AT_FORMAT_NONE;
 271 $_field_formatting['resource_categories.Url']   = AT_FORMAT_NONE;
 272 $_field_formatting['resource_links.LinkName']   = AT_FORMAT_NONE;
 273 $_field_formatting['resource_links.Description']= AT_FORMAT_NONE;
 274 $_field_formatting['resource_links.SubmitName']= AT_FORMAT_NONE;
 275
 276 $_field_formatting['tests.title']                               = AT_FORMAT_ALL;
 277 $_field_formatting['tests.instructions']                = AT_FORMAT_ALL;
 278
 279 $_field_formatting['themes.title']                              = AT_FORMAT_NONE;
 280
 281 $_field_formatting['tests_answers.answer']              = AT_FORMAT_NONE;
 282 $_field_formatting['tests_answers.notes']               = AT_FORMAT_ALL;
 283 $_field_formatting['tests_questions.*']                 = AT_FORMAT_ALL;
 284
 285 $_field_formatting['tests_questions_categories.title']  = AT_FORMAT_NONE;
 286
 287 $_field_formatting['polls.*']            = AT_FORMAT_ALL;
 288
 289 $_field_formatting['blog_posts.body']        = AT_FORMAT_ALL & ~AT_FORMAT_HTML;
 290 $_field_formatting['blog_posts.title']       = AT_FORMAT_NONE;
 291
 292 $_field_formatting['blog_posts_comments.comment'] = AT_FORMAT_ALL & ~AT_FORMAT_HTML;
 293
 294 $_field_formatting['courses.banner'] = AT_FORMAT_ALL;
 295
 296 if (isset($_GET['cid'])) {
 297         $cid = intval($_GET['cid']);
 298 } else if (isset($_POST['cid'])) {
 299         $cid = intval($_POST['cid']);
 300 }
 301
 302
 303 ?>