--- loncom/interface/lonmeta.pm 2004/06/16 14:30:15 1.79 +++ loncom/interface/lonmeta.pm 2005/12/13 11:52:37 1.137 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Metadata display handler # -# $Id: lonmeta.pm,v 1.79 2004/06/16 14:30:15 matthew Exp $ +# $Id: lonmeta.pm,v 1.137 2005/12/13 11:52:37 banghart Exp $ # # Copyright Michigan State University Board of Trustees # @@ -17,7 +17,7 @@ # 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 +# 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 # @@ -31,9 +31,9 @@ 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::lonhtmlcommon(); use Apache::lonmsg; use Apache::lonpublisher; use Apache::lonlocal; @@ -41,6 +41,87 @@ use Apache::lonmysql; use Apache::lonmsg; +############################################################ +############################################################ +## +## &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 @Fields = ('url','count','course', + 'goto','goto_list', + 'comefrom','comefrom_list', + 'sequsage','sequsage_list', + 'stdno','stdno_list', + 'dependencies', + 'avetries','avetries_list', + 'difficulty','difficulty_list', + 'disc','disc_list', + 'clear','technical','correct', + 'helpful','depth'); + # + my $query = 'SELECT '.join(',',@Fields). + ' 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 @Data = + map { + &Apache::lonnet::unescape($_); + } split(',',$result); + my $url = $Data[0]; + for (my $i=0;$i<=$#Fields;$i++) { + $ReturnHash{$url}->{$Fields[$i]}=$Data[$i]; + } + } + $finished = 1; + } + # + return %ReturnHash; +} + + # Fetch and evaluate dynamic metadata sub dynamicmeta { my $url=&Apache::lonnet::declutter(shift); @@ -155,19 +236,25 @@ sub diffgraph { # The field names sub fieldnames { - return &Apache::lonlocal::texthash - ( - 'title' => 'Title', + 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', - 'standards' => 'Standards', + 'courserestricted' => 'Course Restricting Metadata'); + + if (! defined($file_type) || $file_type ne 'portfolio') { + %fields = + (%fields, + 'domain' => 'Domain', 'mime' => 'MIME Type', 'language' => 'Language', 'creationdate' => 'Creation Date', @@ -175,7 +262,7 @@ sub fieldnames { 'owner' => 'Publisher/Owner', 'copyright' => 'Copyright/Distribution', 'customdistributionfile' => 'Custom Distribution File', - 'sourceavail' => 'Source Availible', + 'sourceavail' => 'Source Available', 'sourcerights' => 'Source Custom Distribution File', 'obsolete' => 'Obsolete', 'obsoletereplacement' => 'Suggested Replacement for Obsolete File', @@ -197,13 +284,54 @@ sub fieldnames { '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 select_course { + my %courses; + my $output; + foreach my $key (keys (%env)) { + if ($key =~ m/\.metadata\./) { + $key =~ m/^course\.(.+)(\.metadata.+$)/; + my $course = $1; + my $coursekey = 'course.'.$course.'.description'; + my $value = $env{$coursekey}; + $courses{$coursekey} = $value; + } + } + $output = '

Associate resource with a course


'; + $output .= '
'; + $output .= 'Select course
'; + $output .= ''; + } + $key =~ m/(^.+)\.description$/; + $output .= ''; + } + unless ($meta_not_found) { + $output .= '
'; + $output .= ''; + $output .= '
'; + } + return ($output); +} # Pretty printing of metadata field sub prettyprint { - my ($type,$value)=@_; + my ($type,$value,$target,$prefix,$form,$noformat)=@_; +# $target,$prefix,$form are optional and for filecrumbs only if (! defined($value)) { return ' '; } @@ -249,7 +377,7 @@ sub prettyprint { return &Apache::loncommon::gradeleveldescription($value); } # Only for advance users below - if (! $ENV{'user.adv'}) { + if (! $env{'user.adv'}) { return '- '.&mt('not displayed').' -'; } # File @@ -257,8 +385,9 @@ sub prettyprint { ($type eq 'obsoletereplacement') || ($type eq 'goto_list') || ($type eq 'comefrom_list') || - ($type eq 'sequsage_list')) { - return join('
',map { + ($type eq 'sequsage_list') || + ($type eq 'dependencies')) { + return ''; } # Evaluations if (($type eq 'clear') || @@ -351,10 +479,70 @@ sub relatedfield { sub prettyinput { my ($type,$value,$fieldname,$formname, - $relatedsearchflag,$relatedsep,$relatedvalue,$size)=@_; + $relatedsearchflag,$relatedsep,$relatedvalue,$size,$course_key)=@_; if (! defined($size)) { $size = 80; } + my $output; + if (defined($course_key)) { + my $stu_add; + my $only_one; + my %meta_options; + my @cur_values_inst; + my $cur_values_stu; + my $values = $env{$course_key.'.metadata.'.$type.'.values'}; + if ($env{$course_key.'.metadata.'.$type.'.options'} =~ m/stuadd/) { + $stu_add = 'true'; + } + if ($env{$course_key.'.metadata.'.$type.'.options'} =~ m/onlyone/) { + $only_one = 'true'; + } + # need to take instructor values out of list where instructor and student + # values may be mixed. + if ($values) { + foreach my $item (split(/,/,$values)) { + $item =~ s/^\s+//; + $meta_options{$item} = $item; + } + foreach my $item (split(/,/,$value)) { + $item =~ s/^\s+//; + if ($meta_options{$item}) { + push(@cur_values_inst,$item); + } else { + $cur_values_stu .= $item.','; + } + } + } else { + $cur_values_stu = $value; + } + if ($type eq 'courserestricted') { + return (''); + } + if (($type eq 'keywords') || ($type eq 'subject') + || ($type eq 'author')||($type eq 'notes') + || ($type eq 'abstract')|| ($type eq 'title')|| ($type eq 'standards')) { + if ($values) { + if ($only_one) { + $output .= (&Apache::loncommon::select_form($cur_values_inst[0],'new_'.$type,%meta_options)); + } else { + $output .= (&Apache::loncommon::multiple_select_form('new_'.$type,\@cur_values_inst,undef,\%meta_options)); + } + } + if ($stu_add) { + $output .= ''. + &relatedfield(1,$relatedsearchflag,$relatedsep,$fieldname, + $relatedvalue); + } + return ($output); + } + if (($type eq 'lowestgradelevel') || + ($type eq 'highestgradelevel')) { + return &Apache::loncommon::select_level_form($value,$fieldname). + &relatedfield(0,$relatedsearchflag,$relatedsep); + } + return(); + } # Language if ($type eq 'language') { return &selectbox($fieldname, @@ -415,6 +603,10 @@ sub prettyinput { ",'rights')\">".&mt('Select').''. &relatedfield(0,$relatedsearchflag,$relatedsep); } + if ($type eq 'courserestricted') { + return (''); + } + # Dates if (($type eq 'creationdate') || ($type eq 'lastrevisiondate')) { @@ -447,13 +639,20 @@ sub handler { # my ($resdomain,$resuser)= (&Apache::lonnet::declutter($uri)=~/^(\w+)\/(\w+)\//); - $r->print(''. + my $html=&Apache::lonxml::xmlbegin(); + $r->print($html.'<head><title>'. 'Catalog Information'. ''); if ($uri=~m:/adm/bombs/(.*)$:) { $r->print(&Apache::loncommon::bodytag('Error Messages')); # Looking for all bombs? &report_bombs($r,$uri); + } elsif ($uri=~/\/portfolio\//) { + ($resdomain,$resuser)= + (&Apache::lonnet::declutter($uri)=~m|^(\w+)/(\w+)/portfolio|); + $r->print(&Apache::loncommon::bodytag + ('Edit Portfolio File Information','','','',$resdomain)); + &present_editable_metadata($r,$uri,'portfolio'); } elsif ($uri=~/^\/\~/) { # Construction space $r->print(&Apache::loncommon::bodytag @@ -461,7 +660,7 @@ sub handler { &present_editable_metadata($r,$uri); } else { $r->print(&Apache::loncommon::bodytag - ('Catalog Information','','','',$resdomain)); + ('Catalog Information','','','',$resdomain)); &present_uneditable_metadata($r,$uri); } $r->print(''); @@ -483,6 +682,15 @@ sub report_bombs { $r->print('

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

'); my ($domain,$author)=($uri=~/^(\w+)\/(\w+)\//); if (&Apache::loncacc::constructaccess('/~'.$author.'/',$domain)) { + if ($env{'form.clearbombs'}) { + &Apache::lonmsg::clear_author_res_msg($uri); + } + my $clear=&mt('Clear all Messages in Subdirectory'); + $r->print(< + + +ENDCLEAR my %brokenurls = &Apache::lonmsg::all_url_author_res_msg($author,$domain); foreach (sort(keys(%brokenurls))) { @@ -537,7 +745,7 @@ sub present_uneditable_metadata { # obsolete my $obsolete=$content{'obsolete'}; my $obsoletewarning=''; - if (($obsolete) && ($ENV{'user.adv'})) { + if (($obsolete) && ($env{'user.adv'})) { $obsoletewarning='

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

'; @@ -582,11 +790,11 @@ $disuri
$obsoletewarning $versiondisplay

- +
$table
ENDHEAD - if ($ENV{'user.adv'}) { + if ($env{'user.adv'}) { &print_dynamic_metadata($r,$uri,\%content); } return; @@ -612,7 +820,7 @@ sub print_dynamic_metadata { exists($dynmeta{'goto'}) || exists($dynmeta{'course'})) { $r->print('

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

'. - ''); + '
'); foreach ('count', 'sequsage','sequsage_list', 'comefrom','comefrom_list', @@ -637,7 +845,7 @@ sub print_dynamic_metadata { $r->print('

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

'. - '
'); + '
'); $r->print(''. '
'.$lt{'stdno'}.''. &prettyprint('stdno',$dynmeta{'stdno'}). @@ -656,7 +864,7 @@ sub print_dynamic_metadata { $r->print('

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

'); - my $table = ''. + my $table = '
'. ''. ''. ''. @@ -716,7 +924,7 @@ sub print_dynamic_metadata { exists($dynmeta{'correct'}) || exists($dynmeta{'technical'})){ $r->print('

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

'. - '
CourseSection(s)
'); + '
'); foreach ('clear','depth','helpful','correct','technical') { $r->print(''. '
'.$lt{$_}.''. @@ -727,8 +935,8 @@ sub print_dynamic_metadata { $r->print('

'.&mt('No Evaluation Data is available for this resource.').'

'); } $uri=~/^\/res\/(\w+)\/(\w+)\//; - if ((($ENV{'user.domain'} eq $1) && ($ENV{'user.name'} eq $2)) - || ($ENV{'user.role.ca./'.$1.'/'.$2})) { + if ((($env{'user.domain'} eq $1) && ($env{'user.name'} eq $2)) + || ($env{'user.role.ca./'.$1.'/'.$2})) { if (exists($dynmeta{'comments'})) { $r->print('

'.&mt('Evaluation Comments').' ('. &mt('visible to author and co-authors only'). @@ -750,7 +958,7 @@ sub print_dynamic_metadata { # All other stuff $r->print('

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

'); + ''); foreach (sort(keys(%content))) { my $name=$_; if ($name!~/\.display$/) { @@ -768,16 +976,19 @@ sub print_dynamic_metadata { $name.'.'.$_).'; '; } } - $r->print(''.$display.': '.$content{$name}); + $r->print('\n"); } } + $r->print("
'.$display.''.$content{$name}); if ($otherinfo) { $r->print(' ('.$otherinfo.')'); } - $r->print("
\n"); + $r->print("
"); return; } + + ##################################################### ##################################################### ### ### @@ -786,32 +997,55 @@ sub print_dynamic_metadata { ##################################################### ##################################################### sub present_editable_metadata { - my ($r,$uri) = @_; + my ($r,$uri, $file_type) = @_; # Construction Space Call # Header my $disuri=$uri; my $fn=&Apache::lonnet::filelocation('',$uri); + my $metacourse; $disuri=~s/^\/\~/\/priv\//; $disuri=~s/\.meta$//; + $disuri=~s|^/editupload||; my $target=$uri; - $target=~s/^\/\~/\/res\/$ENV{'request.role.domain'}\//; + $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'}) { + 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'); } } - my $del=&mt('Delete 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
- -
$bombs ENDBOMBS + if ($showdel) { + $r->print(< + +ENDDEL + } else { + $r->print(''.$goback.''); + } + $r->print('
'.$bombs); } else { my $displayfile='Catalog Information for '.$disuri; if ($disuri=~/\/default$/) { @@ -821,76 +1055,162 @@ ENDBOMBS &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)); + my $result=&Apache::lonnet::getfile($fn); + if ($result == -1){ + $r->print('Creating new '.$disuri); + } else { + &Apache::lonpublisher::metaeval($result); + } $r->print(<Edit Catalog Information -$bodytag

$displayfile

ENDEDIT $r->print(''); - my %lt=&fieldnames(); - foreach ('author','title','subject','keywords','abstract','notes', + my %lt=&fieldnames($file_type); + my $output; + my @fields; + if ($file_type eq 'portfolio') { + @fields = ('author','title','subject','keywords','abstract','notes','lowestgradelevel', + 'highestgradelevel','standards','courserestricted'); + } else { + @fields = ('author','title','subject','keywords','abstract','notes', 'copyright','customdistributionfile','language', 'standards', 'lowestgradelevel','highestgradelevel','sourceavail','sourcerights', - 'obsolete','obsoletereplacement') { - if (defined($ENV{'form.new_'.$_})) { - $Apache::lonpublisher::metadatafields{$_}= - $ENV{'form.new_'.$_}; + 'obsolete','obsoletereplacement'); + } + if ($env{'form.metacourse'} ) { + $Apache::lonpublisher::metadatafields{'courserestricted'} = $env{'form.metacourse'}; + $metacourse = $env{'form.metacourse'}; + } else { + if (! $Apache::lonpublisher::metadatafields{'courserestricted'}) { + $Apache::lonpublisher::metadatafields{'courserestricted'}= + 'none'; + $metacourse = 'none'; + } else { + $metacourse = $Apache::lonpublisher::metadatafields{'courserestricted'}; } - if (! $Apache::lonpublisher::metadatafields{'copyright'}) { + } + if (! $Apache::lonpublisher::metadatafields{'copyright'}) { $Apache::lonpublisher::metadatafields{'copyright'}= - 'default'; + 'default'; + } + if ($metacourse ne 'none') { + $r->print('Using: '.$env{$metacourse.".description"}. + " metadata framework
"); + } else { + $r->print("This resources is not associated with a metadata framework
"); + } + foreach my $field_name(@fields) { + + if (defined($env{'form.new_'.$field_name})) { + $Apache::lonpublisher::metadatafields{$field_name}= + join(',',&Apache::loncommon::get_env_multiple('form.new_'.$field_name)); + } + if ($metacourse ne 'none') { + # handle restrictions here + if ($env{$metacourse.'.metadata.'.$field_name.'.options'} =~ m/active/){ + $output.=('

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

'); + } elsif ($field_name eq 'courserestricted') { + $output.=( + &prettyinput($field_name, + $Apache::lonpublisher::metadatafields{$field_name}, + 'new_'.$field_name,'defaultmeta',undef,undef,undef,undef,$metacourse)); + } + } else { + if ($field_name ne 'courserestricted') { + $output.=('

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

'); + } else { + $output.=&prettyinput($field_name, + $Apache::lonpublisher::metadatafields{$field_name}, + 'new_'.$field_name,'defaultmeta'); + } } - $r->print('

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

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

'. - &mt('Could not write metadata').', '. - &mt('FAIL').''); + my $formname='store'; + my $file_content; + foreach my $meta_field (keys %env) { + if (&Apache::loncommon::get_env_multiple('form.new_keywords')) { + $Apache::lonpublisher::metadatafields{'keywords'} = + join (',', &Apache::loncommon::get_env_multiple('form.new_keywords')); + } + } + foreach (sort keys %Apache::lonpublisher::metadatafields) { + next if ($_ =~ /\./); + my $unikey=$_; + $unikey=~/^([A-Za-z]+)/; + my $tag=$1; + $tag=~tr/A-Z/a-z/; + $file_content.= "\n\<$tag"; + foreach (split(/\,/, + $Apache::lonpublisher::metadatakeys{$unikey}) + ) { + my $value= + $Apache::lonpublisher::metadatafields{$unikey.'.'.$_}; + $value=~s/\"/\'\'/g; + $file_content.=' '.$_.'="'.$value.'"' ; + # print $mfh ' '.$_.'="'.$value.'"'; + } + $file_content.= '>'. + &HTML::Entities::encode + ($Apache::lonpublisher::metadatafields{$unikey}, + '<>&"'). + ''; + } + if ($fn =~ /\/portfolio\//) { + $fn =~ /\/portfolio\/(.*)$/; + my $new_fn = '/'.$1; + $env{'form.'.$formname}=$file_content."\n"; + $env{'form.'.$formname.'.filename'}=$new_fn; + &Apache::lonnet::userfileupload('uploaddoc','', + 'portfolio'.$env{'form.currentpath'}); + if (&Apache::lonnet::userfileupload($formname,'','portfolio') eq 'error: no uploaded file') { + $r->print('

'. + &mt('Could not write metadata').', '. + &mt('FAIL').'

'); + } else { + $r->print('

'.&mt('Wrote Metadata'). + ' '.&Apache::lonlocal::locallocaltime(time). + '

'); + } } 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}, - '<>&"'). - ''; + if (! ($mfh=Apache::File->new('>'.$fn))) { + $r->print('

'. + &mt('Could not write metadata').', '. + &mt('FAIL').'

'); + } else { + print $mfh $file_content; + $r->print('

'.&mt('Wrote Metadata'). + ' '.&Apache::lonlocal::locallocaltime(time). + '

'); } - $r->print('

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

'); + if ($metacourse eq 'none') { + $r->print(&select_course()); + } return; } 1; __END__ + +