[BACK]Return to lonnavdisplay.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavdisplay.pm between versions 1.6 and 1.45

version 1.6, 2009/02/26 16:17:30 version 1.45, 2025/02/07 20:46:01
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # Navigate Maps Handler  # Navigate Maps Display Handler
 #  #
 # $Id$  # $Id$
 #  #
Line 30 Line 30
 package Apache::lonnavdisplay;  package Apache::lonnavdisplay;
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http REDIRECT);
 use Apache::lonmenu();  use Apache::lonmenu();
 use Apache::loncommon();  use Apache::loncommon();
 use Apache::lonnavmaps();  use Apache::lonnavmaps();
 use Apache::lonhtmlcommon();  use Apache::lonhtmlcommon();
 use Apache::lonnet;  use Apache::lonnet;
 use Apache::lonlocal;  use Apache::lonlocal;
 use Time::HiRes qw( gettimeofday tv_interval );  use Apache::londocs();
   use Apache::lonuserstate;
   use LONCAPA::ltiutils;
   
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
Line 46  sub handler { Line 48  sub handler {
   
 sub real_handler {  sub real_handler {
     my $r = shift;      my $r = shift;
     #my $t0=[&gettimeofday()];  
     # Handle header-only request      # Handle header-only request
     if ($r->header_only) {      if ($r->header_only) {
         if ($env{'browser.mathml'}) {          &Apache::loncommon::content_type($r,'text/html');
             &Apache::loncommon::content_type($r,'text/xml');  
         } else {  
             &Apache::loncommon::content_type($r,'text/html');  
         }  
         $r->send_http_header;          $r->send_http_header;
         return OK;          return OK;
     }      }
   
     # Send header, don't cache this page      # Check for critical messages and redirect if present.  
     if ($env{'browser.mathml'}) {      my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents');
         &Apache::loncommon::content_type($r,'text/xml');      if ($redirect) {
     } else {  
         &Apache::loncommon::content_type($r,'text/html');          &Apache::loncommon::content_type($r,'text/html');
           $r->header_out(Location => $url);
           return REDIRECT;
     }      }
     &Apache::loncommon::no_cache($r);  
   
     my %toplinkitems=();  # ------------------------------------------------------------ Get query string
     &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'blank','',      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort',
       "Select Action");                                                                    'showOnlyHomework',
     if ($ENV{QUERY_STRING} eq 'collapseExternal') {                                                                    'postsymb']);
  &Apache::lonnet::put('environment',{'remotenavmap' => 'off'});      # Check if course needs to be re-initialized
  &Apache::lonnet::appenv({'environment.remotenavmap' => 'off'});      my $loncaparev = $r->dir_config('lonVersion');
  my $menu=&Apache::lonmenu::reopenmenu();      my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
  my $navstatus=&Apache::lonmenu::get_nav_status();      my %prog_state=();
  if ($menu) {      my $closure;
     $menu=(<<MENU)  
              swmenu=$menu  
              swmenu.clearTimeout(swmenu.menucltim);  
      $navstatus  
 MENU  
         } else {  
     my $nothing = &Apache::lonhtmlcommon::javascript_nothing();  
     my $mainwindow='window.open('.$nothing.',"loncapaclient","",false);';  
     $menu=(<<MENU)  
              swmenu=$mainwindow  
      $navstatus  
 MENU  
  }  
         $r->send_http_header;  
  my $js =<<"ENDSUBM";  
   <script type="text/javascript">  
      function submitthis() {  
     $menu  
     self.close();  
     }  
   
    </script>  
 ENDSUBM  
         $r->print(&Apache::loncommon::start_page(undef,$js,  
  {'only_body' => 1,  
   'bgcolor'   => '#FFFFFF',  
   'add_entries' =>   
       {'onload' =>  
    "submitthis()"}}).  
   &Apache::loncommon::end_page());  
   
       if ($result eq 'switch') {
           &Apache::loncommon::content_type($r,'text/html');
           $r->send_http_header;
           $r->print(&Apache::loncommon::check_release_result(@reinit));
         return OK;          return OK;
     }      }
     if ($ENV{QUERY_STRING} =~ /^launchExternal/) {      my ($cid,$cnum,$cdom);
  &Apache::lonnet::put('environment',{'remotenavmap' => 'on'});      if ($result) {
  &Apache::lonnet::appenv({'environment.remotenavmap' => 'on'});          $cid = $env{'request.course.id'};
   my $menu=&Apache::lonmenu::reopenmenu();          $cnum = $env{'course.'.$cid.'.num'};
  my $navstatus=&Apache::lonmenu::get_nav_status();          $cdom = $env{'course.'.$cid.'.domain'};
  if ($menu) {      }
     $r->print(<<MENU);      if (($result eq 'main') || ($result eq 'both')) {
              <script type="text/javascript">          &Apache::loncommon::content_type($r,'text/html');
              swmenu=$menu          $r->send_http_header;
              swmenu.clearTimeout(swmenu.menucltim);          &startpage($r);
      $navstatus          my $preamble = '<div id="LC_update_'.$cid.'" class="LC_info">'.
              </script>                         '<br />'.
 MENU                         &mt('Your course session is being updated because of recent changes by course personnel.').
         }                         ' '.&mt('Please be patient').'.<br /></div>'.
    }                         '<div style="padding:0;clear:both;margin:0;border:0"></div>';
     if ($ENV{QUERY_STRING} eq 'turningOffExternal') {          $closure = <<ENDCLOSE;
  $env{'environment.remotenavmap'}='off';  <script type="text/javascript">
   // <![CDATA[
   \$("#LC_update_$cid").hide('slow');
   // ]]>
   </script>
   ENDCLOSE
           %prog_state = &Apache::lonhtmlcommon::Create_PrgWin($r,undef,$preamble);
           &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Updating course'));
           $r->rflush();
           my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum",\%prog_state,$r);
           &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Finished!'));
           if ($ferr) {
               &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
               $r->print($closure.&Apache::loncommon::end_page());
               my $requrl = $r->uri;
               $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
               $env{'user.reinit'} = 1;
               return HTTP_NOT_ACCEPTABLE;
           }
       }
       if (($result eq 'both') || ($result eq 'supp')) {
           my $possdel;
           if ($result eq 'supp') {
               $possdel = 1;
           }
           my ($supplemental,$refs_updated) = &Apache::loncommon::get_supplemental($cnum,$cdom,'',$possdel);
           unless ($refs_updated) {
               &Apache::loncommon::set_supp_httprefs($cnum,$cdom,$supplemental,$possdel);
           }
       }
   
       my $course_type = &Apache::loncommon::course_type();
       if (($course_type eq 'Placement') && (!$env{'request.role.adv'})) { 
           my $furl = &Apache::lonpageflip::first_accessible_resource();
           if (($result eq 'main') || ($result eq 'both')) {
               &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
               $r->print($closure.&Apache::loncommon::end_page());
               return OK;
           } else {
               unless ($furl eq '/adm/navmaps') {
                   &Apache::loncommon::content_type($r,'text/html');
                   $r->header_out(Location => $furl);
                   return REDIRECT;
               }
           }
       }
   
       if ($env{'request.lti.login'}) {
           if ($env{'request.lti.uri'} ne '') {
               my $cid = $env{'request.course.id'};
               my $cnum = $env{'course.'.$cid.'.num'};
               my $cdom = $env{'course.'.$cid.'.domain'};
               my ($scope,$url) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},$cdom,$cnum);
               if (($scope eq 'map') || ($scope eq 'resource')) {
                   &Apache::loncommon::content_type($r,'text/html');
                   $r->header_out(Location => $url);
                   return REDIRECT;
               }
           }
     }      }
   
     # Create the nav map      # Create the nav map
     my $navmap = Apache::lonnavmaps::navmap->new();      my $navmap = Apache::lonnavmaps::navmap->new();
   
     if (!defined($navmap)) {      if (!defined($navmap)) {
           if (($result eq 'main') || ($result eq 'both')) {
               &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
               $r->print($closure.&Apache::loncommon::end_page());
           }
         my $requrl = $r->uri;          my $requrl = $r->uri;
         $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";          $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
         $env{'user.reinit'} = 1;          $env{'user.reinit'} = 1;
         return HTTP_NOT_ACCEPTABLE;          return HTTP_NOT_ACCEPTABLE;
     }      }
     $r->send_http_header;  
   
 # ------------------------------------------------------------ Get query string      if (($result eq 'main') || ($result eq 'both')) {
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register','sort','showOnlyHomework','postsymb']);          $r->rflush();
               &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
 # ----------------------------------------------------- Force menu registration          $r->print($closure);
     my $body_only='';          $r->rflush();
     my $js;      } else {
     if ($env{'environment.remotenavmap'} eq 'on') {          # Send header, don't cache this page
  $js='<script type="text/javascript">          &Apache::loncommon::content_type($r,'text/html');
                 function collapse() {          $r->send_http_header;
                    this.document.location="/adm/navmaps?collapseExternal";          &startpage($r);
                 }  
              </script>';  
  $body_only=1;  
     }      }
   
     # Header      &startContentScreen($r,'navmaps',$course_type);
     my $course_type = &Apache::loncommon::course_type();      unless (($result eq 'main') || ($result eq 'both')) {
     $r->print(&Apache::loncommon::start_page(#'Navigate '.$course_type.          $r->rflush();
      'Course Contents',      }
      $js,  
      {'only_body'       => $body_only,  
       'force_register'  =>  
   $env{'form.register'},}));  
     $r->print('<script type="text/javascript">window.focus();</script>');  
        
     $r->rflush();  
   
     # Check that it's defined      # Check that it's defined
     if (!($navmap->courseMapDefined())) {      if (!($navmap->courseMapDefined())) {
Line 174  MENU Line 196  MENU
         return OK;          return OK;
     }      }
   
     # See if there's only one map in the top-level, if we don't      my %toplinkitems=();
     # already have a filter... if so, automatically display it      my @resources = $navmap->retrieveResources();
     # (older code; should use retrieveResources)      my $sequenceCount = 0;
     if ($ENV{QUERY_STRING} !~ /filter/) {      my $problemCount = 0;
         my $iterator = $navmap->getIterator(undef, undef, undef, 0);      my $notaprobCount = 0;
         my $curRes;      my $sequenceId;
         my $sequenceCount = 0;      my $notools;
         my $sequenceId;      foreach my $curRes (@resources) {
         while ($curRes = $iterator->next()) {          if (ref($curRes)) {
             if (ref($curRes) && $curRes->is_sequence()) {              if ($curRes->is_sequence()) {
                 $sequenceCount++;                  $sequenceCount++;
                 $sequenceId = $curRes->map_pc();                  $sequenceId = $curRes->map_pc();
               } elsif ($curRes->is_problem()) {
                   $problemCount ++;
               } else {
                   $notaprobCount ++;
             }              }
         }          }
               }
       if (($sequenceCount == 1) && (!$problemCount) && ($notaprobCount <= 1)) {
           $notools = 1;
       }
   
       # If there's only one map in the top-level and we don't
       # already have a filter, automatically display it
       if ($ENV{QUERY_STRING} !~ /filter/) {
         if ($sequenceCount == 1) {          if ($sequenceCount == 1) {
             # The automatic iterator creation in the render call               # The automatic iterator creation in the render call 
             # will pick this up. We know the condition because              # will pick this up. We know the condition because
Line 198  MENU Line 231  MENU
         }          }
     }      }
   
     if ($ENV{QUERY_STRING} eq 'launchExternal') {  
  $r->print('  
           <form name="returnwin" action="/adm/flip?postdata=navlaunch%3a"   
                 method="post" target="loncapaclient">  
           </form>');  
  $r->print('  
           <script type="text/javascript">  
               this.document.returnwin.submit();  
           </script>');  
     }  
   
     if ($env{'environment.remotenavmap'} ne 'on') {  
  $r->print(&launch_win('link','yes',\%toplinkitems));  
     }   
     if ($env{'environment.remotenavmap'} eq 'on') {  
  &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'closenav',  
   'collapse()',  
   "Close navigation window");  
     }   
   
   
     # Check to see if the student is jumping to next open, do-able problem      # Check to see if the student is jumping to next open, do-able problem
     if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {      if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
         # Find the next homework problem that they can do.          # Find the next homework problem that they can do.
Line 256  MENU Line 268  MENU
   
         # If we found no problems, print a note to that effect.          # If we found no problems, print a note to that effect.
         if (!$foundDoableProblem) {          if (!$foundDoableProblem) {
             $r->print("<font size='+2'>"              $r->print("<span class=\"LC_info\">"
                      .&mt("All homework assignments have been completed.")                       .&mt("All homework assignments have been completed.")
                      ."</font><br /><br />");                       ."</span>");
         }          }
     } else {      } else {
  &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',          my $link = '/adm/navmaps?jumpToFirstHomework';
   'location.href="navmaps?jumpToFirstHomework"',          unless ($notools) {
   "Show my first due problem");      &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
         'location.href="'.$link.'"',
         "Show my first due problem");
           }
     }      }
   
     my $suppressEmptySequences = 0;      my $suppressEmptySequences = 0;
Line 278  MENU Line 293  MENU
         $filterFunc = sub { my $res = shift;           $filterFunc = sub { my $res = shift; 
                             return $res->completable() || $res->is_map();                              return $res->completable() || $res->is_map();
                         };                          };
           my $link = '/adm/navmaps?sort='.$env{'form.sort'};
  &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',   &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',
   'location.href="navmaps?sort='.$env{'form.sort'}.'"',    'location.href="'.$link.'"',
   "Show everything");    'Show everything');
         $r->print("<p><font size='+2'>".&mt("Uncompleted Problems")."</font></p>");          $r->print("<span class=\"LC_info\">".&mt("Uncompleted Problems")."</span>");
         $env{'form.filter'} = '';          $env{'form.filter'} = '';
         $env{'form.condition'} = 1;          $env{'form.condition'} = 1;
  $resource_no_folder_link = 1;   $resource_no_folder_link = 1;
     } else {      } else {
  &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',          my $link = '/adm/navmaps?sort='.$env{'form.sort'}.'&amp;showOnlyHomework=1';
   'location.href="navmaps?sort='.$env{'form.sort'}.          unless ($notools) {
   '&showOnlyHomework=1"',      &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
   "Show only uncompleted problems");        'location.href="'.$link.'"',
     }        'Show only uncompleted problems');
           }
     my %selected=($env{'form.sort'} => 'selected=on');      }
     my $sort_html=("<form>  
                  <nobr>      my %selected=($env{'form.sort'} => ' selected="selected"');
                     <input type=\"hidden\" name=\"showOnlyHomework\" value=\"".$env{'form.showOnlyHomework'}."\" />      my $sort_html;
                     <input type=\"submit\" value=\"".&mt('Sort by:')."\" />      unless ($notools) {
                     <select name=\"sort\">          $sort_html=(
                        <option value=\"default\" $selected{'default'}>".&mt('Default')."</option>                '<form name="sortForm" action="">
                        <option value=\"title\"   $selected{'title'}  >".&mt('Title')."</option>                   <span class="LC_nobreak">
                        <option value=\"duedate\" $selected{'duedate'}>".&mt('Duedate')."</option>                      <input type="hidden" name="showOnlyHomework" value="'.$env{'form.showOnlyHomework'}.'" />
                        <option value=\"discussion\" $selected{'discussion'}>".&mt('Has New Discussion')."</option>                      <label for="LC_navmap_sort">'.&mt('Sort by:').'</label>
                       <select name="sort" id="LC_navmap_sort">
                          <option value="default"'.$selected{'default'}.'>'.&mt('Default').'</option>
                          <option value="title"'.$selected{'title'}.'>'.&mt('Title').'</option>
                          <option value="duedate"'.$selected{'duedate'}.'>'.&mt('Due Date').'</option>
                          <option value="discussion"'.$selected{'discussion'}.'>'.&mt('Has New Discussion').'</option>
                     </select>                      </select>
                  </nobr>                      <input type="submit" value="'.&mt('Go').'" />
                </form>");                   </span>
                  </form>');
       }
     # renderer call      # renderer call
     my $renderArgs = { 'cols' => [0,1,2,3],      my $renderArgs = { 'cols' => [0,1,2,3],
        'sort' => $env{'form.sort'},         'sort' => $env{'form.sort'},
Line 317  MENU Line 340  MENU
        'sort_html'=> $sort_html,         'sort_html'=> $sort_html,
                        'r' => $r,                         'r' => $r,
                        'caller' => 'navmapsdisplay',                         'caller' => 'navmapsdisplay',
                        'linkitems' => \%toplinkitems};                         'linkitems' => \%toplinkitems,
                          'notools' => $notools};
                         
     my $render = &Apache::lonnavmaps::render($renderArgs);      my $render = &Apache::lonnavmaps::render($renderArgs);
   
     # If no resources were printed, print a reassuring message so the      # If no resources were printed, print a reassuring message so the
     # user knows there was no error.      # user knows there was no error.
     if ($renderArgs->{'counter'} == 0) {      if ($renderArgs->{'counter'} == 0) {
         if ($showOnlyHomework) {          if ($showOnlyHomework) {
             $r->print("<p><font size='+1'>".&mt("All homework is currently completed.")."</font></p>");              $r->print("<p><span class=\"LC_info\">".&mt("All homework is currently completed.")."</span></p>");
         } else { # both jumpToFirstHomework and normal use the same: course must be empty          } else { # both jumpToFirstHomework and normal use the same: course must be empty
             $r->print("<p><font size='+1'>".&mt("This course is empty.")."</font></p>");              $r->print("<p><span class=\"LC_info\">".&mt("This course is empty.")."</span></p>");
         }          }
     }      }
     #my $td=&tv_interval($t0);      &endContentScreen($r);
     #$r->print("<br />$td");  
   
     $r->print(&Apache::loncommon::end_page());      $r->print(&Apache::loncommon::end_page());
     $r->rflush();      $r->rflush();
   
     return OK;      return OK;
 }  }
   
 sub launch_win {  sub startpage {
     my ($mode,$script,$toplinkitems,$firsttime)=@_;      my ($r) = @_;
     my $result;  # ----------------------------------------------------- Force menu registration
     if ($script ne 'no') {      # Header
  $result.='<script type="text/javascript">';      my $course_type = &Apache::loncommon::course_type();
     }      my $title = $course_type . ' Contents';
     if ($firsttime) {      my $brcrum = [{href => '/adm/navmaps',
  $result.='function launch_navmapwin() {                     text => &mt($course_type . ' Contents'),
                  newWindow=open(\'/adm/navmaps?launchExternalRoles\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');                     no_mt => 1},
                }';                   ];
       my $args = {'bread_crumbs' => $brcrum};
       $r->print(&Apache::loncommon::start_page($title,undef,$args).
                 '<script type="text/javascript">'."\n".
                 '// <![CDATA['."\n".
                 'window.focus();'."\n".
                 '// ]]>'."\n".
                 '</script>');
       return;
   }
   
   sub startContentScreen {
       my ($r,$mode,$course_type)=@_;
   
       $r->print("\n".'<ul class="LC_TabContentBigger" id="mainnav">'."\n");
       $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");
       my $supptab;
       if ($env{'request.role.adv'}) {
           $supptab = 1;
     } else {      } else {
  $result.='function launch_navmapwin() {          my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                  newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');          my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                }';          $supptab = &Apache::lonnet::has_unhidden_suppfiles($cnum,$cdom);
     }      }
     if ($mode eq 'now') {      if ($supptab) {
  $result.="\nlaunch_navmapwin();\n";          $r->print('<li '.(($mode eq 'supplemental')?' class="active"':'').'><a href="/adm/supplemental"><b>'.&mt('Supplemental Content').'</b></a></li>');
     }      }
     if ($script ne 'no') {      unless ($course_type eq 'Placement') {
  $result.='</script>';          $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");
     }          $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");
     if ($mode eq 'link') {  
  &Apache::lonnavmaps::add_linkitem($toplinkitems,'launchnav',  
   'launch_navmapwin()',  
   "Launch navigation window");  
     }      }
     return $result;      $r->print("\n".'</ul>'."\n");
       $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;">');
   }
   
   sub endContentScreen {
      my ($r)=@_;
      $r->print('</div></div></div>');
 }  }
   
 1;  1;
Removed from v.1.6  
changed lines
  Added in v.1.45

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