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