--- loncom/metadata_database/LONCAPA/lonmetadata.pm 2005/11/29 19:56:42 1.13 +++ loncom/metadata_database/LONCAPA/lonmetadata.pm 2006/09/26 15:15:31 1.14 @@ -1,6 +1,6 @@ # The LearningOnline Network with CAPA # -# $Id: lonmetadata.pm,v 1.13 2005/11/29 19:56:42 www Exp $ +# $Id: lonmetadata.pm,v 1.14 2006/09/26 15:15:31 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -30,6 +30,8 @@ package LONCAPA::lonmetadata; use strict; use DBI; +use vars qw($Metadata_Table_Description $Portfolio_metadata_table_description +$Portfolio_access_table_description $Fulltext_indicies $Portfolio_metadata_indices $Portfolio_access_indices $Portfolio_addedfields_table_description $Portfolio_addedfields_indices); ###################################################################### ###################################################################### @@ -96,8 +98,8 @@ TYPE=MYISAM; ###################################################################### ###################################################################### -my @Metadata_Table_Description = - ( +$Metadata_Table_Description = + [ { name => 'title', type=>'TEXT'}, { name => 'author', type=>'TEXT'}, { name => 'subject', type=>'TEXT'}, @@ -144,9 +146,9 @@ my @Metadata_Table_Description = { name => 'depth', type=>'FLOAT'}, { name => 'hostname', type=> 'TEXT'}, #-------------------------------------------------- - ); + ]; -my @Fulltext_indicies = qw/ +$Fulltext_indicies = [ qw/ title author subject @@ -158,11 +160,95 @@ my @Fulltext_indicies = qw/ mime language owner - copyright/; + copyright/ ]; + +###################################################################### +###################################################################### +$Portfolio_metadata_table_description = + [ + { name => 'title', type=>'TEXT'}, + { name => 'author', type=>'TEXT'}, + { name => 'subject', type=>'TEXT'}, + { name => 'url', type=>'TEXT', restrictions => 'NOT NULL' }, + { name => 'keywords', type=>'TEXT'}, + { name => 'version', type=>'TEXT'}, + { name => 'notes', type=>'TEXT'}, + { name => 'abstract', type=>'TEXT'}, + { name => 'mime', type=>'TEXT'}, + { name => 'language', type=>'TEXT'}, + { name => 'creationdate', type=>'DATETIME'}, + { name => 'lastrevisiondate', type=>'DATETIME'}, + { name => 'owner', type=>'TEXT'}, + { name => 'copyright', type=>'TEXT'}, + { name => 'domain', type=>'TEXT'}, + { name => 'groupname', type=>'TEXT'}, + { name => 'courserestricted', type=>'TEXT'}, + { name => 'addedfieldnames', type=>'TEXT'}, + { name => 'addedfieldvalues', type=>'TEXT'}, + #-------------------------------------------------- + { name => 'dependencies', type=>'TEXT'}, + { name => 'modifyinguser', type=>'TEXT'}, + { name => 'authorspace', type=>'TEXT'}, + { name => 'lowestgradelevel', type=>'INT'}, + { name => 'highestgradelevel', type=>'INT'}, + { name => 'standards', type=>'TEXT'}, + { name => 'hostname', type=> 'TEXT'}, + #-------------------------------------------------- + ]; + +$Portfolio_metadata_indices = [qw/ + title + author + subject + url + keywords + version + notes + abstract + mime + language + owner/]; + +###################################################################### +###################################################################### + +$Portfolio_access_table_description = + [ + { name => 'url', type=>'TEXT', restrictions => 'NOT NULL' }, + { name => 'keynum', type=>'TEXT', restrictions => 'NOT NULL' }, + { name => 'scope', type=>'TEXT'}, + { name => 'start', type=>'DATETIME'}, + { name => 'end', type=>'DATETIME'}, + ]; + +$Portfolio_access_indices = [qw/ + url + keynum + scope + start + end/]; ###################################################################### ###################################################################### +$Portfolio_addedfields_table_description = + [ + { name => 'url', type=>'TEXT', restrictions => 'NOT NULL' }, + { name => 'field', type=>'TEXT', restrictions => 'NOT NULL' }, + { name => 'courserestricted', type=>'TEXT', restrictions => 'NOT NULL' }, + { name => 'value', type=>'TEXT'}, + ]; + +$Portfolio_addedfields_indices = [qw/ + url + field + value + courserestricted/]; + +###################################################################### +###################################################################### + + =pod =item &describe_metadata_storage @@ -176,8 +262,36 @@ of the metadata table(s). ###################################################################### ###################################################################### -sub describe_metadata_storage { - return (\@Metadata_Table_Description,\@Fulltext_indicies); +sub describe_metadata_storage { + my ($tabletype) = @_; + my %table_description = ( + metadata => $Metadata_Table_Description, + portfolio_metadata => $Portfolio_metadata_table_description, + portfolio_access => $Portfolio_access_table_description, + portfolio_addedfields => $Portfolio_addedfields_table_description, + ); + my %index_description = ( + metadata => $Fulltext_indicies, + portfolio_metadata => $Portfolio_metadata_indices, + portfolio_access => $Portfolio_access_indices, + portfolio_addedfields => $Portfolio_addedfields_indices, + ); + if ($tabletype eq 'portfolio_search') { + my @portfolio_search_table = @{$table_description{portfolio_metadata}}; + foreach my $item (@{$table_description{portfolio_access}}) { + if (ref($item) eq 'HASH') { + if ($item->{'name'} eq 'url') { + next; + } + } + push(@portfolio_search_table,$item); + } + my @portfolio_search_indices = @{$index_description{portfolio_metadata}}; + push(@portfolio_search_indices,('scope','keynum')); + return (\@portfolio_search_table,\@portfolio_search_indices); + } else { + return ($table_description{$tabletype},$index_description{$tabletype}); + } } ###################################################################### @@ -197,15 +311,20 @@ metadata storage to be initialized. ###################################################################### ###################################################################### sub create_metadata_storage { - my ($tablename) = @_; + my ($tablename,$tabletype) = @_; $tablename = 'metadata' if (! defined($tablename)); + $tabletype = 'metadata' if (! defined($tabletype)); my $request = "CREATE TABLE IF NOT EXISTS ".$tablename." "; # # Process the columns (this code is stolen from lonmysql.pm) my @Columns; my $col_des; # mysql column description - foreach my $coldata (@Metadata_Table_Description) { + my ($table_columns,$table_indices) = + &describe_metadata_storage($tabletype); + my %coltype; + foreach my $coldata (@{$table_columns}) { my $column = $coldata->{'name'}; + $coltype{$column} = $coldata->{'type'}; $col_des = ''; if (lc($coldata->{'type'}) =~ /(enum|set)/) { # 'enum' or 'set' $col_des.=$column." ".$coldata->{'type'}."('". @@ -231,8 +350,14 @@ sub create_metadata_storage { # skip blank items. push (@Columns,$col_des) if ($col_des ne ''); } - foreach my $colname (@Fulltext_indicies) { - my $text = 'FULLTEXT idx_'.$colname.' ('.$colname.')'; + foreach my $colname (@{$table_indices}) { + my $text; + if ($coltype{$colname} eq 'TEXT') { + $text = 'FULLTEXT '; + } else { + $text = 'INDEX '; + } + $text .= 'idx_'.$colname.' ('.$colname.')'; push (@Columns,$text); } $request .= "(".join(", ",@Columns).") TYPE=MyISAM"; @@ -246,8 +371,8 @@ sub create_metadata_storage { =item store_metadata() -Inputs: database handle ($dbh), a table name, and a hash or hash reference -containing the metadata for a single resource. +Inputs: database handle ($dbh), a table name, table type and a hash or hash +reference containing the metadata for a single resource. Returns: 1 on success, 0 on failure to store. @@ -263,19 +388,21 @@ Returns: 1 on success, 0 on failure to s ## ## In most scripts, this will work fine. If the dbi is going to be ## dropped and (possibly) later recreated, call &clear_sth. Yes it - ## is annoying but $sth appearantly does not have a link back to the + ## is annoying but $sth apparently does not have a link back to the ## $dbh, so we can't check our validity. ## my $sth = undef; my $sth_table = undef; sub create_statement_handler { - my $dbh = shift(); - my $tablename = shift(); + my ($dbh,$tablename,$tabletype) = @_; $tablename = 'metadata' if (! defined($tablename)); + $tabletype = 'metadata' if (! defined($tabletype)); + my ($table_columns,$table_indices) = + &describe_metadata_storage($tabletype); $sth_table = $tablename; my $request = 'INSERT INTO '.$tablename.' VALUES('; - foreach (@Metadata_Table_Description) { + foreach (@{$table_columns}) { $request .= '?,'; } chop $request; @@ -287,18 +414,23 @@ sub create_statement_handler { sub clear_sth { $sth=undef; $sth_table=undef;} sub store_metadata { - my ($dbh,$tablename,@Metadata)=@_; + my ($dbh,$tablename,$tabletype,@Metadata)=@_; my $errors = ''; if (! defined($sth) || ( defined($tablename) && ($sth_table ne $tablename)) || (! defined($tablename) && $sth_table ne 'metadata')) { - &create_statement_handler($dbh,$tablename); + &create_statement_handler($dbh,$tablename,$tabletype); } my $successcount = 0; + if (! defined($tabletype)) { + $tabletype = 'metadata'; + } + my ($table_columns,$table_indices) = + &describe_metadata_storage($tabletype); foreach my $mdata (@Metadata) { next if (ref($mdata) ne "HASH"); my @MData; - foreach my $field (@Metadata_Table_Description) { + foreach my $field (@{$table_columns}) { my $fname = $field->{'name'}; if (exists($mdata->{$fname}) && defined($mdata->{$fname}) && @@ -422,6 +554,7 @@ Inputs: $dbh, database handle $newmetadata, hash reference containing the new metadata $tablename, metadata table name. Defaults to 'metadata'. +$tabletype, type of table (metadata, portfolio_metadata, portfolio_access) Returns: $error on failure. undef on success. @@ -431,9 +564,10 @@ $error on failure. undef on success. ###################################################################### ###################################################################### sub update_metadata { - my ($dbh,$tablename,$newmetadata)=@_; + my ($dbh,$tablename,$tabletype,$newmetadata)=@_; my $error; $tablename = 'metadata' if (! defined($tablename)); + $tabletype = 'metadata' if (! defined($tabletype)); if (! exists($newmetadata->{'url'})) { $error = 'Unable to update: no url specified'; } @@ -445,7 +579,7 @@ sub update_metadata { ' url='.$dbh->quote($newmetadata->{'url'}), undef,$tablename); return $error if ($error); - my %metadata = &LONCAPA::lonmetadata::metadata_col_to_hash(@{$row->[0]}); + my %metadata = &LONCAPA::lonmetadata::metadata_col_to_hash($tabletype,@{$row->[0]}); # # Update metadata values while (my ($key,$value) = each(%$newmetadata)) { @@ -458,7 +592,7 @@ sub update_metadata { # # Store updated metadata my $success; - ($success,$error) = &store_metadata($dbh,$tablename,\%metadata); + ($success,$error) = &store_metadata($dbh,$tablename,$tabletype,\%metadata); return $error; } @@ -479,17 +613,18 @@ passed in as values ###################################################################### ###################################################################### sub metadata_col_to_hash { - my @cols=@_; + my ($tabletype,@cols)=@_; my %hash=(); - for (my $i=0; $i<=$#Metadata_Table_Description;$i++) { - $hash{$Metadata_Table_Description[$i]->{'name'}}=$cols[$i]; - unless ($hash{$Metadata_Table_Description[$i]->{'name'}}) { - if ($Metadata_Table_Description[$i]->{'type'} eq 'TEXT') { - $hash{$Metadata_Table_Description[$i]->{'name'}}=''; - } elsif ($Metadata_Table_Description[$i]->{'type'} eq 'DATETIME') { - $hash{$Metadata_Table_Description[$i]->{'name'}}='0000-00-00 00:00:00'; + my ($columns,$indices) = &describe_metadata_storage($tabletype); + for (my $i=0; $i<@{$columns};$i++) { + $hash{$columns->[$i]->{'name'}}=$cols[$i]; + unless ($hash{$columns->[$i]->{'name'}}) { + if ($columns->[$i]->{'type'} eq 'TEXT') { + $hash{$columns->[$i]->{'name'}}=''; + } elsif ($columns->[$i]->{'type'} eq 'DATETIME') { + $hash{$columns->[$i]->{'name'}}='0000-00-00 00:00:00'; } else { - $hash{$Metadata_Table_Description[$i]->{'name'}}=0; + $hash{$columns->[$i]->{'name'}}=0; } } } @@ -795,6 +930,10 @@ sub dynamic_metadata_storage { ###################################################################### ###################################################################### + + +###################################################################### +###################################################################### ## ## The usual suspects, repeated here to reduce dependency hell ##