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

Diff for /loncom/interface/lonnavmaps.pm between versions 1.522 and 1.534

version 1.522, 2016/07/18 19:28:57 version 1.534, 2017/09/03 18:52:27
Line 51  described at http://www.lon-capa.org. Line 51  described at http://www.lon-capa.org.
 X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the  X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
 course structure and caches it in what is often referred to as the  course structure and caches it in what is often referred to as the
 "big hash" X<big hash>. You can see it if you are logged into  "big hash" X<big hash>. You can see it if you are logged into
 LON-CAPA, in a course, by going to /adm/test. (You may need to  LON-CAPA, in a course, by going to /adm/test. The content of 
 tweak the /home/httpd/lonTabs/htpasswd file to view it.) The  the hash will be under the heading "Big Hash".
 content of the hash will be under the heading "Big Hash".  
   Access to /adm/test is controlled by a domain configuration, 
   which a Domain Coordinator will set for a server's default domain
   via: Main Menu > Set domain configuration > Display (Access to 
   server status pages checked), and entering a username:domain
   or IP address in the "Show user environment" row. Users with
   an unexpired domain coordinator role in the server's domain
   automatically receive access to /adm/test.
   
 Big Hash contains, among other things, how resources are related  Big Hash contains, among other things, how resources are related
 to each other (next/previous), what resources are maps, which   to each other (next/previous), what resources are maps, which 
Line 77  Apache::lonnavmaps also provides fairly Line 84  Apache::lonnavmaps also provides fairly
 rendering navmaps, and last but not least, provides the navmaps  rendering navmaps, and last but not least, provides the navmaps
 view for when the user clicks the NAV button.  view for when the user clicks the NAV button.
   
 B<Note>: Apache::lonnavmaps I<only> works for the "currently  B<Note>: Apache::lonnavmaps by default will show information 
 logged in user"; if you want things like "due dates for another  for the "currently logged in user".  However, if information
 student" lonnavmaps can not directly retrieve information like  about resources is needed for a different user, e.g., a bubblesheet
 that. You need the EXT function. This module can still help,  exam which uses randomorder, or randompick needs to be printed or 
 because many things, such as the course structure, are constant  graded for named user(s) or specific CODEs, then the username,
   domain, or CODE can be passed as arguments when creating a new 
   navmap object.
   
   Note if you want things like "due dates for another student,
   you would use the EXT function instead of lonnavmaps.
   That said, the lonnavmaps module can still help, because many
   things, such as the course structure, are usually constant
 between users, and Apache::lonnavmaps can help by providing  between users, and Apache::lonnavmaps can help by providing
 symbs for the EXT call.  symbs for the EXT call.
   
Line 91  all, then documents the Apache::lonnavma Line 105  all, then documents the Apache::lonnavma
 is the key to accessing the Big Hash information, covers the use  is the key to accessing the Big Hash information, covers the use
 of the Iterator (which provides the logic for traversing the   of the Iterator (which provides the logic for traversing the 
 somewhat-complicated Big Hash data structure), documents the  somewhat-complicated Big Hash data structure), documents the
 Apache::lonnavmaps::Resource objects that are returned by   Apache::lonnavmaps::Resource objects that are returned singularly
   by: getBySymb(), getById(), getByMapPc(), and getResourceByUrl()
   (can also be as an array), or in an array by retrieveResources().
   
 =head1 Subroutine: render  =head1 Subroutine: render
   
Line 991  sub render_resource { Line 1007  sub render_resource {
             # Don't allow users to manipulate folder              # Don't allow users to manipulate folder
             $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';              $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
             $icon = "<img class=\"LC_space\" src='$whitespace' alt='' />"."<img class=\"LC_contentImage\" src='$location/$icon' alt=\"".($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />";              $icon = "<img class=\"LC_space\" src='$whitespace' alt='' />"."<img class=\"LC_contentImage\" src='$location/$icon' alt=\"".($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />";
               if ($params->{'caller'} eq 'sequence') {
             $linkopen = "";                  $linkopen = "<a href=\"$link\">";
             $linkclose = "";              } else {
                   $linkopen = "";
                   $linkclose = "";
               }
         }          }
         if ((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&          if (((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) ||
                 (&Apache::lonnet::allowed('cev',$env{'request.course.id'}))) &&
             ($resource->symb=~/\_\_\_[^\_]+\_\_\_uploaded/)) {              ($resource->symb=~/\_\_\_[^\_]+\_\_\_uploaded/)) {
             if (!$params->{'map_no_edit_link'}) {              if (!$params->{'map_no_edit_link'}) {
                 my $icon = &Apache::loncommon::lonhttpdurl('/res/adm/pages').'/editmap.png';                  my $icon = &Apache::loncommon::lonhttpdurl('/res/adm/pages').'/editmap.png';
Line 1355  sub render { Line 1375  sub render {
             my $currenturl = $env{'form.postdata'};              my $currenturl = $env{'form.postdata'};
             #$currenturl=~s/^http\:\/\///;              #$currenturl=~s/^http\:\/\///;
             #$currenturl=~s/^[^\/]+//;              #$currenturl=~s/^[^\/]+//;
                           unless ($args->{'caller'} eq 'sequence') {
             $here = $jump = &Apache::lonnet::symbread($currenturl);                  $here = $jump = &Apache::lonnet::symbread($currenturl);
               }
  }   }
  if ($here eq '') {   if (($here eq '') && ($args->{'caller'} ne 'sequence')) {
     my $last;      my $last;
     if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',      if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
                     &GDBM_READER(),0640)) {                      &GDBM_READER(),0640)) {
Line 1540  END Line 1561  END
  $result.='</form>';   $result.='</form>';
     }      }
     if (($args->{'caller'} eq 'navmapsdisplay') &&      if (($args->{'caller'} eq 'navmapsdisplay') &&
         (&Apache::lonnet::allowed('mdc',$env{'request.course.id'}))) {          ((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) ||
            (&Apache::lonnet::allowed('cev',$env{'request.course.id'})))) {
         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};          my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};          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 
Line 1682  END Line 1704  END
  undef($args->{'sort'});   undef($args->{'sort'});
     }      }
   
       # Determine if page will be served with https in case
       # it contains a syllabus which uses an external URL
       # which points at an http site.
   
       my ($is_ssl,$cdom,$cnum,$hostname);
       if ($ENV{'SERVER_PORT'} == 443) {
           $is_ssl = 1;
           if ($r) {
               $hostname = $r->hostname();
           } else {
               $hostname = $ENV{'SERVER_NAME'};
           }
       }
       if ($env{'request.course.id'}) {
           $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
           $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
       }
   
     while (1) {      while (1) {
  if ($args->{'sort'}) {   if ($args->{'sort'}) {
Line 1815  END Line 1854  END
  $stack=$it->getStack();   $stack=$it->getStack();
     }      }
     ($src,$symb,$anchor)=getLinkForResource($stack);      ($src,$symb,$anchor)=getLinkForResource($stack);
               my $srcHasQuestion = $src =~ /\?/;
               if ($env{'request.course.id'}) {
                   if (($is_ssl) && ($src =~ m{^\Q/public/$cdom/$cnum/syllabus\E($|\?)}) &&
                       ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ m{^http://})) {
                       if ($hostname ne '') {
                           $src = 'http://'.$hostname.$src;
                       }
                       $src .= ($srcHasQuestion? '&amp;' : '?') . 'usehttp=1';
                       $srcHasQuestion = 1;
                   } elsif (($is_ssl) && ($src =~ m{^\Q/adm/wrapper/ext/\E(?!https:)})) {
                       if ($hostname ne '') {
                           $src = 'http://'.$hostname.$src;
                       }
                   }
               }
     if (defined($anchor)) { $anchor='#'.$anchor; }      if (defined($anchor)) { $anchor='#'.$anchor; }
     my $srcHasQuestion = $src =~ /\?/;      if (($args->{'caller'} eq 'sequence') && ($curRes->is_map())) {
     $args->{"resourceLink"} = $src.          $args->{"resourceLink"} = $src.($srcHasQuestion?'&amp;':'?') .'navmap=1';
  ($srcHasQuestion?'&amp;':'?') .      } else {
  'symb=' . &escape($symb).$anchor;          $args->{"resourceLink"} = $src.
       ($srcHasQuestion?'&amp;':'?') .
       'symb=' . &escape($symb).$anchor;
       }
  }   }
         # Now, we've decided what parts to show. Loop through them and          # Now, we've decided what parts to show. Loop through them and
         # show them.          # show them.
Line 2686  sub parmval_real { Line 2743  sub parmval_real {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
             last if (defined($$useropt{$norecursechk}));              if (defined($$useropt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return [$$useropt{$norecursechk},'map'];
                   } else {
                       last;
                   }
               }
             my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
             if (defined($$useropt{$recursechk})) { return [$$useropt{$recursechk},'map']; }               if (defined($$useropt{$recursechk})) { return [$$useropt{$recursechk},'map']; } 
         }          }
Line 2704  sub parmval_real { Line 2767  sub parmval_real {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;
             last if (defined($$courseopt{$norecursechk}));              if (defined($$courseopt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return [$$courseopt{$norecursechk},'map'];
                   } else {
                      last;
                   }
               }
             my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;
             if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }                    if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }      
         }          }
Line 2721  sub parmval_real { Line 2790  sub parmval_real {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;
             last if (defined($$courseopt{$norecursechk}));              if (defined($$courseopt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return [$$courseopt{$norecursechk},'map'];
                   } else {
                       last;
                   }
               }
             my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;
             if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }              if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }
         }          }
Line 2755  sub parmval_real { Line 2830  sub parmval_real {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
             last if (defined($$courseopt{$norecursechk}));              if (defined($$courseopt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return [$$courseopt{$norecursechk},'map'];
                   } else {
                       last;
                   }
               }
             my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
             if (defined($$courseopt{$recursechk})) {              if (defined($$courseopt{$recursechk})) {
                 return [$$courseopt{$recursechk},'map'];                  return [$$courseopt{$recursechk},'map'];
Line 2800  sub recurseup_maps { Line 2881  sub recurseup_maps {
     return @recurseup;      return @recurseup;
 }  }
   
   sub recursed_crumbs {
       my ($self,$mapurl) = @_;
       my (@revmapinfo,@revmapres);
       my $mapres = $self->getResourceByUrl($mapurl);
       if (ref($mapres)) {
           @revmapres = map { $self->getByMapPc($_); } split(/,/,$mapres->map_breadcrumbs());
           shift(@revmapres);
       }
       foreach my $map (@revmapres) {
           my $pc = $map->map_pc();
           next if ((!$pc) || ($pc == 1));
           push(@revmapinfo,{'href' => $map->link().'?navmap=1','text' => $map->title(),'no_mt' => 1,});
       }
       return @revmapinfo;
   }
   
 #  #
 #  Determines the open/close dates for printing a map that  #  Determines the open/close dates for printing a map that
 #  encloses a resource.  #  encloses a resource.
Line 2894  sub get_mapparam { Line 2991  sub get_mapparam {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
             last if (defined($$useropt{$norecursechk}));              if (defined($$useropt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return $$useropt{$norecursechk};
                   } else {
                       last;
                   }
               }
             my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
             if (defined($$useropt{$recursechk})) {              if (defined($$useropt{$recursechk})) {
                 return $$useropt{$recursechk};                  return $$useropt{$recursechk};
Line 2919  sub get_mapparam { Line 3022  sub get_mapparam {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;
             last if (defined($$courseopt{$norecursechk}));              if (defined($$courseopt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return $$courseopt{$norecursechk};
                   } else {
                       last;
                   }
               }
             my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;
             if (defined($$courseopt{$recursechk})) {              if (defined($$courseopt{$recursechk})) {
                 return $$courseopt{$recursechk};                  return $$courseopt{$recursechk};
Line 2943  sub get_mapparam { Line 3052  sub get_mapparam {
         }          }
         foreach my $item (@recurseup) {          foreach my $item (@recurseup) {
             my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;              my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;
             last if (defined($$courseopt{$norecursechk}));              if (defined($$courseopt{$norecursechk})) {
                   if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                       return $$courseopt{$norecursechk};
                   } else {
                       last;
                   }
               }
             my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;              my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;
             if (defined($$courseopt{$recursechk})) {              if (defined($$courseopt{$recursechk})) {
                 return $$courseopt{$recursechk};                  return $$courseopt{$recursechk};
Line 2974  sub get_mapparam { Line 3089  sub get_mapparam {
         if (@recurseup) {          if (@recurseup) {
             foreach my $item (@recurseup) {              foreach my $item (@recurseup) {
                 my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;                  my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
                 last if (defined($$courseopt{$norecursechk}));                  if (defined($$courseopt{$norecursechk})) {
                       if ($what =~ /\.(encrypturl|hiddenresource)$/) {
                           return $$courseopt{$norecursechk};
                       } else {
                           last;
                       }
                   }
                 my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;                  my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
                 if (defined($$courseopt{$recursechk})) {                  if (defined($$courseopt{$recursechk})) {
                     return $$courseopt{$recursechk};                      return $$courseopt{$recursechk};
Line 4152  sub enclosing_map_src { Line 4273  sub enclosing_map_src {
 }  }
 sub symb {  sub symb {
     my $self=shift;      my $self=shift;
       if (defined $self->{SYMB}) { return $self->{SYMB}; }
     (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;      (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
     my $symbSrc = &Apache::lonnet::declutter($self->src());      my $symbSrc = &Apache::lonnet::declutter($self->src());
     my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))       my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first)) 
Line 4422  Returns a string with a comma-separated Line 4544  Returns a string with a comma-separated
 for the hierarchy of maps containing a map, with the top level  for the hierarchy of maps containing a map, with the top level
 map first, then descending to deeper levels, with the enclosing map last.  map first, then descending to deeper levels, with the enclosing map last.
   
   =item * B<map_breadcrumbs>:
   
   Same as map_hierarchy, except maps containing only a single itemm if
   it's a map, or containing no items are omitted, unless it's the top
   level map (map_pc = 1), which is always included.
   
 =back  =back
   
 =cut  =cut
Line 4457  sub map_hierarchy { Line 4585  sub map_hierarchy {
     my $pc = $self->map_pc();      my $pc = $self->map_pc();
     return $self->navHash("map_hierarchy_$pc", 0);      return $self->navHash("map_hierarchy_$pc", 0);
 }  }
   sub map_breadcrumbs {
       my $self = shift;
       my $pc = $self->map_pc();
       return $self->navHash("map_breadcrumbs_$pc", 0);
   }
   
 #####  #####
 # Property queries  # Property queries
Line 4786  sub getReturnHash { Line 4919  sub getReturnHash {
     my $self = shift;      my $self = shift;
           
     if (!defined($self->{RETURN_HASH})) {      if (!defined($self->{RETURN_HASH})) {
         my %tmpHash  = &Apache::lonnet::restore($self->{SYMB},undef,$self->{DOMAIN},$self->{USERNAME});          #my %tmpHash  = &Apache::lonnet::restore($self->{SYMB},undef,$self->{DOMAIN},$self->{USERNAME});
         $self->{RETURN_HASH} = \%tmpHash;          #$self->{RETURN_HASH} = \%tmpHash;
           # When info is retrieved for several resources (as when rendering a directory),
           # it is much faster to use the user profile dump and avoid repeated lonnet requests
           # (especially since lonnet::currentdump is using Lond directly whenever possible,
           # and lonnet::restore is not at this point).
           $self->{NAV_MAP}->get_user_data();
           $self->{RETURN_HASH} = $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}};
     }      }
 }         }       
   
Line 5018  sub extractParts { Line 5157  sub extractParts {
     my %parts;      my %parts;
   
     # Retrieve part count, if this is a problem      # Retrieve part count, if this is a problem
     if ($self->is_problem()) {      if ($self->is_raw_problem()) {
  my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');   my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
         my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');          my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
   
Removed from v.1.522  
changed lines
  Added in v.1.534

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