--- loncom/interface/lonpickcourse.pm	2006/11/03 18:42:11	1.53
+++ loncom/interface/lonpickcourse.pm	2007/10/06 04:32:49	1.65
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Pick a course
 #
-# $Id: lonpickcourse.pm,v 1.53 2006/11/03 18:42:11 raeburn Exp $
+# $Id: lonpickcourse.pm,v 1.65 2007/10/06 04:32:49 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -35,7 +35,6 @@ use Apache::loncoursedata;
 use Apache::lonnet;
 use Apache::lonlocal;
 use Apache::longroup;
-use lib '/home/httpd/lib/perl/';
 use LONCAPA;
 
 sub handler {
@@ -46,454 +45,409 @@ sub handler {
 
 # ------------------------------------------------------------ Print the screen
 
-# Get parameters from query string
+    # Get parameters from query string
     &Apache::loncommon::get_unprocessed_cgi
-        ($ENV{'QUERY_STRING'},['domainfilter','descriptfilter',
-			       'sincefilter','form','cnumelement',
+        ($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement',
 			       'cdomelement','cnameelement','roleelement',
-                               'pickedcourse','instcodefilter',
-                               'ownerfilter','coursefilter','multiple',
-                               'type','ownerdomfilter']);
-# domain filter and selection
-    my $domainfilter=$env{'form.domainfilter'};
-    $domainfilter=~s/\W//g;
-    unless ($domainfilter) { $domainfilter=''; }
-    my $domainselectform=&Apache::loncommon::select_dom_form($domainfilter,
-                                                          'domainfilter',1);
-# description filter
-    my $descriptfilter=$env{'form.descriptfilter'};
-    unless ($descriptfilter) { $descriptfilter=''; }
-    my $listdescript=&HTML::Entities::encode($descriptfilter,'<>&"');
-# institutional code filter
-    my $instcodefilter=$env{'form.instcodefilter'};
-    unless ($instcodefilter) { $instcodefilter=''; }
-    my $listinstcode=&HTML::Entities::encode($instcodefilter,'<>&"');
-# course owner filter
-    my $ownerfilter=$env{'form.ownerfilter'};
-    $ownerfilter=~s/\W//g;
-    my $listowner=&HTML::Entities::encode($ownerfilter,'<>&"');
-# course ownerdomain filter
-    my $ownerdomfilter=$env{'form.ownerdomfilter'};
-    $ownerdomfilter=~s/\W//g;
-    my $ownerdomselectform=
-       &Apache::loncommon::select_dom_form($ownerdomfilter,'ownerdomfilter',1);
-# course ID filter for DCs only
-    my ($courseidtag,$coursefilter);
-    if ($env{'user.adv'} && $domainfilter && exists($env{'user.role.dc./'.
-                        $domainfilter.'/'})) {
-        $coursefilter=$env{'form.coursefilter'};
-        unless ($coursefilter) { $coursefilter=''; }
-        my $listcourseid=&HTML::Entities::encode($coursefilter,'<>&"');
-        $courseidtag = &mt('LON-CAPA course ID');
-        $courseidtag .= qq|: <input type="text" name="coursefilter" size="25" value="$listcourseid" />
-        <br />
-        |;
-    }
-# last course activity filter and selection
-    my $sincefilter=$env{'form.sincefilter'};
-    $sincefilter=~s/[^\d-]//g;
-    unless ($sincefilter) { $sincefilter=-1; }
-    my $sincefilterform=&Apache::loncommon::select_form($sincefilter,
-       'sincefilter',('-1'=>'',
-                      '86400' => 'today',
-                      '604800' => 'last week',
-                      '2592000' => 'last month',
-                      '7776000' => 'last three months',
-                      '15552000' => 'last six months',
-                      '31104000' => 'last year',
-                      'select_form_order' =>
-                      ['-1','86400','604800','2592000','7776000',
-		      '15552000','31104000']));
-# if called from loncreateuser, report sections, then close
-    my (%loaditem,$seclist,$groupslist,$roleslist,$rolesnameslist,
-	$accesslist,$accessnameslist);
-    my $sec_element = 'currsec';
-    my $grplist_element = 'groups';
-    my $num_sections = 0;
-    my $num_groups = 0;
-    my $num_roles = 0;
-    my $num_access = 0;
-    my ($cdom,$cnum);
-    if ($env{'form.pickedcourse'}) {
-        ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
-    }
-    my $type = $env{'form.type'};
+                               'multiple','type','setroles']);
+
+    my ($type,$title,$jscript,$multelement,$multiple,$roleelement,
+        $lastaction,$autosubmit,$submitopener);
+
+    # Get course type - Course or Non-standard Course.
+    $type = $env{'form.type'};
     if (!defined($env{'form.type'})) {
         $type = 'Course';
     }
+    $title = &mt('Selecting a [_1]',$type);
+
+    # Setup for multiple course selections, if flag for multiples set.
+    $multiple = $env{'form.multiple'};
+    if ($multiple) {
+        ($jscript,$multelement) = &multiples_tag();
+        $title = &mt('Selecting [_1](s)',lc($type));
+    }
+
+    # if called when a DC is selecting a course 
+    my $roledom = $env{'form.roleelement'};
+    if ($roledom) {
+        $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
+        $submitopener = &Apache::lonroles::processpick();
+        $autosubmit = 'process_pick("'.$roledom.'")';
+    }
+
+    my $onlyown = 0;
+    # if called to assign course-based portfolio access control
+    if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
+        $onlyown = 1;
+    }
+
+    my %loaditem;
     if ($env{'form.form'} eq 'cu' && $env{'form.pickedcourse'}) {
         $loaditem{'onload'} ="setSections()";
-        ($seclist,$num_sections,$groupslist,$num_groups) = 
-             &build_selection_lists($cdom,$cnum,$type,undef,undef,
-                                    $env{'form.form'});
-    }
-# if called from portfolio, report roles, sections, groups and close
-    my ($roles_element,$groups_element,$status_element,$setitems_function);
-    if ($env{'form.form'} eq 'portform' && $env{'form.pickedcourse'}) {
-        my ($row_id) = ($env{'form.cnumelement'} =~ /^crsnum_(\d+)$/);
-        $roles_element = 'role_'.$row_id.'_1';
-        $groups_element = 'group_'.$row_id.'_1';
-        $sec_element = 'section_'.$row_id.'_1';
-        $status_element = 'access_'.$row_id.'_1';
-        $grplist_element = 'grplist_'.$row_id.'_1';
-        $loaditem{'onload'} ="setItems()";
-        ($seclist,$num_sections,$groupslist,$num_groups,$roleslist,$num_roles,
-         $rolesnameslist,$accesslist,$num_access,$accessnameslist) =
-               &build_selection_lists($cdom,$cnum,$type,1,1,$env{'form.form'});
-        $setitems_function = qq|
-function setItems() {
-    opener.document.$env{"form.form"}.activate.checked = true;
-    setRoles();
-    setGroups();
-    setStatus();
-    setSections();
-}
+    }
+    $r->print(&Apache::loncommon::start_page($title,undef,
+					     {'add_entries' => \%loaditem,
+					      'no_nav_bar'  => 1, }));
 
-function setRoles() {
-    var numRoles = $num_roles
-    var rolesArray = new Array("$roleslist");
-    var roleNamesArray = new Array("$rolesnameslist");
-    opener.document.$env{"form.form"}.$roles_element.length = 0;
-    if (numRoles == 0) {
-        opener.document.$env{"form.form"}.$roles_element.multiple=false;
-        opener.document.$env{"form.form"}.$roles_element.size=1;
-        opener.document.$env{"form.form"}.$roles_element.options[0] = new Option('No existing roles','',false,false);
+    if ($env{'form.form'} eq 'portform') {
+        $lastaction = 'document.courselist.submit()';
+    } elsif ($env{'form.form'} eq 'cu') {
+        $lastaction = 
+             'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
+             'document.courselist.submit();';
     } else {
-        if (numRoles == 1) {
-            opener.document.$env{"form.form"}.$roles_element.multiple=false;
-            opener.document.$env{"form.form"}.$roles_element.size=1;
-            opener.document.$env{"form.form"}.$roles_element.options[0] = new Option('Select','',true,true);
-            opener.document.$env{"form.form"}.$roles_element.options[1] = new Option(roleNamesArray[0],rolesArray[0],false,false);
-        } else {
-            for (var i=0; i<numRoles; i++) {
-                opener.document.$env{"form.form"}.$roles_element.options[i] = new Option(roleNamesArray[i],rolesArray[i],false,false);
-            }
-            opener.document.$env{"form.form"}.$roles_element.multiple=true;
-            if (numRoles < 3) {
-                opener.document.$env{"form.form"}.$roles_element.size=numRoles;
-            } else {
-                opener.document.$env{"form.form"}.$roles_element.size=3;
-            }
-            opener.document.$env{"form.form"}.$roles_element.options[0].selected = false;
+        $lastaction = 'self.close()';
+    }
+
+    # if called to assign a role in a course to a user via CUSR
+    if ($env{'form.form'} eq 'cu') {
+        $r->print(&create_user_javascript($type)); 
+    }
+
+    # print javascript functions for choosing a course 
+    if ($env{'form.gosearch'} || $onlyown) {
+        $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
+    }
+    $r->print('<script type="text/javascript">'.$jscript.'</script>');
+    $r->print($submitopener);
+
+# ------------------------------------------ Display of filters to limit search
+    my $filter = {};
+    my $action = '/adm/pickcourse';
+    if (!$onlyown) {
+        my $filterlist = ['domainfilter','descriptfilter',
+                          'instcodefilter','ownerfilter',
+                          'ownerdomfilter'];
+        # course ID filter for DCs only
+        if ($env{'user.adv'} && $env{'form.domainfilter'} &&
+            exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
+            push(@{$filterlist},'coursefilter');
         }
+        $r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
+                                 $filter,$action));
     }
+
+# ---------------------------------------------------------------- Get the data
+    if ($env{'form.gosearch'} || $onlyown) {
+        my %courses = &search_courses($r,$type,$onlyown,$filter);
+        &display_matched_courses($r,$type,$multiple,$action,%courses);
+    }
+    $r->print(&Apache::loncommon::end_page());
+    return OK;
 }
 
-function setStatus() {
-    var numStatus = $num_access;
-    var statusArray = new Array("$accesslist");
-    var statusNamesArray = new Array("$accessnameslist");
-    opener.document.$env{"form.form"}.$status_element.multiple=true;
-    opener.document.$env{"form.form"}.$status_element.size=3;
-    for (var i=0; i<numStatus; i++) {
-        opener.document.$env{"form.form"}.$status_element.options[i] = new Option(statusNamesArray[i],statusArray[i],false,false);
+sub create_user_javascript {
+    my ($type) = @_;
+    my $output;
+    #javascript for reporting sections and groups then closing
+    if ($env{'form.pickedcourse'}) {
+        my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
+        my $sec_element = 'currsec';
+        my $grplist_element = 'groups';
+        my ($sections,$groups) =
+          &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
+        my $num_sections = scalar(@{$sections});
+        my $seclist = join(',',@{$sections});
+        my $num_groups = scalar(@{$groups});
+        my $groupslist = join(',',@{$groups});
+        $output = qq|
+<script type="text/javascript">
+function setSections() {
+    opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
+    window.opener.setSect('$seclist');
+    self.close()
+}
+</script>
+|;
+;
     }
+    return $output;
 }
 
-function setGroups() {
-    var numGroups = $num_groups;
-    var groupsArray = new Array("$groupslist");
-    opener.document.$env{"form.form"}.$groups_element.length = 0;
-    if (numGroups == 0) {
-        opener.document.$env{"form.form"}.$groups_element.multiple=false;
-        opener.document.$env{"form.form"}.$groups_element.size=1;
-        opener.document.$env{"form.form"}.$groups_element.options[0] = new Option('No existing groups','',false,false);
-    } else {
-        if (numGroups == 1) {
-            opener.document.$env{"form.form"}.$groups_element.multiple=false;
-            opener.document.$env{"form.form"}.$groups_element.size=1;
-            opener.document.$env{"form.form"}.$groups_element.options[0] = new Option('Select','',true,true);
-            opener.document.$env{"form.form"}.$groups_element.options[1] = new Option('No group','',false,false);
-            opener.document.$env{"form.form"}.$groups_element.options[2] = new Option(groupsArray[0],groupsArray[0],false,false);
+sub display_matched_courses {
+    my ($r,$type,$multiple,$action,%courses) = @_;
+    if ($env{'form.form'} eq 'portform') {
+        $action = '/adm/portfolio';
+    }
+    $r->print('<form name="courselist" method="post" action="'.$action.'">');
+    my %by_descrip;
+    my $numcourses = keys(%courses);
+    foreach my $course (keys(%courses)) {
+        my $descr;
+        if (ref($courses{$course}) eq 'HASH') {
+            $descr = $courses{$course}{'description'};
+        } elsif ($courses{$course} =~ m/^([^:]*):/i) {
+            $descr = &unescape($1);
         } else {
-            for (var i=0; i<numGroups; i++) {
-                opener.document.$env{"form.form"}.$groups_element.options[i] = new Option(groupsArray[i],groupsArray[i],false,false);
-            }
-            opener.document.$env{"form.form"}.$groups_element.multiple=true;
-            if (numGroups < 3) {
-                opener.document.$env{"form.form"}.$groups_element.size=numGroups;
+            $descr = &unescape($courses{$course});
+        }
+        my $description = $descr;
+        push (@{$by_descrip{$description}}, $course);
+    }
+    if ($numcourses > 1 && $multiple) {
+        $r->print('<input type="button" value="check all"
+                  onclick="javascript:checkAll(document.courselist.course_id)" />
+                  &nbsp;&nbsp;<input type="button" value="uncheck all"
+                  onclick="javascript:uncheckAll(document.courselist.course_id)" />
+                  <br /><br />');
+    }
+    foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
+        foreach my $course (@{$by_descrip{$description}}) {
+            my $cleandesc=&HTML::Entities::encode($description,'<>&"');
+            $cleandesc=~s/'/\\'/g;
+            my ($cdom,$cnum)=split(/\_/,$course);
+            my ($descr,$instcode,$ttype,@owners);
+            if (ref($courses{$course}) eq 'HASH') {
+                $descr = $courses{$course}{'description'};
+                $instcode =  $courses{$course}{'inst_code'};
+                $ttype =  $courses{$course}{'type'};
+                push(@owners,&unescape($courses{$course}{'owner'}));
+                if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') {
+                    foreach my $item (@{$courses{$course}{'co-owners'}}) {
+                        push(@owners,&unescape($item));
+                    }
+                }
             } else {
-                opener.document.$env{"form.form"}.$groups_element.size=3;
+                my $singleowner; 
+                ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
+                push(@owners,&unescape($singleowner));
+            }
+            my $owner = join(', ',@owners);
+            $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
+            $r->print($description.'('.
+                      (&Apache::lonnet::domain($cdom,'description')?
+                       &Apache::lonnet::domain($cdom,'description'):$cdom).")");
+            if ($instcode ne '') {
+                $r->print(" - ".&unescape($instcode));
+            }
+            if (@owners > 1) {
+                $r->print(', '.&mt('owners').' - ',join(', ',@owners)); 
+            } elsif (@owners == 1) {
+                $r->print(', '.&mt('owner').' - '.$owner);
             }
-            opener.document.$env{"form.form"}.$groups_element.options[0].selected = false;
+            if ($ttype ne '') {
+                $r->print('('.&unescape($ttype).')');
+            }
+            if ($multiple) { $r->print("</label>\n"); }
+            $r->print("<br />\n");
         }
     }
+    if (!%courses) {
+        $r->print(&mt('None found'));
+    } elsif ($multiple) {
+        $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
+    }
+    $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
+              "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
+              '<input type="hidden" name="type" value="'.$type.'" />'."\n");
+    if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
+        $r->print('<input type="hidden" name="roleelement" value="'.
+                  $env{'form.roleelement'}.'" />'."\n");
+    }
+    if ($env{'form.form'} eq 'portform') {
+        $r->print('<input type="hidden" name="cnum" value="" />');
+        $r->print('<input type="hidden" name="cdom" value="" />');
+        $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
+        $r->print('<input type="hidden" name="action" value="rolepicker" />');
+    } elsif ($env{'form.form'} eq 'modifycourse') {
+        $r->print('<input type="hidden" name="phase" value="menu" />'."\n");
+        $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form']));
+    } else {
+        $r->print('<input type="hidden" name="cnumelement" value="'.
+                  $env{'form.cnumelement'}.'" />'."\n".  
+                  '<input type="hidden" name="cdomelement" value="'.
+                  $env{'form.cdomelement'}.'" />'."\n");
+    }
+    $r->print("</form>\n");
+    return;
 }
 
-|;
-    }
-    my $jscript;
-    my $typeselectform =  '<select name="type" size="1"';
-    $typeselectform .= ">\n";
-    foreach my $posstype ('Course','Non-standard course') { 
-        $typeselectform.='<option value="'.$posstype.'" "'.
-            ($posstype eq $type ? 'selected="selected" ' : ''). ">$posstype</option>\n";
+
+sub multiples_tag {
+    my $jscript = &Apache::loncommon::check_uncheck_jscript();
+    my $multelement = '<input type="hidden" name="multiple" value="1" />';
+    return ($jscript,$multelement);
+}
+
+sub build_filters {
+    my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
+        $caller) = @_;
+    my $list;
+    my $formname;
+    if (defined($env{'form.form'})) {
+         $formname = $env{'form.form'};
+    } else {
+         $formname = $caller;
     }
-    $typeselectform.="</select>";
-    my $title = &mt('Selecting a [_1]',$type);
-# Setup for multiple course selections, if flag for multiples set.
-    my $multiple = $env{'form.multiple'};
-    my $multelement;
-    if ($multiple) {
-        $title = &mt('Selecting [_1](s)',lc($type));
-        $jscript = &Apache::loncommon::check_uncheck_jscript();
-        $multelement = '<input type="hidden" name="multiple" value="'.$multiple.'" />';
+    my ($domainselectform,$sincefilterform,$ownerdomselectform,
+        $instcodeform,$typeselectform);
+    foreach my $item (@{$filterlist}) {
+        $filter->{$item} = $env{'form.'.$item};
+        if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
+	    if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
+		$filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
+	    } elsif ($item eq 'coursefilter') {
+		$filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
+	    } elsif ($item eq 'ownerfilter') {
+		$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
+	    } else {
+		$filter->{$item} =~ s/\W//g;
+	    }
+            if (!$filter->{$item}) {
+                $filter->{$item} = '';
+            }
+        }
+        if ($item eq 'domainfilter') {
+	    my $allow_blank = 1;
+	    if ($formname eq 'portform') {
+		$filter->{$item} ||= $env{'user.domain'};
+		$allow_blank=0;
+	    }
+            $domainselectform =
+		&Apache::loncommon::select_dom_form($filter->{$item},
+						    'domainfilter',
+						    $allow_blank);
+        } elsif ($item eq 'ownerdomfilter') {
+            $ownerdomselectform =
+     &Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
+        } else {
+            $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
+        }
     }
-    $r->print(&Apache::loncommon::start_page($title,undef,
-					     {'add_entries' => \%loaditem,
-					      'no_nav_bar'  => 1, }));
+
+    # last course activity filter and selection
+    $filter->{'sincefilter'} = $env{'form.sincefilter'};
+    $filter->{'sincefilter'} =~ s/[^\d-]//g;
+    if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
+    $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
+       'sincefilter',('-1'=>'',
+                      '86400' => 'today',
+                      '604800' => 'last week',
+                      '2592000' => 'last month',
+                      '7776000' => 'last three months',
+                      '15552000' => 'last six months',
+                      '31104000' => 'last year',
+                      'select_form_order' =>
+                      ['-1','86400','604800','2592000','7776000',
+                      '15552000','31104000']));
+
     my %lt = (
-	      'cac' => &mt('[_1] Activity',$type),
-	      'cde' => &mt('[_1] Description',$type),
-	      'cdo' => &mt('[_1] Domain',$type),
+              'cac' => &mt('[_1] Activity',$type),
+              'cde' => &mt('[_1] Description',$type),
+              'cdo' => &mt('[_1] Domain',$type),
               'cin' => &mt('Course Institutional Code'),
               'cow' => &mt("[_1] Owner's Username",$type),
               'cod' => &mt("[_1] Owner's Domain", $type),
               'cog' => &mt('Course Type')
              );
-   
-    my ($name_code,$name_input);
-    if (defined($env{'form.cnameelement'}) && $env{'form.cnameelement'} ne '') {
-	$name_code = "opener.document.$env{'form.form'}.$env{'form.cnameelement'}.value=cdesc;";
-	$name_input ='<input type="hidden" name="cnameelement" value="'.
-	    $env{'form.cnameelement'}.'" />';
-    }
-    my $submitopener = '';
-    my $autosubmit = '';
-    my $roleelement = '';
-    my $lastaction = 'self.close()';
-    if ($env{'form.form'} eq 'cu') {
-        $lastaction = 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
-                      'document.courselist.submit();';
-    }
-    if ($env{'form.form'} eq 'portform') {
-        $lastaction = 'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
-                      'document.courselist.submit();';
-    }
-    my $roledom = $env{'form.roleelement'};
-    if ($roledom) {
-        $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
-        $submitopener = &Apache::lonroles::processpick();
-        $autosubmit = 'process_pick("'.$roledom.'")';
-    }
-    my $instcodeform;
+
+    $typeselectform =  '<select name="type" size="1">'."\n";
     if ($type eq 'Course') {
-        $instcodeform = $lt{'cin'}.': <input type="text" name="instcodefilter" 
- size="10" value="'.$listinstcode.'" /><br />';
+        $instcodeform = 
+                '<input type="text" name="instcodefilter" size="10" value="'.
+                $list->{'instcodefilter'}.'" />';
     }
-    my %elements = (
-                     'Course' => {
-                                 name  => 'coursepick',
-                                 total => 'coursetotal',
-                                 list  => 'courselist',
-                               },
-                     'Non-standard course' => {
-                                 name  => 'grouppick',
-                                 total => 'grouptotal',
-                                 list  => 'grouplist',
-                             },
-                    );
-
-    $r->print(<<ENDSCRIPT);
-<script>
-function gochoose(cname,cdom,cdesc,multiple,caller) {
-    var openerForm = "$env{'form.form'}";
-    courseCount = 0;
-    var courses = '';
-    if (multiple) {
-	if (typeof(document.courselist.course_id.length) == 'undefined') {
-	    // only 1 course checkbox was created
-	    if (document.courselist.course_id.checked) {
-		courses = courses + document.courselist.course_id.value + "&&";
-		courseCount ++;
-	    }
-	} else {
-	    for (var j=0; j<document.courselist.course_id.length; j++) {
-		if (document.courselist.course_id[j].checked) {
-		    courses = courses + document.courselist.course_id[j].value + "&&";
-		    courseCount ++;
-		}
-	    }
-	} 
-        opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
-	if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
-	    'undefined') {
-	    if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {  
-		opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
-	    } else {
-		opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
-	    }
-	} else {
-	    for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) { 
-		if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {  
-		    opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
-		} else {
-		    opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
-		}
-	    }
-	}
-	if (courseCount > 0) {
-	    courses = courses.substr(0,courses.length-2);
-	    opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
-	}
-    } else {
-        $name_code
-        opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
-        var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
-        if (slct.options == undefined) {
-            opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
-        }
-        else {
-            var i;
-            for (i=0;i<slct.length;i++) {
-                if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
-            }
-        }
+    foreach my $posstype ('Course','Non-standard Course') {
+        $typeselectform.='<option value="'.$posstype.'" "'.
+            ($posstype eq $type ? 'selected="selected" ' : ''). ">$posstype</option>\n";
     }
-    $autosubmit
-    $lastaction
-}
-
-function setSections() {
-    var numSections = $num_sections
-    var sectionsArray = new Array("$seclist")
-    opener.document.$env{"form.form"}.$sec_element.length = 0
-    if (numSections == 0) {
-        opener.document.$env{"form.form"}.$sec_element.multiple=false
-        opener.document.$env{"form.form"}.$sec_element.size=1;
-        opener.document.$env{"form.form"}.$sec_element.options[0] = new Option('No existing sections','',false,false)
-    } else {
-        if (numSections == 1) {
-            opener.document.$env{"form.form"}.$sec_element.multiple=false;
-            opener.document.$env{"form.form"}.$sec_element.size=1;
-            opener.document.$env{"form.form"}.$sec_element.options[0] = new Option('Select','',true,true);
-            opener.document.$env{"form.form"}.$sec_element.options[1] = new Option('No section','',false,false) 
-            opener.document.$env{"form.form"}.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
-        } else {
-            for (var i=0; i<numSections; i++) {
-                opener.document.$env{"form.form"}.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
-            }
-            opener.document.$env{"form.form"}.$sec_element.multiple=true
-            if (numSections < 3) {
-                opener.document.$env{"form.form"}.$sec_element.size=numSections;
-            } else {
-                opener.document.$env{"form.form"}.$sec_element.size=3;
-            }
-            opener.document.$env{"form.form"}.$sec_element.options[0].selected = false
+    $typeselectform.="</select>";
+    my $output = qq|
+<form method="post" name="filterpicker" action="$action">
+<input type="hidden" name="form" value="$formname" />
+|;
+    if ($formname eq 'modifycourse') {
+        $output .= '<input type="hidden" name="phase" value="courselist" />';
+    } else {     
+        my $name_input;
+        if ($env{'form.cnameelement'} ne '') {
+            $name_input = '<input type="hidden" name="cnameelement" value="'.
+                          $env{'form.cnameelement'}.'" />';
         }
-    }
-    opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
-    self.close()
-}
-
-$setitems_function
-
-$jscript
-</script>
-$submitopener
-<form method="post" name="filterpicker" action="/adm/pickcourse">
+        $output .= qq|
 <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
 <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
 $name_input
-<input type="hidden" name="form" value="$env{'form.form'}" />
 $roleelement
 $multelement
-$lt{'cac'}: $sincefilterform
-<br />
-$lt{'cdo'}: $domainselectform
-<br />
-$lt{'cog'}: $typeselectform
-<br />
-$instcodeform
-$lt{'cow'}:
-<input type="text" name="ownerfilter" size="10" value="$listowner" />
-<br />
-$lt{'cod'}: $ownerdomselectform
-<br />
-$courseidtag
-$lt{'cde'}:
-<input type="text" name="descriptfilter" size="40" value="$listdescript" />
+|;
+        if ($formname eq 'portform') {
+            $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
+        }
+    }
+    if ($sincefilterform) { 
+        $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
+    }
+    if ($domainselectform) {
+        $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
+    }
+    if ($typeselectform) {
+        $output .= $lt{'cog'}.': '.$typeselectform.'<br />'."\n";
+    }
+    if ($instcodeform) {
+        $output .= $lt{'cin'}.': '.$instcodeform.'<br />'."\n";
+    }
+    if (exists($filter->{'ownerfilter'})) {
+        $output .= $lt{'cow'}.': '.
+                   '<input type="text" name="ownerfilter" size="10" value="'.
+                   $list->{'ownerfilter'}.'" /><br />'."\n".
+                   $lt{'cod'}.': '.$ownerdomselectform.'<br />'."\n";
+    }
+    if (exists($filter->{'coursefilter'})) {
+        $output .= &mt('LON-CAPA course ID').': '.
+                   '<input type="text" name="coursefilter" size="25" value="'.
+                    $list->{'coursefilter'}.'" /><br />';
+    }
+    if (exists($filter->{'descriptfilter'})) {
+        $output .=$lt{'cde'}.': '.
+                  '<input type="text" name="descriptfilter" size="40" value="'.
+                  $list->{'descriptfilter'}.'" />'."\n";
+    }
+    $output .= qq|
 <p><input type="submit" name="gosearch" value="Search" /></p>
 </form>
 <hr />
-ENDSCRIPT
-# ---------------------------------------------------------------- Get the data
-    if ($env{'form.gosearch'}) {
+|;
+    return $output; 
+}
+
+sub search_courses {
+    my ($r,$type,$onlyown,$filter) = @_;
+    my %courses;
+    if (!$onlyown) {
         $r->print(&mt('Searching').' ...<br />&nbsp;<br />');
         $r->rflush();
-	unless ($descriptfilter) { $descriptfilter='.'; }
-        unless ($instcodefilter) { $instcodefilter='.'; }
-        my $combownerfilter;
-        if (($ownerfilter ne '') || ($ownerdomfilter ne '')) {
-            $combownerfilter = $ownerfilter.':'.$ownerdomfilter;
+        if (($filter->{'ownerfilter'} ne '') ||
+            ($filter->{'ownerdomfilter'} ne '')) {
+            $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
+                                           $filter->{'ownerdomfilter'};
+        }
+        foreach my $item ('descriptfilter','instcodefilter','coursefilter',
+                          'combownerfilter') {
+            if (!$filter->{$item}) {
+                $filter->{$item}='.';
+            }
         }
-        if ($combownerfilter eq '') { $combownerfilter='.'; }
-        if ($coursefilter eq '') { $coursefilter='.'; }
         if ($type eq '') { $type = '.'; }
-        my $timefilter=($sincefilter==-1?1:time-$sincefilter);
-	my %courses = &Apache::lonnet::courseiddump($domainfilter,$descriptfilter,
-                                     $timefilter,$instcodefilter,$combownerfilter,
-                                     $coursefilter,undef,undef,$type);
-	$r->print('<form name="courselist" method="post" action="/adm/pickcourse">');
-	my %by_descrip;
-        my $numcourses = keys(%courses);
-	foreach my $course (keys(%courses)) {
-            my $descr;
-            if ($courses{$course} =~ m/^([^:]*):/i) {
-                $descr = &unescape($1);
-            } else {
-                $descr = &unescape($courses{$course});
-            }
-            my $description = $descr;
-            push (@{$by_descrip{$description}}, $course);
-	}
-        if ($numcourses > 1 && $multiple) {
-            $r->print('<input type="button" value="check all"
-                    onclick="javascript:checkAll(document.courselist.course_id)" />                    &nbsp;&nbsp;<input type="button" value="uncheck all"
-                    onclick="javascript:uncheckAll(document.courselist.course_id)" />
-                    <br /><br />');
-        }
-	foreach my $description (sort 
-				 { lc($a) cmp lc($b) } (keys(%by_descrip))) {
-            foreach my $course (@{$by_descrip{$description}}) {
-	        my $cleandesc=&HTML::Entities::encode($description,'<>&"');
-	        $cleandesc=~s/'/\\'/g;
-	        my ($cdom,$cnum)=split(/\_/,$course);
-                my ($descr,$instcode,$owner,$ttype) = split/:/,$courses{$course};
-                $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
-	        $r->print($description.'('.
-		      ($Apache::lonnet::domaindescription{$cdom}?
-                       $Apache::lonnet::domaindescription{$cdom}:$cdom).")");
-                unless ($instcode eq '') {
-                    $r->print(" - ".&unescape($instcode));
-                }
-                unless ($owner eq '') {
-                    $r->print(", owner - ".&unescape($owner));
-                }
-                unless ($ttype eq '') {
-                    $r->print('('.&Apache::lonnet::unescape($ttype).')');
-                }
-		if ($multiple) { $r->print("</label>\n"); }
-                $r->print("<br />\n");
-            }
-	}
-	if (!%courses) { 
-            $r->print(&mt('None found'));
-        } elsif ($multiple) {
-            $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','',1)".'" />');
-        }
-        $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'."\n".
-                   '<input type="hidden" name="pickedcourse" value="" />'."\n".
-                   '<input type="hidden" name="cnumelement" value="'.$env{'form.cnumelement'}.'" />'."\n".
-                   '<input type="hidden" name="cdomelement" value="'.$env{'form.cdomelement'}.'" />'."\n".
-                   '<input type="hidden" name="type" value="'.$type.'" />'."\n");
-        if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
-           $r->print('<input type="hidden" name="roleelement" value="'.$env{'form.roleelement'}.'" />'."\n");
+        my $timefilter = 
+           ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
+        %courses = 
+            &Apache::lonnet::courseiddump($filter->{'domainfilter'},
+                                          $filter->{'descriptfilter'},
+                                          $timefilter,
+                                          $filter->{'instcodefilter'},
+                                          $filter->{'combownerfilter'},
+                                          $filter->{'coursefilter'},
+                                          undef,undef,$type);
+    } else {
+        $r->print('<br />');
+        my %coursehash = &Apache::loncommon::findallcourses(); 
+        foreach my $cid (sort(keys(%coursehash))) {
+            $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
         }
-        $r->print("</form>\n");
     }
-    $r->print(&Apache::loncommon::end_page());
-    return OK;
+    return %courses;
 }
 
 sub course_chooser {
@@ -508,51 +462,292 @@ sub course_chooser {
     return $output;
 }
 
-sub build_selection_lists {
-    my ($cdom,$cnum,$type,$needroles,$needaccess,$caller) = @_;
-    my ($sections,$groups,$allroles,$roleshash,$accesshash) = 
-          &Apache::loncommon::get_secgrprole_info($cdom,$cnum,$needroles,$type);
-    if ($caller eq 'portform') {
-        if (@{$sections} == 0) {
-            @{$sections} = ('none');
-        } else {
-            unshift(@{$sections},('all','none'));
+sub gochoose_javascript {
+    my ($type,$multiple,$autosubmit,$lastaction) = @_;
+    my %elements = (
+                     'Course' => {
+                                 name  => 'coursepick',
+                                 total => 'coursetotal',
+                                 list  => 'courselist',
+                                 },
+                     'Non-standard Course' => {
+                                 name  => 'grouppick',
+                                 total => 'grouptotal',
+                                 list  => 'grouplist',
+                              },
+                    );
+    my $output .= qq|
+<script type="text/javascript">
+function gochoose(cname,cdom,cdesc) {
+    var openerForm = "$env{'form.form'}";
+    courseCount = 0;
+    var courses = '';
+|;
+    if ($multiple) {
+        $output .= <<"ENDSCRIPT";
+    courseCount = 0;
+    var courses = '';
+    if (typeof(document.courselist.course_id.length) == 'undefined') {
+        // only 1 course checkbox was created
+        if (document.courselist.course_id.checked) {
+            courses = courses + document.courselist.course_id.value + "&&";
+            courseCount ++;
+        }
+    } else {
+        for (var j=0; j<document.courselist.course_id.length; j++) {
+            if (document.courselist.course_id[j].checked) {
+                courses = courses + document.courselist.course_id[j].value + "&&";
+                courseCount ++;
+            }
         }
-        if (@{$groups} == 0) {
-            @{$groups} = ('none');
+    }
+    opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
+    if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
+        'undefined') {
+        if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
+            opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
         } else {
-            unshift(@{$groups},('all','none'));
+            opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
         }
-
-    } 
-    my $num_sections = scalar(@{$sections});
-    my $seclist = join('","',@{$sections});
-    my $num_groups = scalar(@{$groups});
-    my $groupslist = join('","',@{$groups});
-    my ($roleslist,$num_roles,$rolesnameslist,$num_access,$accesslist,
-        $accessnameslist);
-    if ($needroles) {
-        $num_roles = @{$allroles};
-        $roleslist = join('","',@{$allroles});
-        my @allrolesnames; 
-        foreach my $role (@{$allroles}) {
-            push(@allrolesnames,$$roleshash{$role});
-        }  
-        $rolesnameslist = join('","',@allrolesnames);
-    }
-    if ($needaccess) {
-        $num_access = keys(%{$accesshash});
-        my (@allaccess,@allaccessnames);
-        foreach my $key (sort(keys(%{$accesshash}))) {
-            push(@allaccess,$key);
-            push(@allaccessnames,$$accesshash{$key}); 
+    } else {
+        for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
+            if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
+                opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
+            } else {
+                opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
+            }
+        }
+    }
+    if (courseCount > 0) {
+        courses = courses.substr(0,courses.length-2);
+        opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
+    }
+ENDSCRIPT
+    } else {
+        my $name_code;
+        if ($env{'form.cnameelement'} ne '') {
+            $name_code = 'opener.document.'.$env{'form.form'}.'.'.
+                          $env{'form.cnameelement'}.'.value=cdesc;';
+        }
+        $output .= qq|
+        $name_code
+        opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
+        var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
+        if (slct.options == undefined) {
+            opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
+        }
+        else {
+            var i;
+            for (i=0;i<slct.length;i++) {
+                if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
+            }
         }
-        $accesslist = join('","',@allaccess);
-        $accessnameslist = join('","',@allaccessnames);
+|;
+    }
+    $output .= qq|
+    if (openerForm == 'portform') {
+        document.courselist.cnum.value = cname;
+        document.courselist.cdom.value = cdom;
     }
-    return ($seclist,$num_sections,$groupslist,$num_groups,$roleslist,
-            $num_roles,$rolesnameslist,$accesslist,$num_access,$accessnameslist);
+    $autosubmit
+    $lastaction
+}
+</script>
+|;
+    return $output;
 }
 
 1;
 __END__
+
+=pod
+
+=head1 NAME
+
+Apache::lonpickcourse - Search for course(s) based on user-specified criteria.   
+
+=head1 SYNOPSIS
+
+Invoked by other LON-CAPA modules, when course(s) need to be selected by the user. 
+
+=head1 OVERVIEW
+
+Two screens are typically displayed to the user.  The first is a set of criteria which are used to constrain the search for courses.
+
+=head2 Search Criteria (Screen One)
+
+=head3 Criteria:
+
+=over 4
+
+=item *
+Course Activity - how recently was course last visited by anyone.
+
+=item *
+Course Domain - the domain of the course
+
+=item *
+Course Type - Course or Non-standard Course
+
+=item *
+Course Institutional Code - the institutional identifier assigned to the course
+
+=item * 
+Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
+
+=item *
+Course Owner's Domain - the domain of the owner of the course
+
+=item * 
+Course Description - text which appears in the Course Description (or title), as set in the Course Parameters.
+
+=item *
+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).
+
+=back
+
+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'}).
+
+=head2 Course Display (Screen Two)
+
+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:
+
+=over 4
+
+=item *
+Course description
+
+=item *
+Domain description of course domain
+
+=item *
+Course institutional code
+
+=item * 
+Course owner (username:domain)   
+ 
+=back
+
+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.
+
+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.
+
+=head1 SUBROUTINES
+
+=over 4
+
+=item *
+X<create_user_javascript()>
+B<create_user_javascript($type)>:
+
+Input: 1 - $type  - the course type - Course or Non-standard Course
+
+Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags 
+
+Side Effects: None 
+
+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.
+
+
+=item *
+X<display_matched_courses()>
+B<display_matched_courses($r,$type,$multiple,$action,%courses)>:
+
+Input: 5 - request object, course type, multiple (0 or 1), form action; hash of courses.
+
+Output: 0
+
+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.
+
+=item *
+X<multiples_tag()>
+B<multiples_tag()>:
+
+
+Input: 0
+
+Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
+
+Side Effects: None
+
+=item *
+X<build_filters()>
+B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action)>:
+
+
+Input: 6 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action.
+
+Output: 1 - $output - HTML for display of search criteria, and hidden form elements. 
+
+Side Effects: None
+
+=item *
+X<search_courses()>
+B<search_courses($r,$type,$onlyown,$filter)>:
+
+
+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.
+
+Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
+
+Side Effects: None
+
+
+=item *
+X<course_chooser()>
+B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>:
+
+Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description. 
+
+Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection.
+
+Side Effects: None
+
+
+=item *
+X<gochoose_javascript()>
+B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
+
+Input: 4 - course type; single (0) or multiple courses (1); in context of DC selecting a CC role in a course: javascript code from Apache::lonroles::processpick(); final action to take after user chooses course(s):  either close window, or submit form for display of next page etc.
+
+Output: 1  $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
+
+Side Effects: None
+
+javascript functions used when user selects a course(s). Different behavior depending on context:
+
+=back
+
+=over 8
+
+=item
+
+(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.
+
+=item
+
+(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.
+
+=item
+
+(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.
+
+=item
+
+(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. 
+
+=item
+
+(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.
+
+=item
+
+(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. 
+
+=item
+
+(g) Scantron Operator uploading a scantron file to a course - course number is written to visible form element in opener window. Child window closes.
+
+=back
+     
+=cut