# The LearningOnline Network with CAPA
# Handler for displaying the course catalog interface
#
# $Id: coursecatalog.pm,v 1.102 2019/07/23 13:58:53 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;
use LONCAPA::lonauthcgi;
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 $serverdefdom = &Apache::lonnet::default_login_domain();
my $codedom = $serverdefdom;
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($serverdefdom,'description');
&Apache::lonhtmlcommon::clear_breadcrumbs();
unless (($serverdefdom eq $codedom) ||
(&Apache::lonnet::will_trust('catalog',$serverdefdom,$codedom))) {
my $serverdomdesc = &Apache::lonnet::domain($serverdefdom,'description');
$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'));
$r->print('
'.&mt('Access to catalog LON-CAPA courses/communities unavailable for: "[_1]" on servers run by: "[_2]".',
$domdesc,$serverdomdesc).'
');
$r->print(&Apache::loncommon::end_page());
return OK;
}
my $crscats = &Apache::lonnet::get_dom_cats($codedom);
my %domdefaults = &Apache::lonnet::get_domain_defaults($codedom);
my $knownuser = &user_is_known();
my $canviewall = &canview_all($knownuser,$codedom);
my ($cathash,$cattype);
if (ref($crscats) eq 'HASH') {
%{$cathash} = %{$crscats};
} else {
$cathash = {};
}
if ($knownuser || $canviewall) {
$cattype = $domdefaults{'catauth'};
} else {
$cattype = $domdefaults{'catunauth'};
}
if ($cattype eq '') {
$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 || $canviewall) {
$r->print('
'.&mt('No catalog of LON-CAPA courses/communities is provided for: [_1]',$domdesc).'
');
} else {
if ($domdefaults{'catauth'} 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,$canviewall);
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'}) {
my $usehttp = 0;
if (($ENV{'SERVER_PORT'} == 443) && ($courseinfo{$codedom.'_'.$cnum}{'extsyllplain'})) {
unless (&Apache::lonnet::uses_sts()) {
$usehttp = 1;
}
}
$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'} ne '') {
if ($env{'form.coursenum'} =~ /^$LONCAPA::match_courseid$/) {
$cnum = $env{'form.coursenum'};
} else {
delete($env{'form.coursenum'});
}
}
}
my (@cats,@trails,%allitems,%idx,@jsarray,%subcathash,$subcats,%maxd,
$toplevelstr,$maxdepthstr);
if ($env{'form.withsubcats'}) {
$subcats = \%subcathash;
}
&Apache::loncommon::extract_categories($cathash,\@cats,\@trails,\%allitems,
\%idx,\@jsarray,$subcats,\%maxd);
if (ref($cats[0]) eq 'ARRAY') {
foreach my $item (@{$cats[0]}) {
$toplevelstr .= "'".&js_escape($item)."::0',";
$maxdepthstr .= "'$maxd{$item}',";
}
$toplevelstr =~ s/,$//;
$maxdepthstr =~ s/,$//;
}
&validate_input($codedom,\@cats,\%maxd,$cathash);
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) {
var depth = parseInt(depth);
if (depth !== NaN) {
if (depth > 0) {
var possmaxd = 0;
var toplevel = new Array($toplevelstr);
var maxdepths = new Array($maxdepthstr);
if (toplevel.length) {
for (var i=0; i possmaxd) {
depth = possmaxd;
}
}
document.coursecats.catalog_maxdepth.value = depth;
} else {
document.coursecats.currcat_0.value = '';
document.coursecats.catalog_maxdepth.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($r);
if (&user_is_dc($codedom) || $canviewall) {
$catjs .= <print(&print_course_listing($codedom,$numtitles,undef,undef,undef,
\@codetitles,$canviewall));
}
} 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');
}
&js_escape(\$alert);
$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,
$canviewall));
}
}
}
$r->print(' '.&Apache::loncommon::end_page());
return OK;
}
sub validate_input {
my ($codedom,$cats,$maxd,$crscatsref) = @_;
my $currcat = '';
my $depth = 0;
if ($env{'form.catalog_maxdepth'} ne '') {
$env{'form.catalog_maxdepth'} =~ s{\D}{}g;
}
if ((ref($cats) eq 'ARRAY') && (ref($maxd) eq 'HASH')) {
if (ref($cats->[0]) eq 'ARRAY') {
if (@{$cats->[0]} == 1) {
if ($cats->[0][0] eq 'instcode') {
$currcat = 'instcode::0';
} elsif ($cats->[0][0] eq 'communities') {
$currcat = 'communities::0';
} elsif ($cats->[0][0] eq 'placement') {
$currcat = 'placement::0';
} else {
my $name = $cats->[0][0];
$currcat = &escape($name).'::0';
}
if (exists($maxd->{$cats->[0][0]})) {
if ($env{'form.catalog_maxdepth'} <= $maxd->{$cats->[0][0]}) {
$depth = $env{'form.catalog_maxdepth'};
} else {
$depth = $maxd->{$cats->[0][0]};
}
}
} elsif ((@{$cats->[0]} > 1) && ($env{'form.currcat_0'} ne '')) {
my ($escname) = ($env{'form.currcat_0'} =~ /^([^:]+)\:\:0$/);
if ($escname =~ /^instcode|communities|placement$/) {
$currcat = $env{'form.currcat_0'};
if (exists($maxd->{$escname})) {
if ($env{'form.catalog_maxdepth'} <= $maxd->{$escname}) {
$depth = $env{'form.catalog_maxdepth'};
} else {
$depth = $maxd->{$escname};
}
} else {
$depth = 1;
}
} elsif ($escname ne '') {
my $name = &unescape($escname);
if (grep(/^\Q$name\E$/,@{$cats->[0]})) {
$currcat = $env{'form.currcat_0'};
if (exists($maxd->{$name})) {
if ($env{'form.catalog_maxdepth'} <= $maxd->{$name}) {
$depth = $env{'form.catalog_maxdepth'};
} else {
$depth = $maxd->{$name};
}
}
}
}
}
}
}
$env{'form.currcat_0'} = $currcat;
$env{'form.catalog_maxdepth'} = $depth;
my %possibles = (
backto => 1,
catalogfilter => 1,
catalog_maxdepth => 1,
courseid => 1,
coursenum => 1,
currcat_0 => 1,
numtitles => 1,
Year => 1,
Semester => 1,
Department => 1,
Number => 1,
showdom => 1,
sortby => 1,
showcounts => 1,
showdetails => 1,
showhidden => 1,
showselfenroll => 1,
state => 1,
uniquecode => 1,
wasactive => 1,
wasactiveon_day => 1,
wasactiveon_month => 1,
wasactiveon_year => 1,
withsubcats => 1,
);
my %currcats;
if ($env{'form.catalog_maxdepth'} > 0) {
for (my $i=1; $i<=$env{'form.catalog_maxdepth'}; $i++) {
$currcats{'currcat_'.$i} = 1;
$possibles{'currcat_'.$i} = 1;
}
}
foreach my $key (sort(keys(%env))) {
if ($key =~ /^form\.(.+)$/) {
unless ($possibles{$1}) {
delete($env{$key});
}
}
}
if (exists($env{'form.backto'})) {
unless ($env{'form.backto'} eq 'coursecatalog') {
delete($env{'form.backto'});
}
}
if (exists($env{'form.catalogfilter'})) {
unless (($env{'form.catalogfilter'} eq &mt('Display courses')) ||
($env{'form.catalogfilter'} eq &mt('Display communities')) ||
($env{'form.catalogfilter'} eq &mt('Display placement tests'))) {
delete($env{'form.catalogfilter'});
}
}
if (exists($env{'form.courseid'})) {
if ($env{'form.courseid'} ne '') {
unless ($env{'form.courseid'} =~ /^\Q$codedom\E_$LONCAPA::match_courseid$/) {
$env{'form.courseid'} = '';
}
}
}
if (exists($env{'form.coursenum'})) {
unless ($env{'form.coursenum'} =~ /^$LONCAPA::match_courseid$/) {
$env{'form.coursenum'} = '';
}
}
if (exists($env{'form.currcat_0'})) {
unless ($env{'form.currcat_0'} =~ /^(instcode|communities|placement)\Q::0\E$/) {
if ($env{'form.currcat_0'} =~ /^.+\Q::0\E$/) {
if (ref($crscatsref) eq 'HASH') {
unless (exists($crscatsref->{$env{'form.currcat_0'}})) {
delete($env{'form.currcat_0'});
}
} else {
delete($env{'form.currcat_0'});
}
} else {
delete($env{'form.currcat_0'});
}
}
}
if (exists($env{'form.numtitles'})) {
unless ($env{'form.numtitles'} =~ /^\d+$/) {
delete($env{'form.numtitles'});
}
}
my ($gotcodes,%possvals);
foreach my $item ('Year','Semester','Department','Number') {
if (exists($env{'form.'.$item})) {
unless ($env{'form.'.$item} eq '0') {
unless ($gotcodes) {
$gotcodes = &get_instcode_allowable($codedom,\%possvals);
}
if (ref($possvals{$item}) eq 'HASH') {
unless (exists($possvals{$item}{$env{'form.'.$item}})) {
delete($env{'form.'.$item});
}
} else {
delete($env{'form.'.$item});
}
}
}
}
if (exists($env{'form.showdom'})) {
unless ($env{'form.showdom'} =~ /^$LONCAPA::match_domain$/) {
delete($env{'form.showdom'});
}
}
if (exists($env{'form.sortby'})) {
unless ($env{'form.sortby'} =~ /^(title|code|owner|cats)$/) {
delete($env{'form.sortby'});
}
}
if (exists($env{'form.showcounts'})) {
if (ref($env{'form.showcounts'}) eq 'ARRAY') {
foreach my $item (@{$env{'form.showcounts'}}) {
unless ($item =~ /^(Active|Future|Previous)$/) {
delete($env{'form.showcounts'});
last;
}
}
} else {
unless ($env{'form.showcounts'} =~ /^(Active|Future|Previous)$/) {
delete($env{'form.showcounts'});
}
}
}
foreach my $item ('showhidden','showdetails','showselfenroll','withsubcats') {
if (exists($env{'form.'.$item})) {
unless ($env{'form.'.$item} eq '1') {
delete($env{'form.'.$item});
}
}
}
if (exists($env{'form.state'})) {
unless ($env{'form.state'} eq 'listing') {
delete($env{'form.state'});
}
}
if (exists($env{'form.uniquecode'})) {
unless ($env{'form.uniquecode'} =~ /^\w{6}$/) {
delete($env{'form.uniquecode'});
}
}
if (exists($env{'form.wasactive'})) {
unless (($env{'form.wasactive'} eq 'accessend') || ($env{'form.wasactive'} eq 'enrollend')) {
delete($env{'form.wasactive'});
}
}
if (exists($env{'form.wasactiveon_day'})) {
my $tmpday = $env{'form.wasactiveon_day'};
unless (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
delete($env{'form.wasactiveon_day'});
}
}
if (exists($env{'form.wasactiveon_month'})) {
my $tmpmonth = $env{'form.wasactiveon_month'};
unless (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
delete($env{'form.wasactiveon_month'});
}
}
if (exists($env{'form.wasactiveon_year'})) {
my $tmpyear = $env{'form.wasactiveon_year'};
unless (($tmpyear =~ /^\d+$/) && ($tmpyear >= 1970)) {
delete($env{'form.wasactiveon_year'});
}
}
if (keys(%currcats)) {
foreach my $key (keys(%currcats)) {
if ($env{'form.'.$key} eq '') {
delete($env{'form.'.$key});
} elsif (ref($crscatsref) eq 'HASH') {
unless (exists($crscatsref->{$env{'form.'.$key}})) {
delete($env{'form.'.$key});
}
} else {
delete($env{'form.'.$key});
}
}
}
return;
}
sub get_instcode_allowable {
my ($codedom,$possvalref) = @_;
return 1 unless (ref($possvalref) eq 'HASH');
my $instcats = &Apache::lonnet::get_dom_instcats($codedom);
if (ref($instcats) eq 'HASH') {
if ((ref($instcats->{'codetitles'}) eq 'ARRAY') && (ref($instcats->{'codes'}) eq 'HASH')) {
my %codes = %{$instcats->{'codes'}};
my @codetitles = @{$instcats->{'codetitles'}};
my @standardnames = &Apache::loncommon::get_standard_codeitems();
my %local_to_standard;
for (my $i=0; $i<@codetitles; $i++) {
$local_to_standard{$codetitles[$i]} = $standardnames[$i];
$possvalref->{$standardnames[$i]} = {};
}
foreach my $cid (sort(keys(%codes))) {
if (ref($codes{$cid}) eq 'HASH') {
foreach my $item (keys(%{$codes{$cid}})) {
$possvalref->{$local_to_standard{$item}}{$codes{$cid}{$item}} = 1;
}
}
}
}
}
return 1;
}
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';
my $textthree = &mt('Detailed course information:');
my $textfour = &mt('Back to course listing');
if ($env{'form.currcat_0'} eq 'communities::0') {
$brtextone = 'Community listing';
$brtexttwo = 'Community details';
$textthree = &mt('Detailed community information:');
$textfour = &mt('Back to community listing');
} elsif ($env{'form.currcat_0'} eq 'placement::0') {
$brtextone = 'Placement test listing';
$brtexttwo = 'Placement test details';
$textthree = &mt('Detailed placement test information:');
$textfour = &mt('Back to placement test listing');
}
&Apache::lonhtmlcommon::add_breadcrumb
({href=>"javascript:document.$formname.submit()",
text=>$brtextone},
{text=>$brtexttwo});
$r->print(
&Apache::lonhtmlcommon::breadcrumbs('Course/Community Catalog').
'
'.$textthree.'
'.
&print_course_listing($codedom,undef,$trails,$allitems,undef,$codetitles).
' '.
'');
return;
}
sub coursesearch {
my ($codedom,$domdesc,$uniquecode) = @_;
my %lt = &Apache::lonlocal::texthash (
crlk => 'Course look-up',
code => 'Code',
ifyo => 'Enter the course code (six letters and numbers)',
srch => 'Find course',
);
return <<"END";
$lt{'crlk'} ($domdesc)
$lt{'ifyo'}
END
}
sub courselink_javascript {
my ($r) = @_;
my $hostname = $r->hostname();
return <<"END";
function ToSyllabus(cdom,cnum,usehttp) {
if (cdom == '' || cdom == null) {
return;
}
if (cnum == '' || cnum == null) {
return;
}
document.linklaunch.action = "/public/"+cdom+"/"+cnum+"/syllabus";
if (usehttp == 1) {
var hostname = '$hostname';
if (hostname != '') {
document.linklaunch.action = 'http://'+hostname+document.linklaunch.action;
}
document.linklaunch.action += '?usehttp=1';
}
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,$cattype,$canviewall) = @_;
my %cat_titles = ();
my %cat_order = ();
my %cat_items = ();
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) || $canviewall) {
$add_entries{'onload'} .= ' toggleStatuses();toggleWasActive();'
}
&cat_header($r,$codedom,$js,\%add_entries,$catlinks,$numtitles,$cattype);
my $cat_maxdepth = $env{'form.catalog_maxdepth'};
$r->print('
');
} else {
$js = '';
&cat_header($r,$codedom,$js,\%add_entries,$catlinks,$numtitles,$cattype);
my $cat_maxdepth = $env{'form.catalog_maxdepth'};
$r->print('');
}
return $numtitles;
}
sub cat_header {
my ($r,$codedom,$js,$add_entries,$catlinks,$numtitles,$cattype) = @_;
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';
} elsif ($env{'form.currcat_0'} eq 'placement::0') {
$brtext = 'Placement test 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'));
if ($cattype eq 'std') {
my $onchange = 'this.form.submit()';
$r->print('');
}
$r->print('');
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';
} elsif ($cats[0][0] eq 'placement') {
$catlinks .= &mt('Placement Tests');
$env{'form.currcat_0'} = 'placement::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 .= '
';
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,$canviewall) = @_;
my $is_dc = &user_is_dc($codedom);
my $output = '
';
if ($is_dc || $canviewall) {
$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 canview_all {
my ($knownuser,$codedom) = @_;
my $canviewall = 0;
my $page = 'coursecatalog';
if (&LONCAPA::lonauthcgi::can_view($page)) {
$canviewall = 1;
} elsif (&LONCAPA::lonauthcgi::check_ipbased_access($page)) {
$canviewall= 1;
} elsif (($knownuser) && ($codedom ne '')) {
if (&Apache::lonnet::allowed('dcd',$codedom)) {
$canviewall = 1;
}
}
return $canviewall;
}
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';
} elsif ($env{'form.currcat_0'} eq 'placement::0') {
$typefilter = 'Placement';
} 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,$canviewall) = @_;
my $output;
my %courses;
my $knownuser = &user_is_known();
my $canviewall = &canview_all();
my $details = $env{'form.coursenum'};
if (&user_is_dc($domain) || $canviewall) {
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.');
} elsif ($env{'form.currcat_0'} eq 'placement::0') {
$output .= &mt('The courseID provided does not match a placement test 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.');
} elsif ($env{'form.currcat_0'} eq 'placement::0') {
$output .= &mt('No placement tests 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)) && (!$canviewall)) {
$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,$canviewall);
$output .= "\n".'';
return $output;
}
sub construct_data_table {
my ($knownuser,$domain,$courses,$details,$usersections,$now,$trails,$allitems,$canviewall) = @_;
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 .= '