Annotation of loncom/html/adm/helper/newslot.helper, revision 1.30.6.1
1.1 albertel 1: <helper title="Slot Creation" requiredpriv="mgq">
1.22 albertel 2: <state name="START" title="Specify Required Attributes"
3: help="Slot_RequiredAttributes">
1.13 albertel 4:
5: <nextstate>OPTIONAL</nextstate>
6:
1.5 albertel 7: <exec>
8: if (!exists($helper->{'VARS'}{'name'}) ||
9: $helper->{'VARS'}{'name'} !~ /\S/) {
10: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
11: if (exists($env{'form.name'}) ||
12: $env{'form.name'} =~ /\S/) {
13: $helper->{'VARS'}{'name'}=$env{'form.name'};
1.10 albertel 14: $helper->{VARS}{'origname'}=$env{'form.name'};
15: $helper->{DATA}{copy} = 1;
1.5 albertel 16: }
17: }
18: $helper->{DATA}{origslot} = sub {
19: my ($which,$default)=@_;
20: if (!exists($helper->{'VARS'}{'name'}) ||
21: $helper->{'VARS'}{'name'} !~ /\S/) {
22: return $default;
23: }
24: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
25: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
1.10 albertel 26: my $name=$helper->{VARS}{'origname'};
1.5 albertel 27: my %slot=&Apache::lonnet::get('slots', [$name], $cdom, $cnum);
28: if (!ref($slot{$name})) { return $default; }
1.30.6.1! raeburn 29: if (($which eq 'ipdeny') || ($which eq 'ipallow')) {
! 30: if (!exists($slot{$name}{'ip'})) { return $default; }
! 31: } else {
! 32: if (!exists($slot{$name}{$which})) { return $default; }
! 33: }
! 34: if (($which eq 'ipdeny') || ($which eq 'ipallow')) {
! 35: my @allows;
! 36: my @denies;
! 37: foreach my $item (split(',',$slot{$name}{'ip'})) {
! 38: $item =~ s/^\s*//;
! 39: $item =~ s/\s*$//;
! 40: if ($item =~ /^\!(.+)$/) {
! 41: push(@denies,$1);
! 42: } else {
! 43: push(@allows,$item);
! 44: }
! 45: }
! 46: if ($which eq 'ipdeny') {
! 47: return join(',',@denies);
! 48: }
! 49: if ($which eq 'ipallow') {
! 50: return join(',',@allows);
! 51: }
! 52: } else {
! 53: return $slot{$name}{$which};
! 54: }
1.5 albertel 55: }
56: </exec>
1.13 albertel 57: <message>
1.21 rezaferr 58: <br />Name: <br />
1.1 albertel 59: </message>
1.3 albertel 60: <string variable="name" size="30">
1.1 albertel 61: <validator>
62: if ($val=~/^\s*$/) { return 'Must specify a name'; }
1.9 albertel 63: if ($val=~/\s/) { return 'Must not contain spaces'; }
64: if ($val=~/\W/) { return 'Must contain only letters, numbers and _'; }
1.1 albertel 65: return undef;
66: </validator>
1.5 albertel 67: <defaultvalue>
68: return $helper->{'VARS'}{'name'};
69: </defaultvalue>
1.1 albertel 70: </string>
1.10 albertel 71: <condition>
72: <clause>$helper->{DATA}{copy}</clause>
1.13 albertel 73: <message>
1.10 albertel 74: <p>Changing the Name will create a new slot with the new name, and not rename the existing slot.</p>
75: </message>
76: </condition>
1.1 albertel 77: <message>
1.11 albertel 78: <br />Start time:<br />
1.1 albertel 79: </message>
1.5 albertel 80: <date variable="starttime" hoursminutes="1">
81: <defaultvalue>
82: return &{$helper->{DATA}{origslot}}('starttime');
83: </defaultvalue>
84: </date>
1.1 albertel 85: <message>
1.11 albertel 86: <br />End time:<br />
1.1 albertel 87: </message>
1.5 albertel 88: <date variable="endtime" hoursminutes="1">
89: <defaultvalue>
90: return &{$helper->{DATA}{origslot}}('endtime');
91: </defaultvalue>
1.15 albertel 92: <validator>
93: if ($val < $helper->{'VARS'}{'starttime'}) {
94: return 'End time must be later than the start time.';
95: }
96: return undef;
97: </validator>
1.5 albertel 98: </date>
1.1 albertel 99: <message>
1.11 albertel 100: <br />Type:
1.1 albertel 101: </message>
102: <choices variable="type">
1.26 bisitz 103: <choice computer='preassigned'>Instructor assignable.</choice>
1.5 albertel 104: <choice computer='schedulable_student'>Student selectable.</choice>
1.1 albertel 105: <defaultvalue>
1.5 albertel 106: return &{$helper->{DATA}{origslot}}('type','preassigned');
1.1 albertel 107: </defaultvalue>
108: </choices>
109: </state>
110:
1.13 albertel 111:
1.22 albertel 112: <state name="OPTIONAL" title="Specify Optional Attributes"
113: help="Slot_OptionalAttributes">
1.1 albertel 114: <message>
1.11 albertel 115: <p>Description:<br />
1.1 albertel 116: </message>
1.5 albertel 117: <string variable="description" size="60">
118: <defaultvalue>
119: return &{$helper->{DATA}{origslot}}('description');
120: </defaultvalue>
121: </string>
1.7 albertel 122: <condition>
123: <clause>$helper->{'VARS'}{'type'} eq 'schedulable_student'</clause>
124: <message>
1.11 albertel 125: </p><p>Time students can start reserving:<br />
1.7 albertel 126: </message>
127: <date variable="startreserve" hoursminutes="1" anytime="1">
128: <defaultvalue>
129: return &{$helper->{DATA}{origslot}}('startreserve','anytime');
130: </defaultvalue>
1.15 albertel 131: <validator>
132: if (defined($val) && $val > $helper->{'VARS'}{'starttime'}) {
133: return 'Reservation time must come before the slot has started.';
134: }
135: return undef;
136: </validator>
1.7 albertel 137: </date>
138: <message>
1.28 raeburn 139: </p><p>Time students can no longer reserve:<br />
140: </message>
141: <date variable="endreserve" hoursminutes="1" anytime="1">
142: <defaultvalue>
143: return &{$helper->{DATA}{origslot}}('endreserve','anytime');
144: </defaultvalue>
145: <validator>
146: if (defined($val) && $val > $helper->{'VARS'}{'starttime'}) {
147: return 'Reservation end time must come before the slot has started.';
148: }
149: return undef;
150: </validator>
151: </date>
152: <message>
1.24 raeburn 153: </p><p>Maximum number of students allowed in this slot:<br />
1.7 albertel 154: </message>
155: <string variable="maxspace" size="4">
156: <validator>
157: if ($val ne '' && $val=~/\D/) { return 'Must be numeric.'; }
158: return undef;
159: </validator>
160: <defaultvalue>
161: return &{$helper->{DATA}{origslot}}('maxspace');
162: </defaultvalue>
163: </string>
164: <message>
1.25 felicia 165: </p><p>Period of time when this slot can only be uniquely chosen:<br /> Start:
1.7 albertel 166: </message>
167: <date variable="startunique" hoursminutes="1" anytime="1">
168: <defaultvalue>
169: my $default=&{$helper->{DATA}{origslot}}('uniqueperiod','anytime');
170: if ($default eq 'anytime') { return 'anytime' };
171: if (ref($default)) { return $default->[0]; }
172: return 'anytime';
173: </defaultvalue>
174: </date>
1.11 albertel 175: <message><br /> End: </message>
1.7 albertel 176: <date variable="endunique" hoursminutes="1" anytime="1">
177: <defaultvalue>
178: my $default=&{$helper->{DATA}{origslot}}('uniqueperiod','anytime');
179: if ($default eq 'anytime') { return 'anytime' };
180: if (ref($default)) { return $default->[1]; }
181: return 'anytime';
182: </defaultvalue>
1.15 albertel 183: <validator>
184: if (defined($val) && $val < $helper->{'VARS'}{'startunique'}) {
185: return 'End time must be later than the start time.';
186: }
187: return undef;
188: </validator>
1.7 albertel 189: </date>
1.27 raeburn 190: <message>
191: </p><p>Message(s) triggered by reservation change by student
192: </message>
193: <choices variable="reservationmsg">
194: <choice computer='only_student'>Sent to student</choice>
195: <choice computer='student_and_user_notes_screen'>Sent to student and added to user notes</choice>
196: <choice computer='none'>None sent and no record in user notes</choice>
197: <defaultvalue>
198: my $default=&{$helper->{DATA}{origslot}}('reservationmsg');
199: if ($default eq 'only_student') { return $default; }
200: if ($default eq 'student_and_user_notes_screen') { return $default; }
201: return 'none';
202: </defaultvalue>
203: </choices>
1.7 albertel 204: </condition>
205: <condition>
206: <clause>$helper->{'VARS'}{'type'} eq 'preassigned'</clause>
207: <exec>
208: delete($helper->{'VARS'}{'startreserve'});
1.28 raeburn 209: delete($helper->{'VARS'}{'endreserve'});
1.7 albertel 210: delete($helper->{'VARS'}{'maxspace'});
211: delete($helper->{'VARS'}{'startunique'});
212: delete($helper->{'VARS'}{'endunique'});
213: </exec>
214: </condition>
1.20 albertel 215:
216: <message>
217: </p><p>Proctored access:
218: </message>
219: <choices variable="useproctor">
220: <choice computer='no'>No proctor checkin required for access.</choice>
221: <choice computer='yes'>Require proctored checkin for access.</choice>
222: <defaultvalue>
223: my $default=&{$helper->{DATA}{origslot}}('proctor');
224: if ($default) { return 'yes'; }
225: return 'no';
226: </defaultvalue>
227: </choices>
228:
1.1 albertel 229: <message>
1.11 albertel 230: </p><p>Secret word proctors use to checkin users:<br />
1.3 albertel 231: </message>
232: <string variable="secret" size="12">
233: <validator>
234: return undef;
235: </validator>
1.5 albertel 236: <defaultvalue>
237: return &{$helper->{DATA}{origslot}}('secret');
238: </defaultvalue>
1.3 albertel 239: </string>
240: <message>
1.11 albertel 241: </p><p>Slot is:
1.1 albertel 242: </message>
1.22 albertel 243: <helpicon file="Slot_ChoosingResources" />
1.21 rezaferr 244:
1.1 albertel 245: <choices variable="restricttosymb">
1.4 albertel 246: <choice nextstate="PROCTOR" computer='any'>usable for any resource.</choice>
1.1 albertel 247: <choice nextstate="RESOURCESELECT" computer='resource'>restricted to a specific resource.</choice>
1.5 albertel 248: <defaultvalue>
249: my $default=&{$helper->{DATA}{origslot}}('symb');
250: if ($default) { return 'resource'; }
251: return 'any';
252: </defaultvalue>
1.1 albertel 253: </choices>
1.21 rezaferr 254:
1.2 albertel 255: <message>
1.30.6.1! raeburn 256: </p><p>IP restrictions -- allow from all except:<br />
1.2 albertel 257: </message>
1.30.6.1! raeburn 258:
! 259: <string variable="ipdeny" size="30">
1.2 albertel 260: <validator>
261: return undef;
262: </validator>
1.5 albertel 263: <defaultvalue>
1.30.6.1! raeburn 264: return &{$helper->{DATA}{origslot}}('ipdeny');
! 265: </defaultvalue>
! 266: </string>
! 267:
! 268: <message>
! 269: </p><p>IP restrictions -- deny from all except: <br />
! 270: </message>
! 271:
! 272: <string variable="ipallow" size="30">
! 273: <validator>
! 274: return undef;
! 275: </validator>
! 276: <defaultvalue>
! 277: return &{$helper->{DATA}{origslot}}('ipallow');
1.5 albertel 278: </defaultvalue>
1.2 albertel 279: </string>
1.11 albertel 280: <message> </p> </message>
1.1 albertel 281: </state>
1.13 albertel 282:
283:
1.1 albertel 284: <state name="RESOURCESELECT" title="Specify Optional Attributes">
1.13 albertel 285:
286: <nextstate>PROCTOR</nextstate>
287:
1.1 albertel 288: <resource variable="symb">
289: <filterfunc>return $res->is_problem()</filterfunc>
290: <valuefunc>return $res->symb()</valuefunc>
1.5 albertel 291: <defaultvalue>
292: return &{$helper->{DATA}{origslot}}('symb');
293: </defaultvalue>
1.1 albertel 294: </resource>
295: </state>
1.13 albertel 296:
297:
1.22 albertel 298: <state name="PROCTOR" title="Specify Proctors"
299: help="Slot_SpecifyProctors">
1.13 albertel 300:
1.20 albertel 301: <skip>
302: <clause>$helper->{'VARS'}{'useproctor'} eq 'no'</clause>
303: <nextstate>RESTRICTUSER</nextstate>
304: </skip>
1.13 albertel 305:
1.20 albertel 306: <nextstate>RESTRICTUSER</nextstate>
1.18 albertel 307:
1.4 albertel 308: <student variable="proctor" multichoice="1" coursepersonnel="1"
1.23 albertel 309: activeonly="1" emptyallowed="0">
1.5 albertel 310: <defaultvalue>
311: my @defaults;
312: my $default=&{$helper->{DATA}{origslot}}('proctor');
313: if ($default) {
314: @defaults=(split(',',$default));
315: }
316: return @defaults;
317: </defaultvalue>
1.4 albertel 318: </student>
319: </state>
1.13 albertel 320:
321:
1.22 albertel 322: <state name="RESTRICTUSER" title="Restrict slot availability"
323: help="Slot_RestrictAvailibility">
1.20 albertel 324: <skip>
325: <clause>$helper->{'VARS'}{'type'} ne 'schedulable_student'</clause>
326: <nextstate>FINISH</nextstate>
327: </skip>
328:
1.13 albertel 329: <nextstate>FINISH</nextstate>
330: <message>
331: <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>
332: </message>
333:
334: <message>
335: Select sections to limit slot availability to: <br />
336: </message>
337: <section variable="allowedsections" multichoice="1" allowempty="1">
338: <defaultvalue>
339: return join('|||',
340: split(',',&{$helper->{DATA}{origslot}}('allowedsections')));
341: </defaultvalue>
342: </section>
343: <message>
344: Select users to limit slot availability to: <br />
345: </message>
346: <student variable="allowedusers" multichoice="1" coursepersonnel="1"
347: activeonly="1" emptyallowed="1">
348: <defaultvalue>
349: return split(',',&{$helper->{DATA}{origslot}}('allowedusers'));
350: </defaultvalue>
351: </student>
352: </state>
353:
354:
1.30 bisitz 355: <state name="FINISH" title="Creating/Modifying Slot">
1.11 albertel 356: <message> Created Slot </message>
1.3 albertel 357: <final>
358: <finalcode>
359: my $result;
360: if ($helper->{'STATE'} ne 'FINISH') { return; }
361: my %slot;
1.13 albertel 362:
1.3 albertel 363: foreach my $which ('type','starttime','endtime') {
364: $slot{$which} = $helper->{'VARS'}{$which};
365: }
1.13 albertel 366:
1.30.6.1! raeburn 367: foreach my $which ('description','maxspace','secret','symb') {
1.3 albertel 368: if ( $helper->{'VARS'}{$which} =~/\S/ ) {
369: $slot{$which} = $helper->{'VARS'}{$which};
370: }
371: }
1.13 albertel 372:
1.30.6.1! raeburn 373: if ($helper->{'VARS'}{'ipdeny'} =~/\S/ ) {
! 374: foreach my $item (split(',',$helper->{'VARS'}{'ipdeny'})) {
! 375: $item =~ s/^\s*//;
! 376: $item =~ s/\s*$//;
! 377: $slot{'ip'} .= '!'.$item.',';
! 378: }
! 379: }
! 380:
! 381: if ($helper->{'VARS'}{'ipallow'} =~/\S/ ) {
! 382: foreach my $item (split(',',$helper->{'VARS'}{'ipallow'})) {
! 383: $item =~ s/^\s*//;
! 384: $item =~ s/\s*$//;
! 385: $slot{'ip'} .= $item.',';
! 386: }
! 387: }
! 388:
! 389: if ($slot{'ip'} ne '') {
! 390: $slot{'ip'} =~s /,$//;
! 391: }
! 392:
1.27 raeburn 393: if ($helper->{'VARS'}{'type'} eq 'schedulable_student') {
394: if (($helper->{'VARS'}{'reservationmsg'} eq 'only_student') ||
395: ($helper->{'VARS'}{'reservationmsg'} eq 'student_and_user_notes_screen')) {
396: $slot{'reservationmsg'} = $helper->{'VARS'}{'reservationmsg'};
397: } else {
398: $slot{'reservationmsg'} = 'none';
399: }
400: }
401:
1.12 albertel 402: if ( $helper->{'VARS'}{'startreserve'} > 0) {
403: $slot{'startreserve'} = $helper->{'VARS'}{'startreserve'};
404: }
1.13 albertel 405:
1.28 raeburn 406: if ( $helper->{'VARS'}{'endreserve'} > 0) {
407: $slot{'endreserve'} = $helper->{'VARS'}{'endreserve'};
408: }
409:
1.3 albertel 410: if ( $helper->{'VARS'}{'startunique'} > 0 &&
411: $helper->{'VARS'}{'endunique'} > 0 ) {
412: $slot{'uniqueperiod'} = [$helper->{'VARS'}{'startunique'},
413: $helper->{'VARS'}{'endunique'}];
414: }
1.13 albertel 415:
1.19 albertel 416: if ( $helper->{'VARS'}{'useproctor'} eq 'yes'
417: && $helper->{'VARS'}{'proctor'} =~/\S/ ) {
1.4 albertel 418: my @names;
1.16 albertel 419: # just need the username/domain throw away the other data
420: # that <student> returns
1.4 albertel 421: foreach my $user (split(/\|\|\|/, $helper->{'VARS'}{'proctor'})) {
422: my ($uname,$udomain)=split(/:/,$user);
1.16 albertel 423: push(@names,"$uname:$udomain");
1.4 albertel 424: }
1.16 albertel 425: # make sure the usernmaes are unique
1.8 albertel 426: my %proctors = map { ($_,1) } @names;
427: $slot{'proctor'}=join(',',sort(keys(%proctors)));
1.4 albertel 428: }
1.13 albertel 429:
1.14 albertel 430: if ( $helper->{'VARS'}{'allowedsections'} =~/\S/ ) {
431: $slot{'allowedsections'}=
432: join(',',sort(split(/\|\|\|/,
433: $helper->{'VARS'}{'allowedsections'})));
1.13 albertel 434: }
435:
1.14 albertel 436: if ( $helper->{'VARS'}{'allowedusers'} =~/\S/ ) {
1.13 albertel 437: my @names;
1.16 albertel 438: # just need the username/domain throw away the other data
439: # that <student> returns
1.14 albertel 440: foreach my $item (split(/\|\|\|/,
441: $helper->{'VARS'}{'allowedusers'})) {
1.13 albertel 442: my ($uname,$udomain)=split(/:/,$item);
443: push(@names,"$uname:$udomain");
444: }
445:
446: # make sure the choices are unique
1.14 albertel 447: my %users = map { ($_,1) } @names;
448: $slot{'allowedusers'}=join(',',sort(keys(%users)));
1.13 albertel 449: }
450:
1.3 albertel 451: my $cname = $env{'course.'.$env{'request.course.id'}.'.num'};
452: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
453:
454: my $ret = &Apache::lonnet::cput('slots',
455: {$helper->{'VARS'}{'name'} => \%slot},
456: $cdom,$cname);
1.29 raeburn 457: if ($ret eq 'ok') {
458: &Apache::lonnet::devalidate_slots_cache($cname,$cdom);
459: }
1.5 albertel 460: $result.="\n ".'Name: '.&HTML::Entities::encode($helper->{'VARS'}{'name'}).'</li>'.
1.4 albertel 461: "\n".'<li> Starts: '.&Apache::lonlocal::locallocaltime($slot{'starttime'}).'</li>'.
462: "\n".'<li> Ends: '.&Apache::lonlocal::locallocaltime($slot{'endtime'}).'</li>'.
1.3 albertel 463: "\n".'<li> Type: '.$slot{'type'}.'</li>';
464: my %labels =
465: map {($_->[0],$_->[1])} &Apache::slotrequest::csvupload_fields();
1.13 albertel 466: foreach my $which ('ip','description','maxspace','secret','symb',
467: 'allowedsections','allowedusers') {
1.3 albertel 468: if (exists($slot{$which})) {
469: $result.="\n".'<li> '.$labels{$which}.': '.
470: &HTML::Entities::encode($slot{$which}).'</li>';
471: }
472: }
1.12 albertel 473: if (exists($slot{'startreserve'})) {
474: $result.="\n".'<li> '.$labels{'startreserve'}.': '.
475: &Apache::lonlocal::locallocaltime($slot{'startreserve'}).'</li>';
476: }
1.27 raeburn 477:
1.28 raeburn 478: if (exists($slot{'endreserve'})) {
479: $result.="\n".'<li> '.$labels{'endreserve'}.': '.
480: &Apache::lonlocal::locallocaltime($slot{'endreserve'}).'</li>';
481: }
482:
1.27 raeburn 483: if (exists($slot{'reservationmsg'})) {
484: my %options = &Apache::slotrequest::slot_reservationmsg_options();
485: $result.="\n".'<li> '.$labels{'reservationmsg'}.': '.
486: $options{$slot{'reservationmsg'}}.'</li>';
487: }
488:
1.6 albertel 489: if (exists($slot{'proctor'})) {
490: my $proctors = $slot{'proctor'};
491: $proctors =~ s/,/, /g;
492: $result.="\n".'<li> '.$labels{'proctor'}.': '.
493: &HTML::Entities::encode($proctors).'</li>';
494: }
1.3 albertel 495: if (exists($slot{'uniqueperiod'})) {
496: $result.=
497: "\n".'<li> '.$labels{'uniqueperiod'}.': '.
498: &Apache::lonlocal::locallocaltime($slot{'uniqueperiod'}[0]).
499: ', '.
500: &Apache::lonlocal::locallocaltime($slot{'uniqueperiod'}[1]).
501: '</li>';
502: }
503: return $result;
504: </finalcode>
1.4 albertel 505: <exitpage>/adm/slotrequest?command=showslots</exitpage>
1.3 albertel 506: </final>
1.1 albertel 507: </state>
508: </helper>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to newslot.helper CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / html / adm / helper