# The LearningOnline Network
# Pick a course
#
# $Id: lonpickcourse.pm,v 1.73.2.2 2008/07/01 05:26:04 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::lonpickcourse;
use strict;
use Apache::Constants qw(:common);
use Apache::loncommon;
use Apache::loncoursedata;
use Apache::lonnet;
use Apache::lonlocal;
use Apache::longroup;
use LONCAPA;
sub handler {
my $r = shift;
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
return OK if $r->header_only;
# ------------------------------------------------------------ Print the screen
# Get parameters from query string
&Apache::loncommon::get_unprocessed_cgi
($ENV{'QUERY_STRING'},['domainfilter','form','cnumelement',
'cdomelement','cnameelement','roleelement',
'multiple','type','setroles']);
my ($type,$title,$jscript,$multelement,$multiple,$roleelement,
$lastaction,$autosubmit,$submitopener);
# Get course type - Course or Non-standard Course.
$type = $env{'form.type'};
if (!defined($env{'form.type'})) {
$type = 'Course';
}
$title = &mt('Selecting a [_1]',$type);
# Setup for multiple course selections, if flag for multiples set.
$multiple = $env{'form.multiple'};
if ($multiple) {
($jscript,$multelement) = &multiples_tag();
$title = &mt('Selecting [_1](s)',lc($type));
}
# if called when a DC is selecting a course
my $roledom = $env{'form.roleelement'};
if ($roledom) {
$roleelement = '';
$submitopener = &processpick();
$autosubmit = 'process_pick("'.$roledom.'")';
}
my $onlyown = 0;
# if called to assign course-based portfolio access control
if ((($env{'form.form'} eq 'portform') && (!$env{'user.adv'}))) {
$onlyown = 1;
}
my %loaditem;
if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) &&
($env{'form.pickedcourse'})) {
$loaditem{'onload'} ="setSections()";
}
$r->print(&Apache::loncommon::start_page($title,undef,
{'add_entries' => \%loaditem,
'no_nav_bar' => 1, }));
if ($env{'form.form'} eq 'portform') {
$lastaction = 'document.courselist.submit()';
} elsif ($env{'form.form'} eq 'cu' || ($env{'form.form'} eq 'studentform' &&
!$multiple)) {
$lastaction =
'document.courselist.pickedcourse.value = cdom+"_"+cname;'."\n".
'document.courselist.submit();';
} else {
$lastaction = 'self.close()';
}
# if called to assign a role in a course to a user via CUSR
if ($env{'form.form'} eq 'cu' || $env{'form.form'} eq 'studentform') {
$r->print(&create_user_javascript($type));
}
# print javascript functions for choosing a course
if ($env{'form.gosearch'} || $onlyown) {
$r->print(&gochoose_javascript($type,$multiple,$autosubmit,$lastaction));
}
$r->print('');
$r->print($submitopener);
# ------------------------------------------ Display of filters to limit search
my $filter = {};
my $action = '/adm/pickcourse';
if (!$onlyown) {
my $filterlist = ['domainfilter','descriptfilter',
'instcodefilter','ownerfilter',
'ownerdomfilter'];
# course ID filter for DCs only
if ($env{'user.adv'} && $env{'form.domainfilter'} &&
exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
push(@{$filterlist},'coursefilter');
}
$r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
$filter,$action));
}
# ---------------------------------------------------------------- Get the data
if ($env{'form.gosearch'} || $onlyown) {
my %courses = &search_courses($r,$type,$onlyown,$filter);
&display_matched_courses($r,$type,$multiple,$action,%courses);
}
$r->print(&Apache::loncommon::end_page());
return OK;
}
sub processpick {
my $openerform = 'rolechoice';
if ($env{'form.form'} eq 'studentform') {
$openerform = $env{'form.form'};
}
my $process_pick = <<"ENDONE";
";
return $process_pick;
}
sub create_user_javascript {
my ($type) = @_;
my $output;
#javascript for reporting sections and groups then closing
if ($env{'form.pickedcourse'}) {
my ($cdom,$cnum) = split/_/,$env{'form.pickedcourse'};
my $sec_element = 'currsec';
my $grplist_element = 'groups';
my ($sections,$groups) =
&Apache::loncommon::get_secgrprole_info($cdom,$cnum,'',$type);
my $num_sections = scalar(@{$sections});
my $seclist = join(',',@{$sections});
my $num_groups = scalar(@{$groups});
my $groupslist = join(',',@{$groups});
$output = qq|
|;
;
}
return $output;
}
sub display_matched_courses {
my ($r,$type,$multiple,$action,%courses) = @_;
if ($env{'form.form'} eq 'portform') {
$action = '/adm/portfolio';
}
my $numcourses = keys(%courses);
$r->print('
\n");
return;
}
sub multiples_tag {
my $jscript = &Apache::loncommon::check_uncheck_jscript();
my $multelement = '';
return ($jscript,$multelement);
}
sub build_filters {
my ($filterlist,$type,$roleelement,$multelement,$filter,$action,
$caller) = @_;
my $list;
my $formname;
if (defined($env{'form.form'})) {
$formname = $env{'form.form'};
} else {
$formname = $caller;
}
my ($domainselectform,$sincefilterform,$ownerdomselectform,
$instcodeform,$typeselectform);
foreach my $item (@{$filterlist}) {
$filter->{$item} = $env{'form.'.$item};
if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
if ($item eq 'domainfilter' || $item eq 'ownerdomfilter') {
$filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
} elsif ($item eq 'coursefilter') {
$filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
} elsif ($item eq 'ownerfilter') {
$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
} else {
$filter->{$item} =~ s/\W//g;
}
if (!$filter->{$item}) {
$filter->{$item} = '';
}
}
if ($item eq 'domainfilter') {
my $allow_blank = 1;
if ($formname eq 'portform') {
$filter->{$item} ||= $env{'user.domain'};
$allow_blank=0;
} elsif ($formname eq 'studentform') {
$filter->{$item} ||= $env{'request.role.domain'};
$allow_blank=0;
}
$domainselectform =
&Apache::loncommon::select_dom_form($filter->{$item},
'domainfilter',
$allow_blank);
} elsif ($item eq 'ownerdomfilter') {
$ownerdomselectform =
&Apache::loncommon::select_dom_form($filter->{$item},'ownerdomfilter',1);
} else {
$list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
}
}
# last course activity filter and selection
$filter->{'sincefilter'} = $env{'form.sincefilter'};
$filter->{'sincefilter'} =~ s/[^\d-]//g;
if (!$filter->{'sincefilter'}) { $filter->{'sincefilter'}=-1; }
$sincefilterform=&Apache::loncommon::select_form($filter->{'sincefilter'},
'sincefilter',('-1'=>'',
'86400' => 'today',
'604800' => 'last week',
'2592000' => 'last month',
'7776000' => 'last three months',
'15552000' => 'last six months',
'31104000' => 'last year',
'select_form_order' =>
['-1','86400','604800','2592000','7776000',
'15552000','31104000']));
my %lt = (
'cac' => &mt('[_1] Activity',$type),
'cde' => &mt('[_1] Description',$type),
'cdo' => &mt('[_1] Domain',$type),
'cin' => &mt('Course Institutional Code'),
'cow' => &mt("[_1] Owner's Username",$type),
'cod' => &mt("[_1] Owner's Domain", $type),
'cog' => &mt('Course Type')
);
$typeselectform = '";
my $output = qq|
'."\n".''."\n";
return $output;
}
sub search_courses {
my ($r,$type,$onlyown,$filter) = @_;
my %courses;
if (!$onlyown) {
$r->print(&mt('Searching ...').'
');
$r->rflush();
if (($filter->{'ownerfilter'} ne '') ||
($filter->{'ownerdomfilter'} ne '')) {
$filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
$filter->{'ownerdomfilter'};
}
foreach my $item ('descriptfilter','instcodefilter','coursefilter',
'combownerfilter') {
if (!$filter->{$item}) {
$filter->{$item}='.';
}
}
if ($type eq '') { $type = '.'; }
my $timefilter =
($filter->{'sincefilter'}==-1?1:time-$filter->{'sincefilter'});
%courses =
&Apache::lonnet::courseiddump($filter->{'domainfilter'},
$filter->{'descriptfilter'},
$timefilter,
$filter->{'instcodefilter'},
$filter->{'combownerfilter'},
$filter->{'coursefilter'},
undef,undef,$type);
} else {
$r->print(' ');
my %coursehash = &Apache::loncommon::findallcourses();
foreach my $cid (sort(keys(%coursehash))) {
$courses{$cid}{'description'} = $env{'course.'.$cid.'.description'};
}
}
return %courses;
}
sub course_chooser {
my ($multiple,$cdom,$cnum,$cleandesc) = @_;
my $output;
if ($multiple) {
$output = '