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