Annotation of loncom/interface/lonnavdisplay.pm, revision 1.2

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>