Return to newslot.helper CVS log

Up to [LON-CAPA] / loncom / html / adm / helper

- making use of the new <skip> mechanism

<helper title="Slot Creation" requiredpriv="mgq">
  <state name="START" title="Specify Required Attributes">

    <nextstate>OPTIONAL</nextstate>

    <exec>
      if (!exists($helper->{'VARS'}{'name'}) ||
	  $helper->{'VARS'}{'name'} !~ /\S/) {
	  &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
	  if (exists($env{'form.name'}) ||
	      $env{'form.name'} =~ /\S/) {
	      $helper->{'VARS'}{'name'}=$env{'form.name'};
	      $helper->{VARS}{'origname'}=$env{'form.name'};
	      $helper->{DATA}{copy} = 1;
	  }
      }
      $helper->{DATA}{origslot} = sub {
	  my ($which,$default)=@_;
	  if (!exists($helper->{'VARS'}{'name'}) ||
	      $helper->{'VARS'}{'name'} !~ /\S/) {
	      return $default;
	  }
	  my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
	  my $cdom  = $env{'course.'.$env{'request.course.id'}.'.domain'};
	  my $name=$helper->{VARS}{'origname'};
	  my %slot=&Apache::lonnet::get('slots', [$name], $cdom, $cnum);
	  if (!ref($slot{$name})) { return $default; }
	  if (!exists($slot{$name}{$which})) { return $default; }
	  return $slot{$name}{$which};
      }
    </exec>
    <message>
        Name: <br />&nbsp;&nbsp;&nbsp;
    </message>
    <string variable="name" size="30">
      <validator>
          if ($val=~/^\s*$/) { return 'Must specify a name'; }
          if ($val=~/\s/) { return 'Must not contain spaces'; }
          if ($val=~/\W/) { return 'Must contain only letters, numbers and _'; }
          return undef;
      </validator>
      <defaultvalue>
        return $helper->{'VARS'}{'name'};
      </defaultvalue>
    </string>
    <condition>
      <clause>$helper->{DATA}{copy}</clause>
      <message>
	<p>Changing the Name will create a new slot with the new name, and not rename the existing slot.</p>
      </message>
    </condition>
    <message>
      <br />Start time:<br />&nbsp;&nbsp;&nbsp;
    </message>
    <date variable="starttime" hoursminutes="1">
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('starttime');
      </defaultvalue>
    </date>
    <message>
      <br />End time:<br />&nbsp;&nbsp;&nbsp;
    </message>
    <date variable="endtime" hoursminutes="1">
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('endtime');
      </defaultvalue>
      <validator>
         if ($val < $helper->{'VARS'}{'starttime'}) {
	     return 'End time must be later than the start time.';
         }
	 return undef;
      </validator>
    </date>
    <message>
      <br />Type:
    </message>
    <choices variable="type">
      <choice computer='preassigned'>Instructor asssignable.</choice>
      <choice computer='schedulable_student'>Student selectable.</choice>
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('type','preassigned');
      </defaultvalue>
    </choices>
  </state>


  <state name="OPTIONAL" title="Specify Optional Attributes">
    <message>
        <p>Description:<br />&nbsp;&nbsp;&nbsp;
    </message>
    <string variable="description" size="60">
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('description');
      </defaultvalue>
    </string>
    <condition>
      <clause>$helper->{'VARS'}{'type'} eq 'schedulable_student'</clause>
      <message>
        </p><p>Time students can start reserving:<br />&nbsp;&nbsp;&nbsp;
      </message>
      <date variable="startreserve" hoursminutes="1" anytime="1">
        <defaultvalue>
          return &{$helper->{DATA}{origslot}}('startreserve','anytime');
        </defaultvalue>
        <validator>
           if (defined($val) && $val > $helper->{'VARS'}{'starttime'}) {
	       return 'Reservation time must come before the slot has started.';
           }
	   return undef;
        </validator>
      </date>
      <message>
         </p><p>Maxium number of students allowed in this slot:<br />&nbsp;&nbsp;&nbsp;
      </message>
      <string variable="maxspace" size="4">
        <validator>
            if ($val ne '' && $val=~/\D/) { return 'Must be numeric.'; }
            return undef;
        </validator>
        <defaultvalue>
          return &{$helper->{DATA}{origslot}}('maxspace');
        </defaultvalue>
      </string>
      <message>
         </p><p>Period of time in which this slot is can only be uniquely chosen:<br />&nbsp;&nbsp;&nbsp;Start:
      </message>
      <date variable="startunique" hoursminutes="1" anytime="1">
        <defaultvalue>
          my $default=&{$helper->{DATA}{origslot}}('uniqueperiod','anytime');
          if ($default eq 'anytime') { return 'anytime' };
          if (ref($default)) { return $default->[0]; }
          return 'anytime';
        </defaultvalue>
      </date>
      <message><br />&nbsp;&nbsp;&nbsp;End: </message>
      <date variable="endunique" hoursminutes="1" anytime="1">
        <defaultvalue>
          my $default=&{$helper->{DATA}{origslot}}('uniqueperiod','anytime');
          if ($default eq 'anytime') { return 'anytime' };
          if (ref($default)) { return $default->[1]; }
          return 'anytime';
        </defaultvalue>
        <validator>
           if (defined($val) && $val < $helper->{'VARS'}{'startunique'}) {
	       return 'End time must be later than the start time.';
           }
	   return undef;
        </validator>
      </date>
    </condition>
    <condition>
      <clause>$helper->{'VARS'}{'type'} eq 'preassigned'</clause>
      <exec>
        delete($helper->{'VARS'}{'startreserve'});
        delete($helper->{'VARS'}{'maxspace'});
        delete($helper->{'VARS'}{'startunique'});
        delete($helper->{'VARS'}{'endunique'});
      </exec>
    </condition>

    <message>
      </p><p>Proctored access:
    </message>
    <choices variable="useproctor">
      <choice computer='no'>No proctor checkin required for access.</choice>
      <choice computer='yes'>Require proctored checkin for access.</choice>
      <defaultvalue>
        my $default=&{$helper->{DATA}{origslot}}('proctor');
        if ($default) { return 'yes'; }
        return 'no';
      </defaultvalue>
    </choices>

    <message>
      </p><p>Secret word proctors use to checkin users:<br />&nbsp;&nbsp;&nbsp;
    </message>
    <string variable="secret" size="12">
      <validator>
          return undef;
      </validator>
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('secret');
      </defaultvalue>
    </string>
    <message>
      </p><p>Slot is:
    </message>
    <choices variable="restricttosymb">
      <choice nextstate="PROCTOR" computer='any'>usable for any resource.</choice>
      <choice nextstate="RESOURCESELECT" computer='resource'>restricted to a specific resource.</choice>
      <defaultvalue>
        my $default=&{$helper->{DATA}{origslot}}('symb');
        if ($default) { return 'resource'; }
        return 'any';
      </defaultvalue>
    </choices>
    <message>
	</p><p>IP restrictions:<br />&nbsp;&nbsp;&nbsp;      
    </message>
    <string variable="ip" size="30">
      <validator>
          return undef;
      </validator>
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('ip');
      </defaultvalue>
    </string>
    <message>  </p>  </message>
  </state>


  <state name="RESOURCESELECT" title="Specify Optional Attributes">

    <nextstate>PROCTOR</nextstate>

    <resource variable="symb">
      <filterfunc>return $res->is_problem()</filterfunc>
      <valuefunc>return $res->symb()</valuefunc>
      <defaultvalue>
        return &{$helper->{DATA}{origslot}}('symb');
      </defaultvalue>
    </resource>    
  </state>


  <state name="PROCTOR" title="Specify Proctors">

    <skip>
      <clause>$helper->{'VARS'}{'useproctor'} eq 'no'</clause>
      <nextstate>RESTRICTUSER</nextstate>
    </skip>

    <nextstate>RESTRICTUSER</nextstate>

    <student variable="proctor" multichoice="1" coursepersonnel="1"
             activeonly="1" emptyallowed="1">
      <defaultvalue>
        my @defaults;
        my $default=&{$helper->{DATA}{origslot}}('proctor');
        if ($default) {
	    @defaults=(split(',',$default)); 
	}
        return @defaults;
      </defaultvalue>
    </student>
  </state>


  <state name="RESTRICTUSER" title="Restrict slot availability">
    <skip>
       <clause>$helper->{'VARS'}{'type'} ne 'schedulable_student'</clause>
       <nextstate>FINISH</nextstate>
    </skip>

    <nextstate>FINISH</nextstate>
    <message>
      <p>Slots are by default available to all users in a course, if you would like this slot to be restricted to a subset of users you can specify restrictions.</p>
    </message>

    <message>
      Select sections to limit slot availability to: <br />&nbsp;&nbsp;&nbsp;
    </message>
    <section variable="allowedsections" multichoice="1" allowempty="1">
      <defaultvalue>
        return join('|||',
		    split(',',&{$helper->{DATA}{origslot}}('allowedsections')));
      </defaultvalue>
    </section>
    <message>
      Select users to limit slot availability to: <br />&nbsp;&nbsp;&nbsp;
    </message>
    <student variable="allowedusers" multichoice="1" coursepersonnel="1"
             activeonly="1" emptyallowed="1">
      <defaultvalue>
	 return split(',',&{$helper->{DATA}{origslot}}('allowedusers'));
      </defaultvalue>
    </student>
  </state>


  <state name="FINISH" title="Creating/Modfying Slot">
	    <message> Created Slot  </message>	
    <final>
      <finalcode>
        my $result;
	if ($helper->{'STATE'} ne 'FINISH') { return; }
	my %slot;

	foreach my $which ('type','starttime','endtime') {
	    $slot{$which} = $helper->{'VARS'}{$which};
	}

	foreach my $which ('ip','description','maxspace','secret','symb') {
	    if ( $helper->{'VARS'}{$which} =~/\S/ ) {
		$slot{$which} = $helper->{'VARS'}{$which};
	    }
	}

	if ( $helper->{'VARS'}{'startreserve'} > 0) {
		$slot{'startreserve'} = $helper->{'VARS'}{'startreserve'};
	}

	if ( $helper->{'VARS'}{'startunique'} > 0 &&
	     $helper->{'VARS'}{'endunique'} > 0 ) {
	    $slot{'uniqueperiod'} = [$helper->{'VARS'}{'startunique'},
				     $helper->{'VARS'}{'endunique'}];
	}

        if ( $helper->{'VARS'}{'useproctor'} eq 'yes'
	     && $helper->{'VARS'}{'proctor'} =~/\S/ ) {
	    my @names;
	    # just need the username/domain throw away the other data 
            # that <student> returns
	    foreach my $user (split(/\|\|\|/, $helper->{'VARS'}{'proctor'})) {
		my ($uname,$udomain)=split(/:/,$user);
		push(@names,"$uname:$udomain");
	    }
	    # make sure the usernmaes are unique
	    my %proctors = map { ($_,1) } @names;
	    $slot{'proctor'}=join(',',sort(keys(%proctors)));
	}

        if ( $helper->{'VARS'}{'allowedsections'} =~/\S/ ) {
	    $slot{'allowedsections'}=
		join(',',sort(split(/\|\|\|/,
				    $helper->{'VARS'}{'allowedsections'})));
	}

        if ( $helper->{'VARS'}{'allowedusers'} =~/\S/ ) {
	    my @names;
	    # just need the username/domain throw away the other data 
            # that <student> returns
	    foreach my $item (split(/\|\|\|/,
				    $helper->{'VARS'}{'allowedusers'})) {
		my ($uname,$udomain)=split(/:/,$item);
		push(@names,"$uname:$udomain");
	    }

	    # make sure the choices are unique
	    my %users = map { ($_,1) } @names;
	    $slot{'allowedusers'}=join(',',sort(keys(%users)));
	}

        my $cname = $env{'course.'.$env{'request.course.id'}.'.num'};
        my $cdom  = $env{'course.'.$env{'request.course.id'}.'.domain'};

        my $ret = &Apache::lonnet::cput('slots',
					{$helper->{'VARS'}{'name'} => \%slot},
					$cdom,$cname);
        $result.="\n ".'Name: '.&HTML::Entities::encode($helper->{'VARS'}{'name'}).'</li>'.
    "\n".'<li> Starts: '.&Apache::lonlocal::locallocaltime($slot{'starttime'}).'</li>'.
                 "\n".'<li> Ends: '.&Apache::lonlocal::locallocaltime($slot{'endtime'}).'</li>'.
                 "\n".'<li> Type: '.$slot{'type'}.'</li>';
        my %labels =
             map {($_->[0],$_->[1])} &Apache::slotrequest::csvupload_fields();
        foreach my $which ('ip','description','maxspace','secret','symb',
			   'allowedsections','allowedusers') {
	    if (exists($slot{$which})) {
		$result.="\n".'<li> '.$labels{$which}.': '.
		    &HTML::Entities::encode($slot{$which}).'</li>';
	    }
	}
	if (exists($slot{'startreserve'})) {
	    $result.="\n".'<li> '.$labels{'startreserve'}.': '.
		    &Apache::lonlocal::locallocaltime($slot{'startreserve'}).'</li>';
	}
        if (exists($slot{'proctor'})) {
	    my $proctors = $slot{'proctor'};
	    $proctors =~ s/,/, /g;
	    $result.="\n".'<li> '.$labels{'proctor'}.': '.
		&HTML::Entities::encode($proctors).'</li>';
	}
        if (exists($slot{'uniqueperiod'})) {
	    $result.=
                 "\n".'<li> '.$labels{'uniqueperiod'}.': '.
		 &Apache::lonlocal::locallocaltime($slot{'uniqueperiod'}[0]).
		 ', '.
		 &Apache::lonlocal::locallocaltime($slot{'uniqueperiod'}[1]).
		 '</li>';
	}
        return $result;
      </finalcode>
      <exitpage>/adm/slotrequest?command=showslots</exitpage>
    </final>
  </state>
</helper>