--- loncom/interface/lonnavdisplay.pm	2010/03/17 15:59:38	1.16
+++ loncom/interface/lonnavdisplay.pm	2025/05/27 23:35:38	1.48
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
-# Navigate Maps Handler
+# Navigate Maps Display Handler
 #
-# $Id: lonnavdisplay.pm,v 1.16 2010/03/17 15:59:38 droeschl Exp $
+# $Id: lonnavdisplay.pm,v 1.48 2025/05/27 23:35:38 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -30,14 +30,17 @@
 package Apache::lonnavdisplay;
 
 use strict;
-use Apache::Constants qw(:common :http);
+use Apache::Constants qw(:common :http REDIRECT);
 use Apache::lonmenu();
 use Apache::loncommon();
 use Apache::lonnavmaps();
 use Apache::lonhtmlcommon();
 use Apache::lonnet;
 use Apache::lonlocal;
-use Time::HiRes qw( gettimeofday tv_interval );
+use Apache::londocs();
+use Apache::lonuserstate;
+use LONCAPA::ltiutils;
+use LONCAPA;
 
 sub handler {
     my $r = shift;
@@ -46,55 +49,144 @@ sub handler {
 
 sub real_handler {
     my $r = shift;
-    #my $t0=[&gettimeofday()];
     # Handle header-only request
     if ($r->header_only) {
-        if ($env{'browser.mathml'}) {
-            &Apache::loncommon::content_type($r,'text/xml');
-        } else {
-            &Apache::loncommon::content_type($r,'text/html');
-        }
+        &Apache::loncommon::content_type($r,'text/html');
         $r->send_http_header;
         return OK;
     }
 
-    # Send header, don't cache this page
-    if ($env{'browser.mathml'}) {
-        &Apache::loncommon::content_type($r,'text/xml');
-    } else {
+    # Check for critical messages and redirect if present.  
+    my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents');
+    if ($redirect) {
         &Apache::loncommon::content_type($r,'text/html');
+        $r->header_out(Location => $url);
+        return REDIRECT;
     }
-    &Apache::loncommon::no_cache($r);
 
-    my %toplinkitems=();
-    &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'blank','',
-				      "Select Action");
+# ------------------------------------------------------------ Get query string
+    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort',
+                                                                  'showOnlyHomework',
+                                                                  'postsymb']);
+    # Check if course needs to be re-initialized
+    my $loncaparev = $r->dir_config('lonVersion');
+    my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev);
+    my %prog_state=();
+    my $closure;
+
+    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;
+    }
+    my ($cid,$cnum,$cdom);
+    if ($result) {
+        $cid = $env{'request.course.id'};
+        $cnum = $env{'course.'.$cid.'.num'};
+        $cdom = $env{'course.'.$cid.'.domain'};
+    }
+    if (($result eq 'main') || ($result eq 'both')) {
+        &Apache::loncommon::content_type($r,'text/html');
+        $r->send_http_header;
+        &startpage($r);
+        my $preamble = '<div id="LC_update_'.$cid.'" class="LC_info">'.
+                       '<br />'.
+                       &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>';
+        $closure = <<ENDCLOSE;
+<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
     my $navmap = Apache::lonnavmaps::navmap->new();
 
     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;
         $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
         $env{'user.reinit'} = 1;
         return HTTP_NOT_ACCEPTABLE;
     }
-    $r->send_http_header;
 
-# ------------------------------------------------------------ Get query string
-    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort','showOnlyHomework','postsymb']);
-    
-# ----------------------------------------------------- Force menu registration
-    # Header
-    my $course_type = &Apache::loncommon::course_type();
-    my $title = $course_type . ' Contents';
-    my $breadcrumb_text = mt($course_type . ' Contents');
-    $r->print(&Apache::loncommon::start_page($title, '',
-                         { 'bread_crumbs'    => [{text => $breadcrumb_text }],}));
-#SD
-    $r->print('<script type="text/javascript">window.focus();</script>');
-     
-    $r->rflush();
+    if (($result eq 'main') || ($result eq 'both')) {
+        $r->rflush();
+        &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
+        $r->print($closure);
+        $r->rflush();
+    } else {
+        # Send header, don't cache this page
+        &Apache::loncommon::content_type($r,'text/html');
+        $r->send_http_header;
+        &startpage($r);
+    }
+
+    &startContentScreen($r,'navmaps',$course_type);
+    unless (($result eq 'main') || ($result eq 'both')) {
+        $r->rflush();
+    }
 
     # Check that it's defined
     if (!($navmap->courseMapDefined())) {
@@ -105,21 +197,32 @@ sub real_handler {
         return OK;
     }
 
-    # See if there's only one map in the top-level, if we don't
-    # already have a filter... if so, automatically display it
-    # (older code; should use retrieveResources)
-    if ($ENV{QUERY_STRING} !~ /filter/) {
-        my $iterator = $navmap->getIterator(undef, undef, undef, 0);
-        my $curRes;
-        my $sequenceCount = 0;
-        my $sequenceId;
-        while ($curRes = $iterator->next()) {
-            if (ref($curRes) && $curRes->is_sequence()) {
+    my %toplinkitems=();
+    my @resources = $navmap->retrieveResources();
+    my $sequenceCount = 0;
+    my $problemCount = 0;
+    my $notaprobCount = 0;
+    my $sequenceId;
+    my $notools;
+    foreach my $curRes (@resources) {
+        if (ref($curRes)) {
+            if ($curRes->is_sequence()) {
                 $sequenceCount++;
                 $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) {
             # The automatic iterator creation in the render call 
             # will pick this up. We know the condition because
@@ -171,9 +274,12 @@ sub real_handler {
                      ."</span>");
         }
     } else {
-	&Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
-					  'location.href="navmaps?jumpToFirstHomework"',
-					  "Show my first due problem");
+        my $link = '/adm/navmaps?jumpToFirstHomework';
+        unless ($notools) {
+	    &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework',
+					      'location.href="'.$link.'"',
+					      "Show my first due problem");
+        }
     }
 
     my $suppressEmptySequences = 0;
@@ -188,33 +294,41 @@ sub real_handler {
         $filterFunc = sub { my $res = shift; 
                             return $res->completable() || $res->is_map();
                         };
+        my $link = '/adm/navmaps?sort='.$env{'form.sort'};
 	&Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything',
-					  'location.href="navmaps?sort='.$env{'form.sort'}.'"',
-					  "Show everything");
+					  'location.href="'.$link.'"',
+					  'Show everything');
         $r->print("<span class=\"LC_info\">".&mt("Uncompleted Problems")."</span>");
         $env{'form.filter'} = '';
         $env{'form.condition'} = 1;
 	$resource_no_folder_link = 1;
     } else {
-	&Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
-					  'location.href="navmaps?sort='.$env{'form.sort'}.
-					  '&showOnlyHomework=1"',
-					  "Show only uncompleted problems");
+        my $link = '/adm/navmaps?sort='.$env{'form.sort'}.'&amp;showOnlyHomework=1';
+        unless ($notools) {
+	    &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted',
+					      'location.href="'.$link.'"',
+					      'Show only uncompleted problems');
+        }
     }
 
     my %selected=($env{'form.sort'} => ' selected="selected"');
-    my $sort_html=("<form name=\"sortForm\">
-                 <span class=\"LC_nobreak\">
-                    <input type=\"hidden\" name=\"showOnlyHomework\" value=\"".$env{'form.showOnlyHomework'}."\" />
-                    ".&mt('Sort by:')."
-                    <select name=\"sort\" onChange=\"document.sortForm.submit()\">
-                       <option value=\"default\"$selected{'default'}>".&mt('Default')."</option>
-                       <option value=\"title\"$selected{'title'}  >".&mt('Title')."</option>
-                       <option value=\"duedate\"$selected{'duedate'}>".&mt('Duedate')."</option>
-                       <option value=\"discussion\"$selected{'discussion'}>".&mt('Has New Discussion')."</option>
+    my $sort_html;
+    unless ($notools) {
+        $sort_html=(
+              '<form name="sortForm" action="">
+                 <span class="LC_nobreak">
+                    <input type="hidden" name="showOnlyHomework" value="'.$env{'form.showOnlyHomework'}.'" />
+                    <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>
+                    <input type="submit" value="'.&mt('Go').'" />
                  </span>
-               </form>");
+               </form>');
+    }
     # renderer call
     my $renderArgs = { 'cols' => [0,1,2,3],
 		       'sort' => $env{'form.sort'},
@@ -227,27 +341,154 @@ sub real_handler {
 		       'sort_html'=> $sort_html,
                        'r' => $r,
                        'caller' => 'navmapsdisplay',
-                       'linkitems' => \%toplinkitems};
+                       'linkitems' => \%toplinkitems,
+                       'notools' => $notools};
+                      
     my $render = &Apache::lonnavmaps::render($renderArgs);
 
     # If no resources were printed, print a reassuring message so the
     # user knows there was no error.
     if ($renderArgs->{'counter'} == 0) {
+        my $noresmsg;
         if ($showOnlyHomework) {
-            $r->print("<p><span class=\"LC_info\">".&mt("All homework is currently completed.")."</span></p>");
+            $noresmsg = &mt('All homework is currently completed.');
         } else { # both jumpToFirstHomework and normal use the same: course must be empty
-            $r->print("<p><span class=\"LC_info\">".&mt("This course is empty.")."</span></p>");
+            $noresmsg = &mt('This course is empty.');
+            if (($renderArgs->{'deeplinknolist'}) &&
+                ($env{'request.course.deeponlyprot'})) {
+                my ($linkprot,$currmatch,$othermatches,@names);
+                if ($env{'request.linkprot'}) {
+                    ($linkprot) = split(/:/,$env{'request.linkprot'});
+                }
+                foreach my $launcher (split(/&/,$env{'request.course.deeponlyprot'})) {
+                    my ($name,$itemnums) = split(/:/,$launcher);
+                    my @nums = split(/,/,$itemnums);
+                    if (($linkprot) &&
+                        (grep(/^\Q$linkprot\E$/,@nums))) {
+                        $currmatch = &LONCAPA::unescape($name);
+                        if (@nums > 1) {
+                            $othermatches = 1;
+                        }
+                    } else {
+                        push(@names,&LONCAPA::unescape($name));
+                    }
+                }
+                my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+                my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+                my $has_supp = &Apache::lonnet::has_unhidden_suppfiles($cnum,$cdom);
+                if ($linkprot) {
+                    if ($currmatch) {
+                        if ($has_supp) {
+                            $noresmsg = &mt('No main content available when accessed using the link you followed from [_1].',
+                                            $currmatch);
+                        } else {
+                            $noresmsg = &mt('No content available when accessed using the link you followed from [_1].',
+                                            $currmatch);
+                        }
+                        if ($othermatches) {
+                            $noresmsg = '<br />';
+                            if ($has_supp) {
+                                $noresmsg .= &mt('Main content may be available by following a different link from [_1].',
+                                                 $currmatch);
+                            } else {
+                                $noresmsg .= &mt('Content may be available by following a different link from [_1].',
+                                                 $currmatch); 
+                            }
+                        }
+                    } else {
+                        if ($has_supp) {
+                            $noresmsg = &mt('No main content available using the link you followed.');
+                        } else {
+                            $noresmsg = &mt('No content available using the link you followed.');
+                        }
+                    }
+                } elsif (@names > 0) {
+                    if ($has_supp) {
+                        $noresmsg = &mt('No main content available from direct login to this course.');
+                    } else {
+                        $noresmsg = &mt('No content available from direct login to this course.');
+                    }
+                }
+                if (@names == 1) {
+                    $noresmsg .= '<br />';
+                    if ($has_supp) {
+                        $noresmsg .= &mt('Main content is likely available by following links from [_1]',
+                                         $names[0]);
+                    } else {
+                        $noresmsg .= &mt('Content is likely available by following links from [_1]',
+                                         $names[0]);
+                    }
+                } elsif (@names > 1) {
+                    $noresmsg .= '<br />';
+                    if ($has_supp) {
+                        $noresmsg .= &mt('Main content is likely available by following links from the following: [_1]',
+                                         join(', ',@names));
+                    } else {
+                        $noresmsg .= &mt('Content is likely available by following links from the following: [_1]',
+                                         join(', ',@names));
+                    }
+                }
+            }
         }
+        $r->print('<p><span class="LC_info">'.$noresmsg.'</span></p>');
     }
-    #my $td=&tv_interval($t0);
-    #$r->print("<br />$td");
-
+    &endContentScreen($r);
     $r->print(&Apache::loncommon::end_page());
     $r->rflush();
 
     return OK;
 }
 
+sub startpage {
+    my ($r) = @_;
+# ----------------------------------------------------- Force menu registration
+    # Header
+    my $course_type = &Apache::loncommon::course_type();
+    my $title = $course_type . ' Contents';
+    my $brcrum = [{href => '/adm/navmaps',
+                   text => &mt($course_type . ' Contents'),
+                   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".'<div class="LC_landmark" role="main">'.
+              '<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 {
+        my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+        my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+        $supptab = &Apache::lonnet::has_unhidden_suppfiles($cnum,$cdom);
+    }
+    if ($supptab) {
+        $r->print('<li '.(($mode eq 'supplemental')?' class="active"':'').'><a href="/adm/supplemental"><b>'.&mt('Supplemental Content').'</b></a></li>');
+    }
+    unless ($course_type eq 'Placement') {
+        $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");
+    }
+    $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></div>');
+}
+
 1;
 __END__