--- loncom/interface/lonmenu.pm 2003/02/14 19:35:54 1.38
+++ loncom/interface/lonmenu.pm 2010/05/24 12:20:16 1.244.2.17
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Routines to control the menu
#
-# $Id: lonmenu.pm,v 1.38 2003/02/14 19:35:54 www Exp $
+# $Id: lonmenu.pm,v 1.244.2.17 2010/05/24 12:20:16 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,107 +25,529 @@
#
# http://www.lon-capa.org/
#
-# (TeX Conversion Module
#
-# 05/29/00,05/30 Gerd Kortemeyer)
+# There are two parameters controlling the action of this module:
#
-# 10/05,05/28,05/30,06/01,06/08,06/09,07/04,08/07 Gerd Kortemeyer
-# 02/15/02 Matthew Hall
+# 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::Constants qw(:common);
-use Apache::loncommon;
-use Apache::File;
-use vars qw(@desklines $readdesk);
+use Apache::lonhtmlcommon();
+use Apache::loncommon();
+use Apache::lonenc();
+use Apache::lonlocal;
+use LONCAPA qw(:DEFAULT :match);
+use HTML::Entities();
-# ======================================================= Make the menu buttons
+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 {
+ my %lt=&Apache::lonlocal::texthash('ret' => 'Return to Last Location',
+ 'nav' => 'Course Contents',
+ 'main' => 'Main Menu',
+ 'roles' => (&Apache::loncommon::show_course()?
+ 'Courses':'Roles'),
+ 'other' => 'Other Roles',
+ 'docs' => 'Course Editor',
+ 'exit' => 'Logout',
+ 'login' => 'Log In',
+ 'launch' => 'Launch Remote Control',
+ 'groups' => 'Groups',
+ );
+ if (&Apache::loncommon::course_type() eq 'Community') {
+ $lt{'nav'} = &mt('Community Contents');
+ $lt{'docs'} = &mt('Community Editor');
+ }
+ return %lt;
+}
sub menubuttons {
my $forcereg=shift;
- my $target =shift;
- unless ($ENV{'browser.interface'} eq 'textual') { return ''; }
- return "Menu here
";
+ 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
+ }
+ if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
+ $docs=(<$lt{'docs'}
+ENDDOCS
+ }
+ if ($showgroups) {
+ $groups =(<$lt{'groups'}
+ENDGROUPS
+ }
+ }
+ my $form=&serverform();
+ my $utility=&utilityfunctions();
+ my $output=(<
+// BEGIN LON-CAPA Internal
+$utility
+
+
':'').($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.filename'}=~/\.(problem|exam|quiz|assess|survey|form)$/) {
- if (&Apache::lonnet::allowed('vgr',$ENV{'request.course.id'})) {
- $hwkadd.=(< 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 {
- $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();';
}
-# ============================================================= Start up remote
sub startupremote {
my ($lowerurl)=@_;
- if ($ENV{'browser.interface'} eq 'textual') {
+ 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') { return ''; }
+ if (($env{'browser.interface'} eq 'textual') ||
+ ($env{'environment.remote'} eq 'off')) { return ''; }
return(<
+
ENDMAINCALL
}
-# ================================================================= Reopen menu
+
+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 {
- 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);');
+ 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);');
}
-# =============================================================== 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.=(<'."\n".
+ '// '."\n".
+ '';
}
- $returnval.=(<
ENDOPEN
- return '';
+ return '';
}
@@ -367,140 +1070,377 @@ ENDOPEN
sub clear {
my ($row,$col)=@_;
- unless ($ENV{'browser.interface'} eq 'textual') {
+ unless (($env{'browser.interface'} eq 'textual') ||
+ ($env{'environment.remote'} eq 'off')) {
return "\n".qq(window.status+='.';swmenu.clearbut($row,$col););
- } else { return ''; }
+ } 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)=@_;
+ my ($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat,$nobreak)=@_;
$act=~s/\$uname/$uname/g;
$act=~s/\$udom/$udom/g;
- unless ($ENV{'browser.interface'} eq 'textual') {
+ $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/\- //;
- return ' '.$text.' '.$desc;
+ $text=~s/\s*\-\s*//gs;
+
+ my $pic=
+ '';
+ if ($env{'browser.interface'} eq 'faketextual') {
+# Accessibility
+ if ($nobreak==3) {
+ $inlineremote[$idx]="\n".
+ '