# The LearningOnline Network with CAPA
# Handler for displaying the course catalog interface
#
# $Id: coursecatalog.pm,v 1.84 2014/04/28 22:12:55 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();
my %domconfig =
&Apache::lonnet::get_dom('configuration',['coursecategories'],$codedom);
my $knownuser = &user_is_known();
my ($cathash,$cattype);
if (ref($domconfig{'coursecategories'}) eq 'HASH') {
$cathash = $domconfig{'coursecategories'}{'cats'};
if ($knownuser) {
$cattype = $domconfig{'coursecategories'}{'auth'};
} else {
$cattype = $domconfig{'coursecategories'}{'unauth'};
}
} else {
$cathash = {};
$cattype = 'std';
}
if ($cattype eq 'none') {
$r->print(&Apache::loncommon::start_page('Course/Community Catalog'));
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/coursecatalog",
text=>"Course/Community Catalog"});
$r->print(&Apache::lonhtmlcommon::breadcrumbs('Course/Community Catalog'));
if ($knownuser) {
$r->print('
'.&mt('No catalog of LON-CAPA courses/communities is provided for: [_1]',$domdesc).'
');
} else {
if ($domconfig{'coursecategories'}{'auth'} eq 'none') {
$r->print('
'.&mt('No catalog of LON-CAPA courses/communities is provided for: [_1]',$domdesc).'
');
} else {
$r->print('
'.&mt('The catalog of LON-CAPA courses/communities provided for: "[_1]" is only available to users who are logged in.',$domdesc).'
');
}
}
$r->print(&Apache::loncommon::end_page());
return OK;
}
my $cnum;
if ($cattype eq 'codesrch') {
my ($uniquecode,$codemsg,$brtext);
if ($env{'form.uniquecode'}) {
$uniquecode = $env{'form.uniquecode'};
$uniquecode =~ s/^\s+|\s+$//g;
}
my $js = ''."\n";
$r->print(&Apache::loncommon::start_page('Search for a Course/Community',$js));
if ($uniquecode =~ /^\w{6}$/) {
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/coursecatalog",
text=>"Course/Community Catalog"});
$brtext = 'Search Result';
} else {
$brtext = 'Course/Community Catalog';
}
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"/adm/coursecatalog",
text=>"$brtext"});
$r->print(&Apache::lonhtmlcommon::breadcrumbs('Course/Community Catalog'));
$r->print(&coursesearch($codedom,$domdesc,$uniquecode));
if ($uniquecode =~ /^\w{6}$/) {
$r->print('');
my $confname = $codedom.'-domainconfig';
my %codes = &Apache::lonnet::get('uniquecodes',[$uniquecode],$codedom,$confname);
if ($codes{$uniquecode}) {
$cnum = $codes{$uniquecode};
my %courses = &Apache::lonnet::courseiddump($codedom,'.',1,'.','.',
$cnum,undef,undef,'.',1);
if (keys(%courses)) {
$env{'form.coursenum'} = $cnum;
my %courseinfo = &build_courseinfo_hash(\%courses,$knownuser,$codedom);
undef($env{'form.coursenum'});
if (ref($courseinfo{$codedom.'_'.$cnum}) eq 'HASH') {
$r->print(&Apache::lonhtmlcommon::start_pick_box());
my @cols = ('title','ownerlastnames','seclist','access');
my %lt = &Apache::lonlocal::texthash(
title => 'Title',
ownerlastnames => 'Owner & Co-owner(s)',
seclist => 'Sections',
access => 'Default Access Dates for Students',
);
my @shown;
foreach my $item (@cols) {
if ($courseinfo{$codedom.'_'.$cnum}{$item}) {
push(@shown,$item);
}
}
my $num = 0;
foreach my $item (@shown) {
$num ++;
$r->print(&Apache::lonhtmlcommon::row_title($lt{$item}).
$courseinfo{$codedom.'_'.$cnum}{$item});
if ($item eq 'title') {
if ($courseinfo{$codedom.'_'.$cnum}{'showsyllabus'}) {
$r->print(' '.
''.
&mt('Syllabus').'');
}
}
my $arg = ( $num == scalar(@shown) ? 1 : '' );
$r->print(&Apache::lonhtmlcommon::row_closure($arg));
}
$r->print(&Apache::lonhtmlcommon::end_pick_box());
my $selfenroll = &selfenroll_status($courseinfo{$codedom.'_'.$cnum},$codedom.'_'.$cnum);
if ($selfenroll) {
$r->print(' '.$selfenroll);
}
$r->print(''."\n");
} else {
$codemsg = &mt('Code matched, but course ID to which this mapped is invalid.');
}
} else {
$codemsg = &mt('Code matched, but course ID to which this mapped is invalid.');
}
} else {
$codemsg = &mt('No match');
}
}
$r->print(' '.&Apache::loncommon::end_page());
return OK;
} else {
if ($env{'form.coursenum'}) {
$cnum = $env{'form.coursenum'};
}
}
if ($env{'form.catalog_maxdepth'} ne '') {
$env{'form.catalog_maxdepth'} =~ s{\D}{}g;
}
my (@cats,@trails,%allitems,%idx,@jsarray,%subcathash,$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 '') && ($knownuser)) {
&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 .= <'."\n".$catjs."\n".'';
&cat_header($r,$codedom,$catjs,\%add_entries,$catlinks,undef,$cattype);
if ($env{'form.currcat_0'} ne '') {
$r->print('
');
}
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').
'
';
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 .= '
'.
'';
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 .= '
';
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;
$output .= &construct_data_table($knownuser,$domain,\%courses,$details,undef,
$now,$trails,$allitems);
$output .= "\n".'';
return $output;
}
sub construct_data_table {
my ($knownuser,$domain,$courses,$details,$usersections,$now,$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 .= '