--- loncom/interface/lonmeta.pm 2000/10/21 10:46:35 1.1 +++ loncom/interface/lonmeta.pm 2003/12/28 20:12:59 1.44 @@ -1,85 +1,346 @@ # The LearningOnline Network with CAPA -# # Metadata display handler # -# (TeX Content Handler +# $Id: lonmeta.pm,v 1.44 2003/12/28 20:12:59 www 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 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 Apache::File; use Apache::Constants qw(:common); -use HTML::TokeParser; +use Apache::lonnet(); +use Apache::loncommon(); +use Apache::lonmsg; +use Apache::lonpublisher; +use Apache::lonlocal; +use Apache::lonmysql; + +# MySQL table columns + +my @columns; + +# ----------------------------------------- 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 %sum=(); + my %cnt=(); + my %concat=(); + my %listitems=( + 'course' => 'add', + 'goto' => 'add', + 'comefrom' => 'add', + 'avetries' => 'avg', + 'stdno' => 'add', + 'difficulty' => 'avg', + 'clear' => 'avg', + 'technical' => 'avg', + 'helpful' => 'avg', + 'correct' => 'avg', + 'depth' => 'avg', + 'comments' => 'app', + 'usage' => 'cnt' + ); + while ($_=each(%evaldata)) { + my ($item,$purl,$cat)=split(/___/,$_); + ### Apache->request->print("\n".$_.' - '.$item.'
'); + if (defined($cnt{$cat})) { $cnt{$cat}++; } else { $cnt{$cat}=1; } + unless ($listitems{$cat} eq 'app') { + if (defined($sum{$cat})) { + $sum{$cat}+=$evaldata{$_}; + $concat{$cat}.=','.$item; + } else { + $sum{$cat}=$evaldata{$_}; + $concat{$cat}=$item; + } + } else { + if (defined($sum{$cat})) { + if ($evaldata{$_}) { + $sum{$cat}.='
'.$evaldata{$_}; + } + } else { + $sum{$cat}=''.$evaldata{$_}; + } + } + } + my %returnhash=(); + while ($_=each(%cnt)) { + if ($listitems{$_} eq 'avg') { + $returnhash{$_}=int(($sum{$_}/$cnt{$_})*100.0+0.5)/100.0; + } elsif ($listitems{$_} eq 'cnt') { + $returnhash{$_}=$cnt{$_}; + } else { + $returnhash{$_}=$sum{$_}; + } + $returnhash{$_.'_list'}=$concat{$_}; + ### Apache->request->print("\n
".$_.': '.$returnhash{$_}.'
'.$returnhash{$_.'_list'}); + } + # + # Deal with 'count' seperately + $returnhash{'count'} = &access_count($url,$aauthor,$adomain); + return %returnhash; +} -# ================================================= Unpack metadata into a hash +sub access_count { + my ($src,$author,$adomain) = @_; + my %countdata=&Apache::lonnet::dump('nohist_accesscount',$adomain, + $author,$src); + if (! exists($countdata{$src})) { + return 'Not Available'; + } else { + return $countdata{$src}; + } +} -sub unpackagemeta { - my ($datastring,$fordisplay)=@_; - my %content=(); - my $parser=HTML::TokeParser->new(\$datastring); - my $token; - while ($token=$parser->get_token) { - if ($token->[0] eq 'S') { - my $entry=$token->[1]; - my $value=$parser->get_text('/'.$entry); - if (($token->[2]->{'display'}) && ($fordisplay)) { - $value.='__dis__'.$token->[2]->{'display'}; - } - $content{$entry}=$value; - } +# ------------------------------------- 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 'No information available'; } +} + +# -------------------------------------------------------------- Author display + +sub authordisplay { + my ($aname,$adom)=@_; + return &Apache::loncommon::aboutmewrapper( + &Apache::loncommon::plainname($aname,$adom), + $aname,$adom).' ['.$aname.'@'.$adom.']'; +} + +# -------------------------------------------------------------- Pretty display + +sub evalgraph { + my $value=shift; + unless ($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; +} + +sub diffgraph { + my $value=shift; + unless ($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; +} + +# ==================================================== Turn MySQL row into hash + +sub metadata_col_to_hash { + my @cols=@_; + my %hash=(); + for (my $i=0; $i<=$#columns; $i++) { + $hash{$columns[$i]}=$cols[$i]; } - return %content; + return %hash; } # ================================================================ Main Handler sub handler { my $r=shift; - my @metacontents; - my %content; + + my $loaderror=&Apache::lonnet::overloaderror($r); + if ($loaderror) { return $loaderror; } + + + my $uri=$r->uri; + + unless ($uri=~/^\/\~/) { +# =========================================== This is not in construction space + my ($resdomain,$resuser)= + (&Apache::lonnet::declutter($uri)=~/^(\w+)\/(\w+)\//); + + $loaderror= + &Apache::lonnet::overloaderror($r, + &Apache::lonnet::homeserver($resuser,$resdomain)); + if ($loaderror) { return $loaderror; } + + my %content=(); # ----------------------------------------------------------- Set document type - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; # ------------------------------------------------------------------- Read file - - { - my $fh=Apache::File->new($r->filename); - @metacontents=<$fh>; + foreach (split(/\,/,&Apache::lonnet::metadata($uri,'keys'))) { + $content{$_}=&Apache::lonnet::metadata($uri,$_); } +# ------------------------------------------------------------------ Hide stuff - %content=&unpackagemeta(join("\n",@metacontents),1); + unless ($ENV{'user.adv'}) { + foreach ('keywords','notes','abstract','subject') { + $content{$_}='- '.&mt('not displayed').' -'; + } + } # --------------------------------------------------------------- Render Output - + my ($thisversion)=($uri=~/\.(\d+)\.(\w+)\.meta$/); +my $creationdate=&Apache::lonlocal::locallocaltime( + &Apache::lonmysql::unsqltime($content{'creationdate'})); +my $lastrevisiondate=&Apache::lonlocal::locallocaltime( + &Apache::lonmysql::unsqltime($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$//; +my $currentversion=&Apache::lonnet::getversion($disuri); +my $author=$content{'author'}; +$author=~s/(\w+)(\:|\@)(\w+)/&authordisplay($1,$3)/gse; +my $owner=$content{'owner'}; +$owner=~s/(\w+)(\:|\@)(\w+)/&authordisplay($1,$3)/gse; +my $versiondisplay=''; +if ($thisversion) { + $versiondisplay=&mt('Version').': '.$thisversion. + ' ('.&mt('most recent version').': '.$currentversion.')'; +} else { + $versiondisplay='Version: '.$currentversion; +} +my $customdistributionfile=''; +if ($content{'customdistributionfile'}) { + $customdistributionfile=''.$content{'customdistributionfile'}.''; +} + +my $obsolete=$content{'obsolete'}; +my $obsoletereplace=$content{'obsoletereplacement'}; +my $obsoletewarning=''; +if (($obsolete) && ($ENV{'user.adv'})) { + $obsoletewarning='

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

'; +} + +my %lt=&Apache::lonlocal::texthash( + 'au' =>'Author(s)', + 'sb' => 'Subject', + 'kw' => 'Keyword(s)', + 'no' => 'Notes', + 'ab' => 'Abstract', + 'lg' => 'Lowest Grade Level', + 'hg' => 'Highest Grade Level', + 'st' => 'Standards', + 'mi' => 'MIME Type', + 'la' => 'Language', + 'cd' => 'Creation Date', + 'pu' => 'Publisher/Owner', + 'co' => 'Copyright/Distribution', + 'cf' => 'Custom Distribution File', + 'ob' => 'Obsolete', + 'or' => + 'Suggested Replacement for Obsolete File'); +my $bodytag=&Apache::loncommon::bodytag + ('Catalog Information','','','',$resdomain); $r->print(<Catalog Information - -

Catalog Information

+$bodytag

$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: $content{'creationdate'}
-Last Revision Date: $content{'lastrevisiondate'}
-Publisher/Owner: $content{'owner'}
-Copyright/Distribution: $content{'copyright'} -
+

$disuri

+$obsoletewarning +$versiondisplay
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$lt{'au'}$author 
$lt{'sb'}$content{'subject'} 
$lt{'kw'}$content{'keywords'} 
$lt{'no'}$content{'notes'} 
$lt{'ab'}$content{'abstract'} 
$lt{'lg'}$content{'lowestgradelevel'} 
$lt{'hg'}$content{'highestgradelevel'} 
$lt{'st'}$content{'standards'} 
$lt{'mi'}$mime ($content{'mime'}) 
$lt{'la'}$language 
$lt{'cd'}$creationdate 
+Last Revision Date$lastrevisiondate 
$lt{'pu'}$owner 
$lt{'co'}$content{'copyright'} 
$lt{'cf'}$customdistributionfile 
$lt{'ob'}$obsolete 
$lt{'or'}$obsoletereplace 
ENDHEAD delete($content{'title'}); delete($content{'author'}); @@ -93,15 +354,217 @@ ENDHEAD delete($content{'lastrevisiondate'}); delete($content{'owner'}); delete($content{'copyright'}); - map { - my ($value,$name)=split(/\_\_dis\_\_/,$content{$_}); - unless ($name) { $name=$_; } - $r->print(''.$name.': '.$value.'
'); - } sort keys %content; - $r->print(''); - return OK; + delete($content{'customdistributionfile'}); + delete($content{'obsolete'}); + delete($content{'obsoletereplacement'}); + if ($ENV{'user.adv'}) { +# ------------------------------------------------------------ Dynamic Metadata + $r->print( + '

'.&mt('Dynamic Metadata').' ('. + &mt('updated periodically').')

'.&mt('Processing'). + ' ...
'); + $r->rflush(); + my %items=&Apache::lonlocal::texthash( + 'count' => 'Network-wide number of accesses (hits)', + 'course' => 'Network-wide number of courses using resource', + 'usage' => 'Number of resources using or importing resource', + 'goto' => 'Number of resources that follow this resource in maps', + 'comefrom' => 'Number of 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'); + my %dynmeta=&dynamicmeta($uri); + $r->print( +'

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

'); + foreach ('count') { + $r->print( +'\n"); + } + foreach my $cat ('usage','comefrom','goto') { + $r->print( +'\n"); + } + foreach my $cat ('course') { + $r->print( +'\n"); + } + $r->print('
'.$items{$_}.''. +$dynmeta{$_}." 
'.$items{$cat}.''. +$dynmeta{$cat}.'
'.$items{$cat}.''. +$dynmeta{$cat}.'
'); + if ($uri=~/\.(problem|exam|quiz|assess|survey|form)\.meta$/) { + $r->print( +'

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

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

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

'); + foreach ('clear','depth','helpful','correct','technical') { + $r->print( +'\n"); + } + $r->print('
'.$items{$_}.''. +&evalgraph($dynmeta{$_})."
'); + $disuri=~/^(\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').')

'); + my %errormsgs=&Apache::lonnet::dump('nohist_res_msgs',$1,$2); + foreach (keys %errormsgs) { + if ($_=~/^\Q$disuri\E\_\d+$/) { + my %content=&Apache::lonmsg::unpackagemsg($errormsgs{$_}); + $r->print(''.$content{'time'}.': '.$content{'message'}. + '
'); + } + } + } +# ------------------------------------------------------------- All other stuff + $r->print( + '

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

'); + foreach (sort keys %content) { + my $name=$_; + unless ($name=~/\.display$/) { + 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"); + } + } + } +# ===================================================== End Resource Space Call + } else { +# ===================================================== Construction Space Call + +# ----------------------------------------------------------- Set document type + + $r->content_type('text/html'); + $r->send_http_header; + + return OK if $r->header_only; +# ---------------------------------------------------------------------- Header + my $bodytag=&Apache::loncommon::bodytag('Edit Catalog Information'); + my $disuri=$uri; + my $fn=&Apache::lonnet::filelocation('',$uri); + $disuri=~s/^\/\~\w+//; + $disuri=~s/\.meta$//; + my $displayfile='Catalog Information for '.$disuri; + if ($disuri=~/\/default$/) { + my $dir=$disuri; + $dir=~s/default$//; + $displayfile=&mt('Default Cataloging Information for Directory').' '. + $dir; + } + %Apache::lonpublisher::metadatafields=(); + %Apache::lonpublisher::metadatakeys=(); + &Apache::lonpublisher::metaeval(&Apache::lonnet::getfile($fn)); + $r->print(<Edit Catalog Information +$bodytag +

$displayfile

+
+ENDEDIT + foreach ('author','title','subject','keywords','abstract','notes', + 'copyright','customdistributionfile','language', + 'obsolete','obsoletereplacement') { + if ($ENV{'form.new_'.$_}) { + $Apache::lonpublisher::metadatafields{$_}=$ENV{'form.new_'.$_}; + } + if (m/copyright/) { + $r->print(&Apache::lonpublisher::selectbox($_,'new_'.$_, + ($Apache::lonpublisher::metadatafields{$_}? + $Apache::lonpublisher::metadatafields{$_}:'default'), + \&Apache::loncommon::copyrightdescription, + (&Apache::loncommon::copyrightids))); + } elsif (m/language/) { + $r->print(&Apache::lonpublisher::selectbox($_,'new_'.$_, + $Apache::lonpublisher::metadatafields{$_}, + \&Apache::loncommon::languagedescription, + (&Apache::loncommon::languageids))); + } else { + $r->print(&Apache::lonpublisher::textfield($_,'new_'.$_, + $Apache::lonpublisher::metadatafields{$_})); + } + } + if ($ENV{'form.store'}) { + my $mfh; + unless ($mfh=Apache::File->new('>'.$fn)) { + $r->print( + '

'.&mt('Could not write metadata').', '. + &mt('FAIL').''); + } else { + foreach (sort keys %Apache::lonpublisher::metadatafields) { + unless ($_=~/\./) { + 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( + '

'); + return OK; + } } +# ================================================================= BEGIN Block +BEGIN { +# Get columns of MySQL metadata table + @columns=&Apache::lonmysql::col_order('metadata'); +} 1; __END__