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