loncom/interface/lonhelpmenu.pm - view

File: [LON-CAPA] / loncom / interface / lonhelpmenu.pm
Revision 1.32: download - view: text, annotated - select for diffs
Thu Jul 20 22:44:04 2006 UTC (17 years, 10 months ago) by albertel
Branches: MAIN
CVS tags: version_2_5_1, version_2_5_0, version_2_4_X, version_2_4_99_0, version_2_4_2, version_2_4_1, version_2_4_0, version_2_3_X, version_2_3_99_0, version_2_3_2, version_2_3_1, version_2_3_0, version_2_2_X, version_2_2_99_1, version_2_2_99_0, version_2_2_2, version_2_2_1, version_2_2_0, version_2_1_99_3, version_2_1_99_2, version_2_1_99_1, HEAD

- target _top to break out of frames (BUG#4925)
- make the Help link work in more cases by emitting the JS in the h<head> section
- make the help menu when not in popup mode more flexible

1: # The LearningOnline Network with CAPA 2: # generate frame-based help system 3: # 4: # Copyright Michigan State University Board of Trustees 5: # 6: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 7: # 8: # LON-CAPA is free software; you can redistribute it and/or modify 9: # it under the terms of the GNU General Public License as published by 10: # the Free Software Foundation; either version 2 of the License, or 11: # (at your option) any later version. 12: # 13: # LON-CAPA is distributed in the hope that it will be useful, 14: # but WITHOUT ANY WARRANTY; without even the implied warranty of 15: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16: # GNU General Public License for more details. 17: # 18: # You should have received a copy of the GNU General Public License 19: # along with LON-CAPA; if not, write to the Free Software 20: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 21: # 22: # /home/httpd/html/adm/gpl.txt 23: # 24: # http://www.lon-capa.org/ 25: # 26: 27: package Apache::lonhelpmenu; 28: 29: use strict; 30: use lib qw(/home/httpd/lib/perl); 31: use Apache::Constants qw(:common); 32: use Apache::loncommon(); 33: use Apache::lonlocal; 34: use Apache::lonnet; 35: use lib '/home/httpd/lib/perl/'; 36: use LONCAPA; 37: 38: sub handler { 39: my ($r) = @_; 40: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','faq','bug','topic','component_help','origurl','stayonpage']); 41: &Apache::loncommon::content_type($r,'text/html'); 42: $r->send_http_header; 43: 44: if ($r->header_only) { 45: return OK; 46: } 47: my $faq = $env{'form.faq'}; 48: my $bug = $env{'form.bug'}; 49: my $topic = $env{'form.topic'}; 50: my $component_help = $env{'form.component_help'}; 51: my $origurl = $env{'form.origurl'}; 52: my $stayOnPage = $env{'form.stayonpage'}; 53: my $component_url = $component_help; 54: if ($component_url) { 55: $component_url = '/adm/help/'.$component_url.'.hlp'; 56: } 57: my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'}; 58: $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl; 59: if ($bug) { 60: $bugurl .= '&component='.$bug; 61: } 62: my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'}; 63: my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; 64: if ($env{'form.page'} eq 'banner') { 65: &display_help_banner($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); 66: } elsif ($env{'form.page'} eq 'body') { 67: &display_help_mainpage($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail); 68: } 69: return OK; 70: } 71: 72: sub display_help_banner { 73: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; 74: my $location=&Apache::loncommon::lonhttpdurl("/adm"); 75: my $scripttag = ''; 76: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { 77: my $displayurl = &escape($origurl); 78: $scripttag = (<<"SCRIPT_ONE"); 79: <script> 80: function gohelpdesk() { 81: var actiontype = null; 82: try { 83: actiontype = parent.bodyframe.document.logproblem.action.value; 84: } 85: catch(error) { 86: parent.bodyframe.location = "/adm/support?origurl=$displayurl"; 87: return; 88: } 89: if (actiontype) { 90: var loc = parent.bodyframe.location.href; 91: if (loc.indexOf("/adm/support") > -1) { 92: if (parent.bodyframe.document.logproblem.action.value == "process") { 93: if (validmail(parent.bodyframe.document.logproblem.email) == false) { 94: alert("The e-mail address you entered: "+parent.bodyframe.document.logproblem.email.value+" is not a valid e-mail address."); 95: return; 96: } 97: parent.bodyframe.document.logproblem.submit(); 98: return; 99: } 100: } 101: parent.bodyframe.location = "/adm/support?origurl=$displayurl"; 102: return; 103: } 104: } 105: SCRIPT_ONE 106: $scripttag .= (<<'SCRIPT_TWO'); 107: function validmail(field) { 108: var str = field.value; 109: if (window.RegExp) { 110: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)"; 111: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //" 112: var reg1 = new RegExp(reg1str); 113: var reg2 = new RegExp(reg2str); 114: if (!reg1.test(str) && reg2.test(str)) { 115: return true; 116: } 117: return false; 118: } 119: else 120: { 121: 122: if(str.indexOf("@") >= 0) { 123: return true; 124: } 125: return false; 126: } 127: } 128: </script> 129: SCRIPT_TWO 130: } 131: 132: my %body_layout = 133: ('rightmargin' => "0", 134: 'leftmargin' => "0", 135: 'marginwidth' => "0", 136: 'topmargin' => "1", 137: 'marginheight' => "1"); 138: my $start_page = 139: &Apache::loncommon::start_page('',$scripttag, 140: {'add_entries' => \%body_layout, 141: 'only_body' => 1,}); 142: $r->print($start_page); 143: 144: my $width = ($stayOnPage) ? '95%' : '600'; 145: 146: $r->print('<table id="LC_helpmenu" width="'.$width.'">'); 147: 148: my $general_help = &Apache::loncommon::general_help(); 149: $r->print(<<END); 150: <tr height="50"> 151: <td width='5'> </td> 152: <td> 153: <fieldset><legend><img src="$location/lonIcons/minilogo.gif" height='20' width='29' valign='bottom' />  LON-CAPA help/support</legend> 154: <table id="LC_helpmenu_links"> 155: <tr> 156: <td><a href="/adm/help/$general_help.hlp" target="bodyframe"> 157: <img src="$location/help/gif/smallHelp.gif" border="0" alt="(General help)" valign="middle" /> General Help</a> </td> 158: END 159: if ($component_url) { 160: $r->print("<td><a href=\"$component_url\" target=\"bodyframe\">". 161: '<img src="'.$location.'/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" /> '.$topic.'</a> </td>'); 162: } 163: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { 164: $r->print(' 165: <td> <a href="javascript:gohelpdesk()"><img src="'.$location.'/lonIcons/helpdesk.gif" border="0" alt="(Ask helpdesk)" valign="middle" /> Ask helpdesk</a> </td>'); 166: } 167: if ($faq && $env{'user.adv'}) { 168: $r->print(<<END); 169: <td> 170:  <a href="$faqbaseurl/fom/cache/$faq.html" target="bodyframe"><img src="$location/lonMisc/smallFAQ.gif" border="0" alt="(FAQ)" valign="middle" /> FAQ</a>  171: </td> 172: END 173: } 174: if ($env{'user.adv'}) { 175: $r->print(<<END); 176: <td> <b><a href="$bugurl" target="bodyframe"><img src="$location/lonMisc/smallBug.gif" border="0" alt="(Report a bug)" valign="middle" /> Report a bug</a> </b></td> 177: END 178: } 179: if ($stayOnPage) { 180: $r->print(<<END); 181: <td> <a href="$origurl" target="_top"><img src="$location/lonIcons/move_up.gif" border="0" alt="(Return to last location)" valign="middle" /> Return to last location</a> </td> 182: END 183: } else { 184: $r->print(<<END); 185: <td> <a href="javascript:window.close()" target="_top"><img src="$location/lonIcons/closepage.gif" border="0" alt="(Close window)" valign="bottom" /> Close</a> </td> 186: END 187: } 188: $r->print(<<END); 189: </tr> 190: </table> 191: </fieldset> 192: </td> 193: <td width='5'> </td> 194: </tr> 195: <tr height='5'> 196: <td colspan='3' height='5'> </td> 197: </tr> 198: </table> 199: END 200: $r->print(&Apache::loncommon::end_page()); 201: } 202: 203: sub display_help_mainpage { 204: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_; 205: 206: my %lt =&Apache::lonlocal::texthash( 207: 'topp' => 'Topic Page', 208: 'chen' => 'Choose an entry below to go directly to a relevant help page', 209: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.', 210: 'vthp' => 'Visit the help page for ', 211: 'disp' => 'Display the page in the inline help system that covers this topic.', 212: '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.', 213: 'inhs' => 'Topical help system for', 214: 'cont' => 'Contact the LON-CAPA support team', 215: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.', 216: 'stuq' => 'Questions about course content should not be directed to the support team, but instead should be sent to the course instructor', 217: 'faqo' => 'FAQ-O-Matic Help system', 218: 'tfaq' => 'The FAQ-O-Matic is a compendium of answers provided to common questions asked by users of LON-CAPA over the past couple of years.', 219: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system', 220: 'crea' => '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.', 221: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.' 222: ); 223: 224: my %body_layout = 225: ('topmargin' => "0", 226: 'marginheight' => "0"); 227: my $start_page = 228: &Apache::loncommon::start_page('Help Content',undef, 229: {'add_entries' => \%body_layout, 230: 'only_body' => 1,}); 231: $r->print($start_page); 232: $r->print('<b>'.$lt{'chen'}); 233: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { 234: $r->print(', '.$lt{'orto'}); 235: } else { 236: $r->print("."); 237: } 238: $r->print('</b>'); 239: if ($topic) { 240: if ( ($component_url) || ($env{'user.adv'}) ) { 241: if ($component_url) { 242: $r->print(" 243: <ul> 244: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li> 245: </ul> 246: <p>$lt{'disp'}</p> 247: "); 248: } 249: } 250: } 251: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { 252: $r->print(" 253: <ul> 254: <li><a href=\"/adm/support?origurl=".&escape($origurl)."\">$lt{'cont'}</a></li> 255: </ul> 256: <p>$lt{'suhr'}"); 257: unless ($env{'user.adv'}) { 258: $r->print('<br /><b>'.&mt('Note').'</b>: '.$lt{'stuq'}.'. '.&mt('This can be done using the').' <a href="/adm/communicate" target="_top">'.&mt('COM').'</a> '.&mt('button, or the FDBK button when viewing a content page.')); 259: } 260: $r->print("</p>"); 261: } 262: if ($faqbaseurl && $env{'user.adv'}) { 263: if (!defined($faq) ||$faq eq '') { 264: $faq = '1'; 265: } 266: $r->print(" 267: <ul> 268: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li> 269: </ul> 270: <p>$lt{'tfaq'}</p> 271: "); 272: } 273: if ($bugurl && $env{'user.adv'}) { 274: $bugurl .= '?'.$bug; 275: $r->print(" 276: <ul> 277: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li> 278: </ul> 279: <p>$lt{'crea'} $lt{'suim'}</p> 280: "); 281: } 282: $r->print(&Apache::loncommon::end_page()); 283: } 284: 285: 1;