Annotation of loncom/interface/lonpickcourse.pm, revision 1.72
1.1 www 1: # The LearningOnline Network
2: # Pick a course
3: #
1.72 ! raeburn 4: # $Id: lonpickcourse.pm,v 1.71 2008/05/19 21:40:26 bisitz 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.'" />';
1.66 raeburn 75: $submitopener = &processpick();
1.54 raeburn 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.66 raeburn 86: if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) &&
87: ($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()';
1.67 raeburn 96: } elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' &&
97: !$multiple)) {
1.55 raeburn 98: $lastaction =
99: 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
100: 'document.courselist.submit();';
1.34 albertel 101: } else {
1.55 raeburn 102: $lastaction = 'self.close()';
1.1 www 103: }
1.19 raeburn 104:
1.55 raeburn 105: # if called to assign a role in a course to a user via CUSR
1.66 raeburn 106: if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') {
1.68 raeburn 107: $r->print(&create_user_javascript($type));
1.55 raeburn 108: }
1.54 raeburn 109:
1.55 raeburn 110: # print javascript functions for choosing a course
111: if ($env{'form.gosearch'} || $onlyown) {
1.58 raeburn 112: $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
1.55 raeburn 113: }
114: $r->print('<script type="text/javascript">'.$jscript.'</script>');
115: $r->print($submitopener);
1.54 raeburn 116:
1.55 raeburn 117: # ------------------------------------------ Display of filters to limit search
1.57 raeburn 118: my $filter = {};
119: my $action = '/adm/pickcourse';
1.55 raeburn 120: if (!$onlyown) {
121: my $filterlist = ['domainfilter','descriptfilter',
122: 'instcodefilter','ownerfilter',
123: 'ownerdomfilter'];
124: # course ID filter for DCs only
125: if ($env{'user.adv'} && $env{'form.domainfilter'} &&
126: exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
127: push(@{$filterlist},'coursefilter');
128: }
129: $r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
1.57 raeburn 130: $filter,$action));
1.55 raeburn 131: }
1.54 raeburn 132:
133: # ---------------------------------------------------------------- Get the data
134: if ($env{'form.gosearch'} || $onlyown) {
1.57 raeburn 135: my %courses = &search_courses($r,$type,$onlyown,$filter);
136: &display_matched_courses($r,$type,$multiple,$action,%courses);
1.54 raeburn 137: }
138: $r->print(&Apache::loncommon::end_page());
139: return OK;
140: }
141:
1.66 raeburn 142: sub processpick {
143: my $openerform = 'rolechoice';
144: if ($env{'form.form'} eq 'studentform') {
145: $openerform = $env{'form.form'};
146: }
147: my $process_pick = <<"ENDONE";
148: <script type="text/javascript">
149: function process_pick(dom) {
150: var pickedCourse=opener.document.$openerform.$env{'form.cnumelement'}.value;
151: var pickedDomain=opener.document.$openerform.$env{'form.cdomelement'}.value;
152: var okDomain = 0;
153: ENDONE
154: if ($openerform eq 'rolechoice') {
155: $process_pick .= <<"ENDTWO";
156: if (pickedDomain == dom) {
157: if (pickedCourse != '') {
158: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
159: opener.document.title='Role selected. Please stand by.';
160: opener.status='Role selected. Please stand by.';
161: opener.document.rolechoice.newrole.value=courseTarget
162: opener.document.rolechoice.submit();
163: }
164: }
165: else {
166: alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
167: }
168: ENDTWO
169: } else {
170: $process_pick .= <<"ENDTHREE";
171: if (pickedDomain != dom) {
172: alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
173: return;
174: }
175: ENDTHREE
176: }
177: $process_pick .= "
178: }
179:
180: </script>
181: ";
182: return $process_pick;
183: }
184:
1.55 raeburn 185: sub create_user_javascript {
186: my ($type) = @_;
187: my $output;
188: #javascript for reporting sections and groups then closing
189: if ($env{'form.pickedcourse'}) {
190: my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
191: my $sec_element = 'currsec';
192: my $grplist_element = 'groups';
193: my ($sections,$groups) =
194: &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
195: my $num_sections = scalar(@{$sections});
196: my $seclist = join(',',@{$sections});
197: my $num_groups = scalar(@{$groups});
198: my $groupslist = join(',',@{$groups});
199: $output = qq|
200: <script type="text/javascript">
201: function setSections() {
202: opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
203: window.opener.setSect('$seclist');
204: self.close()
205: }
206: </script>
207: |;
208: ;
209: }
210: return $output;
211: }
212:
1.54 raeburn 213: sub display_matched_courses {
1.57 raeburn 214: my ($r,$type,$multiple,$action,%courses) = @_;
1.55 raeburn 215: if ($env{'form.form'} eq 'portform') {
216: $action = '/adm/portfolio';
217: }
1.68 raeburn 218: my $numcourses = keys(%courses);
1.55 raeburn 219: $r->print('<form name="courselist" method="post" action="'.$action.'">');
1.68 raeburn 220: if ($env{'form.form'} eq 'modifycourse') {
221: if ($numcourses > 0) {
222: my $cctitle = &Apache::lonnet::plaintext('cc',$type);
223: my $dctitle = &Apache::lonnet::plaintext('dc');
224: my $ccrolechk = ' checked="checked" ';
225: my $menuchk = ' ';
226: if ($env{'form.prevphase'} ne '') {
227: $ccrolechk = ' ';
228: $menuchk = ' checked="checked" ';
229: }
230: $r->print(
231: '<span class="LC_nobreak"><label>'.
232: '<input type="radio" name="phase" value="ccrole"'.$ccrolechk.'/>'.
233: ' '.&mt('Enter the course with the role of [_1].',$cctitle).
234: '</label>'.(' 'x3).'</span><br />'.
235: '<span class="LC_nobreak"><label>'.
236: '<input type="radio" name="phase" value="menu"'.$menuchk.'/> '.
237: &mt('View or modify course settings which only a [_1] may modify.',$dctitle).
238: '</label></span><br /><br />');
239: }
240: }
1.54 raeburn 241: my %by_descrip;
242: foreach my $course (keys(%courses)) {
243: my $descr;
1.64 raeburn 244: if (ref($courses{$course}) eq 'HASH') {
1.65 raeburn 245: $descr = $courses{$course}{'description'};
1.64 raeburn 246: } elsif ($courses{$course} =~ m/^([^:]*):/i) {
1.54 raeburn 247: $descr = &unescape($1);
1.34 albertel 248: } else {
1.54 raeburn 249: $descr = &unescape($courses{$course});
250: }
251: my $description = $descr;
252: push (@{$by_descrip{$description}}, $course);
253: }
1.71 bisitz 254:
1.54 raeburn 255: if ($numcourses > 1 && $multiple) {
256: $r->print('<input type="button" value="check all"
257: onclick="javascript:checkAll(document.courselist.course_id)" />
258: <input type="button" value="uncheck all"
259: onclick="javascript:uncheckAll(document.courselist.course_id)" />
260: <br /><br />');
261: }
1.71 bisitz 262:
263: if (%courses) {
264: $r->print(&Apache::loncommon::start_data_table());
265: $r->print(&Apache::loncommon::start_data_table_header_row());
266: $r->print('<th>'.&mt('Select').'</th>'
267: .'<th>'.&mt('Course Description').'</th>'
268: .'<th>'.&mt('Domain').'</th>'
269: .'<th>'.&mt('Course Code').'</th>'
1.72 ! raeburn 270: .'<th>'.&mt('Owner/Co-owner(s)').'</th>'
1.71 bisitz 271: .'<th>'.&mt('Type').'</th>'
272: );
273: $r->print(&Apache::loncommon::end_data_table_header_row());
274: }
1.54 raeburn 275: foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
276: foreach my $course (@{$by_descrip{$description}}) {
1.72 ! raeburn 277: $r->print(&Apache::loncommon::start_data_table_row());
1.54 raeburn 278: my $cleandesc=&HTML::Entities::encode($description,'<>&"');
279: $cleandesc=~s/'/\\'/g;
280: my ($cdom,$cnum)=split(/\_/,$course);
1.64 raeburn 281: my ($descr,$instcode,$ttype,@owners);
282: if (ref($courses{$course}) eq 'HASH') {
283: $descr = $courses{$course}{'description'};
1.65 raeburn 284: $instcode = $courses{$course}{'inst_code'};
1.64 raeburn 285: $ttype = $courses{$course}{'type'};
286: push(@owners,&unescape($courses{$course}{'owner'}));
287: if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') {
288: foreach my $item (@{$courses{$course}{'co-owners'}}) {
289: push(@owners,&unescape($item));
290: }
291: }
292: } else {
293: my $singleowner;
294: ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
295: push(@owners,&unescape($singleowner));
296: }
1.72 ! raeburn 297: my $ownerstr = join(', ',@owners);
1.71 bisitz 298: $r->print('<td>'.&course_chooser($multiple,$cdom,$cnum,$cleandesc).'</td>');
299: $r->print('<td>'.$description.'</td>');
300: $r->print('<td>');
301: $r->print(&Apache::lonnet::domain($cdom,'description')?
302: $cdom.' ('.&Apache::lonnet::domain($cdom,'description').')':$cdom);
303: $r->print('</td>');
304: $r->print('<td>');
1.64 raeburn 305: if ($instcode ne '') {
1.71 bisitz 306: $r->print(&unescape($instcode));
307: } else {
308: $r->print(' ');
1.54 raeburn 309: }
1.71 bisitz 310: $r->print('</td>');
1.72 ! raeburn 311: $r->print('<td>'.$ownerstr.'</td>');
1.71 bisitz 312: $r->print('<td>');
1.64 raeburn 313: if ($ttype ne '') {
1.71 bisitz 314: $r->print(&mt(&unescape($ttype)));
315: } else {
316: $r->print(' ');
1.23 raeburn 317: }
1.71 bisitz 318: $r->print('</td>');
1.54 raeburn 319: if ($multiple) { $r->print("</label>\n"); }
1.72 ! raeburn 320: $r->print(&Apache::loncommon::end_data_table_row());
1.71 bisitz 321: # $r->print("<br />\n");
1.19 raeburn 322: }
323: }
1.72 ! raeburn 324: if (%courses) {
! 325: $r->print(&Apache::loncommon::end_data_table());
! 326: }
1.71 bisitz 327:
1.54 raeburn 328: if (!%courses) {
329: $r->print(&mt('None found'));
330: } elsif ($multiple) {
1.57 raeburn 331: $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
1.54 raeburn 332: }
333: $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
334: "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
335: '<input type="hidden" name="type" value="'.$type.'" />'."\n");
336: if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
337: $r->print('<input type="hidden" name="roleelement" value="'.
338: $env{'form.roleelement'}.'" />'."\n");
339: }
1.55 raeburn 340: if ($env{'form.form'} eq 'portform') {
341: $r->print('<input type="hidden" name="cnum" value="" />');
342: $r->print('<input type="hidden" name="cdom" value="" />');
343: $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
344: $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57 raeburn 345: } elsif ($env{'form.form'} eq 'modifycourse') {
346: $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form']));
347: } else {
348: $r->print('<input type="hidden" name="cnumelement" value="'.
349: $env{'form.cnumelement'}.'" />'."\n".
350: '<input type="hidden" name="cdomelement" value="'.
351: $env{'form.cdomelement'}.'" />'."\n");
1.55 raeburn 352: }
1.54 raeburn 353: $r->print("</form>\n");
354: return;
355: }
356:
357:
358: sub multiples_tag {
1.55 raeburn 359: my $jscript = &Apache::loncommon::check_uncheck_jscript();
360: my $multelement = '<input type="hidden" name="multiple" value="1" />';
361: return ($jscript,$multelement);
1.1 www 362: }
1.30 raeburn 363:
1.54 raeburn 364: sub build_filters {
1.57 raeburn 365: my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
366: $caller) = @_;
1.55 raeburn 367: my $list;
1.57 raeburn 368: my $formname;
369: if (defined($env{'form.form'})) {
370: $formname = $env{'form.form'};
371: } else {
372: $formname = $caller;
373: }
1.55 raeburn 374: my ($domainselectform,$sincefilterform,$ownerdomselectform,
1.54 raeburn 375: $instcodeform,$typeselectform);
1.55 raeburn 376: foreach my $item (@{$filterlist}) {
1.54 raeburn 377: $filter->{$item} = $env{'form.'.$item};
378: if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
1.61 albertel 379: if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
380: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
381: } elsif ($item eq 'coursefilter') {
382: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
383: } elsif ($item eq 'ownerfilter') {
384: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
385: } else {
386: $filter->{$item} =~ s/\W//g;
387: }
1.54 raeburn 388: if (!$filter->{$item}) {
389: $filter->{$item} = '';
390: }
391: }
392: if ($item eq 'domainfilter') {
1.63 albertel 393: my $allow_blank = 1;
394: if ($formname eq 'portform') {
395: $filter->{$item} ||= $env{'user.domain'};
396: $allow_blank=0;
1.67 raeburn 397: } elsif ($formname eq 'studentform') {
398: $filter->{$item} ||= $env{'request.role.domain'};
399: $allow_blank=0;
400: }
1.54 raeburn 401: $domainselectform =
1.63 albertel 402: &Apache::loncommon::select_dom_form($filter->{$item},
403: 'domainfilter',
404: $allow_blank);
1.54 raeburn 405: } elsif ($item eq 'ownerdomfilter') {
406: $ownerdomselectform =
407: &Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
408: } else {
409: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
410: }
411: }
412:
413: # last course activity filter and selection
414: $filter->{'sincefilter'} = $env{'form.sincefilter'};
415: $filter->{'sincefilter'} =~ s/[^\d-]//g;
416: if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
417: $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
418: 'sincefilter',('-1'=>'',
419: '86400' => 'today',
420: '604800' => 'last week',
421: '2592000' => 'last month',
422: '7776000' => 'last three months',
423: '15552000' => 'last six months',
424: '31104000' => 'last year',
425: 'select_form_order' =>
426: ['-1','86400','604800','2592000','7776000',
427: '15552000','31104000']));
428:
429: my %lt = (
430: 'cac' => &mt('[_1] Activity',$type),
431: 'cde' => &mt('[_1] Description',$type),
432: 'cdo' => &mt('[_1] Domain',$type),
433: 'cin' => &mt('Course Institutional Code'),
434: 'cow' => &mt("[_1] Owner's Username",$type),
435: 'cod' => &mt("[_1] Owner's Domain", $type),
436: 'cog' => &mt('Course Type')
437: );
1.49 raeburn 438:
1.65 raeburn 439: $typeselectform = '<select name="type" size="1">'."\n";
1.54 raeburn 440: if ($type eq 'Course') {
1.57 raeburn 441: $instcodeform =
442: '<input type="text" name="instcodefilter" size="10" value="'.
443: $list->{'instcodefilter'}.'" />';
1.54 raeburn 444: }
1.57 raeburn 445: foreach my $posstype ('Course','Non-standard Course') {
1.72 ! raeburn 446: $typeselectform.='<option value="'.$posstype.'"'.
! 447: ($posstype eq $type ? ' selected="selected" ' : ''). ">$posstype</option>\n";
1.54 raeburn 448: }
449: $typeselectform.="</select>";
1.57 raeburn 450: my $output = qq|
451: <form method="post" name="filterpicker" action="$action">
452: <input type="hidden" name="form" value="$formname" />
453: |;
454: if ($formname eq 'modifycourse') {
1.68 raeburn 455: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
456: '<input type="hidden" name="prevphase" value="'.
457: $env{'form.prevphase'}.'" />'."\n";
458: } else {
1.57 raeburn 459: my $name_input;
460: if ($env{'form.cnameelement'} ne '') {
461: $name_input = '<input type="hidden" name="cnameelement" value="'.
462: $env{'form.cnameelement'}.'" />';
463: }
464: $output .= qq|
1.27 albertel 465: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
466: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
1.13 albertel 467: $name_input
1.18 raeburn 468: $roleelement
1.35 raeburn 469: $multelement
1.57 raeburn 470: |;
1.59 raeburn 471: if ($formname eq 'portform') {
472: $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
473: }
1.57 raeburn 474: }
475: if ($sincefilterform) {
476: $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
477: }
478: if ($domainselectform) {
479: $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
480: }
481: if ($typeselectform) {
482: $output .= $lt{'cog'}.': '.$typeselectform.'<br />'."\n";
483: }
484: if ($instcodeform) {
485: $output .= $lt{'cin'}.': '.$instcodeform.'<br />'."\n";
486: }
487: if (exists($filter->{'ownerfilter'})) {
488: $output .= $lt{'cow'}.': '.
489: '<input type="text" name="ownerfilter" size="10" value="'.
490: $list->{'ownerfilter'}.'" /><br />'."\n".
491: $lt{'cod'}.': '.$ownerdomselectform.'<br />'."\n";
492: }
493: if (exists($filter->{'coursefilter'})) {
494: $output .= &mt('LON-CAPA course ID').': '.
495: '<input type="text" name="coursefilter" size="25" value="'.
496: $list->{'coursefilter'}.'" /><br />';
497: }
498: if (exists($filter->{'descriptfilter'})) {
499: $output .=$lt{'cde'}.': '.
500: '<input type="text" name="descriptfilter" size="40" value="'.
501: $list->{'descriptfilter'}.'" />'."\n";
502: }
1.70 raeburn 503: $output .= '<p><input type="submit" name="gosearch" value="'.
504: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
1.54 raeburn 505: return $output;
506: }
507:
508: sub search_courses {
509: my ($r,$type,$onlyown,$filter) = @_;
510: my %courses;
511: if (!$onlyown) {
1.71 bisitz 512: $r->print(&mt('Searching ...').'<br /> <br />');
1.6 www 513: $r->rflush();
1.54 raeburn 514: if (($filter->{'ownerfilter'} ne '') ||
515: ($filter->{'ownerdomfilter'} ne '')) {
516: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
517: $filter->{'ownerdomfilter'};
518: }
519: foreach my $item ('descriptfilter','instcodefilter','coursefilter',
520: 'combownerfilter') {
521: if (!$filter->{$item}) {
522: $filter->{$item}='.';
523: }
1.52 raeburn 524: }
525: if ($type eq '') { $type = '.'; }
1.54 raeburn 526: my $timefilter =
527: ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
528: %courses =
529: &Apache::lonnet::courseiddump($filter->{'domainfilter'},
530: $filter->{'descriptfilter'},
531: $timefilter,
532: $filter->{'instcodefilter'},
533: $filter->{'combownerfilter'},
534: $filter->{'coursefilter'},
535: undef,undef,$type);
536: } else {
537: $r->print('<br />');
1.60 raeburn 538: my %coursehash = &Apache::loncommon::findallcourses();
539: foreach my $cid (sort(keys(%coursehash))) {
1.65 raeburn 540: $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
1.36 raeburn 541: }
1.2 www 542: }
1.54 raeburn 543: return %courses;
1.18 raeburn 544: }
1.1 www 545:
1.30 raeburn 546: sub course_chooser {
1.35 raeburn 547: my ($multiple,$cdom,$cnum,$cleandesc) = @_;
1.30 raeburn 548: my $output;
1.35 raeburn 549: if ($multiple) {
1.32 albertel 550: $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.30 raeburn 551: } else {
1.71 bisitz 552: $output = '<input type="button" value="'.&mt('Select').'" onClick="gochoose('.
1.30 raeburn 553: "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
554: }
555: return $output;
1.49 raeburn 556: }
557:
1.55 raeburn 558: sub gochoose_javascript {
1.57 raeburn 559: my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55 raeburn 560: my %elements = (
561: 'Course' => {
562: name => 'coursepick',
563: total => 'coursetotal',
564: list => 'courselist',
565: },
1.57 raeburn 566: 'Non-standard Course' => {
1.55 raeburn 567: name => 'grouppick',
568: total => 'grouptotal',
569: list => 'grouplist',
570: },
571: );
1.57 raeburn 572: my $output .= qq|
1.55 raeburn 573: <script type="text/javascript">
1.57 raeburn 574: function gochoose(cname,cdom,cdesc) {
1.55 raeburn 575: var openerForm = "$env{'form.form'}";
576: courseCount = 0;
577: var courses = '';
1.57 raeburn 578: |;
579: if ($multiple) {
580: $output .= <<"ENDSCRIPT";
581: courseCount = 0;
582: var courses = '';
583: if (typeof(document.courselist.course_id.length) == 'undefined') {
584: // only 1 course checkbox was created
585: if (document.courselist.course_id.checked) {
586: courses = courses + document.courselist.course_id.value + "&&";
587: courseCount ++;
588: }
589: } else {
590: for (var j=0; j<document.courselist.course_id.length; j++) {
591: if (document.courselist.course_id[j].checked) {
592: courses = courses + document.courselist.course_id[j].value + "&&";
1.55 raeburn 593: courseCount ++;
594: }
1.57 raeburn 595: }
596: }
597: opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
598: if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
599: 'undefined') {
600: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
601: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55 raeburn 602: } else {
1.57 raeburn 603: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55 raeburn 604: }
1.57 raeburn 605: } else {
606: for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
607: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
608: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55 raeburn 609: } else {
1.57 raeburn 610: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54 raeburn 611: }
1.55 raeburn 612: }
1.57 raeburn 613: }
614: if (courseCount > 0) {
615: courses = courses.substr(0,courses.length-2);
616: opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
617: }
618: ENDSCRIPT
619: } else {
620: my $name_code;
621: if ($env{'form.cnameelement'} ne '') {
622: $name_code = 'opener.document.'.$env{'form.form'}.'.'.
623: $env{'form.cnameelement'}.'.value=cdesc;';
1.55 raeburn 624: }
1.57 raeburn 625: $output .= qq|
1.55 raeburn 626: $name_code
627: opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
628: var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
629: if (slct.options == undefined) {
630: opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
631: }
632: else {
633: var i;
634: for (i=0;i<slct.length;i++) {
635: if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54 raeburn 636: }
637: }
1.57 raeburn 638: |;
1.54 raeburn 639: }
1.57 raeburn 640: $output .= qq|
1.55 raeburn 641: if (openerForm == 'portform') {
642: document.courselist.cnum.value = cname;
643: document.courselist.cdom.value = cdom;
644: }
645: $autosubmit
646: $lastaction
1.54 raeburn 647: }
1.55 raeburn 648: </script>
1.57 raeburn 649: |;
1.55 raeburn 650: return $output;
1.54 raeburn 651: }
652:
1.55 raeburn 653: 1;
654: __END__
655:
656: =pod
657:
658: =head1 NAME
659:
660: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.
661:
662: =head1 SYNOPSIS
663:
664: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user.
665:
666: =head1 OVERVIEW
667:
668: Two screens are typically displayed to the user. The first is a set of criteria which are used to constrain the search for courses.
669:
670: =head2 Search Criteria (Screen One)
671:
672: =head3 Criteria:
673:
674: =over 4
675:
676: =item *
677: Course Activity - how recently was course last visited by anyone.
678:
679: =item *
680: Course Domain - the domain of the course
681:
682: =item *
1.57 raeburn 683: Course Type - Course or Non-standard Course
1.55 raeburn 684:
685: =item *
686: Course Institutional Code - the institutional identifier assigned to the course
687:
688: =item *
689: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
690:
691: =item *
692: Course Owner's Domain - the domain of the owner of the course
693:
694: =item *
695: Course Description - text which appears in the Course Description (or title), as set in the Course Parameters.
696:
697: =item *
698: 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).
699:
700: =back
701:
702: 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'}).
703:
704: =head2 Course Display (Screen Two)
705:
706: 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:
707:
708: =over 4
709:
710: =item *
711: Course description
712:
713: =item *
714: Domain description of course domain
715:
716: =item *
717: Course institutional code
718:
719: =item *
720: Course owner (username:domain)
721:
722: =back
723:
724: 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.
725:
726: 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.
727:
728: =head1 SUBROUTINES
729:
730: =over 4
731:
732: =item *
733: X<create_user_javascript()>
734: B<create_user_javascript($type)>:
735:
1.57 raeburn 736: Input: 1 - $type - the course type - Course or Non-standard Course
1.55 raeburn 737:
738: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
739:
740: Side Effects: None
741:
742: 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.
743:
744:
745: =item *
746: X<display_matched_courses()>
1.57 raeburn 747: B<display_matched_courses($r,$type,$multiple,$action,%courses)>:
1.55 raeburn 748:
1.57 raeburn 749: Input: 5 - request object, course type, multiple (0 or 1), form action; hash of courses.
1.55 raeburn 750:
751: Output: 0
752:
753: 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.
754:
755: =item *
756: X<multiples_tag()>
757: B<multiples_tag()>:
758:
759:
760: Input: 0
761:
762: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
763:
764: Side Effects: None
765:
766: =item *
767: X<build_filters()>
1.57 raeburn 768: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action)>:
1.55 raeburn 769:
770:
1.57 raeburn 771: Input: 6 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action.
1.55 raeburn 772:
773: Output: 1 - $output - HTML for display of search criteria, and hidden form elements.
774:
775: Side Effects: None
776:
777: =item *
778: X<search_courses()>
779: B<search_courses($r,$type,$onlyown,$filter)>:
780:
781:
782: 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.
783:
784: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
785:
786: Side Effects: None
787:
788:
789: =item *
790: X<course_chooser()>
791: B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>:
792:
793: Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description.
794:
795: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection.
796:
797: Side Effects: None
798:
799:
800: =item *
801: X<gochoose_javascript()>
1.57 raeburn 802: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55 raeburn 803:
1.66 raeburn 804: Input: 4 - course type; single (0) or multiple courses (1); in context of DC selecting a CC role in a course: javascript code from &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 805:
806: Output: 1 $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
807:
808: Side Effects: None
809:
810: javascript functions used when user selects a course(s). Different behavior depending on context:
811:
812: =back
813:
814: =over 8
815:
816: =item
817:
818: (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.
819:
820: =item
821:
822: (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.
823:
824: =item
825:
826: (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.
827:
828: =item
1.54 raeburn 829:
1.55 raeburn 830: (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 831:
1.55 raeburn 832: =item
1.54 raeburn 833:
1.55 raeburn 834: (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 835:
1.55 raeburn 836: =item
1.54 raeburn 837:
1.55 raeburn 838: (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 839:
1.55 raeburn 840: =item
1.49 raeburn 841:
1.55 raeburn 842: (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 843:
1.55 raeburn 844: =back
845:
846: =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