Annotation of loncom/interface/loncommon.pm, revision 1.1453
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1453 ! raeburn 4: # $Id: loncommon.pm,v 1.1452 2025/02/14 05:15:59 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,
1.1450 raeburn 1177: $suffix,
1178: $haslabel
1.36 matthew 1179: ) = @_;
1180: my $second = "document.$formname.$secondselectname";
1181: my $first = "document.$formname.$firstselectname";
1182: # output the javascript to do the changing
1183: my $result = '';
1.776 bisitz 1184: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1185: $result.="// <![CDATA[\n";
1.1245 raeburn 1186: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1187: $" = '","';
1188: my $debug = '';
1189: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1190: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1191: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1192: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1193: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1194: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1195: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1196: @s2values = @{$hashref->{$s1}->{'order'}};
1197: }
1.36 matthew 1198: $result.="\"@s2values\");\n";
1.1245 raeburn 1199: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1200: my @s2texts;
1201: foreach my $value (@s2values) {
1.1263 raeburn 1202: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1203: }
1204: $result.="\"@s2texts\");\n";
1205: }
1206: $"=' ';
1207: $result.= <<"END";
1208:
1.1245 raeburn 1209: function select1${suffix}_changed() {
1.36 matthew 1210: // Determine new choice
1.1245 raeburn 1211: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1212: // update select2
1.1245 raeburn 1213: var values = select2data${suffix}[newvalue].values;
1214: var texts = select2data${suffix}[newvalue].texts;
1215: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1216: var i;
1217: // out with the old
1.1245 raeburn 1218: $second.options.length = 0;
1219: // in with the new
1.36 matthew 1220: for (i=0;i<values.length; i++) {
1221: $second.options[i] = new Option(values[i]);
1.143 matthew 1222: $second.options[i].value = values[i];
1.36 matthew 1223: $second.options[i].text = texts[i];
1224: if (values[i] == select2def) {
1225: $second.options[i].selected = true;
1226: }
1227: }
1228: }
1.824 bisitz 1229: // ]]>
1.36 matthew 1230: </script>
1231: END
1232: # output the initial values for the selection lists
1.1245 raeburn 1233: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1234: my @order = sort(keys(%{$hashref}));
1235: if (ref($menuorder) eq 'ARRAY') {
1236: @order = @{$menuorder};
1237: }
1238: foreach my $value (@order) {
1.36 matthew 1239: $result.=" <option value=\"$value\" ";
1.253 albertel 1240: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1241: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1242: }
1243: $result .= "</select>\n";
1.1450 raeburn 1244: if ($haslabel) {
1245: $result .= '</label>';
1246: }
1.1400 raeburn 1247: my %select2;
1248: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1249: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1250: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1251: }
1252: }
1.1450 raeburn 1253: if ($middletext ne '') {
1.1452 raeburn 1254: $result .= '<label>'.$middletext;
1.1450 raeburn 1255: }
1.1115 raeburn 1256: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1257: if ($onchangesecond) {
1258: $result .= ' onchange="'.$onchangesecond.'"';
1259: }
1260: $result .= ">\n";
1.36 matthew 1261: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1262:
1263: my @secondorder = sort(keys(%select2));
1264: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1265: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1266: }
1267: foreach my $value (@secondorder) {
1.36 matthew 1268: $result.=" <option value=\"$value\" ";
1.253 albertel 1269: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1270: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1271: }
1272: $result .= "</select>\n";
1.1450 raeburn 1273: if ($middletext ne '') {
1274: $result .= '</label>';
1275: }
1.36 matthew 1276: # return $debug;
1277: return $result;
1278: } # end of sub linked_select_forms {
1279:
1.45 matthew 1280: =pod
1.44 bowersj2 1281:
1.1381 raeburn 1282: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1283:
1.112 bowersj2 1284: Returns a string corresponding to an HTML link to the given help
1285: $topic, where $topic corresponds to the name of a .tex file in
1286: /home/httpd/html/adm/help/tex, with underscores replaced by
1287: spaces.
1288:
1289: $text will optionally be linked to the same topic, allowing you to
1290: link text in addition to the graphic. If you do not want to link
1291: text, but wish to specify one of the later parameters, pass an
1292: empty string.
1293:
1294: $stayOnPage is a value that will be interpreted as a boolean. If true,
1295: the link will not open a new window. If false, the link will open
1296: a new window using Javascript. (Default is false.)
1297:
1298: $width and $height are optional numerical parameters that will
1299: override the width and height of the popped up window, which may
1.973 raeburn 1300: be useful for certain help topics with big pictures included.
1301:
1302: $imgid is the id of the img tag used for the help icon. This may be
1303: used in a javascript call to switch the image src. See
1304: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1305:
1.1381 raeburn 1306: $links_target will optionally be set to a target (_top, _parent or _self).
1307:
1.44 bowersj2 1308: =cut
1309:
1310: sub help_open_topic {
1.1381 raeburn 1311: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1312: $text = "" if (not defined $text);
1.44 bowersj2 1313: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1314: $width = 500 if (not defined $width);
1.44 bowersj2 1315: $height = 400 if (not defined $height);
1316: my $filename = $topic;
1317: $filename =~ s/ /_/g;
1318:
1.48 bowersj2 1319: my $template = "";
1320: my $link;
1.572 banghart 1321:
1.159 www 1322: $topic=~s/\W/\_/g;
1.44 bowersj2 1323:
1.572 banghart 1324: if (!$stayOnPage) {
1.1033 www 1325: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1326: } elsif ($stayOnPage eq 'popup') {
1327: $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 1328: } else {
1.48 bowersj2 1329: $link = "/adm/help/${filename}.hlp";
1330: }
1331:
1332: # Add the text
1.1314 raeburn 1333: my $target = ' target="_top"';
1.1381 raeburn 1334: if ($links_target) {
1335: $target = ' target="'.$links_target.'"';
1336: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1337: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1338: $target = '';
1.1378 raeburn 1339: }
1.1380 raeburn 1340: if ($text ne "") {
1.763 bisitz 1341: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1342: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1343: .$text.'</a>';
1.48 bowersj2 1344: }
1345:
1.763 bisitz 1346: # (Always) Add the graphic
1.179 matthew 1347: my $title = &mt('Online Help');
1.667 raeburn 1348: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1349: if ($imgid ne '') {
1350: $imgid = ' id="'.$imgid.'"';
1351: }
1.1314 raeburn 1352: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1353: .'<img src="'.$helpicon.'" border="0"'
1354: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1355: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1356: .' /></a>';
1357: if ($text ne "") {
1358: $template.='</span>';
1359: }
1.44 bowersj2 1360: return $template;
1361:
1.106 bowersj2 1362: }
1363:
1364: # This is a quicky function for Latex cheatsheet editing, since it
1365: # appears in at least four places
1366: sub helpLatexCheatsheet {
1.1037 www 1367: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1368: my $out;
1.106 bowersj2 1369: my $addOther = '';
1.732 raeburn 1370: if ($topic) {
1.1037 www 1371: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1372: }
1373: $out = '<span>' # Start cheatsheet
1374: .$addOther
1375: .'<span>'
1.1037 www 1376: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1377: .'</span> <span>'
1.1037 www 1378: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1379: .'</span>';
1.732 raeburn 1380: unless ($not_author) {
1.1186 kruse 1381: $out .= '<span>'
1382: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1383: .'</span> <span>'
1.1424 raeburn 1384: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763 bisitz 1385: .'</span>';
1.732 raeburn 1386: }
1.763 bisitz 1387: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1388: return $out;
1.172 www 1389: }
1390:
1.430 albertel 1391: sub general_help {
1392: my $helptopic='Student_Intro';
1393: if ($env{'request.role'}=~/^(ca|au)/) {
1394: $helptopic='Authoring_Intro';
1.907 raeburn 1395: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1396: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1397: } elsif ($env{'request.role'}=~/^dc/) {
1398: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1399: }
1400: return $helptopic;
1401: }
1402:
1403: sub update_help_link {
1404: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1405: my $origurl = $ENV{'REQUEST_URI'};
1406: $origurl=~s|^/~|/priv/|;
1407: my $timestamp = time;
1408: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1409: $$datum = &escape($$datum);
1410: }
1411:
1412: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1413: my $output .= <<"ENDOUTPUT";
1414: <script type="text/javascript">
1.824 bisitz 1415: // <![CDATA[
1.430 albertel 1416: banner_link = '$banner_link';
1.824 bisitz 1417: // ]]>
1.430 albertel 1418: </script>
1419: ENDOUTPUT
1420: return $output;
1421: }
1422:
1423: # now just updates the help link and generates a blue icon
1.193 raeburn 1424: sub help_open_menu {
1.1381 raeburn 1425: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1426: = @_;
1.949 droeschl 1427: $stayOnPage = 1;
1.430 albertel 1428: my $output;
1429: if ($component_help) {
1430: if (!$text) {
1431: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1432: $width,$height,'',$links_target);
1.430 albertel 1433: } else {
1434: my $help_text;
1435: $help_text=&unescape($topic);
1436: $output='<table><tr><td>'.
1437: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1438: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1439: }
1440: }
1441: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1442: return $output.$banner_link;
1443: }
1444:
1445: sub top_nav_help {
1.1369 raeburn 1446: my ($text,$linkattr) = @_;
1.436 albertel 1447: $text = &mt($text);
1.949 droeschl 1448: my $stay_on_page = 1;
1449:
1.1168 raeburn 1450: my ($link,$banner_link);
1451: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1452: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1453: : "javascript:helpMenu('open')";
1454: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1455: }
1.201 raeburn 1456: my $title = &mt('Get help');
1.1168 raeburn 1457: if ($link) {
1458: return <<"END";
1.436 albertel 1459: $banner_link
1.1369 raeburn 1460: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1461: END
1.1168 raeburn 1462: } else {
1463: return ' '.$text.' ';
1464: }
1.436 albertel 1465: }
1466:
1467: sub help_menu_js {
1.1154 raeburn 1468: my ($httphost) = @_;
1.949 droeschl 1469: my $stayOnPage = 1;
1.436 albertel 1470: my $width = 620;
1471: my $height = 600;
1.430 albertel 1472: my $helptopic=&general_help();
1.1154 raeburn 1473: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1474: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1475: my $start_page =
1476: &Apache::loncommon::start_page('Help Menu', undef,
1477: {'frameset' => 1,
1478: 'js_ready' => 1,
1.1154 raeburn 1479: 'use_absolute' => $httphost,
1.331 albertel 1480: 'add_entries' => {
1.1168 raeburn 1481: 'border' => '0',
1.579 raeburn 1482: 'rows' => "110,*",},});
1.331 albertel 1483: my $end_page =
1484: &Apache::loncommon::end_page({'frameset' => 1,
1485: 'js_ready' => 1,});
1486:
1.436 albertel 1487: my $template .= <<"ENDTEMPLATE";
1488: <script type="text/javascript">
1.877 bisitz 1489: // <![CDATA[
1.253 albertel 1490: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1491: var banner_link = '';
1.243 raeburn 1492: function helpMenu(target) {
1493: var caller = this;
1494: if (target == 'open') {
1495: var newWindow = null;
1496: try {
1.262 albertel 1497: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1498: }
1499: catch(error) {
1500: writeHelp(caller);
1501: return;
1502: }
1503: if (newWindow) {
1504: caller = newWindow;
1505: }
1.193 raeburn 1506: }
1.243 raeburn 1507: writeHelp(caller);
1508: return;
1509: }
1510: function writeHelp(caller) {
1.1168 raeburn 1511: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1512: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1513: caller.document.close();
1514: caller.focus();
1.193 raeburn 1515: }
1.877 bisitz 1516: // END LON-CAPA Internal -->
1.253 albertel 1517: // ]]>
1.436 albertel 1518: </script>
1.193 raeburn 1519: ENDTEMPLATE
1520: return $template;
1521: }
1522:
1.172 www 1523: sub help_open_bug {
1524: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1525: unless ($env{'user.adv'}) { return ''; }
1.172 www 1526: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1527: $text = "" if (not defined $text);
1528: $stayOnPage=1;
1.184 albertel 1529: $width = 600 if (not defined $width);
1530: $height = 600 if (not defined $height);
1.172 www 1531:
1532: $topic=~s/\W+/\+/g;
1533: my $link='';
1534: my $template='';
1.379 albertel 1535: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1536: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1537: if (!$stayOnPage)
1538: {
1539: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1540: }
1541: else
1542: {
1543: $link = $url;
1544: }
1.1314 raeburn 1545:
1.1382 raeburn 1546: my $target = '_top';
1547: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1548: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1549: $target = '_blank';
1.1378 raeburn 1550: }
1.1382 raeburn 1551:
1.172 www 1552: # Add the text
1553: if ($text ne "")
1554: {
1555: $template .=
1556: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1557: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1558: }
1559:
1560: # Add the graphic
1.179 matthew 1561: my $title = &mt('Report a Bug');
1.215 albertel 1562: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1563: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1564: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1565: ENDTEMPLATE
1566: if ($text ne '') { $template.='</td></tr></table>' };
1567: return $template;
1568:
1569: }
1570:
1571: sub help_open_faq {
1572: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1573: unless ($env{'user.adv'}) { return ''; }
1.172 www 1574: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1575: $text = "" if (not defined $text);
1576: $stayOnPage=1;
1577: $width = 350 if (not defined $width);
1578: $height = 400 if (not defined $height);
1579:
1580: $topic=~s/\W+/\+/g;
1581: my $link='';
1582: my $template='';
1583: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1584: if (!$stayOnPage)
1585: {
1586: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1587: }
1588: else
1589: {
1590: $link = $url;
1591: }
1592:
1593: # Add the text
1594: if ($text ne "")
1595: {
1596: $template .=
1.173 www 1597: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1598: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1599: }
1600:
1601: # Add the graphic
1.179 matthew 1602: my $title = &mt('View the FAQ');
1.215 albertel 1603: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1604: $template .= <<"ENDTEMPLATE";
1.436 albertel 1605: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1606: ENDTEMPLATE
1607: if ($text ne '') { $template.='</td></tr></table>' };
1608: return $template;
1609:
1.44 bowersj2 1610: }
1.37 matthew 1611:
1.180 matthew 1612: ###############################################################
1613: ###############################################################
1614:
1.45 matthew 1615: =pod
1616:
1.648 raeburn 1617: =item * &change_content_javascript():
1.256 matthew 1618:
1619: This and the next function allow you to create small sections of an
1620: otherwise static HTML page that you can update on the fly with
1621: Javascript, even in Netscape 4.
1622:
1623: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1624: must be written to the HTML page once. It will prove the Javascript
1625: function "change(name, content)". Calling the change function with the
1626: name of the section
1627: you want to update, matching the name passed to C<changable_area>, and
1628: the new content you want to put in there, will put the content into
1629: that area.
1630:
1631: B<Note>: Netscape 4 only reserves enough space for the changable area
1632: to contain room for the original contents. You need to "make space"
1633: for whatever changes you wish to make, and be B<sure> to check your
1634: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1635: it's adequate for updating a one-line status display, but little more.
1636: This script will set the space to 100% width, so you only need to
1637: worry about height in Netscape 4.
1638:
1639: Modern browsers are much less limiting, and if you can commit to the
1640: user not using Netscape 4, this feature may be used freely with
1641: pretty much any HTML.
1642:
1643: =cut
1644:
1645: sub change_content_javascript {
1646: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1647: if ($env{'browser.type'} eq 'netscape' &&
1648: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1649: return (<<NETSCAPE4);
1650: function change(name, content) {
1651: doc = document.layers[name+"___escape"].layers[0].document;
1652: doc.open();
1653: doc.write(content);
1654: doc.close();
1655: }
1656: NETSCAPE4
1657: } else {
1658: # Otherwise, we need to use semi-standards-compliant code
1659: # (technically, "innerHTML" isn't standard but the equivalent
1660: # is really scary, and every useful browser supports it
1661: return (<<DOMBASED);
1662: function change(name, content) {
1663: element = document.getElementById(name);
1664: element.innerHTML = content;
1665: }
1666: DOMBASED
1667: }
1668: }
1669:
1670: =pod
1671:
1.648 raeburn 1672: =item * &changable_area($name,$origContent):
1.256 matthew 1673:
1674: This provides a "changable area" that can be modified on the fly via
1675: the Javascript code provided in C<change_content_javascript>. $name is
1676: the name you will use to reference the area later; do not repeat the
1677: same name on a given HTML page more then once. $origContent is what
1678: the area will originally contain, which can be left blank.
1679:
1680: =cut
1681:
1682: sub changable_area {
1683: my ($name, $origContent) = @_;
1684:
1.258 albertel 1685: if ($env{'browser.type'} eq 'netscape' &&
1686: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1687: # If this is netscape 4, we need to use the Layer tag
1688: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1689: } else {
1690: return "<span id='$name'>$origContent</span>";
1691: }
1692: }
1693:
1694: =pod
1695:
1.648 raeburn 1696: =item * &viewport_geometry_js
1.590 raeburn 1697:
1698: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1699:
1700: =cut
1701:
1702:
1703: sub viewport_geometry_js {
1704: return <<"GEOMETRY";
1705: var Geometry = {};
1706: function init_geometry() {
1707: if (Geometry.init) { return };
1708: Geometry.init=1;
1709: if (window.innerHeight) {
1710: Geometry.getViewportHeight = function() { return window.innerHeight; };
1711: Geometry.getViewportWidth = function() { return window.innerWidth; };
1712: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1713: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1714: }
1715: else if (document.documentElement && document.documentElement.clientHeight) {
1716: Geometry.getViewportHeight =
1717: function() { return document.documentElement.clientHeight; };
1718: Geometry.getViewportWidth =
1719: function() { return document.documentElement.clientWidth; };
1720:
1721: Geometry.getHorizontalScroll =
1722: function() { return document.documentElement.scrollLeft; };
1723: Geometry.getVerticalScroll =
1724: function() { return document.documentElement.scrollTop; };
1725: }
1726: else if (document.body.clientHeight) {
1727: Geometry.getViewportHeight =
1728: function() { return document.body.clientHeight; };
1729: Geometry.getViewportWidth =
1730: function() { return document.body.clientWidth; };
1731: Geometry.getHorizontalScroll =
1732: function() { return document.body.scrollLeft; };
1733: Geometry.getVerticalScroll =
1734: function() { return document.body.scrollTop; };
1735: }
1736: }
1737:
1738: GEOMETRY
1739: }
1740:
1741: =pod
1742:
1.648 raeburn 1743: =item * &viewport_size_js()
1.590 raeburn 1744:
1745: 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.
1746:
1747: =cut
1748:
1749: sub viewport_size_js {
1750: my $geometry = &viewport_geometry_js();
1751: return <<"DIMS";
1752:
1753: $geometry
1754:
1755: function getViewportDims(width,height) {
1756: init_geometry();
1757: width.value = Geometry.getViewportWidth();
1758: height.value = Geometry.getViewportHeight();
1759: return;
1760: }
1761:
1762: DIMS
1763: }
1764:
1765: =pod
1766:
1.648 raeburn 1767: =item * &resize_textarea_js()
1.565 albertel 1768:
1769: emits the needed javascript to resize a textarea to be as big as possible
1770:
1771: creates a function resize_textrea that takes two IDs first should be
1772: the id of the element to resize, second should be the id of a div that
1773: surrounds everything that comes after the textarea, this routine needs
1774: to be attached to the <body> for the onload and onresize events.
1775:
1776: =cut
1777:
1778: sub resize_textarea_js {
1.590 raeburn 1779: my $geometry = &viewport_geometry_js();
1.565 albertel 1780: return <<"RESIZE";
1781: <script type="text/javascript">
1.824 bisitz 1782: // <![CDATA[
1.590 raeburn 1783: $geometry
1.565 albertel 1784:
1.588 albertel 1785: function getX(element) {
1786: var x = 0;
1787: while (element) {
1788: x += element.offsetLeft;
1789: element = element.offsetParent;
1790: }
1791: return x;
1792: }
1793: function getY(element) {
1794: var y = 0;
1795: while (element) {
1796: y += element.offsetTop;
1797: element = element.offsetParent;
1798: }
1799: return y;
1800: }
1801:
1802:
1.565 albertel 1803: function resize_textarea(textarea_id,bottom_id) {
1804: init_geometry();
1805: var textarea = document.getElementById(textarea_id);
1806: //alert(textarea);
1807:
1.588 albertel 1808: var textarea_top = getY(textarea);
1.565 albertel 1809: var textarea_height = textarea.offsetHeight;
1810: var bottom = document.getElementById(bottom_id);
1.588 albertel 1811: var bottom_top = getY(bottom);
1.565 albertel 1812: var bottom_height = bottom.offsetHeight;
1813: var window_height = Geometry.getViewportHeight();
1.588 albertel 1814: var fudge = 23;
1.565 albertel 1815: var new_height = window_height-fudge-textarea_top-bottom_height;
1816: if (new_height < 300) {
1817: new_height = 300;
1818: }
1819: textarea.style.height=new_height+'px';
1820: }
1.824 bisitz 1821: // ]]>
1.565 albertel 1822: </script>
1823: RESIZE
1824:
1825: }
1826:
1.1205 golterma 1827: sub colorfuleditor_js {
1.1248 raeburn 1828: my $browse_or_search;
1829: my $respath;
1830: my ($cnum,$cdom) = &crsauthor_url();
1831: if ($cnum) {
1832: $respath = "/res/$cdom/$cnum/";
1833: my %js_lt = &Apache::lonlocal::texthash(
1834: sunm => 'Sub-directory name',
1835: save => 'Save page to make this permanent',
1836: );
1837: &js_escape(\%js_lt);
1.1400 raeburn 1838: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1839: $browse_or_search = <<"END";
1840:
1.1400 raeburn 1841: $showfile_js
1842:
1.1248 raeburn 1843: function toggleChooser(form,element,titleid,only,search) {
1844: var disp = 'none';
1845: if (document.getElementById('chooser_'+element)) {
1846: var curr = document.getElementById('chooser_'+element).style.display;
1847: if (curr == 'none') {
1848: disp='inline';
1849: if (form.elements['chooser_'+element].length) {
1850: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1851: form.elements['chooser_'+element][i].checked = false;
1852: }
1853: }
1854: toggleResImport(form,element);
1855: }
1856: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1857: var dirsel = '';
1858: var filesel = '';
1859: if (document.getElementById('chooser_'+element+'_crsres')) {
1860: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1861: if (currcrsres == 'none') {
1862: dirsel = 'coursepath_'+element;
1863: var filesel = 'coursefile_'+element;
1864: var include;
1865: if (document.getElementById('crsres_include_'+element)) {
1866: include = document.getElementById('crsres_include_'+element).value;
1867: }
1.1402 raeburn 1868: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1869: }
1870: }
1871: if (document.getElementById('chooser_'+element+'_upload')) {
1872: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1873: if (currcrsupload == 'none') {
1874: dirsel = 'crsauthorpath_'+element;
1875: filesel = '';
1.1402 raeburn 1876: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1877: }
1878: }
1.1248 raeburn 1879: }
1880: }
1881:
1.1400 raeburn 1882: function toggleCrsFile(form,element) {
1.1248 raeburn 1883: if (document.getElementById('chooser_'+element+'_crsres')) {
1884: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1885: if (curr == 'none') {
1.1400 raeburn 1886: if (document.getElementById('coursepath_'+element)) {
1887: var numdirs;
1888: if (document.getElementById('coursepath_'+element).length) {
1889: numdirs = document.getElementById('coursepath_'+element).length;
1890: }
1.1402 raeburn 1891: if ((document.getElementById('hascrsres_'+element)) &&
1892: (document.getElementById('nocrsres_'+element))) {
1893: if (numdirs) {
1894: document.getElementById('hascrsres_'+element).style.display='inline-block';
1895: document.getElementById('nocrsres_'+element).style.display='none';
1896: } else {
1897: document.getElementById('hascrsres_'+element).style.display='none';
1898: document.getElementById('nocrsres_'+element).style.display='inline-block';
1899: }
1900: }
1.1248 raeburn 1901: form.elements['coursepath_'+element].selectedIndex = 0;
1902: if (numdirs > 1) {
1.1400 raeburn 1903: var selelem = form.elements['coursefile_'+element];
1904: var i, len = selelem.options.length -1;
1905: if (len >=0) {
1906: for (i = len; i >= 0; i--) {
1907: selelem.remove(i);
1908: }
1909: selelem.options[0] = new Option('','');
1910: }
1.1248 raeburn 1911: }
1912: }
1.1400 raeburn 1913: }
1.1248 raeburn 1914: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1915: }
1916: if (document.getElementById('chooser_'+element+'_upload')) {
1917: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1918: if (document.getElementById('uploadcrsres_'+element)) {
1919: document.getElementById('uploadcrsres_'+element).value = '';
1920: }
1921: }
1922: return;
1923: }
1924:
1.1400 raeburn 1925: function toggleCrsUpload(form,element) {
1.1248 raeburn 1926: if (document.getElementById('chooser_'+element+'_crsres')) {
1927: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1928: }
1929: if (document.getElementById('chooser_'+element+'_upload')) {
1930: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1931: if (curr == 'none') {
1.1400 raeburn 1932: form.elements['newsubdir_'+element][0].checked = true;
1933: toggleNewsubdir(form,element);
1934: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1935: if (document.getElementById('uploadcrsres_'+element)) {
1936: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1937: }
1938: }
1939: }
1940: return;
1941: }
1942:
1943: function toggleResImport(form,element) {
1944: var choices = new Array('crsres','upload');
1945: for (var i=0; i<choices.length; i++) {
1946: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1947: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1948: }
1949: }
1950: }
1951:
1952: function toggleNewsubdir(form,element) {
1953: var newsub = form.elements['newsubdir_'+element];
1954: if (newsub) {
1955: if (newsub.length) {
1956: for (var j=0; j<newsub.length; j++) {
1957: if (newsub[j].checked) {
1958: if (document.getElementById('newsubdirname_'+element)) {
1959: if (newsub[j].value == '1') {
1960: document.getElementById('newsubdirname_'+element).type = "text";
1961: if (document.getElementById('newsubdir_'+element)) {
1962: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1963: }
1964: } else {
1965: document.getElementById('newsubdirname_'+element).type = "hidden";
1966: document.getElementById('newsubdirname_'+element).value = "";
1967: document.getElementById('newsubdir_'+element).innerHTML = "";
1968: }
1969: }
1970: break;
1971: }
1972: }
1973: }
1974: }
1975: }
1976:
1977: function updateCrsFile(form,element) {
1978: var directory = form.elements['coursepath_'+element];
1979: var filename = form.elements['coursefile_'+element];
1980: var path = directory.options[directory.selectedIndex].value;
1981: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1982: if (file != '') {
1983: form.elements[element].value = '$respath';
1984: if (path == '/') {
1985: form.elements[element].value += file;
1986: } else {
1987: form.elements[element].value += path+'/'+file;
1988: }
1989: unClean();
1990: if (document.getElementById('previewimg_'+element)) {
1991: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1992: var newsrc = document.getElementById('previewimg_'+element).src;
1993: }
1994: if (document.getElementById('showimg_'+element)) {
1995: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1996: }
1.1248 raeburn 1997: }
1998: toggleChooser(form,element);
1999: return;
2000: }
2001:
2002: function uploadDone(suffix,name) {
2003: if (name) {
2004: document.forms["lonhomework"].elements[suffix].value = name;
2005: unClean();
2006: toggleChooser(document.forms["lonhomework"],suffix);
2007: }
2008: }
2009:
2010: \$(document).ready(function(){
2011:
2012: \$(document).delegate('form :submit', 'click', function( event ) {
2013: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2014: var buttonId = this.id;
2015: var suffix = buttonId.toString();
2016: suffix = suffix.replace(/^crsupload_/,'');
2017: event.preventDefault();
2018: document.lonhomework.target = 'crsupload_target_'+suffix;
2019: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2020: \$(this.form).submit();
2021: document.lonhomework.target = '';
2022: if (document.getElementById('crsuploadto_'+suffix)) {
2023: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2024: }
2025: return false;
2026: }
2027: });
2028: });
2029: END
2030: }
1.1205 golterma 2031: return <<"COLORFULEDIT"
2032: <script type="text/javascript">
2033: // <![CDATA[>
2034: function fold_box(curDepth, lastresource){
2035:
2036: // we need a list because there can be several blocks you need to fold in one tag
2037: var block = document.getElementsByName('foldblock_'+curDepth);
2038: // but there is only one folding button per tag
2039: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2040:
2041: if(block.item(0).style.display == 'none'){
2042:
2043: foldbutton.value = '@{[&mt("Hide")]}';
2044: for (i = 0; i < block.length; i++){
2045: block.item(i).style.display = '';
2046: }
2047: }else{
2048:
2049: foldbutton.value = '@{[&mt("Show")]}';
2050: for (i = 0; i < block.length; i++){
2051: // block.item(i).style.visibility = 'collapse';
2052: block.item(i).style.display = 'none';
2053: }
2054: };
2055: saveState(lastresource);
2056: }
2057:
2058: function saveState (lastresource) {
2059:
2060: var tag_list = getTagList();
2061: if(tag_list != null){
2062: var timestamp = new Date().getTime();
2063: var key = lastresource;
2064:
2065: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2066: // starting with timestamp
2067: var value = timestamp+';';
2068:
2069: // building the list of key-value pairs
2070: for(var i = 0; i < tag_list.length; i++){
2071: value += tag_list[i]+',';
2072: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2073: }
2074:
2075: // only iterate whole storage if nothing to override
2076: if(localStorage.getItem(key) == null){
2077:
2078: // prevent storage from growing large
2079: if(localStorage.length > 50){
2080: var regex_getTimestamp = /^(?:\d)+;/;
2081: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2082: var oldest_key;
2083:
2084: for(var i = 1; i < localStorage.length; i++){
2085: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2086: oldest_key = localStorage.key(i);
2087: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2088: }
2089: }
2090: localStorage.removeItem(oldest_key);
2091: }
2092: }
2093: localStorage.setItem(key,value);
2094: }
2095: }
2096:
2097: // restore folding status of blocks (on page load)
2098: function restoreState (lastresource) {
2099: if(localStorage.getItem(lastresource) != null){
2100: var key = lastresource;
2101: var value = localStorage.getItem(key);
2102: var regex_delTimestamp = /^\d+;/;
2103:
2104: value.replace(regex_delTimestamp, '');
2105:
2106: var valueArr = value.split(';');
2107: var pairs;
2108: var elements;
2109: for (var i = 0; i < valueArr.length; i++){
2110: pairs = valueArr[i].split(',');
2111: elements = document.getElementsByName(pairs[0]);
2112:
2113: for (var j = 0; j < elements.length; j++){
2114: elements[j].style.display = pairs[1];
2115: if (pairs[1] == "none"){
2116: var regex_id = /([_\\d]+)\$/;
2117: regex_id.exec(pairs[0]);
2118: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2119: }
2120: }
2121: }
2122: }
2123: }
2124:
2125: function getTagList () {
2126:
2127: var stringToSearch = document.lonhomework.innerHTML;
2128:
2129: var ret = new Array();
2130: var regex_findBlock = /(foldblock_.*?)"/g;
2131: var tag_list = stringToSearch.match(regex_findBlock);
2132:
2133: if(tag_list != null){
2134: for(var i = 0; i < tag_list.length; i++){
2135: ret.push(tag_list[i].replace(/"/, ''));
2136: }
2137: }
2138: return ret;
2139: }
2140:
2141: function saveScrollPosition (resource) {
2142: var tag_list = getTagList();
2143:
2144: // we dont always want to jump to the first block
2145: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2146: if(\$(window).scrollTop() > 170){
2147: if(tag_list != null){
2148: var result;
2149: for(var i = 0; i < tag_list.length; i++){
2150: if(isElementInViewport(tag_list[i])){
2151: result += tag_list[i]+';';
2152: }
2153: }
2154: sessionStorage.setItem('anchor_'+resource, result);
2155: }
2156: } else {
2157: // we dont need to save zero, just delete the item to leave everything tidy
2158: sessionStorage.removeItem('anchor_'+resource);
2159: }
2160: }
2161:
2162: function restoreScrollPosition(resource){
2163:
2164: var elem = sessionStorage.getItem('anchor_'+resource);
2165: if(elem != null){
2166: var tag_list = elem.split(';');
2167: var elem_list;
2168:
2169: for(var i = 0; i < tag_list.length; i++){
2170: elem_list = document.getElementsByName(tag_list[i]);
2171:
2172: if(elem_list.length > 0){
2173: elem = elem_list[0];
2174: break;
2175: }
2176: }
2177: elem.scrollIntoView();
2178: }
2179: }
2180:
2181: function isElementInViewport(el) {
2182:
2183: // change to last element instead of first
2184: var elem = document.getElementsByName(el);
2185: var rect = elem[0].getBoundingClientRect();
2186:
2187: return (
2188: rect.top >= 0 &&
2189: rect.left >= 0 &&
2190: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2191: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2192: );
2193: }
2194:
2195: function autosize(depth){
2196: var cmInst = window['cm'+depth];
2197: var fitsizeButton = document.getElementById('fitsize'+depth);
2198:
2199: // is fixed size, switching to dynamic
2200: if (sessionStorage.getItem("autosized_"+depth) == null) {
2201: cmInst.setSize("","auto");
2202: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2203: sessionStorage.setItem("autosized_"+depth, "yes");
2204:
2205: // is dynamic size, switching to fixed
2206: } else {
2207: cmInst.setSize("","300px");
2208: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2209: sessionStorage.removeItem("autosized_"+depth);
2210: }
2211: }
2212:
1.1248 raeburn 2213: $browse_or_search
1.1205 golterma 2214:
2215: // ]]>
2216: </script>
2217: COLORFULEDIT
2218: }
2219:
2220: sub xmleditor_js {
2221: return <<XMLEDIT
2222: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2223: <script type="text/javascript">
2224: // <![CDATA[>
2225:
2226: function saveScrollPosition (resource) {
2227:
2228: var scrollPos = \$(window).scrollTop();
2229: sessionStorage.setItem(resource,scrollPos);
2230: }
2231:
2232: function restoreScrollPosition(resource){
2233:
2234: var scrollPos = sessionStorage.getItem(resource);
2235: \$(window).scrollTop(scrollPos);
2236: }
2237:
2238: // unless internet explorer
2239: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2240:
2241: \$(document).ready(function() {
2242: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2243: });
2244: }
2245:
2246: // inserts text at cursor position into codemirror (xml editor only)
2247: function insertText(text){
2248: cm.focus();
2249: var curPos = cm.getCursor();
2250: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2251: }
2252: // ]]>
2253: </script>
2254: XMLEDIT
2255: }
2256:
2257: sub insert_folding_button {
2258: my $curDepth = $Apache::lonxml::curdepth;
2259: my $lastresource = $env{'request.ambiguous'};
2260:
2261: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2262: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2263: }
2264:
1.1248 raeburn 2265: sub crsauthor_url {
2266: my ($url) = @_;
2267: if ($url eq '') {
2268: $url = $ENV{'REQUEST_URI'};
2269: }
2270: my ($cnum,$cdom);
2271: if ($env{'request.course.id'}) {
2272: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2273: if ($audom ne '' && $auname ne '') {
2274: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2275: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2276: $cnum = $auname;
2277: $cdom = $audom;
2278: }
2279: }
2280: }
2281: return ($cnum,$cdom);
2282: }
2283:
2284: sub import_crsauthor_form {
1.1400 raeburn 2285: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2286: return (0) unless ($env{'request.course.id'});
2287: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2288: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2289: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2290: return (0) unless (($cnum ne '') && ($cdom ne ''));
2291: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2292: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2293:
1.1248 raeburn 2294: if (grep(/^\Q$crshome\E$/,@ids)) {
2295: $is_home = 1;
2296: }
1.1400 raeburn 2297: $toppath = "/priv/$cdom/$cnum";
2298: my $nonemptydir = 1;
2299: my $js_only;
2300: if ($only) {
2301: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2302: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2303: }
2304: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2305: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2306: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2307: my %lt = &Apache::lonlocal::texthash (
2308: fnam => 'Filename',
2309: dire => 'Directory',
1.1400 raeburn 2310: se => 'Select',
1.1248 raeburn 2311: );
1.1450 raeburn 2312: $output = '<label>'.$lt{'dire'}.': '.
1.1400 raeburn 2313: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2314: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2315: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2316: if ($files{'/'}) {
2317: $output .= '<option value="/">/</option>'."\n";
2318: }
1.1400 raeburn 2319: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2320: next if ($key eq '/');
1.1400 raeburn 2321: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2322: }
1.1450 raeburn 2323: $output .= '</select></label><br /><label>'."\n".
1.1402 raeburn 2324: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2325: '<option value="" selected="selected"></option>'."\n".
1.1450 raeburn 2326: '</select></label>'."\n".
1.1402 raeburn 2327: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2328: return ($numdirs,$output);
2329: }
2330:
2331: sub show_crsfiles_js {
2332: my $excluderef = &Apache::lonnet::priv_exclude();
2333: my $se = &js_escape(&mt('Select'));
2334: my $exclude;
2335: if (ref($excluderef) eq 'HASH') {
2336: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2337: }
2338: my $js = <<"END";
2339:
2340:
1.1402 raeburn 2341: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2342: var relpath = '';
2343: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2344: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2345: if (currdir == '') {
2346: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2347: selelem = form.elements[filesel];
2348: var j, numfiles = selelem.options.length -1;
2349: if (numfiles >=0) {
2350: for (j = numfiles; j >= 0; j--) {
2351: selelem.remove(j);
2352: }
2353: }
2354: if (selelem.options.length == 0) {
2355: selelem.options[selelem.options.length] = new Option('','');
2356: selelem.selectedIndex = 0;
1.1248 raeburn 2357: }
2358: }
1.1400 raeburn 2359: return;
2360: } else {
2361: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2362: }
2363: }
1.1400 raeburn 2364: var http = new XMLHttpRequest();
2365: var url = "/adm/courseauthor";
2366: var crsrole = "$env{'request.role'}";
2367: var exclude = '';
2368: if (exc) {
2369: exclude = '$exclude';
2370: }
1.1402 raeburn 2371: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2372: http.open("POST", url, true);
2373: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2374: http.onreadystatechange = function() {
2375: if (http.readyState == 4 && http.status == 200) {
2376: var data = JSON.parse(http.responseText);
2377: var selelem;
2378: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2379: if (Array.isArray(data.dirs)) {
2380: selelem = form.elements[dirsel];
2381: var i, numdirs = selelem.options.length -1;
2382: if (numdirs >=0) {
2383: for (i = numdirs; i >= 0; i--) {
2384: selelem.remove(i);
2385: }
2386: }
2387: var len = data.dirs.length;
2388: if (len) {
1.1402 raeburn 2389: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2390: var j;
2391: for (j = 0; j < len; j++) {
2392: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2393: }
2394: selelem.selectedIndex = 0;
2395: }
2396: if (!setfile) {
2397: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2398: selelem = form.elements[filesel];
2399: var j, numfiles = selelem.options.length -1;
2400: if (numfiles >=0) {
2401: for (j = numfiles; j >= 0; j--) {
2402: selelem.remove(j);
2403: }
2404: }
2405: if (selelem.options.length == 0) {
2406: selelem.options[selelem.options.length] = new Option('','');
2407: selelem.selectedIndex = 0;
2408: }
2409: }
2410: }
2411: }
2412: }
2413: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2414: selelem = form.elements[filesel];
2415: var i, numfiles = selelem.options.length -1;
2416: if (numfiles >=0) {
2417: for (i = numfiles; i >= 0; i--) {
2418: selelem.remove(i);
2419: }
2420: }
2421: var x;
2422: for (x in data.files) {
2423: if (Array.isArray(data.files[x])) {
2424: if (data.files[x].length > 1) {
2425: selelem.options[selelem.options.length] = new Option('$se','');
2426: }
2427: var len = data.files[x].length;
2428: if (len) {
2429: var k;
2430: for (k = 0; k < len; k++) {
2431: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2432: }
2433: selelem.selectedIndex = 0;
2434: }
2435: }
2436: }
2437: if (selelem.options.length == 0) {
2438: selelem.options[selelem.options.length] = new Option('','');
2439: selelem.selectedIndex = 0;
2440: }
1.1248 raeburn 2441: }
2442: }
2443: }
1.1400 raeburn 2444: http.send(params);
1.1248 raeburn 2445: }
1.1400 raeburn 2446: END
1.1248 raeburn 2447: }
2448:
1.1426 raeburn 2449: sub crsauthor_rights {
2450: my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
2451: my $sourcerights = "$path/$rightsfile";
2452: my $now = time;
2453: if (!-e $sourcerights) {
2454: my $cid = $cdom.'_'.$cnum;
2455: if (!-e "$docroot/priv/$cdom") {
2456: mkdir("$docroot/priv/$cdom",0755);
2457: }
2458: if (!-e "$docroot/priv/$cdom/$cnum") {
2459: mkdir("$docroot/priv/$cdom/$cnum",0755);
2460: }
2461: if (open(my $fh,">$sourcerights")) {
2462: print $fh <<END;
2463: <accessrule effect="deny" realm="" type="course" role="" />
2464: <accessrule effect="allow" realm="$cid" type="course" role="" />
2465: END
2466: close($fh);
2467: }
2468: }
2469: if (!-e "$sourcerights.meta") {
2470: if (open(my $fh,">$sourcerights.meta")) {
2471: my $author=$env{'environment.firstname'}.' '.
2472: $env{'environment.middlename'}.' '.
2473: $env{'environment.lastname'}.' '.
2474: $env{'environment.generation'};
2475: $author =~ s/\s+$//;
2476: print $fh <<"END";
2477:
2478: <abstract></abstract>
2479: <author>$author</author>
2480: <authorspace>$cnum:$cdom</authorspace>
2481: <copyright>private</copyright>
2482: <creationdate>$now</creationdate>
2483: <customdistributionfile></customdistributionfile>
2484: <dependencies></dependencies>
2485: <domain>$cdom</domain>
2486: <highestgradelevel>0</highestgradelevel>
2487: <keywords></keywords>
1.1445 raeburn 2488: <language>notset</language>
1.1426 raeburn 2489: <lastrevisiondate>$now</lastrevisiondate>
2490: <lowestgradelevel>0</lowestgradelevel>
2491: <mime>rights</mime>
2492: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
2493: <notes></notes>
2494: <obsolete></obsolete>
2495: <obsoletereplacement></obsoletereplacement>
2496: <owner>$cnum:$cdom</owner>
2497: <rule>deny:::course,allow:$cid::course</rule>
2498: <sourceavail></sourceavail>
2499: <standards></standards>
2500: <subject></subject>
2501: <title>Course Authoring Rights</title>
2502: END
2503: close($fh);
2504: }
2505: }
2506: return;
2507: }
2508:
1.565 albertel 2509: =pod
2510:
1.1420 raeburn 2511: =item * &iframe_wrapper_headjs()
2512:
1.1425 raeburn 2513: emits javascript containing two global vars to facilitate handling of resizing
2514: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
2515: with standard LON-CAPA menus.
2516:
2517: =cut
2518:
1.1420 raeburn 2519: #
2520: # Where iframe is in use, if window.onload() executes before the custom resize function
2521: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
2522: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
2523: # do not obscure the Functions menu.
2524: #
2525:
2526: sub iframe_wrapper_headjs {
2527: return <<"ENDJS";
2528: <script type="text/javascript">
2529: // <![CDATA[
2530: var LCnotready = 0;
2531: var LCresizedef = 0;
2532: // ]]>
2533: </script>
2534:
2535: ENDJS
2536:
2537: }
2538:
2539: =pod
2540:
2541: =item * &iframe_wrapper_resizejs()
2542:
1.1425 raeburn 2543: emits javascript used to handle resizing for a page containing
2544: an iframe, to ensure that the iframe does not obscure any
2545: standard LON-CAPA menu items.
2546:
2547: =back
2548:
2549: =cut
2550:
1.1420 raeburn 2551: #
2552: # jQuery to use when iframe is in use and a page resize occurs.
2553: # This script will ensure that the iframe does not obscure any
2554: # standard LON-CAPA inline menus (primary, secondary, and/or
2555: # breadcrumbs and Functions menus. Expects javascript from
2556: # &iframe_wrapper_headjs() to be in head portion of the web page,
2557: # e.g., by inclusion in second arg passed to &start_page().
2558: #
2559:
2560: sub iframe_wrapper_resizejs {
2561: my $offset = 5;
2562: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
2563: if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
2564: $offset = 0;
2565: }
2566: return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
2567: \$(document).ready( function() {
2568: \$(window).unbind('resize').resize(function(){
2569: var header = null;
2570: var offset = $offset;
2571: var height = 0;
2572: var hdrtop = 0;
1.1421 raeburn 2573: if (\$('div.LC_menus_content:first').length) {
2574: if (\$('div.LC_menus_content:first').hasClass ("shown")) {
2575: header = \$('div.LC_menus_content:first');
1.1423 raeburn 2576: offset = 12;
1.1421 raeburn 2577: }
2578: } else if (\$('div.LC_head_subbox:first').length) {
1.1420 raeburn 2579: header = \$('div.LC_head_subbox:first');
2580: offset = 9;
2581: } else {
2582: if (\$('#LC_breadcrumbs').length) {
2583: header = \$('#LC_breadcrumbs');
2584: }
2585: }
2586: if (header != null && header.length) {
2587: height = header.height();
2588: hdrtop = header.position().top;
2589: }
2590: var pos = height + hdrtop + offset;
2591: \$('.LC_iframecontainer').css('top', pos);
2592: });
2593: LCresizedef = 1;
2594: if (LCnotready == 1) {
2595: LCnotready = 0;
2596: \$(window).trigger('resize');
2597: }
2598: });
2599: window.onload = function(){
2600: if (LCresizedef) {
2601: LCnotready = 0;
2602: \$(window).trigger('resize');
2603: } else {
2604: LCnotready = 1;
2605: }
2606: };
2607: SCRIPT
2608:
2609: }
2610:
2611: =pod
2612:
1.256 matthew 2613: =head1 Excel and CSV file utility routines
2614:
2615: =cut
2616:
2617: ###############################################################
2618: ###############################################################
2619:
2620: =pod
2621:
1.1162 raeburn 2622: =over 4
2623:
1.648 raeburn 2624: =item * &csv_translate($text)
1.37 matthew 2625:
1.185 www 2626: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2627: format.
2628:
2629: =cut
2630:
1.180 matthew 2631: ###############################################################
2632: ###############################################################
1.37 matthew 2633: sub csv_translate {
2634: my $text = shift;
2635: $text =~ s/\"/\"\"/g;
1.209 albertel 2636: $text =~ s/\n/ /g;
1.37 matthew 2637: return $text;
2638: }
1.180 matthew 2639:
2640: ###############################################################
2641: ###############################################################
2642:
2643: =pod
2644:
1.648 raeburn 2645: =item * &define_excel_formats()
1.180 matthew 2646:
2647: Define some commonly used Excel cell formats.
2648:
2649: Currently supported formats:
2650:
2651: =over 4
2652:
2653: =item header
2654:
2655: =item bold
2656:
2657: =item h1
2658:
2659: =item h2
2660:
2661: =item h3
2662:
1.256 matthew 2663: =item h4
2664:
2665: =item i
2666:
1.180 matthew 2667: =item date
2668:
2669: =back
2670:
2671: Inputs: $workbook
2672:
2673: Returns: $format, a hash reference.
2674:
1.1057 foxr 2675:
1.180 matthew 2676: =cut
2677:
2678: ###############################################################
2679: ###############################################################
2680: sub define_excel_formats {
2681: my ($workbook) = @_;
2682: my $format;
2683: $format->{'header'} = $workbook->add_format(bold => 1,
2684: bottom => 1,
2685: align => 'center');
2686: $format->{'bold'} = $workbook->add_format(bold=>1);
2687: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2688: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2689: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2690: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2691: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2692: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2693: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2694: return $format;
2695: }
2696:
2697: ###############################################################
2698: ###############################################################
1.113 bowersj2 2699:
2700: =pod
2701:
1.648 raeburn 2702: =item * &create_workbook()
1.255 matthew 2703:
2704: Create an Excel worksheet. If it fails, output message on the
2705: request object and return undefs.
2706:
2707: Inputs: Apache request object
2708:
2709: Returns (undef) on failure,
2710: Excel worksheet object, scalar with filename, and formats
2711: from &Apache::loncommon::define_excel_formats on success
2712:
2713: =cut
2714:
2715: ###############################################################
2716: ###############################################################
2717: sub create_workbook {
2718: my ($r) = @_;
2719: #
2720: # Create the excel spreadsheet
2721: my $filename = '/prtspool/'.
1.258 albertel 2722: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2723: time.'_'.rand(1000000000).'.xls';
2724: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2725: if (! defined($workbook)) {
2726: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2727: $r->print(
2728: '<p class="LC_error">'
2729: .&mt('Problems occurred in creating the new Excel file.')
2730: .' '.&mt('This error has been logged.')
2731: .' '.&mt('Please alert your LON-CAPA administrator.')
2732: .'</p>'
2733: );
1.255 matthew 2734: return (undef);
2735: }
2736: #
1.1014 foxr 2737: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2738: #
2739: my $format = &Apache::loncommon::define_excel_formats($workbook);
2740: return ($workbook,$filename,$format);
2741: }
2742:
2743: ###############################################################
2744: ###############################################################
2745:
2746: =pod
2747:
1.648 raeburn 2748: =item * &create_text_file()
1.113 bowersj2 2749:
1.542 raeburn 2750: Create a file to write to and eventually make available to the user.
1.256 matthew 2751: If file creation fails, outputs an error message on the request object and
2752: return undefs.
1.113 bowersj2 2753:
1.256 matthew 2754: Inputs: Apache request object, and file suffix
1.113 bowersj2 2755:
1.256 matthew 2756: Returns (undef) on failure,
2757: Filehandle and filename on success.
1.113 bowersj2 2758:
2759: =cut
2760:
1.256 matthew 2761: ###############################################################
2762: ###############################################################
2763: sub create_text_file {
2764: my ($r,$suffix) = @_;
2765: if (! defined($suffix)) { $suffix = 'txt'; };
2766: my $fh;
2767: my $filename = '/prtspool/'.
1.258 albertel 2768: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2769: time.'_'.rand(1000000000).'.'.$suffix;
2770: $fh = Apache::File->new('>/home/httpd'.$filename);
2771: if (! defined($fh)) {
2772: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2773: $r->print(
2774: '<p class="LC_error">'
2775: .&mt('Problems occurred in creating the output file.')
2776: .' '.&mt('This error has been logged.')
2777: .' '.&mt('Please alert your LON-CAPA administrator.')
2778: .'</p>'
2779: );
1.113 bowersj2 2780: }
1.256 matthew 2781: return ($fh,$filename)
1.113 bowersj2 2782: }
2783:
2784:
1.256 matthew 2785: =pod
1.113 bowersj2 2786:
2787: =back
2788:
2789: =cut
1.37 matthew 2790:
2791: ###############################################################
1.33 matthew 2792: ## Home server <option> list generating code ##
2793: ###############################################################
1.35 matthew 2794:
1.169 www 2795: # ------------------------------------------
2796:
2797: sub domain_select {
1.1289 raeburn 2798: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2799: my @possdoms;
2800: if (ref($incdoms) eq 'ARRAY') {
2801: @possdoms = @{$incdoms};
2802: } else {
2803: @possdoms = &Apache::lonnet::all_domains();
2804: }
2805:
1.169 www 2806: my %domains=map {
1.514 albertel 2807: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2808: } @possdoms;
2809:
2810: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2811: foreach my $dom (@{$excdoms}) {
2812: delete($domains{$dom});
2813: }
2814: }
2815:
1.169 www 2816: if ($multiple) {
2817: $domains{''}=&mt('Any domain');
1.550 albertel 2818: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2819: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2820: } else {
1.550 albertel 2821: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2822: return &select_form($name,$value,\%domains);
1.169 www 2823: }
2824: }
2825:
1.282 albertel 2826: #-------------------------------------------
2827:
2828: =pod
2829:
1.519 raeburn 2830: =head1 Routines for form select boxes
2831:
2832: =over 4
2833:
1.648 raeburn 2834: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2835:
2836: Returns a string containing a <select> element int multiple mode
2837:
2838:
2839: Args:
2840: $name - name of the <select> element
1.506 raeburn 2841: $value - scalar or array ref of values that should already be selected
1.282 albertel 2842: $size - number of rows long the select element is
1.283 albertel 2843: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2844: (shown text should already have been &mt())
1.506 raeburn 2845: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2846:
1.282 albertel 2847: =cut
2848:
2849: #-------------------------------------------
1.169 www 2850: sub multiple_select_form {
1.284 albertel 2851: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2852: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2853: my $output='';
1.191 matthew 2854: if (! defined($size)) {
2855: $size = 4;
1.283 albertel 2856: if (scalar(keys(%$hash))<4) {
2857: $size = scalar(keys(%$hash));
1.191 matthew 2858: }
2859: }
1.734 bisitz 2860: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2861: my @order;
1.506 raeburn 2862: if (ref($order) eq 'ARRAY') {
2863: @order = @{$order};
2864: } else {
2865: @order = sort(keys(%$hash));
1.501 banghart 2866: }
2867: if (exists($$hash{'select_form_order'})) {
2868: @order = @{$$hash{'select_form_order'}};
2869: }
2870:
1.284 albertel 2871: foreach my $key (@order) {
1.356 albertel 2872: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2873: $output.='selected="selected" ' if ($selected{$key});
2874: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2875: }
2876: $output.="</select>\n";
2877: return $output;
2878: }
2879:
1.88 www 2880: #-------------------------------------------
2881:
2882: =pod
2883:
1.1254 raeburn 2884: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2885:
2886: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2887: allow a user to select options from a ref to a hash containing:
2888: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2889: a javascript onchange item, e.g., onchange="this.form.submit();".
2890: An optional arg -- $readonly -- if true will cause the select form
2891: to be disabled, e.g., for the case where an instructor has a section-
2892: specific role, and is viewing/modifying parameters.
1.970 raeburn 2893:
1.88 www 2894: See lonrights.pm for an example invocation and use.
2895:
2896: =cut
2897:
2898: #-------------------------------------------
2899: sub select_form {
1.1228 raeburn 2900: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2901: return unless (ref($hashref) eq 'HASH');
2902: if ($onchange) {
2903: $onchange = ' onchange="'.$onchange.'"';
2904: }
1.1228 raeburn 2905: my $disabled;
2906: if ($readonly) {
2907: $disabled = ' disabled="disabled"';
2908: }
2909: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2910: my @keys;
1.970 raeburn 2911: if (exists($hashref->{'select_form_order'})) {
2912: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2913: } else {
1.970 raeburn 2914: @keys=sort(keys(%{$hashref}));
1.128 albertel 2915: }
1.356 albertel 2916: foreach my $key (@keys) {
2917: $selectform.=
2918: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2919: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2920: ">".$hashref->{$key}."</option>\n";
1.88 www 2921: }
2922: $selectform.="</select>";
2923: return $selectform;
2924: }
2925:
1.475 www 2926: # For display filters
2927:
2928: sub display_filter {
1.1074 raeburn 2929: my ($context) = @_;
1.475 www 2930: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2931: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2932: my $phraseinput = 'hidden';
2933: my $includeinput = 'hidden';
2934: my ($checked,$includetypestext);
2935: if ($env{'form.displayfilter'} eq 'containing') {
2936: $phraseinput = 'text';
2937: if ($context eq 'parmslog') {
2938: $includeinput = 'checkbox';
2939: if ($env{'form.includetypes'}) {
2940: $checked = ' checked="checked"';
2941: }
2942: $includetypestext = &mt('Include parameter types');
2943: }
2944: } else {
2945: $includetypestext = ' ';
2946: }
2947: my ($additional,$secondid,$thirdid);
2948: if ($context eq 'parmslog') {
2949: $additional =
2950: '<label><input type="'.$includeinput.'" name="includetypes"'.
2951: $checked.' name="includetypes" value="1" id="includetypes" />'.
2952: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2953: '</label>';
2954: $secondid = 'includetypes';
2955: $thirdid = 'includetypestext';
2956: }
2957: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2958: '$secondid','$thirdid')";
2959: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2960: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2961: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2962: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2963: &mt('Filter: [_1]',
1.477 www 2964: &select_form($env{'form.displayfilter'},
2965: 'displayfilter',
1.970 raeburn 2966: {'currentfolder' => 'Current folder/page',
1.477 www 2967: 'containing' => 'Containing phrase',
1.1074 raeburn 2968: 'none' => 'None'},$onchange)).' '.
2969: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2970: &HTML::Entities::encode($env{'form.containingphrase'}).
2971: '" />'.$additional;
2972: }
2973:
2974: sub display_filter_js {
2975: my $includetext = &mt('Include parameter types');
2976: return <<"ENDJS";
2977:
2978: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2979: var firstType = 'hidden';
2980: if (setter.options[setter.selectedIndex].value == 'containing') {
2981: firstType = 'text';
2982: }
2983: firstObject = document.getElementById(firstid);
2984: if (typeof(firstObject) == 'object') {
2985: if (firstObject.type != firstType) {
2986: changeInputType(firstObject,firstType);
2987: }
2988: }
2989: if (context == 'parmslog') {
2990: var secondType = 'hidden';
2991: if (firstType == 'text') {
2992: secondType = 'checkbox';
2993: }
2994: secondObject = document.getElementById(secondid);
2995: if (typeof(secondObject) == 'object') {
2996: if (secondObject.type != secondType) {
2997: changeInputType(secondObject,secondType);
2998: }
2999: }
3000: var textItem = document.getElementById(thirdid);
3001: var currtext = textItem.innerHTML;
3002: var newtext;
3003: if (firstType == 'text') {
3004: newtext = '$includetext';
3005: } else {
3006: newtext = ' ';
3007: }
3008: if (currtext != newtext) {
3009: textItem.innerHTML = newtext;
3010: }
3011: }
3012: return;
3013: }
3014:
3015: function changeInputType(oldObject,newType) {
3016: var newObject = document.createElement('input');
3017: newObject.type = newType;
3018: if (oldObject.size) {
3019: newObject.size = oldObject.size;
3020: }
3021: if (oldObject.value) {
3022: newObject.value = oldObject.value;
3023: }
3024: if (oldObject.name) {
3025: newObject.name = oldObject.name;
3026: }
3027: if (oldObject.id) {
3028: newObject.id = oldObject.id;
3029: }
3030: oldObject.parentNode.replaceChild(newObject,oldObject);
3031: return;
3032: }
3033:
3034: ENDJS
1.475 www 3035: }
3036:
1.167 www 3037: sub gradeleveldescription {
3038: my $gradelevel=shift;
3039: my %gradelevels=(0 => 'Not specified',
3040: 1 => 'Grade 1',
3041: 2 => 'Grade 2',
3042: 3 => 'Grade 3',
3043: 4 => 'Grade 4',
3044: 5 => 'Grade 5',
3045: 6 => 'Grade 6',
3046: 7 => 'Grade 7',
3047: 8 => 'Grade 8',
3048: 9 => 'Grade 9',
3049: 10 => 'Grade 10',
3050: 11 => 'Grade 11',
3051: 12 => 'Grade 12',
3052: 13 => 'Grade 13',
3053: 14 => '100 Level',
3054: 15 => '200 Level',
3055: 16 => '300 Level',
3056: 17 => '400 Level',
3057: 18 => 'Graduate Level');
3058: return &mt($gradelevels{$gradelevel});
3059: }
3060:
1.163 www 3061: sub select_level_form {
3062: my ($deflevel,$name)=@_;
3063: unless ($deflevel) { $deflevel=0; }
1.167 www 3064: my $selectform = "<select name=\"$name\" size=\"1\">\n";
3065: for (my $i=0; $i<=18; $i++) {
3066: $selectform.="<option value=\"$i\" ".
1.253 albertel 3067: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 3068: ">".&gradeleveldescription($i)."</option>\n";
3069: }
3070: $selectform.="</select>";
3071: return $selectform;
1.163 www 3072: }
1.167 www 3073:
1.35 matthew 3074: #-------------------------------------------
3075:
1.45 matthew 3076: =pod
3077:
1.1453 ! raeburn 3078: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled,$id)
1.35 matthew 3079:
3080: Returns a string containing a <select name='$name' size='1'> form to
3081: allow a user to select the domain to preform an operation in.
3082: See loncreateuser.pm for an example invocation and use.
3083:
1.90 www 3084: If the $includeempty flag is set, it also includes an empty choice ("no domain
3085: selected");
3086:
1.743 raeburn 3087: If the $showdomdesc flag is set, the domain name is followed by the domain description.
3088:
1.910 raeburn 3089: 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.
3090:
1.1121 raeburn 3091: The optional $incdoms is a reference to an array of domains which will be the only available options.
3092:
3093: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 3094:
1.1256 raeburn 3095: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
3096:
1.1453 ! raeburn 3097: The option $id argument is the value (if any) to set as the (unique) id attribute for the select tag.
! 3098:
1.35 matthew 3099: =cut
3100:
3101: #-------------------------------------------
1.34 matthew 3102: sub select_dom_form {
1.1453 ! raeburn 3103: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled,$id) = @_;
1.872 raeburn 3104: if ($onchange) {
1.874 raeburn 3105: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 3106: }
1.1256 raeburn 3107: if ($disabled) {
3108: $disabled = ' disabled="disabled"';
3109: }
1.1453 ! raeburn 3110: if ($id ne '') {
! 3111: $id = ' id="'.$id.'"';
! 3112: }
1.1121 raeburn 3113: my (@domains,%exclude);
1.910 raeburn 3114: if (ref($incdoms) eq 'ARRAY') {
3115: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
3116: } else {
3117: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
3118: }
1.90 www 3119: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 3120: if (ref($excdoms) eq 'ARRAY') {
3121: map { $exclude{$_} = 1; } @{$excdoms};
3122: }
1.1453 ! raeburn 3123: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled$id>\n";
1.356 albertel 3124: foreach my $dom (@domains) {
1.1121 raeburn 3125: next if ($exclude{$dom});
1.356 albertel 3126: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 3127: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
3128: if ($showdomdesc) {
3129: if ($dom ne '') {
3130: my $domdesc = &Apache::lonnet::domain($dom,'description');
3131: if ($domdesc ne '') {
3132: $selectdomain .= ' ('.$domdesc.')';
3133: }
3134: }
3135: }
3136: $selectdomain .= "</option>\n";
1.34 matthew 3137: }
3138: $selectdomain.="</select>";
3139: return $selectdomain;
3140: }
3141:
1.35 matthew 3142: #-------------------------------------------
3143:
1.45 matthew 3144: =pod
3145:
1.648 raeburn 3146: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 3147:
1.586 raeburn 3148: input: 4 arguments (two required, two optional) -
3149: $domain - domain of new user
3150: $name - name of form element
3151: $default - Value of 'default' causes a default item to be first
3152: option, and selected by default.
3153: $hide - Value of 'hide' causes hiding of the name of the server,
3154: if 1 server found, or default, if 0 found.
1.594 raeburn 3155: output: returns 2 items:
1.586 raeburn 3156: (a) form element which contains either:
3157: (i) <select name="$name">
3158: <option value="$hostid1">$hostid $servers{$hostid}</option>
3159: <option value="$hostid2">$hostid $servers{$hostid}</option>
3160: </select>
3161: form item if there are multiple library servers in $domain, or
3162: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
3163: if there is only one library server in $domain.
3164:
3165: (b) number of library servers found.
3166:
3167: See loncreateuser.pm for example of use.
1.35 matthew 3168:
3169: =cut
3170:
3171: #-------------------------------------------
1.586 raeburn 3172: sub home_server_form_item {
3173: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 3174: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 3175: my $result;
3176: my $numlib = keys(%servers);
3177: if ($numlib > 1) {
3178: $result .= '<select name="'.$name.'" />'."\n";
3179: if ($default) {
1.804 bisitz 3180: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3181: '</option>'."\n";
3182: }
3183: foreach my $hostid (sort(keys(%servers))) {
3184: $result.= '<option value="'.$hostid.'">'.
3185: $hostid.' '.$servers{$hostid}."</option>\n";
3186: }
3187: $result .= '</select>'."\n";
3188: } elsif ($numlib == 1) {
3189: my $hostid;
3190: foreach my $item (keys(%servers)) {
3191: $hostid = $item;
3192: }
3193: $result .= '<input type="hidden" name="'.$name.'" value="'.
3194: $hostid.'" />';
3195: if (!$hide) {
3196: $result .= $hostid.' '.$servers{$hostid};
3197: }
3198: $result .= "\n";
3199: } elsif ($default) {
3200: $result .= '<input type="hidden" name="'.$name.
3201: '" value="default" />';
3202: if (!$hide) {
3203: $result .= &mt('default');
3204: }
3205: $result .= "\n";
1.33 matthew 3206: }
1.586 raeburn 3207: return ($result,$numlib);
1.33 matthew 3208: }
1.112 bowersj2 3209:
3210: =pod
3211:
1.534 albertel 3212: =back
3213:
1.112 bowersj2 3214: =cut
1.87 matthew 3215:
3216: ###############################################################
1.112 bowersj2 3217: ## Decoding User Agent ##
1.87 matthew 3218: ###############################################################
3219:
3220: =pod
3221:
1.112 bowersj2 3222: =head1 Decoding the User Agent
3223:
3224: =over 4
3225:
3226: =item * &decode_user_agent()
1.87 matthew 3227:
3228: Inputs: $r
3229:
3230: Outputs:
3231:
3232: =over 4
3233:
1.112 bowersj2 3234: =item * $httpbrowser
1.87 matthew 3235:
1.112 bowersj2 3236: =item * $clientbrowser
1.87 matthew 3237:
1.112 bowersj2 3238: =item * $clientversion
1.87 matthew 3239:
1.112 bowersj2 3240: =item * $clientmathml
1.87 matthew 3241:
1.112 bowersj2 3242: =item * $clientunicode
1.87 matthew 3243:
1.112 bowersj2 3244: =item * $clientos
1.87 matthew 3245:
1.1137 raeburn 3246: =item * $clientmobile
3247:
1.1141 raeburn 3248: =item * $clientinfo
3249:
1.1194 raeburn 3250: =item * $clientosversion
3251:
1.87 matthew 3252: =back
3253:
1.157 matthew 3254: =back
3255:
1.87 matthew 3256: =cut
3257:
3258: ###############################################################
3259: ###############################################################
3260: sub decode_user_agent {
1.247 albertel 3261: my ($r)=@_;
1.87 matthew 3262: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3263: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3264: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3265: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3266: my $clientbrowser='unknown';
3267: my $clientversion='0';
3268: my $clientmathml='';
3269: my $clientunicode='0';
1.1137 raeburn 3270: my $clientmobile=0;
1.1194 raeburn 3271: my $clientosversion='';
1.87 matthew 3272: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3273: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3274: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3275: $clientbrowser=$bname;
3276: $httpbrowser=~/$vreg/i;
3277: $clientversion=$1;
3278: $clientmathml=($clientversion>=$minv);
3279: $clientunicode=($clientversion>=$univ);
3280: }
3281: }
3282: my $clientos='unknown';
1.1141 raeburn 3283: my $clientinfo;
1.87 matthew 3284: if (($httpbrowser=~/linux/i) ||
3285: ($httpbrowser=~/unix/i) ||
3286: ($httpbrowser=~/ux/i) ||
3287: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3288: if (($httpbrowser=~/vax/i) ||
3289: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3290: if ($httpbrowser=~/next/i) { $clientos='next'; }
3291: if (($httpbrowser=~/mac/i) ||
3292: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3293: if ($httpbrowser=~/win/i) {
3294: $clientos='win';
3295: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3296: $clientosversion = $1;
3297: }
3298: }
1.87 matthew 3299: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3300: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3301: $clientmobile=lc($1);
3302: }
1.1141 raeburn 3303: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3304: $clientinfo = 'firefox-'.$1;
3305: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3306: $clientinfo = 'chromeframe-'.$1;
3307: }
1.87 matthew 3308: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3309: $clientunicode,$clientos,$clientmobile,$clientinfo,
3310: $clientosversion);
1.87 matthew 3311: }
3312:
1.32 matthew 3313: ###############################################################
3314: ## Authentication changing form generation subroutines ##
3315: ###############################################################
3316: ##
3317: ## All of the authform_xxxxxxx subroutines take their inputs in a
3318: ## hash, and have reasonable default values.
3319: ##
3320: ## formname = the name given in the <form> tag.
1.35 matthew 3321: #-------------------------------------------
3322:
1.45 matthew 3323: =pod
3324:
1.112 bowersj2 3325: =head1 Authentication Routines
3326:
3327: =over 4
3328:
1.648 raeburn 3329: =item * &authform_xxxxxx()
1.35 matthew 3330:
3331: The authform_xxxxxx subroutines provide javascript and html forms which
3332: handle some of the conveniences required for authentication forms.
3333: This is not an optimal method, but it works.
3334:
3335: =over 4
3336:
1.112 bowersj2 3337: =item * authform_header
1.35 matthew 3338:
1.112 bowersj2 3339: =item * authform_authorwarning
1.35 matthew 3340:
1.112 bowersj2 3341: =item * authform_nochange
1.35 matthew 3342:
1.112 bowersj2 3343: =item * authform_kerberos
1.35 matthew 3344:
1.112 bowersj2 3345: =item * authform_internal
1.35 matthew 3346:
1.112 bowersj2 3347: =item * authform_filesystem
1.35 matthew 3348:
1.1310 raeburn 3349: =item * authform_lti
3350:
1.35 matthew 3351: =back
3352:
1.648 raeburn 3353: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3354:
1.35 matthew 3355: =cut
3356:
3357: #-------------------------------------------
1.32 matthew 3358: sub authform_header{
3359: my %in = (
3360: formname => 'cu',
1.80 albertel 3361: kerb_def_dom => '',
1.32 matthew 3362: @_,
3363: );
3364: $in{'formname'} = 'document.' . $in{'formname'};
3365: my $result='';
1.80 albertel 3366:
3367: #---------------------------------------------- Code for upper case translation
3368: my $Javascript_toUpperCase;
3369: unless ($in{kerb_def_dom}) {
3370: $Javascript_toUpperCase =<<"END";
3371: switch (choice) {
3372: case 'krb': currentform.elements[choicearg].value =
3373: currentform.elements[choicearg].value.toUpperCase();
3374: break;
3375: default:
3376: }
3377: END
3378: } else {
3379: $Javascript_toUpperCase = "";
3380: }
3381:
1.165 raeburn 3382: my $radioval = "'nochange'";
1.591 raeburn 3383: if (defined($in{'curr_authtype'})) {
3384: if ($in{'curr_authtype'} ne '') {
3385: $radioval = "'".$in{'curr_authtype'}."arg'";
3386: }
1.174 matthew 3387: }
1.165 raeburn 3388: my $argfield = 'null';
1.591 raeburn 3389: if (defined($in{'mode'})) {
1.165 raeburn 3390: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3391: if (defined($in{'curr_autharg'})) {
3392: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3393: $argfield = "'$in{'curr_autharg'}'";
3394: }
3395: }
3396: }
3397: }
3398:
1.32 matthew 3399: $result.=<<"END";
3400: var current = new Object();
1.165 raeburn 3401: current.radiovalue = $radioval;
3402: current.argfield = $argfield;
1.32 matthew 3403:
3404: function changed_radio(choice,currentform) {
3405: var choicearg = choice + 'arg';
3406: // If a radio button in changed, we need to change the argfield
3407: if (current.radiovalue != choice) {
3408: current.radiovalue = choice;
3409: if (current.argfield != null) {
3410: currentform.elements[current.argfield].value = '';
3411: }
3412: if (choice == 'nochange') {
3413: current.argfield = null;
3414: } else {
3415: current.argfield = choicearg;
3416: switch(choice) {
3417: case 'krb':
3418: currentform.elements[current.argfield].value =
3419: "$in{'kerb_def_dom'}";
3420: break;
3421: default:
3422: break;
3423: }
3424: }
3425: }
3426: return;
3427: }
1.22 www 3428:
1.32 matthew 3429: function changed_text(choice,currentform) {
3430: var choicearg = choice + 'arg';
3431: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3432: $Javascript_toUpperCase
1.32 matthew 3433: // clear old field
3434: if ((current.argfield != choicearg) && (current.argfield != null)) {
3435: currentform.elements[current.argfield].value = '';
3436: }
3437: current.argfield = choicearg;
3438: }
3439: set_auth_radio_buttons(choice,currentform);
3440: return;
1.20 www 3441: }
1.32 matthew 3442:
3443: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3444: var numauthchoices = currentform.login.length;
3445: if (typeof numauthchoices == "undefined") {
3446: return;
3447: }
1.32 matthew 3448: var i=0;
1.986 raeburn 3449: while (i < numauthchoices) {
1.32 matthew 3450: if (currentform.login[i].value == newvalue) { break; }
3451: i++;
3452: }
1.986 raeburn 3453: if (i == numauthchoices) {
1.32 matthew 3454: return;
3455: }
3456: current.radiovalue = newvalue;
3457: currentform.login[i].checked = true;
3458: return;
3459: }
3460: END
3461: return $result;
3462: }
3463:
1.1106 raeburn 3464: sub authform_authorwarning {
1.32 matthew 3465: my $result='';
1.144 matthew 3466: $result='<i>'.
3467: &mt('As a general rule, only authors or co-authors should be '.
3468: 'filesystem authenticated '.
3469: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3470: return $result;
3471: }
3472:
1.1106 raeburn 3473: sub authform_nochange {
1.32 matthew 3474: my %in = (
3475: formname => 'document.cu',
3476: kerb_def_dom => 'MSU.EDU',
3477: @_,
3478: );
1.1106 raeburn 3479: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3480: my $result;
1.1104 raeburn 3481: if (!$authnum) {
1.1105 raeburn 3482: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3483: } else {
3484: $result = '<label>'.&mt('[_1] Do not change login data',
3485: '<input type="radio" name="login" value="nochange" '.
3486: 'checked="checked" onclick="'.
1.281 albertel 3487: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3488: '</label>';
1.586 raeburn 3489: }
1.32 matthew 3490: return $result;
3491: }
3492:
1.591 raeburn 3493: sub authform_kerberos {
1.32 matthew 3494: my %in = (
3495: formname => 'document.cu',
3496: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3497: kerb_def_auth => 'krb4',
1.32 matthew 3498: @_,
3499: );
1.586 raeburn 3500: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3501: $autharg,$jscall,$disabled);
1.1106 raeburn 3502: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3503: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3504: $check5 = ' checked="checked"';
1.80 albertel 3505: } else {
1.772 bisitz 3506: $check4 = ' checked="checked"';
1.80 albertel 3507: }
1.1259 raeburn 3508: if ($in{'readonly'}) {
3509: $disabled = ' disabled="disabled"';
3510: }
1.165 raeburn 3511: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3512: if (defined($in{'curr_authtype'})) {
3513: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3514: $krbcheck = ' checked="checked"';
1.623 raeburn 3515: if (defined($in{'mode'})) {
3516: if ($in{'mode'} eq 'modifyuser') {
3517: $krbcheck = '';
3518: }
3519: }
1.591 raeburn 3520: if (defined($in{'curr_kerb_ver'})) {
3521: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3522: $check5 = ' checked="checked"';
1.591 raeburn 3523: $check4 = '';
3524: } else {
1.772 bisitz 3525: $check4 = ' checked="checked"';
1.591 raeburn 3526: $check5 = '';
3527: }
1.586 raeburn 3528: }
1.591 raeburn 3529: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3530: $krbarg = $in{'curr_autharg'};
3531: }
1.586 raeburn 3532: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3533: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3534: $result =
3535: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3536: $in{'curr_autharg'},$krbver);
3537: } else {
3538: $result =
3539: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3540: }
3541: return $result;
3542: }
3543: }
3544: } else {
3545: if ($authnum == 1) {
1.784 bisitz 3546: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3547: }
3548: }
1.586 raeburn 3549: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3550: return;
1.587 raeburn 3551: } elsif ($authtype eq '') {
1.591 raeburn 3552: if (defined($in{'mode'})) {
1.587 raeburn 3553: if ($in{'mode'} eq 'modifycourse') {
3554: if ($authnum == 1) {
1.1259 raeburn 3555: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3556: }
3557: }
3558: }
1.586 raeburn 3559: }
3560: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3561: if ($authtype eq '') {
3562: $authtype = '<input type="radio" name="login" value="krb" '.
3563: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3564: $krbcheck.$disabled.' />';
1.586 raeburn 3565: }
3566: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3567: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3568: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3569: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3570: $in{'curr_authtype'} eq 'krb4')) {
3571: $result .= &mt
1.144 matthew 3572: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3573: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3574: '<label>'.$authtype,
1.281 albertel 3575: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3576: 'value="'.$krbarg.'" '.
1.1259 raeburn 3577: 'onchange="'.$jscall.'"'.$disabled.' />',
3578: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3579: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3580: '</label>');
1.586 raeburn 3581: } elsif ($can_assign{'krb4'}) {
3582: $result .= &mt
3583: ('[_1] Kerberos authenticated with domain [_2] '.
3584: '[_3] Version 4 [_4]',
3585: '<label>'.$authtype,
3586: '</label><input type="text" size="10" name="krbarg" '.
3587: 'value="'.$krbarg.'" '.
1.1259 raeburn 3588: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3589: '<label><input type="hidden" name="krbver" value="4" />',
3590: '</label>');
3591: } elsif ($can_assign{'krb5'}) {
3592: $result .= &mt
3593: ('[_1] Kerberos authenticated with domain [_2] '.
3594: '[_3] Version 5 [_4]',
3595: '<label>'.$authtype,
3596: '</label><input type="text" size="10" name="krbarg" '.
3597: 'value="'.$krbarg.'" '.
1.1259 raeburn 3598: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3599: '<label><input type="hidden" name="krbver" value="5" />',
3600: '</label>');
3601: }
1.32 matthew 3602: return $result;
3603: }
3604:
1.1106 raeburn 3605: sub authform_internal {
1.586 raeburn 3606: my %in = (
1.32 matthew 3607: formname => 'document.cu',
3608: kerb_def_dom => 'MSU.EDU',
3609: @_,
3610: );
1.1259 raeburn 3611: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3612: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3613: if ($in{'readonly'}) {
3614: $disabled = ' disabled="disabled"';
3615: }
1.591 raeburn 3616: if (defined($in{'curr_authtype'})) {
3617: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3618: if ($can_assign{'int'}) {
1.772 bisitz 3619: $intcheck = 'checked="checked" ';
1.623 raeburn 3620: if (defined($in{'mode'})) {
3621: if ($in{'mode'} eq 'modifyuser') {
3622: $intcheck = '';
3623: }
3624: }
1.591 raeburn 3625: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3626: $intarg = $in{'curr_autharg'};
3627: }
3628: } else {
3629: $result = &mt('Currently internally authenticated.');
3630: return $result;
1.165 raeburn 3631: }
3632: }
1.586 raeburn 3633: } else {
3634: if ($authnum == 1) {
1.784 bisitz 3635: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3636: }
3637: }
3638: if (!$can_assign{'int'}) {
3639: return;
1.587 raeburn 3640: } elsif ($authtype eq '') {
1.591 raeburn 3641: if (defined($in{'mode'})) {
1.587 raeburn 3642: if ($in{'mode'} eq 'modifycourse') {
3643: if ($authnum == 1) {
1.1259 raeburn 3644: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3645: }
3646: }
3647: }
1.165 raeburn 3648: }
1.586 raeburn 3649: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3650: if ($authtype eq '') {
3651: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3652: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3653: }
1.605 bisitz 3654: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3655: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3656: $result = &mt
1.144 matthew 3657: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3658: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3659: $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 3660: return $result;
3661: }
3662:
1.1104 raeburn 3663: sub authform_local {
1.32 matthew 3664: my %in = (
3665: formname => 'document.cu',
3666: kerb_def_dom => 'MSU.EDU',
3667: @_,
3668: );
1.1259 raeburn 3669: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3670: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3671: if ($in{'readonly'}) {
3672: $disabled = ' disabled="disabled"';
3673: }
1.591 raeburn 3674: if (defined($in{'curr_authtype'})) {
3675: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3676: if ($can_assign{'loc'}) {
1.772 bisitz 3677: $loccheck = 'checked="checked" ';
1.623 raeburn 3678: if (defined($in{'mode'})) {
3679: if ($in{'mode'} eq 'modifyuser') {
3680: $loccheck = '';
3681: }
3682: }
1.591 raeburn 3683: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3684: $locarg = $in{'curr_autharg'};
3685: }
3686: } else {
3687: $result = &mt('Currently using local (institutional) authentication.');
3688: return $result;
1.165 raeburn 3689: }
3690: }
1.586 raeburn 3691: } else {
3692: if ($authnum == 1) {
1.784 bisitz 3693: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3694: }
3695: }
3696: if (!$can_assign{'loc'}) {
3697: return;
1.587 raeburn 3698: } elsif ($authtype eq '') {
1.591 raeburn 3699: if (defined($in{'mode'})) {
1.587 raeburn 3700: if ($in{'mode'} eq 'modifycourse') {
3701: if ($authnum == 1) {
1.1259 raeburn 3702: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3703: }
3704: }
3705: }
1.165 raeburn 3706: }
1.586 raeburn 3707: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3708: if ($authtype eq '') {
3709: $authtype = '<input type="radio" name="login" value="loc" '.
3710: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3711: $jscall.'"'.$disabled.' />';
1.586 raeburn 3712: }
3713: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3714: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3715: $result = &mt('[_1] Local Authentication with argument [_2]',
3716: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3717: return $result;
3718: }
3719:
1.1106 raeburn 3720: sub authform_filesystem {
1.32 matthew 3721: my %in = (
3722: formname => 'document.cu',
3723: kerb_def_dom => 'MSU.EDU',
3724: @_,
3725: );
1.1259 raeburn 3726: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3727: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3728: if ($in{'readonly'}) {
3729: $disabled = ' disabled="disabled"';
3730: }
1.591 raeburn 3731: if (defined($in{'curr_authtype'})) {
3732: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3733: if ($can_assign{'fsys'}) {
1.772 bisitz 3734: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3735: if (defined($in{'mode'})) {
3736: if ($in{'mode'} eq 'modifyuser') {
3737: $fsyscheck = '';
3738: }
3739: }
1.586 raeburn 3740: } else {
3741: $result = &mt('Currently Filesystem Authenticated.');
3742: return $result;
1.1259 raeburn 3743: }
1.586 raeburn 3744: }
3745: } else {
3746: if ($authnum == 1) {
1.784 bisitz 3747: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3748: }
3749: }
3750: if (!$can_assign{'fsys'}) {
3751: return;
1.587 raeburn 3752: } elsif ($authtype eq '') {
1.591 raeburn 3753: if (defined($in{'mode'})) {
1.587 raeburn 3754: if ($in{'mode'} eq 'modifycourse') {
3755: if ($authnum == 1) {
1.1259 raeburn 3756: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3757: }
3758: }
3759: }
1.586 raeburn 3760: }
3761: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3762: if ($authtype eq '') {
3763: $authtype = '<input type="radio" name="login" value="fsys" '.
3764: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3765: $jscall.'"'.$disabled.' />';
1.586 raeburn 3766: }
1.1310 raeburn 3767: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3768: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3769: $result = &mt
1.144 matthew 3770: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3771: '<label>'.$authtype,'</label>'.$autharg);
3772: return $result;
3773: }
3774:
3775: sub authform_lti {
3776: my %in = (
3777: formname => 'document.cu',
3778: kerb_def_dom => 'MSU.EDU',
3779: @_,
3780: );
3781: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3782: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3783: if ($in{'readonly'}) {
3784: $disabled = ' disabled="disabled"';
3785: }
3786: if (defined($in{'curr_authtype'})) {
3787: if ($in{'curr_authtype'} eq 'lti') {
3788: if ($can_assign{'lti'}) {
3789: $lticheck = 'checked="checked" ';
3790: if (defined($in{'mode'})) {
3791: if ($in{'mode'} eq 'modifyuser') {
3792: $lticheck = '';
3793: }
3794: }
3795: } else {
3796: $result = &mt('Currently LTI Authenticated.');
3797: return $result;
3798: }
3799: }
3800: } else {
3801: if ($authnum == 1) {
3802: $authtype = '<input type="hidden" name="login" value="lti" />';
3803: }
3804: }
3805: if (!$can_assign{'lti'}) {
3806: return;
3807: } elsif ($authtype eq '') {
3808: if (defined($in{'mode'})) {
3809: if ($in{'mode'} eq 'modifycourse') {
3810: if ($authnum == 1) {
3811: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3812: }
3813: }
3814: }
3815: }
3816: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3817: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3818: $authtype = '<input type="radio" name="login" value="lti" '.
3819: $lticheck.' onchange="'.$jscall.'" onclick="'.
3820: $jscall.'"'.$disabled.' />';
3821: }
3822: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3823: if ($authtype) {
3824: $result = &mt('[_1] LTI Authenticated',
3825: '<label>'.$authtype.'</label>'.$autharg);
3826: } else {
3827: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3828: $autharg;
3829: }
1.32 matthew 3830: return $result;
3831: }
3832:
1.586 raeburn 3833: sub get_assignable_auth {
3834: my ($dom) = @_;
3835: if ($dom eq '') {
3836: $dom = $env{'request.role.domain'};
3837: }
3838: my %can_assign = (
3839: krb4 => 1,
3840: krb5 => 1,
3841: int => 1,
3842: loc => 1,
1.1310 raeburn 3843: lti => 1,
1.586 raeburn 3844: );
3845: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3846: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3847: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3848: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3849: my $context;
3850: if ($env{'request.role'} =~ /^au/) {
3851: $context = 'author';
1.1259 raeburn 3852: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3853: $context = 'domain';
3854: } elsif ($env{'request.course.id'}) {
3855: $context = 'course';
3856: }
3857: if ($context) {
3858: if (ref($authhash->{$context}) eq 'HASH') {
3859: %can_assign = %{$authhash->{$context}};
3860: }
3861: }
3862: }
3863: }
3864: my $authnum = 0;
3865: foreach my $key (keys(%can_assign)) {
3866: if ($can_assign{$key}) {
3867: $authnum ++;
3868: }
3869: }
3870: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3871: $authnum --;
3872: }
3873: return ($authnum,%can_assign);
3874: }
3875:
1.1331 raeburn 3876: sub check_passwd_rules {
3877: my ($domain,$plainpass) = @_;
3878: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3879: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3880: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3881: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3882: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3883: if ($passwdconf{'min'} > $min) {
3884: $min = $passwdconf{'min'};
3885: }
1.1331 raeburn 3886: }
3887: if ($passwdconf{'max'} =~ /^\d+$/) {
3888: $max = $passwdconf{'max'};
3889: }
3890: @chars = @{$passwdconf{'chars'}};
3891: }
3892: if (($min) && (length($plainpass) < $min)) {
3893: push(@brokerule,'min');
3894: }
3895: if (($max) && (length($plainpass) > $max)) {
3896: push(@brokerule,'max');
3897: }
3898: if (@chars) {
3899: my %rules;
3900: map { $rules{$_} = 1; } @chars;
3901: if ($rules{'uc'}) {
3902: unless ($plainpass =~ /[A-Z]/) {
3903: push(@brokerule,'uc');
3904: }
3905: }
3906: if ($rules{'lc'}) {
1.1332 raeburn 3907: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3908: push(@brokerule,'lc');
3909: }
3910: }
3911: if ($rules{'num'}) {
3912: unless ($plainpass =~ /\d/) {
3913: push(@brokerule,'num');
3914: }
3915: }
3916: if ($rules{'spec'}) {
3917: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3918: push(@brokerule,'spec');
3919: }
3920: }
3921: }
3922: if (@brokerule) {
3923: my %rulenames = &Apache::lonlocal::texthash(
3924: uc => 'At least one upper case letter',
3925: lc => 'At least one lower case letter',
3926: num => 'At least one number',
3927: spec => 'At least one non-alphanumeric',
3928: );
3929: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3930: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3931: $rulenames{'num'} .= ': 0123456789';
3932: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3933: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3934: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3935: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3936: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3937: if (grep(/^$rule$/,@brokerule)) {
3938: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3939: }
3940: }
3941: $warning .= '</ul>';
3942: }
1.1332 raeburn 3943: if (wantarray) {
3944: return @brokerule;
3945: }
1.1331 raeburn 3946: return $warning;
3947: }
3948:
1.1376 raeburn 3949: sub passwd_validation_js {
1.1377 raeburn 3950: my ($currpasswdval,$domain,$context,$id) = @_;
3951: my (%passwdconf,$alertmsg);
3952: if ($context eq 'linkprot') {
3953: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3954: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3955: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3956: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3957: }
3958: }
3959: if ($id eq 'add') {
3960: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3961: } elsif ($id =~ /^\d+$/) {
3962: my $pos = $id+1;
3963: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3964: } else {
3965: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3966: }
1.1434 raeburn 3967: } elsif ($context eq 'ltitools') {
3968: my %domconfig = &Apache::lonnet::get_dom('configuration',['toolsec'],$domain);
3969: if (ref($domconfig{'toolsec'}) eq 'HASH') {
3970: if (ref($domconfig{'toolsec'}{'rules'}) eq 'HASH') {
3971: %passwdconf = %{$domconfig{'toolsec'}{'rules'}};
3972: }
3973: }
3974: if ($id eq 'add') {
3975: $alertmsg = &mt('Secret for added external tool did not satisfy requirement(s):').'\n\n';
3976: } elsif ($id =~ /^\d+$/) {
3977: my $pos = $id+1;
3978: $alertmsg = &mt('Secret for external tool [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3979: } else {
3980: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3981: }
1.1377 raeburn 3982: } else {
3983: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3984: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3985: }
1.1376 raeburn 3986: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3987: $numrules = 0;
3988: $min = $Apache::lonnet::passwdmin;
3989: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3990: if ($passwdconf{'min'} =~ /^\d+$/) {
3991: if ($passwdconf{'min'} > $min) {
3992: $min = $passwdconf{'min'};
3993: }
3994: }
3995: if ($passwdconf{'max'} =~ /^\d+$/) {
3996: $max = $passwdconf{'max'};
3997: $numrules ++;
3998: }
3999: @chars = @{$passwdconf{'chars'}};
4000: if (@chars) {
4001: $numrules ++;
4002: }
4003: }
4004: if ($min > 0) {
4005: $numrules ++;
4006: }
4007: if (($min > 0) || ($max ne '') || (@chars > 0)) {
4008: if ($min) {
4009: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
4010: }
4011: if ($max) {
4012: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
4013: }
4014: my (@charalerts,@charrules);
4015: if (@chars) {
4016: if (grep(/^uc$/,@chars)) {
4017: push(@charalerts,&mt('contain at least one upper case letter'));
4018: push(@charrules,'uc');
4019: }
4020: if (grep(/^lc$/,@chars)) {
4021: push(@charalerts,&mt('contain at least one lower case letter'));
4022: push(@charrules,'lc');
4023: }
4024: if (grep(/^num$/,@chars)) {
4025: push(@charalerts,&mt('contain at least one number'));
4026: push(@charrules,'num');
4027: }
4028: if (grep(/^spec$/,@chars)) {
4029: push(@charalerts,&mt('contain at least one non-alphanumeric'));
4030: push(@charrules,'spec');
4031: }
4032: }
4033: $intargjs = qq| var rulesmsg = '';\n|.
4034: qq| var currpwval = $currpasswdval;\n|;
4035: if ($min) {
4036: $intargjs .= qq|
4037: if (currpwval.length < $min) {
4038: rulesmsg += ' - $alert{min}';
4039: }
4040: |;
4041: }
4042: if ($max) {
4043: $intargjs .= qq|
4044: if (currpwval.length > $max) {
4045: rulesmsg += ' - $alert{max}';
4046: }
4047: |;
4048: }
4049: if (@chars > 0) {
4050: my $charrulestr = '"'.join('","',@charrules).'"';
4051: my $charalertstr = '"'.join('","',@charalerts).'"';
4052: $intargjs .= qq| var brokerules = new Array();\n|.
4053: qq| var charrules = new Array($charrulestr);\n|.
4054: qq| var charalerts = new Array($charalertstr);\n|;
4055: my %rules;
4056: map { $rules{$_} = 1; } @chars;
4057: if ($rules{'uc'}) {
4058: $intargjs .= qq|
4059: var ucRegExp = /[A-Z]/;
4060: if (!ucRegExp.test(currpwval)) {
4061: brokerules.push('uc');
4062: }
4063: |;
4064: }
4065: if ($rules{'lc'}) {
4066: $intargjs .= qq|
4067: var lcRegExp = /[a-z]/;
4068: if (!lcRegExp.test(currpwval)) {
4069: brokerules.push('lc');
4070: }
4071: |;
4072: }
4073: if ($rules{'num'}) {
4074: $intargjs .= qq|
4075: var numRegExp = /[0-9]/;
4076: if (!numRegExp.test(currpwval)) {
4077: brokerules.push('num');
4078: }
4079: |;
4080: }
4081: if ($rules{'spec'}) {
4082: $intargjs .= q|
4083: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
4084: if (!specRegExp.test(currpwval)) {
4085: brokerules.push('spec');
4086: }
4087: |;
4088: }
4089: $intargjs .= qq|
4090: if (brokerules.length > 0) {
4091: for (var i=0; i<brokerules.length; i++) {
4092: for (var j=0; j<charrules.length; j++) {
4093: if (brokerules[i] == charrules[j]) {
4094: rulesmsg += ' - '+charalerts[j]+'\\n';
4095: break;
4096: }
4097: }
4098: }
4099: }
4100: |;
4101: }
4102: $intargjs .= qq|
4103: if (rulesmsg != '') {
4104: rulesmsg = '$alertmsg'+rulesmsg;
4105: alert(rulesmsg);
4106: return false;
4107: }
4108: |;
4109: }
4110: return ($numrules,$intargjs);
4111: }
4112:
1.80 albertel 4113: ###############################################################
4114: ## Get Kerberos Defaults for Domain ##
4115: ###############################################################
4116: ##
4117: ## Returns default kerberos version and an associated argument
4118: ## as listed in file domain.tab. If not listed, provides
4119: ## appropriate default domain and kerberos version.
4120: ##
4121: #-------------------------------------------
4122:
4123: =pod
4124:
1.648 raeburn 4125: =item * &get_kerberos_defaults()
1.80 albertel 4126:
4127: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 4128: version and domain. If not found, it defaults to version 4 and the
4129: domain of the server.
1.80 albertel 4130:
1.648 raeburn 4131: =over 4
4132:
1.80 albertel 4133: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
4134:
1.648 raeburn 4135: =back
4136:
4137: =back
4138:
1.80 albertel 4139: =cut
4140:
4141: #-------------------------------------------
4142: sub get_kerberos_defaults {
4143: my $domain=shift;
1.641 raeburn 4144: my ($krbdef,$krbdefdom);
4145: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
4146: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
4147: $krbdef = $domdefaults{'auth_def'};
4148: $krbdefdom = $domdefaults{'auth_arg_def'};
4149: } else {
1.80 albertel 4150: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
4151: my $krbdefdom=$1;
4152: $krbdefdom=~tr/a-z/A-Z/;
4153: $krbdef = "krb4";
4154: }
4155: return ($krbdef,$krbdefdom);
4156: }
1.112 bowersj2 4157:
1.32 matthew 4158:
1.46 matthew 4159: ###############################################################
4160: ## Thesaurus Functions ##
4161: ###############################################################
1.20 www 4162:
1.46 matthew 4163: =pod
1.20 www 4164:
1.112 bowersj2 4165: =head1 Thesaurus Functions
4166:
4167: =over 4
4168:
1.648 raeburn 4169: =item * &initialize_keywords()
1.46 matthew 4170:
4171: Initializes the package variable %Keywords if it is empty. Uses the
4172: package variable $thesaurus_db_file.
4173:
4174: =cut
4175:
4176: ###################################################
4177:
4178: sub initialize_keywords {
4179: return 1 if (scalar keys(%Keywords));
4180: # If we are here, %Keywords is empty, so fill it up
4181: # Make sure the file we need exists...
4182: if (! -e $thesaurus_db_file) {
4183: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
4184: " failed because it does not exist");
4185: return 0;
4186: }
4187: # Set up the hash as a database
4188: my %thesaurus_db;
4189: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4190: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4191: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
4192: $thesaurus_db_file);
4193: return 0;
4194: }
4195: # Get the average number of appearances of a word.
4196: my $avecount = $thesaurus_db{'average.count'};
4197: # Put keywords (those that appear > average) into %Keywords
4198: while (my ($word,$data)=each (%thesaurus_db)) {
4199: my ($count,undef) = split /:/,$data;
4200: $Keywords{$word}++ if ($count > $avecount);
4201: }
4202: untie %thesaurus_db;
4203: # Remove special values from %Keywords.
1.356 albertel 4204: foreach my $value ('total.count','average.count') {
4205: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4206: }
1.46 matthew 4207: return 1;
4208: }
4209:
4210: ###################################################
4211:
4212: =pod
4213:
1.648 raeburn 4214: =item * &keyword($word)
1.46 matthew 4215:
4216: Returns true if $word is a keyword. A keyword is a word that appears more
4217: than the average number of times in the thesaurus database. Calls
4218: &initialize_keywords
4219:
4220: =cut
4221:
4222: ###################################################
1.20 www 4223:
4224: sub keyword {
1.46 matthew 4225: return if (!&initialize_keywords());
4226: my $word=lc(shift());
4227: $word=~s/\W//g;
4228: return exists($Keywords{$word});
1.20 www 4229: }
1.46 matthew 4230:
4231: ###############################################################
4232:
4233: =pod
1.20 www 4234:
1.648 raeburn 4235: =item * &get_related_words()
1.46 matthew 4236:
1.160 matthew 4237: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4238: an array of words. If the keyword is not in the thesaurus, an empty array
4239: will be returned. The order of the words returned is determined by the
4240: database which holds them.
4241:
4242: Uses global $thesaurus_db_file.
4243:
1.1057 foxr 4244:
1.46 matthew 4245: =cut
4246:
4247: ###############################################################
4248: sub get_related_words {
4249: my $keyword = shift;
4250: my %thesaurus_db;
4251: if (! -e $thesaurus_db_file) {
4252: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4253: "failed because the file does not exist");
4254: return ();
4255: }
4256: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4257: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4258: return ();
4259: }
4260: my @Words=();
1.429 www 4261: my $count=0;
1.46 matthew 4262: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4263: # The first element is the number of times
4264: # the word appears. We do not need it now.
1.429 www 4265: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4266: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4267: my $threshold=$mostfrequentcount/10;
4268: foreach my $possibleword (@RelatedWords) {
4269: my ($word,$wordcount)=split(/\,/,$possibleword);
4270: if ($wordcount>$threshold) {
4271: push(@Words,$word);
4272: $count++;
4273: if ($count>10) { last; }
4274: }
1.20 www 4275: }
4276: }
1.46 matthew 4277: untie %thesaurus_db;
4278: return @Words;
1.14 harris41 4279: }
1.1090 foxr 4280: ###############################################################
4281: #
4282: # Spell checking
4283: #
4284:
4285: =pod
4286:
1.1142 raeburn 4287: =back
4288:
1.1090 foxr 4289: =head1 Spell checking
4290:
4291: =over 4
4292:
4293: =item * &check_spelling($wordlist $language)
4294:
4295: Takes a string containing words and feeds it to an external
4296: spellcheck program via a pipeline. Returns a string containing
4297: them mis-spelled words.
4298:
4299: Parameters:
4300:
4301: =over 4
4302:
4303: =item - $wordlist
4304:
4305: String that will be fed into the spellcheck program.
4306:
4307: =item - $language
4308:
4309: Language string that specifies the language for which the spell
4310: check will be performed.
4311:
4312: =back
4313:
4314: =back
4315:
4316: Note: This sub assumes that aspell is installed.
4317:
4318:
4319: =cut
4320:
1.46 matthew 4321:
1.1090 foxr 4322: sub check_spelling {
4323: my ($wordlist, $language) = @_;
1.1091 foxr 4324: my @misspellings;
4325:
4326: # Generate the speller and set the langauge.
4327: # if explicitly selected:
1.1090 foxr 4328:
1.1091 foxr 4329: my $speller = Text::Aspell->new;
1.1090 foxr 4330: if ($language) {
1.1091 foxr 4331: $speller->set_option('lang', $language);
1.1090 foxr 4332: }
4333:
1.1091 foxr 4334: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4335:
1.1091 foxr 4336: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4337:
1.1091 foxr 4338: foreach my $word (@words) {
4339: if(! $speller->check($word)) {
4340: push(@misspellings, $word);
1.1090 foxr 4341: }
4342: }
1.1091 foxr 4343: return join(' ', @misspellings);
4344:
1.1090 foxr 4345: }
4346:
1.61 www 4347: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4348: =pod
4349:
1.112 bowersj2 4350: =head1 User Name Functions
4351:
4352: =over 4
4353:
1.648 raeburn 4354: =item * &plainname($uname,$udom,$first)
1.81 albertel 4355:
1.112 bowersj2 4356: Takes a users logon name and returns it as a string in
1.226 albertel 4357: "first middle last generation" form
4358: if $first is set to 'lastname' then it returns it as
4359: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4360:
4361: =cut
1.61 www 4362:
1.295 www 4363:
1.81 albertel 4364: ###############################################################
1.61 www 4365: sub plainname {
1.226 albertel 4366: my ($uname,$udom,$first)=@_;
1.537 albertel 4367: return if (!defined($uname) || !defined($udom));
1.295 www 4368: my %names=&getnames($uname,$udom);
1.226 albertel 4369: my $name=&Apache::lonnet::format_name($names{'firstname'},
4370: $names{'middlename'},
4371: $names{'lastname'},
4372: $names{'generation'},$first);
4373: $name=~s/^\s+//;
1.62 www 4374: $name=~s/\s+$//;
4375: $name=~s/\s+/ /g;
1.353 albertel 4376: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4377: return $name;
1.61 www 4378: }
1.66 www 4379:
4380: # -------------------------------------------------------------------- Nickname
1.81 albertel 4381: =pod
4382:
1.648 raeburn 4383: =item * &nickname($uname,$udom)
1.81 albertel 4384:
4385: Gets a users name and returns it as a string as
4386:
4387: ""nickname""
1.66 www 4388:
1.81 albertel 4389: if the user has a nickname or
4390:
4391: "first middle last generation"
4392:
4393: if the user does not
4394:
4395: =cut
1.66 www 4396:
4397: sub nickname {
4398: my ($uname,$udom)=@_;
1.537 albertel 4399: return if (!defined($uname) || !defined($udom));
1.295 www 4400: my %names=&getnames($uname,$udom);
1.68 albertel 4401: my $name=$names{'nickname'};
1.66 www 4402: if ($name) {
4403: $name='"'.$name.'"';
4404: } else {
4405: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4406: $names{'lastname'}.' '.$names{'generation'};
4407: $name=~s/\s+$//;
4408: $name=~s/\s+/ /g;
4409: }
4410: return $name;
4411: }
4412:
1.295 www 4413: sub getnames {
4414: my ($uname,$udom)=@_;
1.537 albertel 4415: return if (!defined($uname) || !defined($udom));
1.433 albertel 4416: if ($udom eq 'public' && $uname eq 'public') {
4417: return ('lastname' => &mt('Public'));
4418: }
1.295 www 4419: my $id=$uname.':'.$udom;
4420: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4421: if ($cached) {
4422: return %{$names};
4423: } else {
4424: my %loadnames=&Apache::lonnet::get('environment',
4425: ['firstname','middlename','lastname','generation','nickname'],
4426: $udom,$uname);
4427: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4428: return %loadnames;
4429: }
4430: }
1.61 www 4431:
1.542 raeburn 4432: # -------------------------------------------------------------------- getemails
1.648 raeburn 4433:
1.542 raeburn 4434: =pod
4435:
1.648 raeburn 4436: =item * &getemails($uname,$udom)
1.542 raeburn 4437:
4438: Gets a user's email information and returns it as a hash with keys:
4439: notification, critnotification, permanentemail
4440:
4441: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4442: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4443:
1.648 raeburn 4444:
1.542 raeburn 4445: =cut
4446:
1.648 raeburn 4447:
1.466 albertel 4448: sub getemails {
4449: my ($uname,$udom)=@_;
4450: if ($udom eq 'public' && $uname eq 'public') {
4451: return;
4452: }
1.467 www 4453: if (!$udom) { $udom=$env{'user.domain'}; }
4454: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4455: my $id=$uname.':'.$udom;
4456: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4457: if ($cached) {
4458: return %{$names};
4459: } else {
4460: my %loadnames=&Apache::lonnet::get('environment',
4461: ['notification','critnotification',
4462: 'permanentemail'],
4463: $udom,$uname);
4464: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4465: return %loadnames;
4466: }
4467: }
4468:
1.551 albertel 4469: sub flush_email_cache {
4470: my ($uname,$udom)=@_;
4471: if (!$udom) { $udom =$env{'user.domain'}; }
4472: if (!$uname) { $uname=$env{'user.name'}; }
4473: return if ($udom eq 'public' && $uname eq 'public');
4474: my $id=$uname.':'.$udom;
4475: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4476: }
4477:
1.728 raeburn 4478: # -------------------------------------------------------------------- getlangs
4479:
4480: =pod
4481:
4482: =item * &getlangs($uname,$udom)
4483:
4484: Gets a user's language preference and returns it as a hash with key:
4485: language.
4486:
4487: =cut
4488:
4489:
4490: sub getlangs {
4491: my ($uname,$udom) = @_;
4492: if (!$udom) { $udom =$env{'user.domain'}; }
4493: if (!$uname) { $uname=$env{'user.name'}; }
4494: my $id=$uname.':'.$udom;
4495: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4496: if ($cached) {
4497: return %{$langs};
4498: } else {
4499: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4500: $udom,$uname);
4501: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4502: return %loadlangs;
4503: }
4504: }
4505:
4506: sub flush_langs_cache {
4507: my ($uname,$udom)=@_;
4508: if (!$udom) { $udom =$env{'user.domain'}; }
4509: if (!$uname) { $uname=$env{'user.name'}; }
4510: return if ($udom eq 'public' && $uname eq 'public');
4511: my $id=$uname.':'.$udom;
4512: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4513: }
4514:
1.61 www 4515: # ------------------------------------------------------------------ Screenname
1.81 albertel 4516:
4517: =pod
4518:
1.648 raeburn 4519: =item * &screenname($uname,$udom)
1.81 albertel 4520:
4521: Gets a users screenname and returns it as a string
4522:
4523: =cut
1.61 www 4524:
4525: sub screenname {
4526: my ($uname,$udom)=@_;
1.258 albertel 4527: if ($uname eq $env{'user.name'} &&
4528: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4529: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4530: return $names{'screenname'};
1.62 www 4531: }
4532:
1.212 albertel 4533:
1.802 bisitz 4534: # ------------------------------------------------------------- Confirm Wrapper
4535: =pod
4536:
1.1142 raeburn 4537: =item * &confirmwrapper($message)
1.802 bisitz 4538:
4539: Wrap messages about completion of operation in box
4540:
4541: =cut
4542:
4543: sub confirmwrapper {
4544: my ($message)=@_;
4545: if ($message) {
4546: return "\n".'<div class="LC_confirm_box">'."\n"
4547: .$message."\n"
4548: .'</div>'."\n";
4549: } else {
4550: return $message;
4551: }
4552: }
4553:
1.62 www 4554: # ------------------------------------------------------------- Message Wrapper
4555:
4556: sub messagewrapper {
1.369 www 4557: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4558: return
1.441 albertel 4559: '<a href="/adm/email?compose=individual&'.
4560: 'recname='.$username.'&recdom='.$domain.
4561: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4562: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4563: }
1.802 bisitz 4564:
1.74 www 4565: # --------------------------------------------------------------- Notes Wrapper
4566:
4567: sub noteswrapper {
4568: my ($link,$un,$do)=@_;
4569: return
1.896 amueller 4570: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4571: }
1.802 bisitz 4572:
1.62 www 4573: # ------------------------------------------------------------- Aboutme Wrapper
4574:
4575: sub aboutmewrapper {
1.1070 raeburn 4576: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4577: if (!defined($username) && !defined($domain)) {
4578: return;
4579: }
1.1096 raeburn 4580: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4581: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4582: }
4583:
4584: # ------------------------------------------------------------ Syllabus Wrapper
4585:
4586: sub syllabuswrapper {
1.707 bisitz 4587: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4588: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4589: }
1.14 harris41 4590:
1.1397 raeburn 4591: # -----------------------------------------------------------------------------
4592:
1.1396 raeburn 4593: sub aboutme_on {
4594: my ($uname,$udom)=@_;
4595: unless ($uname) { $uname=$env{'user.name'}; }
4596: unless ($udom) { $udom=$env{'user.domain'}; }
4597: return if ($udom eq 'public' && $uname eq 'public');
4598: my $hashkey=$uname.':'.$udom;
4599: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4600: if ($cached) {
4601: return $aboutme;
4602: }
4603: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4604: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4605: return $aboutme;
4606: }
4607:
4608: sub devalidate_aboutme_cache {
4609: my ($uname,$udom)=@_;
4610: if (!$udom) { $udom =$env{'user.domain'}; }
4611: if (!$uname) { $uname=$env{'user.name'}; }
4612: return if ($udom eq 'public' && $uname eq 'public');
4613: my $id=$uname.':'.$udom;
4614: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4615: }
4616:
1.208 matthew 4617: sub track_student_link {
1.887 raeburn 4618: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4619: my $link ="/adm/trackstudent?";
1.208 matthew 4620: my $title = 'View recent activity';
4621: if (defined($sname) && $sname !~ /^\s*$/ &&
4622: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4623: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4624: $title .= ' of this student';
1.268 albertel 4625: }
1.208 matthew 4626: if (defined($target) && $target !~ /^\s*$/) {
4627: $target = qq{target="$target"};
4628: } else {
4629: $target = '';
4630: }
1.268 albertel 4631: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4632: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4633: $title = &mt($title);
4634: $linktext = &mt($linktext);
1.448 albertel 4635: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4636: &help_open_topic('View_recent_activity');
1.208 matthew 4637: }
4638:
1.781 raeburn 4639: sub slot_reservations_link {
4640: my ($linktext,$sname,$sdom,$target) = @_;
4641: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4642: my $title = 'View slot reservation history';
4643: if (defined($sname) && $sname !~ /^\s*$/ &&
4644: defined($sdom) && $sdom !~ /^\s*$/) {
4645: $link .= "&uname=$sname&udom=$sdom";
4646: $title .= ' of this student';
4647: }
4648: if (defined($target) && $target !~ /^\s*$/) {
4649: $target = qq{target="$target"};
4650: } else {
4651: $target = '';
4652: }
4653: $title = &mt($title);
4654: $linktext = &mt($linktext);
4655: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4656: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4657:
4658: }
4659:
1.508 www 4660: # ===================================================== Display a student photo
4661:
4662:
1.509 albertel 4663: sub student_image_tag {
1.508 www 4664: my ($domain,$user)=@_;
4665: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4666: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4667: return '<img src="'.$imgsrc.'" align="right" />';
4668: } else {
4669: return '';
4670: }
4671: }
4672:
1.112 bowersj2 4673: =pod
4674:
4675: =back
4676:
4677: =head1 Access .tab File Data
4678:
4679: =over 4
4680:
1.648 raeburn 4681: =item * &languageids()
1.112 bowersj2 4682:
4683: returns list of all language ids
4684:
4685: =cut
4686:
1.14 harris41 4687: sub languageids {
1.16 harris41 4688: return sort(keys(%language));
1.14 harris41 4689: }
4690:
1.112 bowersj2 4691: =pod
4692:
1.648 raeburn 4693: =item * &languagedescription()
1.112 bowersj2 4694:
4695: returns description of a specified language id
4696:
4697: =cut
4698:
1.14 harris41 4699: sub languagedescription {
1.125 www 4700: my $code=shift;
4701: return ($supported_language{$code}?'* ':'').
4702: $language{$code}.
1.126 www 4703: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4704: }
4705:
1.1048 foxr 4706: =pod
4707:
4708: =item * &plainlanguagedescription
4709:
4710: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4711: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4712:
4713: =cut
4714:
1.145 www 4715: sub plainlanguagedescription {
4716: my $code=shift;
4717: return $language{$code};
4718: }
4719:
1.1048 foxr 4720: =pod
4721:
4722: =item * &supportedlanguagecode
4723:
4724: Returns the supported language code (e.g. sptutf maps to pt) given a language
4725: code.
4726:
4727: =cut
4728:
1.145 www 4729: sub supportedlanguagecode {
4730: my $code=shift;
4731: return $supported_language{$code};
1.97 www 4732: }
4733:
1.112 bowersj2 4734: =pod
4735:
1.1048 foxr 4736: =item * &latexlanguage()
4737:
4738: Given a language key code returns the correspondnig language to use
4739: to select the correct hyphenation on LaTeX printouts. This is undef if there
4740: is no supported hyphenation for the language code.
4741:
4742: =cut
4743:
4744: sub latexlanguage {
4745: my $code = shift;
4746: return $latex_language{$code};
4747: }
4748:
4749: =pod
4750:
4751: =item * &latexhyphenation()
4752:
4753: Same as above but what's supplied is the language as it might be stored
4754: in the metadata.
4755:
4756: =cut
4757:
4758: sub latexhyphenation {
4759: my $key = shift;
4760: return $latex_language_bykey{$key};
4761: }
4762:
4763: =pod
4764:
1.648 raeburn 4765: =item * ©rightids()
1.112 bowersj2 4766:
4767: returns list of all copyrights
4768:
4769: =cut
4770:
4771: sub copyrightids {
4772: return sort(keys(%cprtag));
4773: }
4774:
4775: =pod
4776:
1.648 raeburn 4777: =item * ©rightdescription()
1.112 bowersj2 4778:
4779: returns description of a specified copyright id
4780:
4781: =cut
4782:
4783: sub copyrightdescription {
1.166 www 4784: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4785: }
1.197 matthew 4786:
4787: =pod
4788:
1.648 raeburn 4789: =item * &source_copyrightids()
1.192 taceyjo1 4790:
4791: returns list of all source copyrights
4792:
4793: =cut
4794:
4795: sub source_copyrightids {
4796: return sort(keys(%scprtag));
4797: }
4798:
4799: =pod
4800:
1.648 raeburn 4801: =item * &source_copyrightdescription()
1.192 taceyjo1 4802:
4803: returns description of a specified source copyright id
4804:
4805: =cut
4806:
4807: sub source_copyrightdescription {
4808: return &mt($scprtag{shift(@_)});
4809: }
1.112 bowersj2 4810:
4811: =pod
4812:
1.648 raeburn 4813: =item * &filecategories()
1.112 bowersj2 4814:
4815: returns list of all file categories
4816:
4817: =cut
4818:
4819: sub filecategories {
4820: return sort(keys(%category_extensions));
4821: }
4822:
4823: =pod
4824:
1.648 raeburn 4825: =item * &filecategorytypes()
1.112 bowersj2 4826:
4827: returns list of file types belonging to a given file
4828: category
4829:
4830: =cut
4831:
4832: sub filecategorytypes {
1.356 albertel 4833: my ($cat) = @_;
1.1248 raeburn 4834: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4835: return @{$category_extensions{lc($cat)}};
4836: } else {
4837: return ();
4838: }
1.112 bowersj2 4839: }
4840:
4841: =pod
4842:
1.648 raeburn 4843: =item * &fileembstyle()
1.112 bowersj2 4844:
4845: returns embedding style for a specified file type
4846:
4847: =cut
4848:
4849: sub fileembstyle {
4850: return $fe{lc(shift(@_))};
1.169 www 4851: }
4852:
1.351 www 4853: sub filemimetype {
4854: return $fm{lc(shift(@_))};
4855: }
4856:
1.169 www 4857:
4858: sub filecategoryselect {
4859: my ($name,$value)=@_;
1.189 matthew 4860: return &select_form($value,$name,
1.970 raeburn 4861: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4862: }
4863:
4864: =pod
4865:
1.648 raeburn 4866: =item * &filedescription()
1.112 bowersj2 4867:
4868: returns description for a specified file type
4869:
4870: =cut
4871:
4872: sub filedescription {
1.188 matthew 4873: my $file_description = $fd{lc(shift())};
4874: $file_description =~ s:([\[\]]):~$1:g;
4875: return &mt($file_description);
1.112 bowersj2 4876: }
4877:
4878: =pod
4879:
1.648 raeburn 4880: =item * &filedescriptionex()
1.112 bowersj2 4881:
4882: returns description for a specified file type with
4883: extra formatting
4884:
4885: =cut
4886:
4887: sub filedescriptionex {
4888: my $ex=shift;
1.188 matthew 4889: my $file_description = $fd{lc($ex)};
4890: $file_description =~ s:([\[\]]):~$1:g;
4891: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4892: }
4893:
4894: # End of .tab access
4895: =pod
4896:
4897: =back
4898:
4899: =cut
4900:
4901: # ------------------------------------------------------------------ File Types
4902: sub fileextensions {
4903: return sort(keys(%fe));
4904: }
4905:
1.97 www 4906: # ----------------------------------------------------------- Display Languages
4907: # returns a hash with all desired display languages
4908: #
4909:
4910: sub display_languages {
4911: my %languages=();
1.695 raeburn 4912: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4913: $languages{$lang}=1;
1.97 www 4914: }
4915: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4916: if ($env{'form.displaylanguage'}) {
1.356 albertel 4917: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4918: $languages{$lang}=1;
1.97 www 4919: }
4920: }
4921: return %languages;
1.14 harris41 4922: }
4923:
1.582 albertel 4924: sub languages {
4925: my ($possible_langs) = @_;
1.695 raeburn 4926: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4927: if (!ref($possible_langs)) {
4928: if( wantarray ) {
4929: return @preferred_langs;
4930: } else {
4931: return $preferred_langs[0];
4932: }
4933: }
4934: my %possibilities = map { $_ => 1 } (@$possible_langs);
4935: my @preferred_possibilities;
4936: foreach my $preferred_lang (@preferred_langs) {
4937: if (exists($possibilities{$preferred_lang})) {
4938: push(@preferred_possibilities, $preferred_lang);
4939: }
4940: }
4941: if( wantarray ) {
4942: return @preferred_possibilities;
4943: }
4944: return $preferred_possibilities[0];
4945: }
4946:
1.742 raeburn 4947: sub user_lang {
4948: my ($touname,$toudom,$fromcid) = @_;
4949: my @userlangs;
4950: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4951: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4952: $env{'course.'.$fromcid.'.languages'}));
4953: } else {
4954: my %langhash = &getlangs($touname,$toudom);
4955: if ($langhash{'languages'} ne '') {
4956: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4957: } else {
4958: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4959: if ($domdefs{'lang_def'} ne '') {
4960: @userlangs = ($domdefs{'lang_def'});
4961: }
4962: }
4963: }
4964: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4965: my $user_lh = Apache::localize->get_handle(@languages);
4966: return $user_lh;
4967: }
4968:
4969:
1.112 bowersj2 4970: ###############################################################
4971: ## Student Answer Attempts ##
4972: ###############################################################
4973:
4974: =pod
4975:
4976: =head1 Alternate Problem Views
4977:
4978: =over 4
4979:
1.648 raeburn 4980: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4981: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4982:
4983: Return string with previous attempt on problem. Arguments:
4984:
4985: =over 4
4986:
4987: =item * $symb: Problem, including path
4988:
4989: =item * $username: username of the desired student
4990:
4991: =item * $domain: domain of the desired student
1.14 harris41 4992:
1.112 bowersj2 4993: =item * $course: Course ID
1.14 harris41 4994:
1.112 bowersj2 4995: =item * $getattempt: Leave blank for all attempts, otherwise put
4996: something
1.14 harris41 4997:
1.112 bowersj2 4998: =item * $regexp: if string matches this regexp, the string will be
4999: sent to $gradesub
1.14 harris41 5000:
1.112 bowersj2 5001: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 5002:
1.1199 raeburn 5003: =item * $usec: section of the desired student
5004:
5005: =item * $identifier: counter for student (multiple students one problem) or
5006: problem (one student; whole sequence).
5007:
1.112 bowersj2 5008: =back
1.14 harris41 5009:
1.112 bowersj2 5010: The output string is a table containing all desired attempts, if any.
1.16 harris41 5011:
1.112 bowersj2 5012: =cut
1.1 albertel 5013:
5014: sub get_previous_attempt {
1.1199 raeburn 5015: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 5016: my $prevattempts='';
1.43 ng 5017: no strict 'refs';
1.1 albertel 5018: if ($symb) {
1.3 albertel 5019: my (%returnhash)=
5020: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 5021: if ($returnhash{'version'}) {
5022: my %lasthash=();
5023: my $version;
5024: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 5025: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
5026: if ($key =~ /\.rawrndseed$/) {
5027: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
5028: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
5029: } else {
5030: $lasthash{$key}=$returnhash{$version.':'.$key};
5031: }
1.19 harris41 5032: }
1.1 albertel 5033: }
1.596 albertel 5034: $prevattempts=&start_data_table().&start_data_table_header_row();
5035: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 5036: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 5037: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 5038: foreach my $key (sort(keys(%lasthash))) {
5039: my ($ign,@parts) = split(/\./,$key);
1.41 ng 5040: if ($#parts > 0) {
1.31 albertel 5041: my $data=$parts[-1];
1.989 raeburn 5042: next if ($data eq 'foilorder');
1.31 albertel 5043: pop(@parts);
1.1010 www 5044: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 5045: if ($data eq 'type') {
5046: unless ($showsurv) {
5047: my $id = join(',',@parts);
5048: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 5049: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
5050: $lasthidden{$ign.'.'.$id} = 1;
5051: }
1.945 raeburn 5052: }
1.1199 raeburn 5053: if ($identifier ne '') {
5054: my $id = join(',',@parts);
5055: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
5056: $domain,$username,$usec,undef,$course) =~ /^no/) {
5057: $hidestatus{$ign.'.'.$id} = 1;
5058: }
5059: }
5060: } elsif ($data eq 'regrader') {
5061: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 5062: my $id = join(',',@parts);
5063: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 5064: }
1.1010 www 5065: }
1.31 albertel 5066: } else {
1.41 ng 5067: if ($#parts == 0) {
5068: $prevattempts.='<th>'.$parts[0].'</th>';
5069: } else {
5070: $prevattempts.='<th>'.$ign.'</th>';
5071: }
1.31 albertel 5072: }
1.16 harris41 5073: }
1.596 albertel 5074: $prevattempts.=&end_data_table_header_row();
1.40 ng 5075: if ($getattempt eq '') {
1.1199 raeburn 5076: my (%solved,%resets,%probstatus);
1.1200 raeburn 5077: if (($identifier ne '') && (keys(%regraded) > 0)) {
5078: for ($version=1;$version<=$returnhash{'version'};$version++) {
5079: foreach my $id (keys(%regraded)) {
5080: if (($returnhash{$version.':'.$id.'.regrader'}) &&
5081: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
5082: ($returnhash{$version.':'.$id.'.award'} eq '')) {
5083: push(@{$resets{$id}},$version);
1.1199 raeburn 5084: }
5085: }
5086: }
1.1200 raeburn 5087: }
5088: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 5089: my (@hidden,@unsolved);
1.945 raeburn 5090: if (%typeparts) {
5091: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 5092: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
5093: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 5094: push(@hidden,$id);
1.1199 raeburn 5095: } elsif ($identifier ne '') {
5096: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
5097: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
5098: ($hidestatus{$id})) {
1.1200 raeburn 5099: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 5100: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
5101: push(@{$solved{$id}},$version);
5102: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
5103: (ref($solved{$id}) eq 'ARRAY')) {
5104: my $skip;
5105: if (ref($resets{$id}) eq 'ARRAY') {
5106: foreach my $reset (@{$resets{$id}}) {
5107: if ($reset > $solved{$id}[-1]) {
5108: $skip=1;
5109: last;
5110: }
5111: }
5112: }
5113: unless ($skip) {
5114: my ($ign,$partslist) = split(/\./,$id,2);
5115: push(@unsolved,$partslist);
5116: }
5117: }
5118: }
1.945 raeburn 5119: }
5120: }
5121: }
5122: $prevattempts.=&start_data_table_row().
1.1199 raeburn 5123: '<td>'.&mt('Transaction [_1]',$version);
5124: if (@unsolved) {
5125: $prevattempts .= '<span class="LC_nobreak"><label>'.
5126: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
5127: &mt('Hide').'</label></span>';
5128: }
5129: $prevattempts .= '</td>';
1.945 raeburn 5130: if (@hidden) {
5131: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5132: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5133: my $hide;
5134: foreach my $id (@hidden) {
5135: if ($key =~ /^\Q$id\E/) {
5136: $hide = 1;
5137: last;
5138: }
5139: }
5140: if ($hide) {
5141: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5142: if (($data eq 'award') || ($data eq 'awarddetail')) {
5143: my $value = &format_previous_attempt_value($key,
5144: $returnhash{$version.':'.$key});
1.1173 kruse 5145: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5146: } else {
5147: $prevattempts.='<td> </td>';
5148: }
5149: } else {
5150: if ($key =~ /\./) {
1.1212 raeburn 5151: my $value = $returnhash{$version.':'.$key};
5152: if ($key =~ /\.rndseed$/) {
5153: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5154: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5155: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5156: }
5157: }
5158: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5159: ' </td>';
1.945 raeburn 5160: } else {
5161: $prevattempts.='<td> </td>';
5162: }
5163: }
5164: }
5165: } else {
5166: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5167: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 5168: my $value = $returnhash{$version.':'.$key};
5169: if ($key =~ /\.rndseed$/) {
5170: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5171: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5172: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5173: }
5174: }
5175: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5176: ' </td>';
1.945 raeburn 5177: }
5178: }
5179: $prevattempts.=&end_data_table_row();
1.40 ng 5180: }
1.1 albertel 5181: }
1.945 raeburn 5182: my @currhidden = keys(%lasthidden);
1.596 albertel 5183: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 5184: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5185: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5186: if (%typeparts) {
5187: my $hidden;
5188: foreach my $id (@currhidden) {
5189: if ($key =~ /^\Q$id\E/) {
5190: $hidden = 1;
5191: last;
5192: }
5193: }
5194: if ($hidden) {
5195: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5196: if (($data eq 'award') || ($data eq 'awarddetail')) {
5197: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5198: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5199: $value = &$gradesub($value);
5200: }
1.1173 kruse 5201: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5202: } else {
5203: $prevattempts.='<td> </td>';
5204: }
5205: } else {
5206: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5207: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5208: $value = &$gradesub($value);
5209: }
1.1173 kruse 5210: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5211: }
5212: } else {
5213: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5214: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5215: $value = &$gradesub($value);
5216: }
1.1173 kruse 5217: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5218: }
1.16 harris41 5219: }
1.596 albertel 5220: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5221: } else {
1.1305 raeburn 5222: my $msg;
5223: if ($symb =~ /ext\.tool$/) {
5224: $msg = &mt('No grade passed back.');
5225: } else {
5226: $msg = &mt('Nothing submitted - no attempts.');
5227: }
1.596 albertel 5228: $prevattempts=
5229: &start_data_table().&start_data_table_row().
1.1305 raeburn 5230: '<td>'.$msg.'</td>'.
1.596 albertel 5231: &end_data_table_row().&end_data_table();
1.1 albertel 5232: }
5233: } else {
1.596 albertel 5234: $prevattempts=
5235: &start_data_table().&start_data_table_row().
5236: '<td>'.&mt('No data.').'</td>'.
5237: &end_data_table_row().&end_data_table();
1.1 albertel 5238: }
1.10 albertel 5239: }
5240:
1.581 albertel 5241: sub format_previous_attempt_value {
5242: my ($key,$value) = @_;
1.1011 www 5243: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5244: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5245: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5246: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5247: } elsif ($key =~ /answerstring$/) {
5248: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5249: my @answer = %answers;
5250: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5251: my @anskeys = sort(keys(%answers));
5252: if (@anskeys == 1) {
5253: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5254: if ($answer =~ m{\0}) {
5255: $answer =~ s{\0}{,}g;
1.988 raeburn 5256: }
5257: my $tag_internal_answer_name = 'INTERNAL';
5258: if ($anskeys[0] eq $tag_internal_answer_name) {
5259: $value = $answer;
5260: } else {
5261: $value = $anskeys[0].'='.$answer;
5262: }
5263: } else {
5264: foreach my $ans (@anskeys) {
5265: my $answer = $answers{$ans};
1.1001 raeburn 5266: if ($answer =~ m{\0}) {
5267: $answer =~ s{\0}{,}g;
1.988 raeburn 5268: }
5269: $value .= $ans.'='.$answer.'<br />';;
5270: }
5271: }
1.581 albertel 5272: } else {
1.1173 kruse 5273: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5274: }
5275: return $value;
5276: }
5277:
5278:
1.107 albertel 5279: sub relative_to_absolute {
5280: my ($url,$output)=@_;
5281: my $parser=HTML::TokeParser->new(\$output);
5282: my $token;
5283: my $thisdir=$url;
5284: my @rlinks=();
5285: while ($token=$parser->get_token) {
5286: if ($token->[0] eq 'S') {
5287: if ($token->[1] eq 'a') {
5288: if ($token->[2]->{'href'}) {
5289: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5290: }
5291: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5292: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5293: } elsif ($token->[1] eq 'base') {
5294: $thisdir=$token->[2]->{'href'};
5295: }
5296: }
5297: }
5298: $thisdir=~s-/[^/]*$--;
1.356 albertel 5299: foreach my $link (@rlinks) {
1.726 raeburn 5300: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5301: ($link=~/^\//) ||
5302: ($link=~/^javascript:/i) ||
5303: ($link=~/^mailto:/i) ||
5304: ($link=~/^\#/)) {
5305: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5306: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5307: }
5308: }
5309: # -------------------------------------------------- Deal with Applet codebases
5310: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5311: return $output;
5312: }
5313:
1.112 bowersj2 5314: =pod
5315:
1.648 raeburn 5316: =item * &get_student_view()
1.112 bowersj2 5317:
5318: show a snapshot of what student was looking at
5319:
5320: =cut
5321:
1.10 albertel 5322: sub get_student_view {
1.186 albertel 5323: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5324: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5325: my (%form);
1.10 albertel 5326: my @elements=('symb','courseid','domain','username');
5327: foreach my $element (@elements) {
1.186 albertel 5328: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5329: }
1.186 albertel 5330: if (defined($moreenv)) {
5331: %form=(%form,%{$moreenv});
5332: }
1.236 albertel 5333: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5334: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5335: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5336: $feedurl =~ s{^/adm/wrapper}{};
5337: }
1.650 www 5338: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5339: $userview=~s/\<body[^\>]*\>//gi;
5340: $userview=~s/\<\/body\>//gi;
5341: $userview=~s/\<html\>//gi;
5342: $userview=~s/\<\/html\>//gi;
5343: $userview=~s/\<head\>//gi;
5344: $userview=~s/\<\/head\>//gi;
5345: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5346: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5347: if (wantarray) {
5348: return ($userview,$response);
5349: } else {
5350: return $userview;
5351: }
5352: }
5353:
5354: sub get_student_view_with_retries {
5355: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5356:
5357: my $ok = 0; # True if we got a good response.
5358: my $content;
5359: my $response;
5360:
5361: # Try to get the student_view done. within the retries count:
5362:
5363: do {
5364: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5365: $ok = $response->is_success;
5366: if (!$ok) {
5367: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5368: }
5369: $retries--;
5370: } while (!$ok && ($retries > 0));
5371:
5372: if (!$ok) {
5373: $content = ''; # On error return an empty content.
5374: }
1.651 www 5375: if (wantarray) {
5376: return ($content, $response);
5377: } else {
5378: return $content;
5379: }
1.11 albertel 5380: }
5381:
1.1349 raeburn 5382: sub css_links {
5383: my ($currsymb,$level) = @_;
5384: my ($links,@symbs,%cssrefs,%httpref);
5385: if ($level eq 'map') {
5386: my $navmap = Apache::lonnavmaps::navmap->new();
5387: if (ref($navmap)) {
5388: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5389: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5390: foreach my $res (@resources) {
5391: if (ref($res) && $res->symb()) {
5392: push(@symbs,$res->symb());
5393: }
5394: }
5395: }
5396: } else {
5397: @symbs = ($currsymb);
5398: }
5399: foreach my $symb (@symbs) {
5400: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5401: if ($css_href =~ /\S/) {
5402: unless ($css_href =~ m{https?://}) {
5403: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5404: my $proburl = &Apache::lonnet::clutter($url);
5405: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5406: unless ($css_href =~ m{^/}) {
5407: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5408: }
5409: if ($css_href =~ m{^/(res|uploaded)/}) {
5410: unless (($httpref{'httpref.'.$css_href}) ||
5411: (&Apache::lonnet::is_on_map($css_href))) {
5412: my $thisurl = $proburl;
5413: if ($env{'httpref.'.$proburl}) {
5414: $thisurl = $env{'httpref.'.$proburl};
5415: }
5416: $httpref{'httpref.'.$css_href} = $thisurl;
5417: }
5418: }
5419: }
5420: $cssrefs{$css_href} = 1;
5421: }
5422: }
5423: if (keys(%httpref)) {
5424: &Apache::lonnet::appenv(\%httpref);
5425: }
5426: if (keys(%cssrefs)) {
5427: foreach my $css_href (keys(%cssrefs)) {
5428: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5429: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5430: }
5431: }
5432: return $links;
5433: }
5434:
1.112 bowersj2 5435: =pod
5436:
1.648 raeburn 5437: =item * &get_student_answers()
1.112 bowersj2 5438:
5439: show a snapshot of how student was answering problem
5440:
5441: =cut
5442:
1.11 albertel 5443: sub get_student_answers {
1.100 sakharuk 5444: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5445: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5446: my (%moreenv);
1.11 albertel 5447: my @elements=('symb','courseid','domain','username');
5448: foreach my $element (@elements) {
1.186 albertel 5449: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5450: }
1.186 albertel 5451: $moreenv{'grade_target'}='answer';
5452: %moreenv=(%form,%moreenv);
1.497 raeburn 5453: $feedurl = &Apache::lonnet::clutter($feedurl);
5454: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5455: return $userview;
1.1 albertel 5456: }
1.116 albertel 5457:
5458: =pod
5459:
5460: =item * &submlink()
5461:
1.242 albertel 5462: Inputs: $text $uname $udom $symb $target
1.116 albertel 5463:
5464: Returns: A link to grades.pm such as to see the SUBM view of a student
5465:
5466: =cut
5467:
5468: ###############################################
5469: sub submlink {
1.242 albertel 5470: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5471: if (!($uname && $udom)) {
5472: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5473: &Apache::lonnet::whichuser($symb);
1.116 albertel 5474: if (!$symb) { $symb=$cursymb; }
5475: }
1.254 matthew 5476: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5477: $symb=&escape($symb);
1.960 bisitz 5478: if ($target) { $target=" target=\"$target\""; }
5479: return
5480: '<a href="/adm/grades?command=submission'.
5481: '&symb='.$symb.
5482: '&student='.$uname.
5483: '&userdom='.$udom.'"'.
5484: $target.'>'.$text.'</a>';
1.242 albertel 5485: }
5486: ##############################################
5487:
5488: =pod
5489:
5490: =item * &pgrdlink()
5491:
5492: Inputs: $text $uname $udom $symb $target
5493:
5494: Returns: A link to grades.pm such as to see the PGRD view of a student
5495:
5496: =cut
5497:
5498: ###############################################
5499: sub pgrdlink {
5500: my $link=&submlink(@_);
5501: $link=~s/(&command=submission)/$1&showgrading=yes/;
5502: return $link;
5503: }
5504: ##############################################
5505:
5506: =pod
5507:
5508: =item * &pprmlink()
5509:
5510: Inputs: $text $uname $udom $symb $target
5511:
5512: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5513: student and a specific resource
1.242 albertel 5514:
5515: =cut
5516:
5517: ###############################################
5518: sub pprmlink {
5519: my ($text,$uname,$udom,$symb,$target)=@_;
5520: if (!($uname && $udom)) {
5521: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5522: &Apache::lonnet::whichuser($symb);
1.242 albertel 5523: if (!$symb) { $symb=$cursymb; }
5524: }
1.254 matthew 5525: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5526: $symb=&escape($symb);
1.242 albertel 5527: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5528: return '<a href="/adm/parmset?command=set&'.
5529: 'symb='.$symb.'&uname='.$uname.
5530: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5531: }
5532: ##############################################
1.37 matthew 5533:
1.112 bowersj2 5534: =pod
5535:
5536: =back
5537:
5538: =cut
5539:
1.37 matthew 5540: ###############################################
1.51 www 5541:
5542:
5543: sub timehash {
1.687 raeburn 5544: my ($thistime) = @_;
5545: my $timezone = &Apache::lonlocal::gettimezone();
5546: my $dt = DateTime->from_epoch(epoch => $thistime)
5547: ->set_time_zone($timezone);
5548: my $wday = $dt->day_of_week();
5549: if ($wday == 7) { $wday = 0; }
5550: return ( 'second' => $dt->second(),
5551: 'minute' => $dt->minute(),
5552: 'hour' => $dt->hour(),
5553: 'day' => $dt->day_of_month(),
5554: 'month' => $dt->month(),
5555: 'year' => $dt->year(),
5556: 'weekday' => $wday,
5557: 'dayyear' => $dt->day_of_year(),
5558: 'dlsav' => $dt->is_dst() );
1.51 www 5559: }
5560:
1.370 www 5561: sub utc_string {
5562: my ($date)=@_;
1.371 www 5563: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5564: }
5565:
1.51 www 5566: sub maketime {
5567: my %th=@_;
1.687 raeburn 5568: my ($epoch_time,$timezone,$dt);
5569: $timezone = &Apache::lonlocal::gettimezone();
5570: eval {
5571: $dt = DateTime->new( year => $th{'year'},
5572: month => $th{'month'},
5573: day => $th{'day'},
5574: hour => $th{'hour'},
5575: minute => $th{'minute'},
5576: second => $th{'second'},
5577: time_zone => $timezone,
5578: );
5579: };
5580: if (!$@) {
5581: $epoch_time = $dt->epoch;
5582: if ($epoch_time) {
5583: return $epoch_time;
5584: }
5585: }
1.51 www 5586: return POSIX::mktime(
5587: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5588: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5589: }
5590:
5591: #########################################
1.51 www 5592:
5593: sub findallcourses {
1.482 raeburn 5594: my ($roles,$uname,$udom) = @_;
1.355 albertel 5595: my %roles;
5596: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5597: my %courses;
1.51 www 5598: my $now=time;
1.482 raeburn 5599: if (!defined($uname)) {
5600: $uname = $env{'user.name'};
5601: }
5602: if (!defined($udom)) {
5603: $udom = $env{'user.domain'};
5604: }
5605: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5606: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5607: if (!%roles) {
5608: %roles = (
5609: cc => 1,
1.907 raeburn 5610: co => 1,
1.482 raeburn 5611: in => 1,
5612: ep => 1,
5613: ta => 1,
5614: cr => 1,
5615: st => 1,
5616: );
5617: }
5618: foreach my $entry (keys(%roleshash)) {
5619: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5620: if ($trole =~ /^cr/) {
5621: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5622: } else {
5623: next if (!exists($roles{$trole}));
5624: }
5625: if ($tend) {
5626: next if ($tend < $now);
5627: }
5628: if ($tstart) {
5629: next if ($tstart > $now);
5630: }
1.1058 raeburn 5631: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5632: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5633: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5634: if ($secpart eq '') {
5635: ($cnum,$role) = split(/_/,$cnumpart);
5636: $sec = 'none';
1.1058 raeburn 5637: $value .= $cnum.'/';
1.482 raeburn 5638: } else {
5639: $cnum = $cnumpart;
5640: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5641: $value .= $cnum.'/'.$sec;
5642: }
5643: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5644: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5645: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5646: }
5647: } else {
5648: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5649: }
1.482 raeburn 5650: }
5651: } else {
5652: foreach my $key (keys(%env)) {
1.483 albertel 5653: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5654: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5655: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5656: next if ($role eq 'ca' || $role eq 'aa');
5657: next if (%roles && !exists($roles{$role}));
5658: my ($starttime,$endtime)=split(/\./,$env{$key});
5659: my $active=1;
5660: if ($starttime) {
5661: if ($now<$starttime) { $active=0; }
5662: }
5663: if ($endtime) {
5664: if ($now>$endtime) { $active=0; }
5665: }
5666: if ($active) {
1.1058 raeburn 5667: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5668: if ($sec eq '') {
5669: $sec = 'none';
1.1058 raeburn 5670: } else {
5671: $value .= $sec;
5672: }
5673: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5674: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5675: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5676: }
5677: } else {
5678: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5679: }
1.474 raeburn 5680: }
5681: }
1.51 www 5682: }
5683: }
1.474 raeburn 5684: return %courses;
1.51 www 5685: }
1.37 matthew 5686:
1.54 www 5687: ###############################################
1.474 raeburn 5688:
5689: sub blockcheck {
1.1372 raeburn 5690: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5691: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5692: my ($has_evb,$check_ipaccess);
5693: my $dom = $env{'user.domain'};
5694: if ($env{'request.course.id'}) {
5695: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5696: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5697: my $checkrole = "cm./$cdom/$cnum";
5698: my $sec = $env{'request.course.sec'};
5699: if ($sec ne '') {
5700: $checkrole .= "/$sec";
5701: }
5702: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5703: ($env{'request.role'} !~ /^st/)) {
5704: $has_evb = 1;
5705: }
5706: unless ($has_evb) {
5707: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
1.1444 raeburn 5708: ($activity eq 'index') || ($activity eq 'boards') || ($activity eq 'groups') ||
5709: ($activity eq 'chat')) {
1.1372 raeburn 5710: if ($udom eq $cdom) {
5711: $check_ipaccess = 1;
5712: }
5713: }
5714: }
1.1375 raeburn 5715: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5716: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5717: my $checkrole;
5718: if ($env{'request.role.domain'} eq '') {
5719: $checkrole = "cm./$env{'user.domain'}/";
5720: } else {
5721: $checkrole = "cm./$env{'request.role.domain'}/";
5722: }
5723: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5724: $has_evb = 1;
5725: }
1.1372 raeburn 5726: }
5727: unless ($has_evb || $check_ipaccess) {
5728: my @machinedoms = &Apache::lonnet::current_machine_domains();
5729: if (($dom eq 'public') && ($activity eq 'port')) {
5730: $dom = $udom;
5731: }
5732: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5733: $check_ipaccess = 1;
5734: } else {
5735: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5736: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5737: my $prim = &Apache::lonnet::domain($dom,'primary');
5738: my $intdom = &Apache::lonnet::internet_dom($prim);
5739: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5740: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5741: $check_ipaccess = 1;
5742: }
5743: }
5744: }
5745: }
5746: if ($check_ipaccess) {
5747: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5748: unless (defined($cached)) {
5749: my %domconfig =
5750: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5751: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5752: }
5753: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5754: foreach my $id (keys(%{$ipaccessref})) {
5755: if (ref($ipaccessref->{$id}) eq 'HASH') {
5756: my $range = $ipaccessref->{$id}->{'ip'};
5757: if ($range) {
5758: if (&Apache::lonnet::ip_match($clientip,$range)) {
5759: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5760: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5761: return ('','','',$id,$dom);
5762: last;
5763: }
5764: }
5765: }
5766: }
5767: }
5768: }
5769: }
5770: }
1.1373 raeburn 5771: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5772: return ();
5773: }
1.1372 raeburn 5774: }
1.1189 raeburn 5775: if (defined($udom) && defined($uname)) {
5776: # If uname and udom are for a course, check for blocks in the course.
5777: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5778: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5779: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5780: return ($startblock,$endblock,$triggerblock);
5781: }
5782: } else {
1.490 raeburn 5783: $udom = $env{'user.domain'};
5784: $uname = $env{'user.name'};
5785: }
5786:
1.502 raeburn 5787: my $startblock = 0;
5788: my $endblock = 0;
1.1062 raeburn 5789: my $triggerblock = '';
1.1373 raeburn 5790: my %live_courses;
5791: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5792: %live_courses = &findallcourses(undef,$uname,$udom);
5793: }
1.474 raeburn 5794:
1.490 raeburn 5795: # If uname is for a user, and activity is course-specific, i.e.,
5796: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5797:
1.490 raeburn 5798: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5799: $activity eq 'groups' || $activity eq 'printout' ||
1.1444 raeburn 5800: $activity eq 'search' || $activity eq 'index' ||
5801: $activity eq 'reinit' || $activity eq 'alert') &&
1.1189 raeburn 5802: ($env{'request.course.id'})) {
1.490 raeburn 5803: foreach my $key (keys(%live_courses)) {
5804: if ($key ne $env{'request.course.id'}) {
5805: delete($live_courses{$key});
5806: }
5807: }
5808: }
5809:
5810: my $otheruser = 0;
5811: my %own_courses;
5812: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5813: # Resource belongs to user other than current user.
5814: $otheruser = 1;
5815: # Gather courses for current user
5816: %own_courses =
5817: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5818: }
5819:
5820: # Gather active course roles - course coordinator, instructor,
5821: # exam proctor, ta, student, or custom role.
1.474 raeburn 5822:
5823: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5824: my ($cdom,$cnum);
5825: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5826: $cdom = $env{'course.'.$course.'.domain'};
5827: $cnum = $env{'course.'.$course.'.num'};
5828: } else {
1.490 raeburn 5829: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5830: }
5831: my $no_ownblock = 0;
5832: my $no_userblock = 0;
1.533 raeburn 5833: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5834: # Check if current user has 'evb' priv for this
5835: if (defined($own_courses{$course})) {
5836: foreach my $sec (keys(%{$own_courses{$course}})) {
5837: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5838: if ($sec ne 'none') {
5839: $checkrole .= '/'.$sec;
5840: }
5841: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5842: $no_ownblock = 1;
5843: last;
5844: }
5845: }
5846: }
5847: # if they have 'evb' priv and are currently not playing student
5848: next if (($no_ownblock) &&
5849: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5850: }
1.474 raeburn 5851: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5852: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5853: if ($sec ne 'none') {
1.482 raeburn 5854: $checkrole .= '/'.$sec;
1.474 raeburn 5855: }
1.490 raeburn 5856: if ($otheruser) {
5857: # Resource belongs to user other than current user.
5858: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5859: my (%allroles,%userroles);
5860: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5861: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5862: my ($trole,$tdom,$tnum,$tsec);
5863: if ($entry =~ /^cr/) {
5864: ($trole,$tdom,$tnum,$tsec) =
5865: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5866: } else {
5867: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5868: }
5869: my ($spec,$area,$trest);
5870: $area = '/'.$tdom.'/'.$tnum;
5871: $trest = $tnum;
5872: if ($tsec ne '') {
5873: $area .= '/'.$tsec;
5874: $trest .= '/'.$tsec;
5875: }
5876: $spec = $trole.'.'.$area;
5877: if ($trole =~ /^cr/) {
5878: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5879: $tdom,$spec,$trest,$area);
5880: } else {
5881: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5882: $tdom,$spec,$trest,$area);
5883: }
5884: }
1.1276 raeburn 5885: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5886: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5887: if ($1) {
5888: $no_userblock = 1;
5889: last;
5890: }
1.486 raeburn 5891: }
5892: }
1.490 raeburn 5893: } else {
5894: # Resource belongs to current user
5895: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5896: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5897: $no_ownblock = 1;
5898: last;
5899: }
1.474 raeburn 5900: }
5901: }
5902: # if they have the evb priv and are currently not playing student
1.482 raeburn 5903: next if (($no_ownblock) &&
1.491 albertel 5904: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5905: next if ($no_userblock);
1.474 raeburn 5906:
1.1303 raeburn 5907: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5908: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5909:
1.1062 raeburn 5910: my ($start,$end,$trigger) =
1.1347 raeburn 5911: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5912: if (($start != 0) &&
5913: (($startblock == 0) || ($startblock > $start))) {
5914: $startblock = $start;
1.1062 raeburn 5915: if ($trigger ne '') {
5916: $triggerblock = $trigger;
5917: }
1.502 raeburn 5918: }
5919: if (($end != 0) &&
5920: (($endblock == 0) || ($endblock < $end))) {
5921: $endblock = $end;
1.1062 raeburn 5922: if ($trigger ne '') {
5923: $triggerblock = $trigger;
5924: }
1.502 raeburn 5925: }
1.490 raeburn 5926: }
1.1062 raeburn 5927: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5928: }
5929:
5930: sub get_blocks {
1.1347 raeburn 5931: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5932: my $startblock = 0;
5933: my $endblock = 0;
1.1062 raeburn 5934: my $triggerblock = '';
1.490 raeburn 5935: my $course = $cdom.'_'.$cnum;
5936: $setters->{$course} = {};
5937: $setters->{$course}{'staff'} = [];
5938: $setters->{$course}{'times'} = [];
1.1062 raeburn 5939: $setters->{$course}{'triggers'} = [];
5940: my (@blockers,%triggered);
5941: my $now = time;
5942: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5943: if ($activity eq 'docs') {
1.1348 raeburn 5944: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5945: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5946: $blocked = 1;
5947: $nosymbcache = 1;
1.1348 raeburn 5948: $noenccheck = 1;
1.1347 raeburn 5949: }
1.1348 raeburn 5950: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5951: foreach my $block (@blockers) {
5952: if ($block =~ /^firstaccess____(.+)$/) {
5953: my $item = $1;
5954: my $type = 'map';
5955: my $timersymb = $item;
5956: if ($item eq 'course') {
5957: $type = 'course';
5958: } elsif ($item =~ /___\d+___/) {
5959: $type = 'resource';
5960: } else {
5961: $timersymb = &Apache::lonnet::symbread($item);
5962: }
5963: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5964: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5965: $triggered{$block} = {
5966: start => $start,
5967: end => $end,
5968: type => $type,
5969: };
5970: }
5971: }
5972: } else {
5973: foreach my $block (keys(%commblocks)) {
5974: if ($block =~ m/^(\d+)____(\d+)$/) {
5975: my ($start,$end) = ($1,$2);
5976: if ($start <= time && $end >= time) {
5977: if (ref($commblocks{$block}) eq 'HASH') {
5978: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5979: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5980: unless(grep(/^\Q$block\E$/,@blockers)) {
5981: push(@blockers,$block);
5982: }
5983: }
5984: }
5985: }
5986: }
5987: } elsif ($block =~ /^firstaccess____(.+)$/) {
5988: my $item = $1;
5989: my $timersymb = $item;
5990: my $type = 'map';
5991: if ($item eq 'course') {
5992: $type = 'course';
5993: } elsif ($item =~ /___\d+___/) {
5994: $type = 'resource';
5995: } else {
5996: $timersymb = &Apache::lonnet::symbread($item);
5997: }
5998: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5999: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
6000: if ($start && $end) {
6001: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 6002: if (ref($commblocks{$block}) eq 'HASH') {
6003: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
6004: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
6005: unless(grep(/^\Q$block\E$/,@blockers)) {
6006: push(@blockers,$block);
6007: $triggered{$block} = {
6008: start => $start,
6009: end => $end,
6010: type => $type,
6011: };
6012: }
6013: }
6014: }
1.1062 raeburn 6015: }
6016: }
1.490 raeburn 6017: }
1.1062 raeburn 6018: }
6019: }
6020: }
6021: foreach my $blocker (@blockers) {
6022: my ($staff_name,$staff_dom,$title,$blocks) =
6023: &parse_block_record($commblocks{$blocker});
6024: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
6025: my ($start,$end,$triggertype);
6026: if ($blocker =~ m/^(\d+)____(\d+)$/) {
6027: ($start,$end) = ($1,$2);
6028: } elsif (ref($triggered{$blocker}) eq 'HASH') {
6029: $start = $triggered{$blocker}{'start'};
6030: $end = $triggered{$blocker}{'end'};
6031: $triggertype = $triggered{$blocker}{'type'};
6032: }
6033: if ($start) {
6034: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6035: if ($triggertype) {
6036: push(@{$$setters{$course}{'triggers'}},$triggertype);
6037: } else {
6038: push(@{$$setters{$course}{'triggers'}},0);
6039: }
6040: if ( ($startblock == 0) || ($startblock > $start) ) {
6041: $startblock = $start;
6042: if ($triggertype) {
6043: $triggerblock = $blocker;
1.474 raeburn 6044: }
6045: }
1.1062 raeburn 6046: if ( ($endblock == 0) || ($endblock < $end) ) {
6047: $endblock = $end;
6048: if ($triggertype) {
6049: $triggerblock = $blocker;
6050: }
6051: }
1.474 raeburn 6052: }
6053: }
1.1062 raeburn 6054: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6055: }
6056:
6057: sub parse_block_record {
6058: my ($record) = @_;
6059: my ($setuname,$setudom,$title,$blocks);
6060: if (ref($record) eq 'HASH') {
6061: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6062: $title = &unescape($record->{'event'});
6063: $blocks = $record->{'blocks'};
6064: } else {
6065: my @data = split(/:/,$record,3);
6066: if (scalar(@data) eq 2) {
6067: $title = $data[1];
6068: ($setuname,$setudom) = split(/@/,$data[0]);
6069: } else {
6070: ($setuname,$setudom,$title) = @data;
6071: }
6072: $blocks = { 'com' => 'on' };
6073: }
6074: return ($setuname,$setudom,$title,$blocks);
6075: }
6076:
1.854 kalberla 6077: sub blocking_status {
1.1372 raeburn 6078: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6079: my %setters;
1.890 droeschl 6080:
1.1061 raeburn 6081: # check for active blocking
1.1372 raeburn 6082: if ($clientip eq '') {
6083: $clientip = &Apache::lonnet::get_requestor_ip();
6084: }
6085: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6086: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6087: my $blocked = 0;
1.1372 raeburn 6088: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6089: $blocked = 1;
6090: }
1.890 droeschl 6091:
1.1061 raeburn 6092: # caller just wants to know whether a block is active
6093: if (!wantarray) { return $blocked; }
6094:
6095: # build a link to a popup window containing the details
6096: my $querystring = "?activity=$activity";
1.1351 raeburn 6097: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6098: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6099: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6100: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6101: } elsif ($activity eq 'docs') {
1.1347 raeburn 6102: my $showurl = &Apache::lonenc::check_encrypt($url);
6103: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6104: if ($symb) {
6105: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6106: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6107: }
1.1062 raeburn 6108: }
1.1061 raeburn 6109:
6110: my $output .= <<'END_MYBLOCK';
6111: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6112: var options = "width=" + w + ",height=" + h + ",";
6113: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6114: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6115: var newWin = window.open(url, wdwName, options);
6116: newWin.focus();
6117: }
1.890 droeschl 6118: END_MYBLOCK
1.854 kalberla 6119:
1.1061 raeburn 6120: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6121:
1.1061 raeburn 6122: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6123: my $text = &mt('Communication Blocked');
1.1217 raeburn 6124: my $class = 'LC_comblock';
1.1062 raeburn 6125: if ($activity eq 'docs') {
6126: $text = &mt('Content Access Blocked');
1.1217 raeburn 6127: $class = '';
1.1063 raeburn 6128: } elsif ($activity eq 'printout') {
6129: $text = &mt('Printing Blocked');
1.1232 raeburn 6130: } elsif ($activity eq 'passwd') {
6131: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6132: } elsif ($activity eq 'grades') {
6133: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6134: } elsif ($activity eq 'search') {
6135: $text = &mt('Search Blocked');
1.1444 raeburn 6136: } elsif ($activity eq 'index') {
6137: $text = &mt('Content Index Blocked');
1.1282 raeburn 6138: } elsif ($activity eq 'alert') {
6139: $text = &mt('Checking Critical Messages Blocked');
6140: } elsif ($activity eq 'reinit') {
6141: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6142: } elsif ($activity eq 'about') {
6143: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6144: } elsif ($activity eq 'wishlist') {
6145: $text = &mt('Access to Stored Links Blocked');
6146: } elsif ($activity eq 'annotate') {
6147: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6148: }
1.1061 raeburn 6149: $output .= <<"END_BLOCK";
1.1217 raeburn 6150: <div class='$class'>
1.869 kalberla 6151: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6152: title='$text'>
6153: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6154: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6155: title='$text'>$text</a>
1.867 kalberla 6156: </div>
6157:
6158: END_BLOCK
1.474 raeburn 6159:
1.1061 raeburn 6160: return ($blocked, $output);
1.854 kalberla 6161: }
1.490 raeburn 6162:
1.60 matthew 6163: ###############################################
6164:
1.682 raeburn 6165: sub check_ip_acc {
1.1201 raeburn 6166: my ($acc,$clientip)=@_;
1.682 raeburn 6167: &Apache::lonxml::debug("acc is $acc");
6168: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6169: return 1;
6170: }
1.1339 raeburn 6171: my ($ip,$allowed);
6172: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6173: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6174: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6175: } else {
1.1350 raeburn 6176: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6177: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6178: }
1.682 raeburn 6179:
6180: my $name;
1.1219 raeburn 6181: my %access = (
6182: allowfrom => 1,
6183: denyfrom => 0,
6184: );
6185: my @allows;
6186: my @denies;
6187: foreach my $item (split(',',$acc)) {
6188: $item =~ s/^\s*//;
6189: $item =~ s/\s*$//;
6190: my $pattern;
6191: if ($item =~ /^\!(.+)$/) {
6192: push(@denies,$1);
6193: } else {
6194: push(@allows,$item);
6195: }
6196: }
6197: my $numdenies = scalar(@denies);
6198: my $numallows = scalar(@allows);
6199: my $count = 0;
6200: foreach my $pattern (@denies,@allows) {
6201: $count ++;
6202: my $acctype = 'allowfrom';
6203: if ($count <= $numdenies) {
6204: $acctype = 'denyfrom';
6205: }
1.682 raeburn 6206: if ($pattern =~ /\*$/) {
6207: #35.8.*
6208: $pattern=~s/\*//;
1.1219 raeburn 6209: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6210: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6211: #35.8.3.[34-56]
6212: my $low=$2;
6213: my $high=$3;
6214: $pattern=$1;
6215: if ($ip =~ /^\Q$pattern\E/) {
6216: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6217: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6218: }
6219: } elsif ($pattern =~ /^\*/) {
6220: #*.msu.edu
6221: $pattern=~s/\*//;
6222: if (!defined($name)) {
6223: use Socket;
6224: my $netaddr=inet_aton($ip);
6225: ($name)=gethostbyaddr($netaddr,AF_INET);
6226: }
1.1219 raeburn 6227: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6228: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6229: #127.0.0.1
1.1219 raeburn 6230: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6231: } else {
6232: #some.name.com
6233: if (!defined($name)) {
6234: use Socket;
6235: my $netaddr=inet_aton($ip);
6236: ($name)=gethostbyaddr($netaddr,AF_INET);
6237: }
1.1219 raeburn 6238: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6239: }
6240: if ($allowed =~ /^(0|1)$/) { last; }
6241: }
6242: if ($allowed eq '') {
6243: if ($numdenies && !$numallows) {
6244: $allowed = 1;
6245: } else {
6246: $allowed = 0;
1.682 raeburn 6247: }
6248: }
6249: return $allowed;
6250: }
6251:
6252: ###############################################
6253:
1.60 matthew 6254: =pod
6255:
1.112 bowersj2 6256: =head1 Domain Template Functions
6257:
6258: =over 4
6259:
6260: =item * &determinedomain()
1.60 matthew 6261:
6262: Inputs: $domain (usually will be undef)
6263:
1.63 www 6264: Returns: Determines which domain should be used for designs
1.60 matthew 6265:
6266: =cut
1.54 www 6267:
1.60 matthew 6268: ###############################################
1.63 www 6269: sub determinedomain {
6270: my $domain=shift;
1.531 albertel 6271: if (! $domain) {
1.60 matthew 6272: # Determine domain if we have not been given one
1.893 raeburn 6273: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6274: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6275: if ($env{'request.role.domain'}) {
6276: $domain=$env{'request.role.domain'};
1.60 matthew 6277: }
6278: }
1.63 www 6279: return $domain;
6280: }
6281: ###############################################
1.517 raeburn 6282:
1.518 albertel 6283: sub devalidate_domconfig_cache {
6284: my ($udom)=@_;
6285: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6286: }
6287:
6288: # ---------------------- Get domain configuration for a domain
6289: sub get_domainconf {
6290: my ($udom) = @_;
6291: my $cachetime=1800;
6292: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6293: if (defined($cached)) { return %{$result}; }
6294:
6295: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6296: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6297: my (%designhash,%legacy);
1.518 albertel 6298: if (keys(%domconfig) > 0) {
6299: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6300: if (keys(%{$domconfig{'login'}})) {
6301: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6302: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6303: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6304: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6305: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6306: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6307: if ($key eq 'loginvia') {
6308: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6309: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6310: $designhash{$udom.'.login.loginvia'} = $server;
6311: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6312:
6313: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6314: } else {
6315: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6316: }
1.948 raeburn 6317: }
1.1208 raeburn 6318: } elsif ($key eq 'headtag') {
6319: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6320: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6321: }
1.946 raeburn 6322: }
1.1208 raeburn 6323: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6324: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6325: }
1.946 raeburn 6326: }
6327: }
6328: }
1.1366 raeburn 6329: } elsif ($key eq 'saml') {
6330: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6331: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6332: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6333: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6334: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6335: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6336: }
6337: }
6338: }
6339: }
1.946 raeburn 6340: } else {
6341: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6342: $designhash{$udom.'.login.'.$key.'_'.$img} =
6343: $domconfig{'login'}{$key}{$img};
6344: }
1.699 raeburn 6345: }
6346: } else {
6347: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6348: }
1.632 raeburn 6349: }
6350: } else {
6351: $legacy{'login'} = 1;
1.518 albertel 6352: }
1.632 raeburn 6353: } else {
6354: $legacy{'login'} = 1;
1.518 albertel 6355: }
6356: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6357: if (keys(%{$domconfig{'rolecolors'}})) {
6358: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6359: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6360: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6361: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6362: }
1.518 albertel 6363: }
6364: }
1.632 raeburn 6365: } else {
6366: $legacy{'rolecolors'} = 1;
1.518 albertel 6367: }
1.632 raeburn 6368: } else {
6369: $legacy{'rolecolors'} = 1;
1.518 albertel 6370: }
1.948 raeburn 6371: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6372: if ($domconfig{'autoenroll'}{'co-owners'}) {
6373: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6374: }
6375: }
1.632 raeburn 6376: if (keys(%legacy) > 0) {
6377: my %legacyhash = &get_legacy_domconf($udom);
6378: foreach my $item (keys(%legacyhash)) {
6379: if ($item =~ /^\Q$udom\E\.login/) {
6380: if ($legacy{'login'}) {
6381: $designhash{$item} = $legacyhash{$item};
6382: }
6383: } else {
6384: if ($legacy{'rolecolors'}) {
6385: $designhash{$item} = $legacyhash{$item};
6386: }
1.518 albertel 6387: }
6388: }
6389: }
1.632 raeburn 6390: } else {
6391: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6392: }
6393: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6394: $cachetime);
6395: return %designhash;
6396: }
6397:
1.632 raeburn 6398: sub get_legacy_domconf {
6399: my ($udom) = @_;
6400: my %legacyhash;
6401: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6402: my $designfile = $designdir.'/'.$udom.'.tab';
6403: if (-e $designfile) {
1.1317 raeburn 6404: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6405: while (my $line = <$fh>) {
6406: next if ($line =~ /^\#/);
6407: chomp($line);
6408: my ($key,$val)=(split(/\=/,$line));
6409: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6410: }
6411: close($fh);
6412: }
6413: }
1.1026 raeburn 6414: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6415: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6416: }
6417: return %legacyhash;
6418: }
6419:
1.63 www 6420: =pod
6421:
1.112 bowersj2 6422: =item * &domainlogo()
1.63 www 6423:
6424: Inputs: $domain (usually will be undef)
6425:
6426: Returns: A link to a domain logo, if the domain logo exists.
6427: If the domain logo does not exist, a description of the domain.
6428:
6429: =cut
1.112 bowersj2 6430:
1.63 www 6431: ###############################################
6432: sub domainlogo {
1.517 raeburn 6433: my $domain = &determinedomain(shift);
1.518 albertel 6434: my %designhash = &get_domainconf($domain);
1.517 raeburn 6435: # See if there is a logo
6436: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6437: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6438: if ($imgsrc =~ m{^/(adm|res)/}) {
6439: if ($imgsrc =~ m{^/res/}) {
6440: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6441: &Apache::lonnet::repcopy($local_name);
6442: }
6443: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6444: }
6445: my $alttext = $domain;
6446: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6447: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6448: }
6449: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6450: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6451: return &Apache::lonnet::domain($domain,'description');
1.59 www 6452: } else {
1.60 matthew 6453: return '';
1.59 www 6454: }
6455: }
1.63 www 6456: ##############################################
6457:
6458: =pod
6459:
1.112 bowersj2 6460: =item * &designparm()
1.63 www 6461:
6462: Inputs: $which parameter; $domain (usually will be undef)
6463:
6464: Returns: value of designparamter $which
6465:
6466: =cut
1.112 bowersj2 6467:
1.397 albertel 6468:
1.400 albertel 6469: ##############################################
1.397 albertel 6470: sub designparm {
6471: my ($which,$domain)=@_;
6472: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6473: return $env{'environment.color.'.$which};
1.96 www 6474: }
1.63 www 6475: $domain=&determinedomain($domain);
1.1016 raeburn 6476: my %domdesign;
6477: unless ($domain eq 'public') {
6478: %domdesign = &get_domainconf($domain);
6479: }
1.520 raeburn 6480: my $output;
1.517 raeburn 6481: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6482: $output = $domdesign{$domain.'.'.$which};
1.63 www 6483: } else {
1.520 raeburn 6484: $output = $defaultdesign{$which};
6485: }
6486: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6487: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6488: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6489: if ($output =~ m{^/res/}) {
6490: my $local_name = &Apache::lonnet::filelocation('',$output);
6491: &Apache::lonnet::repcopy($local_name);
6492: }
1.520 raeburn 6493: $output = &lonhttpdurl($output);
6494: }
1.63 www 6495: }
1.520 raeburn 6496: return $output;
1.63 www 6497: }
1.59 www 6498:
1.822 bisitz 6499: ##############################################
6500: =pod
6501:
1.832 bisitz 6502: =item * &authorspace()
6503:
1.1028 raeburn 6504: Inputs: $url (usually will be undef).
1.832 bisitz 6505:
1.1132 raeburn 6506: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6507: directory being viewed (or for which action is being taken).
6508: If $url is provided, and begins /priv/<domain>/<uname>
6509: the path will be that portion of the $context argument.
6510: Otherwise the path will be for the author space of the current
6511: user when the current role is author, or for that of the
6512: co-author/assistant co-author space when the current role
6513: is co-author or assistant co-author.
1.832 bisitz 6514:
6515: =cut
6516:
6517: sub authorspace {
1.1028 raeburn 6518: my ($url) = @_;
6519: if ($url ne '') {
6520: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6521: return $1;
6522: }
6523: }
1.832 bisitz 6524: my $caname = '';
1.1024 www 6525: my $cadom = '';
1.1028 raeburn 6526: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6527: ($cadom,$caname) =
1.832 bisitz 6528: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6529: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6530: $caname = $env{'user.name'};
1.1024 www 6531: $cadom = $env{'user.domain'};
1.832 bisitz 6532: }
1.1028 raeburn 6533: if (($caname ne '') && ($cadom ne '')) {
6534: return "/priv/$cadom/$caname/";
6535: }
6536: return;
1.832 bisitz 6537: }
6538:
6539: ##############################################
6540: =pod
6541:
1.822 bisitz 6542: =item * &head_subbox()
6543:
6544: Inputs: $content (contains HTML code with page functions, etc.)
6545:
6546: Returns: HTML div with $content
6547: To be included in page header
6548:
6549: =cut
6550:
6551: sub head_subbox {
6552: my ($content)=@_;
6553: my $output =
1.993 raeburn 6554: '<div class="LC_head_subbox">'
1.822 bisitz 6555: .$content
6556: .'</div>'
6557: }
6558:
6559: ##############################################
6560: =pod
6561:
6562: =item * &CSTR_pageheader()
6563:
1.1026 raeburn 6564: Input: (optional) filename from which breadcrumb trail is built.
6565: In most cases no input as needed, as $env{'request.filename'}
6566: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6567: frameset flag
6568: If page header is being requested for use in a frameset, then
6569: the second (option) argument -- frameset will be true, and
6570: the target attribute set for links should be target="_parent".
1.1433 raeburn 6571: If $title is supplied as the third arg, that will be used to
1.1407 raeburn 6572: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6573:
6574: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6575: To be included on Authoring Space pages
1.822 bisitz 6576:
6577: =cut
6578:
6579: sub CSTR_pageheader {
1.1407 raeburn 6580: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6581: if ($trailfile eq '') {
6582: $trailfile = $env{'request.filename'};
6583: }
6584:
6585: # this is for resources; directories have customtitle, and crumbs
6586: # and select recent are created in lonpubdir.pm
6587:
6588: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6589: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6590: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6591: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6592: $formaction =~ s{/+}{/}g;
1.822 bisitz 6593:
6594: my $parentpath = '';
6595: my $lastitem = '';
6596: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6597: $parentpath = $1;
6598: $lastitem = $2;
6599: } else {
6600: $lastitem = $thisdisfn;
6601: }
1.921 bisitz 6602:
1.1406 raeburn 6603: my $crsauthor;
1.1246 raeburn 6604: if (($env{'request.course.id'}) &&
6605: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6606: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6607: $crsauthor = 1;
1.1406 raeburn 6608: if ($title eq '') {
6609: $title = &mt('Course Authoring Space');
6610: }
6611: } elsif ($title eq '') {
1.1246 raeburn 6612: $title = &mt('Authoring Space');
6613: }
6614:
1.1379 raeburn 6615: my ($target,$crumbtarget) = (' target="_top"','_top');
6616: if ($frameset) {
6617: $target = ' target="_parent"';
6618: $crumbtarget = '_parent';
6619: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6620: $target = '';
6621: $crumbtarget = '';
1.1379 raeburn 6622: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6623: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6624: $crumbtarget = $env{'request.deeplink.target'};
6625: }
1.1313 raeburn 6626:
1.921 bisitz 6627: my $output =
1.1407 raeburn 6628: '<div>'
1.822 bisitz 6629: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6630: .'<b>'.$title.'</b> '
1.1314 raeburn 6631: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6632: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6633:
6634: if ($lastitem) {
6635: $output .=
6636: '<span class="LC_filename">'
6637: .$lastitem
6638: .'</span>';
6639: }
1.1245 raeburn 6640:
1.1246 raeburn 6641: if ($crsauthor) {
1.1379 raeburn 6642: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6643: } else {
6644: $output .=
6645: '<br />'
1.1314 raeburn 6646: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6647: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6648: .'</form>'
1.1379 raeburn 6649: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6650: }
1.1407 raeburn 6651: $output .= '</div>';
1.921 bisitz 6652:
6653: return $output;
1.822 bisitz 6654: }
6655:
1.1419 raeburn 6656: ##############################################
6657: =pod
6658:
6659: =item * &nocodemirror()
6660:
6661: Input: None
6662:
6663: Returns: 1 if CodeMirror is deactivated based on
6664: user's preference, or domain default,
6665: if user indicated use of default.
6666:
6667: =cut
6668:
1.1416 raeburn 6669: sub nocodemirror {
6670: my $nocodem = $env{'environment.nocodemirror'};
6671: unless ($nocodem) {
6672: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6673: if ($domdefs{'nocodemirror'}) {
6674: $nocodem = 'yes';
6675: }
6676: }
1.1417 raeburn 6677: if ($nocodem eq 'yes') {
6678: return 1;
6679: }
6680: return;
1.1416 raeburn 6681: }
6682:
1.1419 raeburn 6683: ##############################################
6684: =pod
6685:
6686: =item * &permitted_editors()
6687:
1.1422 raeburn 6688: Input: $uri (optional)
1.1419 raeburn 6689:
6690: Returns: %editors hash in which keys are editors
1.1429 raeburn 6691: permitted in current Authoring Space,
6692: or in current course for web pages
6693: created in a course.
6694:
1.1419 raeburn 6695: Value for each key is 1. Possible keys
1.1429 raeburn 6696: are: edit, xml, and daxe.
6697:
6698: For a regular Authoring Space, if no specific
1.1419 raeburn 6699: set of editors has been set for the Author
6700: who owns the Authoring Space, then the
6701: domain default will be used. If no domain
6702: default has been set, then the keys will be
6703: edit and xml.
6704:
1.1429 raeburn 6705: For a course author, or for web pages created
6706: in a course, if no specific set of editors has
6707: been set for the course, then the domain
6708: course default will be used. If no domain
6709: course default has been set, then the keys
6710: will be edit and xml.
6711:
1.1419 raeburn 6712: =cut
6713:
1.1418 raeburn 6714: sub permitted_editors {
1.1422 raeburn 6715: my ($uri) = @_;
1.1429 raeburn 6716: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6717: if ($env{'request.role'} =~ m{^au\./}) {
6718: $is_author = 1;
6719: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6720: ($audom,$auname) = ($1,$2);
6721: if (($audom ne '') && ($auname ne '')) {
6722: if (($env{'user.domain'} eq $audom) &&
6723: ($env{'user.name'} eq $auname)) {
6724: $is_author = 1;
6725: } else {
6726: $is_coauthor = 1;
6727: }
6728: }
6729: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6730: my ($cdom,$cnum);
6731: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6732: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6733: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6734: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6735: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6736: $is_course = 1;
6737: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6738: ($audom,$auname) = ($1,$2);
6739: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6740: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6741: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6742: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6743: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6744: $is_course = 1;
6745: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6746: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6747: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6748: }
1.1429 raeburn 6749: unless ($is_course) {
6750: if (($audom ne '') && ($auname ne '')) {
6751: if (($env{'user.domain'} eq $audom) &&
6752: ($env{'user.name'} eq $auname)) {
6753: $is_author = 1;
6754: } else {
6755: $is_coauthor = 1;
6756: }
1.1418 raeburn 6757: }
6758: }
6759: }
6760: if ($is_author) {
6761: if (exists($env{'environment.editors'})) {
6762: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6763: } else {
6764: %editors = ( edit => 1,
6765: xml => 1,
6766: );
6767: }
6768: } elsif ($is_coauthor) {
6769: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6770: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6771: } else {
6772: %editors = ( edit => 1,
6773: xml => 1,
6774: );
6775: }
1.1429 raeburn 6776: } elsif ($is_course) {
6777: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6778: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6779: } else {
6780: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6781: if (exists($domdefaults{'crseditors'})) {
6782: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6783: } else {
6784: %editors = ( edit => 1,
6785: xml => 1,
6786: );
6787: }
6788: }
1.1418 raeburn 6789: } else {
6790: %editors = ( edit => 1,
6791: xml => 1,
6792: );
6793: }
6794: return %editors;
6795: }
6796:
1.60 matthew 6797: ###############################################
6798: ###############################################
6799:
6800: =pod
6801:
1.112 bowersj2 6802: =back
6803:
1.549 albertel 6804: =head1 HTML Helpers
1.112 bowersj2 6805:
6806: =over 4
6807:
6808: =item * &bodytag()
1.60 matthew 6809:
6810: Returns a uniform header for LON-CAPA web pages.
6811:
6812: Inputs:
6813:
1.112 bowersj2 6814: =over 4
6815:
6816: =item * $title, A title to be displayed on the page.
6817:
6818: =item * $function, the current role (can be undef).
6819:
6820: =item * $addentries, extra parameters for the <body> tag.
6821:
6822: =item * $bodyonly, if defined, only return the <body> tag.
6823:
6824: =item * $domain, if defined, force a given domain.
6825:
6826: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6827: text interface only)
1.60 matthew 6828:
1.814 bisitz 6829: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6830: navigational links
1.317 albertel 6831:
1.338 albertel 6832: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6833:
1.460 albertel 6834: =item * $args, optional argument valid values are
6835: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6836: use_absolute -> for external resource or syllabus, this will
6837: contain https://<hostname> if server uses
6838: https (as per hosts.tab), but request is for http
6839: hostname -> hostname, from $r->hostname().
1.460 albertel 6840:
1.1096 raeburn 6841: =item * $advtoolsref, optional argument, ref to an array containing
6842: inlineremote items to be added in "Functions" menu below
6843: breadcrumbs.
6844:
1.1316 raeburn 6845: =item * $ltiscope, optional argument, will be one of: resource, map or
6846: course, if LON-CAPA is in LTI Provider context. Value is
6847: the scope of use, i.e., launch was for access to a single, a map
6848: or the entire course.
6849:
6850: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6851: context, this will contain the URL for the landing item in
6852: the course, after launch from an LTI Consumer
6853:
1.1318 raeburn 6854: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6855: context, this will contain a reference to hash of items
6856: to be included in the page header and/or inline menu.
6857:
1.1385 raeburn 6858: =item * $menucoll, optional argument, if specific menu collection is in
6859: effect, either set as the default for the course, or set for
6860: the deeplink paramater for $env{'request.deeplink.login'}
6861: then $menucoll will be the number of that collection.
6862:
6863: =item * $menuref, optional argument, reference to a hash, containing the
6864: menu options included for the menu in effect, based on the
6865: configuration for the numbered menu collection in use.
6866:
6867: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6868: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6869: if so, $showncrumbsref is set there to 1, and will propagate back
6870: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6871: being called a second time.
6872:
1.112 bowersj2 6873: =back
6874:
1.60 matthew 6875: Returns: A uniform header for LON-CAPA web pages.
6876: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6877: If $bodyonly is undef or zero, an html string containing a <body> tag and
6878: other decorations will be returned.
6879:
6880: =cut
6881:
1.54 www 6882: sub bodytag {
1.831 bisitz 6883: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6884: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6885: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6886:
1.954 raeburn 6887: my $public;
6888: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6889: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6890: $public = 1;
6891: }
1.460 albertel 6892: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6893: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6894: my $hostname = $args->{'hostname'};
1.339 albertel 6895:
1.183 matthew 6896: $function = &get_users_function() if (!$function);
1.339 albertel 6897: my $font = &designparm($function.'.font',$domain);
6898: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6899:
1.803 bisitz 6900: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6901: 'bgcolor' => $pgbg,
1.339 albertel 6902: 'text' => $font,
6903: 'alink' => &designparm($function.'.alink',$domain),
6904: 'vlink' => &designparm($function.'.vlink',$domain),
6905: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6906: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6907:
1.63 www 6908: # role and realm
1.1178 raeburn 6909: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6910: if ($realm) {
6911: $realm = '/'.$realm;
6912: }
1.1357 raeburn 6913: if ($role eq 'ca') {
1.479 albertel 6914: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6915: $realm = &plainname($rname,$rdom);
1.378 raeburn 6916: }
1.55 www 6917: # realm
1.1357 raeburn 6918: my ($cid,$sec);
1.258 albertel 6919: if ($env{'request.course.id'}) {
1.1357 raeburn 6920: $cid = $env{'request.course.id'};
6921: if ($env{'request.course.sec'}) {
6922: $sec = $env{'request.course.sec'};
6923: }
6924: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6925: if (&Apache::lonnet::is_course($1,$2)) {
6926: $cid = $1.'_'.$2;
6927: $sec = $3;
6928: }
6929: }
6930: if ($cid) {
1.378 raeburn 6931: if ($env{'request.role'} !~ /^cr/) {
6932: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6933: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6934: if ($env{'request.role.desc'}) {
6935: $role = $env{'request.role.desc'};
6936: } else {
6937: $role = &mt('Helpdesk[_1]',' '.$2);
6938: }
1.1257 raeburn 6939: } else {
6940: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6941: }
1.1357 raeburn 6942: if ($sec) {
6943: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6944: }
1.1357 raeburn 6945: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6946: } else {
6947: $role = &Apache::lonnet::plaintext($role);
1.54 www 6948: }
1.433 albertel 6949:
1.359 albertel 6950: if (!$realm) { $realm=' '; }
1.330 albertel 6951:
1.438 albertel 6952: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6953:
1.101 www 6954: # construct main body tag
1.359 albertel 6955: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6956: &Apache::lontexconvert::init_math_support();
1.252 albertel 6957:
1.1131 raeburn 6958: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6959:
1.1130 raeburn 6960: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6961: return $bodytag;
1.1130 raeburn 6962: }
1.359 albertel 6963:
1.954 raeburn 6964: if ($public) {
1.433 albertel 6965: undef($role);
6966: }
1.1318 raeburn 6967:
1.1359 raeburn 6968: my $showcrstitle = 1;
1.1357 raeburn 6969: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6970: if (ref($ltimenu) eq 'HASH') {
6971: unless ($ltimenu->{'role'}) {
6972: undef($role);
6973: }
6974: unless ($ltimenu->{'coursetitle'}) {
6975: $realm=' ';
1.1359 raeburn 6976: $showcrstitle = 0;
6977: }
6978: }
6979: } elsif (($cid) && ($menucoll)) {
6980: if (ref($menuref) eq 'HASH') {
6981: unless ($menuref->{'role'}) {
6982: undef($role);
6983: }
6984: unless ($menuref->{'crs'}) {
6985: $realm=' ';
6986: $showcrstitle = 0;
1.1318 raeburn 6987: }
6988: }
6989: }
6990:
1.762 bisitz 6991: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6992: #
6993: # Extra info if you are the DC
6994: my $dc_info = '';
1.1359 raeburn 6995: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6996: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6997: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6998: $dc_info =~ s/\s+$//;
1.359 albertel 6999: }
7000:
1.1237 raeburn 7001: my $crstype;
1.1357 raeburn 7002: if ($cid) {
7003: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 7004: } elsif ($args->{'crstype'}) {
7005: $crstype = $args->{'crstype'};
7006: }
7007: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
7008: undef($role);
7009: } else {
1.1242 raeburn 7010: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 7011: }
1.853 droeschl 7012:
1.903 droeschl 7013: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
7014:
7015: # if ($env{'request.state'} eq 'construct') {
7016: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7017: # }
7018:
1.1440 raeburn 7019: my $need_endlcint;
7020: unless ($args->{'switchserver'}) {
7021: $bodytag .= Apache::lonhtmlcommon::scripttag(
7022: Apache::lonmenu::utilityfunctions($httphost), 'start');
7023: $need_endlcint = 1;
7024: }
1.359 albertel 7025:
1.1427 raeburn 7026: my $collapsible;
1.1423 raeburn 7027: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7028: $collapsible = 1;
7029: my ($menustate,$tiptext,$divclass);
7030: if ($args->{'start_collapsed'}) {
7031: $menustate = 'collapsed';
7032: $tiptext = 'display';
7033: $divclass = 'hidden';
7034: } else {
7035: $menustate = 'expanded';
7036: $tiptext = 'hide';
7037: $divclass = 'shown';
7038: }
7039: my $alttext = &mt('menu state: '.$menustate);
7040: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7041: $bodytag .= <<"END";
7042: <div id="LC_expandingContainer" style="display:inline;">
7043: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7044: <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>
7045: <div class="LC_menus_content $divclass">
1.1421 raeburn 7046: END
7047: }
1.1318 raeburn 7048: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7049: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7050: $args->{'links_disabled'},
1.1421 raeburn 7051: $args->{'links_target'},
1.1427 raeburn 7052: $collapsible);
1.359 albertel 7053:
1.1318 raeburn 7054: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7055: if ($dc_info) {
7056: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7057: }
7058: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7059: <em>$realm</em> $dc_info</div>|;
1.1440 raeburn 7060: if ($need_endlcint) {
7061: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7062: }
1.1318 raeburn 7063: return $bodytag;
7064: }
1.894 droeschl 7065:
1.1318 raeburn 7066: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7067: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7068: }
1.916 droeschl 7069:
1.1318 raeburn 7070: $bodytag .= $right;
1.852 droeschl 7071:
1.1318 raeburn 7072: if ($dc_info) {
7073: $dc_info = &dc_courseid_toggle($dc_info);
7074: }
7075: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7076: }
1.916 droeschl 7077:
1.1169 raeburn 7078: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7079: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7080: if ($need_endlcint) {
7081: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7082: }
1.1168 raeburn 7083: return $bodytag;
7084: }
1.1169 raeburn 7085: #don't show menus for public users
1.954 raeburn 7086: if (!$public){
1.1318 raeburn 7087: unless ($args->{'no_inline_menu'}) {
7088: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7089: $args->{'no_primary_menu'},
1.1369 raeburn 7090: $menucoll,$menuref,
1.1380 raeburn 7091: $args->{'links_disabled'},
7092: $args->{'links_target'});
1.1318 raeburn 7093: }
1.903 droeschl 7094: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7095: if ($need_endlcint) {
7096: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7097: }
1.920 raeburn 7098: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7099: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7100: $args->{'bread_crumbs'},'','',$hostname,
7101: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7102: } elsif ($forcereg) {
7103: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7104: $args->{'group'},$args->{'hide_buttons'},
7105: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7106: } else {
7107: $bodytag .=
7108: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7109: $forcereg,$args->{'group'},
7110: $args->{'bread_crumbs'},
1.1274 raeburn 7111: $advtoolsref,'',$hostname);
1.920 raeburn 7112: }
1.1440 raeburn 7113: } else {
7114: # this is to separate menu from content when there's no secondary
1.1441 raeburn 7115: # menu. Especially needed for publicly accessible resources.
1.903 droeschl 7116: $bodytag .= '<hr style="clear:both" />';
1.1440 raeburn 7117: if ($need_endlcint) {
7118: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7119: }
1.235 raeburn 7120: }
1.1423 raeburn 7121: if ($args->{'collapsible_header'} ne '') {
7122: $bodytag .= $args->{'collapsible_header'}.
7123: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7124: '</div></div>';
7125: }
1.235 raeburn 7126: return $bodytag;
1.182 matthew 7127: }
7128:
1.917 raeburn 7129: sub dc_courseid_toggle {
7130: my ($dc_info) = @_;
1.980 raeburn 7131: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7132: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7133: &mt('(More ...)').'</a></span>'.
7134: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7135: }
7136:
1.330 albertel 7137: sub make_attr_string {
7138: my ($register,$attr_ref) = @_;
7139:
7140: if ($attr_ref && !ref($attr_ref)) {
7141: die("addentries Must be a hash ref ".
7142: join(':',caller(1))." ".
7143: join(':',caller(0))." ");
7144: }
7145:
7146: if ($register) {
1.339 albertel 7147: my ($on_load,$on_unload);
7148: foreach my $key (keys(%{$attr_ref})) {
7149: if (lc($key) eq 'onload') {
7150: $on_load.=$attr_ref->{$key}.';';
7151: delete($attr_ref->{$key});
7152:
7153: } elsif (lc($key) eq 'onunload') {
7154: $on_unload.=$attr_ref->{$key}.';';
7155: delete($attr_ref->{$key});
7156: }
7157: }
1.953 droeschl 7158: $attr_ref->{'onload'} = $on_load;
7159: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7160: }
1.339 albertel 7161:
1.330 albertel 7162: my $attr_string;
1.1159 raeburn 7163: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7164: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7165: }
7166: return $attr_string;
7167: }
7168:
7169:
1.182 matthew 7170: ###############################################
1.251 albertel 7171: ###############################################
7172:
7173: =pod
7174:
7175: =item * &endbodytag()
7176:
7177: Returns a uniform footer for LON-CAPA web pages.
7178:
1.635 raeburn 7179: Inputs: 1 - optional reference to an args hash
7180: If in the hash, key for noredirectlink has a value which evaluates to true,
7181: a 'Continue' link is not displayed if the page contains an
7182: internal redirect in the <head></head> section,
7183: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7184:
7185: =cut
7186:
7187: sub endbodytag {
1.635 raeburn 7188: my ($args) = @_;
1.1080 raeburn 7189: my $endbodytag;
7190: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7191: $endbodytag='</body>';
7192: }
1.315 albertel 7193: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7194: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7195: my ($endbodyjs,$idattr);
7196: if ($env{'internal.head.to_opener'}) {
7197: my $linkid = 'LC_continue_link';
7198: $idattr = ' id="'.$linkid.'"';
7199: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7200: $endbodyjs=<<ENDJS;
7201: <script type="text/javascript">
7202: // <![CDATA[
7203: function ebFunction(evt) {
7204: evt.preventDefault();
7205: var dest = '$redirect_for_js';
7206: if (window.opener != null && !window.opener.closed) {
7207: window.opener.location.href=dest;
7208: window.close();
7209: } else {
7210: window.location.href=dest;
7211: }
7212: return false;
7213: }
7214:
7215: \$(document).ready(function () {
7216: if (document.getElementById('$linkid')) {
7217: var clickelem = document.getElementById('$linkid');
7218: clickelem.addEventListener('click',ebFunction,false);
7219: }
7220: });
7221: // ]]>
7222: </script>
7223: ENDJS
7224: }
1.635 raeburn 7225: $endbodytag=
1.1386 raeburn 7226: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7227: &mt('Continue').'</a>'.
7228: $endbodytag;
7229: }
1.315 albertel 7230: }
1.1411 raeburn 7231: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7232: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7233: }
1.251 albertel 7234: return $endbodytag;
7235: }
7236:
1.352 albertel 7237: =pod
7238:
7239: =item * &standard_css()
7240:
7241: Returns a style sheet
7242:
7243: Inputs: (all optional)
7244: domain -> force to color decorate a page for a specific
7245: domain
7246: function -> force usage of a specific rolish color scheme
7247: bgcolor -> override the default page bgcolor
7248:
7249: =cut
7250:
1.343 albertel 7251: sub standard_css {
1.345 albertel 7252: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7253: $function = &get_users_function() if (!$function);
7254: my $tabbg = &designparm($function.'.tabbg', $domain);
7255: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7256: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7257: #second colour for later usage
1.345 albertel 7258: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7259: my $pgbg_or_bgcolor =
7260: $bgcolor ||
1.352 albertel 7261: &designparm($function.'.pgbg', $domain);
1.382 albertel 7262: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7263: my $alink = &designparm($function.'.alink', $domain);
7264: my $vlink = &designparm($function.'.vlink', $domain);
7265: my $link = &designparm($function.'.link', $domain);
7266:
1.602 albertel 7267: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7268: my $mono = 'monospace';
1.850 bisitz 7269: my $data_table_head = $sidebg;
7270: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7271: my $data_table_dark = '#E0E0E0';
1.470 banghart 7272: my $data_table_darker = '#CCCCCC';
1.349 albertel 7273: my $data_table_highlight = '#FFFF00';
1.352 albertel 7274: my $mail_new = '#FFBB77';
7275: my $mail_new_hover = '#DD9955';
7276: my $mail_read = '#BBBB77';
7277: my $mail_read_hover = '#999944';
7278: my $mail_replied = '#AAAA88';
7279: my $mail_replied_hover = '#888855';
7280: my $mail_other = '#99BBBB';
7281: my $mail_other_hover = '#669999';
1.391 albertel 7282: my $table_header = '#DDDDDD';
1.489 raeburn 7283: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7284: my $lg_border_color = '#C8C8C8';
1.952 onken 7285: my $button_hover = '#BF2317';
1.392 albertel 7286:
1.608 albertel 7287: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7288: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7289: : '0 3px 0 4px';
1.448 albertel 7290:
1.523 albertel 7291:
1.343 albertel 7292: return <<END;
1.947 droeschl 7293:
7294: /* needed for iframe to allow 100% height in FF */
7295: body, html {
7296: margin: 0;
7297: padding: 0 0.5%;
7298: height: 99%; /* to avoid scrollbars */
7299: }
7300:
1.795 www 7301: body {
1.911 bisitz 7302: font-family: $sans;
7303: line-height:130%;
7304: font-size:0.83em;
7305: color:$font;
1.1436 raeburn 7306: background-color: $pgbg_or_bgcolor;
1.795 www 7307: }
7308:
1.959 onken 7309: a:focus,
7310: a:focus img {
1.795 www 7311: color: red;
7312: }
1.698 harmsja 7313:
1.911 bisitz 7314: form, .inline {
7315: display: inline;
1.795 www 7316: }
1.721 harmsja 7317:
1.1453 ! raeburn 7318: .LC_landmark {
! 7319: margin: 0;
! 7320: padding: 0;
! 7321: border: none;
! 7322: }
! 7323:
1.1443 raeburn 7324: .LC_visually_hidden:not(:focus):not(:active) {
7325: clip-path: inset(50%);
7326: height: 1px;
7327: overflow: hidden;
7328: position: absolute;
7329: white-space: nowrap;
7330: width: 1px;
7331: display: inline;
7332: }
7333:
1.1453 ! raeburn 7334: .LC_heading_2 {
! 7335: font-size: 1.17em;
! 7336: margin-top: 1em;
! 7337: margin-bottom: 1em;
! 7338: }
! 7339:
1.1421 raeburn 7340: .LC_menus_content.shown{
1.1428 raeburn 7341: display: block;
1.1421 raeburn 7342: }
7343:
7344: .LC_menus_content.hidden {
7345: display: none;
7346: }
7347:
1.795 www 7348: .LC_right {
1.911 bisitz 7349: text-align:right;
1.795 www 7350: }
7351:
1.1449 raeburn 7352: .LC_center {
7353: text-align:center;
7354: }
7355:
1.795 www 7356: .LC_middle {
1.911 bisitz 7357: vertical-align:middle;
1.795 www 7358: }
1.721 harmsja 7359:
1.1130 raeburn 7360: .LC_floatleft {
7361: float: left;
7362: }
7363:
7364: .LC_floatright {
7365: float: right;
7366: }
7367:
1.911 bisitz 7368: .LC_400Box {
7369: width:400px;
7370: }
1.721 harmsja 7371:
1.1421 raeburn 7372: #LC_collapsible_separator {
7373: border: 1px solid black;
7374: width: 99.9%;
7375: height: 0px;
7376: }
7377:
1.947 droeschl 7378: .LC_iframecontainer {
7379: width: 98%;
7380: margin: 0;
7381: position: fixed;
7382: top: 8.5em;
7383: bottom: 0;
7384: }
7385:
7386: .LC_iframecontainer iframe{
7387: border: none;
7388: width: 100%;
7389: height: 100%;
7390: }
7391:
1.778 bisitz 7392: .LC_filename {
7393: font-family: $mono;
7394: white-space:pre;
1.921 bisitz 7395: font-size: 120%;
1.778 bisitz 7396: }
7397:
7398: .LC_fileicon {
7399: border: none;
7400: height: 1.3em;
7401: vertical-align: text-bottom;
7402: margin-right: 0.3em;
7403: text-decoration:none;
7404: }
7405:
1.1008 www 7406: .LC_setting {
7407: text-decoration:underline;
7408: }
7409:
1.350 albertel 7410: .LC_error {
7411: color: red;
7412: }
1.795 www 7413:
1.1097 bisitz 7414: .LC_warning {
7415: color: darkorange;
7416: }
7417:
1.457 albertel 7418: .LC_diff_removed {
1.733 bisitz 7419: color: red;
1.394 albertel 7420: }
1.532 albertel 7421:
7422: .LC_info,
1.457 albertel 7423: .LC_success,
7424: .LC_diff_added {
1.350 albertel 7425: color: green;
7426: }
1.795 www 7427:
1.802 bisitz 7428: div.LC_confirm_box {
7429: background-color: #FAFAFA;
7430: border: 1px solid $lg_border_color;
7431: margin-right: 0;
7432: padding: 5px;
7433: }
7434:
7435: div.LC_confirm_box .LC_error img,
7436: div.LC_confirm_box .LC_success img {
7437: vertical-align: middle;
7438: }
7439:
1.1242 raeburn 7440: .LC_maxwidth {
7441: max-width: 100%;
7442: height: auto;
7443: }
7444:
1.1243 raeburn 7445: .LC_textsize_mobile {
7446: \@media only screen and (max-device-width: 480px) {
7447: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7448: }
7449: }
7450:
1.440 albertel 7451: .LC_icon {
1.771 droeschl 7452: border: none;
1.790 droeschl 7453: vertical-align: middle;
1.771 droeschl 7454: }
7455:
1.543 albertel 7456: .LC_docs_spacer {
7457: width: 25px;
7458: height: 1px;
1.771 droeschl 7459: border: none;
1.543 albertel 7460: }
1.346 albertel 7461:
1.532 albertel 7462: .LC_internal_info {
1.735 bisitz 7463: color: #999999;
1.532 albertel 7464: }
7465:
1.794 www 7466: .LC_discussion {
1.1050 www 7467: background: $data_table_dark;
1.911 bisitz 7468: border: 1px solid black;
7469: margin: 2px;
1.794 www 7470: }
7471:
7472: .LC_disc_action_left {
1.1050 www 7473: background: $sidebg;
1.911 bisitz 7474: text-align: left;
1.1050 www 7475: padding: 4px;
7476: margin: 2px;
1.794 www 7477: }
7478:
7479: .LC_disc_action_right {
1.1050 www 7480: background: $sidebg;
1.911 bisitz 7481: text-align: right;
1.1050 www 7482: padding: 4px;
7483: margin: 2px;
1.794 www 7484: }
7485:
7486: .LC_disc_new_item {
1.911 bisitz 7487: background: white;
7488: border: 2px solid red;
1.1050 www 7489: margin: 4px;
7490: padding: 4px;
1.794 www 7491: }
7492:
7493: .LC_disc_old_item {
1.911 bisitz 7494: background: white;
1.1050 www 7495: margin: 4px;
7496: padding: 4px;
1.794 www 7497: }
7498:
1.458 albertel 7499: table.LC_pastsubmission {
7500: border: 1px solid black;
7501: margin: 2px;
7502: }
7503:
1.924 bisitz 7504: table#LC_menubuttons {
1.345 albertel 7505: width: 100%;
7506: background: $pgbg;
1.392 albertel 7507: border: 2px;
1.402 albertel 7508: border-collapse: separate;
1.803 bisitz 7509: padding: 0;
1.345 albertel 7510: }
1.392 albertel 7511:
1.801 tempelho 7512: table#LC_title_bar a {
7513: color: $fontmenu;
7514: }
1.836 bisitz 7515:
1.807 droeschl 7516: table#LC_title_bar {
1.819 tempelho 7517: clear: both;
1.836 bisitz 7518: display: none;
1.807 droeschl 7519: }
7520:
1.795 www 7521: table#LC_title_bar,
1.933 droeschl 7522: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7523: table#LC_title_bar.LC_with_remote {
1.359 albertel 7524: width: 100%;
1.392 albertel 7525: border-color: $pgbg;
7526: border-style: solid;
7527: border-width: $border;
1.379 albertel 7528: background: $pgbg;
1.801 tempelho 7529: color: $fontmenu;
1.392 albertel 7530: border-collapse: collapse;
1.803 bisitz 7531: padding: 0;
1.819 tempelho 7532: margin: 0;
1.359 albertel 7533: }
1.795 www 7534:
1.933 droeschl 7535: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7536: margin: 0;
7537: padding: 0;
1.933 droeschl 7538: position: relative;
7539: list-style: none;
1.913 droeschl 7540: }
1.933 droeschl 7541: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7542: display: inline;
7543: }
1.933 droeschl 7544:
7545: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7546: padding: 0;
1.933 droeschl 7547: margin: 0;
7548: float: left;
1.913 droeschl 7549: }
1.933 droeschl 7550: .LC_breadcrumb_tools_tools {
7551: padding: 0;
7552: margin: 0;
1.913 droeschl 7553: float: right;
7554: }
7555:
1.1240 raeburn 7556: .LC_placement_prog {
7557: padding-right: 20px;
7558: font-weight: bold;
7559: font-size: 90%;
7560: }
7561:
1.359 albertel 7562: table#LC_title_bar td {
7563: background: $tabbg;
7564: }
1.795 www 7565:
1.911 bisitz 7566: table#LC_menubuttons img {
1.803 bisitz 7567: border: none;
1.346 albertel 7568: }
1.795 www 7569:
1.842 droeschl 7570: .LC_breadcrumbs_component {
1.911 bisitz 7571: float: right;
7572: margin: 0 1em;
1.357 albertel 7573: }
1.842 droeschl 7574: .LC_breadcrumbs_component img {
1.911 bisitz 7575: vertical-align: middle;
1.777 tempelho 7576: }
1.795 www 7577:
1.1243 raeburn 7578: .LC_breadcrumbs_hoverable {
7579: background: $sidebg;
7580: }
7581:
1.383 albertel 7582: td.LC_table_cell_checkbox {
7583: text-align: center;
7584: }
1.795 www 7585:
7586: .LC_fontsize_small {
1.911 bisitz 7587: font-size: 70%;
1.705 tempelho 7588: }
7589:
1.844 bisitz 7590: #LC_breadcrumbs {
1.911 bisitz 7591: clear:both;
7592: background: $sidebg;
7593: border-bottom: 1px solid $lg_border_color;
7594: line-height: 2.5em;
1.933 droeschl 7595: overflow: hidden;
1.911 bisitz 7596: margin: 0;
7597: padding: 0;
1.995 raeburn 7598: text-align: left;
1.819 tempelho 7599: }
1.862 bisitz 7600:
1.1098 bisitz 7601: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7602: clear:both;
7603: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7604: border: 1px solid $sidebg;
1.1098 bisitz 7605: margin: 0 0 10px 0;
1.966 bisitz 7606: padding: 3px;
1.995 raeburn 7607: text-align: left;
1.822 bisitz 7608: }
7609:
1.795 www 7610: .LC_fontsize_medium {
1.911 bisitz 7611: font-size: 85%;
1.705 tempelho 7612: }
7613:
1.795 www 7614: .LC_fontsize_large {
1.911 bisitz 7615: font-size: 120%;
1.705 tempelho 7616: }
7617:
1.346 albertel 7618: .LC_menubuttons_inline_text {
7619: color: $font;
1.698 harmsja 7620: font-size: 90%;
1.701 harmsja 7621: padding-left:3px;
1.346 albertel 7622: }
7623:
1.934 droeschl 7624: .LC_menubuttons_inline_text img{
7625: vertical-align: middle;
7626: }
7627:
1.1051 www 7628: li.LC_menubuttons_inline_text img {
1.951 onken 7629: cursor:pointer;
1.1002 droeschl 7630: text-decoration: none;
1.951 onken 7631: }
7632:
1.526 www 7633: .LC_menubuttons_link {
7634: text-decoration: none;
7635: }
1.795 www 7636:
1.522 albertel 7637: .LC_menubuttons_category {
1.521 www 7638: color: $font;
1.526 www 7639: background: $pgbg;
1.521 www 7640: font-size: larger;
7641: font-weight: bold;
7642: }
7643:
1.346 albertel 7644: td.LC_menubuttons_text {
1.911 bisitz 7645: color: $font;
1.346 albertel 7646: }
1.706 harmsja 7647:
1.346 albertel 7648: .LC_current_location {
7649: background: $tabbg;
7650: }
1.795 www 7651:
1.1286 raeburn 7652: td.LC_zero_height {
7653: line-height: 0;
7654: cellpadding: 0;
7655: }
7656:
1.938 bisitz 7657: table.LC_data_table {
1.347 albertel 7658: border: 1px solid #000000;
1.402 albertel 7659: border-collapse: separate;
1.426 albertel 7660: border-spacing: 1px;
1.610 albertel 7661: background: $pgbg;
1.347 albertel 7662: }
1.795 www 7663:
1.422 albertel 7664: .LC_data_table_dense {
7665: font-size: small;
7666: }
1.795 www 7667:
1.507 raeburn 7668: table.LC_nested_outer {
7669: border: 1px solid #000000;
1.589 raeburn 7670: border-collapse: collapse;
1.803 bisitz 7671: border-spacing: 0;
1.507 raeburn 7672: width: 100%;
7673: }
1.795 www 7674:
1.879 raeburn 7675: table.LC_innerpickbox,
1.507 raeburn 7676: table.LC_nested {
1.803 bisitz 7677: border: none;
1.589 raeburn 7678: border-collapse: collapse;
1.803 bisitz 7679: border-spacing: 0;
1.507 raeburn 7680: width: 100%;
7681: }
1.795 www 7682:
1.911 bisitz 7683: table.LC_data_table tr th,
7684: table.LC_calendar tr th,
1.879 raeburn 7685: table.LC_prior_tries tr th,
7686: table.LC_innerpickbox tr th {
1.349 albertel 7687: font-weight: bold;
7688: background-color: $data_table_head;
1.801 tempelho 7689: color:$fontmenu;
1.701 harmsja 7690: font-size:90%;
1.347 albertel 7691: }
1.795 www 7692:
1.879 raeburn 7693: table.LC_innerpickbox tr th,
7694: table.LC_innerpickbox tr td {
7695: vertical-align: top;
7696: }
7697:
1.711 raeburn 7698: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7699: background-color: #CCCCCC;
1.711 raeburn 7700: font-weight: bold;
7701: text-align: left;
7702: }
1.795 www 7703:
1.912 bisitz 7704: table.LC_data_table tr.LC_odd_row > td {
7705: background-color: $data_table_light;
7706: padding: 2px;
7707: vertical-align: top;
7708: }
7709:
1.809 bisitz 7710: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7711: background-color: $data_table_light;
1.912 bisitz 7712: vertical-align: top;
7713: }
7714:
7715: table.LC_data_table tr.LC_even_row > td {
7716: background-color: $data_table_dark;
1.425 albertel 7717: padding: 2px;
1.900 bisitz 7718: vertical-align: top;
1.347 albertel 7719: }
1.795 www 7720:
1.809 bisitz 7721: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7722: background-color: $data_table_dark;
1.900 bisitz 7723: vertical-align: top;
1.347 albertel 7724: }
1.795 www 7725:
1.425 albertel 7726: table.LC_data_table tr.LC_data_table_highlight td {
7727: background-color: $data_table_darker;
7728: }
1.795 www 7729:
1.639 raeburn 7730: table.LC_data_table tr td.LC_leftcol_header {
7731: background-color: $data_table_head;
7732: font-weight: bold;
7733: }
1.795 www 7734:
1.451 albertel 7735: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7736: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7737: font-weight: bold;
7738: font-style: italic;
7739: text-align: center;
7740: padding: 8px;
1.347 albertel 7741: }
1.795 www 7742:
1.1114 raeburn 7743: table.LC_data_table tr.LC_empty_row td,
7744: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7745: background-color: $sidebg;
7746: }
7747:
7748: table.LC_nested tr.LC_empty_row td {
7749: background-color: #FFFFFF;
7750: }
7751:
1.890 droeschl 7752: table.LC_caption {
7753: }
7754:
1.507 raeburn 7755: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7756: padding: 4ex
7757: }
1.795 www 7758:
1.507 raeburn 7759: table.LC_nested_outer tr th {
7760: font-weight: bold;
1.801 tempelho 7761: color:$fontmenu;
1.507 raeburn 7762: background-color: $data_table_head;
1.701 harmsja 7763: font-size: small;
1.507 raeburn 7764: border-bottom: 1px solid #000000;
7765: }
1.795 www 7766:
1.507 raeburn 7767: table.LC_nested_outer tr td.LC_subheader {
7768: background-color: $data_table_head;
7769: font-weight: bold;
7770: font-size: small;
7771: border-bottom: 1px solid #000000;
7772: text-align: right;
1.451 albertel 7773: }
1.795 www 7774:
1.507 raeburn 7775: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7776: background-color: #CCCCCC;
1.451 albertel 7777: font-weight: bold;
7778: font-size: small;
1.507 raeburn 7779: text-align: center;
7780: }
1.795 www 7781:
1.589 raeburn 7782: table.LC_nested tr.LC_info_row td.LC_left_item,
7783: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7784: text-align: left;
1.451 albertel 7785: }
1.795 www 7786:
1.507 raeburn 7787: table.LC_nested td {
1.735 bisitz 7788: background-color: #FFFFFF;
1.451 albertel 7789: font-size: small;
1.507 raeburn 7790: }
1.795 www 7791:
1.507 raeburn 7792: table.LC_nested_outer tr th.LC_right_item,
7793: table.LC_nested tr.LC_info_row td.LC_right_item,
7794: table.LC_nested tr.LC_odd_row td.LC_right_item,
7795: table.LC_nested tr td.LC_right_item {
1.451 albertel 7796: text-align: right;
7797: }
7798:
1.507 raeburn 7799: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7800: background-color: #EEEEEE;
1.451 albertel 7801: }
7802:
1.473 raeburn 7803: table.LC_createuser {
7804: }
7805:
7806: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7807: font-size: small;
1.473 raeburn 7808: }
7809:
7810: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7811: background-color: #CCCCCC;
1.473 raeburn 7812: font-weight: bold;
7813: text-align: center;
7814: }
7815:
1.349 albertel 7816: table.LC_calendar {
7817: border: 1px solid #000000;
7818: border-collapse: collapse;
1.917 raeburn 7819: width: 98%;
1.349 albertel 7820: }
1.795 www 7821:
1.349 albertel 7822: table.LC_calendar_pickdate {
7823: font-size: xx-small;
7824: }
1.795 www 7825:
1.349 albertel 7826: table.LC_calendar tr td {
7827: border: 1px solid #000000;
7828: vertical-align: top;
1.917 raeburn 7829: width: 14%;
1.349 albertel 7830: }
1.795 www 7831:
1.349 albertel 7832: table.LC_calendar tr td.LC_calendar_day_empty {
7833: background-color: $data_table_dark;
7834: }
1.795 www 7835:
1.779 bisitz 7836: table.LC_calendar tr td.LC_calendar_day_current {
7837: background-color: $data_table_highlight;
1.777 tempelho 7838: }
1.795 www 7839:
1.938 bisitz 7840: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7841: background-color: $mail_new;
7842: }
1.795 www 7843:
1.938 bisitz 7844: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7845: background-color: $mail_new_hover;
7846: }
1.795 www 7847:
1.938 bisitz 7848: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7849: background-color: $mail_read;
7850: }
1.795 www 7851:
1.938 bisitz 7852: /*
7853: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7854: background-color: $mail_read_hover;
7855: }
1.938 bisitz 7856: */
1.795 www 7857:
1.938 bisitz 7858: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7859: background-color: $mail_replied;
7860: }
1.795 www 7861:
1.938 bisitz 7862: /*
7863: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7864: background-color: $mail_replied_hover;
7865: }
1.938 bisitz 7866: */
1.795 www 7867:
1.938 bisitz 7868: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7869: background-color: $mail_other;
7870: }
1.795 www 7871:
1.938 bisitz 7872: /*
7873: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7874: background-color: $mail_other_hover;
7875: }
1.938 bisitz 7876: */
1.494 raeburn 7877:
1.777 tempelho 7878: table.LC_data_table tr > td.LC_browser_file,
7879: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7880: background: #AAEE77;
1.389 albertel 7881: }
1.795 www 7882:
1.777 tempelho 7883: table.LC_data_table tr > td.LC_browser_file_locked,
7884: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7885: background: #FFAA99;
1.387 albertel 7886: }
1.795 www 7887:
1.777 tempelho 7888: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7889: background: #888888;
1.779 bisitz 7890: }
1.795 www 7891:
1.777 tempelho 7892: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7893: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7894: background: #F8F866;
1.777 tempelho 7895: }
1.795 www 7896:
1.696 bisitz 7897: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7898: background: #E0E8FF;
1.387 albertel 7899: }
1.696 bisitz 7900:
1.707 bisitz 7901: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7902: /* background: #77FF77; */
1.707 bisitz 7903: }
1.795 www 7904:
1.707 bisitz 7905: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7906: border-right: 8px solid #FFFF77;
1.707 bisitz 7907: }
1.795 www 7908:
1.707 bisitz 7909: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7910: border-right: 8px solid #FFAA77;
1.707 bisitz 7911: }
1.795 www 7912:
1.707 bisitz 7913: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7914: border-right: 8px solid #FF7777;
1.707 bisitz 7915: }
1.795 www 7916:
1.707 bisitz 7917: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7918: border-right: 8px solid #AAFF77;
1.707 bisitz 7919: }
1.795 www 7920:
1.707 bisitz 7921: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7922: border-right: 8px solid #11CC55;
1.707 bisitz 7923: }
7924:
1.388 albertel 7925: span.LC_current_location {
1.701 harmsja 7926: font-size:larger;
1.388 albertel 7927: background: $pgbg;
7928: }
1.387 albertel 7929:
1.1029 www 7930: span.LC_current_nav_location {
7931: font-weight:bold;
7932: background: $sidebg;
7933: }
7934:
1.395 albertel 7935: span.LC_parm_menu_item {
7936: font-size: larger;
7937: }
1.795 www 7938:
1.395 albertel 7939: span.LC_parm_scope_all {
7940: color: red;
7941: }
1.795 www 7942:
1.395 albertel 7943: span.LC_parm_scope_folder {
7944: color: green;
7945: }
1.795 www 7946:
1.395 albertel 7947: span.LC_parm_scope_resource {
7948: color: orange;
7949: }
1.795 www 7950:
1.395 albertel 7951: span.LC_parm_part {
7952: color: blue;
7953: }
1.795 www 7954:
1.911 bisitz 7955: span.LC_parm_folder,
7956: span.LC_parm_symb {
1.395 albertel 7957: font-size: x-small;
7958: font-family: $mono;
7959: color: #AAAAAA;
7960: }
7961:
1.977 bisitz 7962: ul.LC_parm_parmlist li {
7963: display: inline-block;
7964: padding: 0.3em 0.8em;
7965: vertical-align: top;
7966: width: 150px;
7967: border-top:1px solid $lg_border_color;
7968: }
7969:
1.795 www 7970: td.LC_parm_overview_level_menu,
7971: td.LC_parm_overview_map_menu,
7972: td.LC_parm_overview_parm_selectors,
7973: td.LC_parm_overview_restrictions {
1.396 albertel 7974: border: 1px solid black;
7975: border-collapse: collapse;
7976: }
1.795 www 7977:
1.1285 raeburn 7978: span.LC_parm_recursive,
7979: td.LC_parm_recursive {
7980: font-weight: bold;
7981: font-size: smaller;
7982: }
7983:
1.396 albertel 7984: table.LC_parm_overview_restrictions td {
7985: border-width: 1px 4px 1px 4px;
7986: border-style: solid;
7987: border-color: $pgbg;
7988: text-align: center;
7989: }
1.795 www 7990:
1.396 albertel 7991: table.LC_parm_overview_restrictions th {
7992: background: $tabbg;
7993: border-width: 1px 4px 1px 4px;
7994: border-style: solid;
7995: border-color: $pgbg;
7996: }
1.795 www 7997:
1.398 albertel 7998: table#LC_helpmenu {
1.803 bisitz 7999: border: none;
1.398 albertel 8000: height: 55px;
1.803 bisitz 8001: border-spacing: 0;
1.398 albertel 8002: }
8003:
8004: table#LC_helpmenu fieldset legend {
8005: font-size: larger;
8006: }
1.795 www 8007:
1.397 albertel 8008: table#LC_helpmenu_links {
8009: width: 100%;
8010: border: 1px solid black;
8011: background: $pgbg;
1.803 bisitz 8012: padding: 0;
1.397 albertel 8013: border-spacing: 1px;
8014: }
1.795 www 8015:
1.397 albertel 8016: table#LC_helpmenu_links tr td {
8017: padding: 1px;
8018: background: $tabbg;
1.399 albertel 8019: text-align: center;
8020: font-weight: bold;
1.397 albertel 8021: }
1.396 albertel 8022:
1.795 www 8023: table#LC_helpmenu_links a:link,
8024: table#LC_helpmenu_links a:visited,
1.397 albertel 8025: table#LC_helpmenu_links a:active {
8026: text-decoration: none;
8027: color: $font;
8028: }
1.795 www 8029:
1.397 albertel 8030: table#LC_helpmenu_links a:hover {
8031: text-decoration: underline;
8032: color: $vlink;
8033: }
1.396 albertel 8034:
1.417 albertel 8035: .LC_chrt_popup_exists {
8036: border: 1px solid #339933;
8037: margin: -1px;
8038: }
1.795 www 8039:
1.417 albertel 8040: .LC_chrt_popup_up {
8041: border: 1px solid yellow;
8042: margin: -1px;
8043: }
1.795 www 8044:
1.417 albertel 8045: .LC_chrt_popup {
8046: border: 1px solid #8888FF;
8047: background: #CCCCFF;
8048: }
1.795 www 8049:
1.421 albertel 8050: table.LC_pick_box {
8051: border-collapse: separate;
8052: background: white;
8053: border: 1px solid black;
8054: border-spacing: 1px;
8055: }
1.795 www 8056:
1.421 albertel 8057: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8058: background: $sidebg;
1.421 albertel 8059: font-weight: bold;
1.900 bisitz 8060: text-align: left;
1.740 bisitz 8061: vertical-align: top;
1.421 albertel 8062: width: 184px;
8063: padding: 8px;
8064: }
1.795 www 8065:
1.579 raeburn 8066: table.LC_pick_box td.LC_pick_box_value {
8067: text-align: left;
8068: padding: 8px;
8069: }
1.795 www 8070:
1.579 raeburn 8071: table.LC_pick_box td.LC_pick_box_select {
8072: text-align: left;
8073: padding: 8px;
8074: }
1.795 www 8075:
1.424 albertel 8076: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8077: padding: 0;
1.421 albertel 8078: height: 1px;
8079: background: black;
8080: }
1.795 www 8081:
1.421 albertel 8082: table.LC_pick_box td.LC_pick_box_submit {
8083: text-align: right;
8084: }
1.795 www 8085:
1.579 raeburn 8086: table.LC_pick_box td.LC_evenrow_value {
8087: text-align: left;
8088: padding: 8px;
8089: background-color: $data_table_light;
8090: }
1.795 www 8091:
1.579 raeburn 8092: table.LC_pick_box td.LC_oddrow_value {
8093: text-align: left;
8094: padding: 8px;
8095: background-color: $data_table_light;
8096: }
1.795 www 8097:
1.579 raeburn 8098: span.LC_helpform_receipt_cat {
8099: font-weight: bold;
8100: }
1.795 www 8101:
1.424 albertel 8102: table.LC_group_priv_box {
8103: background: white;
8104: border: 1px solid black;
8105: border-spacing: 1px;
8106: }
1.795 www 8107:
1.424 albertel 8108: table.LC_group_priv_box td.LC_pick_box_title {
8109: background: $tabbg;
8110: font-weight: bold;
8111: text-align: right;
8112: width: 184px;
8113: }
1.795 www 8114:
1.424 albertel 8115: table.LC_group_priv_box td.LC_groups_fixed {
8116: background: $data_table_light;
8117: text-align: center;
8118: }
1.795 www 8119:
1.424 albertel 8120: table.LC_group_priv_box td.LC_groups_optional {
8121: background: $data_table_dark;
8122: text-align: center;
8123: }
1.795 www 8124:
1.424 albertel 8125: table.LC_group_priv_box td.LC_groups_functionality {
8126: background: $data_table_darker;
8127: text-align: center;
8128: font-weight: bold;
8129: }
1.795 www 8130:
1.424 albertel 8131: table.LC_group_priv td {
8132: text-align: left;
1.803 bisitz 8133: padding: 0;
1.424 albertel 8134: }
8135:
8136: .LC_navbuttons {
8137: margin: 2ex 0ex 2ex 0ex;
8138: }
1.795 www 8139:
1.423 albertel 8140: .LC_topic_bar {
8141: font-weight: bold;
8142: background: $tabbg;
1.918 wenzelju 8143: margin: 1em 0em 1em 2em;
1.805 bisitz 8144: padding: 3px;
1.918 wenzelju 8145: font-size: 1.2em;
1.423 albertel 8146: }
1.795 www 8147:
1.423 albertel 8148: .LC_topic_bar span {
1.918 wenzelju 8149: left: 0.5em;
8150: position: absolute;
1.423 albertel 8151: vertical-align: middle;
1.918 wenzelju 8152: font-size: 1.2em;
1.423 albertel 8153: }
1.795 www 8154:
1.423 albertel 8155: table.LC_course_group_status {
8156: margin: 20px;
8157: }
1.795 www 8158:
1.423 albertel 8159: table.LC_status_selector td {
8160: vertical-align: top;
8161: text-align: center;
1.424 albertel 8162: padding: 4px;
8163: }
1.795 www 8164:
1.599 albertel 8165: div.LC_feedback_link {
1.616 albertel 8166: clear: both;
1.829 kalberla 8167: background: $sidebg;
1.779 bisitz 8168: width: 100%;
1.829 kalberla 8169: padding-bottom: 10px;
8170: border: 1px $tabbg solid;
1.833 kalberla 8171: height: 22px;
8172: line-height: 22px;
8173: padding-top: 5px;
8174: }
8175:
8176: div.LC_feedback_link img {
8177: height: 22px;
1.867 kalberla 8178: vertical-align:middle;
1.829 kalberla 8179: }
8180:
1.911 bisitz 8181: div.LC_feedback_link a {
1.829 kalberla 8182: text-decoration: none;
1.489 raeburn 8183: }
1.795 www 8184:
1.867 kalberla 8185: div.LC_comblock {
1.911 bisitz 8186: display:inline;
1.867 kalberla 8187: color:$font;
8188: font-size:90%;
8189: }
8190:
8191: div.LC_feedback_link div.LC_comblock {
8192: padding-left:5px;
8193: }
8194:
8195: div.LC_feedback_link div.LC_comblock a {
8196: color:$font;
8197: }
8198:
1.489 raeburn 8199: span.LC_feedback_link {
1.858 bisitz 8200: /* background: $feedback_link_bg; */
1.599 albertel 8201: font-size: larger;
8202: }
1.795 www 8203:
1.599 albertel 8204: span.LC_message_link {
1.858 bisitz 8205: /* background: $feedback_link_bg; */
1.599 albertel 8206: font-size: larger;
8207: position: absolute;
8208: right: 1em;
1.489 raeburn 8209: }
1.421 albertel 8210:
1.515 albertel 8211: table.LC_prior_tries {
1.524 albertel 8212: border: 1px solid #000000;
8213: border-collapse: separate;
8214: border-spacing: 1px;
1.515 albertel 8215: }
1.523 albertel 8216:
1.515 albertel 8217: table.LC_prior_tries td {
1.524 albertel 8218: padding: 2px;
1.515 albertel 8219: }
1.523 albertel 8220:
8221: .LC_answer_correct {
1.795 www 8222: background: lightgreen;
8223: color: darkgreen;
8224: padding: 6px;
1.523 albertel 8225: }
1.795 www 8226:
1.523 albertel 8227: .LC_answer_charged_try {
1.797 www 8228: background: #FFAAAA;
1.795 www 8229: color: darkred;
8230: padding: 6px;
1.523 albertel 8231: }
1.795 www 8232:
1.779 bisitz 8233: .LC_answer_not_charged_try,
1.523 albertel 8234: .LC_answer_no_grade,
8235: .LC_answer_late {
1.795 www 8236: background: lightyellow;
1.523 albertel 8237: color: black;
1.795 www 8238: padding: 6px;
1.523 albertel 8239: }
1.795 www 8240:
1.523 albertel 8241: .LC_answer_previous {
1.795 www 8242: background: lightblue;
8243: color: darkblue;
8244: padding: 6px;
1.523 albertel 8245: }
1.795 www 8246:
1.779 bisitz 8247: .LC_answer_no_message {
1.777 tempelho 8248: background: #FFFFFF;
8249: color: black;
1.795 www 8250: padding: 6px;
1.779 bisitz 8251: }
1.795 www 8252:
1.1334 raeburn 8253: .LC_answer_unknown,
8254: .LC_answer_warning {
1.779 bisitz 8255: background: orange;
8256: color: black;
1.795 www 8257: padding: 6px;
1.777 tempelho 8258: }
1.795 www 8259:
1.1446 raeburn 8260: .LC_prob_status {
1.1447 raeburn 8261: margin-top: 5px;
1.1446 raeburn 8262: padding-top: 0;
8263: padding-left: 0;
8264: padding-bottom: 0;
8265: padding-right: 5px;
8266: }
8267:
1.1448 raeburn 8268: .LC_mail_actions {
8269: float: left;
8270: padding: 0;
8271: margin: 6px;
8272: }
8273:
8274: .LC_vertical_line {
8275: width: 1px;
8276: background-color: black;
8277: height: 4em;
8278: float: left;
8279: margin: 0;
8280: padding: 0;
8281: }
8282:
1.529 albertel 8283: span.LC_prior_numerical,
8284: span.LC_prior_string,
8285: span.LC_prior_custom,
8286: span.LC_prior_reaction,
8287: span.LC_prior_math {
1.925 bisitz 8288: font-family: $mono;
1.523 albertel 8289: white-space: pre;
8290: }
8291:
1.525 albertel 8292: span.LC_prior_string {
1.925 bisitz 8293: font-family: $mono;
1.525 albertel 8294: white-space: pre;
8295: }
8296:
1.523 albertel 8297: table.LC_prior_option {
8298: width: 100%;
8299: border-collapse: collapse;
8300: }
1.795 www 8301:
1.911 bisitz 8302: table.LC_prior_rank,
1.795 www 8303: table.LC_prior_match {
1.528 albertel 8304: border-collapse: collapse;
8305: }
1.795 www 8306:
1.528 albertel 8307: table.LC_prior_option tr td,
8308: table.LC_prior_rank tr td,
8309: table.LC_prior_match tr td {
1.524 albertel 8310: border: 1px solid #000000;
1.515 albertel 8311: }
8312:
1.855 bisitz 8313: .LC_nobreak {
1.544 albertel 8314: white-space: nowrap;
1.519 raeburn 8315: }
8316:
1.576 raeburn 8317: span.LC_cusr_emph {
8318: font-style: italic;
8319: }
8320:
1.633 raeburn 8321: span.LC_cusr_subheading {
8322: font-weight: normal;
8323: font-size: 85%;
8324: }
8325:
1.861 bisitz 8326: div.LC_docs_entry_move {
1.859 bisitz 8327: border: 1px solid #BBBBBB;
1.545 albertel 8328: background: #DDDDDD;
1.861 bisitz 8329: width: 22px;
1.859 bisitz 8330: padding: 1px;
8331: margin: 0;
1.545 albertel 8332: }
8333:
1.861 bisitz 8334: table.LC_data_table tr > td.LC_docs_entry_commands,
8335: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8336: font-size: x-small;
8337: }
1.795 www 8338:
1.861 bisitz 8339: .LC_docs_entry_parameter {
8340: white-space: nowrap;
8341: }
8342:
1.544 albertel 8343: .LC_docs_copy {
1.545 albertel 8344: color: #000099;
1.544 albertel 8345: }
1.795 www 8346:
1.544 albertel 8347: .LC_docs_cut {
1.545 albertel 8348: color: #550044;
1.544 albertel 8349: }
1.795 www 8350:
1.544 albertel 8351: .LC_docs_rename {
1.545 albertel 8352: color: #009900;
1.544 albertel 8353: }
1.795 www 8354:
1.544 albertel 8355: .LC_docs_remove {
1.545 albertel 8356: color: #990000;
8357: }
8358:
1.1284 raeburn 8359: .LC_docs_alias {
8360: color: #440055;
8361: }
8362:
1.1286 raeburn 8363: .LC_domprefs_email,
1.1284 raeburn 8364: .LC_docs_alias_name,
1.547 albertel 8365: .LC_docs_reinit_warn,
8366: .LC_docs_ext_edit {
8367: font-size: x-small;
8368: }
8369:
1.545 albertel 8370: table.LC_docs_adddocs td,
8371: table.LC_docs_adddocs th {
8372: border: 1px solid #BBBBBB;
8373: padding: 4px;
8374: background: #DDDDDD;
1.543 albertel 8375: }
8376:
1.584 albertel 8377: table.LC_sty_begin {
8378: background: #BBFFBB;
8379: }
1.795 www 8380:
1.584 albertel 8381: table.LC_sty_end {
8382: background: #FFBBBB;
8383: }
8384:
1.589 raeburn 8385: table.LC_double_column {
1.803 bisitz 8386: border-width: 0;
1.589 raeburn 8387: border-collapse: collapse;
8388: width: 100%;
8389: padding: 2px;
8390: }
8391:
8392: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8393: top: 2px;
1.589 raeburn 8394: left: 2px;
8395: width: 47%;
8396: vertical-align: top;
8397: }
8398:
8399: table.LC_double_column tr td.LC_right_col {
8400: top: 2px;
1.779 bisitz 8401: right: 2px;
1.589 raeburn 8402: width: 47%;
8403: vertical-align: top;
8404: }
8405:
1.591 raeburn 8406: div.LC_left_float {
8407: float: left;
8408: padding-right: 5%;
1.597 albertel 8409: padding-bottom: 4px;
1.591 raeburn 8410: }
8411:
8412: div.LC_clear_float_header {
1.597 albertel 8413: padding-bottom: 2px;
1.591 raeburn 8414: }
8415:
8416: div.LC_clear_float_footer {
1.597 albertel 8417: padding-top: 10px;
1.591 raeburn 8418: clear: both;
8419: }
8420:
1.597 albertel 8421: div.LC_grade_show_user {
1.941 bisitz 8422: /* border-left: 5px solid $sidebg; */
8423: border-top: 5px solid #000000;
8424: margin: 50px 0 0 0;
1.936 bisitz 8425: padding: 15px 0 5px 10px;
1.597 albertel 8426: }
1.795 www 8427:
1.936 bisitz 8428: div.LC_grade_show_user_odd_row {
1.941 bisitz 8429: /* border-left: 5px solid #000000; */
8430: }
8431:
8432: div.LC_grade_show_user div.LC_Box {
8433: margin-right: 50px;
1.597 albertel 8434: }
8435:
8436: div.LC_grade_submissions,
8437: div.LC_grade_message_center,
1.936 bisitz 8438: div.LC_grade_info_links {
1.597 albertel 8439: margin: 5px;
8440: width: 99%;
8441: background: #FFFFFF;
8442: }
1.795 www 8443:
1.597 albertel 8444: div.LC_grade_submissions_header,
1.936 bisitz 8445: div.LC_grade_message_center_header {
1.705 tempelho 8446: font-weight: bold;
8447: font-size: large;
1.597 albertel 8448: }
1.795 www 8449:
1.597 albertel 8450: div.LC_grade_submissions_body,
1.936 bisitz 8451: div.LC_grade_message_center_body {
1.597 albertel 8452: border: 1px solid black;
8453: width: 99%;
8454: background: #FFFFFF;
8455: }
1.795 www 8456:
1.613 albertel 8457: table.LC_scantron_action {
8458: width: 100%;
8459: }
1.795 www 8460:
1.613 albertel 8461: table.LC_scantron_action tr th {
1.698 harmsja 8462: font-weight:bold;
8463: font-style:normal;
1.613 albertel 8464: }
1.795 www 8465:
1.779 bisitz 8466: .LC_edit_problem_header,
1.614 albertel 8467: div.LC_edit_problem_footer {
1.705 tempelho 8468: font-weight: normal;
8469: font-size: medium;
1.602 albertel 8470: margin: 2px;
1.1060 bisitz 8471: background-color: $sidebg;
1.600 albertel 8472: }
1.795 www 8473:
1.600 albertel 8474: div.LC_edit_problem_header,
1.602 albertel 8475: div.LC_edit_problem_header div,
1.614 albertel 8476: div.LC_edit_problem_footer,
8477: div.LC_edit_problem_footer div,
1.602 albertel 8478: div.LC_edit_problem_editxml_header,
8479: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8480: z-index: 100;
1.600 albertel 8481: }
1.795 www 8482:
1.600 albertel 8483: div.LC_edit_problem_header_title {
1.705 tempelho 8484: font-weight: bold;
8485: font-size: larger;
1.602 albertel 8486: background: $tabbg;
8487: padding: 3px;
1.1060 bisitz 8488: margin: 0 0 5px 0;
1.602 albertel 8489: }
1.795 www 8490:
1.602 albertel 8491: table.LC_edit_problem_header_title {
8492: width: 100%;
1.600 albertel 8493: background: $tabbg;
1.602 albertel 8494: }
8495:
1.1205 golterma 8496: div.LC_edit_actionbar {
8497: background-color: $sidebg;
1.1218 droeschl 8498: margin: 0;
8499: padding: 0;
8500: line-height: 200%;
1.602 albertel 8501: }
1.795 www 8502:
1.1218 droeschl 8503: div.LC_edit_actionbar div{
8504: padding: 0;
8505: margin: 0;
8506: display: inline-block;
1.600 albertel 8507: }
1.795 www 8508:
1.1124 bisitz 8509: .LC_edit_opt {
8510: padding-left: 1em;
8511: white-space: nowrap;
8512: }
8513:
1.1152 golterma 8514: .LC_edit_problem_latexhelper{
8515: text-align: right;
8516: }
8517:
8518: #LC_edit_problem_colorful div{
8519: margin-left: 40px;
8520: }
8521:
1.1205 golterma 8522: #LC_edit_problem_codemirror div{
8523: margin-left: 0px;
8524: }
8525:
1.911 bisitz 8526: img.stift {
1.803 bisitz 8527: border-width: 0;
8528: vertical-align: middle;
1.677 riegler 8529: }
1.680 riegler 8530:
1.923 bisitz 8531: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8532: vertical-align: top;
1.777 tempelho 8533: }
1.795 www 8534:
1.716 raeburn 8535: div.LC_createcourse {
1.911 bisitz 8536: margin: 10px 10px 10px 10px;
1.716 raeburn 8537: }
8538:
1.917 raeburn 8539: .LC_dccid {
1.1130 raeburn 8540: float: right;
1.917 raeburn 8541: margin: 0.2em 0 0 0;
8542: padding: 0;
8543: font-size: 90%;
8544: display:none;
8545: }
8546:
1.897 wenzelju 8547: ol.LC_primary_menu a:hover,
1.721 harmsja 8548: ol#LC_MenuBreadcrumbs a:hover,
8549: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8550: ul#LC_secondary_menu a:hover,
1.721 harmsja 8551: .LC_FormSectionClearButton input:hover
1.795 www 8552: ul.LC_TabContent li:hover a {
1.952 onken 8553: color:$button_hover;
1.911 bisitz 8554: text-decoration:none;
1.693 droeschl 8555: }
8556:
1.779 bisitz 8557: h1 {
1.911 bisitz 8558: padding: 0;
8559: line-height:130%;
1.693 droeschl 8560: }
1.698 harmsja 8561:
1.911 bisitz 8562: h2,
8563: h3,
8564: h4,
8565: h5,
8566: h6 {
8567: margin: 5px 0 5px 0;
8568: padding: 0;
8569: line-height:130%;
1.693 droeschl 8570: }
1.795 www 8571:
8572: .LC_hcell {
1.911 bisitz 8573: padding:3px 15px 3px 15px;
8574: margin: 0;
8575: background-color:$tabbg;
8576: color:$fontmenu;
8577: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8578: }
1.795 www 8579:
1.840 bisitz 8580: .LC_Box > .LC_hcell {
1.911 bisitz 8581: margin: 0 -10px 10px -10px;
1.835 bisitz 8582: }
8583:
1.721 harmsja 8584: .LC_noBorder {
1.911 bisitz 8585: border: 0;
1.698 harmsja 8586: }
1.693 droeschl 8587:
1.721 harmsja 8588: .LC_FormSectionClearButton input {
1.911 bisitz 8589: background-color:transparent;
8590: border: none;
8591: cursor:pointer;
8592: text-decoration:underline;
1.693 droeschl 8593: }
1.763 bisitz 8594:
8595: .LC_help_open_topic {
1.911 bisitz 8596: color: #FFFFFF;
8597: background-color: #EEEEFF;
8598: margin: 1px;
8599: padding: 4px;
8600: border: 1px solid #000033;
8601: white-space: nowrap;
8602: /* vertical-align: middle; */
1.759 neumanie 8603: }
1.693 droeschl 8604:
1.911 bisitz 8605: dl,
8606: ul,
8607: div,
8608: fieldset {
8609: margin: 10px 10px 10px 0;
8610: /* overflow: hidden; */
1.693 droeschl 8611: }
1.795 www 8612:
1.1404 raeburn 8613: fieldset#LC_selectuser {
8614: margin: 0;
8615: padding: 0;
8616: }
8617:
1.1211 raeburn 8618: article.geogebraweb div {
8619: margin: 0;
8620: }
8621:
1.838 bisitz 8622: fieldset > legend {
1.911 bisitz 8623: font-weight: bold;
8624: padding: 0 5px 0 5px;
1.838 bisitz 8625: }
8626:
1.813 bisitz 8627: #LC_nav_bar {
1.911 bisitz 8628: float: left;
1.995 raeburn 8629: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8630: margin: 0 0 2px 0;
1.807 droeschl 8631: }
8632:
1.916 droeschl 8633: #LC_realm {
8634: margin: 0.2em 0 0 0;
8635: padding: 0;
8636: font-weight: bold;
8637: text-align: center;
1.995 raeburn 8638: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8639: }
8640:
1.911 bisitz 8641: #LC_nav_bar em {
8642: font-weight: bold;
8643: font-style: normal;
1.807 droeschl 8644: }
8645:
1.897 wenzelju 8646: ol.LC_primary_menu {
1.934 droeschl 8647: margin: 0;
1.1076 raeburn 8648: padding: 0;
1.807 droeschl 8649: }
8650:
1.852 droeschl 8651: ol#LC_PathBreadcrumbs {
1.911 bisitz 8652: margin: 0;
1.693 droeschl 8653: }
8654:
1.897 wenzelju 8655: ol.LC_primary_menu li {
1.1076 raeburn 8656: color: RGB(80, 80, 80);
8657: vertical-align: middle;
8658: text-align: left;
8659: list-style: none;
1.1205 golterma 8660: position: relative;
1.1076 raeburn 8661: float: left;
1.1205 golterma 8662: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8663: line-height: 1.5em;
1.1076 raeburn 8664: }
8665:
1.1205 golterma 8666: ol.LC_primary_menu li a,
8667: ol.LC_primary_menu li p {
1.1076 raeburn 8668: display: block;
8669: margin: 0;
8670: padding: 0 5px 0 10px;
8671: text-decoration: none;
8672: }
8673:
1.1205 golterma 8674: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8675: display: inline-block;
8676: width: 95%;
8677: text-align: left;
8678: }
8679:
8680: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8681: display: inline-block;
8682: width: 5%;
8683: float: right;
8684: text-align: right;
8685: font-size: 70%;
8686: }
8687:
8688: ol.LC_primary_menu ul {
1.1076 raeburn 8689: display: none;
1.1205 golterma 8690: width: 15em;
1.1076 raeburn 8691: background-color: $data_table_light;
1.1205 golterma 8692: position: absolute;
8693: top: 100%;
1.1076 raeburn 8694: }
8695:
1.1205 golterma 8696: ol.LC_primary_menu ul ul {
8697: left: 100%;
8698: top: 0;
8699: }
8700:
8701: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8702: display: block;
8703: position: absolute;
8704: margin: 0;
8705: padding: 0;
1.1078 raeburn 8706: z-index: 2;
1.1076 raeburn 8707: }
8708:
8709: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8710: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8711: font-size: 90%;
1.911 bisitz 8712: vertical-align: top;
1.1076 raeburn 8713: float: none;
1.1079 raeburn 8714: border-left: 1px solid black;
8715: border-right: 1px solid black;
1.1205 golterma 8716: /* A dark bottom border to visualize different menu options;
8717: overwritten in the create_submenu routine for the last border-bottom of the menu */
8718: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8719: }
8720:
1.1205 golterma 8721: ol.LC_primary_menu li li p:hover {
8722: color:$button_hover;
8723: text-decoration:none;
8724: background-color:$data_table_dark;
1.1076 raeburn 8725: }
8726:
8727: ol.LC_primary_menu li li a:hover {
8728: color:$button_hover;
8729: background-color:$data_table_dark;
1.693 droeschl 8730: }
8731:
1.1205 golterma 8732: /* Font-size equal to the size of the predecessors*/
8733: ol.LC_primary_menu li:hover li li {
8734: font-size: 100%;
8735: }
8736:
1.897 wenzelju 8737: ol.LC_primary_menu li img {
1.911 bisitz 8738: vertical-align: bottom;
1.934 droeschl 8739: height: 1.1em;
1.1077 raeburn 8740: margin: 0.2em 0 0 0;
1.693 droeschl 8741: }
8742:
1.897 wenzelju 8743: ol.LC_primary_menu a {
1.911 bisitz 8744: color: RGB(80, 80, 80);
8745: text-decoration: none;
1.693 droeschl 8746: }
1.795 www 8747:
1.949 droeschl 8748: ol.LC_primary_menu a.LC_new_message {
8749: font-weight:bold;
8750: color: darkred;
8751: }
8752:
1.975 raeburn 8753: ol.LC_docs_parameters {
8754: margin-left: 0;
8755: padding: 0;
8756: list-style: none;
8757: }
8758:
8759: ol.LC_docs_parameters li {
8760: margin: 0;
8761: padding-right: 20px;
8762: display: inline;
8763: }
8764:
1.976 raeburn 8765: ol.LC_docs_parameters li:before {
8766: content: "\\002022 \\0020";
8767: }
8768:
8769: li.LC_docs_parameters_title {
8770: font-weight: bold;
8771: }
8772:
8773: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8774: content: "";
8775: }
8776:
1.897 wenzelju 8777: ul#LC_secondary_menu {
1.1107 raeburn 8778: clear: right;
1.911 bisitz 8779: color: $fontmenu;
8780: background: $tabbg;
8781: list-style: none;
8782: padding: 0;
8783: margin: 0;
8784: width: 100%;
1.995 raeburn 8785: text-align: left;
1.1107 raeburn 8786: float: left;
1.808 droeschl 8787: }
8788:
1.897 wenzelju 8789: ul#LC_secondary_menu li {
1.911 bisitz 8790: font-weight: bold;
8791: line-height: 1.8em;
1.1107 raeburn 8792: border-right: 1px solid black;
8793: float: left;
8794: }
8795:
8796: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8797: background-color: $data_table_light;
8798: }
8799:
8800: ul#LC_secondary_menu li a {
1.911 bisitz 8801: padding: 0 0.8em;
1.1107 raeburn 8802: }
8803:
8804: ul#LC_secondary_menu li ul {
8805: display: none;
8806: }
8807:
8808: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8809: display: block;
8810: position: absolute;
8811: margin: 0;
8812: padding: 0;
8813: list-style:none;
8814: float: none;
8815: background-color: $data_table_light;
8816: z-index: 2;
8817: margin-left: -1px;
8818: }
8819:
8820: ul#LC_secondary_menu li ul li {
8821: font-size: 90%;
8822: vertical-align: top;
8823: border-left: 1px solid black;
1.911 bisitz 8824: border-right: 1px solid black;
1.1119 raeburn 8825: background-color: $data_table_light;
1.1107 raeburn 8826: list-style:none;
8827: float: none;
8828: }
8829:
8830: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8831: background-color: $data_table_dark;
1.807 droeschl 8832: }
8833:
1.847 tempelho 8834: ul.LC_TabContent {
1.911 bisitz 8835: display:block;
8836: background: $sidebg;
8837: border-bottom: solid 1px $lg_border_color;
8838: list-style:none;
1.1020 raeburn 8839: margin: -1px -10px 0 -10px;
1.911 bisitz 8840: padding: 0;
1.693 droeschl 8841: }
8842:
1.795 www 8843: ul.LC_TabContent li,
8844: ul.LC_TabContentBigger li {
1.911 bisitz 8845: float:left;
1.741 harmsja 8846: }
1.795 www 8847:
1.897 wenzelju 8848: ul#LC_secondary_menu li a {
1.911 bisitz 8849: color: $fontmenu;
8850: text-decoration: none;
1.693 droeschl 8851: }
1.795 www 8852:
1.721 harmsja 8853: ul.LC_TabContent {
1.952 onken 8854: min-height:20px;
1.721 harmsja 8855: }
1.795 www 8856:
8857: ul.LC_TabContent li {
1.911 bisitz 8858: vertical-align:middle;
1.959 onken 8859: padding: 0 16px 0 10px;
1.911 bisitz 8860: background-color:$tabbg;
8861: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8862: border-left: solid 1px $font;
1.721 harmsja 8863: }
1.795 www 8864:
1.847 tempelho 8865: ul.LC_TabContent .right {
1.911 bisitz 8866: float:right;
1.847 tempelho 8867: }
8868:
1.911 bisitz 8869: ul.LC_TabContent li a,
8870: ul.LC_TabContent li {
8871: color:rgb(47,47,47);
8872: text-decoration:none;
8873: font-size:95%;
8874: font-weight:bold;
1.952 onken 8875: min-height:20px;
8876: }
8877:
1.959 onken 8878: ul.LC_TabContent li a:hover,
8879: ul.LC_TabContent li a:focus {
1.952 onken 8880: color: $button_hover;
1.959 onken 8881: background:none;
8882: outline:none;
1.952 onken 8883: }
8884:
8885: ul.LC_TabContent li:hover {
8886: color: $button_hover;
8887: cursor:pointer;
1.721 harmsja 8888: }
1.795 www 8889:
1.911 bisitz 8890: ul.LC_TabContent li.active {
1.952 onken 8891: color: $font;
1.911 bisitz 8892: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8893: border-bottom:solid 1px #FFFFFF;
8894: cursor: default;
1.744 ehlerst 8895: }
1.795 www 8896:
1.959 onken 8897: ul.LC_TabContent li.active a {
8898: color:$font;
8899: background:#FFFFFF;
8900: outline: none;
8901: }
1.1047 raeburn 8902:
8903: ul.LC_TabContent li.goback {
8904: float: left;
8905: border-left: none;
8906: }
8907:
1.870 tempelho 8908: #maincoursedoc {
1.911 bisitz 8909: clear:both;
1.870 tempelho 8910: }
8911:
8912: ul.LC_TabContentBigger {
1.911 bisitz 8913: display:block;
8914: list-style:none;
8915: padding: 0;
1.870 tempelho 8916: }
8917:
1.795 www 8918: ul.LC_TabContentBigger li {
1.911 bisitz 8919: vertical-align:bottom;
8920: height: 30px;
8921: font-size:110%;
8922: font-weight:bold;
8923: color: #737373;
1.841 tempelho 8924: }
8925:
1.957 onken 8926: ul.LC_TabContentBigger li.active {
8927: position: relative;
8928: top: 1px;
8929: }
8930:
1.870 tempelho 8931: ul.LC_TabContentBigger li a {
1.911 bisitz 8932: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8933: height: 30px;
8934: line-height: 30px;
8935: text-align: center;
8936: display: block;
8937: text-decoration: none;
1.958 onken 8938: outline: none;
1.741 harmsja 8939: }
1.795 www 8940:
1.870 tempelho 8941: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8942: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8943: color:$font;
1.744 ehlerst 8944: }
1.795 www 8945:
1.870 tempelho 8946: ul.LC_TabContentBigger li b {
1.911 bisitz 8947: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8948: display: block;
8949: float: left;
8950: padding: 0 30px;
1.957 onken 8951: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8952: }
8953:
1.956 onken 8954: ul.LC_TabContentBigger li:hover b {
8955: color:$button_hover;
8956: }
8957:
1.870 tempelho 8958: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8959: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8960: color:$font;
1.957 onken 8961: border: 0;
1.741 harmsja 8962: }
1.693 droeschl 8963:
1.870 tempelho 8964:
1.862 bisitz 8965: ul.LC_CourseBreadcrumbs {
8966: background: $sidebg;
1.1020 raeburn 8967: height: 2em;
1.862 bisitz 8968: padding-left: 10px;
1.1020 raeburn 8969: margin: 0;
1.862 bisitz 8970: list-style-position: inside;
8971: }
8972:
1.911 bisitz 8973: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8974: ol#LC_PathBreadcrumbs {
1.911 bisitz 8975: padding-left: 10px;
8976: margin: 0;
1.933 droeschl 8977: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8978: }
8979:
1.911 bisitz 8980: ol#LC_MenuBreadcrumbs li,
8981: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8982: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8983: display: inline;
1.933 droeschl 8984: white-space: normal;
1.693 droeschl 8985: }
8986:
1.823 bisitz 8987: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8988: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8989: text-decoration: none;
8990: font-size:90%;
1.693 droeschl 8991: }
1.795 www 8992:
1.969 droeschl 8993: ol#LC_MenuBreadcrumbs h1 {
8994: display: inline;
8995: font-size: 90%;
8996: line-height: 2.5em;
8997: margin: 0;
8998: padding: 0;
8999: }
9000:
1.795 www 9001: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 9002: text-decoration:none;
9003: font-size:100%;
9004: font-weight:bold;
1.693 droeschl 9005: }
1.795 www 9006:
1.840 bisitz 9007: .LC_Box {
1.911 bisitz 9008: border: solid 1px $lg_border_color;
9009: padding: 0 10px 10px 10px;
1.746 neumanie 9010: }
1.795 www 9011:
1.1020 raeburn 9012: .LC_DocsBox {
9013: border: solid 1px $lg_border_color;
9014: padding: 0 0 10px 10px;
9015: }
9016:
1.795 www 9017: .LC_AboutMe_Image {
1.911 bisitz 9018: float:left;
9019: margin-right:10px;
1.747 neumanie 9020: }
1.795 www 9021:
9022: .LC_Clear_AboutMe_Image {
1.911 bisitz 9023: clear:left;
1.747 neumanie 9024: }
1.795 www 9025:
1.721 harmsja 9026: dl.LC_ListStyleClean dt {
1.911 bisitz 9027: padding-right: 5px;
9028: display: table-header-group;
1.693 droeschl 9029: }
9030:
1.721 harmsja 9031: dl.LC_ListStyleClean dd {
1.911 bisitz 9032: display: table-row;
1.693 droeschl 9033: }
9034:
1.721 harmsja 9035: .LC_ListStyleClean,
9036: .LC_ListStyleSimple,
9037: .LC_ListStyleNormal,
1.795 www 9038: .LC_ListStyleSpecial {
1.911 bisitz 9039: /* display:block; */
9040: list-style-position: inside;
9041: list-style-type: none;
9042: overflow: hidden;
9043: padding: 0;
1.693 droeschl 9044: }
9045:
1.721 harmsja 9046: .LC_ListStyleSimple li,
9047: .LC_ListStyleSimple dd,
9048: .LC_ListStyleNormal li,
9049: .LC_ListStyleNormal dd,
9050: .LC_ListStyleSpecial li,
1.795 www 9051: .LC_ListStyleSpecial dd {
1.911 bisitz 9052: margin: 0;
9053: padding: 5px 5px 5px 10px;
9054: clear: both;
1.693 droeschl 9055: }
9056:
1.721 harmsja 9057: .LC_ListStyleClean li,
9058: .LC_ListStyleClean dd {
1.911 bisitz 9059: padding-top: 0;
9060: padding-bottom: 0;
1.693 droeschl 9061: }
9062:
1.721 harmsja 9063: .LC_ListStyleSimple dd,
1.795 www 9064: .LC_ListStyleSimple li {
1.911 bisitz 9065: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9066: }
9067:
1.721 harmsja 9068: .LC_ListStyleSpecial li,
9069: .LC_ListStyleSpecial dd {
1.911 bisitz 9070: list-style-type: none;
9071: background-color: RGB(220, 220, 220);
9072: margin-bottom: 4px;
1.693 droeschl 9073: }
9074:
1.721 harmsja 9075: table.LC_SimpleTable {
1.911 bisitz 9076: margin:5px;
9077: border:solid 1px $lg_border_color;
1.795 www 9078: }
1.693 droeschl 9079:
1.721 harmsja 9080: table.LC_SimpleTable tr {
1.911 bisitz 9081: padding: 0;
9082: border:solid 1px $lg_border_color;
1.693 droeschl 9083: }
1.795 www 9084:
9085: table.LC_SimpleTable thead {
1.911 bisitz 9086: background:rgb(220,220,220);
1.693 droeschl 9087: }
9088:
1.721 harmsja 9089: div.LC_columnSection {
1.911 bisitz 9090: display: block;
9091: clear: both;
9092: overflow: hidden;
9093: margin: 0;
1.693 droeschl 9094: }
9095:
1.721 harmsja 9096: div.LC_columnSection>* {
1.911 bisitz 9097: float: left;
9098: margin: 10px 20px 10px 0;
9099: overflow:hidden;
1.693 droeschl 9100: }
1.721 harmsja 9101:
1.795 www 9102: table em {
1.911 bisitz 9103: font-weight: bold;
9104: font-style: normal;
1.748 schulted 9105: }
1.795 www 9106:
1.779 bisitz 9107: table.LC_tableBrowseRes,
1.795 www 9108: table.LC_tableOfContent {
1.911 bisitz 9109: border:none;
9110: border-spacing: 1px;
9111: padding: 3px;
9112: background-color: #FFFFFF;
9113: font-size: 90%;
1.753 droeschl 9114: }
1.789 droeschl 9115:
1.911 bisitz 9116: table.LC_tableOfContent {
9117: border-collapse: collapse;
1.789 droeschl 9118: }
9119:
1.771 droeschl 9120: table.LC_tableBrowseRes a,
1.768 schulted 9121: table.LC_tableOfContent a {
1.911 bisitz 9122: background-color: transparent;
9123: text-decoration: none;
1.753 droeschl 9124: }
9125:
1.795 www 9126: table.LC_tableOfContent img {
1.911 bisitz 9127: border: none;
9128: height: 1.3em;
9129: vertical-align: text-bottom;
9130: margin-right: 0.3em;
1.753 droeschl 9131: }
1.757 schulted 9132:
1.795 www 9133: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9134: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9135: }
9136:
1.795 www 9137: a#LC_content_toolbar_everything {
1.911 bisitz 9138: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9139: }
9140:
1.795 www 9141: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9142: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9143: }
9144:
1.795 www 9145: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9146: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9147: }
9148:
1.795 www 9149: a#LC_content_toolbar_changefolder {
1.911 bisitz 9150: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9151: }
9152:
1.795 www 9153: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9154: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9155: }
9156:
1.1043 raeburn 9157: a#LC_content_toolbar_edittoplevel {
9158: background-image:url(/res/adm/pages/edittoplevel.gif);
9159: }
9160:
1.1384 raeburn 9161: a#LC_content_toolbar_printout {
9162: background-image:url(/res/adm/pages/printout.gif);
9163: }
9164:
1.795 www 9165: ul#LC_toolbar li a:hover {
1.911 bisitz 9166: background-position: bottom center;
1.757 schulted 9167: }
9168:
1.795 www 9169: ul#LC_toolbar {
1.911 bisitz 9170: padding: 0;
9171: margin: 2px;
9172: list-style:none;
1.1449 raeburn 9173: display:inline;
1.911 bisitz 9174: background-color:white;
1.1082 raeburn 9175: overflow: auto;
1.757 schulted 9176: }
9177:
1.795 www 9178: ul#LC_toolbar li {
1.911 bisitz 9179: border:1px solid white;
9180: padding: 0;
9181: margin: 0;
9182: float: left;
9183: display:inline;
9184: vertical-align:middle;
1.1082 raeburn 9185: white-space: nowrap;
1.911 bisitz 9186: }
1.757 schulted 9187:
1.783 amueller 9188:
1.795 www 9189: a.LC_toolbarItem {
1.911 bisitz 9190: display:block;
9191: padding: 0;
9192: margin: 0;
9193: height: 32px;
9194: width: 32px;
9195: color:white;
9196: border: none;
9197: background-repeat:no-repeat;
9198: background-color:transparent;
1.757 schulted 9199: }
9200:
1.1449 raeburn 9201: .LC_navtools {
9202: display: inline-block;
9203: padding: 0;
9204: margin: 2px;
9205: vertical-align: middle;
9206: }
9207:
1.915 droeschl 9208: ul.LC_funclist {
9209: margin: 0;
9210: padding: 0.5em 1em 0.5em 0;
9211: }
9212:
1.933 droeschl 9213: ul.LC_funclist > li:first-child {
9214: font-weight:bold;
9215: margin-left:0.8em;
9216: }
9217:
1.915 droeschl 9218: ul.LC_funclist + ul.LC_funclist {
9219: /*
9220: left border as a seperator if we have more than
9221: one list
9222: */
9223: border-left: 1px solid $sidebg;
9224: /*
9225: this hides the left border behind the border of the
9226: outer box if element is wrapped to the next 'line'
9227: */
9228: margin-left: -1px;
9229: }
9230:
1.843 bisitz 9231: ul.LC_funclist li {
1.915 droeschl 9232: display: inline;
1.782 bisitz 9233: white-space: nowrap;
1.915 droeschl 9234: margin: 0 0 0 25px;
9235: line-height: 150%;
1.782 bisitz 9236: }
9237:
1.974 wenzelju 9238: .LC_hidden {
9239: display: none;
9240: }
9241:
1.1030 www 9242: .LCmodal-overlay {
9243: position:fixed;
9244: top:0;
9245: right:0;
9246: bottom:0;
9247: left:0;
9248: height:100%;
9249: width:100%;
9250: margin:0;
9251: padding:0;
9252: background:#999;
9253: opacity:.75;
9254: filter: alpha(opacity=75);
9255: -moz-opacity: 0.75;
9256: z-index:101;
9257: }
9258:
9259: * html .LCmodal-overlay {
9260: position: absolute;
9261: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9262: }
9263:
9264: .LCmodal-window {
9265: position:fixed;
9266: top:50%;
9267: left:50%;
9268: margin:0;
9269: padding:0;
9270: z-index:102;
9271: }
9272:
9273: * html .LCmodal-window {
9274: position:absolute;
9275: }
9276:
9277: .LCclose-window {
9278: position:absolute;
9279: width:32px;
9280: height:32px;
9281: right:8px;
9282: top:8px;
9283: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9284: text-indent:-99999px;
9285: overflow:hidden;
9286: cursor:pointer;
9287: }
9288:
1.1369 raeburn 9289: .LCisDisabled {
9290: cursor: not-allowed;
9291: opacity: 0.5;
9292: }
9293:
9294: a[aria-disabled="true"] {
9295: color: currentColor;
9296: display: inline-block; /* For IE11/ MS Edge bug */
9297: pointer-events: none;
9298: text-decoration: none;
9299: }
9300:
1.1335 raeburn 9301: pre.LC_wordwrap {
9302: white-space: pre-wrap;
9303: white-space: -moz-pre-wrap;
9304: white-space: -pre-wrap;
9305: white-space: -o-pre-wrap;
9306: word-wrap: break-word;
9307: }
9308:
1.1100 raeburn 9309: /*
1.1231 damieng 9310: styles used for response display
9311: */
9312: div.LC_radiofoil, div.LC_rankfoil {
9313: margin: .5em 0em .5em 0em;
9314: }
9315: table.LC_itemgroup {
9316: margin-top: 1em;
9317: }
9318:
9319: /*
1.1100 raeburn 9320: styles used by TTH when "Default set of options to pass to tth/m
9321: when converting TeX" in course settings has been set
9322:
9323: option passed: -t
9324:
9325: */
9326:
9327: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9328: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9329: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9330: td div.norm {line-height:normal;}
9331:
9332: /*
9333: option passed -y3
9334: */
9335:
9336: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9337: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9338: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9339:
1.1230 damieng 9340: /*
9341: sections with roles, for content only
9342: */
9343: section[class^="role-"] {
9344: padding-left: 10px;
9345: padding-right: 5px;
9346: margin-top: 8px;
9347: margin-bottom: 8px;
9348: border: 1px solid #2A4;
9349: border-radius: 5px;
9350: box-shadow: 0px 1px 1px #BBB;
9351: }
9352: section[class^="role-"]>h1 {
9353: position: relative;
9354: margin: 0px;
9355: padding-top: 10px;
9356: padding-left: 40px;
9357: }
9358: section[class^="role-"]>h1:before {
9359: position: absolute;
9360: left: -5px;
9361: top: 5px;
9362: }
9363: section.role-activity>h1:before {
9364: content:url('/adm/daxe/images/section_icons/activity.png');
9365: }
9366: section.role-advice>h1:before {
9367: content:url('/adm/daxe/images/section_icons/advice.png');
9368: }
9369: section.role-bibliography>h1:before {
9370: content:url('/adm/daxe/images/section_icons/bibliography.png');
9371: }
9372: section.role-citation>h1:before {
9373: content:url('/adm/daxe/images/section_icons/citation.png');
9374: }
9375: section.role-conclusion>h1:before {
9376: content:url('/adm/daxe/images/section_icons/conclusion.png');
9377: }
9378: section.role-definition>h1:before {
9379: content:url('/adm/daxe/images/section_icons/definition.png');
9380: }
9381: section.role-demonstration>h1:before {
9382: content:url('/adm/daxe/images/section_icons/demonstration.png');
9383: }
9384: section.role-example>h1:before {
9385: content:url('/adm/daxe/images/section_icons/example.png');
9386: }
9387: section.role-explanation>h1:before {
9388: content:url('/adm/daxe/images/section_icons/explanation.png');
9389: }
9390: section.role-introduction>h1:before {
9391: content:url('/adm/daxe/images/section_icons/introduction.png');
9392: }
9393: section.role-method>h1:before {
9394: content:url('/adm/daxe/images/section_icons/method.png');
9395: }
9396: section.role-more_information>h1:before {
9397: content:url('/adm/daxe/images/section_icons/more_information.png');
9398: }
9399: section.role-objectives>h1:before {
9400: content:url('/adm/daxe/images/section_icons/objectives.png');
9401: }
9402: section.role-prerequisites>h1:before {
9403: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9404: }
9405: section.role-remark>h1:before {
9406: content:url('/adm/daxe/images/section_icons/remark.png');
9407: }
9408: section.role-reminder>h1:before {
9409: content:url('/adm/daxe/images/section_icons/reminder.png');
9410: }
9411: section.role-summary>h1:before {
9412: content:url('/adm/daxe/images/section_icons/summary.png');
9413: }
9414: section.role-syntax>h1:before {
9415: content:url('/adm/daxe/images/section_icons/syntax.png');
9416: }
9417: section.role-warning>h1:before {
9418: content:url('/adm/daxe/images/section_icons/warning.png');
9419: }
9420:
1.1269 raeburn 9421: #LC_minitab_header {
9422: float:left;
9423: width:100%;
9424: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9425: font-size:93%;
9426: line-height:normal;
9427: margin: 0.5em 0 0.5em 0;
9428: }
9429: #LC_minitab_header ul {
9430: margin:0;
9431: padding:10px 10px 0;
9432: list-style:none;
9433: }
9434: #LC_minitab_header li {
9435: float:left;
9436: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9437: margin:0;
9438: padding:0 0 0 9px;
9439: }
9440: #LC_minitab_header a {
9441: display:block;
9442: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9443: padding:5px 15px 4px 6px;
9444: }
9445: #LC_minitab_header #LC_current_minitab {
9446: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9447: }
9448: #LC_minitab_header #LC_current_minitab a {
9449: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9450: padding-bottom:5px;
9451: }
9452:
9453:
1.343 albertel 9454: END
9455: }
9456:
1.306 albertel 9457: =pod
9458:
9459: =item * &headtag()
9460:
9461: Returns a uniform footer for LON-CAPA web pages.
9462:
1.307 albertel 9463: Inputs: $title - optional title for the head
9464: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9465: $args - optional arguments
1.319 albertel 9466: force_register - if is true call registerurl so the remote is
9467: informed
1.415 albertel 9468: redirect -> array ref of
9469: 1- seconds before redirect occurs
9470: 2- url to redirect to
9471: 3- whether the side effect should occur
1.315 albertel 9472: (side effect of setting
9473: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9474: redirected to)
9475: 4- whether the redirect target should be
9476: the opener of the current (pop-up)
9477: window (side effect of setting
9478: $env{'internal.head.to_opener'} to
9479: 1, if true.
1.1388 raeburn 9480: 5- whether encrypt check should be skipped
1.352 albertel 9481: domain -> force to color decorate a page for a specific
9482: domain
9483: function -> force usage of a specific rolish color scheme
9484: bgcolor -> override the default page bgcolor
1.460 albertel 9485: no_auto_mt_title
9486: -> prevent &mt()ing the title arg
1.464 albertel 9487:
1.306 albertel 9488: =cut
9489:
9490: sub headtag {
1.313 albertel 9491: my ($title,$head_extra,$args) = @_;
1.306 albertel 9492:
1.363 albertel 9493: my $function = $args->{'function'} || &get_users_function();
9494: my $domain = $args->{'domain'} || &determinedomain();
9495: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9496: my $httphost = $args->{'use_absolute'};
1.418 albertel 9497: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9498: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9499: #time(),
1.418 albertel 9500: $env{'environment.color.timestamp'},
1.363 albertel 9501: $function,$domain,$bgcolor);
9502:
1.369 www 9503: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9504:
1.308 albertel 9505: my $result =
9506: '<head>'.
1.1160 raeburn 9507: &font_settings($args);
1.319 albertel 9508:
1.1188 raeburn 9509: my $inhibitprint;
9510: if ($args->{'print_suppress'}) {
9511: $inhibitprint = &print_suppression();
9512: }
1.1064 raeburn 9513:
1.1439 raeburn 9514: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9515: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9516: }
1.962 droeschl 9517: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9518: $result .= Apache::lonxml::display_title();
1.319 albertel 9519: }
1.436 albertel 9520: if (!$args->{'no_nav_bar'}
9521: && !$args->{'only_body'}
1.1438 raeburn 9522: && !$args->{'frameset'}
9523: && !$args->{'switchserver'}) {
1.1154 raeburn 9524: $result .= &help_menu_js($httphost);
1.1032 www 9525: $result.=&modal_window();
1.1038 www 9526: $result.=&togglebox_script();
1.1034 www 9527: $result.=&wishlist_window();
1.1041 www 9528: $result.=&LCprogressbarUpdate_script();
1.1034 www 9529: } else {
9530: if ($args->{'add_modal'}) {
9531: $result.=&modal_window();
9532: }
9533: if ($args->{'add_wishlist'}) {
9534: $result.=&wishlist_window();
9535: }
1.1038 www 9536: if ($args->{'add_togglebox'}) {
9537: $result.=&togglebox_script();
9538: }
1.1041 www 9539: if ($args->{'add_progressbar'}) {
9540: $result.=&LCprogressbarUpdate_script();
9541: }
1.436 albertel 9542: }
1.314 albertel 9543: if (ref($args->{'redirect'})) {
1.1388 raeburn 9544: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9545: if (!$skip_enc_check) {
9546: $url = &Apache::lonenc::check_encrypt($url);
9547: }
1.414 albertel 9548: if (!$inhibit_continue) {
9549: $env{'internal.head.redirect'} = $url;
9550: }
1.1386 raeburn 9551: $result.=<<"ADDMETA";
1.313 albertel 9552: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9553: ADDMETA
9554: if ($to_opener) {
9555: $env{'internal.head.to_opener'} = 1;
9556: my $dest = &js_escape($url);
9557: my $timeout = int($time * 1000);
9558: $result .=<<"ENDJS";
9559: <script type="text/javascript">
9560: // <![CDATA[
9561: function LC_To_Opener() {
9562: var dest = '$dest';
9563: if (dest != '') {
9564: if (window.opener != null && !window.opener.closed) {
9565: window.opener.location.href=dest;
9566: window.close();
9567: } else {
9568: window.location.href=dest;
9569: }
9570: }
9571: }
9572: \$(document).ready(function () {
9573: setTimeout('LC_To_Opener()',$timeout);
9574: });
9575: // ]]>
9576: </script>
9577: ENDJS
9578: } else {
9579: $result.=<<"ADDMETA";
1.344 albertel 9580: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9581: ADDMETA
1.1386 raeburn 9582: }
1.1210 raeburn 9583: } else {
9584: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9585: my $requrl = $env{'request.uri'};
9586: if ($requrl eq '') {
9587: $requrl = $ENV{'REQUEST_URI'};
9588: $requrl =~ s/\?.+$//;
9589: }
9590: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9591: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9592: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9593: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9594: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9595: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9596: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9597: my ($offload,$offloadoth);
1.1210 raeburn 9598: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9599: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9600: $offload = 1;
1.1353 raeburn 9601: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9602: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9603: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9604: $offloadoth = 1;
9605: $dom_in_use = $env{'user.domain'};
9606: }
9607: }
1.1340 raeburn 9608: }
9609: }
9610: unless ($offload) {
9611: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9612: if ($domdefs{'offloadoth'}{$lonhost}) {
9613: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9614: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9615: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9616: $offload = 1;
1.1352 raeburn 9617: $offloadoth = 1;
1.1340 raeburn 9618: $dom_in_use = $env{'user.domain'};
9619: }
1.1210 raeburn 9620: }
1.1340 raeburn 9621: }
9622: }
9623: }
9624: if ($offload) {
1.1358 raeburn 9625: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9626: if (($newserver eq '') && ($offloadoth)) {
9627: my @domains = &Apache::lonnet::current_machine_domains();
9628: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9629: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9630: }
9631: }
1.1340 raeburn 9632: if (($newserver) && ($newserver ne $lonhost)) {
9633: my $numsec = 5;
9634: my $timeout = $numsec * 1000;
9635: my ($newurl,$locknum,%locks,$msg);
9636: if ($env{'request.role.adv'}) {
9637: ($locknum,%locks) = &Apache::lonnet::get_locks();
9638: }
9639: my $disable_submit = 0;
9640: if ($requrl =~ /$LONCAPA::assess_re/) {
9641: $disable_submit = 1;
9642: }
9643: if ($locknum) {
9644: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9645: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9646: join(", ",sort(values(%locks)))."\n";
9647: if (&show_course()) {
9648: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9649: } else {
9650: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9651: }
1.1340 raeburn 9652: } else {
9653: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9654: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9655: }
9656: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9657: $newurl = '/adm/switchserver?otherserver='.$newserver;
9658: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9659: $newurl .= '&role='.$env{'request.role'};
9660: }
9661: if ($env{'request.symb'}) {
9662: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9663: if ($shownsymb =~ m{^/enc/}) {
9664: my $reqdmajor = 2;
9665: my $reqdminor = 11;
9666: my $reqdsubminor = 3;
9667: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9668: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9669: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9670: if (($major eq '' && $minor eq '') ||
9671: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9672: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9673: ($reqdsubminor > $subminor))))) {
9674: undef($shownsymb);
9675: }
1.1210 raeburn 9676: }
1.1340 raeburn 9677: if ($shownsymb) {
9678: &js_escape(\$shownsymb);
9679: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9680: }
1.1340 raeburn 9681: } else {
9682: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9683: &js_escape(\$shownurl);
9684: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9685: }
1.1340 raeburn 9686: }
9687: &js_escape(\$msg);
9688: $result.=<<OFFLOAD
1.1210 raeburn 9689: <meta http-equiv="pragma" content="no-cache" />
9690: <script type="text/javascript">
1.1215 raeburn 9691: // <![CDATA[
1.1210 raeburn 9692: function LC_Offload_Now() {
9693: var dest = "$newurl";
9694: if (dest != '') {
9695: window.location.href="$newurl";
9696: }
9697: }
1.1214 raeburn 9698: \$(document).ready(function () {
9699: window.alert('$msg');
9700: if ($disable_submit) {
1.1210 raeburn 9701: \$(".LC_hwk_submit").prop("disabled", true);
9702: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9703: }
9704: setTimeout('LC_Offload_Now()', $timeout);
9705: });
1.1215 raeburn 9706: // ]]>
1.1210 raeburn 9707: </script>
9708: OFFLOAD
9709: }
9710: }
9711: }
9712: }
9713: }
1.313 albertel 9714: }
1.306 albertel 9715: if (!defined($title)) {
9716: $title = 'The LearningOnline Network with CAPA';
9717: }
1.460 albertel 9718: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9719: if ($title =~ /^LON-CAPA\s+/) {
9720: $result .= '<title> '.$title.'</title>';
9721: } else {
9722: $result .= '<title> LON-CAPA '.$title.'</title>';
9723: }
9724: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9725: if (!$args->{'frameset'}) {
9726: $result .= ' /';
9727: }
9728: $result .= '>'
1.1064 raeburn 9729: .$inhibitprint
1.414 albertel 9730: .$head_extra;
1.1242 raeburn 9731: my $clientmobile;
9732: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9733: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9734: } else {
9735: $clientmobile = $env{'browser.mobile'};
9736: }
9737: if ($clientmobile) {
1.1137 raeburn 9738: $result .= '
1.1435 raeburn 9739: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9740: <meta name="apple-mobile-web-app-capable" content="yes" />';
9741: }
1.1278 raeburn 9742: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9743: return $result.'</head>';
1.306 albertel 9744: }
9745:
9746: =pod
9747:
1.340 albertel 9748: =item * &font_settings()
9749:
9750: Returns neccessary <meta> to set the proper encoding
9751:
1.1160 raeburn 9752: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9753:
9754: =cut
9755:
9756: sub font_settings {
1.1160 raeburn 9757: my ($args) = @_;
1.340 albertel 9758: my $headerstring='';
1.1160 raeburn 9759: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9760: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9761: $headerstring.=
9762: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9763: if (!$args->{'frameset'}) {
9764: $headerstring.= ' /';
9765: }
9766: $headerstring .= '>'."\n";
1.340 albertel 9767: }
9768: return $headerstring;
9769: }
9770:
1.341 albertel 9771: =pod
9772:
1.1064 raeburn 9773: =item * &print_suppression()
9774:
9775: In course context returns css which causes the body to be blank when media="print",
9776: if printout generation is unavailable for the current resource.
9777:
9778: This could be because:
9779:
9780: (a) printstartdate is in the future
9781:
9782: (b) printenddate is in the past
9783:
9784: (c) there is an active exam block with "printout"
9785: functionality blocked
9786:
9787: Users with pav, pfo or evb privileges are exempt.
9788:
9789: Inputs: none
9790:
9791: =cut
9792:
9793:
9794: sub print_suppression {
9795: my $noprint;
9796: if ($env{'request.course.id'}) {
9797: my $scope = $env{'request.course.id'};
9798: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9799: (&Apache::lonnet::allowed('pfo',$scope))) {
9800: return;
9801: }
9802: if ($env{'request.course.sec'} ne '') {
9803: $scope .= "/$env{'request.course.sec'}";
9804: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9805: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9806: return;
1.1064 raeburn 9807: }
9808: }
9809: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9810: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9811: my $clientip = &Apache::lonnet::get_requestor_ip();
9812: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9813: if ($blocked) {
9814: my $checkrole = "cm./$cdom/$cnum";
9815: if ($env{'request.course.sec'} ne '') {
9816: $checkrole .= "/$env{'request.course.sec'}";
9817: }
9818: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9819: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9820: $noprint = 1;
9821: }
9822: }
9823: unless ($noprint) {
9824: my $symb = &Apache::lonnet::symbread();
9825: if ($symb ne '') {
9826: my $navmap = Apache::lonnavmaps::navmap->new();
9827: if (ref($navmap)) {
9828: my $res = $navmap->getBySymb($symb);
9829: if (ref($res)) {
9830: if (!$res->resprintable()) {
9831: $noprint = 1;
9832: }
9833: }
9834: }
9835: }
9836: }
9837: if ($noprint) {
9838: return <<"ENDSTYLE";
9839: <style type="text/css" media="print">
9840: body { display:none }
9841: </style>
9842: ENDSTYLE
9843: }
9844: }
9845: return;
9846: }
9847:
9848: =pod
9849:
1.341 albertel 9850: =item * &xml_begin()
9851:
9852: Returns the needed doctype and <html>
9853:
9854: Inputs: none
9855:
9856: =cut
9857:
9858: sub xml_begin {
1.1168 raeburn 9859: my ($is_frameset) = @_;
1.341 albertel 9860: my $output='';
9861:
9862: if ($env{'browser.mathml'}) {
9863: $output='<?xml version="1.0"?>'
9864: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9865: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9866:
9867: # .'<!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">] >'
9868: .'<!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">'
9869: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9870: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9871: } elsif ($is_frameset) {
9872: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9873: '<html>'."\n";
1.341 albertel 9874: } else {
1.1168 raeburn 9875: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9876: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9877: }
9878: return $output;
9879: }
1.340 albertel 9880:
9881: =pod
9882:
1.306 albertel 9883: =item * &start_page()
9884:
9885: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9886:
1.648 raeburn 9887: Inputs:
9888:
9889: =over 4
9890:
9891: $title - optional title for the page
9892:
9893: $head_extra - optional extra HTML to incude inside the <head>
9894:
9895: $args - additional optional args supported are:
9896:
9897: =over 8
9898:
9899: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9900: arg on
1.814 bisitz 9901: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9902: add_entries -> additional attributes to add to the <body>
9903: domain -> force to color decorate a page for a
1.317 albertel 9904: specific domain
1.648 raeburn 9905: function -> force usage of a specific rolish color
1.317 albertel 9906: scheme
1.648 raeburn 9907: redirect -> see &headtag()
9908: bgcolor -> override the default page bg color
9909: js_ready -> return a string ready for being used in
1.317 albertel 9910: a javascript writeln
1.648 raeburn 9911: html_encode -> return a string ready for being used in
1.320 albertel 9912: a html attribute
1.648 raeburn 9913: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9914: $forcereg arg
1.648 raeburn 9915: frameset -> if true will start with a <frameset>
1.330 albertel 9916: rather than <body>
1.648 raeburn 9917: skip_phases -> hash ref of
1.338 albertel 9918: head -> skip the <html><head> generation
9919: body -> skip all <body> generation
1.648 raeburn 9920: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9921: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9922: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9923: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9924: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9925: to override those values, or add to them, specify the value to
9926: include in the style attribute to include in the div tag by using
9927: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9928: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9929: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9930: group -> includes the current group, if page is for a
1.1274 raeburn 9931: specific group
9932: use_absolute -> for request for external resource or syllabus, this
9933: will contain https://<hostname> if server uses
9934: https (as per hosts.tab), but request is for http
9935: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9936: links_disabled -> Links in primary and secondary menus are disabled
9937: (Can enable them once page has loaded - see lonroles.pm
9938: for an example).
1.1380 raeburn 9939: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9940:
1.648 raeburn 9941: =back
1.460 albertel 9942:
1.648 raeburn 9943: =back
1.562 albertel 9944:
1.306 albertel 9945: =cut
9946:
9947: sub start_page {
1.309 albertel 9948: my ($title,$head_extra,$args) = @_;
1.318 albertel 9949: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9950:
1.315 albertel 9951: $env{'internal.start_page'}++;
1.1359 raeburn 9952: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9953:
1.338 albertel 9954: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9955: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9956: }
1.1316 raeburn 9957:
9958: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9959: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9960: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9961: $args->{'no_primary_menu'} = 1;
9962: }
9963: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9964: $args->{'no_inline_menu'} = 1;
9965: }
9966: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9967: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9968: }
9969: } else {
9970: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9971: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9972: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9973: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9974: $args->{'no_primary_menu'} = 1;
9975: }
9976: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9977: $args->{'no_inline_menu'} = 1;
9978: }
9979: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9980: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9981: }
9982: }
9983: }
1.1316 raeburn 9984: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9985: $env{'course.'.$env{'request.course.id'}.'.domain'},
9986: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9987: } elsif ($env{'request.course.id'}) {
9988: my $expiretime=600;
9989: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9990: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9991: }
9992: my ($deeplinkmenu,$menuref);
9993: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9994: if ($menucoll) {
9995: if (ref($menuref) eq 'HASH') {
9996: %menu = %{$menuref};
9997: }
9998: if ($menu{'top'} eq 'n') {
9999: $args->{'no_primary_menu'} = 1;
10000: }
10001: if ($menu{'inline'} eq 'n') {
10002: unless (&Apache::lonnet::allowed('opa')) {
10003: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10004: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10005: my $crstype = &course_type();
10006: my $now = time;
10007: my $ccrole;
10008: if ($crstype eq 'Community') {
10009: $ccrole = 'co';
10010: } else {
10011: $ccrole = 'cc';
10012: }
10013: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
10014: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
10015: if ((($start) && ($start<0)) ||
10016: (($end) && ($end<$now)) ||
10017: (($start) && ($now<$start))) {
10018: $args->{'no_inline_menu'} = 1;
10019: }
10020: } else {
10021: $args->{'no_inline_menu'} = 1;
10022: }
10023: }
10024: }
10025: }
1.1316 raeburn 10026: }
1.1359 raeburn 10027:
1.1385 raeburn 10028: my $showncrumbs;
1.338 albertel 10029: if (! exists($args->{'skip_phases'}{'body'}) ) {
10030: if ($args->{'frameset'}) {
10031: my $attr_string = &make_attr_string($args->{'force_register'},
10032: $args->{'add_entries'});
10033: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 10034: } else {
10035: $result .=
10036: &bodytag($title,
10037: $args->{'function'}, $args->{'add_entries'},
10038: $args->{'only_body'}, $args->{'domain'},
10039: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 10040: $args->{'bgcolor'}, $args,
1.1385 raeburn 10041: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
10042: \%menu,\$showncrumbs);
1.831 bisitz 10043: }
1.330 albertel 10044: }
1.338 albertel 10045:
1.315 albertel 10046: if ($args->{'js_ready'}) {
1.713 kaisler 10047: $result = &js_ready($result);
1.315 albertel 10048: }
1.320 albertel 10049: if ($args->{'html_encode'}) {
1.713 kaisler 10050: $result = &html_encode($result);
10051: }
10052:
1.813 bisitz 10053: # Preparation for new and consistent functionlist at top of screen
10054: # if ($args->{'functionlist'}) {
10055: # $result .= &build_functionlist();
10056: #}
10057:
1.964 droeschl 10058: # Don't add anything more if only_body wanted or in const space
10059: return $result if $args->{'only_body'}
10060: || $env{'request.state'} eq 'construct';
1.813 bisitz 10061:
10062: #Breadcrumbs
1.758 kaisler 10063: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10064: unless ($showncrumbs) {
1.758 kaisler 10065: &Apache::lonhtmlcommon::clear_breadcrumbs();
10066: #if any br links exists, add them to the breadcrumbs
10067: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10068: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10069: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10070: }
10071: }
1.1096 raeburn 10072: # if @advtools array contains items add then to the breadcrumbs
10073: if (@advtools > 0) {
10074: &Apache::lonmenu::advtools_crumbs(@advtools);
10075: }
1.1272 raeburn 10076: my $menulink;
10077: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10078: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10079: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10080: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10081: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10082: (!$env{'request.role.adv'}))) {
10083: $menulink = 0;
10084: } else {
10085: undef($menulink);
10086: }
1.1385 raeburn 10087: my $linkprotout;
10088: if ($env{'request.deeplink.login'}) {
10089: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10090: if ($linkprotout) {
10091: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10092: }
10093: }
1.758 kaisler 10094: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10095: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10096: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10097: '',$menulink,'',
10098: $args->{'bread_crumbs_style'});
1.1237 raeburn 10099: } else {
1.1437 raeburn 10100: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10101: $args->{'bread_crumbs_style'});
1.758 kaisler 10102: }
1.1385 raeburn 10103: }
1.320 albertel 10104: }
1.315 albertel 10105: return $result;
1.306 albertel 10106: }
10107:
10108: sub end_page {
1.315 albertel 10109: my ($args) = @_;
10110: $env{'internal.end_page'}++;
1.330 albertel 10111: my $result;
1.335 albertel 10112: if ($args->{'discussion'}) {
10113: my ($target,$parser);
10114: if (ref($args->{'discussion'})) {
10115: ($target,$parser) =($args->{'discussion'}{'target'},
10116: $args->{'discussion'}{'parser'});
10117: }
10118: $result .= &Apache::lonxml::xmlend($target,$parser);
10119: }
1.330 albertel 10120: if ($args->{'frameset'}) {
10121: $result .= '</frameset>';
10122: } else {
1.635 raeburn 10123: $result .= &endbodytag($args);
1.330 albertel 10124: }
1.1080 raeburn 10125: unless ($args->{'notbody'}) {
10126: $result .= "\n</html>";
10127: }
1.330 albertel 10128:
1.315 albertel 10129: if ($args->{'js_ready'}) {
1.317 albertel 10130: $result = &js_ready($result);
1.315 albertel 10131: }
1.335 albertel 10132:
1.320 albertel 10133: if ($args->{'html_encode'}) {
10134: $result = &html_encode($result);
10135: }
1.335 albertel 10136:
1.315 albertel 10137: return $result;
10138: }
10139:
1.1359 raeburn 10140: sub menucoll_in_effect {
10141: my ($menucoll,$deeplinkmenu,%menu);
10142: if ($env{'request.course.id'}) {
10143: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10144: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10145: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10146: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10147: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10148: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10149: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10150: my $navmap = Apache::lonnavmaps::navmap->new();
10151: if (ref($navmap)) {
10152: $deeplink = $navmap->get_mapparam(undef,
10153: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10154: '0.deeplink');
1.1370 raeburn 10155: } else {
10156: $check_login_symb = 1;
1.1362 raeburn 10157: }
10158: } else {
1.1370 raeburn 10159: my $symb = &Apache::lonnet::symbread();
10160: if ($symb) {
10161: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10162: } else {
10163: $check_login_symb = 1;
10164: }
1.1362 raeburn 10165: }
10166: } else {
1.1370 raeburn 10167: $check_login_symb = 1;
10168: }
10169: if ($check_login_symb) {
1.1362 raeburn 10170: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10171: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10172: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10173: my $navmap = Apache::lonnavmaps::navmap->new();
10174: if (ref($navmap)) {
10175: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10176: }
10177: } else {
10178: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10179: }
10180: }
1.1359 raeburn 10181: if ($deeplink ne '') {
1.1378 raeburn 10182: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10183: if ($display =~ /^\d+$/) {
10184: $deeplinkmenu = 1;
10185: $menucoll = $display;
10186: }
10187: }
10188: }
10189: if ($menucoll) {
10190: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10191: }
10192: }
10193: return ($menucoll,$deeplinkmenu,\%menu);
10194: }
10195:
1.1362 raeburn 10196: sub deeplink_login_symb {
10197: my ($cnum,$cdom) = @_;
10198: my $login_symb;
10199: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10200: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10201: }
10202: return $login_symb;
10203: }
10204:
10205: sub symb_from_tinyurl {
10206: my ($url,$cnum,$cdom) = @_;
10207: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10208: my $key = $1;
10209: my ($tinyurl,$login);
10210: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10211: if (defined($cached)) {
10212: $tinyurl = $result;
10213: } else {
10214: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10215: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10216: if ($currtiny{$key} ne '') {
10217: $tinyurl = $currtiny{$key};
10218: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10219: }
1.1364 raeburn 10220: }
10221: if ($tinyurl ne '') {
10222: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10223: if (wantarray) {
10224: return ($cnumreq,$symb);
10225: } elsif ($cnumreq eq $cnum) {
10226: return $symb;
1.1362 raeburn 10227: }
10228: }
10229: }
1.1364 raeburn 10230: if (wantarray) {
10231: return ();
10232: } else {
10233: return;
10234: }
1.1362 raeburn 10235: }
10236:
1.1405 raeburn 10237: sub usable_exttools {
10238: my %tooltypes;
10239: if ($env{'request.course.id'}) {
10240: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10241: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10242: %tooltypes = (
10243: crs => 1,
10244: dom => 1,
10245: );
10246: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10247: $tooltypes{'crs'} = 1;
10248: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10249: $tooltypes{'dom'} = 1;
10250: }
10251: } else {
10252: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10253: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10254: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10255: if ($crstype eq '') {
10256: $crstype = 'course';
10257: }
10258: if ($crstype eq 'course') {
10259: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10260: $crstype = 'official';
10261: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10262: $crstype = 'textbook';
10263: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10264: $crstype = 'lti';
10265: } else {
10266: $crstype = 'unofficial';
10267: }
10268: }
10269: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10270: if ($domdefaults{$crstype.'domexttool'}) {
10271: $tooltypes{'dom'} = 1;
10272: }
10273: if ($domdefaults{$crstype.'exttool'}) {
10274: $tooltypes{'crs'} = 1;
10275: }
10276: }
10277: }
10278: return %tooltypes;
10279: }
10280:
1.1034 www 10281: sub wishlist_window {
10282: return(<<'ENDWISHLIST');
1.1046 raeburn 10283: <script type="text/javascript">
1.1034 www 10284: // <![CDATA[
10285: // <!-- BEGIN LON-CAPA Internal
10286: function set_wishlistlink(title, path) {
10287: if (!title) {
10288: title = document.title;
10289: title = title.replace(/^LON-CAPA /,'');
10290: }
1.1175 raeburn 10291: title = encodeURIComponent(title);
1.1203 raeburn 10292: title = title.replace("'","\\\'");
1.1034 www 10293: if (!path) {
10294: path = location.pathname;
10295: }
1.1175 raeburn 10296: path = encodeURIComponent(path);
1.1203 raeburn 10297: path = path.replace("'","\\\'");
1.1034 www 10298: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10299: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10300: }
10301: // END LON-CAPA Internal -->
10302: // ]]>
10303: </script>
10304: ENDWISHLIST
10305: }
10306:
1.1030 www 10307: sub modal_window {
10308: return(<<'ENDMODAL');
1.1046 raeburn 10309: <script type="text/javascript">
1.1030 www 10310: // <![CDATA[
10311: // <!-- BEGIN LON-CAPA Internal
10312: var modalWindow = {
10313: parent:"body",
10314: windowId:null,
10315: content:null,
10316: width:null,
10317: height:null,
10318: close:function()
10319: {
10320: $(".LCmodal-window").remove();
10321: $(".LCmodal-overlay").remove();
10322: },
10323: open:function()
10324: {
10325: var modal = "";
10326: modal += "<div class=\"LCmodal-overlay\"></div>";
10327: 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;\">";
10328: modal += this.content;
10329: modal += "</div>";
10330:
10331: $(this.parent).append(modal);
10332:
10333: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10334: $(".LCclose-window").click(function(){modalWindow.close();});
10335: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10336: }
10337: };
1.1140 raeburn 10338: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10339: {
1.1266 raeburn 10340: source = source.replace(/'/g,"'");
1.1030 www 10341: modalWindow.windowId = "myModal";
10342: modalWindow.width = width;
10343: modalWindow.height = height;
1.1196 raeburn 10344: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10345: modalWindow.open();
1.1208 raeburn 10346: };
1.1030 www 10347: // END LON-CAPA Internal -->
10348: // ]]>
10349: </script>
10350: ENDMODAL
10351: }
10352:
10353: sub modal_link {
1.1140 raeburn 10354: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10355: unless ($width) { $width=480; }
10356: unless ($height) { $height=400; }
1.1031 www 10357: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10358: unless ($transparency) { $transparency='true'; }
10359:
1.1074 raeburn 10360: my $target_attr;
10361: if (defined($target)) {
10362: $target_attr = 'target="'.$target.'"';
10363: }
10364: return <<"ENDLINK";
1.1336 raeburn 10365: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10366: ENDLINK
1.1030 www 10367: }
10368:
1.1032 www 10369: sub modal_adhoc_script {
1.1365 raeburn 10370: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10371: my $mathjax;
10372: if ($possmathjax) {
10373: $mathjax = <<'ENDJAX';
10374: if (typeof MathJax == 'object') {
10375: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10376: }
10377: ENDJAX
10378: }
1.1032 www 10379: return (<<ENDADHOC);
1.1046 raeburn 10380: <script type="text/javascript">
1.1032 www 10381: // <![CDATA[
10382: var $funcname = function()
10383: {
10384: modalWindow.windowId = "myModal";
10385: modalWindow.width = $width;
10386: modalWindow.height = $height;
10387: modalWindow.content = '$content';
10388: modalWindow.open();
1.1365 raeburn 10389: $mathjax
1.1032 www 10390: };
10391: // ]]>
10392: </script>
10393: ENDADHOC
10394: }
10395:
1.1041 www 10396: sub modal_adhoc_inner {
1.1365 raeburn 10397: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10398: my $innerwidth=$width-20;
10399: $content=&js_ready(
1.1140 raeburn 10400: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10401: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10402: $content.
1.1041 www 10403: &end_scrollbox().
1.1140 raeburn 10404: &end_page()
1.1041 www 10405: );
1.1365 raeburn 10406: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10407: }
10408:
10409: sub modal_adhoc_window {
1.1365 raeburn 10410: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10411: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10412: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10413: }
10414:
10415: sub modal_adhoc_launch {
10416: my ($funcname,$width,$height,$content)=@_;
10417: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10418: <script type="text/javascript">
10419: // <![CDATA[
10420: $funcname();
10421: // ]]>
10422: </script>
10423: ENDLAUNCH
10424: }
10425:
10426: sub modal_adhoc_close {
10427: return (<<ENDCLOSE);
10428: <script type="text/javascript">
10429: // <![CDATA[
10430: modalWindow.close();
10431: // ]]>
10432: </script>
10433: ENDCLOSE
10434: }
10435:
1.1038 www 10436: sub togglebox_script {
10437: return(<<ENDTOGGLE);
10438: <script type="text/javascript">
10439: // <![CDATA[
10440: function LCtoggleDisplay(id,hidetext,showtext) {
10441: link = document.getElementById(id + "link").childNodes[0];
10442: with (document.getElementById(id).style) {
10443: if (display == "none" ) {
10444: display = "inline";
10445: link.nodeValue = hidetext;
10446: } else {
10447: display = "none";
10448: link.nodeValue = showtext;
10449: }
10450: }
10451: }
10452: // ]]>
10453: </script>
10454: ENDTOGGLE
10455: }
10456:
1.1039 www 10457: sub start_togglebox {
10458: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10459: unless ($heading) { $heading=''; } else { $heading.=' '; }
10460: unless ($showtext) { $showtext=&mt('show'); }
10461: unless ($hidetext) { $hidetext=&mt('hide'); }
10462: unless ($headerbg) { $headerbg='#FFFFFF'; }
10463: return &start_data_table().
10464: &start_data_table_header_row().
10465: '<td bgcolor="'.$headerbg.'">'.$heading.
10466: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10467: $showtext.'\')">'.$showtext.'</a>]</td>'.
10468: &end_data_table_header_row().
10469: '<tr id="'.$id.'" style="display:none""><td>';
10470: }
10471:
10472: sub end_togglebox {
10473: return '</td></tr>'.&end_data_table();
10474: }
10475:
1.1041 www 10476: sub LCprogressbar_script {
1.1302 raeburn 10477: my ($id,$number_to_do)=@_;
10478: if ($number_to_do) {
10479: return(<<ENDPROGRESS);
1.1041 www 10480: <script type="text/javascript">
10481: // <![CDATA[
1.1045 www 10482: \$('#progressbar$id').progressbar({
1.1041 www 10483: value: 0,
10484: change: function(event, ui) {
10485: var newVal = \$(this).progressbar('option', 'value');
10486: \$('.pblabel', this).text(LCprogressTxt);
10487: }
10488: });
10489: // ]]>
10490: </script>
10491: ENDPROGRESS
1.1302 raeburn 10492: } else {
10493: return(<<ENDPROGRESS);
10494: <script type="text/javascript">
10495: // <![CDATA[
10496: \$('#progressbar$id').progressbar({
10497: value: false,
10498: create: function(event, ui) {
10499: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10500: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10501: }
10502: });
10503: // ]]>
10504: </script>
10505: ENDPROGRESS
10506: }
1.1041 www 10507: }
10508:
10509: sub LCprogressbarUpdate_script {
10510: return(<<ENDPROGRESSUPDATE);
10511: <style type="text/css">
10512: .ui-progressbar { position:relative; }
1.1302 raeburn 10513: .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 10514: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10515: </style>
10516: <script type="text/javascript">
10517: // <![CDATA[
1.1045 www 10518: var LCprogressTxt='---';
10519:
1.1302 raeburn 10520: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10521: LCprogressTxt=progresstext;
1.1302 raeburn 10522: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10523: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10524: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10525: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10526: } else {
10527: \$('#progressbar'+id).progressbar('value',percent);
10528: }
1.1041 www 10529: }
10530: // ]]>
10531: </script>
10532: ENDPROGRESSUPDATE
10533: }
10534:
1.1042 www 10535: my $LClastpercent;
1.1045 www 10536: my $LCidcnt;
10537: my $LCcurrentid;
1.1042 www 10538:
1.1041 www 10539: sub LCprogressbar {
1.1302 raeburn 10540: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10541: $LClastpercent=0;
1.1045 www 10542: $LCidcnt++;
10543: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10544: my ($starting,$content);
10545: if ($number_to_do) {
10546: $starting=&mt('Starting');
10547: $content=(<<ENDPROGBAR);
10548: $preamble
1.1045 www 10549: <div id="progressbar$LCcurrentid">
1.1041 www 10550: <span class="pblabel">$starting</span>
10551: </div>
10552: ENDPROGBAR
1.1302 raeburn 10553: } else {
10554: $starting=&mt('Loading...');
10555: $LClastpercent='false';
10556: $content=(<<ENDPROGBAR);
10557: $preamble
10558: <div id="progressbar$LCcurrentid">
10559: <div class="progress-label">$starting</div>
10560: </div>
10561: ENDPROGBAR
10562: }
10563: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10564: }
10565:
10566: sub LCprogressbarUpdate {
1.1302 raeburn 10567: my ($r,$val,$text,$number_to_do)=@_;
10568: if ($number_to_do) {
10569: unless ($val) {
10570: if ($LClastpercent) {
10571: $val=$LClastpercent;
10572: } else {
10573: $val=0;
10574: }
10575: }
10576: if ($val<0) { $val=0; }
10577: if ($val>100) { $val=0; }
10578: $LClastpercent=$val;
10579: unless ($text) { $text=$val.'%'; }
10580: } else {
10581: $val = 'false';
1.1042 www 10582: }
1.1041 www 10583: $text=&js_ready($text);
1.1044 www 10584: &r_print($r,<<ENDUPDATE);
1.1041 www 10585: <script type="text/javascript">
10586: // <![CDATA[
1.1302 raeburn 10587: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10588: // ]]>
10589: </script>
10590: ENDUPDATE
1.1035 www 10591: }
10592:
1.1042 www 10593: sub LCprogressbarClose {
10594: my ($r)=@_;
10595: $LClastpercent=0;
1.1044 www 10596: &r_print($r,<<ENDCLOSE);
1.1042 www 10597: <script type="text/javascript">
10598: // <![CDATA[
1.1045 www 10599: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10600: // ]]>
10601: </script>
10602: ENDCLOSE
1.1044 www 10603: }
10604:
10605: sub r_print {
10606: my ($r,$to_print)=@_;
10607: if ($r) {
10608: $r->print($to_print);
10609: $r->rflush();
10610: } else {
10611: print($to_print);
10612: }
1.1042 www 10613: }
10614:
1.320 albertel 10615: sub html_encode {
10616: my ($result) = @_;
10617:
1.322 albertel 10618: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10619:
10620: return $result;
10621: }
1.1044 www 10622:
1.317 albertel 10623: sub js_ready {
10624: my ($result) = @_;
10625:
1.323 albertel 10626: $result =~ s/[\n\r]/ /xmsg;
10627: $result =~ s/\\/\\\\/xmsg;
10628: $result =~ s/'/\\'/xmsg;
1.372 albertel 10629: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10630:
10631: return $result;
10632: }
10633:
1.315 albertel 10634: sub validate_page {
10635: if ( exists($env{'internal.start_page'})
1.316 albertel 10636: && $env{'internal.start_page'} > 1) {
10637: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10638: $env{'internal.start_page'}.' '.
1.316 albertel 10639: $ENV{'request.filename'});
1.315 albertel 10640: }
10641: if ( exists($env{'internal.end_page'})
1.316 albertel 10642: && $env{'internal.end_page'} > 1) {
10643: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10644: $env{'internal.end_page'}.' '.
1.316 albertel 10645: $env{'request.filename'});
1.315 albertel 10646: }
10647: if ( exists($env{'internal.start_page'})
10648: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10649: &Apache::lonnet::logthis('start_page called without end_page '.
10650: $env{'request.filename'});
1.315 albertel 10651: }
10652: if ( ! exists($env{'internal.start_page'})
10653: && exists($env{'internal.end_page'})) {
1.316 albertel 10654: &Apache::lonnet::logthis('end_page called without start_page'.
10655: $env{'request.filename'});
1.315 albertel 10656: }
1.306 albertel 10657: }
1.315 albertel 10658:
1.996 www 10659:
10660: sub start_scrollbox {
1.1140 raeburn 10661: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10662: unless ($outerwidth) { $outerwidth='520px'; }
10663: unless ($width) { $width='500px'; }
10664: unless ($height) { $height='200px'; }
1.1075 raeburn 10665: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10666: if ($id ne '') {
1.1140 raeburn 10667: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10668: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10669: }
1.1075 raeburn 10670: if ($bgcolor ne '') {
10671: $tdcol = "background-color: $bgcolor;";
10672: }
1.1137 raeburn 10673: my $nicescroll_js;
10674: if ($env{'browser.mobile'}) {
1.1140 raeburn 10675: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10676: }
10677: return <<"END";
10678: $nicescroll_js
10679:
10680: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10681: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10682: END
10683: }
10684:
10685: sub end_scrollbox {
10686: return '</div></td></tr></table>';
10687: }
10688:
10689: sub nicescroll_javascript {
10690: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10691: my %options;
10692: if (ref($cursor) eq 'HASH') {
10693: %options = %{$cursor};
10694: }
10695: unless ($options{'railalign'} =~ /^left|right$/) {
10696: $options{'railalign'} = 'left';
10697: }
10698: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10699: my $function = &get_users_function();
10700: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10701: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10702: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10703: }
1.1140 raeburn 10704: }
10705: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10706: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10707: $options{'cursoropacity'}='1.0';
10708: }
1.1140 raeburn 10709: } else {
10710: $options{'cursoropacity'}='1.0';
10711: }
10712: if ($options{'cursorfixedheight'} eq 'none') {
10713: delete($options{'cursorfixedheight'});
10714: } else {
10715: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10716: }
10717: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10718: delete($options{'railoffset'});
10719: }
10720: my @niceoptions;
10721: while (my($key,$value) = each(%options)) {
10722: if ($value =~ /^\{.+\}$/) {
10723: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10724: } else {
1.1140 raeburn 10725: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10726: }
1.1140 raeburn 10727: }
10728: my $nicescroll_js = '
1.1137 raeburn 10729: $(document).ready(
1.1140 raeburn 10730: function() {
10731: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10732: }
1.1137 raeburn 10733: );
10734: ';
1.1140 raeburn 10735: if ($framecheck) {
10736: $nicescroll_js .= '
10737: function expand_div(caller) {
10738: if (top === self) {
10739: document.getElementById("'.$id.'").style.width = "auto";
10740: document.getElementById("'.$id.'").style.height = "auto";
10741: } else {
10742: try {
10743: if (parent.frames) {
10744: if (parent.frames.length > 1) {
10745: var framesrc = parent.frames[1].location.href;
10746: var currsrc = framesrc.replace(/\#.*$/,"");
10747: if ((caller == "search") || (currsrc == "'.$location.'")) {
10748: document.getElementById("'.$id.'").style.width = "auto";
10749: document.getElementById("'.$id.'").style.height = "auto";
10750: }
10751: }
10752: }
10753: } catch (e) {
10754: return;
10755: }
1.1137 raeburn 10756: }
1.1140 raeburn 10757: return;
1.996 www 10758: }
1.1140 raeburn 10759: ';
10760: }
10761: if ($needjsready) {
10762: $nicescroll_js = '
10763: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10764: } else {
10765: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10766: }
10767: return $nicescroll_js;
1.996 www 10768: }
10769:
1.318 albertel 10770: sub simple_error_page {
1.1150 bisitz 10771: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10772: my %displayargs;
1.1151 raeburn 10773: if (ref($args) eq 'HASH') {
10774: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10775: if ($args->{'only_body'}) {
10776: $displayargs{'only_body'} = 1;
10777: }
10778: if ($args->{'no_nav_bar'}) {
10779: $displayargs{'no_nav_bar'} = 1;
10780: }
1.1151 raeburn 10781: } else {
10782: $msg = &mt($msg);
10783: }
1.1150 bisitz 10784:
1.318 albertel 10785: my $page =
1.1304 raeburn 10786: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10787: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10788: &Apache::loncommon::end_page();
10789: if (ref($r)) {
10790: $r->print($page);
1.327 albertel 10791: return;
1.318 albertel 10792: }
10793: return $page;
10794: }
1.347 albertel 10795:
10796: {
1.610 albertel 10797: my @row_count;
1.961 onken 10798:
10799: sub start_data_table_count {
10800: unshift(@row_count, 0);
10801: return;
10802: }
10803:
10804: sub end_data_table_count {
10805: shift(@row_count);
10806: return;
10807: }
10808:
1.347 albertel 10809: sub start_data_table {
1.1018 raeburn 10810: my ($add_class,$id) = @_;
1.422 albertel 10811: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10812: my $table_id;
10813: if (defined($id)) {
10814: $table_id = ' id="'.$id.'"';
10815: }
1.961 onken 10816: &start_data_table_count();
1.1018 raeburn 10817: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10818: }
10819:
10820: sub end_data_table {
1.961 onken 10821: &end_data_table_count();
1.389 albertel 10822: return '</table>'."\n";;
1.347 albertel 10823: }
10824:
10825: sub start_data_table_row {
1.974 wenzelju 10826: my ($add_class, $id) = @_;
1.610 albertel 10827: $row_count[0]++;
10828: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10829: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10830: $id = (' id="'.$id.'"') unless ($id eq '');
10831: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10832: }
1.471 banghart 10833:
10834: sub continue_data_table_row {
1.974 wenzelju 10835: my ($add_class, $id) = @_;
1.610 albertel 10836: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10837: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10838: $id = (' id="'.$id.'"') unless ($id eq '');
10839: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10840: }
1.347 albertel 10841:
10842: sub end_data_table_row {
1.389 albertel 10843: return '</tr>'."\n";;
1.347 albertel 10844: }
1.367 www 10845:
1.421 albertel 10846: sub start_data_table_empty_row {
1.707 bisitz 10847: # $row_count[0]++;
1.421 albertel 10848: return '<tr class="LC_empty_row" >'."\n";;
10849: }
10850:
10851: sub end_data_table_empty_row {
10852: return '</tr>'."\n";;
10853: }
10854:
1.367 www 10855: sub start_data_table_header_row {
1.389 albertel 10856: return '<tr class="LC_header_row">'."\n";;
1.367 www 10857: }
10858:
10859: sub end_data_table_header_row {
1.389 albertel 10860: return '</tr>'."\n";;
1.367 www 10861: }
1.890 droeschl 10862:
10863: sub data_table_caption {
10864: my $caption = shift;
10865: return "<caption class=\"LC_caption\">$caption</caption>";
10866: }
1.347 albertel 10867: }
10868:
1.548 albertel 10869: =pod
10870:
10871: =item * &inhibit_menu_check($arg)
10872:
10873: Checks for a inhibitmenu state and generates output to preserve it
10874:
10875: Inputs: $arg - can be any of
10876: - undef - in which case the return value is a string
10877: to add into arguments list of a uri
10878: - 'input' - in which case the return value is a HTML
10879: <form> <input> field of type hidden to
10880: preserve the value
10881: - a url - in which case the return value is the url with
10882: the neccesary cgi args added to preserve the
10883: inhibitmenu state
10884: - a ref to a url - no return value, but the string is
10885: updated to include the neccessary cgi
10886: args to preserve the inhibitmenu state
10887:
10888: =cut
10889:
10890: sub inhibit_menu_check {
10891: my ($arg) = @_;
10892: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10893: if ($arg eq 'input') {
10894: if ($env{'form.inhibitmenu'}) {
10895: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10896: } else {
10897: return
10898: }
10899: }
10900: if ($env{'form.inhibitmenu'}) {
10901: if (ref($arg)) {
10902: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10903: } elsif ($arg eq '') {
10904: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10905: } else {
10906: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10907: }
10908: }
10909: if (!ref($arg)) {
10910: return $arg;
10911: }
10912: }
10913:
1.251 albertel 10914: ###############################################
1.182 matthew 10915:
10916: =pod
10917:
1.549 albertel 10918: =back
10919:
10920: =head1 User Information Routines
10921:
10922: =over 4
10923:
1.405 albertel 10924: =item * &get_users_function()
1.182 matthew 10925:
10926: Used by &bodytag to determine the current users primary role.
10927: Returns either 'student','coordinator','admin', or 'author'.
10928:
10929: =cut
10930:
10931: ###############################################
10932: sub get_users_function {
1.815 tempelho 10933: my $function = 'norole';
1.818 tempelho 10934: if ($env{'request.role'}=~/^(st)/) {
10935: $function='student';
10936: }
1.907 raeburn 10937: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10938: $function='coordinator';
10939: }
1.258 albertel 10940: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10941: $function='admin';
10942: }
1.826 bisitz 10943: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10944: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10945: $function='author';
10946: }
10947: return $function;
1.54 www 10948: }
1.99 www 10949:
10950: ###############################################
10951:
1.233 raeburn 10952: =pod
10953:
1.821 raeburn 10954: =item * &show_course()
10955:
10956: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10957: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10958:
10959: Inputs:
10960: None
10961:
10962: Outputs:
10963: Scalar: 1 if 'Course' to be used, 0 otherwise.
10964:
10965: =cut
10966:
10967: ###############################################
10968: sub show_course {
1.1408 raeburn 10969: my ($udom,$uname) = @_;
10970: if (($udom ne '') && ($uname ne '')) {
10971: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10972: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10973: return 0;
10974: } else {
10975: return 1;
10976: }
10977: }
10978: }
1.821 raeburn 10979: my $course = !$env{'user.adv'};
10980: if (!$env{'user.adv'}) {
10981: foreach my $env (keys(%env)) {
10982: next if ($env !~ m/^user\.priv\./);
10983: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10984: $course = 0;
10985: last;
10986: }
10987: }
10988: }
10989: return $course;
10990: }
10991:
10992: ###############################################
10993:
10994: =pod
10995:
1.542 raeburn 10996: =item * &check_user_status()
1.274 raeburn 10997:
10998: Determines current status of supplied role for a
10999: specific user. Roles can be active, previous or future.
11000:
11001: Inputs:
11002: user's domain, user's username, course's domain,
1.375 raeburn 11003: course's number, optional section ID.
1.274 raeburn 11004:
11005: Outputs:
11006: role status: active, previous or future.
11007:
11008: =cut
11009:
11010: sub check_user_status {
1.412 raeburn 11011: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 11012: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 11013: my @uroles = keys(%userinfo);
1.274 raeburn 11014: my $srchstr;
11015: my $active_chk = 'none';
1.412 raeburn 11016: my $now = time;
1.274 raeburn 11017: if (@uroles > 0) {
1.908 raeburn 11018: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 11019: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
11020: } else {
1.412 raeburn 11021: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
11022: }
11023: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 11024: my $role_end = 0;
11025: my $role_start = 0;
11026: $active_chk = 'active';
1.412 raeburn 11027: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
11028: $role_end = $1;
11029: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
11030: $role_start = $1;
1.274 raeburn 11031: }
11032: }
11033: if ($role_start > 0) {
1.412 raeburn 11034: if ($now < $role_start) {
1.274 raeburn 11035: $active_chk = 'future';
11036: }
11037: }
11038: if ($role_end > 0) {
1.412 raeburn 11039: if ($now > $role_end) {
1.274 raeburn 11040: $active_chk = 'previous';
11041: }
11042: }
11043: }
11044: }
11045: return $active_chk;
11046: }
11047:
11048: ###############################################
11049:
11050: =pod
11051:
1.405 albertel 11052: =item * &get_sections()
1.233 raeburn 11053:
11054: Determines all the sections for a course including
11055: sections with students and sections containing other roles.
1.419 raeburn 11056: Incoming parameters:
11057:
11058: 1. domain
11059: 2. course number
11060: 3. reference to array containing roles for which sections should
11061: be gathered (optional).
11062: 4. reference to array containing status types for which sections
11063: should be gathered (optional).
11064:
11065: If the third argument is undefined, sections are gathered for any role.
11066: If the fourth argument is undefined, sections are gathered for any status.
11067: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11068:
1.374 raeburn 11069: Returns section hash (keys are section IDs, values are
11070: number of users in each section), subject to the
1.419 raeburn 11071: optional roles filter, optional status filter
1.233 raeburn 11072:
11073: =cut
11074:
11075: ###############################################
11076: sub get_sections {
1.419 raeburn 11077: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11078: if (!defined($cdom) || !defined($cnum)) {
11079: my $cid = $env{'request.course.id'};
11080:
11081: return if (!defined($cid));
11082:
11083: $cdom = $env{'course.'.$cid.'.domain'};
11084: $cnum = $env{'course.'.$cid.'.num'};
11085: }
11086:
11087: my %sectioncount;
1.419 raeburn 11088: my $now = time;
1.240 albertel 11089:
1.1118 raeburn 11090: my $check_students = 1;
11091: my $only_students = 0;
11092: if (ref($possible_roles) eq 'ARRAY') {
11093: if (grep(/^st$/,@{$possible_roles})) {
11094: if (@{$possible_roles} == 1) {
11095: $only_students = 1;
11096: }
11097: } else {
11098: $check_students = 0;
11099: }
11100: }
11101:
11102: if ($check_students) {
1.276 albertel 11103: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11104: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11105: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11106: my $start_index = &Apache::loncoursedata::CL_START();
11107: my $end_index = &Apache::loncoursedata::CL_END();
11108: my $status;
1.366 albertel 11109: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11110: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11111: $data->[$status_index],
11112: $data->[$start_index],
11113: $data->[$end_index]);
11114: if ($stu_status eq 'Active') {
11115: $status = 'active';
11116: } elsif ($end < $now) {
11117: $status = 'previous';
11118: } elsif ($start > $now) {
11119: $status = 'future';
11120: }
11121: if ($section ne '-1' && $section !~ /^\s*$/) {
11122: if ((!defined($possible_status)) || (($status ne '') &&
11123: (grep/^\Q$status\E$/,@{$possible_status}))) {
11124: $sectioncount{$section}++;
11125: }
1.240 albertel 11126: }
11127: }
11128: }
1.1118 raeburn 11129: if ($only_students) {
11130: return %sectioncount;
11131: }
1.240 albertel 11132: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11133: foreach my $user (sort(keys(%courseroles))) {
11134: if ($user !~ /^(\w{2})/) { next; }
11135: my ($role) = ($user =~ /^(\w{2})/);
11136: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11137: my ($section,$status);
1.240 albertel 11138: if ($role eq 'cr' &&
11139: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11140: $section=$1;
11141: }
11142: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11143: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11144: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11145: if ($end == -1 && $start == -1) {
11146: next; #deleted role
11147: }
11148: if (!defined($possible_status)) {
11149: $sectioncount{$section}++;
11150: } else {
11151: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11152: $status = 'active';
11153: } elsif ($end < $now) {
11154: $status = 'future';
11155: } elsif ($start > $now) {
11156: $status = 'previous';
11157: }
11158: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11159: $sectioncount{$section}++;
11160: }
11161: }
1.233 raeburn 11162: }
1.366 albertel 11163: return %sectioncount;
1.233 raeburn 11164: }
11165:
1.274 raeburn 11166: ###############################################
1.294 raeburn 11167:
11168: =pod
1.405 albertel 11169:
11170: =item * &get_course_users()
11171:
1.275 raeburn 11172: Retrieves usernames:domains for users in the specified course
11173: with specific role(s), and access status.
11174:
11175: Incoming parameters:
1.277 albertel 11176: 1. course domain
11177: 2. course number
11178: 3. access status: users must have - either active,
1.275 raeburn 11179: previous, future, or all.
1.277 albertel 11180: 4. reference to array of permissible roles
1.288 raeburn 11181: 5. reference to array of section restrictions (optional)
11182: 6. reference to results object (hash of hashes).
11183: 7. reference to optional userdata hash
1.609 raeburn 11184: 8. reference to optional statushash
1.630 raeburn 11185: 9. flag if privileged users (except those set to unhide in
11186: course settings) should be excluded
1.609 raeburn 11187: Keys of top level results hash are roles.
1.275 raeburn 11188: Keys of inner hashes are username:domain, with
11189: values set to access type.
1.288 raeburn 11190: Optional userdata hash returns an array with arguments in the
11191: same order as loncoursedata::get_classlist() for student data.
11192:
1.609 raeburn 11193: Optional statushash returns
11194:
1.288 raeburn 11195: Entries for end, start, section and status are blank because
11196: of the possibility of multiple values for non-student roles.
11197:
1.275 raeburn 11198: =cut
1.405 albertel 11199:
1.275 raeburn 11200: ###############################################
1.405 albertel 11201:
1.275 raeburn 11202: sub get_course_users {
1.630 raeburn 11203: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11204: my %idx = ();
1.419 raeburn 11205: my %seclists;
1.288 raeburn 11206:
11207: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11208: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11209: $idx{end} = &Apache::loncoursedata::CL_END();
11210: $idx{start} = &Apache::loncoursedata::CL_START();
11211: $idx{id} = &Apache::loncoursedata::CL_ID();
11212: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11213: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11214: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11215:
1.290 albertel 11216: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11217: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11218: my $now = time;
1.277 albertel 11219: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11220: my $match = 0;
1.412 raeburn 11221: my $secmatch = 0;
1.419 raeburn 11222: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11223: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11224: if ($section eq '') {
11225: $section = 'none';
11226: }
1.291 albertel 11227: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11228: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11229: $secmatch = 1;
11230: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11231: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11232: $secmatch = 1;
11233: }
11234: } else {
1.419 raeburn 11235: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11236: $secmatch = 1;
11237: }
1.290 albertel 11238: }
1.412 raeburn 11239: if (!$secmatch) {
11240: next;
11241: }
1.419 raeburn 11242: }
1.275 raeburn 11243: if (defined($$types{'active'})) {
1.288 raeburn 11244: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11245: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11246: $match = 1;
1.275 raeburn 11247: }
11248: }
11249: if (defined($$types{'previous'})) {
1.609 raeburn 11250: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11251: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11252: $match = 1;
1.275 raeburn 11253: }
11254: }
11255: if (defined($$types{'future'})) {
1.609 raeburn 11256: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11257: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11258: $match = 1;
1.275 raeburn 11259: }
11260: }
1.609 raeburn 11261: if ($match) {
11262: push(@{$seclists{$student}},$section);
11263: if (ref($userdata) eq 'HASH') {
11264: $$userdata{$student} = $$classlist{$student};
11265: }
11266: if (ref($statushash) eq 'HASH') {
11267: $statushash->{$student}{'st'}{$section} = $status;
11268: }
1.288 raeburn 11269: }
1.275 raeburn 11270: }
11271: }
1.412 raeburn 11272: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11273: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11274: my $now = time;
1.609 raeburn 11275: my %displaystatus = ( previous => 'Expired',
11276: active => 'Active',
11277: future => 'Future',
11278: );
1.1121 raeburn 11279: my (%nothide,@possdoms);
1.630 raeburn 11280: if ($hidepriv) {
11281: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11282: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11283: if ($user !~ /:/) {
11284: $nothide{join(':',split(/[\@]/,$user))}=1;
11285: } else {
11286: $nothide{$user} = 1;
11287: }
11288: }
1.1121 raeburn 11289: my @possdoms = ($cdom);
11290: if ($coursehash{'checkforpriv'}) {
11291: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11292: }
1.630 raeburn 11293: }
1.439 raeburn 11294: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11295: my $match = 0;
1.412 raeburn 11296: my $secmatch = 0;
1.439 raeburn 11297: my $status;
1.412 raeburn 11298: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11299: $user =~ s/:$//;
1.439 raeburn 11300: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11301: if ($end == -1 || $start == -1) {
11302: next;
11303: }
11304: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11305: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11306: my ($uname,$udom) = split(/:/,$user);
11307: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11308: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11309: $secmatch = 1;
11310: } elsif ($usec eq '') {
1.420 albertel 11311: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11312: $secmatch = 1;
11313: }
11314: } else {
11315: if (grep(/^\Q$usec\E$/,@{$sections})) {
11316: $secmatch = 1;
11317: }
11318: }
11319: if (!$secmatch) {
11320: next;
11321: }
1.288 raeburn 11322: }
1.419 raeburn 11323: if ($usec eq '') {
11324: $usec = 'none';
11325: }
1.275 raeburn 11326: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11327: if ($hidepriv) {
1.1121 raeburn 11328: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11329: (!$nothide{$uname.':'.$udom})) {
11330: next;
11331: }
11332: }
1.503 raeburn 11333: if ($end > 0 && $end < $now) {
1.439 raeburn 11334: $status = 'previous';
11335: } elsif ($start > $now) {
11336: $status = 'future';
11337: } else {
11338: $status = 'active';
11339: }
1.277 albertel 11340: foreach my $type (keys(%{$types})) {
1.275 raeburn 11341: if ($status eq $type) {
1.420 albertel 11342: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11343: push(@{$$users{$role}{$user}},$type);
11344: }
1.288 raeburn 11345: $match = 1;
11346: }
11347: }
1.419 raeburn 11348: if (($match) && (ref($userdata) eq 'HASH')) {
11349: if (!exists($$userdata{$uname.':'.$udom})) {
11350: &get_user_info($udom,$uname,\%idx,$userdata);
11351: }
1.420 albertel 11352: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11353: push(@{$seclists{$uname.':'.$udom}},$usec);
11354: }
1.609 raeburn 11355: if (ref($statushash) eq 'HASH') {
11356: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11357: }
1.275 raeburn 11358: }
11359: }
11360: }
11361: }
1.290 albertel 11362: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11363: if ((defined($cdom)) && (defined($cnum))) {
11364: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11365: if ( defined($csettings{'internal.courseowner'}) ) {
11366: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11367: next if ($owner eq '');
11368: my ($ownername,$ownerdom);
11369: if ($owner =~ /^([^:]+):([^:]+)$/) {
11370: $ownername = $1;
11371: $ownerdom = $2;
11372: } else {
11373: $ownername = $owner;
11374: $ownerdom = $cdom;
11375: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11376: }
11377: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11378: if (defined($userdata) &&
1.609 raeburn 11379: !exists($$userdata{$owner})) {
11380: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11381: if (!grep(/^none$/,@{$seclists{$owner}})) {
11382: push(@{$seclists{$owner}},'none');
11383: }
11384: if (ref($statushash) eq 'HASH') {
11385: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11386: }
1.290 albertel 11387: }
1.279 raeburn 11388: }
11389: }
11390: }
1.419 raeburn 11391: foreach my $user (keys(%seclists)) {
11392: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11393: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11394: }
1.275 raeburn 11395: }
11396: return;
11397: }
11398:
1.288 raeburn 11399: sub get_user_info {
11400: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11401: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11402: &plainname($uname,$udom,'lastname');
1.291 albertel 11403: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11404: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11405: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11406: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11407: return;
11408: }
1.275 raeburn 11409:
1.472 raeburn 11410: ###############################################
11411:
11412: =pod
11413:
11414: =item * &get_user_quota()
11415:
1.1134 raeburn 11416: Retrieves quota assigned for storage of user files.
11417: Default is to report quota for portfolio files.
1.472 raeburn 11418:
11419: Incoming parameters:
11420: 1. user's username
11421: 2. user's domain
1.1134 raeburn 11422: 3. quota name - portfolio, author, or course
1.1136 raeburn 11423: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11424: 4. crstype - official, unofficial, textbook, placement or community,
11425: if quota name is course
1.472 raeburn 11426:
11427: Returns:
1.1163 raeburn 11428: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11429: 2. (Optional) Type of setting: custom or default
11430: (individually assigned or default for user's
11431: institutional status).
11432: 3. (Optional) - User's institutional status (e.g., faculty, staff
11433: or student - types as defined in localenroll::inst_usertypes
11434: for user's domain, which determines default quota for user.
11435: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11436:
11437: If a value has been stored in the user's environment,
1.536 raeburn 11438: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11439: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11440:
11441: =cut
11442:
11443: ###############################################
11444:
11445:
11446: sub get_user_quota {
1.1136 raeburn 11447: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11448: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11449: if (!defined($udom)) {
11450: $udom = $env{'user.domain'};
11451: }
11452: if (!defined($uname)) {
11453: $uname = $env{'user.name'};
11454: }
11455: if (($udom eq '' || $uname eq '') ||
11456: ($udom eq 'public') && ($uname eq 'public')) {
11457: $quota = 0;
1.536 raeburn 11458: $quotatype = 'default';
11459: $defquota = 0;
1.472 raeburn 11460: } else {
1.536 raeburn 11461: my $inststatus;
1.1134 raeburn 11462: if ($quotaname eq 'course') {
11463: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11464: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11465: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11466: } else {
11467: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11468: $quota = $cenv{'internal.uploadquota'};
11469: }
1.536 raeburn 11470: } else {
1.1134 raeburn 11471: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11472: if ($quotaname eq 'author') {
11473: $quota = $env{'environment.authorquota'};
11474: } else {
11475: $quota = $env{'environment.portfolioquota'};
11476: }
11477: $inststatus = $env{'environment.inststatus'};
11478: } else {
11479: my %userenv =
11480: &Apache::lonnet::get('environment',['portfolioquota',
11481: 'authorquota','inststatus'],$udom,$uname);
11482: my ($tmp) = keys(%userenv);
11483: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11484: if ($quotaname eq 'author') {
11485: $quota = $userenv{'authorquota'};
11486: } else {
11487: $quota = $userenv{'portfolioquota'};
11488: }
11489: $inststatus = $userenv{'inststatus'};
11490: } else {
11491: undef(%userenv);
11492: }
11493: }
11494: }
11495: if ($quota eq '' || wantarray) {
11496: if ($quotaname eq 'course') {
11497: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11498: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11499: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11500: ($crstype eq 'placement')) {
1.1136 raeburn 11501: $defquota = $domdefs{$crstype.'quota'};
11502: }
11503: if ($defquota eq '') {
11504: $defquota = 500;
11505: }
1.1134 raeburn 11506: } else {
11507: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11508: }
11509: if ($quota eq '') {
11510: $quota = $defquota;
11511: $quotatype = 'default';
11512: } else {
11513: $quotatype = 'custom';
11514: }
1.472 raeburn 11515: }
11516: }
1.536 raeburn 11517: if (wantarray) {
11518: return ($quota,$quotatype,$settingstatus,$defquota);
11519: } else {
11520: return $quota;
11521: }
1.472 raeburn 11522: }
11523:
11524: ###############################################
11525:
11526: =pod
11527:
11528: =item * &default_quota()
11529:
1.536 raeburn 11530: Retrieves default quota assigned for storage of user portfolio files,
11531: given an (optional) user's institutional status.
1.472 raeburn 11532:
11533: Incoming parameters:
1.1142 raeburn 11534:
1.472 raeburn 11535: 1. domain
1.536 raeburn 11536: 2. (Optional) institutional status(es). This is a : separated list of
11537: status types (e.g., faculty, staff, student etc.)
11538: which apply to the user for whom the default is being retrieved.
11539: If the institutional status string in undefined, the domain
1.1134 raeburn 11540: default quota will be returned.
11541: 3. quota name - portfolio, author, or course
11542: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11543:
11544: Returns:
1.1142 raeburn 11545:
1.1163 raeburn 11546: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11547: 2. (Optional) institutional type which determined the value of the
11548: default quota.
1.472 raeburn 11549:
11550: If a value has been stored in the domain's configuration db,
11551: it will return that, otherwise it returns 20 (for backwards
11552: compatibility with domains which have not set up a configuration
1.1163 raeburn 11553: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11554:
1.536 raeburn 11555: If the user's status includes multiple types (e.g., staff and student),
11556: the largest default quota which applies to the user determines the
11557: default quota returned.
11558:
1.472 raeburn 11559: =cut
11560:
11561: ###############################################
11562:
11563:
11564: sub default_quota {
1.1134 raeburn 11565: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11566: my ($defquota,$settingstatus);
11567: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11568: ['quotas'],$udom);
1.1134 raeburn 11569: my $key = 'defaultquota';
11570: if ($quotaname eq 'author') {
11571: $key = 'authorquota';
11572: }
1.622 raeburn 11573: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11574: if ($inststatus ne '') {
1.765 raeburn 11575: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11576: foreach my $item (@statuses) {
1.1134 raeburn 11577: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11578: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11579: if ($defquota eq '') {
1.1134 raeburn 11580: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11581: $settingstatus = $item;
1.1134 raeburn 11582: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11583: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11584: $settingstatus = $item;
11585: }
11586: }
1.1134 raeburn 11587: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11588: if ($quotahash{'quotas'}{$item} ne '') {
11589: if ($defquota eq '') {
11590: $defquota = $quotahash{'quotas'}{$item};
11591: $settingstatus = $item;
11592: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11593: $defquota = $quotahash{'quotas'}{$item};
11594: $settingstatus = $item;
11595: }
1.536 raeburn 11596: }
11597: }
11598: }
11599: }
11600: if ($defquota eq '') {
1.1134 raeburn 11601: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11602: $defquota = $quotahash{'quotas'}{$key}{'default'};
11603: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11604: $defquota = $quotahash{'quotas'}{'default'};
11605: }
1.536 raeburn 11606: $settingstatus = 'default';
1.1139 raeburn 11607: if ($defquota eq '') {
11608: if ($quotaname eq 'author') {
11609: $defquota = 500;
11610: }
11611: }
1.536 raeburn 11612: }
11613: } else {
11614: $settingstatus = 'default';
1.1134 raeburn 11615: if ($quotaname eq 'author') {
11616: $defquota = 500;
11617: } else {
11618: $defquota = 20;
11619: }
1.536 raeburn 11620: }
11621: if (wantarray) {
11622: return ($defquota,$settingstatus);
1.472 raeburn 11623: } else {
1.536 raeburn 11624: return $defquota;
1.472 raeburn 11625: }
11626: }
11627:
1.1135 raeburn 11628: ###############################################
11629:
11630: =pod
11631:
1.1136 raeburn 11632: =item * &excess_filesize_warning()
1.1135 raeburn 11633:
11634: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11635: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11636: space to be exceeded.
1.1136 raeburn 11637:
11638: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11639: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11640:
1.1165 raeburn 11641: Inputs: 7
1.1136 raeburn 11642: 1. username or coursenum
1.1135 raeburn 11643: 2. domain
1.1136 raeburn 11644: 3. context ('author' or 'course')
1.1135 raeburn 11645: 4. filename of file for which action is being requested
11646: 5. filesize (kB) of file
11647: 6. action being taken: copy or upload.
1.1237 raeburn 11648: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11649:
11650: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11651: otherwise return null.
11652:
11653: =back
1.1135 raeburn 11654:
11655: =cut
11656:
1.1136 raeburn 11657: sub excess_filesize_warning {
1.1165 raeburn 11658: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11659: my $current_disk_usage = 0;
1.1165 raeburn 11660: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11661: if ($context eq 'author') {
11662: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11663: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11664: } else {
11665: foreach my $subdir ('docs','supplemental') {
11666: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11667: }
11668: }
1.1135 raeburn 11669: $disk_quota = int($disk_quota * 1000);
11670: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11671: return '<p class="LC_warning">'.
1.1135 raeburn 11672: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11673: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11674: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11675: $disk_quota,$current_disk_usage).
11676: '</p>';
11677: }
11678: return;
11679: }
11680:
11681: ###############################################
11682:
11683:
1.1136 raeburn 11684:
11685:
1.384 raeburn 11686: sub get_secgrprole_info {
11687: my ($cdom,$cnum,$needroles,$type) = @_;
11688: my %sections_count = &get_sections($cdom,$cnum);
11689: my @sections = (sort {$a <=> $b} keys(%sections_count));
11690: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11691: my @groups = sort(keys(%curr_groups));
11692: my $allroles = [];
11693: my $rolehash;
11694: my $accesshash = {
11695: active => 'Currently has access',
11696: future => 'Will have future access',
11697: previous => 'Previously had access',
11698: };
11699: if ($needroles) {
11700: $rolehash = {'all' => 'all'};
1.385 albertel 11701: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11702: if (&Apache::lonnet::error(%user_roles)) {
11703: undef(%user_roles);
11704: }
11705: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11706: my ($role)=split(/\:/,$item,2);
11707: if ($role eq 'cr') { next; }
11708: if ($role =~ /^cr/) {
11709: $$rolehash{$role} = (split('/',$role))[3];
11710: } else {
11711: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11712: }
11713: }
11714: foreach my $key (sort(keys(%{$rolehash}))) {
11715: push(@{$allroles},$key);
11716: }
11717: push (@{$allroles},'st');
11718: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11719: }
11720: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11721: }
11722:
1.555 raeburn 11723: sub user_picker {
1.1279 raeburn 11724: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11725: my $currdom = $dom;
1.1253 raeburn 11726: my @alldoms = &Apache::lonnet::all_domains();
11727: if (@alldoms == 1) {
11728: my %domsrch = &Apache::lonnet::get_dom('configuration',
11729: ['directorysrch'],$alldoms[0]);
11730: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11731: my $showdom = $domdesc;
11732: if ($showdom eq '') {
11733: $showdom = $dom;
11734: }
11735: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11736: if ((!$domsrch{'directorysrch'}{'available'}) &&
11737: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11738: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11739: }
11740: }
11741: }
1.555 raeburn 11742: my %curr_selected = (
11743: srchin => 'dom',
1.580 raeburn 11744: srchby => 'lastname',
1.555 raeburn 11745: );
11746: my $srchterm;
1.625 raeburn 11747: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11748: if ($srch->{'srchby'} ne '') {
11749: $curr_selected{'srchby'} = $srch->{'srchby'};
11750: }
11751: if ($srch->{'srchin'} ne '') {
11752: $curr_selected{'srchin'} = $srch->{'srchin'};
11753: }
11754: if ($srch->{'srchtype'} ne '') {
11755: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11756: }
11757: if ($srch->{'srchdomain'} ne '') {
11758: $currdom = $srch->{'srchdomain'};
11759: }
11760: $srchterm = $srch->{'srchterm'};
11761: }
1.1222 damieng 11762: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11763: 'usr' => 'Search criteria',
1.563 raeburn 11764: 'doma' => 'Domain/institution to search',
1.558 albertel 11765: 'uname' => 'username',
11766: 'lastname' => 'last name',
1.555 raeburn 11767: 'lastfirst' => 'last name, first name',
1.558 albertel 11768: 'crs' => 'in this course',
1.576 raeburn 11769: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11770: 'alc' => 'all LON-CAPA',
1.573 raeburn 11771: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11772: 'exact' => 'is',
11773: 'contains' => 'contains',
1.569 raeburn 11774: 'begins' => 'begins with',
1.1222 damieng 11775: );
11776: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11777: 'youm' => "You must include some text to search for.",
11778: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11779: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11780: 'yomc' => "You must choose a domain when using an institutional directory search.",
11781: 'ymcd' => "You must choose a domain when using a domain search.",
11782: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11783: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11784: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11785: );
1.1222 damieng 11786: &html_escape(\%html_lt);
11787: &js_escape(\%js_lt);
1.1255 raeburn 11788: my $domform;
1.1277 raeburn 11789: my $allow_blank = 1;
1.1255 raeburn 11790: if ($fixeddom) {
1.1277 raeburn 11791: $allow_blank = 0;
11792: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11793: } else {
1.1287 raeburn 11794: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11795: my ($trusted,$untrusted);
1.1287 raeburn 11796: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11797: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11798: } elsif ($context eq 'author') {
1.1288 raeburn 11799: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11800: } elsif ($context eq 'domain') {
1.1288 raeburn 11801: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11802: }
1.1288 raeburn 11803: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11804: }
1.563 raeburn 11805: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11806:
11807: my @srchins = ('crs','dom','alc','instd');
11808:
11809: foreach my $option (@srchins) {
11810: # FIXME 'alc' option unavailable until
11811: # loncreateuser::print_user_query_page()
11812: # has been completed.
11813: next if ($option eq 'alc');
1.880 raeburn 11814: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11815: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11816: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11817: if ($curr_selected{'srchin'} eq $option) {
11818: $srchinsel .= '
1.1222 damieng 11819: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11820: } else {
11821: $srchinsel .= '
1.1222 damieng 11822: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11823: }
1.555 raeburn 11824: }
1.563 raeburn 11825: $srchinsel .= "\n </select>\n";
1.555 raeburn 11826:
11827: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11828: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11829: if ($curr_selected{'srchby'} eq $option) {
11830: $srchbysel .= '
1.1222 damieng 11831: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11832: } else {
11833: $srchbysel .= '
1.1222 damieng 11834: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11835: }
11836: }
11837: $srchbysel .= "\n </select>\n";
11838:
11839: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11840: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11841: if ($curr_selected{'srchtype'} eq $option) {
11842: $srchtypesel .= '
1.1222 damieng 11843: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11844: } else {
11845: $srchtypesel .= '
1.1222 damieng 11846: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11847: }
11848: }
11849: $srchtypesel .= "\n </select>\n";
11850:
1.558 albertel 11851: my ($newuserscript,$new_user_create);
1.994 raeburn 11852: my $context_dom = $env{'request.role.domain'};
11853: if ($context eq 'requestcrs') {
11854: if ($env{'form.coursedom'} ne '') {
11855: $context_dom = $env{'form.coursedom'};
11856: }
11857: }
1.556 raeburn 11858: if ($forcenewuser) {
1.576 raeburn 11859: if (ref($srch) eq 'HASH') {
1.994 raeburn 11860: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11861: if ($cancreate) {
11862: $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>';
11863: } else {
1.799 bisitz 11864: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11865: my %usertypetext = (
11866: official => 'institutional',
11867: unofficial => 'non-institutional',
11868: );
1.799 bisitz 11869: $new_user_create = '<p class="LC_warning">'
11870: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11871: .' '
11872: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11873: ,'<a href="'.$helplink.'">','</a>')
11874: .'</p><br />';
1.627 raeburn 11875: }
1.576 raeburn 11876: }
11877: }
11878:
1.556 raeburn 11879: $newuserscript = <<"ENDSCRIPT";
11880:
1.570 raeburn 11881: function setSearch(createnew,callingForm) {
1.556 raeburn 11882: if (createnew == 1) {
1.570 raeburn 11883: for (var i=0; i<callingForm.srchby.length; i++) {
11884: if (callingForm.srchby.options[i].value == 'uname') {
11885: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11886: }
11887: }
1.570 raeburn 11888: for (var i=0; i<callingForm.srchin.length; i++) {
11889: if ( callingForm.srchin.options[i].value == 'dom') {
11890: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11891: }
11892: }
1.570 raeburn 11893: for (var i=0; i<callingForm.srchtype.length; i++) {
11894: if (callingForm.srchtype.options[i].value == 'exact') {
11895: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11896: }
11897: }
1.570 raeburn 11898: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11899: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11900: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11901: }
11902: }
11903: }
11904: }
11905: ENDSCRIPT
1.558 albertel 11906:
1.556 raeburn 11907: }
11908:
1.555 raeburn 11909: my $output = <<"END_BLOCK";
1.556 raeburn 11910: <script type="text/javascript">
1.824 bisitz 11911: // <![CDATA[
1.570 raeburn 11912: function validateEntry(callingForm) {
1.558 albertel 11913:
1.556 raeburn 11914: var checkok = 1;
1.558 albertel 11915: var srchin;
1.570 raeburn 11916: for (var i=0; i<callingForm.srchin.length; i++) {
11917: if ( callingForm.srchin[i].checked ) {
11918: srchin = callingForm.srchin[i].value;
1.558 albertel 11919: }
11920: }
11921:
1.570 raeburn 11922: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11923: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11924: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11925: var srchterm = callingForm.srchterm.value;
11926: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11927: var msg = "";
11928:
11929: if (srchterm == "") {
11930: checkok = 0;
1.1222 damieng 11931: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11932: }
11933:
1.569 raeburn 11934: if (srchtype== 'begins') {
11935: if (srchterm.length < 2) {
11936: checkok = 0;
1.1222 damieng 11937: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11938: }
11939: }
11940:
1.556 raeburn 11941: if (srchtype== 'contains') {
11942: if (srchterm.length < 3) {
11943: checkok = 0;
1.1222 damieng 11944: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11945: }
11946: }
11947: if (srchin == 'instd') {
11948: if (srchdomain == '') {
11949: checkok = 0;
1.1222 damieng 11950: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11951: }
11952: }
11953: if (srchin == 'dom') {
11954: if (srchdomain == '') {
11955: checkok = 0;
1.1222 damieng 11956: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11957: }
11958: }
11959: if (srchby == 'lastfirst') {
11960: if (srchterm.indexOf(",") == -1) {
11961: checkok = 0;
1.1222 damieng 11962: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11963: }
11964: if (srchterm.indexOf(",") == srchterm.length -1) {
11965: checkok = 0;
1.1222 damieng 11966: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11967: }
11968: }
11969: if (checkok == 0) {
1.1222 damieng 11970: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11971: return;
11972: }
11973: if (checkok == 1) {
1.570 raeburn 11974: callingForm.submit();
1.556 raeburn 11975: }
11976: }
11977:
11978: $newuserscript
11979:
1.824 bisitz 11980: // ]]>
1.556 raeburn 11981: </script>
1.558 albertel 11982:
11983: $new_user_create
11984:
1.555 raeburn 11985: END_BLOCK
1.558 albertel 11986:
1.876 raeburn 11987: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11988: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11989: $domform.
11990: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11991: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11992: $srchbysel.
11993: $srchtypesel.
11994: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11995: $srchinsel.
11996: &Apache::lonhtmlcommon::row_closure(1).
11997: &Apache::lonhtmlcommon::end_pick_box().
11998: '<br />';
1.1253 raeburn 11999: return ($output,1);
1.555 raeburn 12000: }
12001:
1.612 raeburn 12002: sub user_rule_check {
1.615 raeburn 12003: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 12004: my ($response,%inst_response);
1.612 raeburn 12005: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 12006: if (keys(%{$usershash}) > 1) {
12007: my (%by_username,%by_id,%userdoms);
12008: my $checkid;
12009: if (ref($checks) eq 'HASH') {
12010: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
12011: $checkid = 1;
12012: }
12013: }
12014: foreach my $user (keys(%{$usershash})) {
12015: my ($uname,$udom) = split(/:/,$user);
12016: if ($checkid) {
12017: if (ref($usershash->{$user}) eq 'HASH') {
12018: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 12019: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 12020: $userdoms{$udom} = 1;
1.1227 raeburn 12021: if (ref($inst_results) eq 'HASH') {
12022: $inst_results->{$uname.':'.$udom} = {};
12023: }
1.1226 raeburn 12024: }
12025: }
12026: } else {
12027: $by_username{$udom}{$uname} = 1;
12028: $userdoms{$udom} = 1;
1.1227 raeburn 12029: if (ref($inst_results) eq 'HASH') {
12030: $inst_results->{$uname.':'.$udom} = {};
12031: }
1.1226 raeburn 12032: }
12033: }
12034: foreach my $udom (keys(%userdoms)) {
12035: if (!$got_rules->{$udom}) {
12036: my %domconfig = &Apache::lonnet::get_dom('configuration',
12037: ['usercreation'],$udom);
12038: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12039: foreach my $item ('username','id') {
12040: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 12041: $$curr_rules{$udom}{$item} =
12042: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 12043: }
12044: }
12045: }
12046: $got_rules->{$udom} = 1;
12047: }
1.612 raeburn 12048: }
1.1226 raeburn 12049: if ($checkid) {
12050: foreach my $udom (keys(%by_id)) {
12051: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12052: if ($outcome eq 'ok') {
1.1227 raeburn 12053: foreach my $id (keys(%{$by_id{$udom}})) {
12054: my $uname = $by_id{$udom}{$id};
12055: $inst_response{$uname.':'.$udom} = $outcome;
12056: }
1.1226 raeburn 12057: if (ref($results) eq 'HASH') {
12058: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12059: if (exists($inst_response{$uname.':'.$udom})) {
12060: $inst_response{$uname.':'.$udom} = $outcome;
12061: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12062: }
1.1226 raeburn 12063: }
12064: }
12065: }
1.612 raeburn 12066: }
1.615 raeburn 12067: } else {
1.1226 raeburn 12068: foreach my $udom (keys(%by_username)) {
12069: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12070: if ($outcome eq 'ok') {
1.1227 raeburn 12071: foreach my $uname (keys(%{$by_username{$udom}})) {
12072: $inst_response{$uname.':'.$udom} = $outcome;
12073: }
1.1226 raeburn 12074: if (ref($results) eq 'HASH') {
12075: foreach my $uname (keys(%{$results})) {
12076: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12077: }
12078: }
12079: }
12080: }
1.612 raeburn 12081: }
1.1226 raeburn 12082: } elsif (keys(%{$usershash}) == 1) {
12083: my $user = (keys(%{$usershash}))[0];
12084: my ($uname,$udom) = split(/:/,$user);
12085: if (($udom ne '') && ($uname ne '')) {
12086: if (ref($usershash->{$user}) eq 'HASH') {
12087: if (ref($checks) eq 'HASH') {
12088: if (defined($checks->{'username'})) {
12089: ($inst_response{$user},%{$inst_results->{$user}}) =
12090: &Apache::lonnet::get_instuser($udom,$uname);
12091: } elsif (defined($checks->{'id'})) {
12092: if ($usershash->{$user}->{'id'} ne '') {
12093: ($inst_response{$user},%{$inst_results->{$user}}) =
12094: &Apache::lonnet::get_instuser($udom,undef,
12095: $usershash->{$user}->{'id'});
12096: } else {
12097: ($inst_response{$user},%{$inst_results->{$user}}) =
12098: &Apache::lonnet::get_instuser($udom,$uname);
12099: }
1.585 raeburn 12100: }
1.1226 raeburn 12101: } else {
12102: ($inst_response{$user},%{$inst_results->{$user}}) =
12103: &Apache::lonnet::get_instuser($udom,$uname);
12104: return;
12105: }
12106: if (!$got_rules->{$udom}) {
12107: my %domconfig = &Apache::lonnet::get_dom('configuration',
12108: ['usercreation'],$udom);
12109: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12110: foreach my $item ('username','id') {
12111: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12112: $$curr_rules{$udom}{$item} =
12113: $domconfig{'usercreation'}{$item.'_rule'};
12114: }
12115: }
12116: }
12117: $got_rules->{$udom} = 1;
1.585 raeburn 12118: }
12119: }
1.1226 raeburn 12120: } else {
12121: return;
12122: }
12123: } else {
12124: return;
12125: }
12126: foreach my $user (keys(%{$usershash})) {
12127: my ($uname,$udom) = split(/:/,$user);
12128: next if (($udom eq '') || ($uname eq ''));
12129: my $id;
1.1227 raeburn 12130: if (ref($inst_results) eq 'HASH') {
12131: if (ref($inst_results->{$user}) eq 'HASH') {
12132: $id = $inst_results->{$user}->{'id'};
12133: }
12134: }
12135: if ($id eq '') {
12136: if (ref($usershash->{$user})) {
12137: $id = $usershash->{$user}->{'id'};
12138: }
1.585 raeburn 12139: }
1.612 raeburn 12140: foreach my $item (keys(%{$checks})) {
12141: if (ref($$curr_rules{$udom}) eq 'HASH') {
12142: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12143: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12144: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12145: $$curr_rules{$udom}{$item});
1.612 raeburn 12146: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12147: if ($rule_check{$rule}) {
12148: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12149: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12150: if (ref($inst_results) eq 'HASH') {
12151: if (ref($inst_results->{$user}) eq 'HASH') {
12152: if (keys(%{$inst_results->{$user}}) == 0) {
12153: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12154: } elsif ($item eq 'id') {
12155: if ($inst_results->{$user}->{'id'} eq '') {
12156: $$alerts{$item}{$udom}{$uname} = 1;
12157: }
1.615 raeburn 12158: }
1.612 raeburn 12159: }
12160: }
1.615 raeburn 12161: }
12162: last;
1.585 raeburn 12163: }
12164: }
12165: }
12166: }
12167: }
12168: }
12169: }
12170: }
1.612 raeburn 12171: return;
12172: }
12173:
12174: sub user_rule_formats {
12175: my ($domain,$domdesc,$curr_rules,$check) = @_;
12176: my %text = (
12177: 'username' => 'Usernames',
12178: 'id' => 'IDs',
12179: );
12180: my $output;
12181: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12182: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12183: if (@{$ruleorder} > 0) {
1.1102 raeburn 12184: $output = '<br />'.
12185: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12186: '<span class="LC_cusr_emph">','</span>',$domdesc).
12187: ' <ul>';
1.612 raeburn 12188: foreach my $rule (@{$ruleorder}) {
12189: if (ref($curr_rules) eq 'ARRAY') {
12190: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12191: if (ref($rules->{$rule}) eq 'HASH') {
12192: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12193: $rules->{$rule}{'desc'}.'</li>';
12194: }
12195: }
12196: }
12197: }
12198: $output .= '</ul>';
12199: }
12200: }
12201: return $output;
12202: }
12203:
12204: sub instrule_disallow_msg {
1.615 raeburn 12205: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12206: my $response;
12207: my %text = (
12208: item => 'username',
12209: items => 'usernames',
12210: match => 'matches',
12211: do => 'does',
12212: action => 'a username',
12213: one => 'one',
12214: );
12215: if ($count > 1) {
12216: $text{'item'} = 'usernames';
12217: $text{'match'} ='match';
12218: $text{'do'} = 'do';
12219: $text{'action'} = 'usernames',
12220: $text{'one'} = 'ones';
12221: }
12222: if ($checkitem eq 'id') {
12223: $text{'items'} = 'IDs';
12224: $text{'item'} = 'ID';
12225: $text{'action'} = 'an ID';
1.615 raeburn 12226: if ($count > 1) {
12227: $text{'item'} = 'IDs';
12228: $text{'action'} = 'IDs';
12229: }
1.612 raeburn 12230: }
1.674 bisitz 12231: $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 12232: if ($mode eq 'upload') {
12233: if ($checkitem eq 'username') {
12234: $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'}.");
12235: } elsif ($checkitem eq 'id') {
1.674 bisitz 12236: $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 12237: }
1.669 raeburn 12238: } elsif ($mode eq 'selfcreate') {
12239: if ($checkitem eq 'id') {
12240: $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.");
12241: }
1.615 raeburn 12242: } else {
12243: if ($checkitem eq 'username') {
12244: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12245: } elsif ($checkitem eq 'id') {
12246: $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.");
12247: }
1.612 raeburn 12248: }
12249: return $response;
1.585 raeburn 12250: }
12251:
1.624 raeburn 12252: sub personal_data_fieldtitles {
12253: my %fieldtitles = &Apache::lonlocal::texthash (
12254: id => 'Student/Employee ID',
12255: permanentemail => 'E-mail address',
12256: lastname => 'Last Name',
12257: firstname => 'First Name',
12258: middlename => 'Middle Name',
12259: generation => 'Generation',
12260: gen => 'Generation',
1.765 raeburn 12261: inststatus => 'Affiliation',
1.624 raeburn 12262: );
12263: return %fieldtitles;
12264: }
12265:
1.642 raeburn 12266: sub sorted_inst_types {
12267: my ($dom) = @_;
1.1185 raeburn 12268: my ($usertypes,$order);
12269: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12270: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12271: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12272: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12273: } else {
12274: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12275: }
1.642 raeburn 12276: my $othertitle = &mt('All users');
12277: if ($env{'request.course.id'}) {
1.668 raeburn 12278: $othertitle = &mt('Any users');
1.642 raeburn 12279: }
12280: my @types;
12281: if (ref($order) eq 'ARRAY') {
12282: @types = @{$order};
12283: }
12284: if (@types == 0) {
12285: if (ref($usertypes) eq 'HASH') {
12286: @types = sort(keys(%{$usertypes}));
12287: }
12288: }
12289: if (keys(%{$usertypes}) > 0) {
12290: $othertitle = &mt('Other users');
12291: }
12292: return ($othertitle,$usertypes,\@types);
12293: }
12294:
1.645 raeburn 12295: sub get_institutional_codes {
1.1361 raeburn 12296: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12297: # Get complete list of course sections to update
12298: my @currsections = ();
12299: my @currxlists = ();
1.1361 raeburn 12300: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12301: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12302: my $crskey = $crs.':'.$coursecode;
12303: @{$unclutteredsec{$crskey}} = ();
12304: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12305:
12306: if ($$settings{'internal.sectionnums'} ne '') {
12307: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12308: }
12309:
12310: if ($$settings{'internal.crosslistings'} ne '') {
12311: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12312: }
12313:
12314: if (@currxlists > 0) {
1.1361 raeburn 12315: foreach my $xl (@currxlists) {
12316: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12317: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12318: push(@{$allcourses},$1);
1.645 raeburn 12319: $$LC_code{$1} = $2;
12320: }
12321: }
12322: }
12323: }
1.1361 raeburn 12324:
1.645 raeburn 12325: if (@currsections > 0) {
1.1361 raeburn 12326: foreach my $sec (@currsections) {
12327: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12328: my $instsec = $1;
1.645 raeburn 12329: my $lc_sec = $2;
1.1361 raeburn 12330: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12331: push(@{$unclutteredsec{$crskey}},$instsec);
12332: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12333: }
12334: }
12335: }
12336: }
12337:
12338: if (@{$unclutteredsec{$crskey}} > 0) {
12339: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12340: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12341: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12342: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12343: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12344: push(@{$allcourses},$sec);
1.1361 raeburn 12345: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12346: }
12347: }
12348: }
12349: }
12350: return;
12351: }
12352:
1.971 raeburn 12353: sub get_standard_codeitems {
12354: return ('Year','Semester','Department','Number','Section');
12355: }
12356:
1.112 bowersj2 12357: =pod
12358:
1.780 raeburn 12359: =head1 Slot Helpers
12360:
12361: =over 4
12362:
12363: =item * sorted_slots()
12364:
1.1040 raeburn 12365: Sorts an array of slot names in order of an optional sort key,
12366: default sort is by slot start time (earliest first).
1.780 raeburn 12367:
12368: Inputs:
12369:
12370: =over 4
12371:
12372: slotsarr - Reference to array of unsorted slot names.
12373:
12374: slots - Reference to hash of hash, where outer hash keys are slot names.
12375:
1.1040 raeburn 12376: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12377:
1.549 albertel 12378: =back
12379:
1.780 raeburn 12380: Returns:
12381:
12382: =over 4
12383:
1.1040 raeburn 12384: sorted - An array of slot names sorted by a specified sort key
12385: (default sort key is start time of the slot).
1.780 raeburn 12386:
12387: =back
12388:
12389: =cut
12390:
12391:
12392: sub sorted_slots {
1.1040 raeburn 12393: my ($slotsarr,$slots,$sortkey) = @_;
12394: if ($sortkey eq '') {
12395: $sortkey = 'starttime';
12396: }
1.780 raeburn 12397: my @sorted;
12398: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12399: @sorted =
12400: sort {
12401: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12402: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12403: }
12404: if (ref($slots->{$a})) { return -1;}
12405: if (ref($slots->{$b})) { return 1;}
12406: return 0;
12407: } @{$slotsarr};
12408: }
12409: return @sorted;
12410: }
12411:
1.1040 raeburn 12412: =pod
12413:
12414: =item * get_future_slots()
12415:
12416: Inputs:
12417:
12418: =over 4
12419:
12420: cnum - course number
12421:
12422: cdom - course domain
12423:
12424: now - current UNIX time
12425:
12426: symb - optional symb
12427:
12428: =back
12429:
12430: Returns:
12431:
12432: =over 4
12433:
12434: sorted_reservable - ref to array of student_schedulable slots currently
12435: reservable, ordered by end date of reservation period.
12436:
12437: reservable_now - ref to hash of student_schedulable slots currently
12438: reservable.
12439:
12440: Keys in inner hash are:
12441: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12442: (b) endreserve: end date of reservation period.
12443: (c) uniqueperiod: start,end dates when slot is to be uniquely
12444: selected.
1.1040 raeburn 12445:
12446: sorted_future - ref to array of student_schedulable slots reservable in
12447: the future, ordered by start date of reservation period.
12448:
12449: future_reservable - ref to hash of student_schedulable slots reservable
12450: in the future.
12451:
12452: Keys in inner hash are:
12453: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12454: (b) startreserve: start date of reservation period.
12455: (c) uniqueperiod: start,end dates when slot is to be uniquely
12456: selected.
1.1040 raeburn 12457:
12458: =back
12459:
12460: =cut
12461:
12462: sub get_future_slots {
12463: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12464: my $map;
12465: if ($symb) {
12466: ($map) = &Apache::lonnet::decode_symb($symb);
12467: }
1.1040 raeburn 12468: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12469: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12470: foreach my $slot (keys(%slots)) {
12471: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12472: if ($symb) {
1.1229 raeburn 12473: if ($slots{$slot}->{'symb'} ne '') {
12474: my $canuse;
12475: my %oksymbs;
12476: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12477: map { $oksymbs{$_} = 1; } @slotsymbs;
12478: if ($oksymbs{$symb}) {
12479: $canuse = 1;
12480: } else {
12481: foreach my $item (@slotsymbs) {
12482: if ($item =~ /\.(page|sequence)$/) {
12483: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12484: if (($map ne '') && ($map eq $sloturl)) {
12485: $canuse = 1;
12486: last;
12487: }
12488: }
12489: }
12490: }
12491: next unless ($canuse);
12492: }
1.1040 raeburn 12493: }
12494: if (($slots{$slot}->{'starttime'} > $now) &&
12495: ($slots{$slot}->{'endtime'} > $now)) {
12496: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12497: my $userallowed = 0;
12498: if ($slots{$slot}->{'allowedsections'}) {
12499: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12500: if (!defined($env{'request.role.sec'})
12501: && grep(/^No section assigned$/,@allowed_sec)) {
12502: $userallowed=1;
12503: } else {
12504: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12505: $userallowed=1;
12506: }
12507: }
12508: unless ($userallowed) {
12509: if (defined($env{'request.course.groups'})) {
12510: my @groups = split(/:/,$env{'request.course.groups'});
12511: foreach my $group (@groups) {
12512: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12513: $userallowed=1;
12514: last;
12515: }
12516: }
12517: }
12518: }
12519: }
12520: if ($slots{$slot}->{'allowedusers'}) {
12521: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12522: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12523: if (grep(/^\Q$user\E$/,@allowed_users)) {
12524: $userallowed = 1;
12525: }
12526: }
12527: next unless($userallowed);
12528: }
12529: my $startreserve = $slots{$slot}->{'startreserve'};
12530: my $endreserve = $slots{$slot}->{'endreserve'};
12531: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12532: my $uniqueperiod;
12533: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12534: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12535: }
1.1040 raeburn 12536: if (($startreserve < $now) &&
12537: (!$endreserve || $endreserve > $now)) {
12538: my $lastres = $endreserve;
12539: if (!$lastres) {
12540: $lastres = $slots{$slot}->{'starttime'};
12541: }
12542: $reservable_now{$slot} = {
12543: symb => $symb,
1.1250 raeburn 12544: endreserve => $lastres,
12545: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12546: };
12547: } elsif (($startreserve > $now) &&
12548: (!$endreserve || $endreserve > $startreserve)) {
12549: $future_reservable{$slot} = {
12550: symb => $symb,
1.1250 raeburn 12551: startreserve => $startreserve,
12552: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12553: };
12554: }
12555: }
12556: }
12557: my @unsorted_reservable = keys(%reservable_now);
12558: if (@unsorted_reservable > 0) {
12559: @sorted_reservable =
12560: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12561: }
12562: my @unsorted_future = keys(%future_reservable);
12563: if (@unsorted_future > 0) {
12564: @sorted_future =
12565: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12566: }
12567: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12568: }
1.780 raeburn 12569:
12570: =pod
12571:
1.1057 foxr 12572: =back
12573:
1.549 albertel 12574: =head1 HTTP Helpers
12575:
12576: =over 4
12577:
1.648 raeburn 12578: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12579:
1.258 albertel 12580: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12581: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12582: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12583:
12584: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12585: $possible_names is an ref to an array of form element names. As an example:
12586: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12587: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12588:
12589: =cut
1.1 albertel 12590:
1.6 albertel 12591: sub get_unprocessed_cgi {
1.25 albertel 12592: my ($query,$possible_names)= @_;
1.26 matthew 12593: # $Apache::lonxml::debug=1;
1.356 albertel 12594: foreach my $pair (split(/&/,$query)) {
12595: my ($name, $value) = split(/=/,$pair);
1.369 www 12596: $name = &unescape($name);
1.25 albertel 12597: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12598: $value =~ tr/+/ /;
12599: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12600: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12601: }
1.16 harris41 12602: }
1.6 albertel 12603: }
12604:
1.112 bowersj2 12605: =pod
12606:
1.648 raeburn 12607: =item * &cacheheader()
1.112 bowersj2 12608:
12609: returns cache-controlling header code
12610:
12611: =cut
12612:
1.7 albertel 12613: sub cacheheader {
1.258 albertel 12614: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12615: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12616: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12617: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12618: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12619: return $output;
1.7 albertel 12620: }
12621:
1.112 bowersj2 12622: =pod
12623:
1.648 raeburn 12624: =item * &no_cache($r)
1.112 bowersj2 12625:
12626: specifies header code to not have cache
12627:
12628: =cut
12629:
1.9 albertel 12630: sub no_cache {
1.216 albertel 12631: my ($r) = @_;
12632: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12633: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12634: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12635: $r->no_cache(1);
12636: $r->header_out("Expires" => $date);
12637: $r->header_out("Pragma" => "no-cache");
1.123 www 12638: }
12639:
12640: sub content_type {
1.181 albertel 12641: my ($r,$type,$charset) = @_;
1.299 foxr 12642: if ($r) {
12643: # Note that printout.pl calls this with undef for $r.
12644: &no_cache($r);
12645: }
1.258 albertel 12646: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12647: unless ($charset) {
12648: $charset=&Apache::lonlocal::current_encoding;
12649: }
12650: if ($charset) { $type.='; charset='.$charset; }
12651: if ($r) {
12652: $r->content_type($type);
12653: } else {
12654: print("Content-type: $type\n\n");
12655: }
1.9 albertel 12656: }
1.25 albertel 12657:
1.112 bowersj2 12658: =pod
12659:
1.648 raeburn 12660: =item * &add_to_env($name,$value)
1.112 bowersj2 12661:
1.258 albertel 12662: adds $name to the %env hash with value
1.112 bowersj2 12663: $value, if $name already exists, the entry is converted to an array
12664: reference and $value is added to the array.
12665:
12666: =cut
12667:
1.25 albertel 12668: sub add_to_env {
12669: my ($name,$value)=@_;
1.258 albertel 12670: if (defined($env{$name})) {
12671: if (ref($env{$name})) {
1.25 albertel 12672: #already have multiple values
1.258 albertel 12673: push(@{ $env{$name} },$value);
1.25 albertel 12674: } else {
12675: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12676: my $first=$env{$name};
12677: undef($env{$name});
12678: push(@{ $env{$name} },$first,$value);
1.25 albertel 12679: }
12680: } else {
1.258 albertel 12681: $env{$name}=$value;
1.25 albertel 12682: }
1.31 albertel 12683: }
1.149 albertel 12684:
12685: =pod
12686:
1.648 raeburn 12687: =item * &get_env_multiple($name)
1.149 albertel 12688:
1.258 albertel 12689: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12690: values may be defined and end up as an array ref.
12691:
12692: returns an array of values
12693:
12694: =cut
12695:
12696: sub get_env_multiple {
12697: my ($name) = @_;
12698: my @values;
1.258 albertel 12699: if (defined($env{$name})) {
1.149 albertel 12700: # exists is it an array
1.258 albertel 12701: if (ref($env{$name})) {
12702: @values=@{ $env{$name} };
1.149 albertel 12703: } else {
1.258 albertel 12704: $values[0]=$env{$name};
1.149 albertel 12705: }
12706: }
12707: return(@values);
12708: }
12709:
1.1249 damieng 12710: # Looks at given dependencies, and returns something depending on the context.
12711: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12712: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12713: # For all other contexts, returns ($output, $counter, $numpathchg).
12714: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12715: # $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.
12716: # $numpathchg: integer with the number of cleaned up dependency paths.
12717: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12718: # \%mapping: hash reference clean path -> original path for all dependencies.
12719: # @param {string} actionurl - The path to the handler, indicative of the context.
12720: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12721: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12722: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12723: # @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)
12724: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12725: sub ask_for_embedded_content {
1.1249 damieng 12726: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12727: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12728: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12729: %currsubfile,%unused,$rem);
1.1071 raeburn 12730: my $counter = 0;
12731: my $numnew = 0;
1.987 raeburn 12732: my $numremref = 0;
12733: my $numinvalid = 0;
12734: my $numpathchg = 0;
12735: my $numexisting = 0;
1.1071 raeburn 12736: my $numunused = 0;
12737: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12738: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12739: my $heading = &mt('Upload embedded files');
12740: my $buttontext = &mt('Upload');
12741:
1.1249 damieng 12742: # fills these variables based on the context:
12743: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12744: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12745: if ($env{'request.course.id'}) {
1.1123 raeburn 12746: if ($actionurl eq '/adm/dependencies') {
12747: $navmap = Apache::lonnavmaps::navmap->new();
12748: }
12749: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12750: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12751: }
1.1123 raeburn 12752: if (($actionurl eq '/adm/portfolio') ||
12753: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12754: my $current_path='/';
12755: if ($env{'form.currentpath'}) {
12756: $current_path = $env{'form.currentpath'};
12757: }
12758: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12759: $udom = $cdom;
12760: $uname = $cnum;
1.984 raeburn 12761: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12762: } else {
12763: $udom = $env{'user.domain'};
12764: $uname = $env{'user.name'};
12765: $url = '/userfiles/portfolio';
12766: }
1.987 raeburn 12767: $toplevel = $url.'/';
1.984 raeburn 12768: $url .= $current_path;
12769: $getpropath = 1;
1.987 raeburn 12770: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12771: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12772: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12773: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12774: $toplevel = $url;
1.984 raeburn 12775: if ($rest ne '') {
1.987 raeburn 12776: $url .= $rest;
12777: }
12778: } elsif ($actionurl eq '/adm/coursedocs') {
12779: if (ref($args) eq 'HASH') {
1.1071 raeburn 12780: $url = $args->{'docs_url'};
12781: $toplevel = $url;
1.1084 raeburn 12782: if ($args->{'context'} eq 'paste') {
12783: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12784: ($path) =
12785: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12786: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12787: $fileloc =~ s{^/}{};
12788: }
1.1071 raeburn 12789: }
1.1084 raeburn 12790: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12791: if ($env{'request.course.id'} ne '') {
12792: if (ref($args) eq 'HASH') {
12793: $url = $args->{'docs_url'};
12794: $title = $args->{'docs_title'};
1.1126 raeburn 12795: $toplevel = $url;
12796: unless ($toplevel =~ m{^/}) {
12797: $toplevel = "/$url";
12798: }
1.1085 raeburn 12799: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12800: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12801: $path = $1;
12802: } else {
12803: ($path) =
12804: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12805: }
1.1195 raeburn 12806: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12807: $fileloc = $toplevel;
12808: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12809: my ($udom,$uname,$fname) =
12810: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12811: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12812: } else {
12813: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12814: }
1.1071 raeburn 12815: $fileloc =~ s{^/}{};
12816: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12817: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12818: }
1.987 raeburn 12819: }
1.1123 raeburn 12820: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12821: $udom = $cdom;
12822: $uname = $cnum;
12823: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12824: $toplevel = $url;
12825: $path = $url;
12826: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12827: $fileloc =~ s{^/}{};
1.987 raeburn 12828: }
1.1249 damieng 12829:
12830: # parses the dependency paths to get some info
12831: # fills $newfiles, $mapping, $subdependencies, $dependencies
12832: # $newfiles: hash URL -> 1 for new files or external URLs
12833: # (will be completed later)
12834: # $mapping:
12835: # for external URLs: external URL -> external URL
12836: # for relative paths: clean path -> original path
12837: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12838: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12839: foreach my $file (keys(%{$allfiles})) {
12840: my $embed_file;
12841: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12842: $embed_file = $1;
12843: } else {
12844: $embed_file = $file;
12845: }
1.1158 raeburn 12846: my ($absolutepath,$cleaned_file);
12847: if ($embed_file =~ m{^\w+://}) {
12848: $cleaned_file = $embed_file;
1.1147 raeburn 12849: $newfiles{$cleaned_file} = 1;
12850: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12851: } else {
1.1158 raeburn 12852: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12853: if ($embed_file =~ m{^/}) {
12854: $absolutepath = $embed_file;
12855: }
1.1147 raeburn 12856: if ($cleaned_file =~ m{/}) {
12857: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12858: $path = &check_for_traversal($path,$url,$toplevel);
12859: my $item = $fname;
12860: if ($path ne '') {
12861: $item = $path.'/'.$fname;
12862: $subdependencies{$path}{$fname} = 1;
12863: } else {
12864: $dependencies{$item} = 1;
12865: }
12866: if ($absolutepath) {
12867: $mapping{$item} = $absolutepath;
12868: } else {
12869: $mapping{$item} = $embed_file;
12870: }
12871: } else {
12872: $dependencies{$embed_file} = 1;
12873: if ($absolutepath) {
1.1147 raeburn 12874: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12875: } else {
1.1147 raeburn 12876: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12877: }
12878: }
1.984 raeburn 12879: }
12880: }
1.1249 damieng 12881:
12882: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12883: # and lists
12884: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12885: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12886: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12887: # the path had to be cleaned up
12888: # $existing: hash clean path -> 1 if the file exists
12889: # $numexisting: number of keys in $existing
12890: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12891: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12892: # dependency subdirectories that are
12893: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12894: my $dirptr = 16384;
1.984 raeburn 12895: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12896: $currsubfile{$path} = {};
1.1123 raeburn 12897: if (($actionurl eq '/adm/portfolio') ||
12898: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12899: my ($sublistref,$listerror) =
12900: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12901: if (ref($sublistref) eq 'ARRAY') {
12902: foreach my $line (@{$sublistref}) {
12903: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12904: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12905: }
1.984 raeburn 12906: }
1.987 raeburn 12907: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12908: if (opendir(my $dir,$url.'/'.$path)) {
12909: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12910: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12911: }
1.1084 raeburn 12912: } elsif (($actionurl eq '/adm/dependencies') ||
12913: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12914: ($args->{'context'} eq 'paste')) ||
12915: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12916: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12917: my $dir;
12918: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12919: $dir = $fileloc;
12920: } else {
12921: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12922: }
1.1071 raeburn 12923: if ($dir ne '') {
12924: my ($sublistref,$listerror) =
12925: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12926: if (ref($sublistref) eq 'ARRAY') {
12927: foreach my $line (@{$sublistref}) {
12928: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12929: undef,$mtime)=split(/\&/,$line,12);
12930: unless (($testdir&$dirptr) ||
12931: ($file_name =~ /^\.\.?$/)) {
12932: $currsubfile{$path}{$file_name} = [$size,$mtime];
12933: }
12934: }
12935: }
12936: }
1.984 raeburn 12937: }
12938: }
12939: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12940: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12941: my $item = $path.'/'.$file;
12942: unless ($mapping{$item} eq $item) {
12943: $pathchanges{$item} = 1;
12944: }
12945: $existing{$item} = 1;
12946: $numexisting ++;
12947: } else {
12948: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12949: }
12950: }
1.1071 raeburn 12951: if ($actionurl eq '/adm/dependencies') {
12952: foreach my $path (keys(%currsubfile)) {
12953: if (ref($currsubfile{$path}) eq 'HASH') {
12954: foreach my $file (keys(%{$currsubfile{$path}})) {
12955: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12956: next if (($rem ne '') &&
12957: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12958: (ref($navmap) &&
12959: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12960: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12961: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12962: $unused{$path.'/'.$file} = 1;
12963: }
12964: }
12965: }
12966: }
12967: }
1.984 raeburn 12968: }
1.1249 damieng 12969:
12970: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12971: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12972: my %currfile;
1.1123 raeburn 12973: if (($actionurl eq '/adm/portfolio') ||
12974: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12975: my ($dirlistref,$listerror) =
12976: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12977: if (ref($dirlistref) eq 'ARRAY') {
12978: foreach my $line (@{$dirlistref}) {
12979: my ($file_name,$rest) = split(/\&/,$line,2);
12980: $currfile{$file_name} = 1;
12981: }
1.984 raeburn 12982: }
1.987 raeburn 12983: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12984: if (opendir(my $dir,$url)) {
1.987 raeburn 12985: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12986: map {$currfile{$_} = 1;} @dir_list;
12987: }
1.1084 raeburn 12988: } elsif (($actionurl eq '/adm/dependencies') ||
12989: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12990: ($args->{'context'} eq 'paste')) ||
12991: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12992: if ($env{'request.course.id'} ne '') {
12993: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12994: if ($dir ne '') {
12995: my ($dirlistref,$listerror) =
12996: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12997: if (ref($dirlistref) eq 'ARRAY') {
12998: foreach my $line (@{$dirlistref}) {
12999: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
13000: $size,undef,$mtime)=split(/\&/,$line,12);
13001: unless (($testdir&$dirptr) ||
13002: ($file_name =~ /^\.\.?$/)) {
13003: $currfile{$file_name} = [$size,$mtime];
13004: }
13005: }
13006: }
13007: }
13008: }
1.984 raeburn 13009: }
1.1249 damieng 13010: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
13011: # are not in subdirectories, using $currfile
1.984 raeburn 13012: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 13013: if (exists($currfile{$file})) {
1.987 raeburn 13014: unless ($mapping{$file} eq $file) {
13015: $pathchanges{$file} = 1;
13016: }
13017: $existing{$file} = 1;
13018: $numexisting ++;
13019: } else {
1.984 raeburn 13020: $newfiles{$file} = 1;
13021: }
13022: }
1.1071 raeburn 13023: foreach my $file (keys(%currfile)) {
13024: unless (($file eq $filename) ||
13025: ($file eq $filename.'.bak') ||
13026: ($dependencies{$file})) {
1.1085 raeburn 13027: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 13028: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
13029: next if (($rem ne '') &&
13030: (($env{"httpref.$rem".$file} ne '') ||
13031: (ref($navmap) &&
13032: (($navmap->getResourceByUrl($rem.$file) ne '') ||
13033: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13034: ($navmap->getResourceByUrl($rem.$1)))))));
13035: }
1.1085 raeburn 13036: }
1.1071 raeburn 13037: $unused{$file} = 1;
13038: }
13039: }
1.1249 damieng 13040:
13041: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 13042: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
13043: ($args->{'context'} eq 'paste')) {
13044: $counter = scalar(keys(%existing));
13045: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 13046: return ($output,$counter,$numpathchg,\%existing);
13047: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
13048: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
13049: $counter = scalar(keys(%existing));
13050: $numpathchg = scalar(keys(%pathchanges));
13051: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13052: }
1.1249 damieng 13053:
13054: # returns HTML otherwise, with dependency results and to ask for more uploads
13055:
13056: # $upload_output: missing dependencies (with upload form)
13057: # $modify_output: uploaded dependencies (in use)
13058: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13059: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13060: if ($actionurl eq '/adm/dependencies') {
13061: next if ($embed_file =~ m{^\w+://});
13062: }
1.660 raeburn 13063: $upload_output .= &start_data_table_row().
1.1123 raeburn 13064: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13065: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13066: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13067: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13068: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13069: }
1.1123 raeburn 13070: $upload_output .= '</td>';
1.1071 raeburn 13071: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13072: $upload_output.='<td align="right">'.
13073: '<span class="LC_info LC_fontsize_medium">'.
13074: &mt("URL points to web address").'</span>';
1.987 raeburn 13075: $numremref++;
1.660 raeburn 13076: } elsif ($args->{'error_on_invalid_names'}
13077: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13078: $upload_output.='<td align="right"><span class="LC_warning">'.
13079: &mt('Invalid characters').'</span>';
1.987 raeburn 13080: $numinvalid++;
1.660 raeburn 13081: } else {
1.1123 raeburn 13082: $upload_output .= '<td>'.
13083: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13084: $embed_file,\%mapping,
1.1071 raeburn 13085: $allfiles,$codebase,'upload');
13086: $counter ++;
13087: $numnew ++;
1.987 raeburn 13088: }
13089: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13090: }
13091: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13092: if ($actionurl eq '/adm/dependencies') {
13093: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13094: $modify_output .= &start_data_table_row().
13095: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13096: '<img src="'.&icon($embed_file).'" border="0" />'.
13097: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13098: '<td>'.$size.'</td>'.
13099: '<td>'.$mtime.'</td>'.
13100: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13101: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13102: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13103: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13104: &embedded_file_element('upload_embedded',$counter,
13105: $embed_file,\%mapping,
13106: $allfiles,$codebase,'modify').
13107: '</div></td>'.
13108: &end_data_table_row()."\n";
13109: $counter ++;
13110: } else {
13111: $upload_output .= &start_data_table_row().
1.1123 raeburn 13112: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13113: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13114: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13115: &Apache::loncommon::end_data_table_row()."\n";
13116: }
13117: }
13118: my $delidx = $counter;
13119: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13120: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13121: $delete_output .= &start_data_table_row().
13122: '<td><img src="'.&icon($oldfile).'" />'.
13123: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13124: '<td>'.$size.'</td>'.
13125: '<td>'.$mtime.'</td>'.
13126: '<td><label><input type="checkbox" name="del_upload_dep" '.
13127: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13128: &embedded_file_element('upload_embedded',$delidx,
13129: $oldfile,\%mapping,$allfiles,
13130: $codebase,'delete').'</td>'.
13131: &end_data_table_row()."\n";
13132: $numunused ++;
13133: $delidx ++;
1.987 raeburn 13134: }
13135: if ($upload_output) {
13136: $upload_output = &start_data_table().
13137: $upload_output.
13138: &end_data_table()."\n";
13139: }
1.1071 raeburn 13140: if ($modify_output) {
13141: $modify_output = &start_data_table().
13142: &start_data_table_header_row().
13143: '<th>'.&mt('File').'</th>'.
13144: '<th>'.&mt('Size (KB)').'</th>'.
13145: '<th>'.&mt('Modified').'</th>'.
13146: '<th>'.&mt('Upload replacement?').'</th>'.
13147: &end_data_table_header_row().
13148: $modify_output.
13149: &end_data_table()."\n";
13150: }
13151: if ($delete_output) {
13152: $delete_output = &start_data_table().
13153: &start_data_table_header_row().
13154: '<th>'.&mt('File').'</th>'.
13155: '<th>'.&mt('Size (KB)').'</th>'.
13156: '<th>'.&mt('Modified').'</th>'.
13157: '<th>'.&mt('Delete?').'</th>'.
13158: &end_data_table_header_row().
13159: $delete_output.
13160: &end_data_table()."\n";
13161: }
1.987 raeburn 13162: my $applies = 0;
13163: if ($numremref) {
13164: $applies ++;
13165: }
13166: if ($numinvalid) {
13167: $applies ++;
13168: }
13169: if ($numexisting) {
13170: $applies ++;
13171: }
1.1071 raeburn 13172: if ($counter || $numunused) {
1.987 raeburn 13173: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13174: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13175: $state.'<h3>'.$heading.'</h3>';
13176: if ($actionurl eq '/adm/dependencies') {
13177: if ($numnew) {
13178: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13179: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13180: $upload_output.'<br />'."\n";
13181: }
13182: if ($numexisting) {
13183: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13184: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13185: $modify_output.'<br />'."\n";
13186: $buttontext = &mt('Save changes');
13187: }
13188: if ($numunused) {
13189: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13190: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13191: $delete_output.'<br />'."\n";
13192: $buttontext = &mt('Save changes');
13193: }
13194: } else {
13195: $output .= $upload_output.'<br />'."\n";
13196: }
13197: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13198: $counter.'" />'."\n";
13199: if ($actionurl eq '/adm/dependencies') {
13200: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13201: $numnew.'" />'."\n";
13202: } elsif ($actionurl eq '') {
1.987 raeburn 13203: $output .= '<input type="hidden" name="phase" value="three" />';
13204: }
13205: } elsif ($applies) {
13206: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13207: if ($applies > 1) {
13208: $output .=
1.1123 raeburn 13209: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13210: if ($numremref) {
13211: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13212: }
13213: if ($numinvalid) {
13214: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13215: }
13216: if ($numexisting) {
13217: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13218: }
13219: $output .= '</ul><br />';
13220: } elsif ($numremref) {
13221: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13222: } elsif ($numinvalid) {
13223: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13224: } elsif ($numexisting) {
13225: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13226: }
13227: $output .= $upload_output.'<br />';
13228: }
13229: my ($pathchange_output,$chgcount);
1.1071 raeburn 13230: $chgcount = $counter;
1.987 raeburn 13231: if (keys(%pathchanges) > 0) {
13232: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13233: if ($counter) {
1.987 raeburn 13234: $output .= &embedded_file_element('pathchange',$chgcount,
13235: $embed_file,\%mapping,
1.1071 raeburn 13236: $allfiles,$codebase,'change');
1.987 raeburn 13237: } else {
13238: $pathchange_output .=
13239: &start_data_table_row().
13240: '<td><input type ="checkbox" name="namechange" value="'.
13241: $chgcount.'" checked="checked" /></td>'.
13242: '<td>'.$mapping{$embed_file}.'</td>'.
13243: '<td>'.$embed_file.
13244: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13245: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13246: '</td>'.&end_data_table_row();
1.660 raeburn 13247: }
1.987 raeburn 13248: $numpathchg ++;
13249: $chgcount ++;
1.660 raeburn 13250: }
13251: }
1.1127 raeburn 13252: if (($counter) || ($numunused)) {
1.987 raeburn 13253: if ($numpathchg) {
13254: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13255: $numpathchg.'" />'."\n";
13256: }
13257: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13258: ($actionurl eq '/adm/imsimport')) {
13259: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13260: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13261: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13262: } elsif ($actionurl eq '/adm/dependencies') {
13263: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13264: }
1.1123 raeburn 13265: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13266: } elsif ($numpathchg) {
13267: my %pathchange = ();
13268: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13269: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13270: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13271: }
1.987 raeburn 13272: }
1.1071 raeburn 13273: return ($output,$counter,$numpathchg);
1.987 raeburn 13274: }
13275:
1.1147 raeburn 13276: =pod
13277:
13278: =item * clean_path($name)
13279:
13280: Performs clean-up of directories, subdirectories and filename in an
13281: embedded object, referenced in an HTML file which is being uploaded
13282: to a course or portfolio, where
13283: "Upload embedded images/multimedia files if HTML file" checkbox was
13284: checked.
13285:
13286: Clean-up is similar to replacements in lonnet::clean_filename()
13287: except each / between sub-directory and next level is preserved.
13288:
13289: =cut
13290:
13291: sub clean_path {
13292: my ($embed_file) = @_;
13293: $embed_file =~s{^/+}{};
13294: my @contents;
13295: if ($embed_file =~ m{/}) {
13296: @contents = split(/\//,$embed_file);
13297: } else {
13298: @contents = ($embed_file);
13299: }
13300: my $lastidx = scalar(@contents)-1;
13301: for (my $i=0; $i<=$lastidx; $i++) {
13302: $contents[$i]=~s{\\}{/}g;
13303: $contents[$i]=~s/\s+/\_/g;
13304: $contents[$i]=~s{[^/\w\.\-]}{}g;
13305: if ($i == $lastidx) {
13306: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13307: }
13308: }
13309: if ($lastidx > 0) {
13310: return join('/',@contents);
13311: } else {
13312: return $contents[0];
13313: }
13314: }
13315:
1.987 raeburn 13316: sub embedded_file_element {
1.1071 raeburn 13317: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13318: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13319: (ref($codebase) eq 'HASH'));
13320: my $output;
1.1071 raeburn 13321: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13322: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13323: }
13324: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13325: &escape($embed_file).'" />';
13326: unless (($context eq 'upload_embedded') &&
13327: ($mapping->{$embed_file} eq $embed_file)) {
13328: $output .='
13329: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13330: }
13331: my $attrib;
13332: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13333: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13334: }
13335: $output .=
13336: "\n\t\t".
13337: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13338: $attrib.'" />';
13339: if (exists($codebase->{$mapping->{$embed_file}})) {
13340: $output .=
13341: "\n\t\t".
13342: '<input name="codebase_'.$num.'" type="hidden" value="'.
13343: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13344: }
1.987 raeburn 13345: return $output;
1.660 raeburn 13346: }
13347:
1.1071 raeburn 13348: sub get_dependency_details {
13349: my ($currfile,$currsubfile,$embed_file) = @_;
13350: my ($size,$mtime,$showsize,$showmtime);
13351: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13352: if ($embed_file =~ m{/}) {
13353: my ($path,$fname) = split(/\//,$embed_file);
13354: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13355: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13356: }
13357: } else {
13358: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13359: ($size,$mtime) = @{$currfile->{$embed_file}};
13360: }
13361: }
13362: $showsize = $size/1024.0;
13363: $showsize = sprintf("%.1f",$showsize);
13364: if ($mtime > 0) {
13365: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13366: }
13367: }
13368: return ($showsize,$showmtime);
13369: }
13370:
13371: sub ask_embedded_js {
13372: return <<"END";
13373: <script type="text/javascript"">
13374: // <![CDATA[
13375: function toggleBrowse(counter) {
13376: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13377: var fileid = document.getElementById('embedded_item_'+counter);
13378: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13379: if (chkboxid.checked == true) {
13380: uploaddivid.style.display='block';
13381: } else {
13382: uploaddivid.style.display='none';
13383: fileid.value = '';
13384: }
13385: }
13386: // ]]>
13387: </script>
13388:
13389: END
13390: }
13391:
1.661 raeburn 13392: sub upload_embedded {
13393: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13394: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13395: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13396: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13397: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13398: my $orig_uploaded_filename =
13399: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13400: foreach my $type ('orig','ref','attrib','codebase') {
13401: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13402: $env{'form.embedded_'.$type.'_'.$i} =
13403: &unescape($env{'form.embedded_'.$type.'_'.$i});
13404: }
13405: }
1.661 raeburn 13406: my ($path,$fname) =
13407: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13408: # no path, whole string is fname
13409: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13410: $fname = &Apache::lonnet::clean_filename($fname);
13411: # See if there is anything left
13412: next if ($fname eq '');
13413:
13414: # Check if file already exists as a file or directory.
13415: my ($state,$msg);
13416: if ($context eq 'portfolio') {
13417: my $port_path = $dirpath;
13418: if ($group ne '') {
13419: $port_path = "groups/$group/$port_path";
13420: }
1.987 raeburn 13421: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13422: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13423: $dir_root,$port_path,$disk_quota,
13424: $current_disk_usage,$uname,$udom);
13425: if ($state eq 'will_exceed_quota'
1.984 raeburn 13426: || $state eq 'file_locked') {
1.661 raeburn 13427: $output .= $msg;
13428: next;
13429: }
13430: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13431: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13432: if ($state eq 'exists') {
13433: $output .= $msg;
13434: next;
13435: }
13436: }
13437: # Check if extension is valid
13438: if (($fname =~ /\.(\w+)$/) &&
13439: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13440: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13441: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13442: next;
13443: } elsif (($fname =~ /\.(\w+)$/) &&
13444: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13445: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13446: next;
13447: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13448: $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 13449: next;
13450: }
13451: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13452: my $subdir = $path;
13453: $subdir =~ s{/+$}{};
1.661 raeburn 13454: if ($context eq 'portfolio') {
1.984 raeburn 13455: my $result;
13456: if ($state eq 'existingfile') {
13457: $result=
13458: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13459: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13460: } else {
1.984 raeburn 13461: $result=
13462: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13463: $dirpath.
1.1123 raeburn 13464: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13465: if ($result !~ m|^/uploaded/|) {
13466: $output .= '<span class="LC_error">'
13467: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13468: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13469: .'</span><br />';
13470: next;
13471: } else {
1.987 raeburn 13472: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13473: $path.$fname.'</span>').'<br />';
1.984 raeburn 13474: }
1.661 raeburn 13475: }
1.1123 raeburn 13476: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13477: my $extendedsubdir = $dirpath.'/'.$subdir;
13478: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13479: my $result =
1.1126 raeburn 13480: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13481: if ($result !~ m|^/uploaded/|) {
13482: $output .= '<span class="LC_error">'
13483: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13484: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13485: .'</span><br />';
13486: next;
13487: } else {
13488: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13489: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13490: if ($context eq 'syllabus') {
13491: &Apache::lonnet::make_public_indefinitely($result);
13492: }
1.987 raeburn 13493: }
1.661 raeburn 13494: } else {
13495: # Save the file
13496: my $target = $env{'form.embedded_item_'.$i};
13497: my $fullpath = $dir_root.$dirpath.'/'.$path;
13498: my $dest = $fullpath.$fname;
13499: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13500: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13501: my $count;
13502: my $filepath = $dir_root;
1.1027 raeburn 13503: foreach my $subdir (@parts) {
13504: $filepath .= "/$subdir";
13505: if (!-e $filepath) {
1.661 raeburn 13506: mkdir($filepath,0770);
13507: }
13508: }
13509: my $fh;
13510: if (!open($fh,'>'.$dest)) {
13511: &Apache::lonnet::logthis('Failed to create '.$dest);
13512: $output .= '<span class="LC_error">'.
1.1071 raeburn 13513: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13514: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13515: '</span><br />';
13516: } else {
13517: if (!print $fh $env{'form.embedded_item_'.$i}) {
13518: &Apache::lonnet::logthis('Failed to write to '.$dest);
13519: $output .= '<span class="LC_error">'.
1.1071 raeburn 13520: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13521: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13522: '</span><br />';
13523: } else {
1.987 raeburn 13524: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13525: $url.'</span>').'<br />';
13526: unless ($context eq 'testbank') {
13527: $footer .= &mt('View embedded file: [_1]',
13528: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13529: }
13530: }
13531: close($fh);
13532: }
13533: }
13534: if ($env{'form.embedded_ref_'.$i}) {
13535: $pathchange{$i} = 1;
13536: }
13537: }
13538: if ($output) {
13539: $output = '<p>'.$output.'</p>';
13540: }
13541: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13542: $returnflag = 'ok';
1.1071 raeburn 13543: my $numpathchgs = scalar(keys(%pathchange));
13544: if ($numpathchgs > 0) {
1.987 raeburn 13545: if ($context eq 'portfolio') {
13546: $output .= '<p>'.&mt('or').'</p>';
13547: } elsif ($context eq 'testbank') {
1.1071 raeburn 13548: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13549: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13550: $returnflag = 'modify_orightml';
13551: }
13552: }
1.1071 raeburn 13553: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13554: }
13555:
13556: sub modify_html_form {
13557: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13558: my $end = 0;
13559: my $modifyform;
13560: if ($context eq 'upload_embedded') {
13561: return unless (ref($pathchange) eq 'HASH');
13562: if ($env{'form.number_embedded_items'}) {
13563: $end += $env{'form.number_embedded_items'};
13564: }
13565: if ($env{'form.number_pathchange_items'}) {
13566: $end += $env{'form.number_pathchange_items'};
13567: }
13568: if ($end) {
13569: for (my $i=0; $i<$end; $i++) {
13570: if ($i < $env{'form.number_embedded_items'}) {
13571: next unless($pathchange->{$i});
13572: }
13573: $modifyform .=
13574: &start_data_table_row().
13575: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13576: 'checked="checked" /></td>'.
13577: '<td>'.$env{'form.embedded_ref_'.$i}.
13578: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13579: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13580: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13581: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13582: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13583: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13584: '<td>'.$env{'form.embedded_orig_'.$i}.
13585: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13586: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13587: &end_data_table_row();
1.1071 raeburn 13588: }
1.987 raeburn 13589: }
13590: } else {
13591: $modifyform = $pathchgtable;
13592: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13593: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13594: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13595: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13596: }
13597: }
13598: if ($modifyform) {
1.1071 raeburn 13599: if ($actionurl eq '/adm/dependencies') {
13600: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13601: }
1.987 raeburn 13602: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13603: '<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".
13604: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13605: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13606: '</ol></p>'."\n".'<p>'.
13607: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13608: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13609: &start_data_table()."\n".
13610: &start_data_table_header_row().
13611: '<th>'.&mt('Change?').'</th>'.
13612: '<th>'.&mt('Current reference').'</th>'.
13613: '<th>'.&mt('Required reference').'</th>'.
13614: &end_data_table_header_row()."\n".
13615: $modifyform.
13616: &end_data_table().'<br />'."\n".$hiddenstate.
13617: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13618: '</form>'."\n";
13619: }
13620: return;
13621: }
13622:
13623: sub modify_html_refs {
1.1123 raeburn 13624: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13625: my $container;
13626: if ($context eq 'portfolio') {
13627: $container = $env{'form.container'};
13628: } elsif ($context eq 'coursedoc') {
13629: $container = $env{'form.primaryurl'};
1.1071 raeburn 13630: } elsif ($context eq 'manage_dependencies') {
13631: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13632: $container = "/$container";
1.1123 raeburn 13633: } elsif ($context eq 'syllabus') {
13634: $container = $url;
1.987 raeburn 13635: } else {
1.1027 raeburn 13636: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13637: }
13638: my (%allfiles,%codebase,$output,$content);
13639: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13640: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13641: if (wantarray) {
13642: return ('',0,0);
13643: } else {
13644: return;
13645: }
13646: }
13647: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13648: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13649: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13650: if (wantarray) {
13651: return ('',0,0);
13652: } else {
13653: return;
13654: }
13655: }
1.987 raeburn 13656: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13657: if ($content eq '-1') {
13658: if (wantarray) {
13659: return ('',0,0);
13660: } else {
13661: return;
13662: }
13663: }
1.987 raeburn 13664: } else {
1.1071 raeburn 13665: unless ($container =~ /^\Q$dir_root\E/) {
13666: if (wantarray) {
13667: return ('',0,0);
13668: } else {
13669: return;
13670: }
13671: }
1.1317 raeburn 13672: if (open(my $fh,'<',$container)) {
1.987 raeburn 13673: $content = join('', <$fh>);
13674: close($fh);
13675: } else {
1.1071 raeburn 13676: if (wantarray) {
13677: return ('',0,0);
13678: } else {
13679: return;
13680: }
1.987 raeburn 13681: }
13682: }
13683: my ($count,$codebasecount) = (0,0);
13684: my $mm = new File::MMagic;
13685: my $mime_type = $mm->checktype_contents($content);
13686: if ($mime_type eq 'text/html') {
13687: my $parse_result =
13688: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13689: \%codebase,\$content);
13690: if ($parse_result eq 'ok') {
13691: foreach my $i (@changes) {
13692: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13693: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13694: if ($allfiles{$ref}) {
13695: my $newname = $orig;
13696: my ($attrib_regexp,$codebase);
1.1006 raeburn 13697: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13698: if ($attrib_regexp =~ /:/) {
13699: $attrib_regexp =~ s/\:/|/g;
13700: }
13701: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13702: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13703: $count += $numchg;
1.1123 raeburn 13704: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13705: delete($allfiles{$ref});
1.987 raeburn 13706: }
13707: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13708: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13709: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13710: $codebasecount ++;
13711: }
13712: }
13713: }
1.1123 raeburn 13714: my $skiprewrites;
1.987 raeburn 13715: if ($count || $codebasecount) {
13716: my $saveresult;
1.1071 raeburn 13717: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13718: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13719: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13720: if ($url eq $container) {
13721: my ($fname) = ($container =~ m{/([^/]+)$});
13722: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13723: $count,'<span class="LC_filename">'.
1.1071 raeburn 13724: $fname.'</span>').'</p>';
1.987 raeburn 13725: } else {
13726: $output = '<p class="LC_error">'.
13727: &mt('Error: update failed for: [_1].',
13728: '<span class="LC_filename">'.
13729: $container.'</span>').'</p>';
13730: }
1.1123 raeburn 13731: if ($context eq 'syllabus') {
13732: unless ($saveresult eq 'ok') {
13733: $skiprewrites = 1;
13734: }
13735: }
1.987 raeburn 13736: } else {
1.1317 raeburn 13737: if (open(my $fh,'>',$container)) {
1.987 raeburn 13738: print $fh $content;
13739: close($fh);
13740: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13741: $count,'<span class="LC_filename">'.
13742: $container.'</span>').'</p>';
1.661 raeburn 13743: } else {
1.987 raeburn 13744: $output = '<p class="LC_error">'.
13745: &mt('Error: could not update [_1].',
13746: '<span class="LC_filename">'.
13747: $container.'</span>').'</p>';
1.661 raeburn 13748: }
13749: }
13750: }
1.1123 raeburn 13751: if (($context eq 'syllabus') && (!$skiprewrites)) {
13752: my ($actionurl,$state);
13753: $actionurl = "/public/$udom/$uname/syllabus";
13754: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13755: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13756: \%codebase,
13757: {'context' => 'rewrites',
13758: 'ignore_remote_references' => 1,});
13759: if (ref($mapping) eq 'HASH') {
13760: my $rewrites = 0;
13761: foreach my $key (keys(%{$mapping})) {
13762: next if ($key =~ m{^https?://});
13763: my $ref = $mapping->{$key};
13764: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13765: my $attrib;
13766: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13767: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13768: }
13769: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13770: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13771: $rewrites += $numchg;
13772: }
13773: }
13774: if ($rewrites) {
13775: my $saveresult;
13776: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13777: if ($url eq $container) {
13778: my ($fname) = ($container =~ m{/([^/]+)$});
13779: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13780: $count,'<span class="LC_filename">'.
13781: $fname.'</span>').'</p>';
13782: } else {
13783: $output .= '<p class="LC_error">'.
13784: &mt('Error: could not update links in [_1].',
13785: '<span class="LC_filename">'.
13786: $container.'</span>').'</p>';
13787:
13788: }
13789: }
13790: }
13791: }
1.987 raeburn 13792: } else {
13793: &logthis('Failed to parse '.$container.
13794: ' to modify references: '.$parse_result);
1.661 raeburn 13795: }
13796: }
1.1071 raeburn 13797: if (wantarray) {
13798: return ($output,$count,$codebasecount);
13799: } else {
13800: return $output;
13801: }
1.661 raeburn 13802: }
13803:
13804: sub check_for_existing {
13805: my ($path,$fname,$element) = @_;
13806: my ($state,$msg);
13807: if (-d $path.'/'.$fname) {
13808: $state = 'exists';
13809: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13810: } elsif (-e $path.'/'.$fname) {
13811: $state = 'exists';
13812: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13813: }
13814: if ($state eq 'exists') {
13815: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13816: }
13817: return ($state,$msg);
13818: }
13819:
13820: sub check_for_upload {
13821: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13822: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13823: my $filesize = length($env{'form.'.$element});
13824: if (!$filesize) {
13825: my $msg = '<span class="LC_error">'.
13826: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13827: '<span class="LC_filename">'.$fname.'</span>',
13828: $filesize).'<br />'.
1.1007 raeburn 13829: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13830: '</span>';
13831: return ('zero_bytes',$msg);
13832: }
13833: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13834: my $getpropath = 1;
1.1021 raeburn 13835: my ($dirlistref,$listerror) =
13836: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13837: my $found_file = 0;
13838: my $locked_file = 0;
1.991 raeburn 13839: my @lockers;
13840: my $navmap;
13841: if ($env{'request.course.id'}) {
13842: $navmap = Apache::lonnavmaps::navmap->new();
13843: }
1.1021 raeburn 13844: if (ref($dirlistref) eq 'ARRAY') {
13845: foreach my $line (@{$dirlistref}) {
13846: my ($file_name,$rest)=split(/\&/,$line,2);
13847: if ($file_name eq $fname){
13848: $file_name = $path.$file_name;
13849: if ($group ne '') {
13850: $file_name = $group.$file_name;
13851: }
13852: $found_file = 1;
13853: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13854: foreach my $lock (@lockers) {
13855: if (ref($lock) eq 'ARRAY') {
13856: my ($symb,$crsid) = @{$lock};
13857: if ($crsid eq $env{'request.course.id'}) {
13858: if (ref($navmap)) {
13859: my $res = $navmap->getBySymb($symb);
13860: foreach my $part (@{$res->parts()}) {
13861: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13862: unless (($slot_status == $res->RESERVED) ||
13863: ($slot_status == $res->RESERVED_LOCATION)) {
13864: $locked_file = 1;
13865: }
1.991 raeburn 13866: }
1.1021 raeburn 13867: } else {
13868: $locked_file = 1;
1.991 raeburn 13869: }
13870: } else {
13871: $locked_file = 1;
13872: }
13873: }
1.1021 raeburn 13874: }
13875: } else {
13876: my @info = split(/\&/,$rest);
13877: my $currsize = $info[6]/1000;
13878: if ($currsize < $filesize) {
13879: my $extra = $filesize - $currsize;
13880: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13881: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13882: &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 13883: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13884: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13885: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13886: return ('will_exceed_quota',$msg);
13887: }
1.984 raeburn 13888: }
13889: }
1.661 raeburn 13890: }
13891: }
13892: }
13893: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13894: my $msg = '<p class="LC_warning">'.
13895: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13896: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13897: return ('will_exceed_quota',$msg);
13898: } elsif ($found_file) {
13899: if ($locked_file) {
1.1179 bisitz 13900: my $msg = '<p class="LC_warning">';
1.661 raeburn 13901: $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 13902: $msg .= '</p>';
1.661 raeburn 13903: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13904: return ('file_locked',$msg);
13905: } else {
1.1179 bisitz 13906: my $msg = '<p class="LC_error">';
1.984 raeburn 13907: $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 13908: $msg .= '</p>';
1.984 raeburn 13909: return ('existingfile',$msg);
1.661 raeburn 13910: }
13911: }
13912: }
13913:
1.987 raeburn 13914: sub check_for_traversal {
13915: my ($path,$url,$toplevel) = @_;
13916: my @parts=split(/\//,$path);
13917: my $cleanpath;
13918: my $fullpath = $url;
13919: for (my $i=0;$i<@parts;$i++) {
13920: next if ($parts[$i] eq '.');
13921: if ($parts[$i] eq '..') {
13922: $fullpath =~ s{([^/]+/)$}{};
13923: } else {
13924: $fullpath .= $parts[$i].'/';
13925: }
13926: }
13927: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13928: $cleanpath = $1;
13929: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13930: my $curr_toprel = $1;
13931: my @parts = split(/\//,$curr_toprel);
13932: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13933: my @urlparts = split(/\//,$url_toprel);
13934: my $doubledots;
13935: my $startdiff = -1;
13936: for (my $i=0; $i<@urlparts; $i++) {
13937: if ($startdiff == -1) {
13938: unless ($urlparts[$i] eq $parts[$i]) {
13939: $startdiff = $i;
13940: $doubledots .= '../';
13941: }
13942: } else {
13943: $doubledots .= '../';
13944: }
13945: }
13946: if ($startdiff > -1) {
13947: $cleanpath = $doubledots;
13948: for (my $i=$startdiff; $i<@parts; $i++) {
13949: $cleanpath .= $parts[$i].'/';
13950: }
13951: }
13952: }
13953: $cleanpath =~ s{(/)$}{};
13954: return $cleanpath;
13955: }
1.31 albertel 13956:
1.1053 raeburn 13957: sub is_archive_file {
13958: my ($mimetype) = @_;
13959: if (($mimetype eq 'application/octet-stream') ||
13960: ($mimetype eq 'application/x-stuffit') ||
13961: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13962: return 1;
13963: }
13964: return;
13965: }
13966:
13967: sub decompress_form {
1.1065 raeburn 13968: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13969: my %lt = &Apache::lonlocal::texthash (
13970: this => 'This file is an archive file.',
1.1067 raeburn 13971: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13972: itsc => 'Its contents are as follows:',
1.1053 raeburn 13973: youm => 'You may wish to extract its contents.',
13974: extr => 'Extract contents',
1.1067 raeburn 13975: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13976: proa => 'Process automatically?',
1.1053 raeburn 13977: yes => 'Yes',
13978: no => 'No',
1.1067 raeburn 13979: fold => 'Title for folder containing movie',
13980: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13981: );
1.1065 raeburn 13982: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13983: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13984: my $info = &list_archive_contents($fileloc,\@paths);
13985: if (@paths) {
13986: foreach my $path (@paths) {
13987: $path =~ s{^/}{};
1.1067 raeburn 13988: if ($path =~ m{^([^/]+)/$}) {
13989: $topdir = $1;
13990: }
1.1065 raeburn 13991: if ($path =~ m{^([^/]+)/}) {
13992: $toplevel{$1} = $path;
13993: } else {
13994: $toplevel{$path} = $path;
13995: }
13996: }
13997: }
1.1067 raeburn 13998: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13999: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 14000: "$topdir/media/",
14001: "$topdir/media/$topdir.mp4",
14002: "$topdir/media/FirstFrame.png",
14003: "$topdir/media/player.swf",
14004: "$topdir/media/swfobject.js",
14005: "$topdir/media/expressInstall.swf");
1.1197 raeburn 14006: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 14007: "$topdir/$topdir.mp4",
14008: "$topdir/$topdir\_config.xml",
14009: "$topdir/$topdir\_controller.swf",
14010: "$topdir/$topdir\_embed.css",
14011: "$topdir/$topdir\_First_Frame.png",
14012: "$topdir/$topdir\_player.html",
14013: "$topdir/$topdir\_Thumbnails.png",
14014: "$topdir/playerProductInstall.swf",
14015: "$topdir/scripts/",
14016: "$topdir/scripts/config_xml.js",
14017: "$topdir/scripts/handlebars.js",
14018: "$topdir/scripts/jquery-1.7.1.min.js",
14019: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
14020: "$topdir/scripts/modernizr.js",
14021: "$topdir/scripts/player-min.js",
14022: "$topdir/scripts/swfobject.js",
14023: "$topdir/skins/",
14024: "$topdir/skins/configuration_express.xml",
14025: "$topdir/skins/express_show/",
14026: "$topdir/skins/express_show/player-min.css",
14027: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 14028: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
14029: "$topdir/$topdir.mp4",
14030: "$topdir/$topdir\_config.xml",
14031: "$topdir/$topdir\_controller.swf",
14032: "$topdir/$topdir\_embed.css",
14033: "$topdir/$topdir\_First_Frame.png",
14034: "$topdir/$topdir\_player.html",
14035: "$topdir/$topdir\_Thumbnails.png",
14036: "$topdir/playerProductInstall.swf",
14037: "$topdir/scripts/",
14038: "$topdir/scripts/config_xml.js",
14039: "$topdir/scripts/techsmith-smart-player.min.js",
14040: "$topdir/skins/",
14041: "$topdir/skins/configuration_express.xml",
14042: "$topdir/skins/express_show/",
14043: "$topdir/skins/express_show/spritesheet.min.css",
14044: "$topdir/skins/express_show/spritesheet.png",
14045: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 14046: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 14047: if (@diffs == 0) {
1.1164 raeburn 14048: $is_camtasia = 6;
14049: } else {
1.1197 raeburn 14050: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 14051: if (@diffs == 0) {
14052: $is_camtasia = 8;
1.1197 raeburn 14053: } else {
14054: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14055: if (@diffs == 0) {
14056: $is_camtasia = 8;
14057: }
1.1164 raeburn 14058: }
1.1067 raeburn 14059: }
14060: }
14061: my $output;
14062: if ($is_camtasia) {
14063: $output = <<"ENDCAM";
14064: <script type="text/javascript" language="Javascript">
14065: // <![CDATA[
14066:
14067: function camtasiaToggle() {
14068: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14069: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14070: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14071: document.getElementById('camtasia_titles').style.display='block';
14072: } else {
14073: document.getElementById('camtasia_titles').style.display='none';
14074: }
14075: }
14076: }
14077: return;
14078: }
14079:
14080: // ]]>
14081: </script>
14082: <p>$lt{'camt'}</p>
14083: ENDCAM
1.1065 raeburn 14084: } else {
1.1067 raeburn 14085: $output = '<p>'.$lt{'this'};
14086: if ($info eq '') {
14087: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14088: } else {
14089: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14090: '<div><pre>'.$info.'</pre></div>';
14091: }
1.1065 raeburn 14092: }
1.1067 raeburn 14093: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14094: my $duplicates;
14095: my $num = 0;
14096: if (ref($dirlist) eq 'ARRAY') {
14097: foreach my $item (@{$dirlist}) {
14098: if (ref($item) eq 'ARRAY') {
14099: if (exists($toplevel{$item->[0]})) {
14100: $duplicates .=
14101: &start_data_table_row().
14102: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14103: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14104: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14105: 'value="1" />'.&mt('Yes').'</label>'.
14106: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14107: '<td>'.$item->[0].'</td>';
14108: if ($item->[2]) {
14109: $duplicates .= '<td>'.&mt('Directory').'</td>';
14110: } else {
14111: $duplicates .= '<td>'.&mt('File').'</td>';
14112: }
14113: $duplicates .= '<td>'.$item->[3].'</td>'.
14114: '<td>'.
14115: &Apache::lonlocal::locallocaltime($item->[4]).
14116: '</td>'.
14117: &end_data_table_row();
14118: $num ++;
14119: }
14120: }
14121: }
14122: }
14123: my $itemcount;
14124: if (@paths > 0) {
14125: $itemcount = scalar(@paths);
14126: } else {
14127: $itemcount = 1;
14128: }
1.1067 raeburn 14129: if ($is_camtasia) {
14130: $output .= $lt{'auto'}.'<br />'.
14131: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14132: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14133: $lt{'yes'}.'</label> <label>'.
14134: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14135: $lt{'no'}.'</label></span><br />'.
14136: '<div id="camtasia_titles" style="display:block">'.
14137: &Apache::lonhtmlcommon::start_pick_box().
14138: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14139: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14140: &Apache::lonhtmlcommon::row_closure().
14141: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14142: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14143: &Apache::lonhtmlcommon::row_closure(1).
14144: &Apache::lonhtmlcommon::end_pick_box().
14145: '</div>';
14146: }
1.1065 raeburn 14147: $output .=
14148: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14149: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14150: "\n";
1.1065 raeburn 14151: if ($duplicates ne '') {
14152: $output .= '<p><span class="LC_warning">'.
14153: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14154: &start_data_table().
14155: &start_data_table_header_row().
14156: '<th>'.&mt('Overwrite?').'</th>'.
14157: '<th>'.&mt('Name').'</th>'.
14158: '<th>'.&mt('Type').'</th>'.
14159: '<th>'.&mt('Size').'</th>'.
14160: '<th>'.&mt('Last modified').'</th>'.
14161: &end_data_table_header_row().
14162: $duplicates.
14163: &end_data_table().
14164: '</p>';
14165: }
1.1067 raeburn 14166: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14167: if (ref($hiddenelements) eq 'HASH') {
14168: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14169: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14170: }
14171: }
14172: $output .= <<"END";
1.1067 raeburn 14173: <br />
1.1053 raeburn 14174: <input type="submit" name="decompress" value="$lt{'extr'}" />
14175: </form>
14176: $noextract
14177: END
14178: return $output;
14179: }
14180:
1.1065 raeburn 14181: sub decompression_utility {
14182: my ($program) = @_;
14183: my @utilities = ('tar','gunzip','bunzip2','unzip');
14184: my $location;
14185: if (grep(/^\Q$program\E$/,@utilities)) {
14186: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14187: '/usr/sbin/') {
14188: if (-x $dir.$program) {
14189: $location = $dir.$program;
14190: last;
14191: }
14192: }
14193: }
14194: return $location;
14195: }
14196:
14197: sub list_archive_contents {
14198: my ($file,$pathsref) = @_;
14199: my (@cmd,$output);
14200: my $needsregexp;
14201: if ($file =~ /\.zip$/) {
14202: @cmd = (&decompression_utility('unzip'),"-l");
14203: $needsregexp = 1;
14204: } elsif (($file =~ m/\.tar\.gz$/) ||
14205: ($file =~ /\.tgz$/)) {
14206: @cmd = (&decompression_utility('tar'),"-ztf");
14207: } elsif ($file =~ /\.tar\.bz2$/) {
14208: @cmd = (&decompression_utility('tar'),"-jtf");
14209: } elsif ($file =~ m|\.tar$|) {
14210: @cmd = (&decompression_utility('tar'),"-tf");
14211: }
14212: if (@cmd) {
14213: undef($!);
14214: undef($@);
14215: if (open(my $fh,"-|", @cmd, $file)) {
14216: while (my $line = <$fh>) {
14217: $output .= $line;
14218: chomp($line);
14219: my $item;
14220: if ($needsregexp) {
14221: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14222: } else {
14223: $item = $line;
14224: }
14225: if ($item ne '') {
14226: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14227: push(@{$pathsref},$item);
14228: }
14229: }
14230: }
14231: close($fh);
14232: }
14233: }
14234: return $output;
14235: }
14236:
1.1053 raeburn 14237: sub decompress_uploaded_file {
14238: my ($file,$dir) = @_;
14239: &Apache::lonnet::appenv({'cgi.file' => $file});
14240: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14241: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14242: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14243: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14244: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14245: my $decompressed = $env{'cgi.decompressed'};
14246: &Apache::lonnet::delenv('cgi.file');
14247: &Apache::lonnet::delenv('cgi.dir');
14248: &Apache::lonnet::delenv('cgi.decompressed');
14249: return ($decompressed,$result);
14250: }
14251:
1.1055 raeburn 14252: sub process_decompression {
14253: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14254: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14255: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14256: &mt('Unexpected file path.').'</p>'."\n";
14257: }
14258: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14259: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14260: &mt('Unexpected course context.').'</p>'."\n";
14261: }
1.1293 raeburn 14262: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14263: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14264: &mt('Filename contained unexpected characters.').'</p>'."\n";
14265: }
1.1055 raeburn 14266: my ($dir,$error,$warning,$output);
1.1180 raeburn 14267: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14268: $error = &mt('Filename not a supported archive file type.').
14269: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14270: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14271: } else {
14272: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14273: if ($docuhome eq 'no_host') {
14274: $error = &mt('Could not determine home server for course.');
14275: } else {
14276: my @ids=&Apache::lonnet::current_machine_ids();
14277: my $currdir = "$dir_root/$destination";
14278: if (grep(/^\Q$docuhome\E$/,@ids)) {
14279: $dir = &LONCAPA::propath($docudom,$docuname).
14280: "$dir_root/$destination";
14281: } else {
14282: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14283: "$dir_root/$docudom/$docuname/$destination";
14284: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14285: $error = &mt('Archive file not found.');
14286: }
14287: }
1.1065 raeburn 14288: my (@to_overwrite,@to_skip);
14289: if ($env{'form.archive_overwrite_total'} > 0) {
14290: my $total = $env{'form.archive_overwrite_total'};
14291: for (my $i=0; $i<$total; $i++) {
14292: if ($env{'form.archive_overwrite_'.$i} == 1) {
14293: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14294: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14295: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14296: }
14297: }
14298: }
14299: my $numskip = scalar(@to_skip);
1.1292 raeburn 14300: my $numoverwrite = scalar(@to_overwrite);
14301: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14302: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14303: } elsif ($dir eq '') {
1.1055 raeburn 14304: $error = &mt('Directory containing archive file unavailable.');
14305: } elsif (!$error) {
1.1065 raeburn 14306: my ($decompressed,$display);
1.1292 raeburn 14307: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14308: my $tempdir = time.'_'.$$.int(rand(10000));
14309: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14310: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14311: ($decompressed,$display) =
14312: &decompress_uploaded_file($file,"$dir/$tempdir");
14313: foreach my $item (@to_skip) {
14314: if (($item ne '') && ($item !~ /\.\./)) {
14315: if (-f "$dir/$tempdir/$item") {
14316: unlink("$dir/$tempdir/$item");
14317: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14318: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14319: }
14320: }
14321: }
14322: foreach my $item (@to_overwrite) {
14323: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14324: if (($item ne '') && ($item !~ /\.\./)) {
14325: if (-f "$dir/$item") {
14326: unlink("$dir/$item");
14327: } elsif (-d "$dir/$item") {
1.1300 raeburn 14328: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14329: }
14330: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14331: }
1.1065 raeburn 14332: }
14333: }
1.1292 raeburn 14334: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14335: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14336: }
1.1065 raeburn 14337: }
14338: } else {
14339: ($decompressed,$display) =
14340: &decompress_uploaded_file($file,$dir);
14341: }
1.1055 raeburn 14342: if ($decompressed eq 'ok') {
1.1065 raeburn 14343: $output = '<p class="LC_info">'.
14344: &mt('Files extracted successfully from archive.').
14345: '</p>'."\n";
1.1055 raeburn 14346: my ($warning,$result,@contents);
14347: my ($newdirlistref,$newlisterror) =
14348: &Apache::lonnet::dirlist($currdir,$docudom,
14349: $docuname,1);
14350: my (%is_dir,%changes,@newitems);
14351: my $dirptr = 16384;
1.1065 raeburn 14352: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14353: foreach my $dir_line (@{$newdirlistref}) {
14354: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14355: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14356: push(@newitems,$item);
14357: if ($dirptr&$testdir) {
14358: $is_dir{$item} = 1;
14359: }
14360: $changes{$item} = 1;
14361: }
14362: }
14363: }
14364: if (keys(%changes) > 0) {
14365: foreach my $item (sort(@newitems)) {
14366: if ($changes{$item}) {
14367: push(@contents,$item);
14368: }
14369: }
14370: }
14371: if (@contents > 0) {
1.1067 raeburn 14372: my $wantform;
14373: unless ($env{'form.autoextract_camtasia'}) {
14374: $wantform = 1;
14375: }
1.1056 raeburn 14376: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14377: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14378: $currdir,\%is_dir,
14379: \%children,\%parent,
1.1056 raeburn 14380: \@contents,\%dirorder,
14381: \%titles,$wantform);
1.1055 raeburn 14382: if ($datatable ne '') {
14383: $output .= &archive_options_form('decompressed',$datatable,
14384: $count,$hiddenelem);
1.1065 raeburn 14385: my $startcount = 6;
1.1055 raeburn 14386: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14387: \%titles,\%children);
1.1055 raeburn 14388: }
1.1067 raeburn 14389: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14390: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14391: my %displayed;
14392: my $total = 1;
14393: $env{'form.archive_directory'} = [];
14394: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14395: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14396: $path =~ s{/$}{};
14397: my $item;
14398: if ($path ne '') {
14399: $item = "$path/$titles{$i}";
14400: } else {
14401: $item = $titles{$i};
14402: }
14403: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14404: if ($item eq $contents[0]) {
14405: push(@{$env{'form.archive_directory'}},$i);
14406: $env{'form.archive_'.$i} = 'display';
14407: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14408: $displayed{'folder'} = $i;
1.1164 raeburn 14409: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14410: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14411: $env{'form.archive_'.$i} = 'display';
14412: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14413: $displayed{'web'} = $i;
14414: } else {
1.1164 raeburn 14415: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14416: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14417: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14418: push(@{$env{'form.archive_directory'}},$i);
14419: }
14420: $env{'form.archive_'.$i} = 'dependency';
14421: }
14422: $total ++;
14423: }
14424: for (my $i=1; $i<$total; $i++) {
14425: next if ($i == $displayed{'web'});
14426: next if ($i == $displayed{'folder'});
14427: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14428: }
14429: $env{'form.phase'} = 'decompress_cleanup';
14430: $env{'form.archivedelete'} = 1;
14431: $env{'form.archive_count'} = $total-1;
14432: $output .=
14433: &process_extracted_files('coursedocs',$docudom,
14434: $docuname,$destination,
14435: $dir_root,$hiddenelem);
14436: }
1.1055 raeburn 14437: } else {
14438: $warning = &mt('No new items extracted from archive file.');
14439: }
14440: } else {
14441: $output = $display;
14442: $error = &mt('An error occurred during extraction from the archive file.');
14443: }
14444: }
14445: }
14446: }
14447: if ($error) {
14448: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14449: $error.'</p>'."\n";
14450: }
14451: if ($warning) {
14452: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14453: }
14454: return $output;
14455: }
14456:
14457: sub get_extracted {
1.1056 raeburn 14458: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14459: $titles,$wantform) = @_;
1.1055 raeburn 14460: my $count = 0;
14461: my $depth = 0;
14462: my $datatable;
1.1056 raeburn 14463: my @hierarchy;
1.1055 raeburn 14464: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14465: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14466: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14467: foreach my $item (@{$contents}) {
14468: $count ++;
1.1056 raeburn 14469: @{$dirorder->{$count}} = @hierarchy;
14470: $titles->{$count} = $item;
1.1055 raeburn 14471: &archive_hierarchy($depth,$count,$parent,$children);
14472: if ($wantform) {
14473: $datatable .= &archive_row($is_dir->{$item},$item,
14474: $currdir,$depth,$count);
14475: }
14476: if ($is_dir->{$item}) {
14477: $depth ++;
1.1056 raeburn 14478: push(@hierarchy,$count);
14479: $parent->{$depth} = $count;
1.1055 raeburn 14480: $datatable .=
14481: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14482: \$depth,\$count,\@hierarchy,$dirorder,
14483: $children,$parent,$titles,$wantform);
1.1055 raeburn 14484: $depth --;
1.1056 raeburn 14485: pop(@hierarchy);
1.1055 raeburn 14486: }
14487: }
14488: return ($count,$datatable);
14489: }
14490:
14491: sub recurse_extracted_archive {
1.1056 raeburn 14492: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14493: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14494: my $result='';
1.1056 raeburn 14495: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14496: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14497: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14498: return $result;
14499: }
14500: my $dirptr = 16384;
14501: my ($newdirlistref,$newlisterror) =
14502: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14503: if (ref($newdirlistref) eq 'ARRAY') {
14504: foreach my $dir_line (@{$newdirlistref}) {
14505: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14506: unless ($item =~ /^\.+$/) {
14507: $$count ++;
1.1056 raeburn 14508: @{$dirorder->{$$count}} = @{$hierarchy};
14509: $titles->{$$count} = $item;
1.1055 raeburn 14510: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14511:
1.1055 raeburn 14512: my $is_dir;
14513: if ($dirptr&$testdir) {
14514: $is_dir = 1;
14515: }
14516: if ($wantform) {
14517: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14518: }
14519: if ($is_dir) {
14520: $$depth ++;
1.1056 raeburn 14521: push(@{$hierarchy},$$count);
14522: $parent->{$$depth} = $$count;
1.1055 raeburn 14523: $result .=
14524: &recurse_extracted_archive("$currdir/$item",$docudom,
14525: $docuname,$depth,$count,
1.1056 raeburn 14526: $hierarchy,$dirorder,$children,
14527: $parent,$titles,$wantform);
1.1055 raeburn 14528: $$depth --;
1.1056 raeburn 14529: pop(@{$hierarchy});
1.1055 raeburn 14530: }
14531: }
14532: }
14533: }
14534: return $result;
14535: }
14536:
14537: sub archive_hierarchy {
14538: my ($depth,$count,$parent,$children) =@_;
14539: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14540: if (exists($parent->{$depth})) {
14541: $children->{$parent->{$depth}} .= $count.':';
14542: }
14543: }
14544: return;
14545: }
14546:
14547: sub archive_row {
14548: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14549: my ($name) = ($item =~ m{([^/]+)$});
14550: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14551: 'display' => 'Add as file',
1.1055 raeburn 14552: 'dependency' => 'Include as dependency',
14553: 'discard' => 'Discard',
14554: );
14555: if ($is_dir) {
1.1059 raeburn 14556: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14557: }
1.1056 raeburn 14558: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14559: my $offset = 0;
1.1055 raeburn 14560: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14561: $offset ++;
1.1065 raeburn 14562: if ($action ne 'display') {
14563: $offset ++;
14564: }
1.1055 raeburn 14565: $output .= '<td><span class="LC_nobreak">'.
14566: '<label><input type="radio" name="archive_'.$count.
14567: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14568: my $text = $choices{$action};
14569: if ($is_dir) {
14570: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14571: if ($action eq 'display') {
1.1059 raeburn 14572: $text = &mt('Add as folder');
1.1055 raeburn 14573: }
1.1056 raeburn 14574: } else {
14575: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14576:
14577: }
14578: $output .= ' /> '.$choices{$action}.'</label></span>';
14579: if ($action eq 'dependency') {
14580: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14581: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14582: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14583: '<option value=""></option>'."\n".
14584: '</select>'."\n".
14585: '</div>';
1.1059 raeburn 14586: } elsif ($action eq 'display') {
14587: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14588: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14589: '</div>';
1.1055 raeburn 14590: }
1.1056 raeburn 14591: $output .= '</td>';
1.1055 raeburn 14592: }
14593: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14594: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14595: for (my $i=0; $i<$depth; $i++) {
14596: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14597: }
14598: if ($is_dir) {
14599: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14600: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14601: } else {
14602: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14603: }
14604: $output .= ' '.$name.'</td>'."\n".
14605: &end_data_table_row();
14606: return $output;
14607: }
14608:
14609: sub archive_options_form {
1.1065 raeburn 14610: my ($form,$display,$count,$hiddenelem) = @_;
14611: my %lt = &Apache::lonlocal::texthash(
14612: perm => 'Permanently remove archive file?',
14613: hows => 'How should each extracted item be incorporated in the course?',
14614: cont => 'Content actions for all',
14615: addf => 'Add as folder/file',
14616: incd => 'Include as dependency for a displayed file',
14617: disc => 'Discard',
14618: no => 'No',
14619: yes => 'Yes',
14620: save => 'Save',
14621: );
14622: my $output = <<"END";
14623: <form name="$form" method="post" action="">
14624: <p><span class="LC_nobreak">$lt{'perm'}
14625: <label>
14626: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14627: </label>
14628:
14629: <label>
14630: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14631: </span>
14632: </p>
14633: <input type="hidden" name="phase" value="decompress_cleanup" />
14634: <br />$lt{'hows'}
14635: <div class="LC_columnSection">
14636: <fieldset>
14637: <legend>$lt{'cont'}</legend>
14638: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14639: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14640: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14641: </fieldset>
14642: </div>
14643: END
14644: return $output.
1.1055 raeburn 14645: &start_data_table()."\n".
1.1065 raeburn 14646: $display."\n".
1.1055 raeburn 14647: &end_data_table()."\n".
14648: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14649: $hiddenelem.
1.1065 raeburn 14650: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14651: '</form>';
14652: }
14653:
14654: sub archive_javascript {
1.1056 raeburn 14655: my ($startcount,$numitems,$titles,$children) = @_;
14656: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14657: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14658: my $scripttag = <<START;
14659: <script type="text/javascript">
14660: // <![CDATA[
14661:
14662: function checkAll(form,prefix) {
14663: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14664: for (var i=0; i < form.elements.length; i++) {
14665: var id = form.elements[i].id;
14666: if ((id != '') && (id != undefined)) {
14667: if (idstr.test(id)) {
14668: if (form.elements[i].type == 'radio') {
14669: form.elements[i].checked = true;
1.1056 raeburn 14670: var nostart = i-$startcount;
1.1059 raeburn 14671: var offset = nostart%7;
14672: var count = (nostart-offset)/7;
1.1056 raeburn 14673: dependencyCheck(form,count,offset);
1.1055 raeburn 14674: }
14675: }
14676: }
14677: }
14678: }
14679:
14680: function propagateCheck(form,count) {
14681: if (count > 0) {
1.1059 raeburn 14682: var startelement = $startcount + ((count-1) * 7);
14683: for (var j=1; j<6; j++) {
14684: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14685: var item = startelement + j;
14686: if (form.elements[item].type == 'radio') {
14687: if (form.elements[item].checked) {
14688: containerCheck(form,count,j);
14689: break;
14690: }
1.1055 raeburn 14691: }
14692: }
14693: }
14694: }
14695: }
14696:
14697: numitems = $numitems
1.1056 raeburn 14698: var titles = new Array(numitems);
14699: var parents = new Array(numitems);
1.1055 raeburn 14700: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14701: parents[i] = new Array;
1.1055 raeburn 14702: }
1.1059 raeburn 14703: var maintitle = '$maintitle';
1.1055 raeburn 14704:
14705: START
14706:
1.1056 raeburn 14707: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14708: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14709: for (my $i=0; $i<@contents; $i ++) {
14710: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14711: }
14712: }
14713:
1.1056 raeburn 14714: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14715: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14716: }
14717:
1.1055 raeburn 14718: $scripttag .= <<END;
14719:
14720: function containerCheck(form,count,offset) {
14721: if (count > 0) {
1.1056 raeburn 14722: dependencyCheck(form,count,offset);
1.1059 raeburn 14723: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14724: form.elements[item].checked = true;
14725: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14726: if (parents[count].length > 0) {
14727: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14728: containerCheck(form,parents[count][j],offset);
14729: }
14730: }
14731: }
14732: }
14733: }
14734:
14735: function dependencyCheck(form,count,offset) {
14736: if (count > 0) {
1.1059 raeburn 14737: var chosen = (offset+$startcount)+7*(count-1);
14738: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14739: var currtype = form.elements[depitem].type;
14740: if (form.elements[chosen].value == 'dependency') {
14741: document.getElementById('arc_depon_'+count).style.display='block';
14742: form.elements[depitem].options.length = 0;
14743: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14744: for (var i=1; i<=numitems; i++) {
14745: if (i == count) {
14746: continue;
14747: }
1.1059 raeburn 14748: var startelement = $startcount + (i-1) * 7;
14749: for (var j=1; j<6; j++) {
14750: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14751: var item = startelement + j;
14752: if (form.elements[item].type == 'radio') {
14753: if (form.elements[item].checked) {
14754: if (form.elements[item].value == 'display') {
14755: var n = form.elements[depitem].options.length;
14756: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14757: }
14758: }
14759: }
14760: }
14761: }
14762: }
14763: } else {
14764: document.getElementById('arc_depon_'+count).style.display='none';
14765: form.elements[depitem].options.length = 0;
14766: form.elements[depitem].options[0] = new Option('Select','',true,true);
14767: }
1.1059 raeburn 14768: titleCheck(form,count,offset);
1.1056 raeburn 14769: }
14770: }
14771:
14772: function propagateSelect(form,count,offset) {
14773: if (count > 0) {
1.1065 raeburn 14774: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14775: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14776: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14777: if (parents[count].length > 0) {
14778: for (var j=0; j<parents[count].length; j++) {
14779: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14780: }
14781: }
14782: }
14783: }
14784: }
1.1056 raeburn 14785:
14786: function containerSelect(form,count,offset,picked) {
14787: if (count > 0) {
1.1065 raeburn 14788: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14789: if (form.elements[item].type == 'radio') {
14790: if (form.elements[item].value == 'dependency') {
14791: if (form.elements[item+1].type == 'select-one') {
14792: for (var i=0; i<form.elements[item+1].options.length; i++) {
14793: if (form.elements[item+1].options[i].value == picked) {
14794: form.elements[item+1].selectedIndex = i;
14795: break;
14796: }
14797: }
14798: }
14799: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14800: if (parents[count].length > 0) {
14801: for (var j=0; j<parents[count].length; j++) {
14802: containerSelect(form,parents[count][j],offset,picked);
14803: }
14804: }
14805: }
14806: }
14807: }
14808: }
14809: }
14810:
1.1059 raeburn 14811: function titleCheck(form,count,offset) {
14812: if (count > 0) {
14813: var chosen = (offset+$startcount)+7*(count-1);
14814: var depitem = $startcount + ((count-1) * 7) + 2;
14815: var currtype = form.elements[depitem].type;
14816: if (form.elements[chosen].value == 'display') {
14817: document.getElementById('arc_title_'+count).style.display='block';
14818: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14819: document.getElementById('archive_title_'+count).value=maintitle;
14820: }
14821: } else {
14822: document.getElementById('arc_title_'+count).style.display='none';
14823: if (currtype == 'text') {
14824: document.getElementById('archive_title_'+count).value='';
14825: }
14826: }
14827: }
14828: return;
14829: }
14830:
1.1055 raeburn 14831: // ]]>
14832: </script>
14833: END
14834: return $scripttag;
14835: }
14836:
14837: sub process_extracted_files {
1.1067 raeburn 14838: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14839: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14840: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14841: my @ids=&Apache::lonnet::current_machine_ids();
14842: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14843: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14844: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14845: if (grep(/^\Q$docuhome\E$/,@ids)) {
14846: $prefix = &LONCAPA::propath($docudom,$docuname);
14847: $pathtocheck = "$dir_root/$destination";
14848: $dir = $dir_root;
14849: $ishome = 1;
14850: } else {
14851: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14852: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14853: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14854: }
14855: my $currdir = "$dir_root/$destination";
14856: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14857: if ($env{'form.folderpath'}) {
14858: my @items = split('&',$env{'form.folderpath'});
14859: $folders{'0'} = $items[-2];
1.1099 raeburn 14860: if ($env{'form.folderpath'} =~ /\:1$/) {
14861: $containers{'0'}='page';
14862: } else {
14863: $containers{'0'}='sequence';
14864: }
1.1055 raeburn 14865: }
14866: my @archdirs = &get_env_multiple('form.archive_directory');
14867: if ($numitems) {
14868: for (my $i=1; $i<=$numitems; $i++) {
14869: my $path = $env{'form.archive_content_'.$i};
14870: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14871: my $item = $1;
14872: $toplevelitems{$item} = $i;
14873: if (grep(/^\Q$i\E$/,@archdirs)) {
14874: $is_dir{$item} = 1;
14875: }
14876: }
14877: }
14878: }
1.1067 raeburn 14879: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14880: if (keys(%toplevelitems) > 0) {
14881: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14882: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14883: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14884: }
1.1066 raeburn 14885: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14886: if ($numitems) {
14887: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14888: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14889: my $path = $env{'form.archive_content_'.$i};
14890: if ($path =~ /^\Q$pathtocheck\E/) {
14891: if ($env{'form.archive_'.$i} eq 'discard') {
14892: if ($prefix ne '' && $path ne '') {
14893: if (-e $prefix.$path) {
1.1066 raeburn 14894: if ((@archdirs > 0) &&
14895: (grep(/^\Q$i\E$/,@archdirs))) {
14896: $todeletedir{$prefix.$path} = 1;
14897: } else {
14898: $todelete{$prefix.$path} = 1;
14899: }
1.1055 raeburn 14900: }
14901: }
14902: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14903: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14904: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14905: $docstitle = $env{'form.archive_title_'.$i};
14906: if ($docstitle eq '') {
14907: $docstitle = $title;
14908: }
1.1055 raeburn 14909: $outer = 0;
1.1056 raeburn 14910: if (ref($dirorder{$i}) eq 'ARRAY') {
14911: if (@{$dirorder{$i}} > 0) {
14912: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14913: if ($env{'form.archive_'.$item} eq 'display') {
14914: $outer = $item;
14915: last;
14916: }
14917: }
14918: }
14919: }
14920: my ($errtext,$fatal) =
14921: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14922: '/'.$folders{$outer}.'.'.
14923: $containers{$outer});
14924: next if ($fatal);
14925: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14926: if ($context eq 'coursedocs') {
1.1056 raeburn 14927: $mapinner{$i} = time;
1.1055 raeburn 14928: $folders{$i} = 'default_'.$mapinner{$i};
14929: $containers{$i} = 'sequence';
14930: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14931: $folders{$i}.'.'.$containers{$i};
14932: my $newidx = &LONCAPA::map::getresidx();
14933: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14934: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14935: push(@LONCAPA::map::order,$newidx);
14936: my ($outtext,$errtext) =
14937: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14938: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14939: '.'.$containers{$outer},1,1);
1.1056 raeburn 14940: $newseqid{$i} = $newidx;
1.1067 raeburn 14941: unless ($errtext) {
1.1294 raeburn 14942: $result .= '<li>'.&mt('Folder: [_1] added to course',
14943: &HTML::Entities::encode($docstitle,'<>&"')).
14944: '</li>'."\n";
1.1067 raeburn 14945: }
1.1055 raeburn 14946: }
14947: } else {
14948: if ($context eq 'coursedocs') {
14949: my $newidx=&LONCAPA::map::getresidx();
14950: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14951: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14952: $title;
1.1392 raeburn 14953: if (($outer !~ /\D/) &&
14954: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14955: ($newidx !~ /\D/)) {
1.1294 raeburn 14956: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14957: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14958: }
14959: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14960: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14961: }
14962: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14963: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14964: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14965: unless ($ishome) {
14966: my $fetch = "$newdest{$i}/$title";
14967: $fetch =~ s/^\Q$prefix$dir\E//;
14968: $prompttofetch{$fetch} = 1;
14969: }
1.1292 raeburn 14970: }
1.1067 raeburn 14971: }
1.1294 raeburn 14972: $LONCAPA::map::resources[$newidx]=
14973: $docstitle.':'.$url.':false:normal:res';
14974: push(@LONCAPA::map::order, $newidx);
14975: my ($outtext,$errtext)=
14976: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14977: $docuname.'/'.$folders{$outer}.
14978: '.'.$containers{$outer},1,1);
14979: unless ($errtext) {
14980: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14981: $result .= '<li>'.&mt('File: [_1] added to course',
14982: &HTML::Entities::encode($docstitle,'<>&"')).
14983: '</li>'."\n";
14984: }
1.1067 raeburn 14985: }
1.1294 raeburn 14986: } else {
14987: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14988: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14989: }
1.1055 raeburn 14990: }
14991: }
1.1086 raeburn 14992: }
14993: } else {
1.1294 raeburn 14994: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14995: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14996: }
14997: }
14998: for (my $i=1; $i<=$numitems; $i++) {
14999: next unless ($env{'form.archive_'.$i} eq 'dependency');
15000: my $path = $env{'form.archive_content_'.$i};
15001: if ($path =~ /^\Q$pathtocheck\E/) {
15002: my ($title) = ($path =~ m{/([^/]+)$});
15003: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
15004: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
15005: if (ref($dirorder{$i}) eq 'ARRAY') {
15006: my ($itemidx,$fullpath,$relpath);
15007: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
15008: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 15009: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 15010: if ($dirorder{$i}->[$j] eq $container) {
15011: $itemidx = $j;
1.1056 raeburn 15012: }
15013: }
1.1086 raeburn 15014: }
15015: if ($itemidx eq '') {
15016: $itemidx = 0;
15017: }
15018: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
15019: if ($mapinner{$referrer{$i}}) {
15020: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
15021: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15022: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15023: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15024: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15025: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15026: if (!-e $fullpath) {
15027: mkdir($fullpath,0755);
1.1056 raeburn 15028: }
15029: }
1.1086 raeburn 15030: } else {
15031: last;
1.1056 raeburn 15032: }
1.1086 raeburn 15033: }
15034: }
15035: } elsif ($newdest{$referrer{$i}}) {
15036: $fullpath = $newdest{$referrer{$i}};
15037: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15038: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
15039: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
15040: last;
15041: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15042: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15043: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15044: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15045: if (!-e $fullpath) {
15046: mkdir($fullpath,0755);
1.1056 raeburn 15047: }
15048: }
1.1086 raeburn 15049: } else {
15050: last;
1.1056 raeburn 15051: }
1.1055 raeburn 15052: }
15053: }
1.1086 raeburn 15054: if ($fullpath ne '') {
15055: if (-e "$prefix$path") {
1.1292 raeburn 15056: unless (rename("$prefix$path","$fullpath/$title")) {
15057: $warning .= &mt('Failed to rename dependency').'<br />';
15058: }
1.1086 raeburn 15059: }
15060: if (-e "$fullpath/$title") {
15061: my $showpath;
15062: if ($relpath ne '') {
15063: $showpath = "$relpath/$title";
15064: } else {
15065: $showpath = "/$title";
15066: }
1.1294 raeburn 15067: $result .= '<li>'.&mt('[_1] included as a dependency',
15068: &HTML::Entities::encode($showpath,'<>&"')).
15069: '</li>'."\n";
1.1292 raeburn 15070: unless ($ishome) {
15071: my $fetch = "$fullpath/$title";
15072: $fetch =~ s/^\Q$prefix$dir\E//;
15073: $prompttofetch{$fetch} = 1;
15074: }
1.1086 raeburn 15075: }
15076: }
1.1055 raeburn 15077: }
1.1086 raeburn 15078: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15079: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15080: &HTML::Entities::encode($path,'<>&"'),
15081: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15082: '<br />';
1.1055 raeburn 15083: }
15084: } else {
1.1294 raeburn 15085: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15086: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15087: }
15088: }
15089: if (keys(%todelete)) {
15090: foreach my $key (keys(%todelete)) {
15091: unlink($key);
1.1066 raeburn 15092: }
15093: }
15094: if (keys(%todeletedir)) {
15095: foreach my $key (keys(%todeletedir)) {
15096: rmdir($key);
15097: }
15098: }
15099: foreach my $dir (sort(keys(%is_dir))) {
15100: if (($pathtocheck ne '') && ($dir ne '')) {
15101: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15102: }
15103: }
1.1067 raeburn 15104: if ($result ne '') {
15105: $output .= '<ul>'."\n".
15106: $result."\n".
15107: '</ul>';
15108: }
15109: unless ($ishome) {
15110: my $replicationfail;
15111: foreach my $item (keys(%prompttofetch)) {
15112: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15113: unless ($fetchresult eq 'ok') {
15114: $replicationfail .= '<li>'.$item.'</li>'."\n";
15115: }
15116: }
15117: if ($replicationfail) {
15118: $output .= '<p class="LC_error">'.
15119: &mt('Course home server failed to retrieve:').'<ul>'.
15120: $replicationfail.
15121: '</ul></p>';
15122: }
15123: }
1.1055 raeburn 15124: } else {
15125: $warning = &mt('No items found in archive.');
15126: }
15127: if ($error) {
15128: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15129: $error.'</p>'."\n";
15130: }
15131: if ($warning) {
15132: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15133: }
15134: return $output;
15135: }
15136:
1.1066 raeburn 15137: sub cleanup_empty_dirs {
15138: my ($path) = @_;
15139: if (($path ne '') && (-d $path)) {
15140: if (opendir(my $dirh,$path)) {
15141: my @dircontents = grep(!/^\./,readdir($dirh));
15142: my $numitems = 0;
15143: foreach my $item (@dircontents) {
15144: if (-d "$path/$item") {
1.1111 raeburn 15145: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15146: if (-e "$path/$item") {
15147: $numitems ++;
15148: }
15149: } else {
15150: $numitems ++;
15151: }
15152: }
15153: if ($numitems == 0) {
15154: rmdir($path);
15155: }
15156: closedir($dirh);
15157: }
15158: }
15159: return;
15160: }
15161:
1.41 ng 15162: =pod
1.45 matthew 15163:
1.1162 raeburn 15164: =item * &get_folder_hierarchy()
1.1068 raeburn 15165:
15166: Provides hierarchy of names of folders/sub-folders containing the current
15167: item,
15168:
15169: Inputs: 3
15170: - $navmap - navmaps object
15171:
15172: - $map - url for map (either the trigger itself, or map containing
15173: the resource, which is the trigger).
15174:
15175: - $showitem - 1 => show title for map itself; 0 => do not show.
15176:
15177: Outputs: 1 @pathitems - array of folder/subfolder names.
15178:
15179: =cut
15180:
15181: sub get_folder_hierarchy {
15182: my ($navmap,$map,$showitem) = @_;
15183: my @pathitems;
15184: if (ref($navmap)) {
15185: my $mapres = $navmap->getResourceByUrl($map);
15186: if (ref($mapres)) {
15187: my $pcslist = $mapres->map_hierarchy();
15188: if ($pcslist ne '') {
15189: my @pcs = split(/,/,$pcslist);
15190: foreach my $pc (@pcs) {
15191: if ($pc == 1) {
1.1129 raeburn 15192: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15193: } else {
15194: my $res = $navmap->getByMapPc($pc);
15195: if (ref($res)) {
15196: my $title = $res->compTitle();
15197: $title =~ s/\W+/_/g;
15198: if ($title ne '') {
15199: push(@pathitems,$title);
15200: }
15201: }
15202: }
15203: }
15204: }
1.1071 raeburn 15205: if ($showitem) {
15206: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15207: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15208: } else {
15209: my $maptitle = $mapres->compTitle();
15210: $maptitle =~ s/\W+/_/g;
15211: if ($maptitle ne '') {
15212: push(@pathitems,$maptitle);
15213: }
1.1068 raeburn 15214: }
15215: }
15216: }
15217: }
15218: return @pathitems;
15219: }
15220:
15221: =pod
15222:
1.1015 raeburn 15223: =item * &get_turnedin_filepath()
15224:
15225: Determines path in a user's portfolio file for storage of files uploaded
15226: to a specific essayresponse or dropbox item.
15227:
15228: Inputs: 3 required + 1 optional.
15229: $symb is symb for resource, $uname and $udom are for current user (required).
15230: $caller is optional (can be "submission", if routine is called when storing
15231: an upoaded file when "Submit Answer" button was pressed).
15232:
15233: Returns array containing $path and $multiresp.
15234: $path is path in portfolio. $multiresp is 1 if this resource contains more
15235: than one file upload item. Callers of routine should append partid as a
15236: subdirectory to $path in cases where $multiresp is 1.
15237:
15238: Called by: homework/essayresponse.pm and homework/structuretags.pm
15239:
15240: =cut
15241:
15242: sub get_turnedin_filepath {
15243: my ($symb,$uname,$udom,$caller) = @_;
15244: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15245: my $turnindir;
15246: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15247: $turnindir = $userhash{'turnindir'};
15248: my ($path,$multiresp);
15249: if ($turnindir eq '') {
15250: if ($caller eq 'submission') {
15251: $turnindir = &mt('turned in');
15252: $turnindir =~ s/\W+/_/g;
15253: my %newhash = (
15254: 'turnindir' => $turnindir,
15255: );
15256: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15257: }
15258: }
15259: if ($turnindir ne '') {
15260: $path = '/'.$turnindir.'/';
15261: my ($multipart,$turnin,@pathitems);
15262: my $navmap = Apache::lonnavmaps::navmap->new();
15263: if (defined($navmap)) {
15264: my $mapres = $navmap->getResourceByUrl($map);
15265: if (ref($mapres)) {
15266: my $pcslist = $mapres->map_hierarchy();
15267: if ($pcslist ne '') {
15268: foreach my $pc (split(/,/,$pcslist)) {
15269: my $res = $navmap->getByMapPc($pc);
15270: if (ref($res)) {
15271: my $title = $res->compTitle();
15272: $title =~ s/\W+/_/g;
15273: if ($title ne '') {
1.1149 raeburn 15274: if (($pc > 1) && (length($title) > 12)) {
15275: $title = substr($title,0,12);
15276: }
1.1015 raeburn 15277: push(@pathitems,$title);
15278: }
15279: }
15280: }
15281: }
15282: my $maptitle = $mapres->compTitle();
15283: $maptitle =~ s/\W+/_/g;
15284: if ($maptitle ne '') {
1.1149 raeburn 15285: if (length($maptitle) > 12) {
15286: $maptitle = substr($maptitle,0,12);
15287: }
1.1015 raeburn 15288: push(@pathitems,$maptitle);
15289: }
15290: unless ($env{'request.state'} eq 'construct') {
15291: my $res = $navmap->getBySymb($symb);
15292: if (ref($res)) {
15293: my $partlist = $res->parts();
15294: my $totaluploads = 0;
15295: if (ref($partlist) eq 'ARRAY') {
15296: foreach my $part (@{$partlist}) {
15297: my @types = $res->responseType($part);
15298: my @ids = $res->responseIds($part);
15299: for (my $i=0; $i < scalar(@ids); $i++) {
15300: if ($types[$i] eq 'essay') {
15301: my $partid = $part.'_'.$ids[$i];
15302: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15303: $totaluploads ++;
15304: }
15305: }
15306: }
15307: }
15308: if ($totaluploads > 1) {
15309: $multiresp = 1;
15310: }
15311: }
15312: }
15313: }
15314: } else {
15315: return;
15316: }
15317: } else {
15318: return;
15319: }
15320: my $restitle=&Apache::lonnet::gettitle($symb);
15321: $restitle =~ s/\W+/_/g;
15322: if ($restitle eq '') {
15323: $restitle = ($resurl =~ m{/[^/]+$});
15324: if ($restitle eq '') {
15325: $restitle = time;
15326: }
15327: }
1.1149 raeburn 15328: if (length($restitle) > 12) {
15329: $restitle = substr($restitle,0,12);
15330: }
1.1015 raeburn 15331: push(@pathitems,$restitle);
15332: $path .= join('/',@pathitems);
15333: }
15334: return ($path,$multiresp);
15335: }
15336:
15337: =pod
15338:
1.464 albertel 15339: =back
1.41 ng 15340:
1.112 bowersj2 15341: =head1 CSV Upload/Handling functions
1.38 albertel 15342:
1.41 ng 15343: =over 4
15344:
1.648 raeburn 15345: =item * &upfile_store($r)
1.41 ng 15346:
15347: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15348: needs $env{'form.upfile'}
1.41 ng 15349: returns $datatoken to be put into hidden field
15350:
15351: =cut
1.31 albertel 15352:
15353: sub upfile_store {
15354: my $r=shift;
1.258 albertel 15355: $env{'form.upfile'}=~s/\r/\n/gs;
15356: $env{'form.upfile'}=~s/\f/\n/gs;
15357: $env{'form.upfile'}=~s/\n+/\n/gs;
15358: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15359:
1.1299 raeburn 15360: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15361: '_enroll_'.$env{'request.course.id'}.'_'.
15362: time.'_'.$$);
15363: return if ($datatoken eq '');
15364:
1.31 albertel 15365: {
1.158 raeburn 15366: my $datafile = $r->dir_config('lonDaemons').
15367: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15368: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15369: print $fh $env{'form.upfile'};
1.158 raeburn 15370: close($fh);
15371: }
1.31 albertel 15372: }
15373: return $datatoken;
15374: }
15375:
1.56 matthew 15376: =pod
15377:
1.1290 raeburn 15378: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15379:
15380: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15381: $datatoken is the name to assign to the temporary file.
1.258 albertel 15382: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15383:
15384: =cut
1.31 albertel 15385:
15386: sub load_tmp_file {
1.1290 raeburn 15387: my ($r,$datatoken) = @_;
15388: return if ($datatoken eq '');
1.31 albertel 15389: my @studentdata=();
15390: {
1.158 raeburn 15391: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15392: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15393: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15394: @studentdata=<$fh>;
15395: close($fh);
15396: }
1.31 albertel 15397: }
1.258 albertel 15398: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15399: }
15400:
1.1290 raeburn 15401: sub valid_datatoken {
15402: my ($datatoken) = @_;
1.1325 raeburn 15403: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15404: return $datatoken;
15405: }
15406: return;
15407: }
15408:
1.56 matthew 15409: =pod
15410:
1.648 raeburn 15411: =item * &upfile_record_sep()
1.41 ng 15412:
15413: Separate uploaded file into records
15414: returns array of records,
1.258 albertel 15415: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15416:
15417: =cut
1.31 albertel 15418:
15419: sub upfile_record_sep {
1.258 albertel 15420: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15421: } else {
1.248 albertel 15422: my @records;
1.258 albertel 15423: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15424: if ($line=~/^\s*$/) { next; }
15425: push(@records,$line);
15426: }
15427: return @records;
1.31 albertel 15428: }
15429: }
15430:
1.56 matthew 15431: =pod
15432:
1.648 raeburn 15433: =item * &record_sep($record)
1.41 ng 15434:
1.258 albertel 15435: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15436:
15437: =cut
15438:
1.263 www 15439: sub takeleft {
15440: my $index=shift;
15441: return substr('0000'.$index,-4,4);
15442: }
15443:
1.31 albertel 15444: sub record_sep {
15445: my $record=shift;
15446: my %components=();
1.258 albertel 15447: if ($env{'form.upfiletype'} eq 'xml') {
15448: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15449: my $i=0;
1.356 albertel 15450: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15451: $field=~s/^(\"|\')//;
15452: $field=~s/(\"|\')$//;
1.263 www 15453: $components{&takeleft($i)}=$field;
1.31 albertel 15454: $i++;
15455: }
1.258 albertel 15456: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15457: my $i=0;
1.356 albertel 15458: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15459: $field=~s/^(\"|\')//;
15460: $field=~s/(\"|\')$//;
1.263 www 15461: $components{&takeleft($i)}=$field;
1.31 albertel 15462: $i++;
15463: }
15464: } else {
1.561 www 15465: my $separator=',';
1.480 banghart 15466: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15467: $separator=';';
1.480 banghart 15468: }
1.31 albertel 15469: my $i=0;
1.561 www 15470: # the character we are looking for to indicate the end of a quote or a record
15471: my $looking_for=$separator;
15472: # do not add the characters to the fields
15473: my $ignore=0;
15474: # we just encountered a separator (or the beginning of the record)
15475: my $just_found_separator=1;
15476: # store the field we are working on here
15477: my $field='';
15478: # work our way through all characters in record
15479: foreach my $character ($record=~/(.)/g) {
15480: if ($character eq $looking_for) {
15481: if ($character ne $separator) {
15482: # Found the end of a quote, again looking for separator
15483: $looking_for=$separator;
15484: $ignore=1;
15485: } else {
15486: # Found a separator, store away what we got
15487: $components{&takeleft($i)}=$field;
15488: $i++;
15489: $just_found_separator=1;
15490: $ignore=0;
15491: $field='';
15492: }
15493: next;
15494: }
15495: # single or double quotation marks after a separator indicate beginning of a quote
15496: # we are now looking for the end of the quote and need to ignore separators
15497: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15498: $looking_for=$character;
15499: next;
15500: }
15501: # ignore would be true after we reached the end of a quote
15502: if ($ignore) { next; }
15503: if (($just_found_separator) && ($character=~/\s/)) { next; }
15504: $field.=$character;
15505: $just_found_separator=0;
1.31 albertel 15506: }
1.561 www 15507: # catch the very last entry, since we never encountered the separator
15508: $components{&takeleft($i)}=$field;
1.31 albertel 15509: }
15510: return %components;
15511: }
15512:
1.144 matthew 15513: ######################################################
15514: ######################################################
15515:
1.56 matthew 15516: =pod
15517:
1.648 raeburn 15518: =item * &upfile_select_html()
1.41 ng 15519:
1.144 matthew 15520: Return HTML code to select a file from the users machine and specify
15521: the file type.
1.41 ng 15522:
15523: =cut
15524:
1.144 matthew 15525: ######################################################
15526: ######################################################
1.31 albertel 15527: sub upfile_select_html {
1.144 matthew 15528: my %Types = (
15529: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15530: semisv => &mt('Semicolon separated values'),
1.144 matthew 15531: space => &mt('Space separated'),
15532: tab => &mt('Tabulator separated'),
15533: # xml => &mt('HTML/XML'),
15534: );
15535: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15536: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15537: foreach my $type (sort(keys(%Types))) {
15538: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15539: }
15540: $Str .= "</select>\n";
15541: return $Str;
1.31 albertel 15542: }
15543:
1.301 albertel 15544: sub get_samples {
15545: my ($records,$toget) = @_;
15546: my @samples=({});
15547: my $got=0;
15548: foreach my $rec (@$records) {
15549: my %temp = &record_sep($rec);
15550: if (! grep(/\S/, values(%temp))) { next; }
15551: if (%temp) {
15552: $samples[$got]=\%temp;
15553: $got++;
15554: if ($got == $toget) { last; }
15555: }
15556: }
15557: return \@samples;
15558: }
15559:
1.144 matthew 15560: ######################################################
15561: ######################################################
15562:
1.56 matthew 15563: =pod
15564:
1.648 raeburn 15565: =item * &csv_print_samples($r,$records)
1.41 ng 15566:
15567: Prints a table of sample values from each column uploaded $r is an
15568: Apache Request ref, $records is an arrayref from
15569: &Apache::loncommon::upfile_record_sep
15570:
15571: =cut
15572:
1.144 matthew 15573: ######################################################
15574: ######################################################
1.31 albertel 15575: sub csv_print_samples {
15576: my ($r,$records) = @_;
1.662 bisitz 15577: my $samples = &get_samples($records,5);
1.301 albertel 15578:
1.594 raeburn 15579: $r->print(&mt('Samples').'<br />'.&start_data_table().
15580: &start_data_table_header_row());
1.356 albertel 15581: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15582: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15583: $r->print(&end_data_table_header_row());
1.301 albertel 15584: foreach my $hash (@$samples) {
1.594 raeburn 15585: $r->print(&start_data_table_row());
1.356 albertel 15586: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15587: $r->print('<td>');
1.356 albertel 15588: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15589: $r->print('</td>');
15590: }
1.594 raeburn 15591: $r->print(&end_data_table_row());
1.31 albertel 15592: }
1.594 raeburn 15593: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15594: }
15595:
1.144 matthew 15596: ######################################################
15597: ######################################################
15598:
1.56 matthew 15599: =pod
15600:
1.648 raeburn 15601: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15602:
15603: Prints a table to create associations between values and table columns.
1.144 matthew 15604:
1.41 ng 15605: $r is an Apache Request ref,
15606: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15607: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15608:
15609: =cut
15610:
1.144 matthew 15611: ######################################################
15612: ######################################################
1.31 albertel 15613: sub csv_print_select_table {
15614: my ($r,$records,$d) = @_;
1.301 albertel 15615: my $i=0;
15616: my $samples = &get_samples($records,1);
1.144 matthew 15617: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15618: &start_data_table().&start_data_table_header_row().
1.144 matthew 15619: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15620: '<th>'.&mt('Column').'</th>'.
15621: &end_data_table_header_row()."\n");
1.356 albertel 15622: foreach my $array_ref (@$d) {
15623: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15624: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15625:
1.875 bisitz 15626: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15627: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15628: $r->print('<option value="none"></option>');
1.356 albertel 15629: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15630: $r->print('<option value="'.$sample.'"'.
15631: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15632: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15633: }
1.594 raeburn 15634: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15635: $i++;
15636: }
1.594 raeburn 15637: $r->print(&end_data_table());
1.31 albertel 15638: $i--;
15639: return $i;
15640: }
1.56 matthew 15641:
1.144 matthew 15642: ######################################################
15643: ######################################################
15644:
1.56 matthew 15645: =pod
1.31 albertel 15646:
1.648 raeburn 15647: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15648:
15649: Prints a table of sample values from the upload and can make associate samples to internal names.
15650:
15651: $r is an Apache Request ref,
15652: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15653: $d is an array of 2 element arrays (internal name, displayed name)
15654:
15655: =cut
15656:
1.144 matthew 15657: ######################################################
15658: ######################################################
1.31 albertel 15659: sub csv_samples_select_table {
15660: my ($r,$records,$d) = @_;
15661: my $i=0;
1.144 matthew 15662: #
1.662 bisitz 15663: my $max_samples = 5;
15664: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15665: $r->print(&start_data_table().
15666: &start_data_table_header_row().'<th>'.
15667: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15668: &end_data_table_header_row());
1.301 albertel 15669:
15670: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15671: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15672: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15673: foreach my $option (@$d) {
15674: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15675: $r->print('<option value="'.$value.'"'.
1.253 albertel 15676: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15677: $display.'</option>');
1.31 albertel 15678: }
15679: $r->print('</select></td><td>');
1.662 bisitz 15680: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15681: if (defined($samples->[$line]{$key})) {
15682: $r->print($samples->[$line]{$key}."<br />\n");
15683: }
15684: }
1.594 raeburn 15685: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15686: $i++;
15687: }
1.594 raeburn 15688: $r->print(&end_data_table());
1.31 albertel 15689: $i--;
15690: return($i);
1.115 matthew 15691: }
15692:
1.144 matthew 15693: ######################################################
15694: ######################################################
15695:
1.115 matthew 15696: =pod
15697:
1.648 raeburn 15698: =item * &clean_excel_name($name)
1.115 matthew 15699:
15700: Returns a replacement for $name which does not contain any illegal characters.
15701:
15702: =cut
15703:
1.144 matthew 15704: ######################################################
15705: ######################################################
1.115 matthew 15706: sub clean_excel_name {
15707: my ($name) = @_;
15708: $name =~ s/[:\*\?\/\\]//g;
15709: if (length($name) > 31) {
15710: $name = substr($name,0,31);
15711: }
15712: return $name;
1.25 albertel 15713: }
1.84 albertel 15714:
1.85 albertel 15715: =pod
15716:
1.648 raeburn 15717: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15718:
15719: Returns either 1 or undef
15720:
15721: 1 if the part is to be hidden, undef if it is to be shown
15722:
15723: Arguments are:
15724:
15725: $id the id of the part to be checked
15726: $symb, optional the symb of the resource to check
15727: $udom, optional the domain of the user to check for
15728: $uname, optional the username of the user to check for
15729:
15730: =cut
1.84 albertel 15731:
15732: sub check_if_partid_hidden {
15733: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15734: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15735: $symb,$udom,$uname);
1.141 albertel 15736: my $truth=1;
15737: #if the string starts with !, then the list is the list to show not hide
15738: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15739: my @hiddenlist=split(/,/,$hiddenparts);
15740: foreach my $checkid (@hiddenlist) {
1.141 albertel 15741: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15742: }
1.141 albertel 15743: return !$truth;
1.84 albertel 15744: }
1.127 matthew 15745:
1.138 matthew 15746:
15747: ############################################################
15748: ############################################################
15749:
15750: =pod
15751:
1.157 matthew 15752: =back
15753:
1.138 matthew 15754: =head1 cgi-bin script and graphing routines
15755:
1.157 matthew 15756: =over 4
15757:
1.648 raeburn 15758: =item * &get_cgi_id()
1.138 matthew 15759:
15760: Inputs: none
15761:
15762: Returns an id which can be used to pass environment variables
15763: to various cgi-bin scripts. These environment variables will
15764: be removed from the users environment after a given time by
15765: the routine &Apache::lonnet::transfer_profile_to_env.
15766:
15767: =cut
15768:
15769: ############################################################
15770: ############################################################
1.152 albertel 15771: my $uniq=0;
1.136 matthew 15772: sub get_cgi_id {
1.154 albertel 15773: $uniq=($uniq+1)%100000;
1.280 albertel 15774: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15775: }
15776:
1.127 matthew 15777: ############################################################
15778: ############################################################
15779:
15780: =pod
15781:
1.648 raeburn 15782: =item * &DrawBarGraph()
1.127 matthew 15783:
1.138 matthew 15784: Facilitates the plotting of data in a (stacked) bar graph.
15785: Puts plot definition data into the users environment in order for
15786: graph.png to plot it. Returns an <img> tag for the plot.
15787: The bars on the plot are labeled '1','2',...,'n'.
15788:
15789: Inputs:
15790:
15791: =over 4
15792:
15793: =item $Title: string, the title of the plot
15794:
15795: =item $xlabel: string, text describing the X-axis of the plot
15796:
15797: =item $ylabel: string, text describing the Y-axis of the plot
15798:
15799: =item $Max: scalar, the maximum Y value to use in the plot
15800: If $Max is < any data point, the graph will not be rendered.
15801:
1.140 matthew 15802: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15803: they are plotted. If undefined, default values will be used.
15804:
1.178 matthew 15805: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15806:
1.138 matthew 15807: =item @Values: An array of array references. Each array reference holds data
15808: to be plotted in a stacked bar chart.
15809:
1.239 matthew 15810: =item If the final element of @Values is a hash reference the key/value
15811: pairs will be added to the graph definition.
15812:
1.138 matthew 15813: =back
15814:
15815: Returns:
15816:
15817: An <img> tag which references graph.png and the appropriate identifying
15818: information for the plot.
15819:
1.127 matthew 15820: =cut
15821:
15822: ############################################################
15823: ############################################################
1.134 matthew 15824: sub DrawBarGraph {
1.178 matthew 15825: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15826: #
15827: if (! defined($colors)) {
15828: $colors = ['#33ff00',
15829: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15830: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15831: ];
15832: }
1.228 matthew 15833: my $extra_settings = {};
15834: if (ref($Values[-1]) eq 'HASH') {
15835: $extra_settings = pop(@Values);
15836: }
1.127 matthew 15837: #
1.136 matthew 15838: my $identifier = &get_cgi_id();
15839: my $id = 'cgi.'.$identifier;
1.129 matthew 15840: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15841: return '';
15842: }
1.225 matthew 15843: #
15844: my @Labels;
15845: if (defined($labels)) {
15846: @Labels = @$labels;
15847: } else {
15848: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15849: push(@Labels,$i+1);
1.225 matthew 15850: }
15851: }
15852: #
1.129 matthew 15853: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15854: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15855: my %ValuesHash;
15856: my $NumSets=1;
15857: foreach my $array (@Values) {
15858: next if (! ref($array));
1.136 matthew 15859: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15860: join(',',@$array);
1.129 matthew 15861: }
1.127 matthew 15862: #
1.136 matthew 15863: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15864: if ($NumBars < 3) {
15865: $width = 120+$NumBars*32;
1.220 matthew 15866: $xskip = 1;
1.225 matthew 15867: $bar_width = 30;
15868: } elsif ($NumBars < 5) {
15869: $width = 120+$NumBars*20;
15870: $xskip = 1;
15871: $bar_width = 20;
1.220 matthew 15872: } elsif ($NumBars < 10) {
1.136 matthew 15873: $width = 120+$NumBars*15;
15874: $xskip = 1;
15875: $bar_width = 15;
15876: } elsif ($NumBars <= 25) {
15877: $width = 120+$NumBars*11;
15878: $xskip = 5;
15879: $bar_width = 8;
15880: } elsif ($NumBars <= 50) {
15881: $width = 120+$NumBars*8;
15882: $xskip = 5;
15883: $bar_width = 4;
15884: } else {
15885: $width = 120+$NumBars*8;
15886: $xskip = 5;
15887: $bar_width = 4;
15888: }
15889: #
1.137 matthew 15890: $Max = 1 if ($Max < 1);
15891: if ( int($Max) < $Max ) {
15892: $Max++;
15893: $Max = int($Max);
15894: }
1.127 matthew 15895: $Title = '' if (! defined($Title));
15896: $xlabel = '' if (! defined($xlabel));
15897: $ylabel = '' if (! defined($ylabel));
1.369 www 15898: $ValuesHash{$id.'.title'} = &escape($Title);
15899: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15900: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15901: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15902: $ValuesHash{$id.'.NumBars'} = $NumBars;
15903: $ValuesHash{$id.'.NumSets'} = $NumSets;
15904: $ValuesHash{$id.'.PlotType'} = 'bar';
15905: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15906: $ValuesHash{$id.'.height'} = $height;
15907: $ValuesHash{$id.'.width'} = $width;
15908: $ValuesHash{$id.'.xskip'} = $xskip;
15909: $ValuesHash{$id.'.bar_width'} = $bar_width;
15910: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15911: #
1.228 matthew 15912: # Deal with other parameters
15913: while (my ($key,$value) = each(%$extra_settings)) {
15914: $ValuesHash{$id.'.'.$key} = $value;
15915: }
15916: #
1.646 raeburn 15917: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15918: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15919: }
15920:
15921: ############################################################
15922: ############################################################
15923:
15924: =pod
15925:
1.648 raeburn 15926: =item * &DrawXYGraph()
1.137 matthew 15927:
1.138 matthew 15928: Facilitates the plotting of data in an XY graph.
15929: Puts plot definition data into the users environment in order for
15930: graph.png to plot it. Returns an <img> tag for the plot.
15931:
15932: Inputs:
15933:
15934: =over 4
15935:
15936: =item $Title: string, the title of the plot
15937:
15938: =item $xlabel: string, text describing the X-axis of the plot
15939:
15940: =item $ylabel: string, text describing the Y-axis of the plot
15941:
15942: =item $Max: scalar, the maximum Y value to use in the plot
15943: If $Max is < any data point, the graph will not be rendered.
15944:
15945: =item $colors: Array ref containing the hex color codes for the data to be
15946: plotted in. If undefined, default values will be used.
15947:
15948: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15949:
15950: =item $Ydata: Array ref containing Array refs.
1.185 www 15951: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15952:
15953: =item %Values: hash indicating or overriding any default values which are
15954: passed to graph.png.
15955: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15956:
15957: =back
15958:
15959: Returns:
15960:
15961: An <img> tag which references graph.png and the appropriate identifying
15962: information for the plot.
15963:
1.137 matthew 15964: =cut
15965:
15966: ############################################################
15967: ############################################################
15968: sub DrawXYGraph {
15969: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15970: #
15971: # Create the identifier for the graph
15972: my $identifier = &get_cgi_id();
15973: my $id = 'cgi.'.$identifier;
15974: #
15975: $Title = '' if (! defined($Title));
15976: $xlabel = '' if (! defined($xlabel));
15977: $ylabel = '' if (! defined($ylabel));
15978: my %ValuesHash =
15979: (
1.369 www 15980: $id.'.title' => &escape($Title),
15981: $id.'.xlabel' => &escape($xlabel),
15982: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15983: $id.'.y_max_value'=> $Max,
15984: $id.'.labels' => join(',',@$Xlabels),
15985: $id.'.PlotType' => 'XY',
15986: );
15987: #
15988: if (defined($colors) && ref($colors) eq 'ARRAY') {
15989: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15990: }
15991: #
15992: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15993: return '';
15994: }
15995: my $NumSets=1;
1.138 matthew 15996: foreach my $array (@{$Ydata}){
1.137 matthew 15997: next if (! ref($array));
15998: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15999: }
1.138 matthew 16000: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 16001: #
16002: # Deal with other parameters
16003: while (my ($key,$value) = each(%Values)) {
16004: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 16005: }
16006: #
1.646 raeburn 16007: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 16008: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
16009: }
16010:
16011: ############################################################
16012: ############################################################
16013:
16014: =pod
16015:
1.648 raeburn 16016: =item * &DrawXYYGraph()
1.138 matthew 16017:
16018: Facilitates the plotting of data in an XY graph with two Y axes.
16019: Puts plot definition data into the users environment in order for
16020: graph.png to plot it. Returns an <img> tag for the plot.
16021:
16022: Inputs:
16023:
16024: =over 4
16025:
16026: =item $Title: string, the title of the plot
16027:
16028: =item $xlabel: string, text describing the X-axis of the plot
16029:
16030: =item $ylabel: string, text describing the Y-axis of the plot
16031:
16032: =item $colors: Array ref containing the hex color codes for the data to be
16033: plotted in. If undefined, default values will be used.
16034:
16035: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
16036:
16037: =item $Ydata1: The first data set
16038:
16039: =item $Min1: The minimum value of the left Y-axis
16040:
16041: =item $Max1: The maximum value of the left Y-axis
16042:
16043: =item $Ydata2: The second data set
16044:
16045: =item $Min2: The minimum value of the right Y-axis
16046:
16047: =item $Max2: The maximum value of the left Y-axis
16048:
16049: =item %Values: hash indicating or overriding any default values which are
16050: passed to graph.png.
16051: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16052:
16053: =back
16054:
16055: Returns:
16056:
16057: An <img> tag which references graph.png and the appropriate identifying
16058: information for the plot.
1.136 matthew 16059:
16060: =cut
16061:
16062: ############################################################
16063: ############################################################
1.137 matthew 16064: sub DrawXYYGraph {
16065: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16066: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16067: #
16068: # Create the identifier for the graph
16069: my $identifier = &get_cgi_id();
16070: my $id = 'cgi.'.$identifier;
16071: #
16072: $Title = '' if (! defined($Title));
16073: $xlabel = '' if (! defined($xlabel));
16074: $ylabel = '' if (! defined($ylabel));
16075: my %ValuesHash =
16076: (
1.369 www 16077: $id.'.title' => &escape($Title),
16078: $id.'.xlabel' => &escape($xlabel),
16079: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16080: $id.'.labels' => join(',',@$Xlabels),
16081: $id.'.PlotType' => 'XY',
16082: $id.'.NumSets' => 2,
1.137 matthew 16083: $id.'.two_axes' => 1,
16084: $id.'.y1_max_value' => $Max1,
16085: $id.'.y1_min_value' => $Min1,
16086: $id.'.y2_max_value' => $Max2,
16087: $id.'.y2_min_value' => $Min2,
1.136 matthew 16088: );
16089: #
1.137 matthew 16090: if (defined($colors) && ref($colors) eq 'ARRAY') {
16091: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16092: }
16093: #
16094: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16095: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16096: return '';
16097: }
16098: my $NumSets=1;
1.137 matthew 16099: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16100: next if (! ref($array));
16101: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16102: }
16103: #
16104: # Deal with other parameters
16105: while (my ($key,$value) = each(%Values)) {
16106: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16107: }
16108: #
1.646 raeburn 16109: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16110: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16111: }
16112:
16113: ############################################################
16114: ############################################################
16115:
16116: =pod
16117:
1.157 matthew 16118: =back
16119:
1.139 matthew 16120: =head1 Statistics helper routines?
16121:
16122: Bad place for them but what the hell.
16123:
1.157 matthew 16124: =over 4
16125:
1.648 raeburn 16126: =item * &chartlink()
1.139 matthew 16127:
16128: Returns a link to the chart for a specific student.
16129:
16130: Inputs:
16131:
16132: =over 4
16133:
16134: =item $linktext: The text of the link
16135:
16136: =item $sname: The students username
16137:
16138: =item $sdomain: The students domain
16139:
16140: =back
16141:
1.157 matthew 16142: =back
16143:
1.139 matthew 16144: =cut
16145:
16146: ############################################################
16147: ############################################################
16148: sub chartlink {
16149: my ($linktext, $sname, $sdomain) = @_;
16150: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16151: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16152: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16153: '">'.$linktext.'</a>';
1.153 matthew 16154: }
16155:
16156: #######################################################
16157: #######################################################
16158:
16159: =pod
16160:
16161: =head1 Course Environment Routines
1.157 matthew 16162:
16163: =over 4
1.153 matthew 16164:
1.648 raeburn 16165: =item * &restore_course_settings()
1.153 matthew 16166:
1.648 raeburn 16167: =item * &store_course_settings()
1.153 matthew 16168:
16169: Restores/Store indicated form parameters from the course environment.
16170: Will not overwrite existing values of the form parameters.
16171:
16172: Inputs:
16173: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16174:
16175: a hash ref describing the data to be stored. For example:
16176:
16177: %Save_Parameters = ('Status' => 'scalar',
16178: 'chartoutputmode' => 'scalar',
16179: 'chartoutputdata' => 'scalar',
16180: 'Section' => 'array',
1.373 raeburn 16181: 'Group' => 'array',
1.153 matthew 16182: 'StudentData' => 'array',
16183: 'Maps' => 'array');
16184:
16185: Returns: both routines return nothing
16186:
1.631 raeburn 16187: =back
16188:
1.153 matthew 16189: =cut
16190:
16191: #######################################################
16192: #######################################################
16193: sub store_course_settings {
1.496 albertel 16194: return &store_settings($env{'request.course.id'},@_);
16195: }
16196:
16197: sub store_settings {
1.153 matthew 16198: # save to the environment
16199: # appenv the same items, just to be safe
1.300 albertel 16200: my $udom = $env{'user.domain'};
16201: my $uname = $env{'user.name'};
1.496 albertel 16202: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16203: my %SaveHash;
16204: my %AppHash;
16205: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16206: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16207: my $envname = 'environment.'.$basename;
1.258 albertel 16208: if (exists($env{'form.'.$setting})) {
1.153 matthew 16209: # Save this value away
16210: if ($type eq 'scalar' &&
1.258 albertel 16211: (! exists($env{$envname}) ||
16212: $env{$envname} ne $env{'form.'.$setting})) {
16213: $SaveHash{$basename} = $env{'form.'.$setting};
16214: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16215: } elsif ($type eq 'array') {
16216: my $stored_form;
1.258 albertel 16217: if (ref($env{'form.'.$setting})) {
1.153 matthew 16218: $stored_form = join(',',
16219: map {
1.369 www 16220: &escape($_);
1.258 albertel 16221: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16222: } else {
16223: $stored_form =
1.369 www 16224: &escape($env{'form.'.$setting});
1.153 matthew 16225: }
16226: # Determine if the array contents are the same.
1.258 albertel 16227: if ($stored_form ne $env{$envname}) {
1.153 matthew 16228: $SaveHash{$basename} = $stored_form;
16229: $AppHash{$envname} = $stored_form;
16230: }
16231: }
16232: }
16233: }
16234: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16235: $udom,$uname);
1.153 matthew 16236: if ($put_result !~ /^(ok|delayed)/) {
16237: &Apache::lonnet::logthis('unable to save form parameters, '.
16238: 'got error:'.$put_result);
16239: }
16240: # Make sure these settings stick around in this session, too
1.646 raeburn 16241: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16242: return;
16243: }
16244:
16245: sub restore_course_settings {
1.499 albertel 16246: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16247: }
16248:
16249: sub restore_settings {
16250: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16251: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16252: next if (exists($env{'form.'.$setting}));
1.496 albertel 16253: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16254: '.'.$setting;
1.258 albertel 16255: if (exists($env{$envname})) {
1.153 matthew 16256: if ($type eq 'scalar') {
1.258 albertel 16257: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16258: } elsif ($type eq 'array') {
1.258 albertel 16259: $env{'form.'.$setting} = [
1.153 matthew 16260: map {
1.369 www 16261: &unescape($_);
1.258 albertel 16262: } split(',',$env{$envname})
1.153 matthew 16263: ];
16264: }
16265: }
16266: }
1.127 matthew 16267: }
16268:
1.618 raeburn 16269: #######################################################
16270: #######################################################
16271:
16272: =pod
16273:
16274: =head1 Domain E-mail Routines
16275:
16276: =over 4
16277:
1.648 raeburn 16278: =item * &build_recipient_list()
1.618 raeburn 16279:
1.1144 raeburn 16280: Build recipient lists for following types of e-mail:
1.766 raeburn 16281: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16282: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16283: module change checking, student/employee ID conflict checks, as
16284: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16285: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16286:
16287: Inputs:
1.619 raeburn 16288: defmail (scalar - email address of default recipient),
1.1144 raeburn 16289: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16290: requestsmail, updatesmail, or idconflictsmail).
16291:
1.619 raeburn 16292: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16293:
1.619 raeburn 16294: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16295: i.e., predates configuration by DC via domainprefs.pm
16296:
16297: $requname username of requester (if mailing type is helpdeskmail)
16298:
16299: $requdom domain of requester (if mailing type is helpdeskmail)
16300:
16301: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16302:
1.618 raeburn 16303:
1.655 raeburn 16304: Returns: comma separated list of addresses to which to send e-mail.
16305:
16306: =back
1.618 raeburn 16307:
16308: =cut
16309:
16310: ############################################################
16311: ############################################################
16312: sub build_recipient_list {
1.1297 raeburn 16313: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16314: my @recipients;
1.1270 raeburn 16315: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16316: my %domconfig =
1.1270 raeburn 16317: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16318: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16319: if (exists($domconfig{'contacts'}{$mailing})) {
16320: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16321: my @contacts = ('adminemail','supportemail');
16322: foreach my $item (@contacts) {
16323: if ($domconfig{'contacts'}{$mailing}{$item}) {
16324: my $addr = $domconfig{'contacts'}{$item};
16325: if (!grep(/^\Q$addr\E$/,@recipients)) {
16326: push(@recipients,$addr);
16327: }
1.619 raeburn 16328: }
1.1270 raeburn 16329: }
16330: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16331: if ($mailing eq 'helpdeskmail') {
16332: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16333: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16334: my @ok_bccs;
16335: foreach my $bcc (@bccs) {
16336: $bcc =~ s/^\s+//g;
16337: $bcc =~ s/\s+$//g;
16338: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16339: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16340: push(@ok_bccs,$bcc);
16341: }
16342: }
16343: }
16344: if (@ok_bccs > 0) {
16345: $allbcc = join(', ',@ok_bccs);
16346: }
16347: }
16348: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16349: }
16350: }
1.766 raeburn 16351: } elsif ($origmail ne '') {
1.1270 raeburn 16352: $lastresort = $origmail;
1.618 raeburn 16353: }
1.1297 raeburn 16354: if ($mailing eq 'helpdeskmail') {
16355: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16356: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16357: my ($inststatus,$inststatus_checked);
16358: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16359: ($env{'user.domain'} ne 'public')) {
16360: $inststatus_checked = 1;
16361: $inststatus = $env{'environment.inststatus'};
16362: }
16363: unless ($inststatus_checked) {
16364: if (($requname ne '') && ($requdom ne '')) {
16365: if (($requname =~ /^$match_username$/) &&
16366: ($requdom =~ /^$match_domain$/) &&
16367: (&Apache::lonnet::domain($requdom))) {
16368: my $requhome = &Apache::lonnet::homeserver($requname,
16369: $requdom);
16370: unless ($requhome eq 'no_host') {
16371: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16372: $inststatus = $userenv{'inststatus'};
16373: $inststatus_checked = 1;
16374: }
16375: }
16376: }
16377: }
16378: unless ($inststatus_checked) {
16379: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16380: my %srch = (srchby => 'email',
16381: srchdomain => $defdom,
16382: srchterm => $reqemail,
16383: srchtype => 'exact');
16384: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16385: foreach my $uname (keys(%srch_results)) {
16386: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16387: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16388: $inststatus_checked = 1;
16389: last;
16390: }
16391: }
16392: unless ($inststatus_checked) {
16393: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16394: if ($dirsrchres eq 'ok') {
16395: foreach my $uname (keys(%srch_results)) {
16396: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16397: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16398: $inststatus_checked = 1;
16399: last;
16400: }
16401: }
16402: }
16403: }
16404: }
16405: }
16406: if ($inststatus ne '') {
16407: foreach my $status (split(/\:/,$inststatus)) {
16408: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16409: my @contacts = ('adminemail','supportemail');
16410: foreach my $item (@contacts) {
16411: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16412: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16413: if (!grep(/^\Q$addr\E$/,@recipients)) {
16414: push(@recipients,$addr);
16415: }
16416: }
16417: }
16418: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16419: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16420: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16421: my @ok_bccs;
16422: foreach my $bcc (@bccs) {
16423: $bcc =~ s/^\s+//g;
16424: $bcc =~ s/\s+$//g;
16425: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16426: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16427: push(@ok_bccs,$bcc);
16428: }
16429: }
16430: }
16431: if (@ok_bccs > 0) {
16432: $allbcc = join(', ',@ok_bccs);
16433: }
16434: }
16435: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16436: last;
16437: }
16438: }
16439: }
16440: }
16441: }
1.619 raeburn 16442: } elsif ($origmail ne '') {
1.1270 raeburn 16443: $lastresort = $origmail;
16444: }
1.1297 raeburn 16445: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16446: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16447: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16448: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16449: my %what = (
16450: perlvar => 1,
16451: );
16452: my $primary = &Apache::lonnet::domain($defdom,'primary');
16453: if ($primary) {
16454: my $gotaddr;
16455: my ($result,$returnhash) =
16456: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16457: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16458: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16459: $lastresort = $returnhash->{'lonSupportEMail'};
16460: $gotaddr = 1;
16461: }
16462: }
16463: unless ($gotaddr) {
16464: my $uintdom = &Apache::lonnet::internet_dom($primary);
16465: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16466: unless ($uintdom eq $intdom) {
16467: my %domconfig =
16468: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16469: if (ref($domconfig{'contacts'}) eq 'HASH') {
16470: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16471: my @contacts = ('adminemail','supportemail');
16472: foreach my $item (@contacts) {
16473: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16474: my $addr = $domconfig{'contacts'}{$item};
16475: if (!grep(/^\Q$addr\E$/,@recipients)) {
16476: push(@recipients,$addr);
16477: }
16478: }
16479: }
16480: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16481: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16482: }
16483: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16484: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16485: my @ok_bccs;
16486: foreach my $bcc (@bccs) {
16487: $bcc =~ s/^\s+//g;
16488: $bcc =~ s/\s+$//g;
16489: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16490: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16491: push(@ok_bccs,$bcc);
16492: }
16493: }
16494: }
16495: if (@ok_bccs > 0) {
16496: $allbcc = join(', ',@ok_bccs);
16497: }
16498: }
16499: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16500: }
16501: }
16502: }
16503: }
16504: }
16505: }
1.618 raeburn 16506: }
1.688 raeburn 16507: if (defined($defmail)) {
16508: if ($defmail ne '') {
16509: push(@recipients,$defmail);
16510: }
1.618 raeburn 16511: }
16512: if ($otheremails) {
1.619 raeburn 16513: my @others;
16514: if ($otheremails =~ /,/) {
16515: @others = split(/,/,$otheremails);
1.618 raeburn 16516: } else {
1.619 raeburn 16517: push(@others,$otheremails);
16518: }
16519: foreach my $addr (@others) {
16520: if (!grep(/^\Q$addr\E$/,@recipients)) {
16521: push(@recipients,$addr);
16522: }
1.618 raeburn 16523: }
16524: }
1.1298 raeburn 16525: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16526: if ((!@recipients) && ($lastresort ne '')) {
16527: push(@recipients,$lastresort);
16528: }
16529: } elsif ($lastresort ne '') {
16530: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16531: push(@recipients,$lastresort);
16532: }
16533: }
1.1271 raeburn 16534: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16535: if (wantarray) {
16536: return ($recipientlist,$allbcc,$addtext);
16537: } else {
16538: return $recipientlist;
16539: }
1.618 raeburn 16540: }
16541:
1.127 matthew 16542: ############################################################
16543: ############################################################
1.154 albertel 16544:
1.655 raeburn 16545: =pod
16546:
1.1224 musolffc 16547: =over 4
16548:
1.1223 musolffc 16549: =item * &mime_email()
16550:
16551: Sends an email with a possible attachment
16552:
16553: Inputs:
16554:
16555: =over 4
16556:
16557: from - Sender's email address
16558:
1.1343 raeburn 16559: replyto - Reply-To email address
16560:
1.1223 musolffc 16561: to - Email address of recipient
16562:
16563: subject - Subject of email
16564:
16565: body - Body of email
16566:
16567: cc_string - Carbon copy email address
16568:
16569: bcc - Blind carbon copy email address
16570:
16571: attachment_path - Path of file to be attached
16572:
16573: file_name - Name of file to be attached
16574:
16575: attachment_text - The body of an attachment of type "TEXT"
16576:
16577: =back
16578:
16579: =back
16580:
16581: =cut
16582:
16583: ############################################################
16584: ############################################################
16585:
16586: sub mime_email {
1.1343 raeburn 16587: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16588: $file_name,$attachment_text) = @_;
16589:
1.1223 musolffc 16590: my $msg = MIME::Lite->new(
16591: From => $from,
16592: To => $to,
16593: Subject => $subject,
16594: Type =>'TEXT',
16595: Data => $body,
16596: );
1.1343 raeburn 16597: if ($replyto ne '') {
16598: $msg->add("Reply-To" => $replyto);
16599: }
1.1223 musolffc 16600: if ($cc_string ne '') {
16601: $msg->add("Cc" => $cc_string);
16602: }
16603: if ($bcc ne '') {
16604: $msg->add("Bcc" => $bcc);
16605: }
16606: $msg->attr("content-type" => "text/plain");
16607: $msg->attr("content-type.charset" => "UTF-8");
16608: # Attach file if given
16609: if ($attachment_path) {
16610: unless ($file_name) {
16611: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16612: }
16613: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16614: $msg->attach(Type => $type,
16615: Path => $attachment_path,
16616: Filename => $file_name
16617: );
16618: # Otherwise attach text if given
16619: } elsif ($attachment_text) {
16620: $msg->attach(Type => 'TEXT',
16621: Data => $attachment_text);
16622: }
16623: # Send it
16624: $msg->send('sendmail');
16625: }
16626:
16627: ############################################################
16628: ############################################################
16629:
16630: =pod
16631:
1.655 raeburn 16632: =head1 Course Catalog Routines
16633:
16634: =over 4
16635:
16636: =item * &gather_categories()
16637:
16638: Converts category definitions - keys of categories hash stored in
16639: coursecategories in configuration.db on the primary library server in a
16640: domain - to an array. Also generates javascript and idx hash used to
16641: generate Domain Coordinator interface for editing Course Categories.
16642:
16643: Inputs:
1.663 raeburn 16644:
1.655 raeburn 16645: categories (reference to hash of category definitions).
1.663 raeburn 16646:
1.655 raeburn 16647: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16648: categories and subcategories).
1.663 raeburn 16649:
1.655 raeburn 16650: idx (reference to hash of counters used in Domain Coordinator interface for
16651: editing Course Categories).
1.663 raeburn 16652:
1.655 raeburn 16653: jsarray (reference to array of categories used to create Javascript arrays for
16654: Domain Coordinator interface for editing Course Categories).
16655:
16656: Returns: nothing
16657:
16658: Side effects: populates cats, idx and jsarray.
16659:
16660: =cut
16661:
16662: sub gather_categories {
16663: my ($categories,$cats,$idx,$jsarray) = @_;
16664: my %counters;
16665: my $num = 0;
16666: foreach my $item (keys(%{$categories})) {
16667: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16668: if ($container eq '' && $depth == 0) {
16669: $cats->[$depth][$categories->{$item}] = $cat;
16670: } else {
16671: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16672: }
16673: my ($escitem,$tail) = split(/:/,$item,2);
16674: if ($counters{$tail} eq '') {
16675: $counters{$tail} = $num;
16676: $num ++;
16677: }
16678: if (ref($idx) eq 'HASH') {
16679: $idx->{$item} = $counters{$tail};
16680: }
16681: if (ref($jsarray) eq 'ARRAY') {
16682: push(@{$jsarray->[$counters{$tail}]},$item);
16683: }
16684: }
16685: return;
16686: }
16687:
16688: =pod
16689:
16690: =item * &extract_categories()
16691:
16692: Used to generate breadcrumb trails for course categories.
16693:
16694: Inputs:
1.663 raeburn 16695:
1.655 raeburn 16696: categories (reference to hash of category definitions).
1.663 raeburn 16697:
1.655 raeburn 16698: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16699: categories and subcategories).
1.663 raeburn 16700:
1.655 raeburn 16701: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16702:
1.655 raeburn 16703: allitems (reference to hash - key is category key
16704: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16705:
1.655 raeburn 16706: idx (reference to hash of counters used in Domain Coordinator interface for
16707: editing Course Categories).
1.663 raeburn 16708:
1.655 raeburn 16709: jsarray (reference to array of categories used to create Javascript arrays for
16710: Domain Coordinator interface for editing Course Categories).
16711:
1.665 raeburn 16712: subcats (reference to hash of arrays containing all subcategories within each
16713: category, -recursive)
16714:
1.1321 raeburn 16715: maxd (reference to hash used to hold max depth for all top-level categories).
16716:
1.655 raeburn 16717: Returns: nothing
16718:
16719: Side effects: populates trails and allitems hash references.
16720:
16721: =cut
16722:
16723: sub extract_categories {
1.1321 raeburn 16724: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16725: if (ref($categories) eq 'HASH') {
16726: &gather_categories($categories,$cats,$idx,$jsarray);
16727: if (ref($cats->[0]) eq 'ARRAY') {
16728: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16729: my $name = $cats->[0][$i];
16730: my $item = &escape($name).'::0';
16731: my $trailstr;
16732: if ($name eq 'instcode') {
16733: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16734: } elsif ($name eq 'communities') {
16735: $trailstr = &mt('Communities');
1.1239 raeburn 16736: } elsif ($name eq 'placement') {
16737: $trailstr = &mt('Placement Tests');
1.655 raeburn 16738: } else {
16739: $trailstr = $name;
16740: }
16741: if ($allitems->{$item} eq '') {
16742: push(@{$trails},$trailstr);
16743: $allitems->{$item} = scalar(@{$trails})-1;
16744: }
16745: my @parents = ($name);
16746: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16747: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16748: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16749: if (ref($subcats) eq 'HASH') {
16750: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16751: }
1.1321 raeburn 16752: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16753: }
16754: } else {
16755: if (ref($subcats) eq 'HASH') {
16756: $subcats->{$item} = [];
1.655 raeburn 16757: }
1.1321 raeburn 16758: if (ref($maxd) eq 'HASH') {
16759: $maxd->{$name} = 1;
16760: }
1.655 raeburn 16761: }
16762: }
16763: }
16764: }
16765: return;
16766: }
16767:
16768: =pod
16769:
1.1162 raeburn 16770: =item * &recurse_categories()
1.655 raeburn 16771:
16772: Recursively used to generate breadcrumb trails for course categories.
16773:
16774: Inputs:
1.663 raeburn 16775:
1.655 raeburn 16776: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16777: categories and subcategories).
1.663 raeburn 16778:
1.655 raeburn 16779: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16780:
16781: category (current course category, for which breadcrumb trail is being generated).
16782:
16783: trails (reference to array of breadcrumb trails for each category).
16784:
1.655 raeburn 16785: allitems (reference to hash - key is category key
16786: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16787:
1.655 raeburn 16788: parents (array containing containers directories for current category,
16789: back to top level).
16790:
16791: Returns: nothing
16792:
16793: Side effects: populates trails and allitems hash references
16794:
16795: =cut
16796:
16797: sub recurse_categories {
1.1321 raeburn 16798: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16799: my $shallower = $depth - 1;
16800: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16801: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16802: my $name = $cats->[$depth]{$category}[$k];
16803: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16804: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16805: if ($allitems->{$item} eq '') {
16806: push(@{$trails},$trailstr);
16807: $allitems->{$item} = scalar(@{$trails})-1;
16808: }
16809: my $deeper = $depth+1;
16810: push(@{$parents},$category);
1.665 raeburn 16811: if (ref($subcats) eq 'HASH') {
16812: my $subcat = &escape($name).':'.$category.':'.$depth;
16813: for (my $j=@{$parents}; $j>=0; $j--) {
16814: my $higher;
16815: if ($j > 0) {
16816: $higher = &escape($parents->[$j]).':'.
16817: &escape($parents->[$j-1]).':'.$j;
16818: } else {
16819: $higher = &escape($parents->[$j]).'::'.$j;
16820: }
16821: push(@{$subcats->{$higher}},$subcat);
16822: }
16823: }
16824: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16825: $subcats,$maxd);
1.655 raeburn 16826: pop(@{$parents});
16827: }
16828: } else {
16829: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16830: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16831: if ($allitems->{$item} eq '') {
16832: push(@{$trails},$trailstr);
16833: $allitems->{$item} = scalar(@{$trails})-1;
16834: }
1.1321 raeburn 16835: if (ref($maxd) eq 'HASH') {
16836: if ($depth > $maxd->{$parents->[0]}) {
16837: $maxd->{$parents->[0]} = $depth;
16838: }
16839: }
1.655 raeburn 16840: }
16841: return;
16842: }
16843:
1.663 raeburn 16844: =pod
16845:
1.1162 raeburn 16846: =item * &assign_categories_table()
1.663 raeburn 16847:
16848: Create a datatable for display of hierarchical categories in a domain,
16849: with checkboxes to allow a course to be categorized.
16850:
16851: Inputs:
16852:
16853: cathash - reference to hash of categories defined for the domain (from
16854: configuration.db)
16855:
16856: currcat - scalar with an & separated list of categories assigned to a course.
16857:
1.919 raeburn 16858: type - scalar contains course type (Course or Community).
16859:
1.1260 raeburn 16860: disabled - scalar (optional) contains disabled="disabled" if input elements are
16861: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16862:
1.663 raeburn 16863: Returns: $output (markup to be displayed)
16864:
16865: =cut
16866:
16867: sub assign_categories_table {
1.1259 raeburn 16868: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16869: my $output;
16870: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16871: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16872: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16873: $maxdepth = scalar(@cats);
16874: if (@cats > 0) {
16875: my $itemcount = 0;
16876: if (ref($cats[0]) eq 'ARRAY') {
16877: my @currcategories;
16878: if ($currcat ne '') {
16879: @currcategories = split('&',$currcat);
16880: }
1.919 raeburn 16881: my $table;
1.663 raeburn 16882: for (my $i=0; $i<@{$cats[0]}; $i++) {
16883: my $parent = $cats[0][$i];
1.919 raeburn 16884: next if ($parent eq 'instcode');
16885: if ($type eq 'Community') {
16886: next unless ($parent eq 'communities');
1.1239 raeburn 16887: } elsif ($type eq 'Placement') {
16888: next unless ($parent eq 'placement');
1.919 raeburn 16889: } else {
1.1239 raeburn 16890: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16891: }
1.663 raeburn 16892: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16893: my $item = &escape($parent).'::0';
16894: my $checked = '';
16895: if (@currcategories > 0) {
16896: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16897: $checked = ' checked="checked"';
1.663 raeburn 16898: }
16899: }
1.919 raeburn 16900: my $parent_title = $parent;
16901: if ($parent eq 'communities') {
16902: $parent_title = &mt('Communities');
1.1239 raeburn 16903: } elsif ($parent eq 'placement') {
16904: $parent_title = &mt('Placement Tests');
1.919 raeburn 16905: }
16906: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16907: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16908: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16909: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16910: my $depth = 1;
16911: push(@path,$parent);
1.1259 raeburn 16912: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16913: pop(@path);
1.919 raeburn 16914: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16915: $itemcount ++;
16916: }
1.919 raeburn 16917: if ($itemcount) {
16918: $output = &Apache::loncommon::start_data_table().
16919: $table.
16920: &Apache::loncommon::end_data_table();
16921: }
1.663 raeburn 16922: }
16923: }
16924: }
16925: return $output;
16926: }
16927:
16928: =pod
16929:
1.1162 raeburn 16930: =item * &assign_category_rows()
1.663 raeburn 16931:
16932: Create a datatable row for display of nested categories in a domain,
16933: with checkboxes to allow a course to be categorized,called recursively.
16934:
16935: Inputs:
16936:
16937: itemcount - track row number for alternating colors
16938:
16939: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16940: categories and subcategories.
16941:
16942: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16943:
16944: parent - parent of current category item
16945:
16946: path - Array containing all categories back up through the hierarchy from the
16947: current category to the top level.
16948:
16949: currcategories - reference to array of current categories assigned to the course
16950:
1.1260 raeburn 16951: disabled - scalar (optional) contains disabled="disabled" if input elements are
16952: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16953:
1.663 raeburn 16954: Returns: $output (markup to be displayed).
16955:
16956: =cut
16957:
16958: sub assign_category_rows {
1.1259 raeburn 16959: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16960: my ($text,$name,$item,$chgstr);
16961: if (ref($cats) eq 'ARRAY') {
16962: my $maxdepth = scalar(@{$cats});
16963: if (ref($cats->[$depth]) eq 'HASH') {
16964: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16965: my $numchildren = @{$cats->[$depth]{$parent}};
16966: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16967: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16968: for (my $j=0; $j<$numchildren; $j++) {
16969: $name = $cats->[$depth]{$parent}[$j];
16970: $item = &escape($name).':'.&escape($parent).':'.$depth;
16971: my $deeper = $depth+1;
16972: my $checked = '';
16973: if (ref($currcategories) eq 'ARRAY') {
16974: if (@{$currcategories} > 0) {
16975: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16976: $checked = ' checked="checked"';
1.663 raeburn 16977: }
16978: }
16979: }
1.664 raeburn 16980: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16981: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16982: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16983: '<input type="hidden" name="catname" value="'.$name.'" />'.
16984: '</td><td>';
1.663 raeburn 16985: if (ref($path) eq 'ARRAY') {
16986: push(@{$path},$name);
1.1259 raeburn 16987: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16988: pop(@{$path});
16989: }
16990: $text .= '</td></tr>';
16991: }
16992: $text .= '</table></td>';
16993: }
16994: }
16995: }
16996: return $text;
16997: }
16998:
1.1181 raeburn 16999: =pod
17000:
17001: =back
17002:
17003: =cut
17004:
1.655 raeburn 17005: ############################################################
17006: ############################################################
17007:
17008:
1.443 albertel 17009: sub commit_customrole {
1.1408 raeburn 17010: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 17011: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 17012: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
17013: $context,$othdomby,$requester);
1.630 raeburn 17014: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 17015: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 17016: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
17017: if (wantarray) {
17018: return ($output,$result);
17019: } else {
17020: return $output;
17021: }
1.443 albertel 17022: }
17023:
17024: sub commit_standardrole {
1.1408 raeburn 17025: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
17026: $othdomby,$requester) = @_;
1.1399 raeburn 17027: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 17028: if ($context eq 'auto') {
17029: $linefeed = "\n";
17030: } else {
17031: $linefeed = "<br />\n";
17032: }
1.443 albertel 17033: if ($three eq 'st') {
1.1399 raeburn 17034: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 17035: $one,$two,$sec,$context,$credits,$othdomby,
17036: $requester);
1.541 raeburn 17037: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 17038: ($result eq 'unknown_course') || ($result eq 'refused')) {
17039: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 17040: } else {
1.541 raeburn 17041: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 17042: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17043: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
17044: if ($context eq 'auto') {
17045: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
17046: } else {
17047: $output .= '<b>'.$result.'</b>'.$linefeed.
17048: &mt('Add to classlist').': <b>ok</b>';
17049: }
17050: $output .= $linefeed;
1.443 albertel 17051: }
17052: } else {
17053: $output = &mt('Assigning').' '.$three.' in '.$url.
17054: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17055: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17056: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17057: '','',$context,$othdomby,$requester);
1.541 raeburn 17058: if ($context eq 'auto') {
17059: $output .= $result.$linefeed;
17060: } else {
17061: $output .= '<b>'.$result.'</b>'.$linefeed;
17062: }
1.443 albertel 17063: }
1.1399 raeburn 17064: if (wantarray) {
17065: return ($output,$result);
17066: } else {
17067: return $output;
17068: }
1.443 albertel 17069: }
17070:
17071: sub commit_studentrole {
1.1116 raeburn 17072: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17073: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17074: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17075: if ($context eq 'auto') {
17076: $linefeed = "\n";
17077: } else {
17078: $linefeed = '<br />'."\n";
17079: }
1.443 albertel 17080: if (defined($one) && defined($two)) {
17081: my $cid=$one.'_'.$two;
17082: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17083: my $secchange = 0;
17084: my $expire_role_result;
17085: my $modify_section_result;
1.628 raeburn 17086: if ($oldsec ne '-1') {
17087: if ($oldsec ne $sec) {
1.443 albertel 17088: $secchange = 1;
1.628 raeburn 17089: my $now = time;
1.443 albertel 17090: my $uurl='/'.$cid;
17091: $uurl=~s/\_/\//g;
17092: if ($oldsec) {
17093: $uurl.='/'.$oldsec;
17094: }
1.626 raeburn 17095: $oldsecurl = $uurl;
1.628 raeburn 17096: $expire_role_result =
1.1408 raeburn 17097: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17098: '','','',$context,$othdomby,$requester);
17099: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17100: if ($expire_role_result eq 'refused') {
17101: my @roles = ('st');
17102: my @statuses = ('previous');
17103: my @roledoms = ($one);
17104: my $withsec = 1;
17105: my %roleshash =
17106: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17107: \@statuses,\@roles,\@roledoms,$withsec);
17108: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17109: my ($oldstart,$oldend) =
17110: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17111: if ($oldend > 0 && $oldend <= $now) {
17112: $expire_role_result = 'ok';
17113: }
17114: }
17115: }
17116: }
1.443 albertel 17117: $result = $expire_role_result;
17118: }
17119: }
17120: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17121: $modify_section_result =
17122: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17123: undef,undef,undef,$sec,
17124: $end,$start,'','',$cid,
1.1408 raeburn 17125: '',$context,$credits,'',
17126: $othdomby,$requester);
1.443 albertel 17127: if ($modify_section_result =~ /^ok/) {
17128: if ($secchange == 1) {
1.628 raeburn 17129: if ($sec eq '') {
17130: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17131: } else {
17132: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17133: }
1.443 albertel 17134: } elsif ($oldsec eq '-1') {
1.628 raeburn 17135: if ($sec eq '') {
17136: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17137: } else {
17138: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17139: }
1.443 albertel 17140: } else {
1.628 raeburn 17141: if ($sec eq '') {
17142: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17143: } else {
17144: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17145: }
1.443 albertel 17146: }
17147: } else {
1.1115 raeburn 17148: if ($secchange) {
1.628 raeburn 17149: $$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;
17150: } else {
17151: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17152: }
1.443 albertel 17153: }
17154: $result = $modify_section_result;
17155: } elsif ($secchange == 1) {
1.628 raeburn 17156: if ($oldsec eq '') {
1.1103 raeburn 17157: $$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 17158: } else {
17159: $$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;
17160: }
1.626 raeburn 17161: if ($expire_role_result eq 'refused') {
17162: my $newsecurl = '/'.$cid;
17163: $newsecurl =~ s/\_/\//g;
17164: if ($sec ne '') {
17165: $newsecurl.='/'.$sec;
17166: }
17167: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17168: if ($sec eq '') {
17169: $$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;
17170: } else {
17171: $$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;
17172: }
17173: }
17174: }
1.443 albertel 17175: }
17176: } else {
1.626 raeburn 17177: $$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 17178: $result = "error: incomplete course id\n";
17179: }
17180: return $result;
17181: }
17182:
1.1108 raeburn 17183: sub show_role_extent {
17184: my ($scope,$context,$role) = @_;
17185: $scope =~ s{^/}{};
17186: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17187: push(@courseroles,'co');
17188: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17189: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17190: $scope =~ s{/}{_};
17191: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17192: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17193: my ($audom,$auname) = split(/\//,$scope);
17194: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17195: &Apache::loncommon::plainname($auname,$audom).'</span>');
17196: } else {
17197: $scope =~ s{/$}{};
17198: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17199: &Apache::lonnet::domain($scope,'description').'</span>');
17200: }
17201: }
17202:
1.443 albertel 17203: ############################################################
17204: ############################################################
17205:
1.566 albertel 17206: sub check_clone {
1.578 raeburn 17207: my ($args,$linefeed) = @_;
1.566 albertel 17208: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17209: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17210: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17211: my $clonetitle;
17212: my @clonemsg;
1.566 albertel 17213: my $can_clone = 0;
1.944 raeburn 17214: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17215: if ($lctype ne 'community') {
17216: $lctype = 'course';
17217: }
1.566 albertel 17218: if ($clonehome eq 'no_host') {
1.944 raeburn 17219: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17220: push(@clonemsg,({
17221: mt => 'No new community created.',
17222: args => [],
17223: },
17224: {
17225: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17226: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17227: }));
1.908 raeburn 17228: } else {
1.1344 raeburn 17229: push(@clonemsg,({
17230: mt => 'No new course created.',
17231: args => [],
17232: },
17233: {
17234: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17235: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17236: }));
17237: }
1.566 albertel 17238: } else {
17239: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17240: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17241: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17242: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17243: push(@clonemsg,({
17244: mt => 'No new community created.',
17245: args => [],
17246: },
17247: {
17248: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17249: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17250: }));
17251: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17252: }
17253: }
1.1262 raeburn 17254: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17255: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17256: $can_clone = 1;
17257: } else {
1.1221 raeburn 17258: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17259: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17260: if ($clonehash{'cloners'} eq '') {
17261: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17262: if ($domdefs{'canclone'}) {
17263: unless ($domdefs{'canclone'} eq 'none') {
17264: if ($domdefs{'canclone'} eq 'domain') {
17265: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17266: $can_clone = 1;
17267: }
17268: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17269: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17270: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17271: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17272: $can_clone = 1;
17273: }
17274: }
17275: }
17276: }
1.578 raeburn 17277: } else {
1.1221 raeburn 17278: my @cloners = split(/,/,$clonehash{'cloners'});
17279: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17280: $can_clone = 1;
1.1221 raeburn 17281: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17282: $can_clone = 1;
1.1225 raeburn 17283: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17284: $can_clone = 1;
1.1221 raeburn 17285: }
17286: unless ($can_clone) {
1.1225 raeburn 17287: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17288: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17289: my (%gotdomdefaults,%gotcodedefaults);
17290: foreach my $cloner (@cloners) {
17291: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17292: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17293: my (%codedefaults,@code_order);
17294: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17295: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17296: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17297: }
17298: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17299: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17300: }
17301: } else {
17302: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17303: \%codedefaults,
17304: \@code_order);
17305: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17306: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17307: }
17308: if (@code_order > 0) {
17309: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17310: $cloner,$clonehash{'internal.coursecode'},
17311: $args->{'crscode'})) {
17312: $can_clone = 1;
17313: last;
17314: }
17315: }
17316: }
17317: }
17318: }
1.1225 raeburn 17319: }
17320: }
17321: unless ($can_clone) {
17322: my $ccrole = 'cc';
17323: if ($args->{'crstype'} eq 'Community') {
17324: $ccrole = 'co';
17325: }
17326: my %roleshash =
17327: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17328: $args->{'ccdomain'},
17329: 'userroles',['active'],[$ccrole],
17330: [$args->{'clonedomain'}]);
17331: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17332: $can_clone = 1;
17333: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17334: $args->{'ccuname'},$args->{'ccdomain'})) {
17335: $can_clone = 1;
1.1221 raeburn 17336: }
17337: }
17338: unless ($can_clone) {
17339: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17340: push(@clonemsg,({
17341: mt => 'No new community created.',
17342: args => [],
17343: },
17344: {
17345: 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]).',
17346: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17347: }));
1.942 raeburn 17348: } else {
1.1344 raeburn 17349: push(@clonemsg,({
17350: mt => 'No new course created.',
17351: args => [],
17352: },
17353: {
17354: 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]).',
17355: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17356: }));
1.1221 raeburn 17357: }
1.566 albertel 17358: }
1.578 raeburn 17359: }
1.566 albertel 17360: }
1.1344 raeburn 17361: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17362: }
17363:
1.444 albertel 17364: sub construct_course {
1.1262 raeburn 17365: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17366: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17367: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17368: my $linefeed = '<br />'."\n";
17369: if ($context eq 'auto') {
17370: $linefeed = "\n";
17371: }
1.566 albertel 17372:
17373: #
17374: # Are we cloning?
17375: #
1.1344 raeburn 17376: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17377: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17378: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17379: if (!$can_clone) {
1.1344 raeburn 17380: return (0,$outcome,$clonemsgref);
1.566 albertel 17381: }
17382: }
17383:
1.444 albertel 17384: #
17385: # Open course
17386: #
1.1239 raeburn 17387: my $showncrstype;
17388: if ($args->{'crstype'} eq 'Placement') {
17389: $showncrstype = 'placement test';
17390: } else {
17391: $showncrstype = lc($args->{'crstype'});
17392: }
1.444 albertel 17393: my %cenv=();
17394: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17395: $args->{'cdescr'},
17396: $args->{'curl'},
17397: $args->{'course_home'},
17398: $args->{'nonstandard'},
17399: $args->{'crscode'},
17400: $args->{'ccuname'}.':'.
17401: $args->{'ccdomain'},
1.882 raeburn 17402: $args->{'crstype'},
1.1344 raeburn 17403: $cnum,$context,$category,
17404: $callercontext);
1.444 albertel 17405:
17406: # Note: The testing routines depend on this being output; see
17407: # Utils::Course. This needs to at least be output as a comment
17408: # if anyone ever decides to not show this, and Utils::Course::new
17409: # will need to be suitably modified.
1.1344 raeburn 17410: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17411: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17412: } else {
17413: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17414: }
1.943 raeburn 17415: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17416: return (0,$outcome,$clonemsgref);
1.943 raeburn 17417: }
17418:
1.444 albertel 17419: #
17420: # Check if created correctly
17421: #
1.479 albertel 17422: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17423: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17424: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17425: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17426: $outcome .= &mt_user($user_lh,
17427: 'Course creation failed, unrecognized course home server.');
17428: } else {
17429: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17430: }
17431: $outcome .= $linefeed;
17432: return (0,$outcome,$clonemsgref);
1.943 raeburn 17433: }
1.541 raeburn 17434: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17435:
1.444 albertel 17436: #
1.566 albertel 17437: # Do the cloning
17438: #
1.1344 raeburn 17439: my @clonemsg;
1.566 albertel 17440: if ($can_clone && $cloneid) {
1.1344 raeburn 17441: push(@clonemsg,
17442: {
17443: mt => 'Created [_1] by cloning from [_2]',
17444: args => [$showncrstype,$clonetitle],
17445: });
1.566 albertel 17446: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17447: # Copy all files
1.1344 raeburn 17448: my @info =
17449: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17450: $args->{'dateshift'},$args->{'crscode'},
17451: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17452: $args->{'tinyurls'});
17453: if (@info) {
17454: push(@clonemsg,@info);
17455: }
1.444 albertel 17456: # Restore URL
1.566 albertel 17457: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17458: # Restore title
1.566 albertel 17459: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17460: # Restore creation date, creator and creation context.
17461: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17462: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17463: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17464: # Mark as cloned
1.566 albertel 17465: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17466: # Need to clone grading mode
17467: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17468: $cenv{'grading'}=$newenv{'grading'};
17469: # Do not clone these environment entries
17470: &Apache::lonnet::del('environment',
17471: ['default_enrollment_start_date',
17472: 'default_enrollment_end_date',
17473: 'question.email',
17474: 'policy.email',
17475: 'comment.email',
17476: 'pch.users.denied',
1.725 raeburn 17477: 'plc.users.denied',
17478: 'hidefromcat',
1.1121 raeburn 17479: 'checkforpriv',
1.1355 raeburn 17480: 'categories'],
1.638 www 17481: $$crsudom,$$crsunum);
1.1170 raeburn 17482: if ($args->{'textbook'}) {
17483: $cenv{'internal.textbook'} = $args->{'textbook'};
17484: }
1.444 albertel 17485: }
1.566 albertel 17486:
1.444 albertel 17487: #
17488: # Set environment (will override cloned, if existing)
17489: #
17490: my @sections = ();
17491: my @xlists = ();
17492: if ($args->{'crstype'}) {
17493: $cenv{'type'}=$args->{'crstype'};
17494: }
1.1371 raeburn 17495: if ($args->{'lti'}) {
17496: $cenv{'internal.lti'}=$args->{'lti'};
17497: }
1.444 albertel 17498: if ($args->{'crsid'}) {
17499: $cenv{'courseid'}=$args->{'crsid'};
17500: }
17501: if ($args->{'crscode'}) {
17502: $cenv{'internal.coursecode'}=$args->{'crscode'};
17503: }
17504: if ($args->{'crsquota'} ne '') {
17505: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17506: } else {
17507: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17508: }
17509: if ($args->{'ccuname'}) {
17510: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17511: ':'.$args->{'ccdomain'};
17512: } else {
17513: $cenv{'internal.courseowner'} = $args->{'curruser'};
17514: }
1.1116 raeburn 17515: if ($args->{'defaultcredits'}) {
17516: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17517: }
1.444 albertel 17518: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17519: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17520: if ($args->{'crssections'}) {
17521: $cenv{'internal.sectionnums'} = '';
17522: if ($args->{'crssections'} =~ m/,/) {
17523: @sections = split/,/,$args->{'crssections'};
17524: } else {
17525: $sections[0] = $args->{'crssections'};
17526: }
17527: if (@sections > 0) {
17528: foreach my $item (@sections) {
17529: my ($sec,$gp) = split/:/,$item;
17530: my $class = $args->{'crscode'}.$sec;
17531: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17532: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17533: if ($addcheck eq 'ok') {
17534: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17535: push(@oklcsecs,$gp);
17536: }
17537: } else {
1.1263 raeburn 17538: push(@badclasses,$class);
1.444 albertel 17539: }
17540: }
17541: $cenv{'internal.sectionnums'} =~ s/,$//;
17542: }
17543: }
17544: # do not hide course coordinator from staff listing,
17545: # even if privileged
17546: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17547: # add course coordinator's domain to domains to check for privileged users
17548: # if different to course domain
17549: if ($$crsudom ne $args->{'ccdomain'}) {
17550: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17551: }
1.444 albertel 17552: # add crosslistings
17553: if ($args->{'crsxlist'}) {
17554: $cenv{'internal.crosslistings'}='';
17555: if ($args->{'crsxlist'} =~ m/,/) {
17556: @xlists = split/,/,$args->{'crsxlist'};
17557: } else {
17558: $xlists[0] = $args->{'crsxlist'};
17559: }
17560: if (@xlists > 0) {
17561: foreach my $item (@xlists) {
17562: my ($xl,$gp) = split/:/,$item;
17563: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17564: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17565: if ($addcheck eq 'ok') {
17566: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17567: push(@oklcsecs,$gp);
17568: }
17569: } else {
1.1263 raeburn 17570: push(@badclasses,$xl);
1.444 albertel 17571: }
17572: }
17573: $cenv{'internal.crosslistings'} =~ s/,$//;
17574: }
17575: }
17576: if ($args->{'autoadds'}) {
17577: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17578: }
17579: if ($args->{'autodrops'}) {
17580: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17581: }
17582: # check for notification of enrollment changes
17583: my @notified = ();
17584: if ($args->{'notify_owner'}) {
17585: if ($args->{'ccuname'} ne '') {
17586: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17587: }
17588: }
17589: if ($args->{'notify_dc'}) {
17590: if ($uname ne '') {
1.630 raeburn 17591: push(@notified,$uname.':'.$udom);
1.444 albertel 17592: }
17593: }
17594: if (@notified > 0) {
17595: my $notifylist;
17596: if (@notified > 1) {
17597: $notifylist = join(',',@notified);
17598: } else {
17599: $notifylist = $notified[0];
17600: }
17601: $cenv{'internal.notifylist'} = $notifylist;
17602: }
17603: if (@badclasses > 0) {
17604: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17605: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17606: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17607: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17608: );
1.1264 raeburn 17609: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17610: &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 17611: if ($context eq 'auto') {
17612: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17613: } else {
1.566 albertel 17614: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17615: }
17616: foreach my $item (@badclasses) {
1.541 raeburn 17617: if ($context eq 'auto') {
1.1261 raeburn 17618: $outcome .= " - $item\n";
1.541 raeburn 17619: } else {
1.1261 raeburn 17620: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17621: }
1.1261 raeburn 17622: }
17623: if ($context eq 'auto') {
17624: $outcome .= $linefeed;
17625: } else {
17626: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17627: }
1.444 albertel 17628: }
17629: if ($args->{'no_end_date'}) {
17630: $args->{'endaccess'} = 0;
17631: }
1.1412 raeburn 17632: # If an official course with institutional sections is created by cloning
17633: # an existing course, section-specific hiding of course totals in student's
17634: # view of grades as copied from cloned course, will be checked for valid
17635: # sections.
17636: if (($can_clone && $cloneid) &&
17637: ($cenv{'internal.coursecode'} ne '') &&
17638: ($cenv{'grading'} eq 'standard') &&
17639: ($cenv{'hidetotals'} ne '') &&
17640: ($cenv{'hidetotals'} ne 'all')) {
17641: my @hidesecs;
17642: my $deletehidetotals;
17643: if (@oklcsecs) {
17644: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17645: if (grep(/^\Q$sec$/,@oklcsecs)) {
17646: push(@hidesecs,$sec);
17647: }
17648: }
17649: if (@hidesecs) {
17650: $cenv{'hidetotals'} = join(',',@hidesecs);
17651: } else {
17652: $deletehidetotals = 1;
17653: }
17654: } else {
17655: $deletehidetotals = 1;
17656: }
17657: if ($deletehidetotals) {
17658: delete($cenv{'hidetotals'});
17659: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17660: }
17661: }
1.444 albertel 17662: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17663: $cenv{'internal.autoend'}=$args->{'enrollend'};
17664: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17665: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17666: if ($args->{'showphotos'}) {
17667: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17668: }
17669: $cenv{'internal.authtype'} = $args->{'authtype'};
17670: $cenv{'internal.autharg'} = $args->{'autharg'};
17671: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17672: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17673: 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');
17674: if ($context eq 'auto') {
17675: $outcome .= $krb_msg;
17676: } else {
1.566 albertel 17677: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17678: }
17679: $outcome .= $linefeed;
1.444 albertel 17680: }
17681: }
17682: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17683: if ($args->{'setpolicy'}) {
17684: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17685: }
17686: if ($args->{'setcontent'}) {
17687: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17688: }
1.1251 raeburn 17689: if ($args->{'setcomment'}) {
17690: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17691: }
1.444 albertel 17692: }
17693: if ($args->{'reshome'}) {
17694: $cenv{'reshome'}=$args->{'reshome'}.'/';
17695: $cenv{'reshome'}=~s/\/+$/\//;
17696: }
17697: #
17698: # course has keyed access
17699: #
17700: if ($args->{'setkeys'}) {
17701: $cenv{'keyaccess'}='yes';
17702: }
17703: # if specified, key authority is not course, but user
17704: # only active if keyaccess is yes
17705: if ($args->{'keyauth'}) {
1.487 albertel 17706: my ($user,$domain) = split(':',$args->{'keyauth'});
17707: $user = &LONCAPA::clean_username($user);
17708: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17709: if ($user ne '' && $domain ne '') {
1.487 albertel 17710: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17711: }
17712: }
17713:
1.1166 raeburn 17714: #
1.1167 raeburn 17715: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17716: #
17717: if ($args->{'uniquecode'}) {
17718: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17719: if ($code) {
17720: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17721: my %crsinfo =
17722: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17723: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17724: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17725: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17726: }
1.1166 raeburn 17727: if (ref($coderef)) {
17728: $$coderef = $code;
17729: }
17730: }
17731: }
17732:
1.444 albertel 17733: if ($args->{'disresdis'}) {
17734: $cenv{'pch.roles.denied'}='st';
17735: }
17736: if ($args->{'disablechat'}) {
17737: $cenv{'plc.roles.denied'}='st';
17738: }
17739:
17740: # Record we've not yet viewed the Course Initialization Helper for this
17741: # course
17742: $cenv{'course.helper.not.run'} = 1;
17743: #
17744: # Use new Randomseed
17745: #
17746: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17747: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17748: #
17749: # The encryption code and receipt prefix for this course
17750: #
17751: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17752: $cenv{'internal.encpref'}=100+int(9*rand(99));
17753: #
17754: # By default, use standard grading
17755: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17756:
1.541 raeburn 17757: $outcome .= $linefeed.&mt('Setting environment').': '.
17758: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17759: #
17760: # Open all assignments
17761: #
17762: if ($args->{'openall'}) {
1.1341 raeburn 17763: my $opendate = time;
17764: if ($args->{'openallfrom'} =~ /^\d+$/) {
17765: $opendate = $args->{'openallfrom'};
17766: }
1.444 albertel 17767: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17768: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17769: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17770: $outcome .= &mt('All assignments open starting [_1]',
17771: &Apache::lonlocal::locallocaltime($opendate)).': '.
17772: &Apache::lonnet::cput
17773: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17774: }
17775: #
17776: # Set first page
17777: #
17778: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17779: || ($cloneid)) {
17780: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17781:
17782: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17783: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17784:
1.444 albertel 17785: $outcome .= ($fatal?$errtext:'read ok').' - ';
17786: my $title; my $url;
17787: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17788: $title=&mt('Syllabus');
1.444 albertel 17789: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17790: } else {
1.963 raeburn 17791: $title=&mt('Table of Contents');
1.444 albertel 17792: $url='/adm/navmaps';
17793: }
1.445 albertel 17794:
17795: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17796: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17797:
17798: if ($errtext) { $fatal=2; }
1.541 raeburn 17799: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17800: }
1.566 albertel 17801:
1.1237 raeburn 17802: #
17803: # Set params for Placement Tests
17804: #
1.1239 raeburn 17805: if ($args->{'crstype'} eq 'Placement') {
17806: my %storecontent;
17807: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17808: my %defaults = (
17809: buttonshide => { value => 'yes',
17810: type => 'string_yesno',},
17811: type => { value => 'randomizetry',
17812: type => 'string_questiontype',},
17813: maxtries => { value => 1,
17814: type => 'int_pos',},
17815: problemstatus => { value => 'no',
17816: type => 'string_problemstatus',},
17817: );
17818: foreach my $key (keys(%defaults)) {
17819: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17820: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17821: }
1.1237 raeburn 17822: &Apache::lonnet::cput
17823: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17824: }
17825:
1.1344 raeburn 17826: return (1,$outcome,\@clonemsg);
1.444 albertel 17827: }
17828:
1.1166 raeburn 17829: sub make_unique_code {
17830: my ($cdom,$cnum) = @_;
17831: # get lock on uniquecodes db
17832: my $lockhash = {
17833: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17834: ':'.$env{'user.domain'},
17835: };
17836: my $tries = 0;
17837: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17838: my ($code,$error);
17839:
17840: while (($gotlock ne 'ok') && ($tries<3)) {
17841: $tries ++;
17842: sleep 1;
17843: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17844: }
17845: if ($gotlock eq 'ok') {
17846: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17847: my $gotcode;
17848: my $attempts = 0;
17849: while ((!$gotcode) && ($attempts < 100)) {
17850: $code = &generate_code();
17851: if (!exists($currcodes{$code})) {
17852: $gotcode = 1;
17853: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17854: $error = 'nostore';
17855: }
17856: }
17857: $attempts ++;
17858: }
17859: my @del_lock = ($cnum."\0".'uniquecodes');
17860: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17861: } else {
17862: $error = 'nolock';
17863: }
17864: return ($code,$error);
17865: }
17866:
17867: sub generate_code {
17868: my $code;
17869: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17870: for (my $i=0; $i<6; $i++) {
17871: my $lettnum = int (rand 2);
17872: my $item = '';
17873: if ($lettnum) {
17874: $item = $letts[int( rand(18) )];
17875: } else {
17876: $item = 1+int( rand(8) );
17877: }
17878: $code .= $item;
17879: }
17880: return $code;
17881: }
17882:
1.444 albertel 17883: ############################################################
17884: ############################################################
17885:
1.1237 raeburn 17886: # Community, Course and Placement Test
1.378 raeburn 17887: sub course_type {
17888: my ($cid) = @_;
17889: if (!defined($cid)) {
17890: $cid = $env{'request.course.id'};
17891: }
1.404 albertel 17892: if (defined($env{'course.'.$cid.'.type'})) {
17893: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17894: } else {
17895: return 'Course';
1.377 raeburn 17896: }
17897: }
1.156 albertel 17898:
1.406 raeburn 17899: sub group_term {
17900: my $crstype = &course_type();
17901: my %names = (
17902: 'Course' => 'group',
1.865 raeburn 17903: 'Community' => 'group',
1.1237 raeburn 17904: 'Placement' => 'group',
1.406 raeburn 17905: );
17906: return $names{$crstype};
17907: }
17908:
1.902 raeburn 17909: sub course_types {
1.1310 raeburn 17910: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17911: my %typename = (
17912: official => 'Official course',
17913: unofficial => 'Unofficial course',
17914: community => 'Community',
1.1165 raeburn 17915: textbook => 'Textbook course',
1.1237 raeburn 17916: placement => 'Placement test',
1.1310 raeburn 17917: lti => 'LTI provider',
1.902 raeburn 17918: );
17919: return (\@types,\%typename);
17920: }
17921:
1.156 albertel 17922: sub icon {
17923: my ($file)=@_;
1.505 albertel 17924: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17925: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17926: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17927: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17928: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17929: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17930: $curfext.".gif") {
17931: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17932: $curfext.".gif";
17933: }
17934: }
1.249 albertel 17935: return &lonhttpdurl($iconname);
1.154 albertel 17936: }
1.84 albertel 17937:
1.575 albertel 17938: sub lonhttpdurl {
1.692 www 17939: #
17940: # Had been used for "small fry" static images on separate port 8080.
17941: # Modify here if lightweight http functionality desired again.
17942: # Currently eliminated due to increasing firewall issues.
17943: #
1.575 albertel 17944: my ($url)=@_;
1.692 www 17945: return $url;
1.215 albertel 17946: }
17947:
1.213 albertel 17948: sub connection_aborted {
17949: my ($r)=@_;
17950: $r->print(" ");$r->rflush();
17951: my $c = $r->connection;
17952: return $c->aborted();
17953: }
17954:
1.221 foxr 17955: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17956: # strings as 'strings'.
17957: sub escape_single {
1.221 foxr 17958: my ($input) = @_;
1.223 albertel 17959: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17960: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17961: return $input;
17962: }
1.223 albertel 17963:
1.222 foxr 17964: # Same as escape_single, but escape's "'s This
17965: # can be used for "strings"
17966: sub escape_double {
17967: my ($input) = @_;
17968: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17969: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17970: return $input;
17971: }
1.223 albertel 17972:
1.222 foxr 17973: # Escapes the last element of a full URL.
17974: sub escape_url {
17975: my ($url) = @_;
1.238 raeburn 17976: my @urlslices = split(/\//, $url,-1);
1.369 www 17977: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17978: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17979: }
1.462 albertel 17980:
1.820 raeburn 17981: sub compare_arrays {
17982: my ($arrayref1,$arrayref2) = @_;
17983: my (@difference,%count);
17984: @difference = ();
17985: %count = ();
17986: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17987: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17988: foreach my $element (keys(%count)) {
17989: if ($count{$element} == 1) {
17990: push(@difference,$element);
17991: }
17992: }
17993: }
17994: return @difference;
17995: }
17996:
1.1322 raeburn 17997: sub lon_status_items {
17998: my %defaults = (
17999: E => 100,
18000: W => 4,
18001: N => 1,
1.1324 raeburn 18002: U => 5,
1.1322 raeburn 18003: threshold => 200,
18004: sysmail => 2500,
18005: );
18006: my %names = (
18007: E => 'Errors',
18008: W => 'Warnings',
18009: N => 'Notices',
1.1324 raeburn 18010: U => 'Unsent',
1.1322 raeburn 18011: );
18012: return (\%defaults,\%names);
18013: }
18014:
1.817 bisitz 18015: # -------------------------------------------------------- Initialize user login
1.462 albertel 18016: sub init_user_environment {
1.463 albertel 18017: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 18018: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
18019:
18020: my $public=($username eq 'public' && $domain eq 'public');
18021:
1.1415 raeburn 18022: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
18023: $coauthorenv);
1.462 albertel 18024: my $now=time;
18025:
18026: if ($public) {
18027: my $max_public=100;
18028: my $oldest;
18029: my $oldest_time=0;
18030: for(my $next=1;$next<=$max_public;$next++) {
18031: if (-e $lonids."/publicuser_$next.id") {
18032: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
18033: if ($mtime<$oldest_time || !$oldest_time) {
18034: $oldest_time=$mtime;
18035: $oldest=$next;
18036: }
18037: } else {
18038: $cookie="publicuser_$next";
18039: last;
18040: }
18041: }
18042: if (!$cookie) { $cookie="publicuser_$oldest"; }
18043: } else {
1.1275 raeburn 18044: # See if old ID present, if so, remove if this isn't a robot,
18045: # killing any existing non-robot sessions
1.463 albertel 18046: if (!$args->{'robot'}) {
18047: opendir(DIR,$lonids);
18048: while ($filename=readdir(DIR)) {
18049: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 18050: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
18051: &GDBM_READER(),0640)) {
1.1295 raeburn 18052: my $linkedfile;
1.1320 raeburn 18053: if (exists($oldenv{'user.linkedenv'})) {
18054: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18055: }
1.1320 raeburn 18056: untie(%oldenv);
18057: if (unlink("$lonids/$filename")) {
18058: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18059: if (-l "$lonids/$linkedfile.id") {
18060: unlink("$lonids/$linkedfile.id");
18061: }
1.1295 raeburn 18062: }
18063: }
18064: } else {
18065: unlink($lonids.'/'.$filename);
18066: }
1.463 albertel 18067: }
1.462 albertel 18068: }
1.463 albertel 18069: closedir(DIR);
1.1204 raeburn 18070: # If there is a undeleted lockfile for the user's paste buffer remove it.
18071: my $namespace = 'nohist_courseeditor';
18072: my $lockingkey = 'paste'."\0".'locked_num';
18073: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18074: $domain,$username);
18075: if (exists($lockhash{$lockingkey})) {
18076: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18077: unless ($delresult eq 'ok') {
18078: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18079: }
18080: }
1.462 albertel 18081: }
18082: # Give them a new cookie
1.463 albertel 18083: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18084: : $now.$$.int(rand(10000)));
1.463 albertel 18085: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18086:
18087: # Initialize roles
18088:
1.1414 raeburn 18089: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18090: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18091: }
18092: # ------------------------------------ Check browser type and MathML capability
18093:
1.1194 raeburn 18094: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18095: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18096:
18097: # ------------------------------------------------------------- Get environment
18098:
18099: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18100: my ($tmp) = keys(%userenv);
1.1275 raeburn 18101: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18102: undef(%userenv);
18103: }
18104: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18105: $form->{'interface'}=$userenv{'interface'};
18106: }
18107: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18108:
18109: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18110: foreach my $option ('interface','localpath','localres') {
18111: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18112: }
18113: # --------------------------------------------------------- Write first profile
18114:
18115: {
1.1350 raeburn 18116: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18117: my %initial_env =
18118: ("user.name" => $username,
18119: "user.domain" => $domain,
18120: "user.home" => $authhost,
18121: "browser.type" => $clientbrowser,
18122: "browser.version" => $clientversion,
18123: "browser.mathml" => $clientmathml,
18124: "browser.unicode" => $clientunicode,
18125: "browser.os" => $clientos,
1.1137 raeburn 18126: "browser.mobile" => $clientmobile,
1.1141 raeburn 18127: "browser.info" => $clientinfo,
1.1194 raeburn 18128: "browser.osversion" => $clientosversion,
1.462 albertel 18129: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18130: "request.course.fn" => '',
18131: "request.course.uri" => '',
18132: "request.course.sec" => '',
18133: "request.role" => 'cm',
18134: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18135: "request.host" => $ip,);
1.462 albertel 18136:
18137: if ($form->{'localpath'}) {
18138: $initial_env{"browser.localpath"} = $form->{'localpath'};
18139: $initial_env{"browser.localres"} = $form->{'localres'};
18140: }
18141:
18142: if ($form->{'interface'}) {
18143: $form->{'interface'}=~s/\W//gs;
18144: $initial_env{"browser.interface"} = $form->{'interface'};
18145: $env{'browser.interface'}=$form->{'interface'};
18146: }
18147:
1.1157 raeburn 18148: if ($form->{'iptoken'}) {
18149: my $lonhost = $r->dir_config('lonHostID');
18150: $initial_env{"user.noloadbalance"} = $lonhost;
18151: $env{'user.noloadbalance'} = $lonhost;
18152: }
18153:
1.1268 raeburn 18154: if ($form->{'noloadbalance'}) {
18155: my @hosts = &Apache::lonnet::current_machine_ids();
18156: my $hosthere = $form->{'noloadbalance'};
18157: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18158: $initial_env{"user.noloadbalance"} = $hosthere;
18159: $env{'user.noloadbalance'} = $hosthere;
18160: }
18161: }
18162:
1.1016 raeburn 18163: unless ($domain eq 'public') {
1.1273 raeburn 18164: my %is_adv = ( is_adv => $env{'user.adv'} );
18165: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18166:
1.1414 raeburn 18167: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18168: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18169: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18170: undef,\%userenv,\%domdef,\%is_adv);
18171: }
1.980 raeburn 18172:
1.1311 raeburn 18173: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18174: $userenv{'canrequest.'.$crstype} =
18175: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18176: 'reload','requestcourses',
18177: \%userenv,\%domdef,\%is_adv);
18178: }
1.724 raeburn 18179:
1.1418 raeburn 18180: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18181: (exists($userroles->{"user.role.au./$domain/"}))) {
18182: if ($userenv{'authoreditors'}) {
18183: $userenv{'editors'} = $userenv{'authoreditors'};
18184: } elsif ($domdef{'editors'} ne '') {
18185: $userenv{'editors'} = $domdef{'editors'};
18186: } else {
18187: $userenv{'editors'} = 'edit,xml';
18188: }
1.1431 raeburn 18189: if ($userenv{'authorarchive'}) {
18190: $userenv{'canarchive'} = 1;
18191: } elsif (($userenv{'authorarchive'} eq '') &&
18192: ($domdef{'archive'})) {
18193: $userenv{'canarchive'} = 1;
18194: }
1.1418 raeburn 18195: }
18196:
1.1273 raeburn 18197: $userenv{'canrequest.author'} =
18198: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18199: 'reload','requestauthor',
1.980 raeburn 18200: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18201: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18202: $domain,$username);
18203: my $reqstatus = $reqauthor{'author_status'};
18204: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18205: if (ref($reqauthor{'author'}) eq 'HASH') {
18206: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18207: $reqauthor{'author'}{'timestamp'};
18208: }
1.1092 raeburn 18209: }
1.1287 raeburn 18210: my ($types,$typename) = &course_types();
18211: if (ref($types) eq 'ARRAY') {
18212: my @options = ('approval','validate','autolimit');
18213: my $optregex = join('|',@options);
18214: my (%willtrust,%trustchecked);
18215: foreach my $type (@{$types}) {
18216: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18217: if ($dom_str ne '') {
18218: my $updatedstr = '';
18219: my @possdomains = split(',',$dom_str);
18220: foreach my $entry (@possdomains) {
18221: my ($extdom,$extopt) = split(':',$entry);
18222: unless ($trustchecked{$extdom}) {
18223: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18224: $trustchecked{$extdom} = 1;
18225: }
18226: if ($willtrust{$extdom}) {
18227: $updatedstr .= $entry.',';
18228: }
18229: }
18230: $updatedstr =~ s/,$//;
18231: if ($updatedstr) {
18232: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18233: } else {
18234: delete($userenv{'reqcrsotherdom.'.$type});
18235: }
18236: }
18237: }
18238: }
1.1092 raeburn 18239: }
1.462 albertel 18240: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18241:
1.462 albertel 18242: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18243: &GDBM_WRCREAT(),0640)) {
18244: &_add_to_env(\%disk_env,\%initial_env);
18245: &_add_to_env(\%disk_env,\%userenv,'environment.');
18246: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18247: if (ref($firstaccenv) eq 'HASH') {
18248: &_add_to_env(\%disk_env,$firstaccenv);
18249: }
18250: if (ref($timerintenv) eq 'HASH') {
18251: &_add_to_env(\%disk_env,$timerintenv);
18252: }
1.1414 raeburn 18253: if (ref($coauthorenv) eq 'HASH') {
18254: if (keys(%{$coauthorenv})) {
18255: &_add_to_env(\%disk_env,$coauthorenv);
18256: }
18257: }
1.463 albertel 18258: if (ref($args->{'extra_env'})) {
18259: &_add_to_env(\%disk_env,$args->{'extra_env'});
18260: }
1.462 albertel 18261: untie(%disk_env);
18262: } else {
1.705 tempelho 18263: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18264: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18265: return 'error: '.$!;
18266: }
18267: }
18268: $env{'request.role'}='cm';
18269: $env{'request.role.adv'}=$env{'user.adv'};
18270: $env{'browser.type'}=$clientbrowser;
18271:
18272: return $cookie;
18273:
18274: }
18275:
18276: sub _add_to_env {
18277: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18278: if (ref($env_data) eq 'HASH') {
18279: while (my ($key,$value) = each(%$env_data)) {
18280: $idf->{$prefix.$key} = $value;
18281: $env{$prefix.$key} = $value;
18282: }
1.462 albertel 18283: }
18284: }
18285:
1.685 tempelho 18286: # --- Get the symbolic name of a problem and the url
18287: sub get_symb {
18288: my ($request,$silent) = @_;
1.726 raeburn 18289: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18290: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18291: if ($symb eq '') {
18292: if (!$silent) {
1.1071 raeburn 18293: if (ref($request)) {
18294: $request->print("Unable to handle ambiguous references:$url:.");
18295: }
1.685 tempelho 18296: return ();
18297: }
18298: }
18299: &Apache::lonenc::check_decrypt(\$symb);
18300: return ($symb);
18301: }
18302:
18303: # --------------------------------------------------------------Get annotation
18304:
18305: sub get_annotation {
18306: my ($symb,$enc) = @_;
18307:
18308: my $key = $symb;
18309: if (!$enc) {
18310: $key =
18311: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18312: }
18313: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18314: return $annotation{$key};
18315: }
18316:
18317: sub clean_symb {
1.731 raeburn 18318: my ($symb,$delete_enc) = @_;
1.685 tempelho 18319:
18320: &Apache::lonenc::check_decrypt(\$symb);
18321: my $enc = $env{'request.enc'};
1.731 raeburn 18322: if ($delete_enc) {
1.730 raeburn 18323: delete($env{'request.enc'});
18324: }
1.685 tempelho 18325:
18326: return ($symb,$enc);
18327: }
1.462 albertel 18328:
1.1181 raeburn 18329: ############################################################
18330: ############################################################
18331:
18332: =pod
18333:
18334: =head1 Routines for building display used to search for courses
18335:
18336:
18337: =over 4
18338:
18339: =item * &build_filters()
18340:
18341: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18342: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18343: and quotacheck.pl
18344:
1.1181 raeburn 18345:
18346: Inputs:
18347:
18348: filterlist - anonymous array of fields to include as potential filters
18349:
18350: crstype - course type
18351:
18352: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18353: to pop-open a course selector (will contain "extra element").
18354:
18355: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18356:
18357: filter - anonymous hash of criteria and their values
18358:
18359: action - form action
18360:
18361: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18362:
1.1182 raeburn 18363: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18364:
18365: cloneruname - username of owner of new course who wants to clone
18366:
18367: clonerudom - domain of owner of new course who wants to clone
18368:
18369: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18370:
18371: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18372:
18373: codedom - domain
18374:
18375: formname - value of form element named "form".
18376:
18377: fixeddom - domain, if fixed.
18378:
18379: prevphase - value to assign to form element named "phase" when going back to the previous screen
18380:
18381: cnameelement - name of form element in form on opener page which will receive title of selected course
18382:
18383: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18384:
18385: cdomelement - name of form element in form on opener page which will receive domain of selected course
18386:
18387: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18388:
18389: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18390:
18391: clonewarning - warning message about missing information for intended course owner when DC creates a course
18392:
1.1182 raeburn 18393:
1.1181 raeburn 18394: Returns: $output - HTML for display of search criteria, and hidden form elements.
18395:
1.1182 raeburn 18396:
1.1181 raeburn 18397: Side Effects: None
18398:
18399: =cut
18400:
18401: # ---------------------------------------------- search for courses based on last activity etc.
18402:
18403: sub build_filters {
18404: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18405: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18406: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18407: $cnameelement,$cnumelement,$cdomelement,$setroles,
18408: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18409: my ($list,$jscript);
1.1181 raeburn 18410: my $onchange = 'javascript:updateFilters(this)';
18411: my ($domainselectform,$sincefilterform,$createdfilterform,
18412: $ownerdomselectform,$persondomselectform,$instcodeform,
18413: $typeselectform,$instcodetitle);
18414: if ($formname eq '') {
18415: $formname = $caller;
18416: }
18417: foreach my $item (@{$filterlist}) {
18418: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18419: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18420: if ($item eq 'domainfilter') {
18421: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18422: } elsif ($item eq 'coursefilter') {
18423: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18424: } elsif ($item eq 'ownerfilter') {
18425: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18426: } elsif ($item eq 'ownerdomfilter') {
18427: $filter->{'ownerdomfilter'} =
18428: &LONCAPA::clean_domain($filter->{$item});
18429: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18430: 'ownerdomfilter',1);
18431: } elsif ($item eq 'personfilter') {
18432: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18433: } elsif ($item eq 'persondomfilter') {
18434: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18435: 'persondomfilter',1);
18436: } else {
18437: $filter->{$item} =~ s/\W//g;
18438: }
18439: if (!$filter->{$item}) {
18440: $filter->{$item} = '';
18441: }
18442: }
18443: if ($item eq 'domainfilter') {
18444: my $allow_blank = 1;
18445: if ($formname eq 'portform') {
18446: $allow_blank=0;
18447: } elsif ($formname eq 'studentform') {
18448: $allow_blank=0;
18449: }
18450: if ($fixeddom) {
18451: $domainselectform = '<input type="hidden" name="domainfilter"'.
18452: ' value="'.$codedom.'" />'.
18453: &Apache::lonnet::domain($codedom,'description');
18454: } else {
18455: $domainselectform = &select_dom_form($filter->{$item},
18456: 'domainfilter',
18457: $allow_blank,'',$onchange);
18458: }
18459: } else {
18460: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18461: }
18462: }
18463:
18464: # last course activity filter and selection
18465: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18466:
18467: # course created filter and selection
18468: if (exists($filter->{'createdfilter'})) {
18469: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18470: }
18471:
1.1239 raeburn 18472: my $prefix = $crstype;
18473: if ($crstype eq 'Placement') {
18474: $prefix = 'Placement Test'
18475: }
1.1181 raeburn 18476: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18477: 'cac' => "$prefix Activity",
18478: 'ccr' => "$prefix Created",
18479: 'cde' => "$prefix Title",
18480: 'cdo' => "$prefix Domain",
1.1181 raeburn 18481: 'ins' => 'Institutional Code',
18482: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18483: 'cow' => "$prefix Owner/Co-owner",
18484: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18485: 'cog' => 'Type',
18486: );
18487:
18488: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18489: my $typeval = 'Course';
18490: if ($crstype eq 'Community') {
18491: $typeval = 'Community';
1.1239 raeburn 18492: } elsif ($crstype eq 'Placement') {
18493: $typeval = 'Placement';
1.1181 raeburn 18494: }
18495: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18496: } else {
18497: $typeselectform = '<select name="type" size="1"';
18498: if ($onchange) {
18499: $typeselectform .= ' onchange="'.$onchange.'"';
18500: }
18501: $typeselectform .= '>'."\n";
1.1237 raeburn 18502: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18503: my $shown;
18504: if ($posstype eq 'Placement') {
18505: $shown = &mt('Placement Test');
18506: } else {
18507: $shown = &mt($posstype);
18508: }
1.1181 raeburn 18509: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18510: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18511: }
18512: $typeselectform.="</select>";
18513: }
18514:
18515: my ($cloneableonlyform,$cloneabletitle);
18516: if (exists($filter->{'cloneableonly'})) {
18517: my $cloneableon = '';
18518: my $cloneableoff = ' checked="checked"';
18519: if ($filter->{'cloneableonly'}) {
18520: $cloneableon = $cloneableoff;
18521: $cloneableoff = '';
18522: }
18523: $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>';
18524: if ($formname eq 'ccrs') {
1.1187 bisitz 18525: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18526: } else {
18527: $cloneabletitle = &mt('Cloneable by you');
18528: }
18529: }
18530: my $officialjs;
18531: if ($crstype eq 'Course') {
18532: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18533: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18534: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18535: if ($codedom) {
1.1181 raeburn 18536: $officialjs = 1;
18537: ($instcodeform,$jscript,$$numtitlesref) =
18538: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18539: $officialjs,$codetitlesref);
18540: if ($jscript) {
1.1182 raeburn 18541: $jscript = '<script type="text/javascript">'."\n".
18542: '// <![CDATA['."\n".
18543: $jscript."\n".
18544: '// ]]>'."\n".
18545: '</script>'."\n";
1.1181 raeburn 18546: }
18547: }
18548: if ($instcodeform eq '') {
18549: $instcodeform =
18550: '<input type="text" name="instcodefilter" size="10" value="'.
18551: $list->{'instcodefilter'}.'" />';
18552: $instcodetitle = $lt{'ins'};
18553: } else {
18554: $instcodetitle = $lt{'inc'};
18555: }
18556: if ($fixeddom) {
18557: $instcodetitle .= '<br />('.$codedom.')';
18558: }
18559: }
18560: }
18561: my $output = qq|
18562: <form method="post" name="filterpicker" action="$action">
18563: <input type="hidden" name="form" value="$formname" />
18564: |;
18565: if ($formname eq 'modifycourse') {
18566: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18567: '<input type="hidden" name="prevphase" value="'.
18568: $prevphase.'" />'."\n";
1.1198 musolffc 18569: } elsif ($formname eq 'quotacheck') {
18570: $output .= qq|
18571: <input type="hidden" name="sortby" value="" />
18572: <input type="hidden" name="sortorder" value="" />
18573: |;
18574: } else {
1.1181 raeburn 18575: my $name_input;
18576: if ($cnameelement ne '') {
18577: $name_input = '<input type="hidden" name="cnameelement" value="'.
18578: $cnameelement.'" />';
18579: }
18580: $output .= qq|
1.1182 raeburn 18581: <input type="hidden" name="cnumelement" value="$cnumelement" />
18582: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18583: $name_input
18584: $roleelement
18585: $multelement
18586: $typeelement
18587: |;
18588: if ($formname eq 'portform') {
18589: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18590: }
18591: }
18592: if ($fixeddom) {
18593: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18594: }
18595: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18596: if ($sincefilterform) {
18597: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18598: .$sincefilterform
18599: .&Apache::lonhtmlcommon::row_closure();
18600: }
18601: if ($createdfilterform) {
18602: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18603: .$createdfilterform
18604: .&Apache::lonhtmlcommon::row_closure();
18605: }
18606: if ($domainselectform) {
18607: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18608: .$domainselectform
18609: .&Apache::lonhtmlcommon::row_closure();
18610: }
18611: if ($typeselectform) {
18612: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18613: $output .= $typeselectform;
18614: } else {
18615: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18616: .$typeselectform
18617: .&Apache::lonhtmlcommon::row_closure();
18618: }
18619: }
18620: if ($instcodeform) {
18621: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18622: .$instcodeform
18623: .&Apache::lonhtmlcommon::row_closure();
18624: }
18625: if (exists($filter->{'ownerfilter'})) {
18626: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18627: '<table><tr><td>'.&mt('Username').'<br />'.
18628: '<input type="text" name="ownerfilter" size="20" value="'.
18629: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18630: $ownerdomselectform.'</td></tr></table>'.
18631: &Apache::lonhtmlcommon::row_closure();
18632: }
18633: if (exists($filter->{'personfilter'})) {
18634: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18635: '<table><tr><td>'.&mt('Username').'<br />'.
18636: '<input type="text" name="personfilter" size="20" value="'.
18637: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18638: $persondomselectform.'</td></tr></table>'.
18639: &Apache::lonhtmlcommon::row_closure();
18640: }
18641: if (exists($filter->{'coursefilter'})) {
18642: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18643: .'<input type="text" name="coursefilter" size="25" value="'
18644: .$list->{'coursefilter'}.'" />'
18645: .&Apache::lonhtmlcommon::row_closure();
18646: }
18647: if ($cloneableonlyform) {
18648: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18649: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18650: }
18651: if (exists($filter->{'descriptfilter'})) {
18652: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18653: .'<input type="text" name="descriptfilter" size="40" value="'
18654: .$list->{'descriptfilter'}.'" />'
18655: .&Apache::lonhtmlcommon::row_closure(1);
18656: }
18657: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18658: '<input type="hidden" name="updater" value="" />'."\n".
18659: '<input type="submit" name="gosearch" value="'.
18660: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18661: return $jscript.$clonewarning.$output;
18662: }
18663:
18664: =pod
18665:
18666: =item * &timebased_select_form()
18667:
1.1182 raeburn 18668: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18669: filter e.g., Course Activity, Course Created, when searching for courses
18670: or communities
18671:
18672: Inputs:
18673:
18674: item - name of form element (sincefilter or createdfilter)
18675:
18676: filter - anonymous hash of criteria and their values
18677:
18678: Returns: HTML for a select box contained a blank, then six time selections,
18679: with value set in incoming form variables currently selected.
18680:
18681: Side Effects: None
18682:
18683: =cut
18684:
18685: sub timebased_select_form {
18686: my ($item,$filter) = @_;
18687: if (ref($filter) eq 'HASH') {
18688: $filter->{$item} =~ s/[^\d-]//g;
18689: if (!$filter->{$item}) { $filter->{$item}=-1; }
18690: return &select_form(
18691: $filter->{$item},
18692: $item,
18693: { '-1' => '',
18694: '86400' => &mt('today'),
18695: '604800' => &mt('last week'),
18696: '2592000' => &mt('last month'),
18697: '7776000' => &mt('last three months'),
18698: '15552000' => &mt('last six months'),
18699: '31104000' => &mt('last year'),
18700: 'select_form_order' =>
18701: ['-1','86400','604800','2592000','7776000',
18702: '15552000','31104000']});
18703: }
18704: }
18705:
18706: =pod
18707:
18708: =item * &js_changer()
18709:
18710: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18711: when course type or domain is changed, and also to hide 'Searching ...' on
18712: page load completion for page showing search result.
1.1181 raeburn 18713:
18714: Inputs: None
18715:
1.1183 raeburn 18716: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18717:
18718: Side Effects: None
18719:
18720: =cut
18721:
18722: sub js_changer {
18723: return <<ENDJS;
18724: <script type="text/javascript">
18725: // <![CDATA[
18726: function updateFilters(caller) {
18727: if (typeof(caller) != "undefined") {
18728: document.filterpicker.updater.value = caller.name;
18729: }
18730: document.filterpicker.submit();
18731: }
1.1183 raeburn 18732:
18733: function hideSearching() {
18734: if (document.getElementById('searching')) {
18735: document.getElementById('searching').style.display = 'none';
18736: }
18737: return;
18738: }
18739:
1.1181 raeburn 18740: // ]]>
18741: </script>
18742:
18743: ENDJS
18744: }
18745:
18746: =pod
18747:
1.1182 raeburn 18748: =item * &search_courses()
18749:
18750: Process selected filters form course search form and pass to lonnet::courseiddump
18751: to retrieve a hash for which keys are courseIDs which match the selected filters.
18752:
18753: Inputs:
18754:
18755: dom - domain being searched
18756:
18757: type - course type ('Course' or 'Community' or '.' if any).
18758:
18759: filter - anonymous hash of criteria and their values
18760:
18761: numtitles - for institutional codes - number of categories
18762:
18763: cloneruname - optional username of new course owner
18764:
18765: clonerudom - optional domain of new course owner
18766:
1.1221 raeburn 18767: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18768: (used when DC is using course creation form)
18769:
18770: codetitles - reference to array of titles of components in institutional codes (official courses).
18771:
1.1221 raeburn 18772: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18773: (and so can clone automatically)
18774:
18775: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18776:
18777: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18778: courses to clone
1.1182 raeburn 18779:
18780: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18781:
18782:
18783: Side Effects: None
18784:
18785: =cut
18786:
18787:
18788: sub search_courses {
1.1221 raeburn 18789: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18790: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18791: my (%courses,%showcourses,$cloner);
18792: if (($filter->{'ownerfilter'} ne '') ||
18793: ($filter->{'ownerdomfilter'} ne '')) {
18794: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18795: $filter->{'ownerdomfilter'};
18796: }
18797: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18798: if (!$filter->{$item}) {
18799: $filter->{$item}='.';
18800: }
18801: }
18802: my $now = time;
18803: my $timefilter =
18804: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18805: my ($createdbefore,$createdafter);
18806: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18807: $createdbefore = $now;
18808: $createdafter = $now-$filter->{'createdfilter'};
18809: }
18810: my ($instcodefilter,$regexpok);
18811: if ($numtitles) {
18812: if ($env{'form.official'} eq 'on') {
18813: $instcodefilter =
18814: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18815: $regexpok = 1;
18816: } elsif ($env{'form.official'} eq 'off') {
18817: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18818: unless ($instcodefilter eq '') {
18819: $regexpok = -1;
18820: }
18821: }
18822: } else {
18823: $instcodefilter = $filter->{'instcodefilter'};
18824: }
18825: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18826: if ($type eq '') { $type = '.'; }
18827:
18828: if (($clonerudom ne '') && ($cloneruname ne '')) {
18829: $cloner = $cloneruname.':'.$clonerudom;
18830: }
18831: %courses = &Apache::lonnet::courseiddump($dom,
18832: $filter->{'descriptfilter'},
18833: $timefilter,
18834: $instcodefilter,
18835: $filter->{'combownerfilter'},
18836: $filter->{'coursefilter'},
18837: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18838: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18839: $filter->{'cloneableonly'},
18840: $createdbefore,$createdafter,undef,
1.1221 raeburn 18841: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18842: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18843: my $ccrole;
18844: if ($type eq 'Community') {
18845: $ccrole = 'co';
18846: } else {
18847: $ccrole = 'cc';
18848: }
18849: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18850: $filter->{'persondomfilter'},
18851: 'userroles',undef,
18852: [$ccrole,'in','ad','ep','ta','cr'],
18853: $dom);
18854: foreach my $role (keys(%rolehash)) {
18855: my ($cnum,$cdom,$courserole) = split(':',$role);
18856: my $cid = $cdom.'_'.$cnum;
18857: if (exists($courses{$cid})) {
18858: if (ref($courses{$cid}) eq 'HASH') {
18859: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18860: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18861: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18862: }
18863: } else {
18864: $courses{$cid}{roles} = [$courserole];
18865: }
18866: $showcourses{$cid} = $courses{$cid};
18867: }
18868: }
18869: }
18870: %courses = %showcourses;
18871: }
18872: return %courses;
18873: }
18874:
18875: =pod
18876:
1.1181 raeburn 18877: =back
18878:
1.1207 raeburn 18879: =head1 Routines for version requirements for current course.
18880:
18881: =over 4
18882:
18883: =item * &check_release_required()
18884:
18885: Compares required LON-CAPA version with version on server, and
18886: if required version is newer looks for a server with the required version.
18887:
18888: Looks first at servers in user's owen domain; if none suitable, looks at
18889: servers in course's domain are permitted to host sessions for user's domain.
18890:
18891: Inputs:
18892:
18893: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18894:
18895: $courseid - Course ID of current course
18896:
18897: $rolecode - User's current role in course (for switchserver query string).
18898:
18899: $required - LON-CAPA version needed by course (format: Major.Minor).
18900:
18901:
18902: Returns:
18903:
18904: $switchserver - query string tp append to /adm/switchserver call (if
18905: current server's LON-CAPA version is too old.
18906:
18907: $warning - Message is displayed if no suitable server could be found.
18908:
18909: =cut
18910:
18911: sub check_release_required {
18912: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18913: my ($switchserver,$warning);
18914: if ($required ne '') {
18915: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18916: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18917: if ($reqdmajor ne '' && $reqdminor ne '') {
18918: my $otherserver;
18919: if (($major eq '' && $minor eq '') ||
18920: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18921: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18922: my $switchlcrev =
18923: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18924: $userdomserver);
18925: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18926: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18927: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18928: my $cdom = $env{'course.'.$courseid.'.domain'};
18929: if ($cdom ne $env{'user.domain'}) {
18930: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18931: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18932: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18933: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18934: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18935: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18936: my $canhost =
18937: &Apache::lonnet::can_host_session($env{'user.domain'},
18938: $coursedomserver,
18939: $remoterev,
18940: $udomdefaults{'remotesessions'},
18941: $defdomdefaults{'hostedsessions'});
18942:
18943: if ($canhost) {
18944: $otherserver = $coursedomserver;
18945: } else {
18946: $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.");
18947: }
18948: } else {
18949: $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).");
18950: }
18951: } else {
18952: $otherserver = $userdomserver;
18953: }
18954: }
18955: if ($otherserver ne '') {
18956: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18957: }
18958: }
18959: }
18960: return ($switchserver,$warning);
18961: }
18962:
18963: =pod
18964:
18965: =item * &check_release_result()
18966:
18967: Inputs:
18968:
18969: $switchwarning - Warning message if no suitable server found to host session.
18970:
18971: $switchserver - query string to append to /adm/switchserver containing lonHostID
18972: and current role.
18973:
18974: Returns: HTML to display with information about requirement to switch server.
18975: Either displaying warning with link to Roles/Courses screen or
18976: display link to switchserver.
18977:
1.1181 raeburn 18978: =cut
18979:
1.1207 raeburn 18980: sub check_release_result {
18981: my ($switchwarning,$switchserver) = @_;
18982: my $output = &start_page('Selected course unavailable on this server').
18983: '<p class="LC_warning">';
18984: if ($switchwarning) {
18985: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18986: if (&show_course()) {
18987: $output .= &mt('Display courses');
18988: } else {
18989: $output .= &mt('Display roles');
18990: }
18991: $output .= '</a>';
18992: } elsif ($switchserver) {
18993: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18994: '<br />'.
18995: '<a href="/adm/switchserver?'.$switchserver.'">'.
18996: &mt('Switch Server').
18997: '</a>';
18998: }
18999: $output .= '</p>'.&end_page();
19000: return $output;
19001: }
19002:
19003: =pod
19004:
19005: =item * &needs_coursereinit()
19006:
19007: Determine if course contents stored for user's session needs to be
19008: refreshed, because content has changed since "Big Hash" last tied.
19009:
19010: Check for change is made if time last checked is more than 10 minutes ago
19011: (by default).
19012:
19013: Inputs:
19014:
19015: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
19016:
19017: $interval (optional) - Time which may elapse (in s) between last check for content
19018: change in current course. (default: 600 s).
19019:
19020: Returns: an array; first element is:
19021:
19022: =over 4
19023:
19024: 'switch' - if content updates mean user's session
19025: needs to be switched to a server running a newer LON-CAPA version
19026:
19027: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
19028: on current server hosting user's session
19029:
19030: '' - if no action required.
19031:
19032: =back
19033:
19034: If first item element is 'switch':
19035:
19036: second item is $switchwarning - Warning message if no suitable server found to host session.
19037:
19038: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
19039: and current role.
19040:
19041: otherwise: no other elements returned.
19042:
19043: =back
19044:
19045: =cut
19046:
19047: sub needs_coursereinit {
19048: my ($loncaparev,$interval) = @_;
19049: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
19050: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19051: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19052: my $now = time;
19053: if ($interval eq '') {
19054: $interval = 600;
19055: }
19056: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19057: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19058: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19059: if ($blocked) {
19060: return ();
19061: }
1.1391 raeburn 19062: my $update;
19063: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19064: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19065: if ($lastmainchange > $env{'request.course.tied'}) {
19066: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19067: if ($needswitch) {
19068: return ('switch',$switchwarning,$switchserver);
19069: }
19070: $update = 'main';
19071: }
19072: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19073: if ($update) {
19074: $update = 'both';
19075: } else {
19076: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19077: if ($needswitch) {
19078: return ('switch',$switchwarning,$switchserver);
19079: } else {
19080: $update = 'supp';
1.1207 raeburn 19081: }
19082: }
1.1391 raeburn 19083: }
1.1453 ! raeburn 19084: return ($update);
1.1391 raeburn 19085: }
19086: return ();
19087: }
19088:
19089: sub switch_for_update {
19090: my ($loncaparev,$cdom,$cnum) = @_;
19091: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19092: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19093: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19094: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19095: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19096: $curr_reqd_hash{'internal.releaserequired'}});
19097: my ($switchserver,$switchwarning) =
19098: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19099: $curr_reqd_hash{'internal.releaserequired'});
19100: if ($switchwarning ne '' || $switchserver ne '') {
19101: return ('switch',$switchwarning,$switchserver);
19102: }
1.1207 raeburn 19103: }
19104: }
19105: return ();
19106: }
1.1181 raeburn 19107:
1.1083 raeburn 19108: sub update_content_constraints {
1.1395 raeburn 19109: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19110: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19111: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19112: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19113: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19114: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19115: if ($item eq 'resourcetag') {
19116: if ($name eq 'responsetype') {
19117: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19118: }
1.1307 raeburn 19119: } elsif ($item eq 'course') {
19120: if ($name eq 'courserestype') {
19121: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19122: }
1.1083 raeburn 19123: }
19124: }
19125: my $navmap = Apache::lonnavmaps::navmap->new();
19126: if (defined($navmap)) {
1.1307 raeburn 19127: my (%allresponses,%allcrsrestypes);
19128: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19129: if ($res->is_tool()) {
19130: if ($allcrsrestypes{'exttool'}) {
19131: $allcrsrestypes{'exttool'} ++;
19132: } else {
19133: $allcrsrestypes{'exttool'} = 1;
19134: }
19135: next;
19136: }
1.1083 raeburn 19137: my %responses = $res->responseTypes();
19138: foreach my $key (keys(%responses)) {
19139: next unless(exists($checkresponsetypes{$key}));
19140: $allresponses{$key} += $responses{$key};
19141: }
19142: }
19143: foreach my $key (keys(%allresponses)) {
19144: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19145: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19146: ($reqdmajor,$reqdminor) = ($major,$minor);
19147: }
19148: }
1.1307 raeburn 19149: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19150: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19151: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19152: ($reqdmajor,$reqdminor) = ($major,$minor);
19153: }
19154: }
1.1083 raeburn 19155: undef($navmap);
19156: }
1.1391 raeburn 19157: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19158: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19159: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19160: ($reqdmajor,$reqdminor) = ($major,$minor);
19161: }
19162: }
1.1083 raeburn 19163: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19164: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19165: }
19166: return;
19167: }
19168:
1.1110 raeburn 19169: sub allmaps_incourse {
19170: my ($cdom,$cnum,$chome,$cid) = @_;
19171: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19172: $cid = $env{'request.course.id'};
19173: $cdom = $env{'course.'.$cid.'.domain'};
19174: $cnum = $env{'course.'.$cid.'.num'};
19175: $chome = $env{'course.'.$cid.'.home'};
19176: }
19177: my %allmaps = ();
19178: my $lastchange =
19179: &Apache::lonnet::get_coursechange($cdom,$cnum);
19180: if ($lastchange > $env{'request.course.tied'}) {
19181: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19182: unless ($ferr) {
1.1395 raeburn 19183: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19184: }
19185: }
19186: my $navmap = Apache::lonnavmaps::navmap->new();
19187: if (defined($navmap)) {
19188: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19189: $allmaps{$res->src()} = 1;
19190: }
19191: }
19192: return \%allmaps;
19193: }
19194:
1.1083 raeburn 19195: sub parse_supplemental_title {
19196: my ($title) = @_;
19197:
19198: my ($foldertitle,$renametitle);
19199: if ($title =~ /&&&/) {
19200: $title = &HTML::Entites::decode($title);
19201: }
19202: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19203: $renametitle=$4;
19204: my ($time,$uname,$udom) = ($1,$2,$3);
19205: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19206: my $name = &plainname($uname,$udom);
19207: $name = &HTML::Entities::encode($name,'"<>&\'');
19208: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19209: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19210: if ($foldertitle ne '') {
1.1401 raeburn 19211: $title .= ': <br />'.$foldertitle;
19212: }
1.1083 raeburn 19213: }
19214: if (wantarray) {
19215: return ($title,$foldertitle,$renametitle);
19216: }
19217: return $title;
19218: }
19219:
1.1395 raeburn 19220: sub get_supplemental {
19221: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19222: my $hashid=$cnum.':'.$cdom;
19223: my ($supplemental,$cached,$set_httprefs);
19224: unless ($ignorecache) {
19225: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19226: }
19227: unless (defined($cached)) {
19228: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19229: unless ($chome eq 'no_host') {
19230: my @order = @LONCAPA::map::order;
19231: my @resources = @LONCAPA::map::resources;
19232: my @resparms = @LONCAPA::map::resparms;
19233: my @zombies = @LONCAPA::map::zombies;
19234: my ($errors,%ids,%hidden);
19235: $errors =
19236: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19237: $errors,$possdel,\%ids,\%hidden);
19238: @LONCAPA::map::order = @order;
19239: @LONCAPA::map::resources = @resources;
19240: @LONCAPA::map::resparms = @resparms;
19241: @LONCAPA::map::zombies = @zombies;
19242: $set_httprefs = 1;
19243: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19244: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19245: }
19246: $supplemental = {
19247: ids => \%ids,
19248: hidden => \%hidden,
19249: };
19250: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19251: }
19252: }
19253: return ($supplemental,$set_httprefs);
19254: }
19255:
1.1143 raeburn 19256: sub recurse_supplemental {
1.1391 raeburn 19257: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19258: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19259: my $mapnum;
19260: if ($suppmap eq 'supplemental.sequence') {
19261: $mapnum = 0;
19262: } else {
19263: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19264: }
1.1143 raeburn 19265: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19266: if ($fatal) {
19267: $errors ++;
19268: } else {
1.1389 raeburn 19269: my @order = @LONCAPA::map::order;
19270: if (@order > 0) {
19271: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19272: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19273: foreach my $idx (@order) {
19274: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19275: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19276: my $id = $mapnum.':'.$idx;
19277: push(@{$suppids->{$src}},$id);
19278: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19279: $hiddensupp->{$id} = 1;
19280: }
1.1146 raeburn 19281: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19282: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19283: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19284: } else {
1.1391 raeburn 19285: my $allowed;
19286: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19287: $allowed = 1;
19288: } elsif ($possdel) {
19289: foreach my $item (@{$suppids->{$src}}) {
19290: next if ($item eq $id);
19291: unless ($hiddensupp->{$item}) {
19292: $allowed = 1;
19293: last;
19294: }
19295: }
19296: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19297: &Apache::lonnet::delenv('httpref.'.$src);
19298: }
19299: }
19300: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19301: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19302: }
1.1143 raeburn 19303: }
19304: }
19305: }
19306: }
19307: }
19308: }
1.1391 raeburn 19309: return $errors;
19310: }
19311:
19312: sub set_supp_httprefs {
19313: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19314: if (ref($supplemental) eq 'HASH') {
19315: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19316: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19317: next if ($src =~ /\.sequence$/);
19318: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19319: my $allowed;
19320: if ($env{'request.role.adv'}) {
19321: $allowed = 1;
19322: } else {
19323: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19324: unless ($supplemental->{'hidden'}->{$id}) {
19325: $allowed = 1;
19326: last;
19327: }
19328: }
19329: }
19330: if (exists($env{'httpref.'.$src})) {
19331: if ($possdel) {
19332: unless ($allowed) {
19333: &Apache::lonnet::delenv('httpref.'.$src);
19334: }
19335: }
19336: } elsif ($allowed) {
19337: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19338: }
19339: }
19340: }
19341: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19342: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19343: }
19344: }
19345: }
19346: }
19347:
19348: sub get_supp_parameter {
19349: my ($resparm,$name)=@_;
19350: return if ($resparm eq '');
19351: my $value=undef;
19352: my $ptype=undef;
19353: foreach (split('&&&',$resparm)) {
19354: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19355: if ($thisname eq $name) {
19356: $value=$thisvalue;
19357: $ptype=$thistype;
19358: }
19359: }
19360: return $value;
1.1143 raeburn 19361: }
19362:
1.1101 raeburn 19363: sub symb_to_docspath {
1.1267 raeburn 19364: my ($symb,$navmapref) = @_;
19365: return unless ($symb && ref($navmapref));
1.1101 raeburn 19366: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19367: if ($resurl=~/\.(sequence|page)$/) {
19368: $mapurl=$resurl;
19369: } elsif ($resurl eq 'adm/navmaps') {
19370: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19371: }
19372: my $mapresobj;
1.1267 raeburn 19373: unless (ref($$navmapref)) {
19374: $$navmapref = Apache::lonnavmaps::navmap->new();
19375: }
19376: if (ref($$navmapref)) {
19377: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19378: }
19379: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19380: my $type=$2;
19381: my $path;
19382: if (ref($mapresobj)) {
19383: my $pcslist = $mapresobj->map_hierarchy();
19384: if ($pcslist ne '') {
19385: foreach my $pc (split(/,/,$pcslist)) {
19386: next if ($pc <= 1);
1.1267 raeburn 19387: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19388: if (ref($res)) {
19389: my $thisurl = $res->src();
19390: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19391: my $thistitle = $res->title();
19392: $path .= '&'.
19393: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19394: &escape($thistitle).
1.1101 raeburn 19395: ':'.$res->randompick().
19396: ':'.$res->randomout().
19397: ':'.$res->encrypted().
19398: ':'.$res->randomorder().
19399: ':'.$res->is_page();
19400: }
19401: }
19402: }
19403: $path =~ s/^\&//;
19404: my $maptitle = $mapresobj->title();
19405: if ($mapurl eq 'default') {
1.1129 raeburn 19406: $maptitle = 'Main Content';
1.1101 raeburn 19407: }
19408: $path .= (($path ne '')? '&' : '').
19409: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19410: &escape($maptitle).
1.1101 raeburn 19411: ':'.$mapresobj->randompick().
19412: ':'.$mapresobj->randomout().
19413: ':'.$mapresobj->encrypted().
19414: ':'.$mapresobj->randomorder().
19415: ':'.$mapresobj->is_page();
19416: } else {
19417: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19418: my $ispage = (($type eq 'page')? 1 : '');
19419: if ($mapurl eq 'default') {
1.1129 raeburn 19420: $maptitle = 'Main Content';
1.1101 raeburn 19421: }
19422: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19423: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19424: }
19425: unless ($mapurl eq 'default') {
19426: $path = 'default&'.
1.1146 raeburn 19427: &escape('Main Content').
1.1101 raeburn 19428: ':::::&'.$path;
19429: }
19430: return $path;
19431: }
19432:
1.1393 raeburn 19433: sub validate_folderpath {
19434: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19435: if ($env{'form.folderpath'} ne '') {
19436: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19437: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19438: for (my $i=0; $i<@items; $i++) {
19439: my $odd = $i%2;
19440: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19441: $badpath = 1;
1.1394 raeburn 19442: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19443: my $idx = $i-1;
1.1394 raeburn 19444: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19445: my $esc_name = $1;
19446: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19447: $supppath .= '&'.$esc_name;
19448: $changed = 1;
19449: } else {
19450: $supppath .= '&'.$items[$i];
19451: }
19452: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19453: $changed = 1;
1.1393 raeburn 19454: my $is_hidden;
19455: unless ($got_supp) {
1.1395 raeburn 19456: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19457: if (ref($supplemental) eq 'HASH') {
19458: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19459: %supphidden = %{$supplemental->{'hidden'}};
19460: }
19461: if (ref($supplemental->{'ids'}) eq 'HASH') {
19462: %suppids = %{$supplemental->{'ids'}};
19463: }
19464: }
19465: $got_supp = 1;
19466: }
19467: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19468: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19469: if ($supphidden{$mapid}) {
19470: $is_hidden = 1;
19471: }
19472: }
1.1394 raeburn 19473: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19474: } else {
19475: $supppath .= '&'.$items[$i];
1.1393 raeburn 19476: }
19477: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19478: $badpath = 1;
1.1394 raeburn 19479: } elsif ($supplementalflag) {
1.1393 raeburn 19480: $supppath .= '&'.$items[$i];
19481: }
19482: last if ($badpath);
19483: }
19484: if ($badpath) {
19485: delete($env{'form.folderpath'});
1.1394 raeburn 19486: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19487: $supppath =~ s/^\&//;
19488: $env{'form.folderpath'} = $supppath;
19489: }
19490: }
19491: return;
19492: }
19493:
1.1094 raeburn 19494: sub captcha_display {
1.1327 raeburn 19495: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19496: my ($output,$error);
1.1234 raeburn 19497: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19498: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19499: if ($captcha eq 'original') {
1.1094 raeburn 19500: $output = &create_captcha();
19501: unless ($output) {
1.1172 raeburn 19502: $error = 'captcha';
1.1094 raeburn 19503: }
19504: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19505: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19506: unless ($output) {
1.1172 raeburn 19507: $error = 'recaptcha';
1.1094 raeburn 19508: }
19509: }
1.1234 raeburn 19510: return ($output,$error,$captcha,$version);
1.1094 raeburn 19511: }
19512:
19513: sub captcha_response {
1.1327 raeburn 19514: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19515: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19516: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19517: if ($captcha eq 'original') {
1.1094 raeburn 19518: ($captcha_chk,$captcha_error) = &check_captcha();
19519: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19520: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19521: } else {
19522: $captcha_chk = 1;
19523: }
19524: return ($captcha_chk,$captcha_error);
19525: }
19526:
19527: sub get_captcha_config {
1.1327 raeburn 19528: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19529: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19530: my $hostname = &Apache::lonnet::hostname($lonhost);
19531: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19532: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19533: if ($context eq 'usercreation') {
19534: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19535: if (ref($domconfig{$context}) eq 'HASH') {
19536: $hashtocheck = $domconfig{$context}{'cancreate'};
19537: if (ref($hashtocheck) eq 'HASH') {
19538: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19539: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19540: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19541: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19542: }
19543: if ($privkey && $pubkey) {
19544: $captcha = 'recaptcha';
1.1234 raeburn 19545: $version = $hashtocheck->{'recaptchaversion'};
19546: if ($version ne '2') {
19547: $version = 1;
19548: }
1.1095 raeburn 19549: } else {
19550: $captcha = 'original';
19551: }
19552: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19553: $captcha = 'original';
19554: }
1.1094 raeburn 19555: }
1.1095 raeburn 19556: } else {
19557: $captcha = 'captcha';
19558: }
19559: } elsif ($context eq 'login') {
19560: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19561: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19562: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19563: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19564: if ($privkey && $pubkey) {
19565: $captcha = 'recaptcha';
1.1234 raeburn 19566: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19567: if ($version ne '2') {
19568: $version = 1;
19569: }
1.1095 raeburn 19570: } else {
19571: $captcha = 'original';
1.1094 raeburn 19572: }
1.1095 raeburn 19573: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19574: $captcha = 'original';
1.1094 raeburn 19575: }
1.1327 raeburn 19576: } elsif ($context eq 'passwords') {
19577: if ($dom_in_effect) {
19578: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19579: if ($passwdconf{'captcha'} eq 'recaptcha') {
19580: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19581: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19582: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19583: }
19584: if ($privkey && $pubkey) {
19585: $captcha = 'recaptcha';
19586: $version = $passwdconf{'recaptchaversion'};
19587: if ($version ne '2') {
19588: $version = 1;
19589: }
19590: } else {
19591: $captcha = 'original';
19592: }
19593: } elsif ($passwdconf{'captcha'} ne 'notused') {
19594: $captcha = 'original';
19595: }
19596: }
19597: }
1.1234 raeburn 19598: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19599: }
19600:
19601: sub create_captcha {
19602: my %captcha_params = &captcha_settings();
19603: my ($output,$maxtries,$tries) = ('',10,0);
19604: while ($tries < $maxtries) {
19605: $tries ++;
19606: my $captcha = Authen::Captcha->new (
19607: output_folder => $captcha_params{'output_dir'},
19608: data_folder => $captcha_params{'db_dir'},
19609: );
19610: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19611:
19612: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19613: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19614: '<span class="LC_nobreak">'.
1.1453 ! raeburn 19615: '<label>'.&mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19616: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1453 ! raeburn 19617: '</label></span><br />'.
1.1176 raeburn 19618: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19619: last;
19620: }
19621: }
1.1323 raeburn 19622: if ($output eq '') {
19623: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19624: }
1.1094 raeburn 19625: return $output;
19626: }
19627:
19628: sub captcha_settings {
19629: my %captcha_params = (
19630: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19631: www_output_dir => "/captchaspool",
19632: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19633: numchars => '5',
19634: );
19635: return %captcha_params;
19636: }
19637:
19638: sub check_captcha {
19639: my ($captcha_chk,$captcha_error);
19640: my $code = $env{'form.code'};
19641: my $md5sum = $env{'form.crypt'};
19642: my %captcha_params = &captcha_settings();
19643: my $captcha = Authen::Captcha->new(
19644: output_folder => $captcha_params{'output_dir'},
19645: data_folder => $captcha_params{'db_dir'},
19646: );
1.1109 raeburn 19647: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19648: my %captcha_hash = (
19649: 0 => 'Code not checked (file error)',
19650: -1 => 'Failed: code expired',
19651: -2 => 'Failed: invalid code (not in database)',
19652: -3 => 'Failed: invalid code (code does not match crypt)',
19653: );
19654: if ($captcha_chk != 1) {
19655: $captcha_error = $captcha_hash{$captcha_chk}
19656: }
19657: return ($captcha_chk,$captcha_error);
19658: }
19659:
19660: sub create_recaptcha {
1.1234 raeburn 19661: my ($pubkey,$version) = @_;
19662: if ($version >= 2) {
1.1367 raeburn 19663: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19664: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19665: } else {
19666: my $use_ssl;
19667: if ($ENV{'SERVER_PORT'} == 443) {
19668: $use_ssl = 1;
19669: }
19670: my $captcha = Captcha::reCAPTCHA->new;
19671: return $captcha->get_options_setter({theme => 'white'})."\n".
19672: $captcha->get_html($pubkey,undef,$use_ssl).
19673: &mt('If the text is hard to read, [_1] will replace them.',
19674: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19675: '<br /><br />';
19676: }
1.1094 raeburn 19677: }
19678:
19679: sub check_recaptcha {
1.1234 raeburn 19680: my ($privkey,$version) = @_;
1.1094 raeburn 19681: my $captcha_chk;
1.1350 raeburn 19682: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19683: if ($version >= 2) {
19684: my %info = (
19685: secret => $privkey,
19686: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19687: remoteip => $ip,
1.1234 raeburn 19688: );
1.1280 raeburn 19689: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19690: $request->content(join('&',map {
19691: my $name = escape($_);
19692: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19693: ? join("&$name=", map {escape($_) } @{$info{$_}})
19694: : &escape($info{$_}) );
19695: } keys(%info)));
19696: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19697: if ($response->is_success) {
19698: my $data = JSON::DWIW->from_json($response->decoded_content);
19699: if (ref($data) eq 'HASH') {
19700: if ($data->{'success'}) {
19701: $captcha_chk = 1;
19702: }
19703: }
19704: }
19705: } else {
19706: my $captcha = Captcha::reCAPTCHA->new;
19707: my $captcha_result =
19708: $captcha->check_answer(
19709: $privkey,
1.1350 raeburn 19710: $ip,
1.1234 raeburn 19711: $env{'form.recaptcha_challenge_field'},
19712: $env{'form.recaptcha_response_field'},
19713: );
19714: if ($captcha_result->{is_valid}) {
19715: $captcha_chk = 1;
19716: }
1.1094 raeburn 19717: }
19718: return $captcha_chk;
19719: }
19720:
1.1174 raeburn 19721: sub emailusername_info {
1.1244 raeburn 19722: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19723: my %titles = &Apache::lonlocal::texthash (
19724: lastname => 'Last Name',
19725: firstname => 'First Name',
19726: institution => 'School/college/university',
19727: location => "School's city, state/province, country",
19728: web => "School's web address",
19729: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19730: id => 'Student/Employee ID',
1.1174 raeburn 19731: );
19732: return (\@fields,\%titles);
19733: }
19734:
1.1161 raeburn 19735: sub cleanup_html {
19736: my ($incoming) = @_;
19737: my $outgoing;
19738: if ($incoming ne '') {
19739: $outgoing = $incoming;
19740: $outgoing =~ s/;/;/g;
19741: $outgoing =~ s/\#/#/g;
19742: $outgoing =~ s/\&/&/g;
19743: $outgoing =~ s/</</g;
19744: $outgoing =~ s/>/>/g;
19745: $outgoing =~ s/\(/(/g;
19746: $outgoing =~ s/\)/)/g;
19747: $outgoing =~ s/"/"/g;
19748: $outgoing =~ s/'/'/g;
19749: $outgoing =~ s/\$/$/g;
19750: $outgoing =~ s{/}{/}g;
19751: $outgoing =~ s/=/=/g;
19752: $outgoing =~ s/\\/\/g
19753: }
19754: return $outgoing;
19755: }
19756:
1.1190 musolffc 19757: # Checks for critical messages and returns a redirect url if one exists.
19758: # $interval indicates how often to check for messages.
1.1282 raeburn 19759: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19760: sub critical_redirect {
1.1282 raeburn 19761: my ($interval,$context) = @_;
1.1356 raeburn 19762: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19763: return ();
19764: }
1.1190 musolffc 19765: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19766: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19767: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19768: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19769: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19770: if ($blocked) {
19771: my $checkrole = "cm./$cdom/$cnum";
19772: if ($env{'request.course.sec'} ne '') {
19773: $checkrole .= "/$env{'request.course.sec'}";
19774: }
19775: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19776: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19777: return;
19778: }
19779: }
19780: }
1.1190 musolffc 19781: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19782: $env{'user.name'});
19783: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19784: my $redirecturl;
1.1190 musolffc 19785: if ($what[0]) {
1.1356 raeburn 19786: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19787: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19788: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19789: return (1, $url);
1.1190 musolffc 19790: }
1.1191 raeburn 19791: }
19792: }
19793: return ();
1.1190 musolffc 19794: }
19795:
1.1174 raeburn 19796: # Use:
19797: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19798: #
19799: ##################################################
19800: # password associated functions #
19801: ##################################################
19802: sub des_keys {
19803: # Make a new key for DES encryption.
19804: # Each key has two parts which are returned separately.
19805: # Please note: Each key must be passed through the &hex function
19806: # before it is output to the web browser. The hex versions cannot
19807: # be used to decrypt.
19808: my @hexstr=('0','1','2','3','4','5','6','7',
19809: '8','9','a','b','c','d','e','f');
19810: my $lkey='';
19811: for (0..7) {
19812: $lkey.=$hexstr[rand(15)];
19813: }
19814: my $ukey='';
19815: for (0..7) {
19816: $ukey.=$hexstr[rand(15)];
19817: }
19818: return ($lkey,$ukey);
19819: }
19820:
19821: sub des_decrypt {
19822: my ($key,$cyphertext) = @_;
19823: my $keybin=pack("H16",$key);
19824: my $cypher;
19825: if ($Crypt::DES::VERSION>=2.03) {
19826: $cypher=new Crypt::DES $keybin;
19827: } else {
19828: $cypher=new DES $keybin;
19829: }
1.1233 raeburn 19830: my $plaintext='';
19831: my $cypherlength = length($cyphertext);
19832: my $numchunks = int($cypherlength/32);
19833: for (my $j=0; $j<$numchunks; $j++) {
19834: my $start = $j*32;
19835: my $cypherblock = substr($cyphertext,$start,32);
19836: my $chunk =
19837: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19838: $chunk .=
19839: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19840: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19841: $plaintext .= $chunk;
19842: }
1.1174 raeburn 19843: return $plaintext;
19844: }
19845:
1.1344 raeburn 19846: sub get_requested_shorturls {
1.1309 raeburn 19847: my ($cdom,$cnum,$navmap) = @_;
19848: return unless (ref($navmap));
1.1344 raeburn 19849: my ($numnew,$errors);
1.1309 raeburn 19850: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19851: if (@toshorten) {
19852: my (%maps,%resources,%titles);
19853: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19854: 'shorturls',$cdom,$cnum);
19855: if (keys(%resources)) {
1.1344 raeburn 19856: my %tocreate;
1.1309 raeburn 19857: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19858: my $symb = $resources{$item};
19859: if ($symb) {
19860: $tocreate{$cnum.'&'.$symb} = 1;
19861: }
19862: }
1.1344 raeburn 19863: if (keys(%tocreate)) {
19864: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19865: \%tocreate);
19866: }
1.1309 raeburn 19867: }
1.1344 raeburn 19868: }
19869: return ($numnew,$errors);
19870: }
19871:
19872: sub make_short_symbs {
19873: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19874: my ($numnew,@errors);
19875: if (ref($tocreateref) eq 'HASH') {
19876: my %tocreate = %{$tocreateref};
1.1309 raeburn 19877: if (keys(%tocreate)) {
19878: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19879: my $su = Short::URL->new(no_vowels => 1);
19880: my $init = '';
19881: my (%newunique,%addcourse,%courseonly,%failed);
19882: # get lock on tiny db
19883: my $now = time;
1.1344 raeburn 19884: if ($lockuser eq '') {
19885: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19886: }
1.1309 raeburn 19887: my $lockhash = {
1.1344 raeburn 19888: "lock\0$now" => $lockuser,
1.1309 raeburn 19889: };
19890: my $tries = 0;
19891: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19892: my ($code,$error);
19893: while (($gotlock ne 'ok') && ($tries<3)) {
19894: $tries ++;
19895: sleep 1;
1.1319 raeburn 19896: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19897: }
19898: if ($gotlock eq 'ok') {
19899: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19900: \%addcourse,\%courseonly,\%failed);
19901: if (keys(%failed)) {
19902: my $numfailed = scalar(keys(%failed));
19903: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19904: }
19905: if (keys(%newunique)) {
19906: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19907: if ($putres eq 'ok') {
19908: $numnew = scalar(keys(%newunique));
19909: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19910: unless ($newputres eq 'ok') {
19911: push(@errors,&mt('error: could not store course look-up of short URLs'));
19912: }
19913: } else {
19914: push(@errors,&mt('error: could not store unique six character URLs'));
19915: }
19916: }
19917: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19918: unless ($dellockres eq 'ok') {
19919: push(@errors,&mt('error: could not release lockfile'));
19920: }
19921: } else {
19922: push(@errors,&mt('error: could not obtain lockfile'));
19923: }
19924: if (keys(%courseonly)) {
19925: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19926: if ($result ne 'ok') {
19927: push(@errors,&mt('error: could not update course look-up of short URLs'));
19928: }
19929: }
19930: }
19931: }
19932: return ($numnew,\@errors);
19933: }
19934:
19935: sub shorten_symbs {
19936: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19937: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19938: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19939: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19940: my (%possibles,%collisions);
19941: foreach my $key (keys(%{$tocreate})) {
19942: my $num = String::CRC32::crc32($key);
19943: my $tiny = $su->encode($num,$init);
19944: if ($tiny) {
19945: $possibles{$tiny} = $key;
19946: }
19947: }
19948: if (!$init) {
19949: $init = 1;
19950: } else {
19951: $init ++;
19952: }
19953: if (keys(%possibles)) {
19954: my @posstiny = keys(%possibles);
19955: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19956: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19957: if (keys(%currtiny)) {
19958: foreach my $key (keys(%currtiny)) {
19959: next if ($currtiny{$key} eq '');
19960: if ($currtiny{$key} eq $possibles{$key}) {
19961: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19962: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19963: $courseonly->{$tsymb} = $key;
19964: }
19965: } else {
19966: $collisions{$possibles{$key}} = 1;
19967: }
19968: delete($possibles{$key});
19969: }
19970: }
19971: foreach my $key (keys(%possibles)) {
19972: $newunique->{$key} = $possibles{$key};
19973: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19974: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19975: $addcourse->{$tsymb} = $key;
19976: }
19977: }
19978: }
19979: if (keys(%collisions)) {
19980: if ($init <5) {
19981: if (!$init) {
19982: $init = 1;
19983: } else {
19984: $init ++;
19985: }
19986: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19987: $newunique,$addcourse,$courseonly,$failed);
19988: } else {
19989: foreach my $key (keys(%collisions)) {
19990: $failed->{$key} = 1;
19991: }
19992: }
19993: }
19994: return $init;
19995: }
19996:
1.1328 raeburn 19997: sub is_nonframeable {
1.1329 raeburn 19998: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19999: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 20000: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 20001:
20002: $remprotocol = lc($remprotocol);
20003: $remhost = lc($remhost);
20004: my $remport = 80;
20005: if ($remprotocol eq 'https') {
20006: $remport = 443;
20007: }
1.1330 raeburn 20008: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 20009: if ($cached) {
20010: unless ($nocache) {
20011: if ($result) {
20012: return 1;
20013: } else {
20014: return 0;
20015: }
20016: }
20017: }
1.1328 raeburn 20018: my $uselink;
20019: my $request = new HTTP::Request('HEAD',$url);
20020: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
20021: if ($response->is_success()) {
20022: my $secpolicy = lc($response->header('content-security-policy'));
20023: my $xframeop = lc($response->header('x-frame-options'));
20024: $secpolicy =~ s/^\s+|\s+$//g;
20025: $xframeop =~ s/^\s+|\s+$//g;
20026: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 20027: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 20028: my ($origin,$protocol,$port);
20029: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
20030: $port = $ENV{'SERVER_PORT'};
20031: } else {
20032: $port = 80;
20033: }
20034: if ($absolute eq '') {
20035: $protocol = 'http:';
20036: if ($port == 443) {
20037: $protocol = 'https:';
20038: }
20039: $origin = $protocol.'//'.lc($hostname);
20040: } else {
20041: $origin = lc($absolute);
20042: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
20043: }
20044: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
20045: my $framepolicy = $1;
20046: $framepolicy =~ s/^\s+|\s+$//g;
20047: my @policies = split(/\s+/,$framepolicy);
20048: if (@policies) {
20049: if (grep(/^\Q'none'\E$/,@policies)) {
20050: $uselink = 1;
20051: } else {
20052: $uselink = 1;
20053: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20054: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20055: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20056: undef($uselink);
20057: }
20058: if ($uselink) {
20059: if (grep(/^\Q'self'\E$/,@policies)) {
20060: if (($origin ne '') && ($remotehost eq $origin)) {
20061: undef($uselink);
20062: }
20063: }
20064: }
20065: if ($uselink) {
20066: my @possok;
20067: if ($ip ne '') {
20068: push(@possok,$ip);
20069: }
20070: my $hoststr = '';
20071: foreach my $part (reverse(split(/\./,$hostname))) {
20072: if ($hoststr eq '') {
20073: $hoststr = $part;
20074: } else {
20075: $hoststr = "$part.$hoststr";
20076: }
20077: if ($hoststr eq $hostname) {
20078: push(@possok,$hostname);
20079: } else {
20080: push(@possok,"*.$hoststr");
20081: }
20082: }
20083: if (@possok) {
20084: foreach my $poss (@possok) {
20085: last if (!$uselink);
20086: foreach my $policy (@policies) {
20087: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20088: undef($uselink);
20089: last;
20090: }
20091: }
20092: }
20093: }
20094: }
20095: }
20096: }
20097: } elsif ($xframeop ne '') {
20098: $uselink = 1;
20099: my @policies = split(/\s*,\s*/,$xframeop);
20100: if (@policies) {
20101: unless (grep(/^deny$/,@policies)) {
20102: if ($origin ne '') {
20103: if (grep(/^sameorigin$/,@policies)) {
20104: if ($remotehost eq $origin) {
20105: undef($uselink);
20106: }
20107: }
20108: if ($uselink) {
20109: foreach my $policy (@policies) {
20110: if ($policy =~ /^allow-from\s*(.+)$/) {
20111: my $allowfrom = $1;
20112: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20113: undef($uselink);
20114: last;
20115: }
20116: }
20117: }
20118: }
20119: }
20120: }
20121: }
20122: }
20123: }
20124: }
1.1329 raeburn 20125: if ($nocache) {
20126: if ($cached) {
20127: my $devalidate;
20128: if ($uselink && !$result) {
20129: $devalidate = 1;
20130: } elsif (!$uselink && $result) {
20131: $devalidate = 1;
20132: }
20133: if ($devalidate) {
20134: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20135: }
20136: }
20137: } else {
20138: if ($uselink) {
20139: $result = 1;
20140: } else {
20141: $result = 0;
20142: }
20143: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20144: }
1.1328 raeburn 20145: return $uselink;
20146: }
20147:
1.1359 raeburn 20148: sub page_menu {
20149: my ($menucolls,$menunum) = @_;
20150: my %menu;
20151: foreach my $item (split(/;/,$menucolls)) {
20152: my ($num,$value) = split(/\%/,$item);
20153: if ($num eq $menunum) {
20154: my @entries = split(/\&/,$value);
20155: foreach my $entry (@entries) {
20156: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20157: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20158: $menu{$name} = $fields;
20159: } else {
20160: my @shown;
20161: if ($fields =~ /,/) {
20162: @shown = split(/,/,$fields);
20163: } else {
20164: @shown = ($fields);
20165: }
20166: if (@shown) {
20167: foreach my $field (@shown) {
20168: next if ($field eq '');
20169: $menu{$field} = 1;
20170: }
20171: }
20172: }
20173: }
20174: }
20175: }
20176: return %menu;
20177: }
20178:
1.112 bowersj2 20179: 1;
20180: __END__;
1.41 ng 20181:
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