--- loncom/interface/lonmeta.pm 2001/08/10 17:20:19 1.7
+++ loncom/interface/lonmeta.pm 2023/11/07 21:31:11 1.257
@@ -1,114 +1,1921 @@
# The LearningOnline Network with CAPA
-#
# Metadata display handler
#
-# (TeX Content Handler
+# $Id: lonmeta.pm,v 1.257 2023/11/07 21:31:11 raeburn 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.
#
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
+# 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.
#
-# 10/19,10/21,10/23,11/27,08/09/01 Gerd Kortemeyer
+# 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::lonnet;
+use Apache::loncommon();
+use Apache::lonhtmlcommon();
+use Apache::lonmsg;
+use Apache::lonpublisher;
+use Apache::lonlocal;
+use Apache::lonmysql;
+use Apache::lonmsg;
+use LONCAPA qw(:DEFAULT :match);
+
+
+sub get_dynamic_metadata_from_sql {
+ my ($url) = shift();
+ my ($authordom,$author)=($url=~m{^/res/($match_domain)/($match_username)/});
+ 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=~/^($match_domain)\/($match_username)\//);
+ 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.='
'.(' ' x2).'
';
+ } else {
+ $output.='
'.
+ '
';
+ }
+ $output.='
';
+ if ($val>20) {
+ $output.='
'.
+ '
';
+ } else {
+ $output.='
'.(' ' x2).'
';
+ }
+ $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' && $file_type ne 'groups') ) {
+ %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' => 'Statistics calculated for number of students',
+ '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"'
+ : '');
+ if ($current_restriction =~ /^course\.($match_domain\_$match_courseid)$/) {
+ my $assoc_crs = $1;
+ my $added_metadata_fields = &Apache::lonparmset::get_added_meta_fieldnames($assoc_crs);
+ if (ref($added_metadata_fields) eq 'HASH') {
+ if (keys(%{$added_metadata_fields}) > 0) {
+ my $transfernotes;
+ foreach my $field_name (keys(%{$added_metadata_fields})) {
+ my $value = $Apache::lonpublisher::metadatafields{$field_name};
+ if ($value) {
+ $transfernotes .=
+ &Apache::loncommon::start_data_table_row().
+ '
'.
+ $field_name.'
'.$value.'
'.
+ &Apache::loncommon::end_data_table_row();
+ }
+ }
+ if ($transfernotes ne '') {
+ my %courseinfo = &Apache::lonnet::coursedescription($assoc_crs,{'one_time' => 1});
+ my $assoc_crs_description = $courseinfo{'description'};
+ $output .= &mt('This resource is currently associated with a course ([_1]) which includes added metadata fields specific to the course.',$assoc_crs_description).' '."\n".
+ &mt('You can choose to transfer data from the added fields to the "Notes" field if you are planning to change the course association.').'