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