Annotation of loncom/interface/lonpickcourse.pm, revision 1.61
1.1 www 1: # The LearningOnline Network
2: # Pick a course
3: #
1.61 ! albertel 4: # $Id: lonpickcourse.pm,v 1.60 2006/11/29 07:46:39 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;
178: if ($courses{$course} =~ m/^([^:]*):/i) {
179: $descr = &unescape($1);
1.34 albertel 180: } else {
1.54 raeburn 181: $descr = &unescape($courses{$course});
182: }
183: my $description = $descr;
184: push (@{$by_descrip{$description}}, $course);
185: }
186: if ($numcourses > 1 && $multiple) {
187: $r->print('<input type="button" value="check all"
188: onclick="javascript:checkAll(document.courselist.course_id)" />
189: <input type="button" value="uncheck all"
190: onclick="javascript:uncheckAll(document.courselist.course_id)" />
191: <br /><br />');
192: }
193: foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
194: foreach my $course (@{$by_descrip{$description}}) {
195: my $cleandesc=&HTML::Entities::encode($description,'<>&"');
196: $cleandesc=~s/'/\\'/g;
197: my ($cdom,$cnum)=split(/\_/,$course);
198: my ($descr,$instcode,$owner,$ttype) = split/:/,$courses{$course};
199: $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
200: $r->print($description.'('.
201: ($Apache::lonnet::domaindescription{$cdom}?
202: $Apache::lonnet::domaindescription{$cdom}:$cdom).")");
203: unless ($instcode eq '') {
204: $r->print(" - ".&unescape($instcode));
205: }
206: unless ($owner eq '') {
207: $r->print(", owner - ".&unescape($owner));
1.23 raeburn 208: }
1.54 raeburn 209: unless ($ttype eq '') {
1.55 raeburn 210: $r->print('('.&unescape($ttype).')');
1.23 raeburn 211: }
1.54 raeburn 212: if ($multiple) { $r->print("</label>\n"); }
213: $r->print("<br />\n");
1.19 raeburn 214: }
215: }
1.54 raeburn 216: if (!%courses) {
217: $r->print(&mt('None found'));
218: } elsif ($multiple) {
1.57 raeburn 219: $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
1.54 raeburn 220: }
221: $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
222: "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
223: '<input type="hidden" name="type" value="'.$type.'" />'."\n");
224: if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
225: $r->print('<input type="hidden" name="roleelement" value="'.
226: $env{'form.roleelement'}.'" />'."\n");
227: }
1.55 raeburn 228: if ($env{'form.form'} eq 'portform') {
229: $r->print('<input type="hidden" name="cnum" value="" />');
230: $r->print('<input type="hidden" name="cdom" value="" />');
231: $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
232: $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57 raeburn 233: } elsif ($env{'form.form'} eq 'modifycourse') {
234: $r->print('<input type="hidden" name="phase" value="menu" />'."\n");
235: $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form']));
236: } else {
237: $r->print('<input type="hidden" name="cnumelement" value="'.
238: $env{'form.cnumelement'}.'" />'."\n".
239: '<input type="hidden" name="cdomelement" value="'.
240: $env{'form.cdomelement'}.'" />'."\n");
1.55 raeburn 241: }
1.54 raeburn 242: $r->print("</form>\n");
243: return;
244: }
245:
246:
247: sub multiples_tag {
1.55 raeburn 248: my $jscript = &Apache::loncommon::check_uncheck_jscript();
249: my $multelement = '<input type="hidden" name="multiple" value="1" />';
250: return ($jscript,$multelement);
1.1 www 251: }
1.30 raeburn 252:
1.54 raeburn 253: sub build_filters {
1.57 raeburn 254: my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
255: $caller) = @_;
1.55 raeburn 256: my $list;
1.57 raeburn 257: my $formname;
258: if (defined($env{'form.form'})) {
259: $formname = $env{'form.form'};
260: } else {
261: $formname = $caller;
262: }
1.55 raeburn 263: my ($domainselectform,$sincefilterform,$ownerdomselectform,
1.54 raeburn 264: $instcodeform,$typeselectform);
1.55 raeburn 265: foreach my $item (@{$filterlist}) {
1.54 raeburn 266: $filter->{$item} = $env{'form.'.$item};
267: if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
1.61 ! albertel 268: if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
! 269: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
! 270: } elsif ($item eq 'coursefilter') {
! 271: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
! 272: } elsif ($item eq 'ownerfilter') {
! 273: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
! 274: } else {
! 275: $filter->{$item} =~ s/\W//g;
! 276: }
1.54 raeburn 277: if (!$filter->{$item}) {
278: $filter->{$item} = '';
279: }
280: }
281: if ($item eq 'domainfilter') {
282: $domainselectform =
283: &Apache::loncommon::select_dom_form($filter->{$item},'domainfilter',1);
284: } elsif ($item eq 'ownerdomfilter') {
285: $ownerdomselectform =
286: &Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
287: } else {
288: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
289: }
290: }
291:
292: # last course activity filter and selection
293: $filter->{'sincefilter'} = $env{'form.sincefilter'};
294: $filter->{'sincefilter'} =~ s/[^\d-]//g;
295: if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
296: $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
297: 'sincefilter',('-1'=>'',
298: '86400' => 'today',
299: '604800' => 'last week',
300: '2592000' => 'last month',
301: '7776000' => 'last three months',
302: '15552000' => 'last six months',
303: '31104000' => 'last year',
304: 'select_form_order' =>
305: ['-1','86400','604800','2592000','7776000',
306: '15552000','31104000']));
307:
308: my %lt = (
309: 'cac' => &mt('[_1] Activity',$type),
310: 'cde' => &mt('[_1] Description',$type),
311: 'cdo' => &mt('[_1] Domain',$type),
312: 'cin' => &mt('Course Institutional Code'),
313: 'cow' => &mt("[_1] Owner's Username",$type),
314: 'cod' => &mt("[_1] Owner's Domain", $type),
315: 'cog' => &mt('Course Type')
316: );
1.49 raeburn 317:
1.54 raeburn 318: $typeselectform = '<select name="type" size="1"';
319: $typeselectform .= ">\n";
320: if ($type eq 'Course') {
1.57 raeburn 321: $instcodeform =
322: '<input type="text" name="instcodefilter" size="10" value="'.
323: $list->{'instcodefilter'}.'" />';
1.54 raeburn 324: }
1.57 raeburn 325: foreach my $posstype ('Course','Non-standard Course') {
1.54 raeburn 326: $typeselectform.='<option value="'.$posstype.'" "'.
327: ($posstype eq $type ? 'selected="selected" ' : ''). ">$posstype</option>\n";
328: }
329: $typeselectform.="</select>";
1.57 raeburn 330: my $output = qq|
331: <form method="post" name="filterpicker" action="$action">
332: <input type="hidden" name="form" value="$formname" />
333: |;
334: if ($formname eq 'modifycourse') {
335: $output .= '<input type="hidden" name="phase" value="courselist" />';
336: } else {
337: my $name_input;
338: if ($env{'form.cnameelement'} ne '') {
339: $name_input = '<input type="hidden" name="cnameelement" value="'.
340: $env{'form.cnameelement'}.'" />';
341: }
342: $output .= qq|
1.27 albertel 343: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
344: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
1.13 albertel 345: $name_input
1.18 raeburn 346: $roleelement
1.35 raeburn 347: $multelement
1.57 raeburn 348: |;
1.59 raeburn 349: if ($formname eq 'portform') {
350: $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
351: }
1.57 raeburn 352: }
353: if ($sincefilterform) {
354: $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
355: }
356: if ($domainselectform) {
357: $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
358: }
359: if ($typeselectform) {
360: $output .= $lt{'cog'}.': '.$typeselectform.'<br />'."\n";
361: }
362: if ($instcodeform) {
363: $output .= $lt{'cin'}.': '.$instcodeform.'<br />'."\n";
364: }
365: if (exists($filter->{'ownerfilter'})) {
366: $output .= $lt{'cow'}.': '.
367: '<input type="text" name="ownerfilter" size="10" value="'.
368: $list->{'ownerfilter'}.'" /><br />'."\n".
369: $lt{'cod'}.': '.$ownerdomselectform.'<br />'."\n";
370: }
371: if (exists($filter->{'coursefilter'})) {
372: $output .= &mt('LON-CAPA course ID').': '.
373: '<input type="text" name="coursefilter" size="25" value="'.
374: $list->{'coursefilter'}.'" /><br />';
375: }
376: if (exists($filter->{'descriptfilter'})) {
377: $output .=$lt{'cde'}.': '.
378: '<input type="text" name="descriptfilter" size="40" value="'.
379: $list->{'descriptfilter'}.'" />'."\n";
380: }
381: $output .= qq|
1.5 www 382: <p><input type="submit" name="gosearch" value="Search" /></p>
1.4 www 383: </form>
1.5 www 384: <hr />
1.57 raeburn 385: |;
1.54 raeburn 386: return $output;
387: }
388:
389: sub search_courses {
390: my ($r,$type,$onlyown,$filter) = @_;
391: my %courses;
392: if (!$onlyown) {
1.8 www 393: $r->print(&mt('Searching').' ...<br /> <br />');
1.6 www 394: $r->rflush();
1.54 raeburn 395: if (($filter->{'ownerfilter'} ne '') ||
396: ($filter->{'ownerdomfilter'} ne '')) {
397: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
398: $filter->{'ownerdomfilter'};
399: }
400: foreach my $item ('descriptfilter','instcodefilter','coursefilter',
401: 'combownerfilter') {
402: if (!$filter->{$item}) {
403: $filter->{$item}='.';
404: }
1.52 raeburn 405: }
406: if ($type eq '') { $type = '.'; }
1.54 raeburn 407: my $timefilter =
408: ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
409: %courses =
410: &Apache::lonnet::courseiddump($filter->{'domainfilter'},
411: $filter->{'descriptfilter'},
412: $timefilter,
413: $filter->{'instcodefilter'},
414: $filter->{'combownerfilter'},
415: $filter->{'coursefilter'},
416: undef,undef,$type);
417: } else {
418: $r->print('<br />');
1.60 raeburn 419: my %coursehash = &Apache::loncommon::findallcourses();
420: foreach my $cid (sort(keys(%coursehash))) {
1.54 raeburn 421: $courses{$cid} = $env{'course.'.$cid.'.description'};
1.36 raeburn 422: }
1.2 www 423: }
1.54 raeburn 424: return %courses;
1.18 raeburn 425: }
1.1 www 426:
1.30 raeburn 427: sub course_chooser {
1.35 raeburn 428: my ($multiple,$cdom,$cnum,$cleandesc) = @_;
1.30 raeburn 429: my $output;
1.35 raeburn 430: if ($multiple) {
1.32 albertel 431: $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.30 raeburn 432: } else {
433: $output = '<input type="button" value="Select" onClick="gochoose('.
434: "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
435: }
436: return $output;
1.49 raeburn 437: }
438:
1.55 raeburn 439: sub gochoose_javascript {
1.57 raeburn 440: my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55 raeburn 441: my %elements = (
442: 'Course' => {
443: name => 'coursepick',
444: total => 'coursetotal',
445: list => 'courselist',
446: },
1.57 raeburn 447: 'Non-standard Course' => {
1.55 raeburn 448: name => 'grouppick',
449: total => 'grouptotal',
450: list => 'grouplist',
451: },
452: );
1.57 raeburn 453: my $output .= qq|
1.55 raeburn 454: <script type="text/javascript">
1.57 raeburn 455: function gochoose(cname,cdom,cdesc) {
1.55 raeburn 456: var openerForm = "$env{'form.form'}";
457: courseCount = 0;
458: var courses = '';
1.57 raeburn 459: |;
460: if ($multiple) {
461: $output .= <<"ENDSCRIPT";
462: courseCount = 0;
463: var courses = '';
464: if (typeof(document.courselist.course_id.length) == 'undefined') {
465: // only 1 course checkbox was created
466: if (document.courselist.course_id.checked) {
467: courses = courses + document.courselist.course_id.value + "&&";
468: courseCount ++;
469: }
470: } else {
471: for (var j=0; j<document.courselist.course_id.length; j++) {
472: if (document.courselist.course_id[j].checked) {
473: courses = courses + document.courselist.course_id[j].value + "&&";
1.55 raeburn 474: courseCount ++;
475: }
1.57 raeburn 476: }
477: }
478: opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
479: if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
480: 'undefined') {
481: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
482: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55 raeburn 483: } else {
1.57 raeburn 484: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55 raeburn 485: }
1.57 raeburn 486: } else {
487: for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
488: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
489: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55 raeburn 490: } else {
1.57 raeburn 491: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54 raeburn 492: }
1.55 raeburn 493: }
1.57 raeburn 494: }
495: if (courseCount > 0) {
496: courses = courses.substr(0,courses.length-2);
497: opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
498: }
499: ENDSCRIPT
500: } else {
501: my $name_code;
502: if ($env{'form.cnameelement'} ne '') {
503: $name_code = 'opener.document.'.$env{'form.form'}.'.'.
504: $env{'form.cnameelement'}.'.value=cdesc;';
1.55 raeburn 505: }
1.57 raeburn 506: $output .= qq|
1.55 raeburn 507: $name_code
508: opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
509: var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
510: if (slct.options == undefined) {
511: opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
512: }
513: else {
514: var i;
515: for (i=0;i<slct.length;i++) {
516: if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54 raeburn 517: }
518: }
1.57 raeburn 519: |;
1.54 raeburn 520: }
1.57 raeburn 521: $output .= qq|
1.55 raeburn 522: if (openerForm == 'portform') {
523: document.courselist.cnum.value = cname;
524: document.courselist.cdom.value = cdom;
525: }
526: $autosubmit
527: $lastaction
1.54 raeburn 528: }
1.55 raeburn 529: </script>
1.57 raeburn 530: |;
1.55 raeburn 531: return $output;
1.54 raeburn 532: }
533:
1.55 raeburn 534: 1;
535: __END__
536:
537: =pod
538:
539: =head1 NAME
540:
541: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.
542:
543: =head1 SYNOPSIS
544:
545: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user.
546:
547: =head1 OVERVIEW
548:
549: Two screens are typically displayed to the user. The first is a set of criteria which are used to constrain the search for courses.
550:
551: =head2 Search Criteria (Screen One)
552:
553: =head3 Criteria:
554:
555: =over 4
556:
557: =item *
558: Course Activity - how recently was course last visited by anyone.
559:
560: =item *
561: Course Domain - the domain of the course
562:
563: =item *
1.57 raeburn 564: Course Type - Course or Non-standard Course
1.55 raeburn 565:
566: =item *
567: Course Institutional Code - the institutional identifier assigned to the course
568:
569: =item *
570: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
571:
572: =item *
573: Course Owner's Domain - the domain of the owner of the course
574:
575: =item *
576: Course Description - text which appears in the Course Description (or title), as set in the Course Parameters.
577:
578: =item *
579: 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).
580:
581: =back
582:
583: 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'}).
584:
585: =head2 Course Display (Screen Two)
586:
587: 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:
588:
589: =over 4
590:
591: =item *
592: Course description
593:
594: =item *
595: Domain description of course domain
596:
597: =item *
598: Course institutional code
599:
600: =item *
601: Course owner (username:domain)
602:
603: =back
604:
605: 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.
606:
607: 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.
608:
609: =head1 SUBROUTINES
610:
611: =over 4
612:
613: =item *
614: X<create_user_javascript()>
615: B<create_user_javascript($type)>:
616:
1.57 raeburn 617: Input: 1 - $type - the course type - Course or Non-standard Course
1.55 raeburn 618:
619: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
620:
621: Side Effects: None
622:
623: 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.
624:
625:
626: =item *
627: X<display_matched_courses()>
1.57 raeburn 628: B<display_matched_courses($r,$type,$multiple,$action,%courses)>:
1.55 raeburn 629:
1.57 raeburn 630: Input: 5 - request object, course type, multiple (0 or 1), form action; hash of courses.
1.55 raeburn 631:
632: Output: 0
633:
634: 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.
635:
636: =item *
637: X<multiples_tag()>
638: B<multiples_tag()>:
639:
640:
641: Input: 0
642:
643: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
644:
645: Side Effects: None
646:
647: =item *
648: X<build_filters()>
1.57 raeburn 649: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action)>:
1.55 raeburn 650:
651:
1.57 raeburn 652: Input: 6 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action.
1.55 raeburn 653:
654: Output: 1 - $output - HTML for display of search criteria, and hidden form elements.
655:
656: Side Effects: None
657:
658: =item *
659: X<search_courses()>
660: B<search_courses($r,$type,$onlyown,$filter)>:
661:
662:
663: 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.
664:
665: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
666:
667: Side Effects: None
668:
669:
670: =item *
671: X<course_chooser()>
672: B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>:
673:
674: Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description.
675:
676: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection.
677:
678: Side Effects: None
679:
680:
681: =item *
682: X<gochoose_javascript()>
1.57 raeburn 683: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55 raeburn 684:
1.57 raeburn 685: 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 686:
687: Output: 1 $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
688:
689: Side Effects: None
690:
691: javascript functions used when user selects a course(s). Different behavior depending on context:
692:
693: =back
694:
695: =over 8
696:
697: =item
698:
699: (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.
700:
701: =item
702:
703: (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.
704:
705: =item
706:
707: (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.
708:
709: =item
1.54 raeburn 710:
1.55 raeburn 711: (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 712:
1.55 raeburn 713: =item
1.54 raeburn 714:
1.55 raeburn 715: (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 716:
1.55 raeburn 717: =item
1.54 raeburn 718:
1.55 raeburn 719: (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 720:
1.55 raeburn 721: =item
1.49 raeburn 722:
1.55 raeburn 723: (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 724:
1.55 raeburn 725: =back
726:
727: =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