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