--- loncom/interface/coursecatalog.pm 2008/05/29 19:58:32 1.30 +++ loncom/interface/coursecatalog.pm 2008/07/15 19:43:15 1.40 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler for displaying the course catalog interface # -# $Id: coursecatalog.pm,v 1.30 2008/05/29 19:58:32 raeburn Exp $ +# $Id: coursecatalog.pm,v 1.40 2008/07/15 19:43:15 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -53,7 +53,8 @@ sub handler { } &Apache::lonacc::get_posted_cgi($r); &Apache::lonlocal::get_language_handle($r); - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sortby']); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sortby','showdom']); my $codedom = &Apache::lonnet::default_login_domain(); @@ -71,19 +72,48 @@ sub handler { } my $domdesc = &Apache::lonnet::domain($codedom,'description'); &Apache::lonhtmlcommon::clear_breadcrumbs(); + + my %domconfig = + &Apache::lonnet::get_dom('configuration',['coursecategories'],$codedom); + my (@cats,@trails,%allitems,%idx,@jsarray,%subcathash,$cathash); + if (ref($domconfig{'coursecategories'}) eq 'HASH') { + $cathash = $domconfig{'coursecategories'}{'cats'}; + } else { + $cathash = {}; + } + my $subcats; + if ($env{'form.withsubcats'}) { + $subcats = \%subcathash; + } + &Apache::loncommon::extract_categories($cathash,\@cats,\@trails,\%allitems, + \%idx,\@jsarray,$subcats); if ($env{'form.coursenum'} ne '' && &user_is_known()) { - &course_details($r,$codedom,$formname,$domdesc); + &course_details($r,$codedom,$formname,$domdesc,\@trails,\%allitems); } else { - my $catlinks = &category_breadcrumbs($codedom); + my ($catlinks,$has_subcats) = &category_breadcrumbs($codedom,@cats); my $catjs = <<"ENDSCRIPT"; function setCatDepth(depth) { document.coursecats.catalog_maxdepth.value = depth; + if (depth == '') { + document.coursecats.currcat_0.value = ''; + } document.coursecats.submit(); return; } +function changeSort(caller) { + document.$formname.sortby.value = caller; + document.$formname.submit(); +} + +function setCourseId(caller) { + document.$formname.coursenum.value = caller; + document.$formname.submit(); +} + ENDSCRIPT + $catjs .= &syllabus_javascript(); my $numtitles; if ($env{'form.currcat_0'} eq 'instcode::0') { $numtitles = &instcode_course_selector($r,$codedom,$formname,$domdesc, @@ -96,21 +126,41 @@ ENDSCRIPT $catjs = ''; &cat_header($r,$codedom,$catjs,\%add_entries,$catlinks); if ($env{'form.currcat_0'} ne '') { - $r->print(&print_course_listing($codedom)); + $r->print('
'. + &additional_filters($codedom,$has_subcats)."\n"); + my ($currdepth,$deeper) = &get_depth_values(); + $r->print(''."\n"); + for (my $i=0; $i<$deeper; $i++) { + $r->print(''."\n"); + } + $r->print(''."\n". + ''."\n". + ''."\n". + ''. + '


'); + } + if ($env{'form.state'} eq 'listing') { + $r->print(&print_course_listing($codedom,undef,\@trails,\%allitems,$subcats)); } } } - $r->print(&Apache::loncommon::end_page()); + $r->print('
'.&Apache::loncommon::end_page()); return OK; } sub course_details { - my ($r,$codedom,$formname,$domdesc) = @_; + my ($r,$codedom,$formname,$domdesc,$trails,$allitems) = @_; my $output; my %add_entries = (topmargin => "0", marginheight => "0",); + my $js = ''."\n"; my $start_page = - &Apache::loncommon::start_page('Course Catalog','', + &Apache::loncommon::start_page('Course Catalog',$js, { 'add_entries' => \%add_entries, 'no_inline_link' => 1,}); @@ -126,15 +176,33 @@ sub course_details { {text=>"Course details"}); $r->print(&Apache::lonhtmlcommon::breadcrumbs('Course Details')); $r->print('
'.&mt('Detailed course information:').'

'. - '
'. - &print_course_listing($codedom).'

'); - $r->print(''. + &print_course_listing($codedom,undef,$trails,$allitems). + '

'); + $r->print(''. + '
'. &mt('Back to course listing').''. - ''. - '
'); + &Apache::lonhtmlcommon::echo_form_input(['coursenum','catalogfilter','showdetails']).''); + return; +} + +sub syllabus_javascript { + return <<"END"; + +function ToSyllabus(cdom,cnum) { + if (cdom == '' || cdom == null) { + return; + } + if (cnum == '' || cnum == null) { + return; + } + document.syllabuslaunch.action = "/public/"+cdom+"/"+cnum+"/syllabus"; + document.syllabuslaunch.submit(); +} + +END } + sub instcode_course_selector { my ($r,$codedom,$formname,$domdesc,$catlinks,$catjs) = @_; my %coursecodes = (); @@ -212,17 +280,6 @@ function setElements() { $jscript .= '}'; } } - if ($env{'form.state'} eq 'listing') { - $jscript .= qq| -function changeSort(caller) { - document.$formname.sortby.value = caller; - document.$formname.submit(); -} -function setCourseId(caller) { - document.$formname.coursenum.value = caller; - document.$formname.submit(); -}\n|; - } } $js = ''; @@ -232,11 +289,12 @@ function setCourseId(caller) { &cat_header($r,$codedom,$js,\%add_entries,$catlinks,$numtitles); my $cat_maxdepth = $env{'form.catalog_maxdepth'}; $r->print('
'. - ''. - ''. - ''); + ''."\n". + ''."\n". + ''. + &additional_filters($codedom)); if ($numtitles > 0) { - $r->print('
'.&mt('Choose which course(s) to list.').'
'); + $r->print(''.&mt('Choose which course(s) to list.').'
'); $r->print(''); for (my $k=0; $k<$lasttitle-1; $k++) { my (@items,@unsorted); @@ -267,37 +325,21 @@ function setCourseId(caller) { ''."\n". - '' - ); - my $show_selfenroll_status; - if ($env{'form.showselfenroll'}) { - $show_selfenroll_status = 'checked="checked" '; - } - if (&user_is_dc($codedom)) { - my $showdetails_status; - if ($env{'form.showdetails'}) { - $showdetails_status = 'checked="checked" '; - } - $r->print(''); - } else { - $r->print(''); - } - $r->print('


'); + ''."\n"); if ($numtitles > 4) { $r->print('

'.$codetitles[$numtitles-1].'
'."\n". '
'."\n"); } $r->print('
'); } - $r->print(''); - if ($numtitles > 0) { - $r->print(''); - } - $r->print('
'); - if (($numtitles > 0) && ($env{'form.state'} eq 'listing')) { - $r->print('
'); - } + $r->print(''."\n". + ''."\n". + ''."\n". + ''."\n". + ''. + '

'); } else { &cat_header($r,$codedom,$js,\%add_entries,$catlinks,$numtitles); my $cat_maxdepth = $env{'form.catalog_maxdepth'}; @@ -335,36 +377,21 @@ sub cat_header { text=>"Select courses"}); $r->print(&Apache::lonhtmlcommon::breadcrumbs('Select courses')); } - $r->print(''. - ''. - '
'.&mt('Domain:').''. + $r->print(''. + ''. + ' 
'.&mt('Domain:').''. &Apache::loncommon::select_dom_form($codedom,'showdom','',1). - ' 
'. '
'. - $catlinks.'
'); + ''.$catlinks.'
'); return; } sub category_breadcrumbs { - my ($dom) = @_; - my %domconfig = - &Apache::lonnet::get_dom('configuration',['coursecategories'],$dom); - my (@cats,@trails,%allitems,%idx,@jsarray); - &Apache::loncommon::extract_categories($domconfig{'coursecategories'},\@cats,\@trails, - \%allitems,\%idx,\@jsarray); - my $currdepth = 0; - my $deeper = 0; - my $currcat_str; - if ($env{'form.catalog_maxdepth'} ne '') { - $currdepth = $env{'form.catalog_maxdepth'}; - if ($env{'form.currcat_'.$currdepth} eq '') { - $deeper = $currdepth; - } else { - $deeper = $currdepth + 1; - } - } - $currcat_str = ''; + my ($dom,@cats) = @_; + my ($currdepth,$deeper) = &get_depth_values(); + my $currcat_str = ''; my $catlinks = ''.&mt('Catalog:').''; + my $has_subcats; for (my $i=0; $i<$deeper; $i++) { $currcat_str .= ''; my ($cattitle,$shallower); @@ -382,25 +409,22 @@ sub category_breadcrumbs { if (ref($cats[0]) eq 'ARRAY') { if ((@{$cats[0]} == 1) && ($cats[0][0] eq 'instcode')) { $catlinks .= &mt('Official courses (with institutional codes)'). - ''; + ''; $env{'form.currcat_0'} = 'instcode::0'; } else { + $has_subcats = 1; $catlinks .= ''."\n". - ' '; + ' '; } } else { $catlinks .= &mt('Official courses (with institutional codes)'). - ''; + ''; $env{'form.currcat_0'} = 'instcode::0'; } } else { @@ -431,19 +455,95 @@ sub category_breadcrumbs { } $catlinks .= '
'.$currcat; if (ref($cats[$deeper]{$cat}) eq 'ARRAY') { + $has_subcats = 1; + my $selstr; $catlinks .= ': '."\n". - ' '; + ' '; } } $catlinks .= $currcat_str.'
'; - return $catlinks; + return ($catlinks,$has_subcats); +} + +sub get_depth_values { + my $currdepth = 0; + my $deeper = 0; + if ($env{'form.catalog_maxdepth'} ne '') { + $currdepth = $env{'form.catalog_maxdepth'}; + if ($env{'form.currcat_'.$currdepth} eq '') { + $deeper = $currdepth; + } else { + $deeper = $currdepth + 1; + } + } + return ($currdepth,$deeper); +} + +sub additional_filters { + my ($codedom,$has_subcats) = @_; + my $output = ''; + if (($env{'form.currcat_0'} ne 'instcode::0') && + ($env{'form.currcat_0'} ne '') && ($has_subcats)) { + my $include_subcat_status; + if ($env{'form.withsubcats'}) { + $include_subcat_status = 'checked="checked" '; + } + my $counter = $env{'form.catalog_maxdepth'}; + if ($counter > 0) { + if ($env{'form.state'} eq 'listing') { + $counter --; + } elsif ($env{'form.currcat_'.$counter} eq '') { + $counter --; + } + } + my ($catname) = split(/:/,$env{'form.currcat_'.$counter}); + if ($catname ne '') { + $output .= ''; + } + } + my $show_selfenroll_status; + if ($env{'form.showselfenroll'}) { + $show_selfenroll_status = 'checked="checked" '; + } + $output .= ''; + if (&user_is_dc($codedom)) { + my $showdetails_status; + if ($env{'form.showdetails'}) { + $showdetails_status = 'checked="checked" '; + } + my $showhidden_status; + if ($env{'form.showhidden'}) { + $showhidden_status = 'checked="checked" '; + } + my $dc_title = &Apache::lonnet::plaintext('dc'); + $output .= ''; + } + $output .= '
'. + '
'."\n". + ''."\n".'
'. + ''."\n".'

'; + return $output; } sub user_is_dc { @@ -566,14 +666,19 @@ sub search_official_courselist { $instcode = '.'; } } - my %courses = &Apache::lonnet::courseiddump($domain,'.',1,$instcode,'.','.', - undef,undef,'Course',1, - $env{'form.showselfenroll'}); + my $showhidden; + if (&user_is_dc($domain)) { + $showhidden = $env{'form.showhidden'}; + } + my %courses = + &Apache::lonnet::courseiddump($domain,'.',1,$instcode,'.','.',undef,undef, + 'Course',1,$env{'form.showselfenroll'},undef, + $showhidden,'coursecatalog'); return %courses; } sub search_courselist { - my ($domain) = @_; + my ($domain,$subcats) = @_; my $cat_maxdepth = $env{'form.catalog_maxdepth'}; my $filter = $env{'form.currcat_'.$cat_maxdepth}; if (($filter eq '') && ($cat_maxdepth > 0)) { @@ -581,16 +686,38 @@ sub search_courselist { $filter = $env{'form.currcat_'.$shallower}; } my %courses; + my $filterstr; if ($filter ne '') { - %courses = &Apache::lonnet::courseiddump($domain,'.',1,'.','.','.', - undef,undef,'Course',1, - $env{'form.showselfenroll'},$filter); + if ($env{'form.withsubcats'}) { + if (ref($subcats) eq 'HASH') { + if (ref($subcats->{$filter}) eq 'ARRAY') { + $filterstr = join('&',@{$subcats->{$filter}}); + if ($filterstr ne '') { + $filterstr = $filter.'&'.$filterstr; + } + } else { + $filterstr = $filter; + } + } else { + $filterstr = $filter; + } + } else { + $filterstr = $filter; + } + my $showhidden; + if (&user_is_dc($domain)) { + $showhidden = $env{'form.showhidden'}; + } + %courses = + &Apache::lonnet::courseiddump($domain,'.',1,'.','.','.',undef,undef, + '.',1,$env{'form.showselfenroll'}, + $filterstr,$showhidden,'coursecatalog'); } return %courses; } sub print_course_listing { - my ($domain,$numtitles) = @_; + my ($domain,$numtitles,$trails,$allitems,$subcats) = @_; my $output; my %courses; my $knownuser = &user_is_known(); @@ -603,7 +730,7 @@ sub print_course_listing { if ($env{'form.coursenum'} ne '') { %courses = &Apache::lonnet::courseiddump($domain,'.',1,'.','.', $env{'form.coursenum'}, - undef,undef,'Course',1); + undef,undef,'.',1); if (keys(%courses) == 0) { $output .= &mt('The courseID provided does not match a course in this domain.'); return $output; @@ -612,35 +739,47 @@ sub print_course_listing { if ($env{'form.currcat_0'} eq 'instcode::0') { %courses = &search_official_courselist($domain,$numtitles); } else { - %courses = &search_courselist($domain); + %courses = &search_courselist($domain,$subcats); } if (keys(%courses) == 0) { $output = &mt('No courses match the criteria you selected.'); return $output; } - if ($knownuser && !$env{'form.showdetails'}) { - $output = &mt('Note for students: If you are officially enrolled in a course but the course is not listed in your LON-CAPA courses, click the "Show more details" link for the specific course and check the default access dates and/or automated enrollment settings.

'); + if (($knownuser) && (!$env{'form.showdetails'}) && (!&user_is_dc($domain))) { + $output = ''.&mt('Note for students:').' ' + .&mt('If you are officially enrolled in a course but the course is not listed in your LON-CAPA courses, click the "Show more details" link for the specific course and check the default access dates and/or automated enrollment settings.') + .'

'; } } my $now = time; my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$domain); - $output .= &construct_data_table($knownuser,\%courses,$details,undef,$now,\%domconfig); - $output .= &Apache::lonhtmlcommon::echo_form_input(['coursenum','state','catalogfilter','sortby','showdetails']); + $output .= &construct_data_table($knownuser,\%courses,$details,undef,$now,\%domconfig,$trails,$allitems); + $output .= "\n".'
'. + ''. + &Apache::lonhtmlcommon::echo_form_input(['catalogfilter']).'
'; return $output; } sub construct_data_table { - my ($knownuser,$courses,$details,$usersections,$now,$domconfig) = @_; + my ($knownuser,$courses,$details,$usersections,$now,$domconfig,$trails, + $allitems) = @_; my %sortname; if (($details eq '') || ($env{'form.showdetails'})) { $sortname{'Code'} = 'code'; + $sortname{'Categories'} = 'cats'; $sortname{'Title'} = 'title'; $sortname{'Owner(s)'} = 'owner'; } my $output = &Apache::loncommon::start_data_table(). &Apache::loncommon::start_data_table_header_row(); - my @coltitles = ('Count','Code','Sections','Crosslisted','Title','Owner(s)'); + my @coltitles = ('Count'); + if ($env{'form.currcat_0'} eq 'instcode::0') { + push(@coltitles,'Code'); + } else { + push(@coltitles,'Categories'); + } + push(@coltitles,('Sections','Crosslisted','Title','Owner(s)')); if (ref($usersections) eq 'HASH') { $coltitles[1] = 'Your Section'; } @@ -673,6 +812,8 @@ sub construct_data_table { foreach my $course (sort(keys(%{$courses}))) { if ($env{'form.sortby'} eq 'code') { push(@{$Sortby{$courseinfo{$course}{'code'}}},$course); + } elsif ($env{'form.sortby'} eq 'cats') { + push(@{$Sortby{$courseinfo{$course}{'categories'}}},$course); } elsif ($env{'form.sortby'} eq 'owner') { push(@{$Sortby{$courseinfo{$course}{'ownerlastnames'}}},$course); } else { @@ -685,7 +826,8 @@ sub construct_data_table { } } my @sorted_courses; - if (($env{'form.sortby'} eq 'code') || ($env{'form.sortby'} eq 'owner')) { + if (($env{'form.sortby'} eq 'code') || ($env{'form.sortby'} eq 'owner') || + ($env{'form.sortby'} eq 'cats')) { @sorted_courses = sort(keys(%Sortby)); } else { @sorted_courses = sort { lc($a) cmp lc($b) } (keys(%Sortby)); @@ -694,8 +836,8 @@ sub construct_data_table { foreach my $item (@sorted_courses) { foreach my $course (@{$Sortby{$item}}) { $output.=&Apache::loncommon::start_data_table_row(); - $output.=&courseinfo_row($courseinfo{$course},$knownuser, - $details,\$count,$now,$course); + $output.=&courseinfo_row($courseinfo{$course},$knownuser,$details, + \$count,$now,$course,$trails,$allitems); $output.=&Apache::loncommon::end_data_table_row(); } } @@ -716,8 +858,8 @@ sub build_courseinfo_hash { $cleandesc=~s/'/\\'/g; $cleandesc =~ s/^\s+//; my ($cdom,$cnum)=split(/\_/,$course); - my ($descr,$instcode,$singleowner,$ttype,$selfenroll_types, - $selfenroll_start,$selfenroll_end,@owners,%ownernames); + my ($instcode,$singleowner,$ttype,$selfenroll_types, + $selfenroll_start,$selfenroll_end,@owners,%ownernames,$categories); if (ref($courses->{$course}) eq 'HASH') { $descr = $courses->{$course}{'description'}; $instcode = $courses->{$course}{'inst_code'}; @@ -726,6 +868,7 @@ sub build_courseinfo_hash { $selfenroll_types = $courses->{$course}{'selfenroll_types'}; $selfenroll_start = $courses->{$course}{'selfenroll_start_date'}; $selfenroll_end = $courses->{$course}{'selfenroll_end_date'}; + $categories = $courses->{$course}{'categories'}; push(@owners,$singleowner); if (ref($courses->{$course}{'co-owners'}) eq 'ARRAY') { foreach my $item (@{$courses->{$course}{'co-owners'}}) { @@ -763,6 +906,7 @@ sub build_courseinfo_hash { $courseinfo{$course}{'selfenroll_types'} = $selfenroll_types; $courseinfo{$course}{'selfenroll_start'} = $selfenroll_start; $courseinfo{$course}{'selfenroll_end'} = $selfenroll_end; + $courseinfo{$course}{'categories'} = $categories; my %coursehash = &Apache::lonnet::dump('environment',$cdom,$cnum); my @classids; @@ -798,7 +942,7 @@ sub build_courseinfo_hash { if ( defined($coursehash{'default_enrollment_end_date'}) ) { $endaccess = &Apache::lonlocal::locallocaltime($coursehash{'default_enrollment_end_date'}); if ($coursehash{'default_enrollment_end_date'} == 0) { - $endaccess = "No ending date"; + $endaccess = &mt('No ending date'); } } if ($startaccess) { @@ -807,6 +951,33 @@ sub build_courseinfo_hash { if ($endaccess) { $accessdates .= &mt('To: ').$endaccess.'
'; } + if (($selfenroll_types ne '') && + ($selfenroll_end > 0 && $selfenroll_end > $now)) { + my ($selfenroll_start_access,$selfenroll_end_access); + if (($coursehash{'default_enrollment_start_date'} ne + $coursehash{'internal.selfenroll_start_access'}) || + ($coursehash{'default_enrollment_end_date'} ne + $coursehash{'internal.selfenroll_end_access'})) { + if ( defined($coursehash{'internal.selfenroll_start_access'}) ) { + $selfenroll_start_access = &Apache::lonlocal::locallocaltime($coursehash{'internal.selfenroll_start_access'}); + } + if ( defined($coursehash{'default_enrollment_end_date'}) ) { + $selfenroll_end_access = &Apache::lonlocal::locallocaltime($coursehash{'internal.selfenroll_end_access'}); + if ($coursehash{'internal.selfenroll_end_access'} == 0) { + $selfenroll_end_access = &mt('No ending date'); + } + } + if ($selfenroll_start_access || $selfenroll_end_access) { + $accessdates .= '

'.&mt('Self-enrollers:').'
'; + if ($selfenroll_start_access) { + $accessdates .= &mt('From: ').$selfenroll_start_access.'
'; + } + if ($selfenroll_end_access) { + $accessdates .= &mt('To: ').$selfenroll_end_access.'
'; + } + } + } + } $courseinfo{$course}{'access'} = $accessdates; } if ($xlist_items eq '') { @@ -846,9 +1017,9 @@ sub count_students { } sub courseinfo_row { - my ($info,$knownuser,$details,$countref,$now,$course) = @_; + my ($info,$knownuser,$details,$countref,$now,$course,$trails,$allitems) = @_; my ($cdom,$cnum,$title,$ownerlast,$code,$owner,$seclist,$xlist_items, - $accessdates,$showsyllabus,$counts,$autoenrollment,$output); + $accessdates,$showsyllabus,$counts,$autoenrollment,$output,$categories); if (ref($info) eq 'HASH') { $cdom = $info->{'cdom'}; $cnum = $info->{'cnum'}; @@ -862,18 +1033,34 @@ sub courseinfo_row { $counts = $info->{'counts'}; $autoenrollment = $info->{'autoenrollment'}; $showsyllabus = $info->{'showsyllabus'}; + $categories = $info->{'categories'}; } else { $output = ''.&mt('No information available for [_1].', $code).''; return $output; } - $output .= ''.$$countref.''. - ''.$code.''. - ''.$seclist.''. + $output .= ''.$$countref.''; + if ($env{'form.currcat_0'} eq 'instcode::0') { + $output .= ''.$code.''; + } else { + my ($categorylist,@cats); + if ($categories ne '') { + @cats = split('&',$categories); + } + if ((ref($trails) eq 'ARRAY') && (ref($allitems) eq 'HASH')) { + my @categories = map { $trails->[$allitems->{$_}]; } @cats; + $categorylist = join('
',@categories); + } + if ($categorylist eq '') { + $categorylist = ' '; + } + $output .= ''.$categorylist.''; + } + $output .= ''.$seclist.''. ''.$xlist_items.''. ''.$title.' '; if ($showsyllabus) { - $output .= &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$cnum,$cdom); + $output .= ''.&mt('Syllabus').''; } else { $output .= ' '; } @@ -927,7 +1114,7 @@ sub identify_sections { } } @secnums = sort {$a <=> $b} @secnums; - my $seclist = join(', ',@secnums); + $seclist = join(', ',@secnums); my $numsec = @secnums; return ($seclist,$numsec); }