--- loncom/interface/lonhelpmenu.pm 2005/06/03 15:47:29 1.21 +++ loncom/interface/lonhelpmenu.pm 2025/02/20 03:05:34 1.50 @@ -1,6 +1,8 @@ # The LearningOnline Network with CAPA # generate frame-based help system # +# $Id: lonhelpmenu.pm,v 1.50 2025/02/20 03:05:34 raeburn Exp $ +# # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). @@ -32,21 +34,22 @@ use Apache::Constants qw(:common); use Apache::loncommon(); use Apache::lonlocal; use Apache::lonnet; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; +use HTML::Entities(); sub handler { my ($r) = @_; - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','color','function','faq','bug','topic','component_help','origurl','stayonpage']); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','faq','bug','topic','component_help','origurl','stayonpage']); &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; if ($r->header_only) { return OK; } - my $color = $env{'form.color'}; my $faq = $env{'form.faq'}; my $bug = $env{'form.bug'}; my $topic = $env{'form.topic'}; - my $function = $env{'form.function'}; my $component_help = $env{'form.component_help'}; my $origurl = $env{'form.origurl'}; my $stayOnPage = $env{'form.stayonpage'}; @@ -55,45 +58,47 @@ sub handler { $component_url = '/adm/help/'.$component_url.'.hlp'; } my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'}; - $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl; + $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl; if ($bug) { - $bugurl .= '&component='.$bug; + $bugurl .= '&component='.$bug; } my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'}; - my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; + my $origmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; + $origurl = &unescape($origurl); + my $defdom; + if ($env{'request.course.id'}) { + $defdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; + } elsif ($env{'request.role.domain'}) { + $defdom = $env{'request.role.domain'}; + } else { + $defdom = &Apache::lonnet::default_login_domain(); + } + my $requestmail = &Apache::loncommon::build_recipient_list(undef,'helpdeskmail', + $defdom,$origmail); if ($env{'form.page'} eq 'banner') { - &display_help_banner($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); + &display_help_banner($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); } elsif ($env{'form.page'} eq 'body') { - &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail); + &display_help_mainpage($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); } return OK; } sub display_help_banner { - my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; - my $bodytag = &Apache::loncommon::bodytag('',$function,'rightmargin="0" leftmargin="0" marginwidth="0" topmargin="1" marginheight="1"',1); - $bodytag=~s/[\n\r]/ /g; - my $fontcolor = &Apache::loncommon::designparm($function.'.font'); - my $alinkcolor = &Apache::loncommon::designparm($function.'.alink'); - my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink'); - my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg'); - my $tablecolor = &Apache::loncommon::designparm($function.'.tabbg'); - my $location=&Apache::loncommon::lonhttpdurl("/adm"); - if (($tablecolor eq '') || ($tablecolor eq '#FFFFFF')) { - $tablecolor = '#EEEE99'; - } + my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; + my $dom = $env{'request.role.domain'}; my $scripttag = ''; - if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { - my $displayurl = &Apache::lonnet::escape($origurl); + if ($requestmail) { + my $displayurl = &escape($origurl); $scripttag = (<<"SCRIPT_ONE"); - SCRIPT_TWO } - my $html=&Apache::lonxml::xmlbegin(); - $r->print(< -Help Banner - -$scripttag - -$bodytag -END + if ($stayOnPage) { - $r->print(''); + $r->print(&Apache::loncommon::start_page('Help',$scripttag, + {'no_secondary_menu' => 1,})); } else { - $r->print(''); + $r->print(&Apache::loncommon::start_page('Help',$scripttag, + {'only_body' => 1,})); } - $r->print(< - - - LON-CAPA help/support - - - - - - - - - - - -END + my $menu = &helpmenu_items($dom,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); + $r->print(''."\n"); + if ($menu) { + $r->print("$menu"); + } + if ($stayOnPage && $env{'user.adv'}) { + $r->print(''); + } + $r->print(''.&Apache::loncommon::end_page()); +} + +sub helpmenu_items { + my ($dom,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; + my $location=&Apache::loncommon::lonhttpdurl("/adm"); + my $general_help = &Apache::loncommon::general_help(); + my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'],$dom); + my %lt = &Apache::lonlocal::texthash( + general => 'General help', + component => 'Topic help', + faq => 'FAQ', + helpdesk => 'Ask helpdesk', + bugs => 'Report a bug', + manuals_web => 'Online manuals', + manuals_pdf => 'Printable manuals', + lastloc => 'Go back', + close => 'Close', + ); + my %alt = &Apache::lonlocal::texthash( + general => 'Intro help icon', + component => 'Topic icon', + faq => 'FAQ icon', + helpdesk => 'Helpdesk form icon', + bugs => 'Bug reporting icon', + manuals_web => 'HTML manuals icon', + manuals_pdf => 'PDF manuals icon', + lastloc => 'Return icon', + close => 'Close help icon', + ); + my ($target,$bugs_target); + if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) || + (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) { + $target = '_parent'; + $bugs_target = '_blank'; + } else { + $target = '_top'; + $bugs_target = '_top'; + } + my %items = ( + general => { + href => '/adm/help/'.$general_help.'.hlp', + img => $location.'/help/help.png', + alt => $alt{'general'}, + text => $lt{'general'}, + }, + component => { + href => $component_url, + img => $location.'/help/help.png', + alt => $alt{'component'}, + text => $topic, + }, + faq => { + href => $faqbaseurl.'fom/cache/'.$faq.'.html', + img => $location.'/lonMisc/smallFAQ.gif', + alt => $alt{'faq'}, + text => $lt{'faq'}, + }, + helpdesk => { + href => '#', + onclick => 'gohelpdesk()', + img => $location.'/lonIcons/helpdesk.gif', + alt => $alt{'helpdesk'}, + text => $lt{'helpdesk'}, + }, + bugs => { + href => $bugurl, + img => $location.'/lonMisc/smallBug.gif', + alt => $alt{'bugs'}, + text => $lt{'bugs'}, + target => $bugs_target, + }, + manuals_web => { + href => '', + img => $location.'/lonIcons/html.gif', + alt => $alt{'manuals_web'}, + text => $lt{'manuals_web'}, + }, + manuals_pdf => { + href => '', + img => $location.'/lonIcons/pdf.gif', + alt => $alt{'manuals_pdf'}, + text => $lt{'manuals_pdf'}, + }, + lastloc => { + href => &HTML::Entities::encode($origurl,'"&<>'), + img => '/res/adm/pages/tolastloc.png', + alt => $alt{'lastloc'}, + text => $lt{'lastloc'}, + target => $target, + }, + close => { + href => 'javascript:window.close()', + img => $location.'/lonIcons/close.gif', + alt => $alt{'close'}, + text => $lt{'close'}, + target => $target, + }, + ); + my %help_submenu = ( + manuals_web => [ + ['/adm/help/course.manual.access.hlp','Course Coordination','course'], + ['/adm/help/author.manual.access.hlp','Authoring','author'], + ], + manuals_pdf => [ + ['/adm/help/course.manual.pdf','Course Coordination','course'], + ['/adm/help/author.manual.pdf','Authoring','author'], + ], + ); + my @order = ('general'); if ($component_url) { - $r->print("". - ' Topic help '); + push(@order,'component'); + } + if ($requestmail) { + push(@order,'helpdesk'); } - if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { - $r->print(' - Ask helpdesk '); - } - if ($faq && $env{'user.adv'}) { - $r->print(< - FAQ - -END - } - if ($env{'user.adv'}) { - $r->print(< Report a bug -END + if ($env{'user.adv'} && $faq) { + push(@order,'faq'); + } + if (($env{'user.adv'}) && (($helpconfig{'helpsettings'}{'submitbugs'} eq '1') || ($helpconfig{'helpsettings'}{'submitbugs'} eq ''))) { + push(@order,'bugs'); } if ($stayOnPage) { - $r->print(< Return to last location -END + push(@order,('manuals_web','manuals_pdf','lastloc')); } else { - $r->print(< Close -END - } - $r->print(< - - - - - - - - - - - - - - - - - - -