[system] / trunk / webwork-modperl / conf / global.conf.dist Repository:
ViewVC logotype

View of /trunk/webwork-modperl/conf/global.conf.dist

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3671 - (download) (annotate)
Fri Sep 30 19:15:26 2005 UTC (7 years, 8 months ago) by sh002i
File size: 32710 byte(s)
implemented named roles for permissions system. %userRoles maps role
names to numeric permission levels, and %permissionLevels now maps
activities* to role names. A slight change to Authz.pm accompanies this
change to do the role-to-permission-level lookups.

* a.k.a. operations, privilegespermissions, gotta get the terminology
straight. think of the users!

%userRoles should be used by modules such as UserList for providing more
intelligent editing of the permission_level field. Another possible use
would be to for pretty-printing user types -- a user could be called a
student, ta, professor, etc. based on what role corresponded to their
permission_level.

    1 #!perl
    2 ################################################################################
    3 # WeBWorK Online Homework Delivery System
    4 # Copyright © 2000-2003 The WeBWorK Project, http://openwebwork.sf.net/
    5 # $CVSHeader: webwork2/conf/global.conf.dist,v 1.142 2005/09/27 03:58:06 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.
   34 $webwork_url         = "/webwork2";
   35 
   36 # Root directory of PG.
   37 $pg_dir              = "/opt/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 = "$webwork_dir/courses";
   46 
   47 ################################################################################
   48 # Paths to external programs
   49 ################################################################################
   50 
   51 # system utilties
   52 $externalPrograms{mkdir}    = "/bin/mkdir";
   53 $externalPrograms{mv}       = "/bin/mv";
   54 $externalPrograms{mysql}    = "/usr/bin/mysql";
   55 $externalPrograms{tar}      = "/usr/bin/tar";
   56 
   57 # equation rendering/hardcopy utiltiies
   58 $externalPrograms{latex}    = "/usr/bin/latex";
   59 $externalPrograms{pdflatex} = "/usr/bin/pdflatex --shell-escape"; # --shell-escape allows pdflatex to handle .eps files
   60 $externalPrograms{dvipng}   = "/usr/bin/dvipng";
   61 $externalPrograms{tth}      = "/usr/bin/tth";
   62 
   63 # NetPBM - basic image manipulation utilities
   64 # most sites only need to configure $netpbm_prefix.
   65 my $netpbm_prefix = "/usr/bin";
   66 $externalPrograms{giftopnm} = "$netpbm_prefix/giftopnm";
   67 $externalPrograms{ppmtopgm} = "$netpbm_prefix/ppmtopgm";
   68 $externalPrograms{pnmtops}  = "$netpbm_prefix/pnmtops";
   69 $externalPrograms{pnmtopng} = "$netpbm_prefix/pnmtopng";
   70 $externalPrograms{pngtopnm} = "$netpbm_prefix/pngtopnm";
   71 
   72 # image conversions utiltiies
   73 # the source file is given on stdin, and the output expected on stdout.
   74 #
   75 # Note on conversions pipelines:
   76 #     we used to use `pnmdepth 1' instead of ppmtopgm as it creates a
   77 #     monochrome image (1 bit) rather than a greyscale image (8 bits).
   78 #     However, this was causing improper display of some sort in PDFs.
   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 ################################################################################
   84 # Mail settings
   85 ################################################################################
   86 
   87 # Mail sent by the PG system and the mail merge and feedback modules will be
   88 # sent via this SMTP server.
   89 $mail{smtpServer}            = 'mail.yourschool.edu';
   90 
   91 # When connecting to the above server, WeBWorK will send this address in the
   92 # MAIL FROM command. This has nothing to do with the "From" address on the mail
   93 # message. It can really be anything, but some mail servers require it contain
   94 # a valid mail domain, or at least be well-formed.
   95 $mail{smtpSender}            = 'webwork@yourserver.yourschool.edu';
   96 
   97 # AllowedRecipients defines addresses that the PG system is allowed to send mail
   98 # to. this prevents subtle PG exploits. This should be set in course.conf to the
   99 # addresses of professors of each course. Sending mail from the PG system (i.e.
  100 # questionaires, essay questions) will fail if this is not set somewhere (either
  101 # here or in course.conf).
  102 $mail{allowedRecipients}     = [
  103   #'prof1@yourserver.yourdomain.edu',
  104   #'prof2@yourserver.yourdomain.edu',
  105 ];
  106 
  107 # By default, feeback is sent to all users who have permission to
  108 # receive_feedback. If this list is non-empty, feedback is also sent to the
  109 # addresses specified here.
  110 #
  111 # * If you want to disable feedback altogether, leave this empty and set
  112 #   submit_feeback => $nobody in %permissionLevels below. This will cause the
  113 #   feedback button to go away as well.
  114 #
  115 # * If you want to send email ONLY to addresses in this list, set
  116 #   receive_feedback => $nobody in %permissionLevels below.
  117 #
  118 # It's often useful to set this in the course.conf to change the behavior of
  119 # feedback for a specific course.
  120 #
  121 $mail{feedbackRecipients}    = [
  122   #'prof1@yourserver.yourdomain.edu',
  123   #'prof2@yourserver.yourdomain.edu',
  124 ];
  125 
  126 # Feedback subject line -- the following escape sequences are recognized:
  127 #
  128 #   %c = course ID
  129 #   %u = user ID
  130 #   %s = set ID
  131 #   %p = problem ID
  132 #   %x = section
  133 #   %r = recitation
  134 #   %% = literal percent sign
  135 #
  136 $mail{feedbackSubjectFormat} = "[WWfeedback] course:%c user:%u set:%s prob:%p sec:%x rec:%r";
  137 
  138 # feedbackVerbosity:
  139 #  0: send only the feedback comment and context link
  140 #  1: as in 0, plus user, set, problem, and PG data
  141 #  2: as in 1, plus the problem environment (debugging data)
  142 $mail{feedbackVerbosity}     = 1;
  143 
  144 # Defines the size of the Mail Merge editor window
  145 # FIXME: should this be here? it's UI, not mail
  146 # FIXME: replace this with the auto-size method that TWiki uses
  147 $mail{editor_window_rows}    = 15;
  148 $mail{editor_window_columns} = 100;
  149 
  150 ################################################################################
  151 # System-wide locations (directories and URLs)
  152 ################################################################################
  153 
  154 # The root directory, set by webwork_root variable in Apache configuration.
  155 $webworkDirs{root}          = "$webwork_dir";
  156 
  157 # Location of system-wide data files.
  158 $webworkDirs{DATA}          = "$webworkDirs{root}/DATA";
  159 
  160 # Used for temporary storage of uploaded files.
  161 $webworkDirs{uploadCache}   = "$webworkDirs{DATA}/uploads";
  162 
  163 # Location of utility programs.
  164 $webworkDirs{bin}           = "$webworkDirs{root}/bin";
  165 
  166 # Location of configuration files, templates, snippets, etc.
  167 $webworkDirs{conf}          = "$webworkDirs{root}/conf";
  168 
  169 # Location of course directories.
  170 $webworkDirs{courses}       = "$webwork_courses_dir" || "$webworkDirs{root}/courses";
  171 
  172 # Contains log files.
  173 $webworkDirs{logs}          = "$webworkDirs{root}/logs";
  174 
  175 # Contains non-web-accessible temporary files, such as TeX working directories.
  176 $webworkDirs{tmp}           = "$webworkDirs{root}/tmp";
  177 
  178 # The (absolute) destinations of symbolic links that are OK for the FileManager to follow.
  179 #   (any subdirectory of these is a valid target for a symbolic link.)
  180 # For example:
  181 #    $webworkDirs{valid_symlinks} = ["$webworkDirs{courses}/modelCourse/templates","/ww2/common/sets"];
  182 $webworkDirs{valid_symlinks}   = [];
  183 
  184 ##### The following locations are web-accessible.
  185 
  186 # The root URL (usually /webwork2), set by <Location> in Apache configuration.
  187 $webworkURLs{root}          = "$webwork_url";
  188 
  189 # Location of system-wide web-accessible files, such as equation images, and
  190 # help files.
  191 $webworkDirs{htdocs}        = "$webwork_htdocs_dir" || "$webworkDirs{root}/htdocs";
  192 $webworkURLs{htdocs}        = "$webwork_htdocs_url";
  193 
  194 # Location of web-accessible temporary files, such as equation images.
  195 $webworkDirs{htdocs_temp}   = "$webworkDirs{htdocs}/tmp";
  196 $webworkURLs{htdocs_temp}   = "$webworkURLs{htdocs}/tmp";
  197 
  198 # Location of cached equation images.
  199 $webworkDirs{equationCache} = "$webworkDirs{htdocs_temp}/equations";
  200 $webworkURLs{equationCache} = "$webworkURLs{htdocs_temp}/equations";
  201 
  202 # Contains context-sensitive help files.
  203 $webworkDirs{local_help}    = "$webworkDirs{htdocs}/helpFiles";
  204 $webworkURLs{local_help}    = "$webworkURLs{htdocs}/helpFiles";
  205 
  206 # URL of general WeBWorK documentation.
  207 $webworkURLs{docs}          = "http://webhost.math.rochester.edu/webworkdocs/docs";
  208 
  209 # URL of WeBWorK 1.x profLogin.pl script, for access to old professor pages.
  210 # Note that both systems must share a single "courses" directory for this to be
  211 # useful. Leave this blank to disable
  212 $webworkURLs{oldProf}       = "/webwork1/profLogin.pl";
  213 
  214 # URL of WeBWorK Bugzilla database.
  215 $webworkURLs{bugReporter}   = "http://bugs.webwork.rochester.edu/";
  216 
  217 # Location of CSS
  218 $webworkURLs{stylesheet}    = "$webworkURLs{htdocs}/css/ur.css";
  219 
  220 # Location of jsMath script, used for the jsMath display mode.
  221 $webworkURLs{jsMath}        = "$webworkURLs{htdocs}/jsMath/jsMath-ww.js";
  222 
  223 # Location of ASCIIMathML script, used for the asciimath display mode.
  224 $webworkURLs{asciimath}     = "$webworkURLs{htdocs}/ASCIIMathML/ASCIIMathML.js";
  225 
  226 ################################################################################
  227 # Defaults for course-specific locations (directories and URLs)
  228 ################################################################################
  229 
  230 # The root directory of the current course. (The ID of the current course is
  231 # available in $courseName.)
  232 $courseDirs{root}        = "$webworkDirs{courses}/$courseName";
  233 
  234 # Location of course-specific data files, such as WW1 (GDBM) database files.
  235 $courseDirs{DATA}        = "$courseDirs{root}/DATA";
  236 
  237 # Location of authentication data files when using a WW1 (GDBM) database.
  238 $courseDirs{auth_DATA}   = "$courseDirs{DATA}/.auth";
  239 
  240 # Location of course HTML files, passed to PG.
  241 $courseDirs{html}        = "$courseDirs{root}/html";
  242 $courseURLs{html}        = "$webwork_courses_url/$courseName";
  243 
  244 # Location of course image files, passed to PG.
  245 $courseDirs{html_images} = "$courseDirs{html}/images";
  246 
  247 # Location of web-accessible, course-specific temporary files, like static and
  248 # dynamically-generated PG graphics.
  249 $courseDirs{html_temp}   = "$courseDirs{html}/tmp";
  250 $courseURLs{html_temp}   = "$courseURLs{html}/tmp";
  251 
  252 # Location of course-specific logs, like the transaction log.
  253 $courseDirs{logs}        = "$courseDirs{root}/logs";
  254 
  255 # Location of scoring files.
  256 $courseDirs{scoring}     = "$courseDirs{root}/scoring";
  257 
  258 # Location of PG templates and set definition files.
  259 $courseDirs{templates}   = "$courseDirs{root}/templates";
  260 
  261 # Location of course-specific macro files.
  262 $courseDirs{macros}      = "$courseDirs{templates}/macros";
  263 
  264 # Location of mail-merge templates.
  265 $courseDirs{email}       = "$courseDirs{templates}/email";
  266 
  267 ################################################################################
  268 # System-wide files
  269 ################################################################################
  270 
  271 # Location of this file.
  272 $webworkFiles{environment}                      = "$webworkDirs{conf}/global.conf";
  273 
  274 # Flat-file database used to protect against MD5 hash collisions. TeX equations
  275 # are hashed to determine the name of the image file. There is a tiny chance of
  276 # a collision between two TeX strings. This file allows for that. However, this
  277 # is slow, so most people chose not to worry about it. Set this to "" if you
  278 # don't want to use the equation cache file.
  279 $webworkFiles{equationCacheDB}                  = ""; # "$webworkDirs{DATA}/equationcache";
  280 
  281 ##### Hardcopy snippets are used in constructing a TeX file for hardcopy output.
  282 ##### They should contain TeX code unless otherwise noted.
  283 
  284 # The preamble is the first thing in the TeX file.
  285 $webworkFiles{hardcopySnippets}{preamble}       = "$webworkDirs{conf}/snippets/hardcopyPreamble.tex";
  286 
  287 # The setHeader preceeds each set. It is a PG file.
  288 $webworkFiles{hardcopySnippets}{setHeader}      = "$webworkDirs{conf}/snippets/setHeader.pg";  # hardcopySetHeader.pg",
  289 
  290 # The problem divider goes between problems.
  291 $webworkFiles{hardcopySnippets}{problemDivider} = "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex";
  292 
  293 # The set footer goes after each set. Is is a PG file.
  294 $webworkFiles{hardcopySnippets}{setFooter}      = "$webworkDirs{conf}/snippets/hardcopySetFooter.pg";
  295 
  296 # The set divider goes between sets (in multiset output).
  297 $webworkFiles{hardcopySnippets}{setDivider}     = "$webworkDirs{conf}/snippets/hardcopySetDivider.tex";
  298 
  299 # The user divider does between users (in multiuser output).
  300 $webworkFiles{hardcopySnippets}{userDivider}    = "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex";
  301 
  302 # The postabmle is the last thing in the TeX file.
  303 $webworkFiles{hardcopySnippets}{postamble}      = "$webworkDirs{conf}/snippets/hardcopyPostamble.tex";
  304 
  305 ##### Screen snippets are used when displaying problem sets on the screen.
  306 
  307 # The set header is displayed on the problem set page. It is a PG file.
  308 $webworkFiles{screenSnippets}{setHeader}        = "$webworkDirs{conf}/snippets/setHeader.pg"; # screenSetHeader.pg"
  309 
  310 # A PG template for creation of new problems.
  311 $webworkFiles{screenSnippets}{blankProblem}    = "$webworkDirs{conf}/snippets/blankProblem.pg"; # screenSetHeader.pg"
  312 
  313 # A site info  "message of the day" file
  314 $webworkFiles{site_info}                       = "$webworkDirs{htdocs}/site_info.txt";
  315 ################################################################################
  316 # Course-specific files
  317 ################################################################################
  318 
  319 # The course configuration file.
  320 $courseFiles{environment} = "$courseDirs{root}/course.conf";
  321 
  322 # File contents are displayed after login, on the problem sets page. Path given
  323 # here is relative to the templates directory.
  324 $courseFiles{course_info} = "course_info.txt";
  325 
  326 # File contents are displayed on the login page. Path given here is relative to
  327 # the templates directory.
  328 $courseFiles{login_info}  = "login_info.txt";
  329 
  330 # Additional library buttons can be added to the Library Browser (SetMaker.pm)
  331 # by adding the libraries you want to the following line.  For each key=>value
  332 # in the list, if a directory (or link to a directory) with name 'key' appears
  333 # in the templates directory, then a button with name 'value' will be placed at
  334 # the top of the problem browser.  (No button will appear if there is no
  335 # directory or link with the given name in the templates directory.)  For
  336 # example,
  337 #
  338 #     $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"};
  339 #
  340 # would add two buttons, one for the Rochester library and one for the ASU
  341 # library, provided templates/rochester and templates/asu exists either as
  342 # subdirectories or links to other directories.
  343 #
  344 $courseFiles{problibs}    = {
  345 #   rochesterLibrary => "Rochester",
  346 #   asuLibrary       => "Arizona State",
  347 #   dcdsLibrary      => "Detroit CDS",
  348 #   dartmouthLibrary => "Dartmouth",
  349 #   indianaLibrary   => "Indiana",
  350 #   osuLibrary       => "Ohio State",
  351 #   capaLibrary      => "CAPA",
  352 };
  353 
  354 ################################################################################
  355 # Database options
  356 ################################################################################
  357 
  358 # Several database are defined in the file conf/database.conf and stored in the
  359 # hash %dbLayouts.
  360 include "conf/database.conf";
  361 
  362 # Select the default database layout. This can be overridden in the course.conf
  363 # file of a particular course. If you choose "gdbm", WeBWorK will be able to
  364 # use courses from WeBWorK 1 without first adding course.conf files to them.
  365 # However, the recommended database layout for new courses is "sql_single". This
  366 # can be set when creating a course.
  367 $dbLayoutName = "sql_single"; # or "gdbm" or "sql"
  368 
  369 # This sets the symbol "dbLayout" as an alias for the selected database layout.
  370 *dbLayout     = $dbLayouts{$dbLayoutName};
  371 
  372 ################################################################################
  373 # Problem library options
  374 ################################################################################
  375 
  376 # The directory containing the problem library files. Set to "" if no problem
  377 # library is installed.
  378 $problemLibrary{root}        = "";
  379 
  380 # Problem Library version
  381 # Version 1 is in use.  Version 2 will be released soon.
  382 $problemLibrary{version} = "1";
  383 
  384 # The name of the SQL database containing problem metadata
  385 $problemLibrary{sourceSQL}   = "ProblemLibrary";
  386 
  387 # The user name to use when connecting to the problem library database
  388 $problemLibrary{userSQL}     = "webworkRead";
  389 
  390 # The password to use when connecting to the problem library database
  391 $problemLibrary{passwordSQL} = "";
  392 
  393 ################################################################################
  394 # Logs
  395 ################################################################################
  396 
  397 # FIXME: take logs out of %webworkFiles/%courseFiles and give them their own
  398 # top-level hash.
  399 
  400 # Logs data about how long it takes to process problems. (Do not confuse this
  401 # with the /other/ timing log which can be set by WeBWorK::Timing and is used
  402 # for benchmarking system performance in general. At some point, this timing
  403 # mechanism will be deprecated in favor of the WeBWorK::Timing mechanism.)
  404 $webworkFiles{logs}{timing}         = "$webworkDirs{logs}/timing.log";
  405 
  406 # Logs courses created via the web-based Course Administration module.
  407 $webworkFiles{logs}{hosted_courses} = "$webworkDirs{logs}/hosted_courses.log";
  408 
  409 # The transaction log contains data from each recorded answer submission. This
  410 # is useful if the database becomes corrupted.
  411 $webworkFiles{logs}{transaction}    = "$courseDirs{logs}/transaction.log";
  412 
  413 # The answer log stores a history of all users' submitted answers.
  414 $courseFiles{logs}{answer_log}      = "$courseDirs{logs}/answer_log";
  415 
  416 # Log logins.
  417 $courseFiles{logs}{login_log}       = "$courseDirs{logs}/login.log";
  418 
  419 # Log for almost every click.  By default it is the empty string, which
  420 # turns this log off.  If you want it turned on, we suggest
  421 #                "$courseDirs{logs}/activity.log"
  422 # When turned on, this log can get quite large.
  423 $courseFiles{logs}{activity_log} = '';
  424 
  425 ################################################################################
  426 # Site defaults (FIXME: what other things could be "site defaults"?)
  427 ################################################################################
  428 
  429 # Status strings -- lists valid status values and their names. If your site uses
  430 # additional values, add them here.
  431 $siteDefaults{status} = {
  432   A        => "Audit",
  433   a        => "Audit",
  434   audit    => "Audit",
  435   D        => "Drop",
  436   d        => "Drop",
  437   drop     => "Drop",
  438   withdraw => "Drop",
  439   C        => "Enrolled",
  440   c        => "Enrolled",
  441   current  => "Enrolled",
  442   enrolled => "Enrolled",
  443 };
  444 
  445 # Set the default timezone of courses on this server. To get a list of valid
  446 # timezones, run:
  447 #
  448 #     perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names'
  449 #
  450 # To get a list of valid timezone "links" (deprecated names), run:
  451 #
  452 #     perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links'
  453 #
  454 # If left blank, the system timezone will be used. This is usually what you
  455 # want. You might want to set this if your server is NOT in the same timezone as
  456 # your school. If just a few courses are in a different timezone, set this in
  457 # course.conf for the affected courses instead.
  458 #
  459 $siteDefaults{timezone} = "";
  460 
  461 # The default_templates_course is used by default to create a new course.
  462 # The contents of the templates directory are copied from this course
  463 # to the new course being created.
  464 $siteDefaults{default_templates_course} ="modelCourse";
  465 
  466 ################################################################################
  467 # Frontend options
  468 ################################################################################
  469 
  470 %templates = (
  471   system => "$webworkDirs{conf}/templates/ur.template",
  472   gateway => "$webworkDirs{conf}/templates/gw.template",
  473 );
  474 
  475 ################################################################################
  476 # Authorization system
  477 ################################################################################
  478 
  479 # this section lets you define which groups of users can perform which actions.
  480 
  481 # this hash maps a numeric permission level to the name of a role. the number
  482 # assigned to a role is significant -- roles with higher numbers are considered
  483 # "more privileged", and are included when that role is listed for a privilege
  484 # below.
  485 #
  486 %userRoles = (
  487   guest => -5,
  488   student => 0,
  489   proctor => 2,
  490   ta => 5,
  491   professor => 10,
  492 );
  493 
  494 # this hash maps operations to the roles that are allowed to perform those
  495 # operations. the role listed and any role with a higher permission level (in
  496 # the %userRoles hash) will be allowed to perform the operation. If the role
  497 # is undefined, no users will be allowed to perform the operation.
  498 #
  499 %permissionLevels = (
  500   login                          => "guest",
  501   report_bugs                    => "student",
  502   submit_feedback                => "student",
  503   change_password                => "student",
  504   change_email_address           => "student",
  505 
  506   proctor_quiz                   => "proctor",
  507 
  508   view_multiple_sets             => "ta",
  509   view_unopened_sets             => "ta",
  510   view_unpublished_sets          => "ta",
  511   view_answers                   => "ta",
  512 
  513   become_student                 => "professor",
  514   access_instructor_tools        => "ta",
  515   score_sets                     => "professor",
  516   send_mail                      => "professor",
  517   receive_feedback               => "ta",
  518 
  519   create_and_delete_problem_sets => "professor",
  520   assign_problem_sets            => "professor",
  521   modify_problem_sets            => "professor",
  522   modify_student_data            => "professor",
  523   modify_classlist_files         => "professor",
  524   modify_set_def_files           => "professor",
  525   modify_scoring_files           => "professor",
  526   modify_problem_template_files  => "professor",
  527 
  528   create_and_delete_courses      => "professor",
  529   fix_course_databases           => "professor",
  530 
  531   ##### Behavior of the interactive problem processor #####
  532 
  533   show_correct_answers_before_answer_date         => "ta",
  534   show_solutions_before_answer_date               => "ta",
  535   avoid_recording_answers                         => "ta",
  536   # Below this level, old answers are never initially shown
  537   can_show_old_answers_by_default                 => "student",
  538   # at this level, we look at showOldAnswers for default value
  539   # even after the due date
  540   can_always_use_show_old_answers_default         => "professor",
  541   check_answers_before_open_date                  => "ta",
  542   check_answers_after_open_date_with_attempts     => "ta",
  543   check_answers_after_open_date_without_attempts  => "guest",
  544   check_answers_after_due_date                    => "guest",
  545   check_answers_after_answer_date                 => "guest",
  546   record_answers_when_acting_as_student           => undef,
  547   # "record_answers_when_acting_as_student" takes precedence
  548   # over the following for professors acting as students:
  549   record_answers_before_open_date                 => undef,
  550   record_answers_after_open_date_with_attempts    => "student",
  551   record_answers_after_open_date_without_attempts => undef,
  552   record_answers_after_due_date                   => undef,
  553   record_answers_after_answer_date                => undef,
  554   dont_log_past_answers                           => "professor",
  555 
  556   ##### Behavior of the Hardcopy Processor #####
  557 
  558   download_hardcopy_multiuser  => "ta",
  559   download_hardcopy_multiset   => "ta",
  560   download_hardcopy_format_pdf => "guest",
  561   download_hardcopy_format_tex => "ta",
  562 );
  563 
  564 ################################################################################
  565 # Session options
  566 ################################################################################
  567 
  568 # $sessionKeyTimeout defines seconds of inactivity before a key expires
  569 $sessionKeyTimeout = 60*30;
  570 
  571 # $sessionKeyLength defines the length (in characters) of the session key
  572 $sessionKeyLength = 40;
  573 
  574 # @sessionKeyChars lists the legal session key characters
  575 @sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9', '.', '^', '/', '!', '*');
  576 
  577 # Practice users are users who's names start with $practiceUser
  578 # (you can comment this out to remove practice user support)
  579 $practiceUserPrefix = "practice";
  580 
  581 # There is a practice user who can be logged in multiple times.  He's
  582 # commented out by default, though, so you don't hurt yourself.  It is
  583 # kindof a backdoor to the practice user system, since he doesn't have a
  584 # password.  Come to think of it, why do we even have this?!
  585 #$debugPracticeUser = "practice666";
  586 
  587 ################################################################################
  588 # PG subsystem options
  589 ################################################################################
  590 
  591 # List of enabled display modes. Comment out any modes you don't wish to make
  592 # available for use.
  593 $pg{displayModes} = [
  594   "plainText",     # display raw TeX for math expressions
  595   "formattedText", # format math expressions using TtH
  596   "images",        # display math expressions as images generated by dvipng
  597   "jsMath",        # render TeX math expressions on the client side using jsMath
  598   "asciimath",     # render TeX math expressions on the client side using ASCIIMathML
  599 ];
  600 
  601 #### Default settings for the PG translator
  602 
  603 # Default display mode. Should be listed above.
  604 $pg{options}{displayMode}        = "images";
  605 
  606 # The default grader to use, if a problem doesn't specify.
  607 $pg{options}{grader}             = "avg_problem_grader";
  608 
  609 # Fill in answer blanks with the student's last answer by default?
  610 $pg{options}{showOldAnswers}     = 1;
  611 
  612 # Show correct answers (when allowed) by default?
  613 $pg{options}{showCorrectAnswers} = 0;
  614 
  615 # Show hints (when allowed) by default?
  616 $pg{options}{showHints}          = 0;
  617 
  618 # Show solutions (when allowed) by default?
  619 $pg{options}{showSolutions}      = 0;
  620 
  621 # Catch translation warnings internally by default? (We no longer need to do
  622 # this, since there is a global warnings handler. So this should be off.)
  623 $pg{options}{catchWarnings}      = 0;
  624 
  625 ##### Currently-selected renderer
  626 
  627 # Only the local renderer is supported in this version.
  628 $pg{renderer} = "WeBWorK::PG::Local";
  629 
  630 # The remote renderer connects to an XML-RPC PG rendering server.
  631 #$pg{renderer} = "WeBWorK::PG::Remote";
  632 
  633 ##### Renderer-dependent options
  634 
  635 # The remote renderer has one option:
  636 $pg{renderers}{"WeBWorK::PG::Remote"} = {
  637   # The "proxy" server to connect to for remote rendering.
  638   proxy => "http://localhost:21000/RenderD",
  639 };
  640 
  641 ##### Settings for various display modes
  642 
  643 # "images" mode has several settings:
  644 $pg{displayModeOptions}{images} = {
  645   # Determines the method used to align images in output. Can be
  646   # "baseline", "absmiddle", or "mysql".
  647   dvipng_align => 'baseline',
  648 
  649   # If we choose mysql, we need information on connecting to the
  650   # database. Whatever you use here, you have to create the database
  651   # and grant read/write priveleges to the user listed here. To create
  652   # the database in mysql, as root use:
  653   #
  654   #     CREATE DATABASE DvipngDepths;
  655   #     USE DvipngDepths;
  656   #     CREATE TABLE depths (md5 CHAR(33) NOT NULL, depth SMALLINT, PRIMARY KEY (md5));
  657   #     GRANT ALL ON DvipngDepths.* TO webworkWrite;
  658   #
  659   # In the last statement, "webworkWrite" should match the user below.
  660   # FIXME: this database can become a table in the 'webwork' database
  661   dvipng_depth_db => {
  662     dbsource => 'dbi:mysql:DvipngDepths',
  663     user     => $dbLayouts{sql}->{password}->{params}->{usernameRW},
  664     passwd   => $dbLayouts{sql}->{password}->{params}->{passwordRW},
  665   },
  666 };
  667 
  668 $pg{displayModeOptions}{jsMath} = {
  669   reportMissingFonts => 0,       # set to 1 to allow the missing font message
  670   missingFontMessage => undef,   # set to an HTML string to replace the missing font message
  671   noImageFonts => 0,             # set to 1 if you didn't install the jsMath image fonts
  672 };
  673 
  674 ##### Directories used by PG
  675 
  676 # The root of the PG directory tree (from pg_root in Apache config).
  677 $pg{directories}{root}   = "$pg_dir";
  678 $pg{directories}{lib}    = "$pg{directories}{root}/lib";
  679 $pg{directories}{macros} = "$pg{directories}{root}/macros";
  680 
  681 #
  682 #  The macro file search path.  Each directory in this list is seached
  683 #  (in this order) by loadMacros() when it looks for a .pl file.
  684 #
  685 $pg{directories}{macrosPath} = [
  686    ".",                     # search the problem file's directory
  687    $courseDirs{macros},
  688    $pg{directories}{macros},
  689 ];
  690 
  691 ##### "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.)
  692 
  693 # Users for whom to print the file name of the PG file being processed.
  694 $pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_FOR} = [ "professor", ];
  695 
  696 # Locations of CAPA resources. (Only necessary if you need to use converted CAPA
  697 # problems.)
  698 $pg{specialPGEnvironmentVars}{CAPA_Tools}             = "$courseDirs{macros}/CAPA_Tools/",
  699 $pg{specialPGEnvironmentVars}{CAPA_MCTools}           = "$courseDirs{macros}/CAPA_MCTools/",
  700 $pg{specialPGEnvironmentVars}{CAPA_GraphicsDirectory} = "$courseDirs{html}/CAPA_Graphics/",
  701 $pg{specialPGEnvironmentVars}{CAPA_Graphics_URL}      = "$courseURLs{html}/CAPA_Graphics/",
  702 
  703 # Size in pixels of dynamically-generated images, i.e. graphs.
  704 $pg{specialPGEnvironmentVars}{onTheFlyImageSize}      = 400,
  705 
  706 # To activate Parser-based versions of num_cmp and fun_cmp, change this
  707 # value to 0.
  708 $pg{specialPGEnvironmentVars}{useOldAnswerMacros} = 1;
  709 
  710 # Strings to insert at the start and end of the body of a problem
  711 #  (at beginproblem() and ENDDOCUMENT) in various modes.  More display modes
  712 #  can be added if different behaviours are desired (e.g., HTML_dpng,
  713 #  HTML_asciimath, etc.).  These parts are not used in the Library browser.
  714 
  715 $pg{specialPGEnvironmentVars}{problemPreamble} = { TeX => '', HTML=> '' };
  716 $pg{specialPGEnvironmentVars}{problemPostamble} = { TeX => '', HTML=>'' };
  717 
  718 # To have the problem body indented and boxed, uncomment:
  719 
  720 # $pg{specialPGEnvironmentVars}{problemPreamble}{HTML} = '<BLOCKQUOTE>
  721 #     <TABLE BORDER=1 CELLSPACING=1 CELLPADDING=15 BGCOLOR=#E8E8E8><TR><TD>';
  722 # $pg{specialPGEnvironmentVars}{problemPostamble}{HTML} = '</TD></TR></TABLE>
  723 #     </BLOCKQUOTE>';
  724 
  725 ##### PG modules to load
  726 
  727 # The first item of each list is the module to load. The remaining items are
  728 # additional packages to import.
  729 
  730 ${pg}{modules} = [
  731   [qw(DynaLoader)],
  732   [qw(Exporter)],
  733   [qw(GD)],
  734 
  735   [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand utf8)],
  736   [qw(AnswerHash AnswerEvaluator)],
  737   [qw(WWPlot)], # required by Circle (and others)
  738   [qw(Circle)],
  739   [qw(Complex)],
  740   [qw(Complex1)],
  741   [qw(Distributions)],
  742   [qw(Fraction)],
  743   [qw(Fun)],
  744   [qw(Hermite)],
  745   [qw(Label)],
  746   [qw(List)],
  747   [qw(Match)],
  748   [qw(MatrixReal1)], # required by Matrix
  749   [qw(Matrix)],
  750   [qw(Multiple)],
  751   [qw(PGrandom)],
  752   [qw(Regression)],
  753   [qw(Select)],
  754   [qw(Units)],
  755   [qw(VectorField)],
  756   [qw(Parser Value)],
  757   [qw(Parser::Legacy)],
  758   [qw(Apache::Log)],
  759 ];
  760 
  761 ##### Answer evaluatior defaults
  762 
  763 $pg{ansEvalDefaults} = {
  764   functAbsTolDefault            => .001,
  765   functLLimitDefault            => .0000001,
  766   functMaxConstantOfIntegration => 1E8,
  767   functNumOfPoints              => 3,
  768   functRelPercentTolDefault     => .1,
  769   functULimitDefault            => .9999999,
  770   functVarDefault               => "x",
  771   functZeroLevelDefault         => 1E-14,
  772   functZeroLevelTolDefault      => 1E-12,
  773   numAbsTolDefault              => .001,
  774   numFormatDefault              => "",
  775   numRelPercentTolDefault       => .1,
  776   numZeroLevelDefault           => 1E-14,
  777   numZeroLevelTolDefault        => 1E-12,
  778   useBaseTenLog                 => 0,
  779   defaultDisplayMatrixStyle     => "[s]",
  780 };
  781 
  782 ################################################################################
  783 # Compatibility
  784 ################################################################################
  785 
  786 # Define the old names for the various "root" variables.
  787 $webworkRoot    = $webworkDirs{root};
  788 $webworkURLRoot = $webworkURLs{root};
  789 $pgRoot         = $pg{directories}{root};

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9