[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 306 Revision 819
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# PerlModule Apache::WeBWorK
6# <Location /webwork>
7# SetHandler perl-script
8# PerlHandler Apache::WeBWorK::dispatch
9# </Location>
10 5
11package Apache::WeBWorK; 6package Apache::WeBWorK;
12 7
8=head1 NAME
9
10Apache::WeBWorK - The WeBWorK dispatcher module.
11
12=cut
13
13use strict; 14use strict;
15use warnings;
14use Apache::Constants qw(:common REDIRECT); 16use Apache::Constants qw(:common REDIRECT);
15use Apache::Request; 17use Apache::Request;
18use WeBWorK::Authen;
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;
29use WeBWorK::ContentGenerator::Test;
16use WeBWorK::CourseEnvironment; 30use WeBWorK::CourseEnvironment;
17use WeBWorK::Test; 31use WeBWorK::DB;
18use WeBWorK::Authen;
19use WeBWorK::Login;
20 32
21# registering discontent: wanted to call this dispatch, but mod_perl gave me lip 33# This module should be installed as a Handler for the location selected for
34# WeBWorK on your webserver. Here is an example of a stanza that can be added
35# to your httpd.conf file to achieve this:
36#
37# <IfModule mod_perl.c>
38# PerlFreshRestart On
39# <Location /webwork>
40# SetHandler perl-script
41# PerlHandler Apache::WeBWorK
42# PerlSetVar webwork_root /path/to/webwork-modperl
43# <Perl>
44# use lib '/path/to/webwork-modperl/lib';
45# use lib '/path/to/webwork-modperl/pglib';
46# </Perl>
47# </Location>
48# </IfModule>
49
22sub handler() { 50sub handler() {
23 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 51 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
52
53 # This stuff is pretty much copied out of the O'Reilly mod_perl book.
54 # It's for figuring out the basepath. I may change this up if I
55 # find a better way to do it.
24 my $path_info = $r->path_info; 56 my $path_info = $r->path_info || "";
25 my $path_translated = $r->lookup_uri($path_info)->filename;
26 my $current_uri = $r->uri; 57 my $current_uri = $r->uri;
27 unless ($path_info) { 58 my $args = $r->args;
59
60 $current_uri =~ m/^(.*)$path_info/;
61 my $urlRoot = $1;
62
63 # If it's a valid WeBWorK URI, it ends in a /. This is assumed
64 # alllll over the place.
65 unless (substr($current_uri,-1) eq '/') {
28 $r->header_out(Location => "$current_uri/"); 66 $r->header_out(Location => "$current_uri/" . ($args ? "?$args" : ""));
67 return REDIRECT;
68 # *** any post data gets lost here -- fix that.
69 }
70
71 # Create the @components array, which contains the path specified in the URL
72 my($junk, @components) = split "/", $path_info;
73 my $webwork_root = $r->dir_config('webwork_root'); # From a PerlSetVar in httpd.conf
74 my $course = shift @components;
75
76 # Try to get the course environment.
77 my $ce = eval {WeBWorK::CourseEnvironment->new($webwork_root, $urlRoot, $course);};
78 if ($@) { # If there was an error getting the requested course
79 # TODO: display an error page. For now, 404 it.
80 warn $@;
81 return DECLINED;
82 }
83
84 # If no course was specified, redirect to the home URL
85 unless (defined $course) {
86 $r->header_out(Location => $ce->{webworkURLs}->{home});
29 return REDIRECT; 87 return REDIRECT;
30 } 88 }
31 89
32 return OK if $r->header_only; 90 # Freak out if the requested course doesn't exist. For now, this is just a
33 my($junk, @components) = split "/", $path_info; 91 # check to see if the course directory exists.
34 my $webwork_root = $r->dir_config('webwork_root'); # From a PerlSetVar in httpd.conf 92 if (!-e $ce->{webworkDirs}->{courses} . "/$course") {
35 my $course = shift @components; 93 warn "Course directory for $course not found at "
36 # catch errors in $@ 94 . $ce->{webworkDirs}->{courses} . "/$course" ."\n";
37 my $course_env = eval {WeBWorK::CourseEnvironment->new($webwork_root, $course);};
38 if ($@) {
39 # TODO: display an error page. For now, print something mildly useful
40 return DECLINED; 95 return DECLINED;
41 } 96 }
42 97
98 # Bring up a connection to the database (for Authen/Authz, and eventually
99 # to be passed to content generators, when we clean this file up).
100 my $db = WeBWorK::DB->new($ce);
101
102 ### Begin dispatching ###
103
43 # WeBWorK::Authen::verify erases the passwd field and sets the key field 104 # WeBWorK::Authen::verify erases the passwd field and sets the key field
44 # if login is successful. 105 # if login is successful.
45 if (!WeBWorK::Authen->new($r, $course_env)->verify) { 106 if (!WeBWorK::Authen->new($r, $ce, $db)->verify) {
46 return WeBWorK::Login->new($r, $course_env)->go(); 107 return WeBWorK::ContentGenerator::Login->new($r, $ce, $db)->go;
47 } else { 108 } else {
48 if (1) { 109 # After we are authenticated, there are some things that need to be
49 return WeBWorK::Test->new($r, $course_env)->go(); 110 # sorted out, Authorization-wize, before we start dispatching to individual
111 # content generators.
112 my $user = $r->param("user");
113 my $effectiveUser = $r->param("effectiveUser") || $user;
114 my $su_authorized = WeBWorK::Authz->new($r, $ce, $db)->hasPermissions($user, "become_student", $effectiveUser);
115 $effectiveUser = $user unless $su_authorized;
116 $r->param("effectiveUser", $effectiveUser);
117
118 my $arg = shift @components;
119 if (!defined $arg) { # We want the list of problem sets
120 return WeBWorK::ContentGenerator::ProblemSets->new($r, $ce, $db)->go;
121 } elsif ($arg eq "hardcopy") {
122 my $hardcopyArgument = shift @components;
123 $hardcopyArgument = "" unless defined $hardcopyArgument;
124 return WeBWorK::ContentGenerator::Hardcopy->new($r, $ce, $db)->go($hardcopyArgument);
125 } elsif ($arg eq "prof") {
126 return WeBWorK::ContentGenerator::Professor->new($r, $ce, $db)->go;
127 } elsif ($arg eq "options") {
128 return WeBWorK::ContentGenerator::Options->new($r, $ce, $db)->go;
129 } elsif ($arg eq "feedback") {
130 return WeBWorK::ContentGenerator::Feedback->new($r, $ce, $db)->go;
131 } elsif ($arg eq "logout") {
132 return WeBWorK::ContentGenerator::Logout->new($r, $ce, $db)->go;
133 } elsif ($arg eq "test") {
134 return WeBWorK::ContentGenerator::Test->new($r, $ce, $db)->go;
135 } else { # We've got the name of a problem set.
136 my $problem_set = $arg;
137 my $ps_arg = shift @components;
138
139 if (!defined $ps_arg) {
140 # list the problems in the problem set
141 return WeBWorK::ContentGenerator::ProblemSet->new($r, $ce, $db)->go($problem_set);
142 } else {
143 # We've got the name of a problem
144 my $problem = $ps_arg;
145 return WeBWorK::ContentGenerator::Problem->new($r, $ce, $db)->go($problem_set, $problem);
146 }
50 } 147 }
148
51 } 149 }
52 150
151 # If the dispatcher doesn't know any modules that want to handle
152 # the current path, it'll claim that the path does not exist by
153 # declining the request.
53 return DECLINED; 154 return DECLINED;
54} 155}
55 156
561; 1571;
57
58__END__
59
60# if (!auth) {
61# loginpage
62# } else {
63# dispatch
64# }
65
66
67
68load some global settings for the system
69 - apparently, these are going to live in the package Global
70 - this sucks, since it's not really the global namespace
71 - but whatever.
72
73disassemble the URI to some extent
74 - we need to know the course
Legend:
Removed from v.306  
changed lines
  Added in v.819
aubreyja at gmail dot com
 ViewVC Help
Powered by ViewVC 1.0.9