Annotation of loncom/interface/lonpickcourse.pm, revision 1.67.2.1

1.1       www         1: # The LearningOnline Network
                      2: # Pick a course
                      3: #
1.67.2.1! albertel    4: # $Id: lonpickcourse.pm,v 1.67 2007/11/06 04:39:19 raeburn Exp $
1.1       www         5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
                     28: 
                     29: package Apache::lonpickcourse;
                     30: 
                     31: use strict;
                     32: use Apache::Constants qw(:common);
                     33: use Apache::loncommon;
                     34: use Apache::loncoursedata;
                     35: use Apache::lonnet;
1.8       www        36: use Apache::lonlocal;
1.46      raeburn    37: use Apache::longroup;
1.47      www        38: use LONCAPA;
1.1       www        39: 
                     40: sub handler {
                     41:     my $r = shift;
1.8       www        42:     &Apache::loncommon::content_type($r,'text/html');
1.1       www        43:     $r->send_http_header;
                     44:     return OK if $r->header_only;
                     45: 
                     46: # ------------------------------------------------------------ Print the screen
1.40      albertel   47: 
1.55      raeburn    48:     # Get parameters from query string
1.1       www        49:     &Apache::loncommon::get_unprocessed_cgi
1.55      raeburn    50:         ($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement',
1.19      raeburn    51: 			       'cdomelement','cnameelement','roleelement',
1.55      raeburn    52:                                'multiple','type','setroles']);
1.54      raeburn    53: 
1.55      raeburn    54:     my ($type,$title,$jscript,$multelement,$multiple,$roleelement,
                     55:         $lastaction,$autosubmit,$submitopener);
                     56: 
1.57      raeburn    57:     # Get course type - Course or Non-standard Course.
1.54      raeburn    58:     $type = $env{'form.type'};
                     59:     if (!defined($env{'form.type'})) {
                     60:         $type = 'Course';
                     61:     }
                     62:     $title = &mt('Selecting a [_1]',$type);
                     63: 
                     64:     # Setup for multiple course selections, if flag for multiples set.
1.55      raeburn    65:     $multiple = $env{'form.multiple'};
                     66:     if ($multiple) {
                     67:         ($jscript,$multelement) = &multiples_tag();
                     68:         $title = &mt('Selecting [_1](s)',lc($type));
1.54      raeburn    69:     }
                     70: 
1.55      raeburn    71:     # if called when a DC is selecting a course 
1.54      raeburn    72:     my $roledom = $env{'form.roleelement'};
                     73:     if ($roledom) {
                     74:         $roleelement = '<input type="hidden" name="roleelement" value="'.$roledom.'" />';
1.66      raeburn    75:         $submitopener = &processpick();
1.54      raeburn    76:         $autosubmit = 'process_pick("'.$roledom.'")';
                     77:     }
                     78: 
                     79:     my $onlyown = 0;
1.55      raeburn    80:     # if called to assign course-based portfolio access control
1.59      raeburn    81:     if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
1.54      raeburn    82:         $onlyown = 1;
1.49      raeburn    83:     }
1.55      raeburn    84: 
                     85:     my %loaditem;
1.66      raeburn    86:     if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) && 
                     87:         ($env{'form.pickedcourse'})) {
1.42      albertel   88:         $loaditem{'onload'} ="setSections()";
1.30      raeburn    89:     }
1.41      albertel   90:     $r->print(&Apache::loncommon::start_page($title,undef,
1.42      albertel   91: 					     {'add_entries' => \%loaditem,
1.41      albertel   92: 					      'no_nav_bar'  => 1, }));
1.55      raeburn    93: 
                     94:     if ($env{'form.form'} eq 'portform') {
                     95:         $lastaction = 'document.courselist.submit()';
1.67      raeburn    96:     } elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' &&
                     97:         !$multiple)) {
1.55      raeburn    98:         $lastaction = 
                     99:              'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
                    100:              'document.courselist.submit();';
1.34      albertel  101:     } else {
1.55      raeburn   102:         $lastaction = 'self.close()';
1.1       www       103:     }
1.19      raeburn   104: 
1.55      raeburn   105:     # if called to assign a role in a course to a user via CUSR
1.66      raeburn   106:     if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') {
1.55      raeburn   107:         $r->print(&create_user_javascript($type)); 
                    108:     }
1.54      raeburn   109: 
1.55      raeburn   110:     # print javascript functions for choosing a course 
                    111:     if ($env{'form.gosearch'} || $onlyown) {
1.58      raeburn   112:         $r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
1.55      raeburn   113:     }
                    114:     $r->print('<script type="text/javascript">'.$jscript.'</script>');
                    115:     $r->print($submitopener);
1.54      raeburn   116: 
1.55      raeburn   117: # ------------------------------------------ Display of filters to limit search
1.57      raeburn   118:     my $filter = {};
                    119:     my $action = '/adm/pickcourse';
1.55      raeburn   120:     if (!$onlyown) {
                    121:         my $filterlist = ['domainfilter','descriptfilter',
                    122:                           'instcodefilter','ownerfilter',
                    123:                           'ownerdomfilter'];
                    124:         # course ID filter for DCs only
                    125:         if ($env{'user.adv'} && $env{'form.domainfilter'} &&
                    126:             exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
                    127:             push(@{$filterlist},'coursefilter');
                    128:         }
                    129:         $r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
1.57      raeburn   130:                                  $filter,$action));
1.55      raeburn   131:     }
1.54      raeburn   132: 
                    133: # ---------------------------------------------------------------- Get the data
                    134:     if ($env{'form.gosearch'} || $onlyown) {
1.57      raeburn   135:         my %courses = &search_courses($r,$type,$onlyown,$filter);
                    136:         &display_matched_courses($r,$type,$multiple,$action,%courses);
1.54      raeburn   137:     }
                    138:     $r->print(&Apache::loncommon::end_page());
                    139:     return OK;
                    140: }
                    141: 
1.66      raeburn   142: sub processpick {
                    143:     my $openerform = 'rolechoice';
                    144:     if ($env{'form.form'} eq 'studentform') {
                    145:         $openerform = $env{'form.form'};
                    146:     }
                    147:     my $process_pick = <<"ENDONE";
                    148: <script type="text/javascript">
                    149: function process_pick(dom) {
                    150:     var pickedCourse=opener.document.$openerform.$env{'form.cnumelement'}.value;
                    151:     var pickedDomain=opener.document.$openerform.$env{'form.cdomelement'}.value;
                    152:     var okDomain = 0;
                    153: ENDONE
                    154:     if ($openerform eq 'rolechoice') {
                    155:         $process_pick .= <<"ENDTWO";
                    156:     if (pickedDomain == dom) {
                    157:         if (pickedCourse != '') {
                    158:             var courseTarget = "cc./"+pickedDomain+"/"+pickedCourse
                    159:             opener.document.title='Role selected. Please stand by.';
                    160:             opener.status='Role selected. Please stand by.';
                    161:             opener.document.rolechoice.newrole.value=courseTarget
                    162:             opener.document.rolechoice.submit();
                    163:         }
                    164:     } 
                    165:     else {
                    166:         alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
                    167:     }
                    168: ENDTWO
                    169:     } else {
                    170:         $process_pick .= <<"ENDTHREE";
                    171:     if (pickedDomain != dom) {
                    172:         alert("You may only use this screen to select courses in the current domain: "+dom+"\\nPlease return to the roles page window and click the 'Select Course' link for domain: "+pickedDomain+",\\n if you are a Domain Coordinator in that domain, and wish to become a Course Coordinator in a course in the domain");
                    173:         return;
                    174:     }
                    175: ENDTHREE
                    176:     }
                    177:     $process_pick .= "
                    178: }
                    179: 
                    180: </script>
                    181: ";
                    182:     return $process_pick;
                    183: }
                    184: 
1.55      raeburn   185: sub create_user_javascript {
                    186:     my ($type) = @_;
                    187:     my $output;
                    188:     #javascript for reporting sections and groups then closing
                    189:     if ($env{'form.pickedcourse'}) {
                    190:         my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
                    191:         my $sec_element = 'currsec';
                    192:         my $grplist_element = 'groups';
                    193:         my ($sections,$groups) =
                    194:           &Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
                    195:         my $num_sections = scalar(@{$sections});
                    196:         my $seclist = join(',',@{$sections});
                    197:         my $num_groups = scalar(@{$groups});
                    198:         my $groupslist = join(',',@{$groups});
                    199:         $output = qq|
                    200: <script type="text/javascript">
                    201: function setSections() {
                    202:     opener.document.$env{"form.form"}.$grplist_element.value='$groupslist';
                    203:     window.opener.setSect('$seclist');
                    204:     self.close()
                    205: }
                    206: </script>
                    207: |;
                    208: ;
                    209:     }
                    210:     return $output;
                    211: }
                    212: 
1.54      raeburn   213: sub display_matched_courses {
1.57      raeburn   214:     my ($r,$type,$multiple,$action,%courses) = @_;
1.55      raeburn   215:     if ($env{'form.form'} eq 'portform') {
                    216:         $action = '/adm/portfolio';
                    217:     }
                    218:     $r->print('<form name="courselist" method="post" action="'.$action.'">');
1.54      raeburn   219:     my %by_descrip;
                    220:     my $numcourses = keys(%courses);
                    221:     foreach my $course (keys(%courses)) {
                    222:         my $descr;
1.64      raeburn   223:         if (ref($courses{$course}) eq 'HASH') {
1.65      raeburn   224:             $descr = $courses{$course}{'description'};
1.64      raeburn   225:         } elsif ($courses{$course} =~ m/^([^:]*):/i) {
1.54      raeburn   226:             $descr = &unescape($1);
1.34      albertel  227:         } else {
1.54      raeburn   228:             $descr = &unescape($courses{$course});
                    229:         }
                    230:         my $description = $descr;
                    231:         push (@{$by_descrip{$description}}, $course);
                    232:     }
                    233:     if ($numcourses > 1 && $multiple) {
                    234:         $r->print('<input type="button" value="check all"
                    235:                   onclick="javascript:checkAll(document.courselist.course_id)" />
                    236:                   &nbsp;&nbsp;<input type="button" value="uncheck all"
                    237:                   onclick="javascript:uncheckAll(document.courselist.course_id)" />
                    238:                   <br /><br />');
                    239:     }
                    240:     foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
                    241:         foreach my $course (@{$by_descrip{$description}}) {
                    242:             my $cleandesc=&HTML::Entities::encode($description,'<>&"');
                    243:             $cleandesc=~s/'/\\'/g;
                    244:             my ($cdom,$cnum)=split(/\_/,$course);
1.64      raeburn   245:             my ($descr,$instcode,$ttype,@owners);
                    246:             if (ref($courses{$course}) eq 'HASH') {
                    247:                 $descr = $courses{$course}{'description'};
1.65      raeburn   248:                 $instcode =  $courses{$course}{'inst_code'};
1.64      raeburn   249:                 $ttype =  $courses{$course}{'type'};
                    250:                 push(@owners,&unescape($courses{$course}{'owner'}));
                    251:                 if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') {
                    252:                     foreach my $item (@{$courses{$course}{'co-owners'}}) {
                    253:                         push(@owners,&unescape($item));
                    254:                     }
                    255:                 }
                    256:             } else {
                    257:                 my $singleowner; 
                    258:                 ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
                    259:                 push(@owners,&unescape($singleowner));
                    260:             }
                    261:             my $owner = join(', ',@owners);
1.54      raeburn   262:             $r->print(&course_chooser($multiple,$cdom,$cnum,$cleandesc));
                    263:             $r->print($description.'('.
1.62      albertel  264:                       (&Apache::lonnet::domain($cdom,'description')?
                    265:                        &Apache::lonnet::domain($cdom,'description'):$cdom).")");
1.64      raeburn   266:             if ($instcode ne '') {
1.54      raeburn   267:                 $r->print(" - ".&unescape($instcode));
                    268:             }
1.64      raeburn   269:             if (@owners > 1) {
                    270:                 $r->print(', '.&mt('owners').' - ',join(', ',@owners)); 
                    271:             } elsif (@owners == 1) {
                    272:                 $r->print(', '.&mt('owner').' - '.$owner);
1.23      raeburn   273:             }
1.64      raeburn   274:             if ($ttype ne '') {
1.55      raeburn   275:                 $r->print('('.&unescape($ttype).')');
1.23      raeburn   276:             }
1.54      raeburn   277:             if ($multiple) { $r->print("</label>\n"); }
                    278:             $r->print("<br />\n");
1.19      raeburn   279:         }
                    280:     }
1.54      raeburn   281:     if (!%courses) {
                    282:         $r->print(&mt('None found'));
                    283:     } elsif ($multiple) {
1.57      raeburn   284:         $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
1.54      raeburn   285:     }
                    286:     $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
                    287:               "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
                    288:               '<input type="hidden" name="type" value="'.$type.'" />'."\n");
                    289:     if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
                    290:         $r->print('<input type="hidden" name="roleelement" value="'.
                    291:                   $env{'form.roleelement'}.'" />'."\n");
                    292:     }
1.55      raeburn   293:     if ($env{'form.form'} eq 'portform') {
                    294:         $r->print('<input type="hidden" name="cnum" value="" />');
                    295:         $r->print('<input type="hidden" name="cdom" value="" />');
                    296:         $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
                    297:         $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57      raeburn   298:     } elsif ($env{'form.form'} eq 'modifycourse') {
                    299:         $r->print('<input type="hidden" name="phase" value="menu" />'."\n");
                    300:         $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form']));
                    301:     } else {
                    302:         $r->print('<input type="hidden" name="cnumelement" value="'.
                    303:                   $env{'form.cnumelement'}.'" />'."\n".  
                    304:                   '<input type="hidden" name="cdomelement" value="'.
                    305:                   $env{'form.cdomelement'}.'" />'."\n");
1.55      raeburn   306:     }
1.54      raeburn   307:     $r->print("</form>\n");
                    308:     return;
                    309: }
                    310: 
                    311: 
                    312: sub multiples_tag {
1.55      raeburn   313:     my $jscript = &Apache::loncommon::check_uncheck_jscript();
                    314:     my $multelement = '<input type="hidden" name="multiple" value="1" />';
                    315:     return ($jscript,$multelement);
1.1       www       316: }
1.30      raeburn   317: 
1.54      raeburn   318: sub build_filters {
1.57      raeburn   319:     my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
                    320:         $caller) = @_;
1.55      raeburn   321:     my $list;
1.57      raeburn   322:     my $formname;
                    323:     if (defined($env{'form.form'})) {
                    324:          $formname = $env{'form.form'};
                    325:     } else {
                    326:          $formname = $caller;
                    327:     }
1.55      raeburn   328:     my ($domainselectform,$sincefilterform,$ownerdomselectform,
1.54      raeburn   329:         $instcodeform,$typeselectform);
1.55      raeburn   330:     foreach my $item (@{$filterlist}) {
1.54      raeburn   331:         $filter->{$item} = $env{'form.'.$item};
                    332:         if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
1.61      albertel  333: 	    if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
                    334: 		$filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                    335: 	    } elsif ($item eq 'coursefilter') {
                    336: 		$filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                    337: 	    } elsif ($item eq 'ownerfilter') {
                    338: 		$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                    339: 	    } else {
                    340: 		$filter->{$item} =~ s/\W//g;
                    341: 	    }
1.54      raeburn   342:             if (!$filter->{$item}) {
                    343:                 $filter->{$item} = '';
                    344:             }
                    345:         }
                    346:         if ($item eq 'domainfilter') {
1.63      albertel  347: 	    my $allow_blank = 1;
                    348: 	    if ($formname eq 'portform') {
                    349: 		$filter->{$item} ||= $env{'user.domain'};
                    350: 		$allow_blank=0;
1.67      raeburn   351: 	    } elsif ($formname eq 'studentform') {
                    352:                 $filter->{$item} ||= $env{'request.role.domain'};
                    353:                 $allow_blank=0;
                    354:             }
1.54      raeburn   355:             $domainselectform =
1.63      albertel  356: 		&Apache::loncommon::select_dom_form($filter->{$item},
                    357: 						    'domainfilter',
                    358: 						    $allow_blank);
1.54      raeburn   359:         } elsif ($item eq 'ownerdomfilter') {
                    360:             $ownerdomselectform =
                    361:      &Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
                    362:         } else {
                    363:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                    364:         }
                    365:     }
                    366: 
                    367:     # last course activity filter and selection
                    368:     $filter->{'sincefilter'} = $env{'form.sincefilter'};
                    369:     $filter->{'sincefilter'} =~ s/[^\d-]//g;
                    370:     if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
                    371:     $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
                    372:        'sincefilter',('-1'=>'',
                    373:                       '86400' => 'today',
                    374:                       '604800' => 'last week',
                    375:                       '2592000' => 'last month',
                    376:                       '7776000' => 'last three months',
                    377:                       '15552000' => 'last six months',
                    378:                       '31104000' => 'last year',
                    379:                       'select_form_order' =>
                    380:                       ['-1','86400','604800','2592000','7776000',
                    381:                       '15552000','31104000']));
                    382: 
                    383:     my %lt = (
                    384:               'cac' => &mt('[_1] Activity',$type),
                    385:               'cde' => &mt('[_1] Description',$type),
                    386:               'cdo' => &mt('[_1] Domain',$type),
                    387:               'cin' => &mt('Course Institutional Code'),
                    388:               'cow' => &mt("[_1] Owner's Username",$type),
                    389:               'cod' => &mt("[_1] Owner's Domain", $type),
                    390:               'cog' => &mt('Course Type')
                    391:              );
1.49      raeburn   392: 
1.65      raeburn   393:     $typeselectform =  '<select name="type" size="1">'."\n";
1.54      raeburn   394:     if ($type eq 'Course') {
1.57      raeburn   395:         $instcodeform = 
                    396:                 '<input type="text" name="instcodefilter" size="10" value="'.
                    397:                 $list->{'instcodefilter'}.'" />';
1.54      raeburn   398:     }
1.57      raeburn   399:     foreach my $posstype ('Course','Non-standard Course') {
1.54      raeburn   400:         $typeselectform.='<option value="'.$posstype.'" "'.
                    401:             ($posstype eq $type ? 'selected="selected" ' : ''). ">$posstype</option>\n";
                    402:     }
                    403:     $typeselectform.="</select>";
1.57      raeburn   404:     my $output = qq|
                    405: <form method="post" name="filterpicker" action="$action">
                    406: <input type="hidden" name="form" value="$formname" />
                    407: |;
                    408:     if ($formname eq 'modifycourse') {
                    409:         $output .= '<input type="hidden" name="phase" value="courselist" />';
                    410:     } else {     
                    411:         my $name_input;
                    412:         if ($env{'form.cnameelement'} ne '') {
                    413:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                    414:                           $env{'form.cnameelement'}.'" />';
                    415:         }
                    416:         $output .= qq|
1.27      albertel  417: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
                    418: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
1.13      albertel  419: $name_input
1.18      raeburn   420: $roleelement
1.35      raeburn   421: $multelement
1.57      raeburn   422: |;
1.59      raeburn   423:         if ($formname eq 'portform') {
                    424:             $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
                    425:         }
1.57      raeburn   426:     }
                    427:     if ($sincefilterform) { 
                    428:         $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
                    429:     }
                    430:     if ($domainselectform) {
                    431:         $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
                    432:     }
1.67.2.1! albertel  433: #    if ($typeselectform) {
        !           434: #        $output .= $lt{'cog'}.': '.$typeselectform.'<br />'."\n";
        !           435: #    }
1.57      raeburn   436:     if ($instcodeform) {
                    437:         $output .= $lt{'cin'}.': '.$instcodeform.'<br />'."\n";
                    438:     }
                    439:     if (exists($filter->{'ownerfilter'})) {
                    440:         $output .= $lt{'cow'}.': '.
                    441:                    '<input type="text" name="ownerfilter" size="10" value="'.
                    442:                    $list->{'ownerfilter'}.'" /><br />'."\n".
                    443:                    $lt{'cod'}.': '.$ownerdomselectform.'<br />'."\n";
                    444:     }
                    445:     if (exists($filter->{'coursefilter'})) {
                    446:         $output .= &mt('LON-CAPA course ID').': '.
                    447:                    '<input type="text" name="coursefilter" size="25" value="'.
                    448:                     $list->{'coursefilter'}.'" /><br />';
                    449:     }
                    450:     if (exists($filter->{'descriptfilter'})) {
                    451:         $output .=$lt{'cde'}.': '.
                    452:                   '<input type="text" name="descriptfilter" size="40" value="'.
                    453:                   $list->{'descriptfilter'}.'" />'."\n";
                    454:     }
                    455:     $output .= qq|
1.5       www       456: <p><input type="submit" name="gosearch" value="Search" /></p>
1.4       www       457: </form>
1.5       www       458: <hr />
1.57      raeburn   459: |;
1.54      raeburn   460:     return $output; 
                    461: }
                    462: 
                    463: sub search_courses {
                    464:     my ($r,$type,$onlyown,$filter) = @_;
                    465:     my %courses;
                    466:     if (!$onlyown) {
1.8       www       467:         $r->print(&mt('Searching').' ...<br />&nbsp;<br />');
1.6       www       468:         $r->rflush();
1.54      raeburn   469:         if (($filter->{'ownerfilter'} ne '') ||
                    470:             ($filter->{'ownerdomfilter'} ne '')) {
                    471:             $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                    472:                                            $filter->{'ownerdomfilter'};
                    473:         }
                    474:         foreach my $item ('descriptfilter','instcodefilter','coursefilter',
                    475:                           'combownerfilter') {
                    476:             if (!$filter->{$item}) {
                    477:                 $filter->{$item}='.';
                    478:             }
1.52      raeburn   479:         }
                    480:         if ($type eq '') { $type = '.'; }
1.54      raeburn   481:         my $timefilter = 
                    482:            ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
                    483:         %courses = 
                    484:             &Apache::lonnet::courseiddump($filter->{'domainfilter'},
                    485:                                           $filter->{'descriptfilter'},
                    486:                                           $timefilter,
                    487:                                           $filter->{'instcodefilter'},
                    488:                                           $filter->{'combownerfilter'},
                    489:                                           $filter->{'coursefilter'},
                    490:                                           undef,undef,$type);
                    491:     } else {
                    492:         $r->print('<br />');
1.60      raeburn   493:         my %coursehash = &Apache::loncommon::findallcourses(); 
                    494:         foreach my $cid (sort(keys(%coursehash))) {
1.65      raeburn   495:             $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
1.36      raeburn   496:         }
1.2       www       497:     }
1.54      raeburn   498:     return %courses;
1.18      raeburn   499: }
1.1       www       500: 
1.30      raeburn   501: sub course_chooser {
1.35      raeburn   502:     my ($multiple,$cdom,$cnum,$cleandesc) = @_;
1.30      raeburn   503:     my $output; 
1.35      raeburn   504:     if ($multiple) {
1.32      albertel  505:         $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.30      raeburn   506:     } else {
                    507:         $output = '<input type="button" value="Select" onClick="gochoose('.
                    508:                   "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
                    509:     }
                    510:     return $output;
1.49      raeburn   511: }
                    512: 
1.55      raeburn   513: sub gochoose_javascript {
1.57      raeburn   514:     my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55      raeburn   515:     my %elements = (
                    516:                      'Course' => {
                    517:                                  name  => 'coursepick',
                    518:                                  total => 'coursetotal',
                    519:                                  list  => 'courselist',
                    520:                                  },
1.57      raeburn   521:                      'Non-standard Course' => {
1.55      raeburn   522:                                  name  => 'grouppick',
                    523:                                  total => 'grouptotal',
                    524:                                  list  => 'grouplist',
                    525:                               },
                    526:                     );
1.57      raeburn   527:     my $output .= qq|
1.55      raeburn   528: <script type="text/javascript">
1.57      raeburn   529: function gochoose(cname,cdom,cdesc) {
1.55      raeburn   530:     var openerForm = "$env{'form.form'}";
                    531:     courseCount = 0;
                    532:     var courses = '';
1.57      raeburn   533: |;
                    534:     if ($multiple) {
                    535:         $output .= <<"ENDSCRIPT";
                    536:     courseCount = 0;
                    537:     var courses = '';
                    538:     if (typeof(document.courselist.course_id.length) == 'undefined') {
                    539:         // only 1 course checkbox was created
                    540:         if (document.courselist.course_id.checked) {
                    541:             courses = courses + document.courselist.course_id.value + "&&";
                    542:             courseCount ++;
                    543:         }
                    544:     } else {
                    545:         for (var j=0; j<document.courselist.course_id.length; j++) {
                    546:             if (document.courselist.course_id[j].checked) {
                    547:                 courses = courses + document.courselist.course_id[j].value + "&&";
1.55      raeburn   548:                 courseCount ++;
                    549:             }
1.57      raeburn   550:         }
                    551:     }
                    552:     opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
                    553:     if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
                    554:         'undefined') {
                    555:         if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
                    556:             opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55      raeburn   557:         } else {
1.57      raeburn   558:             opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55      raeburn   559:         }
1.57      raeburn   560:     } else {
                    561:         for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
                    562:             if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
                    563:                 opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55      raeburn   564:             } else {
1.57      raeburn   565:                 opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54      raeburn   566:             }
1.55      raeburn   567:         }
1.57      raeburn   568:     }
                    569:     if (courseCount > 0) {
                    570:         courses = courses.substr(0,courses.length-2);
                    571:         opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
                    572:     }
                    573: ENDSCRIPT
                    574:     } else {
                    575:         my $name_code;
                    576:         if ($env{'form.cnameelement'} ne '') {
                    577:             $name_code = 'opener.document.'.$env{'form.form'}.'.'.
                    578:                           $env{'form.cnameelement'}.'.value=cdesc;';
1.55      raeburn   579:         }
1.57      raeburn   580:         $output .= qq|
1.55      raeburn   581:         $name_code
                    582:         opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
                    583:         var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
                    584:         if (slct.options == undefined) {
                    585:             opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
                    586:         }
                    587:         else {
                    588:             var i;
                    589:             for (i=0;i<slct.length;i++) {
                    590:                 if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54      raeburn   591:             }
                    592:         }
1.57      raeburn   593: |;
1.54      raeburn   594:     }
1.57      raeburn   595:     $output .= qq|
1.55      raeburn   596:     if (openerForm == 'portform') {
                    597:         document.courselist.cnum.value = cname;
                    598:         document.courselist.cdom.value = cdom;
                    599:     }
                    600:     $autosubmit
                    601:     $lastaction
1.54      raeburn   602: }
1.55      raeburn   603: </script>
1.57      raeburn   604: |;
1.55      raeburn   605:     return $output;
1.54      raeburn   606: }
                    607: 
1.55      raeburn   608: 1;
                    609: __END__
                    610: 
                    611: =pod
                    612: 
                    613: =head1 NAME
                    614: 
                    615: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.   
                    616: 
                    617: =head1 SYNOPSIS
                    618: 
                    619: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user. 
                    620: 
                    621: =head1 OVERVIEW
                    622: 
                    623: Two screens are typically displayed to the user.  The first is a set of criteria which are used to constrain the search for courses.
                    624: 
                    625: =head2 Search Criteria (Screen One)
                    626: 
                    627: =head3 Criteria:
                    628: 
                    629: =over 4
                    630: 
                    631: =item *
                    632: Course Activity - how recently was course last visited by anyone.
                    633: 
                    634: =item *
                    635: Course Domain - the domain of the course
                    636: 
                    637: =item *
1.57      raeburn   638: Course Type - Course or Non-standard Course
1.55      raeburn   639: 
                    640: =item *
                    641: Course Institutional Code - the institutional identifier assigned to the course
                    642: 
                    643: =item * 
                    644: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
                    645: 
                    646: =item *
                    647: Course Owner's Domain - the domain of the owner of the course
                    648: 
                    649: =item * 
                    650: Course Description - text which appears in the Course Description (or title), as set in the Course Parameters.
                    651: 
                    652: =item *
                    653: 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).
                    654: 
                    655: =back
                    656: 
                    657: 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'}).
                    658: 
                    659: =head2 Course Display (Screen Two)
                    660: 
                    661: 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:
                    662: 
                    663: =over 4
                    664: 
                    665: =item *
                    666: Course description
                    667: 
                    668: =item *
                    669: Domain description of course domain
                    670: 
                    671: =item *
                    672: Course institutional code
                    673: 
                    674: =item * 
                    675: Course owner (username:domain)   
                    676:  
                    677: =back
                    678: 
                    679: 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.
                    680: 
                    681: 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.
                    682: 
                    683: =head1 SUBROUTINES
                    684: 
                    685: =over 4
                    686: 
                    687: =item *
                    688: X<create_user_javascript()>
                    689: B<create_user_javascript($type)>:
                    690: 
1.57      raeburn   691: Input: 1 - $type  - the course type - Course or Non-standard Course
1.55      raeburn   692: 
                    693: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags 
                    694: 
                    695: Side Effects: None 
                    696: 
                    697: 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.
                    698: 
                    699: 
                    700: =item *
                    701: X<display_matched_courses()>
1.57      raeburn   702: B<display_matched_courses($r,$type,$multiple,$action,%courses)>:
1.55      raeburn   703: 
1.57      raeburn   704: Input: 5 - request object, course type, multiple (0 or 1), form action; hash of courses.
1.55      raeburn   705: 
                    706: Output: 0
                    707: 
                    708: 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.
                    709: 
                    710: =item *
                    711: X<multiples_tag()>
                    712: B<multiples_tag()>:
                    713: 
                    714: 
                    715: Input: 0
                    716: 
                    717: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
                    718: 
                    719: Side Effects: None
                    720: 
                    721: =item *
                    722: X<build_filters()>
1.57      raeburn   723: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action)>:
1.55      raeburn   724: 
                    725: 
1.57      raeburn   726: Input: 6 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action.
1.55      raeburn   727: 
                    728: Output: 1 - $output - HTML for display of search criteria, and hidden form elements. 
                    729: 
                    730: Side Effects: None
                    731: 
                    732: =item *
                    733: X<search_courses()>
                    734: B<search_courses($r,$type,$onlyown,$filter)>:
                    735: 
                    736: 
                    737: 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.
                    738: 
                    739: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                    740: 
                    741: Side Effects: None
                    742: 
                    743: 
                    744: =item *
                    745: X<course_chooser()>
                    746: B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>:
                    747: 
                    748: Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description. 
                    749: 
                    750: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection.
                    751: 
                    752: Side Effects: None
                    753: 
                    754: 
                    755: =item *
                    756: X<gochoose_javascript()>
1.57      raeburn   757: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55      raeburn   758: 
1.66      raeburn   759: Input: 4 - course type; single (0) or multiple courses (1); in context of DC selecting a CC role in a course: javascript code from &processpick(); final action to take after user chooses course(s):  either close window, or submit form for display of next page etc.
1.55      raeburn   760: 
                    761: Output: 1  $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
                    762: 
                    763: Side Effects: None
                    764: 
                    765: javascript functions used when user selects a course(s). Different behavior depending on context:
                    766: 
                    767: =back
                    768: 
                    769: =over 8
                    770: 
                    771: =item
                    772: 
                    773: (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.
                    774: 
                    775: =item
                    776: 
                    777: (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.
                    778: 
                    779: =item
                    780: 
                    781: (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.
                    782: 
                    783: =item
1.54      raeburn   784: 
1.55      raeburn   785: (d) User selecting a course for course-based conditional access control for a portfolio file - form is submitted, and new page is displayed for selection of roles, access types, sections and groups to be used in conditional ACL. New page is generated by /adm/portfolio. 
1.54      raeburn   786: 
1.55      raeburn   787: =item
1.54      raeburn   788: 
1.55      raeburn   789: (e) Domain Coordinator assigning a role to a user - form is submitted, and new page does an onload call to a javascript function to (a) write lists of sections and groups to hidden elements in opener window, (b) call function in opener window to dynamically populate select box showing current sections.
1.54      raeburn   790: 
1.55      raeburn   791: =item
1.54      raeburn   792: 
1.55      raeburn   793: (f) Author modifying a rights entry in a .rights file - selected course number and domain are witten to visible form elements in opener window.  Child window closes. 
1.54      raeburn   794: 
1.55      raeburn   795: =item
1.49      raeburn   796: 
1.55      raeburn   797: (g) Scantron Operator uploading a scantron file to a course - course number is written to visible form element in opener window. Child window closes.
1.30      raeburn   798: 
1.55      raeburn   799: =back
                    800:      
                    801: =cut

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