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