--- loncom/interface/lonparmset.pm 2002/08/08 17:03:20 1.57 +++ loncom/interface/lonparmset.pm 2002/10/01 06:21:23 1.70 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to set parameters for assessments # -# $Id: lonparmset.pm,v 1.57 2002/08/08 17:03:20 albertel Exp $ +# $Id: lonparmset.pm,v 1.70 2002/10/01 06:21:23 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,27 +25,31 @@ # # http://www.lon-capa.org/ # -# (Handler to resolve ambiguous file locations -# -# (TeX Content Handler -# -# YEAR=2000 -# 05/29/00,05/30,10/11 Gerd Kortemeyer) -# -# 10/11,10/12,10/16 Gerd Kortemeyer) -# -# 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28, -# 12/08,12/12, -# YEAR=2001 -# 16/01/01,02/08,03/20,03/23,03/24,03/26,05/09, -# 07/05,07/06,08/08,08/09,09/01,09/21 Gerd Kortemeyer -# 12/17 Scott Harrison -# 12/19 Guy Albertelli -# 12/26,12/27 Gerd Kortemeyer -# -# YEAR=2002 -# 7/19 Jeremy Bowers -### +################################################################### +################################################################### + +=pod + +=head1 NAME + +lonparmset - Handler to set parameters for assessments and course + +=head1 SYNOPSIS + +lonparmset provides an interface to setting course parameters. + +=head1 DESCRIPTION + +This module sets coursewide and assessment parameters. + +=head1 INTERNAL SUBROUTINES + +=over 4 + +=cut + +################################################################### +################################################################### package Apache::lonparmset; @@ -74,8 +78,23 @@ my $uhome; my $csec; my $coursename; -# -------------------------------------------- Figure out a cascading parameter +################################################## +################################################## + +=pod + +=item parmval + +Figure out a cascading parameter. + +Inputs: $what $id $def + +Returns: I am not entirely sure. + +=cut +################################################## +################################################## sub parmval { my ($what,$id,$def)=@_; my $result=''; @@ -157,15 +176,81 @@ sub parmval { return ($result,@outpar); } -# ------------------------------------------------------------ Output for value +################################################## +################################################## +=pod + +=item valout + +Format a value for output. + +Inputs: $value, $type + +Returns: $value, formatted for output. If $type indicates it is a date, +localtime($value) is returned. + +=cut + +################################################## +################################################## sub valout { my ($value,$type)=@_; - return ($value?(($type=~/^date/)?localtime($value):$value):'  '); + my $result = ''; + # Values of zero are valid. + if (! $value && $value ne '0') { + $result = '  '; + } else { + if ($type eq 'date_interval') { + my ($sec,$min,$hour,$mday,$mon,$year)=gmtime($value); + $year=$year-70; + $mday--; + if ($year) { + $result.=$year.' yrs '; + } + if ($mon) { + $result.=$mon.' mths '; + } + if ($mday) { + $result.=$mday.' days '; + } + if ($hour) { + $result.=$hour.' hrs '; + } + if ($min) { + $result.=$min.' mins '; + } + if ($sec) { + $result.=$sec.' secs '; + } + $result=~s/\s+$//; + } elsif ($type=~/^date/) { + $result = localtime($value); + } else { + $result = $value; + } + } + return $result; } -# -------------------------------------------------------- Produces link anchor +################################################## +################################################## + +=pod + +=item plink + +Produces a link anchor. +Inputs: $type,$dis,$value,$marker,$return,$call + +Returns: scalar with html code for a link which will envoke the +javascript function 'pjump'. + +=cut + +################################################## +################################################## sub plink { my ($type,$dis,$value,$marker,$return,$call)=@_; my $winvalue=$value; @@ -187,6 +272,9 @@ sub startpage { my ($r,$id,$udom,$csec,$uname)=@_; $r->content_type('text/html'); $r->send_http_header; + + my $bodytag=&Apache::loncommon::bodytag('Set Course Parameters','', + 'onUnload="pclose()"'); $r->print(< @@ -241,9 +329,7 @@ sub startpage { } - -

Set Course Parameters for Course: -$ENV{'course.'.$ENV{'request.course.id'}.'.description'}

+$bodytag

Course Environment

@@ -269,10 +355,27 @@ ENDHEAD } sub print_row { - my ($r,$which,$part,$name,$rid,$default,$type,$display,$defbgone, + my ($r,$which,$part,$name,$rid,$default,$defaulttype,$display,$defbgone, $defbgtwo,$parmlev)=@_; +# get the values for the parameter in cascading order +# empty levels will remain empty my ($result,@outpar)=&parmval($$part{$which}.'.'.$$name{$which}, $rid,$$default{$which}); +# get the type for the parameters +# problem: these may not be set for all levels + my ($typeresult,@typeoutpar)=&parmval($$part{$which}.'.'. + $$name{$which}.'.type', + $rid,$$defaulttype{$which}); +# cascade down manually + my $cascadetype=$defaulttype; + for (my $i=$#typeoutpar;$i>0;$i--) { + if ($typeoutpar[$i]) { + $cascadetype=$typeoutpar[$i]; + } else { + $typeoutpar[$i]=$cascadetype; + } + } + my $parm=$$display{$which}; if ($parmlev eq 'full' || $parmlev eq 'brief') { @@ -291,73 +394,78 @@ sub print_row { if ($parmlev eq 'general') { if ($uname) { - &print_td($r,3,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,3,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } elsif ($csec) { - &print_td($r,6,$defbgtwo,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,6,$defbgtwo,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } else { - &print_td($r,9,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,9,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } } elsif ($parmlev eq 'map') { if ($uname) { - &print_td($r,2,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,2,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } elsif ($csec) { - &print_td($r,5,$defbgtwo,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,5,$defbgtwo,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } else { - &print_td($r,8,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,8,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } } else { - &print_td($r,11,'#FFDDDD',$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,11,'#FFDDDD',$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); if ($parmlev eq 'brief') { - &print_td($r,7,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,7,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); if ($csec) { - &print_td($r,4,$defbgtwo,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,4,$defbgtwo,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } if ($uname) { - &print_td($r,1,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,1,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } } else { - &print_td($r,10,'#FFDDDD',$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,9,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,8,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,7,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,10,'#FFDDDD',$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,9,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,8,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,7,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); if ($csec) { - &print_td($r,6,$defbgtwo,$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,5,$defbgtwo,$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,4,$defbgtwo,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,6,$defbgtwo,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,5,$defbgtwo,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,4,$defbgtwo,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } if ($uname) { - &print_td($r,3,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,2,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); - &print_td($r,1,$defbgone,$result,\@outpar,$mprefix,$_,$type,$display); + &print_td($r,3,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,2,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); + &print_td($r,1,$defbgone,$result,\@outpar,$mprefix,$_,\@typeoutpar,$display); } } # end of $brief if/else } # end of $parmlev if/else if ($parmlev eq 'full' || $parmlev eq 'brief') { - $r->print(''. - &valout($outpar[$result],$$type{$which}).''); - -} + $r->print(''. + &valout($outpar[$result],$typeoutpar[$result]).''); + } my $sessionval=&Apache::lonnet::EXT('resource.'.$$part{$which}. '.'.$$name{$which},$symbp{$rid}); +# this doesn't seem to work, and I don't think is correct +# my $sessionvaltype=&Apache::lonnet::EXT('resource.'.$$part{$which}. +# '.'.$$name{$which}.'.type',$symbp{$rid}); +# this seems to work + my $sessionvaltype=$typeoutpar[$result]; $r->print(''. - &valout($sessionval,$$type{$which}).' '. + &valout($sessionval,$sessionvaltype).' '. ''); $r->print(''); $r->print("\n"); } + sub print_td { - my ($r,$which,$defbg,$result,$outpar,$mprefix,$value,$type,$display)=@_; + my ($r,$which,$defbg,$result,$outpar,$mprefix,$value,$typeoutpar,$display)=@_; $r->print(''. - &plink($$type{$value},$$display{$value},$$outpar[$which], + &plink($$typeoutpar[$which],$$display{$value},$$outpar[$which], $mprefix."$which",'parmform.pres','psub').''."\n"); } @@ -375,6 +483,132 @@ sub get_env_multiple { return(@values); } +=pod + +=item B: Given the course data hash, extractResourceInformation extracts lots of information about the course's resources into a variety of hashes. + +Input: See list below: + +=over 4 + +=item B: An array that will contain all of the ids in the course. + +=item B: hash, id->type, where "type" contains the extension of the file, thus, I. + +=item B: hash, id->key list, will contain a comma seperated list of the meta-data keys available for the given id + +=item B: hash, name of parameter->display value (what is the display value?) + +=item B: hash, part identification->text representation of part, where the text representation is "[Part $part]" + +=item B: hash, full key to part->display value (what's display value?) + +=item B: hash, ??? + +=item B: ??? + +=item B: hash, ??? + +=item B: ?? + +=item B: hash, id->full sym? + +=back + +=cut + +sub extractResourceInformation { + my $bighash = shift; + my $ids = shift; + my $typep = shift; + my $keyp = shift; + my $allparms = shift; + my $allparts = shift; + my $allkeys = shift; + my $allmaps = shift; + my $fcat = shift; + my $defp = shift; + my $mapp = shift; + my $symbp = shift; + + foreach (keys %$bighash) { + if ($_=~/^src\_(\d+)\.(\d+)$/) { + my $mapid=$1; + my $resid=$2; + my $id=$mapid.'.'.$resid; + my $srcf=$$bighash{$_}; + if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) { + $$ids[$#$ids+1]=$id; + $$typep{$id}=$1; + $$keyp{$id}=''; + foreach (split(/\,/,&Apache::lonnet::metadata($srcf,'allpossiblekeys'))) { + if ($_=~/^parameter\_(.*)/) { + my $key=$_; + my $allkey=$1; + $allkey=~s/\_/\./g; + my $display= &Apache::lonnet::metadata($srcf,$key.'.display'); + my $name=&Apache::lonnet::metadata($srcf,$key.'.name'); + my $part= &Apache::lonnet::metadata($srcf,$key.'.part'); + my $parmdis = $display; + $parmdis =~ s|(\[Part.*$)||g; + my $partkey = $part; + $partkey =~ tr|_|.|; + $$allparms{$name} = $parmdis; + $$allparts{$part} = "[Part $part]"; + $$allkeys{$allkey}=$display; + if ($allkey eq $fcat) { + $$defp{$id}= &Apache::lonnet::metadata($srcf,$key); + } + if ($$keyp{$id}) { + $$keyp{$id}.=','.$key; + } else { + $$keyp{$id}=$key; + } + } + } + $$mapp{$id}= + &Apache::lonnet::declutter($$bighash{'map_id_'.$mapid}); + $$mapp{$mapid}=$$mapp{$id}; + $$allmaps{$mapid}=$$mapp{$id}; + $$symbp{$id}=$$mapp{$id}. + '___'.$resid.'___'. + &Apache::lonnet::declutter($srcf); + $$symbp{$mapid}=$$mapp{$id}.'___(all)'; + } + } + } +} + +################################################## +################################################## + +=pod + +=item assessparms + +Show assessment data and parameters. This is a large routine that should +be simplified and shortened... someday. + +Inputs: $r + +Returns: nothing + +Variables used (guessed by Jeremy): + +=over 4 + +=item B: ParameterS CATegories? ends up a list of the types of parameters that exist, e.g., tol, weight, acc, opendate, duedate, answerdate, sig, maxtries, type. + +=item B: ParameterS PaRTs? a list of the parts of a problem that we are displaying? Used to display only selected parts? + +=item B: + +=back + +=cut + +################################################## +################################################## sub assessparms { my $r=shift; @@ -491,62 +725,19 @@ sub assessparms { # ------------------------------------------------------------------- Tie hashs if (!(tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db', - &GDBM_READER,0640))) { + &GDBM_READER(),0640))) { $r->print("Unable to access course data. (File $ENV{'request.course.fn'}.db not tieable)"); return ; } if (!(tie(%parmhash,'GDBM_File', - $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640))) { + $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER(),0640))) { $r->print("Unable to access parameter data. (File $ENV{'request.course.fn'}_parms.db not tieable)"); return ; } + # --------------------------------------------------------- Get all assessments - foreach (keys %bighash) { - if ($_=~/^src\_(\d+)\.(\d+)$/) { - my $mapid=$1; - my $resid=$2; - my $id=$mapid.'.'.$resid; - my $srcf=$bighash{$_}; - if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) { - $ids[$#ids+1]=$id; - $typep{$id}=$1; - $keyp{$id}=''; - foreach (split(/\,/,&Apache::lonnet::metadata($srcf,'keys'))) { - if ($_=~/^parameter\_(.*)/) { - my $key=$_; - my $allkey=$1; - $allkey=~s/\_/\./g; - my $display= &Apache::lonnet::metadata($srcf,$key.'.display'); - my $name=&Apache::lonnet::metadata($srcf,$key.'.name'); - my $part= &Apache::lonnet::metadata($srcf,$key.'.part'); - my $parmdis = $display; - $parmdis =~ s|(\[Part.*$)||g; - my $partkey = $part; - $partkey =~ tr|_|.|; - $allparms{$name} = $parmdis; - $allparts{$part} = "[Part $part]"; - $allkeys{$allkey}=$display; - if ($allkey eq $fcat) { - $defp{$id}= &Apache::lonnet::metadata($srcf,$key); - } - if ($keyp{$id}) { - $keyp{$id}.=','.$key; - } else { - $keyp{$id}=$key; - } - } - } - $mapp{$id}= - &Apache::lonnet::declutter($bighash{'map_id_'.$mapid}); - $mapp{$mapid}=$mapp{$id}; - $allmaps{$mapid}=$mapp{$id}; - $symbp{$id}=$mapp{$id}. - '___'.$resid.'___'. - &Apache::lonnet::declutter($srcf); - $symbp{$mapid}=$mapp{$id}.'___(all)'; - } - } - } + extractResourceInformation(\%bighash, \@ids, \%typep,\%keyp, \%allparms, \%allparts, \%allkeys, \%allmaps, $fcat, \%defp, \%mapp, \%symbp); + $mapp{'0.0'} = ''; $symbp{'0.0'} = ''; # ---------------------------------------------------------- Anything to store? @@ -574,8 +765,8 @@ sub assessparms { if ($snum==5) { $storeunder=$seclevelm; } if ($snum==4) { $storeunder=$seclevelr; } - my %storecontent = ($storeunder => $ENV{'form.pres_value'}, - $storeunder.'type' => $ENV{'form.pres_type'}); + my %storecontent = ($storeunder => $ENV{'form.pres_value'}, + $storeunder.'.type' => $ENV{'form.pres_type'}); my $reply=''; if ($snum>3) { # ---------------------------------------------------------------- Store Course @@ -618,6 +809,10 @@ sub assessparms { } # ---------------------------------------------------------------- Done storing } +# --------------------------------------------- Devalidate cache for this child + &Apache::lonnet::devalidatecourseresdata( + $ENV{'course.'.$ENV{'request.course.id'}.'.num'}, + $ENV{'course.'.$ENV{'request.course.id'}.'.domain'}); # -------------------------------------------------------------- Get coursedata %courseopt = &Apache::lonnet::dump ('resourcedata', @@ -645,6 +840,7 @@ sub assessparms { if ($pscat[0] eq "all" || !@pscat) {@pscat = (keys %allparms);} if ($psprt[0] eq "all" || !@psprt) {@psprt = (keys %allparts);} # ------------------------------------------------------------------ Start page + &startpage($r,$id,$udom,$csec,$uname); # if ($ENV{'form.url'}) { # $r->print('yes" for visible separation)', 'pch.roles.denied'=> 'Disallow Resource Discussion for '. - 'Roles ' . - Apache::loncommon::help_open_topic("Course_Disable_Discussion") - , + 'Roles
"st": '. + 'student, "ta": '. + 'TA, "in": '. + 'instructor;
role,role,...) '. + Apache::loncommon::help_open_topic("Course_Disable_Discussion"), 'pch.users.denied' => 'Disallow Resource Discussion for Users
'. '(user:domain,user:domain,...)', @@ -1215,7 +1432,7 @@ sub crsenv { } foreach (sort keys %descriptions) { # onchange is javascript to automatically check the 'Set' button. - my $onchange = 'onchange="javascript:window.document.forms'. + my $onchange = 'onFocus="javascript:window.document.forms'. '[\'envform\'].elements[\''.$_.'_setparmval\']'. '.checked=true;"'; $output.=''.$descriptions{$_}.''. @@ -1224,7 +1441,7 @@ sub crsenv { ''. ''."\n"; } - my $onchange = 'onchange="javascript:window.document.forms'. + my $onchange = 'onFocus="javascript:window.document.forms'. '[\'envform\'].elements[\'newp_setparmval\']'. '.checked=true;"'; $output.='Create New Environment Variable
'. @@ -1263,11 +1480,8 @@ sub crsenv { LON-CAPA Course Environment - -

Set Course Parameters

+$bodytag -

Course: $ENV{'course.'.$ENV{'request.course.id'}.'.description'}

-

Course Environment

$setoutput

@@ -1281,8 +1495,19 @@ $output ENDENV } -# ================================================================ Main Handler +################################################## +################################################## + +=pod +=item handler + +Main handler. Calls &assessparms and &crsenv subroutines. + +=cut + +################################################## +################################################## sub handler { my $r=shift; @@ -1318,70 +1543,7 @@ sub handler { 1; __END__ - -=head1 NAME - -Apache::lonparmset - Handler to set parameters for assessments - -=head1 SYNOPSIS - -Invoked by /etc/httpd/conf/srm.conf: - - - PerlAccessHandler Apache::lonacc - SetHandler perl-script - PerlHandler Apache::lonparmset - ErrorDocument 403 /adm/login - ErrorDocument 406 /adm/roles - ErrorDocument 500 /adm/errorhandler - - -=head1 INTRODUCTION - -This module sets assessment parameters. - -This is part of the LearningOnline Network with CAPA project -described at http://www.lon-capa.org. - -=head1 HANDLER SUBROUTINE - -This routine is called by Apache and mod_perl. - -=over 4 - -=item * - -need to be in course - -=item * - -bring up assessment screen or course environment - -=back - -=head1 OTHER SUBROUTINES - -=over 4 - -=item * - -parmval() : figure out a cascading parameter - -=item * - -valout() : format a value for output - -=item * - -plink() : produces link anchor - -=item * - -assessparms() : show assess data and parameters - -=item * - -crsenv() : for the course environment +=pod =back