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