--- loncom/interface/lonnavmaps.pm	2021/07/14 03:58:17	1.552
+++ loncom/interface/lonnavmaps.pm	2022/10/04 20:39:59	1.562
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Navigate Maps Handler
 #
-# $Id: lonnavmaps.pm,v 1.552 2021/07/14 03:58:17 raeburn Exp $
+# $Id: lonnavmaps.pm,v 1.562 2022/10/04 20:39:59 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -357,7 +357,7 @@ user into thinking that if the sequence
 under it; for example, see the "Show Uncompleted Homework" view on the
 B<NAV> screen.
 
-=item * B<suppressNavmaps>: default: false
+=item * B<suppressNavmap>: default: false
 
 If true, will not display Navigate Content resources. 
 
@@ -1020,8 +1020,12 @@ sub render_resource {
         if ($it->{CONDITION}) {
             $nowOpen = !$nowOpen;
         }
-	
-	my $folderType = $resource->is_sequence() ? 'folder' : 'page';
+	my $folderType;
+	if (&advancedUser() && $resource->is_missing_map()) {
+	    $folderType = 'none';
+	} else {
+	    $folderType = $resource->is_sequence() ? 'folder' : 'page';
+	}
         my $title=$resource->title;
 		$title=~s/\"/\&qout;/g;
         if (!$params->{'resource_no_folder_link'}) {
@@ -1068,13 +1072,28 @@ sub render_resource {
             $nonLinkedText .= ' <span class="LC_warning">('.&mt('hidden').')</span> ';
         } elsif ($params->{'mapUnlisted'}) {
             $nonLinkedText .= ' <span class="LC_warning">('.&mt('unlisted').')</span> ';
+        } elsif ($params->{'mapHiddenDeepLink'} || $resource->deeplinkout()) {
+            $nonLinkedText .= ' <span class="LC_warning">('.&mt('not shown').')</span> ';
         }
     } else {
         if ($resource->randomout()) {
             $nonLinkedText .= ' <span class="LC_warning">('.&mt('hidden').')</span> ';
-        } elsif (($resource->deeplink($params->{caller}) eq 'absent') ||
-                 ($resource->deeplink($params->{caller}) eq 'grades')) {
-            $nonLinkedText .= ' <span class="LC_warning">('.&mt('unlisted').')</span> ';
+        } elsif ($resource->deeplinkout()) {
+            $nonLinkedText .= ' <span class="LC_warning">('.&mt('not shown').')</span> ';
+        } else {
+            my $deeplink = $resource->deeplink($params->{caller});
+            if ((($deeplink eq 'absent') || ($deeplink eq 'grades')) &&
+                  &advancedUser()) {
+                $nonLinkedText .= ' <span class="LC_warning">('.&mt('unlisted').')</span> ';
+            } elsif (($deeplink) && ($deeplink) ne 'full') {
+                if (&advancedUser()) {
+                    $nonLinkedText .= ' <span class="LC_warning">('.&mt('deep-link access').
+                                      ')</span> ';
+                } else {
+                    $nonLinkedText .= ' <span class="LC_warning">('.&mt('access via external site').
+                                      ')</span> ';
+                }
+            }
         }
     }
     if (!$resource->condval()) {
@@ -1401,15 +1420,47 @@ sub render {
         $filterFunc = sub { my $res = shift; return !$res->randomout() &&
                                 ($res->deeplink($args->{'caller'}) ne 'absent') &&
                                 ($res->deeplink($args->{'caller'}) ne 'grades') &&
+                                !$res->deeplinkout() &&
                                 &$oldFilterFunc($res);};
     }
 
     my $condition = 0;
     if ($env{'form.condition'}) {
         $condition = 1;
+    } elsif (($env{'request.deeplink.login'}) && ($env{'request.course.id'}) && (!$userCanSeeHidden)) {
+        if (!defined($navmap)) {
+            $navmap = Apache::lonnavmaps::navmap->new();
+        }
+        if (defined($navmap)) {
+            my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+            my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+            my $symb = &Apache::loncommon::symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
+            if ($symb) {
+                my $deeplink;
+                my $res = $navmap->getBySymb($symb);
+                if ($res->is_map()) {
+                    my $mapname = &Apache::lonnet::declutter($res->src());
+                    $mapname = &Apache::lonnet::deversion($mapname);
+                    $deeplink = $navmap->get_mapparam(undef,$mapname,"0.deeplink");
+                } else {
+                    $deeplink = $res->deeplink();
+                }
+                if ($deeplink ne '') {
+                    if ((split(/,/,$deeplink))[1] eq 'hide') {
+                        if ($res->is_map()) {
+                            map { $filterHash->{$_} = 1 if $_ } split(/,/,$res->map_hierarchy());
+                        } else {
+                            my $mapurl = (&Apache::lonnet::decode_symb($symb))[0];
+                            my $map = $navmap->getResourceByUrl($mapurl);
+                            map { $filterHash->{$_} = 1 if $_ } split(/,/,$map->map_hierarchy());
+                        }
+                    }
+                }
+            }
+        }
     }
 
-    if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) {
+    if (!$env{'form.folderManip'} && !defined($args->{'iterator'}) && !$args->{'nocurrloc'}) {
         # Step 1: Check to see if we have a navmap
         if (!defined($navmap)) {
             $navmap = Apache::lonnavmaps::navmap->new();
@@ -1448,11 +1499,15 @@ sub render {
         my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
         my $curRes;
         my $found = 0;
+        my $here_is_navmaps = 0; 
+        if ($here =~ m{___\d+___adm/navmaps$}) {
+            $here_is_navmaps = 1;
+        }
         
         # We only need to do this if we need to open the maps to show the
         # current position. This will change the counter so we can't count
         # for the jump marker with this loop.
-        while ($here && ($curRes = $mapIterator->next()) && !$found) {
+        while ($here && ($curRes = $mapIterator->next()) && !$found && !$here_is_navmaps) {
             if (ref($curRes) && $curRes->symb() eq $here) {
                 my $mapStack = $mapIterator->getStack();
                 
@@ -1569,9 +1624,6 @@ sub render {
 		'&amp;here='.&escape($here);
 	    $text='Open all folders';
         }
-        if ($env{'form.register'}) {
-            $link .= '&amp;register='.$env{'form.register'};
-        }
 	if ($args->{'caller'} eq 'navmapsdisplay') {
             unless ($args->{'notools'}) {
                 &add_linkitem($args->{'linkitems'},'changefolder',
@@ -1595,9 +1647,6 @@ sub render {
 	<input type="hidden" name="navurl" value="$querystr" />
 	<input type="hidden" name="navtime" value="$time" />
 END
-        if ($env{'form.register'}) {
-            $result .= '<input type="hidden" name="register" value="'.$env{'form.register'}.'" />';
-        }
         if ($args->{'sort'} eq 'discussion') { 
 	    my $totdisc = 0;
 	    my $haveDisc = '';
@@ -1618,16 +1667,22 @@ END
 	}
 	$result.='</form>';
     }
-    if (($args->{'caller'} eq 'navmapsdisplay') &&
-        ((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) ||
-         (&Apache::lonnet::allowed('cev',$env{'request.course.id'})))) {
+    if (($args->{'caller'} eq 'navmapsdisplay') && ($env{'request.course.id'})) {
         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
-        if ($env{'course.'.$env{'request.course.id'}.'.url'} eq 
+        if ($env{'course.'.$env{'request.course.id'}.'.url'} eq
             "uploaded/$cdom/$cnum/default.sequence") {
-            &add_linkitem($args->{'linkitems'},'edittoplevel',
-                          "javascript:gocmd('/adm/coursedocs','editdocs');",
-                          'Content Editor');
+            if ((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) ||
+                (&Apache::lonnet::allowed('cev',$env{'request.course.id'}))) {
+                &add_linkitem($args->{'linkitems'},'edittoplevel',
+                              "javascript:gocmd('/adm/coursedocs','editdocs');",
+                              'Content Editor');
+            }
+            if ($counter) {
+                &add_linkitem($args->{'linkitems'},'printout',
+                              "javascript:gopost('/adm/printout','/adm/navmaps');",
+                              'Prepare a printable document');
+            }
         }
     }
 
@@ -1673,11 +1728,31 @@ END
     # mark as hidden for users who have $userCanSeeHidden.  
     # Use DFS for speed, since structure actually doesn't matter,
     # except what map has what resources.
+    #
+    # To ensure the "Selected Resources from selected folder in course"
+    # printout generation option will work in sessions launched via a
+    # deep link, the value of $args->{'filterFunc'} included in the 
+    # call to lonnavmaps::render() is omitted from the filter function
+    # used with the DFS Iterator when $args->{'caller'} is 'printout'.
+    #
+    # As a result $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} can be
+    # set to 1 for folder(s) which include resources only accessible
+    # for sessions launched via a deep link, when the current session 
+    # is of that type.
 
     my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
                                                      $it->{FIRST_RESOURCE},
                                                      $it->{FINISH_RESOURCE},
                                                      {}, undef, 1);
+    my $dfsFilterFunc;
+    if ($args->{'caller'} eq 'printout') {
+        $dfsFilterFunc = sub { my $res = shift; return !$res->randomout() &&
+                              ($res->deeplink($args->{'caller'}) ne 'absent') &&
+                              ($res->deeplink($args->{'caller'}) ne 'grades') &&
+                              !$res->deeplinkout();};
+    } else {
+        $dfsFilterFunc = $filterFunc;
+    }
     my $depth = 0;
     $dfsit->next();
     my $curRes = $dfsit->next();
@@ -1696,8 +1771,9 @@ END
             } elsif ($curRes->src()) {
                 # Not a sequence: if it's filtered, ignore it, otherwise
                 # rise up the stack and mark the sequences as having children
-                if (&$filterFunc($curRes)) {
+                if (&$dfsFilterFunc($curRes)) {
                     for my $sequence (@{$dfsit->getStack()}) {
+                        next unless ($sequence->is_map());
                         $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
                     }
                 }
@@ -1821,6 +1897,7 @@ END
         # If this is an empty sequence and we're filtering them, continue on
         $args->{'mapHidden'} = 0;
         $args->{'mapUnlisted'} = 0;
+        $args->{'mapHiddenDeepLink'} = 0;
         if (($curRes->is_map()) && (!$curRes->{DATA}->{HAS_VISIBLE_CHILDREN})) {
             if ($args->{'suppressEmptySequences'}) {
                 next;
@@ -1833,9 +1910,16 @@ END
                     } else {
                         next;
                     }
+                } elsif ($curRes->deeplinkout) {
+                    if ($userCanSeeHidden) {
+                        $args->{'mapHiddenDeepLink'} = 1;
+                    } else {
+                        next;
+                    }
                 } else {
                     my $deeplink = $navmap->get_mapparam(undef,$mapname,"0.deeplink");
-                    if ($deeplink =~ /^(absent|grades),/) {
+                    my ($state,$others,$listed) = split(/,/,$deeplink);
+                    if (($listed eq 'absent') || ($listed eq 'grades')) {
                         if ($userCanSeeHidden) {
                             $args->{'mapUnlisted'} = 1;
                         } else {
@@ -1906,10 +1990,10 @@ END
             }
         }
         # If deep-link parameter is set (and is not set to full) suppress link
-        # unless privileged user, or calling context is sequence, and parameter
-        # set at map level
+        # unless privileged user, tinyurl used for login resolved to a map, and
+        # the resource is within the map.
         if ((!$curRes->deeplink($args->{'caller'})) ||
-            ($curRes->deeplink($args->{'caller'}) =~ /^full,/) || &advancedUser()) {
+            ($curRes->deeplink($args->{'caller'}) eq 'full') || &advancedUser()) {
             $args->{'resource_nolink'} = 0;
         } else {
             $args->{'resource_nolink'} = 1;
@@ -2066,7 +2150,7 @@ sub show_linkitems_toolbar {
             $result .= '<td align="left">'."\n".
                        '<ul id="LC_toolbar">';
             my @linkorder = ('firsthomework','everything','uncompleted',
-                             'changefolder','clearbubbles','edittoplevel');
+                             'changefolder','clearbubbles','printout','edittoplevel');
             foreach my $link (@linkorder) {
                 if (ref($args->{'linkitems'}{$link}) eq 'HASH') {
                     if ($args->{'linkitems'}{$link}{'text'} ne '') {
@@ -2479,7 +2563,7 @@ sub getIterator {
     my $self = shift;
     my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
                                                      shift, undef, shift,
-						     shift, shift);
+						     shift, shift, shift);
     return $iterator;
 }
 
@@ -2998,8 +3082,12 @@ sub recursed_crumbs {
         my $pc = $map->map_pc();
         next if ((!$pc) || ($pc == 1));
         push(@links,$map);
-        push(@revmapinfo,{'href' => $env{'request.use_absolute'}.$map->link().'?navmap=1','text' => $map->title(),'no_mt' => 1,});
-        $totallength += length($map->title());
+        my $text = $map->title();
+        if ($text eq '') {
+            $text = '...';
+        }
+        push(@revmapinfo,{'href' => $env{'request.use_absolute'}.$map->link().'?navmap=1','text' => $text,'no_mt' => 1,});
+        $totallength += length($text);
     }
     my $numlinks = scalar(@links);
     if ($numlinks) {
@@ -3011,7 +3099,11 @@ sub recursed_crumbs {
             }
             @revmapinfo = ();
             foreach my $map (@links) {
-                my $showntitle = &truncate_crumb_text($map->title(),$avg);
+                my $title = $map->title();
+                if ($title eq '') {
+                    $title = '...';
+                }
+                my $showntitle = &truncate_crumb_text($title,$avg);
                 if ($showntitle ne '') {
                     push(@revmapinfo,{'href' => $env{'request.use_absolute'}.$map->link().'?navmap=1','text' => $showntitle,'no_mt' => 1,});
                 }
@@ -3619,7 +3711,7 @@ getIterator behaves as follows:
 
 =over 4
 
-=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
+=item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap, $deeplinklisted):
 
 All parameters are optional. firstResource is a resource reference
 corresponding to where the iterator should start. It defaults to
@@ -3636,7 +3728,10 @@ that is not just a single, 'redirecting'
 will return all information, starting with the top-level map,
 regardless of content. returnTopMap, if true (default false), will
 cause the iterator to return the top-level map object (resource 0.0)
-before anything else.
+before anything else. deeplinklisted if true (default false), will
+check "listed" status of a resource with a deeplink, and unless "absent"
+will exclude deeplink checking when retrieving the browsePriv from
+lonnet::allowed().
 
 Thus, by default, only top-level resources will be shown. Change the
 condition to a 1 without changing the hash, and all resources will be
@@ -3773,6 +3868,10 @@ sub new {
     # have we done that yet?
     $self->{HAVE_RETURNED_0} = 0;
 
+    # Do we want to check the "listed" status for a resource for which
+    # deeplinking applies.
+    $self->{DEEPLINKLISTED} = shift;
+
     # Now, we need to pre-process the map, by walking forward and backward
     # over the parts of the map we're going to look at.
 
@@ -3864,7 +3963,8 @@ sub new {
 						 $finishResource, $self->{FILTER},
 						 $self->{ALREADY_SEEN}, 
 						 $self->{CONDITION},
-						 $self->{FORCE_TOP});
+						 $self->{FORCE_TOP},
+                                                 undef,$self->{DEEPLINKLISTED});
     }
 
     # Set up some bookkeeping information.
@@ -4034,13 +4134,14 @@ sub next {
                                               $finishResource, $self->{FILTER},
                                               $self->{ALREADY_SEEN},
 					      $self->{CONDITION},
-					      $self->{FORCE_TOP});
+					      $self->{FORCE_TOP},
+                                              undef,$self->{DEEPLINKLISTED});
     }
 
     # If this is a blank resource, don't actually return it.
     # Should you ever find you need it, make sure to add an option to the code
     #  that you can use; other things depend on this behavior.
-    my $browsePriv = $self->{HERE}->browsePriv($noblockcheck);
+    my $browsePriv = $self->{HERE}->browsePriv($noblockcheck,$self->{DEEPLINKLISTED});
     if (!$self->{HERE}->src() || 
         (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
         return $self->next($closeAllPages);
@@ -4468,6 +4569,7 @@ sub from { my $self=shift; return $self-
 sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
 sub kind { my $self=shift; return $self->navHash("kind_", 1); }
 sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
+sub deeplinkout { my $self=shift; return $self->navHash("deeplinkout_", 1); }
 sub randompick { 
     my $self = shift;
     my $randompick = $self->parmval('randompick');
@@ -4707,6 +4809,11 @@ sub is_sequence {
     return $self->navHash("is_map_", 1) && 
     $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
 }
+sub is_missing_map {
+    my $self=shift;
+    return $self->navHash("is_map_", 1) &&
+    $self->navHash("map_type_" . $self->map_pc()) eq 'none';
+}
 sub is_survey {
     my $self = shift();
     my $part = shift();
@@ -5156,16 +5263,42 @@ sub slot_control {
     return ($useslots,$availablestudent,$available);
 }
 sub deeplink {
-    my ($self,$caller) = @_;
-    my $value = $self->parmval("deeplink");
-    if ($value) {
-        my @deeplink = split(/,/,$value);
-        if ($caller eq 'sequence') {
-            if ($deeplink[1] ne 'res') {
-                return;
+    my ($self,$caller,$action) = @_;
+    my $deeplink = $self->parmval("deeplink");
+    if ($deeplink) {
+        my ($state,$others,$listed,$scope) = split(/,/,$deeplink);
+        if ($action eq 'getlisted') {
+            return $listed;
+        }
+        if ($env{'request.deeplink.login'}) {
+            my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+            my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+            my $deeplink_symb = &Apache::loncommon::deeplink_login_symb($cnum,$cdom);
+            if ($deeplink_symb) {
+                my ($loginmap,$mapname);
+                if ($deeplink_symb =~ /\.(page|sequence)$/) {
+                    $mapname = $self->enclosing_map_src();
+                    $loginmap = &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
+                    return if ($mapname eq $loginmap);
+                } else {
+                    return if ($deeplink_symb eq $self->symb());
+                    if (($scope eq 'map') || ($scope eq 'rec')) {
+                        $mapname = $self->enclosing_map_src();
+                        $loginmap = &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($deeplink_symb))[0]);
+                        return if ($mapname eq $loginmap);
+                    }
+                }
+                if ($scope eq 'rec') {
+                    my $map_pc = $self->navHash('map_pc_'.$mapname);
+                    my @recurseup = split(/,/,$self->navHash('map_hierarchy_'.$map_pc));
+                    my $login_pc = $self->navHash('map_pc_'.$loginmap);
+                    return if (grep(/^\Q$login_pc\E$/,@recurseup));
+                }
             }
         }
-        return $deeplink[0];
+        unless (($caller eq 'sequence') || ($state eq 'both')) {
+            return $listed;
+        }
     }
     return;
 }
@@ -6360,13 +6493,23 @@ sub getPrevious {
 sub browsePriv {
     my $self = shift;
     my $noblockcheck = shift;
+    my $deeplinklisted = shift;
     if (defined($self->{BROWSE_PRIV})) {
         return $self->{BROWSE_PRIV};
     }
-
+    my ($nodeeplinkcheck,$nodeeplinkout);
+    if ($deeplinklisted) {
+        my $deeplink = $self->deeplink(undef,'getlisted');
+        if (($deeplink) && ($deeplink ne 'absent')) {
+            $nodeeplinkcheck = 1;
+        }
+        $nodeeplinkout = 1;
+    }
     $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
 						    $self->{SYMB},undef,
-                                                    undef,$noblockcheck);
+                                                    undef,$noblockcheck,
+                                                    undef,$nodeeplinkcheck,
+                                                    $nodeeplinkout);
 }
 
 =pod