[system] / trunk / webwork2 / lib / Apache / WeBWorK.pm Repository:
ViewVC logotype

Diff of /trunk/webwork2/lib/Apache/WeBWorK.pm

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

Revision 446 Revision 695
1# Apache::WeBWorK - The WeBWorK dispatcher module 1################################################################################
2# Place something like the following in your Apache configuration to load the 2# WeBWorK mod_perl (c) 2000-2002 WeBWorK Project
3# WeBWorK module and install it as a handler for the WeBWorK system 3# $Id$
4 4################################################################################
5# PerlRequire /path/to/webwork/conf/init.pl
6# PerlSetVar webwork_root /path/to/webwork
7# <Location /webwork>
8# SetHandler perl-script
9# PerlHandler Apache::WeBWorK
10# </Location>
11
12# In addition, you will have to edit init.pl in what should be obvious ways.
13 5
14package Apache::WeBWorK; 6package Apache::WeBWorK;
7
8=head1 NAME
9
10Apache::WeBWorK - The WeBWorK dispatcher module.
11
12=cut
15 13
16use strict; 14use strict;
17use warnings; 15use warnings;
18use Apache::Constants qw(:common REDIRECT); 16use Apache::Constants qw(:common REDIRECT);
19use Apache::Request; 17use Apache::Request;
20use WeBWorK::CourseEnvironment;
21use WeBWorK::Authen; 18use WeBWorK::Authen;
22use WeBWorK::Authz; 19use WeBWorK::Authz;
20use WeBWorK::ContentGenerator::Feedback;
21use WeBWorK::ContentGenerator::Login;
22use WeBWorK::ContentGenerator::Logout;
23use WeBWorK::ContentGenerator::Hardcopy;
24use WeBWorK::ContentGenerator::Options;
25use WeBWorK::ContentGenerator::Problem;
26use WeBWorK::ContentGenerator::ProblemSet;
27use WeBWorK::ContentGenerator::ProblemSets;
28use WeBWorK::ContentGenerator::Professor;
23use WeBWorK::ContentGenerator::Test; 29use WeBWorK::ContentGenerator::Test;
24use WeBWorK::ContentGenerator::Login; 30use WeBWorK::CourseEnvironment;
25use WeBWorK::ContentGenerator::ProblemSets;
26use WeBWorK::ContentGenerator::ProblemSet;
27use WeBWorK::ContentGenerator::Problem;
28 31
29# Sets up the common environment needed for every subsystem and then dispatches 32# This module should be installed as a Handler for the location selected for
30# the page request to the appropriate content generator. 33# WeBWorK on your webserver. Here is an example of a stanza that can be added
31 34# to your httpd.conf file to achieve this:
32# This function has MANY MANY points of exit (return statements)! woo! 35#
33# call it a quirk of my coding style. I think it makes it easier to read in this case. 36# <IfModule mod_perl.c>
37# PerlFreshRestart On
38# <Location /modperl-sam>
39# SetHandler perl-script
40# PerlSetVar webwork_root /opt/webwork
41# <Perl>
42# use lib '/opt/webwork/lib';
43# </Perl>
44# PerlHandler Apache::WeBWorK
45# </Location>
46# </IfModule>
34 47
35sub handler() { 48sub handler() {
36 my $r = Apache::Request->new(shift); # have to deal with unpredictable GET or POST data, and sift through it for the key. So use Apache::Request 49 my $r = Apache::Request->new(shift); # have to deal with unpredictable GET or POST data, and sift through it for the key. So use Apache::Request
37 50
38 # This stuff is pretty much copied out of the O'Reilly mod_perl book. 51 # This stuff is pretty much copied out of the O'Reilly mod_perl book.
39 # It's for figuring out the basepath. I may change this up if I 52 # It's for figuring out the basepath. I may change this up if I
40 # find a better way to do it. 53 # find a better way to do it.
41 my $path_info = $r->path_info; 54 my $path_info = $r->path_info || "";
42 my $path_translated = $r->lookup_uri($path_info)->filename;
43 my $current_uri = $r->uri; 55 my $current_uri = $r->uri;
44 my $args = $r->args; 56 my $args = $r->args;
57
58 $current_uri =~ m/^(.*)$path_info/;
59 my $urlRoot = $1;
45 60
46 # If it's a valid WeBWorK URI, it ends in a /. This is assumed 61 # If it's a valid WeBWorK URI, it ends in a /. This is assumed
47 # alllll over the place. 62 # alllll over the place.
48 unless (substr($current_uri,-1) eq '/') { 63 unless (substr($current_uri,-1) eq '/') {
49 $r->header_out(Location => "$current_uri/" . ($args ? "?$args" : "")); 64 $r->header_out(Location => "$current_uri/" . ($args ? "?$args" : ""));
50 return REDIRECT; 65 return REDIRECT;
66 # *** any post data gets lost here -- fix that.
51 } 67 }
52 68
53 # Create the @components array, which contains the path specified in the URL 69 # Create the @components array, which contains the path specified in the URL
54 my($junk, @components) = split "/", $path_info; 70 my($junk, @components) = split "/", $path_info;
55 my $webwork_root = $r->dir_config('webwork_root'); # From a PerlSetVar in httpd.conf 71 my $webwork_root = $r->dir_config('webwork_root'); # From a PerlSetVar in httpd.conf
56 my $course = shift @components; 72 my $course = shift @components;
57 73
74 # If no course was specified, phreak out.
75 # Eventually, display a list of courses, or something.
76 unless (defined $course) {
77 warn "No course specified.\n";
78 return DECLINED;
79 # *** we should either write a "Courses" module, or redirect to a static page.
80 }
81
58 # Try to get the course environment. 82 # Try to get the course environment.
59 my $course_env = eval {WeBWorK::CourseEnvironment->new($webwork_root, $course);}; 83 my $course_env = eval {WeBWorK::CourseEnvironment->new($webwork_root, $urlRoot, $course);};
60 if ($@) { # If there was an error getting the requested course 84 if ($@) { # If there was an error getting the requested course
61 # TODO: display an error page. For now, 404 it. 85 # TODO: display an error page. For now, 404 it.
62 warn $@; 86 warn $@;
63 return DECLINED; 87 return DECLINED;
64 } 88 }
65 89
66 # Freak out if the requested course doesn't exist. For now, this is just a 90 # Freak out if the requested course doesn't exist. For now, this is just a
67 # check to see if the course directory exists. 91 # check to see if the course directory exists.
68 if (!-e $course_env->{webworkDirs}->{courses} . "/$course") { 92 if (!-e $course_env->{webworkDirs}->{courses} . "/$course") {
93 warn "Course directory for $course not found at "
94 . $course_env->{webworkDirs}->{courses} . "/$course" ."\n";
69 return DECLINED; 95 return DECLINED;
70 } 96 }
71 97
72 ### Begin dispatching ### 98 ### Begin dispatching ###
73 99
74 # WeBWorK::Authen::verify erases the passwd field and sets the key field 100 # WeBWorK::Authen::verify erases the passwd field and sets the key field
75 # if login is successful. 101 # if login is successful.
76 if (!WeBWorK::Authen->new($r, $course_env)->verify) { 102 if (!WeBWorK::Authen->new($r, $course_env)->verify) {
103 # *** &verify should throw a descriptive exception on weird failures
77 return WeBWorK::ContentGenerator::Login->new($r, $course_env)->go; 104 return WeBWorK::ContentGenerator::Login->new($r, $course_env)->go;
78 } else { 105 } else {
79 # After we are authenticated, there are some things that need to be 106 # After we are authenticated, there are some things that need to be
80 # sorted out, Authorization-wize, before we start dispatching to individual 107 # sorted out, Authorization-wize, before we start dispatching to individual
81 # content generators. 108 # content generators.
82 my $effectiveUser = $r->param("effectiveUser");
83 my $user = $r->param("user"); 109 my $user = $r->param("user");
110 my $effectiveUser = $r->param("effectiveUser") || $user;
84 my $su_authorized = WeBWorK::Authz->new($r, $course_env)->hasPermissions($user, "become_student", $effectiveUser); 111 my $su_authorized = WeBWorK::Authz->new($r, $course_env)->hasPermissions($user, "become_student", $effectiveUser);
85 # This hoary statement has the effect of forcing effectiveUser to equal user unless 112 $effectiveUser = $user unless $su_authorized;
86 # the user is otherwise authorized.
87 if (!($user ne $effectiveUser && $su_authorized) || !defined $effectiveUser) {
88 $r->param("effectiveUser",$user); 113 $r->param("effectiveUser", $effectiveUser);
89 }
90 114
91 my $arg = shift @components; 115 my $arg = shift @components;
92 if (!defined $arg) { # We want the list of problem sets 116 if (!defined $arg) { # We want the list of problem sets
93 return WeBWorK::ContentGenerator::ProblemSets->new($r, $course_env)->go; 117 return WeBWorK::ContentGenerator::ProblemSets->new($r, $course_env)->go;
118 } elsif ($arg eq "hardcopy") {
119 my $hardcopyArgument = shift @components;
120 $hardcopyArgument = "" unless defined $hardcopyArgument;
121 # *** can i say go(shift || "") here?
122 return WeBWorK::ContentGenerator::Hardcopy->new($r, $course_env)->go($hardcopyArgument);
94 } elsif ($arg eq "prof") { 123 } elsif ($arg eq "prof") {
95 ### 124 return WeBWorK::ContentGenerator::Professor->new($r, $course_env)->go;
96 } elsif ($arg eq "prefs") { 125 } elsif ($arg eq "options") {
97 ### 126 return WeBWorK::ContentGenerator::Options->new($r, $course_env)->go;
127 } elsif ($arg eq "feedback") {
128 return WeBWorK::ContentGenerator::Feedback->new($r, $course_env)->go;
129 } elsif ($arg eq "logout") {
130 return WeBWorK::ContentGenerator::Logout->new($r, $course_env)->go;
98 } elsif ($arg eq "test") { 131 } elsif ($arg eq "test") {
132 # *** we should change this name, or remove it altogether.
99 return WeBWorK::ContentGenerator::Test->new($r, $course_env)->go; 133 return WeBWorK::ContentGenerator::Test->new($r, $course_env)->go;
100 } else { # We've got the name of a problem set. 134 } else { # We've got the name of a problem set.
101 my $problem_set = $arg; 135 my $problem_set = $arg;
102 my $ps_arg = shift @components; 136 my $ps_arg = shift @components;
103 137
104 if (!defined $ps_arg) { 138 if (!defined $ps_arg) {
105 # list the problems in the problem set 139 # list the problems in the problem set
106 return WeBWorK::ContentGenerator::ProblemSet->new($r, $course_env)->go($problem_set); 140 return WeBWorK::ContentGenerator::ProblemSet->new($r, $course_env)->go($problem_set);
107 } elsif ($ps_arg eq "hardcopy") { 141 } elsif ($ps_arg eq "hardcopy") {
108 ### 142 # *** do we need this? hardcopy is not being called this way
109 } 143 }
110 else { 144 else {
111 # We've got the name of a problem 145 # We've got the name of a problem
112 my $problem = $ps_arg; 146 my $problem = $ps_arg;
113 return WeBWorK::ContentGenerator::Problem->new($r, $course_env)->go($problem_set, $problem); 147 return WeBWorK::ContentGenerator::Problem->new($r, $course_env)->go($problem_set, $problem);
114 } 148 }
115 } 149 }
116 150
117 } 151 }
118 152
119 # If the dispatcher doesn't know any modules that want to handle 153 # If the dispatcher doesn't know any modules that want to handle
120 # the current path, it'll claim that the path does not exist by 154 # the current path, it'll claim that the path does not exist by
121 # declining the request. 155 # declining the request.
122 return DECLINED; 156 return DECLINED;
123} 157}
Legend:
Removed from v.446  
changed lines
  Added in v.695
aubreyja at gmail dot com
 ViewVC Help
Powered by ViewVC 1.0.9