Annotation of loncom/metadata_database/searchcat.pl, revision 1.78

1.1       harris41    1: #!/usr/bin/perl
                      2: # The LearningOnline Network
                      3: # searchcat.pl "Search Catalog" batch script
1.16      harris41    4: #
1.78    ! raeburn     5: # $Id: searchcat.pl,v 1.77 2007/07/25 23:17:43 raeburn Exp $
1.16      harris41    6: #
                      7: # Copyright Michigan State University Board of Trustees
                      8: #
1.29      albertel    9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
1.16      harris41   10: #
1.29      albertel   11: # LON-CAPA is free software; you can redistribute it and/or modify
1.16      harris41   12: # it under the terms of the GNU General Public License as published by
                     13: # the Free Software Foundation; either version 2 of the License, or
                     14: # (at your option) any later version.
                     15: #
1.29      albertel   16: # LON-CAPA is distributed in the hope that it will be useful,
1.16      harris41   17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     19: # GNU General Public License for more details.
                     20: #
                     21: # You should have received a copy of the GNU General Public License
1.29      albertel   22: # along with LON-CAPA; if not, write to the Free Software
1.16      harris41   23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     24: #
                     25: # /home/httpd/html/adm/gpl.txt
                     26: #
1.29      albertel   27: # http://www.lon-capa.org/
1.16      harris41   28: #
                     29: ###
1.33      matthew    30: 
1.32      www        31: =pod
1.1       harris41   32: 
1.32      www        33: =head1 NAME
                     34: 
                     35: B<searchcat.pl> - put authoritative filesystem data into sql database.
                     36: 
                     37: =head1 SYNOPSIS
                     38: 
                     39: Ordinarily this script is to be called from a loncapa cron job
                     40: (CVS source location: F<loncapa/loncom/cron/loncapa>; typical
                     41: filesystem installation location: F</etc/cron.d/loncapa>).
                     42: 
                     43: Here is the cron job entry.
                     44: 
                     45: C<# Repopulate and refresh the metadata database used for the search catalog.>
                     46: C<10 1 * * 7    www    /home/httpd/perl/searchcat.pl>
                     47: 
                     48: This script only allows itself to be run as the user C<www>.
                     49: 
                     50: =head1 DESCRIPTION
                     51: 
                     52: This script goes through a loncapa resource directory and gathers metadata.
                     53: The metadata is entered into a SQL database.
                     54: 
                     55: This script also does general database maintenance such as reformatting
                     56: the C<loncapa:metadata> table if it is deprecated.
                     57: 
                     58: This script evaluates dynamic metadata from the authors'
1.48      www        59: F<nohist_resevaldata.db> database file in order to store it in MySQL.
1.32      www        60: 
                     61: This script is playing an increasingly important role for a loncapa
                     62: library server.  The proper operation of this script is critical for a smooth
                     63: and correct user experience.
                     64: 
                     65: =cut
1.1       harris41   66: 
1.45      www        67: use strict;
1.55      matthew    68: use DBI;
1.17      harris41   69: use lib '/home/httpd/lib/perl/';
1.55      matthew    70: use LONCAPA::lonmetadata;
1.76      albertel   71: use LONCAPA;
1.56      matthew    72: use Getopt::Long;
1.1       harris41   73: use IO::File;
                     74: use HTML::TokeParser;
1.21      www        75: use GDBM_File;
1.24      www        76: use POSIX qw(strftime mktime);
1.56      matthew    77: 
1.63      matthew    78: use Apache::lonnet();
1.62      matthew    79: 
1.55      matthew    80: use File::Find;
1.1       harris41   81: 
1.56      matthew    82: #
                     83: # Set up configuration options
1.63      matthew    84: my ($simulate,$oneuser,$help,$verbose,$logfile,$debug);
1.56      matthew    85: GetOptions (
                     86:             'help'     => \$help,
                     87:             'simulate' => \$simulate,
                     88:             'only=s'   => \$oneuser,
                     89:             'verbose=s'  => \$verbose,
                     90:             'debug' => \$debug,
                     91:             );
                     92: 
                     93: if ($help) {
                     94:     print <<"ENDHELP";
                     95: $0
                     96: Rebuild and update the LON-CAPA metadata database. 
                     97: Options:
                     98:     -help          Print this help
                     99:     -simulate      Do not modify the database.
                    100:     -only=user     Only compute for the given user.  Implies -simulate   
                    101:     -verbose=val   Sets logging level, val must be a number
                    102:     -debug         Turns on debugging output
                    103: ENDHELP
                    104:     exit 0;
                    105: }
                    106: 
                    107: if (! defined($debug)) {
                    108:     $debug = 0;
                    109: }
                    110: 
                    111: if (! defined($verbose)) {
                    112:     $verbose = 0;
                    113: }
                    114: 
                    115: if (defined($oneuser)) {
                    116:     $simulate=1;
                    117: }
                    118: 
1.55      matthew   119: ##
                    120: ## Use variables for table names so we can test this routine a little easier
1.69      raeburn   121: my %oldnames = (
                    122:                  'metadata'    => 'metadata',
                    123:                  'portfolio'   => 'portfolio_metadata',
                    124:                  'access'      => 'portfolio_access',
                    125:                  'addedfields' => 'portfolio_addedfields',
1.78    ! raeburn   126:                  'allusers'    => 'allusers',
1.69      raeburn   127:                );
                    128: 
                    129: my %newnames;
                    130: # new table names -  append pid to have unique temporary tables
                    131: foreach my $key (keys(%oldnames)) {
                    132:     $newnames{$key} = 'new'.$oldnames{$key}.$$;
                    133: }
1.45      www       134: 
1.55      matthew   135: #
                    136: # Only run if machine is a library server
1.63      matthew   137: exit if ($Apache::lonnet::perlvar{'lonRole'} ne 'library');
1.78    ! raeburn   138: my $hostid = $Apache::lonnet::perlvar{'lonHostID'};
        !           139: 
1.55      matthew   140: #
                    141: #  Make sure this process is running from user=www
                    142: my $wwwid=getpwnam('www');
                    143: if ($wwwid!=$<) {
1.63      matthew   144:     my $emailto="$Apache::lonnet::perlvar{'lonAdmEMail'},$Apache::lonnet::perlvar{'lonSysEMail'}";
                    145:     my $subj="LON: $Apache::lonnet::perlvar{'lonHostID'} User ID mismatch";
1.55      matthew   146:     system("echo 'User ID mismatch. searchcat.pl must be run as user www.' |\
1.63      matthew   147:  mail -s '$subj' $emailto > /dev/null");
1.55      matthew   148:     exit 1;
                    149: }
                    150: #
                    151: # Let people know we are running
1.63      matthew   152: open(LOG,'>>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/logs/searchcat.log');
1.56      matthew   153: &log(0,'==== Searchcat Run '.localtime()."====");
1.57      matthew   154: 
                    155: 
1.56      matthew   156: if ($debug) {
                    157:     &log(0,'simulating') if ($simulate);
                    158:     &log(0,'only processing user '.$oneuser) if ($oneuser);
                    159:     &log(0,'verbosity level = '.$verbose);
                    160: }
1.55      matthew   161: #
                    162: # Connect to database
                    163: my $dbh;
1.63      matthew   164: if (! ($dbh = DBI->connect("DBI:mysql:loncapa","www",$Apache::lonnet::perlvar{'lonSqlAccess'},
1.55      matthew   165:                           { RaiseError =>0,PrintError=>0}))) {
1.56      matthew   166:     &log(0,"Cannot connect to database!");
1.55      matthew   167:     die "MySQL Error: Cannot connect to database!\n";
                    168: }
                    169: # This can return an error and still be okay, so we do not bother checking.
                    170: # (perhaps it should be more robust and check for specific errors)
1.69      raeburn   171: foreach my $key (keys(%newnames)) {
                    172:     if ($newnames{$key} ne '') {
                    173:         $dbh->do('DROP TABLE IF EXISTS '.$newnames{$key});
                    174:     }
                    175: }
                    176: 
1.55      matthew   177: #
1.77      raeburn   178: # Create the new metadata, portfolio and allusers tables
1.69      raeburn   179: foreach my $key (keys(%newnames)) {
                    180:     if ($newnames{$key} ne '') { 
                    181:         my $request =
                    182:              &LONCAPA::lonmetadata::create_metadata_storage($newnames{$key},$oldnames{$key});
                    183:         $dbh->do($request);
                    184:         if ($dbh->err) {
                    185:             $dbh->disconnect();
                    186:             &log(0,"MySQL Error Create: ".$dbh->errstr);
                    187:             die $dbh->errstr;
                    188:         }
                    189:     }
1.55      matthew   190: }
1.69      raeburn   191: 
1.55      matthew   192: #
                    193: # find out which users we need to examine
1.63      matthew   194: my @domains = sort(&Apache::lonnet::current_machine_domains());
                    195: &log(9,'domains ="'.join('","',@domains).'"');
1.62      matthew   196: 
                    197: foreach my $dom (@domains) {
                    198:     &log(9,'domain = '.$dom);
1.63      matthew   199:     opendir(RESOURCES,"$Apache::lonnet::perlvar{'lonDocRoot'}/res/$dom");
1.62      matthew   200:     my @homeusers = 
                    201:         grep {
1.63      matthew   202:             &ishome("$Apache::lonnet::perlvar{'lonDocRoot'}/res/$dom/$_");
1.62      matthew   203:         } grep { 
                    204:             !/^\.\.?$/;
                    205:         } readdir(RESOURCES);
                    206:     closedir RESOURCES;
                    207:     &log(5,'users = '.$dom.':'.join(',',@homeusers));
                    208:     #
                    209:     if ($oneuser) {
                    210:         @homeusers=($oneuser);
                    211:     }
                    212:     #
                    213:     # Loop through the users
                    214:     foreach my $user (@homeusers) {
                    215:         &log(0,"=== User: ".$user);
                    216:         &process_dynamic_metadata($user,$dom);
                    217:         #
                    218:         # Use File::Find to get the files we need to read/modify
                    219:         find(
                    220:              {preprocess => \&only_meta_files,
                    221:               #wanted     => \&print_filename,
                    222:               #wanted     => \&log_metadata,
                    223:               wanted     => \&process_meta_file,
1.66      albertel  224:               no_chdir   => 1,
1.63      matthew   225:              }, join('/',($Apache::lonnet::perlvar{'lonDocRoot'},'res',$dom,$user)) );
1.62      matthew   226:     }
1.77      raeburn   227:     # Search for all users and public portfolio files
1.78    ! raeburn   228:     my (%allusers,%portusers,%courses);
1.69      raeburn   229:     if ($oneuser) {
                    230:         %portusers = (
                    231:                         $oneuser => '',
                    232:                        );
1.77      raeburn   233:         %allusers = (
                    234:                         $oneuser => '',
                    235:                        );
1.78    ! raeburn   236:         %courses = &courseiddump($dom,'.',1,'.','.',$oneuser,undef,
        !           237:                                  undef,'.');
1.69      raeburn   238:     } else {
1.78    ! raeburn   239:         # get courseIDs for domain on current machine
        !           240:         %courses=&Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',1,[$hostid],'.');
1.69      raeburn   241:         my $dir = $Apache::lonnet::perlvar{lonUsersDir}.'/'.$dom;
1.77      raeburn   242:         &descend_tree($dom,$dir,0,\%portusers,\%allusers);
1.69      raeburn   243:     }
                    244:     foreach my $uname (keys(%portusers)) {
                    245:         my $urlstart = '/uploaded/'.$dom.'/'.$uname;
                    246:         my $pathstart = &propath($dom,$uname).'/userfiles';
1.78    ! raeburn   247:         my $is_course = '';
        !           248:         if (exists($courses{$dom.'_'.$uname})) {
        !           249:             $is_course = 1;
        !           250:         }
1.69      raeburn   251:         my $curr_perm = &Apache::lonnet::get_portfile_permissions($dom,$uname);
                    252:         my %access = &Apache::lonnet::get_access_controls($curr_perm);
1.75      raeburn   253:         foreach my $file (keys(%access)) {
1.69      raeburn   254:             my ($group,$url,$fullpath);
                    255:             if ($is_course) {
                    256:                 ($group, my ($path)) = ($file =~ /^(\w+)(\/.+)$/);
1.72      raeburn   257:                 $fullpath = $pathstart.'/groups/'.$group.'/portfolio'.$path;
1.69      raeburn   258:                 $url = $urlstart.'/groups/'.$group.'/portfolio'.$path;
                    259:             } else {
                    260:                 $fullpath = $pathstart.'/portfolio'.$file;
1.72      raeburn   261:                 $url = $urlstart.'/portfolio'.$file;
1.69      raeburn   262:             }
                    263:             if (ref($access{$file}) eq 'HASH') {
1.75      raeburn   264:                 my %portaccesslog = 
                    265:                     &LONCAPA::lonmetadata::process_portfolio_access_data($dbh,
                    266:                            $simulate,\%newnames,$url,$fullpath,$access{$file});
                    267:                 &portfolio_logging(%portaccesslog);
1.69      raeburn   268:             }
1.75      raeburn   269:             my %portmetalog = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,$simulate,\%newnames,$url,$fullpath,$is_course,$dom,$uname,$group);
                    270:             &portfolio_logging(%portmetalog);
1.69      raeburn   271:         }
                    272:     }
1.77      raeburn   273:     # Update allusers
                    274:     foreach my $uname (keys(%allusers)) {
1.78    ! raeburn   275:         next if (exists($courses{$dom.'_'.$uname}));
1.77      raeburn   276:         my %userdata = 
                    277:             &Apache::lonnet::get('environment',['firstname','lastname',
                    278:                 'middlename','generation','id','permanentemail'],$dom,$uname);
                    279:         $userdata{'username'} = $uname;
                    280:         $userdata{'domain'} = $dom;
                    281:         my %alluserslog = 
                    282:             &LONCAPA::lonmetadata::process_allusers_data($dbh,$simulate,
                    283:                 \%newnames,$uname,$dom,\%userdata);
                    284:         foreach my $item (keys(%alluserslog)) {
                    285:             &log(0,$alluserslog{$item});
                    286:         }
                    287:     }
1.55      matthew   288: }
1.69      raeburn   289: 
1.55      matthew   290: #
1.69      raeburn   291: # Rename the tables
1.56      matthew   292: if (! $simulate) {
1.69      raeburn   293:     foreach my $key (keys(%oldnames)) {
                    294:         if (($oldnames{$key} ne '') && ($newnames{$key} ne '')) {
                    295:             $dbh->do('DROP TABLE IF EXISTS '.$oldnames{$key});
                    296:             if (! $dbh->do('RENAME TABLE '.$newnames{$key}.' TO '.$oldnames{$key})) {
                    297:                 &log(0,"MySQL Error Rename: ".$dbh->errstr);
                    298:                 die $dbh->errstr;
                    299:             } else {
                    300:                 &log(1,"MySQL table rename successful for $key.");
                    301:             }
                    302:         }
1.56      matthew   303:     }
1.55      matthew   304: }
                    305: if (! $dbh->disconnect) {
1.56      matthew   306:     &log(0,"MySQL Error Disconnect: ".$dbh->errstr);
1.55      matthew   307:     die $dbh->errstr;
                    308: }
                    309: ##
                    310: ## Finished!
1.56      matthew   311: &log(0,"==== Searchcat completed ".localtime()." ====");
1.55      matthew   312: close(LOG);
1.21      www       313: 
1.55      matthew   314: &write_type_count();
                    315: &write_copyright_count();
1.36      www       316: 
1.55      matthew   317: exit 0;
1.28      harris41  318: 
1.56      matthew   319: ##
                    320: ## Status logging routine.  Inputs: $level, $message
                    321: ## 
                    322: ## $level 0 should be used for normal output and error messages
                    323: ##
                    324: ## $message does not need to end with \n.  In the case of errors
                    325: ## the message should contain as much information as possible to
                    326: ## help in diagnosing the problem.
                    327: ##
                    328: sub log {
                    329:     my ($level,$message)=@_;
                    330:     $level = 0 if (! defined($level));
                    331:     if ($verbose >= $level) {
                    332:         print LOG $message.$/;
                    333:     }
                    334: }
                    335: 
1.75      raeburn   336: sub portfolio_logging {
                    337:     my (%portlog) = @_;
                    338:     foreach my $key (keys(%portlog)) {
                    339:         if (ref($portlog{$key}) eq 'HASH') {
                    340:             foreach my $item (keys(%{$portlog{$key}})) {
                    341:                 &log(0,$portlog{$key}{$item});
                    342:             }
                    343:         }
                    344:     }
                    345: }
                    346: 
1.69      raeburn   347: sub descend_tree {
1.77      raeburn   348:     my ($dom,$dir,$depth,$allportusers,$alldomusers) = @_;
1.69      raeburn   349:     if (-d $dir) {
                    350:         opendir(DIR,$dir);
                    351:         my @contents = grep(!/^\./,readdir(DIR));
                    352:         closedir(DIR);
                    353:         $depth ++;
                    354:         foreach my $item (@contents) {
                    355:             if ($depth < 4) {
1.77      raeburn   356:                 &descend_tree($dom,$dir.'/'.$item,$depth,$allportusers,$alldomusers);
1.69      raeburn   357:             } else {
                    358:                 if (-e $dir.'/'.$item.'/file_permissions.db') {
1.78    ! raeburn   359:                     $$allportusers{$item} = '';
1.77      raeburn   360:                 }
1.78    ! raeburn   361:                 if (-e $dir.'/'.$item.'/passwd') {
1.69      raeburn   362:                     $$alldomusers{$item} = '';
                    363:                 }
                    364:             }       
                    365:         }
                    366:     } 
                    367: }
                    368: 
1.55      matthew   369: ########################################################
                    370: ########################################################
                    371: ###                                                  ###
                    372: ###          File::Find support routines             ###
                    373: ###                                                  ###
                    374: ########################################################
                    375: ########################################################
                    376: ##
                    377: ## &only_meta_files
                    378: ##
                    379: ## Called by File::Find.
                    380: ## Takes a list of files/directories in and returns a list of files/directories
                    381: ## to search.
                    382: sub only_meta_files {
                    383:     my @PossibleFiles = @_;
                    384:     my @ChosenFiles;
                    385:     foreach my $file (@PossibleFiles) {
                    386:         if ( ($file =~ /\.meta$/ &&            # Ends in meta
                    387:               $file !~ /\.\d+\.[^\.]+\.meta$/  # is not for a prior version
1.67      albertel  388:              ) || (-d $File::Find::dir."/".$file )) { # directories are okay
1.55      matthew   389:                  # but we do not want /. or /..
                    390:             push(@ChosenFiles,$file);
                    391:         }
1.38      www       392:     }
1.55      matthew   393:     return @ChosenFiles;
1.38      www       394: }
                    395: 
1.55      matthew   396: ##
                    397: ##
                    398: ## Debugging routines, use these for 'wanted' in the File::Find call
                    399: ##
                    400: sub print_filename {
                    401:     my ($file) = $_;
                    402:     my $fullfilename = $File::Find::name;
1.56      matthew   403:     if ($debug) {
                    404:         if (-d $file) {
                    405:             &log(5," Got directory ".$fullfilename);
                    406:         } else {
                    407:             &log(5," Got file ".$fullfilename);
                    408:         }
1.38      www       409:     }
1.55      matthew   410:     $_=$file;
1.38      www       411: }
1.28      harris41  412: 
1.55      matthew   413: sub log_metadata {
                    414:     my ($file) = $_;
                    415:     my $fullfilename = $File::Find::name;
                    416:     return if (-d $fullfilename); # No need to do anything here for directories
1.56      matthew   417:     if ($debug) {
                    418:         &log(6,$fullfilename);
1.69      raeburn   419:         my $ref = &metadata($fullfilename);
1.56      matthew   420:         if (! defined($ref)) {
                    421:             &log(6,"    No data");
                    422:             return;
                    423:         }
                    424:         while (my($key,$value) = each(%$ref)) {
                    425:             &log(6,"    ".$key." => ".$value);
                    426:         }
                    427:         &count_copyright($ref->{'copyright'});
1.55      matthew   428:     }
                    429:     $_=$file;
1.31      harris41  430: }
1.21      www       431: 
1.55      matthew   432: ##
                    433: ## process_meta_file
                    434: ##   Called by File::Find. 
                    435: ##   Only input is the filename in $_.  
                    436: sub process_meta_file {
                    437:     my ($file) = $_;
1.56      matthew   438:     my $filename = $File::Find::name; # full filename
1.55      matthew   439:     return if (-d $filename); # No need to do anything here for directories
                    440:     #
1.56      matthew   441:     &log(3,$filename) if ($debug);
1.55      matthew   442:     #
1.69      raeburn   443:     my $ref = &metadata($filename);
1.55      matthew   444:     #
                    445:     # $url is the original file url, not the metadata file
1.61      matthew   446:     my $target = $filename;
                    447:     $target =~ s/\.meta$//;
                    448:     my $url='/res/'.&declutter($target);
1.56      matthew   449:     &log(3,"    ".$url) if ($debug);
1.55      matthew   450:     #
                    451:     # Ignore some files based on their metadata
                    452:     if ($ref->{'obsolete'}) { 
1.56      matthew   453:         &log(3,"obsolete") if ($debug);
1.55      matthew   454:         return; 
                    455:     }
                    456:     &count_copyright($ref->{'copyright'});
                    457:     if ($ref->{'copyright'} eq 'private') { 
1.56      matthew   458:         &log(3,"private") if ($debug);
1.55      matthew   459:         return; 
                    460:     }
                    461:     #
                    462:     # Find the dynamic metadata
                    463:     my %dyn;
                    464:     if ($url=~ m:/default$:) {
                    465:         $url=~ s:/default$:/:;
1.56      matthew   466:         &log(3,"Skipping dynamic data") if ($debug);
1.55      matthew   467:     } else {
1.56      matthew   468:         &log(3,"Retrieving dynamic data") if ($debug);
                    469:         %dyn=&get_dynamic_metadata($url);
1.55      matthew   470:         &count_type($url);
                    471:     }
1.75      raeburn   472:     &LONCAPA::lonmetadata::getfiledates($ref,$target);
1.55      matthew   473:     #
                    474:     my %Data = (
                    475:                 %$ref,
                    476:                 %dyn,
                    477:                 'url'=>$url,
                    478:                 'version'=>'current');
1.56      matthew   479:     if (! $simulate) {
1.69      raeburn   480:         my ($count,$err) = 
                    481:           &LONCAPA::lonmetadata::store_metadata($dbh,$newnames{'metadata'},
                    482:                                                 'metadata',\%Data);
1.56      matthew   483:         if ($err) {
                    484:             &log(0,"MySQL Error Insert: ".$err);
                    485:         }
                    486:         if ($count < 1) {
                    487:             &log(0,"Unable to insert record into MySQL database for $url");
                    488:         }
1.55      matthew   489:     }
                    490:     #
                    491:     # Reset $_ before leaving
                    492:     $_ = $file;
                    493: }
                    494: 
                    495: ########################################################
                    496: ########################################################
                    497: ###                                                  ###
                    498: ###  &metadata($uri)                                 ###
                    499: ###   Retrieve metadata for the given file           ###
                    500: ###                                                  ###
                    501: ########################################################
                    502: ########################################################
                    503: sub metadata {
1.69      raeburn   504:     my ($uri) = @_;
1.55      matthew   505:     my %metacache=();
                    506:     $uri=&declutter($uri);
                    507:     my $filename=$uri;
                    508:     $uri=~s/\.meta$//;
                    509:     $uri='';
                    510:     if ($filename !~ /\.meta$/) { 
                    511:         $filename.='.meta';
                    512:     }
1.75      raeburn   513:     my $metastring = 
                    514:         &LONCAPA::lonmetadata::getfile($Apache::lonnet::perlvar{'lonDocRoot'}.'/res/'.$filename);
1.55      matthew   515:     return undef if (! defined($metastring));
                    516:     my $parser=HTML::TokeParser->new(\$metastring);
                    517:     my $token;
                    518:     while ($token=$parser->get_token) {
                    519:         if ($token->[0] eq 'S') {
                    520:             my $entry=$token->[1];
                    521:             my $unikey=$entry;
                    522:             if (defined($token->[2]->{'part'})) { 
                    523:                 $unikey.='_'.$token->[2]->{'part'}; 
                    524:             }
                    525:             if (defined($token->[2]->{'name'})) { 
                    526:                 $unikey.='_'.$token->[2]->{'name'}; 
                    527:             }
                    528:             if ($metacache{$uri.'keys'}) {
                    529:                 $metacache{$uri.'keys'}.=','.$unikey;
                    530:             } else {
                    531:                 $metacache{$uri.'keys'}=$unikey;
                    532:             }
                    533:             foreach ( @{$token->[3]}) {
                    534:                 $metacache{$uri.''.$unikey.'.'.$_}=$token->[2]->{$_};
1.69      raeburn   535:             }
1.55      matthew   536:             if (! ($metacache{$uri.''.$unikey}=$parser->get_text('/'.$entry))){
                    537:                 $metacache{$uri.''.$unikey} = 
                    538:                     $metacache{$uri.''.$unikey.'.default'};
                    539:             }
                    540:         } # End of ($token->[0] eq 'S')
                    541:     }
                    542:     return \%metacache;
1.31      harris41  543: }
1.28      harris41  544: 
1.55      matthew   545: ########################################################
                    546: ########################################################
                    547: ###                                                  ###
                    548: ###    Dynamic Metadata                              ###
                    549: ###                                                  ###
                    550: ########################################################
                    551: ########################################################
1.56      matthew   552: ##
1.58      www       553: ## Dynamic metadata description (incomplete)
                    554: ##
                    555: ## For a full description of all fields,
                    556: ## see LONCAPA::lonmetadata
1.56      matthew   557: ##
                    558: ##   Field             Type
                    559: ##-----------------------------------------------------------
                    560: ##   count             integer
                    561: ##   course            integer
1.58      www       562: ##   course_list       comma separated list of course ids
1.56      matthew   563: ##   avetries          real                                
1.58      www       564: ##   avetries_list     comma separated list of real numbers
1.56      matthew   565: ##   stdno             real
1.58      www       566: ##   stdno_list        comma separated list of real numbers
1.56      matthew   567: ##   usage             integer   
1.58      www       568: ##   usage_list        comma separated list of resources
1.56      matthew   569: ##   goto              scalar
1.58      www       570: ##   goto_list         comma separated list of resources
1.56      matthew   571: ##   comefrom          scalar
1.58      www       572: ##   comefrom_list     comma separated list of resources
1.56      matthew   573: ##   difficulty        real
1.58      www       574: ##   difficulty_list   comma separated list of real numbers
1.56      matthew   575: ##   sequsage          scalar
1.58      www       576: ##   sequsage_list     comma separated list of resources
1.56      matthew   577: ##   clear             real
                    578: ##   technical         real
                    579: ##   correct           real
                    580: ##   helpful           real
                    581: ##   depth             real
                    582: ##   comments          html of all the comments made
                    583: ##
                    584: {
                    585: 
                    586: my %DynamicData;
                    587: my %Counts;
                    588: 
                    589: sub process_dynamic_metadata {
                    590:     my ($user,$dom) = @_;
                    591:     undef(%DynamicData);
                    592:     undef(%Counts);
                    593:     #
                    594:     my $prodir = &propath($dom,$user);
1.55      matthew   595:     #
1.56      matthew   596:     # Read in the dynamic metadata
1.55      matthew   597:     my %evaldata;
                    598:     if (! tie(%evaldata,'GDBM_File',
                    599:               $prodir.'/nohist_resevaldata.db',&GDBM_READER(),0640)) {
1.56      matthew   600:         return 0;
1.55      matthew   601:     }
1.56      matthew   602:     #
1.57      matthew   603:     %DynamicData = &LONCAPA::lonmetadata::process_reseval_data(\%evaldata);
1.55      matthew   604:     untie(%evaldata);
1.62      matthew   605:     $DynamicData{'domain'} = $dom;
1.64      albertel  606:     #print('user = '.$user.' domain = '.$dom.$/);
1.56      matthew   607:     #
                    608:     # Read in the access count data
                    609:     &log(7,'Reading access count data') if ($debug);
                    610:     my %countdata;
                    611:     if (! tie(%countdata,'GDBM_File',
                    612:               $prodir.'/nohist_accesscount.db',&GDBM_READER(),0640)) {
                    613:         return 0;
                    614:     }
                    615:     while (my ($key,$count) = each(%countdata)) {
                    616:         next if ($key !~ /^$dom/);
                    617:         $key = &unescape($key);
                    618:         &log(8,'    Count '.$key.' = '.$count) if ($debug);
                    619:         $Counts{$key}=$count;
                    620:     }
                    621:     untie(%countdata);
                    622:     if ($debug) {
                    623:         &log(7,scalar(keys(%Counts)).
                    624:              " Counts read for ".$user."@".$dom);
                    625:         &log(7,scalar(keys(%DynamicData)).
                    626:              " Dynamic metadata read for ".$user."@".$dom);
                    627:     }
                    628:     #
                    629:     return 1;
                    630: }
                    631: 
                    632: sub get_dynamic_metadata {
                    633:     my ($url) = @_;
                    634:     $url =~ s:^/res/::;
1.57      matthew   635:     my %data = &LONCAPA::lonmetadata::process_dynamic_metadata($url,
                    636:                                                                \%DynamicData);
1.56      matthew   637:     # find the count
                    638:     $data{'count'} = $Counts{$url};
                    639:     #
                    640:     # Log the dynamic metadata
                    641:     if ($debug) {
                    642:         while (my($k,$v)=each(%data)) {
                    643:             &log(8,"    ".$k." => ".$v);
                    644:         }
1.44      www       645:     }
1.56      matthew   646:     return %data;
1.30      www       647: }
1.28      harris41  648: 
1.56      matthew   649: } # End of %DynamicData and %Counts scope
                    650: 
1.55      matthew   651: ########################################################
                    652: ########################################################
                    653: ###                                                  ###
                    654: ###   Counts                                         ###
                    655: ###                                                  ###
                    656: ########################################################
                    657: ########################################################
                    658: {
1.1       harris41  659: 
1.55      matthew   660: my %countext;
1.15      harris41  661: 
1.55      matthew   662: sub count_type {
                    663:     my $file=shift;
                    664:     $file=~/\.(\w+)$/;
                    665:     my $ext=lc($1);
                    666:     $countext{$ext}++;
1.31      harris41  667: }
1.1       harris41  668: 
1.55      matthew   669: sub write_type_count {
                    670:     open(RESCOUNT,'>/home/httpd/html/lon-status/rescount.txt');
                    671:     while (my ($extension,$count) = each(%countext)) {
                    672: 	print RESCOUNT $extension.'='.$count.'&';
1.47      www       673:     }
1.55      matthew   674:     print RESCOUNT 'time='.time."\n";
                    675:     close(RESCOUNT);
1.31      harris41  676: }
1.27      www       677: 
1.55      matthew   678: } # end of scope for %countext
1.34      matthew   679: 
1.55      matthew   680: {
1.34      matthew   681: 
1.55      matthew   682: my %copyrights;
1.44      www       683: 
1.55      matthew   684: sub count_copyright {
                    685:     $copyrights{@_[0]}++;
1.31      harris41  686: }
1.33      matthew   687: 
1.55      matthew   688: sub write_copyright_count {
                    689:     open(COPYCOUNT,'>/home/httpd/html/lon-status/copyrightcount.txt');
                    690:     while (my ($copyright,$count) = each(%copyrights)) {
                    691: 	print COPYCOUNT $copyright.'='.$count.'&';
1.31      harris41  692:     }
1.55      matthew   693:     print COPYCOUNT 'time='.time."\n";
                    694:     close(COPYCOUNT);
1.31      harris41  695: }
1.28      harris41  696: 
1.55      matthew   697: } # end of scope for %copyrights
1.28      harris41  698: 
1.55      matthew   699: ########################################################
                    700: ########################################################
                    701: ###                                                  ###
                    702: ###   Miscellanous Utility Routines                  ###
                    703: ###                                                  ###
                    704: ########################################################
                    705: ########################################################
                    706: ##
                    707: ## &ishome($username)
                    708: ##   Returns 1 if $username is a LON-CAPA author, 0 otherwise
                    709: ##   (copied from lond, modification of the return value)
1.31      harris41  710: sub ishome {
                    711:     my $author=shift;
1.76      albertel  712:     $author=~s{/home/httpd/html/res/([^/]*)/([^/]*).*}{$1/$2};
1.31      harris41  713:     my ($udom,$uname)=split(/\//,$author);
                    714:     my $proname=propath($udom,$uname);
                    715:     if (-e $proname) {
                    716: 	return 1;
                    717:     } else {
                    718:         return 0;
                    719:     }
                    720: }
1.28      harris41  721: 
1.55      matthew   722: ##
                    723: ## &declutter($filename)
                    724: ##   Given a filename, returns a url for the filename.
                    725: sub declutter {
                    726:     my $thisfn=shift;
1.63      matthew   727:     $thisfn=~s/^$Apache::lonnet::perlvar{'lonDocRoot'}//;
1.55      matthew   728:     $thisfn=~s/^\///;
                    729:     $thisfn=~s/^res\///;
                    730:     return $thisfn;
1.31      harris41  731: }
1.28      harris41  732: 

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