--- loncom/interface/lonmenu.pm 2006/04/21 20:45:42 1.176 +++ loncom/interface/lonmenu.pm 2012/05/23 00:29:22 1.369.2.5 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Routines to control the menu # -# $Id: lonmenu.pm,v 1.176 2006/04/21 20:45:42 albertel Exp $ +# $Id: lonmenu.pm,v 1.369.2.5 2012/05/23 00:29:22 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,15 +26,132 @@ # 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 + +Loads contents of /home/httpd/lonTabs/mydesk.tab, +used to generate inline menu, and Main Menu page. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 GLOBAL VARIABLES + +=over + +=item @desklines + +Each element of this array contains a line of mydesk.tab that doesn't start with +cat, prim or scnd. +It gets filled in the BEGIN block of this module. + +=item %category_names + +The keys of this hash are the abbreviations used in mydesk.tab in those lines that +start with cat, the values are strings representing titles. +It gets filled in the BEGIN block of this module. + +=item %category_members + +TODO + +=item %category_positions + +The keys of this hash are the abbreviations used in mydesk.tab in those lines that +start with cat, its values are position vectors (column, row). +It gets filled in the BEGIN block of this module. + +=item $readdesk + +Indicates that mydesk.tab has been read. +It is set to 'done' in the BEGIN block of this module. + +=item @primary_menu + +The elements of this array reference arrays that are made up of the components +of those lines of mydesk.tab that start with prim:. +It is used by primary_menu() to generate the corresponding menu. +It gets filled in the BEGIN block of this module. + +=item %primary_sub_menu + +The keys of this hash reference are the names of items in the primary_menu array +which have sub-menus. For each key, the corresponding value is a reference to +an array containing components extracted from lines in mydesk.tab which begin +with primsub:. +This hash, which is used by primary_menu to generate sub-menus, is populated in +the BEGIN block. + +=item @secondary_menu + +The elements of this array reference arrays that are made up of the components +of those lines of mydesk.tab that start with scnd. +It is used by secondary_menu() to generate the corresponding menu. +It gets filled in the BEGIN block of this module. + +=back + +=head1 SUBROUTINES + +=over + +=item prep_menuitems(\@menuitem) + +This routine wraps a menuitem in proper HTML. It is used by primary_menu() and +secondary_menu(). + +=item primary_menu() + +This routine evaluates @primary_menu and returns XHTML for the menu +that contains following links: About, Message, Roles, Help, Logout +@primary_menu is filled within the BEGIN block of this module with +entries from mydesk.tab + +=item secondary_menu() + +Same as primary_menu() but operates on @secondary_menu. + +=item innerregister() + +This gets called in order to register a URL in the body of the document + +=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 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; @@ -44,270 +161,310 @@ use Apache::lonhtmlcommon(); use Apache::loncommon(); use Apache::lonenc(); use Apache::lonlocal; +use Apache::lonmsg(); +use LONCAPA qw(:DEFAULT :match); +use HTML::Entities(); -use vars qw(@desklines $readdesk); - +use vars qw(@desklines %category_names %category_members %category_positions + $readdesk @primary_menu %primary_submenu @secondary_menu %secondary_submenu); my @inlineremote; -# ================================================================ Little texts - -sub initlittle { - return &Apache::lonlocal::texthash('ret' => 'Return to Last Location', - 'nav' => 'Navigate Contents', - 'main' => 'Main Menu', - 'roles' => ($env{'user.adv'}? - 'Roles':'Courses'), - 'docs' => 'Course Documents', - 'exit' => 'Exit', - 'launch' => 'Launch Remote Control', - 'groups' => 'Groups'); -} - -sub get_colors { - my ($font,$pgbg,$tabbg); - if ($env{'browser.interface'} eq 'textual') { - $pgbg='#FFFFFF'; - $tabbg='#FFFFFF'; - $font='#000000'; - } else { - my $domain =&Apache::loncommon::determinedomain(); - my $function =&Apache::loncommon::get_users_function(); - - $pgbg =&Apache::loncommon::designparm($function.'.pgbg', $domain); - $tabbg =&Apache::loncommon::designparm($function.'.tabbg',$domain); - $font =&Apache::loncommon::designparm($function.'.font', $domain); - } - return ($font,$pgbg,$tabbg); -} -# ============================= This gets called at the top of the body section - -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 $showgroups=0; - my $escurl=&Apache::lonnet::escape(&Apache::lonenc::check_encrypt($env{'request.noversionuri'})); - my $escsymb=&Apache::lonnet::escape(&Apache::lonenc::check_encrypt($env{'request.symb'})); - - 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 = &Apache::lonnet::escape($returnurl); - } - } - if ($env{'request.course.id'}) { - my %coursegroups; - my $viewgrps_permission = - &Apache::lonnet::allowed('vcg',$env{'request.course.id'}); - if (!$viewgrps_permission) { - %coursegroups = &Apache::lonnet::get_active_groups($env{'user.domain'},$env{'user.name'},$env{'course.'.$env{'request.course.id'}.'.domain'}, $env{'course.'.$env{'request.course.id'}.'.num'}); - } - if ((keys(%coursegroups) > 0) || ($viewgrps_permission)) { - $showgroups = 1; +sub prep_menuitem { + my ($menuitem) = @_; + return '' unless(ref($menuitem) eq 'ARRAY'); + my $link; + if ($$menuitem[1]) { # graphical Link + $link = ""; + } else { # textual Link + $link = &mt($$menuitem[3]); + } + return '
$lt{'main'} | -$reloadlink -$navmaps -$docs -$groups -$lt{'launch'} | -$lt{'roles'} | -$lt{'exit'} | -LON-CAPA | -
';
- }
- if (($textual) && ($env{'request.symb'}) && ($env{'request.course.id'})) {
- my ($mapurl,$rid,$resurl)=
- &Apache::lonnet::decode_symb(&Apache::lonnet::symbread());
- $newmail.=$env{'course.'.$env{'request.course.id'}.'.description'};
- my $maptitle=&Apache::lonnet::gettitle($mapurl);
- my $restitle=&Apache::lonnet::gettitle(&Apache::lonnet::symbread());
- if ($maptitle && $maptitle ne 'default.sequence') {
- $newmail.=', '.$maptitle;
+#SD
+#course_type only Course and Community?
+#
+ my @crumbs;
+ unless (($forcereg) && ($env{'request.noversionuri'} eq '/adm/navmaps')
+ && ($mapurl eq $env{'course.'.$env{'request.course.id'}.'.url'})) {
+ @crumbs = ({text => Apache::loncommon::course_type()
+ . ' Contents',
+ href => "Javascript:gopost('/adm/navmaps','')"});
}
- if ($restitle) {
- $newmail.=': '.$restitle;
+ if ($mapurl ne $env{'course.'.$env{'request.course.id'}.'.url'}) {
+ push(@crumbs, {text => '...',
+ no_mt => 1});
}
- $newmail.=' ';
- }
- if (&Apache::lonmsg::newmail()) {
- $newmail=($textual?
- 'You have new messages ': - 'swmenu.setstatus("you have","messages");'); - } - if ($env{'request.state'} eq 'construct') { - $newmail = $titletable; - } else { - if ($noremote) { - $newmail.=' |