--- loncom/interface/lonmeta.pm 2002/03/29 18:44:41 1.15
+++ loncom/interface/lonmeta.pm 2005/03/17 21:32:17 1.94
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Metadata display handler
#
-# $Id: lonmeta.pm,v 1.15 2002/03/29 18:44:41 www Exp $
+# $Id: lonmeta.pm,v 1.94 2005/03/17 21:32:17 banghart Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -24,285 +24,1001 @@
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
-#
-# (TeX Content Handler
-#
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
-#
-# 10/19,10/21,10/23,11/27,08/09/01,12/22,12/24,12/25 Gerd Kortemeyer
+
package Apache::lonmeta;
use strict;
+use LONCAPA::lonmetadata();
use Apache::Constants qw(:common);
use Apache::lonnet();
use Apache::loncommon();
+use Apache::lonhtmlcommon();
+use Apache::lonmsg;
+use Apache::lonpublisher;
+use Apache::lonlocal;
+use Apache::lonmysql;
+use Apache::lonmsg;
+
+
+############################################################
+############################################################
+##
+## &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$//;
my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);
- my $regexp=&Apache::lonnet::escape($url);
+ my $regexp=$url;
$regexp=~s/(\W)/\\$1/g;
$regexp='___'.$regexp.'___';
- my %evaldata=&Apache::lonnet::dump
- ('resevaldata',$adomain,$aauthor,$regexp);
- my %sum;
- my %cnt;
- my %listitems=('count' => 'add',
- 'course' => 'add',
- 'avetries' => 'avg',
- 'stdno' => 'add',
- 'difficulty' => 'avg',
- 'clear' => 'avg',
- 'technical' => 'avg',
- 'helpful' => 'avg',
- 'correct' => 'avg',
- 'depth' => 'avg',
- 'comments' => 'app',
- 'usage' => 'cnt'
- );
- foreach (keys %evaldata) {
- $_=~/___(\w+)$/;
- if (defined($cnt{$1})) { $cnt{$1}++; } else { $cnt{$1}=1; }
- unless ($listitems{$1} eq 'app') {
- if (defined($sum{$1})) {
- $sum{$1}+=$evaldata{$_};
- } else {
- $sum{$1}=$evaldata{$_};
- }
- } else {
- if (defined($sum{$1})) {
- if ($evaldata{$_}) {
- $sum{$1}.='
'.$evaldata{$_};
- }
- } else {
- $sum{$1}=''.$evaldata{$_};
- }
- }
+ my %evaldata=&Apache::lonnet::dump('nohist_resevaldata',$adomain,
+ $aauthor,$regexp);
+ my %DynamicData = &LONCAPA::lonmetadata::process_reseval_data(\%evaldata);
+ my %Data = &LONCAPA::lonmetadata::process_dynamic_metadata($url,
+ \%DynamicData);
+ #
+ # Deal with 'count' separately
+ $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('-------------------');
}
- my %returnhash=();
- 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{$_};
- }
+ return %Data;
+}
+
+sub access_count {
+ my ($src,$author,$adomain) = @_;
+ my %countdata=&Apache::lonnet::dump('nohist_accesscount',$adomain,
+ $author,$src);
+ if (! exists($countdata{$src})) {
+ return &mt('Not Available');
+ } else {
+ return $countdata{$src};
+ }
+}
+
+# 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');
+ $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');
}
- return %returnhash;
}
-# -------------------------------------------------------------- Pretty display
+# Author display
+sub authordisplay {
+ my ($aname,$adom)=@_;
+ return &Apache::loncommon::aboutmewrapper
+ (&Apache::loncommon::plainname($aname,$adom),
+ $aname,$adom,'preview').' ['.$aname.'@'.$adom.']';
+}
+# 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;
}
-# ================================================================ Main Handler
-sub handler {
- my $r=shift;
- my %content=();
+# 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',
+ 'keywords' => 'Keyword(s)',
+ 'notes' => 'Notes',
+ 'abstract' => 'Abstract',
+ 'lowestgradelevel' => 'Lowest Grade Level',
+ 'highestgradelevel' => 'Highest Grade Level');
+ if (! defined($file_type) || $file_type ne 'portfolio') {
+ %fields =
+ (%fields,
+ 'domain' => 'Domain',
+ 'standards' => 'Standards',
+ '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 &Apache::lonlocal::texthash(%fields);
+}
-# ----------------------------------------------------------- Set document type
+# Pretty printing of metadata field
- $r->content_type('text/html');
- $r->send_http_header;
+sub prettyprint {
+ 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
+ if (($type eq 'creationdate') ||
+ ($type eq 'lastrevisiondate')) {
+ return ($value?&Apache::lonlocal::locallocaltime(
+ &Apache::lonmysql::unsqltime($value)):
+ &mt('not available'));
+ }
+ # Language
+ if ($type eq 'language') {
+ return &Apache::loncommon::languagedescription($value);
+ }
+ # Copyright
+ if ($type eq 'copyright') {
+ return &Apache::loncommon::copyrightdescription($value);
+ }
+ # Copyright
+ if ($type eq 'sourceavail') {
+ return &Apache::loncommon::source_copyrightdescription($value);
+ }
+ # MIME
+ if ($type eq 'mime') {
+ return ' '.
+ &Apache::loncommon::filedescription($value);
+ }
+ # Person
+ if (($type eq 'author') ||
+ ($type eq 'owner') ||
+ ($type eq 'modifyinguser') ||
+ ($type eq 'authorspace')) {
+ $value=~s/(\w+)(\:|\@)(\w+)/&authordisplay($1,$3)/gse;
+ return $value;
+ }
+ # Gradelevel
+ if (($type eq 'lowestgradelevel') ||
+ ($type eq 'highestgradelevel')) {
+ return &Apache::loncommon::gradeleveldescription($value);
+ }
+ # 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') ||
+ ($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
+ if (($type eq 'clear') ||
+ ($type eq 'depth') ||
+ ($type eq 'helpful') ||
+ ($type eq 'correct') ||
+ ($type eq 'technical')) {
+ return &evalgraph($value);
+ }
+ # Difficulty
+ if ($type eq 'difficulty' || $type eq 'disc') {
+ return &diffgraph($value);
+ }
+ # List of courses
+ if ($type=~/\_list/) {
+ 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
+ return $value;
+}
- return OK if $r->header_only;
-
-# ------------------------------------------------------------------- Read file
-
- my $uri=$r->uri;
- foreach (split(/\,/,&Apache::lonnet::metadata($uri,'keys'))) {
- $content{$_}=&Apache::lonnet::metadata($uri,$_);
- }
-
-# ------------------------------------------------------------------ Hide stuff
-
- unless ($ENV{'user.adv'}) {
- foreach ('keywords','notes','abstract','subject') {
- $content{$_}='- not displayed -';
- }
- }
-
-# --------------------------------------------------------------- Render Output
-
-my $creationdate=localtime($content{'creationdate'});
-my $lastrevisiondate=localtime($content{'lastrevisiondate'});
-my $language=&Apache::loncommon::languagedescription($content{'language'});
-my $mime=&Apache::loncommon::filedescription($content{'mime'});
-my $disuri=&Apache::lonnet::declutter($uri);
- $disuri=~s/\.meta$//;
- $r->print(<Catalog Information
-
-Catalog Information
-$content{'title'}
-$disuri
-
-Author(s) |
-$content{'author'} |
-Subject |
-$content{'subject'} |
-Keyword(s) |
-$content{'keywords'} |
-Notes |
-$content{'notes'} |
-Abstract |
-$content{'abstract'} |
-MIME Type |
-$mime ($content{'mime'}) |
-Language |
-$language |
-Creation Date |
-$creationdate |
-
-Last Revision Date | $lastrevisiondate |
-Publisher/Owner |
-$content{'owner'} |
-Copyright/Distribution |
-$content{'copyright'}
- |
-ENDHEAD
- delete($content{'title'});
- delete($content{'author'});
- delete($content{'subject'});
- delete($content{'keywords'});
- delete($content{'notes'});
- delete($content{'abstract'});
- delete($content{'mime'});
- delete($content{'language'});
- delete($content{'creationdate'});
- delete($content{'lastrevisiondate'});
- delete($content{'owner'});
- delete($content{'copyright'});
- if ($ENV{'user.adv'}) {
-# ------------------------------------------------------------ Dynamic Metadata
- $r->print(
- 'Dynamic Metadata (updated periodically)
Processing ...
');
- $r->rflush();
- my %items=(
- 'count' => 'Network-wide number of accesses (hits)',
- 'course' => 'Network-wide number of courses using resource',
- 'usage' => 'Number of resources using or importing resource',
- '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');
- my %dynmeta=&dynamicmeta($uri);
- $r->print(
-'Access and Usage Statistics
');
- foreach ('count','usage','course') {
- $r->print(
-''.$items{$_}.' | '.
-$dynmeta{$_}." |
\n");
- }
- $r->print('
');
- if ($uri=~/\.(problem|exam|quiz|assess|survey|form)\.meta$/) {
- $r->print(
-'Assessment Statistical Data
');
- foreach ('stdno','avetries') {
- $r->print(
-''.$items{$_}.' | '.
-$dynmeta{$_}." |
\n");
- }
- foreach ('difficulty') {
- $r->print(
-''.$items{$_}.' | '.
-&diffgraph($dynmeta{$_})." |
\n");
- }
- $r->print('
');
- }
- $r->print('Evaluation Data
');
- foreach ('clear','depth','helpful','correct','technical') {
- $r->print(
-''.$items{$_}.' | '.
-&evalgraph($dynmeta{$_})." |
\n");
- }
- $r->print('
');
- $disuri=~/^(\w+)\/(\w+)\//;
- if ((($ENV{'user.domain'} eq $1) && ($ENV{'user.name'} eq $2))
- || ($ENV{'user.role.ca./'.$1.'/'.$2})) {
- $r->print(
- 'Evaluation Comments (visible to author and co-authors only)
'.
- ''.$dynmeta{'comments'}.'
');
- }
-# ------------------------------------------------------------- All other stuff
- $r->print(
- 'Additional Metadata (non-standard, parameters, exports)
');
- foreach (sort keys %content) {
- my $name=$_;
- my $display=&Apache::lonnet::metadata($uri,$name.'.display');
- unless ($display) { $display=$name; };
- my $otherinfo='';
- foreach ('name','part','type','default') {
- if (defined(&Apache::lonnet::metadata($uri,$name.'.'.$_))) {
- $otherinfo.=' '.$_.'='.
- &Apache::lonnet::metadata($uri,$name.'.'.$_).'; ';
- }
- }
- $r->print(''.$display.': '.$content{$name});
- if ($otherinfo) {
- $r->print(' ('.$otherinfo.')');
- }
- $r->print("
\n");
- }
- }
- $r->print('