1: # The LearningOnline Network with CAPA
2: # Handler for requesting to have slots added to a students record
3: #
4: # $Id: slotrequest.pm,v 1.44 2006/02/03 23:53:30 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: ###
29:
30: package Apache::slotrequest;
31:
32: use strict;
33: use Apache::Constants qw(:common :http :methods);
34: use Apache::loncommon();
35: use Apache::lonlocal;
36: use Apache::lonnet;
37: use Date::Manip;
38:
39: sub fail {
40: my ($r,$code)=@_;
41: if ($code eq 'not_valid') {
42: $r->print('<p>'.&mt('Unable to understand what resource you wanted to sign up for.').'</p>');
43:
44: } elsif ($code eq 'not_allowed') {
45: $r->print('<p>'.&mt('Not allowed to sign up or change reservations at this time.').'</p>');
46: } else {
47: $r->print('<p>'.&mt('Failed.').'</p>');
48: }
49:
50: &return_link($r);
51: &end_page($r);
52: }
53:
54: sub start_page {
55: my ($r,$title)=@_;
56: my $html=&Apache::lonxml::xmlbegin();
57: $r->print($html.'<head><title>'.&mt($title).'</title></head>');
58: $r->print(&Apache::loncommon::bodytag($title));
59: }
60:
61: sub end_page {
62: my ($r)=@_;
63: $r->print(&Apache::loncommon::endbodytag().'</html>');
64: }
65:
66: =pod
67:
68: slot_reservations db
69: - keys are
70: - slotname\0id -> value is an hashref of
71: name -> user@domain of holder
72: timestamp -> timestamp of reservation
73: symb -> symb of resource that it is reserved for
74:
75: =cut
76:
77: sub get_course {
78: (undef,my $courseid)=&Apache::lonxml::whichuser();
79: my $cdom=$env{'course.'.$courseid.'.domain'};
80: my $cnum=$env{'course.'.$courseid.'.num'};
81: return ($cnum,$cdom);
82: }
83:
84: sub get_reservation_ids {
85: my ($slot_name)=@_;
86:
87: my ($cnum,$cdom)=&get_course();
88:
89: my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum,
90: "^$slot_name\0");
91: if (&network_error(%consumed)) {
92: return 'error: Unable to determine current status';
93: }
94: my ($tmp)=%consumed;
95: if ($tmp=~/^error: 2 / ) {
96: return 0;
97: }
98: return keys(%consumed);
99: }
100:
101: sub space_available {
102: my ($slot_name,$slot)=@_;
103: my $max=$slot->{'maxspace'};
104:
105: if (!defined($max)) { return 1; }
106:
107: my $consumed=scalar(&get_reservation_ids($slot_name));
108: if ($consumed < $max) {
109: return 1
110: }
111: return 0;
112: }
113:
114: sub check_for_reservation {
115: my ($symb,$mode)=@_;
116: my $student = &Apache::lonnet::EXT("resource.0.availablestudent", $symb,
117: $env{'user.domain'}, $env{'user.name'});
118:
119: my $course = &Apache::lonnet::EXT("resource.0.available", $symb,
120: $env{'user.domain'}, $env{'user.name'});
121: my @slots = (split(/:/,$student), split(/:/, $course));
122:
123: &Apache::lonxml::debug(" slot list is ".join(':',@slots));
124:
125: my ($cnum,$cdom)=&get_course();
126: my %slots=&Apache::lonnet::get('slots', [@slots], $cdom, $cnum);
127:
128: if (&network_error($student) || &network_error($course) ||
129: &network_error(%slots)) {
130: return 'error: Unable to determine current status';
131: }
132: my @got;
133: foreach my $slot_name (sort {
134: if (ref($slots{$a}) && ref($slots{$b})) {
135: return $slots{$a}{'starttime'} <=> $slots{$b}{'starttime'}
136: }
137: if (ref($slots{$a})) { return -1;}
138: if (ref($slots{$b})) { return 1;}
139: return 0;
140: } @slots) {
141: next if (!defined($slots{$slot_name}) ||
142: !ref($slots{$slot_name}));
143: &Apache::lonxml::debug(time." $slot_name ".
144: $slots{$slot_name}->{'starttime'}." -- ".
145: $slots{$slot_name}->{'startreserve'});
146: if ($slots{$slot_name}->{'endtime'} > time &&
147: $slots{$slot_name}->{'startreserve'} < time) {
148: # between start of reservation times and end of slot
149: if ($mode eq 'allslots') {
150: push(@got,$slot_name);
151: } else {
152: return($slot_name, $slots{$slot_name});
153: }
154: }
155: }
156: if ($mode eq 'allslots' && @got) {
157: return @got;
158: }
159: return (undef,undef);
160: }
161:
162: sub check_for_conflict {
163: my ($symb,$new_slot_name,$new_slot,$slots)=@_;
164:
165: if (!defined($new_slot->{'uniqueperiod'})) { return undef; }
166:
167: my $student = &Apache::lonnet::EXT("resource.0.availablestudent", $symb,
168: $env{'user.domain'}, $env{'user.name'});
169: my $course = &Apache::lonnet::EXT("resource.0.available", $symb,
170: $env{'user.domain'}, $env{'user.name'});
171: my @slots = (split(/:/,$student), split(/:/, $course));
172: my ($cnum,$cdom)=&get_course();
173: if (!ref($slots)) {
174: my %slots=&Apache::lonnet::get('slots', [@slots], $cdom, $cnum);
175: $slots = \%slots;
176: }
177:
178: if (&network_error($student) || &network_error($course) ||
179: &network_error(%$slots)) {
180: return 'error: Unable to determine current status';
181: }
182:
183: my ($new_uniq_start,$new_uniq_end) = @{$new_slot->{'uniqueperiod'}};
184: foreach my $slot_name (@slots) {
185: next if (!defined($slots->{$slot_name}) ||
186: !ref($slots->{$slot_name}));
187:
188: next if (!defined($slots->{$slot_name}{'uniqueperiod'}) ||
189: !ref($slots->{$slot_name}{'uniqueperiod'}));
190: my ($start,$end)=@{$slots->{$slot_name}{'uniqueperiod'}};
191: if (!
192: ($start < $new_uniq_start && $end < $new_uniq_start) ||
193: ($start > $new_uniq_end && $end > $new_uniq_end )) {
194: return $slot_name;
195: }
196: }
197: return undef;
198:
199: }
200:
201: sub network_error {
202: my ($result) = @_;
203: if ($result =~ /^(con_lost|no_such_host|error: [^2])/) {
204: return 1;
205: }
206: return 0;
207: }
208:
209: sub make_reservation {
210: my ($slot_name,$slot,$symb)=@_;
211:
212: my ($cnum,$cdom)=&get_course();
213:
214: my $value=&Apache::lonnet::EXT("resource.0.availablestudent",$symb,
215: $env{'user.domain'},$env{'user.name'});
216: &Apache::lonxml::debug("value is $value<br />");
217: if (&network_error($value)) {
218: return 'error: Unable to determine current status';
219: }
220:
221: foreach my $other_slot (split(/:/, $value)) {
222: if ($other_slot eq $slot_name) {
223: my %consumed=&Apache::lonnet::dump('slot_reservations', $cdom,
224: $cnum, "^$slot_name\0");
225: if (&network_error($value)) {
226: return 'error: Unable to determine current status';
227: }
228: my $me=$env{'user.name'}.'@'.$env{'user.domain'};
229: foreach my $key (keys(%consumed)) {
230: if ($consumed{$key}->{'name'} eq $me) {
231: my $num=(split('\0',$key))[1];
232: return -$num;
233: }
234: }
235: }
236: }
237:
238: my $max=$slot->{'maxspace'};
239: if (!defined($max)) { $max=99999; }
240:
241: my (@ids)=&get_reservation_ids($slot_name);
242: if (&network_error(@ids)) {
243: return 'error: Unable to determine current status';
244: }
245: my $last=0;
246: foreach my $id (@ids) {
247: my $num=(split('\0',$id))[1];
248: if ($num > $last) { $last=$num; }
249: }
250:
251: my $wanted=$last+1;
252: &Apache::lonxml::debug("wanted $wanted<br />");
253: if (scalar(@ids) >= $max) {
254: # full up
255: return undef;
256: }
257:
258: my %reservation=('name' => $env{'user.name'}.'@'.$env{'user.domain'},
259: 'timestamp' => time,
260: 'symb' => $symb);
261:
262: my $success=&Apache::lonnet::newput('slot_reservations',
263: {"$slot_name\0$wanted" =>
264: \%reservation},
265: $cdom, $cnum);
266:
267: if ($success eq 'ok') {
268: my $new_value=$slot_name;
269: if ($value) {
270: $new_value=$value.':'.$new_value;
271: }
272: my $result=&Apache::lonparmset::storeparm_by_symb($symb,
273: '0_availablestudent',
274: 1, $new_value, 'string',
275: $env{'user.name'},
276: $env{'user.domain'});
277: &Apache::lonxml::debug("hrrm $result");
278: return $wanted;
279: }
280:
281: # someone else got it
282: return undef;
283: }
284:
285: sub remove_registration {
286: my ($r) = @_;
287: my $name = &Apache::loncommon::plainname($env{'form.uname'},
288: $env{'form.udom'});
289:
290: my $title = &Apache::lonnet::gettitle($env{'form.symb'});
291:
292: my $hidden_input;
293: foreach my $parm ('uname','udom','slotname','entry','symb') {
294: $hidden_input .=
295: '<input type="hidden" name="'.$parm.'" value="'
296: .&HTML::Entities::encode($env{'form.'.$parm},'"<>&\'').'" />'."\n";
297: }
298: $r->print(<<"END_CONFIRM");
299: <p> Remove $name from slot $env{'form.slotname'} for $title</p>
300: <form action="/adm/slotrequest" method="POST">
301: <input type="hidden" name="command" value="release" />
302: $hidden_input
303: <input type="submit" name="Yes" value="yes" />
304: </form>
305: <form action="/adm/slotrequest" method="POST">
306: <input type="hidden" name="command" value="showslots" />
307: <input type="submit" name="No" value="no" />
308: </form>
309: END_CONFIRM
310:
311: }
312:
313: sub release_slot {
314: my ($r,$symb,$slot_name,$inhibit_return_link,$mgr)=@_;
315:
316: if ($slot_name eq '') { $slot_name=$env{'form.slotname'}; }
317: my ($cnum,$cdom)=&get_course();
318:
319: my ($uname,$udom) = ($env{'user.name'}, $env{'user.domain'});
320: if ($mgr eq 'F'
321: && defined($env{'form.uname'}) && defined($env{'form.udom'})) {
322: ($uname,$udom) = ($env{'form.uname'}, $env{'form.udom'});
323: }
324:
325: if ($mgr eq 'F'
326: && defined($env{'form.symb'})) {
327: $symb = $env{'form.symb'};
328: }
329: my %slot=&Apache::lonnet::get_slot($slot_name);
330: my $description=&get_description($env{'form.slotname'},\%slot);
331:
332: if ($mgr ne 'F') {
333: if ($slot{'starttime'} < time) {
334: $r->print("<p>Not allowed to release Reservation: $description, as it has already ended. </p>");
335: &return_link($r);
336: return 0;
337: }
338: }
339: # get parameter string, check for existance, rebuild string with the slot
340: my @slots = split(/:/,&Apache::lonnet::EXT("resource.0.availablestudent",
341: $symb,$udom,$uname));
342:
343: my @new_slots;
344: foreach my $exist_slot (@slots) {
345: if ($exist_slot eq $slot_name) { next; }
346: push(@new_slots,$exist_slot);
347: }
348: my $new_param = join(':',@new_slots);
349:
350: # get slot reservations, check if user has one, if so remove reservation
351: my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum,
352: "^$slot_name\0");
353: foreach my $entry (keys(%consumed)) {
354: if ( $consumed{$entry}->{'name'} eq ($uname.'@'.$udom) ) {
355: &Apache::lonnet::del('slot_reservations',[$entry],
356: $cdom,$cnum);
357: }
358: }
359:
360: # store new parameter string
361: my $result=&Apache::lonparmset::storeparm_by_symb($symb,
362: '0_availablestudent',
363: 1, $new_param, 'string',
364: $uname,$udom);
365: my $description=&get_description($env{'form.slotname'},\%slot);
366: $r->print("<p>Released Reservation: $description</p>");
367: if ($mgr eq 'F') {
368: $r->print('<p><a href="/adm/slotrequest?command=showslots">'.
369: &mt('Return to slot list').'</a></p>');
370: }
371: if (!$inhibit_return_link) { &return_link($r); }
372: return 1;
373: }
374:
375: sub delete_slot {
376: my ($r)=@_;
377:
378: my $slot_name = $env{'form.slotname'};
379: my %slot=&Apache::lonnet::get_slot($slot_name);
380:
381: my ($cnum,$cdom)=&get_course();
382: my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum,
383: "^$slot_name\0");
384: my ($tmp) = %consumed;
385: if ($tmp =~ /error: 2/) { undef(%consumed); }
386:
387: if (%slot && !%consumed) {
388: $slot{'type'} = 'deleted';
389: my $ret = &Apache::lonnet::cput('slots', {$slot_name => \%slot},
390: $cdom, $cnum);
391: if ($ret eq 'ok') {
392: $r->print("<p>Slot <tt>$slot_name</tt> marked as deleted.</p>");
393: } else {
394: $r->print("<p> An error ($ret) occurse when attempting to delete Slot <tt>$slot_name</tt>.</p>");
395: }
396: } else {
397: if (%consumed) {
398: $r->print("<p>Slot <tt>$slot_name</tt> has active reservations.</p>");
399: } else {
400: $r->print("<p>Slot <tt>$slot_name</tt> does not exist.</p>");
401: }
402: }
403: $r->print('<p><a href="/adm/slotrequest?command=showslots">'.
404: &mt('Return to slot list').'</a></p>');
405: &return_link($r);
406: }
407:
408: sub return_link {
409: my ($r) = @_;
410: $r->print('<p><a href="/adm/flip?postdata=return:">'.
411: &mt('Return to last resource').'</a></p>');
412: }
413:
414: sub get_slot {
415: my ($r,$symb)=@_;
416:
417: my %slot=&Apache::lonnet::get_slot($env{'form.slotname'});
418: my $slot_name=&check_for_conflict($symb,$env{'form.slotname'},\%slot);
419:
420: if ($slot_name =~ /^error: (.*)/) {
421: $r->print("<p>An error occured while attempting to make a reservation. ($1)</p>");
422: &return_link($r);
423: return;
424: }
425: if ($slot_name) {
426: my %slot=&Apache::lonnet::get_slot($slot_name);
427: my $description1=&get_description($slot_name,\%slot);
428: %slot=&Apache::lonnet::get_slot($env{'form.slotname'});
429: my $description2=&get_description($env{'form.slotname'},\%slot);
430: $r->print("<p>Already have a reservation: $description1</p>");
431: if ($slot_name ne $env{'form.slotname'}) {
432: $r->print(<<STUFF);
433: <form method="POST" action="/adm/slotrequest">
434: <input type="hidden" name="symb" value="$env{'form.symb'}" />
435: <input type="hidden" name="slotname" value="$env{'form.slotname'}" />
436: <input type="hidden" name="releaseslot" value="$slot_name" />
437: <input type="hidden" name="command" value="change" />
438: STUFF
439: $r->print("<p>You can either ");
440: $r->print(<<STUFF);
441: <input type="submit" name="change" value="Change" />
442: STUFF
443: $r->print(' your reservation from <b>'.$description1.'</b> to <b>'.
444: $description2.
445: '</b> <br />or </p>');
446: &return_link($r);
447: $r->print(<<STUFF);
448: </form>
449: STUFF
450: } else {
451: &return_link($r);
452: }
453: return;
454: }
455: my %slot=&Apache::lonnet::get_slot($env{'form.slotname'});
456: my $reserved=&make_reservation($env{'form.slotname'},
457: \%slot,$symb);
458: my $description=&get_description($env{'form.slotname'},\%slot);
459: if (defined($reserved)) {
460: if ($slot_name =~ /^error: (.*)/) {
461: $r->print("<p>An error occured while attempting to make a reservation. ($1)</p>");
462: } elsif ($reserved > -1) {
463: $r->print("<p>Success: $description</p>");
464: } elsif ($reserved < 0) {
465: $r->print("<p>Already reserved: $description</p>");
466: }
467: &return_link($r);
468: return;
469: }
470:
471: my %lt=('request'=>"Availibility list",
472: 'try' =>'Try again');
473: %lt=&Apache::lonlocal::texthash(%lt);
474:
475: $r->print(<<STUFF);
476: <p> <font color="red">Failed</font> to reserve a spot for $description. </p>
477: <p>
478: <form method="POST" action="/adm/slotrequest">
479: <input type="submit" name="Try Again" value="$lt{'try'}" />
480: <input type="hidden" name="symb" value="$env{'form.symb'}" />
481: <input type="hidden" name="slotname" value="$env{'form.slotname'}" />
482: <input type="hidden" name="command" value="get" />
483: </form>
484: ?
485: </p>
486: <p>
487: or
488: <form method="POST" action="/adm/slotrequest">
489: <input type="hidden" name="symb" value="$env{'form.symb'}" />
490: <input type="submit" name="requestattempt" value="$lt{'request'}" />
491: </form>
492: </p>
493: or
494: STUFF
495:
496: &return_link($r);
497: return;
498: }
499:
500: sub allowed_slot {
501: my ($slot_name,$slot,$symb,$slots)=@_;
502: #already started
503: if ($slot->{'starttime'} < time) {
504: # all open slot to be schedulable
505: #return 0;
506: }
507: &Apache::lonxml::debug("$slot_name starttime good");
508: #already ended
509: if ($slot->{'endtime'} < time) {
510: return 0;
511: }
512: &Apache::lonxml::debug("$slot_name endtime good");
513: # not allowed to pick this one
514: if (defined($slot->{'type'})
515: && $slot->{'type'} ne 'schedulable_student') {
516: return 0;
517: }
518: &Apache::lonxml::debug("$slot_name type good");
519: # not allowed for this resource
520: if (defined($slot->{'symb'})
521: && $slot->{'symb'} ne $symb) {
522: return 0;
523: }
524: my $conflict = &check_for_conflict($symb,$slot_name,$slot,$slots);
525: if ($conflict) {
526: if ($slots->{$conflict}{'starttime'} < time) {
527: return 0;
528: }
529: }
530: &Apache::lonxml::debug("$slot_name symb good");
531: return 1;
532: }
533:
534: sub get_description {
535: my ($slot_name,$slot)=@_;
536: my $description=$slot->{'description'};
537: if (!defined($description)) {
538: $description=&mt('[_1] From [_2] to [_3]',$slot_name,
539: &Apache::lonlocal::locallocaltime($slot->{'starttime'}),
540: &Apache::lonlocal::locallocaltime($slot->{'endtime'}));
541: }
542: return $description;
543: }
544:
545: sub show_choices {
546: my ($r,$symb)=@_;
547:
548: my ($cnum,$cdom)=&get_course();
549: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
550: my $available;
551: $r->print('<table border="1">');
552: &Apache::lonxml::debug("Checking Slots");
553: my @got_slots=&check_for_reservation($symb,'allslots');
554: foreach my $slot (sort
555: { return $slots{$a}->{'starttime'} <=> $slots{$b}->{'starttime'} }
556: (keys(%slots))) {
557:
558: &Apache::lonxml::debug("Checking Slot $slot");
559: next if (!&allowed_slot($slot,$slots{$slot},undef,\%slots));
560:
561: $available++;
562:
563: my $description=&get_description($slot,$slots{$slot});
564:
565: my $form=&mt('Unavailable');
566: if ((grep(/^\Q$slot\E$/,@got_slots)) ||
567: &space_available($slot,$slots{$slot},$symb)) {
568: my $text=&mt('Select');
569: my $command='get';
570: if (grep(/^\Q$slot\E$/,@got_slots)) {
571: $text=&mt('Free Reservation');
572: $command='release';
573: } else {
574: my $conflict = &check_for_conflict($symb,$slot,$slots{$slot},
575: \%slots);
576: if ($conflict) {
577: $text=&mt('Change Reservation');
578: $command='get';
579: }
580: }
581: my $escsymb=&Apache::lonnet::escape($symb);
582: $form=<<STUFF;
583: <form method="POST" action="/adm/slotrequest">
584: <input type="submit" name="Select" value="$text" />
585: <input type="hidden" name="symb" value="$escsymb" />
586: <input type="hidden" name="slotname" value="$slot" />
587: <input type="hidden" name="command" value="$command" />
588: </form>
589: STUFF
590: }
591: $r->print(<<STUFF);
592: <tr>
593: <td>$form</td>
594: <td>$description</td>
595: </tr>
596: STUFF
597: }
598:
599: if (!$available) {
600: $r->print('<tr><td>No available times. <a href="/adm/flip?postdata=return:">'.
601: &mt('Return to last resource').'</a></td></tr>');
602: }
603: $r->print('</table>');
604: }
605:
606: sub to_show {
607: my ($slot,$when,$deleted) = @_;
608: my $time=time;
609: my $week=60*60*24*7;
610: if ($deleted eq 'hide' && $slot->{'type'} eq 'deleted') {
611: return 0;
612: }
613: if ($when eq 'any') {
614: return 1;
615: } elsif ($when eq 'now') {
616: if ($time > $slot->{'starttime'} &&
617: $time < $slot->{'endtime'}) {
618: return 1;
619: }
620: return 0;
621: } elsif ($when eq 'nextweek') {
622: if ( ($time < $slot->{'starttime'} &&
623: ($time+$week) > $slot->{'starttime'})
624: ||
625: ($time < $slot->{'endtime'} &&
626: ($time+$week) > $slot->{'endtime'}) ) {
627: return 1;
628: }
629: return 0;
630: } elsif ($when eq 'lastweek') {
631: if ( ($time > $slot->{'starttime'} &&
632: ($time-$week) < $slot->{'starttime'})
633: ||
634: ($time > $slot->{'endtime'} &&
635: ($time-$week) < $slot->{'endtime'}) ) {
636: return 1;
637: }
638: return 0;
639: } elsif ($when eq 'willopen') {
640: if ($time < $slot->{'starttime'}) {
641: return 1;
642: }
643: return 0;
644: } elsif ($when eq 'wereopen') {
645: if ($time > $slot->{'endtime'}) {
646: return 1;
647: }
648: return 0;
649: }
650:
651: return 1;
652: }
653:
654: sub remove_link {
655: my ($slotname,$entry,$uname,$udom,$symb) = @_;
656:
657: $slotname = &Apache::lonnet::escape($slotname);
658: $entry = &Apache::lonnet::escape($entry);
659: $uname = &Apache::lonnet::escape($uname);
660: $udom = &Apache::lonnet::escape($udom);
661: $symb = &Apache::lonnet::escape($symb);
662:
663: my $remove= &mt('Remove');
664:
665: return <<"END_LINK";
666: <a href="/adm/slotrequest?command=remove_registration&slotname=$slotname&entry=$entry&uname=$uname&udom=$udom&symb=$symb"
667: >($remove)</a>
668: END_LINK
669:
670: }
671:
672: sub show_table {
673: my ($r,$mgr)=@_;
674:
675: my ($cnum,$cdom)=&get_course();
676: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
677: if ( (keys(%slots))[0] =~ /^error: 2 /) {
678: undef(%slots);
679: }
680: my $available;
681: if ($mgr eq 'F') {
682: $r->print('<div>');
683: $r->print('<form method="POST" action="/adm/slotrequest">
684: <input type="hidden" name="command" value="uploadstart" />
685: <input type="submit" name="start" value="'.&mt('Upload Slot List').'" />
686: </form>');
687: $r->print('<form method="POST" action="/adm/helper/newslot.helper">
688: <input type="submit" name="newslot" value="'.&mt('Create a New Slot').'" />
689: </form>');
690: $r->print('</div>');
691: }
692:
693: my %Saveable_Parameters = ('show' => 'array',
694: 'when' => 'scalar',
695: 'order' => 'scalar',
696: 'deleted' => 'scalar',
697: );
698: &Apache::loncommon::store_course_settings('slotrequest',\%Saveable_Parameters);
699: &Apache::loncommon::restore_course_settings('slotrequest',\%Saveable_Parameters);
700:
701: my %show_fields=&Apache::lonlocal::texthash(
702: 'name' => 'Slot Name',
703: 'description' => 'Description',
704: 'type' => 'Type',
705: 'starttime' => 'Start time',
706: 'endtime' => 'End Time',
707: 'startreserve' => 'Time students can start reserving',
708: 'secret' => 'Secret Word',
709: 'maxspace' => 'Maximum # of students',
710: 'ip' => 'IP or DNS restrictions',
711: 'symb' => 'Resource slot is restricted to.',
712: 'uniqueperiod' => 'Period of time slot is unique',
713: 'proctor' => 'List of proctors');
714: my @show_order=('name','description','type','starttime','endtime',
715: 'startreserve','secret','maxspace','ip','symb',
716: 'uniqueperiod','proctor');
717: my @show =
718: (exists($env{'form.show'})) ? &Apache::loncommon::get_env_multiple('form.show')
719: : keys(%show_fields);
720: my %show = map { $_ => 1 } (@show);
721:
722: my %when_fields=&Apache::lonlocal::texthash(
723: 'now' => 'Open now',
724: 'nextweek' => 'Open within the next week',
725: 'lastweek' => 'Were open last week',
726: 'willopen' => 'Will open later',
727: 'wereopen' => 'Were open',
728: 'any' => 'Anytime',
729: );
730: my @when_order=('any','now','nextweek','lastweek','willopen','wereopen');
731: $when_fields{'select_form_order'} = \@when_order;
732: my $when = (exists($env{'form.when'})) ? $env{'form.when'}
733: : 'now';
734:
735: my $hide_radio =
736: &Apache::lonhtmlcommon::radio('deleted',$env{'form.deleted'},'hide');
737: my $show_radio =
738: &Apache::lonhtmlcommon::radio('deleted',$env{'form.deleted'},'show');
739:
740: $r->print('<form method="POST" action="/adm/slotrequest">
741: <input type="hidden" name="command" value="showslots" />');
742: $r->print('<div>');
743: $r->print('<table class="inline">
744: <tr><th>'.&mt('Show').'</th>
745: <th>'.&mt('Open').'</th>
746: <th>'.&mt('Options').'</th>
747: </tr>
748: <tr><td>'.&Apache::loncommon::multiple_select_form('show',\@show,6,\%show_fields,\@show_order).
749: '</td>
750: <td>'.&Apache::loncommon::select_form($when,'when',%when_fields).
751: '</td>
752: <td>
753: <table>
754: <tr>
755: <td rowspan="2">Deleted slots:</td>
756: <td><label>'.$show_radio.'Show</label></td>
757: </tr>
758: <tr>
759: <td><label>'.$hide_radio.'Hide</label></td>
760: </tr>
761: </table>
762: </td>
763: </tr>
764: </table>');
765: $r->print('</div>');
766: $r->print('<p><input type="submit" name="start" value="'.&mt('Update Display').'" /></p>');
767: my $linkstart='<a href="/adm/slotrequest?command=showslots&order=';
768: $r->print('<table class="thinborder">
769: <tr>
770: <th></th>');
771: foreach my $which (@show_order) {
772: if ($which ne 'proctor' && exists($show{$which})) {
773: $r->print('<th>'.$linkstart.$which.'">'.$show_fields{$which}.'</a></th>');
774: }
775: }
776: $r->print('<th>Scheduled Students</th></tr>');
777:
778: my %name_cache;
779: my $slotsort = sub {
780: if ($env{'form.order'}=~/^(type|description|endtime|startreserve|maxspace|ip|symb)$/) {
781: if (lc($slots{$a}->{$env{'form.order'}})
782: ne lc($slots{$b}->{$env{'form.order'}})) {
783: return (lc($slots{$a}->{$env{'form.order'}})
784: cmp lc($slots{$b}->{$env{'form.order'}}));
785: }
786: } elsif ($env{'form.order'} eq 'name') {
787: if (lc($a) cmp lc($b)) {
788: return lc($a) cmp lc($b);
789: }
790: } elsif ($env{'form.order'} eq 'uniqueperiod') {
791:
792: if ($slots{$a}->{'uniqueperiod'}[0]
793: ne $slots{$b}->{'uniqueperiod'}[0]) {
794: return ($slots{$a}->{'uniqueperiod'}[0]
795: cmp $slots{$b}->{'uniqueperiod'}[0]);
796: }
797: if ($slots{$a}->{'uniqueperiod'}[1]
798: ne $slots{$b}->{'uniqueperiod'}[1]) {
799: return ($slots{$a}->{'uniqueperiod'}[1]
800: cmp $slots{$b}->{'uniqueperiod'}[1]);
801: }
802: }
803: return $slots{$a}->{'starttime'} <=> $slots{$b}->{'starttime'};
804: };
805: foreach my $slot (sort $slotsort (keys(%slots))) {
806: if (!&to_show($slots{$slot},$when,$env{'form.deleted'})) { next; }
807: if (defined($slots{$slot}->{'type'})
808: && $slots{$slot}->{'type'} ne 'schedulable_student') {
809: #next;
810: }
811: my $description=&get_description($slot,$slots{$slot});
812: my %consumed=&Apache::lonnet::dump('slot_reservations',$cdom,$cnum,
813: "^$slot\0");
814: my $ids;
815:
816: my ($tmp)=%consumed;
817: if ($tmp !~ /^error: /) {
818: foreach my $entry (sort(keys(%consumed))) {
819: my (undef,$id)=split("\0",$entry);
820: my ($uname,$udom) = split('@',$consumed{$entry}{'name'});
821: my $name = &Apache::loncommon::plainname($uname,$udom);
822: $ids.= '<nobr>'.$name.&remove_link($slot,$entry,$uname,$udom,
823: $consumed{$entry}{'symb'})
824: .'</nobr><br />';
825: }
826: }
827:
828: my $start=($slots{$slot}->{'starttime'}?
829: &Apache::lonlocal::locallocaltime($slots{$slot}->{'starttime'}):'');
830: my $end=($slots{$slot}->{'endtime'}?
831: &Apache::lonlocal::locallocaltime($slots{$slot}->{'endtime'}):'');
832: my $start_reserve=($slots{$slot}->{'startreserve'}?
833: &Apache::lonlocal::locallocaltime($slots{$slot}->{'startreserve'}):'');
834:
835: my $unique;
836: if (ref($slots{$slot}{'uniqueperiod'})) {
837: $unique=localtime($slots{$slot}{'uniqueperiod'}[0]).','.
838: localtime($slots{$slot}{'uniqueperiod'}[1]);
839: }
840:
841: my $title;
842: if (exists($slots{$slot}{'symb'})) {
843: my (undef,undef,$res)=
844: &Apache::lonnet::decode_symb($slots{$slot}{'symb'});
845: $res = &Apache::lonnet::clutter($res);
846: $title = &Apache::lonnet::gettitle($slots{$slot}{'symb'});
847: $title='<a href="'.$res.'?symb='.$slots{$slot}{'symb'}.'">'.$title.'</a>';
848: }
849:
850: my @proctors;
851: my $rowspan=1;
852: my $colspan=1;
853: if (exists($show{'proctor'})) {
854: $rowspan=2;
855: @proctors= map {
856: my ($uname,$udom)=split(/@/,$_);
857: my $fullname=$name_cache{$_};
858: if (!defined($fullname)) {
859: &Apache::lonnet::logthis("Gettign $uname $udom");
860: $fullname = &Apache::loncommon::plainname($uname,$udom);
861: $fullname =~s/\s/ /g;
862: $name_cache{$_} = $fullname;
863: }
864: &Apache::loncommon::aboutmewrapper($fullname,$uname,$udom);
865: } (sort(split(/\s*,\s*/,$slots{$slot}->{'proctor'})));
866: }
867: my $proctors=join(', ',@proctors);
868:
869: my $edit=(<<"EDITLINK");
870: <a href="/adm/helper/newslot.helper?name=$slot">Edit</a>
871: EDITLINK
872:
873: my $delete=(<<"DELETELINK");
874: <a href="/adm/slotrequest?command=delete&slotname=$slot">Delete</a>
875: DELETELINK
876: if ($ids ne '') { undef($delete); }
877:
878: $r->print("<tr>\n<td rowspan=\"$rowspan\">$edit $delete</td>\n");
879: if (exists($show{'name'})) {
880: $colspan++;$r->print("<td>$slot</td>");
881: }
882: if (exists($show{'description'})) {
883: $colspan++;$r->print("<td>$description</td>\n");
884: }
885: if (exists($show{'type'})) {
886: $colspan++;$r->print("<td>$slots{$slot}->{'type'}</td>\n");
887: }
888: if (exists($show{'starttime'})) {
889: $colspan++;$r->print("<td>$start</td>\n");
890: }
891: if (exists($show{'endtime'})) {
892: $colspan++;$r->print("<td>$end</td>\n");
893: }
894: if (exists($show{'startreserve'})) {
895: $colspan++;$r->print("<td>$start_reserve</td>\n");
896: }
897: if (exists($show{'secret'})) {
898: $colspan++;$r->print("<td>$slots{$slot}{'secret'}</td>\n");
899: }
900: if (exists($show{'maxspace'})) {
901: $colspan++;$r->print("<td>$slots{$slot}{'maxspace'}</td>\n");
902: }
903: if (exists($show{'ip'})) {
904: $colspan++;$r->print("<td>$slots{$slot}{'ip'}</td>\n");
905: }
906: if (exists($show{'symb'})) {
907: $colspan++;$r->print("<td>$title</td>\n");
908: }
909: if (exists($show{'uniqueperiod'})) {
910: $colspan++;$r->print("<td>$unique</td>\n");
911: }
912: $colspan++;$r->print("<td>$ids</td>\n</tr>\n");
913: if (exists($show{'proctor'})) {
914: $r->print(<<STUFF);
915: <tr>
916: <td colspan="$colspan">$proctors</td>
917: </tr>
918: STUFF
919: }
920: }
921: $r->print('</table>');
922: }
923:
924: sub upload_start {
925: my ($r)=@_;
926: $r->print(&Apache::grades::checkforfile_js());
927: my $result.='<table width=100% border=0><tr bgcolor="#e6ffff"><td>'."\n";
928: $result.=' <b>'.
929: &mt('Specify a file containing the slot definitions.').
930: '</b></td></tr>'."\n";
931: $result.='<tr bgcolor=#ffffe6><td>'."\n";
932: my $upfile_select=&Apache::loncommon::upfile_select_html();
933: my $ignore=&mt('Ignore First Line');
934: $result.=<<ENDUPFORM;
935: <form method="post" enctype="multipart/form-data" action="/adm/slotrequest" name="slotupload">
936: <input type="hidden" name="command" value="csvuploadmap" />
937: $upfile_select
938: <br /><input type="button" onClick="javascript:checkUpload(this.form);" value="Upload Data" />
939: <label><input type="checkbox" name="noFirstLine" />$ignore</label>
940: </form>
941: ENDUPFORM
942: $result.='</td></tr></table>'."\n";
943: $result.='</td></tr></table>'."\n";
944: $r->print($result);
945: }
946:
947: sub csvuploadmap_header {
948: my ($r,$datatoken,$distotal)= @_;
949: my $javascript;
950: if ($env{'form.upfile_associate'} eq 'reverse') {
951: $javascript=&csvupload_javascript_reverse_associate();
952: } else {
953: $javascript=&csvupload_javascript_forward_associate();
954: }
955:
956: my $checked=(($env{'form.noFirstLine'})?' checked="checked"':'');
957: my $ignore=&mt('Ignore First Line');
958: $r->print(<<ENDPICK);
959: <form method="post" enctype="multipart/form-data" action="/adm/slotrequest" name="slotupload">
960: <h3>Identify fields</h3>
961: Total number of records found in file: $distotal <hr />
962: Enter as many fields as you can. The system will inform you and bring you back
963: to this page if the data selected is insufficient to create the slots.<hr />
964: <input type="button" value="Reverse Association" onClick="javascript:this.form.associate.value='Reverse Association';submit(this.form);" />
965: <label><input type="checkbox" name="noFirstLine" $checked />$ignore</label>
966: <input type="hidden" name="associate" value="" />
967: <input type="hidden" name="datatoken" value="$datatoken" />
968: <input type="hidden" name="fileupload" value="$env{'form.fileupload'}" />
969: <input type="hidden" name="upfiletype" value="$env{'form.upfiletype'}" />
970: <input type="hidden" name="upfile_associate"
971: value="$env{'form.upfile_associate'}" />
972: <input type="hidden" name="command" value="csvuploadassign" />
973: <hr />
974: <script type="text/javascript" language="Javascript">
975: $javascript
976: </script>
977: ENDPICK
978: return '';
979:
980: }
981:
982: sub csvuploadmap_footer {
983: my ($request,$i,$keyfields) =@_;
984: $request->print(<<ENDPICK);
985: </table>
986: <input type="hidden" name="nfields" value="$i" />
987: <input type="hidden" name="keyfields" value="$keyfields" />
988: <input type="button" onClick="javascript:verify(this.form)" value="Create Slots" /><br />
989: </form>
990: ENDPICK
991: }
992:
993: sub csvupload_javascript_reverse_associate {
994: my $error1=&mt('You need to specify the name, starttime, endtime and a type');
995: return(<<ENDPICK);
996: function verify(vf) {
997: var foundstart=0;
998: var foundend=0;
999: var foundname=0;
1000: var foundtype=0;
1001: for (i=0;i<=vf.nfields.value;i++) {
1002: tw=eval('vf.f'+i+'.selectedIndex');
1003: if (i==0 && tw!=0) { foundname=1; }
1004: if (i==1 && tw!=0) { foundtype=1; }
1005: if (i==2 && tw!=0) { foundstat=1; }
1006: if (i==3 && tw!=0) { foundend=1; }
1007: }
1008: if (foundstart==0 && foundend==0 && foundtype==0 && foundname==0) {
1009: alert('$error1');
1010: return;
1011: }
1012: vf.submit();
1013: }
1014: function flip(vf,tf) {
1015: }
1016: ENDPICK
1017: }
1018:
1019: sub csvupload_javascript_forward_associate {
1020: my $error1=&mt('You need to specify the name, starttime, endtime and a type');
1021: return(<<ENDPICK);
1022: function verify(vf) {
1023: var foundstart=0;
1024: var foundend=0;
1025: var foundname=0;
1026: var foundtype=0;
1027: for (i=0;i<=vf.nfields.value;i++) {
1028: tw=eval('vf.f'+i+'.selectedIndex');
1029: if (tw==1) { foundname=1; }
1030: if (tw==2) { foundtype=1; }
1031: if (tw==3) { foundstat=1; }
1032: if (tw==4) { foundend=1; }
1033: }
1034: if (foundstart==0 && foundend==0 && foundtype==0 && foundname==0) {
1035: alert('$error1');
1036: return;
1037: }
1038: vf.submit();
1039: }
1040: function flip(vf,tf) {
1041: }
1042: ENDPICK
1043: }
1044:
1045: sub csv_upload_map {
1046: my ($r)= @_;
1047:
1048: my $datatoken;
1049: if (!$env{'form.datatoken'}) {
1050: $datatoken=&Apache::loncommon::upfile_store($r);
1051: } else {
1052: $datatoken=$env{'form.datatoken'};
1053: &Apache::loncommon::load_tmp_file($r);
1054: }
1055: my @records=&Apache::loncommon::upfile_record_sep();
1056: if ($env{'form.noFirstLine'}) { shift(@records); }
1057: &csvuploadmap_header($r,$datatoken,$#records+1);
1058: my ($i,$keyfields);
1059: if (@records) {
1060: my @fields=&csvupload_fields();
1061:
1062: if ($env{'form.upfile_associate'} eq 'reverse') {
1063: &Apache::loncommon::csv_print_samples($r,\@records);
1064: $i=&Apache::loncommon::csv_print_select_table($r,\@records,
1065: \@fields);
1066: foreach (@fields) { $keyfields.=$_->[0].','; }
1067: chop($keyfields);
1068: } else {
1069: unshift(@fields,['none','']);
1070: $i=&Apache::loncommon::csv_samples_select_table($r,\@records,
1071: \@fields);
1072: my %sone=&Apache::loncommon::record_sep($records[0]);
1073: $keyfields=join(',',sort(keys(%sone)));
1074: }
1075: }
1076: &csvuploadmap_footer($r,$i,$keyfields);
1077:
1078: return '';
1079: }
1080:
1081: sub csvupload_fields {
1082: return (['name','Slot name'],
1083: ['type','Type of slot'],
1084: ['starttime','Start Time of slot'],
1085: ['endtime','End Time of slot'],
1086: ['startreserve','Reservation Start Time'],
1087: ['ip','IP or DNS restriction'],
1088: ['proctor','List of proctor ids'],
1089: ['description','Slot Description'],
1090: ['maxspace','Maximum number of reservations'],
1091: ['symb','Resource Restriction'],
1092: ['uniqueperiod','Date range of slot exclusion'],
1093: ['secret','Secret word proctor uses to validate']);
1094: }
1095:
1096: sub csv_upload_assign {
1097: my ($r,$mgr)= @_;
1098: &Apache::loncommon::load_tmp_file($r);
1099: my @slotdata = &Apache::loncommon::upfile_record_sep();
1100: if ($env{'form.noFirstLine'}) { shift(@slotdata); }
1101: my %fields=&Apache::grades::get_fields();
1102: $r->print('<h3>Creating Slots</h3>');
1103: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
1104: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1105: my $countdone=0;
1106: my @errors;
1107: foreach my $slot (@slotdata) {
1108: my %slot;
1109: my %entries=&Apache::loncommon::record_sep($slot);
1110: my $domain;
1111: my $name=$entries{$fields{'name'}};
1112: if ($name=~/^\s*$/) {
1113: push(@errors,"Did not create slot with no name");
1114: next;
1115: }
1116: if ($name=~/\s/) {
1117: push(@errors,"$name not created -- Name must not contain spaces");
1118: next;
1119: }
1120: if ($name=~/\W/) {
1121: push(@errors,"$name not created -- Name must contain only letters, numbers and _");
1122: next;
1123: }
1124: if ($entries{$fields{'type'}}) {
1125: $slot{'type'}=$entries{$fields{'type'}};
1126: } else {
1127: $slot{'type'}='preassigned';
1128: }
1129: if ($slot{'type'} ne 'preassigned' &&
1130: $slot{'type'} ne 'schedulable_student') {
1131: push(@errors,"$name not created -- invalid type ($slot{'type'}) must be either preassigned or schedulable_student");
1132: next;
1133: }
1134: if ($entries{$fields{'starttime'}}) {
1135: $slot{'starttime'}=&UnixDate($entries{$fields{'starttime'}},"%s");
1136: }
1137: if ($entries{$fields{'endtime'}}) {
1138: $slot{'endtime'}=&UnixDate($entries{$fields{'endtime'}},"%s");
1139: }
1140: if ($entries{$fields{'startreserve'}}) {
1141: $slot{'startreserve'}=
1142: &UnixDate($entries{$fields{'startreserve'}},"%s");
1143: }
1144: foreach my $key ('ip','proctor','description','maxspace',
1145: 'secret','symb') {
1146: if ($entries{$fields{$key}}) {
1147: $slot{$key}=$entries{$fields{$key}};
1148: }
1149: }
1150: if ($entries{$fields{'uniqueperiod'}}) {
1151: my ($start,$end)=split(',',$entries{$fields{'uniqueperiod'}});
1152: my @times=(&UnixDate($start,"%s"),
1153: &UnixDate($end,"%s"));
1154: $slot{'uniqueperiod'}=\@times;
1155: }
1156:
1157: &Apache::lonnet::cput('slots',{$name=>\%slot},$cdom,$cname);
1158: $r->print('.');
1159: $r->rflush();
1160: $countdone++;
1161: }
1162: $r->print("<p>Created $countdone slots\n</p>");
1163: foreach my $error (@errors) {
1164: $r->print("<p>$error\n</p>");
1165: }
1166: &show_table($r,$mgr);
1167: return '';
1168: }
1169:
1170: sub handler {
1171: my $r=shift;
1172:
1173: &Apache::loncommon::content_type($r,'text/html');
1174: &Apache::loncommon::no_cache($r);
1175: if ($r->header_only()) {
1176: $r->send_http_header();
1177: return OK;
1178: }
1179:
1180: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'});
1181:
1182: my $vgr=&Apache::lonnet::allowed('vgr',$env{'request.course.id'});
1183: my $mgr=&Apache::lonnet::allowed('mgr',$env{'request.course.id'});
1184: my $title='Requesting Another Worktime';
1185: if ($env{'form.command'} =~ /^(showslots|uploadstart|csvuploadmap|csvuploadassign)$/ && $vgr eq 'F') {
1186: $title = 'Managing Slots';
1187: }
1188: &start_page($r,$title);
1189:
1190: if ($env{'form.command'} eq 'showslots' && $vgr eq 'F') {
1191: &show_table($r,$mgr);
1192: } elsif ($env{'form.command'} eq 'remove_registration' && $mgr eq 'F') {
1193: &remove_registration($r);
1194: } elsif ($env{'form.command'} eq 'release' && $mgr eq 'F') {
1195: &release_slot($r,undef,undef,undef,$mgr);
1196: } elsif ($env{'form.command'} eq 'delete' && $mgr eq 'F') {
1197: &delete_slot($r);
1198: } elsif ($env{'form.command'} eq 'uploadstart' && $mgr eq 'F') {
1199: &upload_start($r);
1200: } elsif ($env{'form.command'} eq 'csvuploadmap' && $mgr eq 'F') {
1201: &csv_upload_map($r);
1202: } elsif ($env{'form.command'} eq 'csvuploadassign' && $mgr eq 'F') {
1203: if ($env{'form.associate'} ne 'Reverse Association') {
1204: &csv_upload_assign($r,$mgr);
1205: } else {
1206: if ( $env{'form.upfile_associate'} ne 'reverse' ) {
1207: $env{'form.upfile_associate'} = 'reverse';
1208: } else {
1209: $env{'form.upfile_associate'} = 'forward';
1210: }
1211: &csv_upload_map($r);
1212: }
1213: } else {
1214: my $symb=&Apache::lonnet::unescape($env{'form.symb'});
1215: my (undef,undef,$res)=&Apache::lonnet::decode_symb($symb);
1216: my $useslots = &Apache::lonnet::EXT("resource.0.useslots",$symb);
1217: if ($useslots ne 'resource') {
1218: &fail($r,'not_valid');
1219: return OK;
1220: }
1221: $env{'request.symb'}=$symb;
1222: my $type = ($res =~ /\.task$/) ? 'Task'
1223: : 'problem';
1224: my ($status) = &Apache::lonhomework::check_slot_access('0',$type);
1225: if ($status eq 'CAN_ANSWER' ||
1226: $status eq 'NEEDS_CHECKIN' ||
1227: $status eq 'WAITING_FOR_GRADE') {
1228: &fail($r,'not_allowed');
1229: return OK;
1230: }
1231: if ($env{'form.requestattempt'}) {
1232: &show_choices($r,$symb);
1233: } elsif ($env{'form.command'} eq 'release') {
1234: &release_slot($r,$symb);
1235: } elsif ($env{'form.command'} eq 'get') {
1236: &get_slot($r,$symb);
1237: } elsif ($env{'form.command'} eq 'change') {
1238: if (&release_slot($r,$symb,$env{'form.releaseslot'},1)) {
1239: &get_slot($r,$symb);
1240: }
1241: } else {
1242: $r->print("<p>Unknown command: ".$env{'form.command'}."</p>");
1243: }
1244: }
1245: &end_page($r);
1246: return OK;
1247: }
1248:
1249: 1;
1250: __END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>