File:  [LON-CAPA] / loncom / interface / lonmeta.pm
Revision 1.33: download - view: text, annotated - select for diffs
Tue Jul 15 19:04:31 2003 UTC (20 years, 9 months ago) by www
Branches: MAIN
CVS tags: version_1_0_3, version_1_0_2, version_1_0_1, version_1_0_0, version_0_99_5, version_0_99_4, HEAD
Display cleanup.

# The LearningOnline Network with CAPA
# Metadata display handler
#
# $Id: lonmeta.pm,v 1.33 2003/07/15 19:04:31 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.
#
# 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/
#
# (TeX Content Handler
#
# 05/29/00,05/30,10/11 Gerd Kortemeyer)
#
# 10/19,10/21,10/23,11/27,08/09/01,12/22,12/24,12/25 Gerd Kortemeyer

package Apache::lonmeta;

use strict;
use Apache::Constants qw(:common);
use Apache::lonnet();
use Apache::loncommon();
use Apache::lonmsg;
use Apache::lonpublisher;

# ----------------------------------------- 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=('count'        => 'add',
                   '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'
                   );
    foreach (keys %evaldata) {
	my ($item,$purl,$cat)=split(/\_\_\_/,$_);
###	print "\n".$_.' - '.$item.'<br />';
        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}.='<hr>'.$evaldata{$_};
	       }
 	    } else {
	       $sum{$cat}=''.$evaldata{$_};
	    }
	}
    }
    my %returnhash=();
    foreach (keys %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{$_};
### print "\n<hr />".$_.': '.$returnhash{$_}.'<br />'.$returnhash{$_.'_list'};
    }
    return %returnhash;
}

# ------------------------------------- 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).' <tt>['.$aname.'@'.$adom.']</tt>';
}

# -------------------------------------------------------------- Pretty display

sub evalgraph {
    my $value=shift;
    unless ($value) { return ''; }
    my $val=int($value*10.+0.5)-10;
    my $output='<table border=0 cellpadding=0 cellspacing=0><tr>';
    if ($val>=20) {
	$output.='<td width=20 bgcolor="#555555">&nbsp&nbsp;</td>';
    } else {
        $output.='<td width='.($val).' bgcolor="#555555">&nbsp;</td>'.
                 '<td width='.(20-$val).' bgcolor="#FF3333">&nbsp;</td>';
    }
    $output.='<td bgcolor="#FFFF33">&nbsp;</td>';
    if ($val>20) {
	$output.='<td width='.($val-20).' bgcolor="#33FF33">&nbsp;</td>'.
                 '<td width='.(40-$val).' bgcolor="#555555">&nbsp;</td>';
    } else {
       $output.='<td width=20 bgcolor="#555555">&nbsp&nbsp;</td>';
    }
    $output.='<td> ('.$value.') </td></tr></table>';
    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='<table border=0 cellpadding=0 cellspacing=0><tr>';
    for (my $i=0;$i<8;$i++) {
	if ($val>$i*5) {
            $output.='<td width=5 bgcolor="'.$colors[$i].'">&nbsp;</td>';
        } else {
	    $output.='<td width=5 bgcolor="#555555">&nbsp;</td>';
	}
    }
    $output.='<td> ('.$value.') </td></tr></table>';
    return $output;
}

# ================================================================ Main Handler

sub handler {
  my $r=shift;

    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');
  $r->send_http_header;

  return OK if $r->header_only;

# ------------------------------------------------------------------- Read file
  foreach (split(/\,/,&Apache::lonnet::metadata($uri,'keys'))) {
      $content{$_}=&Apache::lonnet::metadata($uri,$_);
  }
# ------------------------------------------------------------------ Hide stuff

  unless ($ENV{'user.adv'}) {
      foreach ('keywords','notes','abstract','subject') {
          $content{$_}='<i>- not displayed -</i>';
      }
  }

# --------------------------------------------------------------- Render Output
  my ($thisversion)=($uri=~/\.(\d+)\.(\w+)\.meta$/);
my $creationdate=localtime(
 &Apache::loncommon::unsqltime($content{'creationdate'}));
my $lastrevisiondate=localtime(
 &Apache::loncommon::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='Version: '.$thisversion.
    ' (most recent version: '.$currentversion.')';
} else {
    $versiondisplay='Version: '.$currentversion;
}
my $customdistributionfile='';
if ($content{'customdistributionfile'}) {
   $customdistributionfile='<a href="'.$content{'customdistributionfile'}.
     '"><tt>'.$content{'customdistributionfile'}.'</tt></a>';
}
my $bodytag=&Apache::loncommon::bodytag
            ('Catalog Information','','','',$resdomain);
  $r->print(<<ENDHEAD);
<html><head><title>Catalog Information</title></head>
$bodytag
<h2>$content{'title'}</h2>
<h3><tt>$disuri</tt></h3>
$versiondisplay<br />
<table cellspacing=2 border=0>
<tr><td bgcolor='#AAAAAA'>Author(s)</td>
<td bgcolor="#CCCCCC">$author&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Subject</td>
<td bgcolor="#CCCCCC">$content{'subject'}&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Keyword(s)</td>
<td bgcolor="#CCCCCC">$content{'keywords'}&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Notes</td>
<td bgcolor="#CCCCCC">$content{'notes'}&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Abstract</td>
<td bgcolor="#CCCCCC">$content{'abstract'}&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>MIME Type</td>
<td bgcolor="#CCCCCC">$mime ($content{'mime'})&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Language</td>
<td bgcolor="#CCCCCC">$language&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Creation Date</td>
<td bgcolor="#CCCCCC">$creationdate&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>
Last Revision Date</td><td bgcolor="#CCCCCC">$lastrevisiondate&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Publisher/Owner</td>
<td bgcolor="#CCCCCC">$owner&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Copyright/Distribution</td>
<td bgcolor="#CCCCCC">$content{'copyright'}&nbsp;</td></tr>
<tr><td bgcolor='#AAAAAA'>Custom Distribution File</td>
<td bgcolor="#CCCCCC">$customdistributionfile&nbsp;</td></tr>
</table>
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'});
  delete($content{'customdistributionfile'});
  if ($ENV{'user.adv'}) {
# ------------------------------------------------------------ Dynamic Metadata
   $r->print(
   '<h3>Dynamic Metadata (updated periodically)</h3>Processing ...<br>');
   $r->rflush();
    my %items=(
 '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(
'</table><h4>Access and Usage Statistics</h4><table cellspacing=2 border=0>');
   foreach ('count') {
       $r->print(
'<tr><td bgcolor="#AAAAAA">'.$items{$_}.'</td><td bgcolor="#CCCCCC">'.
$dynmeta{$_}."&nbsp;</td></tr>\n");
   }
   foreach my $cat ('usage','comefrom','goto') {
       $r->print(
'<tr><td bgcolor="#AAAAAA">'.$items{$cat}.'</td><td bgcolor="#CCCCCC">'.
$dynmeta{$cat}.'<font size="-1"><ul>'.join("\n",
      map { my $murl=$_; 
 '<li><a href="'.&Apache::lonnet::clutter($murl).'" target="preview">'.
                        &Apache::lonnet::gettitle($murl).' [<tt>'.$murl
                        .'</tt>]</a></li>' }
      split(/\,/,$dynmeta{$cat.'_list'}))."</ul></font></td></tr>\n");
   }
   foreach my $cat ('course') {
       $r->print(
'<tr><td bgcolor="#AAAAAA">'.$items{$cat}.'</td><td bgcolor="#CCCCCC">'.
$dynmeta{$cat}.'<font size="-1"><ul>'.join("\n",
      map { my %courseinfo=&Apache::lonnet::coursedescription($_);  
 '<li><a href="/public/'.
  $courseinfo{'domain'}.'/'.$courseinfo{'num'}.'/syllabus" target="preview">'.
  $courseinfo{'description'}.'</a></li>' }
      split(/\,/,$dynmeta{$cat.'_list'}))."</ul></font></td></tr>\n");
   }
       $r->print('</table>');
   if ($uri=~/\.(problem|exam|quiz|assess|survey|form)\.meta$/) {
      $r->print(
'<h4>Assessment Statistical Data</h4><table cellspacing=2 border=0>');
      foreach ('stdno','avetries') {
          $r->print(
'<tr><td bgcolor="#AAAAAA">'.$items{$_}.'</td><td bgcolor="#CCCCCC">'.
$dynmeta{$_}."&nbsp;</td></tr>\n");
      }
      foreach ('difficulty') {
         $r->print(
'<tr><td bgcolor="#AAAAAA">'.$items{$_}.'</td><td bgcolor="#CCCCCC">'.
&diffgraph($dynmeta{$_})."</td></tr>\n");
      }
      $r->print('</table>');    
   }
   $r->print('<h4>Evaluation Data</h4><table cellspacing=2 border=0>');
   foreach ('clear','depth','helpful','correct','technical') {
       $r->print(
'<tr><td bgcolor="#AAAAAA">'.$items{$_}.'</td><td bgcolor="#CCCCCC">'.
&evalgraph($dynmeta{$_})."</td></tr>\n");
   }    
   $r->print('</table>');
   $disuri=~/^(\w+)\/(\w+)\//;   
   if ((($ENV{'user.domain'} eq $1) && ($ENV{'user.name'} eq $2))
       || ($ENV{'user.role.ca./'.$1.'/'.$2})) {
      $r->print(
  '<h4>Evaluation Comments (visible to author and co-authors only)</h4>'.
      '<blockquote>'.$dynmeta{'comments'}.'</blockquote>');
      $r->print(
   '<h4>Error Messages (visible to author and co-authors only)</h4>');
      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('<b>'.$content{'time'}.'</b>: '.$content{'message'}.
                    '<br />');
        }
      }      
   }
# ------------------------------------------------------------- All other stuff
   $r->print(
 '<h3>Additional Metadata (non-standard, parameters, exports)</h3>');
   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('<b>'.$display.':</b> '.$content{$name});
	  if ($otherinfo) {
	      $r->print(' ('.$otherinfo.')');
	  }
	  $r->print("<br>\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='Default Cataloging Information for Directory '.$dir;
  }
  %Apache::lonpublisher::metadatafields=();
  %Apache::lonpublisher::metadatakeys=();
  &Apache::lonpublisher::metaeval(&Apache::lonnet::getfile($fn));
  $r->print(<<ENDEDIT);
<html><head><title>Edit Catalog Information</title></head>
$bodytag
<h1>$displayfile</h1>
<form method="post">
ENDEDIT
   foreach ('author','title','subject','keywords','abstract','notes',
            'copyright','customdistributionfile','language') {
       if ($ENV{'form.new_'.$_}) {
	   $Apache::lonpublisher::metadatafields{$_}=$ENV{'form.new_'.$_};
       }
       if (m/copyright/) {
	   $r->print(&Apache::lonpublisher::selectbox($_,'new_'.$_,
			       $Apache::lonpublisher::metadatafields{$_},
			       \&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(
            '<p><font color=red>Could not write metadata, FAIL</font>');
      } 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})
                        .'</'.$tag.'>';
            }
	  }
          $r->print('<p>Wrote Metadata');
      }
    }
    $r->print(
 '<br /><input type="submit" name="store" value="Store Catalog Information"></form></body></html>');
    return OK;
  }
}

1;
__END__








FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>