1: # The LearningOnline Network with CAPA
2: # The LON-CAPA Homework handler
3: #
4: # $Id: lonhomework.pm,v 1.88 2002/09/16 20:39:39 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: # Guy Albertelli
29: # 11/30 Gerd Kortemeyer
30: # 6/1,8/17,8/18 Gerd Kortemeyer
31: # 7/18 Jeremy Bowers
32:
33: package Apache::lonhomework;
34: use strict;
35: use Apache::style();
36: use Apache::lonxml();
37: use Apache::lonnet();
38: use Apache::lonplot();
39: use Apache::inputtags();
40: use Apache::structuretags();
41: use Apache::randomlabel();
42: use Apache::response();
43: use Apache::hint();
44: use Apache::outputtags();
45: use Apache::caparesponse();
46: use Apache::radiobuttonresponse();
47: use Apache::optionresponse();
48: use Apache::imageresponse();
49: use Apache::essayresponse();
50: use Apache::externalresponse();
51: use Apache::Constants qw(:common);
52: use HTML::Entities();
53: use Apache::loncommon();
54: #use Time::HiRes qw( gettimeofday tv_interval );
55:
56: BEGIN {
57: &Apache::lonxml::register_insert();
58: }
59:
60: sub get_target {
61: if ( $ENV{'request.state'} eq "published") {
62: if ( defined($ENV{'form.grade_target'})
63: && ($Apache::lonhomework::viewgrades == 'F' )) {
64: return ($ENV{'form.grade_target'});
65: }
66: if ( defined($ENV{'form.submitted'})) {
67: return ('grade', 'web');
68: } else {
69: return ('web');
70: }
71: } elsif ($ENV{'request.state'} eq "construct") {
72: if ( defined($ENV{'form.grade_target'}) ) {
73: return ($ENV{'form.grade_target'});
74: }
75: if ( defined($ENV{'form.preview'})) {
76: if ( defined($ENV{'form.submitted'})) {
77: return ('grade', 'web');
78: } else {
79: return ('web');
80: }
81: } else {
82: if ( $ENV{'form.problemmode'} eq 'View' ||
83: $ENV{'form.problemmode'} eq 'Discard Edits and View') {
84: if ( defined($ENV{'form.submitted'}) &&
85: (!defined($ENV{'form.resetdata'})) ) {
86: return ('grade', 'web','answer');
87: } else {
88: return ('web','answer');
89: }
90: } elsif ( $ENV{'form.problemmode'} eq 'Edit' ) {
91: if ( $ENV{'form.submitted'} eq 'edit' ) {
92: if ( $ENV{'form.submit'} eq 'Submit Changes and View' ) {
93: return ('modified','web','answer');
94: } else {
95: return ('modified','edit');
96: }
97: } else {
98: return ('edit');
99: }
100: } else {
101: return ('web');
102: }
103: }
104: }
105: return ();
106: }
107:
108: sub setup_vars {
109: my ($target) = @_;
110: return ';'
111: # return ';$external::target='.$target.';';
112: }
113:
114: sub send_header {
115: my ($request)= @_;
116: $request->print(&Apache::lontexconvert::header());
117: # $request->print('<form name='.$ENV{'form.request.prefix'}.'lonhomework method="POST" action="'.$request->uri.'">');
118: }
119:
120: sub createmenu {
121: my ($which,$request)=@_;
122: if ($which eq 'grade') {
123: $request->print('<script language="JavaScript">
124: hwkmenu=window.open("/res/adm/pages/homeworkmenu.html","homeworkremote",
125: "height=350,width=150,menubar=no");
126: </script>');
127: }
128: }
129:
130: sub send_footer {
131: my ($request)= @_;
132: # $request->print('</form>');
133: $request->print(&Apache::lontexconvert::footer());
134: }
135:
136: $Apache::lonxml::browse='';
137:
138: sub check_access {
139: my ($id) = @_;
140: my $date ='';
141: my $status = '';
142: my $datemsg = '';
143: my $lastdate = '';
144: my $temp;
145: my $type;
146: my $passed;
147: &Apache::lonxml::debug("checking for part :$id:");
148: &Apache::lonxml::debug("time:".time);
149: foreach $temp ("opendate","duedate","answerdate") {
150: $lastdate = $date;
151: $date = &Apache::lonnet::EXT("resource.$id.$temp");
152: my $thistype = &Apache::lonnet::EXT("resource.$id.$temp.type");
153: if ($thistype eq 'date_interval') {
154: if ($temp eq 'opendate') {
155: $date=&Apache::lonnet::EXT("resource.$id.duedate")-$date;
156: }
157: if ($temp eq 'answerdate') {
158: $date=&Apache::lonnet::EXT("resource.$id.duedate")+$date;
159: }
160: }
161: &Apache::lonxml::debug("found :$date: for :$temp:");
162: if ($date eq '') {
163: $date = "an unknown date"; $passed = 0;
164: } elsif ($date eq 'con_lost') {
165: $date = "an indeterminate date"; $passed = 0;
166: } else {
167: if (time < $date) { $passed = 0; } else { $passed = 1; }
168: $date = localtime $date;
169: }
170: if (!$passed) { $type=$temp; last; }
171: }
172: &Apache::lonxml::debug("have :$type:$passed:");
173: if ($passed) {
174: $status='SHOW_ANSWER';
175: $datemsg=$date;
176: } elsif ($type eq 'opendate') {
177: $status='CLOSED';
178: $datemsg = "will open on $date";
179: } elsif ($type eq 'duedate') {
180: $status='CAN_ANSWER';
181: $datemsg = "is due at $date";
182: } elsif ($type eq 'answerdate') {
183: $status='CLOSED';
184: $datemsg = "was due on $lastdate, and answers will be available on $date";
185: }
186: if ($status eq 'CAN_ANSWER') {
187: #check #tries
188: my $tries = $Apache::lonhomework::history{"resource.$id.tries"};
189: my $maxtries = &Apache::lonnet::EXT("resource.$id.maxtries");
190: if ( $tries eq '' ) { $tries = '0'; }
191: if ( $maxtries eq '' ) { $maxtries = '2'; }
192: if ($tries >= $maxtries) { $status = 'CANNOT_ANSWER'; }
193: }
194:
195: if (($status ne 'CLOSED') && ($Apache::lonhomework::type eq 'exam') &&
196: (!$Apache::lonhomework::history{"resource.0.outtoken"})) {
197: return ('UNCHECKEDOUT','needs to be checked out');
198: }
199:
200:
201: &Apache::lonxml::debug("sending back :$status:$datemsg:");
202: if (($Apache::lonhomework::browse eq 'F') && ($status eq 'CLOSED')) {
203: &Apache::lonxml::debug("should be allowed to browse a resource when closed");
204: $status='CAN_ANSWER';
205: $datemsg='is closed but you are allowed to view it';
206: }
207: if ($ENV{'request.state'} eq "construct") {
208: &Apache::lonxml::debug("in construction ignoring dates");
209: $status='CAN_ANSWER';
210: $datemsg='is in under construction';
211: }
212: return ($status,$datemsg);
213: }
214:
215: sub showhash {
216: my (%hash) = @_;
217: &showhashsubset(\%hash,'');
218: return '';
219: }
220:
221: sub showhashsubset {
222: my ($hash,$keyre) = @_;
223: my $resultkey;
224: foreach $resultkey (sort keys %$hash) {
225: if ($resultkey =~ /$keyre/) {
226: if (ref($$hash{$resultkey})) {
227: if ($$hash{$resultkey} =~ /ARRAY/ ) {
228: my $string="$resultkey ---- (";
229: foreach my $elm (@{ $$hash{$resultkey} }) {
230: $string.="$elm,";
231: }
232: chop($string);
233: &Apache::lonxml::debug("$string)");
234: } else {
235: &Apache::lonxml::debug("$resultkey ---- $$hash{$resultkey}");
236: }
237: } else {
238: &Apache::lonxml::debug("$resultkey ---- $$hash{$resultkey}");
239: }
240: }
241: }
242: &Apache::lonxml::debug("\n<br />restored values^</br>\n");
243: return '';
244: }
245:
246: sub setuppermissions {
247: $Apache::lonhomework::browse= &Apache::lonnet::allowed('bre',$ENV{'request.filename'});
248: $Apache::lonhomework::viewgrades=&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'});
249: return ''
250: }
251:
252: sub setupheader {
253: my $request=$_[0];
254: if ($ENV{'browser.mathml'}) {
255: $request->content_type('text/xml');
256: } else {
257: $request->content_type('text/html');
258: }
259: if (!$Apache::lonxml::debug && ($ENV{'REQUEST_METHOD'} eq 'GET')) {
260: &Apache::loncommon::no_cache($request);
261: }
262: $request->send_http_header;
263: return OK if $request->header_only;
264: return ''
265: }
266:
267: sub handle_save_or_undo {
268: my ($request,$problem,$result) = @_;
269: my $file = &Apache::lonnet::filelocation("",$request->uri);
270: my $filebak =$file.".bak";
271: my $filetmp =$file.".tmp";
272: my $error=0;
273:
274: if ($ENV{'form.Undo'} eq 'undo') {
275: my $error=0;
276: if (!copy($file,$filetmp)) { $error=1; }
277: if ((!$error) && (!copy($filebak,$file))) { $error=1; }
278: if ((!$error) && (!move($filetmp,$filebak))) { $error=1; }
279: if (!$error) {
280: $request->print("<p><b>Undid changes, Switched $filebak and $file</b></p>");
281: } else {
282: $request->print("<p><font color=\"red\" size=\"+1\"><b>Unable to undo, unable to switch $filebak and $file</b></font></p>");
283: $error=1;
284: }
285: } else {
286: my $fs=Apache::File->new(">$filebak");
287: if (defined($fs)) {
288: print $fs $$problem;
289: $request->print("<b>Making Backup to $filebak</b><br />");
290: } else {
291: $request->print("<font color=\"red\" size=\"+1\"><b>Unable to make backup $filebak</b></font>");
292: $error=2;
293: }
294: my $fh=Apache::File->new(">$file");
295: if (defined($fh)) {
296: print $fh $$result;
297: $request->print("<b>Saving Modifications to $file</b><br />");
298: } else {
299: $request->print("<font color=\"red\" size=\"+1\"><b>Unable to write to $file</b></font>");
300: $error|=4;
301: }
302: }
303: return $error;
304: }
305:
306: sub analyze {
307: my ($request,$file) = @_;
308: &Apache::lonxml::debug("Analyze");
309: my $result=&Apache::lonnet::ssi($request->uri,('grade_target' => 'analyze'));
310: &Apache::lonxml::debug(":$result:");
311: (my $garbage,$result)=split(/_HASH_REF__/,$result,2);
312: &showhash(&Apache::lonnet::str2hash($result));
313: return $result;
314: }
315:
316: sub editxmlmode {
317: my ($request,$file) = @_;
318: my $result;
319: my $problem=&Apache::lonnet::getfile($file);
320: if ($problem == -1) {
321: &Apache::lonxml::error("<b> Unable to find <i>$file</i></b>");
322: $problem='';
323: }
324: if (defined($ENV{'form.editxmltext'}) || defined($ENV{'form.Undo'})) {
325: my $error=&handle_save_or_undo($request,\$problem,
326: \$ENV{'form.editxmltext'});
327: if (!$error) { $problem=&Apache::lonnet::getfile($file); }
328: }
329: &Apache::lonhomework::showhashsubset(\%ENV,'^form');
330: if ( $ENV{'form.submit'} eq 'Submit Changes and View' ) {
331: &Apache::lonhomework::showhashsubset(\%ENV,'^form');
332: $ENV{'form.problemmode'}='View';
333: &renderpage($request,$file);
334: } else {
335: my ($rows,$cols) = &Apache::edit::textarea_sizes(\$problem);
336: my $xml_help = Apache::loncommon::help_open_topic("Problem_Editor_XML_Index");
337: if ($cols > 80) { $cols = 80; }
338: $result.='<html><body bgcolor="#FFFFFF">
339: <form name="lonhomework" method="POST" action="'.
340: $ENV{'request.uri'}.'">
341: <input type="hidden" name="problemmode" value="EditXML" />
342: <input type="submit" name="problemmode" value="Discard Edits and View" />
343: <input type="submit" name="problemmode" value="Edit" />
344: <hr />
345: <input type="submit" name="submit" value="Submit Changes" />
346: <input type="submit" name="submit" value="Submit Changes and View" />
347: <input type="submit" name="Undo" value="undo" />
348: <hr />
349: ' . $xml_help . ' Problem Help<br>
350: <textarea rows="'.$rows.'" cols="'.$cols.'" name="editxmltext">'.
351: &HTML::Entities::encode($problem).'</textarea>
352: </form></body></html>';
353: $request->print($result);
354: }
355: return '';
356: }
357:
358: sub renderpage {
359: my ($request,$file) = @_;
360:
361: my (@targets) = &get_target();
362: &Apache::lonxml::debug("Running targets ".join(':',@targets));
363: foreach my $target (@targets) {
364: #my $t0 = [&gettimeofday()];
365: my $problem=&Apache::lonnet::getfile($file);
366: if ($problem == -1) {
367: &Apache::lonxml::error("<b> Unable to find <i>$file</i></b>");
368: $problem='';
369: }
370:
371: my %mystyle;
372: my $result = '';
373: &Apache::inputtags::initialize_inputtags;
374: &Apache::edit::initialize_edit;
375: if ($target eq 'analyze') { %Apache::lonhomework::anaylze=(); }
376: if ($target eq 'web') {
377: my ($symb)=&Apache::lonxml::whichuser();
378: if ($symb eq '') {
379: if ($ENV{'request.state'} eq "construct") {
380: } else {
381: my $help = Apache::loncommon::help_open_topic("Ambiguous_Reference");
382: $request->print("Browsing or <a href=\"/adm/ambiguous\">ambiguous</a> reference, submissions ignored $help<br />");
383: }
384: }
385: #if ($Apache::lonhomework::viewgrades eq 'F') {&createmenu('grade',$request); }
386: }
387: if ($target eq 'answer') { &showhash(%Apache::lonhomework::history); }
388: if ($target eq 'web') {&Apache::lonhomework::showhashsubset(\%ENV,'^form');}
389:
390: my $default=&Apache::lonnet::getfile('/home/httpd/html/res/adm/includes/default_homework.lcpm');
391: if ($default == -1) {
392: &Apache::lonxml::error("<b>Unable to find <i>default_homework.lcpm</i></b>");
393: $default='';
394: }
395: &Apache::lonxml::debug("Should be parsing now");
396: $result = &Apache::lonxml::xmlparse($request, $target, $problem,
397: $default.&setup_vars($target),%mystyle);
398:
399: #$request->print("Result follows:");
400: if ($target eq 'modified') {
401: &handle_save_or_undo($request,\$problem,\$result);
402: } else {
403: if ($target eq 'analyze') {
404: $result=&Apache::lonnet::hashref2str(\%Apache::lonhomework::analyze);
405: undef(%Apache::lonhomework::analyze);
406: }
407: #my $td=&tv_interval($t0);
408: #if ( $Apache::lonxml::debug) {
409: #$result =~ s:</body>::;
410: #$result.="<br />Spent $td seconds processing target $target\n</body>";
411: #}
412: $request->print($result);
413: }
414: #$request->print(":Result ends");
415: #my $td=&tv_interval($t0);
416: }
417: }
418:
419: # with no arg it returns a HTML <option> list of the template titles
420: # with one arg it returns the filename associated with the arg passed
421: sub get_template_list {
422: my ($namewanted,$extension) = @_;
423: my $result;
424: my @allnames;
425: &Apache::lonxml::debug("Looking for :$extension:");
426: foreach my $file (</home/httpd/html/res/adm/includes/templates/*.$extension>) {
427: my $name=&Apache::lonnet::metadata($file,'title');
428: if ($namewanted && ($name eq $namewanted)) {
429: $result=$file;
430: last;
431: } else {
432: push (@allnames, $name);
433: }
434: }
435: if (@allnames && !$result) {
436: $result="<option>Select a $extension type</option>\n<option>".
437: join('</option><option>',sort(@allnames)).'</option>';
438: }
439: return $result;
440: }
441:
442: sub newproblem {
443: my ($request) = @_;
444: my $extension=$request->uri;
445: $extension=~s:^.*\.([\w]+)$:$1:;
446: &Apache::lonxml::debug("Looking for :$extension:");
447: if ($ENV{'form.template'} &&
448: $ENV{'form.template'} ne "Select a $extension type") {
449: use File::Copy;
450: my $file = &get_template_list($ENV{'form.template'},$extension);
451: my $dest = &Apache::lonnet::filelocation("",$request->uri);
452: copy($file,$dest);
453: &renderpage($request,$dest);
454: } elsif($ENV{'form.newfile'}) {
455: # I don't like hard-coded filenames but for now, this will work.
456: use File::Copy;
457: my $templatefilename =
458: $request->dir_config('lonIncludes').'/templates/blank.problem';
459: &Apache::lonxml::debug("$templatefilename");
460: my $dest = &Apache::lonnet::filelocation("",$request->uri);
461: copy($templatefilename,$dest);
462: &renderpage($request,$dest);
463: } else {
464: my $templatelist=&get_template_list('',$extension);
465: my $url=$request->uri;
466: my $dest = &Apache::lonnet::filelocation("",$request->uri);
467: my $instructions;
468: if ($templatelist) { $instructions=", select a template from the pull-down menu below. Then";}
469: $request->print(<<ENDNEWPROBLEM);
470: <body bgcolor="#FFFFFF">
471: The requested file $url doesn\'t exist. <br />
472: To create a new $extension$instructions click on the Create $extension button.
473: <form action="$url" method="POST">
474: ENDNEWPROBLEM
475: if (defined($templatelist)) {
476: $request->print("<select name=\"template\">$templatelist</select>");
477: }
478: $request->print("<br /><input type=\"submit\" name=\"newfile\" value=\"Create $extension\" />");
479: $request->print("</form></body>");
480: }
481: return '';
482: }
483:
484: sub view_or_edit_menu {
485: my ($request) = @_;
486: my $url=$request->uri;
487: $request->print(<<EDITMENU);
488: <body bgcolor="#FFFFFF">
489: <form action="$url" method="POST">
490: Would you like to <input type="submit" name="problemmode" value="View"> or
491: <input type="submit" name="problemmode" value="Edit"> the problem.
492: </form>
493: </body>
494: EDITMENU
495: }
496:
497: sub handler {
498: #my $t0 = [&gettimeofday()];
499: my $request=$_[0];
500:
501: if ( $ENV{'user.name'} eq 'albertel' ) {$Apache::lonxml::debug=1;}
502:
503: if (&setupheader($request)) { return OK; }
504: $ENV{'request.uri'}=$request->uri;
505:
506: #setup permissions
507: $Apache::lonhomework::browse= &Apache::lonnet::allowed('bre',$ENV{'request.filename'});
508: $Apache::lonhomework::viewgrades=&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'});
509: &Apache::lonxml::debug("Permissions:$Apache::lonhomework::browse:$Apache::lonhomework::viewgrades:");
510: # some times multiple problemmodes are submitted, need to select
511: # the last one
512: &Apache::lonxml::debug("Problem Mode ".$ENV{'form.problemmode'});
513: if ( defined($ENV{'form.problemmode'}) &&
514: ref($ENV{'form.problemmode'}) ) {
515: &Apache::lonxml::debug("Problem Mode ".join(",",@$ENV{'form.problemmode'}));
516: my $mode=$ENV{'form.problemmode'}->[-1];
517: undef $ENV{'form.problemmode'};
518: $ENV{'form.problemmode'}=$mode;
519: }
520: &Apache::lonxml::debug("Problem Mode ".$ENV{'form.problemmode'});
521: my $file=&Apache::lonnet::filelocation("",$request->uri);
522:
523: #check if we know where we are
524: if ($ENV{'request.course.fn'} && !&Apache::lonnet::symbread()) {
525: # if we are browsing we might not be able to know where we are
526: if ($Apache::lonhomework::browse ne 'F') {
527: #should know where we are, so ask
528: $request->internal_redirect('/adm/ambiguous'); return;
529: }
530: }
531:
532: if ($ENV{'request.state'} eq "construct") {
533: if ($ENV{'form.resetdata'} eq 'Reset Submissions') {
534: my ($symb,$courseid,$domain,$name) = &Apache::lonxml::whichuser();
535: &Apache::lonnet::tmpreset($symb,'',$domain,$name);
536: }
537: if ( -e $file ) {
538: if (!(defined $ENV{'form.problemmode'})) {
539: #first visit to problem in construction space
540: #&view_or_edit_menu($request);
541: $ENV{'form.problemmode'}='View';
542: &renderpage($request,$file);
543: } elsif ($ENV{'form.problemmode'} eq 'EditXML') {
544: &editxmlmode($request,$file);
545: } elsif ($ENV{'form.problemmode'} eq 'Answer Distribution') {
546: &analyze($request,$file);
547: } else {
548: &renderpage($request,$file);
549: }
550: } else {
551: # requested file doesn't exist in contruction space
552: &newproblem($request);
553: }
554: } else {
555: # just render the page normally outside of construction space
556: &Apache::lonxml::debug("not construct");
557: &renderpage($request,$file);
558: }
559: #my $td=&tv_interval($t0);
560: #&Apache::lonxml::debug("Spent $td seconds processing");
561: # &Apache::lonhomework::send_footer($request);
562: # always turn off debug messages
563: $Apache::lonxml::debug=0;
564: return OK;
565:
566: }
567:
568: 1;
569: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>