Diff for /loncom/metadata_database/searchcat.pl between versions 1.55 and 1.83

version 1.55, 2004/04/08 15:57:32 version 1.83, 2016/01/27 22:22:59
Line 65  and correct user experience. Line 65  and correct user experience.
 =cut  =cut
   
 use strict;  use strict;
   
 use DBI;  use DBI;
 use lib '/home/httpd/lib/perl/';  use lib '/home/httpd/lib/perl/';
 use LONCAPA::Configuration;  
 use LONCAPA::lonmetadata;  use LONCAPA::lonmetadata;
   use LONCAPA;
   use Getopt::Long;
 use IO::File;  use IO::File;
 use HTML::TokeParser;  use HTML::TokeParser;
 use GDBM_File;  use GDBM_File;
 use POSIX qw(strftime mktime);  use POSIX qw(strftime mktime);
   use Mail::Send;
   use Apache::loncommon();
   
   use Apache::lonnet();
   
 use File::Find;  use File::Find;
   
   #
   # Set up configuration options
   my ($simulate,$oneuser,$help,$verbose,$logfile,$debug);
   GetOptions (
               'help'     => \$help,
               'simulate' => \$simulate,
               'only=s'   => \$oneuser,
               'verbose=s'  => \$verbose,
               'debug' => \$debug,
               );
   
   if ($help) {
       print <<"ENDHELP";
   $0
   Rebuild and update the LON-CAPA metadata database. 
   Options:
       -help          Print this help
       -simulate      Do not modify the database.
       -only=user     Only compute for the given user.  Implies -simulate   
       -verbose=val   Sets logging level, val must be a number
       -debug         Turns on debugging output
   ENDHELP
       exit 0;
   }
   
   if (! defined($debug)) {
       $debug = 0;
   }
   
   if (! defined($verbose)) {
       $verbose = 0;
   }
   
   if (defined($oneuser)) {
       $simulate=1;
   }
   
 ##  ##
 ## Use variables for table names so we can test this routine a little easier  ## Use variables for table names so we can test this routine a little easier
 my $oldname = 'metadata';  my %oldnames = (
 my $newname = 'newmetadata';                   'metadata'    => 'metadata',
                    'portfolio'   => 'portfolio_metadata',
                    'access'      => 'portfolio_access',
                    'addedfields' => 'portfolio_addedfields',
                    'allusers'    => 'allusers',
                  );
   
   my %newnames;
   # new table names -  append pid to have unique temporary tables
   foreach my $key (keys(%oldnames)) {
       $newnames{$key} = 'new'.$oldnames{$key}.$$;
   }
   
 #  #
 # Read loncapa_apache.conf and loncapa.conf  
 my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');  
 my %perlvar=%{$perlvarref};  
 undef $perlvarref;  
 delete $perlvar{'lonReceipt'}; # remove since sensitive (really?) & not needed  
 #  
 # Only run if machine is a library server  # Only run if machine is a library server
 exit if ($perlvar{'lonRole'} ne 'library');  exit if ($Apache::lonnet::perlvar{'lonRole'} ne 'library');
   my $hostid = $Apache::lonnet::perlvar{'lonHostID'};
   
 #  #
 #  Make sure this process is running from user=www  #  Make sure this process is running from user=www
 my $wwwid=getpwnam('www');  my $wwwid=getpwnam('www');
 if ($wwwid!=$<) {  if ($wwwid!=$<) {
     my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";      my $emailto="$Apache::lonnet::perlvar{'lonAdmEMail'},$Apache::lonnet::perlvar{'lonSysEMail'}";
     my $subj="LON: $perlvar{'lonHostID'} User ID mismatch";      my $subj="LON: $Apache::lonnet::perlvar{'lonHostID'} User ID mismatch";
     system("echo 'User ID mismatch. searchcat.pl must be run as user www.' |\      system("echo 'User ID mismatch. searchcat.pl must be run as user www.' |\
  mailto $emailto -s '$subj' > /dev/null");   mail -s '$subj' $emailto > /dev/null");
     exit 1;      exit 1;
 }  }
 #  #
 # Let people know we are running  # Let people know we are running
 open(LOG,'>'.$perlvar{'lonDaemons'}.'/logs/searchcat.log');  open(LOG,'>>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/logs/searchcat.log');
 print LOG '==== Searchcat Run '.localtime()."====\n";  &log(0,'==== Searchcat Run '.localtime()."====");
   
   
   if ($debug) {
       &log(0,'simulating') if ($simulate);
       &log(0,'only processing user '.$oneuser) if ($oneuser);
       &log(0,'verbosity level = '.$verbose);
   }
 #  #
 # Connect to database  # Connect to database
 my $dbh;  my $dbh;
 if (! ($dbh = DBI->connect("DBI:mysql:loncapa","www",$perlvar{'lonSqlAccess'},  if (! ($dbh = DBI->connect("DBI:mysql:loncapa","www",$Apache::lonnet::perlvar{'lonSqlAccess'},
                           { RaiseError =>0,PrintError=>0}))) {                            { RaiseError =>0,PrintError=>0}))) {
     print LOG "Cannot connect to database!\n";      &log(0,"Cannot connect to database!");
     die "MySQL Error: Cannot connect to database!\n";      die "MySQL Error: Cannot connect to database!\n";
 }  }
 # This can return an error and still be okay, so we do not bother checking.  # This can return an error and still be okay, so we do not bother checking.
 # (perhaps it should be more robust and check for specific errors)  # (perhaps it should be more robust and check for specific errors)
 $dbh->do('DROP TABLE IF EXISTS '.$newname);  foreach my $key (keys(%newnames)) {
       if ($newnames{$key} ne '') {
           $dbh->do('DROP TABLE IF EXISTS '.$newnames{$key});
       }
   }
   
 #  #
 # Create the new table  # Create the new metadata, portfolio and allusers tables
 my $request = &LONCAPA::lonmetadata::create_metadata_storage($newname);  foreach my $key (keys(%newnames)) {
 $dbh->do($request);      if ($newnames{$key} ne '') { 
 if ($dbh->err) {          my $request =
     $dbh->disconnect();               &LONCAPA::lonmetadata::create_metadata_storage($newnames{$key},$oldnames{$key});
     print LOG "\nMySQL Error Create: ".$dbh->errstr."\n";          $dbh->do($request);
     die $dbh->errstr;          if ($dbh->err) {
               $dbh->disconnect();
               &log(0,"MySQL Error Create: ".$dbh->errstr);
               die $dbh->errstr;
           }
       }
 }  }
   
 #  #
 # find out which users we need to examine  # find out which users we need to examine
 opendir(RESOURCES,"$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}");  my @domains = sort(&Apache::lonnet::current_machine_domains());
 my @homeusers =   &log(9,'domains ="'.join('","',@domains).'"');
     grep {  
         &ishome("$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}/$_");  foreach my $dom (@domains) {
     } grep {       &log(9,'domain = '.$dom);
         !/^\.\.?$/;      opendir(RESOURCES,"$Apache::lonnet::perlvar{'lonDocRoot'}/res/$dom");
     } readdir(RESOURCES);      my @homeusers = 
 closedir RESOURCES;          grep {
 #              &ishome("$Apache::lonnet::perlvar{'lonDocRoot'}/res/$dom/$_");
 # Loop through the users          } grep { 
 foreach my $user (@homeusers) {              !/^\.\.?$/;
     print LOG "=== User: ".$user."\n";          } readdir(RESOURCES);
     my $prodir=&propath($perlvar{'lonDefDomain'},$user);      closedir RESOURCES;
     #      &log(5,'users = '.$dom.':'.join(',',@homeusers));
     # Use File::Find to get the files we need to read/modify      #
     find(      if ($oneuser) {
          {preprocess => \&only_meta_files,          @homeusers=($oneuser);
 #          wanted     => \&print_filename,      }
 #          wanted     => \&log_metadata,  
           wanted     => \&process_meta_file,      #
           },       # Loop through the users
          "$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}/$user");      foreach my $user (@homeusers) {
           &log(0,"=== User: ".$user);
           &process_dynamic_metadata($user,$dom);
           #
           # Use File::Find to get the files we need to read/modify
           find(
                {preprocess => \&only_meta_files,
                 #wanted     => \&print_filename,
                 #wanted     => \&log_metadata,
                 wanted     => \&process_meta_file,
                 no_chdir   => 1,
                }, join('/',($Apache::lonnet::perlvar{'lonDocRoot'},'res',$dom,$user)) );
       }
       # Search for all users and public portfolio files
       my (%allusers,%portusers,%courses);
       if ($oneuser) {
           %portusers = (
                           $oneuser => '',
                          );
           %allusers = (
                           $oneuser => '',
                          );
           %courses = &courseiddump($dom,'.',1,'.','.',$oneuser,undef,
                                    undef,'.');
       } else {
           # get courseIDs for domain on current machine
           %courses=&Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',1,[$hostid],'.');
           my $dir = $Apache::lonnet::perlvar{lonUsersDir}.'/'.$dom;
           &descend_tree($dom,$dir,0,\%portusers,\%allusers);
       }
       foreach my $uname (keys(%portusers)) {
           my $urlstart = '/uploaded/'.$dom.'/'.$uname;
           my $pathstart = &propath($dom,$uname).'/userfiles';
           my $is_course = '';
           if (exists($courses{$dom.'_'.$uname})) {
               $is_course = 1;
           }
           my $curr_perm = &Apache::lonnet::get_portfile_permissions($dom,$uname);
           my %access = &Apache::lonnet::get_access_controls($curr_perm);
           foreach my $file (keys(%access)) {
               my ($group,$url,$fullpath);
               if ($is_course) {
                   ($group, my ($path)) = ($file =~ /^(\w+)(\/.+)$/);
                   $fullpath = $pathstart.'/groups/'.$group.'/portfolio'.$path;
                   $url = $urlstart.'/groups/'.$group.'/portfolio'.$path;
               } else {
                   $fullpath = $pathstart.'/portfolio'.$file;
                   $url = $urlstart.'/portfolio'.$file;
               }
               if (ref($access{$file}) eq 'HASH') {
                   my %portaccesslog = 
                       &LONCAPA::lonmetadata::process_portfolio_access_data($dbh,
                              $simulate,\%newnames,$url,$fullpath,$access{$file});
                   &portfolio_logging(%portaccesslog);
               }
               my %portmetalog = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,$simulate,\%newnames,$url,$fullpath,$is_course,$dom,$uname,$group);
               &portfolio_logging(%portmetalog);
           }
       }
       my (%names_by_id,,%ids_by_name,%idstodelete,%idstoadd,%duplicates);
       unless ($simulate || $oneuser) {
           my $idshashref;
           $idshashref = &tie_domain_hash($dom, "ids", &GDBM_WRCREAT());
           if (ref($idshashref) eq 'HASH') {
               %names_by_id = %{$idshashref};
               while (my ($id,$uname) = each(%{$idshashref}) ) {
                   $id = &unescape($id);
                   $uname = &unescape($uname); 
                   $names_by_id{$id} = $uname;
                   push(@{$ids_by_name{$uname}},$id);
               }
               &untie_domain_hash($idshashref);
           }
       }
       # Update allusers
       foreach my $uname (keys(%allusers)) {
           next if (exists($courses{$dom.'_'.$uname}));
           my %userdata = 
               &Apache::lonnet::get('environment',['firstname','lastname',
                   'middlename','generation','id','permanentemail'],$dom,$uname);
           unless ($simulate || $oneuser) {
               my $addid;
               if ($userdata{'id'} ne '') {
                   $addid = $userdata{'id'};
                   $addid=~tr/A-Z/a-z/;
               }
               if (exists($ids_by_name{$uname})) {
                   if (ref($ids_by_name{$uname}) eq 'ARRAY') {
                       if (scalar(@{$ids_by_name{$uname}}) > 1) {
                           &log(0,"Multiple employee/student IDs found in ids.db for $uname:$dom -- ".join(', ',@{$ids_by_name{$uname}}));
                       }
                       foreach my $id (@{$ids_by_name{$uname}}) {
                           if ($id eq $userdata{'id'}) {
                               undef($addid);
                           } else { 
                               $idstodelete{$id} = $uname;
                           }
                       }
                   }
               }
               if ($addid ne '') {
                   if (exists($idstoadd{$addid})) {
                       push(@{$duplicates{$addid}},$uname);
                   } else {
                       $idstoadd{$addid} = $uname;
                   }
               }
           }
           
           $userdata{'username'} = $uname;
           $userdata{'domain'} = $dom;
           my %alluserslog = 
               &LONCAPA::lonmetadata::process_allusers_data($dbh,$simulate,
                   \%newnames,$uname,$dom,\%userdata);
           foreach my $item (keys(%alluserslog)) {
               &log(0,$alluserslog{$item});
           }
       }
       unless ($simulate || $oneuser) {
           if (keys(%idstodelete) > 0) {
               my %resulthash = &Apache::lonnet::iddel($dom,\%idstodelete,$hostid);
               if ($resulthash{$hostid} eq 'ok') {
                   foreach my $id (sort(keys(%idstodelete))) {
                       &log(0,"Record deleted from ids.db for $dom -- $id => ".$idstodelete{$id});
                   }
               } else {
                   &log(0,"Error: '$resulthash{$hostid}' occurred when attempting to delete records from ids.db for $dom");
               }
           }
           if (keys(%idstoadd) > 0) {
               my $idmessage = '';
               my %newids;
               foreach my $addid (sort(keys(%idstoadd))) {
                   if ((exists($names_by_id{$addid})) && ($names_by_id{$addid} ne $idstoadd{$addid})  && !($idstodelete{$addid})) {
                       &log(0,"Two usernames associated with a single ID $addid in domain: $dom: $names_by_id{$addid} (current) and $idstoadd{$addid}\n");
                       $idmessage .= "$addid,$names_by_id{$addid},$idstoadd{$addid}\n";
                   } else {
                       $newids{$addid} = $idstoadd{$addid};
                   }
               }
               if (keys(%newids) > 0) {
                   my $putresult = &Apache::lonnet::put_dom('ids',\%idstoadd,$dom,$hostid);
                   if ($putresult eq 'ok') {
                       foreach my $id (sort(keys(%idstoadd))) {
                           &log(0,"Record added to ids.db for $dom -- $id => ".$idstoadd{$id});
                       }
                   } else {
                       &log(0,"Error: '$putresult' occurred when attempting to add records to ids.db for $dom"); 
                   }
               }
               if ($idmessage) {
                   my $to = &Apache::loncommon::build_recipient_list(undef,'idconflictsmail',$dom);
                   if ($to ne '') {
                       my $msg = new Mail::Send;
                       $msg->to($to);
                       $msg->subject('LON-CAPA studentIDs conflict');
                       my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                       my $hostname = &Apache::lonnet::hostname($lonhost);
                       my $replytoaddress = 'do-not-reply@'.$hostname;
                       $msg->add('Reply-to',$replytoaddress);
                       $msg->add('From','www@'.$hostname);
                       $msg->add('Content-type','text/plain; charset=UTF-8');
                       if (my $fh = $msg->open()) {
                           print $fh 
                               'The following IDs are used for more than one user in your domain:'."\n".
                               'Each row contains: Student/Employee ID, Current username in ids.db file, '.
                               'Additional username'."\n\n".
                               $idmessage;
                           $fh->close;
                       }
                   }
               }
           }
           if (keys(%duplicates) > 0) {
               foreach my $id (sort(keys(%duplicates))) {
                   &log(0,"Duplicate IDs found for entries to add to ids.db in $dom -- $id => $idstodelete{$id}");
               }
           }
       }
 }  }
   
 #  #
 # Rename the table  # Rename the tables
 $dbh->do('DROP TABLE IF EXISTS '.$oldname);  if (! $simulate) {
 if (! $dbh->do('RENAME TABLE '.$newname.' TO '.$oldname)) {      foreach my $key (keys(%oldnames)) {
     print LOG "MySQL Error Rename: ".$dbh->errstr."\n";          if (($oldnames{$key} ne '') && ($newnames{$key} ne '')) {
     die $dbh->errstr;              $dbh->do('DROP TABLE IF EXISTS '.$oldnames{$key});
               if (! $dbh->do('RENAME TABLE '.$newnames{$key}.' TO '.$oldnames{$key})) {
                   &log(0,"MySQL Error Rename: ".$dbh->errstr);
                   die $dbh->errstr;
               } else {
                   &log(1,"MySQL table rename successful for $key.");
               }
           }
       }
 }  }
 if (! $dbh->disconnect) {  if (! $dbh->disconnect) {
     print LOG "MySQL Error Disconnect: ".$dbh->errstr."\n";      &log(0,"MySQL Error Disconnect: ".$dbh->errstr);
     die $dbh->errstr;      die $dbh->errstr;
 }  }
 ##  ##
 ## Finished!  ## Finished!
 print LOG "==== Searchcat completed ".localtime()." ====\n";  &log(0,"==== Searchcat completed ".localtime()." ====");
 close(LOG);  close(LOG);
   
 &write_type_count();  &write_type_count();
Line 171  close(LOG); Line 424  close(LOG);
   
 exit 0;  exit 0;
   
   ##
   ## Status logging routine.  Inputs: $level, $message
   ## 
   ## $level 0 should be used for normal output and error messages
   ##
   ## $message does not need to end with \n.  In the case of errors
   ## the message should contain as much information as possible to
   ## help in diagnosing the problem.
   ##
   sub log {
       my ($level,$message)=@_;
       $level = 0 if (! defined($level));
       if ($verbose >= $level) {
           print LOG $message.$/;
       }
   }
   
   sub portfolio_logging {
       my (%portlog) = @_;
       foreach my $key (keys(%portlog)) {
           if (ref($portlog{$key}) eq 'HASH') {
               foreach my $item (keys(%{$portlog{$key}})) {
                   &log(0,$portlog{$key}{$item});
               }
           }
       }
   }
   
   sub descend_tree {
       my ($dom,$dir,$depth,$allportusers,$alldomusers) = @_;
       if (-d $dir) {
           opendir(DIR,$dir);
           my @contents = grep(!/^\./,readdir(DIR));
           closedir(DIR);
           $depth ++;
           foreach my $item (@contents) {
               if (($depth < 4) && (length($item) == 1)) {
                   &descend_tree($dom,$dir.'/'.$item,$depth,$allportusers,$alldomusers);
               } else {
                   if (-e $dir.'/'.$item.'/file_permissions.db') {
                       $$allportusers{$item} = '';
                   }
                   if (-e $dir.'/'.$item.'/passwd') {
                       $$alldomusers{$item} = '';
                   }
               }       
           }
       } 
   }
   
 ########################################################  ########################################################
 ########################################################  ########################################################
 ###                                                  ###  ###                                                  ###
Line 190  sub only_meta_files { Line 493  sub only_meta_files {
     foreach my $file (@PossibleFiles) {      foreach my $file (@PossibleFiles) {
         if ( ($file =~ /\.meta$/ &&            # Ends in meta          if ( ($file =~ /\.meta$/ &&            # Ends in meta
               $file !~ /\.\d+\.[^\.]+\.meta$/  # is not for a prior version                $file !~ /\.\d+\.[^\.]+\.meta$/  # is not for a prior version
              ) || (-d $file )) { # directories are okay               ) || (-d $File::Find::dir."/".$file )) { # directories are okay
                  # but we do not want /. or /..                   # but we do not want /. or /..
             push(@ChosenFiles,$file);              push(@ChosenFiles,$file);
         }          }
Line 205  sub only_meta_files { Line 508  sub only_meta_files {
 sub print_filename {  sub print_filename {
     my ($file) = $_;      my ($file) = $_;
     my $fullfilename = $File::Find::name;      my $fullfilename = $File::Find::name;
     if (-d $file) {      if ($debug) {
         print LOG " Got directory ".$fullfilename."\n";          if (-d $file) {
     } else {              &log(5," Got directory ".$fullfilename);
         print LOG " Got file ".$fullfilename."\n";          } else {
               &log(5," Got file ".$fullfilename);
           }
     }      }
     $_=$file;      $_=$file;
 }  }
Line 217  sub log_metadata { Line 522  sub log_metadata {
     my ($file) = $_;      my ($file) = $_;
     my $fullfilename = $File::Find::name;      my $fullfilename = $File::Find::name;
     return if (-d $fullfilename); # No need to do anything here for directories      return if (-d $fullfilename); # No need to do anything here for directories
     print LOG $fullfilename."\n";      if ($debug) {
     my $ref=&metadata($fullfilename);          &log(6,$fullfilename);
     if (! defined($ref)) {          my $ref = &metadata($fullfilename);
         print LOG "    No data\n";          if (! defined($ref)) {
         return;              &log(6,"    No data");
     }              return;
     while (my($key,$value) = each(%$ref)) {          }
         print LOG "    ".$key." => ".$value."\n";          while (my($key,$value) = each(%$ref)) {
               &log(6,"    ".$key." => ".$value);
           }
           &count_copyright($ref->{'copyright'});
     }      }
     &count_copyright($ref->{'copyright'});  
     $_=$file;      $_=$file;
 }  }
   
   
 ##  ##
 ## process_meta_file  ## process_meta_file
 ##   Called by File::Find.   ##   Called by File::Find. 
 ##   Only input is the filename in $_.    ##   Only input is the filename in $_.  
 sub process_meta_file {  sub process_meta_file {
     my ($file) = $_;      my ($file) = $_;
     my $filename = $File::Find::name;      my $filename = $File::Find::name; # full filename
     return if (-d $filename); # No need to do anything here for directories      return if (-d $filename); # No need to do anything here for directories
     #      #
     print LOG $filename."\n";      &log(3,$filename) if ($debug);
     #      #
     my $ref=&metadata($filename);      my $ref = &metadata($filename);
     #      #
     # $url is the original file url, not the metadata file      # $url is the original file url, not the metadata file
     my $url='/res/'.&declutter($filename);      my $target = $filename;
     $url=~s/\.meta$//;      $target =~ s/\.meta$//;
     print LOG "    ".$url."\n";      my $url='/res/'.&declutter($target);
       &log(3,"    ".$url) if ($debug);
     #      #
     # Ignore some files based on their metadata      # Ignore some files based on their metadata
     if ($ref->{'obsolete'}) {       if ($ref->{'obsolete'}) { 
         print LOG "obsolete\n";           &log(3,"obsolete") if ($debug);
         return;           return; 
     }      }
     &count_copyright($ref->{'copyright'});      &count_copyright($ref->{'copyright'});
     if ($ref->{'copyright'} eq 'private') {       if ($ref->{'copyright'} eq 'private') { 
         print LOG "private\n";           &log(3,"private") if ($debug);
         return;           return; 
     }      }
     #      #
Line 264  sub process_meta_file { Line 571  sub process_meta_file {
     my %dyn;      my %dyn;
     if ($url=~ m:/default$:) {      if ($url=~ m:/default$:) {
         $url=~ s:/default$:/:;          $url=~ s:/default$:/:;
           &log(3,"Skipping dynamic data") if ($debug);
     } else {      } else {
         # %dyn=&dynamicmeta($url);          &log(3,"Retrieving dynamic data") if ($debug);
           %dyn=&get_dynamic_metadata($url);
         &count_type($url);          &count_type($url);
     }      }
       &LONCAPA::lonmetadata::getfiledates($ref,$target);
     #      #
     $ref->{'creationdate'}     = &sqltime($ref->{'creationdate'});  
     $ref->{'lastrevisiondate'} = &sqltime($ref->{'lastrevisiondate'});  
     my %Data = (      my %Data = (
                 %$ref,                  %$ref,
                 %dyn,                  %dyn,
                 'url'=>$url,                  'url'=>$url,
                 'version'=>'current');                  'version'=>'current');
     my ($count,$err) = &LONCAPA::lonmetadata::store_metadata($dbh,$newname,      if (! $simulate) {
                                                              \%Data);          my ($count,$err) = 
     if ($err) {            &LONCAPA::lonmetadata::store_metadata($dbh,$newnames{'metadata'},
         print LOG "\nMySQL Error Insert: ".$err."\n";                                                  'metadata',\%Data);
         die $err;          if ($err) {
     }              &log(0,"MySQL Error Insert: ".$err);
     if ($count < 1) {          }
         print LOG "Unable to insert record into MySQL database for $url\n";          if ($count < 1) {
         die "Unable to insert record into MySQl database for $url";              &log(0,"Unable to insert record into MySQL database for $url");
     } else {          }
         print LOG "Count = ".$count."\n";  
     }      }
     #      #
     # Reset $_ before leaving      # Reset $_ before leaving
Line 302  sub process_meta_file { Line 609  sub process_meta_file {
 ########################################################  ########################################################
 ########################################################  ########################################################
 sub metadata {  sub metadata {
     my ($uri)=@_;      my ($uri) = @_;
     my %metacache=();      my %metacache=();
     $uri=&declutter($uri);      $uri=&declutter($uri);
     my $filename=$uri;      my $filename=$uri;
Line 311  sub metadata { Line 618  sub metadata {
     if ($filename !~ /\.meta$/) {       if ($filename !~ /\.meta$/) { 
         $filename.='.meta';          $filename.='.meta';
     }      }
     my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);      my $metastring = 
           &LONCAPA::lonmetadata::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$filename);
     return undef if (! defined($metastring));      return undef if (! defined($metastring));
     my $parser=HTML::TokeParser->new(\$metastring);      my $parser=HTML::TokeParser->new(\$metastring);
     my $token;      my $token;
Line 332  sub metadata { Line 640  sub metadata {
             }              }
             foreach ( @{$token->[3]}) {              foreach ( @{$token->[3]}) {
                 $metacache{$uri.''.$unikey.'.'.$_}=$token->[2]->{$_};                  $metacache{$uri.''.$unikey.'.'.$_}=$token->[2]->{$_};
             }               }
             if (! ($metacache{$uri.''.$unikey}=$parser->get_text('/'.$entry))){              if (! ($metacache{$uri.''.$unikey}=$parser->get_text('/'.$entry))){
                 $metacache{$uri.''.$unikey} =                   $metacache{$uri.''.$unikey} = 
                     $metacache{$uri.''.$unikey.'.default'};                      $metacache{$uri.''.$unikey.'.default'};
Line 342  sub metadata { Line 650  sub metadata {
     return \%metacache;      return \%metacache;
 }  }
   
 ##  
 ## &getfile($filename)  
 ##   Slurps up an entire file into a scalar.    
 ##   Returns undef if the file does not exist  
 sub getfile {  
     my $file = shift();  
     if (! -e $file ) {   
         return undef;   
     }  
     my $fh=IO::File->new($file);  
     my $contents = '';  
     while (<$fh>) {   
         $contents .= $_;  
     }  
     return $contents;  
 }  
   
 ########################################################  ########################################################
 ########################################################  ########################################################
 ###                                                  ###  ###                                                  ###
Line 366  sub getfile { Line 657  sub getfile {
 ###                                                  ###  ###                                                  ###
 ########################################################  ########################################################
 ########################################################  ########################################################
 sub dynamicmeta {  ##
     my $url = &declutter(shift());  ## Dynamic metadata description (incomplete)
     $url =~ s/\.meta$//;  ##
     my %data = ('count'         => 0,  ## For a full description of all fields,
                 'course'        => 0,  ## see LONCAPA::lonmetadata
                 'course_list'   => '',  ##
                 'avetries'      => 'NULL',  ##   Field             Type
                 'avetries_list' => '',  ##-----------------------------------------------------------
                 'stdno'         => 0,  ##   count             integer
                 'stdno_list'    => '',  ##   course            integer
                 'usage'         => 0,  ##   course_list       comma separated list of course ids
                 'usage_list'    => '',  ##   avetries          real                                
                 'goto'          => 0,  ##   avetries_list     comma separated list of real numbers
                 'goto_list'     => '',  ##   stdno             real
                 'comefrom'      => 0,  ##   stdno_list        comma separated list of real numbers
                 'comefrom_list' => '',  ##   usage             integer   
                 'difficulty'    => 'NULL',  ##   usage_list        comma separated list of resources
                 'difficulty_list' => '',  ##   goto              scalar
                 'sequsage'      => '0',  ##   goto_list         comma separated list of resources
                 'sequsage_list' => '',  ##   comefrom          scalar
                 'clear'         => 'NULL',  ##   comefrom_list     comma separated list of resources
                 'technical'     => 'NULL',  ##   difficulty        real
                 'correct'       => 'NULL',  ##   difficulty_list   comma separated list of real numbers
                 'helpful'       => 'NULL',  ##   sequsage          scalar
                 'depth'         => 'NULL',  ##   sequsage_list     comma separated list of resources
                 'comments'      => '',                  ##   clear             real
                 );  ##   technical         real
     my ($dom,$auth)=($url=~/^(\w+)\/(\w+)\//);  ##   correct           real
     my $prodir=&propath($dom,$auth);  ##   helpful           real
   ##   depth             real
   ##   comments          html of all the comments made
   ##
   {
   
   my %DynamicData;
   my %Counts;
   
   sub process_dynamic_metadata {
       my ($user,$dom) = @_;
       undef(%DynamicData);
       undef(%Counts);
       #
       my $prodir = &propath($dom,$user);
     #      #
     # Get metadata except counts      # Read in the dynamic metadata
     my %evaldata;      my %evaldata;
     if (! tie(%evaldata,'GDBM_File',      if (! tie(%evaldata,'GDBM_File',
               $prodir.'/nohist_resevaldata.db',&GDBM_READER(),0640)) {                $prodir.'/nohist_resevaldata.db',&GDBM_READER(),0640)) {
         return (undef);          return 0;
     }  
     my %sum=();  
     my %count=();  
     my %concat=();  
     my %listitems=(  
                    'course'       => 'add',  
                    'goto'         => 'add',  
                    'comefrom'     => 'add',  
                    'avetries'     => 'average',  
                    'stdno'        => 'add',  
                    'difficulty'   => 'average',  
                    'clear'        => 'average',  
                    'technical'    => 'average',  
                    'helpful'      => 'average',  
                    'correct'      => 'average',  
                    'depth'        => 'average',  
                    'comments'     => 'append',  
                    'usage'        => 'count'  
                    );  
     #  
     my $regexp=$url;  
     $regexp=~s/(\W)/\\$1/g;  
     $regexp='___'.$regexp.'___([a-z]+)$';  
     while (my ($esckey,$value)=each %evaldata) {  
         my $key=&unescape($esckey);  
         if ($key=~/$regexp/) {  
             my ($item,$purl,$cat)=split(/___/,$key);  
             $count{$cat}++;  
             if ($listitems{$cat} ne 'append') {  
                 if (defined($sum{$cat})) {  
                     $sum{$cat}+=&unescape($value);  
                     $concat{$cat}.=','.$item;  
                 } else {  
                     $sum{$cat}=&unescape($value);  
                     $concat{$cat}=$item;  
                 }  
             } else {  
                 if (defined($sum{$cat})) {  
                     if ($evaldata{$esckey}=~/\w/) {  
                         $sum{$cat}.='<hr />'.&unescape($evaldata{$esckey});  
                     }  
                 } else {  
                     $sum{$cat}=''.&unescape($evaldata{$esckey});  
     }  
             }  
         }  
     }      }
       #
       %DynamicData = &LONCAPA::lonmetadata::process_reseval_data(\%evaldata);
     untie(%evaldata);      untie(%evaldata);
     # transfer gathered data to returnhash, calculate averages where applicable      $DynamicData{'domain'} = $dom;
     my %returnhash;      #print('user = '.$user.' domain = '.$dom.$/);
     while (my $cat=each(%count)) {  
         if ($count{$cat} eq 'nan') { next; }  
         if ($sum{$cat} eq 'nan') { next; }  
         if ($listitems{$cat} eq 'average') {  
             if ($count{$cat}) {  
                 $returnhash{$cat}=int(($sum{$cat}/$count{$cat})*100.0+0.5)/100.0;  
             } else {  
                 $returnhash{$cat}='NULL';  
             }  
         } elsif ($listitems{$cat} eq 'count') {  
             $returnhash{$cat}=$count{$cat};  
         } else {  
             $returnhash{$cat}=$sum{$cat};  
         }  
         $returnhash{$cat.'_list'}=$concat{$cat};  
     }  
     #      #
     # get count      # Read in the access count data
     if (tie(my %evaldata,'GDBM_File',      &log(7,'Reading access count data') if ($debug);
             $prodir.'/nohist_accesscount.db',&GDBM_READER(),0640)) {      my %countdata;
  my $escurl=&escape($url);      if (! tie(%countdata,'GDBM_File',
  if (! exists($evaldata{$escurl})) {                $prodir.'/nohist_accesscount.db',&GDBM_READER(),0640)) {
     $returnhash{'count'}=0;          return 0;
  } else {  
     $returnhash{'count'}=$evaldata{$escurl};  
  }  
  untie %evaldata;  
     }      }
     return %returnhash;      while (my ($key,$count) = each(%countdata)) {
           next if ($key !~ /^$dom/);
           $key = &unescape($key);
           &log(8,'    Count '.$key.' = '.$count) if ($debug);
           $Counts{$key}=$count;
       }
       untie(%countdata);
       if ($debug) {
           &log(7,scalar(keys(%Counts)).
                " Counts read for ".$user."@".$dom);
           &log(7,scalar(keys(%DynamicData)).
                " Dynamic metadata read for ".$user."@".$dom);
       }
       #
       return 1;
   }
   
   sub get_dynamic_metadata {
       my ($url) = @_;
       $url =~ s:^/res/::;
       my %data = &LONCAPA::lonmetadata::process_dynamic_metadata($url,
                                                                  \%DynamicData);
       # find the count
       $data{'count'} = $Counts{$url};
       #
       # Log the dynamic metadata
       if ($debug) {
           while (my($k,$v)=each(%data)) {
               &log(8,"    ".$k." => ".$v);
           }
       }
       return %data;
 }  }
   
   } # End of %DynamicData and %Counts scope
   
 ########################################################  ########################################################
 ########################################################  ########################################################
 ###                                                  ###  ###                                                  ###
Line 543  sub write_copyright_count { Line 817  sub write_copyright_count {
 ##   (copied from lond, modification of the return value)  ##   (copied from lond, modification of the return value)
 sub ishome {  sub ishome {
     my $author=shift;      my $author=shift;
     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;      $author=~s{/home/httpd/html/res/([^/]*)/([^/]*).*}{$1/$2};
     my ($udom,$uname)=split(/\//,$author);      my ($udom,$uname)=split(/\//,$author);
     my $proname=propath($udom,$uname);      my $proname=propath($udom,$uname);
     if (-e $proname) {      if (-e $proname) {
Line 554  sub ishome { Line 828  sub ishome {
 }  }
   
 ##  ##
 ## &propath($udom,$uname)  
 ##   Returns the path to the users LON-CAPA directory  
 ##   (copied from lond)  
 sub propath {  
     my ($udom,$uname)=@_;  
     $udom=~s/\W//g;  
     $uname=~s/\W//g;  
     my $subdir=$uname.'__';  
     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;  
     my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";  
     return $proname;  
 }   
   
 ##  
 ## &sqltime($timestamp)  
 ##  
 ## Convert perl $timestamp to MySQL time.  MySQL expects YYYY-MM-DD HH:MM:SS  
 ##  
 sub sqltime {  
     my ($time) = @_;  
     my $mysqltime;  
     if ($time =~   
         /(\d+)-(\d+)-(\d+) # YYYY-MM-DD  
         \s                 # a space  
         (\d+):(\d+):(\d+)  # HH:MM::SS  
         /x ) {   
         # Some of the .meta files have the time in mysql  
         # format already, so just make sure they are 0 padded and  
         # pass them back.  
         $mysqltime = sprintf('%04d-%02d-%02d %02d:%02d:%02d',  
                              $1,$2,$3,$4,$5,$6);  
     } elsif ($time =~ /^\d+$/) {  
         my @TimeData = gmtime($time);  
         # Alter the month to be 1-12 instead of 0-11  
         $TimeData[4]++;  
         # Alter the year to be from 0 instead of from 1900  
         $TimeData[5]+=1900;  
         $mysqltime = sprintf('%04d-%02d-%02d %02d:%02d:%02d',  
                              @TimeData[5,4,3,2,1,0]);  
     } else {  
         print LOG "    Unable to decode time ".$time."\n";  
         $mysqltime = 0;  
     }  
     return $mysqltime;  
 }  
   
 ##  
 ## &declutter($filename)  ## &declutter($filename)
 ##   Given a filename, returns a url for the filename.  ##   Given a filename, returns a url for the filename.
 sub declutter {  sub declutter {
     my $thisfn=shift;      my $thisfn=shift;
     $thisfn=~s/^$perlvar{'lonDocRoot'}//;      $thisfn=~s/^$Apache::lonnet::perlvar{'lonDocRoot'}//;
     $thisfn=~s/^\///;      $thisfn=~s/^\///;
     $thisfn=~s/^res\///;      $thisfn=~s/^res\///;
     return $thisfn;      return $thisfn;
 }  }
   
 ##  
 ## Escape / Unescape special characters  
 sub unescape {  
     my $str=shift;  
     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;  
     return $str;  
 }  
   
 sub escape {  
     my $str=shift;  
     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;  
     return $str;  
 }  

Removed from v.1.55  
changed lines
  Added in v.1.83


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