Annotation of loncom/interface/lonnavdisplay.pm, revision 1.22.4.6
1.1 albertel 1: # The LearningOnline Network with CAPA
1.22.4.5 raeburn 2: # Navigate Maps Display Handler
1.1 albertel 3: #
1.22.4.6! raeburn 4: # $Id: lonnavdisplay.pm,v 1.22.4.5 2014/05/22 12:25:32 raeburn Exp $
1.1 albertel 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: ###
29:
30: package Apache::lonnavdisplay;
31:
32: use strict;
1.22.4.5 raeburn 33: use Apache::Constants qw(:common :http REDIRECT);
1.1 albertel 34: use Apache::lonmenu();
35: use Apache::loncommon();
36: use Apache::lonnavmaps();
37: use Apache::lonhtmlcommon();
38: use Apache::lonnet;
39: use Apache::lonlocal;
1.19 www 40: use Apache::londocs();
1.1 albertel 41:
42: sub handler {
43: my $r = shift;
44: real_handler($r);
45: }
46:
47: sub real_handler {
48: my $r = shift;
49: # Handle header-only request
50: if ($r->header_only) {
1.22.4.6! raeburn 51: &Apache::loncommon::content_type($r,'text/html');
1.1 albertel 52: $r->send_http_header;
53: return OK;
54: }
55:
1.22.4.5 raeburn 56: # Check for critical messages and redirect if present.
57: my ($redirect,$url) = &Apache::loncommon::critical_redirect(300);
58: if ($redirect) {
59: &Apache::loncommon::content_type($r,'text/html');
60: $r->header_out(Location => $url);
61: return REDIRECT;
62: }
63:
1.22.4.6! raeburn 64: # Check if course needs to be re-initialized
! 65: my $loncaparev = $r->dir_config('lonVersion');
! 66: my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
! 67:
! 68: if ($result eq 'switch') {
1.1 albertel 69: &Apache::loncommon::content_type($r,'text/html');
1.22.4.6! raeburn 70: $r->send_http_header;
! 71: $r->print(&Apache::loncommon::check_release_result(@reinit));
! 72: return OK;
! 73: } elsif ($result eq 'update') {
! 74: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
! 75: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
! 76: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
! 77: if ($ferr) {
! 78: my $requrl = $r->uri;
! 79: $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
! 80: $env{'user.reinit'} = 1;
! 81: return HTTP_NOT_ACCEPTABLE;
! 82: }
1.1 albertel 83: }
84:
85: # Create the nav map
86: my $navmap = Apache::lonnavmaps::navmap->new();
87:
88: if (!defined($navmap)) {
89: my $requrl = $r->uri;
90: $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
1.5 raeburn 91: $env{'user.reinit'} = 1;
1.1 albertel 92: return HTTP_NOT_ACCEPTABLE;
93: }
1.22.4.6! raeburn 94:
! 95: # Send header, don't cache this page
! 96: &Apache::loncommon::content_type($r,'text/html');
1.1 albertel 97: $r->send_http_header;
98:
99: # ------------------------------------------------------------ Get query string
1.17 raeburn 100: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort','showOnlyHomework','postsymb','register']);
1.1 albertel 101:
102: # ----------------------------------------------------- Force menu registration
103: # Header
104: my $course_type = &Apache::loncommon::course_type();
1.15 droeschl 105: my $title = $course_type . ' Contents';
1.17 raeburn 106: my ($start_page,$args);
107: if ($env{'form.register'}) {
108: $args = {'force_register' => $env{'form.register'}};
109: $start_page = &Apache::loncommon::start_page($title,undef,$args);
110: } else {
111: my $brcrum = [{href => '/adm/navmaps',
112: text => &mt($course_type . ' Contents'),
113: no_mt => 1},
114: ];
115: $args = {'bread_crumbs' => $brcrum};
116: $start_page = &Apache::loncommon::start_page($title,undef,$args);
117: }
118: $r->print($start_page.
119: '<script type="text/javascript">window.focus();</script>');
1.20 raeburn 120: &startContentScreen($r,'navmaps');
1.1 albertel 121: $r->rflush();
122:
123: # Check that it's defined
124: if (!($navmap->courseMapDefined())) {
125: $r->print(&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT'));
126: $r->print('<span class="LC_error">'.&mt('Coursemap undefined.').
127: '</span>' .
128: &Apache::loncommon::end_page());
129: return OK;
130: }
131:
1.22.4.6! raeburn 132: my %toplinkitems=();
1.21 raeburn 133: my @resources = $navmap->retrieveResources();
134: my $sequenceCount = 0;
135: my $problemCount = 0;
136: my $notaprobCount = 0;
137: my $sequenceId;
138: my $notools;
139: foreach my $curRes (@resources) {
140: if (ref($curRes)) {
141: if ($curRes->is_sequence()) {
1.1 albertel 142: $sequenceCount++;
143: $sequenceId = $curRes->map_pc();
1.21 raeburn 144: } elsif ($curRes->is_problem()) {
145: $problemCount ++;
146: } else {
147: $notaprobCount ++;
1.1 albertel 148: }
149: }
1.21 raeburn 150: }
151: if (($sequenceCount == 1) && (!$problemCount) && ($notaprobCount <= 1)) {
152: $notools = 1;
153: }
154:
155: # If there's only one map in the top-level and we don't
156: # already have a filter, automatically display it
157: if ($ENV{QUERY_STRING} !~ /filter/) {
1.1 albertel 158: if ($sequenceCount == 1) {
159: # The automatic iterator creation in the render call
160: # will pick this up. We know the condition because
161: # the defined($env{'form.filter'}) also ensures this
162: # is a fresh call.
163: $env{'form.filter'} = "$sequenceId";
164: }
165: }
166:
167: # Check to see if the student is jumping to next open, do-able problem
168: if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
169: # Find the next homework problem that they can do.
170: my $iterator = $navmap->getIterator(undef, undef, undef, 1);
171: my $curRes;
172: my $foundDoableProblem = 0;
173: my $minimumduedate;
1.2 albertel 174: my $now = time();
175:
1.1 albertel 176: while ($curRes = $iterator->next()) {
177: if (ref($curRes) && $curRes->is_problem()) {
178: my $status = $curRes->status();
1.2 albertel 179: my $thisduedate=$curRes->duedate();
180: if ($thisduedate > $now
181: && $curRes->completable()) {
1.1 albertel 182:
183: $foundDoableProblem = 1;
184:
1.2 albertel 185: if (!defined($minimumduedate)
186: || $thisduedate<$minimumduedate) {
1.1 albertel 187: # Pop open all previous maps
188: my $stack = $iterator->getStack();
189: pop @$stack; # last resource in the stack is the problem
190: # itself, which we don't need in the map stack
191: my @mapPcs = map {$_->map_pc()} @$stack;
192: $env{'form.filter'} = join(',', @mapPcs);
193:
194: # Mark as both "here" and "jump"
195: $env{'form.postsymb'} = $curRes->symb();
196: $minimumduedate=$thisduedate;
197: }
198: }
199: }
200: }
201:
202: # If we found no problems, print a note to that effect.
203: if (!$foundDoableProblem) {
1.7 schulted 204: $r->print("<span class=\"LC_info\">"
1.4 bisitz 205: .&mt("All homework assignments have been completed.")
1.7 schulted 206: ."</span>");
1.1 albertel 207: }
208: } else {
1.17 raeburn 209: my $link = 'navmaps?jumpToFirstHomework';
210: if ($env{'form.register'}) {
211: $link .= '&register='.$env{'form.register'};
212: }
1.21 raeburn 213: unless ($notools) {
214: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
215: 'location.href="'.$link.'"',
216: "Show my first due problem");
217: }
1.1 albertel 218: }
219:
220: my $suppressEmptySequences = 0;
221: my $filterFunc = undef;
222: my $resource_no_folder_link = 0;
223:
224: # Display only due homework.
225: my $showOnlyHomework = 0;
226: if ($env{'form.showOnlyHomework'} eq "1") {
227: $showOnlyHomework = 1;
228: $suppressEmptySequences = 1;
229: $filterFunc = sub { my $res = shift;
230: return $res->completable() || $res->is_map();
231: };
1.17 raeburn 232: my $link = 'navmaps?sort='.$env{'form.sort'};
233: if ($env{'form.register'}) {
234: $link .= '&register='.$env{'form.register'};
235: }
1.1 albertel 236: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',
1.17 raeburn 237: 'location.href="'.$link.'"',
238: 'Show everything');
1.7 schulted 239: $r->print("<span class=\"LC_info\">".&mt("Uncompleted Problems")."</span>");
1.1 albertel 240: $env{'form.filter'} = '';
241: $env{'form.condition'} = 1;
242: $resource_no_folder_link = 1;
243: } else {
1.17 raeburn 244: my $link = 'navmaps?sort='.$env{'form.sort'}.'&showOnlyHomework=1';
245: if ($env{'form.register'}) {
246: $link .= '&register='.$env{'form.register'};
247: }
1.21 raeburn 248: unless ($notools) {
249: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
250: 'location.href="'.$link.'"',
251: 'Show only uncompleted problems');
252: }
1.1 albertel 253: }
254:
1.10 bisitz 255: my %selected=($env{'form.sort'} => ' selected="selected"');
1.21 raeburn 256: my $sort_html;
257: unless ($notools) {
258: $sort_html=(
259: '<form name="sortForm" action="">
1.17 raeburn 260: <span class="LC_nobreak">
261: <input type="hidden" name="showOnlyHomework" value="'.$env{'form.showOnlyHomework'}.'" />
262: '.&mt('Sort by:').'
1.18 bisitz 263: <select name="sort" onchange="document.sortForm.submit()">
1.17 raeburn 264: <option value="default"'.$selected{'default'}.'>'.&mt('Default').'</option>
265: <option value="title"'.$selected{'title'}.'>'.&mt('Title').'</option>
1.22.4.3 raeburn 266: <option value="duedate"'.$selected{'duedate'}.'>'.&mt('Due Date').'</option>
1.17 raeburn 267: <option value="discussion"'.$selected{'discussion'}.'>'.&mt('Has New Discussion').'</option>
1.1 albertel 268: </select>
1.17 raeburn 269: <input type="hidden" name="register" value="'.$env{'form.register'}.'" />
1.9 bisitz 270: </span>
1.17 raeburn 271: </form>');
1.21 raeburn 272: }
1.1 albertel 273: # renderer call
274: my $renderArgs = { 'cols' => [0,1,2,3],
275: 'sort' => $env{'form.sort'},
276: 'url' => '/adm/navmaps',
277: 'navmap' => $navmap,
278: 'suppressNavmap' => 1,
279: 'suppressEmptySequences' => $suppressEmptySequences,
280: 'filterFunc' => $filterFunc,
281: 'resource_no_folder_link' => $resource_no_folder_link,
282: 'sort_html'=> $sort_html,
283: 'r' => $r,
284: 'caller' => 'navmapsdisplay',
1.21 raeburn 285: 'linkitems' => \%toplinkitems,
286: 'notools' => $notools};
287:
1.1 albertel 288: my $render = &Apache::lonnavmaps::render($renderArgs);
289:
290: # If no resources were printed, print a reassuring message so the
291: # user knows there was no error.
292: if ($renderArgs->{'counter'} == 0) {
293: if ($showOnlyHomework) {
1.7 schulted 294: $r->print("<p><span class=\"LC_info\">".&mt("All homework is currently completed.")."</span></p>");
1.1 albertel 295: } else { # both jumpToFirstHomework and normal use the same: course must be empty
1.7 schulted 296: $r->print("<p><span class=\"LC_info\">".&mt("This course is empty.")."</span></p>");
1.1 albertel 297: }
298: }
1.20 raeburn 299: &endContentScreen($r);
1.1 albertel 300: $r->print(&Apache::loncommon::end_page());
301: $r->rflush();
302:
303: return OK;
304: }
305:
1.20 raeburn 306: sub startContentScreen {
307: my ($r,$mode)=@_;
308:
309: $r->print("\n".'<ul class="LC_TabContentBigger" id="mainnav">'."\n");
1.22 www 310: $r->print('<li'.(($mode eq 'navmaps')?' class="active"':'').'><a href="/adm/navmaps"><b> '.&mt('Main Content').' </b></a></li>'."\n");
1.22.4.2 raeburn 311: my $allowed = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
312: my ($suppcount,$errors);
313: unless ($allowed) {
314: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
315: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
316: ($suppcount,$errors) = &Apache::lonnet::get_numsuppfiles($cnum,$cdom);
317: }
318: if ($allowed || $suppcount) {
319: $r->print('<li '.(($mode eq 'supplemental')?' class="active"':'').'><a href="/adm/supplemental"><b>'.&mt('Supplemental Content').'</b></a></li>');
320: }
1.20 raeburn 321: $r->print('<li'.(($mode eq 'coursesearch')?' class="active"':'').'><a href="/adm/searchcourse"><b> '.&mt('Content Search').' </b></a></li>'."\n");
322: $r->print("\n".'</ul>'."\n");
323: $r->print('<div class="LC_Box" style="clear:both;margin:0;"><div id="maincoursedoc" style="margin:0 0;padding:0 0;"><div class="LC_ContentBox" id="mainCourseDocuments" style="display: block;">');
324: }
325:
326: sub endContentScreen {
327: my ($r)=@_;
328: $r->print('</div></div></div>');
329: }
330:
1.1 albertel 331: 1;
332: __END__
333:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnavdisplay.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface