Annotation of loncom/interface/lonselstudent.pm, revision 1.12
1.1 foxr 1: # The LearningOnline Network with CAPA
2: # lonselstudent.pm : Reusable subs for student selection.
3: #
1.12 ! bisitz 4: # $Id: lonselstudent.pm,v 1.11 2007/11/01 20:04:17 albertel Exp $
1.1 foxr 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: package Apache::lonselstudent;
30: use Apache::lonnet;
1.10 albertel 31: use Apache::lonlocal;
32: use Apache::loncoursedata();
33: use HTML::Entities();
1.1 foxr 34:
35: #
36: # Utility function used when rendering <student> tags.
37: # This function produces a list references to four
38: # arrays:
39: # (\@course_personel, \@current_members, \@expired_members, \@future_members)
1.7 foxr 40: #
41: #
42: # Parameters;
43: #
44: # restrict - Optional.. if present and defined should be a section name.
45: # The *_members arrays will then only contain people
46: # in that section
47: #
1.1 foxr 48: # Where:
49: # course_personnel - Each element of this array is itself a reference to an array
50: # containing information about a member of the course staff.
51: # current_members - Each element of this array is itself a reference to an
52: # array that contains information about current students in
53: # the course.
54: # expired_members - Each element of this array is itself a reference to an
55: # array that contains information about students whose
56: # status has expired.
57: # future_members - Each element of this arrya is itself a reference to an
58: # array that contains information about students who will
59: # become active at a future date.
60: #
61: # Course personnel elements include:
62: # [0] Last, First of the user.
63: # [1] Role held by the user.
64: # [2] Empty.
65: # [3] Empty
66: # [4] username:domain of the user.
67: #
68: # Student member array elements are:
69: # [0] Last, First of the user.
70: # [1] Status of the user one of ("Active", "Future", or "Expired')
71: # depending on which array the user was put in.
72: # [2] Section the student is in.
73: # [3] Role of the member (student).
74: # [4] username:domain of the user.
75: #
76: sub get_people_in_class {
1.7 foxr 77: my ($section_restriction) = @_;
1.1 foxr 78: my %coursepersonnel = &Apache::lonnet::get_course_adv_roles();
79: #
80: # Enumerate the course_personnel.
81: #
82: my @course_personnel;
1.5 albertel 83: for my $role (sort(keys(%coursepersonnel))) {
84: # extract the names so we can sort them
85: my @people;
86: for my $person (split(/,/, $coursepersonnel{$role})) {
87: my ($uname,$domain) = split(/:/, $person);
88: push(@people, [&Apache::loncommon::plainname($uname,$domain),
89: $uname,$domain]);
90: }
91: @people = sort { $a->[0] cmp $b->[0] } (@people);
1.1 foxr 92:
1.5 albertel 93: for my $person (@people) {
94: push(@course_personnel, [join(':', $person->[1],$person->[2]),
95: $person->[0], '', '', $role]);
1.1 foxr 96: }
97: }
98: # Students must be split into the three categories:
99:
100: my @current_members;
101: my @future_members;
102: my @expired_members;
103:
104: # Indices into the coures data elements.
105:
106: my $section = &Apache::loncoursedata::CL_SECTION();
107: my $fullname = &Apache::loncoursedata::CL_FULLNAME();
108: my $status = &Apache::loncoursedata::CL_STATUS();
109: my $start_date = &Apache::loncoursedata::CL_START();
110:
111:
112: my $classlist = &Apache::loncoursedata::get_classlist();
1.4 albertel 113: my @keys = keys(%{$classlist});
1.11 albertel 114: # Sort by: fullname, username
1.1 foxr 115: @keys = sort {
1.8 albertel 116: lc($classlist->{$a}[$fullname]) cmp lc($classlist->{$b}[$fullname]) ||
117: lc($a) cmp lc($b)
1.4 albertel 118: } (@keys);
1.1 foxr 119:
120:
121:
122:
1.6 albertel 123: for my $user (@keys) {
1.7 foxr 124: if (!$section_restriction ||
125: ($section_restriction eq $classlist->{$user}->[$section])) {
1.1 foxr 126:
1.7 foxr 127: if ( $classlist->{$user}->[$status] eq
128: 'Active') {
129: push(@current_members, [$user, $classlist->{$user}->[$fullname],
1.6 albertel 130: $classlist->{$user}->[$section],
1.7 foxr 131: $classlist->{$user}->[$status], 'Student']);
1.1 foxr 132: } else {
1.7 foxr 133: # Need to figure out if this user is future or
134: # Expired... If the start date is in the future
135: # the user is future...else expired.
136:
137: my $now = time;
138: if ($classlist->{$user}->[$start_date] > $now) {
139: push(@future_members, [$user, $classlist->{$user}->[$fullname],
140: $classlist->{$user}->[$section],
141: "Future", "Student"]);
142: } else {
143: push(@expired_members, [$user,
144: $classlist->{$user}->[$fullname],
145: $classlist->{$user}->[$section],
146: "Expired", "Student"]);
147: }
148:
1.1 foxr 149: }
150: }
151: }
152: return (\@course_personnel,
153: \@current_members,
154: \@expired_members,
155: \@future_members);
156:
157: }
158:
159: #
160: # Utility function used when rendering the <student> tag.
161: # This function renders a segment of course personel
162: # Personel are broken up by the helper into past, current and
163: # future...each one gets is own subpage of selection.
164: # This sub renders one of these pages.
165: # Parameters:
166: # $students - Students in the section. (ref to array of references
167: # to arrays).
1.2 foxr 168: # $formname - Name of the form in which this stuff gets rendered.
1.1 foxr 169: # $formprefix - form path prefix for form element names
170: # This is used to make each form element
171: # so that the segments having to do with each
172: # set of students won't collide.
173: # $defaultusers - reference to a hash containng
174: # the set of users that should be on or off.
175: # $multiselect - True if multiselect allowed.
176: # $resultname - Name of result variable.
177: # $javascript - If true, the javascript to run this is output
178: # This should be true for the first call for a page
179: # and false for all other calls... only matters if
180: # multiselect is true.
181: # Returns:
182: # HTML text to add to the rendering of the helper.
183: #
184: sub render_student_list {
1.2 foxr 185: my ($students, $formname, $formprefix, $defaultusers,
1.1 foxr 186: $multiselect, $resultname, $javascript) = @_;
187:
188: my $result = "";
189:
1.8 albertel 190: # no students so no output
191: return if (!@$students);
192:
1.1 foxr 193: if ($javascript && $multiselect) {
194: $result .= <<SCRIPT;
195: <script type="text/javascript">
196: // <!--
197:
198: function findElement(name) {
199: var i;
200: var ele;
1.2 foxr 201: for(i =0; i < document.forms.$formname.elements.length; i++) {
202: ele = document.forms.$formname.elements[i];
1.1 foxr 203: if(ele.name == name) {
204: return ele;
205: }
206: }
207: return null;
208: }
209: function isStudent(element) {
210: if(element.value.indexOf(":Student") != -1) {
211: return 1;
212: }
213: return 0;
214: }
215: function section(element) {
216: var i;
217: var info;
218: if (element.value.indexOf(':') != -1) {
219: info = element.value.split(':');
220: return info[2];
221: } else {
222: return "";
223: }
224: }
225: function rightSubForm(element, which) {
226: if (element.value.indexOf(which) != -1) {
227: return true;
228: } else {
229: return false;
230: }
231: }
232:
233: function setAllStudents(value, which) {
234: var i;
235: var ele;
1.2 foxr 236: for (i =0; i < document.forms.$formname.elements.length; i++) {
237: ele = document.forms.$formname.elements[i];
1.1 foxr 238: if(isStudent(ele) && rightSubForm(ele, which)) {
239: ele.checked=value;
240: }
241: }
242: }
243: function setAllCoursePersonnel(value, which) {
244: var i;
245: var ele;
1.2 foxr 246: for (i =0; i < document.forms.$formname.elements.length; i++) {
247: ele = document.forms.$formname.elements[i];
1.1 foxr 248: if(!isStudent(ele) && rightSubForm(ele, which)) {
249: ele.checked = value;
250: }
251: }
252: }
253: function setSection(which, value, subform) {
254: var i;
255: var ele;
1.2 foxr 256: for (i =0; i < document.forms.$formname.elements.length; i++) {
257: ele = document.forms.$formname.elements[i];
1.1 foxr 258: if (ele.value.indexOf(':') != -1) {
259: if ((section(ele) == which) && rightSubForm(ele, subform)) {
260: ele.checked = value;
261: }
262: }
263: }
264: }
265:
266: function setCheckboxes(listbox, which, value) {
267: var k;
268: var elem;
269: var what;
270: elem = findElement(listbox);
271: if (elem != null) {
272: for (k = 0; k < elem.length; k++) {
273: if (elem.options[k].selected) {
1.10 albertel 274: what = elem.options[k].value;
275: if (what == 'allstudents') {
1.1 foxr 276: setAllStudents(value, which);
1.10 albertel 277: } else if (what == 'allpersonnel') {
1.1 foxr 278: setAllCoursePersonnel(value, which);
1.10 albertel 279: } else if (what == 'nosection') {
1.1 foxr 280: setSection('',value, which);
281: } else {
282: setSection(what, value, which);
283: }
284: }
285: }
286: }
287: }
288: function selectSections(listbox, which) {
289: setCheckboxes(listbox, which, true);
290:
291: }
292: function unselectSections(listbox, which) {
293: setCheckboxes(listbox, which, false);
294: }
295:
296: // -->
297: </script>
298: SCRIPT
299:
300: }
301:
302: # If multiple selections are allowed, we have a listbox
303: # at the top which allows quick selections from each section
304: # as well as from categories of personnel.
305:
306: if ($multiselect) {
307: # Make a section hash so we can add sections to the choice:
308:
309: my %sections;
310: for my $student (@$students) {
311: my $sect = $student->[2];
312: if ($sect ne "") {
313: $sections{$sect} = 1;
314: }
315: }
316:
317: $result .= '<table><tr><td>';
318:
319: my $size = scalar(keys(%sections));
320: $size += 3; # We have allstudents allpersonel nosection too.
321: if ($size > 5) {
322: $size = 5;
323: }
324: $result .= '<select multiple name="'.$formprefix
325: .'.chosensections" size="'.$size.'">'."\n";
1.10 albertel 326: $result .= '<option value="allstudents">'.&mt('All Students').'</option>';
327: $result .= '<option value="allpersonnel">'.&mt('All Course Personnel').'</option>';
328: $result .= '<option value="nosection">'.&mt('No Section').'</option>';
1.1 foxr 329: $result .= "\n";
330: foreach my $sec (sort {lc($a) cmp lc($b)} (keys(%sections))) {
331: $result .= '<option name="'.$sec.'">'.$sec.'</option>'."\n";
332: }
333: $result .= '</td><td valign="top">';
1.12 ! bisitz 334: $result .= '<input type="button" name="'.$formprefix.'.select" value="'.&mt('Select').'" onclick='
1.1 foxr 335: ."'selectSections(\"$formprefix.chosensections\", \"$formprefix\")'".' /></td>';
336: $result .= '<td valign="top"><input type="button" name="'.$formprefix
1.10 albertel 337: .'.unselect" value="'.&mt('Unselect').'" onclick='.
1.1 foxr 338: "'unselectSections(\"$formprefix.chosensections\", \"$formprefix\")' ".' /></td></tr></table>';
339: }
340:
341: # Now we list the students, but the form element type
342: # will depend on whether or not multiselect is true.
343: # True -> checkboxes.
344: # False -> radiobuttons.
345:
1.3 albertel 346: $result .= &Apache::loncommon::start_data_table();
347: $result .= &Apache::loncommon::start_data_table_header_row();
1.10 albertel 348: $result .= '<th></th><th>'.&mt('Name').'</th>'."\n";
349: $result .= ' <th>'.&mt('Section').'</th>'."\n";
350: $result .= ' <th>'.&mt('Status').'</th>'."\n";
351: $result .= ' <th>'.&mt('Role').'</th>'."\n";
352: $result .= ' <th>'.&mt('Username : Domain').'</th>'."\n";
1.3 albertel 353: $result .= &Apache::loncommon::end_data_table_header_row();
1.1 foxr 354:
355: my $input_type;
356: if ($multiselect) {
357: $input_type = "checkbox";
358: } else {
359: $input_type = "radio";
360: }
361:
362: my $checked = 0;
363: for my $student (@$students) {
1.3 albertel 364: $result .= &Apache::loncommon::start_data_table_row().
365: '<td><input type="'.$input_type.'" name="'.
1.9 raeburn 366: $resultname."_forminput".'"';
1.1 foxr 367: my $user = $student->[0];
368:
369: # Figure out which students are checked by default...
370:
1.4 albertel 371: if (%$defaultusers) {
1.1 foxr 372: if (exists ($defaultusers->{$user})) {
373: $result .= ' checked ="checked" ';
374: $checked = 1;
375: }
376: } elsif (!$multiselect && !$checked) {
377: $result .= ' checked="checked" ';
378: $checked = 1; # First one for radio if no default specified.
379: }
1.4 albertel 380: $result .= ' value="'.&HTML::Entities::encode($user . ':'
381: .$student->[2] . ':'
1.1 foxr 382: .$student->[1] . ':'
383: .$student->[3] . ':'
384: .$student->[4] . ":"
385: .$formprefix, "<>&\"'")
386: ."\" /></td><td>\n";
1.4 albertel 387: $result .= &HTML::Entities::encode($student->[1], '<>&"')
1.1 foxr 388: . '</td><td align="center" >'."\n";
1.4 albertel 389: $result .= &HTML::Entities::encode($student->[2], '<>&"')
1.1 foxr 390: . '</td><td align="center">'."\n";
1.4 albertel 391: $result .= &HTML::Entities::encode($student->[3], '<>&"')
1.1 foxr 392: . '</td><td align="center">'."\n";
1.4 albertel 393: $result .= &HTML::Entities::encode($student->[4], '<>&"')
1.1 foxr 394: . '</td><td align="center">'."\n";
1.4 albertel 395: $result .= &HTML::Entities::encode($student->[0], '<>&"')
1.3 albertel 396: . '</td>'.&Apache::loncommon::end_data_table_row().
397: "\n";
1.1 foxr 398: }
1.3 albertel 399: $result .= &Apache::loncommon::end_data_table().
400: " <br /> <hr />\n";
1.1 foxr 401:
402: return $result;
403: }
404:
405: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonselstudent.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface