--- loncom/interface/coursecatalog.pm 2006/09/25 00:16:56 1.5 +++ loncom/interface/coursecatalog.pm 2010/07/08 23:19:19 1.63 @@ -1,3 +1,7 @@ +# The LearningOnline Network with CAPA +# Handler for displaying the course catalog interface +# +# $Id: coursecatalog.pm,v 1.63 2010/07/08 23:19:19 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,11 +32,11 @@ use strict; use lib qw(/home/httpd/lib/perl); use Apache::Constants qw(:common); use Apache::loncommon; +use Apache::lonhtmlcommon; use Apache::lonnet; use Apache::lonlocal; -use Apache::lonsupportreq; +use Apache::courseclassifier; use Apache::lonacc; -use lib '/home/httpd/lib/perl/'; use LONCAPA; sub handler { @@ -42,232 +46,731 @@ sub handler { if ($r->header_only) { return OK; } + my $handle = &Apache::lonnet::check_for_valid_session($r); + my $lonidsdir=$r->dir_config('lonIDsDir'); + if ($handle ne '') { + &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle); + } &Apache::lonacc::get_posted_cgi($r); &Apache::lonlocal::get_language_handle($r); - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sortby']); - my $codedom = $Apache::lonnet::perlvar{'lonDefDomain'}; - my $ccode = ''; + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['sortby','showdom']); + + my $codedom = &Apache::lonnet::default_login_domain(); + + if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne 'public')) { + $codedom = $env{'user.domain'}; + if ($env{'request.role.domain'} ne '') { + $codedom = $env{'request.role.domain'}; + } + } + my $formname = 'coursecatalog'; + if ($env{'form.showdom'} ne '') { + if (&Apache::lonnet::domain($env{'form.showdom'}) ne '') { + $codedom = $env{'form.showdom'}; + } + } + 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); + my ($numtitles,@codetitles); + if ($env{'form.coursenum'} ne '' && &user_is_known()) { + if ($env{'form.currcat_0'} eq 'instcode::0') { + $numtitles = &instcode_course_selector($r,$codedom,$formname,$domdesc, + undef,undef,\@codetitles); + } + &course_details($r,$codedom,$formname,$domdesc,\@trails,\%allitems,\@codetitles); + } else { + my ($catlinks,$has_subcats,$selitem) = &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 .= &courselink_javascript(); + if ($env{'form.currcat_0'} eq 'instcode::0') { + $numtitles = &instcode_course_selector($r,$codedom,$formname,$domdesc, + $catlinks,$catjs,\@codetitles); + if ($env{'form.state'} eq 'listing') { + $r->print(&print_course_listing($codedom,$numtitles,undef,undef,undef, + \@codetitles)); + } + } else { + my (%add_entries); + my ($currdepth,$deeper) = &get_depth_values(); + if ($selitem) { + my $alert = &mt('Choose a subcategory to display'); + if (!$deeper) { + $alert = &mt('Choose a category to display'); + } + $catjs .= <'; + &cat_header($r,$codedom,$catjs,\%add_entries,$catlinks); + if ($env{'form.currcat_0'} ne '') { + $r->print('
'. + &additional_filters($codedom,$has_subcats)."\n"); + $r->print(''."\n"); + for (my $i=0; $i<$deeper; $i++) { + $r->print(''."\n"); + } + my $display_button; + if ($env{'form.currcat_0'} eq 'communities::0') { + $display_button = &mt('Display communities'); + } else { + $display_button = &mt('Display courses'); + } + $r->print(''."\n". + ''."\n". + ''."\n". + ''. + '


'); + } + if ($env{'form.state'} eq 'listing') { + $r->print(&print_course_listing($codedom,undef,\@trails,\%allitems,$subcats,\@codetitles)); + } + } + } + $r->print('
'.&Apache::loncommon::end_page()); + return OK; +} + +sub course_details { + my ($r,$codedom,$formname,$domdesc,$trails,$allitems,$codetitles) = @_; + my $output; + my %add_entries = (topmargin => "0", + marginheight => "0",); + my $js = ''."\n"; + my $start_page = + &Apache::loncommon::start_page('Course/Community Catalog',$js, + {'add_entries' => \%add_entries, }); + $r->print($start_page); + if ($env{'form.numtitles'} > 0) { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/coursecatalog", + text=>"Course/Community Catalog"}); + } + my $brtextone = 'Course listing'; + my $brtexttwo = 'Course details'; + if ($env{'form.currcat_0'} eq 'communities::0') { + $brtextone = 'Community listing'; + $brtexttwo = 'Community details'; + } + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"javascript:document.$formname.submit()", + text=>$brtextone}, + {text=>$brtexttwo}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs('Course/Community Catalog')); + $r->print('
'); + if ($env{'form.currcat_0'} eq 'communities::0') { + $r->print(&mt('Detailed community information:')); + } else { + $r->print(&mt('Detailed course information:')); + } + $r->print('

'. + &print_course_listing($codedom,undef,$trails,$allitems,undef,$codetitles). + '

'); + $r->print('
'. + ''); + if ($env{'form.currcat_0'} eq 'communities::0') { + $r->print(&mt('Back to community listing')); + } else { + $r->print(&mt('Back to course listing')); + } + $r->print(''. + &Apache::lonhtmlcommon::echo_form_input(['coursenum','catalogfilter', + 'showdetails','courseid']).'
'); + return; +} + +sub courselink_javascript { + return <<"END"; + +function ToSyllabus(cdom,cnum) { + if (cdom == '' || cdom == null) { + return; + } + if (cnum == '' || cnum == null) { + return; + } + document.linklaunch.action = "/public/"+cdom+"/"+cnum+"/syllabus"; + document.linklaunch.submit(); +} + +function ToSelfenroll(courseid) { + if (courseid == '') { + return; + } + document.linklaunch.action = "/adm/selfenroll"; + document.linklaunch.courseid.value = courseid; + document.linklaunch.submit(); +} + +END +} + +sub instcode_course_selector { + my ($r,$codedom,$formname,$domdesc,$catlinks,$catjs,$codetitles) = @_; my %coursecodes = (); my %codes = (); - my @codetitles = (); my %cat_titles = (); my %cat_order = (); - my %idlist = (); - my %idnums = (); - my %idlist_titles = (); + my %cat_items; my $caller = 'global'; my $format_reply; - my $totcodes = 0; - my $jscript = ''; - my $formname = 'coursecatalog'; - my $domdesc = $Apache::lonnet::domaindescription{$codedom}; - $totcodes = &Apache::lonsupportreq::retrieve_instcodes(\%coursecodes,$codedom,$totcodes); - if ($totcodes > 0) { - if ($ccode eq '') { - $format_reply = &Apache::lonnet::auto_instcode_format($caller,$codedom,\%coursecodes,\%codes,\@codetitles,\%cat_titles,\%cat_order); - if ($format_reply eq 'ok') { - my $numtypes = @codetitles; - &Apache::lonsupportreq::build_code_selections(\%codes,\@codetitles,\%cat_titles,\%cat_order,\%idlist,\%idnums,\%idlist_titles); - &Apache::lonsupportreq::javascript_code_selections($formname,$numtypes,\%cat_titles,\$jscript,\%idlist,\%idnums,\%idlist_titles,\@codetitles); - } - } - if ($env{'form.state'} eq 'listing') { - $jscript .= ' -function setElements() { -'; - for (my $i=0; $i<@codetitles; $i++) { - if ($env{'form.'.$codetitles[$i]} != -1) { - $jscript .= ' - for (var j=0; j "0", + marginheight => "0",); + my ($jscript,$totcodes,$numtitles,$lasttitle) = + &Apache::courseclassifier::instcode_selectors_data($codedom,$formname, + \%cat_items,$codetitles,\%cat_titles,\%cat_order); + my $js = ''; + if ($totcodes) { + if (($env{'form.state'} eq 'listing') && ($numtitles > 0)) { + $add_entries{'onLoad'} = 'setElements()'; } + &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.').'
'. + &Apache::courseclassifier::build_instcode_selectors($numtitles, + $lasttitle,\%cat_items,$codetitles,\%cat_titles,\%cat_order)); + } + $r->print(''."\n". + ''."\n". + ''."\n". + ''."\n". + ''. + '


'); + } else { + $js = ''; + &cat_header($r,$codedom,$js,\%add_entries,$catlinks,$numtitles); + my $cat_maxdepth = $env{'form.catalog_maxdepth'}; + $r->print('
'. + ''. + ''. + ''); + $r->print('
'.&mt('No official courses to display for [_1].',$domdesc).'
'); } -'; - $jscript .= ' courseSet('."'$codetitles[$i]'".');'."\n"; - } else { - last; - } - } - $jscript .= '}'; - $jscript .= qq| -function changeSort(caller) { - document.coursecatalog.sortby.value = caller; - document.coursecatalog.submit(); -}\n|; - } - my $js = ''; - my %add_entries = (topmargin => "0", - marginheight => "0", - onLoad =>"setElements()",); - my $start_page = - &Apache::loncommon::start_page('Course Catalog',$js, - { - 'add_entries' => \%add_entries, - 'no_inline_link' => 1,}); - $r->print($start_page); - - my $numtitles = @codetitles; - $r->print('

'.&mt('Display information about official [_1] classes for which LON-CAPA courses have been created:',$domdesc).'

'); - $r->print(&mt('Choose which course(s) to list.
')); - $r->print('
'); + return $numtitles; +} + +sub cat_header { + my ($r,$codedom,$js,$add_entries,$catlinks,$numtitles) = @_; + my $start_page = + &Apache::loncommon::start_page('Other',$js, + { 'add_entries' => $add_entries, }); + $r->print($start_page); + my $brtext = 'Course listing'; + if ($env{'form.currcat_0'} eq 'communities::0') { + $brtext = 'Community listing'; + } + if ($env{'form.state'} eq 'listing') { if ($numtitles > 0) { - my $lasttitle = $numtitles; - if ($numtitles > 4) { - $lasttitle = 4; - } - $r->print(''; + return ($catlinks,$has_subcats,$selitem); +} + +sub main_category_selector { + my (@cats) = @_; + my $maincatlinks = ''."\n"; + } + return $maincatlinks; +} + +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 = '
'.$codetitles[0].'
'."\n". - '
'.&mt('Domain:').''. + &Apache::loncommon::select_dom_form($codedom,'showdom','',1,$onchange)); + if (!$onchange) { + $r->print(' '); + } + $r->print('
'. + '
'. + ''.$catlinks.'
'); + return; +} + +sub category_breadcrumbs { + my ($dom,@cats) = @_; + my $crumbsymbol = ' ▶ '; + my ($currdepth,$deeper) = &get_depth_values(); + my $currcat_str = + ''. + ''; + my $catlinks = '		'.&mt('Catalog:').''; + } + } + } else { + $catlinks .= &mt('Official courses (with institutional codes)'); + $env{'form.currcat_0'} = 'instcode::0'; + $currcat_str .= ''; + } + if ($deeper) { + for (my $i=1; $i<=$deeper; $i++) { + my $shallower = $i-1; + next if ($shallower == 0); + my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$env{'form.currcat_'.$shallower}); + if ($cat ne '') { + $catlinks .= '
'; + my $has_subcats; + my $selitem; + if (ref($cats[0]) eq 'ARRAY') { + if (@{$cats[0]} == 0) { + $catlinks .= &mt('No categories defined in this domain'); + } elsif (@{$cats[0]} == 1) { + if ($cats[0][0] eq 'instcode') { + $catlinks .= &mt('Official courses (with institutional codes)'); + $env{'form.currcat_0'} = 'instcode::0'; + } elsif ($cats[0][0] eq 'communities') { + $catlinks .= &mt('Communities'); + $env{'form.currcat_0'} = 'communities::0'; } else { - $items[0] = $idlist{$codetitles[0]}; + my $name = $cats[0][0]; + my $item = &escape($name).'::0'; + $catlinks .= $name; + $env{'form.currcat_0'} = $item; } - if (defined($idlist_titles{$codetitles[0]})) { - if ($idlist_titles{$codetitles[0]} =~ /","/) { - @longitems = split(/","/,$idlist_titles{$codetitles[0]}); - } else { - $longitems[0] = $idlist_titles{$codetitles[0]}; - } - for (my $i=0; $i<@longitems; $i++) { - if ($longitems[$i] eq '') { - $longitems[$i] = $items[$i]; + $currcat_str .= ''; + } else { + $catlinks .= &main_category_selector(@cats); + if (($env{'form.currcat_0'} ne '') && + ($env{'form.currcat_0'} ne 'instcode::0')) { + $catlinks .= $crumbsymbol; + } else { + $catlinks .= ''. + ''; + } + unless ($i == $deeper) { + $catlinks .= $crumbsymbol; + } + } + my ($cat,$container,$depth); + if ($env{'form.currcat_'.$currdepth} eq '') { + my $shallower = $currdepth - 1; + ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$env{'form.currcat_'.$shallower}); + } else { + ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$env{'form.currcat_'.$currdepth}); + } + my $deeperlevel = $depth +1; + if (ref($cats[$deeperlevel]{$cat}) eq 'ARRAY') { + $has_subcats = 1; + my $buttontext = &mt('Show subcategories'); + my $selitem = 'currcat_'.$deeperlevel; + $catlinks .= ' '."\n"; + } elsif ($cat ne 'instcode') { + $catlinks .= ' '.&mt('(No subcategories)'); + } + } else { + $selitem = 'currcat_0'; + } + $catlinks .= $currcat_str.'
'; + 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 --; } - $r->print(''); - for (my $i=1; $i<$numtitles; $i++) { - $r->print('' - ); - } - $r->print('
'.$codetitles[$i].'
'."\n". - ''."\n". - '
'); - if ($numtitles > 4) { - $r->print('

'.$codetitles[$numtitles].'
'."\n". - ''."\n"); - } - } - $r->print('
'); - } else { - $r->print(&Apache::loncommon::start_page('Course Catalog','', - { - 'no_inline_link' => 1,})); - $r->print('
'.&mt('No official courses to display for [_1].',$domdesc)); + } + my ($catname) = split(/:/,$env{'form.currcat_'.$counter}); + if ($catname ne '') { + $output .= ''; + } } - if ($env{'form.state'} eq 'listing') { - $r->print('

'.&print_course_listing($codedom)); + my $show_selfenroll_status; + if ($env{'form.showselfenroll'}) { + $show_selfenroll_status = 'checked="checked" '; + } + my $selfenroll_text; + if ($env{'form.currcat_0'} eq 'communities::0') { + $selfenroll_text = &mt('Only show communities which allow self-enrollment'); + } else { + $selfenroll_text = &mt('Only show courses which allow self-enrollment'); } - $r->print(&Apache::loncommon::end_page()); - return OK; + $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'); + my ($details_text,$hidden_text); + if ($env{'form.currcat_0'} eq 'communities::0') { + $details_text = &mt('Show full details for each community ([_1] only)',$dc_title); + $hidden_text = &mt('Include communities set to be hidden from catalog ([_1] only)',$dc_title); + } else { + $details_text = &mt('Show full details for each course ([_1] only)',$dc_title); + $hidden_text = &mt('Include courses set to be hidden from catalog ([_1] only)',$dc_title); + } + $output .= ''."\n". + ''."\n".''. + ''."\n".''; + } + $output .= '
'; + return $output; +} + +sub user_is_dc { + my ($codedom) = @_; + if (exists($env{'user.role.dc./'.$codedom.'/'})) { + my $livedc = 1; + my $now = time; + my ($start,$end)=split(/\./,$env{'user.role.dc./'.$codedom.'/'}); + if ($start && $start>$now) { $livedc = 0; } + if ($end && $end <$now) { $livedc = 0; } + return $livedc; + } + return; +} + +sub search_official_courselist { + my ($domain,$numtitles,$codetitles) = @_; + my $instcode = &Apache::courseclassifier::instcode_search_str($domain,$numtitles,$codetitles); + 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,$subcats) = @_; + my $cat_maxdepth = $env{'form.catalog_maxdepth'}; + my $filter = $env{'form.currcat_'.$cat_maxdepth}; + if (($filter eq '') && ($cat_maxdepth > 0)) { + my $shallower = $cat_maxdepth - 1; + $filter = $env{'form.currcat_'.$shallower}; + } + my %courses; + my $filterstr; + if ($filter ne '') { + 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,$typefilter); + if (&user_is_dc($domain)) { + $showhidden = $env{'form.showhidden'}; + } + if ($env{'form.currcat_0'} eq 'communities::0') { + $typefilter = 'Community'; + } else { + $typefilter = '.'; + } + %courses = + &Apache::lonnet::courseiddump($domain,'.',1,'.','.','.',undef,undef, + $typefilter,1,$env{'form.showselfenroll'}, + $filterstr,$showhidden,'coursecatalog'); + } + return %courses; } sub print_course_listing { - my ($domain) = @_; + my ($domain,$numtitles,$trails,$allitems,$subcats,$codetitles) = @_; my $output; - my $year = $env{'form.Year'}; - my $sem = $env{'form.Semester'}; - my $dept = $env{'form.Department'}; - my $coursenum = $env{'form.Number'}; - my $instcode; - if ($sem != -1) { - $instcode .= $sem; - } - if ($year != -1) { - $instcode .= $year; - } - if ($dept != -1) { - $instcode .= $dept; - } - if ($coursenum != -1) { - $instcode .= $coursenum; - } - my %courses = &Apache::lonnet::courseiddump($domain,'.',1,$instcode,'.','.', - undef,undef,'Course'); - if (keys(%courses) == 0) { - $output = &mt('No courses match the criteria you selected.'); - return $output; + my %courses; + my $knownuser = &user_is_known(); + my $details = $env{'form.coursenum'}; + if (&user_is_dc($domain)) { + if ($env{'form.showdetails'}) { + $details = 1; + } } - $output = &mt('Note for students: If you are officially enrolled in a course but there is no student role for the course in your LON-CAPA roles screen, check the default access dates and/or auto-enrollment settings for the course below. Your roles screen displays only currently accessible roles.

'); - $output .= &Apache::loncommon::start_data_table(). - &Apache::loncommon::start_data_table_header_row(). - ''.&mt('Code').''. - ''.&mt('Sections').''. - ''.&mt('Crosslisted').''. - ''.&mt('Title').''. - ''.&mt('Owner').''. - ''.&mt('Student Status').''. - ''.&mt('Default Access Dates').''. - ''.&mt('Auto-enrollment').''. - &Apache::loncommon::end_data_table_header_row(); - my %courseinfo; - foreach my $course (keys(%courses)) { - my $descr; - if ($courses{$course} =~ m/^([^:]*):/i) { - $descr = &unescape($1); + if ($env{'form.coursenum'} ne '') { + %courses = &Apache::lonnet::courseiddump($domain,'.',1,'.','.', + $env{'form.coursenum'}, + undef,undef,'.',1); + if (keys(%courses) == 0) { + if ($env{'form.currcat_0'} eq 'communities::0') { + $output .= &mt('The courseID provided does not match a community in this domain.'); + } else { + $output .= &mt('The courseID provided does not match a course in this domain.'); + } + return $output; + } + } else { + if ($env{'form.currcat_0'} eq 'instcode::0') { + %courses = &search_official_courselist($domain,$numtitles,$codetitles); } else { - $descr = &unescape($courses{$course}); + %courses = &search_courselist($domain,$subcats); } - my $cleandesc=&HTML::Entities::encode($descr,'<>&"'); - $cleandesc=~s/'/\\'/g; - my ($cdom,$cnum)=split(/\_/,$course); - - my ($desc,$instcode,$owner,$ttype) = split(/:/,$courses{$course}); - $owner = &unescape($owner); - my ($ownername,$ownerdom); - if ($owner =~ /:/) { - ($ownername,$ownerdom) = split(/:/,$owner); - } else { - $ownername = $owner; - if ($owner ne '') { - $ownerdom = $cdom; + if (keys(%courses) == 0) { + if ($env{'form.currcat_0'} eq 'communities::0') { + $output = &mt('No communities match the criteria you selected.'); + } else { + $output = &mt('No courses match the criteria you selected.'); } + return $output; } - my %ownernames; - if ($ownername ne '' && $ownerdom ne '') { - %ownernames = &Apache::loncommon::getnames($ownername,$ownerdom); + 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,$trails,$allitems); + $output .= "\n".'
'. + ''. + ''. + &Apache::lonhtmlcommon::echo_form_input(['catalogfilter','courseid']).'
'; + return $output; +} + +sub construct_data_table { + 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'); + 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'; + } + foreach my $item (@coltitles) { + $output .= ''; + if (defined($sortname{$item})) { + $output .= ''.&mt($item).''; + } elsif ($item eq 'Count') { + $output .= '  '; + } else { + $output .= &mt($item); + } + $output .= ''; + } + if ($knownuser) { + if ($details) { + if ($env{'form.currcat_0'} eq 'communities::0') { + $output .= ''.&mt('Default Access Dates for Members').''; + } else { + $output .= + ''.&mt('Default Access Dates for Students').''. + ''.&mt('Student Counts').''. + ''.&mt('Auto-enrollment of[_1]registered students','
').''; + } + } else { + $output .= ''.&mt('Details').''; } - $courseinfo{$course}{'cdom'} = $cdom; - $courseinfo{$course}{'cnum'} = $cnum; - $courseinfo{$course}{'code'} = $instcode; - $courseinfo{$course}{'ownerlastname'} = $ownernames{'lastname'}; - $courseinfo{$course}{'title'} = $cleandesc; - $courseinfo{$course}{'owner'} = $owner; } + $output .= ''.&mt('Self-enroll (if permitted)').''; + &Apache::loncommon::end_data_table_header_row(); + my %courseinfo = &build_courseinfo_hash($courses,$knownuser,$details, + $usersections); my %Sortby; - foreach my $course (sort(keys(%courses))) { + 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}{'ownerlastname'}}},$course); + push(@{$Sortby{$courseinfo{$course}{'ownerlastnames'}}},$course); } else { - push(@{$Sortby{$courseinfo{$course}{'title'}}},$course); + my $clean_title = $courseinfo{$course}{'title'}; + $clean_title =~ s/\W+//g; + if ($clean_title eq '') { + $clean_title = $courseinfo{$course}{'title'}; + } + push(@{$Sortby{$clean_title}},$course); } } 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)); } + my $count = 1; foreach my $item (@sorted_courses) { foreach my $course (@{$Sortby{$item}}) { $output.=&Apache::loncommon::start_data_table_row(); - $output.=&courseinfo_row($courseinfo{$course}); + $output.=&courseinfo_row($courseinfo{$course},$knownuser,$details, + \$count,$now,$course,$trails,$allitems); $output.=&Apache::loncommon::end_data_table_row(); } } @@ -275,117 +778,258 @@ sub print_course_listing { return $output; } -sub courseinfo_row { - my ($info) = @_; - my ($cdom,$cnum,$title,$ownerlast,$code,$owner,$output); - if (ref($info) eq 'HASH') { - $cdom = $info->{'cdom'}; - $cnum = $info->{'cnum'}; - $title = $info->{'title'}; - $ownerlast = $info->{'ownerlastname'}; - $code = $info->{'code'}; - $owner = $info->{'owner'}; - } else { - $output = ''.&mt('No information available for [_1].', - $code).''; - return $output; +sub build_courseinfo_hash { + my ($courses,$knownuser,$details,$usersections) = @_; + my %courseinfo; + my $now = time; + foreach my $course (keys(%{$courses})) { + my $descr; + if (ref($courses->{$course}) eq 'HASH') { + $descr = $courses->{$course}{'description'}; + } + my $cleandesc=&HTML::Entities::encode($descr,'<>&"'); + $cleandesc=~s/'/\\'/g; + $cleandesc =~ s/^\s+//; + my ($cdom,$cnum)=split(/\_/,$course); + 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'}; + $singleowner = $courses->{$course}{'owner'}; + $ttype = $courses->{$course}{'type'}; + $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'}}) { + push(@owners,$item); + } + } + } + foreach my $owner (@owners) { + my ($ownername,$ownerdom); + if ($owner =~ /:/) { + ($ownername,$ownerdom) = split(/:/,$owner); + } else { + $ownername = $owner; + if ($owner ne '') { + $ownerdom = $cdom; + } + } + if ($ownername ne '' && $ownerdom ne '') { + my %namehash=&Apache::loncommon::getnames($ownername,$ownerdom); + $ownernames{$ownername.':'.$ownerdom} = \%namehash; + } + } + $courseinfo{$course}{'cdom'} = $cdom; + $courseinfo{$course}{'cnum'} = $cnum; + $courseinfo{$course}{'code'} = $instcode; + my @lastnames; + foreach my $owner (keys(%ownernames)) { + if (ref($ownernames{$owner}) eq 'HASH') { + push(@lastnames,$ownernames{$owner}{'lastname'}); + } + } + $courseinfo{$course}{'ownerlastnames'} = join(', ',sort(@lastnames)); + $courseinfo{$course}{'title'} = $cleandesc; + $courseinfo{$course}{'owner'} = $singleowner; + $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; + my @crosslistings; + my ($seclist,$numsec) = + &identify_sections($coursehash{'internal.sectionnums'}); + if (ref($usersections) eq 'HASH') { + if (ref($usersections->{$course}) eq 'ARRAY') { + $seclist = join(', ',@{$usersections->{$course}}); + } + } + $courseinfo{$course}{'seclist'} = $seclist; + my ($xlist_items,$numxlist) = + &identify_sections($coursehash{'internal.crosslistings'}); + my $showsyllabus = 1; # default is to include a syllabus link + if (defined($coursehash{'showsyllabus'})) { + $showsyllabus = $coursehash{'showsyllabus'}; + } + $courseinfo{$course}{'showsyllabus'} = $showsyllabus; + if (((defined($env{'form.coursenum'}) && ($cnum eq $env{'form.coursenum'}))) || + ($knownuser && ($details == 1))) { + $courseinfo{$course}{'counts'} = &count_students($cdom,$cnum,$numsec); + $courseinfo{$course}{'autoenrollment'} = + &autoenroll_info(\%coursehash,$now,$seclist,$xlist_items, + $instcode,\@owners,$cdom,$cnum); + + my $startaccess = ''; + my $endaccess = ''; + my $accessdates; + if ( defined($coursehash{'default_enrollment_start_date'}) ) { + $startaccess = &Apache::lonlocal::locallocaltime($coursehash{'default_enrollment_start_date'}); + } + if ( defined($coursehash{'default_enrollment_end_date'}) ) { + $endaccess = &Apache::lonlocal::locallocaltime($coursehash{'default_enrollment_end_date'}); + if ($coursehash{'default_enrollment_end_date'} == 0) { + $endaccess = &mt('No ending date'); + } + } + if ($startaccess) { + $accessdates .= ''.&mt('From:[_1]',' '.$startaccess).'
'; + } + if ($endaccess) { + $accessdates .= ''.&mt('To:[_1]',' '.$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:[_1]',' '.$selfenroll_start_access).'
'; + } + if ($selfenroll_end_access) { + $accessdates .= ''.&mt('To:[_1]',' '.$selfenroll_end_access).'
'; + } + } + } + } + $courseinfo{$course}{'access'} = $accessdates; + } + if ($xlist_items eq '') { + $xlist_items = &mt('No'); + } + $courseinfo{$course}{'xlist'} = $xlist_items; } - my %coursehash = &Apache::lonnet::dump('environment',$cdom,$cnum); + return %courseinfo; +} + +sub count_students { + my ($cdom,$cnum,$numsec) = @_; my $classlist = &Apache::loncoursedata::get_classlist($cdom,$cnum); + my %student_count = ( + Active => 0, + Future => 0, + Expired => 0, + ); my %idx; - my @classids; - my @crosslistings; $idx{'status'} = &Apache::loncoursedata::CL_STATUS(); my %status_title = &Apache::lonlocal::texthash( Expired => 'Previous access', Active => 'Current access', Future => 'Future access', ); - my %student_count = ( - Expired => 0, - Active => 0, - Future => 0, - ); + while (my ($student,$data) = each(%$classlist)) { $student_count{$data->[$idx{'status'}]} ++; } - my $seclist = &identify_sections($coursehash{'internal.sectionnums'}); - my $xlist_items = &identify_sections($coursehash{'internal.crosslistings'}); - my $countslist; - my $startaccess = ''; - my $endaccess = ''; - my $now; - my ($accessdates,$autoenrolldates,$showsyllabus); - if ( defined($coursehash{'default_enrollment_start_date'}) ) { - $startaccess = &Apache::lonlocal::locallocaltime($coursehash{'default_enrollment_start_date'}); - } - 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"; - } - } - if ($startaccess) { - $accessdates .= &mt('From: ').$startaccess.'
'; + + my $countslist = &mt('[quant,_1,section:,sections:,No sections]',$numsec).'
'; + foreach my $status ('Active','Future') { + $countslist .= ''.$status_title{$status}.': '. + $student_count{$status}.'
'; } - if ($endaccess) { - $accessdates .= &mt('To: ').$endaccess.'
'; + return $countslist; +} + +sub courseinfo_row { + my ($info,$knownuser,$details,$countref,$now,$course,$trails,$allitems) = @_; + my ($cdom,$cnum,$title,$ownerlast,$code,$owner,$seclist,$xlist_items, + $accessdates,$showsyllabus,$counts,$autoenrollment,$output,$categories); + if (ref($info) eq 'HASH') { + $cdom = $info->{'cdom'}; + $cnum = $info->{'cnum'}; + $title = $info->{'title'}; + $ownerlast = $info->{'ownerlastnames'}; + $code = $info->{'code'}; + $owner = $info->{'owner'}; + $seclist = $info->{'seclist'}; + $xlist_items = $info->{'xlist'}; + $accessdates = $info->{'access'}; + $counts = $info->{'counts'}; + $autoenrollment = $info->{'autoenrollment'}; + $showsyllabus = $info->{'showsyllabus'}; + $categories = $info->{'categories'}; + } else { + $output = ''.&mt('No information available for [_1].', + $code).''; + return $output; } - $autoenrolldates = &mt('Not enabled'); - if (defined($coursehash{'internal.autoadds'}) && $coursehash{'internal.autoadds'} == 1) { - my ($autostart,$autoend); - if ( defined($coursehash{'internal.autostart'}) ) { - $autostart = &Apache::lonlocal::locallocaltime($coursehash{'internal.autostart'}); + $output .= ''.$$countref.''; + if ($env{'form.currcat_0'} eq 'instcode::0') { + $output .= ''.$code.''; + } else { + my ($categorylist,@cats); + if ($categories ne '') { + @cats = split('&',$categories); } - if ( defined($coursehash{'internal.autoend'}) ) { - $autoend = &Apache::lonlocal::locallocaltime($coursehash{'internal.autoend'}); + if ((ref($trails) eq 'ARRAY') && (ref($allitems) eq 'HASH')) { + my @categories = map { $trails->[$allitems->{$_}]; } @cats; + $categorylist = join('
',@categories); } - if ($coursehash{'internal.autostart'} > $now) { - if ($coursehash{'internal.autoend'} && $coursehash{'internal.autoend'} < $now) { - $autoenrolldates = &mt('Not enabled'); - } else { - my $valid_classes = &get_valid_classes($seclist,$xlist_items, - $code,$owner,$cdom,$cnum); - if ($valid_classes ne '') { - $autoenrolldates = &mt('Not enabled
Starts: '). - $autostart.'
'.$valid_classes; - } + if ($categorylist eq '') { + $categorylist = ' '; + } + $output .= ''.$categorylist.''; + } + $output .= ''.$seclist.''. + ''.$xlist_items.''. + ''.$title.' '; + if ($showsyllabus) { + $output .= ''.&mt('Syllabus').''; + } else { + $output .= ' '; + } + $output .= ''. + ''.$ownerlast.''; + if ($knownuser) { + if ($details) { + if ($env{'form.currcat_0'} eq 'communities::0') { + $output .= ''.$accessdates.''; + } else { + $output .= + ''.$accessdates.''. + ''.$counts.''. + ''.$autoenrollment.''; } } else { - if ($coursehash{'internal.autoend'} && $coursehash{'internal.autoend'} < $now) { - $autoenrolldates = &mt('Not enabled
Ended: ').$autoend; - } else { - my $valid_classes = &get_valid_classes($seclist,$xlist_items, - $code,$owner,$cdom,$cnum); - if ($valid_classes ne '') { - $autoenrolldates = &mt('Currently enabled
'). - $valid_classes; - } + $output .= "".&mt('Show more details').''; + } + } + my $selfenroll; + if ($info->{'selfenroll_types'}) { + my $showstart = &Apache::lonlocal::locallocaltime($info->{'selfenroll_start'}); + my $showend = &Apache::lonlocal::locallocaltime($info->{'selfenroll_end'}); + if (($info->{'selfenroll_end'} > 0) && ($info->{'selfenroll_end'} > $now)) { + if (($info->{'selfenroll_start'} > 0) && ($info->{'selfenroll_start'} > $now)) { + $output .= ''.&mt('Starts: [_1]',''.$showstart.'').'
'.&mt('Ends: [_1]',''.$showend.'').''; + } else { + $output .= ''.&mt('Enroll in course').''; } + $selfenroll = 1; } } - if (defined($coursehash{'showsyllabus'})) { - $showsyllabus = $coursehash{'showsyllabus'}; - } - foreach my $status ('Active','Future','Expired') { - $countslist .= ''.$status_title{$status}.': '. - $student_count{$status}.'
'; - } - if ($xlist_items eq '') { - $xlist_items = &mt('No'); - } - $output = ''.$coursehash{'internal.coursecode'}.''. - ''.$seclist.''. - ''.$xlist_items.''. - ''.$title.' '; - if ($showsyllabus) { - $output .= &Apache::loncommon::syllabuswrapper(&mt('Syllabus'),$cnum,$cdom); + if (!$selfenroll) { + $output .= ' '; } - $output .= ''. - ''.$ownerlast.''. - ''.$countslist.''. - ''.$accessdates.''. - ''.$autoenrolldates.''; + $$countref ++; return $output; } @@ -407,21 +1051,22 @@ sub identify_sections { } } @secnums = sort {$a <=> $b} @secnums; - my $seclist = join(', ',@secnums); - return $seclist; + $seclist = join(', ',@secnums); + my $numsec = @secnums; + return ($seclist,$numsec); } sub get_valid_classes { - my ($seclist,$xlist_items,$crscode,$owner,$cdom,$cnum) = @_; + my ($seclist,$xlist_items,$crscode,$owners,$cdom,$cnum) = @_; my $response; my %validations; @{$validations{'sections'}} = (); @{$validations{'xlists'}} = (); my $totalitems = 0; if ($seclist) { - foreach my $sec (split(',',$seclist)) { + foreach my $sec (split(/, /,$seclist)) { my $class = $crscode.$sec; - if (&Apache::lonnet::auto_validate_class_sec($cdom,$cnum,$owner, + if (&Apache::lonnet::auto_validate_class_sec($cdom,$cnum,$owners, $class) eq 'ok') { if (!grep(/^\Q$sec$\E/,@{$validations{'sections'}})) { push(@{$validations{'sections'}},$sec); @@ -431,8 +1076,8 @@ sub get_valid_classes { } } if ($xlist_items) { - foreach my $item (split(',',$xlist_items)) { - if (&Apache::lonnet::auto_validate_class_sec($cdom,$cnum,$owner, + foreach my $item (split(/, /,$xlist_items)) { + if (&Apache::lonnet::auto_validate_class_sec($cdom,$cnum,$owners, $item) eq 'ok') { if (!grep(/^\Q$item$\E/,@{$validations{'xlists'}})) { push(@{$validations{'xlists'}},$item); @@ -443,17 +1088,65 @@ sub get_valid_classes { } if ($totalitems > 0) { if (@{$validations{'sections'}}) { - $response = &mt('Sections: '). - join(',',@{$validations{'sections'}}).'
'; + $response = &mt('Sections:').' '. + join(', ',@{$validations{'sections'}}).'
'; } if (@{$validations{'xlists'}}) { - $response .= &mt('Courses: '). - join(',',@{$validations{'xlists'}}); + $response .= &mt('Courses:').' '. + join(', ',@{$validations{'xlists'}}); } } return $response; } +sub autoenroll_info { + my ($coursehash,$now,$seclist,$xlist_items,$code,$owners,$cdom,$cnum) = @_; + my $autoenrolldates = &mt('Not enabled'); + if (defined($coursehash->{'internal.autoadds'}) && $coursehash->{'internal.autoadds'} == 1) { + my ($autostart,$autoend); + if ( defined($coursehash->{'internal.autostart'}) ) { + $autostart = &Apache::lonlocal::locallocaltime($coursehash->{'internal.autostart'}); + } + if ( defined($coursehash->{'internal.autoend'}) ) { + $autoend = &Apache::lonlocal::locallocaltime($coursehash->{'internal.autoend'}); + } + if ($coursehash->{'internal.autostart'} > $now) { + if ($coursehash->{'internal.autoend'} && $coursehash->{'internal.autoend'} < $now) { + $autoenrolldates = &mt('Not enabled'); + } else { + my $valid_classes = + &get_valid_classes($seclist,$xlist_items,$code, + $owners,$cdom,$cnum); + if ($valid_classes ne '') { + $autoenrolldates = &mt('Not enabled').'
' + .&mt('Starts: [_1]',$autostart) + .'
'.$valid_classes; + } + } + } else { + if ($coursehash->{'internal.autoend'} && $coursehash->{'internal.autoend'} < $now) { + $autoenrolldates = &mt('Not enabled').'
' + .&mt('Ended: [_1]',$autoend); + } else { + my $valid_classes = &get_valid_classes($seclist,$xlist_items, + $code,$owners,$cdom,$cnum); + if ($valid_classes ne '') { + $autoenrolldates = &mt('Currently enabled').'
'. + $valid_classes; + } + } + } + } + return $autoenrolldates; +} -1; +sub user_is_known { + my $known = 0; + if ($env{'user.name'} ne '' && $env{'user.name'} ne 'public' + && $env{'user.domain'} ne '' && $env{'user.domain'} ne 'public') { + $known = 1; + } + return $known; +} +1;