--- loncom/interface/lonparmset.pm 2001/05/10 01:06:06 1.29
+++ loncom/interface/lonparmset.pm 2005/06/02 16:35:32 1.200
@@ -1,432 +1,472 @@
# The LearningOnline Network with CAPA
# Handler to set parameters for assessments
#
-# (Handler to resolve ambiguous file locations
+# $Id: lonparmset.pm,v 1.200 2005/06/02 16:35:32 www Exp $
#
-# (TeX Content Handler
+# Copyright Michigan State University Board of Trustees
#
-# 05/29/00,05/30,10/11 Gerd Kortemeyer)
+# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
-# 10/11,10/12,10/16 Gerd Kortemeyer)
+# 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.
#
-# 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28,
-# 12/08,12/12,
-# 16/01/01,02/08,03/20,03/23,03/24,03/26,05/09 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.
+#
+# 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/
+#
+###################################################################
+###################################################################
+
+=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;
use strict;
use Apache::lonnet;
use Apache::Constants qw(:common :http REDIRECT);
+use Apache::lonhtmlcommon();
+use Apache::loncommon;
use GDBM_File;
+use Apache::lonhomework;
+use Apache::lonxml;
+use Apache::lonlocal;
+use Apache::lonnavmaps;
+# --- Caches local to lonparmset
-my %courseopt;
-my %useropt;
-my %bighash;
+my $parmhashid;
my %parmhash;
-my @outpar;
+# --- end local caches
+#
+# FIXME: get rid of items below
+#
my @ids;
my %symbp;
my %mapp;
my %typep;
my %keyp;
-my %defp;
+my %uris;
+my %maptitles;
+
+##################################################
+##################################################
+
+=pod
-my %allkeys;
-my %allmaps;
+=item parmval
-my $uname;
-my $udom;
-my $uhome;
+Figure out a cascading parameter.
-my $csec;
+Inputs: $what - a parameter spec (incluse part info and name I.E. 0.weight)
+ $id - a bighash Id number
+ $def - the resource's default value 'stupid emacs
-my $fcat;
+Returns: A list, the first item is the index into the remaining list of items of parm valuse that is the active one, the list consists of parm values at the 11 possible levels
-# -------------------------------------------- Figure out a cascading parameter
+11 - General Course
+10 - Map or Folder level in course
+9- resource default
+8- map default
+7 - resource level in course
+6 - General for section
+5 - Map or Folder level for section
+4 - resource level in section
+3 - General for specific student
+2 - Map or Folder level for specific student
+1 - resource level for specific student
+=cut
+
+##################################################
+##################################################
sub parmval {
- my ($what,$id,$def)=@_;
+ my ($what,$id,$def,$uname,$udom,$csec)=@_;
+# load caches
+
+ &cacheparmhash();
+
+ my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+ my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+ my $useropt=&Apache::lonnet::get_userresdata($uname,$udom);
+ my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
+
+
my $result='';
- @outpar=();
+ my @outpar=();
# ----------------------------------------------------- Cascading lookup scheme
- my $symbparm=$symbp{$id}.'.'.$what;
- my $mapparm=$mapp{$id}.'___(all).'.$what;
-
- my $seclevel=
- $ENV{'request.course.id'}.'.['.
- $csec.'].'.$what;
- my $seclevelr=
- $ENV{'request.course.id'}.'.['.
- $csec.'].'.$symbparm;
- my $seclevelm=
- $ENV{'request.course.id'}.'.['.
- $csec.'].'.$mapparm;
+ my $symbparm=$symbp{$id}.'.'.$what;
+ my $mapparm=$mapp{$id}.'___(all).'.$what;
- my $courselevel=
- $ENV{'request.course.id'}.'.'.$what;
- my $courselevelr=
- $ENV{'request.course.id'}.'.'.$symbparm;
- my $courselevelm=
- $ENV{'request.course.id'}.'.'.$mapparm;
+ my $seclevel=$env{'request.course.id'}.'.['.$csec.'].'.$what;
+ my $seclevelr=$env{'request.course.id'}.'.['.$csec.'].'.$symbparm;
+ my $seclevelm=$env{'request.course.id'}.'.['.$csec.'].'.$mapparm;
-# -------------------------------------------------------- first, check default
+ my $courselevel=$env{'request.course.id'}.'.'.$what;
+ my $courselevelr=$env{'request.course.id'}.'.'.$symbparm;
+ my $courselevelm=$env{'request.course.id'}.'.'.$mapparm;
- if ($def) { $outpar[11]=$def;
- $result=11; }
-# ----------------------------------------------------- second, check map parms
- my $thisparm=$parmhash{$symbparm};
- if ($thisparm) { $outpar[10]=$thisparm;
- $result=10; }
+# --------------------------------------------------------- first, check course
-# --------------------------------------------------------- third, check course
+ if (defined($$courseopt{$courselevel})) {
+ $outpar[11]=$$courseopt{$courselevel};
+ $result=11;
+ }
- if ($courseopt{$courselevel}) { $outpar[9]=$courseopt{$courselevel};
- $result=9; }
+ if (defined($$courseopt{$courselevelm})) {
+ $outpar[10]=$$courseopt{$courselevelm};
+ $result=10;
+ }
- if ($courseopt{$courselevelm}) { $outpar[8]=$courseopt{$courselevelm};
- $result=8; }
+# ------------------------------------------------------- second, check default
- if ($courseopt{$courselevelr}) { $outpar[7]=$courseopt{$courselevelr};
- $result=7; }
+ if (defined($def)) { $outpar[9]=$def; $result=9; }
- if ($csec) {
+# ------------------------------------------------------ third, check map parms
- if ($courseopt{$seclevel}) { $outpar[6]=$courseopt{$seclevel};
- $result=6; }
+ my $thisparm=$parmhash{$symbparm};
+ if (defined($thisparm)) { $outpar[8]=$thisparm; $result=8; }
- if ($courseopt{$seclevelm}) { $outpar[5]=$courseopt{$seclevelm};
- $result=5; }
-
- if ($courseopt{$seclevelr}) { $outpar[4]=$courseopt{$seclevelr};
- $result=4; }
-
- }
-
-# ---------------------------------------------------------- fourth, check user
-
- if ($uname) {
-
- if ($useropt{$courselevel}) { $outpar[3]=$useropt{$courselevel};
- $result=3; }
+ if (defined($$courseopt{$courselevelr})) {
+ $outpar[7]=$$courseopt{$courselevelr};
+ $result=7;
+ }
- if ($useropt{$courselevelm}) { $outpar[2]=$useropt{$courselevelm};
- $result=2; }
+# ------------------------------------------------------ fourth, back to course
+ if (defined($csec)) {
+ if (defined($$courseopt{$seclevel})) {
+ $outpar[6]=$$courseopt{$seclevel};
+ $result=6;
+ }
+ if (defined($$courseopt{$seclevelm})) {
+ $outpar[5]=$$courseopt{$seclevelm};
+ $result=5;
+ }
+
+ if (defined($$courseopt{$seclevelr})) {
+ $outpar[4]=$$courseopt
+{$seclevelr};
+ $result=4;
+ }
+ }
- if ($useropt{$courselevelr}) { $outpar[1]=$useropt{$courselevelr};
- $result=1; }
+# ---------------------------------------------------------- fifth, check user
- }
-
- return $result;
+ if (defined($uname)) {
+ if (defined($$useropt{$courselevel})) {
+ $outpar[3]=$$useropt{$courselevel};
+ $result=3;
+ }
+
+ if (defined($$useropt{$courselevelm})) {
+ $outpar[2]=$$useropt{$courselevelm};
+ $result=2;
+ }
+
+ if (defined($$useropt{$courselevelr})) {
+ $outpar[1]=$$useropt{$courselevelr};
+ $result=1;
+ }
+ }
+ return ($result,@outpar);
}
-# ------------------------------------------------------------ Output for value
-
-sub valout {
- my ($value,$type)=@_;
- return
- ($value?(($type=~/^date/)?localtime($value):$value):' ');
+sub resetparmhash {
+ $parmhashid='';
}
-# -------------------------------------------------------- Produces link anchor
+sub cacheparmhash {
+ if ($parmhashid eq $env{'request.course.fn'}) { return; }
+ my %parmhashfile;
+ if (tie(%parmhashfile,'GDBM_File',
+ $env{'request.course.fn'}.'_parms.db',&GDBM_READER(),0640)) {
+ %parmhash=%parmhashfile;
+ untie %parmhashfile;
+ $parmhashid=$env{'request.course.fn'};
+ }
+}
-sub plink {
- my ($type,$dis,$value,$marker,$return,$call)=@_;
- my $winvalue=$value;
- unless ($winvalue) {
- if ($type=~/^date/) {
- $winvalue=$ENV{'form.recent_'.$type};
- } else {
- $winvalue=$ENV{'form.recent_'.(split(/\_/,$type))[0]};
- }
+##################################################
+##################################################
+#
+# Store a parameter by ID
+#
+# Takes
+# - resource id
+# - name of parameter
+# - level
+# - new value
+# - new type
+# - username
+# - userdomain
+
+sub storeparm {
+ my ($sresid,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec)=@_;
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ if ($sresid=~/\./) {
+ my $resource=$navmap->getById($sresid);
+ &storeparm_by_symb($resource->symb(),$spnam,$snum,$nval,$ntype,$uname,$udom,$csec);
+ } else {
+ my $resource=$navmap->getByMapPc($sresid);
+ &storeparm_by_symb(&Apache::lonnet::declutter($resource->src()),$spnam,$snum,$nval,$ntype,$uname,$udom,$csec);
}
- return
- ''.
- &valout($value,$type).'';
}
-# ================================================================ Main Handler
+#
+# Store a parameter by symb
+#
+# Takes
+# - symb
+# - name of parameter
+# - level
+# - new value
+# - new type
+# - username
+# - userdomain
+
+sub storeparm_by_symb {
+# ---------------------------------------------------------- Get symb, map, etc
+ my ($symb,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec)=@_;
+# ---------------------------------------------------------- Construct prefixes
+ $spnam=~s/\_([^\_]+)$/\.$1/;
+ my $map=(&Apache::lonnet::decode_symb($symb))[0];
+ my $symbparm=$symb.'.'.$spnam;
+ my $mapparm=$map.'___(all).'.$spnam;
+
+ my $seclevel=$env{'request.course.id'}.'.['.$csec.'].'.$spnam;
+ my $seclevelr=$env{'request.course.id'}.'.['.$csec.'].'.$symbparm;
+ my $seclevelm=$env{'request.course.id'}.'.['.$csec.'].'.$mapparm;
+
+ my $courselevel=$env{'request.course.id'}.'.'.$spnam;
+ my $courselevelr=$env{'request.course.id'}.'.'.$symbparm;
+ my $courselevelm=$env{'request.course.id'}.'.'.$mapparm;
+
+ my $storeunder='';
+ if (($snum==11) || ($snum==3)) { $storeunder=$courselevel; }
+ if (($snum==10) || ($snum==2)) { $storeunder=$courselevelm; }
+ if (($snum==7) || ($snum==1)) { $storeunder=$courselevelr; }
+ if ($snum==6) { $storeunder=$seclevel; }
+ if ($snum==5) { $storeunder=$seclevelm; }
+ if ($snum==4) { $storeunder=$seclevelr; }
+
+ my $delete;
+ if ($nval eq '') { $delete=1;}
+ my %storecontent = ($storeunder => $nval,
+ $storeunder.'.type' => $ntype);
+ my $reply='';
+ if ($snum>3) {
+# ---------------------------------------------------------------- Store Course
+#
+ my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+ my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+# Expire sheets
+ &Apache::lonnet::expirespread('','','studentcalc');
+ if (($snum==7) || ($snum==4)) {
+ &Apache::lonnet::expirespread('','','assesscalc',$symb);
+ } elsif (($snum==8) || ($snum==5)) {
+ &Apache::lonnet::expirespread('','','assesscalc',$map);
+ } else {
+ &Apache::lonnet::expirespread('','','assesscalc');
+ }
+# Store parameter
+ if ($delete) {
+ $reply=&Apache::lonnet::del
+ ('resourcedata',[keys(%storecontent)],$cdom,$cnum);
+ } else {
+ $reply=&Apache::lonnet::cput
+ ('resourcedata',\%storecontent,$cdom,$cnum);
+ }
+ &Apache::lonnet::devalidatecourseresdata($cnum,$cdom);
+ } else {
+# ------------------------------------------------------------------ Store User
+#
+# Expire sheets
+ &Apache::lonnet::expirespread($uname,$udom,'studentcalc');
+ if ($snum==1) {
+ &Apache::lonnet::expirespread
+ ($uname,$udom,'assesscalc',$symb);
+ } elsif ($snum==2) {
+ &Apache::lonnet::expirespread
+ ($uname,$udom,'assesscalc',$map);
+ } else {
+ &Apache::lonnet::expirespread($uname,$udom,'assesscalc');
+ }
+# Store parameter
+ if ($delete) {
+ $reply=&Apache::lonnet::del
+ ('resourcedata',[keys(%storecontent)],$udom,$uname);
+ } else {
+ $reply=&Apache::lonnet::cput
+ ('resourcedata',\%storecontent,$udom,$uname);
+ }
+ &Apache::lonnet::devalidateuserresdata($uname,$udom);
+ }
+
+ if ($reply=~/^error\:(.*)/) {
+ return "Write Error: $1";
+ }
+ return '';
+}
-sub handler {
- my $r=shift;
+##################################################
+##################################################
- if ($r->header_only) {
- $r->content_type('text/html');
- $r->send_http_header;
- return OK;
- }
+=pod
-# ----------------------------------------------------- Needs to be in a course
+=item valout
- if (($ENV{'request.course.fn'}) &&
- (&Apache::lonnet::allowed('opa',$ENV{'request.course.id'}))) {
-# -------------------------------------------------------- Variable declaration
+Format a value for output.
- %courseopt=();
- %useropt=();
- %bighash=();
-
- @ids=();
- %symbp=();
- %typep=();
-
- my $message='';
-
- $csec=$ENV{'form.csec'};
- $udom=$ENV{'form.udom'};
- unless ($udom) { $udom=$r->dir_config('lonDefDomain'); }
-
- my $pscat=$ENV{'form.pscat'};
- my $pschp=$ENV{'form.pschp'};
- my $pssymb='';
+Inputs: $value, $type
-# ----------------------------------------------- Was this started from grades?
+Returns: $value, formatted for output. If $type indicates it is a date,
+localtime($value) is returned.
- if (($ENV{'form.command'} eq 'set') && ($ENV{'form.url'})
- && (!$ENV{'form.dis'})) {
- my $url=$ENV{'form.url'};
- $url=~s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
- $pssymb=&Apache::lonnet::symbread($url);
- $pscat='all';
- $pschp='';
- } else {
- $ENV{'form.url'}='';
- }
-
- my $id=$ENV{'form.id'};
- if (($id) && ($udom)) {
- $uname=(&Apache::lonnet::idget($udom,$id))[1];
- if ($uname) {
- $id='';
- } else {
- $message=
- "Unknown ID '$id' at domain '$udom'";
- }
- } else {
- $uname=$ENV{'form.uname'};
- }
- unless ($udom) { $uname=''; }
- $uhome='';
- if ($uname) {
- $uhome=&Apache::lonnet::homeserver($uname,$udom);
-
- if ($uhome eq 'no_host') {
- $message=
- "Unknown user '$uname' at domain '$udom'";
- $uname='';
- } else {
- $csec=&Apache::lonnet::usection(
- $udom,$uname,$ENV{'request.course.id'});
- if ($csec eq '-1') {
- $message="".
- "User '$uname' at domain '$udom' not in this course";
- $uname='';
- $csec=$ENV{'form.csec'};
- } else {
- my %name=&Apache::lonnet::userenvironment($udom,$uname,
- ('firstname','middlename','lastname','generation','id'));
- $message="\n
');
+ } else {
+ undef $firstrow;
+ }
+
+ &print_row($r,$_,\%part,\%name,$rid,\%default,
+ \%type,\%display,$defbgone,$defbgtwo,
+ $parmlev,$uname,$udom,$csec);
+ }
+ }
+ }
+ } # end foreach ids
+# -------------------------------------------------- End entry for one resource
+ $r->print('
');
+ } # end of brief/full
+#--------------------------------------------------- Entry for parm level map
+ if ($parmlev eq 'map') {
+ my $defbgone = '"E0E099"';
+ my $defbgtwo = '"FFFF99"';
+
+ my %maplist;
+
+ if ($pschp eq 'all') {
+ %maplist = %allmaps;
+ } else {
+ %maplist = ($pschp => $mapp{$pschp});
+ }
+
+#-------------------------------------------- for each map, gather information
+ my $mapid;
+ foreach $mapid (sort {$maplist{$a} cmp $maplist{$b}} keys %maplist) {
+ my $maptitle = $maplist{$mapid};
+
+#----------------------- loop through ids and get all parameter types for map
+#----------------------------------------- and associated information
+ my %name = ();
+ my %part = ();
+ my %display = ();
+ my %type = ();
+ my %default = ();
+ my $map = 0;
+
+# $r->print("Catmarker: @catmarker \n");
+
+ foreach (@ids) {
+ ($map)=(/([\d]*?)\./);
+ my $rid = $_;
+
+# $r->print("$mapid:$map: $rid \n");
+
+ if ($map eq $mapid) {
+ my $uri=&Apache::lonnet::declutter($uris{$rid});
+# $r->print("Keys: $keyp{$rid} \n");
+
+#--------------------------------------------------------------------
+# @catmarker contains list of all possible parameters including part #s
+# $fullkeyp contains the full part/id # for the extraction of proper parameters
+# $tempkeyp contains part 0 only (no ids - ie, subparts)
+# When storing information, store as part 0
+# When requesting information, request from full part
+#-------------------------------------------------------------------
+ foreach (split(/\,/,$keyp{$rid})) {
+ my $tempkeyp = $_;
+ my $fullkeyp = $tempkeyp;
+ $tempkeyp =~ s/_\w+_/_0_/;
+
+ if ((grep $_ eq $fullkeyp, @catmarker) &&(!$name{$tempkeyp})) {
+ $part{$tempkeyp}="0";
+ $name{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.name');
+ $display{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.display');
+ unless ($display{$tempkeyp}) { $display{$tempkeyp}=''; }
+ $display{$tempkeyp}.=' ('.$name{$tempkeyp}.')';
+ $display{$tempkeyp} =~ s/_\w+_/_0_/;
+ $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp);
+ $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.type');
+ }
+ } # end loop through keys
+ }
+ } # end loop through ids
+
+#---------------------------------------------------- print header information
+ my $foldermap=&mt($maptitle=~/^uploaded/?'Folder':'Map');
+ my $showtitle=$maptitles{$maptitle}.($maptitle!~/^uploaded/?' ['.$maptitle.']':'');
+ $r->print(<
+Set Defaults for All Resources in $foldermap
+$showtitle
+Specifically for
+ENDMAPONE
+ if ($uname) {
+ my %name=&Apache::lonnet::userenvironment($udom,$uname,
+ ('firstname','middlename','lastname','generation', 'id'));
+ my $person=$name{'firstname'}.' '.$name{'middlename'}.' '
+ .$name{'lastname'}.' '.$name{'generation'};
+ $r->print(&mt("User")." $uname \($person\) ".
+ &mt('in')." \n");
+ } else {
+ $r->print("".&mt('all').' '.&mt('users in')." \n");
+ }
+
+ if ($csec) {$r->print(&mt("Section")." $csec ".
+ &mt('of')." \n")};
+
+ $r->print("$coursename ");
+ $r->print("
");
+ } # end each map
+ } # end of $parmlev eq map
+#--------------------------------- Entry for parm level general (Course level)
+ if ($parmlev eq 'general') {
+ my $defbgone = '"E0E099"';
+ my $defbgtwo = '"FFFF99"';
+
+#-------------------------------------------- for each map, gather information
+ my $mapid="0.0";
+#----------------------- loop through ids and get all parameter types for map
+#----------------------------------------- and associated information
+ my %name = ();
+ my %part = ();
+ my %display = ();
+ my %type = ();
+ my %default = ();
+
+ foreach (@ids) {
+ my $rid = $_;
+
+ my $uri=&Apache::lonnet::declutter($uris{$rid});
+
+#--------------------------------------------------------------------
+# @catmarker contains list of all possible parameters including part #s
+# $fullkeyp contains the full part/id # for the extraction of proper parameters
+# $tempkeyp contains part 0 only (no ids - ie, subparts)
+# When storing information, store as part 0
+# When requesting information, request from full part
+#-------------------------------------------------------------------
+ foreach (split(/\,/,$keyp{$rid})) {
+ my $tempkeyp = $_;
+ my $fullkeyp = $tempkeyp;
+ $tempkeyp =~ s/_\w+_/_0_/;
+ if ((grep $_ eq $fullkeyp, @catmarker) &&(!$name{$tempkeyp})) {
+ $part{$tempkeyp}="0";
+ $name{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.name');
+ $display{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.display');
+ unless ($display{$tempkeyp}) { $display{$tempkeyp}=''; }
+ $display{$tempkeyp}.=' ('.$name{$tempkeyp}.')';
+ $display{$tempkeyp} =~ s/_\w+_/_0_/;
+ $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp);
+ $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.type');
+ }
+ } # end loop through keys
+ } # end loop through ids
+
+#---------------------------------------------------- print header information
+ my $setdef=&mt("Set Defaults for All Resources in Course");
+ $r->print(<