Annotation of loncom/interface/loncommon.pm, revision 1.1454
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1454 ! raeburn 4: # $Id: loncommon.pm,v 1.1453 2025/02/14 22:42:05 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.1383 raeburn 64: use Apache::lonnavmaps();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1409 raeburn 74: use LONCAPA::ltiutils;
1.1280 raeburn 75: use LONCAPA::LWPReq;
1.1395 raeburn 76: use LONCAPA::map();
1.1328 raeburn 77: use HTTP::Request;
1.657 raeburn 78: use DateTime::TimeZone;
1.1241 raeburn 79: use DateTime::Locale;
1.1220 raeburn 80: use Encode();
1.1091 foxr 81: use Text::Aspell;
1.1094 raeburn 82: use Authen::Captcha;
83: use Captcha::reCAPTCHA;
1.1234 raeburn 84: use JSON::DWIW;
1.1174 raeburn 85: use Crypt::DES;
86: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 87: use MIME::Lite;
88: use MIME::Types;
1.1292 raeburn 89: use File::Copy();
1.1300 raeburn 90: use File::Path();
1.1309 raeburn 91: use String::CRC32();
92: use Short::URL();
1.117 www 93:
1.517 raeburn 94: # ---------------------------------------------- Designs
95: use vars qw(%defaultdesign);
96:
1.22 www 97: my $readit;
98:
1.517 raeburn 99:
1.157 matthew 100: ##
101: ## Global Variables
102: ##
1.46 matthew 103:
1.643 foxr 104:
105: # ----------------------------------------------- SSI with retries:
106: #
107:
108: =pod
109:
1.648 raeburn 110: =head1 Server Side include with retries:
1.643 foxr 111:
112: =over 4
113:
1.648 raeburn 114: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 115:
116: Performs an ssi with some number of retries. Retries continue either
117: until the result is ok or until the retry count supplied by the
118: caller is exhausted.
119:
120: Inputs:
1.648 raeburn 121:
122: =over 4
123:
1.643 foxr 124: resource - Identifies the resource to insert.
1.648 raeburn 125:
1.643 foxr 126: retries - Count of the number of retries allowed.
1.648 raeburn 127:
1.643 foxr 128: form - Hash that identifies the rendering options.
129:
1.648 raeburn 130: =back
131:
132: Returns:
133:
134: =over 4
135:
1.643 foxr 136: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 137:
1.643 foxr 138: response - The response from the last attempt (which may or may not have been successful.
139:
1.648 raeburn 140: =back
141:
142: =back
143:
1.643 foxr 144: =cut
145:
146: sub ssi_with_retries {
147: my ($resource, $retries, %form) = @_;
148:
149:
150: my $ok = 0; # True if we got a good response.
151: my $content;
152: my $response;
153:
154: # Try to get the ssi done. within the retries count:
155:
156: do {
157: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
158: $ok = $response->is_success;
1.650 www 159: if (!$ok) {
160: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
161: }
1.643 foxr 162: $retries--;
163: } while (!$ok && ($retries > 0));
164:
165: if (!$ok) {
166: $content = ''; # On error return an empty content.
167: }
168: return ($content, $response);
169:
170: }
171:
172:
173:
1.20 www 174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 175: my %language;
1.124 www 176: my %supported_language;
1.1088 foxr 177: my %supported_codes;
1.1048 foxr 178: my %latex_language; # For choosing hyphenation in <transl..>
179: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 180: my %cprtag;
1.192 taceyjo1 181: my %scprtag;
1.351 www 182: my %fe; my %fd; my %fm;
1.41 ng 183: my %category_extensions;
1.12 harris41 184:
1.46 matthew 185: # ---------------------------------------------- Thesaurus variables
1.144 matthew 186: #
187: # %Keywords:
188: # A hash used by &keyword to determine if a word is considered a keyword.
189: # $thesaurus_db_file
190: # Scalar containing the full path to the thesaurus database.
1.46 matthew 191:
192: my %Keywords;
193: my $thesaurus_db_file;
194:
1.144 matthew 195: #
196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
197: # thesaurus.tab, and filecategories.tab.
198: #
1.18 www 199: BEGIN {
1.46 matthew 200: # Variable initialization
201: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
202: #
1.22 www 203: unless ($readit) {
1.12 harris41 204: # ------------------------------------------------------------------- languages
205: {
1.158 raeburn 206: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
207: '/language.tab';
1.1317 raeburn 208: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
1.1088 foxr 212: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 213: $language{$key}=$val.' - '.$enc;
214: if ($sup) {
215: $supported_language{$key}=$sup;
1.1088 foxr 216: $supported_codes{$key} = $code;
1.158 raeburn 217: }
1.1048 foxr 218: if ($latex) {
219: $latex_language_bykey{$key} = $latex;
1.1088 foxr 220: $latex_language{$code} = $latex;
1.1048 foxr 221: }
1.158 raeburn 222: }
223: close($fh);
224: }
1.12 harris41 225: }
226: # ------------------------------------------------------------------ copyrights
227: {
1.158 raeburn 228: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/copyright.tab';
1.1317 raeburn 230: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line=~/^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 235: $cprtag{$key}=$val;
236: }
237: close($fh);
238: }
1.12 harris41 239: }
1.351 www 240: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 241: {
242: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
243: '/source_copyright.tab';
1.1317 raeburn 244: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 249: $scprtag{$key}=$val;
250: }
251: close($fh);
252: }
253: }
1.63 www 254:
1.517 raeburn 255: # -------------------------------------------------------------- default domain designs
1.63 www 256: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 257: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 258: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($key,$val)=(split(/\=/,$line));
263: if ($val) { $defaultdesign{$key}=$val; }
264: }
265: close($fh);
1.63 www 266: }
267:
1.15 harris41 268: # ------------------------------------------------------------- file categories
269: {
1.158 raeburn 270: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filecategories.tab';
1.1317 raeburn 272: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 277: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 278: }
279: close($fh);
280: }
281:
1.15 harris41 282: }
1.12 harris41 283: # ------------------------------------------------------------------ file types
284: {
1.158 raeburn 285: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
286: '/filetypes.tab';
1.1317 raeburn 287: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 288: while (my $line = <$fh>) {
289: next if ($line =~ /^\#/);
290: chomp($line);
291: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 292: if ($descr ne '') {
293: $fe{$ending}=lc($emb);
294: $fd{$ending}=$descr;
1.351 www 295: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 296: }
297: }
298: close($fh);
299: }
1.12 harris41 300: }
1.22 www 301: &Apache::lonnet::logthis(
1.705 tempelho 302: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 303: $readit=1;
1.46 matthew 304: } # end of unless($readit)
1.32 matthew 305:
306: }
1.112 bowersj2 307:
1.42 matthew 308: ###############################################################
309: ## HTML and Javascript Helper Functions ##
310: ###############################################################
311:
312: =pod
313:
1.112 bowersj2 314: =head1 HTML and Javascript Functions
1.42 matthew 315:
1.112 bowersj2 316: =over 4
317:
1.648 raeburn 318: =item * &browser_and_searcher_javascript()
1.112 bowersj2 319:
320: X<browsing, javascript>X<searching, javascript>Returns a string
321: containing javascript with two functions, C<openbrowser> and
322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
323: tags.
1.42 matthew 324:
1.648 raeburn 325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 326:
327: inputs: formname, elementname, only, omit
328:
329: formname and elementname indicate the name of the html form and name of
330: the element that the results of the browsing selection are to be placed in.
331:
332: Specifying 'only' will restrict the browser to displaying only files
1.185 www 333: with the given extension. Can be a comma separated list.
1.42 matthew 334:
335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 336: with the given extension. Can be a comma separated list.
1.42 matthew 337:
1.648 raeburn 338: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 339:
340: Inputs: formname, elementname
341:
342: formname and elementname specify the name of the html form and the name
343: of the element the selection from the search results will be placed in.
1.542 raeburn 344:
1.42 matthew 345: =cut
346:
347: sub browser_and_searcher_javascript {
1.199 albertel 348: my ($mode)=@_;
349: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 350: my $resurl=&escape_single(&lastresurl());
1.42 matthew 351: return <<END;
1.219 albertel 352: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 353: var editbrowser = null;
1.135 albertel 354: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 355: var url = '$resurl/?';
1.42 matthew 356: if (editbrowser == null) {
357: url += 'launch=1&';
358: }
359: url += 'catalogmode=interactive&';
1.199 albertel 360: url += 'mode=$mode&';
1.611 albertel 361: url += 'inhibitmenu=yes&';
1.42 matthew 362: url += 'form=' + formname + '&';
363: if (only != null) {
364: url += 'only=' + only + '&';
1.217 albertel 365: } else {
366: url += 'only=&';
367: }
1.42 matthew 368: if (omit != null) {
369: url += 'omit=' + omit + '&';
1.217 albertel 370: } else {
371: url += 'omit=&';
372: }
1.135 albertel 373: if (titleelement != null) {
374: url += 'titleelement=' + titleelement + '&';
1.217 albertel 375: } else {
376: url += 'titleelement=&';
377: }
1.42 matthew 378: url += 'element=' + elementname + '';
379: var title = 'Browser';
1.435 albertel 380: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 381: options += ',width=700,height=600';
382: editbrowser = open(url,title,options,'1');
383: editbrowser.focus();
384: }
385: var editsearcher;
1.135 albertel 386: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 387: var url = '/adm/searchcat?';
388: if (editsearcher == null) {
389: url += 'launch=1&';
390: }
391: url += 'catalogmode=interactive&';
1.199 albertel 392: url += 'mode=$mode&';
1.42 matthew 393: url += 'form=' + formname + '&';
1.135 albertel 394: if (titleelement != null) {
395: url += 'titleelement=' + titleelement + '&';
1.217 albertel 396: } else {
397: url += 'titleelement=&';
398: }
1.42 matthew 399: url += 'element=' + elementname + '';
400: var title = 'Search';
1.435 albertel 401: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 402: options += ',width=700,height=600';
403: editsearcher = open(url,title,options,'1');
404: editsearcher.focus();
405: }
1.219 albertel 406: // END LON-CAPA Internal -->
1.42 matthew 407: END
1.170 www 408: }
409:
410: sub lastresurl {
1.258 albertel 411: if ($env{'environment.lastresurl'}) {
412: return $env{'environment.lastresurl'}
1.170 www 413: } else {
414: return '/res';
415: }
416: }
417:
418: sub storeresurl {
419: my $resurl=&Apache::lonnet::clutter(shift);
420: unless ($resurl=~/^\/res/) { return 0; }
421: $resurl=~s/\/$//;
422: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 423: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 424: return 1;
1.42 matthew 425: }
426:
1.74 www 427: sub studentbrowser_javascript {
1.111 www 428: unless (
1.258 albertel 429: (($env{'request.course.id'}) &&
1.302 albertel 430: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
431: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
432: '/'.$env{'request.course.sec'})
433: ))
1.258 albertel 434: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 435: ) { return ''; }
1.74 www 436: return (<<'ENDSTDBRW');
1.776 bisitz 437: <script type="text/javascript" language="Javascript">
1.824 bisitz 438: // <![CDATA[
1.74 www 439: var stdeditbrowser;
1.1413 raeburn 440: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74 www 441: var url = '/adm/pickstudent?';
442: var filter;
1.558 albertel 443: if (!ignorefilter) {
444: eval('filter=document.'+formname+'.'+uname+'.value;');
445: }
1.74 www 446: if (filter != null) {
447: if (filter != '') {
448: url += 'filter='+filter+'&';
449: }
450: }
451: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 452: '&udomelement='+udom+
453: '&clicker='+clicker;
1.111 www 454: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 455: if (courseadv == 'condition') {
456: if (document.getElementById('courseadv')) {
457: courseadv = document.getElementById('courseadv').value;
458: }
459: }
460: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413 raeburn 461: if (uident !== '') { url+="&identelement="+uident; }
1.102 www 462: var title = 'Student_Browser';
1.74 www 463: var options = 'scrollbars=1,resizable=1,menubar=0';
464: options += ',width=700,height=600';
465: stdeditbrowser = open(url,title,options,'1');
466: stdeditbrowser.focus();
467: }
1.824 bisitz 468: // ]]>
1.74 www 469: </script>
470: ENDSTDBRW
471: }
1.42 matthew 472:
1.1003 www 473: sub resourcebrowser_javascript {
474: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 475: return (<<'ENDRESBRW');
1.1003 www 476: <script type="text/javascript" language="Javascript">
477: // <![CDATA[
478: var reseditbrowser;
1.1004 www 479: function openresbrowser(formname,reslink) {
1.1005 www 480: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 481: var title = 'Resource_Browser';
482: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 483: options += ',width=700,height=500';
1.1004 www 484: reseditbrowser = open(url,title,options,'1');
485: reseditbrowser.focus();
1.1003 www 486: }
487: // ]]>
488: </script>
1.1004 www 489: ENDRESBRW
1.1003 www 490: }
491:
1.74 www 492: sub selectstudent_link {
1.1413 raeburn 493: my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999 www 494: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
495: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
496: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 497: if ($env{'request.course.id'}) {
1.302 albertel 498: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
499: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
500: '/'.$env{'request.course.sec'})) {
1.111 www 501: return '';
502: }
1.999 www 503: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 504: if ($courseadv eq 'only') {
505: $callargs .= ",'',1,'$courseadv'";
506: } elsif ($courseadv eq 'none') {
507: $callargs .= ",'','','$courseadv'";
508: } elsif ($courseadv eq 'condition') {
509: $callargs .= ",'','','$courseadv'";
1.1413 raeburn 510: } elsif ($identelem ne '') {
511: $callargs .= ",'','',''";
512: }
513: if ($identelem ne '') {
514: $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793 raeburn 515: }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openstdbrowser('.$callargs.');">'.
518: &mt('Select User').'</a></span>';
1.74 www 519: }
1.258 albertel 520: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 521: $callargs .= ",'',1";
1.793 raeburn 522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openstdbrowser('.$callargs.');">'.
524: &mt('Select User').'</a></span>';
1.111 www 525: }
526: return '';
1.91 www 527: }
528:
1.1004 www 529: sub selectresource_link {
530: my ($form,$reslink,$arg)=@_;
531:
532: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
533: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
534: unless ($env{'request.course.id'}) { return $arg; }
535: return '<span class="LC_nobreak">'.
536: '<a href="javascript:openresbrowser('.$callargs.');">'.
537: $arg.'</a></span>';
538: }
539:
540:
541:
1.653 raeburn 542: sub authorbrowser_javascript {
543: return <<"ENDAUTHORBRW";
1.776 bisitz 544: <script type="text/javascript" language="JavaScript">
1.824 bisitz 545: // <![CDATA[
1.653 raeburn 546: var stdeditbrowser;
547:
548: function openauthorbrowser(formname,udom) {
549: var url = '/adm/pickauthor?';
550: url += 'form='+formname+'&roledom='+udom;
551: var title = 'Author_Browser';
552: var options = 'scrollbars=1,resizable=1,menubar=0';
553: options += ',width=700,height=600';
554: stdeditbrowser = open(url,title,options,'1');
555: stdeditbrowser.focus();
556: }
557:
1.824 bisitz 558: // ]]>
1.653 raeburn 559: </script>
560: ENDAUTHORBRW
561: }
562:
1.91 www 563: sub coursebrowser_javascript {
1.1116 raeburn 564: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 565: $credits_element,$instcode) = @_;
1.932 raeburn 566: my $wintitle = 'Course_Browser';
1.931 raeburn 567: if ($crstype eq 'Community') {
1.932 raeburn 568: $wintitle = 'Community_Browser';
1.909 raeburn 569: }
1.876 raeburn 570: my $id_functions = &javascript_index_functions();
571: my $output = '
1.776 bisitz 572: <script type="text/javascript" language="JavaScript">
1.824 bisitz 573: // <![CDATA[
1.468 raeburn 574: var stdeditbrowser;'."\n";
1.876 raeburn 575:
576: $output .= <<"ENDSTDBRW";
1.909 raeburn 577: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 578: var url = '/adm/pickcourse?';
1.895 raeburn 579: var formid = getFormIdByName(formname);
1.876 raeburn 580: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 581: if (domainfilter != null) {
582: if (domainfilter != '') {
583: url += 'domainfilter='+domainfilter+'&';
584: }
585: }
1.91 www 586: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 587: '&cdomelement='+udom+
588: '&cnameelement='+desc;
1.468 raeburn 589: if (extra_element !=null && extra_element != '') {
1.594 raeburn 590: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 591: url += '&roleelement='+extra_element;
592: if (domainfilter == null || domainfilter == '') {
593: url += '&domainfilter='+extra_element;
594: }
1.234 raeburn 595: }
1.468 raeburn 596: else {
597: if (formname == 'portform') {
598: url += '&setroles='+extra_element;
1.800 raeburn 599: } else {
600: if (formname == 'rules') {
601: url += '&fixeddom='+extra_element;
602: }
1.468 raeburn 603: }
604: }
1.230 raeburn 605: }
1.909 raeburn 606: if (type != null && type != '') {
607: url += '&type='+type;
608: }
609: if (type_elem != null && type_elem != '') {
610: url += '&typeelement='+type_elem;
611: }
1.872 raeburn 612: if (formname == 'ccrs') {
613: var ownername = document.forms[formid].ccuname.value;
614: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 615: url += '&cloner='+ownername+':'+ownerdom;
616: if (type == 'Course') {
617: url += '&crscode='+document.forms[formid].crscode.value;
618: }
1.1221 raeburn 619: }
620: if (formname == 'requestcrs') {
621: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 622: }
1.293 raeburn 623: if (multflag !=null && multflag != '') {
624: url += '&multiple='+multflag;
625: }
1.909 raeburn 626: var title = '$wintitle';
1.91 www 627: var options = 'scrollbars=1,resizable=1,menubar=0';
628: options += ',width=700,height=600';
629: stdeditbrowser = open(url,title,options,'1');
630: stdeditbrowser.focus();
631: }
1.876 raeburn 632: $id_functions
633: ENDSTDBRW
1.1116 raeburn 634: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
635: $output .= &setsec_javascript($sec_element,$formname,$role_element,
636: $credits_element);
1.876 raeburn 637: }
638: $output .= '
639: // ]]>
640: </script>';
641: return $output;
642: }
643:
644: sub javascript_index_functions {
645: return <<"ENDJS";
646:
647: function getFormIdByName(formname) {
648: for (var i=0;i<document.forms.length;i++) {
649: if (document.forms[i].name == formname) {
650: return i;
651: }
652: }
653: return -1;
654: }
655:
656: function getIndexByName(formid,item) {
657: for (var i=0;i<document.forms[formid].elements.length;i++) {
658: if (document.forms[formid].elements[i].name == item) {
659: return i;
660: }
661: }
662: return -1;
663: }
1.468 raeburn 664:
1.876 raeburn 665: function getDomainFromSelectbox(formname,udom) {
666: var userdom;
667: var formid = getFormIdByName(formname);
668: if (formid > -1) {
669: var domid = getIndexByName(formid,udom);
670: if (domid > -1) {
671: if (document.forms[formid].elements[domid].type == 'select-one') {
672: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
673: }
674: if (document.forms[formid].elements[domid].type == 'hidden') {
675: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 676: }
677: }
678: }
1.876 raeburn 679: return userdom;
680: }
681:
682: ENDJS
1.468 raeburn 683:
1.876 raeburn 684: }
685:
1.1017 raeburn 686: sub javascript_array_indexof {
1.1018 raeburn 687: return <<ENDJS;
1.1017 raeburn 688: <script type="text/javascript" language="JavaScript">
689: // <![CDATA[
690:
691: if (!Array.prototype.indexOf) {
692: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
693: "use strict";
694: if (this === void 0 || this === null) {
695: throw new TypeError();
696: }
697: var t = Object(this);
698: var len = t.length >>> 0;
699: if (len === 0) {
700: return -1;
701: }
702: var n = 0;
703: if (arguments.length > 0) {
704: n = Number(arguments[1]);
1.1088 foxr 705: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 706: n = 0;
707: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
708: n = (n > 0 || -1) * Math.floor(Math.abs(n));
709: }
710: }
711: if (n >= len) {
712: return -1;
713: }
714: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
715: for (; k < len; k++) {
716: if (k in t && t[k] === searchElement) {
717: return k;
718: }
719: }
720: return -1;
721: }
722: }
723:
724: // ]]>
725: </script>
726:
727: ENDJS
728:
729: }
730:
1.876 raeburn 731: sub userbrowser_javascript {
732: my $id_functions = &javascript_index_functions();
733: return <<"ENDUSERBRW";
734:
1.888 raeburn 735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 736: var url = '/adm/pickuser?';
737: var userdom = getDomainFromSelectbox(formname,udom);
738: if (userdom != null) {
739: if (userdom != '') {
740: url += 'srchdom='+userdom+'&';
741: }
742: }
743: url += 'form=' + formname + '&unameelement='+uname+
744: '&udomelement='+udom+
745: '&ulastelement='+ulast+
746: '&ufirstelement='+ufirst+
747: '&uemailelement='+uemail+
1.881 raeburn 748: '&hideudomelement='+hideudom+
749: '&coursedom='+crsdom;
1.888 raeburn 750: if ((caller != null) && (caller != undefined)) {
751: url += '&caller='+caller;
752: }
1.876 raeburn 753: var title = 'User_Browser';
754: var options = 'scrollbars=1,resizable=1,menubar=0';
755: options += ',width=700,height=600';
756: var stdeditbrowser = open(url,title,options,'1');
757: stdeditbrowser.focus();
758: }
759:
1.888 raeburn 760: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 761: var formid = getFormIdByName(formname);
762: if (formid > -1) {
1.888 raeburn 763: var unameid = getIndexByName(formid,uname);
1.876 raeburn 764: var domid = getIndexByName(formid,udom);
765: var hidedomid = getIndexByName(formid,origdom);
766: if (hidedomid > -1) {
767: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 768: var unameval = document.forms[formid].elements[unameid].value;
769: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
770: if (domid > -1) {
771: var slct = document.forms[formid].elements[domid];
772: if (slct.type == 'select-one') {
773: var i;
774: for (i=0;i<slct.length;i++) {
775: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
776: }
777: }
778: if (slct.type == 'hidden') {
779: slct.value = fixeddom;
1.876 raeburn 780: }
781: }
1.468 raeburn 782: }
783: }
784: }
1.876 raeburn 785: return;
786: }
787:
788: $id_functions
789: ENDUSERBRW
1.468 raeburn 790: }
791:
792: sub setsec_javascript {
1.1116 raeburn 793: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 794: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
795: $communityrolestr);
796: if ($role_element ne '') {
797: my @allroles = ('st','ta','ep','in','ad');
798: foreach my $crstype ('Course','Community') {
799: if ($crstype eq 'Community') {
800: foreach my $role (@allroles) {
801: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
802: }
803: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
804: } else {
805: foreach my $role (@allroles) {
806: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
807: }
808: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
809: }
810: }
811: $rolestr = '"'.join('","',@allroles).'"';
812: $courserolestr = '"'.join('","',@courserolenames).'"';
813: $communityrolestr = '"'.join('","',@communityrolenames).'"';
814: }
1.468 raeburn 815: my $setsections = qq|
816: function setSect(sectionlist) {
1.629 raeburn 817: var sectionsArray = new Array();
818: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
819: sectionsArray = sectionlist.split(",");
820: }
1.468 raeburn 821: var numSections = sectionsArray.length;
822: document.$formname.$sec_element.length = 0;
823: if (numSections == 0) {
824: document.$formname.$sec_element.multiple=false;
825: document.$formname.$sec_element.size=1;
826: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
827: } else {
828: if (numSections == 1) {
829: document.$formname.$sec_element.multiple=false;
830: document.$formname.$sec_element.size=1;
831: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
832: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
833: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
834: } else {
835: for (var i=0; i<numSections; i++) {
836: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
837: }
838: document.$formname.$sec_element.multiple=true
839: if (numSections < 3) {
840: document.$formname.$sec_element.size=numSections;
841: } else {
842: document.$formname.$sec_element.size=3;
843: }
844: document.$formname.$sec_element.options[0].selected = false
845: }
846: }
1.91 www 847: }
1.905 raeburn 848:
849: function setRole(crstype) {
1.468 raeburn 850: |;
1.905 raeburn 851: if ($role_element eq '') {
852: $setsections .= ' return;
853: }
854: ';
855: } else {
856: $setsections .= qq|
857: var elementLength = document.$formname.$role_element.length;
858: var allroles = Array($rolestr);
859: var courserolenames = Array($courserolestr);
860: var communityrolenames = Array($communityrolestr);
861: if (elementLength != undefined) {
862: if (document.$formname.$role_element.options[5].value == 'cc') {
863: if (crstype == 'Course') {
864: return;
865: } else {
866: allroles[5] = 'co';
867: for (var i=0; i<6; i++) {
868: document.$formname.$role_element.options[i].value = allroles[i];
869: document.$formname.$role_element.options[i].text = communityrolenames[i];
870: }
871: }
872: } else {
873: if (crstype == 'Community') {
874: return;
875: } else {
876: allroles[5] = 'cc';
877: for (var i=0; i<6; i++) {
878: document.$formname.$role_element.options[i].value = allroles[i];
879: document.$formname.$role_element.options[i].text = courserolenames[i];
880: }
881: }
882: }
883: }
884: return;
885: }
886: |;
887: }
1.1116 raeburn 888: if ($credits_element) {
889: $setsections .= qq|
890: function setCredits(defaultcredits) {
891: document.$formname.$credits_element.value = defaultcredits;
892: return;
893: }
894: |;
895: }
1.468 raeburn 896: return $setsections;
897: }
898:
1.91 www 899: sub selectcourse_link {
1.909 raeburn 900: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
901: $typeelement) = @_;
902: my $type = $selecttype;
1.871 raeburn 903: my $linktext = &mt('Select Course');
904: if ($selecttype eq 'Community') {
1.909 raeburn 905: $linktext = &mt('Select Community');
1.1239 raeburn 906: } elsif ($selecttype eq 'Placement') {
907: $linktext = &mt('Select Placement Test');
1.906 raeburn 908: } elsif ($selecttype eq 'Course/Community') {
909: $linktext = &mt('Select Course/Community');
1.909 raeburn 910: $type = '';
1.1019 raeburn 911: } elsif ($selecttype eq 'Select') {
912: $linktext = &mt('Select');
913: $type = '';
1.871 raeburn 914: }
1.787 bisitz 915: return '<span class="LC_nobreak">'
916: ."<a href='"
917: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
918: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 919: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 920: ."'>".$linktext.'</a>'
1.787 bisitz 921: .'</span>';
1.74 www 922: }
1.42 matthew 923:
1.653 raeburn 924: sub selectauthor_link {
925: my ($form,$udom)=@_;
926: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
927: &mt('Select Author').'</a>';
928: }
929:
1.876 raeburn 930: sub selectuser_link {
1.881 raeburn 931: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 932: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 933: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 934: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 935: ');">'.$linktext.'</a>';
1.876 raeburn 936: }
937:
1.273 raeburn 938: sub check_uncheck_jscript {
939: my $jscript = <<"ENDSCRT";
940: function checkAll(field) {
941: if (field.length > 0) {
942: for (i = 0; i < field.length; i++) {
1.1093 raeburn 943: if (!field[i].disabled) {
944: field[i].checked = true;
945: }
1.273 raeburn 946: }
947: } else {
1.1093 raeburn 948: if (!field.disabled) {
949: field.checked = true;
950: }
1.273 raeburn 951: }
952: }
953:
954: function uncheckAll(field) {
955: if (field.length > 0) {
956: for (i = 0; i < field.length; i++) {
957: field[i].checked = false ;
1.543 albertel 958: }
959: } else {
1.273 raeburn 960: field.checked = false ;
961: }
962: }
963: ENDSCRT
964: return $jscript;
965: }
966:
1.656 www 967: sub select_timezone {
1.1387 raeburn 968: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
969: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 970: if ($includeempty) {
971: $output .= '<option value=""';
972: if (($selected eq '') || ($selected eq 'local')) {
973: $output .= ' selected="selected" ';
974: }
975: $output .= '> </option>';
976: }
1.657 raeburn 977: my @timezones = DateTime::TimeZone->all_names;
978: foreach my $tzone (@timezones) {
979: $output.= '<option value="'.$tzone.'"';
980: if ($tzone eq $selected) {
981: $output.=' selected="selected"';
982: }
983: $output.=">$tzone</option>\n";
1.656 www 984: }
985: $output.="</select>";
986: return $output;
987: }
1.273 raeburn 988:
1.687 raeburn 989: sub select_datelocale {
1.1256 raeburn 990: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
991: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 992: if ($includeempty) {
993: $output .= '<option value=""';
994: if ($selected eq '') {
995: $output .= ' selected="selected" ';
996: }
997: $output .= '> </option>';
998: }
1.1241 raeburn 999: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 1000: my (@possibles,%locale_names);
1.1241 raeburn 1001: my @locales = DateTime::Locale->ids();
1002: foreach my $id (@locales) {
1003: if ($id ne '') {
1004: my ($en_terr,$native_terr);
1005: my $loc = DateTime::Locale->load($id);
1006: if (ref($loc)) {
1007: $en_terr = $loc->name();
1008: $native_terr = $loc->native_name();
1.687 raeburn 1009: if (grep(/^en$/,@languages) || !@languages) {
1010: if ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: } elsif ($native_terr ne '') {
1013: $locale_names{$id} = $native_terr;
1014: }
1015: } else {
1016: if ($native_terr ne '') {
1017: $locale_names{$id} = $native_terr.' ';
1018: } elsif ($en_terr ne '') {
1019: $locale_names{$id} = '('.$en_terr.')';
1020: }
1021: }
1.1220 raeburn 1022: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1023: push(@possibles,$id);
1024: }
1.687 raeburn 1025: }
1026: }
1027: foreach my $item (sort(@possibles)) {
1028: $output.= '<option value="'.$item.'"';
1029: if ($item eq $selected) {
1030: $output.=' selected="selected"';
1031: }
1032: $output.=">$item";
1033: if ($locale_names{$item} ne '') {
1.1220 raeburn 1034: $output.=' '.$locale_names{$item};
1.687 raeburn 1035: }
1036: $output.="</option>\n";
1037: }
1038: $output.="</select>";
1039: return $output;
1040: }
1041:
1.792 raeburn 1042: sub select_language {
1.1256 raeburn 1043: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1044: my %langchoices;
1045: if ($includeempty) {
1.1117 raeburn 1046: %langchoices = ('' => 'No language preference');
1.792 raeburn 1047: }
1048: foreach my $id (&languageids()) {
1049: my $code = &supportedlanguagecode($id);
1050: if ($code) {
1051: $langchoices{$code} = &plainlanguagedescription($id);
1052: }
1053: }
1.1117 raeburn 1054: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1055: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1056: }
1057:
1.42 matthew 1058: =pod
1.36 matthew 1059:
1.1088 foxr 1060:
1061: =item * &list_languages()
1062:
1063: Returns an array reference that is suitable for use in language prompters.
1064: Each array element is itself a two element array. The first element
1065: is the language code. The second element a descsriptiuon of the
1066: language itself. This is suitable for use in e.g.
1067: &Apache::edit::select_arg (once dereferenced that is).
1068:
1069: =cut
1070:
1071: sub list_languages {
1072: my @lang_choices;
1073:
1074: foreach my $id (&languageids()) {
1075: my $code = &supportedlanguagecode($id);
1076: if ($code) {
1077: my $selector = $supported_codes{$id};
1078: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1079: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1080: }
1081: }
1082: return \@lang_choices;
1083: }
1084:
1085: =pod
1086:
1.648 raeburn 1087: =item * &linked_select_forms(...)
1.36 matthew 1088:
1089: linked_select_forms returns a string containing a <script></script> block
1090: and html for two <select> menus. The select menus will be linked in that
1091: changing the value of the first menu will result in new values being placed
1092: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1093: order unless a defined order is provided.
1.36 matthew 1094:
1095: linked_select_forms takes the following ordered inputs:
1096:
1097: =over 4
1098:
1.112 bowersj2 1099: =item * $formname, the name of the <form> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1102:
1.112 bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36 matthew 1104:
1.112 bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1106:
1.112 bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1108:
1.112 bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1110:
1.609 raeburn 1111: =item * $menuorder, the order of values in the first menu
1112:
1.1115 raeburn 1113: =item * $onchangefirst, additional javascript call to execute for an onchange
1114: event for the first <select> tag
1115:
1116: =item * $onchangesecond, additional javascript call to execute for an onchange
1117: event for the second <select> tag
1118:
1.1245 raeburn 1119: =item * $suffix, to differentiate separate uses of select2data javascript
1120: objects in a page.
1121:
1.41 ng 1122: =back
1123:
1.36 matthew 1124: Below is an example of such a hash. Only the 'text', 'default', and
1125: 'select2' keys must appear as stated. keys(%menu) are the possible
1126: values for the first select menu. The text that coincides with the
1.41 ng 1127: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1128: and text for the second menu are given in the hash pointed to by
1129: $menu{$choice1}->{'select2'}.
1130:
1.112 bowersj2 1131: my %menu = ( A1 => { text =>"Choice A1" ,
1132: default => "B3",
1133: select2 => {
1134: B1 => "Choice B1",
1135: B2 => "Choice B2",
1136: B3 => "Choice B3",
1137: B4 => "Choice B4"
1.609 raeburn 1138: },
1139: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1140: },
1141: A2 => { text =>"Choice A2" ,
1142: default => "C2",
1143: select2 => {
1144: C1 => "Choice C1",
1145: C2 => "Choice C2",
1146: C3 => "Choice C3"
1.609 raeburn 1147: },
1148: order => ['C2','C1','C3'],
1.112 bowersj2 1149: },
1150: A3 => { text =>"Choice A3" ,
1151: default => "D6",
1152: select2 => {
1153: D1 => "Choice D1",
1154: D2 => "Choice D2",
1155: D3 => "Choice D3",
1156: D4 => "Choice D4",
1157: D5 => "Choice D5",
1158: D6 => "Choice D6",
1159: D7 => "Choice D7"
1.609 raeburn 1160: },
1161: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1162: }
1163: );
1.36 matthew 1164:
1165: =cut
1166:
1167: sub linked_select_forms {
1168: my ($formname,
1169: $middletext,
1170: $firstdefault,
1171: $firstselectname,
1172: $secondselectname,
1.609 raeburn 1173: $hashref,
1174: $menuorder,
1.1115 raeburn 1175: $onchangefirst,
1.1245 raeburn 1176: $onchangesecond,
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.438 albertel 6950: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6951:
1.101 www 6952: # construct main body tag
1.359 albertel 6953: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6954: &Apache::lontexconvert::init_math_support();
1.252 albertel 6955:
1.1131 raeburn 6956: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6957:
1.1130 raeburn 6958: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6959: return $bodytag;
1.1130 raeburn 6960: }
1.359 albertel 6961:
1.954 raeburn 6962: if ($public) {
1.433 albertel 6963: undef($role);
6964: }
1.1318 raeburn 6965:
1.1359 raeburn 6966: my $showcrstitle = 1;
1.1357 raeburn 6967: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6968: if (ref($ltimenu) eq 'HASH') {
6969: unless ($ltimenu->{'role'}) {
6970: undef($role);
6971: }
6972: unless ($ltimenu->{'coursetitle'}) {
1.1359 raeburn 6973: $showcrstitle = 0;
6974: }
6975: }
6976: } elsif (($cid) && ($menucoll)) {
6977: if (ref($menuref) eq 'HASH') {
6978: unless ($menuref->{'role'}) {
6979: undef($role);
6980: }
6981: unless ($menuref->{'crs'}) {
6982: $showcrstitle = 0;
1.1318 raeburn 6983: }
6984: }
6985: }
6986:
1.762 bisitz 6987: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6988: #
6989: # Extra info if you are the DC
6990: my $dc_info = '';
1.1359 raeburn 6991: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6992: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6993: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6994: $dc_info =~ s/\s+$//;
1.359 albertel 6995: }
6996:
1.1237 raeburn 6997: my $crstype;
1.1357 raeburn 6998: if ($cid) {
6999: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 7000: } elsif ($args->{'crstype'}) {
7001: $crstype = $args->{'crstype'};
7002: }
7003: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
7004: undef($role);
7005: } else {
1.1242 raeburn 7006: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 7007: }
1.853 droeschl 7008:
1.903 droeschl 7009: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
7010:
7011: # if ($env{'request.state'} eq 'construct') {
7012: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7013: # }
7014:
1.1440 raeburn 7015: my $need_endlcint;
7016: unless ($args->{'switchserver'}) {
7017: $bodytag .= Apache::lonhtmlcommon::scripttag(
7018: Apache::lonmenu::utilityfunctions($httphost), 'start');
7019: $need_endlcint = 1;
7020: }
1.359 albertel 7021:
1.1427 raeburn 7022: my $collapsible;
1.1423 raeburn 7023: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7024: $collapsible = 1;
7025: my ($menustate,$tiptext,$divclass);
7026: if ($args->{'start_collapsed'}) {
7027: $menustate = 'collapsed';
7028: $tiptext = 'display';
7029: $divclass = 'hidden';
7030: } else {
7031: $menustate = 'expanded';
7032: $tiptext = 'hide';
7033: $divclass = 'shown';
7034: }
7035: my $alttext = &mt('menu state: '.$menustate);
7036: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7037: $bodytag .= <<"END";
7038: <div id="LC_expandingContainer" style="display:inline;">
7039: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7040: <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>
7041: <div class="LC_menus_content $divclass">
1.1421 raeburn 7042: END
7043: }
1.1318 raeburn 7044: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7045: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7046: $args->{'links_disabled'},
1.1421 raeburn 7047: $args->{'links_target'},
1.1427 raeburn 7048: $collapsible);
1.1454 ! raeburn 7049: my $labeltext = &HTML::Entities::encode(&mt('Primary links'));
1.1318 raeburn 7050: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7051: if ($dc_info) {
7052: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7053: }
1.1454 ! raeburn 7054: $bodytag .= qq|<div id="LC_nav_bar" role="navigation" aria-label="$labeltext">$left $role<br />|;
! 7055: unless (($realm eq '') && ($dc_info eq '')) {
! 7056: $bodytag .= qq|<div id="LC_realm" role="complementary"><em>$realm</em> $dc_info</div>|;
! 7057: }
1.1440 raeburn 7058: if ($need_endlcint) {
7059: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7060: }
1.1318 raeburn 7061: return $bodytag;
7062: }
1.894 droeschl 7063:
1.1454 ! raeburn 7064: $bodytag .= '<div class="LC_landmark" role="navigation" aria-label="'.$labeltext.'">';
1.1318 raeburn 7065: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7066: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7067: }
1.916 droeschl 7068:
1.1454 ! raeburn 7069: $bodytag .= $right.'</div>';
1.852 droeschl 7070:
1.1318 raeburn 7071: if ($dc_info) {
7072: $dc_info = &dc_courseid_toggle($dc_info);
7073: }
1.1454 ! raeburn 7074: unless (($realm eq '') && ($dc_info eq '')) {
! 7075: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
! 7076: }
1.917 raeburn 7077: }
1.916 droeschl 7078:
1.1169 raeburn 7079: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7080: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7081: if ($need_endlcint) {
7082: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7083: }
1.1168 raeburn 7084: return $bodytag;
7085: }
1.1169 raeburn 7086: #don't show menus for public users
1.954 raeburn 7087: if (!$public){
1.1318 raeburn 7088: unless ($args->{'no_inline_menu'}) {
7089: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7090: $args->{'no_primary_menu'},
1.1369 raeburn 7091: $menucoll,$menuref,
1.1380 raeburn 7092: $args->{'links_disabled'},
7093: $args->{'links_target'});
1.1318 raeburn 7094: }
1.903 droeschl 7095: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7096: if ($need_endlcint) {
7097: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7098: }
1.920 raeburn 7099: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7100: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7101: $args->{'bread_crumbs'},'','',$hostname,
7102: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7103: } elsif ($forcereg) {
7104: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7105: $args->{'group'},$args->{'hide_buttons'},
7106: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7107: } else {
7108: $bodytag .=
7109: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7110: $forcereg,$args->{'group'},
7111: $args->{'bread_crumbs'},
1.1274 raeburn 7112: $advtoolsref,'',$hostname);
1.920 raeburn 7113: }
1.1440 raeburn 7114: } else {
7115: # this is to separate menu from content when there's no secondary
1.1441 raeburn 7116: # menu. Especially needed for publicly accessible resources.
1.903 droeschl 7117: $bodytag .= '<hr style="clear:both" />';
1.1440 raeburn 7118: if ($need_endlcint) {
7119: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7120: }
1.235 raeburn 7121: }
1.1423 raeburn 7122: if ($args->{'collapsible_header'} ne '') {
7123: $bodytag .= $args->{'collapsible_header'}.
7124: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7125: '</div></div>';
7126: }
1.235 raeburn 7127: return $bodytag;
1.182 matthew 7128: }
7129:
1.917 raeburn 7130: sub dc_courseid_toggle {
7131: my ($dc_info) = @_;
1.980 raeburn 7132: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7133: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7134: &mt('(More ...)').'</a></span>'.
7135: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7136: }
7137:
1.330 albertel 7138: sub make_attr_string {
7139: my ($register,$attr_ref) = @_;
7140:
7141: if ($attr_ref && !ref($attr_ref)) {
7142: die("addentries Must be a hash ref ".
7143: join(':',caller(1))." ".
7144: join(':',caller(0))." ");
7145: }
7146:
7147: if ($register) {
1.339 albertel 7148: my ($on_load,$on_unload);
7149: foreach my $key (keys(%{$attr_ref})) {
7150: if (lc($key) eq 'onload') {
7151: $on_load.=$attr_ref->{$key}.';';
7152: delete($attr_ref->{$key});
7153:
7154: } elsif (lc($key) eq 'onunload') {
7155: $on_unload.=$attr_ref->{$key}.';';
7156: delete($attr_ref->{$key});
7157: }
7158: }
1.953 droeschl 7159: $attr_ref->{'onload'} = $on_load;
7160: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7161: }
1.339 albertel 7162:
1.330 albertel 7163: my $attr_string;
1.1159 raeburn 7164: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7165: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7166: }
7167: return $attr_string;
7168: }
7169:
7170:
1.182 matthew 7171: ###############################################
1.251 albertel 7172: ###############################################
7173:
7174: =pod
7175:
7176: =item * &endbodytag()
7177:
7178: Returns a uniform footer for LON-CAPA web pages.
7179:
1.635 raeburn 7180: Inputs: 1 - optional reference to an args hash
7181: If in the hash, key for noredirectlink has a value which evaluates to true,
7182: a 'Continue' link is not displayed if the page contains an
7183: internal redirect in the <head></head> section,
7184: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7185:
7186: =cut
7187:
7188: sub endbodytag {
1.635 raeburn 7189: my ($args) = @_;
1.1080 raeburn 7190: my $endbodytag;
7191: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7192: $endbodytag='</body>';
7193: }
1.315 albertel 7194: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7195: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7196: my ($endbodyjs,$idattr);
7197: if ($env{'internal.head.to_opener'}) {
7198: my $linkid = 'LC_continue_link';
7199: $idattr = ' id="'.$linkid.'"';
7200: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7201: $endbodyjs=<<ENDJS;
7202: <script type="text/javascript">
7203: // <![CDATA[
7204: function ebFunction(evt) {
7205: evt.preventDefault();
7206: var dest = '$redirect_for_js';
7207: if (window.opener != null && !window.opener.closed) {
7208: window.opener.location.href=dest;
7209: window.close();
7210: } else {
7211: window.location.href=dest;
7212: }
7213: return false;
7214: }
7215:
7216: \$(document).ready(function () {
7217: if (document.getElementById('$linkid')) {
7218: var clickelem = document.getElementById('$linkid');
7219: clickelem.addEventListener('click',ebFunction,false);
7220: }
7221: });
7222: // ]]>
7223: </script>
7224: ENDJS
7225: }
1.635 raeburn 7226: $endbodytag=
1.1386 raeburn 7227: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7228: &mt('Continue').'</a>'.
7229: $endbodytag;
7230: }
1.315 albertel 7231: }
1.1411 raeburn 7232: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7233: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7234: }
1.251 albertel 7235: return $endbodytag;
7236: }
7237:
1.352 albertel 7238: =pod
7239:
7240: =item * &standard_css()
7241:
7242: Returns a style sheet
7243:
7244: Inputs: (all optional)
7245: domain -> force to color decorate a page for a specific
7246: domain
7247: function -> force usage of a specific rolish color scheme
7248: bgcolor -> override the default page bgcolor
7249:
7250: =cut
7251:
1.343 albertel 7252: sub standard_css {
1.345 albertel 7253: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7254: $function = &get_users_function() if (!$function);
7255: my $tabbg = &designparm($function.'.tabbg', $domain);
7256: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7257: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7258: #second colour for later usage
1.345 albertel 7259: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7260: my $pgbg_or_bgcolor =
7261: $bgcolor ||
1.352 albertel 7262: &designparm($function.'.pgbg', $domain);
1.382 albertel 7263: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7264: my $alink = &designparm($function.'.alink', $domain);
7265: my $vlink = &designparm($function.'.vlink', $domain);
7266: my $link = &designparm($function.'.link', $domain);
7267:
1.602 albertel 7268: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7269: my $mono = 'monospace';
1.850 bisitz 7270: my $data_table_head = $sidebg;
7271: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7272: my $data_table_dark = '#E0E0E0';
1.470 banghart 7273: my $data_table_darker = '#CCCCCC';
1.349 albertel 7274: my $data_table_highlight = '#FFFF00';
1.352 albertel 7275: my $mail_new = '#FFBB77';
7276: my $mail_new_hover = '#DD9955';
7277: my $mail_read = '#BBBB77';
7278: my $mail_read_hover = '#999944';
7279: my $mail_replied = '#AAAA88';
7280: my $mail_replied_hover = '#888855';
7281: my $mail_other = '#99BBBB';
7282: my $mail_other_hover = '#669999';
1.391 albertel 7283: my $table_header = '#DDDDDD';
1.489 raeburn 7284: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7285: my $lg_border_color = '#C8C8C8';
1.952 onken 7286: my $button_hover = '#BF2317';
1.392 albertel 7287:
1.608 albertel 7288: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7289: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7290: : '0 3px 0 4px';
1.448 albertel 7291:
1.523 albertel 7292:
1.343 albertel 7293: return <<END;
1.947 droeschl 7294:
7295: /* needed for iframe to allow 100% height in FF */
7296: body, html {
7297: margin: 0;
7298: padding: 0 0.5%;
7299: height: 99%; /* to avoid scrollbars */
7300: }
7301:
1.795 www 7302: body {
1.911 bisitz 7303: font-family: $sans;
7304: line-height:130%;
7305: font-size:0.83em;
7306: color:$font;
1.1436 raeburn 7307: background-color: $pgbg_or_bgcolor;
1.795 www 7308: }
7309:
1.959 onken 7310: a:focus,
7311: a:focus img {
1.795 www 7312: color: red;
7313: }
1.698 harmsja 7314:
1.911 bisitz 7315: form, .inline {
7316: display: inline;
1.795 www 7317: }
1.721 harmsja 7318:
1.1453 raeburn 7319: .LC_landmark {
7320: margin: 0;
7321: padding: 0;
7322: border: none;
7323: }
7324:
1.1443 raeburn 7325: .LC_visually_hidden:not(:focus):not(:active) {
7326: clip-path: inset(50%);
7327: height: 1px;
7328: overflow: hidden;
7329: position: absolute;
7330: white-space: nowrap;
7331: width: 1px;
7332: display: inline;
7333: }
7334:
1.1453 raeburn 7335: .LC_heading_2 {
7336: font-size: 1.17em;
7337: margin-top: 1em;
7338: margin-bottom: 1em;
7339: }
7340:
1.1421 raeburn 7341: .LC_menus_content.shown{
1.1428 raeburn 7342: display: block;
1.1421 raeburn 7343: }
7344:
7345: .LC_menus_content.hidden {
7346: display: none;
7347: }
7348:
1.795 www 7349: .LC_right {
1.911 bisitz 7350: text-align:right;
1.795 www 7351: }
7352:
1.1449 raeburn 7353: .LC_center {
7354: text-align:center;
7355: }
7356:
1.795 www 7357: .LC_middle {
1.911 bisitz 7358: vertical-align:middle;
1.795 www 7359: }
1.721 harmsja 7360:
1.1130 raeburn 7361: .LC_floatleft {
7362: float: left;
7363: }
7364:
7365: .LC_floatright {
7366: float: right;
7367: }
7368:
1.911 bisitz 7369: .LC_400Box {
7370: width:400px;
7371: }
1.721 harmsja 7372:
1.1421 raeburn 7373: #LC_collapsible_separator {
7374: border: 1px solid black;
7375: width: 99.9%;
7376: height: 0px;
7377: }
7378:
1.947 droeschl 7379: .LC_iframecontainer {
7380: width: 98%;
7381: margin: 0;
7382: position: fixed;
7383: top: 8.5em;
7384: bottom: 0;
7385: }
7386:
7387: .LC_iframecontainer iframe{
7388: border: none;
7389: width: 100%;
7390: height: 100%;
7391: }
7392:
1.778 bisitz 7393: .LC_filename {
7394: font-family: $mono;
7395: white-space:pre;
1.921 bisitz 7396: font-size: 120%;
1.778 bisitz 7397: }
7398:
7399: .LC_fileicon {
7400: border: none;
7401: height: 1.3em;
7402: vertical-align: text-bottom;
7403: margin-right: 0.3em;
7404: text-decoration:none;
7405: }
7406:
1.1008 www 7407: .LC_setting {
7408: text-decoration:underline;
7409: }
7410:
1.350 albertel 7411: .LC_error {
7412: color: red;
7413: }
1.795 www 7414:
1.1097 bisitz 7415: .LC_warning {
7416: color: darkorange;
7417: }
7418:
1.457 albertel 7419: .LC_diff_removed {
1.733 bisitz 7420: color: red;
1.394 albertel 7421: }
1.532 albertel 7422:
7423: .LC_info,
1.457 albertel 7424: .LC_success,
7425: .LC_diff_added {
1.350 albertel 7426: color: green;
7427: }
1.795 www 7428:
1.802 bisitz 7429: div.LC_confirm_box {
7430: background-color: #FAFAFA;
7431: border: 1px solid $lg_border_color;
7432: margin-right: 0;
7433: padding: 5px;
7434: }
7435:
7436: div.LC_confirm_box .LC_error img,
7437: div.LC_confirm_box .LC_success img {
7438: vertical-align: middle;
7439: }
7440:
1.1242 raeburn 7441: .LC_maxwidth {
7442: max-width: 100%;
7443: height: auto;
7444: }
7445:
1.1243 raeburn 7446: .LC_textsize_mobile {
7447: \@media only screen and (max-device-width: 480px) {
7448: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7449: }
7450: }
7451:
1.440 albertel 7452: .LC_icon {
1.771 droeschl 7453: border: none;
1.790 droeschl 7454: vertical-align: middle;
1.771 droeschl 7455: }
7456:
1.543 albertel 7457: .LC_docs_spacer {
7458: width: 25px;
7459: height: 1px;
1.771 droeschl 7460: border: none;
1.543 albertel 7461: }
1.346 albertel 7462:
1.532 albertel 7463: .LC_internal_info {
1.735 bisitz 7464: color: #999999;
1.532 albertel 7465: }
7466:
1.794 www 7467: .LC_discussion {
1.1050 www 7468: background: $data_table_dark;
1.911 bisitz 7469: border: 1px solid black;
7470: margin: 2px;
1.794 www 7471: }
7472:
7473: .LC_disc_action_left {
1.1050 www 7474: background: $sidebg;
1.911 bisitz 7475: text-align: left;
1.1050 www 7476: padding: 4px;
7477: margin: 2px;
1.794 www 7478: }
7479:
7480: .LC_disc_action_right {
1.1050 www 7481: background: $sidebg;
1.911 bisitz 7482: text-align: right;
1.1050 www 7483: padding: 4px;
7484: margin: 2px;
1.794 www 7485: }
7486:
7487: .LC_disc_new_item {
1.911 bisitz 7488: background: white;
7489: border: 2px solid red;
1.1050 www 7490: margin: 4px;
7491: padding: 4px;
1.794 www 7492: }
7493:
7494: .LC_disc_old_item {
1.911 bisitz 7495: background: white;
1.1050 www 7496: margin: 4px;
7497: padding: 4px;
1.794 www 7498: }
7499:
1.458 albertel 7500: table.LC_pastsubmission {
7501: border: 1px solid black;
7502: margin: 2px;
7503: }
7504:
1.924 bisitz 7505: table#LC_menubuttons {
1.345 albertel 7506: width: 100%;
7507: background: $pgbg;
1.392 albertel 7508: border: 2px;
1.402 albertel 7509: border-collapse: separate;
1.803 bisitz 7510: padding: 0;
1.345 albertel 7511: }
1.392 albertel 7512:
1.801 tempelho 7513: table#LC_title_bar a {
7514: color: $fontmenu;
7515: }
1.836 bisitz 7516:
1.807 droeschl 7517: table#LC_title_bar {
1.819 tempelho 7518: clear: both;
1.836 bisitz 7519: display: none;
1.807 droeschl 7520: }
7521:
1.795 www 7522: table#LC_title_bar,
1.933 droeschl 7523: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7524: table#LC_title_bar.LC_with_remote {
1.359 albertel 7525: width: 100%;
1.392 albertel 7526: border-color: $pgbg;
7527: border-style: solid;
7528: border-width: $border;
1.379 albertel 7529: background: $pgbg;
1.801 tempelho 7530: color: $fontmenu;
1.392 albertel 7531: border-collapse: collapse;
1.803 bisitz 7532: padding: 0;
1.819 tempelho 7533: margin: 0;
1.359 albertel 7534: }
1.795 www 7535:
1.933 droeschl 7536: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7537: margin: 0;
7538: padding: 0;
1.933 droeschl 7539: position: relative;
7540: list-style: none;
1.913 droeschl 7541: }
1.933 droeschl 7542: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7543: display: inline;
7544: }
1.933 droeschl 7545:
7546: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7547: padding: 0;
1.933 droeschl 7548: margin: 0;
7549: float: left;
1.913 droeschl 7550: }
1.933 droeschl 7551: .LC_breadcrumb_tools_tools {
7552: padding: 0;
7553: margin: 0;
1.913 droeschl 7554: float: right;
7555: }
7556:
1.1240 raeburn 7557: .LC_placement_prog {
7558: padding-right: 20px;
7559: font-weight: bold;
7560: font-size: 90%;
7561: }
7562:
1.359 albertel 7563: table#LC_title_bar td {
7564: background: $tabbg;
7565: }
1.795 www 7566:
1.911 bisitz 7567: table#LC_menubuttons img {
1.803 bisitz 7568: border: none;
1.346 albertel 7569: }
1.795 www 7570:
1.842 droeschl 7571: .LC_breadcrumbs_component {
1.911 bisitz 7572: float: right;
7573: margin: 0 1em;
1.357 albertel 7574: }
1.842 droeschl 7575: .LC_breadcrumbs_component img {
1.911 bisitz 7576: vertical-align: middle;
1.777 tempelho 7577: }
1.795 www 7578:
1.1243 raeburn 7579: .LC_breadcrumbs_hoverable {
7580: background: $sidebg;
7581: }
7582:
1.383 albertel 7583: td.LC_table_cell_checkbox {
7584: text-align: center;
7585: }
1.795 www 7586:
7587: .LC_fontsize_small {
1.911 bisitz 7588: font-size: 70%;
1.705 tempelho 7589: }
7590:
1.844 bisitz 7591: #LC_breadcrumbs {
1.911 bisitz 7592: clear:both;
7593: background: $sidebg;
7594: border-bottom: 1px solid $lg_border_color;
7595: line-height: 2.5em;
1.933 droeschl 7596: overflow: hidden;
1.911 bisitz 7597: margin: 0;
7598: padding: 0;
1.995 raeburn 7599: text-align: left;
1.819 tempelho 7600: }
1.862 bisitz 7601:
1.1098 bisitz 7602: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7603: clear:both;
7604: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7605: border: 1px solid $sidebg;
1.1098 bisitz 7606: margin: 0 0 10px 0;
1.966 bisitz 7607: padding: 3px;
1.995 raeburn 7608: text-align: left;
1.822 bisitz 7609: }
7610:
1.795 www 7611: .LC_fontsize_medium {
1.911 bisitz 7612: font-size: 85%;
1.705 tempelho 7613: }
7614:
1.795 www 7615: .LC_fontsize_large {
1.911 bisitz 7616: font-size: 120%;
1.705 tempelho 7617: }
7618:
1.346 albertel 7619: .LC_menubuttons_inline_text {
7620: color: $font;
1.698 harmsja 7621: font-size: 90%;
1.701 harmsja 7622: padding-left:3px;
1.346 albertel 7623: }
7624:
1.934 droeschl 7625: .LC_menubuttons_inline_text img{
7626: vertical-align: middle;
7627: }
7628:
1.1051 www 7629: li.LC_menubuttons_inline_text img {
1.951 onken 7630: cursor:pointer;
1.1002 droeschl 7631: text-decoration: none;
1.951 onken 7632: }
7633:
1.526 www 7634: .LC_menubuttons_link {
7635: text-decoration: none;
7636: }
1.795 www 7637:
1.522 albertel 7638: .LC_menubuttons_category {
1.521 www 7639: color: $font;
1.526 www 7640: background: $pgbg;
1.521 www 7641: font-size: larger;
7642: font-weight: bold;
7643: }
7644:
1.346 albertel 7645: td.LC_menubuttons_text {
1.911 bisitz 7646: color: $font;
1.346 albertel 7647: }
1.706 harmsja 7648:
1.346 albertel 7649: .LC_current_location {
7650: background: $tabbg;
7651: }
1.795 www 7652:
1.1286 raeburn 7653: td.LC_zero_height {
7654: line-height: 0;
7655: cellpadding: 0;
7656: }
7657:
1.938 bisitz 7658: table.LC_data_table {
1.347 albertel 7659: border: 1px solid #000000;
1.402 albertel 7660: border-collapse: separate;
1.426 albertel 7661: border-spacing: 1px;
1.610 albertel 7662: background: $pgbg;
1.347 albertel 7663: }
1.795 www 7664:
1.422 albertel 7665: .LC_data_table_dense {
7666: font-size: small;
7667: }
1.795 www 7668:
1.507 raeburn 7669: table.LC_nested_outer {
7670: border: 1px solid #000000;
1.589 raeburn 7671: border-collapse: collapse;
1.803 bisitz 7672: border-spacing: 0;
1.507 raeburn 7673: width: 100%;
7674: }
1.795 www 7675:
1.879 raeburn 7676: table.LC_innerpickbox,
1.507 raeburn 7677: table.LC_nested {
1.803 bisitz 7678: border: none;
1.589 raeburn 7679: border-collapse: collapse;
1.803 bisitz 7680: border-spacing: 0;
1.507 raeburn 7681: width: 100%;
7682: }
1.795 www 7683:
1.911 bisitz 7684: table.LC_data_table tr th,
7685: table.LC_calendar tr th,
1.879 raeburn 7686: table.LC_prior_tries tr th,
7687: table.LC_innerpickbox tr th {
1.349 albertel 7688: font-weight: bold;
7689: background-color: $data_table_head;
1.801 tempelho 7690: color:$fontmenu;
1.701 harmsja 7691: font-size:90%;
1.347 albertel 7692: }
1.795 www 7693:
1.879 raeburn 7694: table.LC_innerpickbox tr th,
7695: table.LC_innerpickbox tr td {
7696: vertical-align: top;
7697: }
7698:
1.711 raeburn 7699: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7700: background-color: #CCCCCC;
1.711 raeburn 7701: font-weight: bold;
7702: text-align: left;
7703: }
1.795 www 7704:
1.912 bisitz 7705: table.LC_data_table tr.LC_odd_row > td {
7706: background-color: $data_table_light;
7707: padding: 2px;
7708: vertical-align: top;
7709: }
7710:
1.809 bisitz 7711: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7712: background-color: $data_table_light;
1.912 bisitz 7713: vertical-align: top;
7714: }
7715:
7716: table.LC_data_table tr.LC_even_row > td {
7717: background-color: $data_table_dark;
1.425 albertel 7718: padding: 2px;
1.900 bisitz 7719: vertical-align: top;
1.347 albertel 7720: }
1.795 www 7721:
1.809 bisitz 7722: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7723: background-color: $data_table_dark;
1.900 bisitz 7724: vertical-align: top;
1.347 albertel 7725: }
1.795 www 7726:
1.425 albertel 7727: table.LC_data_table tr.LC_data_table_highlight td {
7728: background-color: $data_table_darker;
7729: }
1.795 www 7730:
1.639 raeburn 7731: table.LC_data_table tr td.LC_leftcol_header {
7732: background-color: $data_table_head;
7733: font-weight: bold;
7734: }
1.795 www 7735:
1.451 albertel 7736: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7737: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7738: font-weight: bold;
7739: font-style: italic;
7740: text-align: center;
7741: padding: 8px;
1.347 albertel 7742: }
1.795 www 7743:
1.1114 raeburn 7744: table.LC_data_table tr.LC_empty_row td,
7745: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7746: background-color: $sidebg;
7747: }
7748:
7749: table.LC_nested tr.LC_empty_row td {
7750: background-color: #FFFFFF;
7751: }
7752:
1.890 droeschl 7753: table.LC_caption {
7754: }
7755:
1.507 raeburn 7756: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7757: padding: 4ex
7758: }
1.795 www 7759:
1.507 raeburn 7760: table.LC_nested_outer tr th {
7761: font-weight: bold;
1.801 tempelho 7762: color:$fontmenu;
1.507 raeburn 7763: background-color: $data_table_head;
1.701 harmsja 7764: font-size: small;
1.507 raeburn 7765: border-bottom: 1px solid #000000;
7766: }
1.795 www 7767:
1.507 raeburn 7768: table.LC_nested_outer tr td.LC_subheader {
7769: background-color: $data_table_head;
7770: font-weight: bold;
7771: font-size: small;
7772: border-bottom: 1px solid #000000;
7773: text-align: right;
1.451 albertel 7774: }
1.795 www 7775:
1.507 raeburn 7776: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7777: background-color: #CCCCCC;
1.451 albertel 7778: font-weight: bold;
7779: font-size: small;
1.507 raeburn 7780: text-align: center;
7781: }
1.795 www 7782:
1.589 raeburn 7783: table.LC_nested tr.LC_info_row td.LC_left_item,
7784: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7785: text-align: left;
1.451 albertel 7786: }
1.795 www 7787:
1.507 raeburn 7788: table.LC_nested td {
1.735 bisitz 7789: background-color: #FFFFFF;
1.451 albertel 7790: font-size: small;
1.507 raeburn 7791: }
1.795 www 7792:
1.507 raeburn 7793: table.LC_nested_outer tr th.LC_right_item,
7794: table.LC_nested tr.LC_info_row td.LC_right_item,
7795: table.LC_nested tr.LC_odd_row td.LC_right_item,
7796: table.LC_nested tr td.LC_right_item {
1.451 albertel 7797: text-align: right;
7798: }
7799:
1.507 raeburn 7800: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7801: background-color: #EEEEEE;
1.451 albertel 7802: }
7803:
1.473 raeburn 7804: table.LC_createuser {
7805: }
7806:
7807: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7808: font-size: small;
1.473 raeburn 7809: }
7810:
7811: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7812: background-color: #CCCCCC;
1.473 raeburn 7813: font-weight: bold;
7814: text-align: center;
7815: }
7816:
1.349 albertel 7817: table.LC_calendar {
7818: border: 1px solid #000000;
7819: border-collapse: collapse;
1.917 raeburn 7820: width: 98%;
1.349 albertel 7821: }
1.795 www 7822:
1.349 albertel 7823: table.LC_calendar_pickdate {
7824: font-size: xx-small;
7825: }
1.795 www 7826:
1.349 albertel 7827: table.LC_calendar tr td {
7828: border: 1px solid #000000;
7829: vertical-align: top;
1.917 raeburn 7830: width: 14%;
1.349 albertel 7831: }
1.795 www 7832:
1.349 albertel 7833: table.LC_calendar tr td.LC_calendar_day_empty {
7834: background-color: $data_table_dark;
7835: }
1.795 www 7836:
1.779 bisitz 7837: table.LC_calendar tr td.LC_calendar_day_current {
7838: background-color: $data_table_highlight;
1.777 tempelho 7839: }
1.795 www 7840:
1.938 bisitz 7841: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7842: background-color: $mail_new;
7843: }
1.795 www 7844:
1.938 bisitz 7845: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7846: background-color: $mail_new_hover;
7847: }
1.795 www 7848:
1.938 bisitz 7849: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7850: background-color: $mail_read;
7851: }
1.795 www 7852:
1.938 bisitz 7853: /*
7854: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7855: background-color: $mail_read_hover;
7856: }
1.938 bisitz 7857: */
1.795 www 7858:
1.938 bisitz 7859: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7860: background-color: $mail_replied;
7861: }
1.795 www 7862:
1.938 bisitz 7863: /*
7864: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7865: background-color: $mail_replied_hover;
7866: }
1.938 bisitz 7867: */
1.795 www 7868:
1.938 bisitz 7869: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7870: background-color: $mail_other;
7871: }
1.795 www 7872:
1.938 bisitz 7873: /*
7874: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7875: background-color: $mail_other_hover;
7876: }
1.938 bisitz 7877: */
1.494 raeburn 7878:
1.777 tempelho 7879: table.LC_data_table tr > td.LC_browser_file,
7880: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7881: background: #AAEE77;
1.389 albertel 7882: }
1.795 www 7883:
1.777 tempelho 7884: table.LC_data_table tr > td.LC_browser_file_locked,
7885: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7886: background: #FFAA99;
1.387 albertel 7887: }
1.795 www 7888:
1.777 tempelho 7889: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7890: background: #888888;
1.779 bisitz 7891: }
1.795 www 7892:
1.777 tempelho 7893: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7894: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7895: background: #F8F866;
1.777 tempelho 7896: }
1.795 www 7897:
1.696 bisitz 7898: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7899: background: #E0E8FF;
1.387 albertel 7900: }
1.696 bisitz 7901:
1.707 bisitz 7902: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7903: /* background: #77FF77; */
1.707 bisitz 7904: }
1.795 www 7905:
1.707 bisitz 7906: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7907: border-right: 8px solid #FFFF77;
1.707 bisitz 7908: }
1.795 www 7909:
1.707 bisitz 7910: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7911: border-right: 8px solid #FFAA77;
1.707 bisitz 7912: }
1.795 www 7913:
1.707 bisitz 7914: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7915: border-right: 8px solid #FF7777;
1.707 bisitz 7916: }
1.795 www 7917:
1.707 bisitz 7918: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7919: border-right: 8px solid #AAFF77;
1.707 bisitz 7920: }
1.795 www 7921:
1.707 bisitz 7922: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7923: border-right: 8px solid #11CC55;
1.707 bisitz 7924: }
7925:
1.388 albertel 7926: span.LC_current_location {
1.701 harmsja 7927: font-size:larger;
1.388 albertel 7928: background: $pgbg;
7929: }
1.387 albertel 7930:
1.1029 www 7931: span.LC_current_nav_location {
7932: font-weight:bold;
7933: background: $sidebg;
7934: }
7935:
1.395 albertel 7936: span.LC_parm_menu_item {
7937: font-size: larger;
7938: }
1.795 www 7939:
1.395 albertel 7940: span.LC_parm_scope_all {
7941: color: red;
7942: }
1.795 www 7943:
1.395 albertel 7944: span.LC_parm_scope_folder {
7945: color: green;
7946: }
1.795 www 7947:
1.395 albertel 7948: span.LC_parm_scope_resource {
7949: color: orange;
7950: }
1.795 www 7951:
1.395 albertel 7952: span.LC_parm_part {
7953: color: blue;
7954: }
1.795 www 7955:
1.911 bisitz 7956: span.LC_parm_folder,
7957: span.LC_parm_symb {
1.395 albertel 7958: font-size: x-small;
7959: font-family: $mono;
7960: color: #AAAAAA;
7961: }
7962:
1.977 bisitz 7963: ul.LC_parm_parmlist li {
7964: display: inline-block;
7965: padding: 0.3em 0.8em;
7966: vertical-align: top;
7967: width: 150px;
7968: border-top:1px solid $lg_border_color;
7969: }
7970:
1.795 www 7971: td.LC_parm_overview_level_menu,
7972: td.LC_parm_overview_map_menu,
7973: td.LC_parm_overview_parm_selectors,
7974: td.LC_parm_overview_restrictions {
1.396 albertel 7975: border: 1px solid black;
7976: border-collapse: collapse;
7977: }
1.795 www 7978:
1.1285 raeburn 7979: span.LC_parm_recursive,
7980: td.LC_parm_recursive {
7981: font-weight: bold;
7982: font-size: smaller;
7983: }
7984:
1.396 albertel 7985: table.LC_parm_overview_restrictions td {
7986: border-width: 1px 4px 1px 4px;
7987: border-style: solid;
7988: border-color: $pgbg;
7989: text-align: center;
7990: }
1.795 www 7991:
1.396 albertel 7992: table.LC_parm_overview_restrictions th {
7993: background: $tabbg;
7994: border-width: 1px 4px 1px 4px;
7995: border-style: solid;
7996: border-color: $pgbg;
7997: }
1.795 www 7998:
1.398 albertel 7999: table#LC_helpmenu {
1.803 bisitz 8000: border: none;
1.398 albertel 8001: height: 55px;
1.803 bisitz 8002: border-spacing: 0;
1.398 albertel 8003: }
8004:
8005: table#LC_helpmenu fieldset legend {
8006: font-size: larger;
8007: }
1.795 www 8008:
1.397 albertel 8009: table#LC_helpmenu_links {
8010: width: 100%;
8011: border: 1px solid black;
8012: background: $pgbg;
1.803 bisitz 8013: padding: 0;
1.397 albertel 8014: border-spacing: 1px;
8015: }
1.795 www 8016:
1.397 albertel 8017: table#LC_helpmenu_links tr td {
8018: padding: 1px;
8019: background: $tabbg;
1.399 albertel 8020: text-align: center;
8021: font-weight: bold;
1.397 albertel 8022: }
1.396 albertel 8023:
1.795 www 8024: table#LC_helpmenu_links a:link,
8025: table#LC_helpmenu_links a:visited,
1.397 albertel 8026: table#LC_helpmenu_links a:active {
8027: text-decoration: none;
8028: color: $font;
8029: }
1.795 www 8030:
1.397 albertel 8031: table#LC_helpmenu_links a:hover {
8032: text-decoration: underline;
8033: color: $vlink;
8034: }
1.396 albertel 8035:
1.417 albertel 8036: .LC_chrt_popup_exists {
8037: border: 1px solid #339933;
8038: margin: -1px;
8039: }
1.795 www 8040:
1.417 albertel 8041: .LC_chrt_popup_up {
8042: border: 1px solid yellow;
8043: margin: -1px;
8044: }
1.795 www 8045:
1.417 albertel 8046: .LC_chrt_popup {
8047: border: 1px solid #8888FF;
8048: background: #CCCCFF;
8049: }
1.795 www 8050:
1.421 albertel 8051: table.LC_pick_box {
8052: border-collapse: separate;
8053: background: white;
8054: border: 1px solid black;
8055: border-spacing: 1px;
8056: }
1.795 www 8057:
1.1454 ! raeburn 8058: table.LC_pick_box th.LC_pick_box_title {
1.850 bisitz 8059: background: $sidebg;
1.421 albertel 8060: font-weight: bold;
1.900 bisitz 8061: text-align: left;
1.740 bisitz 8062: vertical-align: top;
1.421 albertel 8063: width: 184px;
8064: padding: 8px;
8065: }
1.795 www 8066:
1.579 raeburn 8067: table.LC_pick_box td.LC_pick_box_value {
8068: text-align: left;
8069: padding: 8px;
8070: }
1.795 www 8071:
1.579 raeburn 8072: table.LC_pick_box td.LC_pick_box_select {
8073: text-align: left;
8074: padding: 8px;
8075: }
1.795 www 8076:
1.424 albertel 8077: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8078: padding: 0;
1.421 albertel 8079: height: 1px;
8080: background: black;
8081: }
1.795 www 8082:
1.421 albertel 8083: table.LC_pick_box td.LC_pick_box_submit {
8084: text-align: right;
8085: }
1.795 www 8086:
1.579 raeburn 8087: table.LC_pick_box td.LC_evenrow_value {
8088: text-align: left;
8089: padding: 8px;
8090: background-color: $data_table_light;
8091: }
1.795 www 8092:
1.579 raeburn 8093: table.LC_pick_box td.LC_oddrow_value {
8094: text-align: left;
8095: padding: 8px;
8096: background-color: $data_table_light;
8097: }
1.795 www 8098:
1.579 raeburn 8099: span.LC_helpform_receipt_cat {
8100: font-weight: bold;
8101: }
1.795 www 8102:
1.424 albertel 8103: table.LC_group_priv_box {
8104: background: white;
8105: border: 1px solid black;
8106: border-spacing: 1px;
8107: }
1.795 www 8108:
1.424 albertel 8109: table.LC_group_priv_box td.LC_pick_box_title {
8110: background: $tabbg;
8111: font-weight: bold;
8112: text-align: right;
8113: width: 184px;
8114: }
1.795 www 8115:
1.424 albertel 8116: table.LC_group_priv_box td.LC_groups_fixed {
8117: background: $data_table_light;
8118: text-align: center;
8119: }
1.795 www 8120:
1.424 albertel 8121: table.LC_group_priv_box td.LC_groups_optional {
8122: background: $data_table_dark;
8123: text-align: center;
8124: }
1.795 www 8125:
1.424 albertel 8126: table.LC_group_priv_box td.LC_groups_functionality {
8127: background: $data_table_darker;
8128: text-align: center;
8129: font-weight: bold;
8130: }
1.795 www 8131:
1.424 albertel 8132: table.LC_group_priv td {
8133: text-align: left;
1.803 bisitz 8134: padding: 0;
1.424 albertel 8135: }
8136:
8137: .LC_navbuttons {
8138: margin: 2ex 0ex 2ex 0ex;
8139: }
1.795 www 8140:
1.423 albertel 8141: .LC_topic_bar {
8142: font-weight: bold;
8143: background: $tabbg;
1.918 wenzelju 8144: margin: 1em 0em 1em 2em;
1.805 bisitz 8145: padding: 3px;
1.918 wenzelju 8146: font-size: 1.2em;
1.423 albertel 8147: }
1.795 www 8148:
1.423 albertel 8149: .LC_topic_bar span {
1.918 wenzelju 8150: left: 0.5em;
8151: position: absolute;
1.423 albertel 8152: vertical-align: middle;
1.918 wenzelju 8153: font-size: 1.2em;
1.423 albertel 8154: }
1.795 www 8155:
1.423 albertel 8156: table.LC_course_group_status {
8157: margin: 20px;
8158: }
1.795 www 8159:
1.423 albertel 8160: table.LC_status_selector td {
8161: vertical-align: top;
8162: text-align: center;
1.424 albertel 8163: padding: 4px;
8164: }
1.795 www 8165:
1.599 albertel 8166: div.LC_feedback_link {
1.616 albertel 8167: clear: both;
1.829 kalberla 8168: background: $sidebg;
1.779 bisitz 8169: width: 100%;
1.829 kalberla 8170: padding-bottom: 10px;
8171: border: 1px $tabbg solid;
1.833 kalberla 8172: height: 22px;
8173: line-height: 22px;
8174: padding-top: 5px;
8175: }
8176:
8177: div.LC_feedback_link img {
8178: height: 22px;
1.867 kalberla 8179: vertical-align:middle;
1.829 kalberla 8180: }
8181:
1.911 bisitz 8182: div.LC_feedback_link a {
1.829 kalberla 8183: text-decoration: none;
1.489 raeburn 8184: }
1.795 www 8185:
1.867 kalberla 8186: div.LC_comblock {
1.911 bisitz 8187: display:inline;
1.867 kalberla 8188: color:$font;
8189: font-size:90%;
8190: }
8191:
8192: div.LC_feedback_link div.LC_comblock {
8193: padding-left:5px;
8194: }
8195:
8196: div.LC_feedback_link div.LC_comblock a {
8197: color:$font;
8198: }
8199:
1.489 raeburn 8200: span.LC_feedback_link {
1.858 bisitz 8201: /* background: $feedback_link_bg; */
1.599 albertel 8202: font-size: larger;
8203: }
1.795 www 8204:
1.599 albertel 8205: span.LC_message_link {
1.858 bisitz 8206: /* background: $feedback_link_bg; */
1.599 albertel 8207: font-size: larger;
8208: position: absolute;
8209: right: 1em;
1.489 raeburn 8210: }
1.421 albertel 8211:
1.515 albertel 8212: table.LC_prior_tries {
1.524 albertel 8213: border: 1px solid #000000;
8214: border-collapse: separate;
8215: border-spacing: 1px;
1.515 albertel 8216: }
1.523 albertel 8217:
1.515 albertel 8218: table.LC_prior_tries td {
1.524 albertel 8219: padding: 2px;
1.515 albertel 8220: }
1.523 albertel 8221:
8222: .LC_answer_correct {
1.795 www 8223: background: lightgreen;
8224: color: darkgreen;
8225: padding: 6px;
1.523 albertel 8226: }
1.795 www 8227:
1.523 albertel 8228: .LC_answer_charged_try {
1.797 www 8229: background: #FFAAAA;
1.795 www 8230: color: darkred;
8231: padding: 6px;
1.523 albertel 8232: }
1.795 www 8233:
1.779 bisitz 8234: .LC_answer_not_charged_try,
1.523 albertel 8235: .LC_answer_no_grade,
8236: .LC_answer_late {
1.795 www 8237: background: lightyellow;
1.523 albertel 8238: color: black;
1.795 www 8239: padding: 6px;
1.523 albertel 8240: }
1.795 www 8241:
1.523 albertel 8242: .LC_answer_previous {
1.795 www 8243: background: lightblue;
8244: color: darkblue;
8245: padding: 6px;
1.523 albertel 8246: }
1.795 www 8247:
1.779 bisitz 8248: .LC_answer_no_message {
1.777 tempelho 8249: background: #FFFFFF;
8250: color: black;
1.795 www 8251: padding: 6px;
1.779 bisitz 8252: }
1.795 www 8253:
1.1334 raeburn 8254: .LC_answer_unknown,
8255: .LC_answer_warning {
1.779 bisitz 8256: background: orange;
8257: color: black;
1.795 www 8258: padding: 6px;
1.777 tempelho 8259: }
1.795 www 8260:
1.1446 raeburn 8261: .LC_prob_status {
1.1447 raeburn 8262: margin-top: 5px;
1.1446 raeburn 8263: padding-top: 0;
8264: padding-left: 0;
8265: padding-bottom: 0;
8266: padding-right: 5px;
8267: }
8268:
1.1448 raeburn 8269: .LC_mail_actions {
8270: float: left;
8271: padding: 0;
8272: margin: 6px;
8273: }
8274:
8275: .LC_vertical_line {
8276: width: 1px;
8277: background-color: black;
8278: height: 4em;
8279: float: left;
8280: margin: 0;
8281: padding: 0;
8282: }
8283:
1.529 albertel 8284: span.LC_prior_numerical,
8285: span.LC_prior_string,
8286: span.LC_prior_custom,
8287: span.LC_prior_reaction,
8288: span.LC_prior_math {
1.925 bisitz 8289: font-family: $mono;
1.523 albertel 8290: white-space: pre;
8291: }
8292:
1.525 albertel 8293: span.LC_prior_string {
1.925 bisitz 8294: font-family: $mono;
1.525 albertel 8295: white-space: pre;
8296: }
8297:
1.523 albertel 8298: table.LC_prior_option {
8299: width: 100%;
8300: border-collapse: collapse;
8301: }
1.795 www 8302:
1.911 bisitz 8303: table.LC_prior_rank,
1.795 www 8304: table.LC_prior_match {
1.528 albertel 8305: border-collapse: collapse;
8306: }
1.795 www 8307:
1.528 albertel 8308: table.LC_prior_option tr td,
8309: table.LC_prior_rank tr td,
8310: table.LC_prior_match tr td {
1.524 albertel 8311: border: 1px solid #000000;
1.515 albertel 8312: }
8313:
1.855 bisitz 8314: .LC_nobreak {
1.544 albertel 8315: white-space: nowrap;
1.519 raeburn 8316: }
8317:
1.576 raeburn 8318: span.LC_cusr_emph {
8319: font-style: italic;
8320: }
8321:
1.633 raeburn 8322: span.LC_cusr_subheading {
8323: font-weight: normal;
8324: font-size: 85%;
8325: }
8326:
1.861 bisitz 8327: div.LC_docs_entry_move {
1.859 bisitz 8328: border: 1px solid #BBBBBB;
1.545 albertel 8329: background: #DDDDDD;
1.861 bisitz 8330: width: 22px;
1.859 bisitz 8331: padding: 1px;
8332: margin: 0;
1.545 albertel 8333: }
8334:
1.861 bisitz 8335: table.LC_data_table tr > td.LC_docs_entry_commands,
8336: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8337: font-size: x-small;
8338: }
1.795 www 8339:
1.861 bisitz 8340: .LC_docs_entry_parameter {
8341: white-space: nowrap;
8342: }
8343:
1.544 albertel 8344: .LC_docs_copy {
1.545 albertel 8345: color: #000099;
1.544 albertel 8346: }
1.795 www 8347:
1.544 albertel 8348: .LC_docs_cut {
1.545 albertel 8349: color: #550044;
1.544 albertel 8350: }
1.795 www 8351:
1.544 albertel 8352: .LC_docs_rename {
1.545 albertel 8353: color: #009900;
1.544 albertel 8354: }
1.795 www 8355:
1.544 albertel 8356: .LC_docs_remove {
1.545 albertel 8357: color: #990000;
8358: }
8359:
1.1284 raeburn 8360: .LC_docs_alias {
8361: color: #440055;
8362: }
8363:
1.1286 raeburn 8364: .LC_domprefs_email,
1.1284 raeburn 8365: .LC_docs_alias_name,
1.547 albertel 8366: .LC_docs_reinit_warn,
8367: .LC_docs_ext_edit {
8368: font-size: x-small;
8369: }
8370:
1.545 albertel 8371: table.LC_docs_adddocs td,
8372: table.LC_docs_adddocs th {
8373: border: 1px solid #BBBBBB;
8374: padding: 4px;
8375: background: #DDDDDD;
1.543 albertel 8376: }
8377:
1.584 albertel 8378: table.LC_sty_begin {
8379: background: #BBFFBB;
8380: }
1.795 www 8381:
1.584 albertel 8382: table.LC_sty_end {
8383: background: #FFBBBB;
8384: }
8385:
1.589 raeburn 8386: table.LC_double_column {
1.803 bisitz 8387: border-width: 0;
1.589 raeburn 8388: border-collapse: collapse;
8389: width: 100%;
8390: padding: 2px;
8391: }
8392:
8393: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8394: top: 2px;
1.589 raeburn 8395: left: 2px;
8396: width: 47%;
8397: vertical-align: top;
8398: }
8399:
8400: table.LC_double_column tr td.LC_right_col {
8401: top: 2px;
1.779 bisitz 8402: right: 2px;
1.589 raeburn 8403: width: 47%;
8404: vertical-align: top;
8405: }
8406:
1.591 raeburn 8407: div.LC_left_float {
8408: float: left;
8409: padding-right: 5%;
1.597 albertel 8410: padding-bottom: 4px;
1.591 raeburn 8411: }
8412:
8413: div.LC_clear_float_header {
1.597 albertel 8414: padding-bottom: 2px;
1.591 raeburn 8415: }
8416:
8417: div.LC_clear_float_footer {
1.597 albertel 8418: padding-top: 10px;
1.591 raeburn 8419: clear: both;
8420: }
8421:
1.597 albertel 8422: div.LC_grade_show_user {
1.941 bisitz 8423: /* border-left: 5px solid $sidebg; */
8424: border-top: 5px solid #000000;
8425: margin: 50px 0 0 0;
1.936 bisitz 8426: padding: 15px 0 5px 10px;
1.597 albertel 8427: }
1.795 www 8428:
1.936 bisitz 8429: div.LC_grade_show_user_odd_row {
1.941 bisitz 8430: /* border-left: 5px solid #000000; */
8431: }
8432:
8433: div.LC_grade_show_user div.LC_Box {
8434: margin-right: 50px;
1.597 albertel 8435: }
8436:
8437: div.LC_grade_submissions,
8438: div.LC_grade_message_center,
1.936 bisitz 8439: div.LC_grade_info_links {
1.597 albertel 8440: margin: 5px;
8441: width: 99%;
8442: background: #FFFFFF;
8443: }
1.795 www 8444:
1.597 albertel 8445: div.LC_grade_submissions_header,
1.936 bisitz 8446: div.LC_grade_message_center_header {
1.705 tempelho 8447: font-weight: bold;
8448: font-size: large;
1.597 albertel 8449: }
1.795 www 8450:
1.597 albertel 8451: div.LC_grade_submissions_body,
1.936 bisitz 8452: div.LC_grade_message_center_body {
1.597 albertel 8453: border: 1px solid black;
8454: width: 99%;
8455: background: #FFFFFF;
8456: }
1.795 www 8457:
1.613 albertel 8458: table.LC_scantron_action {
8459: width: 100%;
8460: }
1.795 www 8461:
1.613 albertel 8462: table.LC_scantron_action tr th {
1.698 harmsja 8463: font-weight:bold;
8464: font-style:normal;
1.613 albertel 8465: }
1.795 www 8466:
1.779 bisitz 8467: .LC_edit_problem_header,
1.614 albertel 8468: div.LC_edit_problem_footer {
1.705 tempelho 8469: font-weight: normal;
8470: font-size: medium;
1.602 albertel 8471: margin: 2px;
1.1060 bisitz 8472: background-color: $sidebg;
1.600 albertel 8473: }
1.795 www 8474:
1.600 albertel 8475: div.LC_edit_problem_header,
1.602 albertel 8476: div.LC_edit_problem_header div,
1.614 albertel 8477: div.LC_edit_problem_footer,
8478: div.LC_edit_problem_footer div,
1.602 albertel 8479: div.LC_edit_problem_editxml_header,
8480: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8481: z-index: 100;
1.600 albertel 8482: }
1.795 www 8483:
1.600 albertel 8484: div.LC_edit_problem_header_title {
1.705 tempelho 8485: font-weight: bold;
8486: font-size: larger;
1.602 albertel 8487: background: $tabbg;
8488: padding: 3px;
1.1060 bisitz 8489: margin: 0 0 5px 0;
1.602 albertel 8490: }
1.795 www 8491:
1.602 albertel 8492: table.LC_edit_problem_header_title {
8493: width: 100%;
1.600 albertel 8494: background: $tabbg;
1.602 albertel 8495: }
8496:
1.1205 golterma 8497: div.LC_edit_actionbar {
8498: background-color: $sidebg;
1.1218 droeschl 8499: margin: 0;
8500: padding: 0;
8501: line-height: 200%;
1.602 albertel 8502: }
1.795 www 8503:
1.1218 droeschl 8504: div.LC_edit_actionbar div{
8505: padding: 0;
8506: margin: 0;
8507: display: inline-block;
1.600 albertel 8508: }
1.795 www 8509:
1.1124 bisitz 8510: .LC_edit_opt {
8511: padding-left: 1em;
8512: white-space: nowrap;
8513: }
8514:
1.1152 golterma 8515: .LC_edit_problem_latexhelper{
8516: text-align: right;
8517: }
8518:
8519: #LC_edit_problem_colorful div{
8520: margin-left: 40px;
8521: }
8522:
1.1205 golterma 8523: #LC_edit_problem_codemirror div{
8524: margin-left: 0px;
8525: }
8526:
1.911 bisitz 8527: img.stift {
1.803 bisitz 8528: border-width: 0;
8529: vertical-align: middle;
1.677 riegler 8530: }
1.680 riegler 8531:
1.923 bisitz 8532: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8533: vertical-align: top;
1.777 tempelho 8534: }
1.795 www 8535:
1.716 raeburn 8536: div.LC_createcourse {
1.911 bisitz 8537: margin: 10px 10px 10px 10px;
1.716 raeburn 8538: }
8539:
1.917 raeburn 8540: .LC_dccid {
1.1130 raeburn 8541: float: right;
1.917 raeburn 8542: margin: 0.2em 0 0 0;
8543: padding: 0;
8544: font-size: 90%;
8545: display:none;
8546: }
8547:
1.897 wenzelju 8548: ol.LC_primary_menu a:hover,
1.721 harmsja 8549: ol#LC_MenuBreadcrumbs a:hover,
8550: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8551: ul#LC_secondary_menu a:hover,
1.721 harmsja 8552: .LC_FormSectionClearButton input:hover
1.795 www 8553: ul.LC_TabContent li:hover a {
1.952 onken 8554: color:$button_hover;
1.911 bisitz 8555: text-decoration:none;
1.693 droeschl 8556: }
8557:
1.779 bisitz 8558: h1 {
1.911 bisitz 8559: padding: 0;
8560: line-height:130%;
1.693 droeschl 8561: }
1.698 harmsja 8562:
1.911 bisitz 8563: h2,
8564: h3,
8565: h4,
8566: h5,
8567: h6 {
8568: margin: 5px 0 5px 0;
8569: padding: 0;
8570: line-height:130%;
1.693 droeschl 8571: }
1.795 www 8572:
8573: .LC_hcell {
1.911 bisitz 8574: padding:3px 15px 3px 15px;
8575: margin: 0;
8576: background-color:$tabbg;
8577: color:$fontmenu;
8578: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8579: }
1.795 www 8580:
1.840 bisitz 8581: .LC_Box > .LC_hcell {
1.911 bisitz 8582: margin: 0 -10px 10px -10px;
1.835 bisitz 8583: }
8584:
1.721 harmsja 8585: .LC_noBorder {
1.911 bisitz 8586: border: 0;
1.698 harmsja 8587: }
1.693 droeschl 8588:
1.721 harmsja 8589: .LC_FormSectionClearButton input {
1.911 bisitz 8590: background-color:transparent;
8591: border: none;
8592: cursor:pointer;
8593: text-decoration:underline;
1.693 droeschl 8594: }
1.763 bisitz 8595:
8596: .LC_help_open_topic {
1.911 bisitz 8597: color: #FFFFFF;
8598: background-color: #EEEEFF;
8599: margin: 1px;
8600: padding: 4px;
8601: border: 1px solid #000033;
8602: white-space: nowrap;
8603: /* vertical-align: middle; */
1.759 neumanie 8604: }
1.693 droeschl 8605:
1.911 bisitz 8606: dl,
8607: ul,
8608: div,
8609: fieldset {
8610: margin: 10px 10px 10px 0;
8611: /* overflow: hidden; */
1.693 droeschl 8612: }
1.795 www 8613:
1.1404 raeburn 8614: fieldset#LC_selectuser {
8615: margin: 0;
8616: padding: 0;
8617: }
8618:
1.1211 raeburn 8619: article.geogebraweb div {
8620: margin: 0;
8621: }
8622:
1.838 bisitz 8623: fieldset > legend {
1.911 bisitz 8624: font-weight: bold;
8625: padding: 0 5px 0 5px;
1.838 bisitz 8626: }
8627:
1.813 bisitz 8628: #LC_nav_bar {
1.911 bisitz 8629: float: left;
1.995 raeburn 8630: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8631: margin: 0 0 2px 0;
1.807 droeschl 8632: }
8633:
1.916 droeschl 8634: #LC_realm {
8635: margin: 0.2em 0 0 0;
8636: padding: 0;
8637: font-weight: bold;
8638: text-align: center;
1.995 raeburn 8639: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8640: }
8641:
1.911 bisitz 8642: #LC_nav_bar em {
8643: font-weight: bold;
8644: font-style: normal;
1.807 droeschl 8645: }
8646:
1.897 wenzelju 8647: ol.LC_primary_menu {
1.934 droeschl 8648: margin: 0;
1.1076 raeburn 8649: padding: 0;
1.807 droeschl 8650: }
8651:
1.852 droeschl 8652: ol#LC_PathBreadcrumbs {
1.911 bisitz 8653: margin: 0;
1.693 droeschl 8654: }
8655:
1.897 wenzelju 8656: ol.LC_primary_menu li {
1.1076 raeburn 8657: color: RGB(80, 80, 80);
8658: vertical-align: middle;
8659: text-align: left;
8660: list-style: none;
1.1205 golterma 8661: position: relative;
1.1076 raeburn 8662: float: left;
1.1205 golterma 8663: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8664: line-height: 1.5em;
1.1076 raeburn 8665: }
8666:
1.1205 golterma 8667: ol.LC_primary_menu li a,
8668: ol.LC_primary_menu li p {
1.1076 raeburn 8669: display: block;
8670: margin: 0;
8671: padding: 0 5px 0 10px;
8672: text-decoration: none;
8673: }
8674:
1.1205 golterma 8675: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8676: display: inline-block;
8677: width: 95%;
8678: text-align: left;
8679: }
8680:
8681: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8682: display: inline-block;
8683: width: 5%;
8684: float: right;
8685: text-align: right;
8686: font-size: 70%;
8687: }
8688:
8689: ol.LC_primary_menu ul {
1.1076 raeburn 8690: display: none;
1.1205 golterma 8691: width: 15em;
1.1076 raeburn 8692: background-color: $data_table_light;
1.1205 golterma 8693: position: absolute;
8694: top: 100%;
1.1076 raeburn 8695: }
8696:
1.1205 golterma 8697: ol.LC_primary_menu ul ul {
8698: left: 100%;
8699: top: 0;
8700: }
8701:
8702: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8703: display: block;
8704: position: absolute;
8705: margin: 0;
8706: padding: 0;
1.1078 raeburn 8707: z-index: 2;
1.1076 raeburn 8708: }
8709:
8710: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8711: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8712: font-size: 90%;
1.911 bisitz 8713: vertical-align: top;
1.1076 raeburn 8714: float: none;
1.1079 raeburn 8715: border-left: 1px solid black;
8716: border-right: 1px solid black;
1.1205 golterma 8717: /* A dark bottom border to visualize different menu options;
8718: overwritten in the create_submenu routine for the last border-bottom of the menu */
8719: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8720: }
8721:
1.1205 golterma 8722: ol.LC_primary_menu li li p:hover {
8723: color:$button_hover;
8724: text-decoration:none;
8725: background-color:$data_table_dark;
1.1076 raeburn 8726: }
8727:
8728: ol.LC_primary_menu li li a:hover {
8729: color:$button_hover;
8730: background-color:$data_table_dark;
1.693 droeschl 8731: }
8732:
1.1205 golterma 8733: /* Font-size equal to the size of the predecessors*/
8734: ol.LC_primary_menu li:hover li li {
8735: font-size: 100%;
8736: }
8737:
1.897 wenzelju 8738: ol.LC_primary_menu li img {
1.911 bisitz 8739: vertical-align: bottom;
1.934 droeschl 8740: height: 1.1em;
1.1077 raeburn 8741: margin: 0.2em 0 0 0;
1.693 droeschl 8742: }
8743:
1.897 wenzelju 8744: ol.LC_primary_menu a {
1.911 bisitz 8745: color: RGB(80, 80, 80);
8746: text-decoration: none;
1.693 droeschl 8747: }
1.795 www 8748:
1.949 droeschl 8749: ol.LC_primary_menu a.LC_new_message {
8750: font-weight:bold;
8751: color: darkred;
8752: }
8753:
1.975 raeburn 8754: ol.LC_docs_parameters {
8755: margin-left: 0;
8756: padding: 0;
8757: list-style: none;
8758: }
8759:
8760: ol.LC_docs_parameters li {
8761: margin: 0;
8762: padding-right: 20px;
8763: display: inline;
8764: }
8765:
1.976 raeburn 8766: ol.LC_docs_parameters li:before {
8767: content: "\\002022 \\0020";
8768: }
8769:
8770: li.LC_docs_parameters_title {
8771: font-weight: bold;
8772: }
8773:
8774: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8775: content: "";
8776: }
8777:
1.897 wenzelju 8778: ul#LC_secondary_menu {
1.1107 raeburn 8779: clear: right;
1.911 bisitz 8780: color: $fontmenu;
8781: background: $tabbg;
8782: list-style: none;
8783: padding: 0;
8784: margin: 0;
8785: width: 100%;
1.995 raeburn 8786: text-align: left;
1.1107 raeburn 8787: float: left;
1.808 droeschl 8788: }
8789:
1.897 wenzelju 8790: ul#LC_secondary_menu li {
1.911 bisitz 8791: font-weight: bold;
8792: line-height: 1.8em;
1.1107 raeburn 8793: border-right: 1px solid black;
8794: float: left;
8795: }
8796:
8797: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8798: background-color: $data_table_light;
8799: }
8800:
8801: ul#LC_secondary_menu li a {
1.911 bisitz 8802: padding: 0 0.8em;
1.1107 raeburn 8803: }
8804:
8805: ul#LC_secondary_menu li ul {
8806: display: none;
8807: }
8808:
8809: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8810: display: block;
8811: position: absolute;
8812: margin: 0;
8813: padding: 0;
8814: list-style:none;
8815: float: none;
8816: background-color: $data_table_light;
8817: z-index: 2;
8818: margin-left: -1px;
8819: }
8820:
8821: ul#LC_secondary_menu li ul li {
8822: font-size: 90%;
8823: vertical-align: top;
8824: border-left: 1px solid black;
1.911 bisitz 8825: border-right: 1px solid black;
1.1119 raeburn 8826: background-color: $data_table_light;
1.1107 raeburn 8827: list-style:none;
8828: float: none;
8829: }
8830:
8831: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8832: background-color: $data_table_dark;
1.807 droeschl 8833: }
8834:
1.847 tempelho 8835: ul.LC_TabContent {
1.911 bisitz 8836: display:block;
8837: background: $sidebg;
8838: border-bottom: solid 1px $lg_border_color;
8839: list-style:none;
1.1020 raeburn 8840: margin: -1px -10px 0 -10px;
1.911 bisitz 8841: padding: 0;
1.693 droeschl 8842: }
8843:
1.795 www 8844: ul.LC_TabContent li,
8845: ul.LC_TabContentBigger li {
1.911 bisitz 8846: float:left;
1.741 harmsja 8847: }
1.795 www 8848:
1.897 wenzelju 8849: ul#LC_secondary_menu li a {
1.911 bisitz 8850: color: $fontmenu;
8851: text-decoration: none;
1.693 droeschl 8852: }
1.795 www 8853:
1.721 harmsja 8854: ul.LC_TabContent {
1.952 onken 8855: min-height:20px;
1.721 harmsja 8856: }
1.795 www 8857:
8858: ul.LC_TabContent li {
1.911 bisitz 8859: vertical-align:middle;
1.959 onken 8860: padding: 0 16px 0 10px;
1.911 bisitz 8861: background-color:$tabbg;
8862: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8863: border-left: solid 1px $font;
1.721 harmsja 8864: }
1.795 www 8865:
1.847 tempelho 8866: ul.LC_TabContent .right {
1.911 bisitz 8867: float:right;
1.847 tempelho 8868: }
8869:
1.911 bisitz 8870: ul.LC_TabContent li a,
8871: ul.LC_TabContent li {
8872: color:rgb(47,47,47);
8873: text-decoration:none;
8874: font-size:95%;
8875: font-weight:bold;
1.952 onken 8876: min-height:20px;
8877: }
8878:
1.959 onken 8879: ul.LC_TabContent li a:hover,
8880: ul.LC_TabContent li a:focus {
1.952 onken 8881: color: $button_hover;
1.959 onken 8882: background:none;
8883: outline:none;
1.952 onken 8884: }
8885:
8886: ul.LC_TabContent li:hover {
8887: color: $button_hover;
8888: cursor:pointer;
1.721 harmsja 8889: }
1.795 www 8890:
1.911 bisitz 8891: ul.LC_TabContent li.active {
1.952 onken 8892: color: $font;
1.911 bisitz 8893: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8894: border-bottom:solid 1px #FFFFFF;
8895: cursor: default;
1.744 ehlerst 8896: }
1.795 www 8897:
1.959 onken 8898: ul.LC_TabContent li.active a {
8899: color:$font;
8900: background:#FFFFFF;
8901: outline: none;
8902: }
1.1047 raeburn 8903:
8904: ul.LC_TabContent li.goback {
8905: float: left;
8906: border-left: none;
8907: }
8908:
1.870 tempelho 8909: #maincoursedoc {
1.911 bisitz 8910: clear:both;
1.870 tempelho 8911: }
8912:
8913: ul.LC_TabContentBigger {
1.911 bisitz 8914: display:block;
8915: list-style:none;
8916: padding: 0;
1.870 tempelho 8917: }
8918:
1.795 www 8919: ul.LC_TabContentBigger li {
1.911 bisitz 8920: vertical-align:bottom;
8921: height: 30px;
8922: font-size:110%;
8923: font-weight:bold;
8924: color: #737373;
1.841 tempelho 8925: }
8926:
1.957 onken 8927: ul.LC_TabContentBigger li.active {
8928: position: relative;
8929: top: 1px;
8930: }
8931:
1.870 tempelho 8932: ul.LC_TabContentBigger li a {
1.911 bisitz 8933: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8934: height: 30px;
8935: line-height: 30px;
8936: text-align: center;
8937: display: block;
8938: text-decoration: none;
1.958 onken 8939: outline: none;
1.741 harmsja 8940: }
1.795 www 8941:
1.870 tempelho 8942: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8943: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8944: color:$font;
1.744 ehlerst 8945: }
1.795 www 8946:
1.870 tempelho 8947: ul.LC_TabContentBigger li b {
1.911 bisitz 8948: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8949: display: block;
8950: float: left;
8951: padding: 0 30px;
1.957 onken 8952: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8953: }
8954:
1.956 onken 8955: ul.LC_TabContentBigger li:hover b {
8956: color:$button_hover;
8957: }
8958:
1.870 tempelho 8959: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8960: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8961: color:$font;
1.957 onken 8962: border: 0;
1.741 harmsja 8963: }
1.693 droeschl 8964:
1.870 tempelho 8965:
1.862 bisitz 8966: ul.LC_CourseBreadcrumbs {
8967: background: $sidebg;
1.1020 raeburn 8968: height: 2em;
1.862 bisitz 8969: padding-left: 10px;
1.1020 raeburn 8970: margin: 0;
1.862 bisitz 8971: list-style-position: inside;
8972: }
8973:
1.911 bisitz 8974: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8975: ol#LC_PathBreadcrumbs {
1.911 bisitz 8976: padding-left: 10px;
8977: margin: 0;
1.933 droeschl 8978: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8979: }
8980:
1.911 bisitz 8981: ol#LC_MenuBreadcrumbs li,
8982: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8983: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8984: display: inline;
1.933 droeschl 8985: white-space: normal;
1.693 droeschl 8986: }
8987:
1.823 bisitz 8988: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8989: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8990: text-decoration: none;
8991: font-size:90%;
1.693 droeschl 8992: }
1.795 www 8993:
1.969 droeschl 8994: ol#LC_MenuBreadcrumbs h1 {
8995: display: inline;
8996: font-size: 90%;
8997: line-height: 2.5em;
8998: margin: 0;
8999: padding: 0;
9000: }
9001:
1.795 www 9002: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 9003: text-decoration:none;
9004: font-size:100%;
9005: font-weight:bold;
1.693 droeschl 9006: }
1.795 www 9007:
1.840 bisitz 9008: .LC_Box {
1.911 bisitz 9009: border: solid 1px $lg_border_color;
9010: padding: 0 10px 10px 10px;
1.746 neumanie 9011: }
1.795 www 9012:
1.1020 raeburn 9013: .LC_DocsBox {
9014: border: solid 1px $lg_border_color;
9015: padding: 0 0 10px 10px;
9016: }
9017:
1.795 www 9018: .LC_AboutMe_Image {
1.911 bisitz 9019: float:left;
9020: margin-right:10px;
1.747 neumanie 9021: }
1.795 www 9022:
9023: .LC_Clear_AboutMe_Image {
1.911 bisitz 9024: clear:left;
1.747 neumanie 9025: }
1.795 www 9026:
1.721 harmsja 9027: dl.LC_ListStyleClean dt {
1.911 bisitz 9028: padding-right: 5px;
9029: display: table-header-group;
1.693 droeschl 9030: }
9031:
1.721 harmsja 9032: dl.LC_ListStyleClean dd {
1.911 bisitz 9033: display: table-row;
1.693 droeschl 9034: }
9035:
1.721 harmsja 9036: .LC_ListStyleClean,
9037: .LC_ListStyleSimple,
9038: .LC_ListStyleNormal,
1.795 www 9039: .LC_ListStyleSpecial {
1.911 bisitz 9040: /* display:block; */
9041: list-style-position: inside;
9042: list-style-type: none;
9043: overflow: hidden;
9044: padding: 0;
1.693 droeschl 9045: }
9046:
1.721 harmsja 9047: .LC_ListStyleSimple li,
9048: .LC_ListStyleSimple dd,
9049: .LC_ListStyleNormal li,
9050: .LC_ListStyleNormal dd,
9051: .LC_ListStyleSpecial li,
1.795 www 9052: .LC_ListStyleSpecial dd {
1.911 bisitz 9053: margin: 0;
9054: padding: 5px 5px 5px 10px;
9055: clear: both;
1.693 droeschl 9056: }
9057:
1.721 harmsja 9058: .LC_ListStyleClean li,
9059: .LC_ListStyleClean dd {
1.911 bisitz 9060: padding-top: 0;
9061: padding-bottom: 0;
1.693 droeschl 9062: }
9063:
1.721 harmsja 9064: .LC_ListStyleSimple dd,
1.795 www 9065: .LC_ListStyleSimple li {
1.911 bisitz 9066: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9067: }
9068:
1.721 harmsja 9069: .LC_ListStyleSpecial li,
9070: .LC_ListStyleSpecial dd {
1.911 bisitz 9071: list-style-type: none;
9072: background-color: RGB(220, 220, 220);
9073: margin-bottom: 4px;
1.693 droeschl 9074: }
9075:
1.721 harmsja 9076: table.LC_SimpleTable {
1.911 bisitz 9077: margin:5px;
9078: border:solid 1px $lg_border_color;
1.795 www 9079: }
1.693 droeschl 9080:
1.721 harmsja 9081: table.LC_SimpleTable tr {
1.911 bisitz 9082: padding: 0;
9083: border:solid 1px $lg_border_color;
1.693 droeschl 9084: }
1.795 www 9085:
9086: table.LC_SimpleTable thead {
1.911 bisitz 9087: background:rgb(220,220,220);
1.693 droeschl 9088: }
9089:
1.721 harmsja 9090: div.LC_columnSection {
1.911 bisitz 9091: display: block;
9092: clear: both;
9093: overflow: hidden;
9094: margin: 0;
1.693 droeschl 9095: }
9096:
1.721 harmsja 9097: div.LC_columnSection>* {
1.911 bisitz 9098: float: left;
9099: margin: 10px 20px 10px 0;
9100: overflow:hidden;
1.693 droeschl 9101: }
1.721 harmsja 9102:
1.795 www 9103: table em {
1.911 bisitz 9104: font-weight: bold;
9105: font-style: normal;
1.748 schulted 9106: }
1.795 www 9107:
1.779 bisitz 9108: table.LC_tableBrowseRes,
1.795 www 9109: table.LC_tableOfContent {
1.911 bisitz 9110: border:none;
9111: border-spacing: 1px;
9112: padding: 3px;
9113: background-color: #FFFFFF;
9114: font-size: 90%;
1.753 droeschl 9115: }
1.789 droeschl 9116:
1.911 bisitz 9117: table.LC_tableOfContent {
9118: border-collapse: collapse;
1.789 droeschl 9119: }
9120:
1.771 droeschl 9121: table.LC_tableBrowseRes a,
1.768 schulted 9122: table.LC_tableOfContent a {
1.911 bisitz 9123: background-color: transparent;
9124: text-decoration: none;
1.753 droeschl 9125: }
9126:
1.795 www 9127: table.LC_tableOfContent img {
1.911 bisitz 9128: border: none;
9129: height: 1.3em;
9130: vertical-align: text-bottom;
9131: margin-right: 0.3em;
1.753 droeschl 9132: }
1.757 schulted 9133:
1.795 www 9134: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9135: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9136: }
9137:
1.795 www 9138: a#LC_content_toolbar_everything {
1.911 bisitz 9139: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9140: }
9141:
1.795 www 9142: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9143: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9144: }
9145:
1.795 www 9146: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9147: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9148: }
9149:
1.795 www 9150: a#LC_content_toolbar_changefolder {
1.911 bisitz 9151: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9152: }
9153:
1.795 www 9154: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9155: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9156: }
9157:
1.1043 raeburn 9158: a#LC_content_toolbar_edittoplevel {
9159: background-image:url(/res/adm/pages/edittoplevel.gif);
9160: }
9161:
1.1384 raeburn 9162: a#LC_content_toolbar_printout {
9163: background-image:url(/res/adm/pages/printout.gif);
9164: }
9165:
1.795 www 9166: ul#LC_toolbar li a:hover {
1.911 bisitz 9167: background-position: bottom center;
1.757 schulted 9168: }
9169:
1.795 www 9170: ul#LC_toolbar {
1.911 bisitz 9171: padding: 0;
9172: margin: 2px;
9173: list-style:none;
1.1449 raeburn 9174: display:inline;
1.911 bisitz 9175: background-color:white;
1.1082 raeburn 9176: overflow: auto;
1.757 schulted 9177: }
9178:
1.795 www 9179: ul#LC_toolbar li {
1.911 bisitz 9180: border:1px solid white;
9181: padding: 0;
9182: margin: 0;
9183: float: left;
9184: display:inline;
9185: vertical-align:middle;
1.1082 raeburn 9186: white-space: nowrap;
1.911 bisitz 9187: }
1.757 schulted 9188:
1.783 amueller 9189:
1.795 www 9190: a.LC_toolbarItem {
1.911 bisitz 9191: display:block;
9192: padding: 0;
9193: margin: 0;
9194: height: 32px;
9195: width: 32px;
9196: color:white;
9197: border: none;
9198: background-repeat:no-repeat;
9199: background-color:transparent;
1.757 schulted 9200: }
9201:
1.1449 raeburn 9202: .LC_navtools {
9203: display: inline-block;
9204: padding: 0;
9205: margin: 2px;
9206: vertical-align: middle;
9207: }
9208:
1.915 droeschl 9209: ul.LC_funclist {
9210: margin: 0;
9211: padding: 0.5em 1em 0.5em 0;
9212: }
9213:
1.933 droeschl 9214: ul.LC_funclist > li:first-child {
9215: font-weight:bold;
9216: margin-left:0.8em;
9217: }
9218:
1.915 droeschl 9219: ul.LC_funclist + ul.LC_funclist {
9220: /*
9221: left border as a seperator if we have more than
9222: one list
9223: */
9224: border-left: 1px solid $sidebg;
9225: /*
9226: this hides the left border behind the border of the
9227: outer box if element is wrapped to the next 'line'
9228: */
9229: margin-left: -1px;
9230: }
9231:
1.843 bisitz 9232: ul.LC_funclist li {
1.915 droeschl 9233: display: inline;
1.782 bisitz 9234: white-space: nowrap;
1.915 droeschl 9235: margin: 0 0 0 25px;
9236: line-height: 150%;
1.782 bisitz 9237: }
9238:
1.974 wenzelju 9239: .LC_hidden {
9240: display: none;
9241: }
9242:
1.1030 www 9243: .LCmodal-overlay {
9244: position:fixed;
9245: top:0;
9246: right:0;
9247: bottom:0;
9248: left:0;
9249: height:100%;
9250: width:100%;
9251: margin:0;
9252: padding:0;
9253: background:#999;
9254: opacity:.75;
9255: filter: alpha(opacity=75);
9256: -moz-opacity: 0.75;
9257: z-index:101;
9258: }
9259:
9260: * html .LCmodal-overlay {
9261: position: absolute;
9262: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9263: }
9264:
9265: .LCmodal-window {
9266: position:fixed;
9267: top:50%;
9268: left:50%;
9269: margin:0;
9270: padding:0;
9271: z-index:102;
9272: }
9273:
9274: * html .LCmodal-window {
9275: position:absolute;
9276: }
9277:
9278: .LCclose-window {
9279: position:absolute;
9280: width:32px;
9281: height:32px;
9282: right:8px;
9283: top:8px;
9284: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9285: text-indent:-99999px;
9286: overflow:hidden;
9287: cursor:pointer;
9288: }
9289:
1.1369 raeburn 9290: .LCisDisabled {
9291: cursor: not-allowed;
9292: opacity: 0.5;
9293: }
9294:
9295: a[aria-disabled="true"] {
9296: color: currentColor;
9297: display: inline-block; /* For IE11/ MS Edge bug */
9298: pointer-events: none;
9299: text-decoration: none;
9300: }
9301:
1.1335 raeburn 9302: pre.LC_wordwrap {
9303: white-space: pre-wrap;
9304: white-space: -moz-pre-wrap;
9305: white-space: -pre-wrap;
9306: white-space: -o-pre-wrap;
9307: word-wrap: break-word;
9308: }
9309:
1.1100 raeburn 9310: /*
1.1231 damieng 9311: styles used for response display
9312: */
9313: div.LC_radiofoil, div.LC_rankfoil {
9314: margin: .5em 0em .5em 0em;
9315: }
9316: table.LC_itemgroup {
9317: margin-top: 1em;
9318: }
9319:
9320: /*
1.1100 raeburn 9321: styles used by TTH when "Default set of options to pass to tth/m
9322: when converting TeX" in course settings has been set
9323:
9324: option passed: -t
9325:
9326: */
9327:
9328: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9329: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9330: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9331: td div.norm {line-height:normal;}
9332:
9333: /*
9334: option passed -y3
9335: */
9336:
9337: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9338: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9339: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9340:
1.1230 damieng 9341: /*
9342: sections with roles, for content only
9343: */
9344: section[class^="role-"] {
9345: padding-left: 10px;
9346: padding-right: 5px;
9347: margin-top: 8px;
9348: margin-bottom: 8px;
9349: border: 1px solid #2A4;
9350: border-radius: 5px;
9351: box-shadow: 0px 1px 1px #BBB;
9352: }
9353: section[class^="role-"]>h1 {
9354: position: relative;
9355: margin: 0px;
9356: padding-top: 10px;
9357: padding-left: 40px;
9358: }
9359: section[class^="role-"]>h1:before {
9360: position: absolute;
9361: left: -5px;
9362: top: 5px;
9363: }
9364: section.role-activity>h1:before {
9365: content:url('/adm/daxe/images/section_icons/activity.png');
9366: }
9367: section.role-advice>h1:before {
9368: content:url('/adm/daxe/images/section_icons/advice.png');
9369: }
9370: section.role-bibliography>h1:before {
9371: content:url('/adm/daxe/images/section_icons/bibliography.png');
9372: }
9373: section.role-citation>h1:before {
9374: content:url('/adm/daxe/images/section_icons/citation.png');
9375: }
9376: section.role-conclusion>h1:before {
9377: content:url('/adm/daxe/images/section_icons/conclusion.png');
9378: }
9379: section.role-definition>h1:before {
9380: content:url('/adm/daxe/images/section_icons/definition.png');
9381: }
9382: section.role-demonstration>h1:before {
9383: content:url('/adm/daxe/images/section_icons/demonstration.png');
9384: }
9385: section.role-example>h1:before {
9386: content:url('/adm/daxe/images/section_icons/example.png');
9387: }
9388: section.role-explanation>h1:before {
9389: content:url('/adm/daxe/images/section_icons/explanation.png');
9390: }
9391: section.role-introduction>h1:before {
9392: content:url('/adm/daxe/images/section_icons/introduction.png');
9393: }
9394: section.role-method>h1:before {
9395: content:url('/adm/daxe/images/section_icons/method.png');
9396: }
9397: section.role-more_information>h1:before {
9398: content:url('/adm/daxe/images/section_icons/more_information.png');
9399: }
9400: section.role-objectives>h1:before {
9401: content:url('/adm/daxe/images/section_icons/objectives.png');
9402: }
9403: section.role-prerequisites>h1:before {
9404: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9405: }
9406: section.role-remark>h1:before {
9407: content:url('/adm/daxe/images/section_icons/remark.png');
9408: }
9409: section.role-reminder>h1:before {
9410: content:url('/adm/daxe/images/section_icons/reminder.png');
9411: }
9412: section.role-summary>h1:before {
9413: content:url('/adm/daxe/images/section_icons/summary.png');
9414: }
9415: section.role-syntax>h1:before {
9416: content:url('/adm/daxe/images/section_icons/syntax.png');
9417: }
9418: section.role-warning>h1:before {
9419: content:url('/adm/daxe/images/section_icons/warning.png');
9420: }
9421:
1.1269 raeburn 9422: #LC_minitab_header {
9423: float:left;
9424: width:100%;
9425: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9426: font-size:93%;
9427: line-height:normal;
9428: margin: 0.5em 0 0.5em 0;
9429: }
9430: #LC_minitab_header ul {
9431: margin:0;
9432: padding:10px 10px 0;
9433: list-style:none;
9434: }
9435: #LC_minitab_header li {
9436: float:left;
9437: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9438: margin:0;
9439: padding:0 0 0 9px;
9440: }
9441: #LC_minitab_header a {
9442: display:block;
9443: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9444: padding:5px 15px 4px 6px;
9445: }
9446: #LC_minitab_header #LC_current_minitab {
9447: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9448: }
9449: #LC_minitab_header #LC_current_minitab a {
9450: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9451: padding-bottom:5px;
9452: }
9453:
9454:
1.343 albertel 9455: END
9456: }
9457:
1.306 albertel 9458: =pod
9459:
9460: =item * &headtag()
9461:
9462: Returns a uniform footer for LON-CAPA web pages.
9463:
1.307 albertel 9464: Inputs: $title - optional title for the head
9465: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9466: $args - optional arguments
1.319 albertel 9467: force_register - if is true call registerurl so the remote is
9468: informed
1.415 albertel 9469: redirect -> array ref of
9470: 1- seconds before redirect occurs
9471: 2- url to redirect to
9472: 3- whether the side effect should occur
1.315 albertel 9473: (side effect of setting
9474: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9475: redirected to)
9476: 4- whether the redirect target should be
9477: the opener of the current (pop-up)
9478: window (side effect of setting
9479: $env{'internal.head.to_opener'} to
9480: 1, if true.
1.1388 raeburn 9481: 5- whether encrypt check should be skipped
1.352 albertel 9482: domain -> force to color decorate a page for a specific
9483: domain
9484: function -> force usage of a specific rolish color scheme
9485: bgcolor -> override the default page bgcolor
1.460 albertel 9486: no_auto_mt_title
9487: -> prevent &mt()ing the title arg
1.464 albertel 9488:
1.306 albertel 9489: =cut
9490:
9491: sub headtag {
1.313 albertel 9492: my ($title,$head_extra,$args) = @_;
1.306 albertel 9493:
1.363 albertel 9494: my $function = $args->{'function'} || &get_users_function();
9495: my $domain = $args->{'domain'} || &determinedomain();
9496: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9497: my $httphost = $args->{'use_absolute'};
1.418 albertel 9498: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9499: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9500: #time(),
1.418 albertel 9501: $env{'environment.color.timestamp'},
1.363 albertel 9502: $function,$domain,$bgcolor);
9503:
1.369 www 9504: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9505:
1.308 albertel 9506: my $result =
9507: '<head>'.
1.1160 raeburn 9508: &font_settings($args);
1.319 albertel 9509:
1.1188 raeburn 9510: my $inhibitprint;
9511: if ($args->{'print_suppress'}) {
9512: $inhibitprint = &print_suppression();
9513: }
1.1064 raeburn 9514:
1.1439 raeburn 9515: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9516: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9517: }
1.962 droeschl 9518: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9519: $result .= Apache::lonxml::display_title();
1.319 albertel 9520: }
1.436 albertel 9521: if (!$args->{'no_nav_bar'}
9522: && !$args->{'only_body'}
1.1438 raeburn 9523: && !$args->{'frameset'}
9524: && !$args->{'switchserver'}) {
1.1154 raeburn 9525: $result .= &help_menu_js($httphost);
1.1032 www 9526: $result.=&modal_window();
1.1038 www 9527: $result.=&togglebox_script();
1.1034 www 9528: $result.=&wishlist_window();
1.1041 www 9529: $result.=&LCprogressbarUpdate_script();
1.1034 www 9530: } else {
9531: if ($args->{'add_modal'}) {
9532: $result.=&modal_window();
9533: }
9534: if ($args->{'add_wishlist'}) {
9535: $result.=&wishlist_window();
9536: }
1.1038 www 9537: if ($args->{'add_togglebox'}) {
9538: $result.=&togglebox_script();
9539: }
1.1041 www 9540: if ($args->{'add_progressbar'}) {
9541: $result.=&LCprogressbarUpdate_script();
9542: }
1.436 albertel 9543: }
1.314 albertel 9544: if (ref($args->{'redirect'})) {
1.1388 raeburn 9545: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9546: if (!$skip_enc_check) {
9547: $url = &Apache::lonenc::check_encrypt($url);
9548: }
1.414 albertel 9549: if (!$inhibit_continue) {
9550: $env{'internal.head.redirect'} = $url;
9551: }
1.1386 raeburn 9552: $result.=<<"ADDMETA";
1.313 albertel 9553: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9554: ADDMETA
9555: if ($to_opener) {
9556: $env{'internal.head.to_opener'} = 1;
9557: my $dest = &js_escape($url);
9558: my $timeout = int($time * 1000);
9559: $result .=<<"ENDJS";
9560: <script type="text/javascript">
9561: // <![CDATA[
9562: function LC_To_Opener() {
9563: var dest = '$dest';
9564: if (dest != '') {
9565: if (window.opener != null && !window.opener.closed) {
9566: window.opener.location.href=dest;
9567: window.close();
9568: } else {
9569: window.location.href=dest;
9570: }
9571: }
9572: }
9573: \$(document).ready(function () {
9574: setTimeout('LC_To_Opener()',$timeout);
9575: });
9576: // ]]>
9577: </script>
9578: ENDJS
9579: } else {
9580: $result.=<<"ADDMETA";
1.344 albertel 9581: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9582: ADDMETA
1.1386 raeburn 9583: }
1.1210 raeburn 9584: } else {
9585: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9586: my $requrl = $env{'request.uri'};
9587: if ($requrl eq '') {
9588: $requrl = $ENV{'REQUEST_URI'};
9589: $requrl =~ s/\?.+$//;
9590: }
9591: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9592: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9593: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9594: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9595: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9596: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9597: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9598: my ($offload,$offloadoth);
1.1210 raeburn 9599: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9600: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9601: $offload = 1;
1.1353 raeburn 9602: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9603: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9604: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9605: $offloadoth = 1;
9606: $dom_in_use = $env{'user.domain'};
9607: }
9608: }
1.1340 raeburn 9609: }
9610: }
9611: unless ($offload) {
9612: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9613: if ($domdefs{'offloadoth'}{$lonhost}) {
9614: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9615: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9616: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9617: $offload = 1;
1.1352 raeburn 9618: $offloadoth = 1;
1.1340 raeburn 9619: $dom_in_use = $env{'user.domain'};
9620: }
1.1210 raeburn 9621: }
1.1340 raeburn 9622: }
9623: }
9624: }
9625: if ($offload) {
1.1358 raeburn 9626: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9627: if (($newserver eq '') && ($offloadoth)) {
9628: my @domains = &Apache::lonnet::current_machine_domains();
9629: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9630: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9631: }
9632: }
1.1340 raeburn 9633: if (($newserver) && ($newserver ne $lonhost)) {
9634: my $numsec = 5;
9635: my $timeout = $numsec * 1000;
9636: my ($newurl,$locknum,%locks,$msg);
9637: if ($env{'request.role.adv'}) {
9638: ($locknum,%locks) = &Apache::lonnet::get_locks();
9639: }
9640: my $disable_submit = 0;
9641: if ($requrl =~ /$LONCAPA::assess_re/) {
9642: $disable_submit = 1;
9643: }
9644: if ($locknum) {
9645: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9646: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9647: join(", ",sort(values(%locks)))."\n";
9648: if (&show_course()) {
9649: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9650: } else {
9651: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9652: }
1.1340 raeburn 9653: } else {
9654: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9655: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9656: }
9657: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9658: $newurl = '/adm/switchserver?otherserver='.$newserver;
9659: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9660: $newurl .= '&role='.$env{'request.role'};
9661: }
9662: if ($env{'request.symb'}) {
9663: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9664: if ($shownsymb =~ m{^/enc/}) {
9665: my $reqdmajor = 2;
9666: my $reqdminor = 11;
9667: my $reqdsubminor = 3;
9668: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9669: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9670: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9671: if (($major eq '' && $minor eq '') ||
9672: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9673: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9674: ($reqdsubminor > $subminor))))) {
9675: undef($shownsymb);
9676: }
1.1210 raeburn 9677: }
1.1340 raeburn 9678: if ($shownsymb) {
9679: &js_escape(\$shownsymb);
9680: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9681: }
1.1340 raeburn 9682: } else {
9683: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9684: &js_escape(\$shownurl);
9685: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9686: }
1.1340 raeburn 9687: }
9688: &js_escape(\$msg);
9689: $result.=<<OFFLOAD
1.1210 raeburn 9690: <meta http-equiv="pragma" content="no-cache" />
9691: <script type="text/javascript">
1.1215 raeburn 9692: // <![CDATA[
1.1210 raeburn 9693: function LC_Offload_Now() {
9694: var dest = "$newurl";
9695: if (dest != '') {
9696: window.location.href="$newurl";
9697: }
9698: }
1.1214 raeburn 9699: \$(document).ready(function () {
9700: window.alert('$msg');
9701: if ($disable_submit) {
1.1210 raeburn 9702: \$(".LC_hwk_submit").prop("disabled", true);
9703: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9704: }
9705: setTimeout('LC_Offload_Now()', $timeout);
9706: });
1.1215 raeburn 9707: // ]]>
1.1210 raeburn 9708: </script>
9709: OFFLOAD
9710: }
9711: }
9712: }
9713: }
9714: }
1.313 albertel 9715: }
1.306 albertel 9716: if (!defined($title)) {
9717: $title = 'The LearningOnline Network with CAPA';
9718: }
1.460 albertel 9719: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9720: if ($title =~ /^LON-CAPA\s+/) {
9721: $result .= '<title> '.$title.'</title>';
9722: } else {
9723: $result .= '<title> LON-CAPA '.$title.'</title>';
9724: }
9725: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9726: if (!$args->{'frameset'}) {
9727: $result .= ' /';
9728: }
9729: $result .= '>'
1.1064 raeburn 9730: .$inhibitprint
1.414 albertel 9731: .$head_extra;
1.1242 raeburn 9732: my $clientmobile;
9733: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9734: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9735: } else {
9736: $clientmobile = $env{'browser.mobile'};
9737: }
9738: if ($clientmobile) {
1.1137 raeburn 9739: $result .= '
1.1435 raeburn 9740: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9741: <meta name="apple-mobile-web-app-capable" content="yes" />';
9742: }
1.1278 raeburn 9743: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9744: return $result.'</head>';
1.306 albertel 9745: }
9746:
9747: =pod
9748:
1.340 albertel 9749: =item * &font_settings()
9750:
9751: Returns neccessary <meta> to set the proper encoding
9752:
1.1160 raeburn 9753: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9754:
9755: =cut
9756:
9757: sub font_settings {
1.1160 raeburn 9758: my ($args) = @_;
1.340 albertel 9759: my $headerstring='';
1.1160 raeburn 9760: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9761: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9762: $headerstring.=
9763: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9764: if (!$args->{'frameset'}) {
9765: $headerstring.= ' /';
9766: }
9767: $headerstring .= '>'."\n";
1.340 albertel 9768: }
9769: return $headerstring;
9770: }
9771:
1.341 albertel 9772: =pod
9773:
1.1064 raeburn 9774: =item * &print_suppression()
9775:
9776: In course context returns css which causes the body to be blank when media="print",
9777: if printout generation is unavailable for the current resource.
9778:
9779: This could be because:
9780:
9781: (a) printstartdate is in the future
9782:
9783: (b) printenddate is in the past
9784:
9785: (c) there is an active exam block with "printout"
9786: functionality blocked
9787:
9788: Users with pav, pfo or evb privileges are exempt.
9789:
9790: Inputs: none
9791:
9792: =cut
9793:
9794:
9795: sub print_suppression {
9796: my $noprint;
9797: if ($env{'request.course.id'}) {
9798: my $scope = $env{'request.course.id'};
9799: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9800: (&Apache::lonnet::allowed('pfo',$scope))) {
9801: return;
9802: }
9803: if ($env{'request.course.sec'} ne '') {
9804: $scope .= "/$env{'request.course.sec'}";
9805: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9806: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9807: return;
1.1064 raeburn 9808: }
9809: }
9810: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9811: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9812: my $clientip = &Apache::lonnet::get_requestor_ip();
9813: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9814: if ($blocked) {
9815: my $checkrole = "cm./$cdom/$cnum";
9816: if ($env{'request.course.sec'} ne '') {
9817: $checkrole .= "/$env{'request.course.sec'}";
9818: }
9819: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9820: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9821: $noprint = 1;
9822: }
9823: }
9824: unless ($noprint) {
9825: my $symb = &Apache::lonnet::symbread();
9826: if ($symb ne '') {
9827: my $navmap = Apache::lonnavmaps::navmap->new();
9828: if (ref($navmap)) {
9829: my $res = $navmap->getBySymb($symb);
9830: if (ref($res)) {
9831: if (!$res->resprintable()) {
9832: $noprint = 1;
9833: }
9834: }
9835: }
9836: }
9837: }
9838: if ($noprint) {
9839: return <<"ENDSTYLE";
9840: <style type="text/css" media="print">
9841: body { display:none }
9842: </style>
9843: ENDSTYLE
9844: }
9845: }
9846: return;
9847: }
9848:
9849: =pod
9850:
1.341 albertel 9851: =item * &xml_begin()
9852:
9853: Returns the needed doctype and <html>
9854:
9855: Inputs: none
9856:
9857: =cut
9858:
9859: sub xml_begin {
1.1168 raeburn 9860: my ($is_frameset) = @_;
1.341 albertel 9861: my $output='';
9862:
9863: if ($env{'browser.mathml'}) {
9864: $output='<?xml version="1.0"?>'
9865: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9866: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9867:
9868: # .'<!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">] >'
9869: .'<!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">'
9870: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9871: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9872: } elsif ($is_frameset) {
9873: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9874: '<html>'."\n";
1.341 albertel 9875: } else {
1.1168 raeburn 9876: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9877: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9878: }
9879: return $output;
9880: }
1.340 albertel 9881:
9882: =pod
9883:
1.306 albertel 9884: =item * &start_page()
9885:
9886: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9887:
1.648 raeburn 9888: Inputs:
9889:
9890: =over 4
9891:
9892: $title - optional title for the page
9893:
9894: $head_extra - optional extra HTML to incude inside the <head>
9895:
9896: $args - additional optional args supported are:
9897:
9898: =over 8
9899:
9900: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9901: arg on
1.814 bisitz 9902: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9903: add_entries -> additional attributes to add to the <body>
9904: domain -> force to color decorate a page for a
1.317 albertel 9905: specific domain
1.648 raeburn 9906: function -> force usage of a specific rolish color
1.317 albertel 9907: scheme
1.648 raeburn 9908: redirect -> see &headtag()
9909: bgcolor -> override the default page bg color
9910: js_ready -> return a string ready for being used in
1.317 albertel 9911: a javascript writeln
1.648 raeburn 9912: html_encode -> return a string ready for being used in
1.320 albertel 9913: a html attribute
1.648 raeburn 9914: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9915: $forcereg arg
1.648 raeburn 9916: frameset -> if true will start with a <frameset>
1.330 albertel 9917: rather than <body>
1.648 raeburn 9918: skip_phases -> hash ref of
1.338 albertel 9919: head -> skip the <html><head> generation
9920: body -> skip all <body> generation
1.648 raeburn 9921: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9922: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9923: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9924: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9925: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9926: to override those values, or add to them, specify the value to
9927: include in the style attribute to include in the div tag by using
9928: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9929: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9930: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9931: group -> includes the current group, if page is for a
1.1274 raeburn 9932: specific group
9933: use_absolute -> for request for external resource or syllabus, this
9934: will contain https://<hostname> if server uses
9935: https (as per hosts.tab), but request is for http
9936: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9937: links_disabled -> Links in primary and secondary menus are disabled
9938: (Can enable them once page has loaded - see lonroles.pm
9939: for an example).
1.1380 raeburn 9940: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9941:
1.648 raeburn 9942: =back
1.460 albertel 9943:
1.648 raeburn 9944: =back
1.562 albertel 9945:
1.306 albertel 9946: =cut
9947:
9948: sub start_page {
1.309 albertel 9949: my ($title,$head_extra,$args) = @_;
1.318 albertel 9950: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9951:
1.315 albertel 9952: $env{'internal.start_page'}++;
1.1359 raeburn 9953: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9954:
1.338 albertel 9955: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9956: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9957: }
1.1316 raeburn 9958:
9959: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9960: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9961: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9962: $args->{'no_primary_menu'} = 1;
9963: }
9964: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9965: $args->{'no_inline_menu'} = 1;
9966: }
9967: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9968: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9969: }
9970: } else {
9971: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9972: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9973: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9974: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9975: $args->{'no_primary_menu'} = 1;
9976: }
9977: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9978: $args->{'no_inline_menu'} = 1;
9979: }
9980: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9981: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9982: }
9983: }
9984: }
1.1316 raeburn 9985: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9986: $env{'course.'.$env{'request.course.id'}.'.domain'},
9987: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9988: } elsif ($env{'request.course.id'}) {
9989: my $expiretime=600;
9990: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9991: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9992: }
9993: my ($deeplinkmenu,$menuref);
9994: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9995: if ($menucoll) {
9996: if (ref($menuref) eq 'HASH') {
9997: %menu = %{$menuref};
9998: }
9999: if ($menu{'top'} eq 'n') {
10000: $args->{'no_primary_menu'} = 1;
10001: }
10002: if ($menu{'inline'} eq 'n') {
10003: unless (&Apache::lonnet::allowed('opa')) {
10004: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10005: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10006: my $crstype = &course_type();
10007: my $now = time;
10008: my $ccrole;
10009: if ($crstype eq 'Community') {
10010: $ccrole = 'co';
10011: } else {
10012: $ccrole = 'cc';
10013: }
10014: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
10015: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
10016: if ((($start) && ($start<0)) ||
10017: (($end) && ($end<$now)) ||
10018: (($start) && ($now<$start))) {
10019: $args->{'no_inline_menu'} = 1;
10020: }
10021: } else {
10022: $args->{'no_inline_menu'} = 1;
10023: }
10024: }
10025: }
10026: }
1.1316 raeburn 10027: }
1.1359 raeburn 10028:
1.1385 raeburn 10029: my $showncrumbs;
1.338 albertel 10030: if (! exists($args->{'skip_phases'}{'body'}) ) {
10031: if ($args->{'frameset'}) {
10032: my $attr_string = &make_attr_string($args->{'force_register'},
10033: $args->{'add_entries'});
10034: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 10035: } else {
10036: $result .=
10037: &bodytag($title,
10038: $args->{'function'}, $args->{'add_entries'},
10039: $args->{'only_body'}, $args->{'domain'},
10040: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 10041: $args->{'bgcolor'}, $args,
1.1385 raeburn 10042: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
10043: \%menu,\$showncrumbs);
1.831 bisitz 10044: }
1.330 albertel 10045: }
1.338 albertel 10046:
1.315 albertel 10047: if ($args->{'js_ready'}) {
1.713 kaisler 10048: $result = &js_ready($result);
1.315 albertel 10049: }
1.320 albertel 10050: if ($args->{'html_encode'}) {
1.713 kaisler 10051: $result = &html_encode($result);
10052: }
10053:
1.813 bisitz 10054: # Preparation for new and consistent functionlist at top of screen
10055: # if ($args->{'functionlist'}) {
10056: # $result .= &build_functionlist();
10057: #}
10058:
1.964 droeschl 10059: # Don't add anything more if only_body wanted or in const space
10060: return $result if $args->{'only_body'}
10061: || $env{'request.state'} eq 'construct';
1.813 bisitz 10062:
10063: #Breadcrumbs
1.758 kaisler 10064: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10065: unless ($showncrumbs) {
1.758 kaisler 10066: &Apache::lonhtmlcommon::clear_breadcrumbs();
10067: #if any br links exists, add them to the breadcrumbs
10068: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10069: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10070: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10071: }
10072: }
1.1096 raeburn 10073: # if @advtools array contains items add then to the breadcrumbs
10074: if (@advtools > 0) {
10075: &Apache::lonmenu::advtools_crumbs(@advtools);
10076: }
1.1272 raeburn 10077: my $menulink;
10078: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10079: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10080: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10081: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10082: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10083: (!$env{'request.role.adv'}))) {
10084: $menulink = 0;
10085: } else {
10086: undef($menulink);
10087: }
1.1385 raeburn 10088: my $linkprotout;
10089: if ($env{'request.deeplink.login'}) {
10090: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10091: if ($linkprotout) {
10092: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10093: }
10094: }
1.758 kaisler 10095: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10096: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10097: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10098: '',$menulink,'',
10099: $args->{'bread_crumbs_style'});
1.1237 raeburn 10100: } else {
1.1437 raeburn 10101: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10102: $args->{'bread_crumbs_style'});
1.758 kaisler 10103: }
1.1385 raeburn 10104: }
1.320 albertel 10105: }
1.315 albertel 10106: return $result;
1.306 albertel 10107: }
10108:
10109: sub end_page {
1.315 albertel 10110: my ($args) = @_;
10111: $env{'internal.end_page'}++;
1.330 albertel 10112: my $result;
1.335 albertel 10113: if ($args->{'discussion'}) {
10114: my ($target,$parser);
10115: if (ref($args->{'discussion'})) {
10116: ($target,$parser) =($args->{'discussion'}{'target'},
10117: $args->{'discussion'}{'parser'});
10118: }
10119: $result .= &Apache::lonxml::xmlend($target,$parser);
10120: }
1.330 albertel 10121: if ($args->{'frameset'}) {
10122: $result .= '</frameset>';
10123: } else {
1.635 raeburn 10124: $result .= &endbodytag($args);
1.330 albertel 10125: }
1.1080 raeburn 10126: unless ($args->{'notbody'}) {
10127: $result .= "\n</html>";
10128: }
1.330 albertel 10129:
1.315 albertel 10130: if ($args->{'js_ready'}) {
1.317 albertel 10131: $result = &js_ready($result);
1.315 albertel 10132: }
1.335 albertel 10133:
1.320 albertel 10134: if ($args->{'html_encode'}) {
10135: $result = &html_encode($result);
10136: }
1.335 albertel 10137:
1.315 albertel 10138: return $result;
10139: }
10140:
1.1359 raeburn 10141: sub menucoll_in_effect {
10142: my ($menucoll,$deeplinkmenu,%menu);
10143: if ($env{'request.course.id'}) {
10144: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10145: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10146: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10147: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10148: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10149: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10150: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10151: my $navmap = Apache::lonnavmaps::navmap->new();
10152: if (ref($navmap)) {
10153: $deeplink = $navmap->get_mapparam(undef,
10154: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10155: '0.deeplink');
1.1370 raeburn 10156: } else {
10157: $check_login_symb = 1;
1.1362 raeburn 10158: }
10159: } else {
1.1370 raeburn 10160: my $symb = &Apache::lonnet::symbread();
10161: if ($symb) {
10162: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10163: } else {
10164: $check_login_symb = 1;
10165: }
1.1362 raeburn 10166: }
10167: } else {
1.1370 raeburn 10168: $check_login_symb = 1;
10169: }
10170: if ($check_login_symb) {
1.1362 raeburn 10171: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10172: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10173: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10174: my $navmap = Apache::lonnavmaps::navmap->new();
10175: if (ref($navmap)) {
10176: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10177: }
10178: } else {
10179: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10180: }
10181: }
1.1359 raeburn 10182: if ($deeplink ne '') {
1.1378 raeburn 10183: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10184: if ($display =~ /^\d+$/) {
10185: $deeplinkmenu = 1;
10186: $menucoll = $display;
10187: }
10188: }
10189: }
10190: if ($menucoll) {
10191: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10192: }
10193: }
10194: return ($menucoll,$deeplinkmenu,\%menu);
10195: }
10196:
1.1362 raeburn 10197: sub deeplink_login_symb {
10198: my ($cnum,$cdom) = @_;
10199: my $login_symb;
10200: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10201: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10202: }
10203: return $login_symb;
10204: }
10205:
10206: sub symb_from_tinyurl {
10207: my ($url,$cnum,$cdom) = @_;
10208: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10209: my $key = $1;
10210: my ($tinyurl,$login);
10211: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10212: if (defined($cached)) {
10213: $tinyurl = $result;
10214: } else {
10215: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10216: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10217: if ($currtiny{$key} ne '') {
10218: $tinyurl = $currtiny{$key};
10219: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10220: }
1.1364 raeburn 10221: }
10222: if ($tinyurl ne '') {
10223: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10224: if (wantarray) {
10225: return ($cnumreq,$symb);
10226: } elsif ($cnumreq eq $cnum) {
10227: return $symb;
1.1362 raeburn 10228: }
10229: }
10230: }
1.1364 raeburn 10231: if (wantarray) {
10232: return ();
10233: } else {
10234: return;
10235: }
1.1362 raeburn 10236: }
10237:
1.1405 raeburn 10238: sub usable_exttools {
10239: my %tooltypes;
10240: if ($env{'request.course.id'}) {
10241: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10242: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10243: %tooltypes = (
10244: crs => 1,
10245: dom => 1,
10246: );
10247: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10248: $tooltypes{'crs'} = 1;
10249: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10250: $tooltypes{'dom'} = 1;
10251: }
10252: } else {
10253: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10254: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10255: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10256: if ($crstype eq '') {
10257: $crstype = 'course';
10258: }
10259: if ($crstype eq 'course') {
10260: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10261: $crstype = 'official';
10262: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10263: $crstype = 'textbook';
10264: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10265: $crstype = 'lti';
10266: } else {
10267: $crstype = 'unofficial';
10268: }
10269: }
10270: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10271: if ($domdefaults{$crstype.'domexttool'}) {
10272: $tooltypes{'dom'} = 1;
10273: }
10274: if ($domdefaults{$crstype.'exttool'}) {
10275: $tooltypes{'crs'} = 1;
10276: }
10277: }
10278: }
10279: return %tooltypes;
10280: }
10281:
1.1034 www 10282: sub wishlist_window {
10283: return(<<'ENDWISHLIST');
1.1046 raeburn 10284: <script type="text/javascript">
1.1034 www 10285: // <![CDATA[
10286: // <!-- BEGIN LON-CAPA Internal
10287: function set_wishlistlink(title, path) {
10288: if (!title) {
10289: title = document.title;
10290: title = title.replace(/^LON-CAPA /,'');
10291: }
1.1175 raeburn 10292: title = encodeURIComponent(title);
1.1203 raeburn 10293: title = title.replace("'","\\\'");
1.1034 www 10294: if (!path) {
10295: path = location.pathname;
10296: }
1.1175 raeburn 10297: path = encodeURIComponent(path);
1.1203 raeburn 10298: path = path.replace("'","\\\'");
1.1034 www 10299: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10300: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10301: }
10302: // END LON-CAPA Internal -->
10303: // ]]>
10304: </script>
10305: ENDWISHLIST
10306: }
10307:
1.1030 www 10308: sub modal_window {
10309: return(<<'ENDMODAL');
1.1046 raeburn 10310: <script type="text/javascript">
1.1030 www 10311: // <![CDATA[
10312: // <!-- BEGIN LON-CAPA Internal
10313: var modalWindow = {
10314: parent:"body",
10315: windowId:null,
10316: content:null,
10317: width:null,
10318: height:null,
10319: close:function()
10320: {
10321: $(".LCmodal-window").remove();
10322: $(".LCmodal-overlay").remove();
10323: },
10324: open:function()
10325: {
10326: var modal = "";
10327: modal += "<div class=\"LCmodal-overlay\"></div>";
10328: 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;\">";
10329: modal += this.content;
10330: modal += "</div>";
10331:
10332: $(this.parent).append(modal);
10333:
10334: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10335: $(".LCclose-window").click(function(){modalWindow.close();});
10336: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10337: }
10338: };
1.1140 raeburn 10339: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10340: {
1.1266 raeburn 10341: source = source.replace(/'/g,"'");
1.1030 www 10342: modalWindow.windowId = "myModal";
10343: modalWindow.width = width;
10344: modalWindow.height = height;
1.1196 raeburn 10345: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10346: modalWindow.open();
1.1208 raeburn 10347: };
1.1030 www 10348: // END LON-CAPA Internal -->
10349: // ]]>
10350: </script>
10351: ENDMODAL
10352: }
10353:
10354: sub modal_link {
1.1140 raeburn 10355: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10356: unless ($width) { $width=480; }
10357: unless ($height) { $height=400; }
1.1031 www 10358: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10359: unless ($transparency) { $transparency='true'; }
10360:
1.1074 raeburn 10361: my $target_attr;
10362: if (defined($target)) {
10363: $target_attr = 'target="'.$target.'"';
10364: }
10365: return <<"ENDLINK";
1.1336 raeburn 10366: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10367: ENDLINK
1.1030 www 10368: }
10369:
1.1032 www 10370: sub modal_adhoc_script {
1.1365 raeburn 10371: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10372: my $mathjax;
10373: if ($possmathjax) {
10374: $mathjax = <<'ENDJAX';
10375: if (typeof MathJax == 'object') {
10376: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10377: }
10378: ENDJAX
10379: }
1.1032 www 10380: return (<<ENDADHOC);
1.1046 raeburn 10381: <script type="text/javascript">
1.1032 www 10382: // <![CDATA[
10383: var $funcname = function()
10384: {
10385: modalWindow.windowId = "myModal";
10386: modalWindow.width = $width;
10387: modalWindow.height = $height;
10388: modalWindow.content = '$content';
10389: modalWindow.open();
1.1365 raeburn 10390: $mathjax
1.1032 www 10391: };
10392: // ]]>
10393: </script>
10394: ENDADHOC
10395: }
10396:
1.1041 www 10397: sub modal_adhoc_inner {
1.1365 raeburn 10398: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10399: my $innerwidth=$width-20;
10400: $content=&js_ready(
1.1140 raeburn 10401: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10402: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10403: $content.
1.1041 www 10404: &end_scrollbox().
1.1140 raeburn 10405: &end_page()
1.1041 www 10406: );
1.1365 raeburn 10407: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10408: }
10409:
10410: sub modal_adhoc_window {
1.1365 raeburn 10411: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10412: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10413: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10414: }
10415:
10416: sub modal_adhoc_launch {
10417: my ($funcname,$width,$height,$content)=@_;
10418: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10419: <script type="text/javascript">
10420: // <![CDATA[
10421: $funcname();
10422: // ]]>
10423: </script>
10424: ENDLAUNCH
10425: }
10426:
10427: sub modal_adhoc_close {
10428: return (<<ENDCLOSE);
10429: <script type="text/javascript">
10430: // <![CDATA[
10431: modalWindow.close();
10432: // ]]>
10433: </script>
10434: ENDCLOSE
10435: }
10436:
1.1038 www 10437: sub togglebox_script {
10438: return(<<ENDTOGGLE);
10439: <script type="text/javascript">
10440: // <![CDATA[
10441: function LCtoggleDisplay(id,hidetext,showtext) {
10442: link = document.getElementById(id + "link").childNodes[0];
10443: with (document.getElementById(id).style) {
10444: if (display == "none" ) {
10445: display = "inline";
10446: link.nodeValue = hidetext;
10447: } else {
10448: display = "none";
10449: link.nodeValue = showtext;
10450: }
10451: }
10452: }
10453: // ]]>
10454: </script>
10455: ENDTOGGLE
10456: }
10457:
1.1039 www 10458: sub start_togglebox {
10459: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10460: unless ($heading) { $heading=''; } else { $heading.=' '; }
10461: unless ($showtext) { $showtext=&mt('show'); }
10462: unless ($hidetext) { $hidetext=&mt('hide'); }
10463: unless ($headerbg) { $headerbg='#FFFFFF'; }
10464: return &start_data_table().
10465: &start_data_table_header_row().
10466: '<td bgcolor="'.$headerbg.'">'.$heading.
10467: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10468: $showtext.'\')">'.$showtext.'</a>]</td>'.
10469: &end_data_table_header_row().
10470: '<tr id="'.$id.'" style="display:none""><td>';
10471: }
10472:
10473: sub end_togglebox {
10474: return '</td></tr>'.&end_data_table();
10475: }
10476:
1.1041 www 10477: sub LCprogressbar_script {
1.1302 raeburn 10478: my ($id,$number_to_do)=@_;
10479: if ($number_to_do) {
10480: return(<<ENDPROGRESS);
1.1041 www 10481: <script type="text/javascript">
10482: // <![CDATA[
1.1045 www 10483: \$('#progressbar$id').progressbar({
1.1041 www 10484: value: 0,
10485: change: function(event, ui) {
10486: var newVal = \$(this).progressbar('option', 'value');
10487: \$('.pblabel', this).text(LCprogressTxt);
10488: }
10489: });
10490: // ]]>
10491: </script>
10492: ENDPROGRESS
1.1302 raeburn 10493: } else {
10494: return(<<ENDPROGRESS);
10495: <script type="text/javascript">
10496: // <![CDATA[
10497: \$('#progressbar$id').progressbar({
10498: value: false,
10499: create: function(event, ui) {
10500: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10501: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10502: }
10503: });
10504: // ]]>
10505: </script>
10506: ENDPROGRESS
10507: }
1.1041 www 10508: }
10509:
10510: sub LCprogressbarUpdate_script {
10511: return(<<ENDPROGRESSUPDATE);
10512: <style type="text/css">
10513: .ui-progressbar { position:relative; }
1.1302 raeburn 10514: .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 10515: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10516: </style>
10517: <script type="text/javascript">
10518: // <![CDATA[
1.1045 www 10519: var LCprogressTxt='---';
10520:
1.1302 raeburn 10521: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10522: LCprogressTxt=progresstext;
1.1302 raeburn 10523: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10524: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10525: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10526: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10527: } else {
10528: \$('#progressbar'+id).progressbar('value',percent);
10529: }
1.1041 www 10530: }
10531: // ]]>
10532: </script>
10533: ENDPROGRESSUPDATE
10534: }
10535:
1.1042 www 10536: my $LClastpercent;
1.1045 www 10537: my $LCidcnt;
10538: my $LCcurrentid;
1.1042 www 10539:
1.1041 www 10540: sub LCprogressbar {
1.1302 raeburn 10541: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10542: $LClastpercent=0;
1.1045 www 10543: $LCidcnt++;
10544: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10545: my ($starting,$content);
10546: if ($number_to_do) {
10547: $starting=&mt('Starting');
10548: $content=(<<ENDPROGBAR);
10549: $preamble
1.1045 www 10550: <div id="progressbar$LCcurrentid">
1.1041 www 10551: <span class="pblabel">$starting</span>
10552: </div>
10553: ENDPROGBAR
1.1302 raeburn 10554: } else {
10555: $starting=&mt('Loading...');
10556: $LClastpercent='false';
10557: $content=(<<ENDPROGBAR);
10558: $preamble
10559: <div id="progressbar$LCcurrentid">
10560: <div class="progress-label">$starting</div>
10561: </div>
10562: ENDPROGBAR
10563: }
10564: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10565: }
10566:
10567: sub LCprogressbarUpdate {
1.1302 raeburn 10568: my ($r,$val,$text,$number_to_do)=@_;
10569: if ($number_to_do) {
10570: unless ($val) {
10571: if ($LClastpercent) {
10572: $val=$LClastpercent;
10573: } else {
10574: $val=0;
10575: }
10576: }
10577: if ($val<0) { $val=0; }
10578: if ($val>100) { $val=0; }
10579: $LClastpercent=$val;
10580: unless ($text) { $text=$val.'%'; }
10581: } else {
10582: $val = 'false';
1.1042 www 10583: }
1.1041 www 10584: $text=&js_ready($text);
1.1044 www 10585: &r_print($r,<<ENDUPDATE);
1.1041 www 10586: <script type="text/javascript">
10587: // <![CDATA[
1.1302 raeburn 10588: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10589: // ]]>
10590: </script>
10591: ENDUPDATE
1.1035 www 10592: }
10593:
1.1042 www 10594: sub LCprogressbarClose {
10595: my ($r)=@_;
10596: $LClastpercent=0;
1.1044 www 10597: &r_print($r,<<ENDCLOSE);
1.1042 www 10598: <script type="text/javascript">
10599: // <![CDATA[
1.1045 www 10600: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10601: // ]]>
10602: </script>
10603: ENDCLOSE
1.1044 www 10604: }
10605:
10606: sub r_print {
10607: my ($r,$to_print)=@_;
10608: if ($r) {
10609: $r->print($to_print);
10610: $r->rflush();
10611: } else {
10612: print($to_print);
10613: }
1.1042 www 10614: }
10615:
1.320 albertel 10616: sub html_encode {
10617: my ($result) = @_;
10618:
1.322 albertel 10619: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10620:
10621: return $result;
10622: }
1.1044 www 10623:
1.317 albertel 10624: sub js_ready {
10625: my ($result) = @_;
10626:
1.323 albertel 10627: $result =~ s/[\n\r]/ /xmsg;
10628: $result =~ s/\\/\\\\/xmsg;
10629: $result =~ s/'/\\'/xmsg;
1.372 albertel 10630: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10631:
10632: return $result;
10633: }
10634:
1.315 albertel 10635: sub validate_page {
10636: if ( exists($env{'internal.start_page'})
1.316 albertel 10637: && $env{'internal.start_page'} > 1) {
10638: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10639: $env{'internal.start_page'}.' '.
1.316 albertel 10640: $ENV{'request.filename'});
1.315 albertel 10641: }
10642: if ( exists($env{'internal.end_page'})
1.316 albertel 10643: && $env{'internal.end_page'} > 1) {
10644: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10645: $env{'internal.end_page'}.' '.
1.316 albertel 10646: $env{'request.filename'});
1.315 albertel 10647: }
10648: if ( exists($env{'internal.start_page'})
10649: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10650: &Apache::lonnet::logthis('start_page called without end_page '.
10651: $env{'request.filename'});
1.315 albertel 10652: }
10653: if ( ! exists($env{'internal.start_page'})
10654: && exists($env{'internal.end_page'})) {
1.316 albertel 10655: &Apache::lonnet::logthis('end_page called without start_page'.
10656: $env{'request.filename'});
1.315 albertel 10657: }
1.306 albertel 10658: }
1.315 albertel 10659:
1.996 www 10660:
10661: sub start_scrollbox {
1.1140 raeburn 10662: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10663: unless ($outerwidth) { $outerwidth='520px'; }
10664: unless ($width) { $width='500px'; }
10665: unless ($height) { $height='200px'; }
1.1075 raeburn 10666: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10667: if ($id ne '') {
1.1140 raeburn 10668: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10669: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10670: }
1.1075 raeburn 10671: if ($bgcolor ne '') {
10672: $tdcol = "background-color: $bgcolor;";
10673: }
1.1137 raeburn 10674: my $nicescroll_js;
10675: if ($env{'browser.mobile'}) {
1.1140 raeburn 10676: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10677: }
10678: return <<"END";
10679: $nicescroll_js
10680:
10681: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10682: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10683: END
10684: }
10685:
10686: sub end_scrollbox {
10687: return '</div></td></tr></table>';
10688: }
10689:
10690: sub nicescroll_javascript {
10691: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10692: my %options;
10693: if (ref($cursor) eq 'HASH') {
10694: %options = %{$cursor};
10695: }
10696: unless ($options{'railalign'} =~ /^left|right$/) {
10697: $options{'railalign'} = 'left';
10698: }
10699: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10700: my $function = &get_users_function();
10701: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10702: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10703: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10704: }
1.1140 raeburn 10705: }
10706: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10707: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10708: $options{'cursoropacity'}='1.0';
10709: }
1.1140 raeburn 10710: } else {
10711: $options{'cursoropacity'}='1.0';
10712: }
10713: if ($options{'cursorfixedheight'} eq 'none') {
10714: delete($options{'cursorfixedheight'});
10715: } else {
10716: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10717: }
10718: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10719: delete($options{'railoffset'});
10720: }
10721: my @niceoptions;
10722: while (my($key,$value) = each(%options)) {
10723: if ($value =~ /^\{.+\}$/) {
10724: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10725: } else {
1.1140 raeburn 10726: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10727: }
1.1140 raeburn 10728: }
10729: my $nicescroll_js = '
1.1137 raeburn 10730: $(document).ready(
1.1140 raeburn 10731: function() {
10732: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10733: }
1.1137 raeburn 10734: );
10735: ';
1.1140 raeburn 10736: if ($framecheck) {
10737: $nicescroll_js .= '
10738: function expand_div(caller) {
10739: if (top === self) {
10740: document.getElementById("'.$id.'").style.width = "auto";
10741: document.getElementById("'.$id.'").style.height = "auto";
10742: } else {
10743: try {
10744: if (parent.frames) {
10745: if (parent.frames.length > 1) {
10746: var framesrc = parent.frames[1].location.href;
10747: var currsrc = framesrc.replace(/\#.*$/,"");
10748: if ((caller == "search") || (currsrc == "'.$location.'")) {
10749: document.getElementById("'.$id.'").style.width = "auto";
10750: document.getElementById("'.$id.'").style.height = "auto";
10751: }
10752: }
10753: }
10754: } catch (e) {
10755: return;
10756: }
1.1137 raeburn 10757: }
1.1140 raeburn 10758: return;
1.996 www 10759: }
1.1140 raeburn 10760: ';
10761: }
10762: if ($needjsready) {
10763: $nicescroll_js = '
10764: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10765: } else {
10766: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10767: }
10768: return $nicescroll_js;
1.996 www 10769: }
10770:
1.318 albertel 10771: sub simple_error_page {
1.1150 bisitz 10772: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10773: my %displayargs;
1.1151 raeburn 10774: if (ref($args) eq 'HASH') {
10775: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10776: if ($args->{'only_body'}) {
10777: $displayargs{'only_body'} = 1;
10778: }
10779: if ($args->{'no_nav_bar'}) {
10780: $displayargs{'no_nav_bar'} = 1;
10781: }
1.1151 raeburn 10782: } else {
10783: $msg = &mt($msg);
10784: }
1.1150 bisitz 10785:
1.318 albertel 10786: my $page =
1.1304 raeburn 10787: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10788: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10789: &Apache::loncommon::end_page();
10790: if (ref($r)) {
10791: $r->print($page);
1.327 albertel 10792: return;
1.318 albertel 10793: }
10794: return $page;
10795: }
1.347 albertel 10796:
10797: {
1.610 albertel 10798: my @row_count;
1.961 onken 10799:
10800: sub start_data_table_count {
10801: unshift(@row_count, 0);
10802: return;
10803: }
10804:
10805: sub end_data_table_count {
10806: shift(@row_count);
10807: return;
10808: }
10809:
1.347 albertel 10810: sub start_data_table {
1.1018 raeburn 10811: my ($add_class,$id) = @_;
1.422 albertel 10812: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10813: my $table_id;
10814: if (defined($id)) {
10815: $table_id = ' id="'.$id.'"';
10816: }
1.961 onken 10817: &start_data_table_count();
1.1018 raeburn 10818: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10819: }
10820:
10821: sub end_data_table {
1.961 onken 10822: &end_data_table_count();
1.389 albertel 10823: return '</table>'."\n";;
1.347 albertel 10824: }
10825:
10826: sub start_data_table_row {
1.974 wenzelju 10827: my ($add_class, $id) = @_;
1.610 albertel 10828: $row_count[0]++;
10829: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10830: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10831: $id = (' id="'.$id.'"') unless ($id eq '');
10832: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10833: }
1.471 banghart 10834:
10835: sub continue_data_table_row {
1.974 wenzelju 10836: my ($add_class, $id) = @_;
1.610 albertel 10837: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10838: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10839: $id = (' id="'.$id.'"') unless ($id eq '');
10840: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10841: }
1.347 albertel 10842:
10843: sub end_data_table_row {
1.389 albertel 10844: return '</tr>'."\n";;
1.347 albertel 10845: }
1.367 www 10846:
1.421 albertel 10847: sub start_data_table_empty_row {
1.707 bisitz 10848: # $row_count[0]++;
1.421 albertel 10849: return '<tr class="LC_empty_row" >'."\n";;
10850: }
10851:
10852: sub end_data_table_empty_row {
10853: return '</tr>'."\n";;
10854: }
10855:
1.367 www 10856: sub start_data_table_header_row {
1.389 albertel 10857: return '<tr class="LC_header_row">'."\n";;
1.367 www 10858: }
10859:
10860: sub end_data_table_header_row {
1.389 albertel 10861: return '</tr>'."\n";;
1.367 www 10862: }
1.890 droeschl 10863:
10864: sub data_table_caption {
10865: my $caption = shift;
10866: return "<caption class=\"LC_caption\">$caption</caption>";
10867: }
1.347 albertel 10868: }
10869:
1.548 albertel 10870: =pod
10871:
10872: =item * &inhibit_menu_check($arg)
10873:
10874: Checks for a inhibitmenu state and generates output to preserve it
10875:
10876: Inputs: $arg - can be any of
10877: - undef - in which case the return value is a string
10878: to add into arguments list of a uri
10879: - 'input' - in which case the return value is a HTML
10880: <form> <input> field of type hidden to
10881: preserve the value
10882: - a url - in which case the return value is the url with
10883: the neccesary cgi args added to preserve the
10884: inhibitmenu state
10885: - a ref to a url - no return value, but the string is
10886: updated to include the neccessary cgi
10887: args to preserve the inhibitmenu state
10888:
10889: =cut
10890:
10891: sub inhibit_menu_check {
10892: my ($arg) = @_;
10893: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10894: if ($arg eq 'input') {
10895: if ($env{'form.inhibitmenu'}) {
10896: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10897: } else {
10898: return
10899: }
10900: }
10901: if ($env{'form.inhibitmenu'}) {
10902: if (ref($arg)) {
10903: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10904: } elsif ($arg eq '') {
10905: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10906: } else {
10907: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10908: }
10909: }
10910: if (!ref($arg)) {
10911: return $arg;
10912: }
10913: }
10914:
1.251 albertel 10915: ###############################################
1.182 matthew 10916:
10917: =pod
10918:
1.549 albertel 10919: =back
10920:
10921: =head1 User Information Routines
10922:
10923: =over 4
10924:
1.405 albertel 10925: =item * &get_users_function()
1.182 matthew 10926:
10927: Used by &bodytag to determine the current users primary role.
10928: Returns either 'student','coordinator','admin', or 'author'.
10929:
10930: =cut
10931:
10932: ###############################################
10933: sub get_users_function {
1.815 tempelho 10934: my $function = 'norole';
1.818 tempelho 10935: if ($env{'request.role'}=~/^(st)/) {
10936: $function='student';
10937: }
1.907 raeburn 10938: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10939: $function='coordinator';
10940: }
1.258 albertel 10941: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10942: $function='admin';
10943: }
1.826 bisitz 10944: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10945: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10946: $function='author';
10947: }
10948: return $function;
1.54 www 10949: }
1.99 www 10950:
10951: ###############################################
10952:
1.233 raeburn 10953: =pod
10954:
1.821 raeburn 10955: =item * &show_course()
10956:
10957: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10958: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10959:
10960: Inputs:
10961: None
10962:
10963: Outputs:
10964: Scalar: 1 if 'Course' to be used, 0 otherwise.
10965:
10966: =cut
10967:
10968: ###############################################
10969: sub show_course {
1.1408 raeburn 10970: my ($udom,$uname) = @_;
10971: if (($udom ne '') && ($uname ne '')) {
10972: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10973: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10974: return 0;
10975: } else {
10976: return 1;
10977: }
10978: }
10979: }
1.821 raeburn 10980: my $course = !$env{'user.adv'};
10981: if (!$env{'user.adv'}) {
10982: foreach my $env (keys(%env)) {
10983: next if ($env !~ m/^user\.priv\./);
10984: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10985: $course = 0;
10986: last;
10987: }
10988: }
10989: }
10990: return $course;
10991: }
10992:
10993: ###############################################
10994:
10995: =pod
10996:
1.542 raeburn 10997: =item * &check_user_status()
1.274 raeburn 10998:
10999: Determines current status of supplied role for a
11000: specific user. Roles can be active, previous or future.
11001:
11002: Inputs:
11003: user's domain, user's username, course's domain,
1.375 raeburn 11004: course's number, optional section ID.
1.274 raeburn 11005:
11006: Outputs:
11007: role status: active, previous or future.
11008:
11009: =cut
11010:
11011: sub check_user_status {
1.412 raeburn 11012: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 11013: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 11014: my @uroles = keys(%userinfo);
1.274 raeburn 11015: my $srchstr;
11016: my $active_chk = 'none';
1.412 raeburn 11017: my $now = time;
1.274 raeburn 11018: if (@uroles > 0) {
1.908 raeburn 11019: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 11020: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
11021: } else {
1.412 raeburn 11022: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
11023: }
11024: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 11025: my $role_end = 0;
11026: my $role_start = 0;
11027: $active_chk = 'active';
1.412 raeburn 11028: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
11029: $role_end = $1;
11030: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
11031: $role_start = $1;
1.274 raeburn 11032: }
11033: }
11034: if ($role_start > 0) {
1.412 raeburn 11035: if ($now < $role_start) {
1.274 raeburn 11036: $active_chk = 'future';
11037: }
11038: }
11039: if ($role_end > 0) {
1.412 raeburn 11040: if ($now > $role_end) {
1.274 raeburn 11041: $active_chk = 'previous';
11042: }
11043: }
11044: }
11045: }
11046: return $active_chk;
11047: }
11048:
11049: ###############################################
11050:
11051: =pod
11052:
1.405 albertel 11053: =item * &get_sections()
1.233 raeburn 11054:
11055: Determines all the sections for a course including
11056: sections with students and sections containing other roles.
1.419 raeburn 11057: Incoming parameters:
11058:
11059: 1. domain
11060: 2. course number
11061: 3. reference to array containing roles for which sections should
11062: be gathered (optional).
11063: 4. reference to array containing status types for which sections
11064: should be gathered (optional).
11065:
11066: If the third argument is undefined, sections are gathered for any role.
11067: If the fourth argument is undefined, sections are gathered for any status.
11068: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11069:
1.374 raeburn 11070: Returns section hash (keys are section IDs, values are
11071: number of users in each section), subject to the
1.419 raeburn 11072: optional roles filter, optional status filter
1.233 raeburn 11073:
11074: =cut
11075:
11076: ###############################################
11077: sub get_sections {
1.419 raeburn 11078: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11079: if (!defined($cdom) || !defined($cnum)) {
11080: my $cid = $env{'request.course.id'};
11081:
11082: return if (!defined($cid));
11083:
11084: $cdom = $env{'course.'.$cid.'.domain'};
11085: $cnum = $env{'course.'.$cid.'.num'};
11086: }
11087:
11088: my %sectioncount;
1.419 raeburn 11089: my $now = time;
1.240 albertel 11090:
1.1118 raeburn 11091: my $check_students = 1;
11092: my $only_students = 0;
11093: if (ref($possible_roles) eq 'ARRAY') {
11094: if (grep(/^st$/,@{$possible_roles})) {
11095: if (@{$possible_roles} == 1) {
11096: $only_students = 1;
11097: }
11098: } else {
11099: $check_students = 0;
11100: }
11101: }
11102:
11103: if ($check_students) {
1.276 albertel 11104: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11105: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11106: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11107: my $start_index = &Apache::loncoursedata::CL_START();
11108: my $end_index = &Apache::loncoursedata::CL_END();
11109: my $status;
1.366 albertel 11110: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11111: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11112: $data->[$status_index],
11113: $data->[$start_index],
11114: $data->[$end_index]);
11115: if ($stu_status eq 'Active') {
11116: $status = 'active';
11117: } elsif ($end < $now) {
11118: $status = 'previous';
11119: } elsif ($start > $now) {
11120: $status = 'future';
11121: }
11122: if ($section ne '-1' && $section !~ /^\s*$/) {
11123: if ((!defined($possible_status)) || (($status ne '') &&
11124: (grep/^\Q$status\E$/,@{$possible_status}))) {
11125: $sectioncount{$section}++;
11126: }
1.240 albertel 11127: }
11128: }
11129: }
1.1118 raeburn 11130: if ($only_students) {
11131: return %sectioncount;
11132: }
1.240 albertel 11133: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11134: foreach my $user (sort(keys(%courseroles))) {
11135: if ($user !~ /^(\w{2})/) { next; }
11136: my ($role) = ($user =~ /^(\w{2})/);
11137: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11138: my ($section,$status);
1.240 albertel 11139: if ($role eq 'cr' &&
11140: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11141: $section=$1;
11142: }
11143: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11144: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11145: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11146: if ($end == -1 && $start == -1) {
11147: next; #deleted role
11148: }
11149: if (!defined($possible_status)) {
11150: $sectioncount{$section}++;
11151: } else {
11152: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11153: $status = 'active';
11154: } elsif ($end < $now) {
11155: $status = 'future';
11156: } elsif ($start > $now) {
11157: $status = 'previous';
11158: }
11159: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11160: $sectioncount{$section}++;
11161: }
11162: }
1.233 raeburn 11163: }
1.366 albertel 11164: return %sectioncount;
1.233 raeburn 11165: }
11166:
1.274 raeburn 11167: ###############################################
1.294 raeburn 11168:
11169: =pod
1.405 albertel 11170:
11171: =item * &get_course_users()
11172:
1.275 raeburn 11173: Retrieves usernames:domains for users in the specified course
11174: with specific role(s), and access status.
11175:
11176: Incoming parameters:
1.277 albertel 11177: 1. course domain
11178: 2. course number
11179: 3. access status: users must have - either active,
1.275 raeburn 11180: previous, future, or all.
1.277 albertel 11181: 4. reference to array of permissible roles
1.288 raeburn 11182: 5. reference to array of section restrictions (optional)
11183: 6. reference to results object (hash of hashes).
11184: 7. reference to optional userdata hash
1.609 raeburn 11185: 8. reference to optional statushash
1.630 raeburn 11186: 9. flag if privileged users (except those set to unhide in
11187: course settings) should be excluded
1.609 raeburn 11188: Keys of top level results hash are roles.
1.275 raeburn 11189: Keys of inner hashes are username:domain, with
11190: values set to access type.
1.288 raeburn 11191: Optional userdata hash returns an array with arguments in the
11192: same order as loncoursedata::get_classlist() for student data.
11193:
1.609 raeburn 11194: Optional statushash returns
11195:
1.288 raeburn 11196: Entries for end, start, section and status are blank because
11197: of the possibility of multiple values for non-student roles.
11198:
1.275 raeburn 11199: =cut
1.405 albertel 11200:
1.275 raeburn 11201: ###############################################
1.405 albertel 11202:
1.275 raeburn 11203: sub get_course_users {
1.630 raeburn 11204: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11205: my %idx = ();
1.419 raeburn 11206: my %seclists;
1.288 raeburn 11207:
11208: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11209: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11210: $idx{end} = &Apache::loncoursedata::CL_END();
11211: $idx{start} = &Apache::loncoursedata::CL_START();
11212: $idx{id} = &Apache::loncoursedata::CL_ID();
11213: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11214: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11215: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11216:
1.290 albertel 11217: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11218: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11219: my $now = time;
1.277 albertel 11220: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11221: my $match = 0;
1.412 raeburn 11222: my $secmatch = 0;
1.419 raeburn 11223: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11224: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11225: if ($section eq '') {
11226: $section = 'none';
11227: }
1.291 albertel 11228: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11229: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11230: $secmatch = 1;
11231: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11232: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11233: $secmatch = 1;
11234: }
11235: } else {
1.419 raeburn 11236: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11237: $secmatch = 1;
11238: }
1.290 albertel 11239: }
1.412 raeburn 11240: if (!$secmatch) {
11241: next;
11242: }
1.419 raeburn 11243: }
1.275 raeburn 11244: if (defined($$types{'active'})) {
1.288 raeburn 11245: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11246: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11247: $match = 1;
1.275 raeburn 11248: }
11249: }
11250: if (defined($$types{'previous'})) {
1.609 raeburn 11251: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11252: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11253: $match = 1;
1.275 raeburn 11254: }
11255: }
11256: if (defined($$types{'future'})) {
1.609 raeburn 11257: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11258: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11259: $match = 1;
1.275 raeburn 11260: }
11261: }
1.609 raeburn 11262: if ($match) {
11263: push(@{$seclists{$student}},$section);
11264: if (ref($userdata) eq 'HASH') {
11265: $$userdata{$student} = $$classlist{$student};
11266: }
11267: if (ref($statushash) eq 'HASH') {
11268: $statushash->{$student}{'st'}{$section} = $status;
11269: }
1.288 raeburn 11270: }
1.275 raeburn 11271: }
11272: }
1.412 raeburn 11273: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11274: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11275: my $now = time;
1.609 raeburn 11276: my %displaystatus = ( previous => 'Expired',
11277: active => 'Active',
11278: future => 'Future',
11279: );
1.1121 raeburn 11280: my (%nothide,@possdoms);
1.630 raeburn 11281: if ($hidepriv) {
11282: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11283: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11284: if ($user !~ /:/) {
11285: $nothide{join(':',split(/[\@]/,$user))}=1;
11286: } else {
11287: $nothide{$user} = 1;
11288: }
11289: }
1.1121 raeburn 11290: my @possdoms = ($cdom);
11291: if ($coursehash{'checkforpriv'}) {
11292: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11293: }
1.630 raeburn 11294: }
1.439 raeburn 11295: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11296: my $match = 0;
1.412 raeburn 11297: my $secmatch = 0;
1.439 raeburn 11298: my $status;
1.412 raeburn 11299: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11300: $user =~ s/:$//;
1.439 raeburn 11301: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11302: if ($end == -1 || $start == -1) {
11303: next;
11304: }
11305: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11306: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11307: my ($uname,$udom) = split(/:/,$user);
11308: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11309: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11310: $secmatch = 1;
11311: } elsif ($usec eq '') {
1.420 albertel 11312: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11313: $secmatch = 1;
11314: }
11315: } else {
11316: if (grep(/^\Q$usec\E$/,@{$sections})) {
11317: $secmatch = 1;
11318: }
11319: }
11320: if (!$secmatch) {
11321: next;
11322: }
1.288 raeburn 11323: }
1.419 raeburn 11324: if ($usec eq '') {
11325: $usec = 'none';
11326: }
1.275 raeburn 11327: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11328: if ($hidepriv) {
1.1121 raeburn 11329: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11330: (!$nothide{$uname.':'.$udom})) {
11331: next;
11332: }
11333: }
1.503 raeburn 11334: if ($end > 0 && $end < $now) {
1.439 raeburn 11335: $status = 'previous';
11336: } elsif ($start > $now) {
11337: $status = 'future';
11338: } else {
11339: $status = 'active';
11340: }
1.277 albertel 11341: foreach my $type (keys(%{$types})) {
1.275 raeburn 11342: if ($status eq $type) {
1.420 albertel 11343: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11344: push(@{$$users{$role}{$user}},$type);
11345: }
1.288 raeburn 11346: $match = 1;
11347: }
11348: }
1.419 raeburn 11349: if (($match) && (ref($userdata) eq 'HASH')) {
11350: if (!exists($$userdata{$uname.':'.$udom})) {
11351: &get_user_info($udom,$uname,\%idx,$userdata);
11352: }
1.420 albertel 11353: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11354: push(@{$seclists{$uname.':'.$udom}},$usec);
11355: }
1.609 raeburn 11356: if (ref($statushash) eq 'HASH') {
11357: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11358: }
1.275 raeburn 11359: }
11360: }
11361: }
11362: }
1.290 albertel 11363: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11364: if ((defined($cdom)) && (defined($cnum))) {
11365: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11366: if ( defined($csettings{'internal.courseowner'}) ) {
11367: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11368: next if ($owner eq '');
11369: my ($ownername,$ownerdom);
11370: if ($owner =~ /^([^:]+):([^:]+)$/) {
11371: $ownername = $1;
11372: $ownerdom = $2;
11373: } else {
11374: $ownername = $owner;
11375: $ownerdom = $cdom;
11376: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11377: }
11378: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11379: if (defined($userdata) &&
1.609 raeburn 11380: !exists($$userdata{$owner})) {
11381: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11382: if (!grep(/^none$/,@{$seclists{$owner}})) {
11383: push(@{$seclists{$owner}},'none');
11384: }
11385: if (ref($statushash) eq 'HASH') {
11386: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11387: }
1.290 albertel 11388: }
1.279 raeburn 11389: }
11390: }
11391: }
1.419 raeburn 11392: foreach my $user (keys(%seclists)) {
11393: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11394: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11395: }
1.275 raeburn 11396: }
11397: return;
11398: }
11399:
1.288 raeburn 11400: sub get_user_info {
11401: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11402: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11403: &plainname($uname,$udom,'lastname');
1.291 albertel 11404: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11405: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11406: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11407: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11408: return;
11409: }
1.275 raeburn 11410:
1.472 raeburn 11411: ###############################################
11412:
11413: =pod
11414:
11415: =item * &get_user_quota()
11416:
1.1134 raeburn 11417: Retrieves quota assigned for storage of user files.
11418: Default is to report quota for portfolio files.
1.472 raeburn 11419:
11420: Incoming parameters:
11421: 1. user's username
11422: 2. user's domain
1.1134 raeburn 11423: 3. quota name - portfolio, author, or course
1.1136 raeburn 11424: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11425: 4. crstype - official, unofficial, textbook, placement or community,
11426: if quota name is course
1.472 raeburn 11427:
11428: Returns:
1.1163 raeburn 11429: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11430: 2. (Optional) Type of setting: custom or default
11431: (individually assigned or default for user's
11432: institutional status).
11433: 3. (Optional) - User's institutional status (e.g., faculty, staff
11434: or student - types as defined in localenroll::inst_usertypes
11435: for user's domain, which determines default quota for user.
11436: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11437:
11438: If a value has been stored in the user's environment,
1.536 raeburn 11439: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11440: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11441:
11442: =cut
11443:
11444: ###############################################
11445:
11446:
11447: sub get_user_quota {
1.1136 raeburn 11448: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11449: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11450: if (!defined($udom)) {
11451: $udom = $env{'user.domain'};
11452: }
11453: if (!defined($uname)) {
11454: $uname = $env{'user.name'};
11455: }
11456: if (($udom eq '' || $uname eq '') ||
11457: ($udom eq 'public') && ($uname eq 'public')) {
11458: $quota = 0;
1.536 raeburn 11459: $quotatype = 'default';
11460: $defquota = 0;
1.472 raeburn 11461: } else {
1.536 raeburn 11462: my $inststatus;
1.1134 raeburn 11463: if ($quotaname eq 'course') {
11464: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11465: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11466: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11467: } else {
11468: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11469: $quota = $cenv{'internal.uploadquota'};
11470: }
1.536 raeburn 11471: } else {
1.1134 raeburn 11472: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11473: if ($quotaname eq 'author') {
11474: $quota = $env{'environment.authorquota'};
11475: } else {
11476: $quota = $env{'environment.portfolioquota'};
11477: }
11478: $inststatus = $env{'environment.inststatus'};
11479: } else {
11480: my %userenv =
11481: &Apache::lonnet::get('environment',['portfolioquota',
11482: 'authorquota','inststatus'],$udom,$uname);
11483: my ($tmp) = keys(%userenv);
11484: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11485: if ($quotaname eq 'author') {
11486: $quota = $userenv{'authorquota'};
11487: } else {
11488: $quota = $userenv{'portfolioquota'};
11489: }
11490: $inststatus = $userenv{'inststatus'};
11491: } else {
11492: undef(%userenv);
11493: }
11494: }
11495: }
11496: if ($quota eq '' || wantarray) {
11497: if ($quotaname eq 'course') {
11498: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11499: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11500: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11501: ($crstype eq 'placement')) {
1.1136 raeburn 11502: $defquota = $domdefs{$crstype.'quota'};
11503: }
11504: if ($defquota eq '') {
11505: $defquota = 500;
11506: }
1.1134 raeburn 11507: } else {
11508: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11509: }
11510: if ($quota eq '') {
11511: $quota = $defquota;
11512: $quotatype = 'default';
11513: } else {
11514: $quotatype = 'custom';
11515: }
1.472 raeburn 11516: }
11517: }
1.536 raeburn 11518: if (wantarray) {
11519: return ($quota,$quotatype,$settingstatus,$defquota);
11520: } else {
11521: return $quota;
11522: }
1.472 raeburn 11523: }
11524:
11525: ###############################################
11526:
11527: =pod
11528:
11529: =item * &default_quota()
11530:
1.536 raeburn 11531: Retrieves default quota assigned for storage of user portfolio files,
11532: given an (optional) user's institutional status.
1.472 raeburn 11533:
11534: Incoming parameters:
1.1142 raeburn 11535:
1.472 raeburn 11536: 1. domain
1.536 raeburn 11537: 2. (Optional) institutional status(es). This is a : separated list of
11538: status types (e.g., faculty, staff, student etc.)
11539: which apply to the user for whom the default is being retrieved.
11540: If the institutional status string in undefined, the domain
1.1134 raeburn 11541: default quota will be returned.
11542: 3. quota name - portfolio, author, or course
11543: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11544:
11545: Returns:
1.1142 raeburn 11546:
1.1163 raeburn 11547: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11548: 2. (Optional) institutional type which determined the value of the
11549: default quota.
1.472 raeburn 11550:
11551: If a value has been stored in the domain's configuration db,
11552: it will return that, otherwise it returns 20 (for backwards
11553: compatibility with domains which have not set up a configuration
1.1163 raeburn 11554: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11555:
1.536 raeburn 11556: If the user's status includes multiple types (e.g., staff and student),
11557: the largest default quota which applies to the user determines the
11558: default quota returned.
11559:
1.472 raeburn 11560: =cut
11561:
11562: ###############################################
11563:
11564:
11565: sub default_quota {
1.1134 raeburn 11566: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11567: my ($defquota,$settingstatus);
11568: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11569: ['quotas'],$udom);
1.1134 raeburn 11570: my $key = 'defaultquota';
11571: if ($quotaname eq 'author') {
11572: $key = 'authorquota';
11573: }
1.622 raeburn 11574: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11575: if ($inststatus ne '') {
1.765 raeburn 11576: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11577: foreach my $item (@statuses) {
1.1134 raeburn 11578: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11579: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11580: if ($defquota eq '') {
1.1134 raeburn 11581: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11582: $settingstatus = $item;
1.1134 raeburn 11583: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11584: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11585: $settingstatus = $item;
11586: }
11587: }
1.1134 raeburn 11588: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11589: if ($quotahash{'quotas'}{$item} ne '') {
11590: if ($defquota eq '') {
11591: $defquota = $quotahash{'quotas'}{$item};
11592: $settingstatus = $item;
11593: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11594: $defquota = $quotahash{'quotas'}{$item};
11595: $settingstatus = $item;
11596: }
1.536 raeburn 11597: }
11598: }
11599: }
11600: }
11601: if ($defquota eq '') {
1.1134 raeburn 11602: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11603: $defquota = $quotahash{'quotas'}{$key}{'default'};
11604: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11605: $defquota = $quotahash{'quotas'}{'default'};
11606: }
1.536 raeburn 11607: $settingstatus = 'default';
1.1139 raeburn 11608: if ($defquota eq '') {
11609: if ($quotaname eq 'author') {
11610: $defquota = 500;
11611: }
11612: }
1.536 raeburn 11613: }
11614: } else {
11615: $settingstatus = 'default';
1.1134 raeburn 11616: if ($quotaname eq 'author') {
11617: $defquota = 500;
11618: } else {
11619: $defquota = 20;
11620: }
1.536 raeburn 11621: }
11622: if (wantarray) {
11623: return ($defquota,$settingstatus);
1.472 raeburn 11624: } else {
1.536 raeburn 11625: return $defquota;
1.472 raeburn 11626: }
11627: }
11628:
1.1135 raeburn 11629: ###############################################
11630:
11631: =pod
11632:
1.1136 raeburn 11633: =item * &excess_filesize_warning()
1.1135 raeburn 11634:
11635: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11636: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11637: space to be exceeded.
1.1136 raeburn 11638:
11639: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11640: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11641:
1.1165 raeburn 11642: Inputs: 7
1.1136 raeburn 11643: 1. username or coursenum
1.1135 raeburn 11644: 2. domain
1.1136 raeburn 11645: 3. context ('author' or 'course')
1.1135 raeburn 11646: 4. filename of file for which action is being requested
11647: 5. filesize (kB) of file
11648: 6. action being taken: copy or upload.
1.1237 raeburn 11649: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11650:
11651: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11652: otherwise return null.
11653:
11654: =back
1.1135 raeburn 11655:
11656: =cut
11657:
1.1136 raeburn 11658: sub excess_filesize_warning {
1.1165 raeburn 11659: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11660: my $current_disk_usage = 0;
1.1165 raeburn 11661: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11662: if ($context eq 'author') {
11663: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11664: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11665: } else {
11666: foreach my $subdir ('docs','supplemental') {
11667: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11668: }
11669: }
1.1135 raeburn 11670: $disk_quota = int($disk_quota * 1000);
11671: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11672: return '<p class="LC_warning">'.
1.1135 raeburn 11673: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11674: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11675: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11676: $disk_quota,$current_disk_usage).
11677: '</p>';
11678: }
11679: return;
11680: }
11681:
11682: ###############################################
11683:
11684:
1.1136 raeburn 11685:
11686:
1.384 raeburn 11687: sub get_secgrprole_info {
11688: my ($cdom,$cnum,$needroles,$type) = @_;
11689: my %sections_count = &get_sections($cdom,$cnum);
11690: my @sections = (sort {$a <=> $b} keys(%sections_count));
11691: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11692: my @groups = sort(keys(%curr_groups));
11693: my $allroles = [];
11694: my $rolehash;
11695: my $accesshash = {
11696: active => 'Currently has access',
11697: future => 'Will have future access',
11698: previous => 'Previously had access',
11699: };
11700: if ($needroles) {
11701: $rolehash = {'all' => 'all'};
1.385 albertel 11702: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11703: if (&Apache::lonnet::error(%user_roles)) {
11704: undef(%user_roles);
11705: }
11706: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11707: my ($role)=split(/\:/,$item,2);
11708: if ($role eq 'cr') { next; }
11709: if ($role =~ /^cr/) {
11710: $$rolehash{$role} = (split('/',$role))[3];
11711: } else {
11712: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11713: }
11714: }
11715: foreach my $key (sort(keys(%{$rolehash}))) {
11716: push(@{$allroles},$key);
11717: }
11718: push (@{$allroles},'st');
11719: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11720: }
11721: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11722: }
11723:
1.555 raeburn 11724: sub user_picker {
1.1279 raeburn 11725: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11726: my $currdom = $dom;
1.1253 raeburn 11727: my @alldoms = &Apache::lonnet::all_domains();
11728: if (@alldoms == 1) {
11729: my %domsrch = &Apache::lonnet::get_dom('configuration',
11730: ['directorysrch'],$alldoms[0]);
11731: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11732: my $showdom = $domdesc;
11733: if ($showdom eq '') {
11734: $showdom = $dom;
11735: }
11736: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11737: if ((!$domsrch{'directorysrch'}{'available'}) &&
11738: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11739: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11740: }
11741: }
11742: }
1.555 raeburn 11743: my %curr_selected = (
11744: srchin => 'dom',
1.580 raeburn 11745: srchby => 'lastname',
1.555 raeburn 11746: );
11747: my $srchterm;
1.625 raeburn 11748: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11749: if ($srch->{'srchby'} ne '') {
11750: $curr_selected{'srchby'} = $srch->{'srchby'};
11751: }
11752: if ($srch->{'srchin'} ne '') {
11753: $curr_selected{'srchin'} = $srch->{'srchin'};
11754: }
11755: if ($srch->{'srchtype'} ne '') {
11756: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11757: }
11758: if ($srch->{'srchdomain'} ne '') {
11759: $currdom = $srch->{'srchdomain'};
11760: }
11761: $srchterm = $srch->{'srchterm'};
11762: }
1.1222 damieng 11763: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11764: 'usr' => 'Search criteria',
1.563 raeburn 11765: 'doma' => 'Domain/institution to search',
1.558 albertel 11766: 'uname' => 'username',
11767: 'lastname' => 'last name',
1.555 raeburn 11768: 'lastfirst' => 'last name, first name',
1.558 albertel 11769: 'crs' => 'in this course',
1.576 raeburn 11770: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11771: 'alc' => 'all LON-CAPA',
1.573 raeburn 11772: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11773: 'exact' => 'is',
11774: 'contains' => 'contains',
1.569 raeburn 11775: 'begins' => 'begins with',
1.1222 damieng 11776: );
11777: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11778: 'youm' => "You must include some text to search for.",
11779: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11780: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11781: 'yomc' => "You must choose a domain when using an institutional directory search.",
11782: 'ymcd' => "You must choose a domain when using a domain search.",
11783: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11784: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11785: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11786: );
1.1222 damieng 11787: &html_escape(\%html_lt);
11788: &js_escape(\%js_lt);
1.1255 raeburn 11789: my $domform;
1.1277 raeburn 11790: my $allow_blank = 1;
1.1255 raeburn 11791: if ($fixeddom) {
1.1277 raeburn 11792: $allow_blank = 0;
11793: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11794: } else {
1.1287 raeburn 11795: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11796: my ($trusted,$untrusted);
1.1287 raeburn 11797: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11798: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11799: } elsif ($context eq 'author') {
1.1288 raeburn 11800: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11801: } elsif ($context eq 'domain') {
1.1288 raeburn 11802: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11803: }
1.1288 raeburn 11804: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11805: }
1.563 raeburn 11806: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11807:
11808: my @srchins = ('crs','dom','alc','instd');
11809:
11810: foreach my $option (@srchins) {
11811: # FIXME 'alc' option unavailable until
11812: # loncreateuser::print_user_query_page()
11813: # has been completed.
11814: next if ($option eq 'alc');
1.880 raeburn 11815: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11816: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11817: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11818: if ($curr_selected{'srchin'} eq $option) {
11819: $srchinsel .= '
1.1222 damieng 11820: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11821: } else {
11822: $srchinsel .= '
1.1222 damieng 11823: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11824: }
1.555 raeburn 11825: }
1.563 raeburn 11826: $srchinsel .= "\n </select>\n";
1.555 raeburn 11827:
11828: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11829: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11830: if ($curr_selected{'srchby'} eq $option) {
11831: $srchbysel .= '
1.1222 damieng 11832: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11833: } else {
11834: $srchbysel .= '
1.1222 damieng 11835: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11836: }
11837: }
11838: $srchbysel .= "\n </select>\n";
11839:
11840: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11841: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11842: if ($curr_selected{'srchtype'} eq $option) {
11843: $srchtypesel .= '
1.1222 damieng 11844: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11845: } else {
11846: $srchtypesel .= '
1.1222 damieng 11847: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11848: }
11849: }
11850: $srchtypesel .= "\n </select>\n";
11851:
1.558 albertel 11852: my ($newuserscript,$new_user_create);
1.994 raeburn 11853: my $context_dom = $env{'request.role.domain'};
11854: if ($context eq 'requestcrs') {
11855: if ($env{'form.coursedom'} ne '') {
11856: $context_dom = $env{'form.coursedom'};
11857: }
11858: }
1.556 raeburn 11859: if ($forcenewuser) {
1.576 raeburn 11860: if (ref($srch) eq 'HASH') {
1.994 raeburn 11861: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11862: if ($cancreate) {
11863: $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>';
11864: } else {
1.799 bisitz 11865: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11866: my %usertypetext = (
11867: official => 'institutional',
11868: unofficial => 'non-institutional',
11869: );
1.799 bisitz 11870: $new_user_create = '<p class="LC_warning">'
11871: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11872: .' '
11873: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11874: ,'<a href="'.$helplink.'">','</a>')
11875: .'</p><br />';
1.627 raeburn 11876: }
1.576 raeburn 11877: }
11878: }
11879:
1.556 raeburn 11880: $newuserscript = <<"ENDSCRIPT";
11881:
1.570 raeburn 11882: function setSearch(createnew,callingForm) {
1.556 raeburn 11883: if (createnew == 1) {
1.570 raeburn 11884: for (var i=0; i<callingForm.srchby.length; i++) {
11885: if (callingForm.srchby.options[i].value == 'uname') {
11886: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11887: }
11888: }
1.570 raeburn 11889: for (var i=0; i<callingForm.srchin.length; i++) {
11890: if ( callingForm.srchin.options[i].value == 'dom') {
11891: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11892: }
11893: }
1.570 raeburn 11894: for (var i=0; i<callingForm.srchtype.length; i++) {
11895: if (callingForm.srchtype.options[i].value == 'exact') {
11896: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11897: }
11898: }
1.570 raeburn 11899: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11900: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11901: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11902: }
11903: }
11904: }
11905: }
11906: ENDSCRIPT
1.558 albertel 11907:
1.556 raeburn 11908: }
11909:
1.555 raeburn 11910: my $output = <<"END_BLOCK";
1.556 raeburn 11911: <script type="text/javascript">
1.824 bisitz 11912: // <![CDATA[
1.570 raeburn 11913: function validateEntry(callingForm) {
1.558 albertel 11914:
1.556 raeburn 11915: var checkok = 1;
1.558 albertel 11916: var srchin;
1.570 raeburn 11917: for (var i=0; i<callingForm.srchin.length; i++) {
11918: if ( callingForm.srchin[i].checked ) {
11919: srchin = callingForm.srchin[i].value;
1.558 albertel 11920: }
11921: }
11922:
1.570 raeburn 11923: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11924: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11925: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11926: var srchterm = callingForm.srchterm.value;
11927: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11928: var msg = "";
11929:
11930: if (srchterm == "") {
11931: checkok = 0;
1.1222 damieng 11932: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11933: }
11934:
1.569 raeburn 11935: if (srchtype== 'begins') {
11936: if (srchterm.length < 2) {
11937: checkok = 0;
1.1222 damieng 11938: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11939: }
11940: }
11941:
1.556 raeburn 11942: if (srchtype== 'contains') {
11943: if (srchterm.length < 3) {
11944: checkok = 0;
1.1222 damieng 11945: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11946: }
11947: }
11948: if (srchin == 'instd') {
11949: if (srchdomain == '') {
11950: checkok = 0;
1.1222 damieng 11951: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11952: }
11953: }
11954: if (srchin == 'dom') {
11955: if (srchdomain == '') {
11956: checkok = 0;
1.1222 damieng 11957: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11958: }
11959: }
11960: if (srchby == 'lastfirst') {
11961: if (srchterm.indexOf(",") == -1) {
11962: checkok = 0;
1.1222 damieng 11963: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11964: }
11965: if (srchterm.indexOf(",") == srchterm.length -1) {
11966: checkok = 0;
1.1222 damieng 11967: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11968: }
11969: }
11970: if (checkok == 0) {
1.1222 damieng 11971: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11972: return;
11973: }
11974: if (checkok == 1) {
1.570 raeburn 11975: callingForm.submit();
1.556 raeburn 11976: }
11977: }
11978:
11979: $newuserscript
11980:
1.824 bisitz 11981: // ]]>
1.556 raeburn 11982: </script>
1.558 albertel 11983:
11984: $new_user_create
11985:
1.555 raeburn 11986: END_BLOCK
1.558 albertel 11987:
1.876 raeburn 11988: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11989: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11990: $domform.
11991: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11992: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11993: $srchbysel.
11994: $srchtypesel.
11995: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11996: $srchinsel.
11997: &Apache::lonhtmlcommon::row_closure(1).
11998: &Apache::lonhtmlcommon::end_pick_box().
11999: '<br />';
1.1253 raeburn 12000: return ($output,1);
1.555 raeburn 12001: }
12002:
1.612 raeburn 12003: sub user_rule_check {
1.615 raeburn 12004: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 12005: my ($response,%inst_response);
1.612 raeburn 12006: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 12007: if (keys(%{$usershash}) > 1) {
12008: my (%by_username,%by_id,%userdoms);
12009: my $checkid;
12010: if (ref($checks) eq 'HASH') {
12011: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
12012: $checkid = 1;
12013: }
12014: }
12015: foreach my $user (keys(%{$usershash})) {
12016: my ($uname,$udom) = split(/:/,$user);
12017: if ($checkid) {
12018: if (ref($usershash->{$user}) eq 'HASH') {
12019: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 12020: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 12021: $userdoms{$udom} = 1;
1.1227 raeburn 12022: if (ref($inst_results) eq 'HASH') {
12023: $inst_results->{$uname.':'.$udom} = {};
12024: }
1.1226 raeburn 12025: }
12026: }
12027: } else {
12028: $by_username{$udom}{$uname} = 1;
12029: $userdoms{$udom} = 1;
1.1227 raeburn 12030: if (ref($inst_results) eq 'HASH') {
12031: $inst_results->{$uname.':'.$udom} = {};
12032: }
1.1226 raeburn 12033: }
12034: }
12035: foreach my $udom (keys(%userdoms)) {
12036: if (!$got_rules->{$udom}) {
12037: my %domconfig = &Apache::lonnet::get_dom('configuration',
12038: ['usercreation'],$udom);
12039: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12040: foreach my $item ('username','id') {
12041: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 12042: $$curr_rules{$udom}{$item} =
12043: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 12044: }
12045: }
12046: }
12047: $got_rules->{$udom} = 1;
12048: }
1.612 raeburn 12049: }
1.1226 raeburn 12050: if ($checkid) {
12051: foreach my $udom (keys(%by_id)) {
12052: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12053: if ($outcome eq 'ok') {
1.1227 raeburn 12054: foreach my $id (keys(%{$by_id{$udom}})) {
12055: my $uname = $by_id{$udom}{$id};
12056: $inst_response{$uname.':'.$udom} = $outcome;
12057: }
1.1226 raeburn 12058: if (ref($results) eq 'HASH') {
12059: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12060: if (exists($inst_response{$uname.':'.$udom})) {
12061: $inst_response{$uname.':'.$udom} = $outcome;
12062: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12063: }
1.1226 raeburn 12064: }
12065: }
12066: }
1.612 raeburn 12067: }
1.615 raeburn 12068: } else {
1.1226 raeburn 12069: foreach my $udom (keys(%by_username)) {
12070: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12071: if ($outcome eq 'ok') {
1.1227 raeburn 12072: foreach my $uname (keys(%{$by_username{$udom}})) {
12073: $inst_response{$uname.':'.$udom} = $outcome;
12074: }
1.1226 raeburn 12075: if (ref($results) eq 'HASH') {
12076: foreach my $uname (keys(%{$results})) {
12077: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12078: }
12079: }
12080: }
12081: }
1.612 raeburn 12082: }
1.1226 raeburn 12083: } elsif (keys(%{$usershash}) == 1) {
12084: my $user = (keys(%{$usershash}))[0];
12085: my ($uname,$udom) = split(/:/,$user);
12086: if (($udom ne '') && ($uname ne '')) {
12087: if (ref($usershash->{$user}) eq 'HASH') {
12088: if (ref($checks) eq 'HASH') {
12089: if (defined($checks->{'username'})) {
12090: ($inst_response{$user},%{$inst_results->{$user}}) =
12091: &Apache::lonnet::get_instuser($udom,$uname);
12092: } elsif (defined($checks->{'id'})) {
12093: if ($usershash->{$user}->{'id'} ne '') {
12094: ($inst_response{$user},%{$inst_results->{$user}}) =
12095: &Apache::lonnet::get_instuser($udom,undef,
12096: $usershash->{$user}->{'id'});
12097: } else {
12098: ($inst_response{$user},%{$inst_results->{$user}}) =
12099: &Apache::lonnet::get_instuser($udom,$uname);
12100: }
1.585 raeburn 12101: }
1.1226 raeburn 12102: } else {
12103: ($inst_response{$user},%{$inst_results->{$user}}) =
12104: &Apache::lonnet::get_instuser($udom,$uname);
12105: return;
12106: }
12107: if (!$got_rules->{$udom}) {
12108: my %domconfig = &Apache::lonnet::get_dom('configuration',
12109: ['usercreation'],$udom);
12110: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12111: foreach my $item ('username','id') {
12112: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12113: $$curr_rules{$udom}{$item} =
12114: $domconfig{'usercreation'}{$item.'_rule'};
12115: }
12116: }
12117: }
12118: $got_rules->{$udom} = 1;
1.585 raeburn 12119: }
12120: }
1.1226 raeburn 12121: } else {
12122: return;
12123: }
12124: } else {
12125: return;
12126: }
12127: foreach my $user (keys(%{$usershash})) {
12128: my ($uname,$udom) = split(/:/,$user);
12129: next if (($udom eq '') || ($uname eq ''));
12130: my $id;
1.1227 raeburn 12131: if (ref($inst_results) eq 'HASH') {
12132: if (ref($inst_results->{$user}) eq 'HASH') {
12133: $id = $inst_results->{$user}->{'id'};
12134: }
12135: }
12136: if ($id eq '') {
12137: if (ref($usershash->{$user})) {
12138: $id = $usershash->{$user}->{'id'};
12139: }
1.585 raeburn 12140: }
1.612 raeburn 12141: foreach my $item (keys(%{$checks})) {
12142: if (ref($$curr_rules{$udom}) eq 'HASH') {
12143: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12144: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12145: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12146: $$curr_rules{$udom}{$item});
1.612 raeburn 12147: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12148: if ($rule_check{$rule}) {
12149: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12150: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12151: if (ref($inst_results) eq 'HASH') {
12152: if (ref($inst_results->{$user}) eq 'HASH') {
12153: if (keys(%{$inst_results->{$user}}) == 0) {
12154: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12155: } elsif ($item eq 'id') {
12156: if ($inst_results->{$user}->{'id'} eq '') {
12157: $$alerts{$item}{$udom}{$uname} = 1;
12158: }
1.615 raeburn 12159: }
1.612 raeburn 12160: }
12161: }
1.615 raeburn 12162: }
12163: last;
1.585 raeburn 12164: }
12165: }
12166: }
12167: }
12168: }
12169: }
12170: }
12171: }
1.612 raeburn 12172: return;
12173: }
12174:
12175: sub user_rule_formats {
12176: my ($domain,$domdesc,$curr_rules,$check) = @_;
12177: my %text = (
12178: 'username' => 'Usernames',
12179: 'id' => 'IDs',
12180: );
12181: my $output;
12182: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12183: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12184: if (@{$ruleorder} > 0) {
1.1102 raeburn 12185: $output = '<br />'.
12186: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12187: '<span class="LC_cusr_emph">','</span>',$domdesc).
12188: ' <ul>';
1.612 raeburn 12189: foreach my $rule (@{$ruleorder}) {
12190: if (ref($curr_rules) eq 'ARRAY') {
12191: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12192: if (ref($rules->{$rule}) eq 'HASH') {
12193: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12194: $rules->{$rule}{'desc'}.'</li>';
12195: }
12196: }
12197: }
12198: }
12199: $output .= '</ul>';
12200: }
12201: }
12202: return $output;
12203: }
12204:
12205: sub instrule_disallow_msg {
1.615 raeburn 12206: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12207: my $response;
12208: my %text = (
12209: item => 'username',
12210: items => 'usernames',
12211: match => 'matches',
12212: do => 'does',
12213: action => 'a username',
12214: one => 'one',
12215: );
12216: if ($count > 1) {
12217: $text{'item'} = 'usernames';
12218: $text{'match'} ='match';
12219: $text{'do'} = 'do';
12220: $text{'action'} = 'usernames',
12221: $text{'one'} = 'ones';
12222: }
12223: if ($checkitem eq 'id') {
12224: $text{'items'} = 'IDs';
12225: $text{'item'} = 'ID';
12226: $text{'action'} = 'an ID';
1.615 raeburn 12227: if ($count > 1) {
12228: $text{'item'} = 'IDs';
12229: $text{'action'} = 'IDs';
12230: }
1.612 raeburn 12231: }
1.674 bisitz 12232: $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 12233: if ($mode eq 'upload') {
12234: if ($checkitem eq 'username') {
12235: $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'}.");
12236: } elsif ($checkitem eq 'id') {
1.674 bisitz 12237: $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 12238: }
1.669 raeburn 12239: } elsif ($mode eq 'selfcreate') {
12240: if ($checkitem eq 'id') {
12241: $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.");
12242: }
1.615 raeburn 12243: } else {
12244: if ($checkitem eq 'username') {
12245: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12246: } elsif ($checkitem eq 'id') {
12247: $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.");
12248: }
1.612 raeburn 12249: }
12250: return $response;
1.585 raeburn 12251: }
12252:
1.624 raeburn 12253: sub personal_data_fieldtitles {
12254: my %fieldtitles = &Apache::lonlocal::texthash (
12255: id => 'Student/Employee ID',
12256: permanentemail => 'E-mail address',
12257: lastname => 'Last Name',
12258: firstname => 'First Name',
12259: middlename => 'Middle Name',
12260: generation => 'Generation',
12261: gen => 'Generation',
1.765 raeburn 12262: inststatus => 'Affiliation',
1.624 raeburn 12263: );
12264: return %fieldtitles;
12265: }
12266:
1.642 raeburn 12267: sub sorted_inst_types {
12268: my ($dom) = @_;
1.1185 raeburn 12269: my ($usertypes,$order);
12270: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12271: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12272: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12273: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12274: } else {
12275: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12276: }
1.642 raeburn 12277: my $othertitle = &mt('All users');
12278: if ($env{'request.course.id'}) {
1.668 raeburn 12279: $othertitle = &mt('Any users');
1.642 raeburn 12280: }
12281: my @types;
12282: if (ref($order) eq 'ARRAY') {
12283: @types = @{$order};
12284: }
12285: if (@types == 0) {
12286: if (ref($usertypes) eq 'HASH') {
12287: @types = sort(keys(%{$usertypes}));
12288: }
12289: }
12290: if (keys(%{$usertypes}) > 0) {
12291: $othertitle = &mt('Other users');
12292: }
12293: return ($othertitle,$usertypes,\@types);
12294: }
12295:
1.645 raeburn 12296: sub get_institutional_codes {
1.1361 raeburn 12297: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12298: # Get complete list of course sections to update
12299: my @currsections = ();
12300: my @currxlists = ();
1.1361 raeburn 12301: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12302: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12303: my $crskey = $crs.':'.$coursecode;
12304: @{$unclutteredsec{$crskey}} = ();
12305: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12306:
12307: if ($$settings{'internal.sectionnums'} ne '') {
12308: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12309: }
12310:
12311: if ($$settings{'internal.crosslistings'} ne '') {
12312: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12313: }
12314:
12315: if (@currxlists > 0) {
1.1361 raeburn 12316: foreach my $xl (@currxlists) {
12317: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12318: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12319: push(@{$allcourses},$1);
1.645 raeburn 12320: $$LC_code{$1} = $2;
12321: }
12322: }
12323: }
12324: }
1.1361 raeburn 12325:
1.645 raeburn 12326: if (@currsections > 0) {
1.1361 raeburn 12327: foreach my $sec (@currsections) {
12328: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12329: my $instsec = $1;
1.645 raeburn 12330: my $lc_sec = $2;
1.1361 raeburn 12331: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12332: push(@{$unclutteredsec{$crskey}},$instsec);
12333: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12334: }
12335: }
12336: }
12337: }
12338:
12339: if (@{$unclutteredsec{$crskey}} > 0) {
12340: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12341: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12342: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12343: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12344: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12345: push(@{$allcourses},$sec);
1.1361 raeburn 12346: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12347: }
12348: }
12349: }
12350: }
12351: return;
12352: }
12353:
1.971 raeburn 12354: sub get_standard_codeitems {
12355: return ('Year','Semester','Department','Number','Section');
12356: }
12357:
1.112 bowersj2 12358: =pod
12359:
1.780 raeburn 12360: =head1 Slot Helpers
12361:
12362: =over 4
12363:
12364: =item * sorted_slots()
12365:
1.1040 raeburn 12366: Sorts an array of slot names in order of an optional sort key,
12367: default sort is by slot start time (earliest first).
1.780 raeburn 12368:
12369: Inputs:
12370:
12371: =over 4
12372:
12373: slotsarr - Reference to array of unsorted slot names.
12374:
12375: slots - Reference to hash of hash, where outer hash keys are slot names.
12376:
1.1040 raeburn 12377: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12378:
1.549 albertel 12379: =back
12380:
1.780 raeburn 12381: Returns:
12382:
12383: =over 4
12384:
1.1040 raeburn 12385: sorted - An array of slot names sorted by a specified sort key
12386: (default sort key is start time of the slot).
1.780 raeburn 12387:
12388: =back
12389:
12390: =cut
12391:
12392:
12393: sub sorted_slots {
1.1040 raeburn 12394: my ($slotsarr,$slots,$sortkey) = @_;
12395: if ($sortkey eq '') {
12396: $sortkey = 'starttime';
12397: }
1.780 raeburn 12398: my @sorted;
12399: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12400: @sorted =
12401: sort {
12402: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12403: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12404: }
12405: if (ref($slots->{$a})) { return -1;}
12406: if (ref($slots->{$b})) { return 1;}
12407: return 0;
12408: } @{$slotsarr};
12409: }
12410: return @sorted;
12411: }
12412:
1.1040 raeburn 12413: =pod
12414:
12415: =item * get_future_slots()
12416:
12417: Inputs:
12418:
12419: =over 4
12420:
12421: cnum - course number
12422:
12423: cdom - course domain
12424:
12425: now - current UNIX time
12426:
12427: symb - optional symb
12428:
12429: =back
12430:
12431: Returns:
12432:
12433: =over 4
12434:
12435: sorted_reservable - ref to array of student_schedulable slots currently
12436: reservable, ordered by end date of reservation period.
12437:
12438: reservable_now - ref to hash of student_schedulable slots currently
12439: reservable.
12440:
12441: Keys in inner hash are:
12442: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12443: (b) endreserve: end date of reservation period.
12444: (c) uniqueperiod: start,end dates when slot is to be uniquely
12445: selected.
1.1040 raeburn 12446:
12447: sorted_future - ref to array of student_schedulable slots reservable in
12448: the future, ordered by start date of reservation period.
12449:
12450: future_reservable - ref to hash of student_schedulable slots reservable
12451: in the future.
12452:
12453: Keys in inner hash are:
12454: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12455: (b) startreserve: start date of reservation period.
12456: (c) uniqueperiod: start,end dates when slot is to be uniquely
12457: selected.
1.1040 raeburn 12458:
12459: =back
12460:
12461: =cut
12462:
12463: sub get_future_slots {
12464: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12465: my $map;
12466: if ($symb) {
12467: ($map) = &Apache::lonnet::decode_symb($symb);
12468: }
1.1040 raeburn 12469: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12470: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12471: foreach my $slot (keys(%slots)) {
12472: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12473: if ($symb) {
1.1229 raeburn 12474: if ($slots{$slot}->{'symb'} ne '') {
12475: my $canuse;
12476: my %oksymbs;
12477: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12478: map { $oksymbs{$_} = 1; } @slotsymbs;
12479: if ($oksymbs{$symb}) {
12480: $canuse = 1;
12481: } else {
12482: foreach my $item (@slotsymbs) {
12483: if ($item =~ /\.(page|sequence)$/) {
12484: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12485: if (($map ne '') && ($map eq $sloturl)) {
12486: $canuse = 1;
12487: last;
12488: }
12489: }
12490: }
12491: }
12492: next unless ($canuse);
12493: }
1.1040 raeburn 12494: }
12495: if (($slots{$slot}->{'starttime'} > $now) &&
12496: ($slots{$slot}->{'endtime'} > $now)) {
12497: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12498: my $userallowed = 0;
12499: if ($slots{$slot}->{'allowedsections'}) {
12500: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12501: if (!defined($env{'request.role.sec'})
12502: && grep(/^No section assigned$/,@allowed_sec)) {
12503: $userallowed=1;
12504: } else {
12505: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12506: $userallowed=1;
12507: }
12508: }
12509: unless ($userallowed) {
12510: if (defined($env{'request.course.groups'})) {
12511: my @groups = split(/:/,$env{'request.course.groups'});
12512: foreach my $group (@groups) {
12513: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12514: $userallowed=1;
12515: last;
12516: }
12517: }
12518: }
12519: }
12520: }
12521: if ($slots{$slot}->{'allowedusers'}) {
12522: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12523: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12524: if (grep(/^\Q$user\E$/,@allowed_users)) {
12525: $userallowed = 1;
12526: }
12527: }
12528: next unless($userallowed);
12529: }
12530: my $startreserve = $slots{$slot}->{'startreserve'};
12531: my $endreserve = $slots{$slot}->{'endreserve'};
12532: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12533: my $uniqueperiod;
12534: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12535: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12536: }
1.1040 raeburn 12537: if (($startreserve < $now) &&
12538: (!$endreserve || $endreserve > $now)) {
12539: my $lastres = $endreserve;
12540: if (!$lastres) {
12541: $lastres = $slots{$slot}->{'starttime'};
12542: }
12543: $reservable_now{$slot} = {
12544: symb => $symb,
1.1250 raeburn 12545: endreserve => $lastres,
12546: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12547: };
12548: } elsif (($startreserve > $now) &&
12549: (!$endreserve || $endreserve > $startreserve)) {
12550: $future_reservable{$slot} = {
12551: symb => $symb,
1.1250 raeburn 12552: startreserve => $startreserve,
12553: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12554: };
12555: }
12556: }
12557: }
12558: my @unsorted_reservable = keys(%reservable_now);
12559: if (@unsorted_reservable > 0) {
12560: @sorted_reservable =
12561: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12562: }
12563: my @unsorted_future = keys(%future_reservable);
12564: if (@unsorted_future > 0) {
12565: @sorted_future =
12566: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12567: }
12568: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12569: }
1.780 raeburn 12570:
12571: =pod
12572:
1.1057 foxr 12573: =back
12574:
1.549 albertel 12575: =head1 HTTP Helpers
12576:
12577: =over 4
12578:
1.648 raeburn 12579: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12580:
1.258 albertel 12581: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12582: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12583: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12584:
12585: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12586: $possible_names is an ref to an array of form element names. As an example:
12587: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12588: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12589:
12590: =cut
1.1 albertel 12591:
1.6 albertel 12592: sub get_unprocessed_cgi {
1.25 albertel 12593: my ($query,$possible_names)= @_;
1.26 matthew 12594: # $Apache::lonxml::debug=1;
1.356 albertel 12595: foreach my $pair (split(/&/,$query)) {
12596: my ($name, $value) = split(/=/,$pair);
1.369 www 12597: $name = &unescape($name);
1.25 albertel 12598: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12599: $value =~ tr/+/ /;
12600: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12601: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12602: }
1.16 harris41 12603: }
1.6 albertel 12604: }
12605:
1.112 bowersj2 12606: =pod
12607:
1.648 raeburn 12608: =item * &cacheheader()
1.112 bowersj2 12609:
12610: returns cache-controlling header code
12611:
12612: =cut
12613:
1.7 albertel 12614: sub cacheheader {
1.258 albertel 12615: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12616: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12617: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12618: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12619: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12620: return $output;
1.7 albertel 12621: }
12622:
1.112 bowersj2 12623: =pod
12624:
1.648 raeburn 12625: =item * &no_cache($r)
1.112 bowersj2 12626:
12627: specifies header code to not have cache
12628:
12629: =cut
12630:
1.9 albertel 12631: sub no_cache {
1.216 albertel 12632: my ($r) = @_;
12633: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12634: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12635: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12636: $r->no_cache(1);
12637: $r->header_out("Expires" => $date);
12638: $r->header_out("Pragma" => "no-cache");
1.123 www 12639: }
12640:
12641: sub content_type {
1.181 albertel 12642: my ($r,$type,$charset) = @_;
1.299 foxr 12643: if ($r) {
12644: # Note that printout.pl calls this with undef for $r.
12645: &no_cache($r);
12646: }
1.258 albertel 12647: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12648: unless ($charset) {
12649: $charset=&Apache::lonlocal::current_encoding;
12650: }
12651: if ($charset) { $type.='; charset='.$charset; }
12652: if ($r) {
12653: $r->content_type($type);
12654: } else {
12655: print("Content-type: $type\n\n");
12656: }
1.9 albertel 12657: }
1.25 albertel 12658:
1.112 bowersj2 12659: =pod
12660:
1.648 raeburn 12661: =item * &add_to_env($name,$value)
1.112 bowersj2 12662:
1.258 albertel 12663: adds $name to the %env hash with value
1.112 bowersj2 12664: $value, if $name already exists, the entry is converted to an array
12665: reference and $value is added to the array.
12666:
12667: =cut
12668:
1.25 albertel 12669: sub add_to_env {
12670: my ($name,$value)=@_;
1.258 albertel 12671: if (defined($env{$name})) {
12672: if (ref($env{$name})) {
1.25 albertel 12673: #already have multiple values
1.258 albertel 12674: push(@{ $env{$name} },$value);
1.25 albertel 12675: } else {
12676: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12677: my $first=$env{$name};
12678: undef($env{$name});
12679: push(@{ $env{$name} },$first,$value);
1.25 albertel 12680: }
12681: } else {
1.258 albertel 12682: $env{$name}=$value;
1.25 albertel 12683: }
1.31 albertel 12684: }
1.149 albertel 12685:
12686: =pod
12687:
1.648 raeburn 12688: =item * &get_env_multiple($name)
1.149 albertel 12689:
1.258 albertel 12690: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12691: values may be defined and end up as an array ref.
12692:
12693: returns an array of values
12694:
12695: =cut
12696:
12697: sub get_env_multiple {
12698: my ($name) = @_;
12699: my @values;
1.258 albertel 12700: if (defined($env{$name})) {
1.149 albertel 12701: # exists is it an array
1.258 albertel 12702: if (ref($env{$name})) {
12703: @values=@{ $env{$name} };
1.149 albertel 12704: } else {
1.258 albertel 12705: $values[0]=$env{$name};
1.149 albertel 12706: }
12707: }
12708: return(@values);
12709: }
12710:
1.1249 damieng 12711: # Looks at given dependencies, and returns something depending on the context.
12712: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12713: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12714: # For all other contexts, returns ($output, $counter, $numpathchg).
12715: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12716: # $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.
12717: # $numpathchg: integer with the number of cleaned up dependency paths.
12718: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12719: # \%mapping: hash reference clean path -> original path for all dependencies.
12720: # @param {string} actionurl - The path to the handler, indicative of the context.
12721: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12722: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12723: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12724: # @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)
12725: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12726: sub ask_for_embedded_content {
1.1249 damieng 12727: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12728: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12729: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12730: %currsubfile,%unused,$rem);
1.1071 raeburn 12731: my $counter = 0;
12732: my $numnew = 0;
1.987 raeburn 12733: my $numremref = 0;
12734: my $numinvalid = 0;
12735: my $numpathchg = 0;
12736: my $numexisting = 0;
1.1071 raeburn 12737: my $numunused = 0;
12738: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12739: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12740: my $heading = &mt('Upload embedded files');
12741: my $buttontext = &mt('Upload');
12742:
1.1249 damieng 12743: # fills these variables based on the context:
12744: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12745: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12746: if ($env{'request.course.id'}) {
1.1123 raeburn 12747: if ($actionurl eq '/adm/dependencies') {
12748: $navmap = Apache::lonnavmaps::navmap->new();
12749: }
12750: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12751: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12752: }
1.1123 raeburn 12753: if (($actionurl eq '/adm/portfolio') ||
12754: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12755: my $current_path='/';
12756: if ($env{'form.currentpath'}) {
12757: $current_path = $env{'form.currentpath'};
12758: }
12759: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12760: $udom = $cdom;
12761: $uname = $cnum;
1.984 raeburn 12762: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12763: } else {
12764: $udom = $env{'user.domain'};
12765: $uname = $env{'user.name'};
12766: $url = '/userfiles/portfolio';
12767: }
1.987 raeburn 12768: $toplevel = $url.'/';
1.984 raeburn 12769: $url .= $current_path;
12770: $getpropath = 1;
1.987 raeburn 12771: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12772: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12773: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12774: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12775: $toplevel = $url;
1.984 raeburn 12776: if ($rest ne '') {
1.987 raeburn 12777: $url .= $rest;
12778: }
12779: } elsif ($actionurl eq '/adm/coursedocs') {
12780: if (ref($args) eq 'HASH') {
1.1071 raeburn 12781: $url = $args->{'docs_url'};
12782: $toplevel = $url;
1.1084 raeburn 12783: if ($args->{'context'} eq 'paste') {
12784: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12785: ($path) =
12786: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12787: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12788: $fileloc =~ s{^/}{};
12789: }
1.1071 raeburn 12790: }
1.1084 raeburn 12791: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12792: if ($env{'request.course.id'} ne '') {
12793: if (ref($args) eq 'HASH') {
12794: $url = $args->{'docs_url'};
12795: $title = $args->{'docs_title'};
1.1126 raeburn 12796: $toplevel = $url;
12797: unless ($toplevel =~ m{^/}) {
12798: $toplevel = "/$url";
12799: }
1.1085 raeburn 12800: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12801: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12802: $path = $1;
12803: } else {
12804: ($path) =
12805: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12806: }
1.1195 raeburn 12807: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12808: $fileloc = $toplevel;
12809: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12810: my ($udom,$uname,$fname) =
12811: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12812: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12813: } else {
12814: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12815: }
1.1071 raeburn 12816: $fileloc =~ s{^/}{};
12817: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12818: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12819: }
1.987 raeburn 12820: }
1.1123 raeburn 12821: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12822: $udom = $cdom;
12823: $uname = $cnum;
12824: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12825: $toplevel = $url;
12826: $path = $url;
12827: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12828: $fileloc =~ s{^/}{};
1.987 raeburn 12829: }
1.1249 damieng 12830:
12831: # parses the dependency paths to get some info
12832: # fills $newfiles, $mapping, $subdependencies, $dependencies
12833: # $newfiles: hash URL -> 1 for new files or external URLs
12834: # (will be completed later)
12835: # $mapping:
12836: # for external URLs: external URL -> external URL
12837: # for relative paths: clean path -> original path
12838: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12839: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12840: foreach my $file (keys(%{$allfiles})) {
12841: my $embed_file;
12842: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12843: $embed_file = $1;
12844: } else {
12845: $embed_file = $file;
12846: }
1.1158 raeburn 12847: my ($absolutepath,$cleaned_file);
12848: if ($embed_file =~ m{^\w+://}) {
12849: $cleaned_file = $embed_file;
1.1147 raeburn 12850: $newfiles{$cleaned_file} = 1;
12851: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12852: } else {
1.1158 raeburn 12853: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12854: if ($embed_file =~ m{^/}) {
12855: $absolutepath = $embed_file;
12856: }
1.1147 raeburn 12857: if ($cleaned_file =~ m{/}) {
12858: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12859: $path = &check_for_traversal($path,$url,$toplevel);
12860: my $item = $fname;
12861: if ($path ne '') {
12862: $item = $path.'/'.$fname;
12863: $subdependencies{$path}{$fname} = 1;
12864: } else {
12865: $dependencies{$item} = 1;
12866: }
12867: if ($absolutepath) {
12868: $mapping{$item} = $absolutepath;
12869: } else {
12870: $mapping{$item} = $embed_file;
12871: }
12872: } else {
12873: $dependencies{$embed_file} = 1;
12874: if ($absolutepath) {
1.1147 raeburn 12875: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12876: } else {
1.1147 raeburn 12877: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12878: }
12879: }
1.984 raeburn 12880: }
12881: }
1.1249 damieng 12882:
12883: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12884: # and lists
12885: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12886: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12887: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12888: # the path had to be cleaned up
12889: # $existing: hash clean path -> 1 if the file exists
12890: # $numexisting: number of keys in $existing
12891: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12892: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12893: # dependency subdirectories that are
12894: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12895: my $dirptr = 16384;
1.984 raeburn 12896: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12897: $currsubfile{$path} = {};
1.1123 raeburn 12898: if (($actionurl eq '/adm/portfolio') ||
12899: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12900: my ($sublistref,$listerror) =
12901: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12902: if (ref($sublistref) eq 'ARRAY') {
12903: foreach my $line (@{$sublistref}) {
12904: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12905: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12906: }
1.984 raeburn 12907: }
1.987 raeburn 12908: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12909: if (opendir(my $dir,$url.'/'.$path)) {
12910: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12911: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12912: }
1.1084 raeburn 12913: } elsif (($actionurl eq '/adm/dependencies') ||
12914: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12915: ($args->{'context'} eq 'paste')) ||
12916: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12917: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12918: my $dir;
12919: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12920: $dir = $fileloc;
12921: } else {
12922: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12923: }
1.1071 raeburn 12924: if ($dir ne '') {
12925: my ($sublistref,$listerror) =
12926: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12927: if (ref($sublistref) eq 'ARRAY') {
12928: foreach my $line (@{$sublistref}) {
12929: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12930: undef,$mtime)=split(/\&/,$line,12);
12931: unless (($testdir&$dirptr) ||
12932: ($file_name =~ /^\.\.?$/)) {
12933: $currsubfile{$path}{$file_name} = [$size,$mtime];
12934: }
12935: }
12936: }
12937: }
1.984 raeburn 12938: }
12939: }
12940: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12941: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12942: my $item = $path.'/'.$file;
12943: unless ($mapping{$item} eq $item) {
12944: $pathchanges{$item} = 1;
12945: }
12946: $existing{$item} = 1;
12947: $numexisting ++;
12948: } else {
12949: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12950: }
12951: }
1.1071 raeburn 12952: if ($actionurl eq '/adm/dependencies') {
12953: foreach my $path (keys(%currsubfile)) {
12954: if (ref($currsubfile{$path}) eq 'HASH') {
12955: foreach my $file (keys(%{$currsubfile{$path}})) {
12956: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12957: next if (($rem ne '') &&
12958: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12959: (ref($navmap) &&
12960: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12961: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12962: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12963: $unused{$path.'/'.$file} = 1;
12964: }
12965: }
12966: }
12967: }
12968: }
1.984 raeburn 12969: }
1.1249 damieng 12970:
12971: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12972: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12973: my %currfile;
1.1123 raeburn 12974: if (($actionurl eq '/adm/portfolio') ||
12975: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12976: my ($dirlistref,$listerror) =
12977: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12978: if (ref($dirlistref) eq 'ARRAY') {
12979: foreach my $line (@{$dirlistref}) {
12980: my ($file_name,$rest) = split(/\&/,$line,2);
12981: $currfile{$file_name} = 1;
12982: }
1.984 raeburn 12983: }
1.987 raeburn 12984: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12985: if (opendir(my $dir,$url)) {
1.987 raeburn 12986: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12987: map {$currfile{$_} = 1;} @dir_list;
12988: }
1.1084 raeburn 12989: } elsif (($actionurl eq '/adm/dependencies') ||
12990: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12991: ($args->{'context'} eq 'paste')) ||
12992: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12993: if ($env{'request.course.id'} ne '') {
12994: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12995: if ($dir ne '') {
12996: my ($dirlistref,$listerror) =
12997: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12998: if (ref($dirlistref) eq 'ARRAY') {
12999: foreach my $line (@{$dirlistref}) {
13000: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
13001: $size,undef,$mtime)=split(/\&/,$line,12);
13002: unless (($testdir&$dirptr) ||
13003: ($file_name =~ /^\.\.?$/)) {
13004: $currfile{$file_name} = [$size,$mtime];
13005: }
13006: }
13007: }
13008: }
13009: }
1.984 raeburn 13010: }
1.1249 damieng 13011: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
13012: # are not in subdirectories, using $currfile
1.984 raeburn 13013: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 13014: if (exists($currfile{$file})) {
1.987 raeburn 13015: unless ($mapping{$file} eq $file) {
13016: $pathchanges{$file} = 1;
13017: }
13018: $existing{$file} = 1;
13019: $numexisting ++;
13020: } else {
1.984 raeburn 13021: $newfiles{$file} = 1;
13022: }
13023: }
1.1071 raeburn 13024: foreach my $file (keys(%currfile)) {
13025: unless (($file eq $filename) ||
13026: ($file eq $filename.'.bak') ||
13027: ($dependencies{$file})) {
1.1085 raeburn 13028: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 13029: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
13030: next if (($rem ne '') &&
13031: (($env{"httpref.$rem".$file} ne '') ||
13032: (ref($navmap) &&
13033: (($navmap->getResourceByUrl($rem.$file) ne '') ||
13034: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13035: ($navmap->getResourceByUrl($rem.$1)))))));
13036: }
1.1085 raeburn 13037: }
1.1071 raeburn 13038: $unused{$file} = 1;
13039: }
13040: }
1.1249 damieng 13041:
13042: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 13043: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
13044: ($args->{'context'} eq 'paste')) {
13045: $counter = scalar(keys(%existing));
13046: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 13047: return ($output,$counter,$numpathchg,\%existing);
13048: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
13049: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
13050: $counter = scalar(keys(%existing));
13051: $numpathchg = scalar(keys(%pathchanges));
13052: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13053: }
1.1249 damieng 13054:
13055: # returns HTML otherwise, with dependency results and to ask for more uploads
13056:
13057: # $upload_output: missing dependencies (with upload form)
13058: # $modify_output: uploaded dependencies (in use)
13059: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13060: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13061: if ($actionurl eq '/adm/dependencies') {
13062: next if ($embed_file =~ m{^\w+://});
13063: }
1.660 raeburn 13064: $upload_output .= &start_data_table_row().
1.1123 raeburn 13065: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13066: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13067: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13068: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13069: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13070: }
1.1123 raeburn 13071: $upload_output .= '</td>';
1.1071 raeburn 13072: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13073: $upload_output.='<td align="right">'.
13074: '<span class="LC_info LC_fontsize_medium">'.
13075: &mt("URL points to web address").'</span>';
1.987 raeburn 13076: $numremref++;
1.660 raeburn 13077: } elsif ($args->{'error_on_invalid_names'}
13078: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13079: $upload_output.='<td align="right"><span class="LC_warning">'.
13080: &mt('Invalid characters').'</span>';
1.987 raeburn 13081: $numinvalid++;
1.660 raeburn 13082: } else {
1.1123 raeburn 13083: $upload_output .= '<td>'.
13084: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13085: $embed_file,\%mapping,
1.1071 raeburn 13086: $allfiles,$codebase,'upload');
13087: $counter ++;
13088: $numnew ++;
1.987 raeburn 13089: }
13090: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13091: }
13092: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13093: if ($actionurl eq '/adm/dependencies') {
13094: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13095: $modify_output .= &start_data_table_row().
13096: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13097: '<img src="'.&icon($embed_file).'" border="0" />'.
13098: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13099: '<td>'.$size.'</td>'.
13100: '<td>'.$mtime.'</td>'.
13101: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13102: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13103: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13104: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13105: &embedded_file_element('upload_embedded',$counter,
13106: $embed_file,\%mapping,
13107: $allfiles,$codebase,'modify').
13108: '</div></td>'.
13109: &end_data_table_row()."\n";
13110: $counter ++;
13111: } else {
13112: $upload_output .= &start_data_table_row().
1.1123 raeburn 13113: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13114: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13115: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13116: &Apache::loncommon::end_data_table_row()."\n";
13117: }
13118: }
13119: my $delidx = $counter;
13120: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13121: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13122: $delete_output .= &start_data_table_row().
13123: '<td><img src="'.&icon($oldfile).'" />'.
13124: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13125: '<td>'.$size.'</td>'.
13126: '<td>'.$mtime.'</td>'.
13127: '<td><label><input type="checkbox" name="del_upload_dep" '.
13128: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13129: &embedded_file_element('upload_embedded',$delidx,
13130: $oldfile,\%mapping,$allfiles,
13131: $codebase,'delete').'</td>'.
13132: &end_data_table_row()."\n";
13133: $numunused ++;
13134: $delidx ++;
1.987 raeburn 13135: }
13136: if ($upload_output) {
13137: $upload_output = &start_data_table().
13138: $upload_output.
13139: &end_data_table()."\n";
13140: }
1.1071 raeburn 13141: if ($modify_output) {
13142: $modify_output = &start_data_table().
13143: &start_data_table_header_row().
13144: '<th>'.&mt('File').'</th>'.
13145: '<th>'.&mt('Size (KB)').'</th>'.
13146: '<th>'.&mt('Modified').'</th>'.
13147: '<th>'.&mt('Upload replacement?').'</th>'.
13148: &end_data_table_header_row().
13149: $modify_output.
13150: &end_data_table()."\n";
13151: }
13152: if ($delete_output) {
13153: $delete_output = &start_data_table().
13154: &start_data_table_header_row().
13155: '<th>'.&mt('File').'</th>'.
13156: '<th>'.&mt('Size (KB)').'</th>'.
13157: '<th>'.&mt('Modified').'</th>'.
13158: '<th>'.&mt('Delete?').'</th>'.
13159: &end_data_table_header_row().
13160: $delete_output.
13161: &end_data_table()."\n";
13162: }
1.987 raeburn 13163: my $applies = 0;
13164: if ($numremref) {
13165: $applies ++;
13166: }
13167: if ($numinvalid) {
13168: $applies ++;
13169: }
13170: if ($numexisting) {
13171: $applies ++;
13172: }
1.1071 raeburn 13173: if ($counter || $numunused) {
1.987 raeburn 13174: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13175: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13176: $state.'<h3>'.$heading.'</h3>';
13177: if ($actionurl eq '/adm/dependencies') {
13178: if ($numnew) {
13179: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13180: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13181: $upload_output.'<br />'."\n";
13182: }
13183: if ($numexisting) {
13184: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13185: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13186: $modify_output.'<br />'."\n";
13187: $buttontext = &mt('Save changes');
13188: }
13189: if ($numunused) {
13190: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13191: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13192: $delete_output.'<br />'."\n";
13193: $buttontext = &mt('Save changes');
13194: }
13195: } else {
13196: $output .= $upload_output.'<br />'."\n";
13197: }
13198: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13199: $counter.'" />'."\n";
13200: if ($actionurl eq '/adm/dependencies') {
13201: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13202: $numnew.'" />'."\n";
13203: } elsif ($actionurl eq '') {
1.987 raeburn 13204: $output .= '<input type="hidden" name="phase" value="three" />';
13205: }
13206: } elsif ($applies) {
13207: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13208: if ($applies > 1) {
13209: $output .=
1.1123 raeburn 13210: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13211: if ($numremref) {
13212: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13213: }
13214: if ($numinvalid) {
13215: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13216: }
13217: if ($numexisting) {
13218: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13219: }
13220: $output .= '</ul><br />';
13221: } elsif ($numremref) {
13222: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13223: } elsif ($numinvalid) {
13224: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13225: } elsif ($numexisting) {
13226: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13227: }
13228: $output .= $upload_output.'<br />';
13229: }
13230: my ($pathchange_output,$chgcount);
1.1071 raeburn 13231: $chgcount = $counter;
1.987 raeburn 13232: if (keys(%pathchanges) > 0) {
13233: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13234: if ($counter) {
1.987 raeburn 13235: $output .= &embedded_file_element('pathchange',$chgcount,
13236: $embed_file,\%mapping,
1.1071 raeburn 13237: $allfiles,$codebase,'change');
1.987 raeburn 13238: } else {
13239: $pathchange_output .=
13240: &start_data_table_row().
13241: '<td><input type ="checkbox" name="namechange" value="'.
13242: $chgcount.'" checked="checked" /></td>'.
13243: '<td>'.$mapping{$embed_file}.'</td>'.
13244: '<td>'.$embed_file.
13245: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13246: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13247: '</td>'.&end_data_table_row();
1.660 raeburn 13248: }
1.987 raeburn 13249: $numpathchg ++;
13250: $chgcount ++;
1.660 raeburn 13251: }
13252: }
1.1127 raeburn 13253: if (($counter) || ($numunused)) {
1.987 raeburn 13254: if ($numpathchg) {
13255: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13256: $numpathchg.'" />'."\n";
13257: }
13258: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13259: ($actionurl eq '/adm/imsimport')) {
13260: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13261: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13262: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13263: } elsif ($actionurl eq '/adm/dependencies') {
13264: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13265: }
1.1123 raeburn 13266: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13267: } elsif ($numpathchg) {
13268: my %pathchange = ();
13269: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13270: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13271: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13272: }
1.987 raeburn 13273: }
1.1071 raeburn 13274: return ($output,$counter,$numpathchg);
1.987 raeburn 13275: }
13276:
1.1147 raeburn 13277: =pod
13278:
13279: =item * clean_path($name)
13280:
13281: Performs clean-up of directories, subdirectories and filename in an
13282: embedded object, referenced in an HTML file which is being uploaded
13283: to a course or portfolio, where
13284: "Upload embedded images/multimedia files if HTML file" checkbox was
13285: checked.
13286:
13287: Clean-up is similar to replacements in lonnet::clean_filename()
13288: except each / between sub-directory and next level is preserved.
13289:
13290: =cut
13291:
13292: sub clean_path {
13293: my ($embed_file) = @_;
13294: $embed_file =~s{^/+}{};
13295: my @contents;
13296: if ($embed_file =~ m{/}) {
13297: @contents = split(/\//,$embed_file);
13298: } else {
13299: @contents = ($embed_file);
13300: }
13301: my $lastidx = scalar(@contents)-1;
13302: for (my $i=0; $i<=$lastidx; $i++) {
13303: $contents[$i]=~s{\\}{/}g;
13304: $contents[$i]=~s/\s+/\_/g;
13305: $contents[$i]=~s{[^/\w\.\-]}{}g;
13306: if ($i == $lastidx) {
13307: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13308: }
13309: }
13310: if ($lastidx > 0) {
13311: return join('/',@contents);
13312: } else {
13313: return $contents[0];
13314: }
13315: }
13316:
1.987 raeburn 13317: sub embedded_file_element {
1.1071 raeburn 13318: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13319: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13320: (ref($codebase) eq 'HASH'));
13321: my $output;
1.1071 raeburn 13322: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13323: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13324: }
13325: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13326: &escape($embed_file).'" />';
13327: unless (($context eq 'upload_embedded') &&
13328: ($mapping->{$embed_file} eq $embed_file)) {
13329: $output .='
13330: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13331: }
13332: my $attrib;
13333: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13334: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13335: }
13336: $output .=
13337: "\n\t\t".
13338: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13339: $attrib.'" />';
13340: if (exists($codebase->{$mapping->{$embed_file}})) {
13341: $output .=
13342: "\n\t\t".
13343: '<input name="codebase_'.$num.'" type="hidden" value="'.
13344: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13345: }
1.987 raeburn 13346: return $output;
1.660 raeburn 13347: }
13348:
1.1071 raeburn 13349: sub get_dependency_details {
13350: my ($currfile,$currsubfile,$embed_file) = @_;
13351: my ($size,$mtime,$showsize,$showmtime);
13352: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13353: if ($embed_file =~ m{/}) {
13354: my ($path,$fname) = split(/\//,$embed_file);
13355: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13356: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13357: }
13358: } else {
13359: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13360: ($size,$mtime) = @{$currfile->{$embed_file}};
13361: }
13362: }
13363: $showsize = $size/1024.0;
13364: $showsize = sprintf("%.1f",$showsize);
13365: if ($mtime > 0) {
13366: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13367: }
13368: }
13369: return ($showsize,$showmtime);
13370: }
13371:
13372: sub ask_embedded_js {
13373: return <<"END";
13374: <script type="text/javascript"">
13375: // <![CDATA[
13376: function toggleBrowse(counter) {
13377: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13378: var fileid = document.getElementById('embedded_item_'+counter);
13379: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13380: if (chkboxid.checked == true) {
13381: uploaddivid.style.display='block';
13382: } else {
13383: uploaddivid.style.display='none';
13384: fileid.value = '';
13385: }
13386: }
13387: // ]]>
13388: </script>
13389:
13390: END
13391: }
13392:
1.661 raeburn 13393: sub upload_embedded {
13394: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13395: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13396: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13397: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13398: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13399: my $orig_uploaded_filename =
13400: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13401: foreach my $type ('orig','ref','attrib','codebase') {
13402: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13403: $env{'form.embedded_'.$type.'_'.$i} =
13404: &unescape($env{'form.embedded_'.$type.'_'.$i});
13405: }
13406: }
1.661 raeburn 13407: my ($path,$fname) =
13408: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13409: # no path, whole string is fname
13410: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13411: $fname = &Apache::lonnet::clean_filename($fname);
13412: # See if there is anything left
13413: next if ($fname eq '');
13414:
13415: # Check if file already exists as a file or directory.
13416: my ($state,$msg);
13417: if ($context eq 'portfolio') {
13418: my $port_path = $dirpath;
13419: if ($group ne '') {
13420: $port_path = "groups/$group/$port_path";
13421: }
1.987 raeburn 13422: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13423: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13424: $dir_root,$port_path,$disk_quota,
13425: $current_disk_usage,$uname,$udom);
13426: if ($state eq 'will_exceed_quota'
1.984 raeburn 13427: || $state eq 'file_locked') {
1.661 raeburn 13428: $output .= $msg;
13429: next;
13430: }
13431: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13432: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13433: if ($state eq 'exists') {
13434: $output .= $msg;
13435: next;
13436: }
13437: }
13438: # Check if extension is valid
13439: if (($fname =~ /\.(\w+)$/) &&
13440: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13441: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13442: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13443: next;
13444: } elsif (($fname =~ /\.(\w+)$/) &&
13445: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13446: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13447: next;
13448: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13449: $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 13450: next;
13451: }
13452: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13453: my $subdir = $path;
13454: $subdir =~ s{/+$}{};
1.661 raeburn 13455: if ($context eq 'portfolio') {
1.984 raeburn 13456: my $result;
13457: if ($state eq 'existingfile') {
13458: $result=
13459: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13460: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13461: } else {
1.984 raeburn 13462: $result=
13463: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13464: $dirpath.
1.1123 raeburn 13465: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13466: if ($result !~ m|^/uploaded/|) {
13467: $output .= '<span class="LC_error">'
13468: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13469: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13470: .'</span><br />';
13471: next;
13472: } else {
1.987 raeburn 13473: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13474: $path.$fname.'</span>').'<br />';
1.984 raeburn 13475: }
1.661 raeburn 13476: }
1.1123 raeburn 13477: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13478: my $extendedsubdir = $dirpath.'/'.$subdir;
13479: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13480: my $result =
1.1126 raeburn 13481: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13482: if ($result !~ m|^/uploaded/|) {
13483: $output .= '<span class="LC_error">'
13484: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13485: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13486: .'</span><br />';
13487: next;
13488: } else {
13489: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13490: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13491: if ($context eq 'syllabus') {
13492: &Apache::lonnet::make_public_indefinitely($result);
13493: }
1.987 raeburn 13494: }
1.661 raeburn 13495: } else {
13496: # Save the file
13497: my $target = $env{'form.embedded_item_'.$i};
13498: my $fullpath = $dir_root.$dirpath.'/'.$path;
13499: my $dest = $fullpath.$fname;
13500: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13501: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13502: my $count;
13503: my $filepath = $dir_root;
1.1027 raeburn 13504: foreach my $subdir (@parts) {
13505: $filepath .= "/$subdir";
13506: if (!-e $filepath) {
1.661 raeburn 13507: mkdir($filepath,0770);
13508: }
13509: }
13510: my $fh;
13511: if (!open($fh,'>'.$dest)) {
13512: &Apache::lonnet::logthis('Failed to create '.$dest);
13513: $output .= '<span class="LC_error">'.
1.1071 raeburn 13514: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13515: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13516: '</span><br />';
13517: } else {
13518: if (!print $fh $env{'form.embedded_item_'.$i}) {
13519: &Apache::lonnet::logthis('Failed to write to '.$dest);
13520: $output .= '<span class="LC_error">'.
1.1071 raeburn 13521: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13522: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13523: '</span><br />';
13524: } else {
1.987 raeburn 13525: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13526: $url.'</span>').'<br />';
13527: unless ($context eq 'testbank') {
13528: $footer .= &mt('View embedded file: [_1]',
13529: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13530: }
13531: }
13532: close($fh);
13533: }
13534: }
13535: if ($env{'form.embedded_ref_'.$i}) {
13536: $pathchange{$i} = 1;
13537: }
13538: }
13539: if ($output) {
13540: $output = '<p>'.$output.'</p>';
13541: }
13542: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13543: $returnflag = 'ok';
1.1071 raeburn 13544: my $numpathchgs = scalar(keys(%pathchange));
13545: if ($numpathchgs > 0) {
1.987 raeburn 13546: if ($context eq 'portfolio') {
13547: $output .= '<p>'.&mt('or').'</p>';
13548: } elsif ($context eq 'testbank') {
1.1071 raeburn 13549: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13550: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13551: $returnflag = 'modify_orightml';
13552: }
13553: }
1.1071 raeburn 13554: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13555: }
13556:
13557: sub modify_html_form {
13558: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13559: my $end = 0;
13560: my $modifyform;
13561: if ($context eq 'upload_embedded') {
13562: return unless (ref($pathchange) eq 'HASH');
13563: if ($env{'form.number_embedded_items'}) {
13564: $end += $env{'form.number_embedded_items'};
13565: }
13566: if ($env{'form.number_pathchange_items'}) {
13567: $end += $env{'form.number_pathchange_items'};
13568: }
13569: if ($end) {
13570: for (my $i=0; $i<$end; $i++) {
13571: if ($i < $env{'form.number_embedded_items'}) {
13572: next unless($pathchange->{$i});
13573: }
13574: $modifyform .=
13575: &start_data_table_row().
13576: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13577: 'checked="checked" /></td>'.
13578: '<td>'.$env{'form.embedded_ref_'.$i}.
13579: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13580: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13581: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13582: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13583: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13584: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13585: '<td>'.$env{'form.embedded_orig_'.$i}.
13586: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13587: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13588: &end_data_table_row();
1.1071 raeburn 13589: }
1.987 raeburn 13590: }
13591: } else {
13592: $modifyform = $pathchgtable;
13593: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13594: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13595: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13596: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13597: }
13598: }
13599: if ($modifyform) {
1.1071 raeburn 13600: if ($actionurl eq '/adm/dependencies') {
13601: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13602: }
1.987 raeburn 13603: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13604: '<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".
13605: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13606: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13607: '</ol></p>'."\n".'<p>'.
13608: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13609: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13610: &start_data_table()."\n".
13611: &start_data_table_header_row().
13612: '<th>'.&mt('Change?').'</th>'.
13613: '<th>'.&mt('Current reference').'</th>'.
13614: '<th>'.&mt('Required reference').'</th>'.
13615: &end_data_table_header_row()."\n".
13616: $modifyform.
13617: &end_data_table().'<br />'."\n".$hiddenstate.
13618: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13619: '</form>'."\n";
13620: }
13621: return;
13622: }
13623:
13624: sub modify_html_refs {
1.1123 raeburn 13625: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13626: my $container;
13627: if ($context eq 'portfolio') {
13628: $container = $env{'form.container'};
13629: } elsif ($context eq 'coursedoc') {
13630: $container = $env{'form.primaryurl'};
1.1071 raeburn 13631: } elsif ($context eq 'manage_dependencies') {
13632: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13633: $container = "/$container";
1.1123 raeburn 13634: } elsif ($context eq 'syllabus') {
13635: $container = $url;
1.987 raeburn 13636: } else {
1.1027 raeburn 13637: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13638: }
13639: my (%allfiles,%codebase,$output,$content);
13640: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13641: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13642: if (wantarray) {
13643: return ('',0,0);
13644: } else {
13645: return;
13646: }
13647: }
13648: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13649: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13650: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13651: if (wantarray) {
13652: return ('',0,0);
13653: } else {
13654: return;
13655: }
13656: }
1.987 raeburn 13657: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13658: if ($content eq '-1') {
13659: if (wantarray) {
13660: return ('',0,0);
13661: } else {
13662: return;
13663: }
13664: }
1.987 raeburn 13665: } else {
1.1071 raeburn 13666: unless ($container =~ /^\Q$dir_root\E/) {
13667: if (wantarray) {
13668: return ('',0,0);
13669: } else {
13670: return;
13671: }
13672: }
1.1317 raeburn 13673: if (open(my $fh,'<',$container)) {
1.987 raeburn 13674: $content = join('', <$fh>);
13675: close($fh);
13676: } else {
1.1071 raeburn 13677: if (wantarray) {
13678: return ('',0,0);
13679: } else {
13680: return;
13681: }
1.987 raeburn 13682: }
13683: }
13684: my ($count,$codebasecount) = (0,0);
13685: my $mm = new File::MMagic;
13686: my $mime_type = $mm->checktype_contents($content);
13687: if ($mime_type eq 'text/html') {
13688: my $parse_result =
13689: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13690: \%codebase,\$content);
13691: if ($parse_result eq 'ok') {
13692: foreach my $i (@changes) {
13693: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13694: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13695: if ($allfiles{$ref}) {
13696: my $newname = $orig;
13697: my ($attrib_regexp,$codebase);
1.1006 raeburn 13698: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13699: if ($attrib_regexp =~ /:/) {
13700: $attrib_regexp =~ s/\:/|/g;
13701: }
13702: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13703: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13704: $count += $numchg;
1.1123 raeburn 13705: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13706: delete($allfiles{$ref});
1.987 raeburn 13707: }
13708: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13709: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13710: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13711: $codebasecount ++;
13712: }
13713: }
13714: }
1.1123 raeburn 13715: my $skiprewrites;
1.987 raeburn 13716: if ($count || $codebasecount) {
13717: my $saveresult;
1.1071 raeburn 13718: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13719: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13720: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13721: if ($url eq $container) {
13722: my ($fname) = ($container =~ m{/([^/]+)$});
13723: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13724: $count,'<span class="LC_filename">'.
1.1071 raeburn 13725: $fname.'</span>').'</p>';
1.987 raeburn 13726: } else {
13727: $output = '<p class="LC_error">'.
13728: &mt('Error: update failed for: [_1].',
13729: '<span class="LC_filename">'.
13730: $container.'</span>').'</p>';
13731: }
1.1123 raeburn 13732: if ($context eq 'syllabus') {
13733: unless ($saveresult eq 'ok') {
13734: $skiprewrites = 1;
13735: }
13736: }
1.987 raeburn 13737: } else {
1.1317 raeburn 13738: if (open(my $fh,'>',$container)) {
1.987 raeburn 13739: print $fh $content;
13740: close($fh);
13741: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13742: $count,'<span class="LC_filename">'.
13743: $container.'</span>').'</p>';
1.661 raeburn 13744: } else {
1.987 raeburn 13745: $output = '<p class="LC_error">'.
13746: &mt('Error: could not update [_1].',
13747: '<span class="LC_filename">'.
13748: $container.'</span>').'</p>';
1.661 raeburn 13749: }
13750: }
13751: }
1.1123 raeburn 13752: if (($context eq 'syllabus') && (!$skiprewrites)) {
13753: my ($actionurl,$state);
13754: $actionurl = "/public/$udom/$uname/syllabus";
13755: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13756: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13757: \%codebase,
13758: {'context' => 'rewrites',
13759: 'ignore_remote_references' => 1,});
13760: if (ref($mapping) eq 'HASH') {
13761: my $rewrites = 0;
13762: foreach my $key (keys(%{$mapping})) {
13763: next if ($key =~ m{^https?://});
13764: my $ref = $mapping->{$key};
13765: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13766: my $attrib;
13767: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13768: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13769: }
13770: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13771: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13772: $rewrites += $numchg;
13773: }
13774: }
13775: if ($rewrites) {
13776: my $saveresult;
13777: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13778: if ($url eq $container) {
13779: my ($fname) = ($container =~ m{/([^/]+)$});
13780: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13781: $count,'<span class="LC_filename">'.
13782: $fname.'</span>').'</p>';
13783: } else {
13784: $output .= '<p class="LC_error">'.
13785: &mt('Error: could not update links in [_1].',
13786: '<span class="LC_filename">'.
13787: $container.'</span>').'</p>';
13788:
13789: }
13790: }
13791: }
13792: }
1.987 raeburn 13793: } else {
13794: &logthis('Failed to parse '.$container.
13795: ' to modify references: '.$parse_result);
1.661 raeburn 13796: }
13797: }
1.1071 raeburn 13798: if (wantarray) {
13799: return ($output,$count,$codebasecount);
13800: } else {
13801: return $output;
13802: }
1.661 raeburn 13803: }
13804:
13805: sub check_for_existing {
13806: my ($path,$fname,$element) = @_;
13807: my ($state,$msg);
13808: if (-d $path.'/'.$fname) {
13809: $state = 'exists';
13810: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13811: } elsif (-e $path.'/'.$fname) {
13812: $state = 'exists';
13813: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13814: }
13815: if ($state eq 'exists') {
13816: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13817: }
13818: return ($state,$msg);
13819: }
13820:
13821: sub check_for_upload {
13822: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13823: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13824: my $filesize = length($env{'form.'.$element});
13825: if (!$filesize) {
13826: my $msg = '<span class="LC_error">'.
13827: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13828: '<span class="LC_filename">'.$fname.'</span>',
13829: $filesize).'<br />'.
1.1007 raeburn 13830: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13831: '</span>';
13832: return ('zero_bytes',$msg);
13833: }
13834: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13835: my $getpropath = 1;
1.1021 raeburn 13836: my ($dirlistref,$listerror) =
13837: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13838: my $found_file = 0;
13839: my $locked_file = 0;
1.991 raeburn 13840: my @lockers;
13841: my $navmap;
13842: if ($env{'request.course.id'}) {
13843: $navmap = Apache::lonnavmaps::navmap->new();
13844: }
1.1021 raeburn 13845: if (ref($dirlistref) eq 'ARRAY') {
13846: foreach my $line (@{$dirlistref}) {
13847: my ($file_name,$rest)=split(/\&/,$line,2);
13848: if ($file_name eq $fname){
13849: $file_name = $path.$file_name;
13850: if ($group ne '') {
13851: $file_name = $group.$file_name;
13852: }
13853: $found_file = 1;
13854: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13855: foreach my $lock (@lockers) {
13856: if (ref($lock) eq 'ARRAY') {
13857: my ($symb,$crsid) = @{$lock};
13858: if ($crsid eq $env{'request.course.id'}) {
13859: if (ref($navmap)) {
13860: my $res = $navmap->getBySymb($symb);
13861: foreach my $part (@{$res->parts()}) {
13862: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13863: unless (($slot_status == $res->RESERVED) ||
13864: ($slot_status == $res->RESERVED_LOCATION)) {
13865: $locked_file = 1;
13866: }
1.991 raeburn 13867: }
1.1021 raeburn 13868: } else {
13869: $locked_file = 1;
1.991 raeburn 13870: }
13871: } else {
13872: $locked_file = 1;
13873: }
13874: }
1.1021 raeburn 13875: }
13876: } else {
13877: my @info = split(/\&/,$rest);
13878: my $currsize = $info[6]/1000;
13879: if ($currsize < $filesize) {
13880: my $extra = $filesize - $currsize;
13881: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13882: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13883: &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 13884: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13885: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13886: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13887: return ('will_exceed_quota',$msg);
13888: }
1.984 raeburn 13889: }
13890: }
1.661 raeburn 13891: }
13892: }
13893: }
13894: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13895: my $msg = '<p class="LC_warning">'.
13896: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13897: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13898: return ('will_exceed_quota',$msg);
13899: } elsif ($found_file) {
13900: if ($locked_file) {
1.1179 bisitz 13901: my $msg = '<p class="LC_warning">';
1.661 raeburn 13902: $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 13903: $msg .= '</p>';
1.661 raeburn 13904: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13905: return ('file_locked',$msg);
13906: } else {
1.1179 bisitz 13907: my $msg = '<p class="LC_error">';
1.984 raeburn 13908: $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 13909: $msg .= '</p>';
1.984 raeburn 13910: return ('existingfile',$msg);
1.661 raeburn 13911: }
13912: }
13913: }
13914:
1.987 raeburn 13915: sub check_for_traversal {
13916: my ($path,$url,$toplevel) = @_;
13917: my @parts=split(/\//,$path);
13918: my $cleanpath;
13919: my $fullpath = $url;
13920: for (my $i=0;$i<@parts;$i++) {
13921: next if ($parts[$i] eq '.');
13922: if ($parts[$i] eq '..') {
13923: $fullpath =~ s{([^/]+/)$}{};
13924: } else {
13925: $fullpath .= $parts[$i].'/';
13926: }
13927: }
13928: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13929: $cleanpath = $1;
13930: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13931: my $curr_toprel = $1;
13932: my @parts = split(/\//,$curr_toprel);
13933: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13934: my @urlparts = split(/\//,$url_toprel);
13935: my $doubledots;
13936: my $startdiff = -1;
13937: for (my $i=0; $i<@urlparts; $i++) {
13938: if ($startdiff == -1) {
13939: unless ($urlparts[$i] eq $parts[$i]) {
13940: $startdiff = $i;
13941: $doubledots .= '../';
13942: }
13943: } else {
13944: $doubledots .= '../';
13945: }
13946: }
13947: if ($startdiff > -1) {
13948: $cleanpath = $doubledots;
13949: for (my $i=$startdiff; $i<@parts; $i++) {
13950: $cleanpath .= $parts[$i].'/';
13951: }
13952: }
13953: }
13954: $cleanpath =~ s{(/)$}{};
13955: return $cleanpath;
13956: }
1.31 albertel 13957:
1.1053 raeburn 13958: sub is_archive_file {
13959: my ($mimetype) = @_;
13960: if (($mimetype eq 'application/octet-stream') ||
13961: ($mimetype eq 'application/x-stuffit') ||
13962: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13963: return 1;
13964: }
13965: return;
13966: }
13967:
13968: sub decompress_form {
1.1065 raeburn 13969: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13970: my %lt = &Apache::lonlocal::texthash (
13971: this => 'This file is an archive file.',
1.1067 raeburn 13972: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13973: itsc => 'Its contents are as follows:',
1.1053 raeburn 13974: youm => 'You may wish to extract its contents.',
13975: extr => 'Extract contents',
1.1067 raeburn 13976: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13977: proa => 'Process automatically?',
1.1053 raeburn 13978: yes => 'Yes',
13979: no => 'No',
1.1067 raeburn 13980: fold => 'Title for folder containing movie',
13981: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13982: );
1.1065 raeburn 13983: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13984: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13985: my $info = &list_archive_contents($fileloc,\@paths);
13986: if (@paths) {
13987: foreach my $path (@paths) {
13988: $path =~ s{^/}{};
1.1067 raeburn 13989: if ($path =~ m{^([^/]+)/$}) {
13990: $topdir = $1;
13991: }
1.1065 raeburn 13992: if ($path =~ m{^([^/]+)/}) {
13993: $toplevel{$1} = $path;
13994: } else {
13995: $toplevel{$path} = $path;
13996: }
13997: }
13998: }
1.1067 raeburn 13999: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 14000: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 14001: "$topdir/media/",
14002: "$topdir/media/$topdir.mp4",
14003: "$topdir/media/FirstFrame.png",
14004: "$topdir/media/player.swf",
14005: "$topdir/media/swfobject.js",
14006: "$topdir/media/expressInstall.swf");
1.1197 raeburn 14007: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 14008: "$topdir/$topdir.mp4",
14009: "$topdir/$topdir\_config.xml",
14010: "$topdir/$topdir\_controller.swf",
14011: "$topdir/$topdir\_embed.css",
14012: "$topdir/$topdir\_First_Frame.png",
14013: "$topdir/$topdir\_player.html",
14014: "$topdir/$topdir\_Thumbnails.png",
14015: "$topdir/playerProductInstall.swf",
14016: "$topdir/scripts/",
14017: "$topdir/scripts/config_xml.js",
14018: "$topdir/scripts/handlebars.js",
14019: "$topdir/scripts/jquery-1.7.1.min.js",
14020: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
14021: "$topdir/scripts/modernizr.js",
14022: "$topdir/scripts/player-min.js",
14023: "$topdir/scripts/swfobject.js",
14024: "$topdir/skins/",
14025: "$topdir/skins/configuration_express.xml",
14026: "$topdir/skins/express_show/",
14027: "$topdir/skins/express_show/player-min.css",
14028: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 14029: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
14030: "$topdir/$topdir.mp4",
14031: "$topdir/$topdir\_config.xml",
14032: "$topdir/$topdir\_controller.swf",
14033: "$topdir/$topdir\_embed.css",
14034: "$topdir/$topdir\_First_Frame.png",
14035: "$topdir/$topdir\_player.html",
14036: "$topdir/$topdir\_Thumbnails.png",
14037: "$topdir/playerProductInstall.swf",
14038: "$topdir/scripts/",
14039: "$topdir/scripts/config_xml.js",
14040: "$topdir/scripts/techsmith-smart-player.min.js",
14041: "$topdir/skins/",
14042: "$topdir/skins/configuration_express.xml",
14043: "$topdir/skins/express_show/",
14044: "$topdir/skins/express_show/spritesheet.min.css",
14045: "$topdir/skins/express_show/spritesheet.png",
14046: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 14047: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 14048: if (@diffs == 0) {
1.1164 raeburn 14049: $is_camtasia = 6;
14050: } else {
1.1197 raeburn 14051: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 14052: if (@diffs == 0) {
14053: $is_camtasia = 8;
1.1197 raeburn 14054: } else {
14055: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14056: if (@diffs == 0) {
14057: $is_camtasia = 8;
14058: }
1.1164 raeburn 14059: }
1.1067 raeburn 14060: }
14061: }
14062: my $output;
14063: if ($is_camtasia) {
14064: $output = <<"ENDCAM";
14065: <script type="text/javascript" language="Javascript">
14066: // <![CDATA[
14067:
14068: function camtasiaToggle() {
14069: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14070: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14071: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14072: document.getElementById('camtasia_titles').style.display='block';
14073: } else {
14074: document.getElementById('camtasia_titles').style.display='none';
14075: }
14076: }
14077: }
14078: return;
14079: }
14080:
14081: // ]]>
14082: </script>
14083: <p>$lt{'camt'}</p>
14084: ENDCAM
1.1065 raeburn 14085: } else {
1.1067 raeburn 14086: $output = '<p>'.$lt{'this'};
14087: if ($info eq '') {
14088: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14089: } else {
14090: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14091: '<div><pre>'.$info.'</pre></div>';
14092: }
1.1065 raeburn 14093: }
1.1067 raeburn 14094: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14095: my $duplicates;
14096: my $num = 0;
14097: if (ref($dirlist) eq 'ARRAY') {
14098: foreach my $item (@{$dirlist}) {
14099: if (ref($item) eq 'ARRAY') {
14100: if (exists($toplevel{$item->[0]})) {
14101: $duplicates .=
14102: &start_data_table_row().
14103: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14104: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14105: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14106: 'value="1" />'.&mt('Yes').'</label>'.
14107: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14108: '<td>'.$item->[0].'</td>';
14109: if ($item->[2]) {
14110: $duplicates .= '<td>'.&mt('Directory').'</td>';
14111: } else {
14112: $duplicates .= '<td>'.&mt('File').'</td>';
14113: }
14114: $duplicates .= '<td>'.$item->[3].'</td>'.
14115: '<td>'.
14116: &Apache::lonlocal::locallocaltime($item->[4]).
14117: '</td>'.
14118: &end_data_table_row();
14119: $num ++;
14120: }
14121: }
14122: }
14123: }
14124: my $itemcount;
14125: if (@paths > 0) {
14126: $itemcount = scalar(@paths);
14127: } else {
14128: $itemcount = 1;
14129: }
1.1067 raeburn 14130: if ($is_camtasia) {
14131: $output .= $lt{'auto'}.'<br />'.
14132: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14133: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14134: $lt{'yes'}.'</label> <label>'.
14135: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14136: $lt{'no'}.'</label></span><br />'.
14137: '<div id="camtasia_titles" style="display:block">'.
14138: &Apache::lonhtmlcommon::start_pick_box().
14139: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14140: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14141: &Apache::lonhtmlcommon::row_closure().
14142: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14143: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14144: &Apache::lonhtmlcommon::row_closure(1).
14145: &Apache::lonhtmlcommon::end_pick_box().
14146: '</div>';
14147: }
1.1065 raeburn 14148: $output .=
14149: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14150: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14151: "\n";
1.1065 raeburn 14152: if ($duplicates ne '') {
14153: $output .= '<p><span class="LC_warning">'.
14154: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14155: &start_data_table().
14156: &start_data_table_header_row().
14157: '<th>'.&mt('Overwrite?').'</th>'.
14158: '<th>'.&mt('Name').'</th>'.
14159: '<th>'.&mt('Type').'</th>'.
14160: '<th>'.&mt('Size').'</th>'.
14161: '<th>'.&mt('Last modified').'</th>'.
14162: &end_data_table_header_row().
14163: $duplicates.
14164: &end_data_table().
14165: '</p>';
14166: }
1.1067 raeburn 14167: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14168: if (ref($hiddenelements) eq 'HASH') {
14169: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14170: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14171: }
14172: }
14173: $output .= <<"END";
1.1067 raeburn 14174: <br />
1.1053 raeburn 14175: <input type="submit" name="decompress" value="$lt{'extr'}" />
14176: </form>
14177: $noextract
14178: END
14179: return $output;
14180: }
14181:
1.1065 raeburn 14182: sub decompression_utility {
14183: my ($program) = @_;
14184: my @utilities = ('tar','gunzip','bunzip2','unzip');
14185: my $location;
14186: if (grep(/^\Q$program\E$/,@utilities)) {
14187: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14188: '/usr/sbin/') {
14189: if (-x $dir.$program) {
14190: $location = $dir.$program;
14191: last;
14192: }
14193: }
14194: }
14195: return $location;
14196: }
14197:
14198: sub list_archive_contents {
14199: my ($file,$pathsref) = @_;
14200: my (@cmd,$output);
14201: my $needsregexp;
14202: if ($file =~ /\.zip$/) {
14203: @cmd = (&decompression_utility('unzip'),"-l");
14204: $needsregexp = 1;
14205: } elsif (($file =~ m/\.tar\.gz$/) ||
14206: ($file =~ /\.tgz$/)) {
14207: @cmd = (&decompression_utility('tar'),"-ztf");
14208: } elsif ($file =~ /\.tar\.bz2$/) {
14209: @cmd = (&decompression_utility('tar'),"-jtf");
14210: } elsif ($file =~ m|\.tar$|) {
14211: @cmd = (&decompression_utility('tar'),"-tf");
14212: }
14213: if (@cmd) {
14214: undef($!);
14215: undef($@);
14216: if (open(my $fh,"-|", @cmd, $file)) {
14217: while (my $line = <$fh>) {
14218: $output .= $line;
14219: chomp($line);
14220: my $item;
14221: if ($needsregexp) {
14222: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14223: } else {
14224: $item = $line;
14225: }
14226: if ($item ne '') {
14227: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14228: push(@{$pathsref},$item);
14229: }
14230: }
14231: }
14232: close($fh);
14233: }
14234: }
14235: return $output;
14236: }
14237:
1.1053 raeburn 14238: sub decompress_uploaded_file {
14239: my ($file,$dir) = @_;
14240: &Apache::lonnet::appenv({'cgi.file' => $file});
14241: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14242: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14243: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14244: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14245: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14246: my $decompressed = $env{'cgi.decompressed'};
14247: &Apache::lonnet::delenv('cgi.file');
14248: &Apache::lonnet::delenv('cgi.dir');
14249: &Apache::lonnet::delenv('cgi.decompressed');
14250: return ($decompressed,$result);
14251: }
14252:
1.1055 raeburn 14253: sub process_decompression {
14254: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14255: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14256: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14257: &mt('Unexpected file path.').'</p>'."\n";
14258: }
14259: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14260: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14261: &mt('Unexpected course context.').'</p>'."\n";
14262: }
1.1293 raeburn 14263: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14264: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14265: &mt('Filename contained unexpected characters.').'</p>'."\n";
14266: }
1.1055 raeburn 14267: my ($dir,$error,$warning,$output);
1.1180 raeburn 14268: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14269: $error = &mt('Filename not a supported archive file type.').
14270: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14271: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14272: } else {
14273: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14274: if ($docuhome eq 'no_host') {
14275: $error = &mt('Could not determine home server for course.');
14276: } else {
14277: my @ids=&Apache::lonnet::current_machine_ids();
14278: my $currdir = "$dir_root/$destination";
14279: if (grep(/^\Q$docuhome\E$/,@ids)) {
14280: $dir = &LONCAPA::propath($docudom,$docuname).
14281: "$dir_root/$destination";
14282: } else {
14283: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14284: "$dir_root/$docudom/$docuname/$destination";
14285: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14286: $error = &mt('Archive file not found.');
14287: }
14288: }
1.1065 raeburn 14289: my (@to_overwrite,@to_skip);
14290: if ($env{'form.archive_overwrite_total'} > 0) {
14291: my $total = $env{'form.archive_overwrite_total'};
14292: for (my $i=0; $i<$total; $i++) {
14293: if ($env{'form.archive_overwrite_'.$i} == 1) {
14294: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14295: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14296: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14297: }
14298: }
14299: }
14300: my $numskip = scalar(@to_skip);
1.1292 raeburn 14301: my $numoverwrite = scalar(@to_overwrite);
14302: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14303: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14304: } elsif ($dir eq '') {
1.1055 raeburn 14305: $error = &mt('Directory containing archive file unavailable.');
14306: } elsif (!$error) {
1.1065 raeburn 14307: my ($decompressed,$display);
1.1292 raeburn 14308: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14309: my $tempdir = time.'_'.$$.int(rand(10000));
14310: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14311: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14312: ($decompressed,$display) =
14313: &decompress_uploaded_file($file,"$dir/$tempdir");
14314: foreach my $item (@to_skip) {
14315: if (($item ne '') && ($item !~ /\.\./)) {
14316: if (-f "$dir/$tempdir/$item") {
14317: unlink("$dir/$tempdir/$item");
14318: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14319: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14320: }
14321: }
14322: }
14323: foreach my $item (@to_overwrite) {
14324: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14325: if (($item ne '') && ($item !~ /\.\./)) {
14326: if (-f "$dir/$item") {
14327: unlink("$dir/$item");
14328: } elsif (-d "$dir/$item") {
1.1300 raeburn 14329: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14330: }
14331: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14332: }
1.1065 raeburn 14333: }
14334: }
1.1292 raeburn 14335: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14336: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14337: }
1.1065 raeburn 14338: }
14339: } else {
14340: ($decompressed,$display) =
14341: &decompress_uploaded_file($file,$dir);
14342: }
1.1055 raeburn 14343: if ($decompressed eq 'ok') {
1.1065 raeburn 14344: $output = '<p class="LC_info">'.
14345: &mt('Files extracted successfully from archive.').
14346: '</p>'."\n";
1.1055 raeburn 14347: my ($warning,$result,@contents);
14348: my ($newdirlistref,$newlisterror) =
14349: &Apache::lonnet::dirlist($currdir,$docudom,
14350: $docuname,1);
14351: my (%is_dir,%changes,@newitems);
14352: my $dirptr = 16384;
1.1065 raeburn 14353: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14354: foreach my $dir_line (@{$newdirlistref}) {
14355: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14356: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14357: push(@newitems,$item);
14358: if ($dirptr&$testdir) {
14359: $is_dir{$item} = 1;
14360: }
14361: $changes{$item} = 1;
14362: }
14363: }
14364: }
14365: if (keys(%changes) > 0) {
14366: foreach my $item (sort(@newitems)) {
14367: if ($changes{$item}) {
14368: push(@contents,$item);
14369: }
14370: }
14371: }
14372: if (@contents > 0) {
1.1067 raeburn 14373: my $wantform;
14374: unless ($env{'form.autoextract_camtasia'}) {
14375: $wantform = 1;
14376: }
1.1056 raeburn 14377: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14378: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14379: $currdir,\%is_dir,
14380: \%children,\%parent,
1.1056 raeburn 14381: \@contents,\%dirorder,
14382: \%titles,$wantform);
1.1055 raeburn 14383: if ($datatable ne '') {
14384: $output .= &archive_options_form('decompressed',$datatable,
14385: $count,$hiddenelem);
1.1065 raeburn 14386: my $startcount = 6;
1.1055 raeburn 14387: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14388: \%titles,\%children);
1.1055 raeburn 14389: }
1.1067 raeburn 14390: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14391: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14392: my %displayed;
14393: my $total = 1;
14394: $env{'form.archive_directory'} = [];
14395: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14396: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14397: $path =~ s{/$}{};
14398: my $item;
14399: if ($path ne '') {
14400: $item = "$path/$titles{$i}";
14401: } else {
14402: $item = $titles{$i};
14403: }
14404: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14405: if ($item eq $contents[0]) {
14406: push(@{$env{'form.archive_directory'}},$i);
14407: $env{'form.archive_'.$i} = 'display';
14408: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14409: $displayed{'folder'} = $i;
1.1164 raeburn 14410: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14411: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14412: $env{'form.archive_'.$i} = 'display';
14413: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14414: $displayed{'web'} = $i;
14415: } else {
1.1164 raeburn 14416: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14417: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14418: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14419: push(@{$env{'form.archive_directory'}},$i);
14420: }
14421: $env{'form.archive_'.$i} = 'dependency';
14422: }
14423: $total ++;
14424: }
14425: for (my $i=1; $i<$total; $i++) {
14426: next if ($i == $displayed{'web'});
14427: next if ($i == $displayed{'folder'});
14428: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14429: }
14430: $env{'form.phase'} = 'decompress_cleanup';
14431: $env{'form.archivedelete'} = 1;
14432: $env{'form.archive_count'} = $total-1;
14433: $output .=
14434: &process_extracted_files('coursedocs',$docudom,
14435: $docuname,$destination,
14436: $dir_root,$hiddenelem);
14437: }
1.1055 raeburn 14438: } else {
14439: $warning = &mt('No new items extracted from archive file.');
14440: }
14441: } else {
14442: $output = $display;
14443: $error = &mt('An error occurred during extraction from the archive file.');
14444: }
14445: }
14446: }
14447: }
14448: if ($error) {
14449: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14450: $error.'</p>'."\n";
14451: }
14452: if ($warning) {
14453: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14454: }
14455: return $output;
14456: }
14457:
14458: sub get_extracted {
1.1056 raeburn 14459: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14460: $titles,$wantform) = @_;
1.1055 raeburn 14461: my $count = 0;
14462: my $depth = 0;
14463: my $datatable;
1.1056 raeburn 14464: my @hierarchy;
1.1055 raeburn 14465: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14466: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14467: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14468: foreach my $item (@{$contents}) {
14469: $count ++;
1.1056 raeburn 14470: @{$dirorder->{$count}} = @hierarchy;
14471: $titles->{$count} = $item;
1.1055 raeburn 14472: &archive_hierarchy($depth,$count,$parent,$children);
14473: if ($wantform) {
14474: $datatable .= &archive_row($is_dir->{$item},$item,
14475: $currdir,$depth,$count);
14476: }
14477: if ($is_dir->{$item}) {
14478: $depth ++;
1.1056 raeburn 14479: push(@hierarchy,$count);
14480: $parent->{$depth} = $count;
1.1055 raeburn 14481: $datatable .=
14482: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14483: \$depth,\$count,\@hierarchy,$dirorder,
14484: $children,$parent,$titles,$wantform);
1.1055 raeburn 14485: $depth --;
1.1056 raeburn 14486: pop(@hierarchy);
1.1055 raeburn 14487: }
14488: }
14489: return ($count,$datatable);
14490: }
14491:
14492: sub recurse_extracted_archive {
1.1056 raeburn 14493: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14494: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14495: my $result='';
1.1056 raeburn 14496: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14497: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14498: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14499: return $result;
14500: }
14501: my $dirptr = 16384;
14502: my ($newdirlistref,$newlisterror) =
14503: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14504: if (ref($newdirlistref) eq 'ARRAY') {
14505: foreach my $dir_line (@{$newdirlistref}) {
14506: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14507: unless ($item =~ /^\.+$/) {
14508: $$count ++;
1.1056 raeburn 14509: @{$dirorder->{$$count}} = @{$hierarchy};
14510: $titles->{$$count} = $item;
1.1055 raeburn 14511: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14512:
1.1055 raeburn 14513: my $is_dir;
14514: if ($dirptr&$testdir) {
14515: $is_dir = 1;
14516: }
14517: if ($wantform) {
14518: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14519: }
14520: if ($is_dir) {
14521: $$depth ++;
1.1056 raeburn 14522: push(@{$hierarchy},$$count);
14523: $parent->{$$depth} = $$count;
1.1055 raeburn 14524: $result .=
14525: &recurse_extracted_archive("$currdir/$item",$docudom,
14526: $docuname,$depth,$count,
1.1056 raeburn 14527: $hierarchy,$dirorder,$children,
14528: $parent,$titles,$wantform);
1.1055 raeburn 14529: $$depth --;
1.1056 raeburn 14530: pop(@{$hierarchy});
1.1055 raeburn 14531: }
14532: }
14533: }
14534: }
14535: return $result;
14536: }
14537:
14538: sub archive_hierarchy {
14539: my ($depth,$count,$parent,$children) =@_;
14540: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14541: if (exists($parent->{$depth})) {
14542: $children->{$parent->{$depth}} .= $count.':';
14543: }
14544: }
14545: return;
14546: }
14547:
14548: sub archive_row {
14549: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14550: my ($name) = ($item =~ m{([^/]+)$});
14551: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14552: 'display' => 'Add as file',
1.1055 raeburn 14553: 'dependency' => 'Include as dependency',
14554: 'discard' => 'Discard',
14555: );
14556: if ($is_dir) {
1.1059 raeburn 14557: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14558: }
1.1056 raeburn 14559: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14560: my $offset = 0;
1.1055 raeburn 14561: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14562: $offset ++;
1.1065 raeburn 14563: if ($action ne 'display') {
14564: $offset ++;
14565: }
1.1055 raeburn 14566: $output .= '<td><span class="LC_nobreak">'.
14567: '<label><input type="radio" name="archive_'.$count.
14568: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14569: my $text = $choices{$action};
14570: if ($is_dir) {
14571: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14572: if ($action eq 'display') {
1.1059 raeburn 14573: $text = &mt('Add as folder');
1.1055 raeburn 14574: }
1.1056 raeburn 14575: } else {
14576: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14577:
14578: }
14579: $output .= ' /> '.$choices{$action}.'</label></span>';
14580: if ($action eq 'dependency') {
14581: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14582: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14583: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14584: '<option value=""></option>'."\n".
14585: '</select>'."\n".
14586: '</div>';
1.1059 raeburn 14587: } elsif ($action eq 'display') {
14588: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14589: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14590: '</div>';
1.1055 raeburn 14591: }
1.1056 raeburn 14592: $output .= '</td>';
1.1055 raeburn 14593: }
14594: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14595: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14596: for (my $i=0; $i<$depth; $i++) {
14597: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14598: }
14599: if ($is_dir) {
14600: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14601: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14602: } else {
14603: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14604: }
14605: $output .= ' '.$name.'</td>'."\n".
14606: &end_data_table_row();
14607: return $output;
14608: }
14609:
14610: sub archive_options_form {
1.1065 raeburn 14611: my ($form,$display,$count,$hiddenelem) = @_;
14612: my %lt = &Apache::lonlocal::texthash(
14613: perm => 'Permanently remove archive file?',
14614: hows => 'How should each extracted item be incorporated in the course?',
14615: cont => 'Content actions for all',
14616: addf => 'Add as folder/file',
14617: incd => 'Include as dependency for a displayed file',
14618: disc => 'Discard',
14619: no => 'No',
14620: yes => 'Yes',
14621: save => 'Save',
14622: );
14623: my $output = <<"END";
14624: <form name="$form" method="post" action="">
14625: <p><span class="LC_nobreak">$lt{'perm'}
14626: <label>
14627: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14628: </label>
14629:
14630: <label>
14631: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14632: </span>
14633: </p>
14634: <input type="hidden" name="phase" value="decompress_cleanup" />
14635: <br />$lt{'hows'}
14636: <div class="LC_columnSection">
14637: <fieldset>
14638: <legend>$lt{'cont'}</legend>
14639: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14640: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14641: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14642: </fieldset>
14643: </div>
14644: END
14645: return $output.
1.1055 raeburn 14646: &start_data_table()."\n".
1.1065 raeburn 14647: $display."\n".
1.1055 raeburn 14648: &end_data_table()."\n".
14649: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14650: $hiddenelem.
1.1065 raeburn 14651: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14652: '</form>';
14653: }
14654:
14655: sub archive_javascript {
1.1056 raeburn 14656: my ($startcount,$numitems,$titles,$children) = @_;
14657: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14658: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14659: my $scripttag = <<START;
14660: <script type="text/javascript">
14661: // <![CDATA[
14662:
14663: function checkAll(form,prefix) {
14664: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14665: for (var i=0; i < form.elements.length; i++) {
14666: var id = form.elements[i].id;
14667: if ((id != '') && (id != undefined)) {
14668: if (idstr.test(id)) {
14669: if (form.elements[i].type == 'radio') {
14670: form.elements[i].checked = true;
1.1056 raeburn 14671: var nostart = i-$startcount;
1.1059 raeburn 14672: var offset = nostart%7;
14673: var count = (nostart-offset)/7;
1.1056 raeburn 14674: dependencyCheck(form,count,offset);
1.1055 raeburn 14675: }
14676: }
14677: }
14678: }
14679: }
14680:
14681: function propagateCheck(form,count) {
14682: if (count > 0) {
1.1059 raeburn 14683: var startelement = $startcount + ((count-1) * 7);
14684: for (var j=1; j<6; j++) {
14685: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14686: var item = startelement + j;
14687: if (form.elements[item].type == 'radio') {
14688: if (form.elements[item].checked) {
14689: containerCheck(form,count,j);
14690: break;
14691: }
1.1055 raeburn 14692: }
14693: }
14694: }
14695: }
14696: }
14697:
14698: numitems = $numitems
1.1056 raeburn 14699: var titles = new Array(numitems);
14700: var parents = new Array(numitems);
1.1055 raeburn 14701: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14702: parents[i] = new Array;
1.1055 raeburn 14703: }
1.1059 raeburn 14704: var maintitle = '$maintitle';
1.1055 raeburn 14705:
14706: START
14707:
1.1056 raeburn 14708: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14709: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14710: for (my $i=0; $i<@contents; $i ++) {
14711: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14712: }
14713: }
14714:
1.1056 raeburn 14715: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14716: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14717: }
14718:
1.1055 raeburn 14719: $scripttag .= <<END;
14720:
14721: function containerCheck(form,count,offset) {
14722: if (count > 0) {
1.1056 raeburn 14723: dependencyCheck(form,count,offset);
1.1059 raeburn 14724: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14725: form.elements[item].checked = true;
14726: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14727: if (parents[count].length > 0) {
14728: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14729: containerCheck(form,parents[count][j],offset);
14730: }
14731: }
14732: }
14733: }
14734: }
14735:
14736: function dependencyCheck(form,count,offset) {
14737: if (count > 0) {
1.1059 raeburn 14738: var chosen = (offset+$startcount)+7*(count-1);
14739: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14740: var currtype = form.elements[depitem].type;
14741: if (form.elements[chosen].value == 'dependency') {
14742: document.getElementById('arc_depon_'+count).style.display='block';
14743: form.elements[depitem].options.length = 0;
14744: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14745: for (var i=1; i<=numitems; i++) {
14746: if (i == count) {
14747: continue;
14748: }
1.1059 raeburn 14749: var startelement = $startcount + (i-1) * 7;
14750: for (var j=1; j<6; j++) {
14751: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14752: var item = startelement + j;
14753: if (form.elements[item].type == 'radio') {
14754: if (form.elements[item].checked) {
14755: if (form.elements[item].value == 'display') {
14756: var n = form.elements[depitem].options.length;
14757: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14758: }
14759: }
14760: }
14761: }
14762: }
14763: }
14764: } else {
14765: document.getElementById('arc_depon_'+count).style.display='none';
14766: form.elements[depitem].options.length = 0;
14767: form.elements[depitem].options[0] = new Option('Select','',true,true);
14768: }
1.1059 raeburn 14769: titleCheck(form,count,offset);
1.1056 raeburn 14770: }
14771: }
14772:
14773: function propagateSelect(form,count,offset) {
14774: if (count > 0) {
1.1065 raeburn 14775: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14776: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14777: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14778: if (parents[count].length > 0) {
14779: for (var j=0; j<parents[count].length; j++) {
14780: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14781: }
14782: }
14783: }
14784: }
14785: }
1.1056 raeburn 14786:
14787: function containerSelect(form,count,offset,picked) {
14788: if (count > 0) {
1.1065 raeburn 14789: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14790: if (form.elements[item].type == 'radio') {
14791: if (form.elements[item].value == 'dependency') {
14792: if (form.elements[item+1].type == 'select-one') {
14793: for (var i=0; i<form.elements[item+1].options.length; i++) {
14794: if (form.elements[item+1].options[i].value == picked) {
14795: form.elements[item+1].selectedIndex = i;
14796: break;
14797: }
14798: }
14799: }
14800: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14801: if (parents[count].length > 0) {
14802: for (var j=0; j<parents[count].length; j++) {
14803: containerSelect(form,parents[count][j],offset,picked);
14804: }
14805: }
14806: }
14807: }
14808: }
14809: }
14810: }
14811:
1.1059 raeburn 14812: function titleCheck(form,count,offset) {
14813: if (count > 0) {
14814: var chosen = (offset+$startcount)+7*(count-1);
14815: var depitem = $startcount + ((count-1) * 7) + 2;
14816: var currtype = form.elements[depitem].type;
14817: if (form.elements[chosen].value == 'display') {
14818: document.getElementById('arc_title_'+count).style.display='block';
14819: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14820: document.getElementById('archive_title_'+count).value=maintitle;
14821: }
14822: } else {
14823: document.getElementById('arc_title_'+count).style.display='none';
14824: if (currtype == 'text') {
14825: document.getElementById('archive_title_'+count).value='';
14826: }
14827: }
14828: }
14829: return;
14830: }
14831:
1.1055 raeburn 14832: // ]]>
14833: </script>
14834: END
14835: return $scripttag;
14836: }
14837:
14838: sub process_extracted_files {
1.1067 raeburn 14839: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14840: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14841: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14842: my @ids=&Apache::lonnet::current_machine_ids();
14843: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14844: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14845: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14846: if (grep(/^\Q$docuhome\E$/,@ids)) {
14847: $prefix = &LONCAPA::propath($docudom,$docuname);
14848: $pathtocheck = "$dir_root/$destination";
14849: $dir = $dir_root;
14850: $ishome = 1;
14851: } else {
14852: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14853: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14854: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14855: }
14856: my $currdir = "$dir_root/$destination";
14857: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14858: if ($env{'form.folderpath'}) {
14859: my @items = split('&',$env{'form.folderpath'});
14860: $folders{'0'} = $items[-2];
1.1099 raeburn 14861: if ($env{'form.folderpath'} =~ /\:1$/) {
14862: $containers{'0'}='page';
14863: } else {
14864: $containers{'0'}='sequence';
14865: }
1.1055 raeburn 14866: }
14867: my @archdirs = &get_env_multiple('form.archive_directory');
14868: if ($numitems) {
14869: for (my $i=1; $i<=$numitems; $i++) {
14870: my $path = $env{'form.archive_content_'.$i};
14871: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14872: my $item = $1;
14873: $toplevelitems{$item} = $i;
14874: if (grep(/^\Q$i\E$/,@archdirs)) {
14875: $is_dir{$item} = 1;
14876: }
14877: }
14878: }
14879: }
1.1067 raeburn 14880: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14881: if (keys(%toplevelitems) > 0) {
14882: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14883: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14884: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14885: }
1.1066 raeburn 14886: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14887: if ($numitems) {
14888: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14889: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14890: my $path = $env{'form.archive_content_'.$i};
14891: if ($path =~ /^\Q$pathtocheck\E/) {
14892: if ($env{'form.archive_'.$i} eq 'discard') {
14893: if ($prefix ne '' && $path ne '') {
14894: if (-e $prefix.$path) {
1.1066 raeburn 14895: if ((@archdirs > 0) &&
14896: (grep(/^\Q$i\E$/,@archdirs))) {
14897: $todeletedir{$prefix.$path} = 1;
14898: } else {
14899: $todelete{$prefix.$path} = 1;
14900: }
1.1055 raeburn 14901: }
14902: }
14903: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14904: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14905: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14906: $docstitle = $env{'form.archive_title_'.$i};
14907: if ($docstitle eq '') {
14908: $docstitle = $title;
14909: }
1.1055 raeburn 14910: $outer = 0;
1.1056 raeburn 14911: if (ref($dirorder{$i}) eq 'ARRAY') {
14912: if (@{$dirorder{$i}} > 0) {
14913: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14914: if ($env{'form.archive_'.$item} eq 'display') {
14915: $outer = $item;
14916: last;
14917: }
14918: }
14919: }
14920: }
14921: my ($errtext,$fatal) =
14922: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14923: '/'.$folders{$outer}.'.'.
14924: $containers{$outer});
14925: next if ($fatal);
14926: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14927: if ($context eq 'coursedocs') {
1.1056 raeburn 14928: $mapinner{$i} = time;
1.1055 raeburn 14929: $folders{$i} = 'default_'.$mapinner{$i};
14930: $containers{$i} = 'sequence';
14931: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14932: $folders{$i}.'.'.$containers{$i};
14933: my $newidx = &LONCAPA::map::getresidx();
14934: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14935: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14936: push(@LONCAPA::map::order,$newidx);
14937: my ($outtext,$errtext) =
14938: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14939: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14940: '.'.$containers{$outer},1,1);
1.1056 raeburn 14941: $newseqid{$i} = $newidx;
1.1067 raeburn 14942: unless ($errtext) {
1.1294 raeburn 14943: $result .= '<li>'.&mt('Folder: [_1] added to course',
14944: &HTML::Entities::encode($docstitle,'<>&"')).
14945: '</li>'."\n";
1.1067 raeburn 14946: }
1.1055 raeburn 14947: }
14948: } else {
14949: if ($context eq 'coursedocs') {
14950: my $newidx=&LONCAPA::map::getresidx();
14951: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14952: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14953: $title;
1.1392 raeburn 14954: if (($outer !~ /\D/) &&
14955: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14956: ($newidx !~ /\D/)) {
1.1294 raeburn 14957: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14958: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14959: }
14960: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14961: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14962: }
14963: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14964: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14965: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14966: unless ($ishome) {
14967: my $fetch = "$newdest{$i}/$title";
14968: $fetch =~ s/^\Q$prefix$dir\E//;
14969: $prompttofetch{$fetch} = 1;
14970: }
1.1292 raeburn 14971: }
1.1067 raeburn 14972: }
1.1294 raeburn 14973: $LONCAPA::map::resources[$newidx]=
14974: $docstitle.':'.$url.':false:normal:res';
14975: push(@LONCAPA::map::order, $newidx);
14976: my ($outtext,$errtext)=
14977: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14978: $docuname.'/'.$folders{$outer}.
14979: '.'.$containers{$outer},1,1);
14980: unless ($errtext) {
14981: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14982: $result .= '<li>'.&mt('File: [_1] added to course',
14983: &HTML::Entities::encode($docstitle,'<>&"')).
14984: '</li>'."\n";
14985: }
1.1067 raeburn 14986: }
1.1294 raeburn 14987: } else {
14988: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14989: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14990: }
1.1055 raeburn 14991: }
14992: }
1.1086 raeburn 14993: }
14994: } else {
1.1294 raeburn 14995: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14996: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14997: }
14998: }
14999: for (my $i=1; $i<=$numitems; $i++) {
15000: next unless ($env{'form.archive_'.$i} eq 'dependency');
15001: my $path = $env{'form.archive_content_'.$i};
15002: if ($path =~ /^\Q$pathtocheck\E/) {
15003: my ($title) = ($path =~ m{/([^/]+)$});
15004: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
15005: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
15006: if (ref($dirorder{$i}) eq 'ARRAY') {
15007: my ($itemidx,$fullpath,$relpath);
15008: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
15009: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 15010: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 15011: if ($dirorder{$i}->[$j] eq $container) {
15012: $itemidx = $j;
1.1056 raeburn 15013: }
15014: }
1.1086 raeburn 15015: }
15016: if ($itemidx eq '') {
15017: $itemidx = 0;
15018: }
15019: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
15020: if ($mapinner{$referrer{$i}}) {
15021: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
15022: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15023: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15024: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15025: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15026: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15027: if (!-e $fullpath) {
15028: mkdir($fullpath,0755);
1.1056 raeburn 15029: }
15030: }
1.1086 raeburn 15031: } else {
15032: last;
1.1056 raeburn 15033: }
1.1086 raeburn 15034: }
15035: }
15036: } elsif ($newdest{$referrer{$i}}) {
15037: $fullpath = $newdest{$referrer{$i}};
15038: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15039: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
15040: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
15041: last;
15042: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15043: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15044: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15045: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15046: if (!-e $fullpath) {
15047: mkdir($fullpath,0755);
1.1056 raeburn 15048: }
15049: }
1.1086 raeburn 15050: } else {
15051: last;
1.1056 raeburn 15052: }
1.1055 raeburn 15053: }
15054: }
1.1086 raeburn 15055: if ($fullpath ne '') {
15056: if (-e "$prefix$path") {
1.1292 raeburn 15057: unless (rename("$prefix$path","$fullpath/$title")) {
15058: $warning .= &mt('Failed to rename dependency').'<br />';
15059: }
1.1086 raeburn 15060: }
15061: if (-e "$fullpath/$title") {
15062: my $showpath;
15063: if ($relpath ne '') {
15064: $showpath = "$relpath/$title";
15065: } else {
15066: $showpath = "/$title";
15067: }
1.1294 raeburn 15068: $result .= '<li>'.&mt('[_1] included as a dependency',
15069: &HTML::Entities::encode($showpath,'<>&"')).
15070: '</li>'."\n";
1.1292 raeburn 15071: unless ($ishome) {
15072: my $fetch = "$fullpath/$title";
15073: $fetch =~ s/^\Q$prefix$dir\E//;
15074: $prompttofetch{$fetch} = 1;
15075: }
1.1086 raeburn 15076: }
15077: }
1.1055 raeburn 15078: }
1.1086 raeburn 15079: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15080: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15081: &HTML::Entities::encode($path,'<>&"'),
15082: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15083: '<br />';
1.1055 raeburn 15084: }
15085: } else {
1.1294 raeburn 15086: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15087: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15088: }
15089: }
15090: if (keys(%todelete)) {
15091: foreach my $key (keys(%todelete)) {
15092: unlink($key);
1.1066 raeburn 15093: }
15094: }
15095: if (keys(%todeletedir)) {
15096: foreach my $key (keys(%todeletedir)) {
15097: rmdir($key);
15098: }
15099: }
15100: foreach my $dir (sort(keys(%is_dir))) {
15101: if (($pathtocheck ne '') && ($dir ne '')) {
15102: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15103: }
15104: }
1.1067 raeburn 15105: if ($result ne '') {
15106: $output .= '<ul>'."\n".
15107: $result."\n".
15108: '</ul>';
15109: }
15110: unless ($ishome) {
15111: my $replicationfail;
15112: foreach my $item (keys(%prompttofetch)) {
15113: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15114: unless ($fetchresult eq 'ok') {
15115: $replicationfail .= '<li>'.$item.'</li>'."\n";
15116: }
15117: }
15118: if ($replicationfail) {
15119: $output .= '<p class="LC_error">'.
15120: &mt('Course home server failed to retrieve:').'<ul>'.
15121: $replicationfail.
15122: '</ul></p>';
15123: }
15124: }
1.1055 raeburn 15125: } else {
15126: $warning = &mt('No items found in archive.');
15127: }
15128: if ($error) {
15129: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15130: $error.'</p>'."\n";
15131: }
15132: if ($warning) {
15133: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15134: }
15135: return $output;
15136: }
15137:
1.1066 raeburn 15138: sub cleanup_empty_dirs {
15139: my ($path) = @_;
15140: if (($path ne '') && (-d $path)) {
15141: if (opendir(my $dirh,$path)) {
15142: my @dircontents = grep(!/^\./,readdir($dirh));
15143: my $numitems = 0;
15144: foreach my $item (@dircontents) {
15145: if (-d "$path/$item") {
1.1111 raeburn 15146: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15147: if (-e "$path/$item") {
15148: $numitems ++;
15149: }
15150: } else {
15151: $numitems ++;
15152: }
15153: }
15154: if ($numitems == 0) {
15155: rmdir($path);
15156: }
15157: closedir($dirh);
15158: }
15159: }
15160: return;
15161: }
15162:
1.41 ng 15163: =pod
1.45 matthew 15164:
1.1162 raeburn 15165: =item * &get_folder_hierarchy()
1.1068 raeburn 15166:
15167: Provides hierarchy of names of folders/sub-folders containing the current
15168: item,
15169:
15170: Inputs: 3
15171: - $navmap - navmaps object
15172:
15173: - $map - url for map (either the trigger itself, or map containing
15174: the resource, which is the trigger).
15175:
15176: - $showitem - 1 => show title for map itself; 0 => do not show.
15177:
15178: Outputs: 1 @pathitems - array of folder/subfolder names.
15179:
15180: =cut
15181:
15182: sub get_folder_hierarchy {
15183: my ($navmap,$map,$showitem) = @_;
15184: my @pathitems;
15185: if (ref($navmap)) {
15186: my $mapres = $navmap->getResourceByUrl($map);
15187: if (ref($mapres)) {
15188: my $pcslist = $mapres->map_hierarchy();
15189: if ($pcslist ne '') {
15190: my @pcs = split(/,/,$pcslist);
15191: foreach my $pc (@pcs) {
15192: if ($pc == 1) {
1.1129 raeburn 15193: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15194: } else {
15195: my $res = $navmap->getByMapPc($pc);
15196: if (ref($res)) {
15197: my $title = $res->compTitle();
15198: $title =~ s/\W+/_/g;
15199: if ($title ne '') {
15200: push(@pathitems,$title);
15201: }
15202: }
15203: }
15204: }
15205: }
1.1071 raeburn 15206: if ($showitem) {
15207: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15208: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15209: } else {
15210: my $maptitle = $mapres->compTitle();
15211: $maptitle =~ s/\W+/_/g;
15212: if ($maptitle ne '') {
15213: push(@pathitems,$maptitle);
15214: }
1.1068 raeburn 15215: }
15216: }
15217: }
15218: }
15219: return @pathitems;
15220: }
15221:
15222: =pod
15223:
1.1015 raeburn 15224: =item * &get_turnedin_filepath()
15225:
15226: Determines path in a user's portfolio file for storage of files uploaded
15227: to a specific essayresponse or dropbox item.
15228:
15229: Inputs: 3 required + 1 optional.
15230: $symb is symb for resource, $uname and $udom are for current user (required).
15231: $caller is optional (can be "submission", if routine is called when storing
15232: an upoaded file when "Submit Answer" button was pressed).
15233:
15234: Returns array containing $path and $multiresp.
15235: $path is path in portfolio. $multiresp is 1 if this resource contains more
15236: than one file upload item. Callers of routine should append partid as a
15237: subdirectory to $path in cases where $multiresp is 1.
15238:
15239: Called by: homework/essayresponse.pm and homework/structuretags.pm
15240:
15241: =cut
15242:
15243: sub get_turnedin_filepath {
15244: my ($symb,$uname,$udom,$caller) = @_;
15245: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15246: my $turnindir;
15247: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15248: $turnindir = $userhash{'turnindir'};
15249: my ($path,$multiresp);
15250: if ($turnindir eq '') {
15251: if ($caller eq 'submission') {
15252: $turnindir = &mt('turned in');
15253: $turnindir =~ s/\W+/_/g;
15254: my %newhash = (
15255: 'turnindir' => $turnindir,
15256: );
15257: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15258: }
15259: }
15260: if ($turnindir ne '') {
15261: $path = '/'.$turnindir.'/';
15262: my ($multipart,$turnin,@pathitems);
15263: my $navmap = Apache::lonnavmaps::navmap->new();
15264: if (defined($navmap)) {
15265: my $mapres = $navmap->getResourceByUrl($map);
15266: if (ref($mapres)) {
15267: my $pcslist = $mapres->map_hierarchy();
15268: if ($pcslist ne '') {
15269: foreach my $pc (split(/,/,$pcslist)) {
15270: my $res = $navmap->getByMapPc($pc);
15271: if (ref($res)) {
15272: my $title = $res->compTitle();
15273: $title =~ s/\W+/_/g;
15274: if ($title ne '') {
1.1149 raeburn 15275: if (($pc > 1) && (length($title) > 12)) {
15276: $title = substr($title,0,12);
15277: }
1.1015 raeburn 15278: push(@pathitems,$title);
15279: }
15280: }
15281: }
15282: }
15283: my $maptitle = $mapres->compTitle();
15284: $maptitle =~ s/\W+/_/g;
15285: if ($maptitle ne '') {
1.1149 raeburn 15286: if (length($maptitle) > 12) {
15287: $maptitle = substr($maptitle,0,12);
15288: }
1.1015 raeburn 15289: push(@pathitems,$maptitle);
15290: }
15291: unless ($env{'request.state'} eq 'construct') {
15292: my $res = $navmap->getBySymb($symb);
15293: if (ref($res)) {
15294: my $partlist = $res->parts();
15295: my $totaluploads = 0;
15296: if (ref($partlist) eq 'ARRAY') {
15297: foreach my $part (@{$partlist}) {
15298: my @types = $res->responseType($part);
15299: my @ids = $res->responseIds($part);
15300: for (my $i=0; $i < scalar(@ids); $i++) {
15301: if ($types[$i] eq 'essay') {
15302: my $partid = $part.'_'.$ids[$i];
15303: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15304: $totaluploads ++;
15305: }
15306: }
15307: }
15308: }
15309: if ($totaluploads > 1) {
15310: $multiresp = 1;
15311: }
15312: }
15313: }
15314: }
15315: } else {
15316: return;
15317: }
15318: } else {
15319: return;
15320: }
15321: my $restitle=&Apache::lonnet::gettitle($symb);
15322: $restitle =~ s/\W+/_/g;
15323: if ($restitle eq '') {
15324: $restitle = ($resurl =~ m{/[^/]+$});
15325: if ($restitle eq '') {
15326: $restitle = time;
15327: }
15328: }
1.1149 raeburn 15329: if (length($restitle) > 12) {
15330: $restitle = substr($restitle,0,12);
15331: }
1.1015 raeburn 15332: push(@pathitems,$restitle);
15333: $path .= join('/',@pathitems);
15334: }
15335: return ($path,$multiresp);
15336: }
15337:
15338: =pod
15339:
1.464 albertel 15340: =back
1.41 ng 15341:
1.112 bowersj2 15342: =head1 CSV Upload/Handling functions
1.38 albertel 15343:
1.41 ng 15344: =over 4
15345:
1.648 raeburn 15346: =item * &upfile_store($r)
1.41 ng 15347:
15348: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15349: needs $env{'form.upfile'}
1.41 ng 15350: returns $datatoken to be put into hidden field
15351:
15352: =cut
1.31 albertel 15353:
15354: sub upfile_store {
15355: my $r=shift;
1.258 albertel 15356: $env{'form.upfile'}=~s/\r/\n/gs;
15357: $env{'form.upfile'}=~s/\f/\n/gs;
15358: $env{'form.upfile'}=~s/\n+/\n/gs;
15359: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15360:
1.1299 raeburn 15361: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15362: '_enroll_'.$env{'request.course.id'}.'_'.
15363: time.'_'.$$);
15364: return if ($datatoken eq '');
15365:
1.31 albertel 15366: {
1.158 raeburn 15367: my $datafile = $r->dir_config('lonDaemons').
15368: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15369: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15370: print $fh $env{'form.upfile'};
1.158 raeburn 15371: close($fh);
15372: }
1.31 albertel 15373: }
15374: return $datatoken;
15375: }
15376:
1.56 matthew 15377: =pod
15378:
1.1290 raeburn 15379: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15380:
15381: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15382: $datatoken is the name to assign to the temporary file.
1.258 albertel 15383: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15384:
15385: =cut
1.31 albertel 15386:
15387: sub load_tmp_file {
1.1290 raeburn 15388: my ($r,$datatoken) = @_;
15389: return if ($datatoken eq '');
1.31 albertel 15390: my @studentdata=();
15391: {
1.158 raeburn 15392: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15393: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15394: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15395: @studentdata=<$fh>;
15396: close($fh);
15397: }
1.31 albertel 15398: }
1.258 albertel 15399: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15400: }
15401:
1.1290 raeburn 15402: sub valid_datatoken {
15403: my ($datatoken) = @_;
1.1325 raeburn 15404: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15405: return $datatoken;
15406: }
15407: return;
15408: }
15409:
1.56 matthew 15410: =pod
15411:
1.648 raeburn 15412: =item * &upfile_record_sep()
1.41 ng 15413:
15414: Separate uploaded file into records
15415: returns array of records,
1.258 albertel 15416: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15417:
15418: =cut
1.31 albertel 15419:
15420: sub upfile_record_sep {
1.258 albertel 15421: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15422: } else {
1.248 albertel 15423: my @records;
1.258 albertel 15424: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15425: if ($line=~/^\s*$/) { next; }
15426: push(@records,$line);
15427: }
15428: return @records;
1.31 albertel 15429: }
15430: }
15431:
1.56 matthew 15432: =pod
15433:
1.648 raeburn 15434: =item * &record_sep($record)
1.41 ng 15435:
1.258 albertel 15436: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15437:
15438: =cut
15439:
1.263 www 15440: sub takeleft {
15441: my $index=shift;
15442: return substr('0000'.$index,-4,4);
15443: }
15444:
1.31 albertel 15445: sub record_sep {
15446: my $record=shift;
15447: my %components=();
1.258 albertel 15448: if ($env{'form.upfiletype'} eq 'xml') {
15449: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15450: my $i=0;
1.356 albertel 15451: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15452: $field=~s/^(\"|\')//;
15453: $field=~s/(\"|\')$//;
1.263 www 15454: $components{&takeleft($i)}=$field;
1.31 albertel 15455: $i++;
15456: }
1.258 albertel 15457: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15458: my $i=0;
1.356 albertel 15459: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15460: $field=~s/^(\"|\')//;
15461: $field=~s/(\"|\')$//;
1.263 www 15462: $components{&takeleft($i)}=$field;
1.31 albertel 15463: $i++;
15464: }
15465: } else {
1.561 www 15466: my $separator=',';
1.480 banghart 15467: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15468: $separator=';';
1.480 banghart 15469: }
1.31 albertel 15470: my $i=0;
1.561 www 15471: # the character we are looking for to indicate the end of a quote or a record
15472: my $looking_for=$separator;
15473: # do not add the characters to the fields
15474: my $ignore=0;
15475: # we just encountered a separator (or the beginning of the record)
15476: my $just_found_separator=1;
15477: # store the field we are working on here
15478: my $field='';
15479: # work our way through all characters in record
15480: foreach my $character ($record=~/(.)/g) {
15481: if ($character eq $looking_for) {
15482: if ($character ne $separator) {
15483: # Found the end of a quote, again looking for separator
15484: $looking_for=$separator;
15485: $ignore=1;
15486: } else {
15487: # Found a separator, store away what we got
15488: $components{&takeleft($i)}=$field;
15489: $i++;
15490: $just_found_separator=1;
15491: $ignore=0;
15492: $field='';
15493: }
15494: next;
15495: }
15496: # single or double quotation marks after a separator indicate beginning of a quote
15497: # we are now looking for the end of the quote and need to ignore separators
15498: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15499: $looking_for=$character;
15500: next;
15501: }
15502: # ignore would be true after we reached the end of a quote
15503: if ($ignore) { next; }
15504: if (($just_found_separator) && ($character=~/\s/)) { next; }
15505: $field.=$character;
15506: $just_found_separator=0;
1.31 albertel 15507: }
1.561 www 15508: # catch the very last entry, since we never encountered the separator
15509: $components{&takeleft($i)}=$field;
1.31 albertel 15510: }
15511: return %components;
15512: }
15513:
1.144 matthew 15514: ######################################################
15515: ######################################################
15516:
1.56 matthew 15517: =pod
15518:
1.648 raeburn 15519: =item * &upfile_select_html()
1.41 ng 15520:
1.144 matthew 15521: Return HTML code to select a file from the users machine and specify
15522: the file type.
1.41 ng 15523:
15524: =cut
15525:
1.144 matthew 15526: ######################################################
15527: ######################################################
1.31 albertel 15528: sub upfile_select_html {
1.144 matthew 15529: my %Types = (
15530: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15531: semisv => &mt('Semicolon separated values'),
1.144 matthew 15532: space => &mt('Space separated'),
15533: tab => &mt('Tabulator separated'),
15534: # xml => &mt('HTML/XML'),
15535: );
15536: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15537: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15538: foreach my $type (sort(keys(%Types))) {
15539: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15540: }
15541: $Str .= "</select>\n";
15542: return $Str;
1.31 albertel 15543: }
15544:
1.301 albertel 15545: sub get_samples {
15546: my ($records,$toget) = @_;
15547: my @samples=({});
15548: my $got=0;
15549: foreach my $rec (@$records) {
15550: my %temp = &record_sep($rec);
15551: if (! grep(/\S/, values(%temp))) { next; }
15552: if (%temp) {
15553: $samples[$got]=\%temp;
15554: $got++;
15555: if ($got == $toget) { last; }
15556: }
15557: }
15558: return \@samples;
15559: }
15560:
1.144 matthew 15561: ######################################################
15562: ######################################################
15563:
1.56 matthew 15564: =pod
15565:
1.648 raeburn 15566: =item * &csv_print_samples($r,$records)
1.41 ng 15567:
15568: Prints a table of sample values from each column uploaded $r is an
15569: Apache Request ref, $records is an arrayref from
15570: &Apache::loncommon::upfile_record_sep
15571:
15572: =cut
15573:
1.144 matthew 15574: ######################################################
15575: ######################################################
1.31 albertel 15576: sub csv_print_samples {
15577: my ($r,$records) = @_;
1.662 bisitz 15578: my $samples = &get_samples($records,5);
1.301 albertel 15579:
1.594 raeburn 15580: $r->print(&mt('Samples').'<br />'.&start_data_table().
15581: &start_data_table_header_row());
1.356 albertel 15582: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15583: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15584: $r->print(&end_data_table_header_row());
1.301 albertel 15585: foreach my $hash (@$samples) {
1.594 raeburn 15586: $r->print(&start_data_table_row());
1.356 albertel 15587: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15588: $r->print('<td>');
1.356 albertel 15589: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15590: $r->print('</td>');
15591: }
1.594 raeburn 15592: $r->print(&end_data_table_row());
1.31 albertel 15593: }
1.594 raeburn 15594: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15595: }
15596:
1.144 matthew 15597: ######################################################
15598: ######################################################
15599:
1.56 matthew 15600: =pod
15601:
1.648 raeburn 15602: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15603:
15604: Prints a table to create associations between values and table columns.
1.144 matthew 15605:
1.41 ng 15606: $r is an Apache Request ref,
15607: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15608: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15609:
15610: =cut
15611:
1.144 matthew 15612: ######################################################
15613: ######################################################
1.31 albertel 15614: sub csv_print_select_table {
15615: my ($r,$records,$d) = @_;
1.301 albertel 15616: my $i=0;
15617: my $samples = &get_samples($records,1);
1.144 matthew 15618: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15619: &start_data_table().&start_data_table_header_row().
1.144 matthew 15620: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15621: '<th>'.&mt('Column').'</th>'.
15622: &end_data_table_header_row()."\n");
1.356 albertel 15623: foreach my $array_ref (@$d) {
15624: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15625: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15626:
1.875 bisitz 15627: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15628: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15629: $r->print('<option value="none"></option>');
1.356 albertel 15630: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15631: $r->print('<option value="'.$sample.'"'.
15632: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15633: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15634: }
1.594 raeburn 15635: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15636: $i++;
15637: }
1.594 raeburn 15638: $r->print(&end_data_table());
1.31 albertel 15639: $i--;
15640: return $i;
15641: }
1.56 matthew 15642:
1.144 matthew 15643: ######################################################
15644: ######################################################
15645:
1.56 matthew 15646: =pod
1.31 albertel 15647:
1.648 raeburn 15648: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15649:
15650: Prints a table of sample values from the upload and can make associate samples to internal names.
15651:
15652: $r is an Apache Request ref,
15653: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15654: $d is an array of 2 element arrays (internal name, displayed name)
15655:
15656: =cut
15657:
1.144 matthew 15658: ######################################################
15659: ######################################################
1.31 albertel 15660: sub csv_samples_select_table {
15661: my ($r,$records,$d) = @_;
15662: my $i=0;
1.144 matthew 15663: #
1.662 bisitz 15664: my $max_samples = 5;
15665: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15666: $r->print(&start_data_table().
15667: &start_data_table_header_row().'<th>'.
15668: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15669: &end_data_table_header_row());
1.301 albertel 15670:
15671: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15672: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15673: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15674: foreach my $option (@$d) {
15675: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15676: $r->print('<option value="'.$value.'"'.
1.253 albertel 15677: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15678: $display.'</option>');
1.31 albertel 15679: }
15680: $r->print('</select></td><td>');
1.662 bisitz 15681: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15682: if (defined($samples->[$line]{$key})) {
15683: $r->print($samples->[$line]{$key}."<br />\n");
15684: }
15685: }
1.594 raeburn 15686: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15687: $i++;
15688: }
1.594 raeburn 15689: $r->print(&end_data_table());
1.31 albertel 15690: $i--;
15691: return($i);
1.115 matthew 15692: }
15693:
1.144 matthew 15694: ######################################################
15695: ######################################################
15696:
1.115 matthew 15697: =pod
15698:
1.648 raeburn 15699: =item * &clean_excel_name($name)
1.115 matthew 15700:
15701: Returns a replacement for $name which does not contain any illegal characters.
15702:
15703: =cut
15704:
1.144 matthew 15705: ######################################################
15706: ######################################################
1.115 matthew 15707: sub clean_excel_name {
15708: my ($name) = @_;
15709: $name =~ s/[:\*\?\/\\]//g;
15710: if (length($name) > 31) {
15711: $name = substr($name,0,31);
15712: }
15713: return $name;
1.25 albertel 15714: }
1.84 albertel 15715:
1.85 albertel 15716: =pod
15717:
1.648 raeburn 15718: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15719:
15720: Returns either 1 or undef
15721:
15722: 1 if the part is to be hidden, undef if it is to be shown
15723:
15724: Arguments are:
15725:
15726: $id the id of the part to be checked
15727: $symb, optional the symb of the resource to check
15728: $udom, optional the domain of the user to check for
15729: $uname, optional the username of the user to check for
15730:
15731: =cut
1.84 albertel 15732:
15733: sub check_if_partid_hidden {
15734: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15735: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15736: $symb,$udom,$uname);
1.141 albertel 15737: my $truth=1;
15738: #if the string starts with !, then the list is the list to show not hide
15739: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15740: my @hiddenlist=split(/,/,$hiddenparts);
15741: foreach my $checkid (@hiddenlist) {
1.141 albertel 15742: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15743: }
1.141 albertel 15744: return !$truth;
1.84 albertel 15745: }
1.127 matthew 15746:
1.138 matthew 15747:
15748: ############################################################
15749: ############################################################
15750:
15751: =pod
15752:
1.157 matthew 15753: =back
15754:
1.138 matthew 15755: =head1 cgi-bin script and graphing routines
15756:
1.157 matthew 15757: =over 4
15758:
1.648 raeburn 15759: =item * &get_cgi_id()
1.138 matthew 15760:
15761: Inputs: none
15762:
15763: Returns an id which can be used to pass environment variables
15764: to various cgi-bin scripts. These environment variables will
15765: be removed from the users environment after a given time by
15766: the routine &Apache::lonnet::transfer_profile_to_env.
15767:
15768: =cut
15769:
15770: ############################################################
15771: ############################################################
1.152 albertel 15772: my $uniq=0;
1.136 matthew 15773: sub get_cgi_id {
1.154 albertel 15774: $uniq=($uniq+1)%100000;
1.280 albertel 15775: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15776: }
15777:
1.127 matthew 15778: ############################################################
15779: ############################################################
15780:
15781: =pod
15782:
1.648 raeburn 15783: =item * &DrawBarGraph()
1.127 matthew 15784:
1.138 matthew 15785: Facilitates the plotting of data in a (stacked) bar graph.
15786: Puts plot definition data into the users environment in order for
15787: graph.png to plot it. Returns an <img> tag for the plot.
15788: The bars on the plot are labeled '1','2',...,'n'.
15789:
15790: Inputs:
15791:
15792: =over 4
15793:
15794: =item $Title: string, the title of the plot
15795:
15796: =item $xlabel: string, text describing the X-axis of the plot
15797:
15798: =item $ylabel: string, text describing the Y-axis of the plot
15799:
15800: =item $Max: scalar, the maximum Y value to use in the plot
15801: If $Max is < any data point, the graph will not be rendered.
15802:
1.140 matthew 15803: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15804: they are plotted. If undefined, default values will be used.
15805:
1.178 matthew 15806: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15807:
1.138 matthew 15808: =item @Values: An array of array references. Each array reference holds data
15809: to be plotted in a stacked bar chart.
15810:
1.239 matthew 15811: =item If the final element of @Values is a hash reference the key/value
15812: pairs will be added to the graph definition.
15813:
1.138 matthew 15814: =back
15815:
15816: Returns:
15817:
15818: An <img> tag which references graph.png and the appropriate identifying
15819: information for the plot.
15820:
1.127 matthew 15821: =cut
15822:
15823: ############################################################
15824: ############################################################
1.134 matthew 15825: sub DrawBarGraph {
1.178 matthew 15826: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15827: #
15828: if (! defined($colors)) {
15829: $colors = ['#33ff00',
15830: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15831: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15832: ];
15833: }
1.228 matthew 15834: my $extra_settings = {};
15835: if (ref($Values[-1]) eq 'HASH') {
15836: $extra_settings = pop(@Values);
15837: }
1.127 matthew 15838: #
1.136 matthew 15839: my $identifier = &get_cgi_id();
15840: my $id = 'cgi.'.$identifier;
1.129 matthew 15841: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15842: return '';
15843: }
1.225 matthew 15844: #
15845: my @Labels;
15846: if (defined($labels)) {
15847: @Labels = @$labels;
15848: } else {
15849: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15850: push(@Labels,$i+1);
1.225 matthew 15851: }
15852: }
15853: #
1.129 matthew 15854: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15855: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15856: my %ValuesHash;
15857: my $NumSets=1;
15858: foreach my $array (@Values) {
15859: next if (! ref($array));
1.136 matthew 15860: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15861: join(',',@$array);
1.129 matthew 15862: }
1.127 matthew 15863: #
1.136 matthew 15864: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15865: if ($NumBars < 3) {
15866: $width = 120+$NumBars*32;
1.220 matthew 15867: $xskip = 1;
1.225 matthew 15868: $bar_width = 30;
15869: } elsif ($NumBars < 5) {
15870: $width = 120+$NumBars*20;
15871: $xskip = 1;
15872: $bar_width = 20;
1.220 matthew 15873: } elsif ($NumBars < 10) {
1.136 matthew 15874: $width = 120+$NumBars*15;
15875: $xskip = 1;
15876: $bar_width = 15;
15877: } elsif ($NumBars <= 25) {
15878: $width = 120+$NumBars*11;
15879: $xskip = 5;
15880: $bar_width = 8;
15881: } elsif ($NumBars <= 50) {
15882: $width = 120+$NumBars*8;
15883: $xskip = 5;
15884: $bar_width = 4;
15885: } else {
15886: $width = 120+$NumBars*8;
15887: $xskip = 5;
15888: $bar_width = 4;
15889: }
15890: #
1.137 matthew 15891: $Max = 1 if ($Max < 1);
15892: if ( int($Max) < $Max ) {
15893: $Max++;
15894: $Max = int($Max);
15895: }
1.127 matthew 15896: $Title = '' if (! defined($Title));
15897: $xlabel = '' if (! defined($xlabel));
15898: $ylabel = '' if (! defined($ylabel));
1.369 www 15899: $ValuesHash{$id.'.title'} = &escape($Title);
15900: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15901: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15902: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15903: $ValuesHash{$id.'.NumBars'} = $NumBars;
15904: $ValuesHash{$id.'.NumSets'} = $NumSets;
15905: $ValuesHash{$id.'.PlotType'} = 'bar';
15906: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15907: $ValuesHash{$id.'.height'} = $height;
15908: $ValuesHash{$id.'.width'} = $width;
15909: $ValuesHash{$id.'.xskip'} = $xskip;
15910: $ValuesHash{$id.'.bar_width'} = $bar_width;
15911: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15912: #
1.228 matthew 15913: # Deal with other parameters
15914: while (my ($key,$value) = each(%$extra_settings)) {
15915: $ValuesHash{$id.'.'.$key} = $value;
15916: }
15917: #
1.646 raeburn 15918: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15919: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15920: }
15921:
15922: ############################################################
15923: ############################################################
15924:
15925: =pod
15926:
1.648 raeburn 15927: =item * &DrawXYGraph()
1.137 matthew 15928:
1.138 matthew 15929: Facilitates the plotting of data in an XY graph.
15930: Puts plot definition data into the users environment in order for
15931: graph.png to plot it. Returns an <img> tag for the plot.
15932:
15933: Inputs:
15934:
15935: =over 4
15936:
15937: =item $Title: string, the title of the plot
15938:
15939: =item $xlabel: string, text describing the X-axis of the plot
15940:
15941: =item $ylabel: string, text describing the Y-axis of the plot
15942:
15943: =item $Max: scalar, the maximum Y value to use in the plot
15944: If $Max is < any data point, the graph will not be rendered.
15945:
15946: =item $colors: Array ref containing the hex color codes for the data to be
15947: plotted in. If undefined, default values will be used.
15948:
15949: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15950:
15951: =item $Ydata: Array ref containing Array refs.
1.185 www 15952: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15953:
15954: =item %Values: hash indicating or overriding any default values which are
15955: passed to graph.png.
15956: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15957:
15958: =back
15959:
15960: Returns:
15961:
15962: An <img> tag which references graph.png and the appropriate identifying
15963: information for the plot.
15964:
1.137 matthew 15965: =cut
15966:
15967: ############################################################
15968: ############################################################
15969: sub DrawXYGraph {
15970: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15971: #
15972: # Create the identifier for the graph
15973: my $identifier = &get_cgi_id();
15974: my $id = 'cgi.'.$identifier;
15975: #
15976: $Title = '' if (! defined($Title));
15977: $xlabel = '' if (! defined($xlabel));
15978: $ylabel = '' if (! defined($ylabel));
15979: my %ValuesHash =
15980: (
1.369 www 15981: $id.'.title' => &escape($Title),
15982: $id.'.xlabel' => &escape($xlabel),
15983: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15984: $id.'.y_max_value'=> $Max,
15985: $id.'.labels' => join(',',@$Xlabels),
15986: $id.'.PlotType' => 'XY',
15987: );
15988: #
15989: if (defined($colors) && ref($colors) eq 'ARRAY') {
15990: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15991: }
15992: #
15993: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15994: return '';
15995: }
15996: my $NumSets=1;
1.138 matthew 15997: foreach my $array (@{$Ydata}){
1.137 matthew 15998: next if (! ref($array));
15999: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
16000: }
1.138 matthew 16001: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 16002: #
16003: # Deal with other parameters
16004: while (my ($key,$value) = each(%Values)) {
16005: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 16006: }
16007: #
1.646 raeburn 16008: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 16009: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
16010: }
16011:
16012: ############################################################
16013: ############################################################
16014:
16015: =pod
16016:
1.648 raeburn 16017: =item * &DrawXYYGraph()
1.138 matthew 16018:
16019: Facilitates the plotting of data in an XY graph with two Y axes.
16020: Puts plot definition data into the users environment in order for
16021: graph.png to plot it. Returns an <img> tag for the plot.
16022:
16023: Inputs:
16024:
16025: =over 4
16026:
16027: =item $Title: string, the title of the plot
16028:
16029: =item $xlabel: string, text describing the X-axis of the plot
16030:
16031: =item $ylabel: string, text describing the Y-axis of the plot
16032:
16033: =item $colors: Array ref containing the hex color codes for the data to be
16034: plotted in. If undefined, default values will be used.
16035:
16036: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
16037:
16038: =item $Ydata1: The first data set
16039:
16040: =item $Min1: The minimum value of the left Y-axis
16041:
16042: =item $Max1: The maximum value of the left Y-axis
16043:
16044: =item $Ydata2: The second data set
16045:
16046: =item $Min2: The minimum value of the right Y-axis
16047:
16048: =item $Max2: The maximum value of the left Y-axis
16049:
16050: =item %Values: hash indicating or overriding any default values which are
16051: passed to graph.png.
16052: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16053:
16054: =back
16055:
16056: Returns:
16057:
16058: An <img> tag which references graph.png and the appropriate identifying
16059: information for the plot.
1.136 matthew 16060:
16061: =cut
16062:
16063: ############################################################
16064: ############################################################
1.137 matthew 16065: sub DrawXYYGraph {
16066: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16067: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16068: #
16069: # Create the identifier for the graph
16070: my $identifier = &get_cgi_id();
16071: my $id = 'cgi.'.$identifier;
16072: #
16073: $Title = '' if (! defined($Title));
16074: $xlabel = '' if (! defined($xlabel));
16075: $ylabel = '' if (! defined($ylabel));
16076: my %ValuesHash =
16077: (
1.369 www 16078: $id.'.title' => &escape($Title),
16079: $id.'.xlabel' => &escape($xlabel),
16080: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16081: $id.'.labels' => join(',',@$Xlabels),
16082: $id.'.PlotType' => 'XY',
16083: $id.'.NumSets' => 2,
1.137 matthew 16084: $id.'.two_axes' => 1,
16085: $id.'.y1_max_value' => $Max1,
16086: $id.'.y1_min_value' => $Min1,
16087: $id.'.y2_max_value' => $Max2,
16088: $id.'.y2_min_value' => $Min2,
1.136 matthew 16089: );
16090: #
1.137 matthew 16091: if (defined($colors) && ref($colors) eq 'ARRAY') {
16092: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16093: }
16094: #
16095: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16096: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16097: return '';
16098: }
16099: my $NumSets=1;
1.137 matthew 16100: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16101: next if (! ref($array));
16102: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16103: }
16104: #
16105: # Deal with other parameters
16106: while (my ($key,$value) = each(%Values)) {
16107: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16108: }
16109: #
1.646 raeburn 16110: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16111: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16112: }
16113:
16114: ############################################################
16115: ############################################################
16116:
16117: =pod
16118:
1.157 matthew 16119: =back
16120:
1.139 matthew 16121: =head1 Statistics helper routines?
16122:
16123: Bad place for them but what the hell.
16124:
1.157 matthew 16125: =over 4
16126:
1.648 raeburn 16127: =item * &chartlink()
1.139 matthew 16128:
16129: Returns a link to the chart for a specific student.
16130:
16131: Inputs:
16132:
16133: =over 4
16134:
16135: =item $linktext: The text of the link
16136:
16137: =item $sname: The students username
16138:
16139: =item $sdomain: The students domain
16140:
16141: =back
16142:
1.157 matthew 16143: =back
16144:
1.139 matthew 16145: =cut
16146:
16147: ############################################################
16148: ############################################################
16149: sub chartlink {
16150: my ($linktext, $sname, $sdomain) = @_;
16151: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16152: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16153: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16154: '">'.$linktext.'</a>';
1.153 matthew 16155: }
16156:
16157: #######################################################
16158: #######################################################
16159:
16160: =pod
16161:
16162: =head1 Course Environment Routines
1.157 matthew 16163:
16164: =over 4
1.153 matthew 16165:
1.648 raeburn 16166: =item * &restore_course_settings()
1.153 matthew 16167:
1.648 raeburn 16168: =item * &store_course_settings()
1.153 matthew 16169:
16170: Restores/Store indicated form parameters from the course environment.
16171: Will not overwrite existing values of the form parameters.
16172:
16173: Inputs:
16174: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16175:
16176: a hash ref describing the data to be stored. For example:
16177:
16178: %Save_Parameters = ('Status' => 'scalar',
16179: 'chartoutputmode' => 'scalar',
16180: 'chartoutputdata' => 'scalar',
16181: 'Section' => 'array',
1.373 raeburn 16182: 'Group' => 'array',
1.153 matthew 16183: 'StudentData' => 'array',
16184: 'Maps' => 'array');
16185:
16186: Returns: both routines return nothing
16187:
1.631 raeburn 16188: =back
16189:
1.153 matthew 16190: =cut
16191:
16192: #######################################################
16193: #######################################################
16194: sub store_course_settings {
1.496 albertel 16195: return &store_settings($env{'request.course.id'},@_);
16196: }
16197:
16198: sub store_settings {
1.153 matthew 16199: # save to the environment
16200: # appenv the same items, just to be safe
1.300 albertel 16201: my $udom = $env{'user.domain'};
16202: my $uname = $env{'user.name'};
1.496 albertel 16203: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16204: my %SaveHash;
16205: my %AppHash;
16206: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16207: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16208: my $envname = 'environment.'.$basename;
1.258 albertel 16209: if (exists($env{'form.'.$setting})) {
1.153 matthew 16210: # Save this value away
16211: if ($type eq 'scalar' &&
1.258 albertel 16212: (! exists($env{$envname}) ||
16213: $env{$envname} ne $env{'form.'.$setting})) {
16214: $SaveHash{$basename} = $env{'form.'.$setting};
16215: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16216: } elsif ($type eq 'array') {
16217: my $stored_form;
1.258 albertel 16218: if (ref($env{'form.'.$setting})) {
1.153 matthew 16219: $stored_form = join(',',
16220: map {
1.369 www 16221: &escape($_);
1.258 albertel 16222: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16223: } else {
16224: $stored_form =
1.369 www 16225: &escape($env{'form.'.$setting});
1.153 matthew 16226: }
16227: # Determine if the array contents are the same.
1.258 albertel 16228: if ($stored_form ne $env{$envname}) {
1.153 matthew 16229: $SaveHash{$basename} = $stored_form;
16230: $AppHash{$envname} = $stored_form;
16231: }
16232: }
16233: }
16234: }
16235: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16236: $udom,$uname);
1.153 matthew 16237: if ($put_result !~ /^(ok|delayed)/) {
16238: &Apache::lonnet::logthis('unable to save form parameters, '.
16239: 'got error:'.$put_result);
16240: }
16241: # Make sure these settings stick around in this session, too
1.646 raeburn 16242: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16243: return;
16244: }
16245:
16246: sub restore_course_settings {
1.499 albertel 16247: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16248: }
16249:
16250: sub restore_settings {
16251: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16252: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16253: next if (exists($env{'form.'.$setting}));
1.496 albertel 16254: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16255: '.'.$setting;
1.258 albertel 16256: if (exists($env{$envname})) {
1.153 matthew 16257: if ($type eq 'scalar') {
1.258 albertel 16258: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16259: } elsif ($type eq 'array') {
1.258 albertel 16260: $env{'form.'.$setting} = [
1.153 matthew 16261: map {
1.369 www 16262: &unescape($_);
1.258 albertel 16263: } split(',',$env{$envname})
1.153 matthew 16264: ];
16265: }
16266: }
16267: }
1.127 matthew 16268: }
16269:
1.618 raeburn 16270: #######################################################
16271: #######################################################
16272:
16273: =pod
16274:
16275: =head1 Domain E-mail Routines
16276:
16277: =over 4
16278:
1.648 raeburn 16279: =item * &build_recipient_list()
1.618 raeburn 16280:
1.1144 raeburn 16281: Build recipient lists for following types of e-mail:
1.766 raeburn 16282: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16283: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16284: module change checking, student/employee ID conflict checks, as
16285: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16286: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16287:
16288: Inputs:
1.619 raeburn 16289: defmail (scalar - email address of default recipient),
1.1144 raeburn 16290: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16291: requestsmail, updatesmail, or idconflictsmail).
16292:
1.619 raeburn 16293: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16294:
1.619 raeburn 16295: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16296: i.e., predates configuration by DC via domainprefs.pm
16297:
16298: $requname username of requester (if mailing type is helpdeskmail)
16299:
16300: $requdom domain of requester (if mailing type is helpdeskmail)
16301:
16302: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16303:
1.618 raeburn 16304:
1.655 raeburn 16305: Returns: comma separated list of addresses to which to send e-mail.
16306:
16307: =back
1.618 raeburn 16308:
16309: =cut
16310:
16311: ############################################################
16312: ############################################################
16313: sub build_recipient_list {
1.1297 raeburn 16314: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16315: my @recipients;
1.1270 raeburn 16316: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16317: my %domconfig =
1.1270 raeburn 16318: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16319: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16320: if (exists($domconfig{'contacts'}{$mailing})) {
16321: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16322: my @contacts = ('adminemail','supportemail');
16323: foreach my $item (@contacts) {
16324: if ($domconfig{'contacts'}{$mailing}{$item}) {
16325: my $addr = $domconfig{'contacts'}{$item};
16326: if (!grep(/^\Q$addr\E$/,@recipients)) {
16327: push(@recipients,$addr);
16328: }
1.619 raeburn 16329: }
1.1270 raeburn 16330: }
16331: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16332: if ($mailing eq 'helpdeskmail') {
16333: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16334: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16335: my @ok_bccs;
16336: foreach my $bcc (@bccs) {
16337: $bcc =~ s/^\s+//g;
16338: $bcc =~ s/\s+$//g;
16339: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16340: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16341: push(@ok_bccs,$bcc);
16342: }
16343: }
16344: }
16345: if (@ok_bccs > 0) {
16346: $allbcc = join(', ',@ok_bccs);
16347: }
16348: }
16349: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16350: }
16351: }
1.766 raeburn 16352: } elsif ($origmail ne '') {
1.1270 raeburn 16353: $lastresort = $origmail;
1.618 raeburn 16354: }
1.1297 raeburn 16355: if ($mailing eq 'helpdeskmail') {
16356: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16357: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16358: my ($inststatus,$inststatus_checked);
16359: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16360: ($env{'user.domain'} ne 'public')) {
16361: $inststatus_checked = 1;
16362: $inststatus = $env{'environment.inststatus'};
16363: }
16364: unless ($inststatus_checked) {
16365: if (($requname ne '') && ($requdom ne '')) {
16366: if (($requname =~ /^$match_username$/) &&
16367: ($requdom =~ /^$match_domain$/) &&
16368: (&Apache::lonnet::domain($requdom))) {
16369: my $requhome = &Apache::lonnet::homeserver($requname,
16370: $requdom);
16371: unless ($requhome eq 'no_host') {
16372: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16373: $inststatus = $userenv{'inststatus'};
16374: $inststatus_checked = 1;
16375: }
16376: }
16377: }
16378: }
16379: unless ($inststatus_checked) {
16380: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16381: my %srch = (srchby => 'email',
16382: srchdomain => $defdom,
16383: srchterm => $reqemail,
16384: srchtype => 'exact');
16385: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16386: foreach my $uname (keys(%srch_results)) {
16387: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16388: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16389: $inststatus_checked = 1;
16390: last;
16391: }
16392: }
16393: unless ($inststatus_checked) {
16394: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16395: if ($dirsrchres eq 'ok') {
16396: foreach my $uname (keys(%srch_results)) {
16397: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16398: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16399: $inststatus_checked = 1;
16400: last;
16401: }
16402: }
16403: }
16404: }
16405: }
16406: }
16407: if ($inststatus ne '') {
16408: foreach my $status (split(/\:/,$inststatus)) {
16409: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16410: my @contacts = ('adminemail','supportemail');
16411: foreach my $item (@contacts) {
16412: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16413: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16414: if (!grep(/^\Q$addr\E$/,@recipients)) {
16415: push(@recipients,$addr);
16416: }
16417: }
16418: }
16419: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16420: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16421: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16422: my @ok_bccs;
16423: foreach my $bcc (@bccs) {
16424: $bcc =~ s/^\s+//g;
16425: $bcc =~ s/\s+$//g;
16426: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16427: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16428: push(@ok_bccs,$bcc);
16429: }
16430: }
16431: }
16432: if (@ok_bccs > 0) {
16433: $allbcc = join(', ',@ok_bccs);
16434: }
16435: }
16436: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16437: last;
16438: }
16439: }
16440: }
16441: }
16442: }
1.619 raeburn 16443: } elsif ($origmail ne '') {
1.1270 raeburn 16444: $lastresort = $origmail;
16445: }
1.1297 raeburn 16446: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16447: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16448: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16449: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16450: my %what = (
16451: perlvar => 1,
16452: );
16453: my $primary = &Apache::lonnet::domain($defdom,'primary');
16454: if ($primary) {
16455: my $gotaddr;
16456: my ($result,$returnhash) =
16457: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16458: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16459: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16460: $lastresort = $returnhash->{'lonSupportEMail'};
16461: $gotaddr = 1;
16462: }
16463: }
16464: unless ($gotaddr) {
16465: my $uintdom = &Apache::lonnet::internet_dom($primary);
16466: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16467: unless ($uintdom eq $intdom) {
16468: my %domconfig =
16469: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16470: if (ref($domconfig{'contacts'}) eq 'HASH') {
16471: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16472: my @contacts = ('adminemail','supportemail');
16473: foreach my $item (@contacts) {
16474: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16475: my $addr = $domconfig{'contacts'}{$item};
16476: if (!grep(/^\Q$addr\E$/,@recipients)) {
16477: push(@recipients,$addr);
16478: }
16479: }
16480: }
16481: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16482: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16483: }
16484: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16485: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16486: my @ok_bccs;
16487: foreach my $bcc (@bccs) {
16488: $bcc =~ s/^\s+//g;
16489: $bcc =~ s/\s+$//g;
16490: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16491: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16492: push(@ok_bccs,$bcc);
16493: }
16494: }
16495: }
16496: if (@ok_bccs > 0) {
16497: $allbcc = join(', ',@ok_bccs);
16498: }
16499: }
16500: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16501: }
16502: }
16503: }
16504: }
16505: }
16506: }
1.618 raeburn 16507: }
1.688 raeburn 16508: if (defined($defmail)) {
16509: if ($defmail ne '') {
16510: push(@recipients,$defmail);
16511: }
1.618 raeburn 16512: }
16513: if ($otheremails) {
1.619 raeburn 16514: my @others;
16515: if ($otheremails =~ /,/) {
16516: @others = split(/,/,$otheremails);
1.618 raeburn 16517: } else {
1.619 raeburn 16518: push(@others,$otheremails);
16519: }
16520: foreach my $addr (@others) {
16521: if (!grep(/^\Q$addr\E$/,@recipients)) {
16522: push(@recipients,$addr);
16523: }
1.618 raeburn 16524: }
16525: }
1.1298 raeburn 16526: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16527: if ((!@recipients) && ($lastresort ne '')) {
16528: push(@recipients,$lastresort);
16529: }
16530: } elsif ($lastresort ne '') {
16531: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16532: push(@recipients,$lastresort);
16533: }
16534: }
1.1271 raeburn 16535: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16536: if (wantarray) {
16537: return ($recipientlist,$allbcc,$addtext);
16538: } else {
16539: return $recipientlist;
16540: }
1.618 raeburn 16541: }
16542:
1.127 matthew 16543: ############################################################
16544: ############################################################
1.154 albertel 16545:
1.655 raeburn 16546: =pod
16547:
1.1224 musolffc 16548: =over 4
16549:
1.1223 musolffc 16550: =item * &mime_email()
16551:
16552: Sends an email with a possible attachment
16553:
16554: Inputs:
16555:
16556: =over 4
16557:
16558: from - Sender's email address
16559:
1.1343 raeburn 16560: replyto - Reply-To email address
16561:
1.1223 musolffc 16562: to - Email address of recipient
16563:
16564: subject - Subject of email
16565:
16566: body - Body of email
16567:
16568: cc_string - Carbon copy email address
16569:
16570: bcc - Blind carbon copy email address
16571:
16572: attachment_path - Path of file to be attached
16573:
16574: file_name - Name of file to be attached
16575:
16576: attachment_text - The body of an attachment of type "TEXT"
16577:
16578: =back
16579:
16580: =back
16581:
16582: =cut
16583:
16584: ############################################################
16585: ############################################################
16586:
16587: sub mime_email {
1.1343 raeburn 16588: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16589: $file_name,$attachment_text) = @_;
16590:
1.1223 musolffc 16591: my $msg = MIME::Lite->new(
16592: From => $from,
16593: To => $to,
16594: Subject => $subject,
16595: Type =>'TEXT',
16596: Data => $body,
16597: );
1.1343 raeburn 16598: if ($replyto ne '') {
16599: $msg->add("Reply-To" => $replyto);
16600: }
1.1223 musolffc 16601: if ($cc_string ne '') {
16602: $msg->add("Cc" => $cc_string);
16603: }
16604: if ($bcc ne '') {
16605: $msg->add("Bcc" => $bcc);
16606: }
16607: $msg->attr("content-type" => "text/plain");
16608: $msg->attr("content-type.charset" => "UTF-8");
16609: # Attach file if given
16610: if ($attachment_path) {
16611: unless ($file_name) {
16612: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16613: }
16614: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16615: $msg->attach(Type => $type,
16616: Path => $attachment_path,
16617: Filename => $file_name
16618: );
16619: # Otherwise attach text if given
16620: } elsif ($attachment_text) {
16621: $msg->attach(Type => 'TEXT',
16622: Data => $attachment_text);
16623: }
16624: # Send it
16625: $msg->send('sendmail');
16626: }
16627:
16628: ############################################################
16629: ############################################################
16630:
16631: =pod
16632:
1.655 raeburn 16633: =head1 Course Catalog Routines
16634:
16635: =over 4
16636:
16637: =item * &gather_categories()
16638:
16639: Converts category definitions - keys of categories hash stored in
16640: coursecategories in configuration.db on the primary library server in a
16641: domain - to an array. Also generates javascript and idx hash used to
16642: generate Domain Coordinator interface for editing Course Categories.
16643:
16644: Inputs:
1.663 raeburn 16645:
1.655 raeburn 16646: categories (reference to hash of category definitions).
1.663 raeburn 16647:
1.655 raeburn 16648: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16649: categories and subcategories).
1.663 raeburn 16650:
1.655 raeburn 16651: idx (reference to hash of counters used in Domain Coordinator interface for
16652: editing Course Categories).
1.663 raeburn 16653:
1.655 raeburn 16654: jsarray (reference to array of categories used to create Javascript arrays for
16655: Domain Coordinator interface for editing Course Categories).
16656:
16657: Returns: nothing
16658:
16659: Side effects: populates cats, idx and jsarray.
16660:
16661: =cut
16662:
16663: sub gather_categories {
16664: my ($categories,$cats,$idx,$jsarray) = @_;
16665: my %counters;
16666: my $num = 0;
16667: foreach my $item (keys(%{$categories})) {
16668: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16669: if ($container eq '' && $depth == 0) {
16670: $cats->[$depth][$categories->{$item}] = $cat;
16671: } else {
16672: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16673: }
16674: my ($escitem,$tail) = split(/:/,$item,2);
16675: if ($counters{$tail} eq '') {
16676: $counters{$tail} = $num;
16677: $num ++;
16678: }
16679: if (ref($idx) eq 'HASH') {
16680: $idx->{$item} = $counters{$tail};
16681: }
16682: if (ref($jsarray) eq 'ARRAY') {
16683: push(@{$jsarray->[$counters{$tail}]},$item);
16684: }
16685: }
16686: return;
16687: }
16688:
16689: =pod
16690:
16691: =item * &extract_categories()
16692:
16693: Used to generate breadcrumb trails for course categories.
16694:
16695: Inputs:
1.663 raeburn 16696:
1.655 raeburn 16697: categories (reference to hash of category definitions).
1.663 raeburn 16698:
1.655 raeburn 16699: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16700: categories and subcategories).
1.663 raeburn 16701:
1.655 raeburn 16702: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16703:
1.655 raeburn 16704: allitems (reference to hash - key is category key
16705: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16706:
1.655 raeburn 16707: idx (reference to hash of counters used in Domain Coordinator interface for
16708: editing Course Categories).
1.663 raeburn 16709:
1.655 raeburn 16710: jsarray (reference to array of categories used to create Javascript arrays for
16711: Domain Coordinator interface for editing Course Categories).
16712:
1.665 raeburn 16713: subcats (reference to hash of arrays containing all subcategories within each
16714: category, -recursive)
16715:
1.1321 raeburn 16716: maxd (reference to hash used to hold max depth for all top-level categories).
16717:
1.655 raeburn 16718: Returns: nothing
16719:
16720: Side effects: populates trails and allitems hash references.
16721:
16722: =cut
16723:
16724: sub extract_categories {
1.1321 raeburn 16725: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16726: if (ref($categories) eq 'HASH') {
16727: &gather_categories($categories,$cats,$idx,$jsarray);
16728: if (ref($cats->[0]) eq 'ARRAY') {
16729: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16730: my $name = $cats->[0][$i];
16731: my $item = &escape($name).'::0';
16732: my $trailstr;
16733: if ($name eq 'instcode') {
16734: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16735: } elsif ($name eq 'communities') {
16736: $trailstr = &mt('Communities');
1.1239 raeburn 16737: } elsif ($name eq 'placement') {
16738: $trailstr = &mt('Placement Tests');
1.655 raeburn 16739: } else {
16740: $trailstr = $name;
16741: }
16742: if ($allitems->{$item} eq '') {
16743: push(@{$trails},$trailstr);
16744: $allitems->{$item} = scalar(@{$trails})-1;
16745: }
16746: my @parents = ($name);
16747: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16748: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16749: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16750: if (ref($subcats) eq 'HASH') {
16751: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16752: }
1.1321 raeburn 16753: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16754: }
16755: } else {
16756: if (ref($subcats) eq 'HASH') {
16757: $subcats->{$item} = [];
1.655 raeburn 16758: }
1.1321 raeburn 16759: if (ref($maxd) eq 'HASH') {
16760: $maxd->{$name} = 1;
16761: }
1.655 raeburn 16762: }
16763: }
16764: }
16765: }
16766: return;
16767: }
16768:
16769: =pod
16770:
1.1162 raeburn 16771: =item * &recurse_categories()
1.655 raeburn 16772:
16773: Recursively used to generate breadcrumb trails for course categories.
16774:
16775: Inputs:
1.663 raeburn 16776:
1.655 raeburn 16777: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16778: categories and subcategories).
1.663 raeburn 16779:
1.655 raeburn 16780: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16781:
16782: category (current course category, for which breadcrumb trail is being generated).
16783:
16784: trails (reference to array of breadcrumb trails for each category).
16785:
1.655 raeburn 16786: allitems (reference to hash - key is category key
16787: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16788:
1.655 raeburn 16789: parents (array containing containers directories for current category,
16790: back to top level).
16791:
16792: Returns: nothing
16793:
16794: Side effects: populates trails and allitems hash references
16795:
16796: =cut
16797:
16798: sub recurse_categories {
1.1321 raeburn 16799: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16800: my $shallower = $depth - 1;
16801: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16802: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16803: my $name = $cats->[$depth]{$category}[$k];
16804: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16805: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16806: if ($allitems->{$item} eq '') {
16807: push(@{$trails},$trailstr);
16808: $allitems->{$item} = scalar(@{$trails})-1;
16809: }
16810: my $deeper = $depth+1;
16811: push(@{$parents},$category);
1.665 raeburn 16812: if (ref($subcats) eq 'HASH') {
16813: my $subcat = &escape($name).':'.$category.':'.$depth;
16814: for (my $j=@{$parents}; $j>=0; $j--) {
16815: my $higher;
16816: if ($j > 0) {
16817: $higher = &escape($parents->[$j]).':'.
16818: &escape($parents->[$j-1]).':'.$j;
16819: } else {
16820: $higher = &escape($parents->[$j]).'::'.$j;
16821: }
16822: push(@{$subcats->{$higher}},$subcat);
16823: }
16824: }
16825: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16826: $subcats,$maxd);
1.655 raeburn 16827: pop(@{$parents});
16828: }
16829: } else {
16830: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16831: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16832: if ($allitems->{$item} eq '') {
16833: push(@{$trails},$trailstr);
16834: $allitems->{$item} = scalar(@{$trails})-1;
16835: }
1.1321 raeburn 16836: if (ref($maxd) eq 'HASH') {
16837: if ($depth > $maxd->{$parents->[0]}) {
16838: $maxd->{$parents->[0]} = $depth;
16839: }
16840: }
1.655 raeburn 16841: }
16842: return;
16843: }
16844:
1.663 raeburn 16845: =pod
16846:
1.1162 raeburn 16847: =item * &assign_categories_table()
1.663 raeburn 16848:
16849: Create a datatable for display of hierarchical categories in a domain,
16850: with checkboxes to allow a course to be categorized.
16851:
16852: Inputs:
16853:
16854: cathash - reference to hash of categories defined for the domain (from
16855: configuration.db)
16856:
16857: currcat - scalar with an & separated list of categories assigned to a course.
16858:
1.919 raeburn 16859: type - scalar contains course type (Course or Community).
16860:
1.1260 raeburn 16861: disabled - scalar (optional) contains disabled="disabled" if input elements are
16862: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16863:
1.663 raeburn 16864: Returns: $output (markup to be displayed)
16865:
16866: =cut
16867:
16868: sub assign_categories_table {
1.1259 raeburn 16869: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16870: my $output;
16871: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16872: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16873: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16874: $maxdepth = scalar(@cats);
16875: if (@cats > 0) {
16876: my $itemcount = 0;
16877: if (ref($cats[0]) eq 'ARRAY') {
16878: my @currcategories;
16879: if ($currcat ne '') {
16880: @currcategories = split('&',$currcat);
16881: }
1.919 raeburn 16882: my $table;
1.663 raeburn 16883: for (my $i=0; $i<@{$cats[0]}; $i++) {
16884: my $parent = $cats[0][$i];
1.919 raeburn 16885: next if ($parent eq 'instcode');
16886: if ($type eq 'Community') {
16887: next unless ($parent eq 'communities');
1.1239 raeburn 16888: } elsif ($type eq 'Placement') {
16889: next unless ($parent eq 'placement');
1.919 raeburn 16890: } else {
1.1239 raeburn 16891: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16892: }
1.663 raeburn 16893: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16894: my $item = &escape($parent).'::0';
16895: my $checked = '';
16896: if (@currcategories > 0) {
16897: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16898: $checked = ' checked="checked"';
1.663 raeburn 16899: }
16900: }
1.919 raeburn 16901: my $parent_title = $parent;
16902: if ($parent eq 'communities') {
16903: $parent_title = &mt('Communities');
1.1239 raeburn 16904: } elsif ($parent eq 'placement') {
16905: $parent_title = &mt('Placement Tests');
1.919 raeburn 16906: }
16907: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16908: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16909: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16910: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16911: my $depth = 1;
16912: push(@path,$parent);
1.1259 raeburn 16913: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16914: pop(@path);
1.919 raeburn 16915: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16916: $itemcount ++;
16917: }
1.919 raeburn 16918: if ($itemcount) {
16919: $output = &Apache::loncommon::start_data_table().
16920: $table.
16921: &Apache::loncommon::end_data_table();
16922: }
1.663 raeburn 16923: }
16924: }
16925: }
16926: return $output;
16927: }
16928:
16929: =pod
16930:
1.1162 raeburn 16931: =item * &assign_category_rows()
1.663 raeburn 16932:
16933: Create a datatable row for display of nested categories in a domain,
16934: with checkboxes to allow a course to be categorized,called recursively.
16935:
16936: Inputs:
16937:
16938: itemcount - track row number for alternating colors
16939:
16940: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16941: categories and subcategories.
16942:
16943: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16944:
16945: parent - parent of current category item
16946:
16947: path - Array containing all categories back up through the hierarchy from the
16948: current category to the top level.
16949:
16950: currcategories - reference to array of current categories assigned to the course
16951:
1.1260 raeburn 16952: disabled - scalar (optional) contains disabled="disabled" if input elements are
16953: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16954:
1.663 raeburn 16955: Returns: $output (markup to be displayed).
16956:
16957: =cut
16958:
16959: sub assign_category_rows {
1.1259 raeburn 16960: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16961: my ($text,$name,$item,$chgstr);
16962: if (ref($cats) eq 'ARRAY') {
16963: my $maxdepth = scalar(@{$cats});
16964: if (ref($cats->[$depth]) eq 'HASH') {
16965: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16966: my $numchildren = @{$cats->[$depth]{$parent}};
16967: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16968: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16969: for (my $j=0; $j<$numchildren; $j++) {
16970: $name = $cats->[$depth]{$parent}[$j];
16971: $item = &escape($name).':'.&escape($parent).':'.$depth;
16972: my $deeper = $depth+1;
16973: my $checked = '';
16974: if (ref($currcategories) eq 'ARRAY') {
16975: if (@{$currcategories} > 0) {
16976: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16977: $checked = ' checked="checked"';
1.663 raeburn 16978: }
16979: }
16980: }
1.664 raeburn 16981: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16982: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16983: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16984: '<input type="hidden" name="catname" value="'.$name.'" />'.
16985: '</td><td>';
1.663 raeburn 16986: if (ref($path) eq 'ARRAY') {
16987: push(@{$path},$name);
1.1259 raeburn 16988: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16989: pop(@{$path});
16990: }
16991: $text .= '</td></tr>';
16992: }
16993: $text .= '</table></td>';
16994: }
16995: }
16996: }
16997: return $text;
16998: }
16999:
1.1181 raeburn 17000: =pod
17001:
17002: =back
17003:
17004: =cut
17005:
1.655 raeburn 17006: ############################################################
17007: ############################################################
17008:
17009:
1.443 albertel 17010: sub commit_customrole {
1.1408 raeburn 17011: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 17012: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 17013: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
17014: $context,$othdomby,$requester);
1.630 raeburn 17015: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 17016: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 17017: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
17018: if (wantarray) {
17019: return ($output,$result);
17020: } else {
17021: return $output;
17022: }
1.443 albertel 17023: }
17024:
17025: sub commit_standardrole {
1.1408 raeburn 17026: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
17027: $othdomby,$requester) = @_;
1.1399 raeburn 17028: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 17029: if ($context eq 'auto') {
17030: $linefeed = "\n";
17031: } else {
17032: $linefeed = "<br />\n";
17033: }
1.443 albertel 17034: if ($three eq 'st') {
1.1399 raeburn 17035: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 17036: $one,$two,$sec,$context,$credits,$othdomby,
17037: $requester);
1.541 raeburn 17038: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 17039: ($result eq 'unknown_course') || ($result eq 'refused')) {
17040: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 17041: } else {
1.541 raeburn 17042: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 17043: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17044: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
17045: if ($context eq 'auto') {
17046: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
17047: } else {
17048: $output .= '<b>'.$result.'</b>'.$linefeed.
17049: &mt('Add to classlist').': <b>ok</b>';
17050: }
17051: $output .= $linefeed;
1.443 albertel 17052: }
17053: } else {
17054: $output = &mt('Assigning').' '.$three.' in '.$url.
17055: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17056: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17057: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17058: '','',$context,$othdomby,$requester);
1.541 raeburn 17059: if ($context eq 'auto') {
17060: $output .= $result.$linefeed;
17061: } else {
17062: $output .= '<b>'.$result.'</b>'.$linefeed;
17063: }
1.443 albertel 17064: }
1.1399 raeburn 17065: if (wantarray) {
17066: return ($output,$result);
17067: } else {
17068: return $output;
17069: }
1.443 albertel 17070: }
17071:
17072: sub commit_studentrole {
1.1116 raeburn 17073: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17074: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17075: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17076: if ($context eq 'auto') {
17077: $linefeed = "\n";
17078: } else {
17079: $linefeed = '<br />'."\n";
17080: }
1.443 albertel 17081: if (defined($one) && defined($two)) {
17082: my $cid=$one.'_'.$two;
17083: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17084: my $secchange = 0;
17085: my $expire_role_result;
17086: my $modify_section_result;
1.628 raeburn 17087: if ($oldsec ne '-1') {
17088: if ($oldsec ne $sec) {
1.443 albertel 17089: $secchange = 1;
1.628 raeburn 17090: my $now = time;
1.443 albertel 17091: my $uurl='/'.$cid;
17092: $uurl=~s/\_/\//g;
17093: if ($oldsec) {
17094: $uurl.='/'.$oldsec;
17095: }
1.626 raeburn 17096: $oldsecurl = $uurl;
1.628 raeburn 17097: $expire_role_result =
1.1408 raeburn 17098: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17099: '','','',$context,$othdomby,$requester);
17100: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17101: if ($expire_role_result eq 'refused') {
17102: my @roles = ('st');
17103: my @statuses = ('previous');
17104: my @roledoms = ($one);
17105: my $withsec = 1;
17106: my %roleshash =
17107: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17108: \@statuses,\@roles,\@roledoms,$withsec);
17109: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17110: my ($oldstart,$oldend) =
17111: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17112: if ($oldend > 0 && $oldend <= $now) {
17113: $expire_role_result = 'ok';
17114: }
17115: }
17116: }
17117: }
1.443 albertel 17118: $result = $expire_role_result;
17119: }
17120: }
17121: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17122: $modify_section_result =
17123: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17124: undef,undef,undef,$sec,
17125: $end,$start,'','',$cid,
1.1408 raeburn 17126: '',$context,$credits,'',
17127: $othdomby,$requester);
1.443 albertel 17128: if ($modify_section_result =~ /^ok/) {
17129: if ($secchange == 1) {
1.628 raeburn 17130: if ($sec eq '') {
17131: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17132: } else {
17133: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17134: }
1.443 albertel 17135: } elsif ($oldsec eq '-1') {
1.628 raeburn 17136: if ($sec eq '') {
17137: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17138: } else {
17139: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17140: }
1.443 albertel 17141: } else {
1.628 raeburn 17142: if ($sec eq '') {
17143: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17144: } else {
17145: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17146: }
1.443 albertel 17147: }
17148: } else {
1.1115 raeburn 17149: if ($secchange) {
1.628 raeburn 17150: $$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;
17151: } else {
17152: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17153: }
1.443 albertel 17154: }
17155: $result = $modify_section_result;
17156: } elsif ($secchange == 1) {
1.628 raeburn 17157: if ($oldsec eq '') {
1.1103 raeburn 17158: $$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 17159: } else {
17160: $$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;
17161: }
1.626 raeburn 17162: if ($expire_role_result eq 'refused') {
17163: my $newsecurl = '/'.$cid;
17164: $newsecurl =~ s/\_/\//g;
17165: if ($sec ne '') {
17166: $newsecurl.='/'.$sec;
17167: }
17168: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17169: if ($sec eq '') {
17170: $$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;
17171: } else {
17172: $$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;
17173: }
17174: }
17175: }
1.443 albertel 17176: }
17177: } else {
1.626 raeburn 17178: $$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 17179: $result = "error: incomplete course id\n";
17180: }
17181: return $result;
17182: }
17183:
1.1108 raeburn 17184: sub show_role_extent {
17185: my ($scope,$context,$role) = @_;
17186: $scope =~ s{^/}{};
17187: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17188: push(@courseroles,'co');
17189: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17190: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17191: $scope =~ s{/}{_};
17192: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17193: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17194: my ($audom,$auname) = split(/\//,$scope);
17195: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17196: &Apache::loncommon::plainname($auname,$audom).'</span>');
17197: } else {
17198: $scope =~ s{/$}{};
17199: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17200: &Apache::lonnet::domain($scope,'description').'</span>');
17201: }
17202: }
17203:
1.443 albertel 17204: ############################################################
17205: ############################################################
17206:
1.566 albertel 17207: sub check_clone {
1.578 raeburn 17208: my ($args,$linefeed) = @_;
1.566 albertel 17209: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17210: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17211: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17212: my $clonetitle;
17213: my @clonemsg;
1.566 albertel 17214: my $can_clone = 0;
1.944 raeburn 17215: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17216: if ($lctype ne 'community') {
17217: $lctype = 'course';
17218: }
1.566 albertel 17219: if ($clonehome eq 'no_host') {
1.944 raeburn 17220: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17221: push(@clonemsg,({
17222: mt => 'No new community created.',
17223: args => [],
17224: },
17225: {
17226: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17227: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17228: }));
1.908 raeburn 17229: } else {
1.1344 raeburn 17230: push(@clonemsg,({
17231: mt => 'No new course created.',
17232: args => [],
17233: },
17234: {
17235: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17236: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17237: }));
17238: }
1.566 albertel 17239: } else {
17240: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17241: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17242: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17243: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17244: push(@clonemsg,({
17245: mt => 'No new community created.',
17246: args => [],
17247: },
17248: {
17249: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17250: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17251: }));
17252: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17253: }
17254: }
1.1262 raeburn 17255: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17256: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17257: $can_clone = 1;
17258: } else {
1.1221 raeburn 17259: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17260: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17261: if ($clonehash{'cloners'} eq '') {
17262: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17263: if ($domdefs{'canclone'}) {
17264: unless ($domdefs{'canclone'} eq 'none') {
17265: if ($domdefs{'canclone'} eq 'domain') {
17266: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17267: $can_clone = 1;
17268: }
17269: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17270: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17271: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17272: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17273: $can_clone = 1;
17274: }
17275: }
17276: }
17277: }
1.578 raeburn 17278: } else {
1.1221 raeburn 17279: my @cloners = split(/,/,$clonehash{'cloners'});
17280: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17281: $can_clone = 1;
1.1221 raeburn 17282: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17283: $can_clone = 1;
1.1225 raeburn 17284: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17285: $can_clone = 1;
1.1221 raeburn 17286: }
17287: unless ($can_clone) {
1.1225 raeburn 17288: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17289: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17290: my (%gotdomdefaults,%gotcodedefaults);
17291: foreach my $cloner (@cloners) {
17292: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17293: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17294: my (%codedefaults,@code_order);
17295: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17296: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17297: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17298: }
17299: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17300: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17301: }
17302: } else {
17303: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17304: \%codedefaults,
17305: \@code_order);
17306: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17307: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17308: }
17309: if (@code_order > 0) {
17310: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17311: $cloner,$clonehash{'internal.coursecode'},
17312: $args->{'crscode'})) {
17313: $can_clone = 1;
17314: last;
17315: }
17316: }
17317: }
17318: }
17319: }
1.1225 raeburn 17320: }
17321: }
17322: unless ($can_clone) {
17323: my $ccrole = 'cc';
17324: if ($args->{'crstype'} eq 'Community') {
17325: $ccrole = 'co';
17326: }
17327: my %roleshash =
17328: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17329: $args->{'ccdomain'},
17330: 'userroles',['active'],[$ccrole],
17331: [$args->{'clonedomain'}]);
17332: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17333: $can_clone = 1;
17334: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17335: $args->{'ccuname'},$args->{'ccdomain'})) {
17336: $can_clone = 1;
1.1221 raeburn 17337: }
17338: }
17339: unless ($can_clone) {
17340: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17341: push(@clonemsg,({
17342: mt => 'No new community created.',
17343: args => [],
17344: },
17345: {
17346: 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]).',
17347: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17348: }));
1.942 raeburn 17349: } else {
1.1344 raeburn 17350: push(@clonemsg,({
17351: mt => 'No new course created.',
17352: args => [],
17353: },
17354: {
17355: 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]).',
17356: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17357: }));
1.1221 raeburn 17358: }
1.566 albertel 17359: }
1.578 raeburn 17360: }
1.566 albertel 17361: }
1.1344 raeburn 17362: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17363: }
17364:
1.444 albertel 17365: sub construct_course {
1.1262 raeburn 17366: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17367: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17368: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17369: my $linefeed = '<br />'."\n";
17370: if ($context eq 'auto') {
17371: $linefeed = "\n";
17372: }
1.566 albertel 17373:
17374: #
17375: # Are we cloning?
17376: #
1.1344 raeburn 17377: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17378: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17379: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17380: if (!$can_clone) {
1.1344 raeburn 17381: return (0,$outcome,$clonemsgref);
1.566 albertel 17382: }
17383: }
17384:
1.444 albertel 17385: #
17386: # Open course
17387: #
1.1239 raeburn 17388: my $showncrstype;
17389: if ($args->{'crstype'} eq 'Placement') {
17390: $showncrstype = 'placement test';
17391: } else {
17392: $showncrstype = lc($args->{'crstype'});
17393: }
1.444 albertel 17394: my %cenv=();
17395: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17396: $args->{'cdescr'},
17397: $args->{'curl'},
17398: $args->{'course_home'},
17399: $args->{'nonstandard'},
17400: $args->{'crscode'},
17401: $args->{'ccuname'}.':'.
17402: $args->{'ccdomain'},
1.882 raeburn 17403: $args->{'crstype'},
1.1344 raeburn 17404: $cnum,$context,$category,
17405: $callercontext);
1.444 albertel 17406:
17407: # Note: The testing routines depend on this being output; see
17408: # Utils::Course. This needs to at least be output as a comment
17409: # if anyone ever decides to not show this, and Utils::Course::new
17410: # will need to be suitably modified.
1.1344 raeburn 17411: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17412: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17413: } else {
17414: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17415: }
1.943 raeburn 17416: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17417: return (0,$outcome,$clonemsgref);
1.943 raeburn 17418: }
17419:
1.444 albertel 17420: #
17421: # Check if created correctly
17422: #
1.479 albertel 17423: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17424: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17425: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17426: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17427: $outcome .= &mt_user($user_lh,
17428: 'Course creation failed, unrecognized course home server.');
17429: } else {
17430: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17431: }
17432: $outcome .= $linefeed;
17433: return (0,$outcome,$clonemsgref);
1.943 raeburn 17434: }
1.541 raeburn 17435: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17436:
1.444 albertel 17437: #
1.566 albertel 17438: # Do the cloning
17439: #
1.1344 raeburn 17440: my @clonemsg;
1.566 albertel 17441: if ($can_clone && $cloneid) {
1.1344 raeburn 17442: push(@clonemsg,
17443: {
17444: mt => 'Created [_1] by cloning from [_2]',
17445: args => [$showncrstype,$clonetitle],
17446: });
1.566 albertel 17447: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17448: # Copy all files
1.1344 raeburn 17449: my @info =
17450: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17451: $args->{'dateshift'},$args->{'crscode'},
17452: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17453: $args->{'tinyurls'});
17454: if (@info) {
17455: push(@clonemsg,@info);
17456: }
1.444 albertel 17457: # Restore URL
1.566 albertel 17458: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17459: # Restore title
1.566 albertel 17460: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17461: # Restore creation date, creator and creation context.
17462: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17463: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17464: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17465: # Mark as cloned
1.566 albertel 17466: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17467: # Need to clone grading mode
17468: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17469: $cenv{'grading'}=$newenv{'grading'};
17470: # Do not clone these environment entries
17471: &Apache::lonnet::del('environment',
17472: ['default_enrollment_start_date',
17473: 'default_enrollment_end_date',
17474: 'question.email',
17475: 'policy.email',
17476: 'comment.email',
17477: 'pch.users.denied',
1.725 raeburn 17478: 'plc.users.denied',
17479: 'hidefromcat',
1.1121 raeburn 17480: 'checkforpriv',
1.1355 raeburn 17481: 'categories'],
1.638 www 17482: $$crsudom,$$crsunum);
1.1170 raeburn 17483: if ($args->{'textbook'}) {
17484: $cenv{'internal.textbook'} = $args->{'textbook'};
17485: }
1.444 albertel 17486: }
1.566 albertel 17487:
1.444 albertel 17488: #
17489: # Set environment (will override cloned, if existing)
17490: #
17491: my @sections = ();
17492: my @xlists = ();
17493: if ($args->{'crstype'}) {
17494: $cenv{'type'}=$args->{'crstype'};
17495: }
1.1371 raeburn 17496: if ($args->{'lti'}) {
17497: $cenv{'internal.lti'}=$args->{'lti'};
17498: }
1.444 albertel 17499: if ($args->{'crsid'}) {
17500: $cenv{'courseid'}=$args->{'crsid'};
17501: }
17502: if ($args->{'crscode'}) {
17503: $cenv{'internal.coursecode'}=$args->{'crscode'};
17504: }
17505: if ($args->{'crsquota'} ne '') {
17506: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17507: } else {
17508: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17509: }
17510: if ($args->{'ccuname'}) {
17511: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17512: ':'.$args->{'ccdomain'};
17513: } else {
17514: $cenv{'internal.courseowner'} = $args->{'curruser'};
17515: }
1.1116 raeburn 17516: if ($args->{'defaultcredits'}) {
17517: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17518: }
1.444 albertel 17519: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17520: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17521: if ($args->{'crssections'}) {
17522: $cenv{'internal.sectionnums'} = '';
17523: if ($args->{'crssections'} =~ m/,/) {
17524: @sections = split/,/,$args->{'crssections'};
17525: } else {
17526: $sections[0] = $args->{'crssections'};
17527: }
17528: if (@sections > 0) {
17529: foreach my $item (@sections) {
17530: my ($sec,$gp) = split/:/,$item;
17531: my $class = $args->{'crscode'}.$sec;
17532: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17533: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17534: if ($addcheck eq 'ok') {
17535: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17536: push(@oklcsecs,$gp);
17537: }
17538: } else {
1.1263 raeburn 17539: push(@badclasses,$class);
1.444 albertel 17540: }
17541: }
17542: $cenv{'internal.sectionnums'} =~ s/,$//;
17543: }
17544: }
17545: # do not hide course coordinator from staff listing,
17546: # even if privileged
17547: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17548: # add course coordinator's domain to domains to check for privileged users
17549: # if different to course domain
17550: if ($$crsudom ne $args->{'ccdomain'}) {
17551: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17552: }
1.444 albertel 17553: # add crosslistings
17554: if ($args->{'crsxlist'}) {
17555: $cenv{'internal.crosslistings'}='';
17556: if ($args->{'crsxlist'} =~ m/,/) {
17557: @xlists = split/,/,$args->{'crsxlist'};
17558: } else {
17559: $xlists[0] = $args->{'crsxlist'};
17560: }
17561: if (@xlists > 0) {
17562: foreach my $item (@xlists) {
17563: my ($xl,$gp) = split/:/,$item;
17564: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17565: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17566: if ($addcheck eq 'ok') {
17567: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17568: push(@oklcsecs,$gp);
17569: }
17570: } else {
1.1263 raeburn 17571: push(@badclasses,$xl);
1.444 albertel 17572: }
17573: }
17574: $cenv{'internal.crosslistings'} =~ s/,$//;
17575: }
17576: }
17577: if ($args->{'autoadds'}) {
17578: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17579: }
17580: if ($args->{'autodrops'}) {
17581: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17582: }
17583: # check for notification of enrollment changes
17584: my @notified = ();
17585: if ($args->{'notify_owner'}) {
17586: if ($args->{'ccuname'} ne '') {
17587: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17588: }
17589: }
17590: if ($args->{'notify_dc'}) {
17591: if ($uname ne '') {
1.630 raeburn 17592: push(@notified,$uname.':'.$udom);
1.444 albertel 17593: }
17594: }
17595: if (@notified > 0) {
17596: my $notifylist;
17597: if (@notified > 1) {
17598: $notifylist = join(',',@notified);
17599: } else {
17600: $notifylist = $notified[0];
17601: }
17602: $cenv{'internal.notifylist'} = $notifylist;
17603: }
17604: if (@badclasses > 0) {
17605: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17606: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17607: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17608: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17609: );
1.1264 raeburn 17610: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17611: &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 17612: if ($context eq 'auto') {
17613: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17614: } else {
1.566 albertel 17615: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17616: }
17617: foreach my $item (@badclasses) {
1.541 raeburn 17618: if ($context eq 'auto') {
1.1261 raeburn 17619: $outcome .= " - $item\n";
1.541 raeburn 17620: } else {
1.1261 raeburn 17621: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17622: }
1.1261 raeburn 17623: }
17624: if ($context eq 'auto') {
17625: $outcome .= $linefeed;
17626: } else {
17627: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17628: }
1.444 albertel 17629: }
17630: if ($args->{'no_end_date'}) {
17631: $args->{'endaccess'} = 0;
17632: }
1.1412 raeburn 17633: # If an official course with institutional sections is created by cloning
17634: # an existing course, section-specific hiding of course totals in student's
17635: # view of grades as copied from cloned course, will be checked for valid
17636: # sections.
17637: if (($can_clone && $cloneid) &&
17638: ($cenv{'internal.coursecode'} ne '') &&
17639: ($cenv{'grading'} eq 'standard') &&
17640: ($cenv{'hidetotals'} ne '') &&
17641: ($cenv{'hidetotals'} ne 'all')) {
17642: my @hidesecs;
17643: my $deletehidetotals;
17644: if (@oklcsecs) {
17645: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17646: if (grep(/^\Q$sec$/,@oklcsecs)) {
17647: push(@hidesecs,$sec);
17648: }
17649: }
17650: if (@hidesecs) {
17651: $cenv{'hidetotals'} = join(',',@hidesecs);
17652: } else {
17653: $deletehidetotals = 1;
17654: }
17655: } else {
17656: $deletehidetotals = 1;
17657: }
17658: if ($deletehidetotals) {
17659: delete($cenv{'hidetotals'});
17660: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17661: }
17662: }
1.444 albertel 17663: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17664: $cenv{'internal.autoend'}=$args->{'enrollend'};
17665: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17666: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17667: if ($args->{'showphotos'}) {
17668: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17669: }
17670: $cenv{'internal.authtype'} = $args->{'authtype'};
17671: $cenv{'internal.autharg'} = $args->{'autharg'};
17672: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17673: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17674: 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');
17675: if ($context eq 'auto') {
17676: $outcome .= $krb_msg;
17677: } else {
1.566 albertel 17678: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17679: }
17680: $outcome .= $linefeed;
1.444 albertel 17681: }
17682: }
17683: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17684: if ($args->{'setpolicy'}) {
17685: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17686: }
17687: if ($args->{'setcontent'}) {
17688: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17689: }
1.1251 raeburn 17690: if ($args->{'setcomment'}) {
17691: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17692: }
1.444 albertel 17693: }
17694: if ($args->{'reshome'}) {
17695: $cenv{'reshome'}=$args->{'reshome'}.'/';
17696: $cenv{'reshome'}=~s/\/+$/\//;
17697: }
17698: #
17699: # course has keyed access
17700: #
17701: if ($args->{'setkeys'}) {
17702: $cenv{'keyaccess'}='yes';
17703: }
17704: # if specified, key authority is not course, but user
17705: # only active if keyaccess is yes
17706: if ($args->{'keyauth'}) {
1.487 albertel 17707: my ($user,$domain) = split(':',$args->{'keyauth'});
17708: $user = &LONCAPA::clean_username($user);
17709: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17710: if ($user ne '' && $domain ne '') {
1.487 albertel 17711: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17712: }
17713: }
17714:
1.1166 raeburn 17715: #
1.1167 raeburn 17716: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17717: #
17718: if ($args->{'uniquecode'}) {
17719: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17720: if ($code) {
17721: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17722: my %crsinfo =
17723: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17724: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17725: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17726: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17727: }
1.1166 raeburn 17728: if (ref($coderef)) {
17729: $$coderef = $code;
17730: }
17731: }
17732: }
17733:
1.444 albertel 17734: if ($args->{'disresdis'}) {
17735: $cenv{'pch.roles.denied'}='st';
17736: }
17737: if ($args->{'disablechat'}) {
17738: $cenv{'plc.roles.denied'}='st';
17739: }
17740:
17741: # Record we've not yet viewed the Course Initialization Helper for this
17742: # course
17743: $cenv{'course.helper.not.run'} = 1;
17744: #
17745: # Use new Randomseed
17746: #
17747: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17748: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17749: #
17750: # The encryption code and receipt prefix for this course
17751: #
17752: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17753: $cenv{'internal.encpref'}=100+int(9*rand(99));
17754: #
17755: # By default, use standard grading
17756: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17757:
1.541 raeburn 17758: $outcome .= $linefeed.&mt('Setting environment').': '.
17759: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17760: #
17761: # Open all assignments
17762: #
17763: if ($args->{'openall'}) {
1.1341 raeburn 17764: my $opendate = time;
17765: if ($args->{'openallfrom'} =~ /^\d+$/) {
17766: $opendate = $args->{'openallfrom'};
17767: }
1.444 albertel 17768: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17769: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17770: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17771: $outcome .= &mt('All assignments open starting [_1]',
17772: &Apache::lonlocal::locallocaltime($opendate)).': '.
17773: &Apache::lonnet::cput
17774: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17775: }
17776: #
17777: # Set first page
17778: #
17779: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17780: || ($cloneid)) {
17781: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17782:
17783: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17784: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17785:
1.444 albertel 17786: $outcome .= ($fatal?$errtext:'read ok').' - ';
17787: my $title; my $url;
17788: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17789: $title=&mt('Syllabus');
1.444 albertel 17790: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17791: } else {
1.963 raeburn 17792: $title=&mt('Table of Contents');
1.444 albertel 17793: $url='/adm/navmaps';
17794: }
1.445 albertel 17795:
17796: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17797: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17798:
17799: if ($errtext) { $fatal=2; }
1.541 raeburn 17800: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17801: }
1.566 albertel 17802:
1.1237 raeburn 17803: #
17804: # Set params for Placement Tests
17805: #
1.1239 raeburn 17806: if ($args->{'crstype'} eq 'Placement') {
17807: my %storecontent;
17808: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17809: my %defaults = (
17810: buttonshide => { value => 'yes',
17811: type => 'string_yesno',},
17812: type => { value => 'randomizetry',
17813: type => 'string_questiontype',},
17814: maxtries => { value => 1,
17815: type => 'int_pos',},
17816: problemstatus => { value => 'no',
17817: type => 'string_problemstatus',},
17818: );
17819: foreach my $key (keys(%defaults)) {
17820: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17821: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17822: }
1.1237 raeburn 17823: &Apache::lonnet::cput
17824: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17825: }
17826:
1.1344 raeburn 17827: return (1,$outcome,\@clonemsg);
1.444 albertel 17828: }
17829:
1.1166 raeburn 17830: sub make_unique_code {
17831: my ($cdom,$cnum) = @_;
17832: # get lock on uniquecodes db
17833: my $lockhash = {
17834: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17835: ':'.$env{'user.domain'},
17836: };
17837: my $tries = 0;
17838: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17839: my ($code,$error);
17840:
17841: while (($gotlock ne 'ok') && ($tries<3)) {
17842: $tries ++;
17843: sleep 1;
17844: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17845: }
17846: if ($gotlock eq 'ok') {
17847: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17848: my $gotcode;
17849: my $attempts = 0;
17850: while ((!$gotcode) && ($attempts < 100)) {
17851: $code = &generate_code();
17852: if (!exists($currcodes{$code})) {
17853: $gotcode = 1;
17854: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17855: $error = 'nostore';
17856: }
17857: }
17858: $attempts ++;
17859: }
17860: my @del_lock = ($cnum."\0".'uniquecodes');
17861: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17862: } else {
17863: $error = 'nolock';
17864: }
17865: return ($code,$error);
17866: }
17867:
17868: sub generate_code {
17869: my $code;
17870: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17871: for (my $i=0; $i<6; $i++) {
17872: my $lettnum = int (rand 2);
17873: my $item = '';
17874: if ($lettnum) {
17875: $item = $letts[int( rand(18) )];
17876: } else {
17877: $item = 1+int( rand(8) );
17878: }
17879: $code .= $item;
17880: }
17881: return $code;
17882: }
17883:
1.444 albertel 17884: ############################################################
17885: ############################################################
17886:
1.1237 raeburn 17887: # Community, Course and Placement Test
1.378 raeburn 17888: sub course_type {
17889: my ($cid) = @_;
17890: if (!defined($cid)) {
17891: $cid = $env{'request.course.id'};
17892: }
1.404 albertel 17893: if (defined($env{'course.'.$cid.'.type'})) {
17894: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17895: } else {
17896: return 'Course';
1.377 raeburn 17897: }
17898: }
1.156 albertel 17899:
1.406 raeburn 17900: sub group_term {
17901: my $crstype = &course_type();
17902: my %names = (
17903: 'Course' => 'group',
1.865 raeburn 17904: 'Community' => 'group',
1.1237 raeburn 17905: 'Placement' => 'group',
1.406 raeburn 17906: );
17907: return $names{$crstype};
17908: }
17909:
1.902 raeburn 17910: sub course_types {
1.1310 raeburn 17911: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17912: my %typename = (
17913: official => 'Official course',
17914: unofficial => 'Unofficial course',
17915: community => 'Community',
1.1165 raeburn 17916: textbook => 'Textbook course',
1.1237 raeburn 17917: placement => 'Placement test',
1.1310 raeburn 17918: lti => 'LTI provider',
1.902 raeburn 17919: );
17920: return (\@types,\%typename);
17921: }
17922:
1.156 albertel 17923: sub icon {
17924: my ($file)=@_;
1.505 albertel 17925: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17926: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17927: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17928: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17929: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17930: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17931: $curfext.".gif") {
17932: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17933: $curfext.".gif";
17934: }
17935: }
1.249 albertel 17936: return &lonhttpdurl($iconname);
1.154 albertel 17937: }
1.84 albertel 17938:
1.575 albertel 17939: sub lonhttpdurl {
1.692 www 17940: #
17941: # Had been used for "small fry" static images on separate port 8080.
17942: # Modify here if lightweight http functionality desired again.
17943: # Currently eliminated due to increasing firewall issues.
17944: #
1.575 albertel 17945: my ($url)=@_;
1.692 www 17946: return $url;
1.215 albertel 17947: }
17948:
1.213 albertel 17949: sub connection_aborted {
17950: my ($r)=@_;
17951: $r->print(" ");$r->rflush();
17952: my $c = $r->connection;
17953: return $c->aborted();
17954: }
17955:
1.221 foxr 17956: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17957: # strings as 'strings'.
17958: sub escape_single {
1.221 foxr 17959: my ($input) = @_;
1.223 albertel 17960: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17961: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17962: return $input;
17963: }
1.223 albertel 17964:
1.222 foxr 17965: # Same as escape_single, but escape's "'s This
17966: # can be used for "strings"
17967: sub escape_double {
17968: my ($input) = @_;
17969: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17970: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17971: return $input;
17972: }
1.223 albertel 17973:
1.222 foxr 17974: # Escapes the last element of a full URL.
17975: sub escape_url {
17976: my ($url) = @_;
1.238 raeburn 17977: my @urlslices = split(/\//, $url,-1);
1.369 www 17978: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17979: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17980: }
1.462 albertel 17981:
1.820 raeburn 17982: sub compare_arrays {
17983: my ($arrayref1,$arrayref2) = @_;
17984: my (@difference,%count);
17985: @difference = ();
17986: %count = ();
17987: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17988: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17989: foreach my $element (keys(%count)) {
17990: if ($count{$element} == 1) {
17991: push(@difference,$element);
17992: }
17993: }
17994: }
17995: return @difference;
17996: }
17997:
1.1322 raeburn 17998: sub lon_status_items {
17999: my %defaults = (
18000: E => 100,
18001: W => 4,
18002: N => 1,
1.1324 raeburn 18003: U => 5,
1.1322 raeburn 18004: threshold => 200,
18005: sysmail => 2500,
18006: );
18007: my %names = (
18008: E => 'Errors',
18009: W => 'Warnings',
18010: N => 'Notices',
1.1324 raeburn 18011: U => 'Unsent',
1.1322 raeburn 18012: );
18013: return (\%defaults,\%names);
18014: }
18015:
1.817 bisitz 18016: # -------------------------------------------------------- Initialize user login
1.462 albertel 18017: sub init_user_environment {
1.463 albertel 18018: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 18019: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
18020:
18021: my $public=($username eq 'public' && $domain eq 'public');
18022:
1.1415 raeburn 18023: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
18024: $coauthorenv);
1.462 albertel 18025: my $now=time;
18026:
18027: if ($public) {
18028: my $max_public=100;
18029: my $oldest;
18030: my $oldest_time=0;
18031: for(my $next=1;$next<=$max_public;$next++) {
18032: if (-e $lonids."/publicuser_$next.id") {
18033: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
18034: if ($mtime<$oldest_time || !$oldest_time) {
18035: $oldest_time=$mtime;
18036: $oldest=$next;
18037: }
18038: } else {
18039: $cookie="publicuser_$next";
18040: last;
18041: }
18042: }
18043: if (!$cookie) { $cookie="publicuser_$oldest"; }
18044: } else {
1.1275 raeburn 18045: # See if old ID present, if so, remove if this isn't a robot,
18046: # killing any existing non-robot sessions
1.463 albertel 18047: if (!$args->{'robot'}) {
18048: opendir(DIR,$lonids);
18049: while ($filename=readdir(DIR)) {
18050: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 18051: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
18052: &GDBM_READER(),0640)) {
1.1295 raeburn 18053: my $linkedfile;
1.1320 raeburn 18054: if (exists($oldenv{'user.linkedenv'})) {
18055: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18056: }
1.1320 raeburn 18057: untie(%oldenv);
18058: if (unlink("$lonids/$filename")) {
18059: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18060: if (-l "$lonids/$linkedfile.id") {
18061: unlink("$lonids/$linkedfile.id");
18062: }
1.1295 raeburn 18063: }
18064: }
18065: } else {
18066: unlink($lonids.'/'.$filename);
18067: }
1.463 albertel 18068: }
1.462 albertel 18069: }
1.463 albertel 18070: closedir(DIR);
1.1204 raeburn 18071: # If there is a undeleted lockfile for the user's paste buffer remove it.
18072: my $namespace = 'nohist_courseeditor';
18073: my $lockingkey = 'paste'."\0".'locked_num';
18074: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18075: $domain,$username);
18076: if (exists($lockhash{$lockingkey})) {
18077: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18078: unless ($delresult eq 'ok') {
18079: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18080: }
18081: }
1.462 albertel 18082: }
18083: # Give them a new cookie
1.463 albertel 18084: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18085: : $now.$$.int(rand(10000)));
1.463 albertel 18086: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18087:
18088: # Initialize roles
18089:
1.1414 raeburn 18090: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18091: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18092: }
18093: # ------------------------------------ Check browser type and MathML capability
18094:
1.1194 raeburn 18095: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18096: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18097:
18098: # ------------------------------------------------------------- Get environment
18099:
18100: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18101: my ($tmp) = keys(%userenv);
1.1275 raeburn 18102: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18103: undef(%userenv);
18104: }
18105: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18106: $form->{'interface'}=$userenv{'interface'};
18107: }
18108: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18109:
18110: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18111: foreach my $option ('interface','localpath','localres') {
18112: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18113: }
18114: # --------------------------------------------------------- Write first profile
18115:
18116: {
1.1350 raeburn 18117: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18118: my %initial_env =
18119: ("user.name" => $username,
18120: "user.domain" => $domain,
18121: "user.home" => $authhost,
18122: "browser.type" => $clientbrowser,
18123: "browser.version" => $clientversion,
18124: "browser.mathml" => $clientmathml,
18125: "browser.unicode" => $clientunicode,
18126: "browser.os" => $clientos,
1.1137 raeburn 18127: "browser.mobile" => $clientmobile,
1.1141 raeburn 18128: "browser.info" => $clientinfo,
1.1194 raeburn 18129: "browser.osversion" => $clientosversion,
1.462 albertel 18130: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18131: "request.course.fn" => '',
18132: "request.course.uri" => '',
18133: "request.course.sec" => '',
18134: "request.role" => 'cm',
18135: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18136: "request.host" => $ip,);
1.462 albertel 18137:
18138: if ($form->{'localpath'}) {
18139: $initial_env{"browser.localpath"} = $form->{'localpath'};
18140: $initial_env{"browser.localres"} = $form->{'localres'};
18141: }
18142:
18143: if ($form->{'interface'}) {
18144: $form->{'interface'}=~s/\W//gs;
18145: $initial_env{"browser.interface"} = $form->{'interface'};
18146: $env{'browser.interface'}=$form->{'interface'};
18147: }
18148:
1.1157 raeburn 18149: if ($form->{'iptoken'}) {
18150: my $lonhost = $r->dir_config('lonHostID');
18151: $initial_env{"user.noloadbalance"} = $lonhost;
18152: $env{'user.noloadbalance'} = $lonhost;
18153: }
18154:
1.1268 raeburn 18155: if ($form->{'noloadbalance'}) {
18156: my @hosts = &Apache::lonnet::current_machine_ids();
18157: my $hosthere = $form->{'noloadbalance'};
18158: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18159: $initial_env{"user.noloadbalance"} = $hosthere;
18160: $env{'user.noloadbalance'} = $hosthere;
18161: }
18162: }
18163:
1.1016 raeburn 18164: unless ($domain eq 'public') {
1.1273 raeburn 18165: my %is_adv = ( is_adv => $env{'user.adv'} );
18166: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18167:
1.1414 raeburn 18168: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18169: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18170: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18171: undef,\%userenv,\%domdef,\%is_adv);
18172: }
1.980 raeburn 18173:
1.1311 raeburn 18174: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18175: $userenv{'canrequest.'.$crstype} =
18176: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18177: 'reload','requestcourses',
18178: \%userenv,\%domdef,\%is_adv);
18179: }
1.724 raeburn 18180:
1.1418 raeburn 18181: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18182: (exists($userroles->{"user.role.au./$domain/"}))) {
18183: if ($userenv{'authoreditors'}) {
18184: $userenv{'editors'} = $userenv{'authoreditors'};
18185: } elsif ($domdef{'editors'} ne '') {
18186: $userenv{'editors'} = $domdef{'editors'};
18187: } else {
18188: $userenv{'editors'} = 'edit,xml';
18189: }
1.1431 raeburn 18190: if ($userenv{'authorarchive'}) {
18191: $userenv{'canarchive'} = 1;
18192: } elsif (($userenv{'authorarchive'} eq '') &&
18193: ($domdef{'archive'})) {
18194: $userenv{'canarchive'} = 1;
18195: }
1.1418 raeburn 18196: }
18197:
1.1273 raeburn 18198: $userenv{'canrequest.author'} =
18199: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18200: 'reload','requestauthor',
1.980 raeburn 18201: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18202: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18203: $domain,$username);
18204: my $reqstatus = $reqauthor{'author_status'};
18205: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18206: if (ref($reqauthor{'author'}) eq 'HASH') {
18207: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18208: $reqauthor{'author'}{'timestamp'};
18209: }
1.1092 raeburn 18210: }
1.1287 raeburn 18211: my ($types,$typename) = &course_types();
18212: if (ref($types) eq 'ARRAY') {
18213: my @options = ('approval','validate','autolimit');
18214: my $optregex = join('|',@options);
18215: my (%willtrust,%trustchecked);
18216: foreach my $type (@{$types}) {
18217: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18218: if ($dom_str ne '') {
18219: my $updatedstr = '';
18220: my @possdomains = split(',',$dom_str);
18221: foreach my $entry (@possdomains) {
18222: my ($extdom,$extopt) = split(':',$entry);
18223: unless ($trustchecked{$extdom}) {
18224: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18225: $trustchecked{$extdom} = 1;
18226: }
18227: if ($willtrust{$extdom}) {
18228: $updatedstr .= $entry.',';
18229: }
18230: }
18231: $updatedstr =~ s/,$//;
18232: if ($updatedstr) {
18233: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18234: } else {
18235: delete($userenv{'reqcrsotherdom.'.$type});
18236: }
18237: }
18238: }
18239: }
1.1092 raeburn 18240: }
1.462 albertel 18241: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18242:
1.462 albertel 18243: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18244: &GDBM_WRCREAT(),0640)) {
18245: &_add_to_env(\%disk_env,\%initial_env);
18246: &_add_to_env(\%disk_env,\%userenv,'environment.');
18247: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18248: if (ref($firstaccenv) eq 'HASH') {
18249: &_add_to_env(\%disk_env,$firstaccenv);
18250: }
18251: if (ref($timerintenv) eq 'HASH') {
18252: &_add_to_env(\%disk_env,$timerintenv);
18253: }
1.1414 raeburn 18254: if (ref($coauthorenv) eq 'HASH') {
18255: if (keys(%{$coauthorenv})) {
18256: &_add_to_env(\%disk_env,$coauthorenv);
18257: }
18258: }
1.463 albertel 18259: if (ref($args->{'extra_env'})) {
18260: &_add_to_env(\%disk_env,$args->{'extra_env'});
18261: }
1.462 albertel 18262: untie(%disk_env);
18263: } else {
1.705 tempelho 18264: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18265: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18266: return 'error: '.$!;
18267: }
18268: }
18269: $env{'request.role'}='cm';
18270: $env{'request.role.adv'}=$env{'user.adv'};
18271: $env{'browser.type'}=$clientbrowser;
18272:
18273: return $cookie;
18274:
18275: }
18276:
18277: sub _add_to_env {
18278: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18279: if (ref($env_data) eq 'HASH') {
18280: while (my ($key,$value) = each(%$env_data)) {
18281: $idf->{$prefix.$key} = $value;
18282: $env{$prefix.$key} = $value;
18283: }
1.462 albertel 18284: }
18285: }
18286:
1.685 tempelho 18287: # --- Get the symbolic name of a problem and the url
18288: sub get_symb {
18289: my ($request,$silent) = @_;
1.726 raeburn 18290: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18291: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18292: if ($symb eq '') {
18293: if (!$silent) {
1.1071 raeburn 18294: if (ref($request)) {
18295: $request->print("Unable to handle ambiguous references:$url:.");
18296: }
1.685 tempelho 18297: return ();
18298: }
18299: }
18300: &Apache::lonenc::check_decrypt(\$symb);
18301: return ($symb);
18302: }
18303:
18304: # --------------------------------------------------------------Get annotation
18305:
18306: sub get_annotation {
18307: my ($symb,$enc) = @_;
18308:
18309: my $key = $symb;
18310: if (!$enc) {
18311: $key =
18312: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18313: }
18314: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18315: return $annotation{$key};
18316: }
18317:
18318: sub clean_symb {
1.731 raeburn 18319: my ($symb,$delete_enc) = @_;
1.685 tempelho 18320:
18321: &Apache::lonenc::check_decrypt(\$symb);
18322: my $enc = $env{'request.enc'};
1.731 raeburn 18323: if ($delete_enc) {
1.730 raeburn 18324: delete($env{'request.enc'});
18325: }
1.685 tempelho 18326:
18327: return ($symb,$enc);
18328: }
1.462 albertel 18329:
1.1181 raeburn 18330: ############################################################
18331: ############################################################
18332:
18333: =pod
18334:
18335: =head1 Routines for building display used to search for courses
18336:
18337:
18338: =over 4
18339:
18340: =item * &build_filters()
18341:
18342: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18343: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18344: and quotacheck.pl
18345:
1.1181 raeburn 18346:
18347: Inputs:
18348:
18349: filterlist - anonymous array of fields to include as potential filters
18350:
18351: crstype - course type
18352:
18353: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18354: to pop-open a course selector (will contain "extra element").
18355:
18356: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18357:
18358: filter - anonymous hash of criteria and their values
18359:
18360: action - form action
18361:
18362: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18363:
1.1182 raeburn 18364: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18365:
18366: cloneruname - username of owner of new course who wants to clone
18367:
18368: clonerudom - domain of owner of new course who wants to clone
18369:
18370: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18371:
18372: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18373:
18374: codedom - domain
18375:
18376: formname - value of form element named "form".
18377:
18378: fixeddom - domain, if fixed.
18379:
18380: prevphase - value to assign to form element named "phase" when going back to the previous screen
18381:
18382: cnameelement - name of form element in form on opener page which will receive title of selected course
18383:
18384: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18385:
18386: cdomelement - name of form element in form on opener page which will receive domain of selected course
18387:
18388: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18389:
18390: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18391:
18392: clonewarning - warning message about missing information for intended course owner when DC creates a course
18393:
1.1182 raeburn 18394:
1.1181 raeburn 18395: Returns: $output - HTML for display of search criteria, and hidden form elements.
18396:
1.1182 raeburn 18397:
1.1181 raeburn 18398: Side Effects: None
18399:
18400: =cut
18401:
18402: # ---------------------------------------------- search for courses based on last activity etc.
18403:
18404: sub build_filters {
18405: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18406: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18407: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18408: $cnameelement,$cnumelement,$cdomelement,$setroles,
18409: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18410: my ($list,$jscript);
1.1181 raeburn 18411: my $onchange = 'javascript:updateFilters(this)';
18412: my ($domainselectform,$sincefilterform,$createdfilterform,
18413: $ownerdomselectform,$persondomselectform,$instcodeform,
18414: $typeselectform,$instcodetitle);
18415: if ($formname eq '') {
18416: $formname = $caller;
18417: }
18418: foreach my $item (@{$filterlist}) {
18419: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18420: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18421: if ($item eq 'domainfilter') {
18422: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18423: } elsif ($item eq 'coursefilter') {
18424: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18425: } elsif ($item eq 'ownerfilter') {
18426: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18427: } elsif ($item eq 'ownerdomfilter') {
18428: $filter->{'ownerdomfilter'} =
18429: &LONCAPA::clean_domain($filter->{$item});
18430: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18431: 'ownerdomfilter',1);
18432: } elsif ($item eq 'personfilter') {
18433: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18434: } elsif ($item eq 'persondomfilter') {
18435: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18436: 'persondomfilter',1);
18437: } else {
18438: $filter->{$item} =~ s/\W//g;
18439: }
18440: if (!$filter->{$item}) {
18441: $filter->{$item} = '';
18442: }
18443: }
18444: if ($item eq 'domainfilter') {
18445: my $allow_blank = 1;
18446: if ($formname eq 'portform') {
18447: $allow_blank=0;
18448: } elsif ($formname eq 'studentform') {
18449: $allow_blank=0;
18450: }
18451: if ($fixeddom) {
18452: $domainselectform = '<input type="hidden" name="domainfilter"'.
18453: ' value="'.$codedom.'" />'.
18454: &Apache::lonnet::domain($codedom,'description');
18455: } else {
18456: $domainselectform = &select_dom_form($filter->{$item},
18457: 'domainfilter',
18458: $allow_blank,'',$onchange);
18459: }
18460: } else {
18461: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18462: }
18463: }
18464:
18465: # last course activity filter and selection
18466: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18467:
18468: # course created filter and selection
18469: if (exists($filter->{'createdfilter'})) {
18470: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18471: }
18472:
1.1239 raeburn 18473: my $prefix = $crstype;
18474: if ($crstype eq 'Placement') {
18475: $prefix = 'Placement Test'
18476: }
1.1181 raeburn 18477: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18478: 'cac' => "$prefix Activity",
18479: 'ccr' => "$prefix Created",
18480: 'cde' => "$prefix Title",
18481: 'cdo' => "$prefix Domain",
1.1181 raeburn 18482: 'ins' => 'Institutional Code',
18483: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18484: 'cow' => "$prefix Owner/Co-owner",
18485: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18486: 'cog' => 'Type',
18487: );
18488:
18489: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18490: my $typeval = 'Course';
18491: if ($crstype eq 'Community') {
18492: $typeval = 'Community';
1.1239 raeburn 18493: } elsif ($crstype eq 'Placement') {
18494: $typeval = 'Placement';
1.1181 raeburn 18495: }
18496: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18497: } else {
18498: $typeselectform = '<select name="type" size="1"';
18499: if ($onchange) {
18500: $typeselectform .= ' onchange="'.$onchange.'"';
18501: }
18502: $typeselectform .= '>'."\n";
1.1237 raeburn 18503: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18504: my $shown;
18505: if ($posstype eq 'Placement') {
18506: $shown = &mt('Placement Test');
18507: } else {
18508: $shown = &mt($posstype);
18509: }
1.1181 raeburn 18510: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18511: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18512: }
18513: $typeselectform.="</select>";
18514: }
18515:
18516: my ($cloneableonlyform,$cloneabletitle);
18517: if (exists($filter->{'cloneableonly'})) {
18518: my $cloneableon = '';
18519: my $cloneableoff = ' checked="checked"';
18520: if ($filter->{'cloneableonly'}) {
18521: $cloneableon = $cloneableoff;
18522: $cloneableoff = '';
18523: }
18524: $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>';
18525: if ($formname eq 'ccrs') {
1.1187 bisitz 18526: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18527: } else {
18528: $cloneabletitle = &mt('Cloneable by you');
18529: }
18530: }
18531: my $officialjs;
18532: if ($crstype eq 'Course') {
18533: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18534: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18535: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18536: if ($codedom) {
1.1181 raeburn 18537: $officialjs = 1;
18538: ($instcodeform,$jscript,$$numtitlesref) =
18539: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18540: $officialjs,$codetitlesref);
18541: if ($jscript) {
1.1182 raeburn 18542: $jscript = '<script type="text/javascript">'."\n".
18543: '// <![CDATA['."\n".
18544: $jscript."\n".
18545: '// ]]>'."\n".
18546: '</script>'."\n";
1.1181 raeburn 18547: }
18548: }
18549: if ($instcodeform eq '') {
18550: $instcodeform =
18551: '<input type="text" name="instcodefilter" size="10" value="'.
18552: $list->{'instcodefilter'}.'" />';
18553: $instcodetitle = $lt{'ins'};
18554: } else {
18555: $instcodetitle = $lt{'inc'};
18556: }
18557: if ($fixeddom) {
18558: $instcodetitle .= '<br />('.$codedom.')';
18559: }
18560: }
18561: }
18562: my $output = qq|
18563: <form method="post" name="filterpicker" action="$action">
18564: <input type="hidden" name="form" value="$formname" />
18565: |;
18566: if ($formname eq 'modifycourse') {
18567: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18568: '<input type="hidden" name="prevphase" value="'.
18569: $prevphase.'" />'."\n";
1.1198 musolffc 18570: } elsif ($formname eq 'quotacheck') {
18571: $output .= qq|
18572: <input type="hidden" name="sortby" value="" />
18573: <input type="hidden" name="sortorder" value="" />
18574: |;
18575: } else {
1.1181 raeburn 18576: my $name_input;
18577: if ($cnameelement ne '') {
18578: $name_input = '<input type="hidden" name="cnameelement" value="'.
18579: $cnameelement.'" />';
18580: }
18581: $output .= qq|
1.1182 raeburn 18582: <input type="hidden" name="cnumelement" value="$cnumelement" />
18583: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18584: $name_input
18585: $roleelement
18586: $multelement
18587: $typeelement
18588: |;
18589: if ($formname eq 'portform') {
18590: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18591: }
18592: }
18593: if ($fixeddom) {
18594: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18595: }
18596: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18597: if ($sincefilterform) {
18598: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18599: .$sincefilterform
18600: .&Apache::lonhtmlcommon::row_closure();
18601: }
18602: if ($createdfilterform) {
18603: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18604: .$createdfilterform
18605: .&Apache::lonhtmlcommon::row_closure();
18606: }
18607: if ($domainselectform) {
18608: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18609: .$domainselectform
18610: .&Apache::lonhtmlcommon::row_closure();
18611: }
18612: if ($typeselectform) {
18613: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18614: $output .= $typeselectform;
18615: } else {
18616: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18617: .$typeselectform
18618: .&Apache::lonhtmlcommon::row_closure();
18619: }
18620: }
18621: if ($instcodeform) {
18622: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18623: .$instcodeform
18624: .&Apache::lonhtmlcommon::row_closure();
18625: }
18626: if (exists($filter->{'ownerfilter'})) {
18627: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18628: '<table><tr><td>'.&mt('Username').'<br />'.
18629: '<input type="text" name="ownerfilter" size="20" value="'.
18630: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18631: $ownerdomselectform.'</td></tr></table>'.
18632: &Apache::lonhtmlcommon::row_closure();
18633: }
18634: if (exists($filter->{'personfilter'})) {
18635: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18636: '<table><tr><td>'.&mt('Username').'<br />'.
18637: '<input type="text" name="personfilter" size="20" value="'.
18638: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18639: $persondomselectform.'</td></tr></table>'.
18640: &Apache::lonhtmlcommon::row_closure();
18641: }
18642: if (exists($filter->{'coursefilter'})) {
18643: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18644: .'<input type="text" name="coursefilter" size="25" value="'
18645: .$list->{'coursefilter'}.'" />'
18646: .&Apache::lonhtmlcommon::row_closure();
18647: }
18648: if ($cloneableonlyform) {
18649: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18650: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18651: }
18652: if (exists($filter->{'descriptfilter'})) {
18653: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18654: .'<input type="text" name="descriptfilter" size="40" value="'
18655: .$list->{'descriptfilter'}.'" />'
18656: .&Apache::lonhtmlcommon::row_closure(1);
18657: }
18658: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18659: '<input type="hidden" name="updater" value="" />'."\n".
18660: '<input type="submit" name="gosearch" value="'.
18661: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18662: return $jscript.$clonewarning.$output;
18663: }
18664:
18665: =pod
18666:
18667: =item * &timebased_select_form()
18668:
1.1182 raeburn 18669: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18670: filter e.g., Course Activity, Course Created, when searching for courses
18671: or communities
18672:
18673: Inputs:
18674:
18675: item - name of form element (sincefilter or createdfilter)
18676:
18677: filter - anonymous hash of criteria and their values
18678:
18679: Returns: HTML for a select box contained a blank, then six time selections,
18680: with value set in incoming form variables currently selected.
18681:
18682: Side Effects: None
18683:
18684: =cut
18685:
18686: sub timebased_select_form {
18687: my ($item,$filter) = @_;
18688: if (ref($filter) eq 'HASH') {
18689: $filter->{$item} =~ s/[^\d-]//g;
18690: if (!$filter->{$item}) { $filter->{$item}=-1; }
18691: return &select_form(
18692: $filter->{$item},
18693: $item,
18694: { '-1' => '',
18695: '86400' => &mt('today'),
18696: '604800' => &mt('last week'),
18697: '2592000' => &mt('last month'),
18698: '7776000' => &mt('last three months'),
18699: '15552000' => &mt('last six months'),
18700: '31104000' => &mt('last year'),
18701: 'select_form_order' =>
18702: ['-1','86400','604800','2592000','7776000',
18703: '15552000','31104000']});
18704: }
18705: }
18706:
18707: =pod
18708:
18709: =item * &js_changer()
18710:
18711: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18712: when course type or domain is changed, and also to hide 'Searching ...' on
18713: page load completion for page showing search result.
1.1181 raeburn 18714:
18715: Inputs: None
18716:
1.1183 raeburn 18717: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18718:
18719: Side Effects: None
18720:
18721: =cut
18722:
18723: sub js_changer {
18724: return <<ENDJS;
18725: <script type="text/javascript">
18726: // <![CDATA[
18727: function updateFilters(caller) {
18728: if (typeof(caller) != "undefined") {
18729: document.filterpicker.updater.value = caller.name;
18730: }
18731: document.filterpicker.submit();
18732: }
1.1183 raeburn 18733:
18734: function hideSearching() {
18735: if (document.getElementById('searching')) {
18736: document.getElementById('searching').style.display = 'none';
18737: }
18738: return;
18739: }
18740:
1.1181 raeburn 18741: // ]]>
18742: </script>
18743:
18744: ENDJS
18745: }
18746:
18747: =pod
18748:
1.1182 raeburn 18749: =item * &search_courses()
18750:
18751: Process selected filters form course search form and pass to lonnet::courseiddump
18752: to retrieve a hash for which keys are courseIDs which match the selected filters.
18753:
18754: Inputs:
18755:
18756: dom - domain being searched
18757:
18758: type - course type ('Course' or 'Community' or '.' if any).
18759:
18760: filter - anonymous hash of criteria and their values
18761:
18762: numtitles - for institutional codes - number of categories
18763:
18764: cloneruname - optional username of new course owner
18765:
18766: clonerudom - optional domain of new course owner
18767:
1.1221 raeburn 18768: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18769: (used when DC is using course creation form)
18770:
18771: codetitles - reference to array of titles of components in institutional codes (official courses).
18772:
1.1221 raeburn 18773: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18774: (and so can clone automatically)
18775:
18776: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18777:
18778: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18779: courses to clone
1.1182 raeburn 18780:
18781: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18782:
18783:
18784: Side Effects: None
18785:
18786: =cut
18787:
18788:
18789: sub search_courses {
1.1221 raeburn 18790: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18791: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18792: my (%courses,%showcourses,$cloner);
18793: if (($filter->{'ownerfilter'} ne '') ||
18794: ($filter->{'ownerdomfilter'} ne '')) {
18795: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18796: $filter->{'ownerdomfilter'};
18797: }
18798: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18799: if (!$filter->{$item}) {
18800: $filter->{$item}='.';
18801: }
18802: }
18803: my $now = time;
18804: my $timefilter =
18805: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18806: my ($createdbefore,$createdafter);
18807: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18808: $createdbefore = $now;
18809: $createdafter = $now-$filter->{'createdfilter'};
18810: }
18811: my ($instcodefilter,$regexpok);
18812: if ($numtitles) {
18813: if ($env{'form.official'} eq 'on') {
18814: $instcodefilter =
18815: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18816: $regexpok = 1;
18817: } elsif ($env{'form.official'} eq 'off') {
18818: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18819: unless ($instcodefilter eq '') {
18820: $regexpok = -1;
18821: }
18822: }
18823: } else {
18824: $instcodefilter = $filter->{'instcodefilter'};
18825: }
18826: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18827: if ($type eq '') { $type = '.'; }
18828:
18829: if (($clonerudom ne '') && ($cloneruname ne '')) {
18830: $cloner = $cloneruname.':'.$clonerudom;
18831: }
18832: %courses = &Apache::lonnet::courseiddump($dom,
18833: $filter->{'descriptfilter'},
18834: $timefilter,
18835: $instcodefilter,
18836: $filter->{'combownerfilter'},
18837: $filter->{'coursefilter'},
18838: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18839: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18840: $filter->{'cloneableonly'},
18841: $createdbefore,$createdafter,undef,
1.1221 raeburn 18842: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18843: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18844: my $ccrole;
18845: if ($type eq 'Community') {
18846: $ccrole = 'co';
18847: } else {
18848: $ccrole = 'cc';
18849: }
18850: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18851: $filter->{'persondomfilter'},
18852: 'userroles',undef,
18853: [$ccrole,'in','ad','ep','ta','cr'],
18854: $dom);
18855: foreach my $role (keys(%rolehash)) {
18856: my ($cnum,$cdom,$courserole) = split(':',$role);
18857: my $cid = $cdom.'_'.$cnum;
18858: if (exists($courses{$cid})) {
18859: if (ref($courses{$cid}) eq 'HASH') {
18860: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18861: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18862: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18863: }
18864: } else {
18865: $courses{$cid}{roles} = [$courserole];
18866: }
18867: $showcourses{$cid} = $courses{$cid};
18868: }
18869: }
18870: }
18871: %courses = %showcourses;
18872: }
18873: return %courses;
18874: }
18875:
18876: =pod
18877:
1.1181 raeburn 18878: =back
18879:
1.1207 raeburn 18880: =head1 Routines for version requirements for current course.
18881:
18882: =over 4
18883:
18884: =item * &check_release_required()
18885:
18886: Compares required LON-CAPA version with version on server, and
18887: if required version is newer looks for a server with the required version.
18888:
18889: Looks first at servers in user's owen domain; if none suitable, looks at
18890: servers in course's domain are permitted to host sessions for user's domain.
18891:
18892: Inputs:
18893:
18894: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18895:
18896: $courseid - Course ID of current course
18897:
18898: $rolecode - User's current role in course (for switchserver query string).
18899:
18900: $required - LON-CAPA version needed by course (format: Major.Minor).
18901:
18902:
18903: Returns:
18904:
18905: $switchserver - query string tp append to /adm/switchserver call (if
18906: current server's LON-CAPA version is too old.
18907:
18908: $warning - Message is displayed if no suitable server could be found.
18909:
18910: =cut
18911:
18912: sub check_release_required {
18913: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18914: my ($switchserver,$warning);
18915: if ($required ne '') {
18916: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18917: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18918: if ($reqdmajor ne '' && $reqdminor ne '') {
18919: my $otherserver;
18920: if (($major eq '' && $minor eq '') ||
18921: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18922: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18923: my $switchlcrev =
18924: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18925: $userdomserver);
18926: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18927: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18928: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18929: my $cdom = $env{'course.'.$courseid.'.domain'};
18930: if ($cdom ne $env{'user.domain'}) {
18931: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18932: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18933: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18934: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18935: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18936: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18937: my $canhost =
18938: &Apache::lonnet::can_host_session($env{'user.domain'},
18939: $coursedomserver,
18940: $remoterev,
18941: $udomdefaults{'remotesessions'},
18942: $defdomdefaults{'hostedsessions'});
18943:
18944: if ($canhost) {
18945: $otherserver = $coursedomserver;
18946: } else {
18947: $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.");
18948: }
18949: } else {
18950: $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).");
18951: }
18952: } else {
18953: $otherserver = $userdomserver;
18954: }
18955: }
18956: if ($otherserver ne '') {
18957: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18958: }
18959: }
18960: }
18961: return ($switchserver,$warning);
18962: }
18963:
18964: =pod
18965:
18966: =item * &check_release_result()
18967:
18968: Inputs:
18969:
18970: $switchwarning - Warning message if no suitable server found to host session.
18971:
18972: $switchserver - query string to append to /adm/switchserver containing lonHostID
18973: and current role.
18974:
18975: Returns: HTML to display with information about requirement to switch server.
18976: Either displaying warning with link to Roles/Courses screen or
18977: display link to switchserver.
18978:
1.1181 raeburn 18979: =cut
18980:
1.1207 raeburn 18981: sub check_release_result {
18982: my ($switchwarning,$switchserver) = @_;
18983: my $output = &start_page('Selected course unavailable on this server').
18984: '<p class="LC_warning">';
18985: if ($switchwarning) {
18986: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18987: if (&show_course()) {
18988: $output .= &mt('Display courses');
18989: } else {
18990: $output .= &mt('Display roles');
18991: }
18992: $output .= '</a>';
18993: } elsif ($switchserver) {
18994: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18995: '<br />'.
18996: '<a href="/adm/switchserver?'.$switchserver.'">'.
18997: &mt('Switch Server').
18998: '</a>';
18999: }
19000: $output .= '</p>'.&end_page();
19001: return $output;
19002: }
19003:
19004: =pod
19005:
19006: =item * &needs_coursereinit()
19007:
19008: Determine if course contents stored for user's session needs to be
19009: refreshed, because content has changed since "Big Hash" last tied.
19010:
19011: Check for change is made if time last checked is more than 10 minutes ago
19012: (by default).
19013:
19014: Inputs:
19015:
19016: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
19017:
19018: $interval (optional) - Time which may elapse (in s) between last check for content
19019: change in current course. (default: 600 s).
19020:
19021: Returns: an array; first element is:
19022:
19023: =over 4
19024:
19025: 'switch' - if content updates mean user's session
19026: needs to be switched to a server running a newer LON-CAPA version
19027:
19028: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
19029: on current server hosting user's session
19030:
19031: '' - if no action required.
19032:
19033: =back
19034:
19035: If first item element is 'switch':
19036:
19037: second item is $switchwarning - Warning message if no suitable server found to host session.
19038:
19039: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
19040: and current role.
19041:
19042: otherwise: no other elements returned.
19043:
19044: =back
19045:
19046: =cut
19047:
19048: sub needs_coursereinit {
19049: my ($loncaparev,$interval) = @_;
19050: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
19051: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19052: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19053: my $now = time;
19054: if ($interval eq '') {
19055: $interval = 600;
19056: }
19057: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19058: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19059: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19060: if ($blocked) {
19061: return ();
19062: }
1.1391 raeburn 19063: my $update;
19064: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19065: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19066: if ($lastmainchange > $env{'request.course.tied'}) {
19067: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19068: if ($needswitch) {
19069: return ('switch',$switchwarning,$switchserver);
19070: }
19071: $update = 'main';
19072: }
19073: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19074: if ($update) {
19075: $update = 'both';
19076: } else {
19077: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19078: if ($needswitch) {
19079: return ('switch',$switchwarning,$switchserver);
19080: } else {
19081: $update = 'supp';
1.1207 raeburn 19082: }
19083: }
1.1391 raeburn 19084: }
1.1453 raeburn 19085: return ($update);
1.1391 raeburn 19086: }
19087: return ();
19088: }
19089:
19090: sub switch_for_update {
19091: my ($loncaparev,$cdom,$cnum) = @_;
19092: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19093: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19094: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19095: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19096: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19097: $curr_reqd_hash{'internal.releaserequired'}});
19098: my ($switchserver,$switchwarning) =
19099: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19100: $curr_reqd_hash{'internal.releaserequired'});
19101: if ($switchwarning ne '' || $switchserver ne '') {
19102: return ('switch',$switchwarning,$switchserver);
19103: }
1.1207 raeburn 19104: }
19105: }
19106: return ();
19107: }
1.1181 raeburn 19108:
1.1083 raeburn 19109: sub update_content_constraints {
1.1395 raeburn 19110: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19111: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19112: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19113: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19114: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19115: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19116: if ($item eq 'resourcetag') {
19117: if ($name eq 'responsetype') {
19118: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19119: }
1.1307 raeburn 19120: } elsif ($item eq 'course') {
19121: if ($name eq 'courserestype') {
19122: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19123: }
1.1083 raeburn 19124: }
19125: }
19126: my $navmap = Apache::lonnavmaps::navmap->new();
19127: if (defined($navmap)) {
1.1307 raeburn 19128: my (%allresponses,%allcrsrestypes);
19129: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19130: if ($res->is_tool()) {
19131: if ($allcrsrestypes{'exttool'}) {
19132: $allcrsrestypes{'exttool'} ++;
19133: } else {
19134: $allcrsrestypes{'exttool'} = 1;
19135: }
19136: next;
19137: }
1.1083 raeburn 19138: my %responses = $res->responseTypes();
19139: foreach my $key (keys(%responses)) {
19140: next unless(exists($checkresponsetypes{$key}));
19141: $allresponses{$key} += $responses{$key};
19142: }
19143: }
19144: foreach my $key (keys(%allresponses)) {
19145: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19146: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19147: ($reqdmajor,$reqdminor) = ($major,$minor);
19148: }
19149: }
1.1307 raeburn 19150: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19151: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19152: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19153: ($reqdmajor,$reqdminor) = ($major,$minor);
19154: }
19155: }
1.1083 raeburn 19156: undef($navmap);
19157: }
1.1391 raeburn 19158: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19159: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19160: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19161: ($reqdmajor,$reqdminor) = ($major,$minor);
19162: }
19163: }
1.1083 raeburn 19164: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19165: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19166: }
19167: return;
19168: }
19169:
1.1110 raeburn 19170: sub allmaps_incourse {
19171: my ($cdom,$cnum,$chome,$cid) = @_;
19172: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19173: $cid = $env{'request.course.id'};
19174: $cdom = $env{'course.'.$cid.'.domain'};
19175: $cnum = $env{'course.'.$cid.'.num'};
19176: $chome = $env{'course.'.$cid.'.home'};
19177: }
19178: my %allmaps = ();
19179: my $lastchange =
19180: &Apache::lonnet::get_coursechange($cdom,$cnum);
19181: if ($lastchange > $env{'request.course.tied'}) {
19182: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19183: unless ($ferr) {
1.1395 raeburn 19184: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19185: }
19186: }
19187: my $navmap = Apache::lonnavmaps::navmap->new();
19188: if (defined($navmap)) {
19189: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19190: $allmaps{$res->src()} = 1;
19191: }
19192: }
19193: return \%allmaps;
19194: }
19195:
1.1083 raeburn 19196: sub parse_supplemental_title {
19197: my ($title) = @_;
19198:
19199: my ($foldertitle,$renametitle);
19200: if ($title =~ /&&&/) {
19201: $title = &HTML::Entites::decode($title);
19202: }
19203: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19204: $renametitle=$4;
19205: my ($time,$uname,$udom) = ($1,$2,$3);
19206: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19207: my $name = &plainname($uname,$udom);
19208: $name = &HTML::Entities::encode($name,'"<>&\'');
19209: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19210: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19211: if ($foldertitle ne '') {
1.1401 raeburn 19212: $title .= ': <br />'.$foldertitle;
19213: }
1.1083 raeburn 19214: }
19215: if (wantarray) {
19216: return ($title,$foldertitle,$renametitle);
19217: }
19218: return $title;
19219: }
19220:
1.1395 raeburn 19221: sub get_supplemental {
19222: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19223: my $hashid=$cnum.':'.$cdom;
19224: my ($supplemental,$cached,$set_httprefs);
19225: unless ($ignorecache) {
19226: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19227: }
19228: unless (defined($cached)) {
19229: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19230: unless ($chome eq 'no_host') {
19231: my @order = @LONCAPA::map::order;
19232: my @resources = @LONCAPA::map::resources;
19233: my @resparms = @LONCAPA::map::resparms;
19234: my @zombies = @LONCAPA::map::zombies;
19235: my ($errors,%ids,%hidden);
19236: $errors =
19237: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19238: $errors,$possdel,\%ids,\%hidden);
19239: @LONCAPA::map::order = @order;
19240: @LONCAPA::map::resources = @resources;
19241: @LONCAPA::map::resparms = @resparms;
19242: @LONCAPA::map::zombies = @zombies;
19243: $set_httprefs = 1;
19244: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19245: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19246: }
19247: $supplemental = {
19248: ids => \%ids,
19249: hidden => \%hidden,
19250: };
19251: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19252: }
19253: }
19254: return ($supplemental,$set_httprefs);
19255: }
19256:
1.1143 raeburn 19257: sub recurse_supplemental {
1.1391 raeburn 19258: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19259: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19260: my $mapnum;
19261: if ($suppmap eq 'supplemental.sequence') {
19262: $mapnum = 0;
19263: } else {
19264: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19265: }
1.1143 raeburn 19266: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19267: if ($fatal) {
19268: $errors ++;
19269: } else {
1.1389 raeburn 19270: my @order = @LONCAPA::map::order;
19271: if (@order > 0) {
19272: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19273: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19274: foreach my $idx (@order) {
19275: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19276: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19277: my $id = $mapnum.':'.$idx;
19278: push(@{$suppids->{$src}},$id);
19279: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19280: $hiddensupp->{$id} = 1;
19281: }
1.1146 raeburn 19282: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19283: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19284: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19285: } else {
1.1391 raeburn 19286: my $allowed;
19287: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19288: $allowed = 1;
19289: } elsif ($possdel) {
19290: foreach my $item (@{$suppids->{$src}}) {
19291: next if ($item eq $id);
19292: unless ($hiddensupp->{$item}) {
19293: $allowed = 1;
19294: last;
19295: }
19296: }
19297: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19298: &Apache::lonnet::delenv('httpref.'.$src);
19299: }
19300: }
19301: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19302: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19303: }
1.1143 raeburn 19304: }
19305: }
19306: }
19307: }
19308: }
19309: }
1.1391 raeburn 19310: return $errors;
19311: }
19312:
19313: sub set_supp_httprefs {
19314: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19315: if (ref($supplemental) eq 'HASH') {
19316: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19317: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19318: next if ($src =~ /\.sequence$/);
19319: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19320: my $allowed;
19321: if ($env{'request.role.adv'}) {
19322: $allowed = 1;
19323: } else {
19324: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19325: unless ($supplemental->{'hidden'}->{$id}) {
19326: $allowed = 1;
19327: last;
19328: }
19329: }
19330: }
19331: if (exists($env{'httpref.'.$src})) {
19332: if ($possdel) {
19333: unless ($allowed) {
19334: &Apache::lonnet::delenv('httpref.'.$src);
19335: }
19336: }
19337: } elsif ($allowed) {
19338: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19339: }
19340: }
19341: }
19342: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19343: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19344: }
19345: }
19346: }
19347: }
19348:
19349: sub get_supp_parameter {
19350: my ($resparm,$name)=@_;
19351: return if ($resparm eq '');
19352: my $value=undef;
19353: my $ptype=undef;
19354: foreach (split('&&&',$resparm)) {
19355: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19356: if ($thisname eq $name) {
19357: $value=$thisvalue;
19358: $ptype=$thistype;
19359: }
19360: }
19361: return $value;
1.1143 raeburn 19362: }
19363:
1.1101 raeburn 19364: sub symb_to_docspath {
1.1267 raeburn 19365: my ($symb,$navmapref) = @_;
19366: return unless ($symb && ref($navmapref));
1.1101 raeburn 19367: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19368: if ($resurl=~/\.(sequence|page)$/) {
19369: $mapurl=$resurl;
19370: } elsif ($resurl eq 'adm/navmaps') {
19371: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19372: }
19373: my $mapresobj;
1.1267 raeburn 19374: unless (ref($$navmapref)) {
19375: $$navmapref = Apache::lonnavmaps::navmap->new();
19376: }
19377: if (ref($$navmapref)) {
19378: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19379: }
19380: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19381: my $type=$2;
19382: my $path;
19383: if (ref($mapresobj)) {
19384: my $pcslist = $mapresobj->map_hierarchy();
19385: if ($pcslist ne '') {
19386: foreach my $pc (split(/,/,$pcslist)) {
19387: next if ($pc <= 1);
1.1267 raeburn 19388: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19389: if (ref($res)) {
19390: my $thisurl = $res->src();
19391: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19392: my $thistitle = $res->title();
19393: $path .= '&'.
19394: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19395: &escape($thistitle).
1.1101 raeburn 19396: ':'.$res->randompick().
19397: ':'.$res->randomout().
19398: ':'.$res->encrypted().
19399: ':'.$res->randomorder().
19400: ':'.$res->is_page();
19401: }
19402: }
19403: }
19404: $path =~ s/^\&//;
19405: my $maptitle = $mapresobj->title();
19406: if ($mapurl eq 'default') {
1.1129 raeburn 19407: $maptitle = 'Main Content';
1.1101 raeburn 19408: }
19409: $path .= (($path ne '')? '&' : '').
19410: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19411: &escape($maptitle).
1.1101 raeburn 19412: ':'.$mapresobj->randompick().
19413: ':'.$mapresobj->randomout().
19414: ':'.$mapresobj->encrypted().
19415: ':'.$mapresobj->randomorder().
19416: ':'.$mapresobj->is_page();
19417: } else {
19418: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19419: my $ispage = (($type eq 'page')? 1 : '');
19420: if ($mapurl eq 'default') {
1.1129 raeburn 19421: $maptitle = 'Main Content';
1.1101 raeburn 19422: }
19423: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19424: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19425: }
19426: unless ($mapurl eq 'default') {
19427: $path = 'default&'.
1.1146 raeburn 19428: &escape('Main Content').
1.1101 raeburn 19429: ':::::&'.$path;
19430: }
19431: return $path;
19432: }
19433:
1.1393 raeburn 19434: sub validate_folderpath {
19435: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19436: if ($env{'form.folderpath'} ne '') {
19437: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19438: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19439: for (my $i=0; $i<@items; $i++) {
19440: my $odd = $i%2;
19441: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19442: $badpath = 1;
1.1394 raeburn 19443: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19444: my $idx = $i-1;
1.1394 raeburn 19445: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19446: my $esc_name = $1;
19447: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19448: $supppath .= '&'.$esc_name;
19449: $changed = 1;
19450: } else {
19451: $supppath .= '&'.$items[$i];
19452: }
19453: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19454: $changed = 1;
1.1393 raeburn 19455: my $is_hidden;
19456: unless ($got_supp) {
1.1395 raeburn 19457: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19458: if (ref($supplemental) eq 'HASH') {
19459: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19460: %supphidden = %{$supplemental->{'hidden'}};
19461: }
19462: if (ref($supplemental->{'ids'}) eq 'HASH') {
19463: %suppids = %{$supplemental->{'ids'}};
19464: }
19465: }
19466: $got_supp = 1;
19467: }
19468: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19469: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19470: if ($supphidden{$mapid}) {
19471: $is_hidden = 1;
19472: }
19473: }
1.1394 raeburn 19474: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19475: } else {
19476: $supppath .= '&'.$items[$i];
1.1393 raeburn 19477: }
19478: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19479: $badpath = 1;
1.1394 raeburn 19480: } elsif ($supplementalflag) {
1.1393 raeburn 19481: $supppath .= '&'.$items[$i];
19482: }
19483: last if ($badpath);
19484: }
19485: if ($badpath) {
19486: delete($env{'form.folderpath'});
1.1394 raeburn 19487: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19488: $supppath =~ s/^\&//;
19489: $env{'form.folderpath'} = $supppath;
19490: }
19491: }
19492: return;
19493: }
19494:
1.1094 raeburn 19495: sub captcha_display {
1.1327 raeburn 19496: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19497: my ($output,$error);
1.1234 raeburn 19498: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19499: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19500: if ($captcha eq 'original') {
1.1094 raeburn 19501: $output = &create_captcha();
19502: unless ($output) {
1.1172 raeburn 19503: $error = 'captcha';
1.1094 raeburn 19504: }
19505: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19506: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19507: unless ($output) {
1.1172 raeburn 19508: $error = 'recaptcha';
1.1094 raeburn 19509: }
19510: }
1.1234 raeburn 19511: return ($output,$error,$captcha,$version);
1.1094 raeburn 19512: }
19513:
19514: sub captcha_response {
1.1327 raeburn 19515: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19516: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19517: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19518: if ($captcha eq 'original') {
1.1094 raeburn 19519: ($captcha_chk,$captcha_error) = &check_captcha();
19520: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19521: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19522: } else {
19523: $captcha_chk = 1;
19524: }
19525: return ($captcha_chk,$captcha_error);
19526: }
19527:
19528: sub get_captcha_config {
1.1327 raeburn 19529: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19530: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19531: my $hostname = &Apache::lonnet::hostname($lonhost);
19532: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19533: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19534: if ($context eq 'usercreation') {
19535: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19536: if (ref($domconfig{$context}) eq 'HASH') {
19537: $hashtocheck = $domconfig{$context}{'cancreate'};
19538: if (ref($hashtocheck) eq 'HASH') {
19539: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19540: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19541: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19542: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19543: }
19544: if ($privkey && $pubkey) {
19545: $captcha = 'recaptcha';
1.1234 raeburn 19546: $version = $hashtocheck->{'recaptchaversion'};
19547: if ($version ne '2') {
19548: $version = 1;
19549: }
1.1095 raeburn 19550: } else {
19551: $captcha = 'original';
19552: }
19553: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19554: $captcha = 'original';
19555: }
1.1094 raeburn 19556: }
1.1095 raeburn 19557: } else {
19558: $captcha = 'captcha';
19559: }
19560: } elsif ($context eq 'login') {
19561: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19562: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19563: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19564: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19565: if ($privkey && $pubkey) {
19566: $captcha = 'recaptcha';
1.1234 raeburn 19567: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19568: if ($version ne '2') {
19569: $version = 1;
19570: }
1.1095 raeburn 19571: } else {
19572: $captcha = 'original';
1.1094 raeburn 19573: }
1.1095 raeburn 19574: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19575: $captcha = 'original';
1.1094 raeburn 19576: }
1.1327 raeburn 19577: } elsif ($context eq 'passwords') {
19578: if ($dom_in_effect) {
19579: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19580: if ($passwdconf{'captcha'} eq 'recaptcha') {
19581: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19582: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19583: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19584: }
19585: if ($privkey && $pubkey) {
19586: $captcha = 'recaptcha';
19587: $version = $passwdconf{'recaptchaversion'};
19588: if ($version ne '2') {
19589: $version = 1;
19590: }
19591: } else {
19592: $captcha = 'original';
19593: }
19594: } elsif ($passwdconf{'captcha'} ne 'notused') {
19595: $captcha = 'original';
19596: }
19597: }
19598: }
1.1234 raeburn 19599: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19600: }
19601:
19602: sub create_captcha {
19603: my %captcha_params = &captcha_settings();
19604: my ($output,$maxtries,$tries) = ('',10,0);
19605: while ($tries < $maxtries) {
19606: $tries ++;
19607: my $captcha = Authen::Captcha->new (
19608: output_folder => $captcha_params{'output_dir'},
19609: data_folder => $captcha_params{'db_dir'},
19610: );
19611: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19612:
19613: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19614: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19615: '<span class="LC_nobreak">'.
1.1453 raeburn 19616: '<label>'.&mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19617: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1453 raeburn 19618: '</label></span><br />'.
1.1176 raeburn 19619: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19620: last;
19621: }
19622: }
1.1323 raeburn 19623: if ($output eq '') {
19624: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19625: }
1.1094 raeburn 19626: return $output;
19627: }
19628:
19629: sub captcha_settings {
19630: my %captcha_params = (
19631: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19632: www_output_dir => "/captchaspool",
19633: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19634: numchars => '5',
19635: );
19636: return %captcha_params;
19637: }
19638:
19639: sub check_captcha {
19640: my ($captcha_chk,$captcha_error);
19641: my $code = $env{'form.code'};
19642: my $md5sum = $env{'form.crypt'};
19643: my %captcha_params = &captcha_settings();
19644: my $captcha = Authen::Captcha->new(
19645: output_folder => $captcha_params{'output_dir'},
19646: data_folder => $captcha_params{'db_dir'},
19647: );
1.1109 raeburn 19648: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19649: my %captcha_hash = (
19650: 0 => 'Code not checked (file error)',
19651: -1 => 'Failed: code expired',
19652: -2 => 'Failed: invalid code (not in database)',
19653: -3 => 'Failed: invalid code (code does not match crypt)',
19654: );
19655: if ($captcha_chk != 1) {
19656: $captcha_error = $captcha_hash{$captcha_chk}
19657: }
19658: return ($captcha_chk,$captcha_error);
19659: }
19660:
19661: sub create_recaptcha {
1.1234 raeburn 19662: my ($pubkey,$version) = @_;
19663: if ($version >= 2) {
1.1367 raeburn 19664: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19665: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19666: } else {
19667: my $use_ssl;
19668: if ($ENV{'SERVER_PORT'} == 443) {
19669: $use_ssl = 1;
19670: }
19671: my $captcha = Captcha::reCAPTCHA->new;
19672: return $captcha->get_options_setter({theme => 'white'})."\n".
19673: $captcha->get_html($pubkey,undef,$use_ssl).
19674: &mt('If the text is hard to read, [_1] will replace them.',
19675: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19676: '<br /><br />';
19677: }
1.1094 raeburn 19678: }
19679:
19680: sub check_recaptcha {
1.1234 raeburn 19681: my ($privkey,$version) = @_;
1.1094 raeburn 19682: my $captcha_chk;
1.1350 raeburn 19683: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19684: if ($version >= 2) {
19685: my %info = (
19686: secret => $privkey,
19687: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19688: remoteip => $ip,
1.1234 raeburn 19689: );
1.1280 raeburn 19690: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19691: $request->content(join('&',map {
19692: my $name = escape($_);
19693: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19694: ? join("&$name=", map {escape($_) } @{$info{$_}})
19695: : &escape($info{$_}) );
19696: } keys(%info)));
19697: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19698: if ($response->is_success) {
19699: my $data = JSON::DWIW->from_json($response->decoded_content);
19700: if (ref($data) eq 'HASH') {
19701: if ($data->{'success'}) {
19702: $captcha_chk = 1;
19703: }
19704: }
19705: }
19706: } else {
19707: my $captcha = Captcha::reCAPTCHA->new;
19708: my $captcha_result =
19709: $captcha->check_answer(
19710: $privkey,
1.1350 raeburn 19711: $ip,
1.1234 raeburn 19712: $env{'form.recaptcha_challenge_field'},
19713: $env{'form.recaptcha_response_field'},
19714: );
19715: if ($captcha_result->{is_valid}) {
19716: $captcha_chk = 1;
19717: }
1.1094 raeburn 19718: }
19719: return $captcha_chk;
19720: }
19721:
1.1174 raeburn 19722: sub emailusername_info {
1.1244 raeburn 19723: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19724: my %titles = &Apache::lonlocal::texthash (
19725: lastname => 'Last Name',
19726: firstname => 'First Name',
19727: institution => 'School/college/university',
19728: location => "School's city, state/province, country",
19729: web => "School's web address",
19730: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19731: id => 'Student/Employee ID',
1.1174 raeburn 19732: );
19733: return (\@fields,\%titles);
19734: }
19735:
1.1161 raeburn 19736: sub cleanup_html {
19737: my ($incoming) = @_;
19738: my $outgoing;
19739: if ($incoming ne '') {
19740: $outgoing = $incoming;
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: $outgoing =~ s/\\/\/g
19754: }
19755: return $outgoing;
19756: }
19757:
1.1190 musolffc 19758: # Checks for critical messages and returns a redirect url if one exists.
19759: # $interval indicates how often to check for messages.
1.1282 raeburn 19760: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19761: sub critical_redirect {
1.1282 raeburn 19762: my ($interval,$context) = @_;
1.1356 raeburn 19763: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19764: return ();
19765: }
1.1190 musolffc 19766: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19767: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19768: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19769: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19770: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19771: if ($blocked) {
19772: my $checkrole = "cm./$cdom/$cnum";
19773: if ($env{'request.course.sec'} ne '') {
19774: $checkrole .= "/$env{'request.course.sec'}";
19775: }
19776: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19777: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19778: return;
19779: }
19780: }
19781: }
1.1190 musolffc 19782: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19783: $env{'user.name'});
19784: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19785: my $redirecturl;
1.1190 musolffc 19786: if ($what[0]) {
1.1356 raeburn 19787: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19788: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19789: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19790: return (1, $url);
1.1190 musolffc 19791: }
1.1191 raeburn 19792: }
19793: }
19794: return ();
1.1190 musolffc 19795: }
19796:
1.1174 raeburn 19797: # Use:
19798: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19799: #
19800: ##################################################
19801: # password associated functions #
19802: ##################################################
19803: sub des_keys {
19804: # Make a new key for DES encryption.
19805: # Each key has two parts which are returned separately.
19806: # Please note: Each key must be passed through the &hex function
19807: # before it is output to the web browser. The hex versions cannot
19808: # be used to decrypt.
19809: my @hexstr=('0','1','2','3','4','5','6','7',
19810: '8','9','a','b','c','d','e','f');
19811: my $lkey='';
19812: for (0..7) {
19813: $lkey.=$hexstr[rand(15)];
19814: }
19815: my $ukey='';
19816: for (0..7) {
19817: $ukey.=$hexstr[rand(15)];
19818: }
19819: return ($lkey,$ukey);
19820: }
19821:
19822: sub des_decrypt {
19823: my ($key,$cyphertext) = @_;
19824: my $keybin=pack("H16",$key);
19825: my $cypher;
19826: if ($Crypt::DES::VERSION>=2.03) {
19827: $cypher=new Crypt::DES $keybin;
19828: } else {
19829: $cypher=new DES $keybin;
19830: }
1.1233 raeburn 19831: my $plaintext='';
19832: my $cypherlength = length($cyphertext);
19833: my $numchunks = int($cypherlength/32);
19834: for (my $j=0; $j<$numchunks; $j++) {
19835: my $start = $j*32;
19836: my $cypherblock = substr($cyphertext,$start,32);
19837: my $chunk =
19838: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19839: $chunk .=
19840: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19841: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19842: $plaintext .= $chunk;
19843: }
1.1174 raeburn 19844: return $plaintext;
19845: }
19846:
1.1344 raeburn 19847: sub get_requested_shorturls {
1.1309 raeburn 19848: my ($cdom,$cnum,$navmap) = @_;
19849: return unless (ref($navmap));
1.1344 raeburn 19850: my ($numnew,$errors);
1.1309 raeburn 19851: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19852: if (@toshorten) {
19853: my (%maps,%resources,%titles);
19854: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19855: 'shorturls',$cdom,$cnum);
19856: if (keys(%resources)) {
1.1344 raeburn 19857: my %tocreate;
1.1309 raeburn 19858: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19859: my $symb = $resources{$item};
19860: if ($symb) {
19861: $tocreate{$cnum.'&'.$symb} = 1;
19862: }
19863: }
1.1344 raeburn 19864: if (keys(%tocreate)) {
19865: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19866: \%tocreate);
19867: }
1.1309 raeburn 19868: }
1.1344 raeburn 19869: }
19870: return ($numnew,$errors);
19871: }
19872:
19873: sub make_short_symbs {
19874: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19875: my ($numnew,@errors);
19876: if (ref($tocreateref) eq 'HASH') {
19877: my %tocreate = %{$tocreateref};
1.1309 raeburn 19878: if (keys(%tocreate)) {
19879: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19880: my $su = Short::URL->new(no_vowels => 1);
19881: my $init = '';
19882: my (%newunique,%addcourse,%courseonly,%failed);
19883: # get lock on tiny db
19884: my $now = time;
1.1344 raeburn 19885: if ($lockuser eq '') {
19886: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19887: }
1.1309 raeburn 19888: my $lockhash = {
1.1344 raeburn 19889: "lock\0$now" => $lockuser,
1.1309 raeburn 19890: };
19891: my $tries = 0;
19892: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19893: my ($code,$error);
19894: while (($gotlock ne 'ok') && ($tries<3)) {
19895: $tries ++;
19896: sleep 1;
1.1319 raeburn 19897: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19898: }
19899: if ($gotlock eq 'ok') {
19900: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19901: \%addcourse,\%courseonly,\%failed);
19902: if (keys(%failed)) {
19903: my $numfailed = scalar(keys(%failed));
19904: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19905: }
19906: if (keys(%newunique)) {
19907: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19908: if ($putres eq 'ok') {
19909: $numnew = scalar(keys(%newunique));
19910: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19911: unless ($newputres eq 'ok') {
19912: push(@errors,&mt('error: could not store course look-up of short URLs'));
19913: }
19914: } else {
19915: push(@errors,&mt('error: could not store unique six character URLs'));
19916: }
19917: }
19918: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19919: unless ($dellockres eq 'ok') {
19920: push(@errors,&mt('error: could not release lockfile'));
19921: }
19922: } else {
19923: push(@errors,&mt('error: could not obtain lockfile'));
19924: }
19925: if (keys(%courseonly)) {
19926: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19927: if ($result ne 'ok') {
19928: push(@errors,&mt('error: could not update course look-up of short URLs'));
19929: }
19930: }
19931: }
19932: }
19933: return ($numnew,\@errors);
19934: }
19935:
19936: sub shorten_symbs {
19937: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19938: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19939: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19940: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19941: my (%possibles,%collisions);
19942: foreach my $key (keys(%{$tocreate})) {
19943: my $num = String::CRC32::crc32($key);
19944: my $tiny = $su->encode($num,$init);
19945: if ($tiny) {
19946: $possibles{$tiny} = $key;
19947: }
19948: }
19949: if (!$init) {
19950: $init = 1;
19951: } else {
19952: $init ++;
19953: }
19954: if (keys(%possibles)) {
19955: my @posstiny = keys(%possibles);
19956: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19957: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19958: if (keys(%currtiny)) {
19959: foreach my $key (keys(%currtiny)) {
19960: next if ($currtiny{$key} eq '');
19961: if ($currtiny{$key} eq $possibles{$key}) {
19962: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19963: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19964: $courseonly->{$tsymb} = $key;
19965: }
19966: } else {
19967: $collisions{$possibles{$key}} = 1;
19968: }
19969: delete($possibles{$key});
19970: }
19971: }
19972: foreach my $key (keys(%possibles)) {
19973: $newunique->{$key} = $possibles{$key};
19974: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19975: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19976: $addcourse->{$tsymb} = $key;
19977: }
19978: }
19979: }
19980: if (keys(%collisions)) {
19981: if ($init <5) {
19982: if (!$init) {
19983: $init = 1;
19984: } else {
19985: $init ++;
19986: }
19987: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19988: $newunique,$addcourse,$courseonly,$failed);
19989: } else {
19990: foreach my $key (keys(%collisions)) {
19991: $failed->{$key} = 1;
19992: }
19993: }
19994: }
19995: return $init;
19996: }
19997:
1.1328 raeburn 19998: sub is_nonframeable {
1.1329 raeburn 19999: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
20000: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 20001: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 20002:
20003: $remprotocol = lc($remprotocol);
20004: $remhost = lc($remhost);
20005: my $remport = 80;
20006: if ($remprotocol eq 'https') {
20007: $remport = 443;
20008: }
1.1330 raeburn 20009: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 20010: if ($cached) {
20011: unless ($nocache) {
20012: if ($result) {
20013: return 1;
20014: } else {
20015: return 0;
20016: }
20017: }
20018: }
1.1328 raeburn 20019: my $uselink;
20020: my $request = new HTTP::Request('HEAD',$url);
20021: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
20022: if ($response->is_success()) {
20023: my $secpolicy = lc($response->header('content-security-policy'));
20024: my $xframeop = lc($response->header('x-frame-options'));
20025: $secpolicy =~ s/^\s+|\s+$//g;
20026: $xframeop =~ s/^\s+|\s+$//g;
20027: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 20028: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 20029: my ($origin,$protocol,$port);
20030: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
20031: $port = $ENV{'SERVER_PORT'};
20032: } else {
20033: $port = 80;
20034: }
20035: if ($absolute eq '') {
20036: $protocol = 'http:';
20037: if ($port == 443) {
20038: $protocol = 'https:';
20039: }
20040: $origin = $protocol.'//'.lc($hostname);
20041: } else {
20042: $origin = lc($absolute);
20043: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
20044: }
20045: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
20046: my $framepolicy = $1;
20047: $framepolicy =~ s/^\s+|\s+$//g;
20048: my @policies = split(/\s+/,$framepolicy);
20049: if (@policies) {
20050: if (grep(/^\Q'none'\E$/,@policies)) {
20051: $uselink = 1;
20052: } else {
20053: $uselink = 1;
20054: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20055: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20056: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20057: undef($uselink);
20058: }
20059: if ($uselink) {
20060: if (grep(/^\Q'self'\E$/,@policies)) {
20061: if (($origin ne '') && ($remotehost eq $origin)) {
20062: undef($uselink);
20063: }
20064: }
20065: }
20066: if ($uselink) {
20067: my @possok;
20068: if ($ip ne '') {
20069: push(@possok,$ip);
20070: }
20071: my $hoststr = '';
20072: foreach my $part (reverse(split(/\./,$hostname))) {
20073: if ($hoststr eq '') {
20074: $hoststr = $part;
20075: } else {
20076: $hoststr = "$part.$hoststr";
20077: }
20078: if ($hoststr eq $hostname) {
20079: push(@possok,$hostname);
20080: } else {
20081: push(@possok,"*.$hoststr");
20082: }
20083: }
20084: if (@possok) {
20085: foreach my $poss (@possok) {
20086: last if (!$uselink);
20087: foreach my $policy (@policies) {
20088: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20089: undef($uselink);
20090: last;
20091: }
20092: }
20093: }
20094: }
20095: }
20096: }
20097: }
20098: } elsif ($xframeop ne '') {
20099: $uselink = 1;
20100: my @policies = split(/\s*,\s*/,$xframeop);
20101: if (@policies) {
20102: unless (grep(/^deny$/,@policies)) {
20103: if ($origin ne '') {
20104: if (grep(/^sameorigin$/,@policies)) {
20105: if ($remotehost eq $origin) {
20106: undef($uselink);
20107: }
20108: }
20109: if ($uselink) {
20110: foreach my $policy (@policies) {
20111: if ($policy =~ /^allow-from\s*(.+)$/) {
20112: my $allowfrom = $1;
20113: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20114: undef($uselink);
20115: last;
20116: }
20117: }
20118: }
20119: }
20120: }
20121: }
20122: }
20123: }
20124: }
20125: }
1.1329 raeburn 20126: if ($nocache) {
20127: if ($cached) {
20128: my $devalidate;
20129: if ($uselink && !$result) {
20130: $devalidate = 1;
20131: } elsif (!$uselink && $result) {
20132: $devalidate = 1;
20133: }
20134: if ($devalidate) {
20135: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20136: }
20137: }
20138: } else {
20139: if ($uselink) {
20140: $result = 1;
20141: } else {
20142: $result = 0;
20143: }
20144: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20145: }
1.1328 raeburn 20146: return $uselink;
20147: }
20148:
1.1359 raeburn 20149: sub page_menu {
20150: my ($menucolls,$menunum) = @_;
20151: my %menu;
20152: foreach my $item (split(/;/,$menucolls)) {
20153: my ($num,$value) = split(/\%/,$item);
20154: if ($num eq $menunum) {
20155: my @entries = split(/\&/,$value);
20156: foreach my $entry (@entries) {
20157: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20158: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20159: $menu{$name} = $fields;
20160: } else {
20161: my @shown;
20162: if ($fields =~ /,/) {
20163: @shown = split(/,/,$fields);
20164: } else {
20165: @shown = ($fields);
20166: }
20167: if (@shown) {
20168: foreach my $field (@shown) {
20169: next if ($field eq '');
20170: $menu{$field} = 1;
20171: }
20172: }
20173: }
20174: }
20175: }
20176: }
20177: return %menu;
20178: }
20179:
1.112 bowersj2 20180: 1;
20181: __END__;
1.41 ng 20182:
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