[system] / trunk / webwork2 / conf / global.conf.dist Repository:
ViewVC logotype

View of /trunk/webwork2/conf/global.conf.dist

Parent Directory Parent Directory | Revision Log Revision Log


Revision 5721 - (download) (annotate)
Mon Jun 23 19:56:08 2008 UTC (4 years, 10 months ago) by glarose
File size: 38456 byte(s)
global.conf.dist: add permission levels to create and record data
for new set versions.

    1 #!perl
    2 ################################################################################
    3 # WeBWorK Online Homework Delivery System
    4 # Copyright © 2000-2007 The WeBWorK Project, http://openwebwork.sf.net/
    5 # $CVSHeader: webwork2/conf/global.conf.dist,v 1.205 2008/03/13 22:22:23 sh002i Exp $
    6 #
    7 # This program is free software; you can redistribute it and/or modify it under
    8 # the terms of either: (a) the GNU General Public License as published by the
    9 # Free Software Foundation; either version 2, or (at your option) any later
   10 # version, or (b) the "Artistic License" which comes with this package.
   11 #
   12 # This program is distributed in the hope that it will be useful, but WITHOUT
   13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   14 # FOR A PARTICULAR PURPOSE.  See either the GNU General Public License or the
   15 # Artistic License for more details.
   16 ################################################################################
   17 
   18 # This file is used to set up the default WeBWorK course environment for all
   19 # requests. Values may be overwritten by the course.conf for a specific course.
   20 # All package variables set in this file are added to the course environment.
   21 # If you wish to set a variable here but omit it from the course environment,
   22 # use the "my" keyword. The $webwork_dir variable is set in the WeBWorK Apache
   23 # configuration file (webwork.apache-config) and is available for use here. In
   24 # addition, the $courseName variable holds the name of the current course.
   25 
   26 ################################################################################
   27 # Seed variables
   28 ################################################################################
   29 
   30 # Set these variables to correspond to your configuration and preferences. You
   31 # will need to restart the webserver to reset the variables in this section.
   32 
   33 # URL of WeBWorK handler. If WeBWorK is to be on the web server root, use "".
   34 $webwork_url         = "/webwork2";
   35 
   36 # Root directory of PG.
   37 $pg_dir              = "/opt/webwork/pg";
   38 
   39 # URL and path to htdocs directory.
   40 $webwork_htdocs_url  = "/webwork2_files";
   41 $webwork_htdocs_dir  = "$webwork_dir/htdocs";
   42 
   43 # URL and path to courses directory.
   44 $webwork_courses_url = "/webwork2_course_files";
   45 #$webwork_courses_dir = "/opt/webwork/courses";
   46 
   47 ################################################################################
   48 # Paths to external programs
   49 ################################################################################
   50 
   51 # system utilties
   52 $externalPrograms{mv}    = "/bin/mv";
   53 $externalPrograms{cp}    = "/bin/cp";
   54 $externalPrograms{rm}    = "/bin/rm";
   55 $externalPrograms{mkdir} = "/bin/mkdir";
   56 $externalPrograms{tar}   = "/bin/tar";
   57 $externalPrograms{gzip}  = "/bin/gzip";
   58 
   59 # equation rendering/hardcopy utiltiies
   60 $externalPrograms{latex}    = "/usr/bin/latex";
   61 $externalPrograms{pdflatex} = "/usr/bin/pdflatex --shell-escape";
   62 $externalPrograms{dvipng}   = "/usr/bin/dvipng";
   63 $externalPrograms{tth}      = "/usr/bin/tth";
   64 
   65 # NetPBM - basic image manipulation utilities
   66 # Most sites only need to configure $netpbm_prefix.
   67 my $netpbm_prefix = "/usr/bin";
   68 $externalPrograms{giftopnm} = "$netpbm_prefix/giftopnm";
   69 $externalPrograms{ppmtopgm} = "$netpbm_prefix/ppmtopgm";
   70 $externalPrograms{pnmtops}  = "$netpbm_prefix/pnmtops";
   71 $externalPrograms{pnmtopng} = "$netpbm_prefix/pnmtopng";
   72 $externalPrograms{pngtopnm} = "$netpbm_prefix/pngtopnm";
   73 
   74 # url checker
   75 $externalPrograms{checkurl} = "/usr/local/bin/lwp-request -mHEAD "; # or "/usr/local/bin/w3c -head "
   76 
   77 # image conversions utiltiies
   78 # the source file is given on stdin, and the output expected on stdout.
   79 $externalPrograms{gif2eps} = "$externalPrograms{giftopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
   80 $externalPrograms{png2eps} = "$externalPrograms{pngtopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
   81 $externalPrograms{gif2png} = "$externalPrograms{giftopnm} | $externalPrograms{pnmtopng}";
   82 
   83 # mysql clients
   84 $externalPrograms{mysql}     = "/usr/bin/mysql";
   85 $externalPrograms{mysqldump} = "/usr/bin/mysqldump";
   86 
   87 ################################################################################
   88 # Mail settings
   89 ################################################################################
   90 
   91 # Mail sent by the PG system and the mail merge and feedback modules will be
   92 # sent via this SMTP server.
   93 $mail{smtpServer}            = 'mail.yourschool.edu';
   94 
   95 # When connecting to the above server, WeBWorK will send this address in the
   96 # MAIL FROM command. This has nothing to do with the "From" address on the mail
   97 # message. It can really be anything, but some mail servers require it contain
   98 # a valid mail domain, or at least be well-formed.
   99 $mail{smtpSender}            = 'webwork@yourserver.yourschool.edu';
  100 
  101 # Seconds to wait before timing out when connecting to the SMTP server.
  102 $mail{smtpTimeout}           = 30;
  103 
  104 # AllowedRecipients defines addresses that the PG system is allowed to send mail
  105 # to. this prevents subtle PG exploits. This should be set in course.conf to the
  106 # addresses of professors of each course. Sending mail from the PG system (i.e.
  107 # questionaires, essay questions) will fail if this is not set somewhere (either
  108 # here or in course.conf).
  109 $mail{allowedRecipients}     = [
  110   #'prof1@yourserver.yourdomain.edu',
  111   #'prof2@yourserver.yourdomain.edu',
  112 ];
  113 
  114 # By default, feeback is sent to all users who have permission to
  115 # receive_feedback. If this list is non-empty, feedback is also sent to the
  116 # addresses specified here.
  117 #
  118 # * If you want to disable feedback altogether, leave this empty and set
  119 #   submit_feeback => $nobody in %permissionLevels below. This will cause the
  120 #   feedback button to go away as well.
  121 #
  122 # * If you want to send email ONLY to addresses in this list, set
  123 #   receive_feedback => $nobody in %permissionLevels below.
  124 #
  125 # It's often useful to set this in the course.conf to change the behavior of
  126 # feedback for a specific course.
  127 #
  128 # Items in this list may be bare addresses, or RFC822 mailboxes, like:
  129 #   'Joe User <joe.user@example.com>'
  130 # The advantage of this form is that the resulting email will include the name
  131 # of the recipient in the "To" field of the email.
  132 #
  133 $mail{feedbackRecipients}    = [
  134   #'prof1@yourserver.yourdomain.edu',
  135   #'prof2@yourserver.yourdomain.edu',
  136 ];
  137 
  138 # Feedback subject line -- the following escape sequences are recognized:
  139 #
  140 #   %c = course ID
  141 #   %u = user ID
  142 #   %s = set ID
  143 #   %p = problem ID
  144 #   %x = section
  145 #   %r = recitation
  146 #   %% = literal percent sign
  147 #
  148 
  149 $mail{feedbackSubjectFormat} = "[WWfeedback] course:%c user:%u set:%s prob:%p sec:%x rec:%r";
  150 
  151 # feedbackVerbosity:
  152 #  0: send only the feedback comment and context link
  153 #  1: as in 0, plus user, set, problem, and PG data
  154 #  2: as in 1, plus the problem environment (debugging data)
  155 $mail{feedbackVerbosity}     = 1;
  156 
  157 # Defines the size of the Mail Merge editor window
  158 # FIXME: should this be here? it's UI, not mail
  159 # FIXME: replace this with the auto-size method that TWiki uses
  160 $mail{editor_window_rows}    = 15;
  161 $mail{editor_window_columns} = 100;
  162 
  163 # Use this to customize the text of the feedback button.
  164 $feedback_button_name = "Email instructor";
  165 
  166 # If this value is true, feedback will only be sent to users with the same
  167 # section as the user initiating the feedback.
  168 $feedback_by_section = 0;
  169 
  170 ################################################################################
  171 # Theme
  172 ################################################################################
  173 
  174 $defaultTheme = "math";
  175 $defaultThemeTemplate = "system";
  176 
  177 ################################################################################
  178 # System-wide locations (directories and URLs)
  179 ################################################################################
  180 
  181 # The root directory, set by webwork_root variable in Apache configuration.
  182 $webworkDirs{root}          = "$webwork_dir";
  183 
  184 # Location of system-wide data files.
  185 $webworkDirs{DATA}          = "$webworkDirs{root}/DATA";
  186 
  187 # Used for temporary storage of uploaded files.
  188 $webworkDirs{uploadCache}   = "$webworkDirs{DATA}/uploads";
  189 
  190 # Location of utility programs.
  191 $webworkDirs{bin}           = "$webworkDirs{root}/bin";
  192 
  193 # Location of configuration files, templates, snippets, etc.
  194 $webworkDirs{conf}          = "$webworkDirs{root}/conf";
  195 
  196 # Location of theme templates.
  197 $webworkDirs{templates}     = "$webworkDirs{conf}/templates";
  198 
  199 # Location of course directories.
  200 $webworkDirs{courses}       = "$webwork_courses_dir" || "$webworkDirs{root}/courses";
  201 
  202 # Contains log files.
  203 $webworkDirs{logs}          = "$webworkDirs{root}/logs";
  204 
  205 # Contains non-web-accessible temporary files, such as TeX working directories.
  206 $webworkDirs{tmp}           = "$webworkDirs{root}/tmp";
  207 
  208 # The (absolute) destinations of symbolic links that are OK for the FileManager to follow.
  209 #   (any subdirectory of these is a valid target for a symbolic link.)
  210 # For example:
  211 #    $webworkDirs{valid_symlinks} = ["$webworkDirs{courses}/modelCourse/templates","/ww2/common/sets"];
  212 $webworkDirs{valid_symlinks}   = [];
  213 
  214 ################################################################################
  215 ##### The following locations are web-accessible.
  216 ################################################################################
  217 
  218 # The root URL (usually /webwork2), set by <Location> in Apache configuration.
  219 $webworkURLs{root}          = "$webwork_url";
  220 
  221 # Location of system-wide web-accessible files, such as equation images, and
  222 # help files.
  223 $webworkDirs{htdocs}        = "$webwork_htdocs_dir" || "$webworkDirs{root}/htdocs";
  224 $webworkURLs{htdocs}        = "$webwork_htdocs_url";
  225 
  226 # Location of web-accessible temporary files, such as equation images.
  227 $webworkDirs{htdocs_temp}   = "$webworkDirs{htdocs}/tmp";
  228 $webworkURLs{htdocs_temp}   = "$webworkURLs{htdocs}/tmp";
  229 
  230 # Location of cached equation images.
  231 $webworkDirs{equationCache} = "$webworkDirs{htdocs_temp}/equations";
  232 $webworkURLs{equationCache} = "$webworkURLs{htdocs_temp}/equations";
  233 
  234 # Contains context-sensitive help files.
  235 $webworkDirs{local_help}    = "$webworkDirs{htdocs}/helpFiles";
  236 $webworkURLs{local_help}    = "$webworkURLs{htdocs}/helpFiles";
  237 
  238 # URL of general WeBWorK documentation.
  239 $webworkURLs{docs}          = "http://webwork.maa.org";
  240 
  241 # URL of WeBWorK Bugzilla database.
  242 $webworkURLs{bugReporter}   = "http://bugs.webwork.rochester.edu/";
  243 
  244 # Location of CSS
  245 $webworkURLs{stylesheet}    = "$webworkURLs{htdocs}/css/${defaultTheme}.css";
  246 
  247 # Location of jsMath script, used for the jsMath display mode.
  248 $webworkURLs{jsMath}        = "$webworkURLs{htdocs}/jsMath/jsMath-ww.js";
  249 
  250 # Location of ASCIIMathML script, used for the asciimath display mode.
  251 $webworkURLs{asciimath}     = "$webworkURLs{htdocs}/ASCIIMathML/ASCIIMathML.js";
  252 
  253 # Location of LaTeXMathML script, used for the LaTeXMathML display mode.
  254 $webworkURLs{LaTeXMathML}   = "$webworkURLs{htdocs}/LaTeXMathML/LaTeXMathML.js";
  255 
  256 ################################################################################
  257 # Defaults for course-specific locations (directories and URLs)
  258 ################################################################################
  259 
  260 # The root directory of the current course. (The ID of the current course is
  261 # available in $courseName.)
  262 $courseDirs{root}        = "$webworkDirs{courses}/$courseName";
  263 
  264 # Location of course-specific data files.
  265 $courseDirs{DATA}        = "$courseDirs{root}/DATA";
  266 
  267 # Location of course HTML files, passed to PG.
  268 $courseDirs{html}        = "$courseDirs{root}/html";
  269 $courseURLs{html}        = "$webwork_courses_url/$courseName";
  270 
  271 # Location of course image files, passed to PG.
  272 $courseDirs{html_images} = "$courseDirs{html}/images";
  273 
  274 # Location of web-accessible, course-specific temporary files, like static and
  275 # dynamically-generated PG graphics.
  276 $courseDirs{html_temp}   = "$courseDirs{html}/tmp";
  277 $courseURLs{html_temp}   = "$courseURLs{html}/tmp";
  278 
  279 # Location of course-specific logs, like the transaction log.
  280 $courseDirs{logs}        = "$courseDirs{root}/logs";
  281 
  282 # Location of scoring files.
  283 $courseDirs{scoring}     = "$courseDirs{root}/scoring";
  284 
  285 # Location of PG templates and set definition files.
  286 $courseDirs{templates}   = "$courseDirs{root}/templates";
  287 
  288 # Location of course-specific macro files.
  289 $courseDirs{macros}      = "$courseDirs{templates}/macros";
  290 
  291 # Location of mail-merge templates.
  292 $courseDirs{email}       = "$courseDirs{templates}/email";
  293 
  294 # Location of temporary editing files.
  295 $courseDirs{tmpEditFileDir}  = "$courseDirs{templates}/tmpEdit";
  296 
  297 # If this is set to a non-empty value (i.e. in course.conf), WeBWorK's usual
  298 # email feedback mechanism  will be replaced with a link to the given URL.
  299 # See also $feedback_button_name, above.
  300 $courseURLs{feedbackURL} = "";
  301 
  302 # mail merge status directory
  303 $courseDirs{mailmerge}   = "$courseDirs{DATA}/mailmerge";
  304 
  305 ################################################################################
  306 # System-wide files
  307 ################################################################################
  308 
  309 # Location of this file.
  310 $webworkFiles{environment}                      = "$webworkDirs{conf}/global.conf";
  311 
  312 # Flat-file database used to protect against MD5 hash collisions. TeX equations
  313 # are hashed to determine the name of the image file. There is a tiny chance of
  314 # a collision between two TeX strings. This file allows for that. However, this
  315 # is slow, so most people chose not to worry about it. Set this to "" if you
  316 # don't want to use the equation cache file.
  317 $webworkFiles{equationCacheDB}                  = ""; # "$webworkDirs{DATA}/equationcache";
  318 
  319 ################################################################################
  320 # Hardcopy snippets are used in constructing a TeX file for hardcopy output.
  321 # They should contain TeX code unless otherwise noted.
  322 ################################################################################
  323 # The preamble is the first thing in the TeX file.
  324 $webworkFiles{hardcopySnippets}{preamble}       = "$webworkDirs{conf}/snippets/hardcopyPreamble.tex";
  325 
  326 # The setHeader preceeds each set. It is a PG file.
  327 $webworkFiles{hardcopySnippets}{setHeader}      = "$webworkDirs{conf}/snippets/setHeader.pg";  # hardcopySetHeader.pg",
  328 
  329 # The problem divider goes between problems.
  330 $webworkFiles{hardcopySnippets}{problemDivider} = "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex";
  331 
  332 # The set footer goes after each set. Is is a PG file.
  333 $webworkFiles{hardcopySnippets}{setFooter}      = "$webworkDirs{conf}/snippets/hardcopySetFooter.pg";
  334 
  335 # The set divider goes between sets (in multiset output).
  336 $webworkFiles{hardcopySnippets}{setDivider}     = "$webworkDirs{conf}/snippets/hardcopySetDivider.tex";
  337 
  338 # The user divider does between users (in multiuser output).
  339 $webworkFiles{hardcopySnippets}{userDivider}    = "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex";
  340 
  341 # The postabmle is the last thing in the TeX file.
  342 $webworkFiles{hardcopySnippets}{postamble}      = "$webworkDirs{conf}/snippets/hardcopyPostamble.tex";
  343 
  344 ##### Screen snippets are used when displaying problem sets on the screen.
  345 
  346 # The set header is displayed on the problem set page. It is a PG file.
  347 $webworkFiles{screenSnippets}{setHeader}        = "$webworkDirs{conf}/snippets/setHeader.pg"; # screenSetHeader.pg"
  348 
  349 # A PG template for creation of new problems.
  350 $webworkFiles{screenSnippets}{blankProblem}    = "$webworkDirs{conf}/snippets/blankProblem2.pg"; # screenSetHeader.pg"
  351 
  352 # A site info  "message of the day" file
  353 $webworkFiles{site_info}                       = "$webworkDirs{htdocs}/site_info.txt";
  354 
  355 ################################################################################
  356 # Course-specific files
  357 ################################################################################
  358 
  359 # The course configuration file.
  360 $courseFiles{environment} = "$courseDirs{root}/course.conf";
  361 
  362 # The course simple configuration file (holds web-based configuratoin).
  363 $courseFiles{simpleConfig} = "$courseDirs{root}/simple.conf";
  364 
  365 # File contents are displayed after login, on the problem sets page. Path given
  366 # here is relative to the templates directory.
  367 $courseFiles{course_info} = "course_info.txt";
  368 
  369 # File contents are displayed on the login page. Path given here is relative to
  370 # the templates directory.
  371 $courseFiles{login_info}  = "login_info.txt";
  372 
  373 # Additional library buttons can be added to the Library Browser (SetMaker.pm)
  374 # by adding the libraries you want to the following line.  For each key=>value
  375 # in the list, if a directory (or link to a directory) with name 'key' appears
  376 # in the templates directory, then a button with name 'value' will be placed at
  377 # the top of the problem browser.  (No button will appear if there is no
  378 # directory or link with the given name in the templates directory.)  For
  379 # example,
  380 #
  381 #     $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"};
  382 #
  383 # would add two buttons, one for the Rochester library and one for the ASU
  384 # library, provided templates/rochester and templates/asu exists either as
  385 # subdirectories or links to other directories.
  386 #
  387 $courseFiles{problibs}    = {
  388 #   rochesterLibrary => "Rochester",
  389 #   asuLibrary       => "Arizona State",
  390 #   dcdsLibrary      => "Detroit CDS",
  391 #   dartmouthLibrary => "Dartmouth",
  392 #   indianaLibrary   => "Indiana",
  393 #   osuLibrary       => "Ohio State",
  394 #   capaLibrary      => "CAPA",
  395 };
  396 
  397 ################################################################################
  398 # Status system
  399 ################################################################################
  400 
  401 # This is the default status given to new students and students with invalid
  402 # or missing statuses.
  403 $default_status = "Enrolled";
  404 
  405 # The first abbreviation in the abbreviations list is the canonical
  406 # abbreviation, and will be used when setting the status value in a user record
  407 # or an exported classlist file.
  408 #
  409 # Results are undefined if more than one status has the same abbreviation.
  410 #
  411 # The four behaviors that are controlled by status are:
  412 #   allow_course_access   => is this user allowed to log in?
  413 #   include_in_assignment => is this user included when assigning as set to "all" users?
  414 #   include_in_stats      => is this user included in statistical reports?
  415 #   include_in_email      => is this user included in emails sent to the class?
  416 #   include_in_scoring    => is this user included in score reports?
  417 
  418 %statuses = (
  419   Enrolled => {
  420     abbrevs => [qw/ C c current enrolled /],
  421     behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email include_in_scoring /],
  422   },
  423   Audit => {
  424     abbrevs => [qw/ A a audit /],
  425     behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email /],
  426   },
  427   Drop => {
  428     abbrevs => [qw/ D d drop withdraw /],
  429     behaviors => [qw/  /],
  430   },
  431   Proctor => {
  432     abbrevs => [qw/ P p proctor /],
  433     behaviors => [qw/  /],
  434   },
  435 );
  436 
  437 ################################################################################
  438 # Database options
  439 ################################################################################
  440 
  441 # these variables are used by database.conf. we define them here so that editing
  442 # database.conf isn't necessary.
  443 $database_dsn = "dbi:mysql:webwork";
  444 $database_username = "webworkWrite";
  445 $database_password = "";
  446 $database_debug = 0;
  447 
  448 # Variables for sql_moodle database layout.
  449 $moodle_dsn = "dbi:mysql:moodle";
  450 $moodle_username = $database_username;
  451 $moodle_password = $database_password;
  452 $moodle_table_prefix = "mdl_";
  453 $moodle17 = 0;
  454 
  455 # Several database are defined in the file conf/database.conf and stored in the
  456 # hash %dbLayouts.
  457 include "conf/database.conf";
  458 
  459 # Select the default database layout. This can be overridden in the course.conf
  460 # file of a particular course. The only database layout supported in WW 2.1.4
  461 # and up is "sql_single".
  462 $dbLayoutName = "sql_single";
  463 
  464 # This sets the symbol "dbLayout" as an alias for the selected database layout.
  465 *dbLayout     = $dbLayouts{$dbLayoutName};
  466 
  467 ################################################################################
  468 # Problem library options
  469 ################################################################################
  470 
  471 # For configuration instructions, see:
  472 # http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/DatabaseProblemLibrary
  473 
  474 # The directory containing the problem library files. Set to "" if no problem
  475 # library is installed.
  476 $problemLibrary{root}        = "";
  477 
  478 # Problem Library version
  479 # Version 1 is in use.  Version 2 will be released soon.
  480 $problemLibrary{version} = "2";
  481 
  482 # Problem Library SQL database connection information
  483 $problemLibrary_db = {
  484         dbsource => $database_dsn,
  485         user     => $database_username,
  486         passwd   => $database_password,
  487 };
  488 
  489 ################################################################################
  490 # Logs
  491 ################################################################################
  492 
  493 # FIXME: take logs out of %webworkFiles/%courseFiles and give them their own
  494 # top-level hash.
  495 
  496 # Logs data about how long it takes to process problems. (Do not confuse this
  497 # with the /other/ timing log which can be set by WeBWorK::Timing and is used
  498 # for benchmarking system performance in general. At some point, this timing
  499 # mechanism will be deprecated in favor of the WeBWorK::Timing mechanism.)
  500 $webworkFiles{logs}{timing}         = "$webworkDirs{logs}/timing.log";
  501 
  502 # Logs courses created via the web-based Course Administration module.
  503 $webworkFiles{logs}{hosted_courses} = "$webworkDirs{logs}/hosted_courses.log";
  504 
  505 # The transaction log contains data from each recorded answer submission. This
  506 # is useful if the database becomes corrupted.
  507 $webworkFiles{logs}{transaction}    = "$webworkDirs{logs}/${courseName}_transaction.log";
  508 
  509 # The answer log stores a history of all users' submitted answers.
  510 $courseFiles{logs}{answer_log}      = "$courseDirs{logs}/answer_log";
  511 
  512 # Log logins.
  513 $courseFiles{logs}{login_log}       = "$courseDirs{logs}/login.log";
  514 
  515 # Log for almost every click.  By default it is the empty string, which
  516 # turns this log off.  If you want it turned on, we suggest
  517 #                "$courseDirs{logs}/activity.log"
  518 # When turned on, this log can get quite large.
  519 $courseFiles{logs}{activity_log} = '';
  520 
  521 ################################################################################
  522 # Site defaults (FIXME: what other things could be "site defaults"?)
  523 ################################################################################
  524 
  525 # Set the default timezone of courses on this server. To get a list of valid
  526 # timezones, run:
  527 #
  528 #     perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names'
  529 #
  530 # To get a list of valid timezone "links" (deprecated names), run:
  531 #
  532 #     perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links'
  533 #
  534 # If left blank, the system timezone will be used. This is usually what you
  535 # want. You might want to set this if your server is NOT in the same timezone as
  536 # your school. If just a few courses are in a different timezone, set this in
  537 # course.conf for the affected courses instead.
  538 #
  539 $siteDefaults{timezone} = "";
  540 
  541 # The default_templates_course is used by default to create a new course.
  542 # The contents of the templates directory are copied from this course
  543 # to the new course being created.
  544 $siteDefaults{default_templates_course} ="modelCourse";
  545 
  546 ################################################################################
  547 # Authentication system
  548 ################################################################################
  549 
  550 # FIXME This mechanism is a little awkward and probably should be merged with
  551 # the dblayout selection system somehow.
  552 
  553 # Select the authentication module to use for normal logins.
  554 #
  555 # If this value is a string, the given authentication module will be used
  556 # regardless of the database layout. If it is a hash, the database layout name
  557 # will be looked up in the hash and the resulting value will be used as the
  558 # authentication module. The special hash key "*" is used if no entry for the
  559 # current database layout is found.
  560 #
  561 $authen{user_module} = {
  562   sql_moodle => "WeBWorK::Authen::Moodle",
  563   "*" => "WeBWorK::Authen",
  564 };
  565 
  566 # Select the authentication module to use for proctor logins.
  567 #
  568 # A string or a hash is accepted, as above.
  569 #
  570 $authen{proctor_module} = "WeBWorK::Authen::Proctor";
  571 
  572 # Options for particular authentication modules
  573 
  574 $authen{moodle_options} = {
  575   dsn => $moodle_dsn,
  576   username => $moodle_username,
  577   password => $moodle_password,
  578   table_prefix => $moodle_table_prefix,
  579   moodle17 => $moodle17,
  580 };
  581 
  582 $authen{ldap_options} = {
  583   # hosts to attempt to connect to, in order. for example:
  584   #   auth.myschool.edu             -- uses LDAP scheme and port 389
  585   #   ldap://auth.myschool.edu:666  -- non-standard port
  586   #   ldaps://auth.myschool.edu     -- uses LDAPS scheme and port 636
  587   #   ldaps://auth.myschool.edu:389 -- SSL on non-SSL port
  588   net_ldap_hosts => [
  589     "ldaps://corona-dmc.its.rochester.edu",
  590     "ldaps://corona-dmb.acs.rochester.edu",
  591   ],
  592   # connection options
  593   net_ldap_options => {
  594     timeout => 30,
  595     version => 3,
  596   },
  597   # base to use when searching for user's DN
  598   net_ldap_base => "ou=people,dc=rochester,dc=edu",
  599   # If LDAP rejects password, check it against the WeBWorK password database
  600   failover => 1,
  601 };
  602 
  603 ################################################################################
  604 # Authorization system
  605 ################################################################################
  606 
  607 # this section lets you define which groups of users can perform which actions.
  608 
  609 # this hash maps a numeric permission level to the name of a role. the number
  610 # assigned to a role is significant -- roles with higher numbers are considered
  611 # "more privileged", and are included when that role is listed for a privilege
  612 # below.
  613 #
  614 %userRoles = (
  615   guest => -5,
  616   student => 0,
  617   login_proctor => 2,
  618   grade_proctor => 3,
  619   ta => 5,
  620   professor => 10,
  621 );
  622 
  623 # this hash maps operations to the roles that are allowed to perform those
  624 # operations. the role listed and any role with a higher permission level (in
  625 # the %userRoles hash) will be allowed to perform the operation. If the role
  626 # is undefined, no users will be allowed to perform the operation.
  627 #
  628 %permissionLevels = (
  629   login                          => "guest",
  630   report_bugs                    => "student",
  631   submit_feedback                => "student",
  632   change_password                => "student",
  633   change_email_address           => "student",
  634 
  635   proctor_quiz_login             => "login_proctor",
  636   proctor_quiz_grade             => "grade_proctor",
  637   view_proctored_tests           => "student",
  638   view_hidden_work               => "ta",
  639 
  640   view_multiple_sets             => "ta",
  641   view_unopened_sets             => "ta",
  642   view_unpublished_sets          => "ta",
  643   view_answers                   => "ta",
  644   view_ip_restricted_sets        => "ta",
  645 
  646   become_student                 => "professor",
  647   access_instructor_tools        => "ta",
  648   score_sets                     => "professor",
  649   send_mail                      => "professor",
  650   receive_feedback               => "ta",
  651 
  652   create_and_delete_problem_sets => "professor",
  653   assign_problem_sets            => "professor",
  654   modify_problem_sets            => "professor",
  655   modify_student_data            => "professor",
  656   modify_classlist_files         => "professor",
  657   modify_set_def_files           => "professor",
  658   modify_scoring_files           => "professor",
  659   modify_problem_template_files  => "professor",
  660   manage_course_files            => "professor",
  661 
  662   create_and_delete_courses      => "professor",
  663   fix_course_databases           => "professor",
  664 
  665   ##### Behavior of the interactive problem processor #####
  666 
  667   show_correct_answers_before_answer_date         => "ta",
  668   show_solutions_before_answer_date               => "ta",
  669   avoid_recording_answers                         => "ta",
  670   # Below this level, old answers are never initially shown
  671   can_show_old_answers_by_default                 => "student",
  672   # at this level, we look at showOldAnswers for default value
  673   # even after the due date
  674   can_always_use_show_old_answers_default         => "professor",
  675   check_answers_before_open_date                  => "ta",
  676   check_answers_after_open_date_with_attempts     => "ta",
  677   check_answers_after_open_date_without_attempts  => "guest",
  678   check_answers_after_due_date                    => "guest",
  679   check_answers_after_answer_date                 => "guest",
  680   create_new_set_version_when_acting_as_student   => undef,
  681   record_set_version_answers_when_acting_as_student => undef,
  682   record_answers_when_acting_as_student           => undef,
  683   # "record_answers_when_acting_as_student" takes precedence
  684   # over the following for professors acting as students:
  685   record_answers_before_open_date                 => undef,
  686   record_answers_after_open_date_with_attempts    => "student",
  687   record_answers_after_open_date_without_attempts => undef,
  688   record_answers_after_due_date                   => undef,
  689   record_answers_after_answer_date                => undef,
  690   dont_log_past_answers                           => "professor",
  691   # does the user get to see a dump of the problem?
  692   view_problem_debugging_info                     => "ta",
  693 
  694   ##### Behavior of the Hardcopy Processor #####
  695 
  696   download_hardcopy_multiuser  => "ta",
  697   download_hardcopy_multiset   => "ta",
  698   download_hardcopy_format_pdf => "guest",
  699   download_hardcopy_format_tex => "ta",
  700 );
  701 
  702 # This is the default permission level given to new students and students with
  703 # invalid or missing permission levels.
  704 $default_permission_level = $userRoles{student};
  705 
  706 ################################################################################
  707 # Session options
  708 ################################################################################
  709 
  710 # $sessionKeyTimeout defines seconds of inactivity before a key expires
  711 $sessionKeyTimeout = 60*30;
  712 
  713 # $sessionKeyLength defines the length (in characters) of the session key
  714 $sessionKeyLength = 32;
  715 
  716 # @sessionKeyChars lists the legal session key characters
  717 @sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9');
  718 
  719 # Practice users are users who's names start with $practiceUser
  720 # (you can comment this out to remove practice user support)
  721 $practiceUserPrefix = "practice";
  722 
  723 # There is a practice user who can be logged in multiple times.  He's
  724 # commented out by default, though, so you don't hurt yourself.  It is
  725 # kindof a backdoor to the practice user system, since he doesn't have a
  726 # password.  Come to think of it, why do we even have this?!
  727 #$debugPracticeUser = "practice666";
  728 
  729 # Option for gateway tests; $gatewayGracePeriod is the time in seconds
  730 # after the official due date during which we'll still grade the test
  731 $gatewayGracePeriod = 120;
  732 
  733 ################################################################################
  734 # PG subsystem options
  735 ################################################################################
  736 
  737 # List of enabled display modes. Comment out any modes you don't wish to make
  738 # available for use.
  739 $pg{displayModes} = [
  740   "plainText",     # display raw TeX for math expressions
  741   "formattedText", # format math expressions using TtH
  742   "images",        # display math expressions as images generated by dvipng
  743   "jsMath",        # render TeX math expressions on the client side using jsMath
  744   "asciimath",     # render TeX math expressions on the client side using ASCIIMathML
  745   "LaTeXMathML",   # render TeX math expressions on the client side using LaTeXMathML
  746 ];
  747 
  748 #### Default settings for the PG translator
  749 
  750 # Default display mode. Should be listed above.
  751 $pg{options}{displayMode}        = "images";
  752 
  753 # The default grader to use, if a problem doesn't specify.
  754 $pg{options}{grader}             = "avg_problem_grader";
  755 
  756 # Fill in answer blanks with the student's last answer by default?
  757 $pg{options}{showOldAnswers}     = 1;
  758 
  759 # Show correct answers (when allowed) by default?
  760 $pg{options}{showCorrectAnswers} = 0;
  761 
  762 # Show hints (when allowed) by default?
  763 $pg{options}{showHints}          = 0;
  764 
  765 # Show solutions (when allowed) by default?
  766 $pg{options}{showSolutions}      = 0;
  767 
  768 # Catch translation warnings internally by default? (We no longer need to do
  769 # this, since there is a global warnings handler. So this should be off.)
  770 $pg{options}{catchWarnings}      = 0;
  771 
  772 ##### Currently-selected renderer
  773 
  774 # Only the local renderer is supported in this version.
  775 $pg{renderer} = "WeBWorK::PG::Local";
  776 
  777 # The remote renderer connects to an XML-RPC PG rendering server.
  778 #$pg{renderer} = "WeBWorK::PG::Remote";
  779 
  780 ##### Renderer-dependent options
  781 
  782 # The remote renderer has one option:
  783 $pg{renderers}{"WeBWorK::PG::Remote"} = {
  784   # The "proxy" server to connect to for remote rendering.
  785   proxy => "http://localhost:21000/RenderD",
  786 };
  787 
  788 ##### Settings for various display modes
  789 
  790 # "images" mode has several settings:
  791 $pg{displayModeOptions}{images} = {
  792   # Determines the method used to align images in output. Can be
  793   # "baseline", "absmiddle", or "mysql".
  794   dvipng_align => 'mysql',
  795 
  796   # If mysql is chosen, this information indicates which database contains the
  797   # 'depths' table. Since 2.3.0, the depths table is kept in the main webwork
  798   # database. (If you are upgrading from an earlier version of webwork, and
  799   # used the mysql method in the past, you should move your existing 'depths'
  800   # table to the main database.)
  801   dvipng_depth_db => {
  802     dbsource => $database_dsn,
  803     user     => $database_username,
  804     passwd   => $database_password,
  805   },
  806 };
  807 
  808 $pg{displayModeOptions}{jsMath} = {
  809   reportMissingFonts => 0,       # set to 1 to allow the missing font message
  810   missingFontMessage => undef,   # set to an HTML string to replace the missing font message
  811   noImageFonts => 0,             # set to 1 if you didn't install the jsMath image fonts
  812   processDoubleClicks => 1,      # set to 0 to disable double-click on math to get TeX source
  813 };
  814 
  815 ##### Directories used by PG
  816 
  817 # The root of the PG directory tree (from pg_root in Apache config).
  818 $pg{directories}{root}   = "$pg_dir";
  819 $pg{directories}{lib}    = "$pg{directories}{root}/lib";
  820 $pg{directories}{macros} = "$pg{directories}{root}/macros";
  821 
  822 #
  823 #  The macro file search path.  Each directory in this list is seached
  824 #  (in this order) by loadMacros() when it looks for a .pl file.
  825 #
  826 $pg{directories}{macrosPath} = [
  827    ".",                     # search the problem file's directory
  828    $courseDirs{macros},
  829    $pg{directories}{macros},
  830 ];
  831 
  832 # The applet search path. If a full URL is given, it is used unmodified. If an
  833 # absolute path is given, the URL of the local server is prepended to it.
  834 #
  835 # For example, if an item is "/math/applets",
  836 # and the local server is  "https://math.yourschool.edu",
  837 # then the URL "https://math.yourschool.edu/math/applets" will be used.
  838 #
  839 $pg{directories}{appletPath} = [    # paths to search for applets (requires full url)
  840   "$webworkURLs{htdocs}/applets",
  841   "$courseURLs{html}/applets",
  842 ];
  843 
  844 ##### "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.)
  845 
  846 # Users for whom to print the file name of the PG file being processed.
  847 $pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_FOR} = [ "professor", ];
  848 
  849 # Locations of CAPA resources. (Only necessary if you need to use converted CAPA
  850 # problems.)
  851 $pg{specialPGEnvironmentVars}{CAPA_Tools}             = "$courseDirs{macros}/CAPA_Tools/",
  852 $pg{specialPGEnvironmentVars}{CAPA_MCTools}           = "$courseDirs{macros}/CAPA_MCTools/",
  853 $pg{specialPGEnvironmentVars}{CAPA_GraphicsDirectory} = "$courseDirs{html}/CAPA_Graphics/",
  854 $pg{specialPGEnvironmentVars}{CAPA_Graphics_URL}      = "$courseURLs{html}/CAPA_Graphics/",
  855 
  856 # Size in pixels of dynamically-generated images, i.e. graphs.
  857 $pg{specialPGEnvironmentVars}{onTheFlyImageSize}      = 400,
  858 
  859 # To disable the Parser-based versions of num_cmp and fun_cmp, and use the
  860 # original versions instead, set this value to 1.
  861 $pg{specialPGEnvironmentVars}{useOldAnswerMacros} = 0;
  862 
  863 # Strings to insert at the start and end of the body of a problem
  864 #  (at beginproblem() and ENDDOCUMENT) in various modes.  More display modes
  865 #  can be added if different behaviours are desired (e.g., HTML_dpng,
  866 #  HTML_asciimath, etc.).  These parts are not used in the Library browser.
  867 
  868 $pg{specialPGEnvironmentVars}{problemPreamble} = { TeX => '', HTML=> '' };
  869 $pg{specialPGEnvironmentVars}{problemPostamble} = { TeX => '', HTML=>'' };
  870 
  871 # To have the problem body indented and boxed, uncomment:
  872 
  873 # $pg{specialPGEnvironmentVars}{problemPreamble}{HTML} = '<BLOCKQUOTE>
  874 #     <TABLE BORDER=1 CELLSPACING=1 CELLPADDING=15 BGCOLOR=#E8E8E8><TR><TD>';
  875 # $pg{specialPGEnvironmentVars}{problemPostamble}{HTML} = '</TD></TR></TABLE>
  876 #     </BLOCKQUOTE>';
  877 
  878 ##### PG modules to load
  879 
  880 # The first item of each list is the module to load. The remaining items are
  881 # additional packages to import.
  882 
  883 ${pg}{modules} = [
  884   [qw(DynaLoader)],
  885   [qw(Exporter)],
  886   [qw(GD)],
  887 
  888   [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand utf8)],
  889   [qw(AnswerHash AnswerEvaluator)],
  890   [qw(WWPlot)], # required by Circle (and others)
  891   [qw(Circle)],
  892   [qw(Complex)],
  893   [qw(Complex1)],
  894   [qw(Distributions)],
  895   [qw(Fraction)],
  896   [qw(Fun)],
  897   [qw(Hermite)],
  898   [qw(Label)],
  899   [qw(List)],
  900   [qw(Match)],
  901   [qw(MatrixReal1)], # required by Matrix
  902   [qw(Matrix)],
  903   [qw(Multiple)],
  904   [qw(PGrandom)],
  905   [qw(Regression)],
  906   [qw(Select)],
  907   [qw(Units)],
  908   [qw(VectorField)],
  909   [qw(Parser Value)],
  910   [qw(Parser::Legacy)],
  911 # [qw(SaveFile)],
  912 # [qw(Applet FlashApplet)],
  913 ];
  914 
  915 ##### Answer evaluatior defaults
  916 
  917 $pg{ansEvalDefaults} = {
  918   functAbsTolDefault            => .001,
  919   functLLimitDefault            => .0000001,
  920   functMaxConstantOfIntegration => 1E8,
  921   functNumOfPoints              => 3,
  922   functRelPercentTolDefault     => .1,
  923   functULimitDefault            => .9999999,
  924   functVarDefault               => "x",
  925   functZeroLevelDefault         => 1E-14,
  926   functZeroLevelTolDefault      => 1E-12,
  927   numAbsTolDefault              => .001,
  928   numFormatDefault              => "",
  929   numRelPercentTolDefault       => .1,
  930   numZeroLevelDefault           => 1E-14,
  931   numZeroLevelTolDefault        => 1E-12,
  932   useBaseTenLog                 => 0,
  933   defaultDisplayMatrixStyle     => "[s]",
  934 };
  935 
  936 ################################################################################
  937 # Compatibility
  938 ################################################################################
  939 
  940 # Define the old names for the various "root" variables.
  941 $webworkRoot    = $webworkDirs{root};
  942 $webworkURLRoot = $webworkURLs{root};
  943 $pgRoot         = $pg{directories}{root};
  944 

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9