Annotation of loncom/interface/loncommon.pm, revision 1.1445
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1445 ! raeburn 4: # $Id: loncommon.pm,v 1.1444 2024/12/31 19:28:29 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>
1.1445 ! raeburn 2479: <language>notset</language>
1.1426 raeburn 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') ||
1.1444 raeburn 5694: ($activity eq 'index') || ($activity eq 'boards') || ($activity eq 'groups') ||
5695: ($activity eq 'chat')) {
1.1372 raeburn 5696: if ($udom eq $cdom) {
5697: $check_ipaccess = 1;
5698: }
5699: }
5700: }
1.1375 raeburn 5701: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5702: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5703: my $checkrole;
5704: if ($env{'request.role.domain'} eq '') {
5705: $checkrole = "cm./$env{'user.domain'}/";
5706: } else {
5707: $checkrole = "cm./$env{'request.role.domain'}/";
5708: }
5709: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5710: $has_evb = 1;
5711: }
1.1372 raeburn 5712: }
5713: unless ($has_evb || $check_ipaccess) {
5714: my @machinedoms = &Apache::lonnet::current_machine_domains();
5715: if (($dom eq 'public') && ($activity eq 'port')) {
5716: $dom = $udom;
5717: }
5718: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5719: $check_ipaccess = 1;
5720: } else {
5721: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5722: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5723: my $prim = &Apache::lonnet::domain($dom,'primary');
5724: my $intdom = &Apache::lonnet::internet_dom($prim);
5725: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5726: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5727: $check_ipaccess = 1;
5728: }
5729: }
5730: }
5731: }
5732: if ($check_ipaccess) {
5733: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5734: unless (defined($cached)) {
5735: my %domconfig =
5736: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5737: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5738: }
5739: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5740: foreach my $id (keys(%{$ipaccessref})) {
5741: if (ref($ipaccessref->{$id}) eq 'HASH') {
5742: my $range = $ipaccessref->{$id}->{'ip'};
5743: if ($range) {
5744: if (&Apache::lonnet::ip_match($clientip,$range)) {
5745: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5746: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5747: return ('','','',$id,$dom);
5748: last;
5749: }
5750: }
5751: }
5752: }
5753: }
5754: }
5755: }
5756: }
1.1373 raeburn 5757: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5758: return ();
5759: }
1.1372 raeburn 5760: }
1.1189 raeburn 5761: if (defined($udom) && defined($uname)) {
5762: # If uname and udom are for a course, check for blocks in the course.
5763: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5764: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5765: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5766: return ($startblock,$endblock,$triggerblock);
5767: }
5768: } else {
1.490 raeburn 5769: $udom = $env{'user.domain'};
5770: $uname = $env{'user.name'};
5771: }
5772:
1.502 raeburn 5773: my $startblock = 0;
5774: my $endblock = 0;
1.1062 raeburn 5775: my $triggerblock = '';
1.1373 raeburn 5776: my %live_courses;
5777: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5778: %live_courses = &findallcourses(undef,$uname,$udom);
5779: }
1.474 raeburn 5780:
1.490 raeburn 5781: # If uname is for a user, and activity is course-specific, i.e.,
5782: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5783:
1.490 raeburn 5784: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5785: $activity eq 'groups' || $activity eq 'printout' ||
1.1444 raeburn 5786: $activity eq 'search' || $activity eq 'index' ||
5787: $activity eq 'reinit' || $activity eq 'alert') &&
1.1189 raeburn 5788: ($env{'request.course.id'})) {
1.490 raeburn 5789: foreach my $key (keys(%live_courses)) {
5790: if ($key ne $env{'request.course.id'}) {
5791: delete($live_courses{$key});
5792: }
5793: }
5794: }
5795:
5796: my $otheruser = 0;
5797: my %own_courses;
5798: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5799: # Resource belongs to user other than current user.
5800: $otheruser = 1;
5801: # Gather courses for current user
5802: %own_courses =
5803: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5804: }
5805:
5806: # Gather active course roles - course coordinator, instructor,
5807: # exam proctor, ta, student, or custom role.
1.474 raeburn 5808:
5809: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5810: my ($cdom,$cnum);
5811: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5812: $cdom = $env{'course.'.$course.'.domain'};
5813: $cnum = $env{'course.'.$course.'.num'};
5814: } else {
1.490 raeburn 5815: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5816: }
5817: my $no_ownblock = 0;
5818: my $no_userblock = 0;
1.533 raeburn 5819: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5820: # Check if current user has 'evb' priv for this
5821: if (defined($own_courses{$course})) {
5822: foreach my $sec (keys(%{$own_courses{$course}})) {
5823: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5824: if ($sec ne 'none') {
5825: $checkrole .= '/'.$sec;
5826: }
5827: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5828: $no_ownblock = 1;
5829: last;
5830: }
5831: }
5832: }
5833: # if they have 'evb' priv and are currently not playing student
5834: next if (($no_ownblock) &&
5835: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5836: }
1.474 raeburn 5837: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5838: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5839: if ($sec ne 'none') {
1.482 raeburn 5840: $checkrole .= '/'.$sec;
1.474 raeburn 5841: }
1.490 raeburn 5842: if ($otheruser) {
5843: # Resource belongs to user other than current user.
5844: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5845: my (%allroles,%userroles);
5846: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5847: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5848: my ($trole,$tdom,$tnum,$tsec);
5849: if ($entry =~ /^cr/) {
5850: ($trole,$tdom,$tnum,$tsec) =
5851: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5852: } else {
5853: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5854: }
5855: my ($spec,$area,$trest);
5856: $area = '/'.$tdom.'/'.$tnum;
5857: $trest = $tnum;
5858: if ($tsec ne '') {
5859: $area .= '/'.$tsec;
5860: $trest .= '/'.$tsec;
5861: }
5862: $spec = $trole.'.'.$area;
5863: if ($trole =~ /^cr/) {
5864: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5865: $tdom,$spec,$trest,$area);
5866: } else {
5867: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5868: $tdom,$spec,$trest,$area);
5869: }
5870: }
1.1276 raeburn 5871: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5872: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5873: if ($1) {
5874: $no_userblock = 1;
5875: last;
5876: }
1.486 raeburn 5877: }
5878: }
1.490 raeburn 5879: } else {
5880: # Resource belongs to current user
5881: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5882: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5883: $no_ownblock = 1;
5884: last;
5885: }
1.474 raeburn 5886: }
5887: }
5888: # if they have the evb priv and are currently not playing student
1.482 raeburn 5889: next if (($no_ownblock) &&
1.491 albertel 5890: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5891: next if ($no_userblock);
1.474 raeburn 5892:
1.1303 raeburn 5893: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5894: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5895:
1.1062 raeburn 5896: my ($start,$end,$trigger) =
1.1347 raeburn 5897: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5898: if (($start != 0) &&
5899: (($startblock == 0) || ($startblock > $start))) {
5900: $startblock = $start;
1.1062 raeburn 5901: if ($trigger ne '') {
5902: $triggerblock = $trigger;
5903: }
1.502 raeburn 5904: }
5905: if (($end != 0) &&
5906: (($endblock == 0) || ($endblock < $end))) {
5907: $endblock = $end;
1.1062 raeburn 5908: if ($trigger ne '') {
5909: $triggerblock = $trigger;
5910: }
1.502 raeburn 5911: }
1.490 raeburn 5912: }
1.1062 raeburn 5913: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5914: }
5915:
5916: sub get_blocks {
1.1347 raeburn 5917: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5918: my $startblock = 0;
5919: my $endblock = 0;
1.1062 raeburn 5920: my $triggerblock = '';
1.490 raeburn 5921: my $course = $cdom.'_'.$cnum;
5922: $setters->{$course} = {};
5923: $setters->{$course}{'staff'} = [];
5924: $setters->{$course}{'times'} = [];
1.1062 raeburn 5925: $setters->{$course}{'triggers'} = [];
5926: my (@blockers,%triggered);
5927: my $now = time;
5928: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5929: if ($activity eq 'docs') {
1.1348 raeburn 5930: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5931: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5932: $blocked = 1;
5933: $nosymbcache = 1;
1.1348 raeburn 5934: $noenccheck = 1;
1.1347 raeburn 5935: }
1.1348 raeburn 5936: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5937: foreach my $block (@blockers) {
5938: if ($block =~ /^firstaccess____(.+)$/) {
5939: my $item = $1;
5940: my $type = 'map';
5941: my $timersymb = $item;
5942: if ($item eq 'course') {
5943: $type = 'course';
5944: } elsif ($item =~ /___\d+___/) {
5945: $type = 'resource';
5946: } else {
5947: $timersymb = &Apache::lonnet::symbread($item);
5948: }
5949: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5950: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5951: $triggered{$block} = {
5952: start => $start,
5953: end => $end,
5954: type => $type,
5955: };
5956: }
5957: }
5958: } else {
5959: foreach my $block (keys(%commblocks)) {
5960: if ($block =~ m/^(\d+)____(\d+)$/) {
5961: my ($start,$end) = ($1,$2);
5962: if ($start <= time && $end >= time) {
5963: if (ref($commblocks{$block}) eq 'HASH') {
5964: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5965: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5966: unless(grep(/^\Q$block\E$/,@blockers)) {
5967: push(@blockers,$block);
5968: }
5969: }
5970: }
5971: }
5972: }
5973: } elsif ($block =~ /^firstaccess____(.+)$/) {
5974: my $item = $1;
5975: my $timersymb = $item;
5976: my $type = 'map';
5977: if ($item eq 'course') {
5978: $type = 'course';
5979: } elsif ($item =~ /___\d+___/) {
5980: $type = 'resource';
5981: } else {
5982: $timersymb = &Apache::lonnet::symbread($item);
5983: }
5984: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5985: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5986: if ($start && $end) {
5987: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5988: if (ref($commblocks{$block}) eq 'HASH') {
5989: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5990: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5991: unless(grep(/^\Q$block\E$/,@blockers)) {
5992: push(@blockers,$block);
5993: $triggered{$block} = {
5994: start => $start,
5995: end => $end,
5996: type => $type,
5997: };
5998: }
5999: }
6000: }
1.1062 raeburn 6001: }
6002: }
1.490 raeburn 6003: }
1.1062 raeburn 6004: }
6005: }
6006: }
6007: foreach my $blocker (@blockers) {
6008: my ($staff_name,$staff_dom,$title,$blocks) =
6009: &parse_block_record($commblocks{$blocker});
6010: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
6011: my ($start,$end,$triggertype);
6012: if ($blocker =~ m/^(\d+)____(\d+)$/) {
6013: ($start,$end) = ($1,$2);
6014: } elsif (ref($triggered{$blocker}) eq 'HASH') {
6015: $start = $triggered{$blocker}{'start'};
6016: $end = $triggered{$blocker}{'end'};
6017: $triggertype = $triggered{$blocker}{'type'};
6018: }
6019: if ($start) {
6020: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6021: if ($triggertype) {
6022: push(@{$$setters{$course}{'triggers'}},$triggertype);
6023: } else {
6024: push(@{$$setters{$course}{'triggers'}},0);
6025: }
6026: if ( ($startblock == 0) || ($startblock > $start) ) {
6027: $startblock = $start;
6028: if ($triggertype) {
6029: $triggerblock = $blocker;
1.474 raeburn 6030: }
6031: }
1.1062 raeburn 6032: if ( ($endblock == 0) || ($endblock < $end) ) {
6033: $endblock = $end;
6034: if ($triggertype) {
6035: $triggerblock = $blocker;
6036: }
6037: }
1.474 raeburn 6038: }
6039: }
1.1062 raeburn 6040: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6041: }
6042:
6043: sub parse_block_record {
6044: my ($record) = @_;
6045: my ($setuname,$setudom,$title,$blocks);
6046: if (ref($record) eq 'HASH') {
6047: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6048: $title = &unescape($record->{'event'});
6049: $blocks = $record->{'blocks'};
6050: } else {
6051: my @data = split(/:/,$record,3);
6052: if (scalar(@data) eq 2) {
6053: $title = $data[1];
6054: ($setuname,$setudom) = split(/@/,$data[0]);
6055: } else {
6056: ($setuname,$setudom,$title) = @data;
6057: }
6058: $blocks = { 'com' => 'on' };
6059: }
6060: return ($setuname,$setudom,$title,$blocks);
6061: }
6062:
1.854 kalberla 6063: sub blocking_status {
1.1372 raeburn 6064: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6065: my %setters;
1.890 droeschl 6066:
1.1061 raeburn 6067: # check for active blocking
1.1372 raeburn 6068: if ($clientip eq '') {
6069: $clientip = &Apache::lonnet::get_requestor_ip();
6070: }
6071: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6072: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6073: my $blocked = 0;
1.1372 raeburn 6074: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6075: $blocked = 1;
6076: }
1.890 droeschl 6077:
1.1061 raeburn 6078: # caller just wants to know whether a block is active
6079: if (!wantarray) { return $blocked; }
6080:
6081: # build a link to a popup window containing the details
6082: my $querystring = "?activity=$activity";
1.1351 raeburn 6083: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6084: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6085: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6086: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6087: } elsif ($activity eq 'docs') {
1.1347 raeburn 6088: my $showurl = &Apache::lonenc::check_encrypt($url);
6089: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6090: if ($symb) {
6091: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6092: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6093: }
1.1062 raeburn 6094: }
1.1061 raeburn 6095:
6096: my $output .= <<'END_MYBLOCK';
6097: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6098: var options = "width=" + w + ",height=" + h + ",";
6099: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6100: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6101: var newWin = window.open(url, wdwName, options);
6102: newWin.focus();
6103: }
1.890 droeschl 6104: END_MYBLOCK
1.854 kalberla 6105:
1.1061 raeburn 6106: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6107:
1.1061 raeburn 6108: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6109: my $text = &mt('Communication Blocked');
1.1217 raeburn 6110: my $class = 'LC_comblock';
1.1062 raeburn 6111: if ($activity eq 'docs') {
6112: $text = &mt('Content Access Blocked');
1.1217 raeburn 6113: $class = '';
1.1063 raeburn 6114: } elsif ($activity eq 'printout') {
6115: $text = &mt('Printing Blocked');
1.1232 raeburn 6116: } elsif ($activity eq 'passwd') {
6117: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6118: } elsif ($activity eq 'grades') {
6119: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6120: } elsif ($activity eq 'search') {
6121: $text = &mt('Search Blocked');
1.1444 raeburn 6122: } elsif ($activity eq 'index') {
6123: $text = &mt('Content Index Blocked');
1.1282 raeburn 6124: } elsif ($activity eq 'alert') {
6125: $text = &mt('Checking Critical Messages Blocked');
6126: } elsif ($activity eq 'reinit') {
6127: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6128: } elsif ($activity eq 'about') {
6129: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6130: } elsif ($activity eq 'wishlist') {
6131: $text = &mt('Access to Stored Links Blocked');
6132: } elsif ($activity eq 'annotate') {
6133: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6134: }
1.1061 raeburn 6135: $output .= <<"END_BLOCK";
1.1217 raeburn 6136: <div class='$class'>
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'>
6139: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6140: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6141: title='$text'>$text</a>
1.867 kalberla 6142: </div>
6143:
6144: END_BLOCK
1.474 raeburn 6145:
1.1061 raeburn 6146: return ($blocked, $output);
1.854 kalberla 6147: }
1.490 raeburn 6148:
1.60 matthew 6149: ###############################################
6150:
1.682 raeburn 6151: sub check_ip_acc {
1.1201 raeburn 6152: my ($acc,$clientip)=@_;
1.682 raeburn 6153: &Apache::lonxml::debug("acc is $acc");
6154: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6155: return 1;
6156: }
1.1339 raeburn 6157: my ($ip,$allowed);
6158: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6159: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6160: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6161: } else {
1.1350 raeburn 6162: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6163: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6164: }
1.682 raeburn 6165:
6166: my $name;
1.1219 raeburn 6167: my %access = (
6168: allowfrom => 1,
6169: denyfrom => 0,
6170: );
6171: my @allows;
6172: my @denies;
6173: foreach my $item (split(',',$acc)) {
6174: $item =~ s/^\s*//;
6175: $item =~ s/\s*$//;
6176: my $pattern;
6177: if ($item =~ /^\!(.+)$/) {
6178: push(@denies,$1);
6179: } else {
6180: push(@allows,$item);
6181: }
6182: }
6183: my $numdenies = scalar(@denies);
6184: my $numallows = scalar(@allows);
6185: my $count = 0;
6186: foreach my $pattern (@denies,@allows) {
6187: $count ++;
6188: my $acctype = 'allowfrom';
6189: if ($count <= $numdenies) {
6190: $acctype = 'denyfrom';
6191: }
1.682 raeburn 6192: if ($pattern =~ /\*$/) {
6193: #35.8.*
6194: $pattern=~s/\*//;
1.1219 raeburn 6195: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6196: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6197: #35.8.3.[34-56]
6198: my $low=$2;
6199: my $high=$3;
6200: $pattern=$1;
6201: if ($ip =~ /^\Q$pattern\E/) {
6202: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6203: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6204: }
6205: } elsif ($pattern =~ /^\*/) {
6206: #*.msu.edu
6207: $pattern=~s/\*//;
6208: if (!defined($name)) {
6209: use Socket;
6210: my $netaddr=inet_aton($ip);
6211: ($name)=gethostbyaddr($netaddr,AF_INET);
6212: }
1.1219 raeburn 6213: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6214: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6215: #127.0.0.1
1.1219 raeburn 6216: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6217: } else {
6218: #some.name.com
6219: if (!defined($name)) {
6220: use Socket;
6221: my $netaddr=inet_aton($ip);
6222: ($name)=gethostbyaddr($netaddr,AF_INET);
6223: }
1.1219 raeburn 6224: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6225: }
6226: if ($allowed =~ /^(0|1)$/) { last; }
6227: }
6228: if ($allowed eq '') {
6229: if ($numdenies && !$numallows) {
6230: $allowed = 1;
6231: } else {
6232: $allowed = 0;
1.682 raeburn 6233: }
6234: }
6235: return $allowed;
6236: }
6237:
6238: ###############################################
6239:
1.60 matthew 6240: =pod
6241:
1.112 bowersj2 6242: =head1 Domain Template Functions
6243:
6244: =over 4
6245:
6246: =item * &determinedomain()
1.60 matthew 6247:
6248: Inputs: $domain (usually will be undef)
6249:
1.63 www 6250: Returns: Determines which domain should be used for designs
1.60 matthew 6251:
6252: =cut
1.54 www 6253:
1.60 matthew 6254: ###############################################
1.63 www 6255: sub determinedomain {
6256: my $domain=shift;
1.531 albertel 6257: if (! $domain) {
1.60 matthew 6258: # Determine domain if we have not been given one
1.893 raeburn 6259: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6260: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6261: if ($env{'request.role.domain'}) {
6262: $domain=$env{'request.role.domain'};
1.60 matthew 6263: }
6264: }
1.63 www 6265: return $domain;
6266: }
6267: ###############################################
1.517 raeburn 6268:
1.518 albertel 6269: sub devalidate_domconfig_cache {
6270: my ($udom)=@_;
6271: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6272: }
6273:
6274: # ---------------------- Get domain configuration for a domain
6275: sub get_domainconf {
6276: my ($udom) = @_;
6277: my $cachetime=1800;
6278: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6279: if (defined($cached)) { return %{$result}; }
6280:
6281: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6282: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6283: my (%designhash,%legacy);
1.518 albertel 6284: if (keys(%domconfig) > 0) {
6285: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6286: if (keys(%{$domconfig{'login'}})) {
6287: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6288: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6289: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6290: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6291: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6292: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6293: if ($key eq 'loginvia') {
6294: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6295: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6296: $designhash{$udom.'.login.loginvia'} = $server;
6297: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6298:
6299: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6300: } else {
6301: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6302: }
1.948 raeburn 6303: }
1.1208 raeburn 6304: } elsif ($key eq 'headtag') {
6305: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6306: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6307: }
1.946 raeburn 6308: }
1.1208 raeburn 6309: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6310: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6311: }
1.946 raeburn 6312: }
6313: }
6314: }
1.1366 raeburn 6315: } elsif ($key eq 'saml') {
6316: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6317: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6318: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6319: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6320: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6321: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6322: }
6323: }
6324: }
6325: }
1.946 raeburn 6326: } else {
6327: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6328: $designhash{$udom.'.login.'.$key.'_'.$img} =
6329: $domconfig{'login'}{$key}{$img};
6330: }
1.699 raeburn 6331: }
6332: } else {
6333: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6334: }
1.632 raeburn 6335: }
6336: } else {
6337: $legacy{'login'} = 1;
1.518 albertel 6338: }
1.632 raeburn 6339: } else {
6340: $legacy{'login'} = 1;
1.518 albertel 6341: }
6342: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6343: if (keys(%{$domconfig{'rolecolors'}})) {
6344: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6345: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6346: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6347: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6348: }
1.518 albertel 6349: }
6350: }
1.632 raeburn 6351: } else {
6352: $legacy{'rolecolors'} = 1;
1.518 albertel 6353: }
1.632 raeburn 6354: } else {
6355: $legacy{'rolecolors'} = 1;
1.518 albertel 6356: }
1.948 raeburn 6357: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6358: if ($domconfig{'autoenroll'}{'co-owners'}) {
6359: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6360: }
6361: }
1.632 raeburn 6362: if (keys(%legacy) > 0) {
6363: my %legacyhash = &get_legacy_domconf($udom);
6364: foreach my $item (keys(%legacyhash)) {
6365: if ($item =~ /^\Q$udom\E\.login/) {
6366: if ($legacy{'login'}) {
6367: $designhash{$item} = $legacyhash{$item};
6368: }
6369: } else {
6370: if ($legacy{'rolecolors'}) {
6371: $designhash{$item} = $legacyhash{$item};
6372: }
1.518 albertel 6373: }
6374: }
6375: }
1.632 raeburn 6376: } else {
6377: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6378: }
6379: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6380: $cachetime);
6381: return %designhash;
6382: }
6383:
1.632 raeburn 6384: sub get_legacy_domconf {
6385: my ($udom) = @_;
6386: my %legacyhash;
6387: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6388: my $designfile = $designdir.'/'.$udom.'.tab';
6389: if (-e $designfile) {
1.1317 raeburn 6390: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6391: while (my $line = <$fh>) {
6392: next if ($line =~ /^\#/);
6393: chomp($line);
6394: my ($key,$val)=(split(/\=/,$line));
6395: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6396: }
6397: close($fh);
6398: }
6399: }
1.1026 raeburn 6400: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6401: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6402: }
6403: return %legacyhash;
6404: }
6405:
1.63 www 6406: =pod
6407:
1.112 bowersj2 6408: =item * &domainlogo()
1.63 www 6409:
6410: Inputs: $domain (usually will be undef)
6411:
6412: Returns: A link to a domain logo, if the domain logo exists.
6413: If the domain logo does not exist, a description of the domain.
6414:
6415: =cut
1.112 bowersj2 6416:
1.63 www 6417: ###############################################
6418: sub domainlogo {
1.517 raeburn 6419: my $domain = &determinedomain(shift);
1.518 albertel 6420: my %designhash = &get_domainconf($domain);
1.517 raeburn 6421: # See if there is a logo
6422: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6423: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6424: if ($imgsrc =~ m{^/(adm|res)/}) {
6425: if ($imgsrc =~ m{^/res/}) {
6426: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6427: &Apache::lonnet::repcopy($local_name);
6428: }
6429: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6430: }
6431: my $alttext = $domain;
6432: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6433: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6434: }
6435: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6436: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6437: return &Apache::lonnet::domain($domain,'description');
1.59 www 6438: } else {
1.60 matthew 6439: return '';
1.59 www 6440: }
6441: }
1.63 www 6442: ##############################################
6443:
6444: =pod
6445:
1.112 bowersj2 6446: =item * &designparm()
1.63 www 6447:
6448: Inputs: $which parameter; $domain (usually will be undef)
6449:
6450: Returns: value of designparamter $which
6451:
6452: =cut
1.112 bowersj2 6453:
1.397 albertel 6454:
1.400 albertel 6455: ##############################################
1.397 albertel 6456: sub designparm {
6457: my ($which,$domain)=@_;
6458: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6459: return $env{'environment.color.'.$which};
1.96 www 6460: }
1.63 www 6461: $domain=&determinedomain($domain);
1.1016 raeburn 6462: my %domdesign;
6463: unless ($domain eq 'public') {
6464: %domdesign = &get_domainconf($domain);
6465: }
1.520 raeburn 6466: my $output;
1.517 raeburn 6467: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6468: $output = $domdesign{$domain.'.'.$which};
1.63 www 6469: } else {
1.520 raeburn 6470: $output = $defaultdesign{$which};
6471: }
6472: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6473: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6474: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6475: if ($output =~ m{^/res/}) {
6476: my $local_name = &Apache::lonnet::filelocation('',$output);
6477: &Apache::lonnet::repcopy($local_name);
6478: }
1.520 raeburn 6479: $output = &lonhttpdurl($output);
6480: }
1.63 www 6481: }
1.520 raeburn 6482: return $output;
1.63 www 6483: }
1.59 www 6484:
1.822 bisitz 6485: ##############################################
6486: =pod
6487:
1.832 bisitz 6488: =item * &authorspace()
6489:
1.1028 raeburn 6490: Inputs: $url (usually will be undef).
1.832 bisitz 6491:
1.1132 raeburn 6492: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6493: directory being viewed (or for which action is being taken).
6494: If $url is provided, and begins /priv/<domain>/<uname>
6495: the path will be that portion of the $context argument.
6496: Otherwise the path will be for the author space of the current
6497: user when the current role is author, or for that of the
6498: co-author/assistant co-author space when the current role
6499: is co-author or assistant co-author.
1.832 bisitz 6500:
6501: =cut
6502:
6503: sub authorspace {
1.1028 raeburn 6504: my ($url) = @_;
6505: if ($url ne '') {
6506: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6507: return $1;
6508: }
6509: }
1.832 bisitz 6510: my $caname = '';
1.1024 www 6511: my $cadom = '';
1.1028 raeburn 6512: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6513: ($cadom,$caname) =
1.832 bisitz 6514: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6515: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6516: $caname = $env{'user.name'};
1.1024 www 6517: $cadom = $env{'user.domain'};
1.832 bisitz 6518: }
1.1028 raeburn 6519: if (($caname ne '') && ($cadom ne '')) {
6520: return "/priv/$cadom/$caname/";
6521: }
6522: return;
1.832 bisitz 6523: }
6524:
6525: ##############################################
6526: =pod
6527:
1.822 bisitz 6528: =item * &head_subbox()
6529:
6530: Inputs: $content (contains HTML code with page functions, etc.)
6531:
6532: Returns: HTML div with $content
6533: To be included in page header
6534:
6535: =cut
6536:
6537: sub head_subbox {
6538: my ($content)=@_;
6539: my $output =
1.993 raeburn 6540: '<div class="LC_head_subbox">'
1.822 bisitz 6541: .$content
6542: .'</div>'
6543: }
6544:
6545: ##############################################
6546: =pod
6547:
6548: =item * &CSTR_pageheader()
6549:
1.1026 raeburn 6550: Input: (optional) filename from which breadcrumb trail is built.
6551: In most cases no input as needed, as $env{'request.filename'}
6552: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6553: frameset flag
6554: If page header is being requested for use in a frameset, then
6555: the second (option) argument -- frameset will be true, and
6556: the target attribute set for links should be target="_parent".
1.1433 raeburn 6557: If $title is supplied as the third arg, that will be used to
1.1407 raeburn 6558: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6559:
6560: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6561: To be included on Authoring Space pages
1.822 bisitz 6562:
6563: =cut
6564:
6565: sub CSTR_pageheader {
1.1407 raeburn 6566: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6567: if ($trailfile eq '') {
6568: $trailfile = $env{'request.filename'};
6569: }
6570:
6571: # this is for resources; directories have customtitle, and crumbs
6572: # and select recent are created in lonpubdir.pm
6573:
6574: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6575: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6576: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6577: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6578: $formaction =~ s{/+}{/}g;
1.822 bisitz 6579:
6580: my $parentpath = '';
6581: my $lastitem = '';
6582: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6583: $parentpath = $1;
6584: $lastitem = $2;
6585: } else {
6586: $lastitem = $thisdisfn;
6587: }
1.921 bisitz 6588:
1.1406 raeburn 6589: my $crsauthor;
1.1246 raeburn 6590: if (($env{'request.course.id'}) &&
6591: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6592: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6593: $crsauthor = 1;
1.1406 raeburn 6594: if ($title eq '') {
6595: $title = &mt('Course Authoring Space');
6596: }
6597: } elsif ($title eq '') {
1.1246 raeburn 6598: $title = &mt('Authoring Space');
6599: }
6600:
1.1379 raeburn 6601: my ($target,$crumbtarget) = (' target="_top"','_top');
6602: if ($frameset) {
6603: $target = ' target="_parent"';
6604: $crumbtarget = '_parent';
6605: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6606: $target = '';
6607: $crumbtarget = '';
1.1379 raeburn 6608: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6609: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6610: $crumbtarget = $env{'request.deeplink.target'};
6611: }
1.1313 raeburn 6612:
1.921 bisitz 6613: my $output =
1.1407 raeburn 6614: '<div>'
1.822 bisitz 6615: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6616: .'<b>'.$title.'</b> '
1.1314 raeburn 6617: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6618: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6619:
6620: if ($lastitem) {
6621: $output .=
6622: '<span class="LC_filename">'
6623: .$lastitem
6624: .'</span>';
6625: }
1.1245 raeburn 6626:
1.1246 raeburn 6627: if ($crsauthor) {
1.1379 raeburn 6628: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6629: } else {
6630: $output .=
6631: '<br />'
1.1314 raeburn 6632: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6633: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6634: .'</form>'
1.1379 raeburn 6635: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6636: }
1.1407 raeburn 6637: $output .= '</div>';
1.921 bisitz 6638:
6639: return $output;
1.822 bisitz 6640: }
6641:
1.1419 raeburn 6642: ##############################################
6643: =pod
6644:
6645: =item * &nocodemirror()
6646:
6647: Input: None
6648:
6649: Returns: 1 if CodeMirror is deactivated based on
6650: user's preference, or domain default,
6651: if user indicated use of default.
6652:
6653: =cut
6654:
1.1416 raeburn 6655: sub nocodemirror {
6656: my $nocodem = $env{'environment.nocodemirror'};
6657: unless ($nocodem) {
6658: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6659: if ($domdefs{'nocodemirror'}) {
6660: $nocodem = 'yes';
6661: }
6662: }
1.1417 raeburn 6663: if ($nocodem eq 'yes') {
6664: return 1;
6665: }
6666: return;
1.1416 raeburn 6667: }
6668:
1.1419 raeburn 6669: ##############################################
6670: =pod
6671:
6672: =item * &permitted_editors()
6673:
1.1422 raeburn 6674: Input: $uri (optional)
1.1419 raeburn 6675:
6676: Returns: %editors hash in which keys are editors
1.1429 raeburn 6677: permitted in current Authoring Space,
6678: or in current course for web pages
6679: created in a course.
6680:
1.1419 raeburn 6681: Value for each key is 1. Possible keys
1.1429 raeburn 6682: are: edit, xml, and daxe.
6683:
6684: For a regular Authoring Space, if no specific
1.1419 raeburn 6685: set of editors has been set for the Author
6686: who owns the Authoring Space, then the
6687: domain default will be used. If no domain
6688: default has been set, then the keys will be
6689: edit and xml.
6690:
1.1429 raeburn 6691: For a course author, or for web pages created
6692: in a course, if no specific set of editors has
6693: been set for the course, then the domain
6694: course default will be used. If no domain
6695: course default has been set, then the keys
6696: will be edit and xml.
6697:
1.1419 raeburn 6698: =cut
6699:
1.1418 raeburn 6700: sub permitted_editors {
1.1422 raeburn 6701: my ($uri) = @_;
1.1429 raeburn 6702: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6703: if ($env{'request.role'} =~ m{^au\./}) {
6704: $is_author = 1;
6705: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6706: ($audom,$auname) = ($1,$2);
6707: if (($audom ne '') && ($auname ne '')) {
6708: if (($env{'user.domain'} eq $audom) &&
6709: ($env{'user.name'} eq $auname)) {
6710: $is_author = 1;
6711: } else {
6712: $is_coauthor = 1;
6713: }
6714: }
6715: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6716: my ($cdom,$cnum);
6717: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6718: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6719: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6720: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6721: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6722: $is_course = 1;
6723: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6724: ($audom,$auname) = ($1,$2);
6725: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6726: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6727: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6728: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6729: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6730: $is_course = 1;
6731: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6732: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6733: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6734: }
1.1429 raeburn 6735: unless ($is_course) {
6736: if (($audom ne '') && ($auname ne '')) {
6737: if (($env{'user.domain'} eq $audom) &&
6738: ($env{'user.name'} eq $auname)) {
6739: $is_author = 1;
6740: } else {
6741: $is_coauthor = 1;
6742: }
1.1418 raeburn 6743: }
6744: }
6745: }
6746: if ($is_author) {
6747: if (exists($env{'environment.editors'})) {
6748: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6749: } else {
6750: %editors = ( edit => 1,
6751: xml => 1,
6752: );
6753: }
6754: } elsif ($is_coauthor) {
6755: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6756: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6757: } else {
6758: %editors = ( edit => 1,
6759: xml => 1,
6760: );
6761: }
1.1429 raeburn 6762: } elsif ($is_course) {
6763: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6764: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6765: } else {
6766: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6767: if (exists($domdefaults{'crseditors'})) {
6768: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6769: } else {
6770: %editors = ( edit => 1,
6771: xml => 1,
6772: );
6773: }
6774: }
1.1418 raeburn 6775: } else {
6776: %editors = ( edit => 1,
6777: xml => 1,
6778: );
6779: }
6780: return %editors;
6781: }
6782:
1.60 matthew 6783: ###############################################
6784: ###############################################
6785:
6786: =pod
6787:
1.112 bowersj2 6788: =back
6789:
1.549 albertel 6790: =head1 HTML Helpers
1.112 bowersj2 6791:
6792: =over 4
6793:
6794: =item * &bodytag()
1.60 matthew 6795:
6796: Returns a uniform header for LON-CAPA web pages.
6797:
6798: Inputs:
6799:
1.112 bowersj2 6800: =over 4
6801:
6802: =item * $title, A title to be displayed on the page.
6803:
6804: =item * $function, the current role (can be undef).
6805:
6806: =item * $addentries, extra parameters for the <body> tag.
6807:
6808: =item * $bodyonly, if defined, only return the <body> tag.
6809:
6810: =item * $domain, if defined, force a given domain.
6811:
6812: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6813: text interface only)
1.60 matthew 6814:
1.814 bisitz 6815: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6816: navigational links
1.317 albertel 6817:
1.338 albertel 6818: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6819:
1.460 albertel 6820: =item * $args, optional argument valid values are
6821: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6822: use_absolute -> for external resource or syllabus, this will
6823: contain https://<hostname> if server uses
6824: https (as per hosts.tab), but request is for http
6825: hostname -> hostname, from $r->hostname().
1.460 albertel 6826:
1.1096 raeburn 6827: =item * $advtoolsref, optional argument, ref to an array containing
6828: inlineremote items to be added in "Functions" menu below
6829: breadcrumbs.
6830:
1.1316 raeburn 6831: =item * $ltiscope, optional argument, will be one of: resource, map or
6832: course, if LON-CAPA is in LTI Provider context. Value is
6833: the scope of use, i.e., launch was for access to a single, a map
6834: or the entire course.
6835:
6836: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6837: context, this will contain the URL for the landing item in
6838: the course, after launch from an LTI Consumer
6839:
1.1318 raeburn 6840: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6841: context, this will contain a reference to hash of items
6842: to be included in the page header and/or inline menu.
6843:
1.1385 raeburn 6844: =item * $menucoll, optional argument, if specific menu collection is in
6845: effect, either set as the default for the course, or set for
6846: the deeplink paramater for $env{'request.deeplink.login'}
6847: then $menucoll will be the number of that collection.
6848:
6849: =item * $menuref, optional argument, reference to a hash, containing the
6850: menu options included for the menu in effect, based on the
6851: configuration for the numbered menu collection in use.
6852:
6853: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6854: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6855: if so, $showncrumbsref is set there to 1, and will propagate back
6856: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6857: being called a second time.
6858:
1.112 bowersj2 6859: =back
6860:
1.60 matthew 6861: Returns: A uniform header for LON-CAPA web pages.
6862: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6863: If $bodyonly is undef or zero, an html string containing a <body> tag and
6864: other decorations will be returned.
6865:
6866: =cut
6867:
1.54 www 6868: sub bodytag {
1.831 bisitz 6869: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6870: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6871: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6872:
1.954 raeburn 6873: my $public;
6874: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6875: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6876: $public = 1;
6877: }
1.460 albertel 6878: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6879: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6880: my $hostname = $args->{'hostname'};
1.339 albertel 6881:
1.183 matthew 6882: $function = &get_users_function() if (!$function);
1.339 albertel 6883: my $font = &designparm($function.'.font',$domain);
6884: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6885:
1.803 bisitz 6886: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6887: 'bgcolor' => $pgbg,
1.339 albertel 6888: 'text' => $font,
6889: 'alink' => &designparm($function.'.alink',$domain),
6890: 'vlink' => &designparm($function.'.vlink',$domain),
6891: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6892: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6893:
1.63 www 6894: # role and realm
1.1178 raeburn 6895: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6896: if ($realm) {
6897: $realm = '/'.$realm;
6898: }
1.1357 raeburn 6899: if ($role eq 'ca') {
1.479 albertel 6900: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6901: $realm = &plainname($rname,$rdom);
1.378 raeburn 6902: }
1.55 www 6903: # realm
1.1357 raeburn 6904: my ($cid,$sec);
1.258 albertel 6905: if ($env{'request.course.id'}) {
1.1357 raeburn 6906: $cid = $env{'request.course.id'};
6907: if ($env{'request.course.sec'}) {
6908: $sec = $env{'request.course.sec'};
6909: }
6910: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6911: if (&Apache::lonnet::is_course($1,$2)) {
6912: $cid = $1.'_'.$2;
6913: $sec = $3;
6914: }
6915: }
6916: if ($cid) {
1.378 raeburn 6917: if ($env{'request.role'} !~ /^cr/) {
6918: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6919: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6920: if ($env{'request.role.desc'}) {
6921: $role = $env{'request.role.desc'};
6922: } else {
6923: $role = &mt('Helpdesk[_1]',' '.$2);
6924: }
1.1257 raeburn 6925: } else {
6926: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6927: }
1.1357 raeburn 6928: if ($sec) {
6929: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6930: }
1.1357 raeburn 6931: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6932: } else {
6933: $role = &Apache::lonnet::plaintext($role);
1.54 www 6934: }
1.433 albertel 6935:
1.359 albertel 6936: if (!$realm) { $realm=' '; }
1.330 albertel 6937:
1.438 albertel 6938: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6939:
1.101 www 6940: # construct main body tag
1.359 albertel 6941: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6942: &Apache::lontexconvert::init_math_support();
1.252 albertel 6943:
1.1131 raeburn 6944: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6945:
1.1130 raeburn 6946: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6947: return $bodytag;
1.1130 raeburn 6948: }
1.359 albertel 6949:
1.954 raeburn 6950: if ($public) {
1.433 albertel 6951: undef($role);
6952: }
1.1318 raeburn 6953:
1.1359 raeburn 6954: my $showcrstitle = 1;
1.1357 raeburn 6955: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6956: if (ref($ltimenu) eq 'HASH') {
6957: unless ($ltimenu->{'role'}) {
6958: undef($role);
6959: }
6960: unless ($ltimenu->{'coursetitle'}) {
6961: $realm=' ';
1.1359 raeburn 6962: $showcrstitle = 0;
6963: }
6964: }
6965: } elsif (($cid) && ($menucoll)) {
6966: if (ref($menuref) eq 'HASH') {
6967: unless ($menuref->{'role'}) {
6968: undef($role);
6969: }
6970: unless ($menuref->{'crs'}) {
6971: $realm=' ';
6972: $showcrstitle = 0;
1.1318 raeburn 6973: }
6974: }
6975: }
6976:
1.762 bisitz 6977: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6978: #
6979: # Extra info if you are the DC
6980: my $dc_info = '';
1.1359 raeburn 6981: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6982: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6983: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6984: $dc_info =~ s/\s+$//;
1.359 albertel 6985: }
6986:
1.1237 raeburn 6987: my $crstype;
1.1357 raeburn 6988: if ($cid) {
6989: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6990: } elsif ($args->{'crstype'}) {
6991: $crstype = $args->{'crstype'};
6992: }
6993: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6994: undef($role);
6995: } else {
1.1242 raeburn 6996: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6997: }
1.853 droeschl 6998:
1.903 droeschl 6999: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
7000:
7001: # if ($env{'request.state'} eq 'construct') {
7002: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7003: # }
7004:
1.1440 raeburn 7005: my $need_endlcint;
7006: unless ($args->{'switchserver'}) {
7007: $bodytag .= Apache::lonhtmlcommon::scripttag(
7008: Apache::lonmenu::utilityfunctions($httphost), 'start');
7009: $need_endlcint = 1;
7010: }
1.359 albertel 7011:
1.1427 raeburn 7012: my $collapsible;
1.1423 raeburn 7013: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7014: $collapsible = 1;
7015: my ($menustate,$tiptext,$divclass);
7016: if ($args->{'start_collapsed'}) {
7017: $menustate = 'collapsed';
7018: $tiptext = 'display';
7019: $divclass = 'hidden';
7020: } else {
7021: $menustate = 'expanded';
7022: $tiptext = 'hide';
7023: $divclass = 'shown';
7024: }
7025: my $alttext = &mt('menu state: '.$menustate);
7026: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7027: $bodytag .= <<"END";
7028: <div id="LC_expandingContainer" style="display:inline;">
7029: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7030: <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>
7031: <div class="LC_menus_content $divclass">
1.1421 raeburn 7032: END
7033: }
1.1318 raeburn 7034: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7035: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7036: $args->{'links_disabled'},
1.1421 raeburn 7037: $args->{'links_target'},
1.1427 raeburn 7038: $collapsible);
1.359 albertel 7039:
1.1318 raeburn 7040: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7041: if ($dc_info) {
7042: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7043: }
7044: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7045: <em>$realm</em> $dc_info</div>|;
1.1440 raeburn 7046: if ($need_endlcint) {
7047: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7048: }
1.1318 raeburn 7049: return $bodytag;
7050: }
1.894 droeschl 7051:
1.1318 raeburn 7052: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7053: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7054: }
1.916 droeschl 7055:
1.1318 raeburn 7056: $bodytag .= $right;
1.852 droeschl 7057:
1.1318 raeburn 7058: if ($dc_info) {
7059: $dc_info = &dc_courseid_toggle($dc_info);
7060: }
7061: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7062: }
1.916 droeschl 7063:
1.1169 raeburn 7064: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7065: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7066: if ($need_endlcint) {
7067: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7068: }
1.1168 raeburn 7069: return $bodytag;
7070: }
1.1169 raeburn 7071: #don't show menus for public users
1.954 raeburn 7072: if (!$public){
1.1318 raeburn 7073: unless ($args->{'no_inline_menu'}) {
7074: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7075: $args->{'no_primary_menu'},
1.1369 raeburn 7076: $menucoll,$menuref,
1.1380 raeburn 7077: $args->{'links_disabled'},
7078: $args->{'links_target'});
1.1318 raeburn 7079: }
1.903 droeschl 7080: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7081: if ($need_endlcint) {
7082: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7083: }
1.920 raeburn 7084: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7085: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7086: $args->{'bread_crumbs'},'','',$hostname,
7087: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7088: } elsif ($forcereg) {
7089: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7090: $args->{'group'},$args->{'hide_buttons'},
7091: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7092: } else {
7093: $bodytag .=
7094: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7095: $forcereg,$args->{'group'},
7096: $args->{'bread_crumbs'},
1.1274 raeburn 7097: $advtoolsref,'',$hostname);
1.920 raeburn 7098: }
1.1440 raeburn 7099: } else {
7100: # this is to separate menu from content when there's no secondary
1.1441 raeburn 7101: # menu. Especially needed for publicly accessible resources.
1.903 droeschl 7102: $bodytag .= '<hr style="clear:both" />';
1.1440 raeburn 7103: if ($need_endlcint) {
7104: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7105: }
1.235 raeburn 7106: }
1.1423 raeburn 7107: if ($args->{'collapsible_header'} ne '') {
7108: $bodytag .= $args->{'collapsible_header'}.
7109: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7110: '</div></div>';
7111: }
1.235 raeburn 7112: return $bodytag;
1.182 matthew 7113: }
7114:
1.917 raeburn 7115: sub dc_courseid_toggle {
7116: my ($dc_info) = @_;
1.980 raeburn 7117: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7118: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7119: &mt('(More ...)').'</a></span>'.
7120: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7121: }
7122:
1.330 albertel 7123: sub make_attr_string {
7124: my ($register,$attr_ref) = @_;
7125:
7126: if ($attr_ref && !ref($attr_ref)) {
7127: die("addentries Must be a hash ref ".
7128: join(':',caller(1))." ".
7129: join(':',caller(0))." ");
7130: }
7131:
7132: if ($register) {
1.339 albertel 7133: my ($on_load,$on_unload);
7134: foreach my $key (keys(%{$attr_ref})) {
7135: if (lc($key) eq 'onload') {
7136: $on_load.=$attr_ref->{$key}.';';
7137: delete($attr_ref->{$key});
7138:
7139: } elsif (lc($key) eq 'onunload') {
7140: $on_unload.=$attr_ref->{$key}.';';
7141: delete($attr_ref->{$key});
7142: }
7143: }
1.953 droeschl 7144: $attr_ref->{'onload'} = $on_load;
7145: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7146: }
1.339 albertel 7147:
1.330 albertel 7148: my $attr_string;
1.1159 raeburn 7149: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7150: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7151: }
7152: return $attr_string;
7153: }
7154:
7155:
1.182 matthew 7156: ###############################################
1.251 albertel 7157: ###############################################
7158:
7159: =pod
7160:
7161: =item * &endbodytag()
7162:
7163: Returns a uniform footer for LON-CAPA web pages.
7164:
1.635 raeburn 7165: Inputs: 1 - optional reference to an args hash
7166: If in the hash, key for noredirectlink has a value which evaluates to true,
7167: a 'Continue' link is not displayed if the page contains an
7168: internal redirect in the <head></head> section,
7169: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7170:
7171: =cut
7172:
7173: sub endbodytag {
1.635 raeburn 7174: my ($args) = @_;
1.1080 raeburn 7175: my $endbodytag;
7176: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7177: $endbodytag='</body>';
7178: }
1.315 albertel 7179: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7180: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7181: my ($endbodyjs,$idattr);
7182: if ($env{'internal.head.to_opener'}) {
7183: my $linkid = 'LC_continue_link';
7184: $idattr = ' id="'.$linkid.'"';
7185: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7186: $endbodyjs=<<ENDJS;
7187: <script type="text/javascript">
7188: // <![CDATA[
7189: function ebFunction(evt) {
7190: evt.preventDefault();
7191: var dest = '$redirect_for_js';
7192: if (window.opener != null && !window.opener.closed) {
7193: window.opener.location.href=dest;
7194: window.close();
7195: } else {
7196: window.location.href=dest;
7197: }
7198: return false;
7199: }
7200:
7201: \$(document).ready(function () {
7202: if (document.getElementById('$linkid')) {
7203: var clickelem = document.getElementById('$linkid');
7204: clickelem.addEventListener('click',ebFunction,false);
7205: }
7206: });
7207: // ]]>
7208: </script>
7209: ENDJS
7210: }
1.635 raeburn 7211: $endbodytag=
1.1386 raeburn 7212: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7213: &mt('Continue').'</a>'.
7214: $endbodytag;
7215: }
1.315 albertel 7216: }
1.1411 raeburn 7217: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7218: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7219: }
1.251 albertel 7220: return $endbodytag;
7221: }
7222:
1.352 albertel 7223: =pod
7224:
7225: =item * &standard_css()
7226:
7227: Returns a style sheet
7228:
7229: Inputs: (all optional)
7230: domain -> force to color decorate a page for a specific
7231: domain
7232: function -> force usage of a specific rolish color scheme
7233: bgcolor -> override the default page bgcolor
7234:
7235: =cut
7236:
1.343 albertel 7237: sub standard_css {
1.345 albertel 7238: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7239: $function = &get_users_function() if (!$function);
7240: my $tabbg = &designparm($function.'.tabbg', $domain);
7241: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7242: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7243: #second colour for later usage
1.345 albertel 7244: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7245: my $pgbg_or_bgcolor =
7246: $bgcolor ||
1.352 albertel 7247: &designparm($function.'.pgbg', $domain);
1.382 albertel 7248: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7249: my $alink = &designparm($function.'.alink', $domain);
7250: my $vlink = &designparm($function.'.vlink', $domain);
7251: my $link = &designparm($function.'.link', $domain);
7252:
1.602 albertel 7253: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7254: my $mono = 'monospace';
1.850 bisitz 7255: my $data_table_head = $sidebg;
7256: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7257: my $data_table_dark = '#E0E0E0';
1.470 banghart 7258: my $data_table_darker = '#CCCCCC';
1.349 albertel 7259: my $data_table_highlight = '#FFFF00';
1.352 albertel 7260: my $mail_new = '#FFBB77';
7261: my $mail_new_hover = '#DD9955';
7262: my $mail_read = '#BBBB77';
7263: my $mail_read_hover = '#999944';
7264: my $mail_replied = '#AAAA88';
7265: my $mail_replied_hover = '#888855';
7266: my $mail_other = '#99BBBB';
7267: my $mail_other_hover = '#669999';
1.391 albertel 7268: my $table_header = '#DDDDDD';
1.489 raeburn 7269: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7270: my $lg_border_color = '#C8C8C8';
1.952 onken 7271: my $button_hover = '#BF2317';
1.392 albertel 7272:
1.608 albertel 7273: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7274: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7275: : '0 3px 0 4px';
1.448 albertel 7276:
1.523 albertel 7277:
1.343 albertel 7278: return <<END;
1.947 droeschl 7279:
7280: /* needed for iframe to allow 100% height in FF */
7281: body, html {
7282: margin: 0;
7283: padding: 0 0.5%;
7284: height: 99%; /* to avoid scrollbars */
7285: }
7286:
1.795 www 7287: body {
1.911 bisitz 7288: font-family: $sans;
7289: line-height:130%;
7290: font-size:0.83em;
7291: color:$font;
1.1436 raeburn 7292: background-color: $pgbg_or_bgcolor;
1.795 www 7293: }
7294:
1.959 onken 7295: a:focus,
7296: a:focus img {
1.795 www 7297: color: red;
7298: }
1.698 harmsja 7299:
1.911 bisitz 7300: form, .inline {
7301: display: inline;
1.795 www 7302: }
1.721 harmsja 7303:
1.1443 raeburn 7304: .LC_visually_hidden:not(:focus):not(:active) {
7305: clip-path: inset(50%);
7306: height: 1px;
7307: overflow: hidden;
7308: position: absolute;
7309: white-space: nowrap;
7310: width: 1px;
7311: display: inline;
7312: }
7313:
1.1421 raeburn 7314: .LC_menus_content.shown{
1.1428 raeburn 7315: display: block;
1.1421 raeburn 7316: }
7317:
7318: .LC_menus_content.hidden {
7319: display: none;
7320: }
7321:
1.795 www 7322: .LC_right {
1.911 bisitz 7323: text-align:right;
1.795 www 7324: }
7325:
7326: .LC_middle {
1.911 bisitz 7327: vertical-align:middle;
1.795 www 7328: }
1.721 harmsja 7329:
1.1130 raeburn 7330: .LC_floatleft {
7331: float: left;
7332: }
7333:
7334: .LC_floatright {
7335: float: right;
7336: }
7337:
1.911 bisitz 7338: .LC_400Box {
7339: width:400px;
7340: }
1.721 harmsja 7341:
1.1421 raeburn 7342: #LC_collapsible_separator {
7343: border: 1px solid black;
7344: width: 99.9%;
7345: height: 0px;
7346: }
7347:
1.947 droeschl 7348: .LC_iframecontainer {
7349: width: 98%;
7350: margin: 0;
7351: position: fixed;
7352: top: 8.5em;
7353: bottom: 0;
7354: }
7355:
7356: .LC_iframecontainer iframe{
7357: border: none;
7358: width: 100%;
7359: height: 100%;
7360: }
7361:
1.778 bisitz 7362: .LC_filename {
7363: font-family: $mono;
7364: white-space:pre;
1.921 bisitz 7365: font-size: 120%;
1.778 bisitz 7366: }
7367:
7368: .LC_fileicon {
7369: border: none;
7370: height: 1.3em;
7371: vertical-align: text-bottom;
7372: margin-right: 0.3em;
7373: text-decoration:none;
7374: }
7375:
1.1008 www 7376: .LC_setting {
7377: text-decoration:underline;
7378: }
7379:
1.350 albertel 7380: .LC_error {
7381: color: red;
7382: }
1.795 www 7383:
1.1097 bisitz 7384: .LC_warning {
7385: color: darkorange;
7386: }
7387:
1.457 albertel 7388: .LC_diff_removed {
1.733 bisitz 7389: color: red;
1.394 albertel 7390: }
1.532 albertel 7391:
7392: .LC_info,
1.457 albertel 7393: .LC_success,
7394: .LC_diff_added {
1.350 albertel 7395: color: green;
7396: }
1.795 www 7397:
1.802 bisitz 7398: div.LC_confirm_box {
7399: background-color: #FAFAFA;
7400: border: 1px solid $lg_border_color;
7401: margin-right: 0;
7402: padding: 5px;
7403: }
7404:
7405: div.LC_confirm_box .LC_error img,
7406: div.LC_confirm_box .LC_success img {
7407: vertical-align: middle;
7408: }
7409:
1.1242 raeburn 7410: .LC_maxwidth {
7411: max-width: 100%;
7412: height: auto;
7413: }
7414:
1.1243 raeburn 7415: .LC_textsize_mobile {
7416: \@media only screen and (max-device-width: 480px) {
7417: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7418: }
7419: }
7420:
1.440 albertel 7421: .LC_icon {
1.771 droeschl 7422: border: none;
1.790 droeschl 7423: vertical-align: middle;
1.771 droeschl 7424: }
7425:
1.543 albertel 7426: .LC_docs_spacer {
7427: width: 25px;
7428: height: 1px;
1.771 droeschl 7429: border: none;
1.543 albertel 7430: }
1.346 albertel 7431:
1.532 albertel 7432: .LC_internal_info {
1.735 bisitz 7433: color: #999999;
1.532 albertel 7434: }
7435:
1.794 www 7436: .LC_discussion {
1.1050 www 7437: background: $data_table_dark;
1.911 bisitz 7438: border: 1px solid black;
7439: margin: 2px;
1.794 www 7440: }
7441:
7442: .LC_disc_action_left {
1.1050 www 7443: background: $sidebg;
1.911 bisitz 7444: text-align: left;
1.1050 www 7445: padding: 4px;
7446: margin: 2px;
1.794 www 7447: }
7448:
7449: .LC_disc_action_right {
1.1050 www 7450: background: $sidebg;
1.911 bisitz 7451: text-align: right;
1.1050 www 7452: padding: 4px;
7453: margin: 2px;
1.794 www 7454: }
7455:
7456: .LC_disc_new_item {
1.911 bisitz 7457: background: white;
7458: border: 2px solid red;
1.1050 www 7459: margin: 4px;
7460: padding: 4px;
1.794 www 7461: }
7462:
7463: .LC_disc_old_item {
1.911 bisitz 7464: background: white;
1.1050 www 7465: margin: 4px;
7466: padding: 4px;
1.794 www 7467: }
7468:
1.458 albertel 7469: table.LC_pastsubmission {
7470: border: 1px solid black;
7471: margin: 2px;
7472: }
7473:
1.924 bisitz 7474: table#LC_menubuttons {
1.345 albertel 7475: width: 100%;
7476: background: $pgbg;
1.392 albertel 7477: border: 2px;
1.402 albertel 7478: border-collapse: separate;
1.803 bisitz 7479: padding: 0;
1.345 albertel 7480: }
1.392 albertel 7481:
1.801 tempelho 7482: table#LC_title_bar a {
7483: color: $fontmenu;
7484: }
1.836 bisitz 7485:
1.807 droeschl 7486: table#LC_title_bar {
1.819 tempelho 7487: clear: both;
1.836 bisitz 7488: display: none;
1.807 droeschl 7489: }
7490:
1.795 www 7491: table#LC_title_bar,
1.933 droeschl 7492: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7493: table#LC_title_bar.LC_with_remote {
1.359 albertel 7494: width: 100%;
1.392 albertel 7495: border-color: $pgbg;
7496: border-style: solid;
7497: border-width: $border;
1.379 albertel 7498: background: $pgbg;
1.801 tempelho 7499: color: $fontmenu;
1.392 albertel 7500: border-collapse: collapse;
1.803 bisitz 7501: padding: 0;
1.819 tempelho 7502: margin: 0;
1.359 albertel 7503: }
1.795 www 7504:
1.933 droeschl 7505: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7506: margin: 0;
7507: padding: 0;
1.933 droeschl 7508: position: relative;
7509: list-style: none;
1.913 droeschl 7510: }
1.933 droeschl 7511: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7512: display: inline;
7513: }
1.933 droeschl 7514:
7515: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7516: padding: 0;
1.933 droeschl 7517: margin: 0;
7518: float: left;
1.913 droeschl 7519: }
1.933 droeschl 7520: .LC_breadcrumb_tools_tools {
7521: padding: 0;
7522: margin: 0;
1.913 droeschl 7523: float: right;
7524: }
7525:
1.1240 raeburn 7526: .LC_placement_prog {
7527: padding-right: 20px;
7528: font-weight: bold;
7529: font-size: 90%;
7530: }
7531:
1.359 albertel 7532: table#LC_title_bar td {
7533: background: $tabbg;
7534: }
1.795 www 7535:
1.911 bisitz 7536: table#LC_menubuttons img {
1.803 bisitz 7537: border: none;
1.346 albertel 7538: }
1.795 www 7539:
1.842 droeschl 7540: .LC_breadcrumbs_component {
1.911 bisitz 7541: float: right;
7542: margin: 0 1em;
1.357 albertel 7543: }
1.842 droeschl 7544: .LC_breadcrumbs_component img {
1.911 bisitz 7545: vertical-align: middle;
1.777 tempelho 7546: }
1.795 www 7547:
1.1243 raeburn 7548: .LC_breadcrumbs_hoverable {
7549: background: $sidebg;
7550: }
7551:
1.383 albertel 7552: td.LC_table_cell_checkbox {
7553: text-align: center;
7554: }
1.795 www 7555:
7556: .LC_fontsize_small {
1.911 bisitz 7557: font-size: 70%;
1.705 tempelho 7558: }
7559:
1.844 bisitz 7560: #LC_breadcrumbs {
1.911 bisitz 7561: clear:both;
7562: background: $sidebg;
7563: border-bottom: 1px solid $lg_border_color;
7564: line-height: 2.5em;
1.933 droeschl 7565: overflow: hidden;
1.911 bisitz 7566: margin: 0;
7567: padding: 0;
1.995 raeburn 7568: text-align: left;
1.819 tempelho 7569: }
1.862 bisitz 7570:
1.1098 bisitz 7571: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7572: clear:both;
7573: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7574: border: 1px solid $sidebg;
1.1098 bisitz 7575: margin: 0 0 10px 0;
1.966 bisitz 7576: padding: 3px;
1.995 raeburn 7577: text-align: left;
1.822 bisitz 7578: }
7579:
1.795 www 7580: .LC_fontsize_medium {
1.911 bisitz 7581: font-size: 85%;
1.705 tempelho 7582: }
7583:
1.795 www 7584: .LC_fontsize_large {
1.911 bisitz 7585: font-size: 120%;
1.705 tempelho 7586: }
7587:
1.346 albertel 7588: .LC_menubuttons_inline_text {
7589: color: $font;
1.698 harmsja 7590: font-size: 90%;
1.701 harmsja 7591: padding-left:3px;
1.346 albertel 7592: }
7593:
1.934 droeschl 7594: .LC_menubuttons_inline_text img{
7595: vertical-align: middle;
7596: }
7597:
1.1051 www 7598: li.LC_menubuttons_inline_text img {
1.951 onken 7599: cursor:pointer;
1.1002 droeschl 7600: text-decoration: none;
1.951 onken 7601: }
7602:
1.526 www 7603: .LC_menubuttons_link {
7604: text-decoration: none;
7605: }
1.795 www 7606:
1.522 albertel 7607: .LC_menubuttons_category {
1.521 www 7608: color: $font;
1.526 www 7609: background: $pgbg;
1.521 www 7610: font-size: larger;
7611: font-weight: bold;
7612: }
7613:
1.346 albertel 7614: td.LC_menubuttons_text {
1.911 bisitz 7615: color: $font;
1.346 albertel 7616: }
1.706 harmsja 7617:
1.346 albertel 7618: .LC_current_location {
7619: background: $tabbg;
7620: }
1.795 www 7621:
1.1286 raeburn 7622: td.LC_zero_height {
7623: line-height: 0;
7624: cellpadding: 0;
7625: }
7626:
1.938 bisitz 7627: table.LC_data_table {
1.347 albertel 7628: border: 1px solid #000000;
1.402 albertel 7629: border-collapse: separate;
1.426 albertel 7630: border-spacing: 1px;
1.610 albertel 7631: background: $pgbg;
1.347 albertel 7632: }
1.795 www 7633:
1.422 albertel 7634: .LC_data_table_dense {
7635: font-size: small;
7636: }
1.795 www 7637:
1.507 raeburn 7638: table.LC_nested_outer {
7639: border: 1px solid #000000;
1.589 raeburn 7640: border-collapse: collapse;
1.803 bisitz 7641: border-spacing: 0;
1.507 raeburn 7642: width: 100%;
7643: }
1.795 www 7644:
1.879 raeburn 7645: table.LC_innerpickbox,
1.507 raeburn 7646: table.LC_nested {
1.803 bisitz 7647: border: none;
1.589 raeburn 7648: border-collapse: collapse;
1.803 bisitz 7649: border-spacing: 0;
1.507 raeburn 7650: width: 100%;
7651: }
1.795 www 7652:
1.911 bisitz 7653: table.LC_data_table tr th,
7654: table.LC_calendar tr th,
1.879 raeburn 7655: table.LC_prior_tries tr th,
7656: table.LC_innerpickbox tr th {
1.349 albertel 7657: font-weight: bold;
7658: background-color: $data_table_head;
1.801 tempelho 7659: color:$fontmenu;
1.701 harmsja 7660: font-size:90%;
1.347 albertel 7661: }
1.795 www 7662:
1.879 raeburn 7663: table.LC_innerpickbox tr th,
7664: table.LC_innerpickbox tr td {
7665: vertical-align: top;
7666: }
7667:
1.711 raeburn 7668: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7669: background-color: #CCCCCC;
1.711 raeburn 7670: font-weight: bold;
7671: text-align: left;
7672: }
1.795 www 7673:
1.912 bisitz 7674: table.LC_data_table tr.LC_odd_row > td {
7675: background-color: $data_table_light;
7676: padding: 2px;
7677: vertical-align: top;
7678: }
7679:
1.809 bisitz 7680: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7681: background-color: $data_table_light;
1.912 bisitz 7682: vertical-align: top;
7683: }
7684:
7685: table.LC_data_table tr.LC_even_row > td {
7686: background-color: $data_table_dark;
1.425 albertel 7687: padding: 2px;
1.900 bisitz 7688: vertical-align: top;
1.347 albertel 7689: }
1.795 www 7690:
1.809 bisitz 7691: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7692: background-color: $data_table_dark;
1.900 bisitz 7693: vertical-align: top;
1.347 albertel 7694: }
1.795 www 7695:
1.425 albertel 7696: table.LC_data_table tr.LC_data_table_highlight td {
7697: background-color: $data_table_darker;
7698: }
1.795 www 7699:
1.639 raeburn 7700: table.LC_data_table tr td.LC_leftcol_header {
7701: background-color: $data_table_head;
7702: font-weight: bold;
7703: }
1.795 www 7704:
1.451 albertel 7705: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7706: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7707: font-weight: bold;
7708: font-style: italic;
7709: text-align: center;
7710: padding: 8px;
1.347 albertel 7711: }
1.795 www 7712:
1.1114 raeburn 7713: table.LC_data_table tr.LC_empty_row td,
7714: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7715: background-color: $sidebg;
7716: }
7717:
7718: table.LC_nested tr.LC_empty_row td {
7719: background-color: #FFFFFF;
7720: }
7721:
1.890 droeschl 7722: table.LC_caption {
7723: }
7724:
1.507 raeburn 7725: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7726: padding: 4ex
7727: }
1.795 www 7728:
1.507 raeburn 7729: table.LC_nested_outer tr th {
7730: font-weight: bold;
1.801 tempelho 7731: color:$fontmenu;
1.507 raeburn 7732: background-color: $data_table_head;
1.701 harmsja 7733: font-size: small;
1.507 raeburn 7734: border-bottom: 1px solid #000000;
7735: }
1.795 www 7736:
1.507 raeburn 7737: table.LC_nested_outer tr td.LC_subheader {
7738: background-color: $data_table_head;
7739: font-weight: bold;
7740: font-size: small;
7741: border-bottom: 1px solid #000000;
7742: text-align: right;
1.451 albertel 7743: }
1.795 www 7744:
1.507 raeburn 7745: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7746: background-color: #CCCCCC;
1.451 albertel 7747: font-weight: bold;
7748: font-size: small;
1.507 raeburn 7749: text-align: center;
7750: }
1.795 www 7751:
1.589 raeburn 7752: table.LC_nested tr.LC_info_row td.LC_left_item,
7753: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7754: text-align: left;
1.451 albertel 7755: }
1.795 www 7756:
1.507 raeburn 7757: table.LC_nested td {
1.735 bisitz 7758: background-color: #FFFFFF;
1.451 albertel 7759: font-size: small;
1.507 raeburn 7760: }
1.795 www 7761:
1.507 raeburn 7762: table.LC_nested_outer tr th.LC_right_item,
7763: table.LC_nested tr.LC_info_row td.LC_right_item,
7764: table.LC_nested tr.LC_odd_row td.LC_right_item,
7765: table.LC_nested tr td.LC_right_item {
1.451 albertel 7766: text-align: right;
7767: }
7768:
1.507 raeburn 7769: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7770: background-color: #EEEEEE;
1.451 albertel 7771: }
7772:
1.473 raeburn 7773: table.LC_createuser {
7774: }
7775:
7776: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7777: font-size: small;
1.473 raeburn 7778: }
7779:
7780: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7781: background-color: #CCCCCC;
1.473 raeburn 7782: font-weight: bold;
7783: text-align: center;
7784: }
7785:
1.349 albertel 7786: table.LC_calendar {
7787: border: 1px solid #000000;
7788: border-collapse: collapse;
1.917 raeburn 7789: width: 98%;
1.349 albertel 7790: }
1.795 www 7791:
1.349 albertel 7792: table.LC_calendar_pickdate {
7793: font-size: xx-small;
7794: }
1.795 www 7795:
1.349 albertel 7796: table.LC_calendar tr td {
7797: border: 1px solid #000000;
7798: vertical-align: top;
1.917 raeburn 7799: width: 14%;
1.349 albertel 7800: }
1.795 www 7801:
1.349 albertel 7802: table.LC_calendar tr td.LC_calendar_day_empty {
7803: background-color: $data_table_dark;
7804: }
1.795 www 7805:
1.779 bisitz 7806: table.LC_calendar tr td.LC_calendar_day_current {
7807: background-color: $data_table_highlight;
1.777 tempelho 7808: }
1.795 www 7809:
1.938 bisitz 7810: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7811: background-color: $mail_new;
7812: }
1.795 www 7813:
1.938 bisitz 7814: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7815: background-color: $mail_new_hover;
7816: }
1.795 www 7817:
1.938 bisitz 7818: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7819: background-color: $mail_read;
7820: }
1.795 www 7821:
1.938 bisitz 7822: /*
7823: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7824: background-color: $mail_read_hover;
7825: }
1.938 bisitz 7826: */
1.795 www 7827:
1.938 bisitz 7828: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7829: background-color: $mail_replied;
7830: }
1.795 www 7831:
1.938 bisitz 7832: /*
7833: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7834: background-color: $mail_replied_hover;
7835: }
1.938 bisitz 7836: */
1.795 www 7837:
1.938 bisitz 7838: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7839: background-color: $mail_other;
7840: }
1.795 www 7841:
1.938 bisitz 7842: /*
7843: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7844: background-color: $mail_other_hover;
7845: }
1.938 bisitz 7846: */
1.494 raeburn 7847:
1.777 tempelho 7848: table.LC_data_table tr > td.LC_browser_file,
7849: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7850: background: #AAEE77;
1.389 albertel 7851: }
1.795 www 7852:
1.777 tempelho 7853: table.LC_data_table tr > td.LC_browser_file_locked,
7854: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7855: background: #FFAA99;
1.387 albertel 7856: }
1.795 www 7857:
1.777 tempelho 7858: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7859: background: #888888;
1.779 bisitz 7860: }
1.795 www 7861:
1.777 tempelho 7862: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7863: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7864: background: #F8F866;
1.777 tempelho 7865: }
1.795 www 7866:
1.696 bisitz 7867: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7868: background: #E0E8FF;
1.387 albertel 7869: }
1.696 bisitz 7870:
1.707 bisitz 7871: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7872: /* background: #77FF77; */
1.707 bisitz 7873: }
1.795 www 7874:
1.707 bisitz 7875: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7876: border-right: 8px solid #FFFF77;
1.707 bisitz 7877: }
1.795 www 7878:
1.707 bisitz 7879: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7880: border-right: 8px solid #FFAA77;
1.707 bisitz 7881: }
1.795 www 7882:
1.707 bisitz 7883: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7884: border-right: 8px solid #FF7777;
1.707 bisitz 7885: }
1.795 www 7886:
1.707 bisitz 7887: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7888: border-right: 8px solid #AAFF77;
1.707 bisitz 7889: }
1.795 www 7890:
1.707 bisitz 7891: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7892: border-right: 8px solid #11CC55;
1.707 bisitz 7893: }
7894:
1.388 albertel 7895: span.LC_current_location {
1.701 harmsja 7896: font-size:larger;
1.388 albertel 7897: background: $pgbg;
7898: }
1.387 albertel 7899:
1.1029 www 7900: span.LC_current_nav_location {
7901: font-weight:bold;
7902: background: $sidebg;
7903: }
7904:
1.395 albertel 7905: span.LC_parm_menu_item {
7906: font-size: larger;
7907: }
1.795 www 7908:
1.395 albertel 7909: span.LC_parm_scope_all {
7910: color: red;
7911: }
1.795 www 7912:
1.395 albertel 7913: span.LC_parm_scope_folder {
7914: color: green;
7915: }
1.795 www 7916:
1.395 albertel 7917: span.LC_parm_scope_resource {
7918: color: orange;
7919: }
1.795 www 7920:
1.395 albertel 7921: span.LC_parm_part {
7922: color: blue;
7923: }
1.795 www 7924:
1.911 bisitz 7925: span.LC_parm_folder,
7926: span.LC_parm_symb {
1.395 albertel 7927: font-size: x-small;
7928: font-family: $mono;
7929: color: #AAAAAA;
7930: }
7931:
1.977 bisitz 7932: ul.LC_parm_parmlist li {
7933: display: inline-block;
7934: padding: 0.3em 0.8em;
7935: vertical-align: top;
7936: width: 150px;
7937: border-top:1px solid $lg_border_color;
7938: }
7939:
1.795 www 7940: td.LC_parm_overview_level_menu,
7941: td.LC_parm_overview_map_menu,
7942: td.LC_parm_overview_parm_selectors,
7943: td.LC_parm_overview_restrictions {
1.396 albertel 7944: border: 1px solid black;
7945: border-collapse: collapse;
7946: }
1.795 www 7947:
1.1285 raeburn 7948: span.LC_parm_recursive,
7949: td.LC_parm_recursive {
7950: font-weight: bold;
7951: font-size: smaller;
7952: }
7953:
1.396 albertel 7954: table.LC_parm_overview_restrictions td {
7955: border-width: 1px 4px 1px 4px;
7956: border-style: solid;
7957: border-color: $pgbg;
7958: text-align: center;
7959: }
1.795 www 7960:
1.396 albertel 7961: table.LC_parm_overview_restrictions th {
7962: background: $tabbg;
7963: border-width: 1px 4px 1px 4px;
7964: border-style: solid;
7965: border-color: $pgbg;
7966: }
1.795 www 7967:
1.398 albertel 7968: table#LC_helpmenu {
1.803 bisitz 7969: border: none;
1.398 albertel 7970: height: 55px;
1.803 bisitz 7971: border-spacing: 0;
1.398 albertel 7972: }
7973:
7974: table#LC_helpmenu fieldset legend {
7975: font-size: larger;
7976: }
1.795 www 7977:
1.397 albertel 7978: table#LC_helpmenu_links {
7979: width: 100%;
7980: border: 1px solid black;
7981: background: $pgbg;
1.803 bisitz 7982: padding: 0;
1.397 albertel 7983: border-spacing: 1px;
7984: }
1.795 www 7985:
1.397 albertel 7986: table#LC_helpmenu_links tr td {
7987: padding: 1px;
7988: background: $tabbg;
1.399 albertel 7989: text-align: center;
7990: font-weight: bold;
1.397 albertel 7991: }
1.396 albertel 7992:
1.795 www 7993: table#LC_helpmenu_links a:link,
7994: table#LC_helpmenu_links a:visited,
1.397 albertel 7995: table#LC_helpmenu_links a:active {
7996: text-decoration: none;
7997: color: $font;
7998: }
1.795 www 7999:
1.397 albertel 8000: table#LC_helpmenu_links a:hover {
8001: text-decoration: underline;
8002: color: $vlink;
8003: }
1.396 albertel 8004:
1.417 albertel 8005: .LC_chrt_popup_exists {
8006: border: 1px solid #339933;
8007: margin: -1px;
8008: }
1.795 www 8009:
1.417 albertel 8010: .LC_chrt_popup_up {
8011: border: 1px solid yellow;
8012: margin: -1px;
8013: }
1.795 www 8014:
1.417 albertel 8015: .LC_chrt_popup {
8016: border: 1px solid #8888FF;
8017: background: #CCCCFF;
8018: }
1.795 www 8019:
1.421 albertel 8020: table.LC_pick_box {
8021: border-collapse: separate;
8022: background: white;
8023: border: 1px solid black;
8024: border-spacing: 1px;
8025: }
1.795 www 8026:
1.421 albertel 8027: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8028: background: $sidebg;
1.421 albertel 8029: font-weight: bold;
1.900 bisitz 8030: text-align: left;
1.740 bisitz 8031: vertical-align: top;
1.421 albertel 8032: width: 184px;
8033: padding: 8px;
8034: }
1.795 www 8035:
1.579 raeburn 8036: table.LC_pick_box td.LC_pick_box_value {
8037: text-align: left;
8038: padding: 8px;
8039: }
1.795 www 8040:
1.579 raeburn 8041: table.LC_pick_box td.LC_pick_box_select {
8042: text-align: left;
8043: padding: 8px;
8044: }
1.795 www 8045:
1.424 albertel 8046: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8047: padding: 0;
1.421 albertel 8048: height: 1px;
8049: background: black;
8050: }
1.795 www 8051:
1.421 albertel 8052: table.LC_pick_box td.LC_pick_box_submit {
8053: text-align: right;
8054: }
1.795 www 8055:
1.579 raeburn 8056: table.LC_pick_box td.LC_evenrow_value {
8057: text-align: left;
8058: padding: 8px;
8059: background-color: $data_table_light;
8060: }
1.795 www 8061:
1.579 raeburn 8062: table.LC_pick_box td.LC_oddrow_value {
8063: text-align: left;
8064: padding: 8px;
8065: background-color: $data_table_light;
8066: }
1.795 www 8067:
1.579 raeburn 8068: span.LC_helpform_receipt_cat {
8069: font-weight: bold;
8070: }
1.795 www 8071:
1.424 albertel 8072: table.LC_group_priv_box {
8073: background: white;
8074: border: 1px solid black;
8075: border-spacing: 1px;
8076: }
1.795 www 8077:
1.424 albertel 8078: table.LC_group_priv_box td.LC_pick_box_title {
8079: background: $tabbg;
8080: font-weight: bold;
8081: text-align: right;
8082: width: 184px;
8083: }
1.795 www 8084:
1.424 albertel 8085: table.LC_group_priv_box td.LC_groups_fixed {
8086: background: $data_table_light;
8087: text-align: center;
8088: }
1.795 www 8089:
1.424 albertel 8090: table.LC_group_priv_box td.LC_groups_optional {
8091: background: $data_table_dark;
8092: text-align: center;
8093: }
1.795 www 8094:
1.424 albertel 8095: table.LC_group_priv_box td.LC_groups_functionality {
8096: background: $data_table_darker;
8097: text-align: center;
8098: font-weight: bold;
8099: }
1.795 www 8100:
1.424 albertel 8101: table.LC_group_priv td {
8102: text-align: left;
1.803 bisitz 8103: padding: 0;
1.424 albertel 8104: }
8105:
8106: .LC_navbuttons {
8107: margin: 2ex 0ex 2ex 0ex;
8108: }
1.795 www 8109:
1.423 albertel 8110: .LC_topic_bar {
8111: font-weight: bold;
8112: background: $tabbg;
1.918 wenzelju 8113: margin: 1em 0em 1em 2em;
1.805 bisitz 8114: padding: 3px;
1.918 wenzelju 8115: font-size: 1.2em;
1.423 albertel 8116: }
1.795 www 8117:
1.423 albertel 8118: .LC_topic_bar span {
1.918 wenzelju 8119: left: 0.5em;
8120: position: absolute;
1.423 albertel 8121: vertical-align: middle;
1.918 wenzelju 8122: font-size: 1.2em;
1.423 albertel 8123: }
1.795 www 8124:
1.423 albertel 8125: table.LC_course_group_status {
8126: margin: 20px;
8127: }
1.795 www 8128:
1.423 albertel 8129: table.LC_status_selector td {
8130: vertical-align: top;
8131: text-align: center;
1.424 albertel 8132: padding: 4px;
8133: }
1.795 www 8134:
1.599 albertel 8135: div.LC_feedback_link {
1.616 albertel 8136: clear: both;
1.829 kalberla 8137: background: $sidebg;
1.779 bisitz 8138: width: 100%;
1.829 kalberla 8139: padding-bottom: 10px;
8140: border: 1px $tabbg solid;
1.833 kalberla 8141: height: 22px;
8142: line-height: 22px;
8143: padding-top: 5px;
8144: }
8145:
8146: div.LC_feedback_link img {
8147: height: 22px;
1.867 kalberla 8148: vertical-align:middle;
1.829 kalberla 8149: }
8150:
1.911 bisitz 8151: div.LC_feedback_link a {
1.829 kalberla 8152: text-decoration: none;
1.489 raeburn 8153: }
1.795 www 8154:
1.867 kalberla 8155: div.LC_comblock {
1.911 bisitz 8156: display:inline;
1.867 kalberla 8157: color:$font;
8158: font-size:90%;
8159: }
8160:
8161: div.LC_feedback_link div.LC_comblock {
8162: padding-left:5px;
8163: }
8164:
8165: div.LC_feedback_link div.LC_comblock a {
8166: color:$font;
8167: }
8168:
1.489 raeburn 8169: span.LC_feedback_link {
1.858 bisitz 8170: /* background: $feedback_link_bg; */
1.599 albertel 8171: font-size: larger;
8172: }
1.795 www 8173:
1.599 albertel 8174: span.LC_message_link {
1.858 bisitz 8175: /* background: $feedback_link_bg; */
1.599 albertel 8176: font-size: larger;
8177: position: absolute;
8178: right: 1em;
1.489 raeburn 8179: }
1.421 albertel 8180:
1.515 albertel 8181: table.LC_prior_tries {
1.524 albertel 8182: border: 1px solid #000000;
8183: border-collapse: separate;
8184: border-spacing: 1px;
1.515 albertel 8185: }
1.523 albertel 8186:
1.515 albertel 8187: table.LC_prior_tries td {
1.524 albertel 8188: padding: 2px;
1.515 albertel 8189: }
1.523 albertel 8190:
8191: .LC_answer_correct {
1.795 www 8192: background: lightgreen;
8193: color: darkgreen;
8194: padding: 6px;
1.523 albertel 8195: }
1.795 www 8196:
1.523 albertel 8197: .LC_answer_charged_try {
1.797 www 8198: background: #FFAAAA;
1.795 www 8199: color: darkred;
8200: padding: 6px;
1.523 albertel 8201: }
1.795 www 8202:
1.779 bisitz 8203: .LC_answer_not_charged_try,
1.523 albertel 8204: .LC_answer_no_grade,
8205: .LC_answer_late {
1.795 www 8206: background: lightyellow;
1.523 albertel 8207: color: black;
1.795 www 8208: padding: 6px;
1.523 albertel 8209: }
1.795 www 8210:
1.523 albertel 8211: .LC_answer_previous {
1.795 www 8212: background: lightblue;
8213: color: darkblue;
8214: padding: 6px;
1.523 albertel 8215: }
1.795 www 8216:
1.779 bisitz 8217: .LC_answer_no_message {
1.777 tempelho 8218: background: #FFFFFF;
8219: color: black;
1.795 www 8220: padding: 6px;
1.779 bisitz 8221: }
1.795 www 8222:
1.1334 raeburn 8223: .LC_answer_unknown,
8224: .LC_answer_warning {
1.779 bisitz 8225: background: orange;
8226: color: black;
1.795 www 8227: padding: 6px;
1.777 tempelho 8228: }
1.795 www 8229:
1.529 albertel 8230: span.LC_prior_numerical,
8231: span.LC_prior_string,
8232: span.LC_prior_custom,
8233: span.LC_prior_reaction,
8234: span.LC_prior_math {
1.925 bisitz 8235: font-family: $mono;
1.523 albertel 8236: white-space: pre;
8237: }
8238:
1.525 albertel 8239: span.LC_prior_string {
1.925 bisitz 8240: font-family: $mono;
1.525 albertel 8241: white-space: pre;
8242: }
8243:
1.523 albertel 8244: table.LC_prior_option {
8245: width: 100%;
8246: border-collapse: collapse;
8247: }
1.795 www 8248:
1.911 bisitz 8249: table.LC_prior_rank,
1.795 www 8250: table.LC_prior_match {
1.528 albertel 8251: border-collapse: collapse;
8252: }
1.795 www 8253:
1.528 albertel 8254: table.LC_prior_option tr td,
8255: table.LC_prior_rank tr td,
8256: table.LC_prior_match tr td {
1.524 albertel 8257: border: 1px solid #000000;
1.515 albertel 8258: }
8259:
1.855 bisitz 8260: .LC_nobreak {
1.544 albertel 8261: white-space: nowrap;
1.519 raeburn 8262: }
8263:
1.576 raeburn 8264: span.LC_cusr_emph {
8265: font-style: italic;
8266: }
8267:
1.633 raeburn 8268: span.LC_cusr_subheading {
8269: font-weight: normal;
8270: font-size: 85%;
8271: }
8272:
1.861 bisitz 8273: div.LC_docs_entry_move {
1.859 bisitz 8274: border: 1px solid #BBBBBB;
1.545 albertel 8275: background: #DDDDDD;
1.861 bisitz 8276: width: 22px;
1.859 bisitz 8277: padding: 1px;
8278: margin: 0;
1.545 albertel 8279: }
8280:
1.861 bisitz 8281: table.LC_data_table tr > td.LC_docs_entry_commands,
8282: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8283: font-size: x-small;
8284: }
1.795 www 8285:
1.861 bisitz 8286: .LC_docs_entry_parameter {
8287: white-space: nowrap;
8288: }
8289:
1.544 albertel 8290: .LC_docs_copy {
1.545 albertel 8291: color: #000099;
1.544 albertel 8292: }
1.795 www 8293:
1.544 albertel 8294: .LC_docs_cut {
1.545 albertel 8295: color: #550044;
1.544 albertel 8296: }
1.795 www 8297:
1.544 albertel 8298: .LC_docs_rename {
1.545 albertel 8299: color: #009900;
1.544 albertel 8300: }
1.795 www 8301:
1.544 albertel 8302: .LC_docs_remove {
1.545 albertel 8303: color: #990000;
8304: }
8305:
1.1284 raeburn 8306: .LC_docs_alias {
8307: color: #440055;
8308: }
8309:
1.1286 raeburn 8310: .LC_domprefs_email,
1.1284 raeburn 8311: .LC_docs_alias_name,
1.547 albertel 8312: .LC_docs_reinit_warn,
8313: .LC_docs_ext_edit {
8314: font-size: x-small;
8315: }
8316:
1.545 albertel 8317: table.LC_docs_adddocs td,
8318: table.LC_docs_adddocs th {
8319: border: 1px solid #BBBBBB;
8320: padding: 4px;
8321: background: #DDDDDD;
1.543 albertel 8322: }
8323:
1.584 albertel 8324: table.LC_sty_begin {
8325: background: #BBFFBB;
8326: }
1.795 www 8327:
1.584 albertel 8328: table.LC_sty_end {
8329: background: #FFBBBB;
8330: }
8331:
1.589 raeburn 8332: table.LC_double_column {
1.803 bisitz 8333: border-width: 0;
1.589 raeburn 8334: border-collapse: collapse;
8335: width: 100%;
8336: padding: 2px;
8337: }
8338:
8339: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8340: top: 2px;
1.589 raeburn 8341: left: 2px;
8342: width: 47%;
8343: vertical-align: top;
8344: }
8345:
8346: table.LC_double_column tr td.LC_right_col {
8347: top: 2px;
1.779 bisitz 8348: right: 2px;
1.589 raeburn 8349: width: 47%;
8350: vertical-align: top;
8351: }
8352:
1.591 raeburn 8353: div.LC_left_float {
8354: float: left;
8355: padding-right: 5%;
1.597 albertel 8356: padding-bottom: 4px;
1.591 raeburn 8357: }
8358:
8359: div.LC_clear_float_header {
1.597 albertel 8360: padding-bottom: 2px;
1.591 raeburn 8361: }
8362:
8363: div.LC_clear_float_footer {
1.597 albertel 8364: padding-top: 10px;
1.591 raeburn 8365: clear: both;
8366: }
8367:
1.597 albertel 8368: div.LC_grade_show_user {
1.941 bisitz 8369: /* border-left: 5px solid $sidebg; */
8370: border-top: 5px solid #000000;
8371: margin: 50px 0 0 0;
1.936 bisitz 8372: padding: 15px 0 5px 10px;
1.597 albertel 8373: }
1.795 www 8374:
1.936 bisitz 8375: div.LC_grade_show_user_odd_row {
1.941 bisitz 8376: /* border-left: 5px solid #000000; */
8377: }
8378:
8379: div.LC_grade_show_user div.LC_Box {
8380: margin-right: 50px;
1.597 albertel 8381: }
8382:
8383: div.LC_grade_submissions,
8384: div.LC_grade_message_center,
1.936 bisitz 8385: div.LC_grade_info_links {
1.597 albertel 8386: margin: 5px;
8387: width: 99%;
8388: background: #FFFFFF;
8389: }
1.795 www 8390:
1.597 albertel 8391: div.LC_grade_submissions_header,
1.936 bisitz 8392: div.LC_grade_message_center_header {
1.705 tempelho 8393: font-weight: bold;
8394: font-size: large;
1.597 albertel 8395: }
1.795 www 8396:
1.597 albertel 8397: div.LC_grade_submissions_body,
1.936 bisitz 8398: div.LC_grade_message_center_body {
1.597 albertel 8399: border: 1px solid black;
8400: width: 99%;
8401: background: #FFFFFF;
8402: }
1.795 www 8403:
1.613 albertel 8404: table.LC_scantron_action {
8405: width: 100%;
8406: }
1.795 www 8407:
1.613 albertel 8408: table.LC_scantron_action tr th {
1.698 harmsja 8409: font-weight:bold;
8410: font-style:normal;
1.613 albertel 8411: }
1.795 www 8412:
1.779 bisitz 8413: .LC_edit_problem_header,
1.614 albertel 8414: div.LC_edit_problem_footer {
1.705 tempelho 8415: font-weight: normal;
8416: font-size: medium;
1.602 albertel 8417: margin: 2px;
1.1060 bisitz 8418: background-color: $sidebg;
1.600 albertel 8419: }
1.795 www 8420:
1.600 albertel 8421: div.LC_edit_problem_header,
1.602 albertel 8422: div.LC_edit_problem_header div,
1.614 albertel 8423: div.LC_edit_problem_footer,
8424: div.LC_edit_problem_footer div,
1.602 albertel 8425: div.LC_edit_problem_editxml_header,
8426: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8427: z-index: 100;
1.600 albertel 8428: }
1.795 www 8429:
1.600 albertel 8430: div.LC_edit_problem_header_title {
1.705 tempelho 8431: font-weight: bold;
8432: font-size: larger;
1.602 albertel 8433: background: $tabbg;
8434: padding: 3px;
1.1060 bisitz 8435: margin: 0 0 5px 0;
1.602 albertel 8436: }
1.795 www 8437:
1.602 albertel 8438: table.LC_edit_problem_header_title {
8439: width: 100%;
1.600 albertel 8440: background: $tabbg;
1.602 albertel 8441: }
8442:
1.1205 golterma 8443: div.LC_edit_actionbar {
8444: background-color: $sidebg;
1.1218 droeschl 8445: margin: 0;
8446: padding: 0;
8447: line-height: 200%;
1.602 albertel 8448: }
1.795 www 8449:
1.1218 droeschl 8450: div.LC_edit_actionbar div{
8451: padding: 0;
8452: margin: 0;
8453: display: inline-block;
1.600 albertel 8454: }
1.795 www 8455:
1.1124 bisitz 8456: .LC_edit_opt {
8457: padding-left: 1em;
8458: white-space: nowrap;
8459: }
8460:
1.1152 golterma 8461: .LC_edit_problem_latexhelper{
8462: text-align: right;
8463: }
8464:
8465: #LC_edit_problem_colorful div{
8466: margin-left: 40px;
8467: }
8468:
1.1205 golterma 8469: #LC_edit_problem_codemirror div{
8470: margin-left: 0px;
8471: }
8472:
1.911 bisitz 8473: img.stift {
1.803 bisitz 8474: border-width: 0;
8475: vertical-align: middle;
1.677 riegler 8476: }
1.680 riegler 8477:
1.923 bisitz 8478: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8479: vertical-align: top;
1.777 tempelho 8480: }
1.795 www 8481:
1.716 raeburn 8482: div.LC_createcourse {
1.911 bisitz 8483: margin: 10px 10px 10px 10px;
1.716 raeburn 8484: }
8485:
1.917 raeburn 8486: .LC_dccid {
1.1130 raeburn 8487: float: right;
1.917 raeburn 8488: margin: 0.2em 0 0 0;
8489: padding: 0;
8490: font-size: 90%;
8491: display:none;
8492: }
8493:
1.897 wenzelju 8494: ol.LC_primary_menu a:hover,
1.721 harmsja 8495: ol#LC_MenuBreadcrumbs a:hover,
8496: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8497: ul#LC_secondary_menu a:hover,
1.721 harmsja 8498: .LC_FormSectionClearButton input:hover
1.795 www 8499: ul.LC_TabContent li:hover a {
1.952 onken 8500: color:$button_hover;
1.911 bisitz 8501: text-decoration:none;
1.693 droeschl 8502: }
8503:
1.779 bisitz 8504: h1 {
1.911 bisitz 8505: padding: 0;
8506: line-height:130%;
1.693 droeschl 8507: }
1.698 harmsja 8508:
1.911 bisitz 8509: h2,
8510: h3,
8511: h4,
8512: h5,
8513: h6 {
8514: margin: 5px 0 5px 0;
8515: padding: 0;
8516: line-height:130%;
1.693 droeschl 8517: }
1.795 www 8518:
8519: .LC_hcell {
1.911 bisitz 8520: padding:3px 15px 3px 15px;
8521: margin: 0;
8522: background-color:$tabbg;
8523: color:$fontmenu;
8524: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8525: }
1.795 www 8526:
1.840 bisitz 8527: .LC_Box > .LC_hcell {
1.911 bisitz 8528: margin: 0 -10px 10px -10px;
1.835 bisitz 8529: }
8530:
1.721 harmsja 8531: .LC_noBorder {
1.911 bisitz 8532: border: 0;
1.698 harmsja 8533: }
1.693 droeschl 8534:
1.721 harmsja 8535: .LC_FormSectionClearButton input {
1.911 bisitz 8536: background-color:transparent;
8537: border: none;
8538: cursor:pointer;
8539: text-decoration:underline;
1.693 droeschl 8540: }
1.763 bisitz 8541:
8542: .LC_help_open_topic {
1.911 bisitz 8543: color: #FFFFFF;
8544: background-color: #EEEEFF;
8545: margin: 1px;
8546: padding: 4px;
8547: border: 1px solid #000033;
8548: white-space: nowrap;
8549: /* vertical-align: middle; */
1.759 neumanie 8550: }
1.693 droeschl 8551:
1.911 bisitz 8552: dl,
8553: ul,
8554: div,
8555: fieldset {
8556: margin: 10px 10px 10px 0;
8557: /* overflow: hidden; */
1.693 droeschl 8558: }
1.795 www 8559:
1.1404 raeburn 8560: fieldset#LC_selectuser {
8561: margin: 0;
8562: padding: 0;
8563: }
8564:
1.1211 raeburn 8565: article.geogebraweb div {
8566: margin: 0;
8567: }
8568:
1.838 bisitz 8569: fieldset > legend {
1.911 bisitz 8570: font-weight: bold;
8571: padding: 0 5px 0 5px;
1.838 bisitz 8572: }
8573:
1.813 bisitz 8574: #LC_nav_bar {
1.911 bisitz 8575: float: left;
1.995 raeburn 8576: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8577: margin: 0 0 2px 0;
1.807 droeschl 8578: }
8579:
1.916 droeschl 8580: #LC_realm {
8581: margin: 0.2em 0 0 0;
8582: padding: 0;
8583: font-weight: bold;
8584: text-align: center;
1.995 raeburn 8585: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8586: }
8587:
1.911 bisitz 8588: #LC_nav_bar em {
8589: font-weight: bold;
8590: font-style: normal;
1.807 droeschl 8591: }
8592:
1.897 wenzelju 8593: ol.LC_primary_menu {
1.934 droeschl 8594: margin: 0;
1.1076 raeburn 8595: padding: 0;
1.807 droeschl 8596: }
8597:
1.852 droeschl 8598: ol#LC_PathBreadcrumbs {
1.911 bisitz 8599: margin: 0;
1.693 droeschl 8600: }
8601:
1.897 wenzelju 8602: ol.LC_primary_menu li {
1.1076 raeburn 8603: color: RGB(80, 80, 80);
8604: vertical-align: middle;
8605: text-align: left;
8606: list-style: none;
1.1205 golterma 8607: position: relative;
1.1076 raeburn 8608: float: left;
1.1205 golterma 8609: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8610: line-height: 1.5em;
1.1076 raeburn 8611: }
8612:
1.1205 golterma 8613: ol.LC_primary_menu li a,
8614: ol.LC_primary_menu li p {
1.1076 raeburn 8615: display: block;
8616: margin: 0;
8617: padding: 0 5px 0 10px;
8618: text-decoration: none;
8619: }
8620:
1.1205 golterma 8621: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8622: display: inline-block;
8623: width: 95%;
8624: text-align: left;
8625: }
8626:
8627: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8628: display: inline-block;
8629: width: 5%;
8630: float: right;
8631: text-align: right;
8632: font-size: 70%;
8633: }
8634:
8635: ol.LC_primary_menu ul {
1.1076 raeburn 8636: display: none;
1.1205 golterma 8637: width: 15em;
1.1076 raeburn 8638: background-color: $data_table_light;
1.1205 golterma 8639: position: absolute;
8640: top: 100%;
1.1076 raeburn 8641: }
8642:
1.1205 golterma 8643: ol.LC_primary_menu ul ul {
8644: left: 100%;
8645: top: 0;
8646: }
8647:
8648: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8649: display: block;
8650: position: absolute;
8651: margin: 0;
8652: padding: 0;
1.1078 raeburn 8653: z-index: 2;
1.1076 raeburn 8654: }
8655:
8656: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8657: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8658: font-size: 90%;
1.911 bisitz 8659: vertical-align: top;
1.1076 raeburn 8660: float: none;
1.1079 raeburn 8661: border-left: 1px solid black;
8662: border-right: 1px solid black;
1.1205 golterma 8663: /* A dark bottom border to visualize different menu options;
8664: overwritten in the create_submenu routine for the last border-bottom of the menu */
8665: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8666: }
8667:
1.1205 golterma 8668: ol.LC_primary_menu li li p:hover {
8669: color:$button_hover;
8670: text-decoration:none;
8671: background-color:$data_table_dark;
1.1076 raeburn 8672: }
8673:
8674: ol.LC_primary_menu li li a:hover {
8675: color:$button_hover;
8676: background-color:$data_table_dark;
1.693 droeschl 8677: }
8678:
1.1205 golterma 8679: /* Font-size equal to the size of the predecessors*/
8680: ol.LC_primary_menu li:hover li li {
8681: font-size: 100%;
8682: }
8683:
1.897 wenzelju 8684: ol.LC_primary_menu li img {
1.911 bisitz 8685: vertical-align: bottom;
1.934 droeschl 8686: height: 1.1em;
1.1077 raeburn 8687: margin: 0.2em 0 0 0;
1.693 droeschl 8688: }
8689:
1.897 wenzelju 8690: ol.LC_primary_menu a {
1.911 bisitz 8691: color: RGB(80, 80, 80);
8692: text-decoration: none;
1.693 droeschl 8693: }
1.795 www 8694:
1.949 droeschl 8695: ol.LC_primary_menu a.LC_new_message {
8696: font-weight:bold;
8697: color: darkred;
8698: }
8699:
1.975 raeburn 8700: ol.LC_docs_parameters {
8701: margin-left: 0;
8702: padding: 0;
8703: list-style: none;
8704: }
8705:
8706: ol.LC_docs_parameters li {
8707: margin: 0;
8708: padding-right: 20px;
8709: display: inline;
8710: }
8711:
1.976 raeburn 8712: ol.LC_docs_parameters li:before {
8713: content: "\\002022 \\0020";
8714: }
8715:
8716: li.LC_docs_parameters_title {
8717: font-weight: bold;
8718: }
8719:
8720: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8721: content: "";
8722: }
8723:
1.897 wenzelju 8724: ul#LC_secondary_menu {
1.1107 raeburn 8725: clear: right;
1.911 bisitz 8726: color: $fontmenu;
8727: background: $tabbg;
8728: list-style: none;
8729: padding: 0;
8730: margin: 0;
8731: width: 100%;
1.995 raeburn 8732: text-align: left;
1.1107 raeburn 8733: float: left;
1.808 droeschl 8734: }
8735:
1.897 wenzelju 8736: ul#LC_secondary_menu li {
1.911 bisitz 8737: font-weight: bold;
8738: line-height: 1.8em;
1.1107 raeburn 8739: border-right: 1px solid black;
8740: float: left;
8741: }
8742:
8743: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8744: background-color: $data_table_light;
8745: }
8746:
8747: ul#LC_secondary_menu li a {
1.911 bisitz 8748: padding: 0 0.8em;
1.1107 raeburn 8749: }
8750:
8751: ul#LC_secondary_menu li ul {
8752: display: none;
8753: }
8754:
8755: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8756: display: block;
8757: position: absolute;
8758: margin: 0;
8759: padding: 0;
8760: list-style:none;
8761: float: none;
8762: background-color: $data_table_light;
8763: z-index: 2;
8764: margin-left: -1px;
8765: }
8766:
8767: ul#LC_secondary_menu li ul li {
8768: font-size: 90%;
8769: vertical-align: top;
8770: border-left: 1px solid black;
1.911 bisitz 8771: border-right: 1px solid black;
1.1119 raeburn 8772: background-color: $data_table_light;
1.1107 raeburn 8773: list-style:none;
8774: float: none;
8775: }
8776:
8777: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8778: background-color: $data_table_dark;
1.807 droeschl 8779: }
8780:
1.847 tempelho 8781: ul.LC_TabContent {
1.911 bisitz 8782: display:block;
8783: background: $sidebg;
8784: border-bottom: solid 1px $lg_border_color;
8785: list-style:none;
1.1020 raeburn 8786: margin: -1px -10px 0 -10px;
1.911 bisitz 8787: padding: 0;
1.693 droeschl 8788: }
8789:
1.795 www 8790: ul.LC_TabContent li,
8791: ul.LC_TabContentBigger li {
1.911 bisitz 8792: float:left;
1.741 harmsja 8793: }
1.795 www 8794:
1.897 wenzelju 8795: ul#LC_secondary_menu li a {
1.911 bisitz 8796: color: $fontmenu;
8797: text-decoration: none;
1.693 droeschl 8798: }
1.795 www 8799:
1.721 harmsja 8800: ul.LC_TabContent {
1.952 onken 8801: min-height:20px;
1.721 harmsja 8802: }
1.795 www 8803:
8804: ul.LC_TabContent li {
1.911 bisitz 8805: vertical-align:middle;
1.959 onken 8806: padding: 0 16px 0 10px;
1.911 bisitz 8807: background-color:$tabbg;
8808: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8809: border-left: solid 1px $font;
1.721 harmsja 8810: }
1.795 www 8811:
1.847 tempelho 8812: ul.LC_TabContent .right {
1.911 bisitz 8813: float:right;
1.847 tempelho 8814: }
8815:
1.911 bisitz 8816: ul.LC_TabContent li a,
8817: ul.LC_TabContent li {
8818: color:rgb(47,47,47);
8819: text-decoration:none;
8820: font-size:95%;
8821: font-weight:bold;
1.952 onken 8822: min-height:20px;
8823: }
8824:
1.959 onken 8825: ul.LC_TabContent li a:hover,
8826: ul.LC_TabContent li a:focus {
1.952 onken 8827: color: $button_hover;
1.959 onken 8828: background:none;
8829: outline:none;
1.952 onken 8830: }
8831:
8832: ul.LC_TabContent li:hover {
8833: color: $button_hover;
8834: cursor:pointer;
1.721 harmsja 8835: }
1.795 www 8836:
1.911 bisitz 8837: ul.LC_TabContent li.active {
1.952 onken 8838: color: $font;
1.911 bisitz 8839: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8840: border-bottom:solid 1px #FFFFFF;
8841: cursor: default;
1.744 ehlerst 8842: }
1.795 www 8843:
1.959 onken 8844: ul.LC_TabContent li.active a {
8845: color:$font;
8846: background:#FFFFFF;
8847: outline: none;
8848: }
1.1047 raeburn 8849:
8850: ul.LC_TabContent li.goback {
8851: float: left;
8852: border-left: none;
8853: }
8854:
1.870 tempelho 8855: #maincoursedoc {
1.911 bisitz 8856: clear:both;
1.870 tempelho 8857: }
8858:
8859: ul.LC_TabContentBigger {
1.911 bisitz 8860: display:block;
8861: list-style:none;
8862: padding: 0;
1.870 tempelho 8863: }
8864:
1.795 www 8865: ul.LC_TabContentBigger li {
1.911 bisitz 8866: vertical-align:bottom;
8867: height: 30px;
8868: font-size:110%;
8869: font-weight:bold;
8870: color: #737373;
1.841 tempelho 8871: }
8872:
1.957 onken 8873: ul.LC_TabContentBigger li.active {
8874: position: relative;
8875: top: 1px;
8876: }
8877:
1.870 tempelho 8878: ul.LC_TabContentBigger li a {
1.911 bisitz 8879: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8880: height: 30px;
8881: line-height: 30px;
8882: text-align: center;
8883: display: block;
8884: text-decoration: none;
1.958 onken 8885: outline: none;
1.741 harmsja 8886: }
1.795 www 8887:
1.870 tempelho 8888: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8889: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8890: color:$font;
1.744 ehlerst 8891: }
1.795 www 8892:
1.870 tempelho 8893: ul.LC_TabContentBigger li b {
1.911 bisitz 8894: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8895: display: block;
8896: float: left;
8897: padding: 0 30px;
1.957 onken 8898: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8899: }
8900:
1.956 onken 8901: ul.LC_TabContentBigger li:hover b {
8902: color:$button_hover;
8903: }
8904:
1.870 tempelho 8905: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8906: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8907: color:$font;
1.957 onken 8908: border: 0;
1.741 harmsja 8909: }
1.693 droeschl 8910:
1.870 tempelho 8911:
1.862 bisitz 8912: ul.LC_CourseBreadcrumbs {
8913: background: $sidebg;
1.1020 raeburn 8914: height: 2em;
1.862 bisitz 8915: padding-left: 10px;
1.1020 raeburn 8916: margin: 0;
1.862 bisitz 8917: list-style-position: inside;
8918: }
8919:
1.911 bisitz 8920: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8921: ol#LC_PathBreadcrumbs {
1.911 bisitz 8922: padding-left: 10px;
8923: margin: 0;
1.933 droeschl 8924: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8925: }
8926:
1.911 bisitz 8927: ol#LC_MenuBreadcrumbs li,
8928: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8929: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8930: display: inline;
1.933 droeschl 8931: white-space: normal;
1.693 droeschl 8932: }
8933:
1.823 bisitz 8934: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8935: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8936: text-decoration: none;
8937: font-size:90%;
1.693 droeschl 8938: }
1.795 www 8939:
1.969 droeschl 8940: ol#LC_MenuBreadcrumbs h1 {
8941: display: inline;
8942: font-size: 90%;
8943: line-height: 2.5em;
8944: margin: 0;
8945: padding: 0;
8946: }
8947:
1.795 www 8948: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8949: text-decoration:none;
8950: font-size:100%;
8951: font-weight:bold;
1.693 droeschl 8952: }
1.795 www 8953:
1.840 bisitz 8954: .LC_Box {
1.911 bisitz 8955: border: solid 1px $lg_border_color;
8956: padding: 0 10px 10px 10px;
1.746 neumanie 8957: }
1.795 www 8958:
1.1020 raeburn 8959: .LC_DocsBox {
8960: border: solid 1px $lg_border_color;
8961: padding: 0 0 10px 10px;
8962: }
8963:
1.795 www 8964: .LC_AboutMe_Image {
1.911 bisitz 8965: float:left;
8966: margin-right:10px;
1.747 neumanie 8967: }
1.795 www 8968:
8969: .LC_Clear_AboutMe_Image {
1.911 bisitz 8970: clear:left;
1.747 neumanie 8971: }
1.795 www 8972:
1.721 harmsja 8973: dl.LC_ListStyleClean dt {
1.911 bisitz 8974: padding-right: 5px;
8975: display: table-header-group;
1.693 droeschl 8976: }
8977:
1.721 harmsja 8978: dl.LC_ListStyleClean dd {
1.911 bisitz 8979: display: table-row;
1.693 droeschl 8980: }
8981:
1.721 harmsja 8982: .LC_ListStyleClean,
8983: .LC_ListStyleSimple,
8984: .LC_ListStyleNormal,
1.795 www 8985: .LC_ListStyleSpecial {
1.911 bisitz 8986: /* display:block; */
8987: list-style-position: inside;
8988: list-style-type: none;
8989: overflow: hidden;
8990: padding: 0;
1.693 droeschl 8991: }
8992:
1.721 harmsja 8993: .LC_ListStyleSimple li,
8994: .LC_ListStyleSimple dd,
8995: .LC_ListStyleNormal li,
8996: .LC_ListStyleNormal dd,
8997: .LC_ListStyleSpecial li,
1.795 www 8998: .LC_ListStyleSpecial dd {
1.911 bisitz 8999: margin: 0;
9000: padding: 5px 5px 5px 10px;
9001: clear: both;
1.693 droeschl 9002: }
9003:
1.721 harmsja 9004: .LC_ListStyleClean li,
9005: .LC_ListStyleClean dd {
1.911 bisitz 9006: padding-top: 0;
9007: padding-bottom: 0;
1.693 droeschl 9008: }
9009:
1.721 harmsja 9010: .LC_ListStyleSimple dd,
1.795 www 9011: .LC_ListStyleSimple li {
1.911 bisitz 9012: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9013: }
9014:
1.721 harmsja 9015: .LC_ListStyleSpecial li,
9016: .LC_ListStyleSpecial dd {
1.911 bisitz 9017: list-style-type: none;
9018: background-color: RGB(220, 220, 220);
9019: margin-bottom: 4px;
1.693 droeschl 9020: }
9021:
1.721 harmsja 9022: table.LC_SimpleTable {
1.911 bisitz 9023: margin:5px;
9024: border:solid 1px $lg_border_color;
1.795 www 9025: }
1.693 droeschl 9026:
1.721 harmsja 9027: table.LC_SimpleTable tr {
1.911 bisitz 9028: padding: 0;
9029: border:solid 1px $lg_border_color;
1.693 droeschl 9030: }
1.795 www 9031:
9032: table.LC_SimpleTable thead {
1.911 bisitz 9033: background:rgb(220,220,220);
1.693 droeschl 9034: }
9035:
1.721 harmsja 9036: div.LC_columnSection {
1.911 bisitz 9037: display: block;
9038: clear: both;
9039: overflow: hidden;
9040: margin: 0;
1.693 droeschl 9041: }
9042:
1.721 harmsja 9043: div.LC_columnSection>* {
1.911 bisitz 9044: float: left;
9045: margin: 10px 20px 10px 0;
9046: overflow:hidden;
1.693 droeschl 9047: }
1.721 harmsja 9048:
1.795 www 9049: table em {
1.911 bisitz 9050: font-weight: bold;
9051: font-style: normal;
1.748 schulted 9052: }
1.795 www 9053:
1.779 bisitz 9054: table.LC_tableBrowseRes,
1.795 www 9055: table.LC_tableOfContent {
1.911 bisitz 9056: border:none;
9057: border-spacing: 1px;
9058: padding: 3px;
9059: background-color: #FFFFFF;
9060: font-size: 90%;
1.753 droeschl 9061: }
1.789 droeschl 9062:
1.911 bisitz 9063: table.LC_tableOfContent {
9064: border-collapse: collapse;
1.789 droeschl 9065: }
9066:
1.771 droeschl 9067: table.LC_tableBrowseRes a,
1.768 schulted 9068: table.LC_tableOfContent a {
1.911 bisitz 9069: background-color: transparent;
9070: text-decoration: none;
1.753 droeschl 9071: }
9072:
1.795 www 9073: table.LC_tableOfContent img {
1.911 bisitz 9074: border: none;
9075: height: 1.3em;
9076: vertical-align: text-bottom;
9077: margin-right: 0.3em;
1.753 droeschl 9078: }
1.757 schulted 9079:
1.795 www 9080: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9081: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9082: }
9083:
1.795 www 9084: a#LC_content_toolbar_everything {
1.911 bisitz 9085: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9086: }
9087:
1.795 www 9088: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9089: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9090: }
9091:
1.795 www 9092: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9093: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9094: }
9095:
1.795 www 9096: a#LC_content_toolbar_changefolder {
1.911 bisitz 9097: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9098: }
9099:
1.795 www 9100: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9101: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9102: }
9103:
1.1043 raeburn 9104: a#LC_content_toolbar_edittoplevel {
9105: background-image:url(/res/adm/pages/edittoplevel.gif);
9106: }
9107:
1.1384 raeburn 9108: a#LC_content_toolbar_printout {
9109: background-image:url(/res/adm/pages/printout.gif);
9110: }
9111:
1.795 www 9112: ul#LC_toolbar li a:hover {
1.911 bisitz 9113: background-position: bottom center;
1.757 schulted 9114: }
9115:
1.795 www 9116: ul#LC_toolbar {
1.911 bisitz 9117: padding: 0;
9118: margin: 2px;
9119: list-style:none;
9120: position:relative;
9121: background-color:white;
1.1082 raeburn 9122: overflow: auto;
1.757 schulted 9123: }
9124:
1.795 www 9125: ul#LC_toolbar li {
1.911 bisitz 9126: border:1px solid white;
9127: padding: 0;
9128: margin: 0;
9129: float: left;
9130: display:inline;
9131: vertical-align:middle;
1.1082 raeburn 9132: white-space: nowrap;
1.911 bisitz 9133: }
1.757 schulted 9134:
1.783 amueller 9135:
1.795 www 9136: a.LC_toolbarItem {
1.911 bisitz 9137: display:block;
9138: padding: 0;
9139: margin: 0;
9140: height: 32px;
9141: width: 32px;
9142: color:white;
9143: border: none;
9144: background-repeat:no-repeat;
9145: background-color:transparent;
1.757 schulted 9146: }
9147:
1.915 droeschl 9148: ul.LC_funclist {
9149: margin: 0;
9150: padding: 0.5em 1em 0.5em 0;
9151: }
9152:
1.933 droeschl 9153: ul.LC_funclist > li:first-child {
9154: font-weight:bold;
9155: margin-left:0.8em;
9156: }
9157:
1.915 droeschl 9158: ul.LC_funclist + ul.LC_funclist {
9159: /*
9160: left border as a seperator if we have more than
9161: one list
9162: */
9163: border-left: 1px solid $sidebg;
9164: /*
9165: this hides the left border behind the border of the
9166: outer box if element is wrapped to the next 'line'
9167: */
9168: margin-left: -1px;
9169: }
9170:
1.843 bisitz 9171: ul.LC_funclist li {
1.915 droeschl 9172: display: inline;
1.782 bisitz 9173: white-space: nowrap;
1.915 droeschl 9174: margin: 0 0 0 25px;
9175: line-height: 150%;
1.782 bisitz 9176: }
9177:
1.974 wenzelju 9178: .LC_hidden {
9179: display: none;
9180: }
9181:
1.1030 www 9182: .LCmodal-overlay {
9183: position:fixed;
9184: top:0;
9185: right:0;
9186: bottom:0;
9187: left:0;
9188: height:100%;
9189: width:100%;
9190: margin:0;
9191: padding:0;
9192: background:#999;
9193: opacity:.75;
9194: filter: alpha(opacity=75);
9195: -moz-opacity: 0.75;
9196: z-index:101;
9197: }
9198:
9199: * html .LCmodal-overlay {
9200: position: absolute;
9201: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9202: }
9203:
9204: .LCmodal-window {
9205: position:fixed;
9206: top:50%;
9207: left:50%;
9208: margin:0;
9209: padding:0;
9210: z-index:102;
9211: }
9212:
9213: * html .LCmodal-window {
9214: position:absolute;
9215: }
9216:
9217: .LCclose-window {
9218: position:absolute;
9219: width:32px;
9220: height:32px;
9221: right:8px;
9222: top:8px;
9223: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9224: text-indent:-99999px;
9225: overflow:hidden;
9226: cursor:pointer;
9227: }
9228:
1.1369 raeburn 9229: .LCisDisabled {
9230: cursor: not-allowed;
9231: opacity: 0.5;
9232: }
9233:
9234: a[aria-disabled="true"] {
9235: color: currentColor;
9236: display: inline-block; /* For IE11/ MS Edge bug */
9237: pointer-events: none;
9238: text-decoration: none;
9239: }
9240:
1.1335 raeburn 9241: pre.LC_wordwrap {
9242: white-space: pre-wrap;
9243: white-space: -moz-pre-wrap;
9244: white-space: -pre-wrap;
9245: white-space: -o-pre-wrap;
9246: word-wrap: break-word;
9247: }
9248:
1.1100 raeburn 9249: /*
1.1231 damieng 9250: styles used for response display
9251: */
9252: div.LC_radiofoil, div.LC_rankfoil {
9253: margin: .5em 0em .5em 0em;
9254: }
9255: table.LC_itemgroup {
9256: margin-top: 1em;
9257: }
9258:
9259: /*
1.1100 raeburn 9260: styles used by TTH when "Default set of options to pass to tth/m
9261: when converting TeX" in course settings has been set
9262:
9263: option passed: -t
9264:
9265: */
9266:
9267: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9268: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9269: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9270: td div.norm {line-height:normal;}
9271:
9272: /*
9273: option passed -y3
9274: */
9275:
9276: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9277: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9278: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9279:
1.1230 damieng 9280: /*
9281: sections with roles, for content only
9282: */
9283: section[class^="role-"] {
9284: padding-left: 10px;
9285: padding-right: 5px;
9286: margin-top: 8px;
9287: margin-bottom: 8px;
9288: border: 1px solid #2A4;
9289: border-radius: 5px;
9290: box-shadow: 0px 1px 1px #BBB;
9291: }
9292: section[class^="role-"]>h1 {
9293: position: relative;
9294: margin: 0px;
9295: padding-top: 10px;
9296: padding-left: 40px;
9297: }
9298: section[class^="role-"]>h1:before {
9299: position: absolute;
9300: left: -5px;
9301: top: 5px;
9302: }
9303: section.role-activity>h1:before {
9304: content:url('/adm/daxe/images/section_icons/activity.png');
9305: }
9306: section.role-advice>h1:before {
9307: content:url('/adm/daxe/images/section_icons/advice.png');
9308: }
9309: section.role-bibliography>h1:before {
9310: content:url('/adm/daxe/images/section_icons/bibliography.png');
9311: }
9312: section.role-citation>h1:before {
9313: content:url('/adm/daxe/images/section_icons/citation.png');
9314: }
9315: section.role-conclusion>h1:before {
9316: content:url('/adm/daxe/images/section_icons/conclusion.png');
9317: }
9318: section.role-definition>h1:before {
9319: content:url('/adm/daxe/images/section_icons/definition.png');
9320: }
9321: section.role-demonstration>h1:before {
9322: content:url('/adm/daxe/images/section_icons/demonstration.png');
9323: }
9324: section.role-example>h1:before {
9325: content:url('/adm/daxe/images/section_icons/example.png');
9326: }
9327: section.role-explanation>h1:before {
9328: content:url('/adm/daxe/images/section_icons/explanation.png');
9329: }
9330: section.role-introduction>h1:before {
9331: content:url('/adm/daxe/images/section_icons/introduction.png');
9332: }
9333: section.role-method>h1:before {
9334: content:url('/adm/daxe/images/section_icons/method.png');
9335: }
9336: section.role-more_information>h1:before {
9337: content:url('/adm/daxe/images/section_icons/more_information.png');
9338: }
9339: section.role-objectives>h1:before {
9340: content:url('/adm/daxe/images/section_icons/objectives.png');
9341: }
9342: section.role-prerequisites>h1:before {
9343: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9344: }
9345: section.role-remark>h1:before {
9346: content:url('/adm/daxe/images/section_icons/remark.png');
9347: }
9348: section.role-reminder>h1:before {
9349: content:url('/adm/daxe/images/section_icons/reminder.png');
9350: }
9351: section.role-summary>h1:before {
9352: content:url('/adm/daxe/images/section_icons/summary.png');
9353: }
9354: section.role-syntax>h1:before {
9355: content:url('/adm/daxe/images/section_icons/syntax.png');
9356: }
9357: section.role-warning>h1:before {
9358: content:url('/adm/daxe/images/section_icons/warning.png');
9359: }
9360:
1.1269 raeburn 9361: #LC_minitab_header {
9362: float:left;
9363: width:100%;
9364: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9365: font-size:93%;
9366: line-height:normal;
9367: margin: 0.5em 0 0.5em 0;
9368: }
9369: #LC_minitab_header ul {
9370: margin:0;
9371: padding:10px 10px 0;
9372: list-style:none;
9373: }
9374: #LC_minitab_header li {
9375: float:left;
9376: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9377: margin:0;
9378: padding:0 0 0 9px;
9379: }
9380: #LC_minitab_header a {
9381: display:block;
9382: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9383: padding:5px 15px 4px 6px;
9384: }
9385: #LC_minitab_header #LC_current_minitab {
9386: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9387: }
9388: #LC_minitab_header #LC_current_minitab a {
9389: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9390: padding-bottom:5px;
9391: }
9392:
9393:
1.343 albertel 9394: END
9395: }
9396:
1.306 albertel 9397: =pod
9398:
9399: =item * &headtag()
9400:
9401: Returns a uniform footer for LON-CAPA web pages.
9402:
1.307 albertel 9403: Inputs: $title - optional title for the head
9404: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9405: $args - optional arguments
1.319 albertel 9406: force_register - if is true call registerurl so the remote is
9407: informed
1.415 albertel 9408: redirect -> array ref of
9409: 1- seconds before redirect occurs
9410: 2- url to redirect to
9411: 3- whether the side effect should occur
1.315 albertel 9412: (side effect of setting
9413: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9414: redirected to)
9415: 4- whether the redirect target should be
9416: the opener of the current (pop-up)
9417: window (side effect of setting
9418: $env{'internal.head.to_opener'} to
9419: 1, if true.
1.1388 raeburn 9420: 5- whether encrypt check should be skipped
1.352 albertel 9421: domain -> force to color decorate a page for a specific
9422: domain
9423: function -> force usage of a specific rolish color scheme
9424: bgcolor -> override the default page bgcolor
1.460 albertel 9425: no_auto_mt_title
9426: -> prevent &mt()ing the title arg
1.464 albertel 9427:
1.306 albertel 9428: =cut
9429:
9430: sub headtag {
1.313 albertel 9431: my ($title,$head_extra,$args) = @_;
1.306 albertel 9432:
1.363 albertel 9433: my $function = $args->{'function'} || &get_users_function();
9434: my $domain = $args->{'domain'} || &determinedomain();
9435: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9436: my $httphost = $args->{'use_absolute'};
1.418 albertel 9437: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9438: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9439: #time(),
1.418 albertel 9440: $env{'environment.color.timestamp'},
1.363 albertel 9441: $function,$domain,$bgcolor);
9442:
1.369 www 9443: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9444:
1.308 albertel 9445: my $result =
9446: '<head>'.
1.1160 raeburn 9447: &font_settings($args);
1.319 albertel 9448:
1.1188 raeburn 9449: my $inhibitprint;
9450: if ($args->{'print_suppress'}) {
9451: $inhibitprint = &print_suppression();
9452: }
1.1064 raeburn 9453:
1.1439 raeburn 9454: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9455: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9456: }
1.962 droeschl 9457: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9458: $result .= Apache::lonxml::display_title();
1.319 albertel 9459: }
1.436 albertel 9460: if (!$args->{'no_nav_bar'}
9461: && !$args->{'only_body'}
1.1438 raeburn 9462: && !$args->{'frameset'}
9463: && !$args->{'switchserver'}) {
1.1154 raeburn 9464: $result .= &help_menu_js($httphost);
1.1032 www 9465: $result.=&modal_window();
1.1038 www 9466: $result.=&togglebox_script();
1.1034 www 9467: $result.=&wishlist_window();
1.1041 www 9468: $result.=&LCprogressbarUpdate_script();
1.1034 www 9469: } else {
9470: if ($args->{'add_modal'}) {
9471: $result.=&modal_window();
9472: }
9473: if ($args->{'add_wishlist'}) {
9474: $result.=&wishlist_window();
9475: }
1.1038 www 9476: if ($args->{'add_togglebox'}) {
9477: $result.=&togglebox_script();
9478: }
1.1041 www 9479: if ($args->{'add_progressbar'}) {
9480: $result.=&LCprogressbarUpdate_script();
9481: }
1.436 albertel 9482: }
1.314 albertel 9483: if (ref($args->{'redirect'})) {
1.1388 raeburn 9484: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9485: if (!$skip_enc_check) {
9486: $url = &Apache::lonenc::check_encrypt($url);
9487: }
1.414 albertel 9488: if (!$inhibit_continue) {
9489: $env{'internal.head.redirect'} = $url;
9490: }
1.1386 raeburn 9491: $result.=<<"ADDMETA";
1.313 albertel 9492: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9493: ADDMETA
9494: if ($to_opener) {
9495: $env{'internal.head.to_opener'} = 1;
9496: my $dest = &js_escape($url);
9497: my $timeout = int($time * 1000);
9498: $result .=<<"ENDJS";
9499: <script type="text/javascript">
9500: // <![CDATA[
9501: function LC_To_Opener() {
9502: var dest = '$dest';
9503: if (dest != '') {
9504: if (window.opener != null && !window.opener.closed) {
9505: window.opener.location.href=dest;
9506: window.close();
9507: } else {
9508: window.location.href=dest;
9509: }
9510: }
9511: }
9512: \$(document).ready(function () {
9513: setTimeout('LC_To_Opener()',$timeout);
9514: });
9515: // ]]>
9516: </script>
9517: ENDJS
9518: } else {
9519: $result.=<<"ADDMETA";
1.344 albertel 9520: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9521: ADDMETA
1.1386 raeburn 9522: }
1.1210 raeburn 9523: } else {
9524: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9525: my $requrl = $env{'request.uri'};
9526: if ($requrl eq '') {
9527: $requrl = $ENV{'REQUEST_URI'};
9528: $requrl =~ s/\?.+$//;
9529: }
9530: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9531: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9532: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9533: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9534: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9535: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9536: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9537: my ($offload,$offloadoth);
1.1210 raeburn 9538: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9539: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9540: $offload = 1;
1.1353 raeburn 9541: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9542: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9543: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9544: $offloadoth = 1;
9545: $dom_in_use = $env{'user.domain'};
9546: }
9547: }
1.1340 raeburn 9548: }
9549: }
9550: unless ($offload) {
9551: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9552: if ($domdefs{'offloadoth'}{$lonhost}) {
9553: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9554: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9555: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9556: $offload = 1;
1.1352 raeburn 9557: $offloadoth = 1;
1.1340 raeburn 9558: $dom_in_use = $env{'user.domain'};
9559: }
1.1210 raeburn 9560: }
1.1340 raeburn 9561: }
9562: }
9563: }
9564: if ($offload) {
1.1358 raeburn 9565: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9566: if (($newserver eq '') && ($offloadoth)) {
9567: my @domains = &Apache::lonnet::current_machine_domains();
9568: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9569: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9570: }
9571: }
1.1340 raeburn 9572: if (($newserver) && ($newserver ne $lonhost)) {
9573: my $numsec = 5;
9574: my $timeout = $numsec * 1000;
9575: my ($newurl,$locknum,%locks,$msg);
9576: if ($env{'request.role.adv'}) {
9577: ($locknum,%locks) = &Apache::lonnet::get_locks();
9578: }
9579: my $disable_submit = 0;
9580: if ($requrl =~ /$LONCAPA::assess_re/) {
9581: $disable_submit = 1;
9582: }
9583: if ($locknum) {
9584: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9585: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9586: join(", ",sort(values(%locks)))."\n";
9587: if (&show_course()) {
9588: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9589: } else {
9590: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9591: }
1.1340 raeburn 9592: } else {
9593: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9594: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9595: }
9596: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9597: $newurl = '/adm/switchserver?otherserver='.$newserver;
9598: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9599: $newurl .= '&role='.$env{'request.role'};
9600: }
9601: if ($env{'request.symb'}) {
9602: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9603: if ($shownsymb =~ m{^/enc/}) {
9604: my $reqdmajor = 2;
9605: my $reqdminor = 11;
9606: my $reqdsubminor = 3;
9607: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9608: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9609: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9610: if (($major eq '' && $minor eq '') ||
9611: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9612: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9613: ($reqdsubminor > $subminor))))) {
9614: undef($shownsymb);
9615: }
1.1210 raeburn 9616: }
1.1340 raeburn 9617: if ($shownsymb) {
9618: &js_escape(\$shownsymb);
9619: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9620: }
1.1340 raeburn 9621: } else {
9622: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9623: &js_escape(\$shownurl);
9624: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9625: }
1.1340 raeburn 9626: }
9627: &js_escape(\$msg);
9628: $result.=<<OFFLOAD
1.1210 raeburn 9629: <meta http-equiv="pragma" content="no-cache" />
9630: <script type="text/javascript">
1.1215 raeburn 9631: // <![CDATA[
1.1210 raeburn 9632: function LC_Offload_Now() {
9633: var dest = "$newurl";
9634: if (dest != '') {
9635: window.location.href="$newurl";
9636: }
9637: }
1.1214 raeburn 9638: \$(document).ready(function () {
9639: window.alert('$msg');
9640: if ($disable_submit) {
1.1210 raeburn 9641: \$(".LC_hwk_submit").prop("disabled", true);
9642: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9643: }
9644: setTimeout('LC_Offload_Now()', $timeout);
9645: });
1.1215 raeburn 9646: // ]]>
1.1210 raeburn 9647: </script>
9648: OFFLOAD
9649: }
9650: }
9651: }
9652: }
9653: }
1.313 albertel 9654: }
1.306 albertel 9655: if (!defined($title)) {
9656: $title = 'The LearningOnline Network with CAPA';
9657: }
1.460 albertel 9658: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9659: if ($title =~ /^LON-CAPA\s+/) {
9660: $result .= '<title> '.$title.'</title>';
9661: } else {
9662: $result .= '<title> LON-CAPA '.$title.'</title>';
9663: }
9664: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9665: if (!$args->{'frameset'}) {
9666: $result .= ' /';
9667: }
9668: $result .= '>'
1.1064 raeburn 9669: .$inhibitprint
1.414 albertel 9670: .$head_extra;
1.1242 raeburn 9671: my $clientmobile;
9672: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9673: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9674: } else {
9675: $clientmobile = $env{'browser.mobile'};
9676: }
9677: if ($clientmobile) {
1.1137 raeburn 9678: $result .= '
1.1435 raeburn 9679: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9680: <meta name="apple-mobile-web-app-capable" content="yes" />';
9681: }
1.1278 raeburn 9682: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9683: return $result.'</head>';
1.306 albertel 9684: }
9685:
9686: =pod
9687:
1.340 albertel 9688: =item * &font_settings()
9689:
9690: Returns neccessary <meta> to set the proper encoding
9691:
1.1160 raeburn 9692: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9693:
9694: =cut
9695:
9696: sub font_settings {
1.1160 raeburn 9697: my ($args) = @_;
1.340 albertel 9698: my $headerstring='';
1.1160 raeburn 9699: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9700: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9701: $headerstring.=
9702: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9703: if (!$args->{'frameset'}) {
9704: $headerstring.= ' /';
9705: }
9706: $headerstring .= '>'."\n";
1.340 albertel 9707: }
9708: return $headerstring;
9709: }
9710:
1.341 albertel 9711: =pod
9712:
1.1064 raeburn 9713: =item * &print_suppression()
9714:
9715: In course context returns css which causes the body to be blank when media="print",
9716: if printout generation is unavailable for the current resource.
9717:
9718: This could be because:
9719:
9720: (a) printstartdate is in the future
9721:
9722: (b) printenddate is in the past
9723:
9724: (c) there is an active exam block with "printout"
9725: functionality blocked
9726:
9727: Users with pav, pfo or evb privileges are exempt.
9728:
9729: Inputs: none
9730:
9731: =cut
9732:
9733:
9734: sub print_suppression {
9735: my $noprint;
9736: if ($env{'request.course.id'}) {
9737: my $scope = $env{'request.course.id'};
9738: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9739: (&Apache::lonnet::allowed('pfo',$scope))) {
9740: return;
9741: }
9742: if ($env{'request.course.sec'} ne '') {
9743: $scope .= "/$env{'request.course.sec'}";
9744: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9745: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9746: return;
1.1064 raeburn 9747: }
9748: }
9749: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9750: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9751: my $clientip = &Apache::lonnet::get_requestor_ip();
9752: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9753: if ($blocked) {
9754: my $checkrole = "cm./$cdom/$cnum";
9755: if ($env{'request.course.sec'} ne '') {
9756: $checkrole .= "/$env{'request.course.sec'}";
9757: }
9758: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9759: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9760: $noprint = 1;
9761: }
9762: }
9763: unless ($noprint) {
9764: my $symb = &Apache::lonnet::symbread();
9765: if ($symb ne '') {
9766: my $navmap = Apache::lonnavmaps::navmap->new();
9767: if (ref($navmap)) {
9768: my $res = $navmap->getBySymb($symb);
9769: if (ref($res)) {
9770: if (!$res->resprintable()) {
9771: $noprint = 1;
9772: }
9773: }
9774: }
9775: }
9776: }
9777: if ($noprint) {
9778: return <<"ENDSTYLE";
9779: <style type="text/css" media="print">
9780: body { display:none }
9781: </style>
9782: ENDSTYLE
9783: }
9784: }
9785: return;
9786: }
9787:
9788: =pod
9789:
1.341 albertel 9790: =item * &xml_begin()
9791:
9792: Returns the needed doctype and <html>
9793:
9794: Inputs: none
9795:
9796: =cut
9797:
9798: sub xml_begin {
1.1168 raeburn 9799: my ($is_frameset) = @_;
1.341 albertel 9800: my $output='';
9801:
9802: if ($env{'browser.mathml'}) {
9803: $output='<?xml version="1.0"?>'
9804: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9805: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9806:
9807: # .'<!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">] >'
9808: .'<!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">'
9809: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9810: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9811: } elsif ($is_frameset) {
9812: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9813: '<html>'."\n";
1.341 albertel 9814: } else {
1.1168 raeburn 9815: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9816: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9817: }
9818: return $output;
9819: }
1.340 albertel 9820:
9821: =pod
9822:
1.306 albertel 9823: =item * &start_page()
9824:
9825: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9826:
1.648 raeburn 9827: Inputs:
9828:
9829: =over 4
9830:
9831: $title - optional title for the page
9832:
9833: $head_extra - optional extra HTML to incude inside the <head>
9834:
9835: $args - additional optional args supported are:
9836:
9837: =over 8
9838:
9839: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9840: arg on
1.814 bisitz 9841: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9842: add_entries -> additional attributes to add to the <body>
9843: domain -> force to color decorate a page for a
1.317 albertel 9844: specific domain
1.648 raeburn 9845: function -> force usage of a specific rolish color
1.317 albertel 9846: scheme
1.648 raeburn 9847: redirect -> see &headtag()
9848: bgcolor -> override the default page bg color
9849: js_ready -> return a string ready for being used in
1.317 albertel 9850: a javascript writeln
1.648 raeburn 9851: html_encode -> return a string ready for being used in
1.320 albertel 9852: a html attribute
1.648 raeburn 9853: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9854: $forcereg arg
1.648 raeburn 9855: frameset -> if true will start with a <frameset>
1.330 albertel 9856: rather than <body>
1.648 raeburn 9857: skip_phases -> hash ref of
1.338 albertel 9858: head -> skip the <html><head> generation
9859: body -> skip all <body> generation
1.648 raeburn 9860: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9861: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9862: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9863: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9864: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9865: to override those values, or add to them, specify the value to
9866: include in the style attribute to include in the div tag by using
9867: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9868: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9869: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9870: group -> includes the current group, if page is for a
1.1274 raeburn 9871: specific group
9872: use_absolute -> for request for external resource or syllabus, this
9873: will contain https://<hostname> if server uses
9874: https (as per hosts.tab), but request is for http
9875: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9876: links_disabled -> Links in primary and secondary menus are disabled
9877: (Can enable them once page has loaded - see lonroles.pm
9878: for an example).
1.1380 raeburn 9879: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9880:
1.648 raeburn 9881: =back
1.460 albertel 9882:
1.648 raeburn 9883: =back
1.562 albertel 9884:
1.306 albertel 9885: =cut
9886:
9887: sub start_page {
1.309 albertel 9888: my ($title,$head_extra,$args) = @_;
1.318 albertel 9889: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9890:
1.315 albertel 9891: $env{'internal.start_page'}++;
1.1359 raeburn 9892: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9893:
1.338 albertel 9894: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9895: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9896: }
1.1316 raeburn 9897:
9898: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9899: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9900: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9901: $args->{'no_primary_menu'} = 1;
9902: }
9903: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9904: $args->{'no_inline_menu'} = 1;
9905: }
9906: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9907: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9908: }
9909: } else {
9910: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9911: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9912: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9913: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9914: $args->{'no_primary_menu'} = 1;
9915: }
9916: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9917: $args->{'no_inline_menu'} = 1;
9918: }
9919: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9920: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9921: }
9922: }
9923: }
1.1316 raeburn 9924: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9925: $env{'course.'.$env{'request.course.id'}.'.domain'},
9926: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9927: } elsif ($env{'request.course.id'}) {
9928: my $expiretime=600;
9929: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9930: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9931: }
9932: my ($deeplinkmenu,$menuref);
9933: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9934: if ($menucoll) {
9935: if (ref($menuref) eq 'HASH') {
9936: %menu = %{$menuref};
9937: }
9938: if ($menu{'top'} eq 'n') {
9939: $args->{'no_primary_menu'} = 1;
9940: }
9941: if ($menu{'inline'} eq 'n') {
9942: unless (&Apache::lonnet::allowed('opa')) {
9943: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9944: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9945: my $crstype = &course_type();
9946: my $now = time;
9947: my $ccrole;
9948: if ($crstype eq 'Community') {
9949: $ccrole = 'co';
9950: } else {
9951: $ccrole = 'cc';
9952: }
9953: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9954: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9955: if ((($start) && ($start<0)) ||
9956: (($end) && ($end<$now)) ||
9957: (($start) && ($now<$start))) {
9958: $args->{'no_inline_menu'} = 1;
9959: }
9960: } else {
9961: $args->{'no_inline_menu'} = 1;
9962: }
9963: }
9964: }
9965: }
1.1316 raeburn 9966: }
1.1359 raeburn 9967:
1.1385 raeburn 9968: my $showncrumbs;
1.338 albertel 9969: if (! exists($args->{'skip_phases'}{'body'}) ) {
9970: if ($args->{'frameset'}) {
9971: my $attr_string = &make_attr_string($args->{'force_register'},
9972: $args->{'add_entries'});
9973: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9974: } else {
9975: $result .=
9976: &bodytag($title,
9977: $args->{'function'}, $args->{'add_entries'},
9978: $args->{'only_body'}, $args->{'domain'},
9979: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9980: $args->{'bgcolor'}, $args,
1.1385 raeburn 9981: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9982: \%menu,\$showncrumbs);
1.831 bisitz 9983: }
1.330 albertel 9984: }
1.338 albertel 9985:
1.315 albertel 9986: if ($args->{'js_ready'}) {
1.713 kaisler 9987: $result = &js_ready($result);
1.315 albertel 9988: }
1.320 albertel 9989: if ($args->{'html_encode'}) {
1.713 kaisler 9990: $result = &html_encode($result);
9991: }
9992:
1.813 bisitz 9993: # Preparation for new and consistent functionlist at top of screen
9994: # if ($args->{'functionlist'}) {
9995: # $result .= &build_functionlist();
9996: #}
9997:
1.964 droeschl 9998: # Don't add anything more if only_body wanted or in const space
9999: return $result if $args->{'only_body'}
10000: || $env{'request.state'} eq 'construct';
1.813 bisitz 10001:
10002: #Breadcrumbs
1.758 kaisler 10003: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10004: unless ($showncrumbs) {
1.758 kaisler 10005: &Apache::lonhtmlcommon::clear_breadcrumbs();
10006: #if any br links exists, add them to the breadcrumbs
10007: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10008: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10009: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10010: }
10011: }
1.1096 raeburn 10012: # if @advtools array contains items add then to the breadcrumbs
10013: if (@advtools > 0) {
10014: &Apache::lonmenu::advtools_crumbs(@advtools);
10015: }
1.1272 raeburn 10016: my $menulink;
10017: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10018: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10019: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10020: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10021: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10022: (!$env{'request.role.adv'}))) {
10023: $menulink = 0;
10024: } else {
10025: undef($menulink);
10026: }
1.1385 raeburn 10027: my $linkprotout;
10028: if ($env{'request.deeplink.login'}) {
10029: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10030: if ($linkprotout) {
10031: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10032: }
10033: }
1.758 kaisler 10034: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10035: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10036: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10037: '',$menulink,'',
10038: $args->{'bread_crumbs_style'});
1.1237 raeburn 10039: } else {
1.1437 raeburn 10040: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10041: $args->{'bread_crumbs_style'});
1.758 kaisler 10042: }
1.1385 raeburn 10043: }
1.320 albertel 10044: }
1.315 albertel 10045: return $result;
1.306 albertel 10046: }
10047:
10048: sub end_page {
1.315 albertel 10049: my ($args) = @_;
10050: $env{'internal.end_page'}++;
1.330 albertel 10051: my $result;
1.335 albertel 10052: if ($args->{'discussion'}) {
10053: my ($target,$parser);
10054: if (ref($args->{'discussion'})) {
10055: ($target,$parser) =($args->{'discussion'}{'target'},
10056: $args->{'discussion'}{'parser'});
10057: }
10058: $result .= &Apache::lonxml::xmlend($target,$parser);
10059: }
1.330 albertel 10060: if ($args->{'frameset'}) {
10061: $result .= '</frameset>';
10062: } else {
1.635 raeburn 10063: $result .= &endbodytag($args);
1.330 albertel 10064: }
1.1080 raeburn 10065: unless ($args->{'notbody'}) {
10066: $result .= "\n</html>";
10067: }
1.330 albertel 10068:
1.315 albertel 10069: if ($args->{'js_ready'}) {
1.317 albertel 10070: $result = &js_ready($result);
1.315 albertel 10071: }
1.335 albertel 10072:
1.320 albertel 10073: if ($args->{'html_encode'}) {
10074: $result = &html_encode($result);
10075: }
1.335 albertel 10076:
1.315 albertel 10077: return $result;
10078: }
10079:
1.1359 raeburn 10080: sub menucoll_in_effect {
10081: my ($menucoll,$deeplinkmenu,%menu);
10082: if ($env{'request.course.id'}) {
10083: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10084: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10085: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10086: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10087: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10088: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10089: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10090: my $navmap = Apache::lonnavmaps::navmap->new();
10091: if (ref($navmap)) {
10092: $deeplink = $navmap->get_mapparam(undef,
10093: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10094: '0.deeplink');
1.1370 raeburn 10095: } else {
10096: $check_login_symb = 1;
1.1362 raeburn 10097: }
10098: } else {
1.1370 raeburn 10099: my $symb = &Apache::lonnet::symbread();
10100: if ($symb) {
10101: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10102: } else {
10103: $check_login_symb = 1;
10104: }
1.1362 raeburn 10105: }
10106: } else {
1.1370 raeburn 10107: $check_login_symb = 1;
10108: }
10109: if ($check_login_symb) {
1.1362 raeburn 10110: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10111: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10112: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10113: my $navmap = Apache::lonnavmaps::navmap->new();
10114: if (ref($navmap)) {
10115: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10116: }
10117: } else {
10118: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10119: }
10120: }
1.1359 raeburn 10121: if ($deeplink ne '') {
1.1378 raeburn 10122: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10123: if ($display =~ /^\d+$/) {
10124: $deeplinkmenu = 1;
10125: $menucoll = $display;
10126: }
10127: }
10128: }
10129: if ($menucoll) {
10130: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10131: }
10132: }
10133: return ($menucoll,$deeplinkmenu,\%menu);
10134: }
10135:
1.1362 raeburn 10136: sub deeplink_login_symb {
10137: my ($cnum,$cdom) = @_;
10138: my $login_symb;
10139: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10140: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10141: }
10142: return $login_symb;
10143: }
10144:
10145: sub symb_from_tinyurl {
10146: my ($url,$cnum,$cdom) = @_;
10147: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10148: my $key = $1;
10149: my ($tinyurl,$login);
10150: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10151: if (defined($cached)) {
10152: $tinyurl = $result;
10153: } else {
10154: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10155: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10156: if ($currtiny{$key} ne '') {
10157: $tinyurl = $currtiny{$key};
10158: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10159: }
1.1364 raeburn 10160: }
10161: if ($tinyurl ne '') {
10162: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10163: if (wantarray) {
10164: return ($cnumreq,$symb);
10165: } elsif ($cnumreq eq $cnum) {
10166: return $symb;
1.1362 raeburn 10167: }
10168: }
10169: }
1.1364 raeburn 10170: if (wantarray) {
10171: return ();
10172: } else {
10173: return;
10174: }
1.1362 raeburn 10175: }
10176:
1.1405 raeburn 10177: sub usable_exttools {
10178: my %tooltypes;
10179: if ($env{'request.course.id'}) {
10180: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10181: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10182: %tooltypes = (
10183: crs => 1,
10184: dom => 1,
10185: );
10186: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10187: $tooltypes{'crs'} = 1;
10188: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10189: $tooltypes{'dom'} = 1;
10190: }
10191: } else {
10192: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10193: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10194: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10195: if ($crstype eq '') {
10196: $crstype = 'course';
10197: }
10198: if ($crstype eq 'course') {
10199: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10200: $crstype = 'official';
10201: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10202: $crstype = 'textbook';
10203: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10204: $crstype = 'lti';
10205: } else {
10206: $crstype = 'unofficial';
10207: }
10208: }
10209: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10210: if ($domdefaults{$crstype.'domexttool'}) {
10211: $tooltypes{'dom'} = 1;
10212: }
10213: if ($domdefaults{$crstype.'exttool'}) {
10214: $tooltypes{'crs'} = 1;
10215: }
10216: }
10217: }
10218: return %tooltypes;
10219: }
10220:
1.1034 www 10221: sub wishlist_window {
10222: return(<<'ENDWISHLIST');
1.1046 raeburn 10223: <script type="text/javascript">
1.1034 www 10224: // <![CDATA[
10225: // <!-- BEGIN LON-CAPA Internal
10226: function set_wishlistlink(title, path) {
10227: if (!title) {
10228: title = document.title;
10229: title = title.replace(/^LON-CAPA /,'');
10230: }
1.1175 raeburn 10231: title = encodeURIComponent(title);
1.1203 raeburn 10232: title = title.replace("'","\\\'");
1.1034 www 10233: if (!path) {
10234: path = location.pathname;
10235: }
1.1175 raeburn 10236: path = encodeURIComponent(path);
1.1203 raeburn 10237: path = path.replace("'","\\\'");
1.1034 www 10238: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10239: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10240: }
10241: // END LON-CAPA Internal -->
10242: // ]]>
10243: </script>
10244: ENDWISHLIST
10245: }
10246:
1.1030 www 10247: sub modal_window {
10248: return(<<'ENDMODAL');
1.1046 raeburn 10249: <script type="text/javascript">
1.1030 www 10250: // <![CDATA[
10251: // <!-- BEGIN LON-CAPA Internal
10252: var modalWindow = {
10253: parent:"body",
10254: windowId:null,
10255: content:null,
10256: width:null,
10257: height:null,
10258: close:function()
10259: {
10260: $(".LCmodal-window").remove();
10261: $(".LCmodal-overlay").remove();
10262: },
10263: open:function()
10264: {
10265: var modal = "";
10266: modal += "<div class=\"LCmodal-overlay\"></div>";
10267: 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;\">";
10268: modal += this.content;
10269: modal += "</div>";
10270:
10271: $(this.parent).append(modal);
10272:
10273: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10274: $(".LCclose-window").click(function(){modalWindow.close();});
10275: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10276: }
10277: };
1.1140 raeburn 10278: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10279: {
1.1266 raeburn 10280: source = source.replace(/'/g,"'");
1.1030 www 10281: modalWindow.windowId = "myModal";
10282: modalWindow.width = width;
10283: modalWindow.height = height;
1.1196 raeburn 10284: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10285: modalWindow.open();
1.1208 raeburn 10286: };
1.1030 www 10287: // END LON-CAPA Internal -->
10288: // ]]>
10289: </script>
10290: ENDMODAL
10291: }
10292:
10293: sub modal_link {
1.1140 raeburn 10294: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10295: unless ($width) { $width=480; }
10296: unless ($height) { $height=400; }
1.1031 www 10297: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10298: unless ($transparency) { $transparency='true'; }
10299:
1.1074 raeburn 10300: my $target_attr;
10301: if (defined($target)) {
10302: $target_attr = 'target="'.$target.'"';
10303: }
10304: return <<"ENDLINK";
1.1336 raeburn 10305: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10306: ENDLINK
1.1030 www 10307: }
10308:
1.1032 www 10309: sub modal_adhoc_script {
1.1365 raeburn 10310: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10311: my $mathjax;
10312: if ($possmathjax) {
10313: $mathjax = <<'ENDJAX';
10314: if (typeof MathJax == 'object') {
10315: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10316: }
10317: ENDJAX
10318: }
1.1032 www 10319: return (<<ENDADHOC);
1.1046 raeburn 10320: <script type="text/javascript">
1.1032 www 10321: // <![CDATA[
10322: var $funcname = function()
10323: {
10324: modalWindow.windowId = "myModal";
10325: modalWindow.width = $width;
10326: modalWindow.height = $height;
10327: modalWindow.content = '$content';
10328: modalWindow.open();
1.1365 raeburn 10329: $mathjax
1.1032 www 10330: };
10331: // ]]>
10332: </script>
10333: ENDADHOC
10334: }
10335:
1.1041 www 10336: sub modal_adhoc_inner {
1.1365 raeburn 10337: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10338: my $innerwidth=$width-20;
10339: $content=&js_ready(
1.1140 raeburn 10340: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10341: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10342: $content.
1.1041 www 10343: &end_scrollbox().
1.1140 raeburn 10344: &end_page()
1.1041 www 10345: );
1.1365 raeburn 10346: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10347: }
10348:
10349: sub modal_adhoc_window {
1.1365 raeburn 10350: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10351: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10352: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10353: }
10354:
10355: sub modal_adhoc_launch {
10356: my ($funcname,$width,$height,$content)=@_;
10357: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10358: <script type="text/javascript">
10359: // <![CDATA[
10360: $funcname();
10361: // ]]>
10362: </script>
10363: ENDLAUNCH
10364: }
10365:
10366: sub modal_adhoc_close {
10367: return (<<ENDCLOSE);
10368: <script type="text/javascript">
10369: // <![CDATA[
10370: modalWindow.close();
10371: // ]]>
10372: </script>
10373: ENDCLOSE
10374: }
10375:
1.1038 www 10376: sub togglebox_script {
10377: return(<<ENDTOGGLE);
10378: <script type="text/javascript">
10379: // <![CDATA[
10380: function LCtoggleDisplay(id,hidetext,showtext) {
10381: link = document.getElementById(id + "link").childNodes[0];
10382: with (document.getElementById(id).style) {
10383: if (display == "none" ) {
10384: display = "inline";
10385: link.nodeValue = hidetext;
10386: } else {
10387: display = "none";
10388: link.nodeValue = showtext;
10389: }
10390: }
10391: }
10392: // ]]>
10393: </script>
10394: ENDTOGGLE
10395: }
10396:
1.1039 www 10397: sub start_togglebox {
10398: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10399: unless ($heading) { $heading=''; } else { $heading.=' '; }
10400: unless ($showtext) { $showtext=&mt('show'); }
10401: unless ($hidetext) { $hidetext=&mt('hide'); }
10402: unless ($headerbg) { $headerbg='#FFFFFF'; }
10403: return &start_data_table().
10404: &start_data_table_header_row().
10405: '<td bgcolor="'.$headerbg.'">'.$heading.
10406: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10407: $showtext.'\')">'.$showtext.'</a>]</td>'.
10408: &end_data_table_header_row().
10409: '<tr id="'.$id.'" style="display:none""><td>';
10410: }
10411:
10412: sub end_togglebox {
10413: return '</td></tr>'.&end_data_table();
10414: }
10415:
1.1041 www 10416: sub LCprogressbar_script {
1.1302 raeburn 10417: my ($id,$number_to_do)=@_;
10418: if ($number_to_do) {
10419: return(<<ENDPROGRESS);
1.1041 www 10420: <script type="text/javascript">
10421: // <![CDATA[
1.1045 www 10422: \$('#progressbar$id').progressbar({
1.1041 www 10423: value: 0,
10424: change: function(event, ui) {
10425: var newVal = \$(this).progressbar('option', 'value');
10426: \$('.pblabel', this).text(LCprogressTxt);
10427: }
10428: });
10429: // ]]>
10430: </script>
10431: ENDPROGRESS
1.1302 raeburn 10432: } else {
10433: return(<<ENDPROGRESS);
10434: <script type="text/javascript">
10435: // <![CDATA[
10436: \$('#progressbar$id').progressbar({
10437: value: false,
10438: create: function(event, ui) {
10439: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10440: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10441: }
10442: });
10443: // ]]>
10444: </script>
10445: ENDPROGRESS
10446: }
1.1041 www 10447: }
10448:
10449: sub LCprogressbarUpdate_script {
10450: return(<<ENDPROGRESSUPDATE);
10451: <style type="text/css">
10452: .ui-progressbar { position:relative; }
1.1302 raeburn 10453: .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 10454: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10455: </style>
10456: <script type="text/javascript">
10457: // <![CDATA[
1.1045 www 10458: var LCprogressTxt='---';
10459:
1.1302 raeburn 10460: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10461: LCprogressTxt=progresstext;
1.1302 raeburn 10462: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10463: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10464: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10465: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10466: } else {
10467: \$('#progressbar'+id).progressbar('value',percent);
10468: }
1.1041 www 10469: }
10470: // ]]>
10471: </script>
10472: ENDPROGRESSUPDATE
10473: }
10474:
1.1042 www 10475: my $LClastpercent;
1.1045 www 10476: my $LCidcnt;
10477: my $LCcurrentid;
1.1042 www 10478:
1.1041 www 10479: sub LCprogressbar {
1.1302 raeburn 10480: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10481: $LClastpercent=0;
1.1045 www 10482: $LCidcnt++;
10483: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10484: my ($starting,$content);
10485: if ($number_to_do) {
10486: $starting=&mt('Starting');
10487: $content=(<<ENDPROGBAR);
10488: $preamble
1.1045 www 10489: <div id="progressbar$LCcurrentid">
1.1041 www 10490: <span class="pblabel">$starting</span>
10491: </div>
10492: ENDPROGBAR
1.1302 raeburn 10493: } else {
10494: $starting=&mt('Loading...');
10495: $LClastpercent='false';
10496: $content=(<<ENDPROGBAR);
10497: $preamble
10498: <div id="progressbar$LCcurrentid">
10499: <div class="progress-label">$starting</div>
10500: </div>
10501: ENDPROGBAR
10502: }
10503: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10504: }
10505:
10506: sub LCprogressbarUpdate {
1.1302 raeburn 10507: my ($r,$val,$text,$number_to_do)=@_;
10508: if ($number_to_do) {
10509: unless ($val) {
10510: if ($LClastpercent) {
10511: $val=$LClastpercent;
10512: } else {
10513: $val=0;
10514: }
10515: }
10516: if ($val<0) { $val=0; }
10517: if ($val>100) { $val=0; }
10518: $LClastpercent=$val;
10519: unless ($text) { $text=$val.'%'; }
10520: } else {
10521: $val = 'false';
1.1042 www 10522: }
1.1041 www 10523: $text=&js_ready($text);
1.1044 www 10524: &r_print($r,<<ENDUPDATE);
1.1041 www 10525: <script type="text/javascript">
10526: // <![CDATA[
1.1302 raeburn 10527: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10528: // ]]>
10529: </script>
10530: ENDUPDATE
1.1035 www 10531: }
10532:
1.1042 www 10533: sub LCprogressbarClose {
10534: my ($r)=@_;
10535: $LClastpercent=0;
1.1044 www 10536: &r_print($r,<<ENDCLOSE);
1.1042 www 10537: <script type="text/javascript">
10538: // <![CDATA[
1.1045 www 10539: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10540: // ]]>
10541: </script>
10542: ENDCLOSE
1.1044 www 10543: }
10544:
10545: sub r_print {
10546: my ($r,$to_print)=@_;
10547: if ($r) {
10548: $r->print($to_print);
10549: $r->rflush();
10550: } else {
10551: print($to_print);
10552: }
1.1042 www 10553: }
10554:
1.320 albertel 10555: sub html_encode {
10556: my ($result) = @_;
10557:
1.322 albertel 10558: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10559:
10560: return $result;
10561: }
1.1044 www 10562:
1.317 albertel 10563: sub js_ready {
10564: my ($result) = @_;
10565:
1.323 albertel 10566: $result =~ s/[\n\r]/ /xmsg;
10567: $result =~ s/\\/\\\\/xmsg;
10568: $result =~ s/'/\\'/xmsg;
1.372 albertel 10569: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10570:
10571: return $result;
10572: }
10573:
1.315 albertel 10574: sub validate_page {
10575: if ( exists($env{'internal.start_page'})
1.316 albertel 10576: && $env{'internal.start_page'} > 1) {
10577: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10578: $env{'internal.start_page'}.' '.
1.316 albertel 10579: $ENV{'request.filename'});
1.315 albertel 10580: }
10581: if ( exists($env{'internal.end_page'})
1.316 albertel 10582: && $env{'internal.end_page'} > 1) {
10583: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10584: $env{'internal.end_page'}.' '.
1.316 albertel 10585: $env{'request.filename'});
1.315 albertel 10586: }
10587: if ( exists($env{'internal.start_page'})
10588: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10589: &Apache::lonnet::logthis('start_page called without end_page '.
10590: $env{'request.filename'});
1.315 albertel 10591: }
10592: if ( ! exists($env{'internal.start_page'})
10593: && exists($env{'internal.end_page'})) {
1.316 albertel 10594: &Apache::lonnet::logthis('end_page called without start_page'.
10595: $env{'request.filename'});
1.315 albertel 10596: }
1.306 albertel 10597: }
1.315 albertel 10598:
1.996 www 10599:
10600: sub start_scrollbox {
1.1140 raeburn 10601: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10602: unless ($outerwidth) { $outerwidth='520px'; }
10603: unless ($width) { $width='500px'; }
10604: unless ($height) { $height='200px'; }
1.1075 raeburn 10605: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10606: if ($id ne '') {
1.1140 raeburn 10607: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10608: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10609: }
1.1075 raeburn 10610: if ($bgcolor ne '') {
10611: $tdcol = "background-color: $bgcolor;";
10612: }
1.1137 raeburn 10613: my $nicescroll_js;
10614: if ($env{'browser.mobile'}) {
1.1140 raeburn 10615: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10616: }
10617: return <<"END";
10618: $nicescroll_js
10619:
10620: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10621: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10622: END
10623: }
10624:
10625: sub end_scrollbox {
10626: return '</div></td></tr></table>';
10627: }
10628:
10629: sub nicescroll_javascript {
10630: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10631: my %options;
10632: if (ref($cursor) eq 'HASH') {
10633: %options = %{$cursor};
10634: }
10635: unless ($options{'railalign'} =~ /^left|right$/) {
10636: $options{'railalign'} = 'left';
10637: }
10638: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10639: my $function = &get_users_function();
10640: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10641: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10642: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10643: }
1.1140 raeburn 10644: }
10645: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10646: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10647: $options{'cursoropacity'}='1.0';
10648: }
1.1140 raeburn 10649: } else {
10650: $options{'cursoropacity'}='1.0';
10651: }
10652: if ($options{'cursorfixedheight'} eq 'none') {
10653: delete($options{'cursorfixedheight'});
10654: } else {
10655: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10656: }
10657: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10658: delete($options{'railoffset'});
10659: }
10660: my @niceoptions;
10661: while (my($key,$value) = each(%options)) {
10662: if ($value =~ /^\{.+\}$/) {
10663: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10664: } else {
1.1140 raeburn 10665: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10666: }
1.1140 raeburn 10667: }
10668: my $nicescroll_js = '
1.1137 raeburn 10669: $(document).ready(
1.1140 raeburn 10670: function() {
10671: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10672: }
1.1137 raeburn 10673: );
10674: ';
1.1140 raeburn 10675: if ($framecheck) {
10676: $nicescroll_js .= '
10677: function expand_div(caller) {
10678: if (top === self) {
10679: document.getElementById("'.$id.'").style.width = "auto";
10680: document.getElementById("'.$id.'").style.height = "auto";
10681: } else {
10682: try {
10683: if (parent.frames) {
10684: if (parent.frames.length > 1) {
10685: var framesrc = parent.frames[1].location.href;
10686: var currsrc = framesrc.replace(/\#.*$/,"");
10687: if ((caller == "search") || (currsrc == "'.$location.'")) {
10688: document.getElementById("'.$id.'").style.width = "auto";
10689: document.getElementById("'.$id.'").style.height = "auto";
10690: }
10691: }
10692: }
10693: } catch (e) {
10694: return;
10695: }
1.1137 raeburn 10696: }
1.1140 raeburn 10697: return;
1.996 www 10698: }
1.1140 raeburn 10699: ';
10700: }
10701: if ($needjsready) {
10702: $nicescroll_js = '
10703: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10704: } else {
10705: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10706: }
10707: return $nicescroll_js;
1.996 www 10708: }
10709:
1.318 albertel 10710: sub simple_error_page {
1.1150 bisitz 10711: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10712: my %displayargs;
1.1151 raeburn 10713: if (ref($args) eq 'HASH') {
10714: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10715: if ($args->{'only_body'}) {
10716: $displayargs{'only_body'} = 1;
10717: }
10718: if ($args->{'no_nav_bar'}) {
10719: $displayargs{'no_nav_bar'} = 1;
10720: }
1.1151 raeburn 10721: } else {
10722: $msg = &mt($msg);
10723: }
1.1150 bisitz 10724:
1.318 albertel 10725: my $page =
1.1304 raeburn 10726: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10727: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10728: &Apache::loncommon::end_page();
10729: if (ref($r)) {
10730: $r->print($page);
1.327 albertel 10731: return;
1.318 albertel 10732: }
10733: return $page;
10734: }
1.347 albertel 10735:
10736: {
1.610 albertel 10737: my @row_count;
1.961 onken 10738:
10739: sub start_data_table_count {
10740: unshift(@row_count, 0);
10741: return;
10742: }
10743:
10744: sub end_data_table_count {
10745: shift(@row_count);
10746: return;
10747: }
10748:
1.347 albertel 10749: sub start_data_table {
1.1018 raeburn 10750: my ($add_class,$id) = @_;
1.422 albertel 10751: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10752: my $table_id;
10753: if (defined($id)) {
10754: $table_id = ' id="'.$id.'"';
10755: }
1.961 onken 10756: &start_data_table_count();
1.1018 raeburn 10757: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10758: }
10759:
10760: sub end_data_table {
1.961 onken 10761: &end_data_table_count();
1.389 albertel 10762: return '</table>'."\n";;
1.347 albertel 10763: }
10764:
10765: sub start_data_table_row {
1.974 wenzelju 10766: my ($add_class, $id) = @_;
1.610 albertel 10767: $row_count[0]++;
10768: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10769: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10770: $id = (' id="'.$id.'"') unless ($id eq '');
10771: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10772: }
1.471 banghart 10773:
10774: sub continue_data_table_row {
1.974 wenzelju 10775: my ($add_class, $id) = @_;
1.610 albertel 10776: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10777: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10778: $id = (' id="'.$id.'"') unless ($id eq '');
10779: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10780: }
1.347 albertel 10781:
10782: sub end_data_table_row {
1.389 albertel 10783: return '</tr>'."\n";;
1.347 albertel 10784: }
1.367 www 10785:
1.421 albertel 10786: sub start_data_table_empty_row {
1.707 bisitz 10787: # $row_count[0]++;
1.421 albertel 10788: return '<tr class="LC_empty_row" >'."\n";;
10789: }
10790:
10791: sub end_data_table_empty_row {
10792: return '</tr>'."\n";;
10793: }
10794:
1.367 www 10795: sub start_data_table_header_row {
1.389 albertel 10796: return '<tr class="LC_header_row">'."\n";;
1.367 www 10797: }
10798:
10799: sub end_data_table_header_row {
1.389 albertel 10800: return '</tr>'."\n";;
1.367 www 10801: }
1.890 droeschl 10802:
10803: sub data_table_caption {
10804: my $caption = shift;
10805: return "<caption class=\"LC_caption\">$caption</caption>";
10806: }
1.347 albertel 10807: }
10808:
1.548 albertel 10809: =pod
10810:
10811: =item * &inhibit_menu_check($arg)
10812:
10813: Checks for a inhibitmenu state and generates output to preserve it
10814:
10815: Inputs: $arg - can be any of
10816: - undef - in which case the return value is a string
10817: to add into arguments list of a uri
10818: - 'input' - in which case the return value is a HTML
10819: <form> <input> field of type hidden to
10820: preserve the value
10821: - a url - in which case the return value is the url with
10822: the neccesary cgi args added to preserve the
10823: inhibitmenu state
10824: - a ref to a url - no return value, but the string is
10825: updated to include the neccessary cgi
10826: args to preserve the inhibitmenu state
10827:
10828: =cut
10829:
10830: sub inhibit_menu_check {
10831: my ($arg) = @_;
10832: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10833: if ($arg eq 'input') {
10834: if ($env{'form.inhibitmenu'}) {
10835: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10836: } else {
10837: return
10838: }
10839: }
10840: if ($env{'form.inhibitmenu'}) {
10841: if (ref($arg)) {
10842: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10843: } elsif ($arg eq '') {
10844: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10845: } else {
10846: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10847: }
10848: }
10849: if (!ref($arg)) {
10850: return $arg;
10851: }
10852: }
10853:
1.251 albertel 10854: ###############################################
1.182 matthew 10855:
10856: =pod
10857:
1.549 albertel 10858: =back
10859:
10860: =head1 User Information Routines
10861:
10862: =over 4
10863:
1.405 albertel 10864: =item * &get_users_function()
1.182 matthew 10865:
10866: Used by &bodytag to determine the current users primary role.
10867: Returns either 'student','coordinator','admin', or 'author'.
10868:
10869: =cut
10870:
10871: ###############################################
10872: sub get_users_function {
1.815 tempelho 10873: my $function = 'norole';
1.818 tempelho 10874: if ($env{'request.role'}=~/^(st)/) {
10875: $function='student';
10876: }
1.907 raeburn 10877: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10878: $function='coordinator';
10879: }
1.258 albertel 10880: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10881: $function='admin';
10882: }
1.826 bisitz 10883: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10884: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10885: $function='author';
10886: }
10887: return $function;
1.54 www 10888: }
1.99 www 10889:
10890: ###############################################
10891:
1.233 raeburn 10892: =pod
10893:
1.821 raeburn 10894: =item * &show_course()
10895:
10896: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10897: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10898:
10899: Inputs:
10900: None
10901:
10902: Outputs:
10903: Scalar: 1 if 'Course' to be used, 0 otherwise.
10904:
10905: =cut
10906:
10907: ###############################################
10908: sub show_course {
1.1408 raeburn 10909: my ($udom,$uname) = @_;
10910: if (($udom ne '') && ($uname ne '')) {
10911: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10912: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10913: return 0;
10914: } else {
10915: return 1;
10916: }
10917: }
10918: }
1.821 raeburn 10919: my $course = !$env{'user.adv'};
10920: if (!$env{'user.adv'}) {
10921: foreach my $env (keys(%env)) {
10922: next if ($env !~ m/^user\.priv\./);
10923: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10924: $course = 0;
10925: last;
10926: }
10927: }
10928: }
10929: return $course;
10930: }
10931:
10932: ###############################################
10933:
10934: =pod
10935:
1.542 raeburn 10936: =item * &check_user_status()
1.274 raeburn 10937:
10938: Determines current status of supplied role for a
10939: specific user. Roles can be active, previous or future.
10940:
10941: Inputs:
10942: user's domain, user's username, course's domain,
1.375 raeburn 10943: course's number, optional section ID.
1.274 raeburn 10944:
10945: Outputs:
10946: role status: active, previous or future.
10947:
10948: =cut
10949:
10950: sub check_user_status {
1.412 raeburn 10951: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10952: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10953: my @uroles = keys(%userinfo);
1.274 raeburn 10954: my $srchstr;
10955: my $active_chk = 'none';
1.412 raeburn 10956: my $now = time;
1.274 raeburn 10957: if (@uroles > 0) {
1.908 raeburn 10958: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10959: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10960: } else {
1.412 raeburn 10961: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10962: }
10963: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10964: my $role_end = 0;
10965: my $role_start = 0;
10966: $active_chk = 'active';
1.412 raeburn 10967: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10968: $role_end = $1;
10969: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10970: $role_start = $1;
1.274 raeburn 10971: }
10972: }
10973: if ($role_start > 0) {
1.412 raeburn 10974: if ($now < $role_start) {
1.274 raeburn 10975: $active_chk = 'future';
10976: }
10977: }
10978: if ($role_end > 0) {
1.412 raeburn 10979: if ($now > $role_end) {
1.274 raeburn 10980: $active_chk = 'previous';
10981: }
10982: }
10983: }
10984: }
10985: return $active_chk;
10986: }
10987:
10988: ###############################################
10989:
10990: =pod
10991:
1.405 albertel 10992: =item * &get_sections()
1.233 raeburn 10993:
10994: Determines all the sections for a course including
10995: sections with students and sections containing other roles.
1.419 raeburn 10996: Incoming parameters:
10997:
10998: 1. domain
10999: 2. course number
11000: 3. reference to array containing roles for which sections should
11001: be gathered (optional).
11002: 4. reference to array containing status types for which sections
11003: should be gathered (optional).
11004:
11005: If the third argument is undefined, sections are gathered for any role.
11006: If the fourth argument is undefined, sections are gathered for any status.
11007: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11008:
1.374 raeburn 11009: Returns section hash (keys are section IDs, values are
11010: number of users in each section), subject to the
1.419 raeburn 11011: optional roles filter, optional status filter
1.233 raeburn 11012:
11013: =cut
11014:
11015: ###############################################
11016: sub get_sections {
1.419 raeburn 11017: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11018: if (!defined($cdom) || !defined($cnum)) {
11019: my $cid = $env{'request.course.id'};
11020:
11021: return if (!defined($cid));
11022:
11023: $cdom = $env{'course.'.$cid.'.domain'};
11024: $cnum = $env{'course.'.$cid.'.num'};
11025: }
11026:
11027: my %sectioncount;
1.419 raeburn 11028: my $now = time;
1.240 albertel 11029:
1.1118 raeburn 11030: my $check_students = 1;
11031: my $only_students = 0;
11032: if (ref($possible_roles) eq 'ARRAY') {
11033: if (grep(/^st$/,@{$possible_roles})) {
11034: if (@{$possible_roles} == 1) {
11035: $only_students = 1;
11036: }
11037: } else {
11038: $check_students = 0;
11039: }
11040: }
11041:
11042: if ($check_students) {
1.276 albertel 11043: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11044: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11045: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11046: my $start_index = &Apache::loncoursedata::CL_START();
11047: my $end_index = &Apache::loncoursedata::CL_END();
11048: my $status;
1.366 albertel 11049: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11050: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11051: $data->[$status_index],
11052: $data->[$start_index],
11053: $data->[$end_index]);
11054: if ($stu_status eq 'Active') {
11055: $status = 'active';
11056: } elsif ($end < $now) {
11057: $status = 'previous';
11058: } elsif ($start > $now) {
11059: $status = 'future';
11060: }
11061: if ($section ne '-1' && $section !~ /^\s*$/) {
11062: if ((!defined($possible_status)) || (($status ne '') &&
11063: (grep/^\Q$status\E$/,@{$possible_status}))) {
11064: $sectioncount{$section}++;
11065: }
1.240 albertel 11066: }
11067: }
11068: }
1.1118 raeburn 11069: if ($only_students) {
11070: return %sectioncount;
11071: }
1.240 albertel 11072: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11073: foreach my $user (sort(keys(%courseroles))) {
11074: if ($user !~ /^(\w{2})/) { next; }
11075: my ($role) = ($user =~ /^(\w{2})/);
11076: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11077: my ($section,$status);
1.240 albertel 11078: if ($role eq 'cr' &&
11079: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11080: $section=$1;
11081: }
11082: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11083: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11084: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11085: if ($end == -1 && $start == -1) {
11086: next; #deleted role
11087: }
11088: if (!defined($possible_status)) {
11089: $sectioncount{$section}++;
11090: } else {
11091: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11092: $status = 'active';
11093: } elsif ($end < $now) {
11094: $status = 'future';
11095: } elsif ($start > $now) {
11096: $status = 'previous';
11097: }
11098: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11099: $sectioncount{$section}++;
11100: }
11101: }
1.233 raeburn 11102: }
1.366 albertel 11103: return %sectioncount;
1.233 raeburn 11104: }
11105:
1.274 raeburn 11106: ###############################################
1.294 raeburn 11107:
11108: =pod
1.405 albertel 11109:
11110: =item * &get_course_users()
11111:
1.275 raeburn 11112: Retrieves usernames:domains for users in the specified course
11113: with specific role(s), and access status.
11114:
11115: Incoming parameters:
1.277 albertel 11116: 1. course domain
11117: 2. course number
11118: 3. access status: users must have - either active,
1.275 raeburn 11119: previous, future, or all.
1.277 albertel 11120: 4. reference to array of permissible roles
1.288 raeburn 11121: 5. reference to array of section restrictions (optional)
11122: 6. reference to results object (hash of hashes).
11123: 7. reference to optional userdata hash
1.609 raeburn 11124: 8. reference to optional statushash
1.630 raeburn 11125: 9. flag if privileged users (except those set to unhide in
11126: course settings) should be excluded
1.609 raeburn 11127: Keys of top level results hash are roles.
1.275 raeburn 11128: Keys of inner hashes are username:domain, with
11129: values set to access type.
1.288 raeburn 11130: Optional userdata hash returns an array with arguments in the
11131: same order as loncoursedata::get_classlist() for student data.
11132:
1.609 raeburn 11133: Optional statushash returns
11134:
1.288 raeburn 11135: Entries for end, start, section and status are blank because
11136: of the possibility of multiple values for non-student roles.
11137:
1.275 raeburn 11138: =cut
1.405 albertel 11139:
1.275 raeburn 11140: ###############################################
1.405 albertel 11141:
1.275 raeburn 11142: sub get_course_users {
1.630 raeburn 11143: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11144: my %idx = ();
1.419 raeburn 11145: my %seclists;
1.288 raeburn 11146:
11147: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11148: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11149: $idx{end} = &Apache::loncoursedata::CL_END();
11150: $idx{start} = &Apache::loncoursedata::CL_START();
11151: $idx{id} = &Apache::loncoursedata::CL_ID();
11152: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11153: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11154: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11155:
1.290 albertel 11156: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11157: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11158: my $now = time;
1.277 albertel 11159: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11160: my $match = 0;
1.412 raeburn 11161: my $secmatch = 0;
1.419 raeburn 11162: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11163: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11164: if ($section eq '') {
11165: $section = 'none';
11166: }
1.291 albertel 11167: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11168: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11169: $secmatch = 1;
11170: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11171: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11172: $secmatch = 1;
11173: }
11174: } else {
1.419 raeburn 11175: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11176: $secmatch = 1;
11177: }
1.290 albertel 11178: }
1.412 raeburn 11179: if (!$secmatch) {
11180: next;
11181: }
1.419 raeburn 11182: }
1.275 raeburn 11183: if (defined($$types{'active'})) {
1.288 raeburn 11184: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11185: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11186: $match = 1;
1.275 raeburn 11187: }
11188: }
11189: if (defined($$types{'previous'})) {
1.609 raeburn 11190: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11191: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11192: $match = 1;
1.275 raeburn 11193: }
11194: }
11195: if (defined($$types{'future'})) {
1.609 raeburn 11196: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11197: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11198: $match = 1;
1.275 raeburn 11199: }
11200: }
1.609 raeburn 11201: if ($match) {
11202: push(@{$seclists{$student}},$section);
11203: if (ref($userdata) eq 'HASH') {
11204: $$userdata{$student} = $$classlist{$student};
11205: }
11206: if (ref($statushash) eq 'HASH') {
11207: $statushash->{$student}{'st'}{$section} = $status;
11208: }
1.288 raeburn 11209: }
1.275 raeburn 11210: }
11211: }
1.412 raeburn 11212: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11213: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11214: my $now = time;
1.609 raeburn 11215: my %displaystatus = ( previous => 'Expired',
11216: active => 'Active',
11217: future => 'Future',
11218: );
1.1121 raeburn 11219: my (%nothide,@possdoms);
1.630 raeburn 11220: if ($hidepriv) {
11221: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11222: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11223: if ($user !~ /:/) {
11224: $nothide{join(':',split(/[\@]/,$user))}=1;
11225: } else {
11226: $nothide{$user} = 1;
11227: }
11228: }
1.1121 raeburn 11229: my @possdoms = ($cdom);
11230: if ($coursehash{'checkforpriv'}) {
11231: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11232: }
1.630 raeburn 11233: }
1.439 raeburn 11234: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11235: my $match = 0;
1.412 raeburn 11236: my $secmatch = 0;
1.439 raeburn 11237: my $status;
1.412 raeburn 11238: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11239: $user =~ s/:$//;
1.439 raeburn 11240: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11241: if ($end == -1 || $start == -1) {
11242: next;
11243: }
11244: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11245: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11246: my ($uname,$udom) = split(/:/,$user);
11247: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11248: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11249: $secmatch = 1;
11250: } elsif ($usec eq '') {
1.420 albertel 11251: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11252: $secmatch = 1;
11253: }
11254: } else {
11255: if (grep(/^\Q$usec\E$/,@{$sections})) {
11256: $secmatch = 1;
11257: }
11258: }
11259: if (!$secmatch) {
11260: next;
11261: }
1.288 raeburn 11262: }
1.419 raeburn 11263: if ($usec eq '') {
11264: $usec = 'none';
11265: }
1.275 raeburn 11266: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11267: if ($hidepriv) {
1.1121 raeburn 11268: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11269: (!$nothide{$uname.':'.$udom})) {
11270: next;
11271: }
11272: }
1.503 raeburn 11273: if ($end > 0 && $end < $now) {
1.439 raeburn 11274: $status = 'previous';
11275: } elsif ($start > $now) {
11276: $status = 'future';
11277: } else {
11278: $status = 'active';
11279: }
1.277 albertel 11280: foreach my $type (keys(%{$types})) {
1.275 raeburn 11281: if ($status eq $type) {
1.420 albertel 11282: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11283: push(@{$$users{$role}{$user}},$type);
11284: }
1.288 raeburn 11285: $match = 1;
11286: }
11287: }
1.419 raeburn 11288: if (($match) && (ref($userdata) eq 'HASH')) {
11289: if (!exists($$userdata{$uname.':'.$udom})) {
11290: &get_user_info($udom,$uname,\%idx,$userdata);
11291: }
1.420 albertel 11292: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11293: push(@{$seclists{$uname.':'.$udom}},$usec);
11294: }
1.609 raeburn 11295: if (ref($statushash) eq 'HASH') {
11296: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11297: }
1.275 raeburn 11298: }
11299: }
11300: }
11301: }
1.290 albertel 11302: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11303: if ((defined($cdom)) && (defined($cnum))) {
11304: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11305: if ( defined($csettings{'internal.courseowner'}) ) {
11306: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11307: next if ($owner eq '');
11308: my ($ownername,$ownerdom);
11309: if ($owner =~ /^([^:]+):([^:]+)$/) {
11310: $ownername = $1;
11311: $ownerdom = $2;
11312: } else {
11313: $ownername = $owner;
11314: $ownerdom = $cdom;
11315: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11316: }
11317: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11318: if (defined($userdata) &&
1.609 raeburn 11319: !exists($$userdata{$owner})) {
11320: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11321: if (!grep(/^none$/,@{$seclists{$owner}})) {
11322: push(@{$seclists{$owner}},'none');
11323: }
11324: if (ref($statushash) eq 'HASH') {
11325: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11326: }
1.290 albertel 11327: }
1.279 raeburn 11328: }
11329: }
11330: }
1.419 raeburn 11331: foreach my $user (keys(%seclists)) {
11332: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11333: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11334: }
1.275 raeburn 11335: }
11336: return;
11337: }
11338:
1.288 raeburn 11339: sub get_user_info {
11340: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11341: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11342: &plainname($uname,$udom,'lastname');
1.291 albertel 11343: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11344: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11345: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11346: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11347: return;
11348: }
1.275 raeburn 11349:
1.472 raeburn 11350: ###############################################
11351:
11352: =pod
11353:
11354: =item * &get_user_quota()
11355:
1.1134 raeburn 11356: Retrieves quota assigned for storage of user files.
11357: Default is to report quota for portfolio files.
1.472 raeburn 11358:
11359: Incoming parameters:
11360: 1. user's username
11361: 2. user's domain
1.1134 raeburn 11362: 3. quota name - portfolio, author, or course
1.1136 raeburn 11363: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11364: 4. crstype - official, unofficial, textbook, placement or community,
11365: if quota name is course
1.472 raeburn 11366:
11367: Returns:
1.1163 raeburn 11368: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11369: 2. (Optional) Type of setting: custom or default
11370: (individually assigned or default for user's
11371: institutional status).
11372: 3. (Optional) - User's institutional status (e.g., faculty, staff
11373: or student - types as defined in localenroll::inst_usertypes
11374: for user's domain, which determines default quota for user.
11375: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11376:
11377: If a value has been stored in the user's environment,
1.536 raeburn 11378: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11379: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11380:
11381: =cut
11382:
11383: ###############################################
11384:
11385:
11386: sub get_user_quota {
1.1136 raeburn 11387: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11388: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11389: if (!defined($udom)) {
11390: $udom = $env{'user.domain'};
11391: }
11392: if (!defined($uname)) {
11393: $uname = $env{'user.name'};
11394: }
11395: if (($udom eq '' || $uname eq '') ||
11396: ($udom eq 'public') && ($uname eq 'public')) {
11397: $quota = 0;
1.536 raeburn 11398: $quotatype = 'default';
11399: $defquota = 0;
1.472 raeburn 11400: } else {
1.536 raeburn 11401: my $inststatus;
1.1134 raeburn 11402: if ($quotaname eq 'course') {
11403: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11404: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11405: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11406: } else {
11407: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11408: $quota = $cenv{'internal.uploadquota'};
11409: }
1.536 raeburn 11410: } else {
1.1134 raeburn 11411: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11412: if ($quotaname eq 'author') {
11413: $quota = $env{'environment.authorquota'};
11414: } else {
11415: $quota = $env{'environment.portfolioquota'};
11416: }
11417: $inststatus = $env{'environment.inststatus'};
11418: } else {
11419: my %userenv =
11420: &Apache::lonnet::get('environment',['portfolioquota',
11421: 'authorquota','inststatus'],$udom,$uname);
11422: my ($tmp) = keys(%userenv);
11423: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11424: if ($quotaname eq 'author') {
11425: $quota = $userenv{'authorquota'};
11426: } else {
11427: $quota = $userenv{'portfolioquota'};
11428: }
11429: $inststatus = $userenv{'inststatus'};
11430: } else {
11431: undef(%userenv);
11432: }
11433: }
11434: }
11435: if ($quota eq '' || wantarray) {
11436: if ($quotaname eq 'course') {
11437: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11438: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11439: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11440: ($crstype eq 'placement')) {
1.1136 raeburn 11441: $defquota = $domdefs{$crstype.'quota'};
11442: }
11443: if ($defquota eq '') {
11444: $defquota = 500;
11445: }
1.1134 raeburn 11446: } else {
11447: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11448: }
11449: if ($quota eq '') {
11450: $quota = $defquota;
11451: $quotatype = 'default';
11452: } else {
11453: $quotatype = 'custom';
11454: }
1.472 raeburn 11455: }
11456: }
1.536 raeburn 11457: if (wantarray) {
11458: return ($quota,$quotatype,$settingstatus,$defquota);
11459: } else {
11460: return $quota;
11461: }
1.472 raeburn 11462: }
11463:
11464: ###############################################
11465:
11466: =pod
11467:
11468: =item * &default_quota()
11469:
1.536 raeburn 11470: Retrieves default quota assigned for storage of user portfolio files,
11471: given an (optional) user's institutional status.
1.472 raeburn 11472:
11473: Incoming parameters:
1.1142 raeburn 11474:
1.472 raeburn 11475: 1. domain
1.536 raeburn 11476: 2. (Optional) institutional status(es). This is a : separated list of
11477: status types (e.g., faculty, staff, student etc.)
11478: which apply to the user for whom the default is being retrieved.
11479: If the institutional status string in undefined, the domain
1.1134 raeburn 11480: default quota will be returned.
11481: 3. quota name - portfolio, author, or course
11482: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11483:
11484: Returns:
1.1142 raeburn 11485:
1.1163 raeburn 11486: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11487: 2. (Optional) institutional type which determined the value of the
11488: default quota.
1.472 raeburn 11489:
11490: If a value has been stored in the domain's configuration db,
11491: it will return that, otherwise it returns 20 (for backwards
11492: compatibility with domains which have not set up a configuration
1.1163 raeburn 11493: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11494:
1.536 raeburn 11495: If the user's status includes multiple types (e.g., staff and student),
11496: the largest default quota which applies to the user determines the
11497: default quota returned.
11498:
1.472 raeburn 11499: =cut
11500:
11501: ###############################################
11502:
11503:
11504: sub default_quota {
1.1134 raeburn 11505: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11506: my ($defquota,$settingstatus);
11507: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11508: ['quotas'],$udom);
1.1134 raeburn 11509: my $key = 'defaultquota';
11510: if ($quotaname eq 'author') {
11511: $key = 'authorquota';
11512: }
1.622 raeburn 11513: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11514: if ($inststatus ne '') {
1.765 raeburn 11515: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11516: foreach my $item (@statuses) {
1.1134 raeburn 11517: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11518: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11519: if ($defquota eq '') {
1.1134 raeburn 11520: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11521: $settingstatus = $item;
1.1134 raeburn 11522: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11523: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11524: $settingstatus = $item;
11525: }
11526: }
1.1134 raeburn 11527: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11528: if ($quotahash{'quotas'}{$item} ne '') {
11529: if ($defquota eq '') {
11530: $defquota = $quotahash{'quotas'}{$item};
11531: $settingstatus = $item;
11532: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11533: $defquota = $quotahash{'quotas'}{$item};
11534: $settingstatus = $item;
11535: }
1.536 raeburn 11536: }
11537: }
11538: }
11539: }
11540: if ($defquota eq '') {
1.1134 raeburn 11541: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11542: $defquota = $quotahash{'quotas'}{$key}{'default'};
11543: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11544: $defquota = $quotahash{'quotas'}{'default'};
11545: }
1.536 raeburn 11546: $settingstatus = 'default';
1.1139 raeburn 11547: if ($defquota eq '') {
11548: if ($quotaname eq 'author') {
11549: $defquota = 500;
11550: }
11551: }
1.536 raeburn 11552: }
11553: } else {
11554: $settingstatus = 'default';
1.1134 raeburn 11555: if ($quotaname eq 'author') {
11556: $defquota = 500;
11557: } else {
11558: $defquota = 20;
11559: }
1.536 raeburn 11560: }
11561: if (wantarray) {
11562: return ($defquota,$settingstatus);
1.472 raeburn 11563: } else {
1.536 raeburn 11564: return $defquota;
1.472 raeburn 11565: }
11566: }
11567:
1.1135 raeburn 11568: ###############################################
11569:
11570: =pod
11571:
1.1136 raeburn 11572: =item * &excess_filesize_warning()
1.1135 raeburn 11573:
11574: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11575: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11576: space to be exceeded.
1.1136 raeburn 11577:
11578: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11579: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11580:
1.1165 raeburn 11581: Inputs: 7
1.1136 raeburn 11582: 1. username or coursenum
1.1135 raeburn 11583: 2. domain
1.1136 raeburn 11584: 3. context ('author' or 'course')
1.1135 raeburn 11585: 4. filename of file for which action is being requested
11586: 5. filesize (kB) of file
11587: 6. action being taken: copy or upload.
1.1237 raeburn 11588: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11589:
11590: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11591: otherwise return null.
11592:
11593: =back
1.1135 raeburn 11594:
11595: =cut
11596:
1.1136 raeburn 11597: sub excess_filesize_warning {
1.1165 raeburn 11598: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11599: my $current_disk_usage = 0;
1.1165 raeburn 11600: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11601: if ($context eq 'author') {
11602: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11603: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11604: } else {
11605: foreach my $subdir ('docs','supplemental') {
11606: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11607: }
11608: }
1.1135 raeburn 11609: $disk_quota = int($disk_quota * 1000);
11610: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11611: return '<p class="LC_warning">'.
1.1135 raeburn 11612: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11613: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11614: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11615: $disk_quota,$current_disk_usage).
11616: '</p>';
11617: }
11618: return;
11619: }
11620:
11621: ###############################################
11622:
11623:
1.1136 raeburn 11624:
11625:
1.384 raeburn 11626: sub get_secgrprole_info {
11627: my ($cdom,$cnum,$needroles,$type) = @_;
11628: my %sections_count = &get_sections($cdom,$cnum);
11629: my @sections = (sort {$a <=> $b} keys(%sections_count));
11630: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11631: my @groups = sort(keys(%curr_groups));
11632: my $allroles = [];
11633: my $rolehash;
11634: my $accesshash = {
11635: active => 'Currently has access',
11636: future => 'Will have future access',
11637: previous => 'Previously had access',
11638: };
11639: if ($needroles) {
11640: $rolehash = {'all' => 'all'};
1.385 albertel 11641: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11642: if (&Apache::lonnet::error(%user_roles)) {
11643: undef(%user_roles);
11644: }
11645: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11646: my ($role)=split(/\:/,$item,2);
11647: if ($role eq 'cr') { next; }
11648: if ($role =~ /^cr/) {
11649: $$rolehash{$role} = (split('/',$role))[3];
11650: } else {
11651: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11652: }
11653: }
11654: foreach my $key (sort(keys(%{$rolehash}))) {
11655: push(@{$allroles},$key);
11656: }
11657: push (@{$allroles},'st');
11658: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11659: }
11660: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11661: }
11662:
1.555 raeburn 11663: sub user_picker {
1.1279 raeburn 11664: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11665: my $currdom = $dom;
1.1253 raeburn 11666: my @alldoms = &Apache::lonnet::all_domains();
11667: if (@alldoms == 1) {
11668: my %domsrch = &Apache::lonnet::get_dom('configuration',
11669: ['directorysrch'],$alldoms[0]);
11670: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11671: my $showdom = $domdesc;
11672: if ($showdom eq '') {
11673: $showdom = $dom;
11674: }
11675: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11676: if ((!$domsrch{'directorysrch'}{'available'}) &&
11677: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11678: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11679: }
11680: }
11681: }
1.555 raeburn 11682: my %curr_selected = (
11683: srchin => 'dom',
1.580 raeburn 11684: srchby => 'lastname',
1.555 raeburn 11685: );
11686: my $srchterm;
1.625 raeburn 11687: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11688: if ($srch->{'srchby'} ne '') {
11689: $curr_selected{'srchby'} = $srch->{'srchby'};
11690: }
11691: if ($srch->{'srchin'} ne '') {
11692: $curr_selected{'srchin'} = $srch->{'srchin'};
11693: }
11694: if ($srch->{'srchtype'} ne '') {
11695: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11696: }
11697: if ($srch->{'srchdomain'} ne '') {
11698: $currdom = $srch->{'srchdomain'};
11699: }
11700: $srchterm = $srch->{'srchterm'};
11701: }
1.1222 damieng 11702: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11703: 'usr' => 'Search criteria',
1.563 raeburn 11704: 'doma' => 'Domain/institution to search',
1.558 albertel 11705: 'uname' => 'username',
11706: 'lastname' => 'last name',
1.555 raeburn 11707: 'lastfirst' => 'last name, first name',
1.558 albertel 11708: 'crs' => 'in this course',
1.576 raeburn 11709: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11710: 'alc' => 'all LON-CAPA',
1.573 raeburn 11711: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11712: 'exact' => 'is',
11713: 'contains' => 'contains',
1.569 raeburn 11714: 'begins' => 'begins with',
1.1222 damieng 11715: );
11716: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11717: 'youm' => "You must include some text to search for.",
11718: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11719: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11720: 'yomc' => "You must choose a domain when using an institutional directory search.",
11721: 'ymcd' => "You must choose a domain when using a domain search.",
11722: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11723: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11724: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11725: );
1.1222 damieng 11726: &html_escape(\%html_lt);
11727: &js_escape(\%js_lt);
1.1255 raeburn 11728: my $domform;
1.1277 raeburn 11729: my $allow_blank = 1;
1.1255 raeburn 11730: if ($fixeddom) {
1.1277 raeburn 11731: $allow_blank = 0;
11732: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11733: } else {
1.1287 raeburn 11734: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11735: my ($trusted,$untrusted);
1.1287 raeburn 11736: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11737: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11738: } elsif ($context eq 'author') {
1.1288 raeburn 11739: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11740: } elsif ($context eq 'domain') {
1.1288 raeburn 11741: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11742: }
1.1288 raeburn 11743: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11744: }
1.563 raeburn 11745: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11746:
11747: my @srchins = ('crs','dom','alc','instd');
11748:
11749: foreach my $option (@srchins) {
11750: # FIXME 'alc' option unavailable until
11751: # loncreateuser::print_user_query_page()
11752: # has been completed.
11753: next if ($option eq 'alc');
1.880 raeburn 11754: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11755: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11756: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11757: if ($curr_selected{'srchin'} eq $option) {
11758: $srchinsel .= '
1.1222 damieng 11759: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11760: } else {
11761: $srchinsel .= '
1.1222 damieng 11762: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11763: }
1.555 raeburn 11764: }
1.563 raeburn 11765: $srchinsel .= "\n </select>\n";
1.555 raeburn 11766:
11767: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11768: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11769: if ($curr_selected{'srchby'} eq $option) {
11770: $srchbysel .= '
1.1222 damieng 11771: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11772: } else {
11773: $srchbysel .= '
1.1222 damieng 11774: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11775: }
11776: }
11777: $srchbysel .= "\n </select>\n";
11778:
11779: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11780: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11781: if ($curr_selected{'srchtype'} eq $option) {
11782: $srchtypesel .= '
1.1222 damieng 11783: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11784: } else {
11785: $srchtypesel .= '
1.1222 damieng 11786: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11787: }
11788: }
11789: $srchtypesel .= "\n </select>\n";
11790:
1.558 albertel 11791: my ($newuserscript,$new_user_create);
1.994 raeburn 11792: my $context_dom = $env{'request.role.domain'};
11793: if ($context eq 'requestcrs') {
11794: if ($env{'form.coursedom'} ne '') {
11795: $context_dom = $env{'form.coursedom'};
11796: }
11797: }
1.556 raeburn 11798: if ($forcenewuser) {
1.576 raeburn 11799: if (ref($srch) eq 'HASH') {
1.994 raeburn 11800: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11801: if ($cancreate) {
11802: $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>';
11803: } else {
1.799 bisitz 11804: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11805: my %usertypetext = (
11806: official => 'institutional',
11807: unofficial => 'non-institutional',
11808: );
1.799 bisitz 11809: $new_user_create = '<p class="LC_warning">'
11810: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11811: .' '
11812: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11813: ,'<a href="'.$helplink.'">','</a>')
11814: .'</p><br />';
1.627 raeburn 11815: }
1.576 raeburn 11816: }
11817: }
11818:
1.556 raeburn 11819: $newuserscript = <<"ENDSCRIPT";
11820:
1.570 raeburn 11821: function setSearch(createnew,callingForm) {
1.556 raeburn 11822: if (createnew == 1) {
1.570 raeburn 11823: for (var i=0; i<callingForm.srchby.length; i++) {
11824: if (callingForm.srchby.options[i].value == 'uname') {
11825: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11826: }
11827: }
1.570 raeburn 11828: for (var i=0; i<callingForm.srchin.length; i++) {
11829: if ( callingForm.srchin.options[i].value == 'dom') {
11830: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11831: }
11832: }
1.570 raeburn 11833: for (var i=0; i<callingForm.srchtype.length; i++) {
11834: if (callingForm.srchtype.options[i].value == 'exact') {
11835: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11836: }
11837: }
1.570 raeburn 11838: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11839: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11840: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11841: }
11842: }
11843: }
11844: }
11845: ENDSCRIPT
1.558 albertel 11846:
1.556 raeburn 11847: }
11848:
1.555 raeburn 11849: my $output = <<"END_BLOCK";
1.556 raeburn 11850: <script type="text/javascript">
1.824 bisitz 11851: // <![CDATA[
1.570 raeburn 11852: function validateEntry(callingForm) {
1.558 albertel 11853:
1.556 raeburn 11854: var checkok = 1;
1.558 albertel 11855: var srchin;
1.570 raeburn 11856: for (var i=0; i<callingForm.srchin.length; i++) {
11857: if ( callingForm.srchin[i].checked ) {
11858: srchin = callingForm.srchin[i].value;
1.558 albertel 11859: }
11860: }
11861:
1.570 raeburn 11862: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11863: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11864: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11865: var srchterm = callingForm.srchterm.value;
11866: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11867: var msg = "";
11868:
11869: if (srchterm == "") {
11870: checkok = 0;
1.1222 damieng 11871: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11872: }
11873:
1.569 raeburn 11874: if (srchtype== 'begins') {
11875: if (srchterm.length < 2) {
11876: checkok = 0;
1.1222 damieng 11877: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11878: }
11879: }
11880:
1.556 raeburn 11881: if (srchtype== 'contains') {
11882: if (srchterm.length < 3) {
11883: checkok = 0;
1.1222 damieng 11884: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11885: }
11886: }
11887: if (srchin == 'instd') {
11888: if (srchdomain == '') {
11889: checkok = 0;
1.1222 damieng 11890: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11891: }
11892: }
11893: if (srchin == 'dom') {
11894: if (srchdomain == '') {
11895: checkok = 0;
1.1222 damieng 11896: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11897: }
11898: }
11899: if (srchby == 'lastfirst') {
11900: if (srchterm.indexOf(",") == -1) {
11901: checkok = 0;
1.1222 damieng 11902: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11903: }
11904: if (srchterm.indexOf(",") == srchterm.length -1) {
11905: checkok = 0;
1.1222 damieng 11906: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11907: }
11908: }
11909: if (checkok == 0) {
1.1222 damieng 11910: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11911: return;
11912: }
11913: if (checkok == 1) {
1.570 raeburn 11914: callingForm.submit();
1.556 raeburn 11915: }
11916: }
11917:
11918: $newuserscript
11919:
1.824 bisitz 11920: // ]]>
1.556 raeburn 11921: </script>
1.558 albertel 11922:
11923: $new_user_create
11924:
1.555 raeburn 11925: END_BLOCK
1.558 albertel 11926:
1.876 raeburn 11927: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11928: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11929: $domform.
11930: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11931: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11932: $srchbysel.
11933: $srchtypesel.
11934: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11935: $srchinsel.
11936: &Apache::lonhtmlcommon::row_closure(1).
11937: &Apache::lonhtmlcommon::end_pick_box().
11938: '<br />';
1.1253 raeburn 11939: return ($output,1);
1.555 raeburn 11940: }
11941:
1.612 raeburn 11942: sub user_rule_check {
1.615 raeburn 11943: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11944: my ($response,%inst_response);
1.612 raeburn 11945: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11946: if (keys(%{$usershash}) > 1) {
11947: my (%by_username,%by_id,%userdoms);
11948: my $checkid;
11949: if (ref($checks) eq 'HASH') {
11950: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11951: $checkid = 1;
11952: }
11953: }
11954: foreach my $user (keys(%{$usershash})) {
11955: my ($uname,$udom) = split(/:/,$user);
11956: if ($checkid) {
11957: if (ref($usershash->{$user}) eq 'HASH') {
11958: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11959: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11960: $userdoms{$udom} = 1;
1.1227 raeburn 11961: if (ref($inst_results) eq 'HASH') {
11962: $inst_results->{$uname.':'.$udom} = {};
11963: }
1.1226 raeburn 11964: }
11965: }
11966: } else {
11967: $by_username{$udom}{$uname} = 1;
11968: $userdoms{$udom} = 1;
1.1227 raeburn 11969: if (ref($inst_results) eq 'HASH') {
11970: $inst_results->{$uname.':'.$udom} = {};
11971: }
1.1226 raeburn 11972: }
11973: }
11974: foreach my $udom (keys(%userdoms)) {
11975: if (!$got_rules->{$udom}) {
11976: my %domconfig = &Apache::lonnet::get_dom('configuration',
11977: ['usercreation'],$udom);
11978: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11979: foreach my $item ('username','id') {
11980: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11981: $$curr_rules{$udom}{$item} =
11982: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11983: }
11984: }
11985: }
11986: $got_rules->{$udom} = 1;
11987: }
1.612 raeburn 11988: }
1.1226 raeburn 11989: if ($checkid) {
11990: foreach my $udom (keys(%by_id)) {
11991: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11992: if ($outcome eq 'ok') {
1.1227 raeburn 11993: foreach my $id (keys(%{$by_id{$udom}})) {
11994: my $uname = $by_id{$udom}{$id};
11995: $inst_response{$uname.':'.$udom} = $outcome;
11996: }
1.1226 raeburn 11997: if (ref($results) eq 'HASH') {
11998: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11999: if (exists($inst_response{$uname.':'.$udom})) {
12000: $inst_response{$uname.':'.$udom} = $outcome;
12001: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12002: }
1.1226 raeburn 12003: }
12004: }
12005: }
1.612 raeburn 12006: }
1.615 raeburn 12007: } else {
1.1226 raeburn 12008: foreach my $udom (keys(%by_username)) {
12009: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12010: if ($outcome eq 'ok') {
1.1227 raeburn 12011: foreach my $uname (keys(%{$by_username{$udom}})) {
12012: $inst_response{$uname.':'.$udom} = $outcome;
12013: }
1.1226 raeburn 12014: if (ref($results) eq 'HASH') {
12015: foreach my $uname (keys(%{$results})) {
12016: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12017: }
12018: }
12019: }
12020: }
1.612 raeburn 12021: }
1.1226 raeburn 12022: } elsif (keys(%{$usershash}) == 1) {
12023: my $user = (keys(%{$usershash}))[0];
12024: my ($uname,$udom) = split(/:/,$user);
12025: if (($udom ne '') && ($uname ne '')) {
12026: if (ref($usershash->{$user}) eq 'HASH') {
12027: if (ref($checks) eq 'HASH') {
12028: if (defined($checks->{'username'})) {
12029: ($inst_response{$user},%{$inst_results->{$user}}) =
12030: &Apache::lonnet::get_instuser($udom,$uname);
12031: } elsif (defined($checks->{'id'})) {
12032: if ($usershash->{$user}->{'id'} ne '') {
12033: ($inst_response{$user},%{$inst_results->{$user}}) =
12034: &Apache::lonnet::get_instuser($udom,undef,
12035: $usershash->{$user}->{'id'});
12036: } else {
12037: ($inst_response{$user},%{$inst_results->{$user}}) =
12038: &Apache::lonnet::get_instuser($udom,$uname);
12039: }
1.585 raeburn 12040: }
1.1226 raeburn 12041: } else {
12042: ($inst_response{$user},%{$inst_results->{$user}}) =
12043: &Apache::lonnet::get_instuser($udom,$uname);
12044: return;
12045: }
12046: if (!$got_rules->{$udom}) {
12047: my %domconfig = &Apache::lonnet::get_dom('configuration',
12048: ['usercreation'],$udom);
12049: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12050: foreach my $item ('username','id') {
12051: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12052: $$curr_rules{$udom}{$item} =
12053: $domconfig{'usercreation'}{$item.'_rule'};
12054: }
12055: }
12056: }
12057: $got_rules->{$udom} = 1;
1.585 raeburn 12058: }
12059: }
1.1226 raeburn 12060: } else {
12061: return;
12062: }
12063: } else {
12064: return;
12065: }
12066: foreach my $user (keys(%{$usershash})) {
12067: my ($uname,$udom) = split(/:/,$user);
12068: next if (($udom eq '') || ($uname eq ''));
12069: my $id;
1.1227 raeburn 12070: if (ref($inst_results) eq 'HASH') {
12071: if (ref($inst_results->{$user}) eq 'HASH') {
12072: $id = $inst_results->{$user}->{'id'};
12073: }
12074: }
12075: if ($id eq '') {
12076: if (ref($usershash->{$user})) {
12077: $id = $usershash->{$user}->{'id'};
12078: }
1.585 raeburn 12079: }
1.612 raeburn 12080: foreach my $item (keys(%{$checks})) {
12081: if (ref($$curr_rules{$udom}) eq 'HASH') {
12082: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12083: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12084: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12085: $$curr_rules{$udom}{$item});
1.612 raeburn 12086: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12087: if ($rule_check{$rule}) {
12088: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12089: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12090: if (ref($inst_results) eq 'HASH') {
12091: if (ref($inst_results->{$user}) eq 'HASH') {
12092: if (keys(%{$inst_results->{$user}}) == 0) {
12093: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12094: } elsif ($item eq 'id') {
12095: if ($inst_results->{$user}->{'id'} eq '') {
12096: $$alerts{$item}{$udom}{$uname} = 1;
12097: }
1.615 raeburn 12098: }
1.612 raeburn 12099: }
12100: }
1.615 raeburn 12101: }
12102: last;
1.585 raeburn 12103: }
12104: }
12105: }
12106: }
12107: }
12108: }
12109: }
12110: }
1.612 raeburn 12111: return;
12112: }
12113:
12114: sub user_rule_formats {
12115: my ($domain,$domdesc,$curr_rules,$check) = @_;
12116: my %text = (
12117: 'username' => 'Usernames',
12118: 'id' => 'IDs',
12119: );
12120: my $output;
12121: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12122: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12123: if (@{$ruleorder} > 0) {
1.1102 raeburn 12124: $output = '<br />'.
12125: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12126: '<span class="LC_cusr_emph">','</span>',$domdesc).
12127: ' <ul>';
1.612 raeburn 12128: foreach my $rule (@{$ruleorder}) {
12129: if (ref($curr_rules) eq 'ARRAY') {
12130: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12131: if (ref($rules->{$rule}) eq 'HASH') {
12132: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12133: $rules->{$rule}{'desc'}.'</li>';
12134: }
12135: }
12136: }
12137: }
12138: $output .= '</ul>';
12139: }
12140: }
12141: return $output;
12142: }
12143:
12144: sub instrule_disallow_msg {
1.615 raeburn 12145: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12146: my $response;
12147: my %text = (
12148: item => 'username',
12149: items => 'usernames',
12150: match => 'matches',
12151: do => 'does',
12152: action => 'a username',
12153: one => 'one',
12154: );
12155: if ($count > 1) {
12156: $text{'item'} = 'usernames';
12157: $text{'match'} ='match';
12158: $text{'do'} = 'do';
12159: $text{'action'} = 'usernames',
12160: $text{'one'} = 'ones';
12161: }
12162: if ($checkitem eq 'id') {
12163: $text{'items'} = 'IDs';
12164: $text{'item'} = 'ID';
12165: $text{'action'} = 'an ID';
1.615 raeburn 12166: if ($count > 1) {
12167: $text{'item'} = 'IDs';
12168: $text{'action'} = 'IDs';
12169: }
1.612 raeburn 12170: }
1.674 bisitz 12171: $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 12172: if ($mode eq 'upload') {
12173: if ($checkitem eq 'username') {
12174: $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'}.");
12175: } elsif ($checkitem eq 'id') {
1.674 bisitz 12176: $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 12177: }
1.669 raeburn 12178: } elsif ($mode eq 'selfcreate') {
12179: if ($checkitem eq 'id') {
12180: $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.");
12181: }
1.615 raeburn 12182: } else {
12183: if ($checkitem eq 'username') {
12184: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12185: } elsif ($checkitem eq 'id') {
12186: $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.");
12187: }
1.612 raeburn 12188: }
12189: return $response;
1.585 raeburn 12190: }
12191:
1.624 raeburn 12192: sub personal_data_fieldtitles {
12193: my %fieldtitles = &Apache::lonlocal::texthash (
12194: id => 'Student/Employee ID',
12195: permanentemail => 'E-mail address',
12196: lastname => 'Last Name',
12197: firstname => 'First Name',
12198: middlename => 'Middle Name',
12199: generation => 'Generation',
12200: gen => 'Generation',
1.765 raeburn 12201: inststatus => 'Affiliation',
1.624 raeburn 12202: );
12203: return %fieldtitles;
12204: }
12205:
1.642 raeburn 12206: sub sorted_inst_types {
12207: my ($dom) = @_;
1.1185 raeburn 12208: my ($usertypes,$order);
12209: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12210: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12211: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12212: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12213: } else {
12214: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12215: }
1.642 raeburn 12216: my $othertitle = &mt('All users');
12217: if ($env{'request.course.id'}) {
1.668 raeburn 12218: $othertitle = &mt('Any users');
1.642 raeburn 12219: }
12220: my @types;
12221: if (ref($order) eq 'ARRAY') {
12222: @types = @{$order};
12223: }
12224: if (@types == 0) {
12225: if (ref($usertypes) eq 'HASH') {
12226: @types = sort(keys(%{$usertypes}));
12227: }
12228: }
12229: if (keys(%{$usertypes}) > 0) {
12230: $othertitle = &mt('Other users');
12231: }
12232: return ($othertitle,$usertypes,\@types);
12233: }
12234:
1.645 raeburn 12235: sub get_institutional_codes {
1.1361 raeburn 12236: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12237: # Get complete list of course sections to update
12238: my @currsections = ();
12239: my @currxlists = ();
1.1361 raeburn 12240: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12241: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12242: my $crskey = $crs.':'.$coursecode;
12243: @{$unclutteredsec{$crskey}} = ();
12244: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12245:
12246: if ($$settings{'internal.sectionnums'} ne '') {
12247: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12248: }
12249:
12250: if ($$settings{'internal.crosslistings'} ne '') {
12251: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12252: }
12253:
12254: if (@currxlists > 0) {
1.1361 raeburn 12255: foreach my $xl (@currxlists) {
12256: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12257: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12258: push(@{$allcourses},$1);
1.645 raeburn 12259: $$LC_code{$1} = $2;
12260: }
12261: }
12262: }
12263: }
1.1361 raeburn 12264:
1.645 raeburn 12265: if (@currsections > 0) {
1.1361 raeburn 12266: foreach my $sec (@currsections) {
12267: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12268: my $instsec = $1;
1.645 raeburn 12269: my $lc_sec = $2;
1.1361 raeburn 12270: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12271: push(@{$unclutteredsec{$crskey}},$instsec);
12272: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12273: }
12274: }
12275: }
12276: }
12277:
12278: if (@{$unclutteredsec{$crskey}} > 0) {
12279: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12280: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12281: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12282: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12283: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12284: push(@{$allcourses},$sec);
1.1361 raeburn 12285: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12286: }
12287: }
12288: }
12289: }
12290: return;
12291: }
12292:
1.971 raeburn 12293: sub get_standard_codeitems {
12294: return ('Year','Semester','Department','Number','Section');
12295: }
12296:
1.112 bowersj2 12297: =pod
12298:
1.780 raeburn 12299: =head1 Slot Helpers
12300:
12301: =over 4
12302:
12303: =item * sorted_slots()
12304:
1.1040 raeburn 12305: Sorts an array of slot names in order of an optional sort key,
12306: default sort is by slot start time (earliest first).
1.780 raeburn 12307:
12308: Inputs:
12309:
12310: =over 4
12311:
12312: slotsarr - Reference to array of unsorted slot names.
12313:
12314: slots - Reference to hash of hash, where outer hash keys are slot names.
12315:
1.1040 raeburn 12316: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12317:
1.549 albertel 12318: =back
12319:
1.780 raeburn 12320: Returns:
12321:
12322: =over 4
12323:
1.1040 raeburn 12324: sorted - An array of slot names sorted by a specified sort key
12325: (default sort key is start time of the slot).
1.780 raeburn 12326:
12327: =back
12328:
12329: =cut
12330:
12331:
12332: sub sorted_slots {
1.1040 raeburn 12333: my ($slotsarr,$slots,$sortkey) = @_;
12334: if ($sortkey eq '') {
12335: $sortkey = 'starttime';
12336: }
1.780 raeburn 12337: my @sorted;
12338: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12339: @sorted =
12340: sort {
12341: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12342: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12343: }
12344: if (ref($slots->{$a})) { return -1;}
12345: if (ref($slots->{$b})) { return 1;}
12346: return 0;
12347: } @{$slotsarr};
12348: }
12349: return @sorted;
12350: }
12351:
1.1040 raeburn 12352: =pod
12353:
12354: =item * get_future_slots()
12355:
12356: Inputs:
12357:
12358: =over 4
12359:
12360: cnum - course number
12361:
12362: cdom - course domain
12363:
12364: now - current UNIX time
12365:
12366: symb - optional symb
12367:
12368: =back
12369:
12370: Returns:
12371:
12372: =over 4
12373:
12374: sorted_reservable - ref to array of student_schedulable slots currently
12375: reservable, ordered by end date of reservation period.
12376:
12377: reservable_now - ref to hash of student_schedulable slots currently
12378: reservable.
12379:
12380: Keys in inner hash are:
12381: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12382: (b) endreserve: end date of reservation period.
12383: (c) uniqueperiod: start,end dates when slot is to be uniquely
12384: selected.
1.1040 raeburn 12385:
12386: sorted_future - ref to array of student_schedulable slots reservable in
12387: the future, ordered by start date of reservation period.
12388:
12389: future_reservable - ref to hash of student_schedulable slots reservable
12390: in the future.
12391:
12392: Keys in inner hash are:
12393: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12394: (b) startreserve: start date of reservation period.
12395: (c) uniqueperiod: start,end dates when slot is to be uniquely
12396: selected.
1.1040 raeburn 12397:
12398: =back
12399:
12400: =cut
12401:
12402: sub get_future_slots {
12403: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12404: my $map;
12405: if ($symb) {
12406: ($map) = &Apache::lonnet::decode_symb($symb);
12407: }
1.1040 raeburn 12408: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12409: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12410: foreach my $slot (keys(%slots)) {
12411: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12412: if ($symb) {
1.1229 raeburn 12413: if ($slots{$slot}->{'symb'} ne '') {
12414: my $canuse;
12415: my %oksymbs;
12416: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12417: map { $oksymbs{$_} = 1; } @slotsymbs;
12418: if ($oksymbs{$symb}) {
12419: $canuse = 1;
12420: } else {
12421: foreach my $item (@slotsymbs) {
12422: if ($item =~ /\.(page|sequence)$/) {
12423: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12424: if (($map ne '') && ($map eq $sloturl)) {
12425: $canuse = 1;
12426: last;
12427: }
12428: }
12429: }
12430: }
12431: next unless ($canuse);
12432: }
1.1040 raeburn 12433: }
12434: if (($slots{$slot}->{'starttime'} > $now) &&
12435: ($slots{$slot}->{'endtime'} > $now)) {
12436: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12437: my $userallowed = 0;
12438: if ($slots{$slot}->{'allowedsections'}) {
12439: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12440: if (!defined($env{'request.role.sec'})
12441: && grep(/^No section assigned$/,@allowed_sec)) {
12442: $userallowed=1;
12443: } else {
12444: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12445: $userallowed=1;
12446: }
12447: }
12448: unless ($userallowed) {
12449: if (defined($env{'request.course.groups'})) {
12450: my @groups = split(/:/,$env{'request.course.groups'});
12451: foreach my $group (@groups) {
12452: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12453: $userallowed=1;
12454: last;
12455: }
12456: }
12457: }
12458: }
12459: }
12460: if ($slots{$slot}->{'allowedusers'}) {
12461: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12462: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12463: if (grep(/^\Q$user\E$/,@allowed_users)) {
12464: $userallowed = 1;
12465: }
12466: }
12467: next unless($userallowed);
12468: }
12469: my $startreserve = $slots{$slot}->{'startreserve'};
12470: my $endreserve = $slots{$slot}->{'endreserve'};
12471: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12472: my $uniqueperiod;
12473: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12474: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12475: }
1.1040 raeburn 12476: if (($startreserve < $now) &&
12477: (!$endreserve || $endreserve > $now)) {
12478: my $lastres = $endreserve;
12479: if (!$lastres) {
12480: $lastres = $slots{$slot}->{'starttime'};
12481: }
12482: $reservable_now{$slot} = {
12483: symb => $symb,
1.1250 raeburn 12484: endreserve => $lastres,
12485: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12486: };
12487: } elsif (($startreserve > $now) &&
12488: (!$endreserve || $endreserve > $startreserve)) {
12489: $future_reservable{$slot} = {
12490: symb => $symb,
1.1250 raeburn 12491: startreserve => $startreserve,
12492: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12493: };
12494: }
12495: }
12496: }
12497: my @unsorted_reservable = keys(%reservable_now);
12498: if (@unsorted_reservable > 0) {
12499: @sorted_reservable =
12500: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12501: }
12502: my @unsorted_future = keys(%future_reservable);
12503: if (@unsorted_future > 0) {
12504: @sorted_future =
12505: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12506: }
12507: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12508: }
1.780 raeburn 12509:
12510: =pod
12511:
1.1057 foxr 12512: =back
12513:
1.549 albertel 12514: =head1 HTTP Helpers
12515:
12516: =over 4
12517:
1.648 raeburn 12518: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12519:
1.258 albertel 12520: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12521: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12522: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12523:
12524: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12525: $possible_names is an ref to an array of form element names. As an example:
12526: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12527: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12528:
12529: =cut
1.1 albertel 12530:
1.6 albertel 12531: sub get_unprocessed_cgi {
1.25 albertel 12532: my ($query,$possible_names)= @_;
1.26 matthew 12533: # $Apache::lonxml::debug=1;
1.356 albertel 12534: foreach my $pair (split(/&/,$query)) {
12535: my ($name, $value) = split(/=/,$pair);
1.369 www 12536: $name = &unescape($name);
1.25 albertel 12537: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12538: $value =~ tr/+/ /;
12539: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12540: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12541: }
1.16 harris41 12542: }
1.6 albertel 12543: }
12544:
1.112 bowersj2 12545: =pod
12546:
1.648 raeburn 12547: =item * &cacheheader()
1.112 bowersj2 12548:
12549: returns cache-controlling header code
12550:
12551: =cut
12552:
1.7 albertel 12553: sub cacheheader {
1.258 albertel 12554: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12555: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12556: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12557: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12558: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12559: return $output;
1.7 albertel 12560: }
12561:
1.112 bowersj2 12562: =pod
12563:
1.648 raeburn 12564: =item * &no_cache($r)
1.112 bowersj2 12565:
12566: specifies header code to not have cache
12567:
12568: =cut
12569:
1.9 albertel 12570: sub no_cache {
1.216 albertel 12571: my ($r) = @_;
12572: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12573: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12574: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12575: $r->no_cache(1);
12576: $r->header_out("Expires" => $date);
12577: $r->header_out("Pragma" => "no-cache");
1.123 www 12578: }
12579:
12580: sub content_type {
1.181 albertel 12581: my ($r,$type,$charset) = @_;
1.299 foxr 12582: if ($r) {
12583: # Note that printout.pl calls this with undef for $r.
12584: &no_cache($r);
12585: }
1.258 albertel 12586: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12587: unless ($charset) {
12588: $charset=&Apache::lonlocal::current_encoding;
12589: }
12590: if ($charset) { $type.='; charset='.$charset; }
12591: if ($r) {
12592: $r->content_type($type);
12593: } else {
12594: print("Content-type: $type\n\n");
12595: }
1.9 albertel 12596: }
1.25 albertel 12597:
1.112 bowersj2 12598: =pod
12599:
1.648 raeburn 12600: =item * &add_to_env($name,$value)
1.112 bowersj2 12601:
1.258 albertel 12602: adds $name to the %env hash with value
1.112 bowersj2 12603: $value, if $name already exists, the entry is converted to an array
12604: reference and $value is added to the array.
12605:
12606: =cut
12607:
1.25 albertel 12608: sub add_to_env {
12609: my ($name,$value)=@_;
1.258 albertel 12610: if (defined($env{$name})) {
12611: if (ref($env{$name})) {
1.25 albertel 12612: #already have multiple values
1.258 albertel 12613: push(@{ $env{$name} },$value);
1.25 albertel 12614: } else {
12615: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12616: my $first=$env{$name};
12617: undef($env{$name});
12618: push(@{ $env{$name} },$first,$value);
1.25 albertel 12619: }
12620: } else {
1.258 albertel 12621: $env{$name}=$value;
1.25 albertel 12622: }
1.31 albertel 12623: }
1.149 albertel 12624:
12625: =pod
12626:
1.648 raeburn 12627: =item * &get_env_multiple($name)
1.149 albertel 12628:
1.258 albertel 12629: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12630: values may be defined and end up as an array ref.
12631:
12632: returns an array of values
12633:
12634: =cut
12635:
12636: sub get_env_multiple {
12637: my ($name) = @_;
12638: my @values;
1.258 albertel 12639: if (defined($env{$name})) {
1.149 albertel 12640: # exists is it an array
1.258 albertel 12641: if (ref($env{$name})) {
12642: @values=@{ $env{$name} };
1.149 albertel 12643: } else {
1.258 albertel 12644: $values[0]=$env{$name};
1.149 albertel 12645: }
12646: }
12647: return(@values);
12648: }
12649:
1.1249 damieng 12650: # Looks at given dependencies, and returns something depending on the context.
12651: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12652: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12653: # For all other contexts, returns ($output, $counter, $numpathchg).
12654: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12655: # $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.
12656: # $numpathchg: integer with the number of cleaned up dependency paths.
12657: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12658: # \%mapping: hash reference clean path -> original path for all dependencies.
12659: # @param {string} actionurl - The path to the handler, indicative of the context.
12660: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12661: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12662: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12663: # @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)
12664: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12665: sub ask_for_embedded_content {
1.1249 damieng 12666: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12667: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12668: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12669: %currsubfile,%unused,$rem);
1.1071 raeburn 12670: my $counter = 0;
12671: my $numnew = 0;
1.987 raeburn 12672: my $numremref = 0;
12673: my $numinvalid = 0;
12674: my $numpathchg = 0;
12675: my $numexisting = 0;
1.1071 raeburn 12676: my $numunused = 0;
12677: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12678: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12679: my $heading = &mt('Upload embedded files');
12680: my $buttontext = &mt('Upload');
12681:
1.1249 damieng 12682: # fills these variables based on the context:
12683: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12684: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12685: if ($env{'request.course.id'}) {
1.1123 raeburn 12686: if ($actionurl eq '/adm/dependencies') {
12687: $navmap = Apache::lonnavmaps::navmap->new();
12688: }
12689: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12690: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12691: }
1.1123 raeburn 12692: if (($actionurl eq '/adm/portfolio') ||
12693: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12694: my $current_path='/';
12695: if ($env{'form.currentpath'}) {
12696: $current_path = $env{'form.currentpath'};
12697: }
12698: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12699: $udom = $cdom;
12700: $uname = $cnum;
1.984 raeburn 12701: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12702: } else {
12703: $udom = $env{'user.domain'};
12704: $uname = $env{'user.name'};
12705: $url = '/userfiles/portfolio';
12706: }
1.987 raeburn 12707: $toplevel = $url.'/';
1.984 raeburn 12708: $url .= $current_path;
12709: $getpropath = 1;
1.987 raeburn 12710: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12711: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12712: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12713: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12714: $toplevel = $url;
1.984 raeburn 12715: if ($rest ne '') {
1.987 raeburn 12716: $url .= $rest;
12717: }
12718: } elsif ($actionurl eq '/adm/coursedocs') {
12719: if (ref($args) eq 'HASH') {
1.1071 raeburn 12720: $url = $args->{'docs_url'};
12721: $toplevel = $url;
1.1084 raeburn 12722: if ($args->{'context'} eq 'paste') {
12723: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12724: ($path) =
12725: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12726: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12727: $fileloc =~ s{^/}{};
12728: }
1.1071 raeburn 12729: }
1.1084 raeburn 12730: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12731: if ($env{'request.course.id'} ne '') {
12732: if (ref($args) eq 'HASH') {
12733: $url = $args->{'docs_url'};
12734: $title = $args->{'docs_title'};
1.1126 raeburn 12735: $toplevel = $url;
12736: unless ($toplevel =~ m{^/}) {
12737: $toplevel = "/$url";
12738: }
1.1085 raeburn 12739: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12740: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12741: $path = $1;
12742: } else {
12743: ($path) =
12744: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12745: }
1.1195 raeburn 12746: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12747: $fileloc = $toplevel;
12748: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12749: my ($udom,$uname,$fname) =
12750: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12751: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12752: } else {
12753: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12754: }
1.1071 raeburn 12755: $fileloc =~ s{^/}{};
12756: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12757: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12758: }
1.987 raeburn 12759: }
1.1123 raeburn 12760: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12761: $udom = $cdom;
12762: $uname = $cnum;
12763: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12764: $toplevel = $url;
12765: $path = $url;
12766: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12767: $fileloc =~ s{^/}{};
1.987 raeburn 12768: }
1.1249 damieng 12769:
12770: # parses the dependency paths to get some info
12771: # fills $newfiles, $mapping, $subdependencies, $dependencies
12772: # $newfiles: hash URL -> 1 for new files or external URLs
12773: # (will be completed later)
12774: # $mapping:
12775: # for external URLs: external URL -> external URL
12776: # for relative paths: clean path -> original path
12777: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12778: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12779: foreach my $file (keys(%{$allfiles})) {
12780: my $embed_file;
12781: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12782: $embed_file = $1;
12783: } else {
12784: $embed_file = $file;
12785: }
1.1158 raeburn 12786: my ($absolutepath,$cleaned_file);
12787: if ($embed_file =~ m{^\w+://}) {
12788: $cleaned_file = $embed_file;
1.1147 raeburn 12789: $newfiles{$cleaned_file} = 1;
12790: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12791: } else {
1.1158 raeburn 12792: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12793: if ($embed_file =~ m{^/}) {
12794: $absolutepath = $embed_file;
12795: }
1.1147 raeburn 12796: if ($cleaned_file =~ m{/}) {
12797: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12798: $path = &check_for_traversal($path,$url,$toplevel);
12799: my $item = $fname;
12800: if ($path ne '') {
12801: $item = $path.'/'.$fname;
12802: $subdependencies{$path}{$fname} = 1;
12803: } else {
12804: $dependencies{$item} = 1;
12805: }
12806: if ($absolutepath) {
12807: $mapping{$item} = $absolutepath;
12808: } else {
12809: $mapping{$item} = $embed_file;
12810: }
12811: } else {
12812: $dependencies{$embed_file} = 1;
12813: if ($absolutepath) {
1.1147 raeburn 12814: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12815: } else {
1.1147 raeburn 12816: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12817: }
12818: }
1.984 raeburn 12819: }
12820: }
1.1249 damieng 12821:
12822: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12823: # and lists
12824: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12825: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12826: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12827: # the path had to be cleaned up
12828: # $existing: hash clean path -> 1 if the file exists
12829: # $numexisting: number of keys in $existing
12830: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12831: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12832: # dependency subdirectories that are
12833: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12834: my $dirptr = 16384;
1.984 raeburn 12835: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12836: $currsubfile{$path} = {};
1.1123 raeburn 12837: if (($actionurl eq '/adm/portfolio') ||
12838: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12839: my ($sublistref,$listerror) =
12840: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12841: if (ref($sublistref) eq 'ARRAY') {
12842: foreach my $line (@{$sublistref}) {
12843: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12844: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12845: }
1.984 raeburn 12846: }
1.987 raeburn 12847: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12848: if (opendir(my $dir,$url.'/'.$path)) {
12849: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12850: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12851: }
1.1084 raeburn 12852: } elsif (($actionurl eq '/adm/dependencies') ||
12853: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12854: ($args->{'context'} eq 'paste')) ||
12855: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12856: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12857: my $dir;
12858: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12859: $dir = $fileloc;
12860: } else {
12861: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12862: }
1.1071 raeburn 12863: if ($dir ne '') {
12864: my ($sublistref,$listerror) =
12865: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12866: if (ref($sublistref) eq 'ARRAY') {
12867: foreach my $line (@{$sublistref}) {
12868: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12869: undef,$mtime)=split(/\&/,$line,12);
12870: unless (($testdir&$dirptr) ||
12871: ($file_name =~ /^\.\.?$/)) {
12872: $currsubfile{$path}{$file_name} = [$size,$mtime];
12873: }
12874: }
12875: }
12876: }
1.984 raeburn 12877: }
12878: }
12879: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12880: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12881: my $item = $path.'/'.$file;
12882: unless ($mapping{$item} eq $item) {
12883: $pathchanges{$item} = 1;
12884: }
12885: $existing{$item} = 1;
12886: $numexisting ++;
12887: } else {
12888: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12889: }
12890: }
1.1071 raeburn 12891: if ($actionurl eq '/adm/dependencies') {
12892: foreach my $path (keys(%currsubfile)) {
12893: if (ref($currsubfile{$path}) eq 'HASH') {
12894: foreach my $file (keys(%{$currsubfile{$path}})) {
12895: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12896: next if (($rem ne '') &&
12897: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12898: (ref($navmap) &&
12899: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12900: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12901: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12902: $unused{$path.'/'.$file} = 1;
12903: }
12904: }
12905: }
12906: }
12907: }
1.984 raeburn 12908: }
1.1249 damieng 12909:
12910: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12911: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12912: my %currfile;
1.1123 raeburn 12913: if (($actionurl eq '/adm/portfolio') ||
12914: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12915: my ($dirlistref,$listerror) =
12916: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12917: if (ref($dirlistref) eq 'ARRAY') {
12918: foreach my $line (@{$dirlistref}) {
12919: my ($file_name,$rest) = split(/\&/,$line,2);
12920: $currfile{$file_name} = 1;
12921: }
1.984 raeburn 12922: }
1.987 raeburn 12923: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12924: if (opendir(my $dir,$url)) {
1.987 raeburn 12925: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12926: map {$currfile{$_} = 1;} @dir_list;
12927: }
1.1084 raeburn 12928: } elsif (($actionurl eq '/adm/dependencies') ||
12929: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12930: ($args->{'context'} eq 'paste')) ||
12931: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12932: if ($env{'request.course.id'} ne '') {
12933: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12934: if ($dir ne '') {
12935: my ($dirlistref,$listerror) =
12936: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12937: if (ref($dirlistref) eq 'ARRAY') {
12938: foreach my $line (@{$dirlistref}) {
12939: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12940: $size,undef,$mtime)=split(/\&/,$line,12);
12941: unless (($testdir&$dirptr) ||
12942: ($file_name =~ /^\.\.?$/)) {
12943: $currfile{$file_name} = [$size,$mtime];
12944: }
12945: }
12946: }
12947: }
12948: }
1.984 raeburn 12949: }
1.1249 damieng 12950: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12951: # are not in subdirectories, using $currfile
1.984 raeburn 12952: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12953: if (exists($currfile{$file})) {
1.987 raeburn 12954: unless ($mapping{$file} eq $file) {
12955: $pathchanges{$file} = 1;
12956: }
12957: $existing{$file} = 1;
12958: $numexisting ++;
12959: } else {
1.984 raeburn 12960: $newfiles{$file} = 1;
12961: }
12962: }
1.1071 raeburn 12963: foreach my $file (keys(%currfile)) {
12964: unless (($file eq $filename) ||
12965: ($file eq $filename.'.bak') ||
12966: ($dependencies{$file})) {
1.1085 raeburn 12967: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12968: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12969: next if (($rem ne '') &&
12970: (($env{"httpref.$rem".$file} ne '') ||
12971: (ref($navmap) &&
12972: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12973: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12974: ($navmap->getResourceByUrl($rem.$1)))))));
12975: }
1.1085 raeburn 12976: }
1.1071 raeburn 12977: $unused{$file} = 1;
12978: }
12979: }
1.1249 damieng 12980:
12981: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12982: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12983: ($args->{'context'} eq 'paste')) {
12984: $counter = scalar(keys(%existing));
12985: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12986: return ($output,$counter,$numpathchg,\%existing);
12987: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12988: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12989: $counter = scalar(keys(%existing));
12990: $numpathchg = scalar(keys(%pathchanges));
12991: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12992: }
1.1249 damieng 12993:
12994: # returns HTML otherwise, with dependency results and to ask for more uploads
12995:
12996: # $upload_output: missing dependencies (with upload form)
12997: # $modify_output: uploaded dependencies (in use)
12998: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12999: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13000: if ($actionurl eq '/adm/dependencies') {
13001: next if ($embed_file =~ m{^\w+://});
13002: }
1.660 raeburn 13003: $upload_output .= &start_data_table_row().
1.1123 raeburn 13004: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13005: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13006: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13007: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13008: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13009: }
1.1123 raeburn 13010: $upload_output .= '</td>';
1.1071 raeburn 13011: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13012: $upload_output.='<td align="right">'.
13013: '<span class="LC_info LC_fontsize_medium">'.
13014: &mt("URL points to web address").'</span>';
1.987 raeburn 13015: $numremref++;
1.660 raeburn 13016: } elsif ($args->{'error_on_invalid_names'}
13017: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13018: $upload_output.='<td align="right"><span class="LC_warning">'.
13019: &mt('Invalid characters').'</span>';
1.987 raeburn 13020: $numinvalid++;
1.660 raeburn 13021: } else {
1.1123 raeburn 13022: $upload_output .= '<td>'.
13023: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13024: $embed_file,\%mapping,
1.1071 raeburn 13025: $allfiles,$codebase,'upload');
13026: $counter ++;
13027: $numnew ++;
1.987 raeburn 13028: }
13029: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13030: }
13031: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13032: if ($actionurl eq '/adm/dependencies') {
13033: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13034: $modify_output .= &start_data_table_row().
13035: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13036: '<img src="'.&icon($embed_file).'" border="0" />'.
13037: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13038: '<td>'.$size.'</td>'.
13039: '<td>'.$mtime.'</td>'.
13040: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13041: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13042: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13043: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13044: &embedded_file_element('upload_embedded',$counter,
13045: $embed_file,\%mapping,
13046: $allfiles,$codebase,'modify').
13047: '</div></td>'.
13048: &end_data_table_row()."\n";
13049: $counter ++;
13050: } else {
13051: $upload_output .= &start_data_table_row().
1.1123 raeburn 13052: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13053: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13054: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13055: &Apache::loncommon::end_data_table_row()."\n";
13056: }
13057: }
13058: my $delidx = $counter;
13059: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13060: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13061: $delete_output .= &start_data_table_row().
13062: '<td><img src="'.&icon($oldfile).'" />'.
13063: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13064: '<td>'.$size.'</td>'.
13065: '<td>'.$mtime.'</td>'.
13066: '<td><label><input type="checkbox" name="del_upload_dep" '.
13067: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13068: &embedded_file_element('upload_embedded',$delidx,
13069: $oldfile,\%mapping,$allfiles,
13070: $codebase,'delete').'</td>'.
13071: &end_data_table_row()."\n";
13072: $numunused ++;
13073: $delidx ++;
1.987 raeburn 13074: }
13075: if ($upload_output) {
13076: $upload_output = &start_data_table().
13077: $upload_output.
13078: &end_data_table()."\n";
13079: }
1.1071 raeburn 13080: if ($modify_output) {
13081: $modify_output = &start_data_table().
13082: &start_data_table_header_row().
13083: '<th>'.&mt('File').'</th>'.
13084: '<th>'.&mt('Size (KB)').'</th>'.
13085: '<th>'.&mt('Modified').'</th>'.
13086: '<th>'.&mt('Upload replacement?').'</th>'.
13087: &end_data_table_header_row().
13088: $modify_output.
13089: &end_data_table()."\n";
13090: }
13091: if ($delete_output) {
13092: $delete_output = &start_data_table().
13093: &start_data_table_header_row().
13094: '<th>'.&mt('File').'</th>'.
13095: '<th>'.&mt('Size (KB)').'</th>'.
13096: '<th>'.&mt('Modified').'</th>'.
13097: '<th>'.&mt('Delete?').'</th>'.
13098: &end_data_table_header_row().
13099: $delete_output.
13100: &end_data_table()."\n";
13101: }
1.987 raeburn 13102: my $applies = 0;
13103: if ($numremref) {
13104: $applies ++;
13105: }
13106: if ($numinvalid) {
13107: $applies ++;
13108: }
13109: if ($numexisting) {
13110: $applies ++;
13111: }
1.1071 raeburn 13112: if ($counter || $numunused) {
1.987 raeburn 13113: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13114: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13115: $state.'<h3>'.$heading.'</h3>';
13116: if ($actionurl eq '/adm/dependencies') {
13117: if ($numnew) {
13118: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13119: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13120: $upload_output.'<br />'."\n";
13121: }
13122: if ($numexisting) {
13123: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13124: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13125: $modify_output.'<br />'."\n";
13126: $buttontext = &mt('Save changes');
13127: }
13128: if ($numunused) {
13129: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13130: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13131: $delete_output.'<br />'."\n";
13132: $buttontext = &mt('Save changes');
13133: }
13134: } else {
13135: $output .= $upload_output.'<br />'."\n";
13136: }
13137: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13138: $counter.'" />'."\n";
13139: if ($actionurl eq '/adm/dependencies') {
13140: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13141: $numnew.'" />'."\n";
13142: } elsif ($actionurl eq '') {
1.987 raeburn 13143: $output .= '<input type="hidden" name="phase" value="three" />';
13144: }
13145: } elsif ($applies) {
13146: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13147: if ($applies > 1) {
13148: $output .=
1.1123 raeburn 13149: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13150: if ($numremref) {
13151: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13152: }
13153: if ($numinvalid) {
13154: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13155: }
13156: if ($numexisting) {
13157: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13158: }
13159: $output .= '</ul><br />';
13160: } elsif ($numremref) {
13161: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13162: } elsif ($numinvalid) {
13163: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13164: } elsif ($numexisting) {
13165: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13166: }
13167: $output .= $upload_output.'<br />';
13168: }
13169: my ($pathchange_output,$chgcount);
1.1071 raeburn 13170: $chgcount = $counter;
1.987 raeburn 13171: if (keys(%pathchanges) > 0) {
13172: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13173: if ($counter) {
1.987 raeburn 13174: $output .= &embedded_file_element('pathchange',$chgcount,
13175: $embed_file,\%mapping,
1.1071 raeburn 13176: $allfiles,$codebase,'change');
1.987 raeburn 13177: } else {
13178: $pathchange_output .=
13179: &start_data_table_row().
13180: '<td><input type ="checkbox" name="namechange" value="'.
13181: $chgcount.'" checked="checked" /></td>'.
13182: '<td>'.$mapping{$embed_file}.'</td>'.
13183: '<td>'.$embed_file.
13184: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13185: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13186: '</td>'.&end_data_table_row();
1.660 raeburn 13187: }
1.987 raeburn 13188: $numpathchg ++;
13189: $chgcount ++;
1.660 raeburn 13190: }
13191: }
1.1127 raeburn 13192: if (($counter) || ($numunused)) {
1.987 raeburn 13193: if ($numpathchg) {
13194: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13195: $numpathchg.'" />'."\n";
13196: }
13197: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13198: ($actionurl eq '/adm/imsimport')) {
13199: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13200: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13201: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13202: } elsif ($actionurl eq '/adm/dependencies') {
13203: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13204: }
1.1123 raeburn 13205: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13206: } elsif ($numpathchg) {
13207: my %pathchange = ();
13208: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13209: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13210: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13211: }
1.987 raeburn 13212: }
1.1071 raeburn 13213: return ($output,$counter,$numpathchg);
1.987 raeburn 13214: }
13215:
1.1147 raeburn 13216: =pod
13217:
13218: =item * clean_path($name)
13219:
13220: Performs clean-up of directories, subdirectories and filename in an
13221: embedded object, referenced in an HTML file which is being uploaded
13222: to a course or portfolio, where
13223: "Upload embedded images/multimedia files if HTML file" checkbox was
13224: checked.
13225:
13226: Clean-up is similar to replacements in lonnet::clean_filename()
13227: except each / between sub-directory and next level is preserved.
13228:
13229: =cut
13230:
13231: sub clean_path {
13232: my ($embed_file) = @_;
13233: $embed_file =~s{^/+}{};
13234: my @contents;
13235: if ($embed_file =~ m{/}) {
13236: @contents = split(/\//,$embed_file);
13237: } else {
13238: @contents = ($embed_file);
13239: }
13240: my $lastidx = scalar(@contents)-1;
13241: for (my $i=0; $i<=$lastidx; $i++) {
13242: $contents[$i]=~s{\\}{/}g;
13243: $contents[$i]=~s/\s+/\_/g;
13244: $contents[$i]=~s{[^/\w\.\-]}{}g;
13245: if ($i == $lastidx) {
13246: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13247: }
13248: }
13249: if ($lastidx > 0) {
13250: return join('/',@contents);
13251: } else {
13252: return $contents[0];
13253: }
13254: }
13255:
1.987 raeburn 13256: sub embedded_file_element {
1.1071 raeburn 13257: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13258: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13259: (ref($codebase) eq 'HASH'));
13260: my $output;
1.1071 raeburn 13261: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13262: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13263: }
13264: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13265: &escape($embed_file).'" />';
13266: unless (($context eq 'upload_embedded') &&
13267: ($mapping->{$embed_file} eq $embed_file)) {
13268: $output .='
13269: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13270: }
13271: my $attrib;
13272: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13273: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13274: }
13275: $output .=
13276: "\n\t\t".
13277: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13278: $attrib.'" />';
13279: if (exists($codebase->{$mapping->{$embed_file}})) {
13280: $output .=
13281: "\n\t\t".
13282: '<input name="codebase_'.$num.'" type="hidden" value="'.
13283: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13284: }
1.987 raeburn 13285: return $output;
1.660 raeburn 13286: }
13287:
1.1071 raeburn 13288: sub get_dependency_details {
13289: my ($currfile,$currsubfile,$embed_file) = @_;
13290: my ($size,$mtime,$showsize,$showmtime);
13291: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13292: if ($embed_file =~ m{/}) {
13293: my ($path,$fname) = split(/\//,$embed_file);
13294: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13295: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13296: }
13297: } else {
13298: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13299: ($size,$mtime) = @{$currfile->{$embed_file}};
13300: }
13301: }
13302: $showsize = $size/1024.0;
13303: $showsize = sprintf("%.1f",$showsize);
13304: if ($mtime > 0) {
13305: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13306: }
13307: }
13308: return ($showsize,$showmtime);
13309: }
13310:
13311: sub ask_embedded_js {
13312: return <<"END";
13313: <script type="text/javascript"">
13314: // <![CDATA[
13315: function toggleBrowse(counter) {
13316: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13317: var fileid = document.getElementById('embedded_item_'+counter);
13318: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13319: if (chkboxid.checked == true) {
13320: uploaddivid.style.display='block';
13321: } else {
13322: uploaddivid.style.display='none';
13323: fileid.value = '';
13324: }
13325: }
13326: // ]]>
13327: </script>
13328:
13329: END
13330: }
13331:
1.661 raeburn 13332: sub upload_embedded {
13333: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13334: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13335: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13336: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13337: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13338: my $orig_uploaded_filename =
13339: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13340: foreach my $type ('orig','ref','attrib','codebase') {
13341: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13342: $env{'form.embedded_'.$type.'_'.$i} =
13343: &unescape($env{'form.embedded_'.$type.'_'.$i});
13344: }
13345: }
1.661 raeburn 13346: my ($path,$fname) =
13347: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13348: # no path, whole string is fname
13349: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13350: $fname = &Apache::lonnet::clean_filename($fname);
13351: # See if there is anything left
13352: next if ($fname eq '');
13353:
13354: # Check if file already exists as a file or directory.
13355: my ($state,$msg);
13356: if ($context eq 'portfolio') {
13357: my $port_path = $dirpath;
13358: if ($group ne '') {
13359: $port_path = "groups/$group/$port_path";
13360: }
1.987 raeburn 13361: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13362: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13363: $dir_root,$port_path,$disk_quota,
13364: $current_disk_usage,$uname,$udom);
13365: if ($state eq 'will_exceed_quota'
1.984 raeburn 13366: || $state eq 'file_locked') {
1.661 raeburn 13367: $output .= $msg;
13368: next;
13369: }
13370: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13371: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13372: if ($state eq 'exists') {
13373: $output .= $msg;
13374: next;
13375: }
13376: }
13377: # Check if extension is valid
13378: if (($fname =~ /\.(\w+)$/) &&
13379: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13380: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13381: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13382: next;
13383: } elsif (($fname =~ /\.(\w+)$/) &&
13384: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13385: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13386: next;
13387: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13388: $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 13389: next;
13390: }
13391: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13392: my $subdir = $path;
13393: $subdir =~ s{/+$}{};
1.661 raeburn 13394: if ($context eq 'portfolio') {
1.984 raeburn 13395: my $result;
13396: if ($state eq 'existingfile') {
13397: $result=
13398: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13399: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13400: } else {
1.984 raeburn 13401: $result=
13402: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13403: $dirpath.
1.1123 raeburn 13404: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13405: if ($result !~ m|^/uploaded/|) {
13406: $output .= '<span class="LC_error">'
13407: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13408: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13409: .'</span><br />';
13410: next;
13411: } else {
1.987 raeburn 13412: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13413: $path.$fname.'</span>').'<br />';
1.984 raeburn 13414: }
1.661 raeburn 13415: }
1.1123 raeburn 13416: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13417: my $extendedsubdir = $dirpath.'/'.$subdir;
13418: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13419: my $result =
1.1126 raeburn 13420: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13421: if ($result !~ m|^/uploaded/|) {
13422: $output .= '<span class="LC_error">'
13423: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13424: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13425: .'</span><br />';
13426: next;
13427: } else {
13428: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13429: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13430: if ($context eq 'syllabus') {
13431: &Apache::lonnet::make_public_indefinitely($result);
13432: }
1.987 raeburn 13433: }
1.661 raeburn 13434: } else {
13435: # Save the file
13436: my $target = $env{'form.embedded_item_'.$i};
13437: my $fullpath = $dir_root.$dirpath.'/'.$path;
13438: my $dest = $fullpath.$fname;
13439: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13440: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13441: my $count;
13442: my $filepath = $dir_root;
1.1027 raeburn 13443: foreach my $subdir (@parts) {
13444: $filepath .= "/$subdir";
13445: if (!-e $filepath) {
1.661 raeburn 13446: mkdir($filepath,0770);
13447: }
13448: }
13449: my $fh;
13450: if (!open($fh,'>'.$dest)) {
13451: &Apache::lonnet::logthis('Failed to create '.$dest);
13452: $output .= '<span class="LC_error">'.
1.1071 raeburn 13453: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13454: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13455: '</span><br />';
13456: } else {
13457: if (!print $fh $env{'form.embedded_item_'.$i}) {
13458: &Apache::lonnet::logthis('Failed to write to '.$dest);
13459: $output .= '<span class="LC_error">'.
1.1071 raeburn 13460: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13461: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13462: '</span><br />';
13463: } else {
1.987 raeburn 13464: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13465: $url.'</span>').'<br />';
13466: unless ($context eq 'testbank') {
13467: $footer .= &mt('View embedded file: [_1]',
13468: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13469: }
13470: }
13471: close($fh);
13472: }
13473: }
13474: if ($env{'form.embedded_ref_'.$i}) {
13475: $pathchange{$i} = 1;
13476: }
13477: }
13478: if ($output) {
13479: $output = '<p>'.$output.'</p>';
13480: }
13481: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13482: $returnflag = 'ok';
1.1071 raeburn 13483: my $numpathchgs = scalar(keys(%pathchange));
13484: if ($numpathchgs > 0) {
1.987 raeburn 13485: if ($context eq 'portfolio') {
13486: $output .= '<p>'.&mt('or').'</p>';
13487: } elsif ($context eq 'testbank') {
1.1071 raeburn 13488: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13489: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13490: $returnflag = 'modify_orightml';
13491: }
13492: }
1.1071 raeburn 13493: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13494: }
13495:
13496: sub modify_html_form {
13497: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13498: my $end = 0;
13499: my $modifyform;
13500: if ($context eq 'upload_embedded') {
13501: return unless (ref($pathchange) eq 'HASH');
13502: if ($env{'form.number_embedded_items'}) {
13503: $end += $env{'form.number_embedded_items'};
13504: }
13505: if ($env{'form.number_pathchange_items'}) {
13506: $end += $env{'form.number_pathchange_items'};
13507: }
13508: if ($end) {
13509: for (my $i=0; $i<$end; $i++) {
13510: if ($i < $env{'form.number_embedded_items'}) {
13511: next unless($pathchange->{$i});
13512: }
13513: $modifyform .=
13514: &start_data_table_row().
13515: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13516: 'checked="checked" /></td>'.
13517: '<td>'.$env{'form.embedded_ref_'.$i}.
13518: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13519: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13520: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13521: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13522: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13523: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13524: '<td>'.$env{'form.embedded_orig_'.$i}.
13525: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13526: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13527: &end_data_table_row();
1.1071 raeburn 13528: }
1.987 raeburn 13529: }
13530: } else {
13531: $modifyform = $pathchgtable;
13532: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13533: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13534: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13535: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13536: }
13537: }
13538: if ($modifyform) {
1.1071 raeburn 13539: if ($actionurl eq '/adm/dependencies') {
13540: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13541: }
1.987 raeburn 13542: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13543: '<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".
13544: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13545: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13546: '</ol></p>'."\n".'<p>'.
13547: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13548: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13549: &start_data_table()."\n".
13550: &start_data_table_header_row().
13551: '<th>'.&mt('Change?').'</th>'.
13552: '<th>'.&mt('Current reference').'</th>'.
13553: '<th>'.&mt('Required reference').'</th>'.
13554: &end_data_table_header_row()."\n".
13555: $modifyform.
13556: &end_data_table().'<br />'."\n".$hiddenstate.
13557: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13558: '</form>'."\n";
13559: }
13560: return;
13561: }
13562:
13563: sub modify_html_refs {
1.1123 raeburn 13564: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13565: my $container;
13566: if ($context eq 'portfolio') {
13567: $container = $env{'form.container'};
13568: } elsif ($context eq 'coursedoc') {
13569: $container = $env{'form.primaryurl'};
1.1071 raeburn 13570: } elsif ($context eq 'manage_dependencies') {
13571: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13572: $container = "/$container";
1.1123 raeburn 13573: } elsif ($context eq 'syllabus') {
13574: $container = $url;
1.987 raeburn 13575: } else {
1.1027 raeburn 13576: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13577: }
13578: my (%allfiles,%codebase,$output,$content);
13579: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13580: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13581: if (wantarray) {
13582: return ('',0,0);
13583: } else {
13584: return;
13585: }
13586: }
13587: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13588: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13589: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13590: if (wantarray) {
13591: return ('',0,0);
13592: } else {
13593: return;
13594: }
13595: }
1.987 raeburn 13596: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13597: if ($content eq '-1') {
13598: if (wantarray) {
13599: return ('',0,0);
13600: } else {
13601: return;
13602: }
13603: }
1.987 raeburn 13604: } else {
1.1071 raeburn 13605: unless ($container =~ /^\Q$dir_root\E/) {
13606: if (wantarray) {
13607: return ('',0,0);
13608: } else {
13609: return;
13610: }
13611: }
1.1317 raeburn 13612: if (open(my $fh,'<',$container)) {
1.987 raeburn 13613: $content = join('', <$fh>);
13614: close($fh);
13615: } else {
1.1071 raeburn 13616: if (wantarray) {
13617: return ('',0,0);
13618: } else {
13619: return;
13620: }
1.987 raeburn 13621: }
13622: }
13623: my ($count,$codebasecount) = (0,0);
13624: my $mm = new File::MMagic;
13625: my $mime_type = $mm->checktype_contents($content);
13626: if ($mime_type eq 'text/html') {
13627: my $parse_result =
13628: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13629: \%codebase,\$content);
13630: if ($parse_result eq 'ok') {
13631: foreach my $i (@changes) {
13632: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13633: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13634: if ($allfiles{$ref}) {
13635: my $newname = $orig;
13636: my ($attrib_regexp,$codebase);
1.1006 raeburn 13637: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13638: if ($attrib_regexp =~ /:/) {
13639: $attrib_regexp =~ s/\:/|/g;
13640: }
13641: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13642: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13643: $count += $numchg;
1.1123 raeburn 13644: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13645: delete($allfiles{$ref});
1.987 raeburn 13646: }
13647: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13648: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13649: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13650: $codebasecount ++;
13651: }
13652: }
13653: }
1.1123 raeburn 13654: my $skiprewrites;
1.987 raeburn 13655: if ($count || $codebasecount) {
13656: my $saveresult;
1.1071 raeburn 13657: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13658: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13659: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13660: if ($url eq $container) {
13661: my ($fname) = ($container =~ m{/([^/]+)$});
13662: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13663: $count,'<span class="LC_filename">'.
1.1071 raeburn 13664: $fname.'</span>').'</p>';
1.987 raeburn 13665: } else {
13666: $output = '<p class="LC_error">'.
13667: &mt('Error: update failed for: [_1].',
13668: '<span class="LC_filename">'.
13669: $container.'</span>').'</p>';
13670: }
1.1123 raeburn 13671: if ($context eq 'syllabus') {
13672: unless ($saveresult eq 'ok') {
13673: $skiprewrites = 1;
13674: }
13675: }
1.987 raeburn 13676: } else {
1.1317 raeburn 13677: if (open(my $fh,'>',$container)) {
1.987 raeburn 13678: print $fh $content;
13679: close($fh);
13680: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13681: $count,'<span class="LC_filename">'.
13682: $container.'</span>').'</p>';
1.661 raeburn 13683: } else {
1.987 raeburn 13684: $output = '<p class="LC_error">'.
13685: &mt('Error: could not update [_1].',
13686: '<span class="LC_filename">'.
13687: $container.'</span>').'</p>';
1.661 raeburn 13688: }
13689: }
13690: }
1.1123 raeburn 13691: if (($context eq 'syllabus') && (!$skiprewrites)) {
13692: my ($actionurl,$state);
13693: $actionurl = "/public/$udom/$uname/syllabus";
13694: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13695: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13696: \%codebase,
13697: {'context' => 'rewrites',
13698: 'ignore_remote_references' => 1,});
13699: if (ref($mapping) eq 'HASH') {
13700: my $rewrites = 0;
13701: foreach my $key (keys(%{$mapping})) {
13702: next if ($key =~ m{^https?://});
13703: my $ref = $mapping->{$key};
13704: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13705: my $attrib;
13706: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13707: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13708: }
13709: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13710: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13711: $rewrites += $numchg;
13712: }
13713: }
13714: if ($rewrites) {
13715: my $saveresult;
13716: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13717: if ($url eq $container) {
13718: my ($fname) = ($container =~ m{/([^/]+)$});
13719: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13720: $count,'<span class="LC_filename">'.
13721: $fname.'</span>').'</p>';
13722: } else {
13723: $output .= '<p class="LC_error">'.
13724: &mt('Error: could not update links in [_1].',
13725: '<span class="LC_filename">'.
13726: $container.'</span>').'</p>';
13727:
13728: }
13729: }
13730: }
13731: }
1.987 raeburn 13732: } else {
13733: &logthis('Failed to parse '.$container.
13734: ' to modify references: '.$parse_result);
1.661 raeburn 13735: }
13736: }
1.1071 raeburn 13737: if (wantarray) {
13738: return ($output,$count,$codebasecount);
13739: } else {
13740: return $output;
13741: }
1.661 raeburn 13742: }
13743:
13744: sub check_for_existing {
13745: my ($path,$fname,$element) = @_;
13746: my ($state,$msg);
13747: if (-d $path.'/'.$fname) {
13748: $state = 'exists';
13749: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13750: } elsif (-e $path.'/'.$fname) {
13751: $state = 'exists';
13752: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13753: }
13754: if ($state eq 'exists') {
13755: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13756: }
13757: return ($state,$msg);
13758: }
13759:
13760: sub check_for_upload {
13761: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13762: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13763: my $filesize = length($env{'form.'.$element});
13764: if (!$filesize) {
13765: my $msg = '<span class="LC_error">'.
13766: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13767: '<span class="LC_filename">'.$fname.'</span>',
13768: $filesize).'<br />'.
1.1007 raeburn 13769: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13770: '</span>';
13771: return ('zero_bytes',$msg);
13772: }
13773: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13774: my $getpropath = 1;
1.1021 raeburn 13775: my ($dirlistref,$listerror) =
13776: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13777: my $found_file = 0;
13778: my $locked_file = 0;
1.991 raeburn 13779: my @lockers;
13780: my $navmap;
13781: if ($env{'request.course.id'}) {
13782: $navmap = Apache::lonnavmaps::navmap->new();
13783: }
1.1021 raeburn 13784: if (ref($dirlistref) eq 'ARRAY') {
13785: foreach my $line (@{$dirlistref}) {
13786: my ($file_name,$rest)=split(/\&/,$line,2);
13787: if ($file_name eq $fname){
13788: $file_name = $path.$file_name;
13789: if ($group ne '') {
13790: $file_name = $group.$file_name;
13791: }
13792: $found_file = 1;
13793: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13794: foreach my $lock (@lockers) {
13795: if (ref($lock) eq 'ARRAY') {
13796: my ($symb,$crsid) = @{$lock};
13797: if ($crsid eq $env{'request.course.id'}) {
13798: if (ref($navmap)) {
13799: my $res = $navmap->getBySymb($symb);
13800: foreach my $part (@{$res->parts()}) {
13801: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13802: unless (($slot_status == $res->RESERVED) ||
13803: ($slot_status == $res->RESERVED_LOCATION)) {
13804: $locked_file = 1;
13805: }
1.991 raeburn 13806: }
1.1021 raeburn 13807: } else {
13808: $locked_file = 1;
1.991 raeburn 13809: }
13810: } else {
13811: $locked_file = 1;
13812: }
13813: }
1.1021 raeburn 13814: }
13815: } else {
13816: my @info = split(/\&/,$rest);
13817: my $currsize = $info[6]/1000;
13818: if ($currsize < $filesize) {
13819: my $extra = $filesize - $currsize;
13820: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13821: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13822: &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 13823: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13824: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13825: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13826: return ('will_exceed_quota',$msg);
13827: }
1.984 raeburn 13828: }
13829: }
1.661 raeburn 13830: }
13831: }
13832: }
13833: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13834: my $msg = '<p class="LC_warning">'.
13835: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13836: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13837: return ('will_exceed_quota',$msg);
13838: } elsif ($found_file) {
13839: if ($locked_file) {
1.1179 bisitz 13840: my $msg = '<p class="LC_warning">';
1.661 raeburn 13841: $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 13842: $msg .= '</p>';
1.661 raeburn 13843: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13844: return ('file_locked',$msg);
13845: } else {
1.1179 bisitz 13846: my $msg = '<p class="LC_error">';
1.984 raeburn 13847: $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 13848: $msg .= '</p>';
1.984 raeburn 13849: return ('existingfile',$msg);
1.661 raeburn 13850: }
13851: }
13852: }
13853:
1.987 raeburn 13854: sub check_for_traversal {
13855: my ($path,$url,$toplevel) = @_;
13856: my @parts=split(/\//,$path);
13857: my $cleanpath;
13858: my $fullpath = $url;
13859: for (my $i=0;$i<@parts;$i++) {
13860: next if ($parts[$i] eq '.');
13861: if ($parts[$i] eq '..') {
13862: $fullpath =~ s{([^/]+/)$}{};
13863: } else {
13864: $fullpath .= $parts[$i].'/';
13865: }
13866: }
13867: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13868: $cleanpath = $1;
13869: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13870: my $curr_toprel = $1;
13871: my @parts = split(/\//,$curr_toprel);
13872: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13873: my @urlparts = split(/\//,$url_toprel);
13874: my $doubledots;
13875: my $startdiff = -1;
13876: for (my $i=0; $i<@urlparts; $i++) {
13877: if ($startdiff == -1) {
13878: unless ($urlparts[$i] eq $parts[$i]) {
13879: $startdiff = $i;
13880: $doubledots .= '../';
13881: }
13882: } else {
13883: $doubledots .= '../';
13884: }
13885: }
13886: if ($startdiff > -1) {
13887: $cleanpath = $doubledots;
13888: for (my $i=$startdiff; $i<@parts; $i++) {
13889: $cleanpath .= $parts[$i].'/';
13890: }
13891: }
13892: }
13893: $cleanpath =~ s{(/)$}{};
13894: return $cleanpath;
13895: }
1.31 albertel 13896:
1.1053 raeburn 13897: sub is_archive_file {
13898: my ($mimetype) = @_;
13899: if (($mimetype eq 'application/octet-stream') ||
13900: ($mimetype eq 'application/x-stuffit') ||
13901: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13902: return 1;
13903: }
13904: return;
13905: }
13906:
13907: sub decompress_form {
1.1065 raeburn 13908: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13909: my %lt = &Apache::lonlocal::texthash (
13910: this => 'This file is an archive file.',
1.1067 raeburn 13911: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13912: itsc => 'Its contents are as follows:',
1.1053 raeburn 13913: youm => 'You may wish to extract its contents.',
13914: extr => 'Extract contents',
1.1067 raeburn 13915: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13916: proa => 'Process automatically?',
1.1053 raeburn 13917: yes => 'Yes',
13918: no => 'No',
1.1067 raeburn 13919: fold => 'Title for folder containing movie',
13920: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13921: );
1.1065 raeburn 13922: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13923: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13924: my $info = &list_archive_contents($fileloc,\@paths);
13925: if (@paths) {
13926: foreach my $path (@paths) {
13927: $path =~ s{^/}{};
1.1067 raeburn 13928: if ($path =~ m{^([^/]+)/$}) {
13929: $topdir = $1;
13930: }
1.1065 raeburn 13931: if ($path =~ m{^([^/]+)/}) {
13932: $toplevel{$1} = $path;
13933: } else {
13934: $toplevel{$path} = $path;
13935: }
13936: }
13937: }
1.1067 raeburn 13938: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13939: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13940: "$topdir/media/",
13941: "$topdir/media/$topdir.mp4",
13942: "$topdir/media/FirstFrame.png",
13943: "$topdir/media/player.swf",
13944: "$topdir/media/swfobject.js",
13945: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13946: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13947: "$topdir/$topdir.mp4",
13948: "$topdir/$topdir\_config.xml",
13949: "$topdir/$topdir\_controller.swf",
13950: "$topdir/$topdir\_embed.css",
13951: "$topdir/$topdir\_First_Frame.png",
13952: "$topdir/$topdir\_player.html",
13953: "$topdir/$topdir\_Thumbnails.png",
13954: "$topdir/playerProductInstall.swf",
13955: "$topdir/scripts/",
13956: "$topdir/scripts/config_xml.js",
13957: "$topdir/scripts/handlebars.js",
13958: "$topdir/scripts/jquery-1.7.1.min.js",
13959: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13960: "$topdir/scripts/modernizr.js",
13961: "$topdir/scripts/player-min.js",
13962: "$topdir/scripts/swfobject.js",
13963: "$topdir/skins/",
13964: "$topdir/skins/configuration_express.xml",
13965: "$topdir/skins/express_show/",
13966: "$topdir/skins/express_show/player-min.css",
13967: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13968: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13969: "$topdir/$topdir.mp4",
13970: "$topdir/$topdir\_config.xml",
13971: "$topdir/$topdir\_controller.swf",
13972: "$topdir/$topdir\_embed.css",
13973: "$topdir/$topdir\_First_Frame.png",
13974: "$topdir/$topdir\_player.html",
13975: "$topdir/$topdir\_Thumbnails.png",
13976: "$topdir/playerProductInstall.swf",
13977: "$topdir/scripts/",
13978: "$topdir/scripts/config_xml.js",
13979: "$topdir/scripts/techsmith-smart-player.min.js",
13980: "$topdir/skins/",
13981: "$topdir/skins/configuration_express.xml",
13982: "$topdir/skins/express_show/",
13983: "$topdir/skins/express_show/spritesheet.min.css",
13984: "$topdir/skins/express_show/spritesheet.png",
13985: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13986: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13987: if (@diffs == 0) {
1.1164 raeburn 13988: $is_camtasia = 6;
13989: } else {
1.1197 raeburn 13990: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13991: if (@diffs == 0) {
13992: $is_camtasia = 8;
1.1197 raeburn 13993: } else {
13994: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13995: if (@diffs == 0) {
13996: $is_camtasia = 8;
13997: }
1.1164 raeburn 13998: }
1.1067 raeburn 13999: }
14000: }
14001: my $output;
14002: if ($is_camtasia) {
14003: $output = <<"ENDCAM";
14004: <script type="text/javascript" language="Javascript">
14005: // <![CDATA[
14006:
14007: function camtasiaToggle() {
14008: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14009: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14010: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14011: document.getElementById('camtasia_titles').style.display='block';
14012: } else {
14013: document.getElementById('camtasia_titles').style.display='none';
14014: }
14015: }
14016: }
14017: return;
14018: }
14019:
14020: // ]]>
14021: </script>
14022: <p>$lt{'camt'}</p>
14023: ENDCAM
1.1065 raeburn 14024: } else {
1.1067 raeburn 14025: $output = '<p>'.$lt{'this'};
14026: if ($info eq '') {
14027: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14028: } else {
14029: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14030: '<div><pre>'.$info.'</pre></div>';
14031: }
1.1065 raeburn 14032: }
1.1067 raeburn 14033: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14034: my $duplicates;
14035: my $num = 0;
14036: if (ref($dirlist) eq 'ARRAY') {
14037: foreach my $item (@{$dirlist}) {
14038: if (ref($item) eq 'ARRAY') {
14039: if (exists($toplevel{$item->[0]})) {
14040: $duplicates .=
14041: &start_data_table_row().
14042: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14043: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14044: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14045: 'value="1" />'.&mt('Yes').'</label>'.
14046: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14047: '<td>'.$item->[0].'</td>';
14048: if ($item->[2]) {
14049: $duplicates .= '<td>'.&mt('Directory').'</td>';
14050: } else {
14051: $duplicates .= '<td>'.&mt('File').'</td>';
14052: }
14053: $duplicates .= '<td>'.$item->[3].'</td>'.
14054: '<td>'.
14055: &Apache::lonlocal::locallocaltime($item->[4]).
14056: '</td>'.
14057: &end_data_table_row();
14058: $num ++;
14059: }
14060: }
14061: }
14062: }
14063: my $itemcount;
14064: if (@paths > 0) {
14065: $itemcount = scalar(@paths);
14066: } else {
14067: $itemcount = 1;
14068: }
1.1067 raeburn 14069: if ($is_camtasia) {
14070: $output .= $lt{'auto'}.'<br />'.
14071: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14072: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14073: $lt{'yes'}.'</label> <label>'.
14074: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14075: $lt{'no'}.'</label></span><br />'.
14076: '<div id="camtasia_titles" style="display:block">'.
14077: &Apache::lonhtmlcommon::start_pick_box().
14078: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14079: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14080: &Apache::lonhtmlcommon::row_closure().
14081: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14082: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14083: &Apache::lonhtmlcommon::row_closure(1).
14084: &Apache::lonhtmlcommon::end_pick_box().
14085: '</div>';
14086: }
1.1065 raeburn 14087: $output .=
14088: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14089: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14090: "\n";
1.1065 raeburn 14091: if ($duplicates ne '') {
14092: $output .= '<p><span class="LC_warning">'.
14093: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14094: &start_data_table().
14095: &start_data_table_header_row().
14096: '<th>'.&mt('Overwrite?').'</th>'.
14097: '<th>'.&mt('Name').'</th>'.
14098: '<th>'.&mt('Type').'</th>'.
14099: '<th>'.&mt('Size').'</th>'.
14100: '<th>'.&mt('Last modified').'</th>'.
14101: &end_data_table_header_row().
14102: $duplicates.
14103: &end_data_table().
14104: '</p>';
14105: }
1.1067 raeburn 14106: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14107: if (ref($hiddenelements) eq 'HASH') {
14108: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14109: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14110: }
14111: }
14112: $output .= <<"END";
1.1067 raeburn 14113: <br />
1.1053 raeburn 14114: <input type="submit" name="decompress" value="$lt{'extr'}" />
14115: </form>
14116: $noextract
14117: END
14118: return $output;
14119: }
14120:
1.1065 raeburn 14121: sub decompression_utility {
14122: my ($program) = @_;
14123: my @utilities = ('tar','gunzip','bunzip2','unzip');
14124: my $location;
14125: if (grep(/^\Q$program\E$/,@utilities)) {
14126: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14127: '/usr/sbin/') {
14128: if (-x $dir.$program) {
14129: $location = $dir.$program;
14130: last;
14131: }
14132: }
14133: }
14134: return $location;
14135: }
14136:
14137: sub list_archive_contents {
14138: my ($file,$pathsref) = @_;
14139: my (@cmd,$output);
14140: my $needsregexp;
14141: if ($file =~ /\.zip$/) {
14142: @cmd = (&decompression_utility('unzip'),"-l");
14143: $needsregexp = 1;
14144: } elsif (($file =~ m/\.tar\.gz$/) ||
14145: ($file =~ /\.tgz$/)) {
14146: @cmd = (&decompression_utility('tar'),"-ztf");
14147: } elsif ($file =~ /\.tar\.bz2$/) {
14148: @cmd = (&decompression_utility('tar'),"-jtf");
14149: } elsif ($file =~ m|\.tar$|) {
14150: @cmd = (&decompression_utility('tar'),"-tf");
14151: }
14152: if (@cmd) {
14153: undef($!);
14154: undef($@);
14155: if (open(my $fh,"-|", @cmd, $file)) {
14156: while (my $line = <$fh>) {
14157: $output .= $line;
14158: chomp($line);
14159: my $item;
14160: if ($needsregexp) {
14161: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14162: } else {
14163: $item = $line;
14164: }
14165: if ($item ne '') {
14166: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14167: push(@{$pathsref},$item);
14168: }
14169: }
14170: }
14171: close($fh);
14172: }
14173: }
14174: return $output;
14175: }
14176:
1.1053 raeburn 14177: sub decompress_uploaded_file {
14178: my ($file,$dir) = @_;
14179: &Apache::lonnet::appenv({'cgi.file' => $file});
14180: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14181: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14182: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14183: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14184: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14185: my $decompressed = $env{'cgi.decompressed'};
14186: &Apache::lonnet::delenv('cgi.file');
14187: &Apache::lonnet::delenv('cgi.dir');
14188: &Apache::lonnet::delenv('cgi.decompressed');
14189: return ($decompressed,$result);
14190: }
14191:
1.1055 raeburn 14192: sub process_decompression {
14193: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14194: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14195: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14196: &mt('Unexpected file path.').'</p>'."\n";
14197: }
14198: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14199: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14200: &mt('Unexpected course context.').'</p>'."\n";
14201: }
1.1293 raeburn 14202: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14203: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14204: &mt('Filename contained unexpected characters.').'</p>'."\n";
14205: }
1.1055 raeburn 14206: my ($dir,$error,$warning,$output);
1.1180 raeburn 14207: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14208: $error = &mt('Filename not a supported archive file type.').
14209: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14210: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14211: } else {
14212: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14213: if ($docuhome eq 'no_host') {
14214: $error = &mt('Could not determine home server for course.');
14215: } else {
14216: my @ids=&Apache::lonnet::current_machine_ids();
14217: my $currdir = "$dir_root/$destination";
14218: if (grep(/^\Q$docuhome\E$/,@ids)) {
14219: $dir = &LONCAPA::propath($docudom,$docuname).
14220: "$dir_root/$destination";
14221: } else {
14222: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14223: "$dir_root/$docudom/$docuname/$destination";
14224: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14225: $error = &mt('Archive file not found.');
14226: }
14227: }
1.1065 raeburn 14228: my (@to_overwrite,@to_skip);
14229: if ($env{'form.archive_overwrite_total'} > 0) {
14230: my $total = $env{'form.archive_overwrite_total'};
14231: for (my $i=0; $i<$total; $i++) {
14232: if ($env{'form.archive_overwrite_'.$i} == 1) {
14233: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14234: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14235: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14236: }
14237: }
14238: }
14239: my $numskip = scalar(@to_skip);
1.1292 raeburn 14240: my $numoverwrite = scalar(@to_overwrite);
14241: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14242: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14243: } elsif ($dir eq '') {
1.1055 raeburn 14244: $error = &mt('Directory containing archive file unavailable.');
14245: } elsif (!$error) {
1.1065 raeburn 14246: my ($decompressed,$display);
1.1292 raeburn 14247: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14248: my $tempdir = time.'_'.$$.int(rand(10000));
14249: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14250: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14251: ($decompressed,$display) =
14252: &decompress_uploaded_file($file,"$dir/$tempdir");
14253: foreach my $item (@to_skip) {
14254: if (($item ne '') && ($item !~ /\.\./)) {
14255: if (-f "$dir/$tempdir/$item") {
14256: unlink("$dir/$tempdir/$item");
14257: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14258: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14259: }
14260: }
14261: }
14262: foreach my $item (@to_overwrite) {
14263: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14264: if (($item ne '') && ($item !~ /\.\./)) {
14265: if (-f "$dir/$item") {
14266: unlink("$dir/$item");
14267: } elsif (-d "$dir/$item") {
1.1300 raeburn 14268: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14269: }
14270: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14271: }
1.1065 raeburn 14272: }
14273: }
1.1292 raeburn 14274: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14275: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14276: }
1.1065 raeburn 14277: }
14278: } else {
14279: ($decompressed,$display) =
14280: &decompress_uploaded_file($file,$dir);
14281: }
1.1055 raeburn 14282: if ($decompressed eq 'ok') {
1.1065 raeburn 14283: $output = '<p class="LC_info">'.
14284: &mt('Files extracted successfully from archive.').
14285: '</p>'."\n";
1.1055 raeburn 14286: my ($warning,$result,@contents);
14287: my ($newdirlistref,$newlisterror) =
14288: &Apache::lonnet::dirlist($currdir,$docudom,
14289: $docuname,1);
14290: my (%is_dir,%changes,@newitems);
14291: my $dirptr = 16384;
1.1065 raeburn 14292: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14293: foreach my $dir_line (@{$newdirlistref}) {
14294: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14295: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14296: push(@newitems,$item);
14297: if ($dirptr&$testdir) {
14298: $is_dir{$item} = 1;
14299: }
14300: $changes{$item} = 1;
14301: }
14302: }
14303: }
14304: if (keys(%changes) > 0) {
14305: foreach my $item (sort(@newitems)) {
14306: if ($changes{$item}) {
14307: push(@contents,$item);
14308: }
14309: }
14310: }
14311: if (@contents > 0) {
1.1067 raeburn 14312: my $wantform;
14313: unless ($env{'form.autoextract_camtasia'}) {
14314: $wantform = 1;
14315: }
1.1056 raeburn 14316: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14317: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14318: $currdir,\%is_dir,
14319: \%children,\%parent,
1.1056 raeburn 14320: \@contents,\%dirorder,
14321: \%titles,$wantform);
1.1055 raeburn 14322: if ($datatable ne '') {
14323: $output .= &archive_options_form('decompressed',$datatable,
14324: $count,$hiddenelem);
1.1065 raeburn 14325: my $startcount = 6;
1.1055 raeburn 14326: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14327: \%titles,\%children);
1.1055 raeburn 14328: }
1.1067 raeburn 14329: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14330: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14331: my %displayed;
14332: my $total = 1;
14333: $env{'form.archive_directory'} = [];
14334: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14335: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14336: $path =~ s{/$}{};
14337: my $item;
14338: if ($path ne '') {
14339: $item = "$path/$titles{$i}";
14340: } else {
14341: $item = $titles{$i};
14342: }
14343: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14344: if ($item eq $contents[0]) {
14345: push(@{$env{'form.archive_directory'}},$i);
14346: $env{'form.archive_'.$i} = 'display';
14347: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14348: $displayed{'folder'} = $i;
1.1164 raeburn 14349: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14350: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14351: $env{'form.archive_'.$i} = 'display';
14352: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14353: $displayed{'web'} = $i;
14354: } else {
1.1164 raeburn 14355: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14356: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14357: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14358: push(@{$env{'form.archive_directory'}},$i);
14359: }
14360: $env{'form.archive_'.$i} = 'dependency';
14361: }
14362: $total ++;
14363: }
14364: for (my $i=1; $i<$total; $i++) {
14365: next if ($i == $displayed{'web'});
14366: next if ($i == $displayed{'folder'});
14367: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14368: }
14369: $env{'form.phase'} = 'decompress_cleanup';
14370: $env{'form.archivedelete'} = 1;
14371: $env{'form.archive_count'} = $total-1;
14372: $output .=
14373: &process_extracted_files('coursedocs',$docudom,
14374: $docuname,$destination,
14375: $dir_root,$hiddenelem);
14376: }
1.1055 raeburn 14377: } else {
14378: $warning = &mt('No new items extracted from archive file.');
14379: }
14380: } else {
14381: $output = $display;
14382: $error = &mt('An error occurred during extraction from the archive file.');
14383: }
14384: }
14385: }
14386: }
14387: if ($error) {
14388: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14389: $error.'</p>'."\n";
14390: }
14391: if ($warning) {
14392: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14393: }
14394: return $output;
14395: }
14396:
14397: sub get_extracted {
1.1056 raeburn 14398: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14399: $titles,$wantform) = @_;
1.1055 raeburn 14400: my $count = 0;
14401: my $depth = 0;
14402: my $datatable;
1.1056 raeburn 14403: my @hierarchy;
1.1055 raeburn 14404: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14405: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14406: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14407: foreach my $item (@{$contents}) {
14408: $count ++;
1.1056 raeburn 14409: @{$dirorder->{$count}} = @hierarchy;
14410: $titles->{$count} = $item;
1.1055 raeburn 14411: &archive_hierarchy($depth,$count,$parent,$children);
14412: if ($wantform) {
14413: $datatable .= &archive_row($is_dir->{$item},$item,
14414: $currdir,$depth,$count);
14415: }
14416: if ($is_dir->{$item}) {
14417: $depth ++;
1.1056 raeburn 14418: push(@hierarchy,$count);
14419: $parent->{$depth} = $count;
1.1055 raeburn 14420: $datatable .=
14421: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14422: \$depth,\$count,\@hierarchy,$dirorder,
14423: $children,$parent,$titles,$wantform);
1.1055 raeburn 14424: $depth --;
1.1056 raeburn 14425: pop(@hierarchy);
1.1055 raeburn 14426: }
14427: }
14428: return ($count,$datatable);
14429: }
14430:
14431: sub recurse_extracted_archive {
1.1056 raeburn 14432: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14433: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14434: my $result='';
1.1056 raeburn 14435: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14436: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14437: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14438: return $result;
14439: }
14440: my $dirptr = 16384;
14441: my ($newdirlistref,$newlisterror) =
14442: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14443: if (ref($newdirlistref) eq 'ARRAY') {
14444: foreach my $dir_line (@{$newdirlistref}) {
14445: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14446: unless ($item =~ /^\.+$/) {
14447: $$count ++;
1.1056 raeburn 14448: @{$dirorder->{$$count}} = @{$hierarchy};
14449: $titles->{$$count} = $item;
1.1055 raeburn 14450: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14451:
1.1055 raeburn 14452: my $is_dir;
14453: if ($dirptr&$testdir) {
14454: $is_dir = 1;
14455: }
14456: if ($wantform) {
14457: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14458: }
14459: if ($is_dir) {
14460: $$depth ++;
1.1056 raeburn 14461: push(@{$hierarchy},$$count);
14462: $parent->{$$depth} = $$count;
1.1055 raeburn 14463: $result .=
14464: &recurse_extracted_archive("$currdir/$item",$docudom,
14465: $docuname,$depth,$count,
1.1056 raeburn 14466: $hierarchy,$dirorder,$children,
14467: $parent,$titles,$wantform);
1.1055 raeburn 14468: $$depth --;
1.1056 raeburn 14469: pop(@{$hierarchy});
1.1055 raeburn 14470: }
14471: }
14472: }
14473: }
14474: return $result;
14475: }
14476:
14477: sub archive_hierarchy {
14478: my ($depth,$count,$parent,$children) =@_;
14479: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14480: if (exists($parent->{$depth})) {
14481: $children->{$parent->{$depth}} .= $count.':';
14482: }
14483: }
14484: return;
14485: }
14486:
14487: sub archive_row {
14488: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14489: my ($name) = ($item =~ m{([^/]+)$});
14490: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14491: 'display' => 'Add as file',
1.1055 raeburn 14492: 'dependency' => 'Include as dependency',
14493: 'discard' => 'Discard',
14494: );
14495: if ($is_dir) {
1.1059 raeburn 14496: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14497: }
1.1056 raeburn 14498: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14499: my $offset = 0;
1.1055 raeburn 14500: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14501: $offset ++;
1.1065 raeburn 14502: if ($action ne 'display') {
14503: $offset ++;
14504: }
1.1055 raeburn 14505: $output .= '<td><span class="LC_nobreak">'.
14506: '<label><input type="radio" name="archive_'.$count.
14507: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14508: my $text = $choices{$action};
14509: if ($is_dir) {
14510: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14511: if ($action eq 'display') {
1.1059 raeburn 14512: $text = &mt('Add as folder');
1.1055 raeburn 14513: }
1.1056 raeburn 14514: } else {
14515: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14516:
14517: }
14518: $output .= ' /> '.$choices{$action}.'</label></span>';
14519: if ($action eq 'dependency') {
14520: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14521: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14522: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14523: '<option value=""></option>'."\n".
14524: '</select>'."\n".
14525: '</div>';
1.1059 raeburn 14526: } elsif ($action eq 'display') {
14527: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14528: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14529: '</div>';
1.1055 raeburn 14530: }
1.1056 raeburn 14531: $output .= '</td>';
1.1055 raeburn 14532: }
14533: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14534: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14535: for (my $i=0; $i<$depth; $i++) {
14536: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14537: }
14538: if ($is_dir) {
14539: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14540: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14541: } else {
14542: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14543: }
14544: $output .= ' '.$name.'</td>'."\n".
14545: &end_data_table_row();
14546: return $output;
14547: }
14548:
14549: sub archive_options_form {
1.1065 raeburn 14550: my ($form,$display,$count,$hiddenelem) = @_;
14551: my %lt = &Apache::lonlocal::texthash(
14552: perm => 'Permanently remove archive file?',
14553: hows => 'How should each extracted item be incorporated in the course?',
14554: cont => 'Content actions for all',
14555: addf => 'Add as folder/file',
14556: incd => 'Include as dependency for a displayed file',
14557: disc => 'Discard',
14558: no => 'No',
14559: yes => 'Yes',
14560: save => 'Save',
14561: );
14562: my $output = <<"END";
14563: <form name="$form" method="post" action="">
14564: <p><span class="LC_nobreak">$lt{'perm'}
14565: <label>
14566: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14567: </label>
14568:
14569: <label>
14570: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14571: </span>
14572: </p>
14573: <input type="hidden" name="phase" value="decompress_cleanup" />
14574: <br />$lt{'hows'}
14575: <div class="LC_columnSection">
14576: <fieldset>
14577: <legend>$lt{'cont'}</legend>
14578: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14579: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14580: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14581: </fieldset>
14582: </div>
14583: END
14584: return $output.
1.1055 raeburn 14585: &start_data_table()."\n".
1.1065 raeburn 14586: $display."\n".
1.1055 raeburn 14587: &end_data_table()."\n".
14588: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14589: $hiddenelem.
1.1065 raeburn 14590: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14591: '</form>';
14592: }
14593:
14594: sub archive_javascript {
1.1056 raeburn 14595: my ($startcount,$numitems,$titles,$children) = @_;
14596: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14597: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14598: my $scripttag = <<START;
14599: <script type="text/javascript">
14600: // <![CDATA[
14601:
14602: function checkAll(form,prefix) {
14603: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14604: for (var i=0; i < form.elements.length; i++) {
14605: var id = form.elements[i].id;
14606: if ((id != '') && (id != undefined)) {
14607: if (idstr.test(id)) {
14608: if (form.elements[i].type == 'radio') {
14609: form.elements[i].checked = true;
1.1056 raeburn 14610: var nostart = i-$startcount;
1.1059 raeburn 14611: var offset = nostart%7;
14612: var count = (nostart-offset)/7;
1.1056 raeburn 14613: dependencyCheck(form,count,offset);
1.1055 raeburn 14614: }
14615: }
14616: }
14617: }
14618: }
14619:
14620: function propagateCheck(form,count) {
14621: if (count > 0) {
1.1059 raeburn 14622: var startelement = $startcount + ((count-1) * 7);
14623: for (var j=1; j<6; j++) {
14624: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14625: var item = startelement + j;
14626: if (form.elements[item].type == 'radio') {
14627: if (form.elements[item].checked) {
14628: containerCheck(form,count,j);
14629: break;
14630: }
1.1055 raeburn 14631: }
14632: }
14633: }
14634: }
14635: }
14636:
14637: numitems = $numitems
1.1056 raeburn 14638: var titles = new Array(numitems);
14639: var parents = new Array(numitems);
1.1055 raeburn 14640: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14641: parents[i] = new Array;
1.1055 raeburn 14642: }
1.1059 raeburn 14643: var maintitle = '$maintitle';
1.1055 raeburn 14644:
14645: START
14646:
1.1056 raeburn 14647: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14648: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14649: for (my $i=0; $i<@contents; $i ++) {
14650: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14651: }
14652: }
14653:
1.1056 raeburn 14654: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14655: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14656: }
14657:
1.1055 raeburn 14658: $scripttag .= <<END;
14659:
14660: function containerCheck(form,count,offset) {
14661: if (count > 0) {
1.1056 raeburn 14662: dependencyCheck(form,count,offset);
1.1059 raeburn 14663: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14664: form.elements[item].checked = true;
14665: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14666: if (parents[count].length > 0) {
14667: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14668: containerCheck(form,parents[count][j],offset);
14669: }
14670: }
14671: }
14672: }
14673: }
14674:
14675: function dependencyCheck(form,count,offset) {
14676: if (count > 0) {
1.1059 raeburn 14677: var chosen = (offset+$startcount)+7*(count-1);
14678: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14679: var currtype = form.elements[depitem].type;
14680: if (form.elements[chosen].value == 'dependency') {
14681: document.getElementById('arc_depon_'+count).style.display='block';
14682: form.elements[depitem].options.length = 0;
14683: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14684: for (var i=1; i<=numitems; i++) {
14685: if (i == count) {
14686: continue;
14687: }
1.1059 raeburn 14688: var startelement = $startcount + (i-1) * 7;
14689: for (var j=1; j<6; j++) {
14690: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14691: var item = startelement + j;
14692: if (form.elements[item].type == 'radio') {
14693: if (form.elements[item].checked) {
14694: if (form.elements[item].value == 'display') {
14695: var n = form.elements[depitem].options.length;
14696: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14697: }
14698: }
14699: }
14700: }
14701: }
14702: }
14703: } else {
14704: document.getElementById('arc_depon_'+count).style.display='none';
14705: form.elements[depitem].options.length = 0;
14706: form.elements[depitem].options[0] = new Option('Select','',true,true);
14707: }
1.1059 raeburn 14708: titleCheck(form,count,offset);
1.1056 raeburn 14709: }
14710: }
14711:
14712: function propagateSelect(form,count,offset) {
14713: if (count > 0) {
1.1065 raeburn 14714: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14715: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14716: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14717: if (parents[count].length > 0) {
14718: for (var j=0; j<parents[count].length; j++) {
14719: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14720: }
14721: }
14722: }
14723: }
14724: }
1.1056 raeburn 14725:
14726: function containerSelect(form,count,offset,picked) {
14727: if (count > 0) {
1.1065 raeburn 14728: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14729: if (form.elements[item].type == 'radio') {
14730: if (form.elements[item].value == 'dependency') {
14731: if (form.elements[item+1].type == 'select-one') {
14732: for (var i=0; i<form.elements[item+1].options.length; i++) {
14733: if (form.elements[item+1].options[i].value == picked) {
14734: form.elements[item+1].selectedIndex = i;
14735: break;
14736: }
14737: }
14738: }
14739: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14740: if (parents[count].length > 0) {
14741: for (var j=0; j<parents[count].length; j++) {
14742: containerSelect(form,parents[count][j],offset,picked);
14743: }
14744: }
14745: }
14746: }
14747: }
14748: }
14749: }
14750:
1.1059 raeburn 14751: function titleCheck(form,count,offset) {
14752: if (count > 0) {
14753: var chosen = (offset+$startcount)+7*(count-1);
14754: var depitem = $startcount + ((count-1) * 7) + 2;
14755: var currtype = form.elements[depitem].type;
14756: if (form.elements[chosen].value == 'display') {
14757: document.getElementById('arc_title_'+count).style.display='block';
14758: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14759: document.getElementById('archive_title_'+count).value=maintitle;
14760: }
14761: } else {
14762: document.getElementById('arc_title_'+count).style.display='none';
14763: if (currtype == 'text') {
14764: document.getElementById('archive_title_'+count).value='';
14765: }
14766: }
14767: }
14768: return;
14769: }
14770:
1.1055 raeburn 14771: // ]]>
14772: </script>
14773: END
14774: return $scripttag;
14775: }
14776:
14777: sub process_extracted_files {
1.1067 raeburn 14778: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14779: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14780: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14781: my @ids=&Apache::lonnet::current_machine_ids();
14782: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14783: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14784: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14785: if (grep(/^\Q$docuhome\E$/,@ids)) {
14786: $prefix = &LONCAPA::propath($docudom,$docuname);
14787: $pathtocheck = "$dir_root/$destination";
14788: $dir = $dir_root;
14789: $ishome = 1;
14790: } else {
14791: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14792: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14793: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14794: }
14795: my $currdir = "$dir_root/$destination";
14796: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14797: if ($env{'form.folderpath'}) {
14798: my @items = split('&',$env{'form.folderpath'});
14799: $folders{'0'} = $items[-2];
1.1099 raeburn 14800: if ($env{'form.folderpath'} =~ /\:1$/) {
14801: $containers{'0'}='page';
14802: } else {
14803: $containers{'0'}='sequence';
14804: }
1.1055 raeburn 14805: }
14806: my @archdirs = &get_env_multiple('form.archive_directory');
14807: if ($numitems) {
14808: for (my $i=1; $i<=$numitems; $i++) {
14809: my $path = $env{'form.archive_content_'.$i};
14810: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14811: my $item = $1;
14812: $toplevelitems{$item} = $i;
14813: if (grep(/^\Q$i\E$/,@archdirs)) {
14814: $is_dir{$item} = 1;
14815: }
14816: }
14817: }
14818: }
1.1067 raeburn 14819: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14820: if (keys(%toplevelitems) > 0) {
14821: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14822: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14823: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14824: }
1.1066 raeburn 14825: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14826: if ($numitems) {
14827: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14828: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14829: my $path = $env{'form.archive_content_'.$i};
14830: if ($path =~ /^\Q$pathtocheck\E/) {
14831: if ($env{'form.archive_'.$i} eq 'discard') {
14832: if ($prefix ne '' && $path ne '') {
14833: if (-e $prefix.$path) {
1.1066 raeburn 14834: if ((@archdirs > 0) &&
14835: (grep(/^\Q$i\E$/,@archdirs))) {
14836: $todeletedir{$prefix.$path} = 1;
14837: } else {
14838: $todelete{$prefix.$path} = 1;
14839: }
1.1055 raeburn 14840: }
14841: }
14842: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14843: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14844: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14845: $docstitle = $env{'form.archive_title_'.$i};
14846: if ($docstitle eq '') {
14847: $docstitle = $title;
14848: }
1.1055 raeburn 14849: $outer = 0;
1.1056 raeburn 14850: if (ref($dirorder{$i}) eq 'ARRAY') {
14851: if (@{$dirorder{$i}} > 0) {
14852: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14853: if ($env{'form.archive_'.$item} eq 'display') {
14854: $outer = $item;
14855: last;
14856: }
14857: }
14858: }
14859: }
14860: my ($errtext,$fatal) =
14861: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14862: '/'.$folders{$outer}.'.'.
14863: $containers{$outer});
14864: next if ($fatal);
14865: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14866: if ($context eq 'coursedocs') {
1.1056 raeburn 14867: $mapinner{$i} = time;
1.1055 raeburn 14868: $folders{$i} = 'default_'.$mapinner{$i};
14869: $containers{$i} = 'sequence';
14870: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14871: $folders{$i}.'.'.$containers{$i};
14872: my $newidx = &LONCAPA::map::getresidx();
14873: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14874: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14875: push(@LONCAPA::map::order,$newidx);
14876: my ($outtext,$errtext) =
14877: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14878: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14879: '.'.$containers{$outer},1,1);
1.1056 raeburn 14880: $newseqid{$i} = $newidx;
1.1067 raeburn 14881: unless ($errtext) {
1.1294 raeburn 14882: $result .= '<li>'.&mt('Folder: [_1] added to course',
14883: &HTML::Entities::encode($docstitle,'<>&"')).
14884: '</li>'."\n";
1.1067 raeburn 14885: }
1.1055 raeburn 14886: }
14887: } else {
14888: if ($context eq 'coursedocs') {
14889: my $newidx=&LONCAPA::map::getresidx();
14890: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14891: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14892: $title;
1.1392 raeburn 14893: if (($outer !~ /\D/) &&
14894: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14895: ($newidx !~ /\D/)) {
1.1294 raeburn 14896: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14897: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14898: }
14899: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14900: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14901: }
14902: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14903: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14904: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14905: unless ($ishome) {
14906: my $fetch = "$newdest{$i}/$title";
14907: $fetch =~ s/^\Q$prefix$dir\E//;
14908: $prompttofetch{$fetch} = 1;
14909: }
1.1292 raeburn 14910: }
1.1067 raeburn 14911: }
1.1294 raeburn 14912: $LONCAPA::map::resources[$newidx]=
14913: $docstitle.':'.$url.':false:normal:res';
14914: push(@LONCAPA::map::order, $newidx);
14915: my ($outtext,$errtext)=
14916: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14917: $docuname.'/'.$folders{$outer}.
14918: '.'.$containers{$outer},1,1);
14919: unless ($errtext) {
14920: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14921: $result .= '<li>'.&mt('File: [_1] added to course',
14922: &HTML::Entities::encode($docstitle,'<>&"')).
14923: '</li>'."\n";
14924: }
1.1067 raeburn 14925: }
1.1294 raeburn 14926: } else {
14927: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14928: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14929: }
1.1055 raeburn 14930: }
14931: }
1.1086 raeburn 14932: }
14933: } else {
1.1294 raeburn 14934: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14935: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14936: }
14937: }
14938: for (my $i=1; $i<=$numitems; $i++) {
14939: next unless ($env{'form.archive_'.$i} eq 'dependency');
14940: my $path = $env{'form.archive_content_'.$i};
14941: if ($path =~ /^\Q$pathtocheck\E/) {
14942: my ($title) = ($path =~ m{/([^/]+)$});
14943: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14944: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14945: if (ref($dirorder{$i}) eq 'ARRAY') {
14946: my ($itemidx,$fullpath,$relpath);
14947: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14948: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14949: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14950: if ($dirorder{$i}->[$j] eq $container) {
14951: $itemidx = $j;
1.1056 raeburn 14952: }
14953: }
1.1086 raeburn 14954: }
14955: if ($itemidx eq '') {
14956: $itemidx = 0;
14957: }
14958: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14959: if ($mapinner{$referrer{$i}}) {
14960: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14961: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14962: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14963: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14964: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14965: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14966: if (!-e $fullpath) {
14967: mkdir($fullpath,0755);
1.1056 raeburn 14968: }
14969: }
1.1086 raeburn 14970: } else {
14971: last;
1.1056 raeburn 14972: }
1.1086 raeburn 14973: }
14974: }
14975: } elsif ($newdest{$referrer{$i}}) {
14976: $fullpath = $newdest{$referrer{$i}};
14977: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14978: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14979: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14980: last;
14981: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14982: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14983: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14984: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14985: if (!-e $fullpath) {
14986: mkdir($fullpath,0755);
1.1056 raeburn 14987: }
14988: }
1.1086 raeburn 14989: } else {
14990: last;
1.1056 raeburn 14991: }
1.1055 raeburn 14992: }
14993: }
1.1086 raeburn 14994: if ($fullpath ne '') {
14995: if (-e "$prefix$path") {
1.1292 raeburn 14996: unless (rename("$prefix$path","$fullpath/$title")) {
14997: $warning .= &mt('Failed to rename dependency').'<br />';
14998: }
1.1086 raeburn 14999: }
15000: if (-e "$fullpath/$title") {
15001: my $showpath;
15002: if ($relpath ne '') {
15003: $showpath = "$relpath/$title";
15004: } else {
15005: $showpath = "/$title";
15006: }
1.1294 raeburn 15007: $result .= '<li>'.&mt('[_1] included as a dependency',
15008: &HTML::Entities::encode($showpath,'<>&"')).
15009: '</li>'."\n";
1.1292 raeburn 15010: unless ($ishome) {
15011: my $fetch = "$fullpath/$title";
15012: $fetch =~ s/^\Q$prefix$dir\E//;
15013: $prompttofetch{$fetch} = 1;
15014: }
1.1086 raeburn 15015: }
15016: }
1.1055 raeburn 15017: }
1.1086 raeburn 15018: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15019: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15020: &HTML::Entities::encode($path,'<>&"'),
15021: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15022: '<br />';
1.1055 raeburn 15023: }
15024: } else {
1.1294 raeburn 15025: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15026: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15027: }
15028: }
15029: if (keys(%todelete)) {
15030: foreach my $key (keys(%todelete)) {
15031: unlink($key);
1.1066 raeburn 15032: }
15033: }
15034: if (keys(%todeletedir)) {
15035: foreach my $key (keys(%todeletedir)) {
15036: rmdir($key);
15037: }
15038: }
15039: foreach my $dir (sort(keys(%is_dir))) {
15040: if (($pathtocheck ne '') && ($dir ne '')) {
15041: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15042: }
15043: }
1.1067 raeburn 15044: if ($result ne '') {
15045: $output .= '<ul>'."\n".
15046: $result."\n".
15047: '</ul>';
15048: }
15049: unless ($ishome) {
15050: my $replicationfail;
15051: foreach my $item (keys(%prompttofetch)) {
15052: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15053: unless ($fetchresult eq 'ok') {
15054: $replicationfail .= '<li>'.$item.'</li>'."\n";
15055: }
15056: }
15057: if ($replicationfail) {
15058: $output .= '<p class="LC_error">'.
15059: &mt('Course home server failed to retrieve:').'<ul>'.
15060: $replicationfail.
15061: '</ul></p>';
15062: }
15063: }
1.1055 raeburn 15064: } else {
15065: $warning = &mt('No items found in archive.');
15066: }
15067: if ($error) {
15068: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15069: $error.'</p>'."\n";
15070: }
15071: if ($warning) {
15072: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15073: }
15074: return $output;
15075: }
15076:
1.1066 raeburn 15077: sub cleanup_empty_dirs {
15078: my ($path) = @_;
15079: if (($path ne '') && (-d $path)) {
15080: if (opendir(my $dirh,$path)) {
15081: my @dircontents = grep(!/^\./,readdir($dirh));
15082: my $numitems = 0;
15083: foreach my $item (@dircontents) {
15084: if (-d "$path/$item") {
1.1111 raeburn 15085: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15086: if (-e "$path/$item") {
15087: $numitems ++;
15088: }
15089: } else {
15090: $numitems ++;
15091: }
15092: }
15093: if ($numitems == 0) {
15094: rmdir($path);
15095: }
15096: closedir($dirh);
15097: }
15098: }
15099: return;
15100: }
15101:
1.41 ng 15102: =pod
1.45 matthew 15103:
1.1162 raeburn 15104: =item * &get_folder_hierarchy()
1.1068 raeburn 15105:
15106: Provides hierarchy of names of folders/sub-folders containing the current
15107: item,
15108:
15109: Inputs: 3
15110: - $navmap - navmaps object
15111:
15112: - $map - url for map (either the trigger itself, or map containing
15113: the resource, which is the trigger).
15114:
15115: - $showitem - 1 => show title for map itself; 0 => do not show.
15116:
15117: Outputs: 1 @pathitems - array of folder/subfolder names.
15118:
15119: =cut
15120:
15121: sub get_folder_hierarchy {
15122: my ($navmap,$map,$showitem) = @_;
15123: my @pathitems;
15124: if (ref($navmap)) {
15125: my $mapres = $navmap->getResourceByUrl($map);
15126: if (ref($mapres)) {
15127: my $pcslist = $mapres->map_hierarchy();
15128: if ($pcslist ne '') {
15129: my @pcs = split(/,/,$pcslist);
15130: foreach my $pc (@pcs) {
15131: if ($pc == 1) {
1.1129 raeburn 15132: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15133: } else {
15134: my $res = $navmap->getByMapPc($pc);
15135: if (ref($res)) {
15136: my $title = $res->compTitle();
15137: $title =~ s/\W+/_/g;
15138: if ($title ne '') {
15139: push(@pathitems,$title);
15140: }
15141: }
15142: }
15143: }
15144: }
1.1071 raeburn 15145: if ($showitem) {
15146: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15147: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15148: } else {
15149: my $maptitle = $mapres->compTitle();
15150: $maptitle =~ s/\W+/_/g;
15151: if ($maptitle ne '') {
15152: push(@pathitems,$maptitle);
15153: }
1.1068 raeburn 15154: }
15155: }
15156: }
15157: }
15158: return @pathitems;
15159: }
15160:
15161: =pod
15162:
1.1015 raeburn 15163: =item * &get_turnedin_filepath()
15164:
15165: Determines path in a user's portfolio file for storage of files uploaded
15166: to a specific essayresponse or dropbox item.
15167:
15168: Inputs: 3 required + 1 optional.
15169: $symb is symb for resource, $uname and $udom are for current user (required).
15170: $caller is optional (can be "submission", if routine is called when storing
15171: an upoaded file when "Submit Answer" button was pressed).
15172:
15173: Returns array containing $path and $multiresp.
15174: $path is path in portfolio. $multiresp is 1 if this resource contains more
15175: than one file upload item. Callers of routine should append partid as a
15176: subdirectory to $path in cases where $multiresp is 1.
15177:
15178: Called by: homework/essayresponse.pm and homework/structuretags.pm
15179:
15180: =cut
15181:
15182: sub get_turnedin_filepath {
15183: my ($symb,$uname,$udom,$caller) = @_;
15184: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15185: my $turnindir;
15186: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15187: $turnindir = $userhash{'turnindir'};
15188: my ($path,$multiresp);
15189: if ($turnindir eq '') {
15190: if ($caller eq 'submission') {
15191: $turnindir = &mt('turned in');
15192: $turnindir =~ s/\W+/_/g;
15193: my %newhash = (
15194: 'turnindir' => $turnindir,
15195: );
15196: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15197: }
15198: }
15199: if ($turnindir ne '') {
15200: $path = '/'.$turnindir.'/';
15201: my ($multipart,$turnin,@pathitems);
15202: my $navmap = Apache::lonnavmaps::navmap->new();
15203: if (defined($navmap)) {
15204: my $mapres = $navmap->getResourceByUrl($map);
15205: if (ref($mapres)) {
15206: my $pcslist = $mapres->map_hierarchy();
15207: if ($pcslist ne '') {
15208: foreach my $pc (split(/,/,$pcslist)) {
15209: my $res = $navmap->getByMapPc($pc);
15210: if (ref($res)) {
15211: my $title = $res->compTitle();
15212: $title =~ s/\W+/_/g;
15213: if ($title ne '') {
1.1149 raeburn 15214: if (($pc > 1) && (length($title) > 12)) {
15215: $title = substr($title,0,12);
15216: }
1.1015 raeburn 15217: push(@pathitems,$title);
15218: }
15219: }
15220: }
15221: }
15222: my $maptitle = $mapres->compTitle();
15223: $maptitle =~ s/\W+/_/g;
15224: if ($maptitle ne '') {
1.1149 raeburn 15225: if (length($maptitle) > 12) {
15226: $maptitle = substr($maptitle,0,12);
15227: }
1.1015 raeburn 15228: push(@pathitems,$maptitle);
15229: }
15230: unless ($env{'request.state'} eq 'construct') {
15231: my $res = $navmap->getBySymb($symb);
15232: if (ref($res)) {
15233: my $partlist = $res->parts();
15234: my $totaluploads = 0;
15235: if (ref($partlist) eq 'ARRAY') {
15236: foreach my $part (@{$partlist}) {
15237: my @types = $res->responseType($part);
15238: my @ids = $res->responseIds($part);
15239: for (my $i=0; $i < scalar(@ids); $i++) {
15240: if ($types[$i] eq 'essay') {
15241: my $partid = $part.'_'.$ids[$i];
15242: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15243: $totaluploads ++;
15244: }
15245: }
15246: }
15247: }
15248: if ($totaluploads > 1) {
15249: $multiresp = 1;
15250: }
15251: }
15252: }
15253: }
15254: } else {
15255: return;
15256: }
15257: } else {
15258: return;
15259: }
15260: my $restitle=&Apache::lonnet::gettitle($symb);
15261: $restitle =~ s/\W+/_/g;
15262: if ($restitle eq '') {
15263: $restitle = ($resurl =~ m{/[^/]+$});
15264: if ($restitle eq '') {
15265: $restitle = time;
15266: }
15267: }
1.1149 raeburn 15268: if (length($restitle) > 12) {
15269: $restitle = substr($restitle,0,12);
15270: }
1.1015 raeburn 15271: push(@pathitems,$restitle);
15272: $path .= join('/',@pathitems);
15273: }
15274: return ($path,$multiresp);
15275: }
15276:
15277: =pod
15278:
1.464 albertel 15279: =back
1.41 ng 15280:
1.112 bowersj2 15281: =head1 CSV Upload/Handling functions
1.38 albertel 15282:
1.41 ng 15283: =over 4
15284:
1.648 raeburn 15285: =item * &upfile_store($r)
1.41 ng 15286:
15287: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15288: needs $env{'form.upfile'}
1.41 ng 15289: returns $datatoken to be put into hidden field
15290:
15291: =cut
1.31 albertel 15292:
15293: sub upfile_store {
15294: my $r=shift;
1.258 albertel 15295: $env{'form.upfile'}=~s/\r/\n/gs;
15296: $env{'form.upfile'}=~s/\f/\n/gs;
15297: $env{'form.upfile'}=~s/\n+/\n/gs;
15298: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15299:
1.1299 raeburn 15300: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15301: '_enroll_'.$env{'request.course.id'}.'_'.
15302: time.'_'.$$);
15303: return if ($datatoken eq '');
15304:
1.31 albertel 15305: {
1.158 raeburn 15306: my $datafile = $r->dir_config('lonDaemons').
15307: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15308: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15309: print $fh $env{'form.upfile'};
1.158 raeburn 15310: close($fh);
15311: }
1.31 albertel 15312: }
15313: return $datatoken;
15314: }
15315:
1.56 matthew 15316: =pod
15317:
1.1290 raeburn 15318: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15319:
15320: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15321: $datatoken is the name to assign to the temporary file.
1.258 albertel 15322: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15323:
15324: =cut
1.31 albertel 15325:
15326: sub load_tmp_file {
1.1290 raeburn 15327: my ($r,$datatoken) = @_;
15328: return if ($datatoken eq '');
1.31 albertel 15329: my @studentdata=();
15330: {
1.158 raeburn 15331: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15332: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15333: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15334: @studentdata=<$fh>;
15335: close($fh);
15336: }
1.31 albertel 15337: }
1.258 albertel 15338: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15339: }
15340:
1.1290 raeburn 15341: sub valid_datatoken {
15342: my ($datatoken) = @_;
1.1325 raeburn 15343: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15344: return $datatoken;
15345: }
15346: return;
15347: }
15348:
1.56 matthew 15349: =pod
15350:
1.648 raeburn 15351: =item * &upfile_record_sep()
1.41 ng 15352:
15353: Separate uploaded file into records
15354: returns array of records,
1.258 albertel 15355: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15356:
15357: =cut
1.31 albertel 15358:
15359: sub upfile_record_sep {
1.258 albertel 15360: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15361: } else {
1.248 albertel 15362: my @records;
1.258 albertel 15363: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15364: if ($line=~/^\s*$/) { next; }
15365: push(@records,$line);
15366: }
15367: return @records;
1.31 albertel 15368: }
15369: }
15370:
1.56 matthew 15371: =pod
15372:
1.648 raeburn 15373: =item * &record_sep($record)
1.41 ng 15374:
1.258 albertel 15375: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15376:
15377: =cut
15378:
1.263 www 15379: sub takeleft {
15380: my $index=shift;
15381: return substr('0000'.$index,-4,4);
15382: }
15383:
1.31 albertel 15384: sub record_sep {
15385: my $record=shift;
15386: my %components=();
1.258 albertel 15387: if ($env{'form.upfiletype'} eq 'xml') {
15388: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15389: my $i=0;
1.356 albertel 15390: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15391: $field=~s/^(\"|\')//;
15392: $field=~s/(\"|\')$//;
1.263 www 15393: $components{&takeleft($i)}=$field;
1.31 albertel 15394: $i++;
15395: }
1.258 albertel 15396: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15397: my $i=0;
1.356 albertel 15398: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15399: $field=~s/^(\"|\')//;
15400: $field=~s/(\"|\')$//;
1.263 www 15401: $components{&takeleft($i)}=$field;
1.31 albertel 15402: $i++;
15403: }
15404: } else {
1.561 www 15405: my $separator=',';
1.480 banghart 15406: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15407: $separator=';';
1.480 banghart 15408: }
1.31 albertel 15409: my $i=0;
1.561 www 15410: # the character we are looking for to indicate the end of a quote or a record
15411: my $looking_for=$separator;
15412: # do not add the characters to the fields
15413: my $ignore=0;
15414: # we just encountered a separator (or the beginning of the record)
15415: my $just_found_separator=1;
15416: # store the field we are working on here
15417: my $field='';
15418: # work our way through all characters in record
15419: foreach my $character ($record=~/(.)/g) {
15420: if ($character eq $looking_for) {
15421: if ($character ne $separator) {
15422: # Found the end of a quote, again looking for separator
15423: $looking_for=$separator;
15424: $ignore=1;
15425: } else {
15426: # Found a separator, store away what we got
15427: $components{&takeleft($i)}=$field;
15428: $i++;
15429: $just_found_separator=1;
15430: $ignore=0;
15431: $field='';
15432: }
15433: next;
15434: }
15435: # single or double quotation marks after a separator indicate beginning of a quote
15436: # we are now looking for the end of the quote and need to ignore separators
15437: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15438: $looking_for=$character;
15439: next;
15440: }
15441: # ignore would be true after we reached the end of a quote
15442: if ($ignore) { next; }
15443: if (($just_found_separator) && ($character=~/\s/)) { next; }
15444: $field.=$character;
15445: $just_found_separator=0;
1.31 albertel 15446: }
1.561 www 15447: # catch the very last entry, since we never encountered the separator
15448: $components{&takeleft($i)}=$field;
1.31 albertel 15449: }
15450: return %components;
15451: }
15452:
1.144 matthew 15453: ######################################################
15454: ######################################################
15455:
1.56 matthew 15456: =pod
15457:
1.648 raeburn 15458: =item * &upfile_select_html()
1.41 ng 15459:
1.144 matthew 15460: Return HTML code to select a file from the users machine and specify
15461: the file type.
1.41 ng 15462:
15463: =cut
15464:
1.144 matthew 15465: ######################################################
15466: ######################################################
1.31 albertel 15467: sub upfile_select_html {
1.144 matthew 15468: my %Types = (
15469: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15470: semisv => &mt('Semicolon separated values'),
1.144 matthew 15471: space => &mt('Space separated'),
15472: tab => &mt('Tabulator separated'),
15473: # xml => &mt('HTML/XML'),
15474: );
15475: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15476: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15477: foreach my $type (sort(keys(%Types))) {
15478: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15479: }
15480: $Str .= "</select>\n";
15481: return $Str;
1.31 albertel 15482: }
15483:
1.301 albertel 15484: sub get_samples {
15485: my ($records,$toget) = @_;
15486: my @samples=({});
15487: my $got=0;
15488: foreach my $rec (@$records) {
15489: my %temp = &record_sep($rec);
15490: if (! grep(/\S/, values(%temp))) { next; }
15491: if (%temp) {
15492: $samples[$got]=\%temp;
15493: $got++;
15494: if ($got == $toget) { last; }
15495: }
15496: }
15497: return \@samples;
15498: }
15499:
1.144 matthew 15500: ######################################################
15501: ######################################################
15502:
1.56 matthew 15503: =pod
15504:
1.648 raeburn 15505: =item * &csv_print_samples($r,$records)
1.41 ng 15506:
15507: Prints a table of sample values from each column uploaded $r is an
15508: Apache Request ref, $records is an arrayref from
15509: &Apache::loncommon::upfile_record_sep
15510:
15511: =cut
15512:
1.144 matthew 15513: ######################################################
15514: ######################################################
1.31 albertel 15515: sub csv_print_samples {
15516: my ($r,$records) = @_;
1.662 bisitz 15517: my $samples = &get_samples($records,5);
1.301 albertel 15518:
1.594 raeburn 15519: $r->print(&mt('Samples').'<br />'.&start_data_table().
15520: &start_data_table_header_row());
1.356 albertel 15521: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15522: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15523: $r->print(&end_data_table_header_row());
1.301 albertel 15524: foreach my $hash (@$samples) {
1.594 raeburn 15525: $r->print(&start_data_table_row());
1.356 albertel 15526: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15527: $r->print('<td>');
1.356 albertel 15528: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15529: $r->print('</td>');
15530: }
1.594 raeburn 15531: $r->print(&end_data_table_row());
1.31 albertel 15532: }
1.594 raeburn 15533: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15534: }
15535:
1.144 matthew 15536: ######################################################
15537: ######################################################
15538:
1.56 matthew 15539: =pod
15540:
1.648 raeburn 15541: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15542:
15543: Prints a table to create associations between values and table columns.
1.144 matthew 15544:
1.41 ng 15545: $r is an Apache Request ref,
15546: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15547: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15548:
15549: =cut
15550:
1.144 matthew 15551: ######################################################
15552: ######################################################
1.31 albertel 15553: sub csv_print_select_table {
15554: my ($r,$records,$d) = @_;
1.301 albertel 15555: my $i=0;
15556: my $samples = &get_samples($records,1);
1.144 matthew 15557: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15558: &start_data_table().&start_data_table_header_row().
1.144 matthew 15559: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15560: '<th>'.&mt('Column').'</th>'.
15561: &end_data_table_header_row()."\n");
1.356 albertel 15562: foreach my $array_ref (@$d) {
15563: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15564: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15565:
1.875 bisitz 15566: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15567: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15568: $r->print('<option value="none"></option>');
1.356 albertel 15569: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15570: $r->print('<option value="'.$sample.'"'.
15571: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15572: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15573: }
1.594 raeburn 15574: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15575: $i++;
15576: }
1.594 raeburn 15577: $r->print(&end_data_table());
1.31 albertel 15578: $i--;
15579: return $i;
15580: }
1.56 matthew 15581:
1.144 matthew 15582: ######################################################
15583: ######################################################
15584:
1.56 matthew 15585: =pod
1.31 albertel 15586:
1.648 raeburn 15587: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15588:
15589: Prints a table of sample values from the upload and can make associate samples to internal names.
15590:
15591: $r is an Apache Request ref,
15592: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15593: $d is an array of 2 element arrays (internal name, displayed name)
15594:
15595: =cut
15596:
1.144 matthew 15597: ######################################################
15598: ######################################################
1.31 albertel 15599: sub csv_samples_select_table {
15600: my ($r,$records,$d) = @_;
15601: my $i=0;
1.144 matthew 15602: #
1.662 bisitz 15603: my $max_samples = 5;
15604: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15605: $r->print(&start_data_table().
15606: &start_data_table_header_row().'<th>'.
15607: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15608: &end_data_table_header_row());
1.301 albertel 15609:
15610: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15611: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15612: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15613: foreach my $option (@$d) {
15614: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15615: $r->print('<option value="'.$value.'"'.
1.253 albertel 15616: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15617: $display.'</option>');
1.31 albertel 15618: }
15619: $r->print('</select></td><td>');
1.662 bisitz 15620: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15621: if (defined($samples->[$line]{$key})) {
15622: $r->print($samples->[$line]{$key}."<br />\n");
15623: }
15624: }
1.594 raeburn 15625: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15626: $i++;
15627: }
1.594 raeburn 15628: $r->print(&end_data_table());
1.31 albertel 15629: $i--;
15630: return($i);
1.115 matthew 15631: }
15632:
1.144 matthew 15633: ######################################################
15634: ######################################################
15635:
1.115 matthew 15636: =pod
15637:
1.648 raeburn 15638: =item * &clean_excel_name($name)
1.115 matthew 15639:
15640: Returns a replacement for $name which does not contain any illegal characters.
15641:
15642: =cut
15643:
1.144 matthew 15644: ######################################################
15645: ######################################################
1.115 matthew 15646: sub clean_excel_name {
15647: my ($name) = @_;
15648: $name =~ s/[:\*\?\/\\]//g;
15649: if (length($name) > 31) {
15650: $name = substr($name,0,31);
15651: }
15652: return $name;
1.25 albertel 15653: }
1.84 albertel 15654:
1.85 albertel 15655: =pod
15656:
1.648 raeburn 15657: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15658:
15659: Returns either 1 or undef
15660:
15661: 1 if the part is to be hidden, undef if it is to be shown
15662:
15663: Arguments are:
15664:
15665: $id the id of the part to be checked
15666: $symb, optional the symb of the resource to check
15667: $udom, optional the domain of the user to check for
15668: $uname, optional the username of the user to check for
15669:
15670: =cut
1.84 albertel 15671:
15672: sub check_if_partid_hidden {
15673: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15674: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15675: $symb,$udom,$uname);
1.141 albertel 15676: my $truth=1;
15677: #if the string starts with !, then the list is the list to show not hide
15678: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15679: my @hiddenlist=split(/,/,$hiddenparts);
15680: foreach my $checkid (@hiddenlist) {
1.141 albertel 15681: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15682: }
1.141 albertel 15683: return !$truth;
1.84 albertel 15684: }
1.127 matthew 15685:
1.138 matthew 15686:
15687: ############################################################
15688: ############################################################
15689:
15690: =pod
15691:
1.157 matthew 15692: =back
15693:
1.138 matthew 15694: =head1 cgi-bin script and graphing routines
15695:
1.157 matthew 15696: =over 4
15697:
1.648 raeburn 15698: =item * &get_cgi_id()
1.138 matthew 15699:
15700: Inputs: none
15701:
15702: Returns an id which can be used to pass environment variables
15703: to various cgi-bin scripts. These environment variables will
15704: be removed from the users environment after a given time by
15705: the routine &Apache::lonnet::transfer_profile_to_env.
15706:
15707: =cut
15708:
15709: ############################################################
15710: ############################################################
1.152 albertel 15711: my $uniq=0;
1.136 matthew 15712: sub get_cgi_id {
1.154 albertel 15713: $uniq=($uniq+1)%100000;
1.280 albertel 15714: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15715: }
15716:
1.127 matthew 15717: ############################################################
15718: ############################################################
15719:
15720: =pod
15721:
1.648 raeburn 15722: =item * &DrawBarGraph()
1.127 matthew 15723:
1.138 matthew 15724: Facilitates the plotting of data in a (stacked) bar graph.
15725: Puts plot definition data into the users environment in order for
15726: graph.png to plot it. Returns an <img> tag for the plot.
15727: The bars on the plot are labeled '1','2',...,'n'.
15728:
15729: Inputs:
15730:
15731: =over 4
15732:
15733: =item $Title: string, the title of the plot
15734:
15735: =item $xlabel: string, text describing the X-axis of the plot
15736:
15737: =item $ylabel: string, text describing the Y-axis of the plot
15738:
15739: =item $Max: scalar, the maximum Y value to use in the plot
15740: If $Max is < any data point, the graph will not be rendered.
15741:
1.140 matthew 15742: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15743: they are plotted. If undefined, default values will be used.
15744:
1.178 matthew 15745: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15746:
1.138 matthew 15747: =item @Values: An array of array references. Each array reference holds data
15748: to be plotted in a stacked bar chart.
15749:
1.239 matthew 15750: =item If the final element of @Values is a hash reference the key/value
15751: pairs will be added to the graph definition.
15752:
1.138 matthew 15753: =back
15754:
15755: Returns:
15756:
15757: An <img> tag which references graph.png and the appropriate identifying
15758: information for the plot.
15759:
1.127 matthew 15760: =cut
15761:
15762: ############################################################
15763: ############################################################
1.134 matthew 15764: sub DrawBarGraph {
1.178 matthew 15765: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15766: #
15767: if (! defined($colors)) {
15768: $colors = ['#33ff00',
15769: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15770: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15771: ];
15772: }
1.228 matthew 15773: my $extra_settings = {};
15774: if (ref($Values[-1]) eq 'HASH') {
15775: $extra_settings = pop(@Values);
15776: }
1.127 matthew 15777: #
1.136 matthew 15778: my $identifier = &get_cgi_id();
15779: my $id = 'cgi.'.$identifier;
1.129 matthew 15780: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15781: return '';
15782: }
1.225 matthew 15783: #
15784: my @Labels;
15785: if (defined($labels)) {
15786: @Labels = @$labels;
15787: } else {
15788: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15789: push(@Labels,$i+1);
1.225 matthew 15790: }
15791: }
15792: #
1.129 matthew 15793: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15794: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15795: my %ValuesHash;
15796: my $NumSets=1;
15797: foreach my $array (@Values) {
15798: next if (! ref($array));
1.136 matthew 15799: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15800: join(',',@$array);
1.129 matthew 15801: }
1.127 matthew 15802: #
1.136 matthew 15803: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15804: if ($NumBars < 3) {
15805: $width = 120+$NumBars*32;
1.220 matthew 15806: $xskip = 1;
1.225 matthew 15807: $bar_width = 30;
15808: } elsif ($NumBars < 5) {
15809: $width = 120+$NumBars*20;
15810: $xskip = 1;
15811: $bar_width = 20;
1.220 matthew 15812: } elsif ($NumBars < 10) {
1.136 matthew 15813: $width = 120+$NumBars*15;
15814: $xskip = 1;
15815: $bar_width = 15;
15816: } elsif ($NumBars <= 25) {
15817: $width = 120+$NumBars*11;
15818: $xskip = 5;
15819: $bar_width = 8;
15820: } elsif ($NumBars <= 50) {
15821: $width = 120+$NumBars*8;
15822: $xskip = 5;
15823: $bar_width = 4;
15824: } else {
15825: $width = 120+$NumBars*8;
15826: $xskip = 5;
15827: $bar_width = 4;
15828: }
15829: #
1.137 matthew 15830: $Max = 1 if ($Max < 1);
15831: if ( int($Max) < $Max ) {
15832: $Max++;
15833: $Max = int($Max);
15834: }
1.127 matthew 15835: $Title = '' if (! defined($Title));
15836: $xlabel = '' if (! defined($xlabel));
15837: $ylabel = '' if (! defined($ylabel));
1.369 www 15838: $ValuesHash{$id.'.title'} = &escape($Title);
15839: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15840: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15841: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15842: $ValuesHash{$id.'.NumBars'} = $NumBars;
15843: $ValuesHash{$id.'.NumSets'} = $NumSets;
15844: $ValuesHash{$id.'.PlotType'} = 'bar';
15845: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15846: $ValuesHash{$id.'.height'} = $height;
15847: $ValuesHash{$id.'.width'} = $width;
15848: $ValuesHash{$id.'.xskip'} = $xskip;
15849: $ValuesHash{$id.'.bar_width'} = $bar_width;
15850: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15851: #
1.228 matthew 15852: # Deal with other parameters
15853: while (my ($key,$value) = each(%$extra_settings)) {
15854: $ValuesHash{$id.'.'.$key} = $value;
15855: }
15856: #
1.646 raeburn 15857: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15858: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15859: }
15860:
15861: ############################################################
15862: ############################################################
15863:
15864: =pod
15865:
1.648 raeburn 15866: =item * &DrawXYGraph()
1.137 matthew 15867:
1.138 matthew 15868: Facilitates the plotting of data in an XY graph.
15869: Puts plot definition data into the users environment in order for
15870: graph.png to plot it. Returns an <img> tag for the plot.
15871:
15872: Inputs:
15873:
15874: =over 4
15875:
15876: =item $Title: string, the title of the plot
15877:
15878: =item $xlabel: string, text describing the X-axis of the plot
15879:
15880: =item $ylabel: string, text describing the Y-axis of the plot
15881:
15882: =item $Max: scalar, the maximum Y value to use in the plot
15883: If $Max is < any data point, the graph will not be rendered.
15884:
15885: =item $colors: Array ref containing the hex color codes for the data to be
15886: plotted in. If undefined, default values will be used.
15887:
15888: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15889:
15890: =item $Ydata: Array ref containing Array refs.
1.185 www 15891: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15892:
15893: =item %Values: hash indicating or overriding any default values which are
15894: passed to graph.png.
15895: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15896:
15897: =back
15898:
15899: Returns:
15900:
15901: An <img> tag which references graph.png and the appropriate identifying
15902: information for the plot.
15903:
1.137 matthew 15904: =cut
15905:
15906: ############################################################
15907: ############################################################
15908: sub DrawXYGraph {
15909: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15910: #
15911: # Create the identifier for the graph
15912: my $identifier = &get_cgi_id();
15913: my $id = 'cgi.'.$identifier;
15914: #
15915: $Title = '' if (! defined($Title));
15916: $xlabel = '' if (! defined($xlabel));
15917: $ylabel = '' if (! defined($ylabel));
15918: my %ValuesHash =
15919: (
1.369 www 15920: $id.'.title' => &escape($Title),
15921: $id.'.xlabel' => &escape($xlabel),
15922: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15923: $id.'.y_max_value'=> $Max,
15924: $id.'.labels' => join(',',@$Xlabels),
15925: $id.'.PlotType' => 'XY',
15926: );
15927: #
15928: if (defined($colors) && ref($colors) eq 'ARRAY') {
15929: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15930: }
15931: #
15932: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15933: return '';
15934: }
15935: my $NumSets=1;
1.138 matthew 15936: foreach my $array (@{$Ydata}){
1.137 matthew 15937: next if (! ref($array));
15938: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15939: }
1.138 matthew 15940: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15941: #
15942: # Deal with other parameters
15943: while (my ($key,$value) = each(%Values)) {
15944: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15945: }
15946: #
1.646 raeburn 15947: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15948: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15949: }
15950:
15951: ############################################################
15952: ############################################################
15953:
15954: =pod
15955:
1.648 raeburn 15956: =item * &DrawXYYGraph()
1.138 matthew 15957:
15958: Facilitates the plotting of data in an XY graph with two Y axes.
15959: Puts plot definition data into the users environment in order for
15960: graph.png to plot it. Returns an <img> tag for the plot.
15961:
15962: Inputs:
15963:
15964: =over 4
15965:
15966: =item $Title: string, the title of the plot
15967:
15968: =item $xlabel: string, text describing the X-axis of the plot
15969:
15970: =item $ylabel: string, text describing the Y-axis of the plot
15971:
15972: =item $colors: Array ref containing the hex color codes for the data to be
15973: plotted in. If undefined, default values will be used.
15974:
15975: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15976:
15977: =item $Ydata1: The first data set
15978:
15979: =item $Min1: The minimum value of the left Y-axis
15980:
15981: =item $Max1: The maximum value of the left Y-axis
15982:
15983: =item $Ydata2: The second data set
15984:
15985: =item $Min2: The minimum value of the right Y-axis
15986:
15987: =item $Max2: The maximum value of the left Y-axis
15988:
15989: =item %Values: hash indicating or overriding any default values which are
15990: passed to graph.png.
15991: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15992:
15993: =back
15994:
15995: Returns:
15996:
15997: An <img> tag which references graph.png and the appropriate identifying
15998: information for the plot.
1.136 matthew 15999:
16000: =cut
16001:
16002: ############################################################
16003: ############################################################
1.137 matthew 16004: sub DrawXYYGraph {
16005: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16006: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16007: #
16008: # Create the identifier for the graph
16009: my $identifier = &get_cgi_id();
16010: my $id = 'cgi.'.$identifier;
16011: #
16012: $Title = '' if (! defined($Title));
16013: $xlabel = '' if (! defined($xlabel));
16014: $ylabel = '' if (! defined($ylabel));
16015: my %ValuesHash =
16016: (
1.369 www 16017: $id.'.title' => &escape($Title),
16018: $id.'.xlabel' => &escape($xlabel),
16019: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16020: $id.'.labels' => join(',',@$Xlabels),
16021: $id.'.PlotType' => 'XY',
16022: $id.'.NumSets' => 2,
1.137 matthew 16023: $id.'.two_axes' => 1,
16024: $id.'.y1_max_value' => $Max1,
16025: $id.'.y1_min_value' => $Min1,
16026: $id.'.y2_max_value' => $Max2,
16027: $id.'.y2_min_value' => $Min2,
1.136 matthew 16028: );
16029: #
1.137 matthew 16030: if (defined($colors) && ref($colors) eq 'ARRAY') {
16031: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16032: }
16033: #
16034: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16035: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16036: return '';
16037: }
16038: my $NumSets=1;
1.137 matthew 16039: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16040: next if (! ref($array));
16041: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16042: }
16043: #
16044: # Deal with other parameters
16045: while (my ($key,$value) = each(%Values)) {
16046: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16047: }
16048: #
1.646 raeburn 16049: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16050: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16051: }
16052:
16053: ############################################################
16054: ############################################################
16055:
16056: =pod
16057:
1.157 matthew 16058: =back
16059:
1.139 matthew 16060: =head1 Statistics helper routines?
16061:
16062: Bad place for them but what the hell.
16063:
1.157 matthew 16064: =over 4
16065:
1.648 raeburn 16066: =item * &chartlink()
1.139 matthew 16067:
16068: Returns a link to the chart for a specific student.
16069:
16070: Inputs:
16071:
16072: =over 4
16073:
16074: =item $linktext: The text of the link
16075:
16076: =item $sname: The students username
16077:
16078: =item $sdomain: The students domain
16079:
16080: =back
16081:
1.157 matthew 16082: =back
16083:
1.139 matthew 16084: =cut
16085:
16086: ############################################################
16087: ############################################################
16088: sub chartlink {
16089: my ($linktext, $sname, $sdomain) = @_;
16090: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16091: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16092: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16093: '">'.$linktext.'</a>';
1.153 matthew 16094: }
16095:
16096: #######################################################
16097: #######################################################
16098:
16099: =pod
16100:
16101: =head1 Course Environment Routines
1.157 matthew 16102:
16103: =over 4
1.153 matthew 16104:
1.648 raeburn 16105: =item * &restore_course_settings()
1.153 matthew 16106:
1.648 raeburn 16107: =item * &store_course_settings()
1.153 matthew 16108:
16109: Restores/Store indicated form parameters from the course environment.
16110: Will not overwrite existing values of the form parameters.
16111:
16112: Inputs:
16113: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16114:
16115: a hash ref describing the data to be stored. For example:
16116:
16117: %Save_Parameters = ('Status' => 'scalar',
16118: 'chartoutputmode' => 'scalar',
16119: 'chartoutputdata' => 'scalar',
16120: 'Section' => 'array',
1.373 raeburn 16121: 'Group' => 'array',
1.153 matthew 16122: 'StudentData' => 'array',
16123: 'Maps' => 'array');
16124:
16125: Returns: both routines return nothing
16126:
1.631 raeburn 16127: =back
16128:
1.153 matthew 16129: =cut
16130:
16131: #######################################################
16132: #######################################################
16133: sub store_course_settings {
1.496 albertel 16134: return &store_settings($env{'request.course.id'},@_);
16135: }
16136:
16137: sub store_settings {
1.153 matthew 16138: # save to the environment
16139: # appenv the same items, just to be safe
1.300 albertel 16140: my $udom = $env{'user.domain'};
16141: my $uname = $env{'user.name'};
1.496 albertel 16142: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16143: my %SaveHash;
16144: my %AppHash;
16145: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16146: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16147: my $envname = 'environment.'.$basename;
1.258 albertel 16148: if (exists($env{'form.'.$setting})) {
1.153 matthew 16149: # Save this value away
16150: if ($type eq 'scalar' &&
1.258 albertel 16151: (! exists($env{$envname}) ||
16152: $env{$envname} ne $env{'form.'.$setting})) {
16153: $SaveHash{$basename} = $env{'form.'.$setting};
16154: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16155: } elsif ($type eq 'array') {
16156: my $stored_form;
1.258 albertel 16157: if (ref($env{'form.'.$setting})) {
1.153 matthew 16158: $stored_form = join(',',
16159: map {
1.369 www 16160: &escape($_);
1.258 albertel 16161: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16162: } else {
16163: $stored_form =
1.369 www 16164: &escape($env{'form.'.$setting});
1.153 matthew 16165: }
16166: # Determine if the array contents are the same.
1.258 albertel 16167: if ($stored_form ne $env{$envname}) {
1.153 matthew 16168: $SaveHash{$basename} = $stored_form;
16169: $AppHash{$envname} = $stored_form;
16170: }
16171: }
16172: }
16173: }
16174: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16175: $udom,$uname);
1.153 matthew 16176: if ($put_result !~ /^(ok|delayed)/) {
16177: &Apache::lonnet::logthis('unable to save form parameters, '.
16178: 'got error:'.$put_result);
16179: }
16180: # Make sure these settings stick around in this session, too
1.646 raeburn 16181: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16182: return;
16183: }
16184:
16185: sub restore_course_settings {
1.499 albertel 16186: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16187: }
16188:
16189: sub restore_settings {
16190: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16191: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16192: next if (exists($env{'form.'.$setting}));
1.496 albertel 16193: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16194: '.'.$setting;
1.258 albertel 16195: if (exists($env{$envname})) {
1.153 matthew 16196: if ($type eq 'scalar') {
1.258 albertel 16197: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16198: } elsif ($type eq 'array') {
1.258 albertel 16199: $env{'form.'.$setting} = [
1.153 matthew 16200: map {
1.369 www 16201: &unescape($_);
1.258 albertel 16202: } split(',',$env{$envname})
1.153 matthew 16203: ];
16204: }
16205: }
16206: }
1.127 matthew 16207: }
16208:
1.618 raeburn 16209: #######################################################
16210: #######################################################
16211:
16212: =pod
16213:
16214: =head1 Domain E-mail Routines
16215:
16216: =over 4
16217:
1.648 raeburn 16218: =item * &build_recipient_list()
1.618 raeburn 16219:
1.1144 raeburn 16220: Build recipient lists for following types of e-mail:
1.766 raeburn 16221: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16222: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16223: module change checking, student/employee ID conflict checks, as
16224: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16225: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16226:
16227: Inputs:
1.619 raeburn 16228: defmail (scalar - email address of default recipient),
1.1144 raeburn 16229: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16230: requestsmail, updatesmail, or idconflictsmail).
16231:
1.619 raeburn 16232: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16233:
1.619 raeburn 16234: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16235: i.e., predates configuration by DC via domainprefs.pm
16236:
16237: $requname username of requester (if mailing type is helpdeskmail)
16238:
16239: $requdom domain of requester (if mailing type is helpdeskmail)
16240:
16241: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16242:
1.618 raeburn 16243:
1.655 raeburn 16244: Returns: comma separated list of addresses to which to send e-mail.
16245:
16246: =back
1.618 raeburn 16247:
16248: =cut
16249:
16250: ############################################################
16251: ############################################################
16252: sub build_recipient_list {
1.1297 raeburn 16253: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16254: my @recipients;
1.1270 raeburn 16255: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16256: my %domconfig =
1.1270 raeburn 16257: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16258: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16259: if (exists($domconfig{'contacts'}{$mailing})) {
16260: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16261: my @contacts = ('adminemail','supportemail');
16262: foreach my $item (@contacts) {
16263: if ($domconfig{'contacts'}{$mailing}{$item}) {
16264: my $addr = $domconfig{'contacts'}{$item};
16265: if (!grep(/^\Q$addr\E$/,@recipients)) {
16266: push(@recipients,$addr);
16267: }
1.619 raeburn 16268: }
1.1270 raeburn 16269: }
16270: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16271: if ($mailing eq 'helpdeskmail') {
16272: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16273: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16274: my @ok_bccs;
16275: foreach my $bcc (@bccs) {
16276: $bcc =~ s/^\s+//g;
16277: $bcc =~ s/\s+$//g;
16278: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16279: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16280: push(@ok_bccs,$bcc);
16281: }
16282: }
16283: }
16284: if (@ok_bccs > 0) {
16285: $allbcc = join(', ',@ok_bccs);
16286: }
16287: }
16288: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16289: }
16290: }
1.766 raeburn 16291: } elsif ($origmail ne '') {
1.1270 raeburn 16292: $lastresort = $origmail;
1.618 raeburn 16293: }
1.1297 raeburn 16294: if ($mailing eq 'helpdeskmail') {
16295: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16296: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16297: my ($inststatus,$inststatus_checked);
16298: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16299: ($env{'user.domain'} ne 'public')) {
16300: $inststatus_checked = 1;
16301: $inststatus = $env{'environment.inststatus'};
16302: }
16303: unless ($inststatus_checked) {
16304: if (($requname ne '') && ($requdom ne '')) {
16305: if (($requname =~ /^$match_username$/) &&
16306: ($requdom =~ /^$match_domain$/) &&
16307: (&Apache::lonnet::domain($requdom))) {
16308: my $requhome = &Apache::lonnet::homeserver($requname,
16309: $requdom);
16310: unless ($requhome eq 'no_host') {
16311: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16312: $inststatus = $userenv{'inststatus'};
16313: $inststatus_checked = 1;
16314: }
16315: }
16316: }
16317: }
16318: unless ($inststatus_checked) {
16319: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16320: my %srch = (srchby => 'email',
16321: srchdomain => $defdom,
16322: srchterm => $reqemail,
16323: srchtype => 'exact');
16324: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16325: foreach my $uname (keys(%srch_results)) {
16326: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16327: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16328: $inststatus_checked = 1;
16329: last;
16330: }
16331: }
16332: unless ($inststatus_checked) {
16333: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16334: if ($dirsrchres eq 'ok') {
16335: foreach my $uname (keys(%srch_results)) {
16336: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16337: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16338: $inststatus_checked = 1;
16339: last;
16340: }
16341: }
16342: }
16343: }
16344: }
16345: }
16346: if ($inststatus ne '') {
16347: foreach my $status (split(/\:/,$inststatus)) {
16348: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16349: my @contacts = ('adminemail','supportemail');
16350: foreach my $item (@contacts) {
16351: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16352: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16353: if (!grep(/^\Q$addr\E$/,@recipients)) {
16354: push(@recipients,$addr);
16355: }
16356: }
16357: }
16358: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16359: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16360: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16361: my @ok_bccs;
16362: foreach my $bcc (@bccs) {
16363: $bcc =~ s/^\s+//g;
16364: $bcc =~ s/\s+$//g;
16365: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16366: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16367: push(@ok_bccs,$bcc);
16368: }
16369: }
16370: }
16371: if (@ok_bccs > 0) {
16372: $allbcc = join(', ',@ok_bccs);
16373: }
16374: }
16375: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16376: last;
16377: }
16378: }
16379: }
16380: }
16381: }
1.619 raeburn 16382: } elsif ($origmail ne '') {
1.1270 raeburn 16383: $lastresort = $origmail;
16384: }
1.1297 raeburn 16385: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16386: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16387: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16388: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16389: my %what = (
16390: perlvar => 1,
16391: );
16392: my $primary = &Apache::lonnet::domain($defdom,'primary');
16393: if ($primary) {
16394: my $gotaddr;
16395: my ($result,$returnhash) =
16396: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16397: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16398: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16399: $lastresort = $returnhash->{'lonSupportEMail'};
16400: $gotaddr = 1;
16401: }
16402: }
16403: unless ($gotaddr) {
16404: my $uintdom = &Apache::lonnet::internet_dom($primary);
16405: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16406: unless ($uintdom eq $intdom) {
16407: my %domconfig =
16408: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16409: if (ref($domconfig{'contacts'}) eq 'HASH') {
16410: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16411: my @contacts = ('adminemail','supportemail');
16412: foreach my $item (@contacts) {
16413: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16414: my $addr = $domconfig{'contacts'}{$item};
16415: if (!grep(/^\Q$addr\E$/,@recipients)) {
16416: push(@recipients,$addr);
16417: }
16418: }
16419: }
16420: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16421: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16422: }
16423: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16424: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16425: my @ok_bccs;
16426: foreach my $bcc (@bccs) {
16427: $bcc =~ s/^\s+//g;
16428: $bcc =~ s/\s+$//g;
16429: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16430: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16431: push(@ok_bccs,$bcc);
16432: }
16433: }
16434: }
16435: if (@ok_bccs > 0) {
16436: $allbcc = join(', ',@ok_bccs);
16437: }
16438: }
16439: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16440: }
16441: }
16442: }
16443: }
16444: }
16445: }
1.618 raeburn 16446: }
1.688 raeburn 16447: if (defined($defmail)) {
16448: if ($defmail ne '') {
16449: push(@recipients,$defmail);
16450: }
1.618 raeburn 16451: }
16452: if ($otheremails) {
1.619 raeburn 16453: my @others;
16454: if ($otheremails =~ /,/) {
16455: @others = split(/,/,$otheremails);
1.618 raeburn 16456: } else {
1.619 raeburn 16457: push(@others,$otheremails);
16458: }
16459: foreach my $addr (@others) {
16460: if (!grep(/^\Q$addr\E$/,@recipients)) {
16461: push(@recipients,$addr);
16462: }
1.618 raeburn 16463: }
16464: }
1.1298 raeburn 16465: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16466: if ((!@recipients) && ($lastresort ne '')) {
16467: push(@recipients,$lastresort);
16468: }
16469: } elsif ($lastresort ne '') {
16470: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16471: push(@recipients,$lastresort);
16472: }
16473: }
1.1271 raeburn 16474: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16475: if (wantarray) {
16476: return ($recipientlist,$allbcc,$addtext);
16477: } else {
16478: return $recipientlist;
16479: }
1.618 raeburn 16480: }
16481:
1.127 matthew 16482: ############################################################
16483: ############################################################
1.154 albertel 16484:
1.655 raeburn 16485: =pod
16486:
1.1224 musolffc 16487: =over 4
16488:
1.1223 musolffc 16489: =item * &mime_email()
16490:
16491: Sends an email with a possible attachment
16492:
16493: Inputs:
16494:
16495: =over 4
16496:
16497: from - Sender's email address
16498:
1.1343 raeburn 16499: replyto - Reply-To email address
16500:
1.1223 musolffc 16501: to - Email address of recipient
16502:
16503: subject - Subject of email
16504:
16505: body - Body of email
16506:
16507: cc_string - Carbon copy email address
16508:
16509: bcc - Blind carbon copy email address
16510:
16511: attachment_path - Path of file to be attached
16512:
16513: file_name - Name of file to be attached
16514:
16515: attachment_text - The body of an attachment of type "TEXT"
16516:
16517: =back
16518:
16519: =back
16520:
16521: =cut
16522:
16523: ############################################################
16524: ############################################################
16525:
16526: sub mime_email {
1.1343 raeburn 16527: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16528: $file_name,$attachment_text) = @_;
16529:
1.1223 musolffc 16530: my $msg = MIME::Lite->new(
16531: From => $from,
16532: To => $to,
16533: Subject => $subject,
16534: Type =>'TEXT',
16535: Data => $body,
16536: );
1.1343 raeburn 16537: if ($replyto ne '') {
16538: $msg->add("Reply-To" => $replyto);
16539: }
1.1223 musolffc 16540: if ($cc_string ne '') {
16541: $msg->add("Cc" => $cc_string);
16542: }
16543: if ($bcc ne '') {
16544: $msg->add("Bcc" => $bcc);
16545: }
16546: $msg->attr("content-type" => "text/plain");
16547: $msg->attr("content-type.charset" => "UTF-8");
16548: # Attach file if given
16549: if ($attachment_path) {
16550: unless ($file_name) {
16551: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16552: }
16553: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16554: $msg->attach(Type => $type,
16555: Path => $attachment_path,
16556: Filename => $file_name
16557: );
16558: # Otherwise attach text if given
16559: } elsif ($attachment_text) {
16560: $msg->attach(Type => 'TEXT',
16561: Data => $attachment_text);
16562: }
16563: # Send it
16564: $msg->send('sendmail');
16565: }
16566:
16567: ############################################################
16568: ############################################################
16569:
16570: =pod
16571:
1.655 raeburn 16572: =head1 Course Catalog Routines
16573:
16574: =over 4
16575:
16576: =item * &gather_categories()
16577:
16578: Converts category definitions - keys of categories hash stored in
16579: coursecategories in configuration.db on the primary library server in a
16580: domain - to an array. Also generates javascript and idx hash used to
16581: generate Domain Coordinator interface for editing Course Categories.
16582:
16583: Inputs:
1.663 raeburn 16584:
1.655 raeburn 16585: categories (reference to hash of category definitions).
1.663 raeburn 16586:
1.655 raeburn 16587: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16588: categories and subcategories).
1.663 raeburn 16589:
1.655 raeburn 16590: idx (reference to hash of counters used in Domain Coordinator interface for
16591: editing Course Categories).
1.663 raeburn 16592:
1.655 raeburn 16593: jsarray (reference to array of categories used to create Javascript arrays for
16594: Domain Coordinator interface for editing Course Categories).
16595:
16596: Returns: nothing
16597:
16598: Side effects: populates cats, idx and jsarray.
16599:
16600: =cut
16601:
16602: sub gather_categories {
16603: my ($categories,$cats,$idx,$jsarray) = @_;
16604: my %counters;
16605: my $num = 0;
16606: foreach my $item (keys(%{$categories})) {
16607: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16608: if ($container eq '' && $depth == 0) {
16609: $cats->[$depth][$categories->{$item}] = $cat;
16610: } else {
16611: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16612: }
16613: my ($escitem,$tail) = split(/:/,$item,2);
16614: if ($counters{$tail} eq '') {
16615: $counters{$tail} = $num;
16616: $num ++;
16617: }
16618: if (ref($idx) eq 'HASH') {
16619: $idx->{$item} = $counters{$tail};
16620: }
16621: if (ref($jsarray) eq 'ARRAY') {
16622: push(@{$jsarray->[$counters{$tail}]},$item);
16623: }
16624: }
16625: return;
16626: }
16627:
16628: =pod
16629:
16630: =item * &extract_categories()
16631:
16632: Used to generate breadcrumb trails for course categories.
16633:
16634: Inputs:
1.663 raeburn 16635:
1.655 raeburn 16636: categories (reference to hash of category definitions).
1.663 raeburn 16637:
1.655 raeburn 16638: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16639: categories and subcategories).
1.663 raeburn 16640:
1.655 raeburn 16641: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16642:
1.655 raeburn 16643: allitems (reference to hash - key is category key
16644: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16645:
1.655 raeburn 16646: idx (reference to hash of counters used in Domain Coordinator interface for
16647: editing Course Categories).
1.663 raeburn 16648:
1.655 raeburn 16649: jsarray (reference to array of categories used to create Javascript arrays for
16650: Domain Coordinator interface for editing Course Categories).
16651:
1.665 raeburn 16652: subcats (reference to hash of arrays containing all subcategories within each
16653: category, -recursive)
16654:
1.1321 raeburn 16655: maxd (reference to hash used to hold max depth for all top-level categories).
16656:
1.655 raeburn 16657: Returns: nothing
16658:
16659: Side effects: populates trails and allitems hash references.
16660:
16661: =cut
16662:
16663: sub extract_categories {
1.1321 raeburn 16664: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16665: if (ref($categories) eq 'HASH') {
16666: &gather_categories($categories,$cats,$idx,$jsarray);
16667: if (ref($cats->[0]) eq 'ARRAY') {
16668: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16669: my $name = $cats->[0][$i];
16670: my $item = &escape($name).'::0';
16671: my $trailstr;
16672: if ($name eq 'instcode') {
16673: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16674: } elsif ($name eq 'communities') {
16675: $trailstr = &mt('Communities');
1.1239 raeburn 16676: } elsif ($name eq 'placement') {
16677: $trailstr = &mt('Placement Tests');
1.655 raeburn 16678: } else {
16679: $trailstr = $name;
16680: }
16681: if ($allitems->{$item} eq '') {
16682: push(@{$trails},$trailstr);
16683: $allitems->{$item} = scalar(@{$trails})-1;
16684: }
16685: my @parents = ($name);
16686: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16687: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16688: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16689: if (ref($subcats) eq 'HASH') {
16690: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16691: }
1.1321 raeburn 16692: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16693: }
16694: } else {
16695: if (ref($subcats) eq 'HASH') {
16696: $subcats->{$item} = [];
1.655 raeburn 16697: }
1.1321 raeburn 16698: if (ref($maxd) eq 'HASH') {
16699: $maxd->{$name} = 1;
16700: }
1.655 raeburn 16701: }
16702: }
16703: }
16704: }
16705: return;
16706: }
16707:
16708: =pod
16709:
1.1162 raeburn 16710: =item * &recurse_categories()
1.655 raeburn 16711:
16712: Recursively used to generate breadcrumb trails for course categories.
16713:
16714: Inputs:
1.663 raeburn 16715:
1.655 raeburn 16716: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16717: categories and subcategories).
1.663 raeburn 16718:
1.655 raeburn 16719: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16720:
16721: category (current course category, for which breadcrumb trail is being generated).
16722:
16723: trails (reference to array of breadcrumb trails for each category).
16724:
1.655 raeburn 16725: allitems (reference to hash - key is category key
16726: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16727:
1.655 raeburn 16728: parents (array containing containers directories for current category,
16729: back to top level).
16730:
16731: Returns: nothing
16732:
16733: Side effects: populates trails and allitems hash references
16734:
16735: =cut
16736:
16737: sub recurse_categories {
1.1321 raeburn 16738: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16739: my $shallower = $depth - 1;
16740: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16741: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16742: my $name = $cats->[$depth]{$category}[$k];
16743: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16744: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16745: if ($allitems->{$item} eq '') {
16746: push(@{$trails},$trailstr);
16747: $allitems->{$item} = scalar(@{$trails})-1;
16748: }
16749: my $deeper = $depth+1;
16750: push(@{$parents},$category);
1.665 raeburn 16751: if (ref($subcats) eq 'HASH') {
16752: my $subcat = &escape($name).':'.$category.':'.$depth;
16753: for (my $j=@{$parents}; $j>=0; $j--) {
16754: my $higher;
16755: if ($j > 0) {
16756: $higher = &escape($parents->[$j]).':'.
16757: &escape($parents->[$j-1]).':'.$j;
16758: } else {
16759: $higher = &escape($parents->[$j]).'::'.$j;
16760: }
16761: push(@{$subcats->{$higher}},$subcat);
16762: }
16763: }
16764: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16765: $subcats,$maxd);
1.655 raeburn 16766: pop(@{$parents});
16767: }
16768: } else {
16769: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16770: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16771: if ($allitems->{$item} eq '') {
16772: push(@{$trails},$trailstr);
16773: $allitems->{$item} = scalar(@{$trails})-1;
16774: }
1.1321 raeburn 16775: if (ref($maxd) eq 'HASH') {
16776: if ($depth > $maxd->{$parents->[0]}) {
16777: $maxd->{$parents->[0]} = $depth;
16778: }
16779: }
1.655 raeburn 16780: }
16781: return;
16782: }
16783:
1.663 raeburn 16784: =pod
16785:
1.1162 raeburn 16786: =item * &assign_categories_table()
1.663 raeburn 16787:
16788: Create a datatable for display of hierarchical categories in a domain,
16789: with checkboxes to allow a course to be categorized.
16790:
16791: Inputs:
16792:
16793: cathash - reference to hash of categories defined for the domain (from
16794: configuration.db)
16795:
16796: currcat - scalar with an & separated list of categories assigned to a course.
16797:
1.919 raeburn 16798: type - scalar contains course type (Course or Community).
16799:
1.1260 raeburn 16800: disabled - scalar (optional) contains disabled="disabled" if input elements are
16801: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16802:
1.663 raeburn 16803: Returns: $output (markup to be displayed)
16804:
16805: =cut
16806:
16807: sub assign_categories_table {
1.1259 raeburn 16808: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16809: my $output;
16810: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16811: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16812: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16813: $maxdepth = scalar(@cats);
16814: if (@cats > 0) {
16815: my $itemcount = 0;
16816: if (ref($cats[0]) eq 'ARRAY') {
16817: my @currcategories;
16818: if ($currcat ne '') {
16819: @currcategories = split('&',$currcat);
16820: }
1.919 raeburn 16821: my $table;
1.663 raeburn 16822: for (my $i=0; $i<@{$cats[0]}; $i++) {
16823: my $parent = $cats[0][$i];
1.919 raeburn 16824: next if ($parent eq 'instcode');
16825: if ($type eq 'Community') {
16826: next unless ($parent eq 'communities');
1.1239 raeburn 16827: } elsif ($type eq 'Placement') {
16828: next unless ($parent eq 'placement');
1.919 raeburn 16829: } else {
1.1239 raeburn 16830: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16831: }
1.663 raeburn 16832: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16833: my $item = &escape($parent).'::0';
16834: my $checked = '';
16835: if (@currcategories > 0) {
16836: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16837: $checked = ' checked="checked"';
1.663 raeburn 16838: }
16839: }
1.919 raeburn 16840: my $parent_title = $parent;
16841: if ($parent eq 'communities') {
16842: $parent_title = &mt('Communities');
1.1239 raeburn 16843: } elsif ($parent eq 'placement') {
16844: $parent_title = &mt('Placement Tests');
1.919 raeburn 16845: }
16846: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16847: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16848: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16849: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16850: my $depth = 1;
16851: push(@path,$parent);
1.1259 raeburn 16852: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16853: pop(@path);
1.919 raeburn 16854: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16855: $itemcount ++;
16856: }
1.919 raeburn 16857: if ($itemcount) {
16858: $output = &Apache::loncommon::start_data_table().
16859: $table.
16860: &Apache::loncommon::end_data_table();
16861: }
1.663 raeburn 16862: }
16863: }
16864: }
16865: return $output;
16866: }
16867:
16868: =pod
16869:
1.1162 raeburn 16870: =item * &assign_category_rows()
1.663 raeburn 16871:
16872: Create a datatable row for display of nested categories in a domain,
16873: with checkboxes to allow a course to be categorized,called recursively.
16874:
16875: Inputs:
16876:
16877: itemcount - track row number for alternating colors
16878:
16879: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16880: categories and subcategories.
16881:
16882: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16883:
16884: parent - parent of current category item
16885:
16886: path - Array containing all categories back up through the hierarchy from the
16887: current category to the top level.
16888:
16889: currcategories - reference to array of current categories assigned to the course
16890:
1.1260 raeburn 16891: disabled - scalar (optional) contains disabled="disabled" if input elements are
16892: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16893:
1.663 raeburn 16894: Returns: $output (markup to be displayed).
16895:
16896: =cut
16897:
16898: sub assign_category_rows {
1.1259 raeburn 16899: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16900: my ($text,$name,$item,$chgstr);
16901: if (ref($cats) eq 'ARRAY') {
16902: my $maxdepth = scalar(@{$cats});
16903: if (ref($cats->[$depth]) eq 'HASH') {
16904: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16905: my $numchildren = @{$cats->[$depth]{$parent}};
16906: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16907: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16908: for (my $j=0; $j<$numchildren; $j++) {
16909: $name = $cats->[$depth]{$parent}[$j];
16910: $item = &escape($name).':'.&escape($parent).':'.$depth;
16911: my $deeper = $depth+1;
16912: my $checked = '';
16913: if (ref($currcategories) eq 'ARRAY') {
16914: if (@{$currcategories} > 0) {
16915: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16916: $checked = ' checked="checked"';
1.663 raeburn 16917: }
16918: }
16919: }
1.664 raeburn 16920: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16921: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16922: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16923: '<input type="hidden" name="catname" value="'.$name.'" />'.
16924: '</td><td>';
1.663 raeburn 16925: if (ref($path) eq 'ARRAY') {
16926: push(@{$path},$name);
1.1259 raeburn 16927: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16928: pop(@{$path});
16929: }
16930: $text .= '</td></tr>';
16931: }
16932: $text .= '</table></td>';
16933: }
16934: }
16935: }
16936: return $text;
16937: }
16938:
1.1181 raeburn 16939: =pod
16940:
16941: =back
16942:
16943: =cut
16944:
1.655 raeburn 16945: ############################################################
16946: ############################################################
16947:
16948:
1.443 albertel 16949: sub commit_customrole {
1.1408 raeburn 16950: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16951: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16952: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16953: $context,$othdomby,$requester);
1.630 raeburn 16954: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16955: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16956: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16957: if (wantarray) {
16958: return ($output,$result);
16959: } else {
16960: return $output;
16961: }
1.443 albertel 16962: }
16963:
16964: sub commit_standardrole {
1.1408 raeburn 16965: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16966: $othdomby,$requester) = @_;
1.1399 raeburn 16967: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16968: if ($context eq 'auto') {
16969: $linefeed = "\n";
16970: } else {
16971: $linefeed = "<br />\n";
16972: }
1.443 albertel 16973: if ($three eq 'st') {
1.1399 raeburn 16974: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16975: $one,$two,$sec,$context,$credits,$othdomby,
16976: $requester);
1.541 raeburn 16977: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16978: ($result eq 'unknown_course') || ($result eq 'refused')) {
16979: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16980: } else {
1.541 raeburn 16981: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16982: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16983: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16984: if ($context eq 'auto') {
16985: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16986: } else {
16987: $output .= '<b>'.$result.'</b>'.$linefeed.
16988: &mt('Add to classlist').': <b>ok</b>';
16989: }
16990: $output .= $linefeed;
1.443 albertel 16991: }
16992: } else {
16993: $output = &mt('Assigning').' '.$three.' in '.$url.
16994: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16995: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 16996: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
16997: '','',$context,$othdomby,$requester);
1.541 raeburn 16998: if ($context eq 'auto') {
16999: $output .= $result.$linefeed;
17000: } else {
17001: $output .= '<b>'.$result.'</b>'.$linefeed;
17002: }
1.443 albertel 17003: }
1.1399 raeburn 17004: if (wantarray) {
17005: return ($output,$result);
17006: } else {
17007: return $output;
17008: }
1.443 albertel 17009: }
17010:
17011: sub commit_studentrole {
1.1116 raeburn 17012: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17013: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17014: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17015: if ($context eq 'auto') {
17016: $linefeed = "\n";
17017: } else {
17018: $linefeed = '<br />'."\n";
17019: }
1.443 albertel 17020: if (defined($one) && defined($two)) {
17021: my $cid=$one.'_'.$two;
17022: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17023: my $secchange = 0;
17024: my $expire_role_result;
17025: my $modify_section_result;
1.628 raeburn 17026: if ($oldsec ne '-1') {
17027: if ($oldsec ne $sec) {
1.443 albertel 17028: $secchange = 1;
1.628 raeburn 17029: my $now = time;
1.443 albertel 17030: my $uurl='/'.$cid;
17031: $uurl=~s/\_/\//g;
17032: if ($oldsec) {
17033: $uurl.='/'.$oldsec;
17034: }
1.626 raeburn 17035: $oldsecurl = $uurl;
1.628 raeburn 17036: $expire_role_result =
1.1408 raeburn 17037: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17038: '','','',$context,$othdomby,$requester);
17039: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17040: if ($expire_role_result eq 'refused') {
17041: my @roles = ('st');
17042: my @statuses = ('previous');
17043: my @roledoms = ($one);
17044: my $withsec = 1;
17045: my %roleshash =
17046: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17047: \@statuses,\@roles,\@roledoms,$withsec);
17048: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17049: my ($oldstart,$oldend) =
17050: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17051: if ($oldend > 0 && $oldend <= $now) {
17052: $expire_role_result = 'ok';
17053: }
17054: }
17055: }
17056: }
1.443 albertel 17057: $result = $expire_role_result;
17058: }
17059: }
17060: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17061: $modify_section_result =
17062: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17063: undef,undef,undef,$sec,
17064: $end,$start,'','',$cid,
1.1408 raeburn 17065: '',$context,$credits,'',
17066: $othdomby,$requester);
1.443 albertel 17067: if ($modify_section_result =~ /^ok/) {
17068: if ($secchange == 1) {
1.628 raeburn 17069: if ($sec eq '') {
17070: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17071: } else {
17072: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17073: }
1.443 albertel 17074: } elsif ($oldsec eq '-1') {
1.628 raeburn 17075: if ($sec eq '') {
17076: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17077: } else {
17078: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17079: }
1.443 albertel 17080: } else {
1.628 raeburn 17081: if ($sec eq '') {
17082: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17083: } else {
17084: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17085: }
1.443 albertel 17086: }
17087: } else {
1.1115 raeburn 17088: if ($secchange) {
1.628 raeburn 17089: $$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;
17090: } else {
17091: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17092: }
1.443 albertel 17093: }
17094: $result = $modify_section_result;
17095: } elsif ($secchange == 1) {
1.628 raeburn 17096: if ($oldsec eq '') {
1.1103 raeburn 17097: $$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 17098: } else {
17099: $$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;
17100: }
1.626 raeburn 17101: if ($expire_role_result eq 'refused') {
17102: my $newsecurl = '/'.$cid;
17103: $newsecurl =~ s/\_/\//g;
17104: if ($sec ne '') {
17105: $newsecurl.='/'.$sec;
17106: }
17107: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17108: if ($sec eq '') {
17109: $$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;
17110: } else {
17111: $$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;
17112: }
17113: }
17114: }
1.443 albertel 17115: }
17116: } else {
1.626 raeburn 17117: $$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 17118: $result = "error: incomplete course id\n";
17119: }
17120: return $result;
17121: }
17122:
1.1108 raeburn 17123: sub show_role_extent {
17124: my ($scope,$context,$role) = @_;
17125: $scope =~ s{^/}{};
17126: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17127: push(@courseroles,'co');
17128: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17129: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17130: $scope =~ s{/}{_};
17131: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17132: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17133: my ($audom,$auname) = split(/\//,$scope);
17134: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17135: &Apache::loncommon::plainname($auname,$audom).'</span>');
17136: } else {
17137: $scope =~ s{/$}{};
17138: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17139: &Apache::lonnet::domain($scope,'description').'</span>');
17140: }
17141: }
17142:
1.443 albertel 17143: ############################################################
17144: ############################################################
17145:
1.566 albertel 17146: sub check_clone {
1.578 raeburn 17147: my ($args,$linefeed) = @_;
1.566 albertel 17148: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17149: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17150: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17151: my $clonetitle;
17152: my @clonemsg;
1.566 albertel 17153: my $can_clone = 0;
1.944 raeburn 17154: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17155: if ($lctype ne 'community') {
17156: $lctype = 'course';
17157: }
1.566 albertel 17158: if ($clonehome eq 'no_host') {
1.944 raeburn 17159: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17160: push(@clonemsg,({
17161: mt => 'No new community created.',
17162: args => [],
17163: },
17164: {
17165: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17166: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17167: }));
1.908 raeburn 17168: } else {
1.1344 raeburn 17169: push(@clonemsg,({
17170: mt => 'No new course created.',
17171: args => [],
17172: },
17173: {
17174: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17175: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17176: }));
17177: }
1.566 albertel 17178: } else {
17179: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17180: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17181: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17182: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17183: push(@clonemsg,({
17184: mt => 'No new community created.',
17185: args => [],
17186: },
17187: {
17188: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17189: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17190: }));
17191: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17192: }
17193: }
1.1262 raeburn 17194: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17195: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17196: $can_clone = 1;
17197: } else {
1.1221 raeburn 17198: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17199: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17200: if ($clonehash{'cloners'} eq '') {
17201: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17202: if ($domdefs{'canclone'}) {
17203: unless ($domdefs{'canclone'} eq 'none') {
17204: if ($domdefs{'canclone'} eq 'domain') {
17205: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17206: $can_clone = 1;
17207: }
17208: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17209: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17210: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17211: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17212: $can_clone = 1;
17213: }
17214: }
17215: }
17216: }
1.578 raeburn 17217: } else {
1.1221 raeburn 17218: my @cloners = split(/,/,$clonehash{'cloners'});
17219: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17220: $can_clone = 1;
1.1221 raeburn 17221: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17222: $can_clone = 1;
1.1225 raeburn 17223: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17224: $can_clone = 1;
1.1221 raeburn 17225: }
17226: unless ($can_clone) {
1.1225 raeburn 17227: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17228: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17229: my (%gotdomdefaults,%gotcodedefaults);
17230: foreach my $cloner (@cloners) {
17231: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17232: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17233: my (%codedefaults,@code_order);
17234: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17235: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17236: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17237: }
17238: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17239: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17240: }
17241: } else {
17242: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17243: \%codedefaults,
17244: \@code_order);
17245: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17246: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17247: }
17248: if (@code_order > 0) {
17249: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17250: $cloner,$clonehash{'internal.coursecode'},
17251: $args->{'crscode'})) {
17252: $can_clone = 1;
17253: last;
17254: }
17255: }
17256: }
17257: }
17258: }
1.1225 raeburn 17259: }
17260: }
17261: unless ($can_clone) {
17262: my $ccrole = 'cc';
17263: if ($args->{'crstype'} eq 'Community') {
17264: $ccrole = 'co';
17265: }
17266: my %roleshash =
17267: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17268: $args->{'ccdomain'},
17269: 'userroles',['active'],[$ccrole],
17270: [$args->{'clonedomain'}]);
17271: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17272: $can_clone = 1;
17273: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17274: $args->{'ccuname'},$args->{'ccdomain'})) {
17275: $can_clone = 1;
1.1221 raeburn 17276: }
17277: }
17278: unless ($can_clone) {
17279: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17280: push(@clonemsg,({
17281: mt => 'No new community created.',
17282: args => [],
17283: },
17284: {
17285: 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]).',
17286: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17287: }));
1.942 raeburn 17288: } else {
1.1344 raeburn 17289: push(@clonemsg,({
17290: mt => 'No new course created.',
17291: args => [],
17292: },
17293: {
17294: 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]).',
17295: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17296: }));
1.1221 raeburn 17297: }
1.566 albertel 17298: }
1.578 raeburn 17299: }
1.566 albertel 17300: }
1.1344 raeburn 17301: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17302: }
17303:
1.444 albertel 17304: sub construct_course {
1.1262 raeburn 17305: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17306: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17307: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17308: my $linefeed = '<br />'."\n";
17309: if ($context eq 'auto') {
17310: $linefeed = "\n";
17311: }
1.566 albertel 17312:
17313: #
17314: # Are we cloning?
17315: #
1.1344 raeburn 17316: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17317: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17318: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17319: if (!$can_clone) {
1.1344 raeburn 17320: return (0,$outcome,$clonemsgref);
1.566 albertel 17321: }
17322: }
17323:
1.444 albertel 17324: #
17325: # Open course
17326: #
1.1239 raeburn 17327: my $showncrstype;
17328: if ($args->{'crstype'} eq 'Placement') {
17329: $showncrstype = 'placement test';
17330: } else {
17331: $showncrstype = lc($args->{'crstype'});
17332: }
1.444 albertel 17333: my %cenv=();
17334: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17335: $args->{'cdescr'},
17336: $args->{'curl'},
17337: $args->{'course_home'},
17338: $args->{'nonstandard'},
17339: $args->{'crscode'},
17340: $args->{'ccuname'}.':'.
17341: $args->{'ccdomain'},
1.882 raeburn 17342: $args->{'crstype'},
1.1344 raeburn 17343: $cnum,$context,$category,
17344: $callercontext);
1.444 albertel 17345:
17346: # Note: The testing routines depend on this being output; see
17347: # Utils::Course. This needs to at least be output as a comment
17348: # if anyone ever decides to not show this, and Utils::Course::new
17349: # will need to be suitably modified.
1.1344 raeburn 17350: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17351: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17352: } else {
17353: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17354: }
1.943 raeburn 17355: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17356: return (0,$outcome,$clonemsgref);
1.943 raeburn 17357: }
17358:
1.444 albertel 17359: #
17360: # Check if created correctly
17361: #
1.479 albertel 17362: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17363: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17364: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17365: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17366: $outcome .= &mt_user($user_lh,
17367: 'Course creation failed, unrecognized course home server.');
17368: } else {
17369: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17370: }
17371: $outcome .= $linefeed;
17372: return (0,$outcome,$clonemsgref);
1.943 raeburn 17373: }
1.541 raeburn 17374: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17375:
1.444 albertel 17376: #
1.566 albertel 17377: # Do the cloning
17378: #
1.1344 raeburn 17379: my @clonemsg;
1.566 albertel 17380: if ($can_clone && $cloneid) {
1.1344 raeburn 17381: push(@clonemsg,
17382: {
17383: mt => 'Created [_1] by cloning from [_2]',
17384: args => [$showncrstype,$clonetitle],
17385: });
1.566 albertel 17386: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17387: # Copy all files
1.1344 raeburn 17388: my @info =
17389: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17390: $args->{'dateshift'},$args->{'crscode'},
17391: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17392: $args->{'tinyurls'});
17393: if (@info) {
17394: push(@clonemsg,@info);
17395: }
1.444 albertel 17396: # Restore URL
1.566 albertel 17397: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17398: # Restore title
1.566 albertel 17399: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17400: # Restore creation date, creator and creation context.
17401: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17402: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17403: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17404: # Mark as cloned
1.566 albertel 17405: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17406: # Need to clone grading mode
17407: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17408: $cenv{'grading'}=$newenv{'grading'};
17409: # Do not clone these environment entries
17410: &Apache::lonnet::del('environment',
17411: ['default_enrollment_start_date',
17412: 'default_enrollment_end_date',
17413: 'question.email',
17414: 'policy.email',
17415: 'comment.email',
17416: 'pch.users.denied',
1.725 raeburn 17417: 'plc.users.denied',
17418: 'hidefromcat',
1.1121 raeburn 17419: 'checkforpriv',
1.1355 raeburn 17420: 'categories'],
1.638 www 17421: $$crsudom,$$crsunum);
1.1170 raeburn 17422: if ($args->{'textbook'}) {
17423: $cenv{'internal.textbook'} = $args->{'textbook'};
17424: }
1.444 albertel 17425: }
1.566 albertel 17426:
1.444 albertel 17427: #
17428: # Set environment (will override cloned, if existing)
17429: #
17430: my @sections = ();
17431: my @xlists = ();
17432: if ($args->{'crstype'}) {
17433: $cenv{'type'}=$args->{'crstype'};
17434: }
1.1371 raeburn 17435: if ($args->{'lti'}) {
17436: $cenv{'internal.lti'}=$args->{'lti'};
17437: }
1.444 albertel 17438: if ($args->{'crsid'}) {
17439: $cenv{'courseid'}=$args->{'crsid'};
17440: }
17441: if ($args->{'crscode'}) {
17442: $cenv{'internal.coursecode'}=$args->{'crscode'};
17443: }
17444: if ($args->{'crsquota'} ne '') {
17445: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17446: } else {
17447: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17448: }
17449: if ($args->{'ccuname'}) {
17450: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17451: ':'.$args->{'ccdomain'};
17452: } else {
17453: $cenv{'internal.courseowner'} = $args->{'curruser'};
17454: }
1.1116 raeburn 17455: if ($args->{'defaultcredits'}) {
17456: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17457: }
1.444 albertel 17458: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17459: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17460: if ($args->{'crssections'}) {
17461: $cenv{'internal.sectionnums'} = '';
17462: if ($args->{'crssections'} =~ m/,/) {
17463: @sections = split/,/,$args->{'crssections'};
17464: } else {
17465: $sections[0] = $args->{'crssections'};
17466: }
17467: if (@sections > 0) {
17468: foreach my $item (@sections) {
17469: my ($sec,$gp) = split/:/,$item;
17470: my $class = $args->{'crscode'}.$sec;
17471: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17472: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17473: if ($addcheck eq 'ok') {
17474: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17475: push(@oklcsecs,$gp);
17476: }
17477: } else {
1.1263 raeburn 17478: push(@badclasses,$class);
1.444 albertel 17479: }
17480: }
17481: $cenv{'internal.sectionnums'} =~ s/,$//;
17482: }
17483: }
17484: # do not hide course coordinator from staff listing,
17485: # even if privileged
17486: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17487: # add course coordinator's domain to domains to check for privileged users
17488: # if different to course domain
17489: if ($$crsudom ne $args->{'ccdomain'}) {
17490: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17491: }
1.444 albertel 17492: # add crosslistings
17493: if ($args->{'crsxlist'}) {
17494: $cenv{'internal.crosslistings'}='';
17495: if ($args->{'crsxlist'} =~ m/,/) {
17496: @xlists = split/,/,$args->{'crsxlist'};
17497: } else {
17498: $xlists[0] = $args->{'crsxlist'};
17499: }
17500: if (@xlists > 0) {
17501: foreach my $item (@xlists) {
17502: my ($xl,$gp) = split/:/,$item;
17503: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17504: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17505: if ($addcheck eq 'ok') {
17506: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17507: push(@oklcsecs,$gp);
17508: }
17509: } else {
1.1263 raeburn 17510: push(@badclasses,$xl);
1.444 albertel 17511: }
17512: }
17513: $cenv{'internal.crosslistings'} =~ s/,$//;
17514: }
17515: }
17516: if ($args->{'autoadds'}) {
17517: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17518: }
17519: if ($args->{'autodrops'}) {
17520: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17521: }
17522: # check for notification of enrollment changes
17523: my @notified = ();
17524: if ($args->{'notify_owner'}) {
17525: if ($args->{'ccuname'} ne '') {
17526: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17527: }
17528: }
17529: if ($args->{'notify_dc'}) {
17530: if ($uname ne '') {
1.630 raeburn 17531: push(@notified,$uname.':'.$udom);
1.444 albertel 17532: }
17533: }
17534: if (@notified > 0) {
17535: my $notifylist;
17536: if (@notified > 1) {
17537: $notifylist = join(',',@notified);
17538: } else {
17539: $notifylist = $notified[0];
17540: }
17541: $cenv{'internal.notifylist'} = $notifylist;
17542: }
17543: if (@badclasses > 0) {
17544: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17545: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17546: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17547: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17548: );
1.1264 raeburn 17549: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17550: &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 17551: if ($context eq 'auto') {
17552: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17553: } else {
1.566 albertel 17554: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17555: }
17556: foreach my $item (@badclasses) {
1.541 raeburn 17557: if ($context eq 'auto') {
1.1261 raeburn 17558: $outcome .= " - $item\n";
1.541 raeburn 17559: } else {
1.1261 raeburn 17560: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17561: }
1.1261 raeburn 17562: }
17563: if ($context eq 'auto') {
17564: $outcome .= $linefeed;
17565: } else {
17566: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17567: }
1.444 albertel 17568: }
17569: if ($args->{'no_end_date'}) {
17570: $args->{'endaccess'} = 0;
17571: }
1.1412 raeburn 17572: # If an official course with institutional sections is created by cloning
17573: # an existing course, section-specific hiding of course totals in student's
17574: # view of grades as copied from cloned course, will be checked for valid
17575: # sections.
17576: if (($can_clone && $cloneid) &&
17577: ($cenv{'internal.coursecode'} ne '') &&
17578: ($cenv{'grading'} eq 'standard') &&
17579: ($cenv{'hidetotals'} ne '') &&
17580: ($cenv{'hidetotals'} ne 'all')) {
17581: my @hidesecs;
17582: my $deletehidetotals;
17583: if (@oklcsecs) {
17584: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17585: if (grep(/^\Q$sec$/,@oklcsecs)) {
17586: push(@hidesecs,$sec);
17587: }
17588: }
17589: if (@hidesecs) {
17590: $cenv{'hidetotals'} = join(',',@hidesecs);
17591: } else {
17592: $deletehidetotals = 1;
17593: }
17594: } else {
17595: $deletehidetotals = 1;
17596: }
17597: if ($deletehidetotals) {
17598: delete($cenv{'hidetotals'});
17599: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17600: }
17601: }
1.444 albertel 17602: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17603: $cenv{'internal.autoend'}=$args->{'enrollend'};
17604: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17605: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17606: if ($args->{'showphotos'}) {
17607: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17608: }
17609: $cenv{'internal.authtype'} = $args->{'authtype'};
17610: $cenv{'internal.autharg'} = $args->{'autharg'};
17611: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17612: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17613: 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');
17614: if ($context eq 'auto') {
17615: $outcome .= $krb_msg;
17616: } else {
1.566 albertel 17617: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17618: }
17619: $outcome .= $linefeed;
1.444 albertel 17620: }
17621: }
17622: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17623: if ($args->{'setpolicy'}) {
17624: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17625: }
17626: if ($args->{'setcontent'}) {
17627: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17628: }
1.1251 raeburn 17629: if ($args->{'setcomment'}) {
17630: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17631: }
1.444 albertel 17632: }
17633: if ($args->{'reshome'}) {
17634: $cenv{'reshome'}=$args->{'reshome'}.'/';
17635: $cenv{'reshome'}=~s/\/+$/\//;
17636: }
17637: #
17638: # course has keyed access
17639: #
17640: if ($args->{'setkeys'}) {
17641: $cenv{'keyaccess'}='yes';
17642: }
17643: # if specified, key authority is not course, but user
17644: # only active if keyaccess is yes
17645: if ($args->{'keyauth'}) {
1.487 albertel 17646: my ($user,$domain) = split(':',$args->{'keyauth'});
17647: $user = &LONCAPA::clean_username($user);
17648: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17649: if ($user ne '' && $domain ne '') {
1.487 albertel 17650: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17651: }
17652: }
17653:
1.1166 raeburn 17654: #
1.1167 raeburn 17655: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17656: #
17657: if ($args->{'uniquecode'}) {
17658: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17659: if ($code) {
17660: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17661: my %crsinfo =
17662: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17663: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17664: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17665: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17666: }
1.1166 raeburn 17667: if (ref($coderef)) {
17668: $$coderef = $code;
17669: }
17670: }
17671: }
17672:
1.444 albertel 17673: if ($args->{'disresdis'}) {
17674: $cenv{'pch.roles.denied'}='st';
17675: }
17676: if ($args->{'disablechat'}) {
17677: $cenv{'plc.roles.denied'}='st';
17678: }
17679:
17680: # Record we've not yet viewed the Course Initialization Helper for this
17681: # course
17682: $cenv{'course.helper.not.run'} = 1;
17683: #
17684: # Use new Randomseed
17685: #
17686: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17687: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17688: #
17689: # The encryption code and receipt prefix for this course
17690: #
17691: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17692: $cenv{'internal.encpref'}=100+int(9*rand(99));
17693: #
17694: # By default, use standard grading
17695: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17696:
1.541 raeburn 17697: $outcome .= $linefeed.&mt('Setting environment').': '.
17698: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17699: #
17700: # Open all assignments
17701: #
17702: if ($args->{'openall'}) {
1.1341 raeburn 17703: my $opendate = time;
17704: if ($args->{'openallfrom'} =~ /^\d+$/) {
17705: $opendate = $args->{'openallfrom'};
17706: }
1.444 albertel 17707: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17708: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17709: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17710: $outcome .= &mt('All assignments open starting [_1]',
17711: &Apache::lonlocal::locallocaltime($opendate)).': '.
17712: &Apache::lonnet::cput
17713: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17714: }
17715: #
17716: # Set first page
17717: #
17718: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17719: || ($cloneid)) {
17720: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17721:
17722: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17723: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17724:
1.444 albertel 17725: $outcome .= ($fatal?$errtext:'read ok').' - ';
17726: my $title; my $url;
17727: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17728: $title=&mt('Syllabus');
1.444 albertel 17729: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17730: } else {
1.963 raeburn 17731: $title=&mt('Table of Contents');
1.444 albertel 17732: $url='/adm/navmaps';
17733: }
1.445 albertel 17734:
17735: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17736: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17737:
17738: if ($errtext) { $fatal=2; }
1.541 raeburn 17739: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17740: }
1.566 albertel 17741:
1.1237 raeburn 17742: #
17743: # Set params for Placement Tests
17744: #
1.1239 raeburn 17745: if ($args->{'crstype'} eq 'Placement') {
17746: my %storecontent;
17747: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17748: my %defaults = (
17749: buttonshide => { value => 'yes',
17750: type => 'string_yesno',},
17751: type => { value => 'randomizetry',
17752: type => 'string_questiontype',},
17753: maxtries => { value => 1,
17754: type => 'int_pos',},
17755: problemstatus => { value => 'no',
17756: type => 'string_problemstatus',},
17757: );
17758: foreach my $key (keys(%defaults)) {
17759: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17760: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17761: }
1.1237 raeburn 17762: &Apache::lonnet::cput
17763: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17764: }
17765:
1.1344 raeburn 17766: return (1,$outcome,\@clonemsg);
1.444 albertel 17767: }
17768:
1.1166 raeburn 17769: sub make_unique_code {
17770: my ($cdom,$cnum) = @_;
17771: # get lock on uniquecodes db
17772: my $lockhash = {
17773: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17774: ':'.$env{'user.domain'},
17775: };
17776: my $tries = 0;
17777: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17778: my ($code,$error);
17779:
17780: while (($gotlock ne 'ok') && ($tries<3)) {
17781: $tries ++;
17782: sleep 1;
17783: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17784: }
17785: if ($gotlock eq 'ok') {
17786: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17787: my $gotcode;
17788: my $attempts = 0;
17789: while ((!$gotcode) && ($attempts < 100)) {
17790: $code = &generate_code();
17791: if (!exists($currcodes{$code})) {
17792: $gotcode = 1;
17793: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17794: $error = 'nostore';
17795: }
17796: }
17797: $attempts ++;
17798: }
17799: my @del_lock = ($cnum."\0".'uniquecodes');
17800: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17801: } else {
17802: $error = 'nolock';
17803: }
17804: return ($code,$error);
17805: }
17806:
17807: sub generate_code {
17808: my $code;
17809: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17810: for (my $i=0; $i<6; $i++) {
17811: my $lettnum = int (rand 2);
17812: my $item = '';
17813: if ($lettnum) {
17814: $item = $letts[int( rand(18) )];
17815: } else {
17816: $item = 1+int( rand(8) );
17817: }
17818: $code .= $item;
17819: }
17820: return $code;
17821: }
17822:
1.444 albertel 17823: ############################################################
17824: ############################################################
17825:
1.1237 raeburn 17826: # Community, Course and Placement Test
1.378 raeburn 17827: sub course_type {
17828: my ($cid) = @_;
17829: if (!defined($cid)) {
17830: $cid = $env{'request.course.id'};
17831: }
1.404 albertel 17832: if (defined($env{'course.'.$cid.'.type'})) {
17833: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17834: } else {
17835: return 'Course';
1.377 raeburn 17836: }
17837: }
1.156 albertel 17838:
1.406 raeburn 17839: sub group_term {
17840: my $crstype = &course_type();
17841: my %names = (
17842: 'Course' => 'group',
1.865 raeburn 17843: 'Community' => 'group',
1.1237 raeburn 17844: 'Placement' => 'group',
1.406 raeburn 17845: );
17846: return $names{$crstype};
17847: }
17848:
1.902 raeburn 17849: sub course_types {
1.1310 raeburn 17850: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17851: my %typename = (
17852: official => 'Official course',
17853: unofficial => 'Unofficial course',
17854: community => 'Community',
1.1165 raeburn 17855: textbook => 'Textbook course',
1.1237 raeburn 17856: placement => 'Placement test',
1.1310 raeburn 17857: lti => 'LTI provider',
1.902 raeburn 17858: );
17859: return (\@types,\%typename);
17860: }
17861:
1.156 albertel 17862: sub icon {
17863: my ($file)=@_;
1.505 albertel 17864: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17865: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17866: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17867: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17868: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17869: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17870: $curfext.".gif") {
17871: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17872: $curfext.".gif";
17873: }
17874: }
1.249 albertel 17875: return &lonhttpdurl($iconname);
1.154 albertel 17876: }
1.84 albertel 17877:
1.575 albertel 17878: sub lonhttpdurl {
1.692 www 17879: #
17880: # Had been used for "small fry" static images on separate port 8080.
17881: # Modify here if lightweight http functionality desired again.
17882: # Currently eliminated due to increasing firewall issues.
17883: #
1.575 albertel 17884: my ($url)=@_;
1.692 www 17885: return $url;
1.215 albertel 17886: }
17887:
1.213 albertel 17888: sub connection_aborted {
17889: my ($r)=@_;
17890: $r->print(" ");$r->rflush();
17891: my $c = $r->connection;
17892: return $c->aborted();
17893: }
17894:
1.221 foxr 17895: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17896: # strings as 'strings'.
17897: sub escape_single {
1.221 foxr 17898: my ($input) = @_;
1.223 albertel 17899: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17900: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17901: return $input;
17902: }
1.223 albertel 17903:
1.222 foxr 17904: # Same as escape_single, but escape's "'s This
17905: # can be used for "strings"
17906: sub escape_double {
17907: my ($input) = @_;
17908: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17909: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17910: return $input;
17911: }
1.223 albertel 17912:
1.222 foxr 17913: # Escapes the last element of a full URL.
17914: sub escape_url {
17915: my ($url) = @_;
1.238 raeburn 17916: my @urlslices = split(/\//, $url,-1);
1.369 www 17917: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17918: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17919: }
1.462 albertel 17920:
1.820 raeburn 17921: sub compare_arrays {
17922: my ($arrayref1,$arrayref2) = @_;
17923: my (@difference,%count);
17924: @difference = ();
17925: %count = ();
17926: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17927: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17928: foreach my $element (keys(%count)) {
17929: if ($count{$element} == 1) {
17930: push(@difference,$element);
17931: }
17932: }
17933: }
17934: return @difference;
17935: }
17936:
1.1322 raeburn 17937: sub lon_status_items {
17938: my %defaults = (
17939: E => 100,
17940: W => 4,
17941: N => 1,
1.1324 raeburn 17942: U => 5,
1.1322 raeburn 17943: threshold => 200,
17944: sysmail => 2500,
17945: );
17946: my %names = (
17947: E => 'Errors',
17948: W => 'Warnings',
17949: N => 'Notices',
1.1324 raeburn 17950: U => 'Unsent',
1.1322 raeburn 17951: );
17952: return (\%defaults,\%names);
17953: }
17954:
1.817 bisitz 17955: # -------------------------------------------------------- Initialize user login
1.462 albertel 17956: sub init_user_environment {
1.463 albertel 17957: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17958: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17959:
17960: my $public=($username eq 'public' && $domain eq 'public');
17961:
1.1415 raeburn 17962: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17963: $coauthorenv);
1.462 albertel 17964: my $now=time;
17965:
17966: if ($public) {
17967: my $max_public=100;
17968: my $oldest;
17969: my $oldest_time=0;
17970: for(my $next=1;$next<=$max_public;$next++) {
17971: if (-e $lonids."/publicuser_$next.id") {
17972: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17973: if ($mtime<$oldest_time || !$oldest_time) {
17974: $oldest_time=$mtime;
17975: $oldest=$next;
17976: }
17977: } else {
17978: $cookie="publicuser_$next";
17979: last;
17980: }
17981: }
17982: if (!$cookie) { $cookie="publicuser_$oldest"; }
17983: } else {
1.1275 raeburn 17984: # See if old ID present, if so, remove if this isn't a robot,
17985: # killing any existing non-robot sessions
1.463 albertel 17986: if (!$args->{'robot'}) {
17987: opendir(DIR,$lonids);
17988: while ($filename=readdir(DIR)) {
17989: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17990: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17991: &GDBM_READER(),0640)) {
1.1295 raeburn 17992: my $linkedfile;
1.1320 raeburn 17993: if (exists($oldenv{'user.linkedenv'})) {
17994: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17995: }
1.1320 raeburn 17996: untie(%oldenv);
17997: if (unlink("$lonids/$filename")) {
17998: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17999: if (-l "$lonids/$linkedfile.id") {
18000: unlink("$lonids/$linkedfile.id");
18001: }
1.1295 raeburn 18002: }
18003: }
18004: } else {
18005: unlink($lonids.'/'.$filename);
18006: }
1.463 albertel 18007: }
1.462 albertel 18008: }
1.463 albertel 18009: closedir(DIR);
1.1204 raeburn 18010: # If there is a undeleted lockfile for the user's paste buffer remove it.
18011: my $namespace = 'nohist_courseeditor';
18012: my $lockingkey = 'paste'."\0".'locked_num';
18013: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18014: $domain,$username);
18015: if (exists($lockhash{$lockingkey})) {
18016: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18017: unless ($delresult eq 'ok') {
18018: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18019: }
18020: }
1.462 albertel 18021: }
18022: # Give them a new cookie
1.463 albertel 18023: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18024: : $now.$$.int(rand(10000)));
1.463 albertel 18025: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18026:
18027: # Initialize roles
18028:
1.1414 raeburn 18029: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18030: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18031: }
18032: # ------------------------------------ Check browser type and MathML capability
18033:
1.1194 raeburn 18034: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18035: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18036:
18037: # ------------------------------------------------------------- Get environment
18038:
18039: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18040: my ($tmp) = keys(%userenv);
1.1275 raeburn 18041: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18042: undef(%userenv);
18043: }
18044: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18045: $form->{'interface'}=$userenv{'interface'};
18046: }
18047: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18048:
18049: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18050: foreach my $option ('interface','localpath','localres') {
18051: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18052: }
18053: # --------------------------------------------------------- Write first profile
18054:
18055: {
1.1350 raeburn 18056: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18057: my %initial_env =
18058: ("user.name" => $username,
18059: "user.domain" => $domain,
18060: "user.home" => $authhost,
18061: "browser.type" => $clientbrowser,
18062: "browser.version" => $clientversion,
18063: "browser.mathml" => $clientmathml,
18064: "browser.unicode" => $clientunicode,
18065: "browser.os" => $clientos,
1.1137 raeburn 18066: "browser.mobile" => $clientmobile,
1.1141 raeburn 18067: "browser.info" => $clientinfo,
1.1194 raeburn 18068: "browser.osversion" => $clientosversion,
1.462 albertel 18069: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18070: "request.course.fn" => '',
18071: "request.course.uri" => '',
18072: "request.course.sec" => '',
18073: "request.role" => 'cm',
18074: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18075: "request.host" => $ip,);
1.462 albertel 18076:
18077: if ($form->{'localpath'}) {
18078: $initial_env{"browser.localpath"} = $form->{'localpath'};
18079: $initial_env{"browser.localres"} = $form->{'localres'};
18080: }
18081:
18082: if ($form->{'interface'}) {
18083: $form->{'interface'}=~s/\W//gs;
18084: $initial_env{"browser.interface"} = $form->{'interface'};
18085: $env{'browser.interface'}=$form->{'interface'};
18086: }
18087:
1.1157 raeburn 18088: if ($form->{'iptoken'}) {
18089: my $lonhost = $r->dir_config('lonHostID');
18090: $initial_env{"user.noloadbalance"} = $lonhost;
18091: $env{'user.noloadbalance'} = $lonhost;
18092: }
18093:
1.1268 raeburn 18094: if ($form->{'noloadbalance'}) {
18095: my @hosts = &Apache::lonnet::current_machine_ids();
18096: my $hosthere = $form->{'noloadbalance'};
18097: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18098: $initial_env{"user.noloadbalance"} = $hosthere;
18099: $env{'user.noloadbalance'} = $hosthere;
18100: }
18101: }
18102:
1.1016 raeburn 18103: unless ($domain eq 'public') {
1.1273 raeburn 18104: my %is_adv = ( is_adv => $env{'user.adv'} );
18105: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18106:
1.1414 raeburn 18107: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18108: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18109: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18110: undef,\%userenv,\%domdef,\%is_adv);
18111: }
1.980 raeburn 18112:
1.1311 raeburn 18113: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18114: $userenv{'canrequest.'.$crstype} =
18115: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18116: 'reload','requestcourses',
18117: \%userenv,\%domdef,\%is_adv);
18118: }
1.724 raeburn 18119:
1.1418 raeburn 18120: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18121: (exists($userroles->{"user.role.au./$domain/"}))) {
18122: if ($userenv{'authoreditors'}) {
18123: $userenv{'editors'} = $userenv{'authoreditors'};
18124: } elsif ($domdef{'editors'} ne '') {
18125: $userenv{'editors'} = $domdef{'editors'};
18126: } else {
18127: $userenv{'editors'} = 'edit,xml';
18128: }
1.1431 raeburn 18129: if ($userenv{'authorarchive'}) {
18130: $userenv{'canarchive'} = 1;
18131: } elsif (($userenv{'authorarchive'} eq '') &&
18132: ($domdef{'archive'})) {
18133: $userenv{'canarchive'} = 1;
18134: }
1.1418 raeburn 18135: }
18136:
1.1273 raeburn 18137: $userenv{'canrequest.author'} =
18138: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18139: 'reload','requestauthor',
1.980 raeburn 18140: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18141: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18142: $domain,$username);
18143: my $reqstatus = $reqauthor{'author_status'};
18144: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18145: if (ref($reqauthor{'author'}) eq 'HASH') {
18146: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18147: $reqauthor{'author'}{'timestamp'};
18148: }
1.1092 raeburn 18149: }
1.1287 raeburn 18150: my ($types,$typename) = &course_types();
18151: if (ref($types) eq 'ARRAY') {
18152: my @options = ('approval','validate','autolimit');
18153: my $optregex = join('|',@options);
18154: my (%willtrust,%trustchecked);
18155: foreach my $type (@{$types}) {
18156: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18157: if ($dom_str ne '') {
18158: my $updatedstr = '';
18159: my @possdomains = split(',',$dom_str);
18160: foreach my $entry (@possdomains) {
18161: my ($extdom,$extopt) = split(':',$entry);
18162: unless ($trustchecked{$extdom}) {
18163: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18164: $trustchecked{$extdom} = 1;
18165: }
18166: if ($willtrust{$extdom}) {
18167: $updatedstr .= $entry.',';
18168: }
18169: }
18170: $updatedstr =~ s/,$//;
18171: if ($updatedstr) {
18172: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18173: } else {
18174: delete($userenv{'reqcrsotherdom.'.$type});
18175: }
18176: }
18177: }
18178: }
1.1092 raeburn 18179: }
1.462 albertel 18180: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18181:
1.462 albertel 18182: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18183: &GDBM_WRCREAT(),0640)) {
18184: &_add_to_env(\%disk_env,\%initial_env);
18185: &_add_to_env(\%disk_env,\%userenv,'environment.');
18186: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18187: if (ref($firstaccenv) eq 'HASH') {
18188: &_add_to_env(\%disk_env,$firstaccenv);
18189: }
18190: if (ref($timerintenv) eq 'HASH') {
18191: &_add_to_env(\%disk_env,$timerintenv);
18192: }
1.1414 raeburn 18193: if (ref($coauthorenv) eq 'HASH') {
18194: if (keys(%{$coauthorenv})) {
18195: &_add_to_env(\%disk_env,$coauthorenv);
18196: }
18197: }
1.463 albertel 18198: if (ref($args->{'extra_env'})) {
18199: &_add_to_env(\%disk_env,$args->{'extra_env'});
18200: }
1.462 albertel 18201: untie(%disk_env);
18202: } else {
1.705 tempelho 18203: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18204: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18205: return 'error: '.$!;
18206: }
18207: }
18208: $env{'request.role'}='cm';
18209: $env{'request.role.adv'}=$env{'user.adv'};
18210: $env{'browser.type'}=$clientbrowser;
18211:
18212: return $cookie;
18213:
18214: }
18215:
18216: sub _add_to_env {
18217: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18218: if (ref($env_data) eq 'HASH') {
18219: while (my ($key,$value) = each(%$env_data)) {
18220: $idf->{$prefix.$key} = $value;
18221: $env{$prefix.$key} = $value;
18222: }
1.462 albertel 18223: }
18224: }
18225:
1.685 tempelho 18226: # --- Get the symbolic name of a problem and the url
18227: sub get_symb {
18228: my ($request,$silent) = @_;
1.726 raeburn 18229: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18230: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18231: if ($symb eq '') {
18232: if (!$silent) {
1.1071 raeburn 18233: if (ref($request)) {
18234: $request->print("Unable to handle ambiguous references:$url:.");
18235: }
1.685 tempelho 18236: return ();
18237: }
18238: }
18239: &Apache::lonenc::check_decrypt(\$symb);
18240: return ($symb);
18241: }
18242:
18243: # --------------------------------------------------------------Get annotation
18244:
18245: sub get_annotation {
18246: my ($symb,$enc) = @_;
18247:
18248: my $key = $symb;
18249: if (!$enc) {
18250: $key =
18251: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18252: }
18253: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18254: return $annotation{$key};
18255: }
18256:
18257: sub clean_symb {
1.731 raeburn 18258: my ($symb,$delete_enc) = @_;
1.685 tempelho 18259:
18260: &Apache::lonenc::check_decrypt(\$symb);
18261: my $enc = $env{'request.enc'};
1.731 raeburn 18262: if ($delete_enc) {
1.730 raeburn 18263: delete($env{'request.enc'});
18264: }
1.685 tempelho 18265:
18266: return ($symb,$enc);
18267: }
1.462 albertel 18268:
1.1181 raeburn 18269: ############################################################
18270: ############################################################
18271:
18272: =pod
18273:
18274: =head1 Routines for building display used to search for courses
18275:
18276:
18277: =over 4
18278:
18279: =item * &build_filters()
18280:
18281: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18282: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18283: and quotacheck.pl
18284:
1.1181 raeburn 18285:
18286: Inputs:
18287:
18288: filterlist - anonymous array of fields to include as potential filters
18289:
18290: crstype - course type
18291:
18292: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18293: to pop-open a course selector (will contain "extra element").
18294:
18295: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18296:
18297: filter - anonymous hash of criteria and their values
18298:
18299: action - form action
18300:
18301: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18302:
1.1182 raeburn 18303: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18304:
18305: cloneruname - username of owner of new course who wants to clone
18306:
18307: clonerudom - domain of owner of new course who wants to clone
18308:
18309: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18310:
18311: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18312:
18313: codedom - domain
18314:
18315: formname - value of form element named "form".
18316:
18317: fixeddom - domain, if fixed.
18318:
18319: prevphase - value to assign to form element named "phase" when going back to the previous screen
18320:
18321: cnameelement - name of form element in form on opener page which will receive title of selected course
18322:
18323: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18324:
18325: cdomelement - name of form element in form on opener page which will receive domain of selected course
18326:
18327: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18328:
18329: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18330:
18331: clonewarning - warning message about missing information for intended course owner when DC creates a course
18332:
1.1182 raeburn 18333:
1.1181 raeburn 18334: Returns: $output - HTML for display of search criteria, and hidden form elements.
18335:
1.1182 raeburn 18336:
1.1181 raeburn 18337: Side Effects: None
18338:
18339: =cut
18340:
18341: # ---------------------------------------------- search for courses based on last activity etc.
18342:
18343: sub build_filters {
18344: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18345: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18346: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18347: $cnameelement,$cnumelement,$cdomelement,$setroles,
18348: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18349: my ($list,$jscript);
1.1181 raeburn 18350: my $onchange = 'javascript:updateFilters(this)';
18351: my ($domainselectform,$sincefilterform,$createdfilterform,
18352: $ownerdomselectform,$persondomselectform,$instcodeform,
18353: $typeselectform,$instcodetitle);
18354: if ($formname eq '') {
18355: $formname = $caller;
18356: }
18357: foreach my $item (@{$filterlist}) {
18358: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18359: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18360: if ($item eq 'domainfilter') {
18361: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18362: } elsif ($item eq 'coursefilter') {
18363: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18364: } elsif ($item eq 'ownerfilter') {
18365: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18366: } elsif ($item eq 'ownerdomfilter') {
18367: $filter->{'ownerdomfilter'} =
18368: &LONCAPA::clean_domain($filter->{$item});
18369: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18370: 'ownerdomfilter',1);
18371: } elsif ($item eq 'personfilter') {
18372: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18373: } elsif ($item eq 'persondomfilter') {
18374: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18375: 'persondomfilter',1);
18376: } else {
18377: $filter->{$item} =~ s/\W//g;
18378: }
18379: if (!$filter->{$item}) {
18380: $filter->{$item} = '';
18381: }
18382: }
18383: if ($item eq 'domainfilter') {
18384: my $allow_blank = 1;
18385: if ($formname eq 'portform') {
18386: $allow_blank=0;
18387: } elsif ($formname eq 'studentform') {
18388: $allow_blank=0;
18389: }
18390: if ($fixeddom) {
18391: $domainselectform = '<input type="hidden" name="domainfilter"'.
18392: ' value="'.$codedom.'" />'.
18393: &Apache::lonnet::domain($codedom,'description');
18394: } else {
18395: $domainselectform = &select_dom_form($filter->{$item},
18396: 'domainfilter',
18397: $allow_blank,'',$onchange);
18398: }
18399: } else {
18400: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18401: }
18402: }
18403:
18404: # last course activity filter and selection
18405: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18406:
18407: # course created filter and selection
18408: if (exists($filter->{'createdfilter'})) {
18409: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18410: }
18411:
1.1239 raeburn 18412: my $prefix = $crstype;
18413: if ($crstype eq 'Placement') {
18414: $prefix = 'Placement Test'
18415: }
1.1181 raeburn 18416: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18417: 'cac' => "$prefix Activity",
18418: 'ccr' => "$prefix Created",
18419: 'cde' => "$prefix Title",
18420: 'cdo' => "$prefix Domain",
1.1181 raeburn 18421: 'ins' => 'Institutional Code',
18422: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18423: 'cow' => "$prefix Owner/Co-owner",
18424: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18425: 'cog' => 'Type',
18426: );
18427:
18428: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18429: my $typeval = 'Course';
18430: if ($crstype eq 'Community') {
18431: $typeval = 'Community';
1.1239 raeburn 18432: } elsif ($crstype eq 'Placement') {
18433: $typeval = 'Placement';
1.1181 raeburn 18434: }
18435: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18436: } else {
18437: $typeselectform = '<select name="type" size="1"';
18438: if ($onchange) {
18439: $typeselectform .= ' onchange="'.$onchange.'"';
18440: }
18441: $typeselectform .= '>'."\n";
1.1237 raeburn 18442: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18443: my $shown;
18444: if ($posstype eq 'Placement') {
18445: $shown = &mt('Placement Test');
18446: } else {
18447: $shown = &mt($posstype);
18448: }
1.1181 raeburn 18449: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18450: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18451: }
18452: $typeselectform.="</select>";
18453: }
18454:
18455: my ($cloneableonlyform,$cloneabletitle);
18456: if (exists($filter->{'cloneableonly'})) {
18457: my $cloneableon = '';
18458: my $cloneableoff = ' checked="checked"';
18459: if ($filter->{'cloneableonly'}) {
18460: $cloneableon = $cloneableoff;
18461: $cloneableoff = '';
18462: }
18463: $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>';
18464: if ($formname eq 'ccrs') {
1.1187 bisitz 18465: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18466: } else {
18467: $cloneabletitle = &mt('Cloneable by you');
18468: }
18469: }
18470: my $officialjs;
18471: if ($crstype eq 'Course') {
18472: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18473: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18474: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18475: if ($codedom) {
1.1181 raeburn 18476: $officialjs = 1;
18477: ($instcodeform,$jscript,$$numtitlesref) =
18478: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18479: $officialjs,$codetitlesref);
18480: if ($jscript) {
1.1182 raeburn 18481: $jscript = '<script type="text/javascript">'."\n".
18482: '// <![CDATA['."\n".
18483: $jscript."\n".
18484: '// ]]>'."\n".
18485: '</script>'."\n";
1.1181 raeburn 18486: }
18487: }
18488: if ($instcodeform eq '') {
18489: $instcodeform =
18490: '<input type="text" name="instcodefilter" size="10" value="'.
18491: $list->{'instcodefilter'}.'" />';
18492: $instcodetitle = $lt{'ins'};
18493: } else {
18494: $instcodetitle = $lt{'inc'};
18495: }
18496: if ($fixeddom) {
18497: $instcodetitle .= '<br />('.$codedom.')';
18498: }
18499: }
18500: }
18501: my $output = qq|
18502: <form method="post" name="filterpicker" action="$action">
18503: <input type="hidden" name="form" value="$formname" />
18504: |;
18505: if ($formname eq 'modifycourse') {
18506: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18507: '<input type="hidden" name="prevphase" value="'.
18508: $prevphase.'" />'."\n";
1.1198 musolffc 18509: } elsif ($formname eq 'quotacheck') {
18510: $output .= qq|
18511: <input type="hidden" name="sortby" value="" />
18512: <input type="hidden" name="sortorder" value="" />
18513: |;
18514: } else {
1.1181 raeburn 18515: my $name_input;
18516: if ($cnameelement ne '') {
18517: $name_input = '<input type="hidden" name="cnameelement" value="'.
18518: $cnameelement.'" />';
18519: }
18520: $output .= qq|
1.1182 raeburn 18521: <input type="hidden" name="cnumelement" value="$cnumelement" />
18522: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18523: $name_input
18524: $roleelement
18525: $multelement
18526: $typeelement
18527: |;
18528: if ($formname eq 'portform') {
18529: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18530: }
18531: }
18532: if ($fixeddom) {
18533: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18534: }
18535: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18536: if ($sincefilterform) {
18537: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18538: .$sincefilterform
18539: .&Apache::lonhtmlcommon::row_closure();
18540: }
18541: if ($createdfilterform) {
18542: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18543: .$createdfilterform
18544: .&Apache::lonhtmlcommon::row_closure();
18545: }
18546: if ($domainselectform) {
18547: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18548: .$domainselectform
18549: .&Apache::lonhtmlcommon::row_closure();
18550: }
18551: if ($typeselectform) {
18552: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18553: $output .= $typeselectform;
18554: } else {
18555: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18556: .$typeselectform
18557: .&Apache::lonhtmlcommon::row_closure();
18558: }
18559: }
18560: if ($instcodeform) {
18561: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18562: .$instcodeform
18563: .&Apache::lonhtmlcommon::row_closure();
18564: }
18565: if (exists($filter->{'ownerfilter'})) {
18566: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18567: '<table><tr><td>'.&mt('Username').'<br />'.
18568: '<input type="text" name="ownerfilter" size="20" value="'.
18569: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18570: $ownerdomselectform.'</td></tr></table>'.
18571: &Apache::lonhtmlcommon::row_closure();
18572: }
18573: if (exists($filter->{'personfilter'})) {
18574: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18575: '<table><tr><td>'.&mt('Username').'<br />'.
18576: '<input type="text" name="personfilter" size="20" value="'.
18577: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18578: $persondomselectform.'</td></tr></table>'.
18579: &Apache::lonhtmlcommon::row_closure();
18580: }
18581: if (exists($filter->{'coursefilter'})) {
18582: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18583: .'<input type="text" name="coursefilter" size="25" value="'
18584: .$list->{'coursefilter'}.'" />'
18585: .&Apache::lonhtmlcommon::row_closure();
18586: }
18587: if ($cloneableonlyform) {
18588: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18589: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18590: }
18591: if (exists($filter->{'descriptfilter'})) {
18592: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18593: .'<input type="text" name="descriptfilter" size="40" value="'
18594: .$list->{'descriptfilter'}.'" />'
18595: .&Apache::lonhtmlcommon::row_closure(1);
18596: }
18597: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18598: '<input type="hidden" name="updater" value="" />'."\n".
18599: '<input type="submit" name="gosearch" value="'.
18600: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18601: return $jscript.$clonewarning.$output;
18602: }
18603:
18604: =pod
18605:
18606: =item * &timebased_select_form()
18607:
1.1182 raeburn 18608: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18609: filter e.g., Course Activity, Course Created, when searching for courses
18610: or communities
18611:
18612: Inputs:
18613:
18614: item - name of form element (sincefilter or createdfilter)
18615:
18616: filter - anonymous hash of criteria and their values
18617:
18618: Returns: HTML for a select box contained a blank, then six time selections,
18619: with value set in incoming form variables currently selected.
18620:
18621: Side Effects: None
18622:
18623: =cut
18624:
18625: sub timebased_select_form {
18626: my ($item,$filter) = @_;
18627: if (ref($filter) eq 'HASH') {
18628: $filter->{$item} =~ s/[^\d-]//g;
18629: if (!$filter->{$item}) { $filter->{$item}=-1; }
18630: return &select_form(
18631: $filter->{$item},
18632: $item,
18633: { '-1' => '',
18634: '86400' => &mt('today'),
18635: '604800' => &mt('last week'),
18636: '2592000' => &mt('last month'),
18637: '7776000' => &mt('last three months'),
18638: '15552000' => &mt('last six months'),
18639: '31104000' => &mt('last year'),
18640: 'select_form_order' =>
18641: ['-1','86400','604800','2592000','7776000',
18642: '15552000','31104000']});
18643: }
18644: }
18645:
18646: =pod
18647:
18648: =item * &js_changer()
18649:
18650: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18651: when course type or domain is changed, and also to hide 'Searching ...' on
18652: page load completion for page showing search result.
1.1181 raeburn 18653:
18654: Inputs: None
18655:
1.1183 raeburn 18656: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18657:
18658: Side Effects: None
18659:
18660: =cut
18661:
18662: sub js_changer {
18663: return <<ENDJS;
18664: <script type="text/javascript">
18665: // <![CDATA[
18666: function updateFilters(caller) {
18667: if (typeof(caller) != "undefined") {
18668: document.filterpicker.updater.value = caller.name;
18669: }
18670: document.filterpicker.submit();
18671: }
1.1183 raeburn 18672:
18673: function hideSearching() {
18674: if (document.getElementById('searching')) {
18675: document.getElementById('searching').style.display = 'none';
18676: }
18677: return;
18678: }
18679:
1.1181 raeburn 18680: // ]]>
18681: </script>
18682:
18683: ENDJS
18684: }
18685:
18686: =pod
18687:
1.1182 raeburn 18688: =item * &search_courses()
18689:
18690: Process selected filters form course search form and pass to lonnet::courseiddump
18691: to retrieve a hash for which keys are courseIDs which match the selected filters.
18692:
18693: Inputs:
18694:
18695: dom - domain being searched
18696:
18697: type - course type ('Course' or 'Community' or '.' if any).
18698:
18699: filter - anonymous hash of criteria and their values
18700:
18701: numtitles - for institutional codes - number of categories
18702:
18703: cloneruname - optional username of new course owner
18704:
18705: clonerudom - optional domain of new course owner
18706:
1.1221 raeburn 18707: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18708: (used when DC is using course creation form)
18709:
18710: codetitles - reference to array of titles of components in institutional codes (official courses).
18711:
1.1221 raeburn 18712: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18713: (and so can clone automatically)
18714:
18715: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18716:
18717: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18718: courses to clone
1.1182 raeburn 18719:
18720: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18721:
18722:
18723: Side Effects: None
18724:
18725: =cut
18726:
18727:
18728: sub search_courses {
1.1221 raeburn 18729: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18730: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18731: my (%courses,%showcourses,$cloner);
18732: if (($filter->{'ownerfilter'} ne '') ||
18733: ($filter->{'ownerdomfilter'} ne '')) {
18734: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18735: $filter->{'ownerdomfilter'};
18736: }
18737: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18738: if (!$filter->{$item}) {
18739: $filter->{$item}='.';
18740: }
18741: }
18742: my $now = time;
18743: my $timefilter =
18744: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18745: my ($createdbefore,$createdafter);
18746: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18747: $createdbefore = $now;
18748: $createdafter = $now-$filter->{'createdfilter'};
18749: }
18750: my ($instcodefilter,$regexpok);
18751: if ($numtitles) {
18752: if ($env{'form.official'} eq 'on') {
18753: $instcodefilter =
18754: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18755: $regexpok = 1;
18756: } elsif ($env{'form.official'} eq 'off') {
18757: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18758: unless ($instcodefilter eq '') {
18759: $regexpok = -1;
18760: }
18761: }
18762: } else {
18763: $instcodefilter = $filter->{'instcodefilter'};
18764: }
18765: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18766: if ($type eq '') { $type = '.'; }
18767:
18768: if (($clonerudom ne '') && ($cloneruname ne '')) {
18769: $cloner = $cloneruname.':'.$clonerudom;
18770: }
18771: %courses = &Apache::lonnet::courseiddump($dom,
18772: $filter->{'descriptfilter'},
18773: $timefilter,
18774: $instcodefilter,
18775: $filter->{'combownerfilter'},
18776: $filter->{'coursefilter'},
18777: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18778: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18779: $filter->{'cloneableonly'},
18780: $createdbefore,$createdafter,undef,
1.1221 raeburn 18781: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18782: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18783: my $ccrole;
18784: if ($type eq 'Community') {
18785: $ccrole = 'co';
18786: } else {
18787: $ccrole = 'cc';
18788: }
18789: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18790: $filter->{'persondomfilter'},
18791: 'userroles',undef,
18792: [$ccrole,'in','ad','ep','ta','cr'],
18793: $dom);
18794: foreach my $role (keys(%rolehash)) {
18795: my ($cnum,$cdom,$courserole) = split(':',$role);
18796: my $cid = $cdom.'_'.$cnum;
18797: if (exists($courses{$cid})) {
18798: if (ref($courses{$cid}) eq 'HASH') {
18799: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18800: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18801: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18802: }
18803: } else {
18804: $courses{$cid}{roles} = [$courserole];
18805: }
18806: $showcourses{$cid} = $courses{$cid};
18807: }
18808: }
18809: }
18810: %courses = %showcourses;
18811: }
18812: return %courses;
18813: }
18814:
18815: =pod
18816:
1.1181 raeburn 18817: =back
18818:
1.1207 raeburn 18819: =head1 Routines for version requirements for current course.
18820:
18821: =over 4
18822:
18823: =item * &check_release_required()
18824:
18825: Compares required LON-CAPA version with version on server, and
18826: if required version is newer looks for a server with the required version.
18827:
18828: Looks first at servers in user's owen domain; if none suitable, looks at
18829: servers in course's domain are permitted to host sessions for user's domain.
18830:
18831: Inputs:
18832:
18833: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18834:
18835: $courseid - Course ID of current course
18836:
18837: $rolecode - User's current role in course (for switchserver query string).
18838:
18839: $required - LON-CAPA version needed by course (format: Major.Minor).
18840:
18841:
18842: Returns:
18843:
18844: $switchserver - query string tp append to /adm/switchserver call (if
18845: current server's LON-CAPA version is too old.
18846:
18847: $warning - Message is displayed if no suitable server could be found.
18848:
18849: =cut
18850:
18851: sub check_release_required {
18852: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18853: my ($switchserver,$warning);
18854: if ($required ne '') {
18855: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18856: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18857: if ($reqdmajor ne '' && $reqdminor ne '') {
18858: my $otherserver;
18859: if (($major eq '' && $minor eq '') ||
18860: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18861: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18862: my $switchlcrev =
18863: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18864: $userdomserver);
18865: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18866: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18867: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18868: my $cdom = $env{'course.'.$courseid.'.domain'};
18869: if ($cdom ne $env{'user.domain'}) {
18870: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18871: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18872: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18873: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18874: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18875: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18876: my $canhost =
18877: &Apache::lonnet::can_host_session($env{'user.domain'},
18878: $coursedomserver,
18879: $remoterev,
18880: $udomdefaults{'remotesessions'},
18881: $defdomdefaults{'hostedsessions'});
18882:
18883: if ($canhost) {
18884: $otherserver = $coursedomserver;
18885: } else {
18886: $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.");
18887: }
18888: } else {
18889: $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).");
18890: }
18891: } else {
18892: $otherserver = $userdomserver;
18893: }
18894: }
18895: if ($otherserver ne '') {
18896: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18897: }
18898: }
18899: }
18900: return ($switchserver,$warning);
18901: }
18902:
18903: =pod
18904:
18905: =item * &check_release_result()
18906:
18907: Inputs:
18908:
18909: $switchwarning - Warning message if no suitable server found to host session.
18910:
18911: $switchserver - query string to append to /adm/switchserver containing lonHostID
18912: and current role.
18913:
18914: Returns: HTML to display with information about requirement to switch server.
18915: Either displaying warning with link to Roles/Courses screen or
18916: display link to switchserver.
18917:
1.1181 raeburn 18918: =cut
18919:
1.1207 raeburn 18920: sub check_release_result {
18921: my ($switchwarning,$switchserver) = @_;
18922: my $output = &start_page('Selected course unavailable on this server').
18923: '<p class="LC_warning">';
18924: if ($switchwarning) {
18925: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18926: if (&show_course()) {
18927: $output .= &mt('Display courses');
18928: } else {
18929: $output .= &mt('Display roles');
18930: }
18931: $output .= '</a>';
18932: } elsif ($switchserver) {
18933: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18934: '<br />'.
18935: '<a href="/adm/switchserver?'.$switchserver.'">'.
18936: &mt('Switch Server').
18937: '</a>';
18938: }
18939: $output .= '</p>'.&end_page();
18940: return $output;
18941: }
18942:
18943: =pod
18944:
18945: =item * &needs_coursereinit()
18946:
18947: Determine if course contents stored for user's session needs to be
18948: refreshed, because content has changed since "Big Hash" last tied.
18949:
18950: Check for change is made if time last checked is more than 10 minutes ago
18951: (by default).
18952:
18953: Inputs:
18954:
18955: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18956:
18957: $interval (optional) - Time which may elapse (in s) between last check for content
18958: change in current course. (default: 600 s).
18959:
18960: Returns: an array; first element is:
18961:
18962: =over 4
18963:
18964: 'switch' - if content updates mean user's session
18965: needs to be switched to a server running a newer LON-CAPA version
18966:
18967: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18968: on current server hosting user's session
18969:
18970: '' - if no action required.
18971:
18972: =back
18973:
18974: If first item element is 'switch':
18975:
18976: second item is $switchwarning - Warning message if no suitable server found to host session.
18977:
18978: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18979: and current role.
18980:
18981: otherwise: no other elements returned.
18982:
18983: =back
18984:
18985: =cut
18986:
18987: sub needs_coursereinit {
18988: my ($loncaparev,$interval) = @_;
18989: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18990: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18991: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18992: my $now = time;
18993: if ($interval eq '') {
18994: $interval = 600;
18995: }
18996: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18997: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18998: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18999: if ($blocked) {
19000: return ();
19001: }
1.1391 raeburn 19002: my $update;
19003: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19004: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19005: if ($lastmainchange > $env{'request.course.tied'}) {
19006: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19007: if ($needswitch) {
19008: return ('switch',$switchwarning,$switchserver);
19009: }
19010: $update = 'main';
19011: }
19012: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19013: if ($update) {
19014: $update = 'both';
19015: } else {
19016: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19017: if ($needswitch) {
19018: return ('switch',$switchwarning,$switchserver);
19019: } else {
19020: $update = 'supp';
1.1207 raeburn 19021: }
19022: }
1.1391 raeburn 19023: return ($update);
19024: }
19025: }
19026: return ();
19027: }
19028:
19029: sub switch_for_update {
19030: my ($loncaparev,$cdom,$cnum) = @_;
19031: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19032: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19033: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19034: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19035: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19036: $curr_reqd_hash{'internal.releaserequired'}});
19037: my ($switchserver,$switchwarning) =
19038: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19039: $curr_reqd_hash{'internal.releaserequired'});
19040: if ($switchwarning ne '' || $switchserver ne '') {
19041: return ('switch',$switchwarning,$switchserver);
19042: }
1.1207 raeburn 19043: }
19044: }
19045: return ();
19046: }
1.1181 raeburn 19047:
1.1083 raeburn 19048: sub update_content_constraints {
1.1395 raeburn 19049: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19050: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19051: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19052: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19053: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19054: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19055: if ($item eq 'resourcetag') {
19056: if ($name eq 'responsetype') {
19057: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19058: }
1.1307 raeburn 19059: } elsif ($item eq 'course') {
19060: if ($name eq 'courserestype') {
19061: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19062: }
1.1083 raeburn 19063: }
19064: }
19065: my $navmap = Apache::lonnavmaps::navmap->new();
19066: if (defined($navmap)) {
1.1307 raeburn 19067: my (%allresponses,%allcrsrestypes);
19068: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19069: if ($res->is_tool()) {
19070: if ($allcrsrestypes{'exttool'}) {
19071: $allcrsrestypes{'exttool'} ++;
19072: } else {
19073: $allcrsrestypes{'exttool'} = 1;
19074: }
19075: next;
19076: }
1.1083 raeburn 19077: my %responses = $res->responseTypes();
19078: foreach my $key (keys(%responses)) {
19079: next unless(exists($checkresponsetypes{$key}));
19080: $allresponses{$key} += $responses{$key};
19081: }
19082: }
19083: foreach my $key (keys(%allresponses)) {
19084: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19085: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19086: ($reqdmajor,$reqdminor) = ($major,$minor);
19087: }
19088: }
1.1307 raeburn 19089: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19090: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19091: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19092: ($reqdmajor,$reqdminor) = ($major,$minor);
19093: }
19094: }
1.1083 raeburn 19095: undef($navmap);
19096: }
1.1391 raeburn 19097: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19098: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19099: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19100: ($reqdmajor,$reqdminor) = ($major,$minor);
19101: }
19102: }
1.1083 raeburn 19103: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19104: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19105: }
19106: return;
19107: }
19108:
1.1110 raeburn 19109: sub allmaps_incourse {
19110: my ($cdom,$cnum,$chome,$cid) = @_;
19111: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19112: $cid = $env{'request.course.id'};
19113: $cdom = $env{'course.'.$cid.'.domain'};
19114: $cnum = $env{'course.'.$cid.'.num'};
19115: $chome = $env{'course.'.$cid.'.home'};
19116: }
19117: my %allmaps = ();
19118: my $lastchange =
19119: &Apache::lonnet::get_coursechange($cdom,$cnum);
19120: if ($lastchange > $env{'request.course.tied'}) {
19121: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19122: unless ($ferr) {
1.1395 raeburn 19123: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19124: }
19125: }
19126: my $navmap = Apache::lonnavmaps::navmap->new();
19127: if (defined($navmap)) {
19128: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19129: $allmaps{$res->src()} = 1;
19130: }
19131: }
19132: return \%allmaps;
19133: }
19134:
1.1083 raeburn 19135: sub parse_supplemental_title {
19136: my ($title) = @_;
19137:
19138: my ($foldertitle,$renametitle);
19139: if ($title =~ /&&&/) {
19140: $title = &HTML::Entites::decode($title);
19141: }
19142: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19143: $renametitle=$4;
19144: my ($time,$uname,$udom) = ($1,$2,$3);
19145: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19146: my $name = &plainname($uname,$udom);
19147: $name = &HTML::Entities::encode($name,'"<>&\'');
19148: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19149: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19150: if ($foldertitle ne '') {
1.1401 raeburn 19151: $title .= ': <br />'.$foldertitle;
19152: }
1.1083 raeburn 19153: }
19154: if (wantarray) {
19155: return ($title,$foldertitle,$renametitle);
19156: }
19157: return $title;
19158: }
19159:
1.1395 raeburn 19160: sub get_supplemental {
19161: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19162: my $hashid=$cnum.':'.$cdom;
19163: my ($supplemental,$cached,$set_httprefs);
19164: unless ($ignorecache) {
19165: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19166: }
19167: unless (defined($cached)) {
19168: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19169: unless ($chome eq 'no_host') {
19170: my @order = @LONCAPA::map::order;
19171: my @resources = @LONCAPA::map::resources;
19172: my @resparms = @LONCAPA::map::resparms;
19173: my @zombies = @LONCAPA::map::zombies;
19174: my ($errors,%ids,%hidden);
19175: $errors =
19176: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19177: $errors,$possdel,\%ids,\%hidden);
19178: @LONCAPA::map::order = @order;
19179: @LONCAPA::map::resources = @resources;
19180: @LONCAPA::map::resparms = @resparms;
19181: @LONCAPA::map::zombies = @zombies;
19182: $set_httprefs = 1;
19183: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19184: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19185: }
19186: $supplemental = {
19187: ids => \%ids,
19188: hidden => \%hidden,
19189: };
19190: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19191: }
19192: }
19193: return ($supplemental,$set_httprefs);
19194: }
19195:
1.1143 raeburn 19196: sub recurse_supplemental {
1.1391 raeburn 19197: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19198: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19199: my $mapnum;
19200: if ($suppmap eq 'supplemental.sequence') {
19201: $mapnum = 0;
19202: } else {
19203: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19204: }
1.1143 raeburn 19205: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19206: if ($fatal) {
19207: $errors ++;
19208: } else {
1.1389 raeburn 19209: my @order = @LONCAPA::map::order;
19210: if (@order > 0) {
19211: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19212: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19213: foreach my $idx (@order) {
19214: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19215: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19216: my $id = $mapnum.':'.$idx;
19217: push(@{$suppids->{$src}},$id);
19218: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19219: $hiddensupp->{$id} = 1;
19220: }
1.1146 raeburn 19221: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19222: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19223: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19224: } else {
1.1391 raeburn 19225: my $allowed;
19226: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19227: $allowed = 1;
19228: } elsif ($possdel) {
19229: foreach my $item (@{$suppids->{$src}}) {
19230: next if ($item eq $id);
19231: unless ($hiddensupp->{$item}) {
19232: $allowed = 1;
19233: last;
19234: }
19235: }
19236: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19237: &Apache::lonnet::delenv('httpref.'.$src);
19238: }
19239: }
19240: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19241: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19242: }
1.1143 raeburn 19243: }
19244: }
19245: }
19246: }
19247: }
19248: }
1.1391 raeburn 19249: return $errors;
19250: }
19251:
19252: sub set_supp_httprefs {
19253: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19254: if (ref($supplemental) eq 'HASH') {
19255: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19256: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19257: next if ($src =~ /\.sequence$/);
19258: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19259: my $allowed;
19260: if ($env{'request.role.adv'}) {
19261: $allowed = 1;
19262: } else {
19263: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19264: unless ($supplemental->{'hidden'}->{$id}) {
19265: $allowed = 1;
19266: last;
19267: }
19268: }
19269: }
19270: if (exists($env{'httpref.'.$src})) {
19271: if ($possdel) {
19272: unless ($allowed) {
19273: &Apache::lonnet::delenv('httpref.'.$src);
19274: }
19275: }
19276: } elsif ($allowed) {
19277: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19278: }
19279: }
19280: }
19281: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19282: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19283: }
19284: }
19285: }
19286: }
19287:
19288: sub get_supp_parameter {
19289: my ($resparm,$name)=@_;
19290: return if ($resparm eq '');
19291: my $value=undef;
19292: my $ptype=undef;
19293: foreach (split('&&&',$resparm)) {
19294: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19295: if ($thisname eq $name) {
19296: $value=$thisvalue;
19297: $ptype=$thistype;
19298: }
19299: }
19300: return $value;
1.1143 raeburn 19301: }
19302:
1.1101 raeburn 19303: sub symb_to_docspath {
1.1267 raeburn 19304: my ($symb,$navmapref) = @_;
19305: return unless ($symb && ref($navmapref));
1.1101 raeburn 19306: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19307: if ($resurl=~/\.(sequence|page)$/) {
19308: $mapurl=$resurl;
19309: } elsif ($resurl eq 'adm/navmaps') {
19310: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19311: }
19312: my $mapresobj;
1.1267 raeburn 19313: unless (ref($$navmapref)) {
19314: $$navmapref = Apache::lonnavmaps::navmap->new();
19315: }
19316: if (ref($$navmapref)) {
19317: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19318: }
19319: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19320: my $type=$2;
19321: my $path;
19322: if (ref($mapresobj)) {
19323: my $pcslist = $mapresobj->map_hierarchy();
19324: if ($pcslist ne '') {
19325: foreach my $pc (split(/,/,$pcslist)) {
19326: next if ($pc <= 1);
1.1267 raeburn 19327: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19328: if (ref($res)) {
19329: my $thisurl = $res->src();
19330: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19331: my $thistitle = $res->title();
19332: $path .= '&'.
19333: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19334: &escape($thistitle).
1.1101 raeburn 19335: ':'.$res->randompick().
19336: ':'.$res->randomout().
19337: ':'.$res->encrypted().
19338: ':'.$res->randomorder().
19339: ':'.$res->is_page();
19340: }
19341: }
19342: }
19343: $path =~ s/^\&//;
19344: my $maptitle = $mapresobj->title();
19345: if ($mapurl eq 'default') {
1.1129 raeburn 19346: $maptitle = 'Main Content';
1.1101 raeburn 19347: }
19348: $path .= (($path ne '')? '&' : '').
19349: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19350: &escape($maptitle).
1.1101 raeburn 19351: ':'.$mapresobj->randompick().
19352: ':'.$mapresobj->randomout().
19353: ':'.$mapresobj->encrypted().
19354: ':'.$mapresobj->randomorder().
19355: ':'.$mapresobj->is_page();
19356: } else {
19357: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19358: my $ispage = (($type eq 'page')? 1 : '');
19359: if ($mapurl eq 'default') {
1.1129 raeburn 19360: $maptitle = 'Main Content';
1.1101 raeburn 19361: }
19362: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19363: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19364: }
19365: unless ($mapurl eq 'default') {
19366: $path = 'default&'.
1.1146 raeburn 19367: &escape('Main Content').
1.1101 raeburn 19368: ':::::&'.$path;
19369: }
19370: return $path;
19371: }
19372:
1.1393 raeburn 19373: sub validate_folderpath {
19374: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19375: if ($env{'form.folderpath'} ne '') {
19376: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19377: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19378: for (my $i=0; $i<@items; $i++) {
19379: my $odd = $i%2;
19380: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19381: $badpath = 1;
1.1394 raeburn 19382: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19383: my $idx = $i-1;
1.1394 raeburn 19384: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19385: my $esc_name = $1;
19386: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19387: $supppath .= '&'.$esc_name;
19388: $changed = 1;
19389: } else {
19390: $supppath .= '&'.$items[$i];
19391: }
19392: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19393: $changed = 1;
1.1393 raeburn 19394: my $is_hidden;
19395: unless ($got_supp) {
1.1395 raeburn 19396: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19397: if (ref($supplemental) eq 'HASH') {
19398: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19399: %supphidden = %{$supplemental->{'hidden'}};
19400: }
19401: if (ref($supplemental->{'ids'}) eq 'HASH') {
19402: %suppids = %{$supplemental->{'ids'}};
19403: }
19404: }
19405: $got_supp = 1;
19406: }
19407: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19408: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19409: if ($supphidden{$mapid}) {
19410: $is_hidden = 1;
19411: }
19412: }
1.1394 raeburn 19413: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19414: } else {
19415: $supppath .= '&'.$items[$i];
1.1393 raeburn 19416: }
19417: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19418: $badpath = 1;
1.1394 raeburn 19419: } elsif ($supplementalflag) {
1.1393 raeburn 19420: $supppath .= '&'.$items[$i];
19421: }
19422: last if ($badpath);
19423: }
19424: if ($badpath) {
19425: delete($env{'form.folderpath'});
1.1394 raeburn 19426: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19427: $supppath =~ s/^\&//;
19428: $env{'form.folderpath'} = $supppath;
19429: }
19430: }
19431: return;
19432: }
19433:
1.1094 raeburn 19434: sub captcha_display {
1.1327 raeburn 19435: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19436: my ($output,$error);
1.1234 raeburn 19437: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19438: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19439: if ($captcha eq 'original') {
1.1094 raeburn 19440: $output = &create_captcha();
19441: unless ($output) {
1.1172 raeburn 19442: $error = 'captcha';
1.1094 raeburn 19443: }
19444: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19445: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19446: unless ($output) {
1.1172 raeburn 19447: $error = 'recaptcha';
1.1094 raeburn 19448: }
19449: }
1.1234 raeburn 19450: return ($output,$error,$captcha,$version);
1.1094 raeburn 19451: }
19452:
19453: sub captcha_response {
1.1327 raeburn 19454: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19455: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19456: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19457: if ($captcha eq 'original') {
1.1094 raeburn 19458: ($captcha_chk,$captcha_error) = &check_captcha();
19459: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19460: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19461: } else {
19462: $captcha_chk = 1;
19463: }
19464: return ($captcha_chk,$captcha_error);
19465: }
19466:
19467: sub get_captcha_config {
1.1327 raeburn 19468: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19469: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19470: my $hostname = &Apache::lonnet::hostname($lonhost);
19471: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19472: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19473: if ($context eq 'usercreation') {
19474: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19475: if (ref($domconfig{$context}) eq 'HASH') {
19476: $hashtocheck = $domconfig{$context}{'cancreate'};
19477: if (ref($hashtocheck) eq 'HASH') {
19478: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19479: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19480: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19481: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19482: }
19483: if ($privkey && $pubkey) {
19484: $captcha = 'recaptcha';
1.1234 raeburn 19485: $version = $hashtocheck->{'recaptchaversion'};
19486: if ($version ne '2') {
19487: $version = 1;
19488: }
1.1095 raeburn 19489: } else {
19490: $captcha = 'original';
19491: }
19492: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19493: $captcha = 'original';
19494: }
1.1094 raeburn 19495: }
1.1095 raeburn 19496: } else {
19497: $captcha = 'captcha';
19498: }
19499: } elsif ($context eq 'login') {
19500: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19501: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19502: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19503: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19504: if ($privkey && $pubkey) {
19505: $captcha = 'recaptcha';
1.1234 raeburn 19506: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19507: if ($version ne '2') {
19508: $version = 1;
19509: }
1.1095 raeburn 19510: } else {
19511: $captcha = 'original';
1.1094 raeburn 19512: }
1.1095 raeburn 19513: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19514: $captcha = 'original';
1.1094 raeburn 19515: }
1.1327 raeburn 19516: } elsif ($context eq 'passwords') {
19517: if ($dom_in_effect) {
19518: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19519: if ($passwdconf{'captcha'} eq 'recaptcha') {
19520: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19521: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19522: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19523: }
19524: if ($privkey && $pubkey) {
19525: $captcha = 'recaptcha';
19526: $version = $passwdconf{'recaptchaversion'};
19527: if ($version ne '2') {
19528: $version = 1;
19529: }
19530: } else {
19531: $captcha = 'original';
19532: }
19533: } elsif ($passwdconf{'captcha'} ne 'notused') {
19534: $captcha = 'original';
19535: }
19536: }
19537: }
1.1234 raeburn 19538: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19539: }
19540:
19541: sub create_captcha {
19542: my %captcha_params = &captcha_settings();
19543: my ($output,$maxtries,$tries) = ('',10,0);
19544: while ($tries < $maxtries) {
19545: $tries ++;
19546: my $captcha = Authen::Captcha->new (
19547: output_folder => $captcha_params{'output_dir'},
19548: data_folder => $captcha_params{'db_dir'},
19549: );
19550: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19551:
19552: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19553: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19554: '<span class="LC_nobreak">'.
1.1094 raeburn 19555: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19556: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19557: '</span><br />'.
1.1176 raeburn 19558: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19559: last;
19560: }
19561: }
1.1323 raeburn 19562: if ($output eq '') {
19563: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19564: }
1.1094 raeburn 19565: return $output;
19566: }
19567:
19568: sub captcha_settings {
19569: my %captcha_params = (
19570: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19571: www_output_dir => "/captchaspool",
19572: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19573: numchars => '5',
19574: );
19575: return %captcha_params;
19576: }
19577:
19578: sub check_captcha {
19579: my ($captcha_chk,$captcha_error);
19580: my $code = $env{'form.code'};
19581: my $md5sum = $env{'form.crypt'};
19582: my %captcha_params = &captcha_settings();
19583: my $captcha = Authen::Captcha->new(
19584: output_folder => $captcha_params{'output_dir'},
19585: data_folder => $captcha_params{'db_dir'},
19586: );
1.1109 raeburn 19587: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19588: my %captcha_hash = (
19589: 0 => 'Code not checked (file error)',
19590: -1 => 'Failed: code expired',
19591: -2 => 'Failed: invalid code (not in database)',
19592: -3 => 'Failed: invalid code (code does not match crypt)',
19593: );
19594: if ($captcha_chk != 1) {
19595: $captcha_error = $captcha_hash{$captcha_chk}
19596: }
19597: return ($captcha_chk,$captcha_error);
19598: }
19599:
19600: sub create_recaptcha {
1.1234 raeburn 19601: my ($pubkey,$version) = @_;
19602: if ($version >= 2) {
1.1367 raeburn 19603: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19604: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19605: } else {
19606: my $use_ssl;
19607: if ($ENV{'SERVER_PORT'} == 443) {
19608: $use_ssl = 1;
19609: }
19610: my $captcha = Captcha::reCAPTCHA->new;
19611: return $captcha->get_options_setter({theme => 'white'})."\n".
19612: $captcha->get_html($pubkey,undef,$use_ssl).
19613: &mt('If the text is hard to read, [_1] will replace them.',
19614: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19615: '<br /><br />';
19616: }
1.1094 raeburn 19617: }
19618:
19619: sub check_recaptcha {
1.1234 raeburn 19620: my ($privkey,$version) = @_;
1.1094 raeburn 19621: my $captcha_chk;
1.1350 raeburn 19622: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19623: if ($version >= 2) {
19624: my %info = (
19625: secret => $privkey,
19626: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19627: remoteip => $ip,
1.1234 raeburn 19628: );
1.1280 raeburn 19629: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19630: $request->content(join('&',map {
19631: my $name = escape($_);
19632: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19633: ? join("&$name=", map {escape($_) } @{$info{$_}})
19634: : &escape($info{$_}) );
19635: } keys(%info)));
19636: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19637: if ($response->is_success) {
19638: my $data = JSON::DWIW->from_json($response->decoded_content);
19639: if (ref($data) eq 'HASH') {
19640: if ($data->{'success'}) {
19641: $captcha_chk = 1;
19642: }
19643: }
19644: }
19645: } else {
19646: my $captcha = Captcha::reCAPTCHA->new;
19647: my $captcha_result =
19648: $captcha->check_answer(
19649: $privkey,
1.1350 raeburn 19650: $ip,
1.1234 raeburn 19651: $env{'form.recaptcha_challenge_field'},
19652: $env{'form.recaptcha_response_field'},
19653: );
19654: if ($captcha_result->{is_valid}) {
19655: $captcha_chk = 1;
19656: }
1.1094 raeburn 19657: }
19658: return $captcha_chk;
19659: }
19660:
1.1174 raeburn 19661: sub emailusername_info {
1.1244 raeburn 19662: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19663: my %titles = &Apache::lonlocal::texthash (
19664: lastname => 'Last Name',
19665: firstname => 'First Name',
19666: institution => 'School/college/university',
19667: location => "School's city, state/province, country",
19668: web => "School's web address",
19669: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19670: id => 'Student/Employee ID',
1.1174 raeburn 19671: );
19672: return (\@fields,\%titles);
19673: }
19674:
1.1161 raeburn 19675: sub cleanup_html {
19676: my ($incoming) = @_;
19677: my $outgoing;
19678: if ($incoming ne '') {
19679: $outgoing = $incoming;
19680: $outgoing =~ s/;/;/g;
19681: $outgoing =~ s/\#/#/g;
19682: $outgoing =~ s/\&/&/g;
19683: $outgoing =~ s/</</g;
19684: $outgoing =~ s/>/>/g;
19685: $outgoing =~ s/\(/(/g;
19686: $outgoing =~ s/\)/)/g;
19687: $outgoing =~ s/"/"/g;
19688: $outgoing =~ s/'/'/g;
19689: $outgoing =~ s/\$/$/g;
19690: $outgoing =~ s{/}{/}g;
19691: $outgoing =~ s/=/=/g;
19692: $outgoing =~ s/\\/\/g
19693: }
19694: return $outgoing;
19695: }
19696:
1.1190 musolffc 19697: # Checks for critical messages and returns a redirect url if one exists.
19698: # $interval indicates how often to check for messages.
1.1282 raeburn 19699: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19700: sub critical_redirect {
1.1282 raeburn 19701: my ($interval,$context) = @_;
1.1356 raeburn 19702: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19703: return ();
19704: }
1.1190 musolffc 19705: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19706: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19707: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19708: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19709: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19710: if ($blocked) {
19711: my $checkrole = "cm./$cdom/$cnum";
19712: if ($env{'request.course.sec'} ne '') {
19713: $checkrole .= "/$env{'request.course.sec'}";
19714: }
19715: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19716: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19717: return;
19718: }
19719: }
19720: }
1.1190 musolffc 19721: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19722: $env{'user.name'});
19723: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19724: my $redirecturl;
1.1190 musolffc 19725: if ($what[0]) {
1.1356 raeburn 19726: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19727: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19728: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19729: return (1, $url);
1.1190 musolffc 19730: }
1.1191 raeburn 19731: }
19732: }
19733: return ();
1.1190 musolffc 19734: }
19735:
1.1174 raeburn 19736: # Use:
19737: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19738: #
19739: ##################################################
19740: # password associated functions #
19741: ##################################################
19742: sub des_keys {
19743: # Make a new key for DES encryption.
19744: # Each key has two parts which are returned separately.
19745: # Please note: Each key must be passed through the &hex function
19746: # before it is output to the web browser. The hex versions cannot
19747: # be used to decrypt.
19748: my @hexstr=('0','1','2','3','4','5','6','7',
19749: '8','9','a','b','c','d','e','f');
19750: my $lkey='';
19751: for (0..7) {
19752: $lkey.=$hexstr[rand(15)];
19753: }
19754: my $ukey='';
19755: for (0..7) {
19756: $ukey.=$hexstr[rand(15)];
19757: }
19758: return ($lkey,$ukey);
19759: }
19760:
19761: sub des_decrypt {
19762: my ($key,$cyphertext) = @_;
19763: my $keybin=pack("H16",$key);
19764: my $cypher;
19765: if ($Crypt::DES::VERSION>=2.03) {
19766: $cypher=new Crypt::DES $keybin;
19767: } else {
19768: $cypher=new DES $keybin;
19769: }
1.1233 raeburn 19770: my $plaintext='';
19771: my $cypherlength = length($cyphertext);
19772: my $numchunks = int($cypherlength/32);
19773: for (my $j=0; $j<$numchunks; $j++) {
19774: my $start = $j*32;
19775: my $cypherblock = substr($cyphertext,$start,32);
19776: my $chunk =
19777: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19778: $chunk .=
19779: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19780: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19781: $plaintext .= $chunk;
19782: }
1.1174 raeburn 19783: return $plaintext;
19784: }
19785:
1.1344 raeburn 19786: sub get_requested_shorturls {
1.1309 raeburn 19787: my ($cdom,$cnum,$navmap) = @_;
19788: return unless (ref($navmap));
1.1344 raeburn 19789: my ($numnew,$errors);
1.1309 raeburn 19790: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19791: if (@toshorten) {
19792: my (%maps,%resources,%titles);
19793: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19794: 'shorturls',$cdom,$cnum);
19795: if (keys(%resources)) {
1.1344 raeburn 19796: my %tocreate;
1.1309 raeburn 19797: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19798: my $symb = $resources{$item};
19799: if ($symb) {
19800: $tocreate{$cnum.'&'.$symb} = 1;
19801: }
19802: }
1.1344 raeburn 19803: if (keys(%tocreate)) {
19804: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19805: \%tocreate);
19806: }
1.1309 raeburn 19807: }
1.1344 raeburn 19808: }
19809: return ($numnew,$errors);
19810: }
19811:
19812: sub make_short_symbs {
19813: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19814: my ($numnew,@errors);
19815: if (ref($tocreateref) eq 'HASH') {
19816: my %tocreate = %{$tocreateref};
1.1309 raeburn 19817: if (keys(%tocreate)) {
19818: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19819: my $su = Short::URL->new(no_vowels => 1);
19820: my $init = '';
19821: my (%newunique,%addcourse,%courseonly,%failed);
19822: # get lock on tiny db
19823: my $now = time;
1.1344 raeburn 19824: if ($lockuser eq '') {
19825: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19826: }
1.1309 raeburn 19827: my $lockhash = {
1.1344 raeburn 19828: "lock\0$now" => $lockuser,
1.1309 raeburn 19829: };
19830: my $tries = 0;
19831: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19832: my ($code,$error);
19833: while (($gotlock ne 'ok') && ($tries<3)) {
19834: $tries ++;
19835: sleep 1;
1.1319 raeburn 19836: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19837: }
19838: if ($gotlock eq 'ok') {
19839: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19840: \%addcourse,\%courseonly,\%failed);
19841: if (keys(%failed)) {
19842: my $numfailed = scalar(keys(%failed));
19843: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19844: }
19845: if (keys(%newunique)) {
19846: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19847: if ($putres eq 'ok') {
19848: $numnew = scalar(keys(%newunique));
19849: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19850: unless ($newputres eq 'ok') {
19851: push(@errors,&mt('error: could not store course look-up of short URLs'));
19852: }
19853: } else {
19854: push(@errors,&mt('error: could not store unique six character URLs'));
19855: }
19856: }
19857: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19858: unless ($dellockres eq 'ok') {
19859: push(@errors,&mt('error: could not release lockfile'));
19860: }
19861: } else {
19862: push(@errors,&mt('error: could not obtain lockfile'));
19863: }
19864: if (keys(%courseonly)) {
19865: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19866: if ($result ne 'ok') {
19867: push(@errors,&mt('error: could not update course look-up of short URLs'));
19868: }
19869: }
19870: }
19871: }
19872: return ($numnew,\@errors);
19873: }
19874:
19875: sub shorten_symbs {
19876: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19877: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19878: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19879: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19880: my (%possibles,%collisions);
19881: foreach my $key (keys(%{$tocreate})) {
19882: my $num = String::CRC32::crc32($key);
19883: my $tiny = $su->encode($num,$init);
19884: if ($tiny) {
19885: $possibles{$tiny} = $key;
19886: }
19887: }
19888: if (!$init) {
19889: $init = 1;
19890: } else {
19891: $init ++;
19892: }
19893: if (keys(%possibles)) {
19894: my @posstiny = keys(%possibles);
19895: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19896: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19897: if (keys(%currtiny)) {
19898: foreach my $key (keys(%currtiny)) {
19899: next if ($currtiny{$key} eq '');
19900: if ($currtiny{$key} eq $possibles{$key}) {
19901: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19902: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19903: $courseonly->{$tsymb} = $key;
19904: }
19905: } else {
19906: $collisions{$possibles{$key}} = 1;
19907: }
19908: delete($possibles{$key});
19909: }
19910: }
19911: foreach my $key (keys(%possibles)) {
19912: $newunique->{$key} = $possibles{$key};
19913: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19914: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19915: $addcourse->{$tsymb} = $key;
19916: }
19917: }
19918: }
19919: if (keys(%collisions)) {
19920: if ($init <5) {
19921: if (!$init) {
19922: $init = 1;
19923: } else {
19924: $init ++;
19925: }
19926: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19927: $newunique,$addcourse,$courseonly,$failed);
19928: } else {
19929: foreach my $key (keys(%collisions)) {
19930: $failed->{$key} = 1;
19931: }
19932: }
19933: }
19934: return $init;
19935: }
19936:
1.1328 raeburn 19937: sub is_nonframeable {
1.1329 raeburn 19938: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19939: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19940: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19941:
19942: $remprotocol = lc($remprotocol);
19943: $remhost = lc($remhost);
19944: my $remport = 80;
19945: if ($remprotocol eq 'https') {
19946: $remport = 443;
19947: }
1.1330 raeburn 19948: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19949: if ($cached) {
19950: unless ($nocache) {
19951: if ($result) {
19952: return 1;
19953: } else {
19954: return 0;
19955: }
19956: }
19957: }
1.1328 raeburn 19958: my $uselink;
19959: my $request = new HTTP::Request('HEAD',$url);
19960: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19961: if ($response->is_success()) {
19962: my $secpolicy = lc($response->header('content-security-policy'));
19963: my $xframeop = lc($response->header('x-frame-options'));
19964: $secpolicy =~ s/^\s+|\s+$//g;
19965: $xframeop =~ s/^\s+|\s+$//g;
19966: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19967: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19968: my ($origin,$protocol,$port);
19969: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19970: $port = $ENV{'SERVER_PORT'};
19971: } else {
19972: $port = 80;
19973: }
19974: if ($absolute eq '') {
19975: $protocol = 'http:';
19976: if ($port == 443) {
19977: $protocol = 'https:';
19978: }
19979: $origin = $protocol.'//'.lc($hostname);
19980: } else {
19981: $origin = lc($absolute);
19982: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19983: }
19984: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19985: my $framepolicy = $1;
19986: $framepolicy =~ s/^\s+|\s+$//g;
19987: my @policies = split(/\s+/,$framepolicy);
19988: if (@policies) {
19989: if (grep(/^\Q'none'\E$/,@policies)) {
19990: $uselink = 1;
19991: } else {
19992: $uselink = 1;
19993: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19994: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19995: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19996: undef($uselink);
19997: }
19998: if ($uselink) {
19999: if (grep(/^\Q'self'\E$/,@policies)) {
20000: if (($origin ne '') && ($remotehost eq $origin)) {
20001: undef($uselink);
20002: }
20003: }
20004: }
20005: if ($uselink) {
20006: my @possok;
20007: if ($ip ne '') {
20008: push(@possok,$ip);
20009: }
20010: my $hoststr = '';
20011: foreach my $part (reverse(split(/\./,$hostname))) {
20012: if ($hoststr eq '') {
20013: $hoststr = $part;
20014: } else {
20015: $hoststr = "$part.$hoststr";
20016: }
20017: if ($hoststr eq $hostname) {
20018: push(@possok,$hostname);
20019: } else {
20020: push(@possok,"*.$hoststr");
20021: }
20022: }
20023: if (@possok) {
20024: foreach my $poss (@possok) {
20025: last if (!$uselink);
20026: foreach my $policy (@policies) {
20027: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20028: undef($uselink);
20029: last;
20030: }
20031: }
20032: }
20033: }
20034: }
20035: }
20036: }
20037: } elsif ($xframeop ne '') {
20038: $uselink = 1;
20039: my @policies = split(/\s*,\s*/,$xframeop);
20040: if (@policies) {
20041: unless (grep(/^deny$/,@policies)) {
20042: if ($origin ne '') {
20043: if (grep(/^sameorigin$/,@policies)) {
20044: if ($remotehost eq $origin) {
20045: undef($uselink);
20046: }
20047: }
20048: if ($uselink) {
20049: foreach my $policy (@policies) {
20050: if ($policy =~ /^allow-from\s*(.+)$/) {
20051: my $allowfrom = $1;
20052: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20053: undef($uselink);
20054: last;
20055: }
20056: }
20057: }
20058: }
20059: }
20060: }
20061: }
20062: }
20063: }
20064: }
1.1329 raeburn 20065: if ($nocache) {
20066: if ($cached) {
20067: my $devalidate;
20068: if ($uselink && !$result) {
20069: $devalidate = 1;
20070: } elsif (!$uselink && $result) {
20071: $devalidate = 1;
20072: }
20073: if ($devalidate) {
20074: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20075: }
20076: }
20077: } else {
20078: if ($uselink) {
20079: $result = 1;
20080: } else {
20081: $result = 0;
20082: }
20083: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20084: }
1.1328 raeburn 20085: return $uselink;
20086: }
20087:
1.1359 raeburn 20088: sub page_menu {
20089: my ($menucolls,$menunum) = @_;
20090: my %menu;
20091: foreach my $item (split(/;/,$menucolls)) {
20092: my ($num,$value) = split(/\%/,$item);
20093: if ($num eq $menunum) {
20094: my @entries = split(/\&/,$value);
20095: foreach my $entry (@entries) {
20096: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20097: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20098: $menu{$name} = $fields;
20099: } else {
20100: my @shown;
20101: if ($fields =~ /,/) {
20102: @shown = split(/,/,$fields);
20103: } else {
20104: @shown = ($fields);
20105: }
20106: if (@shown) {
20107: foreach my $field (@shown) {
20108: next if ($field eq '');
20109: $menu{$field} = 1;
20110: }
20111: }
20112: }
20113: }
20114: }
20115: }
20116: return %menu;
20117: }
20118:
1.112 bowersj2 20119: 1;
20120: __END__;
1.41 ng 20121:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncommon.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface