# The LearningOnline Network with CAPA
# Routines to control the menu
#
# $Id: lonmenu.pm,v 1.39 2003/02/14 21:22:04 www 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/
#
# (TeX Conversion Module
#
# 05/29/00,05/30 Gerd Kortemeyer)
#
# 10/05,05/28,05/30,06/01,06/08,06/09,07/04,08/07 Gerd Kortemeyer
# 02/15/02 Matthew Hall
package Apache::lonmenu;
use strict;
use Apache::lonnet;
use Apache::Constants qw(:common);
use Apache::loncommon;
use Apache::File;
use vars qw(@desklines $readdesk);
# ======================================================= Make the menu buttons
sub menubuttons {
my $forcereg=shift;
my $target =shift;
unless ($ENV{'browser.interface'} eq 'textual') { return ''; }
my $output='Main Menu
';
return $output."
";
}
# ============================================== Register a URL with the remote
sub registerurl {
my $forcereg=shift;
my $target = shift;
my $result = '';
if ($target eq 'edit') {
$result .="\n";
}
if (($ENV{'browser.interface'} eq 'textual') ||
((($ENV{'request.publicaccess'}) ||
(!&Apache::lonnet::is_on_map($ENV{'REQUEST_URI'}))) &&
(!$forcereg))) {
return $result.
'';
}
if ($Apache::lonxml::registered && !$forcereg) { return ''; }
$Apache::lonxml::registered=1;
my $reopen=&Apache::lonmenu::reopenmenu();
my $newmail='';
if (&Apache::lonmsg::newmail()) {
$newmail='swmenu.setstatus("you have","messages");';
}
my $timesync='swmenu.syncclock(1000*'.time.');';
if (($ENV{'REQUEST_URI'}!~/^\/(res\/)*adm\//) || ($forcereg)) {
my $hwkadd='';
if ($ENV{'request.filename'}=~/\.(problem|exam|quiz|assess|survey|form)$/) {
if (&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
$hwkadd.=(<
// BEGIN LON-CAPA Internal
function LONCAPAreg() {
swmenu=$reopen;
swmenu.clearTimeout(swmenu.menucltim);
$timesync
$newmail
swmenu.currentURL=window.location.pathname;
swmenu.reloadURL=window.location.pathname;
swmenu.currentSymb="$ENV{'request.symb'}";
swmenu.reloadSymb="$ENV{'request.symb'}";
swmenu.currentStale=0;
swmenu.clearbut(3,1);
swmenu.switchbutton
(6,3,'catalog.gif','catalog','info','catalog_info()','Show catalog information');
swmenu.switchbutton
(8,1,'eval.gif','evaluate','this','gopost("/adm/evaluate",currentURL)','Provide my evaluation of this resource');
swmenu.switchbutton
(8,2,'fdbk.gif','feedback','discuss','gopost("/adm/feedback",currentURL)','Provide feedback messages or contribute to the course discussion about this resource');
swmenu.switchbutton
(8,3,'prt.gif','prepare','printout','gopost("/adm/printout",currentURL)','Prepare a printable document');
swmenu.switchbutton
(2,1,'back.gif','backward','','gopost("/adm/flip","back:"+currentURL)','Go to the previous resource in the course sequence');
swmenu.switchbutton
(2,3,'forw.gif','forward','','gopost("/adm/flip","forward:"+currentURL)','Go to the next resource in the course sequence');
swmenu.switchbutton
(9,1,'sbkm.gif','set','bookmark','set_bookmark()','Set a bookmark for this resource');
swmenu.switchbutton
(9,2,'vbkm.gif','view','bookmark','edit_bookmarks()','Use or edit my bookmark collection');
swmenu.switchbutton
(9,3,'anot.gif','anno-','tations','annotate()','Make notes and annotations about this resource');
$hwkadd
$editbutton
}
function LONCAPAstale() {
swmenu=$reopen
swmenu.currentStale=1;
if (swmenu.reloadURL!='' && swmenu.reloadURL!= null) {
swmenu.switchbutton
(3,1,'reload.gif','return','location','go(reloadURL)','Return to the last known location in the course sequence');
}
swmenu.clearbut(7,1);
swmenu.clearbut(7,2);
swmenu.clearbut(7,3);
swmenu.menucltim=swmenu.setTimeout(
'clearbut(2,1);clearbut(2,3);clearbut(8,1);clearbut(8,2);clearbut(8,3);'+
'clearbut(9,1);clearbut(9,2);clearbut(9,3);clearbut(6,3);clearbut(6,1)',
2000);
}
// END LON-CAPA Internal
ENDREGTHIS
} else {
$result = (<
// BEGIN LON-CAPA Internal
function LONCAPAreg() {
swmenu=$reopen
$timesync
swmenu.currentStale=1;
swmenu.clearbut(2,1);
swmenu.clearbut(2,3);
swmenu.clearbut(8,1);
swmenu.clearbut(8,2);
swmenu.clearbut(8,3);
if (swmenu.currentURL) {
swmenu.switchbutton
(3,1,'reload.gif','return','location','go(currentURL)');
} else {
swmenu.clearbut(3,1);
}
}
function LONCAPAstale() {
}
// END LON-CAPA Internal
ENDDONOTREGTHIS
}
return $result;
}
sub loadevents() {
return 'LONCAPAreg();';
}
sub unloadevents() {
return 'LONCAPAstale();';
}
# ============================================================= Start up remote
sub startupremote {
my ($lowerurl)=@_;
if ($ENV{'browser.interface'} eq 'textual') {
return ('');
}
my $configmenu=&rawconfig();
return(<
function wheelswitch() {
if (window.status=='|') {
window.status='/';
} else {
if (window.status=='/') {
window.status='-';
} else {
if (window.status=='-') {
window.status='\\\\';
} else {
if (window.status=='\\\\') { window.status='|'; }
}
}
}
}
// ---------------------------------------------------------- The wait function
var canceltim;
function wait() {
if ((menuloaded==1) || (tim==1)) {
window.status='Done.';
if (tim==0) {
clearTimeout(canceltim);
$configmenu
window.location='$lowerurl';
} else {
alert("Remote Control timed out. It is possible that it was blocked by pop-up window filters.");
}
} else {
wheelswitch();
setTimeout('wait();',200);
}
}
function main() {
canceltim=setTimeout('tim=1;',60000);
window.status='-';
wait();
}
ENDREMOTESTARTUP
}
sub setflags() {
return(<
menuloaded=0;
tim=0;
ENDSETFLAGS
}
sub maincall() {
if ($ENV{'browser.interface'} eq 'textual') { return ''; }
return(<
main();
ENDMAINCALL
}
# ================================================================= Reopen menu
sub reopenmenu {
my $nothing='';
if ($ENV{'browser.interface'} eq 'textual') { return ''; }
my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
if ($ENV{'browser.type'} eq 'explorer') { $nothing='javascript:void(0);'; }
return('window.open("'.$nothing.'","'.$menuname.'","",false);');
}
# =============================================================== Open the menu
sub open {
my $returnval='';
if ($ENV{'browser.interface'} eq 'textual') { return ''; }
my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
unless (shift eq 'unix') {
# resizing does not work on linux because of virtual desktop sizes
$returnval.=(<'.$returnval.'';
}
# ================================================================== Raw Config
sub clear {
my ($row,$col)=@_;
unless ($ENV{'browser.interface'} eq 'textual') {
return "\n".qq(window.status+='.';swmenu.clearbut($row,$col););
} else { return ''; }
}
# 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)=@_;
$act=~s/\$uname/$uname/g;
$act=~s/\$udom/$udom/g;
unless ($ENV{'browser.interface'} eq 'textual') {
return "\n".
qq(window.status+='.';swmenu.switchbutton($row,$col,"$img","$top","$bot","$act","$desc"););
} else {
my $text=$top.' '.$bot;
$text=~s/\- //;
return '
'.$text.' '.$desc;
}
}
sub secondlevel {
my $output='';
my
($uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc)=@_;
if ($prt eq 'any') {
$output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc);
} elsif ($prt=~/^r(\w+)/) {
if ($rol eq $1) {
$output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc);
}
}
return $output;
}
sub openmenu {
my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
if ($ENV{'browser.interface'} eq 'textual') { return ''; }
if ($ENV{'browser.type'} eq 'explorer') {
return "window.open('javascript:void(0);','".$menuname."');";
} else {
return "window.open('','".$menuname."');";
}
}
sub rawconfig {
my $textualoverride=shift;
my $output='';
unless ($ENV{'browser.interface'} eq 'textual') {
$output.=
"window.status='Opening Remote Control';var swmenu=".&openmenu().
"\nwindow.status='Configuring Remote Control ';";
} else {
unless ($textualoverride) { return ''; }
}
my $uname=$ENV{'user.name'};
my $udom=$ENV{'user.domain'};
my $adv=$ENV{'user.adv'};
my $author=$ENV{'user.author'};
my $crs='';
if ($ENV{'request.course.id'}) {
$crs='/'.$ENV{'request.course.id'};
if ($ENV{'request.course.sec'}) {
$crs.='_'.$ENV{'request.course.sec'};
}
$crs=~s/\_/\//g;
}
my $pub=($ENV{'request.state'} eq 'published');
my $con=($ENV{'request.state'} eq 'construct');
my $rol=$ENV{'request.role'};
my $requested_domain = $ENV{'request.role.domain'};
foreach (@desklines) {
my ($row,$col,$pro,$prt,$img,$top,$bot,$act,$desc)=split(/\:/,$_);
$prt=~s/\$uname/$uname/g;
$prt=~s/\$udom/$udom/g;
$prt=~s/\$crs/$crs/g;
$prt=~s/\$requested_domain/$requested_domain/g;
if ($pro eq 'clear') {
$output.=&clear($row,$col);
} elsif ($pro eq 'any') {
$output.=&secondlevel(
$uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc);
} elsif ($pro eq 'smp') {
unless ($adv) {
$output.=&secondlevel(
$uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc);
}
} elsif ($pro eq 'adv') {
if ($adv) {
$output.=&secondlevel(
$uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc);
}
} elsif (($pro=~/p(\w+)/) && ($prt)) {
if (&Apache::lonnet::allowed($1,$prt)) {
$output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc);
}
} elsif ($pro eq 'course') {
if ($ENV{'request.course.fn'}) {
$output.=switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc);
}
} elsif ($pro eq 'author') {
if ($author) {
if ((($prt eq 'rca') && ($ENV{'request.role'}=~/^ca/)) ||
(($prt eq 'rau') && ($ENV{'request.role'}=~/^au/))) {
# Check that we are on the correct machine
my $cadom=$requested_domain;
my $caname=$ENV{'user.name'};
if ($prt eq 'rca') {
($cadom,$caname)=
($ENV{'request.role'}=~/(\w+)\/(\w+)$/);
}
$act =~ s/\$caname/$caname/g;
my $home = &Apache::lonnet::homeserver($caname,$cadom);
if ($home eq $Apache::lonnet::perlvar{'lonHostID'}) {
$output.=switch($caname,$cadom,
$row,$col,$img,$top,$bot,$act,$desc);
}
}
}
}
}
unless ($ENV{'browser.interface'} eq 'textual') {
$output.="\nwindow.status='Synchronizing Time';swmenu.syncclock(1000*".time.");\nwindow.status='Remote Control Configured.';";
}
return $output;
}
# ======================================================================= Close
sub close {
if ($ENV{'browser.interface'} eq 'textual') { return ''; }
my $menuname='LCmenu'.$Apache::lonnet::perlvar{'lonHostID'};
return(<
window.status='Accessing Remote Control';
menu=window.open("/adm/rat/empty.html","$menuname",
"height=350,width=150,scrollbars=no,menubar=no");
window.status='Disabling Remote Control';
menu.active=0;
menu.autologout=0;
window.status='Closing Remote Control';
menu.close();
window.status='Done.';
ENDCLOSE
}
# ====================================================================== Footer
sub footer {
}
# ================================================ Handler when called directly
sub handler {
my $r = shift;
$r->content_type('text/html');
$r->send_http_header;
return OK if $r->header_only;
my $bodytag=&Apache::loncommon::bodytag('Main Menu');
# ------------------------------------------------------------ Print the screen
$r->print(<
LON-CAPA Main Menu
$bodytag
ENDHEADER
$r->print(&rawconfig(1));
$r->print('