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