# The LearningOnline Network with CAPA
# Metadata display handler
#
# $Id: lonmeta.pm,v 1.85 2004/08/03 15:56:18 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# 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
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
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
sub dynamicmeta {
my $url=&Apache::lonnet::declutter(shift);
$url=~s/\.meta$//;
my ($adomain,$aauthor)=($url=~/^(\w+)\/(\w+)\//);
my $regexp=$url;
$regexp=~s/(\W)/\\$1/g;
$regexp='___'.$regexp.'___';
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('-------------------');
}
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');
}
}
# 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;
if (! $value) {
return '';
}
my $val=int($value*10.+0.5)-10;
my $output='
';
if ($val>=20) {
$output.='
 
';
} else {
$output.='
'.
'
';
}
$output.='
';
if ($val>20) {
$output.='
'.
'
';
} else {
$output.='
 
';
}
$output.='
('.sprintf("%5.2f",$value).')
';
return $output;
}
sub diffgraph {
my $value=shift;
if (! $value) {
return '';
}
my $val=int(40.0*$value+0.5);
my @colors=('#FF9933','#EEAA33','#DDBB33','#CCCC33',
'#BBDD33','#CCCC33','#DDBB33','#EEAA33');
my $output='
';
for (my $i=0;$i<8;$i++) {
if ($val>$i*5) {
$output.='
';
} else {
$output.='
';
}
}
$output.='
('.sprintf("%3.2f",$value).')
';
return $output;
}
# The field names
sub fieldnames {
return &Apache::lonlocal::texthash
(
'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',
'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',
);
}
# Pretty printing of metadata field
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 '