Annotation of loncom/interface/lonhelpmenu.pm, revision 1.49
1.1 raeburn 1: # The LearningOnline Network with CAPA
2: # generate frame-based help system
3: #
1.49 ! raeburn 4: # $Id: lonhelpmenu.pm,v 1.48 2022/05/30 00:17:38 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.45 raeburn 39: use HTML::Entities();
1.1 raeburn 40:
1.2 albertel 41: sub handler {
42: my ($r) = @_;
1.29 albertel 43: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','faq','bug','topic','component_help','origurl','stayonpage']);
1.2 albertel 44: &Apache::loncommon::content_type($r,'text/html');
1.1 raeburn 45: $r->send_http_header;
46:
47: if ($r->header_only) {
48: return OK;
49: }
1.20 albertel 50: my $faq = $env{'form.faq'};
51: my $bug = $env{'form.bug'};
52: my $topic = $env{'form.topic'};
53: my $component_help = $env{'form.component_help'};
54: my $origurl = $env{'form.origurl'};
55: my $stayOnPage = $env{'form.stayonpage'};
1.1 raeburn 56: my $component_url = $component_help;
57: if ($component_url) {
58: $component_url = '/adm/help/'.$component_url.'.hlp';
59: }
60: my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'};
1.42 raeburn 61: $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl;
1.1 raeburn 62: if ($bug) {
1.42 raeburn 63: $bugurl .= '&component='.$bug;
1.1 raeburn 64: }
65: my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'};
1.43 raeburn 66: my $origmail = $Apache::lonnet::perlvar{'lonSupportEMail'};
1.45 raeburn 67: $origurl = &unescape($origurl);
1.43 raeburn 68: my $defdom;
69: if ($env{'request.course.id'}) {
70: $defdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
71: } elsif ($env{'request.role.domain'}) {
72: $defdom = $env{'request.role.domain'};
73: } else {
74: $defdom = &Apache::lonnet::default_login_domain();
75: }
76: my $requestmail = &Apache::loncommon::build_recipient_list(undef,'helpdeskmail',
77: $defdom,$origmail);
1.20 albertel 78: if ($env{'form.page'} eq 'banner') {
1.29 albertel 79: &display_help_banner($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
1.20 albertel 80: } elsif ($env{'form.page'} eq 'body') {
1.43 raeburn 81: &display_help_mainpage($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
1.1 raeburn 82: }
83: return OK;
84: }
85:
86: sub display_help_banner {
1.29 albertel 87: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
1.38 jms 88: my $dom = $env{'request.role.domain'};
1.17 raeburn 89: my $scripttag = '';
1.43 raeburn 90: if ($requestmail) {
1.25 www 91: my $displayurl = &escape($origurl);
1.17 raeburn 92: $scripttag = (<<"SCRIPT_ONE");
1.43 raeburn 93: <script type="text/javascript">
1.42 raeburn 94: // <![CDATA[
1.17 raeburn 95: function gohelpdesk() {
96: var actiontype = null;
97: try {
98: actiontype = parent.bodyframe.document.logproblem.action.value;
99: }
100: catch(error) {
1.29 albertel 101: parent.bodyframe.location = "/adm/support?origurl=$displayurl";
1.17 raeburn 102: return;
103: }
104: if (actiontype) {
105: var loc = parent.bodyframe.location.href;
106: if (loc.indexOf("/adm/support") > -1) {
107: if (parent.bodyframe.document.logproblem.action.value == "process") {
108: if (validmail(parent.bodyframe.document.logproblem.email) == false) {
109: alert("The e-mail address you entered: "+parent.bodyframe.document.logproblem.email.value+" is not a valid e-mail address.");
110: return;
111: }
112: parent.bodyframe.document.logproblem.submit();
113: return;
114: }
115: }
1.29 albertel 116: parent.bodyframe.location = "/adm/support?origurl=$displayurl";
1.17 raeburn 117: return;
118: }
119: }
1.43 raeburn 120:
1.17 raeburn 121: SCRIPT_ONE
122: $scripttag .= (<<'SCRIPT_TWO');
123: function validmail(field) {
124: var str = field.value;
125: if (window.RegExp) {
126: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
1.22 albertel 127: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
1.17 raeburn 128: var reg1 = new RegExp(reg1str);
129: var reg2 = new RegExp(reg2str);
130: if (!reg1.test(str) && reg2.test(str)) {
131: return true;
132: }
133: return false;
134: }
135: else
136: {
1.8 raeburn 137:
1.17 raeburn 138: if(str.indexOf("@") >= 0) {
139: return true;
140: }
141: return false;
142: }
143: }
1.43 raeburn 144:
1.42 raeburn 145: // ]]>
1.17 raeburn 146: </script>
147: SCRIPT_TWO
148: }
1.22 albertel 149:
1.43 raeburn 150: if ($stayOnPage) {
151: $r->print(&Apache::loncommon::start_page('Help',$scripttag,
152: {'no_secondary_menu' => 1,}));
153: } else {
154: $r->print(&Apache::loncommon::start_page('Help',$scripttag,
155: {'only_body' => 1,}));
156: }
157: my $menu = &helpmenu_items($dom,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
158: if ($menu) {
159: $r->print("<ul id=\"LC_secondary_menu\">$menu</ul>");
160: }
161: if ($stayOnPage && $env{'user.adv'}) {
162: $r->print('<br />');
163: }
164: $r->print(&Apache::loncommon::end_page());
165: }
1.27 albertel 166:
1.43 raeburn 167: sub helpmenu_items {
168: my ($dom,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
169: my $location=&Apache::loncommon::lonhttpdurl("/adm");
1.31 albertel 170: my $general_help = &Apache::loncommon::general_help();
1.43 raeburn 171: my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'],$dom);
172: my %lt = &Apache::lonlocal::texthash(
173: general => 'General help',
174: component => 'Topic help',
175: faq => 'FAQ',
176: helpdesk => 'Ask helpdesk',
177: bugs => 'Report a bug',
178: manuals_web => 'Online manuals',
179: manuals_pdf => 'Printable manuals',
180: lastloc => 'Go back',
181: close => 'Close',
182: );
1.48 raeburn 183: my ($target,$bugs_target);
184: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
185: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1.47 raeburn 186: $target = '_parent';
1.48 raeburn 187: $bugs_target = '_blank';
188: } else {
189: $target = '_top';
190: $bugs_target = '_top';
1.47 raeburn 191: }
1.43 raeburn 192: my %items = (
193: general => {
194: href => '/adm/help/'.$general_help.'.hlp',
195: img => $location.'/help/help.png',
196: alt => $lt{'general'},
197: text => $lt{'general'},
198: },
199: component => {
200: href => $component_url,
201: img => $location.'/help/help.png',
202: alt => $lt{'component'},
203: text => $topic,
204: },
205: faq => {
206: href => $faqbaseurl.'fom/cache/'.$faq.'.html',
207: img => $location.'/lonMisc/smallFAQ.gif',
208: alt => $lt{'faq'},
209: text => $lt{'faq'},
210: },
211: helpdesk => {
212: href => '#',
213: onclick => 'gohelpdesk()',
214: img => $location.'/lonIcons/helpdesk.gif',
215: alt => $lt{'helpdesk'},
216: text => $lt{'helpdesk'},
217: },
218: bugs => {
219: href => $bugurl,
220: img => $location.'/lonMisc/smallBug.gif',
221: alt => $lt{'bugs'},
222: text => $lt{'bugs'},
1.48 raeburn 223: target => $bugs_target,
1.43 raeburn 224: },
225: manuals_web => {
226: href => '',
227: img => $location.'/lonIcons/html.gif',
228: alt => $lt{'manuals_web'},
229: text => $lt{'manuals_web'},
230: },
231: manuals_pdf => {
232: href => '',
233: img => $location.'/lonIcons/pdf.gif',
234: alt => $lt{'manuals_pdf'},
235: text => $lt{'manuals_pdf'},
236: },
237: lastloc => {
1.45 raeburn 238: href => &HTML::Entities::encode($origurl,'"&<>'),
1.43 raeburn 239: img => '/res/adm/pages/tolastloc.png',
240: alt => $lt{'lastloc'},
241: text => $lt{'lastloc'},
1.46 raeburn 242: target => $target,
1.43 raeburn 243: },
244: close => {
245: href => 'javascript:window.close()',
246: img => $location.'/lonIcons/close.gif',
247: alt => $lt{'close'},
248: text => $lt{'close'},
1.46 raeburn 249: target => $target,
1.43 raeburn 250: },
251: );
252: my %help_submenu = (
253: manuals_web => [
254: ['/adm/help/course.manual.access.hlp','Course Coordination','course'],
1.44 raeburn 255: ['/adm/help/author.manual.access.hlp','Authoring','author'],
1.43 raeburn 256: ],
257: manuals_pdf => [
258: ['/adm/help/course.manual.pdf','Course Coordination','course'],
1.44 raeburn 259: ['/adm/help/author.manual.pdf','Authoring','author'],
1.43 raeburn 260: ],
261: );
262: my @order = ('general');
1.21 www 263: if ($component_url) {
1.43 raeburn 264: push(@order,'component');
265: }
266: if ($requestmail) {
267: push(@order,'helpdesk');
268: }
269: if ($env{'user.adv'} && $faq) {
270: push(@order,'faq');
1.1 raeburn 271: }
1.43 raeburn 272: if (($env{'user.adv'}) && (($helpconfig{'helpsettings'}{'submitbugs'} eq '1') || ($helpconfig{'helpsettings'}{'submitbugs'} eq ''))) {
273: push(@order,'bugs');
1.1 raeburn 274: }
1.8 raeburn 275: if ($stayOnPage) {
1.43 raeburn 276: push(@order,('manuals_web','manuals_pdf','lastloc'));
1.8 raeburn 277: } else {
1.43 raeburn 278: push(@order,'close');
1.8 raeburn 279: }
1.43 raeburn 280: my $menu;
281: foreach my $title (@order) {
282: my $menuitem = $items{$title};
283: next unless (ref($menuitem) eq 'HASH');
284: if (defined($help_submenu{$title})) {
285: my ($link,$target);
286: if ($menuitem->{href} ne '') {
287: $link = $menuitem->{href};
288: $target = 'bodyframe';
289: } else {
290: $link = '#';
291: }
292: my @helpsub;
293: if (ref($help_submenu{$title}) eq 'ARRAY') {
294: foreach my $item (@{$help_submenu{$title}}) {
295: if (ref($item) eq 'ARRAY') {
296: if (($item->[2] eq 'course') || ($item->[2] eq 'author')) {
297: next unless($env{'user.adv'});
298: }
299: push(@helpsub,$item);
300: }
301: }
302: if (@helpsub > 0) {
303: my $img;
304: if ($menuitem->{img}) {
305: $img = '<img class="LC_noBorder" style="vertical-align:top" src="'.$menuitem->{img}.'" alt="'.$menuitem->{alt}.'" />';
306: }
307: $menu .= &create_submenu($link,$img,$target,$menuitem->{text},\@helpsub,1);
308: } elsif ($link ne '#') {
309: $menu .= '<li><a href="'.$link.'" target="'.$target.'">'.$menuitem->{text}.'</a></li>';
310: }
311: }
312: } else {
313: $menu .= &build_menuitem($menuitem);
314: }
315: }
316: return $menu;
317: }
318:
319: sub build_menuitem {
320: my ($menuitem) = @_;
321: return '' unless(ref($menuitem) eq 'HASH');
322: my $link;
323: if ($menuitem->{img}) {
324: $link = '<img style="vertical-align:top" class="LC_noBorder" src="'.$menuitem->{img}.'" alt="'.$menuitem->{alt}.'" /> ';
325: }
326: if ($menuitem->{text}) {
327: $link .= $menuitem->{text};
328: }
329: my $target;
330: if ($menuitem->{target}) {
331: $target = $menuitem->{target};
332: } else {
333: $target = 'bodyframe';
334: }
335: my $onclick;
336: if ($menuitem->{onclick}) {
337: $onclick = ' onclick="'.$menuitem->{onclick}.';return false"';
338: }
339: return '<li><a href="'.$menuitem->{href}.'" target="'.$target.'"'.$onclick.'>'.$link.'</a></li>',
340: }
341:
342: sub create_submenu {
343: my ($link,$img,$target,$title,$submenu,$translate) = @_;
344: return unless (ref($submenu) eq 'ARRAY');
345: my $disptarget;
346: if ($target ne '') {
347: $disptarget = ' target="'.$target.'"';
348: }
349: my $menu = '<li class="LC_hoverable">'.$img.
350: '<a href="'.$link.'"'.$disptarget.'>'.
351: '<span class="LC_nobreak">'.$title.
352: '<span class="LC_fontsize_small" style="font-weight:normal;">'.
353: ' ▼</span></span></a>'.
354: '<ul>';
355: my $count = 0;
356: my $numsub = scalar(@{$submenu});
357: foreach my $item (@{$submenu}) {
358: $count ++;
359: if (ref($item) eq 'ARRAY') {
360: my $href = $item->[0];
361: my $borderbot;
362: if ($count == $numsub) {
363: $borderbot = 'border-bottom:1px solid black;';
364: }
365: $menu .= '<li style="margin:0;padding:0;'.
366: $borderbot.'"><a href="'.$href.'" target="bodyframe">';
367: if ($translate) {
368: $menu .= &mt($item->[1]);
369: } else {
370: $menu .= $item->[1];
371: }
372: $menu .= '</a></li>';
373: }
374: }
375: $menu .= '</ul></li>';
376: return $menu;
1.1 raeburn 377: }
378:
379: sub display_help_mainpage {
1.43 raeburn 380: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
1.22 albertel 381:
1.8 raeburn 382: my %lt =&Apache::lonlocal::texthash(
383: 'topp' => 'Topic Page',
384: 'chen' => 'Choose an entry below to go directly to a relevant help page',
385: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
386: 'vthp' => 'Visit the help page for ',
387: 'disp' => 'Display the page in the inline help system that covers this topic.',
388: '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.',
389: 'cont' => 'Contact the LON-CAPA support team',
390: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
391: 'faqo' => 'FAQ-O-Matic Help system',
392: '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.',
393: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
394: '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.',
395: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
396: );
1.22 albertel 397:
1.43 raeburn 398: if ($stayOnPage) {
399: $r->print(&Apache::loncommon::start_page('Help Content',undef,
400: {'no_secondary_menu' => 1,}));
401: } else {
402: $r->print(&Apache::loncommon::start_page('Help Content',undef,
403: {'only_body' => 1,}));
404: }
1.46 raeburn 405: my $target = '_top';
1.49 ! raeburn 406: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
! 407: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1.47 raeburn 408: $target = '_parent';
409: }
1.43 raeburn 410: if ($stayOnPage) {
411: $r->print('<div>');
1.49 ! raeburn 412: }
1.30 www 413: $r->print('<b>'.$lt{'chen'});
1.43 raeburn 414: if ($requestmail) {
1.8 raeburn 415: $r->print(', '.$lt{'orto'});
1.1 raeburn 416: } else {
417: $r->print(".");
418: }
1.30 www 419: $r->print('</b>');
1.1 raeburn 420: if ($topic) {
1.20 albertel 421: if ( ($component_url) || ($env{'user.adv'}) ) {
1.1 raeburn 422: if ($component_url) {
423: $r->print("
424: <ul>
1.8 raeburn 425: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
1.1 raeburn 426: </ul>
1.8 raeburn 427: <p>$lt{'disp'}</p>
1.1 raeburn 428: ");
429: }
430: }
431: }
1.43 raeburn 432: if ($requestmail) {
1.1 raeburn 433: $r->print("
434: <ul>
1.29 albertel 435: <li><a href=\"/adm/support?origurl=".&escape($origurl)."\">$lt{'cont'}</a></li>
1.1 raeburn 436: </ul>
1.18 raeburn 437: <p>$lt{'suhr'}");
1.20 albertel 438: unless ($env{'user.adv'}) {
1.40 raeburn 439: $r->print('<br />'.
440: &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.').
441: ' '.
442: &mt('This can be done by clicking the [_1]Communicate[_2] link or the "Send Feedback" link when viewing a content page.',
1.46 raeburn 443: '<a href="/adm/communicate" target="'.$target.'">','</a>'));
1.18 raeburn 444: }
445: $r->print("</p>");
1.1 raeburn 446: }
1.20 albertel 447: if ($faqbaseurl && $env{'user.adv'}) {
1.1 raeburn 448: if (!defined($faq) ||$faq eq '') {
449: $faq = '1';
450: }
451: $r->print("
1.11 raeburn 452: <ul>
1.8 raeburn 453: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
1.1 raeburn 454: </ul>
1.8 raeburn 455: <p>$lt{'tfaq'}</p>
1.1 raeburn 456: ");
457: }
1.20 albertel 458: if ($bugurl && $env{'user.adv'}) {
1.1 raeburn 459: $bugurl .= '?'.$bug;
460: $r->print("
461: <ul>
1.8 raeburn 462: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
1.1 raeburn 463: </ul>
1.8 raeburn 464: <p>$lt{'crea'} $lt{'suim'}</p>
1.1 raeburn 465: ");
466: }
1.43 raeburn 467: if ($stayOnPage) {
468: $r->print('</div>');
469: }
1.22 albertel 470: $r->print(&Apache::loncommon::end_page());
1.1 raeburn 471: }
472:
473: 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