Annotation of loncom/interface/lonhelpmenu.pm, revision 1.17
1.1 raeburn 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:
1.2 albertel 34: sub handler {
35: my ($r) = @_;
1.8 raeburn 36: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','color','function','faq','bug','topic','component_help','origurl','stayonpage']);
1.2 albertel 37: &Apache::loncommon::content_type($r,'text/html');
1.1 raeburn 38: $r->send_http_header;
39:
40: if ($r->header_only) {
41: return OK;
42: }
1.3 albertel 43: my $color = $ENV{'form.color'};
44: my $faq = $ENV{'form.faq'};
45: my $bug = $ENV{'form.bug'};
46: my $topic = $ENV{'form.topic'};
47: my $function = $ENV{'form.function'};
48: my $component_help = $ENV{'form.component_help'};
1.1 raeburn 49: my $origurl = $ENV{'form.origurl'};
1.8 raeburn 50: my $stayOnPage = $ENV{'form.stayonpage'};
1.1 raeburn 51: my $component_url = $component_help;
52: if ($component_url) {
53: $component_url = '/adm/help/'.$component_url.'.hlp';
54: }
55: my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'};
56: $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl;
57: if ($bug) {
58: $bugurl .= '&component='.$bug;
59: }
60: my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'};
61: my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'};
62: if ($ENV{'form.page'} eq 'banner') {
1.8 raeburn 63: &display_help_banner($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
1.1 raeburn 64: } elsif ($ENV{'form.page'} eq 'body') {
1.3 albertel 65: &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);
1.1 raeburn 66: }
67: return OK;
68: }
69:
70: sub display_help_banner {
1.8 raeburn 71: my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
1.1 raeburn 72: my $bodytag = &Apache::loncommon::bodytag('',$function,'rightmargin="0" leftmargin="0" marginwidth="0" topmargin="1" marginheight="1"',1);
1.5 albertel 73: $bodytag=~s/[\n\r]/ /g;
1.1 raeburn 74: my $fontcolor = &Apache::loncommon::designparm($function.'.font');
75: my $alinkcolor = &Apache::loncommon::designparm($function.'.alink');
76: my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink');
77: my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg');
78: my $tablecolor = &Apache::loncommon::designparm($function.'.tabbg');
1.14 albertel 79: my $location=&Apache::loncommon::lonhttpdurl("/adm");
1.8 raeburn 80: if (($tablecolor eq '') || ($tablecolor eq '#FFFFFF')) {
1.17 ! raeburn 81: $tablecolor = '#EEEE99';
1.8 raeburn 82: }
1.17 ! raeburn 83: my $scripttag = '';
! 84: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
! 85: my $displayurl = &Apache::lonnet::escape($origurl);
! 86: $scripttag = (<<"SCRIPT_ONE");
! 87: <script>
! 88: function gohelpdesk() {
! 89: var actiontype = null;
! 90: try {
! 91: actiontype = parent.bodyframe.document.logproblem.action.value;
! 92: }
! 93: catch(error) {
! 94: parent.bodyframe.location = "/adm/support?origurl=$displayurl&function=$function";
! 95: return;
! 96: }
! 97: if (actiontype) {
! 98: var loc = parent.bodyframe.location.href;
! 99: if (loc.indexOf("/adm/support") > -1) {
! 100: if (parent.bodyframe.document.logproblem.action.value == "process") {
! 101: if (validmail(parent.bodyframe.document.logproblem.email) == false) {
! 102: alert("The e-mail address you entered: "+parent.bodyframe.document.logproblem.email.value+" is not a valid e-mail address.");
! 103: return;
! 104: }
! 105: parent.bodyframe.document.logproblem.submit();
! 106: return;
! 107: }
! 108: }
! 109: parent.bodyframe.location = "/adm/support?origurl=$displayurl&function=$function";
! 110: return;
! 111: }
! 112: }
! 113: SCRIPT_ONE
! 114: $scripttag .= (<<'SCRIPT_TWO');
! 115: function validmail(field) {
! 116: var str = field.value;
! 117: if (window.RegExp) {
! 118: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
! 119: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$";
! 120: var reg1 = new RegExp(reg1str);
! 121: var reg2 = new RegExp(reg2str);
! 122: if (!reg1.test(str) && reg2.test(str)) {
! 123: return true;
! 124: }
! 125: return false;
! 126: }
! 127: else
! 128: {
1.8 raeburn 129:
1.17 ! raeburn 130: if(str.indexOf("@") >= 0) {
! 131: return true;
! 132: }
! 133: return false;
! 134: }
! 135: }
! 136: </script>
! 137: SCRIPT_TWO
! 138: }
1.1 raeburn 139: $r->print(<<END);
140: <html>
141: <head>
142: <title>Help Banner</title>
143: <style type="text/css">
144: <!--
145: a:link {text-decoration: none; color: $fontcolor; }
146: a:visited {text-decoration: none; color: $fontcolor; }
147: a:active {text-decoration: none; color: $fontcolor; }
148: a:hover {text-decoration: underline; color: $vlinkcolor; }
149: -->
150: </style>
1.17 ! raeburn 151: $scripttag
1.1 raeburn 152: </head>
153: $bodytag
1.8 raeburn 154: END
155: if ($stayOnPage) {
156: $r->print('<table width="700" border="0" cellspacing="0" cellpadding="0" height="55">');
157: } else {
158: $r->print('<table width="600" border="0" cellspacing="0" cellpadding="0" height="55">');
159: }
160: $r->print(<<END);
1.1 raeburn 161: <tr height="50">
162: <td width='5'> </td>
163: <td>
1.12 albertel 164: <fieldset><legend><img src="$location/lonIcons/minilogo.gif" height='20' width='29' valign='bottom' /> <b><font size="+1">LON-CAPA help/support</font></b></legend>
1.1 raeburn 165: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#000000">
166: <tr>
167: <td>
168: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">
169: <tr>
170: <td>
171: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">
172: <tr>
173: <td>
174: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#ffffff">
175: <tr bgcolor="$tablecolor">
176: END
177: if (($component_url) || ($ENV{'user.adv'})) {
178: if ($component_url) {
179: $r->print("
180: <td align=\"center\"> <b><a href=\"$component_url\" target=\"bodyframe\">");
1.8 raeburn 181: } elsif ($ENV{'user.adv'}) {
1.16 raeburn 182: $r->print('<td align="center"> <b><a href="/adm/help/nohelptopic.html" target="bodyframe">');
1.1 raeburn 183: }
1.8 raeburn 184: $r->print('
1.15 raeburn 185: <img src="'.$location.'/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" /> Topic help</a></b> </td>');
1.1 raeburn 186: }
1.11 raeburn 187: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 188: $r->print('
1.17 ! raeburn 189: <td align="center"> <b><a href="javascript:gohelpdesk()"><img src="'.$location.'/lonIcons/helpdesk.gif" border="0" alt="(Ask helpdesk)" valign="middle" /> Ask helpdesk</a></b> </td>');
1.1 raeburn 190: }
1.7 albertel 191: if ($faq && $ENV{'user.adv'}) {
1.15 raeburn 192: $r->print(<<END);
1.1 raeburn 193: <td align="center">
1.13 albertel 194: <b><a href="$faqbaseurl/fom/cache/$faq.html" target="bodyframe"><img src="$location/lonMisc/smallFAQ.gif" border="0" alt="(FAQ)" valign="middle" /> FAQ</a></b>
1.1 raeburn 195: </td>
1.7 albertel 196: END
197: }
198: if ($ENV{'user.adv'}) {
1.15 raeburn 199: $r->print(<<END);
1.13 albertel 200: <td align="center"> <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>
1.1 raeburn 201: END
202: }
1.8 raeburn 203: if ($stayOnPage) {
204: $r->print(<<END);
1.13 albertel 205: <td align="center"> <b><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></b> </td>
1.8 raeburn 206: END
207: } else {
208: $r->print(<<END);
1.13 albertel 209: <td align="center"> <b><a href="javascript:window.close()" target="_top"><img src="$location/lonIcons/closepage.gif" border="0" alt="(Close window)" valign="bottom" /> Close</a></b> </td>
1.8 raeburn 210: END
211: }
1.1 raeburn 212: $r->print(<<END);
213: </tr>
214: </table>
215: </td>
216: </tr>
217: </table>
218: </td>
219: </tr>
220: </table>
221: </td>
222: </tr>
223: </table>
224: </fieldset>
225: </td>
226: <td width='5'> </td>
227: </tr>
228: <tr height='5'>
229: <td colspan='3' height='5'> </td>
230: </tr>
231: </table>
232: </body>
233: </html>
234: END
235: }
236:
237: sub display_help_mainpage {
238: my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;
239: my $bodytag = &Apache::loncommon::bodytag('',$function,'topmargin="0" marginheight="0"',1);
1.4 albertel 240: $bodytag=~s/[\n\r]/ /g;
1.8 raeburn 241: my %lt =&Apache::lonlocal::texthash(
242: 'heco' => 'Help Content',
243: 'topp' => 'Topic Page',
244: 'chen' => 'Choose an entry below to go directly to a relevant help page',
245: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
246: 'vthp' => 'Visit the help page for ',
247: 'disp' => 'Display the page in the inline help system that covers this topic.',
248: '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.',
249: 'inhs' => 'Inline help system for',
250: 'coth' => 'Consult the inline help system for this topic.',
251: 'cont' => 'Contact the LON-CAPA support team',
252: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
253: 'faqo' => 'FAQ-O-Matic Help system',
254: '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.',
255: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
256: '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.',
257: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
258: );
259:
1.1 raeburn 260: $r->print(<<END);
261: <html>
262: <head>
1.8 raeburn 263: <title>$lt{'heco'}</title>
1.1 raeburn 264: </head>
265: $bodytag
266: END
1.8 raeburn 267: $r->print($lt{'chen'});
1.11 raeburn 268: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.8 raeburn 269: $r->print(', '.$lt{'orto'});
1.1 raeburn 270: } else {
271: $r->print(".");
272: }
273: if ($topic) {
274: if ( ($component_url) || ($ENV{'user.adv'}) ) {
275: if ($component_url) {
276: $r->print("
277: <ul>
1.8 raeburn 278: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
1.1 raeburn 279: </ul>
1.8 raeburn 280: <p>$lt{'disp'}</p>
1.1 raeburn 281: ");
282: } elsif ($ENV{'user.adv'}) {
283: $r->print("
284: <ul>
1.8 raeburn 285: <li><td align=\"center\"> <a href=\"/adm/help/nohelptopic.html\">$lt{'inhs'} $topic</a></li></ul>
286: <p>$lt{'coth'}</p>");
1.1 raeburn 287: }
288: }
289: }
1.11 raeburn 290: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 291: $r->print("
292: <ul>
1.9 raeburn 293: <li><a href=\"/adm/support?origurl=".&Apache::lonnet::escape($origurl)."&function=$function\">$lt{'cont'}</a></li>
1.1 raeburn 294: </ul>
1.8 raeburn 295: <p>$lt{'suhr'}</p>
1.1 raeburn 296: ");
297: }
298: if ($faqbaseurl && $ENV{'user.adv'}) {
299: if (!defined($faq) ||$faq eq '') {
300: $faq = '1';
301: }
302: $r->print("
1.11 raeburn 303: <ul>
1.8 raeburn 304: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
1.1 raeburn 305: </ul>
1.8 raeburn 306: <p>$lt{'tfaq'}</p>
1.1 raeburn 307: ");
308: }
309: if ($bugurl && $ENV{'user.adv'}) {
310: $bugurl .= '?'.$bug;
311: $r->print("
312: <ul>
1.8 raeburn 313: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
1.1 raeburn 314: </ul>
1.8 raeburn 315: <p>$lt{'crea'} $lt{'suim'}</p>
1.1 raeburn 316: ");
317: }
318: $r->print(<<END);
319: </body>
320: </html>
321: END
322: }
323:
324: 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