[BACK]Return to lonpickcourse.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonpickcourse.pm between versions 1.33 and 1.67

version 1.33, 2005/10/14 18:43:13 version 1.67, 2007/11/06 04:39:19
Line 34  use Apache::loncommon; Line 34  use Apache::loncommon;
 use Apache::loncoursedata;  use Apache::loncoursedata;
 use Apache::lonnet;  use Apache::lonnet;
 use Apache::lonlocal;  use Apache::lonlocal;
   use Apache::longroup;
   use LONCAPA;
   
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
Line 42  sub handler { Line 44  sub handler {
     return OK if $r->header_only;      return OK if $r->header_only;
   
 # ------------------------------------------------------------ Print the screen  # ------------------------------------------------------------ Print the screen
     my $html=&Apache::lonxml::xmlbegin();  
     $r->print(<<ENDDOCUMENT);      # Get parameters from query string
 $html  
 <head>  
 <title>The LearningOnline Network with CAPA</title>  
 </head>  
 ENDDOCUMENT  
 # Get parameters from query string  
     &Apache::loncommon::get_unprocessed_cgi      &Apache::loncommon::get_unprocessed_cgi
         ($ENV{'QUERY_STRING'},['domainfilter','descriptfilter',          ($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement',
        'sincefilter','form','cnumelement',  
        'cdomelement','cnameelement','roleelement',         'cdomelement','cnameelement','roleelement',
                                'pickedcourse','instcodefilter',                                 'multiple','type','setroles']);
                                'ownerfilter','coursefilter']);  
 # domain filter and selection      my ($type,$title,$jscript,$multelement,$multiple,$roleelement,
     my $domainfilter=$env{'form.domainfilter'};          $lastaction,$autosubmit,$submitopener);
     $domainfilter=~s/\W//g;  
     unless ($domainfilter) { $domainfilter=''; }      # Get course type - Course or Non-standard Course.
     my $domainselectform=&Apache::loncommon::select_dom_form($domainfilter,      $type = $env{'form.type'};
                                                           'domainfilter',1);      if (!defined($env{'form.type'})) {
 # description filter          $type = 'Course';
     my $descriptfilter=$env{'form.descriptfilter'};      }
     unless ($descriptfilter) { $descriptfilter=''; }      $title = &mt('Selecting a [_1]',$type);
     my $listdescript=&HTML::Entities::encode($descriptfilter,'<>&"');  
 # institutional code filter      # Setup for multiple course selections, if flag for multiples set.
     my $instcodefilter=$env{'form.instcodefilter'};      $multiple = $env{'form.multiple'};
     unless ($instcodefilter) { $instcodefilter=''; }      if ($multiple) {
     my $listinstcode=&HTML::Entities::encode($instcodefilter,'<>&"');          ($jscript,$multelement) = &multiples_tag();
 # course owner filter          $title = &mt('Selecting [_1](s)',lc($type));
     my $ownerfilter=$env{'form.ownerfilter'};  
     unless ($ownerfilter) { $ownerfilter=''; }  
     my $listowner=&HTML::Entities::encode($ownerfilter,'<>&"');  
 # 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);  
     my $num_sections = 0;  
     if ($env{'form.form'} eq 'cu' && $env{'form.pickedcourse'}) {  
         $loaditem = 'onLoad="setSections()"';  
         my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};  
         my %sections_count = ();  
         $num_sections = &Apache::loncommon::get_sections($cdom,$cnum,\%sections_count);  
         my @sections = ();  
         if ($num_sections > 0) {  
             @sections = (sort {$a <=> $b} keys(%sections_count));  
             $seclist = join('","',@sections);  
         }  
     }  
 # if called from rolefilter, setup for multiple course selections.  
     my $multflag = 0;  
     my $jscript;  
     my $title = 'Selecting a course';  
     if ($env{'form.form'} eq 'rolefilter') {  
         $multflag = 1;  
         $title = 'Selecting course(s)';  
     }  
     if ($multflag) {  
         $jscript = &Apache::loncommon::check_uncheck_jscript();  
     }  
     $r->print(&Apache::loncommon::bodytag($title,undef,$loaditem,undef,undef,undef,undef,1));  
     my %lt=&Apache::lonlocal::texthash(  
        'cac' => 'Course Activity',  
        'cde' => 'Course Description',  
        'cdo' => 'Course Domain',  
                                        'cin' => 'Course Institutional Code',  
                                        'cow' => "Course Owner's usename");  
     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 called when a DC is selecting a course 
     my $roledom = $env{'form.roleelement'};      my $roledom = $env{'form.roleelement'};
     if ($roledom) {      if ($roledom) {
         $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';          $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
         $submitopener = &Apache::lonroles::processpick($roledom);          $submitopener = &processpick();
         $autosubmit = 'process_pick("'.$roledom.'")';          $autosubmit = 'process_pick("'.$roledom.'")';
     }      }
     $r->print(<<ENDSCRIPT);  
 <script>      my $onlyown = 0;
 function gochoose(cname,cdom,cdesc,multflag,caller) {      # if called to assign course-based portfolio access control
     var openerForm = "$env{'form.form'}";      if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
     courseCount = 0;          $onlyown = 1;
     var courses = '';  
     if (multflag) {  
  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'}.coursetotal.value = courseCount;  
  if (typeof(opener.document.$env{'form.form'}.coursepick.length) ==  
     'undefined') {  
     if (opener.document.$env{'form.form'}.coursepick.value == 'specific') {    
  opener.document.$env{'form.form'}.coursepick.checked = true;  
     } else {  
  opener.document.$env{'form.form'}.coursepick.checked = false;  
     }  
  } else {  
     for (var j=0; j<opener.document.$env{'form.form'}.coursepick.length; j++) {   
  if (opener.document.$env{'form.form'}.coursepick[j].value == 'specific') {    
     opener.document.$env{'form.form'}.coursepick[j].checked = true;  
  }  
  else {  
     opener.document.$env{'form.form'}.coursepick[j].checked = false;  
  }  
     }  
  }  
  if (courseCount > 0) {  
     courses = courses.substr(0,courses.length-2);  
     opener.document.$env{'form.form'}.courselist.value = courses;  
  }  
     }      }
     else {  
         $name_code      my %loaditem;
         opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;      if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) && 
         if (openerForm == 'cu') {          ($env{'form.pickedcourse'})) {
             opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;          $loaditem{'onload'} ="setSections()";
       }
       $r->print(&Apache::loncommon::start_page($title,undef,
        {'add_entries' => \%loaditem,
         'no_nav_bar'  => 1, }));
   
       if ($env{'form.form'} eq 'portform') {
           $lastaction = 'document.courselist.submit()';
       } elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' &&
           !$multiple)) {
           $lastaction = 
                'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
                'document.courselist.submit();';
       } else {
           $lastaction = 'self.close()';
       }
   
       # if called to assign a role in a course to a user via CUSR
       if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') {
           $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');
         }          }
         else {          $r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
             var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};                                   $filter,$action));
             var i;      }
             for (i=0;i<slct.length;i++) {  
                 if (slct.options[i].value==cdom) { slct.selectedIndex=i; }  # ---------------------------------------------------------------- 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;
   }
   
   sub processpick {
       my $openerform = 'rolechoice';
       if ($env{'form.form'} eq 'studentform') {
           $openerform = $env{'form.form'};
       }
       my $process_pick = <<"ENDONE";
   <script type="text/javascript">
   function process_pick(dom) {
       var pickedCourse=opener.document.$openerform.$env{'form.cnumelement'}.value;
       var pickedDomain=opener.document.$openerform.$env{'form.cdomelement'}.value;
       var okDomain = 0;
   ENDONE
       if ($openerform eq 'rolechoice') {
           $process_pick .= <<"ENDTWO";
       if (pickedDomain == dom) {
           if (pickedCourse != '') {
               var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
               opener.document.title='Role selected. Please stand by.';
               opener.status='Role selected. Please stand by.';
               opener.document.rolechoice.newrole.value=courseTarget
               opener.document.rolechoice.submit();
         }          }
       } 
       else {
           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");
     }      }
     $autosubmit  ENDTWO
     $lastaction      } else {
           $process_pick .= <<"ENDTHREE";
       if (pickedDomain != dom) {
           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");
           return;
       }
   ENDTHREE
       }
       $process_pick .= "
 }  }
   
   </script>
   ";
       return $process_pick;
   }
   
   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() {  function setSections() {
     var numSections = $num_sections      opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
     var sectionsArray = new Array("$seclist")      window.opener.setSect('$seclist');
     opener.document.$env{"form.form"}.currsec.length = 0      self.close()
     if (numSections == 0) {  }
         opener.document.$env{"form.form"}.currsec.multiple=false  </script>
         opener.document.$env{"form.form"}.currsec.size=1;  |;
         opener.document.$env{"form.form"}.currsec.options[0] = new Option('No existing sections','',false,false)  ;
     }      }
     else {      return $output;
         if (numSections == 1) {  }
             opener.document.$env{"form.form"}.currsec.multiple=false;  
             opener.document.$env{"form.form"}.currsec.size=1;  sub display_matched_courses {
             opener.document.$env{"form.form"}.currsec.options[0] = new Option('Select','',true,true);      my ($r,$type,$multiple,$action,%courses) = @_;
             opener.document.$env{"form.form"}.currsec.options[1] = new Option('No section','',false,false)       if ($env{'form.form'} eq 'portform') {
             opener.document.$env{"form.form"}.currsec.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);          $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 {
               $descr = &unescape($courses{$course});
         }          }
         else {          my $description = $descr;
             for (var i=0; i<numSections; i++) {          push (@{$by_descrip{$description}}, $course);
                 opener.document.$env{"form.form"}.currsec.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)      }
       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 {
                   my $singleowner; 
                   ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
                   push(@owners,&unescape($singleowner));
             }              }
             opener.document.$env{"form.form"}.currsec.multiple=true              my $owner = join(', ',@owners);
             if (numSections < 3) {              $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
                 opener.document.$env{"form.form"}.currsec.size=numSections;              $r->print($description.'('.
                         (&Apache::lonnet::domain($cdom,'description')?
                          &Apache::lonnet::domain($cdom,'description'):$cdom).")");
               if ($instcode ne '') {
                   $r->print(" - ".&unescape($instcode));
             }              }
             else {              if (@owners > 1) {
                 opener.document.$env{"form.form"}.currsec.size=3;                  $r->print(', '.&mt('owners').' - ',join(', ',@owners)); 
               } elsif (@owners == 1) {
                   $r->print(', '.&mt('owner').' - '.$owner);
             }              }
             opener.document.$env{"form.form"}.currsec.options[0].selected = false              if ($ttype ne '') {
                   $r->print('('.&unescape($ttype).')');
               }
               if ($multiple) { $r->print("</label>\n"); }
               $r->print("<br />\n");
         }          }
     }      }
     self.close()      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;
 }  }
   
 $jscript  
 </script>  sub multiples_tag {
 $submitopener      my $jscript = &Apache::loncommon::check_uncheck_jscript();
 <form method="post" name="filterpicker">      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;
       }
       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;
       } elsif ($formname eq 'studentform') {
                   $filter->{$item} ||= $env{'request.role.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},'<>&"');
           }
       }
   
       # 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),
                 'cin' => &mt('Course Institutional Code'),
                 'cow' => &mt("[_1] Owner's Username",$type),
                 'cod' => &mt("[_1] Owner's Domain", $type),
                 'cog' => &mt('Course Type')
                );
   
       $typeselectform =  '<select name="type" size="1">'."\n";
       if ($type eq 'Course') {
           $instcodeform = 
                   '<input type="text" name="instcodefilter" size="10" value="'.
                   $list->{'instcodefilter'}.'" />';
       }
       foreach my $posstype ('Course','Non-standard Course') {
           $typeselectform.='<option value="'.$posstype.'" "'.
               ($posstype eq $type ? 'selected="selected" ' : ''). ">$posstype</option>\n";
       }
       $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'}.'" />';
           }
           $output .= qq|
 <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />  <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
 <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />  <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
 $name_input  $name_input
 <input type="hidden" name="form" value="$env{'form.form'}" />  
 $roleelement  $roleelement
 $lt{'cac'}: $sincefilterform  $multelement
 <br />  |;
 $lt{'cdo'}: $domainselectform          if ($formname eq 'portform') {
 <br />              $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
 $lt{'cin'}:          }
 <input type="text" name="instcodefilter" size="10" value="$listinstcode" />      }
 <br />      if ($sincefilterform) { 
 $lt{'cow'}:          $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
 <input type="text" name="ownerfilter" size="10" value="$listowner" />      }
 <br />      if ($domainselectform) {
 $courseidtag          $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
 $lt{'cde'}:      }
 <input type="text" name="descriptfilter" size="40" value="$listdescript" />      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>  <p><input type="submit" name="gosearch" value="Search" /></p>
 </form>  </form>
 <hr />  <hr />
 ENDSCRIPT  |;
 # ---------------------------------------------------------------- Get the data      return $output; 
     if ($env{'form.gosearch'}) {  }
   
   sub search_courses {
       my ($r,$type,$onlyown,$filter) = @_;
       my %courses;
       if (!$onlyown) {
         $r->print(&mt('Searching').' ...<br />&nbsp;<br />');          $r->print(&mt('Searching').' ...<br />&nbsp;<br />');
         $r->rflush();          $r->rflush();
  unless ($descriptfilter) { $descriptfilter='.'; }          if (($filter->{'ownerfilter'} ne '') ||
         unless ($instcodefilter) { $instcodefilter='.'; }              ($filter->{'ownerdomfilter'} ne '')) {
         unless ($ownerfilter) { $ownerfilter='.'; }              $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
         unless ($coursefilter) { $coursefilter='.'; }                                             $filter->{'ownerdomfilter'};
         my $timefilter=($sincefilter==-1?1:time-$sincefilter);          }
  my %courses=          foreach my $item ('descriptfilter','instcodefilter','coursefilter',
     &Apache::lonnet::courseiddump                            'combownerfilter') {
     ($domainfilter,$descriptfilter,$timefilter,$instcodefilter,$ownerfilter,$coursefilter);              if (!$filter->{$item}) {
  $r->print('<form name="courselist">');                  $filter->{$item}='.';
  my %by_descrip;  
         my $numcourses = keys(%courses);  
  foreach my $course (keys(%courses)) {  
             my $descr;  
             if ($courses{$course} =~ m/^([^:]*):/) {  
                 $descr = &Apache::lonnet::unescape($1);  
             } else {  
                 $descr = &Apache::lonnet::unescape($courses{$course});  
             }  
             my $description = lc($descr);  
             push (@{$by_descrip{$description}}, $course);  
  }  
         if ($numcourses > 1 && $multflag) {  
             $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(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) = split/:/,$courses{$course};  
                 $r->print(&course_chooser($multflag,$cdom,$cnum,$cleandesc));  
         $r->print($description.'('.  
       ($Apache::lonnet::domaindescription{$cdom}?  
                        $Apache::lonnet::domaindescription{$cdom}:$cdom).")");  
                 unless ($instcode eq '') {  
                     $r->print(" - ".&Apache::lonnet::unescape($instcode));  
                 }  
                 unless ($owner eq '') {  
                     $r->print(", owner - ".&Apache::lonnet::unescape($owner));  
                 }  
  if ($multflag) { $r->print("</label>\n"); }  
                 $r->print("<br />\n");  
             }              }
  }          }
  if (!%courses) {           if ($type eq '') { $type = '.'; }
             $r->print(&mt('None found'));          my $timefilter = 
         } elsif ($multflag) {             ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
             $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','',1)".'" />');          %courses = 
         }              &Apache::lonnet::courseiddump($filter->{'domainfilter'},
         $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'."\n".                                            $filter->{'descriptfilter'},
                    '<input type="hidden" name="pickedcourse" value="" />'."\n".                                            $timefilter,
                    '<input type="hidden" name="cnumelement" value="'.$env{'form.cnumelement'}.'" />'."\n".                                            $filter->{'instcodefilter'},
                    '<input type="hidden" name="cdomelement" value="'.$env{'form.cdomelement'}.'" />'."\n".                                            $filter->{'combownerfilter'},
                    '</form>');                                            $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('</body></html>');      return %courses;
     return OK;  
 }  }
   
 sub course_chooser {  sub course_chooser {
     my ($multflag,$cdom,$cnum,$cleandesc) = @_;      my ($multiple,$cdom,$cnum,$cleandesc) = @_;
     my $output;       my $output; 
     if ($multflag) {      if ($multiple) {
         $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";          $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
     } else {      } else {
         $output = '<input type="button" value="Select" onClick="gochoose('.          $output = '<input type="button" value="Select" onClick="gochoose('.
                   "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";                    "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
     }      }
     return $output;      return $output;
 }   }
   
   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 ++;
               }
           }
       }
       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;
       }
   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; }
               }
           }
   |;
       }
       $output .= qq|
       if (openerForm == 'portform') {
           document.courselist.cnum.value = cname;
           document.courselist.cdom.value = cdom;
       }
       $autosubmit
       $lastaction
   }
   </script>
   |;
       return $output;
   }
   
 1;  1;
 __END__  __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 &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
Removed from v.1.33  
changed lines
  Added in v.1.67

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>