--- loncom/interface/lonhelpmenu.pm 2004/11/08 22:47:43 1.14 +++ loncom/interface/lonhelpmenu.pm 2018/05/08 01:19:06 1.46 @@ -1,6 +1,8 @@ # The LearningOnline Network with CAPA # generate frame-based help system # +# $Id: lonhelpmenu.pm,v 1.46 2018/05/08 01:19:06 raeburn Exp $ +# # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). @@ -30,168 +32,354 @@ use strict; use lib qw(/home/httpd/lib/perl); 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'}; + my $faq = $env{'form.faq'}; + my $bug = $env{'form.bug'}; + my $topic = $env{'form.topic'}; + my $component_help = $env{'form.component_help'}; + my $origurl = $env{'form.origurl'}; + my $stayOnPage = $env{'form.stayonpage'}; my $component_url = $component_help; if ($component_url) { $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'}; - if ($ENV{'form.page'} eq 'banner') { - &display_help_banner($r,$color,$function,$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); + 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,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); + } elsif ($env{'form.page'} eq 'body') { + &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 = '#CCCCFF'; + my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; + my $dom = $env{'request.role.domain'}; + my $scripttag = ''; + if ($requestmail) { + my $displayurl = &escape($origurl); + $scripttag = (<<"SCRIPT_ONE"); + +SCRIPT_TWO } - $r->print(< - -Help Banner - - -$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 - if (($component_url) || ($ENV{'user.adv'})) { - if ($component_url) { - $r->print(" - '); + my $menu = &helpmenu_items($dom,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); + 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 $target = '_top'; + if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) { + $target = '_parent'; + } + my %items = ( + general => { + href => '/adm/help/'.$general_help.'.hlp', + img => $location.'/help/help.png', + alt => $lt{'general'}, + text => $lt{'general'}, + }, + component => { + href => $component_url, + img => $location.'/help/help.png', + alt => $lt{'component'}, + text => $topic, + }, + faq => { + href => $faqbaseurl.'fom/cache/'.$faq.'.html', + img => $location.'/lonMisc/smallFAQ.gif', + alt => $lt{'faq'}, + text => $lt{'faq'}, + }, + helpdesk => { + href => '#', + onclick => 'gohelpdesk()', + img => $location.'/lonIcons/helpdesk.gif', + alt => $lt{'helpdesk'}, + text => $lt{'helpdesk'}, + }, + bugs => { + href => $bugurl, + img => $location.'/lonMisc/smallBug.gif', + alt => $lt{'bugs'}, + text => $lt{'bugs'}, + }, + manuals_web => { + href => '', + img => $location.'/lonIcons/html.gif', + alt => $lt{'manuals_web'}, + text => $lt{'manuals_web'}, + }, + manuals_pdf => { + href => '', + img => $location.'/lonIcons/pdf.gif', + alt => $lt{'manuals_pdf'}, + text => $lt{'manuals_pdf'}, + }, + lastloc => { + href => &HTML::Entities::encode($origurl,'"&<>'), + img => '/res/adm/pages/tolastloc.png', + alt => $lt{'lastloc'}, + text => $lt{'lastloc'}, + target => $target, + }, + close => { + href => 'javascript:window.close()', + img => $location.'/lonIcons/close.gif', + alt => $lt{'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) { + push(@order,'component'); } - if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { - $r->print(' - '); - } - if ($faq && $ENV{'user.adv'}) { - $r->print(< -  (FAQ) FAQ  - -END - } - if ($ENV{'user.adv'}) { - $r->print(< (Report a bug) Report a bug  -END + if ($requestmail) { + push(@order,'helpdesk'); + } + 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) Return to last location  -END + push(@order,('manuals_web','manuals_pdf','lastloc')); + } else { + push(@order,'close'); + } + my $menu; + foreach my $title (@order) { + my $menuitem = $items{$title}; + next unless (ref($menuitem) eq 'HASH'); + if (defined($help_submenu{$title})) { + my ($link,$target); + if ($menuitem->{href} ne '') { + $link = $menuitem->{href}; + $target = 'bodyframe'; + } else { + $link = '#'; + } + my @helpsub; + if (ref($help_submenu{$title}) eq 'ARRAY') { + foreach my $item (@{$help_submenu{$title}}) { + if (ref($item) eq 'ARRAY') { + if (($item->[2] eq 'course') || ($item->[2] eq 'author')) { + next unless($env{'user.adv'}); + } + push(@helpsub,$item); + } + } + if (@helpsub > 0) { + my $img; + if ($menuitem->{img}) { + $img = ''.$menuitem->{alt}.''; + } + $menu .= &create_submenu($link,$img,$target,$menuitem->{text},\@helpsub,1); + } elsif ($link ne '#') { + $menu .= '
  • '.$menuitem->{text}.'
    • '; + } + } + } else { + $menu .= &build_menuitem($menuitem); + } + } + return $menu; +} + +sub build_menuitem { + my ($menuitem) = @_; + return '' unless(ref($menuitem) eq 'HASH'); + my $link; + if ($menuitem->{img}) { + $link = ''.$menuitem->{alt}.' '; + } + if ($menuitem->{text}) { + $link .= $menuitem->{text}; + } + my $target; + if ($menuitem->{target}) { + $target = $menuitem->{target}; } else { - $r->print(< (Close window) Close  -END - } - $r->print(< -
     "); - } elsif ($ENV{'user.adv'}) { - $r->print(' '); - } - $r->print(' - (Topic help) Topic help  (Ask helpdesk) Ask helpdesk 
    -
    -
    -
    -
    -     		 
     
    - - -END + $target = 'bodyframe'; + } + my $onclick; + if ($menuitem->{onclick}) { + $onclick = ' onclick="'.$menuitem->{onclick}.';return false"'; + } + return '
  • '.$link.'
    • ', +} + +sub create_submenu { + my ($link,$img,$target,$title,$submenu,$translate) = @_; + return unless (ref($submenu) eq 'ARRAY'); + my $disptarget; + if ($target ne '') { + $disptarget = ' target="'.$target.'"'; + } + my $menu = '
  • '.$img. + ''. + ''.$title. + ''. + ' ▼'. + '
    • '; + return $menu; } sub display_help_mainpage { - my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_; - my $bodytag = &Apache::loncommon::bodytag('',$function,'topmargin="0" marginheight="0"',1); - $bodytag=~s/[\n\r]/ /g; + my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; + my %lt =&Apache::lonlocal::texthash( - 'heco' => 'Help Content', 'topp' => 'Topic Page', 'chen' => 'Choose an entry below to go directly to a relevant help page', 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.', 'vthp' => 'Visit the help page for ', 'disp' => 'Display the page in the inline help system that covers this topic.', 'crac' => 'Create an account for yourself in the LON-CAPA Bugzilla tracking system, if you wish to report bugs you have encountered in the LON-CAPA software, or if you have suggestions for improvements in LON-CAPA.', - 'inhs' => 'Inline help system for', - 'coth' => 'Consult the inline help system for this topic.', 'cont' => 'Contact the LON-CAPA support team', 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.', 'faqo' => 'FAQ-O-Matic Help system', @@ -201,21 +389,29 @@ sub display_help_mainpage { 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.' ); - $r->print(< - - $lt{'heco'} - -$bodytag -END - $r->print($lt{'chen'}); - if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { + if ($stayOnPage) { + $r->print(&Apache::loncommon::start_page('Help Content',undef, + {'no_secondary_menu' => 1,})); + } else { + $r->print(&Apache::loncommon::start_page('Help Content',undef, + {'only_body' => 1,})); + } + my $target = '_top'; + if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) { + $target = '_parent'; + } + if ($stayOnPage) { + $r->print('
    '); + } + $r->print(''.$lt{'chen'}); + if ($requestmail) { $r->print(', '.$lt{'orto'}); } else { $r->print("."); } + $r->print(''); if ($topic) { - if ( ($component_url) || ($ENV{'user.adv'}) ) { + if ( ($component_url) || ($env{'user.adv'}) ) { if ($component_url) { $r->print("
      @@ -223,23 +419,25 @@ END

    $lt{'disp'}

    "); - } elsif ($ENV{'user.adv'}) { - $r->print(" - -

    $lt{'coth'}

    "); } } } - if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { + if ($requestmail) { $r->print(" -

    $lt{'suhr'}

    - "); +

    $lt{'suhr'}"); + unless ($env{'user.adv'}) { + $r->print('
    '. + &mt('[_1]Note[_2]: questions about course content should not be directed to the support team, but instead should be sent to the course instructor.'). + ' '. + &mt('This can be done by clicking the [_1]Communicate[_2] link or the "Send Feedback" link when viewing a content page.', + '','')); + } + $r->print("

    "); } - if ($faqbaseurl && $ENV{'user.adv'}) { + if ($faqbaseurl && $env{'user.adv'}) { if (!defined($faq) ||$faq eq '') { $faq = '1'; } @@ -250,7 +448,7 @@ END

    $lt{'tfaq'}

    "); } - if ($bugurl && $ENV{'user.adv'}) { + if ($bugurl && $env{'user.adv'}) { $bugurl .= '?'.$bug; $r->print("
      @@ -259,10 +457,10 @@ END

      $lt{'crea'} $lt{'suim'}

      "); } - $r->print(< - -END + if ($stayOnPage) { + $r->print('
    '); + } + $r->print(&Apache::loncommon::end_page()); } 1;