Annotation of rat/lonwrapper.pm, revision 1.56
1.1 www 1: # The LearningOnline Network with CAPA
2: # Wrapper for external and binary files as standalone resources
3: #
1.56 ! raeburn 4: # $Id: lonwrapper.pm,v 1.55 2016/11/30 16:02:27 raeburn Exp $
1.4 www 5: #
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: #
1.1 www 28:
1.29 jms 29:
1.1 www 30: package Apache::lonwrapper;
31:
32: use strict;
33: use Apache::Constants qw(:common);
1.38 droeschl 34: use Apache::lonenc();
1.18 albertel 35: use Apache::lonnet;
1.42 raeburn 36: use Apache::lonlocal;
37: use Apache::loncommon();
38: use Apache::lonhtmlcommon();
39: use Apache::lonextresedit();
1.50 raeburn 40: use Apache::lonexttool();
41: use LONCAPA qw(:DEFAULT :match);;
1.1 www 42:
43: # ================================================================ Main Handler
1.21 albertel 44: sub wrapper {
1.50 raeburn 45: my ($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool,$title) = @_;
1.23 albertel 46:
1.42 raeburn 47: my $forcereg;
48: unless ($env{'form.folderpath'}) {
49: $forcereg = 1;
50: }
1.46 raeburn 51: my %lt = &Apache::lonlocal::texthash(
52: 'noif' => 'No iframe support.',
53: 'show' => 'Show content in pop-up window',
54: );
55:
1.51 raeburn 56: my $anchor;
1.53 raeburn 57: if ($is_ext) {
58: if ($env{'form.symb'}) {
59: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
60: if ($res =~ /(#[^#]+)$/) {
61: $anchor = $1;
62: }
63: } elsif ($env{'form.anchor'} ne '') {
64: $anchor = '#'.$env{'form.anchor'};
1.51 raeburn 65: }
66: }
67:
68: my $noiframe = &Apache::loncommon::modal_link($url.$anchor,$lt{'show'},500,400);
1.42 raeburn 69: my $args = {'bgcolor' => '#FFFFFF'};
70: if ($forcereg) {
71: $args->{'force_register'} = $forcereg;
72: }
73: if (ref($brcrum) eq 'ARRAY') {
1.45 raeburn 74: $args->{'bread_crumbs'} = $brcrum;
1.42 raeburn 75: }
1.44 raeburn 76: if ($absolute) {
77: $args->{'use_absolute'} = $absolute;
78: }
1.56 ! raeburn 79: if ($env{'form.only_body'}) {
! 80: $args->{'only_body'} = $env{'form.only_body'};
! 81: }
1.42 raeburn 82:
1.46 raeburn 83: my $startpage = &Apache::loncommon::start_page('Menu',undef,$args);
84: my $endpage = &Apache::loncommon::end_page();
1.50 raeburn 85:
86: if (($env{'browser.mobile'}) || ($exttool eq 'window')) {
1.47 raeburn 87: my $output = $startpage;
88: if ($is_pdf) {
89: if ($title eq '') {
1.49 raeburn 90: $title = $env{'form.title'};
91: if ($title eq '') {
92: unless ($env{'request.enc'}) {
93: ($title) = ($url =~ m{/([^/]+)$});
94: $title =~ s/(\?[^\?]+)$//;
95: }
1.47 raeburn 96: }
97: }
98: unless ($title eq '') {
99: $output .= $title.'<br />';
100: }
101: $output .= '<a href="'.$url.'">'.&mt('Link to PDF (for mobile devices)').'</a>';
1.50 raeburn 102: } elsif ($exttool eq 'window') {
103: $output .= '<div>'.
104: '<a href="'.$url.'" target="LC_LTI" style="padding:0;clear:both;margin:0;border:0">'.
105: &mt('Launch External Tool').'</a>'.
106: '</div>';
1.47 raeburn 107: } else {
108: $output .= '<div style="overflow:scroll; -webkit-overflow-scrolling:touch;">'."\n".
1.51 raeburn 109: '<iframe src="'.$url.$anchor.'" height="100%" width="100%" frameborder="0">'."\n".
1.47 raeburn 110: "$lt{'noif'} $noiframe\n".
111: "</iframe>\n".
112: "</div>\n";
113: }
114: $output .= $endpage;
115: return $output;
1.46 raeburn 116: } else {
1.55 raeburn 117: my $offset = 5;
118: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
119: if ($env{'form.inhibitmenu'} eq 'yes') {
120: $offset = 0;
121: }
1.46 raeburn 122: my $script = &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
123: \$(document).ready( function() {
124: \$(window).unbind('resize').resize(function(){
1.54 damieng 125: var header = null;
1.55 raeburn 126: var offset = $offset;
1.46 raeburn 127: var height = 0;
128: var hdrtop = 0;
129: if (\$('div.LC_head_subbox:first').length) {
130: header = \$('div.LC_head_subbox:first');
131: offset = 9;
132: } else {
133: if (\$('#LC_breadcrumbs').length) {
134: header = \$('#LC_breadcrumbs');
135: }
136: }
1.54 damieng 137: if (header != null && header.length) {
1.46 raeburn 138: height = header.height();
139: hdrtop = header.position().top;
1.42 raeburn 140: }
1.46 raeburn 141: var pos = height + hdrtop + offset;
142: \$('.LC_iframecontainer').css('top', pos);
143: });
1.38 droeschl 144: });
1.46 raeburn 145: window.onload = function(){ \$(window).trigger('resize') };
1.39 droeschl 146: SCRIPT
1.46 raeburn 147: # javascript will position the iframe if window was resized (or zoomed)
148: return <<ENDFRAME;
149: $startpage
150: $script
151: <div class="LC_iframecontainer">
1.51 raeburn 152: <iframe src="$url$anchor">$lt{'noif'} $noiframe</iframe>
1.46 raeburn 153: </div>
154: $endpage
1.38 droeschl 155: ENDFRAME
1.46 raeburn 156: }
1.21 albertel 157: }
158:
159: sub handler {
160: my $r=shift;
161: &Apache::loncommon::content_type($r,'text/html');
162: $r->send_http_header;
163:
164: return OK if $r->header_only;
165:
1.38 droeschl 166: my $url = $r->uri;
1.50 raeburn 167: my ($is_ext,$brcrum,$absolute,$is_pdf,$exttool,$cdom,$cnum);
1.38 droeschl 168:
169: for ($url){
170: s|^/adm/wrapper||;
171: $is_ext = $_ =~ s|^/ext/|http://|;
172: s|http://https://|https://|;
173: s|:|:|g;
1.21 albertel 174: }
175:
1.50 raeburn 176:
1.47 raeburn 177: if ($url =~ /\.pdf$/i) {
178: $is_pdf = 1;
1.50 raeburn 179: } elsif ($url =~ m{^/adm/($match_domain)/($match_courseid)/(\d+)/exttools?$}) {
180: $cdom = $1;
181: $cnum = $2;
182: my $marker = $3;
183: $exttool = 'iframe';
184: my %toolhash = &Apache::lonnet::get('exttool_'.$marker,['target'],$cdom,$cnum);
185: if ($toolhash{'target'} eq 'window') {
186: $exttool = 'window';
187: }
1.47 raeburn 188: }
1.50 raeburn 189: if (($is_ext) || ($exttool)) {
1.42 raeburn 190: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.53 raeburn 191: ['forceedit','register','folderpath','symb','idx','title','anchor']);
1.42 raeburn 192: if (($env{'form.forceedit'}) &&
193: (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) &&
194: (($env{'form.folderpath'} =~ /^supplemental/) ||
195: ($env{'form.symb'} =~ /^uploaded/))) {
1.53 raeburn 196: if ($env{'form.symb'}) {
197: (undef,undef,my $res) = &Apache::lonnet::decode_symb($env{'form.symb'});
198: if ($res =~ /(#[^#]+)$/) {
199: $url .= $1;
200: }
201: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
202: if ($env{'form.anchor'} ne '') {
203: $url .= '#'.$env{'form.anchor'};
204: }
1.52 raeburn 205: }
1.50 raeburn 206: my $type = 'ext';
207: my %ltitools;
208: if ($exttool) {
209: $type = 'tool';
210: %ltitools = &Apache::lonnet::get_domain_ltitools($cdom);
211: }
1.42 raeburn 212: $r->print(
213: &Apache::lonextresedit::display_editor($url,$env{'form.folderpath'},
214: $env{'form.symb'},
1.50 raeburn 215: $env{'form.idx'},$type,$cdom,
216: $cnum,\%ltitools));
1.42 raeburn 217: return OK;
218: } elsif ($env{'form.folderpath'} =~ /^supplemental/) {
219: my $crstype = &Apache::loncommon::course_type();
1.43 raeburn 220: my $title = $env{'form.title'};
221: if ($title eq '') {
1.50 raeburn 222: if ($is_ext) {
223: $title = &mt('External Resource');
224: } else {
225: $title = &mt('External Tool');
226: }
1.43 raeburn 227: }
1.42 raeburn 228: $brcrum =
1.43 raeburn 229: &Apache::lonhtmlcommon::docs_breadcrumbs(undef,$crstype,undef,$title,1);
1.42 raeburn 230: }
231: }
232:
1.21 albertel 233: #
234: # Actual URL
235: #
1.41 www 236: if ($url=~/$LONCAPA::assess_re/) {
1.21 albertel 237: #
238: # This is uploaded homework
239: #
1.38 droeschl 240: $env{'request.state'}='uploaded';
241: &Apache::lonhomework::renderpage($r,$url);
1.21 albertel 242: } else {
243: #
244: # This is not homework
245: #
1.50 raeburn 246: if (($is_ext) || ($exttool)) {
1.49 raeburn 247: $absolute = $env{'request.use_absolute'};
1.38 droeschl 248: $ENV{'QUERY_STRING'} =~ s/(^|\&)symb=[^\&]*/$1/;
1.42 raeburn 249: $ENV{'QUERY_STRING'} =~ s/\&$//;
1.38 droeschl 250: }
251:
1.35 raeburn 252: unless ($ENV{'QUERY_STRING'} eq '') {
1.38 droeschl 253: $url.=(($url=~/\?/)?'&':'?').$ENV{'QUERY_STRING'};
1.35 raeburn 254: }
1.38 droeschl 255:
256: # encrypt url if not external
1.50 raeburn 257: unless ($is_ext || $exttool) {
258: &Apache::lonenc::check_encrypt(\$url);
259: }
1.38 droeschl 260:
1.50 raeburn 261: $r->print( wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$exttool) );
1.38 droeschl 262:
1.21 albertel 263: } # not just the menu
1.38 droeschl 264:
1.21 albertel 265: return OK;
1.13 www 266: } # handler
1.1 www 267:
268: 1;
269: __END__
270:
1.30 jms 271: =pod
1.1 www 272:
1.30 jms 273: =head1 NAME
274:
275: Apache::lonwrapper - External and binary file management.
276:
277: =head1 SYNOPSIS
278:
279: Wrapper for external and binary files as standalone resources. Edit handler for rat maps; TeX content handler.
280:
281: This is part of the LearningOnline Network with CAPA project
282: described at http://www.lon-capa.org.
283:
284: =head1 Subroutines
285:
286: =over
287:
1.49 raeburn 288: =item wrapper($url,$brcrum,$absolute,$is_ext,$is_pdf,$title))
1.30 jms 289:
1.45 raeburn 290: =over
291:
1.46 raeburn 292: =item $url
293:
1.45 raeburn 294: url to display by including in an iframe within a
295: LON-CAPA page which has a standard LON-CAPA inline menu.
296:
297: =item $brcrum
298:
299: breadcrumbs for unregistered urls
1.42 raeburn 300: (i.e., external resources in Supplemental Content).
1.45 raeburn 301:
1.46 raeburn 302: =item $absolute
1.45 raeburn 303:
304: contains protocol (http or https) followed by
305: the hostname, if menu items in the standard LON-CAPA
306: interface created by the call to loncommon::start_page()
307: within &wrapper() need to use absolute URLs rather than
308: relative URLs.
309:
310: That will be the case where an external resource has been
311: served from port 80, when the server customarily serves
312: requests using Apache/SSL (i.e., port 443). mod_rewrite
1.49 raeburn 313: is used to switch requests for external resources and
314: the syllabus: /public/<domain>/<courseid>/syllabus
315: (which might also point at an external resource)
1.45 raeburn 316: from https:// to http:// where the the URL of the remote site
317: specified in the resource itself is http://.
318:
319: This is done to avoid default mixed content blocking
320: in Firefox 23 and later, when serving from Apache/SSL.
321:
322: =item $is_ext
323:
324: true if URL is for an external resource.
325:
1.47 raeburn 326: =item $is_pdf
327:
328: true if URL is for a PDF (based on file extension).
329:
1.49 raeburn 330: =item $title
331:
332: optional. If wrapped item is a PDF, and $env{'browser.mobile'}
333: is true, a link to a PDF is shown. The "title" will be displayed
334: above the link, but if not provided as an arg, $env{'form.title'}
335: will be used, otherwise, the filename will be displayed (unless
336: hidden URL set for the resource).
337:
1.45 raeburn 338: =back
339:
1.38 droeschl 340: Returns markup for the entire page.
1.30 jms 341:
342: =item handler()
343:
344: =back
345:
346: =cut
1.1 www 347:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonwrapper.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / rat