File:
[LON-CAPA] /
rat /
lonpage.pm
Revision
1.59:
download - view:
text,
annotated -
select for diffs
Sun Aug 29 19:25:34 2004 UTC (19 years, 11 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
Modified message when page to be displayed is empty, or contains only hidden items. For the future: modify lonnavmaps so empty pages are not displayed in the map, and modify lonpageflip so empty pages are skipped when jumping to next resource.
1: # The LearningOnline Network with CAPA
2: # Page Handler
3: #
4: # $Id: lonpage.pm,v 1.59 2004/08/29 19:25:34 raeburn 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: # (TeX Content Handler
29: #
30: # YEAR=2000
31: # 05/29/00,05/30 Gerd Kortemeyer)
32: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
33: # 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16,
34: # YEAR=2001
35: # 08/13/01,08/30,10/1 Gerd Kortemeyer
36: # YEAR=2002
37: # 03/19 Gerd Kortemeyer
38: #
39: ###
40:
41: package Apache::lonpage;
42:
43: use strict;
44: use Apache::Constants qw(:common :http);
45: use Apache::lonnet();
46: use Apache::loncommon();
47: use Apache::lonxml();
48: use Apache::lonlocal;
49: use Apache::lonmenu;
50: use HTML::TokeParser;
51: use GDBM_File;
52: use Apache::lonsequence;
53:
54: # -------------------------------------------------------------- Module Globals
55: my %hash;
56: my @rows;
57:
58: # ------------------------------------------------------------------ Euclid gcd
59:
60: sub euclid {
61: my ($e,$f)=@_;
62: my $a; my $b; my $r;
63: if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }
64: while ($r!=0) {
65: $a=$b; $b=$r;
66: $r=$a%$b;
67: }
68: return $b;
69: }
70:
71: # ------------------------------------------------------------ Build page table
72:
73: sub tracetable {
74: my ($sofar,$rid,$beenhere)=@_;
75: my $further=$sofar;
76: my $randomout=0;
77: unless ($ENV{'request.role.adv'}) {
78: $randomout = $hash{'randomout_'.$rid};
79: }
80: unless ($beenhere=~/\&$rid\&/) {
81: $beenhere.=$rid.'&';
82: unless ($randomout) {
83: if (defined($hash{'is_map_'.$rid})) {
84: if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
85: (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {
86: my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
87: $sofar=
88: &tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},
89: '&'.$frid.'&');
90: $sofar++;
91: if ($hash{'src_'.$frid}) {
92: my $brepriv=&Apache::lonnet::allowed('bre',$hash{'src_'.$frid});
93: if (($brepriv eq '2') || ($brepriv eq 'F')) {
94: if (defined($rows[$sofar])) {
95: $rows[$sofar].='&'.$frid;
96: } else {
97: $rows[$sofar]=$frid;
98: }
99: }
100: }
101: }
102: } else {
103: $sofar++;
104: if ($hash{'src_'.$rid}) {
105: my $brepriv=&Apache::lonnet::allowed('bre',$hash{'src_'.$rid});
106: if (($brepriv eq '2') || ($brepriv eq 'F')) {
107: if (defined($rows[$sofar])) {
108: $rows[$sofar].='&'.$rid;
109: } else {
110: $rows[$sofar]=$rid;
111: }
112: }
113: }
114: }
115: }
116:
117: if (defined($hash{'to_'.$rid})) {
118: my $mincond=1;
119: my $next='';
120: foreach (split(/\,/,$hash{'to_'.$rid})) {
121: my $thiscond=
122: &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
123: if ($thiscond>=$mincond) {
124: if ($next) {
125: $next.=','.$_.':'.$thiscond;
126: } else {
127: $next=$_.':'.$thiscond;
128: }
129: if ($thiscond>$mincond) { $mincond=$thiscond; }
130: }
131: }
132: foreach (split(/\,/,$next)) {
133: my ($linkid,$condval)=split(/\:/,$_);
134: if ($condval>=$mincond) {
135: my $now=&tracetable($sofar,$hash{'goesto_'.$linkid},$beenhere);
136: if ($now>$further) { $further=$now; }
137: }
138: }
139: }
140: }
141: return $further;
142: }
143:
144: # ================================================================ Main Handler
145:
146: sub handler {
147: my $r=shift;
148:
149: # ------------------------------------------- Set document type for header only
150:
151: if ($r->header_only) {
152: if ($ENV{'browser.mathml'}) {
153: &Apache::loncommon::content_type($r,'text/xml');
154: } else {
155: &Apache::loncommon::content_type($r,'text/html');
156: }
157: $r->send_http_header;
158: return OK;
159: }
160:
161: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
162: ['forceselect','launch']);
163: my $number_of_columns = 1;
164: my $requrl=$r->uri;
165: my $target = $ENV{'form.grade_target'};
166: # &Apache::lonnet::logthis("Got a target of $target");
167: if ($target eq 'meta') {
168: &Apache::loncommon::content_type($r,'text/html');
169: $r->send_http_header;
170: return OK;
171: }
172: # ----------------------------------------------------------------- Tie db file
173: if (($ENV{'request.course.fn'}) && (!$ENV{'form.forceselect'})) {
174: my $fn=$ENV{'request.course.fn'};
175: if (-e "$fn.db") {
176: if (tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) {
177: # ------------------------------------------------------------------- Hash tied
178: my $firstres=$hash{'map_start_'.$requrl};
179: my $lastres=$hash{'map_finish_'.$requrl};
180: if (($firstres) && ($lastres)) {
181: # ----------------------------------------------------------------- Render page
182:
183: @rows=();
184:
185: &tracetable(0,$firstres,'&');
186:
187: # ------------------------------------------------------------ Add to symb list
188:
189: my $i;
190: my %symbhash=();
191: for ($i=0;$i<=$#rows;$i++) {
192: if ($rows[$i]) {
193: my @colcont=split(/\&/,$rows[$i]);
194: foreach (@colcont) {
195: $symbhash{$hash{'src_'.$_}}='';
196: }
197: }
198: }
199: &Apache::lonnet::symblist($requrl,%symbhash);
200:
201: # ------------------------------------------------------------------ Page parms
202:
203: my $j;
204: my $lcm=1;
205: my $contents=0;
206: my $nforms=0;
207:
208: my %ssibody=();
209: my %ssibgcolor=();
210: my %ssitext=();
211: my %ssilink=();
212: my %ssivlink=();
213: my %ssialink=();
214:
215: my %metalink=();
216:
217: my %cellemb=();
218:
219: my $allscript='';
220: my $allmeta='';
221:
222: my $isxml=0;
223: my $xmlheader='';
224: my $xmlbody='';
225:
226: # --------------------------------------------- Get SSI output, post parameters
227:
228: for ($i=0;$i<=$#rows;$i++) {
229: if ($rows[$i]) {
230: $contents++;
231: my @colcont=split(/\&/,$rows[$i]);
232: $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));
233: foreach (@colcont) {
234: my $src=$hash{'src_'.$_};
235: $src=~/\.(\w+)$/;
236: $metalink{$_}=$src.'.meta';
237: $cellemb{$_}=Apache::loncommon::fileembstyle($1);
238: if ($cellemb{$_} eq 'ssi') {
239: # --------------------------------------------------------- This is an SSI cell
240: my $prefix=$_.'_';
241: my %posthash=('request.prefix' => $prefix);
242: if ($ENV{'form.grade_target'} eq 'tex') {
243: $posthash{'grade_target'}=$ENV{'form.grade_target'};
244: $posthash{'textwidth'}=$ENV{'form.textwidth'};
245: $posthash{'problem_split'}=$ENV{'form.problem_split'};
246: $posthash{'latex_type'}=$ENV{'form.latex_type'};
247: $posthash{'rndseed'}=$ENV{'form.rndseed'};
248: }
249: if (($ENV{'form.'.$prefix.'submit'})
250: || ($ENV{'form.all_submit'})) {
251: foreach (keys %ENV) {
252: if ($_=~/^form.$prefix/) {
253: my $name=$_;
254: $name=~s/^form.$prefix//;
255: $posthash{$name}=$ENV{$_};
256: }
257: }
258: }
259: my $output=Apache::lonnet::ssi($src,%posthash);
260: $output=~
261: s/\/\/ BEGIN LON\-CAPA Internal.+\/\/ END LON\-CAPA Internal\s//gs;
262: if ($target eq 'tex') {
263: $output =~ s/^([^&]+)\\begin{document}//;
264: $output =~ s/\\end{document}//;
265: $output = '\parbox{\minipagewidth}{ '.$output.' }';
266: #some additional cleanup necessary for LateX (due to limitations of table environment
267: $output =~ s/(\\vskip\s*\d+mm)\s*(\\\\)+/$1/g;
268: }
269: my $parser=HTML::TokeParser->new(\$output);
270: my $token;
271: my $thisdir=$src;
272: my $bodydef=0;
273: my $thisxml=0;
274: my @rlinks=();
275: if ($output=~/\?xml/) {
276: $isxml=1;
277: $thisxml=1;
278: $output=~
279: /((?:\<(?:\?xml|\!DOC|html)[^\>]*(?:\>|\>\]\>)\s*)+)\<body[^\>]*\>/si;
280: $xmlheader=$1;
281: }
282: while ($token=$parser->get_token) {
283: if ($token->[0] eq 'S') {
284: if ($token->[1] eq 'a') {
285: if ($token->[2]->{'href'}) {
286: $rlinks[$#rlinks+1]=
287: $token->[2]->{'href'};
288: }
289: } elsif ($token->[1] eq 'img') {
290: $rlinks[$#rlinks+1]=
291: $token->[2]->{'src'};
292: } elsif ($token->[1] eq 'embed') {
293: $rlinks[$#rlinks+1]=
294: $token->[2]->{'src'};
295: } elsif ($token->[1] eq 'base') {
296: $thisdir=$token->[2]->{'href'};
297: } elsif ($token->[1] eq 'body') {
298: $bodydef=1;
299: $ssibgcolor{$_}=$token->[2]->{'bgcolor'};
300: $ssitext{$_}=$token->[2]->{'text'};
301: $ssilink{$_}=$token->[2]->{'link'};
302: $ssivlink{$_}=$token->[2]->{'vlink'};
303: $ssialink{$_}=$token->[2]->{'alink'};
304: if ($thisxml) {
305: $xmlbody=$token->[4];
306: }
307: } elsif ($token->[1] eq 'meta') {
308: if ($token->[4] !~ m:/>$:) {
309: $allmeta.="\n".$token->[4].'</meta>';
310: } else {
311: $allmeta.="\n".$token->[4];
312: }
313: } elsif (($token->[1] eq 'script') &&
314: ($bodydef==0)) {
315: $allscript.="\n\n"
316: .$parser->get_text('/script');
317: }
318: }
319: }
320: if ($output=~/\<body[^\>]*\>(.*)/si) {
321: $output=$1;
322: }
323: $output=~s/\<\/body\>.*//si;
324: if ($output=~/\<form/si) {
325: $nforms++;
326: $output=~s/\<form[^\>]*\>//gsi;
327: $output=~s/\<\/form[^\>]*\>//gsi;
328: $output=~
329: s/\<((?:input|select|button|textarea)[^\>]+)name\s*\=\s*[\'\"]*([\w\.\:]+)[\'\"]*([^\>]*)\>/\<$1 name="$prefix$2" $3\>/gsi;
330: }
331: $thisdir=~s/\/[^\/]*$//;
332: foreach (@rlinks) {
333: unless (($_=~/^http:\/\//i) ||
334: ($_=~/^\//) ||
335: ($_=~/^javascript:/i) ||
336: ($_=~/^mailto:/i) ||
337: ($_=~/^\#/)) {
338: my $newlocation=
339: &Apache::lonnet::hreflocation($thisdir,$_);
340: $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
341: }
342: }
343: # -------------------------------------------------- Deal with Applet codebases
344: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
345: $ssibody{$_}=$output;
346: # ---------------------------------------------------------------- End SSI cell
347: }
348: }
349: }
350: }
351: unless ($contents) {
352: &Apache::loncommon::content_type($r,'text/html');
353: $r->send_http_header;
354: $r->print('<html>'."\n".
355: '<head>'."\n".
356: &Apache::lonmenu::registerurl(1,undef)."\n".
357: '</head>'."\n".
358: '<body bgcolor="#FFFFFF" onLoad="'
359: .&Apache::lonmenu::loadevents.
360: '" onUnload="'.&Apache::lonmenu::unloadevents.'">'.
361: &Apache::lonmenu::menubuttons(undef,$target,1)
362: );
363: $r->print(&mt('This page is either empty or it only contains resources that are currently hidden').'. ');
364: $r->print('<br /><br />'.&mt('Please use the LON-CAPA navigation arrows to move to another item in the course').'.</body></html>');
365: } else {
366: # ------------------------------------------------------------------ Build page
367:
368: # ---------------------------------------------------------------- Send headers
369: unless ($target eq 'tex') {
370: if ($isxml) {
371: &Apache::loncommon::content_type($r,'text/xml');
372: $r->send_http_header;
373: $r->print($xmlheader);
374: } else {
375: &Apache::loncommon::content_type($r,'text/html');
376: $r->send_http_header;
377: $r->print('<html>');
378: }
379: # ------------------------------------------------------------------------ Head
380: $r->print("\n<head>\n".$allmeta);
381: if ($allscript) {
382: $r->print("\n<script language='JavaScript'>\n".
383: $allscript."\n</script>\n");
384: }
385: $r->print(&Apache::lonmenu::registerurl(1,undef));
386: $r->print("\n</head>\n");
387: # ------------------------------------------------------------------ Start body
388: if ($isxml) {
389: $r->print($xmlbody);
390: } else {
391: $r->print(
392: '<body bgcolor="#FFFFFF" onLoad="'.&Apache::lonmenu::loadevents.
393: '" onUnload="'.&Apache::lonmenu::unloadevents.'">'.
394: &Apache::lonmenu::menubuttons(undef,$target,1)
395: );
396: }
397: # ------------------------------------------------------------------ Start form
398: if ($nforms) {
399: $r->print('<form method="post" action="'.
400: $requrl.'">');
401: }
402: } elsif ($target eq 'tex') {
403: $r->print('\documentclass{article}
404: \newcommand{\keephidden}[1]{}
405: \usepackage[dvips]{graphicx}
406: \usepackage{epsfig}
407: \usepackage{calc}
408: \usepackage{longtable}
409: \begin{document}');
410: }
411: # ----------------------------------------------------------------- Start table
412: if ($target eq 'tex') {
413: $r->print('\begin{longtable}INSERTTHEHEADOFLONGTABLE\endfirsthead\endhead ');
414: if ($number_of_columns le $lcm) {$number_of_columns=$lcm;};
415: } else {
416: $r->print('<table cols="'.$lcm.'" border="0">');
417: }
418: for ($i=0;$i<=$#rows;$i++) {
419: if ($rows[$i]) {
420: unless ($target eq 'tex') {
421: $r->print("\n<tr>");
422: }
423: my @colcont=split(/\&/,$rows[$i]);
424: my $avespan=$lcm/($#colcont+1);
425: for ($j=0;$j<=$#colcont;$j++) {
426: my $rid=$colcont[$j];
427: my $metainfo='<a name="'.
428: &Apache::lonnet::escape(&Apache::lonnet::declutter($hash{'src_'.$rid})).'" />'.
429: '<a href="'.
430: $metalink{$rid}.'" target="LONcatInfo">'.
431: '<img src="/adm/lonMisc/cat_button.gif" border=0>'.
432: '</img></a><a href="/adm/evaluate?postdata='.
433: &Apache::lonnet::escape(&Apache::lonnet::declutter($hash{'src_'.$rid}))
434: .'" target="LONcatInfo">'.
435: '<img src="/adm/lonMisc/eval_button.gif" border=0>'.
436: '</img></a>';
437: if (
438: ($hash{'src_'.$rid}=~/\.(problem|exam|quiz|assess|survey|form)$/) &&
439: (&Apache::lonnet::allowed('mgr',$ENV{'request.course.id'}))) {
440: my ($mapid,$resid)=split(/\./,$rid);
441: my $symb=
442: &Apache::lonnet::declutter($hash{'map_id_'.$mapid}).
443: '___'.$resid.'___'.
444: &Apache::lonnet::declutter($hash{'src_'.$rid});
445: $metainfo.=
446: '<a href="/adm/grades?symb='.&Apache::lonnet::escape($symb).
447: # '&command=submission" target="LONcatInfo">'.
448: '&command=submission">'.
449: '<img src="/adm/lonMisc/subm_button.gif" border=0>'.
450: '</img></a>'.
451: '<a href="/adm/grades?symb='.&Apache::lonnet::escape($symb).
452: # '&command=gradingmenu" target="LONcatInfo">'.
453: '&command=gradingmenu">'.
454: '<img src="/adm/lonMisc/pgrd_button.gif" border=0>'.
455: '</img></a>'.
456: '<a href="/adm/parmset?symb='.&Apache::lonnet::escape($symb).
457: # '" target="LONcatInfo">'.
458: '" >'.
459: '<img src="/adm/lonMisc/pprm_button.gif" border=0>'.
460: '</img></a>';
461: }
462: $metainfo.='<br></br>';
463: unless ($target eq 'tex') {
464: $r->print('<td colspan="'.$avespan.'"');
465: }
466: if ($cellemb{$rid} eq 'ssi') {
467: unless ($target eq 'tex') {
468: if ($ssibgcolor{$rid}) {
469: $r->print(' bgcolor="'.
470: $ssibgcolor{$rid}.'"');
471: }
472: $r->print('>'.$metainfo.'<font');
473:
474: if ($ssitext{$rid}) {
475: $r->print(' text="'.$ssitext{$rid}.'"');
476: }
477: if ($ssilink{$rid}) {
478: $r->print(' link="'.$ssilink{$rid}.'"');
479: }
480: if ($ssitext{$rid}) {
481: $r->print(' vlink="'.$ssivlink{$rid}.'"');
482: }
483: if ($ssialink{$rid}) {
484: $r->print(' alink="'.$ssialink{$rid}.'"');
485: }
486: $r->print('>');
487: }
488: $r->print($ssibody{$rid});
489: unless ($target eq 'tex') {
490: $r->print('</font>');
491: }
492: if ($ENV{'course.'.
493: $ENV{'request.course.id'}.
494: '.pageseparators'} eq 'yes') {
495: unless($target eq 'tex') {
496: $r->print('<hr />');
497: } else {
498: $r->print('\hline');
499: }
500: }
501: } elsif ($cellemb{$rid} eq 'img') {
502: $r->print('>'.$metainfo.'<img src="'.
503: $hash{'src_'.$rid}.'"></img>');
504: } elsif ($cellemb{$rid} eq 'emb') {
505: $r->print('>'.$metainfo.'<embed src="'.
506: $hash{'src_'.$rid}.'"></embed>');
507: }
508: unless ($target eq 'tex') {
509: $r->print('</td>');
510: } else {
511: for (my $incol=1;$incol<=$avespan;$incol++) {
512: $r->print(' & ');
513: }
514: }
515: }
516: unless ($target eq 'tex') {
517: $r->print('</tr>');
518: } else {
519: $r->print('REMOVETHEHEADOFLONGTABLE\\\\');
520: }
521: }
522: }
523: unless ($target eq 'tex') {
524: $r->print("\n</table>");
525: } else {
526: $r->print('\end{longtable}\strut');
527: }
528: # ---------------------------------------------------------------- Submit, etc.
529: if ($nforms) {
530: $r->print(
531: '<input name="all_submit" value="Submit All" type="'.
532: (($nforms>1)?'submit':'hidden').'"></input></form>');
533: }
534: unless ($target eq 'tex') {
535: $r->print('</body>'.&Apache::lonxml::xmlend());
536: } else {
537: $r->print('\end{document}'.$number_of_columns);
538: }
539: # -------------------------------------------------------------------- End page
540: }
541: # ------------------------------------------------------------- End render page
542: } else {
543: $r->content_type('text/html');
544: $r->send_http_header;
545: &Apache::lonsequence::viewmap($r,$requrl);
546: }
547: # ------------------------------------------------------------------ Untie hash
548: unless (untie(%hash)) {
549: &Apache::lonnet::logthis("<font color=blue>WARNING: ".
550: "Could not untie coursemap $fn (browse).</font>");
551: }
552: # -------------------------------------------------------------------- All done
553: return OK;
554: # ----------------------------------------------- Errors, hash could no be tied
555: }
556: }
557: }
558: $r->content_type('text/html');
559: $r->send_http_header;
560: &Apache::lonsequence::viewmap($r,$requrl);
561: return OK;
562: }
563:
564: 1;
565: __END__
566:
567: =head1 NAME
568:
569: Apache::lonpage - Page Handler
570:
571: =head1 SYNOPSIS
572:
573: Invoked by /etc/httpd/conf/srm.conf:
574:
575: <LocationMatch "^/res/.*\.page$>
576: SetHandler perl-script
577: PerlHandler Apache::lonpage
578: </LocationMatch>
579:
580: =head1 INTRODUCTION
581:
582: This module renders a .page resource.
583:
584: This is part of the LearningOnline Network with CAPA project
585: described at http://www.lon-capa.org.
586:
587: =head1 HANDLER SUBROUTINE
588:
589: This routine is called by Apache and mod_perl.
590:
591: =over 4
592:
593: =item *
594:
595: set document type for header only
596:
597: =item *
598:
599: tie db file
600:
601: =item *
602:
603: render page
604:
605: =item *
606:
607: add to symb list
608:
609: =item *
610:
611: page parms
612:
613: =item *
614:
615: Get SSI output, post parameters
616:
617: =item *
618:
619: SSI cell rendering
620:
621: =item *
622:
623: Deal with Applet codebases
624:
625: =item *
626:
627: Build page
628:
629: =item *
630:
631: send headers
632:
633: =item *
634:
635: start body
636:
637: =item *
638:
639: start form
640:
641: =item *
642:
643: start table
644:
645: =item *
646:
647: submit element, etc, render page, untie hash
648:
649: =back
650:
651: =head1 OTHER SUBROUTINES
652:
653: =over 4
654:
655: =item *
656:
657: euclid() : Euclid's method for determining the greatest common denominator.
658:
659: =item *
660:
661: tracetable() : Build page table.
662:
663: =back
664:
665: =cut
666:
667:
668:
669:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>