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