loncom/interface/lonpickcourse.pm - view

File: [LON-CAPA] / loncom / interface / lonpickcourse.pm
Revision 1.84: download - view: text, annotated - select for diffs
Wed Jul 29 22:32:44 2009 UTC (14 years, 10 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD

lonpickcourse.pm
- Wording change.  "Course Type" changed to "Type".
- course filter form now sets a form element named "command" to 'gosearch' on submit.
- course filter form will automatically reload, but not search,
  if either Domain or Type are changed.

courseclassifier.pm
 Javascript function "setOfficial() checks if caller arg is defined

lond
&dump_course_id_handler() change.
 - change to the effect regexp_ok arg.
 - now if arg has a value of -1, a course will be excluded from the resturned list,
   if the instcode matches the RE.
   This excludes "official" courses (i.e., those with an instcode matching the expected pattern for the domain) from the list returned in a search for "unofficial" courses.

1: # The LearningOnline Network 2: # Pick a course 3: # 4: # $Id: lonpickcourse.pm,v 1.84 2009/07/29 22:32:44 raeburn Exp $ 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; 36: use Apache::lonlocal; 37: use Apache::longroup; 38: use Apache::courseclassifier; 39: use LONCAPA; 40: 41: sub handler { 42: my $r = shift; 43: &Apache::loncommon::content_type($r,'text/html'); 44: $r->send_http_header; 45: return OK if $r->header_only; 46: 47: # ------------------------------------------------------------ Print the screen 48: 49: # Get parameters from query string 50: &Apache::loncommon::get_unprocessed_cgi 51: ($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement', 52: 'cdomelement','cnameelement','roleelement', 53: 'multiple','type','setroles','fixeddom']); 54: my ($type,$title,$jscript,$multelement,$multiple,$roleelement, 55: $lastaction,$autosubmit,$submitopener); 56: 57: # Get course type - Course or Community. 58: $type = $env{'form.type'}; 59: if (!defined($env{'form.type'})) { 60: $type = 'Course'; 61: } 62: $title = 'Selecting a '.$type; 63: 64: # Setup for multiple course selections, if flag for multiples set. 65: $multiple = $env{'form.multiple'}; 66: if ($multiple) { 67: ($jscript,$multelement) = &multiples_tag(); 68: $title = 'Selecting '.$type.'(s)'; 69: } 70: 71: # if called when a DC is selecting a course 72: my $roledom = $env{'form.roleelement'}; 73: if ($roledom) { 74: $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />'; 75: $submitopener = &processpick(); 76: $autosubmit = 'process_pick("'.$roledom.'")'; 77: } 78: 79: my $onlyown = 0; 80: # if called to assign course-based portfolio access control 81: if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) { 82: $onlyown = 1; 83: } 84: 85: my %loaditem; 86: if (($env{'form.type'} eq 'Course') && ($env{'form.numtitles'})) { 87: if (($env{'form.official'} eq 'on') && ($env{'form.state'} eq 'listing')) { 88: $loaditem{'onload'} = 'setElements(document.filterpicker); '; 89: } 90: } 91: 92: if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) && 93: ($env{'form.pickedcourse'})) { 94: $loaditem{'onload'} .= 'setSections()'; 95: } 96: $r->print(&Apache::loncommon::start_page($title,undef, 97: {'add_entries' => \%loaditem, 98: 'no_nav_bar' => 1, })); 99: 100: if ($env{'form.form'} eq 'portform') { 101: $lastaction = 'document.courselist.submit()'; 102: } elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' && 103: !$multiple)) { 104: $lastaction = 105: 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n". 106: 'document.courselist.submit();'; 107: } else { 108: $lastaction = 'self.close()'; 109: } 110: 111: # if called to assign a role in a course to a user via CUSR 112: if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') { 113: $r->print(&create_user_javascript($type)); 114: } 115: 116: # print javascript functions for choosing a course 117: if (($env{'form.command'} eq 'gosearch') || $onlyown) { 118: $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction)); 119: } 120: $r->print('<script type="text/javascript" language="Javascript">'.$jscript. 121: '</script>'); 122: $r->print($submitopener); 123: 124: # ------------------------------------------ Display of filters to limit search 125: my $filter = {}; 126: my $action = '/adm/pickcourse'; 127: my ($numtitles,$showroles,$nohost); 128: if (!$onlyown) { 129: my $filterlist = ['domainfilter','descriptfilter', 130: 'instcodefilter']; 131: if ($env{'form.form'} eq 'rules') { 132: push(@{$filterlist},'personfilter'); 133: if (($env{'form.personfilter'} ne '') && ($env{'form.persondomfilter'} ne '')) { 134: if (&Apache::lonnet::homeserver($env{'form.personfilter'}, 135: $env{'form.persondomfilter'}) eq 'no_host') { 136: $nohost = 1; 137: } else { 138: $showroles = 1; 139: } 140: } 141: } else { 142: push(@{$filterlist},'ownerfilter'); 143: } 144: # course ID filter for DCs only 145: if ($env{'user.adv'} && $env{'form.domainfilter'} && 146: exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) { 147: push(@{$filterlist},'coursefilter'); 148: } 149: $r->print(&build_filters($filterlist,$type,$roleelement,$multelement, 150: $filter,$action,\$numtitles)); 151: } 152: 153: # ---------------------------------------------------------------- Get the data 154: if (($env{'form.command'} eq 'gosearch') || $onlyown) { 155: my %courses = &search_courses($r,$type,$onlyown,$filter,$numtitles); 156: if ($nohost) { 157: $r->print ('<span class="LC_warning">'. 158: &mt('User does not exist - username: [_1], domain: [_2].', 159: '<b>'.$filter->{'personfilter'}.'</b>', 160: '<b>'.$filter->{'persondomfilter'}.'</b>').'</span>'); 161: } else { 162: &display_matched_courses($r,$type,$multiple,$action,$showroles,%courses); 163: } 164: } 165: $r->print(&Apache::loncommon::end_page()); 166: return OK; 167: } 168: 169: sub processpick { 170: my $openerform = 'rolechoice'; 171: if ($env{'form.form'} eq 'studentform') { 172: $openerform = $env{'form.form'}; 173: } 174: my $process_pick = <<"ENDONE"; 175: <script type="text/javascript"> 176: function process_pick(dom) { 177: var pickedCourse=opener.document.$openerform.$env{'form.cnumelement'}.value; 178: var pickedDomain=opener.document.$openerform.$env{'form.cdomelement'}.value; 179: var okDomain = 0; 180: ENDONE 181: if ($openerform eq 'rolechoice') { 182: $process_pick .= <<"ENDTWO"; 183: if (pickedDomain == dom) { 184: if (pickedCourse != '') { 185: var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse 186: opener.document.title='Role selected. Please stand by.'; 187: opener.status='Role selected. Please stand by.'; 188: opener.document.rolechoice.newrole.value=courseTarget 189: opener.document.rolechoice.submit(); 190: } 191: } 192: else { 193: 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"); 194: } 195: ENDTWO 196: } else { 197: $process_pick .= <<"ENDTHREE"; 198: if (pickedDomain != dom) { 199: 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"); 200: return; 201: } 202: ENDTHREE 203: } 204: $process_pick .= " 205: } 206: 207: </script> 208: "; 209: return $process_pick; 210: } 211: 212: sub create_user_javascript { 213: my ($type) = @_; 214: my $output; 215: #javascript for reporting sections and groups then closing 216: if ($env{'form.pickedcourse'}) { 217: my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'}; 218: my $sec_element = 'currsec'; 219: my $grplist_element = 'groups'; 220: my ($sections,$groups) = 221: &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type); 222: my $num_sections = scalar(@{$sections}); 223: my $seclist = join(',',@{$sections}); 224: my $num_groups = scalar(@{$groups}); 225: my $groupslist = join(',',@{$groups}); 226: $output = qq| 227: <script type="text/javascript"> 228: function setSections() { 229: opener.document.$env{"form.form"}.$grplist_element.value='$groupslist'; 230: window.opener.setSect('$seclist'); 231: self.close() 232: } 233: </script> 234: |; 235: ; 236: } 237: return $output; 238: } 239: 240: sub display_matched_courses { 241: my ($r,$type,$multiple,$action,$showroles,%courses) = @_; 242: if ($env{'form.form'} eq 'portform') { 243: $action = '/adm/portfolio'; 244: } 245: my $numcourses = keys(%courses); 246: $r->print('<form name="courselist" method="post" action="'.$action.'">'); 247: if ($env{'form.form'} eq 'modifycourse') { 248: if ($numcourses > 0) { 249: my $cctitle = &Apache::lonnet::plaintext('cc',$type); 250: my $dctitle = &Apache::lonnet::plaintext('dc'); 251: my $ccrolechk = ' checked="checked" '; 252: my $menuchk = ' '; 253: if ($env{'form.prevphase'} ne '') { 254: $ccrolechk = ' '; 255: $menuchk = ' checked="checked" '; 256: } 257: $r->print( 258: '<fieldset>' 259: .'<legend>'.&mt('Action').'</legend>' 260: .'<div class="LC_nobreak"><label>' 261: .'<input type="radio" name="phase" value="ccrole"'.$ccrolechk.'/>' 262: .' '.&mt('Enter the course with the role of [_1].',$cctitle) 263: .'</label></div>' 264: .'<div class="LC_nobreak"><label>' 265: .'<input type="radio" name="phase" value="menu"'.$menuchk.'/> ' 266: .&mt('View or modify course settings which only a [_1] may modify.',$dctitle) 267: .'</label></div>' 268: .'</fieldset>' 269: .'<br />' 270: ); 271: } 272: } 273: my %by_descrip; 274: foreach my $course (keys(%courses)) { 275: my $descr; 276: if (ref($courses{$course}) eq 'HASH') { 277: $descr = $courses{$course}{'description'}; 278: } elsif ($courses{$course} =~ m/^([^:]*):/i) { 279: $descr = &unescape($1); 280: } else { 281: $descr = &unescape($courses{$course}); 282: } 283: my $description = $descr; 284: push (@{$by_descrip{$description}}, $course); 285: } 286: 287: if ($numcourses > 1 && $multiple) { 288: $r->print('<input type="button" value="check all" 289: onclick="javascript:checkAll(document.courselist.course_id)" /> 290:   <input type="button" value="uncheck all" 291: onclick="javascript:uncheckAll(document.courselist.course_id)" /> 292: <br /><br />'); 293: } 294: 295: if (%courses) { 296: $r->print(&Apache::loncommon::start_data_table()); 297: $r->print(&Apache::loncommon::start_data_table_header_row()); 298: $r->print('<th>'.&mt('Select').'</th>' 299: .'<th>'.&mt('Course Title').'</th>' 300: .'<th>'.&mt('Domain').'</th>' 301: .'<th>'.&mt('Course Code').'</th>' 302: .'<th>'.&mt('Owner/Co-owner(s)').'</th>' 303: .'<th>'.&mt('Type').'</th>' 304: ); 305: if ($showroles) { 306: $r->print('<th>'.&mt("Role(s) for [_1]", 307: &Apache::loncommon::plainname($env{'form.personfilter'}, 308: $env{'form.persondomfilter'},'firstname')).'</th>'); 309: } 310: $r->print(&Apache::loncommon::end_data_table_header_row()); 311: } 312: foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) { 313: foreach my $course (@{$by_descrip{$description}}) { 314: $r->print(&Apache::loncommon::start_data_table_row()); 315: my $cleandesc=&HTML::Entities::encode($description,'<>&"'); 316: $cleandesc=~s/'/\\'/g; 317: my ($cdom,$cnum)=split(/\_/,$course); 318: my ($descr,$instcode,$ttype,@owners); 319: if (ref($courses{$course}) eq 'HASH') { 320: $descr = $courses{$course}{'description'}; 321: $instcode = $courses{$course}{'inst_code'}; 322: $ttype = $courses{$course}{'type'}; 323: push(@owners,&unescape($courses{$course}{'owner'})); 324: if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') { 325: foreach my $item (@{$courses{$course}{'co-owners'}}) { 326: push(@owners,&unescape($item)); 327: } 328: } 329: } else { 330: my $singleowner; 331: ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course}); 332: push(@owners,&unescape($singleowner)); 333: } 334: my $ownerstr = join(', ',@owners); 335: $r->print('<td>'.&course_chooser($multiple,$cdom,$cnum,$cleandesc).'</td>'); 336: $r->print('<td>'.$description.'</td>'); 337: $r->print('<td>'); 338: $r->print(&Apache::lonnet::domain($cdom,'description')? 339: $cdom.' ('.&Apache::lonnet::domain($cdom,'description').')':$cdom); 340: $r->print('</td>'); 341: $r->print('<td>'); 342: if ($instcode ne '') { 343: $r->print(&unescape($instcode)); 344: } else { 345: $r->print(' '); 346: } 347: $r->print('</td>'); 348: $r->print('<td>'.$ownerstr.'</td>'); 349: $r->print('<td>'); 350: if ($ttype ne '') { 351: $r->print(&mt(&unescape($ttype))); 352: } else { 353: $r->print(' '); 354: } 355: $r->print('</td>'); 356: if ($showroles) { 357: $r->print('<td>'); 358: my $rolestr; 359: if (ref($courses{$course}{'roles'}) eq 'ARRAY') { 360: my @roles = sort(@{$courses{$course}{'roles'}}); 361: foreach my $role (@roles) { 362: if ($role =~ /^cr/) { 363: my (undef,$crdom,$crname,$crtitle) = split('/',$role); 364: $rolestr .= $crtitle.', '; 365: } else { 366: $rolestr .= &Apache::lonnet::plaintext($role,$ttype).', '; 367: } 368: } 369: $rolestr =~ s/\, $//; 370: } 371: $r->print($rolestr.'</td>'); 372: } 373: if ($multiple) { $r->print("</label>\n"); } 374: $r->print(&Apache::loncommon::end_data_table_row()); 375: # $r->print("<br />\n"); 376: } 377: } 378: if (%courses) { 379: $r->print(&Apache::loncommon::end_data_table()); 380: } 381: 382: if (!%courses) { 383: $r->print(&mt('None found')); 384: } elsif ($multiple) { 385: $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />'); 386: } 387: $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'. 388: "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n". 389: '<input type="hidden" name="type" value="'.$type.'" />'."\n"); 390: if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) { 391: $r->print('<input type="hidden" name="roleelement" value="'. 392: $env{'form.roleelement'}.'" />'."\n"); 393: } 394: if ($env{'form.form'} eq 'portform') { 395: $r->print('<input type="hidden" name="cnum" value="" />'); 396: $r->print('<input type="hidden" name="cdom" value="" />'); 397: $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />'); 398: $r->print('<input type="hidden" name="action" value="rolepicker" />'); 399: } elsif ($env{'form.form'} eq 'modifycourse') { 400: $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form','numtitles','state','command'])); 401: } else { 402: $r->print('<input type="hidden" name="cnumelement" value="'. 403: $env{'form.cnumelement'}.'" />'."\n". 404: '<input type="hidden" name="cdomelement" value="'. 405: $env{'form.cdomelement'}.'" />'."\n"); 406: } 407: if ((exists($env{'form.fixeddom'})) && ($env{'form.form'} eq 'rules')) { 408: $r->print('<input type="hidden" name="fixeddom" value="'. 409: $env{'form.fixeddom'}.'" />'); 410: } 411: if ($env{'form.numtitles'}) { 412: $r->print('<input type="hidden" name="numtitles" value="'. 413: $env{'form.numtitles'}.'" />'); 414: } 415: $r->print("</form>\n"); 416: return; 417: } 418: 419: sub multiples_tag { 420: my $jscript = &Apache::loncommon::check_uncheck_jscript(); 421: my $multelement = '<input type="hidden" name="multiple" value="1" />'; 422: return ($jscript,$multelement); 423: } 424: 425: sub build_filters { 426: my ($filterlist,$type,$roleelement,$multelement,$filter,$action, 427: $numtitlesref,$caller) = @_; 428: my $list; 429: my $formname; 430: my ($fixeddom,$codedom,$jscript); 431: if (defined($env{'form.form'})) { 432: $formname = $env{'form.form'}; 433: } else { 434: $formname = $caller; 435: } 436: my $onchange; 437: unless ($env{'form.interface'} eq 'textual') { 438: $onchange = 1; 439: } 440: my ($domainselectform,$sincefilterform,$ownerdomselectform,$persondomselectform, 441: $instcodeform,$typeselectform,$instcodetitle); 442: foreach my $item (@{$filterlist}) { 443: $filter->{$item} = $env{'form.'.$item}; 444: if ($item ne 'descriptfilter' && $item ne 'instcodefilter') { 445: if ($item eq 'domainfilter') { 446: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item}); 447: } elsif ($item eq 'coursefilter') { 448: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item}); 449: } elsif ($item eq 'ownerfilter') { 450: $filter->{$item} = &LONCAPA::clean_username($filter->{$item}); 451: $filter->{'ownerdomfilter'} = 452: &LONCAPA::clean_domain($env{'form.ownerdomfilter'}); 453: $ownerdomselectform = 454: &Apache::loncommon::select_dom_form($filter->{'ownerdomfilter'}, 455: 'ownerdomfilter',1); 456: } elsif ($item eq 'personfilter') { 457: $filter->{$item} = &LONCAPA::clean_username($filter->{$item}); 458: if ($env{'form.persondomfilter'} eq '') { 459: unless ($env{'form.command'} eq 'gosearch') { 460: $filter->{'persondomfilter'} = $env{'request.role.domain'}; 461: } 462: } else { 463: $filter->{'persondomfilter'} = 464: &LONCAPA::clean_domain($env{'form.persondomfilter'}); 465: } 466: $persondomselectform = 467: &Apache::loncommon::select_dom_form($filter->{'persondomfilter'}, 468: 'persondomfilter',1); 469: } else { 470: $filter->{$item} =~ s/\W//g; 471: } 472: if (!$filter->{$item}) { 473: $filter->{$item} = ''; 474: } 475: } 476: if ($item eq 'domainfilter') { 477: my $allow_blank = 1; 478: if ($formname eq 'portform') { 479: $filter->{$item} ||= $env{'user.domain'}; 480: $allow_blank=0; 481: } elsif ($formname eq 'studentform') { 482: $filter->{$item} ||= $env{'request.role.domain'}; 483: $allow_blank=0; 484: } 485: if ($env{'form.fixeddom'}) { 486: $domainselectform = '<input type="hidden" name="domainfilter"'. 487: 'value="'.$env{'request.role.domain'}.'" />'. 488: &Apache::lonnet::domain($env{'request.role.domain'}, 489: 'description'); 490: $codedom = $env{'request.role.domain'}; 491: } else { 492: $domainselectform = 493: &Apache::loncommon::select_dom_form($filter->{$item}, 494: 'domainfilter', 495: $allow_blank,'',$onchange); 496: $codedom = $filter->{'domainfilter'}; 497: } 498: } else { 499: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"'); 500: } 501: } 502: 503: # last course activity filter and selection 504: $filter->{'sincefilter'} = $env{'form.sincefilter'}; 505: $filter->{'sincefilter'} =~ s/[^\d-]//g; 506: if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; } 507: $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'}, 508: 'sincefilter',('-1'=>'', 509: '86400' => 'today', 510: '604800' => 'last week', 511: '2592000' => 'last month', 512: '7776000' => 'last three months', 513: '15552000' => 'last six months', 514: '31104000' => 'last year', 515: 'select_form_order' => 516: ['-1','86400','604800','2592000','7776000', 517: '15552000','31104000'])); 518: 519: my %lt = ( 520: 'cac' => &mt("$type Activity"), 521: 'cde' => &mt("$type Title"), 522: 'cdo' => &mt("$type Domain"), 523: 'ins' => &mt('Institutional Code'), 524: 'inc' => &mt('Institutional Categorization'), 525: 'cow' => &mt("$type Owner/Co-owner"), 526: 'cop' => &mt("$type Personnel Includes"), 527: 'cog' => &mt('Type') 528: ); 529: 530: $typeselectform = '<select name="type" size="1"'; 531: if ($onchange) { 532: $typeselectform .= 'onchange=" javascript:submit()"'; 533: } 534: $typeselectform .= '>'."\n"; 535: my $officialjs; 536: if ($type eq 'Course') { 537: if (($env{'form.fixeddom'}) || ($env{'form.form'} eq 'requestcrs')) { 538: $officialjs = 1; 539: ($instcodeform,$jscript,$$numtitlesref) = 540: &instcode_selectors($codedom,'filterpicker',$officialjs); 541: } 542: if ($instcodeform eq '') { 543: $instcodeform = 544: '<input type="text" name="instcodefilter" size="10" value="'. 545: $list->{'instcodefilter'}.'" />'; 546: $instcodetitle = $lt{'ins'}; 547: } else { 548: $instcodetitle = $lt{'inc'}; 549: } 550: if ($env{'form.fixeddom'}) { 551: $instcodetitle .= '<br />('.$codedom.')'; 552: } 553: } 554: $jscript .= <<"END_JS"; 555: 556: function setCommand() { 557: document.filterpicker.command.value = 'gosearch'; 558: return; 559: } 560: 561: END_JS 562: 563: $jscript = '<script type="text/javascript" language="Javascript">'.$jscript. 564: '</script>'."\n"; 565: 566: foreach my $posstype ('Course','Community') { 567: $typeselectform.='<option value="'.$posstype.'"'. 568: ($posstype eq $type ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n"; 569: } 570: $typeselectform.="</select>"; 571: my $output = qq| 572: <form method="post" name="filterpicker" action="$action" onsubmit="setCommand()"> 573: <input type="hidden" name="form" value="$formname" /> 574: |; 575: if ($formname eq 'modifycourse') { 576: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n". 577: '<input type="hidden" name="prevphase" value="'. 578: $env{'form.prevphase'}.'" />'."\n"; 579: } else { 580: my $name_input; 581: if ($env{'form.cnameelement'} ne '') { 582: $name_input = '<input type="hidden" name="cnameelement" value="'. 583: $env{'form.cnameelement'}.'" />'; 584: } 585: $output .= qq| 586: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" /> 587: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" /> 588: $name_input 589: $roleelement 590: $multelement 591: |; 592: if ($formname eq 'portform') { 593: $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />'."\n"; 594: } 595: } 596: if ($env{'form.fixeddom'}) { 597: $output .= '<input type="hidden" name="fixeddom" value="'.$env{'form.fixeddom'}.'" />'."\n"; 598: } 599: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box(); 600: if ($sincefilterform) { 601: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'}) 602: .$sincefilterform 603: .&Apache::lonhtmlcommon::row_closure(); 604: } 605: if ($domainselectform) { 606: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'}) 607: .$domainselectform 608: .&Apache::lonhtmlcommon::row_closure(); 609: } 610: if ($typeselectform) { 611: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'}) 612: .$typeselectform 613: .&Apache::lonhtmlcommon::row_closure(); 614: } 615: if ($instcodeform) { 616: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle) 617: .$instcodeform 618: .&Apache::lonhtmlcommon::row_closure(); 619: } 620: if (exists($filter->{'ownerfilter'})) { 621: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}). 622: '<table><tr><td>'.&mt('Username').'<br />'. 623: '<input type="text" name="ownerfilter" size="20" value="'. 624: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'. 625: $ownerdomselectform.'</td></tr></table>'. 626: &Apache::lonhtmlcommon::row_closure(); 627: } 628: if (exists($filter->{'personfilter'})) { 629: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}). 630: '<table><tr><td>'.&mt('Username').'<br />'. 631: '<input type="text" name="personfilter" size="20" value="'. 632: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'. 633: $persondomselectform.'</td></tr></table>'. 634: &Apache::lonhtmlcommon::row_closure(); 635: } 636: if (exists($filter->{'coursefilter'})) { 637: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID')) 638: .'<input type="text" name="coursefilter" size="25" value="' 639: .$list->{'coursefilter'}.'" />' 640: .&Apache::lonhtmlcommon::row_closure(); 641: } 642: if (exists($filter->{'descriptfilter'})) { 643: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'}) 644: .'<input type="text" name="descriptfilter" size="40" value="' 645: .$list->{'descriptfilter'}.'" />' 646: .&Apache::lonhtmlcommon::row_closure(1); 647: } 648: $output .= &Apache::lonhtmlcommon::end_pick_box(); 649: $output .= '<p><input type="hidden" name="command" value="">'."\n". 650: '<input type="submit" name="gosearch" value="'. 651: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n"; 652: return $jscript.$output; 653: } 654: 655: sub instcode_selectors { 656: my ($codedom,$formname,$officialjs) = @_; 657: my ($output,@codetitles,%cat_titles,%cat_order,%cat_items); 658: my ($jscript,$totcodes,$numtitles,$lasttitle) = 659: &Apache::courseclassifier::instcode_selectors_data($codedom,$formname, 660: \%cat_items,\@codetitles,\%cat_titles,\%cat_order,$officialjs); 661: if ($numtitles > 0) { 662: my $official = ' checked="checked" '; 663: my $unofficial = ''; 664: if ($env{'form.official'} eq 'off') { 665: $unofficial = $official; 666: $official = ''; 667: } 668: $output .= '<span class="LC_nobreak">'.&mt('Official course:').' <label>'. 669: '<input type="radio" name="official" value="on"'.$official.' />'. 670: &mt('Yes').'</label>'.(' 'x3).'<label>'. 671: '<input type="radio" name="official" value="off"'.$unofficial. 672: ' onclick="toggleOfficial();" />'.&mt('No').'</label></span><br />'. 673: &Apache::courseclassifier::build_instcode_selectors($numtitles, 674: $lasttitle,\%cat_items,\@codetitles,\%cat_titles,\%cat_order)."\n". 675: '<input type="hidden" name="numtitles" value="'.$numtitles.'" />'."\n". 676: '<input type="hidden" name="state" value="listing" />'."\n"; 677: 678: } 679: return ($output,$jscript,$numtitles); 680: } 681: 682: sub search_courses { 683: my ($r,$type,$onlyown,$filter,$numtitles) = @_; 684: my (%courses,%showcourses); 685: if (!$onlyown) { 686: $r->print(&mt('Searching ...').'<br /> <br />'); 687: $r->rflush(); 688: if (($filter->{'ownerfilter'} ne '') || 689: ($filter->{'ownerdomfilter'} ne '')) { 690: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'. 691: $filter->{'ownerdomfilter'}; 692: } 693: foreach my $item ('descriptfilter','coursefilter','combownerfilter') { 694: if (!$filter->{$item}) { 695: $filter->{$item}='.'; 696: } 697: } 698: my $timefilter = 699: ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'}); 700: my ($instcodefilter,$regexpok); 701: if ($numtitles) { 702: if ($env{'form.official'} eq 'on') { 703: $instcodefilter = 704: &Apache::courseclassifier::instcode_search_str($filter->{'domainfilter'},$numtitles); 705: $regexpok = 1; 706: } elsif ($env{'form.official'} eq 'off') { 707: $instcodefilter = &Apache::courseclassifier::instcode_search_str($filter->{'domainfilter'},$numtitles); 708: unless ($instcodefilter eq '') { 709: $regexpok = -1; 710: } 711: } 712: } else { 713: $instcodefilter = $filter->{'instcodefilter'}; 714: } 715: if ($instcodefilter eq '') { $instcodefilter = '.'; } 716: if ($type eq '') { $type = '.'; } 717: %courses = 718: &Apache::lonnet::courseiddump($filter->{'domainfilter'}, 719: $filter->{'descriptfilter'}, 720: $timefilter, 721: $instcodefilter, 722: $filter->{'combownerfilter'}, 723: $filter->{'coursefilter'}, 724: undef,undef,$type,$regexpok); 725: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) { 726: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'}, 727: $filter->{'persondomfilter'}, 728: 'userroles',undef, 729: ['cc','in','ad','ep','ta','cr'], 730: $filter->{'domainfilter'}); 731: foreach my $role (keys(%rolehash)) { 732: my ($cnum,$cdom,$courserole) = split(':',$role); 733: my $cid = $cdom.'_'.$cnum; 734: if (exists($courses{$cid})) { 735: if (ref($courses{$cid}) eq 'HASH') { 736: if (ref($courses{$cid}{roles}) eq 'ARRAY') { 737: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) { 738: push (@{$courses{$cid}{roles}},$courserole); 739: } 740: } else { 741: $courses{$cid}{roles} = [$courserole]; 742: } 743: $showcourses{$cid} = $courses{$cid}; 744: } 745: } 746: } 747: %courses = %showcourses; 748: } 749: } else { 750: $r->print('<br />'); 751: my %coursehash = &Apache::loncommon::findallcourses(); 752: foreach my $cid (sort(keys(%coursehash))) { 753: $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'}; 754: } 755: } 756: return %courses; 757: } 758: 759: sub course_chooser { 760: my ($multiple,$cdom,$cnum,$cleandesc) = @_; 761: my $output; 762: if ($multiple) { 763: $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n"; 764: } else { 765: $output = '<input type="button" value="'.&mt('Select').'" onClick="gochoose('. 766: "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n"; 767: } 768: return $output; 769: } 770: 771: sub gochoose_javascript { 772: my ($type,$multiple,$autosubmit,$lastaction) = @_; 773: my %elements = ( 774: 'Course' => { 775: name => 'coursepick', 776: total => 'coursetotal', 777: list => 'courselist', 778: }, 779: 'Community' => { 780: name => 'grouppick', 781: total => 'grouptotal', 782: list => 'grouplist', 783: }, 784: ); 785: my $output .= qq| 786: <script type="text/javascript"> 787: function gochoose(cname,cdom,cdesc) { 788: var openerForm = "$env{'form.form'}"; 789: courseCount = 0; 790: var courses = ''; 791: |; 792: if ($multiple) { 793: $output .= <<"ENDSCRIPT"; 794: courseCount = 0; 795: var courses = ''; 796: if (typeof(document.courselist.course_id.length) == 'undefined') { 797: // only 1 course checkbox was created 798: if (document.courselist.course_id.checked) { 799: courses = courses + document.courselist.course_id.value + "&&"; 800: courseCount ++; 801: } 802: } else { 803: for (var j=0; j<document.courselist.course_id.length; j++) { 804: if (document.courselist.course_id[j].checked) { 805: courses = courses + document.courselist.course_id[j].value + "&&"; 806: courseCount ++; 807: } 808: } 809: } 810: opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount; 811: if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) == 812: 'undefined') { 813: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') { 814: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true; 815: } else { 816: opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false; 817: } 818: } else { 819: for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) { 820: if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') { 821: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true; 822: } else { 823: opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false; 824: } 825: } 826: } 827: if (courseCount > 0) { 828: courses = courses.substr(0,courses.length-2); 829: opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses; 830: } 831: ENDSCRIPT 832: } else { 833: my $name_code; 834: if ($env{'form.cnameelement'} ne '') { 835: $name_code = 'opener.document.'.$env{'form.form'}.'.'. 836: $env{'form.cnameelement'}.'.value=cdesc;'; 837: } 838: $output .= qq| 839: $name_code 840: opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname; 841: var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'}; 842: if (slct.options == undefined) { 843: opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom; 844: } 845: else { 846: var i; 847: for (i=0;i<slct.length;i++) { 848: if (slct.options[i].value==cdom) { slct.selectedIndex=i; } 849: } 850: } 851: |; 852: } 853: $output .= qq| 854: if (openerForm == 'portform') { 855: document.courselist.cnum.value = cname; 856: document.courselist.cdom.value = cdom; 857: } 858: $autosubmit 859: $lastaction 860: } 861: </script> 862: |; 863: return $output; 864: } 865: 866: 1; 867: __END__ 868: 869: =pod 870: 871: =head1 NAME 872: 873: Apache::lonpickcourse - Search for course(s) based on user-specified criteria. 874: 875: =head1 SYNOPSIS 876: 877: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user. 878: 879: =head1 OVERVIEW 880: 881: Two screens are typically displayed to the user. The first is a set of criteria which are used to constrain the search for courses. 882: 883: =head2 Search Criteria (Screen One) 884: 885: =head3 Criteria: 886: 887: =over 4 888: 889: =item * 890: Course Activity - how recently was course last visited by anyone. 891: 892: =item * 893: Course Domain - the domain of the course 894: 895: =item * 896: Type - Course or Community 897: 898: =item * 899: Course Institutional Code - the institutional identifier assigned to the course 900: 901: =item * 902: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created). 903: 904: =item * 905: Course Owner's Domain - the domain of the owner of the course 906: 907: =item * 908: Course Title - text which appears in the Course Title, as set in the Course Parameters. 909: 910: =item * 911: 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). 912: 913: =back 914: 915: 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'}). 916: 917: =head2 Course Display (Screen Two) 918: 919: 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: 920: 921: =over 4 922: 923: =item * 924: Course description 925: 926: =item * 927: Domain description of course domain 928: 929: =item * 930: Course institutional code 931: 932: =item * 933: Course owner (username:domain) 934: 935: =back 936: 937: 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. 938: 939: 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. 940: 941: =head1 SUBROUTINES 942: 943: =over 4 944: 945: =item * 946: X<create_user_javascript()> 947: B<create_user_javascript($type)>: 948: 949: Input: 1 - $type - the course type - Course or Community 950: 951: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags 952: 953: Side Effects: None 954: 955: 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. 956: 957: 958: =item * 959: X<display_matched_courses()> 960: B<display_matched_courses($r,$type,$multiple,$action,$showroles,%courses)>: 961: 962: Input: 7 - request object, course type, multiple (0 or 1), form action, whether to show roles (for course personnel filter), hash of courses. 963: 964: Output: 0 965: 966: 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. 967: 968: =item * 969: X<multiples_tag()> 970: B<multiples_tag()>: 971: 972: 973: Input: 0 974: 975: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1. 976: 977: Side Effects: None 978: 979: =item * 980: X<build_filters()> 981: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action,$numfiltersref,$caller)>: 982: 983: 984: Input: 7 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action; ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number); caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm). 985: 986: Output: 1 - $output - HTML for display of search criteria, and hidden form elements. 987: 988: Side Effects: None 989: 990: =item * 991: X<search_courses()> 992: B<search_courses($r,$type,$onlyown,$filter,$numtitles)>: 993: 994: 995: 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; for institutional codes - number of categories). 996: 997: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type. 998: 999: Side Effects: None 1000: 1001: 1002: =item * 1003: X<course_chooser()> 1004: B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>: 1005: 1006: Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description. 1007: 1008: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection. 1009: 1010: Side Effects: None 1011: 1012: 1013: =item * 1014: X<gochoose_javascript()> 1015: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>: 1016: 1017: 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. 1018: 1019: Output: 1 $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags 1020: 1021: Side Effects: None 1022: 1023: javascript functions used when user selects a course(s). Different behavior depending on context: 1024: 1025: =back 1026: 1027: =over 8 1028: 1029: =item 1030: 1031: (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. 1032: 1033: =item 1034: 1035: (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. 1036: 1037: =item 1038: 1039: (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. 1040: 1041: =item 1042: 1043: (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. 1044: 1045: =item 1046: 1047: (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. 1048: 1049: =item 1050: 1051: (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. 1052: 1053: =item 1054: 1055: (g) Scantron Operator uploading a scantron file to a course - course number is written to visible form element in opener window. Child window closes. 1056: 1057: =item 1058: 1059: (h) User requesting creation of a course, and selecting a course to clone - course number and domain written to visible form elements in opener window. Child window closes. 1060: 1061: =back 1062: 1063: =cut