Annotation of loncom/interface/lonnavdisplay.pm, revision 1.13.4.4
1.1 albertel 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
3: #
1.13.4.4! raeburn 4: # $Id: lonnavdisplay.pm,v 1.13.4.3 2010/08/14 21:42:59 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;
33: use Apache::Constants qw(:common :http);
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.2 albertel 40: use Time::HiRes qw( gettimeofday tv_interval );
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: #my $t0=[&gettimeofday()];
50: # Handle header-only request
51: if ($r->header_only) {
52: if ($env{'browser.mathml'}) {
53: &Apache::loncommon::content_type($r,'text/xml');
54: } else {
55: &Apache::loncommon::content_type($r,'text/html');
56: }
57: $r->send_http_header;
58: return OK;
59: }
60:
61: # Send header, don't cache this page
62: if ($env{'browser.mathml'}) {
63: &Apache::loncommon::content_type($r,'text/xml');
64: } else {
65: &Apache::loncommon::content_type($r,'text/html');
66: }
67: &Apache::loncommon::no_cache($r);
68:
69: my %toplinkitems=();
70: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'blank','',
71: "Select Action");
72: if ($ENV{QUERY_STRING} eq 'collapseExternal') {
73: &Apache::lonnet::put('environment',{'remotenavmap' => 'off'});
1.3 raeburn 74: &Apache::lonnet::appenv({'environment.remotenavmap' => 'off'});
1.1 albertel 75: my $menu=&Apache::lonmenu::reopenmenu();
76: my $navstatus=&Apache::lonmenu::get_nav_status();
77: if ($menu) {
78: $menu=(<<MENU)
79: swmenu=$menu
80: swmenu.clearTimeout(swmenu.menucltim);
81: $navstatus
82: MENU
83: } else {
84: my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
85: my $mainwindow='window.open('.$nothing.',"loncapaclient","",false);';
86: $menu=(<<MENU)
87: swmenu=$mainwindow
88: $navstatus
89: MENU
90: }
91: $r->send_http_header;
92: my $js =<<"ENDSUBM";
93: <script type="text/javascript">
94: function submitthis() {
95: $menu
96: self.close();
97: }
98:
99: </script>
100: ENDSUBM
101: $r->print(&Apache::loncommon::start_page(undef,$js,
102: {'only_body' => 1,
103: 'bgcolor' => '#FFFFFF',
104: 'add_entries' =>
105: {'onload' =>
106: "submitthis()"}}).
107: &Apache::loncommon::end_page());
108:
109: return OK;
110: }
111: if ($ENV{QUERY_STRING} =~ /^launchExternal/) {
112: &Apache::lonnet::put('environment',{'remotenavmap' => 'on'});
1.3 raeburn 113: &Apache::lonnet::appenv({'environment.remotenavmap' => 'on'});
1.1 albertel 114: my $menu=&Apache::lonmenu::reopenmenu();
115: my $navstatus=&Apache::lonmenu::get_nav_status();
116: if ($menu) {
117: $r->print(<<MENU);
118: <script type="text/javascript">
119: swmenu=$menu
120: swmenu.clearTimeout(swmenu.menucltim);
121: $navstatus
122: </script>
123: MENU
124: }
125: }
126: if ($ENV{QUERY_STRING} eq 'turningOffExternal') {
127: $env{'environment.remotenavmap'}='off';
128: }
129:
130: # Create the nav map
131: my $navmap = Apache::lonnavmaps::navmap->new();
132:
133: if (!defined($navmap)) {
134: my $requrl = $r->uri;
135: $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
1.5 raeburn 136: $env{'user.reinit'} = 1;
1.1 albertel 137: return HTTP_NOT_ACCEPTABLE;
138: }
139: $r->send_http_header;
140:
141: # ------------------------------------------------------------ Get query string
142: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register','sort','showOnlyHomework','postsymb']);
143:
144: # ----------------------------------------------------- Force menu registration
145: my $body_only='';
146: my $js;
147: if ($env{'environment.remotenavmap'} eq 'on') {
148: $js='<script type="text/javascript">
149: function collapse() {
150: this.document.location="/adm/navmaps?collapseExternal";
151: }
152: </script>';
153: $body_only=1;
154: }
155:
156: # Header
157: my $course_type = &Apache::loncommon::course_type();
1.13.4.1 raeburn 158: my ($title,$breadcrumb_text,$start_page,$args);
1.13 raeburn 159: if ($course_type eq 'Community') {
160: $title = 'Community Contents';
161: $breadcrumb_text = &mt('Community Contents');
162: } else {
163: $title = 'Course Contents';
164: $breadcrumb_text = &mt('Course Contents');
165: }
1.13.4.1 raeburn 166: if ($env{'form.register'}) {
167: $args = {'force_register' => $env{'form.register'}};
1.13.4.4! raeburn 168: if ($body_only && $env{'environment.remote'} eq 'on') {
! 169: $args->{only_body} = 1;
! 170: }
1.13.4.1 raeburn 171: $start_page = &Apache::loncommon::start_page($title,$js,$args);
172: } else {
173: my $brcrum = [{href => '/adm/navmaps',
174: text => $breadcrumb_text,
175: no_mt => 1},
176: ];
1.13.4.4! raeburn 177: unless ($env{'environment.remotenavmap'} eq 'on') {
! 178: $args = {'bread_crumbs' => $brcrum};
! 179: }
! 180: if ($body_only && $env{'environment.remote'} eq 'on') {
! 181: $args->{only_body} = 1;
! 182: }
1.13.4.2 raeburn 183: $start_page = &Apache::loncommon::start_page($title,$js,$args);
1.13.4.1 raeburn 184: }
185: $r->print($start_page.
186: '<script type="text/javascript">window.focus();</script>');
1.1 albertel 187: $r->rflush();
188:
189: # Check that it's defined
190: if (!($navmap->courseMapDefined())) {
191: $r->print(&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT'));
192: $r->print('<span class="LC_error">'.&mt('Coursemap undefined.').
193: '</span>' .
194: &Apache::loncommon::end_page());
195: return OK;
196: }
197:
198: # See if there's only one map in the top-level, if we don't
199: # already have a filter... if so, automatically display it
200: # (older code; should use retrieveResources)
201: if ($ENV{QUERY_STRING} !~ /filter/) {
202: my $iterator = $navmap->getIterator(undef, undef, undef, 0);
203: my $curRes;
204: my $sequenceCount = 0;
205: my $sequenceId;
206: while ($curRes = $iterator->next()) {
207: if (ref($curRes) && $curRes->is_sequence()) {
208: $sequenceCount++;
209: $sequenceId = $curRes->map_pc();
210: }
211: }
212:
213: if ($sequenceCount == 1) {
214: # The automatic iterator creation in the render call
215: # will pick this up. We know the condition because
216: # the defined($env{'form.filter'}) also ensures this
217: # is a fresh call.
218: $env{'form.filter'} = "$sequenceId";
219: }
220: }
221:
222: if ($ENV{QUERY_STRING} eq 'launchExternal') {
223: $r->print('
224: <form name="returnwin" action="/adm/flip?postdata=navlaunch%3a"
225: method="post" target="loncapaclient">
226: </form>');
227: $r->print('
228: <script type="text/javascript">
229: this.document.returnwin.submit();
230: </script>');
231: }
232:
233: if ($env{'environment.remotenavmap'} ne 'on') {
234: $r->print(&launch_win('link','yes',\%toplinkitems));
235: }
236: if ($env{'environment.remotenavmap'} eq 'on') {
237: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'closenav',
238: 'collapse()',
239: "Close navigation window");
240: }
241:
242:
243: # Check to see if the student is jumping to next open, do-able problem
244: if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
245: # Find the next homework problem that they can do.
246: my $iterator = $navmap->getIterator(undef, undef, undef, 1);
247: my $curRes;
248: my $foundDoableProblem = 0;
249: my $minimumduedate;
1.2 albertel 250: my $now = time();
251:
1.1 albertel 252: while ($curRes = $iterator->next()) {
253: if (ref($curRes) && $curRes->is_problem()) {
254: my $status = $curRes->status();
1.2 albertel 255: my $thisduedate=$curRes->duedate();
256: if ($thisduedate > $now
257: && $curRes->completable()) {
1.1 albertel 258:
259: $foundDoableProblem = 1;
260:
1.2 albertel 261: if (!defined($minimumduedate)
262: || $thisduedate<$minimumduedate) {
1.1 albertel 263: # Pop open all previous maps
264: my $stack = $iterator->getStack();
265: pop @$stack; # last resource in the stack is the problem
266: # itself, which we don't need in the map stack
267: my @mapPcs = map {$_->map_pc()} @$stack;
268: $env{'form.filter'} = join(',', @mapPcs);
269:
270: # Mark as both "here" and "jump"
271: $env{'form.postsymb'} = $curRes->symb();
272: $minimumduedate=$thisduedate;
273: }
274: }
275: }
276: }
277:
278: # If we found no problems, print a note to that effect.
279: if (!$foundDoableProblem) {
1.7 schulted 280: $r->print("<span class=\"LC_info\">"
1.4 bisitz 281: .&mt("All homework assignments have been completed.")
1.7 schulted 282: ."</span>");
1.1 albertel 283: }
284: } else {
1.13.4.1 raeburn 285: my $link = 'navmaps?jumpToFirstHomework';
286: if ($env{'form.register'}) {
287: $link .= '&register='.$env{'form.register'};
288: }
1.1 albertel 289: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
1.13.4.1 raeburn 290: 'location.href="'.$link.'"',
1.1 albertel 291: "Show my first due problem");
292: }
293:
294: my $suppressEmptySequences = 0;
295: my $filterFunc = undef;
296: my $resource_no_folder_link = 0;
297:
298: # Display only due homework.
299: my $showOnlyHomework = 0;
300: if ($env{'form.showOnlyHomework'} eq "1") {
301: $showOnlyHomework = 1;
302: $suppressEmptySequences = 1;
303: $filterFunc = sub { my $res = shift;
304: return $res->completable() || $res->is_map();
305: };
1.13.4.1 raeburn 306: my $link = 'navmaps?sort='.$env{'form.sort'};
307: if ($env{'form.register'}) {
308: $link .= '&register='.$env{'form.register'};
309: }
1.1 albertel 310: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',
1.13.4.1 raeburn 311: 'location.href="'.$link.'"',
1.1 albertel 312: "Show everything");
1.7 schulted 313: $r->print("<span class=\"LC_info\">".&mt("Uncompleted Problems")."</span>");
1.1 albertel 314: $env{'form.filter'} = '';
315: $env{'form.condition'} = 1;
316: $resource_no_folder_link = 1;
317: } else {
1.13.4.1 raeburn 318: my $link = 'navmaps?sort='.$env{'form.sort'}.'&showOnlyHomework=1';
319: if ($env{'form.register'}) {
320: $link .= '&register='.$env{'form.register'};
321: }
1.1 albertel 322: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
1.13.4.1 raeburn 323: 'location.href="'.$link.'"',
1.1 albertel 324: "Show only uncompleted problems");
325: }
326:
1.10 bisitz 327: my %selected=($env{'form.sort'} => ' selected="selected"');
1.13.4.3 raeburn 328: my $sort_html=('<form name="sortForm" action="">
1.13.4.1 raeburn 329: <span class="LC_nobreak">
330: <input type="hidden" name="showOnlyHomework" value="'.$env{'form.showOnlyHomework'}.'" />
331: '.&mt('Sort by:').'
1.13.4.3 raeburn 332: <select name="sort" onchange="document.sortForm.submit()">
1.13.4.1 raeburn 333: <option value="default"'.$selected{'default'}.'>'.&mt('Default').'</option>
334: <option value="title"'.$selected{'title'}.'>'.&mt('Title').'</option>
335: <option value="duedate"'.$selected{'duedate'}.'>'.&mt('Duedate').'</option>
336: <option value="discussion"'.$selected{'discussion'}.'>'.&mt('Has New Discussion').'</option>
337: </select>
338: <input type="hidden" name="register" value="'.$env{'form.register'}.'" />
1.9 bisitz 339: </span>
1.13.4.1 raeburn 340: </form>');
1.1 albertel 341: # renderer call
342: my $renderArgs = { 'cols' => [0,1,2,3],
343: 'sort' => $env{'form.sort'},
344: 'url' => '/adm/navmaps',
345: 'navmap' => $navmap,
346: 'suppressNavmap' => 1,
347: 'suppressEmptySequences' => $suppressEmptySequences,
348: 'filterFunc' => $filterFunc,
349: 'resource_no_folder_link' => $resource_no_folder_link,
350: 'sort_html'=> $sort_html,
351: 'r' => $r,
352: 'caller' => 'navmapsdisplay',
353: 'linkitems' => \%toplinkitems};
354: my $render = &Apache::lonnavmaps::render($renderArgs);
355:
356: # If no resources were printed, print a reassuring message so the
357: # user knows there was no error.
358: if ($renderArgs->{'counter'} == 0) {
359: if ($showOnlyHomework) {
1.7 schulted 360: $r->print("<p><span class=\"LC_info\">".&mt("All homework is currently completed.")."</span></p>");
1.1 albertel 361: } else { # both jumpToFirstHomework and normal use the same: course must be empty
1.7 schulted 362: $r->print("<p><span class=\"LC_info\">".&mt("This course is empty.")."</span></p>");
1.1 albertel 363: }
364: }
365: #my $td=&tv_interval($t0);
366: #$r->print("<br />$td");
367:
368: $r->print(&Apache::loncommon::end_page());
369: $r->rflush();
370:
371: return OK;
372: }
373:
374: sub launch_win {
375: my ($mode,$script,$toplinkitems,$firsttime)=@_;
376: my $result;
377: if ($script ne 'no') {
378: $result.='<script type="text/javascript">';
379: }
380: if ($firsttime) {
381: $result.='function launch_navmapwin() {
382: newWindow=open(\'/adm/navmaps?launchExternalRoles\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
383: }';
384: } else {
385: $result.='function launch_navmapwin() {
386: newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
387: }';
388: }
389: if ($mode eq 'now') {
390: $result.="\nlaunch_navmapwin();\n";
391: }
392: if ($script ne 'no') {
393: $result.='</script>';
394: }
395: if ($mode eq 'link') {
396: &Apache::lonnavmaps::add_linkitem($toplinkitems,'launchnav',
397: 'launch_navmapwin()',
398: "Launch navigation window");
399: }
400: return $result;
401: }
402:
403: 1;
404: __END__
405:
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