# The LearningOnline Network with CAPA # Handler for displaying the course catalog interface # # $Id: coursecatalog.pm,v 1.79 2014/03/17 01:48:34 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ # package Apache::coursecatalog; 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::courseclassifier; use Apache::lonacc; use LONCAPA; sub handler { my ($r) = @_; &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; 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','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 '') { $env{'form.showdom'} = &LONCAPA::clean_domain($env{'form.showdom'}); if (&Apache::lonnet::domain($env{'form.showdom'}) ne '') { $codedom = $env{'form.showdom'}; } else { $env{'form.showdom'} = ''; } } my $domdesc = &Apache::lonnet::domain($codedom,'description'); &Apache::lonhtmlcommon::clear_breadcrumbs(); if ($env{'form.catalog_maxdepth'} ne '') { $env{'form.catalog_maxdepth'} =~ s{\D}{}g; } 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()) { &course_details($r,$codedom,$formname,$domdesc,\@trails,\%allitems,\@codetitles); } else { my ($catlinks,$has_subcats,$selitem) = &category_breadcrumbs($codedom,@cats); my $wasacctext = &get_wasactive_text(); 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 (&user_is_dc($codedom)) { $catjs .= <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'). '

'. (($env{'form.currcat_0'} eq 'communities::0') ? &mt('Detailed community information:') : &mt('Detailed course information:')). '

'. &print_course_listing($codedom,undef,$trails,$allitems,undef,$codetitles). '
'. '
'. &Apache::lonhtmlcommon::actionbox([ ''. (($env{'form.currcat_0'} eq 'communities::0') ? &mt('Back to community listing') : &mt('Back to course listing')). '' ]). &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 %cat_titles = (); my %cat_order = (); my %cat_items; my $caller = 'global'; my $format_reply; my %add_entries = (topmargin => "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();'; } if (&user_is_dc($codedom)) { $add_entries{'onLoad'} .= ' toggleStatuses();toggleWasActive();' } &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". ''. '


'); } 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).'
'); } return $numtitles; } sub cat_header { my ($r,$codedom,$js,$add_entries,$catlinks,$numtitles) = @_; my $start_page = &Apache::loncommon::start_page('Course/Community Catalog',$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) { &Apache::lonhtmlcommon::add_breadcrumb ({href=>"/adm/coursecatalog", text=>"Course/Community Catalog"}, {text=>$brtext}); } else { &Apache::lonhtmlcommon::add_breadcrumb ({text=>$brtext}); } } else { &Apache::lonhtmlcommon::add_breadcrumb ({href=>"/adm/coursecatalog", text=>"Course/Community Catalog"}); } $r->print(&Apache::lonhtmlcommon::breadcrumbs('Course/Community Catalog')); my $onchange = 'this.form.submit()'; $r->print('
'. '
'.&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:').'
'; 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 { my $name = $cats[0][0]; my $item = &escape($name).'::0'; $catlinks .= $name; $env{'form.currcat_0'} = $item; } $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 .= &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 .= ''. ''; } 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.'
'; 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 $is_dc = &user_is_dc($codedom); my $output = '
'; if ($is_dc) { $output .= '
'.&mt('Options').''; } $output .= ''."\n". ''; } else { $output .= ''; } $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" '; } my $selfenroll_text; if ($env{'form.currcat_0'} eq 'communities::0') { $selfenroll_text = &mt('Only show communities which currently allow self-enrollment (or will allow it in the future)'); } else { $selfenroll_text = &mt('Only show courses which currently allow self-enrollment (or will allow it in the future)'); } $output .= ''. '
'; if ($is_dc) { my ($titlesref,$orderref) = &get_statustitles('filters'); my $showdetails_status; if ($env{'form.showdetails'}) { $showdetails_status = 'checked="checked" '; } my $showhidden_status; if ($env{'form.showhidden'}) { $showhidden_status = 'checked="checked" '; } my @currstatuses = &Apache::loncommon::get_env_multiple('form.showcounts'); my $dc_title = &Apache::lonnet::plaintext('dc'); my ($details_text,$hidden_text,$statusdisplay,$cellborder); my $wasactivedisplay = 'none'; if ($env{'form.showdetails'}) { $statusdisplay = 'block'; $cellborder = 'border-left: 1px solid;'; if (grep(/^Previous$/,@currstatuses)) { $wasactivedisplay = 'block'; } } else { $statusdisplay = 'none'; $cellborder = 'border-left: 0px'; } 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". ''. '
'. '
'; if (ref($orderref) eq 'ARRAY') { if (@{$orderref} > 0) { foreach my $type (@{$orderref}) { my $checked; if (grep(/^\Q$type\E$/,@currstatuses)) { $checked = ' checked="checked"'; } my $title; if (ref($titlesref) eq 'HASH') { $title = $titlesref->{$type}; } unless ($title) { $title = &mt($type); } my $onclick; if ($type eq 'Previous') { $onclick = ' onclick="toggleWasActive();"'; } $output .= ''. ''; if ($type eq 'Previous') { my %milestonetext = &Apache::lonlocal::texthash ( accessend => 'immediately prior to default end access date', enrollend => 'immediately prior to end date for auto-enrollment', date => 'immediately prior to specific date:', ); my @statuses = &Apache::loncommon::get_env_multiple('form.showcounts'); $output .= ''; if ($checked) { $output .= &get_wasactive_text(); } $output .= ''. '
'. ''; my @milestones = ('accessend'); if (&Apache::lonnet::auto_run(undef,$codedom)) { push(@milestones,'enrollend'); } push(@milestones,'date'); foreach my $item (@milestones) { my $checked; if ($env{'form.state'} eq 'listing') { if ($env{'form.wasactive'} eq $item) { $checked = ' checked="checked"'; } } elsif ($item eq 'accessend') { $checked = ' checked="checked"'; } $output .= ''; } $output .= '
 '. ''; if ($item eq 'date') { my $wasactiveon; if (grep(/^Previous$/,@currstatuses)) { $wasactiveon = &Apache::lonhtmlcommon::get_date_from_form('wasactiveon'); } else { $wasactiveon = 'now'; } $output .= ' '. &Apache::lonhtmlcommon::date_setter('coursecatalog', 'wasactiveon', $wasactiveon, '','','',1,'', '','',1); } $output .= '
'; } $output .= '
'; } } } $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 get_statustitles { my ($caller) = @_; my @status_order = ('Active','Future','Previous'); my %status_title; if ($caller eq 'filters') { %status_title = &Apache::lonlocal::texthash( Previous => 'Show count for past access', Active => 'Show count for current student access', Future => 'Show count for future student access', ); if ($env{'form.currcat_0'} eq 'communities::0') { $status_title{'Active'} = 'Show count for current member access'; $status_title{'Future'} = 'Show count for future member access'; } } else { %status_title = &Apache::lonlocal::texthash( Previous => 'Previous access', Active => 'Current access', Future => 'Future access', ); } return (\%status_title,\@status_order); } sub get_wasactive_text { my $wasacctext = ' -- '; if ($env{'form.currcat_0'} eq 'communities::0') { $wasacctext .= &mt('where member access status was current ...'); } else { $wasacctext .= &mt('where student access status was current ...'); } return $wasacctext; } 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,$numtitles,$trails,$allitems,$subcats,$codetitles) = @_; my $output; my %courses; my $knownuser = &user_is_known(); my $details = $env{'form.coursenum'}; if (&user_is_dc($domain)) { if ($env{'form.showdetails'}) { $details = 1; } } if ($env{'form.coursenum'} ne '') { %courses = &Apache::lonnet::courseiddump($domain,'.',1,'.','.', $env{'form.coursenum'}, undef,undef,'.',1); if (keys(%courses) == 0) { $output = '

'; 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.'); } $output .= '

'; return $output; } } else { if ($env{'form.currcat_0'} eq 'instcode::0') { %courses = &search_official_courselist($domain,$numtitles,$codetitles); } else { %courses = &search_courselist($domain,$subcats); } if (keys(%courses) == 0) { $output = '

'; 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.'); } $output .= '

'; return $output; } 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,$domain,\%courses,$details,undef, $now,\%domconfig,$trails,$allitems); $output .= "\n".'
'. ''. ''. &Apache::lonhtmlcommon::echo_form_input(['catalogfilter','courseid']).'
'; return $output; } sub construct_data_table { my ($knownuser,$domain,$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 & Co-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 & Co-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 .= ''; } my (@fields,%fieldtitles,$wasactiveon); if ($knownuser) { if ($details) { if ($env{'form.currcat_0'} eq 'communities::0') { $output .= ''.&mt('Default Access Dates for Members').''. ''.&mt('Member Counts').''; } else { $output .= ''.&mt('Default Access Dates for Students').''. ''.&mt('Student Counts').''. ''.&mt('Auto-enrollment of[_1]registered students','
').''; } my ($titlesref,$orderref) = &get_statustitles(); my @statuses; if (&user_is_dc($domain)) { @statuses = &Apache::loncommon::get_env_multiple('form.showcounts'); if (grep(/^Previous$/,@statuses)) { if ($env{'form.wasactive'} eq 'date') { $wasactiveon = &Apache::lonhtmlcommon::get_date_from_form('wasactiveon'); } else { $wasactiveon = $env{'form.wasactive'}; } } if (ref($orderref) eq 'ARRAY') { foreach my $status (@{$orderref}) { if (grep(/^\Q$status\E$/,@statuses)) { push(@fields,$status); } } } } else { @fields = ('Active','Future'); } foreach my $status (@fields) { my $title; if (ref($titlesref) eq 'HASH') { $title = $titlesref->{$status}; } unless ($title) { $title = &mt($status); } $fieldtitles{$status} = $title; } } else { $output .= ''.&mt('Details').''; } } $output .= ''.&mt('Self-enroll (if permitted)').''; &Apache::loncommon::end_data_table_header_row(); my (%numbers,%creditsum); my ($showcredits,$defofficial,$defunofficial,$deftextbook); my %domdefaults = &Apache::lonnet::get_domain_defaults($domain); unless ($env{'form.currcat_0'} eq 'communities::0') { if ($domdefaults{'officialcredits'} || $domdefaults{'unofficialcredits'} || $domdefaults{'textbookcredits'}) { $showcredits = 1; $defofficial = $domdefaults{'officialcredits'}; $defunofficial = $domdefaults{'unofficialcredits'}; $deftextbook = $domdefaults{'textbookcredits'}; } } my %courseinfo = &build_courseinfo_hash($courses,$knownuser,$domain,$details, $usersections,\@fields,\%fieldtitles, $wasactiveon,\%numbers,\%creditsum, $showcredits,$defofficial,$defunofficial,$deftextbook); my %Sortby; 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 { 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') || ($env{'form.sortby'} eq 'cats')) { @sorted_courses = sort(keys(%Sortby)); } else { @sorted_courses = sort { lc($a) cmp lc($b) } (keys(%Sortby)); } my $count = 1; my $totalsec = 0; 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,$trails,$allitems,\%numbers); $output.=&Apache::loncommon::end_data_table_row(); } } if (($knownuser) && ($count > 1) && $env{'form.showdetails'}) { if (&user_is_dc($domain)) { my %lt = &Apache::lonlocal::texthash ( 'Active' => 'Total current students', 'Future' => 'Total future students', 'Previous' => 'Total previous students', 'courses' => 'Total unique codes and courses without codes', 'sections' => 'Total sections', 'xlists' => 'Total cross-listings', ); if ($showcredits) { $lt{'cr_Active'} = &mt('Total current student credit hours'); $lt{'cr_Future'} = &mt('Total future student credit hours'); $lt{'cr_Previous'} = &mt('Total previous student credit hours'); } if ($env{'form.currcat_0'} eq 'communities::0') { $lt{'courses'} = &mt('Total communities'); $lt{'Active'} = &mt('Total current members'); $lt{'Future'} = &mt('Total future members'); $lt{'Previous'} = &mt('Total previous members'); } my $colspan = 8; if ($showcredits) { $colspan = 4; } $output .= ''. ' '. ''. ''; foreach my $item ('courses','sections','xlists') { $output .= ''. ''. ''. ''."\n"; } if (@fields > 0) { foreach my $status (@fields) { $output .= ''. ''. ''. ''."\n"; } } $output .= '
'.$lt{$item}.' '.$numbers{$item}.'
'.$lt{$status}.' '.$numbers{$status}.'
'; if ($showcredits) { $output .= ''; foreach my $status (@fields) { $output .= ''. ''. ''; } $output .= '
'.$lt{'cr_'.$status}.' '.$creditsum{$status}.'
'; } } } $output .= &Apache::loncommon::end_data_table(); return $output; } sub build_courseinfo_hash { my ($courses,$knownuser,$domain,$details,$usersections,$fields,$fieldtitles, $wasactiveon,$numbers,$creditsum,$showcredits,$defofficial,$defunofficial) = @_; my %courseinfo; my $now = time; my $gettotals; if ((keys(%{$courses}) > 0) && (&user_is_dc($domain)) && ($details)) { $gettotals = 1; } my (%uniquecodes,$nocodes,$defcreds); 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 ($courses->{$course}{'co-owners'} ne '') { foreach my $item (split(/,/,$courses->{$course}{'co-owners'})) { push(@owners,$item); } } } if ($instcode ne '') { $uniquecodes{$instcode} = 1; } else { $nocodes ++; } 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'}); $courseinfo{$course}{'seclist'} = $seclist; my ($xlist_items,$numxlist) = &identify_sections($coursehash{'internal.crosslistings'}); if (ref($numbers) eq 'HASH') { $numbers->{'sections'} += $numsec; $numbers->{'xlists'} += $numxlist; } my $showsyllabus = 1; # default is to include a syllabus link if (defined($coursehash{'showsyllabus'})) { $showsyllabus = $coursehash{'showsyllabus'}; } $courseinfo{$course}{'showsyllabus'} = $showsyllabus; if ($showcredits) { if ($coursehash{'internal.defaultcredits'}) { $courseinfo{$course}{'defaultcredits'} = $coursehash{'internal.defaultcredits'}; } elsif ($instcode ne '') { $courseinfo{$course}{'defaultcredits'} = $defofficial; } else { $courseinfo{$course}{'defaultcredits'} = $defunofficial; } $defcreds = $courseinfo{$course}{'defaultcredits'}; } if (((defined($env{'form.coursenum'}) && ($cnum eq $env{'form.coursenum'}))) || ($knownuser && ($details == 1))) { my $milestone; if ($wasactiveon eq 'accessend') { if ($coursehash{'default_enrollment_end_date'}) { $milestone = $coursehash{'default_enrollment_end_date'}; } else { $milestone = time; } } elsif ($wasactiveon eq 'enrollend') { if ($coursehash{'internal.autoend'}) { $milestone = $coursehash{'internal.autoend'}; } else { $milestone = time; } } else { $milestone = $wasactiveon; } $courseinfo{$course}{'counts'} = &count_students($cdom,$cnum,$numsec,$fields,$fieldtitles,$gettotals, $numbers,$creditsum,$showcredits,$defcreds,$milestone); if ($instcode ne '') { $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; } if (ref($numbers) eq 'HASH') { $numbers->{'courses'} = $nocodes + scalar(keys(%uniquecodes)); } return %courseinfo; } sub count_students { my ($cdom,$cnum,$numsec,$fieldsref,$titlesref,$getcounts,$numbers,$creditsum, $showcredits,$defcreds,$wasactiveon) = @_; my $countslist = ''. &mt('[quant,_1,section,sections,No sections]',$numsec).''; my (@fields,%titles,$showexpired); if ((ref($fieldsref) eq 'ARRAY') && (ref($titlesref) eq 'HASH') && (ref($numbers) eq 'HASH')) { @fields = @{$fieldsref}; %titles = %{$titlesref}; if (grep(/^Previous$/,@fields)) { $showexpired = 1; } } else { return; } my $classlist = &Apache::loncoursedata::get_classlist($cdom,$cnum); my (%student_count,%credit_count); %student_count = ( Active => 0, Future => 0, Previous => 0, ); if ($showcredits) { %credit_count = ( Active => 0, Future => 0, Previous => 0, ); } my %idx; $idx{'status'} = &Apache::loncoursedata::CL_STATUS(); $idx{'end'} = &Apache::loncoursedata::CL_END(); $idx{'credits'} = &Apache::loncoursedata::CL_CREDITS(); while (my ($student,$data) = each(%$classlist)) { my $status = $data->[$idx{'status'}]; my $credits = $data->[$idx{'credits'}]; if ($credits eq '') { $credits = $defcreds; } if ($status eq 'Expired') { if (($showexpired) && ($data->[$idx{'end'}] >= $wasactiveon)) { $student_count{'Previous'} ++; if ($showcredits) { $credit_count{'Previous'} += $credits; } } } else { $student_count{$status} ++; if ($showcredits) { $credit_count{$status} += $credits; } } } if (@fields) { $countslist .= ':
'; foreach my $status (@fields) { $countslist .= ''.$titles{$status}.': '. $student_count{$status}.'
'; $numbers->{$status} += $student_count{$status}; if ($showcredits) { $creditsum->{$status} += $credit_count{$status}; } } } return $countslist; } sub courseinfo_row { my ($info,$knownuser,$details,$countref,$now,$course,$trails,$allitems,$numbers) = @_; 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; } $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 .= ''.&mt('Syllabus').''; } else { $output .= ' '; } $output .= ''. ''.$ownerlast.''; if ($knownuser) { if ($details) { $output .= ''.$accessdates.''. ''.$counts.''; unless ($env{'form.currcat_0'} eq 'communities::0') { $output .= ''.$autoenrollment.''; } } else { $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').'
'; if ($info->{'selfenroll_end'} == 0) { $output .= &mt('Available permanently'); } elsif ($info->{'selfenroll_end'} > $now) { $output .= &mt('Self-enrollment ends: [_1]',''.$showend.''); } $output .= ''; } $selfenroll = 1; } } if (!$selfenroll) { $output .= ' '; } $$countref ++; return $output; } sub identify_sections { my ($seclist) = @_; my @secnums; if ($seclist =~ /,/) { my @sections = split(/,/,$seclist); foreach my $sec (@sections) { $sec =~ s/:[^:]*$//; push(@secnums,$sec); } } else { if ($seclist =~ m/^([^:]+):/) { my $sec = $1; if (!grep(/^\Q$sec\E$/,@secnums)) { push(@secnums,$sec); } } } @secnums = sort {$a <=> $b} @secnums; $seclist = join(', ',@secnums); my $numsec = @secnums; return ($seclist,$numsec); } sub get_valid_classes { 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)) { my $class = $crscode.$sec; if (&Apache::lonnet::auto_validate_class_sec($cdom,$cnum,$owners, $class) eq 'ok') { if (!grep(/^\Q$sec$\E/,@{$validations{'sections'}})) { push(@{$validations{'sections'}},$sec); $totalitems ++; } } } } if ($xlist_items) { 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); $totalitems ++; } } } } if ($totalitems > 0) { if (@{$validations{'sections'}}) { $response = &mt('Sections:').' '. join(', ',@{$validations{'sections'}}).'
'; } if (@{$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; } 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;