--- loncom/interface/coursecatalog.pm 2008/02/15 02:30:14 1.26 +++ loncom/interface/coursecatalog.pm 2008/06/27 04:59:45 1.32 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler for displaying the course catalog interface # -# $Id: coursecatalog.pm,v 1.26 2008/02/15 02:30:14 raeburn Exp $ +# $Id: coursecatalog.pm,v 1.32 2008/06/27 04:59:45 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -54,7 +54,8 @@ sub handler { &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::default_login_domain(); + + my $codedom = &Apache::lonnet::default_login_domain(); if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne 'public')) { $codedom = $env{'user.domain'}; @@ -63,18 +64,43 @@ sub handler { } } 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(); if ($env{'form.coursenum'} ne '' && &user_is_known()) { &course_details($r,$codedom,$formname,$domdesc); } else { - my $numtitles = &course_selector($r,$codedom,$formname,$domdesc); - if ($env{'form.state'} eq 'listing') { - $r->print(&print_course_listing($codedom,$numtitles).'
'); + my $catlinks = &category_breadcrumbs($codedom); + my $catjs = <<"ENDSCRIPT"; + +function setCatDepth(depth) { + document.coursecats.catalog_maxdepth.value = depth; + document.coursecats.submit(); + return; +} + +ENDSCRIPT + my $numtitles; + if ($env{'form.currcat_0'} eq 'instcode::0') { + $numtitles = &instcode_course_selector($r,$codedom,$formname,$domdesc, + $catlinks,$catjs); + if ($env{'form.state'} eq 'listing') { + $r->print(&print_course_listing($codedom,$numtitles)); + } + } else { + my (%add_entries); + $catjs = ''; + &cat_header($r,$codedom,$catjs,\%add_entries,$catlinks); + if ($env{'form.currcat_0'} ne '') { + $r->print(&print_course_listing($codedom)); + } } } - $r->print(&Apache::loncommon::end_page()); + $r->print('
'.&Apache::loncommon::end_page()); return OK; } @@ -100,7 +126,7 @@ 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(''. &mt('Back to course listing').''. @@ -109,8 +135,8 @@ sub course_details { '
'); } -sub course_selector { - my ($r,$codedom,$formname,$domdesc) = @_; +sub instcode_course_selector { + my ($r,$codedom,$formname,$domdesc,$catlinks,$catjs) = @_; my %coursecodes = (); my %codes = (); my @codetitles = (); @@ -128,6 +154,9 @@ sub course_selector { my $totcodes = 0; my $jscript = ''; my ($numtitles,$lasttitle); + my %add_entries = (topmargin => "0", + marginheight => "0",); + my $js; $totcodes = &Apache::courseclassifier::retrieve_instcodes(\%coursecodes,$codedom); if ($totcodes > 0) { $format_reply = &Apache::lonnet::auto_instcode_format($caller,$codedom,\%coursecodes,\%codes,\@codetitles,\%cat_titles,\%cat_order); @@ -187,48 +216,65 @@ function setElements() { $jscript .= qq| function changeSort(caller) { document.$formname.sortby.value = caller; + copy_filters(); document.$formname.submit(); } function setCourseId(caller) { - document.$formname.coursenum.value = caller; - document.$formname.submit(); + document.$formname.coursenum.value = caller; + copy_filters(); + document.$formname.submit(); }\n|; } } - my $js = ''; - my %add_entries = (topmargin => "0", - marginheight => "0",); + $jscript .= qq| +function copy_filters() { + if (document.coursecats.showselfenroll.checked) { + document.$formname.showselfenroll.value = '1'; + } else { + document.$formname.showselfenroll.value = ''; + } +|; + if (&user_is_dc($codedom)) { + $jscript .= qq| + if (document.coursecats.showhidden.checked) { + document.$formname.showhidden.value = '1'; + } else { + document.$formname.showhidden.value = ''; + } + if (document.coursecats.showdetails.checked) { + document.$formname.showdetails.value = '1'; + } else { + document.$formname.showdetails.value = ''; + } +|; + } + $jscript .= qq| +} + +function display_courses() { + copy_filters(); + document.$formname.submit(); +} + +|; + $js = ''; if (($env{'form.state'} eq 'listing') && ($numtitles > 0)) { $add_entries{'onLoad'} = 'setElements()'; } - my $start_page = - &Apache::loncommon::start_page('Course Catalog',$js, - { - 'add_entries' => \%add_entries, - 'no_inline_link' => 1,}); - $r->print($start_page); - if ($env{'form.state'} eq 'listing') { - if ($numtitles > 0) { - &Apache::lonhtmlcommon::add_breadcrumb - ({href=>"/adm/coursecatalog", - text=>"Select courses"}, - {text=>"Course listing"}); - } else { - &Apache::lonhtmlcommon::add_breadcrumb - ({text=>"Course listing"}); - } - $r->print(&Apache::lonhtmlcommon::breadcrumbs('Course Listing')); - } else { - &Apache::lonhtmlcommon::add_breadcrumb - ({href=>"/adm/coursecatalog", - text=>"Select courses"}); - $r->print(&Apache::lonhtmlcommon::breadcrumbs('Select courses')); + &cat_header($r,$codedom,$js,\%add_entries,$catlinks,$numtitles); + my $cat_maxdepth = $env{'form.catalog_maxdepth'}; + $r->print('
'. + ''."\n". + ''."\n". + ''. + ''."\n"); + if (&user_is_dc($codedom)) { + $r->print(''."\n". + ''."\n"); } - $r->print('

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

'); - $r->print(''); 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); @@ -259,40 +305,195 @@ function setCourseId(caller) { ''."\n". - '' - ); - if (&user_is_dc($codedom)) { - my $showdetails_status; - if ($env{'form.showdetails'}) { - $showdetails_status = 'checked="checked" '; - } - $r->print(''); - } - $r->print('
'.&mt('Show full details for each course (DC only)').'
'); + ''."\n"); if ($numtitles > 4) { $r->print('

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

'); + $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)); + &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 Catalog',$js, + { + 'add_entries' => $add_entries, + 'no_inline_link' => 1,}); + $r->print($start_page); + if ($env{'form.state'} eq 'listing') { + if ($numtitles > 0) { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/coursecatalog", + text=>"Select courses"}, + {text=>"Course listing"}); + } else { + &Apache::lonhtmlcommon::add_breadcrumb + ({text=>"Course listing"}); + } + $r->print(&Apache::lonhtmlcommon::breadcrumbs('Course Listing')); + } else { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/coursecatalog", + text=>"Select courses"}); + $r->print(&Apache::lonhtmlcommon::breadcrumbs('Select courses')); + } + $r->print(''. + ''. + ''. + ''. + $catlinks.''); + 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" '; + } + my $showhidden_status; + if ($env{'form.showhidden'}) { + $showhidden_status = 'checked="checked" '; + } + $r->print(''); + } + $r->print('
'.&mt('Domain:').''. + &Apache::loncommon::select_dom_form($codedom,'showdom','',1). + ' 
'. + '

'); + return; +} + +sub category_breadcrumbs { + my ($dom) = @_; + my %domconfig = + &Apache::lonnet::get_dom('configuration',['coursecategories'],$dom); + my (@cats,@trails,%allitems,%idx,@jsarray,$cathash); + if (ref($domconfig{'coursecategories'}) eq 'HASH') { + $cathash = $domconfig{'coursecategories'}{'cats'}; + } else { + $cathash = {}; + } + &Apache::loncommon::extract_categories($cathash,\@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 $catlinks = ''.&mt('Catalog:').''; + for (my $i=0; $i<$deeper; $i++) { + $currcat_str .= ''; + my ($cattitle,$shallower); + if ($i == 0) { + $cattitle = &mt('Main Categories'); + } else { + $shallower = $i-1; + my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$env{'form.currcat_'.$shallower}); + $cattitle = $cat; + } + $catlinks .= ''; + } + if ($deeper == 0) { + $catlinks .= '
'.$cattitle.'->'.&mt('Main Categories').': '; + 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 { + $catlinks .= ''."\n". + ' '; + } + } else { + $catlinks .= &mt('Official courses (with institutional codes)'). + ''; + $env{'form.currcat_0'} = 'instcode::0'; + } + } else { + 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 $deeper = $depth +1; + my $currcat = $cat; + if ($cat eq 'instcode') { + $currcat = &mt('Official courses (with institutional codes)'); + } + $catlinks .= ''.$currcat; + if (ref($cats[$deeper]{$cat}) eq 'ARRAY') { + $catlinks .= ': '."\n". + ' '; + } + } + $catlinks .= $currcat_str.'
'; + return $catlinks; +} + sub user_is_dc { my ($codedom) = @_; if (exists($env{'user.role.dc./'.$codedom.'/'})) { @@ -389,7 +590,7 @@ sub build_javascript { return $output; } -sub search_courselist { +sub search_official_courselist { my ($domain,$numtitles) = @_; my $instcode; if (defined($numtitles) && $numtitles == 0) { @@ -413,11 +614,38 @@ sub search_courselist { $instcode = '.'; } } - my %courses = &Apache::lonnet::courseiddump($domain,'.',1,$instcode,'.','.', - undef,undef,'Course',1); + 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 $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; + if ($filter ne '') { + my $showhidden; + if (&user_is_dc($domain)) { + $showhidden = $env{'form.showhidden'}; + } + %courses = + &Apache::lonnet::courseiddump($domain,'.',1,'.','.','.',undef,undef, + '.',1,$env{'form.showselfenroll'}, + $filter,$showhidden,'coursecatalog'); + } + return %courses; +} sub print_course_listing { my ($domain,$numtitles) = @_; @@ -439,22 +667,31 @@ sub print_course_listing { return $output; } } else { - %courses = &search_courselist($domain,$numtitles); + if ($env{'form.currcat_0'} eq 'instcode::0') { + %courses = &search_official_courselist($domain,$numtitles); + } else { + %courses = &search_courselist($domain); + } 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.') + .'

'; } } - $output .= &construct_data_table($knownuser,\%courses,$details); + 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']); return $output; } sub construct_data_table { - my ($knownuser,$courses,$details,$usersections) = @_; + my ($knownuser,$courses,$details,$usersections,$now,$domconfig) = @_; my %sortname; if (($details eq '') || ($env{'form.showdetails'})) { $sortname{'Code'} = 'code'; @@ -485,9 +722,10 @@ sub construct_data_table { ''.&mt('Student Counts').''. ''.&mt('Auto-enrollment of
registered students').''; } else { - $output .= ' '; + $output .= ''.&mt('Details').''; } } + $output .= ''.&mt('Self-enroll (if permitted)').''; &Apache::loncommon::end_data_table_header_row(); my %courseinfo = &build_courseinfo_hash($courses,$knownuser,$details, $usersections); @@ -516,7 +754,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); + $output.=&courseinfo_row($courseinfo{$course},$knownuser, + $details,\$count,$now,$course); $output.=&Apache::loncommon::end_data_table_row(); } } @@ -537,12 +776,16 @@ sub build_courseinfo_hash { $cleandesc=~s/'/\\'/g; $cleandesc =~ s/^\s+//; my ($cdom,$cnum)=split(/\_/,$course); - my ($descr,$instcode,$singleowner,$ttype,@owners,%ownernames); + my ($descr,$instcode,$singleowner,$ttype,$selfenroll_types, + $selfenroll_start,$selfenroll_end,@owners,%ownernames); 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'}; push(@owners,$singleowner); if (ref($courses->{$course}{'co-owners'}) eq 'ARRAY') { foreach my $item (@{$courses->{$course}{'co-owners'}}) { @@ -577,6 +820,9 @@ sub build_courseinfo_hash { $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; my %coursehash = &Apache::lonnet::dump('environment',$cdom,$cnum); my @classids; @@ -660,7 +906,7 @@ sub count_students { } sub courseinfo_row { - my ($info,$knownuser,$details,$countref) = @_; + my ($info,$knownuser,$details,$countref,$now,$course) = @_; my ($cdom,$cnum,$title,$ownerlast,$code,$owner,$seclist,$xlist_items, $accessdates,$showsyllabus,$counts,$autoenrollment,$output); if (ref($info) eq 'HASH') { @@ -703,6 +949,22 @@ sub courseinfo_row { $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 (!$selfenroll) { + $output .= ' '; + } $$countref ++; return $output; }