# The LearningOnline Network with CAPA
# Handler to set parameters for assessments
#
# $Id: lonparmset.pm,v 1.247 2005/09/02 22:14:35 albertel 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/
#
###################################################################
###################################################################
=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 $parmhashid;
my %parmhash;
my $symbsid;
my %symbs;
my $rulesid;
my %rules;
# --- end local caches
##################################################
##################################################
=pod
=item parmval
Figure out a cascading parameter.
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
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
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,$uname,$udom,$csec)=@_;
return &parmval_by_symb($what,&symbcache($id),$def,$uname,$udom,$csec);
}
sub parmval_by_symb {
my ($what,$symb,$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='';
my @outpar=();
# ----------------------------------------------------- Cascading lookup scheme
my $map=(&Apache::lonnet::decode_symb($symb))[0];
my $symbparm=$symb.'.'.$what;
my $mapparm=$map.'___(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 $courselevel=$env{'request.course.id'}.'.'.$what;
my $courselevelr=$env{'request.course.id'}.'.'.$symbparm;
my $courselevelm=$env{'request.course.id'}.'.'.$mapparm;
# --------------------------------------------------------- first, check course
if (defined($$courseopt{$courselevel})) {
$outpar[11]=$$courseopt{$courselevel};
$result=11;
}
if (defined($$courseopt{$courselevelm})) {
$outpar[10]=$$courseopt{$courselevelm};
$result=10;
}
# ------------------------------------------------------- second, check default
if (defined($def)) { $outpar[9]=$def; $result=9; }
# ------------------------------------------------------ third, check map parms
my $thisparm=$parmhash{$symbparm};
if (defined($thisparm)) { $outpar[8]=$thisparm; $result=8; }
if (defined($$courseopt{$courselevelr})) {
$outpar[7]=$$courseopt{$courselevelr};
$result=7;
}
# ------------------------------------------------------ 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;
}
}
# ---------------------------------------------------------- fifth, check user
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);
}
sub resetparmhash {
$parmhashid='';
}
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 resetsymbcache {
$symbsid='';
}
sub symbcache {
my $id=shift;
if ($symbsid ne $env{'request.course.id'}) {
%symbs=();
}
unless ($symbs{$id}) {
my $navmap = Apache::lonnavmaps::navmap->new();
if ($id=~/\./) {
my $resource=$navmap->getById($id);
$symbs{$id}=$resource->symb();
} else {
my $resource=$navmap->getByMapPc($id);
$symbs{$id}=&Apache::lonnet::declutter($resource->src());
}
$symbsid=$env{'request.course.id'};
}
return $symbs{$id};
}
sub resetrulescache {
$rulesid='';
}
sub rulescache {
my $id=shift;
if ($rulesid ne $env{'request.course.id'}) {
%rules=();
}
unless (defined($rules{$id})) {
my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'};
my $crs = $env{'course.'.$env{'request.course.id'}.'.num'};
%rules=&Apache::lonnet::dump('parmdefactions',$dom,$crs);
$rulesid=$env{'request.course.id'};
}
return $rules{$id};
}
sub preset_defaults {
my $type=shift;
if (&rulescache($type.'_action') eq 'default') {
# yes, there is something
return (&rulescache($type.'_hours'),
&rulescache($type.'_min'),
&rulescache($type.'_sec'),
&rulescache($type.'_value'));
} else {
# nothing there or something else
return ('','','','','');
}
}
##################################################
##################################################
#
# 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)=@_;
&storeparm_by_symb(&symbcache($sresid),$spnam,$snum,$nval,$ntype,$uname,$udom,$csec);
}
#
# Store a parameter by symb
#
# Takes
# - symb
# - name of parameter
# - level
# - new value
# - new type
# - username
# - userdomain
my %recstack;
sub storeparm_by_symb {
my ($symb,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec,$recflag)=@_;
unless ($recflag) {
# first time call
%recstack=();
$recflag=1;
}
# store parameter
&storeparm_by_symb_inner
($symb,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec);
my ($prefix,$parm)=($spnam=~/^(.*[\_\.])([^\_\.]+)$/);
# remember that this was set
$recstack{$parm}=1;
# what does this trigger?
foreach my $triggered (split(/\:/,&rulescache($parm.'_triggers'))) {
# don't backfire
unless ((!$triggered) || ($recstack{$triggered})) {
my $action=&rulescache($triggered.'_action');
my ($whichaction,$whichparm)=($action=~/^(.*\_)([^\_]+)$/);
# set triggered parameter on same level
my $newspnam=$prefix.$triggered;
my $newvalue='';
my $active=1;
if ($action=~/^when\_setting/) {
# are there restrictions?
if (&rulescache($triggered.'_triggervalue')=~/\w/) {
$active=0;
foreach my $possiblevalue (split(/\s*\,\s*/,&rulescache($triggered.'_triggervalue'))) {
if (lc($possiblevalue) eq lc($nval)) { $active=1; }
}
}
$newvalue=&rulescache($triggered.'_value');
} else {
my $totalsecs=((&rulescache($triggered.'_days')*24+&rulescache($triggered.'_hours'))*60+&rulescache($triggered.'_min'))*60+&rulescache($triggered.'_sec');
if ($action=~/^later\_than/) {
$newvalue=$nval+$totalsecs;
} else {
$newvalue=$nval-$totalsecs;
}
}
if ($active) {
&storeparm_by_symb($symb,$newspnam,$snum,$newvalue,&rulescache($triggered.'_type'),
$uname,$udom,$csec,$recflag);
}
}
}
return '';
}
sub storeparm_by_symb_inner {
# ---------------------------------------------------------- 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 '';
}
##################################################
##################################################
=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)=@_;
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 (&isdateparm($type)) {
$result = localtime($value);
} else {
$result = $value;
}
}
return $result;
}
##################################################
##################################################
=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;
unless ($winvalue) {
if (&isdateparm($type)) {
$winvalue=$env{'form.recent_'.$type};
} else {
$winvalue=$env{'form.recent_'.(split(/\_/,$type))[0]};
}
}
my ($parmname)=((split(/\&/,$marker))[1]=~/\_([^\_]+)$/);
my ($hour,$min,$sec,$val)=&preset_defaults($parmname);
unless (defined($winvalue)) { $winvalue=$val; }
return
''.
&valout($value,$type).'';
}
sub startpage {
my $r=shift;
my $bodytag=&Apache::loncommon::bodytag('Set/Modify Course Parameters','',
'onUnload="pclose()"');
my $breadcrumbs = &Apache::lonhtmlcommon::breadcrumbs(undef,'Table Mode Parameter Setting');
my $selscript=&Apache::loncommon::studentbrowser_javascript();
my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
my $html=&Apache::lonxml::xmlbegin();
$r->print(<LON-CAPA Course Parameters
$selscript
$bodytag
$breadcrumbs