# The LearningOnline Network with CAPA # Routines to control the menu # # $Id: lonmenu.pm,v 1.366 2011/12/28 22:41:02 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 is one parameter controlling the action of this module: # =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 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 @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; use strict; use Apache::lonnet; use Apache::lonhtmlcommon(); use Apache::loncommon(); use Apache::lonenc(); use Apache::lonlocal; use Apache::lonmsg(); use LONCAPA qw(:DEFAULT :match); use HTML::Entities(); use Apache::lonwishlist(); use vars qw(@desklines %category_names %category_members %category_positions $readdesk @primary_menu @secondary_menu); my @inlineremote; 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 '
  • $link
  • |; } # primary_menu() 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 sub primary_menu { my $menu; # each element of @primary contains following array: # (link url, icon path, alt text, link text, condition) my $public; if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')) || (($env{'user.name'} eq '') && ($env{'user.domain'} eq ''))) { $public = 1; } foreach my $menuitem (@primary_menu) { # evaluate conditions next if ref($menuitem) ne 'ARRAY'; # next if $$menuitem[4] eq 'nonewmsg' # show links depending on && &Apache::lonmsg::mynewmail(); # whether a new msg next if $$menuitem[4] eq 'newmsg' # arrived or not && !&Apache::lonmsg::mynewmail(); # next if $$menuitem[4] !~ /public/ ##we've a public user, && $public; ##who should not see all ##links next if $$menuitem[4] eq 'onlypublic'# hide links which are && !$public; # only visible to public # users next if $$menuitem[4] eq 'roles' ##show links depending on && &Apache::loncommon::show_course(); ##term 'Courses' or next if $$menuitem[4] eq 'courses' ##'Roles' wanted && !&Apache::loncommon::show_course(); ## if ($$menuitem[3] eq 'Help') { # special treatment for helplink if ($public) { my $origmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; my $defdom = &Apache::lonnet::default_login_domain(); my $to = &Apache::loncommon::build_recipient_list(undef, 'helpdeskmail', $defdom,$origmail); if ($to ne '') { $menu .= &prep_menuitem($menuitem); } } else { $menu .= '
  • '.&Apache::loncommon::top_nav_help('Help').'
  • '; } } else { $menu .= prep_menuitem($menuitem); } } $menu =~ s/\[domain\]/$env{'user.domain'}/g; $menu =~ s/\[user\]/$env{'user.name'}/g; return "
      $menu
    "; } #returns hashref {user=>'',dom=>''} containing: # own name, domain if user is au # name, domain of parent author if user is ca or aa #empty return if user is not an author or not on homeserver # #TODO this should probably be moved somewhere more central #since it can be used by different parts of the system sub getauthor{ return unless $env{'request.role'}=~/^(ca|aa|au)/; #nothing to do if user isn't some kind of author #co- or assistent author? my ($dom, $user) = ($env{'request.role'} =~ /^(?:ca|aa)\.\/($match_domain)\/($match_username)$/) ? ($1, $2) #domain, username of the parent author : @env{ ('request.role.domain', 'user.name') }; #own domain, username # current server == home server? my $home = &Apache::lonnet::homeserver($user,$dom); foreach (&Apache::lonnet::current_machine_ids()){ return {user => $user, dom => $dom} if $_ eq $home; } # if wrong server return; } sub secondary_menu { my $menu; my $crstype = &Apache::loncommon::course_type(); my $crs_sec = $env{'request.course.id'} . ($env{'request.course.sec'} ? "/$env{'request.course.sec'}" : ''); my $canedit = &Apache::lonnet::allowed('mdc', $env{'request.course.id'}); my $canviewgrps = &Apache::lonnet::allowed('vcg', $crs_sec); my $canmodifyuser = &Apache::lonnet::allowed('cst', $crs_sec); my $canviewwnew = &Apache::lonnet::allowed('whn', $crs_sec); my $canmodpara = &Apache::lonnet::allowed('opa', $crs_sec); my $canvgr = &Apache::lonnet::allowed('vgr', $crs_sec); my $canmgr = &Apache::lonnet::allowed('mgr', $crs_sec); my $author = &getauthor(); my %groups = &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'}); foreach my $menuitem (@secondary_menu) { # evaluate conditions next if ref($menuitem) ne 'ARRAY'; next if $$menuitem[4] ne 'always' && $$menuitem[4] ne 'author' && !$env{'request.course.id'}; next if $$menuitem[4] =~ /^mdc/ && !$canedit; next if $$menuitem[4] eq 'nvgr' && $canvgr; next if $$menuitem[4] eq 'vgr' && !$canvgr; next if $$menuitem[4] eq 'cst' && !$canmodifyuser; next if $$menuitem[4] eq 'ncst' && $canmodifyuser; next if $$menuitem[4] eq 'mgr' && !$canmgr; next if $$menuitem[4] eq 'nmgr' && $canmgr; next if $$menuitem[4] eq 'whn' && !$canviewwnew; next if $$menuitem[4] eq 'opa' && !$canmodpara; next if $$menuitem[4] =~ /showgroups$/ && !$canviewgrps && !%groups; next if $$menuitem[4] eq 'author' && !$author; if ($$menuitem[3] eq 'Roles' && $env{'request.course.id'}) { # special treatment for role selector my $roles_selector = &roles_selector( $env{'course.' . $env{'request.course.id'} . '.domain'}, $env{'course.' . $env{'request.course.id'} . '.num'} ); $menu .= $roles_selector ? "
  • $roles_selector
  • " : ''; } else { $menu .= &prep_menuitem(\@$menuitem); } } if ($menu =~ /\[url\].*\[symb\]/) { my $escurl = &escape( &Apache::lonenc::check_encrypt( $env{'request.noversionuri'})); my $escsymb = &escape( &Apache::lonenc::check_encrypt( $env{'request.symb'})); if ( $env{'request.state'} eq 'construct' and ( $env{'request.noversionuri'} eq '' || !defined($env{'request.noversionuri'}))) { my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'}; ($escurl = $env{'request.filename'}) =~ s{^\Q$londocroot\E}{}; $escurl = &escape($escurl); } $menu =~ s/\[url\]/$escurl/g; $menu =~ s/\[symb\]/$escsymb/g; } $menu =~ s/\[uname\]/$$author{user}/g; $menu =~ s/\[udom\]/$$author{dom}/g; return ""; } sub innerregister { my ($forcereg,$bread_crumbs) = @_; my $const_space = ($env{'request.state'} eq 'construct'); my $is_const_dir = 0; if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { return ''; } $env{'request.registered'} = 1; undef(@inlineremote); my $resurl; if ( $env{'request.symb'} && $env{'request.course.id'} ) { (my $mapurl, my $rid, $resurl) = &Apache::lonnet::decode_symb(&Apache::lonnet::symbread()); my $coursetitle = $env{'course.'.$env{'request.course.id'}.'.description'}; my $maptitle = &Apache::lonnet::gettitle($mapurl); my $restitle = &Apache::lonnet::gettitle(&Apache::lonnet::symbread()); #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 ($mapurl ne $env{'course.'.$env{'request.course.id'}.'.url'}) { push(@crumbs, {text => '...', no_mt => 1}); } push @crumbs, {text => $maptitle, no_mt => 1} if ($maptitle && $maptitle ne 'default.sequence' && $maptitle ne $coursetitle); push @crumbs, {text => $restitle, no_mt => 1} if $restitle; &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb(@crumbs); }elsif (! $const_space){ #a situation when we're looking at a resource outside of context of a #course or construction space (e.g. with cumulative rights) &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb({text => 'View Resource'}); } # ============================================================================= # ============================ This is for URLs that actually can be registered return '' unless ( ($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'}=~/$LONCAPA::assess_re/) { if (&Apache::lonnet::allowed('mgr',$crs)) { $hwkadd.=&switch('','',7,2,'pgrd.png','Content Grades','grades[_4]', "gocmd('/adm/grades','gradingmenu')", 'Content Grades'); } elsif (&Apache::lonnet::allowed('vgr',$crs)) { $hwkadd.=&switch('','',7,2,'subm.png','Content Submissions','missions[_1]', "gocmd('/adm/grades','submission')", 'Content Submissions'); } } if ($env{'request.symb'} ne '' && &Apache::lonnet::allowed('opa',$crs)) { $hwkadd.=&switch('','',7,3,'pparm.png','Content Settings','parms[_2]', "gocmd('/adm/parmset','set')", 'Content Settings'); } if ($env{'request.symb'}=~/^uploaded/ && &Apache::lonnet::allowed('mdc',$crs)) { $hwkadd.=&switch('','',7,4,'docs.png','Folder/Page Content','parms[_2]', "gocmd('/adm/coursedocs','direct')", 'Folder/Page Content'); } # -- 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)/) { # # We have the role of an author # # Set defaults for authors my ($top,$bottom) = ('con-','struct'); my $action = "go('/priv/".$env{'user.domain'}.'/'.$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/".$cadom.'/'.$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/".$cadom.'/'.$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; } } # # We are an author for some stuff, but currently do not have the role of author. # Figure out if we have authoring privileges for the resource we are looking at. # This should maybe become a privilege check in lonnet # ## ## Determine if user can edit url. ## my $cfile=''; my $cfuname=''; my $cfudom=''; my $uploaded; my $switchserver=''; my $home; if ($env{'request.filename'}) { my $file=&Apache::lonnet::declutter($env{'request.filename'}); if (defined($cnum) && defined($cdom)) { $uploaded = &is_course_upload($file,$cnum,$cdom); } if (!$uploaded) { $file=~s{^(priv/$match_domain/$match_username)}{/$1}; $file=~s{^($match_domain/$match_username)}{/priv/$1}; # Check that the user has permission to edit this resource my $setpriv = 1; ($cfuname,$cfudom)=&Apache::loncacc::constructaccess($file,$setpriv); if (defined($cfudom)) { $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; } else { $switchserver=$file; } } } } # Finally, turn the button on or off if (($cfile || $switchserver) && !$const_space) { my $nocrsedit; # Suppress display where CC has switched to student role. if ($env{'request.course.id'}) { unless(&Apache::lonnet::allowed('mdc', $env{'request.course.id'})) { $nocrsedit = 1; } } if ($nocrsedit) { $editbutton=&clear(6,1); } else { my $bot = "go('$cfile')"; if ($switchserver) { if ( $env{'request.symb'} && $env{'request.course.id'} ) { $cfile = '/adm/switchserver?otherserver='.$home.'&role='. &HTML::Entities::encode($env{'request.role'},'"<>&').'&symb='. &HTML::Entities::encode($env{'request.symb'},'"<>&'); $bot = "need_switchserver('$cfile');"; } } $editbutton=&switch ('','',6,1,'pcstr.png','Edit','resource[_2]', $bot,"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.png','Edit', 'resource[_2]',"go('".$cfile."');", 'Edit this resource'); } } } } } if ($env{'request.course.id'}) { if ($resurl eq "public/$cdom/$cnum/syllabus") { if ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ /\w/) { if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) { $editbutton=&switch('','',6,1,'pcstr.png','Edit', 'resource[_2]', "go('/adm/courseprefs?phase=display&actions=courseinfo')", 'Edit this resource'); } } } } ### ### # Prepare the rest of the buttons my $menuitems; if ($const_space) { # # We are in construction space # my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'}; my ($udom,$uname,$thisdisfn) = ($env{'request.filename'}=~m{^\Q$londocroot/priv/\E([^/]+)/([^/]+)/(.*)$}); my $currdir = '/priv/'.$udom.'/'.$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); # # Probably should be in mydesk.tab # $menuitems=(< 0){ $menuitems.="anot2.png"; }else{ $menuitems.="anot.png"; } $menuitems.="&Notes&&annotate()&"; $menuitems.="Make notes and annotations about this resource&&1\n"; unless ($env{'request.noversionuri'}=~/\/(bulletinboard|smppg|navmaps|syllabus|aboutme|viewclasslist|portfolio)(\?|$)/) { if ((!$env{'request.enc'}) && ($env{'request.noversionuri'} !~ m{^/adm/wrapper/ext/})) { $menuitems.=(<&'); } } return $cfile; } # ================================================================== Raw Config sub clear { my ($row,$col)=@_; $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); my $idx=10*$row+$col; $category_members{$cat}.=':'.$idx; # Inline Menu if ($nobreak==2) { return ''; } my $text=$top.' '.$bot; $text=~s/\s*\-\s*//gs; my $pic= ''.$text.''; if ($env{'browser.interface'} eq 'faketextual') { # Main Menu if ($nobreak==3) { $inlineremote[$idx]="\n". ''.$text. ''. ''.$pic.''; } elsif ($nobreak) { $inlineremote[$idx]="\n". ''. ''.$pic.' '.$text.''; } else { $inlineremote[$idx]="\n". ''. ''.$pic. ''. ''.$desc.''; } } else { # Inline Menu $inlineremote[$idx]= ''.$pic. ''.$top.' '; } return ''; } sub secondlevel { my $output=''; my ($uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat)=@_; if ($prt eq 'any') { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } elsif ($prt=~/^r(\w+)/) { if ($rol eq $1) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } return $output; } sub inlinemenu { undef(@inlineremote); undef(%category_members); # calling rawconfig with "1" will evaluate mydesk.tab, even if there is no active remote control &rawconfig(1); my $output=''; for (my $col=1; $col<=2; $col++) { $output.='"; } $output.="
    '; for (my $row=1; $row<=8; $row++) { foreach my $cat (keys(%category_members)) { if ($category_positions{$cat} ne "$col,$row") { next; } #$output.=''; $output.='
    '; $output.='

    '.&mt($category_names{$cat}).'

    '; $output.='
    '.&mt($category_names{$cat}).'
    '; my %active=(); foreach my $menu_item (split(/\:/,$category_members{$cat})) { if ($inlineremote[$menu_item]) { $active{$menu_item}=1; } } foreach my $item (sort(keys(%active))) { $output.=$inlineremote[$item]; } $output.='
    '; $output.=''; } } $output.="
    "; return $output; } sub rawconfig { # # This evaluates mydesk.tab # Need to add more positions and more privileges to deal with all # menu items. # my $textualoverride=shift; my $output=''; return '' unless $textualoverride; my $uname=$env{'user.name'}; my $udom=$env{'user.domain'}; my $adv=$env{'user.adv'}; my $show_course=&Apache::loncommon::show_course(); my $author=$env{'user.author'}; my $crs=''; my $crstype=''; if ($env{'request.course.id'}) { $crs='/'.$env{'request.course.id'}; if ($env{'request.course.sec'}) { $crs.='_'.$env{'request.course.sec'}; } $crs=~s/\_/\//g; $crstype = &Apache::loncommon::course_type(); } 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 my $line (@desklines) { my ($row,$col,$pro,$prt,$img,$top,$bot,$act,$desc,$cat)=split(/\:/,$line); $prt=~s/\$uname/$uname/g; $prt=~s/\$udom/$udom/g; if ($prt =~ /\$crs/) { next unless ($env{'request.course.id'}); next if ($crstype eq 'Community'); $prt=~s/\$crs/$crs/g; } elsif ($prt =~ /\$cmty/) { next unless ($env{'request.course.id'}); next if ($crstype ne 'Community'); $prt=~s/\$cmty/$crs/g; } $prt=~s/\$requested_domain/$requested_domain/g; if ($category_names{$cat}!~/\w/) { $cat='oth'; } 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,$cat); } elsif ($pro eq 'smp') { unless ($adv) { $output.=&secondlevel( $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'adv') { if ($adv) { $output.=&secondlevel( $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'shc') { if ($show_course) { $output.=&secondlevel( $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'nsc') { if (!$show_course) { $output.=&secondlevel( $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat); } } elsif (($pro=~/^p(\w+)/) && ($prt)) { my $priv = $1; if ($priv =~ /^mdc(Course|Community)/) { if ($crstype eq $1) { $priv = 'mdc'; } else { next; } } if (&Apache::lonnet::allowed($priv,$prt)) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'course') { if (($env{'request.course.fn'}) && ($crstype ne 'Community')) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'community') { if (($env{'request.course.fn'}) && ($crstype eq 'Community')) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro =~ /^courseenv_(.*)$/) { my $key = $1; if ($crstype ne 'Community') { my $coursepref = $env{'course.'.$env{'request.course.id'}.'.'.$key}; if ($key eq 'canuse_pdfforms') { if ($env{'request.course.id'} && $coursepref eq '') { my %domdefs = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'}); $coursepref = $domdefs{'canuse_pdfforms'}; } } if ($coursepref) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } } elsif ($pro =~ /^communityenv_(.*)$/) { my $key = $1; if ($crstype eq 'Community') { my $coursepref = $env{'course.'.$env{'request.course.id'}.'.'.$key}; if ($key eq 'canuse_pdfforms') { if ($env{'request.course.id'} && $coursepref eq '') { my %domdefs = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'}); $coursepref = $domdefs{'canuse_pdfforms'}; } } if ($coursepref) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } } elsif ($pro =~ /^course_(.*)$/) { # Check for permissions inside of a course if (($env{'request.course.id'}) && ($crstype ne 'Community') && (&Apache::lonnet::allowed($1,$env{'request.course.id'}. ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')) )) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro =~ /^community_(.*)$/) { # Check for permissions inside of a community if (($env{'request.course.id'}) && ($crstype eq 'Community') && (&Apache::lonnet::allowed($1,$env{'request.course.id'}. ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')) )) { $output.=&switch($uname,$udom,$row,$col,$img,$top,$bot,$act,$desc,$cat); } } elsif ($pro eq 'author') { if ($author) { if ((($prt eq 'rca') && ($env{'request.role'}=~/^ca/)) || (($prt eq 'raa') && ($env{'request.role'}=~/^aa/)) || (($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') || ($prt eq 'raa')) { ($cadom,$caname)= ($env{'request.role'}=~/($match_domain)\/($match_username)$/); } $act =~ s/\$caname/$caname/g; $act =~ s/\$cadom/$cadom/g; 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) { $output.=&switch($caname,$cadom, $row,$col,$img,$top,$bot,$act,$desc,$cat); } } } } elsif ($pro eq 'tools') { my @tools = ('aboutme','blog','portfolio'); if (grep(/^\Q$prt\E$/,@tools)) { if (!&Apache::lonnet::usertools_access($env{'user.name'}, $env{'user.domain'}, $prt,undef,'tools')) { $output.=&clear($row,$col); next; } } elsif (($prt eq 'reqcrsnsc') || ($prt eq 'reqcrsshc')) { if (($prt eq 'reqcrsnsc') && ($show_course)) { next; } if (($prt eq 'reqcrsshc') && (!$show_course)) { next; } my $showreqcrs = &check_for_rcrs(); if (!$showreqcrs) { $output.=&clear($row,$col); next; } } $prt='any'; $output.=&secondlevel( $uname,$udom,$rol,$crs,$pub,$con,$row,$col,$prt,$img,$top,$bot,$act,$desc,$cat); } } return $output; } sub check_for_rcrs { my $showreqcrs = 0; my @reqtypes = ('official','unofficial','community'); foreach my $type (@reqtypes) { if (&Apache::lonnet::usertools_access($env{'user.name'}, $env{'user.domain'}, $type,undef,'requestcourses')) { $showreqcrs = 1; last; } } if (!$showreqcrs) { foreach my $type (@reqtypes) { if ($env{'environment.reqcrsotherdom.'.$type} ne '') { $showreqcrs = 1; last; } } } return $showreqcrs; } sub dc_popup_js { my %lt = &Apache::lonlocal::texthash( more => '(More ...)', less => '(Less ...)', ); return <<"END"; function showCourseID() { document.getElementById('dccid').style.display='block'; document.getElementById('dccid').style.textAlign='left'; document.getElementById('dccid').style.textFace='normal'; document.getElementById('dccidtext').innerHTML ='$lt{'less'}'; return; } function hideCourseID() { document.getElementById('dccid').style.display='none'; document.getElementById('dccidtext').innerHTML ='$lt{'more'}'; return; } END } sub utilityfunctions { my $currenturl=&Apache::lonnet::clutter(&Apache::lonnet::fixversion((split(/\?/,$env{'request.noversionuri'}))[0])); if ($currenturl =~ m{^/adm/wrapper/ext/} && $env{'request.external.querystring'} ) { $currenturl .= ($currenturl=~/\?/)?'&':'?'.$env{'request.external.querystring'}; } $currenturl=&Apache::lonenc::check_encrypt(&unescape($currenturl)); my $currentsymb=&Apache::lonenc::check_encrypt($env{'request.symb'}); my $dc_popup_cid; if ($env{'user.adv'} && exists($env{'user.role.dc./'. $env{'course.'.$env{'request.course.id'}. '.domain'}.'/'})) { $dc_popup_cid = &dc_popup_js(); } my $start_page_annotate = &Apache::loncommon::start_page('Annotator',undef, {'only_body' => 1, 'js_ready' => 1, 'bgcolor' => '#BBBBBB', 'add_entries' => { 'onload' => 'javascript:document.goannotate.submit();'}}); my $end_page_annotate = &Apache::loncommon::end_page({'js_ready' => 1}); my $confirm_switch = &mt("Editing requires switching to the resource's home server.").'\n'. &mt('Switch server?'); return (<" +"" +"<\\/form>" +'$end_page_annotate'); annotator.document.close(); } function open_Wishlist_Import(rat) { var newWin; if (rat) { newWin = window.open('/adm/wishlist?inhibitmenu=yes&mode=import&rat='+rat, 'wishlistImport','scrollbars=1,resizable=1,menubar=0'); } else { newWin = window.open('/adm/wishlist?inhibitmenu=yes&mode=import', 'wishlistImport','scrollbars=1,resizable=1,menubar=0'); } newWin.focus(); } ENDUTILITY } sub serverform { return(< ENDSERVERFORM } sub constspaceform { return(<
    ENDCONSTSPACEFORM } sub hidden_button_check { if ( $env{'request.course.id'} eq '' || $env{'request.role.adv'} ) { return; } my $buttonshide = &Apache::lonnet::EXT('resource.0.buttonshide'); return $buttonshide; } sub roles_selector { my ($cdom,$cnum) = @_; my $crstype = &Apache::loncommon::course_type(); my $now = time; my (%courseroles,%seccount,%courseprivs); my $is_cc; my $role_selector; my $ccrole; if ($crstype eq 'Community') { $ccrole = 'co'; } else { $ccrole = 'cc'; } my $priv; my $destinationurl = $ENV{'REQUEST_URI'}; my $reqprivs = &required_privs(); if (ref($reqprivs) eq 'HASH') { my $destination = $destinationurl; $destination =~ s/(\?.*)$//; if (exists($reqprivs->{$destination})) { $priv = $reqprivs->{$destination}; } } if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) { my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}); if ((($start) && ($start<0)) || (($end) && ($end<$now)) || (($start) && ($now<$start))) { $is_cc = 0; } else { $is_cc = 1; } } if ($is_cc) { &get_all_courseroles($cdom,$cnum,\%courseroles,\%seccount,\%courseprivs,$priv); } else { my %gotnosection; foreach my $item (keys(%env)) { if ($item =~ m-^user\.role\.([^.]+)\./\Q$cdom\E/\Q$cnum\E/?(\w*)$-) { my $role = $1; my $sec = $2; next if ($role eq 'gr'); my ($start,$end) = split(/\./,$env{$item}); next if (($start && $start > $now) || ($end && $end < $now)); if ($sec eq '') { if (!$gotnosection{$role}) { $seccount{$role} ++; $gotnosection{$role} = 1; } } if ($priv ne '') { my $cnumsec = $cnum; if ($sec ne '') { $cnumsec .= "/$sec"; } $courseprivs{"$role./$cdom/$cnumsec./"} = $env{"user.priv.$role./$cdom/$cnumsec./"}; $courseprivs{"$role./$cdom/$cnumsec./$cdom/"} = $env{"user.priv.$role./$cdom/$cnumsec./$cdom/"}; $courseprivs{"$role./$cdom/$cnumsec./$cdom/$cnumsec"} = $env{"user.priv.$role./$cdom/$cnumsec./$cdom/$cnumsec"}; } if (ref($courseroles{$role}) eq 'ARRAY') { if ($sec ne '') { if (!grep(/^\Q$sec\E$/,@{$courseroles{$role}})) { push(@{$courseroles{$role}},$sec); $seccount{$role} ++; } } } else { @{$courseroles{$role}} = (); if ($sec ne '') { $seccount{$role} ++; push(@{$courseroles{$role}},$sec); } } } } } my $switchtext; if ($crstype eq 'Community') { $switchtext = &mt('Switch community role to...') } else { $switchtext = &mt('Switch course role to...') } my @roles_order = ($ccrole,'in','ta','ep','ad','st'); if (keys(%courseroles) > 1) { $role_selector = &jump_to_role($cdom,$cnum,\%seccount,\%courseroles,\%courseprivs,$priv); $role_selector .= '
    '."\n". ''."\n". ''."\n". ''."\n". ''."\n". '
    '; } return $role_selector; } sub get_all_courseroles { my ($cdom,$cnum,$courseroles,$seccount,$courseprivs) = @_; unless ((ref($courseroles) eq 'HASH') && (ref($seccount) eq 'HASH') && (ref($courseprivs) eq 'HASH')) { return; } my ($result,$cached) = &Apache::lonnet::is_cached_new('getcourseroles',$cdom.'_'.$cnum); if (defined($cached)) { if (ref($result) eq 'HASH') { if ((ref($result->{'roles'}) eq 'HASH') && (ref($result->{'seccount'}) eq 'HASH') && (ref($result->{'privs'}) eq 'HASH')) { %{$courseroles} = %{$result->{'roles'}}; %{$seccount} = %{$result->{'seccount'}}; %{$courseprivs} = %{$result->{'privs'}}; return; } } } my %gotnosection; my %adv_roles = &Apache::lonnet::get_course_adv_roles($env{'request.course.id'},1); foreach my $role (keys(%adv_roles)) { my ($urole,$usec) = split(/:/,$role); if (!$gotnosection{$urole}) { $seccount->{$urole} ++; $gotnosection{$urole} = 1; } if (ref($courseroles->{$urole}) eq 'ARRAY') { if ($usec ne '') { if (!grep(/^Q$usec\E$/,@{$courseroles->{$urole}})) { push(@{$courseroles->{$urole}},$usec); $seccount->{$urole} ++; } } } else { @{$courseroles->{$urole}} = (); if ($usec ne '') { $seccount->{$urole} ++; push(@{$courseroles->{$urole}},$usec); } } my $area = '/'.$cdom.'/'.$cnum; if ($usec ne '') { $area .= '/'.$usec; } if ($role =~ /^cr\//) { &Apache::lonnet::custom_roleprivs($courseprivs,$urole,$cdom,$cnum,$urole.'.'.$area,$area); } else { &Apache::lonnet::standard_roleprivs($courseprivs,$urole,$cdom,$urole.'.'.$area,$cnum,$area); } } my %sections_count = &Apache::loncommon::get_sections($cdom,$cnum,['st']); @{$courseroles->{'st'}} = (); &Apache::lonnet::standard_roleprivs($courseprivs,'st',$cdom,"st./$cdom/$cnum",$cnum,"/$cdom/$cnum"); if (keys(%sections_count) > 0) { push(@{$courseroles->{'st'}},keys(%sections_count)); $seccount->{'st'} = scalar(keys(%sections_count)); } my $rolehash = { 'roles' => $courseroles, 'seccount' => $seccount, 'privs' => $courseprivs, }; &Apache::lonnet::do_cache_new('getcourseroles',$cdom.'_'.$cnum,$rolehash); return; } sub jump_to_role { my ($cdom,$cnum,$seccount,$courseroles,$courseprivs,$priv) = @_; my %lt = &Apache::lonlocal::texthash( this => 'This role has section(s) associated with it.', ente => 'Enter a specific section.', orlb => 'Enter a specific section, or leave blank for no section.', avai => 'Available sections are:', youe => 'You entered an invalid section choice:', plst => 'Please try again.', role => 'The role you selected is not permitted to view the current page.', swit => 'Switch role, but display Main Menu page instead?', ); my $js; if (ref($courseroles) eq 'HASH') { $js = ' var secpick = new Array("'.$lt{'ente'}.'","'.$lt{'orlb'}.'");'."\n". ' var numsec = new Array();'."\n". ' var rolesections = new Array();'."\n". ' var rolenames = new Array();'."\n". ' var roleseclist = new Array();'."\n"; my @items = keys(%{$courseroles}); for (my $i=0; $i<@items; $i++) { $js .= ' rolenames['.$i.'] = "'.$items[$i].'";'."\n"; my ($secs,$secstr); if (ref($courseroles->{$items[$i]}) eq 'ARRAY') { my @sections = sort { $a <=> $b } @{$courseroles->{$items[$i]}}; $secs = join('","',@sections); $secstr = join(', ',@sections); } $js .= ' rolesections['.$i.'] = new Array("'.$secs.'");'."\n". ' roleseclist['.$i.'] = "'.$secstr.'";'."\n". ' numsec['.$i.'] = "'.$seccount->{$items[$i]}.'";'."\n"; } } my $checkroles = 0; if ($priv && ref($courseprivs) eq 'HASH') { my (%disallowed,%allowed,@disallow); foreach my $role (sort(keys(%{$courseprivs}))) { my $trole; if ($role =~ m{^(.+?)\Q./$cdom/$cnum\E}) { $trole = $1; } if (($trole ne '') && ($trole ne 'cm')) { if ($courseprivs->{$role} =~ /\Q:$priv\E($|:|\&\w+)/) { $allowed{$trole} = 1; } else { $disallowed{$trole} = 1; } } } foreach my $trole (keys(%disallowed)) { unless ($allowed{$trole}) { push(@disallow,$trole); } } if (@disallow > 0) { $checkroles = 1; $js .= " var disallow = new Array('".join("','",@disallow)."');\n". " var rolecheck = 1;\n"; } } if (!$checkroles) { $js .= " var disallow = new Array();\n". " rolecheck = 0;\n"; } return <<"END"; END } sub required_privs { my $privs = { '/adm/parmset' => 'opa', '/adm/courseprefs' => 'opa', '/adm/whatsnew' => 'whn', '/adm/populate' => 'cst', '/adm/trackstudent' => 'vsa', '/adm/statistics' => 'vgr', '/adm/setblock' => 'dcm', }; unless ($env{'course.'.$env{'request.course.id'}.'.grading'} eq 'spreadsheet') { $privs->{'/adm/classcalc'} = 'vgr', $privs->{'/adm/assesscalc'} = 'vgr', $privs->{'/adm/studentcalc'} = 'vgr'; } return $privs; } # ================================================================ Main Program BEGIN { if (! defined($readdesk)) { { my $tabfile = $Apache::lonnet::perlvar{'lonTabDir'}.'/mydesk.tab'; if ( CORE::open( my $config,"<$tabfile") ) { while (my $configline=<$config>) { $configline=(split(/\#/,$configline))[0]; $configline=~s/^\s+//; chomp($configline); if ($configline=~/^cat\:/) { my @entries=split(/\:/,$configline); $category_positions{$entries[2]}=$entries[1]; $category_names{$entries[2]}=$entries[3]; } elsif ($configline=~/^prim\:/) { my @entries = (split(/\:/, $configline))[1..5]; push @primary_menu, \@entries; } elsif ($configline=~/^scnd\:/) { my @entries = (split(/\:/, $configline))[1..5]; push @secondary_menu, \@entries; } elsif ($configline) { push(@desklines,$configline); } } CORE::close($config); } } $readdesk='done'; } } 1; __END__