# The LearningOnline Network
# Pick a course
#
# $Id: lonpickcourse.pm,v 1.103 2011/09/01 02:32:50 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 Apache::courseclassifier;
use LONCAPA qw(:DEFAULT :match);
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','fixeddom','cloner']);
my ($type,$title,$jscript,$multelement,$multiple,$roleelement,$typeelement,
$lastaction,$autosubmit,$submitopener,$cloneruname,$clonerudom);
# Get course type - Course or Community.
$type = $env{'form.type'};
if (!defined($env{'form.type'})) {
$type = 'Course';
}
$title = 'Selecting a '.$type;
# Setup for multiple course selections, if flag for multiples set.
$multiple = $env{'form.multiple'};
if ($multiple) {
($jscript,$multelement) = &multiples_tag();
$title = 'Selecting '.$type.'(s)';
}
# if called when a DC is selecting a course
my $roledom = $env{'form.roleelement'};
if ($roledom) {
$roleelement = '';
$submitopener = &processpick();
$autosubmit = 'process_pick("'.$roledom.'")';
}
if ($env{'form.typeelement'} ne '') {
$typeelement = '';
}
# if called when a DC is creating a course for another user.
if ($env{'form.form'} eq 'ccrs') {
($cloneruname,$clonerudom) = ($env{'form.cloner'} =~ /^($match_username):($match_domain)$/);
}
# if called when requesting a course
if ($env{'form.form'} eq 'requestcrs') {
$cloneruname = $env{'user.name'};
$clonerudom = $env{'user.domain'};
}
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.type'} eq 'Course') && ($env{'form.numtitles'})) {
if (($env{'form.official'} eq 'on') && ($env{'form.state'} eq 'listing')) {
$loaditem{'onload'} = 'setElements(document.filterpicker); ';
}
}
if ((($env{'form.form'} eq 'cu') || ($env{'form.form'} eq 'studentform')) &&
($env{'form.pickedcourse'})) {
$loaditem{'onload'} .= 'setRoles();setSections();';
}
my $js = &js_changer();
$r->print(&Apache::loncommon::start_page($title,$js,
{'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'}) && ($env{'form.updater'} eq '')) ||
$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';
my ($numtitles,$showroles,$nohost,@codetitles);
if (!$onlyown) {
my $filterlist = ['domainfilter'];
# created filter for DCs only
if ($env{'user.adv'} && $env{'form.domainfilter'} &&
exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})
&& $env{'form.form'} ne 'portform') {
my $loncaparev = &Apache::lonnet::get_server_loncaparev($env{'form.domainfilter'});
if ($loncaparev ne 'unknown_cmd') {
push(@{$filterlist},'createdfilter');
}
}
push(@{$filterlist},('descriptfilter','instcodefilter'));
if ($env{'form.form'} eq 'rules') {
push(@{$filterlist},'personfilter');
if (($env{'form.personfilter'} ne '') && ($env{'form.persondomfilter'} ne '')) {
if (&Apache::lonnet::homeserver($env{'form.personfilter'},
$env{'form.persondomfilter'}) eq 'no_host') {
$nohost = 1;
} else {
$showroles = 1;
}
}
} else {
push(@{$filterlist},'ownerfilter');
}
# course ID filter for DCs only
if ($env{'user.adv'} && $env{'form.domainfilter'} &&
exists($env{'user.role.dc./'.$env{'form.domainfilter'}.'/'})) {
push(@{$filterlist},'coursefilter');
}
if ($cloneruname ne '' && $clonerudom ne '') {
push(@{$filterlist},'cloneableonly');
}
$r->print(&build_filters($filterlist,$type,$roleelement,$multelement,
$filter,$action,\$numtitles,undef,$cloneruname,
$clonerudom,$typeelement,\@codetitles));
}
# ---------------------------------------------------------------- Get the data
if ((($env{'form.gosearch'}) && ($env{'form.updater'} eq '')) ||
$onlyown) {
my $domcloner;
if ($env{'form.form'} eq 'ccrs') {
if (($env{'request.role.domain'} eq $env{'form.domainfilter'}) &&
(&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
$domcloner = 1;
}
}
my %courses = &search_courses($r,$type,$onlyown,$filter,$numtitles,
$cloneruname,$clonerudom,$domcloner,\@codetitles);
if ($nohost) {
$r->print (''.
&mt('User does not exist - username: [_1], domain: [_2].',
''.$filter->{'personfilter'}.'',
''.$filter->{'persondomfilter'}.'').'');
} else {
&display_matched_courses($r,$type,$multiple,$action,$showroles,$cloneruname,
$clonerudom,%courses);
}
}
$r->print(&Apache::loncommon::end_page());
return OK;
}
sub js_changer {
return <<"ENDJS";
ENDJS
}
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 %coursedescription =
&Apache::lonnet::coursedescription($env{'form.pickedcourse'},
{'one_time' => '1'});
my $cdom = $coursedescription{'domain'};
my $cnum = $coursedescription{'num'};
my $crstype = $coursedescription{'type'};
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,$showroles,$cloneruname,$clonerudom,%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,
$numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,$codetitlesref) = @_;
my ($list,$formname,$fixeddom,$codedom,$jscript);
$codedom = $env{'request.role.domain'};
if (defined($env{'form.form'})) {
$formname = $env{'form.form'};
} else {
$formname = $caller;
}
my $onchange = 'javascript:updateFilters(this)';
my ($domainselectform,$sincefilterform,$createdfilterform,
$ownerdomselectform,$persondomselectform,$instcodeform,
$typeselectform,$instcodetitle);
foreach my $item (@{$filterlist}) {
$filter->{$item} = $env{'form.'.$item};
if ($item ne 'descriptfilter' && $item ne 'instcodefilter') {
if ($item eq 'domainfilter') {
$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});
$filter->{'ownerdomfilter'} =
&LONCAPA::clean_domain($env{'form.ownerdomfilter'});
$ownerdomselectform =
&Apache::loncommon::select_dom_form($filter->{'ownerdomfilter'},
'ownerdomfilter',1);
} elsif ($item eq 'personfilter') {
$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
if ($env{'form.persondomfilter'} eq '') {
unless ($env{'form.gosearch'}) {
$filter->{'persondomfilter'} = $env{'request.role.domain'};
}
} else {
$filter->{'persondomfilter'} =
&LONCAPA::clean_domain($env{'form.persondomfilter'});
}
$persondomselectform =
&Apache::loncommon::select_dom_form($filter->{'persondomfilter'},
'persondomfilter',1);
} 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;
}
if ($env{'form.fixeddom'}) {
$domainselectform = ''.
&Apache::lonnet::domain($env{'request.role.domain'},
'description');
$codedom = $env{'request.role.domain'};
} else {
$domainselectform =
&Apache::loncommon::select_dom_form($filter->{$item},
'domainfilter',
$allow_blank,'',$onchange);
$codedom = $filter->{'domainfilter'};
}
} else {
$list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
}
}
# last course activity filter and selection
$sincefilterform = &timebased_select_form('sincefilter',$filter);
# course created filter and selection
if (exists($filter->{'createdfilter'})) {
$createdfilterform = &timebased_select_form('createdfilter',$filter);
}
my %lt = &Apache::lonlocal::texthash(
'cac' => "$type Activity",
'ccr' => "$type Created",
'cde' => "$type Title",
'cdo' => "$type Domain",
'ins' => 'Institutional Code',
'inc' => 'Institutional Categorization',
'cow' => "$type Owner/Co-owner",
'cop' => "$type Personnel Includes",
'cog' => 'Type',
);
if (($env{'form.form'} eq 'ccrs') || ($env{'form.form'} eq 'requestcrs')) {
my $typeval = 'Course';
if ($type eq 'Community') {
$typeval = 'Community';
}
$typeselectform = '';
} else {
$typeselectform = '";
}
my ($cloneableonlyform,$cloneabletitle);
if (exists($filter->{'cloneableonly'})) {
my $cloneableon = '';
my $cloneableoff = ' checked="checked"';
if ($filter->{'cloneableonly'}) {
$cloneableon = $cloneableoff;
$cloneableoff = '';
}
$cloneableonlyform = ''.(' 'x3).'';
if ($env{'form.form'} eq 'ccrs') {
$cloneabletitle = &mt('Cloneable for').' '.$cloneruname.':'.$clonerudom;
} else {
$cloneabletitle = &mt('Cloneable by you');
}
}
my $officialjs;
if ($type eq 'Course') {
if (exists($filter->{'instcodefilter'})) {
if (($env{'form.fixeddom'}) || ($formname eq 'requestcrs')
|| ($formname eq 'modifycourse')) {
$officialjs = 1;
($instcodeform,$jscript,$$numtitlesref) =
&instcode_selectors($codedom,'filterpicker',$officialjs,$codetitlesref);
if ($jscript) {
$jscript = ''."\n";
}
}
if ($instcodeform eq '') {
$instcodeform =
'';
$instcodetitle = $lt{'ins'};
} else {
$instcodetitle = $lt{'inc'};
}
if ($env{'form.fixeddom'}) {
$instcodetitle .= ' ('.$codedom.')';
}
}
}
my $output = qq|
'."\n".''."\n";
return $jscript.$warning.$output;
}
sub timebased_select_form {
my ($item,$filter) = @_;
if (ref($filter) eq 'HASH') {
$filter->{$item} = $env{'form.'.$item};
$filter->{$item} =~ s/[^\d-]//g;
if (!$filter->{$item}) { $filter->{$item}=-1; }
return &Apache::loncommon::select_form(
$filter->{$item},
$item,
{ '-1' => '',
'86400' => &mt('today'),
'604800' => &mt('last week'),
'2592000' => &mt('last month'),
'7776000' => &mt('last three months'),
'15552000' => &mt('last six months'),
'31104000' => &mt('last year'),
'select_form_order' =>
['-1','86400','604800','2592000','7776000',
'15552000','31104000']});
}
}
sub get_coordinator_cloneable {
my ($cloneruname,$clonerudom,$type) = @_;
if (($cloneruname!~/\w/) || ($clonerudom!~/\w/)) {
my $warning = '