# The LearningOnline Network with CAPA
# Metadata display handler
#
# $Id: lonmeta.pm,v 1.189 2006/11/20 20:58:30 banghart 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;
use lib '/home/httpd/lib/perl/';
use LONCAPA;
############################################################
############################################################
##
## &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 $query = 'SELECT * 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 %hash=&LONCAPA::lonmetadata::metadata_col_to_hash('metadata',
map { &unescape($_) } split(/\,/,$result));
foreach my $key (keys(%hash)) {
$ReturnHash{$hash{'url'}}->{$key}=$hash{$key};
}
}
$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 {
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');
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 &Apache::lonlocal::texthash(%fields);
}
sub portfolio_linked_path {
my ($path,$group,$port_path) = @_;
my $start = 'portfolio';
if ($group) {
$start = "groups/$group/".$start;
}
my %anchor_fields = (
'selectfile' => $start,
'currentpath' => '/'
);
my $result = &Apache::portfolio::make_anchor($port_path,\%anchor_fields,$start);
my $fullpath = '/';
my (undef,@tree) = split('/',$path);
my $filename = pop(@tree);
foreach my $dir (@tree) {
$fullpath .= $dir.'/';
$result .= '/';
my %anchor_fields = (
'selectfile' => $dir,
'currentpath' => $fullpath
);
$result .= &Apache::portfolio::make_anchor($port_path,\%anchor_fields,$dir);
}
$result .= "/$filename";
return $result;
}
sub get_port_path_and_group {
my ($uri)=@_;
my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
my ($port_path,$group);
if ($uri =~ m{^/editupload/\Q$cdom\E/\Q$cnum\E/groups/}) {
$group = (split('/',$uri))[5];
$port_path = '/adm/coursegrp_portfolio';
} else {
$port_path = '/adm/portfolio';
}
if ($env{'form.group'} ne $group) {
$env{'form.group'} = $group;
}
return ($port_path,$group);
}
sub portfolio_display_uri {
my ($uri,$as_links)=@_;
my ($port_path,$group) = &get_port_path_and_group($uri);
$uri =~ s|.*/(portfolio/.*)$|$1|;
my ($res_uri,$meta_uri) = ($uri,$uri);
if ($uri =~ /\.meta$/) {
$res_uri =~ s/\.meta//;
} else {
$meta_uri .= '.meta';
}
my ($path) = ($res_uri =~ m|^portfolio(.*/)[^/]*$|);
if ($as_links) {
$res_uri = &portfolio_linked_path($res_uri,$group,$port_path);
$meta_uri = &portfolio_linked_path($meta_uri,$group,$port_path);
}
return ($res_uri,$meta_uri,$path);
}
sub pre_select_course {
my ($r,$uri) = @_;
my $output;
my $fn=&Apache::lonnet::filelocation('',$uri);
my ($res_uri,$meta_uri,$path) = &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('');
my ($port_path,$group) = &get_port_path_and_group($uri);
my $group_input;
if ($group) {
$group_input = '';
}
$r->print('
');
return;
}
sub select_course {
my $output=$/;
my $current_restriction=
$Apache::lonpublisher::metadatafields{'courserestricted'};
my $selected = ($current_restriction eq 'none' ? 'selected="selected"'
: '');
$output .= ' ';
return ($output);
}
# 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 '
'.&mt('No Access or Usages Statistics are available for this resource.').'
');
}
#
# Assessment statistics
if ($uri=~/\.(problem|exam|quiz|assess|survey|form)$/) {
if (exists($dynmeta{'stdno'}) ||
exists($dynmeta{'avetries'}) ||
exists($dynmeta{'difficulty'}) ||
exists($dynmeta{'disc'})) {
# This is an assessment, print assessment data
$r->print('
');
foreach (sort(keys(%content))) {
my $name=$_;
if ($name!~/\.display$/) {
my $display=&Apache::lonnet::metadata($uri,
$name.'.display');
if (! $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("
");
return;
}
#####################################################
#####################################################
### ###
### Editable metadata display ###
### ###
#####################################################
#####################################################
sub present_editable_metadata {
my ($r,$uri,$file_type) = @_;
# Construction Space Call
# Header
my $disuri=$uri;
my $fn=&Apache::lonnet::filelocation('',$uri);
$disuri=~s{^/\~}{/priv/};
$disuri=~s/\.meta$//;
my $meta_uri = $disuri;
my $path;
if ($disuri =~ m|/portfolio/|) {
($disuri, $meta_uri, $path) = &portfolio_display_uri($disuri,1);
}
my $target=$uri;
$target=~s{^/\~}{/res/$env{'request.role.domain'}/};
$target=~s/\.meta$//;
my $bombs=&Apache::lonmsg::retrieve_author_res_msg($target);
if ($bombs) {
my $showdel=1;
if ($env{'form.delmsg'}) {
if (&Apache::lonmsg::del_url_author_res_msg($target) eq 'ok') {
$bombs=&mt('Messages deleted.');
$showdel=0;
} else {
$bombs=&mt('Error deleting messages');
}
}
if ($env{'form.clearmsg'}) {
my $cleardir=$target;
$cleardir=~s/\/[^\/]+$/\//;
if (&Apache::lonmsg::clear_author_res_msg($cleardir) eq 'ok') {
$bombs=&mt('Messages cleared.');
$showdel=0;
} else {
$bombs=&mt('Error clearing messages');
}
}
my $del=&mt('Delete Messages for this Resource');
my $clear=&mt('Clear all Messages in Subdirectory');
my $goback=&mt('Back to Source File');
$r->print(<$disuri