Annotation of loncom/interface/lonpickcourse.pm, revision 1.65
1.1 www 1: # The LearningOnline Network
2: # Pick a course
3: #
1.65 ! raeburn 4: # $Id: lonpickcourse.pm,v 1.64 2007/10/03 19:57:29 raeburn Exp $
1.1 www 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::lonpickcourse;
30:
31: use strict;
32: use Apache::Constants qw(:common);
33: use Apache::loncommon;
34: use Apache::loncoursedata;
35: use Apache::lonnet;
1.8 www 36: use Apache::lonlocal;
1.46 raeburn 37: use Apache::longroup;
1.47 www 38: use LONCAPA;
1.1 www 39:
40: sub handler {
41: my $r = shift;
1.8 www 42: &Apache::loncommon::content_type($r,'text/html');
1.1 www 43: $r->send_http_header;
44: return OK if $r->header_only;
45:
46: # ------------------------------------------------------------ Print the screen
1.40 albertel 47:
1.55 raeburn 48: # Get parameters from query string
1.1 www 49: &Apache::loncommon::get_unprocessed_cgi
1.55 raeburn 50: ($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement',
1.19 raeburn 51: 'cdomelement','cnameelement','roleelement',
1.55 raeburn 52: 'multiple','type','setroles']);
1.54 raeburn 53:
1.55 raeburn 54: my ($type,$title,$jscript,$multelement,$multiple,$roleelement,
55: $lastaction,$autosubmit,$submitopener);
56:
1.57 raeburn 57: # Get course type - Course or Non-standard Course.
1.54 raeburn 58: $type = $env{'form.type'};
59: if (!defined($env{'form.type'})) {
60: $type = 'Course';
61: }
62: $title = &mt('Selecting a [_1]',$type);
63:
64: # Setup for multiple course selections, if flag for multiples set.
1.55 raeburn 65: $multiple = $env{'form.multiple'};
66: if ($multiple) {
67: ($jscript,$multelement) = &multiples_tag();
68: $title = &mt('Selecting [_1](s)',lc($type));
1.54 raeburn 69: }
70:
1.55 raeburn 71: # if called when a DC is selecting a course
1.54 raeburn 72: my $roledom = $env{'form.roleelement'};
73: if ($roledom) {
74: $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
75: $submitopener = &Apache::lonroles::processpick();
76: $autosubmit = 'process_pick("'.$roledom.'")';
77: }
78:
79: my $onlyown = 0;
1.55 raeburn 80: # if called to assign course-based portfolio access control
1.59 raeburn 81: if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
1.54 raeburn 82: $onlyown = 1;
1.49 raeburn 83: }
1.55 raeburn 84:
85: my %loaditem;
1.27 albertel 86: if ($env{'form.form'} eq 'cu' && $env{'form.pickedcourse'}) {
1.42 albertel 87: $loaditem{'onload'} ="setSections()";
1.30 raeburn 88: }
1.41 albertel 89: $r->print(&Apache::loncommon::start_page($title,undef,
1.42 albertel 90: {'add_entries' => \%loaditem,
1.41 albertel 91: 'no_nav_bar' => 1, }));
1.55 raeburn 92:
93: if ($env{'form.form'} eq 'portform') {
94: $lastaction = 'document.courselist.submit()';
95: } elsif ($env{'form.form'} eq 'cu') {
96: $lastaction =
97: 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
98: 'document.courselist.submit();';
1.34 albertel 99: } else {
1.55 raeburn 100: $lastaction = 'self.close()';
1.1 www 101: }
1.19 raeburn 102:
1.55 raeburn 103: # if called to assign a role in a course to a user via CUSR
104: if ($env{'form.form'} eq 'cu') {
105: $r->print(&create_user_javascript($type));
106: }
1.54 raeburn 107:
1.55 raeburn 108: # print javascript functions for choosing a course
109: if ($env{'form.gosearch'} || $onlyown) {
1.58 raeburn 110: $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
1.55 raeburn 111: }
112: $r->print('<script type="text/javascript">'.$jscript.'</script>');
113: $r->print($submitopener);
1.54 raeburn 114:
1.55 raeburn 115: # ------------------------------------------ Display of filters to limit search
1.57 raeburn 116: my $filter = {};
117: my $action = '/adm/pickcourse';
1.55 raeburn 118: if (!$onlyown) {
119: my $filterlist = ['domainfilter','descriptfilter',
120: 'instcodefilter','ownerfilter',
121: 'ownerdomfilter'];
122: # course ID filter for DCs only
123: if ($env{'user.adv'} && $env{'form.domainfilter'} &&
124: exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
125: push(@{$filterlist},'coursefilter');
126: }
127: $r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
1.57 raeburn 128: $filter,$action));
1.55 raeburn 129: }
1.54 raeburn 130:
131: # ---------------------------------------------------------------- Get the data
132: if ($env{'form.gosearch'} || $onlyown) {
1.57 raeburn 133: my %courses = &search_courses($r,$type,$onlyown,$filter);
134: &display_matched_courses($r,$type,$multiple,$action,%courses);
1.54 raeburn 135: }
136: $r->print(&Apache::loncommon::end_page());
137: return OK;
138: }
139:
1.55 raeburn 140: sub create_user_javascript {
141: my ($type) = @_;
142: my $output;
143: #javascript for reporting sections and groups then closing
144: if ($env{'form.pickedcourse'}) {
145: my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
146: my $sec_element = 'currsec';
147: my $grplist_element = 'groups';
148: my ($sections,$groups) =
149: &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
150: my $num_sections = scalar(@{$sections});
151: my $seclist = join(',',@{$sections});
152: my $num_groups = scalar(@{$groups});
153: my $groupslist = join(',',@{$groups});
154: $output = qq|
155: <script type="text/javascript">
156: function setSections() {
157: opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
158: window.opener.setSect('$seclist');
159: self.close()
160: }
161: </script>
162: |;
163: ;
164: }
165: return $output;
166: }
167:
1.54 raeburn 168: sub display_matched_courses {
1.57 raeburn 169: my ($r,$type,$multiple,$action,%courses) = @_;
1.55 raeburn 170: if ($env{'form.form'} eq 'portform') {
171: $action = '/adm/portfolio';
172: }
173: $r->print('<form name="courselist" method="post" action="'.$action.'">');
1.54 raeburn 174: my %by_descrip;
175: my $numcourses = keys(%courses);
176: foreach my $course (keys(%courses)) {
177: my $descr;
1.64 raeburn 178: if (ref($courses{$course}) eq 'HASH') {
1.65 ! raeburn 179: $descr = $courses{$course}{'description'};
1.64 raeburn 180: } elsif ($courses{$course} =~ m/^([^:]*):/i) {
1.54 raeburn 181: $descr = &unescape($1);
1.34 albertel 182: } else {
1.54 raeburn 183: $descr = &unescape($courses{$course});
184: }
185: my $description = $descr;
186: push (@{$by_descrip{$description}}, $course);
187: }
188: if ($numcourses > 1 && $multiple) {
189: $r->print('<input type="button" value="check all"
190: onclick="javascript:checkAll(document.courselist.course_id)" />
191: <input type="button" value="uncheck all"
192: onclick="javascript:uncheckAll(document.courselist.course_id)" />
193: <br /><br />');
194: }
195: foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
196: foreach my $course (@{$by_descrip{$description}}) {
197: my $cleandesc=&HTML::Entities::encode($description,'<>&"');
198: $cleandesc=~s/'/\\'/g;
199: my ($cdom,$cnum)=split(/\_/,$course);
1.64 raeburn 200: my ($descr,$instcode,$ttype,@owners);
201: if (ref($courses{$course}) eq 'HASH') {
202: $descr = $courses{$course}{'description'};
1.65 ! raeburn 203: $instcode = $courses{$course}{'inst_code'};
1.64 raeburn 204: $ttype = $courses{$course}{'type'};
205: push(@owners,&unescape($courses{$course}{'owner'}));
206: if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') {
207: foreach my $item (@{$courses{$course}{'co-owners'}}) {
208: push(@owners,&unescape($item));
209: }
210: }
211: } else {
212: my $singleowner;
213: ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
214: push(@owners,&unescape($singleowner));
215: }
216: my $owner = join(', ',@owners);
1.54 raeburn 217: $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
218: $r->print($description.'('.
1.62 albertel 219: (&Apache::lonnet::domain($cdom,'description')?
220: &Apache::lonnet::domain($cdom,'description'):$cdom).")");
1.64 raeburn 221: if ($instcode ne '') {
1.54 raeburn 222: $r->print(" - ".&unescape($instcode));
223: }
1.64 raeburn 224: if (@owners > 1) {
225: $r->print(', '.&mt('owners').' - ',join(', ',@owners));
226: } elsif (@owners == 1) {
227: $r->print(', '.&mt('owner').' - '.$owner);
1.23 raeburn 228: }
1.64 raeburn 229: if ($ttype ne '') {
1.55 raeburn 230: $r->print('('.&unescape($ttype).')');
1.23 raeburn 231: }
1.54 raeburn 232: if ($multiple) { $r->print("</label>\n"); }
233: $r->print("<br />\n");
1.19 raeburn 234: }
235: }
1.54 raeburn 236: if (!%courses) {
237: $r->print(&mt('None found'));
238: } elsif ($multiple) {
1.57 raeburn 239: $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
1.54 raeburn 240: }
241: $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
242: "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
243: '<input type="hidden" name="type" value="'.$type.'" />'."\n");
244: if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
245: $r->print('<input type="hidden" name="roleelement" value="'.
246: $env{'form.roleelement'}.'" />'."\n");
247: }
1.55 raeburn 248: if ($env{'form.form'} eq 'portform') {
249: $r->print('<input type="hidden" name="cnum" value="" />');
250: $r->print('<input type="hidden" name="cdom" value="" />');
251: $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
252: $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57 raeburn 253: } elsif ($env{'form.form'} eq 'modifycourse') {
254: $r->print('<input type="hidden" name="phase" value="menu" />'."\n");
255: $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form']));
256: } else {
257: $r->print('<input type="hidden" name="cnumelement" value="'.
258: $env{'form.cnumelement'}.'" />'."\n".
259: '<input type="hidden" name="cdomelement" value="'.
260: $env{'form.cdomelement'}.'" />'."\n");
1.55 raeburn 261: }
1.54 raeburn 262: $r->print("</form>\n");
263: return;
264: }
265:
266:
267: sub multiples_tag {
1.55 raeburn 268: my $jscript = &Apache::loncommon::check_uncheck_jscript();
269: my $multelement = '<input type="hidden" name="multiple" value="1" />';
270: return ($jscript,$multelement);
1.1 www 271: }
1.30 raeburn 272:
1.54 raeburn 273: sub build_filters {
1.57 raeburn 274: my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
275: $caller) = @_;
1.55 raeburn 276: my $list;
1.57 raeburn 277: my $formname;
278: if (defined($env{'form.form'})) {
279: $formname = $env{'form.form'};
280: } else {
281: $formname = $caller;
282: }
1.55 raeburn 283: my ($domainselectform,$sincefilterform,$ownerdomselectform,
1.54 raeburn 284: $instcodeform,$typeselectform);
1.55 raeburn 285: foreach my $item (@{$filterlist}) {
1.54 raeburn 286: $filter->{$item} = $env{'form.'.$item};
287: if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
1.61 albertel 288: if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
289: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
290: } elsif ($item eq 'coursefilter') {
291: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
292: } elsif ($item eq 'ownerfilter') {
293: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
294: } else {
295: $filter->{$item} =~ s/\W//g;
296: }
1.54 raeburn 297: if (!$filter->{$item}) {
298: $filter->{$item} = '';
299: }
300: }
301: if ($item eq 'domainfilter') {
1.63 albertel 302: my $allow_blank = 1;
303: if ($formname eq 'portform') {
304: $filter->{$item} ||= $env{'user.domain'};
305: $allow_blank=0;
306: }
1.54 raeburn 307: $domainselectform =
1.63 albertel 308: &Apache::loncommon::select_dom_form($filter->{$item},
309: 'domainfilter',
310: $allow_blank);
1.54 raeburn 311: } elsif ($item eq 'ownerdomfilter') {
312: $ownerdomselectform =
313: &Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
314: } else {
315: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
316: }
317: }
318:
319: # last course activity filter and selection
320: $filter->{'sincefilter'} = $env{'form.sincefilter'};
321: $filter->{'sincefilter'} =~ s/[^\d-]//g;
322: if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
323: $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
324: 'sincefilter',('-1'=>'',
325: '86400' => 'today',
326: '604800' => 'last week',
327: '2592000' => 'last month',
328: '7776000' => 'last three months',
329: '15552000' => 'last six months',
330: '31104000' => 'last year',
331: 'select_form_order' =>
332: ['-1','86400','604800','2592000','7776000',
333: '15552000','31104000']));
334:
335: my %lt = (
336: 'cac' => &mt('[_1] Activity',$type),
337: 'cde' => &mt('[_1] Description',$type),
338: 'cdo' => &mt('[_1] Domain',$type),
339: 'cin' => &mt('Course Institutional Code'),
340: 'cow' => &mt("[_1] Owner's Username",$type),
341: 'cod' => &mt("[_1] Owner's Domain", $type),
342: 'cog' => &mt('Course Type')
343: );
1.49 raeburn 344:
1.65 ! raeburn 345: $typeselectform = '<select name="type" size="1">'."\n";
1.54 raeburn 346: if ($type eq 'Course') {
1.57 raeburn 347: $instcodeform =
348: '<input type="text" name="instcodefilter" size="10" value="'.
349: $list->{'instcodefilter'}.'" />';
1.54 raeburn 350: }
1.57 raeburn 351: foreach my $posstype ('Course','Non-standard Course') {
1.54 raeburn 352: $typeselectform.='<option value="'.$posstype.'" "'.
353: ($posstype eq $type ? 'selected="selected" ' : ''). ">$posstype</option>\n";
354: }
355: $typeselectform.="</select>";
1.57 raeburn 356: my $output = qq|
357: <form method="post" name="filterpicker" action="$action">
358: <input type="hidden" name="form" value="$formname" />
359: |;
360: if ($formname eq 'modifycourse') {
361: $output .= '<input type="hidden" name="phase" value="courselist" />';
362: } else {
363: my $name_input;
364: if ($env{'form.cnameelement'} ne '') {
365: $name_input = '<input type="hidden" name="cnameelement" value="'.
366: $env{'form.cnameelement'}.'" />';
367: }
368: $output .= qq|
1.27 albertel 369: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
370: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
1.13 albertel 371: $name_input
1.18 raeburn 372: $roleelement
1.35 raeburn 373: $multelement
1.57 raeburn 374: |;
1.59 raeburn 375: if ($formname eq 'portform') {
376: $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
377: }
1.57 raeburn 378: }
379: if ($sincefilterform) {
380: $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
381: }
382: if ($domainselectform) {
383: $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
384: }
385: if ($typeselectform) {
386: $output .= $lt{'cog'}.': '.$typeselectform.'<br />'."\n";
387: }
388: if ($instcodeform) {
389: $output .= $lt{'cin'}.': '.$instcodeform.'<br />'."\n";
390: }
391: if (exists($filter->{'ownerfilter'})) {
392: $output .= $lt{'cow'}.': '.
393: '<input type="text" name="ownerfilter" size="10" value="'.
394: $list->{'ownerfilter'}.'" /><br />'."\n".
395: $lt{'cod'}.': '.$ownerdomselectform.'<br />'."\n";
396: }
397: if (exists($filter->{'coursefilter'})) {
398: $output .= &mt('LON-CAPA course ID').': '.
399: '<input type="text" name="coursefilter" size="25" value="'.
400: $list->{'coursefilter'}.'" /><br />';
401: }
402: if (exists($filter->{'descriptfilter'})) {
403: $output .=$lt{'cde'}.': '.
404: '<input type="text" name="descriptfilter" size="40" value="'.
405: $list->{'descriptfilter'}.'" />'."\n";
406: }
407: $output .= qq|
1.5 www 408: <p><input type="submit" name="gosearch" value="Search" /></p>
1.4 www 409: </form>
1.5 www 410: <hr />
1.57 raeburn 411: |;
1.54 raeburn 412: return $output;
413: }
414:
415: sub search_courses {
416: my ($r,$type,$onlyown,$filter) = @_;
417: my %courses;
418: if (!$onlyown) {
1.8 www 419: $r->print(&mt('Searching').' ...<br /> <br />');
1.6 www 420: $r->rflush();
1.54 raeburn 421: if (($filter->{'ownerfilter'} ne '') ||
422: ($filter->{'ownerdomfilter'} ne '')) {
423: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
424: $filter->{'ownerdomfilter'};
425: }
426: foreach my $item ('descriptfilter','instcodefilter','coursefilter',
427: 'combownerfilter') {
428: if (!$filter->{$item}) {
429: $filter->{$item}='.';
430: }
1.52 raeburn 431: }
432: if ($type eq '') { $type = '.'; }
1.54 raeburn 433: my $timefilter =
434: ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
435: %courses =
436: &Apache::lonnet::courseiddump($filter->{'domainfilter'},
437: $filter->{'descriptfilter'},
438: $timefilter,
439: $filter->{'instcodefilter'},
440: $filter->{'combownerfilter'},
441: $filter->{'coursefilter'},
442: undef,undef,$type);
443: } else {
444: $r->print('<br />');
1.60 raeburn 445: my %coursehash = &Apache::loncommon::findallcourses();
446: foreach my $cid (sort(keys(%coursehash))) {
1.65 ! raeburn 447: $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
1.36 raeburn 448: }
1.2 www 449: }
1.54 raeburn 450: return %courses;
1.18 raeburn 451: }
1.1 www 452:
1.30 raeburn 453: sub course_chooser {
1.35 raeburn 454: my ($multiple,$cdom,$cnum,$cleandesc) = @_;
1.30 raeburn 455: my $output;
1.35 raeburn 456: if ($multiple) {
1.32 albertel 457: $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.30 raeburn 458: } else {
459: $output = '<input type="button" value="Select" onClick="gochoose('.
460: "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
461: }
462: return $output;
1.49 raeburn 463: }
464:
1.55 raeburn 465: sub gochoose_javascript {
1.57 raeburn 466: my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55 raeburn 467: my %elements = (
468: 'Course' => {
469: name => 'coursepick',
470: total => 'coursetotal',
471: list => 'courselist',
472: },
1.57 raeburn 473: 'Non-standard Course' => {
1.55 raeburn 474: name => 'grouppick',
475: total => 'grouptotal',
476: list => 'grouplist',
477: },
478: );
1.57 raeburn 479: my $output .= qq|
1.55 raeburn 480: <script type="text/javascript">
1.57 raeburn 481: function gochoose(cname,cdom,cdesc) {
1.55 raeburn 482: var openerForm = "$env{'form.form'}";
483: courseCount = 0;
484: var courses = '';
1.57 raeburn 485: |;
486: if ($multiple) {
487: $output .= <<"ENDSCRIPT";
488: courseCount = 0;
489: var courses = '';
490: if (typeof(document.courselist.course_id.length) == 'undefined') {
491: // only 1 course checkbox was created
492: if (document.courselist.course_id.checked) {
493: courses = courses + document.courselist.course_id.value + "&&";
494: courseCount ++;
495: }
496: } else {
497: for (var j=0; j<document.courselist.course_id.length; j++) {
498: if (document.courselist.course_id[j].checked) {
499: courses = courses + document.courselist.course_id[j].value + "&&";
1.55 raeburn 500: courseCount ++;
501: }
1.57 raeburn 502: }
503: }
504: opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
505: if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
506: 'undefined') {
507: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
508: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55 raeburn 509: } else {
1.57 raeburn 510: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55 raeburn 511: }
1.57 raeburn 512: } else {
513: for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
514: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
515: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55 raeburn 516: } else {
1.57 raeburn 517: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54 raeburn 518: }
1.55 raeburn 519: }
1.57 raeburn 520: }
521: if (courseCount > 0) {
522: courses = courses.substr(0,courses.length-2);
523: opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
524: }
525: ENDSCRIPT
526: } else {
527: my $name_code;
528: if ($env{'form.cnameelement'} ne '') {
529: $name_code = 'opener.document.'.$env{'form.form'}.'.'.
530: $env{'form.cnameelement'}.'.value=cdesc;';
1.55 raeburn 531: }
1.57 raeburn 532: $output .= qq|
1.55 raeburn 533: $name_code
534: opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
535: var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
536: if (slct.options == undefined) {
537: opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
538: }
539: else {
540: var i;
541: for (i=0;i<slct.length;i++) {
542: if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54 raeburn 543: }
544: }
1.57 raeburn 545: |;
1.54 raeburn 546: }
1.57 raeburn 547: $output .= qq|
1.55 raeburn 548: if (openerForm == 'portform') {
549: document.courselist.cnum.value = cname;
550: document.courselist.cdom.value = cdom;
551: }
552: $autosubmit
553: $lastaction
1.54 raeburn 554: }
1.55 raeburn 555: </script>
1.57 raeburn 556: |;
1.55 raeburn 557: return $output;
1.54 raeburn 558: }
559:
1.55 raeburn 560: 1;
561: __END__
562:
563: =pod
564:
565: =head1 NAME
566:
567: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.
568:
569: =head1 SYNOPSIS
570:
571: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user.
572:
573: =head1 OVERVIEW
574:
575: Two screens are typically displayed to the user. The first is a set of criteria which are used to constrain the search for courses.
576:
577: =head2 Search Criteria (Screen One)
578:
579: =head3 Criteria:
580:
581: =over 4
582:
583: =item *
584: Course Activity - how recently was course last visited by anyone.
585:
586: =item *
587: Course Domain - the domain of the course
588:
589: =item *
1.57 raeburn 590: Course Type - Course or Non-standard Course
1.55 raeburn 591:
592: =item *
593: Course Institutional Code - the institutional identifier assigned to the course
594:
595: =item *
596: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
597:
598: =item *
599: Course Owner's Domain - the domain of the owner of the course
600:
601: =item *
602: Course Description - text which appears in the Course Description (or title), as set in the Course Parameters.
603:
604: =item *
605: Course ID - the internal course number (course ID part after initial 'domain_') used by LON-CAPA (this criterion is only displayed to Domain Coordinators selecting a course in the same domain as their DC role).
606:
607: =back
608:
609: The criteria setting screen is not displayed if course picking is done by a user who does not have advanced privileges (as defined by $env{'user.adv'}).
610:
611: =head2 Course Display (Screen Two)
612:
613: A list of courses matching the search criteria is displayed. If the user is not an advanced user, screen one will have been skipped and the courses displayed will be all courses in which the user has currently active roles. The information displayed for each course is:
614:
615: =over 4
616:
617: =item *
618: Course description
619:
620: =item *
621: Domain description of course domain
622:
623: =item *
624: Course institutional code
625:
626: =item *
627: Course owner (username:domain)
628:
629: =back
630:
631: Depending on context, the display may include a single select box for each course, allowing selection of only a single course, or may include checkboxes allowing selection of more than one course.
632:
633: Following selection, and/or submission, the course description, number and domain are transferred to the browser window from which the course picker window was opened. In most cases, the child window containing the course picker screens will be closed. However, in some cases closure will be delayed until a third screen has been displayed (e.g., setting of course-based conditional access controls for portfolio files). In this case the page is generated via /adm/portfolio and the page features select boxes to allow the user to select roles, access types, sections and groups.
634:
635: =head1 SUBROUTINES
636:
637: =over 4
638:
639: =item *
640: X<create_user_javascript()>
641: B<create_user_javascript($type)>:
642:
1.57 raeburn 643: Input: 1 - $type - the course type - Course or Non-standard Course
1.55 raeburn 644:
645: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
646:
647: Side Effects: None
648:
649: javascript code for reporting selected sections (as a string of comma separated sections) and groups in the selected course (as a comma separated list) then calling setSect() javscript function in the opener window (to populate section select box) then closing current window.
650:
651:
652: =item *
653: X<display_matched_courses()>
1.57 raeburn 654: B<display_matched_courses($r,$type,$multiple,$action,%courses)>:
1.55 raeburn 655:
1.57 raeburn 656: Input: 5 - request object, course type, multiple (0 or 1), form action; hash of courses.
1.55 raeburn 657:
658: Output: 0
659:
660: Side Effects: prints select buttons (multiple = 0) or checkboxes (multiple = 1) and hidden form elements for selection of one or more courses which met search criteria.
661:
662: =item *
663: X<multiples_tag()>
664: B<multiples_tag()>:
665:
666:
667: Input: 0
668:
669: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
670:
671: Side Effects: None
672:
673: =item *
674: X<build_filters()>
1.57 raeburn 675: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action)>:
1.55 raeburn 676:
677:
1.57 raeburn 678: Input: 6 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action.
1.55 raeburn 679:
680: Output: 1 - $output - HTML for display of search criteria, and hidden form elements.
681:
682: Side Effects: None
683:
684: =item *
685: X<search_courses()>
686: B<search_courses($r,$type,$onlyown,$filter)>:
687:
688:
689: Input: 5 - request object, course type, search scope: only courses in which user has active role (1), or any course (0); anonymous hash of criteria and their values.
690:
691: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
692:
693: Side Effects: None
694:
695:
696: =item *
697: X<course_chooser()>
698: B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>:
699:
700: Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description.
701:
702: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection.
703:
704: Side Effects: None
705:
706:
707: =item *
708: X<gochoose_javascript()>
1.57 raeburn 709: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55 raeburn 710:
1.57 raeburn 711: Input: 4 - course type; single (0) or multiple courses (1); in context of DC selecting a CC role in a course: javascript code from Apache::lonroles::processpick(); final action to take after user chooses course(s): either close window, or submit form for display of next page etc.
1.55 raeburn 712:
713: Output: 1 $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
714:
715: Side Effects: None
716:
717: javascript functions used when user selects a course(s). Different behavior depending on context:
718:
719: =back
720:
721: =over 8
722:
723: =item
724:
725: (a) Domain Coordinator using MAIL to select recipients of broadcast e-mail - && separated list of selected courses written to hidden form element in opener window. Child window closes.
726:
727: =item
728:
729: (b) Domain Coordinator choosing a course for adoption of a CC role from roles screen - write course identifying information to hidden form elements in opener window and automatically submit role selection form in opener window. Child window closes.
730:
731: =item
732:
733: (c) Domain Coordinator creating a course, and selecting a course to clone - course number and domain written to visible form elements in opener window. Child window closes.
734:
735: =item
1.54 raeburn 736:
1.55 raeburn 737: (d) User selecting a course for course-based conditional access control for a portfolio file - form is submitted, and new page is displayed for selection of roles, access types, sections and groups to be used in conditional ACL. New page is generated by /adm/portfolio.
1.54 raeburn 738:
1.55 raeburn 739: =item
1.54 raeburn 740:
1.55 raeburn 741: (e) Domain Coordinator assigning a role to a user - form is submitted, and new page does an onload call to a javascript function to (a) write lists of sections and groups to hidden elements in opener window, (b) call function in opener window to dynamically populate select box showing current sections.
1.54 raeburn 742:
1.55 raeburn 743: =item
1.54 raeburn 744:
1.55 raeburn 745: (f) Author modifying a rights entry in a .rights file - selected course number and domain are witten to visible form elements in opener window. Child window closes.
1.54 raeburn 746:
1.55 raeburn 747: =item
1.49 raeburn 748:
1.55 raeburn 749: (g) Scantron Operator uploading a scantron file to a course - course number is written to visible form element in opener window. Child window closes.
1.30 raeburn 750:
1.55 raeburn 751: =back
752:
753: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonpickcourse.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface