--- trunk/webwork2/conf/global.conf.dist 2003/12/09 01:12:32 1663 +++ trunk/webwork2/conf/global.conf.dist 2007/06/01 14:25:08 4973 @@ -1,8 +1,8 @@ #!perl ################################################################################ # WeBWorK Online Homework Delivery System -# Copyright © 2000-2003 The WeBWorK Project, http://openwebwork.sf.net/ -# $CVSHeader$ +# Copyright © 2000-2006 The WeBWorK Project, http://openwebwork.sf.net/ +# $CVSHeader: webwork2/conf/global.conf.dist,v 1.189 2007/04/04 15:05:26 glarose Exp $ # # This program is free software; you can redistribute it and/or modify it under # the terms of either: (a) the GNU General Public License as published by the @@ -19,198 +19,680 @@ # requests. Values may be overwritten by the course.conf for a specific course. # All package variables set in this file are added to the course environment. # If you wish to set a variable here but omit it from the course environment, -# use the "my" keyword. The following variables are available to this file: -# -# $webworkRoot directory that contains the WeBWorK distribution -# $webworkURL base URL handled by Apache::WeBWorK -# $pgRoot directory that contains the PG distribution -# $courseName name of the course being used - -################################################################################ -# WeBWorK settings -################################################################################ - -%webworkDirs = ( - root => "$webworkRoot", - DATA => "$webworkRoot/DATA", - uploadCache => "$webworkRoot/DATA/uploads", - bin => "$webworkRoot/bin", - conf => "$webworkRoot/conf", - courses => "$webworkRoot/courses", - htdocs => "$webworkRoot/htdocs", - htdocs_temp => "$webworkRoot/htdocs/tmp", - equationCache => "$webworkRoot/htdocs/tmp/equations", - lib => "$webworkRoot/lib", - logs => "$webworkRoot/logs", - macros => "$pgRoot/macros", - tmp => "$webworkRoot/tmp", -); +# use the "my" keyword. The $webwork_dir variable is set in the WeBWorK Apache +# configuration file (webwork.apache-config) and is available for use here. In +# addition, the $courseName variable holds the name of the current course. + +################################################################################ +# Seed variables +################################################################################ + +# Set these variables to correspond to your configuration and preferences. You +# will need to restart the webserver to reset the variables in this section. + +# URL of WeBWorK handler. If WeBWorK is to be on the web server root, use "". +$webwork_url = "/webwork2"; + +# Root directory of PG. +$pg_dir = "/opt/webwork/pg"; + +# URL and path to htdocs directory. +$webwork_htdocs_url = "/webwork2_files"; +$webwork_htdocs_dir = "$webwork_dir/htdocs"; + +# URL and path to courses directory. +$webwork_courses_url = "/webwork2_course_files"; +$webwork_courses_dir = "/opt/webwork/courses"; + +################################################################################ +# Paths to external programs +################################################################################ + +# system utilties +$externalPrograms{mv} = "/bin/mv"; +$externalPrograms{cp} = "/bin/cp"; +$externalPrograms{rm} = "/bin/rm"; +$externalPrograms{mkdir} = "/bin/mkdir"; +$externalPrograms{tar} = "/usr/bin/tar"; +$externalPrograms{gzip} = "/usr/bin/gzip"; + +# equation rendering/hardcopy utiltiies +$externalPrograms{latex} = "/usr/bin/latex"; +$externalPrograms{pdflatex} = "/usr/bin/pdflatex --shell-escape"; +$externalPrograms{dvipng} = "/usr/bin/dvipng"; +$externalPrograms{tth} = "/usr/bin/tth"; + +# NetPBM - basic image manipulation utilities +# Most sites only need to configure $netpbm_prefix. +my $netpbm_prefix = "/usr/bin"; +$externalPrograms{giftopnm} = "$netpbm_prefix/giftopnm"; +$externalPrograms{ppmtopgm} = "$netpbm_prefix/ppmtopgm"; +$externalPrograms{pnmtops} = "$netpbm_prefix/pnmtops"; +$externalPrograms{pnmtopng} = "$netpbm_prefix/pnmtopng"; +$externalPrograms{pngtopnm} = "$netpbm_prefix/pngtopnm"; + +# url checker +$externalPrograms{checkurl} = "/usr/local/bin/lwp-request -mHEAD "; # or "/usr/local/bin/w3c -head " + +# image conversions utiltiies +# the source file is given on stdin, and the output expected on stdout. +$externalPrograms{gif2eps} = "$externalPrograms{giftopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null"; +$externalPrograms{png2eps} = "$externalPrograms{pngtopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null"; +$externalPrograms{gif2png} = "$externalPrograms{giftopnm} | $externalPrograms{pnmtopng}"; + +# mysql clients +$externalPrograms{mysql} = "/usr/bin/mysql"; +$externalPrograms{mysqldump} = "/usr/bin/mysqldump"; + +################################################################################ +# Mail settings +################################################################################ + +# Mail sent by the PG system and the mail merge and feedback modules will be +# sent via this SMTP server. +$mail{smtpServer} = 'mail.yourschool.edu'; + +# When connecting to the above server, WeBWorK will send this address in the +# MAIL FROM command. This has nothing to do with the "From" address on the mail +# message. It can really be anything, but some mail servers require it contain +# a valid mail domain, or at least be well-formed. +$mail{smtpSender} = 'webwork@yourserver.yourschool.edu'; + +# AllowedRecipients defines addresses that the PG system is allowed to send mail +# to. this prevents subtle PG exploits. This should be set in course.conf to the +# addresses of professors of each course. Sending mail from the PG system (i.e. +# questionaires, essay questions) will fail if this is not set somewhere (either +# here or in course.conf). +$mail{allowedRecipients} = [ + #'prof1@yourserver.yourdomain.edu', + #'prof2@yourserver.yourdomain.edu', +]; + +# By default, feeback is sent to all users who have permission to +# receive_feedback. If this list is non-empty, feedback is also sent to the +# addresses specified here. +# +# * If you want to disable feedback altogether, leave this empty and set +# submit_feeback => $nobody in %permissionLevels below. This will cause the +# feedback button to go away as well. +# +# * If you want to send email ONLY to addresses in this list, set +# receive_feedback => $nobody in %permissionLevels below. +# +# It's often useful to set this in the course.conf to change the behavior of +# feedback for a specific course. +# +# Items in this list may be bare addresses, or RFC822 mailboxes, like: +# 'Joe User ' +# The advantage of this form is that the resulting email will include the name +# of the recipient in the "To" field of the email. +# +$mail{feedbackRecipients} = [ + #'prof1@yourserver.yourdomain.edu', + #'prof2@yourserver.yourdomain.edu', +]; + +# Feedback subject line -- the following escape sequences are recognized: +# +# %c = course ID +# %u = user ID +# %s = set ID +# %p = problem ID +# %x = section +# %r = recitation +# %% = literal percent sign +# +$mail{feedbackSubjectFormat} = "[WWfeedback] course:%c user:%u set:%s prob:%p sec:%x rec:%r"; + +# feedbackVerbosity: +# 0: send only the feedback comment and context link +# 1: as in 0, plus user, set, problem, and PG data +# 2: as in 1, plus the problem environment (debugging data) +$mail{feedbackVerbosity} = 1; + +# Defines the size of the Mail Merge editor window +# FIXME: should this be here? it's UI, not mail +# FIXME: replace this with the auto-size method that TWiki uses +$mail{editor_window_rows} = 15; +$mail{editor_window_columns} = 100; + +# Use this to customize the text of the feedback button. +$feedback_button_name = "Email instructor"; + +################################################################################ +# System-wide locations (directories and URLs) +################################################################################ + +# The root directory, set by webwork_root variable in Apache configuration. +$webworkDirs{root} = "$webwork_dir"; + +# Location of system-wide data files. +$webworkDirs{DATA} = "$webworkDirs{root}/DATA"; + +# Used for temporary storage of uploaded files. +$webworkDirs{uploadCache} = "$webworkDirs{DATA}/uploads"; + +# Location of utility programs. +$webworkDirs{bin} = "$webworkDirs{root}/bin"; + +# Location of configuration files, templates, snippets, etc. +$webworkDirs{conf} = "$webworkDirs{root}/conf"; + +# Location of theme templates. +$webworkDirs{templates} = "$webworkDirs{conf}/templates"; + +# Location of course directories. +$webworkDirs{courses} = "$webwork_courses_dir" || "$webworkDirs{root}/courses"; + +# Contains log files. +$webworkDirs{logs} = "$webworkDirs{root}/logs"; + +# Contains non-web-accessible temporary files, such as TeX working directories. +$webworkDirs{tmp} = "$webworkDirs{root}/tmp"; + +# The (absolute) destinations of symbolic links that are OK for the FileManager to follow. +# (any subdirectory of these is a valid target for a symbolic link.) +# For example: +# $webworkDirs{valid_symlinks} = ["$webworkDirs{courses}/modelCourse/templates","/ww2/common/sets"]; +$webworkDirs{valid_symlinks} = []; + +##### The following locations are web-accessible. + +# The root URL (usually /webwork2), set by in Apache configuration. +$webworkURLs{root} = "$webwork_url"; + +# Location of system-wide web-accessible files, such as equation images, and +# help files. +$webworkDirs{htdocs} = "$webwork_htdocs_dir" || "$webworkDirs{root}/htdocs"; +$webworkURLs{htdocs} = "$webwork_htdocs_url"; + +# Location of web-accessible temporary files, such as equation images. +$webworkDirs{htdocs_temp} = "$webworkDirs{htdocs}/tmp"; +$webworkURLs{htdocs_temp} = "$webworkURLs{htdocs}/tmp"; + +# Location of cached equation images. +$webworkDirs{equationCache} = "$webworkDirs{htdocs_temp}/equations"; +$webworkURLs{equationCache} = "$webworkURLs{htdocs_temp}/equations"; + +# Contains context-sensitive help files. +$webworkDirs{local_help} = "$webworkDirs{htdocs}/helpFiles"; +$webworkURLs{local_help} = "$webworkURLs{htdocs}/helpFiles"; + +# URL of general WeBWorK documentation. +$webworkURLs{docs} = "http://webhost.math.rochester.edu/webworkdocs/docs"; + +# URL of WeBWorK Bugzilla database. +$webworkURLs{bugReporter} = "http://bugs.webwork.rochester.edu/"; + +# Location of CSS +#$webworkURLs{stylesheet} = "$webworkURLs{htdocs}/css/ur.css"; +$webworkURLs{stylesheet} = "$webworkURLs{htdocs}/css/${defaultTheme}.css"; + +# Location of jsMath script, used for the jsMath display mode. +$webworkURLs{jsMath} = "$webworkURLs{htdocs}/jsMath/jsMath-ww.js"; + +# Location of ASCIIMathML script, used for the asciimath display mode. +$webworkURLs{asciimath} = "$webworkURLs{htdocs}/ASCIIMathML/ASCIIMathML.js"; + +# Location of LaTeXMathML script, used for the LaTeXMathML display mode. +$webworkURLs{LaTeXMathML} = "$webworkURLs{htdocs}/LaTeXMathML/LaTeXMathML.js"; + +################################################################################ +# Defaults for course-specific locations (directories and URLs) +################################################################################ + +# The root directory of the current course. (The ID of the current course is +# available in $courseName.) +$courseDirs{root} = "$webworkDirs{courses}/$courseName"; + +# Location of course-specific data files. +$courseDirs{DATA} = "$courseDirs{root}/DATA"; + +# Location of course HTML files, passed to PG. +$courseDirs{html} = "$courseDirs{root}/html"; +$courseURLs{html} = "$webwork_courses_url/$courseName"; + +# Location of course image files, passed to PG. +$courseDirs{html_images} = "$courseDirs{html}/images"; + +# Location of web-accessible, course-specific temporary files, like static and +# dynamically-generated PG graphics. +$courseDirs{html_temp} = "$courseDirs{html}/tmp"; +$courseURLs{html_temp} = "$courseURLs{html}/tmp"; + +# Location of course-specific logs, like the transaction log. +$courseDirs{logs} = "$courseDirs{root}/logs"; + +# Location of scoring files. +$courseDirs{scoring} = "$courseDirs{root}/scoring"; + +# Location of PG templates and set definition files. +$courseDirs{templates} = "$courseDirs{root}/templates"; + +# Location of course-specific macro files. +$courseDirs{macros} = "$courseDirs{templates}/macros"; + +# Location of mail-merge templates. +$courseDirs{email} = "$courseDirs{templates}/email"; + +# Location of temporary editing files. +$courseDirs{tmpEditFileDir} = "$courseDirs{templates}/tmpEdit"; + +# If this is set to a non-empty value (i.e. in course.conf), WeBWorK's usual +# email feedback mechanism will be replaced with a link to the given URL. +# See also $feedback_button_name, above. +$courseURLs{feedbackURL} = ""; + +# mail merge status directory +$courseDirs{mailmerge} = "$courseDirs{DATA}/mailmerge"; + +################################################################################ +# System-wide files +################################################################################ + +# Location of this file. +$webworkFiles{environment} = "$webworkDirs{conf}/global.conf"; + +# Flat-file database used to protect against MD5 hash collisions. TeX equations +# are hashed to determine the name of the image file. There is a tiny chance of +# a collision between two TeX strings. This file allows for that. However, this +# is slow, so most people chose not to worry about it. Set this to "" if you +# don't want to use the equation cache file. +$webworkFiles{equationCacheDB} = ""; # "$webworkDirs{DATA}/equationcache"; + +##### Hardcopy snippets are used in constructing a TeX file for hardcopy output. +##### They should contain TeX code unless otherwise noted. + +# The preamble is the first thing in the TeX file. +$webworkFiles{hardcopySnippets}{preamble} = "$webworkDirs{conf}/snippets/hardcopyPreamble.tex"; + +# The setHeader preceeds each set. It is a PG file. +$webworkFiles{hardcopySnippets}{setHeader} = "$webworkDirs{conf}/snippets/setHeader.pg"; # hardcopySetHeader.pg", + +# The problem divider goes between problems. +$webworkFiles{hardcopySnippets}{problemDivider} = "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex"; + +# The set footer goes after each set. Is is a PG file. +$webworkFiles{hardcopySnippets}{setFooter} = "$webworkDirs{conf}/snippets/hardcopySetFooter.pg"; + +# The set divider goes between sets (in multiset output). +$webworkFiles{hardcopySnippets}{setDivider} = "$webworkDirs{conf}/snippets/hardcopySetDivider.tex"; + +# The user divider does between users (in multiuser output). +$webworkFiles{hardcopySnippets}{userDivider} = "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex"; + +# The postabmle is the last thing in the TeX file. +$webworkFiles{hardcopySnippets}{postamble} = "$webworkDirs{conf}/snippets/hardcopyPostamble.tex"; + +##### Screen snippets are used when displaying problem sets on the screen. + +# The set header is displayed on the problem set page. It is a PG file. +$webworkFiles{screenSnippets}{setHeader} = "$webworkDirs{conf}/snippets/setHeader.pg"; # screenSetHeader.pg" + +# A PG template for creation of new problems. +$webworkFiles{screenSnippets}{blankProblem} = "$webworkDirs{conf}/snippets/blankProblem.pg"; # screenSetHeader.pg" -%webworkFiles = ( - environment => "$webworkDirs{conf}/global.conf", - hardcopySnippets => { - preamble => "$webworkDirs{conf}/snippets/hardcopyPreamble.tex", - setHeader => "$webworkDirs{conf}/snippets/hardcopySetHeader.pg", - problemDivider => "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex", - setFooter => "$webworkDirs{conf}/snippets/hardcopySetFooter.pg", - setDivider => "$webworkDirs{conf}/snippets/hardcopySetDivider.tex", - userDivider => "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex", - postamble => "$webworkDirs{conf}/snippets/hardcopyPostamble.tex", +# A site info "message of the day" file +$webworkFiles{site_info} = "$webworkDirs{htdocs}/site_info.txt"; + +################################################################################ +# Course-specific files +################################################################################ + +# The course configuration file. +$courseFiles{environment} = "$courseDirs{root}/course.conf"; + +# The course simple configuration file (holds web-based configuratoin). +$courseFiles{simpleConfig} = "$courseDirs{root}/simple.conf"; + +# File contents are displayed after login, on the problem sets page. Path given +# here is relative to the templates directory. +$courseFiles{course_info} = "course_info.txt"; + +# File contents are displayed on the login page. Path given here is relative to +# the templates directory. +$courseFiles{login_info} = "login_info.txt"; + +# Additional library buttons can be added to the Library Browser (SetMaker.pm) +# by adding the libraries you want to the following line. For each key=>value +# in the list, if a directory (or link to a directory) with name 'key' appears +# in the templates directory, then a button with name 'value' will be placed at +# the top of the problem browser. (No button will appear if there is no +# directory or link with the given name in the templates directory.) For +# example, +# +# $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"}; +# +# would add two buttons, one for the Rochester library and one for the ASU +# library, provided templates/rochester and templates/asu exists either as +# subdirectories or links to other directories. +# +$courseFiles{problibs} = { +# rochesterLibrary => "Rochester", +# asuLibrary => "Arizona State", +# dcdsLibrary => "Detroit CDS", +# dartmouthLibrary => "Dartmouth", +# indianaLibrary => "Indiana", +# osuLibrary => "Ohio State", +# capaLibrary => "CAPA", +}; + +################################################################################ +# Status system +################################################################################ + +# This is the default status given to new students and students with invalid +# or missing statuses. +$default_status = "Enrolled"; + +# The first abbreviation in the abbreviations list is the canonical +# abbreviation, and will be used when setting the status value in a user record +# or an exported classlist file. +# +# Results are undefined if more than one status has the same abbreviation. +# +# The four behaviors that are controlled by status are: +# allow_course_access => is this user allowed to log in? +# include_in_assignment => is this user included when assigning as set to "all" users? +# include_in_stats => is this user included in statistical reports? +# include_in_email => is this user included in emails sent to the class? +# include_in_scoring => is this user included in score reports? + +%statuses = ( + Enrolled => { + abbrevs => [qw/ C c current enrolled /], + behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email include_in_scoring /], + }, + Audit => { + abbrevs => [qw/ A a audit /], + behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email /], }, - screenSnippets => { - setHeader => "$webworkDirs{conf}/snippets/setHeader.pg", + Drop => { + abbrevs => [qw/ D d drop withdraw /], + behaviors => [qw/ /], }, - logs => { - timing => "$webworkDirs{logs}/timing.log", + Proctor => { + abbrevs => [qw/ P p proctor /], + behaviors => [qw/ /], }, - equationCacheDB => "$webworkDirs{DATA}/equationcache", ); -%webworkURLs = ( - root => "$webworkURLRoot", - home => "/webwork2_files/index.html", - htdocs => "/webwork2_files", - htdocs_temp => "/webwork2_files/tmp", - equationCache => "/webwork2_files/tmp/equations", - docs => "http://webhost.math.rochester.edu/webworkdocs/docs", - oldProf => "/webwork-old/profLogin.pl", -); +################################################################################ +# Database options +################################################################################ + +# these variables are used by database.conf. we define them here so that editing +# database.conf isn't necessary. +$database_dsn = "dbi:mysql:webwork"; +$database_username = "webworkWrite"; +$database_password = ""; +$database_debug = 0; + +# Variables for sql_moodle database layout. +$moodle_dsn = "dbi:mysql:moodle"; +$moodle_username = $database_username; +$moodle_password = $database_password; +$moodle_table_prefix = "mdl_"; +$moodle17 = 0; + +# Several database are defined in the file conf/database.conf and stored in the +# hash %dbLayouts. +include "conf/database.conf"; + +# Select the default database layout. This can be overridden in the course.conf +# file of a particular course. The only database layout supported in WW 2.1.4 +# and up is "sql_single". +$dbLayoutName = "sql_single"; + +# This sets the symbol "dbLayout" as an alias for the selected database layout. +*dbLayout = $dbLayouts{$dbLayoutName}; ################################################################################ -# Default course-specific settings +# Problem library options ################################################################################ -my $courseRoot = "$webworkDirs{courses}/$courseName"; -%courseDirs = ( - root => "$courseRoot", - DATA => "$courseRoot/DATA", - auth_DATA => "$courseRoot/DATA/.auth", - html => "$courseRoot/html", - html_images => "$courseRoot/html/images", - html_temp => "$courseRoot/html/tmp", - logs => "$courseRoot/logs", - scoring => "$courseRoot/scoring", - templates => "$courseRoot/templates", - macros => "$courseRoot/templates/macros", - email => "$courseRoot/templates/email", -); +# For configuration instructions, see: +# http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/DatabaseProblemLibrary -%courseFiles = ( - environment => "$courseDirs{root}/course.conf", - motd => "$courseDirs{root}/motd.txt", - logs => { - answer_log => "$courseDirs{logs}/answer_log", - }, - course_info => "$courseDirs{root}/course_info.txt", - login_info => "$courseDirs{root}/login_info.txt", -); +# The directory containing the problem library files. Set to "" if no problem +# library is installed. +$problemLibrary{root} = ""; -# quick hack to fix transaction logging. blah. -$webworkFiles{logs}->{transaction} = "$courseDirs{logs}/transaction.log"; -$webworkFiles{logs}->{pastAnswerList} = "$courseDirs{logs}/past_answers.log"; - -my $courseURLRoot = "$webworkURLs{htdocs}/courses/$courseName"; -%courseURLs = ( - root => "$courseURLRoot", - html => "$courseURLRoot", - html_temp => "$courseURLRoot/tmp", -); +# Problem Library version +# Version 1 is in use. Version 2 will be released soon. +$problemLibrary{version} = "2"; + +# The name of the SQL database containing problem metadata +$problemLibrary{sourceSQL} = "ProblemLibrary"; + +# The user name to use when connecting to the problem library database +$problemLibrary{userSQL} = $database_username; + +# The password to use when connecting to the problem library database +$problemLibrary{passwordSQL} = $database_password; ################################################################################ -# Other site-specific options +# Logs ################################################################################ -%mail = ( - smtpServer => "mail.math.rochester.edu", - smtpSender => "webwork\@math.rochester.edu", - # allowedRecipients defines addresses that the PG system is allowed to - # send mail to. this prevents subtle PG exploits. This should be set - # in course.conf to the addresses of professors of each course. Sending - # mail from the PG system (i.e. questionaires, essay questions) will - # fail if this is not set somewhere (either here or in course.conf). - #allowedRecipients => [ - # "yourname\@host.yourdomain.edu", - #], - # if defined, feedbackRecipients overrides the list of recipients for - # feedback email. It's appropriate to set this in the course.conf for - # specific courses, but probably not in global.conf. if not defined, - # mail is sent to all professors and TAs for a given course - #feedbackRecipients => [ - # "prof1\@host.yourdomain.edu", - # "prof2\@host.yourdomain.edu", - #], - # feedbackVerbosity: - # 0: send only the feedback comment and context link - # 1: as in 0, plus user, set, problem, and PG data - # 2: as in 1, plus the problem environment (debugging data) - feedbackVerbosity => 1, - editor_window_rows => 15, - editor_window_columns => 100, -); +# FIXME: take logs out of %webworkFiles/%courseFiles and give them their own +# top-level hash. -%externalPrograms = ( - mkdir => "/bin/mkdir", - tth => "/usr/local/bin/tth", - pdflatex => "/usr/local/bin/pdflatex", - latex => "/usr/local/bin/latex", - #dvipng => "/usr/local/bin/dvipng -mode ljfivemp -D600 -Q6 -x1000.5 -bgTransparent", - dvipng => "/usr/local/bin/dvipng", - gif2eps => "$webworkDirs{bin}/gif2eps", - png2eps => "$webworkDirs{bin}/png2eps", - gif2png => "$webworkDirs{bin}/gif2png", -); +# Logs data about how long it takes to process problems. (Do not confuse this +# with the /other/ timing log which can be set by WeBWorK::Timing and is used +# for benchmarking system performance in general. At some point, this timing +# mechanism will be deprecated in favor of the WeBWorK::Timing mechanism.) +$webworkFiles{logs}{timing} = "$webworkDirs{logs}/timing.log"; + +# Logs courses created via the web-based Course Administration module. +$webworkFiles{logs}{hosted_courses} = "$webworkDirs{logs}/hosted_courses.log"; + +# The transaction log contains data from each recorded answer submission. This +# is useful if the database becomes corrupted. +$webworkFiles{logs}{transaction} = "$webworkDirs{logs}/$coursename_transaction.log"; + +# The answer log stores a history of all users' submitted answers. +$courseFiles{logs}{answer_log} = "$courseDirs{logs}/answer_log"; + +# Log logins. +$courseFiles{logs}{login_log} = "$courseDirs{logs}/login.log"; + +# Log for almost every click. By default it is the empty string, which +# turns this log off. If you want it turned on, we suggest +# "$courseDirs{logs}/activity.log" +# When turned on, this log can get quite large. +$courseFiles{logs}{activity_log} = ''; ################################################################################ -# Frontend options +# Site defaults (FIXME: what other things could be "site defaults"?) ################################################################################ -%templates = ( - system => "$webworkDirs{conf}/templates/ur.template", -); +# Set the default timezone of courses on this server. To get a list of valid +# timezones, run: +# +# perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names' +# +# To get a list of valid timezone "links" (deprecated names), run: +# +# perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links' +# +# If left blank, the system timezone will be used. This is usually what you +# want. You might want to set this if your server is NOT in the same timezone as +# your school. If just a few courses are in a different timezone, set this in +# course.conf for the affected courses instead. +# +$siteDefaults{timezone} = ""; + +# The default_templates_course is used by default to create a new course. +# The contents of the templates directory are copied from this course +# to the new course being created. +$siteDefaults{default_templates_course} ="modelCourse"; ################################################################################ -# Database options +# Theme ################################################################################ -# Several database layouts are defined in separate environment files. Select the -# one which should be used by all courses by default, and include it. This can -# be overridden by including a difference environment file in the course.conf of -# a particular course. - -# Include sql.conf to specify a database layout for use with an SQL server. -#include "conf/sql.conf"; - -# Include gdbm.conf to specify a database layout for WeBWorK 1.x compatible GDBM -# databases. Use this layout if you wish to share courses between WeBWorK 1.x -# and WeBWorK 2. -include "conf/gdbm.conf"; +$defaultTheme = "math"; +$defaultThemeTemplate = "system"; + +################################################################################ +# Authentication system +################################################################################ -# Please read the documentation in the file that you chose to include, as there -# are layout-specific options that must be configured. +# FIXME This mechanism is a little awkward and probably should be merged with +# the dblayout selection system somehow. + +# Select the authentication module to use for normal logins. +# +# If this value is a string, the given authentication module will be used +# regardless of the database layout. If it is a hash, the database layout name +# will be looked up in the hash and the resulting value will be used as the +# authentication module. The special hash key "*" is used if no entry for the +# current database layout is found. +# +$authen{user_module} = { + sql_moodle => "WeBWorK::Authen::Moodle", + "*" => "WeBWorK::Authen", +}; + +# Select the authentication module to use for proctor logins. +# +# A string or a hash is accepted, as above. +# +$authen{proctor_module} = "WeBWorK::Authen::Proctor"; + +# Options for particular authentication modules + +$authen{moodle_options} = { + dsn => $moodle_dsn, + username => $moodle_username, + password => $moodle_password, + table_prefix => $moodle_table_prefix, + moodle17 => $moodle17, +}; + +$authen{ldap_options} = { + # hosts to attempt to connect to, in order. for example: + # auth.myschool.edu -- uses LDAP scheme and port 389 + # ldap://auth.myschool.edu:666 -- non-standard port + # ldaps://auth.myschool.edu -- uses LDAPS scheme and port 636 + # ldaps://auth.myschool.edu:389 -- SSL on non-SSL port + net_ldap_hosts => [ + "ldaps://corona-dmc.its.rochester.edu", + "ldaps://corona-dmb.acs.rochester.edu", + ], + # connection options + net_ldap_options => { + timeout => 30, + version => 3, + }, + # base to use when searching for user's DN + net_ldap_base => "ou=people,dc=rochester,dc=edu", + # If LDAP rejects password, check it against the WeBWorK password database + failover => 1, +}; ################################################################################ # Authorization system ################################################################################ -# This lets you specify a minimum permission level needed to perform certain -# actions. In the current system, >=10 will allow a professor to perform the -# action, >=5 will allow a TA to, and >=0 will allow a student to perform an -# action (almost never what you want). -my $ta = 5; -my $professor = 10; -%permissionLevels = ( - become_student => $professor, - access_instructor_tools => $ta, - create_and_delete_problem_sets => $professor, - modify_problem_sets => $professor, - assign_problem_sets => $professor, - modify_student_data => $professor, - score_sets => $professor, - send_mail => $professor, - modify_classlist_files => $professor, - modify_set_def_files => $professor, +# this section lets you define which groups of users can perform which actions. + +# this hash maps a numeric permission level to the name of a role. the number +# assigned to a role is significant -- roles with higher numbers are considered +# "more privileged", and are included when that role is listed for a privilege +# below. +# +%userRoles = ( + guest => -5, + student => 0, + login_proctor => 2, + grade_proctor => 3, + ta => 5, + professor => 10, ); +# this hash maps operations to the roles that are allowed to perform those +# operations. the role listed and any role with a higher permission level (in +# the %userRoles hash) will be allowed to perform the operation. If the role +# is undefined, no users will be allowed to perform the operation. +# +%permissionLevels = ( + login => "guest", + report_bugs => "student", + submit_feedback => "student", + change_password => "student", + change_email_address => "student", + + proctor_quiz_login => "login_proctor", + proctor_quiz_grade => "grade_proctor", + view_proctored_tests => "ta", + view_hidden_work => "ta", + + view_multiple_sets => "ta", + view_unopened_sets => "ta", + view_unpublished_sets => "ta", + view_answers => "ta", + view_ip_restricted_sets => "ta", + + become_student => "professor", + access_instructor_tools => "ta", + score_sets => "professor", + send_mail => "professor", + receive_feedback => "ta", + + create_and_delete_problem_sets => "professor", + assign_problem_sets => "professor", + modify_problem_sets => "professor", + modify_student_data => "professor", + modify_classlist_files => "professor", + modify_set_def_files => "professor", + modify_scoring_files => "professor", + modify_problem_template_files => "professor", + manage_course_files => "professor", + + create_and_delete_courses => "professor", + fix_course_databases => "professor", + + ##### Behavior of the interactive problem processor ##### + + show_correct_answers_before_answer_date => "ta", + show_solutions_before_answer_date => "ta", + avoid_recording_answers => "ta", + # Below this level, old answers are never initially shown + can_show_old_answers_by_default => "student", + # at this level, we look at showOldAnswers for default value + # even after the due date + can_always_use_show_old_answers_default => "professor", + check_answers_before_open_date => "ta", + check_answers_after_open_date_with_attempts => "ta", + check_answers_after_open_date_without_attempts => "guest", + check_answers_after_due_date => "guest", + check_answers_after_answer_date => "guest", + record_answers_when_acting_as_student => undef, + # "record_answers_when_acting_as_student" takes precedence + # over the following for professors acting as students: + record_answers_before_open_date => undef, + record_answers_after_open_date_with_attempts => "student", + record_answers_after_open_date_without_attempts => undef, + record_answers_after_due_date => undef, + record_answers_after_answer_date => undef, + dont_log_past_answers => "professor", + # does the user get to see a dump of the problem? + view_problem_debugging_info => "ta", + + ##### Behavior of the Hardcopy Processor ##### + + download_hardcopy_multiuser => "ta", + download_hardcopy_multiset => "ta", + download_hardcopy_format_pdf => "guest", + download_hardcopy_format_tex => "ta", +); + +# This is the default permission level given to new students and students with +# invalid or missing permission levels. +$default_permission_level = $userRoles{student}; + ################################################################################ # Session options ################################################################################ @@ -219,10 +701,10 @@ $sessionKeyTimeout = 60*30; # $sessionKeyLength defines the length (in characters) of the session key -$sessionKeyLength = 40; +$sessionKeyLength = 32; # @sessionKeyChars lists the legal session key characters -@sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9', '.', '^', '/', '!', '*'); +@sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9'); # Practice users are users who's names start with $practiceUser # (you can comment this out to remove practice user support) @@ -234,88 +716,216 @@ # password. Come to think of it, why do we even have this?! #$debugPracticeUser = "practice666"; +# Option for gateway tests; $gatewayGracePeriod is the time in seconds +# after the official due date during which we'll still grade the test +$gatewayGracePeriod = 120; + ################################################################################ -# PG translation options +# PG subsystem options ################################################################################ -%pg = ( - # options for various renderers - renderers => { - "WeBWorK::PG::Remote" => { - proxy => "http://localhost:21000/RenderD" - } - }, - # currently selected renderer - renderer => "WeBWorK::PG::Local", - #renderer => "WeBWorK::PG::Remote", - # directories used by PG - directories => { - # directories used only by PG - lib => "$pgRoot/lib", - macros => "$pgRoot/macros", - }, - options => { - # default translation options - displayMode => "images", - showOldAnswers => 1, - showCorrectAnswers => 0, - showHints => 0, - showSolutions => 0, - catchWarnings => 0, # there's a global warning catcher now - # default grader - grader => "avg_problem_grader", - }, - # this will be customized in the course.conf file - specialPGEnvironmentVars => { - PRINT_FILE_NAMES_FOR => [ qw(gage apizer voloshin lr003k professor) ], - CAPA_Tools => "$courseDirs{macros}/CAPA_Tools/", - CAPA_MCTools => "$courseDirs{macros}/CAPA_MCTools/", - CAPA_Graphics_URL => "$courseDirs{html}/CAPA_Graphics/", - CAPA_GraphicsDirectory => "$courseDirs{html}CAPA_Graphics/", - }, - # modules lists module names and the packages each contains - modules => [ - [qw(DynaLoader)], - [qw(Exporter)], - [qw(GD)], - - [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand)], - [qw(AnswerHash AnswerEvaluator)], - [qw(WWPlot)], # required by Circle (and others) - [qw(Circle)], - [qw(Complex)], - [qw(Complex1)], - [qw(Distributions)], - [qw(Fraction)], - [qw(Fun)], - [qw(Hermite)], - [qw(Label)], - [qw(List)], - [qw(Match)], - [qw(MatrixReal1)], # required by Matrix - [qw(Matrix)], - [qw(Multiple)], - [qw(PGrandom)], - [qw(Regression)], - [qw(Select)], - [qw(Units)], - [qw(VectorField)], - ], - # defaults used by answer evaluators - ansEvalDefaults => { - functAbsTolDefault => .001, - functLLimitDefault => .0000001, - functMaxConstantOfIntegration => 1E8, - functNumOfPoints => 3, - functRelPercentTolDefault => .1, - functULimitDefault => .9999999, - functVarDefault => "x", - functZeroLevelDefault => 1E-14, - functZeroLevelTolDefault => 1E-12, - numAbsTolDefault => .001, - numFormatDefault => "", - numRelPercentTolDefault => .1, - numZeroLevelDefault => 1E-14, - numZeroLevelTolDefault => 1E-12, +# List of enabled display modes. Comment out any modes you don't wish to make +# available for use. +$pg{displayModes} = [ + "plainText", # display raw TeX for math expressions + "formattedText", # format math expressions using TtH + "images", # display math expressions as images generated by dvipng + "jsMath", # render TeX math expressions on the client side using jsMath + "asciimath", # render TeX math expressions on the client side using ASCIIMathML + "LaTeXMathML", # render TeX math expressions on the client side using LaTeXMathML +]; + +#### Default settings for the PG translator + +# Default display mode. Should be listed above. +$pg{options}{displayMode} = "images"; + +# The default grader to use, if a problem doesn't specify. +$pg{options}{grader} = "avg_problem_grader"; + +# Fill in answer blanks with the student's last answer by default? +$pg{options}{showOldAnswers} = 1; + +# Show correct answers (when allowed) by default? +$pg{options}{showCorrectAnswers} = 0; + +# Show hints (when allowed) by default? +$pg{options}{showHints} = 0; + +# Show solutions (when allowed) by default? +$pg{options}{showSolutions} = 0; + +# Catch translation warnings internally by default? (We no longer need to do +# this, since there is a global warnings handler. So this should be off.) +$pg{options}{catchWarnings} = 0; + +##### Currently-selected renderer + +# Only the local renderer is supported in this version. +$pg{renderer} = "WeBWorK::PG::Local"; + +# The remote renderer connects to an XML-RPC PG rendering server. +#$pg{renderer} = "WeBWorK::PG::Remote"; + +##### Renderer-dependent options + +# The remote renderer has one option: +$pg{renderers}{"WeBWorK::PG::Remote"} = { + # The "proxy" server to connect to for remote rendering. + proxy => "http://localhost:21000/RenderD", +}; + +##### Settings for various display modes + +# "images" mode has several settings: +$pg{displayModeOptions}{images} = { + # Determines the method used to align images in output. Can be + # "baseline", "absmiddle", or "mysql". + dvipng_align => 'mysql', + + # If mysql is chosen, this information indicates which database contains the + # 'depths' table. Since 2.3.0, the depths table is kept in the main webwork + # database. (If you are upgrading from an earlier version of webwork, and + # used the mysql method in the past, you should move your existing 'depths' + # table to the main database.) + dvipng_depth_db => { + dbsource => $database_dsn, + user => $database_username, + passwd => $database_password, }, -); +}; + +$pg{displayModeOptions}{jsMath} = { + reportMissingFonts => 0, # set to 1 to allow the missing font message + missingFontMessage => undef, # set to an HTML string to replace the missing font message + noImageFonts => 0, # set to 1 if you didn't install the jsMath image fonts + processDoubleClicks => 1, # set to 0 to disable double-click on math to get TeX source +}; + +##### Directories used by PG + +# The root of the PG directory tree (from pg_root in Apache config). +$pg{directories}{root} = "$pg_dir"; +$pg{directories}{lib} = "$pg{directories}{root}/lib"; +$pg{directories}{macros} = "$pg{directories}{root}/macros"; + +# +# The macro file search path. Each directory in this list is seached +# (in this order) by loadMacros() when it looks for a .pl file. +# +$pg{directories}{macrosPath} = [ + ".", # search the problem file's directory + $courseDirs{macros}, + $pg{directories}{macros}, +]; + +# The applet search path. If a full URL is given, it is used unmodified. If an +# absolute path is given, the URL of the local server is prepended to it. +# +# For example, if an item is "/math/applets", +# and the local server is "https://math.yourschool.edu", +# then the URL "https://math.yourschool.edu/math/applets" will be used. +# +$pg{directories}{appletPath} = [ # paths to search for applets (requires full url) + "$webworkURLs{htdocs}/applets", + "$courseURLs{html}/applets", +]; + +##### "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.) + +# Users for whom to print the file name of the PG file being processed. +$pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_FOR} = [ "professor", ]; + +# Locations of CAPA resources. (Only necessary if you need to use converted CAPA +# problems.) +$pg{specialPGEnvironmentVars}{CAPA_Tools} = "$courseDirs{macros}/CAPA_Tools/", +$pg{specialPGEnvironmentVars}{CAPA_MCTools} = "$courseDirs{macros}/CAPA_MCTools/", +$pg{specialPGEnvironmentVars}{CAPA_GraphicsDirectory} = "$courseDirs{html}/CAPA_Graphics/", +$pg{specialPGEnvironmentVars}{CAPA_Graphics_URL} = "$courseURLs{html}/CAPA_Graphics/", + +# Size in pixels of dynamically-generated images, i.e. graphs. +$pg{specialPGEnvironmentVars}{onTheFlyImageSize} = 400, + +# To disable the Parser-based versions of num_cmp and fun_cmp, and use the +# original versions instead, set this value to 1. +$pg{specialPGEnvironmentVars}{useOldAnswerMacros} = 0; + +# Strings to insert at the start and end of the body of a problem +# (at beginproblem() and ENDDOCUMENT) in various modes. More display modes +# can be added if different behaviours are desired (e.g., HTML_dpng, +# HTML_asciimath, etc.). These parts are not used in the Library browser. + +$pg{specialPGEnvironmentVars}{problemPreamble} = { TeX => '', HTML=> '' }; +$pg{specialPGEnvironmentVars}{problemPostamble} = { TeX => '', HTML=>'' }; + +# To have the problem body indented and boxed, uncomment: + +# $pg{specialPGEnvironmentVars}{problemPreamble}{HTML} = '
+#
'; +# $pg{specialPGEnvironmentVars}{problemPostamble}{HTML} = '
+#
'; + +##### PG modules to load + +# The first item of each list is the module to load. The remaining items are +# additional packages to import. + +${pg}{modules} = [ + [qw(DynaLoader)], + [qw(Exporter)], + [qw(GD)], + + [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand utf8)], + [qw(AnswerHash AnswerEvaluator)], + [qw(WWPlot)], # required by Circle (and others) + [qw(Circle)], + [qw(Complex)], + [qw(Complex1)], + [qw(Distributions)], + [qw(Fraction)], + [qw(Fun)], + [qw(Hermite)], + [qw(Label)], + [qw(List)], + [qw(Match)], + [qw(MatrixReal1)], # required by Matrix + [qw(Matrix)], + [qw(Multiple)], + [qw(PGrandom)], + [qw(Regression)], + [qw(Select)], + [qw(Units)], + [qw(VectorField)], + [qw(Parser Value)], + [qw(Parser::Legacy)], +]; + +##### Answer evaluatior defaults + +$pg{ansEvalDefaults} = { + functAbsTolDefault => .001, + functLLimitDefault => .0000001, + functMaxConstantOfIntegration => 1E8, + functNumOfPoints => 3, + functRelPercentTolDefault => .1, + functULimitDefault => .9999999, + functVarDefault => "x", + functZeroLevelDefault => 1E-14, + functZeroLevelTolDefault => 1E-12, + numAbsTolDefault => .001, + numFormatDefault => "", + numRelPercentTolDefault => .1, + numZeroLevelDefault => 1E-14, + numZeroLevelTolDefault => 1E-12, + useBaseTenLog => 0, + defaultDisplayMatrixStyle => "[s]", +}; + +################################################################################ +# Compatibility +################################################################################ + +# Define the old names for the various "root" variables. +$webworkRoot = $webworkDirs{root}; +$webworkURLRoot = $webworkURLs{root}; +$pgRoot = $pg{directories}{root};