Return to lonnavdisplay.pm CVS log

Up to [LON-CAPA] / loncom / interface

- Supplemental Content Tab not shown on Course Contents screen unless
  user has mdc priv in course, or Supplemental content contains one or
  more resources (folders not counted).

    1: # The LearningOnline Network with CAPA
    2: # Navigate Maps Handler
    3: #
    4: # $Id: lonnavdisplay.pm,v 1.23 2013/08/07 00:03:25 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 Apache::londocs();
   41: use Time::HiRes qw( gettimeofday tv_interval );
   42: 
   43: sub handler {
   44:     my $r = shift;
   45:     real_handler($r);
   46: }
   47: 
   48: sub real_handler {
   49:     my $r = shift;
   50:     #my $t0=[&gettimeofday()];
   51:     # Handle header-only request
   52:     if ($r->header_only) {
   53:         if ($env{'browser.mathml'}) {
   54:             &Apache::loncommon::content_type($r,'text/xml');
   55:         } else {
   56:             &Apache::loncommon::content_type($r,'text/html');
   57:         }
   58:         $r->send_http_header;
   59:         return OK;
   60:     }
   61: 
   62:     # Send header, don't cache this page
   63:     if ($env{'browser.mathml'}) {
   64:         &Apache::loncommon::content_type($r,'text/xml');
   65:     } else {
   66:         &Apache::loncommon::content_type($r,'text/html');
   67:     }
   68:     &Apache::loncommon::no_cache($r);
   69: 
   70:     my %toplinkitems=();
   71: 
   72:     # Create the nav map
   73:     my $navmap = Apache::lonnavmaps::navmap->new();
   74: 
   75:     if (!defined($navmap)) {
   76:         my $requrl = $r->uri;
   77:         $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
   78:         $env{'user.reinit'} = 1;
   79:         return HTTP_NOT_ACCEPTABLE;
   80:     }
   81:     $r->send_http_header;
   82: 
   83: # ------------------------------------------------------------ Get query string
   84:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort','showOnlyHomework','postsymb','register']);
   85:     
   86: # ----------------------------------------------------- Force menu registration
   87:     # Header
   88:     my $course_type = &Apache::loncommon::course_type();
   89:     my $title = $course_type . ' Contents';
   90:     my ($start_page,$args);
   91:     if ($env{'form.register'}) {
   92:         $args = {'force_register' => $env{'form.register'}};
   93:         $start_page = &Apache::loncommon::start_page($title,undef,$args);
   94:     } else {
   95:         my $brcrum = [{href => '/adm/navmaps',
   96:                        text => &mt($course_type . ' Contents'),
   97:                        no_mt => 1},
   98:                      ];
   99:         $args = {'bread_crumbs' => $brcrum};
  100:         $start_page = &Apache::loncommon::start_page($title,undef,$args);
  101:     }
  102:     $r->print($start_page.
  103:               '<script type="text/javascript">window.focus();</script>');
  104:     &startContentScreen($r,'navmaps');
  105:     $r->rflush();
  106: 
  107:     # Check that it's defined
  108:     if (!($navmap->courseMapDefined())) {
  109: 	$r->print(&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT'));
  110:         $r->print('<span class="LC_error">'.&mt('Coursemap undefined.').
  111: 		  '</span>' .
  112:                   &Apache::loncommon::end_page());
  113:         return OK;
  114:     }
  115: 
  116:     my @resources = $navmap->retrieveResources();
  117:     my $sequenceCount = 0;
  118:     my $problemCount = 0;
  119:     my $notaprobCount = 0;
  120:     my $sequenceId;
  121:     my $notools;
  122:     foreach my $curRes (@resources) {
  123:         if (ref($curRes)) {
  124:             if ($curRes->is_sequence()) {
  125:                 $sequenceCount++;
  126:                 $sequenceId = $curRes->map_pc();
  127:             } elsif ($curRes->is_problem()) {
  128:                 $problemCount ++;
  129:             } else {
  130:                 $notaprobCount ++;
  131:             }
  132:         }
  133:     }
  134:     if (($sequenceCount == 1) && (!$problemCount) && ($notaprobCount <= 1)) {
  135:         $notools = 1;
  136:     }
  137: 
  138:     # If there's only one map in the top-level and we don't
  139:     # already have a filter, automatically display it
  140:     if ($ENV{QUERY_STRING} !~ /filter/) {
  141:         if ($sequenceCount == 1) {
  142:             # The automatic iterator creation in the render call 
  143:             # will pick this up. We know the condition because
  144:             # the defined($env{'form.filter'}) also ensures this
  145:             # is a fresh call.
  146:             $env{'form.filter'} = "$sequenceId";
  147:         }
  148:     }
  149: 
  150:     # Check to see if the student is jumping to next open, do-able problem
  151:     if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
  152:         # Find the next homework problem that they can do.
  153:         my $iterator = $navmap->getIterator(undef, undef, undef, 1);
  154:         my $curRes;
  155:         my $foundDoableProblem = 0;
  156:         my $minimumduedate;
  157:         my $now = time();
  158: 	
  159:         while ($curRes = $iterator->next()) {
  160:             if (ref($curRes) && $curRes->is_problem()) {
  161:                 my $status = $curRes->status();
  162: 		my $thisduedate=$curRes->duedate();
  163:                 if ($thisduedate > $now 
  164: 		    && $curRes->completable()) {
  165:                         
  166:                     $foundDoableProblem = 1;
  167: 
  168:                     if (!defined($minimumduedate)
  169:                         || $thisduedate<$minimumduedate) {
  170: 			# Pop open all previous maps
  171: 			my $stack = $iterator->getStack();
  172: 			pop @$stack; # last resource in the stack is the problem
  173: 			# itself, which we don't need in the map stack
  174: 			my @mapPcs = map {$_->map_pc()} @$stack;
  175: 			$env{'form.filter'} = join(',', @mapPcs);
  176: 			
  177: 			# Mark as both "here" and "jump"
  178: 			$env{'form.postsymb'} = $curRes->symb();
  179:                         $minimumduedate=$thisduedate;
  180: 		    }
  181:                 }
  182:             }
  183:         }
  184: 
  185:         # If we found no problems, print a note to that effect.
  186:         if (!$foundDoableProblem) {
  187:             $r->print("<span class=\"LC_info\">"
  188:                      .&mt("All homework assignments have been completed.")
  189:                      ."</span>");
  190:         }
  191:     } else {
  192:         my $link = 'navmaps?jumpToFirstHomework';
  193:         if ($env{'form.register'}) {
  194:             $link .= '&amp;register='.$env{'form.register'}; 
  195:         }
  196:         unless ($notools) {
  197: 	    &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
  198: 					      'location.href="'.$link.'"',
  199: 					      "Show my first due problem");
  200:         }
  201:     }
  202: 
  203:     my $suppressEmptySequences = 0;
  204:     my $filterFunc = undef;
  205:     my $resource_no_folder_link = 0;
  206: 
  207:     # Display only due homework.
  208:     my $showOnlyHomework = 0;
  209:     if ($env{'form.showOnlyHomework'} eq "1") {
  210:         $showOnlyHomework = 1;
  211:         $suppressEmptySequences = 1;
  212:         $filterFunc = sub { my $res = shift; 
  213:                             return $res->completable() || $res->is_map();
  214:                         };
  215:         my $link = 'navmaps?sort='.$env{'form.sort'};
  216:         if ($env{'form.register'}) {
  217:             $link .= '&amp;register='.$env{'form.register'};
  218:         }
  219: 	&Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',
  220: 					  'location.href="'.$link.'"',
  221: 					  'Show everything');
  222:         $r->print("<span class=\"LC_info\">".&mt("Uncompleted Problems")."</span>");
  223:         $env{'form.filter'} = '';
  224:         $env{'form.condition'} = 1;
  225: 	$resource_no_folder_link = 1;
  226:     } else {
  227:         my $link = 'navmaps?sort='.$env{'form.sort'}.'&amp;showOnlyHomework=1';
  228:         if ($env{'form.register'}) {
  229:             $link .= '&amp;register='.$env{'form.register'};
  230:         }
  231:         unless ($notools) {
  232: 	    &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
  233: 					      'location.href="'.$link.'"',
  234: 					      'Show only uncompleted problems');
  235:         }
  236:     }
  237: 
  238:     my %selected=($env{'form.sort'} => ' selected="selected"');
  239:     my $sort_html;
  240:     unless ($notools) {
  241:         $sort_html=(
  242:               '<form name="sortForm" action="">
  243:                  <span class="LC_nobreak">
  244:                     <input type="hidden" name="showOnlyHomework" value="'.$env{'form.showOnlyHomework'}.'" />
  245:                     '.&mt('Sort by:').'
  246:                     <select name="sort" onchange="document.sortForm.submit()">
  247:                        <option value="default"'.$selected{'default'}.'>'.&mt('Default').'</option>
  248:                        <option value="title"'.$selected{'title'}.'>'.&mt('Title').'</option>
  249:                        <option value="duedate"'.$selected{'duedate'}.'>'.&mt('Duedate').'</option>
  250:                        <option value="discussion"'.$selected{'discussion'}.'>'.&mt('Has New Discussion').'</option>
  251:                     </select>
  252:                     <input type="hidden" name="register" value="'.$env{'form.register'}.'" />
  253:                  </span>
  254:                </form>');
  255:     }
  256:     # renderer call
  257:     my $renderArgs = { 'cols' => [0,1,2,3],
  258: 		       'sort' => $env{'form.sort'},
  259:                        'url' => '/adm/navmaps',
  260:                        'navmap' => $navmap,
  261:                        'suppressNavmap' => 1,
  262:                        'suppressEmptySequences' => $suppressEmptySequences,
  263:                        'filterFunc' => $filterFunc,
  264: 		       'resource_no_folder_link' => $resource_no_folder_link,
  265: 		       'sort_html'=> $sort_html,
  266:                        'r' => $r,
  267:                        'caller' => 'navmapsdisplay',
  268:                        'linkitems' => \%toplinkitems,
  269:                        'notools' => $notools};
  270:                       
  271:     my $render = &Apache::lonnavmaps::render($renderArgs);
  272: 
  273:     # If no resources were printed, print a reassuring message so the
  274:     # user knows there was no error.
  275:     if ($renderArgs->{'counter'} == 0) {
  276:         if ($showOnlyHomework) {
  277:             $r->print("<p><span class=\"LC_info\">".&mt("All homework is currently completed.")."</span></p>");
  278:         } else { # both jumpToFirstHomework and normal use the same: course must be empty
  279:             $r->print("<p><span class=\"LC_info\">".&mt("This course is empty.")."</span></p>");
  280:         }
  281:     }
  282:     #my $td=&tv_interval($t0);
  283:     #$r->print("<br />$td");
  284:     &endContentScreen($r);
  285:     $r->print(&Apache::loncommon::end_page());
  286:     $r->rflush();
  287: 
  288:     return OK;
  289: }
  290: 
  291: sub startContentScreen {
  292:     my ($r,$mode)=@_;
  293: 
  294:     $r->print("\n".'<ul class="LC_TabContentBigger" id="mainnav">'."\n");
  295:     $r->print('<li'.(($mode eq 'navmaps')?' class="active"':'').'><a href="/adm/navmaps"><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'.&mt('Main Content').'&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</b></a></li>'."\n");
  296:     my $allowed = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
  297:     my ($suppcount,$errors);
  298:     unless ($allowed) {
  299:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
  300:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 
  301:         ($suppcount,$errors) = &Apache::lonnet::get_numsuppfiles($cnum,$cdom);
  302:     }
  303:     if ($allowed || $suppcount) { 
  304:         $r->print('<li '.(($mode eq 'supplemental')?' class="active"':'').'><a href="/adm/supplemental"><b>'.&mt('Supplemental Content').'</b></a></li>');
  305:     }
  306:     $r->print('<li'.(($mode eq 'coursesearch')?' class="active"':'').'><a href="/adm/searchcourse"><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'.&mt('Content Search').'&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</b></a></li>'."\n");
  307:     $r->print('<li'.(($mode eq 'courseindex')?' class="active"':'').'><a href="/adm/indexcourse"><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'.&mt('Content Index').'&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</b></a></li>'."\n");
  308:     $r->print("\n".'</ul>'."\n");
  309:     $r->print('<div class="LC_Box" style="clear:both;margin:0;"><div id="maincoursedoc" style="margin:0 0;padding:0 0;"><div class="LC_ContentBox" id="mainCourseDocuments" style="display: block;">');
  310: }
  311: 
  312: sub endContentScreen {
  313:    my ($r)=@_;
  314:    $r->print('</div></div></div>');
  315: }
  316: 
  317: 1;
  318: __END__
  319: