# The LearningOnline Network with CAPA
# Routines to control the menu
#
# $Id: lonmenu.pm,v 1.244.2.12 2010/01/18 21:35: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/
#
#
# There are two parameters controlling the action of this module:
#
# browser.interface - if this is 'textual', it overrides the second parameter
# and goes to screen reader PDA mode
#
# environment.remote - if this is 'on', the routines controll the remote
# control, otherwise they render the main window controls; ignored it
# browser.interface is 'textual'
#
=head1 NAME
Apache::lonmenu
=head1 SYNOPSIS
Coordinates the response to clicking an image.
This is part of the LearningOnline Network with CAPA project
described at http://www.lon-capa.org.
=head1 SUBROUTINES
=over
=item show_course()
Little texts
=item initlittle()
=item menubuttons()
This gets called at the top of the body section
=item show_return_link()
=item registerurl()
This gets called in the header section
=item innerregister()
This gets called in order to register a URL, both with the Remote
and in the body of the document
=item loadevents()
=item unloadevents()
=item startupremote()
=item setflags()
=item maincall()
=item load_remote_msg()
=item get_menu_name()
=item reopenmenu()
=item open()
Open the menu
=item clear()
=item switch()
Switch a button or create a link
Switch acts on the javascript that is executed when a button is clicked.
The javascript is usually similar to "go('/adm/roles')" or "cstrgo(..)".
=item secondlevel()
=item openmenu()
=item inlinemenu()
=item rawconfig()
=item close()
=item footer()
=item utilityfunctions()
=item serverform()
=item constspaceform()
=item get_nav_status()
=item hidden_button_check()
=item roles_selector()
=item jump_to_role()
=back
=cut
package Apache::lonmenu;
use strict;
use Apache::lonnet;
use Apache::lonhtmlcommon();
use Apache::loncommon();
use Apache::lonenc();
use Apache::lonlocal;
use LONCAPA qw(:DEFAULT :match);
use HTML::Entities();
use vars qw(@desklines %category_names %category_members %category_positions $readdesk);
my @inlineremote;
sub show_course {
my $course = !$env{'user.adv'};
if (!$env{'user.adv'}) {
foreach my $env (keys(%env)) {
next if ($env !~ m/^user\.priv\./);
if ($env !~ m/^user\.priv\.(?:st|cm)/) {
$course = 0;
last;
}
}
}
return $course;
}
sub initlittle {
return &Apache::lonlocal::texthash('ret' => 'Return to Last Location',
'nav' => 'Navigate Contents',
'main' => 'Main Menu',
'roles' => (&Apache::loncommon::show_course()?
'Courses':'Roles'),
'other' => 'Other Roles',
'docs' => 'Edit Course',
'exit' => 'Logout',
'login' => 'Log In',
'launch' => 'Launch Remote Control',
'groups' => 'Groups',
'gdoc' => 'Community Documents',
);
}
sub menubuttons {
my $forcereg=shift;
my $registration=shift;
my $titletable=shift;
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
['inhibitmenu']);
if (($env{'form.inhibitmenu'} eq 'yes') ||
($ENV{'REQUEST_URI'} eq '/adm/logout')) { return ''; }
if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
my %lt=&initlittle();
my $navmaps='';
my $reloadlink='';
my $docs='';
my $groups='';
my $roles=''.$lt{'roles'}.'';
my $role_selector;
my $showgroups=0;
my ($cnum,$cdom);
my $escurl=&escape(&Apache::lonenc::check_encrypt($env{'request.noversionuri'}));
my $escsymb=&escape(&Apache::lonenc::check_encrypt($env{'request.symb'}));
my $logo=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/minilogo.gif");
$logo = '
';
if ($env{'request.state'} eq 'construct') {
if (($env{'request.noversionuri'} eq '') || (!defined($env{'request.noversionuri'}))) {
my $returnurl = $env{'request.filename'};
$returnurl =~ s:^/home/([^/]+)/public_html/(.*)$:/priv/$1/$2:;
$escurl = &escape($returnurl);
}
}
if ($env{'request.course.id'}) {
$cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
$cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
my %coursegroups;
my $viewgrps_permission =
&Apache::lonnet::allowed('vcg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''));
if (!$viewgrps_permission) {
%coursegroups = &Apache::lonnet::get_active_groups($env{'user.domain'},$env{'user.name'},$cdom,$cnum);
}
if ((keys(%coursegroups) > 0) || ($viewgrps_permission)) {
$showgroups = 1;
}
$role_selector = &roles_selector($cdom,$cnum);
if ($role_selector) {
$roles = ''.$role_selector.' '.$lt{'other'}.'';
}
}
if ($env{'browser.interface'} eq 'textual') {
# Textual display only
if ($env{'request.course.id'}) {
$navmaps=(<$lt{'nav'}
ENDNAV
if (&show_return_link()) {
my $escreload=&escape('return:');
$reloadlink=(<$lt{'ret'}
ENDRELOAD
}
my $is_community =
(&Apache::loncommon::course_type() eq 'Community');
if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
my $text = ($is_community) ? $lt{'gdoc'} : $lt{'docs'};
$docs=(<$text
ENDDOCS
}
if ($showgroups) {
$groups =(<$lt{'groups'}
ENDGROUPS
}
}
my $form=&serverform();
my $utility=&utilityfunctions();
my $output=(<
// BEGIN LON-CAPA Internal
$utility
$form
ENDMAINMENU
if ($registration) { $output.=&innerregister($forcereg); }
return $output."";
} elsif ($env{'environment.remote'} eq 'off') {
# Remote Control is switched off
# figure out colors
my %lt=&initlittle();
my $domain=&Apache::loncommon::determinedomain();
my $function =&Apache::loncommon::get_users_function();
my $link=&Apache::loncommon::designparm($function.'.link',$domain);
my $alink=&Apache::loncommon::designparm($function.'.alink',$domain);
my $vlink=&Apache::loncommon::designparm($function.'.vlink',$domain);
my $sidebg=&Apache::loncommon::designparm($function.'.sidebg',$domain);
if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
return (<
';
# Do we have a NAV link?
if ($env{'request.course.id'}) {
my $link='/adm/navmaps?postdata='.$escurl.'&postsymb='.
$escsymb;
if ($env{'environment.remotenavmap'} eq 'on') {
$link="javascript:gonav('".$link."')";
}
$navmaps=(<$lt{'nav'}
ENDNAV
my $is_community =
(&Apache::loncommon::course_type() eq 'Community');
if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
my $text = ($is_community) ? $lt{'gdoc'} : $lt{'docs'};
$docs=(<$text
ENDDOCS
}
if ($showgroups) {
$groups =(<$lt{'groups'}
ENDGROUPS
}
if (&show_return_link()) {
my $escreload=&escape('return:');
$reloadlink=(<$lt{'ret'}
ENDRELOAD
}
if ($role_selector) {
$roles = '
';
}
}
if (($env{'request.state'} eq 'construct') && ($env{'request.course.id'})) {
my $escreload=&escape('return:');
$reloadlink=(<$lt{'ret'}
ENDCRELOAD
}
my $reg='';
if ($registration) {
$reg=&innerregister($forcereg,$titletable);
}
my $form=&serverform();
my $utility=&utilityfunctions();
my $helplink=&Apache::loncommon::top_nav_help('Help');
return (<
//
';
my ($mapurl,$rid,$resurl)=
&Apache::lonnet::decode_symb(&Apache::lonnet::symbread());
my $coursetitle=$env{'course.'.$env{'request.course.id'}.'.description'};
$newmail.=$coursetitle;
my $maptitle=&Apache::lonnet::gettitle($mapurl);
my $restitle=&Apache::lonnet::gettitle(&Apache::lonnet::symbread());
if ($maptitle && ($maptitle ne 'default.sequence') && ($maptitle ne $coursetitle)) {
$newmail.=', '.$maptitle;
}
if ($restitle) {
$newmail.=': '.$restitle;
}
$newmail.='
';
}
if ($env{'request.state'} eq 'construct') {
$newmail = $titletable;
} else {
if ($noremote) {
$newmail.='
';
}
}
my $timesync=($textual?'':'swmenu.syncclock(1000*'.time.');');
my $tablestart=($noremote?'
':'').($textinter?'':'');
# =============================================================================
# ============================ This is for URLs that actually can be registered
if (($env{'request.noversionuri'}!~m|^/(res/)*adm/|) || ($forcereg)) {
# -- This applies to homework problems for users with grading privileges
my $crs='/'.$env{'request.course.id'};
if ($env{'request.course.sec'}) {
$crs.='_'.$env{'request.course.sec'};
}
$crs=~s/\_/\//g;
my $hwkadd='';
if ($env{'request.symb'} ne '' &&
$env{'request.filename'}=~/\.(problem|exam|quiz|assess|survey|form|task)$/) {
if (&Apache::lonnet::allowed('mgr',$crs)) {
$hwkadd.=&switch('','',7,2,'pgrd.gif','problem[_1]','grades[_4]',
"gocmd('/adm/grades','gradingmenu')",
'Modify user grades for this assessment resource');
} elsif (&Apache::lonnet::allowed('vgr',$crs)) {
$hwkadd.=&switch('','',7,2,'subm.gif','view sub-[_1]','missions[_1]',
"gocmd('/adm/grades','submission')",
'View user submissions for this assessment resource');
}
}
if ($env{'request.symb'} ne '' &&
&Apache::lonnet::allowed('opa',$crs)) {
$hwkadd.=&switch('','',7,3,'pparm.gif','problem[_2]','parms[_2]',
"gocmd('/adm/parmset','set')",
'Modify parameter settings for this resource');
}
# -- End Homework
###
### Determine whether or not to display the 'cstr' button for this
### resource
###
my $editbutton = '';
my $noeditbutton = 1;
my ($cnum,$cdom);
if ($env{'request.course.id'}) {
$cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
$cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
}
if ($env{'user.author'}) {
if ($env{'request.role'}=~/^(aa|ca|au)/) {
# Set defaults for authors
my ($top,$bottom) = ('con-','struct');
my $action = "go('/priv/".$env{'user.name'}."');";
my $cadom = $env{'request.role.domain'};
my $caname = $env{'user.name'};
my $desc = "Enter my construction space";
# Set defaults for co-authors
if ($env{'request.role'} =~ /^ca/) {
($cadom,$caname)=($env{'request.role'}=~/($match_domain)\/($match_username)$/);
($top,$bottom) = ('co con-','struct');
$action = "go('/priv/".$caname."');";
$desc = "Enter construction space as co-author";
} elsif ($env{'request.role'} =~ /^aa/) {
($cadom,$caname)=($env{'request.role'}=~/($match_domain)\/($match_username)$/);
($top,$bottom) = ('co con-','struct');
$action = "go('/priv/".$caname."');";
$desc = "Enter construction space as assistant co-author";
}
# Check that we are on the correct machine
my $home = &Apache::lonnet::homeserver($caname,$cadom);
my $allowed=0;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if (!$allowed) {
$editbutton=&switch('','',6,1,$top,,$bottom,$action,$desc);
$noeditbutton = 0;
}
}
##
## Determine if user can edit url.
##
my $cfile='';
my $cfuname='';
my $cfudom='';
my $uploaded;
if ($env{'request.filename'}) {
my $file=&Apache::lonnet::declutter($env{'request.filename'});
$file=~s/^($match_domain)\/($match_username)/\/priv\/$2/;
# Check that the user has permission to edit this resource
($cfuname,$cfudom)=&Apache::loncacc::constructaccess($file,$1);
if (defined($cfudom)) {
my $home=&Apache::lonnet::homeserver($cfuname,$cfudom);
my $allowed=0;
my @ids=&Apache::lonnet::current_machine_ids();
foreach my $id (@ids) { if ($id eq $home) { $allowed=1; } }
if ($allowed) {
$cfile=$file;
}
}
}
# Finally, turn the button on or off
if ($cfile && !$const_space) {
$editbutton=&switch
('','',6,1,'pcstr.gif','edit[_1]','resource[_2]',
"go('".$cfile."');","Edit this resource");
$noeditbutton = 0;
} elsif ($editbutton eq '') {
$editbutton=&clear(6,1);
}
}
if (($noeditbutton) && ($env{'request.filename'})) {
if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
my $file=&Apache::lonnet::declutter($env{'request.filename'});
if (defined($cnum) && defined($cdom)) {
if (&is_course_upload($file,$cnum,$cdom)) {
my $cfile = &edit_course_upload($file,$cnum,$cdom);
if ($cfile) {
$editbutton=&switch
('','',6,1,'pcstr.gif','edit[_1]',
'resource[_2]',"go('".$cfile."');",
'Edit this resource');
}
}
}
}
}
###
###
# Prepare the rest of the buttons
my $menuitems;
if ($const_space) {
my ($uname,$thisdisfn) =
($env{'request.filename'}=~m|^/home/([^/]+)/public_html/(.*)|);
my $currdir = '/priv/'.$uname.'/'.$thisdisfn;
if ($currdir =~ m-/$-) {
$is_const_dir = 1;
} else {
$currdir =~ s#[^/]+$##;
my $cleandisfn = &Apache::loncommon::escape_single($thisdisfn);
my $esc_currdir = &Apache::loncommon::escape_single($currdir);
$menuitems=(< 0){
$menuitems.="anot2.gif";
}else{
$menuitems.="anot.gif";
}
$menuitems.="&anno-[_1]&tations[_1]&annotate()&";
$menuitems.="Make notes and annotations about this resource&&1\n";
unless ($noremote) {
my $showreqcrs = &check_for_rcrs();
if ($showreqcrs) {
$menuitems.="s&8&1&rcrs.gif&request[_1]&course[_16]".
"&go('/adm/requestcourse')&Course requests\n";
}
}
unless ($env{'request.noversionuri'}=~/\/(bulletinboard|smppg|navmaps|syllabus|aboutme)(\?|$)/) {
if ((!$env{'request.enc'}) && ($env{'request.noversionuri'} !~ m{^/adm/wrapper/ext/})) {
$menuitems.=(<
$inlineremote[21] $inlineremote[23]
ENDARROWSINLINE
if (&hidden_button_check() ne 'yes') {
$inlinebuttons .= (<
ENDINLINEICONS
}
} else {
if ($inlineremote[21] ne '' || $inlineremote[23] ne '') {
$inlinebuttons=(<
$inlineremote[21]
$inlineremote[23]
ENDFIRSTLINE
}
if (&hidden_button_check() ne 'yes') {
foreach my $row (6..9) {
if ($inlineremote[${row}.'1'] ne ''
|| $inlineremote[$row.'2'] ne ''
|| $inlineremote[$row.'3'] ne '') {
$inlinebuttons .= <<"ENDLINE";
$inlineremote["${row}1"]
$inlineremote["${row}2"]
$inlineremote["${row}3"]
ENDLINE
}
}
}
}
}
}
$result =(<
// BEGIN LON-CAPA Internal
$timesync
$tablestart
$inlinebuttons
$tableend
$newmail
ENDREGTEXT
# Registered, graphical output
} else {
my $requri=&Apache::lonnet::clutter(&Apache::lonnet::fixversion((split(/\?/,$env{'request.noversionuri'}))[0]));
$requri=&Apache::lonenc::check_encrypt(&unescape($requri));
my $cursymb=&Apache::lonenc::check_encrypt($env{'request.symb'});
my $navstatus=&get_nav_status();
my $clearcstr;
if ($env{'user.adv'}) { $clearcstr='clearbut(6,1)'; }
$result = (<
//
ENDREGTHIS
}
# =============================================================================
} else {
# ========================================== This can or will not be registered
if ($textual) {
# Not registered, textual
$result= (<
//
ENDDONOTREGTHIS
}
# =============================================================================
}
return $result;
}
sub is_course_upload {
my ($file,$cnum,$cdom) = @_;
my $uploadpath = &LONCAPA::propath($cdom,$cnum);
$uploadpath =~ s{^\/}{};
if (($file =~ m{^\Q$uploadpath\E/userfiles/docs/}) ||
($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/docs/})) {
return 1;
}
return;
}
sub edit_course_upload {
my ($file,$cnum,$cdom) = @_;
my $cfile;
if ($file =~/\.(htm|html|css|js|txt)$/) {
my $ext = $1;
my $url = &Apache::lonnet::hreflocation('',$file);
my $home = &Apache::lonnet::homeserver($cnum,$cdom);
my @ids=&Apache::lonnet::current_machine_ids();
my $dest;
if ($home && grep(/^\Q$home\E$/,@ids)) {
$dest = $url.'?forceedit=1';
} else {
unless (&Apache::lonnet::get_locks()) {
$dest = '/adm/switchserver?otherserver='.
$home.'&role='.$env{'request.role'}.
'&url='.$url.'&forceedit=1';
}
}
if ($dest) {
$cfile = &HTML::Entities::encode($dest,'"<>&');
}
}
return $cfile;
}
sub loadevents() {
if ($env{'request.state'} eq 'construct' ||
$env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
return 'LONCAPAreg();';
}
sub unloadevents() {
if ($env{'request.state'} eq 'construct' ||
$env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; }
return 'LONCAPAstale();';
}
sub startupremote {
my ($lowerurl)=@_;
if (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) {
return ('');
}
#
# The Remote actually gets launched!
#
my $configmenu=&rawconfig();
my $esclowerurl=&escape($lowerurl);
my $message=&mt('"Waiting for Remote Control window to load: "+[_1]','waited');
return(<
//
ENDREMOTESTARTUP
}
sub setflags() {
return(<
//
ENDSETFLAGS
}
sub maincall() {
if (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) { return ''; }
return(<
//
ENDMAINCALL
}
sub load_remote_msg {
my ($lowerurl)=@_;
if (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) { return ''; }
my $esclowerurl=&escape($lowerurl);
my $link=&mt('[_1]Continue[_2] on in Inline Menu mode',
'',
'');
return(<
$link
ENDREMOTEFORM
}
sub get_menu_name {
my $hostid = $Apache::lonnet::perlvar{'lonHostID'};
$hostid =~ s/\W//g;
return 'LCmenu'.$hostid;
}
sub reopenmenu {
if (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) { return ''; }
my $menuname = &get_menu_name();
my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
return('window.open('.$nothing.',"'.$menuname.'","",false);');
}
sub open {
my $returnval='';
if (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) {
return
'';
}
my $menuname = &get_menu_name();
# unless (shift eq 'unix') {
# resizing does not work on linux because of virtual desktop sizes
# $returnval.=(<
ENDOPEN
return '';
}
# ================================================================== Raw Config
sub clear {
my ($row,$col)=@_;
unless (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) {
return "\n".qq(window.status+='.';swmenu.clearbut($row,$col););
} else {
$inlineremote[10*$row+$col]='';
return '';
}
}
# ============================================ Switch a button or create a link
# Switch acts on the javascript that is executed when a button is clicked.
# The javascript is usually similar to "go('/adm/roles')" or "cstrgo(..)".
sub switch {
my ($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat,$nobreak)=@_;
$act=~s/\$uname/$uname/g;
$act=~s/\$udom/$udom/g;
$top=&mt($top);
$bot=&mt($bot);
$desc=&mt($desc);
if (($env{'environment.remote'} ne 'off') || ($env{'environment.icons'} eq 'classic')) {
$img=&mt($img);
}
my $idx=10*$row+$col;
$category_members{$cat}.=':'.$idx;
unless (($env{'browser.interface'} eq 'textual') ||
($env{'environment.remote'} eq 'off')) {
# Remote
return "\n".
qq(window.status+='.';swmenu.switchbutton($row,$col,"$img","$top","$bot","$act","$desc"););
} elsif ($env{'browser.interface'} eq 'textual') {
# Accessibility
if ($nobreak==2) { return ''; }
my $text=$top.' '.$bot;
$text=~s/\s*\-\s*//gs;
if ($nobreak) {
$inlineremote[$idx]=
''.$text.'';
} else {
$inlineremote[$idx]="\n ".
$desc.' '.$text.'';
}
} else {
# Inline Remote
if ($env{'environment.icons'} ne 'classic') {
$img=~s/\.gif$/\.png/;
}
if ($nobreak==2) { return ''; }
my $text=$top.' '.$bot;
$text=~s/\s*\-\s*//gs;
my $pic=
'';
if ($env{'browser.interface'} eq 'faketextual') {
# Accessibility
if ($nobreak==3) {
$inlineremote[$idx]="\n".
'