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