Annotation of rat/lonsequence.pm, revision 1.46
1.1 www 1: # The LearningOnline Network with CAPA
2: #
3: # Sequence Handler
4: #
1.46 ! raeburn 5: # $Id: lonsequence.pm,v 1.45 2014/12/15 00:46:52 raeburn 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();
1.41 foxr 39: use LONCAPA;
1.28 albertel 40: use Apache::lonpageflip();
41: use Apache::loncommon();
1.31 albertel 42: use Apache::groupsort();
1.16 www 43: use Apache::lonlocal;
1.46 ! raeburn 44: use Apache::lonnavmaps();
! 45: use Apache::lonenc();
1.30 albertel 46: use HTML::Entities();
1.1 www 47:
1.12 www 48: my %selhash;
49: my $successtied;
1.8 www 50:
51: # ----------------------------------------- Attempt to read from resource space
52:
53: sub attemptread {
1.32 albertel 54: my ($fn,$unsorted)=@_;
1.8 www 55: &Apache::lonnet::repcopy($fn);
56: if (-e $fn) {
1.32 albertel 57: return &LONCAPA::map::attemptread($fn,$unsorted);
1.8 www 58: } else {
59: return ();
60: }
61: }
62:
1.15 www 63: sub mapread {
64: my $fn=shift;
65: &Apache::lonnet::repcopy($fn);
66: if (-e $fn) {
1.28 albertel 67: return &LONCAPA::map::mapread($fn,'');
1.15 www 68: } else {
69: return ();
70: }
71: }
72:
1.8 www 73: # ---------------------------------------------------------------- View Handler
74:
75: sub viewmap {
1.9 www 76: my ($r,$url)=@_;
1.26 albertel 77:
78: my $js;
79: if ($env{'form.forceselect'}) {
80: $js = (<<ENDSCRIPT);
81: <script type="text/javascript">
1.8 www 82:
83: function select_group() {
1.12 www 84: window.location="/adm/groupsort?catalogmode=groupsec&mode=rat&acts="+document.forms.fileattr.acts.value;
1.8 www 85: }
86:
87: function queue(val) {
88: if (eval("document.forms."+val+".filelink.checked")) {
89: var l=val.length;
90: var v=val.substring(4,l);
91: document.forms.fileattr.acts.value+='1a'+v+'b';
92: }
93: else {
94: var l=val.length;
95: var v=val.substring(4,l);
96: document.forms.fileattr.acts.value+='0a'+v+'b';
97: }
98: }
99:
100: </script>
101: ENDSCRIPT
102: }
1.26 albertel 103:
104: $r->print(&Apache::loncommon::start_page('Map Contents',$js).
105: '<h1>'.$url.'</h1>');
1.12 www 106: # ------------------ This is trying to select. Provide buttons and tie %selhash
1.24 albertel 107: if ($env{'form.forceselect'}) { $r->print(<<ENDSELECT);
1.38 bisitz 108: <form name="fileattr"><input type="hidden" name="acts" value="" />
109: <input type="button" name="close" value="CLOSE" onClick="self.close()" />
110: <input type="button" name="groupimport" value="GROUP IMPORT"
111: onClick="javascript:select_group()" />
1.8 www 112: </form>
113: ENDSELECT
1.12 www 114: my $diropendb =
1.41 foxr 115: LONCAPA::tempdir() .
116: "$env{'user.domain'}\_$env{'user.name'}_sel_res.db";
1.13 albertel 117: if (tie(%selhash,'GDBM_File',$diropendb,&GDBM_WRCREAT(),0640)) {
1.24 albertel 118: if ($env{'form.launch'} eq '1') {
1.12 www 119: &start_fresh_session();
120: }
121: $successtied=1;
122:
123: # - Evaluate actions from previous page (both cumulatively and chronologically)
1.31 albertel 124: if ($env{'form.catalogmode'} eq 'import') {
125: &Apache::groupsort::update_actions_hash(\%selhash);
1.12 www 126: }
127: # -
128: }
1.8 www 129: }
1.12 www 130: # ----------------------------- successtied is now '1' if in working selectmode
1.15 www 131: my ($errtext,$fatal)=&mapread(&Apache::lonnet::filelocation('',$url),'');
132: if ($fatal==1) {
1.37 bisitz 133: $r->print('<p class="LC_warning">'
134: .&mt('Map contents are not shown in order.')
135: .'</p><br />');
1.15 www 136: }
1.8 www 137: my $idx=0;
1.45 raeburn 138: foreach my $entry (&attemptread(&Apache::lonnet::filelocation('',$url))) {
139: if (defined($entry)) {
1.8 www 140: $idx++;
1.12 www 141: if ($successtied) {
1.8 www 142: $r->print('<form name="form'.$idx.'">');
143: }
1.45 raeburn 144: my ($title,$url)=split(/\:/,$entry);
1.30 albertel 145: $title = &LONCAPA::map::qtescape($title);
146: unless ($title) { $title=(split(/\//,$url))[-1] };
147: my $enc_title = &HTML::Entities::encode($title,'\'"<>&');
148: unless ($title) {
149: $title='<i>'.&mt('Empty').'</i>';
150: $enc_title = &mt('Empty');
151: }
152: $url = &LONCAPA::map::qtescape($url);
153: my $enc_url = &HTML::Entities::encode($url,'\'"<>&');
1.8 www 154: if ($url) {
1.12 www 155: if ($successtied) {
156: my $checked='';
157: if ($selhash{'store_'.$url}) {
1.38 bisitz 158: $checked=' checked="checked"';
1.12 www 159: }
160: $selhash{"pre_${idx}_link"}=$url;
161: $selhash{"pre_${idx}_title"}=$title;
1.30 albertel 162:
163: $url = &HTML::Entities::encode($url, '\'"<>&');
1.8 www 164: $r->print(<<ENDCHECKBOX);
165: <input type='checkbox' name='filelink'
1.30 albertel 166: value='$enc_url' onClick='javascript:queue("form$idx")'$checked />
167: <input type='hidden' name='title' value='$enc_title' />
1.8 www 168: ENDCHECKBOX
169: }
1.30 albertel 170: $r->print('<a href="'.$enc_url.'">');
1.8 www 171: }
1.30 albertel 172: $r->print($enc_title);
1.8 www 173: if ($url) { $r->print('</a>'); }
1.12 www 174: if ($successtied) {
1.8 www 175: $r->print('</form>');
176: } else {
1.39 bisitz 177: $r->print('<br />');
1.8 www 178: }
179: }
180: }
1.26 albertel 181: $r->print(&Apache::loncommon::end_page());
1.12 www 182: if ($successtied) {
183: untie %selhash;
184: }
1.8 www 185: }
186:
1.12 www 187: # ----------------------------------------------------------- Clean out selhash
188: sub start_fresh_session {
1.45 raeburn 189: foreach my $item (keys(%selhash)) {
190: if ($item =~ /^pre_/) {
191: delete $selhash{$item};
1.12 www 192: }
1.45 raeburn 193: if ($item =~ /^store/) {
194: delete $selhash{$item};
1.12 www 195: }
196: }
197: }
198:
199:
1.1 www 200: # ================================================================ Main Handler
201:
202: sub handler {
203: my $r=shift;
204:
205: if ($r->header_only) {
1.16 www 206: &Apache::loncommon::content_type($r,'text/html');
1.1 www 207: $r->send_http_header;
208: return OK;
209: }
1.46 ! raeburn 210:
! 211: my $requrl=$r->uri;
1.8 www 212: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.46 ! raeburn 213: ['forceselect','launch','navmap']);
! 214:
! 215: if (($env{'request.course.fn'}) && ($env{'form.navmap'}) && ($env{'request.course.id'})) {
! 216: my $crstype = &Apache::loncommon::course_type();
! 217: unless (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
! 218:
! 219: # Check for critical messages and redirect if present.
! 220: my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents');
! 221: if ($redirect) {
! 222: &Apache::loncommon::content_type($r,'text/html');
! 223: $r->header_out(Location => $url);
! 224: return REDIRECT;
! 225: }
! 226:
! 227: # Check if course needs to be re-initialized
! 228: my $loncaparev = $r->dir_config('lonVersion');
! 229: my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
! 230:
! 231: if ($result eq 'switch') {
! 232: &Apache::loncommon::content_type($r,'text/html');
! 233: $r->send_http_header;
! 234: $r->print(&Apache::loncommon::check_release_result(@reinit));
! 235: return OK;
! 236: } elsif ($result eq 'update') {
! 237: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
! 238: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
! 239: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
! 240: if ($ferr) {
! 241: my $requrl = $r->uri;
! 242: $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
! 243: $env{'user.reinit'} = 1;
! 244: return HTTP_NOT_ACCEPTABLE;
! 245: }
! 246: }
! 247:
! 248: # Create the nav map
! 249: my $navmap = Apache::lonnavmaps::navmap->new();
! 250:
! 251: if (ref($navmap)) {
! 252: # renderer call
! 253: if (&Apache::lonnet::is_on_map($requrl)) {
! 254: my $mapurl = &Apache::lonnet::declutter($requrl);
! 255: my @crumbs = ({text => $crstype.' Contents',
! 256: href => "javascript:gopost('/adm/navmaps','')"});
! 257: my $res = $navmap->getResourceByUrl($mapurl);
! 258: if (ref($res)) {
! 259: my ($parent) = &Apache::lonnet::decode_symb($res->symb());
! 260: if ($parent ne $env{'course.'.$env{'request.course.id'}.'.url'}) {
! 261: my @mapcrumbs = $navmap->recursed_crumbs($parent);
! 262: if (@mapcrumbs) {
! 263: push(@crumbs,@mapcrumbs);
! 264: } else {
! 265: push(@crumbs,{text => '...',
! 266: no_mt => 1});
! 267: }
! 268: }
! 269: }
! 270: my $maptitle = &Apache::lonnet::gettitle($mapurl);
! 271: push(@crumbs,{text => $maptitle, no_mt => 1});
! 272: my $args = {'bread_crumbs' => \@crumbs,
! 273: 'bread_crumbs_nomenu' => 1};
! 274: &Apache::loncommon::content_type($r,'text/html');
! 275: $r->send_http_header;
! 276:
! 277: $r->print(&Apache::loncommon::start_page($maptitle,undef,$args));
! 278:
! 279: my $renderArgs = { 'cols' => [0,1,2,3],
! 280: 'url' => $mapurl,
! 281: 'navmap' => $navmap,
! 282: 'suppressNavmap' => 1,
! 283: 'suppressEmptySequences' => 1,
! 284: 'filterFunc' => undef,
! 285: 'resource_no_folder_link' => 1,
! 286: 'r' => $r,
! 287: 'caller' => 'sequence',
! 288: 'notools' => 1,
! 289: 'iterator_map' => $mapurl,
! 290: };
! 291:
! 292: my $render = &Apache::lonnavmaps::render($renderArgs);
! 293:
! 294: # If no resources were found let the user know.
! 295: if ($renderArgs->{'counter'} == 0) {
! 296: $r->print("<p><span class=\"LC_info\">".
! 297: &mt("This folder is empty.")."</span></p>");
! 298: }
! 299: $r->print(&Apache::loncommon::end_page());
! 300: $r->rflush();
! 301: return OK;
! 302: }
! 303: }
! 304: }
! 305: }
1.1 www 306:
1.2 www 307: my %hash;
1.1 www 308: my %bighash;
1.2 www 309:
1.12 www 310: $successtied=0;
1.3 www 311: # ------------------------------------------------------------ Tie symb db file
1.9 www 312: my $disurl='';
313: my $dismapid='';
1.18 raeburn 314: my $exitdisid = '';
315: my $arrow_dir = '';
1.40 raeburn 316: my $is_encrypted = '';
1.9 www 317:
1.24 albertel 318: if (($env{'request.course.fn'}) && (!$env{'form.forceselect'})) {
1.2 www 319: my $last;
1.24 albertel 320: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.13 albertel 321: &GDBM_READER(),0640)) {
1.2 www 322: $last=$hash{'last_direction'};
323: untie(%hash);
324: }
1.3 www 325: my $direction='';
326: my $prevmap='';
327: if ($last) {
1.23 albertel 328: ($prevmap,undef,$direction)=&Apache::lonnet::decode_symb($last);
1.3 www 329: }
330: # ------------------------------------------------------------- Tie big db file
1.24 albertel 331: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.13 albertel 332: &GDBM_READER(),0640)) {
1.3 www 333: my $disid='';
1.17 raeburn 334: my $randomout ='';
1.10 www 335:
1.3 www 336: if ($direction eq 'back') {
337: $disid=$bighash{'map_finish_'.$requrl};
338: } else {
339: $disid=$bighash{'map_start_'.$requrl};
1.18 raeburn 340: }
1.3 www 341: if ($disid) {
342: $disurl=$bighash{'src_'.$disid};
1.4 www 343: $dismapid=(split(/\./,$disid))[1];
1.25 albertel 344: if (!$env{'request.role.adv'}) {
345: $randomout = $bighash{'randomout_'.$disid};
346: }
1.40 raeburn 347: if (!$env{'request.role.adv'}) {
348: $is_encrypted = $bighash{'encrypted_'.$disid};
349: }
1.24 albertel 350: } elsif (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.18 raeburn 351: &GDBM_READER(),0640)) {
352: $last=$hash{'last_known'};
353: untie(%hash);
1.3 www 354: }
1.18 raeburn 355:
356:
1.17 raeburn 357: # ----------- If this is an empty one, or hidden, skip to next non-empty or non-hidden one
1.18 raeburn 358: while ( ((!$disurl) && ($disid)) || ($randomout && $disid) ) {
1.11 www 359: $direction=($direction?$direction:'forward');
360: ($disid,$requrl)=
361: &Apache::lonpageflip::fullmove($disid,
362: &Apache::lonnet::declutter($requrl),$direction);
363: if ($disid) {
364: $disurl=$bighash{'src_'.$disid};
365: $dismapid=(split(/\./,$disid))[1];
1.25 albertel 366: if (!$env{'request.role.adv'}) {
367: $randomout = $bighash{'randomout_'.$disid};
368: }
1.40 raeburn 369: if (!$env{'request.role.adv'}) {
370: $is_encrypted = $bighash{'encrypted_'.$disid};
371: }
1.11 www 372: }
373: }
1.18 raeburn 374: $exitdisid = $disid;
375: $arrow_dir = $direction;
1.11 www 376:
1.3 www 377: # --------------------------------------- Untie hash, make sure to come by here
378: untie(%bighash);
1.9 www 379: }
380: }
381:
382: # now either disurl is set (going to first page), or we need another display
383: if ($disurl) {
1.3 www 384: # -------------------------------------------------- Has first or last resource
1.40 raeburn 385: my $showdisurl = $disurl;
386: if ($is_encrypted) {
387: $showdisurl = &Apache::lonenc::encrypted($disurl);
388: }
1.23 albertel 389: &Apache::lonnet::symblist($requrl,$disurl => [$disurl,$dismapid],
390: 'last_known' => [$disurl,$dismapid]);
1.16 www 391: &Apache::loncommon::content_type($r,'text/html');
1.36 raeburn 392: $r->header_out(Location => &Apache::lonnet::absolute_url($ENV{'SERVER_NAME'}).
1.40 raeburn 393: $showdisurl);
1.9 www 394: return REDIRECT;
1.1 www 395: } else {
1.16 www 396: &Apache::loncommon::content_type($r,'text/html');
1.9 www 397: $r->send_http_header;
1.21 albertel 398: if ($exitdisid eq '' && $arrow_dir ne '') {
1.18 raeburn 399: my %lt =&Apache::lonlocal::texthash(
400: 'nere' => 'Next resource could not be displayed',
401: 'goba' => 'Go Back',
1.44 raeburn 402: 'nacc' => 'Course Contents',
1.18 raeburn 403: );
1.44 raeburn 404: if (&Apache::loncommon::course_type() eq 'Community') {
405: $lt{'nav'} = &mt('Community Contents');
406: }
1.42 raeburn 407: my $warnmsg;
1.18 raeburn 408: if ($arrow_dir eq 'forward') {
1.42 raeburn 409: $warnmsg = &mt('As all folders and sequences '
410: .'following the current resource were empty, '
411: .'you have now reached the end of the course.');
1.18 raeburn 412: } elsif ($arrow_dir eq 'back') {
1.43 raeburn 413: $warnmsg = &mt('As all folders and sequences '
1.42 raeburn 414: .'preceding the current resource were empty, '
415: .'you have now reached the beginning of the course.');
1.18 raeburn 416: }
1.26 albertel 417: my $start_page=
418: &Apache::loncommon::start_page('Empty Folder/Sequence');
419: my $end_page=
420: &Apache::loncommon::end_page();
1.18 raeburn 421: $r->print(<<ENDNONE);
1.26 albertel 422: $start_page
1.18 raeburn 423: <h3>$lt{'nere'}</h3>
424: <p>$warnmsg</p>
425: <ul>
426: <li><a href="javascript:history.go(-1)">$lt{'goba'}</a></li>
427: <li><a href="/adm/navmaps">$lt{'nacc'}</a></li>
428: </ul>
1.26 albertel 429: $end_page
1.18 raeburn 430: ENDNONE
431: } else {
432: &viewmap($r,$requrl);
433: }
1.9 www 434: return OK;
1.1 www 435: }
436: }
437:
438: 1;
439: __END__
440:
1.35 jms 441: =head1 NAME
442:
443: Apache::lonsequence
444:
445: =head1 SYNOPSIS
446:
447: Handler for showing sequence objects of
448: educational resources.
449:
450: This is part of the LearningOnline Network with CAPA project
451: described at http://www.lon-capa.org.
452:
453: =head1 SUBROUTINES
454:
455: =over
456:
457: =item handler()
458:
459: =item viewmap()
460:
461: =item attemptread()
1.1 www 462:
1.35 jms 463: =item mapread()
464:
465: =item start_fresh_session()
466:
467: =back
468:
469: =cut
1.1 www 470:
471:
472:
473:
474:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonsequence.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / rat