Annotation of rat/lonsequence.pm, revision 1.36
1.1 www 1: # The LearningOnline Network with CAPA
2: #
3: # Sequence Handler
4: #
1.36 ! raeburn 5: # $Id: lonsequence.pm,v 1.35 2008/11/20 15:19:05 jms Exp $
1.5 www 6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27: # http://www.lon-capa.org/
28: #
1.1 www 29:
1.33 jms 30:
31:
1.3 www 32: package Apache::lonsequence;
1.1 www 33:
34: use strict;
35: use Apache::lonnet;
1.3 www 36: use Apache::Constants qw(:common :http REDIRECT);
1.1 www 37: use GDBM_File;
1.28 albertel 38: use LONCAPA::map();
39: use Apache::lonpageflip();
40: use Apache::loncommon();
1.31 albertel 41: use Apache::groupsort();
1.16 www 42: use Apache::lonlocal;
1.30 albertel 43: use HTML::Entities();
1.1 www 44:
1.12 www 45: my %selhash;
46: my $successtied;
1.8 www 47:
48: # ----------------------------------------- Attempt to read from resource space
49:
50: sub attemptread {
1.32 albertel 51: my ($fn,$unsorted)=@_;
1.8 www 52: &Apache::lonnet::repcopy($fn);
53: if (-e $fn) {
1.32 albertel 54: return &LONCAPA::map::attemptread($fn,$unsorted);
1.8 www 55: } else {
56: return ();
57: }
58: }
59:
1.15 www 60: sub mapread {
61: my $fn=shift;
62: &Apache::lonnet::repcopy($fn);
63: if (-e $fn) {
1.28 albertel 64: return &LONCAPA::map::mapread($fn,'');
1.15 www 65: } else {
66: return ();
67: }
68: }
69:
1.8 www 70: # ---------------------------------------------------------------- View Handler
71:
72: sub viewmap {
1.9 www 73: my ($r,$url)=@_;
1.26 albertel 74:
75: my $js;
76: if ($env{'form.forceselect'}) {
77: $js = (<<ENDSCRIPT);
78: <script type="text/javascript">
1.8 www 79:
80: function select_group() {
1.12 www 81: window.location="/adm/groupsort?catalogmode=groupsec&mode=rat&acts="+document.forms.fileattr.acts.value;
1.8 www 82: }
83:
84: function queue(val) {
85: if (eval("document.forms."+val+".filelink.checked")) {
86: var l=val.length;
87: var v=val.substring(4,l);
88: document.forms.fileattr.acts.value+='1a'+v+'b';
89: }
90: else {
91: var l=val.length;
92: var v=val.substring(4,l);
93: document.forms.fileattr.acts.value+='0a'+v+'b';
94: }
95: }
96:
97: </script>
98: ENDSCRIPT
99: }
1.26 albertel 100:
101: $r->print(&Apache::loncommon::start_page('Map Contents',$js).
102: '<h1>'.$url.'</h1>');
1.12 www 103: # ------------------ This is trying to select. Provide buttons and tie %selhash
1.24 albertel 104: if ($env{'form.forceselect'}) { $r->print(<<ENDSELECT);
1.8 www 105: <form name=fileattr><input type=hidden name=acts value=''>
106: <input type="button" name="close" value='CLOSE' onClick="self.close()">
107: <input type="button" name="groupimport" value='GROUP IMPORT'
108: onClick="javascript:select_group()">
109: </form>
110: ENDSELECT
1.12 www 111: my $diropendb =
1.27 www 112: "/home/httpd/perl/tmp/$env{'user.domain'}\_$env{'user.name'}_sel_res.db";
1.13 albertel 113: if (tie(%selhash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
1.24 albertel 114: if ($env{'form.launch'} eq '1') {
1.12 www 115: &start_fresh_session();
116: }
117: $successtied=1;
118:
119: # - Evaluate actions from previous page (both cumulatively and chronologically)
1.31 albertel 120: if ($env{'form.catalogmode'} eq 'import') {
121: &Apache::groupsort::update_actions_hash(\%selhash);
1.12 www 122: }
123: # -
124: }
1.8 www 125: }
1.12 www 126: # ----------------------------- successtied is now '1' if in working selectmode
1.15 www 127: my ($errtext,$fatal)=&mapread(&Apache::lonnet::filelocation('',$url),'');
128: if ($fatal==1) {
1.16 www 129: $r->print('<p><b><font color="red">'.&mt('Map contents are not shown in order.').'</font></b></p><br />');
1.15 www 130: }
1.8 www 131: my $idx=0;
132: foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) {
133: if (defined($_)) {
134: $idx++;
1.12 www 135: if ($successtied) {
1.8 www 136: $r->print('<form name="form'.$idx.'">');
137: }
138: my ($title,$url)=split(/\:/,$_);
1.30 albertel 139: $title = &LONCAPA::map::qtescape($title);
140: unless ($title) { $title=(split(/\//,$url))[-1] };
141: my $enc_title = &HTML::Entities::encode($title,'\'"<>&');
142: unless ($title) {
143: $title='<i>'.&mt('Empty').'</i>';
144: $enc_title = &mt('Empty');
145: }
146: $url = &LONCAPA::map::qtescape($url);
147: my $enc_url = &HTML::Entities::encode($url,'\'"<>&');
1.8 www 148: if ($url) {
1.12 www 149: if ($successtied) {
150: my $checked='';
151: if ($selhash{'store_'.$url}) {
152: $checked=" checked";
153: }
154: $selhash{"pre_${idx}_link"}=$url;
155: $selhash{"pre_${idx}_title"}=$title;
1.30 albertel 156:
157: $url = &HTML::Entities::encode($url, '\'"<>&');
1.8 www 158: $r->print(<<ENDCHECKBOX);
159: <input type='checkbox' name='filelink'
1.30 albertel 160: value='$enc_url' onClick='javascript:queue("form$idx")'$checked />
161: <input type='hidden' name='title' value='$enc_title' />
1.8 www 162: ENDCHECKBOX
163: }
1.30 albertel 164: $r->print('<a href="'.$enc_url.'">');
1.8 www 165: }
1.30 albertel 166: $r->print($enc_title);
1.8 www 167: if ($url) { $r->print('</a>'); }
1.12 www 168: if ($successtied) {
1.8 www 169: $r->print('</form>');
170: } else {
171: $r->print('<br>');
172: }
173: }
174: }
1.26 albertel 175: $r->print(&Apache::loncommon::end_page());
1.12 www 176: if ($successtied) {
177: untie %selhash;
178: }
1.8 www 179: }
180:
1.12 www 181: # ----------------------------------------------------------- Clean out selhash
182: sub start_fresh_session {
183: foreach (keys %selhash) {
184: if ($_ =~ /^pre_/) {
185: delete $selhash{$_};
186: }
187: if ($_ =~ /^store/) {
188: delete $selhash{$_};
189: }
190: }
191: }
192:
193:
1.1 www 194: # ================================================================ Main Handler
195:
196: sub handler {
197: my $r=shift;
198:
199: if ($r->header_only) {
1.16 www 200: &Apache::loncommon::content_type($r,'text/html');
1.1 www 201: $r->send_http_header;
202: return OK;
203: }
1.8 www 204:
205: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.12 www 206: ['forceselect','launch']);
1.1 www 207:
1.2 www 208: my %hash;
1.1 www 209: my %bighash;
1.2 www 210: my $requrl=$r->uri;
211:
1.12 www 212: $successtied=0;
1.3 www 213: # ------------------------------------------------------------ Tie symb db file
1.9 www 214: my $disurl='';
215: my $dismapid='';
1.18 raeburn 216: my $exitdisid = '';
217: my $arrow_dir = '';
1.9 www 218:
1.24 albertel 219: if (($env{'request.course.fn'}) && (!$env{'form.forceselect'})) {
1.2 www 220: my $last;
1.24 albertel 221: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.13 albertel 222: &GDBM_READER(),0640)) {
1.2 www 223: $last=$hash{'last_direction'};
224: untie(%hash);
225: }
1.3 www 226: my $direction='';
227: my $prevmap='';
228: if ($last) {
1.23 albertel 229: ($prevmap,undef,$direction)=&Apache::lonnet::decode_symb($last);
1.3 www 230: }
231: # ------------------------------------------------------------- Tie big db file
1.24 albertel 232: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.13 albertel 233: &GDBM_READER(),0640)) {
1.3 www 234: my $disid='';
1.17 raeburn 235: my $randomout ='';
1.10 www 236:
1.3 www 237: if ($direction eq 'back') {
238: $disid=$bighash{'map_finish_'.$requrl};
239: } else {
240: $disid=$bighash{'map_start_'.$requrl};
1.18 raeburn 241: }
1.3 www 242: if ($disid) {
243: $disurl=$bighash{'src_'.$disid};
1.4 www 244: $dismapid=(split(/\./,$disid))[1];
1.25 albertel 245: if (!$env{'request.role.adv'}) {
246: $randomout = $bighash{'randomout_'.$disid};
247: }
1.24 albertel 248: } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.18 raeburn 249: &GDBM_READER(),0640)) {
250: $last=$hash{'last_known'};
251: untie(%hash);
1.3 www 252: }
1.18 raeburn 253:
254:
1.17 raeburn 255: # ----------- If this is an empty one, or hidden, skip to next non-empty or non-hidden one
1.18 raeburn 256: while ( ((!$disurl) && ($disid)) || ($randomout && $disid) ) {
1.11 www 257: $direction=($direction?$direction:'forward');
258: ($disid,$requrl)=
259: &Apache::lonpageflip::fullmove($disid,
260: &Apache::lonnet::declutter($requrl),$direction);
261: if ($disid) {
262: $disurl=$bighash{'src_'.$disid};
263: $dismapid=(split(/\./,$disid))[1];
1.25 albertel 264: if (!$env{'request.role.adv'}) {
265: $randomout = $bighash{'randomout_'.$disid};
266: }
1.11 www 267: }
268: }
1.18 raeburn 269: $exitdisid = $disid;
270: $arrow_dir = $direction;
1.11 www 271:
1.3 www 272: # --------------------------------------- Untie hash, make sure to come by here
273: untie(%bighash);
1.9 www 274: }
275: }
276:
277: # now either disurl is set (going to first page), or we need another display
278: if ($disurl) {
1.3 www 279: # -------------------------------------------------- Has first or last resource
1.23 albertel 280: &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid],
281: 'last_known' => [$disurl,$dismapid]);
1.16 www 282: &Apache::loncommon::content_type($r,'text/html');
1.36 ! raeburn 283: $r->header_out(Location => &Apache::lonnet::absolute_url($ENV{'SERVER_NAME'}).
! 284: $disurl);
1.9 www 285: return REDIRECT;
1.1 www 286: } else {
1.16 www 287: &Apache::loncommon::content_type($r,'text/html');
1.9 www 288: $r->send_http_header;
1.21 albertel 289: if ($exitdisid eq '' && $arrow_dir ne '') {
1.18 raeburn 290: my %lt =&Apache::lonlocal::texthash(
291: 'back' => 'beginning',
292: 'forward' => 'end',
293: 'nere' => 'Next resource could not be displayed',
294: 'goba' => 'Go Back',
295: 'nacc' => 'Navigate Course Content',
296: );
1.26 albertel 297: my $warnmsg = &mt('As all folders and sequences ');
1.18 raeburn 298: if ($arrow_dir eq 'forward') {
299: $warnmsg .= &mt('following the current resource were empty').',';
300: } elsif ($arrow_dir eq 'back') {
301: $warnmsg .= &mt('preceding the current resource were empty').',';
302: }
303: $warnmsg .= &mt('you have now reached the').' '.$lt{$arrow_dir}.' '.&mt('of the course.');
1.26 albertel 304: my $start_page=
305: &Apache::loncommon::start_page('Empty Folder/Sequence');
306: my $end_page=
307: &Apache::loncommon::end_page();
1.18 raeburn 308: $r->print(<<ENDNONE);
1.26 albertel 309: $start_page
1.18 raeburn 310: <h3>$lt{'nere'}</h3>
311: <p>$warnmsg</p>
312: <ul>
313: <li><a href="javascript:history.go(-1)">$lt{'goba'}</a></li>
314: <li><a href="/adm/navmaps">$lt{'nacc'}</a></li>
315: </ul>
1.26 albertel 316: $end_page
1.18 raeburn 317: ENDNONE
318: } else {
319: &viewmap($r,$requrl);
320: }
1.9 www 321: return OK;
1.1 www 322: }
323: }
324:
325: 1;
326: __END__
327:
1.35 jms 328: =head1 NAME
329:
330: Apache::lonsequence
331:
332: =head1 SYNOPSIS
333:
334: Handler for showing sequence objects of
335: educational resources.
336:
337: This is part of the LearningOnline Network with CAPA project
338: described at http://www.lon-capa.org.
339:
340: =head1 SUBROUTINES
341:
342: =over
343:
344: =item handler()
345:
346: =item viewmap()
347:
348: =item attemptread()
1.1 www 349:
1.35 jms 350: =item mapread()
351:
352: =item start_fresh_session()
353:
354: =back
355:
356: =cut
1.1 www 357:
358:
359:
360:
361:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>