Annotation of loncom/interface/lonnavdisplay.pm, revision 1.13.6.3
1.1 albertel 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
3: #
1.13.6.3! raeburn 4: # $Id: lonnavdisplay.pm,v 1.13.6.2 2010/10/04 21:46: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;
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
1.13.6.1 raeburn 142: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort','showOnlyHomework','postsymb','register']);
1.1 albertel 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.6.2 raeburn 158: my ($title,$breadcrumb_text,$start_page,$args);
1.13.6.3! raeburn 159: $title = 'Contents';
! 160: $breadcrumb_text = &mt('Contents');
1.13.6.1 raeburn 161: if ($env{'form.register'}) {
1.13.6.3! raeburn 162: $args = {'force_register' => $env{'form.register'}};
! 163: my $brcrum = [{href => '/adm/navmaps',
! 164: text => $breadcrumb_text,
! 165: no_mt => 1,},
! 166: ];
! 167: $args = {'bread_crumbs' => $brcrum,
! 168: 'only_body' => $body_only};
1.13.6.1 raeburn 169: $start_page = &Apache::loncommon::start_page($title,$js,$args);
170: } else {
1.13.6.3! raeburn 171: my $nomenu = 0;
! 172: if ((&Apache::loncommon::needs_gci_custom()) ||
! 173: ($env{'user.domain'} eq 'gcitest' && $env{'request.course.id'})) {
! 174: $nomenu = 1;
! 175: }
! 176: my $brcrum = [{href => '/adm/navmaps',
! 177: text => $breadcrumb_text,
! 178: no_mt => 1,
! 179: _nomenu => $nomenu,},
1.13.6.1 raeburn 180: ];
181: $args = {'bread_crumbs' => $brcrum,
182: 'only_body' => $body_only};
183: $start_page = &Apache::loncommon::start_page($title,$js,$args);
184: }
1.13.6.2 raeburn 185: $r->print($start_page.
186: '<script type="text/javascript">window.focus();</script>');
1.1 albertel 187:
188: $r->rflush();
189:
190: # Check that it's defined
191: if (!($navmap->courseMapDefined())) {
192: $r->print(&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT'));
193: $r->print('<span class="LC_error">'.&mt('Coursemap undefined.').
194: '</span>' .
195: &Apache::loncommon::end_page());
196: return OK;
197: }
198:
199: # See if there's only one map in the top-level, if we don't
200: # already have a filter... if so, automatically display it
201: # (older code; should use retrieveResources)
202: if ($ENV{QUERY_STRING} !~ /filter/) {
203: my $iterator = $navmap->getIterator(undef, undef, undef, 0);
204: my $curRes;
205: my $sequenceCount = 0;
206: my $sequenceId;
207: while ($curRes = $iterator->next()) {
208: if (ref($curRes) && $curRes->is_sequence()) {
209: $sequenceCount++;
210: $sequenceId = $curRes->map_pc();
211: }
212: }
213:
214: if ($sequenceCount == 1) {
215: # The automatic iterator creation in the render call
216: # will pick this up. We know the condition because
217: # the defined($env{'form.filter'}) also ensures this
218: # is a fresh call.
219: $env{'form.filter'} = "$sequenceId";
220: }
221: }
222:
223: if ($ENV{QUERY_STRING} eq 'launchExternal') {
224: $r->print('
225: <form name="returnwin" action="/adm/flip?postdata=navlaunch%3a"
226: method="post" target="loncapaclient">
227: </form>');
228: $r->print('
229: <script type="text/javascript">
230: this.document.returnwin.submit();
231: </script>');
232: }
233:
234: if ($env{'environment.remotenavmap'} ne 'on') {
235: $r->print(&launch_win('link','yes',\%toplinkitems));
236: }
237: if ($env{'environment.remotenavmap'} eq 'on') {
238: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'closenav',
239: 'collapse()',
240: "Close navigation window");
241: }
242:
243:
244: # Check to see if the student is jumping to next open, do-able problem
245: if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
246: # Find the next homework problem that they can do.
247: my $iterator = $navmap->getIterator(undef, undef, undef, 1);
248: my $curRes;
249: my $foundDoableProblem = 0;
250: my $minimumduedate;
1.2 albertel 251: my $now = time();
252:
1.1 albertel 253: while ($curRes = $iterator->next()) {
254: if (ref($curRes) && $curRes->is_problem()) {
255: my $status = $curRes->status();
1.2 albertel 256: my $thisduedate=$curRes->duedate();
257: if ($thisduedate > $now
258: && $curRes->completable()) {
1.1 albertel 259:
260: $foundDoableProblem = 1;
261:
1.2 albertel 262: if (!defined($minimumduedate)
263: || $thisduedate<$minimumduedate) {
1.1 albertel 264: # Pop open all previous maps
265: my $stack = $iterator->getStack();
266: pop @$stack; # last resource in the stack is the problem
267: # itself, which we don't need in the map stack
268: my @mapPcs = map {$_->map_pc()} @$stack;
269: $env{'form.filter'} = join(',', @mapPcs);
270:
271: # Mark as both "here" and "jump"
272: $env{'form.postsymb'} = $curRes->symb();
273: $minimumduedate=$thisduedate;
274: }
275: }
276: }
277: }
278:
279: # If we found no problems, print a note to that effect.
280: if (!$foundDoableProblem) {
1.7 schulted 281: $r->print("<span class=\"LC_info\">"
1.4 bisitz 282: .&mt("All homework assignments have been completed.")
1.7 schulted 283: ."</span>");
1.1 albertel 284: }
285: } else {
1.13.6.1 raeburn 286: my $link = 'navmaps?jumpToFirstHomework';
287: if ($env{'form.register'}) {
288: $link .= '&register='.$env{'form.register'};
289: }
1.1 albertel 290: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
1.13.6.1 raeburn 291: 'location.href="'.$link.'"',
1.1 albertel 292: "Show my first due problem");
293: }
294:
295: my $suppressEmptySequences = 0;
296: my $filterFunc = undef;
297: my $resource_no_folder_link = 0;
298:
299: # Display only due homework.
300: my $showOnlyHomework = 0;
301: if ($env{'form.showOnlyHomework'} eq "1") {
302: $showOnlyHomework = 1;
303: $suppressEmptySequences = 1;
304: $filterFunc = sub { my $res = shift;
305: return $res->completable() || $res->is_map();
306: };
1.13.6.1 raeburn 307: my $link = 'navmaps?sort='.$env{'form.sort'};
308: if ($env{'form.register'}) {
309: $link .= '&register='.$env{'form.register'};
310: }
1.1 albertel 311: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',
1.13.6.1 raeburn 312: 'location.href="'.$link.'"',
1.1 albertel 313: "Show everything");
1.7 schulted 314: $r->print("<span class=\"LC_info\">".&mt("Uncompleted Problems")."</span>");
1.1 albertel 315: $env{'form.filter'} = '';
316: $env{'form.condition'} = 1;
317: $resource_no_folder_link = 1;
318: } else {
1.13.6.2 raeburn 319: my $link = 'navmaps?sort='.$env{'form.sort'}.'&showOnlyHomework=1';
320: if ($env{'form.register'}) {
321: $link .= '&register='.$env{'form.register'};
322: }
1.1 albertel 323: &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
1.13.6.2 raeburn 324: 'location.href="'.$link.'"',
1.1 albertel 325: "Show only uncompleted problems");
326: }
327:
1.10 bisitz 328: my %selected=($env{'form.sort'} => ' selected="selected"');
1.13.6.1 raeburn 329: my $sort_html=('<form name="sortForm" action="">
330: <span class="LC_nobreak">
331: <input type="hidden" name="showOnlyHomework" value="'.$env{'form.showOnlyHomework'}.'" />
332: '.&mt('Sort by:').'
333: <select name="sort" onchange="document.sortForm.submit()">
1.13.6.2 raeburn 334: <option value="default"'.$selected{'default'}.'>'.&mt('Default').'</option>
335: <option value="title"'.$selected{'title'}.'>'.&mt('Title').'</option>
1.13.6.1 raeburn 336: <option value="duedate"'.$selected{'duedate'}.'>'.&mt('Duedate').'</option>
337: <option value="discussion"'.$selected{'discussion'}.'>'.&mt('Has New Discussion').'</option>
1.1 albertel 338: </select>
1.13.6.1 raeburn 339: <input type="hidden" name="register" value="'.$env{'form.register'}.'" />
1.9 bisitz 340: </span>
1.13.6.1 raeburn 341: </form>');
1.1 albertel 342: # renderer call
343: my $renderArgs = { 'cols' => [0,1,2,3],
344: 'sort' => $env{'form.sort'},
345: 'url' => '/adm/navmaps',
346: 'navmap' => $navmap,
347: 'suppressNavmap' => 1,
348: 'suppressEmptySequences' => $suppressEmptySequences,
349: 'filterFunc' => $filterFunc,
350: 'resource_no_folder_link' => $resource_no_folder_link,
351: 'sort_html'=> $sort_html,
352: 'r' => $r,
353: 'caller' => 'navmapsdisplay',
354: 'linkitems' => \%toplinkitems};
355: my $render = &Apache::lonnavmaps::render($renderArgs);
356:
357: # If no resources were printed, print a reassuring message so the
358: # user knows there was no error.
359: if ($renderArgs->{'counter'} == 0) {
360: if ($showOnlyHomework) {
1.7 schulted 361: $r->print("<p><span class=\"LC_info\">".&mt("All homework is currently completed.")."</span></p>");
1.1 albertel 362: } else { # both jumpToFirstHomework and normal use the same: course must be empty
1.7 schulted 363: $r->print("<p><span class=\"LC_info\">".&mt("This course is empty.")."</span></p>");
1.1 albertel 364: }
365: }
366: #my $td=&tv_interval($t0);
367: #$r->print("<br />$td");
368:
369: $r->print(&Apache::loncommon::end_page());
370: $r->rflush();
371:
372: return OK;
373: }
374:
375: sub launch_win {
376: my ($mode,$script,$toplinkitems,$firsttime)=@_;
377: my $result;
378: if ($script ne 'no') {
379: $result.='<script type="text/javascript">';
380: }
381: if ($firsttime) {
382: $result.='function launch_navmapwin() {
383: newWindow=open(\'/adm/navmaps?launchExternalRoles\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
384: }';
385: } else {
386: $result.='function launch_navmapwin() {
387: newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
388: }';
389: }
390: if ($mode eq 'now') {
391: $result.="\nlaunch_navmapwin();\n";
392: }
393: if ($script ne 'no') {
394: $result.='</script>';
395: }
396: if ($mode eq 'link') {
397: &Apache::lonnavmaps::add_linkitem($toplinkitems,'launchnav',
398: 'launch_navmapwin()',
399: "Launch navigation window");
400: }
401: return $result;
402: }
403:
404: 1;
405: __END__
406:
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