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