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