[BACK]Return to lonparmset.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonparmset.pm between versions 1.57 and 1.65

version 1.57, 2002/08/08 17:03:20 version 1.65, 2002/08/28 19:48:57
Line 25 Line 25
 #  #
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # (Handler to resolve ambiguous file locations  ###################################################################
 #  ###################################################################
 # (TeX Content Handler  
 #  =pod
 # YEAR=2000  
 # 05/29/00,05/30,10/11 Gerd Kortemeyer)  =head1 NAME
 #  
 # 10/11,10/12,10/16 Gerd Kortemeyer)  lonparmset - Handler to set parameters for assessments and course
 #  
 # 11/20,11/21,11/22,11/23,11/24,11/25,11/27,11/28,  =head1 SYNOPSIS
 # 12/08,12/12,  
 # YEAR=2001  lonparmset provides an interface to setting course parameters. 
 # 16/01/01,02/08,03/20,03/23,03/24,03/26,05/09,  
 # 07/05,07/06,08/08,08/09,09/01,09/21 Gerd Kortemeyer  =head1 DESCRIPTION
 # 12/17 Scott Harrison  
 # 12/19 Guy Albertelli  This module sets coursewide and assessment parameters.
 # 12/26,12/27 Gerd Kortemeyer  
 #  =head1 INTERNAL SUBROUTINES
 # YEAR=2002  
 # 7/19 Jeremy Bowers  =over 4
 ###  
   =cut
   
   ###################################################################
   ###################################################################
   
 package Apache::lonparmset;  package Apache::lonparmset;
   
Line 74  my $uhome; Line 78  my $uhome;
 my $csec;  my $csec;
 my $coursename;  my $coursename;
   
 # -------------------------------------------- Figure out a cascading parameter  ##################################################
   ##################################################
   
   =pod
   
   =item parmval
   
   Figure out a cascading parameter.
   
   Inputs:  $what $id $def
   
   Returns: I am not entirely sure.
   
   =cut
   
   ##################################################
   ##################################################
 sub parmval {  sub parmval {
     my ($what,$id,$def)=@_;      my ($what,$id,$def)=@_;
     my $result='';      my $result='';
Line 157  sub parmval { Line 176  sub parmval {
     return ($result,@outpar);      return ($result,@outpar);
 }  }
   
 # ------------------------------------------------------------ Output for value  ##################################################
   ##################################################
   
   =pod
   
   =item valout
   
   Format a value for output.
   
   Inputs:  $value, $type
   
   Returns: $value, formatted for output.  If $type indicates it is a date,
   localtime($value) is returned.
   
   =cut
   
   ##################################################
   ##################################################
 sub valout {  sub valout {
     my ($value,$type)=@_;      my ($value,$type)=@_;
     return ($value?(($type=~/^date/)?localtime($value):$value):'  ');      my $result = '';
       # Values of zero are valid.
       if (! $value && $value ne '0') {
           $result = '  ';
       } else {
           if ($type=~/^date/) {
               $result = localtime($value);
           } else {
               $result = $value;
           }
       }
       return $result;
 }  }
   
 # -------------------------------------------------------- Produces link anchor  ##################################################
   ##################################################
   
   =pod
   
   =item plink
   
   Produces a link anchor.
   
   Inputs: $type,$dis,$value,$marker,$return,$call
   
   Returns: scalar with html code for a link which will envoke the 
   javascript function 'pjump'.
   
   =cut
   
   ##################################################
   ##################################################
 sub plink {  sub plink {
     my ($type,$dis,$value,$marker,$return,$call)=@_;      my ($type,$dis,$value,$marker,$return,$call)=@_;
     my $winvalue=$value;      my $winvalue=$value;
Line 187  sub startpage { Line 249  sub startpage {
     my ($r,$id,$udom,$csec,$uname)=@_;      my ($r,$id,$udom,$csec,$uname)=@_;
     $r->content_type('text/html');      $r->content_type('text/html');
     $r->send_http_header;      $r->send_http_header;
    
       my $bodytag=&Apache::loncommon::bodytag('Set Course Parameters','',
                                               'onUnload="pclose()"');
     $r->print(<<ENDHEAD);      $r->print(<<ENDHEAD);
 <html>  <html>
 <head>  <head>
Line 241  sub startpage { Line 306  sub startpage {
     }      }
 </script>  </script>
 </head>  </head>
 <body bgcolor="#FFFFFF" onUnload="pclose()">  $bodytag
 <h1>Set Course Parameters for Course:  
 $ENV{'course.'.$ENV{'request.course.id'}.'.description'}</h1>  
 <form method="post" action="/adm/parmset" name="envform">  <form method="post" action="/adm/parmset" name="envform">
 <h3>Course Environment</h3>  <h3>Course Environment</h3>
 <input type="submit" name="crsenv" value="Set Course Environment">  <input type="submit" name="crsenv" value="Set Course Environment">
Line 341  sub print_row { Line 404  sub print_row {
     } # end of $parmlev if/else      } # end of $parmlev if/else
   
     if ($parmlev eq 'full' || $parmlev eq 'brief') {      if ($parmlev eq 'full' || $parmlev eq 'brief') {
     $r->print('<td bgcolor=#CCCCFF align="center">'.          $r->print('<td bgcolor=#CCCCFF align="center">'.
         &valout($outpar[$result],$$type{$which}).'</td>');                    &valout($outpar[$result],$$type{$which}).'</td>');
       }
 }  
     my $sessionval=&Apache::lonnet::EXT('resource.'.$$part{$which}.      my $sessionval=&Apache::lonnet::EXT('resource.'.$$part{$which}.
                                         '.'.$$name{$which},$symbp{$rid});                                          '.'.$$name{$which},$symbp{$rid});
     $r->print('<td bgcolor=#999999 align="center"><font color=#FFFFFF>'.      $r->print('<td bgcolor=#999999 align="center"><font color=#FFFFFF>'.
Line 353  sub print_row { Line 415  sub print_row {
     $r->print('</tr>');      $r->print('</tr>');
     $r->print("\n");      $r->print("\n");
 }  }
   
 sub print_td {  sub print_td {
     my ($r,$which,$defbg,$result,$outpar,$mprefix,$value,$type,$display)=@_;      my ($r,$which,$defbg,$result,$outpar,$mprefix,$value,$type,$display)=@_;
     $r->print('<td bgcolor='.(($result==$which)?'"#AAFFAA"':$defbg).      $r->print('<td bgcolor='.(($result==$which)?'"#AAFFAA"':$defbg).
Line 375  sub get_env_multiple { Line 438  sub get_env_multiple {
     return(@values);      return(@values);
 }  }
   
   =pod
   
   =item B<extractResourceInformation>: Given the course data hash, extractResourceInformation extracts lots of information about the course's resources into a variety of hashes.
   
   Input: See list below:
   
   =over 4
   
   =item B<ids>: An array that will contain all of the ids in the course.
   
   =item B<typep>: hash, id->type, where "type" contains the extension of the file, thus, I<problem exam quiz assess survey form>.
   
   =item B<keyp>: hash, id->key list, will contain a comma seperated list of the meta-data keys available for the given id
   
   =item B<allparms>: hash, name of parameter->display value (what is the display value?)
   
   =item B<allparts>: hash, part identification->text representation of part, where the text representation is "[Part $part]"
   
   =item B<allkeys>: hash, full key to part->display value (what's display value?)
   
   =item B<allmaps>: hash, ???
   
   =item B<fcat>: ???
   
   =item B<defp>: hash, ???
   
   =item B<mapp>: ??
   
   =item B<symbp>: hash, id->full sym?
   
   =back
   
   =cut
   
   sub extractResourceInformation {
       my $bighash = shift;
       my $ids = shift;
       my $typep = shift;
       my $keyp = shift;
       my $allparms = shift;
       my $allparts = shift;
       my $allkeys = shift;
       my $allmaps = shift;
       my $fcat = shift;
       my $defp = shift;
       my $mapp = shift;
       my $symbp = shift;
   
       foreach (keys %$bighash) {
    if ($_=~/^src\_(\d+)\.(\d+)$/) {
       my $mapid=$1;
       my $resid=$2;
       my $id=$mapid.'.'.$resid;
       my $srcf=$$bighash{$_};
       if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) {
    $$ids[$#$ids+1]=$id;
    $$typep{$id}=$1;
    $$keyp{$id}='';
    foreach (split(/\,/,&Apache::lonnet::metadata($srcf,'allpossiblekeys'))) {
     if ($_=~/^parameter\_(.*)/) {
                       my $key=$_;
                       my $allkey=$1;
                       $allkey=~s/\_/\./g;
                       my $display= &Apache::lonnet::metadata($srcf,$key.'.display');
                       my $name=&Apache::lonnet::metadata($srcf,$key.'.name');
                       my $part= &Apache::lonnet::metadata($srcf,$key.'.part');
                       my $parmdis = $display;
                       $parmdis =~ s|(\[Part.*$)||g;
                       my $partkey = $part;
                       $partkey =~ tr|_|.|;
                       $$allparms{$name} = $parmdis;
                       $$allparts{$part} = "[Part $part]";
                       $$allkeys{$allkey}=$display;
                       if ($allkey eq $fcat) {
           $$defp{$id}= &Apache::lonnet::metadata($srcf,$key);
       }
       if ($$keyp{$id}) {
           $$keyp{$id}.=','.$key;
       } else {
           $$keyp{$id}=$key;
       }
     }
    }
    $$mapp{$id}=
       &Apache::lonnet::declutter($$bighash{'map_id_'.$mapid});
                   $$mapp{$mapid}=$$mapp{$id};
    $$allmaps{$mapid}=$$mapp{$id};
    $$symbp{$id}=$$mapp{$id}.
    '___'.$resid.'___'.
       &Apache::lonnet::declutter($srcf);
                   $$symbp{$mapid}=$$mapp{$id}.'___(all)';
       }
    }
       }
   }
   
   ##################################################
   ##################################################
   
   =pod
   
   =item assessparms
   
   Show assessment data and parameters.  This is a large routine that should
   be simplified and shortened... someday.
   
   Inputs: $r
   
   Returns: nothing
   
   Variables used (guessed by Jeremy):
   
   =over 4
   
   =item B<pscat>: ParameterS CATegories? ends up a list of the types of parameters that exist, e.g., tol, weight, acc, opendate, duedate, answerdate, sig, maxtries, type.
   
   =item B<psprt>: ParameterS PaRTs? a list of the parts of a problem that we are displaying? Used to display only selected parts?
   
   =item B<allmaps>:
   
   =back
   
   =cut
   
   ##################################################
   ##################################################
 sub assessparms {  sub assessparms {
   
     my $r=shift;      my $r=shift;
Line 491  sub assessparms { Line 680  sub assessparms {
   
 # ------------------------------------------------------------------- Tie hashs  # ------------------------------------------------------------------- Tie hashs
     if (!(tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',      if (!(tie(%bighash,'GDBM_File',$ENV{'request.course.fn'}.'.db',
       &GDBM_READER,0640))) {        &GDBM_READER(),0640))) {
  $r->print("Unable to access course data. (File $ENV{'request.course.fn'}.db not tieable)");   $r->print("Unable to access course data. (File $ENV{'request.course.fn'}.db not tieable)");
  return ;   return ;
     }      }
     if (!(tie(%parmhash,'GDBM_File',      if (!(tie(%parmhash,'GDBM_File',
       $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER,0640))) {        $ENV{'request.course.fn'}.'_parms.db',&GDBM_READER(),0640))) {
  $r->print("Unable to access parameter data. (File $ENV{'request.course.fn'}_parms.db not tieable)");   $r->print("Unable to access parameter data. (File $ENV{'request.course.fn'}_parms.db not tieable)");
  return ;   return ;
     }      }
   
 # --------------------------------------------------------- Get all assessments  # --------------------------------------------------------- Get all assessments
     foreach (keys %bighash) {      extractResourceInformation(\%bighash, \@ids, \%typep,\%keyp, \%allparms, \%allparts, \%allkeys, \%allmaps, $fcat, \%defp, \%mapp, \%symbp);
  if ($_=~/^src\_(\d+)\.(\d+)$/) {  
     my $mapid=$1;  
     my $resid=$2;  
     my $id=$mapid.'.'.$resid;  
     my $srcf=$bighash{$_};  
     if ($srcf=~/\.(problem|exam|quiz|assess|survey|form)$/) {  
  $ids[$#ids+1]=$id;  
  $typep{$id}=$1;  
  $keyp{$id}='';  
  foreach (split(/\,/,&Apache::lonnet::metadata($srcf,'keys'))) {  
   if ($_=~/^parameter\_(.*)/) {  
                     my $key=$_;  
                     my $allkey=$1;  
                     $allkey=~s/\_/\./g;  
                     my $display= &Apache::lonnet::metadata($srcf,$key.'.display');  
                     my $name=&Apache::lonnet::metadata($srcf,$key.'.name');  
                     my $part= &Apache::lonnet::metadata($srcf,$key.'.part');  
                     my $parmdis = $display;  
                     $parmdis =~ s|(\[Part.*$)||g;  
                     my $partkey = $part;  
                     $partkey =~ tr|_|.|;  
                     $allparms{$name} = $parmdis;  
                     $allparts{$part} = "[Part $part]";  
                     $allkeys{$allkey}=$display;  
                     if ($allkey eq $fcat) {  
         $defp{$id}= &Apache::lonnet::metadata($srcf,$key);  
     }  
     if ($keyp{$id}) {  
         $keyp{$id}.=','.$key;  
     } else {  
         $keyp{$id}=$key;  
     }  
   }  
  }  
  $mapp{$id}=  
     &Apache::lonnet::declutter($bighash{'map_id_'.$mapid});  
                 $mapp{$mapid}=$mapp{$id};  
  $allmaps{$mapid}=$mapp{$id};  
  $symbp{$id}=$mapp{$id}.  
  '___'.$resid.'___'.  
     &Apache::lonnet::declutter($srcf);  
                 $symbp{$mapid}=$mapp{$id}.'___(all)';  
     }  
  }  
     }  
     $mapp{'0.0'} = '';      $mapp{'0.0'} = '';
     $symbp{'0.0'} = '';      $symbp{'0.0'} = '';
 # ---------------------------------------------------------- Anything to store?  # ---------------------------------------------------------- Anything to store?
Line 645  sub assessparms { Line 791  sub assessparms {
     if ($pscat[0] eq "all" || !@pscat) {@pscat = (keys %allparms);}      if ($pscat[0] eq "all" || !@pscat) {@pscat = (keys %allparms);}
     if ($psprt[0] eq "all" || !@psprt) {@psprt = (keys %allparts);}      if ($psprt[0] eq "all" || !@psprt) {@psprt = (keys %allparts);}
 # ------------------------------------------------------------------ Start page  # ------------------------------------------------------------------ Start page
   
     &startpage($r,$id,$udom,$csec,$uname);      &startpage($r,$id,$udom,$csec,$uname);
 #    if ($ENV{'form.url'}) {  #    if ($ENV{'form.url'}) {
 # $r->print('<input type="hidden" value="'.$ENV{'form.url'}.  # $r->print('<input type="hidden" value="'.$ENV{'form.url'}.
Line 790  sub assessparms { Line 937  sub assessparms {
     $r->print('</table>');      $r->print('</table>');
   
     my @temp_psprt;      my @temp_psprt;
     map {      foreach my $t (@psprt) {
          my $t = $_;   push(@temp_psprt, grep {eval (/^$t\./ || ($_ == $t))} (keys %allparts));
          push(@temp_psprt,      }
          grep {eval (/^$t\./ || ($_ == $t))} (keys %allparts));  
     } @psprt;  
   
     @psprt = @temp_psprt;      @psprt = @temp_psprt;
   
Line 954  ENDTABLEHEADFOUR Line 1099  ENDTABLEHEADFOUR
   
 #-------------------------------------------- for each map, gather information  #-------------------------------------------- for each map, gather information
             my $mapid;              my $mapid;
             foreach $mapid (keys %maplist) {      foreach $mapid (sort {$maplist{$a} cmp $maplist{$b}} keys %maplist) {
                 my $maptitle = $allmaps{$mapid};                  my $maptitle = $maplist{$mapid};
   
 #-----------------------  loop through ids and get all parameter types for map  #-----------------------  loop through ids and get all parameter types for map
 #-----------------------------------------          and associated information  #-----------------------------------------          and associated information
Line 1121  ENDMAPONE Line 1266  ENDMAPONE
     untie(%parmhash);      untie(%parmhash);
 } # end sub assessparms  } # end sub assessparms
   
 # ------------------------------------------- Set course environment parameters  
   ##################################################
   ##################################################
   
   =pod
   
   =item crsenv
   
   Show course data and parameters.  This is a large routine that should
   be simplified and shortened... someday.
   
   Inputs: $r
   
   Returns: nothing
   
   =cut
   
   ##################################################
   ##################################################
 sub crsenv {  sub crsenv {
     my $r=shift;      my $r=shift;
     my $setoutput='';      my $setoutput='';
       my $bodytag=&Apache::loncommon::bodytag(
                                'Set Course Environment Parameters');
     my $dom = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};      my $dom = $ENV{'course.'.$ENV{'request.course.id'}.'.domain'};
     my $crs = $ENV{'course.'.$ENV{'request.course.id'}.'.num'};      my $crs = $ENV{'course.'.$ENV{'request.course.id'}.'.num'};
 # -------------------------------------------------- Go through list of changes  # -------------------------------------------------- Go through list of changes
Line 1137  sub crsenv { Line 1302  sub crsenv {
             }              }
             if ($name eq 'url') {              if ($name eq 'url') {
  $value=~s/^\/res\///;   $value=~s/^\/res\///;
                   my $bkuptime=time;
                 my @tmp = &Apache::lonnet::get                  my @tmp = &Apache::lonnet::get
                     ('environment',['url'],$dom,$crs);                      ('environment',['url'],$dom,$crs);
                 $setoutput.='Backing up previous URL: '.                  $setoutput.='Backing up previous URL: '.
                     &Apache::lonnet::put                      &Apache::lonnet::put
                         ('environment',                          ('environment',
                          {'top level map backup ' => $tmp[1] },                           {'top level map backup '.$bkuptime => $tmp[1] },
                          $dom,$crs).                           $dom,$crs).
                     '<br>';                      '<br>';
             }              }
Line 1186  sub crsenv { Line 1352  sub crsenv {
              'pageseparators'  => '<b>Visibly Separate Items on Pages</b><br>'.               'pageseparators'  => '<b>Visibly Separate Items on Pages</b><br>'.
                                  '("<tt>yes</tt>" for visible separation)',                                   '("<tt>yes</tt>" for visible separation)',
              'pch.roles.denied'=> '<b>Disallow Resource Discussion for '.               'pch.roles.denied'=> '<b>Disallow Resource Discussion for '.
                                   'Roles</b> ' .                                     'Roles</b><br>"<tt>st</tt>": '.
    Apache::loncommon::help_open_topic("Course_Disable_Discussion")                                    'student, "<tt>ta</tt>": '.
                           ,                                    'TA, "<tt>in</tt>": '.
                                     'instructor;<br><tt>role,role,...</tt>) '.
          Apache::loncommon::help_open_topic("Course_Disable_Discussion"),
              'pch.users.denied' =>                'pch.users.denied' => 
                           '<b>Disallow Resource Discussion for Users</b><br>'.                            '<b>Disallow Resource Discussion for Users</b><br>'.
                                  '(<tt>user:domain,user:domain,...</tt>)',                                   '(<tt>user:domain,user:domain,...</tt>)',
Line 1263  sub crsenv { Line 1431  sub crsenv {
 <head>  <head>
 <title>LON-CAPA Course Environment</title>  <title>LON-CAPA Course Environment</title>
 </head>  </head>
 <body bgcolor="#FFFFFF">  $bodytag
 <h1>Set Course Parameters</h1>  
 <form method="post" action="/adm/parmset" name="envform">  <form method="post" action="/adm/parmset" name="envform">
 <h2>Course: $ENV{'course.'.$ENV{'request.course.id'}.'.description'}</h2>  
 <h3>Course Environment</h3>  
 $setoutput  $setoutput
 <p>  <p>
 <table border=2>  <table border=2>
Line 1281  $output Line 1446  $output
 ENDENV  ENDENV
 }  }
   
 # ================================================================ Main Handler  ##################################################
   ##################################################
   
   =pod
   
   =item handler
   
   Main handler.  Calls &assessparms and &crsenv subroutines.
   
   =cut
   
   ##################################################
   ##################################################
 sub handler {  sub handler {
     my $r=shift;      my $r=shift;
   
Line 1318  sub handler { Line 1494  sub handler {
 1;  1;
 __END__  __END__
   
   =pod
 =head1 NAME  
   
 Apache::lonparmset - Handler to set parameters for assessments  
   
 =head1 SYNOPSIS  
   
 Invoked by /etc/httpd/conf/srm.conf:  
   
  <Location /adm/parmset>  
  PerlAccessHandler       Apache::lonacc  
  SetHandler perl-script  
  PerlHandler Apache::lonparmset  
  ErrorDocument     403 /adm/login  
  ErrorDocument     406 /adm/roles  
  ErrorDocument  500 /adm/errorhandler  
  </Location>  
   
 =head1 INTRODUCTION  
   
 This module sets assessment parameters.  
   
 This is part of the LearningOnline Network with CAPA project  
 described at http://www.lon-capa.org.  
   
 =head1 HANDLER SUBROUTINE  
   
 This routine is called by Apache and mod_perl.  
   
 =over 4  
   
 =item *  
   
 need to be in course  
   
 =item *  
   
 bring up assessment screen or course environment  
   
 =back  
   
 =head1 OTHER SUBROUTINES  
   
 =over 4  
   
 =item *  
   
 parmval() : figure out a cascading parameter  
   
 =item *  
   
 valout() : format a value for output  
   
 =item *  
   
 plink() : produces link anchor  
   
 =item *  
   
 assessparms() : show assess data and parameters  
   
 =item *  
   
 crsenv() : for the course environment  
   
 =back  =back
   
Removed from v.1.57  
changed lines
  Added in v.1.65

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>