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

Diff for /loncom/Lond.pm between versions 1.1 and 1.3

version 1.1, 2012/04/11 21:32:28 version 1.3, 2012/04/26 20:00:57
Line 39  use GDBM_File; Line 39  use GDBM_File;
   
   
 sub dump_with_regexp {  sub dump_with_regexp {
     #TODO encapsulate $clientname and $clientversion in a object.      my ( $tail, $clientname, $clientversion ) = @_;
     my ( $cmd, $tail, $clientname, $clientversion ) = @_;      my ( $udom, $uname, $namespace, $regexp, $range ) = 
           split /:/, $tail;
   
     my $userinput = "$cmd:$tail";      $regexp = defined $regexp ? unescape($regexp) : '.';
   
     my ($udom,$uname,$namespace,$regexp,$range,$extra)=split(/:/,$tail);  
     if (defined($regexp)) {  
  $regexp=&unescape($regexp);  
     } else {  
  $regexp='.';  
     }  
     my ($start,$end);      my ($start,$end);
   
     if (defined($range)) {      if (defined($range)) {
  if ($range =~/^(\d+)\-(\d+)$/) {          if ($range =~ /^(\d+)\-(\d+)$/) {
     ($start,$end) = ($1,$2);              ($start,$end) = ($1,$2);
  } elsif ($range =~/^(\d+)$/) {          } elsif ($range =~/^(\d+)$/) {
     ($start,$end) = (0,$1);              ($start,$end) = (0,$1);
  } else {          } else {
     undef($range);              undef($range);
  }          }
     }      }
     Apache::lonnet::logthis("Lond.pm: udom:[$udom] uname:[$uname] namespace:[$namespace]");  
     my $hashref = &tie_user_hash($udom, $uname, $namespace,      my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER()) or 
  &GDBM_READER());          return "error: ".($!+0)." tie(GDBM) Failed while attempting dump";
     my $skipcheck;  
     if ($hashref) {      my $qresult = '';
         my $qresult='';      my $count = 0;
  my $count=0;  
 #  #
 # When dump is for roles.db, determine if LON-CAPA version checking is needed.  # When dump is for roles.db, determine if LON-CAPA version checking is needed.
 # Sessions on 2.10 and later will include skipcheck => 1 in extra args ref,  # Sessions on 2.10 and later do not require version checking, as that occurs
 # to indicate no version checking is needed (in this case, checking occurs  
 # on the server hosting the user session, when constructing the roles/courses   # on the server hosting the user session, when constructing the roles/courses 
 # screen).  # screen).
 #   # 
         if ($extra ne '') {      my $skipcheck;
             $extra = &Apache::lonnet::thaw_unescape($extra);      my @ids = &Apache::lonnet::current_machine_ids();
             $skipcheck = $extra->{'skipcheck'};      my (%homecourses, $major, $minor, $now);
         }  
         my @ids = &Apache::lonnet::current_machine_ids();  
         my (%homecourses,$major,$minor,$now);  
 #   # 
 # If dump is for roles.db from a pre-2.10 server, determine the LON-CAPA     # If dump is for roles.db from a pre-2.10 server, determine the LON-CAPA   
 # version on the server which requested the data. For LON-CAPA 2.9, the    # version on the server which requested the data. 
 # client session will have sent its LON-CAPA version when initiating the  
 # connection. For LON-CAPA 2.8 and older, the version is retrieved from  
 # the global %loncaparevs in lonnet.pm.  
 #   # 
         if (($namespace eq 'roles') && (!$skipcheck)) {      if ($namespace eq 'roles') {
             my $loncaparev = $clientversion;          if ($clientversion =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?/) {
             if ($loncaparev eq '') {              $major = $1;
                 $loncaparev = $Apache::lonnet::loncaparevs{$clientname};              $minor = $2;
             }          }
             if ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?/) {          if (($major > 2) || (($major == 2) && ($minor > 9))) {
                 $major = $1;              $skipcheck = 1;
                 $minor = $2;  
             }  
             $now = time;  
         }          }
  while (my ($key,$value) = each(%$hashref)) {          $now = time;
             if ($namespace eq 'roles') {      }
       while (my ($key,$value) = each(%$hashref)) {
               if ($namespace eq 'roles' && (!$skipcheck)) {
                 if ($key =~ m{^/($LONCAPA::match_domain)/($LONCAPA::match_courseid)(/?[^_]*)_(cc|co|in|ta|ep|ad|st|cr)$}) {                  if ($key =~ m{^/($LONCAPA::match_domain)/($LONCAPA::match_courseid)(/?[^_]*)_(cc|co|in|ta|ep|ad|st|cr)$}) {
                     my $cdom = $1;                      my $cdom = $1;
                     my $cnum = $2;                      my $cnum = $2;
                     unless ($skipcheck) {                      my ($role,$roleend,$rolestart) = split(/\_/,$value);
                         my ($role,$roleend,$rolestart) = split(/\_/,$value);                      if (!$roleend || $roleend > $now) {
                         if (!$roleend || $roleend > $now) {  
 #  #
 # For active course roles, check that requesting server is running a LON-CAPA  # For active course roles, check that requesting server is running a LON-CAPA
 # version which meets any version requirements for the course. Do not include  # version which meets any version requirements for the course. Do not include
Line 116  sub dump_with_regexp { Line 102  sub dump_with_regexp {
 # homeserver is the current server, or whether it is a different server.  # homeserver is the current server, or whether it is a different server.
 # In both cases, the course's version requirement needs to be retrieved.  # In both cases, the course's version requirement needs to be retrieved.
 #   # 
                             next unless (&releasereqd_check($cnum,$cdom,$key,$value,$major,                          next unless (&releasereqd_check($cnum,$cdom,$key,$value,$major,
                                                             $minor,\%homecourses,\@ids));                                                          $minor,\%homecourses,\@ids));
                         }  
                     }                      }
                 }                  }
             }              }
     if ($regexp eq '.') {          if ($regexp eq '.') {
  $count++;              $count++;
  if (defined($range) && $count >= $end)   { last; }              if (defined($range) && $count >= $end)   { last; }
  if (defined($range) && $count <  $start) { next; }              if (defined($range) && $count <  $start) { next; }
  $qresult.=$key.'='.$value.'&';              $qresult.=$key.'='.$value.'&';
     } else {          } else {
  my $unescapeKey = &unescape($key);              my $unescapeKey = &unescape($key);
  if (eval('$unescapeKey=~/$regexp/')) {              if (eval('$unescapeKey=~/$regexp/')) {
     $count++;                  $count++;
     if (defined($range) && $count >= $end)   { last; }                  if (defined($range) && $count >= $end)   { last; }
     if (defined($range) && $count <  $start) { next; }                  if (defined($range) && $count <  $start) { next; }
     $qresult.="$key=$value&";                  $qresult.="$key=$value&";
  }              }
     }          }
  }      }
  if (&untie_user_hash($hashref)) {  
       &untie_user_hash($hashref) or 
           return "error: ".($!+0)." untie(GDBM) Failed while attempting dump";
 #  #
 # If dump is for roles.db from a pre-2.10 server, check if the LON-CAPA  # If dump is for roles.db from a pre-2.10 server, check if the LON-CAPA
 # version requirements for courses for which the current server is the home  # version requirements for courses for which the current server is the home
Line 145  sub dump_with_regexp { Line 132  sub dump_with_regexp {
 # user's session. If so, include those role results in the data returned to    # user's session. If so, include those role results in the data returned to  
 # the client server.  # the client server.
 #  #
             if (($namespace eq 'roles') && (!$skipcheck)) {      if (($namespace eq 'roles') && (!$skipcheck)) {
                 if (keys(%homecourses) > 0) {          if (keys(%homecourses) > 0) {
                     $qresult .= &check_homecourses(\%homecourses,$regexp,$count,              $qresult .= &check_homecourses(\%homecourses,$regexp,$count,
                                                    $range,$start,$end,$major,$minor);                                             $range,$start,$end,$major,$minor);
                 }          }
       }
       chop($qresult);
       return $qresult;
   }
   
   
   sub releasereqd_check {
       my ($cnum,$cdom,$key,$value,$major,$minor,$homecourses,$ids) = @_;
       my $home = &Apache::lonnet::homeserver($cnum,$cdom);
       return if ($home eq 'no_host');
       my ($reqdmajor,$reqdminor,$displayrole);
       if ($cnum =~ /$LONCAPA::match_community/) {
           if ($major eq '' && $minor eq '') {
               return unless ((ref($ids) eq 'ARRAY') && 
                              (grep(/^\Q$home\E$/,@{$ids})));
           } else {
               $reqdmajor = 2;
               $reqdminor = 9;
               return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
           }
       }
       my $hashid = $cdom.':'.$cnum;
       my ($courseinfo,$cached) =
           &Apache::lonnet::is_cached_new('courseinfo',$hashid);
       if (defined($cached)) {
           if (ref($courseinfo) eq 'HASH') {
               if (exists($courseinfo->{'releaserequired'})) {
                   my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
                   return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
             }              }
     chop($qresult);          }
         Apache::lonnet::logthis("Lond.pm: qresult:[$qresult]");  
         return $qresult;  
         #&Reply($client, \$qresult, $userinput);  
  } else {  
     return "error: ".($!+0)." untie(GDBM) Failed while attempting dump";  
          #&Failure( $client, "error: ".($!+0)." untie(GDBM) Failed ".  
  #     "while attempting dump\n", $userinput);  
  }  
     } else {      } else {
     return "error: ".($!+0)." tie(GDBM) Failed while attempting dump";          if (ref($ids) eq 'ARRAY') {
     #&Failure($client, "error: ".($!+0)." tie(GDBM) Failed ".              if (grep(/^\Q$home\E$/,@{$ids})) {
  # "while attempting dump\n", $userinput);                  if (ref($homecourses) eq 'HASH') {
                       if (ref($homecourses->{$cdom}) eq 'HASH') {
                           if (ref($homecourses->{$cdom}{$cnum}) eq 'HASH') {
                               if (ref($homecourses->{$cdom}{$cnum}) eq 'ARRAY') {
                                   push(@{$homecourses->{$cdom}{$cnum}},{$key=>$value});
                               } else {
                                   $homecourses->{$cdom}{$cnum} = [{$key=>$value}];
                               }
                           } else {
                               $homecourses->{$cdom}{$cnum} = [{$key=>$value}];
                           }
                       } else {
                           $homecourses->{$cdom}{$cnum} = [{$key=>$value}];
                       }
                   }
                   return;
               }
           }
           my $courseinfo = &get_courseinfo_hash($cnum,$cdom,$home);
           if (ref($courseinfo) eq 'HASH') {
               if (exists($courseinfo->{'releaserequired'})) {
                   my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
                   return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
               }
           } else {
               return;
           }
     }      }
       return 1;
   }
   
   
     #never get here  sub check_homecourses {
     die("SHOULD NOT HAPPEN!");      my ($homecourses,$regexp,$count,$range,$start,$end,$major,$minor) = @_;
       my ($result,%addtocache);
       my $yesterday = time - 24*3600; 
       if (ref($homecourses) eq 'HASH') {
           my (%okcourses,%courseinfo,%recent);
           foreach my $domain (keys(%{$homecourses})) {
               my $hashref = 
                   &tie_domain_hash($domain, "nohist_courseids", &GDBM_WRCREAT());
               if (ref($hashref) eq 'HASH') {
                   while (my ($key,$value) = each(%$hashref)) {
                       my $unesc_key = &unescape($key);
                       if ($unesc_key =~ /^lasttime:(\w+)$/) {
                           my $cid = $1;
                           $cid =~ s/_/:/;
                           if ($value > $yesterday ) {
                               $recent{$cid} = 1;
                           }
                           next;
                       }
                       my $items = &Apache::lonnet::thaw_unescape($value);
                       if (ref($items) eq 'HASH') {
                           my ($cdom,$cnum) = split(/_/,$unesc_key);
                           my $hashid = $cdom.':'.$cnum; 
                           $courseinfo{$hashid} = $items;
                           if (ref($homecourses->{$cdom}{$cnum}) eq 'ARRAY') {
                               my ($reqdmajor,$reqdminor) = split(/\./,$items->{'releaserequired'});
                               if (&useable_role($reqdmajor,$reqdminor,$major,$minor)) {
                                  $okcourses{$hashid} = 1;
                               }
                           }
                       }
                   }
                   unless (&untie_domain_hash($hashref)) {
                       &logthis("Failed to untie tied hash for nohist_courseids.db for $domain");
                   }
               } else {
                   &logthis("Failed to tie hash for nohist_courseids.db for $domain");
               }
           }
           foreach my $hashid (keys(%recent)) {
               my ($result,$cached)=&Apache::lonnet::is_cached_new('courseinfo',$hashid);
               unless ($cached) {
                   &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
               }
           }
           foreach my $cdom (keys(%{$homecourses})) {
               if (ref($homecourses->{$cdom}) eq 'HASH') {
                   foreach my $cnum (keys(%{$homecourses->{$cdom}})) {
                       my $hashid = $cdom.':'.$cnum;
                       next if ($recent{$hashid});
                       &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
                   }
               }
           }
           foreach my $hashid (keys(%okcourses)) {
               my ($cdom,$cnum) = split(/:/,$hashid);
               if ((ref($homecourses->{$cdom}) eq 'HASH') &&  
                   (ref($homecourses->{$cdom}{$cnum}) eq 'ARRAY')) {
                   foreach my $role (@{$homecourses->{$cdom}{$cnum}}) {
                       if (ref($role) eq 'HASH') {
                           while (my ($key,$value) = each(%{$role})) {
                               if ($regexp eq '.') {
                                   $count++;
                                   if (defined($range) && $count >= $end)   { last; }
                                   if (defined($range) && $count <  $start) { next; }
                                   $result.=$key.'='.$value.'&';
                               } else {
                                   my $unescapeKey = &unescape($key);
                                   if (eval('$unescapeKey=~/$regexp/')) {
                                       $count++;
                                       if (defined($range) && $count >= $end)   { last; }
                                       if (defined($range) && $count <  $start) { next; }
                                       $result.="$key=$value&";
                                   }
                               }
                           }
                       }
                   }
               }
           }
       }
       return $result;
   }
   
   
   sub useable_role {
       my ($reqdmajor,$reqdminor,$major,$minor) = @_; 
       if ($reqdmajor ne '' && $reqdminor ne '') {
           return if (($major eq '' && $minor eq '') ||
                      ($major < $reqdmajor) ||
                      (($major == $reqdmajor) && ($minor < $reqdminor)));
       }
     return 1;      return 1;
 }  }
   
   
   sub get_courseinfo_hash {
       my ($cnum,$cdom,$home) = @_;
       my %info;
       eval {
           local($SIG{ALRM}) = sub { die "timeout\n"; };
           local($SIG{__DIE__})='DEFAULT';
           alarm(3);
           %info = &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,1,[$home],'.');
           alarm(0);
       };
       if ($@) {
           if ($@ eq "timeout\n") {
               &logthis("<font color='blue'>WARNING courseiddump for $cnum:$cdom from $home timedout</font>");
           } else {
               &logthis("<font color='yellow'>WARNING unexpected error during eval of call for courseiddump from $home</font>");
           }
       } else {
           if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
               my $hashid = $cdom.':'.$cnum;
               return &Apache::lonnet::do_cache_new('courseinfo',$hashid,$info{$cdom.'_'.$cnum},600);
           }
       }
       return;
   }
   
   
   
   
 1;  1;
   
 __END__  __END__
Line 191  LONCAPA::Lond.pm Line 348  LONCAPA::Lond.pm
   
 =over 4  =over 4
   
 =item dump_with_regexp( $cmd, $tail, $client )  =item dump_with_regexp( $tail, $client )
   
 Dump a profile database with an optional regular expression to match against  Dump a profile database with an optional regular expression to match against
 the keys.  In this dump, no effort is made to separate symb from version  the keys.  In this dump, no effort is made to separate symb from version
Line 199  information. Presumably the databases th Line 356  information. Presumably the databases th
 different structure.  Need to look at this and improve the documentation of  different structure.  Need to look at this and improve the documentation of
 both this and the currentdump handler.  both this and the currentdump handler.
   
 $cmd is the command keyword.  
   
 $tail a colon separated list containing  $tail a colon separated list containing
   
 =over   =over 
Line 224  selective dumps. Line 379  selective dumps.
   
 optional range of entries e.g., 10-20 would return the 10th to 19th items, etc.    optional range of entries e.g., 10-20 would return the 10th to 19th items, etc.  
   
 =item extra          
   
 optional ref to hash of additional args. currently skipcheck is only key used.     
   
 =back  =back
   
 $client is the channel open on the client.  $client is the channel open on the client.
Line 236  Returns: 1 (Continue processing). Line 387  Returns: 1 (Continue processing).
   
 Side effects: response is written to $client.    Side effects: response is written to $client.  
   
   
   =item releasereqd_check( $cnum, $cdom, $key, $value, $major, $minor, 
           $homecourses, $ids )
   
   releasereqd_check() will determine if a LON-CAPA version (defined in the
   $major,$minor args passed) is not too old to allow use of a role in a 
   course ($cnum,$cdom args passed), if at least one of the following applies: 
   (a) the course is a Community, (b) the course's home server is *not* the
   current server, or (c) cached course information is not stale. 
   
   For the case where none of these apply, the course is added to the 
   $homecourse hash ref (keys = courseIDs, values = array of a hash of roles).
   The $homecourse hash ref is for courses for which the current server is the 
   home server.  LON-CAPA version requirements are checked elsewhere for the
   items in $homecourse.
   
   
   =item check_homecourses( $homecourses, $regexp, $count, $range, $start, $end, 
           $major, $minor )
   
   check_homecourses() will retrieve course information for those courses which
   are keys of the $homecourses hash ref (first arg). The nohist_courseids.db 
   GDBM file is tied and course information for each course retrieved. Last   
   visit (lasttime key) is also retrieved for each, and cached values updated  
   for any courses last visited less than 24 hours ago. Cached values are also
   updated for any courses included in the $homecourses hash ref.
   
   The reason for the 24 hours constraint is that the cron entry in 
   /etc/cron.d/loncapa for /home/httpd/perl/refresh_courseids_db.pl causes 
   cached course information to be updated nightly for courses with activity
   within the past 24 hours.
   
   Role information for the user (included in a ref to an array of hashes as the
   value for each key in $homecourses) is appended to the result returned by the
   routine, which will in turn be appended to the string returned to the client
   hosting the user's session.
   
   
   =item useable_role( $reqdmajor, $reqdminor, $major, $minor )
   
   useable_role() will compare the LON-CAPA version required by a course with 
   the version available on the client server.  If the client server's version
   is compatible, 1 will be returned.
   
   
   =item get_courseinfo_hash( $cnum, $cdom, $home )
   
   get_courseinfo_hash() is used to retrieve course information from the db
   file: nohist_courseids.db for a course for which the current server is *not*
   the home server.
   
   A hash of a hash will be retrieved. The outer hash contains a single key --
   courseID -- for the course for which the data are being requested.
   The contents of the inner hash, for that single item in the outer hash
   are returned (and cached in memcache for 10 minutes).
   
   
   
 =back  =back
   
 =head1 BUGS  =head1 BUGS
Removed from v.1.1  
changed lines
  Added in v.1.3

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