--- loncom/interface/lonparmset.pm 2015/08/28 22:44:59 1.553 +++ loncom/interface/lonparmset.pm 2020/01/14 21:09:19 1.593 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to set parameters for assessments # -# $Id: lonparmset.pm,v 1.553 2015/08/28 22:44:59 raeburn Exp $ +# $Id: lonparmset.pm,v 1.593 2020/01/14 21:09:19 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -36,7 +36,12 @@ lonparmset - Handler to set parameters f =head1 SYNOPSIS -lonparmset provides an interface to setting course parameters. +lonparmset provides an interface to setting content parameters in a +course. + +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 @@ -54,21 +59,25 @@ Inputs: $what - a parameter spec (inclu $id - a bighash Id number $def - the resource's default value 'stupid emacs -Returns: A list, the first item is the index into the remaining list of items of parm valuse that is the active one, the list consists of parm values at the 14 possible levels +Returns: A list, the first item is the index into the remaining list of items of parm values that is the active one, the list consists of parm values at the 18 possible levels -14- General Course -13- Map or Folder level in course -12- resource default -11- map default -10- resource level in course -9 - General for section -8 - Map or Folder level for section -7 - resource level in section -6 - General for group -5 - Map or Folder level for group -4 - resource level in group -3 - General for specific student -2 - Map or Folder level for specific student +18 - General Course +17 - Map or Folder level in course (recursive) +16 - Map or Folder level in course (non-recursive) +15 - resource default +14 - map default +13 - resource level in course +12 - General for section +11 - Map or Folder level for section (recursive) +10 - Map or Folder level for section (non-recursive) +9 - resource level in section +8 - General for group +7 - Map or Folder level for group (recursive) +6 - Map or Folder level for group (non-recursive) +5 - resource level in group +4 - General for specific student +3 - Map or Folder level for specific student (recursive) +2 - Map or Folder level for specific student (non-recursive) 1 - resource level for specific student =item parmval_by_symb() @@ -129,7 +138,7 @@ javascript function 'pjump'. =item print_td() -=item print_usergroups() +=item check_other_groups() =item parm_control_group() @@ -323,6 +332,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)=@_; @@ -341,6 +359,7 @@ sub startSettingsScreen { $r->print('
'); } +# Page footer sub endSettingsScreen { my ($r)=@_; $r->print('
'); @@ -348,18 +367,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=''; @@ -367,98 +416,141 @@ 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; my $grplevel=$env{'request.course.id'}.'.['.$cgroup.'].'.$what; my $grplevelr=$env{'request.course.id'}.'.['.$cgroup.'].'.$symbparm; + my $grpleveli=$env{'request.course.id'}.'.['.$cgroup.'].'.$recurseparm; my $grplevelm=$env{'request.course.id'}.'.['.$cgroup.'].'.$mapparm; my $seclevel=$env{'request.course.id'}.'.['.$csec.'].'.$what; my $seclevelr=$env{'request.course.id'}.'.['.$csec.'].'.$symbparm; + my $secleveli=$env{'request.course.id'}.'.['.$csec.'].'.$recurseparm; my $seclevelm=$env{'request.course.id'}.'.['.$csec.'].'.$mapparm; my $courselevel=$env{'request.course.id'}.'.'.$what; my $courselevelr=$env{'request.course.id'}.'.'.$symbparm; + my $courseleveli=$env{'request.course.id'}.'.'.$recurseparm; my $courselevelm=$env{'request.course.id'}.'.'.$mapparm; # --------------------------------------------------------- first, check course +# 18 - General Course if (defined($$courseopt{$courselevel})) { - $outpar[14]=$$courseopt{$courselevel}; - $result=14; + $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[13]=$$courseopt{$courselevelm}; - $result=13; + $outpar[16]=$$courseopt{$courselevelm}; + $result=16; } # ------------------------------------------------------- second, check default - if (defined($def)) { $outpar[12]=$def; $result=12; } +# 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[11]=$thisparm; $result=11; } + if (defined($thisparm)) { $outpar[14]=$thisparm; $result=14; } +# 13 - resource level in course if (defined($$courseopt{$courselevelr})) { - $outpar[10]=$$courseopt{$courselevelr}; - $result=10; + $outpar[13]=$$courseopt{$courselevelr}; + $result=13; } # ------------------------------------------------------ fourth, back to course if ($csec ne '') { +# 12 - General for section if (defined($$courseopt{$seclevel})) { - $outpar[9]=$$courseopt{$seclevel}; - $result=9; - } + $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[8]=$$courseopt{$seclevelm}; - $result=8; - } - + $outpar[10]=$$courseopt{$seclevelm}; + $result=10; + } +# 9 - resource level in section if (defined($$courseopt{$seclevelr})) { - $outpar[7]=$$courseopt{$seclevelr}; - $result=7; - } + $outpar[9]=$$courseopt{$seclevelr}; + $result=9; + } } # ------------------------------------------------------ fifth, check course group if ($cgroup ne '') { +# 8 - General for group if (defined($$courseopt{$grplevel})) { - $outpar[6]=$$courseopt{$grplevel}; - $result=6; + $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[5]=$$courseopt{$grplevelm}; - $result=5; + $outpar[6]=$$courseopt{$grplevelm}; + $result=6; } +# 5 - resource level in group if (defined($$courseopt{$grplevelr})) { - $outpar[4]=$$courseopt{$grplevelr}; - $result=4; + $outpar[5]=$$courseopt{$grplevelr}; + $result=5; } } -# ---------------------------------------------------------- fifth, check user +# ---------------------------------------------------------- sixth, check user if ($uname ne '') { - if (defined($$useropt{$courselevel})) { - $outpar[3]=$$useropt{$courselevel}; - $result=3; - } - - if (defined($$useropt{$courselevelm})) { - $outpar[2]=$$useropt{$courselevelm}; - $result=2; - } +# 4 - General for specific student + if (defined($$useropt{$courselevel})) { + $outpar[4]=$$useropt{$courselevel}; + $result=4; + } - if (defined($$useropt{$courselevelr})) { - $outpar[1]=$$useropt{$courselevelr}; - $result=1; - } +# 3 - Map or Folder level for specific student (recursive) + if (defined($$useropt{$courseleveli})) { + $outpar[3]=$$useropt{$courseleveli}; + $result=3; + } + +# 2 - Map or Folder level for specific student (non-recursive) + if (defined($$useropt{$courselevelm})) { + $outpar[2]=$$useropt{$courselevelm}; + $result=2; + } + +# 1 - resource level for specific student + if (defined($$useropt{$courselevelr})) { + $outpar[1]=$$useropt{$courselevelr}; + $result=1; + } } return ($result,@outpar); } @@ -468,106 +560,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 ''; } @@ -602,81 +716,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)=@_; @@ -686,30 +828,56 @@ sub storeparm_by_symb_inner { $map = &Apache::lonnet::deversion($map); my $symbparm=$symb.'.'.$spnam; + my $recurseparm=$map.'___(rec).'.$spnam; my $mapparm=$map.'___(all).'.$spnam; my $grplevel=$env{'request.course.id'}.'.['.$cgroup.'].'.$spnam; my $grplevelr=$env{'request.course.id'}.'.['.$cgroup.'].'.$symbparm; + my $grpleveli=$env{'request.course.id'}.'.['.$cgroup.'].'.$recurseparm; my $grplevelm=$env{'request.course.id'}.'.['.$cgroup.'].'.$mapparm; my $seclevel=$env{'request.course.id'}.'.['.$csec.'].'.$spnam; my $seclevelr=$env{'request.course.id'}.'.['.$csec.'].'.$symbparm; + my $secleveli=$env{'request.course.id'}.'.['.$csec.'].'.$recurseparm; my $seclevelm=$env{'request.course.id'}.'.['.$csec.'].'.$mapparm; my $courselevel=$env{'request.course.id'}.'.'.$spnam; my $courselevelr=$env{'request.course.id'}.'.'.$symbparm; + my $courseleveli=$env{'request.course.id'}.'.'.$recurseparm; my $courselevelm=$env{'request.course.id'}.'.'.$mapparm; my $storeunder=''; - if (($snum==14) || ($snum==3)) { $storeunder=$courselevel; } - if (($snum==13) || ($snum==2)) { $storeunder=$courselevelm; } - if (($snum==10) || ($snum==1)) { $storeunder=$courselevelr; } - if ($snum==9) { $storeunder=$seclevel; } - if ($snum==8) { $storeunder=$seclevelm; } - if ($snum==7) { $storeunder=$seclevelr; } - if ($snum==6) { $storeunder=$grplevel; } - if ($snum==5) { $storeunder=$grplevelm; } - if ($snum==4) { $storeunder=$grplevelr; } + my $possreplace=''; + if (($snum==18) || ($snum==4)) { $storeunder=$courselevel; } + if (($snum==17) || ($snum==3)) { + $storeunder=$courseleveli; + $possreplace=$courselevelm; + } + if (($snum==16) || ($snum==2)) { + $storeunder=$courselevelm; + $possreplace=$courseleveli; + } + if (($snum==13) || ($snum==1)) { $storeunder=$courselevelr; } + if ($snum==12) { $storeunder=$seclevel; } + if ($snum==11) { + $storeunder=$secleveli; + $possreplace=$seclevelm; + } + if ($snum==10) { + $storeunder=$seclevelm; + $possreplace=$secleveli; + } + if ($snum==9) { $storeunder=$seclevelr; } + if ($snum==8) { $storeunder=$grplevel; } + if ($snum==7) { + $storeunder=$grpleveli; + $possreplace=$grplevelm; + } + if ($snum==6) { + $storeunder=$grplevelm; + $possreplace=$grpleveli; + } + if ($snum==5) { $storeunder=$grplevelr; } my $delete; @@ -717,67 +885,100 @@ sub storeparm_by_symb_inner { my %storecontent = ($storeunder => $nval, $storeunder.'.type' => $ntype); my $reply=''; - if ($snum>3) { + + 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==10) || ($snum==7) || ($snum==4)) { - &Apache::lonnet::expirespread('','','assesscalc',$symb); - } elsif (($snum==11) || ($snum==8) || ($snum==5)) { - &Apache::lonnet::expirespread('','','assesscalc',$map); - } else { - &Apache::lonnet::expirespread('','','assesscalc'); - } -# Store parameter - if ($delete) { - $reply=&Apache::lonnet::del - ('resourcedata',[keys(%storecontent)],$cdom,$cnum); - &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==17) || ($snum==16) || ($snum==11) || ($snum==10) || ($snum==7) || ($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); + if ($possreplace) { + my $resdata = &Apache::lonnet::get_courseresdata($cnum,$cdom); + if (ref($resdata) eq 'HASH') { + if (exists($resdata->{$possreplace})) { + if (&Apache::lonnet::del + ('resourcedata',[$possreplace,$possreplace.'.type'],$cdom,$cnum) eq 'ok') { + &log_parmset({$possreplace => '', $possreplace.'.type' => $ntype},1); + } + } + } + } + } + &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) || ($snum==3)) { + &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); + if ($possreplace) { + my $resdata = &Apache::lonnet::get_userresdata($uname,$udom); + if (ref($resdata) eq 'HASH') { + if (exists($resdata->{$possreplace})) { + if (&Apache::lonnet::del + ('resourcedata',[$possreplace,$possreplace.'.type'],$udom,$uname) eq 'ok') { + &log_parmset({$possreplace => '',$possreplace.'.type' => $ntype},1, + $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 {boolean} $editable - Set to true to get an icon when no value is defined. sub valout { - my ($value,$type,$editable)=@_; + my ($value,$type,$name,$editable)=@_; my $result = ''; # Values of zero are valid. if (! $value && $value ne '0') { @@ -791,7 +992,17 @@ sub valout { } } else { if ($type eq 'date_interval') { - my ($sec,$min,$hour,$mday,$mon,$year)=gmtime($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; $mday--; @@ -824,25 +1035,47 @@ sub valout { push(@timer,&mt('[quant,_1,sec]',0)); } $result.=join(", ",@timer); + 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') +# @param {boolean} $recursive - true if link is for a map/folder where parameter is currently set to be recursive. +# @param {string} $extra - optional additional information to send as tenth arg in call to javascript pjump function. sub plink { - my ($type,$dis,$value,$marker,$return,$call)=@_; + my ($type,$dis,$value,$marker,$return,$call,$recursive,$extra)=@_; my $winvalue=$value; unless ($winvalue) { - if (&isdateparm($type)) { + if (&isdateparm($type) || (&is_specialstring($type))) { $winvalue=$env{'form.recent_'.$type}; + } elsif ($type eq 'string_yesno') { + if ($env{'form.recent_string'} =~ /^(yes|no)$/i) { + $winvalue=$env{'form.recent_string'}; + } } else { $winvalue=$env{'form.recent_'.(split(/\_/,$type))[0]}; } @@ -853,16 +1086,19 @@ sub plink { my $valout = &valout($value,$type,1); my $unencmarker = $marker; foreach my $item (\$type, \$dis, \$winvalue, \$marker, \$return, \$call, - \$hour, \$min, \$sec) { - $$item = &HTML::Entities::encode($$item,'"<>&'); - $$item =~ s/\'/\\\'/g; + \$hour, \$min, \$sec, \$extra) { + $$item = &HTML::Entities::encode($$item,'"<>&'); + $$item =~ s/\'/\\\'/g; } return '
'. ''. - $valout.'
'; + .$marker."','".$return."','".$call."','".$hour."','".$min."','".$sec."','".$extra."'".');">'. + $valout.''.($recursive?''. + &mt('recursive').'' : '').''; + } +# Javascript for table mode. sub page_js { my $selscript=&Apache::loncommon::studentbrowser_javascript(); @@ -875,20 +1111,22 @@ sub page_js { $pjump_def function psub() { + var specstring = /^string_!(yesno|any)/i; if (document.parmform.pres_marker.value!='') { 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') || + (specstring.test(document.parmform.pres_type.value))) { + 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=''; @@ -912,6 +1150,8 @@ ENDJS } +# Javascript to show or hide the map selection (function showHide_courseContent), +# for table and overview modes. sub showhide_js { return <<"COURSECONTENTSCRIPT"; @@ -932,6 +1172,7 @@ function showHide_courseContent() { COURSECONTENTSCRIPT } +# Javascript functions showHideLenient and toggleParmTextbox, for overview mode sub toggleparmtextbox_js { return <<"ENDSCRIPT"; @@ -991,6 +1232,7 @@ function toggleParmTextbox(form,key) { ENDSCRIPT } +# Javascript function validateParms, for overview mode sub validateparms_js { return <<'ENDSCRIPT'; @@ -1001,12 +1243,16 @@ function validateParms() { var patternLenientStd = /^(yes|no|default)$/; var ipallowRegExp = /^setipallow_/; var ipdenyRegExp = /^setipdeny_/; + var deeplinkRegExp = /^deeplink_(listing|scope)_/; + var deeplinkUrlsRegExp = /^deeplink_urls_/; + var deeplinkltiRegExp = /^deeplink_lti_/; + var deeplinkkeyRegExp = /^deeplink_key_/; var patternIP = /[\[\]\*\.a-zA-Z\d\-]+/; if ((document.parmform.elements.length != 'undefined') && (document.parmform.elements.length) != 'null') { if (document.parmform.elements.length) { for (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().' |; - } elsif ($currsec eq '') { + } else { $sections .= qq| 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('
'); @@ -2527,7 +3334,7 @@ ENDPARMSELSCRIPT # Step 2 $r->print(&Apache::lonhtmlcommon::topic_bar(2,&mt('Parameter Specification'),'parmstep2')); - &displaymenu($r,\%allparms,\@pscat,\@psprt,\%keyorder,'parmmenuscroll'); + &displaymenu($r,\%allparms,\@pscat,\%keyorder,'parmmenuscroll'); # Step 3 $r->print(&Apache::lonhtmlcommon::topic_bar(3,&mt('User Specification (optional)'),'parmstep3')); @@ -2594,31 +3401,35 @@ ENDPARMSELSCRIPT my @catmarker=map { tr|.|_|; 'parameter_'.$_; } @pscat; my $csuname=$env{'user.name'}; my $csudom=$env{'user.domain'}; + my $readonly = 1; + if ($parm_permission->{'edit'}) { + undef($readonly); + } if ($parmlev eq 'full') { # # This produces the cascading table output of parameters # - my $coursespan=$csec?8:5; - my $userspan=3; - if ($cgroup ne '') { - $coursespan += 3; - } - - $r->print(&Apache::loncommon::start_data_table()); -# -# This produces the headers -# - $r->print(''); - $r->print(''.&mt('Any User').''); - if ($uname) { + my $coursespan=$csec?8:5; + my $userspan=3; + if ($cgroup ne '') { + $coursespan += 3; + } + + $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", @@ -2634,59 +3445,58 @@ ENDPARMSELSCRIPT 'foremf' => 'for Enclosing Map or Folder', '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{'foremf'} $lt{'def'}$lt{'femof'}$lt{'fr'} ENDTABLEHEADFOUR - if ($csec) { - $r->print(''.&mt('general').''.&mt('for Enclosing Map or Folder').''.&mt('for Resource').''); - } - - if ($cgroup) { - $r->print(''.&mt('general').''.&mt('for Enclosing Map or Folder').''.&mt('for Resource').''); - } + if ($csec) { + $r->print(''.$lt{'gen'}.''.$lt{'foremf'}.''.$lt{'fr'}.''); + } + + if ($cgroup) { + $r->print(''.$lt{'gen'}.''.$lt{'foremf'}.''.$lt{'fr'}.''); + } - if ($uname) { + if ($uname) { if (@usersgroups > 1) { $r->print(''.&mt('Control by other group?').''); - } - $r->print(''.&mt('general').''.&mt('for Enclosing Map or Folder').''.&mt('for Resource').''); - } + } + $r->print(''.$lt{'gen'}.''.$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'; @@ -2712,39 +3522,48 @@ ENDTABLEHEADFOUR my %type= (); my %default=(); my $uri=&Apache::lonnet::declutter($uris{$rid}); + my $toolsymb; + if ($uri =~ /ext\.tool$/) { + $toolsymb = $symbp{$rid}; + } 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',$toolsymb); + # 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',$toolsymb); + + my $parmdis=&Apache::lonnet::metadata($uri,$tempkeyp.'.display',$toolsymb); + 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,$toolsymb); + $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$tempkeyp.'.type',$toolsymb); + $thistitle=&Apache::lonnet::metadata($uri,$tempkeyp.'.title',$toolsymb); } } my $totalparms=scalar(keys(%name)); if ($totalparms>0) { - my $firstrow=1; + my $firstrow=1; my $title=&Apache::lonnet::gettitle($symbp{$rid}); + my $navmap = Apache::lonnavmaps::navmap->new(); + my @recurseup; + if (ref($navmap) && $mapp{$rid}) { + @recurseup = $navmap->recurseup_maps($mapp{$rid}); + } $r->print(''. @@ -2776,7 +3595,9 @@ ENDTABLEHEADFOUR &print_row($r,$item,\%part,\%name,\%symbp,$rid,\%default, \%type,\%display,$defbgone,$defbgtwo, $defbgthree,$parmlev,$uname,$udom,$csec, - $cgroup,\@usersgroups,$noeditgrp); + $cgroup,\@usersgroups,$noeditgrp,$readonly, + \@recurseup,\%maptitles,\%allmaps_inverted, + \$numreclinks); } } } @@ -2800,7 +3621,7 @@ ENDTABLEHEADFOUR #-------------------------------------------- for each map, gather information my $mapid; - foreach $mapid (sort {$maplist{$a} cmp $maplist{$b}} keys(%maplist)) { + foreach $mapid (sort {$maplist{$a} cmp $maplist{$b}} keys(%maplist)) { my $maptitle = $maplist{$mapid}; #----------------------- loop through ids and get all parameter types for map @@ -2820,8 +3641,13 @@ ENDTABLEHEADFOUR # $r->print("$mapid:$map: $rid
\n"); - if ($map eq $mapid) { + if ($map eq $mapid) { my $uri=&Apache::lonnet::declutter($uris{$rid}); + my $toolsymb; + if ($uri =~ /ext\.tool$/) { + $toolsymb = $symbp{$rid}; + } + # $r->print("Keys: $keyp{$rid}
\n"); #-------------------------------------------------------------------- @@ -2837,8 +3663,8 @@ ENDTABLEHEADFOUR if ((grep $_ eq $fullkeyp, @catmarker) &&(!$name{$tempkeyp})) { $part{$tempkeyp}="0"; - $name{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.name'); - my $parmdis=&Apache::lonnet::metadata($uri,$fullkeyp.'.display'); + $name{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.name',$toolsymb); + my $parmdis=&Apache::lonnet::metadata($uri,$fullkeyp.'.display',$toolsymb); if ($allparms{$name{$tempkeyp}} ne '') { my $identifier; if ($parmdis =~ /(\s*\[Part.*)$/) { @@ -2851,11 +3677,11 @@ ENDTABLEHEADFOUR unless ($display{$tempkeyp}) { $display{$tempkeyp}=''; } $display{$tempkeyp}.=' ('.$name{$tempkeyp}.')'; $display{$tempkeyp} =~ s/_\w+_/_0_/; - $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp); - $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.type'); + $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp,$toolsymb); + $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.type',$toolsymb); } } # end loop through keys - } + } } # end loop through ids #---------------------------------------------------- print header information @@ -2889,16 +3715,28 @@ ENDTABLEHEADFOUR $r->print('

'.&Apache::loncommon::start_data_table() .&Apache::loncommon::start_data_table_header_row() .''.&mt('Parameter Name').'' - .''.&mt('Default Value').'' + .''.&mt('Value').'' .''.&mt('Parameter in Effect').'' .&Apache::loncommon::end_data_table_header_row() ); + my $navmap = Apache::lonnavmaps::navmap->new(); + my @recurseup; + if (ref($navmap)) { + my $mapres = $navmap->getByMapPc($mapid); + if (ref($mapres)) { + @recurseup = $navmap->recurseup_maps($mapres->src()); + } + } + + foreach my $item (&keysinorder(\%name,\%keyorder)) { $r->print(&Apache::loncommon::start_data_table_row()); &print_row($r,$item,\%part,\%name,\%symbp,$mapid,\%default, \%type,\%display,$defbgone,$defbgtwo,$defbgthree, - $parmlev,$uname,$udom,$csec,$cgroup,'',$noeditgrp); + $parmlev,$uname,$udom,$csec,$cgroup,'',$noeditgrp, + $readonly,\@recurseup,\%maptitles,\%allmaps_inverted, + \$numreclinks); } $r->print(&Apache::loncommon::end_data_table().'

' .'
' @@ -2925,6 +3763,10 @@ ENDTABLEHEADFOUR my $rid = $id; my $uri=&Apache::lonnet::declutter($uris{$rid}); + my $toolsymb; + if ($uri =~ /ext\.tool$/) { + $toolsymb = $symbp{$rid}; + } #-------------------------------------------------------------------- # @catmarker contains list of all possible parameters including part #s @@ -2938,8 +3780,8 @@ ENDTABLEHEADFOUR $tempkeyp =~ s/_\w+_/_0_/; if ((grep $_ eq $fullkeyp, @catmarker) &&(!$name{$tempkeyp})) { $part{$tempkeyp}="0"; - $name{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.name'); - my $parmdis=&Apache::lonnet::metadata($uri,$fullkeyp.'.display'); + $name{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.name',$toolsymb); + my $parmdis=&Apache::lonnet::metadata($uri,$fullkeyp.'.display',$toolsymb); if ($allparms{$name{$tempkeyp}} ne '') { my $identifier; if ($parmdis =~ /(\s*\[Part.*)$/) { @@ -2952,9 +3794,9 @@ ENDTABLEHEADFOUR unless ($display{$tempkeyp}) { $display{$tempkeyp}=''; } $display{$tempkeyp}.=' ('.$name{$tempkeyp}.')'; $display{$tempkeyp} =~ s/_\w+_/_0_/; - $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp); - $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.type'); - } + $default{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp,$toolsymb); + $type{$tempkeyp}=&Apache::lonnet::metadata($uri,$fullkeyp.'.type',$toolsymb); + } } # end loop through keys } # end loop through ids @@ -2987,8 +3829,9 @@ ENDMAPONE foreach my $item (&keysinorder(\%name,\%keyorder)) { $r->print(&Apache::loncommon::start_data_table_row()); &print_row($r,$item,\%part,\%name,\%symbp,$mapid,\%default, - \%type,\%display,$defbgone,$defbgtwo,$defbgthree, - $parmlev,$uname,$udom,$csec,$cgroup,'',$noeditgrp); + \%type,\%display,$defbgone,$defbgtwo,$defbgthree, + $parmlev,$uname,$udom,$csec,$cgroup,'',$noeditgrp, + $readonly); } $r->print(&Apache::loncommon::end_data_table() .'

' @@ -2997,17 +3840,42 @@ ENDMAPONE } # end of $parmlev eq general } $r->print(''); + if ($numreclinks) { + $r->print(<<"END"); +
+ + + + +
+ +END + } &endSettingsScreen($r); $r->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) = @_; + my ($readonly,$is_map) = @_; if ($tableopen) { return ''; } else { @@ -3016,22 +3884,35 @@ sub tablestart { if ($readonly) { $output .= ''.&mt('Current value').''; } else { - $output .= ''.&mt('Delete').''.&mt('Set to ...').''; + $output .= ''.&mt('Delete').''. + ''.&mt('Set to ...').''; + if ($is_map) { + $output .= ''.&mt('Recursive?').''; + } } $output .= ''; return $output; } } +# 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 @@ -3060,8 +3941,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, setdeeplink) - 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 @@ -3070,167 +3967,385 @@ sub storedata { my %newdata=(); undef %newdata; my @deldata=(); + my @delrec=(); + my @delnonrec=(); 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; + my ($altkey,$recursive,$tkey,$tkeyrec,$tkeynonrec); + next if ($cmd eq 'rec' || $cmd eq 'settext' || $cmd eq 'setipallow' || $cmd eq 'setipdeny' || $cmd eq 'setdeeplink'); + if ((($cmd eq 'set') || ($cmd eq 'datepointer') || ($cmd eq 'dateinterval') || ($cmd eq 'del')) && + ($thiskey =~ /(?:sequence|page)\Q___(all)\E/)) { + unless ($thiskey =~ /(encrypturl|hiddenresource)$/) { + $altkey = $thiskey; + $altkey =~ s/\Q___(all)\E/___(rec)/; + if ($env{'form.rec_'.$thiskey}) { + $recursive = 1; + } + } + } + my ($tuname,$tudom)=&extractuser($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=$thiskey; + $tkey=~s/\.\[useropt\:$tuname\:$tudom\]\./\./; + if ($altkey) { + $tkeynonrec = $tkey; + $tkeyrec = $altkey; + $tkeyrec=~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') || ($typeof eq 'string_deeplink')) { + ($name) = ($typeof =~ /^string_(lenient|deeplink)$/); + 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 ($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 ($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'; + if ($recursive) { + $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; } } - } - } elsif ($cmd eq 'dateinterval') { - $data=&get_date_interval_from_form($thiskey); - $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; + my ($reconlychg,$haschange,$storekey); + if ($tuname) { + my $ustorekey; + if ($altkey) { + if ($recursive) { + if (exists($$olddata{$thiskey})) { + if ($$olddata{$thiskey} eq $data) { + $reconlychg = 1; + } + &Apache::lonnet::del('resourcedata',[$tkeynonrec,$tkeynonrec.'.type'],$tudom,$tuname); + } + if (exists($$olddata{$altkey})) { + if (defined($data) && $$olddata{$altkey} ne $data) { + $haschange = 1; + } + } elsif ((!$reconlychg) && ($data ne '')) { + $haschange = 1; + } + $ustorekey = $tkeyrec; + } else { + if (exists($$olddata{$altkey})) { + if ($$olddata{$altkey} eq $data) { + $reconlychg = 1; + } + &Apache::lonnet::del('resourcedata',[$tkeyrec,$tkeyrec.'.type'],$tudom,$tuname); + } + if (exists($$olddata{$thiskey})) { + if (defined($data) && $$olddata{$thiskey} ne $data) { + $haschange = 1; + } + } elsif ((!$reconlychg) && ($data ne '')) { + $haschange = 1; + } + $ustorekey = $tkeynonrec; + } + } else { + if (exists($$olddata{$tkey})) { + if (defined($data) && $$olddata{$tkey} ne $data) { + $haschange = 1; + } + $ustorekey = $tkey; + } + } + if ($haschange || $reconlychg) { + unless ($env{'form.del_'.$thiskey}) { + if (&Apache::lonnet::put('resourcedata',{$ustorekey=>$data, + $ustorekey.'.type' => $typeof}, + $tudom,$tuname) eq 'ok') { + &log_parmset({$ustorekey=>$data,$ustorekey.'.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 { + if ($altkey) { + if ($recursive) { + if (exists($$olddata{$thiskey})) { + if ($$olddata{$thiskey} eq $data) { + $reconlychg = 1; + } + push(@delnonrec,($thiskey,$thiskey.'.type')); + } + if (exists($$olddata{$altkey})) { + if (defined($data) && $$olddata{$altkey} ne $data) { + $haschange = 1; + } + } elsif (($data ne '') && (!$reconlychg)) { + $haschange = 1; + } + $storekey = $altkey; + } else { + if (exists($$olddata{$altkey})) { + if ($$olddata{$altkey} eq $data) { + $reconlychg = 1; + } + push(@delrec,($altkey,$altkey.'.type')); + } + if (exists($$olddata{$thiskey})) { + if (defined($data) && $$olddata{$thiskey} ne $data) { + $haschange = 1; + } + } elsif (($data ne '') && (!$reconlychg)) { + $haschange = 1; + } + $storekey = $thiskey; + } + } else { + if (defined($data) && $$olddata{$thiskey} ne $data) { + $haschange = 1; + $storekey = $thiskey; + } + } } - $needsnewer = ¶meter_releasecheck($name,$valchk,$valmatch, - $needsrelease, - $cmajor,$cminor); - if ($needsnewer) { - $r->print('
'.&oldversion_warning($name,$data, - $chostname,$cmajor, - $cminor,$needsrelease)); - next; + if ($reconlychg || $haschange) { + unless ($env{'form.del_'.$thiskey}) { + $newdata{$storekey}=$data; + $newdata{$storekey.'.type'}=$typeof; + } + } + } elsif ($cmd eq 'del') { + if ($tuname) { + my $error; + if ($altkey) { + if (exists($$olddata{$altkey})) { + if (&Apache::lonnet::del('resourcedata',[$tkeyrec,$tkeyrec.'.type'],$tudom,$tuname) eq 'ok') { + &log_parmset({$tkeyrec=>''},1,$tuname,$tudom); + if ($recursive) { + $r->print('
'.&mt('Deleted parameter for').' '.&Apache::loncommon::plainname($tuname,$tudom)); + } + } elsif ($recursive) { + $error = 1; + } + } + if (exists($$olddata{$thiskey})) { + if (&Apache::lonnet::del('resourcedata',[$tkeynonrec,$tkeynonrec.'.type'],$tudom,$tuname) eq 'ok') { + &log_parmset({$tkeynonrec=>''},1,$tuname,$tudom); + unless ($recursive) { + $r->print('
'.&mt('Deleted parameter for').' '.&Apache::loncommon::plainname($tuname,$tudom)); + } + } elsif (!$recursive) { + $error = 1; + } + } + } else { + if (exists($$olddata{$thiskey})) { + if (&Apache::lonnet::del('resourcedata',[$tkey,$tkey.'.type'],$tudom,$tuname) eq 'ok') { + &log_parmset({$tkey=>''},1,$tuname,$tudom); + $r->print('
'.&mt('Deleted parameter for').' '.&Apache::loncommon::plainname($tuname,$tudom)); + } else { + $error = 1; + } + } + } + if ($error) { + $r->print('
'. + &mt('Error deleting parameters').'
'); + } + &Apache::lonnet::devalidateuserresdata($tuname,$tudom); + } else { + if ($altkey) { + if (exists($$olddata{$altkey})) { + unless (grep(/^\Q$altkey\E$/,@delrec)) { + push(@deldata,($altkey,$altkey.'.type')); + } + } + if (exists($$olddata{$thiskey})) { + unless (grep(/^\Q$thiskey\E$/,@delnonrec)) { + push(@deldata,($thiskey,$thiskey.'.type')); + } + } + } elsif (exists($$olddata{$thiskey})) { + 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 @alldels; + if (@delrec) { + push(@alldels,@delrec); + } + if (@delnonrec) { + push(@alldels,@delnonrec); + } + if (@deldata) { + push(@alldels,@deldata); + } 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); + my ($delresult,$devalidate); + if (@alldels) { + if (&Apache::lonnet::del('resourcedata',\@alldels,$dom,$crs) eq 'ok') { + my %loghash=map { $_ => '' } @alldels; + &log_parmset(\%loghash,1); + if ($delentries) { + $r->print('

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

'); + } + } elsif ($delentries) { + $r->print('
'. + &mt('Error deleting parameters').'
'); + } + $devalidate = 1; } 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').'
'); + 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').'
'); + } + $devalidate = 1; } - &Apache::lonnet::devalidatecourseresdata($crs,$dom); + if ($devalidate) { + &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 @@ -3239,11 +4354,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=~/^(.*)\.(.*)$/); @@ -3251,8 +4366,18 @@ 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 +# @param {boolean} $readonly - true if editing not allowed +# @returns{integer} - number of $listdata parameters processed sub listdata { - my ($r,$resourcedata,$listdata,$sortorder,$caller,$classlist)=@_; + my ($r,$resourcedata,$listdata,$sortorder,$caller,$classlist,$readonly)=@_; # Start list output @@ -3270,203 +4395,238 @@ sub listdata { if (&Apache::lonnet::allowed('mdg',$env{'request.course.id'})) { %grouphash = &Apache::longroup::coursegroups(); } elsif ($env{'request.course.groups'} ne '') { - map { $grouphash{$_} = 1; } split(/,/,$env{'request.course.groups'}); + map { $grouphash{$_} = 1; } split(/:/,$env{'request.course.groups'}); } } - foreach my $thiskey (sort { - my ($astudent,$ares,$apart,$aparm) = &parse_listdata_key($a,$listdata); - my ($bstudent,$bres,$bpart,$bparm) = &parse_listdata_key($b,$listdata); + foreach my $key (sort { + 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})) { - - 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'}); + $result; + + } keys(%{$listdata})) { # foreach my $key + my $thiskey = $key; + 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'); + my $showval = $$resourcedata{$thiskey}; + 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').''; + my ($is_map,$is_recursive,$mapurl,$maplevel); + if ($caller eq 'overview') { + if ($middle=~/^(.+)\_\_\_\((all|rec)\)$/) { + $mapurl = $1; + $maplevel = $2; + $is_map = 1; + } + } elsif ($caller eq 'newoverview') { + if ($middle=~/^(.+)\_\_\_\((all)\)$/) { + $mapurl = $1; + $maplevel = $2; + $is_map = 1; + } + } + if ($is_map) { + my $leveltitle = &mt('Folder/Map'); + unless (($name eq 'hiddenresource') || ($name eq 'encrypturl')) { + if ($caller eq 'newoverview') { + my $altkey = $thiskey; + $altkey =~ s/\Q___(all)\E/___(rec)/; + if ((exists($$resourcedata{$altkey})) & (!exists($$resourcedata{$thiskey}))) { + $is_recursive = 1; + if ($$resourcedata{$altkey.'.type'}) { + $thistype=$$resourcedata{$altkey.'.type'}; + } + $showval = $$resourcedata{$altkey}; + } + } elsif (($caller eq 'overview') && ($maplevel eq 'rec')) { + $thiskey =~ s/\Q___(rec)\E/___(all)/; + $is_recursive = 1; + } + } + $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\)$/) { - $realm=''.&mt('Folder/Map').': '.&Apache::lonnet::gettitle($1).'
('.$1.')'; - } 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 -# - 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'; + if ($part ne $oldpart) { + $r->print(&tableend(). + "\n".''.&mt('Part').": $part"); + $oldpart=$part; } - $r->print( - &Apache::lonhtmlcommon::date_setter('parmform', - $jskey, - $$resourcedata{$thiskey}, - '',1,$state)); - unless ($readonly) { + # + # Ready to print + # + my $parmitem = &standard_parameter_names($name); + $r->print(&tablestart($readonly,$is_map). + &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, + $showval, + '',1,$state)); + unless ($readonly) { + $r->print( + ''. + (($showval!=0)?''. + &mt('Shift all dates based on this date').'':''). + &date_sanity_info($showval) + ); + } + } elsif ($thistype eq 'date_interval') { + $r->print(&date_interval_selector($thiskey,$name, + $showval,$readonly)); + } elsif ($thistype =~ m/^string/) { + $r->print(&string_selector($thistype,$thiskey, + $showval,$name,$readonly)); + } else { + $r->print(&default_selector($thiskey,$showval,$readonly)); } - } elsif ($thistype eq 'date_interval') { - $r->print(&date_interval_selector($thiskey, - $$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(''); + if ($is_map) { + if (($name eq 'encrypturl') || ($name eq 'hiddenresource')) { + $r->print('
'.&mt('Yes').'
'); + } else { + my ($disabled,$recon,$recoff); + if ($readonly) { + $disabled = ' disabled="disabled"'; + } + if ($is_recursive) { + $recon = ' checked="checked"'; + } else { + $recoff = ' checked="checked"'; + } + $r->print('
'. + '
'); + } + } + $r->print(&Apache::loncommon::end_data_table_row()); } - $r->print(''.&Apache::loncommon::end_data_table_row()); - } } return $foundkeys; } - -sub date_interval_selector { - my ($thiskey, $showval, $readonly) = @_; - my $result; - foreach my $which (['days', 86400, 31], - ['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); - } - unless ($readonly) { - $result .= ''; - } - return $result; - -} - +# 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; @@ -3474,15 +4634,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') || ($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; @@ -3492,6 +4674,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 = ( @@ -3520,7 +4708,7 @@ sub string_ip_selector { @{$access{'deny'}} = (''); } my ($disabled,$addmore); - if ($disabled) { + if ($readonly) { $disabled=' disabled="disabled"'; } else { $addmore = "\n".''; @@ -3552,12 +4740,147 @@ sub string_ip_selector { return $output; } -{ +sub string_deeplink_selector { + my ($thiskey, $showval, $readonly) = @_; + my (@components,%values,@current,%titles,%options,%optiontext,%defaults,%posslti); + @components = ('listing','scope','urls'); + %titles = &Apache::lonlocal::texthash ( + listing => 'In Contents and/or Gradebook', + scope => 'Access scope for link', + urls => 'Supported link types', + ); + %options = ( + listing => ['full','absent','grades','details','datestatus'], + scope => ['res','map','rec'], + urls => ['any','only','key','lti'], + ); + %optiontext = &Apache::lonlocal::texthash ( + full => 'Listed (linked) in both', + absent => 'Not listed', + grades => 'Listed in grades only', + details => 'Listed (unlinked) in both', + datestatus => 'Listed (unlinked) inc. status in both', + res => 'resource only', + map => 'enclosing map/folder', + rec => 'recursive map/folder', + any => 'regular + deep', + only => 'deep only', + key => 'deep with key', + lti => 'deep with LTI launch', + ); + if ($showval =~ /,/) { + @current = split(/,/,$showval); + ($values{'listing'}) = ($current[0] =~ /^(full|absent|grades|details|datestatus)$/); + ($values{'scope'}) = ($current[1] =~ /^(res|map|rec)$/); + ($values{'urls'}) = ($current[2] =~ /^(any|only|key:\w+|lti:\d+)$/); + } else { + $defaults{'listing'} = 'full'; + $defaults{'scope'} = 'res'; + $defaults{'urls'} = 'any'; + } + my $disabled; + if ($readonly) { + $disabled=' disabled="disabled"'; + } + my %lti = + &Apache::lonnet::get_domain_lti($env{'course.'.$env{'request.course.id'}.'.domain'}, + 'provider'); + foreach my $item (keys(%lti)) { + if (ref($lti{$item}) eq 'HASH') { + unless ($lti{$item}{'requser'}) { + $posslti{$item} = $lti{$item}{'consumer'}; + } + } + } + my $output = ''; + foreach my $item ('listing','scope','urls') { + $output .= ''; + } + $output .= ''; + foreach my $item (@components) { + $output .= ''; + } + $output .= '
'.$titles{$item}.'
'; + if ($item eq 'urls') { + my $selected = $values{$item}; + foreach my $option (@{$options{$item}}) { + if ($option eq 'lti') { + next unless (keys(%posslti)); + } + my $checked; + if ($selected =~ /^\Q$option\E/) { + $checked = ' checked="checked"'; + } + my $onclick; + unless ($readonly) { + my $esc_key = &js_escape($thiskey); + $onclick = ' onclick="toggleDeepLink(this.form,'."'$item','$esc_key'".');"'; + } + $output .= ''; + if ($option eq 'key') { + my $visibility="hidden"; + my $currkey; + if ($checked) { + $visibility = "text"; + $currkey = (split(/\:/,$values{$item}))[1]; + } + $output .= ' '. + ''; + } elsif ($option eq 'lti') { + my $display="none"; + my ($currlti,$blankcheck); + if ($checked) { + $display = 'inline-block'; + $currlti = (split(/\:/,$values{$item}))[1]; + } else { + $blankcheck = ' selected="selected"'; + } + $output .= '
 
'; + } + $output .= ' '; + } + } else { + my $selected = $values{$item}; + my $defsel; + if ($selected eq '') { + $defsel = ' selected="selected"'; + } + $output .= ''; + } + $output .= '
'."\n"; + 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.' ], @@ -3583,8 +4906,11 @@ my %strings = ['no','No']], 'string_ip' => [['_allowfrom_','Hostname(s), or IP(s) from which access is allowed'], - ['_denyfrom_',], 'Hostname(s) or IP(s) from which access is disallowed'], - ); + ['_denyfrom_','Hostname(s) or IP(s) from which access is disallowed']], + 'string_deeplink' + => [['on','Set choices for link protection, resource listing, and access scope']], + ); + my %stringmatches = ( 'string_lenient' @@ -3592,6 +4918,8 @@ my %stringmatches = ( 'string_ip' => [['_allowfrom_','[^\!]+'], ['_denyfrom_','\!']], + 'string_deeplink' + => [['on','^(full|absent|grades|details|datestatus)\,(res|map|rec)\,(any|only|key\:\w+|lti\:\d+)$']], ); my %stringtypes = ( @@ -3601,8 +4929,14 @@ my %stringtypes = ( discussvote => 'string_discussvote', examcode => 'string_examcode', acc => 'string_ip', + deeplink => 'string_deeplink', ); +# 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') { @@ -3611,6 +4945,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') { @@ -3619,6 +4957,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})) { @@ -3627,6 +4969,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) = @_; @@ -3636,10 +4986,11 @@ 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') || + ($thistype eq 'string_deeplink') || + ($name eq 'retrypartial')) { my ($got_chostname,$chostname,$cmajor,$cminor); foreach my $possibilities (@{ $strings{$thistype} }) { next unless (ref($possibilities) eq 'ARRAY'); @@ -3662,7 +5013,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 '') { @@ -3677,6 +5028,8 @@ sub string_selector { if ($thistype eq 'string_ip') { return &string_ip_selector($thiskey,$showval,$readonly); + } elsif ($thistype eq 'string_deeplink') { + return &string_deeplink_selector($thiskey,$showval,$readonly); } my ($result,$disabled); @@ -3774,8 +5127,202 @@ sub string_selector { return $result; } +my %intervals = + ( + 'date_interval' + => [[ 'done', 'Yes' ], + [ 'done_proctor', 'Yes, with proctor key'], + [ '', 'No' ]], + ); + +my %intervalmatches = ( + 'date_interval' + => [['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') { + return $intervalmatches{$interval_type}; + } + 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})) { + return $intervaltypes{$name}; + } + 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') { + return $intervals{$interval_type}; + } + 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); + if ($name eq 'interval') { + my $intervaltype = &get_intervaltype($name); + my ($got_chostname,$chostname,$cmajor,$cminor); + foreach my $possibilities (@{ $intervals{$intervaltype} }) { + next unless (ref($possibilities) eq 'ARRAY'); + my ($parmval, $description) = @{ $possibilities }; + my $parmmatch; + if (ref($intervalmatches{$intervaltype}) eq 'ARRAY') { + foreach my $item (@{$intervalmatches{$intervaltype}}) { + if (ref($item) eq 'ARRAY') { + if ($parmval eq $item->[0]) { + $parmmatch = $parmval; + $parmval = ''; + last; + } + } + } + } + my $needsrelease=$Apache::lonnet::needsrelease{"parameter:$name:$parmval:$parmmatch"}; + if ($needsrelease) { + unless ($got_chostname) { + ($chostname,$cmajor,$cminor)=¶meter_release_vars(); + $got_chostname = 1; + } + my $needsnewer=¶meter_releasecheck($name,$parmval,$parmmatch,undef, + $needsrelease,$cmajor,$cminor); + if ($needsnewer) { + if ($parmmatch ne '') { + $skipval{$parmmatch} = 1; + } elsif ($parmval ne '') { + $skipval{$parmval} = 1; + } + } + } + } + } + + my $currval = $showval; + foreach my $which (['days', 86400, 31], + ['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); + } + 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$/) { + $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'; + } + my $onclick = ' onclick="toggleSecret(this.form,'."'done_','$thiskey'".');"'; + my $disabled; + if ($readonly) { + $disabled = ' disabled="disabled"'; + } + $result .= '
'.&mt('Include "done" button'). + ''.(' 'x2). + ''.(' 'x2). + ''. + '&').'"'.$disabled.' />
'. + ''.&mt('Button text').': '. + '&').'"'.$disabled.' />'; + } + } + unless ($readonly) { + $result .= ''; + } + 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 '') { @@ -3820,22 +5367,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'}; @@ -3867,12 +5415,19 @@ sub dateshift { return $reply; } +# Overview mode UI to edit course parameters. +# +# @param {Apache2::RequestRec} $r - the Apache request sub newoverview { - my ($r) = @_; + my ($r,$parm_permission) = @_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $crs = $env{'course.'.$env{'request.course.id'}.'.num'}; my $crstype = $env{'course.'.$env{'request.course.id'}.'.type'}; + my $readonly = 1; + if ($parm_permission->{'edit'}) { + undef($readonly); + } &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=setoverview', text=>"Overview Mode"}); @@ -3888,6 +5443,8 @@ sub newoverview { &toggleparmtextbox_js()."\n". &validateparms_js()."\n". &ipacc_boxes_js()."\n". + &done_proctor_js()."\n". + &deeplink_js()."\n". '// ]]> '; @@ -4030,15 +5587,31 @@ ENDOVER # List data - &listdata($r,$resourcedata,$listdata,$sortorder,'newoverview'); + &listdata($r,$resourcedata,$listdata,$sortorder,'newoverview',undef,$readonly); + } + $r->print(&tableend()); + unless ($readonly) { + $r->print( ((($env{'form.store'}) || ($env{'form.dis'}))?'

':'') ); } - $r->print(&tableend(). - ((($env{'form.store'}) || ($env{'form.dis'}))?'

':''). - ''); + $r->print(''); &endSettingsScreen($r); $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}) { @@ -4074,16 +5647,26 @@ 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 ($r,$parm_permission) = @_; my $dom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $crs = $env{'course.'.$env{'request.course.id'}.'.num'}; my $crstype = $env{'course.'.$env{'request.course.id'}.'.type'}; + my $readonly = 1; + if ($parm_permission->{'edit'}) { + undef($readonly); + } my $js = ''."\n"; &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=setoverview', @@ -4100,7 +5683,9 @@ sub overview { # Store modified - &storedata($r,$crs,$dom); + unless ($readonly) { + &storedata($r,$crs,$dom); + } # Read modified data @@ -4111,14 +5696,29 @@ sub overview { unless ($sortorder) { $sortorder='realmstudent'; } &sortmenu($r,$sortorder); + my $submitbutton = ''; + + if ($readonly) { + $r->print('

'.$submitbutton.'

'); + } + # List data - my $foundkeys=&listdata($r,$resourcedata,$resourcedata,$sortorder,'overview',$classlist); - $r->print(&tableend().'

'. - ($foundkeys?'':''.&mt('There are no parameters.').'').'

'. - &Apache::loncommon::end_page()); + my $foundkeys=&listdata($r,$resourcedata,$resourcedata,$sortorder,'overview',$classlist,$readonly); + $r->print(&tableend().'

'); + if ($foundkeys) { + unless ($readonly) { + $r->print('

'.$submitbutton.'

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

'.&mt('There are no parameters.').'

'); + } + $r->print(''.&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'}; @@ -4154,51 +5754,49 @@ 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 'secgroup') { + $r->print(&mt('Group/Section: [_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().'

'. ''. @@ -4207,6 +5805,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'}; @@ -4235,6 +5837,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'}; @@ -4262,37 +5867,43 @@ 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; my ($middle,$part,$name)= - ($key=~/^$env{'request.course.id'}\.(?:(.+)\.)*([\w\s]+)\.(\w+)$/); + ($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 { + $data{'scope_type'} = 'secgroup'; + } + $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; @@ -4302,12 +5913,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)=@_; # @@ -4327,35 +5947,73 @@ ENDMAINFORMHEAD my $vgr = &Apache::lonnet::allowed('vgr',$env{'request.course.id'}); my $mgr = &Apache::lonnet::allowed('mgr',$env{'request.course.id'}); my $dcm = &Apache::lonnet::allowed('dcm',$env{'request.course.id'}); + my $vcb = &Apache::lonnet::allowed('vcb',$env{'request.course.id'}); + my $vpa = &Apache::lonnet::allowed('vpa',$env{'request.course.id'}); if ((!$dcm) && ($env{'request.course.sec'} ne '')) { $dcm = &Apache::lonnet::allowed('dcm',$env{'request.course.id'}. '/'.$env{'request.course.sec'}); } - + if ((!$vcb) && ($env{'request.course.sec'} ne '')) { + $vcb = &Apache::lonnet::allowed('vcb',$env{'request.course.id'}. + '/'.$env{'request.course.sec'}); + } + my (%linktext,%linktitle,%url); + if ($parm_permission->{'edit'}) { + %linktext = ( + newoverview => 'Edit Resource Parameters - Overview Mode', + settable => 'Edit Resource Parameters - Table Mode', + setoverview => 'Modify Resource Parameters - Overview Mode', + ); + %linktitle = ( + newoverview => 'Set/Modify resource parameters in overview mode.', + settable => 'Set/Modify resource parameters in table mode.', + setoverview => 'Set/Modify existing resource parameters in overview mode.', + ); + } else { + %linktext = ( + newoverview => 'View Resource Parameters - Overview Mode', + settable => 'View Resource Parameters - Table Mode', + setoverview => 'View Resource Parameters - Overview Mode', + ); + %linktitle = ( + newoverview => 'Display resource parameters in overview mode.', + settable => 'Display resource parameters in table mode.', + setoverview => 'Display existing resource parameters in overview mode.', + ); + } + if ($mgr) { + $linktext{'resettimes'} = 'Reset Student Access Times'; + $linktitle{'resettimes'} = "Reset access times for folders/maps, resources or the $lc_crstype."; + $url{'resettimes'} = '/adm/helper/resettimes.helper'; + } elsif ($vgr) { + $linktext{'resettimes'} = 'Display Student Access Times', + $linktitle{'resettimes'} = "Display access times for folders/maps, resources or the $lc_crstype.", + $url{'resettimes'} = '/adm/accesstimes'; + } my @menu = ( { categorytitle=>"Content Settings for this $crstype", items => [ { linktext => 'Portfolio Metadata', url => '/adm/parmset?action=setrestrictmeta', - permission => $parm_permission, + permission => $parm_permission->{'setrestrictmeta'}, linktitle => "Restrict metadata for this $lc_crstype." , icon =>'contact-new.png' , }, - { linktext => 'Reset Student Access Times', - url => '/adm/helper/resettimes.helper', - permission => $mgr, - linktitle => "Reset access times for folders/maps, resources or the $lc_crstype." , - icon => 'start-here.png' , + { linktext => $linktext{'resettimes'}, + url => $url{'resettimes'}, + permission => ($vgr || $mgr), + linktitle => $linktitle{'resettimes'}, + icon => 'start-here.png', }, { linktext => 'Blocking Communication/Resource Access', url => '/adm/setblock', - permission => $dcm, + permission => ($vcb || $dcm), linktitle => 'Configure blocking of communication/collaboration and access to resources during an exam', icon => 'comblock.png', }, { linktext => 'Set Parameter Setting Default Actions', url => '/adm/parmset?action=setdefaults', - permission => $parm_permission, + permission => $parm_permission->{'setdefaults'}, linktitle =>'Set default actions for parameters.' , icon => 'folder-new.png' , }]}, @@ -4363,37 +6021,37 @@ ENDMAINFORMHEAD items => [ { linktext => 'Edit Resource Parameters - Helper Mode', url => '/adm/helper/parameter.helper', - permission => $parm_permission, + permission => $parm_permission->{'helper'}, linktitle =>'Set/Modify resource parameters in helper mode.' , icon => 'dialog-information.png' , #help => 'Parameter_Helper', }, - { linktext => 'Edit Resource Parameters - Overview Mode', + { linktext => $linktext{'newoverview'}, url => '/adm/parmset?action=newoverview', - permission => $parm_permission, - linktitle =>'Set/Modify resource parameters in overview mode.' , - icon => 'edit-find.png' , + permission => $parm_permission->{'newoverview'}, + linktitle => $linktitle{'newoverview'}, + icon => 'edit-find.png', #help => 'Parameter_Overview', }, - { linktext => 'Edit Resource Parameters - Table Mode', + { linktext => $linktext{'settable'}, url => '/adm/parmset?action=settable', - permission => $parm_permission, - linktitle =>'Set/Modify resource parameters in table mode.' , - icon => 'edit-copy.png' , + permission => $parm_permission->{'settable'}, + linktitle => $linktitle{'settable'}, + icon => 'edit-copy.png', #help => 'Table_Mode', }]}, { categorytitle => 'Existing Parameter Settings for Resources', items => [ - { linktext => 'Modify Resource Parameters - Overview Mode', + { linktext => $linktext{'setoverview'}, url => '/adm/parmset?action=setoverview', - permission => $parm_permission, - linktitle =>'Set/Modify existing resource parameters in overview mode.' , - icon => 'preferences-desktop-wallpaper.png' , + permission => $parm_permission->{'setoverview'}, + linktitle => $linktitle{'setoverview'}, + icon => 'preferences-desktop-wallpaper.png', #help => 'Parameter_Overview', }, { linktext => 'Change Log', url => '/adm/parmset?action=parameterchangelog', - permission => $parm_permission, + permission => $parm_permission->{'parameterchangelog'}, linktitle =>"View parameter and $lc_crstype blog posting/user notification change log." , icon => 'document-properties.png', }]} @@ -4407,6 +6065,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; @@ -4428,14 +6097,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(); @@ -4448,22 +6117,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; @@ -4471,12 +6143,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'}) { @@ -4488,14 +6161,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 @@ -4510,10 +6183,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; @@ -4553,15 +6226,21 @@ sub order_meta_fields { } +# Returns HTML with a Continue button redirecting to the initial portfolio metadata screen. +# @returns {string} sub continue { my $output; $output .= '

'; $output .= ''; - $output .= ''; + $output .= ''; return ($output); } +# 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', @@ -4581,7 +6260,10 @@ sub addmetafield { my $put_result = &Apache::lonnet::put('environment', {'metadata.'.$meta_field.'.options'=>$options},$dom,$crs); - $r->print('Undeleted Metadata Field '.$env{'course.'.$env{'request.course.id'}.'.metadata.'.$meta_field.'.added'}." with result ".$put_result.'
'); + $r->print(&mt('Undeleted Metadata Field [_1] with result [_2]', + ''.$env{'course.'.$env{'request.course.id'}.'.metadata.'.$meta_field.'.added'}. + '',$put_result). + '
'); } $r->print(&continue()); } elsif (exists($env{'form.fieldname'})) { @@ -4593,29 +6275,40 @@ sub addmetafield { {'metadata.'.$meta_field.'.values'=>"", 'metadata.'.$meta_field.'.added'=>"$display_field", 'metadata.'.$meta_field.'.options'=>""},$dom,$crs); - $r->print('Added new Metadata Field '.$env{'form.fieldname'}." with result ".$put_result.'
'); + $r->print(&mt('Added new Metadata Field [_1] with result [_2]', + ''.$env{'form.fieldname'}.'',$put_result). + '
'); $r->print(&continue()); } else { my $fields = &get_deleted_meta_fieldnames($env{'request.course.id'}); if ($fields) { - $r->print('You may undelete previously deleted fields.
Check those you wish to undelete and click Undelete.
'); + $r->print(&mt('You may undelete previously deleted fields.'). + '
'. + &mt('Check those you wish to undelete and click Undelete.'). + '
'); $r->print(''); foreach my $key(keys(%$fields)) { - $r->print(''.$$fields{$key}.'
print('
print(''); + $r->print(''); $r->print('
'); } - $r->print('
Or you may enter a new metadata field name.
print('
'. + &mt('[_1]Or[_2] you may enter a new metadata field name.', + '',''). + ''); $r->print('
'); - $r->print(''); + $r->print(''); + $r->print('
'); } - $r->print(''); &endSettingsScreen($r); } +# Display or save portfolio metadata. +# +# @param {Apache2::RequestRec} $r - the Apache request sub setrestrictmeta { my ($r)=@_; my $next_meta; @@ -4632,6 +6325,11 @@ sub setrestrictmeta { &startSettingsScreen($r,'parmset',$crstype); my $key_base = $env{'course.'.$env{'request.course.id'}.'.'}; my $save_field = ''; + my %lt = &Apache::lonlocal::texthash( + addm => 'Add Metadata Field', + ordm => 'Order Metadata Fields', + save => 'Save', + ); if ($env{'form.restrictmeta'}) { foreach my $field (sort(keys(%env))) { if ($field=~m/^form.(.+)_(.+)$/) { @@ -4656,10 +6354,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); } } } @@ -4670,28 +6368,25 @@ sub setrestrictmeta { my %metadata_fields = &Apache::lonmeta::fieldnames('portfolio'); # Now get possible added metadata fields my $added_metadata_fields = &get_added_meta_fieldnames($env{'request.course.id'}); - my $row_alt = 1; $output .= &Apache::loncommon::start_data_table(); 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 = (< +
- +

- + 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); } $output .= &Apache::loncommon::end_data_table(); $r->print(< field title (not localized) sub get_added_meta_fieldnames { my ($cid) = @_; my %fields; @@ -4721,7 +6419,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; @@ -4736,6 +6437,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) = @_; @@ -4768,45 +6478,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', @@ -4819,75 +6529,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(). @@ -4898,77 +6608,119 @@ 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) +# +# @param {string} $key - parameter log key +# @param {string} $uname - user name +# @param {string} $udom - user domain +# @param {boolean} $typeflag - .type log entry +# @returns {Array} sub components { - my ($key,$uname,$udom,$exeuser,$exedomain,$typeflag)=@_; + my ($key,$uname,$udom,$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'); - if ($middle=~/^(.+)\_\_\_\(all\)$/) { - $realm=''.&mt('Folder/Map').': '.&Apache::lonnet::gettitle($1).'
('.$1.')'; - $realmdescription=&mt('folder').' '.&Apache::lonnet::gettitle($1); - } 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); + 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.')'; + $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"); + 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); $standard_parms{'int_pos'} = 'Positive Integer'; $standard_parms{'int_zero_pos'} = 'Positive Integer or Zero'; + $standard_parms{'scoreformat'} = 'Format for display of score'; } +# 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) { @@ -4980,11 +6732,32 @@ 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 ($r,$parm_permission)=@_; my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; - my $crstype = $env{'course.'.$env{'request.course.id'}.'.type'} + my $crstype = $env{'course.'.$env{'request.course.id'}.'.type'}; &Apache::lonhtmlcommon::add_breadcrumb({href=>'/adm/parmset?action=settable', text=>"Parameter Change Log"}); my $js = '