--- loncom/interface/lonparmset.pm 2016/03/02 14:14:06 1.556 +++ loncom/interface/lonparmset.pm 2016/08/10 21:05:42 1.566 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to set parameters for assessments # -# $Id: lonparmset.pm,v 1.556 2016/03/02 14:14:06 raeburn Exp $ +# $Id: lonparmset.pm,v 1.566 2016/08/10 21:05:42 damieng Exp $ # # Copyright Michigan State University Board of Trustees # @@ -36,7 +36,11 @@ lonparmset - Handler to set parameters f =head1 SYNOPSIS -lonparmset provides an interface to setting course parameters. +lonparmset provides an interface to setting course parameters. + +It contains all the code for the "Content and Problem Settings" UI, except +for the helpers parameter.helper and resettimes.helper, and lonhelper.pm, +and lonblockingmenu.pm. =head1 DESCRIPTION @@ -327,6 +331,15 @@ use HTML::Entities; use LONCAPA qw(:DEFAULT :match); +################################################## +# CONTENT AND PROBLEM SETTINGS HTML PAGE HEADER/FOOTER +################################################## + +# Page header +# +# @param {Apache2::RequestRec} $r - Apache request object +# @param {string} $mode - selected tab, 'parmset' for course and problem settings, or 'coursepref' for course settings +# @param {string} $crstype - course type ('Community' for community settings) sub startSettingsScreen { my ($r,$mode,$crstype)=@_; @@ -345,6 +358,7 @@ sub startSettingsScreen { $r->print('
'); } +# Page footer sub endSettingsScreen { my ($r)=@_; $r->print('
'); @@ -352,18 +366,48 @@ sub endSettingsScreen { +################################################## +# (mostly) TABLE MODE +# (parmval is also used for the log of parameter changes) +################################################## + +# Calls parmval_by_symb, getting the symb from $id with &symbcache. +# +# @param {string} $what - part info and parameter name separated by a dot, e.g. '0.weight' +# @param {string} $id - resource id or map pc +# @param {string} $def - the resource's default value for this parameter +# @param {string} $uname - user name +# @param {string} $udom - user domain +# @param {string} $csec - section name +# @param {string} $cgroup - group name +# @param {hash reference} $courseopt - course parameters hash (result of lonnet::get_courseresdata, dump of course's resourcedata.db) +# @returns {Array} sub parmval { my ($what,$id,$def,$uname,$udom,$csec,$cgroup,$courseopt)=@_; return &parmval_by_symb($what,&symbcache($id),$def,$uname,$udom,$csec, $cgroup,$courseopt); } +# Returns an array containing +# - the most specific level that is defined for that parameter (integer) +# - an array with the level as index and the parameter value as value (when defined) +# (level 1 is the most specific and will have precedence) +# +# @param {string} $what - part info and parameter name separated by a dot, e.g. '0.weight' +# @param {string} $symb - resource symb or map src +# @param {string} $def - the resource's default value for this parameter +# @param {string} $uname - user name +# @param {string} $udom - user domain +# @param {string} $csec - section name +# @param {string} $cgroup - group name +# @param {hash reference} $courseopt - course parameters hash (result of lonnet::get_courseresdata, dump of course's resourcedata.db) +# @returns {Array} sub parmval_by_symb { my ($what,$symb,$def,$uname,$udom,$csec,$cgroup,$courseopt)=@_; my $useropt; if ($uname ne '' && $udom ne '') { - $useropt = &Apache::lonnet::get_userresdata($uname,$udom); + $useropt = &Apache::lonnet::get_userresdata($uname,$udom); } my $result=''; @@ -371,7 +415,10 @@ sub parmval_by_symb { # ----------------------------------------------------- Cascading lookup scheme my $map=(&Apache::lonnet::decode_symb($symb))[0]; $map = &Apache::lonnet::deversion($map); - + + # NOTE: some of that code looks redondant with code in lonnavmaps::parmval_real, + # any change should be reflected there. + my $symbparm=$symb.'.'.$what; my $recurseparm=$map.'___(rec).'.$what; my $mapparm=$map.'___(all).'.$what; @@ -394,16 +441,19 @@ sub parmval_by_symb { # --------------------------------------------------------- first, check course +# 18 - General Course if (defined($$courseopt{$courselevel})) { $outpar[18]=$$courseopt{$courselevel}; $result=18; } +# 17 - Map or Folder level in course (recursive) if (defined($$courseopt{$courseleveli})) { $outpar[17]=$$courseopt{$courseleveli}; $result=17; } +# 16 - Map or Folder level in course (non-recursive) if (defined($$courseopt{$courselevelm})) { $outpar[16]=$$courseopt{$courselevelm}; $result=16; @@ -411,14 +461,17 @@ sub parmval_by_symb { # ------------------------------------------------------- second, check default +# 15 - resource default if (defined($def)) { $outpar[15]=$def; $result=15; } # ------------------------------------------------------ third, check map parms +# 14 - map default my $thisparm=&parmhash($symbparm); if (defined($thisparm)) { $outpar[14]=$thisparm; $result=14; } +# 13 - resource level in course if (defined($$courseopt{$courselevelr})) { $outpar[13]=$$courseopt{$courselevelr}; $result=13; @@ -426,18 +479,22 @@ sub parmval_by_symb { # ------------------------------------------------------ fourth, back to course if ($csec ne '') { +# 12 - General for section if (defined($$courseopt{$seclevel})) { $outpar[12]=$$courseopt{$seclevel}; $result=12; } +# 11 - Map or Folder level for section (recursive) if (defined($$courseopt{$secleveli})) { $outpar[11]=$$courseopt{$secleveli}; $result=11; } +# 10 - Map or Folder level for section (non-recursive) if (defined($$courseopt{$seclevelm})) { $outpar[10]=$$courseopt{$seclevelm}; $result=10; } +# 9 - resource level in section if (defined($$courseopt{$seclevelr})) { $outpar[9]=$$courseopt{$seclevelr}; $result=9; @@ -445,18 +502,22 @@ sub parmval_by_symb { } # ------------------------------------------------------ fifth, check course group if ($cgroup ne '') { +# 8 - General for group if (defined($$courseopt{$grplevel})) { $outpar[8]=$$courseopt{$grplevel}; $result=8; } +# 7 - Map or Folder level for group (recursive) if (defined($$courseopt{$grpleveli})) { $outpar[7]=$$courseopt{$grpleveli}; $result=7; } +# 6 - Map or Folder level for group (non-recursive) if (defined($$courseopt{$grplevelm})) { $outpar[6]=$$courseopt{$grplevelm}; $result=6; } +# 5 - resource level in group if (defined($$courseopt{$grplevelr})) { $outpar[5]=$$courseopt{$grplevelr}; $result=5; @@ -466,25 +527,29 @@ sub parmval_by_symb { # ---------------------------------------------------------- sixth, check user if ($uname ne '') { - if (defined($$useropt{$courselevel})) { - $outpar[4]=$$useropt{$courselevel}; - $result=4; - } +# 4 - General for specific student + if (defined($$useropt{$courselevel})) { + $outpar[4]=$$useropt{$courselevel}; + $result=4; + } - if (defined($$useropt{$courseleveli})) { - $outpar[3]=$$useropt{$courseleveli}; - $result=3; - } +# 3 - Map or Folder level for specific student (recursive) + if (defined($$useropt{$courseleveli})) { + $outpar[3]=$$useropt{$courseleveli}; + $result=3; + } - if (defined($$useropt{$courselevelm})) { - $outpar[2]=$$useropt{$courselevelm}; - $result=2; - } +# 2 - Map or Folder level for specific student (non-recursive) + if (defined($$useropt{$courselevelm})) { + $outpar[2]=$$useropt{$courselevelm}; + $result=2; + } - if (defined($$useropt{$courselevelr})) { - $outpar[1]=$$useropt{$courselevelr}; - $result=1; - } +# 1 - resource level for specific student + if (defined($$useropt{$courselevelr})) { + $outpar[1]=$$useropt{$courselevelr}; + $result=1; + } } return ($result,@outpar); } @@ -494,106 +559,128 @@ sub parmval_by_symb { # --- Caches local to lonparmset +# Reset lonparmset caches (called at the beginning and end of the handler). sub reset_caches { &resetparmhash(); &resetsymbcache(); &resetrulescache(); } +# cache for map parameters, stored temporarily in $env{'request.course.fn'}_parms.db +# (these parameters come from param elements in .sequence files created with the advanced RAT) { - my $parmhashid; - my %parmhash; + my $parmhashid; # course identifier, to initialize the cache only once for a course + my %parmhash; # the parameter cache + # reset map parameter hash sub resetparmhash { - undef($parmhashid); - undef(%parmhash); + undef($parmhashid); + undef(%parmhash); } + # dump the _parms.db database into %parmhash 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'}; - } + 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'}; + } } + # returns a parameter value for an identifier symb.parts.parameter, using the map parameter cache sub parmhash { - my ($id) = @_; - &cacheparmhash(); - return $parmhash{$id}; + my ($id) = @_; + &cacheparmhash(); + return $parmhash{$id}; } - } +} +# cache resource id or map pc -> resource symb or map src, using lonnavmaps to find association { - my $symbsid; - my %symbs; + my $symbsid; # course identifier, to initialize the cache only once for a course + my %symbs; # hash id->symb + # reset the id->symb cache sub resetsymbcache { - undef($symbsid); - undef(%symbs); + undef($symbsid); + undef(%symbs); } + # returns the resource symb or map src corresponding to a resource id or map pc + # (using lonnavmaps and a cache) sub symbcache { - my $id=shift; - if ($symbsid ne $env{'request.course.id'}) { - undef(%symbs); - } - if (!$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()); + my $id=shift; + if ($symbsid ne $env{'request.course.id'}) { + undef(%symbs); + } + if (!$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'}; } - $symbsid=$env{'request.course.id'}; + return $symbs{$id}; } - return $symbs{$id}; - } - } +} +# cache for parameter default actions (stored in parmdefactions.db) { - my $rulesid; - my %rules; + my $rulesid; # course identifier, to initialize the cache only once for a course + my %rules; # parameter default actions hash sub resetrulescache { - undef($rulesid); - undef(%rules); + undef($rulesid); + undef(%rules); } + # returns the value for a given key in the parameter default action hash sub rulescache { - my $id=shift; - if ($rulesid ne $env{'request.course.id'} - && !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}; + my $id=shift; + if ($rulesid ne $env{'request.course.id'} + && !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}; } } - +# Returns the values of the parameter type default action +# "default value when manually setting". +# If none is defined, ('','','','','') is returned. +# +# @param {string} $type - parameter type +# @returns {Array} - (hours, min, sec, value) 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')); + # yes, there is something + return (&rulescache($type.'_hours'), + &rulescache($type.'_min'), + &rulescache($type.'_sec'), + &rulescache($type.'_value')); } else { -# nothing there or something else - return ('','','','',''); + # nothing there or something else + return ('','','','',''); } } - - +# Checks that a date is after enrollment start date and before +# enrollment end date. +# Returns HTML with a warning if it is not, or the empty string otherwise. +# This is used by both overview and table modes. +# +# @param {integer} $checkdate - the date to check. +# @returns {string} - HTML possibly containing a localized warning message. sub date_sanity_info { my $checkdate=shift; unless ($checkdate) { return ''; } @@ -628,81 +715,109 @@ sub date_sanity_info { # } return $result; } -################################################## -################################################## -# -# Store a parameter by ID -# -# Takes -# - resource id -# - name of parameter -# - level -# - new value -# - new type -# - username -# - userdomain + +# Store a parameter value and type by ID, also triggering more parameter changes based on parameter default actions. +# +# @param {string} $sresid - resource id or map pc +# @param {string} $spnam - part info and parameter name separated by a dot or underscore, e.g. '0.weight' +# @param {integer} $snum - level +# @param {string} $nval - new value +# @param {string} $ntype - new type +# @param {string} $uname - username +# @param {string} $udom - userdomain +# @param {string} $csec - section name +# @param {string} $cgroup - group name sub storeparm { my ($sresid,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec,$cgroup)=@_; &storeparm_by_symb(&symbcache($sresid),$spnam,$snum,$nval,$ntype,$uname,$udom,$csec,'',$cgroup); } -my %recstack; +my %recstack; # hash parameter name -> 1 when a parameter was used before in a recursive call to storeparm_by_symb + +# Store a parameter value and type by symb, also triggering more parameter changes based on parameter default actions. +# Uses storeparm_by_symb_inner to actually store the parameter, ignoring any returned error. +# +# @param {string} $symb - resource symb or map src +# @param {string} $spnam - part info and parameter name separated by a dot or underscore, e.g. '0.weight' +# @param {integer} $snum - level +# @param {string} $nval - new value +# @param {string} $ntype - new type +# @param {string} $uname - username +# @param {string} $udom - userdomain +# @param {string} $csec - section name +# @param {boolean} $recflag - should be true for recursive calls to storeparm_by_symb, false otherwise +# @param {string} $cgroup - group name sub storeparm_by_symb { my ($symb,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec,$recflag,$cgroup)=@_; unless ($recflag) { -# first time call - %recstack=(); - $recflag=1; + # first time call + %recstack=(); + $recflag=1; } -# store parameter + # store parameter &storeparm_by_symb_inner ($symb,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec,$cgroup); -# don't do anything if parameter was reset + # don't do anything if parameter was reset unless ($nval) { return; } my ($prefix,$parm)=($spnam=~/^(.*[\_\.])([^\_\.]+)$/); -# remember that this was set + # remember that this was set $recstack{$parm}=1; -# what does this trigger? + # 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,$cgroup); - } - } + # 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,$cgroup); + } + } } return ''; } +# Adds all given arguments to the course parameter log. +# @returns {string} - the answer to the lonnet query. sub log_parmset { return &Apache::lonnet::write_log('course','parameterlog',@_); } +# Store a parameter value and type by symb, without using the parameter default actions. +# Expire related sheets. +# +# @param {string} $symb - resource symb or map src +# @param {string} $spnam - part info and parameter name separated by a dot, e.g. '0.weight' +# @param {integer} $snum - level +# @param {string} $nval - new value +# @param {string} $ntype - new type +# @param {string} $uname - username +# @param {string} $udom - userdomain +# @param {string} $csec - section name +# @param {string} $cgroup - group name +# @returns {string} - HTML code with an error message if the parameter could not be stored. sub storeparm_by_symb_inner { # ---------------------------------------------------------- Get symb, map, etc my ($symb,$spnam,$snum,$nval,$ntype,$uname,$udom,$csec,$cgroup)=@_; @@ -750,66 +865,76 @@ sub storeparm_by_symb_inner { my %storecontent = ($storeunder => $nval, $storeunder.'.type' => $ntype); my $reply=''; + if ($snum>4) { # ---------------------------------------------------------------- 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==13) || ($snum==9) || ($snum==5)) { - &Apache::lonnet::expirespread('','','assesscalc',$symb); -#FIXME - } elsif (($snum==14) || ($snum==10) || ($snum==6)) { - &Apache::lonnet::expirespread('','','assesscalc',$map); - } else { - &Apache::lonnet::expirespread('','','assesscalc'); - } -# Store parameter - if ($delete) { - $reply=&Apache::lonnet::del - ('resourcedata',[keys(%storecontent)],$cdom,$cnum); - &log_parmset(\%storecontent,1); - } else { - $reply=&Apache::lonnet::cput - ('resourcedata',\%storecontent,$cdom,$cnum); - &log_parmset(\%storecontent); - } - &Apache::lonnet::devalidatecourseresdata($cnum,$cdom); + 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==13) || ($snum==9) || ($snum==5)) { + &Apache::lonnet::expirespread('','','assesscalc',$symb); + } elsif (($snum==14) || ($snum==10) || ($snum==6)) { + &Apache::lonnet::expirespread('','','assesscalc',$map); + } else { + &Apache::lonnet::expirespread('','','assesscalc'); + } + # Store parameter + if ($delete) { + $reply=&Apache::lonnet::del + ('resourcedata',[keys(%storecontent)],$cdom,$cnum); + &log_parmset(\%storecontent,1); + } else { + $reply=&Apache::lonnet::cput + ('resourcedata',\%storecontent,$cdom,$cnum); + &log_parmset(\%storecontent); + } + &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); - &log_parmset(\%storecontent,1,$uname,$udom); - } else { - $reply=&Apache::lonnet::cput - ('resourcedata',\%storecontent,$udom,$uname); - &log_parmset(\%storecontent,0,$uname,$udom); - } - &Apache::lonnet::devalidateuserresdata($uname,$udom); + # 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); + &log_parmset(\%storecontent,1,$uname,$udom); + } else { + $reply=&Apache::lonnet::cput + ('resourcedata',\%storecontent,$udom,$uname); + &log_parmset(\%storecontent,0,$uname,$udom); + } + &Apache::lonnet::devalidateuserresdata($uname,$udom); } if ($reply=~/^error\:(.*)/) { - return "Write Error: $1"; + return "Write Error: $1"; } return ''; } +# Returns HTML with the value of the given parameter, +# using a readable format for dates, and +# a warning if there is a problem with a date. +# Used by table mode. +# Returns HTML for the editmap.png image if no value is defined and $editable is true. +# +# @param {string} $value - the parameter value +# @param {string} $type - the parameter type +# @param {string} $name - the parameter name (unused) +# @param {boolean} $editable - Set to true to get an icon when no value is defined. sub valout { my ($value,$type,$name,$editable)=@_; my $result = ''; @@ -825,7 +950,16 @@ sub valout { } } else { if ($type eq 'date_interval') { - my ($totalsecs,$donebutton) = split(/_/,$value); + my ($totalsecs,$donesuffix) = split(/_/,$value,2); + my ($usesdone,$donebuttontext,$proctor,$secretkey); + if ($donesuffix =~ /^done\:([^\:]+)\:(.*)$/) { + $donebuttontext = $1; + (undef,$proctor,$secretkey) = split(/_/,$2); + $usesdone = 'done'; + } elsif ($donesuffix =~ /^done(|_.+)$/) { + $donebuttontext = &mt('Done'); + ($usesdone,$proctor,$secretkey) = split(/_/,$donesuffix); + } my ($sec,$min,$hour,$mday,$mon,$year)=gmtime($totalsecs); my @timer; $year=$year-70; @@ -859,27 +993,40 @@ sub valout { push(@timer,&mt('[quant,_1,sec]',0)); } $result.=join(", ",@timer); - if ($donebutton eq 'done') { - $result .= ' '.&mt('+ "done"'); + if ($usesdone eq 'done') { + if ($secretkey) { + $result .= ' '.&mt('+ "[_1]" with proctor key: [_2]',$donebuttontext,$secretkey); + } else { + $result .= ' + "'.$donebuttontext.'"'; + } } } elsif (&isdateparm($type)) { $result = &Apache::lonlocal::locallocaltime($value). - &date_sanity_info($value); + &date_sanity_info($value); } else { $result = $value; $result=~s/\,/\, /gs; - $result = &HTML::Entities::encode($result,'"<>&'); + $result = &HTML::Entities::encode($result,'"<>&'); } } return $result; } +# Returns HTML containing a link on a parameter value, for table mode. +# The link uses the javascript function 'pjump'. +# +# @param {string} $type - parameter type +# @param {string} $dis - dialog title for editing the parameter value and type +# @param {string} $value - parameter value +# @param {string} $marker - identifier for the parameter, "resource id&part_parameter name&level", will be passed as pres_marker when the user submits a change. +# @param {string} $return - prefix for the name of the form and field names that will be used to submit the form ('parmform.pres') +# @param {string} $call - javascript function to call to submit the form ('psub') sub plink { my ($type,$dis,$value,$marker,$return,$call)=@_; my $winvalue=$value; unless ($winvalue) { - if (&isdateparm($type)) { + if (&isdateparm($type)) { $winvalue=$env{'form.recent_'.$type}; } else { $winvalue=$env{'form.recent_'.(split(/\_/,$type))[0]}; @@ -892,8 +1039,8 @@ sub plink { my $unencmarker = $marker; foreach my $item (\$type, \$dis, \$winvalue, \$marker, \$return, \$call, \$hour, \$min, \$sec) { - $$item = &HTML::Entities::encode($$item,'"<>&'); - $$item =~ s/\'/\\\'/g; + $$item = &HTML::Entities::encode($$item,'"<>&'); + $$item =~ s/\'/\\\'/g; } return '
'. '
'; } +# Javascript for table mode. sub page_js { my $selscript=&Apache::loncommon::studentbrowser_javascript(); @@ -917,16 +1065,16 @@ sub page_js { document.parmform.action+='#'+document.parmform.pres_marker.value; var typedef=new Array(); typedef=document.parmform.pres_type.value.split('_'); - if (document.parmform.pres_type.value!='') { - if (typedef[0]=='date') { - eval('document.parmform.recent_'+ - document.parmform.pres_type.value+ - '.value=document.parmform.pres_value.value;'); - } else { - eval('document.parmform.recent_'+typedef[0]+ - '.value=document.parmform.pres_value.value;'); + if (document.parmform.pres_type.value!='') { + if (typedef[0]=='date') { + eval('document.parmform.recent_'+ + document.parmform.pres_type.value+ + '.value=document.parmform.pres_value.value;'); + } else { + eval('document.parmform.recent_'+typedef[0]+ + '.value=document.parmform.pres_value.value;'); + } } - } document.parmform.submit(); } else { document.parmform.pres_value.value=''; @@ -950,6 +1098,8 @@ ENDJS } +# Javascript to show or hide the map selection (function showHide_courseContent), +# for table and overview modes. sub showhide_js { return <<"COURSECONTENTSCRIPT"; @@ -970,6 +1120,7 @@ function showHide_courseContent() { COURSECONTENTSCRIPT } +# Javascript functions showHideLenient and toggleParmTextbox, for overview mode sub toggleparmtextbox_js { return <<"ENDSCRIPT"; @@ -1029,6 +1180,7 @@ function toggleParmTextbox(form,key) { ENDSCRIPT } +# Javascript function validateParms, for overview mode sub validateparms_js { return <<'ENDSCRIPT'; @@ -1102,6 +1254,7 @@ function validateParms() { ENDSCRIPT } +# Javascript initialization, for overview mode sub ipacc_boxes_js { my $remove = &mt('Remove'); return <<"END"; @@ -1126,6 +1279,36 @@ sub ipacc_boxes_js { END } +# Javascript function toggleSecret, for overview mode. +sub done_proctor_js { + return <<"END"; +function toggleSecret(form,radio,key) { + var radios = form[radio+key]; + if (radios.length) { + for (var i=0; i'Problem_Parameters', - text=>"Problem Parameters"}); + if ((($env{'form.command'} eq 'set') && ($env{'form.url'}) && + (!$env{'form.dis'})) || ($env{'form.symb'})) { + &Apache::lonhtmlcommon::add_breadcrumb({help=>'Problem_Parameters', + text=>"Problem Parameters"}); } else { - &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=settable', - text=>"Table Mode", - help => 'Course_Setting_Parameters'}); + &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=settable', + text=>"Table Mode", + help => 'Course_Setting_Parameters'}); } my $js = &page_js().' ENDPARMSELSCRIPT if (!$pssymb) { + # No single resource selected, print forms to select things (hidden after first selection) my $parmselhiddenstyle=' style="display:none"'; if($env{'form.hideparmsel'} eq 'hidden') { $r->print('
'); @@ -2666,26 +3101,26 @@ ENDPARMSELSCRIPT # # This produces the cascading table output of parameters # - my $coursespan=$csec?10:6; - my $userspan=4; - if ($cgroup ne '') { - $coursespan += 4; - } - - $r->print(&Apache::loncommon::start_data_table()); -# -# This produces the headers -# - $r->print(''); - $r->print(''.&mt('Any User').''); - if ($uname) { + my $coursespan=$csec?10:6; + my $userspan=4; + if ($cgroup ne '') { + $coursespan += 4; + } + + $r->print(&Apache::loncommon::start_data_table()); + # + # This produces the headers + # + $r->print(''); + $r->print(''.&mt('Any User').''); + if ($uname) { if (@usersgroups > 1) { - $userspan ++; - } - $r->print(''); - $r->print(&mt('User [_1] at Domain [_2]',"'".$uname."'","'".$udom."'").''); - } - my %lt=&Apache::lonlocal::texthash( + $userspan ++; + } + $r->print(''); + $r->print(&mt('User [_1] at Domain [_2]',"'".$uname."'","'".$udom."'").''); + } + my %lt=&Apache::lonlocal::texthash( 'pie' => "Parameter in Effect", 'csv' => "Current Session Value", 'rl' => "Resource Level", @@ -2702,59 +3137,59 @@ ENDPARMSELSCRIPT 'formfr' => 'for Map or Folder (recursive)', 'fr' => 'for Resource' ); - $r->print(<print(<$lt{'pie'} $lt{'csv'}
($csuname:$csudom) $lt{'ic'}$lt{'rl'} $lt{'ic'} ENDTABLETWO - if ($csec) { - $r->print(''. - &mt("in Section")." $csec"); - } - if ($cgroup) { + if ($csec) { + $r->print(''. + &mt("in Section")." $csec"); + } + if ($cgroup) { $r->print(''. &mt("in Group")." $cgroup"); - } - $r->print(<print(<$lt{'aut'}$lt{'type'} $lt{'emof'}$lt{'part'}$lt{'pn'} $lt{'gen'}$lt{'formfr'}$lt{'foremf'} $lt{'def'}$lt{'femof'}$lt{'fr'} ENDTABLEHEADFOUR - if ($csec) { - $r->print(''.$lt{'gen'}.''.$lt{'formfr'}.''.$lt{'foremf'}.''.$lt{'fr'}.''); - } - - if ($cgroup) { - $r->print(''.$lt{'gen'}.''.$lt{'formfr'}.''.&mt('foremf').''.$lt{'fr'}.''); - } - - if ($uname) { - if (@usersgroups > 1) { - $r->print(''.&mt('Control by other group?').''); - } - $r->print(''.$lt{'gen'}.''.$lt{'formfr'}.''.$lt{'foremf'}.''.$lt{'fr'}.''); - } + if ($csec) { + $r->print(''.$lt{'gen'}.''.$lt{'formfr'}.''.$lt{'foremf'}.''.$lt{'fr'}.''); + } + + if ($cgroup) { + $r->print(''.$lt{'gen'}.''.$lt{'formfr'}.''.&mt('foremf').''.$lt{'fr'}.''); + } + + if ($uname) { + if (@usersgroups > 1) { + $r->print(''.&mt('Control by other group?').''); + } + $r->print(''.$lt{'gen'}.''.$lt{'formfr'}.''.$lt{'foremf'}.''.$lt{'fr'}.''); + } - $r->print(''); + $r->print(''); # # Done with the headers # - my $defbgone=''; - my $defbgtwo=''; - my $defbgthree = ''; + my $defbgone=''; + my $defbgtwo=''; + my $defbgthree = ''; - foreach my $rid (@ids) { + foreach my $rid (@ids) { my ($inmapid)=($rid=~/\.(\d+)$/); if ((!$pssymb && - (($pschp eq 'all') || ($allmaps{$pschp} eq $mapp{$rid}))) - || - ($pssymb && $pssymb eq $symbp{$rid})) { + (($pschp eq 'all') || ($allmaps{$pschp} eq $mapp{$rid}))) + || + ($pssymb && $pssymb eq $symbp{$rid})) { # ------------------------------------------------------ Entry for one resource if ($defbgone eq '#E0E099') { $defbgone='#E0E0DD'; @@ -2784,34 +3219,34 @@ ENDTABLEHEADFOUR my $filter=$env{'form.filter'}; foreach my $tempkeyp (&keysplit($keyp{$rid})) { if (grep $_ eq $tempkeyp, @catmarker) { - my $parmname=&Apache::lonnet::metadata($uri,$tempkeyp.'.name'); -# We may only want certain parameters listed - if ($filter) { - unless ($filter=~/\Q$parmname\E/) { next; } - } - $name{$tempkeyp}=$parmname; - $part{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp.'.part'); - - my $parmdis=&Apache::lonnet::metadata($uri,$tempkeyp.'.display'); - if ($allparms{$name{$tempkeyp}} ne '') { - my $identifier; - if ($parmdis =~ /(\s*\[Part.*)$/) { - $identifier = $1; - } - $display{$tempkeyp} = $allparms{$name{$tempkeyp}}.$identifier; - } else { - $display{$tempkeyp} = $parmdis; - } - unless ($display{$tempkeyp}) { $display{$tempkeyp}=''; } - $display{$tempkeyp}.=' ('.$name{$tempkeyp}.')'; - $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp); - $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp.'.type'); - $thistitle=&Apache::lonnet::metadata($uri,$tempkeyp.'.title'); + my $parmname=&Apache::lonnet::metadata($uri,$tempkeyp.'.name'); + # We may only want certain parameters listed + if ($filter) { + unless ($filter=~/\Q$parmname\E/) { next; } + } + $name{$tempkeyp}=$parmname; + $part{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp.'.part'); + + my $parmdis=&Apache::lonnet::metadata($uri,$tempkeyp.'.display'); + if ($allparms{$name{$tempkeyp}} ne '') { + my $identifier; + if ($parmdis =~ /(\s*\[Part.*)$/) { + $identifier = $1; + } + $display{$tempkeyp} = $allparms{$name{$tempkeyp}}.$identifier; + } else { + $display{$tempkeyp} = $parmdis; + } + unless ($display{$tempkeyp}) { $display{$tempkeyp}=''; } + $display{$tempkeyp}.=' ('.$name{$tempkeyp}.')'; + $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp); + $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp.'.type'); + $thistitle=&Apache::lonnet::metadata($uri,$tempkeyp.'.title'); } } my $totalparms=scalar(keys(%name)); if ($totalparms>0) { - my $firstrow=1; + my $firstrow=1; my $title=&Apache::lonnet::gettitle($symbp{$rid}); $r->print('print(&Apache::loncommon::end_page()); } # end sub assessparms + + ################################################## -# Overview mode +# OVERVIEW MODE ################################################## -my $tableopen; +my $tableopen; # boolean, true if HTML table is already opened + +# Returns HTML with the HTML table start tag and header, unless the table is already opened. +# @param {boolean} $readonly - true if values cannot be edited (otherwise more columns are added) +# @returns {string} sub tablestart { my ($readonly) = @_; if ($tableopen) { @@ -3092,15 +3533,24 @@ sub tablestart { } } +# Returns HTML with the HTML table end tag, unless the table is not opened. +# @returns {string} sub tableend { if ($tableopen) { - $tableopen=0; - return &Apache::loncommon::end_data_table(); + $tableopen=0; + return &Apache::loncommon::end_data_table(); } else { - return''; + return''; } } +# Reads course and user information. +# If the context is looking for a scalar, returns the course parameters hash (result of lonnet::get_courseresdata, dump of course's resourcedata.db) with added student data from lonnet::get_userresdata (which reads the user's resourcedata.db). +# The key for student data is modified with '[useropt:'.username.':'.userdomain.'].'. +# If the context is looking for a list, returns a list with the scalar data and the class list. +# @param {string} $crs - course number +# @param {string} $dom - course domain +# @returns {hash reference|Array} sub readdata { my ($crs,$dom)=@_; # Read coursedata @@ -3129,8 +3579,24 @@ sub readdata { } -# Setting - +# Stores parameter data, using form parameters directly. +# +# Uses the following form parameters. The variable part in the names is a resourcedata key (except for a modification for user data). +# set_* (except settext, setipallow, setipdeny) - set a parameter value +# del_* - remove a parameter +# datepointer_* - set a date parameter (value is key_* refering to a set of other form parameters) +# dateinterval_* - set a date interval parameter (value refers to more form parameters) +# key_* - date values +# days_* - for date intervals +# hours_* - for date intervals +# minutes_* - for date intervals +# seconds_* - for date intervals +# done_* - for date intervals +# typeof_* - parameter type +# +# @param {Apache2::RequestRec} $r - the Apache request +# @param {string} $crs - course number +# @param {string} $dom - course domain sub storedata { my ($r,$crs,$dom)=@_; # Set userlevel immediately @@ -3142,183 +3608,220 @@ sub storedata { undef @deldata; my ($got_chostname,$chostname,$cmajor,$cminor); my $now = time; - foreach my $key (keys(%env)) { - if ($key =~ /^form\.([a-z]+)\_(.+)$/) { - my $cmd=$1; - my $thiskey=$2; - next if ($cmd eq 'settext' || $cmd eq 'setipallow' || $cmd eq 'setipdeny'); - my ($tuname,$tudom)=&extractuser($thiskey); - my $tkey=$thiskey; + foreach my $key (keys(%env)) { + if ($key =~ /^form\.([a-z]+)\_(.+)$/) { + my $cmd=$1; + my $thiskey=$2; + next if ($cmd eq 'settext' || $cmd eq 'setipallow' || $cmd eq 'setipdeny'); + my ($tuname,$tudom)=&extractuser($thiskey); + my $tkey=$thiskey; if ($tuname) { - $tkey=~s/\.\[useropt\:$tuname\:$tudom\]\./\./; - } - if ($cmd eq 'set' || $cmd eq 'datepointer' || $cmd eq 'dateinterval') { - my ($data, $typeof, $text, $name, $valchk, $valmatch); - if ($cmd eq 'set') { - $data=$env{$key}; - $valmatch = ''; - $valchk = $data; - $typeof=$env{'form.typeof_'.$thiskey}; - $text = &mt('Saved modified parameter for'); - if ($typeof eq 'string_questiontype') { - $name = 'type'; - } elsif ($typeof eq 'string_lenient') { - $name = 'lenient'; - my $stringmatch = &standard_string_matches($typeof); - if (ref($stringmatch) eq 'ARRAY') { - foreach my $item (@{$stringmatch}) { - if (ref($item) eq 'ARRAY') { - my ($regexpname,$pattern) = @{$item}; - if ($pattern ne '') { - if ($data =~ /$pattern/) { - $valmatch = $regexpname; - $valchk = ''; - last; + $tkey=~s/\.\[useropt\:$tuname\:$tudom\]\./\./; + } + if ($cmd eq 'set' || $cmd eq 'datepointer' || $cmd eq 'dateinterval') { + my ($data, $typeof, $text, $name, $valchk, $valmatch, $namematch); + if ($cmd eq 'set') { + $data=$env{$key}; + $valmatch = ''; + $valchk = $data; + $typeof=$env{'form.typeof_'.$thiskey}; + $text = &mt('Saved modified parameter for'); + if ($typeof eq 'string_questiontype') { + $name = 'type'; + } elsif ($typeof eq 'string_lenient') { + $name = 'lenient'; + my $stringmatch = &standard_string_matches($typeof); + if (ref($stringmatch) eq 'ARRAY') { + foreach my $item (@{$stringmatch}) { + if (ref($item) eq 'ARRAY') { + my ($regexpname,$pattern) = @{$item}; + if ($pattern ne '') { + if ($data =~ /$pattern/) { + $valmatch = $regexpname; + $valchk = ''; + last; + } + } } } } + } elsif ($typeof eq 'string_discussvote') { + $name = 'discussvote'; + } elsif ($typeof eq 'string_examcode') { + $name = 'examcode'; + if (&Apache::lonnet::validCODE($data)) { + $valchk = 'valid'; + } + } elsif ($typeof eq 'string_yesno') { + if ($thiskey =~ /\.retrypartial$/) { + $name = 'retrypartial'; + } } - } - } elsif ($typeof eq 'string_discussvote') { - $name = 'discussvote'; - } elsif ($typeof eq 'string_examcode') { - $name = 'examcode'; - if (&Apache::lonnet::validCODE($data)) { - $valchk = 'valid'; - } - } elsif ($typeof eq 'string_yesno') { - if ($thiskey =~ /\.retrypartial$/) { - $name = 'retrypartial'; - } - } - } elsif ($cmd eq 'datepointer') { - $data=&Apache::lonhtmlcommon::get_date_from_form($env{$key}); - $typeof=$env{'form.typeof_'.$thiskey}; - $text = &mt('Saved modified date for'); - if ($typeof eq 'date_start') { - if ($thiskey =~ /\.printstartdate$/) { - $name = 'printstartdate'; - if (($data) && ($data > $now)) { - $valchk = 'future'; - } - } - } elsif ($typeof eq 'date_end') { - if ($thiskey =~ /\.printenddate$/) { - $name = 'printenddate'; - if (($data) && ($data < $now)) { - $valchk = 'past'; + } elsif ($cmd eq 'datepointer') { + $data=&Apache::lonhtmlcommon::get_date_from_form($env{$key}); + $typeof=$env{'form.typeof_'.$thiskey}; + $text = &mt('Saved modified date for'); + if ($typeof eq 'date_start') { + if ($thiskey =~ /\.printstartdate$/) { + $name = 'printstartdate'; + if (($data) && ($data > $now)) { + $valchk = 'future'; + } + } + } elsif ($typeof eq 'date_end') { + if ($thiskey =~ /\.printenddate$/) { + $name = 'printenddate'; + if (($data) && ($data < $now)) { + $valchk = 'past'; + } + } } + } elsif ($cmd eq 'dateinterval') { + $data=&get_date_interval_from_form($thiskey); + if ($thiskey =~ /\.interval$/) { + $name = 'interval'; + my $intervaltype = &get_intervaltype($name); + my $intervalmatch = &standard_interval_matches($intervaltype); + if (ref($intervalmatch) eq 'ARRAY') { + foreach my $item (@{$intervalmatch}) { + if (ref($item) eq 'ARRAY') { + my ($regexpname,$pattern) = @{$item}; + if ($pattern ne '') { + if ($data =~ /$pattern/) { + $valmatch = $regexpname; + $valchk = ''; + last; + } + } + } + } + } + } + $typeof=$env{'form.typeof_'.$thiskey}; + $text = &mt('Saved modified date for'); } - } - } elsif ($cmd eq 'dateinterval') { - $data=&get_date_interval_from_form($thiskey); - if ($thiskey =~ /\.interval$/) { - $name = 'interval'; - my $intervaltype = &get_intervaltype($name); - my $intervalmatch = &standard_interval_matches($intervaltype); - if (ref($intervalmatch) eq 'ARRAY') { - foreach my $item (@{$intervalmatch}) { - if (ref($item) eq 'ARRAY') { - my ($regexpname,$pattern) = @{$item}; - if ($pattern ne '') { - if ($data =~ /$pattern/) { - $valmatch = $regexpname; - $valchk = ''; - last; + if ($thiskey =~ m{\.(?:sequence|page)___\(rec\)}) { + $namematch = 'maplevelrecurse'; + } + if (($name ne '') || ($namematch ne '')) { + my ($needsrelease,$needsnewer); + if ($name ne '') { + $needsrelease = $Apache::lonnet::needsrelease{"parameter:$name:$valchk:$valmatch:"}; + if ($needsrelease) { + unless ($got_chostname) { + ($chostname,$cmajor,$cminor)=¶meter_release_vars(); + $got_chostname = 1; + } + $needsnewer = ¶meter_releasecheck($name,$valchk,$valmatch,undef, + $needsrelease, + $cmajor,$cminor); + } + } + if ($namematch ne '') { + if ($needsnewer) { + undef($namematch); + } else { + my $currneeded; + if ($needsrelease) { + $currneeded = $needsrelease; + } + $needsrelease = + $Apache::lonnet::needsrelease{"parameter::::$namematch"}; + if (($needsrelease) && + (($currneeded eq '') || ($needsrelease < $currneeded))) { + unless ($got_chostname) { + ($chostname,$cmajor,$cminor) = ¶meter_release_vars(); + $got_chostname = 1; } + $needsnewer = ¶meter_releasecheck(undef,$valchk,$valmatch, + $namematch, $needsrelease,$cmajor,$cminor); + } else { + undef($namematch); } } } + if ($needsnewer) { + $r->print('
'.&oldversion_warning($name,$namematch,$data, + $chostname,$cmajor, + $cminor,$needsrelease)); + next; + } } - } - $typeof=$env{'form.typeof_'.$thiskey}; - $text = &mt('Saved modified date for'); - } - if ($name ne '') { - my ($needsrelease,$needsnewer); - $needsrelease = $Apache::lonnet::needsrelease{"parameter:$name:$valchk:$valmatch"}; - if ($needsrelease) { - unless ($got_chostname) { - ($chostname,$cmajor,$cminor)=¶meter_release_vars(); - $got_chostname = 1; + if (defined($data) and $$olddata{$thiskey} ne $data) { + if ($tuname) { + if (&Apache::lonnet::put('resourcedata',{$tkey=>$data, + $tkey.'.type' => $typeof}, + $tudom,$tuname) eq 'ok') { + &log_parmset({$tkey=>$data,$tkey.'.type' => $typeof},0,$tuname,$tudom); + $r->print('
'.$text.' '. + &Apache::loncommon::plainname($tuname,$tudom)); + } else { + $r->print('
'. + &mt('Error saving parameters').'
'); + } + &Apache::lonnet::devalidateuserresdata($tuname,$tudom); + } else { + $newdata{$thiskey}=$data; + $newdata{$thiskey.'.type'}=$typeof; + } } - $needsnewer = ¶meter_releasecheck($name,$valchk,$valmatch, - $needsrelease, - $cmajor,$cminor); - if ($needsnewer) { - $r->print('
'.&oldversion_warning($name,$data, - $chostname,$cmajor, - $cminor,$needsrelease)); - next; + } elsif ($cmd eq 'del') { + if ($tuname) { + if (&Apache::lonnet::del('resourcedata',[$tkey],$tudom,$tuname) eq 'ok') { + &log_parmset({$tkey=>''},1,$tuname,$tudom); + $r->print('
'.&mt('Deleted parameter for').' '.&Apache::loncommon::plainname($tuname,$tudom)); + } else { + $r->print('
'. + &mt('Error deleting parameters').'
'); + } + &Apache::lonnet::devalidateuserresdata($tuname,$tudom); + } else { + push (@deldata,$thiskey,$thiskey.'.type'); } } } - if (defined($data) and $$olddata{$thiskey} ne $data) { - if ($tuname) { - if (&Apache::lonnet::put('resourcedata',{$tkey=>$data, - $tkey.'.type' => $typeof}, - $tudom,$tuname) eq 'ok') { - &log_parmset({$tkey=>$data,$tkey.'.type' => $typeof},0,$tuname,$tudom); - $r->print('
'.$text.' '. - &Apache::loncommon::plainname($tuname,$tudom)); - } else { - $r->print('
'. - &mt('Error saving parameters').'
'); - } - &Apache::lonnet::devalidateuserresdata($tuname,$tudom); - } else { - $newdata{$thiskey}=$data; - $newdata{$thiskey.'.type'}=$typeof; - } - } - } elsif ($cmd eq 'del') { - if ($tuname) { - if (&Apache::lonnet::del('resourcedata',[$tkey],$tudom,$tuname) eq 'ok') { - &log_parmset({$tkey=>''},1,$tuname,$tudom); - $r->print('
'.&mt('Deleted parameter for').' '.&Apache::loncommon::plainname($tuname,$tudom)); - } else { - $r->print('
'. - &mt('Error deleting parameters').'
'); - } - &Apache::lonnet::devalidateuserresdata($tuname,$tudom); - } else { - push (@deldata,$thiskey,$thiskey.'.type'); - } - } - } } # Store all course level my $delentries=$#deldata+1; my @newdatakeys=keys(%newdata); my $putentries=$#newdatakeys+1; if ($delentries) { - if (&Apache::lonnet::del('resourcedata',\@deldata,$dom,$crs) eq 'ok') { - my %loghash=map { $_ => '' } @deldata; - &log_parmset(\%loghash,1); - $r->print('

'.&mt('Deleted [quant,_1,parameter]',$delentries/2).'

'); - } else { - $r->print('
'. - &mt('Error deleting parameters').'
'); - } - &Apache::lonnet::devalidatecourseresdata($crs,$dom); + if (&Apache::lonnet::del('resourcedata',\@deldata,$dom,$crs) eq 'ok') { + my %loghash=map { $_ => '' } @deldata; + &log_parmset(\%loghash,1); + $r->print('

'.&mt('Deleted [quant,_1,parameter]',$delentries/2).'

'); + } else { + $r->print('
'. + &mt('Error deleting parameters').'
'); + } + &Apache::lonnet::devalidatecourseresdata($crs,$dom); } if ($putentries) { - if (&Apache::lonnet::put('resourcedata',\%newdata,$dom,$crs) eq 'ok') { - &log_parmset(\%newdata,0); - $r->print('

'.&mt('Saved [quant,_1,parameter]',$putentries/2).'

'); - } else { - $r->print('
'. - &mt('Error saving parameters').'
'); - } - &Apache::lonnet::devalidatecourseresdata($crs,$dom); + if (&Apache::lonnet::put('resourcedata',\%newdata,$dom,$crs) eq 'ok') { + &log_parmset(\%newdata,0); + $r->print('

'.&mt('Saved [quant,_1,parameter]',$putentries/2).'

'); + } else { + $r->print('
'. + &mt('Error saving parameters').'
'); + } + &Apache::lonnet::devalidatecourseresdata($crs,$dom); } } +# Returns the username and domain from a key created in readdata from a resourcedata key. +# +# @param {string} $key - the key +# @returns {Array} sub extractuser { my $key=shift; return ($key=~/^$env{'request.course.id'}.\[useropt\:($match_username)\:($match_domain)\]\./); } +# Parses a parameter key and returns the components. +# +# @param {string} $key - +# @param {hash reference} $listdata - +# @return {Array} - (student, resource, part, parameter) sub parse_listdata_key { my ($key,$listdata) = @_; # split into student/section affected, and @@ -3327,11 +3830,11 @@ sub parse_listdata_key { ($key=~/^\Q$env{'request.course.id'}\E\.\[([^\.]+)\]\.(.+)$/); # if course wide student would be undefined if (!defined($student)) { - ($realm)=($key=~/^\Q$env{'request.course.id'}\E\.(.+)$/); + ($realm)=($key=~/^\Q$env{'request.course.id'}\E\.(.+)$/); } # strip off the .type if it's not the Question type parameter if ($realm=~/\.type$/ && !exists($listdata->{$key.'.type'})) { - $realm=~s/\.type//; + $realm=~s/\.type//; } # split into resource+part and parameter name my ($res, $parm) = ($realm=~/^(.*)\.(.*)$/); @@ -3339,6 +3842,15 @@ sub parse_listdata_key { return ($student,$res,$part,$parm); } +# Prints HTML with forms for the given parameter data in overview mode (newoverview or overview). +# +# @param {Apache2::RequestRec} $r - the Apache request +# @param {hash reference} $resourcedata - parameter data returned by readdata +# @param {hash reference} $listdata - data created in secgroup_lister, course id.[section id].part.name -> 1 or course id.[section id].part.name.type -> parameter type +# @param {string} $sortorder - realmstudent|studentrealm +# @param {string} $caller - name of the calling sub (overview|newoverview) +# @param {hash reference} $classlist - from loncoursedata::get_classlist +# @returns{integer} - number of $listdata parameters processed sub listdata { my ($r,$resourcedata,$listdata,$sortorder,$caller,$classlist)=@_; @@ -3363,180 +3875,190 @@ sub listdata { } foreach my $thiskey (sort { - my ($astudent,$ares,$apart,$aparm) = &parse_listdata_key($a,$listdata); - my ($bstudent,$bres,$bpart,$bparm) = &parse_listdata_key($b,$listdata); + my ($astudent,$ares,$apart,$aparm) = &parse_listdata_key($a,$listdata); + my ($bstudent,$bres,$bpart,$bparm) = &parse_listdata_key($b,$listdata); - # get the numerical order for the param - $aparm=$keyorder{'parameter_0_'.$aparm}; - $bparm=$keyorder{'parameter_0_'.$bparm}; + # get the numerical order for the param + $aparm=$keyorder{'parameter_0_'.$aparm}; + $bparm=$keyorder{'parameter_0_'.$bparm}; - my $result=0; + my $result=0; - if ($sortorder eq 'realmstudent') { + if ($sortorder eq 'realmstudent') { if ($ares ne $bres ) { - $result = ($ares cmp $bres); + $result = ($ares cmp $bres); } elsif ($astudent ne $bstudent) { - $result = ($astudent cmp $bstudent); - } elsif ($apart ne $bpart ) { - $result = ($apart cmp $bpart); - } - } else { - if ($astudent ne $bstudent) { - $result = ($astudent cmp $bstudent); - } elsif ($ares ne $bres ) { - $result = ($ares cmp $bres); - } elsif ($apart ne $bpart ) { - $result = ($apart cmp $bpart); + $result = ($astudent cmp $bstudent); + } elsif ($apart ne $bpart ) { + $result = ($apart cmp $bpart); + } + } else { + if ($astudent ne $bstudent) { + $result = ($astudent cmp $bstudent); + } elsif ($ares ne $bres ) { + $result = ($ares cmp $bres); + } elsif ($apart ne $bpart ) { + $result = ($apart cmp $bpart); + } } - } - if (!$result) { + if (!$result) { if (defined($aparm) && defined($bparm)) { - $result = ($aparm <=> $bparm); + $result = ($aparm <=> $bparm); } elsif (defined($aparm)) { - $result = -1; + $result = -1; } elsif (defined($bparm)) { - $result = 1; + $result = 1; + } } - } - $result; - } keys(%{$listdata})) { + $result; + + } keys(%{$listdata})) { # foreach my $thiskey - my $readonly; - if ($$listdata{$thiskey.'.type'}) { - my $thistype=$$listdata{$thiskey.'.type'}; - if ($$resourcedata{$thiskey.'.type'}) { - $thistype=$$resourcedata{$thiskey.'.type'}; - } - my ($middle,$part,$name)= - ($thiskey=~/^$env{'request.course.id'}\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); - my $section=&mt('All Students'); - if ($middle=~/^\[(.*)\]/) { - my $issection=$1; - if ($issection=~/^useropt\:($match_username)\:($match_domain)/) { - my ($stuname,$studom) = ($1,$2); - if (($env{'request.course.sec'} ne '') && ($caller eq 'overview')) { - if (ref($classlist) eq 'HASH') { - if (ref($classlist->{$stuname.':'.$studom}) eq 'ARRAY') { - next unless ($classlist->{$stuname.':'.$studom}->[$secidx] eq $env{'request.course.sec'}); + my $readonly; + if ($$listdata{$thiskey.'.type'}) { + my $thistype=$$listdata{$thiskey.'.type'}; + if ($$resourcedata{$thiskey.'.type'}) { + $thistype=$$resourcedata{$thiskey.'.type'}; + } + my ($middle,$part,$name)= + ($thiskey=~/^$env{'request.course.id'}\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); + my $section=&mt('All Students'); + if ($middle=~/^\[(.*)\]/) { + my $issection=$1; + if ($issection=~/^useropt\:($match_username)\:($match_domain)/) { + my ($stuname,$studom) = ($1,$2); + if (($env{'request.course.sec'} ne '') && ($caller eq 'overview')) { + if (ref($classlist) eq 'HASH') { + if (ref($classlist->{$stuname.':'.$studom}) eq 'ARRAY') { + next unless ($classlist->{$stuname.':'.$studom}->[$secidx] eq $env{'request.course.sec'}); + } } } - } - $section=&mt('User').": ".&Apache::loncommon::plainname($stuname,$studom); - } else { - if (($env{'request.course.sec'} ne '') && ($caller eq 'overview')) { - if (exists($grouphash{$issection})) { - $section=&mt('Group').': '.$issection; - } elsif ($issection eq $env{'request.course.sec'}) { - $section = &mt('Section').': '.$issection; + $section=&mt('User').": ".&Apache::loncommon::plainname($stuname,$studom); + } else { + if (($env{'request.course.sec'} ne '') && ($caller eq 'overview')) { + if (exists($grouphash{$issection})) { + $section=&mt('Group').': '.$issection; + } elsif ($issection eq $env{'request.course.sec'}) { + $section = &mt('Section').': '.$issection; + } else { + next; + } } else { - next; + $section=&mt('Group/Section').': '.$issection; } - } else { - $section=&mt('Group/Section').': '.$issection; + } + $middle=~s/^\[(.*)\]//; + } elsif (($env{'request.course.sec'} ne '') && ($caller eq 'overview')) { + $readonly = 1; + } + $middle=~s/\.+$//; + $middle=~s/^\.+//; + my $realm=''.&mt('All Resources').''; + if ($middle=~/^(.+)\_\_\_\((all|rec)\)$/) { + my $mapurl = $1; + my $maplevel = $2; + my $leveltitle = &mt('Folder/Map'); + if ($maplevel eq 'rec') { + $leveltitle = &mt('Recursive'); + } + $realm=''.$leveltitle.': '.&Apache::lonnet::gettitle($mapurl).'
('.$mapurl.')
'; + } elsif ($middle) { + my ($map,$id,$url)=&Apache::lonnet::decode_symb($middle); + $realm=''.&mt('Resource'). + ': '.&Apache::lonnet::gettitle($middle). + '
('.$url.' in '.$map.' id: '. + $id.')
'; + } + if ($sortorder eq 'realmstudent') { + if ($realm ne $oldrealm) { + $r->print(&tableend()."\n

$realm

"); + $oldrealm=$realm; + $oldsection=''; + } + if ($section ne $oldsection) { + $r->print(&tableend()."\n

$section

"); + $oldsection=$section; + $oldpart=''; + } + } else { + if ($section ne $oldsection) { + $r->print(&tableend()."\n

$section

"); + $oldsection=$section; + $oldrealm=''; + } + if ($realm ne $oldrealm) { + $r->print(&tableend()."\n

$realm

"); + $oldrealm=$realm; + $oldpart=''; } } - $middle=~s/^\[(.*)\]//; - } elsif (($env{'request.course.sec'} ne '') && ($caller eq 'overview')) { - $readonly = 1; - } - $middle=~s/\.+$//; - $middle=~s/^\.+//; - my $realm=''.&mt('All Resources').''; - if ($middle=~/^(.+)\_\_\_\((all|rec)\)$/) { - my $mapurl = $1; - my $maplevel = $2; - my $leveltitle = &mt('Folder/Map'); - if ($maplevel eq 'rec') { - $leveltitle = &mt('Recursive'); + if ($part ne $oldpart) { + $r->print(&tableend(). + "\n".''.&mt('Part').": $part"); + $oldpart=$part; } - $realm=''.$leveltitle.': '.&Apache::lonnet::gettitle($mapurl).'
('.$mapurl.')
'; - } elsif ($middle) { - my ($map,$id,$url)=&Apache::lonnet::decode_symb($middle); - $realm=''.&mt('Resource').': '.&Apache::lonnet::gettitle($middle).'
('.$url.' in '.$map.' id: '.$id.')
'; - } - if ($sortorder eq 'realmstudent') { - if ($realm ne $oldrealm) { - $r->print(&tableend()."\n

$realm

"); - $oldrealm=$realm; - $oldsection=''; - } - if ($section ne $oldsection) { - $r->print(&tableend()."\n

$section

"); - $oldsection=$section; - $oldpart=''; - } - } else { - if ($section ne $oldsection) { - $r->print(&tableend()."\n

$section

"); - $oldsection=$section; - $oldrealm=''; - } - if ($realm ne $oldrealm) { - $r->print(&tableend()."\n

$realm

"); - $oldrealm=$realm; - $oldpart=''; - } - } - if ($part ne $oldpart) { - $r->print(&tableend(). - "\n".''.&mt('Part').": $part"); - $oldpart=$part; - } -# -# Ready to print -# + # + # Ready to print + # my $parmitem = &standard_parameter_names($name); - $r->print(&tablestart($readonly). - &Apache::loncommon::start_data_table_row(). - ''.&mt($parmitem). - ''); - unless ($readonly) { - $r->print(''); - } - $r->print(''); - $foundkeys++; - if (&isdateparm($thistype)) { - my $jskey='key_'.$pointer; - my $state; - $pointer++; - if ($readonly) { - $state = 'disabled'; - } - $r->print( - &Apache::lonhtmlcommon::date_setter('parmform', - $jskey, - $$resourcedata{$thiskey}, - '',1,$state)); - unless ($readonly) { + $r->print(&tablestart($readonly). + &Apache::loncommon::start_data_table_row(). + ''.&mt($parmitem). + ''); + unless ($readonly) { + $r->print(''); + } + $r->print(''); + $foundkeys++; + if (&isdateparm($thistype)) { + my $jskey='key_'.$pointer; + my $state; + $pointer++; + if ($readonly) { + $state = 'disabled'; + } $r->print( -''. -(($$resourcedata{$thiskey}!=0)?''. -&mt('Shift all dates based on this date').'':''). -&date_sanity_info($$resourcedata{$thiskey}) - ); + &Apache::lonhtmlcommon::date_setter('parmform', + $jskey, + $$resourcedata{$thiskey}, + '',1,$state)); + unless ($readonly) { + $r->print( + ''. + (($$resourcedata{$thiskey}!=0)?''. + &mt('Shift all dates based on this date').'':''). + &date_sanity_info($$resourcedata{$thiskey}) + ); + } + } elsif ($thistype eq 'date_interval') { + $r->print(&date_interval_selector($thiskey,$name, + $$resourcedata{$thiskey},$readonly)); + } elsif ($thistype =~ m/^string/) { + $r->print(&string_selector($thistype,$thiskey, + $$resourcedata{$thiskey},$name,$readonly)); + } else { + $r->print(&default_selector($thiskey,$$resourcedata{$thiskey},$readonly)); } - } elsif ($thistype eq 'date_interval') { - $r->print(&date_interval_selector($thiskey,$name, - $$resourcedata{$thiskey},$readonly)); - } elsif ($thistype =~ m/^string/) { - $r->print(&string_selector($thistype,$thiskey, - $$resourcedata{$thiskey},$name,$readonly)); - } else { - $r->print(&default_selector($thiskey,$$resourcedata{$thiskey},$readonly)); - } - unless ($readonly) { - $r->print(''); + unless ($readonly) { + $r->print(''); + } + $r->print(''.&Apache::loncommon::end_data_table_row()); } - $r->print(''.&Apache::loncommon::end_data_table_row()); - } } return $foundkeys; } +# Returns a string representing the interval, directly using form data matching the given key. +# The returned string may also include information related to proctored exams. +# Format: seconds['_done'[':'done button title':']['_proctor'['_'proctor key]]] +# +# @param {string} $key - suffix for form fields related to the interval +# @returns {string} sub get_date_interval_from_form { my ($key) = @_; my $seconds = 0; @@ -3544,18 +4066,37 @@ sub get_date_interval_from_form { ['hours', 3600], ['minutes', 60], ['seconds', 1]) { - my ($name, $factor) = @{ $which }; - if (defined($env{'form.'.$name.'_'.$key})) { - $seconds += $env{'form.'.$name.'_'.$key} * $factor; - } + my ($name, $factor) = @{ $which }; + if (defined($env{'form.'.$name.'_'.$key})) { + $seconds += $env{'form.'.$name.'_'.$key} * $factor; + } } - if (($key =~ /\.interval$/) && ($env{'form.done_'.$key} eq '_done')) { - $seconds .= $env{'form.done_'.$key}; + if (($key =~ /\.interval$/) && + (($env{'form.done_'.$key} eq '_done') || ($env{'form.done_'.$key} eq '_done_proctor'))) { + if ($env{'form.done_'.$key.'_buttontext'}) { + $env{'form.done_'.$key.'_buttontext'} =~ s/\://g; + $seconds .= '_done:'.$env{'form.done_'.$key.'_buttontext'}.':'; + if ($env{'form.done_'.$key} eq '_done_proctor') { + $seconds .= '_proctor'; + } + } else { + $seconds .= $env{'form.done_'.$key}; + } + if (($env{'form.done_'.$key} eq '_done_proctor') && + ($env{'form.done_'.$key.'_proctorkey'})) { + $seconds .= '_'.$env{'form.done_'.$key.'_proctorkey'}; + } } return $seconds; } +# Returns HTML to enter a text value for a parameter. +# +# @param {string} $thiskey - parameter key +# @param {string} $showval - the current value +# @param {boolean} $readonly - true if the field should not be made editable +# @returns {string} sub default_selector { my ($thiskey, $showval, $readonly) = @_; my $disabled; @@ -3565,6 +4106,12 @@ sub default_selector { return ''; } +# Returns HTML to enter allow/deny rules related to IP addresses. +# +# @param {string} $thiskey - parameter key +# @param {string} $showval - the current value +# @param {boolean} $readonly - true if the fields should not be made editable +# @returns {string} sub string_ip_selector { my ($thiskey, $showval, $readonly) = @_; my %access = ( @@ -3625,12 +4172,14 @@ sub string_ip_selector { return $output; } -{ + +{ # block using some constants related to parameter types (overview mode) + my %strings = ( 'string_yesno' => [[ 'yes', 'Yes' ], - [ 'no', 'No' ]], + [ 'no', 'No' ]], 'string_problemstatus' => [[ 'yes', 'Yes' ], [ 'answer', 'Yes, and show correct answer if they exceed the maximum number of tries.' ], @@ -3676,6 +4225,11 @@ my %stringtypes = ( acc => 'string_ip', ); +# Returns the possible values and titles for a given string type, or undef if there are none. +# Used by courseprefs. +# +# @param {string} $string_type - a parameter type for strings +# @returns {array reference} - 2D array, containing values and English titles sub standard_string_options { my ($string_type) = @_; if (ref($strings{$string_type}) eq 'ARRAY') { @@ -3684,6 +4238,10 @@ sub standard_string_options { return; } +# Returns regular expressions to match kinds of string types, or undef if there are none. +# +# @param {string} $string_type - a parameter type for strings +# @returns {array reference} - 2D array, containing regular expression names and regular expressions sub standard_string_matches { my ($string_type) = @_; if (ref($stringmatches{$string_type}) eq 'ARRAY') { @@ -3692,6 +4250,10 @@ sub standard_string_matches { return; } +# Returns a parameter type for a given parameter with a string type, or undef if not known. +# +# @param {string} $name - parameter name +# @returns {string} sub get_stringtype { my ($name) = @_; if (exists($stringtypes{$name})) { @@ -3700,6 +4262,14 @@ sub get_stringtype { return; } +# Returns HTML to edit a string parameter. +# +# @param {string} $thistype - parameter type +# @param {string} $thiskey - parameter key +# @param {string} $showval - parameter current value +# @param {string} $name - parameter name +# @param {boolean} $readonly - true if the values should not be made editable +# @returns {string} sub string_selector { my ($thistype, $thiskey, $showval, $name, $readonly) = @_; @@ -3709,10 +4279,10 @@ sub string_selector { my %skiptype; if (($thistype eq 'string_questiontype') || - ($thistype eq 'string_lenient') || - ($thistype eq 'string_discussvote') || - ($thistype eq 'string_ip') || - ($name eq 'retrypartial')) { + ($thistype eq 'string_lenient') || + ($thistype eq 'string_discussvote') || + ($thistype eq 'string_ip') || + ($name eq 'retrypartial')) { my ($got_chostname,$chostname,$cmajor,$cminor); foreach my $possibilities (@{ $strings{$thistype} }) { next unless (ref($possibilities) eq 'ARRAY'); @@ -3735,7 +4305,7 @@ sub string_selector { ($chostname,$cmajor,$cminor)=¶meter_release_vars(); $got_chostname = 1; } - my $needsnewer=¶meter_releasecheck($name,$parmval,$parmmatch, + my $needsnewer=¶meter_releasecheck($name,$parmval,$parmmatch,undef, $needsrelease,$cmajor,$cminor); if ($needsnewer) { if ($parmmatch ne '') { @@ -3851,18 +4421,24 @@ my %intervals = ( 'date_interval' => [[ 'done', 'Yes' ], + [ 'done_proctor', 'Yes, with proctor key'], [ '', 'No' ]], ); my %intervalmatches = ( 'date_interval' - => [['done','\d+_done$'],], + => [['done','\d+_done(|\:[^\:]+\:)$'], + ['done_proctor','\d+_done(|\:[^\:]+\:)_proctor_']], ); my %intervaltypes = ( interval => 'date_interval', ); +# Returns regular expressions to match kinds of interval type, or undef if there are none. +# +# @param {string} $interval_type - a parameter type for intervals +# @returns {array reference} - 2D array, containing regular expression names and regular expressions sub standard_interval_matches { my ($interval_type) = @_; if (ref($intervalmatches{$interval_type}) eq 'ARRAY') { @@ -3871,6 +4447,10 @@ sub standard_interval_matches { return; } +# Returns a parameter type for a given parameter with an interval type, or undef if not known. +# +# @param {string} $name - parameter name +# @returns {string} sub get_intervaltype { my ($name) = @_; if (exists($intervaltypes{$name})) { @@ -3879,6 +4459,11 @@ sub get_intervaltype { return; } +# Returns the possible values and titles for a given interval type, or undef if there are none. +# Used by courseprefs. +# +# @param {string} $interval_type - a parameter type for intervals +# @returns {array reference} - 2D array, containing values and English titles sub standard_interval_options { my ($interval_type) = @_; if (ref($intervals{$interval_type}) eq 'ARRAY') { @@ -3887,6 +4472,13 @@ sub standard_interval_options { return; } +# Returns HTML to edit a date interval parameter. +# +# @param {string} $thiskey - parameter key +# @param {string} $name - parameter name +# @param {string} $showval - parameter current value +# @param {boolean} $readonly - true if the values should not be made editable +# @returns {string} sub date_interval_selector { my ($thiskey, $name, $showval, $readonly) = @_; my ($result,%skipval); @@ -3914,7 +4506,7 @@ sub date_interval_selector { ($chostname,$cmajor,$cminor)=¶meter_release_vars(); $got_chostname = 1; } - my $needsnewer=¶meter_releasecheck($name,$parmval,$parmmatch, + my $needsnewer=¶meter_releasecheck($name,$parmval,$parmmatch,undef, $needsrelease,$cmajor,$cminor); if ($needsnewer) { if ($parmmatch ne '') { @@ -3932,28 +4524,54 @@ sub date_interval_selector { ['hours', 3600, 23], ['minutes', 60, 59], ['seconds', 1, 59]) { - my ($name, $factor, $max) = @{ $which }; - my $amount = int($showval/$factor); - $showval %= $factor; - my %select = ((map {$_ => $_} (0..$max)), - 'select_form_order' => [0..$max]); - $result .= &Apache::loncommon::select_form($amount,$name.'_'.$thiskey, - \%select,'',$readonly); - $result .= ' '.&mt($name); + my ($name, $factor, $max) = @{ $which }; + my $amount = int($showval/$factor); + $showval %= $factor; + my %select = ((map {$_ => $_} (0..$max)), + 'select_form_order' => [0..$max]); + $result .= &Apache::loncommon::select_form($amount,$name.'_'.$thiskey, + \%select,'',$readonly); + $result .= ' '.&mt($name); } if ($name eq 'interval') { unless ($skipval{'done'}) { my $checkedon = ''; + my $checkedproc = ''; + my $currproctorkey = ''; + my $currprocdisplay = 'hidden'; + my $currdonetext = &mt('Done'); my $checkedoff = ' checked="checked"'; - if ($currval =~ /^(\d+)_done$/) { + if ($currval =~ /^(?:\d+)_done$/) { $checkedon = ' checked="checked"'; $checkedoff = ''; + } elsif ($currval =~ /^(?:\d+)_done\:([^\:]+)\:$/) { + $currdonetext = $1; + $checkedon = ' checked="checked"'; + $checkedoff = ''; + } elsif ($currval =~ /^(?:\d+)_done_proctor_(.+)$/) { + $currproctorkey = $1; + $checkedproc = ' checked="checked"'; + $checkedoff = ''; + $currprocdisplay = 'text'; + } elsif ($currval =~ /^(?:\d+)_done\:([^\:]+)\:_proctor_(.+)$/) { + $currdonetext = $1; + $currproctorkey = $2; + $checkedproc = ' checked="checked"'; + $checkedoff = ''; + $currprocdisplay = 'text'; } - $result .= ''.(' ' x 3).'('.&mt('Include "done" button'). - ''. - ')'; + my $onclick = ' onclick="toggleSecret(this.form,'."'done_','$thiskey'".');"'; + $result .= '
'.&mt('Include "done" button'). + ''.(' 'x2). + ''.(' 'x2). + ''. + '&').'" />
'. + ''.&mt('Button text').': '. + '&').'" />'; } } unless ($readonly) { @@ -3962,8 +4580,35 @@ sub date_interval_selector { return $result; } +# Returns HTML with a warning if a parameter requires a more recent version of LON-CAPA. +# +# @param {string} $name - parameter name +# @param {string} $namematch - parameter level name (recognized: resourcelevel|maplevel|maplevelrecurse|courselevel) +# @param {string} $value - parameter value +# @param {string} $chostname - course server name +# @param {integer} $cmajor - major version number +# @param {integer} $cminor - minor version number +# @param {string} $needsrelease - release version needed (major.minor) +# @returns {string} sub oldversion_warning { - my ($name,$value,$chostname,$cmajor,$cminor,$needsrelease) = @_; + my ($name,$namematch,$value,$chostname,$cmajor,$cminor,$needsrelease) = @_; + my $standard_name = &standard_parameter_names($name); + if ($namematch) { + my $level = &standard_parameter_levels($namematch); + my $msg = ''; + if ($level) { + $msg = &mt('[_1] was [_2]not[_3] set at the level of: [_4].', + $standard_name,'','','"'.$level.'"'); + } else { + $msg = &mt('[_1] was [_2]not[_3] set.', + $standard_name,'',''); + } + return '

'.$msg.'
'. + &mt('LON-CAPA version ([_1]) installed on home server ([_2]) does not meet version requirements ([_3] or newer).', + $cmajor.'.'.$cminor,$chostname, + $needsrelease). + '

'; + } my $desc; my $stringtype = &get_stringtype($name); if ($stringtype ne '') { @@ -4008,22 +4653,23 @@ sub oldversion_warning { } } } - my $standard_name = &standard_parameter_names($name); return '

'. - &mt('[_1] was [_2]not[_3] set to [_4].', - $standard_name,'','','"'.$desc.'"').'
'. - &mt('LON-CAPA version ([_1]) installed on home server ([_2]) does not meet version requirements ([_3] or newer).', - $cmajor.'.'.$cminor,$chostname, - $needsrelease). - '

'; + &mt('[_1] was [_2]not[_3] set to [_4].', + $standard_name,'','','"'.$desc.'"').'
'. + &mt('LON-CAPA version ([_1]) installed on home server ([_2]) does not meet version requirements ([_3] or newer).', + $cmajor.'.'.$cminor,$chostname, + $needsrelease). + '

'; } -} +} # end of block using some constants related to parameter types + -# -# Shift all start and end dates by $shift -# +# Shifts all start and end dates in the current course by $shift. +# +# @param {integer} $shift - time to shift, in seconds +# @returns {string} - error name or 'ok' sub dateshift { my ($shift)=@_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; @@ -4055,6 +4701,9 @@ sub dateshift { return $reply; } +# Overview mode UI to edit course parameters. +# +# @param {Apache2::RequestRec} $r - the Apache request sub newoverview { my ($r) = @_; @@ -4076,6 +4725,7 @@ sub newoverview { &toggleparmtextbox_js()."\n". &validateparms_js()."\n". &ipacc_boxes_js()."\n". + &done_proctor_js()."\n". '// ]]> '; @@ -4162,7 +4812,7 @@ ENDOVER $r->print('
'); $r->print('
'); - &displaymenu($r,\%allparms,\@pscat,\%keyorder); + &displaymenu($r,\%allparms,\@pscat,\%keyorder); # FIXME: wrong parameters, could make keysindisplayorderCategory crash because $keyorder is undefined $r->print(&Apache::lonhtmlcommon::start_pick_box()); $r->print(&Apache::lonhtmlcommon::row_title(&mt('Select Parts to View'))); my $sectionselector = §ionmenu(\@selected_sections); @@ -4227,6 +4877,20 @@ ENDOVER $r->print(&Apache::loncommon::end_page()); } +# Fills $listdata with parameter information. +# Keys use the format course id.[section id].part.name and course id.[section id].part.name.type. +# The non-type value is always 1. +# +# @param {string} $cat - parameter name +# @param {string} $pschp - selected map pc, or 'all' +# @param {string} $parmlev - selected level value (full|map|general), or '' +# @param {hash reference} $listdata - the parameter data that will be modified +# @param {array reference} $psprt - selected parts +# @param {array reference} $selections - selected sections +# @param {hash reference} $defkeytype - hash parameter name -> parameter type +# @param {hash reference} $allmaps - hash map pc -> map src +# @param {array reference} $ids - resource and map ids +# @param {hash reference} $symbp - hash map pc or resource/map id -> map src.'___(all)' or resource symb sub secgroup_lister { my ($cat,$pschp,$parmlev,$listdata,$psprt,$selections,$defkeytype,$allmaps,$ids,$symbp) = @_; foreach my $item (@{$selections}) { @@ -4265,6 +4929,10 @@ sub secgroup_lister { } } +# UI to edit parameter settings starting with a list of all existing parameters. +# (called by setoverview action) +# +# @param {Apache2::RequestRec} $r - the Apache request sub overview { my ($r) = @_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; @@ -4275,6 +4943,7 @@ sub overview { &toggleparmtextbox_js()."\n". &validateparms_js()."\n". &ipacc_boxes_js()."\n". + &done_proctor_js()."\n". '// ]]>'."\n". ''."\n"; &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=setoverview', @@ -4310,6 +4979,9 @@ sub overview { &Apache::loncommon::end_page()); } +# Unused sub. +# +# @param {Apache2::RequestRec} $r - the Apache request sub clean_parameters { my ($r) = @_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; @@ -4345,51 +5017,51 @@ ENDOVER ''.&mt('Parameter').''. ''); foreach my $thiskey (sort(keys(%{$resourcedata}))) { - next if (!exists($resourcedata->{$thiskey.'.type'}) - && $thiskey=~/\.type$/); - my %data = &parse_key($thiskey); - if (1) { #exists($data{'realm_exists'}) - #&& !$data{'realm_exists'}) { - $r->print(&Apache::loncommon::start_data_table_row(). - ''. - '' ); - - $r->print(''); - my $display_value = $resourcedata->{$thiskey}; - if (&isdateparm($resourcedata->{$thiskey.'.type'})) { - $display_value = - &Apache::lonlocal::locallocaltime($display_value); - } + next if (!exists($resourcedata->{$thiskey.'.type'}) + && $thiskey=~/\.type$/); + my %data = &parse_key($thiskey); + if (1) { #exists($data{'realm_exists'}) + #&& !$data{'realm_exists'}) { + $r->print(&Apache::loncommon::start_data_table_row(). + ''. + '' ); + + $r->print(''); + my $display_value = $resourcedata->{$thiskey}; + if (&isdateparm($resourcedata->{$thiskey.'.type'})) { + $display_value = + &Apache::lonlocal::locallocaltime($display_value); + } my $parmitem = &standard_parameter_names($data{'parameter_name'}); $parmitem = &mt($parmitem); - $r->print(&mt('Parameter: "[_1]" with value: "[_2]"', - $parmitem,$resourcedata->{$thiskey})); - $r->print('
'); - if ($data{'scope_type'} eq 'all') { - $r->print(&mt('All users')); - } elsif ($data{'scope_type'} eq 'user') { - $r->print(&mt('User: [_1]',join(':',@{$data{'scope'}}))); - } elsif ($data{'scope_type'} eq 'section') { - $r->print(&mt('Section: [_1]',$data{'scope'})); - } elsif ($data{'scope_type'} eq 'group') { - $r->print(&mt('Group: [_1]',$data{'scope'})); - } - $r->print('
'); - if ($data{'realm_type'} eq 'all') { - $r->print(&mt('All Resources')); - } elsif ($data{'realm_type'} eq 'folder') { - $r->print(&mt('Folder: [_1]'),$data{'realm'}); - } elsif ($data{'realm_type'} eq 'symb') { - my ($map,$resid,$url) = - &Apache::lonnet::decode_symb($data{'realm'}); - $r->print(&mt('Resource: [_1]with ID: [_2]in folder [_3]', - $url.'
   ', - $resid.'
   ',$map)); - } - $r->print('
   '.&mt('Part: [_1]',$data{'parameter_part'})); - $r->print(''); + $r->print(&mt('Parameter: "[_1]" with value: "[_2]"', + $parmitem,$resourcedata->{$thiskey})); + $r->print('
'); + if ($data{'scope_type'} eq 'all') { + $r->print(&mt('All users')); + } elsif ($data{'scope_type'} eq 'user') { + $r->print(&mt('User: [_1]',join(':',@{$data{'scope'}}))); + } elsif ($data{'scope_type'} eq 'section') { + $r->print(&mt('Section: [_1]',$data{'scope'})); + } elsif ($data{'scope_type'} eq 'group') { + $r->print(&mt('Group: [_1]',$data{'scope'})); + } + $r->print('
'); + if ($data{'realm_type'} eq 'all') { + $r->print(&mt('All Resources')); + } elsif ($data{'realm_type'} eq 'folder') { + $r->print(&mt('Folder: [_1]'),$data{'realm'}); + } elsif ($data{'realm_type'} eq 'symb') { + my ($map,$resid,$url) = + &Apache::lonnet::decode_symb($data{'realm'}); + $r->print(&mt('Resource: [_1]with ID: [_2]in folder [_3]', + $url.'
   ', + $resid.'
   ',$map)); + } + $r->print('
   '.&mt('Part: [_1]',$data{'parameter_part'})); + $r->print(''); - } + } } $r->print(&Apache::loncommon::end_data_table().'

'. ''. @@ -4398,6 +5070,10 @@ ENDOVER $r->print(&Apache::loncommon::end_page()); } +# UI to shift all dates (called by dateshift1 action). +# Used by overview mode. +# +# @param {Apache2::RequestRec} $r - the Apache request sub date_shift_one { my ($r) = @_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; @@ -4426,6 +5102,9 @@ sub date_shift_one { $r->print(&Apache::loncommon::end_page()); } +# UI to shift all dates (second form). +# +# @param {Apache2::RequestRec} $r - the Apache request sub date_shift_two { my ($r) = @_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; @@ -4453,6 +5132,13 @@ sub date_shift_two { $r->print(&Apache::loncommon::end_page()); } +# Returns the different components of a resourcedata key. +# Keys: scope_type, scope, realm_type, realm, realm_title, +# realm_exists, parameter_part, parameter_name. +# Was used by clean_parameters (which is unused). +# +# @param {string} $key - the parameter key +# @returns {hash} sub parse_key { my ($key) = @_; my %data; @@ -4460,30 +5146,30 @@ sub parse_key { ($key=~/^$env{'request.course.id'}\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); $data{'scope_type'} = 'all'; if ($middle=~/^\[(.*)\]/) { - $data{'scope'} = $1; - if ($data{'scope'}=~/^useropt\:($match_username)\:($match_domain)/) { - $data{'scope_type'} = 'user'; - $data{'scope'} = [$1,$2]; - } else { - #FIXME check for group scope - $data{'scope_type'} = 'section'; - } - $middle=~s/^\[(.*)\]//; + $data{'scope'} = $1; + if ($data{'scope'}=~/^useropt\:($match_username)\:($match_domain)/) { + $data{'scope_type'} = 'user'; + $data{'scope'} = [$1,$2]; + } else { + #FIXME check for group scope + $data{'scope_type'} = 'section'; + } + $middle=~s/^\[(.*)\]//; } $middle=~s/\.+$//; $middle=~s/^\.+//; $data{'realm_type'}='all'; if ($middle=~/^(.+)\_\_\_\(all\)$/) { - $data{'realm'} = $1; - $data{'realm_type'} = 'folder'; - $data{'realm_title'} = &Apache::lonnet::gettitle($data{'realm'}); - ($data{'realm_exists'}) = &Apache::lonnet::is_on_map($data{'realm'}); + $data{'realm'} = $1; + $data{'realm_type'} = 'folder'; + $data{'realm_title'} = &Apache::lonnet::gettitle($data{'realm'}); + ($data{'realm_exists'}) = &Apache::lonnet::is_on_map($data{'realm'}); } elsif ($middle) { - $data{'realm'} = $middle; - $data{'realm_type'} = 'symb'; - $data{'realm_title'} = &Apache::lonnet::gettitle($data{'realm'}); - my ($map,$resid,$url) = &Apache::lonnet::decode_symb($data{'realm'}); - $data{'realm_exists'} = &Apache::lonnet::symbverify($data{'realm'},$url); + $data{'realm'} = $middle; + $data{'realm_type'} = 'symb'; + $data{'realm_title'} = &Apache::lonnet::gettitle($data{'realm'}); + my ($map,$resid,$url) = &Apache::lonnet::decode_symb($data{'realm'}); + $data{'realm_exists'} = &Apache::lonnet::symbverify($data{'realm'},$url); } $data{'parameter_part'} = $part; @@ -4493,12 +5179,21 @@ sub parse_key { } +# Calls loncommon::start_page with the "Settings" title. sub header { return &Apache::loncommon::start_page('Settings'); } +################################################## +# MAIN MENU +################################################## + +# Content and problem settings main menu. +# +# @param {Apache2::RequestRec} $r - the Apache request +# @param {boolean} $parm_permission - true if the user has permission to edit the current course or section sub print_main_menu { my ($r,$parm_permission)=@_; # @@ -4598,6 +5293,17 @@ ENDMAINFORMHEAD +################################################## +# PORTFOLIO METADATA +################################################## + +# Prints HTML to edit an item of portfolio metadata. The HTML contains several td elements (no tr). +# It looks like field titles are not localized. +# +# @param {Apache2::RequestRec} $r - the Apache request +# @param {string} $field_name - metadata field name +# @param {string} $field_text - metadata field title, in English unless manually added +# @param {boolean} $added_flag - true if the field was manually added sub output_row { my ($r, $field_name, $field_text, $added_flag) = @_; my $output; @@ -4619,14 +5325,14 @@ sub output_row { $output .= ''.$field_text.':'; $output .= &Apache::loncommon::end_data_table_row(); foreach my $opt (@options) { - my $checked = ($options =~ m/$opt->[0]/) ? ' checked="checked" ' : '' ; - $output .= &Apache::loncommon::continue_data_table_row(); - $output .= ''.(' ' x 5).''; - $output .= &Apache::loncommon::end_data_table_row(); - } + my $checked = ($options =~ m/$opt->[0]/) ? ' checked="checked" ' : '' ; + $output .= &Apache::loncommon::continue_data_table_row(); + $output .= ''.(' ' x 5).''; + $output .= &Apache::loncommon::end_data_table_row(); + } $output .= &Apache::loncommon::continue_data_table_row(); $output .= ''.(' ' x 10).''; $output .= &Apache::loncommon::end_data_table_row(); @@ -4639,22 +5345,25 @@ sub output_row { $multiple_checked = ' checked="checked"'; $single_checked = ''; } - $output .= &Apache::loncommon::continue_data_table_row(); - $output .= ''.(' ' x 10).' - - '.&mt('Student may select multiple choices from list').''; - $output .= &Apache::loncommon::end_data_table_row(); - $output .= &Apache::loncommon::continue_data_table_row(); - $output .= ''.(' ' x 10).' - - '.&mt('Student may select only one choice from list').''; - $output .= &Apache::loncommon::end_data_table_row(); + $output .= &Apache::loncommon::continue_data_table_row(); + $output .= ''.(' ' x 10).' + + '.&mt('Student may select multiple choices from list').''; + $output .= &Apache::loncommon::end_data_table_row(); + $output .= &Apache::loncommon::continue_data_table_row(); + $output .= ''.(' ' x 10).' + + '.&mt('Student may select only one choice from list').''; + $output .= &Apache::loncommon::end_data_table_row(); } return ($output); } - +# UI to order portfolio metadata fields. +# Currently useless because addmetafield does not work. +# +# @param {Apache2::RequestRec} $r - the Apache request sub order_meta_fields { my ($r)=@_; my $idx = 1; @@ -4662,12 +5371,13 @@ sub order_meta_fields { my $crs = $env{'course.'.$env{'request.course.id'}.'.num'}; my $crstype = $env{'course.'.$env{'request.course.id'}.'.type'};; $r->print(&Apache::loncommon::start_page('Order Metadata Fields')); - &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=addmetadata', + &Apache::lonhtmlcommon::add_breadcrumb( + {href=>'/adm/parmset?action=addmetadata', text=>"Add Metadata Field"}); - &Apache::lonhtmlcommon::add_breadcrumb - ({href=>"/adm/parmset?action=setrestrictmeta", - text=>"Restrict Metadata"}, - {text=>"Order Metadata"}); + &Apache::lonhtmlcommon::add_breadcrumb( + {href=>"/adm/parmset?action=setrestrictmeta", + text=>"Restrict Metadata"}, + {text=>"Order Metadata"}); $r->print(&Apache::lonhtmlcommon::breadcrumbs('Order Metadata')); &startSettingsScreen($r,'parmset',$crstype); if ($env{'form.storeorder'}) { @@ -4679,14 +5389,14 @@ sub order_meta_fields { if ($newpos > $currentpos) { # moving stuff up for ($i=0;$i<$currentpos;$i++) { - $neworder[$i]=$oldorder[$i]; + $neworder[$i]=$oldorder[$i]; } for ($i=$currentpos;$i<$newpos;$i++) { - $neworder[$i]=$oldorder[$i+1]; + $neworder[$i]=$oldorder[$i+1]; } $neworder[$newpos]=$oldorder[$currentpos]; for ($i=$newpos+1;$i<=$#oldorder;$i++) { - $neworder[$i]=$oldorder[$i]; + $neworder[$i]=$oldorder[$i]; } } else { # moving stuff down @@ -4701,10 +5411,10 @@ sub order_meta_fields { $neworder[$i]=$oldorder[$i]; } } - my $ordered_fields = join ",", @neworder; + my $ordered_fields = join ",", @neworder; my $put_result = &Apache::lonnet::put('environment', - {'metadata.addedorder'=>$ordered_fields},$dom,$crs); - &Apache::lonnet::appenv({'course.'.$env{'request.course.id'}.'.metadata.addedorder' => $ordered_fields}); + {'metadata.addedorder'=>$ordered_fields},$dom,$crs); + &Apache::lonnet::appenv({'course.'.$env{'request.course.id'}.'.metadata.addedorder' => $ordered_fields}); } my $fields = &get_added_meta_fieldnames($env{'request.course.id'}); my $ordered_fields; @@ -4744,6 +5454,8 @@ sub order_meta_fields { } +# Returns HTML with a Continue button redirecting to the initial portfolio metadata screen. +# @returns {string} sub continue { my $output; $output .= '

'; @@ -4753,6 +5465,10 @@ sub continue { } +# UI to add a metadata field. +# Currenly does not work because of an HTML error (the field is not visible). +# +# @param {Apache2::RequestRec} $r - the Apache request sub addmetafield { my ($r)=@_; &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=addmetadata', @@ -4797,7 +5513,7 @@ sub addmetafield { $r->print(''); $r->print('
'); } - $r->print('
Or you may enter a new metadata field name.
print('
Or you may enter a new metadata field name.print('
'); $r->print(''); } @@ -4807,6 +5523,9 @@ sub addmetafield { +# Display or save portfolio metadata. +# +# @param {Apache2::RequestRec} $r - the Apache request sub setrestrictmeta { my ($r)=@_; my $next_meta; @@ -4847,10 +5566,10 @@ sub setrestrictmeta { $options.='deleted,'; } my $name = $save_field; - $put_result = &Apache::lonnet::put('environment', - {'metadata.'.$meta_field.'.options'=>$options, - 'metadata.'.$meta_field.'.values'=>$env{'form.'.$meta_field.'_values'}, - },$dom,$crs); + $put_result = &Apache::lonnet::put('environment', + {'metadata.'.$meta_field.'.options'=>$options, + 'metadata.'.$meta_field.'.values'=>$env{'form.'.$meta_field.'_values'}, + },$dom,$crs); } } } @@ -4866,8 +5585,8 @@ sub setrestrictmeta { foreach my $field (sort(keys(%metadata_fields))) { if ($field ne 'courserestricted') { $row_alt = $row_alt ? 0 : 1; - $output.= &output_row($r, $field, $metadata_fields{$field}); - } + $output.= &output_row($r, $field, $metadata_fields{$field}); + } } my $buttons = (< @@ -4882,7 +5601,7 @@ ENDButtons my $added_flag = 1; foreach my $field (sort(keys(%$added_metadata_fields))) { $row_alt = $row_alt ? 0 : 1; - $output.= &output_row($r, $field, $$added_metadata_fields{$field},$added_flag, $row_alt); + $output.= &output_row($r, $field, $$added_metadata_fields{$field},$added_flag, $row_alt); # FIXME: wrong parameters } $output .= &Apache::loncommon::end_data_table(); $r->print(< field title (not localized) sub get_added_meta_fieldnames { my ($cid) = @_; my %fields; @@ -4912,7 +5634,10 @@ sub get_added_meta_fieldnames { } - +# Returns metadata fields that have been manually added and deleted. +# +# @param {string} $cid - course id +# @returns {hash reference} - hash field name -> field title (not localized) sub get_deleted_meta_fieldnames { my ($cid) = @_; my %fields; @@ -4927,6 +5652,15 @@ sub get_deleted_meta_fieldnames { } return \%fields; } + + +################################################## +# PARAMETER SETTINGS DEFAULT ACTIONS +################################################## + +# UI to change parameter setting default actions +# +# @param {Apache2::RequestRec} $r - the Apache request sub defaultsetter { my ($r) = @_; @@ -4959,45 +5693,45 @@ sub defaultsetter { \%mapp, \%symbp,\%maptitles,\%uris, \%keyorder,\%defkeytype); if ($env{'form.storerules'}) { - my %newrules=(); - my @delrules=(); - my %triggers=(); - foreach my $key (keys(%env)) { + my %newrules=(); + my @delrules=(); + my %triggers=(); + foreach my $key (keys(%env)) { if ($key=~/^form\.(\w+)\_action$/) { - my $tempkey=$1; - my $action=$env{$key}; + my $tempkey=$1; + my $action=$env{$key}; if ($action) { - $newrules{$tempkey.'_action'}=$action; - if ($action ne 'default') { - my ($whichaction,$whichparm)=($action=~/^(.*\_)([^\_]+)$/); - $triggers{$whichparm}.=$tempkey.':'; - } - $newrules{$tempkey.'_type'}=$defkeytype{$tempkey}; - if (&isdateparm($defkeytype{$tempkey})) { - $newrules{$tempkey.'_days'}=$env{'form.'.$tempkey.'_days'}; - $newrules{$tempkey.'_hours'}=$env{'form.'.$tempkey.'_hours'}; - $newrules{$tempkey.'_min'}=$env{'form.'.$tempkey.'_min'}; - $newrules{$tempkey.'_sec'}=$env{'form.'.$tempkey.'_sec'}; - } else { - $newrules{$tempkey.'_value'}=$env{'form.'.$tempkey.'_value'}; - $newrules{$tempkey.'_triggervalue'}=$env{'form.'.$tempkey.'_triggervalue'}; + $newrules{$tempkey.'_action'}=$action; + if ($action ne 'default') { + my ($whichaction,$whichparm)=($action=~/^(.*\_)([^\_]+)$/); + $triggers{$whichparm}.=$tempkey.':'; + } + $newrules{$tempkey.'_type'}=$defkeytype{$tempkey}; + if (&isdateparm($defkeytype{$tempkey})) { + $newrules{$tempkey.'_days'}=$env{'form.'.$tempkey.'_days'}; + $newrules{$tempkey.'_hours'}=$env{'form.'.$tempkey.'_hours'}; + $newrules{$tempkey.'_min'}=$env{'form.'.$tempkey.'_min'}; + $newrules{$tempkey.'_sec'}=$env{'form.'.$tempkey.'_sec'}; + } else { + $newrules{$tempkey.'_value'}=$env{'form.'.$tempkey.'_value'}; + $newrules{$tempkey.'_triggervalue'}=$env{'form.'.$tempkey.'_triggervalue'}; + } + } else { + push(@delrules,$tempkey.'_action'); + push(@delrules,$tempkey.'_type'); + push(@delrules,$tempkey.'_hours'); + push(@delrules,$tempkey.'_min'); + push(@delrules,$tempkey.'_sec'); + push(@delrules,$tempkey.'_value'); + } } - } else { - push(@delrules,$tempkey.'_action'); - push(@delrules,$tempkey.'_type'); - push(@delrules,$tempkey.'_hours'); - push(@delrules,$tempkey.'_min'); - push(@delrules,$tempkey.'_sec'); - push(@delrules,$tempkey.'_value'); } + foreach my $key (keys(%allparms)) { + $newrules{$key.'_triggers'}=$triggers{$key}; } - } - foreach my $key (keys(%allparms)) { - $newrules{$key.'_triggers'}=$triggers{$key}; - } - &Apache::lonnet::put('parmdefactions',\%newrules,$cdom,$cnum); - &Apache::lonnet::del('parmdefactions',\@delrules,$cdom,$cnum); - &resetrulescache(); + &Apache::lonnet::put('parmdefactions',\%newrules,$cdom,$cnum); + &Apache::lonnet::del('parmdefactions',\@delrules,$cdom,$cnum); + &resetrulescache(); } my %lt=&Apache::lonlocal::texthash('days' => 'Days', 'hours' => 'Hours', @@ -5010,75 +5744,75 @@ sub defaultsetter { my @dateoptions=('','default'); my @datedisplay=('',&mt('Default value when manually setting')); foreach my $tempkey (&keysindisplayorder(\%allparms,\%keyorder)) { - unless ($tempkey) { next; } - push @standardoptions,'when_setting_'.$tempkey; - push @standarddisplay,&mt('Automatically set when setting ').$tempkey; - if (&isdateparm($defkeytype{$tempkey})) { - push @dateoptions,'later_than_'.$tempkey; - push @datedisplay,&mt('Automatically set later than ').$tempkey; - push @dateoptions,'earlier_than_'.$tempkey; - push @datedisplay,&mt('Automatically set earlier than ').$tempkey; - } + unless ($tempkey) { next; } + push @standardoptions,'when_setting_'.$tempkey; + push @standarddisplay,&mt('Automatically set when setting ').$tempkey; + if (&isdateparm($defkeytype{$tempkey})) { + push @dateoptions,'later_than_'.$tempkey; + push @datedisplay,&mt('Automatically set later than ').$tempkey; + push @dateoptions,'earlier_than_'.$tempkey; + push @datedisplay,&mt('Automatically set earlier than ').$tempkey; + } } -$r->print(&mt('Manual setting rules apply to all interfaces.').'
'. - &mt('Automatic setting rules apply to table mode interfaces only.')); + $r->print(&mt('Manual setting rules apply to all interfaces.').'
'. + &mt('Automatic setting rules apply to table mode interfaces only.')); $r->print("\n".&Apache::loncommon::start_data_table(). &Apache::loncommon::start_data_table_header_row(). "".&mt('Rule for parameter').''. &mt('Action').''.&mt('Value').''. &Apache::loncommon::end_data_table_header_row()); foreach my $tempkey (&keysindisplayorder(\%allparms,\%keyorder)) { - unless ($tempkey) { next; } - $r->print("\n".&Apache::loncommon::start_data_table_row(). - "".$allparms{$tempkey}."\n
(".$tempkey.')'); - my $action=&rulescache($tempkey.'_action'); - $r->print(''); + if (&isdateparm($defkeytype{$tempkey})) { + for (my $i=0;$i<=$#dateoptions;$i++) { + if ($dateoptions[$i]=~/\_$tempkey$/) { next; } + $r->print("\n"); + } + } else { + for (my $i=0;$i<=$#standardoptions;$i++) { + if ($standardoptions[$i]=~/\_$tempkey$/) { next; } + $r->print("\n"); + } } - } else { - for (my $i=0;$i<=$#standardoptions;$i++) { - if ($standardoptions[$i]=~/\_$tempkey$/) { next; } - $r->print("\n"); + $r->print(''); + unless (&isdateparm($defkeytype{$tempkey})) { + $r->print("\n
".&mt('Triggering value(s) of other parameter (optional, comma-separated):'). + ''); } - } - $r->print(''); - unless (&isdateparm($defkeytype{$tempkey})) { - $r->print("\n
".&mt('Triggering value(s) of other parameter (optional, comma-separated):'). - ''); - } - $r->print("\n\n"); + $r->print("\n\n"); if (&isdateparm($defkeytype{$tempkey})) { - my $days=&rulescache($tempkey.'_days'); - my $hours=&rulescache($tempkey.'_hours'); - my $min=&rulescache($tempkey.'_min'); - my $sec=&rulescache($tempkey.'_sec'); - $r->print(<$lt{'days'}
-$lt{'hours'}
-$lt{'min'}
-$lt{'sec'} + my $days=&rulescache($tempkey.'_days'); + my $hours=&rulescache($tempkey.'_hours'); + my $min=&rulescache($tempkey.'_min'); + my $sec=&rulescache($tempkey.'_sec'); + $r->print(<$lt{'days'}
+ $lt{'hours'}
+ $lt{'min'}
+ $lt{'sec'} ENDINPUTDATE - } elsif ($defkeytype{$tempkey} eq 'string_yesno') { - my $yeschecked=''; - my $nochecked=''; - if (&rulescache($tempkey.'_value') eq 'yes') { $yeschecked=' checked="checked"'; } - if (&rulescache($tempkey.'_value') eq 'no') { $nochecked=' checked="checked"'; } - - $r->print(< $lt{'yes'}
- + } elsif ($defkeytype{$tempkey} eq 'string_yesno') { + my $yeschecked=''; + my $nochecked=''; + if (&rulescache($tempkey.'_value') eq 'yes') { $yeschecked=' checked="checked"'; } + if (&rulescache($tempkey.'_value') eq 'no') { $nochecked=' checked="checked"'; } + + $r->print(< $lt{'yes'}
+ ENDYESNO } else { - $r->print(''); - } + $r->print(''); + } $r->print(''.&Apache::loncommon::end_data_table_row()); } $r->print(&Apache::loncommon::end_data_table(). @@ -5089,28 +5823,54 @@ ENDYESNO return; } +################################################## +# PARAMETER CHANGES LOG +################################################## + +# Returns some info for a parameter log entry. +# Returned entries: +# $realm - HTML title for the parameter level and resource +# $section - parameter section +# $name - parameter name +# $part - parameter part +# $what - $part.'.'.$name +# $middle - resource symb ? +# $uname - user name (same as given) +# $udom - user domain (same as given) +# $issection - section or group name +# $realmdescription - title for the parameter level and resource (without using HTML) +# +# FIXME: remove unused fields. +# +# @param {string} $key - parameter log key +# @param {string} $uname - user name +# @param {string} $udom - user domain +# @param {string} $exeuser - unused +# @param {string} $exedomain - unused +# @param {boolean} $typeflag - .type log entry +# @returns {Array} sub components { my ($key,$uname,$udom,$exeuser,$exedomain,$typeflag)=@_; if ($typeflag) { - $key=~s/\.type$//; + $key=~s/\.type$//; } my ($middle,$part,$name)= - ($key=~/^$env{'request.course.id'}\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); + ($key=~/^$env{'request.course.id'}\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); my $issection; my $section=&mt('All Students'); if ($middle=~/^\[(.*)\]/) { - $issection=$1; - $section=&mt('Group/Section').': '.$issection; - $middle=~s/^\[(.*)\]//; + $issection=$1; + $section=&mt('Group/Section').': '.$issection; + $middle=~s/^\[(.*)\]//; } $middle=~s/\.+$//; $middle=~s/^\.+//; if ($uname) { - $section=&mt('User').": ".&Apache::loncommon::plainname($uname,$udom); - $issection=''; + $section=&mt('User').": ".&Apache::loncommon::plainname($uname,$udom); + $issection=''; } my $realm=''.&mt('All Resources').''; my $realmdescription=&mt('all resources'); @@ -5121,32 +5881,37 @@ sub components { if ($maplevel eq 'rec') { $leveltitle = &mt('Recursive'); } - $realm=''.$leveltitle.': '.&Apache::lonnet::gettitle($mapurl).'
('.$mapurl.')
'; - $realmdescription=&mt('folder').' '.&Apache::lonnet::gettitle($mapurl); - } elsif ($middle) { - my ($map,$id,$url)=&Apache::lonnet::decode_symb($middle); - $realm=''.&mt('Resource').': '.&Apache::lonnet::gettitle($middle).'
('.$url.' in '.$map.' id: '.$id.')
'; - $realmdescription=&mt('resource').' '.&Apache::lonnet::gettitle($middle); + $realm=''.$leveltitle. + ': '.&Apache::lonnet::gettitle($mapurl).'
('. + $mapurl.')
'; + $realmdescription=&mt('folder').' '.&Apache::lonnet::gettitle($mapurl); + } elsif ($middle) { + my ($map,$id,$url)=&Apache::lonnet::decode_symb($middle); + $realm=''.&mt('Resource'). + ': '.&Apache::lonnet::gettitle($middle).'
('.$url. + ' in '.$map.' id: '.$id.')
'; + $realmdescription=&mt('resource').' '.&Apache::lonnet::gettitle($middle); } my $what=$part.'.'.$name; return ($realm,$section,$name,$part, $what,$middle,$uname,$udom,$issection,$realmdescription); } -my %standard_parms; -my %standard_parms_types; +my %standard_parms; # hash parameter name -> parameter title (not localized) +my %standard_parms_types; # hash parameter name -> parameter type +# Reads parameter info from packages.tab into %standard_parms. sub load_parameter_names { open(my $config,"<$Apache::lonnet::perlvar{'lonTabDir'}/packages.tab"); while (my $configline=<$config>) { - if ($configline !~ /\S/ || $configline=~/^\#/) { next; } - chomp($configline); - my ($short,$plain)=split(/:/,$configline); - my (undef,$name,$type)=split(/\&/,$short,3); - if ($type eq 'display') { - $standard_parms{$name} = $plain; + if ($configline !~ /\S/ || $configline=~/^\#/) { next; } + chomp($configline); + my ($short,$plain)=split(/:/,$configline); + my (undef,$name,$type)=split(/\&/,$short,3); + if ($type eq 'display') { + $standard_parms{$name} = $plain; } elsif ($type eq 'type') { - $standard_parms_types{$name} = $plain; + $standard_parms_types{$name} = $plain; } } close($config); @@ -5154,18 +5919,26 @@ sub load_parameter_names { $standard_parms{'int_zero_pos'} = 'Positive Integer or Zero'; } +# Returns a parameter title for standard parameters, the name for others. +# +# @param {string} $name - parameter name +# @returns {string} sub standard_parameter_names { my ($name)=@_; if (!%standard_parms) { - &load_parameter_names(); + &load_parameter_names(); } if ($standard_parms{$name}) { - return $standard_parms{$name}; + return $standard_parms{$name}; } else { - return $name; + return $name; } } +# Returns a parameter type for standard parameters, undef for others. +# +# @param {string} $name - parameter name +# @returns {string} sub standard_parameter_types { my ($name)=@_; if (!%standard_parms_types) { @@ -5177,6 +5950,27 @@ sub standard_parameter_types { return; } +# Returns a parameter level title (not localized) from the parameter level name. +# +# @param {string} $name - parameter level name (recognized: resourcelevel|maplevel|maplevelrecurse|courselevel) +# @returns {string} +sub standard_parameter_levels { + my ($name)=@_; + my %levels = ( + 'resourcelevel' => 'a single resource', + 'maplevel' => 'the enclosing map/folder', + 'maplevelrecurse' => 'the enclosing map/folder (recursive into sub-folders)', + 'courselevel' => 'the general (course) level', + ); + if ($levels{$name}) { + return $levels{$name}; + } + return; +} + +# Display log for parameter changes, blog postings, user notification changes. +# +# @param {Apache2::RequestRec} $r - the Apache request sub parm_change_log { my ($r)=@_; my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; @@ -5218,89 +6012,89 @@ sub parm_change_log { my $shown=0; my $folder=''; if ($env{'form.displayfilter'} eq 'currentfolder') { - my $last=''; - if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', - &GDBM_READER(),0640)) { - $last=$hash{'last_known'}; - untie(%hash); - } - if ($last) { ($folder) = &Apache::lonnet::decode_symb($last); } - } - foreach my $id (sort - { - if ($parmlog{$b}{'exe_time'} ne $parmlog{$a}{'exe_time'}) { - return $parmlog{$b}{'exe_time'} <=>$parmlog{$a}{'exe_time'} - } - my $aid = (split('00000',$a))[-1]; - my $bid = (split('00000',$b))[-1]; - return $bid<=>$aid; + my $last=''; + if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', + &GDBM_READER(),0640)) { + $last=$hash{'last_known'}; + untie(%hash); + } + if ($last) { ($folder) = &Apache::lonnet::decode_symb($last); } + } + foreach my $id (sort { + if ($parmlog{$b}{'exe_time'} ne $parmlog{$a}{'exe_time'}) { + return $parmlog{$b}{'exe_time'} <=>$parmlog{$a}{'exe_time'} + } + my $aid = (split('00000',$a))[-1]; + my $bid = (split('00000',$b))[-1]; + return $bid<=>$aid; } (keys(%parmlog))) { my @changes=keys(%{$parmlog{$id}{'logentry'}}); - my $count = 0; - my $time = - &Apache::lonlocal::locallocaltime($parmlog{$id}{'exe_time'}); - my $plainname = - &Apache::loncommon::plainname($parmlog{$id}{'exe_uname'}, - $parmlog{$id}{'exe_udom'}); - my $about_me_link = - &Apache::loncommon::aboutmewrapper($plainname, - $parmlog{$id}{'exe_uname'}, - $parmlog{$id}{'exe_udom'}); - my $send_msg_link=''; - if ((($parmlog{$id}{'exe_uname'} ne $env{'user.name'}) - || ($parmlog{$id}{'exe_udom'} ne $env{'user.domain'}))) { - $send_msg_link ='
'. - &Apache::loncommon::messagewrapper(&mt('Send message'), - $parmlog{$id}{'exe_uname'}, - $parmlog{$id}{'exe_udom'}); - } - my $row_start=&Apache::loncommon::start_data_table_row(); - my $makenewrow=0; - my %istype=(); - my $output; - foreach my $changed (reverse(sort(@changes))) { - my $value=$parmlog{$id}{'logentry'}{$changed}; - my $typeflag = ($changed =~/\.type$/ && - !exists($parmlog{$id}{'logentry'}{$changed.'.type'})); + my $count = 0; + my $time = + &Apache::lonlocal::locallocaltime($parmlog{$id}{'exe_time'}); + my $plainname = + &Apache::loncommon::plainname($parmlog{$id}{'exe_uname'}, + $parmlog{$id}{'exe_udom'}); + my $about_me_link = + &Apache::loncommon::aboutmewrapper($plainname, + $parmlog{$id}{'exe_uname'}, + $parmlog{$id}{'exe_udom'}); + my $send_msg_link=''; + if ((($parmlog{$id}{'exe_uname'} ne $env{'user.name'}) + || ($parmlog{$id}{'exe_udom'} ne $env{'user.domain'}))) { + $send_msg_link ='
'. + &Apache::loncommon::messagewrapper(&mt('Send message'), + $parmlog{$id}{'exe_uname'}, + $parmlog{$id}{'exe_udom'}); + } + my $row_start=&Apache::loncommon::start_data_table_row(); + my $makenewrow=0; + my %istype=(); + my $output; + foreach my $changed (reverse(sort(@changes))) { + my $value=$parmlog{$id}{'logentry'}{$changed}; + my $typeflag = ($changed =~/\.type$/ && + !exists($parmlog{$id}{'logentry'}{$changed.'.type'})); my ($realm,$section,$parmname,$part,$what,$middle,$uname,$udom,$issection,$realmdescription)= - &components($changed,$parmlog{$id}{'uname'},$parmlog{$id}{'udom'},undef,undef,$typeflag); - if ($env{'request.course.sec'} ne '') { - next if (($issection ne '') && ($issection ne $env{'request.course.sec'})); - if ($uname ne '') { - my $stusection = &Apache::lonnet::getsection($uname,$udom,$env{'request.course.id'}); - next if (($stusection ne '-1') && ($stusection ne $env{'request.course.sec'})); - } - } - if ($env{'form.displayfilter'} eq 'currentfolder') { - if ($folder) { - if ($middle!~/^\Q$folder\E/) { next; } - } - } - if ($typeflag) { - $istype{$parmname}=$value; - if (!$env{'form.includetypes'}) { next; } - } - $count++; - if ($makenewrow) { - $output .= $row_start; - } else { - $makenewrow=1; - } + &components($changed,$parmlog{$id}{'uname'},$parmlog{$id}{'udom'},undef,undef,$typeflag); + if ($env{'request.course.sec'} ne '') { + next if (($issection ne '') && ($issection ne $env{'request.course.sec'})); + if ($uname ne '') { + my $stusection = &Apache::lonnet::getsection($uname,$udom,$env{'request.course.id'}); + next if (($stusection ne '-1') && ($stusection ne $env{'request.course.sec'})); + } + } + if ($env{'form.displayfilter'} eq 'currentfolder') { + if ($folder) { + if ($middle!~/^\Q$folder\E/) { next; } + } + } + if ($typeflag) { + $istype{$parmname}=$value; + if (!$env{'form.includetypes'}) { next; } + } + $count++; + if ($makenewrow) { + $output .= $row_start; + } else { + $makenewrow=1; + } my $parmitem = &standard_parameter_names($parmname); - $output .=''.$realm.''.$section.''. - &mt($parmitem).''. - ($part?&mt('Part: [_1]',$part):&mt('All Parts')).''; - my $stillactive=0; - if ($parmlog{$id}{'delflag'}) { - $output .= &mt('Deleted'); - } else { - if ($typeflag) { + $output .=''.$realm.''.$section.''. + &mt($parmitem).''. + ($part?&mt('Part: [_1]',$part):&mt('All Parts')).''; + my $stillactive=0; + if ($parmlog{$id}{'delflag'}) { + $output .= &mt('Deleted'); + } else { + if ($typeflag) { my $parmitem = &standard_parameter_names($value); $parmitem = &mt($parmitem); - $output .= &mt('Type: [_1]',$parmitem); - } else { - my ($level,@all)=&parmval_by_symb($what,$middle,&Apache::lonnet::metadata($middle,$what), - $uname,$udom,$issection,$issection,$courseopt); + $output .= &mt('Type: [_1]',$parmitem); + } else { + my ($level,@all)=&parmval_by_symb($what,$middle, + &Apache::lonnet::metadata($middle,$what), + $uname,$udom,$issection,$issection,$courseopt); my $showvalue = $value; if ($istype{$parmname} eq '') { my $type = &standard_parameter_types($parmname); @@ -5311,63 +6105,77 @@ sub parm_change_log { } } } else { - if (&isdateparm($istype{$parmname})) { - $showvalue = - &Apache::lonlocal::locallocaltime($value); - } + if (&isdateparm($istype{$parmname})) { + $showvalue = &Apache::lonlocal::locallocaltime($value); + } } $output .= $showvalue; - if ($value ne $all[$level]) { - $output .= '
'.&mt('Not active anymore').''; - } else { - $stillactive=1; + if ($value ne $all[$level]) { + $output .= '
'.&mt('Not active anymore').''; + } else { + $stillactive=1; + } + } } - } - } - $output .= ''; - - if ($stillactive) { + $output .= ''; + + if ($stillactive) { my $parmitem = &standard_parameter_names($parmname); $parmitem = &mt($parmitem); - my $title=&mt('Changed [_1]',$parmitem); + my $title=&mt('Changed [_1]',$parmitem); my $description=&mt('Changed [_1] for [_2] to [_3]', - $parmitem,$realmdescription, + $parmitem,$realmdescription, (&isdateparm($istype{$parmname})?&Apache::lonlocal::locallocaltime($value):$value)); - if (($uname) && ($udom)) { - $output .= - &Apache::loncommon::messagewrapper('Notify User', - $uname,$udom,$title, - $description); - } else { - $output .= - &Apache::lonrss::course_blog_link($id,$title, - $description); - } + if (($uname) && ($udom)) { + $output .= + &Apache::loncommon::messagewrapper('Notify User', + $uname,$udom,$title, + $description); + } else { + $output .= + &Apache::lonrss::course_blog_link($id,$title, + $description); + } + } + $output .= ''.&Apache::loncommon::end_data_table_row(); } - $output .= ''.&Apache::loncommon::end_data_table_row(); - } if ($env{'form.displayfilter'} eq 'containing') { - my $wholeentry=$about_me_link.':'. - $parmlog{$id}{'exe_uname'}.':'.$parmlog{$id}{'exe_udom'}.':'. - $output; - if ($wholeentry!~/\Q$env{'form.containingphrase'}\E/i) { next; } - } + my $wholeentry=$about_me_link.':'. + $parmlog{$id}{'exe_uname'}.':'.$parmlog{$id}{'exe_udom'}.':'. + $output; + if ($wholeentry!~/\Q$env{'form.containingphrase'}\E/i) { next; } + } if ($count) { - $r->print($row_start.''.$time.' - '.$about_me_link. - '
'.$parmlog{$id}{'exe_uname'}. - ':'.$parmlog{$id}{'exe_udom'}.''. - $send_msg_link.''.$output); - $shown++; - } - if (!($env{'form.show'} eq &mt('all') - || $shown<=$env{'form.show'})) { last; } + $r->print($row_start.''.$time.' + '.$about_me_link. + '
'.$parmlog{$id}{'exe_uname'}. + ':'.$parmlog{$id}{'exe_udom'}.''. + $send_msg_link.''.$output); + $shown++; + } + if (!($env{'form.show'} eq &mt('all') + || $shown<=$env{'form.show'})) { last; } } $r->print(&Apache::loncommon::end_data_table()); &endSettingsScreen($r); $r->print(&Apache::loncommon::end_page()); } +################################################## +# MISC ! +################################################## + +# Stores slot information. +# Used by table UI +# FIXME: I don't understand how this can work when the symb is not defined (if only a map was selected) +# +# @param {string} $slot_name - slot name +# @param {string} $cdom - course domain +# @param {string} $cnum - course number +# @param {string} $symb - resource symb +# @param {string} $uname - user name +# @param {string} $udom - user domain +# @returns {string} - 'ok' or error name sub update_slots { my ($slot_name,$cdom,$cnum,$symb,$uname,$udom) = @_; my %slot=&Apache::lonnet::get_slot($slot_name); @@ -5421,6 +6229,17 @@ sub update_slots { return $success; } +# Deletes a slot reservation. +# Used by table UI +# FIXME: I don't understand how this can work when the symb is not defined (if only a map was selected) +# +# @param {string} $slot_name - slot name +# @param {string} $cdom - course domain +# @param {string} $cnum - course number +# @param {string} $uname - user name +# @param {string} $udom - user domain +# @param {string} $symb - resource symb +# @returns {string} - 'ok' or error name sub delete_slots { my ($slot_name,$cdom,$cnum,$uname,$udom,$symb) = @_; my $delresult; @@ -5456,12 +6275,19 @@ sub delete_slots { return $delresult; } +# Returns true if there is a current course. +# Used by handler +# +# @returns {boolean} sub check_for_course_info { my $navmap = Apache::lonnavmaps::navmap->new(); return 1 if ($navmap); return 0; } +# Returns the current course host and host LON-CAPA version. +# +# @returns {Array} - (course hostname, major version number, minor version number) sub parameter_release_vars { my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $chome = $env{'course.'.$env{'request.course.id'}.'.home'}; @@ -5471,21 +6297,57 @@ sub parameter_release_vars { return ($chostname,$cmajor,$cminor); } +# Checks if the course host version can handle a parameter required version, +# and if it does, stores the release needed for the course. +# +# @param {string} $name - parameter name +# @param {string} $value - parameter value +# @param {string} $valmatch - name of the test used for checking the value +# @param {string} $namematch - name of the test used for checking the name +# @param {string} $needsrelease - version needed by the parameter, major.minor +# @param {integer} $cmajor - course major version number +# @param {integer} $cminor - course minor version number +# @returns {boolean} - true if a newer version is needed sub parameter_releasecheck { - my ($name,$value,$valmatch,$needsrelease,$cmajor,$cminor) = @_; + my ($name,$value,$valmatch,$namematch,$needsrelease,$cmajor,$cminor) = @_; my $needsnewer; my ($needsmajor,$needsminor) = split(/\./,$needsrelease); if (($cmajor < $needsmajor) || ($cmajor == $needsmajor && $cminor < $needsminor)) { $needsnewer = 1; - } elsif ($valmatch) { - &Apache::lonnet::update_released_required($Apache::lonnet::needsrelease{'parameter:'.$name.'::'.$valmatch}); - } elsif ($value) { - &Apache::lonnet::update_released_required($Apache::lonnet::needsrelease{'parameter:'.$name.':'.$value.':'}); + } elsif ($name) { + if ($valmatch) { + &Apache::lonnet::update_released_required($Apache::lonnet::needsrelease{'parameter:'.$name.'::'.$valmatch.':'}); + } elsif ($value) { + &Apache::lonnet::update_released_required($Apache::lonnet::needsrelease{'parameter:'.$name.':'.$value.'::'}); + } + } elsif ($namematch) { + &Apache::lonnet::update_released_required($Apache::lonnet::needsrelease{'parameter::::'.$namematch}); } return $needsnewer; } +################################################## +# HANDLER +################################################## + +# Main handler for lonparmset. +# Sub called based on request parameters action and command: +# no command or action: print_main_menu +# command 'set': assessparms (direct access to table mode for a resource) +# (this can also be accessed simply with the symb parameter) +# action 'setoverview': overview (display all existing parameter settings) +# action 'addmetadata': addmetafield (called to add a portfolio metadata field) +# action 'ordermetadata': order_meta_fields (called to order portfolio metadata fields) +# action 'setrestrictmeta': setrestrictmeta (display or save portfolio metadata) +# action 'newoverview': newoverview (overview mode) +# action 'setdefaults': defaultsetter (UI to change parameter setting default actions) +# action 'settable': assessparms (table mode) +# action 'parameterchangelog': parm_change_log (display log for parameter changes, +# blog postings, user notification changes) +# action 'cleanparameters': clean_parameters (unused) +# action 'dateshift1': date_shift_one (overview mode, shift all dates) +# action 'dateshift2': date_shift_two (overview mode, shift all dates) sub handler { my $r=shift; @@ -5526,28 +6388,28 @@ sub handler { # Check first if coming from someone else headed directly for # the table mode if ((($env{'form.command'} eq 'set') && ($env{'form.url'}) - && (!$env{'form.dis'})) || ($env{'form.symb'})) { - &assessparms($r); + && (!$env{'form.dis'})) || ($env{'form.symb'})) { + &assessparms($r); } elsif (! exists($env{'form.action'})) { &print_main_menu($r,$parm_permission); } elsif ($env{'form.action'} eq 'setoverview') { - &overview($r); - } elsif ($env{'form.action'} eq 'addmetadata') { - &addmetafield($r); - } elsif ($env{'form.action'} eq 'ordermetadata') { - &order_meta_fields($r); + &overview($r); + } elsif ($env{'form.action'} eq 'addmetadata') { + &addmetafield($r); + } elsif ($env{'form.action'} eq 'ordermetadata') { + &order_meta_fields($r); } elsif ($env{'form.action'} eq 'setrestrictmeta') { - &setrestrictmeta($r); + &setrestrictmeta($r); } elsif ($env{'form.action'} eq 'newoverview') { - &newoverview($r); + &newoverview($r); } elsif ($env{'form.action'} eq 'setdefaults') { - &defaultsetter($r); - } elsif ($env{'form.action'} eq 'settable') { - &assessparms($r); + &defaultsetter($r); + } elsif ($env{'form.action'} eq 'settable') { + &assessparms($r); } elsif ($env{'form.action'} eq 'parameterchangelog') { - &parm_change_log($r); + &parm_change_log($r); } elsif ($env{'form.action'} eq 'cleanparameters') { - &clean_parameters($r); + &clean_parameters($r); } elsif ($env{'form.action'} eq 'dateshift1') { &date_shift_one($r); } elsif ($env{'form.action'} eq 'dateshift2') { @@ -5555,14 +6417,14 @@ sub handler { } } else { # ----------------------------- Not in a course, or not allowed to modify parms - if ($exists) { - $env{'user.error.msg'}= - "/adm/parmset:opa:0:0:Cannot modify assessment parameters"; - } else { - $env{'user.error.msg'}= - "/adm/parmset::0:1:Course environment gone, reinitialize the course"; - } - return HTTP_NOT_ACCEPTABLE; + if ($exists) { + $env{'user.error.msg'}= + "/adm/parmset:opa:0:0:Cannot modify assessment parameters"; + } else { + $env{'user.error.msg'}= + "/adm/parmset::0:1:Course environment gone, reinitialize the course"; + } + return HTTP_NOT_ACCEPTABLE; } &reset_caches();