Annotation of loncom/html/adm/helper/newslot.helper, revision 1.31
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: delete($helper->{'VARS'}{'startunique'});
188: delete($helper->{'VARS'}{'endunique'});
189: </exec>
190: </condition>
1.20 albertel 191:
192: <message>
193: </p><p>Proctored access:
194: </message>
195: <choices variable="useproctor">
196: <choice computer='no'>No proctor checkin required for access.</choice>
197: <choice computer='yes'>Require proctored checkin for access.</choice>
198: <defaultvalue>
199: my $default=&{$helper->{DATA}{origslot}}('proctor');
200: if ($default) { return 'yes'; }
201: return 'no';
202: </defaultvalue>
203: </choices>
204:
1.1 albertel 205: <message>
1.11 albertel 206: </p><p>Secret word proctors use to checkin users:<br />
1.3 albertel 207: </message>
208: <string variable="secret" size="12">
209: <validator>
210: return undef;
211: </validator>
1.5 albertel 212: <defaultvalue>
213: return &{$helper->{DATA}{origslot}}('secret');
214: </defaultvalue>
1.3 albertel 215: </string>
216: <message>
1.11 albertel 217: </p><p>Slot is:
1.1 albertel 218: </message>
1.22 albertel 219: <helpicon file="Slot_ChoosingResources" />
1.21 rezaferr 220:
1.1 albertel 221: <choices variable="restricttosymb">
1.4 albertel 222: <choice nextstate="PROCTOR" computer='any'>usable for any resource.</choice>
1.31 ! raeburn 223: <choice nextstate="MAPSELECT" computer='map'>restricted to resources in a specific folder/composite page.</choice>
1.1 albertel 224: <choice nextstate="RESOURCESELECT" computer='resource'>restricted to a specific resource.</choice>
1.5 albertel 225: <defaultvalue>
226: my $default=&{$helper->{DATA}{origslot}}('symb');
1.31 ! raeburn 227: if ($default) {
! 228: if ($default =~ /\.(page|sequence)$/) {
! 229: return 'map';
! 230: } else {
! 231: return 'resource';
! 232: }
! 233: } else {
! 234: return 'any';
! 235: }
1.5 albertel 236: </defaultvalue>
1.1 albertel 237: </choices>
1.21 rezaferr 238:
1.2 albertel 239: <message>
1.13 albertel 240: </p><p>IP restrictions:<br />
1.2 albertel 241: </message>
242: <string variable="ip" size="30">
243: <validator>
244: return undef;
245: </validator>
1.5 albertel 246: <defaultvalue>
247: return &{$helper->{DATA}{origslot}}('ip');
248: </defaultvalue>
1.2 albertel 249: </string>
1.11 albertel 250: <message> </p> </message>
1.1 albertel 251: </state>
1.13 albertel 252:
253:
1.1 albertel 254: <state name="RESOURCESELECT" title="Specify Optional Attributes">
1.13 albertel 255:
256: <nextstate>PROCTOR</nextstate>
257:
1.1 albertel 258: <resource variable="symb">
259: <filterfunc>return $res->is_problem()</filterfunc>
260: <valuefunc>return $res->symb()</valuefunc>
1.5 albertel 261: <defaultvalue>
262: return &{$helper->{DATA}{origslot}}('symb');
263: </defaultvalue>
1.1 albertel 264: </resource>
265: </state>
1.13 albertel 266:
1.31 ! raeburn 267: <state name="MAPSELECT" title="Specify Optional Attributes">
! 268:
! 269: <nextstate>PROCTOR</nextstate>
! 270:
! 271: <resource variable="symb">
! 272: <filterfunc>return $res->is_map()</filterfunc>
! 273: <valuefunc>return $res->symb()</valuefunc>
! 274: <defaultvalue>
! 275: return &{$helper->{DATA}{origslot}}('symb');
! 276: </defaultvalue>
! 277: </resource>
! 278: </state>
1.13 albertel 279:
1.22 albertel 280: <state name="PROCTOR" title="Specify Proctors"
281: help="Slot_SpecifyProctors">
1.13 albertel 282:
1.20 albertel 283: <skip>
284: <clause>$helper->{'VARS'}{'useproctor'} eq 'no'</clause>
285: <nextstate>RESTRICTUSER</nextstate>
286: </skip>
1.13 albertel 287:
1.20 albertel 288: <nextstate>RESTRICTUSER</nextstate>
1.18 albertel 289:
1.4 albertel 290: <student variable="proctor" multichoice="1" coursepersonnel="1"
1.23 albertel 291: activeonly="1" emptyallowed="0">
1.5 albertel 292: <defaultvalue>
293: my @defaults;
294: my $default=&{$helper->{DATA}{origslot}}('proctor');
295: if ($default) {
296: @defaults=(split(',',$default));
297: }
298: return @defaults;
299: </defaultvalue>
1.4 albertel 300: </student>
301: </state>
1.13 albertel 302:
303:
1.22 albertel 304: <state name="RESTRICTUSER" title="Restrict slot availability"
305: help="Slot_RestrictAvailibility">
1.20 albertel 306: <skip>
307: <clause>$helper->{'VARS'}{'type'} ne 'schedulable_student'</clause>
308: <nextstate>FINISH</nextstate>
309: </skip>
310:
1.13 albertel 311: <nextstate>FINISH</nextstate>
312: <message>
313: <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>
314: </message>
315:
316: <message>
317: Select sections to limit slot availability to: <br />
318: </message>
319: <section variable="allowedsections" multichoice="1" allowempty="1">
320: <defaultvalue>
321: return join('|||',
322: split(',',&{$helper->{DATA}{origslot}}('allowedsections')));
323: </defaultvalue>
324: </section>
325: <message>
326: Select users to limit slot availability to: <br />
327: </message>
328: <student variable="allowedusers" multichoice="1" coursepersonnel="1"
329: activeonly="1" emptyallowed="1">
330: <defaultvalue>
331: return split(',',&{$helper->{DATA}{origslot}}('allowedusers'));
332: </defaultvalue>
333: </student>
334: </state>
335:
336:
1.30 bisitz 337: <state name="FINISH" title="Creating/Modifying Slot">
1.11 albertel 338: <message> Created Slot </message>
1.3 albertel 339: <final>
340: <finalcode>
341: my $result;
342: if ($helper->{'STATE'} ne 'FINISH') { return; }
343: my %slot;
1.13 albertel 344:
1.3 albertel 345: foreach my $which ('type','starttime','endtime') {
346: $slot{$which} = $helper->{'VARS'}{$which};
347: }
1.13 albertel 348:
349: foreach my $which ('ip','description','maxspace','secret','symb') {
1.3 albertel 350: if ( $helper->{'VARS'}{$which} =~/\S/ ) {
351: $slot{$which} = $helper->{'VARS'}{$which};
352: }
353: }
1.13 albertel 354:
1.27 raeburn 355: if ($helper->{'VARS'}{'type'} eq 'schedulable_student') {
356: if (($helper->{'VARS'}{'reservationmsg'} eq 'only_student') ||
357: ($helper->{'VARS'}{'reservationmsg'} eq 'student_and_user_notes_screen')) {
358: $slot{'reservationmsg'} = $helper->{'VARS'}{'reservationmsg'};
359: } else {
360: $slot{'reservationmsg'} = 'none';
361: }
362: }
363:
1.12 albertel 364: if ( $helper->{'VARS'}{'startreserve'} > 0) {
365: $slot{'startreserve'} = $helper->{'VARS'}{'startreserve'};
366: }
1.13 albertel 367:
1.28 raeburn 368: if ( $helper->{'VARS'}{'endreserve'} > 0) {
369: $slot{'endreserve'} = $helper->{'VARS'}{'endreserve'};
370: }
371:
1.3 albertel 372: if ( $helper->{'VARS'}{'startunique'} > 0 &&
373: $helper->{'VARS'}{'endunique'} > 0 ) {
374: $slot{'uniqueperiod'} = [$helper->{'VARS'}{'startunique'},
375: $helper->{'VARS'}{'endunique'}];
376: }
1.13 albertel 377:
1.19 albertel 378: if ( $helper->{'VARS'}{'useproctor'} eq 'yes'
379: && $helper->{'VARS'}{'proctor'} =~/\S/ ) {
1.4 albertel 380: my @names;
1.16 albertel 381: # just need the username/domain throw away the other data
382: # that <student> returns
1.4 albertel 383: foreach my $user (split(/\|\|\|/, $helper->{'VARS'}{'proctor'})) {
384: my ($uname,$udomain)=split(/:/,$user);
1.16 albertel 385: push(@names,"$uname:$udomain");
1.4 albertel 386: }
1.16 albertel 387: # make sure the usernmaes are unique
1.8 albertel 388: my %proctors = map { ($_,1) } @names;
389: $slot{'proctor'}=join(',',sort(keys(%proctors)));
1.4 albertel 390: }
1.13 albertel 391:
1.14 albertel 392: if ( $helper->{'VARS'}{'allowedsections'} =~/\S/ ) {
393: $slot{'allowedsections'}=
394: join(',',sort(split(/\|\|\|/,
395: $helper->{'VARS'}{'allowedsections'})));
1.13 albertel 396: }
397:
1.14 albertel 398: if ( $helper->{'VARS'}{'allowedusers'} =~/\S/ ) {
1.13 albertel 399: my @names;
1.16 albertel 400: # just need the username/domain throw away the other data
401: # that <student> returns
1.14 albertel 402: foreach my $item (split(/\|\|\|/,
403: $helper->{'VARS'}{'allowedusers'})) {
1.13 albertel 404: my ($uname,$udomain)=split(/:/,$item);
405: push(@names,"$uname:$udomain");
406: }
407:
408: # make sure the choices are unique
1.14 albertel 409: my %users = map { ($_,1) } @names;
410: $slot{'allowedusers'}=join(',',sort(keys(%users)));
1.13 albertel 411: }
412:
1.3 albertel 413: my $cname = $env{'course.'.$env{'request.course.id'}.'.num'};
414: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
415:
416: my $ret = &Apache::lonnet::cput('slots',
417: {$helper->{'VARS'}{'name'} => \%slot},
418: $cdom,$cname);
1.29 raeburn 419: if ($ret eq 'ok') {
420: &Apache::lonnet::devalidate_slots_cache($cname,$cdom);
421: }
1.5 albertel 422: $result.="\n ".'Name: '.&HTML::Entities::encode($helper->{'VARS'}{'name'}).'</li>'.
1.4 albertel 423: "\n".'<li> Starts: '.&Apache::lonlocal::locallocaltime($slot{'starttime'}).'</li>'.
424: "\n".'<li> Ends: '.&Apache::lonlocal::locallocaltime($slot{'endtime'}).'</li>'.
1.3 albertel 425: "\n".'<li> Type: '.$slot{'type'}.'</li>';
426: my %labels =
427: map {($_->[0],$_->[1])} &Apache::slotrequest::csvupload_fields();
1.13 albertel 428: foreach my $which ('ip','description','maxspace','secret','symb',
429: 'allowedsections','allowedusers') {
1.3 albertel 430: if (exists($slot{$which})) {
431: $result.="\n".'<li> '.$labels{$which}.': '.
432: &HTML::Entities::encode($slot{$which}).'</li>';
433: }
434: }
1.12 albertel 435: if (exists($slot{'startreserve'})) {
436: $result.="\n".'<li> '.$labels{'startreserve'}.': '.
437: &Apache::lonlocal::locallocaltime($slot{'startreserve'}).'</li>';
438: }
1.27 raeburn 439:
1.28 raeburn 440: if (exists($slot{'endreserve'})) {
441: $result.="\n".'<li> '.$labels{'endreserve'}.': '.
442: &Apache::lonlocal::locallocaltime($slot{'endreserve'}).'</li>';
443: }
444:
1.27 raeburn 445: if (exists($slot{'reservationmsg'})) {
446: my %options = &Apache::slotrequest::slot_reservationmsg_options();
447: $result.="\n".'<li> '.$labels{'reservationmsg'}.': '.
448: $options{$slot{'reservationmsg'}}.'</li>';
449: }
450:
1.6 albertel 451: if (exists($slot{'proctor'})) {
452: my $proctors = $slot{'proctor'};
453: $proctors =~ s/,/, /g;
454: $result.="\n".'<li> '.$labels{'proctor'}.': '.
455: &HTML::Entities::encode($proctors).'</li>';
456: }
1.3 albertel 457: if (exists($slot{'uniqueperiod'})) {
458: $result.=
459: "\n".'<li> '.$labels{'uniqueperiod'}.': '.
460: &Apache::lonlocal::locallocaltime($slot{'uniqueperiod'}[0]).
461: ', '.
462: &Apache::lonlocal::locallocaltime($slot{'uniqueperiod'}[1]).
463: '</li>';
464: }
465: return $result;
466: </finalcode>
1.4 albertel 467: <exitpage>/adm/slotrequest?command=showslots</exitpage>
1.3 albertel 468: </final>
1.1 albertel 469: </state>
470: </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