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