[BACK]Return to searchcat.pl CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / metadata_database

Diff for /loncom/metadata_database/searchcat.pl between versions 1.43 and 1.73

version 1.43, 2003/10/08 19:38:41 version 1.73, 2007/01/02 07:26:11
Line 56  This script also does general database m Line 56  This script also does general database m
 the C<loncapa:metadata> table if it is deprecated.  the C<loncapa:metadata> table if it is deprecated.
   
 This script evaluates dynamic metadata from the authors'  This script evaluates dynamic metadata from the authors'
 F<nohist_resevaldata.db> database file in order to store it in MySQL, as  F<nohist_resevaldata.db> database file in order to store it in MySQL.
 well as to compress the filesize (add up all "count"-type metadata).  
   
 This script is playing an increasingly important role for a loncapa  This script is playing an increasingly important role for a loncapa
 library server.  The proper operation of this script is critical for a smooth  library server.  The proper operation of this script is critical for a smooth
Line 65  and correct user experience. Line 64  and correct user experience.
   
 =cut  =cut
   
   use strict;
   use DBI;
 use lib '/home/httpd/lib/perl/';  use lib '/home/httpd/lib/perl/';
 use LONCAPA::Configuration;  use LONCAPA::lonmetadata;
   
   use Getopt::Long;
 use IO::File;  use IO::File;
 use HTML::TokeParser;  use HTML::TokeParser;
 use DBI;  
 use GDBM_File;  use GDBM_File;
 use POSIX qw(strftime mktime);  use POSIX qw(strftime mktime);
   
 my @metalist;  use Apache::lonnet();
   
 $simplestatus='';  use File::Find;
 my %countext=();  
   
 sub writesimple {  #
     open(SMP,'>/home/httpd/html/lon-status/mysql.txt');  # Set up configuration options
     print SMP $simplestatus."\n";  my ($simulate,$oneuser,$help,$verbose,$logfile,$debug);
     close(SMP);  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
   my %oldnames = (
                    'metadata'    => 'metadata',
                    'portfolio'   => 'portfolio_metadata',
                    'access'      => 'portfolio_access',
                    'addedfields' => 'portfolio_addedfields',
                  );
   
   my %newnames;
   # new table names -  append pid to have unique temporary tables
   foreach my $key (keys(%oldnames)) {
       $newnames{$key} = 'new'.$oldnames{$key}.$$;
 }  }
   
 sub writecount {  #
     open(RSMP,'>/home/httpd/html/lon-status/rescount.txt');  # Only run if machine is a library server
     foreach (keys %countext) {  exit if ($Apache::lonnet::perlvar{'lonRole'} ne 'library');
  print RSMP $_.'='.$countext{$_}.'&';  #
     }  #  Make sure this process is running from user=www
     print RSMP 'time='.time."\n";  my $wwwid=getpwnam('www');
     close(RSMP);  if ($wwwid!=$<) {
       my $emailto="$Apache::lonnet::perlvar{'lonAdmEMail'},$Apache::lonnet::perlvar{'lonSysEMail'}";
       my $subj="LON: $Apache::lonnet::perlvar{'lonHostID'} User ID mismatch";
       system("echo 'User ID mismatch. searchcat.pl must be run as user www.' |\
    mail -s '$subj' $emailto > /dev/null");
       exit 1;
 }  }
   #
   # Let people know we are running
   open(LOG,'>>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/logs/searchcat.log');
   &log(0,'==== Searchcat Run '.localtime()."====");
   
 sub count {  
     my $file=shift;  if ($debug) {
     $file=~/\.(\w+)$/;      &log(0,'simulating') if ($simulate);
     my $ext=lc($1);      &log(0,'only processing user '.$oneuser) if ($oneuser);
     if (defined($countext{$ext})) {      &log(0,'verbosity level = '.$verbose);
  $countext{$ext}++;  }
     } else {  #
  $countext{$ext}=1;  # Connect to database
   my $dbh;
   if (! ($dbh = DBI->connect("DBI:mysql:loncapa","www",$Apache::lonnet::perlvar{'lonSqlAccess'},
                             { RaiseError =>0,PrintError=>0}))) {
       &log(0,"Cannot connect to database!");
       die "MySQL Error: Cannot connect to database!\n";
   }
   # 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)
   foreach my $key (keys(%newnames)) {
       if ($newnames{$key} ne '') {
           $dbh->do('DROP TABLE IF EXISTS '.$newnames{$key});
     }      }
 }  }
 # ----------------------------------------------------- Un-Escape Special Chars  
   
 sub unescape {  #
     my $str=shift;  # Create the new metadata and portfolio tables
     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;  foreach my $key (keys(%newnames)) {
     return $str;      if ($newnames{$key} ne '') { 
           my $request =
                &LONCAPA::lonmetadata::create_metadata_storage($newnames{$key},$oldnames{$key});
           $dbh->do($request);
           if ($dbh->err) {
               $dbh->disconnect();
               &log(0,"MySQL Error Create: ".$dbh->errstr);
               die $dbh->errstr;
           }
       }
 }  }
   
 # -------------------------------------------------------- Escape Special Chars  #
   # find out which users we need to examine
 sub escape {  my @domains = sort(&Apache::lonnet::current_machine_domains());
     my $str=shift;  &log(9,'domains ="'.join('","',@domains).'"');
     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;  
     return $str;  foreach my $dom (@domains) {
       &log(9,'domain = '.$dom);
       opendir(RESOURCES,"$Apache::lonnet::perlvar{'lonDocRoot'}/res/$dom");
       my @homeusers = 
           grep {
               &ishome("$Apache::lonnet::perlvar{'lonDocRoot'}/res/$dom/$_");
           } grep { 
               !/^\.\.?$/;
           } readdir(RESOURCES);
       closedir RESOURCES;
       &log(5,'users = '.$dom.':'.join(',',@homeusers));
       #
       if ($oneuser) {
           @homeusers=($oneuser);
       }
       #
       # Loop through the users
       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 public portfolio files
       my %portusers;
       if ($oneuser) {
           %portusers = (
                           $oneuser => '',
                          );
       } else {
           my $dir = $Apache::lonnet::perlvar{lonUsersDir}.'/'.$dom;
           &descend_tree($dir,0,\%portusers);
       }
       foreach my $uname (keys(%portusers)) {
           my $urlstart = '/uploaded/'.$dom.'/'.$uname;
           my $pathstart = &propath($dom,$uname).'/userfiles';
           my $is_course = &Apache::lonnet::is_course($dom,$uname);
           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') {
                   &process_portfolio_access_data($url,$access{$file});
               }
               &process_portfolio_metadata($url,$fullpath,$is_course,$dom,
                                           $uname,$group);
           }
       }
 }  }
   
   #
 # ------------------------------------------- Code to evaluate dynamic metadata  # Rename the tables
   if (! $simulate) {
 sub dynamicmeta {      foreach my $key (keys(%oldnames)) {
           if (($oldnames{$key} ne '') && ($newnames{$key} ne '')) {
     my $url=&declutter(shift);              $dbh->do('DROP TABLE IF EXISTS '.$oldnames{$key});
     $url=~s/\.meta$//;              if (! $dbh->do('RENAME TABLE '.$newnames{$key}.' TO '.$oldnames{$key})) {
     my %returnhash=();                  &log(0,"MySQL Error Rename: ".$dbh->errstr);
     my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);                  die $dbh->errstr;
     my $prodir=&propath($adomain,$aauthor);  
     if ((tie(%evaldata,'GDBM_File',  
             $prodir.'/nohist_resevaldata.db',&GDBM_READER(),0640)) &&  
         (tie(%newevaldata,'GDBM_File',  
             $prodir.'/nohist_new_resevaldata.db',&GDBM_WRCREAT(),0640))) {  
        my %sum=();  
        my %cnt=();  
        my %listitems=('count'        => 'add',  
                       'course'       => 'add',  
       'goto'         => 'add',  
       'comefrom'     => 'add',  
                       'avetries'     => 'avg',  
                       'stdno'        => 'add',  
                       'difficulty'   => 'avg',  
                       'clear'        => 'avg',  
                       'technical'    => 'avg',  
                       'helpful'      => 'avg',  
                       'correct'      => 'avg',  
                       'depth'        => 'avg',  
                       'comments'     => 'app',  
                       'usage'        => 'cnt'  
                       );  
        my $regexp=$url;  
        $regexp=~s/(\W)/\\$1/g;  
        $regexp='___'.$regexp.'___([a-z]+)$';  
        while (my ($esckey,$value)=each %evaldata) {  
  $key=&unescape($esckey);  
  if ($key=~/$regexp/) {  
     my $ctype=$1;  
             if (defined($cnt{$ctype})) {   
                $cnt{$ctype}++;   
             } else {   
                $cnt{$ctype}=1;   
             }  
             unless ($listitems{$ctype} eq 'app') {  
                if (defined($sum{$ctype})) {  
                   $sum{$ctype}+=$value;  
           } else {  
                   $sum{$ctype}=$value;  
        }  
             } else {              } else {
                if (defined($sum{$ctype})) {                  &log(1,"MySQL table rename successful for $key.");
                   if ($value) {              }
                      $sum{$ctype}.='<hr>'.$value;          }
           }      }
         } else {  }
              $sum{$ctype}=''.$value;  if (! $dbh->disconnect) {
        }      &log(0,"MySQL Error Disconnect: ".$dbh->errstr);
     }      die $dbh->errstr;
     if ($ctype ne 'count') {  }
        $newevaldata{$esckey}=$value;  ##
    }  ## Finished!
  }  &log(0,"==== Searchcat completed ".localtime()." ====");
       }  close(LOG);
       foreach (keys %cnt) {  
          if ($listitems{$_} eq 'avg') {  
      $returnhash{$_}=int(($sum{$_}/$cnt{$_})*100.0+0.5)/100.0;  
          } elsif ($listitems{$_} eq 'cnt') {  
              $returnhash{$_}=$cnt{$_};  
          } else {  
              $returnhash{$_}=$sum{$_};  
          }  
      }  
      if ($returnhash{'count'}) {  
          my $newkey=$$.'_'.time.'_searchcat___'.&escape($url).'___count';  
          $newevaldata{$newkey}=$returnhash{'count'};  
      }  
      untie(%evaldata);  
      untie(%newevaldata);  
    }  
    return %returnhash;  
 }  
     
 # ----------------- Code to enable 'find' subroutine listing of the .meta files  
 require "find.pl";  
 sub wanted {  
     (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&  
         -f _ &&  
         /^.*\.meta$/ && !/^.+\.\d+\.[^\.]+\.meta$/ &&  
         push(@metalist,"$dir/$_");  
 }  
   
 # ---------------  Read loncapa_apache.conf and loncapa.conf and get variables  
 my $perlvarref=LONCAPA::Configuration::read_conf('loncapa.conf');  
 my %perlvar=%{$perlvarref};  
 undef $perlvarref; # remove since sensitive and not needed  
 delete $perlvar{'lonReceipt'}; # remove since sensitive and not needed  
   
 # ------------------------------------- Only run if machine is a library server  &write_type_count();
 exit unless $perlvar{'lonRole'} eq 'library';  &write_copyright_count();
   
 # ----------------------------- Make sure this process is running from user=www  exit 0;
   
 my $wwwid=getpwnam('www');  ##
 if ($wwwid!=$<) {  ## Status logging routine.  Inputs: $level, $message
     $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";  ## 
     $subj="LON: $perlvar{'lonHostID'} User ID mismatch";  ## $level 0 should be used for normal output and error messages
     system("echo 'User ID mismatch. searchcat.pl must be run as user www.' |\  ##
  mailto $emailto -s '$subj' > /dev/null");  ## $message does not need to end with \n.  In the case of errors
     exit 1;  ## 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 descend_tree {
       my ($dir,$depth,$alldomusers) = @_;
       if (-d $dir) {
           opendir(DIR,$dir);
           my @contents = grep(!/^\./,readdir(DIR));
           closedir(DIR);
           $depth ++;
           foreach my $item (@contents) {
               if ($depth < 4) {
                   &descend_tree($dir.'/'.$item,$depth,$alldomusers);
               } else {
                   if (-e $dir.'/'.$item.'/file_permissions.db') {
                    
                       $$alldomusers{$item} = '';
                   }
               }       
           }
       } 
   }
   
 # ---------------------------------------------------------- We are in business  sub process_portfolio_access_data {
       my ($url,$access_hash) = @_;
       foreach my $key (keys(%{$access_hash})) {
           my $acc_data;
           $acc_data->{url} = $url;
           $acc_data->{keynum} = $key;
           my ($num,$scope,$end,$start) =
                           ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
           next if (($scope ne 'public') && ($scope ne 'guest'));
           $acc_data->{scope} = $scope;
           if ($end != 0) {
               $acc_data->{end} = &LONCAPA::lonmetadata::sqltime($end);
           }
           $acc_data->{start} = &LONCAPA::lonmetadata::sqltime($start);
           if (! $simulate) {
               my ($count,$err) =
                 &LONCAPA::lonmetadata::store_metadata($dbh,
                                                   $newnames{'access'},
                                                   'portfolio_access',$acc_data);
               if ($err) {
                   &log(0,"MySQL Error Insert: ".$err);
               }
               if ($count < 1) {
                   &log(0,"Unable to insert record into MySQL database for $url");
               }
           }
       }
   }
   
 open(LOG,'>'.$perlvar{'lonDaemons'}.'/logs/searchcat.log');  sub process_portfolio_metadata {
 print LOG '==== Searchcat Run '.localtime()."====\n\n";      my ($url,$fullpath,$is_course,$dom,$uname,$group) = @_;
 $simplestatus='time='.time.'&';      my ($ref,$crs,$addedfields) = &portfolio_metadata($fullpath,$dom,$uname,
 my $dbh;                                                        $group);
 # ------------------------------------- Make sure that database can be accessed      &getfiledates($ref,$fullpath);
 {      if ($is_course) {
     unless (          $ref->{'groupname'} = $group;
     $dbh = DBI->connect("DBI:mysql:loncapa","www",$perlvar{'lonSqlAccess'},{ RaiseError =>0,PrintError=>0})      }
     ) {       my %Data;
  print LOG "Cannot connect to database!\n";      if (ref($ref) eq 'HASH') {
  $simplestatus.='mysql=defunct';          %Data = %{$ref};
  &writesimple();      }
  exit;      %Data = (
     }               %Data,
                'url'=>$url,
     my $make_metadata_table = "CREATE TABLE IF NOT EXISTS metadata (".               'version'=>'current',
         "title TEXT, author TEXT, subject TEXT, url TEXT, keywords TEXT, ".      );
         "version TEXT, notes TEXT, abstract TEXT, mime TEXT, language TEXT, ".      if (! $simulate) {
         "creationdate DATETIME, lastrevisiondate DATETIME, owner TEXT, ".          my ($count,$err) =
         "copyright TEXT, FULLTEXT idx_title (title), ".           &LONCAPA::lonmetadata::store_metadata($dbh,
         "FULLTEXT idx_author (author), FULLTEXT idx_subject (subject), ".                                                 $newnames{'portfolio'},
         "FULLTEXT idx_url (url), FULLTEXT idx_keywords (keywords), ".                                                 'portfolio_metadata',\%Data);
         "FULLTEXT idx_version (version), FULLTEXT idx_notes (notes), ".          if ($err) {
         "FULLTEXT idx_abstract (abstract), FULLTEXT idx_mime (mime), ".              &log(0,"MySQL Error Insert: ".$err);
         "FULLTEXT idx_language (language), FULLTEXT idx_owner (owner), ".          }
         "FULLTEXT idx_copyright (copyright)) TYPE=MYISAM";          if ($count < 1) {
     # It would sure be nice to have some logging mechanism.              &log(0,"Unable to insert record into MySQL portfolio_metadata database table for $url");
     $dbh->do($make_metadata_table);          }
 }          if (ref($addedfields) eq 'HASH') {
               if (keys(%{$addedfields}) > 0) {
 # ------------------------------------------------------------- get .meta files                  foreach my $key (keys(%{$addedfields})) {
 opendir(RESOURCES,"$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}");                      my $added_data = {
 my @homeusers = grep {                                  'url'   => $url,
     &ishome("$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}/$_")                                  'field' => $key,
     } grep {!/^\.\.?$/} readdir(RESOURCES);                                  'value' => $addedfields->{$key},
 closedir RESOURCES;                                  'courserestricted' => $crs,
                       };
                       ($count,$err) = &LONCAPA::lonmetadata::store_metadata($dbh,
                                               $newnames{'addedfields'},
                                               'portfolio_addedfields',
                                               $added_data);
                       if ($err) {
                           &log(0,"MySQL Error Insert: ".$err);
                       }
                       if ($count < 1) {
                           &log(0,"Unable to insert record into MySQL portfolio_addedfields database table for url = $url and field = $key");
                       }
                   }
               }
           }
       }
       return;
   }
   
 #  ########################################################
 # Create the statement handlers we need  ########################################################
 my $delete_sth = $dbh->prepare  ###                                                  ###
     ("DELETE FROM metadata WHERE url LIKE BINARY ?");  ###          File::Find support routines             ###
   ###                                                  ###
 my $insert_sth = $dbh->prepare  ########################################################
     ("INSERT INTO metadata VALUES (".  ########################################################
      "?,".   # title  ##
      "?,".   # author  ## &only_meta_files
      "?,".   # subject  ##
      "?,".   # m2???  ## Called by File::Find.
      "?,".   # version  ## Takes a list of files/directories in and returns a list of files/directories
      "?,".   # current  ## to search.
      "?,".   # notes  sub only_meta_files {
      "?,".   # abstract      my @PossibleFiles = @_;
      "?,".   # mime      my @ChosenFiles;
      "?,".   # language      foreach my $file (@PossibleFiles) {
      "?,".   # creationdate          if ( ($file =~ /\.meta$/ &&            # Ends in meta
      "?,".   # revisiondate                $file !~ /\.\d+\.[^\.]+\.meta$/  # is not for a prior version
      "?,".   # owner               ) || (-d $File::Find::dir."/".$file )) { # directories are okay
      "?)"    # copyright                   # but we do not want /. or /..
      );              push(@ChosenFiles,$file);
           }
 foreach my $user (@homeusers) {      }
     print LOG "\n=== User: ".$user."\n\n";      return @ChosenFiles;
     # Remove left-over db-files from potentially crashed searchcat run  }
     my $prodir=&propath($perlvar{'lonDefDomain'},$user);  
     unlink($prodir.'/nohist_new_resevaldata.db');  
     # Use find.pl  
     undef @metalist;  
     @metalist=();  
     &find("$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}/$user");  
     # -- process each file to get metadata and put into search catalog SQL  
     # database.  Also, check to see if already there.  
     # I could just delete (without searching first), but this works for now.  
     foreach my $m (@metalist) {  
         print LOG "- ".$m."\n";  
         my $ref=&metadata($m);  
         my $m2='/res/'.&declutter($m);  
         $m2=~s/\.meta$//;  
         &dynamicmeta($m2);  
   if ($ref->{'obsolete'}) { print LOG "obsolete\n"; next; }  
  if ($ref->{'copyright'} eq 'private') { print LOG "private\n"; next; }  
  &count($m2);  
         $delete_sth->execute($m2);  
         $insert_sth->execute($ref->{'title'},  
                              $ref->{'author'},  
                              $ref->{'subject'},  
                              $m2,  
                              $ref->{'keywords'},  
                              'current',  
                              $ref->{'notes'},  
                              $ref->{'abstract'},  
                              $ref->{'mime'},  
                              $ref->{'language'},  
                              sqltime($ref->{'creationdate'}),  
                              sqltime($ref->{'lastrevisiondate'}),  
                              $ref->{'owner'},  
                              $ref->{'copyright'});  
 #        if ($dbh->err()) {  
 #            print STDERR "Error:".$dbh->errstr()."\n";  
 #        }  
         $ref = undef;  
     }  
       
     # --------------------------------------------------- Clean up database  
     # Need to, perhaps, remove stale SQL database records.  
     # ... not yet implemented  
           
     # ------------------------------------------- Copy over the new db-files  
     #  
   
     system('mv '.$prodir.'/nohist_new_resevaldata.db '.  
    $prodir.'/nohist_resevaldata.db');  
   
 }  
 # --------------------------------------------------- Close database connection  
 $dbh->disconnect;  
 print LOG "\n==== Searchcat completed ".localtime()." ====\n";  
 close(LOG);  
 &writesimple();  
 &writecount();  
 exit 0;  
   
   ##
   ##
   ## Debugging routines, use these for 'wanted' in the File::Find call
   ##
   sub print_filename {
       my ($file) = $_;
       my $fullfilename = $File::Find::name;
       if ($debug) {
           if (-d $file) {
               &log(5," Got directory ".$fullfilename);
           } else {
               &log(5," Got file ".$fullfilename);
           }
       }
       $_=$file;
   }
   
   sub log_metadata {
       my ($file) = $_;
       my $fullfilename = $File::Find::name;
       return if (-d $fullfilename); # No need to do anything here for directories
       if ($debug) {
           &log(6,$fullfilename);
           my $ref = &metadata($fullfilename);
           if (! defined($ref)) {
               &log(6,"    No data");
               return;
           }
           while (my($key,$value) = each(%$ref)) {
               &log(6,"    ".$key." => ".$value);
           }
           &count_copyright($ref->{'copyright'});
       }
       $_=$file;
   }
   
 # =============================================================================  ##
   ## process_meta_file
   ##   Called by File::Find. 
   ##   Only input is the filename in $_.  
   sub process_meta_file {
       my ($file) = $_;
       my $filename = $File::Find::name; # full filename
       return if (-d $filename); # No need to do anything here for directories
       #
       &log(3,$filename) if ($debug);
       #
       my $ref = &metadata($filename);
       #
       # $url is the original file url, not the metadata file
       my $target = $filename;
       $target =~ s/\.meta$//;
       my $url='/res/'.&declutter($target);
       &log(3,"    ".$url) if ($debug);
       #
       # Ignore some files based on their metadata
       if ($ref->{'obsolete'}) { 
           &log(3,"obsolete") if ($debug);
           return; 
       }
       &count_copyright($ref->{'copyright'});
       if ($ref->{'copyright'} eq 'private') { 
           &log(3,"private") if ($debug);
           return; 
       }
       #
       # Find the dynamic metadata
       my %dyn;
       if ($url=~ m:/default$:) {
           $url=~ s:/default$:/:;
           &log(3,"Skipping dynamic data") if ($debug);
       } else {
           &log(3,"Retrieving dynamic data") if ($debug);
           %dyn=&get_dynamic_metadata($url);
           &count_type($url);
       }
       &getfiledates($ref,$target);
       #
       my %Data = (
                   %$ref,
                   %dyn,
                   'url'=>$url,
                   'version'=>'current');
       if (! $simulate) {
           my ($count,$err) = 
             &LONCAPA::lonmetadata::store_metadata($dbh,$newnames{'metadata'},
                                                   'metadata',\%Data);
           if ($err) {
               &log(0,"MySQL Error Insert: ".$err);
           }
           if ($count < 1) {
               &log(0,"Unable to insert record into MySQL database for $url");
           }
       }
       #
       # Reset $_ before leaving
       $_ = $file;
   }
   
 # ---------------------------------------------------------------- Get metadata  ########################################################
 # significantly altered from subroutine present in lonnet  ########################################################
   ###                                                  ###
   ###  &metadata($uri)                                 ###
   ###   Retrieve metadata for the given file           ###
   ###                                                  ###
   ########################################################
   ########################################################
 sub metadata {  sub metadata {
     my ($uri,$what)=@_;      my ($uri) = @_;
     my %metacache;      my %metacache=();
     $uri=&declutter($uri);      $uri=&declutter($uri);
     my $filename=$uri;      my $filename=$uri;
     $uri=~s/\.meta$//;      $uri=~s/\.meta$//;
     $uri='';      $uri='';
     unless ($metacache{$uri.'keys'}) {      if ($filename !~ /\.meta$/) { 
         unless ($filename=~/\.meta$/) { $filename.='.meta'; }          $filename.='.meta';
  my $metastring=&getfile($perlvar{'lonDocRoot'}.'/res/'.$filename);      }
       my $metastring=&getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$filename);
       return undef if (! defined($metastring));
       my $parser=HTML::TokeParser->new(\$metastring);
       my $token;
       while ($token=$parser->get_token) {
           if ($token->[0] eq 'S') {
               my $entry=$token->[1];
               my $unikey=$entry;
               if (defined($token->[2]->{'part'})) { 
                   $unikey.='_'.$token->[2]->{'part'}; 
               }
               if (defined($token->[2]->{'name'})) { 
                   $unikey.='_'.$token->[2]->{'name'}; 
               }
               if ($metacache{$uri.'keys'}) {
                   $metacache{$uri.'keys'}.=','.$unikey;
               } else {
                   $metacache{$uri.'keys'}=$unikey;
               }
               foreach ( @{$token->[3]}) {
                   $metacache{$uri.''.$unikey.'.'.$_}=$token->[2]->{$_};
               }
               if (! ($metacache{$uri.''.$unikey}=$parser->get_text('/'.$entry))){
                   $metacache{$uri.''.$unikey} = 
                       $metacache{$uri.''.$unikey.'.default'};
               }
           } # End of ($token->[0] eq 'S')
       }
       return \%metacache;
   }
   
   ###############################################################
   ###############################################################
   ###                                                         ###
   ###  &portfolio_metadata($filepath,$dom,$uname,$group) ###
   ###   Retrieve metadata for the given file                  ###
   ###   Returns array -                                       ###
   ###      contains reference to metadatahash and             ###
   ###         optional reference to addedfields hash          ###
   ###                                                         ###
   ###############################################################
   ###############################################################
   sub portfolio_metadata {
       my ($fullpath,$dom,$uname,$group)=@_;
       my ($mime) = ( $fullpath=~/\.(\w+)$/ );
       my %metacache=();
       if ($fullpath !~ /\.meta$/) {
           $fullpath .= '.meta';
       }
       my (@standard_fields,%addedfields);
       my $colsref = 
          $LONCAPA::lonmetadata::Portfolio_metadata_table_description;
       if (ref($colsref) eq 'ARRAY') {
           my @columns = @{$colsref};
           foreach my $coldata (@columns) {
               push(@standard_fields,$coldata->{'name'});
           }
       }
       my $metastring=&getfile($fullpath);
       if (! defined($metastring)) {
           $metacache{'keys'}= 'owner,domain,mime';
           $metacache{'owner'} = $uname.':'.$dom;
           $metacache{'domain'} = $dom;
           $metacache{'mime'} = $mime;
           if (defined($group)) {
               $metacache{'keys'} .= ',courserestricted';
               $metacache{'courserestricted'} = 'course.'.$dom.'_'.$uname;
           } 
       } else {
         my $parser=HTML::TokeParser->new(\$metastring);          my $parser=HTML::TokeParser->new(\$metastring);
         my $token;          my $token;
         while ($token=$parser->get_token) {          while ($token=$parser->get_token) {
             if ($token->[0] eq 'S') {              if ($token->[0] eq 'S') {
                 my $entry=$token->[1];                  my $entry=$token->[1];
                 my $unikey=$entry;                  if ($metacache{'keys'}) {
                 if (defined($token->[2]->{'part'})) {                       $metacache{'keys'}.=','.$entry;
                     $unikey.='_'.$token->[2]->{'part'};   
                 }  
                 if (defined($token->[2]->{'name'})) {   
                     $unikey.='_'.$token->[2]->{'name'};   
                 }  
                 if ($metacache{$uri.'keys'}) {  
                     $metacache{$uri.'keys'}.=','.$unikey;  
                 } else {                  } else {
                     $metacache{$uri.'keys'}=$unikey;                      $metacache{'keys'}=$entry;
                 }                  }
                 map {                  my $value = $parser->get_text('/'.$entry);
                     $metacache{$uri.''.$unikey.'.'.$_}=$token->[2]->{$_};                  if (!grep(/^\Q$entry\E$/,@standard_fields)) {
                 } @{$token->[3]};                      my $clean_value = lc($value);
                 unless (                      $clean_value =~ s/\s/_/g;
                         $metacache{$uri.''.$unikey}=$parser->get_text('/'.$entry)                      if ($clean_value ne $entry) {
                         ) { $metacache{$uri.''.$unikey}=                          if (defined($addedfields{$entry})) {
                                 $metacache{$uri.''.$unikey.'.default'};                              $addedfields{$entry} .=','.$value;
                           } else {
                               $addedfields{$entry} = $value;
                         }                          }
                       }
                   } else {
                       $metacache{$entry} = $value;
                   }
             }              }
           } # End of ($token->[0] eq 'S')
       }
       if (keys(%addedfields) > 0) {
           foreach my $key (sort keys(%addedfields)) {
               $metacache{'addedfieldnames'} .= $key.',';
               $metacache{'addedfieldvalues'} .= $addedfields{$key}.'&&&';
           }
           $metacache{'addedfieldnames'} =~ s/,$//;
           $metacache{'addedfieldvalues'} =~ s/\&\&\&$//;
           if ($metacache{'keys'}) {
               $metacache{'keys'}.=',addedfieldnames';
           } else {
               $metacache{'keys'}='addedfieldnames';
         }          }
           $metacache{'keys'}.=',addedfieldvalues';
     }      }
     return \%metacache;      return (\%metacache,$metacache{'courserestricted'},\%addedfields);
 }  }
   
 # ------------------------------------------------------------ Serves up a file  ##
 # returns either the contents of the file or a -1  ## &getfile($filename)
   ##   Slurps up an entire file into a scalar.  
   ##   Returns undef if the file does not exist
 sub getfile {  sub getfile {
     my $file=shift;      my $file = shift();
     if (! -e $file ) { return -1; };      if (! -e $file ) { 
           return undef; 
       }
     my $fh=IO::File->new($file);      my $fh=IO::File->new($file);
     my $a='';      my $contents = '';
     while (<$fh>) { $a .=$_; }      while (<$fh>) { 
     return $a;          $contents .= $_;
       }
       return $contents;
 }  }
   
 # ------------------------------------------------------------- Declutters URLs  ##
 sub declutter {  ## &getfiledates() 
     my $thisfn=shift;  ## Converts creationdate and modifieddates to SQL format 
     $thisfn=~s/^$perlvar{'lonDocRoot'}//;  ## Applies stat() to file to retrieve dates if missing
     $thisfn=~s/^\///;  sub getfiledates {
     $thisfn=~s/^res\///;      my ($ref,$target) = @_;
     return $thisfn;      if (! defined($ref->{'creationdate'}) ||
           $ref->{'creationdate'} =~ /^\s*$/) {
           $ref->{'creationdate'} = (stat($target))[9];
       }
       if (! defined($ref->{'lastrevisiondate'}) ||
           $ref->{'lastrevisiondate'} =~ /^\s*$/) {
           $ref->{'lastrevisiondate'} = (stat($target))[9];
       }
       $ref->{'creationdate'}     = 
           &LONCAPA::lonmetadata::sqltime($ref->{'creationdate'});
       $ref->{'lastrevisiondate'} = 
           &LONCAPA::lonmetadata::sqltime($ref->{'lastrevisiondate'});
   }
   
   ########################################################
   ########################################################
   ###                                                  ###
   ###    Dynamic Metadata                              ###
   ###                                                  ###
   ########################################################
   ########################################################
   ##
   ## Dynamic metadata description (incomplete)
   ##
   ## For a full description of all fields,
   ## see LONCAPA::lonmetadata
   ##
   ##   Field             Type
   ##-----------------------------------------------------------
   ##   count             integer
   ##   course            integer
   ##   course_list       comma separated list of course ids
   ##   avetries          real                                
   ##   avetries_list     comma separated list of real numbers
   ##   stdno             real
   ##   stdno_list        comma separated list of real numbers
   ##   usage             integer   
   ##   usage_list        comma separated list of resources
   ##   goto              scalar
   ##   goto_list         comma separated list of resources
   ##   comefrom          scalar
   ##   comefrom_list     comma separated list of resources
   ##   difficulty        real
   ##   difficulty_list   comma separated list of real numbers
   ##   sequsage          scalar
   ##   sequsage_list     comma separated list of resources
   ##   clear             real
   ##   technical         real
   ##   correct           real
   ##   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);
       #
       # Read in the dynamic metadata
       my %evaldata;
       if (! tie(%evaldata,'GDBM_File',
                 $prodir.'/nohist_resevaldata.db',&GDBM_READER(),0640)) {
           return 0;
       }
       #
       %DynamicData = &LONCAPA::lonmetadata::process_reseval_data(\%evaldata);
       untie(%evaldata);
       $DynamicData{'domain'} = $dom;
       #print('user = '.$user.' domain = '.$dom.$/);
       #
       # Read in the access count data
       &log(7,'Reading access count data') if ($debug);
       my %countdata;
       if (! tie(%countdata,'GDBM_File',
                 $prodir.'/nohist_accesscount.db',&GDBM_READER(),0640)) {
           return 0;
       }
       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;
 }  }
   
 # --------------------------------------- Is this the home server of an author?  sub get_dynamic_metadata {
 # (copied from lond, modification of the return value)      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
   
   ########################################################
   ########################################################
   ###                                                  ###
   ###   Counts                                         ###
   ###                                                  ###
   ########################################################
   ########################################################
   {
   
   my %countext;
   
   sub count_type {
       my $file=shift;
       $file=~/\.(\w+)$/;
       my $ext=lc($1);
       $countext{$ext}++;
   }
   
   sub write_type_count {
       open(RESCOUNT,'>/home/httpd/html/lon-status/rescount.txt');
       while (my ($extension,$count) = each(%countext)) {
    print RESCOUNT $extension.'='.$count.'&';
       }
       print RESCOUNT 'time='.time."\n";
       close(RESCOUNT);
   }
   
   } # end of scope for %countext
   
   {
   
   my %copyrights;
   
   sub count_copyright {
       $copyrights{@_[0]}++;
   }
   
   sub write_copyright_count {
       open(COPYCOUNT,'>/home/httpd/html/lon-status/copyrightcount.txt');
       while (my ($copyright,$count) = each(%copyrights)) {
    print COPYCOUNT $copyright.'='.$count.'&';
       }
       print COPYCOUNT 'time='.time."\n";
       close(COPYCOUNT);
   }
   
   } # end of scope for %copyrights
   
   ########################################################
   ########################################################
   ###                                                  ###
   ###   Miscellanous Utility Routines                  ###
   ###                                                  ###
   ########################################################
   ########################################################
   ##
   ## &ishome($username)
   ##   Returns 1 if $username is a LON-CAPA author, 0 otherwise
   ##   (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/;
Line 436  sub ishome { Line 876  sub ishome {
     }      }
 }  }
   
 # -------------------------------------------- Return path to profile directory  ##
 # (copied from lond)  ## &propath($udom,$uname)
   ##   Returns the path to the users LON-CAPA directory
   ##   (copied from lond)
 sub propath {  sub propath {
     my ($udom,$uname)=@_;      my ($udom,$uname)=@_;
     $udom=~s/\W//g;      $udom=~s/\W//g;
     $uname=~s/\W//g;      $uname=~s/\W//g;
     my $subdir=$uname.'__';      my $subdir=$uname.'__';
     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;      $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
     my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";      my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
     return $proname;      return $proname;
 }   } 
   
 # ---------------------------- convert 'time' format into a datetime sql format  ##
 sub sqltime {  ## &declutter($filename)
     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =  ##   Given a filename, returns a url for the filename.
  localtime(&unsqltime(@_[0]));  sub declutter {
     $mon++; $year+=1900;      my $thisfn=shift;
     return "$year-$mon-$mday $hour:$min:$sec";      $thisfn=~s/^$Apache::lonnet::perlvar{'lonDocRoot'}//;
       $thisfn=~s/^\///;
       $thisfn=~s/^res\///;
       return $thisfn;
 }  }
   
 sub maketime {  ##
     my %th=@_;  ## Escape / Unescape special characters
     return POSIX::mktime(($th{'seconds'},$th{'minutes'},$th{'hours'},  sub unescape {
                           $th{'day'},$th{'month'}-1,      my $str=shift;
                           $th{'year'}-1900,0,0,$th{'dlsav'}));      $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;
 # Retro-fixing of un-backward-compatible time format      return $str;
   
 sub unsqltime {  
     my $timestamp=shift;  
     if ($timestamp=~/^(\d+)\-(\d+)\-(\d+)\s+(\d+)\:(\d+)\:(\d+)$/) {  
         $timestamp=&maketime('year'=>$1,'month'=>$2,'day'=>$3,  
                              'hours'=>$4,'minutes'=>$5,'seconds'=>$6);  
     }  
     return $timestamp;  
 }  }
   
Removed from v.1.43  
changed lines
  Added in v.1.73

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