Annotation of loncom/interface/lonhelpmenu.pm, revision 1.46
1.1 raeburn 1: # The LearningOnline Network with CAPA
2: # generate frame-based help system
3: #
1.46 ! raeburn 4: # $Id: lonhelpmenu.pm,v 1.45 2017/02/20 00:36:40 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.46 ! raeburn 183: my $target = '_top';
! 184: if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
! 185: $target = '_parent';
! 186: }
1.43 raeburn 187: my %items = (
188: general => {
189: href => '/adm/help/'.$general_help.'.hlp',
190: img => $location.'/help/help.png',
191: alt => $lt{'general'},
192: text => $lt{'general'},
193: },
194: component => {
195: href => $component_url,
196: img => $location.'/help/help.png',
197: alt => $lt{'component'},
198: text => $topic,
199: },
200: faq => {
201: href => $faqbaseurl.'fom/cache/'.$faq.'.html',
202: img => $location.'/lonMisc/smallFAQ.gif',
203: alt => $lt{'faq'},
204: text => $lt{'faq'},
205: },
206: helpdesk => {
207: href => '#',
208: onclick => 'gohelpdesk()',
209: img => $location.'/lonIcons/helpdesk.gif',
210: alt => $lt{'helpdesk'},
211: text => $lt{'helpdesk'},
212: },
213: bugs => {
214: href => $bugurl,
215: img => $location.'/lonMisc/smallBug.gif',
216: alt => $lt{'bugs'},
217: text => $lt{'bugs'},
218: },
219: manuals_web => {
220: href => '',
221: img => $location.'/lonIcons/html.gif',
222: alt => $lt{'manuals_web'},
223: text => $lt{'manuals_web'},
224: },
225: manuals_pdf => {
226: href => '',
227: img => $location.'/lonIcons/pdf.gif',
228: alt => $lt{'manuals_pdf'},
229: text => $lt{'manuals_pdf'},
230: },
231: lastloc => {
1.45 raeburn 232: href => &HTML::Entities::encode($origurl,'"&<>'),
1.43 raeburn 233: img => '/res/adm/pages/tolastloc.png',
234: alt => $lt{'lastloc'},
235: text => $lt{'lastloc'},
1.46 ! raeburn 236: target => $target,
1.43 raeburn 237: },
238: close => {
239: href => 'javascript:window.close()',
240: img => $location.'/lonIcons/close.gif',
241: alt => $lt{'close'},
242: text => $lt{'close'},
1.46 ! raeburn 243: target => $target,
1.43 raeburn 244: },
245: );
246: my %help_submenu = (
247: manuals_web => [
248: ['/adm/help/course.manual.access.hlp','Course Coordination','course'],
1.44 raeburn 249: ['/adm/help/author.manual.access.hlp','Authoring','author'],
1.43 raeburn 250: ],
251: manuals_pdf => [
252: ['/adm/help/course.manual.pdf','Course Coordination','course'],
1.44 raeburn 253: ['/adm/help/author.manual.pdf','Authoring','author'],
1.43 raeburn 254: ],
255: );
256: my @order = ('general');
1.21 www 257: if ($component_url) {
1.43 raeburn 258: push(@order,'component');
259: }
260: if ($requestmail) {
261: push(@order,'helpdesk');
262: }
263: if ($env{'user.adv'} && $faq) {
264: push(@order,'faq');
1.1 raeburn 265: }
1.43 raeburn 266: if (($env{'user.adv'}) && (($helpconfig{'helpsettings'}{'submitbugs'} eq '1') || ($helpconfig{'helpsettings'}{'submitbugs'} eq ''))) {
267: push(@order,'bugs');
1.1 raeburn 268: }
1.8 raeburn 269: if ($stayOnPage) {
1.43 raeburn 270: push(@order,('manuals_web','manuals_pdf','lastloc'));
1.8 raeburn 271: } else {
1.43 raeburn 272: push(@order,'close');
1.8 raeburn 273: }
1.43 raeburn 274: my $menu;
275: foreach my $title (@order) {
276: my $menuitem = $items{$title};
277: next unless (ref($menuitem) eq 'HASH');
278: if (defined($help_submenu{$title})) {
279: my ($link,$target);
280: if ($menuitem->{href} ne '') {
281: $link = $menuitem->{href};
282: $target = 'bodyframe';
283: } else {
284: $link = '#';
285: }
286: my @helpsub;
287: if (ref($help_submenu{$title}) eq 'ARRAY') {
288: foreach my $item (@{$help_submenu{$title}}) {
289: if (ref($item) eq 'ARRAY') {
290: if (($item->[2] eq 'course') || ($item->[2] eq 'author')) {
291: next unless($env{'user.adv'});
292: }
293: push(@helpsub,$item);
294: }
295: }
296: if (@helpsub > 0) {
297: my $img;
298: if ($menuitem->{img}) {
299: $img = '<img class="LC_noBorder" style="vertical-align:top" src="'.$menuitem->{img}.'" alt="'.$menuitem->{alt}.'" />';
300: }
301: $menu .= &create_submenu($link,$img,$target,$menuitem->{text},\@helpsub,1);
302: } elsif ($link ne '#') {
303: $menu .= '<li><a href="'.$link.'" target="'.$target.'">'.$menuitem->{text}.'</a></li>';
304: }
305: }
306: } else {
307: $menu .= &build_menuitem($menuitem);
308: }
309: }
310: return $menu;
311: }
312:
313: sub build_menuitem {
314: my ($menuitem) = @_;
315: return '' unless(ref($menuitem) eq 'HASH');
316: my $link;
317: if ($menuitem->{img}) {
318: $link = '<img style="vertical-align:top" class="LC_noBorder" src="'.$menuitem->{img}.'" alt="'.$menuitem->{alt}.'" /> ';
319: }
320: if ($menuitem->{text}) {
321: $link .= $menuitem->{text};
322: }
323: my $target;
324: if ($menuitem->{target}) {
325: $target = $menuitem->{target};
326: } else {
327: $target = 'bodyframe';
328: }
329: my $onclick;
330: if ($menuitem->{onclick}) {
331: $onclick = ' onclick="'.$menuitem->{onclick}.';return false"';
332: }
333: return '<li><a href="'.$menuitem->{href}.'" target="'.$target.'"'.$onclick.'>'.$link.'</a></li>',
334: }
335:
336: sub create_submenu {
337: my ($link,$img,$target,$title,$submenu,$translate) = @_;
338: return unless (ref($submenu) eq 'ARRAY');
339: my $disptarget;
340: if ($target ne '') {
341: $disptarget = ' target="'.$target.'"';
342: }
343: my $menu = '<li class="LC_hoverable">'.$img.
344: '<a href="'.$link.'"'.$disptarget.'>'.
345: '<span class="LC_nobreak">'.$title.
346: '<span class="LC_fontsize_small" style="font-weight:normal;">'.
347: ' ▼</span></span></a>'.
348: '<ul>';
349: my $count = 0;
350: my $numsub = scalar(@{$submenu});
351: foreach my $item (@{$submenu}) {
352: $count ++;
353: if (ref($item) eq 'ARRAY') {
354: my $href = $item->[0];
355: my $borderbot;
356: if ($count == $numsub) {
357: $borderbot = 'border-bottom:1px solid black;';
358: }
359: $menu .= '<li style="margin:0;padding:0;'.
360: $borderbot.'"><a href="'.$href.'" target="bodyframe">';
361: if ($translate) {
362: $menu .= &mt($item->[1]);
363: } else {
364: $menu .= $item->[1];
365: }
366: $menu .= '</a></li>';
367: }
368: }
369: $menu .= '</ul></li>';
370: return $menu;
1.1 raeburn 371: }
372:
373: sub display_help_mainpage {
1.43 raeburn 374: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
1.22 albertel 375:
1.8 raeburn 376: my %lt =&Apache::lonlocal::texthash(
377: 'topp' => 'Topic Page',
378: 'chen' => 'Choose an entry below to go directly to a relevant help page',
379: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
380: 'vthp' => 'Visit the help page for ',
381: 'disp' => 'Display the page in the inline help system that covers this topic.',
382: '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.',
383: 'cont' => 'Contact the LON-CAPA support team',
384: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
385: 'faqo' => 'FAQ-O-Matic Help system',
386: '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.',
387: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
388: '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.',
389: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
390: );
1.22 albertel 391:
1.43 raeburn 392: if ($stayOnPage) {
393: $r->print(&Apache::loncommon::start_page('Help Content',undef,
394: {'no_secondary_menu' => 1,}));
395: } else {
396: $r->print(&Apache::loncommon::start_page('Help Content',undef,
397: {'only_body' => 1,}));
398: }
1.46 ! raeburn 399: my $target = '_top';
! 400: if (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
! 401: $target = '_parent';
! 402: }
1.43 raeburn 403: if ($stayOnPage) {
404: $r->print('<div>');
405: }
1.30 www 406: $r->print('<b>'.$lt{'chen'});
1.43 raeburn 407: if ($requestmail) {
1.8 raeburn 408: $r->print(', '.$lt{'orto'});
1.1 raeburn 409: } else {
410: $r->print(".");
411: }
1.30 www 412: $r->print('</b>');
1.1 raeburn 413: if ($topic) {
1.20 albertel 414: if ( ($component_url) || ($env{'user.adv'}) ) {
1.1 raeburn 415: if ($component_url) {
416: $r->print("
417: <ul>
1.8 raeburn 418: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
1.1 raeburn 419: </ul>
1.8 raeburn 420: <p>$lt{'disp'}</p>
1.1 raeburn 421: ");
422: }
423: }
424: }
1.43 raeburn 425: if ($requestmail) {
1.1 raeburn 426: $r->print("
427: <ul>
1.29 albertel 428: <li><a href=\"/adm/support?origurl=".&escape($origurl)."\">$lt{'cont'}</a></li>
1.1 raeburn 429: </ul>
1.18 raeburn 430: <p>$lt{'suhr'}");
1.20 albertel 431: unless ($env{'user.adv'}) {
1.40 raeburn 432: $r->print('<br />'.
433: &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.').
434: ' '.
435: &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 436: '<a href="/adm/communicate" target="'.$target.'">','</a>'));
1.18 raeburn 437: }
438: $r->print("</p>");
1.1 raeburn 439: }
1.20 albertel 440: if ($faqbaseurl && $env{'user.adv'}) {
1.1 raeburn 441: if (!defined($faq) ||$faq eq '') {
442: $faq = '1';
443: }
444: $r->print("
1.11 raeburn 445: <ul>
1.8 raeburn 446: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
1.1 raeburn 447: </ul>
1.8 raeburn 448: <p>$lt{'tfaq'}</p>
1.1 raeburn 449: ");
450: }
1.20 albertel 451: if ($bugurl && $env{'user.adv'}) {
1.1 raeburn 452: $bugurl .= '?'.$bug;
453: $r->print("
454: <ul>
1.8 raeburn 455: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
1.1 raeburn 456: </ul>
1.8 raeburn 457: <p>$lt{'crea'} $lt{'suim'}</p>
1.1 raeburn 458: ");
459: }
1.43 raeburn 460: if ($stayOnPage) {
461: $r->print('</div>');
462: }
1.22 albertel 463: $r->print(&Apache::loncommon::end_page());
1.1 raeburn 464: }
465:
466: 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