--- loncom/interface/lonmeta.pm 2001/08/10 17:16:06 1.6 +++ loncom/interface/lonmeta.pm 2004/04/14 18:30:36 1.68 @@ -1,111 +1,754 @@ # The LearningOnline Network with CAPA -# # Metadata display handler # -# (TeX Content Handler +# $Id: lonmeta.pm,v 1.68 2004/04/14 18:30:36 matthew 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. # -# 05/29/00,05/30,10/11 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 # -# 10/19,10/21,10/23,11/27 Gerd Kortemeyer +# /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; + + +# 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}; + } +} -# ================================================================ Main Handler +# 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'); + } +} -sub handler { - my $r=shift; - my %content=(); +# Author display +sub authordisplay { + my ($aname,$adom)=@_; + return &Apache::loncommon::aboutmewrapper + (&Apache::loncommon::plainname($aname,$adom), + $aname,$adom,'preview').' ['.$aname.'@'.$adom.']'; +} -# ----------------------------------------------------------- Set document type +# 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.='
          ('.$value.')
'; + return $output; +} - $r->content_type('text/html'); - $r->send_http_header; +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.='
   ('.$value.')
'; + return $output; +} - return OK if $r->header_only; - -# ------------------------------------------------------------------- Read file - - my $uri=$r->uri; - map { - $content{$_}=&Apache::lonnet::metadata($uri,$_); - } split(/\,/,&Apache::lonnet::metadata($uri,'keys')); - -# ------------------------------------------------------------------ Hide stuff - if (!$ENV{'user.adv'}) { - map { - $content{$_}='- not displayed -'; - } ('keywords','notes','abstract','subject'); - } - -# --------------------------------------------------------------- Render Output - -my $creationdate=localtime($content{'creationdate'}); -my $lastrevisiondate=localtime($content{'lastrevisiondate'}); - - $r->print(<Catalog Information - -

Catalog Information

-

$content{'title'}

-

Author(s): $content{'author'}

-Subject: $content{'subject'}
-Keyword(s): $content{'keywords'}
-Notes: $content{'notes'}
-Abstract: -
$content{'abstract'}
-
-MIME Type: $content{'mime'}
-Language: $content{'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'}); - map { - my $name=$_; - my $display=&Apache::lonnet::metadata($uri,$name.'.display'); - unless ($display) { $display=$name; }; - my $otherinfo=''; - map { - if (defined(&Apache::lonnet::metadata($uri,$name.'.'.$_))) { - $otherinfo.=' '.$_.'='. - &Apache::lonnet::metadata($uri,$name.'.'.$_).'; '; - } - } ('name','part','type','default'); - $r->print(''.$display.': '.$content{$name}); - if ($otherinfo) { - $r->print(' ('.$otherinfo.')'); - } - $r->print("
\n"); - } sort keys %content; - $r->print(''); - return OK; + +# 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', + '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' + ); } -1; -__END__ +# Pretty printing of metadata field +sub prettyprint { + my ($type,$value)=@_; + 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); + } + # 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')) { + return join('
',map { + my $url=&Apache::lonnet::clutter($_); + ''.&Apache::lonnet::gettitle($url).''. + &Apache::lonhtmlcommon::crumbs($url,'preview','',undef,'+0'); + } 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') { + return &diffgraph($value); + } + # List of courses + if ($type=~/\_list/) { + return join('
',map { + my %courseinfo=&Apache::lonnet::coursedescription($_); + ''. + $courseinfo{'description'}.''; + } split(/\s*\,\s*/,$value)); + } + # No pretty print found + return $value; +} +# Pretty input of metadata field +sub direct { + return shift; +} +sub selectbox { + my ($name,$value,$functionref,@idlist)=@_; + if (! defined($functionref)) { + $functionref=\&direct; + } + my $selout=''; +} + +sub relatedfield { + my ($show,$relatedsearchflag,$relatedsep,$fieldname,$relatedvalue)=@_; + if (! $relatedsearchflag) { + return ''; + } + if (! defined($relatedsep)) { + $relatedsep=' '; + } + if (! $show) { + return $relatedsep.' '; + } + return $relatedsep.''; +} +sub prettyinput { + my ($type,$value,$fieldname,$formname, + $relatedsearchflag,$relatedsep,$relatedvalue)=@_; + # Language + if ($type eq 'language') { + return &selectbox($fieldname, + $value, + \&Apache::loncommon::languagedescription, + (&Apache::loncommon::languageids)). + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # Copyright + if ($type eq 'copyright') { + return &selectbox($fieldname, + $value, + \&Apache::loncommon::copyrightdescription, + (&Apache::loncommon::copyrightids)). + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # Gradelevels + if (($type eq 'lowestgradelevel') || + ($type eq 'highestgradelevel')) { + return &Apache::loncommon::select_level_form($value,$fieldname). + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # Obsolete + if ($type eq 'obsolete') { + return ''. + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # Obsolete replacement file + if ($type eq 'obsoletereplacement') { + return '".&mt('Select').''. + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # Customdistribution file + if ($type eq 'customdistributionfile') { + return '".&mt('Select').''. + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # Dates + if (($type eq 'creationdate') || + ($type eq 'lastrevisiondate')) { + return + &Apache::lonhtmlcommon::date_setter($formname,$fieldname,$value). + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + # No pretty input found + $value=~s/^\s+//gs; + $value=~s/\s+$//gs; + $value=~s/\s+/ /gs; + $value=~s/\"/\&quod\;/gs; + return + ''. + &relatedfield(1,$relatedsearchflag,$relatedsep,$fieldname, + $relatedvalue); +} +# Main Handler +sub handler { + my $r=shift; + # + my $uri=$r->uri; + # + # Check to see if this server is overloaded + my $loaderror=&Apache::lonnet::overloaderror($r); + if ($loaderror) { + return $loaderror; + } + # + # Check to see if original resource server is overloaded + my ($resdomain,$resuser)= + (&Apache::lonnet::declutter($uri)=~/^(\w+)\/(\w+)\//); + $loaderror=&Apache::lonnet::overloaderror + ($r,&Apache::lonnet::homeserver($resuser,$resdomain)); + if ($loaderror) { + return $loaderror; + } + # + # Set document type + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + return OK if $r->header_only; + # + $r->print(''. + 'Catalog Information'. + ''); + if ($uri=~m:/adm/bombs/(.*)$:) { + $r->print(&Apache::loncommon::bodytag('Error Messages')); + # Looking for all bombs? + &report_bombs($r,$uri); + } elsif ($uri=~/^\/\~/) { + # Construction space + $r->print(&Apache::loncommon::bodytag + ('Edit Catalog Information','','','',$resdomain)); + &present_editable_metadata($r,$uri); + } else { + $r->print(&Apache::loncommon::bodytag + ('Catalog Information','','','',$resdomain)); + &present_uneditable_metadata($r,$uri); + } + $r->print(''); + return OK; +} +##################################################### +##################################################### +### ### +### Report Bombs ### +### ### +##################################################### +##################################################### +sub report_bombs { + my ($r,$uri) = @_; + # Set document type + $uri =~ s:/adm/bombs/::; + $uri = &Apache::lonnet::declutter($uri); + $r->print('

'.&Apache::lonnet::clutter($uri).'

'); + my ($domain,$author)=($uri=~/^(\w+)\/(\w+)\//); + if (&Apache::loncacc::constructaccess('/~'.$author.'/',$domain)) { + my %brokenurls = + &Apache::lonmsg::all_url_author_res_msg($author,$domain); + foreach (sort(keys(%brokenurls))) { + if ($_=~/^\Q$uri\E/) { + $r->print(&Apache::lonhtmlcommon::crumbs + (&Apache::lonnet::clutter($_)). + &Apache::lonmsg::retrieve_author_res_msg($_). + '
'); + } + } + } else { + $r->print(&mt('Not authorized')); + } + return; +} +##################################################### +##################################################### +### ### +### Uneditable Metadata Display ### +### ### +##################################################### +##################################################### +sub present_uneditable_metadata { + my ($r,$uri) = @_; + # + my %content=(); + # Read file + foreach (split(/\,/,&Apache::lonnet::metadata($uri,'keys'))) { + $content{$_}=&Apache::lonnet::metadata($uri,$_); + } + # Render Output + # displayed url + my ($thisversion)=($uri=~/\.(\d+)\.(\w+)\.meta$/); + $uri=~s/\.meta$//; + my $disuri=&Apache::lonnet::clutter($uri); + # version + my $currentversion=&Apache::lonnet::getversion($disuri); + my $versiondisplay=''; + if ($thisversion) { + $versiondisplay=&mt('Version').': '.$thisversion. + ' ('.&mt('most recent version').': '. + ($currentversion>0 ? + $currentversion : + &mt('information not available')).')'; + } else { + $versiondisplay='Version: '.$currentversion; + } + # crumbify displayed URL + $disuri=&Apache::lonhtmlcommon::crumbs($disuri); + # obsolete + my $obsolete=$content{'obsolete'}; + my $obsoletewarning=''; + if (($obsolete) && ($ENV{'user.adv'})) { + $obsoletewarning='

'. + &mt('This resource has been marked obsolete by the author(s)'). + '

'; + } + # + my %lt=&fieldnames(); + my $table=''; + foreach ('title', + 'author', + 'subject', + 'keywords', + 'notes', + 'abstract', + 'lowestgradelevel', + 'highestgradelevel', + 'standards', + 'mime', + 'language', + 'creationdate', + 'lastrevisiondate', + 'owner', + 'copyright', + 'customdistributionfile', + 'obsolete', + 'obsoletereplacement') { + $table.=''.$lt{$_}. + ''. + &prettyprint($_,$content{$_}).''; + delete $content{$_}; + } + # + $r->print(<$content{'title'} +

$disuri

+$obsoletewarning +$versiondisplay
+ +$table +
+ENDHEAD + if ($ENV{'user.adv'}) { + &print_dynamic_metadata($r,$uri,\%content); + } + return; +} + +sub print_dynamic_metadata { + my ($r,$uri,$content) = @_; + # + my %content = \$content; + my %lt=&fieldnames(); + # + my $description = 'Dynamic Metadata (updated periodically)'; + $r->print('

'.&mt($description).'

'. + &mt('Processing').' ...
'); + $r->rflush(); + my %items=&fieldnames(); + my %dynmeta=&dynamicmeta($uri); + # + # General Access and Usage Statistics + $r->print('

'.&mt('Access and Usage Statistics').'

'. + ''); + foreach ('count', + 'sequsage','sequsage_list', + 'comefrom','comefrom_list', + 'goto','goto_list', + 'course','course_list') { + $r->print(''. + '\n"); + } + $r->print('
'.$lt{$_}.''. + &prettyprint($_,$dynmeta{$_})."
'); + if ($uri=~/\.(problem|exam|quiz|assess|survey|form)$/) { + # This is an assessment, print assessment data + $r->print( + '

'.&mt('Assessment Statistical Data').'

'. + ''); + foreach ('stdno','avetries','difficulty') { + $r->print(''. + '\n"); + } + $r->print('
'.$lt{$_}.''. + &prettyprint($_,$dynmeta{$_})."
'); + } + + $r->print('

'.&mt('Evaluation Data').'

'. + ''); + foreach ('clear','depth','helpful','correct','technical') { + $r->print(''. + '\n"); + } + $r->print('
'.$lt{$_}.''. + &prettyprint($_,$dynmeta{$_})."
'); + $uri=~/^\/res\/(\w+)\/(\w+)\//; + if ((($ENV{'user.domain'} eq $1) && ($ENV{'user.name'} eq $2)) + || ($ENV{'user.role.ca./'.$1.'/'.$2})) { + $r->print('

'.&mt('Evaluation Comments').' ('. + &mt('visible to author and co-authors only'). + ')

'. + '
'.$dynmeta{'comments'}.'
'); + $r->print('

'.&mt('Error Messages').' ('. + &mt('visible to author and co-authors only').')'. + '

'. + &Apache::lonmsg::retrieve_author_res_msg($uri)); + } + # All other stuff + $r->print('

'. + &mt('Additional Metadata (non-standard, parameters, exports)'). + '

'); + 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"); + } + } + return; +} + +##################################################### +##################################################### +### ### +### Editable metadata display ### +### ### +##################################################### +##################################################### +sub present_editable_metadata { + my ($r,$uri) = @_; + # Construction Space Call + # Header + my $disuri=$uri; + my $fn=&Apache::lonnet::filelocation('',$uri); + $disuri=~s/^\/\~/\/priv\//; + $disuri=~s/\.meta$//; + my $target=$uri; + $target=~s/^\/\~/\/res\/$ENV{'request.role.domain'}\//; + $target=~s/\.meta$//; + my $bombs=&Apache::lonmsg::retrieve_author_res_msg($target); + if ($bombs) { + if ($ENV{'form.delmsg'}) { + if (&Apache::lonmsg::del_url_author_res_msg($target) eq 'ok') { + $bombs=&mt('Messages deleted.'); + } else { + $bombs=&mt('Error deleting messages'); + } + } + my $del=&mt('Delete Messages'); + $r->print(<$disuri +
+ +
$bombs +ENDBOMBS + } else { + my $displayfile='Catalog Information for '.$disuri; + if ($disuri=~/\/default$/) { + my $dir=$disuri; + $dir=~s/default$//; + $displayfile= + &mt('Default Cataloging Information for Directory').' '. + $dir; + } + my $bodytag= + &Apache::loncommon::bodytag('Edit Catalog Information'); + %Apache::lonpublisher::metadatafields=(); + %Apache::lonpublisher::metadatakeys=(); + &Apache::lonpublisher::metaeval(&Apache::lonnet::getfile($fn)); + $r->print(<Edit Catalog Information +$bodytag +

$displayfile

+ +ENDEDIT + $r->print(''); + my %lt=&fieldnames(); + foreach ('author','title','subject','keywords','abstract','notes', + 'copyright','customdistributionfile','language', + 'standards', + 'lowestgradelevel','highestgradelevel', + 'obsolete','obsoletereplacement') { + if (defined($ENV{'form.new_'.$_})) { + $Apache::lonpublisher::metadatafields{$_}= + $ENV{'form.new_'.$_}; + } + if (! $Apache::lonpublisher::metadatafields{'copyright'}) { + $Apache::lonpublisher::metadatafields{'copyright'}= + 'default'; + } + $r->print('

'.$lt{$_}.': '. + &prettyinput + ($_,$Apache::lonpublisher::metadatafields{$_}, + 'new_'.$_,'defaultmeta').'

'); + } + if ($ENV{'form.store'}) { + my $mfh; + if (! ($mfh=Apache::File->new('>'.$fn))) { + $r->print('

'. + &mt('Could not write metadata').', '. + &mt('FAIL').''); + } else { + foreach (sort keys %Apache::lonpublisher::metadatafields) { + next if ($_ =~ /\./); + my $unikey=$_; + $unikey=~/^([A-Za-z]+)/; + my $tag=$1; + $tag=~tr/A-Z/a-z/; + print $mfh "\n\<$tag"; + foreach (split(/\,/, + $Apache::lonpublisher::metadatakeys{$unikey}) + ) { + my $value= + $Apache::lonpublisher::metadatafields{$unikey.'.'.$_}; + $value=~s/\"/\'\'/g; + print $mfh ' '.$_.'="'.$value.'"'; + } + print $mfh '>'. + &HTML::Entities::encode + ($Apache::lonpublisher::metadatafields{$unikey}, + '<>&"'). + ''; + } + $r->print('

'.&mt('Wrote Metadata')); + } + } + $r->print('
'); + } + $r->print('

'); + return; +} + +1; +__END__