Return to lonpickcourse.pm CVS log

Up to [LON-CAPA] / loncom / interface

&coursegroups() and &get_group_settings() moved to longroup.pm, which contains general utility functions for asking about groups.  Also contains &group_changes() which is used to add/drop group memberships as a result of role changes, as determined by group settings for auto-add and auto-drop. 'none' and 'all' are now reserved words which may not be used as section or group names, so they can be used instead of _all and _none  when specifying auto-add and auto-drop settings for all sections or no section roles.

    1: # The LearningOnline Network
    2: # Pick a course
    3: #
    4: # $Id: lonpickcourse.pm,v 1.46 2006/05/18 01:08:50 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: 
   39: sub handler {
   40:     my $r = shift;
   41:     &Apache::loncommon::content_type($r,'text/html');
   42:     $r->send_http_header;
   43:     return OK if $r->header_only;
   44: 
   45: # ------------------------------------------------------------ Print the screen
   46: 
   47: # Get parameters from query string
   48:     &Apache::loncommon::get_unprocessed_cgi
   49:         ($ENV{'QUERY_STRING'},['domainfilter','descriptfilter',
   50: 			       'sincefilter','form','cnumelement',
   51: 			       'cdomelement','cnameelement','roleelement',
   52:                                'pickedcourse','instcodefilter',
   53:                                'ownerfilter','coursefilter','multiple']);
   54: # domain filter and selection
   55:     my $domainfilter=$env{'form.domainfilter'};
   56:     $domainfilter=~s/\W//g;
   57:     unless ($domainfilter) { $domainfilter=''; }
   58:     my $domainselectform=&Apache::loncommon::select_dom_form($domainfilter,
   59:                                                           'domainfilter',1);
   60: # description filter
   61:     my $descriptfilter=$env{'form.descriptfilter'};
   62:     unless ($descriptfilter) { $descriptfilter=''; }
   63:     my $listdescript=&HTML::Entities::encode($descriptfilter,'<>&"');
   64: # institutional code filter
   65:     my $instcodefilter=$env{'form.instcodefilter'};
   66:     unless ($instcodefilter) { $instcodefilter=''; }
   67:     my $listinstcode=&HTML::Entities::encode($instcodefilter,'<>&"');
   68: # course owner filter
   69:     my $ownerfilter=$env{'form.ownerfilter'};
   70:     unless ($ownerfilter) { $ownerfilter=''; }
   71:     my $listowner=&HTML::Entities::encode($ownerfilter,'<>&"');
   72: # course ID filter for DCs only
   73:     my ($courseidtag,$coursefilter);
   74:     if ($env{'user.adv'} && $domainfilter && exists($env{'user.role.dc./'.
   75:                         $domainfilter.'/'})) {
   76:         $coursefilter=$env{'form.coursefilter'};
   77:         unless ($coursefilter) { $coursefilter=''; }
   78:         my $listcourseid=&HTML::Entities::encode($coursefilter,'<>&"');
   79:         $courseidtag = &mt('LON-CAPA course ID');
   80:         $courseidtag .= qq|: <input type="text" name="coursefilter" size="25" value="$listcourseid" />
   81:         <br />
   82:         |;
   83:     }
   84: # last course activity filter and selection
   85:     my $sincefilter=$env{'form.sincefilter'};
   86:     $sincefilter=~s/[^\d-]//g;
   87:     unless ($sincefilter) { $sincefilter=-1; }
   88:     my $sincefilterform=&Apache::loncommon::select_form($sincefilter,
   89:        'sincefilter',('-1'=>'',
   90:                       '86400' => 'today',
   91:                       '604800' => 'last week',
   92:                       '2592000' => 'last month',
   93:                       '7776000' => 'last three months',
   94:                       '15552000' => 'last six months',
   95:                       '31104000' => 'last year',
   96:                       'select_form_order' =>
   97:                       ['-1','86400','604800','2592000','7776000',
   98: 		      '15552000','31104000']));
   99: # if called from loncreateuser, report sections, then close
  100:     my (%loaditem,$seclist,$groupslist);
  101:     my $num_sections = 0;
  102:     if ($env{'form.form'} eq 'cu' && $env{'form.pickedcourse'}) {
  103:         $loaditem{'onload'} ="setSections()";
  104:         my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
  105: 
  106:         my %sections_count = &Apache::loncommon::get_sections($cdom,$cnum);
  107:         my @sections =  (sort {$a <=> $b} keys(%sections_count));
  108: 	$seclist = join('","',@sections);
  109: 
  110:         my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
  111: 	$groupslist = join(',',sort(keys(%curr_groups)));
  112:     }
  113:     my $jscript;
  114:     my $title = 'Selecting a course';
  115: # Setup for multiple course selections, if flag for multiples set.
  116:     my $multiple = $env{'form.multiple'};
  117:     my $multelement;
  118:     if ($multiple) {
  119:         $title = 'Selecting course(s)';
  120:         $jscript = &Apache::loncommon::check_uncheck_jscript();
  121:         $multelement = '<input type="hidden" name="multiple" value="'.$multiple.'" />';
  122:     }
  123:     $r->print(&Apache::loncommon::start_page($title,undef,
  124: 					     {'add_entries' => \%loaditem,
  125: 					      'no_nav_bar'  => 1, }));
  126:     my %lt=&Apache::lonlocal::texthash(
  127: 				       'cac' => 'Course Activity',
  128: 				       'cde' => 'Course Description',
  129: 				       'cdo' => 'Course Domain',
  130:                                        'cin' => 'Course Institutional Code',
  131:                                        'cow' => "Course Owner's Username");
  132:     my ($name_code,$name_input);
  133:     if (defined($env{'form.cnameelement'}) && $env{'form.cnameelement'} ne '') {
  134: 	$name_code = "opener.document.$env{'form.form'}.$env{'form.cnameelement'}.value=cdesc;";
  135: 	$name_input ='<input type="hidden" name="cnameelement" value="'.
  136: 	    $env{'form.cnameelement'}.'" />';
  137:     }
  138:     my $submitopener = '';
  139:     my $autosubmit = '';
  140:     my $roleelement = '';
  141:     my $lastaction = 'self.close()';
  142:     if ($env{'form.form'} eq 'cu') {
  143:         $lastaction = 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
  144:                       'document.courselist.submit();';
  145:     }
  146:     my $roledom = $env{'form.roleelement'};
  147:     if ($roledom) {
  148:         $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
  149:         $submitopener = &Apache::lonroles::processpick();
  150:         $autosubmit = 'process_pick("'.$roledom.'")';
  151:     }
  152:     $r->print(<<ENDSCRIPT);
  153: <script>
  154: function gochoose(cname,cdom,cdesc,multiple,caller) {
  155:     var openerForm = "$env{'form.form'}";
  156:     courseCount = 0;
  157:     var courses = '';
  158:     if (multiple) {
  159: 	if (typeof(document.courselist.course_id.length) == 'undefined') {
  160: 	    // only 1 course checkbox was created
  161: 	    if (document.courselist.course_id.checked) {
  162: 		courses = courses + document.courselist.course_id.value + "&&";
  163: 		courseCount ++;
  164: 	    }
  165: 	} else {
  166: 	    for (var j=0; j<document.courselist.course_id.length; j++) {
  167: 		if (document.courselist.course_id[j].checked) {
  168: 		    courses = courses + document.courselist.course_id[j].value + "&&";
  169: 		    courseCount ++;
  170: 		}
  171: 	    }
  172: 	} 
  173:         opener.document.$env{'form.form'}.coursetotal.value = courseCount;
  174: 	if (typeof(opener.document.$env{'form.form'}.coursepick.length) ==
  175: 	    'undefined') {
  176: 	    if (opener.document.$env{'form.form'}.coursepick.value == 'specific') {  
  177: 		opener.document.$env{'form.form'}.coursepick.checked = true;
  178: 	    } else {
  179: 		opener.document.$env{'form.form'}.coursepick.checked = false;
  180: 	    }
  181: 	} else {
  182: 	    for (var j=0; j<opener.document.$env{'form.form'}.coursepick.length; j++) { 
  183: 		if (opener.document.$env{'form.form'}.coursepick[j].value == 'specific') {  
  184: 		    opener.document.$env{'form.form'}.coursepick[j].checked = true;
  185: 		} else {
  186: 		    opener.document.$env{'form.form'}.coursepick[j].checked = false;
  187: 		}
  188: 	    }
  189: 	}
  190: 	if (courseCount > 0) {
  191: 	    courses = courses.substr(0,courses.length-2);
  192: 	    opener.document.$env{'form.form'}.courselist.value = courses;
  193: 	}
  194:     } else {
  195:         $name_code
  196:         opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
  197:         var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
  198:         if (slct.options == undefined) {
  199:             opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
  200:         }
  201:         else {
  202:             var i;
  203:             for (i=0;i<slct.length;i++) {
  204:                 if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
  205:             }
  206:         }
  207:     }
  208:     $autosubmit
  209:     $lastaction
  210: }
  211: 
  212: function setSections() {
  213:     var numSections = $num_sections
  214:     var sectionsArray = new Array("$seclist")
  215:     opener.document.$env{"form.form"}.currsec.length = 0
  216:     if (numSections == 0) {
  217:         opener.document.$env{"form.form"}.currsec.multiple=false
  218:         opener.document.$env{"form.form"}.currsec.size=1;
  219:         opener.document.$env{"form.form"}.currsec.options[0] = new Option('No existing sections','',false,false)
  220:     } else {
  221:         if (numSections == 1) {
  222:             opener.document.$env{"form.form"}.currsec.multiple=false;
  223:             opener.document.$env{"form.form"}.currsec.size=1;
  224:             opener.document.$env{"form.form"}.currsec.options[0] = new Option('Select','',true,true);
  225:             opener.document.$env{"form.form"}.currsec.options[1] = new Option('No section','',false,false) 
  226:             opener.document.$env{"form.form"}.currsec.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
  227:         } else {
  228:             for (var i=0; i<numSections; i++) {
  229:                 opener.document.$env{"form.form"}.currsec.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
  230:             }
  231:             opener.document.$env{"form.form"}.currsec.multiple=true
  232:             if (numSections < 3) {
  233:                 opener.document.$env{"form.form"}.currsec.size=numSections;
  234:             } else {
  235:                 opener.document.$env{"form.form"}.currsec.size=3;
  236:             }
  237:             opener.document.$env{"form.form"}.currsec.options[0].selected = false
  238:         }
  239:     }
  240:     opener.document.$env{"form.form"}.groups.value='$groupslist';
  241:     self.close()
  242: }
  243: 
  244: $jscript
  245: </script>
  246: $submitopener
  247: <form method="post" name="filterpicker">
  248: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
  249: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
  250: $name_input
  251: <input type="hidden" name="form" value="$env{'form.form'}" />
  252: $roleelement
  253: $multelement
  254: $lt{'cac'}: $sincefilterform
  255: <br />
  256: $lt{'cdo'}: $domainselectform
  257: <br />
  258: $lt{'cin'}:
  259: <input type="text" name="instcodefilter" size="10" value="$listinstcode" />
  260: <br />
  261: $lt{'cow'}:
  262: <input type="text" name="ownerfilter" size="10" value="$listowner" />
  263: <br />
  264: $courseidtag
  265: $lt{'cde'}:
  266: <input type="text" name="descriptfilter" size="40" value="$listdescript" />
  267: <p><input type="submit" name="gosearch" value="Search" /></p>
  268: </form>
  269: <hr />
  270: ENDSCRIPT
  271: # ---------------------------------------------------------------- Get the data
  272:     if ($env{'form.gosearch'}) {
  273:         $r->print(&mt('Searching').' ...<br />&nbsp;<br />');
  274:         $r->rflush();
  275: 	unless ($descriptfilter) { $descriptfilter='.'; }
  276:         unless ($instcodefilter) { $instcodefilter='.'; }
  277:         unless ($ownerfilter) { $ownerfilter='.'; }
  278:         unless ($coursefilter) { $coursefilter='.'; }
  279:         my $timefilter=($sincefilter==-1?1:time-$sincefilter);
  280: 	my %courses=
  281: 	    &Apache::lonnet::courseiddump
  282: 	    ($domainfilter,$descriptfilter,$timefilter,$instcodefilter,$ownerfilter,$coursefilter);
  283: 	$r->print('<form name="courselist">');
  284: 	my %by_descrip;
  285:         my $numcourses = keys(%courses);
  286: 	foreach my $course (keys(%courses)) {
  287:             my $descr;
  288:             if ($courses{$course} =~ m/^([^:]*):/i) {
  289:                 $descr = &Apache::lonnet::unescape($1);
  290:             } else {
  291:                 $descr = &Apache::lonnet::unescape($courses{$course});
  292:             }
  293:             my $description = $descr;
  294:             push (@{$by_descrip{$description}}, $course);
  295: 	}
  296:         if ($numcourses > 1 && $multiple) {
  297:             $r->print('<input type="button" value="check all"
  298:                     onclick="javascript:checkAll(document.courselist.course_id)" />                    &nbsp;&nbsp;<input type="button" value="uncheck all"
  299:                     onclick="javascript:uncheckAll(document.courselist.course_id)" />
  300:                     <br /><br />');
  301:         }
  302: 	foreach my $description (sort 
  303: 				 { lc($a) cmp lc($b) } (keys(%by_descrip))) {
  304:             foreach my $course (@{$by_descrip{$description}}) {
  305: 	        my $cleandesc=&HTML::Entities::encode($description,'<>&"');
  306: 	        $cleandesc=~s/'/\\'/g;
  307: 	        my ($cdom,$cnum)=split(/\_/,$course);
  308:                 my ($descr,$instcode,$owner) = split/:/,$courses{$course};
  309:                 $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
  310: 	        $r->print($description.'('.
  311: 		      ($Apache::lonnet::domaindescription{$cdom}?
  312:                        $Apache::lonnet::domaindescription{$cdom}:$cdom).")");
  313:                 unless ($instcode eq '') {
  314:                     $r->print(" - ".&Apache::lonnet::unescape($instcode));
  315:                 }
  316:                 unless ($owner eq '') {
  317:                     $r->print(", owner - ".&Apache::lonnet::unescape($owner));
  318:                 }
  319: 		if ($multiple) { $r->print("</label>\n"); }
  320:                 $r->print("<br />\n");
  321:             }
  322: 	}
  323: 	if (!%courses) { 
  324:             $r->print(&mt('None found'));
  325:         } elsif ($multiple) {
  326:             $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','',1)".'" />');
  327:         }
  328:         $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'."\n".
  329:                    '<input type="hidden" name="pickedcourse" value="" />'."\n".
  330:                    '<input type="hidden" name="cnumelement" value="'.$env{'form.cnumelement'}.'" />'."\n".
  331:                    '<input type="hidden" name="cdomelement" value="'.$env{'form.cdomelement'}.'" />'."\n");
  332:         if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
  333:            $r->print('<input type="hidden" name="roleelement" value="'.$env{'form.roleelement'}.'" />'."\n");
  334:         }
  335:         $r->print("</form>\n");
  336:     }
  337:     $r->print(&Apache::loncommon::end_page());
  338:     return OK;
  339: }
  340: 
  341: sub course_chooser {
  342:     my ($multiple,$cdom,$cnum,$cleandesc) = @_;
  343:     my $output; 
  344:     if ($multiple) {
  345:         $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
  346:     } else {
  347:         $output = '<input type="button" value="Select" onClick="gochoose('.
  348:                   "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
  349:     }
  350:     return $output;
  351: } 
  352: 
  353: 1;
  354: __END__