Annotation of loncom/interface/loncommon.pm, revision 1.1434
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1434 ! raeburn 4: # $Id: loncommon.pm,v 1.1433 2024/08/22 15:16:05 raeburn Exp $
1.10 albertel 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 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.1383 raeburn 64: use Apache::lonnavmaps();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1409 raeburn 74: use LONCAPA::ltiutils;
1.1280 raeburn 75: use LONCAPA::LWPReq;
1.1395 raeburn 76: use LONCAPA::map();
1.1328 raeburn 77: use HTTP::Request;
1.657 raeburn 78: use DateTime::TimeZone;
1.1241 raeburn 79: use DateTime::Locale;
1.1220 raeburn 80: use Encode();
1.1091 foxr 81: use Text::Aspell;
1.1094 raeburn 82: use Authen::Captcha;
83: use Captcha::reCAPTCHA;
1.1234 raeburn 84: use JSON::DWIW;
1.1174 raeburn 85: use Crypt::DES;
86: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 87: use MIME::Lite;
88: use MIME::Types;
1.1292 raeburn 89: use File::Copy();
1.1300 raeburn 90: use File::Path();
1.1309 raeburn 91: use String::CRC32();
92: use Short::URL();
1.117 www 93:
1.517 raeburn 94: # ---------------------------------------------- Designs
95: use vars qw(%defaultdesign);
96:
1.22 www 97: my $readit;
98:
1.517 raeburn 99:
1.157 matthew 100: ##
101: ## Global Variables
102: ##
1.46 matthew 103:
1.643 foxr 104:
105: # ----------------------------------------------- SSI with retries:
106: #
107:
108: =pod
109:
1.648 raeburn 110: =head1 Server Side include with retries:
1.643 foxr 111:
112: =over 4
113:
1.648 raeburn 114: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 115:
116: Performs an ssi with some number of retries. Retries continue either
117: until the result is ok or until the retry count supplied by the
118: caller is exhausted.
119:
120: Inputs:
1.648 raeburn 121:
122: =over 4
123:
1.643 foxr 124: resource - Identifies the resource to insert.
1.648 raeburn 125:
1.643 foxr 126: retries - Count of the number of retries allowed.
1.648 raeburn 127:
1.643 foxr 128: form - Hash that identifies the rendering options.
129:
1.648 raeburn 130: =back
131:
132: Returns:
133:
134: =over 4
135:
1.643 foxr 136: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 137:
1.643 foxr 138: response - The response from the last attempt (which may or may not have been successful.
139:
1.648 raeburn 140: =back
141:
142: =back
143:
1.643 foxr 144: =cut
145:
146: sub ssi_with_retries {
147: my ($resource, $retries, %form) = @_;
148:
149:
150: my $ok = 0; # True if we got a good response.
151: my $content;
152: my $response;
153:
154: # Try to get the ssi done. within the retries count:
155:
156: do {
157: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
158: $ok = $response->is_success;
1.650 www 159: if (!$ok) {
160: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
161: }
1.643 foxr 162: $retries--;
163: } while (!$ok && ($retries > 0));
164:
165: if (!$ok) {
166: $content = ''; # On error return an empty content.
167: }
168: return ($content, $response);
169:
170: }
171:
172:
173:
1.20 www 174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 175: my %language;
1.124 www 176: my %supported_language;
1.1088 foxr 177: my %supported_codes;
1.1048 foxr 178: my %latex_language; # For choosing hyphenation in <transl..>
179: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 180: my %cprtag;
1.192 taceyjo1 181: my %scprtag;
1.351 www 182: my %fe; my %fd; my %fm;
1.41 ng 183: my %category_extensions;
1.12 harris41 184:
1.46 matthew 185: # ---------------------------------------------- Thesaurus variables
1.144 matthew 186: #
187: # %Keywords:
188: # A hash used by &keyword to determine if a word is considered a keyword.
189: # $thesaurus_db_file
190: # Scalar containing the full path to the thesaurus database.
1.46 matthew 191:
192: my %Keywords;
193: my $thesaurus_db_file;
194:
1.144 matthew 195: #
196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
197: # thesaurus.tab, and filecategories.tab.
198: #
1.18 www 199: BEGIN {
1.46 matthew 200: # Variable initialization
201: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
202: #
1.22 www 203: unless ($readit) {
1.12 harris41 204: # ------------------------------------------------------------------- languages
205: {
1.158 raeburn 206: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
207: '/language.tab';
1.1317 raeburn 208: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
1.1088 foxr 212: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 213: $language{$key}=$val.' - '.$enc;
214: if ($sup) {
215: $supported_language{$key}=$sup;
1.1088 foxr 216: $supported_codes{$key} = $code;
1.158 raeburn 217: }
1.1048 foxr 218: if ($latex) {
219: $latex_language_bykey{$key} = $latex;
1.1088 foxr 220: $latex_language{$code} = $latex;
1.1048 foxr 221: }
1.158 raeburn 222: }
223: close($fh);
224: }
1.12 harris41 225: }
226: # ------------------------------------------------------------------ copyrights
227: {
1.158 raeburn 228: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/copyright.tab';
1.1317 raeburn 230: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line=~/^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 235: $cprtag{$key}=$val;
236: }
237: close($fh);
238: }
1.12 harris41 239: }
1.351 www 240: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 241: {
242: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
243: '/source_copyright.tab';
1.1317 raeburn 244: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 249: $scprtag{$key}=$val;
250: }
251: close($fh);
252: }
253: }
1.63 www 254:
1.517 raeburn 255: # -------------------------------------------------------------- default domain designs
1.63 www 256: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 257: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 258: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($key,$val)=(split(/\=/,$line));
263: if ($val) { $defaultdesign{$key}=$val; }
264: }
265: close($fh);
1.63 www 266: }
267:
1.15 harris41 268: # ------------------------------------------------------------- file categories
269: {
1.158 raeburn 270: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filecategories.tab';
1.1317 raeburn 272: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 277: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 278: }
279: close($fh);
280: }
281:
1.15 harris41 282: }
1.12 harris41 283: # ------------------------------------------------------------------ file types
284: {
1.158 raeburn 285: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
286: '/filetypes.tab';
1.1317 raeburn 287: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 288: while (my $line = <$fh>) {
289: next if ($line =~ /^\#/);
290: chomp($line);
291: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 292: if ($descr ne '') {
293: $fe{$ending}=lc($emb);
294: $fd{$ending}=$descr;
1.351 www 295: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 296: }
297: }
298: close($fh);
299: }
1.12 harris41 300: }
1.22 www 301: &Apache::lonnet::logthis(
1.705 tempelho 302: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 303: $readit=1;
1.46 matthew 304: } # end of unless($readit)
1.32 matthew 305:
306: }
1.112 bowersj2 307:
1.42 matthew 308: ###############################################################
309: ## HTML and Javascript Helper Functions ##
310: ###############################################################
311:
312: =pod
313:
1.112 bowersj2 314: =head1 HTML and Javascript Functions
1.42 matthew 315:
1.112 bowersj2 316: =over 4
317:
1.648 raeburn 318: =item * &browser_and_searcher_javascript()
1.112 bowersj2 319:
320: X<browsing, javascript>X<searching, javascript>Returns a string
321: containing javascript with two functions, C<openbrowser> and
322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
323: tags.
1.42 matthew 324:
1.648 raeburn 325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 326:
327: inputs: formname, elementname, only, omit
328:
329: formname and elementname indicate the name of the html form and name of
330: the element that the results of the browsing selection are to be placed in.
331:
332: Specifying 'only' will restrict the browser to displaying only files
1.185 www 333: with the given extension. Can be a comma separated list.
1.42 matthew 334:
335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 336: with the given extension. Can be a comma separated list.
1.42 matthew 337:
1.648 raeburn 338: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 339:
340: Inputs: formname, elementname
341:
342: formname and elementname specify the name of the html form and the name
343: of the element the selection from the search results will be placed in.
1.542 raeburn 344:
1.42 matthew 345: =cut
346:
347: sub browser_and_searcher_javascript {
1.199 albertel 348: my ($mode)=@_;
349: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 350: my $resurl=&escape_single(&lastresurl());
1.42 matthew 351: return <<END;
1.219 albertel 352: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 353: var editbrowser = null;
1.135 albertel 354: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 355: var url = '$resurl/?';
1.42 matthew 356: if (editbrowser == null) {
357: url += 'launch=1&';
358: }
359: url += 'catalogmode=interactive&';
1.199 albertel 360: url += 'mode=$mode&';
1.611 albertel 361: url += 'inhibitmenu=yes&';
1.42 matthew 362: url += 'form=' + formname + '&';
363: if (only != null) {
364: url += 'only=' + only + '&';
1.217 albertel 365: } else {
366: url += 'only=&';
367: }
1.42 matthew 368: if (omit != null) {
369: url += 'omit=' + omit + '&';
1.217 albertel 370: } else {
371: url += 'omit=&';
372: }
1.135 albertel 373: if (titleelement != null) {
374: url += 'titleelement=' + titleelement + '&';
1.217 albertel 375: } else {
376: url += 'titleelement=&';
377: }
1.42 matthew 378: url += 'element=' + elementname + '';
379: var title = 'Browser';
1.435 albertel 380: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 381: options += ',width=700,height=600';
382: editbrowser = open(url,title,options,'1');
383: editbrowser.focus();
384: }
385: var editsearcher;
1.135 albertel 386: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 387: var url = '/adm/searchcat?';
388: if (editsearcher == null) {
389: url += 'launch=1&';
390: }
391: url += 'catalogmode=interactive&';
1.199 albertel 392: url += 'mode=$mode&';
1.42 matthew 393: url += 'form=' + formname + '&';
1.135 albertel 394: if (titleelement != null) {
395: url += 'titleelement=' + titleelement + '&';
1.217 albertel 396: } else {
397: url += 'titleelement=&';
398: }
1.42 matthew 399: url += 'element=' + elementname + '';
400: var title = 'Search';
1.435 albertel 401: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 402: options += ',width=700,height=600';
403: editsearcher = open(url,title,options,'1');
404: editsearcher.focus();
405: }
1.219 albertel 406: // END LON-CAPA Internal -->
1.42 matthew 407: END
1.170 www 408: }
409:
410: sub lastresurl {
1.258 albertel 411: if ($env{'environment.lastresurl'}) {
412: return $env{'environment.lastresurl'}
1.170 www 413: } else {
414: return '/res';
415: }
416: }
417:
418: sub storeresurl {
419: my $resurl=&Apache::lonnet::clutter(shift);
420: unless ($resurl=~/^\/res/) { return 0; }
421: $resurl=~s/\/$//;
422: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 423: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 424: return 1;
1.42 matthew 425: }
426:
1.74 www 427: sub studentbrowser_javascript {
1.111 www 428: unless (
1.258 albertel 429: (($env{'request.course.id'}) &&
1.302 albertel 430: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
431: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
432: '/'.$env{'request.course.sec'})
433: ))
1.258 albertel 434: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 435: ) { return ''; }
1.74 www 436: return (<<'ENDSTDBRW');
1.776 bisitz 437: <script type="text/javascript" language="Javascript">
1.824 bisitz 438: // <![CDATA[
1.74 www 439: var stdeditbrowser;
1.1413 raeburn 440: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74 www 441: var url = '/adm/pickstudent?';
442: var filter;
1.558 albertel 443: if (!ignorefilter) {
444: eval('filter=document.'+formname+'.'+uname+'.value;');
445: }
1.74 www 446: if (filter != null) {
447: if (filter != '') {
448: url += 'filter='+filter+'&';
449: }
450: }
451: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 452: '&udomelement='+udom+
453: '&clicker='+clicker;
1.111 www 454: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 455: if (courseadv == 'condition') {
456: if (document.getElementById('courseadv')) {
457: courseadv = document.getElementById('courseadv').value;
458: }
459: }
460: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413 raeburn 461: if (uident !== '') { url+="&identelement="+uident; }
1.102 www 462: var title = 'Student_Browser';
1.74 www 463: var options = 'scrollbars=1,resizable=1,menubar=0';
464: options += ',width=700,height=600';
465: stdeditbrowser = open(url,title,options,'1');
466: stdeditbrowser.focus();
467: }
1.824 bisitz 468: // ]]>
1.74 www 469: </script>
470: ENDSTDBRW
471: }
1.42 matthew 472:
1.1003 www 473: sub resourcebrowser_javascript {
474: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 475: return (<<'ENDRESBRW');
1.1003 www 476: <script type="text/javascript" language="Javascript">
477: // <![CDATA[
478: var reseditbrowser;
1.1004 www 479: function openresbrowser(formname,reslink) {
1.1005 www 480: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 481: var title = 'Resource_Browser';
482: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 483: options += ',width=700,height=500';
1.1004 www 484: reseditbrowser = open(url,title,options,'1');
485: reseditbrowser.focus();
1.1003 www 486: }
487: // ]]>
488: </script>
1.1004 www 489: ENDRESBRW
1.1003 www 490: }
491:
1.74 www 492: sub selectstudent_link {
1.1413 raeburn 493: my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999 www 494: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
495: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
496: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 497: if ($env{'request.course.id'}) {
1.302 albertel 498: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
499: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
500: '/'.$env{'request.course.sec'})) {
1.111 www 501: return '';
502: }
1.999 www 503: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 504: if ($courseadv eq 'only') {
505: $callargs .= ",'',1,'$courseadv'";
506: } elsif ($courseadv eq 'none') {
507: $callargs .= ",'','','$courseadv'";
508: } elsif ($courseadv eq 'condition') {
509: $callargs .= ",'','','$courseadv'";
1.1413 raeburn 510: } elsif ($identelem ne '') {
511: $callargs .= ",'','',''";
512: }
513: if ($identelem ne '') {
514: $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793 raeburn 515: }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openstdbrowser('.$callargs.');">'.
518: &mt('Select User').'</a></span>';
1.74 www 519: }
1.258 albertel 520: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 521: $callargs .= ",'',1";
1.793 raeburn 522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openstdbrowser('.$callargs.');">'.
524: &mt('Select User').'</a></span>';
1.111 www 525: }
526: return '';
1.91 www 527: }
528:
1.1004 www 529: sub selectresource_link {
530: my ($form,$reslink,$arg)=@_;
531:
532: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
533: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
534: unless ($env{'request.course.id'}) { return $arg; }
535: return '<span class="LC_nobreak">'.
536: '<a href="javascript:openresbrowser('.$callargs.');">'.
537: $arg.'</a></span>';
538: }
539:
540:
541:
1.653 raeburn 542: sub authorbrowser_javascript {
543: return <<"ENDAUTHORBRW";
1.776 bisitz 544: <script type="text/javascript" language="JavaScript">
1.824 bisitz 545: // <![CDATA[
1.653 raeburn 546: var stdeditbrowser;
547:
548: function openauthorbrowser(formname,udom) {
549: var url = '/adm/pickauthor?';
550: url += 'form='+formname+'&roledom='+udom;
551: var title = 'Author_Browser';
552: var options = 'scrollbars=1,resizable=1,menubar=0';
553: options += ',width=700,height=600';
554: stdeditbrowser = open(url,title,options,'1');
555: stdeditbrowser.focus();
556: }
557:
1.824 bisitz 558: // ]]>
1.653 raeburn 559: </script>
560: ENDAUTHORBRW
561: }
562:
1.91 www 563: sub coursebrowser_javascript {
1.1116 raeburn 564: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 565: $credits_element,$instcode) = @_;
1.932 raeburn 566: my $wintitle = 'Course_Browser';
1.931 raeburn 567: if ($crstype eq 'Community') {
1.932 raeburn 568: $wintitle = 'Community_Browser';
1.909 raeburn 569: }
1.876 raeburn 570: my $id_functions = &javascript_index_functions();
571: my $output = '
1.776 bisitz 572: <script type="text/javascript" language="JavaScript">
1.824 bisitz 573: // <![CDATA[
1.468 raeburn 574: var stdeditbrowser;'."\n";
1.876 raeburn 575:
576: $output .= <<"ENDSTDBRW";
1.909 raeburn 577: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 578: var url = '/adm/pickcourse?';
1.895 raeburn 579: var formid = getFormIdByName(formname);
1.876 raeburn 580: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 581: if (domainfilter != null) {
582: if (domainfilter != '') {
583: url += 'domainfilter='+domainfilter+'&';
584: }
585: }
1.91 www 586: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 587: '&cdomelement='+udom+
588: '&cnameelement='+desc;
1.468 raeburn 589: if (extra_element !=null && extra_element != '') {
1.594 raeburn 590: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 591: url += '&roleelement='+extra_element;
592: if (domainfilter == null || domainfilter == '') {
593: url += '&domainfilter='+extra_element;
594: }
1.234 raeburn 595: }
1.468 raeburn 596: else {
597: if (formname == 'portform') {
598: url += '&setroles='+extra_element;
1.800 raeburn 599: } else {
600: if (formname == 'rules') {
601: url += '&fixeddom='+extra_element;
602: }
1.468 raeburn 603: }
604: }
1.230 raeburn 605: }
1.909 raeburn 606: if (type != null && type != '') {
607: url += '&type='+type;
608: }
609: if (type_elem != null && type_elem != '') {
610: url += '&typeelement='+type_elem;
611: }
1.872 raeburn 612: if (formname == 'ccrs') {
613: var ownername = document.forms[formid].ccuname.value;
614: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 615: url += '&cloner='+ownername+':'+ownerdom;
616: if (type == 'Course') {
617: url += '&crscode='+document.forms[formid].crscode.value;
618: }
1.1221 raeburn 619: }
620: if (formname == 'requestcrs') {
621: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 622: }
1.293 raeburn 623: if (multflag !=null && multflag != '') {
624: url += '&multiple='+multflag;
625: }
1.909 raeburn 626: var title = '$wintitle';
1.91 www 627: var options = 'scrollbars=1,resizable=1,menubar=0';
628: options += ',width=700,height=600';
629: stdeditbrowser = open(url,title,options,'1');
630: stdeditbrowser.focus();
631: }
1.876 raeburn 632: $id_functions
633: ENDSTDBRW
1.1116 raeburn 634: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
635: $output .= &setsec_javascript($sec_element,$formname,$role_element,
636: $credits_element);
1.876 raeburn 637: }
638: $output .= '
639: // ]]>
640: </script>';
641: return $output;
642: }
643:
644: sub javascript_index_functions {
645: return <<"ENDJS";
646:
647: function getFormIdByName(formname) {
648: for (var i=0;i<document.forms.length;i++) {
649: if (document.forms[i].name == formname) {
650: return i;
651: }
652: }
653: return -1;
654: }
655:
656: function getIndexByName(formid,item) {
657: for (var i=0;i<document.forms[formid].elements.length;i++) {
658: if (document.forms[formid].elements[i].name == item) {
659: return i;
660: }
661: }
662: return -1;
663: }
1.468 raeburn 664:
1.876 raeburn 665: function getDomainFromSelectbox(formname,udom) {
666: var userdom;
667: var formid = getFormIdByName(formname);
668: if (formid > -1) {
669: var domid = getIndexByName(formid,udom);
670: if (domid > -1) {
671: if (document.forms[formid].elements[domid].type == 'select-one') {
672: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
673: }
674: if (document.forms[formid].elements[domid].type == 'hidden') {
675: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 676: }
677: }
678: }
1.876 raeburn 679: return userdom;
680: }
681:
682: ENDJS
1.468 raeburn 683:
1.876 raeburn 684: }
685:
1.1017 raeburn 686: sub javascript_array_indexof {
1.1018 raeburn 687: return <<ENDJS;
1.1017 raeburn 688: <script type="text/javascript" language="JavaScript">
689: // <![CDATA[
690:
691: if (!Array.prototype.indexOf) {
692: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
693: "use strict";
694: if (this === void 0 || this === null) {
695: throw new TypeError();
696: }
697: var t = Object(this);
698: var len = t.length >>> 0;
699: if (len === 0) {
700: return -1;
701: }
702: var n = 0;
703: if (arguments.length > 0) {
704: n = Number(arguments[1]);
1.1088 foxr 705: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 706: n = 0;
707: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
708: n = (n > 0 || -1) * Math.floor(Math.abs(n));
709: }
710: }
711: if (n >= len) {
712: return -1;
713: }
714: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
715: for (; k < len; k++) {
716: if (k in t && t[k] === searchElement) {
717: return k;
718: }
719: }
720: return -1;
721: }
722: }
723:
724: // ]]>
725: </script>
726:
727: ENDJS
728:
729: }
730:
1.876 raeburn 731: sub userbrowser_javascript {
732: my $id_functions = &javascript_index_functions();
733: return <<"ENDUSERBRW";
734:
1.888 raeburn 735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 736: var url = '/adm/pickuser?';
737: var userdom = getDomainFromSelectbox(formname,udom);
738: if (userdom != null) {
739: if (userdom != '') {
740: url += 'srchdom='+userdom+'&';
741: }
742: }
743: url += 'form=' + formname + '&unameelement='+uname+
744: '&udomelement='+udom+
745: '&ulastelement='+ulast+
746: '&ufirstelement='+ufirst+
747: '&uemailelement='+uemail+
1.881 raeburn 748: '&hideudomelement='+hideudom+
749: '&coursedom='+crsdom;
1.888 raeburn 750: if ((caller != null) && (caller != undefined)) {
751: url += '&caller='+caller;
752: }
1.876 raeburn 753: var title = 'User_Browser';
754: var options = 'scrollbars=1,resizable=1,menubar=0';
755: options += ',width=700,height=600';
756: var stdeditbrowser = open(url,title,options,'1');
757: stdeditbrowser.focus();
758: }
759:
1.888 raeburn 760: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 761: var formid = getFormIdByName(formname);
762: if (formid > -1) {
1.888 raeburn 763: var unameid = getIndexByName(formid,uname);
1.876 raeburn 764: var domid = getIndexByName(formid,udom);
765: var hidedomid = getIndexByName(formid,origdom);
766: if (hidedomid > -1) {
767: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 768: var unameval = document.forms[formid].elements[unameid].value;
769: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
770: if (domid > -1) {
771: var slct = document.forms[formid].elements[domid];
772: if (slct.type == 'select-one') {
773: var i;
774: for (i=0;i<slct.length;i++) {
775: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
776: }
777: }
778: if (slct.type == 'hidden') {
779: slct.value = fixeddom;
1.876 raeburn 780: }
781: }
1.468 raeburn 782: }
783: }
784: }
1.876 raeburn 785: return;
786: }
787:
788: $id_functions
789: ENDUSERBRW
1.468 raeburn 790: }
791:
792: sub setsec_javascript {
1.1116 raeburn 793: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 794: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
795: $communityrolestr);
796: if ($role_element ne '') {
797: my @allroles = ('st','ta','ep','in','ad');
798: foreach my $crstype ('Course','Community') {
799: if ($crstype eq 'Community') {
800: foreach my $role (@allroles) {
801: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
802: }
803: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
804: } else {
805: foreach my $role (@allroles) {
806: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
807: }
808: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
809: }
810: }
811: $rolestr = '"'.join('","',@allroles).'"';
812: $courserolestr = '"'.join('","',@courserolenames).'"';
813: $communityrolestr = '"'.join('","',@communityrolenames).'"';
814: }
1.468 raeburn 815: my $setsections = qq|
816: function setSect(sectionlist) {
1.629 raeburn 817: var sectionsArray = new Array();
818: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
819: sectionsArray = sectionlist.split(",");
820: }
1.468 raeburn 821: var numSections = sectionsArray.length;
822: document.$formname.$sec_element.length = 0;
823: if (numSections == 0) {
824: document.$formname.$sec_element.multiple=false;
825: document.$formname.$sec_element.size=1;
826: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
827: } else {
828: if (numSections == 1) {
829: document.$formname.$sec_element.multiple=false;
830: document.$formname.$sec_element.size=1;
831: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
832: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
833: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
834: } else {
835: for (var i=0; i<numSections; i++) {
836: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
837: }
838: document.$formname.$sec_element.multiple=true
839: if (numSections < 3) {
840: document.$formname.$sec_element.size=numSections;
841: } else {
842: document.$formname.$sec_element.size=3;
843: }
844: document.$formname.$sec_element.options[0].selected = false
845: }
846: }
1.91 www 847: }
1.905 raeburn 848:
849: function setRole(crstype) {
1.468 raeburn 850: |;
1.905 raeburn 851: if ($role_element eq '') {
852: $setsections .= ' return;
853: }
854: ';
855: } else {
856: $setsections .= qq|
857: var elementLength = document.$formname.$role_element.length;
858: var allroles = Array($rolestr);
859: var courserolenames = Array($courserolestr);
860: var communityrolenames = Array($communityrolestr);
861: if (elementLength != undefined) {
862: if (document.$formname.$role_element.options[5].value == 'cc') {
863: if (crstype == 'Course') {
864: return;
865: } else {
866: allroles[5] = 'co';
867: for (var i=0; i<6; i++) {
868: document.$formname.$role_element.options[i].value = allroles[i];
869: document.$formname.$role_element.options[i].text = communityrolenames[i];
870: }
871: }
872: } else {
873: if (crstype == 'Community') {
874: return;
875: } else {
876: allroles[5] = 'cc';
877: for (var i=0; i<6; i++) {
878: document.$formname.$role_element.options[i].value = allroles[i];
879: document.$formname.$role_element.options[i].text = courserolenames[i];
880: }
881: }
882: }
883: }
884: return;
885: }
886: |;
887: }
1.1116 raeburn 888: if ($credits_element) {
889: $setsections .= qq|
890: function setCredits(defaultcredits) {
891: document.$formname.$credits_element.value = defaultcredits;
892: return;
893: }
894: |;
895: }
1.468 raeburn 896: return $setsections;
897: }
898:
1.91 www 899: sub selectcourse_link {
1.909 raeburn 900: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
901: $typeelement) = @_;
902: my $type = $selecttype;
1.871 raeburn 903: my $linktext = &mt('Select Course');
904: if ($selecttype eq 'Community') {
1.909 raeburn 905: $linktext = &mt('Select Community');
1.1239 raeburn 906: } elsif ($selecttype eq 'Placement') {
907: $linktext = &mt('Select Placement Test');
1.906 raeburn 908: } elsif ($selecttype eq 'Course/Community') {
909: $linktext = &mt('Select Course/Community');
1.909 raeburn 910: $type = '';
1.1019 raeburn 911: } elsif ($selecttype eq 'Select') {
912: $linktext = &mt('Select');
913: $type = '';
1.871 raeburn 914: }
1.787 bisitz 915: return '<span class="LC_nobreak">'
916: ."<a href='"
917: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
918: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 919: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 920: ."'>".$linktext.'</a>'
1.787 bisitz 921: .'</span>';
1.74 www 922: }
1.42 matthew 923:
1.653 raeburn 924: sub selectauthor_link {
925: my ($form,$udom)=@_;
926: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
927: &mt('Select Author').'</a>';
928: }
929:
1.876 raeburn 930: sub selectuser_link {
1.881 raeburn 931: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 932: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 933: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 934: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 935: ');">'.$linktext.'</a>';
1.876 raeburn 936: }
937:
1.273 raeburn 938: sub check_uncheck_jscript {
939: my $jscript = <<"ENDSCRT";
940: function checkAll(field) {
941: if (field.length > 0) {
942: for (i = 0; i < field.length; i++) {
1.1093 raeburn 943: if (!field[i].disabled) {
944: field[i].checked = true;
945: }
1.273 raeburn 946: }
947: } else {
1.1093 raeburn 948: if (!field.disabled) {
949: field.checked = true;
950: }
1.273 raeburn 951: }
952: }
953:
954: function uncheckAll(field) {
955: if (field.length > 0) {
956: for (i = 0; i < field.length; i++) {
957: field[i].checked = false ;
1.543 albertel 958: }
959: } else {
1.273 raeburn 960: field.checked = false ;
961: }
962: }
963: ENDSCRT
964: return $jscript;
965: }
966:
1.656 www 967: sub select_timezone {
1.1387 raeburn 968: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
969: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 970: if ($includeempty) {
971: $output .= '<option value=""';
972: if (($selected eq '') || ($selected eq 'local')) {
973: $output .= ' selected="selected" ';
974: }
975: $output .= '> </option>';
976: }
1.657 raeburn 977: my @timezones = DateTime::TimeZone->all_names;
978: foreach my $tzone (@timezones) {
979: $output.= '<option value="'.$tzone.'"';
980: if ($tzone eq $selected) {
981: $output.=' selected="selected"';
982: }
983: $output.=">$tzone</option>\n";
1.656 www 984: }
985: $output.="</select>";
986: return $output;
987: }
1.273 raeburn 988:
1.687 raeburn 989: sub select_datelocale {
1.1256 raeburn 990: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
991: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 992: if ($includeempty) {
993: $output .= '<option value=""';
994: if ($selected eq '') {
995: $output .= ' selected="selected" ';
996: }
997: $output .= '> </option>';
998: }
1.1241 raeburn 999: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 1000: my (@possibles,%locale_names);
1.1241 raeburn 1001: my @locales = DateTime::Locale->ids();
1002: foreach my $id (@locales) {
1003: if ($id ne '') {
1004: my ($en_terr,$native_terr);
1005: my $loc = DateTime::Locale->load($id);
1006: if (ref($loc)) {
1007: $en_terr = $loc->name();
1008: $native_terr = $loc->native_name();
1.687 raeburn 1009: if (grep(/^en$/,@languages) || !@languages) {
1010: if ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: } elsif ($native_terr ne '') {
1013: $locale_names{$id} = $native_terr;
1014: }
1015: } else {
1016: if ($native_terr ne '') {
1017: $locale_names{$id} = $native_terr.' ';
1018: } elsif ($en_terr ne '') {
1019: $locale_names{$id} = '('.$en_terr.')';
1020: }
1021: }
1.1220 raeburn 1022: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1023: push(@possibles,$id);
1024: }
1.687 raeburn 1025: }
1026: }
1027: foreach my $item (sort(@possibles)) {
1028: $output.= '<option value="'.$item.'"';
1029: if ($item eq $selected) {
1030: $output.=' selected="selected"';
1031: }
1032: $output.=">$item";
1033: if ($locale_names{$item} ne '') {
1.1220 raeburn 1034: $output.=' '.$locale_names{$item};
1.687 raeburn 1035: }
1036: $output.="</option>\n";
1037: }
1038: $output.="</select>";
1039: return $output;
1040: }
1041:
1.792 raeburn 1042: sub select_language {
1.1256 raeburn 1043: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1044: my %langchoices;
1045: if ($includeempty) {
1.1117 raeburn 1046: %langchoices = ('' => 'No language preference');
1.792 raeburn 1047: }
1048: foreach my $id (&languageids()) {
1049: my $code = &supportedlanguagecode($id);
1050: if ($code) {
1051: $langchoices{$code} = &plainlanguagedescription($id);
1052: }
1053: }
1.1117 raeburn 1054: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1055: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1056: }
1057:
1.42 matthew 1058: =pod
1.36 matthew 1059:
1.1088 foxr 1060:
1061: =item * &list_languages()
1062:
1063: Returns an array reference that is suitable for use in language prompters.
1064: Each array element is itself a two element array. The first element
1065: is the language code. The second element a descsriptiuon of the
1066: language itself. This is suitable for use in e.g.
1067: &Apache::edit::select_arg (once dereferenced that is).
1068:
1069: =cut
1070:
1071: sub list_languages {
1072: my @lang_choices;
1073:
1074: foreach my $id (&languageids()) {
1075: my $code = &supportedlanguagecode($id);
1076: if ($code) {
1077: my $selector = $supported_codes{$id};
1078: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1079: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1080: }
1081: }
1082: return \@lang_choices;
1083: }
1084:
1085: =pod
1086:
1.648 raeburn 1087: =item * &linked_select_forms(...)
1.36 matthew 1088:
1089: linked_select_forms returns a string containing a <script></script> block
1090: and html for two <select> menus. The select menus will be linked in that
1091: changing the value of the first menu will result in new values being placed
1092: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1093: order unless a defined order is provided.
1.36 matthew 1094:
1095: linked_select_forms takes the following ordered inputs:
1096:
1097: =over 4
1098:
1.112 bowersj2 1099: =item * $formname, the name of the <form> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1102:
1.112 bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36 matthew 1104:
1.112 bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1106:
1.112 bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1108:
1.112 bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1110:
1.609 raeburn 1111: =item * $menuorder, the order of values in the first menu
1112:
1.1115 raeburn 1113: =item * $onchangefirst, additional javascript call to execute for an onchange
1114: event for the first <select> tag
1115:
1116: =item * $onchangesecond, additional javascript call to execute for an onchange
1117: event for the second <select> tag
1118:
1.1245 raeburn 1119: =item * $suffix, to differentiate separate uses of select2data javascript
1120: objects in a page.
1121:
1.41 ng 1122: =back
1123:
1.36 matthew 1124: Below is an example of such a hash. Only the 'text', 'default', and
1125: 'select2' keys must appear as stated. keys(%menu) are the possible
1126: values for the first select menu. The text that coincides with the
1.41 ng 1127: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1128: and text for the second menu are given in the hash pointed to by
1129: $menu{$choice1}->{'select2'}.
1130:
1.112 bowersj2 1131: my %menu = ( A1 => { text =>"Choice A1" ,
1132: default => "B3",
1133: select2 => {
1134: B1 => "Choice B1",
1135: B2 => "Choice B2",
1136: B3 => "Choice B3",
1137: B4 => "Choice B4"
1.609 raeburn 1138: },
1139: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1140: },
1141: A2 => { text =>"Choice A2" ,
1142: default => "C2",
1143: select2 => {
1144: C1 => "Choice C1",
1145: C2 => "Choice C2",
1146: C3 => "Choice C3"
1.609 raeburn 1147: },
1148: order => ['C2','C1','C3'],
1.112 bowersj2 1149: },
1150: A3 => { text =>"Choice A3" ,
1151: default => "D6",
1152: select2 => {
1153: D1 => "Choice D1",
1154: D2 => "Choice D2",
1155: D3 => "Choice D3",
1156: D4 => "Choice D4",
1157: D5 => "Choice D5",
1158: D6 => "Choice D6",
1159: D7 => "Choice D7"
1.609 raeburn 1160: },
1161: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1162: }
1163: );
1.36 matthew 1164:
1165: =cut
1166:
1167: sub linked_select_forms {
1168: my ($formname,
1169: $middletext,
1170: $firstdefault,
1171: $firstselectname,
1172: $secondselectname,
1.609 raeburn 1173: $hashref,
1174: $menuorder,
1.1115 raeburn 1175: $onchangefirst,
1.1245 raeburn 1176: $onchangesecond,
1177: $suffix
1.36 matthew 1178: ) = @_;
1179: my $second = "document.$formname.$secondselectname";
1180: my $first = "document.$formname.$firstselectname";
1181: # output the javascript to do the changing
1182: my $result = '';
1.776 bisitz 1183: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1184: $result.="// <![CDATA[\n";
1.1245 raeburn 1185: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1186: $" = '","';
1187: my $debug = '';
1188: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1189: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1190: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1191: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1192: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1193: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1194: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1195: @s2values = @{$hashref->{$s1}->{'order'}};
1196: }
1.36 matthew 1197: $result.="\"@s2values\");\n";
1.1245 raeburn 1198: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1199: my @s2texts;
1200: foreach my $value (@s2values) {
1.1263 raeburn 1201: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1202: }
1203: $result.="\"@s2texts\");\n";
1204: }
1205: $"=' ';
1206: $result.= <<"END";
1207:
1.1245 raeburn 1208: function select1${suffix}_changed() {
1.36 matthew 1209: // Determine new choice
1.1245 raeburn 1210: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1211: // update select2
1.1245 raeburn 1212: var values = select2data${suffix}[newvalue].values;
1213: var texts = select2data${suffix}[newvalue].texts;
1214: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1215: var i;
1216: // out with the old
1.1245 raeburn 1217: $second.options.length = 0;
1218: // in with the new
1.36 matthew 1219: for (i=0;i<values.length; i++) {
1220: $second.options[i] = new Option(values[i]);
1.143 matthew 1221: $second.options[i].value = values[i];
1.36 matthew 1222: $second.options[i].text = texts[i];
1223: if (values[i] == select2def) {
1224: $second.options[i].selected = true;
1225: }
1226: }
1227: }
1.824 bisitz 1228: // ]]>
1.36 matthew 1229: </script>
1230: END
1231: # output the initial values for the selection lists
1.1245 raeburn 1232: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1233: my @order = sort(keys(%{$hashref}));
1234: if (ref($menuorder) eq 'ARRAY') {
1235: @order = @{$menuorder};
1236: }
1237: foreach my $value (@order) {
1.36 matthew 1238: $result.=" <option value=\"$value\" ";
1.253 albertel 1239: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1240: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1241: }
1242: $result .= "</select>\n";
1.1400 raeburn 1243: my %select2;
1244: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1245: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1246: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1247: }
1248: }
1.36 matthew 1249: $result .= $middletext;
1.1115 raeburn 1250: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1251: if ($onchangesecond) {
1252: $result .= ' onchange="'.$onchangesecond.'"';
1253: }
1254: $result .= ">\n";
1.36 matthew 1255: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1256:
1257: my @secondorder = sort(keys(%select2));
1258: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1259: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1260: }
1261: foreach my $value (@secondorder) {
1.36 matthew 1262: $result.=" <option value=\"$value\" ";
1.253 albertel 1263: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1264: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1265: }
1266: $result .= "</select>\n";
1267: # return $debug;
1268: return $result;
1269: } # end of sub linked_select_forms {
1270:
1.45 matthew 1271: =pod
1.44 bowersj2 1272:
1.1381 raeburn 1273: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1274:
1.112 bowersj2 1275: Returns a string corresponding to an HTML link to the given help
1276: $topic, where $topic corresponds to the name of a .tex file in
1277: /home/httpd/html/adm/help/tex, with underscores replaced by
1278: spaces.
1279:
1280: $text will optionally be linked to the same topic, allowing you to
1281: link text in addition to the graphic. If you do not want to link
1282: text, but wish to specify one of the later parameters, pass an
1283: empty string.
1284:
1285: $stayOnPage is a value that will be interpreted as a boolean. If true,
1286: the link will not open a new window. If false, the link will open
1287: a new window using Javascript. (Default is false.)
1288:
1289: $width and $height are optional numerical parameters that will
1290: override the width and height of the popped up window, which may
1.973 raeburn 1291: be useful for certain help topics with big pictures included.
1292:
1293: $imgid is the id of the img tag used for the help icon. This may be
1294: used in a javascript call to switch the image src. See
1295: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1296:
1.1381 raeburn 1297: $links_target will optionally be set to a target (_top, _parent or _self).
1298:
1.44 bowersj2 1299: =cut
1300:
1301: sub help_open_topic {
1.1381 raeburn 1302: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1303: $text = "" if (not defined $text);
1.44 bowersj2 1304: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1305: $width = 500 if (not defined $width);
1.44 bowersj2 1306: $height = 400 if (not defined $height);
1307: my $filename = $topic;
1308: $filename =~ s/ /_/g;
1309:
1.48 bowersj2 1310: my $template = "";
1311: my $link;
1.572 banghart 1312:
1.159 www 1313: $topic=~s/\W/\_/g;
1.44 bowersj2 1314:
1.572 banghart 1315: if (!$stayOnPage) {
1.1033 www 1316: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1317: } elsif ($stayOnPage eq 'popup') {
1318: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1319: } else {
1.48 bowersj2 1320: $link = "/adm/help/${filename}.hlp";
1321: }
1322:
1323: # Add the text
1.1314 raeburn 1324: my $target = ' target="_top"';
1.1381 raeburn 1325: if ($links_target) {
1326: $target = ' target="'.$links_target.'"';
1327: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1328: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1329: $target = '';
1.1378 raeburn 1330: }
1.1380 raeburn 1331: if ($text ne "") {
1.763 bisitz 1332: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1333: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1334: .$text.'</a>';
1.48 bowersj2 1335: }
1336:
1.763 bisitz 1337: # (Always) Add the graphic
1.179 matthew 1338: my $title = &mt('Online Help');
1.667 raeburn 1339: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1340: if ($imgid ne '') {
1341: $imgid = ' id="'.$imgid.'"';
1342: }
1.1314 raeburn 1343: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1344: .'<img src="'.$helpicon.'" border="0"'
1345: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1346: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1347: .' /></a>';
1348: if ($text ne "") {
1349: $template.='</span>';
1350: }
1.44 bowersj2 1351: return $template;
1352:
1.106 bowersj2 1353: }
1354:
1355: # This is a quicky function for Latex cheatsheet editing, since it
1356: # appears in at least four places
1357: sub helpLatexCheatsheet {
1.1037 www 1358: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1359: my $out;
1.106 bowersj2 1360: my $addOther = '';
1.732 raeburn 1361: if ($topic) {
1.1037 www 1362: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1363: }
1364: $out = '<span>' # Start cheatsheet
1365: .$addOther
1366: .'<span>'
1.1037 www 1367: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1368: .'</span> <span>'
1.1037 www 1369: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1370: .'</span>';
1.732 raeburn 1371: unless ($not_author) {
1.1186 kruse 1372: $out .= '<span>'
1373: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1374: .'</span> <span>'
1.1424 raeburn 1375: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763 bisitz 1376: .'</span>';
1.732 raeburn 1377: }
1.763 bisitz 1378: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1379: return $out;
1.172 www 1380: }
1381:
1.430 albertel 1382: sub general_help {
1383: my $helptopic='Student_Intro';
1384: if ($env{'request.role'}=~/^(ca|au)/) {
1385: $helptopic='Authoring_Intro';
1.907 raeburn 1386: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1387: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1388: } elsif ($env{'request.role'}=~/^dc/) {
1389: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1390: }
1391: return $helptopic;
1392: }
1393:
1394: sub update_help_link {
1395: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1396: my $origurl = $ENV{'REQUEST_URI'};
1397: $origurl=~s|^/~|/priv/|;
1398: my $timestamp = time;
1399: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1400: $$datum = &escape($$datum);
1401: }
1402:
1403: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1404: my $output .= <<"ENDOUTPUT";
1405: <script type="text/javascript">
1.824 bisitz 1406: // <![CDATA[
1.430 albertel 1407: banner_link = '$banner_link';
1.824 bisitz 1408: // ]]>
1.430 albertel 1409: </script>
1410: ENDOUTPUT
1411: return $output;
1412: }
1413:
1414: # now just updates the help link and generates a blue icon
1.193 raeburn 1415: sub help_open_menu {
1.1381 raeburn 1416: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1417: = @_;
1.949 droeschl 1418: $stayOnPage = 1;
1.430 albertel 1419: my $output;
1420: if ($component_help) {
1421: if (!$text) {
1422: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1423: $width,$height,'',$links_target);
1.430 albertel 1424: } else {
1425: my $help_text;
1426: $help_text=&unescape($topic);
1427: $output='<table><tr><td>'.
1428: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1429: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1430: }
1431: }
1432: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1433: return $output.$banner_link;
1434: }
1435:
1436: sub top_nav_help {
1.1369 raeburn 1437: my ($text,$linkattr) = @_;
1.436 albertel 1438: $text = &mt($text);
1.949 droeschl 1439: my $stay_on_page = 1;
1440:
1.1168 raeburn 1441: my ($link,$banner_link);
1442: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1443: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1444: : "javascript:helpMenu('open')";
1445: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1446: }
1.201 raeburn 1447: my $title = &mt('Get help');
1.1168 raeburn 1448: if ($link) {
1449: return <<"END";
1.436 albertel 1450: $banner_link
1.1369 raeburn 1451: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1452: END
1.1168 raeburn 1453: } else {
1454: return ' '.$text.' ';
1455: }
1.436 albertel 1456: }
1457:
1458: sub help_menu_js {
1.1154 raeburn 1459: my ($httphost) = @_;
1.949 droeschl 1460: my $stayOnPage = 1;
1.436 albertel 1461: my $width = 620;
1462: my $height = 600;
1.430 albertel 1463: my $helptopic=&general_help();
1.1154 raeburn 1464: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1465: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1466: my $start_page =
1467: &Apache::loncommon::start_page('Help Menu', undef,
1468: {'frameset' => 1,
1469: 'js_ready' => 1,
1.1154 raeburn 1470: 'use_absolute' => $httphost,
1.331 albertel 1471: 'add_entries' => {
1.1168 raeburn 1472: 'border' => '0',
1.579 raeburn 1473: 'rows' => "110,*",},});
1.331 albertel 1474: my $end_page =
1475: &Apache::loncommon::end_page({'frameset' => 1,
1476: 'js_ready' => 1,});
1477:
1.436 albertel 1478: my $template .= <<"ENDTEMPLATE";
1479: <script type="text/javascript">
1.877 bisitz 1480: // <![CDATA[
1.253 albertel 1481: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1482: var banner_link = '';
1.243 raeburn 1483: function helpMenu(target) {
1484: var caller = this;
1485: if (target == 'open') {
1486: var newWindow = null;
1487: try {
1.262 albertel 1488: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1489: }
1490: catch(error) {
1491: writeHelp(caller);
1492: return;
1493: }
1494: if (newWindow) {
1495: caller = newWindow;
1496: }
1.193 raeburn 1497: }
1.243 raeburn 1498: writeHelp(caller);
1499: return;
1500: }
1501: function writeHelp(caller) {
1.1168 raeburn 1502: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1503: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1504: caller.document.close();
1505: caller.focus();
1.193 raeburn 1506: }
1.877 bisitz 1507: // END LON-CAPA Internal -->
1.253 albertel 1508: // ]]>
1.436 albertel 1509: </script>
1.193 raeburn 1510: ENDTEMPLATE
1511: return $template;
1512: }
1513:
1.172 www 1514: sub help_open_bug {
1515: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1516: unless ($env{'user.adv'}) { return ''; }
1.172 www 1517: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1518: $text = "" if (not defined $text);
1519: $stayOnPage=1;
1.184 albertel 1520: $width = 600 if (not defined $width);
1521: $height = 600 if (not defined $height);
1.172 www 1522:
1523: $topic=~s/\W+/\+/g;
1524: my $link='';
1525: my $template='';
1.379 albertel 1526: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1527: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1528: if (!$stayOnPage)
1529: {
1530: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1531: }
1532: else
1533: {
1534: $link = $url;
1535: }
1.1314 raeburn 1536:
1.1382 raeburn 1537: my $target = '_top';
1538: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1539: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1540: $target = '_blank';
1.1378 raeburn 1541: }
1.1382 raeburn 1542:
1.172 www 1543: # Add the text
1544: if ($text ne "")
1545: {
1546: $template .=
1547: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1548: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1549: }
1550:
1551: # Add the graphic
1.179 matthew 1552: my $title = &mt('Report a Bug');
1.215 albertel 1553: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1554: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1555: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1556: ENDTEMPLATE
1557: if ($text ne '') { $template.='</td></tr></table>' };
1558: return $template;
1559:
1560: }
1561:
1562: sub help_open_faq {
1563: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1564: unless ($env{'user.adv'}) { return ''; }
1.172 www 1565: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1566: $text = "" if (not defined $text);
1567: $stayOnPage=1;
1568: $width = 350 if (not defined $width);
1569: $height = 400 if (not defined $height);
1570:
1571: $topic=~s/\W+/\+/g;
1572: my $link='';
1573: my $template='';
1574: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1575: if (!$stayOnPage)
1576: {
1577: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1578: }
1579: else
1580: {
1581: $link = $url;
1582: }
1583:
1584: # Add the text
1585: if ($text ne "")
1586: {
1587: $template .=
1.173 www 1588: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1589: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1590: }
1591:
1592: # Add the graphic
1.179 matthew 1593: my $title = &mt('View the FAQ');
1.215 albertel 1594: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1595: $template .= <<"ENDTEMPLATE";
1.436 albertel 1596: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1597: ENDTEMPLATE
1598: if ($text ne '') { $template.='</td></tr></table>' };
1599: return $template;
1600:
1.44 bowersj2 1601: }
1.37 matthew 1602:
1.180 matthew 1603: ###############################################################
1604: ###############################################################
1605:
1.45 matthew 1606: =pod
1607:
1.648 raeburn 1608: =item * &change_content_javascript():
1.256 matthew 1609:
1610: This and the next function allow you to create small sections of an
1611: otherwise static HTML page that you can update on the fly with
1612: Javascript, even in Netscape 4.
1613:
1614: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1615: must be written to the HTML page once. It will prove the Javascript
1616: function "change(name, content)". Calling the change function with the
1617: name of the section
1618: you want to update, matching the name passed to C<changable_area>, and
1619: the new content you want to put in there, will put the content into
1620: that area.
1621:
1622: B<Note>: Netscape 4 only reserves enough space for the changable area
1623: to contain room for the original contents. You need to "make space"
1624: for whatever changes you wish to make, and be B<sure> to check your
1625: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1626: it's adequate for updating a one-line status display, but little more.
1627: This script will set the space to 100% width, so you only need to
1628: worry about height in Netscape 4.
1629:
1630: Modern browsers are much less limiting, and if you can commit to the
1631: user not using Netscape 4, this feature may be used freely with
1632: pretty much any HTML.
1633:
1634: =cut
1635:
1636: sub change_content_javascript {
1637: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1638: if ($env{'browser.type'} eq 'netscape' &&
1639: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1640: return (<<NETSCAPE4);
1641: function change(name, content) {
1642: doc = document.layers[name+"___escape"].layers[0].document;
1643: doc.open();
1644: doc.write(content);
1645: doc.close();
1646: }
1647: NETSCAPE4
1648: } else {
1649: # Otherwise, we need to use semi-standards-compliant code
1650: # (technically, "innerHTML" isn't standard but the equivalent
1651: # is really scary, and every useful browser supports it
1652: return (<<DOMBASED);
1653: function change(name, content) {
1654: element = document.getElementById(name);
1655: element.innerHTML = content;
1656: }
1657: DOMBASED
1658: }
1659: }
1660:
1661: =pod
1662:
1.648 raeburn 1663: =item * &changable_area($name,$origContent):
1.256 matthew 1664:
1665: This provides a "changable area" that can be modified on the fly via
1666: the Javascript code provided in C<change_content_javascript>. $name is
1667: the name you will use to reference the area later; do not repeat the
1668: same name on a given HTML page more then once. $origContent is what
1669: the area will originally contain, which can be left blank.
1670:
1671: =cut
1672:
1673: sub changable_area {
1674: my ($name, $origContent) = @_;
1675:
1.258 albertel 1676: if ($env{'browser.type'} eq 'netscape' &&
1677: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1678: # If this is netscape 4, we need to use the Layer tag
1679: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1680: } else {
1681: return "<span id='$name'>$origContent</span>";
1682: }
1683: }
1684:
1685: =pod
1686:
1.648 raeburn 1687: =item * &viewport_geometry_js
1.590 raeburn 1688:
1689: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1690:
1691: =cut
1692:
1693:
1694: sub viewport_geometry_js {
1695: return <<"GEOMETRY";
1696: var Geometry = {};
1697: function init_geometry() {
1698: if (Geometry.init) { return };
1699: Geometry.init=1;
1700: if (window.innerHeight) {
1701: Geometry.getViewportHeight = function() { return window.innerHeight; };
1702: Geometry.getViewportWidth = function() { return window.innerWidth; };
1703: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1704: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1705: }
1706: else if (document.documentElement && document.documentElement.clientHeight) {
1707: Geometry.getViewportHeight =
1708: function() { return document.documentElement.clientHeight; };
1709: Geometry.getViewportWidth =
1710: function() { return document.documentElement.clientWidth; };
1711:
1712: Geometry.getHorizontalScroll =
1713: function() { return document.documentElement.scrollLeft; };
1714: Geometry.getVerticalScroll =
1715: function() { return document.documentElement.scrollTop; };
1716: }
1717: else if (document.body.clientHeight) {
1718: Geometry.getViewportHeight =
1719: function() { return document.body.clientHeight; };
1720: Geometry.getViewportWidth =
1721: function() { return document.body.clientWidth; };
1722: Geometry.getHorizontalScroll =
1723: function() { return document.body.scrollLeft; };
1724: Geometry.getVerticalScroll =
1725: function() { return document.body.scrollTop; };
1726: }
1727: }
1728:
1729: GEOMETRY
1730: }
1731:
1732: =pod
1733:
1.648 raeburn 1734: =item * &viewport_size_js()
1.590 raeburn 1735:
1736: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1737:
1738: =cut
1739:
1740: sub viewport_size_js {
1741: my $geometry = &viewport_geometry_js();
1742: return <<"DIMS";
1743:
1744: $geometry
1745:
1746: function getViewportDims(width,height) {
1747: init_geometry();
1748: width.value = Geometry.getViewportWidth();
1749: height.value = Geometry.getViewportHeight();
1750: return;
1751: }
1752:
1753: DIMS
1754: }
1755:
1756: =pod
1757:
1.648 raeburn 1758: =item * &resize_textarea_js()
1.565 albertel 1759:
1760: emits the needed javascript to resize a textarea to be as big as possible
1761:
1762: creates a function resize_textrea that takes two IDs first should be
1763: the id of the element to resize, second should be the id of a div that
1764: surrounds everything that comes after the textarea, this routine needs
1765: to be attached to the <body> for the onload and onresize events.
1766:
1767: =cut
1768:
1769: sub resize_textarea_js {
1.590 raeburn 1770: my $geometry = &viewport_geometry_js();
1.565 albertel 1771: return <<"RESIZE";
1772: <script type="text/javascript">
1.824 bisitz 1773: // <![CDATA[
1.590 raeburn 1774: $geometry
1.565 albertel 1775:
1.588 albertel 1776: function getX(element) {
1777: var x = 0;
1778: while (element) {
1779: x += element.offsetLeft;
1780: element = element.offsetParent;
1781: }
1782: return x;
1783: }
1784: function getY(element) {
1785: var y = 0;
1786: while (element) {
1787: y += element.offsetTop;
1788: element = element.offsetParent;
1789: }
1790: return y;
1791: }
1792:
1793:
1.565 albertel 1794: function resize_textarea(textarea_id,bottom_id) {
1795: init_geometry();
1796: var textarea = document.getElementById(textarea_id);
1797: //alert(textarea);
1798:
1.588 albertel 1799: var textarea_top = getY(textarea);
1.565 albertel 1800: var textarea_height = textarea.offsetHeight;
1801: var bottom = document.getElementById(bottom_id);
1.588 albertel 1802: var bottom_top = getY(bottom);
1.565 albertel 1803: var bottom_height = bottom.offsetHeight;
1804: var window_height = Geometry.getViewportHeight();
1.588 albertel 1805: var fudge = 23;
1.565 albertel 1806: var new_height = window_height-fudge-textarea_top-bottom_height;
1807: if (new_height < 300) {
1808: new_height = 300;
1809: }
1810: textarea.style.height=new_height+'px';
1811: }
1.824 bisitz 1812: // ]]>
1.565 albertel 1813: </script>
1814: RESIZE
1815:
1816: }
1817:
1.1205 golterma 1818: sub colorfuleditor_js {
1.1248 raeburn 1819: my $browse_or_search;
1820: my $respath;
1821: my ($cnum,$cdom) = &crsauthor_url();
1822: if ($cnum) {
1823: $respath = "/res/$cdom/$cnum/";
1824: my %js_lt = &Apache::lonlocal::texthash(
1825: sunm => 'Sub-directory name',
1826: save => 'Save page to make this permanent',
1827: );
1828: &js_escape(\%js_lt);
1.1400 raeburn 1829: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1830: $browse_or_search = <<"END";
1831:
1.1400 raeburn 1832: $showfile_js
1833:
1.1248 raeburn 1834: function toggleChooser(form,element,titleid,only,search) {
1835: var disp = 'none';
1836: if (document.getElementById('chooser_'+element)) {
1837: var curr = document.getElementById('chooser_'+element).style.display;
1838: if (curr == 'none') {
1839: disp='inline';
1840: if (form.elements['chooser_'+element].length) {
1841: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1842: form.elements['chooser_'+element][i].checked = false;
1843: }
1844: }
1845: toggleResImport(form,element);
1846: }
1847: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1848: var dirsel = '';
1849: var filesel = '';
1850: if (document.getElementById('chooser_'+element+'_crsres')) {
1851: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1852: if (currcrsres == 'none') {
1853: dirsel = 'coursepath_'+element;
1854: var filesel = 'coursefile_'+element;
1855: var include;
1856: if (document.getElementById('crsres_include_'+element)) {
1857: include = document.getElementById('crsres_include_'+element).value;
1858: }
1.1402 raeburn 1859: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1860: }
1861: }
1862: if (document.getElementById('chooser_'+element+'_upload')) {
1863: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1864: if (currcrsupload == 'none') {
1865: dirsel = 'crsauthorpath_'+element;
1866: filesel = '';
1.1402 raeburn 1867: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1868: }
1869: }
1.1248 raeburn 1870: }
1871: }
1872:
1.1400 raeburn 1873: function toggleCrsFile(form,element) {
1.1248 raeburn 1874: if (document.getElementById('chooser_'+element+'_crsres')) {
1875: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1876: if (curr == 'none') {
1.1400 raeburn 1877: if (document.getElementById('coursepath_'+element)) {
1878: var numdirs;
1879: if (document.getElementById('coursepath_'+element).length) {
1880: numdirs = document.getElementById('coursepath_'+element).length;
1881: }
1.1402 raeburn 1882: if ((document.getElementById('hascrsres_'+element)) &&
1883: (document.getElementById('nocrsres_'+element))) {
1884: if (numdirs) {
1885: document.getElementById('hascrsres_'+element).style.display='inline-block';
1886: document.getElementById('nocrsres_'+element).style.display='none';
1887: } else {
1888: document.getElementById('hascrsres_'+element).style.display='none';
1889: document.getElementById('nocrsres_'+element).style.display='inline-block';
1890: }
1891: }
1.1248 raeburn 1892: form.elements['coursepath_'+element].selectedIndex = 0;
1893: if (numdirs > 1) {
1.1400 raeburn 1894: var selelem = form.elements['coursefile_'+element];
1895: var i, len = selelem.options.length -1;
1896: if (len >=0) {
1897: for (i = len; i >= 0; i--) {
1898: selelem.remove(i);
1899: }
1900: selelem.options[0] = new Option('','');
1901: }
1.1248 raeburn 1902: }
1903: }
1.1400 raeburn 1904: }
1.1248 raeburn 1905: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1906: }
1907: if (document.getElementById('chooser_'+element+'_upload')) {
1908: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1909: if (document.getElementById('uploadcrsres_'+element)) {
1910: document.getElementById('uploadcrsres_'+element).value = '';
1911: }
1912: }
1913: return;
1914: }
1915:
1.1400 raeburn 1916: function toggleCrsUpload(form,element) {
1.1248 raeburn 1917: if (document.getElementById('chooser_'+element+'_crsres')) {
1918: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1919: }
1920: if (document.getElementById('chooser_'+element+'_upload')) {
1921: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1922: if (curr == 'none') {
1.1400 raeburn 1923: form.elements['newsubdir_'+element][0].checked = true;
1924: toggleNewsubdir(form,element);
1925: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1926: if (document.getElementById('uploadcrsres_'+element)) {
1927: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1928: }
1929: }
1930: }
1931: return;
1932: }
1933:
1934: function toggleResImport(form,element) {
1935: var choices = new Array('crsres','upload');
1936: for (var i=0; i<choices.length; i++) {
1937: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1938: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1939: }
1940: }
1941: }
1942:
1943: function toggleNewsubdir(form,element) {
1944: var newsub = form.elements['newsubdir_'+element];
1945: if (newsub) {
1946: if (newsub.length) {
1947: for (var j=0; j<newsub.length; j++) {
1948: if (newsub[j].checked) {
1949: if (document.getElementById('newsubdirname_'+element)) {
1950: if (newsub[j].value == '1') {
1951: document.getElementById('newsubdirname_'+element).type = "text";
1952: if (document.getElementById('newsubdir_'+element)) {
1953: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1954: }
1955: } else {
1956: document.getElementById('newsubdirname_'+element).type = "hidden";
1957: document.getElementById('newsubdirname_'+element).value = "";
1958: document.getElementById('newsubdir_'+element).innerHTML = "";
1959: }
1960: }
1961: break;
1962: }
1963: }
1964: }
1965: }
1966: }
1967:
1968: function updateCrsFile(form,element) {
1969: var directory = form.elements['coursepath_'+element];
1970: var filename = form.elements['coursefile_'+element];
1971: var path = directory.options[directory.selectedIndex].value;
1972: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1973: if (file != '') {
1974: form.elements[element].value = '$respath';
1975: if (path == '/') {
1976: form.elements[element].value += file;
1977: } else {
1978: form.elements[element].value += path+'/'+file;
1979: }
1980: unClean();
1981: if (document.getElementById('previewimg_'+element)) {
1982: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1983: var newsrc = document.getElementById('previewimg_'+element).src;
1984: }
1985: if (document.getElementById('showimg_'+element)) {
1986: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1987: }
1.1248 raeburn 1988: }
1989: toggleChooser(form,element);
1990: return;
1991: }
1992:
1993: function uploadDone(suffix,name) {
1994: if (name) {
1995: document.forms["lonhomework"].elements[suffix].value = name;
1996: unClean();
1997: toggleChooser(document.forms["lonhomework"],suffix);
1998: }
1999: }
2000:
2001: \$(document).ready(function(){
2002:
2003: \$(document).delegate('form :submit', 'click', function( event ) {
2004: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2005: var buttonId = this.id;
2006: var suffix = buttonId.toString();
2007: suffix = suffix.replace(/^crsupload_/,'');
2008: event.preventDefault();
2009: document.lonhomework.target = 'crsupload_target_'+suffix;
2010: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2011: \$(this.form).submit();
2012: document.lonhomework.target = '';
2013: if (document.getElementById('crsuploadto_'+suffix)) {
2014: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2015: }
2016: return false;
2017: }
2018: });
2019: });
2020: END
2021: }
1.1205 golterma 2022: return <<"COLORFULEDIT"
2023: <script type="text/javascript">
2024: // <![CDATA[>
2025: function fold_box(curDepth, lastresource){
2026:
2027: // we need a list because there can be several blocks you need to fold in one tag
2028: var block = document.getElementsByName('foldblock_'+curDepth);
2029: // but there is only one folding button per tag
2030: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2031:
2032: if(block.item(0).style.display == 'none'){
2033:
2034: foldbutton.value = '@{[&mt("Hide")]}';
2035: for (i = 0; i < block.length; i++){
2036: block.item(i).style.display = '';
2037: }
2038: }else{
2039:
2040: foldbutton.value = '@{[&mt("Show")]}';
2041: for (i = 0; i < block.length; i++){
2042: // block.item(i).style.visibility = 'collapse';
2043: block.item(i).style.display = 'none';
2044: }
2045: };
2046: saveState(lastresource);
2047: }
2048:
2049: function saveState (lastresource) {
2050:
2051: var tag_list = getTagList();
2052: if(tag_list != null){
2053: var timestamp = new Date().getTime();
2054: var key = lastresource;
2055:
2056: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2057: // starting with timestamp
2058: var value = timestamp+';';
2059:
2060: // building the list of key-value pairs
2061: for(var i = 0; i < tag_list.length; i++){
2062: value += tag_list[i]+',';
2063: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2064: }
2065:
2066: // only iterate whole storage if nothing to override
2067: if(localStorage.getItem(key) == null){
2068:
2069: // prevent storage from growing large
2070: if(localStorage.length > 50){
2071: var regex_getTimestamp = /^(?:\d)+;/;
2072: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2073: var oldest_key;
2074:
2075: for(var i = 1; i < localStorage.length; i++){
2076: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2077: oldest_key = localStorage.key(i);
2078: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2079: }
2080: }
2081: localStorage.removeItem(oldest_key);
2082: }
2083: }
2084: localStorage.setItem(key,value);
2085: }
2086: }
2087:
2088: // restore folding status of blocks (on page load)
2089: function restoreState (lastresource) {
2090: if(localStorage.getItem(lastresource) != null){
2091: var key = lastresource;
2092: var value = localStorage.getItem(key);
2093: var regex_delTimestamp = /^\d+;/;
2094:
2095: value.replace(regex_delTimestamp, '');
2096:
2097: var valueArr = value.split(';');
2098: var pairs;
2099: var elements;
2100: for (var i = 0; i < valueArr.length; i++){
2101: pairs = valueArr[i].split(',');
2102: elements = document.getElementsByName(pairs[0]);
2103:
2104: for (var j = 0; j < elements.length; j++){
2105: elements[j].style.display = pairs[1];
2106: if (pairs[1] == "none"){
2107: var regex_id = /([_\\d]+)\$/;
2108: regex_id.exec(pairs[0]);
2109: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2110: }
2111: }
2112: }
2113: }
2114: }
2115:
2116: function getTagList () {
2117:
2118: var stringToSearch = document.lonhomework.innerHTML;
2119:
2120: var ret = new Array();
2121: var regex_findBlock = /(foldblock_.*?)"/g;
2122: var tag_list = stringToSearch.match(regex_findBlock);
2123:
2124: if(tag_list != null){
2125: for(var i = 0; i < tag_list.length; i++){
2126: ret.push(tag_list[i].replace(/"/, ''));
2127: }
2128: }
2129: return ret;
2130: }
2131:
2132: function saveScrollPosition (resource) {
2133: var tag_list = getTagList();
2134:
2135: // we dont always want to jump to the first block
2136: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2137: if(\$(window).scrollTop() > 170){
2138: if(tag_list != null){
2139: var result;
2140: for(var i = 0; i < tag_list.length; i++){
2141: if(isElementInViewport(tag_list[i])){
2142: result += tag_list[i]+';';
2143: }
2144: }
2145: sessionStorage.setItem('anchor_'+resource, result);
2146: }
2147: } else {
2148: // we dont need to save zero, just delete the item to leave everything tidy
2149: sessionStorage.removeItem('anchor_'+resource);
2150: }
2151: }
2152:
2153: function restoreScrollPosition(resource){
2154:
2155: var elem = sessionStorage.getItem('anchor_'+resource);
2156: if(elem != null){
2157: var tag_list = elem.split(';');
2158: var elem_list;
2159:
2160: for(var i = 0; i < tag_list.length; i++){
2161: elem_list = document.getElementsByName(tag_list[i]);
2162:
2163: if(elem_list.length > 0){
2164: elem = elem_list[0];
2165: break;
2166: }
2167: }
2168: elem.scrollIntoView();
2169: }
2170: }
2171:
2172: function isElementInViewport(el) {
2173:
2174: // change to last element instead of first
2175: var elem = document.getElementsByName(el);
2176: var rect = elem[0].getBoundingClientRect();
2177:
2178: return (
2179: rect.top >= 0 &&
2180: rect.left >= 0 &&
2181: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2182: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2183: );
2184: }
2185:
2186: function autosize(depth){
2187: var cmInst = window['cm'+depth];
2188: var fitsizeButton = document.getElementById('fitsize'+depth);
2189:
2190: // is fixed size, switching to dynamic
2191: if (sessionStorage.getItem("autosized_"+depth) == null) {
2192: cmInst.setSize("","auto");
2193: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2194: sessionStorage.setItem("autosized_"+depth, "yes");
2195:
2196: // is dynamic size, switching to fixed
2197: } else {
2198: cmInst.setSize("","300px");
2199: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2200: sessionStorage.removeItem("autosized_"+depth);
2201: }
2202: }
2203:
1.1248 raeburn 2204: $browse_or_search
1.1205 golterma 2205:
2206: // ]]>
2207: </script>
2208: COLORFULEDIT
2209: }
2210:
2211: sub xmleditor_js {
2212: return <<XMLEDIT
2213: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2214: <script type="text/javascript">
2215: // <![CDATA[>
2216:
2217: function saveScrollPosition (resource) {
2218:
2219: var scrollPos = \$(window).scrollTop();
2220: sessionStorage.setItem(resource,scrollPos);
2221: }
2222:
2223: function restoreScrollPosition(resource){
2224:
2225: var scrollPos = sessionStorage.getItem(resource);
2226: \$(window).scrollTop(scrollPos);
2227: }
2228:
2229: // unless internet explorer
2230: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2231:
2232: \$(document).ready(function() {
2233: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2234: });
2235: }
2236:
2237: // inserts text at cursor position into codemirror (xml editor only)
2238: function insertText(text){
2239: cm.focus();
2240: var curPos = cm.getCursor();
2241: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2242: }
2243: // ]]>
2244: </script>
2245: XMLEDIT
2246: }
2247:
2248: sub insert_folding_button {
2249: my $curDepth = $Apache::lonxml::curdepth;
2250: my $lastresource = $env{'request.ambiguous'};
2251:
2252: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2253: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2254: }
2255:
1.1248 raeburn 2256: sub crsauthor_url {
2257: my ($url) = @_;
2258: if ($url eq '') {
2259: $url = $ENV{'REQUEST_URI'};
2260: }
2261: my ($cnum,$cdom);
2262: if ($env{'request.course.id'}) {
2263: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2264: if ($audom ne '' && $auname ne '') {
2265: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2266: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2267: $cnum = $auname;
2268: $cdom = $audom;
2269: }
2270: }
2271: }
2272: return ($cnum,$cdom);
2273: }
2274:
2275: sub import_crsauthor_form {
1.1400 raeburn 2276: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2277: return (0) unless ($env{'request.course.id'});
2278: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2279: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2280: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2281: return (0) unless (($cnum ne '') && ($cdom ne ''));
2282: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2283: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2284:
1.1248 raeburn 2285: if (grep(/^\Q$crshome\E$/,@ids)) {
2286: $is_home = 1;
2287: }
1.1400 raeburn 2288: $toppath = "/priv/$cdom/$cnum";
2289: my $nonemptydir = 1;
2290: my $js_only;
2291: if ($only) {
2292: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2293: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2294: }
2295: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2296: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2297: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2298: my %lt = &Apache::lonlocal::texthash (
2299: fnam => 'Filename',
2300: dire => 'Directory',
1.1400 raeburn 2301: se => 'Select',
1.1248 raeburn 2302: );
1.1402 raeburn 2303: $output = $lt{'dire'}.': '.
1.1400 raeburn 2304: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2305: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2306: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2307: if ($files{'/'}) {
2308: $output .= '<option value="/">/</option>'."\n";
2309: }
1.1400 raeburn 2310: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2311: next if ($key eq '/');
1.1400 raeburn 2312: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2313: }
2314: $output .= '</select><br />'."\n".
1.1402 raeburn 2315: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2316: '<option value="" selected="selected"></option>'."\n".
1.1402 raeburn 2317: '</select>'."\n".
2318: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2319: return ($numdirs,$output);
2320: }
2321:
2322: sub show_crsfiles_js {
2323: my $excluderef = &Apache::lonnet::priv_exclude();
2324: my $se = &js_escape(&mt('Select'));
2325: my $exclude;
2326: if (ref($excluderef) eq 'HASH') {
2327: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2328: }
2329: my $js = <<"END";
2330:
2331:
1.1402 raeburn 2332: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2333: var relpath = '';
2334: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2335: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2336: if (currdir == '') {
2337: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2338: selelem = form.elements[filesel];
2339: var j, numfiles = selelem.options.length -1;
2340: if (numfiles >=0) {
2341: for (j = numfiles; j >= 0; j--) {
2342: selelem.remove(j);
2343: }
2344: }
2345: if (selelem.options.length == 0) {
2346: selelem.options[selelem.options.length] = new Option('','');
2347: selelem.selectedIndex = 0;
1.1248 raeburn 2348: }
2349: }
1.1400 raeburn 2350: return;
2351: } else {
2352: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2353: }
2354: }
1.1400 raeburn 2355: var http = new XMLHttpRequest();
2356: var url = "/adm/courseauthor";
2357: var crsrole = "$env{'request.role'}";
2358: var exclude = '';
2359: if (exc) {
2360: exclude = '$exclude';
2361: }
1.1402 raeburn 2362: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2363: http.open("POST", url, true);
2364: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2365: http.onreadystatechange = function() {
2366: if (http.readyState == 4 && http.status == 200) {
2367: var data = JSON.parse(http.responseText);
2368: var selelem;
2369: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2370: if (Array.isArray(data.dirs)) {
2371: selelem = form.elements[dirsel];
2372: var i, numdirs = selelem.options.length -1;
2373: if (numdirs >=0) {
2374: for (i = numdirs; i >= 0; i--) {
2375: selelem.remove(i);
2376: }
2377: }
2378: var len = data.dirs.length;
2379: if (len) {
1.1402 raeburn 2380: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2381: var j;
2382: for (j = 0; j < len; j++) {
2383: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2384: }
2385: selelem.selectedIndex = 0;
2386: }
2387: if (!setfile) {
2388: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2389: selelem = form.elements[filesel];
2390: var j, numfiles = selelem.options.length -1;
2391: if (numfiles >=0) {
2392: for (j = numfiles; j >= 0; j--) {
2393: selelem.remove(j);
2394: }
2395: }
2396: if (selelem.options.length == 0) {
2397: selelem.options[selelem.options.length] = new Option('','');
2398: selelem.selectedIndex = 0;
2399: }
2400: }
2401: }
2402: }
2403: }
2404: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2405: selelem = form.elements[filesel];
2406: var i, numfiles = selelem.options.length -1;
2407: if (numfiles >=0) {
2408: for (i = numfiles; i >= 0; i--) {
2409: selelem.remove(i);
2410: }
2411: }
2412: var x;
2413: for (x in data.files) {
2414: if (Array.isArray(data.files[x])) {
2415: if (data.files[x].length > 1) {
2416: selelem.options[selelem.options.length] = new Option('$se','');
2417: }
2418: var len = data.files[x].length;
2419: if (len) {
2420: var k;
2421: for (k = 0; k < len; k++) {
2422: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2423: }
2424: selelem.selectedIndex = 0;
2425: }
2426: }
2427: }
2428: if (selelem.options.length == 0) {
2429: selelem.options[selelem.options.length] = new Option('','');
2430: selelem.selectedIndex = 0;
2431: }
1.1248 raeburn 2432: }
2433: }
2434: }
1.1400 raeburn 2435: http.send(params);
1.1248 raeburn 2436: }
1.1400 raeburn 2437: END
1.1248 raeburn 2438: }
2439:
1.1426 raeburn 2440: sub crsauthor_rights {
2441: my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
2442: my $sourcerights = "$path/$rightsfile";
2443: my $now = time;
2444: if (!-e $sourcerights) {
2445: my $cid = $cdom.'_'.$cnum;
2446: if (!-e "$docroot/priv/$cdom") {
2447: mkdir("$docroot/priv/$cdom",0755);
2448: }
2449: if (!-e "$docroot/priv/$cdom/$cnum") {
2450: mkdir("$docroot/priv/$cdom/$cnum",0755);
2451: }
2452: if (open(my $fh,">$sourcerights")) {
2453: print $fh <<END;
2454: <accessrule effect="deny" realm="" type="course" role="" />
2455: <accessrule effect="allow" realm="$cid" type="course" role="" />
2456: END
2457: close($fh);
2458: }
2459: }
2460: if (!-e "$sourcerights.meta") {
2461: if (open(my $fh,">$sourcerights.meta")) {
2462: my $author=$env{'environment.firstname'}.' '.
2463: $env{'environment.middlename'}.' '.
2464: $env{'environment.lastname'}.' '.
2465: $env{'environment.generation'};
2466: $author =~ s/\s+$//;
2467: print $fh <<"END";
2468:
2469: <abstract></abstract>
2470: <author>$author</author>
2471: <authorspace>$cnum:$cdom</authorspace>
2472: <copyright>private</copyright>
2473: <creationdate>$now</creationdate>
2474: <customdistributionfile></customdistributionfile>
2475: <dependencies></dependencies>
2476: <domain>$cdom</domain>
2477: <highestgradelevel>0</highestgradelevel>
2478: <keywords></keywords>
2479: <language>notset </language>
2480: <lastrevisiondate>$now</lastrevisiondate>
2481: <lowestgradelevel>0</lowestgradelevel>
2482: <mime>rights</mime>
2483: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
2484: <notes></notes>
2485: <obsolete></obsolete>
2486: <obsoletereplacement></obsoletereplacement>
2487: <owner>$cnum:$cdom</owner>
2488: <rule>deny:::course,allow:$cid::course</rule>
2489: <sourceavail></sourceavail>
2490: <standards></standards>
2491: <subject></subject>
2492: <title>Course Authoring Rights</title>
2493: END
2494: close($fh);
2495: }
2496: }
2497: return;
2498: }
2499:
1.565 albertel 2500: =pod
2501:
1.1420 raeburn 2502: =item * &iframe_wrapper_headjs()
2503:
1.1425 raeburn 2504: emits javascript containing two global vars to facilitate handling of resizing
2505: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
2506: with standard LON-CAPA menus.
2507:
2508: =cut
2509:
1.1420 raeburn 2510: #
2511: # Where iframe is in use, if window.onload() executes before the custom resize function
2512: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
2513: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
2514: # do not obscure the Functions menu.
2515: #
2516:
2517: sub iframe_wrapper_headjs {
2518: return <<"ENDJS";
2519: <script type="text/javascript">
2520: // <![CDATA[
2521: var LCnotready = 0;
2522: var LCresizedef = 0;
2523: // ]]>
2524: </script>
2525:
2526: ENDJS
2527:
2528: }
2529:
2530: =pod
2531:
2532: =item * &iframe_wrapper_resizejs()
2533:
1.1425 raeburn 2534: emits javascript used to handle resizing for a page containing
2535: an iframe, to ensure that the iframe does not obscure any
2536: standard LON-CAPA menu items.
2537:
2538: =back
2539:
2540: =cut
2541:
1.1420 raeburn 2542: #
2543: # jQuery to use when iframe is in use and a page resize occurs.
2544: # This script will ensure that the iframe does not obscure any
2545: # standard LON-CAPA inline menus (primary, secondary, and/or
2546: # breadcrumbs and Functions menus. Expects javascript from
2547: # &iframe_wrapper_headjs() to be in head portion of the web page,
2548: # e.g., by inclusion in second arg passed to &start_page().
2549: #
2550:
2551: sub iframe_wrapper_resizejs {
2552: my $offset = 5;
2553: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
2554: if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
2555: $offset = 0;
2556: }
2557: return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
2558: \$(document).ready( function() {
2559: \$(window).unbind('resize').resize(function(){
2560: var header = null;
2561: var offset = $offset;
2562: var height = 0;
2563: var hdrtop = 0;
1.1421 raeburn 2564: if (\$('div.LC_menus_content:first').length) {
2565: if (\$('div.LC_menus_content:first').hasClass ("shown")) {
2566: header = \$('div.LC_menus_content:first');
1.1423 raeburn 2567: offset = 12;
1.1421 raeburn 2568: }
2569: } else if (\$('div.LC_head_subbox:first').length) {
1.1420 raeburn 2570: header = \$('div.LC_head_subbox:first');
2571: offset = 9;
2572: } else {
2573: if (\$('#LC_breadcrumbs').length) {
2574: header = \$('#LC_breadcrumbs');
2575: }
2576: }
2577: if (header != null && header.length) {
2578: height = header.height();
2579: hdrtop = header.position().top;
2580: }
2581: var pos = height + hdrtop + offset;
2582: \$('.LC_iframecontainer').css('top', pos);
2583: });
2584: LCresizedef = 1;
2585: if (LCnotready == 1) {
2586: LCnotready = 0;
2587: \$(window).trigger('resize');
2588: }
2589: });
2590: window.onload = function(){
2591: if (LCresizedef) {
2592: LCnotready = 0;
2593: \$(window).trigger('resize');
2594: } else {
2595: LCnotready = 1;
2596: }
2597: };
2598: SCRIPT
2599:
2600: }
2601:
2602: =pod
2603:
1.256 matthew 2604: =head1 Excel and CSV file utility routines
2605:
2606: =cut
2607:
2608: ###############################################################
2609: ###############################################################
2610:
2611: =pod
2612:
1.1162 raeburn 2613: =over 4
2614:
1.648 raeburn 2615: =item * &csv_translate($text)
1.37 matthew 2616:
1.185 www 2617: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2618: format.
2619:
2620: =cut
2621:
1.180 matthew 2622: ###############################################################
2623: ###############################################################
1.37 matthew 2624: sub csv_translate {
2625: my $text = shift;
2626: $text =~ s/\"/\"\"/g;
1.209 albertel 2627: $text =~ s/\n/ /g;
1.37 matthew 2628: return $text;
2629: }
1.180 matthew 2630:
2631: ###############################################################
2632: ###############################################################
2633:
2634: =pod
2635:
1.648 raeburn 2636: =item * &define_excel_formats()
1.180 matthew 2637:
2638: Define some commonly used Excel cell formats.
2639:
2640: Currently supported formats:
2641:
2642: =over 4
2643:
2644: =item header
2645:
2646: =item bold
2647:
2648: =item h1
2649:
2650: =item h2
2651:
2652: =item h3
2653:
1.256 matthew 2654: =item h4
2655:
2656: =item i
2657:
1.180 matthew 2658: =item date
2659:
2660: =back
2661:
2662: Inputs: $workbook
2663:
2664: Returns: $format, a hash reference.
2665:
1.1057 foxr 2666:
1.180 matthew 2667: =cut
2668:
2669: ###############################################################
2670: ###############################################################
2671: sub define_excel_formats {
2672: my ($workbook) = @_;
2673: my $format;
2674: $format->{'header'} = $workbook->add_format(bold => 1,
2675: bottom => 1,
2676: align => 'center');
2677: $format->{'bold'} = $workbook->add_format(bold=>1);
2678: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2679: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2680: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2681: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2682: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2683: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2684: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2685: return $format;
2686: }
2687:
2688: ###############################################################
2689: ###############################################################
1.113 bowersj2 2690:
2691: =pod
2692:
1.648 raeburn 2693: =item * &create_workbook()
1.255 matthew 2694:
2695: Create an Excel worksheet. If it fails, output message on the
2696: request object and return undefs.
2697:
2698: Inputs: Apache request object
2699:
2700: Returns (undef) on failure,
2701: Excel worksheet object, scalar with filename, and formats
2702: from &Apache::loncommon::define_excel_formats on success
2703:
2704: =cut
2705:
2706: ###############################################################
2707: ###############################################################
2708: sub create_workbook {
2709: my ($r) = @_;
2710: #
2711: # Create the excel spreadsheet
2712: my $filename = '/prtspool/'.
1.258 albertel 2713: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2714: time.'_'.rand(1000000000).'.xls';
2715: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2716: if (! defined($workbook)) {
2717: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2718: $r->print(
2719: '<p class="LC_error">'
2720: .&mt('Problems occurred in creating the new Excel file.')
2721: .' '.&mt('This error has been logged.')
2722: .' '.&mt('Please alert your LON-CAPA administrator.')
2723: .'</p>'
2724: );
1.255 matthew 2725: return (undef);
2726: }
2727: #
1.1014 foxr 2728: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2729: #
2730: my $format = &Apache::loncommon::define_excel_formats($workbook);
2731: return ($workbook,$filename,$format);
2732: }
2733:
2734: ###############################################################
2735: ###############################################################
2736:
2737: =pod
2738:
1.648 raeburn 2739: =item * &create_text_file()
1.113 bowersj2 2740:
1.542 raeburn 2741: Create a file to write to and eventually make available to the user.
1.256 matthew 2742: If file creation fails, outputs an error message on the request object and
2743: return undefs.
1.113 bowersj2 2744:
1.256 matthew 2745: Inputs: Apache request object, and file suffix
1.113 bowersj2 2746:
1.256 matthew 2747: Returns (undef) on failure,
2748: Filehandle and filename on success.
1.113 bowersj2 2749:
2750: =cut
2751:
1.256 matthew 2752: ###############################################################
2753: ###############################################################
2754: sub create_text_file {
2755: my ($r,$suffix) = @_;
2756: if (! defined($suffix)) { $suffix = 'txt'; };
2757: my $fh;
2758: my $filename = '/prtspool/'.
1.258 albertel 2759: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2760: time.'_'.rand(1000000000).'.'.$suffix;
2761: $fh = Apache::File->new('>/home/httpd'.$filename);
2762: if (! defined($fh)) {
2763: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2764: $r->print(
2765: '<p class="LC_error">'
2766: .&mt('Problems occurred in creating the output file.')
2767: .' '.&mt('This error has been logged.')
2768: .' '.&mt('Please alert your LON-CAPA administrator.')
2769: .'</p>'
2770: );
1.113 bowersj2 2771: }
1.256 matthew 2772: return ($fh,$filename)
1.113 bowersj2 2773: }
2774:
2775:
1.256 matthew 2776: =pod
1.113 bowersj2 2777:
2778: =back
2779:
2780: =cut
1.37 matthew 2781:
2782: ###############################################################
1.33 matthew 2783: ## Home server <option> list generating code ##
2784: ###############################################################
1.35 matthew 2785:
1.169 www 2786: # ------------------------------------------
2787:
2788: sub domain_select {
1.1289 raeburn 2789: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2790: my @possdoms;
2791: if (ref($incdoms) eq 'ARRAY') {
2792: @possdoms = @{$incdoms};
2793: } else {
2794: @possdoms = &Apache::lonnet::all_domains();
2795: }
2796:
1.169 www 2797: my %domains=map {
1.514 albertel 2798: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2799: } @possdoms;
2800:
2801: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2802: foreach my $dom (@{$excdoms}) {
2803: delete($domains{$dom});
2804: }
2805: }
2806:
1.169 www 2807: if ($multiple) {
2808: $domains{''}=&mt('Any domain');
1.550 albertel 2809: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2810: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2811: } else {
1.550 albertel 2812: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2813: return &select_form($name,$value,\%domains);
1.169 www 2814: }
2815: }
2816:
1.282 albertel 2817: #-------------------------------------------
2818:
2819: =pod
2820:
1.519 raeburn 2821: =head1 Routines for form select boxes
2822:
2823: =over 4
2824:
1.648 raeburn 2825: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2826:
2827: Returns a string containing a <select> element int multiple mode
2828:
2829:
2830: Args:
2831: $name - name of the <select> element
1.506 raeburn 2832: $value - scalar or array ref of values that should already be selected
1.282 albertel 2833: $size - number of rows long the select element is
1.283 albertel 2834: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2835: (shown text should already have been &mt())
1.506 raeburn 2836: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2837:
1.282 albertel 2838: =cut
2839:
2840: #-------------------------------------------
1.169 www 2841: sub multiple_select_form {
1.284 albertel 2842: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2843: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2844: my $output='';
1.191 matthew 2845: if (! defined($size)) {
2846: $size = 4;
1.283 albertel 2847: if (scalar(keys(%$hash))<4) {
2848: $size = scalar(keys(%$hash));
1.191 matthew 2849: }
2850: }
1.734 bisitz 2851: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2852: my @order;
1.506 raeburn 2853: if (ref($order) eq 'ARRAY') {
2854: @order = @{$order};
2855: } else {
2856: @order = sort(keys(%$hash));
1.501 banghart 2857: }
2858: if (exists($$hash{'select_form_order'})) {
2859: @order = @{$$hash{'select_form_order'}};
2860: }
2861:
1.284 albertel 2862: foreach my $key (@order) {
1.356 albertel 2863: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2864: $output.='selected="selected" ' if ($selected{$key});
2865: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2866: }
2867: $output.="</select>\n";
2868: return $output;
2869: }
2870:
1.88 www 2871: #-------------------------------------------
2872:
2873: =pod
2874:
1.1254 raeburn 2875: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2876:
2877: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2878: allow a user to select options from a ref to a hash containing:
2879: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2880: a javascript onchange item, e.g., onchange="this.form.submit();".
2881: An optional arg -- $readonly -- if true will cause the select form
2882: to be disabled, e.g., for the case where an instructor has a section-
2883: specific role, and is viewing/modifying parameters.
1.970 raeburn 2884:
1.88 www 2885: See lonrights.pm for an example invocation and use.
2886:
2887: =cut
2888:
2889: #-------------------------------------------
2890: sub select_form {
1.1228 raeburn 2891: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2892: return unless (ref($hashref) eq 'HASH');
2893: if ($onchange) {
2894: $onchange = ' onchange="'.$onchange.'"';
2895: }
1.1228 raeburn 2896: my $disabled;
2897: if ($readonly) {
2898: $disabled = ' disabled="disabled"';
2899: }
2900: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2901: my @keys;
1.970 raeburn 2902: if (exists($hashref->{'select_form_order'})) {
2903: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2904: } else {
1.970 raeburn 2905: @keys=sort(keys(%{$hashref}));
1.128 albertel 2906: }
1.356 albertel 2907: foreach my $key (@keys) {
2908: $selectform.=
2909: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2910: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2911: ">".$hashref->{$key}."</option>\n";
1.88 www 2912: }
2913: $selectform.="</select>";
2914: return $selectform;
2915: }
2916:
1.475 www 2917: # For display filters
2918:
2919: sub display_filter {
1.1074 raeburn 2920: my ($context) = @_;
1.475 www 2921: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2922: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2923: my $phraseinput = 'hidden';
2924: my $includeinput = 'hidden';
2925: my ($checked,$includetypestext);
2926: if ($env{'form.displayfilter'} eq 'containing') {
2927: $phraseinput = 'text';
2928: if ($context eq 'parmslog') {
2929: $includeinput = 'checkbox';
2930: if ($env{'form.includetypes'}) {
2931: $checked = ' checked="checked"';
2932: }
2933: $includetypestext = &mt('Include parameter types');
2934: }
2935: } else {
2936: $includetypestext = ' ';
2937: }
2938: my ($additional,$secondid,$thirdid);
2939: if ($context eq 'parmslog') {
2940: $additional =
2941: '<label><input type="'.$includeinput.'" name="includetypes"'.
2942: $checked.' name="includetypes" value="1" id="includetypes" />'.
2943: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2944: '</label>';
2945: $secondid = 'includetypes';
2946: $thirdid = 'includetypestext';
2947: }
2948: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2949: '$secondid','$thirdid')";
2950: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2951: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2952: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2953: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2954: &mt('Filter: [_1]',
1.477 www 2955: &select_form($env{'form.displayfilter'},
2956: 'displayfilter',
1.970 raeburn 2957: {'currentfolder' => 'Current folder/page',
1.477 www 2958: 'containing' => 'Containing phrase',
1.1074 raeburn 2959: 'none' => 'None'},$onchange)).' '.
2960: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2961: &HTML::Entities::encode($env{'form.containingphrase'}).
2962: '" />'.$additional;
2963: }
2964:
2965: sub display_filter_js {
2966: my $includetext = &mt('Include parameter types');
2967: return <<"ENDJS";
2968:
2969: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2970: var firstType = 'hidden';
2971: if (setter.options[setter.selectedIndex].value == 'containing') {
2972: firstType = 'text';
2973: }
2974: firstObject = document.getElementById(firstid);
2975: if (typeof(firstObject) == 'object') {
2976: if (firstObject.type != firstType) {
2977: changeInputType(firstObject,firstType);
2978: }
2979: }
2980: if (context == 'parmslog') {
2981: var secondType = 'hidden';
2982: if (firstType == 'text') {
2983: secondType = 'checkbox';
2984: }
2985: secondObject = document.getElementById(secondid);
2986: if (typeof(secondObject) == 'object') {
2987: if (secondObject.type != secondType) {
2988: changeInputType(secondObject,secondType);
2989: }
2990: }
2991: var textItem = document.getElementById(thirdid);
2992: var currtext = textItem.innerHTML;
2993: var newtext;
2994: if (firstType == 'text') {
2995: newtext = '$includetext';
2996: } else {
2997: newtext = ' ';
2998: }
2999: if (currtext != newtext) {
3000: textItem.innerHTML = newtext;
3001: }
3002: }
3003: return;
3004: }
3005:
3006: function changeInputType(oldObject,newType) {
3007: var newObject = document.createElement('input');
3008: newObject.type = newType;
3009: if (oldObject.size) {
3010: newObject.size = oldObject.size;
3011: }
3012: if (oldObject.value) {
3013: newObject.value = oldObject.value;
3014: }
3015: if (oldObject.name) {
3016: newObject.name = oldObject.name;
3017: }
3018: if (oldObject.id) {
3019: newObject.id = oldObject.id;
3020: }
3021: oldObject.parentNode.replaceChild(newObject,oldObject);
3022: return;
3023: }
3024:
3025: ENDJS
1.475 www 3026: }
3027:
1.167 www 3028: sub gradeleveldescription {
3029: my $gradelevel=shift;
3030: my %gradelevels=(0 => 'Not specified',
3031: 1 => 'Grade 1',
3032: 2 => 'Grade 2',
3033: 3 => 'Grade 3',
3034: 4 => 'Grade 4',
3035: 5 => 'Grade 5',
3036: 6 => 'Grade 6',
3037: 7 => 'Grade 7',
3038: 8 => 'Grade 8',
3039: 9 => 'Grade 9',
3040: 10 => 'Grade 10',
3041: 11 => 'Grade 11',
3042: 12 => 'Grade 12',
3043: 13 => 'Grade 13',
3044: 14 => '100 Level',
3045: 15 => '200 Level',
3046: 16 => '300 Level',
3047: 17 => '400 Level',
3048: 18 => 'Graduate Level');
3049: return &mt($gradelevels{$gradelevel});
3050: }
3051:
1.163 www 3052: sub select_level_form {
3053: my ($deflevel,$name)=@_;
3054: unless ($deflevel) { $deflevel=0; }
1.167 www 3055: my $selectform = "<select name=\"$name\" size=\"1\">\n";
3056: for (my $i=0; $i<=18; $i++) {
3057: $selectform.="<option value=\"$i\" ".
1.253 albertel 3058: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 3059: ">".&gradeleveldescription($i)."</option>\n";
3060: }
3061: $selectform.="</select>";
3062: return $selectform;
1.163 www 3063: }
1.167 www 3064:
1.35 matthew 3065: #-------------------------------------------
3066:
1.45 matthew 3067: =pod
3068:
1.1256 raeburn 3069: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 3070:
3071: Returns a string containing a <select name='$name' size='1'> form to
3072: allow a user to select the domain to preform an operation in.
3073: See loncreateuser.pm for an example invocation and use.
3074:
1.90 www 3075: If the $includeempty flag is set, it also includes an empty choice ("no domain
3076: selected");
3077:
1.743 raeburn 3078: If the $showdomdesc flag is set, the domain name is followed by the domain description.
3079:
1.910 raeburn 3080: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
3081:
1.1121 raeburn 3082: The optional $incdoms is a reference to an array of domains which will be the only available options.
3083:
3084: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 3085:
1.1256 raeburn 3086: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
3087:
1.35 matthew 3088: =cut
3089:
3090: #-------------------------------------------
1.34 matthew 3091: sub select_dom_form {
1.1256 raeburn 3092: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 3093: if ($onchange) {
1.874 raeburn 3094: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 3095: }
1.1256 raeburn 3096: if ($disabled) {
3097: $disabled = ' disabled="disabled"';
3098: }
1.1121 raeburn 3099: my (@domains,%exclude);
1.910 raeburn 3100: if (ref($incdoms) eq 'ARRAY') {
3101: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
3102: } else {
3103: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
3104: }
1.90 www 3105: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 3106: if (ref($excdoms) eq 'ARRAY') {
3107: map { $exclude{$_} = 1; } @{$excdoms};
3108: }
1.1256 raeburn 3109: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 3110: foreach my $dom (@domains) {
1.1121 raeburn 3111: next if ($exclude{$dom});
1.356 albertel 3112: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 3113: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
3114: if ($showdomdesc) {
3115: if ($dom ne '') {
3116: my $domdesc = &Apache::lonnet::domain($dom,'description');
3117: if ($domdesc ne '') {
3118: $selectdomain .= ' ('.$domdesc.')';
3119: }
3120: }
3121: }
3122: $selectdomain .= "</option>\n";
1.34 matthew 3123: }
3124: $selectdomain.="</select>";
3125: return $selectdomain;
3126: }
3127:
1.35 matthew 3128: #-------------------------------------------
3129:
1.45 matthew 3130: =pod
3131:
1.648 raeburn 3132: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 3133:
1.586 raeburn 3134: input: 4 arguments (two required, two optional) -
3135: $domain - domain of new user
3136: $name - name of form element
3137: $default - Value of 'default' causes a default item to be first
3138: option, and selected by default.
3139: $hide - Value of 'hide' causes hiding of the name of the server,
3140: if 1 server found, or default, if 0 found.
1.594 raeburn 3141: output: returns 2 items:
1.586 raeburn 3142: (a) form element which contains either:
3143: (i) <select name="$name">
3144: <option value="$hostid1">$hostid $servers{$hostid}</option>
3145: <option value="$hostid2">$hostid $servers{$hostid}</option>
3146: </select>
3147: form item if there are multiple library servers in $domain, or
3148: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
3149: if there is only one library server in $domain.
3150:
3151: (b) number of library servers found.
3152:
3153: See loncreateuser.pm for example of use.
1.35 matthew 3154:
3155: =cut
3156:
3157: #-------------------------------------------
1.586 raeburn 3158: sub home_server_form_item {
3159: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 3160: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 3161: my $result;
3162: my $numlib = keys(%servers);
3163: if ($numlib > 1) {
3164: $result .= '<select name="'.$name.'" />'."\n";
3165: if ($default) {
1.804 bisitz 3166: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3167: '</option>'."\n";
3168: }
3169: foreach my $hostid (sort(keys(%servers))) {
3170: $result.= '<option value="'.$hostid.'">'.
3171: $hostid.' '.$servers{$hostid}."</option>\n";
3172: }
3173: $result .= '</select>'."\n";
3174: } elsif ($numlib == 1) {
3175: my $hostid;
3176: foreach my $item (keys(%servers)) {
3177: $hostid = $item;
3178: }
3179: $result .= '<input type="hidden" name="'.$name.'" value="'.
3180: $hostid.'" />';
3181: if (!$hide) {
3182: $result .= $hostid.' '.$servers{$hostid};
3183: }
3184: $result .= "\n";
3185: } elsif ($default) {
3186: $result .= '<input type="hidden" name="'.$name.
3187: '" value="default" />';
3188: if (!$hide) {
3189: $result .= &mt('default');
3190: }
3191: $result .= "\n";
1.33 matthew 3192: }
1.586 raeburn 3193: return ($result,$numlib);
1.33 matthew 3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.534 albertel 3198: =back
3199:
1.112 bowersj2 3200: =cut
1.87 matthew 3201:
3202: ###############################################################
1.112 bowersj2 3203: ## Decoding User Agent ##
1.87 matthew 3204: ###############################################################
3205:
3206: =pod
3207:
1.112 bowersj2 3208: =head1 Decoding the User Agent
3209:
3210: =over 4
3211:
3212: =item * &decode_user_agent()
1.87 matthew 3213:
3214: Inputs: $r
3215:
3216: Outputs:
3217:
3218: =over 4
3219:
1.112 bowersj2 3220: =item * $httpbrowser
1.87 matthew 3221:
1.112 bowersj2 3222: =item * $clientbrowser
1.87 matthew 3223:
1.112 bowersj2 3224: =item * $clientversion
1.87 matthew 3225:
1.112 bowersj2 3226: =item * $clientmathml
1.87 matthew 3227:
1.112 bowersj2 3228: =item * $clientunicode
1.87 matthew 3229:
1.112 bowersj2 3230: =item * $clientos
1.87 matthew 3231:
1.1137 raeburn 3232: =item * $clientmobile
3233:
1.1141 raeburn 3234: =item * $clientinfo
3235:
1.1194 raeburn 3236: =item * $clientosversion
3237:
1.87 matthew 3238: =back
3239:
1.157 matthew 3240: =back
3241:
1.87 matthew 3242: =cut
3243:
3244: ###############################################################
3245: ###############################################################
3246: sub decode_user_agent {
1.247 albertel 3247: my ($r)=@_;
1.87 matthew 3248: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3249: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3250: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3251: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3252: my $clientbrowser='unknown';
3253: my $clientversion='0';
3254: my $clientmathml='';
3255: my $clientunicode='0';
1.1137 raeburn 3256: my $clientmobile=0;
1.1194 raeburn 3257: my $clientosversion='';
1.87 matthew 3258: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3259: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3260: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3261: $clientbrowser=$bname;
3262: $httpbrowser=~/$vreg/i;
3263: $clientversion=$1;
3264: $clientmathml=($clientversion>=$minv);
3265: $clientunicode=($clientversion>=$univ);
3266: }
3267: }
3268: my $clientos='unknown';
1.1141 raeburn 3269: my $clientinfo;
1.87 matthew 3270: if (($httpbrowser=~/linux/i) ||
3271: ($httpbrowser=~/unix/i) ||
3272: ($httpbrowser=~/ux/i) ||
3273: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3274: if (($httpbrowser=~/vax/i) ||
3275: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3276: if ($httpbrowser=~/next/i) { $clientos='next'; }
3277: if (($httpbrowser=~/mac/i) ||
3278: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3279: if ($httpbrowser=~/win/i) {
3280: $clientos='win';
3281: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3282: $clientosversion = $1;
3283: }
3284: }
1.87 matthew 3285: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3286: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3287: $clientmobile=lc($1);
3288: }
1.1141 raeburn 3289: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3290: $clientinfo = 'firefox-'.$1;
3291: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3292: $clientinfo = 'chromeframe-'.$1;
3293: }
1.87 matthew 3294: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3295: $clientunicode,$clientos,$clientmobile,$clientinfo,
3296: $clientosversion);
1.87 matthew 3297: }
3298:
1.32 matthew 3299: ###############################################################
3300: ## Authentication changing form generation subroutines ##
3301: ###############################################################
3302: ##
3303: ## All of the authform_xxxxxxx subroutines take their inputs in a
3304: ## hash, and have reasonable default values.
3305: ##
3306: ## formname = the name given in the <form> tag.
1.35 matthew 3307: #-------------------------------------------
3308:
1.45 matthew 3309: =pod
3310:
1.112 bowersj2 3311: =head1 Authentication Routines
3312:
3313: =over 4
3314:
1.648 raeburn 3315: =item * &authform_xxxxxx()
1.35 matthew 3316:
3317: The authform_xxxxxx subroutines provide javascript and html forms which
3318: handle some of the conveniences required for authentication forms.
3319: This is not an optimal method, but it works.
3320:
3321: =over 4
3322:
1.112 bowersj2 3323: =item * authform_header
1.35 matthew 3324:
1.112 bowersj2 3325: =item * authform_authorwarning
1.35 matthew 3326:
1.112 bowersj2 3327: =item * authform_nochange
1.35 matthew 3328:
1.112 bowersj2 3329: =item * authform_kerberos
1.35 matthew 3330:
1.112 bowersj2 3331: =item * authform_internal
1.35 matthew 3332:
1.112 bowersj2 3333: =item * authform_filesystem
1.35 matthew 3334:
1.1310 raeburn 3335: =item * authform_lti
3336:
1.35 matthew 3337: =back
3338:
1.648 raeburn 3339: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3340:
1.35 matthew 3341: =cut
3342:
3343: #-------------------------------------------
1.32 matthew 3344: sub authform_header{
3345: my %in = (
3346: formname => 'cu',
1.80 albertel 3347: kerb_def_dom => '',
1.32 matthew 3348: @_,
3349: );
3350: $in{'formname'} = 'document.' . $in{'formname'};
3351: my $result='';
1.80 albertel 3352:
3353: #---------------------------------------------- Code for upper case translation
3354: my $Javascript_toUpperCase;
3355: unless ($in{kerb_def_dom}) {
3356: $Javascript_toUpperCase =<<"END";
3357: switch (choice) {
3358: case 'krb': currentform.elements[choicearg].value =
3359: currentform.elements[choicearg].value.toUpperCase();
3360: break;
3361: default:
3362: }
3363: END
3364: } else {
3365: $Javascript_toUpperCase = "";
3366: }
3367:
1.165 raeburn 3368: my $radioval = "'nochange'";
1.591 raeburn 3369: if (defined($in{'curr_authtype'})) {
3370: if ($in{'curr_authtype'} ne '') {
3371: $radioval = "'".$in{'curr_authtype'}."arg'";
3372: }
1.174 matthew 3373: }
1.165 raeburn 3374: my $argfield = 'null';
1.591 raeburn 3375: if (defined($in{'mode'})) {
1.165 raeburn 3376: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3377: if (defined($in{'curr_autharg'})) {
3378: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3379: $argfield = "'$in{'curr_autharg'}'";
3380: }
3381: }
3382: }
3383: }
3384:
1.32 matthew 3385: $result.=<<"END";
3386: var current = new Object();
1.165 raeburn 3387: current.radiovalue = $radioval;
3388: current.argfield = $argfield;
1.32 matthew 3389:
3390: function changed_radio(choice,currentform) {
3391: var choicearg = choice + 'arg';
3392: // If a radio button in changed, we need to change the argfield
3393: if (current.radiovalue != choice) {
3394: current.radiovalue = choice;
3395: if (current.argfield != null) {
3396: currentform.elements[current.argfield].value = '';
3397: }
3398: if (choice == 'nochange') {
3399: current.argfield = null;
3400: } else {
3401: current.argfield = choicearg;
3402: switch(choice) {
3403: case 'krb':
3404: currentform.elements[current.argfield].value =
3405: "$in{'kerb_def_dom'}";
3406: break;
3407: default:
3408: break;
3409: }
3410: }
3411: }
3412: return;
3413: }
1.22 www 3414:
1.32 matthew 3415: function changed_text(choice,currentform) {
3416: var choicearg = choice + 'arg';
3417: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3418: $Javascript_toUpperCase
1.32 matthew 3419: // clear old field
3420: if ((current.argfield != choicearg) && (current.argfield != null)) {
3421: currentform.elements[current.argfield].value = '';
3422: }
3423: current.argfield = choicearg;
3424: }
3425: set_auth_radio_buttons(choice,currentform);
3426: return;
1.20 www 3427: }
1.32 matthew 3428:
3429: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3430: var numauthchoices = currentform.login.length;
3431: if (typeof numauthchoices == "undefined") {
3432: return;
3433: }
1.32 matthew 3434: var i=0;
1.986 raeburn 3435: while (i < numauthchoices) {
1.32 matthew 3436: if (currentform.login[i].value == newvalue) { break; }
3437: i++;
3438: }
1.986 raeburn 3439: if (i == numauthchoices) {
1.32 matthew 3440: return;
3441: }
3442: current.radiovalue = newvalue;
3443: currentform.login[i].checked = true;
3444: return;
3445: }
3446: END
3447: return $result;
3448: }
3449:
1.1106 raeburn 3450: sub authform_authorwarning {
1.32 matthew 3451: my $result='';
1.144 matthew 3452: $result='<i>'.
3453: &mt('As a general rule, only authors or co-authors should be '.
3454: 'filesystem authenticated '.
3455: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3456: return $result;
3457: }
3458:
1.1106 raeburn 3459: sub authform_nochange {
1.32 matthew 3460: my %in = (
3461: formname => 'document.cu',
3462: kerb_def_dom => 'MSU.EDU',
3463: @_,
3464: );
1.1106 raeburn 3465: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3466: my $result;
1.1104 raeburn 3467: if (!$authnum) {
1.1105 raeburn 3468: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3469: } else {
3470: $result = '<label>'.&mt('[_1] Do not change login data',
3471: '<input type="radio" name="login" value="nochange" '.
3472: 'checked="checked" onclick="'.
1.281 albertel 3473: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3474: '</label>';
1.586 raeburn 3475: }
1.32 matthew 3476: return $result;
3477: }
3478:
1.591 raeburn 3479: sub authform_kerberos {
1.32 matthew 3480: my %in = (
3481: formname => 'document.cu',
3482: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3483: kerb_def_auth => 'krb4',
1.32 matthew 3484: @_,
3485: );
1.586 raeburn 3486: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3487: $autharg,$jscall,$disabled);
1.1106 raeburn 3488: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3489: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3490: $check5 = ' checked="checked"';
1.80 albertel 3491: } else {
1.772 bisitz 3492: $check4 = ' checked="checked"';
1.80 albertel 3493: }
1.1259 raeburn 3494: if ($in{'readonly'}) {
3495: $disabled = ' disabled="disabled"';
3496: }
1.165 raeburn 3497: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3498: if (defined($in{'curr_authtype'})) {
3499: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3500: $krbcheck = ' checked="checked"';
1.623 raeburn 3501: if (defined($in{'mode'})) {
3502: if ($in{'mode'} eq 'modifyuser') {
3503: $krbcheck = '';
3504: }
3505: }
1.591 raeburn 3506: if (defined($in{'curr_kerb_ver'})) {
3507: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3508: $check5 = ' checked="checked"';
1.591 raeburn 3509: $check4 = '';
3510: } else {
1.772 bisitz 3511: $check4 = ' checked="checked"';
1.591 raeburn 3512: $check5 = '';
3513: }
1.586 raeburn 3514: }
1.591 raeburn 3515: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3516: $krbarg = $in{'curr_autharg'};
3517: }
1.586 raeburn 3518: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3519: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3520: $result =
3521: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3522: $in{'curr_autharg'},$krbver);
3523: } else {
3524: $result =
3525: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3526: }
3527: return $result;
3528: }
3529: }
3530: } else {
3531: if ($authnum == 1) {
1.784 bisitz 3532: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3533: }
3534: }
1.586 raeburn 3535: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3536: return;
1.587 raeburn 3537: } elsif ($authtype eq '') {
1.591 raeburn 3538: if (defined($in{'mode'})) {
1.587 raeburn 3539: if ($in{'mode'} eq 'modifycourse') {
3540: if ($authnum == 1) {
1.1259 raeburn 3541: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3542: }
3543: }
3544: }
1.586 raeburn 3545: }
3546: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3547: if ($authtype eq '') {
3548: $authtype = '<input type="radio" name="login" value="krb" '.
3549: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3550: $krbcheck.$disabled.' />';
1.586 raeburn 3551: }
3552: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3553: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3554: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3555: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3556: $in{'curr_authtype'} eq 'krb4')) {
3557: $result .= &mt
1.144 matthew 3558: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3559: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3560: '<label>'.$authtype,
1.281 albertel 3561: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3562: 'value="'.$krbarg.'" '.
1.1259 raeburn 3563: 'onchange="'.$jscall.'"'.$disabled.' />',
3564: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3565: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3566: '</label>');
1.586 raeburn 3567: } elsif ($can_assign{'krb4'}) {
3568: $result .= &mt
3569: ('[_1] Kerberos authenticated with domain [_2] '.
3570: '[_3] Version 4 [_4]',
3571: '<label>'.$authtype,
3572: '</label><input type="text" size="10" name="krbarg" '.
3573: 'value="'.$krbarg.'" '.
1.1259 raeburn 3574: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3575: '<label><input type="hidden" name="krbver" value="4" />',
3576: '</label>');
3577: } elsif ($can_assign{'krb5'}) {
3578: $result .= &mt
3579: ('[_1] Kerberos authenticated with domain [_2] '.
3580: '[_3] Version 5 [_4]',
3581: '<label>'.$authtype,
3582: '</label><input type="text" size="10" name="krbarg" '.
3583: 'value="'.$krbarg.'" '.
1.1259 raeburn 3584: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3585: '<label><input type="hidden" name="krbver" value="5" />',
3586: '</label>');
3587: }
1.32 matthew 3588: return $result;
3589: }
3590:
1.1106 raeburn 3591: sub authform_internal {
1.586 raeburn 3592: my %in = (
1.32 matthew 3593: formname => 'document.cu',
3594: kerb_def_dom => 'MSU.EDU',
3595: @_,
3596: );
1.1259 raeburn 3597: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3598: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3599: if ($in{'readonly'}) {
3600: $disabled = ' disabled="disabled"';
3601: }
1.591 raeburn 3602: if (defined($in{'curr_authtype'})) {
3603: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3604: if ($can_assign{'int'}) {
1.772 bisitz 3605: $intcheck = 'checked="checked" ';
1.623 raeburn 3606: if (defined($in{'mode'})) {
3607: if ($in{'mode'} eq 'modifyuser') {
3608: $intcheck = '';
3609: }
3610: }
1.591 raeburn 3611: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3612: $intarg = $in{'curr_autharg'};
3613: }
3614: } else {
3615: $result = &mt('Currently internally authenticated.');
3616: return $result;
1.165 raeburn 3617: }
3618: }
1.586 raeburn 3619: } else {
3620: if ($authnum == 1) {
1.784 bisitz 3621: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3622: }
3623: }
3624: if (!$can_assign{'int'}) {
3625: return;
1.587 raeburn 3626: } elsif ($authtype eq '') {
1.591 raeburn 3627: if (defined($in{'mode'})) {
1.587 raeburn 3628: if ($in{'mode'} eq 'modifycourse') {
3629: if ($authnum == 1) {
1.1259 raeburn 3630: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3631: }
3632: }
3633: }
1.165 raeburn 3634: }
1.586 raeburn 3635: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3636: if ($authtype eq '') {
3637: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3638: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3639: }
1.605 bisitz 3640: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3641: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3642: $result = &mt
1.144 matthew 3643: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3644: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3645: $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32 matthew 3646: return $result;
3647: }
3648:
1.1104 raeburn 3649: sub authform_local {
1.32 matthew 3650: my %in = (
3651: formname => 'document.cu',
3652: kerb_def_dom => 'MSU.EDU',
3653: @_,
3654: );
1.1259 raeburn 3655: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3656: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3657: if ($in{'readonly'}) {
3658: $disabled = ' disabled="disabled"';
3659: }
1.591 raeburn 3660: if (defined($in{'curr_authtype'})) {
3661: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3662: if ($can_assign{'loc'}) {
1.772 bisitz 3663: $loccheck = 'checked="checked" ';
1.623 raeburn 3664: if (defined($in{'mode'})) {
3665: if ($in{'mode'} eq 'modifyuser') {
3666: $loccheck = '';
3667: }
3668: }
1.591 raeburn 3669: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3670: $locarg = $in{'curr_autharg'};
3671: }
3672: } else {
3673: $result = &mt('Currently using local (institutional) authentication.');
3674: return $result;
1.165 raeburn 3675: }
3676: }
1.586 raeburn 3677: } else {
3678: if ($authnum == 1) {
1.784 bisitz 3679: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3680: }
3681: }
3682: if (!$can_assign{'loc'}) {
3683: return;
1.587 raeburn 3684: } elsif ($authtype eq '') {
1.591 raeburn 3685: if (defined($in{'mode'})) {
1.587 raeburn 3686: if ($in{'mode'} eq 'modifycourse') {
3687: if ($authnum == 1) {
1.1259 raeburn 3688: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3689: }
3690: }
3691: }
1.165 raeburn 3692: }
1.586 raeburn 3693: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3694: if ($authtype eq '') {
3695: $authtype = '<input type="radio" name="login" value="loc" '.
3696: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3697: $jscall.'"'.$disabled.' />';
1.586 raeburn 3698: }
3699: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3700: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3701: $result = &mt('[_1] Local Authentication with argument [_2]',
3702: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3703: return $result;
3704: }
3705:
1.1106 raeburn 3706: sub authform_filesystem {
1.32 matthew 3707: my %in = (
3708: formname => 'document.cu',
3709: kerb_def_dom => 'MSU.EDU',
3710: @_,
3711: );
1.1259 raeburn 3712: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3713: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3714: if ($in{'readonly'}) {
3715: $disabled = ' disabled="disabled"';
3716: }
1.591 raeburn 3717: if (defined($in{'curr_authtype'})) {
3718: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3719: if ($can_assign{'fsys'}) {
1.772 bisitz 3720: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3721: if (defined($in{'mode'})) {
3722: if ($in{'mode'} eq 'modifyuser') {
3723: $fsyscheck = '';
3724: }
3725: }
1.586 raeburn 3726: } else {
3727: $result = &mt('Currently Filesystem Authenticated.');
3728: return $result;
1.1259 raeburn 3729: }
1.586 raeburn 3730: }
3731: } else {
3732: if ($authnum == 1) {
1.784 bisitz 3733: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3734: }
3735: }
3736: if (!$can_assign{'fsys'}) {
3737: return;
1.587 raeburn 3738: } elsif ($authtype eq '') {
1.591 raeburn 3739: if (defined($in{'mode'})) {
1.587 raeburn 3740: if ($in{'mode'} eq 'modifycourse') {
3741: if ($authnum == 1) {
1.1259 raeburn 3742: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3743: }
3744: }
3745: }
1.586 raeburn 3746: }
3747: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3748: if ($authtype eq '') {
3749: $authtype = '<input type="radio" name="login" value="fsys" '.
3750: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3751: $jscall.'"'.$disabled.' />';
1.586 raeburn 3752: }
1.1310 raeburn 3753: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3754: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3755: $result = &mt
1.144 matthew 3756: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3757: '<label>'.$authtype,'</label>'.$autharg);
3758: return $result;
3759: }
3760:
3761: sub authform_lti {
3762: my %in = (
3763: formname => 'document.cu',
3764: kerb_def_dom => 'MSU.EDU',
3765: @_,
3766: );
3767: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3768: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3769: if ($in{'readonly'}) {
3770: $disabled = ' disabled="disabled"';
3771: }
3772: if (defined($in{'curr_authtype'})) {
3773: if ($in{'curr_authtype'} eq 'lti') {
3774: if ($can_assign{'lti'}) {
3775: $lticheck = 'checked="checked" ';
3776: if (defined($in{'mode'})) {
3777: if ($in{'mode'} eq 'modifyuser') {
3778: $lticheck = '';
3779: }
3780: }
3781: } else {
3782: $result = &mt('Currently LTI Authenticated.');
3783: return $result;
3784: }
3785: }
3786: } else {
3787: if ($authnum == 1) {
3788: $authtype = '<input type="hidden" name="login" value="lti" />';
3789: }
3790: }
3791: if (!$can_assign{'lti'}) {
3792: return;
3793: } elsif ($authtype eq '') {
3794: if (defined($in{'mode'})) {
3795: if ($in{'mode'} eq 'modifycourse') {
3796: if ($authnum == 1) {
3797: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3798: }
3799: }
3800: }
3801: }
3802: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3803: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3804: $authtype = '<input type="radio" name="login" value="lti" '.
3805: $lticheck.' onchange="'.$jscall.'" onclick="'.
3806: $jscall.'"'.$disabled.' />';
3807: }
3808: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3809: if ($authtype) {
3810: $result = &mt('[_1] LTI Authenticated',
3811: '<label>'.$authtype.'</label>'.$autharg);
3812: } else {
3813: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3814: $autharg;
3815: }
1.32 matthew 3816: return $result;
3817: }
3818:
1.586 raeburn 3819: sub get_assignable_auth {
3820: my ($dom) = @_;
3821: if ($dom eq '') {
3822: $dom = $env{'request.role.domain'};
3823: }
3824: my %can_assign = (
3825: krb4 => 1,
3826: krb5 => 1,
3827: int => 1,
3828: loc => 1,
1.1310 raeburn 3829: lti => 1,
1.586 raeburn 3830: );
3831: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3832: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3833: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3834: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3835: my $context;
3836: if ($env{'request.role'} =~ /^au/) {
3837: $context = 'author';
1.1259 raeburn 3838: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3839: $context = 'domain';
3840: } elsif ($env{'request.course.id'}) {
3841: $context = 'course';
3842: }
3843: if ($context) {
3844: if (ref($authhash->{$context}) eq 'HASH') {
3845: %can_assign = %{$authhash->{$context}};
3846: }
3847: }
3848: }
3849: }
3850: my $authnum = 0;
3851: foreach my $key (keys(%can_assign)) {
3852: if ($can_assign{$key}) {
3853: $authnum ++;
3854: }
3855: }
3856: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3857: $authnum --;
3858: }
3859: return ($authnum,%can_assign);
3860: }
3861:
1.1331 raeburn 3862: sub check_passwd_rules {
3863: my ($domain,$plainpass) = @_;
3864: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3865: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3866: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3867: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3868: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3869: if ($passwdconf{'min'} > $min) {
3870: $min = $passwdconf{'min'};
3871: }
1.1331 raeburn 3872: }
3873: if ($passwdconf{'max'} =~ /^\d+$/) {
3874: $max = $passwdconf{'max'};
3875: }
3876: @chars = @{$passwdconf{'chars'}};
3877: }
3878: if (($min) && (length($plainpass) < $min)) {
3879: push(@brokerule,'min');
3880: }
3881: if (($max) && (length($plainpass) > $max)) {
3882: push(@brokerule,'max');
3883: }
3884: if (@chars) {
3885: my %rules;
3886: map { $rules{$_} = 1; } @chars;
3887: if ($rules{'uc'}) {
3888: unless ($plainpass =~ /[A-Z]/) {
3889: push(@brokerule,'uc');
3890: }
3891: }
3892: if ($rules{'lc'}) {
1.1332 raeburn 3893: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3894: push(@brokerule,'lc');
3895: }
3896: }
3897: if ($rules{'num'}) {
3898: unless ($plainpass =~ /\d/) {
3899: push(@brokerule,'num');
3900: }
3901: }
3902: if ($rules{'spec'}) {
3903: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3904: push(@brokerule,'spec');
3905: }
3906: }
3907: }
3908: if (@brokerule) {
3909: my %rulenames = &Apache::lonlocal::texthash(
3910: uc => 'At least one upper case letter',
3911: lc => 'At least one lower case letter',
3912: num => 'At least one number',
3913: spec => 'At least one non-alphanumeric',
3914: );
3915: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3916: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3917: $rulenames{'num'} .= ': 0123456789';
3918: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3919: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3920: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3921: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3922: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3923: if (grep(/^$rule$/,@brokerule)) {
3924: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3925: }
3926: }
3927: $warning .= '</ul>';
3928: }
1.1332 raeburn 3929: if (wantarray) {
3930: return @brokerule;
3931: }
1.1331 raeburn 3932: return $warning;
3933: }
3934:
1.1376 raeburn 3935: sub passwd_validation_js {
1.1377 raeburn 3936: my ($currpasswdval,$domain,$context,$id) = @_;
3937: my (%passwdconf,$alertmsg);
3938: if ($context eq 'linkprot') {
3939: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3940: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3941: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3942: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3943: }
3944: }
3945: if ($id eq 'add') {
3946: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3947: } elsif ($id =~ /^\d+$/) {
3948: my $pos = $id+1;
3949: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3950: } else {
3951: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3952: }
1.1434 ! raeburn 3953: } elsif ($context eq 'ltitools') {
! 3954: my %domconfig = &Apache::lonnet::get_dom('configuration',['toolsec'],$domain);
! 3955: if (ref($domconfig{'toolsec'}) eq 'HASH') {
! 3956: if (ref($domconfig{'toolsec'}{'rules'}) eq 'HASH') {
! 3957: %passwdconf = %{$domconfig{'toolsec'}{'rules'}};
! 3958: }
! 3959: }
! 3960: if ($id eq 'add') {
! 3961: $alertmsg = &mt('Secret for added external tool did not satisfy requirement(s):').'\n\n';
! 3962: } elsif ($id =~ /^\d+$/) {
! 3963: my $pos = $id+1;
! 3964: $alertmsg = &mt('Secret for external tool [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
! 3965: } else {
! 3966: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
! 3967: }
1.1377 raeburn 3968: } else {
3969: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3970: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3971: }
1.1376 raeburn 3972: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3973: $numrules = 0;
3974: $min = $Apache::lonnet::passwdmin;
3975: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3976: if ($passwdconf{'min'} =~ /^\d+$/) {
3977: if ($passwdconf{'min'} > $min) {
3978: $min = $passwdconf{'min'};
3979: }
3980: }
3981: if ($passwdconf{'max'} =~ /^\d+$/) {
3982: $max = $passwdconf{'max'};
3983: $numrules ++;
3984: }
3985: @chars = @{$passwdconf{'chars'}};
3986: if (@chars) {
3987: $numrules ++;
3988: }
3989: }
3990: if ($min > 0) {
3991: $numrules ++;
3992: }
3993: if (($min > 0) || ($max ne '') || (@chars > 0)) {
3994: if ($min) {
3995: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3996: }
3997: if ($max) {
3998: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3999: }
4000: my (@charalerts,@charrules);
4001: if (@chars) {
4002: if (grep(/^uc$/,@chars)) {
4003: push(@charalerts,&mt('contain at least one upper case letter'));
4004: push(@charrules,'uc');
4005: }
4006: if (grep(/^lc$/,@chars)) {
4007: push(@charalerts,&mt('contain at least one lower case letter'));
4008: push(@charrules,'lc');
4009: }
4010: if (grep(/^num$/,@chars)) {
4011: push(@charalerts,&mt('contain at least one number'));
4012: push(@charrules,'num');
4013: }
4014: if (grep(/^spec$/,@chars)) {
4015: push(@charalerts,&mt('contain at least one non-alphanumeric'));
4016: push(@charrules,'spec');
4017: }
4018: }
4019: $intargjs = qq| var rulesmsg = '';\n|.
4020: qq| var currpwval = $currpasswdval;\n|;
4021: if ($min) {
4022: $intargjs .= qq|
4023: if (currpwval.length < $min) {
4024: rulesmsg += ' - $alert{min}';
4025: }
4026: |;
4027: }
4028: if ($max) {
4029: $intargjs .= qq|
4030: if (currpwval.length > $max) {
4031: rulesmsg += ' - $alert{max}';
4032: }
4033: |;
4034: }
4035: if (@chars > 0) {
4036: my $charrulestr = '"'.join('","',@charrules).'"';
4037: my $charalertstr = '"'.join('","',@charalerts).'"';
4038: $intargjs .= qq| var brokerules = new Array();\n|.
4039: qq| var charrules = new Array($charrulestr);\n|.
4040: qq| var charalerts = new Array($charalertstr);\n|;
4041: my %rules;
4042: map { $rules{$_} = 1; } @chars;
4043: if ($rules{'uc'}) {
4044: $intargjs .= qq|
4045: var ucRegExp = /[A-Z]/;
4046: if (!ucRegExp.test(currpwval)) {
4047: brokerules.push('uc');
4048: }
4049: |;
4050: }
4051: if ($rules{'lc'}) {
4052: $intargjs .= qq|
4053: var lcRegExp = /[a-z]/;
4054: if (!lcRegExp.test(currpwval)) {
4055: brokerules.push('lc');
4056: }
4057: |;
4058: }
4059: if ($rules{'num'}) {
4060: $intargjs .= qq|
4061: var numRegExp = /[0-9]/;
4062: if (!numRegExp.test(currpwval)) {
4063: brokerules.push('num');
4064: }
4065: |;
4066: }
4067: if ($rules{'spec'}) {
4068: $intargjs .= q|
4069: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
4070: if (!specRegExp.test(currpwval)) {
4071: brokerules.push('spec');
4072: }
4073: |;
4074: }
4075: $intargjs .= qq|
4076: if (brokerules.length > 0) {
4077: for (var i=0; i<brokerules.length; i++) {
4078: for (var j=0; j<charrules.length; j++) {
4079: if (brokerules[i] == charrules[j]) {
4080: rulesmsg += ' - '+charalerts[j]+'\\n';
4081: break;
4082: }
4083: }
4084: }
4085: }
4086: |;
4087: }
4088: $intargjs .= qq|
4089: if (rulesmsg != '') {
4090: rulesmsg = '$alertmsg'+rulesmsg;
4091: alert(rulesmsg);
4092: return false;
4093: }
4094: |;
4095: }
4096: return ($numrules,$intargjs);
4097: }
4098:
1.80 albertel 4099: ###############################################################
4100: ## Get Kerberos Defaults for Domain ##
4101: ###############################################################
4102: ##
4103: ## Returns default kerberos version and an associated argument
4104: ## as listed in file domain.tab. If not listed, provides
4105: ## appropriate default domain and kerberos version.
4106: ##
4107: #-------------------------------------------
4108:
4109: =pod
4110:
1.648 raeburn 4111: =item * &get_kerberos_defaults()
1.80 albertel 4112:
4113: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 4114: version and domain. If not found, it defaults to version 4 and the
4115: domain of the server.
1.80 albertel 4116:
1.648 raeburn 4117: =over 4
4118:
1.80 albertel 4119: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
4120:
1.648 raeburn 4121: =back
4122:
4123: =back
4124:
1.80 albertel 4125: =cut
4126:
4127: #-------------------------------------------
4128: sub get_kerberos_defaults {
4129: my $domain=shift;
1.641 raeburn 4130: my ($krbdef,$krbdefdom);
4131: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
4132: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
4133: $krbdef = $domdefaults{'auth_def'};
4134: $krbdefdom = $domdefaults{'auth_arg_def'};
4135: } else {
1.80 albertel 4136: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
4137: my $krbdefdom=$1;
4138: $krbdefdom=~tr/a-z/A-Z/;
4139: $krbdef = "krb4";
4140: }
4141: return ($krbdef,$krbdefdom);
4142: }
1.112 bowersj2 4143:
1.32 matthew 4144:
1.46 matthew 4145: ###############################################################
4146: ## Thesaurus Functions ##
4147: ###############################################################
1.20 www 4148:
1.46 matthew 4149: =pod
1.20 www 4150:
1.112 bowersj2 4151: =head1 Thesaurus Functions
4152:
4153: =over 4
4154:
1.648 raeburn 4155: =item * &initialize_keywords()
1.46 matthew 4156:
4157: Initializes the package variable %Keywords if it is empty. Uses the
4158: package variable $thesaurus_db_file.
4159:
4160: =cut
4161:
4162: ###################################################
4163:
4164: sub initialize_keywords {
4165: return 1 if (scalar keys(%Keywords));
4166: # If we are here, %Keywords is empty, so fill it up
4167: # Make sure the file we need exists...
4168: if (! -e $thesaurus_db_file) {
4169: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
4170: " failed because it does not exist");
4171: return 0;
4172: }
4173: # Set up the hash as a database
4174: my %thesaurus_db;
4175: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4176: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4177: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
4178: $thesaurus_db_file);
4179: return 0;
4180: }
4181: # Get the average number of appearances of a word.
4182: my $avecount = $thesaurus_db{'average.count'};
4183: # Put keywords (those that appear > average) into %Keywords
4184: while (my ($word,$data)=each (%thesaurus_db)) {
4185: my ($count,undef) = split /:/,$data;
4186: $Keywords{$word}++ if ($count > $avecount);
4187: }
4188: untie %thesaurus_db;
4189: # Remove special values from %Keywords.
1.356 albertel 4190: foreach my $value ('total.count','average.count') {
4191: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4192: }
1.46 matthew 4193: return 1;
4194: }
4195:
4196: ###################################################
4197:
4198: =pod
4199:
1.648 raeburn 4200: =item * &keyword($word)
1.46 matthew 4201:
4202: Returns true if $word is a keyword. A keyword is a word that appears more
4203: than the average number of times in the thesaurus database. Calls
4204: &initialize_keywords
4205:
4206: =cut
4207:
4208: ###################################################
1.20 www 4209:
4210: sub keyword {
1.46 matthew 4211: return if (!&initialize_keywords());
4212: my $word=lc(shift());
4213: $word=~s/\W//g;
4214: return exists($Keywords{$word});
1.20 www 4215: }
1.46 matthew 4216:
4217: ###############################################################
4218:
4219: =pod
1.20 www 4220:
1.648 raeburn 4221: =item * &get_related_words()
1.46 matthew 4222:
1.160 matthew 4223: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4224: an array of words. If the keyword is not in the thesaurus, an empty array
4225: will be returned. The order of the words returned is determined by the
4226: database which holds them.
4227:
4228: Uses global $thesaurus_db_file.
4229:
1.1057 foxr 4230:
1.46 matthew 4231: =cut
4232:
4233: ###############################################################
4234: sub get_related_words {
4235: my $keyword = shift;
4236: my %thesaurus_db;
4237: if (! -e $thesaurus_db_file) {
4238: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4239: "failed because the file does not exist");
4240: return ();
4241: }
4242: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4243: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4244: return ();
4245: }
4246: my @Words=();
1.429 www 4247: my $count=0;
1.46 matthew 4248: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4249: # The first element is the number of times
4250: # the word appears. We do not need it now.
1.429 www 4251: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4252: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4253: my $threshold=$mostfrequentcount/10;
4254: foreach my $possibleword (@RelatedWords) {
4255: my ($word,$wordcount)=split(/\,/,$possibleword);
4256: if ($wordcount>$threshold) {
4257: push(@Words,$word);
4258: $count++;
4259: if ($count>10) { last; }
4260: }
1.20 www 4261: }
4262: }
1.46 matthew 4263: untie %thesaurus_db;
4264: return @Words;
1.14 harris41 4265: }
1.1090 foxr 4266: ###############################################################
4267: #
4268: # Spell checking
4269: #
4270:
4271: =pod
4272:
1.1142 raeburn 4273: =back
4274:
1.1090 foxr 4275: =head1 Spell checking
4276:
4277: =over 4
4278:
4279: =item * &check_spelling($wordlist $language)
4280:
4281: Takes a string containing words and feeds it to an external
4282: spellcheck program via a pipeline. Returns a string containing
4283: them mis-spelled words.
4284:
4285: Parameters:
4286:
4287: =over 4
4288:
4289: =item - $wordlist
4290:
4291: String that will be fed into the spellcheck program.
4292:
4293: =item - $language
4294:
4295: Language string that specifies the language for which the spell
4296: check will be performed.
4297:
4298: =back
4299:
4300: =back
4301:
4302: Note: This sub assumes that aspell is installed.
4303:
4304:
4305: =cut
4306:
1.46 matthew 4307:
1.1090 foxr 4308: sub check_spelling {
4309: my ($wordlist, $language) = @_;
1.1091 foxr 4310: my @misspellings;
4311:
4312: # Generate the speller and set the langauge.
4313: # if explicitly selected:
1.1090 foxr 4314:
1.1091 foxr 4315: my $speller = Text::Aspell->new;
1.1090 foxr 4316: if ($language) {
1.1091 foxr 4317: $speller->set_option('lang', $language);
1.1090 foxr 4318: }
4319:
1.1091 foxr 4320: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4321:
1.1091 foxr 4322: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4323:
1.1091 foxr 4324: foreach my $word (@words) {
4325: if(! $speller->check($word)) {
4326: push(@misspellings, $word);
1.1090 foxr 4327: }
4328: }
1.1091 foxr 4329: return join(' ', @misspellings);
4330:
1.1090 foxr 4331: }
4332:
1.61 www 4333: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4334: =pod
4335:
1.112 bowersj2 4336: =head1 User Name Functions
4337:
4338: =over 4
4339:
1.648 raeburn 4340: =item * &plainname($uname,$udom,$first)
1.81 albertel 4341:
1.112 bowersj2 4342: Takes a users logon name and returns it as a string in
1.226 albertel 4343: "first middle last generation" form
4344: if $first is set to 'lastname' then it returns it as
4345: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4346:
4347: =cut
1.61 www 4348:
1.295 www 4349:
1.81 albertel 4350: ###############################################################
1.61 www 4351: sub plainname {
1.226 albertel 4352: my ($uname,$udom,$first)=@_;
1.537 albertel 4353: return if (!defined($uname) || !defined($udom));
1.295 www 4354: my %names=&getnames($uname,$udom);
1.226 albertel 4355: my $name=&Apache::lonnet::format_name($names{'firstname'},
4356: $names{'middlename'},
4357: $names{'lastname'},
4358: $names{'generation'},$first);
4359: $name=~s/^\s+//;
1.62 www 4360: $name=~s/\s+$//;
4361: $name=~s/\s+/ /g;
1.353 albertel 4362: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4363: return $name;
1.61 www 4364: }
1.66 www 4365:
4366: # -------------------------------------------------------------------- Nickname
1.81 albertel 4367: =pod
4368:
1.648 raeburn 4369: =item * &nickname($uname,$udom)
1.81 albertel 4370:
4371: Gets a users name and returns it as a string as
4372:
4373: ""nickname""
1.66 www 4374:
1.81 albertel 4375: if the user has a nickname or
4376:
4377: "first middle last generation"
4378:
4379: if the user does not
4380:
4381: =cut
1.66 www 4382:
4383: sub nickname {
4384: my ($uname,$udom)=@_;
1.537 albertel 4385: return if (!defined($uname) || !defined($udom));
1.295 www 4386: my %names=&getnames($uname,$udom);
1.68 albertel 4387: my $name=$names{'nickname'};
1.66 www 4388: if ($name) {
4389: $name='"'.$name.'"';
4390: } else {
4391: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4392: $names{'lastname'}.' '.$names{'generation'};
4393: $name=~s/\s+$//;
4394: $name=~s/\s+/ /g;
4395: }
4396: return $name;
4397: }
4398:
1.295 www 4399: sub getnames {
4400: my ($uname,$udom)=@_;
1.537 albertel 4401: return if (!defined($uname) || !defined($udom));
1.433 albertel 4402: if ($udom eq 'public' && $uname eq 'public') {
4403: return ('lastname' => &mt('Public'));
4404: }
1.295 www 4405: my $id=$uname.':'.$udom;
4406: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4407: if ($cached) {
4408: return %{$names};
4409: } else {
4410: my %loadnames=&Apache::lonnet::get('environment',
4411: ['firstname','middlename','lastname','generation','nickname'],
4412: $udom,$uname);
4413: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4414: return %loadnames;
4415: }
4416: }
1.61 www 4417:
1.542 raeburn 4418: # -------------------------------------------------------------------- getemails
1.648 raeburn 4419:
1.542 raeburn 4420: =pod
4421:
1.648 raeburn 4422: =item * &getemails($uname,$udom)
1.542 raeburn 4423:
4424: Gets a user's email information and returns it as a hash with keys:
4425: notification, critnotification, permanentemail
4426:
4427: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4428: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4429:
1.648 raeburn 4430:
1.542 raeburn 4431: =cut
4432:
1.648 raeburn 4433:
1.466 albertel 4434: sub getemails {
4435: my ($uname,$udom)=@_;
4436: if ($udom eq 'public' && $uname eq 'public') {
4437: return;
4438: }
1.467 www 4439: if (!$udom) { $udom=$env{'user.domain'}; }
4440: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4441: my $id=$uname.':'.$udom;
4442: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4443: if ($cached) {
4444: return %{$names};
4445: } else {
4446: my %loadnames=&Apache::lonnet::get('environment',
4447: ['notification','critnotification',
4448: 'permanentemail'],
4449: $udom,$uname);
4450: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4451: return %loadnames;
4452: }
4453: }
4454:
1.551 albertel 4455: sub flush_email_cache {
4456: my ($uname,$udom)=@_;
4457: if (!$udom) { $udom =$env{'user.domain'}; }
4458: if (!$uname) { $uname=$env{'user.name'}; }
4459: return if ($udom eq 'public' && $uname eq 'public');
4460: my $id=$uname.':'.$udom;
4461: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4462: }
4463:
1.728 raeburn 4464: # -------------------------------------------------------------------- getlangs
4465:
4466: =pod
4467:
4468: =item * &getlangs($uname,$udom)
4469:
4470: Gets a user's language preference and returns it as a hash with key:
4471: language.
4472:
4473: =cut
4474:
4475:
4476: sub getlangs {
4477: my ($uname,$udom) = @_;
4478: if (!$udom) { $udom =$env{'user.domain'}; }
4479: if (!$uname) { $uname=$env{'user.name'}; }
4480: my $id=$uname.':'.$udom;
4481: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4482: if ($cached) {
4483: return %{$langs};
4484: } else {
4485: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4486: $udom,$uname);
4487: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4488: return %loadlangs;
4489: }
4490: }
4491:
4492: sub flush_langs_cache {
4493: my ($uname,$udom)=@_;
4494: if (!$udom) { $udom =$env{'user.domain'}; }
4495: if (!$uname) { $uname=$env{'user.name'}; }
4496: return if ($udom eq 'public' && $uname eq 'public');
4497: my $id=$uname.':'.$udom;
4498: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4499: }
4500:
1.61 www 4501: # ------------------------------------------------------------------ Screenname
1.81 albertel 4502:
4503: =pod
4504:
1.648 raeburn 4505: =item * &screenname($uname,$udom)
1.81 albertel 4506:
4507: Gets a users screenname and returns it as a string
4508:
4509: =cut
1.61 www 4510:
4511: sub screenname {
4512: my ($uname,$udom)=@_;
1.258 albertel 4513: if ($uname eq $env{'user.name'} &&
4514: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4515: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4516: return $names{'screenname'};
1.62 www 4517: }
4518:
1.212 albertel 4519:
1.802 bisitz 4520: # ------------------------------------------------------------- Confirm Wrapper
4521: =pod
4522:
1.1142 raeburn 4523: =item * &confirmwrapper($message)
1.802 bisitz 4524:
4525: Wrap messages about completion of operation in box
4526:
4527: =cut
4528:
4529: sub confirmwrapper {
4530: my ($message)=@_;
4531: if ($message) {
4532: return "\n".'<div class="LC_confirm_box">'."\n"
4533: .$message."\n"
4534: .'</div>'."\n";
4535: } else {
4536: return $message;
4537: }
4538: }
4539:
1.62 www 4540: # ------------------------------------------------------------- Message Wrapper
4541:
4542: sub messagewrapper {
1.369 www 4543: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4544: return
1.441 albertel 4545: '<a href="/adm/email?compose=individual&'.
4546: 'recname='.$username.'&recdom='.$domain.
4547: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4548: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4549: }
1.802 bisitz 4550:
1.74 www 4551: # --------------------------------------------------------------- Notes Wrapper
4552:
4553: sub noteswrapper {
4554: my ($link,$un,$do)=@_;
4555: return
1.896 amueller 4556: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4557: }
1.802 bisitz 4558:
1.62 www 4559: # ------------------------------------------------------------- Aboutme Wrapper
4560:
4561: sub aboutmewrapper {
1.1070 raeburn 4562: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4563: if (!defined($username) && !defined($domain)) {
4564: return;
4565: }
1.1096 raeburn 4566: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4567: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4568: }
4569:
4570: # ------------------------------------------------------------ Syllabus Wrapper
4571:
4572: sub syllabuswrapper {
1.707 bisitz 4573: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4574: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4575: }
1.14 harris41 4576:
1.1397 raeburn 4577: # -----------------------------------------------------------------------------
4578:
1.1396 raeburn 4579: sub aboutme_on {
4580: my ($uname,$udom)=@_;
4581: unless ($uname) { $uname=$env{'user.name'}; }
4582: unless ($udom) { $udom=$env{'user.domain'}; }
4583: return if ($udom eq 'public' && $uname eq 'public');
4584: my $hashkey=$uname.':'.$udom;
4585: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4586: if ($cached) {
4587: return $aboutme;
4588: }
4589: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4590: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4591: return $aboutme;
4592: }
4593:
4594: sub devalidate_aboutme_cache {
4595: my ($uname,$udom)=@_;
4596: if (!$udom) { $udom =$env{'user.domain'}; }
4597: if (!$uname) { $uname=$env{'user.name'}; }
4598: return if ($udom eq 'public' && $uname eq 'public');
4599: my $id=$uname.':'.$udom;
4600: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4601: }
4602:
1.208 matthew 4603: sub track_student_link {
1.887 raeburn 4604: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4605: my $link ="/adm/trackstudent?";
1.208 matthew 4606: my $title = 'View recent activity';
4607: if (defined($sname) && $sname !~ /^\s*$/ &&
4608: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4609: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4610: $title .= ' of this student';
1.268 albertel 4611: }
1.208 matthew 4612: if (defined($target) && $target !~ /^\s*$/) {
4613: $target = qq{target="$target"};
4614: } else {
4615: $target = '';
4616: }
1.268 albertel 4617: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4618: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4619: $title = &mt($title);
4620: $linktext = &mt($linktext);
1.448 albertel 4621: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4622: &help_open_topic('View_recent_activity');
1.208 matthew 4623: }
4624:
1.781 raeburn 4625: sub slot_reservations_link {
4626: my ($linktext,$sname,$sdom,$target) = @_;
4627: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4628: my $title = 'View slot reservation history';
4629: if (defined($sname) && $sname !~ /^\s*$/ &&
4630: defined($sdom) && $sdom !~ /^\s*$/) {
4631: $link .= "&uname=$sname&udom=$sdom";
4632: $title .= ' of this student';
4633: }
4634: if (defined($target) && $target !~ /^\s*$/) {
4635: $target = qq{target="$target"};
4636: } else {
4637: $target = '';
4638: }
4639: $title = &mt($title);
4640: $linktext = &mt($linktext);
4641: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4642: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4643:
4644: }
4645:
1.508 www 4646: # ===================================================== Display a student photo
4647:
4648:
1.509 albertel 4649: sub student_image_tag {
1.508 www 4650: my ($domain,$user)=@_;
4651: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4652: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4653: return '<img src="'.$imgsrc.'" align="right" />';
4654: } else {
4655: return '';
4656: }
4657: }
4658:
1.112 bowersj2 4659: =pod
4660:
4661: =back
4662:
4663: =head1 Access .tab File Data
4664:
4665: =over 4
4666:
1.648 raeburn 4667: =item * &languageids()
1.112 bowersj2 4668:
4669: returns list of all language ids
4670:
4671: =cut
4672:
1.14 harris41 4673: sub languageids {
1.16 harris41 4674: return sort(keys(%language));
1.14 harris41 4675: }
4676:
1.112 bowersj2 4677: =pod
4678:
1.648 raeburn 4679: =item * &languagedescription()
1.112 bowersj2 4680:
4681: returns description of a specified language id
4682:
4683: =cut
4684:
1.14 harris41 4685: sub languagedescription {
1.125 www 4686: my $code=shift;
4687: return ($supported_language{$code}?'* ':'').
4688: $language{$code}.
1.126 www 4689: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4690: }
4691:
1.1048 foxr 4692: =pod
4693:
4694: =item * &plainlanguagedescription
4695:
4696: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4697: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4698:
4699: =cut
4700:
1.145 www 4701: sub plainlanguagedescription {
4702: my $code=shift;
4703: return $language{$code};
4704: }
4705:
1.1048 foxr 4706: =pod
4707:
4708: =item * &supportedlanguagecode
4709:
4710: Returns the supported language code (e.g. sptutf maps to pt) given a language
4711: code.
4712:
4713: =cut
4714:
1.145 www 4715: sub supportedlanguagecode {
4716: my $code=shift;
4717: return $supported_language{$code};
1.97 www 4718: }
4719:
1.112 bowersj2 4720: =pod
4721:
1.1048 foxr 4722: =item * &latexlanguage()
4723:
4724: Given a language key code returns the correspondnig language to use
4725: to select the correct hyphenation on LaTeX printouts. This is undef if there
4726: is no supported hyphenation for the language code.
4727:
4728: =cut
4729:
4730: sub latexlanguage {
4731: my $code = shift;
4732: return $latex_language{$code};
4733: }
4734:
4735: =pod
4736:
4737: =item * &latexhyphenation()
4738:
4739: Same as above but what's supplied is the language as it might be stored
4740: in the metadata.
4741:
4742: =cut
4743:
4744: sub latexhyphenation {
4745: my $key = shift;
4746: return $latex_language_bykey{$key};
4747: }
4748:
4749: =pod
4750:
1.648 raeburn 4751: =item * ©rightids()
1.112 bowersj2 4752:
4753: returns list of all copyrights
4754:
4755: =cut
4756:
4757: sub copyrightids {
4758: return sort(keys(%cprtag));
4759: }
4760:
4761: =pod
4762:
1.648 raeburn 4763: =item * ©rightdescription()
1.112 bowersj2 4764:
4765: returns description of a specified copyright id
4766:
4767: =cut
4768:
4769: sub copyrightdescription {
1.166 www 4770: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4771: }
1.197 matthew 4772:
4773: =pod
4774:
1.648 raeburn 4775: =item * &source_copyrightids()
1.192 taceyjo1 4776:
4777: returns list of all source copyrights
4778:
4779: =cut
4780:
4781: sub source_copyrightids {
4782: return sort(keys(%scprtag));
4783: }
4784:
4785: =pod
4786:
1.648 raeburn 4787: =item * &source_copyrightdescription()
1.192 taceyjo1 4788:
4789: returns description of a specified source copyright id
4790:
4791: =cut
4792:
4793: sub source_copyrightdescription {
4794: return &mt($scprtag{shift(@_)});
4795: }
1.112 bowersj2 4796:
4797: =pod
4798:
1.648 raeburn 4799: =item * &filecategories()
1.112 bowersj2 4800:
4801: returns list of all file categories
4802:
4803: =cut
4804:
4805: sub filecategories {
4806: return sort(keys(%category_extensions));
4807: }
4808:
4809: =pod
4810:
1.648 raeburn 4811: =item * &filecategorytypes()
1.112 bowersj2 4812:
4813: returns list of file types belonging to a given file
4814: category
4815:
4816: =cut
4817:
4818: sub filecategorytypes {
1.356 albertel 4819: my ($cat) = @_;
1.1248 raeburn 4820: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4821: return @{$category_extensions{lc($cat)}};
4822: } else {
4823: return ();
4824: }
1.112 bowersj2 4825: }
4826:
4827: =pod
4828:
1.648 raeburn 4829: =item * &fileembstyle()
1.112 bowersj2 4830:
4831: returns embedding style for a specified file type
4832:
4833: =cut
4834:
4835: sub fileembstyle {
4836: return $fe{lc(shift(@_))};
1.169 www 4837: }
4838:
1.351 www 4839: sub filemimetype {
4840: return $fm{lc(shift(@_))};
4841: }
4842:
1.169 www 4843:
4844: sub filecategoryselect {
4845: my ($name,$value)=@_;
1.189 matthew 4846: return &select_form($value,$name,
1.970 raeburn 4847: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4848: }
4849:
4850: =pod
4851:
1.648 raeburn 4852: =item * &filedescription()
1.112 bowersj2 4853:
4854: returns description for a specified file type
4855:
4856: =cut
4857:
4858: sub filedescription {
1.188 matthew 4859: my $file_description = $fd{lc(shift())};
4860: $file_description =~ s:([\[\]]):~$1:g;
4861: return &mt($file_description);
1.112 bowersj2 4862: }
4863:
4864: =pod
4865:
1.648 raeburn 4866: =item * &filedescriptionex()
1.112 bowersj2 4867:
4868: returns description for a specified file type with
4869: extra formatting
4870:
4871: =cut
4872:
4873: sub filedescriptionex {
4874: my $ex=shift;
1.188 matthew 4875: my $file_description = $fd{lc($ex)};
4876: $file_description =~ s:([\[\]]):~$1:g;
4877: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4878: }
4879:
4880: # End of .tab access
4881: =pod
4882:
4883: =back
4884:
4885: =cut
4886:
4887: # ------------------------------------------------------------------ File Types
4888: sub fileextensions {
4889: return sort(keys(%fe));
4890: }
4891:
1.97 www 4892: # ----------------------------------------------------------- Display Languages
4893: # returns a hash with all desired display languages
4894: #
4895:
4896: sub display_languages {
4897: my %languages=();
1.695 raeburn 4898: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4899: $languages{$lang}=1;
1.97 www 4900: }
4901: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4902: if ($env{'form.displaylanguage'}) {
1.356 albertel 4903: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4904: $languages{$lang}=1;
1.97 www 4905: }
4906: }
4907: return %languages;
1.14 harris41 4908: }
4909:
1.582 albertel 4910: sub languages {
4911: my ($possible_langs) = @_;
1.695 raeburn 4912: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4913: if (!ref($possible_langs)) {
4914: if( wantarray ) {
4915: return @preferred_langs;
4916: } else {
4917: return $preferred_langs[0];
4918: }
4919: }
4920: my %possibilities = map { $_ => 1 } (@$possible_langs);
4921: my @preferred_possibilities;
4922: foreach my $preferred_lang (@preferred_langs) {
4923: if (exists($possibilities{$preferred_lang})) {
4924: push(@preferred_possibilities, $preferred_lang);
4925: }
4926: }
4927: if( wantarray ) {
4928: return @preferred_possibilities;
4929: }
4930: return $preferred_possibilities[0];
4931: }
4932:
1.742 raeburn 4933: sub user_lang {
4934: my ($touname,$toudom,$fromcid) = @_;
4935: my @userlangs;
4936: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4937: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4938: $env{'course.'.$fromcid.'.languages'}));
4939: } else {
4940: my %langhash = &getlangs($touname,$toudom);
4941: if ($langhash{'languages'} ne '') {
4942: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4943: } else {
4944: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4945: if ($domdefs{'lang_def'} ne '') {
4946: @userlangs = ($domdefs{'lang_def'});
4947: }
4948: }
4949: }
4950: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4951: my $user_lh = Apache::localize->get_handle(@languages);
4952: return $user_lh;
4953: }
4954:
4955:
1.112 bowersj2 4956: ###############################################################
4957: ## Student Answer Attempts ##
4958: ###############################################################
4959:
4960: =pod
4961:
4962: =head1 Alternate Problem Views
4963:
4964: =over 4
4965:
1.648 raeburn 4966: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4967: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4968:
4969: Return string with previous attempt on problem. Arguments:
4970:
4971: =over 4
4972:
4973: =item * $symb: Problem, including path
4974:
4975: =item * $username: username of the desired student
4976:
4977: =item * $domain: domain of the desired student
1.14 harris41 4978:
1.112 bowersj2 4979: =item * $course: Course ID
1.14 harris41 4980:
1.112 bowersj2 4981: =item * $getattempt: Leave blank for all attempts, otherwise put
4982: something
1.14 harris41 4983:
1.112 bowersj2 4984: =item * $regexp: if string matches this regexp, the string will be
4985: sent to $gradesub
1.14 harris41 4986:
1.112 bowersj2 4987: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4988:
1.1199 raeburn 4989: =item * $usec: section of the desired student
4990:
4991: =item * $identifier: counter for student (multiple students one problem) or
4992: problem (one student; whole sequence).
4993:
1.112 bowersj2 4994: =back
1.14 harris41 4995:
1.112 bowersj2 4996: The output string is a table containing all desired attempts, if any.
1.16 harris41 4997:
1.112 bowersj2 4998: =cut
1.1 albertel 4999:
5000: sub get_previous_attempt {
1.1199 raeburn 5001: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 5002: my $prevattempts='';
1.43 ng 5003: no strict 'refs';
1.1 albertel 5004: if ($symb) {
1.3 albertel 5005: my (%returnhash)=
5006: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 5007: if ($returnhash{'version'}) {
5008: my %lasthash=();
5009: my $version;
5010: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 5011: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
5012: if ($key =~ /\.rawrndseed$/) {
5013: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
5014: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
5015: } else {
5016: $lasthash{$key}=$returnhash{$version.':'.$key};
5017: }
1.19 harris41 5018: }
1.1 albertel 5019: }
1.596 albertel 5020: $prevattempts=&start_data_table().&start_data_table_header_row();
5021: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 5022: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 5023: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 5024: foreach my $key (sort(keys(%lasthash))) {
5025: my ($ign,@parts) = split(/\./,$key);
1.41 ng 5026: if ($#parts > 0) {
1.31 albertel 5027: my $data=$parts[-1];
1.989 raeburn 5028: next if ($data eq 'foilorder');
1.31 albertel 5029: pop(@parts);
1.1010 www 5030: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 5031: if ($data eq 'type') {
5032: unless ($showsurv) {
5033: my $id = join(',',@parts);
5034: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 5035: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
5036: $lasthidden{$ign.'.'.$id} = 1;
5037: }
1.945 raeburn 5038: }
1.1199 raeburn 5039: if ($identifier ne '') {
5040: my $id = join(',',@parts);
5041: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
5042: $domain,$username,$usec,undef,$course) =~ /^no/) {
5043: $hidestatus{$ign.'.'.$id} = 1;
5044: }
5045: }
5046: } elsif ($data eq 'regrader') {
5047: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 5048: my $id = join(',',@parts);
5049: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 5050: }
1.1010 www 5051: }
1.31 albertel 5052: } else {
1.41 ng 5053: if ($#parts == 0) {
5054: $prevattempts.='<th>'.$parts[0].'</th>';
5055: } else {
5056: $prevattempts.='<th>'.$ign.'</th>';
5057: }
1.31 albertel 5058: }
1.16 harris41 5059: }
1.596 albertel 5060: $prevattempts.=&end_data_table_header_row();
1.40 ng 5061: if ($getattempt eq '') {
1.1199 raeburn 5062: my (%solved,%resets,%probstatus);
1.1200 raeburn 5063: if (($identifier ne '') && (keys(%regraded) > 0)) {
5064: for ($version=1;$version<=$returnhash{'version'};$version++) {
5065: foreach my $id (keys(%regraded)) {
5066: if (($returnhash{$version.':'.$id.'.regrader'}) &&
5067: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
5068: ($returnhash{$version.':'.$id.'.award'} eq '')) {
5069: push(@{$resets{$id}},$version);
1.1199 raeburn 5070: }
5071: }
5072: }
1.1200 raeburn 5073: }
5074: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 5075: my (@hidden,@unsolved);
1.945 raeburn 5076: if (%typeparts) {
5077: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 5078: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
5079: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 5080: push(@hidden,$id);
1.1199 raeburn 5081: } elsif ($identifier ne '') {
5082: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
5083: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
5084: ($hidestatus{$id})) {
1.1200 raeburn 5085: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 5086: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
5087: push(@{$solved{$id}},$version);
5088: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
5089: (ref($solved{$id}) eq 'ARRAY')) {
5090: my $skip;
5091: if (ref($resets{$id}) eq 'ARRAY') {
5092: foreach my $reset (@{$resets{$id}}) {
5093: if ($reset > $solved{$id}[-1]) {
5094: $skip=1;
5095: last;
5096: }
5097: }
5098: }
5099: unless ($skip) {
5100: my ($ign,$partslist) = split(/\./,$id,2);
5101: push(@unsolved,$partslist);
5102: }
5103: }
5104: }
1.945 raeburn 5105: }
5106: }
5107: }
5108: $prevattempts.=&start_data_table_row().
1.1199 raeburn 5109: '<td>'.&mt('Transaction [_1]',$version);
5110: if (@unsolved) {
5111: $prevattempts .= '<span class="LC_nobreak"><label>'.
5112: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
5113: &mt('Hide').'</label></span>';
5114: }
5115: $prevattempts .= '</td>';
1.945 raeburn 5116: if (@hidden) {
5117: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5118: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5119: my $hide;
5120: foreach my $id (@hidden) {
5121: if ($key =~ /^\Q$id\E/) {
5122: $hide = 1;
5123: last;
5124: }
5125: }
5126: if ($hide) {
5127: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5128: if (($data eq 'award') || ($data eq 'awarddetail')) {
5129: my $value = &format_previous_attempt_value($key,
5130: $returnhash{$version.':'.$key});
1.1173 kruse 5131: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5132: } else {
5133: $prevattempts.='<td> </td>';
5134: }
5135: } else {
5136: if ($key =~ /\./) {
1.1212 raeburn 5137: my $value = $returnhash{$version.':'.$key};
5138: if ($key =~ /\.rndseed$/) {
5139: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5140: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5141: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5142: }
5143: }
5144: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5145: ' </td>';
1.945 raeburn 5146: } else {
5147: $prevattempts.='<td> </td>';
5148: }
5149: }
5150: }
5151: } else {
5152: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5153: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 5154: my $value = $returnhash{$version.':'.$key};
5155: if ($key =~ /\.rndseed$/) {
5156: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5157: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5158: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5159: }
5160: }
5161: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5162: ' </td>';
1.945 raeburn 5163: }
5164: }
5165: $prevattempts.=&end_data_table_row();
1.40 ng 5166: }
1.1 albertel 5167: }
1.945 raeburn 5168: my @currhidden = keys(%lasthidden);
1.596 albertel 5169: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 5170: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5171: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5172: if (%typeparts) {
5173: my $hidden;
5174: foreach my $id (@currhidden) {
5175: if ($key =~ /^\Q$id\E/) {
5176: $hidden = 1;
5177: last;
5178: }
5179: }
5180: if ($hidden) {
5181: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5182: if (($data eq 'award') || ($data eq 'awarddetail')) {
5183: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5184: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5185: $value = &$gradesub($value);
5186: }
1.1173 kruse 5187: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5188: } else {
5189: $prevattempts.='<td> </td>';
5190: }
5191: } else {
5192: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5193: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5194: $value = &$gradesub($value);
5195: }
1.1173 kruse 5196: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5197: }
5198: } else {
5199: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5200: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5201: $value = &$gradesub($value);
5202: }
1.1173 kruse 5203: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5204: }
1.16 harris41 5205: }
1.596 albertel 5206: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5207: } else {
1.1305 raeburn 5208: my $msg;
5209: if ($symb =~ /ext\.tool$/) {
5210: $msg = &mt('No grade passed back.');
5211: } else {
5212: $msg = &mt('Nothing submitted - no attempts.');
5213: }
1.596 albertel 5214: $prevattempts=
5215: &start_data_table().&start_data_table_row().
1.1305 raeburn 5216: '<td>'.$msg.'</td>'.
1.596 albertel 5217: &end_data_table_row().&end_data_table();
1.1 albertel 5218: }
5219: } else {
1.596 albertel 5220: $prevattempts=
5221: &start_data_table().&start_data_table_row().
5222: '<td>'.&mt('No data.').'</td>'.
5223: &end_data_table_row().&end_data_table();
1.1 albertel 5224: }
1.10 albertel 5225: }
5226:
1.581 albertel 5227: sub format_previous_attempt_value {
5228: my ($key,$value) = @_;
1.1011 www 5229: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5230: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5231: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5232: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5233: } elsif ($key =~ /answerstring$/) {
5234: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5235: my @answer = %answers;
5236: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5237: my @anskeys = sort(keys(%answers));
5238: if (@anskeys == 1) {
5239: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5240: if ($answer =~ m{\0}) {
5241: $answer =~ s{\0}{,}g;
1.988 raeburn 5242: }
5243: my $tag_internal_answer_name = 'INTERNAL';
5244: if ($anskeys[0] eq $tag_internal_answer_name) {
5245: $value = $answer;
5246: } else {
5247: $value = $anskeys[0].'='.$answer;
5248: }
5249: } else {
5250: foreach my $ans (@anskeys) {
5251: my $answer = $answers{$ans};
1.1001 raeburn 5252: if ($answer =~ m{\0}) {
5253: $answer =~ s{\0}{,}g;
1.988 raeburn 5254: }
5255: $value .= $ans.'='.$answer.'<br />';;
5256: }
5257: }
1.581 albertel 5258: } else {
1.1173 kruse 5259: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5260: }
5261: return $value;
5262: }
5263:
5264:
1.107 albertel 5265: sub relative_to_absolute {
5266: my ($url,$output)=@_;
5267: my $parser=HTML::TokeParser->new(\$output);
5268: my $token;
5269: my $thisdir=$url;
5270: my @rlinks=();
5271: while ($token=$parser->get_token) {
5272: if ($token->[0] eq 'S') {
5273: if ($token->[1] eq 'a') {
5274: if ($token->[2]->{'href'}) {
5275: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5276: }
5277: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5278: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5279: } elsif ($token->[1] eq 'base') {
5280: $thisdir=$token->[2]->{'href'};
5281: }
5282: }
5283: }
5284: $thisdir=~s-/[^/]*$--;
1.356 albertel 5285: foreach my $link (@rlinks) {
1.726 raeburn 5286: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5287: ($link=~/^\//) ||
5288: ($link=~/^javascript:/i) ||
5289: ($link=~/^mailto:/i) ||
5290: ($link=~/^\#/)) {
5291: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5292: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5293: }
5294: }
5295: # -------------------------------------------------- Deal with Applet codebases
5296: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5297: return $output;
5298: }
5299:
1.112 bowersj2 5300: =pod
5301:
1.648 raeburn 5302: =item * &get_student_view()
1.112 bowersj2 5303:
5304: show a snapshot of what student was looking at
5305:
5306: =cut
5307:
1.10 albertel 5308: sub get_student_view {
1.186 albertel 5309: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5310: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5311: my (%form);
1.10 albertel 5312: my @elements=('symb','courseid','domain','username');
5313: foreach my $element (@elements) {
1.186 albertel 5314: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5315: }
1.186 albertel 5316: if (defined($moreenv)) {
5317: %form=(%form,%{$moreenv});
5318: }
1.236 albertel 5319: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5320: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5321: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5322: $feedurl =~ s{^/adm/wrapper}{};
5323: }
1.650 www 5324: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5325: $userview=~s/\<body[^\>]*\>//gi;
5326: $userview=~s/\<\/body\>//gi;
5327: $userview=~s/\<html\>//gi;
5328: $userview=~s/\<\/html\>//gi;
5329: $userview=~s/\<head\>//gi;
5330: $userview=~s/\<\/head\>//gi;
5331: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5332: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5333: if (wantarray) {
5334: return ($userview,$response);
5335: } else {
5336: return $userview;
5337: }
5338: }
5339:
5340: sub get_student_view_with_retries {
5341: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5342:
5343: my $ok = 0; # True if we got a good response.
5344: my $content;
5345: my $response;
5346:
5347: # Try to get the student_view done. within the retries count:
5348:
5349: do {
5350: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5351: $ok = $response->is_success;
5352: if (!$ok) {
5353: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5354: }
5355: $retries--;
5356: } while (!$ok && ($retries > 0));
5357:
5358: if (!$ok) {
5359: $content = ''; # On error return an empty content.
5360: }
1.651 www 5361: if (wantarray) {
5362: return ($content, $response);
5363: } else {
5364: return $content;
5365: }
1.11 albertel 5366: }
5367:
1.1349 raeburn 5368: sub css_links {
5369: my ($currsymb,$level) = @_;
5370: my ($links,@symbs,%cssrefs,%httpref);
5371: if ($level eq 'map') {
5372: my $navmap = Apache::lonnavmaps::navmap->new();
5373: if (ref($navmap)) {
5374: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5375: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5376: foreach my $res (@resources) {
5377: if (ref($res) && $res->symb()) {
5378: push(@symbs,$res->symb());
5379: }
5380: }
5381: }
5382: } else {
5383: @symbs = ($currsymb);
5384: }
5385: foreach my $symb (@symbs) {
5386: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5387: if ($css_href =~ /\S/) {
5388: unless ($css_href =~ m{https?://}) {
5389: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5390: my $proburl = &Apache::lonnet::clutter($url);
5391: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5392: unless ($css_href =~ m{^/}) {
5393: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5394: }
5395: if ($css_href =~ m{^/(res|uploaded)/}) {
5396: unless (($httpref{'httpref.'.$css_href}) ||
5397: (&Apache::lonnet::is_on_map($css_href))) {
5398: my $thisurl = $proburl;
5399: if ($env{'httpref.'.$proburl}) {
5400: $thisurl = $env{'httpref.'.$proburl};
5401: }
5402: $httpref{'httpref.'.$css_href} = $thisurl;
5403: }
5404: }
5405: }
5406: $cssrefs{$css_href} = 1;
5407: }
5408: }
5409: if (keys(%httpref)) {
5410: &Apache::lonnet::appenv(\%httpref);
5411: }
5412: if (keys(%cssrefs)) {
5413: foreach my $css_href (keys(%cssrefs)) {
5414: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5415: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5416: }
5417: }
5418: return $links;
5419: }
5420:
1.112 bowersj2 5421: =pod
5422:
1.648 raeburn 5423: =item * &get_student_answers()
1.112 bowersj2 5424:
5425: show a snapshot of how student was answering problem
5426:
5427: =cut
5428:
1.11 albertel 5429: sub get_student_answers {
1.100 sakharuk 5430: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5431: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5432: my (%moreenv);
1.11 albertel 5433: my @elements=('symb','courseid','domain','username');
5434: foreach my $element (@elements) {
1.186 albertel 5435: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5436: }
1.186 albertel 5437: $moreenv{'grade_target'}='answer';
5438: %moreenv=(%form,%moreenv);
1.497 raeburn 5439: $feedurl = &Apache::lonnet::clutter($feedurl);
5440: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5441: return $userview;
1.1 albertel 5442: }
1.116 albertel 5443:
5444: =pod
5445:
5446: =item * &submlink()
5447:
1.242 albertel 5448: Inputs: $text $uname $udom $symb $target
1.116 albertel 5449:
5450: Returns: A link to grades.pm such as to see the SUBM view of a student
5451:
5452: =cut
5453:
5454: ###############################################
5455: sub submlink {
1.242 albertel 5456: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5457: if (!($uname && $udom)) {
5458: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5459: &Apache::lonnet::whichuser($symb);
1.116 albertel 5460: if (!$symb) { $symb=$cursymb; }
5461: }
1.254 matthew 5462: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5463: $symb=&escape($symb);
1.960 bisitz 5464: if ($target) { $target=" target=\"$target\""; }
5465: return
5466: '<a href="/adm/grades?command=submission'.
5467: '&symb='.$symb.
5468: '&student='.$uname.
5469: '&userdom='.$udom.'"'.
5470: $target.'>'.$text.'</a>';
1.242 albertel 5471: }
5472: ##############################################
5473:
5474: =pod
5475:
5476: =item * &pgrdlink()
5477:
5478: Inputs: $text $uname $udom $symb $target
5479:
5480: Returns: A link to grades.pm such as to see the PGRD view of a student
5481:
5482: =cut
5483:
5484: ###############################################
5485: sub pgrdlink {
5486: my $link=&submlink(@_);
5487: $link=~s/(&command=submission)/$1&showgrading=yes/;
5488: return $link;
5489: }
5490: ##############################################
5491:
5492: =pod
5493:
5494: =item * &pprmlink()
5495:
5496: Inputs: $text $uname $udom $symb $target
5497:
5498: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5499: student and a specific resource
1.242 albertel 5500:
5501: =cut
5502:
5503: ###############################################
5504: sub pprmlink {
5505: my ($text,$uname,$udom,$symb,$target)=@_;
5506: if (!($uname && $udom)) {
5507: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5508: &Apache::lonnet::whichuser($symb);
1.242 albertel 5509: if (!$symb) { $symb=$cursymb; }
5510: }
1.254 matthew 5511: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5512: $symb=&escape($symb);
1.242 albertel 5513: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5514: return '<a href="/adm/parmset?command=set&'.
5515: 'symb='.$symb.'&uname='.$uname.
5516: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5517: }
5518: ##############################################
1.37 matthew 5519:
1.112 bowersj2 5520: =pod
5521:
5522: =back
5523:
5524: =cut
5525:
1.37 matthew 5526: ###############################################
1.51 www 5527:
5528:
5529: sub timehash {
1.687 raeburn 5530: my ($thistime) = @_;
5531: my $timezone = &Apache::lonlocal::gettimezone();
5532: my $dt = DateTime->from_epoch(epoch => $thistime)
5533: ->set_time_zone($timezone);
5534: my $wday = $dt->day_of_week();
5535: if ($wday == 7) { $wday = 0; }
5536: return ( 'second' => $dt->second(),
5537: 'minute' => $dt->minute(),
5538: 'hour' => $dt->hour(),
5539: 'day' => $dt->day_of_month(),
5540: 'month' => $dt->month(),
5541: 'year' => $dt->year(),
5542: 'weekday' => $wday,
5543: 'dayyear' => $dt->day_of_year(),
5544: 'dlsav' => $dt->is_dst() );
1.51 www 5545: }
5546:
1.370 www 5547: sub utc_string {
5548: my ($date)=@_;
1.371 www 5549: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5550: }
5551:
1.51 www 5552: sub maketime {
5553: my %th=@_;
1.687 raeburn 5554: my ($epoch_time,$timezone,$dt);
5555: $timezone = &Apache::lonlocal::gettimezone();
5556: eval {
5557: $dt = DateTime->new( year => $th{'year'},
5558: month => $th{'month'},
5559: day => $th{'day'},
5560: hour => $th{'hour'},
5561: minute => $th{'minute'},
5562: second => $th{'second'},
5563: time_zone => $timezone,
5564: );
5565: };
5566: if (!$@) {
5567: $epoch_time = $dt->epoch;
5568: if ($epoch_time) {
5569: return $epoch_time;
5570: }
5571: }
1.51 www 5572: return POSIX::mktime(
5573: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5574: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5575: }
5576:
5577: #########################################
1.51 www 5578:
5579: sub findallcourses {
1.482 raeburn 5580: my ($roles,$uname,$udom) = @_;
1.355 albertel 5581: my %roles;
5582: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5583: my %courses;
1.51 www 5584: my $now=time;
1.482 raeburn 5585: if (!defined($uname)) {
5586: $uname = $env{'user.name'};
5587: }
5588: if (!defined($udom)) {
5589: $udom = $env{'user.domain'};
5590: }
5591: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5592: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5593: if (!%roles) {
5594: %roles = (
5595: cc => 1,
1.907 raeburn 5596: co => 1,
1.482 raeburn 5597: in => 1,
5598: ep => 1,
5599: ta => 1,
5600: cr => 1,
5601: st => 1,
5602: );
5603: }
5604: foreach my $entry (keys(%roleshash)) {
5605: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5606: if ($trole =~ /^cr/) {
5607: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5608: } else {
5609: next if (!exists($roles{$trole}));
5610: }
5611: if ($tend) {
5612: next if ($tend < $now);
5613: }
5614: if ($tstart) {
5615: next if ($tstart > $now);
5616: }
1.1058 raeburn 5617: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5618: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5619: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5620: if ($secpart eq '') {
5621: ($cnum,$role) = split(/_/,$cnumpart);
5622: $sec = 'none';
1.1058 raeburn 5623: $value .= $cnum.'/';
1.482 raeburn 5624: } else {
5625: $cnum = $cnumpart;
5626: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5627: $value .= $cnum.'/'.$sec;
5628: }
5629: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5630: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5631: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5632: }
5633: } else {
5634: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5635: }
1.482 raeburn 5636: }
5637: } else {
5638: foreach my $key (keys(%env)) {
1.483 albertel 5639: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5640: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5641: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5642: next if ($role eq 'ca' || $role eq 'aa');
5643: next if (%roles && !exists($roles{$role}));
5644: my ($starttime,$endtime)=split(/\./,$env{$key});
5645: my $active=1;
5646: if ($starttime) {
5647: if ($now<$starttime) { $active=0; }
5648: }
5649: if ($endtime) {
5650: if ($now>$endtime) { $active=0; }
5651: }
5652: if ($active) {
1.1058 raeburn 5653: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5654: if ($sec eq '') {
5655: $sec = 'none';
1.1058 raeburn 5656: } else {
5657: $value .= $sec;
5658: }
5659: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5660: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5661: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5662: }
5663: } else {
5664: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5665: }
1.474 raeburn 5666: }
5667: }
1.51 www 5668: }
5669: }
1.474 raeburn 5670: return %courses;
1.51 www 5671: }
1.37 matthew 5672:
1.54 www 5673: ###############################################
1.474 raeburn 5674:
5675: sub blockcheck {
1.1372 raeburn 5676: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5677: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5678: my ($has_evb,$check_ipaccess);
5679: my $dom = $env{'user.domain'};
5680: if ($env{'request.course.id'}) {
5681: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5682: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5683: my $checkrole = "cm./$cdom/$cnum";
5684: my $sec = $env{'request.course.sec'};
5685: if ($sec ne '') {
5686: $checkrole .= "/$sec";
5687: }
5688: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5689: ($env{'request.role'} !~ /^st/)) {
5690: $has_evb = 1;
5691: }
5692: unless ($has_evb) {
5693: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
5694: ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
5695: if ($udom eq $cdom) {
5696: $check_ipaccess = 1;
5697: }
5698: }
5699: }
1.1375 raeburn 5700: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5701: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5702: my $checkrole;
5703: if ($env{'request.role.domain'} eq '') {
5704: $checkrole = "cm./$env{'user.domain'}/";
5705: } else {
5706: $checkrole = "cm./$env{'request.role.domain'}/";
5707: }
5708: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5709: $has_evb = 1;
5710: }
1.1372 raeburn 5711: }
5712: unless ($has_evb || $check_ipaccess) {
5713: my @machinedoms = &Apache::lonnet::current_machine_domains();
5714: if (($dom eq 'public') && ($activity eq 'port')) {
5715: $dom = $udom;
5716: }
5717: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5718: $check_ipaccess = 1;
5719: } else {
5720: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5721: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5722: my $prim = &Apache::lonnet::domain($dom,'primary');
5723: my $intdom = &Apache::lonnet::internet_dom($prim);
5724: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5725: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5726: $check_ipaccess = 1;
5727: }
5728: }
5729: }
5730: }
5731: if ($check_ipaccess) {
5732: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5733: unless (defined($cached)) {
5734: my %domconfig =
5735: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5736: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5737: }
5738: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5739: foreach my $id (keys(%{$ipaccessref})) {
5740: if (ref($ipaccessref->{$id}) eq 'HASH') {
5741: my $range = $ipaccessref->{$id}->{'ip'};
5742: if ($range) {
5743: if (&Apache::lonnet::ip_match($clientip,$range)) {
5744: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5745: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5746: return ('','','',$id,$dom);
5747: last;
5748: }
5749: }
5750: }
5751: }
5752: }
5753: }
5754: }
5755: }
1.1373 raeburn 5756: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5757: return ();
5758: }
1.1372 raeburn 5759: }
1.1189 raeburn 5760: if (defined($udom) && defined($uname)) {
5761: # If uname and udom are for a course, check for blocks in the course.
5762: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5763: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5764: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5765: return ($startblock,$endblock,$triggerblock);
5766: }
5767: } else {
1.490 raeburn 5768: $udom = $env{'user.domain'};
5769: $uname = $env{'user.name'};
5770: }
5771:
1.502 raeburn 5772: my $startblock = 0;
5773: my $endblock = 0;
1.1062 raeburn 5774: my $triggerblock = '';
1.1373 raeburn 5775: my %live_courses;
5776: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5777: %live_courses = &findallcourses(undef,$uname,$udom);
5778: }
1.474 raeburn 5779:
1.490 raeburn 5780: # If uname is for a user, and activity is course-specific, i.e.,
5781: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5782:
1.490 raeburn 5783: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5784: $activity eq 'groups' || $activity eq 'printout' ||
1.1346 raeburn 5785: $activity eq 'search' || $activity eq 'reinit' ||
5786: $activity eq 'alert') &&
1.1189 raeburn 5787: ($env{'request.course.id'})) {
1.490 raeburn 5788: foreach my $key (keys(%live_courses)) {
5789: if ($key ne $env{'request.course.id'}) {
5790: delete($live_courses{$key});
5791: }
5792: }
5793: }
5794:
5795: my $otheruser = 0;
5796: my %own_courses;
5797: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5798: # Resource belongs to user other than current user.
5799: $otheruser = 1;
5800: # Gather courses for current user
5801: %own_courses =
5802: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5803: }
5804:
5805: # Gather active course roles - course coordinator, instructor,
5806: # exam proctor, ta, student, or custom role.
1.474 raeburn 5807:
5808: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5809: my ($cdom,$cnum);
5810: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5811: $cdom = $env{'course.'.$course.'.domain'};
5812: $cnum = $env{'course.'.$course.'.num'};
5813: } else {
1.490 raeburn 5814: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5815: }
5816: my $no_ownblock = 0;
5817: my $no_userblock = 0;
1.533 raeburn 5818: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5819: # Check if current user has 'evb' priv for this
5820: if (defined($own_courses{$course})) {
5821: foreach my $sec (keys(%{$own_courses{$course}})) {
5822: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5823: if ($sec ne 'none') {
5824: $checkrole .= '/'.$sec;
5825: }
5826: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5827: $no_ownblock = 1;
5828: last;
5829: }
5830: }
5831: }
5832: # if they have 'evb' priv and are currently not playing student
5833: next if (($no_ownblock) &&
5834: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5835: }
1.474 raeburn 5836: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5837: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5838: if ($sec ne 'none') {
1.482 raeburn 5839: $checkrole .= '/'.$sec;
1.474 raeburn 5840: }
1.490 raeburn 5841: if ($otheruser) {
5842: # Resource belongs to user other than current user.
5843: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5844: my (%allroles,%userroles);
5845: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5846: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5847: my ($trole,$tdom,$tnum,$tsec);
5848: if ($entry =~ /^cr/) {
5849: ($trole,$tdom,$tnum,$tsec) =
5850: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5851: } else {
5852: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5853: }
5854: my ($spec,$area,$trest);
5855: $area = '/'.$tdom.'/'.$tnum;
5856: $trest = $tnum;
5857: if ($tsec ne '') {
5858: $area .= '/'.$tsec;
5859: $trest .= '/'.$tsec;
5860: }
5861: $spec = $trole.'.'.$area;
5862: if ($trole =~ /^cr/) {
5863: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5864: $tdom,$spec,$trest,$area);
5865: } else {
5866: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5867: $tdom,$spec,$trest,$area);
5868: }
5869: }
1.1276 raeburn 5870: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5871: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5872: if ($1) {
5873: $no_userblock = 1;
5874: last;
5875: }
1.486 raeburn 5876: }
5877: }
1.490 raeburn 5878: } else {
5879: # Resource belongs to current user
5880: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5881: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5882: $no_ownblock = 1;
5883: last;
5884: }
1.474 raeburn 5885: }
5886: }
5887: # if they have the evb priv and are currently not playing student
1.482 raeburn 5888: next if (($no_ownblock) &&
1.491 albertel 5889: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5890: next if ($no_userblock);
1.474 raeburn 5891:
1.1303 raeburn 5892: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5893: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5894:
1.1062 raeburn 5895: my ($start,$end,$trigger) =
1.1347 raeburn 5896: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5897: if (($start != 0) &&
5898: (($startblock == 0) || ($startblock > $start))) {
5899: $startblock = $start;
1.1062 raeburn 5900: if ($trigger ne '') {
5901: $triggerblock = $trigger;
5902: }
1.502 raeburn 5903: }
5904: if (($end != 0) &&
5905: (($endblock == 0) || ($endblock < $end))) {
5906: $endblock = $end;
1.1062 raeburn 5907: if ($trigger ne '') {
5908: $triggerblock = $trigger;
5909: }
1.502 raeburn 5910: }
1.490 raeburn 5911: }
1.1062 raeburn 5912: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5913: }
5914:
5915: sub get_blocks {
1.1347 raeburn 5916: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5917: my $startblock = 0;
5918: my $endblock = 0;
1.1062 raeburn 5919: my $triggerblock = '';
1.490 raeburn 5920: my $course = $cdom.'_'.$cnum;
5921: $setters->{$course} = {};
5922: $setters->{$course}{'staff'} = [];
5923: $setters->{$course}{'times'} = [];
1.1062 raeburn 5924: $setters->{$course}{'triggers'} = [];
5925: my (@blockers,%triggered);
5926: my $now = time;
5927: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5928: if ($activity eq 'docs') {
1.1348 raeburn 5929: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5930: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5931: $blocked = 1;
5932: $nosymbcache = 1;
1.1348 raeburn 5933: $noenccheck = 1;
1.1347 raeburn 5934: }
1.1348 raeburn 5935: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5936: foreach my $block (@blockers) {
5937: if ($block =~ /^firstaccess____(.+)$/) {
5938: my $item = $1;
5939: my $type = 'map';
5940: my $timersymb = $item;
5941: if ($item eq 'course') {
5942: $type = 'course';
5943: } elsif ($item =~ /___\d+___/) {
5944: $type = 'resource';
5945: } else {
5946: $timersymb = &Apache::lonnet::symbread($item);
5947: }
5948: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5949: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5950: $triggered{$block} = {
5951: start => $start,
5952: end => $end,
5953: type => $type,
5954: };
5955: }
5956: }
5957: } else {
5958: foreach my $block (keys(%commblocks)) {
5959: if ($block =~ m/^(\d+)____(\d+)$/) {
5960: my ($start,$end) = ($1,$2);
5961: if ($start <= time && $end >= time) {
5962: if (ref($commblocks{$block}) eq 'HASH') {
5963: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5964: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5965: unless(grep(/^\Q$block\E$/,@blockers)) {
5966: push(@blockers,$block);
5967: }
5968: }
5969: }
5970: }
5971: }
5972: } elsif ($block =~ /^firstaccess____(.+)$/) {
5973: my $item = $1;
5974: my $timersymb = $item;
5975: my $type = 'map';
5976: if ($item eq 'course') {
5977: $type = 'course';
5978: } elsif ($item =~ /___\d+___/) {
5979: $type = 'resource';
5980: } else {
5981: $timersymb = &Apache::lonnet::symbread($item);
5982: }
5983: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5984: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5985: if ($start && $end) {
5986: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5987: if (ref($commblocks{$block}) eq 'HASH') {
5988: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5989: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5990: unless(grep(/^\Q$block\E$/,@blockers)) {
5991: push(@blockers,$block);
5992: $triggered{$block} = {
5993: start => $start,
5994: end => $end,
5995: type => $type,
5996: };
5997: }
5998: }
5999: }
1.1062 raeburn 6000: }
6001: }
1.490 raeburn 6002: }
1.1062 raeburn 6003: }
6004: }
6005: }
6006: foreach my $blocker (@blockers) {
6007: my ($staff_name,$staff_dom,$title,$blocks) =
6008: &parse_block_record($commblocks{$blocker});
6009: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
6010: my ($start,$end,$triggertype);
6011: if ($blocker =~ m/^(\d+)____(\d+)$/) {
6012: ($start,$end) = ($1,$2);
6013: } elsif (ref($triggered{$blocker}) eq 'HASH') {
6014: $start = $triggered{$blocker}{'start'};
6015: $end = $triggered{$blocker}{'end'};
6016: $triggertype = $triggered{$blocker}{'type'};
6017: }
6018: if ($start) {
6019: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6020: if ($triggertype) {
6021: push(@{$$setters{$course}{'triggers'}},$triggertype);
6022: } else {
6023: push(@{$$setters{$course}{'triggers'}},0);
6024: }
6025: if ( ($startblock == 0) || ($startblock > $start) ) {
6026: $startblock = $start;
6027: if ($triggertype) {
6028: $triggerblock = $blocker;
1.474 raeburn 6029: }
6030: }
1.1062 raeburn 6031: if ( ($endblock == 0) || ($endblock < $end) ) {
6032: $endblock = $end;
6033: if ($triggertype) {
6034: $triggerblock = $blocker;
6035: }
6036: }
1.474 raeburn 6037: }
6038: }
1.1062 raeburn 6039: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6040: }
6041:
6042: sub parse_block_record {
6043: my ($record) = @_;
6044: my ($setuname,$setudom,$title,$blocks);
6045: if (ref($record) eq 'HASH') {
6046: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6047: $title = &unescape($record->{'event'});
6048: $blocks = $record->{'blocks'};
6049: } else {
6050: my @data = split(/:/,$record,3);
6051: if (scalar(@data) eq 2) {
6052: $title = $data[1];
6053: ($setuname,$setudom) = split(/@/,$data[0]);
6054: } else {
6055: ($setuname,$setudom,$title) = @data;
6056: }
6057: $blocks = { 'com' => 'on' };
6058: }
6059: return ($setuname,$setudom,$title,$blocks);
6060: }
6061:
1.854 kalberla 6062: sub blocking_status {
1.1372 raeburn 6063: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6064: my %setters;
1.890 droeschl 6065:
1.1061 raeburn 6066: # check for active blocking
1.1372 raeburn 6067: if ($clientip eq '') {
6068: $clientip = &Apache::lonnet::get_requestor_ip();
6069: }
6070: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6071: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6072: my $blocked = 0;
1.1372 raeburn 6073: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6074: $blocked = 1;
6075: }
1.890 droeschl 6076:
1.1061 raeburn 6077: # caller just wants to know whether a block is active
6078: if (!wantarray) { return $blocked; }
6079:
6080: # build a link to a popup window containing the details
6081: my $querystring = "?activity=$activity";
1.1351 raeburn 6082: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6083: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6084: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6085: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6086: } elsif ($activity eq 'docs') {
1.1347 raeburn 6087: my $showurl = &Apache::lonenc::check_encrypt($url);
6088: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6089: if ($symb) {
6090: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6091: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6092: }
1.1062 raeburn 6093: }
1.1061 raeburn 6094:
6095: my $output .= <<'END_MYBLOCK';
6096: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6097: var options = "width=" + w + ",height=" + h + ",";
6098: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6099: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6100: var newWin = window.open(url, wdwName, options);
6101: newWin.focus();
6102: }
1.890 droeschl 6103: END_MYBLOCK
1.854 kalberla 6104:
1.1061 raeburn 6105: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6106:
1.1061 raeburn 6107: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6108: my $text = &mt('Communication Blocked');
1.1217 raeburn 6109: my $class = 'LC_comblock';
1.1062 raeburn 6110: if ($activity eq 'docs') {
6111: $text = &mt('Content Access Blocked');
1.1217 raeburn 6112: $class = '';
1.1063 raeburn 6113: } elsif ($activity eq 'printout') {
6114: $text = &mt('Printing Blocked');
1.1232 raeburn 6115: } elsif ($activity eq 'passwd') {
6116: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6117: } elsif ($activity eq 'grades') {
6118: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6119: } elsif ($activity eq 'search') {
6120: $text = &mt('Search Blocked');
1.1282 raeburn 6121: } elsif ($activity eq 'alert') {
6122: $text = &mt('Checking Critical Messages Blocked');
6123: } elsif ($activity eq 'reinit') {
6124: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6125: } elsif ($activity eq 'about') {
6126: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6127: } elsif ($activity eq 'wishlist') {
6128: $text = &mt('Access to Stored Links Blocked');
6129: } elsif ($activity eq 'annotate') {
6130: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6131: }
1.1061 raeburn 6132: $output .= <<"END_BLOCK";
1.1217 raeburn 6133: <div class='$class'>
1.869 kalberla 6134: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6135: title='$text'>
6136: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6137: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6138: title='$text'>$text</a>
1.867 kalberla 6139: </div>
6140:
6141: END_BLOCK
1.474 raeburn 6142:
1.1061 raeburn 6143: return ($blocked, $output);
1.854 kalberla 6144: }
1.490 raeburn 6145:
1.60 matthew 6146: ###############################################
6147:
1.682 raeburn 6148: sub check_ip_acc {
1.1201 raeburn 6149: my ($acc,$clientip)=@_;
1.682 raeburn 6150: &Apache::lonxml::debug("acc is $acc");
6151: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6152: return 1;
6153: }
1.1339 raeburn 6154: my ($ip,$allowed);
6155: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6156: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6157: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6158: } else {
1.1350 raeburn 6159: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6160: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6161: }
1.682 raeburn 6162:
6163: my $name;
1.1219 raeburn 6164: my %access = (
6165: allowfrom => 1,
6166: denyfrom => 0,
6167: );
6168: my @allows;
6169: my @denies;
6170: foreach my $item (split(',',$acc)) {
6171: $item =~ s/^\s*//;
6172: $item =~ s/\s*$//;
6173: my $pattern;
6174: if ($item =~ /^\!(.+)$/) {
6175: push(@denies,$1);
6176: } else {
6177: push(@allows,$item);
6178: }
6179: }
6180: my $numdenies = scalar(@denies);
6181: my $numallows = scalar(@allows);
6182: my $count = 0;
6183: foreach my $pattern (@denies,@allows) {
6184: $count ++;
6185: my $acctype = 'allowfrom';
6186: if ($count <= $numdenies) {
6187: $acctype = 'denyfrom';
6188: }
1.682 raeburn 6189: if ($pattern =~ /\*$/) {
6190: #35.8.*
6191: $pattern=~s/\*//;
1.1219 raeburn 6192: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6193: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6194: #35.8.3.[34-56]
6195: my $low=$2;
6196: my $high=$3;
6197: $pattern=$1;
6198: if ($ip =~ /^\Q$pattern\E/) {
6199: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6200: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6201: }
6202: } elsif ($pattern =~ /^\*/) {
6203: #*.msu.edu
6204: $pattern=~s/\*//;
6205: if (!defined($name)) {
6206: use Socket;
6207: my $netaddr=inet_aton($ip);
6208: ($name)=gethostbyaddr($netaddr,AF_INET);
6209: }
1.1219 raeburn 6210: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6211: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6212: #127.0.0.1
1.1219 raeburn 6213: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6214: } else {
6215: #some.name.com
6216: if (!defined($name)) {
6217: use Socket;
6218: my $netaddr=inet_aton($ip);
6219: ($name)=gethostbyaddr($netaddr,AF_INET);
6220: }
1.1219 raeburn 6221: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6222: }
6223: if ($allowed =~ /^(0|1)$/) { last; }
6224: }
6225: if ($allowed eq '') {
6226: if ($numdenies && !$numallows) {
6227: $allowed = 1;
6228: } else {
6229: $allowed = 0;
1.682 raeburn 6230: }
6231: }
6232: return $allowed;
6233: }
6234:
6235: ###############################################
6236:
1.60 matthew 6237: =pod
6238:
1.112 bowersj2 6239: =head1 Domain Template Functions
6240:
6241: =over 4
6242:
6243: =item * &determinedomain()
1.60 matthew 6244:
6245: Inputs: $domain (usually will be undef)
6246:
1.63 www 6247: Returns: Determines which domain should be used for designs
1.60 matthew 6248:
6249: =cut
1.54 www 6250:
1.60 matthew 6251: ###############################################
1.63 www 6252: sub determinedomain {
6253: my $domain=shift;
1.531 albertel 6254: if (! $domain) {
1.60 matthew 6255: # Determine domain if we have not been given one
1.893 raeburn 6256: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6257: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6258: if ($env{'request.role.domain'}) {
6259: $domain=$env{'request.role.domain'};
1.60 matthew 6260: }
6261: }
1.63 www 6262: return $domain;
6263: }
6264: ###############################################
1.517 raeburn 6265:
1.518 albertel 6266: sub devalidate_domconfig_cache {
6267: my ($udom)=@_;
6268: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6269: }
6270:
6271: # ---------------------- Get domain configuration for a domain
6272: sub get_domainconf {
6273: my ($udom) = @_;
6274: my $cachetime=1800;
6275: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6276: if (defined($cached)) { return %{$result}; }
6277:
6278: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6279: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6280: my (%designhash,%legacy);
1.518 albertel 6281: if (keys(%domconfig) > 0) {
6282: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6283: if (keys(%{$domconfig{'login'}})) {
6284: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6285: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6286: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6287: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6288: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6289: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6290: if ($key eq 'loginvia') {
6291: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6292: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6293: $designhash{$udom.'.login.loginvia'} = $server;
6294: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6295:
6296: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6297: } else {
6298: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6299: }
1.948 raeburn 6300: }
1.1208 raeburn 6301: } elsif ($key eq 'headtag') {
6302: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6303: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6304: }
1.946 raeburn 6305: }
1.1208 raeburn 6306: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6307: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6308: }
1.946 raeburn 6309: }
6310: }
6311: }
1.1366 raeburn 6312: } elsif ($key eq 'saml') {
6313: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6314: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6315: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6316: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6317: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6318: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6319: }
6320: }
6321: }
6322: }
1.946 raeburn 6323: } else {
6324: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6325: $designhash{$udom.'.login.'.$key.'_'.$img} =
6326: $domconfig{'login'}{$key}{$img};
6327: }
1.699 raeburn 6328: }
6329: } else {
6330: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6331: }
1.632 raeburn 6332: }
6333: } else {
6334: $legacy{'login'} = 1;
1.518 albertel 6335: }
1.632 raeburn 6336: } else {
6337: $legacy{'login'} = 1;
1.518 albertel 6338: }
6339: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6340: if (keys(%{$domconfig{'rolecolors'}})) {
6341: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6342: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6343: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6344: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6345: }
1.518 albertel 6346: }
6347: }
1.632 raeburn 6348: } else {
6349: $legacy{'rolecolors'} = 1;
1.518 albertel 6350: }
1.632 raeburn 6351: } else {
6352: $legacy{'rolecolors'} = 1;
1.518 albertel 6353: }
1.948 raeburn 6354: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6355: if ($domconfig{'autoenroll'}{'co-owners'}) {
6356: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6357: }
6358: }
1.632 raeburn 6359: if (keys(%legacy) > 0) {
6360: my %legacyhash = &get_legacy_domconf($udom);
6361: foreach my $item (keys(%legacyhash)) {
6362: if ($item =~ /^\Q$udom\E\.login/) {
6363: if ($legacy{'login'}) {
6364: $designhash{$item} = $legacyhash{$item};
6365: }
6366: } else {
6367: if ($legacy{'rolecolors'}) {
6368: $designhash{$item} = $legacyhash{$item};
6369: }
1.518 albertel 6370: }
6371: }
6372: }
1.632 raeburn 6373: } else {
6374: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6375: }
6376: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6377: $cachetime);
6378: return %designhash;
6379: }
6380:
1.632 raeburn 6381: sub get_legacy_domconf {
6382: my ($udom) = @_;
6383: my %legacyhash;
6384: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6385: my $designfile = $designdir.'/'.$udom.'.tab';
6386: if (-e $designfile) {
1.1317 raeburn 6387: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6388: while (my $line = <$fh>) {
6389: next if ($line =~ /^\#/);
6390: chomp($line);
6391: my ($key,$val)=(split(/\=/,$line));
6392: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6393: }
6394: close($fh);
6395: }
6396: }
1.1026 raeburn 6397: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6398: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6399: }
6400: return %legacyhash;
6401: }
6402:
1.63 www 6403: =pod
6404:
1.112 bowersj2 6405: =item * &domainlogo()
1.63 www 6406:
6407: Inputs: $domain (usually will be undef)
6408:
6409: Returns: A link to a domain logo, if the domain logo exists.
6410: If the domain logo does not exist, a description of the domain.
6411:
6412: =cut
1.112 bowersj2 6413:
1.63 www 6414: ###############################################
6415: sub domainlogo {
1.517 raeburn 6416: my $domain = &determinedomain(shift);
1.518 albertel 6417: my %designhash = &get_domainconf($domain);
1.517 raeburn 6418: # See if there is a logo
6419: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6420: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6421: if ($imgsrc =~ m{^/(adm|res)/}) {
6422: if ($imgsrc =~ m{^/res/}) {
6423: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6424: &Apache::lonnet::repcopy($local_name);
6425: }
6426: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6427: }
6428: my $alttext = $domain;
6429: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6430: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6431: }
6432: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6433: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6434: return &Apache::lonnet::domain($domain,'description');
1.59 www 6435: } else {
1.60 matthew 6436: return '';
1.59 www 6437: }
6438: }
1.63 www 6439: ##############################################
6440:
6441: =pod
6442:
1.112 bowersj2 6443: =item * &designparm()
1.63 www 6444:
6445: Inputs: $which parameter; $domain (usually will be undef)
6446:
6447: Returns: value of designparamter $which
6448:
6449: =cut
1.112 bowersj2 6450:
1.397 albertel 6451:
1.400 albertel 6452: ##############################################
1.397 albertel 6453: sub designparm {
6454: my ($which,$domain)=@_;
6455: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6456: return $env{'environment.color.'.$which};
1.96 www 6457: }
1.63 www 6458: $domain=&determinedomain($domain);
1.1016 raeburn 6459: my %domdesign;
6460: unless ($domain eq 'public') {
6461: %domdesign = &get_domainconf($domain);
6462: }
1.520 raeburn 6463: my $output;
1.517 raeburn 6464: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6465: $output = $domdesign{$domain.'.'.$which};
1.63 www 6466: } else {
1.520 raeburn 6467: $output = $defaultdesign{$which};
6468: }
6469: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6470: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6471: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6472: if ($output =~ m{^/res/}) {
6473: my $local_name = &Apache::lonnet::filelocation('',$output);
6474: &Apache::lonnet::repcopy($local_name);
6475: }
1.520 raeburn 6476: $output = &lonhttpdurl($output);
6477: }
1.63 www 6478: }
1.520 raeburn 6479: return $output;
1.63 www 6480: }
1.59 www 6481:
1.822 bisitz 6482: ##############################################
6483: =pod
6484:
1.832 bisitz 6485: =item * &authorspace()
6486:
1.1028 raeburn 6487: Inputs: $url (usually will be undef).
1.832 bisitz 6488:
1.1132 raeburn 6489: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6490: directory being viewed (or for which action is being taken).
6491: If $url is provided, and begins /priv/<domain>/<uname>
6492: the path will be that portion of the $context argument.
6493: Otherwise the path will be for the author space of the current
6494: user when the current role is author, or for that of the
6495: co-author/assistant co-author space when the current role
6496: is co-author or assistant co-author.
1.832 bisitz 6497:
6498: =cut
6499:
6500: sub authorspace {
1.1028 raeburn 6501: my ($url) = @_;
6502: if ($url ne '') {
6503: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6504: return $1;
6505: }
6506: }
1.832 bisitz 6507: my $caname = '';
1.1024 www 6508: my $cadom = '';
1.1028 raeburn 6509: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6510: ($cadom,$caname) =
1.832 bisitz 6511: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6512: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6513: $caname = $env{'user.name'};
1.1024 www 6514: $cadom = $env{'user.domain'};
1.832 bisitz 6515: }
1.1028 raeburn 6516: if (($caname ne '') && ($cadom ne '')) {
6517: return "/priv/$cadom/$caname/";
6518: }
6519: return;
1.832 bisitz 6520: }
6521:
6522: ##############################################
6523: =pod
6524:
1.822 bisitz 6525: =item * &head_subbox()
6526:
6527: Inputs: $content (contains HTML code with page functions, etc.)
6528:
6529: Returns: HTML div with $content
6530: To be included in page header
6531:
6532: =cut
6533:
6534: sub head_subbox {
6535: my ($content)=@_;
6536: my $output =
1.993 raeburn 6537: '<div class="LC_head_subbox">'
1.822 bisitz 6538: .$content
6539: .'</div>'
6540: }
6541:
6542: ##############################################
6543: =pod
6544:
6545: =item * &CSTR_pageheader()
6546:
1.1026 raeburn 6547: Input: (optional) filename from which breadcrumb trail is built.
6548: In most cases no input as needed, as $env{'request.filename'}
6549: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6550: frameset flag
6551: If page header is being requested for use in a frameset, then
6552: the second (option) argument -- frameset will be true, and
6553: the target attribute set for links should be target="_parent".
1.1433 raeburn 6554: If $title is supplied as the third arg, that will be used to
1.1407 raeburn 6555: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6556:
6557: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6558: To be included on Authoring Space pages
1.822 bisitz 6559:
6560: =cut
6561:
6562: sub CSTR_pageheader {
1.1407 raeburn 6563: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6564: if ($trailfile eq '') {
6565: $trailfile = $env{'request.filename'};
6566: }
6567:
6568: # this is for resources; directories have customtitle, and crumbs
6569: # and select recent are created in lonpubdir.pm
6570:
6571: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6572: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6573: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6574: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6575: $formaction =~ s{/+}{/}g;
1.822 bisitz 6576:
6577: my $parentpath = '';
6578: my $lastitem = '';
6579: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6580: $parentpath = $1;
6581: $lastitem = $2;
6582: } else {
6583: $lastitem = $thisdisfn;
6584: }
1.921 bisitz 6585:
1.1406 raeburn 6586: my $crsauthor;
1.1246 raeburn 6587: if (($env{'request.course.id'}) &&
6588: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6589: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6590: $crsauthor = 1;
1.1406 raeburn 6591: if ($title eq '') {
6592: $title = &mt('Course Authoring Space');
6593: }
6594: } elsif ($title eq '') {
1.1246 raeburn 6595: $title = &mt('Authoring Space');
6596: }
6597:
1.1379 raeburn 6598: my ($target,$crumbtarget) = (' target="_top"','_top');
6599: if ($frameset) {
6600: $target = ' target="_parent"';
6601: $crumbtarget = '_parent';
6602: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6603: $target = '';
6604: $crumbtarget = '';
1.1379 raeburn 6605: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6606: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6607: $crumbtarget = $env{'request.deeplink.target'};
6608: }
1.1313 raeburn 6609:
1.921 bisitz 6610: my $output =
1.1407 raeburn 6611: '<div>'
1.822 bisitz 6612: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6613: .'<b>'.$title.'</b> '
1.1314 raeburn 6614: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6615: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6616:
6617: if ($lastitem) {
6618: $output .=
6619: '<span class="LC_filename">'
6620: .$lastitem
6621: .'</span>';
6622: }
1.1245 raeburn 6623:
1.1246 raeburn 6624: if ($crsauthor) {
1.1379 raeburn 6625: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6626: } else {
6627: $output .=
6628: '<br />'
1.1314 raeburn 6629: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6630: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6631: .'</form>'
1.1379 raeburn 6632: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6633: }
1.1407 raeburn 6634: $output .= '</div>';
1.921 bisitz 6635:
6636: return $output;
1.822 bisitz 6637: }
6638:
1.1419 raeburn 6639: ##############################################
6640: =pod
6641:
6642: =item * &nocodemirror()
6643:
6644: Input: None
6645:
6646: Returns: 1 if CodeMirror is deactivated based on
6647: user's preference, or domain default,
6648: if user indicated use of default.
6649:
6650: =cut
6651:
1.1416 raeburn 6652: sub nocodemirror {
6653: my $nocodem = $env{'environment.nocodemirror'};
6654: unless ($nocodem) {
6655: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6656: if ($domdefs{'nocodemirror'}) {
6657: $nocodem = 'yes';
6658: }
6659: }
1.1417 raeburn 6660: if ($nocodem eq 'yes') {
6661: return 1;
6662: }
6663: return;
1.1416 raeburn 6664: }
6665:
1.1419 raeburn 6666: ##############################################
6667: =pod
6668:
6669: =item * &permitted_editors()
6670:
1.1422 raeburn 6671: Input: $uri (optional)
1.1419 raeburn 6672:
6673: Returns: %editors hash in which keys are editors
1.1429 raeburn 6674: permitted in current Authoring Space,
6675: or in current course for web pages
6676: created in a course.
6677:
1.1419 raeburn 6678: Value for each key is 1. Possible keys
1.1429 raeburn 6679: are: edit, xml, and daxe.
6680:
6681: For a regular Authoring Space, if no specific
1.1419 raeburn 6682: set of editors has been set for the Author
6683: who owns the Authoring Space, then the
6684: domain default will be used. If no domain
6685: default has been set, then the keys will be
6686: edit and xml.
6687:
1.1429 raeburn 6688: For a course author, or for web pages created
6689: in a course, if no specific set of editors has
6690: been set for the course, then the domain
6691: course default will be used. If no domain
6692: course default has been set, then the keys
6693: will be edit and xml.
6694:
1.1419 raeburn 6695: =cut
6696:
1.1418 raeburn 6697: sub permitted_editors {
1.1422 raeburn 6698: my ($uri) = @_;
1.1429 raeburn 6699: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6700: if ($env{'request.role'} =~ m{^au\./}) {
6701: $is_author = 1;
6702: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6703: ($audom,$auname) = ($1,$2);
6704: if (($audom ne '') && ($auname ne '')) {
6705: if (($env{'user.domain'} eq $audom) &&
6706: ($env{'user.name'} eq $auname)) {
6707: $is_author = 1;
6708: } else {
6709: $is_coauthor = 1;
6710: }
6711: }
6712: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6713: my ($cdom,$cnum);
6714: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6715: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6716: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6717: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6718: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6719: $is_course = 1;
6720: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6721: ($audom,$auname) = ($1,$2);
6722: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6723: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6724: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6725: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6726: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6727: $is_course = 1;
6728: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6729: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6730: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6731: }
1.1429 raeburn 6732: unless ($is_course) {
6733: if (($audom ne '') && ($auname ne '')) {
6734: if (($env{'user.domain'} eq $audom) &&
6735: ($env{'user.name'} eq $auname)) {
6736: $is_author = 1;
6737: } else {
6738: $is_coauthor = 1;
6739: }
1.1418 raeburn 6740: }
6741: }
6742: }
6743: if ($is_author) {
6744: if (exists($env{'environment.editors'})) {
6745: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6746: } else {
6747: %editors = ( edit => 1,
6748: xml => 1,
6749: );
6750: }
6751: } elsif ($is_coauthor) {
6752: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6753: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6754: } else {
6755: %editors = ( edit => 1,
6756: xml => 1,
6757: );
6758: }
1.1429 raeburn 6759: } elsif ($is_course) {
6760: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6761: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6762: } else {
6763: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6764: if (exists($domdefaults{'crseditors'})) {
6765: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6766: } else {
6767: %editors = ( edit => 1,
6768: xml => 1,
6769: );
6770: }
6771: }
1.1418 raeburn 6772: } else {
6773: %editors = ( edit => 1,
6774: xml => 1,
6775: );
6776: }
6777: return %editors;
6778: }
6779:
1.60 matthew 6780: ###############################################
6781: ###############################################
6782:
6783: =pod
6784:
1.112 bowersj2 6785: =back
6786:
1.549 albertel 6787: =head1 HTML Helpers
1.112 bowersj2 6788:
6789: =over 4
6790:
6791: =item * &bodytag()
1.60 matthew 6792:
6793: Returns a uniform header for LON-CAPA web pages.
6794:
6795: Inputs:
6796:
1.112 bowersj2 6797: =over 4
6798:
6799: =item * $title, A title to be displayed on the page.
6800:
6801: =item * $function, the current role (can be undef).
6802:
6803: =item * $addentries, extra parameters for the <body> tag.
6804:
6805: =item * $bodyonly, if defined, only return the <body> tag.
6806:
6807: =item * $domain, if defined, force a given domain.
6808:
6809: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6810: text interface only)
1.60 matthew 6811:
1.814 bisitz 6812: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6813: navigational links
1.317 albertel 6814:
1.338 albertel 6815: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6816:
1.460 albertel 6817: =item * $args, optional argument valid values are
6818: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6819: use_absolute -> for external resource or syllabus, this will
6820: contain https://<hostname> if server uses
6821: https (as per hosts.tab), but request is for http
6822: hostname -> hostname, from $r->hostname().
1.460 albertel 6823:
1.1096 raeburn 6824: =item * $advtoolsref, optional argument, ref to an array containing
6825: inlineremote items to be added in "Functions" menu below
6826: breadcrumbs.
6827:
1.1316 raeburn 6828: =item * $ltiscope, optional argument, will be one of: resource, map or
6829: course, if LON-CAPA is in LTI Provider context. Value is
6830: the scope of use, i.e., launch was for access to a single, a map
6831: or the entire course.
6832:
6833: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6834: context, this will contain the URL for the landing item in
6835: the course, after launch from an LTI Consumer
6836:
1.1318 raeburn 6837: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6838: context, this will contain a reference to hash of items
6839: to be included in the page header and/or inline menu.
6840:
1.1385 raeburn 6841: =item * $menucoll, optional argument, if specific menu collection is in
6842: effect, either set as the default for the course, or set for
6843: the deeplink paramater for $env{'request.deeplink.login'}
6844: then $menucoll will be the number of that collection.
6845:
6846: =item * $menuref, optional argument, reference to a hash, containing the
6847: menu options included for the menu in effect, based on the
6848: configuration for the numbered menu collection in use.
6849:
6850: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6851: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6852: if so, $showncrumbsref is set there to 1, and will propagate back
6853: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6854: being called a second time.
6855:
1.112 bowersj2 6856: =back
6857:
1.60 matthew 6858: Returns: A uniform header for LON-CAPA web pages.
6859: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6860: If $bodyonly is undef or zero, an html string containing a <body> tag and
6861: other decorations will be returned.
6862:
6863: =cut
6864:
1.54 www 6865: sub bodytag {
1.831 bisitz 6866: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6867: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6868: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6869:
1.954 raeburn 6870: my $public;
6871: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6872: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6873: $public = 1;
6874: }
1.460 albertel 6875: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6876: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6877: my $hostname = $args->{'hostname'};
1.339 albertel 6878:
1.183 matthew 6879: $function = &get_users_function() if (!$function);
1.339 albertel 6880: my $img = &designparm($function.'.img',$domain);
6881: my $font = &designparm($function.'.font',$domain);
6882: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6883:
1.803 bisitz 6884: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6885: 'bgcolor' => $pgbg,
1.339 albertel 6886: 'text' => $font,
6887: 'alink' => &designparm($function.'.alink',$domain),
6888: 'vlink' => &designparm($function.'.vlink',$domain),
6889: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6890: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6891:
1.63 www 6892: # role and realm
1.1178 raeburn 6893: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6894: if ($realm) {
6895: $realm = '/'.$realm;
6896: }
1.1357 raeburn 6897: if ($role eq 'ca') {
1.479 albertel 6898: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6899: $realm = &plainname($rname,$rdom);
1.378 raeburn 6900: }
1.55 www 6901: # realm
1.1357 raeburn 6902: my ($cid,$sec);
1.258 albertel 6903: if ($env{'request.course.id'}) {
1.1357 raeburn 6904: $cid = $env{'request.course.id'};
6905: if ($env{'request.course.sec'}) {
6906: $sec = $env{'request.course.sec'};
6907: }
6908: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6909: if (&Apache::lonnet::is_course($1,$2)) {
6910: $cid = $1.'_'.$2;
6911: $sec = $3;
6912: }
6913: }
6914: if ($cid) {
1.378 raeburn 6915: if ($env{'request.role'} !~ /^cr/) {
6916: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6917: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6918: if ($env{'request.role.desc'}) {
6919: $role = $env{'request.role.desc'};
6920: } else {
6921: $role = &mt('Helpdesk[_1]',' '.$2);
6922: }
1.1257 raeburn 6923: } else {
6924: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6925: }
1.1357 raeburn 6926: if ($sec) {
6927: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6928: }
1.1357 raeburn 6929: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6930: } else {
6931: $role = &Apache::lonnet::plaintext($role);
1.54 www 6932: }
1.433 albertel 6933:
1.359 albertel 6934: if (!$realm) { $realm=' '; }
1.330 albertel 6935:
1.438 albertel 6936: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6937:
1.101 www 6938: # construct main body tag
1.359 albertel 6939: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6940: &Apache::lontexconvert::init_math_support();
1.252 albertel 6941:
1.1131 raeburn 6942: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6943:
1.1130 raeburn 6944: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6945: return $bodytag;
1.1130 raeburn 6946: }
1.359 albertel 6947:
1.954 raeburn 6948: if ($public) {
1.433 albertel 6949: undef($role);
6950: }
1.1318 raeburn 6951:
1.1359 raeburn 6952: my $showcrstitle = 1;
1.1357 raeburn 6953: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6954: if (ref($ltimenu) eq 'HASH') {
6955: unless ($ltimenu->{'role'}) {
6956: undef($role);
6957: }
6958: unless ($ltimenu->{'coursetitle'}) {
6959: $realm=' ';
1.1359 raeburn 6960: $showcrstitle = 0;
6961: }
6962: }
6963: } elsif (($cid) && ($menucoll)) {
6964: if (ref($menuref) eq 'HASH') {
6965: unless ($menuref->{'role'}) {
6966: undef($role);
6967: }
6968: unless ($menuref->{'crs'}) {
6969: $realm=' ';
6970: $showcrstitle = 0;
1.1318 raeburn 6971: }
6972: }
6973: }
6974:
1.762 bisitz 6975: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6976: #
6977: # Extra info if you are the DC
6978: my $dc_info = '';
1.1359 raeburn 6979: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6980: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6981: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6982: $dc_info =~ s/\s+$//;
1.359 albertel 6983: }
6984:
1.1237 raeburn 6985: my $crstype;
1.1357 raeburn 6986: if ($cid) {
6987: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6988: } elsif ($args->{'crstype'}) {
6989: $crstype = $args->{'crstype'};
6990: }
6991: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6992: undef($role);
6993: } else {
1.1242 raeburn 6994: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6995: }
1.853 droeschl 6996:
1.903 droeschl 6997: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6998:
6999: # if ($env{'request.state'} eq 'construct') {
7000: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7001: # }
7002:
1.1130 raeburn 7003: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 7004: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 7005:
1.1427 raeburn 7006: my $collapsible;
1.1423 raeburn 7007: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7008: $collapsible = 1;
7009: my ($menustate,$tiptext,$divclass);
7010: if ($args->{'start_collapsed'}) {
7011: $menustate = 'collapsed';
7012: $tiptext = 'display';
7013: $divclass = 'hidden';
7014: } else {
7015: $menustate = 'expanded';
7016: $tiptext = 'hide';
7017: $divclass = 'shown';
7018: }
7019: my $alttext = &mt('menu state: '.$menustate);
7020: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7021: $bodytag .= <<"END";
7022: <div id="LC_expandingContainer" style="display:inline;">
7023: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7024: <a href="#" style="text-decoration:none;"><img class="LC_collapsible_indicator" alt="$alttext" title="$tooltip" src="/res/adm/pages/$menustate.png" style="border:0;margin:0;padding:0;max-width:100%;height:auto" /></a></div>
7025: <div class="LC_menus_content $divclass">
1.1421 raeburn 7026: END
7027: }
1.1318 raeburn 7028: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7029: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7030: $args->{'links_disabled'},
1.1421 raeburn 7031: $args->{'links_target'},
1.1427 raeburn 7032: $collapsible);
1.359 albertel 7033:
1.1318 raeburn 7034: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7035: if ($dc_info) {
7036: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7037: }
7038: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7039: <em>$realm</em> $dc_info</div>|;
7040: return $bodytag;
7041: }
1.894 droeschl 7042:
1.1318 raeburn 7043: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7044: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7045: }
1.916 droeschl 7046:
1.1318 raeburn 7047: $bodytag .= $right;
1.852 droeschl 7048:
1.1318 raeburn 7049: if ($dc_info) {
7050: $dc_info = &dc_courseid_toggle($dc_info);
7051: }
7052: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7053: }
1.916 droeschl 7054:
1.1169 raeburn 7055: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7056: if ($args->{'no_secondary_menu'}) {
7057: return $bodytag;
7058: }
1.1169 raeburn 7059: #don't show menus for public users
1.954 raeburn 7060: if (!$public){
1.1318 raeburn 7061: unless ($args->{'no_inline_menu'}) {
7062: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7063: $args->{'no_primary_menu'},
1.1369 raeburn 7064: $menucoll,$menuref,
1.1380 raeburn 7065: $args->{'links_disabled'},
7066: $args->{'links_target'});
1.1318 raeburn 7067: }
1.903 droeschl 7068: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 7069: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7070: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7071: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7072: $args->{'bread_crumbs'},'','',$hostname,
7073: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7074: } elsif ($forcereg) {
7075: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7076: $args->{'group'},$args->{'hide_buttons'},
7077: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7078: } else {
7079: $bodytag .=
7080: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7081: $forcereg,$args->{'group'},
7082: $args->{'bread_crumbs'},
1.1274 raeburn 7083: $advtoolsref,'',$hostname);
1.920 raeburn 7084: }
1.903 droeschl 7085: }else{
7086: # this is to seperate menu from content when there's no secondary
7087: # menu. Especially needed for public accessible ressources.
7088: $bodytag .= '<hr style="clear:both" />';
7089: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 7090: }
1.1423 raeburn 7091: if ($args->{'collapsible_header'} ne '') {
7092: $bodytag .= $args->{'collapsible_header'}.
7093: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7094: '</div></div>';
7095: }
1.235 raeburn 7096: return $bodytag;
1.182 matthew 7097: }
7098:
1.917 raeburn 7099: sub dc_courseid_toggle {
7100: my ($dc_info) = @_;
1.980 raeburn 7101: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7102: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7103: &mt('(More ...)').'</a></span>'.
7104: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7105: }
7106:
1.330 albertel 7107: sub make_attr_string {
7108: my ($register,$attr_ref) = @_;
7109:
7110: if ($attr_ref && !ref($attr_ref)) {
7111: die("addentries Must be a hash ref ".
7112: join(':',caller(1))." ".
7113: join(':',caller(0))." ");
7114: }
7115:
7116: if ($register) {
1.339 albertel 7117: my ($on_load,$on_unload);
7118: foreach my $key (keys(%{$attr_ref})) {
7119: if (lc($key) eq 'onload') {
7120: $on_load.=$attr_ref->{$key}.';';
7121: delete($attr_ref->{$key});
7122:
7123: } elsif (lc($key) eq 'onunload') {
7124: $on_unload.=$attr_ref->{$key}.';';
7125: delete($attr_ref->{$key});
7126: }
7127: }
1.953 droeschl 7128: $attr_ref->{'onload'} = $on_load;
7129: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7130: }
1.339 albertel 7131:
1.330 albertel 7132: my $attr_string;
1.1159 raeburn 7133: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7134: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7135: }
7136: return $attr_string;
7137: }
7138:
7139:
1.182 matthew 7140: ###############################################
1.251 albertel 7141: ###############################################
7142:
7143: =pod
7144:
7145: =item * &endbodytag()
7146:
7147: Returns a uniform footer for LON-CAPA web pages.
7148:
1.635 raeburn 7149: Inputs: 1 - optional reference to an args hash
7150: If in the hash, key for noredirectlink has a value which evaluates to true,
7151: a 'Continue' link is not displayed if the page contains an
7152: internal redirect in the <head></head> section,
7153: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7154:
7155: =cut
7156:
7157: sub endbodytag {
1.635 raeburn 7158: my ($args) = @_;
1.1080 raeburn 7159: my $endbodytag;
7160: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7161: $endbodytag='</body>';
7162: }
1.315 albertel 7163: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7164: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7165: my ($endbodyjs,$idattr);
7166: if ($env{'internal.head.to_opener'}) {
7167: my $linkid = 'LC_continue_link';
7168: $idattr = ' id="'.$linkid.'"';
7169: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7170: $endbodyjs=<<ENDJS;
7171: <script type="text/javascript">
7172: // <![CDATA[
7173: function ebFunction(evt) {
7174: evt.preventDefault();
7175: var dest = '$redirect_for_js';
7176: if (window.opener != null && !window.opener.closed) {
7177: window.opener.location.href=dest;
7178: window.close();
7179: } else {
7180: window.location.href=dest;
7181: }
7182: return false;
7183: }
7184:
7185: \$(document).ready(function () {
7186: if (document.getElementById('$linkid')) {
7187: var clickelem = document.getElementById('$linkid');
7188: clickelem.addEventListener('click',ebFunction,false);
7189: }
7190: });
7191: // ]]>
7192: </script>
7193: ENDJS
7194: }
1.635 raeburn 7195: $endbodytag=
1.1386 raeburn 7196: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7197: &mt('Continue').'</a>'.
7198: $endbodytag;
7199: }
1.315 albertel 7200: }
1.1411 raeburn 7201: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7202: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7203: }
1.251 albertel 7204: return $endbodytag;
7205: }
7206:
1.352 albertel 7207: =pod
7208:
7209: =item * &standard_css()
7210:
7211: Returns a style sheet
7212:
7213: Inputs: (all optional)
7214: domain -> force to color decorate a page for a specific
7215: domain
7216: function -> force usage of a specific rolish color scheme
7217: bgcolor -> override the default page bgcolor
7218:
7219: =cut
7220:
1.343 albertel 7221: sub standard_css {
1.345 albertel 7222: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7223: $function = &get_users_function() if (!$function);
7224: my $img = &designparm($function.'.img', $domain);
7225: my $tabbg = &designparm($function.'.tabbg', $domain);
7226: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7227: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7228: #second colour for later usage
1.345 albertel 7229: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7230: my $pgbg_or_bgcolor =
7231: $bgcolor ||
1.352 albertel 7232: &designparm($function.'.pgbg', $domain);
1.382 albertel 7233: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7234: my $alink = &designparm($function.'.alink', $domain);
7235: my $vlink = &designparm($function.'.vlink', $domain);
7236: my $link = &designparm($function.'.link', $domain);
7237:
1.602 albertel 7238: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7239: my $mono = 'monospace';
1.850 bisitz 7240: my $data_table_head = $sidebg;
7241: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7242: my $data_table_dark = '#E0E0E0';
1.470 banghart 7243: my $data_table_darker = '#CCCCCC';
1.349 albertel 7244: my $data_table_highlight = '#FFFF00';
1.352 albertel 7245: my $mail_new = '#FFBB77';
7246: my $mail_new_hover = '#DD9955';
7247: my $mail_read = '#BBBB77';
7248: my $mail_read_hover = '#999944';
7249: my $mail_replied = '#AAAA88';
7250: my $mail_replied_hover = '#888855';
7251: my $mail_other = '#99BBBB';
7252: my $mail_other_hover = '#669999';
1.391 albertel 7253: my $table_header = '#DDDDDD';
1.489 raeburn 7254: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7255: my $lg_border_color = '#C8C8C8';
1.952 onken 7256: my $button_hover = '#BF2317';
1.392 albertel 7257:
1.608 albertel 7258: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7259: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7260: : '0 3px 0 4px';
1.448 albertel 7261:
1.523 albertel 7262:
1.343 albertel 7263: return <<END;
1.947 droeschl 7264:
7265: /* needed for iframe to allow 100% height in FF */
7266: body, html {
7267: margin: 0;
7268: padding: 0 0.5%;
7269: height: 99%; /* to avoid scrollbars */
7270: }
7271:
1.795 www 7272: body {
1.911 bisitz 7273: font-family: $sans;
7274: line-height:130%;
7275: font-size:0.83em;
7276: color:$font;
1.795 www 7277: }
7278:
1.959 onken 7279: a:focus,
7280: a:focus img {
1.795 www 7281: color: red;
7282: }
1.698 harmsja 7283:
1.911 bisitz 7284: form, .inline {
7285: display: inline;
1.795 www 7286: }
1.721 harmsja 7287:
1.1421 raeburn 7288: .LC_menus_content.shown{
1.1428 raeburn 7289: display: block;
1.1421 raeburn 7290: }
7291:
7292: .LC_menus_content.hidden {
7293: display: none;
7294: }
7295:
1.795 www 7296: .LC_right {
1.911 bisitz 7297: text-align:right;
1.795 www 7298: }
7299:
7300: .LC_middle {
1.911 bisitz 7301: vertical-align:middle;
1.795 www 7302: }
1.721 harmsja 7303:
1.1130 raeburn 7304: .LC_floatleft {
7305: float: left;
7306: }
7307:
7308: .LC_floatright {
7309: float: right;
7310: }
7311:
1.911 bisitz 7312: .LC_400Box {
7313: width:400px;
7314: }
1.721 harmsja 7315:
1.1421 raeburn 7316: #LC_collapsible_separator {
7317: border: 1px solid black;
7318: width: 99.9%;
7319: height: 0px;
7320: }
7321:
1.947 droeschl 7322: .LC_iframecontainer {
7323: width: 98%;
7324: margin: 0;
7325: position: fixed;
7326: top: 8.5em;
7327: bottom: 0;
7328: }
7329:
7330: .LC_iframecontainer iframe{
7331: border: none;
7332: width: 100%;
7333: height: 100%;
7334: }
7335:
1.778 bisitz 7336: .LC_filename {
7337: font-family: $mono;
7338: white-space:pre;
1.921 bisitz 7339: font-size: 120%;
1.778 bisitz 7340: }
7341:
7342: .LC_fileicon {
7343: border: none;
7344: height: 1.3em;
7345: vertical-align: text-bottom;
7346: margin-right: 0.3em;
7347: text-decoration:none;
7348: }
7349:
1.1008 www 7350: .LC_setting {
7351: text-decoration:underline;
7352: }
7353:
1.350 albertel 7354: .LC_error {
7355: color: red;
7356: }
1.795 www 7357:
1.1097 bisitz 7358: .LC_warning {
7359: color: darkorange;
7360: }
7361:
1.457 albertel 7362: .LC_diff_removed {
1.733 bisitz 7363: color: red;
1.394 albertel 7364: }
1.532 albertel 7365:
7366: .LC_info,
1.457 albertel 7367: .LC_success,
7368: .LC_diff_added {
1.350 albertel 7369: color: green;
7370: }
1.795 www 7371:
1.802 bisitz 7372: div.LC_confirm_box {
7373: background-color: #FAFAFA;
7374: border: 1px solid $lg_border_color;
7375: margin-right: 0;
7376: padding: 5px;
7377: }
7378:
7379: div.LC_confirm_box .LC_error img,
7380: div.LC_confirm_box .LC_success img {
7381: vertical-align: middle;
7382: }
7383:
1.1242 raeburn 7384: .LC_maxwidth {
7385: max-width: 100%;
7386: height: auto;
7387: }
7388:
1.1243 raeburn 7389: .LC_textsize_mobile {
7390: \@media only screen and (max-device-width: 480px) {
7391: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7392: }
7393: }
7394:
1.440 albertel 7395: .LC_icon {
1.771 droeschl 7396: border: none;
1.790 droeschl 7397: vertical-align: middle;
1.771 droeschl 7398: }
7399:
1.543 albertel 7400: .LC_docs_spacer {
7401: width: 25px;
7402: height: 1px;
1.771 droeschl 7403: border: none;
1.543 albertel 7404: }
1.346 albertel 7405:
1.532 albertel 7406: .LC_internal_info {
1.735 bisitz 7407: color: #999999;
1.532 albertel 7408: }
7409:
1.794 www 7410: .LC_discussion {
1.1050 www 7411: background: $data_table_dark;
1.911 bisitz 7412: border: 1px solid black;
7413: margin: 2px;
1.794 www 7414: }
7415:
7416: .LC_disc_action_left {
1.1050 www 7417: background: $sidebg;
1.911 bisitz 7418: text-align: left;
1.1050 www 7419: padding: 4px;
7420: margin: 2px;
1.794 www 7421: }
7422:
7423: .LC_disc_action_right {
1.1050 www 7424: background: $sidebg;
1.911 bisitz 7425: text-align: right;
1.1050 www 7426: padding: 4px;
7427: margin: 2px;
1.794 www 7428: }
7429:
7430: .LC_disc_new_item {
1.911 bisitz 7431: background: white;
7432: border: 2px solid red;
1.1050 www 7433: margin: 4px;
7434: padding: 4px;
1.794 www 7435: }
7436:
7437: .LC_disc_old_item {
1.911 bisitz 7438: background: white;
1.1050 www 7439: margin: 4px;
7440: padding: 4px;
1.794 www 7441: }
7442:
1.458 albertel 7443: table.LC_pastsubmission {
7444: border: 1px solid black;
7445: margin: 2px;
7446: }
7447:
1.924 bisitz 7448: table#LC_menubuttons {
1.345 albertel 7449: width: 100%;
7450: background: $pgbg;
1.392 albertel 7451: border: 2px;
1.402 albertel 7452: border-collapse: separate;
1.803 bisitz 7453: padding: 0;
1.345 albertel 7454: }
1.392 albertel 7455:
1.801 tempelho 7456: table#LC_title_bar a {
7457: color: $fontmenu;
7458: }
1.836 bisitz 7459:
1.807 droeschl 7460: table#LC_title_bar {
1.819 tempelho 7461: clear: both;
1.836 bisitz 7462: display: none;
1.807 droeschl 7463: }
7464:
1.795 www 7465: table#LC_title_bar,
1.933 droeschl 7466: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7467: table#LC_title_bar.LC_with_remote {
1.359 albertel 7468: width: 100%;
1.392 albertel 7469: border-color: $pgbg;
7470: border-style: solid;
7471: border-width: $border;
1.379 albertel 7472: background: $pgbg;
1.801 tempelho 7473: color: $fontmenu;
1.392 albertel 7474: border-collapse: collapse;
1.803 bisitz 7475: padding: 0;
1.819 tempelho 7476: margin: 0;
1.359 albertel 7477: }
1.795 www 7478:
1.933 droeschl 7479: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7480: margin: 0;
7481: padding: 0;
1.933 droeschl 7482: position: relative;
7483: list-style: none;
1.913 droeschl 7484: }
1.933 droeschl 7485: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7486: display: inline;
7487: }
1.933 droeschl 7488:
7489: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7490: padding: 0;
1.933 droeschl 7491: margin: 0;
7492: float: left;
1.913 droeschl 7493: }
1.933 droeschl 7494: .LC_breadcrumb_tools_tools {
7495: padding: 0;
7496: margin: 0;
1.913 droeschl 7497: float: right;
7498: }
7499:
1.1240 raeburn 7500: .LC_placement_prog {
7501: padding-right: 20px;
7502: font-weight: bold;
7503: font-size: 90%;
7504: }
7505:
1.359 albertel 7506: table#LC_title_bar td {
7507: background: $tabbg;
7508: }
1.795 www 7509:
1.911 bisitz 7510: table#LC_menubuttons img {
1.803 bisitz 7511: border: none;
1.346 albertel 7512: }
1.795 www 7513:
1.842 droeschl 7514: .LC_breadcrumbs_component {
1.911 bisitz 7515: float: right;
7516: margin: 0 1em;
1.357 albertel 7517: }
1.842 droeschl 7518: .LC_breadcrumbs_component img {
1.911 bisitz 7519: vertical-align: middle;
1.777 tempelho 7520: }
1.795 www 7521:
1.1243 raeburn 7522: .LC_breadcrumbs_hoverable {
7523: background: $sidebg;
7524: }
7525:
1.383 albertel 7526: td.LC_table_cell_checkbox {
7527: text-align: center;
7528: }
1.795 www 7529:
7530: .LC_fontsize_small {
1.911 bisitz 7531: font-size: 70%;
1.705 tempelho 7532: }
7533:
1.844 bisitz 7534: #LC_breadcrumbs {
1.911 bisitz 7535: clear:both;
7536: background: $sidebg;
7537: border-bottom: 1px solid $lg_border_color;
7538: line-height: 2.5em;
1.933 droeschl 7539: overflow: hidden;
1.911 bisitz 7540: margin: 0;
7541: padding: 0;
1.995 raeburn 7542: text-align: left;
1.819 tempelho 7543: }
1.862 bisitz 7544:
1.1098 bisitz 7545: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7546: clear:both;
7547: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7548: border: 1px solid $sidebg;
1.1098 bisitz 7549: margin: 0 0 10px 0;
1.966 bisitz 7550: padding: 3px;
1.995 raeburn 7551: text-align: left;
1.822 bisitz 7552: }
7553:
1.795 www 7554: .LC_fontsize_medium {
1.911 bisitz 7555: font-size: 85%;
1.705 tempelho 7556: }
7557:
1.795 www 7558: .LC_fontsize_large {
1.911 bisitz 7559: font-size: 120%;
1.705 tempelho 7560: }
7561:
1.346 albertel 7562: .LC_menubuttons_inline_text {
7563: color: $font;
1.698 harmsja 7564: font-size: 90%;
1.701 harmsja 7565: padding-left:3px;
1.346 albertel 7566: }
7567:
1.934 droeschl 7568: .LC_menubuttons_inline_text img{
7569: vertical-align: middle;
7570: }
7571:
1.1051 www 7572: li.LC_menubuttons_inline_text img {
1.951 onken 7573: cursor:pointer;
1.1002 droeschl 7574: text-decoration: none;
1.951 onken 7575: }
7576:
1.526 www 7577: .LC_menubuttons_link {
7578: text-decoration: none;
7579: }
1.795 www 7580:
1.522 albertel 7581: .LC_menubuttons_category {
1.521 www 7582: color: $font;
1.526 www 7583: background: $pgbg;
1.521 www 7584: font-size: larger;
7585: font-weight: bold;
7586: }
7587:
1.346 albertel 7588: td.LC_menubuttons_text {
1.911 bisitz 7589: color: $font;
1.346 albertel 7590: }
1.706 harmsja 7591:
1.346 albertel 7592: .LC_current_location {
7593: background: $tabbg;
7594: }
1.795 www 7595:
1.1286 raeburn 7596: td.LC_zero_height {
7597: line-height: 0;
7598: cellpadding: 0;
7599: }
7600:
1.938 bisitz 7601: table.LC_data_table {
1.347 albertel 7602: border: 1px solid #000000;
1.402 albertel 7603: border-collapse: separate;
1.426 albertel 7604: border-spacing: 1px;
1.610 albertel 7605: background: $pgbg;
1.347 albertel 7606: }
1.795 www 7607:
1.422 albertel 7608: .LC_data_table_dense {
7609: font-size: small;
7610: }
1.795 www 7611:
1.507 raeburn 7612: table.LC_nested_outer {
7613: border: 1px solid #000000;
1.589 raeburn 7614: border-collapse: collapse;
1.803 bisitz 7615: border-spacing: 0;
1.507 raeburn 7616: width: 100%;
7617: }
1.795 www 7618:
1.879 raeburn 7619: table.LC_innerpickbox,
1.507 raeburn 7620: table.LC_nested {
1.803 bisitz 7621: border: none;
1.589 raeburn 7622: border-collapse: collapse;
1.803 bisitz 7623: border-spacing: 0;
1.507 raeburn 7624: width: 100%;
7625: }
1.795 www 7626:
1.911 bisitz 7627: table.LC_data_table tr th,
7628: table.LC_calendar tr th,
1.879 raeburn 7629: table.LC_prior_tries tr th,
7630: table.LC_innerpickbox tr th {
1.349 albertel 7631: font-weight: bold;
7632: background-color: $data_table_head;
1.801 tempelho 7633: color:$fontmenu;
1.701 harmsja 7634: font-size:90%;
1.347 albertel 7635: }
1.795 www 7636:
1.879 raeburn 7637: table.LC_innerpickbox tr th,
7638: table.LC_innerpickbox tr td {
7639: vertical-align: top;
7640: }
7641:
1.711 raeburn 7642: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7643: background-color: #CCCCCC;
1.711 raeburn 7644: font-weight: bold;
7645: text-align: left;
7646: }
1.795 www 7647:
1.912 bisitz 7648: table.LC_data_table tr.LC_odd_row > td {
7649: background-color: $data_table_light;
7650: padding: 2px;
7651: vertical-align: top;
7652: }
7653:
1.809 bisitz 7654: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7655: background-color: $data_table_light;
1.912 bisitz 7656: vertical-align: top;
7657: }
7658:
7659: table.LC_data_table tr.LC_even_row > td {
7660: background-color: $data_table_dark;
1.425 albertel 7661: padding: 2px;
1.900 bisitz 7662: vertical-align: top;
1.347 albertel 7663: }
1.795 www 7664:
1.809 bisitz 7665: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7666: background-color: $data_table_dark;
1.900 bisitz 7667: vertical-align: top;
1.347 albertel 7668: }
1.795 www 7669:
1.425 albertel 7670: table.LC_data_table tr.LC_data_table_highlight td {
7671: background-color: $data_table_darker;
7672: }
1.795 www 7673:
1.639 raeburn 7674: table.LC_data_table tr td.LC_leftcol_header {
7675: background-color: $data_table_head;
7676: font-weight: bold;
7677: }
1.795 www 7678:
1.451 albertel 7679: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7680: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7681: font-weight: bold;
7682: font-style: italic;
7683: text-align: center;
7684: padding: 8px;
1.347 albertel 7685: }
1.795 www 7686:
1.1114 raeburn 7687: table.LC_data_table tr.LC_empty_row td,
7688: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7689: background-color: $sidebg;
7690: }
7691:
7692: table.LC_nested tr.LC_empty_row td {
7693: background-color: #FFFFFF;
7694: }
7695:
1.890 droeschl 7696: table.LC_caption {
7697: }
7698:
1.507 raeburn 7699: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7700: padding: 4ex
7701: }
1.795 www 7702:
1.507 raeburn 7703: table.LC_nested_outer tr th {
7704: font-weight: bold;
1.801 tempelho 7705: color:$fontmenu;
1.507 raeburn 7706: background-color: $data_table_head;
1.701 harmsja 7707: font-size: small;
1.507 raeburn 7708: border-bottom: 1px solid #000000;
7709: }
1.795 www 7710:
1.507 raeburn 7711: table.LC_nested_outer tr td.LC_subheader {
7712: background-color: $data_table_head;
7713: font-weight: bold;
7714: font-size: small;
7715: border-bottom: 1px solid #000000;
7716: text-align: right;
1.451 albertel 7717: }
1.795 www 7718:
1.507 raeburn 7719: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7720: background-color: #CCCCCC;
1.451 albertel 7721: font-weight: bold;
7722: font-size: small;
1.507 raeburn 7723: text-align: center;
7724: }
1.795 www 7725:
1.589 raeburn 7726: table.LC_nested tr.LC_info_row td.LC_left_item,
7727: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7728: text-align: left;
1.451 albertel 7729: }
1.795 www 7730:
1.507 raeburn 7731: table.LC_nested td {
1.735 bisitz 7732: background-color: #FFFFFF;
1.451 albertel 7733: font-size: small;
1.507 raeburn 7734: }
1.795 www 7735:
1.507 raeburn 7736: table.LC_nested_outer tr th.LC_right_item,
7737: table.LC_nested tr.LC_info_row td.LC_right_item,
7738: table.LC_nested tr.LC_odd_row td.LC_right_item,
7739: table.LC_nested tr td.LC_right_item {
1.451 albertel 7740: text-align: right;
7741: }
7742:
1.507 raeburn 7743: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7744: background-color: #EEEEEE;
1.451 albertel 7745: }
7746:
1.473 raeburn 7747: table.LC_createuser {
7748: }
7749:
7750: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7751: font-size: small;
1.473 raeburn 7752: }
7753:
7754: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7755: background-color: #CCCCCC;
1.473 raeburn 7756: font-weight: bold;
7757: text-align: center;
7758: }
7759:
1.349 albertel 7760: table.LC_calendar {
7761: border: 1px solid #000000;
7762: border-collapse: collapse;
1.917 raeburn 7763: width: 98%;
1.349 albertel 7764: }
1.795 www 7765:
1.349 albertel 7766: table.LC_calendar_pickdate {
7767: font-size: xx-small;
7768: }
1.795 www 7769:
1.349 albertel 7770: table.LC_calendar tr td {
7771: border: 1px solid #000000;
7772: vertical-align: top;
1.917 raeburn 7773: width: 14%;
1.349 albertel 7774: }
1.795 www 7775:
1.349 albertel 7776: table.LC_calendar tr td.LC_calendar_day_empty {
7777: background-color: $data_table_dark;
7778: }
1.795 www 7779:
1.779 bisitz 7780: table.LC_calendar tr td.LC_calendar_day_current {
7781: background-color: $data_table_highlight;
1.777 tempelho 7782: }
1.795 www 7783:
1.938 bisitz 7784: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7785: background-color: $mail_new;
7786: }
1.795 www 7787:
1.938 bisitz 7788: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7789: background-color: $mail_new_hover;
7790: }
1.795 www 7791:
1.938 bisitz 7792: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7793: background-color: $mail_read;
7794: }
1.795 www 7795:
1.938 bisitz 7796: /*
7797: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7798: background-color: $mail_read_hover;
7799: }
1.938 bisitz 7800: */
1.795 www 7801:
1.938 bisitz 7802: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7803: background-color: $mail_replied;
7804: }
1.795 www 7805:
1.938 bisitz 7806: /*
7807: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7808: background-color: $mail_replied_hover;
7809: }
1.938 bisitz 7810: */
1.795 www 7811:
1.938 bisitz 7812: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7813: background-color: $mail_other;
7814: }
1.795 www 7815:
1.938 bisitz 7816: /*
7817: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7818: background-color: $mail_other_hover;
7819: }
1.938 bisitz 7820: */
1.494 raeburn 7821:
1.777 tempelho 7822: table.LC_data_table tr > td.LC_browser_file,
7823: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7824: background: #AAEE77;
1.389 albertel 7825: }
1.795 www 7826:
1.777 tempelho 7827: table.LC_data_table tr > td.LC_browser_file_locked,
7828: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7829: background: #FFAA99;
1.387 albertel 7830: }
1.795 www 7831:
1.777 tempelho 7832: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7833: background: #888888;
1.779 bisitz 7834: }
1.795 www 7835:
1.777 tempelho 7836: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7837: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7838: background: #F8F866;
1.777 tempelho 7839: }
1.795 www 7840:
1.696 bisitz 7841: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7842: background: #E0E8FF;
1.387 albertel 7843: }
1.696 bisitz 7844:
1.707 bisitz 7845: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7846: /* background: #77FF77; */
1.707 bisitz 7847: }
1.795 www 7848:
1.707 bisitz 7849: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7850: border-right: 8px solid #FFFF77;
1.707 bisitz 7851: }
1.795 www 7852:
1.707 bisitz 7853: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7854: border-right: 8px solid #FFAA77;
1.707 bisitz 7855: }
1.795 www 7856:
1.707 bisitz 7857: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7858: border-right: 8px solid #FF7777;
1.707 bisitz 7859: }
1.795 www 7860:
1.707 bisitz 7861: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7862: border-right: 8px solid #AAFF77;
1.707 bisitz 7863: }
1.795 www 7864:
1.707 bisitz 7865: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7866: border-right: 8px solid #11CC55;
1.707 bisitz 7867: }
7868:
1.388 albertel 7869: span.LC_current_location {
1.701 harmsja 7870: font-size:larger;
1.388 albertel 7871: background: $pgbg;
7872: }
1.387 albertel 7873:
1.1029 www 7874: span.LC_current_nav_location {
7875: font-weight:bold;
7876: background: $sidebg;
7877: }
7878:
1.395 albertel 7879: span.LC_parm_menu_item {
7880: font-size: larger;
7881: }
1.795 www 7882:
1.395 albertel 7883: span.LC_parm_scope_all {
7884: color: red;
7885: }
1.795 www 7886:
1.395 albertel 7887: span.LC_parm_scope_folder {
7888: color: green;
7889: }
1.795 www 7890:
1.395 albertel 7891: span.LC_parm_scope_resource {
7892: color: orange;
7893: }
1.795 www 7894:
1.395 albertel 7895: span.LC_parm_part {
7896: color: blue;
7897: }
1.795 www 7898:
1.911 bisitz 7899: span.LC_parm_folder,
7900: span.LC_parm_symb {
1.395 albertel 7901: font-size: x-small;
7902: font-family: $mono;
7903: color: #AAAAAA;
7904: }
7905:
1.977 bisitz 7906: ul.LC_parm_parmlist li {
7907: display: inline-block;
7908: padding: 0.3em 0.8em;
7909: vertical-align: top;
7910: width: 150px;
7911: border-top:1px solid $lg_border_color;
7912: }
7913:
1.795 www 7914: td.LC_parm_overview_level_menu,
7915: td.LC_parm_overview_map_menu,
7916: td.LC_parm_overview_parm_selectors,
7917: td.LC_parm_overview_restrictions {
1.396 albertel 7918: border: 1px solid black;
7919: border-collapse: collapse;
7920: }
1.795 www 7921:
1.1285 raeburn 7922: span.LC_parm_recursive,
7923: td.LC_parm_recursive {
7924: font-weight: bold;
7925: font-size: smaller;
7926: }
7927:
1.396 albertel 7928: table.LC_parm_overview_restrictions td {
7929: border-width: 1px 4px 1px 4px;
7930: border-style: solid;
7931: border-color: $pgbg;
7932: text-align: center;
7933: }
1.795 www 7934:
1.396 albertel 7935: table.LC_parm_overview_restrictions th {
7936: background: $tabbg;
7937: border-width: 1px 4px 1px 4px;
7938: border-style: solid;
7939: border-color: $pgbg;
7940: }
1.795 www 7941:
1.398 albertel 7942: table#LC_helpmenu {
1.803 bisitz 7943: border: none;
1.398 albertel 7944: height: 55px;
1.803 bisitz 7945: border-spacing: 0;
1.398 albertel 7946: }
7947:
7948: table#LC_helpmenu fieldset legend {
7949: font-size: larger;
7950: }
1.795 www 7951:
1.397 albertel 7952: table#LC_helpmenu_links {
7953: width: 100%;
7954: border: 1px solid black;
7955: background: $pgbg;
1.803 bisitz 7956: padding: 0;
1.397 albertel 7957: border-spacing: 1px;
7958: }
1.795 www 7959:
1.397 albertel 7960: table#LC_helpmenu_links tr td {
7961: padding: 1px;
7962: background: $tabbg;
1.399 albertel 7963: text-align: center;
7964: font-weight: bold;
1.397 albertel 7965: }
1.396 albertel 7966:
1.795 www 7967: table#LC_helpmenu_links a:link,
7968: table#LC_helpmenu_links a:visited,
1.397 albertel 7969: table#LC_helpmenu_links a:active {
7970: text-decoration: none;
7971: color: $font;
7972: }
1.795 www 7973:
1.397 albertel 7974: table#LC_helpmenu_links a:hover {
7975: text-decoration: underline;
7976: color: $vlink;
7977: }
1.396 albertel 7978:
1.417 albertel 7979: .LC_chrt_popup_exists {
7980: border: 1px solid #339933;
7981: margin: -1px;
7982: }
1.795 www 7983:
1.417 albertel 7984: .LC_chrt_popup_up {
7985: border: 1px solid yellow;
7986: margin: -1px;
7987: }
1.795 www 7988:
1.417 albertel 7989: .LC_chrt_popup {
7990: border: 1px solid #8888FF;
7991: background: #CCCCFF;
7992: }
1.795 www 7993:
1.421 albertel 7994: table.LC_pick_box {
7995: border-collapse: separate;
7996: background: white;
7997: border: 1px solid black;
7998: border-spacing: 1px;
7999: }
1.795 www 8000:
1.421 albertel 8001: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8002: background: $sidebg;
1.421 albertel 8003: font-weight: bold;
1.900 bisitz 8004: text-align: left;
1.740 bisitz 8005: vertical-align: top;
1.421 albertel 8006: width: 184px;
8007: padding: 8px;
8008: }
1.795 www 8009:
1.579 raeburn 8010: table.LC_pick_box td.LC_pick_box_value {
8011: text-align: left;
8012: padding: 8px;
8013: }
1.795 www 8014:
1.579 raeburn 8015: table.LC_pick_box td.LC_pick_box_select {
8016: text-align: left;
8017: padding: 8px;
8018: }
1.795 www 8019:
1.424 albertel 8020: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8021: padding: 0;
1.421 albertel 8022: height: 1px;
8023: background: black;
8024: }
1.795 www 8025:
1.421 albertel 8026: table.LC_pick_box td.LC_pick_box_submit {
8027: text-align: right;
8028: }
1.795 www 8029:
1.579 raeburn 8030: table.LC_pick_box td.LC_evenrow_value {
8031: text-align: left;
8032: padding: 8px;
8033: background-color: $data_table_light;
8034: }
1.795 www 8035:
1.579 raeburn 8036: table.LC_pick_box td.LC_oddrow_value {
8037: text-align: left;
8038: padding: 8px;
8039: background-color: $data_table_light;
8040: }
1.795 www 8041:
1.579 raeburn 8042: span.LC_helpform_receipt_cat {
8043: font-weight: bold;
8044: }
1.795 www 8045:
1.424 albertel 8046: table.LC_group_priv_box {
8047: background: white;
8048: border: 1px solid black;
8049: border-spacing: 1px;
8050: }
1.795 www 8051:
1.424 albertel 8052: table.LC_group_priv_box td.LC_pick_box_title {
8053: background: $tabbg;
8054: font-weight: bold;
8055: text-align: right;
8056: width: 184px;
8057: }
1.795 www 8058:
1.424 albertel 8059: table.LC_group_priv_box td.LC_groups_fixed {
8060: background: $data_table_light;
8061: text-align: center;
8062: }
1.795 www 8063:
1.424 albertel 8064: table.LC_group_priv_box td.LC_groups_optional {
8065: background: $data_table_dark;
8066: text-align: center;
8067: }
1.795 www 8068:
1.424 albertel 8069: table.LC_group_priv_box td.LC_groups_functionality {
8070: background: $data_table_darker;
8071: text-align: center;
8072: font-weight: bold;
8073: }
1.795 www 8074:
1.424 albertel 8075: table.LC_group_priv td {
8076: text-align: left;
1.803 bisitz 8077: padding: 0;
1.424 albertel 8078: }
8079:
8080: .LC_navbuttons {
8081: margin: 2ex 0ex 2ex 0ex;
8082: }
1.795 www 8083:
1.423 albertel 8084: .LC_topic_bar {
8085: font-weight: bold;
8086: background: $tabbg;
1.918 wenzelju 8087: margin: 1em 0em 1em 2em;
1.805 bisitz 8088: padding: 3px;
1.918 wenzelju 8089: font-size: 1.2em;
1.423 albertel 8090: }
1.795 www 8091:
1.423 albertel 8092: .LC_topic_bar span {
1.918 wenzelju 8093: left: 0.5em;
8094: position: absolute;
1.423 albertel 8095: vertical-align: middle;
1.918 wenzelju 8096: font-size: 1.2em;
1.423 albertel 8097: }
1.795 www 8098:
1.423 albertel 8099: table.LC_course_group_status {
8100: margin: 20px;
8101: }
1.795 www 8102:
1.423 albertel 8103: table.LC_status_selector td {
8104: vertical-align: top;
8105: text-align: center;
1.424 albertel 8106: padding: 4px;
8107: }
1.795 www 8108:
1.599 albertel 8109: div.LC_feedback_link {
1.616 albertel 8110: clear: both;
1.829 kalberla 8111: background: $sidebg;
1.779 bisitz 8112: width: 100%;
1.829 kalberla 8113: padding-bottom: 10px;
8114: border: 1px $tabbg solid;
1.833 kalberla 8115: height: 22px;
8116: line-height: 22px;
8117: padding-top: 5px;
8118: }
8119:
8120: div.LC_feedback_link img {
8121: height: 22px;
1.867 kalberla 8122: vertical-align:middle;
1.829 kalberla 8123: }
8124:
1.911 bisitz 8125: div.LC_feedback_link a {
1.829 kalberla 8126: text-decoration: none;
1.489 raeburn 8127: }
1.795 www 8128:
1.867 kalberla 8129: div.LC_comblock {
1.911 bisitz 8130: display:inline;
1.867 kalberla 8131: color:$font;
8132: font-size:90%;
8133: }
8134:
8135: div.LC_feedback_link div.LC_comblock {
8136: padding-left:5px;
8137: }
8138:
8139: div.LC_feedback_link div.LC_comblock a {
8140: color:$font;
8141: }
8142:
1.489 raeburn 8143: span.LC_feedback_link {
1.858 bisitz 8144: /* background: $feedback_link_bg; */
1.599 albertel 8145: font-size: larger;
8146: }
1.795 www 8147:
1.599 albertel 8148: span.LC_message_link {
1.858 bisitz 8149: /* background: $feedback_link_bg; */
1.599 albertel 8150: font-size: larger;
8151: position: absolute;
8152: right: 1em;
1.489 raeburn 8153: }
1.421 albertel 8154:
1.515 albertel 8155: table.LC_prior_tries {
1.524 albertel 8156: border: 1px solid #000000;
8157: border-collapse: separate;
8158: border-spacing: 1px;
1.515 albertel 8159: }
1.523 albertel 8160:
1.515 albertel 8161: table.LC_prior_tries td {
1.524 albertel 8162: padding: 2px;
1.515 albertel 8163: }
1.523 albertel 8164:
8165: .LC_answer_correct {
1.795 www 8166: background: lightgreen;
8167: color: darkgreen;
8168: padding: 6px;
1.523 albertel 8169: }
1.795 www 8170:
1.523 albertel 8171: .LC_answer_charged_try {
1.797 www 8172: background: #FFAAAA;
1.795 www 8173: color: darkred;
8174: padding: 6px;
1.523 albertel 8175: }
1.795 www 8176:
1.779 bisitz 8177: .LC_answer_not_charged_try,
1.523 albertel 8178: .LC_answer_no_grade,
8179: .LC_answer_late {
1.795 www 8180: background: lightyellow;
1.523 albertel 8181: color: black;
1.795 www 8182: padding: 6px;
1.523 albertel 8183: }
1.795 www 8184:
1.523 albertel 8185: .LC_answer_previous {
1.795 www 8186: background: lightblue;
8187: color: darkblue;
8188: padding: 6px;
1.523 albertel 8189: }
1.795 www 8190:
1.779 bisitz 8191: .LC_answer_no_message {
1.777 tempelho 8192: background: #FFFFFF;
8193: color: black;
1.795 www 8194: padding: 6px;
1.779 bisitz 8195: }
1.795 www 8196:
1.1334 raeburn 8197: .LC_answer_unknown,
8198: .LC_answer_warning {
1.779 bisitz 8199: background: orange;
8200: color: black;
1.795 www 8201: padding: 6px;
1.777 tempelho 8202: }
1.795 www 8203:
1.529 albertel 8204: span.LC_prior_numerical,
8205: span.LC_prior_string,
8206: span.LC_prior_custom,
8207: span.LC_prior_reaction,
8208: span.LC_prior_math {
1.925 bisitz 8209: font-family: $mono;
1.523 albertel 8210: white-space: pre;
8211: }
8212:
1.525 albertel 8213: span.LC_prior_string {
1.925 bisitz 8214: font-family: $mono;
1.525 albertel 8215: white-space: pre;
8216: }
8217:
1.523 albertel 8218: table.LC_prior_option {
8219: width: 100%;
8220: border-collapse: collapse;
8221: }
1.795 www 8222:
1.911 bisitz 8223: table.LC_prior_rank,
1.795 www 8224: table.LC_prior_match {
1.528 albertel 8225: border-collapse: collapse;
8226: }
1.795 www 8227:
1.528 albertel 8228: table.LC_prior_option tr td,
8229: table.LC_prior_rank tr td,
8230: table.LC_prior_match tr td {
1.524 albertel 8231: border: 1px solid #000000;
1.515 albertel 8232: }
8233:
1.855 bisitz 8234: .LC_nobreak {
1.544 albertel 8235: white-space: nowrap;
1.519 raeburn 8236: }
8237:
1.576 raeburn 8238: span.LC_cusr_emph {
8239: font-style: italic;
8240: }
8241:
1.633 raeburn 8242: span.LC_cusr_subheading {
8243: font-weight: normal;
8244: font-size: 85%;
8245: }
8246:
1.861 bisitz 8247: div.LC_docs_entry_move {
1.859 bisitz 8248: border: 1px solid #BBBBBB;
1.545 albertel 8249: background: #DDDDDD;
1.861 bisitz 8250: width: 22px;
1.859 bisitz 8251: padding: 1px;
8252: margin: 0;
1.545 albertel 8253: }
8254:
1.861 bisitz 8255: table.LC_data_table tr > td.LC_docs_entry_commands,
8256: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8257: font-size: x-small;
8258: }
1.795 www 8259:
1.861 bisitz 8260: .LC_docs_entry_parameter {
8261: white-space: nowrap;
8262: }
8263:
1.544 albertel 8264: .LC_docs_copy {
1.545 albertel 8265: color: #000099;
1.544 albertel 8266: }
1.795 www 8267:
1.544 albertel 8268: .LC_docs_cut {
1.545 albertel 8269: color: #550044;
1.544 albertel 8270: }
1.795 www 8271:
1.544 albertel 8272: .LC_docs_rename {
1.545 albertel 8273: color: #009900;
1.544 albertel 8274: }
1.795 www 8275:
1.544 albertel 8276: .LC_docs_remove {
1.545 albertel 8277: color: #990000;
8278: }
8279:
1.1284 raeburn 8280: .LC_docs_alias {
8281: color: #440055;
8282: }
8283:
1.1286 raeburn 8284: .LC_domprefs_email,
1.1284 raeburn 8285: .LC_docs_alias_name,
1.547 albertel 8286: .LC_docs_reinit_warn,
8287: .LC_docs_ext_edit {
8288: font-size: x-small;
8289: }
8290:
1.545 albertel 8291: table.LC_docs_adddocs td,
8292: table.LC_docs_adddocs th {
8293: border: 1px solid #BBBBBB;
8294: padding: 4px;
8295: background: #DDDDDD;
1.543 albertel 8296: }
8297:
1.584 albertel 8298: table.LC_sty_begin {
8299: background: #BBFFBB;
8300: }
1.795 www 8301:
1.584 albertel 8302: table.LC_sty_end {
8303: background: #FFBBBB;
8304: }
8305:
1.589 raeburn 8306: table.LC_double_column {
1.803 bisitz 8307: border-width: 0;
1.589 raeburn 8308: border-collapse: collapse;
8309: width: 100%;
8310: padding: 2px;
8311: }
8312:
8313: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8314: top: 2px;
1.589 raeburn 8315: left: 2px;
8316: width: 47%;
8317: vertical-align: top;
8318: }
8319:
8320: table.LC_double_column tr td.LC_right_col {
8321: top: 2px;
1.779 bisitz 8322: right: 2px;
1.589 raeburn 8323: width: 47%;
8324: vertical-align: top;
8325: }
8326:
1.591 raeburn 8327: div.LC_left_float {
8328: float: left;
8329: padding-right: 5%;
1.597 albertel 8330: padding-bottom: 4px;
1.591 raeburn 8331: }
8332:
8333: div.LC_clear_float_header {
1.597 albertel 8334: padding-bottom: 2px;
1.591 raeburn 8335: }
8336:
8337: div.LC_clear_float_footer {
1.597 albertel 8338: padding-top: 10px;
1.591 raeburn 8339: clear: both;
8340: }
8341:
1.597 albertel 8342: div.LC_grade_show_user {
1.941 bisitz 8343: /* border-left: 5px solid $sidebg; */
8344: border-top: 5px solid #000000;
8345: margin: 50px 0 0 0;
1.936 bisitz 8346: padding: 15px 0 5px 10px;
1.597 albertel 8347: }
1.795 www 8348:
1.936 bisitz 8349: div.LC_grade_show_user_odd_row {
1.941 bisitz 8350: /* border-left: 5px solid #000000; */
8351: }
8352:
8353: div.LC_grade_show_user div.LC_Box {
8354: margin-right: 50px;
1.597 albertel 8355: }
8356:
8357: div.LC_grade_submissions,
8358: div.LC_grade_message_center,
1.936 bisitz 8359: div.LC_grade_info_links {
1.597 albertel 8360: margin: 5px;
8361: width: 99%;
8362: background: #FFFFFF;
8363: }
1.795 www 8364:
1.597 albertel 8365: div.LC_grade_submissions_header,
1.936 bisitz 8366: div.LC_grade_message_center_header {
1.705 tempelho 8367: font-weight: bold;
8368: font-size: large;
1.597 albertel 8369: }
1.795 www 8370:
1.597 albertel 8371: div.LC_grade_submissions_body,
1.936 bisitz 8372: div.LC_grade_message_center_body {
1.597 albertel 8373: border: 1px solid black;
8374: width: 99%;
8375: background: #FFFFFF;
8376: }
1.795 www 8377:
1.613 albertel 8378: table.LC_scantron_action {
8379: width: 100%;
8380: }
1.795 www 8381:
1.613 albertel 8382: table.LC_scantron_action tr th {
1.698 harmsja 8383: font-weight:bold;
8384: font-style:normal;
1.613 albertel 8385: }
1.795 www 8386:
1.779 bisitz 8387: .LC_edit_problem_header,
1.614 albertel 8388: div.LC_edit_problem_footer {
1.705 tempelho 8389: font-weight: normal;
8390: font-size: medium;
1.602 albertel 8391: margin: 2px;
1.1060 bisitz 8392: background-color: $sidebg;
1.600 albertel 8393: }
1.795 www 8394:
1.600 albertel 8395: div.LC_edit_problem_header,
1.602 albertel 8396: div.LC_edit_problem_header div,
1.614 albertel 8397: div.LC_edit_problem_footer,
8398: div.LC_edit_problem_footer div,
1.602 albertel 8399: div.LC_edit_problem_editxml_header,
8400: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8401: z-index: 100;
1.600 albertel 8402: }
1.795 www 8403:
1.600 albertel 8404: div.LC_edit_problem_header_title {
1.705 tempelho 8405: font-weight: bold;
8406: font-size: larger;
1.602 albertel 8407: background: $tabbg;
8408: padding: 3px;
1.1060 bisitz 8409: margin: 0 0 5px 0;
1.602 albertel 8410: }
1.795 www 8411:
1.602 albertel 8412: table.LC_edit_problem_header_title {
8413: width: 100%;
1.600 albertel 8414: background: $tabbg;
1.602 albertel 8415: }
8416:
1.1205 golterma 8417: div.LC_edit_actionbar {
8418: background-color: $sidebg;
1.1218 droeschl 8419: margin: 0;
8420: padding: 0;
8421: line-height: 200%;
1.602 albertel 8422: }
1.795 www 8423:
1.1218 droeschl 8424: div.LC_edit_actionbar div{
8425: padding: 0;
8426: margin: 0;
8427: display: inline-block;
1.600 albertel 8428: }
1.795 www 8429:
1.1124 bisitz 8430: .LC_edit_opt {
8431: padding-left: 1em;
8432: white-space: nowrap;
8433: }
8434:
1.1152 golterma 8435: .LC_edit_problem_latexhelper{
8436: text-align: right;
8437: }
8438:
8439: #LC_edit_problem_colorful div{
8440: margin-left: 40px;
8441: }
8442:
1.1205 golterma 8443: #LC_edit_problem_codemirror div{
8444: margin-left: 0px;
8445: }
8446:
1.911 bisitz 8447: img.stift {
1.803 bisitz 8448: border-width: 0;
8449: vertical-align: middle;
1.677 riegler 8450: }
1.680 riegler 8451:
1.923 bisitz 8452: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8453: vertical-align: top;
1.777 tempelho 8454: }
1.795 www 8455:
1.716 raeburn 8456: div.LC_createcourse {
1.911 bisitz 8457: margin: 10px 10px 10px 10px;
1.716 raeburn 8458: }
8459:
1.917 raeburn 8460: .LC_dccid {
1.1130 raeburn 8461: float: right;
1.917 raeburn 8462: margin: 0.2em 0 0 0;
8463: padding: 0;
8464: font-size: 90%;
8465: display:none;
8466: }
8467:
1.897 wenzelju 8468: ol.LC_primary_menu a:hover,
1.721 harmsja 8469: ol#LC_MenuBreadcrumbs a:hover,
8470: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8471: ul#LC_secondary_menu a:hover,
1.721 harmsja 8472: .LC_FormSectionClearButton input:hover
1.795 www 8473: ul.LC_TabContent li:hover a {
1.952 onken 8474: color:$button_hover;
1.911 bisitz 8475: text-decoration:none;
1.693 droeschl 8476: }
8477:
1.779 bisitz 8478: h1 {
1.911 bisitz 8479: padding: 0;
8480: line-height:130%;
1.693 droeschl 8481: }
1.698 harmsja 8482:
1.911 bisitz 8483: h2,
8484: h3,
8485: h4,
8486: h5,
8487: h6 {
8488: margin: 5px 0 5px 0;
8489: padding: 0;
8490: line-height:130%;
1.693 droeschl 8491: }
1.795 www 8492:
8493: .LC_hcell {
1.911 bisitz 8494: padding:3px 15px 3px 15px;
8495: margin: 0;
8496: background-color:$tabbg;
8497: color:$fontmenu;
8498: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8499: }
1.795 www 8500:
1.840 bisitz 8501: .LC_Box > .LC_hcell {
1.911 bisitz 8502: margin: 0 -10px 10px -10px;
1.835 bisitz 8503: }
8504:
1.721 harmsja 8505: .LC_noBorder {
1.911 bisitz 8506: border: 0;
1.698 harmsja 8507: }
1.693 droeschl 8508:
1.721 harmsja 8509: .LC_FormSectionClearButton input {
1.911 bisitz 8510: background-color:transparent;
8511: border: none;
8512: cursor:pointer;
8513: text-decoration:underline;
1.693 droeschl 8514: }
1.763 bisitz 8515:
8516: .LC_help_open_topic {
1.911 bisitz 8517: color: #FFFFFF;
8518: background-color: #EEEEFF;
8519: margin: 1px;
8520: padding: 4px;
8521: border: 1px solid #000033;
8522: white-space: nowrap;
8523: /* vertical-align: middle; */
1.759 neumanie 8524: }
1.693 droeschl 8525:
1.911 bisitz 8526: dl,
8527: ul,
8528: div,
8529: fieldset {
8530: margin: 10px 10px 10px 0;
8531: /* overflow: hidden; */
1.693 droeschl 8532: }
1.795 www 8533:
1.1404 raeburn 8534: fieldset#LC_selectuser {
8535: margin: 0;
8536: padding: 0;
8537: }
8538:
1.1211 raeburn 8539: article.geogebraweb div {
8540: margin: 0;
8541: }
8542:
1.838 bisitz 8543: fieldset > legend {
1.911 bisitz 8544: font-weight: bold;
8545: padding: 0 5px 0 5px;
1.838 bisitz 8546: }
8547:
1.813 bisitz 8548: #LC_nav_bar {
1.911 bisitz 8549: float: left;
1.995 raeburn 8550: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8551: margin: 0 0 2px 0;
1.807 droeschl 8552: }
8553:
1.916 droeschl 8554: #LC_realm {
8555: margin: 0.2em 0 0 0;
8556: padding: 0;
8557: font-weight: bold;
8558: text-align: center;
1.995 raeburn 8559: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8560: }
8561:
1.911 bisitz 8562: #LC_nav_bar em {
8563: font-weight: bold;
8564: font-style: normal;
1.807 droeschl 8565: }
8566:
1.897 wenzelju 8567: ol.LC_primary_menu {
1.934 droeschl 8568: margin: 0;
1.1076 raeburn 8569: padding: 0;
1.807 droeschl 8570: }
8571:
1.852 droeschl 8572: ol#LC_PathBreadcrumbs {
1.911 bisitz 8573: margin: 0;
1.693 droeschl 8574: }
8575:
1.897 wenzelju 8576: ol.LC_primary_menu li {
1.1076 raeburn 8577: color: RGB(80, 80, 80);
8578: vertical-align: middle;
8579: text-align: left;
8580: list-style: none;
1.1205 golterma 8581: position: relative;
1.1076 raeburn 8582: float: left;
1.1205 golterma 8583: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8584: line-height: 1.5em;
1.1076 raeburn 8585: }
8586:
1.1205 golterma 8587: ol.LC_primary_menu li a,
8588: ol.LC_primary_menu li p {
1.1076 raeburn 8589: display: block;
8590: margin: 0;
8591: padding: 0 5px 0 10px;
8592: text-decoration: none;
8593: }
8594:
1.1205 golterma 8595: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8596: display: inline-block;
8597: width: 95%;
8598: text-align: left;
8599: }
8600:
8601: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8602: display: inline-block;
8603: width: 5%;
8604: float: right;
8605: text-align: right;
8606: font-size: 70%;
8607: }
8608:
8609: ol.LC_primary_menu ul {
1.1076 raeburn 8610: display: none;
1.1205 golterma 8611: width: 15em;
1.1076 raeburn 8612: background-color: $data_table_light;
1.1205 golterma 8613: position: absolute;
8614: top: 100%;
1.1076 raeburn 8615: }
8616:
1.1205 golterma 8617: ol.LC_primary_menu ul ul {
8618: left: 100%;
8619: top: 0;
8620: }
8621:
8622: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8623: display: block;
8624: position: absolute;
8625: margin: 0;
8626: padding: 0;
1.1078 raeburn 8627: z-index: 2;
1.1076 raeburn 8628: }
8629:
8630: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8631: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8632: font-size: 90%;
1.911 bisitz 8633: vertical-align: top;
1.1076 raeburn 8634: float: none;
1.1079 raeburn 8635: border-left: 1px solid black;
8636: border-right: 1px solid black;
1.1205 golterma 8637: /* A dark bottom border to visualize different menu options;
8638: overwritten in the create_submenu routine for the last border-bottom of the menu */
8639: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8640: }
8641:
1.1205 golterma 8642: ol.LC_primary_menu li li p:hover {
8643: color:$button_hover;
8644: text-decoration:none;
8645: background-color:$data_table_dark;
1.1076 raeburn 8646: }
8647:
8648: ol.LC_primary_menu li li a:hover {
8649: color:$button_hover;
8650: background-color:$data_table_dark;
1.693 droeschl 8651: }
8652:
1.1205 golterma 8653: /* Font-size equal to the size of the predecessors*/
8654: ol.LC_primary_menu li:hover li li {
8655: font-size: 100%;
8656: }
8657:
1.897 wenzelju 8658: ol.LC_primary_menu li img {
1.911 bisitz 8659: vertical-align: bottom;
1.934 droeschl 8660: height: 1.1em;
1.1077 raeburn 8661: margin: 0.2em 0 0 0;
1.693 droeschl 8662: }
8663:
1.897 wenzelju 8664: ol.LC_primary_menu a {
1.911 bisitz 8665: color: RGB(80, 80, 80);
8666: text-decoration: none;
1.693 droeschl 8667: }
1.795 www 8668:
1.949 droeschl 8669: ol.LC_primary_menu a.LC_new_message {
8670: font-weight:bold;
8671: color: darkred;
8672: }
8673:
1.975 raeburn 8674: ol.LC_docs_parameters {
8675: margin-left: 0;
8676: padding: 0;
8677: list-style: none;
8678: }
8679:
8680: ol.LC_docs_parameters li {
8681: margin: 0;
8682: padding-right: 20px;
8683: display: inline;
8684: }
8685:
1.976 raeburn 8686: ol.LC_docs_parameters li:before {
8687: content: "\\002022 \\0020";
8688: }
8689:
8690: li.LC_docs_parameters_title {
8691: font-weight: bold;
8692: }
8693:
8694: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8695: content: "";
8696: }
8697:
1.897 wenzelju 8698: ul#LC_secondary_menu {
1.1107 raeburn 8699: clear: right;
1.911 bisitz 8700: color: $fontmenu;
8701: background: $tabbg;
8702: list-style: none;
8703: padding: 0;
8704: margin: 0;
8705: width: 100%;
1.995 raeburn 8706: text-align: left;
1.1107 raeburn 8707: float: left;
1.808 droeschl 8708: }
8709:
1.897 wenzelju 8710: ul#LC_secondary_menu li {
1.911 bisitz 8711: font-weight: bold;
8712: line-height: 1.8em;
1.1107 raeburn 8713: border-right: 1px solid black;
8714: float: left;
8715: }
8716:
8717: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8718: background-color: $data_table_light;
8719: }
8720:
8721: ul#LC_secondary_menu li a {
1.911 bisitz 8722: padding: 0 0.8em;
1.1107 raeburn 8723: }
8724:
8725: ul#LC_secondary_menu li ul {
8726: display: none;
8727: }
8728:
8729: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8730: display: block;
8731: position: absolute;
8732: margin: 0;
8733: padding: 0;
8734: list-style:none;
8735: float: none;
8736: background-color: $data_table_light;
8737: z-index: 2;
8738: margin-left: -1px;
8739: }
8740:
8741: ul#LC_secondary_menu li ul li {
8742: font-size: 90%;
8743: vertical-align: top;
8744: border-left: 1px solid black;
1.911 bisitz 8745: border-right: 1px solid black;
1.1119 raeburn 8746: background-color: $data_table_light;
1.1107 raeburn 8747: list-style:none;
8748: float: none;
8749: }
8750:
8751: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8752: background-color: $data_table_dark;
1.807 droeschl 8753: }
8754:
1.847 tempelho 8755: ul.LC_TabContent {
1.911 bisitz 8756: display:block;
8757: background: $sidebg;
8758: border-bottom: solid 1px $lg_border_color;
8759: list-style:none;
1.1020 raeburn 8760: margin: -1px -10px 0 -10px;
1.911 bisitz 8761: padding: 0;
1.693 droeschl 8762: }
8763:
1.795 www 8764: ul.LC_TabContent li,
8765: ul.LC_TabContentBigger li {
1.911 bisitz 8766: float:left;
1.741 harmsja 8767: }
1.795 www 8768:
1.897 wenzelju 8769: ul#LC_secondary_menu li a {
1.911 bisitz 8770: color: $fontmenu;
8771: text-decoration: none;
1.693 droeschl 8772: }
1.795 www 8773:
1.721 harmsja 8774: ul.LC_TabContent {
1.952 onken 8775: min-height:20px;
1.721 harmsja 8776: }
1.795 www 8777:
8778: ul.LC_TabContent li {
1.911 bisitz 8779: vertical-align:middle;
1.959 onken 8780: padding: 0 16px 0 10px;
1.911 bisitz 8781: background-color:$tabbg;
8782: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8783: border-left: solid 1px $font;
1.721 harmsja 8784: }
1.795 www 8785:
1.847 tempelho 8786: ul.LC_TabContent .right {
1.911 bisitz 8787: float:right;
1.847 tempelho 8788: }
8789:
1.911 bisitz 8790: ul.LC_TabContent li a,
8791: ul.LC_TabContent li {
8792: color:rgb(47,47,47);
8793: text-decoration:none;
8794: font-size:95%;
8795: font-weight:bold;
1.952 onken 8796: min-height:20px;
8797: }
8798:
1.959 onken 8799: ul.LC_TabContent li a:hover,
8800: ul.LC_TabContent li a:focus {
1.952 onken 8801: color: $button_hover;
1.959 onken 8802: background:none;
8803: outline:none;
1.952 onken 8804: }
8805:
8806: ul.LC_TabContent li:hover {
8807: color: $button_hover;
8808: cursor:pointer;
1.721 harmsja 8809: }
1.795 www 8810:
1.911 bisitz 8811: ul.LC_TabContent li.active {
1.952 onken 8812: color: $font;
1.911 bisitz 8813: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8814: border-bottom:solid 1px #FFFFFF;
8815: cursor: default;
1.744 ehlerst 8816: }
1.795 www 8817:
1.959 onken 8818: ul.LC_TabContent li.active a {
8819: color:$font;
8820: background:#FFFFFF;
8821: outline: none;
8822: }
1.1047 raeburn 8823:
8824: ul.LC_TabContent li.goback {
8825: float: left;
8826: border-left: none;
8827: }
8828:
1.870 tempelho 8829: #maincoursedoc {
1.911 bisitz 8830: clear:both;
1.870 tempelho 8831: }
8832:
8833: ul.LC_TabContentBigger {
1.911 bisitz 8834: display:block;
8835: list-style:none;
8836: padding: 0;
1.870 tempelho 8837: }
8838:
1.795 www 8839: ul.LC_TabContentBigger li {
1.911 bisitz 8840: vertical-align:bottom;
8841: height: 30px;
8842: font-size:110%;
8843: font-weight:bold;
8844: color: #737373;
1.841 tempelho 8845: }
8846:
1.957 onken 8847: ul.LC_TabContentBigger li.active {
8848: position: relative;
8849: top: 1px;
8850: }
8851:
1.870 tempelho 8852: ul.LC_TabContentBigger li a {
1.911 bisitz 8853: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8854: height: 30px;
8855: line-height: 30px;
8856: text-align: center;
8857: display: block;
8858: text-decoration: none;
1.958 onken 8859: outline: none;
1.741 harmsja 8860: }
1.795 www 8861:
1.870 tempelho 8862: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8863: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8864: color:$font;
1.744 ehlerst 8865: }
1.795 www 8866:
1.870 tempelho 8867: ul.LC_TabContentBigger li b {
1.911 bisitz 8868: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8869: display: block;
8870: float: left;
8871: padding: 0 30px;
1.957 onken 8872: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8873: }
8874:
1.956 onken 8875: ul.LC_TabContentBigger li:hover b {
8876: color:$button_hover;
8877: }
8878:
1.870 tempelho 8879: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8880: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8881: color:$font;
1.957 onken 8882: border: 0;
1.741 harmsja 8883: }
1.693 droeschl 8884:
1.870 tempelho 8885:
1.862 bisitz 8886: ul.LC_CourseBreadcrumbs {
8887: background: $sidebg;
1.1020 raeburn 8888: height: 2em;
1.862 bisitz 8889: padding-left: 10px;
1.1020 raeburn 8890: margin: 0;
1.862 bisitz 8891: list-style-position: inside;
8892: }
8893:
1.911 bisitz 8894: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8895: ol#LC_PathBreadcrumbs {
1.911 bisitz 8896: padding-left: 10px;
8897: margin: 0;
1.933 droeschl 8898: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8899: }
8900:
1.911 bisitz 8901: ol#LC_MenuBreadcrumbs li,
8902: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8903: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8904: display: inline;
1.933 droeschl 8905: white-space: normal;
1.693 droeschl 8906: }
8907:
1.823 bisitz 8908: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8909: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8910: text-decoration: none;
8911: font-size:90%;
1.693 droeschl 8912: }
1.795 www 8913:
1.969 droeschl 8914: ol#LC_MenuBreadcrumbs h1 {
8915: display: inline;
8916: font-size: 90%;
8917: line-height: 2.5em;
8918: margin: 0;
8919: padding: 0;
8920: }
8921:
1.795 www 8922: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8923: text-decoration:none;
8924: font-size:100%;
8925: font-weight:bold;
1.693 droeschl 8926: }
1.795 www 8927:
1.840 bisitz 8928: .LC_Box {
1.911 bisitz 8929: border: solid 1px $lg_border_color;
8930: padding: 0 10px 10px 10px;
1.746 neumanie 8931: }
1.795 www 8932:
1.1020 raeburn 8933: .LC_DocsBox {
8934: border: solid 1px $lg_border_color;
8935: padding: 0 0 10px 10px;
8936: }
8937:
1.795 www 8938: .LC_AboutMe_Image {
1.911 bisitz 8939: float:left;
8940: margin-right:10px;
1.747 neumanie 8941: }
1.795 www 8942:
8943: .LC_Clear_AboutMe_Image {
1.911 bisitz 8944: clear:left;
1.747 neumanie 8945: }
1.795 www 8946:
1.721 harmsja 8947: dl.LC_ListStyleClean dt {
1.911 bisitz 8948: padding-right: 5px;
8949: display: table-header-group;
1.693 droeschl 8950: }
8951:
1.721 harmsja 8952: dl.LC_ListStyleClean dd {
1.911 bisitz 8953: display: table-row;
1.693 droeschl 8954: }
8955:
1.721 harmsja 8956: .LC_ListStyleClean,
8957: .LC_ListStyleSimple,
8958: .LC_ListStyleNormal,
1.795 www 8959: .LC_ListStyleSpecial {
1.911 bisitz 8960: /* display:block; */
8961: list-style-position: inside;
8962: list-style-type: none;
8963: overflow: hidden;
8964: padding: 0;
1.693 droeschl 8965: }
8966:
1.721 harmsja 8967: .LC_ListStyleSimple li,
8968: .LC_ListStyleSimple dd,
8969: .LC_ListStyleNormal li,
8970: .LC_ListStyleNormal dd,
8971: .LC_ListStyleSpecial li,
1.795 www 8972: .LC_ListStyleSpecial dd {
1.911 bisitz 8973: margin: 0;
8974: padding: 5px 5px 5px 10px;
8975: clear: both;
1.693 droeschl 8976: }
8977:
1.721 harmsja 8978: .LC_ListStyleClean li,
8979: .LC_ListStyleClean dd {
1.911 bisitz 8980: padding-top: 0;
8981: padding-bottom: 0;
1.693 droeschl 8982: }
8983:
1.721 harmsja 8984: .LC_ListStyleSimple dd,
1.795 www 8985: .LC_ListStyleSimple li {
1.911 bisitz 8986: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8987: }
8988:
1.721 harmsja 8989: .LC_ListStyleSpecial li,
8990: .LC_ListStyleSpecial dd {
1.911 bisitz 8991: list-style-type: none;
8992: background-color: RGB(220, 220, 220);
8993: margin-bottom: 4px;
1.693 droeschl 8994: }
8995:
1.721 harmsja 8996: table.LC_SimpleTable {
1.911 bisitz 8997: margin:5px;
8998: border:solid 1px $lg_border_color;
1.795 www 8999: }
1.693 droeschl 9000:
1.721 harmsja 9001: table.LC_SimpleTable tr {
1.911 bisitz 9002: padding: 0;
9003: border:solid 1px $lg_border_color;
1.693 droeschl 9004: }
1.795 www 9005:
9006: table.LC_SimpleTable thead {
1.911 bisitz 9007: background:rgb(220,220,220);
1.693 droeschl 9008: }
9009:
1.721 harmsja 9010: div.LC_columnSection {
1.911 bisitz 9011: display: block;
9012: clear: both;
9013: overflow: hidden;
9014: margin: 0;
1.693 droeschl 9015: }
9016:
1.721 harmsja 9017: div.LC_columnSection>* {
1.911 bisitz 9018: float: left;
9019: margin: 10px 20px 10px 0;
9020: overflow:hidden;
1.693 droeschl 9021: }
1.721 harmsja 9022:
1.795 www 9023: table em {
1.911 bisitz 9024: font-weight: bold;
9025: font-style: normal;
1.748 schulted 9026: }
1.795 www 9027:
1.779 bisitz 9028: table.LC_tableBrowseRes,
1.795 www 9029: table.LC_tableOfContent {
1.911 bisitz 9030: border:none;
9031: border-spacing: 1px;
9032: padding: 3px;
9033: background-color: #FFFFFF;
9034: font-size: 90%;
1.753 droeschl 9035: }
1.789 droeschl 9036:
1.911 bisitz 9037: table.LC_tableOfContent {
9038: border-collapse: collapse;
1.789 droeschl 9039: }
9040:
1.771 droeschl 9041: table.LC_tableBrowseRes a,
1.768 schulted 9042: table.LC_tableOfContent a {
1.911 bisitz 9043: background-color: transparent;
9044: text-decoration: none;
1.753 droeschl 9045: }
9046:
1.795 www 9047: table.LC_tableOfContent img {
1.911 bisitz 9048: border: none;
9049: height: 1.3em;
9050: vertical-align: text-bottom;
9051: margin-right: 0.3em;
1.753 droeschl 9052: }
1.757 schulted 9053:
1.795 www 9054: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9055: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9056: }
9057:
1.795 www 9058: a#LC_content_toolbar_everything {
1.911 bisitz 9059: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9060: }
9061:
1.795 www 9062: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9063: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9064: }
9065:
1.795 www 9066: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9067: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9068: }
9069:
1.795 www 9070: a#LC_content_toolbar_changefolder {
1.911 bisitz 9071: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9072: }
9073:
1.795 www 9074: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9075: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9076: }
9077:
1.1043 raeburn 9078: a#LC_content_toolbar_edittoplevel {
9079: background-image:url(/res/adm/pages/edittoplevel.gif);
9080: }
9081:
1.1384 raeburn 9082: a#LC_content_toolbar_printout {
9083: background-image:url(/res/adm/pages/printout.gif);
9084: }
9085:
1.795 www 9086: ul#LC_toolbar li a:hover {
1.911 bisitz 9087: background-position: bottom center;
1.757 schulted 9088: }
9089:
1.795 www 9090: ul#LC_toolbar {
1.911 bisitz 9091: padding: 0;
9092: margin: 2px;
9093: list-style:none;
9094: position:relative;
9095: background-color:white;
1.1082 raeburn 9096: overflow: auto;
1.757 schulted 9097: }
9098:
1.795 www 9099: ul#LC_toolbar li {
1.911 bisitz 9100: border:1px solid white;
9101: padding: 0;
9102: margin: 0;
9103: float: left;
9104: display:inline;
9105: vertical-align:middle;
1.1082 raeburn 9106: white-space: nowrap;
1.911 bisitz 9107: }
1.757 schulted 9108:
1.783 amueller 9109:
1.795 www 9110: a.LC_toolbarItem {
1.911 bisitz 9111: display:block;
9112: padding: 0;
9113: margin: 0;
9114: height: 32px;
9115: width: 32px;
9116: color:white;
9117: border: none;
9118: background-repeat:no-repeat;
9119: background-color:transparent;
1.757 schulted 9120: }
9121:
1.915 droeschl 9122: ul.LC_funclist {
9123: margin: 0;
9124: padding: 0.5em 1em 0.5em 0;
9125: }
9126:
1.933 droeschl 9127: ul.LC_funclist > li:first-child {
9128: font-weight:bold;
9129: margin-left:0.8em;
9130: }
9131:
1.915 droeschl 9132: ul.LC_funclist + ul.LC_funclist {
9133: /*
9134: left border as a seperator if we have more than
9135: one list
9136: */
9137: border-left: 1px solid $sidebg;
9138: /*
9139: this hides the left border behind the border of the
9140: outer box if element is wrapped to the next 'line'
9141: */
9142: margin-left: -1px;
9143: }
9144:
1.843 bisitz 9145: ul.LC_funclist li {
1.915 droeschl 9146: display: inline;
1.782 bisitz 9147: white-space: nowrap;
1.915 droeschl 9148: margin: 0 0 0 25px;
9149: line-height: 150%;
1.782 bisitz 9150: }
9151:
1.974 wenzelju 9152: .LC_hidden {
9153: display: none;
9154: }
9155:
1.1030 www 9156: .LCmodal-overlay {
9157: position:fixed;
9158: top:0;
9159: right:0;
9160: bottom:0;
9161: left:0;
9162: height:100%;
9163: width:100%;
9164: margin:0;
9165: padding:0;
9166: background:#999;
9167: opacity:.75;
9168: filter: alpha(opacity=75);
9169: -moz-opacity: 0.75;
9170: z-index:101;
9171: }
9172:
9173: * html .LCmodal-overlay {
9174: position: absolute;
9175: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9176: }
9177:
9178: .LCmodal-window {
9179: position:fixed;
9180: top:50%;
9181: left:50%;
9182: margin:0;
9183: padding:0;
9184: z-index:102;
9185: }
9186:
9187: * html .LCmodal-window {
9188: position:absolute;
9189: }
9190:
9191: .LCclose-window {
9192: position:absolute;
9193: width:32px;
9194: height:32px;
9195: right:8px;
9196: top:8px;
9197: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9198: text-indent:-99999px;
9199: overflow:hidden;
9200: cursor:pointer;
9201: }
9202:
1.1369 raeburn 9203: .LCisDisabled {
9204: cursor: not-allowed;
9205: opacity: 0.5;
9206: }
9207:
9208: a[aria-disabled="true"] {
9209: color: currentColor;
9210: display: inline-block; /* For IE11/ MS Edge bug */
9211: pointer-events: none;
9212: text-decoration: none;
9213: }
9214:
1.1335 raeburn 9215: pre.LC_wordwrap {
9216: white-space: pre-wrap;
9217: white-space: -moz-pre-wrap;
9218: white-space: -pre-wrap;
9219: white-space: -o-pre-wrap;
9220: word-wrap: break-word;
9221: }
9222:
1.1100 raeburn 9223: /*
1.1231 damieng 9224: styles used for response display
9225: */
9226: div.LC_radiofoil, div.LC_rankfoil {
9227: margin: .5em 0em .5em 0em;
9228: }
9229: table.LC_itemgroup {
9230: margin-top: 1em;
9231: }
9232:
9233: /*
1.1100 raeburn 9234: styles used by TTH when "Default set of options to pass to tth/m
9235: when converting TeX" in course settings has been set
9236:
9237: option passed: -t
9238:
9239: */
9240:
9241: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9242: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9243: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9244: td div.norm {line-height:normal;}
9245:
9246: /*
9247: option passed -y3
9248: */
9249:
9250: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9251: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9252: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9253:
1.1230 damieng 9254: /*
9255: sections with roles, for content only
9256: */
9257: section[class^="role-"] {
9258: padding-left: 10px;
9259: padding-right: 5px;
9260: margin-top: 8px;
9261: margin-bottom: 8px;
9262: border: 1px solid #2A4;
9263: border-radius: 5px;
9264: box-shadow: 0px 1px 1px #BBB;
9265: }
9266: section[class^="role-"]>h1 {
9267: position: relative;
9268: margin: 0px;
9269: padding-top: 10px;
9270: padding-left: 40px;
9271: }
9272: section[class^="role-"]>h1:before {
9273: position: absolute;
9274: left: -5px;
9275: top: 5px;
9276: }
9277: section.role-activity>h1:before {
9278: content:url('/adm/daxe/images/section_icons/activity.png');
9279: }
9280: section.role-advice>h1:before {
9281: content:url('/adm/daxe/images/section_icons/advice.png');
9282: }
9283: section.role-bibliography>h1:before {
9284: content:url('/adm/daxe/images/section_icons/bibliography.png');
9285: }
9286: section.role-citation>h1:before {
9287: content:url('/adm/daxe/images/section_icons/citation.png');
9288: }
9289: section.role-conclusion>h1:before {
9290: content:url('/adm/daxe/images/section_icons/conclusion.png');
9291: }
9292: section.role-definition>h1:before {
9293: content:url('/adm/daxe/images/section_icons/definition.png');
9294: }
9295: section.role-demonstration>h1:before {
9296: content:url('/adm/daxe/images/section_icons/demonstration.png');
9297: }
9298: section.role-example>h1:before {
9299: content:url('/adm/daxe/images/section_icons/example.png');
9300: }
9301: section.role-explanation>h1:before {
9302: content:url('/adm/daxe/images/section_icons/explanation.png');
9303: }
9304: section.role-introduction>h1:before {
9305: content:url('/adm/daxe/images/section_icons/introduction.png');
9306: }
9307: section.role-method>h1:before {
9308: content:url('/adm/daxe/images/section_icons/method.png');
9309: }
9310: section.role-more_information>h1:before {
9311: content:url('/adm/daxe/images/section_icons/more_information.png');
9312: }
9313: section.role-objectives>h1:before {
9314: content:url('/adm/daxe/images/section_icons/objectives.png');
9315: }
9316: section.role-prerequisites>h1:before {
9317: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9318: }
9319: section.role-remark>h1:before {
9320: content:url('/adm/daxe/images/section_icons/remark.png');
9321: }
9322: section.role-reminder>h1:before {
9323: content:url('/adm/daxe/images/section_icons/reminder.png');
9324: }
9325: section.role-summary>h1:before {
9326: content:url('/adm/daxe/images/section_icons/summary.png');
9327: }
9328: section.role-syntax>h1:before {
9329: content:url('/adm/daxe/images/section_icons/syntax.png');
9330: }
9331: section.role-warning>h1:before {
9332: content:url('/adm/daxe/images/section_icons/warning.png');
9333: }
9334:
1.1269 raeburn 9335: #LC_minitab_header {
9336: float:left;
9337: width:100%;
9338: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9339: font-size:93%;
9340: line-height:normal;
9341: margin: 0.5em 0 0.5em 0;
9342: }
9343: #LC_minitab_header ul {
9344: margin:0;
9345: padding:10px 10px 0;
9346: list-style:none;
9347: }
9348: #LC_minitab_header li {
9349: float:left;
9350: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9351: margin:0;
9352: padding:0 0 0 9px;
9353: }
9354: #LC_minitab_header a {
9355: display:block;
9356: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9357: padding:5px 15px 4px 6px;
9358: }
9359: #LC_minitab_header #LC_current_minitab {
9360: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9361: }
9362: #LC_minitab_header #LC_current_minitab a {
9363: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9364: padding-bottom:5px;
9365: }
9366:
9367:
1.343 albertel 9368: END
9369: }
9370:
1.306 albertel 9371: =pod
9372:
9373: =item * &headtag()
9374:
9375: Returns a uniform footer for LON-CAPA web pages.
9376:
1.307 albertel 9377: Inputs: $title - optional title for the head
9378: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9379: $args - optional arguments
1.319 albertel 9380: force_register - if is true call registerurl so the remote is
9381: informed
1.415 albertel 9382: redirect -> array ref of
9383: 1- seconds before redirect occurs
9384: 2- url to redirect to
9385: 3- whether the side effect should occur
1.315 albertel 9386: (side effect of setting
9387: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9388: redirected to)
9389: 4- whether the redirect target should be
9390: the opener of the current (pop-up)
9391: window (side effect of setting
9392: $env{'internal.head.to_opener'} to
9393: 1, if true.
1.1388 raeburn 9394: 5- whether encrypt check should be skipped
1.352 albertel 9395: domain -> force to color decorate a page for a specific
9396: domain
9397: function -> force usage of a specific rolish color scheme
9398: bgcolor -> override the default page bgcolor
1.460 albertel 9399: no_auto_mt_title
9400: -> prevent &mt()ing the title arg
1.464 albertel 9401:
1.306 albertel 9402: =cut
9403:
9404: sub headtag {
1.313 albertel 9405: my ($title,$head_extra,$args) = @_;
1.306 albertel 9406:
1.363 albertel 9407: my $function = $args->{'function'} || &get_users_function();
9408: my $domain = $args->{'domain'} || &determinedomain();
9409: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9410: my $httphost = $args->{'use_absolute'};
1.418 albertel 9411: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9412: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9413: #time(),
1.418 albertel 9414: $env{'environment.color.timestamp'},
1.363 albertel 9415: $function,$domain,$bgcolor);
9416:
1.369 www 9417: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9418:
1.308 albertel 9419: my $result =
9420: '<head>'.
1.1160 raeburn 9421: &font_settings($args);
1.319 albertel 9422:
1.1188 raeburn 9423: my $inhibitprint;
9424: if ($args->{'print_suppress'}) {
9425: $inhibitprint = &print_suppression();
9426: }
1.1064 raeburn 9427:
1.461 albertel 9428: if (!$args->{'frameset'}) {
9429: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9430: }
1.962 droeschl 9431: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9432: $result .= Apache::lonxml::display_title();
1.319 albertel 9433: }
1.436 albertel 9434: if (!$args->{'no_nav_bar'}
9435: && !$args->{'only_body'}
9436: && !$args->{'frameset'}) {
1.1154 raeburn 9437: $result .= &help_menu_js($httphost);
1.1032 www 9438: $result.=&modal_window();
1.1038 www 9439: $result.=&togglebox_script();
1.1034 www 9440: $result.=&wishlist_window();
1.1041 www 9441: $result.=&LCprogressbarUpdate_script();
1.1034 www 9442: } else {
9443: if ($args->{'add_modal'}) {
9444: $result.=&modal_window();
9445: }
9446: if ($args->{'add_wishlist'}) {
9447: $result.=&wishlist_window();
9448: }
1.1038 www 9449: if ($args->{'add_togglebox'}) {
9450: $result.=&togglebox_script();
9451: }
1.1041 www 9452: if ($args->{'add_progressbar'}) {
9453: $result.=&LCprogressbarUpdate_script();
9454: }
1.436 albertel 9455: }
1.314 albertel 9456: if (ref($args->{'redirect'})) {
1.1388 raeburn 9457: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9458: if (!$skip_enc_check) {
9459: $url = &Apache::lonenc::check_encrypt($url);
9460: }
1.414 albertel 9461: if (!$inhibit_continue) {
9462: $env{'internal.head.redirect'} = $url;
9463: }
1.1386 raeburn 9464: $result.=<<"ADDMETA";
1.313 albertel 9465: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9466: ADDMETA
9467: if ($to_opener) {
9468: $env{'internal.head.to_opener'} = 1;
9469: my $dest = &js_escape($url);
9470: my $timeout = int($time * 1000);
9471: $result .=<<"ENDJS";
9472: <script type="text/javascript">
9473: // <![CDATA[
9474: function LC_To_Opener() {
9475: var dest = '$dest';
9476: if (dest != '') {
9477: if (window.opener != null && !window.opener.closed) {
9478: window.opener.location.href=dest;
9479: window.close();
9480: } else {
9481: window.location.href=dest;
9482: }
9483: }
9484: }
9485: \$(document).ready(function () {
9486: setTimeout('LC_To_Opener()',$timeout);
9487: });
9488: // ]]>
9489: </script>
9490: ENDJS
9491: } else {
9492: $result.=<<"ADDMETA";
1.344 albertel 9493: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9494: ADDMETA
1.1386 raeburn 9495: }
1.1210 raeburn 9496: } else {
9497: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9498: my $requrl = $env{'request.uri'};
9499: if ($requrl eq '') {
9500: $requrl = $ENV{'REQUEST_URI'};
9501: $requrl =~ s/\?.+$//;
9502: }
9503: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9504: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9505: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9506: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9507: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9508: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9509: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9510: my ($offload,$offloadoth);
1.1210 raeburn 9511: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9512: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9513: $offload = 1;
1.1353 raeburn 9514: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9515: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9516: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9517: $offloadoth = 1;
9518: $dom_in_use = $env{'user.domain'};
9519: }
9520: }
1.1340 raeburn 9521: }
9522: }
9523: unless ($offload) {
9524: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9525: if ($domdefs{'offloadoth'}{$lonhost}) {
9526: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9527: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9528: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9529: $offload = 1;
1.1352 raeburn 9530: $offloadoth = 1;
1.1340 raeburn 9531: $dom_in_use = $env{'user.domain'};
9532: }
1.1210 raeburn 9533: }
1.1340 raeburn 9534: }
9535: }
9536: }
9537: if ($offload) {
1.1358 raeburn 9538: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9539: if (($newserver eq '') && ($offloadoth)) {
9540: my @domains = &Apache::lonnet::current_machine_domains();
9541: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9542: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9543: }
9544: }
1.1340 raeburn 9545: if (($newserver) && ($newserver ne $lonhost)) {
9546: my $numsec = 5;
9547: my $timeout = $numsec * 1000;
9548: my ($newurl,$locknum,%locks,$msg);
9549: if ($env{'request.role.adv'}) {
9550: ($locknum,%locks) = &Apache::lonnet::get_locks();
9551: }
9552: my $disable_submit = 0;
9553: if ($requrl =~ /$LONCAPA::assess_re/) {
9554: $disable_submit = 1;
9555: }
9556: if ($locknum) {
9557: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9558: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9559: join(", ",sort(values(%locks)))."\n";
9560: if (&show_course()) {
9561: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9562: } else {
9563: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9564: }
1.1340 raeburn 9565: } else {
9566: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9567: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9568: }
9569: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9570: $newurl = '/adm/switchserver?otherserver='.$newserver;
9571: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9572: $newurl .= '&role='.$env{'request.role'};
9573: }
9574: if ($env{'request.symb'}) {
9575: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9576: if ($shownsymb =~ m{^/enc/}) {
9577: my $reqdmajor = 2;
9578: my $reqdminor = 11;
9579: my $reqdsubminor = 3;
9580: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9581: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9582: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9583: if (($major eq '' && $minor eq '') ||
9584: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9585: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9586: ($reqdsubminor > $subminor))))) {
9587: undef($shownsymb);
9588: }
1.1210 raeburn 9589: }
1.1340 raeburn 9590: if ($shownsymb) {
9591: &js_escape(\$shownsymb);
9592: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9593: }
1.1340 raeburn 9594: } else {
9595: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9596: &js_escape(\$shownurl);
9597: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9598: }
1.1340 raeburn 9599: }
9600: &js_escape(\$msg);
9601: $result.=<<OFFLOAD
1.1210 raeburn 9602: <meta http-equiv="pragma" content="no-cache" />
9603: <script type="text/javascript">
1.1215 raeburn 9604: // <![CDATA[
1.1210 raeburn 9605: function LC_Offload_Now() {
9606: var dest = "$newurl";
9607: if (dest != '') {
9608: window.location.href="$newurl";
9609: }
9610: }
1.1214 raeburn 9611: \$(document).ready(function () {
9612: window.alert('$msg');
9613: if ($disable_submit) {
1.1210 raeburn 9614: \$(".LC_hwk_submit").prop("disabled", true);
9615: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9616: }
9617: setTimeout('LC_Offload_Now()', $timeout);
9618: });
1.1215 raeburn 9619: // ]]>
1.1210 raeburn 9620: </script>
9621: OFFLOAD
9622: }
9623: }
9624: }
9625: }
9626: }
1.313 albertel 9627: }
1.306 albertel 9628: if (!defined($title)) {
9629: $title = 'The LearningOnline Network with CAPA';
9630: }
1.460 albertel 9631: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9632: if ($title =~ /^LON-CAPA\s+/) {
9633: $result .= '<title> '.$title.'</title>';
9634: } else {
9635: $result .= '<title> LON-CAPA '.$title.'</title>';
9636: }
9637: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9638: if (!$args->{'frameset'}) {
9639: $result .= ' /';
9640: }
9641: $result .= '>'
1.1064 raeburn 9642: .$inhibitprint
1.414 albertel 9643: .$head_extra;
1.1242 raeburn 9644: my $clientmobile;
9645: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9646: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9647: } else {
9648: $clientmobile = $env{'browser.mobile'};
9649: }
9650: if ($clientmobile) {
1.1137 raeburn 9651: $result .= '
9652: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
9653: <meta name="apple-mobile-web-app-capable" content="yes" />';
9654: }
1.1278 raeburn 9655: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9656: return $result.'</head>';
1.306 albertel 9657: }
9658:
9659: =pod
9660:
1.340 albertel 9661: =item * &font_settings()
9662:
9663: Returns neccessary <meta> to set the proper encoding
9664:
1.1160 raeburn 9665: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9666:
9667: =cut
9668:
9669: sub font_settings {
1.1160 raeburn 9670: my ($args) = @_;
1.340 albertel 9671: my $headerstring='';
1.1160 raeburn 9672: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9673: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9674: $headerstring.=
9675: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9676: if (!$args->{'frameset'}) {
9677: $headerstring.= ' /';
9678: }
9679: $headerstring .= '>'."\n";
1.340 albertel 9680: }
9681: return $headerstring;
9682: }
9683:
1.341 albertel 9684: =pod
9685:
1.1064 raeburn 9686: =item * &print_suppression()
9687:
9688: In course context returns css which causes the body to be blank when media="print",
9689: if printout generation is unavailable for the current resource.
9690:
9691: This could be because:
9692:
9693: (a) printstartdate is in the future
9694:
9695: (b) printenddate is in the past
9696:
9697: (c) there is an active exam block with "printout"
9698: functionality blocked
9699:
9700: Users with pav, pfo or evb privileges are exempt.
9701:
9702: Inputs: none
9703:
9704: =cut
9705:
9706:
9707: sub print_suppression {
9708: my $noprint;
9709: if ($env{'request.course.id'}) {
9710: my $scope = $env{'request.course.id'};
9711: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9712: (&Apache::lonnet::allowed('pfo',$scope))) {
9713: return;
9714: }
9715: if ($env{'request.course.sec'} ne '') {
9716: $scope .= "/$env{'request.course.sec'}";
9717: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9718: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9719: return;
1.1064 raeburn 9720: }
9721: }
9722: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9723: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9724: my $clientip = &Apache::lonnet::get_requestor_ip();
9725: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9726: if ($blocked) {
9727: my $checkrole = "cm./$cdom/$cnum";
9728: if ($env{'request.course.sec'} ne '') {
9729: $checkrole .= "/$env{'request.course.sec'}";
9730: }
9731: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9732: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9733: $noprint = 1;
9734: }
9735: }
9736: unless ($noprint) {
9737: my $symb = &Apache::lonnet::symbread();
9738: if ($symb ne '') {
9739: my $navmap = Apache::lonnavmaps::navmap->new();
9740: if (ref($navmap)) {
9741: my $res = $navmap->getBySymb($symb);
9742: if (ref($res)) {
9743: if (!$res->resprintable()) {
9744: $noprint = 1;
9745: }
9746: }
9747: }
9748: }
9749: }
9750: if ($noprint) {
9751: return <<"ENDSTYLE";
9752: <style type="text/css" media="print">
9753: body { display:none }
9754: </style>
9755: ENDSTYLE
9756: }
9757: }
9758: return;
9759: }
9760:
9761: =pod
9762:
1.341 albertel 9763: =item * &xml_begin()
9764:
9765: Returns the needed doctype and <html>
9766:
9767: Inputs: none
9768:
9769: =cut
9770:
9771: sub xml_begin {
1.1168 raeburn 9772: my ($is_frameset) = @_;
1.341 albertel 9773: my $output='';
9774:
9775: if ($env{'browser.mathml'}) {
9776: $output='<?xml version="1.0"?>'
9777: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9778: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9779:
9780: # .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
9781: .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
9782: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9783: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9784: } elsif ($is_frameset) {
9785: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9786: '<html>'."\n";
1.341 albertel 9787: } else {
1.1168 raeburn 9788: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9789: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9790: }
9791: return $output;
9792: }
1.340 albertel 9793:
9794: =pod
9795:
1.306 albertel 9796: =item * &start_page()
9797:
9798: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9799:
1.648 raeburn 9800: Inputs:
9801:
9802: =over 4
9803:
9804: $title - optional title for the page
9805:
9806: $head_extra - optional extra HTML to incude inside the <head>
9807:
9808: $args - additional optional args supported are:
9809:
9810: =over 8
9811:
9812: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9813: arg on
1.814 bisitz 9814: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9815: add_entries -> additional attributes to add to the <body>
9816: domain -> force to color decorate a page for a
1.317 albertel 9817: specific domain
1.648 raeburn 9818: function -> force usage of a specific rolish color
1.317 albertel 9819: scheme
1.648 raeburn 9820: redirect -> see &headtag()
9821: bgcolor -> override the default page bg color
9822: js_ready -> return a string ready for being used in
1.317 albertel 9823: a javascript writeln
1.648 raeburn 9824: html_encode -> return a string ready for being used in
1.320 albertel 9825: a html attribute
1.648 raeburn 9826: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9827: $forcereg arg
1.648 raeburn 9828: frameset -> if true will start with a <frameset>
1.330 albertel 9829: rather than <body>
1.648 raeburn 9830: skip_phases -> hash ref of
1.338 albertel 9831: head -> skip the <html><head> generation
9832: body -> skip all <body> generation
1.648 raeburn 9833: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9834: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9835: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 9836: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9837: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9838: group -> includes the current group, if page is for a
1.1274 raeburn 9839: specific group
9840: use_absolute -> for request for external resource or syllabus, this
9841: will contain https://<hostname> if server uses
9842: https (as per hosts.tab), but request is for http
9843: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9844: links_disabled -> Links in primary and secondary menus are disabled
9845: (Can enable them once page has loaded - see lonroles.pm
9846: for an example).
1.1380 raeburn 9847: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9848:
1.648 raeburn 9849: =back
1.460 albertel 9850:
1.648 raeburn 9851: =back
1.562 albertel 9852:
1.306 albertel 9853: =cut
9854:
9855: sub start_page {
1.309 albertel 9856: my ($title,$head_extra,$args) = @_;
1.318 albertel 9857: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9858:
1.315 albertel 9859: $env{'internal.start_page'}++;
1.1359 raeburn 9860: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9861:
1.338 albertel 9862: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9863: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9864: }
1.1316 raeburn 9865:
9866: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9867: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9868: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9869: $args->{'no_primary_menu'} = 1;
9870: }
9871: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9872: $args->{'no_inline_menu'} = 1;
9873: }
9874: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9875: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9876: }
9877: } else {
9878: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9879: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9880: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9881: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9882: $args->{'no_primary_menu'} = 1;
9883: }
9884: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9885: $args->{'no_inline_menu'} = 1;
9886: }
9887: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9888: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9889: }
9890: }
9891: }
1.1316 raeburn 9892: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9893: $env{'course.'.$env{'request.course.id'}.'.domain'},
9894: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9895: } elsif ($env{'request.course.id'}) {
9896: my $expiretime=600;
9897: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9898: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9899: }
9900: my ($deeplinkmenu,$menuref);
9901: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9902: if ($menucoll) {
9903: if (ref($menuref) eq 'HASH') {
9904: %menu = %{$menuref};
9905: }
9906: if ($menu{'top'} eq 'n') {
9907: $args->{'no_primary_menu'} = 1;
9908: }
9909: if ($menu{'inline'} eq 'n') {
9910: unless (&Apache::lonnet::allowed('opa')) {
9911: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9912: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9913: my $crstype = &course_type();
9914: my $now = time;
9915: my $ccrole;
9916: if ($crstype eq 'Community') {
9917: $ccrole = 'co';
9918: } else {
9919: $ccrole = 'cc';
9920: }
9921: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9922: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9923: if ((($start) && ($start<0)) ||
9924: (($end) && ($end<$now)) ||
9925: (($start) && ($now<$start))) {
9926: $args->{'no_inline_menu'} = 1;
9927: }
9928: } else {
9929: $args->{'no_inline_menu'} = 1;
9930: }
9931: }
9932: }
9933: }
1.1316 raeburn 9934: }
1.1359 raeburn 9935:
1.1385 raeburn 9936: my $showncrumbs;
1.338 albertel 9937: if (! exists($args->{'skip_phases'}{'body'}) ) {
9938: if ($args->{'frameset'}) {
9939: my $attr_string = &make_attr_string($args->{'force_register'},
9940: $args->{'add_entries'});
9941: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9942: } else {
9943: $result .=
9944: &bodytag($title,
9945: $args->{'function'}, $args->{'add_entries'},
9946: $args->{'only_body'}, $args->{'domain'},
9947: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9948: $args->{'bgcolor'}, $args,
1.1385 raeburn 9949: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9950: \%menu,\$showncrumbs);
1.831 bisitz 9951: }
1.330 albertel 9952: }
1.338 albertel 9953:
1.315 albertel 9954: if ($args->{'js_ready'}) {
1.713 kaisler 9955: $result = &js_ready($result);
1.315 albertel 9956: }
1.320 albertel 9957: if ($args->{'html_encode'}) {
1.713 kaisler 9958: $result = &html_encode($result);
9959: }
9960:
1.813 bisitz 9961: # Preparation for new and consistent functionlist at top of screen
9962: # if ($args->{'functionlist'}) {
9963: # $result .= &build_functionlist();
9964: #}
9965:
1.964 droeschl 9966: # Don't add anything more if only_body wanted or in const space
9967: return $result if $args->{'only_body'}
9968: || $env{'request.state'} eq 'construct';
1.813 bisitz 9969:
9970: #Breadcrumbs
1.758 kaisler 9971: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 9972: unless ($showncrumbs) {
1.758 kaisler 9973: &Apache::lonhtmlcommon::clear_breadcrumbs();
9974: #if any br links exists, add them to the breadcrumbs
9975: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9976: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9977: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9978: }
9979: }
1.1096 raeburn 9980: # if @advtools array contains items add then to the breadcrumbs
9981: if (@advtools > 0) {
9982: &Apache::lonmenu::advtools_crumbs(@advtools);
9983: }
1.1272 raeburn 9984: my $menulink;
9985: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9986: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9987: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9988: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9989: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9990: (!$env{'request.role.adv'}))) {
9991: $menulink = 0;
9992: } else {
9993: undef($menulink);
9994: }
1.1385 raeburn 9995: my $linkprotout;
9996: if ($env{'request.deeplink.login'}) {
9997: my $linkprotout = &Apache::lonmenu::linkprot_exit();
9998: if ($linkprotout) {
9999: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10000: }
10001: }
1.758 kaisler 10002: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10003: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 10004: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 10005: } else {
1.1272 raeburn 10006: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 10007: }
1.1385 raeburn 10008: }
1.320 albertel 10009: }
1.315 albertel 10010: return $result;
1.306 albertel 10011: }
10012:
10013: sub end_page {
1.315 albertel 10014: my ($args) = @_;
10015: $env{'internal.end_page'}++;
1.330 albertel 10016: my $result;
1.335 albertel 10017: if ($args->{'discussion'}) {
10018: my ($target,$parser);
10019: if (ref($args->{'discussion'})) {
10020: ($target,$parser) =($args->{'discussion'}{'target'},
10021: $args->{'discussion'}{'parser'});
10022: }
10023: $result .= &Apache::lonxml::xmlend($target,$parser);
10024: }
1.330 albertel 10025: if ($args->{'frameset'}) {
10026: $result .= '</frameset>';
10027: } else {
1.635 raeburn 10028: $result .= &endbodytag($args);
1.330 albertel 10029: }
1.1080 raeburn 10030: unless ($args->{'notbody'}) {
10031: $result .= "\n</html>";
10032: }
1.330 albertel 10033:
1.315 albertel 10034: if ($args->{'js_ready'}) {
1.317 albertel 10035: $result = &js_ready($result);
1.315 albertel 10036: }
1.335 albertel 10037:
1.320 albertel 10038: if ($args->{'html_encode'}) {
10039: $result = &html_encode($result);
10040: }
1.335 albertel 10041:
1.315 albertel 10042: return $result;
10043: }
10044:
1.1359 raeburn 10045: sub menucoll_in_effect {
10046: my ($menucoll,$deeplinkmenu,%menu);
10047: if ($env{'request.course.id'}) {
10048: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10049: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10050: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10051: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10052: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10053: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10054: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10055: my $navmap = Apache::lonnavmaps::navmap->new();
10056: if (ref($navmap)) {
10057: $deeplink = $navmap->get_mapparam(undef,
10058: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10059: '0.deeplink');
1.1370 raeburn 10060: } else {
10061: $check_login_symb = 1;
1.1362 raeburn 10062: }
10063: } else {
1.1370 raeburn 10064: my $symb = &Apache::lonnet::symbread();
10065: if ($symb) {
10066: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10067: } else {
10068: $check_login_symb = 1;
10069: }
1.1362 raeburn 10070: }
10071: } else {
1.1370 raeburn 10072: $check_login_symb = 1;
10073: }
10074: if ($check_login_symb) {
1.1362 raeburn 10075: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10076: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10077: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10078: my $navmap = Apache::lonnavmaps::navmap->new();
10079: if (ref($navmap)) {
10080: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10081: }
10082: } else {
10083: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10084: }
10085: }
1.1359 raeburn 10086: if ($deeplink ne '') {
1.1378 raeburn 10087: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10088: if ($display =~ /^\d+$/) {
10089: $deeplinkmenu = 1;
10090: $menucoll = $display;
10091: }
10092: }
10093: }
10094: if ($menucoll) {
10095: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10096: }
10097: }
10098: return ($menucoll,$deeplinkmenu,\%menu);
10099: }
10100:
1.1362 raeburn 10101: sub deeplink_login_symb {
10102: my ($cnum,$cdom) = @_;
10103: my $login_symb;
10104: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10105: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10106: }
10107: return $login_symb;
10108: }
10109:
10110: sub symb_from_tinyurl {
10111: my ($url,$cnum,$cdom) = @_;
10112: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10113: my $key = $1;
10114: my ($tinyurl,$login);
10115: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10116: if (defined($cached)) {
10117: $tinyurl = $result;
10118: } else {
10119: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10120: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10121: if ($currtiny{$key} ne '') {
10122: $tinyurl = $currtiny{$key};
10123: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10124: }
1.1364 raeburn 10125: }
10126: if ($tinyurl ne '') {
10127: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10128: if (wantarray) {
10129: return ($cnumreq,$symb);
10130: } elsif ($cnumreq eq $cnum) {
10131: return $symb;
1.1362 raeburn 10132: }
10133: }
10134: }
1.1364 raeburn 10135: if (wantarray) {
10136: return ();
10137: } else {
10138: return;
10139: }
1.1362 raeburn 10140: }
10141:
1.1405 raeburn 10142: sub usable_exttools {
10143: my %tooltypes;
10144: if ($env{'request.course.id'}) {
10145: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10146: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10147: %tooltypes = (
10148: crs => 1,
10149: dom => 1,
10150: );
10151: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10152: $tooltypes{'crs'} = 1;
10153: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10154: $tooltypes{'dom'} = 1;
10155: }
10156: } else {
10157: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10158: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10159: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10160: if ($crstype eq '') {
10161: $crstype = 'course';
10162: }
10163: if ($crstype eq 'course') {
10164: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10165: $crstype = 'official';
10166: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10167: $crstype = 'textbook';
10168: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10169: $crstype = 'lti';
10170: } else {
10171: $crstype = 'unofficial';
10172: }
10173: }
10174: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10175: if ($domdefaults{$crstype.'domexttool'}) {
10176: $tooltypes{'dom'} = 1;
10177: }
10178: if ($domdefaults{$crstype.'exttool'}) {
10179: $tooltypes{'crs'} = 1;
10180: }
10181: }
10182: }
10183: return %tooltypes;
10184: }
10185:
1.1034 www 10186: sub wishlist_window {
10187: return(<<'ENDWISHLIST');
1.1046 raeburn 10188: <script type="text/javascript">
1.1034 www 10189: // <![CDATA[
10190: // <!-- BEGIN LON-CAPA Internal
10191: function set_wishlistlink(title, path) {
10192: if (!title) {
10193: title = document.title;
10194: title = title.replace(/^LON-CAPA /,'');
10195: }
1.1175 raeburn 10196: title = encodeURIComponent(title);
1.1203 raeburn 10197: title = title.replace("'","\\\'");
1.1034 www 10198: if (!path) {
10199: path = location.pathname;
10200: }
1.1175 raeburn 10201: path = encodeURIComponent(path);
1.1203 raeburn 10202: path = path.replace("'","\\\'");
1.1034 www 10203: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10204: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10205: }
10206: // END LON-CAPA Internal -->
10207: // ]]>
10208: </script>
10209: ENDWISHLIST
10210: }
10211:
1.1030 www 10212: sub modal_window {
10213: return(<<'ENDMODAL');
1.1046 raeburn 10214: <script type="text/javascript">
1.1030 www 10215: // <![CDATA[
10216: // <!-- BEGIN LON-CAPA Internal
10217: var modalWindow = {
10218: parent:"body",
10219: windowId:null,
10220: content:null,
10221: width:null,
10222: height:null,
10223: close:function()
10224: {
10225: $(".LCmodal-window").remove();
10226: $(".LCmodal-overlay").remove();
10227: },
10228: open:function()
10229: {
10230: var modal = "";
10231: modal += "<div class=\"LCmodal-overlay\"></div>";
10232: modal += "<div id=\"" + this.windowId + "\" class=\"LCmodal-window\" style=\"width:" + this.width + "px; height:" + this.height + "px; margin-top:-" + (this.height / 2) + "px; margin-left:-" + (this.width / 2) + "px;\">";
10233: modal += this.content;
10234: modal += "</div>";
10235:
10236: $(this.parent).append(modal);
10237:
10238: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10239: $(".LCclose-window").click(function(){modalWindow.close();});
10240: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10241: }
10242: };
1.1140 raeburn 10243: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10244: {
1.1266 raeburn 10245: source = source.replace(/'/g,"'");
1.1030 www 10246: modalWindow.windowId = "myModal";
10247: modalWindow.width = width;
10248: modalWindow.height = height;
1.1196 raeburn 10249: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10250: modalWindow.open();
1.1208 raeburn 10251: };
1.1030 www 10252: // END LON-CAPA Internal -->
10253: // ]]>
10254: </script>
10255: ENDMODAL
10256: }
10257:
10258: sub modal_link {
1.1140 raeburn 10259: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10260: unless ($width) { $width=480; }
10261: unless ($height) { $height=400; }
1.1031 www 10262: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10263: unless ($transparency) { $transparency='true'; }
10264:
1.1074 raeburn 10265: my $target_attr;
10266: if (defined($target)) {
10267: $target_attr = 'target="'.$target.'"';
10268: }
10269: return <<"ENDLINK";
1.1336 raeburn 10270: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10271: ENDLINK
1.1030 www 10272: }
10273:
1.1032 www 10274: sub modal_adhoc_script {
1.1365 raeburn 10275: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10276: my $mathjax;
10277: if ($possmathjax) {
10278: $mathjax = <<'ENDJAX';
10279: if (typeof MathJax == 'object') {
10280: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10281: }
10282: ENDJAX
10283: }
1.1032 www 10284: return (<<ENDADHOC);
1.1046 raeburn 10285: <script type="text/javascript">
1.1032 www 10286: // <![CDATA[
10287: var $funcname = function()
10288: {
10289: modalWindow.windowId = "myModal";
10290: modalWindow.width = $width;
10291: modalWindow.height = $height;
10292: modalWindow.content = '$content';
10293: modalWindow.open();
1.1365 raeburn 10294: $mathjax
1.1032 www 10295: };
10296: // ]]>
10297: </script>
10298: ENDADHOC
10299: }
10300:
1.1041 www 10301: sub modal_adhoc_inner {
1.1365 raeburn 10302: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10303: my $innerwidth=$width-20;
10304: $content=&js_ready(
1.1140 raeburn 10305: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10306: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10307: $content.
1.1041 www 10308: &end_scrollbox().
1.1140 raeburn 10309: &end_page()
1.1041 www 10310: );
1.1365 raeburn 10311: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10312: }
10313:
10314: sub modal_adhoc_window {
1.1365 raeburn 10315: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10316: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10317: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10318: }
10319:
10320: sub modal_adhoc_launch {
10321: my ($funcname,$width,$height,$content)=@_;
10322: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10323: <script type="text/javascript">
10324: // <![CDATA[
10325: $funcname();
10326: // ]]>
10327: </script>
10328: ENDLAUNCH
10329: }
10330:
10331: sub modal_adhoc_close {
10332: return (<<ENDCLOSE);
10333: <script type="text/javascript">
10334: // <![CDATA[
10335: modalWindow.close();
10336: // ]]>
10337: </script>
10338: ENDCLOSE
10339: }
10340:
1.1038 www 10341: sub togglebox_script {
10342: return(<<ENDTOGGLE);
10343: <script type="text/javascript">
10344: // <![CDATA[
10345: function LCtoggleDisplay(id,hidetext,showtext) {
10346: link = document.getElementById(id + "link").childNodes[0];
10347: with (document.getElementById(id).style) {
10348: if (display == "none" ) {
10349: display = "inline";
10350: link.nodeValue = hidetext;
10351: } else {
10352: display = "none";
10353: link.nodeValue = showtext;
10354: }
10355: }
10356: }
10357: // ]]>
10358: </script>
10359: ENDTOGGLE
10360: }
10361:
1.1039 www 10362: sub start_togglebox {
10363: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10364: unless ($heading) { $heading=''; } else { $heading.=' '; }
10365: unless ($showtext) { $showtext=&mt('show'); }
10366: unless ($hidetext) { $hidetext=&mt('hide'); }
10367: unless ($headerbg) { $headerbg='#FFFFFF'; }
10368: return &start_data_table().
10369: &start_data_table_header_row().
10370: '<td bgcolor="'.$headerbg.'">'.$heading.
10371: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10372: $showtext.'\')">'.$showtext.'</a>]</td>'.
10373: &end_data_table_header_row().
10374: '<tr id="'.$id.'" style="display:none""><td>';
10375: }
10376:
10377: sub end_togglebox {
10378: return '</td></tr>'.&end_data_table();
10379: }
10380:
1.1041 www 10381: sub LCprogressbar_script {
1.1302 raeburn 10382: my ($id,$number_to_do)=@_;
10383: if ($number_to_do) {
10384: return(<<ENDPROGRESS);
1.1041 www 10385: <script type="text/javascript">
10386: // <![CDATA[
1.1045 www 10387: \$('#progressbar$id').progressbar({
1.1041 www 10388: value: 0,
10389: change: function(event, ui) {
10390: var newVal = \$(this).progressbar('option', 'value');
10391: \$('.pblabel', this).text(LCprogressTxt);
10392: }
10393: });
10394: // ]]>
10395: </script>
10396: ENDPROGRESS
1.1302 raeburn 10397: } else {
10398: return(<<ENDPROGRESS);
10399: <script type="text/javascript">
10400: // <![CDATA[
10401: \$('#progressbar$id').progressbar({
10402: value: false,
10403: create: function(event, ui) {
10404: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10405: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10406: }
10407: });
10408: // ]]>
10409: </script>
10410: ENDPROGRESS
10411: }
1.1041 www 10412: }
10413:
10414: sub LCprogressbarUpdate_script {
10415: return(<<ENDPROGRESSUPDATE);
10416: <style type="text/css">
10417: .ui-progressbar { position:relative; }
1.1302 raeburn 10418: .progress-label {position: absolute; width: 100%; text-align: center; top: 1px; font-weight: bold; text-shadow: 1px 1px 0 #fff;margin: 0; line-height: 200%; }
1.1041 www 10419: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10420: </style>
10421: <script type="text/javascript">
10422: // <![CDATA[
1.1045 www 10423: var LCprogressTxt='---';
10424:
1.1302 raeburn 10425: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10426: LCprogressTxt=progresstext;
1.1302 raeburn 10427: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10428: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10429: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10430: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10431: } else {
10432: \$('#progressbar'+id).progressbar('value',percent);
10433: }
1.1041 www 10434: }
10435: // ]]>
10436: </script>
10437: ENDPROGRESSUPDATE
10438: }
10439:
1.1042 www 10440: my $LClastpercent;
1.1045 www 10441: my $LCidcnt;
10442: my $LCcurrentid;
1.1042 www 10443:
1.1041 www 10444: sub LCprogressbar {
1.1302 raeburn 10445: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10446: $LClastpercent=0;
1.1045 www 10447: $LCidcnt++;
10448: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10449: my ($starting,$content);
10450: if ($number_to_do) {
10451: $starting=&mt('Starting');
10452: $content=(<<ENDPROGBAR);
10453: $preamble
1.1045 www 10454: <div id="progressbar$LCcurrentid">
1.1041 www 10455: <span class="pblabel">$starting</span>
10456: </div>
10457: ENDPROGBAR
1.1302 raeburn 10458: } else {
10459: $starting=&mt('Loading...');
10460: $LClastpercent='false';
10461: $content=(<<ENDPROGBAR);
10462: $preamble
10463: <div id="progressbar$LCcurrentid">
10464: <div class="progress-label">$starting</div>
10465: </div>
10466: ENDPROGBAR
10467: }
10468: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10469: }
10470:
10471: sub LCprogressbarUpdate {
1.1302 raeburn 10472: my ($r,$val,$text,$number_to_do)=@_;
10473: if ($number_to_do) {
10474: unless ($val) {
10475: if ($LClastpercent) {
10476: $val=$LClastpercent;
10477: } else {
10478: $val=0;
10479: }
10480: }
10481: if ($val<0) { $val=0; }
10482: if ($val>100) { $val=0; }
10483: $LClastpercent=$val;
10484: unless ($text) { $text=$val.'%'; }
10485: } else {
10486: $val = 'false';
1.1042 www 10487: }
1.1041 www 10488: $text=&js_ready($text);
1.1044 www 10489: &r_print($r,<<ENDUPDATE);
1.1041 www 10490: <script type="text/javascript">
10491: // <![CDATA[
1.1302 raeburn 10492: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10493: // ]]>
10494: </script>
10495: ENDUPDATE
1.1035 www 10496: }
10497:
1.1042 www 10498: sub LCprogressbarClose {
10499: my ($r)=@_;
10500: $LClastpercent=0;
1.1044 www 10501: &r_print($r,<<ENDCLOSE);
1.1042 www 10502: <script type="text/javascript">
10503: // <![CDATA[
1.1045 www 10504: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10505: // ]]>
10506: </script>
10507: ENDCLOSE
1.1044 www 10508: }
10509:
10510: sub r_print {
10511: my ($r,$to_print)=@_;
10512: if ($r) {
10513: $r->print($to_print);
10514: $r->rflush();
10515: } else {
10516: print($to_print);
10517: }
1.1042 www 10518: }
10519:
1.320 albertel 10520: sub html_encode {
10521: my ($result) = @_;
10522:
1.322 albertel 10523: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10524:
10525: return $result;
10526: }
1.1044 www 10527:
1.317 albertel 10528: sub js_ready {
10529: my ($result) = @_;
10530:
1.323 albertel 10531: $result =~ s/[\n\r]/ /xmsg;
10532: $result =~ s/\\/\\\\/xmsg;
10533: $result =~ s/'/\\'/xmsg;
1.372 albertel 10534: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10535:
10536: return $result;
10537: }
10538:
1.315 albertel 10539: sub validate_page {
10540: if ( exists($env{'internal.start_page'})
1.316 albertel 10541: && $env{'internal.start_page'} > 1) {
10542: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10543: $env{'internal.start_page'}.' '.
1.316 albertel 10544: $ENV{'request.filename'});
1.315 albertel 10545: }
10546: if ( exists($env{'internal.end_page'})
1.316 albertel 10547: && $env{'internal.end_page'} > 1) {
10548: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10549: $env{'internal.end_page'}.' '.
1.316 albertel 10550: $env{'request.filename'});
1.315 albertel 10551: }
10552: if ( exists($env{'internal.start_page'})
10553: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10554: &Apache::lonnet::logthis('start_page called without end_page '.
10555: $env{'request.filename'});
1.315 albertel 10556: }
10557: if ( ! exists($env{'internal.start_page'})
10558: && exists($env{'internal.end_page'})) {
1.316 albertel 10559: &Apache::lonnet::logthis('end_page called without start_page'.
10560: $env{'request.filename'});
1.315 albertel 10561: }
1.306 albertel 10562: }
1.315 albertel 10563:
1.996 www 10564:
10565: sub start_scrollbox {
1.1140 raeburn 10566: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10567: unless ($outerwidth) { $outerwidth='520px'; }
10568: unless ($width) { $width='500px'; }
10569: unless ($height) { $height='200px'; }
1.1075 raeburn 10570: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10571: if ($id ne '') {
1.1140 raeburn 10572: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10573: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10574: }
1.1075 raeburn 10575: if ($bgcolor ne '') {
10576: $tdcol = "background-color: $bgcolor;";
10577: }
1.1137 raeburn 10578: my $nicescroll_js;
10579: if ($env{'browser.mobile'}) {
1.1140 raeburn 10580: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10581: }
10582: return <<"END";
10583: $nicescroll_js
10584:
10585: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10586: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10587: END
10588: }
10589:
10590: sub end_scrollbox {
10591: return '</div></td></tr></table>';
10592: }
10593:
10594: sub nicescroll_javascript {
10595: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10596: my %options;
10597: if (ref($cursor) eq 'HASH') {
10598: %options = %{$cursor};
10599: }
10600: unless ($options{'railalign'} =~ /^left|right$/) {
10601: $options{'railalign'} = 'left';
10602: }
10603: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10604: my $function = &get_users_function();
10605: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10606: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10607: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10608: }
1.1140 raeburn 10609: }
10610: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10611: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10612: $options{'cursoropacity'}='1.0';
10613: }
1.1140 raeburn 10614: } else {
10615: $options{'cursoropacity'}='1.0';
10616: }
10617: if ($options{'cursorfixedheight'} eq 'none') {
10618: delete($options{'cursorfixedheight'});
10619: } else {
10620: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10621: }
10622: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10623: delete($options{'railoffset'});
10624: }
10625: my @niceoptions;
10626: while (my($key,$value) = each(%options)) {
10627: if ($value =~ /^\{.+\}$/) {
10628: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10629: } else {
1.1140 raeburn 10630: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10631: }
1.1140 raeburn 10632: }
10633: my $nicescroll_js = '
1.1137 raeburn 10634: $(document).ready(
1.1140 raeburn 10635: function() {
10636: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10637: }
1.1137 raeburn 10638: );
10639: ';
1.1140 raeburn 10640: if ($framecheck) {
10641: $nicescroll_js .= '
10642: function expand_div(caller) {
10643: if (top === self) {
10644: document.getElementById("'.$id.'").style.width = "auto";
10645: document.getElementById("'.$id.'").style.height = "auto";
10646: } else {
10647: try {
10648: if (parent.frames) {
10649: if (parent.frames.length > 1) {
10650: var framesrc = parent.frames[1].location.href;
10651: var currsrc = framesrc.replace(/\#.*$/,"");
10652: if ((caller == "search") || (currsrc == "'.$location.'")) {
10653: document.getElementById("'.$id.'").style.width = "auto";
10654: document.getElementById("'.$id.'").style.height = "auto";
10655: }
10656: }
10657: }
10658: } catch (e) {
10659: return;
10660: }
1.1137 raeburn 10661: }
1.1140 raeburn 10662: return;
1.996 www 10663: }
1.1140 raeburn 10664: ';
10665: }
10666: if ($needjsready) {
10667: $nicescroll_js = '
10668: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10669: } else {
10670: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10671: }
10672: return $nicescroll_js;
1.996 www 10673: }
10674:
1.318 albertel 10675: sub simple_error_page {
1.1150 bisitz 10676: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10677: my %displayargs;
1.1151 raeburn 10678: if (ref($args) eq 'HASH') {
10679: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10680: if ($args->{'only_body'}) {
10681: $displayargs{'only_body'} = 1;
10682: }
10683: if ($args->{'no_nav_bar'}) {
10684: $displayargs{'no_nav_bar'} = 1;
10685: }
1.1151 raeburn 10686: } else {
10687: $msg = &mt($msg);
10688: }
1.1150 bisitz 10689:
1.318 albertel 10690: my $page =
1.1304 raeburn 10691: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10692: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10693: &Apache::loncommon::end_page();
10694: if (ref($r)) {
10695: $r->print($page);
1.327 albertel 10696: return;
1.318 albertel 10697: }
10698: return $page;
10699: }
1.347 albertel 10700:
10701: {
1.610 albertel 10702: my @row_count;
1.961 onken 10703:
10704: sub start_data_table_count {
10705: unshift(@row_count, 0);
10706: return;
10707: }
10708:
10709: sub end_data_table_count {
10710: shift(@row_count);
10711: return;
10712: }
10713:
1.347 albertel 10714: sub start_data_table {
1.1018 raeburn 10715: my ($add_class,$id) = @_;
1.422 albertel 10716: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10717: my $table_id;
10718: if (defined($id)) {
10719: $table_id = ' id="'.$id.'"';
10720: }
1.961 onken 10721: &start_data_table_count();
1.1018 raeburn 10722: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10723: }
10724:
10725: sub end_data_table {
1.961 onken 10726: &end_data_table_count();
1.389 albertel 10727: return '</table>'."\n";;
1.347 albertel 10728: }
10729:
10730: sub start_data_table_row {
1.974 wenzelju 10731: my ($add_class, $id) = @_;
1.610 albertel 10732: $row_count[0]++;
10733: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10734: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10735: $id = (' id="'.$id.'"') unless ($id eq '');
10736: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10737: }
1.471 banghart 10738:
10739: sub continue_data_table_row {
1.974 wenzelju 10740: my ($add_class, $id) = @_;
1.610 albertel 10741: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10742: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10743: $id = (' id="'.$id.'"') unless ($id eq '');
10744: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10745: }
1.347 albertel 10746:
10747: sub end_data_table_row {
1.389 albertel 10748: return '</tr>'."\n";;
1.347 albertel 10749: }
1.367 www 10750:
1.421 albertel 10751: sub start_data_table_empty_row {
1.707 bisitz 10752: # $row_count[0]++;
1.421 albertel 10753: return '<tr class="LC_empty_row" >'."\n";;
10754: }
10755:
10756: sub end_data_table_empty_row {
10757: return '</tr>'."\n";;
10758: }
10759:
1.367 www 10760: sub start_data_table_header_row {
1.389 albertel 10761: return '<tr class="LC_header_row">'."\n";;
1.367 www 10762: }
10763:
10764: sub end_data_table_header_row {
1.389 albertel 10765: return '</tr>'."\n";;
1.367 www 10766: }
1.890 droeschl 10767:
10768: sub data_table_caption {
10769: my $caption = shift;
10770: return "<caption class=\"LC_caption\">$caption</caption>";
10771: }
1.347 albertel 10772: }
10773:
1.548 albertel 10774: =pod
10775:
10776: =item * &inhibit_menu_check($arg)
10777:
10778: Checks for a inhibitmenu state and generates output to preserve it
10779:
10780: Inputs: $arg - can be any of
10781: - undef - in which case the return value is a string
10782: to add into arguments list of a uri
10783: - 'input' - in which case the return value is a HTML
10784: <form> <input> field of type hidden to
10785: preserve the value
10786: - a url - in which case the return value is the url with
10787: the neccesary cgi args added to preserve the
10788: inhibitmenu state
10789: - a ref to a url - no return value, but the string is
10790: updated to include the neccessary cgi
10791: args to preserve the inhibitmenu state
10792:
10793: =cut
10794:
10795: sub inhibit_menu_check {
10796: my ($arg) = @_;
10797: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10798: if ($arg eq 'input') {
10799: if ($env{'form.inhibitmenu'}) {
10800: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10801: } else {
10802: return
10803: }
10804: }
10805: if ($env{'form.inhibitmenu'}) {
10806: if (ref($arg)) {
10807: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10808: } elsif ($arg eq '') {
10809: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10810: } else {
10811: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10812: }
10813: }
10814: if (!ref($arg)) {
10815: return $arg;
10816: }
10817: }
10818:
1.251 albertel 10819: ###############################################
1.182 matthew 10820:
10821: =pod
10822:
1.549 albertel 10823: =back
10824:
10825: =head1 User Information Routines
10826:
10827: =over 4
10828:
1.405 albertel 10829: =item * &get_users_function()
1.182 matthew 10830:
10831: Used by &bodytag to determine the current users primary role.
10832: Returns either 'student','coordinator','admin', or 'author'.
10833:
10834: =cut
10835:
10836: ###############################################
10837: sub get_users_function {
1.815 tempelho 10838: my $function = 'norole';
1.818 tempelho 10839: if ($env{'request.role'}=~/^(st)/) {
10840: $function='student';
10841: }
1.907 raeburn 10842: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10843: $function='coordinator';
10844: }
1.258 albertel 10845: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10846: $function='admin';
10847: }
1.826 bisitz 10848: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10849: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10850: $function='author';
10851: }
10852: return $function;
1.54 www 10853: }
1.99 www 10854:
10855: ###############################################
10856:
1.233 raeburn 10857: =pod
10858:
1.821 raeburn 10859: =item * &show_course()
10860:
10861: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10862: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10863:
10864: Inputs:
10865: None
10866:
10867: Outputs:
10868: Scalar: 1 if 'Course' to be used, 0 otherwise.
10869:
10870: =cut
10871:
10872: ###############################################
10873: sub show_course {
1.1408 raeburn 10874: my ($udom,$uname) = @_;
10875: if (($udom ne '') && ($uname ne '')) {
10876: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10877: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10878: return 0;
10879: } else {
10880: return 1;
10881: }
10882: }
10883: }
1.821 raeburn 10884: my $course = !$env{'user.adv'};
10885: if (!$env{'user.adv'}) {
10886: foreach my $env (keys(%env)) {
10887: next if ($env !~ m/^user\.priv\./);
10888: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10889: $course = 0;
10890: last;
10891: }
10892: }
10893: }
10894: return $course;
10895: }
10896:
10897: ###############################################
10898:
10899: =pod
10900:
1.542 raeburn 10901: =item * &check_user_status()
1.274 raeburn 10902:
10903: Determines current status of supplied role for a
10904: specific user. Roles can be active, previous or future.
10905:
10906: Inputs:
10907: user's domain, user's username, course's domain,
1.375 raeburn 10908: course's number, optional section ID.
1.274 raeburn 10909:
10910: Outputs:
10911: role status: active, previous or future.
10912:
10913: =cut
10914:
10915: sub check_user_status {
1.412 raeburn 10916: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10917: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10918: my @uroles = keys(%userinfo);
1.274 raeburn 10919: my $srchstr;
10920: my $active_chk = 'none';
1.412 raeburn 10921: my $now = time;
1.274 raeburn 10922: if (@uroles > 0) {
1.908 raeburn 10923: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10924: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10925: } else {
1.412 raeburn 10926: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10927: }
10928: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10929: my $role_end = 0;
10930: my $role_start = 0;
10931: $active_chk = 'active';
1.412 raeburn 10932: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10933: $role_end = $1;
10934: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10935: $role_start = $1;
1.274 raeburn 10936: }
10937: }
10938: if ($role_start > 0) {
1.412 raeburn 10939: if ($now < $role_start) {
1.274 raeburn 10940: $active_chk = 'future';
10941: }
10942: }
10943: if ($role_end > 0) {
1.412 raeburn 10944: if ($now > $role_end) {
1.274 raeburn 10945: $active_chk = 'previous';
10946: }
10947: }
10948: }
10949: }
10950: return $active_chk;
10951: }
10952:
10953: ###############################################
10954:
10955: =pod
10956:
1.405 albertel 10957: =item * &get_sections()
1.233 raeburn 10958:
10959: Determines all the sections for a course including
10960: sections with students and sections containing other roles.
1.419 raeburn 10961: Incoming parameters:
10962:
10963: 1. domain
10964: 2. course number
10965: 3. reference to array containing roles for which sections should
10966: be gathered (optional).
10967: 4. reference to array containing status types for which sections
10968: should be gathered (optional).
10969:
10970: If the third argument is undefined, sections are gathered for any role.
10971: If the fourth argument is undefined, sections are gathered for any status.
10972: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10973:
1.374 raeburn 10974: Returns section hash (keys are section IDs, values are
10975: number of users in each section), subject to the
1.419 raeburn 10976: optional roles filter, optional status filter
1.233 raeburn 10977:
10978: =cut
10979:
10980: ###############################################
10981: sub get_sections {
1.419 raeburn 10982: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 10983: if (!defined($cdom) || !defined($cnum)) {
10984: my $cid = $env{'request.course.id'};
10985:
10986: return if (!defined($cid));
10987:
10988: $cdom = $env{'course.'.$cid.'.domain'};
10989: $cnum = $env{'course.'.$cid.'.num'};
10990: }
10991:
10992: my %sectioncount;
1.419 raeburn 10993: my $now = time;
1.240 albertel 10994:
1.1118 raeburn 10995: my $check_students = 1;
10996: my $only_students = 0;
10997: if (ref($possible_roles) eq 'ARRAY') {
10998: if (grep(/^st$/,@{$possible_roles})) {
10999: if (@{$possible_roles} == 1) {
11000: $only_students = 1;
11001: }
11002: } else {
11003: $check_students = 0;
11004: }
11005: }
11006:
11007: if ($check_students) {
1.276 albertel 11008: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11009: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11010: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11011: my $start_index = &Apache::loncoursedata::CL_START();
11012: my $end_index = &Apache::loncoursedata::CL_END();
11013: my $status;
1.366 albertel 11014: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11015: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11016: $data->[$status_index],
11017: $data->[$start_index],
11018: $data->[$end_index]);
11019: if ($stu_status eq 'Active') {
11020: $status = 'active';
11021: } elsif ($end < $now) {
11022: $status = 'previous';
11023: } elsif ($start > $now) {
11024: $status = 'future';
11025: }
11026: if ($section ne '-1' && $section !~ /^\s*$/) {
11027: if ((!defined($possible_status)) || (($status ne '') &&
11028: (grep/^\Q$status\E$/,@{$possible_status}))) {
11029: $sectioncount{$section}++;
11030: }
1.240 albertel 11031: }
11032: }
11033: }
1.1118 raeburn 11034: if ($only_students) {
11035: return %sectioncount;
11036: }
1.240 albertel 11037: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11038: foreach my $user (sort(keys(%courseroles))) {
11039: if ($user !~ /^(\w{2})/) { next; }
11040: my ($role) = ($user =~ /^(\w{2})/);
11041: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11042: my ($section,$status);
1.240 albertel 11043: if ($role eq 'cr' &&
11044: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11045: $section=$1;
11046: }
11047: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11048: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11049: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11050: if ($end == -1 && $start == -1) {
11051: next; #deleted role
11052: }
11053: if (!defined($possible_status)) {
11054: $sectioncount{$section}++;
11055: } else {
11056: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11057: $status = 'active';
11058: } elsif ($end < $now) {
11059: $status = 'future';
11060: } elsif ($start > $now) {
11061: $status = 'previous';
11062: }
11063: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11064: $sectioncount{$section}++;
11065: }
11066: }
1.233 raeburn 11067: }
1.366 albertel 11068: return %sectioncount;
1.233 raeburn 11069: }
11070:
1.274 raeburn 11071: ###############################################
1.294 raeburn 11072:
11073: =pod
1.405 albertel 11074:
11075: =item * &get_course_users()
11076:
1.275 raeburn 11077: Retrieves usernames:domains for users in the specified course
11078: with specific role(s), and access status.
11079:
11080: Incoming parameters:
1.277 albertel 11081: 1. course domain
11082: 2. course number
11083: 3. access status: users must have - either active,
1.275 raeburn 11084: previous, future, or all.
1.277 albertel 11085: 4. reference to array of permissible roles
1.288 raeburn 11086: 5. reference to array of section restrictions (optional)
11087: 6. reference to results object (hash of hashes).
11088: 7. reference to optional userdata hash
1.609 raeburn 11089: 8. reference to optional statushash
1.630 raeburn 11090: 9. flag if privileged users (except those set to unhide in
11091: course settings) should be excluded
1.609 raeburn 11092: Keys of top level results hash are roles.
1.275 raeburn 11093: Keys of inner hashes are username:domain, with
11094: values set to access type.
1.288 raeburn 11095: Optional userdata hash returns an array with arguments in the
11096: same order as loncoursedata::get_classlist() for student data.
11097:
1.609 raeburn 11098: Optional statushash returns
11099:
1.288 raeburn 11100: Entries for end, start, section and status are blank because
11101: of the possibility of multiple values for non-student roles.
11102:
1.275 raeburn 11103: =cut
1.405 albertel 11104:
1.275 raeburn 11105: ###############################################
1.405 albertel 11106:
1.275 raeburn 11107: sub get_course_users {
1.630 raeburn 11108: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11109: my %idx = ();
1.419 raeburn 11110: my %seclists;
1.288 raeburn 11111:
11112: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11113: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11114: $idx{end} = &Apache::loncoursedata::CL_END();
11115: $idx{start} = &Apache::loncoursedata::CL_START();
11116: $idx{id} = &Apache::loncoursedata::CL_ID();
11117: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11118: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11119: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11120:
1.290 albertel 11121: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11122: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11123: my $now = time;
1.277 albertel 11124: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11125: my $match = 0;
1.412 raeburn 11126: my $secmatch = 0;
1.419 raeburn 11127: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11128: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11129: if ($section eq '') {
11130: $section = 'none';
11131: }
1.291 albertel 11132: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11133: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11134: $secmatch = 1;
11135: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11136: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11137: $secmatch = 1;
11138: }
11139: } else {
1.419 raeburn 11140: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11141: $secmatch = 1;
11142: }
1.290 albertel 11143: }
1.412 raeburn 11144: if (!$secmatch) {
11145: next;
11146: }
1.419 raeburn 11147: }
1.275 raeburn 11148: if (defined($$types{'active'})) {
1.288 raeburn 11149: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11150: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11151: $match = 1;
1.275 raeburn 11152: }
11153: }
11154: if (defined($$types{'previous'})) {
1.609 raeburn 11155: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11156: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11157: $match = 1;
1.275 raeburn 11158: }
11159: }
11160: if (defined($$types{'future'})) {
1.609 raeburn 11161: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11162: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11163: $match = 1;
1.275 raeburn 11164: }
11165: }
1.609 raeburn 11166: if ($match) {
11167: push(@{$seclists{$student}},$section);
11168: if (ref($userdata) eq 'HASH') {
11169: $$userdata{$student} = $$classlist{$student};
11170: }
11171: if (ref($statushash) eq 'HASH') {
11172: $statushash->{$student}{'st'}{$section} = $status;
11173: }
1.288 raeburn 11174: }
1.275 raeburn 11175: }
11176: }
1.412 raeburn 11177: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11178: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11179: my $now = time;
1.609 raeburn 11180: my %displaystatus = ( previous => 'Expired',
11181: active => 'Active',
11182: future => 'Future',
11183: );
1.1121 raeburn 11184: my (%nothide,@possdoms);
1.630 raeburn 11185: if ($hidepriv) {
11186: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11187: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11188: if ($user !~ /:/) {
11189: $nothide{join(':',split(/[\@]/,$user))}=1;
11190: } else {
11191: $nothide{$user} = 1;
11192: }
11193: }
1.1121 raeburn 11194: my @possdoms = ($cdom);
11195: if ($coursehash{'checkforpriv'}) {
11196: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11197: }
1.630 raeburn 11198: }
1.439 raeburn 11199: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11200: my $match = 0;
1.412 raeburn 11201: my $secmatch = 0;
1.439 raeburn 11202: my $status;
1.412 raeburn 11203: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11204: $user =~ s/:$//;
1.439 raeburn 11205: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11206: if ($end == -1 || $start == -1) {
11207: next;
11208: }
11209: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11210: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11211: my ($uname,$udom) = split(/:/,$user);
11212: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11213: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11214: $secmatch = 1;
11215: } elsif ($usec eq '') {
1.420 albertel 11216: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11217: $secmatch = 1;
11218: }
11219: } else {
11220: if (grep(/^\Q$usec\E$/,@{$sections})) {
11221: $secmatch = 1;
11222: }
11223: }
11224: if (!$secmatch) {
11225: next;
11226: }
1.288 raeburn 11227: }
1.419 raeburn 11228: if ($usec eq '') {
11229: $usec = 'none';
11230: }
1.275 raeburn 11231: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11232: if ($hidepriv) {
1.1121 raeburn 11233: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11234: (!$nothide{$uname.':'.$udom})) {
11235: next;
11236: }
11237: }
1.503 raeburn 11238: if ($end > 0 && $end < $now) {
1.439 raeburn 11239: $status = 'previous';
11240: } elsif ($start > $now) {
11241: $status = 'future';
11242: } else {
11243: $status = 'active';
11244: }
1.277 albertel 11245: foreach my $type (keys(%{$types})) {
1.275 raeburn 11246: if ($status eq $type) {
1.420 albertel 11247: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11248: push(@{$$users{$role}{$user}},$type);
11249: }
1.288 raeburn 11250: $match = 1;
11251: }
11252: }
1.419 raeburn 11253: if (($match) && (ref($userdata) eq 'HASH')) {
11254: if (!exists($$userdata{$uname.':'.$udom})) {
11255: &get_user_info($udom,$uname,\%idx,$userdata);
11256: }
1.420 albertel 11257: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11258: push(@{$seclists{$uname.':'.$udom}},$usec);
11259: }
1.609 raeburn 11260: if (ref($statushash) eq 'HASH') {
11261: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11262: }
1.275 raeburn 11263: }
11264: }
11265: }
11266: }
1.290 albertel 11267: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11268: if ((defined($cdom)) && (defined($cnum))) {
11269: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11270: if ( defined($csettings{'internal.courseowner'}) ) {
11271: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11272: next if ($owner eq '');
11273: my ($ownername,$ownerdom);
11274: if ($owner =~ /^([^:]+):([^:]+)$/) {
11275: $ownername = $1;
11276: $ownerdom = $2;
11277: } else {
11278: $ownername = $owner;
11279: $ownerdom = $cdom;
11280: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11281: }
11282: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11283: if (defined($userdata) &&
1.609 raeburn 11284: !exists($$userdata{$owner})) {
11285: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11286: if (!grep(/^none$/,@{$seclists{$owner}})) {
11287: push(@{$seclists{$owner}},'none');
11288: }
11289: if (ref($statushash) eq 'HASH') {
11290: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11291: }
1.290 albertel 11292: }
1.279 raeburn 11293: }
11294: }
11295: }
1.419 raeburn 11296: foreach my $user (keys(%seclists)) {
11297: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11298: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11299: }
1.275 raeburn 11300: }
11301: return;
11302: }
11303:
1.288 raeburn 11304: sub get_user_info {
11305: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11306: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11307: &plainname($uname,$udom,'lastname');
1.291 albertel 11308: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11309: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11310: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11311: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11312: return;
11313: }
1.275 raeburn 11314:
1.472 raeburn 11315: ###############################################
11316:
11317: =pod
11318:
11319: =item * &get_user_quota()
11320:
1.1134 raeburn 11321: Retrieves quota assigned for storage of user files.
11322: Default is to report quota for portfolio files.
1.472 raeburn 11323:
11324: Incoming parameters:
11325: 1. user's username
11326: 2. user's domain
1.1134 raeburn 11327: 3. quota name - portfolio, author, or course
1.1136 raeburn 11328: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11329: 4. crstype - official, unofficial, textbook, placement or community,
11330: if quota name is course
1.472 raeburn 11331:
11332: Returns:
1.1163 raeburn 11333: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11334: 2. (Optional) Type of setting: custom or default
11335: (individually assigned or default for user's
11336: institutional status).
11337: 3. (Optional) - User's institutional status (e.g., faculty, staff
11338: or student - types as defined in localenroll::inst_usertypes
11339: for user's domain, which determines default quota for user.
11340: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11341:
11342: If a value has been stored in the user's environment,
1.536 raeburn 11343: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11344: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11345:
11346: =cut
11347:
11348: ###############################################
11349:
11350:
11351: sub get_user_quota {
1.1136 raeburn 11352: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11353: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11354: if (!defined($udom)) {
11355: $udom = $env{'user.domain'};
11356: }
11357: if (!defined($uname)) {
11358: $uname = $env{'user.name'};
11359: }
11360: if (($udom eq '' || $uname eq '') ||
11361: ($udom eq 'public') && ($uname eq 'public')) {
11362: $quota = 0;
1.536 raeburn 11363: $quotatype = 'default';
11364: $defquota = 0;
1.472 raeburn 11365: } else {
1.536 raeburn 11366: my $inststatus;
1.1134 raeburn 11367: if ($quotaname eq 'course') {
11368: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11369: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11370: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11371: } else {
11372: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11373: $quota = $cenv{'internal.uploadquota'};
11374: }
1.536 raeburn 11375: } else {
1.1134 raeburn 11376: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11377: if ($quotaname eq 'author') {
11378: $quota = $env{'environment.authorquota'};
11379: } else {
11380: $quota = $env{'environment.portfolioquota'};
11381: }
11382: $inststatus = $env{'environment.inststatus'};
11383: } else {
11384: my %userenv =
11385: &Apache::lonnet::get('environment',['portfolioquota',
11386: 'authorquota','inststatus'],$udom,$uname);
11387: my ($tmp) = keys(%userenv);
11388: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11389: if ($quotaname eq 'author') {
11390: $quota = $userenv{'authorquota'};
11391: } else {
11392: $quota = $userenv{'portfolioquota'};
11393: }
11394: $inststatus = $userenv{'inststatus'};
11395: } else {
11396: undef(%userenv);
11397: }
11398: }
11399: }
11400: if ($quota eq '' || wantarray) {
11401: if ($quotaname eq 'course') {
11402: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11403: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11404: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11405: ($crstype eq 'placement')) {
1.1136 raeburn 11406: $defquota = $domdefs{$crstype.'quota'};
11407: }
11408: if ($defquota eq '') {
11409: $defquota = 500;
11410: }
1.1134 raeburn 11411: } else {
11412: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11413: }
11414: if ($quota eq '') {
11415: $quota = $defquota;
11416: $quotatype = 'default';
11417: } else {
11418: $quotatype = 'custom';
11419: }
1.472 raeburn 11420: }
11421: }
1.536 raeburn 11422: if (wantarray) {
11423: return ($quota,$quotatype,$settingstatus,$defquota);
11424: } else {
11425: return $quota;
11426: }
1.472 raeburn 11427: }
11428:
11429: ###############################################
11430:
11431: =pod
11432:
11433: =item * &default_quota()
11434:
1.536 raeburn 11435: Retrieves default quota assigned for storage of user portfolio files,
11436: given an (optional) user's institutional status.
1.472 raeburn 11437:
11438: Incoming parameters:
1.1142 raeburn 11439:
1.472 raeburn 11440: 1. domain
1.536 raeburn 11441: 2. (Optional) institutional status(es). This is a : separated list of
11442: status types (e.g., faculty, staff, student etc.)
11443: which apply to the user for whom the default is being retrieved.
11444: If the institutional status string in undefined, the domain
1.1134 raeburn 11445: default quota will be returned.
11446: 3. quota name - portfolio, author, or course
11447: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11448:
11449: Returns:
1.1142 raeburn 11450:
1.1163 raeburn 11451: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11452: 2. (Optional) institutional type which determined the value of the
11453: default quota.
1.472 raeburn 11454:
11455: If a value has been stored in the domain's configuration db,
11456: it will return that, otherwise it returns 20 (for backwards
11457: compatibility with domains which have not set up a configuration
1.1163 raeburn 11458: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11459:
1.536 raeburn 11460: If the user's status includes multiple types (e.g., staff and student),
11461: the largest default quota which applies to the user determines the
11462: default quota returned.
11463:
1.472 raeburn 11464: =cut
11465:
11466: ###############################################
11467:
11468:
11469: sub default_quota {
1.1134 raeburn 11470: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11471: my ($defquota,$settingstatus);
11472: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11473: ['quotas'],$udom);
1.1134 raeburn 11474: my $key = 'defaultquota';
11475: if ($quotaname eq 'author') {
11476: $key = 'authorquota';
11477: }
1.622 raeburn 11478: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11479: if ($inststatus ne '') {
1.765 raeburn 11480: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11481: foreach my $item (@statuses) {
1.1134 raeburn 11482: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11483: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11484: if ($defquota eq '') {
1.1134 raeburn 11485: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11486: $settingstatus = $item;
1.1134 raeburn 11487: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11488: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11489: $settingstatus = $item;
11490: }
11491: }
1.1134 raeburn 11492: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11493: if ($quotahash{'quotas'}{$item} ne '') {
11494: if ($defquota eq '') {
11495: $defquota = $quotahash{'quotas'}{$item};
11496: $settingstatus = $item;
11497: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11498: $defquota = $quotahash{'quotas'}{$item};
11499: $settingstatus = $item;
11500: }
1.536 raeburn 11501: }
11502: }
11503: }
11504: }
11505: if ($defquota eq '') {
1.1134 raeburn 11506: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11507: $defquota = $quotahash{'quotas'}{$key}{'default'};
11508: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11509: $defquota = $quotahash{'quotas'}{'default'};
11510: }
1.536 raeburn 11511: $settingstatus = 'default';
1.1139 raeburn 11512: if ($defquota eq '') {
11513: if ($quotaname eq 'author') {
11514: $defquota = 500;
11515: }
11516: }
1.536 raeburn 11517: }
11518: } else {
11519: $settingstatus = 'default';
1.1134 raeburn 11520: if ($quotaname eq 'author') {
11521: $defquota = 500;
11522: } else {
11523: $defquota = 20;
11524: }
1.536 raeburn 11525: }
11526: if (wantarray) {
11527: return ($defquota,$settingstatus);
1.472 raeburn 11528: } else {
1.536 raeburn 11529: return $defquota;
1.472 raeburn 11530: }
11531: }
11532:
1.1135 raeburn 11533: ###############################################
11534:
11535: =pod
11536:
1.1136 raeburn 11537: =item * &excess_filesize_warning()
1.1135 raeburn 11538:
11539: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11540: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11541: space to be exceeded.
1.1136 raeburn 11542:
11543: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11544: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11545:
1.1165 raeburn 11546: Inputs: 7
1.1136 raeburn 11547: 1. username or coursenum
1.1135 raeburn 11548: 2. domain
1.1136 raeburn 11549: 3. context ('author' or 'course')
1.1135 raeburn 11550: 4. filename of file for which action is being requested
11551: 5. filesize (kB) of file
11552: 6. action being taken: copy or upload.
1.1237 raeburn 11553: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11554:
11555: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11556: otherwise return null.
11557:
11558: =back
1.1135 raeburn 11559:
11560: =cut
11561:
1.1136 raeburn 11562: sub excess_filesize_warning {
1.1165 raeburn 11563: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11564: my $current_disk_usage = 0;
1.1165 raeburn 11565: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11566: if ($context eq 'author') {
11567: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11568: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11569: } else {
11570: foreach my $subdir ('docs','supplemental') {
11571: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11572: }
11573: }
1.1135 raeburn 11574: $disk_quota = int($disk_quota * 1000);
11575: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11576: return '<p class="LC_warning">'.
1.1135 raeburn 11577: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11578: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11579: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11580: $disk_quota,$current_disk_usage).
11581: '</p>';
11582: }
11583: return;
11584: }
11585:
11586: ###############################################
11587:
11588:
1.1136 raeburn 11589:
11590:
1.384 raeburn 11591: sub get_secgrprole_info {
11592: my ($cdom,$cnum,$needroles,$type) = @_;
11593: my %sections_count = &get_sections($cdom,$cnum);
11594: my @sections = (sort {$a <=> $b} keys(%sections_count));
11595: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11596: my @groups = sort(keys(%curr_groups));
11597: my $allroles = [];
11598: my $rolehash;
11599: my $accesshash = {
11600: active => 'Currently has access',
11601: future => 'Will have future access',
11602: previous => 'Previously had access',
11603: };
11604: if ($needroles) {
11605: $rolehash = {'all' => 'all'};
1.385 albertel 11606: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11607: if (&Apache::lonnet::error(%user_roles)) {
11608: undef(%user_roles);
11609: }
11610: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11611: my ($role)=split(/\:/,$item,2);
11612: if ($role eq 'cr') { next; }
11613: if ($role =~ /^cr/) {
11614: $$rolehash{$role} = (split('/',$role))[3];
11615: } else {
11616: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11617: }
11618: }
11619: foreach my $key (sort(keys(%{$rolehash}))) {
11620: push(@{$allroles},$key);
11621: }
11622: push (@{$allroles},'st');
11623: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11624: }
11625: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11626: }
11627:
1.555 raeburn 11628: sub user_picker {
1.1279 raeburn 11629: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11630: my $currdom = $dom;
1.1253 raeburn 11631: my @alldoms = &Apache::lonnet::all_domains();
11632: if (@alldoms == 1) {
11633: my %domsrch = &Apache::lonnet::get_dom('configuration',
11634: ['directorysrch'],$alldoms[0]);
11635: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11636: my $showdom = $domdesc;
11637: if ($showdom eq '') {
11638: $showdom = $dom;
11639: }
11640: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11641: if ((!$domsrch{'directorysrch'}{'available'}) &&
11642: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11643: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11644: }
11645: }
11646: }
1.555 raeburn 11647: my %curr_selected = (
11648: srchin => 'dom',
1.580 raeburn 11649: srchby => 'lastname',
1.555 raeburn 11650: );
11651: my $srchterm;
1.625 raeburn 11652: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11653: if ($srch->{'srchby'} ne '') {
11654: $curr_selected{'srchby'} = $srch->{'srchby'};
11655: }
11656: if ($srch->{'srchin'} ne '') {
11657: $curr_selected{'srchin'} = $srch->{'srchin'};
11658: }
11659: if ($srch->{'srchtype'} ne '') {
11660: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11661: }
11662: if ($srch->{'srchdomain'} ne '') {
11663: $currdom = $srch->{'srchdomain'};
11664: }
11665: $srchterm = $srch->{'srchterm'};
11666: }
1.1222 damieng 11667: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11668: 'usr' => 'Search criteria',
1.563 raeburn 11669: 'doma' => 'Domain/institution to search',
1.558 albertel 11670: 'uname' => 'username',
11671: 'lastname' => 'last name',
1.555 raeburn 11672: 'lastfirst' => 'last name, first name',
1.558 albertel 11673: 'crs' => 'in this course',
1.576 raeburn 11674: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11675: 'alc' => 'all LON-CAPA',
1.573 raeburn 11676: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11677: 'exact' => 'is',
11678: 'contains' => 'contains',
1.569 raeburn 11679: 'begins' => 'begins with',
1.1222 damieng 11680: );
11681: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11682: 'youm' => "You must include some text to search for.",
11683: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11684: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11685: 'yomc' => "You must choose a domain when using an institutional directory search.",
11686: 'ymcd' => "You must choose a domain when using a domain search.",
11687: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11688: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11689: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11690: );
1.1222 damieng 11691: &html_escape(\%html_lt);
11692: &js_escape(\%js_lt);
1.1255 raeburn 11693: my $domform;
1.1277 raeburn 11694: my $allow_blank = 1;
1.1255 raeburn 11695: if ($fixeddom) {
1.1277 raeburn 11696: $allow_blank = 0;
11697: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11698: } else {
1.1287 raeburn 11699: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11700: my ($trusted,$untrusted);
1.1287 raeburn 11701: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11702: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11703: } elsif ($context eq 'author') {
1.1288 raeburn 11704: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11705: } elsif ($context eq 'domain') {
1.1288 raeburn 11706: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11707: }
1.1288 raeburn 11708: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11709: }
1.563 raeburn 11710: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11711:
11712: my @srchins = ('crs','dom','alc','instd');
11713:
11714: foreach my $option (@srchins) {
11715: # FIXME 'alc' option unavailable until
11716: # loncreateuser::print_user_query_page()
11717: # has been completed.
11718: next if ($option eq 'alc');
1.880 raeburn 11719: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11720: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11721: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11722: if ($curr_selected{'srchin'} eq $option) {
11723: $srchinsel .= '
1.1222 damieng 11724: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11725: } else {
11726: $srchinsel .= '
1.1222 damieng 11727: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11728: }
1.555 raeburn 11729: }
1.563 raeburn 11730: $srchinsel .= "\n </select>\n";
1.555 raeburn 11731:
11732: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11733: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11734: if ($curr_selected{'srchby'} eq $option) {
11735: $srchbysel .= '
1.1222 damieng 11736: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11737: } else {
11738: $srchbysel .= '
1.1222 damieng 11739: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11740: }
11741: }
11742: $srchbysel .= "\n </select>\n";
11743:
11744: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11745: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11746: if ($curr_selected{'srchtype'} eq $option) {
11747: $srchtypesel .= '
1.1222 damieng 11748: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11749: } else {
11750: $srchtypesel .= '
1.1222 damieng 11751: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11752: }
11753: }
11754: $srchtypesel .= "\n </select>\n";
11755:
1.558 albertel 11756: my ($newuserscript,$new_user_create);
1.994 raeburn 11757: my $context_dom = $env{'request.role.domain'};
11758: if ($context eq 'requestcrs') {
11759: if ($env{'form.coursedom'} ne '') {
11760: $context_dom = $env{'form.coursedom'};
11761: }
11762: }
1.556 raeburn 11763: if ($forcenewuser) {
1.576 raeburn 11764: if (ref($srch) eq 'HASH') {
1.994 raeburn 11765: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11766: if ($cancreate) {
11767: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
11768: } else {
1.799 bisitz 11769: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11770: my %usertypetext = (
11771: official => 'institutional',
11772: unofficial => 'non-institutional',
11773: );
1.799 bisitz 11774: $new_user_create = '<p class="LC_warning">'
11775: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11776: .' '
11777: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11778: ,'<a href="'.$helplink.'">','</a>')
11779: .'</p><br />';
1.627 raeburn 11780: }
1.576 raeburn 11781: }
11782: }
11783:
1.556 raeburn 11784: $newuserscript = <<"ENDSCRIPT";
11785:
1.570 raeburn 11786: function setSearch(createnew,callingForm) {
1.556 raeburn 11787: if (createnew == 1) {
1.570 raeburn 11788: for (var i=0; i<callingForm.srchby.length; i++) {
11789: if (callingForm.srchby.options[i].value == 'uname') {
11790: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11791: }
11792: }
1.570 raeburn 11793: for (var i=0; i<callingForm.srchin.length; i++) {
11794: if ( callingForm.srchin.options[i].value == 'dom') {
11795: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11796: }
11797: }
1.570 raeburn 11798: for (var i=0; i<callingForm.srchtype.length; i++) {
11799: if (callingForm.srchtype.options[i].value == 'exact') {
11800: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11801: }
11802: }
1.570 raeburn 11803: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11804: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11805: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11806: }
11807: }
11808: }
11809: }
11810: ENDSCRIPT
1.558 albertel 11811:
1.556 raeburn 11812: }
11813:
1.555 raeburn 11814: my $output = <<"END_BLOCK";
1.556 raeburn 11815: <script type="text/javascript">
1.824 bisitz 11816: // <![CDATA[
1.570 raeburn 11817: function validateEntry(callingForm) {
1.558 albertel 11818:
1.556 raeburn 11819: var checkok = 1;
1.558 albertel 11820: var srchin;
1.570 raeburn 11821: for (var i=0; i<callingForm.srchin.length; i++) {
11822: if ( callingForm.srchin[i].checked ) {
11823: srchin = callingForm.srchin[i].value;
1.558 albertel 11824: }
11825: }
11826:
1.570 raeburn 11827: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11828: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11829: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11830: var srchterm = callingForm.srchterm.value;
11831: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11832: var msg = "";
11833:
11834: if (srchterm == "") {
11835: checkok = 0;
1.1222 damieng 11836: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11837: }
11838:
1.569 raeburn 11839: if (srchtype== 'begins') {
11840: if (srchterm.length < 2) {
11841: checkok = 0;
1.1222 damieng 11842: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11843: }
11844: }
11845:
1.556 raeburn 11846: if (srchtype== 'contains') {
11847: if (srchterm.length < 3) {
11848: checkok = 0;
1.1222 damieng 11849: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11850: }
11851: }
11852: if (srchin == 'instd') {
11853: if (srchdomain == '') {
11854: checkok = 0;
1.1222 damieng 11855: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11856: }
11857: }
11858: if (srchin == 'dom') {
11859: if (srchdomain == '') {
11860: checkok = 0;
1.1222 damieng 11861: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11862: }
11863: }
11864: if (srchby == 'lastfirst') {
11865: if (srchterm.indexOf(",") == -1) {
11866: checkok = 0;
1.1222 damieng 11867: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11868: }
11869: if (srchterm.indexOf(",") == srchterm.length -1) {
11870: checkok = 0;
1.1222 damieng 11871: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11872: }
11873: }
11874: if (checkok == 0) {
1.1222 damieng 11875: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11876: return;
11877: }
11878: if (checkok == 1) {
1.570 raeburn 11879: callingForm.submit();
1.556 raeburn 11880: }
11881: }
11882:
11883: $newuserscript
11884:
1.824 bisitz 11885: // ]]>
1.556 raeburn 11886: </script>
1.558 albertel 11887:
11888: $new_user_create
11889:
1.555 raeburn 11890: END_BLOCK
1.558 albertel 11891:
1.876 raeburn 11892: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11893: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11894: $domform.
11895: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11896: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11897: $srchbysel.
11898: $srchtypesel.
11899: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11900: $srchinsel.
11901: &Apache::lonhtmlcommon::row_closure(1).
11902: &Apache::lonhtmlcommon::end_pick_box().
11903: '<br />';
1.1253 raeburn 11904: return ($output,1);
1.555 raeburn 11905: }
11906:
1.612 raeburn 11907: sub user_rule_check {
1.615 raeburn 11908: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11909: my ($response,%inst_response);
1.612 raeburn 11910: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11911: if (keys(%{$usershash}) > 1) {
11912: my (%by_username,%by_id,%userdoms);
11913: my $checkid;
11914: if (ref($checks) eq 'HASH') {
11915: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11916: $checkid = 1;
11917: }
11918: }
11919: foreach my $user (keys(%{$usershash})) {
11920: my ($uname,$udom) = split(/:/,$user);
11921: if ($checkid) {
11922: if (ref($usershash->{$user}) eq 'HASH') {
11923: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11924: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11925: $userdoms{$udom} = 1;
1.1227 raeburn 11926: if (ref($inst_results) eq 'HASH') {
11927: $inst_results->{$uname.':'.$udom} = {};
11928: }
1.1226 raeburn 11929: }
11930: }
11931: } else {
11932: $by_username{$udom}{$uname} = 1;
11933: $userdoms{$udom} = 1;
1.1227 raeburn 11934: if (ref($inst_results) eq 'HASH') {
11935: $inst_results->{$uname.':'.$udom} = {};
11936: }
1.1226 raeburn 11937: }
11938: }
11939: foreach my $udom (keys(%userdoms)) {
11940: if (!$got_rules->{$udom}) {
11941: my %domconfig = &Apache::lonnet::get_dom('configuration',
11942: ['usercreation'],$udom);
11943: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11944: foreach my $item ('username','id') {
11945: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11946: $$curr_rules{$udom}{$item} =
11947: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11948: }
11949: }
11950: }
11951: $got_rules->{$udom} = 1;
11952: }
1.612 raeburn 11953: }
1.1226 raeburn 11954: if ($checkid) {
11955: foreach my $udom (keys(%by_id)) {
11956: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11957: if ($outcome eq 'ok') {
1.1227 raeburn 11958: foreach my $id (keys(%{$by_id{$udom}})) {
11959: my $uname = $by_id{$udom}{$id};
11960: $inst_response{$uname.':'.$udom} = $outcome;
11961: }
1.1226 raeburn 11962: if (ref($results) eq 'HASH') {
11963: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11964: if (exists($inst_response{$uname.':'.$udom})) {
11965: $inst_response{$uname.':'.$udom} = $outcome;
11966: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11967: }
1.1226 raeburn 11968: }
11969: }
11970: }
1.612 raeburn 11971: }
1.615 raeburn 11972: } else {
1.1226 raeburn 11973: foreach my $udom (keys(%by_username)) {
11974: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11975: if ($outcome eq 'ok') {
1.1227 raeburn 11976: foreach my $uname (keys(%{$by_username{$udom}})) {
11977: $inst_response{$uname.':'.$udom} = $outcome;
11978: }
1.1226 raeburn 11979: if (ref($results) eq 'HASH') {
11980: foreach my $uname (keys(%{$results})) {
11981: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11982: }
11983: }
11984: }
11985: }
1.612 raeburn 11986: }
1.1226 raeburn 11987: } elsif (keys(%{$usershash}) == 1) {
11988: my $user = (keys(%{$usershash}))[0];
11989: my ($uname,$udom) = split(/:/,$user);
11990: if (($udom ne '') && ($uname ne '')) {
11991: if (ref($usershash->{$user}) eq 'HASH') {
11992: if (ref($checks) eq 'HASH') {
11993: if (defined($checks->{'username'})) {
11994: ($inst_response{$user},%{$inst_results->{$user}}) =
11995: &Apache::lonnet::get_instuser($udom,$uname);
11996: } elsif (defined($checks->{'id'})) {
11997: if ($usershash->{$user}->{'id'} ne '') {
11998: ($inst_response{$user},%{$inst_results->{$user}}) =
11999: &Apache::lonnet::get_instuser($udom,undef,
12000: $usershash->{$user}->{'id'});
12001: } else {
12002: ($inst_response{$user},%{$inst_results->{$user}}) =
12003: &Apache::lonnet::get_instuser($udom,$uname);
12004: }
1.585 raeburn 12005: }
1.1226 raeburn 12006: } else {
12007: ($inst_response{$user},%{$inst_results->{$user}}) =
12008: &Apache::lonnet::get_instuser($udom,$uname);
12009: return;
12010: }
12011: if (!$got_rules->{$udom}) {
12012: my %domconfig = &Apache::lonnet::get_dom('configuration',
12013: ['usercreation'],$udom);
12014: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12015: foreach my $item ('username','id') {
12016: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12017: $$curr_rules{$udom}{$item} =
12018: $domconfig{'usercreation'}{$item.'_rule'};
12019: }
12020: }
12021: }
12022: $got_rules->{$udom} = 1;
1.585 raeburn 12023: }
12024: }
1.1226 raeburn 12025: } else {
12026: return;
12027: }
12028: } else {
12029: return;
12030: }
12031: foreach my $user (keys(%{$usershash})) {
12032: my ($uname,$udom) = split(/:/,$user);
12033: next if (($udom eq '') || ($uname eq ''));
12034: my $id;
1.1227 raeburn 12035: if (ref($inst_results) eq 'HASH') {
12036: if (ref($inst_results->{$user}) eq 'HASH') {
12037: $id = $inst_results->{$user}->{'id'};
12038: }
12039: }
12040: if ($id eq '') {
12041: if (ref($usershash->{$user})) {
12042: $id = $usershash->{$user}->{'id'};
12043: }
1.585 raeburn 12044: }
1.612 raeburn 12045: foreach my $item (keys(%{$checks})) {
12046: if (ref($$curr_rules{$udom}) eq 'HASH') {
12047: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12048: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12049: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12050: $$curr_rules{$udom}{$item});
1.612 raeburn 12051: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12052: if ($rule_check{$rule}) {
12053: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12054: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12055: if (ref($inst_results) eq 'HASH') {
12056: if (ref($inst_results->{$user}) eq 'HASH') {
12057: if (keys(%{$inst_results->{$user}}) == 0) {
12058: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12059: } elsif ($item eq 'id') {
12060: if ($inst_results->{$user}->{'id'} eq '') {
12061: $$alerts{$item}{$udom}{$uname} = 1;
12062: }
1.615 raeburn 12063: }
1.612 raeburn 12064: }
12065: }
1.615 raeburn 12066: }
12067: last;
1.585 raeburn 12068: }
12069: }
12070: }
12071: }
12072: }
12073: }
12074: }
12075: }
1.612 raeburn 12076: return;
12077: }
12078:
12079: sub user_rule_formats {
12080: my ($domain,$domdesc,$curr_rules,$check) = @_;
12081: my %text = (
12082: 'username' => 'Usernames',
12083: 'id' => 'IDs',
12084: );
12085: my $output;
12086: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12087: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12088: if (@{$ruleorder} > 0) {
1.1102 raeburn 12089: $output = '<br />'.
12090: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12091: '<span class="LC_cusr_emph">','</span>',$domdesc).
12092: ' <ul>';
1.612 raeburn 12093: foreach my $rule (@{$ruleorder}) {
12094: if (ref($curr_rules) eq 'ARRAY') {
12095: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12096: if (ref($rules->{$rule}) eq 'HASH') {
12097: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12098: $rules->{$rule}{'desc'}.'</li>';
12099: }
12100: }
12101: }
12102: }
12103: $output .= '</ul>';
12104: }
12105: }
12106: return $output;
12107: }
12108:
12109: sub instrule_disallow_msg {
1.615 raeburn 12110: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12111: my $response;
12112: my %text = (
12113: item => 'username',
12114: items => 'usernames',
12115: match => 'matches',
12116: do => 'does',
12117: action => 'a username',
12118: one => 'one',
12119: );
12120: if ($count > 1) {
12121: $text{'item'} = 'usernames';
12122: $text{'match'} ='match';
12123: $text{'do'} = 'do';
12124: $text{'action'} = 'usernames',
12125: $text{'one'} = 'ones';
12126: }
12127: if ($checkitem eq 'id') {
12128: $text{'items'} = 'IDs';
12129: $text{'item'} = 'ID';
12130: $text{'action'} = 'an ID';
1.615 raeburn 12131: if ($count > 1) {
12132: $text{'item'} = 'IDs';
12133: $text{'action'} = 'IDs';
12134: }
1.612 raeburn 12135: }
1.674 bisitz 12136: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615 raeburn 12137: if ($mode eq 'upload') {
12138: if ($checkitem eq 'username') {
12139: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12140: } elsif ($checkitem eq 'id') {
1.674 bisitz 12141: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615 raeburn 12142: }
1.669 raeburn 12143: } elsif ($mode eq 'selfcreate') {
12144: if ($checkitem eq 'id') {
12145: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
12146: }
1.615 raeburn 12147: } else {
12148: if ($checkitem eq 'username') {
12149: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12150: } elsif ($checkitem eq 'id') {
12151: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
12152: }
1.612 raeburn 12153: }
12154: return $response;
1.585 raeburn 12155: }
12156:
1.624 raeburn 12157: sub personal_data_fieldtitles {
12158: my %fieldtitles = &Apache::lonlocal::texthash (
12159: id => 'Student/Employee ID',
12160: permanentemail => 'E-mail address',
12161: lastname => 'Last Name',
12162: firstname => 'First Name',
12163: middlename => 'Middle Name',
12164: generation => 'Generation',
12165: gen => 'Generation',
1.765 raeburn 12166: inststatus => 'Affiliation',
1.624 raeburn 12167: );
12168: return %fieldtitles;
12169: }
12170:
1.642 raeburn 12171: sub sorted_inst_types {
12172: my ($dom) = @_;
1.1185 raeburn 12173: my ($usertypes,$order);
12174: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12175: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12176: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12177: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12178: } else {
12179: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12180: }
1.642 raeburn 12181: my $othertitle = &mt('All users');
12182: if ($env{'request.course.id'}) {
1.668 raeburn 12183: $othertitle = &mt('Any users');
1.642 raeburn 12184: }
12185: my @types;
12186: if (ref($order) eq 'ARRAY') {
12187: @types = @{$order};
12188: }
12189: if (@types == 0) {
12190: if (ref($usertypes) eq 'HASH') {
12191: @types = sort(keys(%{$usertypes}));
12192: }
12193: }
12194: if (keys(%{$usertypes}) > 0) {
12195: $othertitle = &mt('Other users');
12196: }
12197: return ($othertitle,$usertypes,\@types);
12198: }
12199:
1.645 raeburn 12200: sub get_institutional_codes {
1.1361 raeburn 12201: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12202: # Get complete list of course sections to update
12203: my @currsections = ();
12204: my @currxlists = ();
1.1361 raeburn 12205: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12206: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12207: my $crskey = $crs.':'.$coursecode;
12208: @{$unclutteredsec{$crskey}} = ();
12209: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12210:
12211: if ($$settings{'internal.sectionnums'} ne '') {
12212: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12213: }
12214:
12215: if ($$settings{'internal.crosslistings'} ne '') {
12216: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12217: }
12218:
12219: if (@currxlists > 0) {
1.1361 raeburn 12220: foreach my $xl (@currxlists) {
12221: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12222: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12223: push(@{$allcourses},$1);
1.645 raeburn 12224: $$LC_code{$1} = $2;
12225: }
12226: }
12227: }
12228: }
1.1361 raeburn 12229:
1.645 raeburn 12230: if (@currsections > 0) {
1.1361 raeburn 12231: foreach my $sec (@currsections) {
12232: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12233: my $instsec = $1;
1.645 raeburn 12234: my $lc_sec = $2;
1.1361 raeburn 12235: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12236: push(@{$unclutteredsec{$crskey}},$instsec);
12237: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12238: }
12239: }
12240: }
12241: }
12242:
12243: if (@{$unclutteredsec{$crskey}} > 0) {
12244: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12245: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12246: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12247: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12248: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12249: push(@{$allcourses},$sec);
1.1361 raeburn 12250: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12251: }
12252: }
12253: }
12254: }
12255: return;
12256: }
12257:
1.971 raeburn 12258: sub get_standard_codeitems {
12259: return ('Year','Semester','Department','Number','Section');
12260: }
12261:
1.112 bowersj2 12262: =pod
12263:
1.780 raeburn 12264: =head1 Slot Helpers
12265:
12266: =over 4
12267:
12268: =item * sorted_slots()
12269:
1.1040 raeburn 12270: Sorts an array of slot names in order of an optional sort key,
12271: default sort is by slot start time (earliest first).
1.780 raeburn 12272:
12273: Inputs:
12274:
12275: =over 4
12276:
12277: slotsarr - Reference to array of unsorted slot names.
12278:
12279: slots - Reference to hash of hash, where outer hash keys are slot names.
12280:
1.1040 raeburn 12281: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12282:
1.549 albertel 12283: =back
12284:
1.780 raeburn 12285: Returns:
12286:
12287: =over 4
12288:
1.1040 raeburn 12289: sorted - An array of slot names sorted by a specified sort key
12290: (default sort key is start time of the slot).
1.780 raeburn 12291:
12292: =back
12293:
12294: =cut
12295:
12296:
12297: sub sorted_slots {
1.1040 raeburn 12298: my ($slotsarr,$slots,$sortkey) = @_;
12299: if ($sortkey eq '') {
12300: $sortkey = 'starttime';
12301: }
1.780 raeburn 12302: my @sorted;
12303: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12304: @sorted =
12305: sort {
12306: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12307: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12308: }
12309: if (ref($slots->{$a})) { return -1;}
12310: if (ref($slots->{$b})) { return 1;}
12311: return 0;
12312: } @{$slotsarr};
12313: }
12314: return @sorted;
12315: }
12316:
1.1040 raeburn 12317: =pod
12318:
12319: =item * get_future_slots()
12320:
12321: Inputs:
12322:
12323: =over 4
12324:
12325: cnum - course number
12326:
12327: cdom - course domain
12328:
12329: now - current UNIX time
12330:
12331: symb - optional symb
12332:
12333: =back
12334:
12335: Returns:
12336:
12337: =over 4
12338:
12339: sorted_reservable - ref to array of student_schedulable slots currently
12340: reservable, ordered by end date of reservation period.
12341:
12342: reservable_now - ref to hash of student_schedulable slots currently
12343: reservable.
12344:
12345: Keys in inner hash are:
12346: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12347: (b) endreserve: end date of reservation period.
12348: (c) uniqueperiod: start,end dates when slot is to be uniquely
12349: selected.
1.1040 raeburn 12350:
12351: sorted_future - ref to array of student_schedulable slots reservable in
12352: the future, ordered by start date of reservation period.
12353:
12354: future_reservable - ref to hash of student_schedulable slots reservable
12355: in the future.
12356:
12357: Keys in inner hash are:
12358: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12359: (b) startreserve: start date of reservation period.
12360: (c) uniqueperiod: start,end dates when slot is to be uniquely
12361: selected.
1.1040 raeburn 12362:
12363: =back
12364:
12365: =cut
12366:
12367: sub get_future_slots {
12368: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12369: my $map;
12370: if ($symb) {
12371: ($map) = &Apache::lonnet::decode_symb($symb);
12372: }
1.1040 raeburn 12373: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12374: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12375: foreach my $slot (keys(%slots)) {
12376: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12377: if ($symb) {
1.1229 raeburn 12378: if ($slots{$slot}->{'symb'} ne '') {
12379: my $canuse;
12380: my %oksymbs;
12381: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12382: map { $oksymbs{$_} = 1; } @slotsymbs;
12383: if ($oksymbs{$symb}) {
12384: $canuse = 1;
12385: } else {
12386: foreach my $item (@slotsymbs) {
12387: if ($item =~ /\.(page|sequence)$/) {
12388: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12389: if (($map ne '') && ($map eq $sloturl)) {
12390: $canuse = 1;
12391: last;
12392: }
12393: }
12394: }
12395: }
12396: next unless ($canuse);
12397: }
1.1040 raeburn 12398: }
12399: if (($slots{$slot}->{'starttime'} > $now) &&
12400: ($slots{$slot}->{'endtime'} > $now)) {
12401: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12402: my $userallowed = 0;
12403: if ($slots{$slot}->{'allowedsections'}) {
12404: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12405: if (!defined($env{'request.role.sec'})
12406: && grep(/^No section assigned$/,@allowed_sec)) {
12407: $userallowed=1;
12408: } else {
12409: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12410: $userallowed=1;
12411: }
12412: }
12413: unless ($userallowed) {
12414: if (defined($env{'request.course.groups'})) {
12415: my @groups = split(/:/,$env{'request.course.groups'});
12416: foreach my $group (@groups) {
12417: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12418: $userallowed=1;
12419: last;
12420: }
12421: }
12422: }
12423: }
12424: }
12425: if ($slots{$slot}->{'allowedusers'}) {
12426: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12427: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12428: if (grep(/^\Q$user\E$/,@allowed_users)) {
12429: $userallowed = 1;
12430: }
12431: }
12432: next unless($userallowed);
12433: }
12434: my $startreserve = $slots{$slot}->{'startreserve'};
12435: my $endreserve = $slots{$slot}->{'endreserve'};
12436: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12437: my $uniqueperiod;
12438: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12439: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12440: }
1.1040 raeburn 12441: if (($startreserve < $now) &&
12442: (!$endreserve || $endreserve > $now)) {
12443: my $lastres = $endreserve;
12444: if (!$lastres) {
12445: $lastres = $slots{$slot}->{'starttime'};
12446: }
12447: $reservable_now{$slot} = {
12448: symb => $symb,
1.1250 raeburn 12449: endreserve => $lastres,
12450: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12451: };
12452: } elsif (($startreserve > $now) &&
12453: (!$endreserve || $endreserve > $startreserve)) {
12454: $future_reservable{$slot} = {
12455: symb => $symb,
1.1250 raeburn 12456: startreserve => $startreserve,
12457: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12458: };
12459: }
12460: }
12461: }
12462: my @unsorted_reservable = keys(%reservable_now);
12463: if (@unsorted_reservable > 0) {
12464: @sorted_reservable =
12465: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12466: }
12467: my @unsorted_future = keys(%future_reservable);
12468: if (@unsorted_future > 0) {
12469: @sorted_future =
12470: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12471: }
12472: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12473: }
1.780 raeburn 12474:
12475: =pod
12476:
1.1057 foxr 12477: =back
12478:
1.549 albertel 12479: =head1 HTTP Helpers
12480:
12481: =over 4
12482:
1.648 raeburn 12483: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12484:
1.258 albertel 12485: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12486: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12487: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12488:
12489: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12490: $possible_names is an ref to an array of form element names. As an example:
12491: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12492: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12493:
12494: =cut
1.1 albertel 12495:
1.6 albertel 12496: sub get_unprocessed_cgi {
1.25 albertel 12497: my ($query,$possible_names)= @_;
1.26 matthew 12498: # $Apache::lonxml::debug=1;
1.356 albertel 12499: foreach my $pair (split(/&/,$query)) {
12500: my ($name, $value) = split(/=/,$pair);
1.369 www 12501: $name = &unescape($name);
1.25 albertel 12502: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12503: $value =~ tr/+/ /;
12504: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12505: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12506: }
1.16 harris41 12507: }
1.6 albertel 12508: }
12509:
1.112 bowersj2 12510: =pod
12511:
1.648 raeburn 12512: =item * &cacheheader()
1.112 bowersj2 12513:
12514: returns cache-controlling header code
12515:
12516: =cut
12517:
1.7 albertel 12518: sub cacheheader {
1.258 albertel 12519: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12520: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12521: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12522: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12523: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12524: return $output;
1.7 albertel 12525: }
12526:
1.112 bowersj2 12527: =pod
12528:
1.648 raeburn 12529: =item * &no_cache($r)
1.112 bowersj2 12530:
12531: specifies header code to not have cache
12532:
12533: =cut
12534:
1.9 albertel 12535: sub no_cache {
1.216 albertel 12536: my ($r) = @_;
12537: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12538: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12539: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12540: $r->no_cache(1);
12541: $r->header_out("Expires" => $date);
12542: $r->header_out("Pragma" => "no-cache");
1.123 www 12543: }
12544:
12545: sub content_type {
1.181 albertel 12546: my ($r,$type,$charset) = @_;
1.299 foxr 12547: if ($r) {
12548: # Note that printout.pl calls this with undef for $r.
12549: &no_cache($r);
12550: }
1.258 albertel 12551: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12552: unless ($charset) {
12553: $charset=&Apache::lonlocal::current_encoding;
12554: }
12555: if ($charset) { $type.='; charset='.$charset; }
12556: if ($r) {
12557: $r->content_type($type);
12558: } else {
12559: print("Content-type: $type\n\n");
12560: }
1.9 albertel 12561: }
1.25 albertel 12562:
1.112 bowersj2 12563: =pod
12564:
1.648 raeburn 12565: =item * &add_to_env($name,$value)
1.112 bowersj2 12566:
1.258 albertel 12567: adds $name to the %env hash with value
1.112 bowersj2 12568: $value, if $name already exists, the entry is converted to an array
12569: reference and $value is added to the array.
12570:
12571: =cut
12572:
1.25 albertel 12573: sub add_to_env {
12574: my ($name,$value)=@_;
1.258 albertel 12575: if (defined($env{$name})) {
12576: if (ref($env{$name})) {
1.25 albertel 12577: #already have multiple values
1.258 albertel 12578: push(@{ $env{$name} },$value);
1.25 albertel 12579: } else {
12580: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12581: my $first=$env{$name};
12582: undef($env{$name});
12583: push(@{ $env{$name} },$first,$value);
1.25 albertel 12584: }
12585: } else {
1.258 albertel 12586: $env{$name}=$value;
1.25 albertel 12587: }
1.31 albertel 12588: }
1.149 albertel 12589:
12590: =pod
12591:
1.648 raeburn 12592: =item * &get_env_multiple($name)
1.149 albertel 12593:
1.258 albertel 12594: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12595: values may be defined and end up as an array ref.
12596:
12597: returns an array of values
12598:
12599: =cut
12600:
12601: sub get_env_multiple {
12602: my ($name) = @_;
12603: my @values;
1.258 albertel 12604: if (defined($env{$name})) {
1.149 albertel 12605: # exists is it an array
1.258 albertel 12606: if (ref($env{$name})) {
12607: @values=@{ $env{$name} };
1.149 albertel 12608: } else {
1.258 albertel 12609: $values[0]=$env{$name};
1.149 albertel 12610: }
12611: }
12612: return(@values);
12613: }
12614:
1.1249 damieng 12615: # Looks at given dependencies, and returns something depending on the context.
12616: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12617: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12618: # For all other contexts, returns ($output, $counter, $numpathchg).
12619: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12620: # $counter: integer with the number of existing dependencies when no HTML output is returned, and the number of missing dependencies when an HTML output is returned.
12621: # $numpathchg: integer with the number of cleaned up dependency paths.
12622: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12623: # \%mapping: hash reference clean path -> original path for all dependencies.
12624: # @param {string} actionurl - The path to the handler, indicative of the context.
12625: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12626: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12627: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12628: # @param {hash reference} args - More parameters ! Possible keys: error_on_invalid_names (boolean), ignore_remote_references (boolean), current_path (string), docs_url (string), docs_title (string), context (string)
12629: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12630: sub ask_for_embedded_content {
1.1249 damieng 12631: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12632: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12633: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12634: %currsubfile,%unused,$rem);
1.1071 raeburn 12635: my $counter = 0;
12636: my $numnew = 0;
1.987 raeburn 12637: my $numremref = 0;
12638: my $numinvalid = 0;
12639: my $numpathchg = 0;
12640: my $numexisting = 0;
1.1071 raeburn 12641: my $numunused = 0;
12642: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12643: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12644: my $heading = &mt('Upload embedded files');
12645: my $buttontext = &mt('Upload');
12646:
1.1249 damieng 12647: # fills these variables based on the context:
12648: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12649: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12650: if ($env{'request.course.id'}) {
1.1123 raeburn 12651: if ($actionurl eq '/adm/dependencies') {
12652: $navmap = Apache::lonnavmaps::navmap->new();
12653: }
12654: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12655: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12656: }
1.1123 raeburn 12657: if (($actionurl eq '/adm/portfolio') ||
12658: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12659: my $current_path='/';
12660: if ($env{'form.currentpath'}) {
12661: $current_path = $env{'form.currentpath'};
12662: }
12663: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12664: $udom = $cdom;
12665: $uname = $cnum;
1.984 raeburn 12666: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12667: } else {
12668: $udom = $env{'user.domain'};
12669: $uname = $env{'user.name'};
12670: $url = '/userfiles/portfolio';
12671: }
1.987 raeburn 12672: $toplevel = $url.'/';
1.984 raeburn 12673: $url .= $current_path;
12674: $getpropath = 1;
1.987 raeburn 12675: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12676: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12677: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12678: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12679: $toplevel = $url;
1.984 raeburn 12680: if ($rest ne '') {
1.987 raeburn 12681: $url .= $rest;
12682: }
12683: } elsif ($actionurl eq '/adm/coursedocs') {
12684: if (ref($args) eq 'HASH') {
1.1071 raeburn 12685: $url = $args->{'docs_url'};
12686: $toplevel = $url;
1.1084 raeburn 12687: if ($args->{'context'} eq 'paste') {
12688: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12689: ($path) =
12690: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12691: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12692: $fileloc =~ s{^/}{};
12693: }
1.1071 raeburn 12694: }
1.1084 raeburn 12695: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12696: if ($env{'request.course.id'} ne '') {
12697: if (ref($args) eq 'HASH') {
12698: $url = $args->{'docs_url'};
12699: $title = $args->{'docs_title'};
1.1126 raeburn 12700: $toplevel = $url;
12701: unless ($toplevel =~ m{^/}) {
12702: $toplevel = "/$url";
12703: }
1.1085 raeburn 12704: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12705: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12706: $path = $1;
12707: } else {
12708: ($path) =
12709: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12710: }
1.1195 raeburn 12711: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12712: $fileloc = $toplevel;
12713: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12714: my ($udom,$uname,$fname) =
12715: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12716: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12717: } else {
12718: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12719: }
1.1071 raeburn 12720: $fileloc =~ s{^/}{};
12721: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12722: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12723: }
1.987 raeburn 12724: }
1.1123 raeburn 12725: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12726: $udom = $cdom;
12727: $uname = $cnum;
12728: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12729: $toplevel = $url;
12730: $path = $url;
12731: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12732: $fileloc =~ s{^/}{};
1.987 raeburn 12733: }
1.1249 damieng 12734:
12735: # parses the dependency paths to get some info
12736: # fills $newfiles, $mapping, $subdependencies, $dependencies
12737: # $newfiles: hash URL -> 1 for new files or external URLs
12738: # (will be completed later)
12739: # $mapping:
12740: # for external URLs: external URL -> external URL
12741: # for relative paths: clean path -> original path
12742: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12743: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12744: foreach my $file (keys(%{$allfiles})) {
12745: my $embed_file;
12746: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12747: $embed_file = $1;
12748: } else {
12749: $embed_file = $file;
12750: }
1.1158 raeburn 12751: my ($absolutepath,$cleaned_file);
12752: if ($embed_file =~ m{^\w+://}) {
12753: $cleaned_file = $embed_file;
1.1147 raeburn 12754: $newfiles{$cleaned_file} = 1;
12755: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12756: } else {
1.1158 raeburn 12757: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12758: if ($embed_file =~ m{^/}) {
12759: $absolutepath = $embed_file;
12760: }
1.1147 raeburn 12761: if ($cleaned_file =~ m{/}) {
12762: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12763: $path = &check_for_traversal($path,$url,$toplevel);
12764: my $item = $fname;
12765: if ($path ne '') {
12766: $item = $path.'/'.$fname;
12767: $subdependencies{$path}{$fname} = 1;
12768: } else {
12769: $dependencies{$item} = 1;
12770: }
12771: if ($absolutepath) {
12772: $mapping{$item} = $absolutepath;
12773: } else {
12774: $mapping{$item} = $embed_file;
12775: }
12776: } else {
12777: $dependencies{$embed_file} = 1;
12778: if ($absolutepath) {
1.1147 raeburn 12779: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12780: } else {
1.1147 raeburn 12781: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12782: }
12783: }
1.984 raeburn 12784: }
12785: }
1.1249 damieng 12786:
12787: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12788: # and lists
12789: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12790: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12791: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12792: # the path had to be cleaned up
12793: # $existing: hash clean path -> 1 if the file exists
12794: # $numexisting: number of keys in $existing
12795: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12796: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12797: # dependency subdirectories that are
12798: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12799: my $dirptr = 16384;
1.984 raeburn 12800: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12801: $currsubfile{$path} = {};
1.1123 raeburn 12802: if (($actionurl eq '/adm/portfolio') ||
12803: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12804: my ($sublistref,$listerror) =
12805: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12806: if (ref($sublistref) eq 'ARRAY') {
12807: foreach my $line (@{$sublistref}) {
12808: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12809: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12810: }
1.984 raeburn 12811: }
1.987 raeburn 12812: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12813: if (opendir(my $dir,$url.'/'.$path)) {
12814: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12815: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12816: }
1.1084 raeburn 12817: } elsif (($actionurl eq '/adm/dependencies') ||
12818: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12819: ($args->{'context'} eq 'paste')) ||
12820: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12821: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12822: my $dir;
12823: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12824: $dir = $fileloc;
12825: } else {
12826: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12827: }
1.1071 raeburn 12828: if ($dir ne '') {
12829: my ($sublistref,$listerror) =
12830: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12831: if (ref($sublistref) eq 'ARRAY') {
12832: foreach my $line (@{$sublistref}) {
12833: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12834: undef,$mtime)=split(/\&/,$line,12);
12835: unless (($testdir&$dirptr) ||
12836: ($file_name =~ /^\.\.?$/)) {
12837: $currsubfile{$path}{$file_name} = [$size,$mtime];
12838: }
12839: }
12840: }
12841: }
1.984 raeburn 12842: }
12843: }
12844: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12845: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12846: my $item = $path.'/'.$file;
12847: unless ($mapping{$item} eq $item) {
12848: $pathchanges{$item} = 1;
12849: }
12850: $existing{$item} = 1;
12851: $numexisting ++;
12852: } else {
12853: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12854: }
12855: }
1.1071 raeburn 12856: if ($actionurl eq '/adm/dependencies') {
12857: foreach my $path (keys(%currsubfile)) {
12858: if (ref($currsubfile{$path}) eq 'HASH') {
12859: foreach my $file (keys(%{$currsubfile{$path}})) {
12860: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12861: next if (($rem ne '') &&
12862: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12863: (ref($navmap) &&
12864: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12865: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12866: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12867: $unused{$path.'/'.$file} = 1;
12868: }
12869: }
12870: }
12871: }
12872: }
1.984 raeburn 12873: }
1.1249 damieng 12874:
12875: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12876: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12877: my %currfile;
1.1123 raeburn 12878: if (($actionurl eq '/adm/portfolio') ||
12879: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12880: my ($dirlistref,$listerror) =
12881: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12882: if (ref($dirlistref) eq 'ARRAY') {
12883: foreach my $line (@{$dirlistref}) {
12884: my ($file_name,$rest) = split(/\&/,$line,2);
12885: $currfile{$file_name} = 1;
12886: }
1.984 raeburn 12887: }
1.987 raeburn 12888: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12889: if (opendir(my $dir,$url)) {
1.987 raeburn 12890: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12891: map {$currfile{$_} = 1;} @dir_list;
12892: }
1.1084 raeburn 12893: } elsif (($actionurl eq '/adm/dependencies') ||
12894: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12895: ($args->{'context'} eq 'paste')) ||
12896: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12897: if ($env{'request.course.id'} ne '') {
12898: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12899: if ($dir ne '') {
12900: my ($dirlistref,$listerror) =
12901: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12902: if (ref($dirlistref) eq 'ARRAY') {
12903: foreach my $line (@{$dirlistref}) {
12904: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12905: $size,undef,$mtime)=split(/\&/,$line,12);
12906: unless (($testdir&$dirptr) ||
12907: ($file_name =~ /^\.\.?$/)) {
12908: $currfile{$file_name} = [$size,$mtime];
12909: }
12910: }
12911: }
12912: }
12913: }
1.984 raeburn 12914: }
1.1249 damieng 12915: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12916: # are not in subdirectories, using $currfile
1.984 raeburn 12917: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12918: if (exists($currfile{$file})) {
1.987 raeburn 12919: unless ($mapping{$file} eq $file) {
12920: $pathchanges{$file} = 1;
12921: }
12922: $existing{$file} = 1;
12923: $numexisting ++;
12924: } else {
1.984 raeburn 12925: $newfiles{$file} = 1;
12926: }
12927: }
1.1071 raeburn 12928: foreach my $file (keys(%currfile)) {
12929: unless (($file eq $filename) ||
12930: ($file eq $filename.'.bak') ||
12931: ($dependencies{$file})) {
1.1085 raeburn 12932: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12933: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12934: next if (($rem ne '') &&
12935: (($env{"httpref.$rem".$file} ne '') ||
12936: (ref($navmap) &&
12937: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12938: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12939: ($navmap->getResourceByUrl($rem.$1)))))));
12940: }
1.1085 raeburn 12941: }
1.1071 raeburn 12942: $unused{$file} = 1;
12943: }
12944: }
1.1249 damieng 12945:
12946: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12947: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12948: ($args->{'context'} eq 'paste')) {
12949: $counter = scalar(keys(%existing));
12950: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12951: return ($output,$counter,$numpathchg,\%existing);
12952: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12953: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12954: $counter = scalar(keys(%existing));
12955: $numpathchg = scalar(keys(%pathchanges));
12956: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12957: }
1.1249 damieng 12958:
12959: # returns HTML otherwise, with dependency results and to ask for more uploads
12960:
12961: # $upload_output: missing dependencies (with upload form)
12962: # $modify_output: uploaded dependencies (in use)
12963: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12964: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12965: if ($actionurl eq '/adm/dependencies') {
12966: next if ($embed_file =~ m{^\w+://});
12967: }
1.660 raeburn 12968: $upload_output .= &start_data_table_row().
1.1123 raeburn 12969: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12970: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12971: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12972: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12973: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12974: }
1.1123 raeburn 12975: $upload_output .= '</td>';
1.1071 raeburn 12976: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 12977: $upload_output.='<td align="right">'.
12978: '<span class="LC_info LC_fontsize_medium">'.
12979: &mt("URL points to web address").'</span>';
1.987 raeburn 12980: $numremref++;
1.660 raeburn 12981: } elsif ($args->{'error_on_invalid_names'}
12982: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 12983: $upload_output.='<td align="right"><span class="LC_warning">'.
12984: &mt('Invalid characters').'</span>';
1.987 raeburn 12985: $numinvalid++;
1.660 raeburn 12986: } else {
1.1123 raeburn 12987: $upload_output .= '<td>'.
12988: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 12989: $embed_file,\%mapping,
1.1071 raeburn 12990: $allfiles,$codebase,'upload');
12991: $counter ++;
12992: $numnew ++;
1.987 raeburn 12993: }
12994: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
12995: }
12996: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 12997: if ($actionurl eq '/adm/dependencies') {
12998: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
12999: $modify_output .= &start_data_table_row().
13000: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13001: '<img src="'.&icon($embed_file).'" border="0" />'.
13002: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13003: '<td>'.$size.'</td>'.
13004: '<td>'.$mtime.'</td>'.
13005: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13006: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13007: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13008: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13009: &embedded_file_element('upload_embedded',$counter,
13010: $embed_file,\%mapping,
13011: $allfiles,$codebase,'modify').
13012: '</div></td>'.
13013: &end_data_table_row()."\n";
13014: $counter ++;
13015: } else {
13016: $upload_output .= &start_data_table_row().
1.1123 raeburn 13017: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13018: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13019: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13020: &Apache::loncommon::end_data_table_row()."\n";
13021: }
13022: }
13023: my $delidx = $counter;
13024: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13025: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13026: $delete_output .= &start_data_table_row().
13027: '<td><img src="'.&icon($oldfile).'" />'.
13028: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13029: '<td>'.$size.'</td>'.
13030: '<td>'.$mtime.'</td>'.
13031: '<td><label><input type="checkbox" name="del_upload_dep" '.
13032: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13033: &embedded_file_element('upload_embedded',$delidx,
13034: $oldfile,\%mapping,$allfiles,
13035: $codebase,'delete').'</td>'.
13036: &end_data_table_row()."\n";
13037: $numunused ++;
13038: $delidx ++;
1.987 raeburn 13039: }
13040: if ($upload_output) {
13041: $upload_output = &start_data_table().
13042: $upload_output.
13043: &end_data_table()."\n";
13044: }
1.1071 raeburn 13045: if ($modify_output) {
13046: $modify_output = &start_data_table().
13047: &start_data_table_header_row().
13048: '<th>'.&mt('File').'</th>'.
13049: '<th>'.&mt('Size (KB)').'</th>'.
13050: '<th>'.&mt('Modified').'</th>'.
13051: '<th>'.&mt('Upload replacement?').'</th>'.
13052: &end_data_table_header_row().
13053: $modify_output.
13054: &end_data_table()."\n";
13055: }
13056: if ($delete_output) {
13057: $delete_output = &start_data_table().
13058: &start_data_table_header_row().
13059: '<th>'.&mt('File').'</th>'.
13060: '<th>'.&mt('Size (KB)').'</th>'.
13061: '<th>'.&mt('Modified').'</th>'.
13062: '<th>'.&mt('Delete?').'</th>'.
13063: &end_data_table_header_row().
13064: $delete_output.
13065: &end_data_table()."\n";
13066: }
1.987 raeburn 13067: my $applies = 0;
13068: if ($numremref) {
13069: $applies ++;
13070: }
13071: if ($numinvalid) {
13072: $applies ++;
13073: }
13074: if ($numexisting) {
13075: $applies ++;
13076: }
1.1071 raeburn 13077: if ($counter || $numunused) {
1.987 raeburn 13078: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13079: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13080: $state.'<h3>'.$heading.'</h3>';
13081: if ($actionurl eq '/adm/dependencies') {
13082: if ($numnew) {
13083: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13084: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13085: $upload_output.'<br />'."\n";
13086: }
13087: if ($numexisting) {
13088: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13089: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13090: $modify_output.'<br />'."\n";
13091: $buttontext = &mt('Save changes');
13092: }
13093: if ($numunused) {
13094: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13095: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13096: $delete_output.'<br />'."\n";
13097: $buttontext = &mt('Save changes');
13098: }
13099: } else {
13100: $output .= $upload_output.'<br />'."\n";
13101: }
13102: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13103: $counter.'" />'."\n";
13104: if ($actionurl eq '/adm/dependencies') {
13105: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13106: $numnew.'" />'."\n";
13107: } elsif ($actionurl eq '') {
1.987 raeburn 13108: $output .= '<input type="hidden" name="phase" value="three" />';
13109: }
13110: } elsif ($applies) {
13111: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13112: if ($applies > 1) {
13113: $output .=
1.1123 raeburn 13114: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13115: if ($numremref) {
13116: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13117: }
13118: if ($numinvalid) {
13119: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13120: }
13121: if ($numexisting) {
13122: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13123: }
13124: $output .= '</ul><br />';
13125: } elsif ($numremref) {
13126: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13127: } elsif ($numinvalid) {
13128: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13129: } elsif ($numexisting) {
13130: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13131: }
13132: $output .= $upload_output.'<br />';
13133: }
13134: my ($pathchange_output,$chgcount);
1.1071 raeburn 13135: $chgcount = $counter;
1.987 raeburn 13136: if (keys(%pathchanges) > 0) {
13137: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13138: if ($counter) {
1.987 raeburn 13139: $output .= &embedded_file_element('pathchange',$chgcount,
13140: $embed_file,\%mapping,
1.1071 raeburn 13141: $allfiles,$codebase,'change');
1.987 raeburn 13142: } else {
13143: $pathchange_output .=
13144: &start_data_table_row().
13145: '<td><input type ="checkbox" name="namechange" value="'.
13146: $chgcount.'" checked="checked" /></td>'.
13147: '<td>'.$mapping{$embed_file}.'</td>'.
13148: '<td>'.$embed_file.
13149: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13150: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13151: '</td>'.&end_data_table_row();
1.660 raeburn 13152: }
1.987 raeburn 13153: $numpathchg ++;
13154: $chgcount ++;
1.660 raeburn 13155: }
13156: }
1.1127 raeburn 13157: if (($counter) || ($numunused)) {
1.987 raeburn 13158: if ($numpathchg) {
13159: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13160: $numpathchg.'" />'."\n";
13161: }
13162: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13163: ($actionurl eq '/adm/imsimport')) {
13164: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13165: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13166: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13167: } elsif ($actionurl eq '/adm/dependencies') {
13168: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13169: }
1.1123 raeburn 13170: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13171: } elsif ($numpathchg) {
13172: my %pathchange = ();
13173: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13174: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13175: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13176: }
1.987 raeburn 13177: }
1.1071 raeburn 13178: return ($output,$counter,$numpathchg);
1.987 raeburn 13179: }
13180:
1.1147 raeburn 13181: =pod
13182:
13183: =item * clean_path($name)
13184:
13185: Performs clean-up of directories, subdirectories and filename in an
13186: embedded object, referenced in an HTML file which is being uploaded
13187: to a course or portfolio, where
13188: "Upload embedded images/multimedia files if HTML file" checkbox was
13189: checked.
13190:
13191: Clean-up is similar to replacements in lonnet::clean_filename()
13192: except each / between sub-directory and next level is preserved.
13193:
13194: =cut
13195:
13196: sub clean_path {
13197: my ($embed_file) = @_;
13198: $embed_file =~s{^/+}{};
13199: my @contents;
13200: if ($embed_file =~ m{/}) {
13201: @contents = split(/\//,$embed_file);
13202: } else {
13203: @contents = ($embed_file);
13204: }
13205: my $lastidx = scalar(@contents)-1;
13206: for (my $i=0; $i<=$lastidx; $i++) {
13207: $contents[$i]=~s{\\}{/}g;
13208: $contents[$i]=~s/\s+/\_/g;
13209: $contents[$i]=~s{[^/\w\.\-]}{}g;
13210: if ($i == $lastidx) {
13211: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13212: }
13213: }
13214: if ($lastidx > 0) {
13215: return join('/',@contents);
13216: } else {
13217: return $contents[0];
13218: }
13219: }
13220:
1.987 raeburn 13221: sub embedded_file_element {
1.1071 raeburn 13222: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13223: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13224: (ref($codebase) eq 'HASH'));
13225: my $output;
1.1071 raeburn 13226: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13227: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13228: }
13229: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13230: &escape($embed_file).'" />';
13231: unless (($context eq 'upload_embedded') &&
13232: ($mapping->{$embed_file} eq $embed_file)) {
13233: $output .='
13234: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13235: }
13236: my $attrib;
13237: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13238: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13239: }
13240: $output .=
13241: "\n\t\t".
13242: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13243: $attrib.'" />';
13244: if (exists($codebase->{$mapping->{$embed_file}})) {
13245: $output .=
13246: "\n\t\t".
13247: '<input name="codebase_'.$num.'" type="hidden" value="'.
13248: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13249: }
1.987 raeburn 13250: return $output;
1.660 raeburn 13251: }
13252:
1.1071 raeburn 13253: sub get_dependency_details {
13254: my ($currfile,$currsubfile,$embed_file) = @_;
13255: my ($size,$mtime,$showsize,$showmtime);
13256: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13257: if ($embed_file =~ m{/}) {
13258: my ($path,$fname) = split(/\//,$embed_file);
13259: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13260: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13261: }
13262: } else {
13263: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13264: ($size,$mtime) = @{$currfile->{$embed_file}};
13265: }
13266: }
13267: $showsize = $size/1024.0;
13268: $showsize = sprintf("%.1f",$showsize);
13269: if ($mtime > 0) {
13270: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13271: }
13272: }
13273: return ($showsize,$showmtime);
13274: }
13275:
13276: sub ask_embedded_js {
13277: return <<"END";
13278: <script type="text/javascript"">
13279: // <![CDATA[
13280: function toggleBrowse(counter) {
13281: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13282: var fileid = document.getElementById('embedded_item_'+counter);
13283: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13284: if (chkboxid.checked == true) {
13285: uploaddivid.style.display='block';
13286: } else {
13287: uploaddivid.style.display='none';
13288: fileid.value = '';
13289: }
13290: }
13291: // ]]>
13292: </script>
13293:
13294: END
13295: }
13296:
1.661 raeburn 13297: sub upload_embedded {
13298: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13299: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13300: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13301: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13302: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13303: my $orig_uploaded_filename =
13304: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13305: foreach my $type ('orig','ref','attrib','codebase') {
13306: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13307: $env{'form.embedded_'.$type.'_'.$i} =
13308: &unescape($env{'form.embedded_'.$type.'_'.$i});
13309: }
13310: }
1.661 raeburn 13311: my ($path,$fname) =
13312: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13313: # no path, whole string is fname
13314: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13315: $fname = &Apache::lonnet::clean_filename($fname);
13316: # See if there is anything left
13317: next if ($fname eq '');
13318:
13319: # Check if file already exists as a file or directory.
13320: my ($state,$msg);
13321: if ($context eq 'portfolio') {
13322: my $port_path = $dirpath;
13323: if ($group ne '') {
13324: $port_path = "groups/$group/$port_path";
13325: }
1.987 raeburn 13326: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13327: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13328: $dir_root,$port_path,$disk_quota,
13329: $current_disk_usage,$uname,$udom);
13330: if ($state eq 'will_exceed_quota'
1.984 raeburn 13331: || $state eq 'file_locked') {
1.661 raeburn 13332: $output .= $msg;
13333: next;
13334: }
13335: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13336: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13337: if ($state eq 'exists') {
13338: $output .= $msg;
13339: next;
13340: }
13341: }
13342: # Check if extension is valid
13343: if (($fname =~ /\.(\w+)$/) &&
13344: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13345: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13346: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13347: next;
13348: } elsif (($fname =~ /\.(\w+)$/) &&
13349: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13350: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13351: next;
13352: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13353: $output .= &mt('Filename not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />';
1.661 raeburn 13354: next;
13355: }
13356: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13357: my $subdir = $path;
13358: $subdir =~ s{/+$}{};
1.661 raeburn 13359: if ($context eq 'portfolio') {
1.984 raeburn 13360: my $result;
13361: if ($state eq 'existingfile') {
13362: $result=
13363: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13364: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13365: } else {
1.984 raeburn 13366: $result=
13367: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13368: $dirpath.
1.1123 raeburn 13369: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13370: if ($result !~ m|^/uploaded/|) {
13371: $output .= '<span class="LC_error">'
13372: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13373: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13374: .'</span><br />';
13375: next;
13376: } else {
1.987 raeburn 13377: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13378: $path.$fname.'</span>').'<br />';
1.984 raeburn 13379: }
1.661 raeburn 13380: }
1.1123 raeburn 13381: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13382: my $extendedsubdir = $dirpath.'/'.$subdir;
13383: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13384: my $result =
1.1126 raeburn 13385: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13386: if ($result !~ m|^/uploaded/|) {
13387: $output .= '<span class="LC_error">'
13388: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13389: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13390: .'</span><br />';
13391: next;
13392: } else {
13393: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13394: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13395: if ($context eq 'syllabus') {
13396: &Apache::lonnet::make_public_indefinitely($result);
13397: }
1.987 raeburn 13398: }
1.661 raeburn 13399: } else {
13400: # Save the file
13401: my $target = $env{'form.embedded_item_'.$i};
13402: my $fullpath = $dir_root.$dirpath.'/'.$path;
13403: my $dest = $fullpath.$fname;
13404: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13405: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13406: my $count;
13407: my $filepath = $dir_root;
1.1027 raeburn 13408: foreach my $subdir (@parts) {
13409: $filepath .= "/$subdir";
13410: if (!-e $filepath) {
1.661 raeburn 13411: mkdir($filepath,0770);
13412: }
13413: }
13414: my $fh;
13415: if (!open($fh,'>'.$dest)) {
13416: &Apache::lonnet::logthis('Failed to create '.$dest);
13417: $output .= '<span class="LC_error">'.
1.1071 raeburn 13418: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13419: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13420: '</span><br />';
13421: } else {
13422: if (!print $fh $env{'form.embedded_item_'.$i}) {
13423: &Apache::lonnet::logthis('Failed to write to '.$dest);
13424: $output .= '<span class="LC_error">'.
1.1071 raeburn 13425: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13426: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13427: '</span><br />';
13428: } else {
1.987 raeburn 13429: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13430: $url.'</span>').'<br />';
13431: unless ($context eq 'testbank') {
13432: $footer .= &mt('View embedded file: [_1]',
13433: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13434: }
13435: }
13436: close($fh);
13437: }
13438: }
13439: if ($env{'form.embedded_ref_'.$i}) {
13440: $pathchange{$i} = 1;
13441: }
13442: }
13443: if ($output) {
13444: $output = '<p>'.$output.'</p>';
13445: }
13446: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13447: $returnflag = 'ok';
1.1071 raeburn 13448: my $numpathchgs = scalar(keys(%pathchange));
13449: if ($numpathchgs > 0) {
1.987 raeburn 13450: if ($context eq 'portfolio') {
13451: $output .= '<p>'.&mt('or').'</p>';
13452: } elsif ($context eq 'testbank') {
1.1071 raeburn 13453: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13454: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13455: $returnflag = 'modify_orightml';
13456: }
13457: }
1.1071 raeburn 13458: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13459: }
13460:
13461: sub modify_html_form {
13462: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13463: my $end = 0;
13464: my $modifyform;
13465: if ($context eq 'upload_embedded') {
13466: return unless (ref($pathchange) eq 'HASH');
13467: if ($env{'form.number_embedded_items'}) {
13468: $end += $env{'form.number_embedded_items'};
13469: }
13470: if ($env{'form.number_pathchange_items'}) {
13471: $end += $env{'form.number_pathchange_items'};
13472: }
13473: if ($end) {
13474: for (my $i=0; $i<$end; $i++) {
13475: if ($i < $env{'form.number_embedded_items'}) {
13476: next unless($pathchange->{$i});
13477: }
13478: $modifyform .=
13479: &start_data_table_row().
13480: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13481: 'checked="checked" /></td>'.
13482: '<td>'.$env{'form.embedded_ref_'.$i}.
13483: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13484: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13485: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13486: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13487: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13488: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13489: '<td>'.$env{'form.embedded_orig_'.$i}.
13490: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13491: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13492: &end_data_table_row();
1.1071 raeburn 13493: }
1.987 raeburn 13494: }
13495: } else {
13496: $modifyform = $pathchgtable;
13497: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13498: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13499: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13500: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13501: }
13502: }
13503: if ($modifyform) {
1.1071 raeburn 13504: if ($actionurl eq '/adm/dependencies') {
13505: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13506: }
1.987 raeburn 13507: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13508: '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n".
13509: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13510: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13511: '</ol></p>'."\n".'<p>'.
13512: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13513: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13514: &start_data_table()."\n".
13515: &start_data_table_header_row().
13516: '<th>'.&mt('Change?').'</th>'.
13517: '<th>'.&mt('Current reference').'</th>'.
13518: '<th>'.&mt('Required reference').'</th>'.
13519: &end_data_table_header_row()."\n".
13520: $modifyform.
13521: &end_data_table().'<br />'."\n".$hiddenstate.
13522: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13523: '</form>'."\n";
13524: }
13525: return;
13526: }
13527:
13528: sub modify_html_refs {
1.1123 raeburn 13529: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13530: my $container;
13531: if ($context eq 'portfolio') {
13532: $container = $env{'form.container'};
13533: } elsif ($context eq 'coursedoc') {
13534: $container = $env{'form.primaryurl'};
1.1071 raeburn 13535: } elsif ($context eq 'manage_dependencies') {
13536: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13537: $container = "/$container";
1.1123 raeburn 13538: } elsif ($context eq 'syllabus') {
13539: $container = $url;
1.987 raeburn 13540: } else {
1.1027 raeburn 13541: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13542: }
13543: my (%allfiles,%codebase,$output,$content);
13544: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13545: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13546: if (wantarray) {
13547: return ('',0,0);
13548: } else {
13549: return;
13550: }
13551: }
13552: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13553: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13554: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13555: if (wantarray) {
13556: return ('',0,0);
13557: } else {
13558: return;
13559: }
13560: }
1.987 raeburn 13561: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13562: if ($content eq '-1') {
13563: if (wantarray) {
13564: return ('',0,0);
13565: } else {
13566: return;
13567: }
13568: }
1.987 raeburn 13569: } else {
1.1071 raeburn 13570: unless ($container =~ /^\Q$dir_root\E/) {
13571: if (wantarray) {
13572: return ('',0,0);
13573: } else {
13574: return;
13575: }
13576: }
1.1317 raeburn 13577: if (open(my $fh,'<',$container)) {
1.987 raeburn 13578: $content = join('', <$fh>);
13579: close($fh);
13580: } else {
1.1071 raeburn 13581: if (wantarray) {
13582: return ('',0,0);
13583: } else {
13584: return;
13585: }
1.987 raeburn 13586: }
13587: }
13588: my ($count,$codebasecount) = (0,0);
13589: my $mm = new File::MMagic;
13590: my $mime_type = $mm->checktype_contents($content);
13591: if ($mime_type eq 'text/html') {
13592: my $parse_result =
13593: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13594: \%codebase,\$content);
13595: if ($parse_result eq 'ok') {
13596: foreach my $i (@changes) {
13597: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13598: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13599: if ($allfiles{$ref}) {
13600: my $newname = $orig;
13601: my ($attrib_regexp,$codebase);
1.1006 raeburn 13602: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13603: if ($attrib_regexp =~ /:/) {
13604: $attrib_regexp =~ s/\:/|/g;
13605: }
13606: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13607: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13608: $count += $numchg;
1.1123 raeburn 13609: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13610: delete($allfiles{$ref});
1.987 raeburn 13611: }
13612: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13613: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13614: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13615: $codebasecount ++;
13616: }
13617: }
13618: }
1.1123 raeburn 13619: my $skiprewrites;
1.987 raeburn 13620: if ($count || $codebasecount) {
13621: my $saveresult;
1.1071 raeburn 13622: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13623: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13624: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13625: if ($url eq $container) {
13626: my ($fname) = ($container =~ m{/([^/]+)$});
13627: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13628: $count,'<span class="LC_filename">'.
1.1071 raeburn 13629: $fname.'</span>').'</p>';
1.987 raeburn 13630: } else {
13631: $output = '<p class="LC_error">'.
13632: &mt('Error: update failed for: [_1].',
13633: '<span class="LC_filename">'.
13634: $container.'</span>').'</p>';
13635: }
1.1123 raeburn 13636: if ($context eq 'syllabus') {
13637: unless ($saveresult eq 'ok') {
13638: $skiprewrites = 1;
13639: }
13640: }
1.987 raeburn 13641: } else {
1.1317 raeburn 13642: if (open(my $fh,'>',$container)) {
1.987 raeburn 13643: print $fh $content;
13644: close($fh);
13645: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13646: $count,'<span class="LC_filename">'.
13647: $container.'</span>').'</p>';
1.661 raeburn 13648: } else {
1.987 raeburn 13649: $output = '<p class="LC_error">'.
13650: &mt('Error: could not update [_1].',
13651: '<span class="LC_filename">'.
13652: $container.'</span>').'</p>';
1.661 raeburn 13653: }
13654: }
13655: }
1.1123 raeburn 13656: if (($context eq 'syllabus') && (!$skiprewrites)) {
13657: my ($actionurl,$state);
13658: $actionurl = "/public/$udom/$uname/syllabus";
13659: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13660: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13661: \%codebase,
13662: {'context' => 'rewrites',
13663: 'ignore_remote_references' => 1,});
13664: if (ref($mapping) eq 'HASH') {
13665: my $rewrites = 0;
13666: foreach my $key (keys(%{$mapping})) {
13667: next if ($key =~ m{^https?://});
13668: my $ref = $mapping->{$key};
13669: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13670: my $attrib;
13671: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13672: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13673: }
13674: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13675: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13676: $rewrites += $numchg;
13677: }
13678: }
13679: if ($rewrites) {
13680: my $saveresult;
13681: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13682: if ($url eq $container) {
13683: my ($fname) = ($container =~ m{/([^/]+)$});
13684: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13685: $count,'<span class="LC_filename">'.
13686: $fname.'</span>').'</p>';
13687: } else {
13688: $output .= '<p class="LC_error">'.
13689: &mt('Error: could not update links in [_1].',
13690: '<span class="LC_filename">'.
13691: $container.'</span>').'</p>';
13692:
13693: }
13694: }
13695: }
13696: }
1.987 raeburn 13697: } else {
13698: &logthis('Failed to parse '.$container.
13699: ' to modify references: '.$parse_result);
1.661 raeburn 13700: }
13701: }
1.1071 raeburn 13702: if (wantarray) {
13703: return ($output,$count,$codebasecount);
13704: } else {
13705: return $output;
13706: }
1.661 raeburn 13707: }
13708:
13709: sub check_for_existing {
13710: my ($path,$fname,$element) = @_;
13711: my ($state,$msg);
13712: if (-d $path.'/'.$fname) {
13713: $state = 'exists';
13714: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13715: } elsif (-e $path.'/'.$fname) {
13716: $state = 'exists';
13717: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13718: }
13719: if ($state eq 'exists') {
13720: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13721: }
13722: return ($state,$msg);
13723: }
13724:
13725: sub check_for_upload {
13726: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13727: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13728: my $filesize = length($env{'form.'.$element});
13729: if (!$filesize) {
13730: my $msg = '<span class="LC_error">'.
13731: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13732: '<span class="LC_filename">'.$fname.'</span>',
13733: $filesize).'<br />'.
1.1007 raeburn 13734: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13735: '</span>';
13736: return ('zero_bytes',$msg);
13737: }
13738: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13739: my $getpropath = 1;
1.1021 raeburn 13740: my ($dirlistref,$listerror) =
13741: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13742: my $found_file = 0;
13743: my $locked_file = 0;
1.991 raeburn 13744: my @lockers;
13745: my $navmap;
13746: if ($env{'request.course.id'}) {
13747: $navmap = Apache::lonnavmaps::navmap->new();
13748: }
1.1021 raeburn 13749: if (ref($dirlistref) eq 'ARRAY') {
13750: foreach my $line (@{$dirlistref}) {
13751: my ($file_name,$rest)=split(/\&/,$line,2);
13752: if ($file_name eq $fname){
13753: $file_name = $path.$file_name;
13754: if ($group ne '') {
13755: $file_name = $group.$file_name;
13756: }
13757: $found_file = 1;
13758: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13759: foreach my $lock (@lockers) {
13760: if (ref($lock) eq 'ARRAY') {
13761: my ($symb,$crsid) = @{$lock};
13762: if ($crsid eq $env{'request.course.id'}) {
13763: if (ref($navmap)) {
13764: my $res = $navmap->getBySymb($symb);
13765: foreach my $part (@{$res->parts()}) {
13766: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13767: unless (($slot_status == $res->RESERVED) ||
13768: ($slot_status == $res->RESERVED_LOCATION)) {
13769: $locked_file = 1;
13770: }
1.991 raeburn 13771: }
1.1021 raeburn 13772: } else {
13773: $locked_file = 1;
1.991 raeburn 13774: }
13775: } else {
13776: $locked_file = 1;
13777: }
13778: }
1.1021 raeburn 13779: }
13780: } else {
13781: my @info = split(/\&/,$rest);
13782: my $currsize = $info[6]/1000;
13783: if ($currsize < $filesize) {
13784: my $extra = $filesize - $currsize;
13785: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13786: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13787: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
1.1179 bisitz 13788: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13789: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13790: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13791: return ('will_exceed_quota',$msg);
13792: }
1.984 raeburn 13793: }
13794: }
1.661 raeburn 13795: }
13796: }
13797: }
13798: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13799: my $msg = '<p class="LC_warning">'.
13800: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13801: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13802: return ('will_exceed_quota',$msg);
13803: } elsif ($found_file) {
13804: if ($locked_file) {
1.1179 bisitz 13805: my $msg = '<p class="LC_warning">';
1.661 raeburn 13806: $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
1.1179 bisitz 13807: $msg .= '</p>';
1.661 raeburn 13808: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13809: return ('file_locked',$msg);
13810: } else {
1.1179 bisitz 13811: my $msg = '<p class="LC_error">';
1.984 raeburn 13812: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1179 bisitz 13813: $msg .= '</p>';
1.984 raeburn 13814: return ('existingfile',$msg);
1.661 raeburn 13815: }
13816: }
13817: }
13818:
1.987 raeburn 13819: sub check_for_traversal {
13820: my ($path,$url,$toplevel) = @_;
13821: my @parts=split(/\//,$path);
13822: my $cleanpath;
13823: my $fullpath = $url;
13824: for (my $i=0;$i<@parts;$i++) {
13825: next if ($parts[$i] eq '.');
13826: if ($parts[$i] eq '..') {
13827: $fullpath =~ s{([^/]+/)$}{};
13828: } else {
13829: $fullpath .= $parts[$i].'/';
13830: }
13831: }
13832: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13833: $cleanpath = $1;
13834: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13835: my $curr_toprel = $1;
13836: my @parts = split(/\//,$curr_toprel);
13837: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13838: my @urlparts = split(/\//,$url_toprel);
13839: my $doubledots;
13840: my $startdiff = -1;
13841: for (my $i=0; $i<@urlparts; $i++) {
13842: if ($startdiff == -1) {
13843: unless ($urlparts[$i] eq $parts[$i]) {
13844: $startdiff = $i;
13845: $doubledots .= '../';
13846: }
13847: } else {
13848: $doubledots .= '../';
13849: }
13850: }
13851: if ($startdiff > -1) {
13852: $cleanpath = $doubledots;
13853: for (my $i=$startdiff; $i<@parts; $i++) {
13854: $cleanpath .= $parts[$i].'/';
13855: }
13856: }
13857: }
13858: $cleanpath =~ s{(/)$}{};
13859: return $cleanpath;
13860: }
1.31 albertel 13861:
1.1053 raeburn 13862: sub is_archive_file {
13863: my ($mimetype) = @_;
13864: if (($mimetype eq 'application/octet-stream') ||
13865: ($mimetype eq 'application/x-stuffit') ||
13866: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13867: return 1;
13868: }
13869: return;
13870: }
13871:
13872: sub decompress_form {
1.1065 raeburn 13873: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13874: my %lt = &Apache::lonlocal::texthash (
13875: this => 'This file is an archive file.',
1.1067 raeburn 13876: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13877: itsc => 'Its contents are as follows:',
1.1053 raeburn 13878: youm => 'You may wish to extract its contents.',
13879: extr => 'Extract contents',
1.1067 raeburn 13880: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13881: proa => 'Process automatically?',
1.1053 raeburn 13882: yes => 'Yes',
13883: no => 'No',
1.1067 raeburn 13884: fold => 'Title for folder containing movie',
13885: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13886: );
1.1065 raeburn 13887: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13888: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13889: my $info = &list_archive_contents($fileloc,\@paths);
13890: if (@paths) {
13891: foreach my $path (@paths) {
13892: $path =~ s{^/}{};
1.1067 raeburn 13893: if ($path =~ m{^([^/]+)/$}) {
13894: $topdir = $1;
13895: }
1.1065 raeburn 13896: if ($path =~ m{^([^/]+)/}) {
13897: $toplevel{$1} = $path;
13898: } else {
13899: $toplevel{$path} = $path;
13900: }
13901: }
13902: }
1.1067 raeburn 13903: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13904: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13905: "$topdir/media/",
13906: "$topdir/media/$topdir.mp4",
13907: "$topdir/media/FirstFrame.png",
13908: "$topdir/media/player.swf",
13909: "$topdir/media/swfobject.js",
13910: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13911: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13912: "$topdir/$topdir.mp4",
13913: "$topdir/$topdir\_config.xml",
13914: "$topdir/$topdir\_controller.swf",
13915: "$topdir/$topdir\_embed.css",
13916: "$topdir/$topdir\_First_Frame.png",
13917: "$topdir/$topdir\_player.html",
13918: "$topdir/$topdir\_Thumbnails.png",
13919: "$topdir/playerProductInstall.swf",
13920: "$topdir/scripts/",
13921: "$topdir/scripts/config_xml.js",
13922: "$topdir/scripts/handlebars.js",
13923: "$topdir/scripts/jquery-1.7.1.min.js",
13924: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13925: "$topdir/scripts/modernizr.js",
13926: "$topdir/scripts/player-min.js",
13927: "$topdir/scripts/swfobject.js",
13928: "$topdir/skins/",
13929: "$topdir/skins/configuration_express.xml",
13930: "$topdir/skins/express_show/",
13931: "$topdir/skins/express_show/player-min.css",
13932: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13933: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13934: "$topdir/$topdir.mp4",
13935: "$topdir/$topdir\_config.xml",
13936: "$topdir/$topdir\_controller.swf",
13937: "$topdir/$topdir\_embed.css",
13938: "$topdir/$topdir\_First_Frame.png",
13939: "$topdir/$topdir\_player.html",
13940: "$topdir/$topdir\_Thumbnails.png",
13941: "$topdir/playerProductInstall.swf",
13942: "$topdir/scripts/",
13943: "$topdir/scripts/config_xml.js",
13944: "$topdir/scripts/techsmith-smart-player.min.js",
13945: "$topdir/skins/",
13946: "$topdir/skins/configuration_express.xml",
13947: "$topdir/skins/express_show/",
13948: "$topdir/skins/express_show/spritesheet.min.css",
13949: "$topdir/skins/express_show/spritesheet.png",
13950: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13951: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13952: if (@diffs == 0) {
1.1164 raeburn 13953: $is_camtasia = 6;
13954: } else {
1.1197 raeburn 13955: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13956: if (@diffs == 0) {
13957: $is_camtasia = 8;
1.1197 raeburn 13958: } else {
13959: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13960: if (@diffs == 0) {
13961: $is_camtasia = 8;
13962: }
1.1164 raeburn 13963: }
1.1067 raeburn 13964: }
13965: }
13966: my $output;
13967: if ($is_camtasia) {
13968: $output = <<"ENDCAM";
13969: <script type="text/javascript" language="Javascript">
13970: // <![CDATA[
13971:
13972: function camtasiaToggle() {
13973: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13974: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13975: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 13976: document.getElementById('camtasia_titles').style.display='block';
13977: } else {
13978: document.getElementById('camtasia_titles').style.display='none';
13979: }
13980: }
13981: }
13982: return;
13983: }
13984:
13985: // ]]>
13986: </script>
13987: <p>$lt{'camt'}</p>
13988: ENDCAM
1.1065 raeburn 13989: } else {
1.1067 raeburn 13990: $output = '<p>'.$lt{'this'};
13991: if ($info eq '') {
13992: $output .= ' '.$lt{'youm'}.'</p>'."\n";
13993: } else {
13994: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
13995: '<div><pre>'.$info.'</pre></div>';
13996: }
1.1065 raeburn 13997: }
1.1067 raeburn 13998: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 13999: my $duplicates;
14000: my $num = 0;
14001: if (ref($dirlist) eq 'ARRAY') {
14002: foreach my $item (@{$dirlist}) {
14003: if (ref($item) eq 'ARRAY') {
14004: if (exists($toplevel{$item->[0]})) {
14005: $duplicates .=
14006: &start_data_table_row().
14007: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14008: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14009: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14010: 'value="1" />'.&mt('Yes').'</label>'.
14011: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14012: '<td>'.$item->[0].'</td>';
14013: if ($item->[2]) {
14014: $duplicates .= '<td>'.&mt('Directory').'</td>';
14015: } else {
14016: $duplicates .= '<td>'.&mt('File').'</td>';
14017: }
14018: $duplicates .= '<td>'.$item->[3].'</td>'.
14019: '<td>'.
14020: &Apache::lonlocal::locallocaltime($item->[4]).
14021: '</td>'.
14022: &end_data_table_row();
14023: $num ++;
14024: }
14025: }
14026: }
14027: }
14028: my $itemcount;
14029: if (@paths > 0) {
14030: $itemcount = scalar(@paths);
14031: } else {
14032: $itemcount = 1;
14033: }
1.1067 raeburn 14034: if ($is_camtasia) {
14035: $output .= $lt{'auto'}.'<br />'.
14036: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14037: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14038: $lt{'yes'}.'</label> <label>'.
14039: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14040: $lt{'no'}.'</label></span><br />'.
14041: '<div id="camtasia_titles" style="display:block">'.
14042: &Apache::lonhtmlcommon::start_pick_box().
14043: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14044: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14045: &Apache::lonhtmlcommon::row_closure().
14046: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14047: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14048: &Apache::lonhtmlcommon::row_closure(1).
14049: &Apache::lonhtmlcommon::end_pick_box().
14050: '</div>';
14051: }
1.1065 raeburn 14052: $output .=
14053: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14054: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14055: "\n";
1.1065 raeburn 14056: if ($duplicates ne '') {
14057: $output .= '<p><span class="LC_warning">'.
14058: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14059: &start_data_table().
14060: &start_data_table_header_row().
14061: '<th>'.&mt('Overwrite?').'</th>'.
14062: '<th>'.&mt('Name').'</th>'.
14063: '<th>'.&mt('Type').'</th>'.
14064: '<th>'.&mt('Size').'</th>'.
14065: '<th>'.&mt('Last modified').'</th>'.
14066: &end_data_table_header_row().
14067: $duplicates.
14068: &end_data_table().
14069: '</p>';
14070: }
1.1067 raeburn 14071: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14072: if (ref($hiddenelements) eq 'HASH') {
14073: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14074: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14075: }
14076: }
14077: $output .= <<"END";
1.1067 raeburn 14078: <br />
1.1053 raeburn 14079: <input type="submit" name="decompress" value="$lt{'extr'}" />
14080: </form>
14081: $noextract
14082: END
14083: return $output;
14084: }
14085:
1.1065 raeburn 14086: sub decompression_utility {
14087: my ($program) = @_;
14088: my @utilities = ('tar','gunzip','bunzip2','unzip');
14089: my $location;
14090: if (grep(/^\Q$program\E$/,@utilities)) {
14091: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14092: '/usr/sbin/') {
14093: if (-x $dir.$program) {
14094: $location = $dir.$program;
14095: last;
14096: }
14097: }
14098: }
14099: return $location;
14100: }
14101:
14102: sub list_archive_contents {
14103: my ($file,$pathsref) = @_;
14104: my (@cmd,$output);
14105: my $needsregexp;
14106: if ($file =~ /\.zip$/) {
14107: @cmd = (&decompression_utility('unzip'),"-l");
14108: $needsregexp = 1;
14109: } elsif (($file =~ m/\.tar\.gz$/) ||
14110: ($file =~ /\.tgz$/)) {
14111: @cmd = (&decompression_utility('tar'),"-ztf");
14112: } elsif ($file =~ /\.tar\.bz2$/) {
14113: @cmd = (&decompression_utility('tar'),"-jtf");
14114: } elsif ($file =~ m|\.tar$|) {
14115: @cmd = (&decompression_utility('tar'),"-tf");
14116: }
14117: if (@cmd) {
14118: undef($!);
14119: undef($@);
14120: if (open(my $fh,"-|", @cmd, $file)) {
14121: while (my $line = <$fh>) {
14122: $output .= $line;
14123: chomp($line);
14124: my $item;
14125: if ($needsregexp) {
14126: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14127: } else {
14128: $item = $line;
14129: }
14130: if ($item ne '') {
14131: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14132: push(@{$pathsref},$item);
14133: }
14134: }
14135: }
14136: close($fh);
14137: }
14138: }
14139: return $output;
14140: }
14141:
1.1053 raeburn 14142: sub decompress_uploaded_file {
14143: my ($file,$dir) = @_;
14144: &Apache::lonnet::appenv({'cgi.file' => $file});
14145: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14146: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14147: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14148: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14149: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14150: my $decompressed = $env{'cgi.decompressed'};
14151: &Apache::lonnet::delenv('cgi.file');
14152: &Apache::lonnet::delenv('cgi.dir');
14153: &Apache::lonnet::delenv('cgi.decompressed');
14154: return ($decompressed,$result);
14155: }
14156:
1.1055 raeburn 14157: sub process_decompression {
14158: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14159: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14160: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14161: &mt('Unexpected file path.').'</p>'."\n";
14162: }
14163: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14164: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14165: &mt('Unexpected course context.').'</p>'."\n";
14166: }
1.1293 raeburn 14167: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14168: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14169: &mt('Filename contained unexpected characters.').'</p>'."\n";
14170: }
1.1055 raeburn 14171: my ($dir,$error,$warning,$output);
1.1180 raeburn 14172: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14173: $error = &mt('Filename not a supported archive file type.').
14174: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14175: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14176: } else {
14177: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14178: if ($docuhome eq 'no_host') {
14179: $error = &mt('Could not determine home server for course.');
14180: } else {
14181: my @ids=&Apache::lonnet::current_machine_ids();
14182: my $currdir = "$dir_root/$destination";
14183: if (grep(/^\Q$docuhome\E$/,@ids)) {
14184: $dir = &LONCAPA::propath($docudom,$docuname).
14185: "$dir_root/$destination";
14186: } else {
14187: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14188: "$dir_root/$docudom/$docuname/$destination";
14189: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14190: $error = &mt('Archive file not found.');
14191: }
14192: }
1.1065 raeburn 14193: my (@to_overwrite,@to_skip);
14194: if ($env{'form.archive_overwrite_total'} > 0) {
14195: my $total = $env{'form.archive_overwrite_total'};
14196: for (my $i=0; $i<$total; $i++) {
14197: if ($env{'form.archive_overwrite_'.$i} == 1) {
14198: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14199: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14200: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14201: }
14202: }
14203: }
14204: my $numskip = scalar(@to_skip);
1.1292 raeburn 14205: my $numoverwrite = scalar(@to_overwrite);
14206: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14207: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14208: } elsif ($dir eq '') {
1.1055 raeburn 14209: $error = &mt('Directory containing archive file unavailable.');
14210: } elsif (!$error) {
1.1065 raeburn 14211: my ($decompressed,$display);
1.1292 raeburn 14212: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14213: my $tempdir = time.'_'.$$.int(rand(10000));
14214: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14215: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14216: ($decompressed,$display) =
14217: &decompress_uploaded_file($file,"$dir/$tempdir");
14218: foreach my $item (@to_skip) {
14219: if (($item ne '') && ($item !~ /\.\./)) {
14220: if (-f "$dir/$tempdir/$item") {
14221: unlink("$dir/$tempdir/$item");
14222: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14223: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14224: }
14225: }
14226: }
14227: foreach my $item (@to_overwrite) {
14228: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14229: if (($item ne '') && ($item !~ /\.\./)) {
14230: if (-f "$dir/$item") {
14231: unlink("$dir/$item");
14232: } elsif (-d "$dir/$item") {
1.1300 raeburn 14233: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14234: }
14235: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14236: }
1.1065 raeburn 14237: }
14238: }
1.1292 raeburn 14239: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14240: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14241: }
1.1065 raeburn 14242: }
14243: } else {
14244: ($decompressed,$display) =
14245: &decompress_uploaded_file($file,$dir);
14246: }
1.1055 raeburn 14247: if ($decompressed eq 'ok') {
1.1065 raeburn 14248: $output = '<p class="LC_info">'.
14249: &mt('Files extracted successfully from archive.').
14250: '</p>'."\n";
1.1055 raeburn 14251: my ($warning,$result,@contents);
14252: my ($newdirlistref,$newlisterror) =
14253: &Apache::lonnet::dirlist($currdir,$docudom,
14254: $docuname,1);
14255: my (%is_dir,%changes,@newitems);
14256: my $dirptr = 16384;
1.1065 raeburn 14257: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14258: foreach my $dir_line (@{$newdirlistref}) {
14259: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14260: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14261: push(@newitems,$item);
14262: if ($dirptr&$testdir) {
14263: $is_dir{$item} = 1;
14264: }
14265: $changes{$item} = 1;
14266: }
14267: }
14268: }
14269: if (keys(%changes) > 0) {
14270: foreach my $item (sort(@newitems)) {
14271: if ($changes{$item}) {
14272: push(@contents,$item);
14273: }
14274: }
14275: }
14276: if (@contents > 0) {
1.1067 raeburn 14277: my $wantform;
14278: unless ($env{'form.autoextract_camtasia'}) {
14279: $wantform = 1;
14280: }
1.1056 raeburn 14281: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14282: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14283: $currdir,\%is_dir,
14284: \%children,\%parent,
1.1056 raeburn 14285: \@contents,\%dirorder,
14286: \%titles,$wantform);
1.1055 raeburn 14287: if ($datatable ne '') {
14288: $output .= &archive_options_form('decompressed',$datatable,
14289: $count,$hiddenelem);
1.1065 raeburn 14290: my $startcount = 6;
1.1055 raeburn 14291: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14292: \%titles,\%children);
1.1055 raeburn 14293: }
1.1067 raeburn 14294: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14295: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14296: my %displayed;
14297: my $total = 1;
14298: $env{'form.archive_directory'} = [];
14299: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14300: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14301: $path =~ s{/$}{};
14302: my $item;
14303: if ($path ne '') {
14304: $item = "$path/$titles{$i}";
14305: } else {
14306: $item = $titles{$i};
14307: }
14308: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14309: if ($item eq $contents[0]) {
14310: push(@{$env{'form.archive_directory'}},$i);
14311: $env{'form.archive_'.$i} = 'display';
14312: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14313: $displayed{'folder'} = $i;
1.1164 raeburn 14314: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14315: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14316: $env{'form.archive_'.$i} = 'display';
14317: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14318: $displayed{'web'} = $i;
14319: } else {
1.1164 raeburn 14320: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14321: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14322: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14323: push(@{$env{'form.archive_directory'}},$i);
14324: }
14325: $env{'form.archive_'.$i} = 'dependency';
14326: }
14327: $total ++;
14328: }
14329: for (my $i=1; $i<$total; $i++) {
14330: next if ($i == $displayed{'web'});
14331: next if ($i == $displayed{'folder'});
14332: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14333: }
14334: $env{'form.phase'} = 'decompress_cleanup';
14335: $env{'form.archivedelete'} = 1;
14336: $env{'form.archive_count'} = $total-1;
14337: $output .=
14338: &process_extracted_files('coursedocs',$docudom,
14339: $docuname,$destination,
14340: $dir_root,$hiddenelem);
14341: }
1.1055 raeburn 14342: } else {
14343: $warning = &mt('No new items extracted from archive file.');
14344: }
14345: } else {
14346: $output = $display;
14347: $error = &mt('An error occurred during extraction from the archive file.');
14348: }
14349: }
14350: }
14351: }
14352: if ($error) {
14353: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14354: $error.'</p>'."\n";
14355: }
14356: if ($warning) {
14357: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14358: }
14359: return $output;
14360: }
14361:
14362: sub get_extracted {
1.1056 raeburn 14363: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14364: $titles,$wantform) = @_;
1.1055 raeburn 14365: my $count = 0;
14366: my $depth = 0;
14367: my $datatable;
1.1056 raeburn 14368: my @hierarchy;
1.1055 raeburn 14369: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14370: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14371: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14372: foreach my $item (@{$contents}) {
14373: $count ++;
1.1056 raeburn 14374: @{$dirorder->{$count}} = @hierarchy;
14375: $titles->{$count} = $item;
1.1055 raeburn 14376: &archive_hierarchy($depth,$count,$parent,$children);
14377: if ($wantform) {
14378: $datatable .= &archive_row($is_dir->{$item},$item,
14379: $currdir,$depth,$count);
14380: }
14381: if ($is_dir->{$item}) {
14382: $depth ++;
1.1056 raeburn 14383: push(@hierarchy,$count);
14384: $parent->{$depth} = $count;
1.1055 raeburn 14385: $datatable .=
14386: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14387: \$depth,\$count,\@hierarchy,$dirorder,
14388: $children,$parent,$titles,$wantform);
1.1055 raeburn 14389: $depth --;
1.1056 raeburn 14390: pop(@hierarchy);
1.1055 raeburn 14391: }
14392: }
14393: return ($count,$datatable);
14394: }
14395:
14396: sub recurse_extracted_archive {
1.1056 raeburn 14397: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14398: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14399: my $result='';
1.1056 raeburn 14400: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14401: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14402: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14403: return $result;
14404: }
14405: my $dirptr = 16384;
14406: my ($newdirlistref,$newlisterror) =
14407: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14408: if (ref($newdirlistref) eq 'ARRAY') {
14409: foreach my $dir_line (@{$newdirlistref}) {
14410: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14411: unless ($item =~ /^\.+$/) {
14412: $$count ++;
1.1056 raeburn 14413: @{$dirorder->{$$count}} = @{$hierarchy};
14414: $titles->{$$count} = $item;
1.1055 raeburn 14415: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14416:
1.1055 raeburn 14417: my $is_dir;
14418: if ($dirptr&$testdir) {
14419: $is_dir = 1;
14420: }
14421: if ($wantform) {
14422: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14423: }
14424: if ($is_dir) {
14425: $$depth ++;
1.1056 raeburn 14426: push(@{$hierarchy},$$count);
14427: $parent->{$$depth} = $$count;
1.1055 raeburn 14428: $result .=
14429: &recurse_extracted_archive("$currdir/$item",$docudom,
14430: $docuname,$depth,$count,
1.1056 raeburn 14431: $hierarchy,$dirorder,$children,
14432: $parent,$titles,$wantform);
1.1055 raeburn 14433: $$depth --;
1.1056 raeburn 14434: pop(@{$hierarchy});
1.1055 raeburn 14435: }
14436: }
14437: }
14438: }
14439: return $result;
14440: }
14441:
14442: sub archive_hierarchy {
14443: my ($depth,$count,$parent,$children) =@_;
14444: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14445: if (exists($parent->{$depth})) {
14446: $children->{$parent->{$depth}} .= $count.':';
14447: }
14448: }
14449: return;
14450: }
14451:
14452: sub archive_row {
14453: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14454: my ($name) = ($item =~ m{([^/]+)$});
14455: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14456: 'display' => 'Add as file',
1.1055 raeburn 14457: 'dependency' => 'Include as dependency',
14458: 'discard' => 'Discard',
14459: );
14460: if ($is_dir) {
1.1059 raeburn 14461: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14462: }
1.1056 raeburn 14463: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14464: my $offset = 0;
1.1055 raeburn 14465: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14466: $offset ++;
1.1065 raeburn 14467: if ($action ne 'display') {
14468: $offset ++;
14469: }
1.1055 raeburn 14470: $output .= '<td><span class="LC_nobreak">'.
14471: '<label><input type="radio" name="archive_'.$count.
14472: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14473: my $text = $choices{$action};
14474: if ($is_dir) {
14475: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14476: if ($action eq 'display') {
1.1059 raeburn 14477: $text = &mt('Add as folder');
1.1055 raeburn 14478: }
1.1056 raeburn 14479: } else {
14480: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14481:
14482: }
14483: $output .= ' /> '.$choices{$action}.'</label></span>';
14484: if ($action eq 'dependency') {
14485: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14486: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14487: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14488: '<option value=""></option>'."\n".
14489: '</select>'."\n".
14490: '</div>';
1.1059 raeburn 14491: } elsif ($action eq 'display') {
14492: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14493: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14494: '</div>';
1.1055 raeburn 14495: }
1.1056 raeburn 14496: $output .= '</td>';
1.1055 raeburn 14497: }
14498: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14499: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14500: for (my $i=0; $i<$depth; $i++) {
14501: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14502: }
14503: if ($is_dir) {
14504: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14505: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14506: } else {
14507: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14508: }
14509: $output .= ' '.$name.'</td>'."\n".
14510: &end_data_table_row();
14511: return $output;
14512: }
14513:
14514: sub archive_options_form {
1.1065 raeburn 14515: my ($form,$display,$count,$hiddenelem) = @_;
14516: my %lt = &Apache::lonlocal::texthash(
14517: perm => 'Permanently remove archive file?',
14518: hows => 'How should each extracted item be incorporated in the course?',
14519: cont => 'Content actions for all',
14520: addf => 'Add as folder/file',
14521: incd => 'Include as dependency for a displayed file',
14522: disc => 'Discard',
14523: no => 'No',
14524: yes => 'Yes',
14525: save => 'Save',
14526: );
14527: my $output = <<"END";
14528: <form name="$form" method="post" action="">
14529: <p><span class="LC_nobreak">$lt{'perm'}
14530: <label>
14531: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14532: </label>
14533:
14534: <label>
14535: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14536: </span>
14537: </p>
14538: <input type="hidden" name="phase" value="decompress_cleanup" />
14539: <br />$lt{'hows'}
14540: <div class="LC_columnSection">
14541: <fieldset>
14542: <legend>$lt{'cont'}</legend>
14543: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14544: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14545: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14546: </fieldset>
14547: </div>
14548: END
14549: return $output.
1.1055 raeburn 14550: &start_data_table()."\n".
1.1065 raeburn 14551: $display."\n".
1.1055 raeburn 14552: &end_data_table()."\n".
14553: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14554: $hiddenelem.
1.1065 raeburn 14555: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14556: '</form>';
14557: }
14558:
14559: sub archive_javascript {
1.1056 raeburn 14560: my ($startcount,$numitems,$titles,$children) = @_;
14561: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14562: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14563: my $scripttag = <<START;
14564: <script type="text/javascript">
14565: // <![CDATA[
14566:
14567: function checkAll(form,prefix) {
14568: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14569: for (var i=0; i < form.elements.length; i++) {
14570: var id = form.elements[i].id;
14571: if ((id != '') && (id != undefined)) {
14572: if (idstr.test(id)) {
14573: if (form.elements[i].type == 'radio') {
14574: form.elements[i].checked = true;
1.1056 raeburn 14575: var nostart = i-$startcount;
1.1059 raeburn 14576: var offset = nostart%7;
14577: var count = (nostart-offset)/7;
1.1056 raeburn 14578: dependencyCheck(form,count,offset);
1.1055 raeburn 14579: }
14580: }
14581: }
14582: }
14583: }
14584:
14585: function propagateCheck(form,count) {
14586: if (count > 0) {
1.1059 raeburn 14587: var startelement = $startcount + ((count-1) * 7);
14588: for (var j=1; j<6; j++) {
14589: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14590: var item = startelement + j;
14591: if (form.elements[item].type == 'radio') {
14592: if (form.elements[item].checked) {
14593: containerCheck(form,count,j);
14594: break;
14595: }
1.1055 raeburn 14596: }
14597: }
14598: }
14599: }
14600: }
14601:
14602: numitems = $numitems
1.1056 raeburn 14603: var titles = new Array(numitems);
14604: var parents = new Array(numitems);
1.1055 raeburn 14605: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14606: parents[i] = new Array;
1.1055 raeburn 14607: }
1.1059 raeburn 14608: var maintitle = '$maintitle';
1.1055 raeburn 14609:
14610: START
14611:
1.1056 raeburn 14612: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14613: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14614: for (my $i=0; $i<@contents; $i ++) {
14615: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14616: }
14617: }
14618:
1.1056 raeburn 14619: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14620: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14621: }
14622:
1.1055 raeburn 14623: $scripttag .= <<END;
14624:
14625: function containerCheck(form,count,offset) {
14626: if (count > 0) {
1.1056 raeburn 14627: dependencyCheck(form,count,offset);
1.1059 raeburn 14628: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14629: form.elements[item].checked = true;
14630: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14631: if (parents[count].length > 0) {
14632: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14633: containerCheck(form,parents[count][j],offset);
14634: }
14635: }
14636: }
14637: }
14638: }
14639:
14640: function dependencyCheck(form,count,offset) {
14641: if (count > 0) {
1.1059 raeburn 14642: var chosen = (offset+$startcount)+7*(count-1);
14643: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14644: var currtype = form.elements[depitem].type;
14645: if (form.elements[chosen].value == 'dependency') {
14646: document.getElementById('arc_depon_'+count).style.display='block';
14647: form.elements[depitem].options.length = 0;
14648: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14649: for (var i=1; i<=numitems; i++) {
14650: if (i == count) {
14651: continue;
14652: }
1.1059 raeburn 14653: var startelement = $startcount + (i-1) * 7;
14654: for (var j=1; j<6; j++) {
14655: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14656: var item = startelement + j;
14657: if (form.elements[item].type == 'radio') {
14658: if (form.elements[item].checked) {
14659: if (form.elements[item].value == 'display') {
14660: var n = form.elements[depitem].options.length;
14661: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14662: }
14663: }
14664: }
14665: }
14666: }
14667: }
14668: } else {
14669: document.getElementById('arc_depon_'+count).style.display='none';
14670: form.elements[depitem].options.length = 0;
14671: form.elements[depitem].options[0] = new Option('Select','',true,true);
14672: }
1.1059 raeburn 14673: titleCheck(form,count,offset);
1.1056 raeburn 14674: }
14675: }
14676:
14677: function propagateSelect(form,count,offset) {
14678: if (count > 0) {
1.1065 raeburn 14679: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14680: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14681: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14682: if (parents[count].length > 0) {
14683: for (var j=0; j<parents[count].length; j++) {
14684: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14685: }
14686: }
14687: }
14688: }
14689: }
1.1056 raeburn 14690:
14691: function containerSelect(form,count,offset,picked) {
14692: if (count > 0) {
1.1065 raeburn 14693: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14694: if (form.elements[item].type == 'radio') {
14695: if (form.elements[item].value == 'dependency') {
14696: if (form.elements[item+1].type == 'select-one') {
14697: for (var i=0; i<form.elements[item+1].options.length; i++) {
14698: if (form.elements[item+1].options[i].value == picked) {
14699: form.elements[item+1].selectedIndex = i;
14700: break;
14701: }
14702: }
14703: }
14704: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14705: if (parents[count].length > 0) {
14706: for (var j=0; j<parents[count].length; j++) {
14707: containerSelect(form,parents[count][j],offset,picked);
14708: }
14709: }
14710: }
14711: }
14712: }
14713: }
14714: }
14715:
1.1059 raeburn 14716: function titleCheck(form,count,offset) {
14717: if (count > 0) {
14718: var chosen = (offset+$startcount)+7*(count-1);
14719: var depitem = $startcount + ((count-1) * 7) + 2;
14720: var currtype = form.elements[depitem].type;
14721: if (form.elements[chosen].value == 'display') {
14722: document.getElementById('arc_title_'+count).style.display='block';
14723: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14724: document.getElementById('archive_title_'+count).value=maintitle;
14725: }
14726: } else {
14727: document.getElementById('arc_title_'+count).style.display='none';
14728: if (currtype == 'text') {
14729: document.getElementById('archive_title_'+count).value='';
14730: }
14731: }
14732: }
14733: return;
14734: }
14735:
1.1055 raeburn 14736: // ]]>
14737: </script>
14738: END
14739: return $scripttag;
14740: }
14741:
14742: sub process_extracted_files {
1.1067 raeburn 14743: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14744: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14745: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14746: my @ids=&Apache::lonnet::current_machine_ids();
14747: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14748: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14749: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14750: if (grep(/^\Q$docuhome\E$/,@ids)) {
14751: $prefix = &LONCAPA::propath($docudom,$docuname);
14752: $pathtocheck = "$dir_root/$destination";
14753: $dir = $dir_root;
14754: $ishome = 1;
14755: } else {
14756: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14757: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14758: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14759: }
14760: my $currdir = "$dir_root/$destination";
14761: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14762: if ($env{'form.folderpath'}) {
14763: my @items = split('&',$env{'form.folderpath'});
14764: $folders{'0'} = $items[-2];
1.1099 raeburn 14765: if ($env{'form.folderpath'} =~ /\:1$/) {
14766: $containers{'0'}='page';
14767: } else {
14768: $containers{'0'}='sequence';
14769: }
1.1055 raeburn 14770: }
14771: my @archdirs = &get_env_multiple('form.archive_directory');
14772: if ($numitems) {
14773: for (my $i=1; $i<=$numitems; $i++) {
14774: my $path = $env{'form.archive_content_'.$i};
14775: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14776: my $item = $1;
14777: $toplevelitems{$item} = $i;
14778: if (grep(/^\Q$i\E$/,@archdirs)) {
14779: $is_dir{$item} = 1;
14780: }
14781: }
14782: }
14783: }
1.1067 raeburn 14784: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14785: if (keys(%toplevelitems) > 0) {
14786: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14787: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14788: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14789: }
1.1066 raeburn 14790: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14791: if ($numitems) {
14792: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14793: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14794: my $path = $env{'form.archive_content_'.$i};
14795: if ($path =~ /^\Q$pathtocheck\E/) {
14796: if ($env{'form.archive_'.$i} eq 'discard') {
14797: if ($prefix ne '' && $path ne '') {
14798: if (-e $prefix.$path) {
1.1066 raeburn 14799: if ((@archdirs > 0) &&
14800: (grep(/^\Q$i\E$/,@archdirs))) {
14801: $todeletedir{$prefix.$path} = 1;
14802: } else {
14803: $todelete{$prefix.$path} = 1;
14804: }
1.1055 raeburn 14805: }
14806: }
14807: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14808: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14809: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14810: $docstitle = $env{'form.archive_title_'.$i};
14811: if ($docstitle eq '') {
14812: $docstitle = $title;
14813: }
1.1055 raeburn 14814: $outer = 0;
1.1056 raeburn 14815: if (ref($dirorder{$i}) eq 'ARRAY') {
14816: if (@{$dirorder{$i}} > 0) {
14817: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14818: if ($env{'form.archive_'.$item} eq 'display') {
14819: $outer = $item;
14820: last;
14821: }
14822: }
14823: }
14824: }
14825: my ($errtext,$fatal) =
14826: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14827: '/'.$folders{$outer}.'.'.
14828: $containers{$outer});
14829: next if ($fatal);
14830: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14831: if ($context eq 'coursedocs') {
1.1056 raeburn 14832: $mapinner{$i} = time;
1.1055 raeburn 14833: $folders{$i} = 'default_'.$mapinner{$i};
14834: $containers{$i} = 'sequence';
14835: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14836: $folders{$i}.'.'.$containers{$i};
14837: my $newidx = &LONCAPA::map::getresidx();
14838: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14839: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14840: push(@LONCAPA::map::order,$newidx);
14841: my ($outtext,$errtext) =
14842: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14843: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14844: '.'.$containers{$outer},1,1);
1.1056 raeburn 14845: $newseqid{$i} = $newidx;
1.1067 raeburn 14846: unless ($errtext) {
1.1294 raeburn 14847: $result .= '<li>'.&mt('Folder: [_1] added to course',
14848: &HTML::Entities::encode($docstitle,'<>&"')).
14849: '</li>'."\n";
1.1067 raeburn 14850: }
1.1055 raeburn 14851: }
14852: } else {
14853: if ($context eq 'coursedocs') {
14854: my $newidx=&LONCAPA::map::getresidx();
14855: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14856: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14857: $title;
1.1392 raeburn 14858: if (($outer !~ /\D/) &&
14859: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14860: ($newidx !~ /\D/)) {
1.1294 raeburn 14861: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14862: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14863: }
14864: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14865: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14866: }
14867: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14868: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14869: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14870: unless ($ishome) {
14871: my $fetch = "$newdest{$i}/$title";
14872: $fetch =~ s/^\Q$prefix$dir\E//;
14873: $prompttofetch{$fetch} = 1;
14874: }
1.1292 raeburn 14875: }
1.1067 raeburn 14876: }
1.1294 raeburn 14877: $LONCAPA::map::resources[$newidx]=
14878: $docstitle.':'.$url.':false:normal:res';
14879: push(@LONCAPA::map::order, $newidx);
14880: my ($outtext,$errtext)=
14881: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14882: $docuname.'/'.$folders{$outer}.
14883: '.'.$containers{$outer},1,1);
14884: unless ($errtext) {
14885: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14886: $result .= '<li>'.&mt('File: [_1] added to course',
14887: &HTML::Entities::encode($docstitle,'<>&"')).
14888: '</li>'."\n";
14889: }
1.1067 raeburn 14890: }
1.1294 raeburn 14891: } else {
14892: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14893: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14894: }
1.1055 raeburn 14895: }
14896: }
1.1086 raeburn 14897: }
14898: } else {
1.1294 raeburn 14899: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14900: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14901: }
14902: }
14903: for (my $i=1; $i<=$numitems; $i++) {
14904: next unless ($env{'form.archive_'.$i} eq 'dependency');
14905: my $path = $env{'form.archive_content_'.$i};
14906: if ($path =~ /^\Q$pathtocheck\E/) {
14907: my ($title) = ($path =~ m{/([^/]+)$});
14908: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14909: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14910: if (ref($dirorder{$i}) eq 'ARRAY') {
14911: my ($itemidx,$fullpath,$relpath);
14912: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14913: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14914: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14915: if ($dirorder{$i}->[$j] eq $container) {
14916: $itemidx = $j;
1.1056 raeburn 14917: }
14918: }
1.1086 raeburn 14919: }
14920: if ($itemidx eq '') {
14921: $itemidx = 0;
14922: }
14923: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14924: if ($mapinner{$referrer{$i}}) {
14925: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14926: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14927: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14928: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14929: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14930: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14931: if (!-e $fullpath) {
14932: mkdir($fullpath,0755);
1.1056 raeburn 14933: }
14934: }
1.1086 raeburn 14935: } else {
14936: last;
1.1056 raeburn 14937: }
1.1086 raeburn 14938: }
14939: }
14940: } elsif ($newdest{$referrer{$i}}) {
14941: $fullpath = $newdest{$referrer{$i}};
14942: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14943: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14944: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14945: last;
14946: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14947: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14948: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14949: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14950: if (!-e $fullpath) {
14951: mkdir($fullpath,0755);
1.1056 raeburn 14952: }
14953: }
1.1086 raeburn 14954: } else {
14955: last;
1.1056 raeburn 14956: }
1.1055 raeburn 14957: }
14958: }
1.1086 raeburn 14959: if ($fullpath ne '') {
14960: if (-e "$prefix$path") {
1.1292 raeburn 14961: unless (rename("$prefix$path","$fullpath/$title")) {
14962: $warning .= &mt('Failed to rename dependency').'<br />';
14963: }
1.1086 raeburn 14964: }
14965: if (-e "$fullpath/$title") {
14966: my $showpath;
14967: if ($relpath ne '') {
14968: $showpath = "$relpath/$title";
14969: } else {
14970: $showpath = "/$title";
14971: }
1.1294 raeburn 14972: $result .= '<li>'.&mt('[_1] included as a dependency',
14973: &HTML::Entities::encode($showpath,'<>&"')).
14974: '</li>'."\n";
1.1292 raeburn 14975: unless ($ishome) {
14976: my $fetch = "$fullpath/$title";
14977: $fetch =~ s/^\Q$prefix$dir\E//;
14978: $prompttofetch{$fetch} = 1;
14979: }
1.1086 raeburn 14980: }
14981: }
1.1055 raeburn 14982: }
1.1086 raeburn 14983: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
14984: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 14985: &HTML::Entities::encode($path,'<>&"'),
14986: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
14987: '<br />';
1.1055 raeburn 14988: }
14989: } else {
1.1294 raeburn 14990: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 14991: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 14992: }
14993: }
14994: if (keys(%todelete)) {
14995: foreach my $key (keys(%todelete)) {
14996: unlink($key);
1.1066 raeburn 14997: }
14998: }
14999: if (keys(%todeletedir)) {
15000: foreach my $key (keys(%todeletedir)) {
15001: rmdir($key);
15002: }
15003: }
15004: foreach my $dir (sort(keys(%is_dir))) {
15005: if (($pathtocheck ne '') && ($dir ne '')) {
15006: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15007: }
15008: }
1.1067 raeburn 15009: if ($result ne '') {
15010: $output .= '<ul>'."\n".
15011: $result."\n".
15012: '</ul>';
15013: }
15014: unless ($ishome) {
15015: my $replicationfail;
15016: foreach my $item (keys(%prompttofetch)) {
15017: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15018: unless ($fetchresult eq 'ok') {
15019: $replicationfail .= '<li>'.$item.'</li>'."\n";
15020: }
15021: }
15022: if ($replicationfail) {
15023: $output .= '<p class="LC_error">'.
15024: &mt('Course home server failed to retrieve:').'<ul>'.
15025: $replicationfail.
15026: '</ul></p>';
15027: }
15028: }
1.1055 raeburn 15029: } else {
15030: $warning = &mt('No items found in archive.');
15031: }
15032: if ($error) {
15033: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15034: $error.'</p>'."\n";
15035: }
15036: if ($warning) {
15037: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15038: }
15039: return $output;
15040: }
15041:
1.1066 raeburn 15042: sub cleanup_empty_dirs {
15043: my ($path) = @_;
15044: if (($path ne '') && (-d $path)) {
15045: if (opendir(my $dirh,$path)) {
15046: my @dircontents = grep(!/^\./,readdir($dirh));
15047: my $numitems = 0;
15048: foreach my $item (@dircontents) {
15049: if (-d "$path/$item") {
1.1111 raeburn 15050: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15051: if (-e "$path/$item") {
15052: $numitems ++;
15053: }
15054: } else {
15055: $numitems ++;
15056: }
15057: }
15058: if ($numitems == 0) {
15059: rmdir($path);
15060: }
15061: closedir($dirh);
15062: }
15063: }
15064: return;
15065: }
15066:
1.41 ng 15067: =pod
1.45 matthew 15068:
1.1162 raeburn 15069: =item * &get_folder_hierarchy()
1.1068 raeburn 15070:
15071: Provides hierarchy of names of folders/sub-folders containing the current
15072: item,
15073:
15074: Inputs: 3
15075: - $navmap - navmaps object
15076:
15077: - $map - url for map (either the trigger itself, or map containing
15078: the resource, which is the trigger).
15079:
15080: - $showitem - 1 => show title for map itself; 0 => do not show.
15081:
15082: Outputs: 1 @pathitems - array of folder/subfolder names.
15083:
15084: =cut
15085:
15086: sub get_folder_hierarchy {
15087: my ($navmap,$map,$showitem) = @_;
15088: my @pathitems;
15089: if (ref($navmap)) {
15090: my $mapres = $navmap->getResourceByUrl($map);
15091: if (ref($mapres)) {
15092: my $pcslist = $mapres->map_hierarchy();
15093: if ($pcslist ne '') {
15094: my @pcs = split(/,/,$pcslist);
15095: foreach my $pc (@pcs) {
15096: if ($pc == 1) {
1.1129 raeburn 15097: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15098: } else {
15099: my $res = $navmap->getByMapPc($pc);
15100: if (ref($res)) {
15101: my $title = $res->compTitle();
15102: $title =~ s/\W+/_/g;
15103: if ($title ne '') {
15104: push(@pathitems,$title);
15105: }
15106: }
15107: }
15108: }
15109: }
1.1071 raeburn 15110: if ($showitem) {
15111: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15112: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15113: } else {
15114: my $maptitle = $mapres->compTitle();
15115: $maptitle =~ s/\W+/_/g;
15116: if ($maptitle ne '') {
15117: push(@pathitems,$maptitle);
15118: }
1.1068 raeburn 15119: }
15120: }
15121: }
15122: }
15123: return @pathitems;
15124: }
15125:
15126: =pod
15127:
1.1015 raeburn 15128: =item * &get_turnedin_filepath()
15129:
15130: Determines path in a user's portfolio file for storage of files uploaded
15131: to a specific essayresponse or dropbox item.
15132:
15133: Inputs: 3 required + 1 optional.
15134: $symb is symb for resource, $uname and $udom are for current user (required).
15135: $caller is optional (can be "submission", if routine is called when storing
15136: an upoaded file when "Submit Answer" button was pressed).
15137:
15138: Returns array containing $path and $multiresp.
15139: $path is path in portfolio. $multiresp is 1 if this resource contains more
15140: than one file upload item. Callers of routine should append partid as a
15141: subdirectory to $path in cases where $multiresp is 1.
15142:
15143: Called by: homework/essayresponse.pm and homework/structuretags.pm
15144:
15145: =cut
15146:
15147: sub get_turnedin_filepath {
15148: my ($symb,$uname,$udom,$caller) = @_;
15149: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15150: my $turnindir;
15151: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15152: $turnindir = $userhash{'turnindir'};
15153: my ($path,$multiresp);
15154: if ($turnindir eq '') {
15155: if ($caller eq 'submission') {
15156: $turnindir = &mt('turned in');
15157: $turnindir =~ s/\W+/_/g;
15158: my %newhash = (
15159: 'turnindir' => $turnindir,
15160: );
15161: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15162: }
15163: }
15164: if ($turnindir ne '') {
15165: $path = '/'.$turnindir.'/';
15166: my ($multipart,$turnin,@pathitems);
15167: my $navmap = Apache::lonnavmaps::navmap->new();
15168: if (defined($navmap)) {
15169: my $mapres = $navmap->getResourceByUrl($map);
15170: if (ref($mapres)) {
15171: my $pcslist = $mapres->map_hierarchy();
15172: if ($pcslist ne '') {
15173: foreach my $pc (split(/,/,$pcslist)) {
15174: my $res = $navmap->getByMapPc($pc);
15175: if (ref($res)) {
15176: my $title = $res->compTitle();
15177: $title =~ s/\W+/_/g;
15178: if ($title ne '') {
1.1149 raeburn 15179: if (($pc > 1) && (length($title) > 12)) {
15180: $title = substr($title,0,12);
15181: }
1.1015 raeburn 15182: push(@pathitems,$title);
15183: }
15184: }
15185: }
15186: }
15187: my $maptitle = $mapres->compTitle();
15188: $maptitle =~ s/\W+/_/g;
15189: if ($maptitle ne '') {
1.1149 raeburn 15190: if (length($maptitle) > 12) {
15191: $maptitle = substr($maptitle,0,12);
15192: }
1.1015 raeburn 15193: push(@pathitems,$maptitle);
15194: }
15195: unless ($env{'request.state'} eq 'construct') {
15196: my $res = $navmap->getBySymb($symb);
15197: if (ref($res)) {
15198: my $partlist = $res->parts();
15199: my $totaluploads = 0;
15200: if (ref($partlist) eq 'ARRAY') {
15201: foreach my $part (@{$partlist}) {
15202: my @types = $res->responseType($part);
15203: my @ids = $res->responseIds($part);
15204: for (my $i=0; $i < scalar(@ids); $i++) {
15205: if ($types[$i] eq 'essay') {
15206: my $partid = $part.'_'.$ids[$i];
15207: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15208: $totaluploads ++;
15209: }
15210: }
15211: }
15212: }
15213: if ($totaluploads > 1) {
15214: $multiresp = 1;
15215: }
15216: }
15217: }
15218: }
15219: } else {
15220: return;
15221: }
15222: } else {
15223: return;
15224: }
15225: my $restitle=&Apache::lonnet::gettitle($symb);
15226: $restitle =~ s/\W+/_/g;
15227: if ($restitle eq '') {
15228: $restitle = ($resurl =~ m{/[^/]+$});
15229: if ($restitle eq '') {
15230: $restitle = time;
15231: }
15232: }
1.1149 raeburn 15233: if (length($restitle) > 12) {
15234: $restitle = substr($restitle,0,12);
15235: }
1.1015 raeburn 15236: push(@pathitems,$restitle);
15237: $path .= join('/',@pathitems);
15238: }
15239: return ($path,$multiresp);
15240: }
15241:
15242: =pod
15243:
1.464 albertel 15244: =back
1.41 ng 15245:
1.112 bowersj2 15246: =head1 CSV Upload/Handling functions
1.38 albertel 15247:
1.41 ng 15248: =over 4
15249:
1.648 raeburn 15250: =item * &upfile_store($r)
1.41 ng 15251:
15252: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15253: needs $env{'form.upfile'}
1.41 ng 15254: returns $datatoken to be put into hidden field
15255:
15256: =cut
1.31 albertel 15257:
15258: sub upfile_store {
15259: my $r=shift;
1.258 albertel 15260: $env{'form.upfile'}=~s/\r/\n/gs;
15261: $env{'form.upfile'}=~s/\f/\n/gs;
15262: $env{'form.upfile'}=~s/\n+/\n/gs;
15263: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15264:
1.1299 raeburn 15265: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15266: '_enroll_'.$env{'request.course.id'}.'_'.
15267: time.'_'.$$);
15268: return if ($datatoken eq '');
15269:
1.31 albertel 15270: {
1.158 raeburn 15271: my $datafile = $r->dir_config('lonDaemons').
15272: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15273: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15274: print $fh $env{'form.upfile'};
1.158 raeburn 15275: close($fh);
15276: }
1.31 albertel 15277: }
15278: return $datatoken;
15279: }
15280:
1.56 matthew 15281: =pod
15282:
1.1290 raeburn 15283: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15284:
15285: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15286: $datatoken is the name to assign to the temporary file.
1.258 albertel 15287: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15288:
15289: =cut
1.31 albertel 15290:
15291: sub load_tmp_file {
1.1290 raeburn 15292: my ($r,$datatoken) = @_;
15293: return if ($datatoken eq '');
1.31 albertel 15294: my @studentdata=();
15295: {
1.158 raeburn 15296: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15297: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15298: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15299: @studentdata=<$fh>;
15300: close($fh);
15301: }
1.31 albertel 15302: }
1.258 albertel 15303: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15304: }
15305:
1.1290 raeburn 15306: sub valid_datatoken {
15307: my ($datatoken) = @_;
1.1325 raeburn 15308: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15309: return $datatoken;
15310: }
15311: return;
15312: }
15313:
1.56 matthew 15314: =pod
15315:
1.648 raeburn 15316: =item * &upfile_record_sep()
1.41 ng 15317:
15318: Separate uploaded file into records
15319: returns array of records,
1.258 albertel 15320: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15321:
15322: =cut
1.31 albertel 15323:
15324: sub upfile_record_sep {
1.258 albertel 15325: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15326: } else {
1.248 albertel 15327: my @records;
1.258 albertel 15328: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15329: if ($line=~/^\s*$/) { next; }
15330: push(@records,$line);
15331: }
15332: return @records;
1.31 albertel 15333: }
15334: }
15335:
1.56 matthew 15336: =pod
15337:
1.648 raeburn 15338: =item * &record_sep($record)
1.41 ng 15339:
1.258 albertel 15340: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15341:
15342: =cut
15343:
1.263 www 15344: sub takeleft {
15345: my $index=shift;
15346: return substr('0000'.$index,-4,4);
15347: }
15348:
1.31 albertel 15349: sub record_sep {
15350: my $record=shift;
15351: my %components=();
1.258 albertel 15352: if ($env{'form.upfiletype'} eq 'xml') {
15353: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15354: my $i=0;
1.356 albertel 15355: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15356: $field=~s/^(\"|\')//;
15357: $field=~s/(\"|\')$//;
1.263 www 15358: $components{&takeleft($i)}=$field;
1.31 albertel 15359: $i++;
15360: }
1.258 albertel 15361: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15362: my $i=0;
1.356 albertel 15363: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15364: $field=~s/^(\"|\')//;
15365: $field=~s/(\"|\')$//;
1.263 www 15366: $components{&takeleft($i)}=$field;
1.31 albertel 15367: $i++;
15368: }
15369: } else {
1.561 www 15370: my $separator=',';
1.480 banghart 15371: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15372: $separator=';';
1.480 banghart 15373: }
1.31 albertel 15374: my $i=0;
1.561 www 15375: # the character we are looking for to indicate the end of a quote or a record
15376: my $looking_for=$separator;
15377: # do not add the characters to the fields
15378: my $ignore=0;
15379: # we just encountered a separator (or the beginning of the record)
15380: my $just_found_separator=1;
15381: # store the field we are working on here
15382: my $field='';
15383: # work our way through all characters in record
15384: foreach my $character ($record=~/(.)/g) {
15385: if ($character eq $looking_for) {
15386: if ($character ne $separator) {
15387: # Found the end of a quote, again looking for separator
15388: $looking_for=$separator;
15389: $ignore=1;
15390: } else {
15391: # Found a separator, store away what we got
15392: $components{&takeleft($i)}=$field;
15393: $i++;
15394: $just_found_separator=1;
15395: $ignore=0;
15396: $field='';
15397: }
15398: next;
15399: }
15400: # single or double quotation marks after a separator indicate beginning of a quote
15401: # we are now looking for the end of the quote and need to ignore separators
15402: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15403: $looking_for=$character;
15404: next;
15405: }
15406: # ignore would be true after we reached the end of a quote
15407: if ($ignore) { next; }
15408: if (($just_found_separator) && ($character=~/\s/)) { next; }
15409: $field.=$character;
15410: $just_found_separator=0;
1.31 albertel 15411: }
1.561 www 15412: # catch the very last entry, since we never encountered the separator
15413: $components{&takeleft($i)}=$field;
1.31 albertel 15414: }
15415: return %components;
15416: }
15417:
1.144 matthew 15418: ######################################################
15419: ######################################################
15420:
1.56 matthew 15421: =pod
15422:
1.648 raeburn 15423: =item * &upfile_select_html()
1.41 ng 15424:
1.144 matthew 15425: Return HTML code to select a file from the users machine and specify
15426: the file type.
1.41 ng 15427:
15428: =cut
15429:
1.144 matthew 15430: ######################################################
15431: ######################################################
1.31 albertel 15432: sub upfile_select_html {
1.144 matthew 15433: my %Types = (
15434: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15435: semisv => &mt('Semicolon separated values'),
1.144 matthew 15436: space => &mt('Space separated'),
15437: tab => &mt('Tabulator separated'),
15438: # xml => &mt('HTML/XML'),
15439: );
15440: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15441: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15442: foreach my $type (sort(keys(%Types))) {
15443: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15444: }
15445: $Str .= "</select>\n";
15446: return $Str;
1.31 albertel 15447: }
15448:
1.301 albertel 15449: sub get_samples {
15450: my ($records,$toget) = @_;
15451: my @samples=({});
15452: my $got=0;
15453: foreach my $rec (@$records) {
15454: my %temp = &record_sep($rec);
15455: if (! grep(/\S/, values(%temp))) { next; }
15456: if (%temp) {
15457: $samples[$got]=\%temp;
15458: $got++;
15459: if ($got == $toget) { last; }
15460: }
15461: }
15462: return \@samples;
15463: }
15464:
1.144 matthew 15465: ######################################################
15466: ######################################################
15467:
1.56 matthew 15468: =pod
15469:
1.648 raeburn 15470: =item * &csv_print_samples($r,$records)
1.41 ng 15471:
15472: Prints a table of sample values from each column uploaded $r is an
15473: Apache Request ref, $records is an arrayref from
15474: &Apache::loncommon::upfile_record_sep
15475:
15476: =cut
15477:
1.144 matthew 15478: ######################################################
15479: ######################################################
1.31 albertel 15480: sub csv_print_samples {
15481: my ($r,$records) = @_;
1.662 bisitz 15482: my $samples = &get_samples($records,5);
1.301 albertel 15483:
1.594 raeburn 15484: $r->print(&mt('Samples').'<br />'.&start_data_table().
15485: &start_data_table_header_row());
1.356 albertel 15486: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15487: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15488: $r->print(&end_data_table_header_row());
1.301 albertel 15489: foreach my $hash (@$samples) {
1.594 raeburn 15490: $r->print(&start_data_table_row());
1.356 albertel 15491: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15492: $r->print('<td>');
1.356 albertel 15493: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15494: $r->print('</td>');
15495: }
1.594 raeburn 15496: $r->print(&end_data_table_row());
1.31 albertel 15497: }
1.594 raeburn 15498: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15499: }
15500:
1.144 matthew 15501: ######################################################
15502: ######################################################
15503:
1.56 matthew 15504: =pod
15505:
1.648 raeburn 15506: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15507:
15508: Prints a table to create associations between values and table columns.
1.144 matthew 15509:
1.41 ng 15510: $r is an Apache Request ref,
15511: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15512: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15513:
15514: =cut
15515:
1.144 matthew 15516: ######################################################
15517: ######################################################
1.31 albertel 15518: sub csv_print_select_table {
15519: my ($r,$records,$d) = @_;
1.301 albertel 15520: my $i=0;
15521: my $samples = &get_samples($records,1);
1.144 matthew 15522: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15523: &start_data_table().&start_data_table_header_row().
1.144 matthew 15524: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15525: '<th>'.&mt('Column').'</th>'.
15526: &end_data_table_header_row()."\n");
1.356 albertel 15527: foreach my $array_ref (@$d) {
15528: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15529: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15530:
1.875 bisitz 15531: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15532: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15533: $r->print('<option value="none"></option>');
1.356 albertel 15534: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15535: $r->print('<option value="'.$sample.'"'.
15536: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15537: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15538: }
1.594 raeburn 15539: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15540: $i++;
15541: }
1.594 raeburn 15542: $r->print(&end_data_table());
1.31 albertel 15543: $i--;
15544: return $i;
15545: }
1.56 matthew 15546:
1.144 matthew 15547: ######################################################
15548: ######################################################
15549:
1.56 matthew 15550: =pod
1.31 albertel 15551:
1.648 raeburn 15552: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15553:
15554: Prints a table of sample values from the upload and can make associate samples to internal names.
15555:
15556: $r is an Apache Request ref,
15557: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15558: $d is an array of 2 element arrays (internal name, displayed name)
15559:
15560: =cut
15561:
1.144 matthew 15562: ######################################################
15563: ######################################################
1.31 albertel 15564: sub csv_samples_select_table {
15565: my ($r,$records,$d) = @_;
15566: my $i=0;
1.144 matthew 15567: #
1.662 bisitz 15568: my $max_samples = 5;
15569: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15570: $r->print(&start_data_table().
15571: &start_data_table_header_row().'<th>'.
15572: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15573: &end_data_table_header_row());
1.301 albertel 15574:
15575: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15576: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15577: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15578: foreach my $option (@$d) {
15579: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15580: $r->print('<option value="'.$value.'"'.
1.253 albertel 15581: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15582: $display.'</option>');
1.31 albertel 15583: }
15584: $r->print('</select></td><td>');
1.662 bisitz 15585: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15586: if (defined($samples->[$line]{$key})) {
15587: $r->print($samples->[$line]{$key}."<br />\n");
15588: }
15589: }
1.594 raeburn 15590: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15591: $i++;
15592: }
1.594 raeburn 15593: $r->print(&end_data_table());
1.31 albertel 15594: $i--;
15595: return($i);
1.115 matthew 15596: }
15597:
1.144 matthew 15598: ######################################################
15599: ######################################################
15600:
1.115 matthew 15601: =pod
15602:
1.648 raeburn 15603: =item * &clean_excel_name($name)
1.115 matthew 15604:
15605: Returns a replacement for $name which does not contain any illegal characters.
15606:
15607: =cut
15608:
1.144 matthew 15609: ######################################################
15610: ######################################################
1.115 matthew 15611: sub clean_excel_name {
15612: my ($name) = @_;
15613: $name =~ s/[:\*\?\/\\]//g;
15614: if (length($name) > 31) {
15615: $name = substr($name,0,31);
15616: }
15617: return $name;
1.25 albertel 15618: }
1.84 albertel 15619:
1.85 albertel 15620: =pod
15621:
1.648 raeburn 15622: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15623:
15624: Returns either 1 or undef
15625:
15626: 1 if the part is to be hidden, undef if it is to be shown
15627:
15628: Arguments are:
15629:
15630: $id the id of the part to be checked
15631: $symb, optional the symb of the resource to check
15632: $udom, optional the domain of the user to check for
15633: $uname, optional the username of the user to check for
15634:
15635: =cut
1.84 albertel 15636:
15637: sub check_if_partid_hidden {
15638: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15639: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15640: $symb,$udom,$uname);
1.141 albertel 15641: my $truth=1;
15642: #if the string starts with !, then the list is the list to show not hide
15643: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15644: my @hiddenlist=split(/,/,$hiddenparts);
15645: foreach my $checkid (@hiddenlist) {
1.141 albertel 15646: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15647: }
1.141 albertel 15648: return !$truth;
1.84 albertel 15649: }
1.127 matthew 15650:
1.138 matthew 15651:
15652: ############################################################
15653: ############################################################
15654:
15655: =pod
15656:
1.157 matthew 15657: =back
15658:
1.138 matthew 15659: =head1 cgi-bin script and graphing routines
15660:
1.157 matthew 15661: =over 4
15662:
1.648 raeburn 15663: =item * &get_cgi_id()
1.138 matthew 15664:
15665: Inputs: none
15666:
15667: Returns an id which can be used to pass environment variables
15668: to various cgi-bin scripts. These environment variables will
15669: be removed from the users environment after a given time by
15670: the routine &Apache::lonnet::transfer_profile_to_env.
15671:
15672: =cut
15673:
15674: ############################################################
15675: ############################################################
1.152 albertel 15676: my $uniq=0;
1.136 matthew 15677: sub get_cgi_id {
1.154 albertel 15678: $uniq=($uniq+1)%100000;
1.280 albertel 15679: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15680: }
15681:
1.127 matthew 15682: ############################################################
15683: ############################################################
15684:
15685: =pod
15686:
1.648 raeburn 15687: =item * &DrawBarGraph()
1.127 matthew 15688:
1.138 matthew 15689: Facilitates the plotting of data in a (stacked) bar graph.
15690: Puts plot definition data into the users environment in order for
15691: graph.png to plot it. Returns an <img> tag for the plot.
15692: The bars on the plot are labeled '1','2',...,'n'.
15693:
15694: Inputs:
15695:
15696: =over 4
15697:
15698: =item $Title: string, the title of the plot
15699:
15700: =item $xlabel: string, text describing the X-axis of the plot
15701:
15702: =item $ylabel: string, text describing the Y-axis of the plot
15703:
15704: =item $Max: scalar, the maximum Y value to use in the plot
15705: If $Max is < any data point, the graph will not be rendered.
15706:
1.140 matthew 15707: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15708: they are plotted. If undefined, default values will be used.
15709:
1.178 matthew 15710: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15711:
1.138 matthew 15712: =item @Values: An array of array references. Each array reference holds data
15713: to be plotted in a stacked bar chart.
15714:
1.239 matthew 15715: =item If the final element of @Values is a hash reference the key/value
15716: pairs will be added to the graph definition.
15717:
1.138 matthew 15718: =back
15719:
15720: Returns:
15721:
15722: An <img> tag which references graph.png and the appropriate identifying
15723: information for the plot.
15724:
1.127 matthew 15725: =cut
15726:
15727: ############################################################
15728: ############################################################
1.134 matthew 15729: sub DrawBarGraph {
1.178 matthew 15730: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15731: #
15732: if (! defined($colors)) {
15733: $colors = ['#33ff00',
15734: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15735: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15736: ];
15737: }
1.228 matthew 15738: my $extra_settings = {};
15739: if (ref($Values[-1]) eq 'HASH') {
15740: $extra_settings = pop(@Values);
15741: }
1.127 matthew 15742: #
1.136 matthew 15743: my $identifier = &get_cgi_id();
15744: my $id = 'cgi.'.$identifier;
1.129 matthew 15745: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15746: return '';
15747: }
1.225 matthew 15748: #
15749: my @Labels;
15750: if (defined($labels)) {
15751: @Labels = @$labels;
15752: } else {
15753: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15754: push(@Labels,$i+1);
1.225 matthew 15755: }
15756: }
15757: #
1.129 matthew 15758: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15759: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15760: my %ValuesHash;
15761: my $NumSets=1;
15762: foreach my $array (@Values) {
15763: next if (! ref($array));
1.136 matthew 15764: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15765: join(',',@$array);
1.129 matthew 15766: }
1.127 matthew 15767: #
1.136 matthew 15768: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15769: if ($NumBars < 3) {
15770: $width = 120+$NumBars*32;
1.220 matthew 15771: $xskip = 1;
1.225 matthew 15772: $bar_width = 30;
15773: } elsif ($NumBars < 5) {
15774: $width = 120+$NumBars*20;
15775: $xskip = 1;
15776: $bar_width = 20;
1.220 matthew 15777: } elsif ($NumBars < 10) {
1.136 matthew 15778: $width = 120+$NumBars*15;
15779: $xskip = 1;
15780: $bar_width = 15;
15781: } elsif ($NumBars <= 25) {
15782: $width = 120+$NumBars*11;
15783: $xskip = 5;
15784: $bar_width = 8;
15785: } elsif ($NumBars <= 50) {
15786: $width = 120+$NumBars*8;
15787: $xskip = 5;
15788: $bar_width = 4;
15789: } else {
15790: $width = 120+$NumBars*8;
15791: $xskip = 5;
15792: $bar_width = 4;
15793: }
15794: #
1.137 matthew 15795: $Max = 1 if ($Max < 1);
15796: if ( int($Max) < $Max ) {
15797: $Max++;
15798: $Max = int($Max);
15799: }
1.127 matthew 15800: $Title = '' if (! defined($Title));
15801: $xlabel = '' if (! defined($xlabel));
15802: $ylabel = '' if (! defined($ylabel));
1.369 www 15803: $ValuesHash{$id.'.title'} = &escape($Title);
15804: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15805: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15806: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15807: $ValuesHash{$id.'.NumBars'} = $NumBars;
15808: $ValuesHash{$id.'.NumSets'} = $NumSets;
15809: $ValuesHash{$id.'.PlotType'} = 'bar';
15810: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15811: $ValuesHash{$id.'.height'} = $height;
15812: $ValuesHash{$id.'.width'} = $width;
15813: $ValuesHash{$id.'.xskip'} = $xskip;
15814: $ValuesHash{$id.'.bar_width'} = $bar_width;
15815: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15816: #
1.228 matthew 15817: # Deal with other parameters
15818: while (my ($key,$value) = each(%$extra_settings)) {
15819: $ValuesHash{$id.'.'.$key} = $value;
15820: }
15821: #
1.646 raeburn 15822: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15823: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15824: }
15825:
15826: ############################################################
15827: ############################################################
15828:
15829: =pod
15830:
1.648 raeburn 15831: =item * &DrawXYGraph()
1.137 matthew 15832:
1.138 matthew 15833: Facilitates the plotting of data in an XY graph.
15834: Puts plot definition data into the users environment in order for
15835: graph.png to plot it. Returns an <img> tag for the plot.
15836:
15837: Inputs:
15838:
15839: =over 4
15840:
15841: =item $Title: string, the title of the plot
15842:
15843: =item $xlabel: string, text describing the X-axis of the plot
15844:
15845: =item $ylabel: string, text describing the Y-axis of the plot
15846:
15847: =item $Max: scalar, the maximum Y value to use in the plot
15848: If $Max is < any data point, the graph will not be rendered.
15849:
15850: =item $colors: Array ref containing the hex color codes for the data to be
15851: plotted in. If undefined, default values will be used.
15852:
15853: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15854:
15855: =item $Ydata: Array ref containing Array refs.
1.185 www 15856: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15857:
15858: =item %Values: hash indicating or overriding any default values which are
15859: passed to graph.png.
15860: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15861:
15862: =back
15863:
15864: Returns:
15865:
15866: An <img> tag which references graph.png and the appropriate identifying
15867: information for the plot.
15868:
1.137 matthew 15869: =cut
15870:
15871: ############################################################
15872: ############################################################
15873: sub DrawXYGraph {
15874: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15875: #
15876: # Create the identifier for the graph
15877: my $identifier = &get_cgi_id();
15878: my $id = 'cgi.'.$identifier;
15879: #
15880: $Title = '' if (! defined($Title));
15881: $xlabel = '' if (! defined($xlabel));
15882: $ylabel = '' if (! defined($ylabel));
15883: my %ValuesHash =
15884: (
1.369 www 15885: $id.'.title' => &escape($Title),
15886: $id.'.xlabel' => &escape($xlabel),
15887: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15888: $id.'.y_max_value'=> $Max,
15889: $id.'.labels' => join(',',@$Xlabels),
15890: $id.'.PlotType' => 'XY',
15891: );
15892: #
15893: if (defined($colors) && ref($colors) eq 'ARRAY') {
15894: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15895: }
15896: #
15897: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15898: return '';
15899: }
15900: my $NumSets=1;
1.138 matthew 15901: foreach my $array (@{$Ydata}){
1.137 matthew 15902: next if (! ref($array));
15903: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15904: }
1.138 matthew 15905: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15906: #
15907: # Deal with other parameters
15908: while (my ($key,$value) = each(%Values)) {
15909: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15910: }
15911: #
1.646 raeburn 15912: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15913: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15914: }
15915:
15916: ############################################################
15917: ############################################################
15918:
15919: =pod
15920:
1.648 raeburn 15921: =item * &DrawXYYGraph()
1.138 matthew 15922:
15923: Facilitates the plotting of data in an XY graph with two Y axes.
15924: Puts plot definition data into the users environment in order for
15925: graph.png to plot it. Returns an <img> tag for the plot.
15926:
15927: Inputs:
15928:
15929: =over 4
15930:
15931: =item $Title: string, the title of the plot
15932:
15933: =item $xlabel: string, text describing the X-axis of the plot
15934:
15935: =item $ylabel: string, text describing the Y-axis of the plot
15936:
15937: =item $colors: Array ref containing the hex color codes for the data to be
15938: plotted in. If undefined, default values will be used.
15939:
15940: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15941:
15942: =item $Ydata1: The first data set
15943:
15944: =item $Min1: The minimum value of the left Y-axis
15945:
15946: =item $Max1: The maximum value of the left Y-axis
15947:
15948: =item $Ydata2: The second data set
15949:
15950: =item $Min2: The minimum value of the right Y-axis
15951:
15952: =item $Max2: The maximum value of the left Y-axis
15953:
15954: =item %Values: hash indicating or overriding any default values which are
15955: passed to graph.png.
15956: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15957:
15958: =back
15959:
15960: Returns:
15961:
15962: An <img> tag which references graph.png and the appropriate identifying
15963: information for the plot.
1.136 matthew 15964:
15965: =cut
15966:
15967: ############################################################
15968: ############################################################
1.137 matthew 15969: sub DrawXYYGraph {
15970: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15971: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15972: #
15973: # Create the identifier for the graph
15974: my $identifier = &get_cgi_id();
15975: my $id = 'cgi.'.$identifier;
15976: #
15977: $Title = '' if (! defined($Title));
15978: $xlabel = '' if (! defined($xlabel));
15979: $ylabel = '' if (! defined($ylabel));
15980: my %ValuesHash =
15981: (
1.369 www 15982: $id.'.title' => &escape($Title),
15983: $id.'.xlabel' => &escape($xlabel),
15984: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 15985: $id.'.labels' => join(',',@$Xlabels),
15986: $id.'.PlotType' => 'XY',
15987: $id.'.NumSets' => 2,
1.137 matthew 15988: $id.'.two_axes' => 1,
15989: $id.'.y1_max_value' => $Max1,
15990: $id.'.y1_min_value' => $Min1,
15991: $id.'.y2_max_value' => $Max2,
15992: $id.'.y2_min_value' => $Min2,
1.136 matthew 15993: );
15994: #
1.137 matthew 15995: if (defined($colors) && ref($colors) eq 'ARRAY') {
15996: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15997: }
15998: #
15999: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16000: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16001: return '';
16002: }
16003: my $NumSets=1;
1.137 matthew 16004: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16005: next if (! ref($array));
16006: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16007: }
16008: #
16009: # Deal with other parameters
16010: while (my ($key,$value) = each(%Values)) {
16011: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16012: }
16013: #
1.646 raeburn 16014: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16015: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16016: }
16017:
16018: ############################################################
16019: ############################################################
16020:
16021: =pod
16022:
1.157 matthew 16023: =back
16024:
1.139 matthew 16025: =head1 Statistics helper routines?
16026:
16027: Bad place for them but what the hell.
16028:
1.157 matthew 16029: =over 4
16030:
1.648 raeburn 16031: =item * &chartlink()
1.139 matthew 16032:
16033: Returns a link to the chart for a specific student.
16034:
16035: Inputs:
16036:
16037: =over 4
16038:
16039: =item $linktext: The text of the link
16040:
16041: =item $sname: The students username
16042:
16043: =item $sdomain: The students domain
16044:
16045: =back
16046:
1.157 matthew 16047: =back
16048:
1.139 matthew 16049: =cut
16050:
16051: ############################################################
16052: ############################################################
16053: sub chartlink {
16054: my ($linktext, $sname, $sdomain) = @_;
16055: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16056: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16057: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16058: '">'.$linktext.'</a>';
1.153 matthew 16059: }
16060:
16061: #######################################################
16062: #######################################################
16063:
16064: =pod
16065:
16066: =head1 Course Environment Routines
1.157 matthew 16067:
16068: =over 4
1.153 matthew 16069:
1.648 raeburn 16070: =item * &restore_course_settings()
1.153 matthew 16071:
1.648 raeburn 16072: =item * &store_course_settings()
1.153 matthew 16073:
16074: Restores/Store indicated form parameters from the course environment.
16075: Will not overwrite existing values of the form parameters.
16076:
16077: Inputs:
16078: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16079:
16080: a hash ref describing the data to be stored. For example:
16081:
16082: %Save_Parameters = ('Status' => 'scalar',
16083: 'chartoutputmode' => 'scalar',
16084: 'chartoutputdata' => 'scalar',
16085: 'Section' => 'array',
1.373 raeburn 16086: 'Group' => 'array',
1.153 matthew 16087: 'StudentData' => 'array',
16088: 'Maps' => 'array');
16089:
16090: Returns: both routines return nothing
16091:
1.631 raeburn 16092: =back
16093:
1.153 matthew 16094: =cut
16095:
16096: #######################################################
16097: #######################################################
16098: sub store_course_settings {
1.496 albertel 16099: return &store_settings($env{'request.course.id'},@_);
16100: }
16101:
16102: sub store_settings {
1.153 matthew 16103: # save to the environment
16104: # appenv the same items, just to be safe
1.300 albertel 16105: my $udom = $env{'user.domain'};
16106: my $uname = $env{'user.name'};
1.496 albertel 16107: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16108: my %SaveHash;
16109: my %AppHash;
16110: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16111: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16112: my $envname = 'environment.'.$basename;
1.258 albertel 16113: if (exists($env{'form.'.$setting})) {
1.153 matthew 16114: # Save this value away
16115: if ($type eq 'scalar' &&
1.258 albertel 16116: (! exists($env{$envname}) ||
16117: $env{$envname} ne $env{'form.'.$setting})) {
16118: $SaveHash{$basename} = $env{'form.'.$setting};
16119: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16120: } elsif ($type eq 'array') {
16121: my $stored_form;
1.258 albertel 16122: if (ref($env{'form.'.$setting})) {
1.153 matthew 16123: $stored_form = join(',',
16124: map {
1.369 www 16125: &escape($_);
1.258 albertel 16126: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16127: } else {
16128: $stored_form =
1.369 www 16129: &escape($env{'form.'.$setting});
1.153 matthew 16130: }
16131: # Determine if the array contents are the same.
1.258 albertel 16132: if ($stored_form ne $env{$envname}) {
1.153 matthew 16133: $SaveHash{$basename} = $stored_form;
16134: $AppHash{$envname} = $stored_form;
16135: }
16136: }
16137: }
16138: }
16139: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16140: $udom,$uname);
1.153 matthew 16141: if ($put_result !~ /^(ok|delayed)/) {
16142: &Apache::lonnet::logthis('unable to save form parameters, '.
16143: 'got error:'.$put_result);
16144: }
16145: # Make sure these settings stick around in this session, too
1.646 raeburn 16146: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16147: return;
16148: }
16149:
16150: sub restore_course_settings {
1.499 albertel 16151: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16152: }
16153:
16154: sub restore_settings {
16155: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16156: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16157: next if (exists($env{'form.'.$setting}));
1.496 albertel 16158: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16159: '.'.$setting;
1.258 albertel 16160: if (exists($env{$envname})) {
1.153 matthew 16161: if ($type eq 'scalar') {
1.258 albertel 16162: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16163: } elsif ($type eq 'array') {
1.258 albertel 16164: $env{'form.'.$setting} = [
1.153 matthew 16165: map {
1.369 www 16166: &unescape($_);
1.258 albertel 16167: } split(',',$env{$envname})
1.153 matthew 16168: ];
16169: }
16170: }
16171: }
1.127 matthew 16172: }
16173:
1.618 raeburn 16174: #######################################################
16175: #######################################################
16176:
16177: =pod
16178:
16179: =head1 Domain E-mail Routines
16180:
16181: =over 4
16182:
1.648 raeburn 16183: =item * &build_recipient_list()
1.618 raeburn 16184:
1.1144 raeburn 16185: Build recipient lists for following types of e-mail:
1.766 raeburn 16186: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16187: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16188: module change checking, student/employee ID conflict checks, as
16189: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16190: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16191:
16192: Inputs:
1.619 raeburn 16193: defmail (scalar - email address of default recipient),
1.1144 raeburn 16194: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16195: requestsmail, updatesmail, or idconflictsmail).
16196:
1.619 raeburn 16197: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16198:
1.619 raeburn 16199: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16200: i.e., predates configuration by DC via domainprefs.pm
16201:
16202: $requname username of requester (if mailing type is helpdeskmail)
16203:
16204: $requdom domain of requester (if mailing type is helpdeskmail)
16205:
16206: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16207:
1.618 raeburn 16208:
1.655 raeburn 16209: Returns: comma separated list of addresses to which to send e-mail.
16210:
16211: =back
1.618 raeburn 16212:
16213: =cut
16214:
16215: ############################################################
16216: ############################################################
16217: sub build_recipient_list {
1.1297 raeburn 16218: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16219: my @recipients;
1.1270 raeburn 16220: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16221: my %domconfig =
1.1270 raeburn 16222: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16223: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16224: if (exists($domconfig{'contacts'}{$mailing})) {
16225: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16226: my @contacts = ('adminemail','supportemail');
16227: foreach my $item (@contacts) {
16228: if ($domconfig{'contacts'}{$mailing}{$item}) {
16229: my $addr = $domconfig{'contacts'}{$item};
16230: if (!grep(/^\Q$addr\E$/,@recipients)) {
16231: push(@recipients,$addr);
16232: }
1.619 raeburn 16233: }
1.1270 raeburn 16234: }
16235: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16236: if ($mailing eq 'helpdeskmail') {
16237: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16238: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16239: my @ok_bccs;
16240: foreach my $bcc (@bccs) {
16241: $bcc =~ s/^\s+//g;
16242: $bcc =~ s/\s+$//g;
16243: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16244: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16245: push(@ok_bccs,$bcc);
16246: }
16247: }
16248: }
16249: if (@ok_bccs > 0) {
16250: $allbcc = join(', ',@ok_bccs);
16251: }
16252: }
16253: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16254: }
16255: }
1.766 raeburn 16256: } elsif ($origmail ne '') {
1.1270 raeburn 16257: $lastresort = $origmail;
1.618 raeburn 16258: }
1.1297 raeburn 16259: if ($mailing eq 'helpdeskmail') {
16260: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16261: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16262: my ($inststatus,$inststatus_checked);
16263: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16264: ($env{'user.domain'} ne 'public')) {
16265: $inststatus_checked = 1;
16266: $inststatus = $env{'environment.inststatus'};
16267: }
16268: unless ($inststatus_checked) {
16269: if (($requname ne '') && ($requdom ne '')) {
16270: if (($requname =~ /^$match_username$/) &&
16271: ($requdom =~ /^$match_domain$/) &&
16272: (&Apache::lonnet::domain($requdom))) {
16273: my $requhome = &Apache::lonnet::homeserver($requname,
16274: $requdom);
16275: unless ($requhome eq 'no_host') {
16276: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16277: $inststatus = $userenv{'inststatus'};
16278: $inststatus_checked = 1;
16279: }
16280: }
16281: }
16282: }
16283: unless ($inststatus_checked) {
16284: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16285: my %srch = (srchby => 'email',
16286: srchdomain => $defdom,
16287: srchterm => $reqemail,
16288: srchtype => 'exact');
16289: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16290: foreach my $uname (keys(%srch_results)) {
16291: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16292: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16293: $inststatus_checked = 1;
16294: last;
16295: }
16296: }
16297: unless ($inststatus_checked) {
16298: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16299: if ($dirsrchres eq 'ok') {
16300: foreach my $uname (keys(%srch_results)) {
16301: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16302: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16303: $inststatus_checked = 1;
16304: last;
16305: }
16306: }
16307: }
16308: }
16309: }
16310: }
16311: if ($inststatus ne '') {
16312: foreach my $status (split(/\:/,$inststatus)) {
16313: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16314: my @contacts = ('adminemail','supportemail');
16315: foreach my $item (@contacts) {
16316: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16317: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16318: if (!grep(/^\Q$addr\E$/,@recipients)) {
16319: push(@recipients,$addr);
16320: }
16321: }
16322: }
16323: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16324: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16325: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16326: my @ok_bccs;
16327: foreach my $bcc (@bccs) {
16328: $bcc =~ s/^\s+//g;
16329: $bcc =~ s/\s+$//g;
16330: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16331: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16332: push(@ok_bccs,$bcc);
16333: }
16334: }
16335: }
16336: if (@ok_bccs > 0) {
16337: $allbcc = join(', ',@ok_bccs);
16338: }
16339: }
16340: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16341: last;
16342: }
16343: }
16344: }
16345: }
16346: }
1.619 raeburn 16347: } elsif ($origmail ne '') {
1.1270 raeburn 16348: $lastresort = $origmail;
16349: }
1.1297 raeburn 16350: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16351: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16352: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16353: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16354: my %what = (
16355: perlvar => 1,
16356: );
16357: my $primary = &Apache::lonnet::domain($defdom,'primary');
16358: if ($primary) {
16359: my $gotaddr;
16360: my ($result,$returnhash) =
16361: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16362: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16363: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16364: $lastresort = $returnhash->{'lonSupportEMail'};
16365: $gotaddr = 1;
16366: }
16367: }
16368: unless ($gotaddr) {
16369: my $uintdom = &Apache::lonnet::internet_dom($primary);
16370: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16371: unless ($uintdom eq $intdom) {
16372: my %domconfig =
16373: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16374: if (ref($domconfig{'contacts'}) eq 'HASH') {
16375: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16376: my @contacts = ('adminemail','supportemail');
16377: foreach my $item (@contacts) {
16378: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16379: my $addr = $domconfig{'contacts'}{$item};
16380: if (!grep(/^\Q$addr\E$/,@recipients)) {
16381: push(@recipients,$addr);
16382: }
16383: }
16384: }
16385: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16386: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16387: }
16388: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16389: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16390: my @ok_bccs;
16391: foreach my $bcc (@bccs) {
16392: $bcc =~ s/^\s+//g;
16393: $bcc =~ s/\s+$//g;
16394: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16395: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16396: push(@ok_bccs,$bcc);
16397: }
16398: }
16399: }
16400: if (@ok_bccs > 0) {
16401: $allbcc = join(', ',@ok_bccs);
16402: }
16403: }
16404: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16405: }
16406: }
16407: }
16408: }
16409: }
16410: }
1.618 raeburn 16411: }
1.688 raeburn 16412: if (defined($defmail)) {
16413: if ($defmail ne '') {
16414: push(@recipients,$defmail);
16415: }
1.618 raeburn 16416: }
16417: if ($otheremails) {
1.619 raeburn 16418: my @others;
16419: if ($otheremails =~ /,/) {
16420: @others = split(/,/,$otheremails);
1.618 raeburn 16421: } else {
1.619 raeburn 16422: push(@others,$otheremails);
16423: }
16424: foreach my $addr (@others) {
16425: if (!grep(/^\Q$addr\E$/,@recipients)) {
16426: push(@recipients,$addr);
16427: }
1.618 raeburn 16428: }
16429: }
1.1298 raeburn 16430: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16431: if ((!@recipients) && ($lastresort ne '')) {
16432: push(@recipients,$lastresort);
16433: }
16434: } elsif ($lastresort ne '') {
16435: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16436: push(@recipients,$lastresort);
16437: }
16438: }
1.1271 raeburn 16439: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16440: if (wantarray) {
16441: return ($recipientlist,$allbcc,$addtext);
16442: } else {
16443: return $recipientlist;
16444: }
1.618 raeburn 16445: }
16446:
1.127 matthew 16447: ############################################################
16448: ############################################################
1.154 albertel 16449:
1.655 raeburn 16450: =pod
16451:
1.1224 musolffc 16452: =over 4
16453:
1.1223 musolffc 16454: =item * &mime_email()
16455:
16456: Sends an email with a possible attachment
16457:
16458: Inputs:
16459:
16460: =over 4
16461:
16462: from - Sender's email address
16463:
1.1343 raeburn 16464: replyto - Reply-To email address
16465:
1.1223 musolffc 16466: to - Email address of recipient
16467:
16468: subject - Subject of email
16469:
16470: body - Body of email
16471:
16472: cc_string - Carbon copy email address
16473:
16474: bcc - Blind carbon copy email address
16475:
16476: attachment_path - Path of file to be attached
16477:
16478: file_name - Name of file to be attached
16479:
16480: attachment_text - The body of an attachment of type "TEXT"
16481:
16482: =back
16483:
16484: =back
16485:
16486: =cut
16487:
16488: ############################################################
16489: ############################################################
16490:
16491: sub mime_email {
1.1343 raeburn 16492: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16493: $file_name,$attachment_text) = @_;
16494:
1.1223 musolffc 16495: my $msg = MIME::Lite->new(
16496: From => $from,
16497: To => $to,
16498: Subject => $subject,
16499: Type =>'TEXT',
16500: Data => $body,
16501: );
1.1343 raeburn 16502: if ($replyto ne '') {
16503: $msg->add("Reply-To" => $replyto);
16504: }
1.1223 musolffc 16505: if ($cc_string ne '') {
16506: $msg->add("Cc" => $cc_string);
16507: }
16508: if ($bcc ne '') {
16509: $msg->add("Bcc" => $bcc);
16510: }
16511: $msg->attr("content-type" => "text/plain");
16512: $msg->attr("content-type.charset" => "UTF-8");
16513: # Attach file if given
16514: if ($attachment_path) {
16515: unless ($file_name) {
16516: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16517: }
16518: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16519: $msg->attach(Type => $type,
16520: Path => $attachment_path,
16521: Filename => $file_name
16522: );
16523: # Otherwise attach text if given
16524: } elsif ($attachment_text) {
16525: $msg->attach(Type => 'TEXT',
16526: Data => $attachment_text);
16527: }
16528: # Send it
16529: $msg->send('sendmail');
16530: }
16531:
16532: ############################################################
16533: ############################################################
16534:
16535: =pod
16536:
1.655 raeburn 16537: =head1 Course Catalog Routines
16538:
16539: =over 4
16540:
16541: =item * &gather_categories()
16542:
16543: Converts category definitions - keys of categories hash stored in
16544: coursecategories in configuration.db on the primary library server in a
16545: domain - to an array. Also generates javascript and idx hash used to
16546: generate Domain Coordinator interface for editing Course Categories.
16547:
16548: Inputs:
1.663 raeburn 16549:
1.655 raeburn 16550: categories (reference to hash of category definitions).
1.663 raeburn 16551:
1.655 raeburn 16552: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16553: categories and subcategories).
1.663 raeburn 16554:
1.655 raeburn 16555: idx (reference to hash of counters used in Domain Coordinator interface for
16556: editing Course Categories).
1.663 raeburn 16557:
1.655 raeburn 16558: jsarray (reference to array of categories used to create Javascript arrays for
16559: Domain Coordinator interface for editing Course Categories).
16560:
16561: Returns: nothing
16562:
16563: Side effects: populates cats, idx and jsarray.
16564:
16565: =cut
16566:
16567: sub gather_categories {
16568: my ($categories,$cats,$idx,$jsarray) = @_;
16569: my %counters;
16570: my $num = 0;
16571: foreach my $item (keys(%{$categories})) {
16572: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16573: if ($container eq '' && $depth == 0) {
16574: $cats->[$depth][$categories->{$item}] = $cat;
16575: } else {
16576: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16577: }
16578: my ($escitem,$tail) = split(/:/,$item,2);
16579: if ($counters{$tail} eq '') {
16580: $counters{$tail} = $num;
16581: $num ++;
16582: }
16583: if (ref($idx) eq 'HASH') {
16584: $idx->{$item} = $counters{$tail};
16585: }
16586: if (ref($jsarray) eq 'ARRAY') {
16587: push(@{$jsarray->[$counters{$tail}]},$item);
16588: }
16589: }
16590: return;
16591: }
16592:
16593: =pod
16594:
16595: =item * &extract_categories()
16596:
16597: Used to generate breadcrumb trails for course categories.
16598:
16599: Inputs:
1.663 raeburn 16600:
1.655 raeburn 16601: categories (reference to hash of category definitions).
1.663 raeburn 16602:
1.655 raeburn 16603: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16604: categories and subcategories).
1.663 raeburn 16605:
1.655 raeburn 16606: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16607:
1.655 raeburn 16608: allitems (reference to hash - key is category key
16609: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16610:
1.655 raeburn 16611: idx (reference to hash of counters used in Domain Coordinator interface for
16612: editing Course Categories).
1.663 raeburn 16613:
1.655 raeburn 16614: jsarray (reference to array of categories used to create Javascript arrays for
16615: Domain Coordinator interface for editing Course Categories).
16616:
1.665 raeburn 16617: subcats (reference to hash of arrays containing all subcategories within each
16618: category, -recursive)
16619:
1.1321 raeburn 16620: maxd (reference to hash used to hold max depth for all top-level categories).
16621:
1.655 raeburn 16622: Returns: nothing
16623:
16624: Side effects: populates trails and allitems hash references.
16625:
16626: =cut
16627:
16628: sub extract_categories {
1.1321 raeburn 16629: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16630: if (ref($categories) eq 'HASH') {
16631: &gather_categories($categories,$cats,$idx,$jsarray);
16632: if (ref($cats->[0]) eq 'ARRAY') {
16633: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16634: my $name = $cats->[0][$i];
16635: my $item = &escape($name).'::0';
16636: my $trailstr;
16637: if ($name eq 'instcode') {
16638: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16639: } elsif ($name eq 'communities') {
16640: $trailstr = &mt('Communities');
1.1239 raeburn 16641: } elsif ($name eq 'placement') {
16642: $trailstr = &mt('Placement Tests');
1.655 raeburn 16643: } else {
16644: $trailstr = $name;
16645: }
16646: if ($allitems->{$item} eq '') {
16647: push(@{$trails},$trailstr);
16648: $allitems->{$item} = scalar(@{$trails})-1;
16649: }
16650: my @parents = ($name);
16651: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16652: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16653: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16654: if (ref($subcats) eq 'HASH') {
16655: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16656: }
1.1321 raeburn 16657: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16658: }
16659: } else {
16660: if (ref($subcats) eq 'HASH') {
16661: $subcats->{$item} = [];
1.655 raeburn 16662: }
1.1321 raeburn 16663: if (ref($maxd) eq 'HASH') {
16664: $maxd->{$name} = 1;
16665: }
1.655 raeburn 16666: }
16667: }
16668: }
16669: }
16670: return;
16671: }
16672:
16673: =pod
16674:
1.1162 raeburn 16675: =item * &recurse_categories()
1.655 raeburn 16676:
16677: Recursively used to generate breadcrumb trails for course categories.
16678:
16679: Inputs:
1.663 raeburn 16680:
1.655 raeburn 16681: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16682: categories and subcategories).
1.663 raeburn 16683:
1.655 raeburn 16684: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16685:
16686: category (current course category, for which breadcrumb trail is being generated).
16687:
16688: trails (reference to array of breadcrumb trails for each category).
16689:
1.655 raeburn 16690: allitems (reference to hash - key is category key
16691: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16692:
1.655 raeburn 16693: parents (array containing containers directories for current category,
16694: back to top level).
16695:
16696: Returns: nothing
16697:
16698: Side effects: populates trails and allitems hash references
16699:
16700: =cut
16701:
16702: sub recurse_categories {
1.1321 raeburn 16703: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16704: my $shallower = $depth - 1;
16705: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16706: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16707: my $name = $cats->[$depth]{$category}[$k];
16708: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16709: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16710: if ($allitems->{$item} eq '') {
16711: push(@{$trails},$trailstr);
16712: $allitems->{$item} = scalar(@{$trails})-1;
16713: }
16714: my $deeper = $depth+1;
16715: push(@{$parents},$category);
1.665 raeburn 16716: if (ref($subcats) eq 'HASH') {
16717: my $subcat = &escape($name).':'.$category.':'.$depth;
16718: for (my $j=@{$parents}; $j>=0; $j--) {
16719: my $higher;
16720: if ($j > 0) {
16721: $higher = &escape($parents->[$j]).':'.
16722: &escape($parents->[$j-1]).':'.$j;
16723: } else {
16724: $higher = &escape($parents->[$j]).'::'.$j;
16725: }
16726: push(@{$subcats->{$higher}},$subcat);
16727: }
16728: }
16729: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16730: $subcats,$maxd);
1.655 raeburn 16731: pop(@{$parents});
16732: }
16733: } else {
16734: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16735: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16736: if ($allitems->{$item} eq '') {
16737: push(@{$trails},$trailstr);
16738: $allitems->{$item} = scalar(@{$trails})-1;
16739: }
1.1321 raeburn 16740: if (ref($maxd) eq 'HASH') {
16741: if ($depth > $maxd->{$parents->[0]}) {
16742: $maxd->{$parents->[0]} = $depth;
16743: }
16744: }
1.655 raeburn 16745: }
16746: return;
16747: }
16748:
1.663 raeburn 16749: =pod
16750:
1.1162 raeburn 16751: =item * &assign_categories_table()
1.663 raeburn 16752:
16753: Create a datatable for display of hierarchical categories in a domain,
16754: with checkboxes to allow a course to be categorized.
16755:
16756: Inputs:
16757:
16758: cathash - reference to hash of categories defined for the domain (from
16759: configuration.db)
16760:
16761: currcat - scalar with an & separated list of categories assigned to a course.
16762:
1.919 raeburn 16763: type - scalar contains course type (Course or Community).
16764:
1.1260 raeburn 16765: disabled - scalar (optional) contains disabled="disabled" if input elements are
16766: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16767:
1.663 raeburn 16768: Returns: $output (markup to be displayed)
16769:
16770: =cut
16771:
16772: sub assign_categories_table {
1.1259 raeburn 16773: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16774: my $output;
16775: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16776: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16777: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16778: $maxdepth = scalar(@cats);
16779: if (@cats > 0) {
16780: my $itemcount = 0;
16781: if (ref($cats[0]) eq 'ARRAY') {
16782: my @currcategories;
16783: if ($currcat ne '') {
16784: @currcategories = split('&',$currcat);
16785: }
1.919 raeburn 16786: my $table;
1.663 raeburn 16787: for (my $i=0; $i<@{$cats[0]}; $i++) {
16788: my $parent = $cats[0][$i];
1.919 raeburn 16789: next if ($parent eq 'instcode');
16790: if ($type eq 'Community') {
16791: next unless ($parent eq 'communities');
1.1239 raeburn 16792: } elsif ($type eq 'Placement') {
16793: next unless ($parent eq 'placement');
1.919 raeburn 16794: } else {
1.1239 raeburn 16795: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16796: }
1.663 raeburn 16797: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16798: my $item = &escape($parent).'::0';
16799: my $checked = '';
16800: if (@currcategories > 0) {
16801: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16802: $checked = ' checked="checked"';
1.663 raeburn 16803: }
16804: }
1.919 raeburn 16805: my $parent_title = $parent;
16806: if ($parent eq 'communities') {
16807: $parent_title = &mt('Communities');
1.1239 raeburn 16808: } elsif ($parent eq 'placement') {
16809: $parent_title = &mt('Placement Tests');
1.919 raeburn 16810: }
16811: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16812: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16813: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16814: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16815: my $depth = 1;
16816: push(@path,$parent);
1.1259 raeburn 16817: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16818: pop(@path);
1.919 raeburn 16819: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16820: $itemcount ++;
16821: }
1.919 raeburn 16822: if ($itemcount) {
16823: $output = &Apache::loncommon::start_data_table().
16824: $table.
16825: &Apache::loncommon::end_data_table();
16826: }
1.663 raeburn 16827: }
16828: }
16829: }
16830: return $output;
16831: }
16832:
16833: =pod
16834:
1.1162 raeburn 16835: =item * &assign_category_rows()
1.663 raeburn 16836:
16837: Create a datatable row for display of nested categories in a domain,
16838: with checkboxes to allow a course to be categorized,called recursively.
16839:
16840: Inputs:
16841:
16842: itemcount - track row number for alternating colors
16843:
16844: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16845: categories and subcategories.
16846:
16847: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16848:
16849: parent - parent of current category item
16850:
16851: path - Array containing all categories back up through the hierarchy from the
16852: current category to the top level.
16853:
16854: currcategories - reference to array of current categories assigned to the course
16855:
1.1260 raeburn 16856: disabled - scalar (optional) contains disabled="disabled" if input elements are
16857: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16858:
1.663 raeburn 16859: Returns: $output (markup to be displayed).
16860:
16861: =cut
16862:
16863: sub assign_category_rows {
1.1259 raeburn 16864: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16865: my ($text,$name,$item,$chgstr);
16866: if (ref($cats) eq 'ARRAY') {
16867: my $maxdepth = scalar(@{$cats});
16868: if (ref($cats->[$depth]) eq 'HASH') {
16869: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16870: my $numchildren = @{$cats->[$depth]{$parent}};
16871: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16872: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16873: for (my $j=0; $j<$numchildren; $j++) {
16874: $name = $cats->[$depth]{$parent}[$j];
16875: $item = &escape($name).':'.&escape($parent).':'.$depth;
16876: my $deeper = $depth+1;
16877: my $checked = '';
16878: if (ref($currcategories) eq 'ARRAY') {
16879: if (@{$currcategories} > 0) {
16880: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16881: $checked = ' checked="checked"';
1.663 raeburn 16882: }
16883: }
16884: }
1.664 raeburn 16885: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16886: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16887: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16888: '<input type="hidden" name="catname" value="'.$name.'" />'.
16889: '</td><td>';
1.663 raeburn 16890: if (ref($path) eq 'ARRAY') {
16891: push(@{$path},$name);
1.1259 raeburn 16892: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16893: pop(@{$path});
16894: }
16895: $text .= '</td></tr>';
16896: }
16897: $text .= '</table></td>';
16898: }
16899: }
16900: }
16901: return $text;
16902: }
16903:
1.1181 raeburn 16904: =pod
16905:
16906: =back
16907:
16908: =cut
16909:
1.655 raeburn 16910: ############################################################
16911: ############################################################
16912:
16913:
1.443 albertel 16914: sub commit_customrole {
1.1408 raeburn 16915: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16916: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16917: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16918: $context,$othdomby,$requester);
1.630 raeburn 16919: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16920: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16921: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16922: if (wantarray) {
16923: return ($output,$result);
16924: } else {
16925: return $output;
16926: }
1.443 albertel 16927: }
16928:
16929: sub commit_standardrole {
1.1408 raeburn 16930: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16931: $othdomby,$requester) = @_;
1.1399 raeburn 16932: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16933: if ($context eq 'auto') {
16934: $linefeed = "\n";
16935: } else {
16936: $linefeed = "<br />\n";
16937: }
1.443 albertel 16938: if ($three eq 'st') {
1.1399 raeburn 16939: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16940: $one,$two,$sec,$context,$credits,$othdomby,
16941: $requester);
1.541 raeburn 16942: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16943: ($result eq 'unknown_course') || ($result eq 'refused')) {
16944: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16945: } else {
1.541 raeburn 16946: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16947: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16948: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16949: if ($context eq 'auto') {
16950: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16951: } else {
16952: $output .= '<b>'.$result.'</b>'.$linefeed.
16953: &mt('Add to classlist').': <b>ok</b>';
16954: }
16955: $output .= $linefeed;
1.443 albertel 16956: }
16957: } else {
16958: $output = &mt('Assigning').' '.$three.' in '.$url.
16959: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16960: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 16961: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
16962: '','',$context,$othdomby,$requester);
1.541 raeburn 16963: if ($context eq 'auto') {
16964: $output .= $result.$linefeed;
16965: } else {
16966: $output .= '<b>'.$result.'</b>'.$linefeed;
16967: }
1.443 albertel 16968: }
1.1399 raeburn 16969: if (wantarray) {
16970: return ($output,$result);
16971: } else {
16972: return $output;
16973: }
1.443 albertel 16974: }
16975:
16976: sub commit_studentrole {
1.1116 raeburn 16977: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 16978: $credits,$othdomby,$requester) = @_;
1.626 raeburn 16979: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 16980: if ($context eq 'auto') {
16981: $linefeed = "\n";
16982: } else {
16983: $linefeed = '<br />'."\n";
16984: }
1.443 albertel 16985: if (defined($one) && defined($two)) {
16986: my $cid=$one.'_'.$two;
16987: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
16988: my $secchange = 0;
16989: my $expire_role_result;
16990: my $modify_section_result;
1.628 raeburn 16991: if ($oldsec ne '-1') {
16992: if ($oldsec ne $sec) {
1.443 albertel 16993: $secchange = 1;
1.628 raeburn 16994: my $now = time;
1.443 albertel 16995: my $uurl='/'.$cid;
16996: $uurl=~s/\_/\//g;
16997: if ($oldsec) {
16998: $uurl.='/'.$oldsec;
16999: }
1.626 raeburn 17000: $oldsecurl = $uurl;
1.628 raeburn 17001: $expire_role_result =
1.1408 raeburn 17002: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17003: '','','',$context,$othdomby,$requester);
17004: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17005: if ($expire_role_result eq 'refused') {
17006: my @roles = ('st');
17007: my @statuses = ('previous');
17008: my @roledoms = ($one);
17009: my $withsec = 1;
17010: my %roleshash =
17011: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17012: \@statuses,\@roles,\@roledoms,$withsec);
17013: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17014: my ($oldstart,$oldend) =
17015: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17016: if ($oldend > 0 && $oldend <= $now) {
17017: $expire_role_result = 'ok';
17018: }
17019: }
17020: }
17021: }
1.443 albertel 17022: $result = $expire_role_result;
17023: }
17024: }
17025: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17026: $modify_section_result =
17027: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17028: undef,undef,undef,$sec,
17029: $end,$start,'','',$cid,
1.1408 raeburn 17030: '',$context,$credits,'',
17031: $othdomby,$requester);
1.443 albertel 17032: if ($modify_section_result =~ /^ok/) {
17033: if ($secchange == 1) {
1.628 raeburn 17034: if ($sec eq '') {
17035: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17036: } else {
17037: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17038: }
1.443 albertel 17039: } elsif ($oldsec eq '-1') {
1.628 raeburn 17040: if ($sec eq '') {
17041: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17042: } else {
17043: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17044: }
1.443 albertel 17045: } else {
1.628 raeburn 17046: if ($sec eq '') {
17047: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17048: } else {
17049: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17050: }
1.443 albertel 17051: }
17052: } else {
1.1115 raeburn 17053: if ($secchange) {
1.628 raeburn 17054: $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
17055: } else {
17056: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17057: }
1.443 albertel 17058: }
17059: $result = $modify_section_result;
17060: } elsif ($secchange == 1) {
1.628 raeburn 17061: if ($oldsec eq '') {
1.1103 raeburn 17062: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_2] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
1.628 raeburn 17063: } else {
17064: $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
17065: }
1.626 raeburn 17066: if ($expire_role_result eq 'refused') {
17067: my $newsecurl = '/'.$cid;
17068: $newsecurl =~ s/\_/\//g;
17069: if ($sec ne '') {
17070: $newsecurl.='/'.$sec;
17071: }
17072: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17073: if ($sec eq '') {
17074: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
17075: } else {
17076: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
17077: }
17078: }
17079: }
1.443 albertel 17080: }
17081: } else {
1.626 raeburn 17082: $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443 albertel 17083: $result = "error: incomplete course id\n";
17084: }
17085: return $result;
17086: }
17087:
1.1108 raeburn 17088: sub show_role_extent {
17089: my ($scope,$context,$role) = @_;
17090: $scope =~ s{^/}{};
17091: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17092: push(@courseroles,'co');
17093: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17094: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17095: $scope =~ s{/}{_};
17096: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17097: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17098: my ($audom,$auname) = split(/\//,$scope);
17099: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17100: &Apache::loncommon::plainname($auname,$audom).'</span>');
17101: } else {
17102: $scope =~ s{/$}{};
17103: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17104: &Apache::lonnet::domain($scope,'description').'</span>');
17105: }
17106: }
17107:
1.443 albertel 17108: ############################################################
17109: ############################################################
17110:
1.566 albertel 17111: sub check_clone {
1.578 raeburn 17112: my ($args,$linefeed) = @_;
1.566 albertel 17113: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17114: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17115: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17116: my $clonetitle;
17117: my @clonemsg;
1.566 albertel 17118: my $can_clone = 0;
1.944 raeburn 17119: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17120: if ($lctype ne 'community') {
17121: $lctype = 'course';
17122: }
1.566 albertel 17123: if ($clonehome eq 'no_host') {
1.944 raeburn 17124: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17125: push(@clonemsg,({
17126: mt => 'No new community created.',
17127: args => [],
17128: },
17129: {
17130: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17131: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17132: }));
1.908 raeburn 17133: } else {
1.1344 raeburn 17134: push(@clonemsg,({
17135: mt => 'No new course created.',
17136: args => [],
17137: },
17138: {
17139: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17140: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17141: }));
17142: }
1.566 albertel 17143: } else {
17144: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17145: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17146: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17147: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17148: push(@clonemsg,({
17149: mt => 'No new community created.',
17150: args => [],
17151: },
17152: {
17153: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17154: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17155: }));
17156: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17157: }
17158: }
1.1262 raeburn 17159: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17160: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17161: $can_clone = 1;
17162: } else {
1.1221 raeburn 17163: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17164: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17165: if ($clonehash{'cloners'} eq '') {
17166: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17167: if ($domdefs{'canclone'}) {
17168: unless ($domdefs{'canclone'} eq 'none') {
17169: if ($domdefs{'canclone'} eq 'domain') {
17170: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17171: $can_clone = 1;
17172: }
17173: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17174: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17175: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17176: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17177: $can_clone = 1;
17178: }
17179: }
17180: }
17181: }
1.578 raeburn 17182: } else {
1.1221 raeburn 17183: my @cloners = split(/,/,$clonehash{'cloners'});
17184: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17185: $can_clone = 1;
1.1221 raeburn 17186: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17187: $can_clone = 1;
1.1225 raeburn 17188: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17189: $can_clone = 1;
1.1221 raeburn 17190: }
17191: unless ($can_clone) {
1.1225 raeburn 17192: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17193: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17194: my (%gotdomdefaults,%gotcodedefaults);
17195: foreach my $cloner (@cloners) {
17196: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17197: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17198: my (%codedefaults,@code_order);
17199: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17200: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17201: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17202: }
17203: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17204: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17205: }
17206: } else {
17207: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17208: \%codedefaults,
17209: \@code_order);
17210: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17211: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17212: }
17213: if (@code_order > 0) {
17214: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17215: $cloner,$clonehash{'internal.coursecode'},
17216: $args->{'crscode'})) {
17217: $can_clone = 1;
17218: last;
17219: }
17220: }
17221: }
17222: }
17223: }
1.1225 raeburn 17224: }
17225: }
17226: unless ($can_clone) {
17227: my $ccrole = 'cc';
17228: if ($args->{'crstype'} eq 'Community') {
17229: $ccrole = 'co';
17230: }
17231: my %roleshash =
17232: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17233: $args->{'ccdomain'},
17234: 'userroles',['active'],[$ccrole],
17235: [$args->{'clonedomain'}]);
17236: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17237: $can_clone = 1;
17238: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17239: $args->{'ccuname'},$args->{'ccdomain'})) {
17240: $can_clone = 1;
1.1221 raeburn 17241: }
17242: }
17243: unless ($can_clone) {
17244: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17245: push(@clonemsg,({
17246: mt => 'No new community created.',
17247: args => [],
17248: },
17249: {
17250: mt => 'The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',
17251: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17252: }));
1.942 raeburn 17253: } else {
1.1344 raeburn 17254: push(@clonemsg,({
17255: mt => 'No new course created.',
17256: args => [],
17257: },
17258: {
17259: mt => 'The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',
17260: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17261: }));
1.1221 raeburn 17262: }
1.566 albertel 17263: }
1.578 raeburn 17264: }
1.566 albertel 17265: }
1.1344 raeburn 17266: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17267: }
17268:
1.444 albertel 17269: sub construct_course {
1.1262 raeburn 17270: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17271: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17272: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17273: my $linefeed = '<br />'."\n";
17274: if ($context eq 'auto') {
17275: $linefeed = "\n";
17276: }
1.566 albertel 17277:
17278: #
17279: # Are we cloning?
17280: #
1.1344 raeburn 17281: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17282: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17283: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17284: if (!$can_clone) {
1.1344 raeburn 17285: return (0,$outcome,$clonemsgref);
1.566 albertel 17286: }
17287: }
17288:
1.444 albertel 17289: #
17290: # Open course
17291: #
1.1239 raeburn 17292: my $showncrstype;
17293: if ($args->{'crstype'} eq 'Placement') {
17294: $showncrstype = 'placement test';
17295: } else {
17296: $showncrstype = lc($args->{'crstype'});
17297: }
1.444 albertel 17298: my %cenv=();
17299: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17300: $args->{'cdescr'},
17301: $args->{'curl'},
17302: $args->{'course_home'},
17303: $args->{'nonstandard'},
17304: $args->{'crscode'},
17305: $args->{'ccuname'}.':'.
17306: $args->{'ccdomain'},
1.882 raeburn 17307: $args->{'crstype'},
1.1344 raeburn 17308: $cnum,$context,$category,
17309: $callercontext);
1.444 albertel 17310:
17311: # Note: The testing routines depend on this being output; see
17312: # Utils::Course. This needs to at least be output as a comment
17313: # if anyone ever decides to not show this, and Utils::Course::new
17314: # will need to be suitably modified.
1.1344 raeburn 17315: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17316: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17317: } else {
17318: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17319: }
1.943 raeburn 17320: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17321: return (0,$outcome,$clonemsgref);
1.943 raeburn 17322: }
17323:
1.444 albertel 17324: #
17325: # Check if created correctly
17326: #
1.479 albertel 17327: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17328: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17329: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17330: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17331: $outcome .= &mt_user($user_lh,
17332: 'Course creation failed, unrecognized course home server.');
17333: } else {
17334: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17335: }
17336: $outcome .= $linefeed;
17337: return (0,$outcome,$clonemsgref);
1.943 raeburn 17338: }
1.541 raeburn 17339: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17340:
1.444 albertel 17341: #
1.566 albertel 17342: # Do the cloning
17343: #
1.1344 raeburn 17344: my @clonemsg;
1.566 albertel 17345: if ($can_clone && $cloneid) {
1.1344 raeburn 17346: push(@clonemsg,
17347: {
17348: mt => 'Created [_1] by cloning from [_2]',
17349: args => [$showncrstype,$clonetitle],
17350: });
1.566 albertel 17351: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17352: # Copy all files
1.1344 raeburn 17353: my @info =
17354: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17355: $args->{'dateshift'},$args->{'crscode'},
17356: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17357: $args->{'tinyurls'});
17358: if (@info) {
17359: push(@clonemsg,@info);
17360: }
1.444 albertel 17361: # Restore URL
1.566 albertel 17362: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17363: # Restore title
1.566 albertel 17364: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17365: # Restore creation date, creator and creation context.
17366: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17367: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17368: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17369: # Mark as cloned
1.566 albertel 17370: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17371: # Need to clone grading mode
17372: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17373: $cenv{'grading'}=$newenv{'grading'};
17374: # Do not clone these environment entries
17375: &Apache::lonnet::del('environment',
17376: ['default_enrollment_start_date',
17377: 'default_enrollment_end_date',
17378: 'question.email',
17379: 'policy.email',
17380: 'comment.email',
17381: 'pch.users.denied',
1.725 raeburn 17382: 'plc.users.denied',
17383: 'hidefromcat',
1.1121 raeburn 17384: 'checkforpriv',
1.1355 raeburn 17385: 'categories'],
1.638 www 17386: $$crsudom,$$crsunum);
1.1170 raeburn 17387: if ($args->{'textbook'}) {
17388: $cenv{'internal.textbook'} = $args->{'textbook'};
17389: }
1.444 albertel 17390: }
1.566 albertel 17391:
1.444 albertel 17392: #
17393: # Set environment (will override cloned, if existing)
17394: #
17395: my @sections = ();
17396: my @xlists = ();
17397: if ($args->{'crstype'}) {
17398: $cenv{'type'}=$args->{'crstype'};
17399: }
1.1371 raeburn 17400: if ($args->{'lti'}) {
17401: $cenv{'internal.lti'}=$args->{'lti'};
17402: }
1.444 albertel 17403: if ($args->{'crsid'}) {
17404: $cenv{'courseid'}=$args->{'crsid'};
17405: }
17406: if ($args->{'crscode'}) {
17407: $cenv{'internal.coursecode'}=$args->{'crscode'};
17408: }
17409: if ($args->{'crsquota'} ne '') {
17410: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17411: } else {
17412: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17413: }
17414: if ($args->{'ccuname'}) {
17415: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17416: ':'.$args->{'ccdomain'};
17417: } else {
17418: $cenv{'internal.courseowner'} = $args->{'curruser'};
17419: }
1.1116 raeburn 17420: if ($args->{'defaultcredits'}) {
17421: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17422: }
1.444 albertel 17423: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17424: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17425: if ($args->{'crssections'}) {
17426: $cenv{'internal.sectionnums'} = '';
17427: if ($args->{'crssections'} =~ m/,/) {
17428: @sections = split/,/,$args->{'crssections'};
17429: } else {
17430: $sections[0] = $args->{'crssections'};
17431: }
17432: if (@sections > 0) {
17433: foreach my $item (@sections) {
17434: my ($sec,$gp) = split/:/,$item;
17435: my $class = $args->{'crscode'}.$sec;
17436: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17437: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17438: if ($addcheck eq 'ok') {
17439: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17440: push(@oklcsecs,$gp);
17441: }
17442: } else {
1.1263 raeburn 17443: push(@badclasses,$class);
1.444 albertel 17444: }
17445: }
17446: $cenv{'internal.sectionnums'} =~ s/,$//;
17447: }
17448: }
17449: # do not hide course coordinator from staff listing,
17450: # even if privileged
17451: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17452: # add course coordinator's domain to domains to check for privileged users
17453: # if different to course domain
17454: if ($$crsudom ne $args->{'ccdomain'}) {
17455: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17456: }
1.444 albertel 17457: # add crosslistings
17458: if ($args->{'crsxlist'}) {
17459: $cenv{'internal.crosslistings'}='';
17460: if ($args->{'crsxlist'} =~ m/,/) {
17461: @xlists = split/,/,$args->{'crsxlist'};
17462: } else {
17463: $xlists[0] = $args->{'crsxlist'};
17464: }
17465: if (@xlists > 0) {
17466: foreach my $item (@xlists) {
17467: my ($xl,$gp) = split/:/,$item;
17468: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17469: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17470: if ($addcheck eq 'ok') {
17471: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17472: push(@oklcsecs,$gp);
17473: }
17474: } else {
1.1263 raeburn 17475: push(@badclasses,$xl);
1.444 albertel 17476: }
17477: }
17478: $cenv{'internal.crosslistings'} =~ s/,$//;
17479: }
17480: }
17481: if ($args->{'autoadds'}) {
17482: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17483: }
17484: if ($args->{'autodrops'}) {
17485: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17486: }
17487: # check for notification of enrollment changes
17488: my @notified = ();
17489: if ($args->{'notify_owner'}) {
17490: if ($args->{'ccuname'} ne '') {
17491: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17492: }
17493: }
17494: if ($args->{'notify_dc'}) {
17495: if ($uname ne '') {
1.630 raeburn 17496: push(@notified,$uname.':'.$udom);
1.444 albertel 17497: }
17498: }
17499: if (@notified > 0) {
17500: my $notifylist;
17501: if (@notified > 1) {
17502: $notifylist = join(',',@notified);
17503: } else {
17504: $notifylist = $notified[0];
17505: }
17506: $cenv{'internal.notifylist'} = $notifylist;
17507: }
17508: if (@badclasses > 0) {
17509: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17510: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17511: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17512: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17513: );
1.1264 raeburn 17514: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17515: &mt('That is because the user identified as the course owner ([_1]) does not have rights to access enrollment in these classes, as determined by the policies of your institution on access to official classlists',$cenv{'internal.courseowner'}).$linefeed.$lt{'itis'};
1.541 raeburn 17516: if ($context eq 'auto') {
17517: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17518: } else {
1.566 albertel 17519: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17520: }
17521: foreach my $item (@badclasses) {
1.541 raeburn 17522: if ($context eq 'auto') {
1.1261 raeburn 17523: $outcome .= " - $item\n";
1.541 raeburn 17524: } else {
1.1261 raeburn 17525: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17526: }
1.1261 raeburn 17527: }
17528: if ($context eq 'auto') {
17529: $outcome .= $linefeed;
17530: } else {
17531: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17532: }
1.444 albertel 17533: }
17534: if ($args->{'no_end_date'}) {
17535: $args->{'endaccess'} = 0;
17536: }
1.1412 raeburn 17537: # If an official course with institutional sections is created by cloning
17538: # an existing course, section-specific hiding of course totals in student's
17539: # view of grades as copied from cloned course, will be checked for valid
17540: # sections.
17541: if (($can_clone && $cloneid) &&
17542: ($cenv{'internal.coursecode'} ne '') &&
17543: ($cenv{'grading'} eq 'standard') &&
17544: ($cenv{'hidetotals'} ne '') &&
17545: ($cenv{'hidetotals'} ne 'all')) {
17546: my @hidesecs;
17547: my $deletehidetotals;
17548: if (@oklcsecs) {
17549: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17550: if (grep(/^\Q$sec$/,@oklcsecs)) {
17551: push(@hidesecs,$sec);
17552: }
17553: }
17554: if (@hidesecs) {
17555: $cenv{'hidetotals'} = join(',',@hidesecs);
17556: } else {
17557: $deletehidetotals = 1;
17558: }
17559: } else {
17560: $deletehidetotals = 1;
17561: }
17562: if ($deletehidetotals) {
17563: delete($cenv{'hidetotals'});
17564: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17565: }
17566: }
1.444 albertel 17567: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17568: $cenv{'internal.autoend'}=$args->{'enrollend'};
17569: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17570: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17571: if ($args->{'showphotos'}) {
17572: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17573: }
17574: $cenv{'internal.authtype'} = $args->{'authtype'};
17575: $cenv{'internal.autharg'} = $args->{'autharg'};
17576: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17577: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17578: my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student');
17579: if ($context eq 'auto') {
17580: $outcome .= $krb_msg;
17581: } else {
1.566 albertel 17582: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17583: }
17584: $outcome .= $linefeed;
1.444 albertel 17585: }
17586: }
17587: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17588: if ($args->{'setpolicy'}) {
17589: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17590: }
17591: if ($args->{'setcontent'}) {
17592: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17593: }
1.1251 raeburn 17594: if ($args->{'setcomment'}) {
17595: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17596: }
1.444 albertel 17597: }
17598: if ($args->{'reshome'}) {
17599: $cenv{'reshome'}=$args->{'reshome'}.'/';
17600: $cenv{'reshome'}=~s/\/+$/\//;
17601: }
17602: #
17603: # course has keyed access
17604: #
17605: if ($args->{'setkeys'}) {
17606: $cenv{'keyaccess'}='yes';
17607: }
17608: # if specified, key authority is not course, but user
17609: # only active if keyaccess is yes
17610: if ($args->{'keyauth'}) {
1.487 albertel 17611: my ($user,$domain) = split(':',$args->{'keyauth'});
17612: $user = &LONCAPA::clean_username($user);
17613: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17614: if ($user ne '' && $domain ne '') {
1.487 albertel 17615: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17616: }
17617: }
17618:
1.1166 raeburn 17619: #
1.1167 raeburn 17620: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17621: #
17622: if ($args->{'uniquecode'}) {
17623: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17624: if ($code) {
17625: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17626: my %crsinfo =
17627: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17628: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17629: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17630: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17631: }
1.1166 raeburn 17632: if (ref($coderef)) {
17633: $$coderef = $code;
17634: }
17635: }
17636: }
17637:
1.444 albertel 17638: if ($args->{'disresdis'}) {
17639: $cenv{'pch.roles.denied'}='st';
17640: }
17641: if ($args->{'disablechat'}) {
17642: $cenv{'plc.roles.denied'}='st';
17643: }
17644:
17645: # Record we've not yet viewed the Course Initialization Helper for this
17646: # course
17647: $cenv{'course.helper.not.run'} = 1;
17648: #
17649: # Use new Randomseed
17650: #
17651: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17652: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17653: #
17654: # The encryption code and receipt prefix for this course
17655: #
17656: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17657: $cenv{'internal.encpref'}=100+int(9*rand(99));
17658: #
17659: # By default, use standard grading
17660: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17661:
1.541 raeburn 17662: $outcome .= $linefeed.&mt('Setting environment').': '.
17663: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17664: #
17665: # Open all assignments
17666: #
17667: if ($args->{'openall'}) {
1.1341 raeburn 17668: my $opendate = time;
17669: if ($args->{'openallfrom'} =~ /^\d+$/) {
17670: $opendate = $args->{'openallfrom'};
17671: }
1.444 albertel 17672: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17673: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17674: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17675: $outcome .= &mt('All assignments open starting [_1]',
17676: &Apache::lonlocal::locallocaltime($opendate)).': '.
17677: &Apache::lonnet::cput
17678: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17679: }
17680: #
17681: # Set first page
17682: #
17683: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17684: || ($cloneid)) {
17685: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17686:
17687: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17688: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17689:
1.444 albertel 17690: $outcome .= ($fatal?$errtext:'read ok').' - ';
17691: my $title; my $url;
17692: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17693: $title=&mt('Syllabus');
1.444 albertel 17694: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17695: } else {
1.963 raeburn 17696: $title=&mt('Table of Contents');
1.444 albertel 17697: $url='/adm/navmaps';
17698: }
1.445 albertel 17699:
17700: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17701: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17702:
17703: if ($errtext) { $fatal=2; }
1.541 raeburn 17704: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17705: }
1.566 albertel 17706:
1.1237 raeburn 17707: #
17708: # Set params for Placement Tests
17709: #
1.1239 raeburn 17710: if ($args->{'crstype'} eq 'Placement') {
17711: my %storecontent;
17712: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17713: my %defaults = (
17714: buttonshide => { value => 'yes',
17715: type => 'string_yesno',},
17716: type => { value => 'randomizetry',
17717: type => 'string_questiontype',},
17718: maxtries => { value => 1,
17719: type => 'int_pos',},
17720: problemstatus => { value => 'no',
17721: type => 'string_problemstatus',},
17722: );
17723: foreach my $key (keys(%defaults)) {
17724: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17725: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17726: }
1.1237 raeburn 17727: &Apache::lonnet::cput
17728: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17729: }
17730:
1.1344 raeburn 17731: return (1,$outcome,\@clonemsg);
1.444 albertel 17732: }
17733:
1.1166 raeburn 17734: sub make_unique_code {
17735: my ($cdom,$cnum) = @_;
17736: # get lock on uniquecodes db
17737: my $lockhash = {
17738: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17739: ':'.$env{'user.domain'},
17740: };
17741: my $tries = 0;
17742: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17743: my ($code,$error);
17744:
17745: while (($gotlock ne 'ok') && ($tries<3)) {
17746: $tries ++;
17747: sleep 1;
17748: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17749: }
17750: if ($gotlock eq 'ok') {
17751: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17752: my $gotcode;
17753: my $attempts = 0;
17754: while ((!$gotcode) && ($attempts < 100)) {
17755: $code = &generate_code();
17756: if (!exists($currcodes{$code})) {
17757: $gotcode = 1;
17758: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17759: $error = 'nostore';
17760: }
17761: }
17762: $attempts ++;
17763: }
17764: my @del_lock = ($cnum."\0".'uniquecodes');
17765: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17766: } else {
17767: $error = 'nolock';
17768: }
17769: return ($code,$error);
17770: }
17771:
17772: sub generate_code {
17773: my $code;
17774: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17775: for (my $i=0; $i<6; $i++) {
17776: my $lettnum = int (rand 2);
17777: my $item = '';
17778: if ($lettnum) {
17779: $item = $letts[int( rand(18) )];
17780: } else {
17781: $item = 1+int( rand(8) );
17782: }
17783: $code .= $item;
17784: }
17785: return $code;
17786: }
17787:
1.444 albertel 17788: ############################################################
17789: ############################################################
17790:
1.1237 raeburn 17791: # Community, Course and Placement Test
1.378 raeburn 17792: sub course_type {
17793: my ($cid) = @_;
17794: if (!defined($cid)) {
17795: $cid = $env{'request.course.id'};
17796: }
1.404 albertel 17797: if (defined($env{'course.'.$cid.'.type'})) {
17798: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17799: } else {
17800: return 'Course';
1.377 raeburn 17801: }
17802: }
1.156 albertel 17803:
1.406 raeburn 17804: sub group_term {
17805: my $crstype = &course_type();
17806: my %names = (
17807: 'Course' => 'group',
1.865 raeburn 17808: 'Community' => 'group',
1.1237 raeburn 17809: 'Placement' => 'group',
1.406 raeburn 17810: );
17811: return $names{$crstype};
17812: }
17813:
1.902 raeburn 17814: sub course_types {
1.1310 raeburn 17815: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17816: my %typename = (
17817: official => 'Official course',
17818: unofficial => 'Unofficial course',
17819: community => 'Community',
1.1165 raeburn 17820: textbook => 'Textbook course',
1.1237 raeburn 17821: placement => 'Placement test',
1.1310 raeburn 17822: lti => 'LTI provider',
1.902 raeburn 17823: );
17824: return (\@types,\%typename);
17825: }
17826:
1.156 albertel 17827: sub icon {
17828: my ($file)=@_;
1.505 albertel 17829: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17830: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17831: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17832: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17833: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17834: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17835: $curfext.".gif") {
17836: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17837: $curfext.".gif";
17838: }
17839: }
1.249 albertel 17840: return &lonhttpdurl($iconname);
1.154 albertel 17841: }
1.84 albertel 17842:
1.575 albertel 17843: sub lonhttpdurl {
1.692 www 17844: #
17845: # Had been used for "small fry" static images on separate port 8080.
17846: # Modify here if lightweight http functionality desired again.
17847: # Currently eliminated due to increasing firewall issues.
17848: #
1.575 albertel 17849: my ($url)=@_;
1.692 www 17850: return $url;
1.215 albertel 17851: }
17852:
1.213 albertel 17853: sub connection_aborted {
17854: my ($r)=@_;
17855: $r->print(" ");$r->rflush();
17856: my $c = $r->connection;
17857: return $c->aborted();
17858: }
17859:
1.221 foxr 17860: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17861: # strings as 'strings'.
17862: sub escape_single {
1.221 foxr 17863: my ($input) = @_;
1.223 albertel 17864: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17865: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17866: return $input;
17867: }
1.223 albertel 17868:
1.222 foxr 17869: # Same as escape_single, but escape's "'s This
17870: # can be used for "strings"
17871: sub escape_double {
17872: my ($input) = @_;
17873: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17874: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17875: return $input;
17876: }
1.223 albertel 17877:
1.222 foxr 17878: # Escapes the last element of a full URL.
17879: sub escape_url {
17880: my ($url) = @_;
1.238 raeburn 17881: my @urlslices = split(/\//, $url,-1);
1.369 www 17882: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17883: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17884: }
1.462 albertel 17885:
1.820 raeburn 17886: sub compare_arrays {
17887: my ($arrayref1,$arrayref2) = @_;
17888: my (@difference,%count);
17889: @difference = ();
17890: %count = ();
17891: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17892: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17893: foreach my $element (keys(%count)) {
17894: if ($count{$element} == 1) {
17895: push(@difference,$element);
17896: }
17897: }
17898: }
17899: return @difference;
17900: }
17901:
1.1322 raeburn 17902: sub lon_status_items {
17903: my %defaults = (
17904: E => 100,
17905: W => 4,
17906: N => 1,
1.1324 raeburn 17907: U => 5,
1.1322 raeburn 17908: threshold => 200,
17909: sysmail => 2500,
17910: );
17911: my %names = (
17912: E => 'Errors',
17913: W => 'Warnings',
17914: N => 'Notices',
1.1324 raeburn 17915: U => 'Unsent',
1.1322 raeburn 17916: );
17917: return (\%defaults,\%names);
17918: }
17919:
1.817 bisitz 17920: # -------------------------------------------------------- Initialize user login
1.462 albertel 17921: sub init_user_environment {
1.463 albertel 17922: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17923: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17924:
17925: my $public=($username eq 'public' && $domain eq 'public');
17926:
1.1415 raeburn 17927: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17928: $coauthorenv);
1.462 albertel 17929: my $now=time;
17930:
17931: if ($public) {
17932: my $max_public=100;
17933: my $oldest;
17934: my $oldest_time=0;
17935: for(my $next=1;$next<=$max_public;$next++) {
17936: if (-e $lonids."/publicuser_$next.id") {
17937: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17938: if ($mtime<$oldest_time || !$oldest_time) {
17939: $oldest_time=$mtime;
17940: $oldest=$next;
17941: }
17942: } else {
17943: $cookie="publicuser_$next";
17944: last;
17945: }
17946: }
17947: if (!$cookie) { $cookie="publicuser_$oldest"; }
17948: } else {
1.1275 raeburn 17949: # See if old ID present, if so, remove if this isn't a robot,
17950: # killing any existing non-robot sessions
1.463 albertel 17951: if (!$args->{'robot'}) {
17952: opendir(DIR,$lonids);
17953: while ($filename=readdir(DIR)) {
17954: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17955: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17956: &GDBM_READER(),0640)) {
1.1295 raeburn 17957: my $linkedfile;
1.1320 raeburn 17958: if (exists($oldenv{'user.linkedenv'})) {
17959: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17960: }
1.1320 raeburn 17961: untie(%oldenv);
17962: if (unlink("$lonids/$filename")) {
17963: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17964: if (-l "$lonids/$linkedfile.id") {
17965: unlink("$lonids/$linkedfile.id");
17966: }
1.1295 raeburn 17967: }
17968: }
17969: } else {
17970: unlink($lonids.'/'.$filename);
17971: }
1.463 albertel 17972: }
1.462 albertel 17973: }
1.463 albertel 17974: closedir(DIR);
1.1204 raeburn 17975: # If there is a undeleted lockfile for the user's paste buffer remove it.
17976: my $namespace = 'nohist_courseeditor';
17977: my $lockingkey = 'paste'."\0".'locked_num';
17978: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
17979: $domain,$username);
17980: if (exists($lockhash{$lockingkey})) {
17981: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
17982: unless ($delresult eq 'ok') {
17983: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
17984: }
17985: }
1.462 albertel 17986: }
17987: # Give them a new cookie
1.463 albertel 17988: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 17989: : $now.$$.int(rand(10000)));
1.463 albertel 17990: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 17991:
17992: # Initialize roles
17993:
1.1414 raeburn 17994: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 17995: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 17996: }
17997: # ------------------------------------ Check browser type and MathML capability
17998:
1.1194 raeburn 17999: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18000: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18001:
18002: # ------------------------------------------------------------- Get environment
18003:
18004: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18005: my ($tmp) = keys(%userenv);
1.1275 raeburn 18006: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18007: undef(%userenv);
18008: }
18009: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18010: $form->{'interface'}=$userenv{'interface'};
18011: }
18012: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18013:
18014: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18015: foreach my $option ('interface','localpath','localres') {
18016: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18017: }
18018: # --------------------------------------------------------- Write first profile
18019:
18020: {
1.1350 raeburn 18021: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18022: my %initial_env =
18023: ("user.name" => $username,
18024: "user.domain" => $domain,
18025: "user.home" => $authhost,
18026: "browser.type" => $clientbrowser,
18027: "browser.version" => $clientversion,
18028: "browser.mathml" => $clientmathml,
18029: "browser.unicode" => $clientunicode,
18030: "browser.os" => $clientos,
1.1137 raeburn 18031: "browser.mobile" => $clientmobile,
1.1141 raeburn 18032: "browser.info" => $clientinfo,
1.1194 raeburn 18033: "browser.osversion" => $clientosversion,
1.462 albertel 18034: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18035: "request.course.fn" => '',
18036: "request.course.uri" => '',
18037: "request.course.sec" => '',
18038: "request.role" => 'cm',
18039: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18040: "request.host" => $ip,);
1.462 albertel 18041:
18042: if ($form->{'localpath'}) {
18043: $initial_env{"browser.localpath"} = $form->{'localpath'};
18044: $initial_env{"browser.localres"} = $form->{'localres'};
18045: }
18046:
18047: if ($form->{'interface'}) {
18048: $form->{'interface'}=~s/\W//gs;
18049: $initial_env{"browser.interface"} = $form->{'interface'};
18050: $env{'browser.interface'}=$form->{'interface'};
18051: }
18052:
1.1157 raeburn 18053: if ($form->{'iptoken'}) {
18054: my $lonhost = $r->dir_config('lonHostID');
18055: $initial_env{"user.noloadbalance"} = $lonhost;
18056: $env{'user.noloadbalance'} = $lonhost;
18057: }
18058:
1.1268 raeburn 18059: if ($form->{'noloadbalance'}) {
18060: my @hosts = &Apache::lonnet::current_machine_ids();
18061: my $hosthere = $form->{'noloadbalance'};
18062: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18063: $initial_env{"user.noloadbalance"} = $hosthere;
18064: $env{'user.noloadbalance'} = $hosthere;
18065: }
18066: }
18067:
1.1016 raeburn 18068: unless ($domain eq 'public') {
1.1273 raeburn 18069: my %is_adv = ( is_adv => $env{'user.adv'} );
18070: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18071:
1.1414 raeburn 18072: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18073: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18074: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18075: undef,\%userenv,\%domdef,\%is_adv);
18076: }
1.980 raeburn 18077:
1.1311 raeburn 18078: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18079: $userenv{'canrequest.'.$crstype} =
18080: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18081: 'reload','requestcourses',
18082: \%userenv,\%domdef,\%is_adv);
18083: }
1.724 raeburn 18084:
1.1418 raeburn 18085: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18086: (exists($userroles->{"user.role.au./$domain/"}))) {
18087: if ($userenv{'authoreditors'}) {
18088: $userenv{'editors'} = $userenv{'authoreditors'};
18089: } elsif ($domdef{'editors'} ne '') {
18090: $userenv{'editors'} = $domdef{'editors'};
18091: } else {
18092: $userenv{'editors'} = 'edit,xml';
18093: }
1.1431 raeburn 18094: if ($userenv{'authorarchive'}) {
18095: $userenv{'canarchive'} = 1;
18096: } elsif (($userenv{'authorarchive'} eq '') &&
18097: ($domdef{'archive'})) {
18098: $userenv{'canarchive'} = 1;
18099: }
1.1418 raeburn 18100: }
18101:
1.1273 raeburn 18102: $userenv{'canrequest.author'} =
18103: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18104: 'reload','requestauthor',
1.980 raeburn 18105: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18106: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18107: $domain,$username);
18108: my $reqstatus = $reqauthor{'author_status'};
18109: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18110: if (ref($reqauthor{'author'}) eq 'HASH') {
18111: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18112: $reqauthor{'author'}{'timestamp'};
18113: }
1.1092 raeburn 18114: }
1.1287 raeburn 18115: my ($types,$typename) = &course_types();
18116: if (ref($types) eq 'ARRAY') {
18117: my @options = ('approval','validate','autolimit');
18118: my $optregex = join('|',@options);
18119: my (%willtrust,%trustchecked);
18120: foreach my $type (@{$types}) {
18121: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18122: if ($dom_str ne '') {
18123: my $updatedstr = '';
18124: my @possdomains = split(',',$dom_str);
18125: foreach my $entry (@possdomains) {
18126: my ($extdom,$extopt) = split(':',$entry);
18127: unless ($trustchecked{$extdom}) {
18128: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18129: $trustchecked{$extdom} = 1;
18130: }
18131: if ($willtrust{$extdom}) {
18132: $updatedstr .= $entry.',';
18133: }
18134: }
18135: $updatedstr =~ s/,$//;
18136: if ($updatedstr) {
18137: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18138: } else {
18139: delete($userenv{'reqcrsotherdom.'.$type});
18140: }
18141: }
18142: }
18143: }
1.1092 raeburn 18144: }
1.462 albertel 18145: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18146:
1.462 albertel 18147: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18148: &GDBM_WRCREAT(),0640)) {
18149: &_add_to_env(\%disk_env,\%initial_env);
18150: &_add_to_env(\%disk_env,\%userenv,'environment.');
18151: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18152: if (ref($firstaccenv) eq 'HASH') {
18153: &_add_to_env(\%disk_env,$firstaccenv);
18154: }
18155: if (ref($timerintenv) eq 'HASH') {
18156: &_add_to_env(\%disk_env,$timerintenv);
18157: }
1.1414 raeburn 18158: if (ref($coauthorenv) eq 'HASH') {
18159: if (keys(%{$coauthorenv})) {
18160: &_add_to_env(\%disk_env,$coauthorenv);
18161: }
18162: }
1.463 albertel 18163: if (ref($args->{'extra_env'})) {
18164: &_add_to_env(\%disk_env,$args->{'extra_env'});
18165: }
1.462 albertel 18166: untie(%disk_env);
18167: } else {
1.705 tempelho 18168: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18169: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18170: return 'error: '.$!;
18171: }
18172: }
18173: $env{'request.role'}='cm';
18174: $env{'request.role.adv'}=$env{'user.adv'};
18175: $env{'browser.type'}=$clientbrowser;
18176:
18177: return $cookie;
18178:
18179: }
18180:
18181: sub _add_to_env {
18182: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18183: if (ref($env_data) eq 'HASH') {
18184: while (my ($key,$value) = each(%$env_data)) {
18185: $idf->{$prefix.$key} = $value;
18186: $env{$prefix.$key} = $value;
18187: }
1.462 albertel 18188: }
18189: }
18190:
1.685 tempelho 18191: # --- Get the symbolic name of a problem and the url
18192: sub get_symb {
18193: my ($request,$silent) = @_;
1.726 raeburn 18194: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18195: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18196: if ($symb eq '') {
18197: if (!$silent) {
1.1071 raeburn 18198: if (ref($request)) {
18199: $request->print("Unable to handle ambiguous references:$url:.");
18200: }
1.685 tempelho 18201: return ();
18202: }
18203: }
18204: &Apache::lonenc::check_decrypt(\$symb);
18205: return ($symb);
18206: }
18207:
18208: # --------------------------------------------------------------Get annotation
18209:
18210: sub get_annotation {
18211: my ($symb,$enc) = @_;
18212:
18213: my $key = $symb;
18214: if (!$enc) {
18215: $key =
18216: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18217: }
18218: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18219: return $annotation{$key};
18220: }
18221:
18222: sub clean_symb {
1.731 raeburn 18223: my ($symb,$delete_enc) = @_;
1.685 tempelho 18224:
18225: &Apache::lonenc::check_decrypt(\$symb);
18226: my $enc = $env{'request.enc'};
1.731 raeburn 18227: if ($delete_enc) {
1.730 raeburn 18228: delete($env{'request.enc'});
18229: }
1.685 tempelho 18230:
18231: return ($symb,$enc);
18232: }
1.462 albertel 18233:
1.1181 raeburn 18234: ############################################################
18235: ############################################################
18236:
18237: =pod
18238:
18239: =head1 Routines for building display used to search for courses
18240:
18241:
18242: =over 4
18243:
18244: =item * &build_filters()
18245:
18246: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18247: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18248: and quotacheck.pl
18249:
1.1181 raeburn 18250:
18251: Inputs:
18252:
18253: filterlist - anonymous array of fields to include as potential filters
18254:
18255: crstype - course type
18256:
18257: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18258: to pop-open a course selector (will contain "extra element").
18259:
18260: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18261:
18262: filter - anonymous hash of criteria and their values
18263:
18264: action - form action
18265:
18266: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18267:
1.1182 raeburn 18268: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18269:
18270: cloneruname - username of owner of new course who wants to clone
18271:
18272: clonerudom - domain of owner of new course who wants to clone
18273:
18274: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18275:
18276: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18277:
18278: codedom - domain
18279:
18280: formname - value of form element named "form".
18281:
18282: fixeddom - domain, if fixed.
18283:
18284: prevphase - value to assign to form element named "phase" when going back to the previous screen
18285:
18286: cnameelement - name of form element in form on opener page which will receive title of selected course
18287:
18288: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18289:
18290: cdomelement - name of form element in form on opener page which will receive domain of selected course
18291:
18292: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18293:
18294: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18295:
18296: clonewarning - warning message about missing information for intended course owner when DC creates a course
18297:
1.1182 raeburn 18298:
1.1181 raeburn 18299: Returns: $output - HTML for display of search criteria, and hidden form elements.
18300:
1.1182 raeburn 18301:
1.1181 raeburn 18302: Side Effects: None
18303:
18304: =cut
18305:
18306: # ---------------------------------------------- search for courses based on last activity etc.
18307:
18308: sub build_filters {
18309: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18310: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18311: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18312: $cnameelement,$cnumelement,$cdomelement,$setroles,
18313: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18314: my ($list,$jscript);
1.1181 raeburn 18315: my $onchange = 'javascript:updateFilters(this)';
18316: my ($domainselectform,$sincefilterform,$createdfilterform,
18317: $ownerdomselectform,$persondomselectform,$instcodeform,
18318: $typeselectform,$instcodetitle);
18319: if ($formname eq '') {
18320: $formname = $caller;
18321: }
18322: foreach my $item (@{$filterlist}) {
18323: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18324: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18325: if ($item eq 'domainfilter') {
18326: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18327: } elsif ($item eq 'coursefilter') {
18328: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18329: } elsif ($item eq 'ownerfilter') {
18330: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18331: } elsif ($item eq 'ownerdomfilter') {
18332: $filter->{'ownerdomfilter'} =
18333: &LONCAPA::clean_domain($filter->{$item});
18334: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18335: 'ownerdomfilter',1);
18336: } elsif ($item eq 'personfilter') {
18337: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18338: } elsif ($item eq 'persondomfilter') {
18339: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18340: 'persondomfilter',1);
18341: } else {
18342: $filter->{$item} =~ s/\W//g;
18343: }
18344: if (!$filter->{$item}) {
18345: $filter->{$item} = '';
18346: }
18347: }
18348: if ($item eq 'domainfilter') {
18349: my $allow_blank = 1;
18350: if ($formname eq 'portform') {
18351: $allow_blank=0;
18352: } elsif ($formname eq 'studentform') {
18353: $allow_blank=0;
18354: }
18355: if ($fixeddom) {
18356: $domainselectform = '<input type="hidden" name="domainfilter"'.
18357: ' value="'.$codedom.'" />'.
18358: &Apache::lonnet::domain($codedom,'description');
18359: } else {
18360: $domainselectform = &select_dom_form($filter->{$item},
18361: 'domainfilter',
18362: $allow_blank,'',$onchange);
18363: }
18364: } else {
18365: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18366: }
18367: }
18368:
18369: # last course activity filter and selection
18370: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18371:
18372: # course created filter and selection
18373: if (exists($filter->{'createdfilter'})) {
18374: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18375: }
18376:
1.1239 raeburn 18377: my $prefix = $crstype;
18378: if ($crstype eq 'Placement') {
18379: $prefix = 'Placement Test'
18380: }
1.1181 raeburn 18381: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18382: 'cac' => "$prefix Activity",
18383: 'ccr' => "$prefix Created",
18384: 'cde' => "$prefix Title",
18385: 'cdo' => "$prefix Domain",
1.1181 raeburn 18386: 'ins' => 'Institutional Code',
18387: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18388: 'cow' => "$prefix Owner/Co-owner",
18389: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18390: 'cog' => 'Type',
18391: );
18392:
18393: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18394: my $typeval = 'Course';
18395: if ($crstype eq 'Community') {
18396: $typeval = 'Community';
1.1239 raeburn 18397: } elsif ($crstype eq 'Placement') {
18398: $typeval = 'Placement';
1.1181 raeburn 18399: }
18400: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18401: } else {
18402: $typeselectform = '<select name="type" size="1"';
18403: if ($onchange) {
18404: $typeselectform .= ' onchange="'.$onchange.'"';
18405: }
18406: $typeselectform .= '>'."\n";
1.1237 raeburn 18407: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18408: my $shown;
18409: if ($posstype eq 'Placement') {
18410: $shown = &mt('Placement Test');
18411: } else {
18412: $shown = &mt($posstype);
18413: }
1.1181 raeburn 18414: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18415: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18416: }
18417: $typeselectform.="</select>";
18418: }
18419:
18420: my ($cloneableonlyform,$cloneabletitle);
18421: if (exists($filter->{'cloneableonly'})) {
18422: my $cloneableon = '';
18423: my $cloneableoff = ' checked="checked"';
18424: if ($filter->{'cloneableonly'}) {
18425: $cloneableon = $cloneableoff;
18426: $cloneableoff = '';
18427: }
18428: $cloneableonlyform = '<span class="LC_nobreak"><label><input type="radio" name="cloneableonly" value="1" '.$cloneableon.'/> '.&mt('Required').'</label>'.(' 'x3).'<label><input type="radio" name="cloneableonly" value="" '.$cloneableoff.' /> '.&mt('No restriction').'</label></span>';
18429: if ($formname eq 'ccrs') {
1.1187 bisitz 18430: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18431: } else {
18432: $cloneabletitle = &mt('Cloneable by you');
18433: }
18434: }
18435: my $officialjs;
18436: if ($crstype eq 'Course') {
18437: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18438: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18439: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18440: if ($codedom) {
1.1181 raeburn 18441: $officialjs = 1;
18442: ($instcodeform,$jscript,$$numtitlesref) =
18443: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18444: $officialjs,$codetitlesref);
18445: if ($jscript) {
1.1182 raeburn 18446: $jscript = '<script type="text/javascript">'."\n".
18447: '// <![CDATA['."\n".
18448: $jscript."\n".
18449: '// ]]>'."\n".
18450: '</script>'."\n";
1.1181 raeburn 18451: }
18452: }
18453: if ($instcodeform eq '') {
18454: $instcodeform =
18455: '<input type="text" name="instcodefilter" size="10" value="'.
18456: $list->{'instcodefilter'}.'" />';
18457: $instcodetitle = $lt{'ins'};
18458: } else {
18459: $instcodetitle = $lt{'inc'};
18460: }
18461: if ($fixeddom) {
18462: $instcodetitle .= '<br />('.$codedom.')';
18463: }
18464: }
18465: }
18466: my $output = qq|
18467: <form method="post" name="filterpicker" action="$action">
18468: <input type="hidden" name="form" value="$formname" />
18469: |;
18470: if ($formname eq 'modifycourse') {
18471: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18472: '<input type="hidden" name="prevphase" value="'.
18473: $prevphase.'" />'."\n";
1.1198 musolffc 18474: } elsif ($formname eq 'quotacheck') {
18475: $output .= qq|
18476: <input type="hidden" name="sortby" value="" />
18477: <input type="hidden" name="sortorder" value="" />
18478: |;
18479: } else {
1.1181 raeburn 18480: my $name_input;
18481: if ($cnameelement ne '') {
18482: $name_input = '<input type="hidden" name="cnameelement" value="'.
18483: $cnameelement.'" />';
18484: }
18485: $output .= qq|
1.1182 raeburn 18486: <input type="hidden" name="cnumelement" value="$cnumelement" />
18487: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18488: $name_input
18489: $roleelement
18490: $multelement
18491: $typeelement
18492: |;
18493: if ($formname eq 'portform') {
18494: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18495: }
18496: }
18497: if ($fixeddom) {
18498: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18499: }
18500: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18501: if ($sincefilterform) {
18502: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18503: .$sincefilterform
18504: .&Apache::lonhtmlcommon::row_closure();
18505: }
18506: if ($createdfilterform) {
18507: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18508: .$createdfilterform
18509: .&Apache::lonhtmlcommon::row_closure();
18510: }
18511: if ($domainselectform) {
18512: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18513: .$domainselectform
18514: .&Apache::lonhtmlcommon::row_closure();
18515: }
18516: if ($typeselectform) {
18517: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18518: $output .= $typeselectform;
18519: } else {
18520: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18521: .$typeselectform
18522: .&Apache::lonhtmlcommon::row_closure();
18523: }
18524: }
18525: if ($instcodeform) {
18526: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18527: .$instcodeform
18528: .&Apache::lonhtmlcommon::row_closure();
18529: }
18530: if (exists($filter->{'ownerfilter'})) {
18531: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18532: '<table><tr><td>'.&mt('Username').'<br />'.
18533: '<input type="text" name="ownerfilter" size="20" value="'.
18534: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18535: $ownerdomselectform.'</td></tr></table>'.
18536: &Apache::lonhtmlcommon::row_closure();
18537: }
18538: if (exists($filter->{'personfilter'})) {
18539: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18540: '<table><tr><td>'.&mt('Username').'<br />'.
18541: '<input type="text" name="personfilter" size="20" value="'.
18542: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18543: $persondomselectform.'</td></tr></table>'.
18544: &Apache::lonhtmlcommon::row_closure();
18545: }
18546: if (exists($filter->{'coursefilter'})) {
18547: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18548: .'<input type="text" name="coursefilter" size="25" value="'
18549: .$list->{'coursefilter'}.'" />'
18550: .&Apache::lonhtmlcommon::row_closure();
18551: }
18552: if ($cloneableonlyform) {
18553: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18554: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18555: }
18556: if (exists($filter->{'descriptfilter'})) {
18557: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18558: .'<input type="text" name="descriptfilter" size="40" value="'
18559: .$list->{'descriptfilter'}.'" />'
18560: .&Apache::lonhtmlcommon::row_closure(1);
18561: }
18562: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18563: '<input type="hidden" name="updater" value="" />'."\n".
18564: '<input type="submit" name="gosearch" value="'.
18565: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18566: return $jscript.$clonewarning.$output;
18567: }
18568:
18569: =pod
18570:
18571: =item * &timebased_select_form()
18572:
1.1182 raeburn 18573: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18574: filter e.g., Course Activity, Course Created, when searching for courses
18575: or communities
18576:
18577: Inputs:
18578:
18579: item - name of form element (sincefilter or createdfilter)
18580:
18581: filter - anonymous hash of criteria and their values
18582:
18583: Returns: HTML for a select box contained a blank, then six time selections,
18584: with value set in incoming form variables currently selected.
18585:
18586: Side Effects: None
18587:
18588: =cut
18589:
18590: sub timebased_select_form {
18591: my ($item,$filter) = @_;
18592: if (ref($filter) eq 'HASH') {
18593: $filter->{$item} =~ s/[^\d-]//g;
18594: if (!$filter->{$item}) { $filter->{$item}=-1; }
18595: return &select_form(
18596: $filter->{$item},
18597: $item,
18598: { '-1' => '',
18599: '86400' => &mt('today'),
18600: '604800' => &mt('last week'),
18601: '2592000' => &mt('last month'),
18602: '7776000' => &mt('last three months'),
18603: '15552000' => &mt('last six months'),
18604: '31104000' => &mt('last year'),
18605: 'select_form_order' =>
18606: ['-1','86400','604800','2592000','7776000',
18607: '15552000','31104000']});
18608: }
18609: }
18610:
18611: =pod
18612:
18613: =item * &js_changer()
18614:
18615: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18616: when course type or domain is changed, and also to hide 'Searching ...' on
18617: page load completion for page showing search result.
1.1181 raeburn 18618:
18619: Inputs: None
18620:
1.1183 raeburn 18621: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18622:
18623: Side Effects: None
18624:
18625: =cut
18626:
18627: sub js_changer {
18628: return <<ENDJS;
18629: <script type="text/javascript">
18630: // <![CDATA[
18631: function updateFilters(caller) {
18632: if (typeof(caller) != "undefined") {
18633: document.filterpicker.updater.value = caller.name;
18634: }
18635: document.filterpicker.submit();
18636: }
1.1183 raeburn 18637:
18638: function hideSearching() {
18639: if (document.getElementById('searching')) {
18640: document.getElementById('searching').style.display = 'none';
18641: }
18642: return;
18643: }
18644:
1.1181 raeburn 18645: // ]]>
18646: </script>
18647:
18648: ENDJS
18649: }
18650:
18651: =pod
18652:
1.1182 raeburn 18653: =item * &search_courses()
18654:
18655: Process selected filters form course search form and pass to lonnet::courseiddump
18656: to retrieve a hash for which keys are courseIDs which match the selected filters.
18657:
18658: Inputs:
18659:
18660: dom - domain being searched
18661:
18662: type - course type ('Course' or 'Community' or '.' if any).
18663:
18664: filter - anonymous hash of criteria and their values
18665:
18666: numtitles - for institutional codes - number of categories
18667:
18668: cloneruname - optional username of new course owner
18669:
18670: clonerudom - optional domain of new course owner
18671:
1.1221 raeburn 18672: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18673: (used when DC is using course creation form)
18674:
18675: codetitles - reference to array of titles of components in institutional codes (official courses).
18676:
1.1221 raeburn 18677: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18678: (and so can clone automatically)
18679:
18680: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18681:
18682: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18683: courses to clone
1.1182 raeburn 18684:
18685: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18686:
18687:
18688: Side Effects: None
18689:
18690: =cut
18691:
18692:
18693: sub search_courses {
1.1221 raeburn 18694: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18695: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18696: my (%courses,%showcourses,$cloner);
18697: if (($filter->{'ownerfilter'} ne '') ||
18698: ($filter->{'ownerdomfilter'} ne '')) {
18699: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18700: $filter->{'ownerdomfilter'};
18701: }
18702: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18703: if (!$filter->{$item}) {
18704: $filter->{$item}='.';
18705: }
18706: }
18707: my $now = time;
18708: my $timefilter =
18709: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18710: my ($createdbefore,$createdafter);
18711: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18712: $createdbefore = $now;
18713: $createdafter = $now-$filter->{'createdfilter'};
18714: }
18715: my ($instcodefilter,$regexpok);
18716: if ($numtitles) {
18717: if ($env{'form.official'} eq 'on') {
18718: $instcodefilter =
18719: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18720: $regexpok = 1;
18721: } elsif ($env{'form.official'} eq 'off') {
18722: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18723: unless ($instcodefilter eq '') {
18724: $regexpok = -1;
18725: }
18726: }
18727: } else {
18728: $instcodefilter = $filter->{'instcodefilter'};
18729: }
18730: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18731: if ($type eq '') { $type = '.'; }
18732:
18733: if (($clonerudom ne '') && ($cloneruname ne '')) {
18734: $cloner = $cloneruname.':'.$clonerudom;
18735: }
18736: %courses = &Apache::lonnet::courseiddump($dom,
18737: $filter->{'descriptfilter'},
18738: $timefilter,
18739: $instcodefilter,
18740: $filter->{'combownerfilter'},
18741: $filter->{'coursefilter'},
18742: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18743: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18744: $filter->{'cloneableonly'},
18745: $createdbefore,$createdafter,undef,
1.1221 raeburn 18746: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18747: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18748: my $ccrole;
18749: if ($type eq 'Community') {
18750: $ccrole = 'co';
18751: } else {
18752: $ccrole = 'cc';
18753: }
18754: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18755: $filter->{'persondomfilter'},
18756: 'userroles',undef,
18757: [$ccrole,'in','ad','ep','ta','cr'],
18758: $dom);
18759: foreach my $role (keys(%rolehash)) {
18760: my ($cnum,$cdom,$courserole) = split(':',$role);
18761: my $cid = $cdom.'_'.$cnum;
18762: if (exists($courses{$cid})) {
18763: if (ref($courses{$cid}) eq 'HASH') {
18764: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18765: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18766: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18767: }
18768: } else {
18769: $courses{$cid}{roles} = [$courserole];
18770: }
18771: $showcourses{$cid} = $courses{$cid};
18772: }
18773: }
18774: }
18775: %courses = %showcourses;
18776: }
18777: return %courses;
18778: }
18779:
18780: =pod
18781:
1.1181 raeburn 18782: =back
18783:
1.1207 raeburn 18784: =head1 Routines for version requirements for current course.
18785:
18786: =over 4
18787:
18788: =item * &check_release_required()
18789:
18790: Compares required LON-CAPA version with version on server, and
18791: if required version is newer looks for a server with the required version.
18792:
18793: Looks first at servers in user's owen domain; if none suitable, looks at
18794: servers in course's domain are permitted to host sessions for user's domain.
18795:
18796: Inputs:
18797:
18798: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18799:
18800: $courseid - Course ID of current course
18801:
18802: $rolecode - User's current role in course (for switchserver query string).
18803:
18804: $required - LON-CAPA version needed by course (format: Major.Minor).
18805:
18806:
18807: Returns:
18808:
18809: $switchserver - query string tp append to /adm/switchserver call (if
18810: current server's LON-CAPA version is too old.
18811:
18812: $warning - Message is displayed if no suitable server could be found.
18813:
18814: =cut
18815:
18816: sub check_release_required {
18817: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18818: my ($switchserver,$warning);
18819: if ($required ne '') {
18820: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18821: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18822: if ($reqdmajor ne '' && $reqdminor ne '') {
18823: my $otherserver;
18824: if (($major eq '' && $minor eq '') ||
18825: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18826: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18827: my $switchlcrev =
18828: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18829: $userdomserver);
18830: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18831: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18832: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18833: my $cdom = $env{'course.'.$courseid.'.domain'};
18834: if ($cdom ne $env{'user.domain'}) {
18835: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18836: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18837: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18838: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18839: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18840: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18841: my $canhost =
18842: &Apache::lonnet::can_host_session($env{'user.domain'},
18843: $coursedomserver,
18844: $remoterev,
18845: $udomdefaults{'remotesessions'},
18846: $defdomdefaults{'hostedsessions'});
18847:
18848: if ($canhost) {
18849: $otherserver = $coursedomserver;
18850: } else {
18851: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
18852: }
18853: } else {
18854: $warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).'<br />'.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
18855: }
18856: } else {
18857: $otherserver = $userdomserver;
18858: }
18859: }
18860: if ($otherserver ne '') {
18861: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18862: }
18863: }
18864: }
18865: return ($switchserver,$warning);
18866: }
18867:
18868: =pod
18869:
18870: =item * &check_release_result()
18871:
18872: Inputs:
18873:
18874: $switchwarning - Warning message if no suitable server found to host session.
18875:
18876: $switchserver - query string to append to /adm/switchserver containing lonHostID
18877: and current role.
18878:
18879: Returns: HTML to display with information about requirement to switch server.
18880: Either displaying warning with link to Roles/Courses screen or
18881: display link to switchserver.
18882:
1.1181 raeburn 18883: =cut
18884:
1.1207 raeburn 18885: sub check_release_result {
18886: my ($switchwarning,$switchserver) = @_;
18887: my $output = &start_page('Selected course unavailable on this server').
18888: '<p class="LC_warning">';
18889: if ($switchwarning) {
18890: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18891: if (&show_course()) {
18892: $output .= &mt('Display courses');
18893: } else {
18894: $output .= &mt('Display roles');
18895: }
18896: $output .= '</a>';
18897: } elsif ($switchserver) {
18898: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18899: '<br />'.
18900: '<a href="/adm/switchserver?'.$switchserver.'">'.
18901: &mt('Switch Server').
18902: '</a>';
18903: }
18904: $output .= '</p>'.&end_page();
18905: return $output;
18906: }
18907:
18908: =pod
18909:
18910: =item * &needs_coursereinit()
18911:
18912: Determine if course contents stored for user's session needs to be
18913: refreshed, because content has changed since "Big Hash" last tied.
18914:
18915: Check for change is made if time last checked is more than 10 minutes ago
18916: (by default).
18917:
18918: Inputs:
18919:
18920: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18921:
18922: $interval (optional) - Time which may elapse (in s) between last check for content
18923: change in current course. (default: 600 s).
18924:
18925: Returns: an array; first element is:
18926:
18927: =over 4
18928:
18929: 'switch' - if content updates mean user's session
18930: needs to be switched to a server running a newer LON-CAPA version
18931:
18932: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18933: on current server hosting user's session
18934:
18935: '' - if no action required.
18936:
18937: =back
18938:
18939: If first item element is 'switch':
18940:
18941: second item is $switchwarning - Warning message if no suitable server found to host session.
18942:
18943: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18944: and current role.
18945:
18946: otherwise: no other elements returned.
18947:
18948: =back
18949:
18950: =cut
18951:
18952: sub needs_coursereinit {
18953: my ($loncaparev,$interval) = @_;
18954: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18955: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18956: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18957: my $now = time;
18958: if ($interval eq '') {
18959: $interval = 600;
18960: }
18961: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18962: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18963: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18964: if ($blocked) {
18965: return ();
18966: }
1.1391 raeburn 18967: my $update;
18968: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18969: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
18970: if ($lastmainchange > $env{'request.course.tied'}) {
18971: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18972: if ($needswitch) {
18973: return ('switch',$switchwarning,$switchserver);
18974: }
18975: $update = 'main';
18976: }
18977: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
18978: if ($update) {
18979: $update = 'both';
18980: } else {
18981: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18982: if ($needswitch) {
18983: return ('switch',$switchwarning,$switchserver);
18984: } else {
18985: $update = 'supp';
1.1207 raeburn 18986: }
18987: }
1.1391 raeburn 18988: return ($update);
18989: }
18990: }
18991: return ();
18992: }
18993:
18994: sub switch_for_update {
18995: my ($loncaparev,$cdom,$cnum) = @_;
18996: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18997: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
18998: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
18999: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19000: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19001: $curr_reqd_hash{'internal.releaserequired'}});
19002: my ($switchserver,$switchwarning) =
19003: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19004: $curr_reqd_hash{'internal.releaserequired'});
19005: if ($switchwarning ne '' || $switchserver ne '') {
19006: return ('switch',$switchwarning,$switchserver);
19007: }
1.1207 raeburn 19008: }
19009: }
19010: return ();
19011: }
1.1181 raeburn 19012:
1.1083 raeburn 19013: sub update_content_constraints {
1.1395 raeburn 19014: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19015: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19016: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19017: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19018: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19019: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19020: if ($item eq 'resourcetag') {
19021: if ($name eq 'responsetype') {
19022: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19023: }
1.1307 raeburn 19024: } elsif ($item eq 'course') {
19025: if ($name eq 'courserestype') {
19026: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19027: }
1.1083 raeburn 19028: }
19029: }
19030: my $navmap = Apache::lonnavmaps::navmap->new();
19031: if (defined($navmap)) {
1.1307 raeburn 19032: my (%allresponses,%allcrsrestypes);
19033: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19034: if ($res->is_tool()) {
19035: if ($allcrsrestypes{'exttool'}) {
19036: $allcrsrestypes{'exttool'} ++;
19037: } else {
19038: $allcrsrestypes{'exttool'} = 1;
19039: }
19040: next;
19041: }
1.1083 raeburn 19042: my %responses = $res->responseTypes();
19043: foreach my $key (keys(%responses)) {
19044: next unless(exists($checkresponsetypes{$key}));
19045: $allresponses{$key} += $responses{$key};
19046: }
19047: }
19048: foreach my $key (keys(%allresponses)) {
19049: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19050: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19051: ($reqdmajor,$reqdminor) = ($major,$minor);
19052: }
19053: }
1.1307 raeburn 19054: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19055: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19056: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19057: ($reqdmajor,$reqdminor) = ($major,$minor);
19058: }
19059: }
1.1083 raeburn 19060: undef($navmap);
19061: }
1.1391 raeburn 19062: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19063: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19064: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19065: ($reqdmajor,$reqdminor) = ($major,$minor);
19066: }
19067: }
1.1083 raeburn 19068: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19069: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19070: }
19071: return;
19072: }
19073:
1.1110 raeburn 19074: sub allmaps_incourse {
19075: my ($cdom,$cnum,$chome,$cid) = @_;
19076: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19077: $cid = $env{'request.course.id'};
19078: $cdom = $env{'course.'.$cid.'.domain'};
19079: $cnum = $env{'course.'.$cid.'.num'};
19080: $chome = $env{'course.'.$cid.'.home'};
19081: }
19082: my %allmaps = ();
19083: my $lastchange =
19084: &Apache::lonnet::get_coursechange($cdom,$cnum);
19085: if ($lastchange > $env{'request.course.tied'}) {
19086: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19087: unless ($ferr) {
1.1395 raeburn 19088: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19089: }
19090: }
19091: my $navmap = Apache::lonnavmaps::navmap->new();
19092: if (defined($navmap)) {
19093: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19094: $allmaps{$res->src()} = 1;
19095: }
19096: }
19097: return \%allmaps;
19098: }
19099:
1.1083 raeburn 19100: sub parse_supplemental_title {
19101: my ($title) = @_;
19102:
19103: my ($foldertitle,$renametitle);
19104: if ($title =~ /&&&/) {
19105: $title = &HTML::Entites::decode($title);
19106: }
19107: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19108: $renametitle=$4;
19109: my ($time,$uname,$udom) = ($1,$2,$3);
19110: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19111: my $name = &plainname($uname,$udom);
19112: $name = &HTML::Entities::encode($name,'"<>&\'');
19113: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19114: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19115: if ($foldertitle ne '') {
1.1401 raeburn 19116: $title .= ': <br />'.$foldertitle;
19117: }
1.1083 raeburn 19118: }
19119: if (wantarray) {
19120: return ($title,$foldertitle,$renametitle);
19121: }
19122: return $title;
19123: }
19124:
1.1395 raeburn 19125: sub get_supplemental {
19126: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19127: my $hashid=$cnum.':'.$cdom;
19128: my ($supplemental,$cached,$set_httprefs);
19129: unless ($ignorecache) {
19130: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19131: }
19132: unless (defined($cached)) {
19133: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19134: unless ($chome eq 'no_host') {
19135: my @order = @LONCAPA::map::order;
19136: my @resources = @LONCAPA::map::resources;
19137: my @resparms = @LONCAPA::map::resparms;
19138: my @zombies = @LONCAPA::map::zombies;
19139: my ($errors,%ids,%hidden);
19140: $errors =
19141: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19142: $errors,$possdel,\%ids,\%hidden);
19143: @LONCAPA::map::order = @order;
19144: @LONCAPA::map::resources = @resources;
19145: @LONCAPA::map::resparms = @resparms;
19146: @LONCAPA::map::zombies = @zombies;
19147: $set_httprefs = 1;
19148: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19149: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19150: }
19151: $supplemental = {
19152: ids => \%ids,
19153: hidden => \%hidden,
19154: };
19155: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19156: }
19157: }
19158: return ($supplemental,$set_httprefs);
19159: }
19160:
1.1143 raeburn 19161: sub recurse_supplemental {
1.1391 raeburn 19162: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19163: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19164: my $mapnum;
19165: if ($suppmap eq 'supplemental.sequence') {
19166: $mapnum = 0;
19167: } else {
19168: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19169: }
1.1143 raeburn 19170: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19171: if ($fatal) {
19172: $errors ++;
19173: } else {
1.1389 raeburn 19174: my @order = @LONCAPA::map::order;
19175: if (@order > 0) {
19176: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19177: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19178: foreach my $idx (@order) {
19179: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19180: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19181: my $id = $mapnum.':'.$idx;
19182: push(@{$suppids->{$src}},$id);
19183: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19184: $hiddensupp->{$id} = 1;
19185: }
1.1146 raeburn 19186: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19187: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19188: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19189: } else {
1.1391 raeburn 19190: my $allowed;
19191: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19192: $allowed = 1;
19193: } elsif ($possdel) {
19194: foreach my $item (@{$suppids->{$src}}) {
19195: next if ($item eq $id);
19196: unless ($hiddensupp->{$item}) {
19197: $allowed = 1;
19198: last;
19199: }
19200: }
19201: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19202: &Apache::lonnet::delenv('httpref.'.$src);
19203: }
19204: }
19205: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19206: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19207: }
1.1143 raeburn 19208: }
19209: }
19210: }
19211: }
19212: }
19213: }
1.1391 raeburn 19214: return $errors;
19215: }
19216:
19217: sub set_supp_httprefs {
19218: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19219: if (ref($supplemental) eq 'HASH') {
19220: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19221: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19222: next if ($src =~ /\.sequence$/);
19223: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19224: my $allowed;
19225: if ($env{'request.role.adv'}) {
19226: $allowed = 1;
19227: } else {
19228: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19229: unless ($supplemental->{'hidden'}->{$id}) {
19230: $allowed = 1;
19231: last;
19232: }
19233: }
19234: }
19235: if (exists($env{'httpref.'.$src})) {
19236: if ($possdel) {
19237: unless ($allowed) {
19238: &Apache::lonnet::delenv('httpref.'.$src);
19239: }
19240: }
19241: } elsif ($allowed) {
19242: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19243: }
19244: }
19245: }
19246: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19247: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19248: }
19249: }
19250: }
19251: }
19252:
19253: sub get_supp_parameter {
19254: my ($resparm,$name)=@_;
19255: return if ($resparm eq '');
19256: my $value=undef;
19257: my $ptype=undef;
19258: foreach (split('&&&',$resparm)) {
19259: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19260: if ($thisname eq $name) {
19261: $value=$thisvalue;
19262: $ptype=$thistype;
19263: }
19264: }
19265: return $value;
1.1143 raeburn 19266: }
19267:
1.1101 raeburn 19268: sub symb_to_docspath {
1.1267 raeburn 19269: my ($symb,$navmapref) = @_;
19270: return unless ($symb && ref($navmapref));
1.1101 raeburn 19271: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19272: if ($resurl=~/\.(sequence|page)$/) {
19273: $mapurl=$resurl;
19274: } elsif ($resurl eq 'adm/navmaps') {
19275: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19276: }
19277: my $mapresobj;
1.1267 raeburn 19278: unless (ref($$navmapref)) {
19279: $$navmapref = Apache::lonnavmaps::navmap->new();
19280: }
19281: if (ref($$navmapref)) {
19282: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19283: }
19284: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19285: my $type=$2;
19286: my $path;
19287: if (ref($mapresobj)) {
19288: my $pcslist = $mapresobj->map_hierarchy();
19289: if ($pcslist ne '') {
19290: foreach my $pc (split(/,/,$pcslist)) {
19291: next if ($pc <= 1);
1.1267 raeburn 19292: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19293: if (ref($res)) {
19294: my $thisurl = $res->src();
19295: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19296: my $thistitle = $res->title();
19297: $path .= '&'.
19298: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19299: &escape($thistitle).
1.1101 raeburn 19300: ':'.$res->randompick().
19301: ':'.$res->randomout().
19302: ':'.$res->encrypted().
19303: ':'.$res->randomorder().
19304: ':'.$res->is_page();
19305: }
19306: }
19307: }
19308: $path =~ s/^\&//;
19309: my $maptitle = $mapresobj->title();
19310: if ($mapurl eq 'default') {
1.1129 raeburn 19311: $maptitle = 'Main Content';
1.1101 raeburn 19312: }
19313: $path .= (($path ne '')? '&' : '').
19314: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19315: &escape($maptitle).
1.1101 raeburn 19316: ':'.$mapresobj->randompick().
19317: ':'.$mapresobj->randomout().
19318: ':'.$mapresobj->encrypted().
19319: ':'.$mapresobj->randomorder().
19320: ':'.$mapresobj->is_page();
19321: } else {
19322: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19323: my $ispage = (($type eq 'page')? 1 : '');
19324: if ($mapurl eq 'default') {
1.1129 raeburn 19325: $maptitle = 'Main Content';
1.1101 raeburn 19326: }
19327: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19328: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19329: }
19330: unless ($mapurl eq 'default') {
19331: $path = 'default&'.
1.1146 raeburn 19332: &escape('Main Content').
1.1101 raeburn 19333: ':::::&'.$path;
19334: }
19335: return $path;
19336: }
19337:
1.1393 raeburn 19338: sub validate_folderpath {
19339: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19340: if ($env{'form.folderpath'} ne '') {
19341: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19342: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19343: for (my $i=0; $i<@items; $i++) {
19344: my $odd = $i%2;
19345: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19346: $badpath = 1;
1.1394 raeburn 19347: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19348: my $idx = $i-1;
1.1394 raeburn 19349: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19350: my $esc_name = $1;
19351: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19352: $supppath .= '&'.$esc_name;
19353: $changed = 1;
19354: } else {
19355: $supppath .= '&'.$items[$i];
19356: }
19357: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19358: $changed = 1;
1.1393 raeburn 19359: my $is_hidden;
19360: unless ($got_supp) {
1.1395 raeburn 19361: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19362: if (ref($supplemental) eq 'HASH') {
19363: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19364: %supphidden = %{$supplemental->{'hidden'}};
19365: }
19366: if (ref($supplemental->{'ids'}) eq 'HASH') {
19367: %suppids = %{$supplemental->{'ids'}};
19368: }
19369: }
19370: $got_supp = 1;
19371: }
19372: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19373: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19374: if ($supphidden{$mapid}) {
19375: $is_hidden = 1;
19376: }
19377: }
1.1394 raeburn 19378: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19379: } else {
19380: $supppath .= '&'.$items[$i];
1.1393 raeburn 19381: }
19382: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19383: $badpath = 1;
1.1394 raeburn 19384: } elsif ($supplementalflag) {
1.1393 raeburn 19385: $supppath .= '&'.$items[$i];
19386: }
19387: last if ($badpath);
19388: }
19389: if ($badpath) {
19390: delete($env{'form.folderpath'});
1.1394 raeburn 19391: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19392: $supppath =~ s/^\&//;
19393: $env{'form.folderpath'} = $supppath;
19394: }
19395: }
19396: return;
19397: }
19398:
1.1094 raeburn 19399: sub captcha_display {
1.1327 raeburn 19400: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19401: my ($output,$error);
1.1234 raeburn 19402: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19403: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19404: if ($captcha eq 'original') {
1.1094 raeburn 19405: $output = &create_captcha();
19406: unless ($output) {
1.1172 raeburn 19407: $error = 'captcha';
1.1094 raeburn 19408: }
19409: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19410: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19411: unless ($output) {
1.1172 raeburn 19412: $error = 'recaptcha';
1.1094 raeburn 19413: }
19414: }
1.1234 raeburn 19415: return ($output,$error,$captcha,$version);
1.1094 raeburn 19416: }
19417:
19418: sub captcha_response {
1.1327 raeburn 19419: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19420: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19421: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19422: if ($captcha eq 'original') {
1.1094 raeburn 19423: ($captcha_chk,$captcha_error) = &check_captcha();
19424: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19425: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19426: } else {
19427: $captcha_chk = 1;
19428: }
19429: return ($captcha_chk,$captcha_error);
19430: }
19431:
19432: sub get_captcha_config {
1.1327 raeburn 19433: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19434: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19435: my $hostname = &Apache::lonnet::hostname($lonhost);
19436: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19437: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19438: if ($context eq 'usercreation') {
19439: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19440: if (ref($domconfig{$context}) eq 'HASH') {
19441: $hashtocheck = $domconfig{$context}{'cancreate'};
19442: if (ref($hashtocheck) eq 'HASH') {
19443: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19444: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19445: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19446: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19447: }
19448: if ($privkey && $pubkey) {
19449: $captcha = 'recaptcha';
1.1234 raeburn 19450: $version = $hashtocheck->{'recaptchaversion'};
19451: if ($version ne '2') {
19452: $version = 1;
19453: }
1.1095 raeburn 19454: } else {
19455: $captcha = 'original';
19456: }
19457: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19458: $captcha = 'original';
19459: }
1.1094 raeburn 19460: }
1.1095 raeburn 19461: } else {
19462: $captcha = 'captcha';
19463: }
19464: } elsif ($context eq 'login') {
19465: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19466: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19467: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19468: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19469: if ($privkey && $pubkey) {
19470: $captcha = 'recaptcha';
1.1234 raeburn 19471: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19472: if ($version ne '2') {
19473: $version = 1;
19474: }
1.1095 raeburn 19475: } else {
19476: $captcha = 'original';
1.1094 raeburn 19477: }
1.1095 raeburn 19478: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19479: $captcha = 'original';
1.1094 raeburn 19480: }
1.1327 raeburn 19481: } elsif ($context eq 'passwords') {
19482: if ($dom_in_effect) {
19483: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19484: if ($passwdconf{'captcha'} eq 'recaptcha') {
19485: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19486: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19487: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19488: }
19489: if ($privkey && $pubkey) {
19490: $captcha = 'recaptcha';
19491: $version = $passwdconf{'recaptchaversion'};
19492: if ($version ne '2') {
19493: $version = 1;
19494: }
19495: } else {
19496: $captcha = 'original';
19497: }
19498: } elsif ($passwdconf{'captcha'} ne 'notused') {
19499: $captcha = 'original';
19500: }
19501: }
19502: }
1.1234 raeburn 19503: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19504: }
19505:
19506: sub create_captcha {
19507: my %captcha_params = &captcha_settings();
19508: my ($output,$maxtries,$tries) = ('',10,0);
19509: while ($tries < $maxtries) {
19510: $tries ++;
19511: my $captcha = Authen::Captcha->new (
19512: output_folder => $captcha_params{'output_dir'},
19513: data_folder => $captcha_params{'db_dir'},
19514: );
19515: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19516:
19517: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19518: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19519: '<span class="LC_nobreak">'.
1.1094 raeburn 19520: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19521: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19522: '</span><br />'.
1.1176 raeburn 19523: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19524: last;
19525: }
19526: }
1.1323 raeburn 19527: if ($output eq '') {
19528: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19529: }
1.1094 raeburn 19530: return $output;
19531: }
19532:
19533: sub captcha_settings {
19534: my %captcha_params = (
19535: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19536: www_output_dir => "/captchaspool",
19537: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19538: numchars => '5',
19539: );
19540: return %captcha_params;
19541: }
19542:
19543: sub check_captcha {
19544: my ($captcha_chk,$captcha_error);
19545: my $code = $env{'form.code'};
19546: my $md5sum = $env{'form.crypt'};
19547: my %captcha_params = &captcha_settings();
19548: my $captcha = Authen::Captcha->new(
19549: output_folder => $captcha_params{'output_dir'},
19550: data_folder => $captcha_params{'db_dir'},
19551: );
1.1109 raeburn 19552: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19553: my %captcha_hash = (
19554: 0 => 'Code not checked (file error)',
19555: -1 => 'Failed: code expired',
19556: -2 => 'Failed: invalid code (not in database)',
19557: -3 => 'Failed: invalid code (code does not match crypt)',
19558: );
19559: if ($captcha_chk != 1) {
19560: $captcha_error = $captcha_hash{$captcha_chk}
19561: }
19562: return ($captcha_chk,$captcha_error);
19563: }
19564:
19565: sub create_recaptcha {
1.1234 raeburn 19566: my ($pubkey,$version) = @_;
19567: if ($version >= 2) {
1.1367 raeburn 19568: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19569: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19570: } else {
19571: my $use_ssl;
19572: if ($ENV{'SERVER_PORT'} == 443) {
19573: $use_ssl = 1;
19574: }
19575: my $captcha = Captcha::reCAPTCHA->new;
19576: return $captcha->get_options_setter({theme => 'white'})."\n".
19577: $captcha->get_html($pubkey,undef,$use_ssl).
19578: &mt('If the text is hard to read, [_1] will replace them.',
19579: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19580: '<br /><br />';
19581: }
1.1094 raeburn 19582: }
19583:
19584: sub check_recaptcha {
1.1234 raeburn 19585: my ($privkey,$version) = @_;
1.1094 raeburn 19586: my $captcha_chk;
1.1350 raeburn 19587: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19588: if ($version >= 2) {
19589: my %info = (
19590: secret => $privkey,
19591: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19592: remoteip => $ip,
1.1234 raeburn 19593: );
1.1280 raeburn 19594: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19595: $request->content(join('&',map {
19596: my $name = escape($_);
19597: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19598: ? join("&$name=", map {escape($_) } @{$info{$_}})
19599: : &escape($info{$_}) );
19600: } keys(%info)));
19601: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19602: if ($response->is_success) {
19603: my $data = JSON::DWIW->from_json($response->decoded_content);
19604: if (ref($data) eq 'HASH') {
19605: if ($data->{'success'}) {
19606: $captcha_chk = 1;
19607: }
19608: }
19609: }
19610: } else {
19611: my $captcha = Captcha::reCAPTCHA->new;
19612: my $captcha_result =
19613: $captcha->check_answer(
19614: $privkey,
1.1350 raeburn 19615: $ip,
1.1234 raeburn 19616: $env{'form.recaptcha_challenge_field'},
19617: $env{'form.recaptcha_response_field'},
19618: );
19619: if ($captcha_result->{is_valid}) {
19620: $captcha_chk = 1;
19621: }
1.1094 raeburn 19622: }
19623: return $captcha_chk;
19624: }
19625:
1.1174 raeburn 19626: sub emailusername_info {
1.1244 raeburn 19627: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19628: my %titles = &Apache::lonlocal::texthash (
19629: lastname => 'Last Name',
19630: firstname => 'First Name',
19631: institution => 'School/college/university',
19632: location => "School's city, state/province, country",
19633: web => "School's web address",
19634: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19635: id => 'Student/Employee ID',
1.1174 raeburn 19636: );
19637: return (\@fields,\%titles);
19638: }
19639:
1.1161 raeburn 19640: sub cleanup_html {
19641: my ($incoming) = @_;
19642: my $outgoing;
19643: if ($incoming ne '') {
19644: $outgoing = $incoming;
19645: $outgoing =~ s/;/;/g;
19646: $outgoing =~ s/\#/#/g;
19647: $outgoing =~ s/\&/&/g;
19648: $outgoing =~ s/</</g;
19649: $outgoing =~ s/>/>/g;
19650: $outgoing =~ s/\(/(/g;
19651: $outgoing =~ s/\)/)/g;
19652: $outgoing =~ s/"/"/g;
19653: $outgoing =~ s/'/'/g;
19654: $outgoing =~ s/\$/$/g;
19655: $outgoing =~ s{/}{/}g;
19656: $outgoing =~ s/=/=/g;
19657: $outgoing =~ s/\\/\/g
19658: }
19659: return $outgoing;
19660: }
19661:
1.1190 musolffc 19662: # Checks for critical messages and returns a redirect url if one exists.
19663: # $interval indicates how often to check for messages.
1.1282 raeburn 19664: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19665: sub critical_redirect {
1.1282 raeburn 19666: my ($interval,$context) = @_;
1.1356 raeburn 19667: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19668: return ();
19669: }
1.1190 musolffc 19670: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19671: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19672: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19673: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19674: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19675: if ($blocked) {
19676: my $checkrole = "cm./$cdom/$cnum";
19677: if ($env{'request.course.sec'} ne '') {
19678: $checkrole .= "/$env{'request.course.sec'}";
19679: }
19680: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19681: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19682: return;
19683: }
19684: }
19685: }
1.1190 musolffc 19686: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19687: $env{'user.name'});
19688: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19689: my $redirecturl;
1.1190 musolffc 19690: if ($what[0]) {
1.1356 raeburn 19691: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19692: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19693: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19694: return (1, $url);
1.1190 musolffc 19695: }
1.1191 raeburn 19696: }
19697: }
19698: return ();
1.1190 musolffc 19699: }
19700:
1.1174 raeburn 19701: # Use:
19702: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19703: #
19704: ##################################################
19705: # password associated functions #
19706: ##################################################
19707: sub des_keys {
19708: # Make a new key for DES encryption.
19709: # Each key has two parts which are returned separately.
19710: # Please note: Each key must be passed through the &hex function
19711: # before it is output to the web browser. The hex versions cannot
19712: # be used to decrypt.
19713: my @hexstr=('0','1','2','3','4','5','6','7',
19714: '8','9','a','b','c','d','e','f');
19715: my $lkey='';
19716: for (0..7) {
19717: $lkey.=$hexstr[rand(15)];
19718: }
19719: my $ukey='';
19720: for (0..7) {
19721: $ukey.=$hexstr[rand(15)];
19722: }
19723: return ($lkey,$ukey);
19724: }
19725:
19726: sub des_decrypt {
19727: my ($key,$cyphertext) = @_;
19728: my $keybin=pack("H16",$key);
19729: my $cypher;
19730: if ($Crypt::DES::VERSION>=2.03) {
19731: $cypher=new Crypt::DES $keybin;
19732: } else {
19733: $cypher=new DES $keybin;
19734: }
1.1233 raeburn 19735: my $plaintext='';
19736: my $cypherlength = length($cyphertext);
19737: my $numchunks = int($cypherlength/32);
19738: for (my $j=0; $j<$numchunks; $j++) {
19739: my $start = $j*32;
19740: my $cypherblock = substr($cyphertext,$start,32);
19741: my $chunk =
19742: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19743: $chunk .=
19744: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19745: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19746: $plaintext .= $chunk;
19747: }
1.1174 raeburn 19748: return $plaintext;
19749: }
19750:
1.1344 raeburn 19751: sub get_requested_shorturls {
1.1309 raeburn 19752: my ($cdom,$cnum,$navmap) = @_;
19753: return unless (ref($navmap));
1.1344 raeburn 19754: my ($numnew,$errors);
1.1309 raeburn 19755: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19756: if (@toshorten) {
19757: my (%maps,%resources,%titles);
19758: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19759: 'shorturls',$cdom,$cnum);
19760: if (keys(%resources)) {
1.1344 raeburn 19761: my %tocreate;
1.1309 raeburn 19762: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19763: my $symb = $resources{$item};
19764: if ($symb) {
19765: $tocreate{$cnum.'&'.$symb} = 1;
19766: }
19767: }
1.1344 raeburn 19768: if (keys(%tocreate)) {
19769: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19770: \%tocreate);
19771: }
1.1309 raeburn 19772: }
1.1344 raeburn 19773: }
19774: return ($numnew,$errors);
19775: }
19776:
19777: sub make_short_symbs {
19778: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19779: my ($numnew,@errors);
19780: if (ref($tocreateref) eq 'HASH') {
19781: my %tocreate = %{$tocreateref};
1.1309 raeburn 19782: if (keys(%tocreate)) {
19783: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19784: my $su = Short::URL->new(no_vowels => 1);
19785: my $init = '';
19786: my (%newunique,%addcourse,%courseonly,%failed);
19787: # get lock on tiny db
19788: my $now = time;
1.1344 raeburn 19789: if ($lockuser eq '') {
19790: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19791: }
1.1309 raeburn 19792: my $lockhash = {
1.1344 raeburn 19793: "lock\0$now" => $lockuser,
1.1309 raeburn 19794: };
19795: my $tries = 0;
19796: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19797: my ($code,$error);
19798: while (($gotlock ne 'ok') && ($tries<3)) {
19799: $tries ++;
19800: sleep 1;
1.1319 raeburn 19801: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19802: }
19803: if ($gotlock eq 'ok') {
19804: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19805: \%addcourse,\%courseonly,\%failed);
19806: if (keys(%failed)) {
19807: my $numfailed = scalar(keys(%failed));
19808: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19809: }
19810: if (keys(%newunique)) {
19811: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19812: if ($putres eq 'ok') {
19813: $numnew = scalar(keys(%newunique));
19814: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19815: unless ($newputres eq 'ok') {
19816: push(@errors,&mt('error: could not store course look-up of short URLs'));
19817: }
19818: } else {
19819: push(@errors,&mt('error: could not store unique six character URLs'));
19820: }
19821: }
19822: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19823: unless ($dellockres eq 'ok') {
19824: push(@errors,&mt('error: could not release lockfile'));
19825: }
19826: } else {
19827: push(@errors,&mt('error: could not obtain lockfile'));
19828: }
19829: if (keys(%courseonly)) {
19830: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19831: if ($result ne 'ok') {
19832: push(@errors,&mt('error: could not update course look-up of short URLs'));
19833: }
19834: }
19835: }
19836: }
19837: return ($numnew,\@errors);
19838: }
19839:
19840: sub shorten_symbs {
19841: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19842: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19843: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19844: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19845: my (%possibles,%collisions);
19846: foreach my $key (keys(%{$tocreate})) {
19847: my $num = String::CRC32::crc32($key);
19848: my $tiny = $su->encode($num,$init);
19849: if ($tiny) {
19850: $possibles{$tiny} = $key;
19851: }
19852: }
19853: if (!$init) {
19854: $init = 1;
19855: } else {
19856: $init ++;
19857: }
19858: if (keys(%possibles)) {
19859: my @posstiny = keys(%possibles);
19860: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19861: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19862: if (keys(%currtiny)) {
19863: foreach my $key (keys(%currtiny)) {
19864: next if ($currtiny{$key} eq '');
19865: if ($currtiny{$key} eq $possibles{$key}) {
19866: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19867: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19868: $courseonly->{$tsymb} = $key;
19869: }
19870: } else {
19871: $collisions{$possibles{$key}} = 1;
19872: }
19873: delete($possibles{$key});
19874: }
19875: }
19876: foreach my $key (keys(%possibles)) {
19877: $newunique->{$key} = $possibles{$key};
19878: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19879: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19880: $addcourse->{$tsymb} = $key;
19881: }
19882: }
19883: }
19884: if (keys(%collisions)) {
19885: if ($init <5) {
19886: if (!$init) {
19887: $init = 1;
19888: } else {
19889: $init ++;
19890: }
19891: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19892: $newunique,$addcourse,$courseonly,$failed);
19893: } else {
19894: foreach my $key (keys(%collisions)) {
19895: $failed->{$key} = 1;
19896: }
19897: }
19898: }
19899: return $init;
19900: }
19901:
1.1328 raeburn 19902: sub is_nonframeable {
1.1329 raeburn 19903: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19904: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19905: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19906:
19907: $remprotocol = lc($remprotocol);
19908: $remhost = lc($remhost);
19909: my $remport = 80;
19910: if ($remprotocol eq 'https') {
19911: $remport = 443;
19912: }
1.1330 raeburn 19913: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19914: if ($cached) {
19915: unless ($nocache) {
19916: if ($result) {
19917: return 1;
19918: } else {
19919: return 0;
19920: }
19921: }
19922: }
1.1328 raeburn 19923: my $uselink;
19924: my $request = new HTTP::Request('HEAD',$url);
19925: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19926: if ($response->is_success()) {
19927: my $secpolicy = lc($response->header('content-security-policy'));
19928: my $xframeop = lc($response->header('x-frame-options'));
19929: $secpolicy =~ s/^\s+|\s+$//g;
19930: $xframeop =~ s/^\s+|\s+$//g;
19931: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19932: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19933: my ($origin,$protocol,$port);
19934: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19935: $port = $ENV{'SERVER_PORT'};
19936: } else {
19937: $port = 80;
19938: }
19939: if ($absolute eq '') {
19940: $protocol = 'http:';
19941: if ($port == 443) {
19942: $protocol = 'https:';
19943: }
19944: $origin = $protocol.'//'.lc($hostname);
19945: } else {
19946: $origin = lc($absolute);
19947: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19948: }
19949: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19950: my $framepolicy = $1;
19951: $framepolicy =~ s/^\s+|\s+$//g;
19952: my @policies = split(/\s+/,$framepolicy);
19953: if (@policies) {
19954: if (grep(/^\Q'none'\E$/,@policies)) {
19955: $uselink = 1;
19956: } else {
19957: $uselink = 1;
19958: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19959: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19960: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19961: undef($uselink);
19962: }
19963: if ($uselink) {
19964: if (grep(/^\Q'self'\E$/,@policies)) {
19965: if (($origin ne '') && ($remotehost eq $origin)) {
19966: undef($uselink);
19967: }
19968: }
19969: }
19970: if ($uselink) {
19971: my @possok;
19972: if ($ip ne '') {
19973: push(@possok,$ip);
19974: }
19975: my $hoststr = '';
19976: foreach my $part (reverse(split(/\./,$hostname))) {
19977: if ($hoststr eq '') {
19978: $hoststr = $part;
19979: } else {
19980: $hoststr = "$part.$hoststr";
19981: }
19982: if ($hoststr eq $hostname) {
19983: push(@possok,$hostname);
19984: } else {
19985: push(@possok,"*.$hoststr");
19986: }
19987: }
19988: if (@possok) {
19989: foreach my $poss (@possok) {
19990: last if (!$uselink);
19991: foreach my $policy (@policies) {
19992: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
19993: undef($uselink);
19994: last;
19995: }
19996: }
19997: }
19998: }
19999: }
20000: }
20001: }
20002: } elsif ($xframeop ne '') {
20003: $uselink = 1;
20004: my @policies = split(/\s*,\s*/,$xframeop);
20005: if (@policies) {
20006: unless (grep(/^deny$/,@policies)) {
20007: if ($origin ne '') {
20008: if (grep(/^sameorigin$/,@policies)) {
20009: if ($remotehost eq $origin) {
20010: undef($uselink);
20011: }
20012: }
20013: if ($uselink) {
20014: foreach my $policy (@policies) {
20015: if ($policy =~ /^allow-from\s*(.+)$/) {
20016: my $allowfrom = $1;
20017: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20018: undef($uselink);
20019: last;
20020: }
20021: }
20022: }
20023: }
20024: }
20025: }
20026: }
20027: }
20028: }
20029: }
1.1329 raeburn 20030: if ($nocache) {
20031: if ($cached) {
20032: my $devalidate;
20033: if ($uselink && !$result) {
20034: $devalidate = 1;
20035: } elsif (!$uselink && $result) {
20036: $devalidate = 1;
20037: }
20038: if ($devalidate) {
20039: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20040: }
20041: }
20042: } else {
20043: if ($uselink) {
20044: $result = 1;
20045: } else {
20046: $result = 0;
20047: }
20048: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20049: }
1.1328 raeburn 20050: return $uselink;
20051: }
20052:
1.1359 raeburn 20053: sub page_menu {
20054: my ($menucolls,$menunum) = @_;
20055: my %menu;
20056: foreach my $item (split(/;/,$menucolls)) {
20057: my ($num,$value) = split(/\%/,$item);
20058: if ($num eq $menunum) {
20059: my @entries = split(/\&/,$value);
20060: foreach my $entry (@entries) {
20061: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20062: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20063: $menu{$name} = $fields;
20064: } else {
20065: my @shown;
20066: if ($fields =~ /,/) {
20067: @shown = split(/,/,$fields);
20068: } else {
20069: @shown = ($fields);
20070: }
20071: if (@shown) {
20072: foreach my $field (@shown) {
20073: next if ($field eq '');
20074: $menu{$field} = 1;
20075: }
20076: }
20077: }
20078: }
20079: }
20080: }
20081: return %menu;
20082: }
20083:
1.112 bowersj2 20084: 1;
20085: __END__;
1.41 ng 20086:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>