[system] / branches / rel-2-4-patches / webwork-modperl / conf / global.conf.dist Repository:
ViewVC logotype

Diff of /branches/rel-2-4-patches/webwork-modperl/conf/global.conf.dist

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1089  
changed lines
  Added in v.4460

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9