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