--- loncom/interface/lonmeta.pm 2003/12/31 15:34:32 1.53
+++ loncom/interface/lonmeta.pm 2005/12/19 20:08:40 1.142
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Metadata display handler
#
-# $Id: lonmeta.pm,v 1.53 2003/12/31 15:34:32 www Exp $
+# $Id: lonmeta.pm,v 1.142 2005/12/19 20:08:40 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -17,7 +17,7 @@
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
@@ -29,22 +29,100 @@
package Apache::lonmeta;
use strict;
+use LONCAPA::lonmetadata();
use Apache::Constants qw(:common);
-use Apache::lonnet();
+use Apache::lonnet;
use Apache::loncommon();
-use Apache::lonhtmlcommon();
+use Apache::lonhtmlcommon();
use Apache::lonmsg;
use Apache::lonpublisher;
use Apache::lonlocal;
use Apache::lonmysql;
use Apache::lonmsg;
-# MySQL table columns
-my @columns;
+############################################################
+############################################################
+##
+## &get_dynamic_metadata_from_sql($url)
+##
+## Queries sql database for dynamic metdata
+## Returns a hash of hashes, with keys of urls which match $url
+## Returned fields are given below.
+##
+## Examples:
+##
+## %DynamicMetadata = &Apache::lonmeta::get_dynmaic_metadata_from_sql
+## ('/res/msu/korte/');
+##
+## $DynamicMetadata{'/res/msu/korte/example.problem'}->{$field}
+##
+############################################################
+############################################################
+sub get_dynamic_metadata_from_sql {
+ my ($url) = shift();
+ my ($authordom,$author)=($url=~m:^/res/(\w+)/(\w+)/:);
+ if (! defined($authordom)) {
+ $authordom = shift();
+ }
+ if (! defined($author)) {
+ $author = shift();
+ }
+ if (! defined($authordom) || ! defined($author)) {
+ return ();
+ }
+ my @Fields = ('url','count','course',
+ 'goto','goto_list',
+ 'comefrom','comefrom_list',
+ 'sequsage','sequsage_list',
+ 'stdno','stdno_list',
+ 'dependencies',
+ 'avetries','avetries_list',
+ 'difficulty','difficulty_list',
+ 'disc','disc_list',
+ 'clear','technical','correct',
+ 'helpful','depth');
+ #
+ my $query = 'SELECT '.join(',',@Fields).
+ ' FROM metadata WHERE url LIKE "'.$url.'%"';
+ my $server = &Apache::lonnet::homeserver($author,$authordom);
+ my $reply = &Apache::lonnet::metadata_query($query,undef,undef,
+ ,[$server]);
+ return () if (! defined($reply) || ref($reply) ne 'HASH');
+ my $filename = $reply->{$server};
+ if (! defined($filename) || $filename =~ /^error/) {
+ return ();
+ }
+ my $max_time = time + 10; # wait 10 seconds for results at most
+ my %ReturnHash;
+ #
+ # Look for results
+ my $finished = 0;
+ while (! $finished && time < $max_time) {
+ my $datafile=$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename;
+ if (! -e "$datafile.end") { next; }
+ my $fh;
+ if (!($fh=Apache::File->new($datafile))) { next; }
+ while (my $result = <$fh>) {
+ chomp($result);
+ next if (! $result);
+ my @Data =
+ map {
+ &Apache::lonnet::unescape($_);
+ } split(',',$result);
+ my $url = $Data[0];
+ for (my $i=0;$i<=$#Fields;$i++) {
+ $ReturnHash{$url}->{$Fields[$i]}=$Data[$i];
+ }
+ }
+ $finished = 1;
+ }
+ #
+ return %ReturnHash;
+}
-# ----------------------------------------- Fetch and evaluate dynamic metadata
+# Fetch and evaluate dynamic metadata
sub dynamicmeta {
my $url=&Apache::lonnet::declutter(shift);
$url=~s/\.meta$//;
@@ -54,66 +132,22 @@ sub dynamicmeta {
$regexp='___'.$regexp.'___';
my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
$aauthor,$regexp);
- my %sum=();
- my %cnt=();
- my %concat=();
- my %listitems=(
- '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'
- );
- while ($_=each(%evaldata)) {
- my ($item,$purl,$cat)=split(/___/,$_);
- ### Apache->request->print("\n".$_.' - '.$item.'
');
- if (defined($cnt{$cat})) { $cnt{$cat}++; } else { $cnt{$cat}=1; }
- unless ($listitems{$cat} eq 'app') {
- if (defined($sum{$cat})) {
- $sum{$cat}+=$evaldata{$_};
- $concat{$cat}.=','.$item;
- } else {
- $sum{$cat}=$evaldata{$_};
- $concat{$cat}=$item;
- }
- } else {
- if (defined($sum{$cat})) {
- if ($evaldata{$_}) {
- $sum{$cat}.='
'.$evaldata{$_};
- }
- } else {
- $sum{$cat}=''.$evaldata{$_};
- }
- }
- }
- my %returnhash=();
- while ($_=each(%cnt)) {
- if ($listitems{$_} eq 'avg') {
- $returnhash{$_}=int(($sum{$_}/$cnt{$_})*100.0+0.5)/100.0;
- } elsif ($listitems{$_} eq 'cnt') {
- $returnhash{$_}=$cnt{$_};
- } else {
- $returnhash{$_}=$sum{$_};
- }
- $returnhash{$_.'_list'}=$concat{$_};
- ### Apache->request->print("\n
".$_.': '.$returnhash{$_}.'
'.$returnhash{$_.'_list'});
- }
+ my %DynamicData = &LONCAPA::lonmetadata::process_reseval_data(\%evaldata);
+ my %Data = &LONCAPA::lonmetadata::process_dynamic_metadata($url,
+ \%DynamicData);
#
# Deal with 'count' separately
- $returnhash{'count'} = &access_count($url,$aauthor,$adomain);
- # since "usage" is reserved word in MySQL ...
- $returnhash{'sequsage'}=$returnhash{'usage'};
- $returnhash{'sequsage_list'}=$returnhash{'usage_list'};
-
- return %returnhash;
+ $Data{'count'} = &access_count($url,$aauthor,$adomain);
+ #
+ # Debugging code I will probably need later
+ if (0) {
+ &Apache::lonnet::logthis('Dynamic Metadata');
+ while(my($k,$v)=each(%Data)){
+ &Apache::lonnet::logthis(' "'.$k.'"=>"'.$v.'"');
+ }
+ &Apache::lonnet::logthis('-------------------');
+ }
+ return %Data;
}
sub access_count {
@@ -127,156 +161,242 @@ sub access_count {
}
}
-# ------------------------------------- Try to make an alt tag if there is none
-
+# Try to make an alt tag if there is none
sub alttag {
my ($base,$src)=@_;
my $fullpath=&Apache::lonnet::hreflocation($base,$src);
my $alttag=&Apache::lonnet::metadata($fullpath,'title').' '.
- &Apache::lonnet::metadata($fullpath,'subject').' '.
- &Apache::lonnet::metadata($fullpath,'abstract');
+ &Apache::lonnet::metadata($fullpath,'subject').' '.
+ &Apache::lonnet::metadata($fullpath,'abstract');
$alttag=~s/\s+/ /gs;
$alttag=~s/\"//gs;
$alttag=~s/\'//gs;
$alttag=~s/\s+$//gs;
$alttag=~s/^\s+//gs;
- if ($alttag) { return $alttag; } else
- { return &mt('No information available'); }
+ if ($alttag) {
+ return $alttag;
+ } else {
+ return &mt('No information available');
+ }
}
-# -------------------------------------------------------------- Author display
-
+# Author display
sub authordisplay {
my ($aname,$adom)=@_;
- return &Apache::loncommon::aboutmewrapper(
- &Apache::loncommon::plainname($aname,$adom),
- $aname,$adom,'preview').' ['.$aname.'@'.$adom.']';
+ return &Apache::loncommon::aboutmewrapper
+ (&Apache::loncommon::plainname($aname,$adom),
+ $aname,$adom,'preview').' ['.$aname.'@'.$adom.']';
}
-# -------------------------------------------------------------- Pretty display
-
+# Pretty display
sub evalgraph {
my $value=shift;
- unless ($value) { return ''; }
+ if (! $value) {
+ return '';
+ }
my $val=int($value*10.+0.5)-10;
- my $output='';
+ my $output='';
if ($val>=20) {
- $output.='  | ';
+ $output.='  | ';
} else {
- $output.=' | '.
- ' | ';
+ $output.=' | '.
+ ' | ';
}
$output.=' | ';
if ($val>20) {
- $output.=' | '.
- ' | ';
+ $output.=' | '.
+ ' | ';
} else {
- $output.='  | ';
+ $output.='  | ';
}
- $output.=' ('.$value.') |
';
+ $output.=' ('.sprintf("%5.2f",$value).') |
';
return $output;
}
sub diffgraph {
my $value=shift;
- unless ($value) { return ''; }
+ if (! $value) {
+ return '';
+ }
my $val=int(40.0*$value+0.5);
my @colors=('#FF9933','#EEAA33','#DDBB33','#CCCC33',
'#BBDD33','#CCCC33','#DDBB33','#EEAA33');
- my $output='';
+ my $output='';
for (my $i=0;$i<8;$i++) {
if ($val>$i*5) {
- $output.=' | ';
+ $output.=' | ';
} else {
- $output.=' | ';
+ $output.=' | ';
}
}
- $output.=' ('.$value.') |
';
+ $output.=' ('.sprintf("%3.2f",$value).') |
';
return $output;
}
-# ==================================================== Turn MySQL row into hash
-sub metadata_col_to_hash {
- my @cols=@_;
- my %hash=();
- for (my $i=0; $i<=$#columns; $i++) {
- $hash{$columns[$i]}=$cols[$i];
+# The field names
+sub fieldnames {
+ my $file_type=shift;
+ my %fields =
+ ('title' => 'Title',
+ 'author' =>'Author(s)',
+ 'authorspace' => 'Author Space',
+ 'modifyinguser' => 'Last Modifying User',
+ 'subject' => 'Subject',
+ 'standards' => 'Standards',
+ 'keywords' => 'Keyword(s)',
+ 'notes' => 'Notes',
+ 'abstract' => 'Abstract',
+ 'lowestgradelevel' => 'Lowest Grade Level',
+ 'highestgradelevel' => 'Highest Grade Level',
+ 'courserestricted' => 'Course Restricting Metadata');
+
+ if (! defined($file_type) || $file_type ne 'portfolio') {
+ %fields =
+ (%fields,
+ 'domain' => 'Domain',
+ 'mime' => 'MIME Type',
+ 'language' => 'Language',
+ 'creationdate' => 'Creation Date',
+ 'lastrevisiondate' => 'Last Revision Date',
+ 'owner' => 'Publisher/Owner',
+ 'copyright' => 'Copyright/Distribution',
+ 'customdistributionfile' => 'Custom Distribution File',
+ 'sourceavail' => 'Source Available',
+ 'sourcerights' => 'Source Custom Distribution File',
+ 'obsolete' => 'Obsolete',
+ 'obsoletereplacement' => 'Suggested Replacement for Obsolete File',
+ 'count' => 'Network-wide number of accesses (hits)',
+ 'course' => 'Network-wide number of courses using resource',
+ 'course_list' => 'Network-wide courses using resource',
+ 'sequsage' => 'Number of resources using or importing resource',
+ 'sequsage_list' => 'Resources using or importing resource',
+ 'goto' => 'Number of resources that follow this resource in maps',
+ 'goto_list' => 'Resources that follow this resource in maps',
+ 'comefrom' => 'Number of resources that lead up to this resource in maps',
+ 'comefrom_list' => 'Resources that lead up to this resource in maps',
+ 'clear' => 'Material presented in clear way',
+ 'depth' => 'Material covered with sufficient depth',
+ 'helpful' => 'Material is helpful',
+ 'correct' => 'Material appears to be correct',
+ 'technical' => 'Resource is technically correct',
+ 'avetries' => 'Average number of tries till solved',
+ 'stdno' => 'Total number of students who have worked on this problem',
+ 'difficulty' => 'Degree of difficulty',
+ 'disc' => 'Degree of discrimination',
+ 'dependencies' => 'Resources used by this resource',
+ );
}
- return %hash;
+ return &Apache::lonlocal::texthash(%fields);
}
-# ============================================================= The field names
+sub portfolio_display_uri {
+ my ($uri)=@_;
+ $uri =~ s|.*/portfolio(/.*)$|$1|;
+ my ($res_uri,$meta_uri) = ($uri,$uri);
-sub fieldnames {
- return &Apache::lonlocal::texthash(
- 'title' => 'Title',
- 'author' =>'Author(s)',
- 'subject' => 'Subject',
- 'keywords' => 'Keyword(s)',
- 'notes' => 'Notes',
- 'abstract' => 'Abstract',
- 'lowestgradelevel' => 'Lowest Grade Level',
- 'highestgradelevel' => 'Highest Grade Level',
- 'standards' => 'Standards',
- 'mime' => 'MIME Type',
- 'language' => 'Language',
- 'creationdate' => 'Creation Date',
- 'lastrevisiondate' => 'Last Revision Date',
- 'owner' => 'Publisher/Owner',
- 'copyright' => 'Copyright/Distribution',
- 'customdistributionfile' => 'Custom Distribution File',
- 'obsolete' => 'Obsolete',
- 'obsoletereplacement' => 'Suggested Replacement for Obsolete File',
- 'count' => 'Network-wide number of accesses (hits)',
- 'course' => 'Network-wide number of courses using resource',
- 'course_list' => 'Network-wide courses using resource',
- 'sequsage' => 'Number of resources using or importing resource',
- 'sequsage_list' => 'Resources using or importing resource',
- 'goto' => 'Number of resources that follow this resource in maps',
- 'goto_list' => 'Resources that follow this resource in maps',
- 'comefrom' => 'Number of resources that lead up to this resource in maps',
- 'comefrom_list' => 'Resources that lead up to this resource in maps',
- 'clear' => 'Material presented in clear way',
- 'depth' => 'Material covered with sufficient depth',
- 'helpful' => 'Material is helpful',
- 'correct' => 'Material appears to be correct',
- 'technical' => 'Resource is technically correct',
- 'avetries' => 'Average number of tries till solved',
- 'stdno' => 'Total number of students who have worked on this problem',
- 'difficulty' => 'Degree of difficulty'
- );
+ if ($uri =~ /\.meta$/) {
+ $res_uri =~ s/\.meta//;
+ } else {
+ $meta_uri .= '.meta';
+ }
+ return ($res_uri,$meta_uri);
}
-# =========================================== Pretty printing of metadata field
+sub pre_select_course {
+ my ($r,$uri) = @_;
+ my $output;
+ my $fn=&Apache::lonnet::filelocation('',$uri);
+ my ($res_uri,$meta_uri) = &portfolio_display_uri($uri);
+ %Apache::lonpublisher::metadatafields=();
+ %Apache::lonpublisher::metadatakeys=();
+ my $result=&Apache::lonnet::getfile($fn);
+ if ($result == -1){
+ $r->print(&mt('Creating new file [_1]'),$meta_uri);
+ } else {
+ &Apache::lonpublisher::metaeval($result);
+ }
+ $r->print('
');
+ return;
+}
+sub select_course {
+ my %courses;
+ my $output;
+ my $selected;
+ foreach my $key (keys (%env)) {
+ if ($key =~ m/\.metadata\./) {
+ $key =~ m/^course\.(.+)(\.metadata.+$)/;
+ my $course = $1;
+ my $coursekey = 'course.'.$course.'.description';
+ my $value = $env{$coursekey};
+ $courses{$coursekey} = $value;
+ }
+ }
+ &Apache::lonnet::logthis('the restricted is'.$Apache::lonpublisher::metadatafields{'courserestricted'});
+ my $meta_not_found = 1;
+ if ($Apache::lonpublisher::metadatafields{'courserestricted'} eq 'none') {
+ $selected = ' SELECTED ';
+ } else {
+ $selected = '';
+ }
+ $output .= '
';
+ return ($output);
+}
+# Pretty printing of metadata field
sub prettyprint {
- my ($type,$value)=@_;
- unless (defined($value)) { return ' '; }
-# Title
+ my ($type,$value,$target,$prefix,$form,$noformat)=@_;
+# $target,$prefix,$form are optional and for filecrumbs only
+ if (! defined($value)) {
+ return ' ';
+ }
+ # Title
if ($type eq 'title') {
return ''.$value.'';
}
-# Dates
+ # Dates
if (($type eq 'creationdate') ||
($type eq 'lastrevisiondate')) {
- return &Apache::lonlocal::locallocaltime(
- &Apache::lonmysql::unsqltime($value));
+ return ($value?&Apache::lonlocal::locallocaltime(
+ &Apache::lonmysql::unsqltime($value)):
+ &mt('not available'));
}
-# Language
+ # Language
if ($type eq 'language') {
return &Apache::loncommon::languagedescription($value);
}
-# Copyright
+ # Copyright
if ($type eq 'copyright') {
return &Apache::loncommon::copyrightdescription($value);
}
-# MIME
+ # Copyright
+ if ($type eq 'sourceavail') {
+ return &Apache::loncommon::source_copyrightdescription($value);
+ }
+ # MIME
if ($type eq 'mime') {
- return '
'.
- &Apache::loncommon::filedescription($value);
- }
-# Person
+ return '
'.
+ &Apache::loncommon::filedescription($value);
+ }
+ # Person
if (($type eq 'author') ||
($type eq 'owner') ||
($type eq 'modifyinguser') ||
@@ -284,26 +404,45 @@ sub prettyprint {
$value=~s/(\w+)(\:|\@)(\w+)/&authordisplay($1,$3)/gse;
return $value;
}
-# Gradelevel
+ # Gradelevel
if (($type eq 'lowestgradelevel') ||
($type eq 'highestgradelevel')) {
return &Apache::loncommon::gradeleveldescription($value);
}
-# Only for advance users below
- unless ($ENV{'user.adv'}) { return '- '.&mt('not displayed').' -' };
-# File
+ # Only for advance users below
+ if (! $env{'user.adv'}) {
+ return '- '.&mt('not displayed').' -';
+ }
+ # File
if (($type eq 'customdistributionfile') ||
($type eq 'obsoletereplacement') ||
($type eq 'goto_list') ||
($type eq 'comefrom_list') ||
- ($type eq 'sequsage_list')) {
- return join('
',map {
- my $url=&Apache::lonnet::clutter($_);
- '
'.&Apache::lonnet::gettitle($url).''.
- &Apache::lonhtmlcommon::crumbs($url,'preview','');
- } split(/\s*\,\s*/,$value));
+ ($type eq 'sequsage_list') ||
+ ($type eq 'dependencies')) {
+ return ''.join("\n",map {
+ my $url = &Apache::lonnet::clutter($_);
+ my $title = &Apache::lonnet::gettitle($url);
+ if ($title eq '') {
+ $title = 'Untitled';
+ if ($url =~ /\.sequence$/) {
+ $title .= ' Sequence';
+ } elsif ($url =~ /\.page$/) {
+ $title .= ' Page';
+ } elsif ($url =~ /\.problem$/) {
+ $title .= ' Problem';
+ } elsif ($url =~ /\.html$/) {
+ $title .= ' HTML document';
+ } elsif ($url =~ m:/syllabus$:) {
+ $title .= ' Syllabus';
+ }
+ }
+ $_ = '- '.$title.' '.
+ &Apache::lonhtmlcommon::crumbs($url,$target,$prefix,$form,'-1',$noformat).
+ '
'
+ } split(/\s*\,\s*/,$value)).'
';
}
-# Evaluations
+ # Evaluations
if (($type eq 'clear') ||
($type eq 'depth') ||
($type eq 'helpful') ||
@@ -311,26 +450,40 @@ sub prettyprint {
($type eq 'technical')) {
return &evalgraph($value);
}
-# Difficulty
- if ($type eq 'difficulty') {
+ # Difficulty
+ if ($type eq 'difficulty' || $type eq 'disc') {
return &diffgraph($value);
}
-# List of courses
+ # List of courses
if ($type=~/\_list/) {
- return join('
',map {
- my %courseinfo=&Apache::lonnet::coursedescription($_);
- ''.
- $courseinfo{'description'}.'';
- } split(/\s*\,\s*/,$value));
+ my @Courses = split(/\s*\,\s*/,$value);
+ my $Str;
+ foreach my $course (@Courses) {
+ my %courseinfo = &Apache::lonnet::coursedescription($course);
+ if (! exists($courseinfo{'num'}) || $courseinfo{'num'} eq '') {
+ next;
+ }
+ if ($Str ne '') { $Str .= '
'; }
+ $Str .= ''.
+ $courseinfo{'description'}.'';
+ }
+ return $Str;
}
-# No pretty print found
+ # No pretty print found
return $value;
}
-# ============================================== Pretty input of metadata field
+
+# Pretty input of metadata field
+sub direct {
+ return shift;
+}
sub selectbox {
my ($name,$value,$functionref,@idlist)=@_;
+ if (! defined($functionref)) {
+ $functionref=\&direct;
+ }
my $selout='