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

1.1       www         1: # The LearningOnline Network
                      2: # Pick a course
                      3: #
1.73.2.1! raeburn     4: # $Id: lonpickcourse.pm,v 1.73 2008/06/04 22:48:54 bisitz 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.68      raeburn   107:         $r->print(&create_user_javascript($type));
1.55      raeburn   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:     }
1.68      raeburn   218:     my $numcourses = keys(%courses);
1.55      raeburn   219:     $r->print('<form name="courselist" method="post" action="'.$action.'">');
1.68      raeburn   220:     if ($env{'form.form'} eq 'modifycourse') {
                    221:         if ($numcourses > 0) {
                    222:             my $cctitle = &Apache::lonnet::plaintext('cc',$type);
                    223:             my $dctitle = &Apache::lonnet::plaintext('dc');
                    224:             my $ccrolechk = ' checked="checked" ';
                    225:             my $menuchk = ' ';
                    226:             if ($env{'form.prevphase'} ne '') {
                    227:                  $ccrolechk = ' ';
                    228:                  $menuchk = ' checked="checked" ';
                    229:             }
                    230:             $r->print(
1.73      bisitz    231:                 '<table class="LC_pick_box">'.
                    232:                 '<tr class="LC_pick_box_row">'.
                    233:                 '<td class="LC_pick_box_title" rowspan="2">'.&mt('Action').'</td>'.
                    234:                 '<td class="LC_evenrow_value">'.
1.68      raeburn   235:                 '<span class="LC_nobreak"><label>'.
                    236:                 '<input type="radio" name="phase" value="ccrole"'.$ccrolechk.'/>'.
                    237:                 '&nbsp;'.&mt('Enter the course with the role of [_1].',$cctitle).
1.73      bisitz    238:                 '</label>'.('&nbsp;'x3).'</span>'.
                    239:                 '</td></tr>'.
                    240:                 '<tr class="LC_pick_box_row">'.
                    241:                 '<td class="LC_oddrow_value">'.
1.68      raeburn   242:                 '<span class="LC_nobreak"><label>'.
                    243:                 '<input type="radio" name="phase" value="menu"'.$menuchk.'/>&nbsp;'.
                    244:                 &mt('View or modify course settings which only a [_1] may modify.',$dctitle).
1.73      bisitz    245:                 '</label></span>'.
                    246:                 '</td></tr></table>'.
                    247:                 '<br />');
1.68      raeburn   248:         }
                    249:     }
1.54      raeburn   250:     my %by_descrip;
                    251:     foreach my $course (keys(%courses)) {
                    252:         my $descr;
1.64      raeburn   253:         if (ref($courses{$course}) eq 'HASH') {
1.65      raeburn   254:             $descr = $courses{$course}{'description'};
1.64      raeburn   255:         } elsif ($courses{$course} =~ m/^([^:]*):/i) {
1.54      raeburn   256:             $descr = &unescape($1);
1.34      albertel  257:         } else {
1.54      raeburn   258:             $descr = &unescape($courses{$course});
                    259:         }
                    260:         my $description = $descr;
                    261:         push (@{$by_descrip{$description}}, $course);
                    262:     }
1.71      bisitz    263:  
1.54      raeburn   264:     if ($numcourses > 1 && $multiple) {
                    265:         $r->print('<input type="button" value="check all"
                    266:                   onclick="javascript:checkAll(document.courselist.course_id)" />
                    267:                   &nbsp;&nbsp;<input type="button" value="uncheck all"
                    268:                   onclick="javascript:uncheckAll(document.courselist.course_id)" />
                    269:                   <br /><br />');
                    270:     }
1.71      bisitz    271: 
                    272:     if (%courses) {
                    273:         $r->print(&Apache::loncommon::start_data_table());
                    274:         $r->print(&Apache::loncommon::start_data_table_header_row());
                    275:         $r->print('<th>'.&mt('Select').'</th>'
                    276:                  .'<th>'.&mt('Course Description').'</th>'
                    277:                  .'<th>'.&mt('Domain').'</th>'
                    278:                  .'<th>'.&mt('Course Code').'</th>'
1.72      raeburn   279:                  .'<th>'.&mt('Owner/Co-owner(s)').'</th>'
1.71      bisitz    280:                  .'<th>'.&mt('Type').'</th>'
                    281:                  );
                    282:         $r->print(&Apache::loncommon::end_data_table_header_row());
                    283:     }
1.54      raeburn   284:     foreach my $description (sort { lc($a) cmp lc($b) } (keys(%by_descrip))) {
                    285:         foreach my $course (@{$by_descrip{$description}}) {
1.72      raeburn   286:             $r->print(&Apache::loncommon::start_data_table_row());
1.54      raeburn   287:             my $cleandesc=&HTML::Entities::encode($description,'<>&"');
                    288:             $cleandesc=~s/'/\\'/g;
                    289:             my ($cdom,$cnum)=split(/\_/,$course);
1.64      raeburn   290:             my ($descr,$instcode,$ttype,@owners);
                    291:             if (ref($courses{$course}) eq 'HASH') {
                    292:                 $descr = $courses{$course}{'description'};
1.65      raeburn   293:                 $instcode =  $courses{$course}{'inst_code'};
1.64      raeburn   294:                 $ttype =  $courses{$course}{'type'};
                    295:                 push(@owners,&unescape($courses{$course}{'owner'}));
                    296:                 if (ref($courses{$course}{'co-owners'}) eq 'ARRAY') {
                    297:                     foreach my $item (@{$courses{$course}{'co-owners'}}) {
                    298:                         push(@owners,&unescape($item));
                    299:                     }
                    300:                 }
                    301:             } else {
                    302:                 my $singleowner; 
                    303:                 ($descr,$instcode,$singleowner,$ttype)=split(/:/,$courses{$course});
                    304:                 push(@owners,&unescape($singleowner));
                    305:             }
1.72      raeburn   306:             my $ownerstr = join(', ',@owners);
1.71      bisitz    307:             $r->print('<td>'.&course_chooser($multiple,$cdom,$cnum,$cleandesc).'</td>');
                    308:             $r->print('<td>'.$description.'</td>');
                    309:             $r->print('<td>');
                    310:             $r->print(&Apache::lonnet::domain($cdom,'description')?
                    311:                       $cdom.' ('.&Apache::lonnet::domain($cdom,'description').')':$cdom);
                    312:             $r->print('</td>');
                    313:             $r->print('<td>');
1.64      raeburn   314:             if ($instcode ne '') {
1.71      bisitz    315:                 $r->print(&unescape($instcode));
                    316:             } else {
                    317:                 $r->print('&nbsp;');
1.54      raeburn   318:             }
1.71      bisitz    319:             $r->print('</td>');
1.72      raeburn   320:             $r->print('<td>'.$ownerstr.'</td>');
1.71      bisitz    321:             $r->print('<td>');
1.64      raeburn   322:             if ($ttype ne '') {
1.71      bisitz    323:                 $r->print(&mt(&unescape($ttype)));
                    324:             } else {
                    325:                 $r->print('&nbsp;');
1.23      raeburn   326:             }
1.71      bisitz    327:             $r->print('</td>');
1.54      raeburn   328:             if ($multiple) { $r->print("</label>\n"); }
1.72      raeburn   329:             $r->print(&Apache::loncommon::end_data_table_row());
1.71      bisitz    330:             # $r->print("<br />\n");
1.19      raeburn   331:         }
                    332:     }
1.72      raeburn   333:     if (%courses) {
                    334:         $r->print(&Apache::loncommon::end_data_table());
                    335:     }
1.71      bisitz    336: 
1.54      raeburn   337:     if (!%courses) {
                    338:         $r->print(&mt('None found'));
                    339:     } elsif ($multiple) {
1.57      raeburn   340:         $r->print('<input type="button" value="Submit" onClick="gochoose('."'','','')".'" />');
1.54      raeburn   341:     }
                    342:     $r->print('<input type="hidden" name="form" value="'.$env{'form.form'}.'" />'.
                    343:               "\n".'<input type="hidden" name="pickedcourse" value="" />'."\n".
                    344:               '<input type="hidden" name="type" value="'.$type.'" />'."\n");
                    345:     if ((exists($env{'form.roleelement'})) && ($env{'form.form'} eq 'rolechoice')) {
                    346:         $r->print('<input type="hidden" name="roleelement" value="'.
                    347:                   $env{'form.roleelement'}.'" />'."\n");
                    348:     }
1.55      raeburn   349:     if ($env{'form.form'} eq 'portform') {
                    350:         $r->print('<input type="hidden" name="cnum" value="" />');
                    351:         $r->print('<input type="hidden" name="cdom" value="" />');
                    352:         $r->print('<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />');
                    353:         $r->print('<input type="hidden" name="action" value="rolepicker" />');
1.57      raeburn   354:     } elsif ($env{'form.form'} eq 'modifycourse') {
                    355:         $r->print(&Apache::lonhtmlcommon::echo_form_input(['phase','pickedcourse','type','form']));
                    356:     } else {
                    357:         $r->print('<input type="hidden" name="cnumelement" value="'.
                    358:                   $env{'form.cnumelement'}.'" />'."\n".  
                    359:                   '<input type="hidden" name="cdomelement" value="'.
                    360:                   $env{'form.cdomelement'}.'" />'."\n");
1.55      raeburn   361:     }
1.54      raeburn   362:     $r->print("</form>\n");
                    363:     return;
                    364: }
                    365: 
                    366: 
                    367: sub multiples_tag {
1.55      raeburn   368:     my $jscript = &Apache::loncommon::check_uncheck_jscript();
                    369:     my $multelement = '<input type="hidden" name="multiple" value="1" />';
                    370:     return ($jscript,$multelement);
1.1       www       371: }
1.30      raeburn   372: 
1.54      raeburn   373: sub build_filters {
1.57      raeburn   374:     my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
                    375:         $caller) = @_;
1.55      raeburn   376:     my $list;
1.57      raeburn   377:     my $formname;
                    378:     if (defined($env{'form.form'})) {
                    379:          $formname = $env{'form.form'};
                    380:     } else {
                    381:          $formname = $caller;
                    382:     }
1.55      raeburn   383:     my ($domainselectform,$sincefilterform,$ownerdomselectform,
1.54      raeburn   384:         $instcodeform,$typeselectform);
1.55      raeburn   385:     foreach my $item (@{$filterlist}) {
1.54      raeburn   386:         $filter->{$item} = $env{'form.'.$item};
                    387:         if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
1.61      albertel  388: 	    if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
                    389: 		$filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                    390: 	    } elsif ($item eq 'coursefilter') {
                    391: 		$filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                    392: 	    } elsif ($item eq 'ownerfilter') {
                    393: 		$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                    394: 	    } else {
                    395: 		$filter->{$item} =~ s/\W//g;
                    396: 	    }
1.54      raeburn   397:             if (!$filter->{$item}) {
                    398:                 $filter->{$item} = '';
                    399:             }
                    400:         }
                    401:         if ($item eq 'domainfilter') {
1.63      albertel  402: 	    my $allow_blank = 1;
                    403: 	    if ($formname eq 'portform') {
                    404: 		$filter->{$item} ||= $env{'user.domain'};
                    405: 		$allow_blank=0;
1.67      raeburn   406: 	    } elsif ($formname eq 'studentform') {
                    407:                 $filter->{$item} ||= $env{'request.role.domain'};
                    408:                 $allow_blank=0;
                    409:             }
1.54      raeburn   410:             $domainselectform =
1.63      albertel  411: 		&Apache::loncommon::select_dom_form($filter->{$item},
                    412: 						    'domainfilter',
                    413: 						    $allow_blank);
1.54      raeburn   414:         } elsif ($item eq 'ownerdomfilter') {
                    415:             $ownerdomselectform =
                    416:      &Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
                    417:         } else {
                    418:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                    419:         }
                    420:     }
                    421: 
                    422:     # last course activity filter and selection
                    423:     $filter->{'sincefilter'} = $env{'form.sincefilter'};
                    424:     $filter->{'sincefilter'} =~ s/[^\d-]//g;
                    425:     if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
                    426:     $sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
                    427:        'sincefilter',('-1'=>'',
                    428:                       '86400' => 'today',
                    429:                       '604800' => 'last week',
                    430:                       '2592000' => 'last month',
                    431:                       '7776000' => 'last three months',
                    432:                       '15552000' => 'last six months',
                    433:                       '31104000' => 'last year',
                    434:                       'select_form_order' =>
                    435:                       ['-1','86400','604800','2592000','7776000',
                    436:                       '15552000','31104000']));
                    437: 
                    438:     my %lt = (
                    439:               'cac' => &mt('[_1] Activity',$type),
                    440:               'cde' => &mt('[_1] Description',$type),
                    441:               'cdo' => &mt('[_1] Domain',$type),
                    442:               'cin' => &mt('Course Institutional Code'),
                    443:               'cow' => &mt("[_1] Owner's Username",$type),
                    444:               'cod' => &mt("[_1] Owner's Domain", $type),
                    445:               'cog' => &mt('Course Type')
                    446:              );
1.49      raeburn   447: 
1.65      raeburn   448:     $typeselectform =  '<select name="type" size="1">'."\n";
1.54      raeburn   449:     if ($type eq 'Course') {
1.57      raeburn   450:         $instcodeform = 
                    451:                 '<input type="text" name="instcodefilter" size="10" value="'.
                    452:                 $list->{'instcodefilter'}.'" />';
1.54      raeburn   453:     }
1.57      raeburn   454:     foreach my $posstype ('Course','Non-standard Course') {
1.72      raeburn   455:         $typeselectform.='<option value="'.$posstype.'"'.
1.73      bisitz    456:             ($posstype eq $type ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
1.54      raeburn   457:     }
                    458:     $typeselectform.="</select>";
1.57      raeburn   459:     my $output = qq|
                    460: <form method="post" name="filterpicker" action="$action">
                    461: <input type="hidden" name="form" value="$formname" />
                    462: |;
                    463:     if ($formname eq 'modifycourse') {
1.68      raeburn   464:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                    465:                    '<input type="hidden" name="prevphase" value="'.
                    466:                    $env{'form.prevphase'}.'" />'."\n";
                    467:     } else {
1.57      raeburn   468:         my $name_input;
                    469:         if ($env{'form.cnameelement'} ne '') {
                    470:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                    471:                           $env{'form.cnameelement'}.'" />';
                    472:         }
                    473:         $output .= qq|
1.27      albertel  474: <input type="hidden" name="cnumelement" value="$env{'form.cnumelement'}" />
                    475: <input type="hidden" name="cdomelement" value="$env{'form.cdomelement'}" />
1.13      albertel  476: $name_input
1.18      raeburn   477: $roleelement
1.35      raeburn   478: $multelement
1.57      raeburn   479: |;
1.59      raeburn   480:         if ($formname eq 'portform') {
                    481:             $output .= '<input type="hidden" name="setroles" value="'.$env{'form.setroles'}.'" />';
                    482:         }
1.57      raeburn   483:     }
                    484:     if ($sincefilterform) { 
                    485:         $output .= $lt{'cac'}.': '.$sincefilterform.'<br />'."\n";
                    486:     }
                    487:     if ($domainselectform) {
                    488:         $output .= $lt{'cdo'}.': '.$domainselectform.'<br />'."\n";
                    489:     }
1.73.2.1! raeburn   490: #    if ($typeselectform) {
        !           491: #        $output .= $lt{'cog'}.': '.$typeselectform.'<br />'."\n";
        !           492: #    }
1.57      raeburn   493:     if ($instcodeform) {
                    494:         $output .= $lt{'cin'}.': '.$instcodeform.'<br />'."\n";
                    495:     }
                    496:     if (exists($filter->{'ownerfilter'})) {
                    497:         $output .= $lt{'cow'}.': '.
                    498:                    '<input type="text" name="ownerfilter" size="10" value="'.
                    499:                    $list->{'ownerfilter'}.'" /><br />'."\n".
                    500:                    $lt{'cod'}.': '.$ownerdomselectform.'<br />'."\n";
                    501:     }
                    502:     if (exists($filter->{'coursefilter'})) {
                    503:         $output .= &mt('LON-CAPA course ID').': '.
                    504:                    '<input type="text" name="coursefilter" size="25" value="'.
                    505:                     $list->{'coursefilter'}.'" /><br />';
                    506:     }
                    507:     if (exists($filter->{'descriptfilter'})) {
                    508:         $output .=$lt{'cde'}.': '.
                    509:                   '<input type="text" name="descriptfilter" size="40" value="'.
                    510:                   $list->{'descriptfilter'}.'" />'."\n";
                    511:     }
1.70      raeburn   512:     $output .= '<p><input type="submit" name="gosearch" value="'. 
                    513:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
1.54      raeburn   514:     return $output; 
                    515: }
                    516: 
                    517: sub search_courses {
                    518:     my ($r,$type,$onlyown,$filter) = @_;
                    519:     my %courses;
                    520:     if (!$onlyown) {
1.71      bisitz    521:         $r->print(&mt('Searching ...').'<br />&nbsp;<br />');
1.6       www       522:         $r->rflush();
1.54      raeburn   523:         if (($filter->{'ownerfilter'} ne '') ||
                    524:             ($filter->{'ownerdomfilter'} ne '')) {
                    525:             $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                    526:                                            $filter->{'ownerdomfilter'};
                    527:         }
                    528:         foreach my $item ('descriptfilter','instcodefilter','coursefilter',
                    529:                           'combownerfilter') {
                    530:             if (!$filter->{$item}) {
                    531:                 $filter->{$item}='.';
                    532:             }
1.52      raeburn   533:         }
                    534:         if ($type eq '') { $type = '.'; }
1.54      raeburn   535:         my $timefilter = 
                    536:            ($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
                    537:         %courses = 
                    538:             &Apache::lonnet::courseiddump($filter->{'domainfilter'},
                    539:                                           $filter->{'descriptfilter'},
                    540:                                           $timefilter,
                    541:                                           $filter->{'instcodefilter'},
                    542:                                           $filter->{'combownerfilter'},
                    543:                                           $filter->{'coursefilter'},
                    544:                                           undef,undef,$type);
                    545:     } else {
                    546:         $r->print('<br />');
1.60      raeburn   547:         my %coursehash = &Apache::loncommon::findallcourses(); 
                    548:         foreach my $cid (sort(keys(%coursehash))) {
1.65      raeburn   549:             $courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
1.36      raeburn   550:         }
1.2       www       551:     }
1.54      raeburn   552:     return %courses;
1.18      raeburn   553: }
1.1       www       554: 
1.30      raeburn   555: sub course_chooser {
1.35      raeburn   556:     my ($multiple,$cdom,$cnum,$cleandesc) = @_;
1.30      raeburn   557:     my $output; 
1.35      raeburn   558:     if ($multiple) {
1.32      albertel  559:         $output = '<label><input type="checkbox" name="course_id" value="'.$cdom.'_'.$cnum.'" />'."\n";
1.30      raeburn   560:     } else {
1.71      bisitz    561:         $output = '<input type="button" value="'.&mt('Select').'" onClick="gochoose('.
1.30      raeburn   562:                   "'".$cnum."','".$cdom."','".$cleandesc."')".'" />'."\n";
                    563:     }
                    564:     return $output;
1.49      raeburn   565: }
                    566: 
1.55      raeburn   567: sub gochoose_javascript {
1.57      raeburn   568:     my ($type,$multiple,$autosubmit,$lastaction) = @_;
1.55      raeburn   569:     my %elements = (
                    570:                      'Course' => {
                    571:                                  name  => 'coursepick',
                    572:                                  total => 'coursetotal',
                    573:                                  list  => 'courselist',
                    574:                                  },
1.57      raeburn   575:                      'Non-standard Course' => {
1.55      raeburn   576:                                  name  => 'grouppick',
                    577:                                  total => 'grouptotal',
                    578:                                  list  => 'grouplist',
                    579:                               },
                    580:                     );
1.57      raeburn   581:     my $output .= qq|
1.55      raeburn   582: <script type="text/javascript">
1.57      raeburn   583: function gochoose(cname,cdom,cdesc) {
1.55      raeburn   584:     var openerForm = "$env{'form.form'}";
                    585:     courseCount = 0;
                    586:     var courses = '';
1.57      raeburn   587: |;
                    588:     if ($multiple) {
                    589:         $output .= <<"ENDSCRIPT";
                    590:     courseCount = 0;
                    591:     var courses = '';
                    592:     if (typeof(document.courselist.course_id.length) == 'undefined') {
                    593:         // only 1 course checkbox was created
                    594:         if (document.courselist.course_id.checked) {
                    595:             courses = courses + document.courselist.course_id.value + "&&";
                    596:             courseCount ++;
                    597:         }
                    598:     } else {
                    599:         for (var j=0; j<document.courselist.course_id.length; j++) {
                    600:             if (document.courselist.course_id[j].checked) {
                    601:                 courses = courses + document.courselist.course_id[j].value + "&&";
1.55      raeburn   602:                 courseCount ++;
                    603:             }
1.57      raeburn   604:         }
                    605:     }
                    606:     opener.document.$env{'form.form'}.$elements{$type}{'total'}.value = courseCount;
                    607:     if (typeof(opener.document.$env{'form.form'}.$elements{$type}{'name'}.length) ==
                    608:         'undefined') {
                    609:         if (opener.document.$env{'form.form'}.$elements{$type}{'name'}.value == 'specific') {
                    610:             opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = true;
1.55      raeburn   611:         } else {
1.57      raeburn   612:             opener.document.$env{'form.form'}.$elements{$type}{'name'}.checked = false;
1.55      raeburn   613:         }
1.57      raeburn   614:     } else {
                    615:         for (var j=0; j<opener.document.$env{'form.form'}.$elements{$type}{'name'}.length; j++) {
                    616:             if (opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].value == 'specific') {
                    617:                 opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = true;
1.55      raeburn   618:             } else {
1.57      raeburn   619:                 opener.document.$env{'form.form'}.$elements{$type}{'name'}\[j].checked = false;
1.54      raeburn   620:             }
1.55      raeburn   621:         }
1.57      raeburn   622:     }
                    623:     if (courseCount > 0) {
                    624:         courses = courses.substr(0,courses.length-2);
                    625:         opener.document.$env{'form.form'}.$elements{$type}{'list'}.value = courses;
                    626:     }
                    627: ENDSCRIPT
                    628:     } else {
                    629:         my $name_code;
                    630:         if ($env{'form.cnameelement'} ne '') {
                    631:             $name_code = 'opener.document.'.$env{'form.form'}.'.'.
                    632:                           $env{'form.cnameelement'}.'.value=cdesc;';
1.55      raeburn   633:         }
1.57      raeburn   634:         $output .= qq|
1.55      raeburn   635:         $name_code
                    636:         opener.document.$env{'form.form'}.$env{'form.cnumelement'}.value=cname;
                    637:         var slct=opener.document.$env{'form.form'}.$env{'form.cdomelement'};
                    638:         if (slct.options == undefined) {
                    639:             opener.document.$env{'form.form'}.$env{'form.cdomelement'}.value=cdom;
                    640:         }
                    641:         else {
                    642:             var i;
                    643:             for (i=0;i<slct.length;i++) {
                    644:                 if (slct.options[i].value==cdom) { slct.selectedIndex=i; }
1.54      raeburn   645:             }
                    646:         }
1.57      raeburn   647: |;
1.54      raeburn   648:     }
1.57      raeburn   649:     $output .= qq|
1.55      raeburn   650:     if (openerForm == 'portform') {
                    651:         document.courselist.cnum.value = cname;
                    652:         document.courselist.cdom.value = cdom;
                    653:     }
                    654:     $autosubmit
                    655:     $lastaction
1.54      raeburn   656: }
1.55      raeburn   657: </script>
1.57      raeburn   658: |;
1.55      raeburn   659:     return $output;
1.54      raeburn   660: }
                    661: 
1.55      raeburn   662: 1;
                    663: __END__
                    664: 
                    665: =pod
                    666: 
                    667: =head1 NAME
                    668: 
                    669: Apache::lonpickcourse - Search for course(s) based on user-specified criteria.   
                    670: 
                    671: =head1 SYNOPSIS
                    672: 
                    673: Invoked by other LON-CAPA modules, when course(s) need to be selected by the user. 
                    674: 
                    675: =head1 OVERVIEW
                    676: 
                    677: Two screens are typically displayed to the user.  The first is a set of criteria which are used to constrain the search for courses.
                    678: 
                    679: =head2 Search Criteria (Screen One)
                    680: 
                    681: =head3 Criteria:
                    682: 
                    683: =over 4
                    684: 
                    685: =item *
                    686: Course Activity - how recently was course last visited by anyone.
                    687: 
                    688: =item *
                    689: Course Domain - the domain of the course
                    690: 
                    691: =item *
1.57      raeburn   692: Course Type - Course or Non-standard Course
1.55      raeburn   693: 
                    694: =item *
                    695: Course Institutional Code - the institutional identifier assigned to the course
                    696: 
                    697: =item * 
                    698: Course Owner's Username - the username of the owner of the course (assigned by the Domain Coordinator and/or when the course was created).
                    699: 
                    700: =item *
                    701: Course Owner's Domain - the domain of the owner of the course
                    702: 
                    703: =item * 
                    704: Course Description - text which appears in the Course Description (or title), as set in the Course Parameters.
                    705: 
                    706: =item *
                    707: 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).
                    708: 
                    709: =back
                    710: 
                    711: 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'}).
                    712: 
                    713: =head2 Course Display (Screen Two)
                    714: 
                    715: 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:
                    716: 
                    717: =over 4
                    718: 
                    719: =item *
                    720: Course description
                    721: 
                    722: =item *
                    723: Domain description of course domain
                    724: 
                    725: =item *
                    726: Course institutional code
                    727: 
                    728: =item * 
                    729: Course owner (username:domain)   
                    730:  
                    731: =back
                    732: 
                    733: 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.
                    734: 
                    735: 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.
                    736: 
                    737: =head1 SUBROUTINES
                    738: 
                    739: =over 4
                    740: 
                    741: =item *
                    742: X<create_user_javascript()>
                    743: B<create_user_javascript($type)>:
                    744: 
1.57      raeburn   745: Input: 1 - $type  - the course type - Course or Non-standard Course
1.55      raeburn   746: 
                    747: Output: 1 - $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags 
                    748: 
                    749: Side Effects: None 
                    750: 
                    751: 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.
                    752: 
                    753: 
                    754: =item *
                    755: X<display_matched_courses()>
1.57      raeburn   756: B<display_matched_courses($r,$type,$multiple,$action,%courses)>:
1.55      raeburn   757: 
1.57      raeburn   758: Input: 5 - request object, course type, multiple (0 or 1), form action; hash of courses.
1.55      raeburn   759: 
                    760: Output: 0
                    761: 
                    762: 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.
                    763: 
                    764: =item *
                    765: X<multiples_tag()>
                    766: B<multiples_tag()>:
                    767: 
                    768: 
                    769: Input: 0
                    770: 
                    771: Output: 2 - $jscript - javascript for check all/uncheck all checkboxes; $multelement - hidden form element with multiple set to 1.
                    772: 
                    773: Side Effects: None
                    774: 
                    775: =item *
                    776: X<build_filters()>
1.57      raeburn   777: B<build_filters($filterlist,$type,$roleelement,$multelement,$filter,$action)>:
1.55      raeburn   778: 
                    779: 
1.57      raeburn   780: Input: 6 - anonymous array of search criteria; course type; $roleelement ; $multelement ; anonymous hash of criteria and their values; form action.
1.55      raeburn   781: 
                    782: Output: 1 - $output - HTML for display of search criteria, and hidden form elements. 
                    783: 
                    784: Side Effects: None
                    785: 
                    786: =item *
                    787: X<search_courses()>
                    788: B<search_courses($r,$type,$onlyown,$filter)>:
                    789: 
                    790: 
                    791: 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.
                    792: 
                    793: Output: 1 - %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                    794: 
                    795: Side Effects: None
                    796: 
                    797: 
                    798: =item *
                    799: X<course_chooser()>
                    800: B<course_chooser($multiple,$cdom,$cnum,$cleandesc)>:
                    801: 
                    802: Input: 4 - single (0) or multiple (1) courses; course domain, course number; course description. 
                    803: 
                    804: Output: 1 - HTML for either checkbox (multiple=1) or select button (multiple=0) for user yo indicate course selection.
                    805: 
                    806: Side Effects: None
                    807: 
                    808: 
                    809: =item *
                    810: X<gochoose_javascript()>
1.57      raeburn   811: B<gochoose_javascript($type,$multiple,$autosubmit,$lastaction)>:
1.55      raeburn   812: 
1.66      raeburn   813: 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   814: 
                    815: Output: 1  $output - javascript wrapped in E<lt>scriptE<gt>E<lt>/scriptE<gt> tags
                    816: 
                    817: Side Effects: None
                    818: 
                    819: javascript functions used when user selects a course(s). Different behavior depending on context:
                    820: 
                    821: =back
                    822: 
                    823: =over 8
                    824: 
                    825: =item
                    826: 
                    827: (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.
                    828: 
                    829: =item
                    830: 
                    831: (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.
                    832: 
                    833: =item
                    834: 
                    835: (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.
                    836: 
                    837: =item
1.54      raeburn   838: 
1.55      raeburn   839: (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   840: 
1.55      raeburn   841: =item
1.54      raeburn   842: 
1.55      raeburn   843: (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   844: 
1.55      raeburn   845: =item
1.54      raeburn   846: 
1.55      raeburn   847: (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   848: 
1.55      raeburn   849: =item
1.49      raeburn   850: 
1.55      raeburn   851: (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   852: 
1.55      raeburn   853: =back
                    854:      
                    855: =cut

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