Annotation of loncom/interface/loncommon.pm, revision 1.1456
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1456 ! raeburn 4: # $Id: loncommon.pm,v 1.1455 2025/02/17 18:30:42 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.1456 ! raeburn 7054: $bodytag .= qq|<div id="LC_nav_bar" role="navigation" aria-label="$labeltext">$left $role</div>|;
1.1454 raeburn 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: }
7338:
1.1421 raeburn 7339: .LC_menus_content.shown{
1.1428 raeburn 7340: display: block;
1.1421 raeburn 7341: }
7342:
7343: .LC_menus_content.hidden {
7344: display: none;
7345: }
7346:
1.795 www 7347: .LC_right {
1.911 bisitz 7348: text-align:right;
1.795 www 7349: }
7350:
1.1449 raeburn 7351: .LC_center {
7352: text-align:center;
7353: }
7354:
1.795 www 7355: .LC_middle {
1.911 bisitz 7356: vertical-align:middle;
1.795 www 7357: }
1.721 harmsja 7358:
1.1130 raeburn 7359: .LC_floatleft {
7360: float: left;
7361: }
7362:
7363: .LC_floatright {
7364: float: right;
7365: }
7366:
1.911 bisitz 7367: .LC_400Box {
7368: width:400px;
7369: }
1.721 harmsja 7370:
1.1421 raeburn 7371: #LC_collapsible_separator {
7372: border: 1px solid black;
7373: width: 99.9%;
7374: height: 0px;
7375: }
7376:
1.947 droeschl 7377: .LC_iframecontainer {
7378: width: 98%;
7379: margin: 0;
7380: position: fixed;
7381: top: 8.5em;
7382: bottom: 0;
7383: }
7384:
7385: .LC_iframecontainer iframe{
7386: border: none;
7387: width: 100%;
7388: height: 100%;
7389: }
7390:
1.778 bisitz 7391: .LC_filename {
7392: font-family: $mono;
7393: white-space:pre;
1.921 bisitz 7394: font-size: 120%;
1.778 bisitz 7395: }
7396:
7397: .LC_fileicon {
7398: border: none;
7399: height: 1.3em;
7400: vertical-align: text-bottom;
7401: margin-right: 0.3em;
7402: text-decoration:none;
7403: }
7404:
1.1008 www 7405: .LC_setting {
7406: text-decoration:underline;
7407: }
7408:
1.350 albertel 7409: .LC_error {
7410: color: red;
7411: }
1.795 www 7412:
1.1097 bisitz 7413: .LC_warning {
7414: color: darkorange;
7415: }
7416:
1.457 albertel 7417: .LC_diff_removed {
1.733 bisitz 7418: color: red;
1.394 albertel 7419: }
1.532 albertel 7420:
7421: .LC_info,
1.457 albertel 7422: .LC_success,
7423: .LC_diff_added {
1.350 albertel 7424: color: green;
7425: }
1.795 www 7426:
1.802 bisitz 7427: div.LC_confirm_box {
7428: background-color: #FAFAFA;
7429: border: 1px solid $lg_border_color;
7430: margin-right: 0;
7431: padding: 5px;
7432: }
7433:
7434: div.LC_confirm_box .LC_error img,
7435: div.LC_confirm_box .LC_success img {
7436: vertical-align: middle;
7437: }
7438:
1.1242 raeburn 7439: .LC_maxwidth {
7440: max-width: 100%;
7441: height: auto;
7442: }
7443:
1.1243 raeburn 7444: .LC_textsize_mobile {
7445: \@media only screen and (max-device-width: 480px) {
7446: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7447: }
7448: }
7449:
1.440 albertel 7450: .LC_icon {
1.771 droeschl 7451: border: none;
1.790 droeschl 7452: vertical-align: middle;
1.771 droeschl 7453: }
7454:
1.543 albertel 7455: .LC_docs_spacer {
7456: width: 25px;
7457: height: 1px;
1.771 droeschl 7458: border: none;
1.543 albertel 7459: }
1.346 albertel 7460:
1.532 albertel 7461: .LC_internal_info {
1.735 bisitz 7462: color: #999999;
1.532 albertel 7463: }
7464:
1.794 www 7465: .LC_discussion {
1.1050 www 7466: background: $data_table_dark;
1.911 bisitz 7467: border: 1px solid black;
7468: margin: 2px;
1.794 www 7469: }
7470:
7471: .LC_disc_action_left {
1.1050 www 7472: background: $sidebg;
1.911 bisitz 7473: text-align: left;
1.1050 www 7474: padding: 4px;
7475: margin: 2px;
1.794 www 7476: }
7477:
7478: .LC_disc_action_right {
1.1050 www 7479: background: $sidebg;
1.911 bisitz 7480: text-align: right;
1.1050 www 7481: padding: 4px;
7482: margin: 2px;
1.794 www 7483: }
7484:
7485: .LC_disc_new_item {
1.911 bisitz 7486: background: white;
7487: border: 2px solid red;
1.1050 www 7488: margin: 4px;
7489: padding: 4px;
1.794 www 7490: }
7491:
7492: .LC_disc_old_item {
1.911 bisitz 7493: background: white;
1.1050 www 7494: margin: 4px;
7495: padding: 4px;
1.794 www 7496: }
7497:
1.458 albertel 7498: table.LC_pastsubmission {
7499: border: 1px solid black;
7500: margin: 2px;
7501: }
7502:
1.924 bisitz 7503: table#LC_menubuttons {
1.345 albertel 7504: width: 100%;
7505: background: $pgbg;
1.392 albertel 7506: border: 2px;
1.402 albertel 7507: border-collapse: separate;
1.803 bisitz 7508: padding: 0;
1.345 albertel 7509: }
1.392 albertel 7510:
1.801 tempelho 7511: table#LC_title_bar a {
7512: color: $fontmenu;
7513: }
1.836 bisitz 7514:
1.807 droeschl 7515: table#LC_title_bar {
1.819 tempelho 7516: clear: both;
1.836 bisitz 7517: display: none;
1.807 droeschl 7518: }
7519:
1.795 www 7520: table#LC_title_bar,
1.933 droeschl 7521: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7522: table#LC_title_bar.LC_with_remote {
1.359 albertel 7523: width: 100%;
1.392 albertel 7524: border-color: $pgbg;
7525: border-style: solid;
7526: border-width: $border;
1.379 albertel 7527: background: $pgbg;
1.801 tempelho 7528: color: $fontmenu;
1.392 albertel 7529: border-collapse: collapse;
1.803 bisitz 7530: padding: 0;
1.819 tempelho 7531: margin: 0;
1.359 albertel 7532: }
1.795 www 7533:
1.933 droeschl 7534: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7535: margin: 0;
7536: padding: 0;
1.933 droeschl 7537: position: relative;
7538: list-style: none;
1.913 droeschl 7539: }
1.933 droeschl 7540: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7541: display: inline;
7542: }
1.933 droeschl 7543:
7544: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7545: padding: 0;
1.933 droeschl 7546: margin: 0;
7547: float: left;
1.913 droeschl 7548: }
1.933 droeschl 7549: .LC_breadcrumb_tools_tools {
7550: padding: 0;
7551: margin: 0;
1.913 droeschl 7552: float: right;
7553: }
7554:
1.1240 raeburn 7555: .LC_placement_prog {
7556: padding-right: 20px;
7557: font-weight: bold;
7558: font-size: 90%;
7559: }
7560:
1.359 albertel 7561: table#LC_title_bar td {
7562: background: $tabbg;
7563: }
1.795 www 7564:
1.911 bisitz 7565: table#LC_menubuttons img {
1.803 bisitz 7566: border: none;
1.346 albertel 7567: }
1.795 www 7568:
1.842 droeschl 7569: .LC_breadcrumbs_component {
1.911 bisitz 7570: float: right;
7571: margin: 0 1em;
1.357 albertel 7572: }
1.842 droeschl 7573: .LC_breadcrumbs_component img {
1.911 bisitz 7574: vertical-align: middle;
1.777 tempelho 7575: }
1.795 www 7576:
1.1243 raeburn 7577: .LC_breadcrumbs_hoverable {
7578: background: $sidebg;
7579: }
7580:
1.383 albertel 7581: td.LC_table_cell_checkbox {
7582: text-align: center;
7583: }
1.795 www 7584:
7585: .LC_fontsize_small {
1.911 bisitz 7586: font-size: 70%;
1.705 tempelho 7587: }
7588:
1.844 bisitz 7589: #LC_breadcrumbs {
1.911 bisitz 7590: clear:both;
7591: background: $sidebg;
7592: border-bottom: 1px solid $lg_border_color;
7593: line-height: 2.5em;
1.933 droeschl 7594: overflow: hidden;
1.911 bisitz 7595: margin: 0;
7596: padding: 0;
1.995 raeburn 7597: text-align: left;
1.819 tempelho 7598: }
1.862 bisitz 7599:
1.1098 bisitz 7600: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7601: clear:both;
7602: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7603: border: 1px solid $sidebg;
1.1098 bisitz 7604: margin: 0 0 10px 0;
1.966 bisitz 7605: padding: 3px;
1.995 raeburn 7606: text-align: left;
1.822 bisitz 7607: }
7608:
1.795 www 7609: .LC_fontsize_medium {
1.911 bisitz 7610: font-size: 85%;
1.705 tempelho 7611: }
7612:
1.795 www 7613: .LC_fontsize_large {
1.911 bisitz 7614: font-size: 120%;
1.705 tempelho 7615: }
7616:
1.346 albertel 7617: .LC_menubuttons_inline_text {
7618: color: $font;
1.698 harmsja 7619: font-size: 90%;
1.701 harmsja 7620: padding-left:3px;
1.346 albertel 7621: }
7622:
1.934 droeschl 7623: .LC_menubuttons_inline_text img{
7624: vertical-align: middle;
7625: }
7626:
1.1051 www 7627: li.LC_menubuttons_inline_text img {
1.951 onken 7628: cursor:pointer;
1.1002 droeschl 7629: text-decoration: none;
1.951 onken 7630: }
7631:
1.526 www 7632: .LC_menubuttons_link {
7633: text-decoration: none;
7634: }
1.795 www 7635:
1.522 albertel 7636: .LC_menubuttons_category {
1.521 www 7637: color: $font;
1.526 www 7638: background: $pgbg;
1.521 www 7639: font-size: larger;
7640: font-weight: bold;
7641: }
7642:
1.346 albertel 7643: td.LC_menubuttons_text {
1.911 bisitz 7644: color: $font;
1.346 albertel 7645: }
1.706 harmsja 7646:
1.346 albertel 7647: .LC_current_location {
7648: background: $tabbg;
7649: }
1.795 www 7650:
1.1286 raeburn 7651: td.LC_zero_height {
7652: line-height: 0;
7653: cellpadding: 0;
7654: }
7655:
1.938 bisitz 7656: table.LC_data_table {
1.347 albertel 7657: border: 1px solid #000000;
1.402 albertel 7658: border-collapse: separate;
1.426 albertel 7659: border-spacing: 1px;
1.610 albertel 7660: background: $pgbg;
1.347 albertel 7661: }
1.795 www 7662:
1.422 albertel 7663: .LC_data_table_dense {
7664: font-size: small;
7665: }
1.795 www 7666:
1.507 raeburn 7667: table.LC_nested_outer {
7668: border: 1px solid #000000;
1.589 raeburn 7669: border-collapse: collapse;
1.803 bisitz 7670: border-spacing: 0;
1.507 raeburn 7671: width: 100%;
7672: }
1.795 www 7673:
1.879 raeburn 7674: table.LC_innerpickbox,
1.507 raeburn 7675: table.LC_nested {
1.803 bisitz 7676: border: none;
1.589 raeburn 7677: border-collapse: collapse;
1.803 bisitz 7678: border-spacing: 0;
1.507 raeburn 7679: width: 100%;
7680: }
1.795 www 7681:
1.911 bisitz 7682: table.LC_data_table tr th,
7683: table.LC_calendar tr th,
1.879 raeburn 7684: table.LC_prior_tries tr th,
7685: table.LC_innerpickbox tr th {
1.349 albertel 7686: font-weight: bold;
7687: background-color: $data_table_head;
1.801 tempelho 7688: color:$fontmenu;
1.701 harmsja 7689: font-size:90%;
1.347 albertel 7690: }
1.795 www 7691:
1.879 raeburn 7692: table.LC_innerpickbox tr th,
7693: table.LC_innerpickbox tr td {
7694: vertical-align: top;
7695: }
7696:
1.711 raeburn 7697: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7698: background-color: #CCCCCC;
1.711 raeburn 7699: font-weight: bold;
7700: text-align: left;
7701: }
1.795 www 7702:
1.912 bisitz 7703: table.LC_data_table tr.LC_odd_row > td {
7704: background-color: $data_table_light;
7705: padding: 2px;
7706: vertical-align: top;
7707: }
7708:
1.809 bisitz 7709: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7710: background-color: $data_table_light;
1.912 bisitz 7711: vertical-align: top;
7712: }
7713:
7714: table.LC_data_table tr.LC_even_row > td {
7715: background-color: $data_table_dark;
1.425 albertel 7716: padding: 2px;
1.900 bisitz 7717: vertical-align: top;
1.347 albertel 7718: }
1.795 www 7719:
1.809 bisitz 7720: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7721: background-color: $data_table_dark;
1.900 bisitz 7722: vertical-align: top;
1.347 albertel 7723: }
1.795 www 7724:
1.425 albertel 7725: table.LC_data_table tr.LC_data_table_highlight td {
7726: background-color: $data_table_darker;
7727: }
1.795 www 7728:
1.639 raeburn 7729: table.LC_data_table tr td.LC_leftcol_header {
7730: background-color: $data_table_head;
7731: font-weight: bold;
7732: }
1.795 www 7733:
1.451 albertel 7734: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7735: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7736: font-weight: bold;
7737: font-style: italic;
7738: text-align: center;
7739: padding: 8px;
1.347 albertel 7740: }
1.795 www 7741:
1.1114 raeburn 7742: table.LC_data_table tr.LC_empty_row td,
7743: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7744: background-color: $sidebg;
7745: }
7746:
7747: table.LC_nested tr.LC_empty_row td {
7748: background-color: #FFFFFF;
7749: }
7750:
1.890 droeschl 7751: table.LC_caption {
7752: }
7753:
1.507 raeburn 7754: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7755: padding: 4ex
7756: }
1.795 www 7757:
1.507 raeburn 7758: table.LC_nested_outer tr th {
7759: font-weight: bold;
1.801 tempelho 7760: color:$fontmenu;
1.507 raeburn 7761: background-color: $data_table_head;
1.701 harmsja 7762: font-size: small;
1.507 raeburn 7763: border-bottom: 1px solid #000000;
7764: }
1.795 www 7765:
1.507 raeburn 7766: table.LC_nested_outer tr td.LC_subheader {
7767: background-color: $data_table_head;
7768: font-weight: bold;
7769: font-size: small;
7770: border-bottom: 1px solid #000000;
7771: text-align: right;
1.451 albertel 7772: }
1.795 www 7773:
1.507 raeburn 7774: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7775: background-color: #CCCCCC;
1.451 albertel 7776: font-weight: bold;
7777: font-size: small;
1.507 raeburn 7778: text-align: center;
7779: }
1.795 www 7780:
1.589 raeburn 7781: table.LC_nested tr.LC_info_row td.LC_left_item,
7782: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7783: text-align: left;
1.451 albertel 7784: }
1.795 www 7785:
1.507 raeburn 7786: table.LC_nested td {
1.735 bisitz 7787: background-color: #FFFFFF;
1.451 albertel 7788: font-size: small;
1.507 raeburn 7789: }
1.795 www 7790:
1.507 raeburn 7791: table.LC_nested_outer tr th.LC_right_item,
7792: table.LC_nested tr.LC_info_row td.LC_right_item,
7793: table.LC_nested tr.LC_odd_row td.LC_right_item,
7794: table.LC_nested tr td.LC_right_item {
1.451 albertel 7795: text-align: right;
7796: }
7797:
1.507 raeburn 7798: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7799: background-color: #EEEEEE;
1.451 albertel 7800: }
7801:
1.473 raeburn 7802: table.LC_createuser {
7803: }
7804:
7805: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7806: font-size: small;
1.473 raeburn 7807: }
7808:
7809: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7810: background-color: #CCCCCC;
1.473 raeburn 7811: font-weight: bold;
7812: text-align: center;
7813: }
7814:
1.349 albertel 7815: table.LC_calendar {
7816: border: 1px solid #000000;
7817: border-collapse: collapse;
1.917 raeburn 7818: width: 98%;
1.349 albertel 7819: }
1.795 www 7820:
1.349 albertel 7821: table.LC_calendar_pickdate {
7822: font-size: xx-small;
7823: }
1.795 www 7824:
1.349 albertel 7825: table.LC_calendar tr td {
7826: border: 1px solid #000000;
7827: vertical-align: top;
1.917 raeburn 7828: width: 14%;
1.349 albertel 7829: }
1.795 www 7830:
1.349 albertel 7831: table.LC_calendar tr td.LC_calendar_day_empty {
7832: background-color: $data_table_dark;
7833: }
1.795 www 7834:
1.779 bisitz 7835: table.LC_calendar tr td.LC_calendar_day_current {
7836: background-color: $data_table_highlight;
1.777 tempelho 7837: }
1.795 www 7838:
1.938 bisitz 7839: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7840: background-color: $mail_new;
7841: }
1.795 www 7842:
1.938 bisitz 7843: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7844: background-color: $mail_new_hover;
7845: }
1.795 www 7846:
1.938 bisitz 7847: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7848: background-color: $mail_read;
7849: }
1.795 www 7850:
1.938 bisitz 7851: /*
7852: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7853: background-color: $mail_read_hover;
7854: }
1.938 bisitz 7855: */
1.795 www 7856:
1.938 bisitz 7857: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7858: background-color: $mail_replied;
7859: }
1.795 www 7860:
1.938 bisitz 7861: /*
7862: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7863: background-color: $mail_replied_hover;
7864: }
1.938 bisitz 7865: */
1.795 www 7866:
1.938 bisitz 7867: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7868: background-color: $mail_other;
7869: }
1.795 www 7870:
1.938 bisitz 7871: /*
7872: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7873: background-color: $mail_other_hover;
7874: }
1.938 bisitz 7875: */
1.494 raeburn 7876:
1.777 tempelho 7877: table.LC_data_table tr > td.LC_browser_file,
7878: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7879: background: #AAEE77;
1.389 albertel 7880: }
1.795 www 7881:
1.777 tempelho 7882: table.LC_data_table tr > td.LC_browser_file_locked,
7883: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7884: background: #FFAA99;
1.387 albertel 7885: }
1.795 www 7886:
1.777 tempelho 7887: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7888: background: #888888;
1.779 bisitz 7889: }
1.795 www 7890:
1.777 tempelho 7891: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7892: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7893: background: #F8F866;
1.777 tempelho 7894: }
1.795 www 7895:
1.696 bisitz 7896: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7897: background: #E0E8FF;
1.387 albertel 7898: }
1.696 bisitz 7899:
1.707 bisitz 7900: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7901: /* background: #77FF77; */
1.707 bisitz 7902: }
1.795 www 7903:
1.707 bisitz 7904: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7905: border-right: 8px solid #FFFF77;
1.707 bisitz 7906: }
1.795 www 7907:
1.707 bisitz 7908: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7909: border-right: 8px solid #FFAA77;
1.707 bisitz 7910: }
1.795 www 7911:
1.707 bisitz 7912: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7913: border-right: 8px solid #FF7777;
1.707 bisitz 7914: }
1.795 www 7915:
1.707 bisitz 7916: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7917: border-right: 8px solid #AAFF77;
1.707 bisitz 7918: }
1.795 www 7919:
1.707 bisitz 7920: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7921: border-right: 8px solid #11CC55;
1.707 bisitz 7922: }
7923:
1.388 albertel 7924: span.LC_current_location {
1.701 harmsja 7925: font-size:larger;
1.388 albertel 7926: background: $pgbg;
7927: }
1.387 albertel 7928:
1.1029 www 7929: span.LC_current_nav_location {
7930: font-weight:bold;
7931: background: $sidebg;
7932: }
7933:
1.395 albertel 7934: span.LC_parm_menu_item {
7935: font-size: larger;
7936: }
1.795 www 7937:
1.395 albertel 7938: span.LC_parm_scope_all {
7939: color: red;
7940: }
1.795 www 7941:
1.395 albertel 7942: span.LC_parm_scope_folder {
7943: color: green;
7944: }
1.795 www 7945:
1.395 albertel 7946: span.LC_parm_scope_resource {
7947: color: orange;
7948: }
1.795 www 7949:
1.395 albertel 7950: span.LC_parm_part {
7951: color: blue;
7952: }
1.795 www 7953:
1.911 bisitz 7954: span.LC_parm_folder,
7955: span.LC_parm_symb {
1.395 albertel 7956: font-size: x-small;
7957: font-family: $mono;
7958: color: #AAAAAA;
7959: }
7960:
1.977 bisitz 7961: ul.LC_parm_parmlist li {
7962: display: inline-block;
7963: padding: 0.3em 0.8em;
7964: vertical-align: top;
7965: width: 150px;
7966: border-top:1px solid $lg_border_color;
7967: }
7968:
1.795 www 7969: td.LC_parm_overview_level_menu,
7970: td.LC_parm_overview_map_menu,
7971: td.LC_parm_overview_parm_selectors,
7972: td.LC_parm_overview_restrictions {
1.396 albertel 7973: border: 1px solid black;
7974: border-collapse: collapse;
7975: }
1.795 www 7976:
1.1285 raeburn 7977: span.LC_parm_recursive,
7978: td.LC_parm_recursive {
7979: font-weight: bold;
7980: font-size: smaller;
7981: }
7982:
1.396 albertel 7983: table.LC_parm_overview_restrictions td {
7984: border-width: 1px 4px 1px 4px;
7985: border-style: solid;
7986: border-color: $pgbg;
7987: text-align: center;
7988: }
1.795 www 7989:
1.396 albertel 7990: table.LC_parm_overview_restrictions th {
7991: background: $tabbg;
7992: border-width: 1px 4px 1px 4px;
7993: border-style: solid;
7994: border-color: $pgbg;
7995: }
1.795 www 7996:
1.398 albertel 7997: table#LC_helpmenu {
1.803 bisitz 7998: border: none;
1.398 albertel 7999: height: 55px;
1.803 bisitz 8000: border-spacing: 0;
1.398 albertel 8001: }
8002:
8003: table#LC_helpmenu fieldset legend {
8004: font-size: larger;
8005: }
1.795 www 8006:
1.1456 ! raeburn 8007: .LC_helpdesk_headbox {
! 8008: border: 2px groove threedface;
! 8009: padding: 1em;
! 8010: }
! 8011:
! 8012: h1.LC_helpdesk_legend {
! 8013: float: left;
! 8014: margin: -1.7em 0 0;
! 8015: padding: 0 .5em;
1.397 albertel 8016: background: $pgbg;
1.1456 ! raeburn 8017: font-size: 1em;
! 8018: font-weight: bold;
! 8019: }
! 8020:
! 8021: h1.LC_helpdesk_title {
! 8022: display: inline;
! 8023: font-size: 1em;
! 8024: line-height: 2.5em;
! 8025: margin: 0;
1.803 bisitz 8026: padding: 0;
1.1456 ! raeburn 8027: vertical-align: bottom;
1.397 albertel 8028: }
1.795 www 8029:
1.1456 ! raeburn 8030: .LC_helpdesk_links {
! 8031: border: 1px solid black;
! 8032: padding: 3px;
1.397 albertel 8033: background: $tabbg;
1.399 albertel 8034: text-align: center;
8035: font-weight: bold;
1.1456 ! raeburn 8036: display: inline;
! 8037: margin-right: -6px;
! 8038: }
! 8039:
! 8040: .LC_helpdesk_img,
! 8041: .LC_helpdesk_text {
! 8042: padding: 0;
! 8043: margin: 0;
! 8044: border: 0;
! 8045: display: inline;
1.397 albertel 8046: }
1.396 albertel 8047:
1.1456 ! raeburn 8048: .LC_helpdesk_img a:link,
! 8049: .LC_helpdesk_img a:visited,
! 8050: .LC_helpdesk_img a:active,
! 8051: .LC_helpdesk_text a:link,
! 8052: .LC_helpdesk_text a:visited,
! 8053: .LC_helpdesk_text a:active {
1.397 albertel 8054: text-decoration: none;
8055: color: $font;
8056: }
1.795 www 8057:
1.1456 ! raeburn 8058: div.LC_helpdesk_text a:hover {
1.397 albertel 8059: text-decoration: underline;
8060: color: $vlink;
8061: }
1.396 albertel 8062:
1.417 albertel 8063: .LC_chrt_popup_exists {
8064: border: 1px solid #339933;
8065: margin: -1px;
8066: }
1.795 www 8067:
1.417 albertel 8068: .LC_chrt_popup_up {
8069: border: 1px solid yellow;
8070: margin: -1px;
8071: }
1.795 www 8072:
1.417 albertel 8073: .LC_chrt_popup {
8074: border: 1px solid #8888FF;
8075: background: #CCCCFF;
8076: }
1.795 www 8077:
1.421 albertel 8078: table.LC_pick_box {
8079: border-collapse: separate;
8080: background: white;
8081: border: 1px solid black;
8082: border-spacing: 1px;
8083: }
1.795 www 8084:
1.1454 raeburn 8085: table.LC_pick_box th.LC_pick_box_title {
1.850 bisitz 8086: background: $sidebg;
1.421 albertel 8087: font-weight: bold;
1.900 bisitz 8088: text-align: left;
1.740 bisitz 8089: vertical-align: top;
1.421 albertel 8090: width: 184px;
8091: padding: 8px;
8092: }
1.795 www 8093:
1.579 raeburn 8094: table.LC_pick_box td.LC_pick_box_value {
8095: text-align: left;
8096: padding: 8px;
8097: }
1.795 www 8098:
1.579 raeburn 8099: table.LC_pick_box td.LC_pick_box_select {
8100: text-align: left;
8101: padding: 8px;
8102: }
1.795 www 8103:
1.424 albertel 8104: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8105: padding: 0;
1.421 albertel 8106: height: 1px;
8107: background: black;
8108: }
1.795 www 8109:
1.421 albertel 8110: table.LC_pick_box td.LC_pick_box_submit {
8111: text-align: right;
8112: }
1.795 www 8113:
1.579 raeburn 8114: table.LC_pick_box td.LC_evenrow_value {
8115: text-align: left;
8116: padding: 8px;
8117: background-color: $data_table_light;
8118: }
1.795 www 8119:
1.579 raeburn 8120: table.LC_pick_box td.LC_oddrow_value {
8121: text-align: left;
8122: padding: 8px;
8123: background-color: $data_table_light;
8124: }
1.795 www 8125:
1.579 raeburn 8126: span.LC_helpform_receipt_cat {
8127: font-weight: bold;
8128: }
1.795 www 8129:
1.424 albertel 8130: table.LC_group_priv_box {
8131: background: white;
8132: border: 1px solid black;
8133: border-spacing: 1px;
8134: }
1.795 www 8135:
1.424 albertel 8136: table.LC_group_priv_box td.LC_pick_box_title {
8137: background: $tabbg;
8138: font-weight: bold;
8139: text-align: right;
8140: width: 184px;
8141: }
1.795 www 8142:
1.424 albertel 8143: table.LC_group_priv_box td.LC_groups_fixed {
8144: background: $data_table_light;
8145: text-align: center;
8146: }
1.795 www 8147:
1.424 albertel 8148: table.LC_group_priv_box td.LC_groups_optional {
8149: background: $data_table_dark;
8150: text-align: center;
8151: }
1.795 www 8152:
1.424 albertel 8153: table.LC_group_priv_box td.LC_groups_functionality {
8154: background: $data_table_darker;
8155: text-align: center;
8156: font-weight: bold;
8157: }
1.795 www 8158:
1.424 albertel 8159: table.LC_group_priv td {
8160: text-align: left;
1.803 bisitz 8161: padding: 0;
1.424 albertel 8162: }
8163:
8164: .LC_navbuttons {
8165: margin: 2ex 0ex 2ex 0ex;
8166: }
1.795 www 8167:
1.423 albertel 8168: .LC_topic_bar {
8169: font-weight: bold;
8170: background: $tabbg;
1.918 wenzelju 8171: margin: 1em 0em 1em 2em;
1.805 bisitz 8172: padding: 3px;
1.918 wenzelju 8173: font-size: 1.2em;
1.423 albertel 8174: }
1.795 www 8175:
1.423 albertel 8176: .LC_topic_bar span {
1.918 wenzelju 8177: left: 0.5em;
8178: position: absolute;
1.423 albertel 8179: vertical-align: middle;
1.918 wenzelju 8180: font-size: 1.2em;
1.423 albertel 8181: }
1.795 www 8182:
1.423 albertel 8183: table.LC_course_group_status {
8184: margin: 20px;
8185: }
1.795 www 8186:
1.423 albertel 8187: table.LC_status_selector td {
8188: vertical-align: top;
8189: text-align: center;
1.424 albertel 8190: padding: 4px;
8191: }
1.795 www 8192:
1.599 albertel 8193: div.LC_feedback_link {
1.616 albertel 8194: clear: both;
1.829 kalberla 8195: background: $sidebg;
1.779 bisitz 8196: width: 100%;
1.829 kalberla 8197: padding-bottom: 10px;
8198: border: 1px $tabbg solid;
1.833 kalberla 8199: height: 22px;
8200: line-height: 22px;
8201: padding-top: 5px;
8202: }
8203:
8204: div.LC_feedback_link img {
8205: height: 22px;
1.867 kalberla 8206: vertical-align:middle;
1.829 kalberla 8207: }
8208:
1.911 bisitz 8209: div.LC_feedback_link a {
1.829 kalberla 8210: text-decoration: none;
1.489 raeburn 8211: }
1.795 www 8212:
1.867 kalberla 8213: div.LC_comblock {
1.911 bisitz 8214: display:inline;
1.867 kalberla 8215: color:$font;
8216: font-size:90%;
8217: }
8218:
8219: div.LC_feedback_link div.LC_comblock {
8220: padding-left:5px;
8221: }
8222:
8223: div.LC_feedback_link div.LC_comblock a {
8224: color:$font;
8225: }
8226:
1.489 raeburn 8227: span.LC_feedback_link {
1.858 bisitz 8228: /* background: $feedback_link_bg; */
1.599 albertel 8229: font-size: larger;
8230: }
1.795 www 8231:
1.599 albertel 8232: span.LC_message_link {
1.858 bisitz 8233: /* background: $feedback_link_bg; */
1.599 albertel 8234: font-size: larger;
8235: position: absolute;
8236: right: 1em;
1.489 raeburn 8237: }
1.421 albertel 8238:
1.515 albertel 8239: table.LC_prior_tries {
1.524 albertel 8240: border: 1px solid #000000;
8241: border-collapse: separate;
8242: border-spacing: 1px;
1.515 albertel 8243: }
1.523 albertel 8244:
1.515 albertel 8245: table.LC_prior_tries td {
1.524 albertel 8246: padding: 2px;
1.515 albertel 8247: }
1.523 albertel 8248:
8249: .LC_answer_correct {
1.795 www 8250: background: lightgreen;
8251: color: darkgreen;
8252: padding: 6px;
1.523 albertel 8253: }
1.795 www 8254:
1.523 albertel 8255: .LC_answer_charged_try {
1.797 www 8256: background: #FFAAAA;
1.795 www 8257: color: darkred;
8258: padding: 6px;
1.523 albertel 8259: }
1.795 www 8260:
1.779 bisitz 8261: .LC_answer_not_charged_try,
1.523 albertel 8262: .LC_answer_no_grade,
8263: .LC_answer_late {
1.795 www 8264: background: lightyellow;
1.523 albertel 8265: color: black;
1.795 www 8266: padding: 6px;
1.523 albertel 8267: }
1.795 www 8268:
1.523 albertel 8269: .LC_answer_previous {
1.795 www 8270: background: lightblue;
8271: color: darkblue;
8272: padding: 6px;
1.523 albertel 8273: }
1.795 www 8274:
1.779 bisitz 8275: .LC_answer_no_message {
1.777 tempelho 8276: background: #FFFFFF;
8277: color: black;
1.795 www 8278: padding: 6px;
1.779 bisitz 8279: }
1.795 www 8280:
1.1334 raeburn 8281: .LC_answer_unknown,
8282: .LC_answer_warning {
1.779 bisitz 8283: background: orange;
8284: color: black;
1.795 www 8285: padding: 6px;
1.777 tempelho 8286: }
1.795 www 8287:
1.1446 raeburn 8288: .LC_prob_status {
1.1447 raeburn 8289: margin-top: 5px;
1.1446 raeburn 8290: padding-top: 0;
8291: padding-left: 0;
8292: padding-bottom: 0;
8293: padding-right: 5px;
8294: }
8295:
1.1448 raeburn 8296: .LC_mail_actions {
8297: float: left;
8298: padding: 0;
8299: margin: 6px;
8300: }
8301:
8302: .LC_vertical_line {
8303: width: 1px;
8304: background-color: black;
8305: height: 4em;
8306: float: left;
8307: margin: 0;
8308: padding: 0;
8309: }
8310:
1.529 albertel 8311: span.LC_prior_numerical,
8312: span.LC_prior_string,
8313: span.LC_prior_custom,
8314: span.LC_prior_reaction,
8315: span.LC_prior_math {
1.925 bisitz 8316: font-family: $mono;
1.523 albertel 8317: white-space: pre;
8318: }
8319:
1.525 albertel 8320: span.LC_prior_string {
1.925 bisitz 8321: font-family: $mono;
1.525 albertel 8322: white-space: pre;
8323: }
8324:
1.523 albertel 8325: table.LC_prior_option {
8326: width: 100%;
8327: border-collapse: collapse;
8328: }
1.795 www 8329:
1.911 bisitz 8330: table.LC_prior_rank,
1.795 www 8331: table.LC_prior_match {
1.528 albertel 8332: border-collapse: collapse;
8333: }
1.795 www 8334:
1.528 albertel 8335: table.LC_prior_option tr td,
8336: table.LC_prior_rank tr td,
8337: table.LC_prior_match tr td {
1.524 albertel 8338: border: 1px solid #000000;
1.515 albertel 8339: }
8340:
1.855 bisitz 8341: .LC_nobreak {
1.544 albertel 8342: white-space: nowrap;
1.519 raeburn 8343: }
8344:
1.576 raeburn 8345: span.LC_cusr_emph {
8346: font-style: italic;
8347: }
8348:
1.633 raeburn 8349: span.LC_cusr_subheading {
8350: font-weight: normal;
8351: font-size: 85%;
8352: }
8353:
1.861 bisitz 8354: div.LC_docs_entry_move {
1.859 bisitz 8355: border: 1px solid #BBBBBB;
1.545 albertel 8356: background: #DDDDDD;
1.861 bisitz 8357: width: 22px;
1.859 bisitz 8358: padding: 1px;
8359: margin: 0;
1.545 albertel 8360: }
8361:
1.861 bisitz 8362: table.LC_data_table tr > td.LC_docs_entry_commands,
8363: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8364: font-size: x-small;
8365: }
1.795 www 8366:
1.861 bisitz 8367: .LC_docs_entry_parameter {
8368: white-space: nowrap;
8369: }
8370:
1.544 albertel 8371: .LC_docs_copy {
1.545 albertel 8372: color: #000099;
1.544 albertel 8373: }
1.795 www 8374:
1.544 albertel 8375: .LC_docs_cut {
1.545 albertel 8376: color: #550044;
1.544 albertel 8377: }
1.795 www 8378:
1.544 albertel 8379: .LC_docs_rename {
1.545 albertel 8380: color: #009900;
1.544 albertel 8381: }
1.795 www 8382:
1.544 albertel 8383: .LC_docs_remove {
1.545 albertel 8384: color: #990000;
8385: }
8386:
1.1284 raeburn 8387: .LC_docs_alias {
8388: color: #440055;
8389: }
8390:
1.1286 raeburn 8391: .LC_domprefs_email,
1.1284 raeburn 8392: .LC_docs_alias_name,
1.547 albertel 8393: .LC_docs_reinit_warn,
8394: .LC_docs_ext_edit {
8395: font-size: x-small;
8396: }
8397:
1.545 albertel 8398: table.LC_docs_adddocs td,
8399: table.LC_docs_adddocs th {
8400: border: 1px solid #BBBBBB;
8401: padding: 4px;
8402: background: #DDDDDD;
1.543 albertel 8403: }
8404:
1.584 albertel 8405: table.LC_sty_begin {
8406: background: #BBFFBB;
8407: }
1.795 www 8408:
1.584 albertel 8409: table.LC_sty_end {
8410: background: #FFBBBB;
8411: }
8412:
1.589 raeburn 8413: table.LC_double_column {
1.803 bisitz 8414: border-width: 0;
1.589 raeburn 8415: border-collapse: collapse;
8416: width: 100%;
8417: padding: 2px;
8418: }
8419:
8420: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8421: top: 2px;
1.589 raeburn 8422: left: 2px;
8423: width: 47%;
8424: vertical-align: top;
8425: }
8426:
8427: table.LC_double_column tr td.LC_right_col {
8428: top: 2px;
1.779 bisitz 8429: right: 2px;
1.589 raeburn 8430: width: 47%;
8431: vertical-align: top;
8432: }
8433:
1.591 raeburn 8434: div.LC_left_float {
8435: float: left;
8436: padding-right: 5%;
1.597 albertel 8437: padding-bottom: 4px;
1.591 raeburn 8438: }
8439:
8440: div.LC_clear_float_header {
1.597 albertel 8441: padding-bottom: 2px;
1.591 raeburn 8442: }
8443:
8444: div.LC_clear_float_footer {
1.597 albertel 8445: padding-top: 10px;
1.591 raeburn 8446: clear: both;
8447: }
8448:
1.597 albertel 8449: div.LC_grade_show_user {
1.941 bisitz 8450: /* border-left: 5px solid $sidebg; */
8451: border-top: 5px solid #000000;
8452: margin: 50px 0 0 0;
1.936 bisitz 8453: padding: 15px 0 5px 10px;
1.597 albertel 8454: }
1.795 www 8455:
1.936 bisitz 8456: div.LC_grade_show_user_odd_row {
1.941 bisitz 8457: /* border-left: 5px solid #000000; */
8458: }
8459:
8460: div.LC_grade_show_user div.LC_Box {
8461: margin-right: 50px;
1.597 albertel 8462: }
8463:
8464: div.LC_grade_submissions,
8465: div.LC_grade_message_center,
1.936 bisitz 8466: div.LC_grade_info_links {
1.597 albertel 8467: margin: 5px;
8468: width: 99%;
8469: background: #FFFFFF;
8470: }
1.795 www 8471:
1.597 albertel 8472: div.LC_grade_submissions_header,
1.936 bisitz 8473: div.LC_grade_message_center_header {
1.705 tempelho 8474: font-weight: bold;
8475: font-size: large;
1.597 albertel 8476: }
1.795 www 8477:
1.597 albertel 8478: div.LC_grade_submissions_body,
1.936 bisitz 8479: div.LC_grade_message_center_body {
1.597 albertel 8480: border: 1px solid black;
8481: width: 99%;
8482: background: #FFFFFF;
8483: }
1.795 www 8484:
1.613 albertel 8485: table.LC_scantron_action {
8486: width: 100%;
8487: }
1.795 www 8488:
1.613 albertel 8489: table.LC_scantron_action tr th {
1.698 harmsja 8490: font-weight:bold;
8491: font-style:normal;
1.613 albertel 8492: }
1.795 www 8493:
1.779 bisitz 8494: .LC_edit_problem_header,
1.614 albertel 8495: div.LC_edit_problem_footer {
1.705 tempelho 8496: font-weight: normal;
8497: font-size: medium;
1.602 albertel 8498: margin: 2px;
1.1060 bisitz 8499: background-color: $sidebg;
1.600 albertel 8500: }
1.795 www 8501:
1.600 albertel 8502: div.LC_edit_problem_header,
1.602 albertel 8503: div.LC_edit_problem_header div,
1.614 albertel 8504: div.LC_edit_problem_footer,
8505: div.LC_edit_problem_footer div,
1.602 albertel 8506: div.LC_edit_problem_editxml_header,
8507: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8508: z-index: 100;
1.600 albertel 8509: }
1.795 www 8510:
1.600 albertel 8511: div.LC_edit_problem_header_title {
1.705 tempelho 8512: font-weight: bold;
8513: font-size: larger;
1.602 albertel 8514: background: $tabbg;
8515: padding: 3px;
1.1060 bisitz 8516: margin: 0 0 5px 0;
1.602 albertel 8517: }
1.795 www 8518:
1.602 albertel 8519: table.LC_edit_problem_header_title {
8520: width: 100%;
1.600 albertel 8521: background: $tabbg;
1.602 albertel 8522: }
8523:
1.1205 golterma 8524: div.LC_edit_actionbar {
8525: background-color: $sidebg;
1.1218 droeschl 8526: margin: 0;
8527: padding: 0;
8528: line-height: 200%;
1.602 albertel 8529: }
1.795 www 8530:
1.1218 droeschl 8531: div.LC_edit_actionbar div{
8532: padding: 0;
8533: margin: 0;
8534: display: inline-block;
1.600 albertel 8535: }
1.795 www 8536:
1.1124 bisitz 8537: .LC_edit_opt {
8538: padding-left: 1em;
8539: white-space: nowrap;
8540: }
8541:
1.1152 golterma 8542: .LC_edit_problem_latexhelper{
8543: text-align: right;
8544: }
8545:
8546: #LC_edit_problem_colorful div{
8547: margin-left: 40px;
8548: }
8549:
1.1205 golterma 8550: #LC_edit_problem_codemirror div{
8551: margin-left: 0px;
8552: }
8553:
1.911 bisitz 8554: img.stift {
1.803 bisitz 8555: border-width: 0;
8556: vertical-align: middle;
1.677 riegler 8557: }
1.680 riegler 8558:
1.923 bisitz 8559: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8560: vertical-align: top;
1.777 tempelho 8561: }
1.795 www 8562:
1.716 raeburn 8563: div.LC_createcourse {
1.911 bisitz 8564: margin: 10px 10px 10px 10px;
1.716 raeburn 8565: }
8566:
1.917 raeburn 8567: .LC_dccid {
1.1130 raeburn 8568: float: right;
1.917 raeburn 8569: margin: 0.2em 0 0 0;
8570: padding: 0;
8571: font-size: 90%;
8572: display:none;
8573: }
8574:
1.897 wenzelju 8575: ol.LC_primary_menu a:hover,
1.721 harmsja 8576: ol#LC_MenuBreadcrumbs a:hover,
8577: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8578: ul#LC_secondary_menu a:hover,
1.721 harmsja 8579: .LC_FormSectionClearButton input:hover
1.795 www 8580: ul.LC_TabContent li:hover a {
1.952 onken 8581: color:$button_hover;
1.911 bisitz 8582: text-decoration:none;
1.693 droeschl 8583: }
8584:
1.779 bisitz 8585: h1 {
1.911 bisitz 8586: padding: 0;
8587: line-height:130%;
1.693 droeschl 8588: }
1.698 harmsja 8589:
1.911 bisitz 8590: h2,
8591: h3,
8592: h4,
8593: h5,
8594: h6 {
8595: margin: 5px 0 5px 0;
8596: padding: 0;
8597: line-height:130%;
1.693 droeschl 8598: }
1.795 www 8599:
8600: .LC_hcell {
1.911 bisitz 8601: padding:3px 15px 3px 15px;
8602: margin: 0;
8603: background-color:$tabbg;
8604: color:$fontmenu;
8605: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8606: }
1.795 www 8607:
1.840 bisitz 8608: .LC_Box > .LC_hcell {
1.911 bisitz 8609: margin: 0 -10px 10px -10px;
1.835 bisitz 8610: }
8611:
1.721 harmsja 8612: .LC_noBorder {
1.911 bisitz 8613: border: 0;
1.698 harmsja 8614: }
1.693 droeschl 8615:
1.721 harmsja 8616: .LC_FormSectionClearButton input {
1.911 bisitz 8617: background-color:transparent;
8618: border: none;
8619: cursor:pointer;
8620: text-decoration:underline;
1.693 droeschl 8621: }
1.763 bisitz 8622:
8623: .LC_help_open_topic {
1.911 bisitz 8624: color: #FFFFFF;
8625: background-color: #EEEEFF;
8626: margin: 1px;
8627: padding: 4px;
8628: border: 1px solid #000033;
8629: white-space: nowrap;
8630: /* vertical-align: middle; */
1.759 neumanie 8631: }
1.693 droeschl 8632:
1.911 bisitz 8633: dl,
8634: ul,
8635: div,
8636: fieldset {
8637: margin: 10px 10px 10px 0;
8638: /* overflow: hidden; */
1.693 droeschl 8639: }
1.795 www 8640:
1.1404 raeburn 8641: fieldset#LC_selectuser {
8642: margin: 0;
8643: padding: 0;
8644: }
8645:
1.1211 raeburn 8646: article.geogebraweb div {
8647: margin: 0;
8648: }
8649:
1.838 bisitz 8650: fieldset > legend {
1.911 bisitz 8651: font-weight: bold;
8652: padding: 0 5px 0 5px;
1.838 bisitz 8653: }
8654:
1.813 bisitz 8655: #LC_nav_bar {
1.911 bisitz 8656: float: left;
1.995 raeburn 8657: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8658: margin: 0 0 2px 0;
1.807 droeschl 8659: }
8660:
1.916 droeschl 8661: #LC_realm {
8662: margin: 0.2em 0 0 0;
8663: padding: 0;
8664: font-weight: bold;
8665: text-align: center;
1.995 raeburn 8666: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8667: }
8668:
1.911 bisitz 8669: #LC_nav_bar em {
8670: font-weight: bold;
8671: font-style: normal;
1.807 droeschl 8672: }
8673:
1.897 wenzelju 8674: ol.LC_primary_menu {
1.934 droeschl 8675: margin: 0;
1.1076 raeburn 8676: padding: 0;
1.807 droeschl 8677: }
8678:
1.852 droeschl 8679: ol#LC_PathBreadcrumbs {
1.911 bisitz 8680: margin: 0;
1.693 droeschl 8681: }
8682:
1.897 wenzelju 8683: ol.LC_primary_menu li {
1.1076 raeburn 8684: color: RGB(80, 80, 80);
8685: vertical-align: middle;
8686: text-align: left;
8687: list-style: none;
1.1205 golterma 8688: position: relative;
1.1076 raeburn 8689: float: left;
1.1205 golterma 8690: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8691: line-height: 1.5em;
1.1076 raeburn 8692: }
8693:
1.1205 golterma 8694: ol.LC_primary_menu li a,
8695: ol.LC_primary_menu li p {
1.1076 raeburn 8696: display: block;
8697: margin: 0;
8698: padding: 0 5px 0 10px;
8699: text-decoration: none;
8700: }
8701:
1.1205 golterma 8702: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8703: display: inline-block;
8704: width: 95%;
8705: text-align: left;
8706: }
8707:
8708: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8709: display: inline-block;
8710: width: 5%;
8711: float: right;
8712: text-align: right;
8713: font-size: 70%;
8714: }
8715:
8716: ol.LC_primary_menu ul {
1.1076 raeburn 8717: display: none;
1.1205 golterma 8718: width: 15em;
1.1076 raeburn 8719: background-color: $data_table_light;
1.1205 golterma 8720: position: absolute;
8721: top: 100%;
1.1076 raeburn 8722: }
8723:
1.1205 golterma 8724: ol.LC_primary_menu ul ul {
8725: left: 100%;
8726: top: 0;
8727: }
8728:
8729: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8730: display: block;
8731: position: absolute;
8732: margin: 0;
8733: padding: 0;
1.1078 raeburn 8734: z-index: 2;
1.1076 raeburn 8735: }
8736:
8737: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8738: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8739: font-size: 90%;
1.911 bisitz 8740: vertical-align: top;
1.1076 raeburn 8741: float: none;
1.1079 raeburn 8742: border-left: 1px solid black;
8743: border-right: 1px solid black;
1.1205 golterma 8744: /* A dark bottom border to visualize different menu options;
8745: overwritten in the create_submenu routine for the last border-bottom of the menu */
8746: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8747: }
8748:
1.1205 golterma 8749: ol.LC_primary_menu li li p:hover {
8750: color:$button_hover;
8751: text-decoration:none;
8752: background-color:$data_table_dark;
1.1076 raeburn 8753: }
8754:
8755: ol.LC_primary_menu li li a:hover {
8756: color:$button_hover;
8757: background-color:$data_table_dark;
1.693 droeschl 8758: }
8759:
1.1205 golterma 8760: /* Font-size equal to the size of the predecessors*/
8761: ol.LC_primary_menu li:hover li li {
8762: font-size: 100%;
8763: }
8764:
1.897 wenzelju 8765: ol.LC_primary_menu li img {
1.911 bisitz 8766: vertical-align: bottom;
1.934 droeschl 8767: height: 1.1em;
1.1077 raeburn 8768: margin: 0.2em 0 0 0;
1.693 droeschl 8769: }
8770:
1.897 wenzelju 8771: ol.LC_primary_menu a {
1.911 bisitz 8772: color: RGB(80, 80, 80);
8773: text-decoration: none;
1.693 droeschl 8774: }
1.795 www 8775:
1.949 droeschl 8776: ol.LC_primary_menu a.LC_new_message {
8777: font-weight:bold;
8778: color: darkred;
8779: }
8780:
1.975 raeburn 8781: ol.LC_docs_parameters {
8782: margin-left: 0;
8783: padding: 0;
8784: list-style: none;
8785: }
8786:
8787: ol.LC_docs_parameters li {
8788: margin: 0;
8789: padding-right: 20px;
8790: display: inline;
8791: }
8792:
1.976 raeburn 8793: ol.LC_docs_parameters li:before {
8794: content: "\\002022 \\0020";
8795: }
8796:
8797: li.LC_docs_parameters_title {
8798: font-weight: bold;
8799: }
8800:
8801: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8802: content: "";
8803: }
8804:
1.897 wenzelju 8805: ul#LC_secondary_menu {
1.1107 raeburn 8806: clear: right;
1.911 bisitz 8807: color: $fontmenu;
8808: background: $tabbg;
8809: list-style: none;
8810: padding: 0;
8811: margin: 0;
8812: width: 100%;
1.995 raeburn 8813: text-align: left;
1.1107 raeburn 8814: float: left;
1.808 droeschl 8815: }
8816:
1.897 wenzelju 8817: ul#LC_secondary_menu li {
1.911 bisitz 8818: font-weight: bold;
8819: line-height: 1.8em;
1.1107 raeburn 8820: border-right: 1px solid black;
8821: float: left;
8822: }
8823:
8824: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8825: background-color: $data_table_light;
8826: }
8827:
8828: ul#LC_secondary_menu li a {
1.911 bisitz 8829: padding: 0 0.8em;
1.1107 raeburn 8830: }
8831:
8832: ul#LC_secondary_menu li ul {
8833: display: none;
8834: }
8835:
8836: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8837: display: block;
8838: position: absolute;
8839: margin: 0;
8840: padding: 0;
8841: list-style:none;
8842: float: none;
8843: background-color: $data_table_light;
8844: z-index: 2;
8845: margin-left: -1px;
8846: }
8847:
8848: ul#LC_secondary_menu li ul li {
8849: font-size: 90%;
8850: vertical-align: top;
8851: border-left: 1px solid black;
1.911 bisitz 8852: border-right: 1px solid black;
1.1119 raeburn 8853: background-color: $data_table_light;
1.1107 raeburn 8854: list-style:none;
8855: float: none;
8856: }
8857:
8858: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8859: background-color: $data_table_dark;
1.807 droeschl 8860: }
8861:
1.847 tempelho 8862: ul.LC_TabContent {
1.911 bisitz 8863: display:block;
8864: background: $sidebg;
8865: border-bottom: solid 1px $lg_border_color;
8866: list-style:none;
1.1020 raeburn 8867: margin: -1px -10px 0 -10px;
1.911 bisitz 8868: padding: 0;
1.693 droeschl 8869: }
8870:
1.795 www 8871: ul.LC_TabContent li,
8872: ul.LC_TabContentBigger li {
1.911 bisitz 8873: float:left;
1.741 harmsja 8874: }
1.795 www 8875:
1.897 wenzelju 8876: ul#LC_secondary_menu li a {
1.911 bisitz 8877: color: $fontmenu;
8878: text-decoration: none;
1.693 droeschl 8879: }
1.795 www 8880:
1.721 harmsja 8881: ul.LC_TabContent {
1.952 onken 8882: min-height:20px;
1.721 harmsja 8883: }
1.795 www 8884:
8885: ul.LC_TabContent li {
1.911 bisitz 8886: vertical-align:middle;
1.959 onken 8887: padding: 0 16px 0 10px;
1.911 bisitz 8888: background-color:$tabbg;
8889: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8890: border-left: solid 1px $font;
1.721 harmsja 8891: }
1.795 www 8892:
1.847 tempelho 8893: ul.LC_TabContent .right {
1.911 bisitz 8894: float:right;
1.847 tempelho 8895: }
8896:
1.911 bisitz 8897: ul.LC_TabContent li a,
8898: ul.LC_TabContent li {
8899: color:rgb(47,47,47);
8900: text-decoration:none;
8901: font-size:95%;
8902: font-weight:bold;
1.952 onken 8903: min-height:20px;
8904: }
8905:
1.959 onken 8906: ul.LC_TabContent li a:hover,
8907: ul.LC_TabContent li a:focus {
1.952 onken 8908: color: $button_hover;
1.959 onken 8909: background:none;
8910: outline:none;
1.952 onken 8911: }
8912:
8913: ul.LC_TabContent li:hover {
8914: color: $button_hover;
8915: cursor:pointer;
1.721 harmsja 8916: }
1.795 www 8917:
1.911 bisitz 8918: ul.LC_TabContent li.active {
1.952 onken 8919: color: $font;
1.911 bisitz 8920: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8921: border-bottom:solid 1px #FFFFFF;
8922: cursor: default;
1.744 ehlerst 8923: }
1.795 www 8924:
1.959 onken 8925: ul.LC_TabContent li.active a {
8926: color:$font;
8927: background:#FFFFFF;
8928: outline: none;
8929: }
1.1047 raeburn 8930:
8931: ul.LC_TabContent li.goback {
8932: float: left;
8933: border-left: none;
8934: }
8935:
1.870 tempelho 8936: #maincoursedoc {
1.911 bisitz 8937: clear:both;
1.870 tempelho 8938: }
8939:
8940: ul.LC_TabContentBigger {
1.911 bisitz 8941: display:block;
8942: list-style:none;
8943: padding: 0;
1.870 tempelho 8944: }
8945:
1.795 www 8946: ul.LC_TabContentBigger li {
1.911 bisitz 8947: vertical-align:bottom;
8948: height: 30px;
8949: font-size:110%;
8950: font-weight:bold;
8951: color: #737373;
1.841 tempelho 8952: }
8953:
1.957 onken 8954: ul.LC_TabContentBigger li.active {
8955: position: relative;
8956: top: 1px;
8957: }
8958:
1.870 tempelho 8959: ul.LC_TabContentBigger li a {
1.911 bisitz 8960: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8961: height: 30px;
8962: line-height: 30px;
8963: text-align: center;
8964: display: block;
8965: text-decoration: none;
1.958 onken 8966: outline: none;
1.741 harmsja 8967: }
1.795 www 8968:
1.870 tempelho 8969: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8970: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8971: color:$font;
1.744 ehlerst 8972: }
1.795 www 8973:
1.870 tempelho 8974: ul.LC_TabContentBigger li b {
1.911 bisitz 8975: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8976: display: block;
8977: float: left;
8978: padding: 0 30px;
1.957 onken 8979: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8980: }
8981:
1.956 onken 8982: ul.LC_TabContentBigger li:hover b {
8983: color:$button_hover;
8984: }
8985:
1.870 tempelho 8986: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8987: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8988: color:$font;
1.957 onken 8989: border: 0;
1.741 harmsja 8990: }
1.693 droeschl 8991:
1.870 tempelho 8992:
1.862 bisitz 8993: ul.LC_CourseBreadcrumbs {
8994: background: $sidebg;
1.1020 raeburn 8995: height: 2em;
1.862 bisitz 8996: padding-left: 10px;
1.1020 raeburn 8997: margin: 0;
1.862 bisitz 8998: list-style-position: inside;
8999: }
9000:
1.911 bisitz 9001: ol#LC_MenuBreadcrumbs,
1.862 bisitz 9002: ol#LC_PathBreadcrumbs {
1.911 bisitz 9003: padding-left: 10px;
9004: margin: 0;
1.933 droeschl 9005: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 9006: }
9007:
1.911 bisitz 9008: ol#LC_MenuBreadcrumbs li,
9009: ol#LC_PathBreadcrumbs li,
1.862 bisitz 9010: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 9011: display: inline;
1.933 droeschl 9012: white-space: normal;
1.693 droeschl 9013: }
9014:
1.823 bisitz 9015: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 9016: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 9017: text-decoration: none;
9018: font-size:90%;
1.693 droeschl 9019: }
1.795 www 9020:
1.969 droeschl 9021: ol#LC_MenuBreadcrumbs h1 {
9022: display: inline;
9023: font-size: 90%;
9024: line-height: 2.5em;
9025: margin: 0;
9026: padding: 0;
9027: }
9028:
1.795 www 9029: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 9030: text-decoration:none;
9031: font-size:100%;
9032: font-weight:bold;
1.693 droeschl 9033: }
1.795 www 9034:
1.840 bisitz 9035: .LC_Box {
1.911 bisitz 9036: border: solid 1px $lg_border_color;
9037: padding: 0 10px 10px 10px;
1.746 neumanie 9038: }
1.795 www 9039:
1.1020 raeburn 9040: .LC_DocsBox {
9041: border: solid 1px $lg_border_color;
9042: padding: 0 0 10px 10px;
9043: }
9044:
1.795 www 9045: .LC_AboutMe_Image {
1.911 bisitz 9046: float:left;
9047: margin-right:10px;
1.747 neumanie 9048: }
1.795 www 9049:
9050: .LC_Clear_AboutMe_Image {
1.911 bisitz 9051: clear:left;
1.747 neumanie 9052: }
1.795 www 9053:
1.721 harmsja 9054: dl.LC_ListStyleClean dt {
1.911 bisitz 9055: padding-right: 5px;
9056: display: table-header-group;
1.693 droeschl 9057: }
9058:
1.721 harmsja 9059: dl.LC_ListStyleClean dd {
1.911 bisitz 9060: display: table-row;
1.693 droeschl 9061: }
9062:
1.721 harmsja 9063: .LC_ListStyleClean,
9064: .LC_ListStyleSimple,
9065: .LC_ListStyleNormal,
1.795 www 9066: .LC_ListStyleSpecial {
1.911 bisitz 9067: /* display:block; */
9068: list-style-position: inside;
9069: list-style-type: none;
9070: overflow: hidden;
9071: padding: 0;
1.693 droeschl 9072: }
9073:
1.721 harmsja 9074: .LC_ListStyleSimple li,
9075: .LC_ListStyleSimple dd,
9076: .LC_ListStyleNormal li,
9077: .LC_ListStyleNormal dd,
9078: .LC_ListStyleSpecial li,
1.795 www 9079: .LC_ListStyleSpecial dd {
1.911 bisitz 9080: margin: 0;
9081: padding: 5px 5px 5px 10px;
9082: clear: both;
1.693 droeschl 9083: }
9084:
1.721 harmsja 9085: .LC_ListStyleClean li,
9086: .LC_ListStyleClean dd {
1.911 bisitz 9087: padding-top: 0;
9088: padding-bottom: 0;
1.693 droeschl 9089: }
9090:
1.721 harmsja 9091: .LC_ListStyleSimple dd,
1.795 www 9092: .LC_ListStyleSimple li {
1.911 bisitz 9093: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9094: }
9095:
1.721 harmsja 9096: .LC_ListStyleSpecial li,
9097: .LC_ListStyleSpecial dd {
1.911 bisitz 9098: list-style-type: none;
9099: background-color: RGB(220, 220, 220);
9100: margin-bottom: 4px;
1.693 droeschl 9101: }
9102:
1.721 harmsja 9103: table.LC_SimpleTable {
1.911 bisitz 9104: margin:5px;
9105: border:solid 1px $lg_border_color;
1.795 www 9106: }
1.693 droeschl 9107:
1.721 harmsja 9108: table.LC_SimpleTable tr {
1.911 bisitz 9109: padding: 0;
9110: border:solid 1px $lg_border_color;
1.693 droeschl 9111: }
1.795 www 9112:
9113: table.LC_SimpleTable thead {
1.911 bisitz 9114: background:rgb(220,220,220);
1.693 droeschl 9115: }
9116:
1.721 harmsja 9117: div.LC_columnSection {
1.911 bisitz 9118: display: block;
9119: clear: both;
9120: overflow: hidden;
9121: margin: 0;
1.693 droeschl 9122: }
9123:
1.721 harmsja 9124: div.LC_columnSection>* {
1.911 bisitz 9125: float: left;
9126: margin: 10px 20px 10px 0;
9127: overflow:hidden;
1.693 droeschl 9128: }
1.721 harmsja 9129:
1.795 www 9130: table em {
1.911 bisitz 9131: font-weight: bold;
9132: font-style: normal;
1.748 schulted 9133: }
1.795 www 9134:
1.779 bisitz 9135: table.LC_tableBrowseRes,
1.795 www 9136: table.LC_tableOfContent {
1.911 bisitz 9137: border:none;
9138: border-spacing: 1px;
9139: padding: 3px;
9140: background-color: #FFFFFF;
9141: font-size: 90%;
1.753 droeschl 9142: }
1.789 droeschl 9143:
1.911 bisitz 9144: table.LC_tableOfContent {
9145: border-collapse: collapse;
1.789 droeschl 9146: }
9147:
1.771 droeschl 9148: table.LC_tableBrowseRes a,
1.768 schulted 9149: table.LC_tableOfContent a {
1.911 bisitz 9150: background-color: transparent;
9151: text-decoration: none;
1.753 droeschl 9152: }
9153:
1.795 www 9154: table.LC_tableOfContent img {
1.911 bisitz 9155: border: none;
9156: height: 1.3em;
9157: vertical-align: text-bottom;
9158: margin-right: 0.3em;
1.753 droeschl 9159: }
1.757 schulted 9160:
1.795 www 9161: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9162: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9163: }
9164:
1.795 www 9165: a#LC_content_toolbar_everything {
1.911 bisitz 9166: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9167: }
9168:
1.795 www 9169: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9170: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9171: }
9172:
1.795 www 9173: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9174: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9175: }
9176:
1.795 www 9177: a#LC_content_toolbar_changefolder {
1.911 bisitz 9178: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9179: }
9180:
1.795 www 9181: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9182: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9183: }
9184:
1.1043 raeburn 9185: a#LC_content_toolbar_edittoplevel {
9186: background-image:url(/res/adm/pages/edittoplevel.gif);
9187: }
9188:
1.1384 raeburn 9189: a#LC_content_toolbar_printout {
9190: background-image:url(/res/adm/pages/printout.gif);
9191: }
9192:
1.795 www 9193: ul#LC_toolbar li a:hover {
1.911 bisitz 9194: background-position: bottom center;
1.757 schulted 9195: }
9196:
1.795 www 9197: ul#LC_toolbar {
1.911 bisitz 9198: padding: 0;
9199: margin: 2px;
9200: list-style:none;
1.1449 raeburn 9201: display:inline;
1.911 bisitz 9202: background-color:white;
1.1082 raeburn 9203: overflow: auto;
1.757 schulted 9204: }
9205:
1.795 www 9206: ul#LC_toolbar li {
1.911 bisitz 9207: border:1px solid white;
9208: padding: 0;
9209: margin: 0;
9210: float: left;
9211: display:inline;
9212: vertical-align:middle;
1.1082 raeburn 9213: white-space: nowrap;
1.911 bisitz 9214: }
1.757 schulted 9215:
1.783 amueller 9216:
1.795 www 9217: a.LC_toolbarItem {
1.911 bisitz 9218: display:block;
9219: padding: 0;
9220: margin: 0;
9221: height: 32px;
9222: width: 32px;
9223: color:white;
9224: border: none;
9225: background-repeat:no-repeat;
9226: background-color:transparent;
1.757 schulted 9227: }
9228:
1.1449 raeburn 9229: .LC_navtools {
9230: display: inline-block;
9231: padding: 0;
9232: margin: 2px;
9233: vertical-align: middle;
9234: }
9235:
1.915 droeschl 9236: ul.LC_funclist {
9237: margin: 0;
9238: padding: 0.5em 1em 0.5em 0;
9239: }
9240:
1.933 droeschl 9241: ul.LC_funclist > li:first-child {
9242: font-weight:bold;
9243: margin-left:0.8em;
9244: }
9245:
1.915 droeschl 9246: ul.LC_funclist + ul.LC_funclist {
9247: /*
9248: left border as a seperator if we have more than
9249: one list
9250: */
9251: border-left: 1px solid $sidebg;
9252: /*
9253: this hides the left border behind the border of the
9254: outer box if element is wrapped to the next 'line'
9255: */
9256: margin-left: -1px;
9257: }
9258:
1.843 bisitz 9259: ul.LC_funclist li {
1.915 droeschl 9260: display: inline;
1.782 bisitz 9261: white-space: nowrap;
1.915 droeschl 9262: margin: 0 0 0 25px;
9263: line-height: 150%;
1.782 bisitz 9264: }
9265:
1.974 wenzelju 9266: .LC_hidden {
9267: display: none;
9268: }
9269:
1.1030 www 9270: .LCmodal-overlay {
9271: position:fixed;
9272: top:0;
9273: right:0;
9274: bottom:0;
9275: left:0;
9276: height:100%;
9277: width:100%;
9278: margin:0;
9279: padding:0;
9280: background:#999;
9281: opacity:.75;
9282: filter: alpha(opacity=75);
9283: -moz-opacity: 0.75;
9284: z-index:101;
9285: }
9286:
9287: * html .LCmodal-overlay {
9288: position: absolute;
9289: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9290: }
9291:
9292: .LCmodal-window {
9293: position:fixed;
9294: top:50%;
9295: left:50%;
9296: margin:0;
9297: padding:0;
9298: z-index:102;
9299: }
9300:
9301: * html .LCmodal-window {
9302: position:absolute;
9303: }
9304:
9305: .LCclose-window {
9306: position:absolute;
9307: width:32px;
9308: height:32px;
9309: right:8px;
9310: top:8px;
9311: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9312: text-indent:-99999px;
9313: overflow:hidden;
9314: cursor:pointer;
9315: }
9316:
1.1369 raeburn 9317: .LCisDisabled {
9318: cursor: not-allowed;
9319: opacity: 0.5;
9320: }
9321:
9322: a[aria-disabled="true"] {
9323: color: currentColor;
9324: display: inline-block; /* For IE11/ MS Edge bug */
9325: pointer-events: none;
9326: text-decoration: none;
9327: }
9328:
1.1335 raeburn 9329: pre.LC_wordwrap {
9330: white-space: pre-wrap;
9331: white-space: -moz-pre-wrap;
9332: white-space: -pre-wrap;
9333: white-space: -o-pre-wrap;
9334: word-wrap: break-word;
9335: }
9336:
1.1100 raeburn 9337: /*
1.1231 damieng 9338: styles used for response display
9339: */
9340: div.LC_radiofoil, div.LC_rankfoil {
9341: margin: .5em 0em .5em 0em;
9342: }
9343: table.LC_itemgroup {
9344: margin-top: 1em;
9345: }
9346:
9347: /*
1.1100 raeburn 9348: styles used by TTH when "Default set of options to pass to tth/m
9349: when converting TeX" in course settings has been set
9350:
9351: option passed: -t
9352:
9353: */
9354:
9355: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9356: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9357: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9358: td div.norm {line-height:normal;}
9359:
9360: /*
9361: option passed -y3
9362: */
9363:
9364: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9365: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9366: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9367:
1.1230 damieng 9368: /*
9369: sections with roles, for content only
9370: */
9371: section[class^="role-"] {
9372: padding-left: 10px;
9373: padding-right: 5px;
9374: margin-top: 8px;
9375: margin-bottom: 8px;
9376: border: 1px solid #2A4;
9377: border-radius: 5px;
9378: box-shadow: 0px 1px 1px #BBB;
9379: }
9380: section[class^="role-"]>h1 {
9381: position: relative;
9382: margin: 0px;
9383: padding-top: 10px;
9384: padding-left: 40px;
9385: }
9386: section[class^="role-"]>h1:before {
9387: position: absolute;
9388: left: -5px;
9389: top: 5px;
9390: }
9391: section.role-activity>h1:before {
9392: content:url('/adm/daxe/images/section_icons/activity.png');
9393: }
9394: section.role-advice>h1:before {
9395: content:url('/adm/daxe/images/section_icons/advice.png');
9396: }
9397: section.role-bibliography>h1:before {
9398: content:url('/adm/daxe/images/section_icons/bibliography.png');
9399: }
9400: section.role-citation>h1:before {
9401: content:url('/adm/daxe/images/section_icons/citation.png');
9402: }
9403: section.role-conclusion>h1:before {
9404: content:url('/adm/daxe/images/section_icons/conclusion.png');
9405: }
9406: section.role-definition>h1:before {
9407: content:url('/adm/daxe/images/section_icons/definition.png');
9408: }
9409: section.role-demonstration>h1:before {
9410: content:url('/adm/daxe/images/section_icons/demonstration.png');
9411: }
9412: section.role-example>h1:before {
9413: content:url('/adm/daxe/images/section_icons/example.png');
9414: }
9415: section.role-explanation>h1:before {
9416: content:url('/adm/daxe/images/section_icons/explanation.png');
9417: }
9418: section.role-introduction>h1:before {
9419: content:url('/adm/daxe/images/section_icons/introduction.png');
9420: }
9421: section.role-method>h1:before {
9422: content:url('/adm/daxe/images/section_icons/method.png');
9423: }
9424: section.role-more_information>h1:before {
9425: content:url('/adm/daxe/images/section_icons/more_information.png');
9426: }
9427: section.role-objectives>h1:before {
9428: content:url('/adm/daxe/images/section_icons/objectives.png');
9429: }
9430: section.role-prerequisites>h1:before {
9431: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9432: }
9433: section.role-remark>h1:before {
9434: content:url('/adm/daxe/images/section_icons/remark.png');
9435: }
9436: section.role-reminder>h1:before {
9437: content:url('/adm/daxe/images/section_icons/reminder.png');
9438: }
9439: section.role-summary>h1:before {
9440: content:url('/adm/daxe/images/section_icons/summary.png');
9441: }
9442: section.role-syntax>h1:before {
9443: content:url('/adm/daxe/images/section_icons/syntax.png');
9444: }
9445: section.role-warning>h1:before {
9446: content:url('/adm/daxe/images/section_icons/warning.png');
9447: }
9448:
1.1269 raeburn 9449: #LC_minitab_header {
9450: float:left;
9451: width:100%;
9452: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9453: font-size:93%;
9454: line-height:normal;
9455: margin: 0.5em 0 0.5em 0;
9456: }
9457: #LC_minitab_header ul {
9458: margin:0;
9459: padding:10px 10px 0;
9460: list-style:none;
9461: }
9462: #LC_minitab_header li {
9463: float:left;
9464: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9465: margin:0;
9466: padding:0 0 0 9px;
9467: }
9468: #LC_minitab_header a {
9469: display:block;
9470: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9471: padding:5px 15px 4px 6px;
9472: }
9473: #LC_minitab_header #LC_current_minitab {
9474: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9475: }
9476: #LC_minitab_header #LC_current_minitab a {
9477: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9478: padding-bottom:5px;
9479: }
9480:
9481:
1.343 albertel 9482: END
9483: }
9484:
1.306 albertel 9485: =pod
9486:
9487: =item * &headtag()
9488:
9489: Returns a uniform footer for LON-CAPA web pages.
9490:
1.307 albertel 9491: Inputs: $title - optional title for the head
9492: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9493: $args - optional arguments
1.319 albertel 9494: force_register - if is true call registerurl so the remote is
9495: informed
1.415 albertel 9496: redirect -> array ref of
9497: 1- seconds before redirect occurs
9498: 2- url to redirect to
9499: 3- whether the side effect should occur
1.315 albertel 9500: (side effect of setting
9501: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9502: redirected to)
9503: 4- whether the redirect target should be
9504: the opener of the current (pop-up)
9505: window (side effect of setting
9506: $env{'internal.head.to_opener'} to
9507: 1, if true.
1.1388 raeburn 9508: 5- whether encrypt check should be skipped
1.352 albertel 9509: domain -> force to color decorate a page for a specific
9510: domain
9511: function -> force usage of a specific rolish color scheme
9512: bgcolor -> override the default page bgcolor
1.460 albertel 9513: no_auto_mt_title
9514: -> prevent &mt()ing the title arg
1.464 albertel 9515:
1.306 albertel 9516: =cut
9517:
9518: sub headtag {
1.313 albertel 9519: my ($title,$head_extra,$args) = @_;
1.306 albertel 9520:
1.363 albertel 9521: my $function = $args->{'function'} || &get_users_function();
9522: my $domain = $args->{'domain'} || &determinedomain();
9523: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9524: my $httphost = $args->{'use_absolute'};
1.418 albertel 9525: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9526: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9527: #time(),
1.418 albertel 9528: $env{'environment.color.timestamp'},
1.363 albertel 9529: $function,$domain,$bgcolor);
9530:
1.369 www 9531: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9532:
1.308 albertel 9533: my $result =
9534: '<head>'.
1.1160 raeburn 9535: &font_settings($args);
1.319 albertel 9536:
1.1188 raeburn 9537: my $inhibitprint;
9538: if ($args->{'print_suppress'}) {
9539: $inhibitprint = &print_suppression();
9540: }
1.1064 raeburn 9541:
1.1439 raeburn 9542: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9543: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9544: }
1.962 droeschl 9545: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9546: $result .= Apache::lonxml::display_title();
1.319 albertel 9547: }
1.436 albertel 9548: if (!$args->{'no_nav_bar'}
9549: && !$args->{'only_body'}
1.1438 raeburn 9550: && !$args->{'frameset'}
9551: && !$args->{'switchserver'}) {
1.1154 raeburn 9552: $result .= &help_menu_js($httphost);
1.1032 www 9553: $result.=&modal_window();
1.1038 www 9554: $result.=&togglebox_script();
1.1034 www 9555: $result.=&wishlist_window();
1.1041 www 9556: $result.=&LCprogressbarUpdate_script();
1.1034 www 9557: } else {
9558: if ($args->{'add_modal'}) {
9559: $result.=&modal_window();
9560: }
9561: if ($args->{'add_wishlist'}) {
9562: $result.=&wishlist_window();
9563: }
1.1038 www 9564: if ($args->{'add_togglebox'}) {
9565: $result.=&togglebox_script();
9566: }
1.1041 www 9567: if ($args->{'add_progressbar'}) {
9568: $result.=&LCprogressbarUpdate_script();
9569: }
1.436 albertel 9570: }
1.314 albertel 9571: if (ref($args->{'redirect'})) {
1.1388 raeburn 9572: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9573: if (!$skip_enc_check) {
9574: $url = &Apache::lonenc::check_encrypt($url);
9575: }
1.414 albertel 9576: if (!$inhibit_continue) {
9577: $env{'internal.head.redirect'} = $url;
9578: }
1.1386 raeburn 9579: $result.=<<"ADDMETA";
1.313 albertel 9580: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9581: ADDMETA
9582: if ($to_opener) {
9583: $env{'internal.head.to_opener'} = 1;
9584: my $dest = &js_escape($url);
9585: my $timeout = int($time * 1000);
9586: $result .=<<"ENDJS";
9587: <script type="text/javascript">
9588: // <![CDATA[
9589: function LC_To_Opener() {
9590: var dest = '$dest';
9591: if (dest != '') {
9592: if (window.opener != null && !window.opener.closed) {
9593: window.opener.location.href=dest;
9594: window.close();
9595: } else {
9596: window.location.href=dest;
9597: }
9598: }
9599: }
9600: \$(document).ready(function () {
9601: setTimeout('LC_To_Opener()',$timeout);
9602: });
9603: // ]]>
9604: </script>
9605: ENDJS
9606: } else {
9607: $result.=<<"ADDMETA";
1.344 albertel 9608: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9609: ADDMETA
1.1386 raeburn 9610: }
1.1210 raeburn 9611: } else {
9612: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9613: my $requrl = $env{'request.uri'};
9614: if ($requrl eq '') {
9615: $requrl = $ENV{'REQUEST_URI'};
9616: $requrl =~ s/\?.+$//;
9617: }
9618: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9619: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9620: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9621: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9622: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9623: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9624: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9625: my ($offload,$offloadoth);
1.1210 raeburn 9626: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9627: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9628: $offload = 1;
1.1353 raeburn 9629: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9630: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9631: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9632: $offloadoth = 1;
9633: $dom_in_use = $env{'user.domain'};
9634: }
9635: }
1.1340 raeburn 9636: }
9637: }
9638: unless ($offload) {
9639: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9640: if ($domdefs{'offloadoth'}{$lonhost}) {
9641: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9642: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9643: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9644: $offload = 1;
1.1352 raeburn 9645: $offloadoth = 1;
1.1340 raeburn 9646: $dom_in_use = $env{'user.domain'};
9647: }
1.1210 raeburn 9648: }
1.1340 raeburn 9649: }
9650: }
9651: }
9652: if ($offload) {
1.1358 raeburn 9653: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9654: if (($newserver eq '') && ($offloadoth)) {
9655: my @domains = &Apache::lonnet::current_machine_domains();
9656: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9657: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9658: }
9659: }
1.1340 raeburn 9660: if (($newserver) && ($newserver ne $lonhost)) {
9661: my $numsec = 5;
9662: my $timeout = $numsec * 1000;
9663: my ($newurl,$locknum,%locks,$msg);
9664: if ($env{'request.role.adv'}) {
9665: ($locknum,%locks) = &Apache::lonnet::get_locks();
9666: }
9667: my $disable_submit = 0;
9668: if ($requrl =~ /$LONCAPA::assess_re/) {
9669: $disable_submit = 1;
9670: }
9671: if ($locknum) {
9672: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9673: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9674: join(", ",sort(values(%locks)))."\n";
9675: if (&show_course()) {
9676: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9677: } else {
9678: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9679: }
1.1340 raeburn 9680: } else {
9681: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9682: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9683: }
9684: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9685: $newurl = '/adm/switchserver?otherserver='.$newserver;
9686: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9687: $newurl .= '&role='.$env{'request.role'};
9688: }
9689: if ($env{'request.symb'}) {
9690: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9691: if ($shownsymb =~ m{^/enc/}) {
9692: my $reqdmajor = 2;
9693: my $reqdminor = 11;
9694: my $reqdsubminor = 3;
9695: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9696: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9697: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9698: if (($major eq '' && $minor eq '') ||
9699: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9700: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9701: ($reqdsubminor > $subminor))))) {
9702: undef($shownsymb);
9703: }
1.1210 raeburn 9704: }
1.1340 raeburn 9705: if ($shownsymb) {
9706: &js_escape(\$shownsymb);
9707: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9708: }
1.1340 raeburn 9709: } else {
9710: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9711: &js_escape(\$shownurl);
9712: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9713: }
1.1340 raeburn 9714: }
9715: &js_escape(\$msg);
9716: $result.=<<OFFLOAD
1.1210 raeburn 9717: <meta http-equiv="pragma" content="no-cache" />
9718: <script type="text/javascript">
1.1215 raeburn 9719: // <![CDATA[
1.1210 raeburn 9720: function LC_Offload_Now() {
9721: var dest = "$newurl";
9722: if (dest != '') {
9723: window.location.href="$newurl";
9724: }
9725: }
1.1214 raeburn 9726: \$(document).ready(function () {
9727: window.alert('$msg');
9728: if ($disable_submit) {
1.1210 raeburn 9729: \$(".LC_hwk_submit").prop("disabled", true);
9730: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9731: }
9732: setTimeout('LC_Offload_Now()', $timeout);
9733: });
1.1215 raeburn 9734: // ]]>
1.1210 raeburn 9735: </script>
9736: OFFLOAD
9737: }
9738: }
9739: }
9740: }
9741: }
1.313 albertel 9742: }
1.306 albertel 9743: if (!defined($title)) {
9744: $title = 'The LearningOnline Network with CAPA';
9745: }
1.460 albertel 9746: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9747: if ($title =~ /^LON-CAPA\s+/) {
9748: $result .= '<title> '.$title.'</title>';
9749: } else {
9750: $result .= '<title> LON-CAPA '.$title.'</title>';
9751: }
9752: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9753: if (!$args->{'frameset'}) {
9754: $result .= ' /';
9755: }
9756: $result .= '>'
1.1064 raeburn 9757: .$inhibitprint
1.414 albertel 9758: .$head_extra;
1.1242 raeburn 9759: my $clientmobile;
9760: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9761: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9762: } else {
9763: $clientmobile = $env{'browser.mobile'};
9764: }
9765: if ($clientmobile) {
1.1137 raeburn 9766: $result .= '
1.1435 raeburn 9767: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9768: <meta name="apple-mobile-web-app-capable" content="yes" />';
9769: }
1.1455 raeburn 9770: $result .= '<meta name="google" content="notranslate"';
9771: if (!$args->{'frameset'}) {
9772: $result .= ' /';
9773: }
9774: $result .= '>'."\n";
1.962 droeschl 9775: return $result.'</head>';
1.306 albertel 9776: }
9777:
9778: =pod
9779:
1.340 albertel 9780: =item * &font_settings()
9781:
9782: Returns neccessary <meta> to set the proper encoding
9783:
1.1160 raeburn 9784: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9785:
9786: =cut
9787:
9788: sub font_settings {
1.1160 raeburn 9789: my ($args) = @_;
1.340 albertel 9790: my $headerstring='';
1.1160 raeburn 9791: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9792: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9793: $headerstring.=
9794: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9795: if (!$args->{'frameset'}) {
9796: $headerstring.= ' /';
9797: }
9798: $headerstring .= '>'."\n";
1.340 albertel 9799: }
9800: return $headerstring;
9801: }
9802:
1.341 albertel 9803: =pod
9804:
1.1064 raeburn 9805: =item * &print_suppression()
9806:
9807: In course context returns css which causes the body to be blank when media="print",
9808: if printout generation is unavailable for the current resource.
9809:
9810: This could be because:
9811:
9812: (a) printstartdate is in the future
9813:
9814: (b) printenddate is in the past
9815:
9816: (c) there is an active exam block with "printout"
9817: functionality blocked
9818:
9819: Users with pav, pfo or evb privileges are exempt.
9820:
9821: Inputs: none
9822:
9823: =cut
9824:
9825:
9826: sub print_suppression {
9827: my $noprint;
9828: if ($env{'request.course.id'}) {
9829: my $scope = $env{'request.course.id'};
9830: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9831: (&Apache::lonnet::allowed('pfo',$scope))) {
9832: return;
9833: }
9834: if ($env{'request.course.sec'} ne '') {
9835: $scope .= "/$env{'request.course.sec'}";
9836: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9837: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9838: return;
1.1064 raeburn 9839: }
9840: }
9841: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9842: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9843: my $clientip = &Apache::lonnet::get_requestor_ip();
9844: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9845: if ($blocked) {
9846: my $checkrole = "cm./$cdom/$cnum";
9847: if ($env{'request.course.sec'} ne '') {
9848: $checkrole .= "/$env{'request.course.sec'}";
9849: }
9850: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9851: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9852: $noprint = 1;
9853: }
9854: }
9855: unless ($noprint) {
9856: my $symb = &Apache::lonnet::symbread();
9857: if ($symb ne '') {
9858: my $navmap = Apache::lonnavmaps::navmap->new();
9859: if (ref($navmap)) {
9860: my $res = $navmap->getBySymb($symb);
9861: if (ref($res)) {
9862: if (!$res->resprintable()) {
9863: $noprint = 1;
9864: }
9865: }
9866: }
9867: }
9868: }
9869: if ($noprint) {
9870: return <<"ENDSTYLE";
9871: <style type="text/css" media="print">
9872: body { display:none }
9873: </style>
9874: ENDSTYLE
9875: }
9876: }
9877: return;
9878: }
9879:
9880: =pod
9881:
1.341 albertel 9882: =item * &xml_begin()
9883:
9884: Returns the needed doctype and <html>
9885:
9886: Inputs: none
9887:
9888: =cut
9889:
9890: sub xml_begin {
1.1168 raeburn 9891: my ($is_frameset) = @_;
1.341 albertel 9892: my $output='';
9893:
9894: if ($env{'browser.mathml'}) {
9895: $output='<?xml version="1.0"?>'
9896: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9897: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9898:
9899: # .'<!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">] >'
9900: .'<!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">'
9901: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9902: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9903: } elsif ($is_frameset) {
9904: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9905: '<html>'."\n";
1.341 albertel 9906: } else {
1.1168 raeburn 9907: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9908: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9909: }
9910: return $output;
9911: }
1.340 albertel 9912:
9913: =pod
9914:
1.306 albertel 9915: =item * &start_page()
9916:
9917: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9918:
1.648 raeburn 9919: Inputs:
9920:
9921: =over 4
9922:
9923: $title - optional title for the page
9924:
9925: $head_extra - optional extra HTML to incude inside the <head>
9926:
9927: $args - additional optional args supported are:
9928:
9929: =over 8
9930:
9931: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9932: arg on
1.814 bisitz 9933: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9934: add_entries -> additional attributes to add to the <body>
9935: domain -> force to color decorate a page for a
1.317 albertel 9936: specific domain
1.648 raeburn 9937: function -> force usage of a specific rolish color
1.317 albertel 9938: scheme
1.648 raeburn 9939: redirect -> see &headtag()
9940: bgcolor -> override the default page bg color
9941: js_ready -> return a string ready for being used in
1.317 albertel 9942: a javascript writeln
1.648 raeburn 9943: html_encode -> return a string ready for being used in
1.320 albertel 9944: a html attribute
1.648 raeburn 9945: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9946: $forcereg arg
1.648 raeburn 9947: frameset -> if true will start with a <frameset>
1.330 albertel 9948: rather than <body>
1.648 raeburn 9949: skip_phases -> hash ref of
1.338 albertel 9950: head -> skip the <html><head> generation
9951: body -> skip all <body> generation
1.648 raeburn 9952: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9953: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9954: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9955: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9956: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9957: to override those values, or add to them, specify the value to
9958: include in the style attribute to include in the div tag by using
9959: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9960: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9961: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9962: group -> includes the current group, if page is for a
1.1274 raeburn 9963: specific group
9964: use_absolute -> for request for external resource or syllabus, this
9965: will contain https://<hostname> if server uses
9966: https (as per hosts.tab), but request is for http
9967: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9968: links_disabled -> Links in primary and secondary menus are disabled
9969: (Can enable them once page has loaded - see lonroles.pm
9970: for an example).
1.1380 raeburn 9971: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9972:
1.648 raeburn 9973: =back
1.460 albertel 9974:
1.648 raeburn 9975: =back
1.562 albertel 9976:
1.306 albertel 9977: =cut
9978:
9979: sub start_page {
1.309 albertel 9980: my ($title,$head_extra,$args) = @_;
1.318 albertel 9981: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9982:
1.315 albertel 9983: $env{'internal.start_page'}++;
1.1359 raeburn 9984: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9985:
1.338 albertel 9986: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9987: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9988: }
1.1316 raeburn 9989:
9990: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9991: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9992: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9993: $args->{'no_primary_menu'} = 1;
9994: }
9995: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9996: $args->{'no_inline_menu'} = 1;
9997: }
9998: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9999: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
10000: }
10001: } else {
10002: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10003: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
10004: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
10005: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
10006: $args->{'no_primary_menu'} = 1;
10007: }
10008: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
10009: $args->{'no_inline_menu'} = 1;
10010: }
10011: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
10012: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
10013: }
10014: }
10015: }
1.1316 raeburn 10016: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
10017: $env{'course.'.$env{'request.course.id'}.'.domain'},
10018: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 10019: } elsif ($env{'request.course.id'}) {
10020: my $expiretime=600;
10021: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
10022: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
10023: }
10024: my ($deeplinkmenu,$menuref);
10025: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
10026: if ($menucoll) {
10027: if (ref($menuref) eq 'HASH') {
10028: %menu = %{$menuref};
10029: }
10030: if ($menu{'top'} eq 'n') {
10031: $args->{'no_primary_menu'} = 1;
10032: }
10033: if ($menu{'inline'} eq 'n') {
10034: unless (&Apache::lonnet::allowed('opa')) {
10035: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10036: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10037: my $crstype = &course_type();
10038: my $now = time;
10039: my $ccrole;
10040: if ($crstype eq 'Community') {
10041: $ccrole = 'co';
10042: } else {
10043: $ccrole = 'cc';
10044: }
10045: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
10046: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
10047: if ((($start) && ($start<0)) ||
10048: (($end) && ($end<$now)) ||
10049: (($start) && ($now<$start))) {
10050: $args->{'no_inline_menu'} = 1;
10051: }
10052: } else {
10053: $args->{'no_inline_menu'} = 1;
10054: }
10055: }
10056: }
10057: }
1.1316 raeburn 10058: }
1.1359 raeburn 10059:
1.1385 raeburn 10060: my $showncrumbs;
1.338 albertel 10061: if (! exists($args->{'skip_phases'}{'body'}) ) {
10062: if ($args->{'frameset'}) {
10063: my $attr_string = &make_attr_string($args->{'force_register'},
10064: $args->{'add_entries'});
10065: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 10066: } else {
10067: $result .=
10068: &bodytag($title,
10069: $args->{'function'}, $args->{'add_entries'},
10070: $args->{'only_body'}, $args->{'domain'},
10071: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 10072: $args->{'bgcolor'}, $args,
1.1385 raeburn 10073: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
10074: \%menu,\$showncrumbs);
1.831 bisitz 10075: }
1.330 albertel 10076: }
1.338 albertel 10077:
1.315 albertel 10078: if ($args->{'js_ready'}) {
1.713 kaisler 10079: $result = &js_ready($result);
1.315 albertel 10080: }
1.320 albertel 10081: if ($args->{'html_encode'}) {
1.713 kaisler 10082: $result = &html_encode($result);
10083: }
10084:
1.813 bisitz 10085: # Preparation for new and consistent functionlist at top of screen
10086: # if ($args->{'functionlist'}) {
10087: # $result .= &build_functionlist();
10088: #}
10089:
1.964 droeschl 10090: # Don't add anything more if only_body wanted or in const space
10091: return $result if $args->{'only_body'}
10092: || $env{'request.state'} eq 'construct';
1.813 bisitz 10093:
10094: #Breadcrumbs
1.758 kaisler 10095: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10096: unless ($showncrumbs) {
1.758 kaisler 10097: &Apache::lonhtmlcommon::clear_breadcrumbs();
10098: #if any br links exists, add them to the breadcrumbs
10099: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10100: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10101: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10102: }
10103: }
1.1096 raeburn 10104: # if @advtools array contains items add then to the breadcrumbs
10105: if (@advtools > 0) {
10106: &Apache::lonmenu::advtools_crumbs(@advtools);
10107: }
1.1272 raeburn 10108: my $menulink;
10109: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10110: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10111: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10112: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10113: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10114: (!$env{'request.role.adv'}))) {
10115: $menulink = 0;
10116: } else {
10117: undef($menulink);
10118: }
1.1385 raeburn 10119: my $linkprotout;
10120: if ($env{'request.deeplink.login'}) {
10121: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10122: if ($linkprotout) {
10123: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10124: }
10125: }
1.758 kaisler 10126: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10127: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10128: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10129: '',$menulink,'',
10130: $args->{'bread_crumbs_style'});
1.1237 raeburn 10131: } else {
1.1437 raeburn 10132: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10133: $args->{'bread_crumbs_style'});
1.758 kaisler 10134: }
1.1385 raeburn 10135: }
1.320 albertel 10136: }
1.315 albertel 10137: return $result;
1.306 albertel 10138: }
10139:
10140: sub end_page {
1.315 albertel 10141: my ($args) = @_;
10142: $env{'internal.end_page'}++;
1.330 albertel 10143: my $result;
1.335 albertel 10144: if ($args->{'discussion'}) {
10145: my ($target,$parser);
10146: if (ref($args->{'discussion'})) {
10147: ($target,$parser) =($args->{'discussion'}{'target'},
10148: $args->{'discussion'}{'parser'});
10149: }
10150: $result .= &Apache::lonxml::xmlend($target,$parser);
10151: }
1.330 albertel 10152: if ($args->{'frameset'}) {
10153: $result .= '</frameset>';
10154: } else {
1.635 raeburn 10155: $result .= &endbodytag($args);
1.330 albertel 10156: }
1.1080 raeburn 10157: unless ($args->{'notbody'}) {
10158: $result .= "\n</html>";
10159: }
1.330 albertel 10160:
1.315 albertel 10161: if ($args->{'js_ready'}) {
1.317 albertel 10162: $result = &js_ready($result);
1.315 albertel 10163: }
1.335 albertel 10164:
1.320 albertel 10165: if ($args->{'html_encode'}) {
10166: $result = &html_encode($result);
10167: }
1.335 albertel 10168:
1.315 albertel 10169: return $result;
10170: }
10171:
1.1359 raeburn 10172: sub menucoll_in_effect {
10173: my ($menucoll,$deeplinkmenu,%menu);
10174: if ($env{'request.course.id'}) {
10175: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10176: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10177: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10178: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10179: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10180: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10181: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10182: my $navmap = Apache::lonnavmaps::navmap->new();
10183: if (ref($navmap)) {
10184: $deeplink = $navmap->get_mapparam(undef,
10185: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10186: '0.deeplink');
1.1370 raeburn 10187: } else {
10188: $check_login_symb = 1;
1.1362 raeburn 10189: }
10190: } else {
1.1370 raeburn 10191: my $symb = &Apache::lonnet::symbread();
10192: if ($symb) {
10193: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10194: } else {
10195: $check_login_symb = 1;
10196: }
1.1362 raeburn 10197: }
10198: } else {
1.1370 raeburn 10199: $check_login_symb = 1;
10200: }
10201: if ($check_login_symb) {
1.1362 raeburn 10202: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10203: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10204: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10205: my $navmap = Apache::lonnavmaps::navmap->new();
10206: if (ref($navmap)) {
10207: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10208: }
10209: } else {
10210: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10211: }
10212: }
1.1359 raeburn 10213: if ($deeplink ne '') {
1.1378 raeburn 10214: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10215: if ($display =~ /^\d+$/) {
10216: $deeplinkmenu = 1;
10217: $menucoll = $display;
10218: }
10219: }
10220: }
10221: if ($menucoll) {
10222: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10223: }
10224: }
10225: return ($menucoll,$deeplinkmenu,\%menu);
10226: }
10227:
1.1362 raeburn 10228: sub deeplink_login_symb {
10229: my ($cnum,$cdom) = @_;
10230: my $login_symb;
10231: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10232: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10233: }
10234: return $login_symb;
10235: }
10236:
10237: sub symb_from_tinyurl {
10238: my ($url,$cnum,$cdom) = @_;
10239: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10240: my $key = $1;
10241: my ($tinyurl,$login);
10242: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10243: if (defined($cached)) {
10244: $tinyurl = $result;
10245: } else {
10246: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10247: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10248: if ($currtiny{$key} ne '') {
10249: $tinyurl = $currtiny{$key};
10250: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10251: }
1.1364 raeburn 10252: }
10253: if ($tinyurl ne '') {
10254: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10255: if (wantarray) {
10256: return ($cnumreq,$symb);
10257: } elsif ($cnumreq eq $cnum) {
10258: return $symb;
1.1362 raeburn 10259: }
10260: }
10261: }
1.1364 raeburn 10262: if (wantarray) {
10263: return ();
10264: } else {
10265: return;
10266: }
1.1362 raeburn 10267: }
10268:
1.1405 raeburn 10269: sub usable_exttools {
10270: my %tooltypes;
10271: if ($env{'request.course.id'}) {
10272: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10273: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10274: %tooltypes = (
10275: crs => 1,
10276: dom => 1,
10277: );
10278: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10279: $tooltypes{'crs'} = 1;
10280: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10281: $tooltypes{'dom'} = 1;
10282: }
10283: } else {
10284: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10285: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10286: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10287: if ($crstype eq '') {
10288: $crstype = 'course';
10289: }
10290: if ($crstype eq 'course') {
10291: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10292: $crstype = 'official';
10293: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10294: $crstype = 'textbook';
10295: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10296: $crstype = 'lti';
10297: } else {
10298: $crstype = 'unofficial';
10299: }
10300: }
10301: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10302: if ($domdefaults{$crstype.'domexttool'}) {
10303: $tooltypes{'dom'} = 1;
10304: }
10305: if ($domdefaults{$crstype.'exttool'}) {
10306: $tooltypes{'crs'} = 1;
10307: }
10308: }
10309: }
10310: return %tooltypes;
10311: }
10312:
1.1034 www 10313: sub wishlist_window {
10314: return(<<'ENDWISHLIST');
1.1046 raeburn 10315: <script type="text/javascript">
1.1034 www 10316: // <![CDATA[
10317: // <!-- BEGIN LON-CAPA Internal
10318: function set_wishlistlink(title, path) {
10319: if (!title) {
10320: title = document.title;
10321: title = title.replace(/^LON-CAPA /,'');
10322: }
1.1175 raeburn 10323: title = encodeURIComponent(title);
1.1203 raeburn 10324: title = title.replace("'","\\\'");
1.1034 www 10325: if (!path) {
10326: path = location.pathname;
10327: }
1.1175 raeburn 10328: path = encodeURIComponent(path);
1.1203 raeburn 10329: path = path.replace("'","\\\'");
1.1034 www 10330: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10331: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10332: }
10333: // END LON-CAPA Internal -->
10334: // ]]>
10335: </script>
10336: ENDWISHLIST
10337: }
10338:
1.1030 www 10339: sub modal_window {
10340: return(<<'ENDMODAL');
1.1046 raeburn 10341: <script type="text/javascript">
1.1030 www 10342: // <![CDATA[
10343: // <!-- BEGIN LON-CAPA Internal
10344: var modalWindow = {
10345: parent:"body",
10346: windowId:null,
10347: content:null,
10348: width:null,
10349: height:null,
10350: close:function()
10351: {
10352: $(".LCmodal-window").remove();
10353: $(".LCmodal-overlay").remove();
10354: },
10355: open:function()
10356: {
10357: var modal = "";
10358: modal += "<div class=\"LCmodal-overlay\"></div>";
10359: 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;\">";
10360: modal += this.content;
10361: modal += "</div>";
10362:
10363: $(this.parent).append(modal);
10364:
10365: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10366: $(".LCclose-window").click(function(){modalWindow.close();});
10367: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10368: }
10369: };
1.1140 raeburn 10370: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10371: {
1.1266 raeburn 10372: source = source.replace(/'/g,"'");
1.1030 www 10373: modalWindow.windowId = "myModal";
10374: modalWindow.width = width;
10375: modalWindow.height = height;
1.1196 raeburn 10376: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10377: modalWindow.open();
1.1208 raeburn 10378: };
1.1030 www 10379: // END LON-CAPA Internal -->
10380: // ]]>
10381: </script>
10382: ENDMODAL
10383: }
10384:
10385: sub modal_link {
1.1140 raeburn 10386: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10387: unless ($width) { $width=480; }
10388: unless ($height) { $height=400; }
1.1031 www 10389: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10390: unless ($transparency) { $transparency='true'; }
10391:
1.1074 raeburn 10392: my $target_attr;
10393: if (defined($target)) {
10394: $target_attr = 'target="'.$target.'"';
10395: }
10396: return <<"ENDLINK";
1.1336 raeburn 10397: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10398: ENDLINK
1.1030 www 10399: }
10400:
1.1032 www 10401: sub modal_adhoc_script {
1.1365 raeburn 10402: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10403: my $mathjax;
10404: if ($possmathjax) {
10405: $mathjax = <<'ENDJAX';
10406: if (typeof MathJax == 'object') {
10407: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10408: }
10409: ENDJAX
10410: }
1.1032 www 10411: return (<<ENDADHOC);
1.1046 raeburn 10412: <script type="text/javascript">
1.1032 www 10413: // <![CDATA[
10414: var $funcname = function()
10415: {
10416: modalWindow.windowId = "myModal";
10417: modalWindow.width = $width;
10418: modalWindow.height = $height;
10419: modalWindow.content = '$content';
10420: modalWindow.open();
1.1365 raeburn 10421: $mathjax
1.1032 www 10422: };
10423: // ]]>
10424: </script>
10425: ENDADHOC
10426: }
10427:
1.1041 www 10428: sub modal_adhoc_inner {
1.1365 raeburn 10429: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10430: my $innerwidth=$width-20;
10431: $content=&js_ready(
1.1140 raeburn 10432: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10433: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10434: $content.
1.1041 www 10435: &end_scrollbox().
1.1140 raeburn 10436: &end_page()
1.1041 www 10437: );
1.1365 raeburn 10438: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10439: }
10440:
10441: sub modal_adhoc_window {
1.1365 raeburn 10442: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10443: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10444: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10445: }
10446:
10447: sub modal_adhoc_launch {
10448: my ($funcname,$width,$height,$content)=@_;
10449: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10450: <script type="text/javascript">
10451: // <![CDATA[
10452: $funcname();
10453: // ]]>
10454: </script>
10455: ENDLAUNCH
10456: }
10457:
10458: sub modal_adhoc_close {
10459: return (<<ENDCLOSE);
10460: <script type="text/javascript">
10461: // <![CDATA[
10462: modalWindow.close();
10463: // ]]>
10464: </script>
10465: ENDCLOSE
10466: }
10467:
1.1038 www 10468: sub togglebox_script {
10469: return(<<ENDTOGGLE);
10470: <script type="text/javascript">
10471: // <![CDATA[
10472: function LCtoggleDisplay(id,hidetext,showtext) {
10473: link = document.getElementById(id + "link").childNodes[0];
10474: with (document.getElementById(id).style) {
10475: if (display == "none" ) {
10476: display = "inline";
10477: link.nodeValue = hidetext;
10478: } else {
10479: display = "none";
10480: link.nodeValue = showtext;
10481: }
10482: }
10483: }
10484: // ]]>
10485: </script>
10486: ENDTOGGLE
10487: }
10488:
1.1039 www 10489: sub start_togglebox {
10490: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10491: unless ($heading) { $heading=''; } else { $heading.=' '; }
10492: unless ($showtext) { $showtext=&mt('show'); }
10493: unless ($hidetext) { $hidetext=&mt('hide'); }
10494: unless ($headerbg) { $headerbg='#FFFFFF'; }
10495: return &start_data_table().
10496: &start_data_table_header_row().
10497: '<td bgcolor="'.$headerbg.'">'.$heading.
10498: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10499: $showtext.'\')">'.$showtext.'</a>]</td>'.
10500: &end_data_table_header_row().
10501: '<tr id="'.$id.'" style="display:none""><td>';
10502: }
10503:
10504: sub end_togglebox {
10505: return '</td></tr>'.&end_data_table();
10506: }
10507:
1.1041 www 10508: sub LCprogressbar_script {
1.1302 raeburn 10509: my ($id,$number_to_do)=@_;
10510: if ($number_to_do) {
10511: return(<<ENDPROGRESS);
1.1041 www 10512: <script type="text/javascript">
10513: // <![CDATA[
1.1045 www 10514: \$('#progressbar$id').progressbar({
1.1041 www 10515: value: 0,
10516: change: function(event, ui) {
10517: var newVal = \$(this).progressbar('option', 'value');
10518: \$('.pblabel', this).text(LCprogressTxt);
10519: }
10520: });
10521: // ]]>
10522: </script>
10523: ENDPROGRESS
1.1302 raeburn 10524: } else {
10525: return(<<ENDPROGRESS);
10526: <script type="text/javascript">
10527: // <![CDATA[
10528: \$('#progressbar$id').progressbar({
10529: value: false,
10530: create: function(event, ui) {
10531: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10532: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10533: }
10534: });
10535: // ]]>
10536: </script>
10537: ENDPROGRESS
10538: }
1.1041 www 10539: }
10540:
10541: sub LCprogressbarUpdate_script {
10542: return(<<ENDPROGRESSUPDATE);
10543: <style type="text/css">
10544: .ui-progressbar { position:relative; }
1.1302 raeburn 10545: .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 10546: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10547: </style>
10548: <script type="text/javascript">
10549: // <![CDATA[
1.1045 www 10550: var LCprogressTxt='---';
10551:
1.1302 raeburn 10552: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10553: LCprogressTxt=progresstext;
1.1302 raeburn 10554: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10555: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10556: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10557: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10558: } else {
10559: \$('#progressbar'+id).progressbar('value',percent);
10560: }
1.1041 www 10561: }
10562: // ]]>
10563: </script>
10564: ENDPROGRESSUPDATE
10565: }
10566:
1.1042 www 10567: my $LClastpercent;
1.1045 www 10568: my $LCidcnt;
10569: my $LCcurrentid;
1.1042 www 10570:
1.1041 www 10571: sub LCprogressbar {
1.1302 raeburn 10572: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10573: $LClastpercent=0;
1.1045 www 10574: $LCidcnt++;
10575: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10576: my ($starting,$content);
10577: if ($number_to_do) {
10578: $starting=&mt('Starting');
10579: $content=(<<ENDPROGBAR);
10580: $preamble
1.1045 www 10581: <div id="progressbar$LCcurrentid">
1.1041 www 10582: <span class="pblabel">$starting</span>
10583: </div>
10584: ENDPROGBAR
1.1302 raeburn 10585: } else {
10586: $starting=&mt('Loading...');
10587: $LClastpercent='false';
10588: $content=(<<ENDPROGBAR);
10589: $preamble
10590: <div id="progressbar$LCcurrentid">
10591: <div class="progress-label">$starting</div>
10592: </div>
10593: ENDPROGBAR
10594: }
10595: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10596: }
10597:
10598: sub LCprogressbarUpdate {
1.1302 raeburn 10599: my ($r,$val,$text,$number_to_do)=@_;
10600: if ($number_to_do) {
10601: unless ($val) {
10602: if ($LClastpercent) {
10603: $val=$LClastpercent;
10604: } else {
10605: $val=0;
10606: }
10607: }
10608: if ($val<0) { $val=0; }
10609: if ($val>100) { $val=0; }
10610: $LClastpercent=$val;
10611: unless ($text) { $text=$val.'%'; }
10612: } else {
10613: $val = 'false';
1.1042 www 10614: }
1.1041 www 10615: $text=&js_ready($text);
1.1044 www 10616: &r_print($r,<<ENDUPDATE);
1.1041 www 10617: <script type="text/javascript">
10618: // <![CDATA[
1.1302 raeburn 10619: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10620: // ]]>
10621: </script>
10622: ENDUPDATE
1.1035 www 10623: }
10624:
1.1042 www 10625: sub LCprogressbarClose {
10626: my ($r)=@_;
10627: $LClastpercent=0;
1.1044 www 10628: &r_print($r,<<ENDCLOSE);
1.1042 www 10629: <script type="text/javascript">
10630: // <![CDATA[
1.1045 www 10631: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10632: // ]]>
10633: </script>
10634: ENDCLOSE
1.1044 www 10635: }
10636:
10637: sub r_print {
10638: my ($r,$to_print)=@_;
10639: if ($r) {
10640: $r->print($to_print);
10641: $r->rflush();
10642: } else {
10643: print($to_print);
10644: }
1.1042 www 10645: }
10646:
1.320 albertel 10647: sub html_encode {
10648: my ($result) = @_;
10649:
1.322 albertel 10650: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10651:
10652: return $result;
10653: }
1.1044 www 10654:
1.317 albertel 10655: sub js_ready {
10656: my ($result) = @_;
10657:
1.323 albertel 10658: $result =~ s/[\n\r]/ /xmsg;
10659: $result =~ s/\\/\\\\/xmsg;
10660: $result =~ s/'/\\'/xmsg;
1.372 albertel 10661: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10662:
10663: return $result;
10664: }
10665:
1.315 albertel 10666: sub validate_page {
10667: if ( exists($env{'internal.start_page'})
1.316 albertel 10668: && $env{'internal.start_page'} > 1) {
10669: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10670: $env{'internal.start_page'}.' '.
1.316 albertel 10671: $ENV{'request.filename'});
1.315 albertel 10672: }
10673: if ( exists($env{'internal.end_page'})
1.316 albertel 10674: && $env{'internal.end_page'} > 1) {
10675: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10676: $env{'internal.end_page'}.' '.
1.316 albertel 10677: $env{'request.filename'});
1.315 albertel 10678: }
10679: if ( exists($env{'internal.start_page'})
10680: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10681: &Apache::lonnet::logthis('start_page called without end_page '.
10682: $env{'request.filename'});
1.315 albertel 10683: }
10684: if ( ! exists($env{'internal.start_page'})
10685: && exists($env{'internal.end_page'})) {
1.316 albertel 10686: &Apache::lonnet::logthis('end_page called without start_page'.
10687: $env{'request.filename'});
1.315 albertel 10688: }
1.306 albertel 10689: }
1.315 albertel 10690:
1.996 www 10691:
10692: sub start_scrollbox {
1.1140 raeburn 10693: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10694: unless ($outerwidth) { $outerwidth='520px'; }
10695: unless ($width) { $width='500px'; }
10696: unless ($height) { $height='200px'; }
1.1075 raeburn 10697: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10698: if ($id ne '') {
1.1140 raeburn 10699: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10700: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10701: }
1.1075 raeburn 10702: if ($bgcolor ne '') {
10703: $tdcol = "background-color: $bgcolor;";
10704: }
1.1137 raeburn 10705: my $nicescroll_js;
10706: if ($env{'browser.mobile'}) {
1.1140 raeburn 10707: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10708: }
10709: return <<"END";
10710: $nicescroll_js
10711:
10712: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10713: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10714: END
10715: }
10716:
10717: sub end_scrollbox {
10718: return '</div></td></tr></table>';
10719: }
10720:
10721: sub nicescroll_javascript {
10722: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10723: my %options;
10724: if (ref($cursor) eq 'HASH') {
10725: %options = %{$cursor};
10726: }
10727: unless ($options{'railalign'} =~ /^left|right$/) {
10728: $options{'railalign'} = 'left';
10729: }
10730: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10731: my $function = &get_users_function();
10732: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10733: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10734: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10735: }
1.1140 raeburn 10736: }
10737: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10738: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10739: $options{'cursoropacity'}='1.0';
10740: }
1.1140 raeburn 10741: } else {
10742: $options{'cursoropacity'}='1.0';
10743: }
10744: if ($options{'cursorfixedheight'} eq 'none') {
10745: delete($options{'cursorfixedheight'});
10746: } else {
10747: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10748: }
10749: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10750: delete($options{'railoffset'});
10751: }
10752: my @niceoptions;
10753: while (my($key,$value) = each(%options)) {
10754: if ($value =~ /^\{.+\}$/) {
10755: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10756: } else {
1.1140 raeburn 10757: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10758: }
1.1140 raeburn 10759: }
10760: my $nicescroll_js = '
1.1137 raeburn 10761: $(document).ready(
1.1140 raeburn 10762: function() {
10763: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10764: }
1.1137 raeburn 10765: );
10766: ';
1.1140 raeburn 10767: if ($framecheck) {
10768: $nicescroll_js .= '
10769: function expand_div(caller) {
10770: if (top === self) {
10771: document.getElementById("'.$id.'").style.width = "auto";
10772: document.getElementById("'.$id.'").style.height = "auto";
10773: } else {
10774: try {
10775: if (parent.frames) {
10776: if (parent.frames.length > 1) {
10777: var framesrc = parent.frames[1].location.href;
10778: var currsrc = framesrc.replace(/\#.*$/,"");
10779: if ((caller == "search") || (currsrc == "'.$location.'")) {
10780: document.getElementById("'.$id.'").style.width = "auto";
10781: document.getElementById("'.$id.'").style.height = "auto";
10782: }
10783: }
10784: }
10785: } catch (e) {
10786: return;
10787: }
1.1137 raeburn 10788: }
1.1140 raeburn 10789: return;
1.996 www 10790: }
1.1140 raeburn 10791: ';
10792: }
10793: if ($needjsready) {
10794: $nicescroll_js = '
10795: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10796: } else {
10797: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10798: }
10799: return $nicescroll_js;
1.996 www 10800: }
10801:
1.318 albertel 10802: sub simple_error_page {
1.1150 bisitz 10803: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10804: my %displayargs;
1.1151 raeburn 10805: if (ref($args) eq 'HASH') {
10806: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10807: if ($args->{'only_body'}) {
10808: $displayargs{'only_body'} = 1;
10809: }
10810: if ($args->{'no_nav_bar'}) {
10811: $displayargs{'no_nav_bar'} = 1;
10812: }
1.1151 raeburn 10813: } else {
10814: $msg = &mt($msg);
10815: }
1.1150 bisitz 10816:
1.318 albertel 10817: my $page =
1.1304 raeburn 10818: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10819: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10820: &Apache::loncommon::end_page();
10821: if (ref($r)) {
10822: $r->print($page);
1.327 albertel 10823: return;
1.318 albertel 10824: }
10825: return $page;
10826: }
1.347 albertel 10827:
10828: {
1.610 albertel 10829: my @row_count;
1.961 onken 10830:
10831: sub start_data_table_count {
10832: unshift(@row_count, 0);
10833: return;
10834: }
10835:
10836: sub end_data_table_count {
10837: shift(@row_count);
10838: return;
10839: }
10840:
1.347 albertel 10841: sub start_data_table {
1.1018 raeburn 10842: my ($add_class,$id) = @_;
1.422 albertel 10843: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10844: my $table_id;
10845: if (defined($id)) {
10846: $table_id = ' id="'.$id.'"';
10847: }
1.961 onken 10848: &start_data_table_count();
1.1018 raeburn 10849: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10850: }
10851:
10852: sub end_data_table {
1.961 onken 10853: &end_data_table_count();
1.389 albertel 10854: return '</table>'."\n";;
1.347 albertel 10855: }
10856:
10857: sub start_data_table_row {
1.974 wenzelju 10858: my ($add_class, $id) = @_;
1.610 albertel 10859: $row_count[0]++;
10860: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10861: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10862: $id = (' id="'.$id.'"') unless ($id eq '');
10863: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10864: }
1.471 banghart 10865:
10866: sub continue_data_table_row {
1.974 wenzelju 10867: my ($add_class, $id) = @_;
1.610 albertel 10868: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10869: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10870: $id = (' id="'.$id.'"') unless ($id eq '');
10871: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10872: }
1.347 albertel 10873:
10874: sub end_data_table_row {
1.389 albertel 10875: return '</tr>'."\n";;
1.347 albertel 10876: }
1.367 www 10877:
1.421 albertel 10878: sub start_data_table_empty_row {
1.707 bisitz 10879: # $row_count[0]++;
1.421 albertel 10880: return '<tr class="LC_empty_row" >'."\n";;
10881: }
10882:
10883: sub end_data_table_empty_row {
10884: return '</tr>'."\n";;
10885: }
10886:
1.367 www 10887: sub start_data_table_header_row {
1.389 albertel 10888: return '<tr class="LC_header_row">'."\n";;
1.367 www 10889: }
10890:
10891: sub end_data_table_header_row {
1.389 albertel 10892: return '</tr>'."\n";;
1.367 www 10893: }
1.890 droeschl 10894:
10895: sub data_table_caption {
10896: my $caption = shift;
10897: return "<caption class=\"LC_caption\">$caption</caption>";
10898: }
1.347 albertel 10899: }
10900:
1.548 albertel 10901: =pod
10902:
10903: =item * &inhibit_menu_check($arg)
10904:
10905: Checks for a inhibitmenu state and generates output to preserve it
10906:
10907: Inputs: $arg - can be any of
10908: - undef - in which case the return value is a string
10909: to add into arguments list of a uri
10910: - 'input' - in which case the return value is a HTML
10911: <form> <input> field of type hidden to
10912: preserve the value
10913: - a url - in which case the return value is the url with
10914: the neccesary cgi args added to preserve the
10915: inhibitmenu state
10916: - a ref to a url - no return value, but the string is
10917: updated to include the neccessary cgi
10918: args to preserve the inhibitmenu state
10919:
10920: =cut
10921:
10922: sub inhibit_menu_check {
10923: my ($arg) = @_;
10924: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10925: if ($arg eq 'input') {
10926: if ($env{'form.inhibitmenu'}) {
10927: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10928: } else {
10929: return
10930: }
10931: }
10932: if ($env{'form.inhibitmenu'}) {
10933: if (ref($arg)) {
10934: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10935: } elsif ($arg eq '') {
10936: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10937: } else {
10938: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10939: }
10940: }
10941: if (!ref($arg)) {
10942: return $arg;
10943: }
10944: }
10945:
1.251 albertel 10946: ###############################################
1.182 matthew 10947:
10948: =pod
10949:
1.549 albertel 10950: =back
10951:
10952: =head1 User Information Routines
10953:
10954: =over 4
10955:
1.405 albertel 10956: =item * &get_users_function()
1.182 matthew 10957:
10958: Used by &bodytag to determine the current users primary role.
10959: Returns either 'student','coordinator','admin', or 'author'.
10960:
10961: =cut
10962:
10963: ###############################################
10964: sub get_users_function {
1.815 tempelho 10965: my $function = 'norole';
1.818 tempelho 10966: if ($env{'request.role'}=~/^(st)/) {
10967: $function='student';
10968: }
1.907 raeburn 10969: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10970: $function='coordinator';
10971: }
1.258 albertel 10972: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10973: $function='admin';
10974: }
1.826 bisitz 10975: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10976: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10977: $function='author';
10978: }
10979: return $function;
1.54 www 10980: }
1.99 www 10981:
10982: ###############################################
10983:
1.233 raeburn 10984: =pod
10985:
1.821 raeburn 10986: =item * &show_course()
10987:
10988: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10989: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10990:
10991: Inputs:
10992: None
10993:
10994: Outputs:
10995: Scalar: 1 if 'Course' to be used, 0 otherwise.
10996:
10997: =cut
10998:
10999: ###############################################
11000: sub show_course {
1.1408 raeburn 11001: my ($udom,$uname) = @_;
11002: if (($udom ne '') && ($uname ne '')) {
11003: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 11004: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 11005: return 0;
11006: } else {
11007: return 1;
11008: }
11009: }
11010: }
1.821 raeburn 11011: my $course = !$env{'user.adv'};
11012: if (!$env{'user.adv'}) {
11013: foreach my $env (keys(%env)) {
11014: next if ($env !~ m/^user\.priv\./);
11015: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
11016: $course = 0;
11017: last;
11018: }
11019: }
11020: }
11021: return $course;
11022: }
11023:
11024: ###############################################
11025:
11026: =pod
11027:
1.542 raeburn 11028: =item * &check_user_status()
1.274 raeburn 11029:
11030: Determines current status of supplied role for a
11031: specific user. Roles can be active, previous or future.
11032:
11033: Inputs:
11034: user's domain, user's username, course's domain,
1.375 raeburn 11035: course's number, optional section ID.
1.274 raeburn 11036:
11037: Outputs:
11038: role status: active, previous or future.
11039:
11040: =cut
11041:
11042: sub check_user_status {
1.412 raeburn 11043: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 11044: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 11045: my @uroles = keys(%userinfo);
1.274 raeburn 11046: my $srchstr;
11047: my $active_chk = 'none';
1.412 raeburn 11048: my $now = time;
1.274 raeburn 11049: if (@uroles > 0) {
1.908 raeburn 11050: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 11051: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
11052: } else {
1.412 raeburn 11053: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
11054: }
11055: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 11056: my $role_end = 0;
11057: my $role_start = 0;
11058: $active_chk = 'active';
1.412 raeburn 11059: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
11060: $role_end = $1;
11061: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
11062: $role_start = $1;
1.274 raeburn 11063: }
11064: }
11065: if ($role_start > 0) {
1.412 raeburn 11066: if ($now < $role_start) {
1.274 raeburn 11067: $active_chk = 'future';
11068: }
11069: }
11070: if ($role_end > 0) {
1.412 raeburn 11071: if ($now > $role_end) {
1.274 raeburn 11072: $active_chk = 'previous';
11073: }
11074: }
11075: }
11076: }
11077: return $active_chk;
11078: }
11079:
11080: ###############################################
11081:
11082: =pod
11083:
1.405 albertel 11084: =item * &get_sections()
1.233 raeburn 11085:
11086: Determines all the sections for a course including
11087: sections with students and sections containing other roles.
1.419 raeburn 11088: Incoming parameters:
11089:
11090: 1. domain
11091: 2. course number
11092: 3. reference to array containing roles for which sections should
11093: be gathered (optional).
11094: 4. reference to array containing status types for which sections
11095: should be gathered (optional).
11096:
11097: If the third argument is undefined, sections are gathered for any role.
11098: If the fourth argument is undefined, sections are gathered for any status.
11099: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11100:
1.374 raeburn 11101: Returns section hash (keys are section IDs, values are
11102: number of users in each section), subject to the
1.419 raeburn 11103: optional roles filter, optional status filter
1.233 raeburn 11104:
11105: =cut
11106:
11107: ###############################################
11108: sub get_sections {
1.419 raeburn 11109: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11110: if (!defined($cdom) || !defined($cnum)) {
11111: my $cid = $env{'request.course.id'};
11112:
11113: return if (!defined($cid));
11114:
11115: $cdom = $env{'course.'.$cid.'.domain'};
11116: $cnum = $env{'course.'.$cid.'.num'};
11117: }
11118:
11119: my %sectioncount;
1.419 raeburn 11120: my $now = time;
1.240 albertel 11121:
1.1118 raeburn 11122: my $check_students = 1;
11123: my $only_students = 0;
11124: if (ref($possible_roles) eq 'ARRAY') {
11125: if (grep(/^st$/,@{$possible_roles})) {
11126: if (@{$possible_roles} == 1) {
11127: $only_students = 1;
11128: }
11129: } else {
11130: $check_students = 0;
11131: }
11132: }
11133:
11134: if ($check_students) {
1.276 albertel 11135: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11136: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11137: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11138: my $start_index = &Apache::loncoursedata::CL_START();
11139: my $end_index = &Apache::loncoursedata::CL_END();
11140: my $status;
1.366 albertel 11141: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11142: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11143: $data->[$status_index],
11144: $data->[$start_index],
11145: $data->[$end_index]);
11146: if ($stu_status eq 'Active') {
11147: $status = 'active';
11148: } elsif ($end < $now) {
11149: $status = 'previous';
11150: } elsif ($start > $now) {
11151: $status = 'future';
11152: }
11153: if ($section ne '-1' && $section !~ /^\s*$/) {
11154: if ((!defined($possible_status)) || (($status ne '') &&
11155: (grep/^\Q$status\E$/,@{$possible_status}))) {
11156: $sectioncount{$section}++;
11157: }
1.240 albertel 11158: }
11159: }
11160: }
1.1118 raeburn 11161: if ($only_students) {
11162: return %sectioncount;
11163: }
1.240 albertel 11164: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11165: foreach my $user (sort(keys(%courseroles))) {
11166: if ($user !~ /^(\w{2})/) { next; }
11167: my ($role) = ($user =~ /^(\w{2})/);
11168: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11169: my ($section,$status);
1.240 albertel 11170: if ($role eq 'cr' &&
11171: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11172: $section=$1;
11173: }
11174: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11175: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11176: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11177: if ($end == -1 && $start == -1) {
11178: next; #deleted role
11179: }
11180: if (!defined($possible_status)) {
11181: $sectioncount{$section}++;
11182: } else {
11183: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11184: $status = 'active';
11185: } elsif ($end < $now) {
11186: $status = 'future';
11187: } elsif ($start > $now) {
11188: $status = 'previous';
11189: }
11190: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11191: $sectioncount{$section}++;
11192: }
11193: }
1.233 raeburn 11194: }
1.366 albertel 11195: return %sectioncount;
1.233 raeburn 11196: }
11197:
1.274 raeburn 11198: ###############################################
1.294 raeburn 11199:
11200: =pod
1.405 albertel 11201:
11202: =item * &get_course_users()
11203:
1.275 raeburn 11204: Retrieves usernames:domains for users in the specified course
11205: with specific role(s), and access status.
11206:
11207: Incoming parameters:
1.277 albertel 11208: 1. course domain
11209: 2. course number
11210: 3. access status: users must have - either active,
1.275 raeburn 11211: previous, future, or all.
1.277 albertel 11212: 4. reference to array of permissible roles
1.288 raeburn 11213: 5. reference to array of section restrictions (optional)
11214: 6. reference to results object (hash of hashes).
11215: 7. reference to optional userdata hash
1.609 raeburn 11216: 8. reference to optional statushash
1.630 raeburn 11217: 9. flag if privileged users (except those set to unhide in
11218: course settings) should be excluded
1.609 raeburn 11219: Keys of top level results hash are roles.
1.275 raeburn 11220: Keys of inner hashes are username:domain, with
11221: values set to access type.
1.288 raeburn 11222: Optional userdata hash returns an array with arguments in the
11223: same order as loncoursedata::get_classlist() for student data.
11224:
1.609 raeburn 11225: Optional statushash returns
11226:
1.288 raeburn 11227: Entries for end, start, section and status are blank because
11228: of the possibility of multiple values for non-student roles.
11229:
1.275 raeburn 11230: =cut
1.405 albertel 11231:
1.275 raeburn 11232: ###############################################
1.405 albertel 11233:
1.275 raeburn 11234: sub get_course_users {
1.630 raeburn 11235: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11236: my %idx = ();
1.419 raeburn 11237: my %seclists;
1.288 raeburn 11238:
11239: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11240: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11241: $idx{end} = &Apache::loncoursedata::CL_END();
11242: $idx{start} = &Apache::loncoursedata::CL_START();
11243: $idx{id} = &Apache::loncoursedata::CL_ID();
11244: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11245: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11246: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11247:
1.290 albertel 11248: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11249: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11250: my $now = time;
1.277 albertel 11251: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11252: my $match = 0;
1.412 raeburn 11253: my $secmatch = 0;
1.419 raeburn 11254: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11255: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11256: if ($section eq '') {
11257: $section = 'none';
11258: }
1.291 albertel 11259: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11260: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11261: $secmatch = 1;
11262: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11263: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11264: $secmatch = 1;
11265: }
11266: } else {
1.419 raeburn 11267: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11268: $secmatch = 1;
11269: }
1.290 albertel 11270: }
1.412 raeburn 11271: if (!$secmatch) {
11272: next;
11273: }
1.419 raeburn 11274: }
1.275 raeburn 11275: if (defined($$types{'active'})) {
1.288 raeburn 11276: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11277: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11278: $match = 1;
1.275 raeburn 11279: }
11280: }
11281: if (defined($$types{'previous'})) {
1.609 raeburn 11282: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11283: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11284: $match = 1;
1.275 raeburn 11285: }
11286: }
11287: if (defined($$types{'future'})) {
1.609 raeburn 11288: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11289: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11290: $match = 1;
1.275 raeburn 11291: }
11292: }
1.609 raeburn 11293: if ($match) {
11294: push(@{$seclists{$student}},$section);
11295: if (ref($userdata) eq 'HASH') {
11296: $$userdata{$student} = $$classlist{$student};
11297: }
11298: if (ref($statushash) eq 'HASH') {
11299: $statushash->{$student}{'st'}{$section} = $status;
11300: }
1.288 raeburn 11301: }
1.275 raeburn 11302: }
11303: }
1.412 raeburn 11304: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11305: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11306: my $now = time;
1.609 raeburn 11307: my %displaystatus = ( previous => 'Expired',
11308: active => 'Active',
11309: future => 'Future',
11310: );
1.1121 raeburn 11311: my (%nothide,@possdoms);
1.630 raeburn 11312: if ($hidepriv) {
11313: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11314: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11315: if ($user !~ /:/) {
11316: $nothide{join(':',split(/[\@]/,$user))}=1;
11317: } else {
11318: $nothide{$user} = 1;
11319: }
11320: }
1.1121 raeburn 11321: my @possdoms = ($cdom);
11322: if ($coursehash{'checkforpriv'}) {
11323: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11324: }
1.630 raeburn 11325: }
1.439 raeburn 11326: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11327: my $match = 0;
1.412 raeburn 11328: my $secmatch = 0;
1.439 raeburn 11329: my $status;
1.412 raeburn 11330: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11331: $user =~ s/:$//;
1.439 raeburn 11332: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11333: if ($end == -1 || $start == -1) {
11334: next;
11335: }
11336: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11337: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11338: my ($uname,$udom) = split(/:/,$user);
11339: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11340: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11341: $secmatch = 1;
11342: } elsif ($usec eq '') {
1.420 albertel 11343: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11344: $secmatch = 1;
11345: }
11346: } else {
11347: if (grep(/^\Q$usec\E$/,@{$sections})) {
11348: $secmatch = 1;
11349: }
11350: }
11351: if (!$secmatch) {
11352: next;
11353: }
1.288 raeburn 11354: }
1.419 raeburn 11355: if ($usec eq '') {
11356: $usec = 'none';
11357: }
1.275 raeburn 11358: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11359: if ($hidepriv) {
1.1121 raeburn 11360: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11361: (!$nothide{$uname.':'.$udom})) {
11362: next;
11363: }
11364: }
1.503 raeburn 11365: if ($end > 0 && $end < $now) {
1.439 raeburn 11366: $status = 'previous';
11367: } elsif ($start > $now) {
11368: $status = 'future';
11369: } else {
11370: $status = 'active';
11371: }
1.277 albertel 11372: foreach my $type (keys(%{$types})) {
1.275 raeburn 11373: if ($status eq $type) {
1.420 albertel 11374: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11375: push(@{$$users{$role}{$user}},$type);
11376: }
1.288 raeburn 11377: $match = 1;
11378: }
11379: }
1.419 raeburn 11380: if (($match) && (ref($userdata) eq 'HASH')) {
11381: if (!exists($$userdata{$uname.':'.$udom})) {
11382: &get_user_info($udom,$uname,\%idx,$userdata);
11383: }
1.420 albertel 11384: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11385: push(@{$seclists{$uname.':'.$udom}},$usec);
11386: }
1.609 raeburn 11387: if (ref($statushash) eq 'HASH') {
11388: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11389: }
1.275 raeburn 11390: }
11391: }
11392: }
11393: }
1.290 albertel 11394: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11395: if ((defined($cdom)) && (defined($cnum))) {
11396: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11397: if ( defined($csettings{'internal.courseowner'}) ) {
11398: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11399: next if ($owner eq '');
11400: my ($ownername,$ownerdom);
11401: if ($owner =~ /^([^:]+):([^:]+)$/) {
11402: $ownername = $1;
11403: $ownerdom = $2;
11404: } else {
11405: $ownername = $owner;
11406: $ownerdom = $cdom;
11407: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11408: }
11409: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11410: if (defined($userdata) &&
1.609 raeburn 11411: !exists($$userdata{$owner})) {
11412: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11413: if (!grep(/^none$/,@{$seclists{$owner}})) {
11414: push(@{$seclists{$owner}},'none');
11415: }
11416: if (ref($statushash) eq 'HASH') {
11417: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11418: }
1.290 albertel 11419: }
1.279 raeburn 11420: }
11421: }
11422: }
1.419 raeburn 11423: foreach my $user (keys(%seclists)) {
11424: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11425: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11426: }
1.275 raeburn 11427: }
11428: return;
11429: }
11430:
1.288 raeburn 11431: sub get_user_info {
11432: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11433: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11434: &plainname($uname,$udom,'lastname');
1.291 albertel 11435: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11436: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11437: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11438: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11439: return;
11440: }
1.275 raeburn 11441:
1.472 raeburn 11442: ###############################################
11443:
11444: =pod
11445:
11446: =item * &get_user_quota()
11447:
1.1134 raeburn 11448: Retrieves quota assigned for storage of user files.
11449: Default is to report quota for portfolio files.
1.472 raeburn 11450:
11451: Incoming parameters:
11452: 1. user's username
11453: 2. user's domain
1.1134 raeburn 11454: 3. quota name - portfolio, author, or course
1.1136 raeburn 11455: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11456: 4. crstype - official, unofficial, textbook, placement or community,
11457: if quota name is course
1.472 raeburn 11458:
11459: Returns:
1.1163 raeburn 11460: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11461: 2. (Optional) Type of setting: custom or default
11462: (individually assigned or default for user's
11463: institutional status).
11464: 3. (Optional) - User's institutional status (e.g., faculty, staff
11465: or student - types as defined in localenroll::inst_usertypes
11466: for user's domain, which determines default quota for user.
11467: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11468:
11469: If a value has been stored in the user's environment,
1.536 raeburn 11470: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11471: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11472:
11473: =cut
11474:
11475: ###############################################
11476:
11477:
11478: sub get_user_quota {
1.1136 raeburn 11479: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11480: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11481: if (!defined($udom)) {
11482: $udom = $env{'user.domain'};
11483: }
11484: if (!defined($uname)) {
11485: $uname = $env{'user.name'};
11486: }
11487: if (($udom eq '' || $uname eq '') ||
11488: ($udom eq 'public') && ($uname eq 'public')) {
11489: $quota = 0;
1.536 raeburn 11490: $quotatype = 'default';
11491: $defquota = 0;
1.472 raeburn 11492: } else {
1.536 raeburn 11493: my $inststatus;
1.1134 raeburn 11494: if ($quotaname eq 'course') {
11495: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11496: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11497: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11498: } else {
11499: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11500: $quota = $cenv{'internal.uploadquota'};
11501: }
1.536 raeburn 11502: } else {
1.1134 raeburn 11503: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11504: if ($quotaname eq 'author') {
11505: $quota = $env{'environment.authorquota'};
11506: } else {
11507: $quota = $env{'environment.portfolioquota'};
11508: }
11509: $inststatus = $env{'environment.inststatus'};
11510: } else {
11511: my %userenv =
11512: &Apache::lonnet::get('environment',['portfolioquota',
11513: 'authorquota','inststatus'],$udom,$uname);
11514: my ($tmp) = keys(%userenv);
11515: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11516: if ($quotaname eq 'author') {
11517: $quota = $userenv{'authorquota'};
11518: } else {
11519: $quota = $userenv{'portfolioquota'};
11520: }
11521: $inststatus = $userenv{'inststatus'};
11522: } else {
11523: undef(%userenv);
11524: }
11525: }
11526: }
11527: if ($quota eq '' || wantarray) {
11528: if ($quotaname eq 'course') {
11529: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11530: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11531: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11532: ($crstype eq 'placement')) {
1.1136 raeburn 11533: $defquota = $domdefs{$crstype.'quota'};
11534: }
11535: if ($defquota eq '') {
11536: $defquota = 500;
11537: }
1.1134 raeburn 11538: } else {
11539: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11540: }
11541: if ($quota eq '') {
11542: $quota = $defquota;
11543: $quotatype = 'default';
11544: } else {
11545: $quotatype = 'custom';
11546: }
1.472 raeburn 11547: }
11548: }
1.536 raeburn 11549: if (wantarray) {
11550: return ($quota,$quotatype,$settingstatus,$defquota);
11551: } else {
11552: return $quota;
11553: }
1.472 raeburn 11554: }
11555:
11556: ###############################################
11557:
11558: =pod
11559:
11560: =item * &default_quota()
11561:
1.536 raeburn 11562: Retrieves default quota assigned for storage of user portfolio files,
11563: given an (optional) user's institutional status.
1.472 raeburn 11564:
11565: Incoming parameters:
1.1142 raeburn 11566:
1.472 raeburn 11567: 1. domain
1.536 raeburn 11568: 2. (Optional) institutional status(es). This is a : separated list of
11569: status types (e.g., faculty, staff, student etc.)
11570: which apply to the user for whom the default is being retrieved.
11571: If the institutional status string in undefined, the domain
1.1134 raeburn 11572: default quota will be returned.
11573: 3. quota name - portfolio, author, or course
11574: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11575:
11576: Returns:
1.1142 raeburn 11577:
1.1163 raeburn 11578: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11579: 2. (Optional) institutional type which determined the value of the
11580: default quota.
1.472 raeburn 11581:
11582: If a value has been stored in the domain's configuration db,
11583: it will return that, otherwise it returns 20 (for backwards
11584: compatibility with domains which have not set up a configuration
1.1163 raeburn 11585: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11586:
1.536 raeburn 11587: If the user's status includes multiple types (e.g., staff and student),
11588: the largest default quota which applies to the user determines the
11589: default quota returned.
11590:
1.472 raeburn 11591: =cut
11592:
11593: ###############################################
11594:
11595:
11596: sub default_quota {
1.1134 raeburn 11597: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11598: my ($defquota,$settingstatus);
11599: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11600: ['quotas'],$udom);
1.1134 raeburn 11601: my $key = 'defaultquota';
11602: if ($quotaname eq 'author') {
11603: $key = 'authorquota';
11604: }
1.622 raeburn 11605: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11606: if ($inststatus ne '') {
1.765 raeburn 11607: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11608: foreach my $item (@statuses) {
1.1134 raeburn 11609: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11610: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11611: if ($defquota eq '') {
1.1134 raeburn 11612: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11613: $settingstatus = $item;
1.1134 raeburn 11614: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11615: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11616: $settingstatus = $item;
11617: }
11618: }
1.1134 raeburn 11619: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11620: if ($quotahash{'quotas'}{$item} ne '') {
11621: if ($defquota eq '') {
11622: $defquota = $quotahash{'quotas'}{$item};
11623: $settingstatus = $item;
11624: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11625: $defquota = $quotahash{'quotas'}{$item};
11626: $settingstatus = $item;
11627: }
1.536 raeburn 11628: }
11629: }
11630: }
11631: }
11632: if ($defquota eq '') {
1.1134 raeburn 11633: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11634: $defquota = $quotahash{'quotas'}{$key}{'default'};
11635: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11636: $defquota = $quotahash{'quotas'}{'default'};
11637: }
1.536 raeburn 11638: $settingstatus = 'default';
1.1139 raeburn 11639: if ($defquota eq '') {
11640: if ($quotaname eq 'author') {
11641: $defquota = 500;
11642: }
11643: }
1.536 raeburn 11644: }
11645: } else {
11646: $settingstatus = 'default';
1.1134 raeburn 11647: if ($quotaname eq 'author') {
11648: $defquota = 500;
11649: } else {
11650: $defquota = 20;
11651: }
1.536 raeburn 11652: }
11653: if (wantarray) {
11654: return ($defquota,$settingstatus);
1.472 raeburn 11655: } else {
1.536 raeburn 11656: return $defquota;
1.472 raeburn 11657: }
11658: }
11659:
1.1135 raeburn 11660: ###############################################
11661:
11662: =pod
11663:
1.1136 raeburn 11664: =item * &excess_filesize_warning()
1.1135 raeburn 11665:
11666: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11667: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11668: space to be exceeded.
1.1136 raeburn 11669:
11670: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11671: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11672:
1.1165 raeburn 11673: Inputs: 7
1.1136 raeburn 11674: 1. username or coursenum
1.1135 raeburn 11675: 2. domain
1.1136 raeburn 11676: 3. context ('author' or 'course')
1.1135 raeburn 11677: 4. filename of file for which action is being requested
11678: 5. filesize (kB) of file
11679: 6. action being taken: copy or upload.
1.1237 raeburn 11680: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11681:
11682: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11683: otherwise return null.
11684:
11685: =back
1.1135 raeburn 11686:
11687: =cut
11688:
1.1136 raeburn 11689: sub excess_filesize_warning {
1.1165 raeburn 11690: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11691: my $current_disk_usage = 0;
1.1165 raeburn 11692: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11693: if ($context eq 'author') {
11694: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11695: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11696: } else {
11697: foreach my $subdir ('docs','supplemental') {
11698: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11699: }
11700: }
1.1135 raeburn 11701: $disk_quota = int($disk_quota * 1000);
11702: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11703: return '<p class="LC_warning">'.
1.1135 raeburn 11704: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11705: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11706: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11707: $disk_quota,$current_disk_usage).
11708: '</p>';
11709: }
11710: return;
11711: }
11712:
11713: ###############################################
11714:
11715:
1.1136 raeburn 11716:
11717:
1.384 raeburn 11718: sub get_secgrprole_info {
11719: my ($cdom,$cnum,$needroles,$type) = @_;
11720: my %sections_count = &get_sections($cdom,$cnum);
11721: my @sections = (sort {$a <=> $b} keys(%sections_count));
11722: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11723: my @groups = sort(keys(%curr_groups));
11724: my $allroles = [];
11725: my $rolehash;
11726: my $accesshash = {
11727: active => 'Currently has access',
11728: future => 'Will have future access',
11729: previous => 'Previously had access',
11730: };
11731: if ($needroles) {
11732: $rolehash = {'all' => 'all'};
1.385 albertel 11733: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11734: if (&Apache::lonnet::error(%user_roles)) {
11735: undef(%user_roles);
11736: }
11737: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11738: my ($role)=split(/\:/,$item,2);
11739: if ($role eq 'cr') { next; }
11740: if ($role =~ /^cr/) {
11741: $$rolehash{$role} = (split('/',$role))[3];
11742: } else {
11743: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11744: }
11745: }
11746: foreach my $key (sort(keys(%{$rolehash}))) {
11747: push(@{$allroles},$key);
11748: }
11749: push (@{$allroles},'st');
11750: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11751: }
11752: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11753: }
11754:
1.555 raeburn 11755: sub user_picker {
1.1279 raeburn 11756: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11757: my $currdom = $dom;
1.1253 raeburn 11758: my @alldoms = &Apache::lonnet::all_domains();
11759: if (@alldoms == 1) {
11760: my %domsrch = &Apache::lonnet::get_dom('configuration',
11761: ['directorysrch'],$alldoms[0]);
11762: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11763: my $showdom = $domdesc;
11764: if ($showdom eq '') {
11765: $showdom = $dom;
11766: }
11767: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11768: if ((!$domsrch{'directorysrch'}{'available'}) &&
11769: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11770: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11771: }
11772: }
11773: }
1.555 raeburn 11774: my %curr_selected = (
11775: srchin => 'dom',
1.580 raeburn 11776: srchby => 'lastname',
1.555 raeburn 11777: );
11778: my $srchterm;
1.625 raeburn 11779: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11780: if ($srch->{'srchby'} ne '') {
11781: $curr_selected{'srchby'} = $srch->{'srchby'};
11782: }
11783: if ($srch->{'srchin'} ne '') {
11784: $curr_selected{'srchin'} = $srch->{'srchin'};
11785: }
11786: if ($srch->{'srchtype'} ne '') {
11787: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11788: }
11789: if ($srch->{'srchdomain'} ne '') {
11790: $currdom = $srch->{'srchdomain'};
11791: }
11792: $srchterm = $srch->{'srchterm'};
11793: }
1.1222 damieng 11794: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11795: 'usr' => 'Search criteria',
1.563 raeburn 11796: 'doma' => 'Domain/institution to search',
1.558 albertel 11797: 'uname' => 'username',
11798: 'lastname' => 'last name',
1.555 raeburn 11799: 'lastfirst' => 'last name, first name',
1.558 albertel 11800: 'crs' => 'in this course',
1.576 raeburn 11801: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11802: 'alc' => 'all LON-CAPA',
1.573 raeburn 11803: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11804: 'exact' => 'is',
11805: 'contains' => 'contains',
1.569 raeburn 11806: 'begins' => 'begins with',
1.1222 damieng 11807: );
11808: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11809: 'youm' => "You must include some text to search for.",
11810: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11811: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11812: 'yomc' => "You must choose a domain when using an institutional directory search.",
11813: 'ymcd' => "You must choose a domain when using a domain search.",
11814: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11815: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11816: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11817: );
1.1222 damieng 11818: &html_escape(\%html_lt);
11819: &js_escape(\%js_lt);
1.1255 raeburn 11820: my $domform;
1.1277 raeburn 11821: my $allow_blank = 1;
1.1255 raeburn 11822: if ($fixeddom) {
1.1277 raeburn 11823: $allow_blank = 0;
11824: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11825: } else {
1.1287 raeburn 11826: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11827: my ($trusted,$untrusted);
1.1287 raeburn 11828: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11829: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11830: } elsif ($context eq 'author') {
1.1288 raeburn 11831: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11832: } elsif ($context eq 'domain') {
1.1288 raeburn 11833: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11834: }
1.1288 raeburn 11835: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11836: }
1.563 raeburn 11837: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11838:
11839: my @srchins = ('crs','dom','alc','instd');
11840:
11841: foreach my $option (@srchins) {
11842: # FIXME 'alc' option unavailable until
11843: # loncreateuser::print_user_query_page()
11844: # has been completed.
11845: next if ($option eq 'alc');
1.880 raeburn 11846: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11847: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11848: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11849: if ($curr_selected{'srchin'} eq $option) {
11850: $srchinsel .= '
1.1222 damieng 11851: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11852: } else {
11853: $srchinsel .= '
1.1222 damieng 11854: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11855: }
1.555 raeburn 11856: }
1.563 raeburn 11857: $srchinsel .= "\n </select>\n";
1.555 raeburn 11858:
11859: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11860: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11861: if ($curr_selected{'srchby'} eq $option) {
11862: $srchbysel .= '
1.1222 damieng 11863: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11864: } else {
11865: $srchbysel .= '
1.1222 damieng 11866: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11867: }
11868: }
11869: $srchbysel .= "\n </select>\n";
11870:
11871: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11872: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11873: if ($curr_selected{'srchtype'} eq $option) {
11874: $srchtypesel .= '
1.1222 damieng 11875: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11876: } else {
11877: $srchtypesel .= '
1.1222 damieng 11878: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11879: }
11880: }
11881: $srchtypesel .= "\n </select>\n";
11882:
1.558 albertel 11883: my ($newuserscript,$new_user_create);
1.994 raeburn 11884: my $context_dom = $env{'request.role.domain'};
11885: if ($context eq 'requestcrs') {
11886: if ($env{'form.coursedom'} ne '') {
11887: $context_dom = $env{'form.coursedom'};
11888: }
11889: }
1.556 raeburn 11890: if ($forcenewuser) {
1.576 raeburn 11891: if (ref($srch) eq 'HASH') {
1.994 raeburn 11892: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11893: if ($cancreate) {
11894: $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>';
11895: } else {
1.799 bisitz 11896: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11897: my %usertypetext = (
11898: official => 'institutional',
11899: unofficial => 'non-institutional',
11900: );
1.799 bisitz 11901: $new_user_create = '<p class="LC_warning">'
11902: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11903: .' '
11904: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11905: ,'<a href="'.$helplink.'">','</a>')
11906: .'</p><br />';
1.627 raeburn 11907: }
1.576 raeburn 11908: }
11909: }
11910:
1.556 raeburn 11911: $newuserscript = <<"ENDSCRIPT";
11912:
1.570 raeburn 11913: function setSearch(createnew,callingForm) {
1.556 raeburn 11914: if (createnew == 1) {
1.570 raeburn 11915: for (var i=0; i<callingForm.srchby.length; i++) {
11916: if (callingForm.srchby.options[i].value == 'uname') {
11917: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11918: }
11919: }
1.570 raeburn 11920: for (var i=0; i<callingForm.srchin.length; i++) {
11921: if ( callingForm.srchin.options[i].value == 'dom') {
11922: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11923: }
11924: }
1.570 raeburn 11925: for (var i=0; i<callingForm.srchtype.length; i++) {
11926: if (callingForm.srchtype.options[i].value == 'exact') {
11927: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11928: }
11929: }
1.570 raeburn 11930: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11931: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11932: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11933: }
11934: }
11935: }
11936: }
11937: ENDSCRIPT
1.558 albertel 11938:
1.556 raeburn 11939: }
11940:
1.555 raeburn 11941: my $output = <<"END_BLOCK";
1.556 raeburn 11942: <script type="text/javascript">
1.824 bisitz 11943: // <![CDATA[
1.570 raeburn 11944: function validateEntry(callingForm) {
1.558 albertel 11945:
1.556 raeburn 11946: var checkok = 1;
1.558 albertel 11947: var srchin;
1.570 raeburn 11948: for (var i=0; i<callingForm.srchin.length; i++) {
11949: if ( callingForm.srchin[i].checked ) {
11950: srchin = callingForm.srchin[i].value;
1.558 albertel 11951: }
11952: }
11953:
1.570 raeburn 11954: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11955: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11956: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11957: var srchterm = callingForm.srchterm.value;
11958: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11959: var msg = "";
11960:
11961: if (srchterm == "") {
11962: checkok = 0;
1.1222 damieng 11963: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11964: }
11965:
1.569 raeburn 11966: if (srchtype== 'begins') {
11967: if (srchterm.length < 2) {
11968: checkok = 0;
1.1222 damieng 11969: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11970: }
11971: }
11972:
1.556 raeburn 11973: if (srchtype== 'contains') {
11974: if (srchterm.length < 3) {
11975: checkok = 0;
1.1222 damieng 11976: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11977: }
11978: }
11979: if (srchin == 'instd') {
11980: if (srchdomain == '') {
11981: checkok = 0;
1.1222 damieng 11982: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11983: }
11984: }
11985: if (srchin == 'dom') {
11986: if (srchdomain == '') {
11987: checkok = 0;
1.1222 damieng 11988: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11989: }
11990: }
11991: if (srchby == 'lastfirst') {
11992: if (srchterm.indexOf(",") == -1) {
11993: checkok = 0;
1.1222 damieng 11994: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11995: }
11996: if (srchterm.indexOf(",") == srchterm.length -1) {
11997: checkok = 0;
1.1222 damieng 11998: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11999: }
12000: }
12001: if (checkok == 0) {
1.1222 damieng 12002: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 12003: return;
12004: }
12005: if (checkok == 1) {
1.570 raeburn 12006: callingForm.submit();
1.556 raeburn 12007: }
12008: }
12009:
12010: $newuserscript
12011:
1.824 bisitz 12012: // ]]>
1.556 raeburn 12013: </script>
1.558 albertel 12014:
12015: $new_user_create
12016:
1.555 raeburn 12017: END_BLOCK
1.558 albertel 12018:
1.876 raeburn 12019: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 12020: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 12021: $domform.
12022: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 12023: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 12024: $srchbysel.
12025: $srchtypesel.
12026: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
12027: $srchinsel.
12028: &Apache::lonhtmlcommon::row_closure(1).
12029: &Apache::lonhtmlcommon::end_pick_box().
12030: '<br />';
1.1253 raeburn 12031: return ($output,1);
1.555 raeburn 12032: }
12033:
1.612 raeburn 12034: sub user_rule_check {
1.615 raeburn 12035: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 12036: my ($response,%inst_response);
1.612 raeburn 12037: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 12038: if (keys(%{$usershash}) > 1) {
12039: my (%by_username,%by_id,%userdoms);
12040: my $checkid;
12041: if (ref($checks) eq 'HASH') {
12042: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
12043: $checkid = 1;
12044: }
12045: }
12046: foreach my $user (keys(%{$usershash})) {
12047: my ($uname,$udom) = split(/:/,$user);
12048: if ($checkid) {
12049: if (ref($usershash->{$user}) eq 'HASH') {
12050: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 12051: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 12052: $userdoms{$udom} = 1;
1.1227 raeburn 12053: if (ref($inst_results) eq 'HASH') {
12054: $inst_results->{$uname.':'.$udom} = {};
12055: }
1.1226 raeburn 12056: }
12057: }
12058: } else {
12059: $by_username{$udom}{$uname} = 1;
12060: $userdoms{$udom} = 1;
1.1227 raeburn 12061: if (ref($inst_results) eq 'HASH') {
12062: $inst_results->{$uname.':'.$udom} = {};
12063: }
1.1226 raeburn 12064: }
12065: }
12066: foreach my $udom (keys(%userdoms)) {
12067: if (!$got_rules->{$udom}) {
12068: my %domconfig = &Apache::lonnet::get_dom('configuration',
12069: ['usercreation'],$udom);
12070: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12071: foreach my $item ('username','id') {
12072: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 12073: $$curr_rules{$udom}{$item} =
12074: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 12075: }
12076: }
12077: }
12078: $got_rules->{$udom} = 1;
12079: }
1.612 raeburn 12080: }
1.1226 raeburn 12081: if ($checkid) {
12082: foreach my $udom (keys(%by_id)) {
12083: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12084: if ($outcome eq 'ok') {
1.1227 raeburn 12085: foreach my $id (keys(%{$by_id{$udom}})) {
12086: my $uname = $by_id{$udom}{$id};
12087: $inst_response{$uname.':'.$udom} = $outcome;
12088: }
1.1226 raeburn 12089: if (ref($results) eq 'HASH') {
12090: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12091: if (exists($inst_response{$uname.':'.$udom})) {
12092: $inst_response{$uname.':'.$udom} = $outcome;
12093: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12094: }
1.1226 raeburn 12095: }
12096: }
12097: }
1.612 raeburn 12098: }
1.615 raeburn 12099: } else {
1.1226 raeburn 12100: foreach my $udom (keys(%by_username)) {
12101: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12102: if ($outcome eq 'ok') {
1.1227 raeburn 12103: foreach my $uname (keys(%{$by_username{$udom}})) {
12104: $inst_response{$uname.':'.$udom} = $outcome;
12105: }
1.1226 raeburn 12106: if (ref($results) eq 'HASH') {
12107: foreach my $uname (keys(%{$results})) {
12108: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12109: }
12110: }
12111: }
12112: }
1.612 raeburn 12113: }
1.1226 raeburn 12114: } elsif (keys(%{$usershash}) == 1) {
12115: my $user = (keys(%{$usershash}))[0];
12116: my ($uname,$udom) = split(/:/,$user);
12117: if (($udom ne '') && ($uname ne '')) {
12118: if (ref($usershash->{$user}) eq 'HASH') {
12119: if (ref($checks) eq 'HASH') {
12120: if (defined($checks->{'username'})) {
12121: ($inst_response{$user},%{$inst_results->{$user}}) =
12122: &Apache::lonnet::get_instuser($udom,$uname);
12123: } elsif (defined($checks->{'id'})) {
12124: if ($usershash->{$user}->{'id'} ne '') {
12125: ($inst_response{$user},%{$inst_results->{$user}}) =
12126: &Apache::lonnet::get_instuser($udom,undef,
12127: $usershash->{$user}->{'id'});
12128: } else {
12129: ($inst_response{$user},%{$inst_results->{$user}}) =
12130: &Apache::lonnet::get_instuser($udom,$uname);
12131: }
1.585 raeburn 12132: }
1.1226 raeburn 12133: } else {
12134: ($inst_response{$user},%{$inst_results->{$user}}) =
12135: &Apache::lonnet::get_instuser($udom,$uname);
12136: return;
12137: }
12138: if (!$got_rules->{$udom}) {
12139: my %domconfig = &Apache::lonnet::get_dom('configuration',
12140: ['usercreation'],$udom);
12141: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12142: foreach my $item ('username','id') {
12143: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12144: $$curr_rules{$udom}{$item} =
12145: $domconfig{'usercreation'}{$item.'_rule'};
12146: }
12147: }
12148: }
12149: $got_rules->{$udom} = 1;
1.585 raeburn 12150: }
12151: }
1.1226 raeburn 12152: } else {
12153: return;
12154: }
12155: } else {
12156: return;
12157: }
12158: foreach my $user (keys(%{$usershash})) {
12159: my ($uname,$udom) = split(/:/,$user);
12160: next if (($udom eq '') || ($uname eq ''));
12161: my $id;
1.1227 raeburn 12162: if (ref($inst_results) eq 'HASH') {
12163: if (ref($inst_results->{$user}) eq 'HASH') {
12164: $id = $inst_results->{$user}->{'id'};
12165: }
12166: }
12167: if ($id eq '') {
12168: if (ref($usershash->{$user})) {
12169: $id = $usershash->{$user}->{'id'};
12170: }
1.585 raeburn 12171: }
1.612 raeburn 12172: foreach my $item (keys(%{$checks})) {
12173: if (ref($$curr_rules{$udom}) eq 'HASH') {
12174: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12175: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12176: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12177: $$curr_rules{$udom}{$item});
1.612 raeburn 12178: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12179: if ($rule_check{$rule}) {
12180: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12181: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12182: if (ref($inst_results) eq 'HASH') {
12183: if (ref($inst_results->{$user}) eq 'HASH') {
12184: if (keys(%{$inst_results->{$user}}) == 0) {
12185: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12186: } elsif ($item eq 'id') {
12187: if ($inst_results->{$user}->{'id'} eq '') {
12188: $$alerts{$item}{$udom}{$uname} = 1;
12189: }
1.615 raeburn 12190: }
1.612 raeburn 12191: }
12192: }
1.615 raeburn 12193: }
12194: last;
1.585 raeburn 12195: }
12196: }
12197: }
12198: }
12199: }
12200: }
12201: }
12202: }
1.612 raeburn 12203: return;
12204: }
12205:
12206: sub user_rule_formats {
12207: my ($domain,$domdesc,$curr_rules,$check) = @_;
12208: my %text = (
12209: 'username' => 'Usernames',
12210: 'id' => 'IDs',
12211: );
12212: my $output;
12213: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12214: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12215: if (@{$ruleorder} > 0) {
1.1102 raeburn 12216: $output = '<br />'.
12217: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12218: '<span class="LC_cusr_emph">','</span>',$domdesc).
12219: ' <ul>';
1.612 raeburn 12220: foreach my $rule (@{$ruleorder}) {
12221: if (ref($curr_rules) eq 'ARRAY') {
12222: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12223: if (ref($rules->{$rule}) eq 'HASH') {
12224: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12225: $rules->{$rule}{'desc'}.'</li>';
12226: }
12227: }
12228: }
12229: }
12230: $output .= '</ul>';
12231: }
12232: }
12233: return $output;
12234: }
12235:
12236: sub instrule_disallow_msg {
1.615 raeburn 12237: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12238: my $response;
12239: my %text = (
12240: item => 'username',
12241: items => 'usernames',
12242: match => 'matches',
12243: do => 'does',
12244: action => 'a username',
12245: one => 'one',
12246: );
12247: if ($count > 1) {
12248: $text{'item'} = 'usernames';
12249: $text{'match'} ='match';
12250: $text{'do'} = 'do';
12251: $text{'action'} = 'usernames',
12252: $text{'one'} = 'ones';
12253: }
12254: if ($checkitem eq 'id') {
12255: $text{'items'} = 'IDs';
12256: $text{'item'} = 'ID';
12257: $text{'action'} = 'an ID';
1.615 raeburn 12258: if ($count > 1) {
12259: $text{'item'} = 'IDs';
12260: $text{'action'} = 'IDs';
12261: }
1.612 raeburn 12262: }
1.674 bisitz 12263: $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 12264: if ($mode eq 'upload') {
12265: if ($checkitem eq 'username') {
12266: $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'}.");
12267: } elsif ($checkitem eq 'id') {
1.674 bisitz 12268: $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 12269: }
1.669 raeburn 12270: } elsif ($mode eq 'selfcreate') {
12271: if ($checkitem eq 'id') {
12272: $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.");
12273: }
1.615 raeburn 12274: } else {
12275: if ($checkitem eq 'username') {
12276: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12277: } elsif ($checkitem eq 'id') {
12278: $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.");
12279: }
1.612 raeburn 12280: }
12281: return $response;
1.585 raeburn 12282: }
12283:
1.624 raeburn 12284: sub personal_data_fieldtitles {
12285: my %fieldtitles = &Apache::lonlocal::texthash (
12286: id => 'Student/Employee ID',
12287: permanentemail => 'E-mail address',
12288: lastname => 'Last Name',
12289: firstname => 'First Name',
12290: middlename => 'Middle Name',
12291: generation => 'Generation',
12292: gen => 'Generation',
1.765 raeburn 12293: inststatus => 'Affiliation',
1.624 raeburn 12294: );
12295: return %fieldtitles;
12296: }
12297:
1.642 raeburn 12298: sub sorted_inst_types {
12299: my ($dom) = @_;
1.1185 raeburn 12300: my ($usertypes,$order);
12301: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12302: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12303: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12304: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12305: } else {
12306: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12307: }
1.642 raeburn 12308: my $othertitle = &mt('All users');
12309: if ($env{'request.course.id'}) {
1.668 raeburn 12310: $othertitle = &mt('Any users');
1.642 raeburn 12311: }
12312: my @types;
12313: if (ref($order) eq 'ARRAY') {
12314: @types = @{$order};
12315: }
12316: if (@types == 0) {
12317: if (ref($usertypes) eq 'HASH') {
12318: @types = sort(keys(%{$usertypes}));
12319: }
12320: }
12321: if (keys(%{$usertypes}) > 0) {
12322: $othertitle = &mt('Other users');
12323: }
12324: return ($othertitle,$usertypes,\@types);
12325: }
12326:
1.645 raeburn 12327: sub get_institutional_codes {
1.1361 raeburn 12328: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12329: # Get complete list of course sections to update
12330: my @currsections = ();
12331: my @currxlists = ();
1.1361 raeburn 12332: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12333: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12334: my $crskey = $crs.':'.$coursecode;
12335: @{$unclutteredsec{$crskey}} = ();
12336: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12337:
12338: if ($$settings{'internal.sectionnums'} ne '') {
12339: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12340: }
12341:
12342: if ($$settings{'internal.crosslistings'} ne '') {
12343: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12344: }
12345:
12346: if (@currxlists > 0) {
1.1361 raeburn 12347: foreach my $xl (@currxlists) {
12348: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12349: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12350: push(@{$allcourses},$1);
1.645 raeburn 12351: $$LC_code{$1} = $2;
12352: }
12353: }
12354: }
12355: }
1.1361 raeburn 12356:
1.645 raeburn 12357: if (@currsections > 0) {
1.1361 raeburn 12358: foreach my $sec (@currsections) {
12359: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12360: my $instsec = $1;
1.645 raeburn 12361: my $lc_sec = $2;
1.1361 raeburn 12362: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12363: push(@{$unclutteredsec{$crskey}},$instsec);
12364: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12365: }
12366: }
12367: }
12368: }
12369:
12370: if (@{$unclutteredsec{$crskey}} > 0) {
12371: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12372: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12373: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12374: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12375: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12376: push(@{$allcourses},$sec);
1.1361 raeburn 12377: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12378: }
12379: }
12380: }
12381: }
12382: return;
12383: }
12384:
1.971 raeburn 12385: sub get_standard_codeitems {
12386: return ('Year','Semester','Department','Number','Section');
12387: }
12388:
1.112 bowersj2 12389: =pod
12390:
1.780 raeburn 12391: =head1 Slot Helpers
12392:
12393: =over 4
12394:
12395: =item * sorted_slots()
12396:
1.1040 raeburn 12397: Sorts an array of slot names in order of an optional sort key,
12398: default sort is by slot start time (earliest first).
1.780 raeburn 12399:
12400: Inputs:
12401:
12402: =over 4
12403:
12404: slotsarr - Reference to array of unsorted slot names.
12405:
12406: slots - Reference to hash of hash, where outer hash keys are slot names.
12407:
1.1040 raeburn 12408: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12409:
1.549 albertel 12410: =back
12411:
1.780 raeburn 12412: Returns:
12413:
12414: =over 4
12415:
1.1040 raeburn 12416: sorted - An array of slot names sorted by a specified sort key
12417: (default sort key is start time of the slot).
1.780 raeburn 12418:
12419: =back
12420:
12421: =cut
12422:
12423:
12424: sub sorted_slots {
1.1040 raeburn 12425: my ($slotsarr,$slots,$sortkey) = @_;
12426: if ($sortkey eq '') {
12427: $sortkey = 'starttime';
12428: }
1.780 raeburn 12429: my @sorted;
12430: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12431: @sorted =
12432: sort {
12433: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12434: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12435: }
12436: if (ref($slots->{$a})) { return -1;}
12437: if (ref($slots->{$b})) { return 1;}
12438: return 0;
12439: } @{$slotsarr};
12440: }
12441: return @sorted;
12442: }
12443:
1.1040 raeburn 12444: =pod
12445:
12446: =item * get_future_slots()
12447:
12448: Inputs:
12449:
12450: =over 4
12451:
12452: cnum - course number
12453:
12454: cdom - course domain
12455:
12456: now - current UNIX time
12457:
12458: symb - optional symb
12459:
12460: =back
12461:
12462: Returns:
12463:
12464: =over 4
12465:
12466: sorted_reservable - ref to array of student_schedulable slots currently
12467: reservable, ordered by end date of reservation period.
12468:
12469: reservable_now - ref to hash of student_schedulable slots currently
12470: reservable.
12471:
12472: Keys in inner hash are:
12473: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12474: (b) endreserve: end date of reservation period.
12475: (c) uniqueperiod: start,end dates when slot is to be uniquely
12476: selected.
1.1040 raeburn 12477:
12478: sorted_future - ref to array of student_schedulable slots reservable in
12479: the future, ordered by start date of reservation period.
12480:
12481: future_reservable - ref to hash of student_schedulable slots reservable
12482: in the future.
12483:
12484: Keys in inner hash are:
12485: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12486: (b) startreserve: start date of reservation period.
12487: (c) uniqueperiod: start,end dates when slot is to be uniquely
12488: selected.
1.1040 raeburn 12489:
12490: =back
12491:
12492: =cut
12493:
12494: sub get_future_slots {
12495: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12496: my $map;
12497: if ($symb) {
12498: ($map) = &Apache::lonnet::decode_symb($symb);
12499: }
1.1040 raeburn 12500: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12501: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12502: foreach my $slot (keys(%slots)) {
12503: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12504: if ($symb) {
1.1229 raeburn 12505: if ($slots{$slot}->{'symb'} ne '') {
12506: my $canuse;
12507: my %oksymbs;
12508: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12509: map { $oksymbs{$_} = 1; } @slotsymbs;
12510: if ($oksymbs{$symb}) {
12511: $canuse = 1;
12512: } else {
12513: foreach my $item (@slotsymbs) {
12514: if ($item =~ /\.(page|sequence)$/) {
12515: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12516: if (($map ne '') && ($map eq $sloturl)) {
12517: $canuse = 1;
12518: last;
12519: }
12520: }
12521: }
12522: }
12523: next unless ($canuse);
12524: }
1.1040 raeburn 12525: }
12526: if (($slots{$slot}->{'starttime'} > $now) &&
12527: ($slots{$slot}->{'endtime'} > $now)) {
12528: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12529: my $userallowed = 0;
12530: if ($slots{$slot}->{'allowedsections'}) {
12531: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12532: if (!defined($env{'request.role.sec'})
12533: && grep(/^No section assigned$/,@allowed_sec)) {
12534: $userallowed=1;
12535: } else {
12536: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12537: $userallowed=1;
12538: }
12539: }
12540: unless ($userallowed) {
12541: if (defined($env{'request.course.groups'})) {
12542: my @groups = split(/:/,$env{'request.course.groups'});
12543: foreach my $group (@groups) {
12544: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12545: $userallowed=1;
12546: last;
12547: }
12548: }
12549: }
12550: }
12551: }
12552: if ($slots{$slot}->{'allowedusers'}) {
12553: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12554: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12555: if (grep(/^\Q$user\E$/,@allowed_users)) {
12556: $userallowed = 1;
12557: }
12558: }
12559: next unless($userallowed);
12560: }
12561: my $startreserve = $slots{$slot}->{'startreserve'};
12562: my $endreserve = $slots{$slot}->{'endreserve'};
12563: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12564: my $uniqueperiod;
12565: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12566: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12567: }
1.1040 raeburn 12568: if (($startreserve < $now) &&
12569: (!$endreserve || $endreserve > $now)) {
12570: my $lastres = $endreserve;
12571: if (!$lastres) {
12572: $lastres = $slots{$slot}->{'starttime'};
12573: }
12574: $reservable_now{$slot} = {
12575: symb => $symb,
1.1250 raeburn 12576: endreserve => $lastres,
12577: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12578: };
12579: } elsif (($startreserve > $now) &&
12580: (!$endreserve || $endreserve > $startreserve)) {
12581: $future_reservable{$slot} = {
12582: symb => $symb,
1.1250 raeburn 12583: startreserve => $startreserve,
12584: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12585: };
12586: }
12587: }
12588: }
12589: my @unsorted_reservable = keys(%reservable_now);
12590: if (@unsorted_reservable > 0) {
12591: @sorted_reservable =
12592: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12593: }
12594: my @unsorted_future = keys(%future_reservable);
12595: if (@unsorted_future > 0) {
12596: @sorted_future =
12597: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12598: }
12599: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12600: }
1.780 raeburn 12601:
12602: =pod
12603:
1.1057 foxr 12604: =back
12605:
1.549 albertel 12606: =head1 HTTP Helpers
12607:
12608: =over 4
12609:
1.648 raeburn 12610: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12611:
1.258 albertel 12612: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12613: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12614: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12615:
12616: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12617: $possible_names is an ref to an array of form element names. As an example:
12618: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12619: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12620:
12621: =cut
1.1 albertel 12622:
1.6 albertel 12623: sub get_unprocessed_cgi {
1.25 albertel 12624: my ($query,$possible_names)= @_;
1.26 matthew 12625: # $Apache::lonxml::debug=1;
1.356 albertel 12626: foreach my $pair (split(/&/,$query)) {
12627: my ($name, $value) = split(/=/,$pair);
1.369 www 12628: $name = &unescape($name);
1.25 albertel 12629: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12630: $value =~ tr/+/ /;
12631: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12632: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12633: }
1.16 harris41 12634: }
1.6 albertel 12635: }
12636:
1.112 bowersj2 12637: =pod
12638:
1.648 raeburn 12639: =item * &cacheheader()
1.112 bowersj2 12640:
12641: returns cache-controlling header code
12642:
12643: =cut
12644:
1.7 albertel 12645: sub cacheheader {
1.258 albertel 12646: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12647: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12648: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12649: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12650: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12651: return $output;
1.7 albertel 12652: }
12653:
1.112 bowersj2 12654: =pod
12655:
1.648 raeburn 12656: =item * &no_cache($r)
1.112 bowersj2 12657:
12658: specifies header code to not have cache
12659:
12660: =cut
12661:
1.9 albertel 12662: sub no_cache {
1.216 albertel 12663: my ($r) = @_;
12664: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12665: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12666: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12667: $r->no_cache(1);
12668: $r->header_out("Expires" => $date);
12669: $r->header_out("Pragma" => "no-cache");
1.123 www 12670: }
12671:
12672: sub content_type {
1.181 albertel 12673: my ($r,$type,$charset) = @_;
1.299 foxr 12674: if ($r) {
12675: # Note that printout.pl calls this with undef for $r.
12676: &no_cache($r);
12677: }
1.258 albertel 12678: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12679: unless ($charset) {
12680: $charset=&Apache::lonlocal::current_encoding;
12681: }
12682: if ($charset) { $type.='; charset='.$charset; }
12683: if ($r) {
12684: $r->content_type($type);
12685: } else {
12686: print("Content-type: $type\n\n");
12687: }
1.9 albertel 12688: }
1.25 albertel 12689:
1.112 bowersj2 12690: =pod
12691:
1.648 raeburn 12692: =item * &add_to_env($name,$value)
1.112 bowersj2 12693:
1.258 albertel 12694: adds $name to the %env hash with value
1.112 bowersj2 12695: $value, if $name already exists, the entry is converted to an array
12696: reference and $value is added to the array.
12697:
12698: =cut
12699:
1.25 albertel 12700: sub add_to_env {
12701: my ($name,$value)=@_;
1.258 albertel 12702: if (defined($env{$name})) {
12703: if (ref($env{$name})) {
1.25 albertel 12704: #already have multiple values
1.258 albertel 12705: push(@{ $env{$name} },$value);
1.25 albertel 12706: } else {
12707: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12708: my $first=$env{$name};
12709: undef($env{$name});
12710: push(@{ $env{$name} },$first,$value);
1.25 albertel 12711: }
12712: } else {
1.258 albertel 12713: $env{$name}=$value;
1.25 albertel 12714: }
1.31 albertel 12715: }
1.149 albertel 12716:
12717: =pod
12718:
1.648 raeburn 12719: =item * &get_env_multiple($name)
1.149 albertel 12720:
1.258 albertel 12721: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12722: values may be defined and end up as an array ref.
12723:
12724: returns an array of values
12725:
12726: =cut
12727:
12728: sub get_env_multiple {
12729: my ($name) = @_;
12730: my @values;
1.258 albertel 12731: if (defined($env{$name})) {
1.149 albertel 12732: # exists is it an array
1.258 albertel 12733: if (ref($env{$name})) {
12734: @values=@{ $env{$name} };
1.149 albertel 12735: } else {
1.258 albertel 12736: $values[0]=$env{$name};
1.149 albertel 12737: }
12738: }
12739: return(@values);
12740: }
12741:
1.1249 damieng 12742: # Looks at given dependencies, and returns something depending on the context.
12743: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12744: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12745: # For all other contexts, returns ($output, $counter, $numpathchg).
12746: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12747: # $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.
12748: # $numpathchg: integer with the number of cleaned up dependency paths.
12749: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12750: # \%mapping: hash reference clean path -> original path for all dependencies.
12751: # @param {string} actionurl - The path to the handler, indicative of the context.
12752: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12753: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12754: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12755: # @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)
12756: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12757: sub ask_for_embedded_content {
1.1249 damieng 12758: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12759: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12760: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12761: %currsubfile,%unused,$rem);
1.1071 raeburn 12762: my $counter = 0;
12763: my $numnew = 0;
1.987 raeburn 12764: my $numremref = 0;
12765: my $numinvalid = 0;
12766: my $numpathchg = 0;
12767: my $numexisting = 0;
1.1071 raeburn 12768: my $numunused = 0;
12769: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12770: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12771: my $heading = &mt('Upload embedded files');
12772: my $buttontext = &mt('Upload');
12773:
1.1249 damieng 12774: # fills these variables based on the context:
12775: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12776: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12777: if ($env{'request.course.id'}) {
1.1123 raeburn 12778: if ($actionurl eq '/adm/dependencies') {
12779: $navmap = Apache::lonnavmaps::navmap->new();
12780: }
12781: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12782: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12783: }
1.1123 raeburn 12784: if (($actionurl eq '/adm/portfolio') ||
12785: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12786: my $current_path='/';
12787: if ($env{'form.currentpath'}) {
12788: $current_path = $env{'form.currentpath'};
12789: }
12790: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12791: $udom = $cdom;
12792: $uname = $cnum;
1.984 raeburn 12793: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12794: } else {
12795: $udom = $env{'user.domain'};
12796: $uname = $env{'user.name'};
12797: $url = '/userfiles/portfolio';
12798: }
1.987 raeburn 12799: $toplevel = $url.'/';
1.984 raeburn 12800: $url .= $current_path;
12801: $getpropath = 1;
1.987 raeburn 12802: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12803: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12804: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12805: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12806: $toplevel = $url;
1.984 raeburn 12807: if ($rest ne '') {
1.987 raeburn 12808: $url .= $rest;
12809: }
12810: } elsif ($actionurl eq '/adm/coursedocs') {
12811: if (ref($args) eq 'HASH') {
1.1071 raeburn 12812: $url = $args->{'docs_url'};
12813: $toplevel = $url;
1.1084 raeburn 12814: if ($args->{'context'} eq 'paste') {
12815: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12816: ($path) =
12817: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12818: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12819: $fileloc =~ s{^/}{};
12820: }
1.1071 raeburn 12821: }
1.1084 raeburn 12822: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12823: if ($env{'request.course.id'} ne '') {
12824: if (ref($args) eq 'HASH') {
12825: $url = $args->{'docs_url'};
12826: $title = $args->{'docs_title'};
1.1126 raeburn 12827: $toplevel = $url;
12828: unless ($toplevel =~ m{^/}) {
12829: $toplevel = "/$url";
12830: }
1.1085 raeburn 12831: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12832: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12833: $path = $1;
12834: } else {
12835: ($path) =
12836: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12837: }
1.1195 raeburn 12838: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12839: $fileloc = $toplevel;
12840: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12841: my ($udom,$uname,$fname) =
12842: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12843: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12844: } else {
12845: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12846: }
1.1071 raeburn 12847: $fileloc =~ s{^/}{};
12848: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12849: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12850: }
1.987 raeburn 12851: }
1.1123 raeburn 12852: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12853: $udom = $cdom;
12854: $uname = $cnum;
12855: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12856: $toplevel = $url;
12857: $path = $url;
12858: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12859: $fileloc =~ s{^/}{};
1.987 raeburn 12860: }
1.1249 damieng 12861:
12862: # parses the dependency paths to get some info
12863: # fills $newfiles, $mapping, $subdependencies, $dependencies
12864: # $newfiles: hash URL -> 1 for new files or external URLs
12865: # (will be completed later)
12866: # $mapping:
12867: # for external URLs: external URL -> external URL
12868: # for relative paths: clean path -> original path
12869: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12870: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12871: foreach my $file (keys(%{$allfiles})) {
12872: my $embed_file;
12873: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12874: $embed_file = $1;
12875: } else {
12876: $embed_file = $file;
12877: }
1.1158 raeburn 12878: my ($absolutepath,$cleaned_file);
12879: if ($embed_file =~ m{^\w+://}) {
12880: $cleaned_file = $embed_file;
1.1147 raeburn 12881: $newfiles{$cleaned_file} = 1;
12882: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12883: } else {
1.1158 raeburn 12884: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12885: if ($embed_file =~ m{^/}) {
12886: $absolutepath = $embed_file;
12887: }
1.1147 raeburn 12888: if ($cleaned_file =~ m{/}) {
12889: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12890: $path = &check_for_traversal($path,$url,$toplevel);
12891: my $item = $fname;
12892: if ($path ne '') {
12893: $item = $path.'/'.$fname;
12894: $subdependencies{$path}{$fname} = 1;
12895: } else {
12896: $dependencies{$item} = 1;
12897: }
12898: if ($absolutepath) {
12899: $mapping{$item} = $absolutepath;
12900: } else {
12901: $mapping{$item} = $embed_file;
12902: }
12903: } else {
12904: $dependencies{$embed_file} = 1;
12905: if ($absolutepath) {
1.1147 raeburn 12906: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12907: } else {
1.1147 raeburn 12908: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12909: }
12910: }
1.984 raeburn 12911: }
12912: }
1.1249 damieng 12913:
12914: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12915: # and lists
12916: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12917: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12918: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12919: # the path had to be cleaned up
12920: # $existing: hash clean path -> 1 if the file exists
12921: # $numexisting: number of keys in $existing
12922: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12923: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12924: # dependency subdirectories that are
12925: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12926: my $dirptr = 16384;
1.984 raeburn 12927: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12928: $currsubfile{$path} = {};
1.1123 raeburn 12929: if (($actionurl eq '/adm/portfolio') ||
12930: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12931: my ($sublistref,$listerror) =
12932: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12933: if (ref($sublistref) eq 'ARRAY') {
12934: foreach my $line (@{$sublistref}) {
12935: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12936: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12937: }
1.984 raeburn 12938: }
1.987 raeburn 12939: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12940: if (opendir(my $dir,$url.'/'.$path)) {
12941: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12942: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12943: }
1.1084 raeburn 12944: } elsif (($actionurl eq '/adm/dependencies') ||
12945: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12946: ($args->{'context'} eq 'paste')) ||
12947: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12948: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12949: my $dir;
12950: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12951: $dir = $fileloc;
12952: } else {
12953: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12954: }
1.1071 raeburn 12955: if ($dir ne '') {
12956: my ($sublistref,$listerror) =
12957: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12958: if (ref($sublistref) eq 'ARRAY') {
12959: foreach my $line (@{$sublistref}) {
12960: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12961: undef,$mtime)=split(/\&/,$line,12);
12962: unless (($testdir&$dirptr) ||
12963: ($file_name =~ /^\.\.?$/)) {
12964: $currsubfile{$path}{$file_name} = [$size,$mtime];
12965: }
12966: }
12967: }
12968: }
1.984 raeburn 12969: }
12970: }
12971: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12972: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12973: my $item = $path.'/'.$file;
12974: unless ($mapping{$item} eq $item) {
12975: $pathchanges{$item} = 1;
12976: }
12977: $existing{$item} = 1;
12978: $numexisting ++;
12979: } else {
12980: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12981: }
12982: }
1.1071 raeburn 12983: if ($actionurl eq '/adm/dependencies') {
12984: foreach my $path (keys(%currsubfile)) {
12985: if (ref($currsubfile{$path}) eq 'HASH') {
12986: foreach my $file (keys(%{$currsubfile{$path}})) {
12987: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12988: next if (($rem ne '') &&
12989: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12990: (ref($navmap) &&
12991: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12992: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12993: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12994: $unused{$path.'/'.$file} = 1;
12995: }
12996: }
12997: }
12998: }
12999: }
1.984 raeburn 13000: }
1.1249 damieng 13001:
13002: # fills $currfile, hash file name -> 1 or [$size,$mtime]
13003: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 13004: my %currfile;
1.1123 raeburn 13005: if (($actionurl eq '/adm/portfolio') ||
13006: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 13007: my ($dirlistref,$listerror) =
13008: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
13009: if (ref($dirlistref) eq 'ARRAY') {
13010: foreach my $line (@{$dirlistref}) {
13011: my ($file_name,$rest) = split(/\&/,$line,2);
13012: $currfile{$file_name} = 1;
13013: }
1.984 raeburn 13014: }
1.987 raeburn 13015: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 13016: if (opendir(my $dir,$url)) {
1.987 raeburn 13017: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 13018: map {$currfile{$_} = 1;} @dir_list;
13019: }
1.1084 raeburn 13020: } elsif (($actionurl eq '/adm/dependencies') ||
13021: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 13022: ($args->{'context'} eq 'paste')) ||
13023: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 13024: if ($env{'request.course.id'} ne '') {
13025: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
13026: if ($dir ne '') {
13027: my ($dirlistref,$listerror) =
13028: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
13029: if (ref($dirlistref) eq 'ARRAY') {
13030: foreach my $line (@{$dirlistref}) {
13031: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
13032: $size,undef,$mtime)=split(/\&/,$line,12);
13033: unless (($testdir&$dirptr) ||
13034: ($file_name =~ /^\.\.?$/)) {
13035: $currfile{$file_name} = [$size,$mtime];
13036: }
13037: }
13038: }
13039: }
13040: }
1.984 raeburn 13041: }
1.1249 damieng 13042: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
13043: # are not in subdirectories, using $currfile
1.984 raeburn 13044: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 13045: if (exists($currfile{$file})) {
1.987 raeburn 13046: unless ($mapping{$file} eq $file) {
13047: $pathchanges{$file} = 1;
13048: }
13049: $existing{$file} = 1;
13050: $numexisting ++;
13051: } else {
1.984 raeburn 13052: $newfiles{$file} = 1;
13053: }
13054: }
1.1071 raeburn 13055: foreach my $file (keys(%currfile)) {
13056: unless (($file eq $filename) ||
13057: ($file eq $filename.'.bak') ||
13058: ($dependencies{$file})) {
1.1085 raeburn 13059: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 13060: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
13061: next if (($rem ne '') &&
13062: (($env{"httpref.$rem".$file} ne '') ||
13063: (ref($navmap) &&
13064: (($navmap->getResourceByUrl($rem.$file) ne '') ||
13065: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13066: ($navmap->getResourceByUrl($rem.$1)))))));
13067: }
1.1085 raeburn 13068: }
1.1071 raeburn 13069: $unused{$file} = 1;
13070: }
13071: }
1.1249 damieng 13072:
13073: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 13074: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
13075: ($args->{'context'} eq 'paste')) {
13076: $counter = scalar(keys(%existing));
13077: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 13078: return ($output,$counter,$numpathchg,\%existing);
13079: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
13080: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
13081: $counter = scalar(keys(%existing));
13082: $numpathchg = scalar(keys(%pathchanges));
13083: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13084: }
1.1249 damieng 13085:
13086: # returns HTML otherwise, with dependency results and to ask for more uploads
13087:
13088: # $upload_output: missing dependencies (with upload form)
13089: # $modify_output: uploaded dependencies (in use)
13090: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13091: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13092: if ($actionurl eq '/adm/dependencies') {
13093: next if ($embed_file =~ m{^\w+://});
13094: }
1.660 raeburn 13095: $upload_output .= &start_data_table_row().
1.1123 raeburn 13096: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13097: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13098: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13099: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13100: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13101: }
1.1123 raeburn 13102: $upload_output .= '</td>';
1.1071 raeburn 13103: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13104: $upload_output.='<td align="right">'.
13105: '<span class="LC_info LC_fontsize_medium">'.
13106: &mt("URL points to web address").'</span>';
1.987 raeburn 13107: $numremref++;
1.660 raeburn 13108: } elsif ($args->{'error_on_invalid_names'}
13109: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13110: $upload_output.='<td align="right"><span class="LC_warning">'.
13111: &mt('Invalid characters').'</span>';
1.987 raeburn 13112: $numinvalid++;
1.660 raeburn 13113: } else {
1.1123 raeburn 13114: $upload_output .= '<td>'.
13115: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13116: $embed_file,\%mapping,
1.1071 raeburn 13117: $allfiles,$codebase,'upload');
13118: $counter ++;
13119: $numnew ++;
1.987 raeburn 13120: }
13121: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13122: }
13123: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13124: if ($actionurl eq '/adm/dependencies') {
13125: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13126: $modify_output .= &start_data_table_row().
13127: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13128: '<img src="'.&icon($embed_file).'" border="0" />'.
13129: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13130: '<td>'.$size.'</td>'.
13131: '<td>'.$mtime.'</td>'.
13132: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13133: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13134: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13135: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13136: &embedded_file_element('upload_embedded',$counter,
13137: $embed_file,\%mapping,
13138: $allfiles,$codebase,'modify').
13139: '</div></td>'.
13140: &end_data_table_row()."\n";
13141: $counter ++;
13142: } else {
13143: $upload_output .= &start_data_table_row().
1.1123 raeburn 13144: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13145: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13146: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13147: &Apache::loncommon::end_data_table_row()."\n";
13148: }
13149: }
13150: my $delidx = $counter;
13151: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13152: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13153: $delete_output .= &start_data_table_row().
13154: '<td><img src="'.&icon($oldfile).'" />'.
13155: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13156: '<td>'.$size.'</td>'.
13157: '<td>'.$mtime.'</td>'.
13158: '<td><label><input type="checkbox" name="del_upload_dep" '.
13159: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13160: &embedded_file_element('upload_embedded',$delidx,
13161: $oldfile,\%mapping,$allfiles,
13162: $codebase,'delete').'</td>'.
13163: &end_data_table_row()."\n";
13164: $numunused ++;
13165: $delidx ++;
1.987 raeburn 13166: }
13167: if ($upload_output) {
13168: $upload_output = &start_data_table().
13169: $upload_output.
13170: &end_data_table()."\n";
13171: }
1.1071 raeburn 13172: if ($modify_output) {
13173: $modify_output = &start_data_table().
13174: &start_data_table_header_row().
13175: '<th>'.&mt('File').'</th>'.
13176: '<th>'.&mt('Size (KB)').'</th>'.
13177: '<th>'.&mt('Modified').'</th>'.
13178: '<th>'.&mt('Upload replacement?').'</th>'.
13179: &end_data_table_header_row().
13180: $modify_output.
13181: &end_data_table()."\n";
13182: }
13183: if ($delete_output) {
13184: $delete_output = &start_data_table().
13185: &start_data_table_header_row().
13186: '<th>'.&mt('File').'</th>'.
13187: '<th>'.&mt('Size (KB)').'</th>'.
13188: '<th>'.&mt('Modified').'</th>'.
13189: '<th>'.&mt('Delete?').'</th>'.
13190: &end_data_table_header_row().
13191: $delete_output.
13192: &end_data_table()."\n";
13193: }
1.987 raeburn 13194: my $applies = 0;
13195: if ($numremref) {
13196: $applies ++;
13197: }
13198: if ($numinvalid) {
13199: $applies ++;
13200: }
13201: if ($numexisting) {
13202: $applies ++;
13203: }
1.1071 raeburn 13204: if ($counter || $numunused) {
1.987 raeburn 13205: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13206: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13207: $state.'<h3>'.$heading.'</h3>';
13208: if ($actionurl eq '/adm/dependencies') {
13209: if ($numnew) {
13210: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13211: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13212: $upload_output.'<br />'."\n";
13213: }
13214: if ($numexisting) {
13215: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13216: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13217: $modify_output.'<br />'."\n";
13218: $buttontext = &mt('Save changes');
13219: }
13220: if ($numunused) {
13221: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13222: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13223: $delete_output.'<br />'."\n";
13224: $buttontext = &mt('Save changes');
13225: }
13226: } else {
13227: $output .= $upload_output.'<br />'."\n";
13228: }
13229: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13230: $counter.'" />'."\n";
13231: if ($actionurl eq '/adm/dependencies') {
13232: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13233: $numnew.'" />'."\n";
13234: } elsif ($actionurl eq '') {
1.987 raeburn 13235: $output .= '<input type="hidden" name="phase" value="three" />';
13236: }
13237: } elsif ($applies) {
13238: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13239: if ($applies > 1) {
13240: $output .=
1.1123 raeburn 13241: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13242: if ($numremref) {
13243: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13244: }
13245: if ($numinvalid) {
13246: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13247: }
13248: if ($numexisting) {
13249: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13250: }
13251: $output .= '</ul><br />';
13252: } elsif ($numremref) {
13253: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13254: } elsif ($numinvalid) {
13255: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13256: } elsif ($numexisting) {
13257: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13258: }
13259: $output .= $upload_output.'<br />';
13260: }
13261: my ($pathchange_output,$chgcount);
1.1071 raeburn 13262: $chgcount = $counter;
1.987 raeburn 13263: if (keys(%pathchanges) > 0) {
13264: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13265: if ($counter) {
1.987 raeburn 13266: $output .= &embedded_file_element('pathchange',$chgcount,
13267: $embed_file,\%mapping,
1.1071 raeburn 13268: $allfiles,$codebase,'change');
1.987 raeburn 13269: } else {
13270: $pathchange_output .=
13271: &start_data_table_row().
13272: '<td><input type ="checkbox" name="namechange" value="'.
13273: $chgcount.'" checked="checked" /></td>'.
13274: '<td>'.$mapping{$embed_file}.'</td>'.
13275: '<td>'.$embed_file.
13276: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13277: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13278: '</td>'.&end_data_table_row();
1.660 raeburn 13279: }
1.987 raeburn 13280: $numpathchg ++;
13281: $chgcount ++;
1.660 raeburn 13282: }
13283: }
1.1127 raeburn 13284: if (($counter) || ($numunused)) {
1.987 raeburn 13285: if ($numpathchg) {
13286: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13287: $numpathchg.'" />'."\n";
13288: }
13289: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13290: ($actionurl eq '/adm/imsimport')) {
13291: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13292: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13293: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13294: } elsif ($actionurl eq '/adm/dependencies') {
13295: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13296: }
1.1123 raeburn 13297: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13298: } elsif ($numpathchg) {
13299: my %pathchange = ();
13300: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13301: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13302: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13303: }
1.987 raeburn 13304: }
1.1071 raeburn 13305: return ($output,$counter,$numpathchg);
1.987 raeburn 13306: }
13307:
1.1147 raeburn 13308: =pod
13309:
13310: =item * clean_path($name)
13311:
13312: Performs clean-up of directories, subdirectories and filename in an
13313: embedded object, referenced in an HTML file which is being uploaded
13314: to a course or portfolio, where
13315: "Upload embedded images/multimedia files if HTML file" checkbox was
13316: checked.
13317:
13318: Clean-up is similar to replacements in lonnet::clean_filename()
13319: except each / between sub-directory and next level is preserved.
13320:
13321: =cut
13322:
13323: sub clean_path {
13324: my ($embed_file) = @_;
13325: $embed_file =~s{^/+}{};
13326: my @contents;
13327: if ($embed_file =~ m{/}) {
13328: @contents = split(/\//,$embed_file);
13329: } else {
13330: @contents = ($embed_file);
13331: }
13332: my $lastidx = scalar(@contents)-1;
13333: for (my $i=0; $i<=$lastidx; $i++) {
13334: $contents[$i]=~s{\\}{/}g;
13335: $contents[$i]=~s/\s+/\_/g;
13336: $contents[$i]=~s{[^/\w\.\-]}{}g;
13337: if ($i == $lastidx) {
13338: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13339: }
13340: }
13341: if ($lastidx > 0) {
13342: return join('/',@contents);
13343: } else {
13344: return $contents[0];
13345: }
13346: }
13347:
1.987 raeburn 13348: sub embedded_file_element {
1.1071 raeburn 13349: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13350: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13351: (ref($codebase) eq 'HASH'));
13352: my $output;
1.1071 raeburn 13353: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13354: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13355: }
13356: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13357: &escape($embed_file).'" />';
13358: unless (($context eq 'upload_embedded') &&
13359: ($mapping->{$embed_file} eq $embed_file)) {
13360: $output .='
13361: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13362: }
13363: my $attrib;
13364: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13365: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13366: }
13367: $output .=
13368: "\n\t\t".
13369: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13370: $attrib.'" />';
13371: if (exists($codebase->{$mapping->{$embed_file}})) {
13372: $output .=
13373: "\n\t\t".
13374: '<input name="codebase_'.$num.'" type="hidden" value="'.
13375: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13376: }
1.987 raeburn 13377: return $output;
1.660 raeburn 13378: }
13379:
1.1071 raeburn 13380: sub get_dependency_details {
13381: my ($currfile,$currsubfile,$embed_file) = @_;
13382: my ($size,$mtime,$showsize,$showmtime);
13383: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13384: if ($embed_file =~ m{/}) {
13385: my ($path,$fname) = split(/\//,$embed_file);
13386: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13387: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13388: }
13389: } else {
13390: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13391: ($size,$mtime) = @{$currfile->{$embed_file}};
13392: }
13393: }
13394: $showsize = $size/1024.0;
13395: $showsize = sprintf("%.1f",$showsize);
13396: if ($mtime > 0) {
13397: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13398: }
13399: }
13400: return ($showsize,$showmtime);
13401: }
13402:
13403: sub ask_embedded_js {
13404: return <<"END";
13405: <script type="text/javascript"">
13406: // <![CDATA[
13407: function toggleBrowse(counter) {
13408: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13409: var fileid = document.getElementById('embedded_item_'+counter);
13410: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13411: if (chkboxid.checked == true) {
13412: uploaddivid.style.display='block';
13413: } else {
13414: uploaddivid.style.display='none';
13415: fileid.value = '';
13416: }
13417: }
13418: // ]]>
13419: </script>
13420:
13421: END
13422: }
13423:
1.661 raeburn 13424: sub upload_embedded {
13425: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13426: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13427: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13428: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13429: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13430: my $orig_uploaded_filename =
13431: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13432: foreach my $type ('orig','ref','attrib','codebase') {
13433: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13434: $env{'form.embedded_'.$type.'_'.$i} =
13435: &unescape($env{'form.embedded_'.$type.'_'.$i});
13436: }
13437: }
1.661 raeburn 13438: my ($path,$fname) =
13439: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13440: # no path, whole string is fname
13441: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13442: $fname = &Apache::lonnet::clean_filename($fname);
13443: # See if there is anything left
13444: next if ($fname eq '');
13445:
13446: # Check if file already exists as a file or directory.
13447: my ($state,$msg);
13448: if ($context eq 'portfolio') {
13449: my $port_path = $dirpath;
13450: if ($group ne '') {
13451: $port_path = "groups/$group/$port_path";
13452: }
1.987 raeburn 13453: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13454: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13455: $dir_root,$port_path,$disk_quota,
13456: $current_disk_usage,$uname,$udom);
13457: if ($state eq 'will_exceed_quota'
1.984 raeburn 13458: || $state eq 'file_locked') {
1.661 raeburn 13459: $output .= $msg;
13460: next;
13461: }
13462: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13463: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13464: if ($state eq 'exists') {
13465: $output .= $msg;
13466: next;
13467: }
13468: }
13469: # Check if extension is valid
13470: if (($fname =~ /\.(\w+)$/) &&
13471: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13472: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13473: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13474: next;
13475: } elsif (($fname =~ /\.(\w+)$/) &&
13476: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13477: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13478: next;
13479: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13480: $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 13481: next;
13482: }
13483: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13484: my $subdir = $path;
13485: $subdir =~ s{/+$}{};
1.661 raeburn 13486: if ($context eq 'portfolio') {
1.984 raeburn 13487: my $result;
13488: if ($state eq 'existingfile') {
13489: $result=
13490: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13491: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13492: } else {
1.984 raeburn 13493: $result=
13494: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13495: $dirpath.
1.1123 raeburn 13496: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13497: if ($result !~ m|^/uploaded/|) {
13498: $output .= '<span class="LC_error">'
13499: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13500: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13501: .'</span><br />';
13502: next;
13503: } else {
1.987 raeburn 13504: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13505: $path.$fname.'</span>').'<br />';
1.984 raeburn 13506: }
1.661 raeburn 13507: }
1.1123 raeburn 13508: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13509: my $extendedsubdir = $dirpath.'/'.$subdir;
13510: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13511: my $result =
1.1126 raeburn 13512: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13513: if ($result !~ m|^/uploaded/|) {
13514: $output .= '<span class="LC_error">'
13515: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13516: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13517: .'</span><br />';
13518: next;
13519: } else {
13520: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13521: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13522: if ($context eq 'syllabus') {
13523: &Apache::lonnet::make_public_indefinitely($result);
13524: }
1.987 raeburn 13525: }
1.661 raeburn 13526: } else {
13527: # Save the file
13528: my $target = $env{'form.embedded_item_'.$i};
13529: my $fullpath = $dir_root.$dirpath.'/'.$path;
13530: my $dest = $fullpath.$fname;
13531: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13532: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13533: my $count;
13534: my $filepath = $dir_root;
1.1027 raeburn 13535: foreach my $subdir (@parts) {
13536: $filepath .= "/$subdir";
13537: if (!-e $filepath) {
1.661 raeburn 13538: mkdir($filepath,0770);
13539: }
13540: }
13541: my $fh;
13542: if (!open($fh,'>'.$dest)) {
13543: &Apache::lonnet::logthis('Failed to create '.$dest);
13544: $output .= '<span class="LC_error">'.
1.1071 raeburn 13545: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13546: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13547: '</span><br />';
13548: } else {
13549: if (!print $fh $env{'form.embedded_item_'.$i}) {
13550: &Apache::lonnet::logthis('Failed to write to '.$dest);
13551: $output .= '<span class="LC_error">'.
1.1071 raeburn 13552: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13553: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13554: '</span><br />';
13555: } else {
1.987 raeburn 13556: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13557: $url.'</span>').'<br />';
13558: unless ($context eq 'testbank') {
13559: $footer .= &mt('View embedded file: [_1]',
13560: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13561: }
13562: }
13563: close($fh);
13564: }
13565: }
13566: if ($env{'form.embedded_ref_'.$i}) {
13567: $pathchange{$i} = 1;
13568: }
13569: }
13570: if ($output) {
13571: $output = '<p>'.$output.'</p>';
13572: }
13573: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13574: $returnflag = 'ok';
1.1071 raeburn 13575: my $numpathchgs = scalar(keys(%pathchange));
13576: if ($numpathchgs > 0) {
1.987 raeburn 13577: if ($context eq 'portfolio') {
13578: $output .= '<p>'.&mt('or').'</p>';
13579: } elsif ($context eq 'testbank') {
1.1071 raeburn 13580: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13581: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13582: $returnflag = 'modify_orightml';
13583: }
13584: }
1.1071 raeburn 13585: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13586: }
13587:
13588: sub modify_html_form {
13589: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13590: my $end = 0;
13591: my $modifyform;
13592: if ($context eq 'upload_embedded') {
13593: return unless (ref($pathchange) eq 'HASH');
13594: if ($env{'form.number_embedded_items'}) {
13595: $end += $env{'form.number_embedded_items'};
13596: }
13597: if ($env{'form.number_pathchange_items'}) {
13598: $end += $env{'form.number_pathchange_items'};
13599: }
13600: if ($end) {
13601: for (my $i=0; $i<$end; $i++) {
13602: if ($i < $env{'form.number_embedded_items'}) {
13603: next unless($pathchange->{$i});
13604: }
13605: $modifyform .=
13606: &start_data_table_row().
13607: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13608: 'checked="checked" /></td>'.
13609: '<td>'.$env{'form.embedded_ref_'.$i}.
13610: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13611: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13612: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13613: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13614: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13615: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13616: '<td>'.$env{'form.embedded_orig_'.$i}.
13617: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13618: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13619: &end_data_table_row();
1.1071 raeburn 13620: }
1.987 raeburn 13621: }
13622: } else {
13623: $modifyform = $pathchgtable;
13624: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13625: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13626: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13627: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13628: }
13629: }
13630: if ($modifyform) {
1.1071 raeburn 13631: if ($actionurl eq '/adm/dependencies') {
13632: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13633: }
1.987 raeburn 13634: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13635: '<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".
13636: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13637: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13638: '</ol></p>'."\n".'<p>'.
13639: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13640: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13641: &start_data_table()."\n".
13642: &start_data_table_header_row().
13643: '<th>'.&mt('Change?').'</th>'.
13644: '<th>'.&mt('Current reference').'</th>'.
13645: '<th>'.&mt('Required reference').'</th>'.
13646: &end_data_table_header_row()."\n".
13647: $modifyform.
13648: &end_data_table().'<br />'."\n".$hiddenstate.
13649: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13650: '</form>'."\n";
13651: }
13652: return;
13653: }
13654:
13655: sub modify_html_refs {
1.1123 raeburn 13656: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13657: my $container;
13658: if ($context eq 'portfolio') {
13659: $container = $env{'form.container'};
13660: } elsif ($context eq 'coursedoc') {
13661: $container = $env{'form.primaryurl'};
1.1071 raeburn 13662: } elsif ($context eq 'manage_dependencies') {
13663: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13664: $container = "/$container";
1.1123 raeburn 13665: } elsif ($context eq 'syllabus') {
13666: $container = $url;
1.987 raeburn 13667: } else {
1.1027 raeburn 13668: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13669: }
13670: my (%allfiles,%codebase,$output,$content);
13671: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13672: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13673: if (wantarray) {
13674: return ('',0,0);
13675: } else {
13676: return;
13677: }
13678: }
13679: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13680: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13681: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13682: if (wantarray) {
13683: return ('',0,0);
13684: } else {
13685: return;
13686: }
13687: }
1.987 raeburn 13688: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13689: if ($content eq '-1') {
13690: if (wantarray) {
13691: return ('',0,0);
13692: } else {
13693: return;
13694: }
13695: }
1.987 raeburn 13696: } else {
1.1071 raeburn 13697: unless ($container =~ /^\Q$dir_root\E/) {
13698: if (wantarray) {
13699: return ('',0,0);
13700: } else {
13701: return;
13702: }
13703: }
1.1317 raeburn 13704: if (open(my $fh,'<',$container)) {
1.987 raeburn 13705: $content = join('', <$fh>);
13706: close($fh);
13707: } else {
1.1071 raeburn 13708: if (wantarray) {
13709: return ('',0,0);
13710: } else {
13711: return;
13712: }
1.987 raeburn 13713: }
13714: }
13715: my ($count,$codebasecount) = (0,0);
13716: my $mm = new File::MMagic;
13717: my $mime_type = $mm->checktype_contents($content);
13718: if ($mime_type eq 'text/html') {
13719: my $parse_result =
13720: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13721: \%codebase,\$content);
13722: if ($parse_result eq 'ok') {
13723: foreach my $i (@changes) {
13724: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13725: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13726: if ($allfiles{$ref}) {
13727: my $newname = $orig;
13728: my ($attrib_regexp,$codebase);
1.1006 raeburn 13729: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13730: if ($attrib_regexp =~ /:/) {
13731: $attrib_regexp =~ s/\:/|/g;
13732: }
13733: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13734: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13735: $count += $numchg;
1.1123 raeburn 13736: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13737: delete($allfiles{$ref});
1.987 raeburn 13738: }
13739: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13740: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13741: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13742: $codebasecount ++;
13743: }
13744: }
13745: }
1.1123 raeburn 13746: my $skiprewrites;
1.987 raeburn 13747: if ($count || $codebasecount) {
13748: my $saveresult;
1.1071 raeburn 13749: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13750: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13751: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13752: if ($url eq $container) {
13753: my ($fname) = ($container =~ m{/([^/]+)$});
13754: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13755: $count,'<span class="LC_filename">'.
1.1071 raeburn 13756: $fname.'</span>').'</p>';
1.987 raeburn 13757: } else {
13758: $output = '<p class="LC_error">'.
13759: &mt('Error: update failed for: [_1].',
13760: '<span class="LC_filename">'.
13761: $container.'</span>').'</p>';
13762: }
1.1123 raeburn 13763: if ($context eq 'syllabus') {
13764: unless ($saveresult eq 'ok') {
13765: $skiprewrites = 1;
13766: }
13767: }
1.987 raeburn 13768: } else {
1.1317 raeburn 13769: if (open(my $fh,'>',$container)) {
1.987 raeburn 13770: print $fh $content;
13771: close($fh);
13772: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13773: $count,'<span class="LC_filename">'.
13774: $container.'</span>').'</p>';
1.661 raeburn 13775: } else {
1.987 raeburn 13776: $output = '<p class="LC_error">'.
13777: &mt('Error: could not update [_1].',
13778: '<span class="LC_filename">'.
13779: $container.'</span>').'</p>';
1.661 raeburn 13780: }
13781: }
13782: }
1.1123 raeburn 13783: if (($context eq 'syllabus') && (!$skiprewrites)) {
13784: my ($actionurl,$state);
13785: $actionurl = "/public/$udom/$uname/syllabus";
13786: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13787: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13788: \%codebase,
13789: {'context' => 'rewrites',
13790: 'ignore_remote_references' => 1,});
13791: if (ref($mapping) eq 'HASH') {
13792: my $rewrites = 0;
13793: foreach my $key (keys(%{$mapping})) {
13794: next if ($key =~ m{^https?://});
13795: my $ref = $mapping->{$key};
13796: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13797: my $attrib;
13798: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13799: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13800: }
13801: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13802: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13803: $rewrites += $numchg;
13804: }
13805: }
13806: if ($rewrites) {
13807: my $saveresult;
13808: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13809: if ($url eq $container) {
13810: my ($fname) = ($container =~ m{/([^/]+)$});
13811: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13812: $count,'<span class="LC_filename">'.
13813: $fname.'</span>').'</p>';
13814: } else {
13815: $output .= '<p class="LC_error">'.
13816: &mt('Error: could not update links in [_1].',
13817: '<span class="LC_filename">'.
13818: $container.'</span>').'</p>';
13819:
13820: }
13821: }
13822: }
13823: }
1.987 raeburn 13824: } else {
13825: &logthis('Failed to parse '.$container.
13826: ' to modify references: '.$parse_result);
1.661 raeburn 13827: }
13828: }
1.1071 raeburn 13829: if (wantarray) {
13830: return ($output,$count,$codebasecount);
13831: } else {
13832: return $output;
13833: }
1.661 raeburn 13834: }
13835:
13836: sub check_for_existing {
13837: my ($path,$fname,$element) = @_;
13838: my ($state,$msg);
13839: if (-d $path.'/'.$fname) {
13840: $state = 'exists';
13841: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13842: } elsif (-e $path.'/'.$fname) {
13843: $state = 'exists';
13844: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13845: }
13846: if ($state eq 'exists') {
13847: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13848: }
13849: return ($state,$msg);
13850: }
13851:
13852: sub check_for_upload {
13853: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13854: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13855: my $filesize = length($env{'form.'.$element});
13856: if (!$filesize) {
13857: my $msg = '<span class="LC_error">'.
13858: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13859: '<span class="LC_filename">'.$fname.'</span>',
13860: $filesize).'<br />'.
1.1007 raeburn 13861: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13862: '</span>';
13863: return ('zero_bytes',$msg);
13864: }
13865: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13866: my $getpropath = 1;
1.1021 raeburn 13867: my ($dirlistref,$listerror) =
13868: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13869: my $found_file = 0;
13870: my $locked_file = 0;
1.991 raeburn 13871: my @lockers;
13872: my $navmap;
13873: if ($env{'request.course.id'}) {
13874: $navmap = Apache::lonnavmaps::navmap->new();
13875: }
1.1021 raeburn 13876: if (ref($dirlistref) eq 'ARRAY') {
13877: foreach my $line (@{$dirlistref}) {
13878: my ($file_name,$rest)=split(/\&/,$line,2);
13879: if ($file_name eq $fname){
13880: $file_name = $path.$file_name;
13881: if ($group ne '') {
13882: $file_name = $group.$file_name;
13883: }
13884: $found_file = 1;
13885: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13886: foreach my $lock (@lockers) {
13887: if (ref($lock) eq 'ARRAY') {
13888: my ($symb,$crsid) = @{$lock};
13889: if ($crsid eq $env{'request.course.id'}) {
13890: if (ref($navmap)) {
13891: my $res = $navmap->getBySymb($symb);
13892: foreach my $part (@{$res->parts()}) {
13893: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13894: unless (($slot_status == $res->RESERVED) ||
13895: ($slot_status == $res->RESERVED_LOCATION)) {
13896: $locked_file = 1;
13897: }
1.991 raeburn 13898: }
1.1021 raeburn 13899: } else {
13900: $locked_file = 1;
1.991 raeburn 13901: }
13902: } else {
13903: $locked_file = 1;
13904: }
13905: }
1.1021 raeburn 13906: }
13907: } else {
13908: my @info = split(/\&/,$rest);
13909: my $currsize = $info[6]/1000;
13910: if ($currsize < $filesize) {
13911: my $extra = $filesize - $currsize;
13912: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13913: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13914: &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 13915: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13916: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13917: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13918: return ('will_exceed_quota',$msg);
13919: }
1.984 raeburn 13920: }
13921: }
1.661 raeburn 13922: }
13923: }
13924: }
13925: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13926: my $msg = '<p class="LC_warning">'.
13927: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13928: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13929: return ('will_exceed_quota',$msg);
13930: } elsif ($found_file) {
13931: if ($locked_file) {
1.1179 bisitz 13932: my $msg = '<p class="LC_warning">';
1.661 raeburn 13933: $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 13934: $msg .= '</p>';
1.661 raeburn 13935: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13936: return ('file_locked',$msg);
13937: } else {
1.1179 bisitz 13938: my $msg = '<p class="LC_error">';
1.984 raeburn 13939: $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 13940: $msg .= '</p>';
1.984 raeburn 13941: return ('existingfile',$msg);
1.661 raeburn 13942: }
13943: }
13944: }
13945:
1.987 raeburn 13946: sub check_for_traversal {
13947: my ($path,$url,$toplevel) = @_;
13948: my @parts=split(/\//,$path);
13949: my $cleanpath;
13950: my $fullpath = $url;
13951: for (my $i=0;$i<@parts;$i++) {
13952: next if ($parts[$i] eq '.');
13953: if ($parts[$i] eq '..') {
13954: $fullpath =~ s{([^/]+/)$}{};
13955: } else {
13956: $fullpath .= $parts[$i].'/';
13957: }
13958: }
13959: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13960: $cleanpath = $1;
13961: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13962: my $curr_toprel = $1;
13963: my @parts = split(/\//,$curr_toprel);
13964: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13965: my @urlparts = split(/\//,$url_toprel);
13966: my $doubledots;
13967: my $startdiff = -1;
13968: for (my $i=0; $i<@urlparts; $i++) {
13969: if ($startdiff == -1) {
13970: unless ($urlparts[$i] eq $parts[$i]) {
13971: $startdiff = $i;
13972: $doubledots .= '../';
13973: }
13974: } else {
13975: $doubledots .= '../';
13976: }
13977: }
13978: if ($startdiff > -1) {
13979: $cleanpath = $doubledots;
13980: for (my $i=$startdiff; $i<@parts; $i++) {
13981: $cleanpath .= $parts[$i].'/';
13982: }
13983: }
13984: }
13985: $cleanpath =~ s{(/)$}{};
13986: return $cleanpath;
13987: }
1.31 albertel 13988:
1.1053 raeburn 13989: sub is_archive_file {
13990: my ($mimetype) = @_;
13991: if (($mimetype eq 'application/octet-stream') ||
13992: ($mimetype eq 'application/x-stuffit') ||
13993: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13994: return 1;
13995: }
13996: return;
13997: }
13998:
13999: sub decompress_form {
1.1065 raeburn 14000: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 14001: my %lt = &Apache::lonlocal::texthash (
14002: this => 'This file is an archive file.',
1.1067 raeburn 14003: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 14004: itsc => 'Its contents are as follows:',
1.1053 raeburn 14005: youm => 'You may wish to extract its contents.',
14006: extr => 'Extract contents',
1.1067 raeburn 14007: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
14008: proa => 'Process automatically?',
1.1053 raeburn 14009: yes => 'Yes',
14010: no => 'No',
1.1067 raeburn 14011: fold => 'Title for folder containing movie',
14012: movi => 'Title for page containing embedded movie',
1.1053 raeburn 14013: );
1.1065 raeburn 14014: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 14015: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 14016: my $info = &list_archive_contents($fileloc,\@paths);
14017: if (@paths) {
14018: foreach my $path (@paths) {
14019: $path =~ s{^/}{};
1.1067 raeburn 14020: if ($path =~ m{^([^/]+)/$}) {
14021: $topdir = $1;
14022: }
1.1065 raeburn 14023: if ($path =~ m{^([^/]+)/}) {
14024: $toplevel{$1} = $path;
14025: } else {
14026: $toplevel{$path} = $path;
14027: }
14028: }
14029: }
1.1067 raeburn 14030: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 14031: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 14032: "$topdir/media/",
14033: "$topdir/media/$topdir.mp4",
14034: "$topdir/media/FirstFrame.png",
14035: "$topdir/media/player.swf",
14036: "$topdir/media/swfobject.js",
14037: "$topdir/media/expressInstall.swf");
1.1197 raeburn 14038: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 14039: "$topdir/$topdir.mp4",
14040: "$topdir/$topdir\_config.xml",
14041: "$topdir/$topdir\_controller.swf",
14042: "$topdir/$topdir\_embed.css",
14043: "$topdir/$topdir\_First_Frame.png",
14044: "$topdir/$topdir\_player.html",
14045: "$topdir/$topdir\_Thumbnails.png",
14046: "$topdir/playerProductInstall.swf",
14047: "$topdir/scripts/",
14048: "$topdir/scripts/config_xml.js",
14049: "$topdir/scripts/handlebars.js",
14050: "$topdir/scripts/jquery-1.7.1.min.js",
14051: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
14052: "$topdir/scripts/modernizr.js",
14053: "$topdir/scripts/player-min.js",
14054: "$topdir/scripts/swfobject.js",
14055: "$topdir/skins/",
14056: "$topdir/skins/configuration_express.xml",
14057: "$topdir/skins/express_show/",
14058: "$topdir/skins/express_show/player-min.css",
14059: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 14060: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
14061: "$topdir/$topdir.mp4",
14062: "$topdir/$topdir\_config.xml",
14063: "$topdir/$topdir\_controller.swf",
14064: "$topdir/$topdir\_embed.css",
14065: "$topdir/$topdir\_First_Frame.png",
14066: "$topdir/$topdir\_player.html",
14067: "$topdir/$topdir\_Thumbnails.png",
14068: "$topdir/playerProductInstall.swf",
14069: "$topdir/scripts/",
14070: "$topdir/scripts/config_xml.js",
14071: "$topdir/scripts/techsmith-smart-player.min.js",
14072: "$topdir/skins/",
14073: "$topdir/skins/configuration_express.xml",
14074: "$topdir/skins/express_show/",
14075: "$topdir/skins/express_show/spritesheet.min.css",
14076: "$topdir/skins/express_show/spritesheet.png",
14077: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 14078: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 14079: if (@diffs == 0) {
1.1164 raeburn 14080: $is_camtasia = 6;
14081: } else {
1.1197 raeburn 14082: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 14083: if (@diffs == 0) {
14084: $is_camtasia = 8;
1.1197 raeburn 14085: } else {
14086: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14087: if (@diffs == 0) {
14088: $is_camtasia = 8;
14089: }
1.1164 raeburn 14090: }
1.1067 raeburn 14091: }
14092: }
14093: my $output;
14094: if ($is_camtasia) {
14095: $output = <<"ENDCAM";
14096: <script type="text/javascript" language="Javascript">
14097: // <![CDATA[
14098:
14099: function camtasiaToggle() {
14100: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14101: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14102: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14103: document.getElementById('camtasia_titles').style.display='block';
14104: } else {
14105: document.getElementById('camtasia_titles').style.display='none';
14106: }
14107: }
14108: }
14109: return;
14110: }
14111:
14112: // ]]>
14113: </script>
14114: <p>$lt{'camt'}</p>
14115: ENDCAM
1.1065 raeburn 14116: } else {
1.1067 raeburn 14117: $output = '<p>'.$lt{'this'};
14118: if ($info eq '') {
14119: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14120: } else {
14121: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14122: '<div><pre>'.$info.'</pre></div>';
14123: }
1.1065 raeburn 14124: }
1.1067 raeburn 14125: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14126: my $duplicates;
14127: my $num = 0;
14128: if (ref($dirlist) eq 'ARRAY') {
14129: foreach my $item (@{$dirlist}) {
14130: if (ref($item) eq 'ARRAY') {
14131: if (exists($toplevel{$item->[0]})) {
14132: $duplicates .=
14133: &start_data_table_row().
14134: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14135: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14136: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14137: 'value="1" />'.&mt('Yes').'</label>'.
14138: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14139: '<td>'.$item->[0].'</td>';
14140: if ($item->[2]) {
14141: $duplicates .= '<td>'.&mt('Directory').'</td>';
14142: } else {
14143: $duplicates .= '<td>'.&mt('File').'</td>';
14144: }
14145: $duplicates .= '<td>'.$item->[3].'</td>'.
14146: '<td>'.
14147: &Apache::lonlocal::locallocaltime($item->[4]).
14148: '</td>'.
14149: &end_data_table_row();
14150: $num ++;
14151: }
14152: }
14153: }
14154: }
14155: my $itemcount;
14156: if (@paths > 0) {
14157: $itemcount = scalar(@paths);
14158: } else {
14159: $itemcount = 1;
14160: }
1.1067 raeburn 14161: if ($is_camtasia) {
14162: $output .= $lt{'auto'}.'<br />'.
14163: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14164: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14165: $lt{'yes'}.'</label> <label>'.
14166: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14167: $lt{'no'}.'</label></span><br />'.
14168: '<div id="camtasia_titles" style="display:block">'.
14169: &Apache::lonhtmlcommon::start_pick_box().
14170: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14171: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14172: &Apache::lonhtmlcommon::row_closure().
14173: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14174: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14175: &Apache::lonhtmlcommon::row_closure(1).
14176: &Apache::lonhtmlcommon::end_pick_box().
14177: '</div>';
14178: }
1.1065 raeburn 14179: $output .=
14180: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14181: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14182: "\n";
1.1065 raeburn 14183: if ($duplicates ne '') {
14184: $output .= '<p><span class="LC_warning">'.
14185: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14186: &start_data_table().
14187: &start_data_table_header_row().
14188: '<th>'.&mt('Overwrite?').'</th>'.
14189: '<th>'.&mt('Name').'</th>'.
14190: '<th>'.&mt('Type').'</th>'.
14191: '<th>'.&mt('Size').'</th>'.
14192: '<th>'.&mt('Last modified').'</th>'.
14193: &end_data_table_header_row().
14194: $duplicates.
14195: &end_data_table().
14196: '</p>';
14197: }
1.1067 raeburn 14198: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14199: if (ref($hiddenelements) eq 'HASH') {
14200: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14201: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14202: }
14203: }
14204: $output .= <<"END";
1.1067 raeburn 14205: <br />
1.1053 raeburn 14206: <input type="submit" name="decompress" value="$lt{'extr'}" />
14207: </form>
14208: $noextract
14209: END
14210: return $output;
14211: }
14212:
1.1065 raeburn 14213: sub decompression_utility {
14214: my ($program) = @_;
14215: my @utilities = ('tar','gunzip','bunzip2','unzip');
14216: my $location;
14217: if (grep(/^\Q$program\E$/,@utilities)) {
14218: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14219: '/usr/sbin/') {
14220: if (-x $dir.$program) {
14221: $location = $dir.$program;
14222: last;
14223: }
14224: }
14225: }
14226: return $location;
14227: }
14228:
14229: sub list_archive_contents {
14230: my ($file,$pathsref) = @_;
14231: my (@cmd,$output);
14232: my $needsregexp;
14233: if ($file =~ /\.zip$/) {
14234: @cmd = (&decompression_utility('unzip'),"-l");
14235: $needsregexp = 1;
14236: } elsif (($file =~ m/\.tar\.gz$/) ||
14237: ($file =~ /\.tgz$/)) {
14238: @cmd = (&decompression_utility('tar'),"-ztf");
14239: } elsif ($file =~ /\.tar\.bz2$/) {
14240: @cmd = (&decompression_utility('tar'),"-jtf");
14241: } elsif ($file =~ m|\.tar$|) {
14242: @cmd = (&decompression_utility('tar'),"-tf");
14243: }
14244: if (@cmd) {
14245: undef($!);
14246: undef($@);
14247: if (open(my $fh,"-|", @cmd, $file)) {
14248: while (my $line = <$fh>) {
14249: $output .= $line;
14250: chomp($line);
14251: my $item;
14252: if ($needsregexp) {
14253: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14254: } else {
14255: $item = $line;
14256: }
14257: if ($item ne '') {
14258: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14259: push(@{$pathsref},$item);
14260: }
14261: }
14262: }
14263: close($fh);
14264: }
14265: }
14266: return $output;
14267: }
14268:
1.1053 raeburn 14269: sub decompress_uploaded_file {
14270: my ($file,$dir) = @_;
14271: &Apache::lonnet::appenv({'cgi.file' => $file});
14272: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14273: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14274: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14275: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14276: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14277: my $decompressed = $env{'cgi.decompressed'};
14278: &Apache::lonnet::delenv('cgi.file');
14279: &Apache::lonnet::delenv('cgi.dir');
14280: &Apache::lonnet::delenv('cgi.decompressed');
14281: return ($decompressed,$result);
14282: }
14283:
1.1055 raeburn 14284: sub process_decompression {
14285: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14286: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14287: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14288: &mt('Unexpected file path.').'</p>'."\n";
14289: }
14290: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14291: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14292: &mt('Unexpected course context.').'</p>'."\n";
14293: }
1.1293 raeburn 14294: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14295: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14296: &mt('Filename contained unexpected characters.').'</p>'."\n";
14297: }
1.1055 raeburn 14298: my ($dir,$error,$warning,$output);
1.1180 raeburn 14299: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14300: $error = &mt('Filename not a supported archive file type.').
14301: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14302: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14303: } else {
14304: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14305: if ($docuhome eq 'no_host') {
14306: $error = &mt('Could not determine home server for course.');
14307: } else {
14308: my @ids=&Apache::lonnet::current_machine_ids();
14309: my $currdir = "$dir_root/$destination";
14310: if (grep(/^\Q$docuhome\E$/,@ids)) {
14311: $dir = &LONCAPA::propath($docudom,$docuname).
14312: "$dir_root/$destination";
14313: } else {
14314: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14315: "$dir_root/$docudom/$docuname/$destination";
14316: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14317: $error = &mt('Archive file not found.');
14318: }
14319: }
1.1065 raeburn 14320: my (@to_overwrite,@to_skip);
14321: if ($env{'form.archive_overwrite_total'} > 0) {
14322: my $total = $env{'form.archive_overwrite_total'};
14323: for (my $i=0; $i<$total; $i++) {
14324: if ($env{'form.archive_overwrite_'.$i} == 1) {
14325: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14326: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14327: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14328: }
14329: }
14330: }
14331: my $numskip = scalar(@to_skip);
1.1292 raeburn 14332: my $numoverwrite = scalar(@to_overwrite);
14333: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14334: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14335: } elsif ($dir eq '') {
1.1055 raeburn 14336: $error = &mt('Directory containing archive file unavailable.');
14337: } elsif (!$error) {
1.1065 raeburn 14338: my ($decompressed,$display);
1.1292 raeburn 14339: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14340: my $tempdir = time.'_'.$$.int(rand(10000));
14341: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14342: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14343: ($decompressed,$display) =
14344: &decompress_uploaded_file($file,"$dir/$tempdir");
14345: foreach my $item (@to_skip) {
14346: if (($item ne '') && ($item !~ /\.\./)) {
14347: if (-f "$dir/$tempdir/$item") {
14348: unlink("$dir/$tempdir/$item");
14349: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14350: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14351: }
14352: }
14353: }
14354: foreach my $item (@to_overwrite) {
14355: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14356: if (($item ne '') && ($item !~ /\.\./)) {
14357: if (-f "$dir/$item") {
14358: unlink("$dir/$item");
14359: } elsif (-d "$dir/$item") {
1.1300 raeburn 14360: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14361: }
14362: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14363: }
1.1065 raeburn 14364: }
14365: }
1.1292 raeburn 14366: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14367: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14368: }
1.1065 raeburn 14369: }
14370: } else {
14371: ($decompressed,$display) =
14372: &decompress_uploaded_file($file,$dir);
14373: }
1.1055 raeburn 14374: if ($decompressed eq 'ok') {
1.1065 raeburn 14375: $output = '<p class="LC_info">'.
14376: &mt('Files extracted successfully from archive.').
14377: '</p>'."\n";
1.1055 raeburn 14378: my ($warning,$result,@contents);
14379: my ($newdirlistref,$newlisterror) =
14380: &Apache::lonnet::dirlist($currdir,$docudom,
14381: $docuname,1);
14382: my (%is_dir,%changes,@newitems);
14383: my $dirptr = 16384;
1.1065 raeburn 14384: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14385: foreach my $dir_line (@{$newdirlistref}) {
14386: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14387: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14388: push(@newitems,$item);
14389: if ($dirptr&$testdir) {
14390: $is_dir{$item} = 1;
14391: }
14392: $changes{$item} = 1;
14393: }
14394: }
14395: }
14396: if (keys(%changes) > 0) {
14397: foreach my $item (sort(@newitems)) {
14398: if ($changes{$item}) {
14399: push(@contents,$item);
14400: }
14401: }
14402: }
14403: if (@contents > 0) {
1.1067 raeburn 14404: my $wantform;
14405: unless ($env{'form.autoextract_camtasia'}) {
14406: $wantform = 1;
14407: }
1.1056 raeburn 14408: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14409: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14410: $currdir,\%is_dir,
14411: \%children,\%parent,
1.1056 raeburn 14412: \@contents,\%dirorder,
14413: \%titles,$wantform);
1.1055 raeburn 14414: if ($datatable ne '') {
14415: $output .= &archive_options_form('decompressed',$datatable,
14416: $count,$hiddenelem);
1.1065 raeburn 14417: my $startcount = 6;
1.1055 raeburn 14418: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14419: \%titles,\%children);
1.1055 raeburn 14420: }
1.1067 raeburn 14421: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14422: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14423: my %displayed;
14424: my $total = 1;
14425: $env{'form.archive_directory'} = [];
14426: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14427: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14428: $path =~ s{/$}{};
14429: my $item;
14430: if ($path ne '') {
14431: $item = "$path/$titles{$i}";
14432: } else {
14433: $item = $titles{$i};
14434: }
14435: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14436: if ($item eq $contents[0]) {
14437: push(@{$env{'form.archive_directory'}},$i);
14438: $env{'form.archive_'.$i} = 'display';
14439: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14440: $displayed{'folder'} = $i;
1.1164 raeburn 14441: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14442: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14443: $env{'form.archive_'.$i} = 'display';
14444: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14445: $displayed{'web'} = $i;
14446: } else {
1.1164 raeburn 14447: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14448: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14449: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14450: push(@{$env{'form.archive_directory'}},$i);
14451: }
14452: $env{'form.archive_'.$i} = 'dependency';
14453: }
14454: $total ++;
14455: }
14456: for (my $i=1; $i<$total; $i++) {
14457: next if ($i == $displayed{'web'});
14458: next if ($i == $displayed{'folder'});
14459: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14460: }
14461: $env{'form.phase'} = 'decompress_cleanup';
14462: $env{'form.archivedelete'} = 1;
14463: $env{'form.archive_count'} = $total-1;
14464: $output .=
14465: &process_extracted_files('coursedocs',$docudom,
14466: $docuname,$destination,
14467: $dir_root,$hiddenelem);
14468: }
1.1055 raeburn 14469: } else {
14470: $warning = &mt('No new items extracted from archive file.');
14471: }
14472: } else {
14473: $output = $display;
14474: $error = &mt('An error occurred during extraction from the archive file.');
14475: }
14476: }
14477: }
14478: }
14479: if ($error) {
14480: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14481: $error.'</p>'."\n";
14482: }
14483: if ($warning) {
14484: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14485: }
14486: return $output;
14487: }
14488:
14489: sub get_extracted {
1.1056 raeburn 14490: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14491: $titles,$wantform) = @_;
1.1055 raeburn 14492: my $count = 0;
14493: my $depth = 0;
14494: my $datatable;
1.1056 raeburn 14495: my @hierarchy;
1.1055 raeburn 14496: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14497: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14498: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14499: foreach my $item (@{$contents}) {
14500: $count ++;
1.1056 raeburn 14501: @{$dirorder->{$count}} = @hierarchy;
14502: $titles->{$count} = $item;
1.1055 raeburn 14503: &archive_hierarchy($depth,$count,$parent,$children);
14504: if ($wantform) {
14505: $datatable .= &archive_row($is_dir->{$item},$item,
14506: $currdir,$depth,$count);
14507: }
14508: if ($is_dir->{$item}) {
14509: $depth ++;
1.1056 raeburn 14510: push(@hierarchy,$count);
14511: $parent->{$depth} = $count;
1.1055 raeburn 14512: $datatable .=
14513: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14514: \$depth,\$count,\@hierarchy,$dirorder,
14515: $children,$parent,$titles,$wantform);
1.1055 raeburn 14516: $depth --;
1.1056 raeburn 14517: pop(@hierarchy);
1.1055 raeburn 14518: }
14519: }
14520: return ($count,$datatable);
14521: }
14522:
14523: sub recurse_extracted_archive {
1.1056 raeburn 14524: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14525: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14526: my $result='';
1.1056 raeburn 14527: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14528: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14529: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14530: return $result;
14531: }
14532: my $dirptr = 16384;
14533: my ($newdirlistref,$newlisterror) =
14534: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14535: if (ref($newdirlistref) eq 'ARRAY') {
14536: foreach my $dir_line (@{$newdirlistref}) {
14537: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14538: unless ($item =~ /^\.+$/) {
14539: $$count ++;
1.1056 raeburn 14540: @{$dirorder->{$$count}} = @{$hierarchy};
14541: $titles->{$$count} = $item;
1.1055 raeburn 14542: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14543:
1.1055 raeburn 14544: my $is_dir;
14545: if ($dirptr&$testdir) {
14546: $is_dir = 1;
14547: }
14548: if ($wantform) {
14549: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14550: }
14551: if ($is_dir) {
14552: $$depth ++;
1.1056 raeburn 14553: push(@{$hierarchy},$$count);
14554: $parent->{$$depth} = $$count;
1.1055 raeburn 14555: $result .=
14556: &recurse_extracted_archive("$currdir/$item",$docudom,
14557: $docuname,$depth,$count,
1.1056 raeburn 14558: $hierarchy,$dirorder,$children,
14559: $parent,$titles,$wantform);
1.1055 raeburn 14560: $$depth --;
1.1056 raeburn 14561: pop(@{$hierarchy});
1.1055 raeburn 14562: }
14563: }
14564: }
14565: }
14566: return $result;
14567: }
14568:
14569: sub archive_hierarchy {
14570: my ($depth,$count,$parent,$children) =@_;
14571: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14572: if (exists($parent->{$depth})) {
14573: $children->{$parent->{$depth}} .= $count.':';
14574: }
14575: }
14576: return;
14577: }
14578:
14579: sub archive_row {
14580: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14581: my ($name) = ($item =~ m{([^/]+)$});
14582: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14583: 'display' => 'Add as file',
1.1055 raeburn 14584: 'dependency' => 'Include as dependency',
14585: 'discard' => 'Discard',
14586: );
14587: if ($is_dir) {
1.1059 raeburn 14588: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14589: }
1.1056 raeburn 14590: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14591: my $offset = 0;
1.1055 raeburn 14592: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14593: $offset ++;
1.1065 raeburn 14594: if ($action ne 'display') {
14595: $offset ++;
14596: }
1.1055 raeburn 14597: $output .= '<td><span class="LC_nobreak">'.
14598: '<label><input type="radio" name="archive_'.$count.
14599: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14600: my $text = $choices{$action};
14601: if ($is_dir) {
14602: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14603: if ($action eq 'display') {
1.1059 raeburn 14604: $text = &mt('Add as folder');
1.1055 raeburn 14605: }
1.1056 raeburn 14606: } else {
14607: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14608:
14609: }
14610: $output .= ' /> '.$choices{$action}.'</label></span>';
14611: if ($action eq 'dependency') {
14612: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14613: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14614: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14615: '<option value=""></option>'."\n".
14616: '</select>'."\n".
14617: '</div>';
1.1059 raeburn 14618: } elsif ($action eq 'display') {
14619: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14620: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14621: '</div>';
1.1055 raeburn 14622: }
1.1056 raeburn 14623: $output .= '</td>';
1.1055 raeburn 14624: }
14625: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14626: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14627: for (my $i=0; $i<$depth; $i++) {
14628: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14629: }
14630: if ($is_dir) {
14631: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14632: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14633: } else {
14634: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14635: }
14636: $output .= ' '.$name.'</td>'."\n".
14637: &end_data_table_row();
14638: return $output;
14639: }
14640:
14641: sub archive_options_form {
1.1065 raeburn 14642: my ($form,$display,$count,$hiddenelem) = @_;
14643: my %lt = &Apache::lonlocal::texthash(
14644: perm => 'Permanently remove archive file?',
14645: hows => 'How should each extracted item be incorporated in the course?',
14646: cont => 'Content actions for all',
14647: addf => 'Add as folder/file',
14648: incd => 'Include as dependency for a displayed file',
14649: disc => 'Discard',
14650: no => 'No',
14651: yes => 'Yes',
14652: save => 'Save',
14653: );
14654: my $output = <<"END";
14655: <form name="$form" method="post" action="">
14656: <p><span class="LC_nobreak">$lt{'perm'}
14657: <label>
14658: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14659: </label>
14660:
14661: <label>
14662: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14663: </span>
14664: </p>
14665: <input type="hidden" name="phase" value="decompress_cleanup" />
14666: <br />$lt{'hows'}
14667: <div class="LC_columnSection">
14668: <fieldset>
14669: <legend>$lt{'cont'}</legend>
14670: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14671: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14672: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14673: </fieldset>
14674: </div>
14675: END
14676: return $output.
1.1055 raeburn 14677: &start_data_table()."\n".
1.1065 raeburn 14678: $display."\n".
1.1055 raeburn 14679: &end_data_table()."\n".
14680: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14681: $hiddenelem.
1.1065 raeburn 14682: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14683: '</form>';
14684: }
14685:
14686: sub archive_javascript {
1.1056 raeburn 14687: my ($startcount,$numitems,$titles,$children) = @_;
14688: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14689: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14690: my $scripttag = <<START;
14691: <script type="text/javascript">
14692: // <![CDATA[
14693:
14694: function checkAll(form,prefix) {
14695: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14696: for (var i=0; i < form.elements.length; i++) {
14697: var id = form.elements[i].id;
14698: if ((id != '') && (id != undefined)) {
14699: if (idstr.test(id)) {
14700: if (form.elements[i].type == 'radio') {
14701: form.elements[i].checked = true;
1.1056 raeburn 14702: var nostart = i-$startcount;
1.1059 raeburn 14703: var offset = nostart%7;
14704: var count = (nostart-offset)/7;
1.1056 raeburn 14705: dependencyCheck(form,count,offset);
1.1055 raeburn 14706: }
14707: }
14708: }
14709: }
14710: }
14711:
14712: function propagateCheck(form,count) {
14713: if (count > 0) {
1.1059 raeburn 14714: var startelement = $startcount + ((count-1) * 7);
14715: for (var j=1; j<6; j++) {
14716: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14717: var item = startelement + j;
14718: if (form.elements[item].type == 'radio') {
14719: if (form.elements[item].checked) {
14720: containerCheck(form,count,j);
14721: break;
14722: }
1.1055 raeburn 14723: }
14724: }
14725: }
14726: }
14727: }
14728:
14729: numitems = $numitems
1.1056 raeburn 14730: var titles = new Array(numitems);
14731: var parents = new Array(numitems);
1.1055 raeburn 14732: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14733: parents[i] = new Array;
1.1055 raeburn 14734: }
1.1059 raeburn 14735: var maintitle = '$maintitle';
1.1055 raeburn 14736:
14737: START
14738:
1.1056 raeburn 14739: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14740: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14741: for (my $i=0; $i<@contents; $i ++) {
14742: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14743: }
14744: }
14745:
1.1056 raeburn 14746: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14747: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14748: }
14749:
1.1055 raeburn 14750: $scripttag .= <<END;
14751:
14752: function containerCheck(form,count,offset) {
14753: if (count > 0) {
1.1056 raeburn 14754: dependencyCheck(form,count,offset);
1.1059 raeburn 14755: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14756: form.elements[item].checked = true;
14757: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14758: if (parents[count].length > 0) {
14759: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14760: containerCheck(form,parents[count][j],offset);
14761: }
14762: }
14763: }
14764: }
14765: }
14766:
14767: function dependencyCheck(form,count,offset) {
14768: if (count > 0) {
1.1059 raeburn 14769: var chosen = (offset+$startcount)+7*(count-1);
14770: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14771: var currtype = form.elements[depitem].type;
14772: if (form.elements[chosen].value == 'dependency') {
14773: document.getElementById('arc_depon_'+count).style.display='block';
14774: form.elements[depitem].options.length = 0;
14775: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14776: for (var i=1; i<=numitems; i++) {
14777: if (i == count) {
14778: continue;
14779: }
1.1059 raeburn 14780: var startelement = $startcount + (i-1) * 7;
14781: for (var j=1; j<6; j++) {
14782: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14783: var item = startelement + j;
14784: if (form.elements[item].type == 'radio') {
14785: if (form.elements[item].checked) {
14786: if (form.elements[item].value == 'display') {
14787: var n = form.elements[depitem].options.length;
14788: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14789: }
14790: }
14791: }
14792: }
14793: }
14794: }
14795: } else {
14796: document.getElementById('arc_depon_'+count).style.display='none';
14797: form.elements[depitem].options.length = 0;
14798: form.elements[depitem].options[0] = new Option('Select','',true,true);
14799: }
1.1059 raeburn 14800: titleCheck(form,count,offset);
1.1056 raeburn 14801: }
14802: }
14803:
14804: function propagateSelect(form,count,offset) {
14805: if (count > 0) {
1.1065 raeburn 14806: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14807: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14808: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14809: if (parents[count].length > 0) {
14810: for (var j=0; j<parents[count].length; j++) {
14811: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14812: }
14813: }
14814: }
14815: }
14816: }
1.1056 raeburn 14817:
14818: function containerSelect(form,count,offset,picked) {
14819: if (count > 0) {
1.1065 raeburn 14820: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14821: if (form.elements[item].type == 'radio') {
14822: if (form.elements[item].value == 'dependency') {
14823: if (form.elements[item+1].type == 'select-one') {
14824: for (var i=0; i<form.elements[item+1].options.length; i++) {
14825: if (form.elements[item+1].options[i].value == picked) {
14826: form.elements[item+1].selectedIndex = i;
14827: break;
14828: }
14829: }
14830: }
14831: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14832: if (parents[count].length > 0) {
14833: for (var j=0; j<parents[count].length; j++) {
14834: containerSelect(form,parents[count][j],offset,picked);
14835: }
14836: }
14837: }
14838: }
14839: }
14840: }
14841: }
14842:
1.1059 raeburn 14843: function titleCheck(form,count,offset) {
14844: if (count > 0) {
14845: var chosen = (offset+$startcount)+7*(count-1);
14846: var depitem = $startcount + ((count-1) * 7) + 2;
14847: var currtype = form.elements[depitem].type;
14848: if (form.elements[chosen].value == 'display') {
14849: document.getElementById('arc_title_'+count).style.display='block';
14850: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14851: document.getElementById('archive_title_'+count).value=maintitle;
14852: }
14853: } else {
14854: document.getElementById('arc_title_'+count).style.display='none';
14855: if (currtype == 'text') {
14856: document.getElementById('archive_title_'+count).value='';
14857: }
14858: }
14859: }
14860: return;
14861: }
14862:
1.1055 raeburn 14863: // ]]>
14864: </script>
14865: END
14866: return $scripttag;
14867: }
14868:
14869: sub process_extracted_files {
1.1067 raeburn 14870: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14871: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14872: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14873: my @ids=&Apache::lonnet::current_machine_ids();
14874: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14875: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14876: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14877: if (grep(/^\Q$docuhome\E$/,@ids)) {
14878: $prefix = &LONCAPA::propath($docudom,$docuname);
14879: $pathtocheck = "$dir_root/$destination";
14880: $dir = $dir_root;
14881: $ishome = 1;
14882: } else {
14883: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14884: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14885: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14886: }
14887: my $currdir = "$dir_root/$destination";
14888: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14889: if ($env{'form.folderpath'}) {
14890: my @items = split('&',$env{'form.folderpath'});
14891: $folders{'0'} = $items[-2];
1.1099 raeburn 14892: if ($env{'form.folderpath'} =~ /\:1$/) {
14893: $containers{'0'}='page';
14894: } else {
14895: $containers{'0'}='sequence';
14896: }
1.1055 raeburn 14897: }
14898: my @archdirs = &get_env_multiple('form.archive_directory');
14899: if ($numitems) {
14900: for (my $i=1; $i<=$numitems; $i++) {
14901: my $path = $env{'form.archive_content_'.$i};
14902: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14903: my $item = $1;
14904: $toplevelitems{$item} = $i;
14905: if (grep(/^\Q$i\E$/,@archdirs)) {
14906: $is_dir{$item} = 1;
14907: }
14908: }
14909: }
14910: }
1.1067 raeburn 14911: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14912: if (keys(%toplevelitems) > 0) {
14913: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14914: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14915: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14916: }
1.1066 raeburn 14917: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14918: if ($numitems) {
14919: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14920: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14921: my $path = $env{'form.archive_content_'.$i};
14922: if ($path =~ /^\Q$pathtocheck\E/) {
14923: if ($env{'form.archive_'.$i} eq 'discard') {
14924: if ($prefix ne '' && $path ne '') {
14925: if (-e $prefix.$path) {
1.1066 raeburn 14926: if ((@archdirs > 0) &&
14927: (grep(/^\Q$i\E$/,@archdirs))) {
14928: $todeletedir{$prefix.$path} = 1;
14929: } else {
14930: $todelete{$prefix.$path} = 1;
14931: }
1.1055 raeburn 14932: }
14933: }
14934: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14935: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14936: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14937: $docstitle = $env{'form.archive_title_'.$i};
14938: if ($docstitle eq '') {
14939: $docstitle = $title;
14940: }
1.1055 raeburn 14941: $outer = 0;
1.1056 raeburn 14942: if (ref($dirorder{$i}) eq 'ARRAY') {
14943: if (@{$dirorder{$i}} > 0) {
14944: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14945: if ($env{'form.archive_'.$item} eq 'display') {
14946: $outer = $item;
14947: last;
14948: }
14949: }
14950: }
14951: }
14952: my ($errtext,$fatal) =
14953: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14954: '/'.$folders{$outer}.'.'.
14955: $containers{$outer});
14956: next if ($fatal);
14957: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14958: if ($context eq 'coursedocs') {
1.1056 raeburn 14959: $mapinner{$i} = time;
1.1055 raeburn 14960: $folders{$i} = 'default_'.$mapinner{$i};
14961: $containers{$i} = 'sequence';
14962: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14963: $folders{$i}.'.'.$containers{$i};
14964: my $newidx = &LONCAPA::map::getresidx();
14965: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14966: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14967: push(@LONCAPA::map::order,$newidx);
14968: my ($outtext,$errtext) =
14969: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14970: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14971: '.'.$containers{$outer},1,1);
1.1056 raeburn 14972: $newseqid{$i} = $newidx;
1.1067 raeburn 14973: unless ($errtext) {
1.1294 raeburn 14974: $result .= '<li>'.&mt('Folder: [_1] added to course',
14975: &HTML::Entities::encode($docstitle,'<>&"')).
14976: '</li>'."\n";
1.1067 raeburn 14977: }
1.1055 raeburn 14978: }
14979: } else {
14980: if ($context eq 'coursedocs') {
14981: my $newidx=&LONCAPA::map::getresidx();
14982: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14983: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14984: $title;
1.1392 raeburn 14985: if (($outer !~ /\D/) &&
14986: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14987: ($newidx !~ /\D/)) {
1.1294 raeburn 14988: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14989: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14990: }
14991: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14992: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14993: }
14994: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14995: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14996: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14997: unless ($ishome) {
14998: my $fetch = "$newdest{$i}/$title";
14999: $fetch =~ s/^\Q$prefix$dir\E//;
15000: $prompttofetch{$fetch} = 1;
15001: }
1.1292 raeburn 15002: }
1.1067 raeburn 15003: }
1.1294 raeburn 15004: $LONCAPA::map::resources[$newidx]=
15005: $docstitle.':'.$url.':false:normal:res';
15006: push(@LONCAPA::map::order, $newidx);
15007: my ($outtext,$errtext)=
15008: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
15009: $docuname.'/'.$folders{$outer}.
15010: '.'.$containers{$outer},1,1);
15011: unless ($errtext) {
15012: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
15013: $result .= '<li>'.&mt('File: [_1] added to course',
15014: &HTML::Entities::encode($docstitle,'<>&"')).
15015: '</li>'."\n";
15016: }
1.1067 raeburn 15017: }
1.1294 raeburn 15018: } else {
15019: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
15020: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 15021: }
1.1055 raeburn 15022: }
15023: }
1.1086 raeburn 15024: }
15025: } else {
1.1294 raeburn 15026: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
15027: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 15028: }
15029: }
15030: for (my $i=1; $i<=$numitems; $i++) {
15031: next unless ($env{'form.archive_'.$i} eq 'dependency');
15032: my $path = $env{'form.archive_content_'.$i};
15033: if ($path =~ /^\Q$pathtocheck\E/) {
15034: my ($title) = ($path =~ m{/([^/]+)$});
15035: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
15036: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
15037: if (ref($dirorder{$i}) eq 'ARRAY') {
15038: my ($itemidx,$fullpath,$relpath);
15039: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
15040: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 15041: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 15042: if ($dirorder{$i}->[$j] eq $container) {
15043: $itemidx = $j;
1.1056 raeburn 15044: }
15045: }
1.1086 raeburn 15046: }
15047: if ($itemidx eq '') {
15048: $itemidx = 0;
15049: }
15050: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
15051: if ($mapinner{$referrer{$i}}) {
15052: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
15053: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15054: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15055: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15056: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15057: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15058: if (!-e $fullpath) {
15059: mkdir($fullpath,0755);
1.1056 raeburn 15060: }
15061: }
1.1086 raeburn 15062: } else {
15063: last;
1.1056 raeburn 15064: }
1.1086 raeburn 15065: }
15066: }
15067: } elsif ($newdest{$referrer{$i}}) {
15068: $fullpath = $newdest{$referrer{$i}};
15069: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15070: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
15071: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
15072: last;
15073: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15074: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15075: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15076: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15077: if (!-e $fullpath) {
15078: mkdir($fullpath,0755);
1.1056 raeburn 15079: }
15080: }
1.1086 raeburn 15081: } else {
15082: last;
1.1056 raeburn 15083: }
1.1055 raeburn 15084: }
15085: }
1.1086 raeburn 15086: if ($fullpath ne '') {
15087: if (-e "$prefix$path") {
1.1292 raeburn 15088: unless (rename("$prefix$path","$fullpath/$title")) {
15089: $warning .= &mt('Failed to rename dependency').'<br />';
15090: }
1.1086 raeburn 15091: }
15092: if (-e "$fullpath/$title") {
15093: my $showpath;
15094: if ($relpath ne '') {
15095: $showpath = "$relpath/$title";
15096: } else {
15097: $showpath = "/$title";
15098: }
1.1294 raeburn 15099: $result .= '<li>'.&mt('[_1] included as a dependency',
15100: &HTML::Entities::encode($showpath,'<>&"')).
15101: '</li>'."\n";
1.1292 raeburn 15102: unless ($ishome) {
15103: my $fetch = "$fullpath/$title";
15104: $fetch =~ s/^\Q$prefix$dir\E//;
15105: $prompttofetch{$fetch} = 1;
15106: }
1.1086 raeburn 15107: }
15108: }
1.1055 raeburn 15109: }
1.1086 raeburn 15110: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15111: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15112: &HTML::Entities::encode($path,'<>&"'),
15113: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15114: '<br />';
1.1055 raeburn 15115: }
15116: } else {
1.1294 raeburn 15117: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15118: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15119: }
15120: }
15121: if (keys(%todelete)) {
15122: foreach my $key (keys(%todelete)) {
15123: unlink($key);
1.1066 raeburn 15124: }
15125: }
15126: if (keys(%todeletedir)) {
15127: foreach my $key (keys(%todeletedir)) {
15128: rmdir($key);
15129: }
15130: }
15131: foreach my $dir (sort(keys(%is_dir))) {
15132: if (($pathtocheck ne '') && ($dir ne '')) {
15133: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15134: }
15135: }
1.1067 raeburn 15136: if ($result ne '') {
15137: $output .= '<ul>'."\n".
15138: $result."\n".
15139: '</ul>';
15140: }
15141: unless ($ishome) {
15142: my $replicationfail;
15143: foreach my $item (keys(%prompttofetch)) {
15144: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15145: unless ($fetchresult eq 'ok') {
15146: $replicationfail .= '<li>'.$item.'</li>'."\n";
15147: }
15148: }
15149: if ($replicationfail) {
15150: $output .= '<p class="LC_error">'.
15151: &mt('Course home server failed to retrieve:').'<ul>'.
15152: $replicationfail.
15153: '</ul></p>';
15154: }
15155: }
1.1055 raeburn 15156: } else {
15157: $warning = &mt('No items found in archive.');
15158: }
15159: if ($error) {
15160: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15161: $error.'</p>'."\n";
15162: }
15163: if ($warning) {
15164: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15165: }
15166: return $output;
15167: }
15168:
1.1066 raeburn 15169: sub cleanup_empty_dirs {
15170: my ($path) = @_;
15171: if (($path ne '') && (-d $path)) {
15172: if (opendir(my $dirh,$path)) {
15173: my @dircontents = grep(!/^\./,readdir($dirh));
15174: my $numitems = 0;
15175: foreach my $item (@dircontents) {
15176: if (-d "$path/$item") {
1.1111 raeburn 15177: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15178: if (-e "$path/$item") {
15179: $numitems ++;
15180: }
15181: } else {
15182: $numitems ++;
15183: }
15184: }
15185: if ($numitems == 0) {
15186: rmdir($path);
15187: }
15188: closedir($dirh);
15189: }
15190: }
15191: return;
15192: }
15193:
1.41 ng 15194: =pod
1.45 matthew 15195:
1.1162 raeburn 15196: =item * &get_folder_hierarchy()
1.1068 raeburn 15197:
15198: Provides hierarchy of names of folders/sub-folders containing the current
15199: item,
15200:
15201: Inputs: 3
15202: - $navmap - navmaps object
15203:
15204: - $map - url for map (either the trigger itself, or map containing
15205: the resource, which is the trigger).
15206:
15207: - $showitem - 1 => show title for map itself; 0 => do not show.
15208:
15209: Outputs: 1 @pathitems - array of folder/subfolder names.
15210:
15211: =cut
15212:
15213: sub get_folder_hierarchy {
15214: my ($navmap,$map,$showitem) = @_;
15215: my @pathitems;
15216: if (ref($navmap)) {
15217: my $mapres = $navmap->getResourceByUrl($map);
15218: if (ref($mapres)) {
15219: my $pcslist = $mapres->map_hierarchy();
15220: if ($pcslist ne '') {
15221: my @pcs = split(/,/,$pcslist);
15222: foreach my $pc (@pcs) {
15223: if ($pc == 1) {
1.1129 raeburn 15224: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15225: } else {
15226: my $res = $navmap->getByMapPc($pc);
15227: if (ref($res)) {
15228: my $title = $res->compTitle();
15229: $title =~ s/\W+/_/g;
15230: if ($title ne '') {
15231: push(@pathitems,$title);
15232: }
15233: }
15234: }
15235: }
15236: }
1.1071 raeburn 15237: if ($showitem) {
15238: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15239: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15240: } else {
15241: my $maptitle = $mapres->compTitle();
15242: $maptitle =~ s/\W+/_/g;
15243: if ($maptitle ne '') {
15244: push(@pathitems,$maptitle);
15245: }
1.1068 raeburn 15246: }
15247: }
15248: }
15249: }
15250: return @pathitems;
15251: }
15252:
15253: =pod
15254:
1.1015 raeburn 15255: =item * &get_turnedin_filepath()
15256:
15257: Determines path in a user's portfolio file for storage of files uploaded
15258: to a specific essayresponse or dropbox item.
15259:
15260: Inputs: 3 required + 1 optional.
15261: $symb is symb for resource, $uname and $udom are for current user (required).
15262: $caller is optional (can be "submission", if routine is called when storing
15263: an upoaded file when "Submit Answer" button was pressed).
15264:
15265: Returns array containing $path and $multiresp.
15266: $path is path in portfolio. $multiresp is 1 if this resource contains more
15267: than one file upload item. Callers of routine should append partid as a
15268: subdirectory to $path in cases where $multiresp is 1.
15269:
15270: Called by: homework/essayresponse.pm and homework/structuretags.pm
15271:
15272: =cut
15273:
15274: sub get_turnedin_filepath {
15275: my ($symb,$uname,$udom,$caller) = @_;
15276: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15277: my $turnindir;
15278: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15279: $turnindir = $userhash{'turnindir'};
15280: my ($path,$multiresp);
15281: if ($turnindir eq '') {
15282: if ($caller eq 'submission') {
15283: $turnindir = &mt('turned in');
15284: $turnindir =~ s/\W+/_/g;
15285: my %newhash = (
15286: 'turnindir' => $turnindir,
15287: );
15288: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15289: }
15290: }
15291: if ($turnindir ne '') {
15292: $path = '/'.$turnindir.'/';
15293: my ($multipart,$turnin,@pathitems);
15294: my $navmap = Apache::lonnavmaps::navmap->new();
15295: if (defined($navmap)) {
15296: my $mapres = $navmap->getResourceByUrl($map);
15297: if (ref($mapres)) {
15298: my $pcslist = $mapres->map_hierarchy();
15299: if ($pcslist ne '') {
15300: foreach my $pc (split(/,/,$pcslist)) {
15301: my $res = $navmap->getByMapPc($pc);
15302: if (ref($res)) {
15303: my $title = $res->compTitle();
15304: $title =~ s/\W+/_/g;
15305: if ($title ne '') {
1.1149 raeburn 15306: if (($pc > 1) && (length($title) > 12)) {
15307: $title = substr($title,0,12);
15308: }
1.1015 raeburn 15309: push(@pathitems,$title);
15310: }
15311: }
15312: }
15313: }
15314: my $maptitle = $mapres->compTitle();
15315: $maptitle =~ s/\W+/_/g;
15316: if ($maptitle ne '') {
1.1149 raeburn 15317: if (length($maptitle) > 12) {
15318: $maptitle = substr($maptitle,0,12);
15319: }
1.1015 raeburn 15320: push(@pathitems,$maptitle);
15321: }
15322: unless ($env{'request.state'} eq 'construct') {
15323: my $res = $navmap->getBySymb($symb);
15324: if (ref($res)) {
15325: my $partlist = $res->parts();
15326: my $totaluploads = 0;
15327: if (ref($partlist) eq 'ARRAY') {
15328: foreach my $part (@{$partlist}) {
15329: my @types = $res->responseType($part);
15330: my @ids = $res->responseIds($part);
15331: for (my $i=0; $i < scalar(@ids); $i++) {
15332: if ($types[$i] eq 'essay') {
15333: my $partid = $part.'_'.$ids[$i];
15334: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15335: $totaluploads ++;
15336: }
15337: }
15338: }
15339: }
15340: if ($totaluploads > 1) {
15341: $multiresp = 1;
15342: }
15343: }
15344: }
15345: }
15346: } else {
15347: return;
15348: }
15349: } else {
15350: return;
15351: }
15352: my $restitle=&Apache::lonnet::gettitle($symb);
15353: $restitle =~ s/\W+/_/g;
15354: if ($restitle eq '') {
15355: $restitle = ($resurl =~ m{/[^/]+$});
15356: if ($restitle eq '') {
15357: $restitle = time;
15358: }
15359: }
1.1149 raeburn 15360: if (length($restitle) > 12) {
15361: $restitle = substr($restitle,0,12);
15362: }
1.1015 raeburn 15363: push(@pathitems,$restitle);
15364: $path .= join('/',@pathitems);
15365: }
15366: return ($path,$multiresp);
15367: }
15368:
15369: =pod
15370:
1.464 albertel 15371: =back
1.41 ng 15372:
1.112 bowersj2 15373: =head1 CSV Upload/Handling functions
1.38 albertel 15374:
1.41 ng 15375: =over 4
15376:
1.648 raeburn 15377: =item * &upfile_store($r)
1.41 ng 15378:
15379: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15380: needs $env{'form.upfile'}
1.41 ng 15381: returns $datatoken to be put into hidden field
15382:
15383: =cut
1.31 albertel 15384:
15385: sub upfile_store {
15386: my $r=shift;
1.258 albertel 15387: $env{'form.upfile'}=~s/\r/\n/gs;
15388: $env{'form.upfile'}=~s/\f/\n/gs;
15389: $env{'form.upfile'}=~s/\n+/\n/gs;
15390: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15391:
1.1299 raeburn 15392: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15393: '_enroll_'.$env{'request.course.id'}.'_'.
15394: time.'_'.$$);
15395: return if ($datatoken eq '');
15396:
1.31 albertel 15397: {
1.158 raeburn 15398: my $datafile = $r->dir_config('lonDaemons').
15399: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15400: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15401: print $fh $env{'form.upfile'};
1.158 raeburn 15402: close($fh);
15403: }
1.31 albertel 15404: }
15405: return $datatoken;
15406: }
15407:
1.56 matthew 15408: =pod
15409:
1.1290 raeburn 15410: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15411:
15412: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15413: $datatoken is the name to assign to the temporary file.
1.258 albertel 15414: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15415:
15416: =cut
1.31 albertel 15417:
15418: sub load_tmp_file {
1.1290 raeburn 15419: my ($r,$datatoken) = @_;
15420: return if ($datatoken eq '');
1.31 albertel 15421: my @studentdata=();
15422: {
1.158 raeburn 15423: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15424: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15425: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15426: @studentdata=<$fh>;
15427: close($fh);
15428: }
1.31 albertel 15429: }
1.258 albertel 15430: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15431: }
15432:
1.1290 raeburn 15433: sub valid_datatoken {
15434: my ($datatoken) = @_;
1.1325 raeburn 15435: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15436: return $datatoken;
15437: }
15438: return;
15439: }
15440:
1.56 matthew 15441: =pod
15442:
1.648 raeburn 15443: =item * &upfile_record_sep()
1.41 ng 15444:
15445: Separate uploaded file into records
15446: returns array of records,
1.258 albertel 15447: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15448:
15449: =cut
1.31 albertel 15450:
15451: sub upfile_record_sep {
1.258 albertel 15452: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15453: } else {
1.248 albertel 15454: my @records;
1.258 albertel 15455: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15456: if ($line=~/^\s*$/) { next; }
15457: push(@records,$line);
15458: }
15459: return @records;
1.31 albertel 15460: }
15461: }
15462:
1.56 matthew 15463: =pod
15464:
1.648 raeburn 15465: =item * &record_sep($record)
1.41 ng 15466:
1.258 albertel 15467: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15468:
15469: =cut
15470:
1.263 www 15471: sub takeleft {
15472: my $index=shift;
15473: return substr('0000'.$index,-4,4);
15474: }
15475:
1.31 albertel 15476: sub record_sep {
15477: my $record=shift;
15478: my %components=();
1.258 albertel 15479: if ($env{'form.upfiletype'} eq 'xml') {
15480: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15481: my $i=0;
1.356 albertel 15482: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15483: $field=~s/^(\"|\')//;
15484: $field=~s/(\"|\')$//;
1.263 www 15485: $components{&takeleft($i)}=$field;
1.31 albertel 15486: $i++;
15487: }
1.258 albertel 15488: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15489: my $i=0;
1.356 albertel 15490: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15491: $field=~s/^(\"|\')//;
15492: $field=~s/(\"|\')$//;
1.263 www 15493: $components{&takeleft($i)}=$field;
1.31 albertel 15494: $i++;
15495: }
15496: } else {
1.561 www 15497: my $separator=',';
1.480 banghart 15498: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15499: $separator=';';
1.480 banghart 15500: }
1.31 albertel 15501: my $i=0;
1.561 www 15502: # the character we are looking for to indicate the end of a quote or a record
15503: my $looking_for=$separator;
15504: # do not add the characters to the fields
15505: my $ignore=0;
15506: # we just encountered a separator (or the beginning of the record)
15507: my $just_found_separator=1;
15508: # store the field we are working on here
15509: my $field='';
15510: # work our way through all characters in record
15511: foreach my $character ($record=~/(.)/g) {
15512: if ($character eq $looking_for) {
15513: if ($character ne $separator) {
15514: # Found the end of a quote, again looking for separator
15515: $looking_for=$separator;
15516: $ignore=1;
15517: } else {
15518: # Found a separator, store away what we got
15519: $components{&takeleft($i)}=$field;
15520: $i++;
15521: $just_found_separator=1;
15522: $ignore=0;
15523: $field='';
15524: }
15525: next;
15526: }
15527: # single or double quotation marks after a separator indicate beginning of a quote
15528: # we are now looking for the end of the quote and need to ignore separators
15529: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15530: $looking_for=$character;
15531: next;
15532: }
15533: # ignore would be true after we reached the end of a quote
15534: if ($ignore) { next; }
15535: if (($just_found_separator) && ($character=~/\s/)) { next; }
15536: $field.=$character;
15537: $just_found_separator=0;
1.31 albertel 15538: }
1.561 www 15539: # catch the very last entry, since we never encountered the separator
15540: $components{&takeleft($i)}=$field;
1.31 albertel 15541: }
15542: return %components;
15543: }
15544:
1.144 matthew 15545: ######################################################
15546: ######################################################
15547:
1.56 matthew 15548: =pod
15549:
1.648 raeburn 15550: =item * &upfile_select_html()
1.41 ng 15551:
1.144 matthew 15552: Return HTML code to select a file from the users machine and specify
15553: the file type.
1.41 ng 15554:
15555: =cut
15556:
1.144 matthew 15557: ######################################################
15558: ######################################################
1.31 albertel 15559: sub upfile_select_html {
1.144 matthew 15560: my %Types = (
15561: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15562: semisv => &mt('Semicolon separated values'),
1.144 matthew 15563: space => &mt('Space separated'),
15564: tab => &mt('Tabulator separated'),
15565: # xml => &mt('HTML/XML'),
15566: );
15567: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15568: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15569: foreach my $type (sort(keys(%Types))) {
15570: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15571: }
15572: $Str .= "</select>\n";
15573: return $Str;
1.31 albertel 15574: }
15575:
1.301 albertel 15576: sub get_samples {
15577: my ($records,$toget) = @_;
15578: my @samples=({});
15579: my $got=0;
15580: foreach my $rec (@$records) {
15581: my %temp = &record_sep($rec);
15582: if (! grep(/\S/, values(%temp))) { next; }
15583: if (%temp) {
15584: $samples[$got]=\%temp;
15585: $got++;
15586: if ($got == $toget) { last; }
15587: }
15588: }
15589: return \@samples;
15590: }
15591:
1.144 matthew 15592: ######################################################
15593: ######################################################
15594:
1.56 matthew 15595: =pod
15596:
1.648 raeburn 15597: =item * &csv_print_samples($r,$records)
1.41 ng 15598:
15599: Prints a table of sample values from each column uploaded $r is an
15600: Apache Request ref, $records is an arrayref from
15601: &Apache::loncommon::upfile_record_sep
15602:
15603: =cut
15604:
1.144 matthew 15605: ######################################################
15606: ######################################################
1.31 albertel 15607: sub csv_print_samples {
15608: my ($r,$records) = @_;
1.662 bisitz 15609: my $samples = &get_samples($records,5);
1.301 albertel 15610:
1.594 raeburn 15611: $r->print(&mt('Samples').'<br />'.&start_data_table().
15612: &start_data_table_header_row());
1.356 albertel 15613: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15614: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15615: $r->print(&end_data_table_header_row());
1.301 albertel 15616: foreach my $hash (@$samples) {
1.594 raeburn 15617: $r->print(&start_data_table_row());
1.356 albertel 15618: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15619: $r->print('<td>');
1.356 albertel 15620: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15621: $r->print('</td>');
15622: }
1.594 raeburn 15623: $r->print(&end_data_table_row());
1.31 albertel 15624: }
1.594 raeburn 15625: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15626: }
15627:
1.144 matthew 15628: ######################################################
15629: ######################################################
15630:
1.56 matthew 15631: =pod
15632:
1.648 raeburn 15633: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15634:
15635: Prints a table to create associations between values and table columns.
1.144 matthew 15636:
1.41 ng 15637: $r is an Apache Request ref,
15638: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15639: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15640:
15641: =cut
15642:
1.144 matthew 15643: ######################################################
15644: ######################################################
1.31 albertel 15645: sub csv_print_select_table {
15646: my ($r,$records,$d) = @_;
1.301 albertel 15647: my $i=0;
15648: my $samples = &get_samples($records,1);
1.144 matthew 15649: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15650: &start_data_table().&start_data_table_header_row().
1.144 matthew 15651: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15652: '<th>'.&mt('Column').'</th>'.
15653: &end_data_table_header_row()."\n");
1.356 albertel 15654: foreach my $array_ref (@$d) {
15655: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15656: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15657:
1.875 bisitz 15658: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15659: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15660: $r->print('<option value="none"></option>');
1.356 albertel 15661: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15662: $r->print('<option value="'.$sample.'"'.
15663: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15664: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15665: }
1.594 raeburn 15666: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15667: $i++;
15668: }
1.594 raeburn 15669: $r->print(&end_data_table());
1.31 albertel 15670: $i--;
15671: return $i;
15672: }
1.56 matthew 15673:
1.144 matthew 15674: ######################################################
15675: ######################################################
15676:
1.56 matthew 15677: =pod
1.31 albertel 15678:
1.648 raeburn 15679: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15680:
15681: Prints a table of sample values from the upload and can make associate samples to internal names.
15682:
15683: $r is an Apache Request ref,
15684: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15685: $d is an array of 2 element arrays (internal name, displayed name)
15686:
15687: =cut
15688:
1.144 matthew 15689: ######################################################
15690: ######################################################
1.31 albertel 15691: sub csv_samples_select_table {
15692: my ($r,$records,$d) = @_;
15693: my $i=0;
1.144 matthew 15694: #
1.662 bisitz 15695: my $max_samples = 5;
15696: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15697: $r->print(&start_data_table().
15698: &start_data_table_header_row().'<th>'.
15699: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15700: &end_data_table_header_row());
1.301 albertel 15701:
15702: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15703: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15704: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15705: foreach my $option (@$d) {
15706: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15707: $r->print('<option value="'.$value.'"'.
1.253 albertel 15708: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15709: $display.'</option>');
1.31 albertel 15710: }
15711: $r->print('</select></td><td>');
1.662 bisitz 15712: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15713: if (defined($samples->[$line]{$key})) {
15714: $r->print($samples->[$line]{$key}."<br />\n");
15715: }
15716: }
1.594 raeburn 15717: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15718: $i++;
15719: }
1.594 raeburn 15720: $r->print(&end_data_table());
1.31 albertel 15721: $i--;
15722: return($i);
1.115 matthew 15723: }
15724:
1.144 matthew 15725: ######################################################
15726: ######################################################
15727:
1.115 matthew 15728: =pod
15729:
1.648 raeburn 15730: =item * &clean_excel_name($name)
1.115 matthew 15731:
15732: Returns a replacement for $name which does not contain any illegal characters.
15733:
15734: =cut
15735:
1.144 matthew 15736: ######################################################
15737: ######################################################
1.115 matthew 15738: sub clean_excel_name {
15739: my ($name) = @_;
15740: $name =~ s/[:\*\?\/\\]//g;
15741: if (length($name) > 31) {
15742: $name = substr($name,0,31);
15743: }
15744: return $name;
1.25 albertel 15745: }
1.84 albertel 15746:
1.85 albertel 15747: =pod
15748:
1.648 raeburn 15749: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15750:
15751: Returns either 1 or undef
15752:
15753: 1 if the part is to be hidden, undef if it is to be shown
15754:
15755: Arguments are:
15756:
15757: $id the id of the part to be checked
15758: $symb, optional the symb of the resource to check
15759: $udom, optional the domain of the user to check for
15760: $uname, optional the username of the user to check for
15761:
15762: =cut
1.84 albertel 15763:
15764: sub check_if_partid_hidden {
15765: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15766: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15767: $symb,$udom,$uname);
1.141 albertel 15768: my $truth=1;
15769: #if the string starts with !, then the list is the list to show not hide
15770: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15771: my @hiddenlist=split(/,/,$hiddenparts);
15772: foreach my $checkid (@hiddenlist) {
1.141 albertel 15773: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15774: }
1.141 albertel 15775: return !$truth;
1.84 albertel 15776: }
1.127 matthew 15777:
1.138 matthew 15778:
15779: ############################################################
15780: ############################################################
15781:
15782: =pod
15783:
1.157 matthew 15784: =back
15785:
1.138 matthew 15786: =head1 cgi-bin script and graphing routines
15787:
1.157 matthew 15788: =over 4
15789:
1.648 raeburn 15790: =item * &get_cgi_id()
1.138 matthew 15791:
15792: Inputs: none
15793:
15794: Returns an id which can be used to pass environment variables
15795: to various cgi-bin scripts. These environment variables will
15796: be removed from the users environment after a given time by
15797: the routine &Apache::lonnet::transfer_profile_to_env.
15798:
15799: =cut
15800:
15801: ############################################################
15802: ############################################################
1.152 albertel 15803: my $uniq=0;
1.136 matthew 15804: sub get_cgi_id {
1.154 albertel 15805: $uniq=($uniq+1)%100000;
1.280 albertel 15806: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15807: }
15808:
1.127 matthew 15809: ############################################################
15810: ############################################################
15811:
15812: =pod
15813:
1.648 raeburn 15814: =item * &DrawBarGraph()
1.127 matthew 15815:
1.138 matthew 15816: Facilitates the plotting of data in a (stacked) bar graph.
15817: Puts plot definition data into the users environment in order for
15818: graph.png to plot it. Returns an <img> tag for the plot.
15819: The bars on the plot are labeled '1','2',...,'n'.
15820:
15821: Inputs:
15822:
15823: =over 4
15824:
15825: =item $Title: string, the title of the plot
15826:
15827: =item $xlabel: string, text describing the X-axis of the plot
15828:
15829: =item $ylabel: string, text describing the Y-axis of the plot
15830:
15831: =item $Max: scalar, the maximum Y value to use in the plot
15832: If $Max is < any data point, the graph will not be rendered.
15833:
1.140 matthew 15834: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15835: they are plotted. If undefined, default values will be used.
15836:
1.178 matthew 15837: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15838:
1.138 matthew 15839: =item @Values: An array of array references. Each array reference holds data
15840: to be plotted in a stacked bar chart.
15841:
1.239 matthew 15842: =item If the final element of @Values is a hash reference the key/value
15843: pairs will be added to the graph definition.
15844:
1.138 matthew 15845: =back
15846:
15847: Returns:
15848:
15849: An <img> tag which references graph.png and the appropriate identifying
15850: information for the plot.
15851:
1.127 matthew 15852: =cut
15853:
15854: ############################################################
15855: ############################################################
1.134 matthew 15856: sub DrawBarGraph {
1.178 matthew 15857: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15858: #
15859: if (! defined($colors)) {
15860: $colors = ['#33ff00',
15861: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15862: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15863: ];
15864: }
1.228 matthew 15865: my $extra_settings = {};
15866: if (ref($Values[-1]) eq 'HASH') {
15867: $extra_settings = pop(@Values);
15868: }
1.127 matthew 15869: #
1.136 matthew 15870: my $identifier = &get_cgi_id();
15871: my $id = 'cgi.'.$identifier;
1.129 matthew 15872: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15873: return '';
15874: }
1.225 matthew 15875: #
15876: my @Labels;
15877: if (defined($labels)) {
15878: @Labels = @$labels;
15879: } else {
15880: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15881: push(@Labels,$i+1);
1.225 matthew 15882: }
15883: }
15884: #
1.129 matthew 15885: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15886: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15887: my %ValuesHash;
15888: my $NumSets=1;
15889: foreach my $array (@Values) {
15890: next if (! ref($array));
1.136 matthew 15891: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15892: join(',',@$array);
1.129 matthew 15893: }
1.127 matthew 15894: #
1.136 matthew 15895: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15896: if ($NumBars < 3) {
15897: $width = 120+$NumBars*32;
1.220 matthew 15898: $xskip = 1;
1.225 matthew 15899: $bar_width = 30;
15900: } elsif ($NumBars < 5) {
15901: $width = 120+$NumBars*20;
15902: $xskip = 1;
15903: $bar_width = 20;
1.220 matthew 15904: } elsif ($NumBars < 10) {
1.136 matthew 15905: $width = 120+$NumBars*15;
15906: $xskip = 1;
15907: $bar_width = 15;
15908: } elsif ($NumBars <= 25) {
15909: $width = 120+$NumBars*11;
15910: $xskip = 5;
15911: $bar_width = 8;
15912: } elsif ($NumBars <= 50) {
15913: $width = 120+$NumBars*8;
15914: $xskip = 5;
15915: $bar_width = 4;
15916: } else {
15917: $width = 120+$NumBars*8;
15918: $xskip = 5;
15919: $bar_width = 4;
15920: }
15921: #
1.137 matthew 15922: $Max = 1 if ($Max < 1);
15923: if ( int($Max) < $Max ) {
15924: $Max++;
15925: $Max = int($Max);
15926: }
1.127 matthew 15927: $Title = '' if (! defined($Title));
15928: $xlabel = '' if (! defined($xlabel));
15929: $ylabel = '' if (! defined($ylabel));
1.369 www 15930: $ValuesHash{$id.'.title'} = &escape($Title);
15931: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15932: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15933: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15934: $ValuesHash{$id.'.NumBars'} = $NumBars;
15935: $ValuesHash{$id.'.NumSets'} = $NumSets;
15936: $ValuesHash{$id.'.PlotType'} = 'bar';
15937: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15938: $ValuesHash{$id.'.height'} = $height;
15939: $ValuesHash{$id.'.width'} = $width;
15940: $ValuesHash{$id.'.xskip'} = $xskip;
15941: $ValuesHash{$id.'.bar_width'} = $bar_width;
15942: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15943: #
1.228 matthew 15944: # Deal with other parameters
15945: while (my ($key,$value) = each(%$extra_settings)) {
15946: $ValuesHash{$id.'.'.$key} = $value;
15947: }
15948: #
1.646 raeburn 15949: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15950: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15951: }
15952:
15953: ############################################################
15954: ############################################################
15955:
15956: =pod
15957:
1.648 raeburn 15958: =item * &DrawXYGraph()
1.137 matthew 15959:
1.138 matthew 15960: Facilitates the plotting of data in an XY graph.
15961: Puts plot definition data into the users environment in order for
15962: graph.png to plot it. Returns an <img> tag for the plot.
15963:
15964: Inputs:
15965:
15966: =over 4
15967:
15968: =item $Title: string, the title of the plot
15969:
15970: =item $xlabel: string, text describing the X-axis of the plot
15971:
15972: =item $ylabel: string, text describing the Y-axis of the plot
15973:
15974: =item $Max: scalar, the maximum Y value to use in the plot
15975: If $Max is < any data point, the graph will not be rendered.
15976:
15977: =item $colors: Array ref containing the hex color codes for the data to be
15978: plotted in. If undefined, default values will be used.
15979:
15980: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15981:
15982: =item $Ydata: Array ref containing Array refs.
1.185 www 15983: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15984:
15985: =item %Values: hash indicating or overriding any default values which are
15986: passed to graph.png.
15987: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15988:
15989: =back
15990:
15991: Returns:
15992:
15993: An <img> tag which references graph.png and the appropriate identifying
15994: information for the plot.
15995:
1.137 matthew 15996: =cut
15997:
15998: ############################################################
15999: ############################################################
16000: sub DrawXYGraph {
16001: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
16002: #
16003: # Create the identifier for the graph
16004: my $identifier = &get_cgi_id();
16005: my $id = 'cgi.'.$identifier;
16006: #
16007: $Title = '' if (! defined($Title));
16008: $xlabel = '' if (! defined($xlabel));
16009: $ylabel = '' if (! defined($ylabel));
16010: my %ValuesHash =
16011: (
1.369 www 16012: $id.'.title' => &escape($Title),
16013: $id.'.xlabel' => &escape($xlabel),
16014: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 16015: $id.'.y_max_value'=> $Max,
16016: $id.'.labels' => join(',',@$Xlabels),
16017: $id.'.PlotType' => 'XY',
16018: );
16019: #
16020: if (defined($colors) && ref($colors) eq 'ARRAY') {
16021: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16022: }
16023: #
16024: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
16025: return '';
16026: }
16027: my $NumSets=1;
1.138 matthew 16028: foreach my $array (@{$Ydata}){
1.137 matthew 16029: next if (! ref($array));
16030: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
16031: }
1.138 matthew 16032: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 16033: #
16034: # Deal with other parameters
16035: while (my ($key,$value) = each(%Values)) {
16036: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 16037: }
16038: #
1.646 raeburn 16039: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 16040: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
16041: }
16042:
16043: ############################################################
16044: ############################################################
16045:
16046: =pod
16047:
1.648 raeburn 16048: =item * &DrawXYYGraph()
1.138 matthew 16049:
16050: Facilitates the plotting of data in an XY graph with two Y axes.
16051: Puts plot definition data into the users environment in order for
16052: graph.png to plot it. Returns an <img> tag for the plot.
16053:
16054: Inputs:
16055:
16056: =over 4
16057:
16058: =item $Title: string, the title of the plot
16059:
16060: =item $xlabel: string, text describing the X-axis of the plot
16061:
16062: =item $ylabel: string, text describing the Y-axis of the plot
16063:
16064: =item $colors: Array ref containing the hex color codes for the data to be
16065: plotted in. If undefined, default values will be used.
16066:
16067: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
16068:
16069: =item $Ydata1: The first data set
16070:
16071: =item $Min1: The minimum value of the left Y-axis
16072:
16073: =item $Max1: The maximum value of the left Y-axis
16074:
16075: =item $Ydata2: The second data set
16076:
16077: =item $Min2: The minimum value of the right Y-axis
16078:
16079: =item $Max2: The maximum value of the left Y-axis
16080:
16081: =item %Values: hash indicating or overriding any default values which are
16082: passed to graph.png.
16083: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16084:
16085: =back
16086:
16087: Returns:
16088:
16089: An <img> tag which references graph.png and the appropriate identifying
16090: information for the plot.
1.136 matthew 16091:
16092: =cut
16093:
16094: ############################################################
16095: ############################################################
1.137 matthew 16096: sub DrawXYYGraph {
16097: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16098: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16099: #
16100: # Create the identifier for the graph
16101: my $identifier = &get_cgi_id();
16102: my $id = 'cgi.'.$identifier;
16103: #
16104: $Title = '' if (! defined($Title));
16105: $xlabel = '' if (! defined($xlabel));
16106: $ylabel = '' if (! defined($ylabel));
16107: my %ValuesHash =
16108: (
1.369 www 16109: $id.'.title' => &escape($Title),
16110: $id.'.xlabel' => &escape($xlabel),
16111: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16112: $id.'.labels' => join(',',@$Xlabels),
16113: $id.'.PlotType' => 'XY',
16114: $id.'.NumSets' => 2,
1.137 matthew 16115: $id.'.two_axes' => 1,
16116: $id.'.y1_max_value' => $Max1,
16117: $id.'.y1_min_value' => $Min1,
16118: $id.'.y2_max_value' => $Max2,
16119: $id.'.y2_min_value' => $Min2,
1.136 matthew 16120: );
16121: #
1.137 matthew 16122: if (defined($colors) && ref($colors) eq 'ARRAY') {
16123: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16124: }
16125: #
16126: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16127: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16128: return '';
16129: }
16130: my $NumSets=1;
1.137 matthew 16131: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16132: next if (! ref($array));
16133: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16134: }
16135: #
16136: # Deal with other parameters
16137: while (my ($key,$value) = each(%Values)) {
16138: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16139: }
16140: #
1.646 raeburn 16141: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16142: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16143: }
16144:
16145: ############################################################
16146: ############################################################
16147:
16148: =pod
16149:
1.157 matthew 16150: =back
16151:
1.139 matthew 16152: =head1 Statistics helper routines?
16153:
16154: Bad place for them but what the hell.
16155:
1.157 matthew 16156: =over 4
16157:
1.648 raeburn 16158: =item * &chartlink()
1.139 matthew 16159:
16160: Returns a link to the chart for a specific student.
16161:
16162: Inputs:
16163:
16164: =over 4
16165:
16166: =item $linktext: The text of the link
16167:
16168: =item $sname: The students username
16169:
16170: =item $sdomain: The students domain
16171:
16172: =back
16173:
1.157 matthew 16174: =back
16175:
1.139 matthew 16176: =cut
16177:
16178: ############################################################
16179: ############################################################
16180: sub chartlink {
16181: my ($linktext, $sname, $sdomain) = @_;
16182: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16183: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16184: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16185: '">'.$linktext.'</a>';
1.153 matthew 16186: }
16187:
16188: #######################################################
16189: #######################################################
16190:
16191: =pod
16192:
16193: =head1 Course Environment Routines
1.157 matthew 16194:
16195: =over 4
1.153 matthew 16196:
1.648 raeburn 16197: =item * &restore_course_settings()
1.153 matthew 16198:
1.648 raeburn 16199: =item * &store_course_settings()
1.153 matthew 16200:
16201: Restores/Store indicated form parameters from the course environment.
16202: Will not overwrite existing values of the form parameters.
16203:
16204: Inputs:
16205: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16206:
16207: a hash ref describing the data to be stored. For example:
16208:
16209: %Save_Parameters = ('Status' => 'scalar',
16210: 'chartoutputmode' => 'scalar',
16211: 'chartoutputdata' => 'scalar',
16212: 'Section' => 'array',
1.373 raeburn 16213: 'Group' => 'array',
1.153 matthew 16214: 'StudentData' => 'array',
16215: 'Maps' => 'array');
16216:
16217: Returns: both routines return nothing
16218:
1.631 raeburn 16219: =back
16220:
1.153 matthew 16221: =cut
16222:
16223: #######################################################
16224: #######################################################
16225: sub store_course_settings {
1.496 albertel 16226: return &store_settings($env{'request.course.id'},@_);
16227: }
16228:
16229: sub store_settings {
1.153 matthew 16230: # save to the environment
16231: # appenv the same items, just to be safe
1.300 albertel 16232: my $udom = $env{'user.domain'};
16233: my $uname = $env{'user.name'};
1.496 albertel 16234: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16235: my %SaveHash;
16236: my %AppHash;
16237: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16238: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16239: my $envname = 'environment.'.$basename;
1.258 albertel 16240: if (exists($env{'form.'.$setting})) {
1.153 matthew 16241: # Save this value away
16242: if ($type eq 'scalar' &&
1.258 albertel 16243: (! exists($env{$envname}) ||
16244: $env{$envname} ne $env{'form.'.$setting})) {
16245: $SaveHash{$basename} = $env{'form.'.$setting};
16246: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16247: } elsif ($type eq 'array') {
16248: my $stored_form;
1.258 albertel 16249: if (ref($env{'form.'.$setting})) {
1.153 matthew 16250: $stored_form = join(',',
16251: map {
1.369 www 16252: &escape($_);
1.258 albertel 16253: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16254: } else {
16255: $stored_form =
1.369 www 16256: &escape($env{'form.'.$setting});
1.153 matthew 16257: }
16258: # Determine if the array contents are the same.
1.258 albertel 16259: if ($stored_form ne $env{$envname}) {
1.153 matthew 16260: $SaveHash{$basename} = $stored_form;
16261: $AppHash{$envname} = $stored_form;
16262: }
16263: }
16264: }
16265: }
16266: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16267: $udom,$uname);
1.153 matthew 16268: if ($put_result !~ /^(ok|delayed)/) {
16269: &Apache::lonnet::logthis('unable to save form parameters, '.
16270: 'got error:'.$put_result);
16271: }
16272: # Make sure these settings stick around in this session, too
1.646 raeburn 16273: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16274: return;
16275: }
16276:
16277: sub restore_course_settings {
1.499 albertel 16278: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16279: }
16280:
16281: sub restore_settings {
16282: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16283: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16284: next if (exists($env{'form.'.$setting}));
1.496 albertel 16285: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16286: '.'.$setting;
1.258 albertel 16287: if (exists($env{$envname})) {
1.153 matthew 16288: if ($type eq 'scalar') {
1.258 albertel 16289: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16290: } elsif ($type eq 'array') {
1.258 albertel 16291: $env{'form.'.$setting} = [
1.153 matthew 16292: map {
1.369 www 16293: &unescape($_);
1.258 albertel 16294: } split(',',$env{$envname})
1.153 matthew 16295: ];
16296: }
16297: }
16298: }
1.127 matthew 16299: }
16300:
1.618 raeburn 16301: #######################################################
16302: #######################################################
16303:
16304: =pod
16305:
16306: =head1 Domain E-mail Routines
16307:
16308: =over 4
16309:
1.648 raeburn 16310: =item * &build_recipient_list()
1.618 raeburn 16311:
1.1144 raeburn 16312: Build recipient lists for following types of e-mail:
1.766 raeburn 16313: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16314: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16315: module change checking, student/employee ID conflict checks, as
16316: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16317: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16318:
16319: Inputs:
1.619 raeburn 16320: defmail (scalar - email address of default recipient),
1.1144 raeburn 16321: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16322: requestsmail, updatesmail, or idconflictsmail).
16323:
1.619 raeburn 16324: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16325:
1.619 raeburn 16326: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16327: i.e., predates configuration by DC via domainprefs.pm
16328:
16329: $requname username of requester (if mailing type is helpdeskmail)
16330:
16331: $requdom domain of requester (if mailing type is helpdeskmail)
16332:
16333: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16334:
1.618 raeburn 16335:
1.655 raeburn 16336: Returns: comma separated list of addresses to which to send e-mail.
16337:
16338: =back
1.618 raeburn 16339:
16340: =cut
16341:
16342: ############################################################
16343: ############################################################
16344: sub build_recipient_list {
1.1297 raeburn 16345: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16346: my @recipients;
1.1270 raeburn 16347: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16348: my %domconfig =
1.1270 raeburn 16349: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16350: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16351: if (exists($domconfig{'contacts'}{$mailing})) {
16352: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16353: my @contacts = ('adminemail','supportemail');
16354: foreach my $item (@contacts) {
16355: if ($domconfig{'contacts'}{$mailing}{$item}) {
16356: my $addr = $domconfig{'contacts'}{$item};
16357: if (!grep(/^\Q$addr\E$/,@recipients)) {
16358: push(@recipients,$addr);
16359: }
1.619 raeburn 16360: }
1.1270 raeburn 16361: }
16362: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16363: if ($mailing eq 'helpdeskmail') {
16364: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16365: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16366: my @ok_bccs;
16367: foreach my $bcc (@bccs) {
16368: $bcc =~ s/^\s+//g;
16369: $bcc =~ s/\s+$//g;
16370: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16371: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16372: push(@ok_bccs,$bcc);
16373: }
16374: }
16375: }
16376: if (@ok_bccs > 0) {
16377: $allbcc = join(', ',@ok_bccs);
16378: }
16379: }
16380: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16381: }
16382: }
1.766 raeburn 16383: } elsif ($origmail ne '') {
1.1270 raeburn 16384: $lastresort = $origmail;
1.618 raeburn 16385: }
1.1297 raeburn 16386: if ($mailing eq 'helpdeskmail') {
16387: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16388: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16389: my ($inststatus,$inststatus_checked);
16390: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16391: ($env{'user.domain'} ne 'public')) {
16392: $inststatus_checked = 1;
16393: $inststatus = $env{'environment.inststatus'};
16394: }
16395: unless ($inststatus_checked) {
16396: if (($requname ne '') && ($requdom ne '')) {
16397: if (($requname =~ /^$match_username$/) &&
16398: ($requdom =~ /^$match_domain$/) &&
16399: (&Apache::lonnet::domain($requdom))) {
16400: my $requhome = &Apache::lonnet::homeserver($requname,
16401: $requdom);
16402: unless ($requhome eq 'no_host') {
16403: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16404: $inststatus = $userenv{'inststatus'};
16405: $inststatus_checked = 1;
16406: }
16407: }
16408: }
16409: }
16410: unless ($inststatus_checked) {
16411: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16412: my %srch = (srchby => 'email',
16413: srchdomain => $defdom,
16414: srchterm => $reqemail,
16415: srchtype => 'exact');
16416: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16417: foreach my $uname (keys(%srch_results)) {
16418: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16419: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16420: $inststatus_checked = 1;
16421: last;
16422: }
16423: }
16424: unless ($inststatus_checked) {
16425: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16426: if ($dirsrchres eq 'ok') {
16427: foreach my $uname (keys(%srch_results)) {
16428: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16429: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16430: $inststatus_checked = 1;
16431: last;
16432: }
16433: }
16434: }
16435: }
16436: }
16437: }
16438: if ($inststatus ne '') {
16439: foreach my $status (split(/\:/,$inststatus)) {
16440: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16441: my @contacts = ('adminemail','supportemail');
16442: foreach my $item (@contacts) {
16443: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16444: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16445: if (!grep(/^\Q$addr\E$/,@recipients)) {
16446: push(@recipients,$addr);
16447: }
16448: }
16449: }
16450: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16451: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16452: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16453: my @ok_bccs;
16454: foreach my $bcc (@bccs) {
16455: $bcc =~ s/^\s+//g;
16456: $bcc =~ s/\s+$//g;
16457: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16458: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16459: push(@ok_bccs,$bcc);
16460: }
16461: }
16462: }
16463: if (@ok_bccs > 0) {
16464: $allbcc = join(', ',@ok_bccs);
16465: }
16466: }
16467: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16468: last;
16469: }
16470: }
16471: }
16472: }
16473: }
1.619 raeburn 16474: } elsif ($origmail ne '') {
1.1270 raeburn 16475: $lastresort = $origmail;
16476: }
1.1297 raeburn 16477: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16478: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16479: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16480: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16481: my %what = (
16482: perlvar => 1,
16483: );
16484: my $primary = &Apache::lonnet::domain($defdom,'primary');
16485: if ($primary) {
16486: my $gotaddr;
16487: my ($result,$returnhash) =
16488: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16489: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16490: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16491: $lastresort = $returnhash->{'lonSupportEMail'};
16492: $gotaddr = 1;
16493: }
16494: }
16495: unless ($gotaddr) {
16496: my $uintdom = &Apache::lonnet::internet_dom($primary);
16497: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16498: unless ($uintdom eq $intdom) {
16499: my %domconfig =
16500: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16501: if (ref($domconfig{'contacts'}) eq 'HASH') {
16502: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16503: my @contacts = ('adminemail','supportemail');
16504: foreach my $item (@contacts) {
16505: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16506: my $addr = $domconfig{'contacts'}{$item};
16507: if (!grep(/^\Q$addr\E$/,@recipients)) {
16508: push(@recipients,$addr);
16509: }
16510: }
16511: }
16512: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16513: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16514: }
16515: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16516: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16517: my @ok_bccs;
16518: foreach my $bcc (@bccs) {
16519: $bcc =~ s/^\s+//g;
16520: $bcc =~ s/\s+$//g;
16521: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16522: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16523: push(@ok_bccs,$bcc);
16524: }
16525: }
16526: }
16527: if (@ok_bccs > 0) {
16528: $allbcc = join(', ',@ok_bccs);
16529: }
16530: }
16531: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16532: }
16533: }
16534: }
16535: }
16536: }
16537: }
1.618 raeburn 16538: }
1.688 raeburn 16539: if (defined($defmail)) {
16540: if ($defmail ne '') {
16541: push(@recipients,$defmail);
16542: }
1.618 raeburn 16543: }
16544: if ($otheremails) {
1.619 raeburn 16545: my @others;
16546: if ($otheremails =~ /,/) {
16547: @others = split(/,/,$otheremails);
1.618 raeburn 16548: } else {
1.619 raeburn 16549: push(@others,$otheremails);
16550: }
16551: foreach my $addr (@others) {
16552: if (!grep(/^\Q$addr\E$/,@recipients)) {
16553: push(@recipients,$addr);
16554: }
1.618 raeburn 16555: }
16556: }
1.1298 raeburn 16557: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16558: if ((!@recipients) && ($lastresort ne '')) {
16559: push(@recipients,$lastresort);
16560: }
16561: } elsif ($lastresort ne '') {
16562: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16563: push(@recipients,$lastresort);
16564: }
16565: }
1.1271 raeburn 16566: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16567: if (wantarray) {
16568: return ($recipientlist,$allbcc,$addtext);
16569: } else {
16570: return $recipientlist;
16571: }
1.618 raeburn 16572: }
16573:
1.127 matthew 16574: ############################################################
16575: ############################################################
1.154 albertel 16576:
1.655 raeburn 16577: =pod
16578:
1.1224 musolffc 16579: =over 4
16580:
1.1223 musolffc 16581: =item * &mime_email()
16582:
16583: Sends an email with a possible attachment
16584:
16585: Inputs:
16586:
16587: =over 4
16588:
16589: from - Sender's email address
16590:
1.1343 raeburn 16591: replyto - Reply-To email address
16592:
1.1223 musolffc 16593: to - Email address of recipient
16594:
16595: subject - Subject of email
16596:
16597: body - Body of email
16598:
16599: cc_string - Carbon copy email address
16600:
16601: bcc - Blind carbon copy email address
16602:
16603: attachment_path - Path of file to be attached
16604:
16605: file_name - Name of file to be attached
16606:
16607: attachment_text - The body of an attachment of type "TEXT"
16608:
16609: =back
16610:
16611: =back
16612:
16613: =cut
16614:
16615: ############################################################
16616: ############################################################
16617:
16618: sub mime_email {
1.1343 raeburn 16619: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16620: $file_name,$attachment_text) = @_;
16621:
1.1223 musolffc 16622: my $msg = MIME::Lite->new(
16623: From => $from,
16624: To => $to,
16625: Subject => $subject,
16626: Type =>'TEXT',
16627: Data => $body,
16628: );
1.1343 raeburn 16629: if ($replyto ne '') {
16630: $msg->add("Reply-To" => $replyto);
16631: }
1.1223 musolffc 16632: if ($cc_string ne '') {
16633: $msg->add("Cc" => $cc_string);
16634: }
16635: if ($bcc ne '') {
16636: $msg->add("Bcc" => $bcc);
16637: }
16638: $msg->attr("content-type" => "text/plain");
16639: $msg->attr("content-type.charset" => "UTF-8");
16640: # Attach file if given
16641: if ($attachment_path) {
16642: unless ($file_name) {
16643: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16644: }
16645: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16646: $msg->attach(Type => $type,
16647: Path => $attachment_path,
16648: Filename => $file_name
16649: );
16650: # Otherwise attach text if given
16651: } elsif ($attachment_text) {
16652: $msg->attach(Type => 'TEXT',
16653: Data => $attachment_text);
16654: }
16655: # Send it
16656: $msg->send('sendmail');
16657: }
16658:
16659: ############################################################
16660: ############################################################
16661:
16662: =pod
16663:
1.655 raeburn 16664: =head1 Course Catalog Routines
16665:
16666: =over 4
16667:
16668: =item * &gather_categories()
16669:
16670: Converts category definitions - keys of categories hash stored in
16671: coursecategories in configuration.db on the primary library server in a
16672: domain - to an array. Also generates javascript and idx hash used to
16673: generate Domain Coordinator interface for editing Course Categories.
16674:
16675: Inputs:
1.663 raeburn 16676:
1.655 raeburn 16677: categories (reference to hash of category definitions).
1.663 raeburn 16678:
1.655 raeburn 16679: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16680: categories and subcategories).
1.663 raeburn 16681:
1.655 raeburn 16682: idx (reference to hash of counters used in Domain Coordinator interface for
16683: editing Course Categories).
1.663 raeburn 16684:
1.655 raeburn 16685: jsarray (reference to array of categories used to create Javascript arrays for
16686: Domain Coordinator interface for editing Course Categories).
16687:
16688: Returns: nothing
16689:
16690: Side effects: populates cats, idx and jsarray.
16691:
16692: =cut
16693:
16694: sub gather_categories {
16695: my ($categories,$cats,$idx,$jsarray) = @_;
16696: my %counters;
16697: my $num = 0;
16698: foreach my $item (keys(%{$categories})) {
16699: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16700: if ($container eq '' && $depth == 0) {
16701: $cats->[$depth][$categories->{$item}] = $cat;
16702: } else {
16703: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16704: }
16705: my ($escitem,$tail) = split(/:/,$item,2);
16706: if ($counters{$tail} eq '') {
16707: $counters{$tail} = $num;
16708: $num ++;
16709: }
16710: if (ref($idx) eq 'HASH') {
16711: $idx->{$item} = $counters{$tail};
16712: }
16713: if (ref($jsarray) eq 'ARRAY') {
16714: push(@{$jsarray->[$counters{$tail}]},$item);
16715: }
16716: }
16717: return;
16718: }
16719:
16720: =pod
16721:
16722: =item * &extract_categories()
16723:
16724: Used to generate breadcrumb trails for course categories.
16725:
16726: Inputs:
1.663 raeburn 16727:
1.655 raeburn 16728: categories (reference to hash of category definitions).
1.663 raeburn 16729:
1.655 raeburn 16730: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16731: categories and subcategories).
1.663 raeburn 16732:
1.655 raeburn 16733: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16734:
1.655 raeburn 16735: allitems (reference to hash - key is category key
16736: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16737:
1.655 raeburn 16738: idx (reference to hash of counters used in Domain Coordinator interface for
16739: editing Course Categories).
1.663 raeburn 16740:
1.655 raeburn 16741: jsarray (reference to array of categories used to create Javascript arrays for
16742: Domain Coordinator interface for editing Course Categories).
16743:
1.665 raeburn 16744: subcats (reference to hash of arrays containing all subcategories within each
16745: category, -recursive)
16746:
1.1321 raeburn 16747: maxd (reference to hash used to hold max depth for all top-level categories).
16748:
1.655 raeburn 16749: Returns: nothing
16750:
16751: Side effects: populates trails and allitems hash references.
16752:
16753: =cut
16754:
16755: sub extract_categories {
1.1321 raeburn 16756: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16757: if (ref($categories) eq 'HASH') {
16758: &gather_categories($categories,$cats,$idx,$jsarray);
16759: if (ref($cats->[0]) eq 'ARRAY') {
16760: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16761: my $name = $cats->[0][$i];
16762: my $item = &escape($name).'::0';
16763: my $trailstr;
16764: if ($name eq 'instcode') {
16765: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16766: } elsif ($name eq 'communities') {
16767: $trailstr = &mt('Communities');
1.1239 raeburn 16768: } elsif ($name eq 'placement') {
16769: $trailstr = &mt('Placement Tests');
1.655 raeburn 16770: } else {
16771: $trailstr = $name;
16772: }
16773: if ($allitems->{$item} eq '') {
16774: push(@{$trails},$trailstr);
16775: $allitems->{$item} = scalar(@{$trails})-1;
16776: }
16777: my @parents = ($name);
16778: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16779: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16780: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16781: if (ref($subcats) eq 'HASH') {
16782: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16783: }
1.1321 raeburn 16784: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16785: }
16786: } else {
16787: if (ref($subcats) eq 'HASH') {
16788: $subcats->{$item} = [];
1.655 raeburn 16789: }
1.1321 raeburn 16790: if (ref($maxd) eq 'HASH') {
16791: $maxd->{$name} = 1;
16792: }
1.655 raeburn 16793: }
16794: }
16795: }
16796: }
16797: return;
16798: }
16799:
16800: =pod
16801:
1.1162 raeburn 16802: =item * &recurse_categories()
1.655 raeburn 16803:
16804: Recursively used to generate breadcrumb trails for course categories.
16805:
16806: Inputs:
1.663 raeburn 16807:
1.655 raeburn 16808: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16809: categories and subcategories).
1.663 raeburn 16810:
1.655 raeburn 16811: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16812:
16813: category (current course category, for which breadcrumb trail is being generated).
16814:
16815: trails (reference to array of breadcrumb trails for each category).
16816:
1.655 raeburn 16817: allitems (reference to hash - key is category key
16818: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16819:
1.655 raeburn 16820: parents (array containing containers directories for current category,
16821: back to top level).
16822:
16823: Returns: nothing
16824:
16825: Side effects: populates trails and allitems hash references
16826:
16827: =cut
16828:
16829: sub recurse_categories {
1.1321 raeburn 16830: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16831: my $shallower = $depth - 1;
16832: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16833: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16834: my $name = $cats->[$depth]{$category}[$k];
16835: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16836: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16837: if ($allitems->{$item} eq '') {
16838: push(@{$trails},$trailstr);
16839: $allitems->{$item} = scalar(@{$trails})-1;
16840: }
16841: my $deeper = $depth+1;
16842: push(@{$parents},$category);
1.665 raeburn 16843: if (ref($subcats) eq 'HASH') {
16844: my $subcat = &escape($name).':'.$category.':'.$depth;
16845: for (my $j=@{$parents}; $j>=0; $j--) {
16846: my $higher;
16847: if ($j > 0) {
16848: $higher = &escape($parents->[$j]).':'.
16849: &escape($parents->[$j-1]).':'.$j;
16850: } else {
16851: $higher = &escape($parents->[$j]).'::'.$j;
16852: }
16853: push(@{$subcats->{$higher}},$subcat);
16854: }
16855: }
16856: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16857: $subcats,$maxd);
1.655 raeburn 16858: pop(@{$parents});
16859: }
16860: } else {
16861: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16862: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16863: if ($allitems->{$item} eq '') {
16864: push(@{$trails},$trailstr);
16865: $allitems->{$item} = scalar(@{$trails})-1;
16866: }
1.1321 raeburn 16867: if (ref($maxd) eq 'HASH') {
16868: if ($depth > $maxd->{$parents->[0]}) {
16869: $maxd->{$parents->[0]} = $depth;
16870: }
16871: }
1.655 raeburn 16872: }
16873: return;
16874: }
16875:
1.663 raeburn 16876: =pod
16877:
1.1162 raeburn 16878: =item * &assign_categories_table()
1.663 raeburn 16879:
16880: Create a datatable for display of hierarchical categories in a domain,
16881: with checkboxes to allow a course to be categorized.
16882:
16883: Inputs:
16884:
16885: cathash - reference to hash of categories defined for the domain (from
16886: configuration.db)
16887:
16888: currcat - scalar with an & separated list of categories assigned to a course.
16889:
1.919 raeburn 16890: type - scalar contains course type (Course or Community).
16891:
1.1260 raeburn 16892: disabled - scalar (optional) contains disabled="disabled" if input elements are
16893: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16894:
1.663 raeburn 16895: Returns: $output (markup to be displayed)
16896:
16897: =cut
16898:
16899: sub assign_categories_table {
1.1259 raeburn 16900: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16901: my $output;
16902: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16903: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16904: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16905: $maxdepth = scalar(@cats);
16906: if (@cats > 0) {
16907: my $itemcount = 0;
16908: if (ref($cats[0]) eq 'ARRAY') {
16909: my @currcategories;
16910: if ($currcat ne '') {
16911: @currcategories = split('&',$currcat);
16912: }
1.919 raeburn 16913: my $table;
1.663 raeburn 16914: for (my $i=0; $i<@{$cats[0]}; $i++) {
16915: my $parent = $cats[0][$i];
1.919 raeburn 16916: next if ($parent eq 'instcode');
16917: if ($type eq 'Community') {
16918: next unless ($parent eq 'communities');
1.1239 raeburn 16919: } elsif ($type eq 'Placement') {
16920: next unless ($parent eq 'placement');
1.919 raeburn 16921: } else {
1.1239 raeburn 16922: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16923: }
1.663 raeburn 16924: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16925: my $item = &escape($parent).'::0';
16926: my $checked = '';
16927: if (@currcategories > 0) {
16928: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16929: $checked = ' checked="checked"';
1.663 raeburn 16930: }
16931: }
1.919 raeburn 16932: my $parent_title = $parent;
16933: if ($parent eq 'communities') {
16934: $parent_title = &mt('Communities');
1.1239 raeburn 16935: } elsif ($parent eq 'placement') {
16936: $parent_title = &mt('Placement Tests');
1.919 raeburn 16937: }
16938: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16939: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16940: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16941: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16942: my $depth = 1;
16943: push(@path,$parent);
1.1259 raeburn 16944: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16945: pop(@path);
1.919 raeburn 16946: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16947: $itemcount ++;
16948: }
1.919 raeburn 16949: if ($itemcount) {
16950: $output = &Apache::loncommon::start_data_table().
16951: $table.
16952: &Apache::loncommon::end_data_table();
16953: }
1.663 raeburn 16954: }
16955: }
16956: }
16957: return $output;
16958: }
16959:
16960: =pod
16961:
1.1162 raeburn 16962: =item * &assign_category_rows()
1.663 raeburn 16963:
16964: Create a datatable row for display of nested categories in a domain,
16965: with checkboxes to allow a course to be categorized,called recursively.
16966:
16967: Inputs:
16968:
16969: itemcount - track row number for alternating colors
16970:
16971: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16972: categories and subcategories.
16973:
16974: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16975:
16976: parent - parent of current category item
16977:
16978: path - Array containing all categories back up through the hierarchy from the
16979: current category to the top level.
16980:
16981: currcategories - reference to array of current categories assigned to the course
16982:
1.1260 raeburn 16983: disabled - scalar (optional) contains disabled="disabled" if input elements are
16984: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16985:
1.663 raeburn 16986: Returns: $output (markup to be displayed).
16987:
16988: =cut
16989:
16990: sub assign_category_rows {
1.1259 raeburn 16991: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16992: my ($text,$name,$item,$chgstr);
16993: if (ref($cats) eq 'ARRAY') {
16994: my $maxdepth = scalar(@{$cats});
16995: if (ref($cats->[$depth]) eq 'HASH') {
16996: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16997: my $numchildren = @{$cats->[$depth]{$parent}};
16998: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16999: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 17000: for (my $j=0; $j<$numchildren; $j++) {
17001: $name = $cats->[$depth]{$parent}[$j];
17002: $item = &escape($name).':'.&escape($parent).':'.$depth;
17003: my $deeper = $depth+1;
17004: my $checked = '';
17005: if (ref($currcategories) eq 'ARRAY') {
17006: if (@{$currcategories} > 0) {
17007: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 17008: $checked = ' checked="checked"';
1.663 raeburn 17009: }
17010: }
17011: }
1.664 raeburn 17012: $text .= '<tr><td><span class="LC_nobreak"><label>'.
17013: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 17014: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 17015: '<input type="hidden" name="catname" value="'.$name.'" />'.
17016: '</td><td>';
1.663 raeburn 17017: if (ref($path) eq 'ARRAY') {
17018: push(@{$path},$name);
1.1259 raeburn 17019: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 17020: pop(@{$path});
17021: }
17022: $text .= '</td></tr>';
17023: }
17024: $text .= '</table></td>';
17025: }
17026: }
17027: }
17028: return $text;
17029: }
17030:
1.1181 raeburn 17031: =pod
17032:
17033: =back
17034:
17035: =cut
17036:
1.655 raeburn 17037: ############################################################
17038: ############################################################
17039:
17040:
1.443 albertel 17041: sub commit_customrole {
1.1408 raeburn 17042: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 17043: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 17044: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
17045: $context,$othdomby,$requester);
1.630 raeburn 17046: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 17047: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 17048: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
17049: if (wantarray) {
17050: return ($output,$result);
17051: } else {
17052: return $output;
17053: }
1.443 albertel 17054: }
17055:
17056: sub commit_standardrole {
1.1408 raeburn 17057: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
17058: $othdomby,$requester) = @_;
1.1399 raeburn 17059: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 17060: if ($context eq 'auto') {
17061: $linefeed = "\n";
17062: } else {
17063: $linefeed = "<br />\n";
17064: }
1.443 albertel 17065: if ($three eq 'st') {
1.1399 raeburn 17066: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 17067: $one,$two,$sec,$context,$credits,$othdomby,
17068: $requester);
1.541 raeburn 17069: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 17070: ($result eq 'unknown_course') || ($result eq 'refused')) {
17071: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 17072: } else {
1.541 raeburn 17073: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 17074: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17075: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
17076: if ($context eq 'auto') {
17077: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
17078: } else {
17079: $output .= '<b>'.$result.'</b>'.$linefeed.
17080: &mt('Add to classlist').': <b>ok</b>';
17081: }
17082: $output .= $linefeed;
1.443 albertel 17083: }
17084: } else {
17085: $output = &mt('Assigning').' '.$three.' in '.$url.
17086: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17087: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17088: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17089: '','',$context,$othdomby,$requester);
1.541 raeburn 17090: if ($context eq 'auto') {
17091: $output .= $result.$linefeed;
17092: } else {
17093: $output .= '<b>'.$result.'</b>'.$linefeed;
17094: }
1.443 albertel 17095: }
1.1399 raeburn 17096: if (wantarray) {
17097: return ($output,$result);
17098: } else {
17099: return $output;
17100: }
1.443 albertel 17101: }
17102:
17103: sub commit_studentrole {
1.1116 raeburn 17104: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17105: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17106: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17107: if ($context eq 'auto') {
17108: $linefeed = "\n";
17109: } else {
17110: $linefeed = '<br />'."\n";
17111: }
1.443 albertel 17112: if (defined($one) && defined($two)) {
17113: my $cid=$one.'_'.$two;
17114: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17115: my $secchange = 0;
17116: my $expire_role_result;
17117: my $modify_section_result;
1.628 raeburn 17118: if ($oldsec ne '-1') {
17119: if ($oldsec ne $sec) {
1.443 albertel 17120: $secchange = 1;
1.628 raeburn 17121: my $now = time;
1.443 albertel 17122: my $uurl='/'.$cid;
17123: $uurl=~s/\_/\//g;
17124: if ($oldsec) {
17125: $uurl.='/'.$oldsec;
17126: }
1.626 raeburn 17127: $oldsecurl = $uurl;
1.628 raeburn 17128: $expire_role_result =
1.1408 raeburn 17129: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17130: '','','',$context,$othdomby,$requester);
17131: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17132: if ($expire_role_result eq 'refused') {
17133: my @roles = ('st');
17134: my @statuses = ('previous');
17135: my @roledoms = ($one);
17136: my $withsec = 1;
17137: my %roleshash =
17138: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17139: \@statuses,\@roles,\@roledoms,$withsec);
17140: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17141: my ($oldstart,$oldend) =
17142: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17143: if ($oldend > 0 && $oldend <= $now) {
17144: $expire_role_result = 'ok';
17145: }
17146: }
17147: }
17148: }
1.443 albertel 17149: $result = $expire_role_result;
17150: }
17151: }
17152: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17153: $modify_section_result =
17154: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17155: undef,undef,undef,$sec,
17156: $end,$start,'','',$cid,
1.1408 raeburn 17157: '',$context,$credits,'',
17158: $othdomby,$requester);
1.443 albertel 17159: if ($modify_section_result =~ /^ok/) {
17160: if ($secchange == 1) {
1.628 raeburn 17161: if ($sec eq '') {
17162: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17163: } else {
17164: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17165: }
1.443 albertel 17166: } elsif ($oldsec eq '-1') {
1.628 raeburn 17167: if ($sec eq '') {
17168: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17169: } else {
17170: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17171: }
1.443 albertel 17172: } else {
1.628 raeburn 17173: if ($sec eq '') {
17174: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17175: } else {
17176: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17177: }
1.443 albertel 17178: }
17179: } else {
1.1115 raeburn 17180: if ($secchange) {
1.628 raeburn 17181: $$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;
17182: } else {
17183: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17184: }
1.443 albertel 17185: }
17186: $result = $modify_section_result;
17187: } elsif ($secchange == 1) {
1.628 raeburn 17188: if ($oldsec eq '') {
1.1103 raeburn 17189: $$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 17190: } else {
17191: $$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;
17192: }
1.626 raeburn 17193: if ($expire_role_result eq 'refused') {
17194: my $newsecurl = '/'.$cid;
17195: $newsecurl =~ s/\_/\//g;
17196: if ($sec ne '') {
17197: $newsecurl.='/'.$sec;
17198: }
17199: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17200: if ($sec eq '') {
17201: $$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;
17202: } else {
17203: $$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;
17204: }
17205: }
17206: }
1.443 albertel 17207: }
17208: } else {
1.626 raeburn 17209: $$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 17210: $result = "error: incomplete course id\n";
17211: }
17212: return $result;
17213: }
17214:
1.1108 raeburn 17215: sub show_role_extent {
17216: my ($scope,$context,$role) = @_;
17217: $scope =~ s{^/}{};
17218: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17219: push(@courseroles,'co');
17220: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17221: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17222: $scope =~ s{/}{_};
17223: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17224: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17225: my ($audom,$auname) = split(/\//,$scope);
17226: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17227: &Apache::loncommon::plainname($auname,$audom).'</span>');
17228: } else {
17229: $scope =~ s{/$}{};
17230: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17231: &Apache::lonnet::domain($scope,'description').'</span>');
17232: }
17233: }
17234:
1.443 albertel 17235: ############################################################
17236: ############################################################
17237:
1.566 albertel 17238: sub check_clone {
1.578 raeburn 17239: my ($args,$linefeed) = @_;
1.566 albertel 17240: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17241: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17242: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17243: my $clonetitle;
17244: my @clonemsg;
1.566 albertel 17245: my $can_clone = 0;
1.944 raeburn 17246: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17247: if ($lctype ne 'community') {
17248: $lctype = 'course';
17249: }
1.566 albertel 17250: if ($clonehome eq 'no_host') {
1.944 raeburn 17251: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17252: push(@clonemsg,({
17253: mt => 'No new community created.',
17254: args => [],
17255: },
17256: {
17257: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17258: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17259: }));
1.908 raeburn 17260: } else {
1.1344 raeburn 17261: push(@clonemsg,({
17262: mt => 'No new course created.',
17263: args => [],
17264: },
17265: {
17266: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17267: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17268: }));
17269: }
1.566 albertel 17270: } else {
17271: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17272: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17273: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17274: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17275: push(@clonemsg,({
17276: mt => 'No new community created.',
17277: args => [],
17278: },
17279: {
17280: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17281: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17282: }));
17283: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17284: }
17285: }
1.1262 raeburn 17286: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17287: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17288: $can_clone = 1;
17289: } else {
1.1221 raeburn 17290: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17291: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17292: if ($clonehash{'cloners'} eq '') {
17293: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17294: if ($domdefs{'canclone'}) {
17295: unless ($domdefs{'canclone'} eq 'none') {
17296: if ($domdefs{'canclone'} eq 'domain') {
17297: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17298: $can_clone = 1;
17299: }
17300: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17301: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17302: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17303: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17304: $can_clone = 1;
17305: }
17306: }
17307: }
17308: }
1.578 raeburn 17309: } else {
1.1221 raeburn 17310: my @cloners = split(/,/,$clonehash{'cloners'});
17311: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17312: $can_clone = 1;
1.1221 raeburn 17313: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17314: $can_clone = 1;
1.1225 raeburn 17315: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17316: $can_clone = 1;
1.1221 raeburn 17317: }
17318: unless ($can_clone) {
1.1225 raeburn 17319: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17320: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17321: my (%gotdomdefaults,%gotcodedefaults);
17322: foreach my $cloner (@cloners) {
17323: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17324: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17325: my (%codedefaults,@code_order);
17326: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17327: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17328: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17329: }
17330: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17331: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17332: }
17333: } else {
17334: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17335: \%codedefaults,
17336: \@code_order);
17337: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17338: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17339: }
17340: if (@code_order > 0) {
17341: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17342: $cloner,$clonehash{'internal.coursecode'},
17343: $args->{'crscode'})) {
17344: $can_clone = 1;
17345: last;
17346: }
17347: }
17348: }
17349: }
17350: }
1.1225 raeburn 17351: }
17352: }
17353: unless ($can_clone) {
17354: my $ccrole = 'cc';
17355: if ($args->{'crstype'} eq 'Community') {
17356: $ccrole = 'co';
17357: }
17358: my %roleshash =
17359: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17360: $args->{'ccdomain'},
17361: 'userroles',['active'],[$ccrole],
17362: [$args->{'clonedomain'}]);
17363: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17364: $can_clone = 1;
17365: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17366: $args->{'ccuname'},$args->{'ccdomain'})) {
17367: $can_clone = 1;
1.1221 raeburn 17368: }
17369: }
17370: unless ($can_clone) {
17371: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17372: push(@clonemsg,({
17373: mt => 'No new community created.',
17374: args => [],
17375: },
17376: {
17377: 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]).',
17378: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17379: }));
1.942 raeburn 17380: } else {
1.1344 raeburn 17381: push(@clonemsg,({
17382: mt => 'No new course created.',
17383: args => [],
17384: },
17385: {
17386: 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]).',
17387: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17388: }));
1.1221 raeburn 17389: }
1.566 albertel 17390: }
1.578 raeburn 17391: }
1.566 albertel 17392: }
1.1344 raeburn 17393: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17394: }
17395:
1.444 albertel 17396: sub construct_course {
1.1262 raeburn 17397: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17398: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17399: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17400: my $linefeed = '<br />'."\n";
17401: if ($context eq 'auto') {
17402: $linefeed = "\n";
17403: }
1.566 albertel 17404:
17405: #
17406: # Are we cloning?
17407: #
1.1344 raeburn 17408: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17409: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17410: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17411: if (!$can_clone) {
1.1344 raeburn 17412: return (0,$outcome,$clonemsgref);
1.566 albertel 17413: }
17414: }
17415:
1.444 albertel 17416: #
17417: # Open course
17418: #
1.1239 raeburn 17419: my $showncrstype;
17420: if ($args->{'crstype'} eq 'Placement') {
17421: $showncrstype = 'placement test';
17422: } else {
17423: $showncrstype = lc($args->{'crstype'});
17424: }
1.444 albertel 17425: my %cenv=();
17426: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17427: $args->{'cdescr'},
17428: $args->{'curl'},
17429: $args->{'course_home'},
17430: $args->{'nonstandard'},
17431: $args->{'crscode'},
17432: $args->{'ccuname'}.':'.
17433: $args->{'ccdomain'},
1.882 raeburn 17434: $args->{'crstype'},
1.1344 raeburn 17435: $cnum,$context,$category,
17436: $callercontext);
1.444 albertel 17437:
17438: # Note: The testing routines depend on this being output; see
17439: # Utils::Course. This needs to at least be output as a comment
17440: # if anyone ever decides to not show this, and Utils::Course::new
17441: # will need to be suitably modified.
1.1344 raeburn 17442: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17443: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17444: } else {
17445: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17446: }
1.943 raeburn 17447: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17448: return (0,$outcome,$clonemsgref);
1.943 raeburn 17449: }
17450:
1.444 albertel 17451: #
17452: # Check if created correctly
17453: #
1.479 albertel 17454: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17455: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17456: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17457: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17458: $outcome .= &mt_user($user_lh,
17459: 'Course creation failed, unrecognized course home server.');
17460: } else {
17461: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17462: }
17463: $outcome .= $linefeed;
17464: return (0,$outcome,$clonemsgref);
1.943 raeburn 17465: }
1.541 raeburn 17466: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17467:
1.444 albertel 17468: #
1.566 albertel 17469: # Do the cloning
17470: #
1.1344 raeburn 17471: my @clonemsg;
1.566 albertel 17472: if ($can_clone && $cloneid) {
1.1344 raeburn 17473: push(@clonemsg,
17474: {
17475: mt => 'Created [_1] by cloning from [_2]',
17476: args => [$showncrstype,$clonetitle],
17477: });
1.566 albertel 17478: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17479: # Copy all files
1.1344 raeburn 17480: my @info =
17481: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17482: $args->{'dateshift'},$args->{'crscode'},
17483: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17484: $args->{'tinyurls'});
17485: if (@info) {
17486: push(@clonemsg,@info);
17487: }
1.444 albertel 17488: # Restore URL
1.566 albertel 17489: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17490: # Restore title
1.566 albertel 17491: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17492: # Restore creation date, creator and creation context.
17493: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17494: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17495: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17496: # Mark as cloned
1.566 albertel 17497: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17498: # Need to clone grading mode
17499: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17500: $cenv{'grading'}=$newenv{'grading'};
17501: # Do not clone these environment entries
17502: &Apache::lonnet::del('environment',
17503: ['default_enrollment_start_date',
17504: 'default_enrollment_end_date',
17505: 'question.email',
17506: 'policy.email',
17507: 'comment.email',
17508: 'pch.users.denied',
1.725 raeburn 17509: 'plc.users.denied',
17510: 'hidefromcat',
1.1121 raeburn 17511: 'checkforpriv',
1.1355 raeburn 17512: 'categories'],
1.638 www 17513: $$crsudom,$$crsunum);
1.1170 raeburn 17514: if ($args->{'textbook'}) {
17515: $cenv{'internal.textbook'} = $args->{'textbook'};
17516: }
1.444 albertel 17517: }
1.566 albertel 17518:
1.444 albertel 17519: #
17520: # Set environment (will override cloned, if existing)
17521: #
17522: my @sections = ();
17523: my @xlists = ();
17524: if ($args->{'crstype'}) {
17525: $cenv{'type'}=$args->{'crstype'};
17526: }
1.1371 raeburn 17527: if ($args->{'lti'}) {
17528: $cenv{'internal.lti'}=$args->{'lti'};
17529: }
1.444 albertel 17530: if ($args->{'crsid'}) {
17531: $cenv{'courseid'}=$args->{'crsid'};
17532: }
17533: if ($args->{'crscode'}) {
17534: $cenv{'internal.coursecode'}=$args->{'crscode'};
17535: }
17536: if ($args->{'crsquota'} ne '') {
17537: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17538: } else {
17539: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17540: }
17541: if ($args->{'ccuname'}) {
17542: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17543: ':'.$args->{'ccdomain'};
17544: } else {
17545: $cenv{'internal.courseowner'} = $args->{'curruser'};
17546: }
1.1116 raeburn 17547: if ($args->{'defaultcredits'}) {
17548: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17549: }
1.444 albertel 17550: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17551: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17552: if ($args->{'crssections'}) {
17553: $cenv{'internal.sectionnums'} = '';
17554: if ($args->{'crssections'} =~ m/,/) {
17555: @sections = split/,/,$args->{'crssections'};
17556: } else {
17557: $sections[0] = $args->{'crssections'};
17558: }
17559: if (@sections > 0) {
17560: foreach my $item (@sections) {
17561: my ($sec,$gp) = split/:/,$item;
17562: my $class = $args->{'crscode'}.$sec;
17563: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17564: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17565: if ($addcheck eq 'ok') {
17566: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17567: push(@oklcsecs,$gp);
17568: }
17569: } else {
1.1263 raeburn 17570: push(@badclasses,$class);
1.444 albertel 17571: }
17572: }
17573: $cenv{'internal.sectionnums'} =~ s/,$//;
17574: }
17575: }
17576: # do not hide course coordinator from staff listing,
17577: # even if privileged
17578: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17579: # add course coordinator's domain to domains to check for privileged users
17580: # if different to course domain
17581: if ($$crsudom ne $args->{'ccdomain'}) {
17582: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17583: }
1.444 albertel 17584: # add crosslistings
17585: if ($args->{'crsxlist'}) {
17586: $cenv{'internal.crosslistings'}='';
17587: if ($args->{'crsxlist'} =~ m/,/) {
17588: @xlists = split/,/,$args->{'crsxlist'};
17589: } else {
17590: $xlists[0] = $args->{'crsxlist'};
17591: }
17592: if (@xlists > 0) {
17593: foreach my $item (@xlists) {
17594: my ($xl,$gp) = split/:/,$item;
17595: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17596: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17597: if ($addcheck eq 'ok') {
17598: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17599: push(@oklcsecs,$gp);
17600: }
17601: } else {
1.1263 raeburn 17602: push(@badclasses,$xl);
1.444 albertel 17603: }
17604: }
17605: $cenv{'internal.crosslistings'} =~ s/,$//;
17606: }
17607: }
17608: if ($args->{'autoadds'}) {
17609: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17610: }
17611: if ($args->{'autodrops'}) {
17612: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17613: }
17614: # check for notification of enrollment changes
17615: my @notified = ();
17616: if ($args->{'notify_owner'}) {
17617: if ($args->{'ccuname'} ne '') {
17618: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17619: }
17620: }
17621: if ($args->{'notify_dc'}) {
17622: if ($uname ne '') {
1.630 raeburn 17623: push(@notified,$uname.':'.$udom);
1.444 albertel 17624: }
17625: }
17626: if (@notified > 0) {
17627: my $notifylist;
17628: if (@notified > 1) {
17629: $notifylist = join(',',@notified);
17630: } else {
17631: $notifylist = $notified[0];
17632: }
17633: $cenv{'internal.notifylist'} = $notifylist;
17634: }
17635: if (@badclasses > 0) {
17636: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17637: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17638: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17639: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17640: );
1.1264 raeburn 17641: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17642: &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 17643: if ($context eq 'auto') {
17644: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17645: } else {
1.566 albertel 17646: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17647: }
17648: foreach my $item (@badclasses) {
1.541 raeburn 17649: if ($context eq 'auto') {
1.1261 raeburn 17650: $outcome .= " - $item\n";
1.541 raeburn 17651: } else {
1.1261 raeburn 17652: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17653: }
1.1261 raeburn 17654: }
17655: if ($context eq 'auto') {
17656: $outcome .= $linefeed;
17657: } else {
17658: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17659: }
1.444 albertel 17660: }
17661: if ($args->{'no_end_date'}) {
17662: $args->{'endaccess'} = 0;
17663: }
1.1412 raeburn 17664: # If an official course with institutional sections is created by cloning
17665: # an existing course, section-specific hiding of course totals in student's
17666: # view of grades as copied from cloned course, will be checked for valid
17667: # sections.
17668: if (($can_clone && $cloneid) &&
17669: ($cenv{'internal.coursecode'} ne '') &&
17670: ($cenv{'grading'} eq 'standard') &&
17671: ($cenv{'hidetotals'} ne '') &&
17672: ($cenv{'hidetotals'} ne 'all')) {
17673: my @hidesecs;
17674: my $deletehidetotals;
17675: if (@oklcsecs) {
17676: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17677: if (grep(/^\Q$sec$/,@oklcsecs)) {
17678: push(@hidesecs,$sec);
17679: }
17680: }
17681: if (@hidesecs) {
17682: $cenv{'hidetotals'} = join(',',@hidesecs);
17683: } else {
17684: $deletehidetotals = 1;
17685: }
17686: } else {
17687: $deletehidetotals = 1;
17688: }
17689: if ($deletehidetotals) {
17690: delete($cenv{'hidetotals'});
17691: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17692: }
17693: }
1.444 albertel 17694: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17695: $cenv{'internal.autoend'}=$args->{'enrollend'};
17696: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17697: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17698: if ($args->{'showphotos'}) {
17699: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17700: }
17701: $cenv{'internal.authtype'} = $args->{'authtype'};
17702: $cenv{'internal.autharg'} = $args->{'autharg'};
17703: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17704: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17705: 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');
17706: if ($context eq 'auto') {
17707: $outcome .= $krb_msg;
17708: } else {
1.566 albertel 17709: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17710: }
17711: $outcome .= $linefeed;
1.444 albertel 17712: }
17713: }
17714: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17715: if ($args->{'setpolicy'}) {
17716: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17717: }
17718: if ($args->{'setcontent'}) {
17719: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17720: }
1.1251 raeburn 17721: if ($args->{'setcomment'}) {
17722: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17723: }
1.444 albertel 17724: }
17725: if ($args->{'reshome'}) {
17726: $cenv{'reshome'}=$args->{'reshome'}.'/';
17727: $cenv{'reshome'}=~s/\/+$/\//;
17728: }
17729: #
17730: # course has keyed access
17731: #
17732: if ($args->{'setkeys'}) {
17733: $cenv{'keyaccess'}='yes';
17734: }
17735: # if specified, key authority is not course, but user
17736: # only active if keyaccess is yes
17737: if ($args->{'keyauth'}) {
1.487 albertel 17738: my ($user,$domain) = split(':',$args->{'keyauth'});
17739: $user = &LONCAPA::clean_username($user);
17740: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17741: if ($user ne '' && $domain ne '') {
1.487 albertel 17742: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17743: }
17744: }
17745:
1.1166 raeburn 17746: #
1.1167 raeburn 17747: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17748: #
17749: if ($args->{'uniquecode'}) {
17750: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17751: if ($code) {
17752: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17753: my %crsinfo =
17754: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17755: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17756: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17757: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17758: }
1.1166 raeburn 17759: if (ref($coderef)) {
17760: $$coderef = $code;
17761: }
17762: }
17763: }
17764:
1.444 albertel 17765: if ($args->{'disresdis'}) {
17766: $cenv{'pch.roles.denied'}='st';
17767: }
17768: if ($args->{'disablechat'}) {
17769: $cenv{'plc.roles.denied'}='st';
17770: }
17771:
17772: # Record we've not yet viewed the Course Initialization Helper for this
17773: # course
17774: $cenv{'course.helper.not.run'} = 1;
17775: #
17776: # Use new Randomseed
17777: #
17778: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17779: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17780: #
17781: # The encryption code and receipt prefix for this course
17782: #
17783: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17784: $cenv{'internal.encpref'}=100+int(9*rand(99));
17785: #
17786: # By default, use standard grading
17787: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17788:
1.541 raeburn 17789: $outcome .= $linefeed.&mt('Setting environment').': '.
17790: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17791: #
17792: # Open all assignments
17793: #
17794: if ($args->{'openall'}) {
1.1341 raeburn 17795: my $opendate = time;
17796: if ($args->{'openallfrom'} =~ /^\d+$/) {
17797: $opendate = $args->{'openallfrom'};
17798: }
1.444 albertel 17799: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17800: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17801: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17802: $outcome .= &mt('All assignments open starting [_1]',
17803: &Apache::lonlocal::locallocaltime($opendate)).': '.
17804: &Apache::lonnet::cput
17805: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17806: }
17807: #
17808: # Set first page
17809: #
17810: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17811: || ($cloneid)) {
17812: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17813:
17814: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17815: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17816:
1.444 albertel 17817: $outcome .= ($fatal?$errtext:'read ok').' - ';
17818: my $title; my $url;
17819: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17820: $title=&mt('Syllabus');
1.444 albertel 17821: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17822: } else {
1.963 raeburn 17823: $title=&mt('Table of Contents');
1.444 albertel 17824: $url='/adm/navmaps';
17825: }
1.445 albertel 17826:
17827: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17828: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17829:
17830: if ($errtext) { $fatal=2; }
1.541 raeburn 17831: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17832: }
1.566 albertel 17833:
1.1237 raeburn 17834: #
17835: # Set params for Placement Tests
17836: #
1.1239 raeburn 17837: if ($args->{'crstype'} eq 'Placement') {
17838: my %storecontent;
17839: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17840: my %defaults = (
17841: buttonshide => { value => 'yes',
17842: type => 'string_yesno',},
17843: type => { value => 'randomizetry',
17844: type => 'string_questiontype',},
17845: maxtries => { value => 1,
17846: type => 'int_pos',},
17847: problemstatus => { value => 'no',
17848: type => 'string_problemstatus',},
17849: );
17850: foreach my $key (keys(%defaults)) {
17851: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17852: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17853: }
1.1237 raeburn 17854: &Apache::lonnet::cput
17855: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17856: }
17857:
1.1344 raeburn 17858: return (1,$outcome,\@clonemsg);
1.444 albertel 17859: }
17860:
1.1166 raeburn 17861: sub make_unique_code {
17862: my ($cdom,$cnum) = @_;
17863: # get lock on uniquecodes db
17864: my $lockhash = {
17865: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17866: ':'.$env{'user.domain'},
17867: };
17868: my $tries = 0;
17869: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17870: my ($code,$error);
17871:
17872: while (($gotlock ne 'ok') && ($tries<3)) {
17873: $tries ++;
17874: sleep 1;
17875: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17876: }
17877: if ($gotlock eq 'ok') {
17878: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17879: my $gotcode;
17880: my $attempts = 0;
17881: while ((!$gotcode) && ($attempts < 100)) {
17882: $code = &generate_code();
17883: if (!exists($currcodes{$code})) {
17884: $gotcode = 1;
17885: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17886: $error = 'nostore';
17887: }
17888: }
17889: $attempts ++;
17890: }
17891: my @del_lock = ($cnum."\0".'uniquecodes');
17892: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17893: } else {
17894: $error = 'nolock';
17895: }
17896: return ($code,$error);
17897: }
17898:
17899: sub generate_code {
17900: my $code;
17901: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17902: for (my $i=0; $i<6; $i++) {
17903: my $lettnum = int (rand 2);
17904: my $item = '';
17905: if ($lettnum) {
17906: $item = $letts[int( rand(18) )];
17907: } else {
17908: $item = 1+int( rand(8) );
17909: }
17910: $code .= $item;
17911: }
17912: return $code;
17913: }
17914:
1.444 albertel 17915: ############################################################
17916: ############################################################
17917:
1.1237 raeburn 17918: # Community, Course and Placement Test
1.378 raeburn 17919: sub course_type {
17920: my ($cid) = @_;
17921: if (!defined($cid)) {
17922: $cid = $env{'request.course.id'};
17923: }
1.404 albertel 17924: if (defined($env{'course.'.$cid.'.type'})) {
17925: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17926: } else {
17927: return 'Course';
1.377 raeburn 17928: }
17929: }
1.156 albertel 17930:
1.406 raeburn 17931: sub group_term {
17932: my $crstype = &course_type();
17933: my %names = (
17934: 'Course' => 'group',
1.865 raeburn 17935: 'Community' => 'group',
1.1237 raeburn 17936: 'Placement' => 'group',
1.406 raeburn 17937: );
17938: return $names{$crstype};
17939: }
17940:
1.902 raeburn 17941: sub course_types {
1.1310 raeburn 17942: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17943: my %typename = (
17944: official => 'Official course',
17945: unofficial => 'Unofficial course',
17946: community => 'Community',
1.1165 raeburn 17947: textbook => 'Textbook course',
1.1237 raeburn 17948: placement => 'Placement test',
1.1310 raeburn 17949: lti => 'LTI provider',
1.902 raeburn 17950: );
17951: return (\@types,\%typename);
17952: }
17953:
1.156 albertel 17954: sub icon {
17955: my ($file)=@_;
1.505 albertel 17956: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17957: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17958: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17959: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17960: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17961: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17962: $curfext.".gif") {
17963: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17964: $curfext.".gif";
17965: }
17966: }
1.249 albertel 17967: return &lonhttpdurl($iconname);
1.154 albertel 17968: }
1.84 albertel 17969:
1.575 albertel 17970: sub lonhttpdurl {
1.692 www 17971: #
17972: # Had been used for "small fry" static images on separate port 8080.
17973: # Modify here if lightweight http functionality desired again.
17974: # Currently eliminated due to increasing firewall issues.
17975: #
1.575 albertel 17976: my ($url)=@_;
1.692 www 17977: return $url;
1.215 albertel 17978: }
17979:
1.213 albertel 17980: sub connection_aborted {
17981: my ($r)=@_;
17982: $r->print(" ");$r->rflush();
17983: my $c = $r->connection;
17984: return $c->aborted();
17985: }
17986:
1.221 foxr 17987: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17988: # strings as 'strings'.
17989: sub escape_single {
1.221 foxr 17990: my ($input) = @_;
1.223 albertel 17991: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17992: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17993: return $input;
17994: }
1.223 albertel 17995:
1.222 foxr 17996: # Same as escape_single, but escape's "'s This
17997: # can be used for "strings"
17998: sub escape_double {
17999: my ($input) = @_;
18000: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
18001: $input =~ s/\"/\\\"/g; # Esacpe the "s....
18002: return $input;
18003: }
1.223 albertel 18004:
1.222 foxr 18005: # Escapes the last element of a full URL.
18006: sub escape_url {
18007: my ($url) = @_;
1.238 raeburn 18008: my @urlslices = split(/\//, $url,-1);
1.369 www 18009: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 18010: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 18011: }
1.462 albertel 18012:
1.820 raeburn 18013: sub compare_arrays {
18014: my ($arrayref1,$arrayref2) = @_;
18015: my (@difference,%count);
18016: @difference = ();
18017: %count = ();
18018: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
18019: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
18020: foreach my $element (keys(%count)) {
18021: if ($count{$element} == 1) {
18022: push(@difference,$element);
18023: }
18024: }
18025: }
18026: return @difference;
18027: }
18028:
1.1322 raeburn 18029: sub lon_status_items {
18030: my %defaults = (
18031: E => 100,
18032: W => 4,
18033: N => 1,
1.1324 raeburn 18034: U => 5,
1.1322 raeburn 18035: threshold => 200,
18036: sysmail => 2500,
18037: );
18038: my %names = (
18039: E => 'Errors',
18040: W => 'Warnings',
18041: N => 'Notices',
1.1324 raeburn 18042: U => 'Unsent',
1.1322 raeburn 18043: );
18044: return (\%defaults,\%names);
18045: }
18046:
1.817 bisitz 18047: # -------------------------------------------------------- Initialize user login
1.462 albertel 18048: sub init_user_environment {
1.463 albertel 18049: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 18050: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
18051:
18052: my $public=($username eq 'public' && $domain eq 'public');
18053:
1.1415 raeburn 18054: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
18055: $coauthorenv);
1.462 albertel 18056: my $now=time;
18057:
18058: if ($public) {
18059: my $max_public=100;
18060: my $oldest;
18061: my $oldest_time=0;
18062: for(my $next=1;$next<=$max_public;$next++) {
18063: if (-e $lonids."/publicuser_$next.id") {
18064: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
18065: if ($mtime<$oldest_time || !$oldest_time) {
18066: $oldest_time=$mtime;
18067: $oldest=$next;
18068: }
18069: } else {
18070: $cookie="publicuser_$next";
18071: last;
18072: }
18073: }
18074: if (!$cookie) { $cookie="publicuser_$oldest"; }
18075: } else {
1.1275 raeburn 18076: # See if old ID present, if so, remove if this isn't a robot,
18077: # killing any existing non-robot sessions
1.463 albertel 18078: if (!$args->{'robot'}) {
18079: opendir(DIR,$lonids);
18080: while ($filename=readdir(DIR)) {
18081: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 18082: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
18083: &GDBM_READER(),0640)) {
1.1295 raeburn 18084: my $linkedfile;
1.1320 raeburn 18085: if (exists($oldenv{'user.linkedenv'})) {
18086: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18087: }
1.1320 raeburn 18088: untie(%oldenv);
18089: if (unlink("$lonids/$filename")) {
18090: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18091: if (-l "$lonids/$linkedfile.id") {
18092: unlink("$lonids/$linkedfile.id");
18093: }
1.1295 raeburn 18094: }
18095: }
18096: } else {
18097: unlink($lonids.'/'.$filename);
18098: }
1.463 albertel 18099: }
1.462 albertel 18100: }
1.463 albertel 18101: closedir(DIR);
1.1204 raeburn 18102: # If there is a undeleted lockfile for the user's paste buffer remove it.
18103: my $namespace = 'nohist_courseeditor';
18104: my $lockingkey = 'paste'."\0".'locked_num';
18105: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18106: $domain,$username);
18107: if (exists($lockhash{$lockingkey})) {
18108: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18109: unless ($delresult eq 'ok') {
18110: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18111: }
18112: }
1.462 albertel 18113: }
18114: # Give them a new cookie
1.463 albertel 18115: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18116: : $now.$$.int(rand(10000)));
1.463 albertel 18117: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18118:
18119: # Initialize roles
18120:
1.1414 raeburn 18121: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18122: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18123: }
18124: # ------------------------------------ Check browser type and MathML capability
18125:
1.1194 raeburn 18126: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18127: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18128:
18129: # ------------------------------------------------------------- Get environment
18130:
18131: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18132: my ($tmp) = keys(%userenv);
1.1275 raeburn 18133: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18134: undef(%userenv);
18135: }
18136: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18137: $form->{'interface'}=$userenv{'interface'};
18138: }
18139: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18140:
18141: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18142: foreach my $option ('interface','localpath','localres') {
18143: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18144: }
18145: # --------------------------------------------------------- Write first profile
18146:
18147: {
1.1350 raeburn 18148: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18149: my %initial_env =
18150: ("user.name" => $username,
18151: "user.domain" => $domain,
18152: "user.home" => $authhost,
18153: "browser.type" => $clientbrowser,
18154: "browser.version" => $clientversion,
18155: "browser.mathml" => $clientmathml,
18156: "browser.unicode" => $clientunicode,
18157: "browser.os" => $clientos,
1.1137 raeburn 18158: "browser.mobile" => $clientmobile,
1.1141 raeburn 18159: "browser.info" => $clientinfo,
1.1194 raeburn 18160: "browser.osversion" => $clientosversion,
1.462 albertel 18161: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18162: "request.course.fn" => '',
18163: "request.course.uri" => '',
18164: "request.course.sec" => '',
18165: "request.role" => 'cm',
18166: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18167: "request.host" => $ip,);
1.462 albertel 18168:
18169: if ($form->{'localpath'}) {
18170: $initial_env{"browser.localpath"} = $form->{'localpath'};
18171: $initial_env{"browser.localres"} = $form->{'localres'};
18172: }
18173:
18174: if ($form->{'interface'}) {
18175: $form->{'interface'}=~s/\W//gs;
18176: $initial_env{"browser.interface"} = $form->{'interface'};
18177: $env{'browser.interface'}=$form->{'interface'};
18178: }
18179:
1.1157 raeburn 18180: if ($form->{'iptoken'}) {
18181: my $lonhost = $r->dir_config('lonHostID');
18182: $initial_env{"user.noloadbalance"} = $lonhost;
18183: $env{'user.noloadbalance'} = $lonhost;
18184: }
18185:
1.1268 raeburn 18186: if ($form->{'noloadbalance'}) {
18187: my @hosts = &Apache::lonnet::current_machine_ids();
18188: my $hosthere = $form->{'noloadbalance'};
18189: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18190: $initial_env{"user.noloadbalance"} = $hosthere;
18191: $env{'user.noloadbalance'} = $hosthere;
18192: }
18193: }
18194:
1.1016 raeburn 18195: unless ($domain eq 'public') {
1.1273 raeburn 18196: my %is_adv = ( is_adv => $env{'user.adv'} );
18197: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18198:
1.1414 raeburn 18199: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18200: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18201: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18202: undef,\%userenv,\%domdef,\%is_adv);
18203: }
1.980 raeburn 18204:
1.1311 raeburn 18205: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18206: $userenv{'canrequest.'.$crstype} =
18207: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18208: 'reload','requestcourses',
18209: \%userenv,\%domdef,\%is_adv);
18210: }
1.724 raeburn 18211:
1.1418 raeburn 18212: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18213: (exists($userroles->{"user.role.au./$domain/"}))) {
18214: if ($userenv{'authoreditors'}) {
18215: $userenv{'editors'} = $userenv{'authoreditors'};
18216: } elsif ($domdef{'editors'} ne '') {
18217: $userenv{'editors'} = $domdef{'editors'};
18218: } else {
18219: $userenv{'editors'} = 'edit,xml';
18220: }
1.1431 raeburn 18221: if ($userenv{'authorarchive'}) {
18222: $userenv{'canarchive'} = 1;
18223: } elsif (($userenv{'authorarchive'} eq '') &&
18224: ($domdef{'archive'})) {
18225: $userenv{'canarchive'} = 1;
18226: }
1.1418 raeburn 18227: }
18228:
1.1273 raeburn 18229: $userenv{'canrequest.author'} =
18230: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18231: 'reload','requestauthor',
1.980 raeburn 18232: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18233: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18234: $domain,$username);
18235: my $reqstatus = $reqauthor{'author_status'};
18236: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18237: if (ref($reqauthor{'author'}) eq 'HASH') {
18238: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18239: $reqauthor{'author'}{'timestamp'};
18240: }
1.1092 raeburn 18241: }
1.1287 raeburn 18242: my ($types,$typename) = &course_types();
18243: if (ref($types) eq 'ARRAY') {
18244: my @options = ('approval','validate','autolimit');
18245: my $optregex = join('|',@options);
18246: my (%willtrust,%trustchecked);
18247: foreach my $type (@{$types}) {
18248: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18249: if ($dom_str ne '') {
18250: my $updatedstr = '';
18251: my @possdomains = split(',',$dom_str);
18252: foreach my $entry (@possdomains) {
18253: my ($extdom,$extopt) = split(':',$entry);
18254: unless ($trustchecked{$extdom}) {
18255: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18256: $trustchecked{$extdom} = 1;
18257: }
18258: if ($willtrust{$extdom}) {
18259: $updatedstr .= $entry.',';
18260: }
18261: }
18262: $updatedstr =~ s/,$//;
18263: if ($updatedstr) {
18264: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18265: } else {
18266: delete($userenv{'reqcrsotherdom.'.$type});
18267: }
18268: }
18269: }
18270: }
1.1092 raeburn 18271: }
1.462 albertel 18272: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18273:
1.462 albertel 18274: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18275: &GDBM_WRCREAT(),0640)) {
18276: &_add_to_env(\%disk_env,\%initial_env);
18277: &_add_to_env(\%disk_env,\%userenv,'environment.');
18278: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18279: if (ref($firstaccenv) eq 'HASH') {
18280: &_add_to_env(\%disk_env,$firstaccenv);
18281: }
18282: if (ref($timerintenv) eq 'HASH') {
18283: &_add_to_env(\%disk_env,$timerintenv);
18284: }
1.1414 raeburn 18285: if (ref($coauthorenv) eq 'HASH') {
18286: if (keys(%{$coauthorenv})) {
18287: &_add_to_env(\%disk_env,$coauthorenv);
18288: }
18289: }
1.463 albertel 18290: if (ref($args->{'extra_env'})) {
18291: &_add_to_env(\%disk_env,$args->{'extra_env'});
18292: }
1.462 albertel 18293: untie(%disk_env);
18294: } else {
1.705 tempelho 18295: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18296: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18297: return 'error: '.$!;
18298: }
18299: }
18300: $env{'request.role'}='cm';
18301: $env{'request.role.adv'}=$env{'user.adv'};
18302: $env{'browser.type'}=$clientbrowser;
18303:
18304: return $cookie;
18305:
18306: }
18307:
18308: sub _add_to_env {
18309: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18310: if (ref($env_data) eq 'HASH') {
18311: while (my ($key,$value) = each(%$env_data)) {
18312: $idf->{$prefix.$key} = $value;
18313: $env{$prefix.$key} = $value;
18314: }
1.462 albertel 18315: }
18316: }
18317:
1.685 tempelho 18318: # --- Get the symbolic name of a problem and the url
18319: sub get_symb {
18320: my ($request,$silent) = @_;
1.726 raeburn 18321: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18322: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18323: if ($symb eq '') {
18324: if (!$silent) {
1.1071 raeburn 18325: if (ref($request)) {
18326: $request->print("Unable to handle ambiguous references:$url:.");
18327: }
1.685 tempelho 18328: return ();
18329: }
18330: }
18331: &Apache::lonenc::check_decrypt(\$symb);
18332: return ($symb);
18333: }
18334:
18335: # --------------------------------------------------------------Get annotation
18336:
18337: sub get_annotation {
18338: my ($symb,$enc) = @_;
18339:
18340: my $key = $symb;
18341: if (!$enc) {
18342: $key =
18343: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18344: }
18345: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18346: return $annotation{$key};
18347: }
18348:
18349: sub clean_symb {
1.731 raeburn 18350: my ($symb,$delete_enc) = @_;
1.685 tempelho 18351:
18352: &Apache::lonenc::check_decrypt(\$symb);
18353: my $enc = $env{'request.enc'};
1.731 raeburn 18354: if ($delete_enc) {
1.730 raeburn 18355: delete($env{'request.enc'});
18356: }
1.685 tempelho 18357:
18358: return ($symb,$enc);
18359: }
1.462 albertel 18360:
1.1181 raeburn 18361: ############################################################
18362: ############################################################
18363:
18364: =pod
18365:
18366: =head1 Routines for building display used to search for courses
18367:
18368:
18369: =over 4
18370:
18371: =item * &build_filters()
18372:
18373: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18374: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18375: and quotacheck.pl
18376:
1.1181 raeburn 18377:
18378: Inputs:
18379:
18380: filterlist - anonymous array of fields to include as potential filters
18381:
18382: crstype - course type
18383:
18384: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18385: to pop-open a course selector (will contain "extra element").
18386:
18387: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18388:
18389: filter - anonymous hash of criteria and their values
18390:
18391: action - form action
18392:
18393: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18394:
1.1182 raeburn 18395: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18396:
18397: cloneruname - username of owner of new course who wants to clone
18398:
18399: clonerudom - domain of owner of new course who wants to clone
18400:
18401: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18402:
18403: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18404:
18405: codedom - domain
18406:
18407: formname - value of form element named "form".
18408:
18409: fixeddom - domain, if fixed.
18410:
18411: prevphase - value to assign to form element named "phase" when going back to the previous screen
18412:
18413: cnameelement - name of form element in form on opener page which will receive title of selected course
18414:
18415: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18416:
18417: cdomelement - name of form element in form on opener page which will receive domain of selected course
18418:
18419: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18420:
18421: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18422:
18423: clonewarning - warning message about missing information for intended course owner when DC creates a course
18424:
1.1182 raeburn 18425:
1.1181 raeburn 18426: Returns: $output - HTML for display of search criteria, and hidden form elements.
18427:
1.1182 raeburn 18428:
1.1181 raeburn 18429: Side Effects: None
18430:
18431: =cut
18432:
18433: # ---------------------------------------------- search for courses based on last activity etc.
18434:
18435: sub build_filters {
18436: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18437: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18438: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18439: $cnameelement,$cnumelement,$cdomelement,$setroles,
18440: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18441: my ($list,$jscript);
1.1181 raeburn 18442: my $onchange = 'javascript:updateFilters(this)';
18443: my ($domainselectform,$sincefilterform,$createdfilterform,
18444: $ownerdomselectform,$persondomselectform,$instcodeform,
18445: $typeselectform,$instcodetitle);
18446: if ($formname eq '') {
18447: $formname = $caller;
18448: }
18449: foreach my $item (@{$filterlist}) {
18450: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18451: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18452: if ($item eq 'domainfilter') {
18453: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18454: } elsif ($item eq 'coursefilter') {
18455: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18456: } elsif ($item eq 'ownerfilter') {
18457: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18458: } elsif ($item eq 'ownerdomfilter') {
18459: $filter->{'ownerdomfilter'} =
18460: &LONCAPA::clean_domain($filter->{$item});
18461: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18462: 'ownerdomfilter',1);
18463: } elsif ($item eq 'personfilter') {
18464: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18465: } elsif ($item eq 'persondomfilter') {
18466: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18467: 'persondomfilter',1);
18468: } else {
18469: $filter->{$item} =~ s/\W//g;
18470: }
18471: if (!$filter->{$item}) {
18472: $filter->{$item} = '';
18473: }
18474: }
18475: if ($item eq 'domainfilter') {
18476: my $allow_blank = 1;
18477: if ($formname eq 'portform') {
18478: $allow_blank=0;
18479: } elsif ($formname eq 'studentform') {
18480: $allow_blank=0;
18481: }
18482: if ($fixeddom) {
18483: $domainselectform = '<input type="hidden" name="domainfilter"'.
18484: ' value="'.$codedom.'" />'.
18485: &Apache::lonnet::domain($codedom,'description');
18486: } else {
18487: $domainselectform = &select_dom_form($filter->{$item},
18488: 'domainfilter',
18489: $allow_blank,'',$onchange);
18490: }
18491: } else {
18492: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18493: }
18494: }
18495:
18496: # last course activity filter and selection
18497: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18498:
18499: # course created filter and selection
18500: if (exists($filter->{'createdfilter'})) {
18501: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18502: }
18503:
1.1239 raeburn 18504: my $prefix = $crstype;
18505: if ($crstype eq 'Placement') {
18506: $prefix = 'Placement Test'
18507: }
1.1181 raeburn 18508: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18509: 'cac' => "$prefix Activity",
18510: 'ccr' => "$prefix Created",
18511: 'cde' => "$prefix Title",
18512: 'cdo' => "$prefix Domain",
1.1181 raeburn 18513: 'ins' => 'Institutional Code',
18514: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18515: 'cow' => "$prefix Owner/Co-owner",
18516: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18517: 'cog' => 'Type',
18518: );
18519:
18520: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18521: my $typeval = 'Course';
18522: if ($crstype eq 'Community') {
18523: $typeval = 'Community';
1.1239 raeburn 18524: } elsif ($crstype eq 'Placement') {
18525: $typeval = 'Placement';
1.1181 raeburn 18526: }
18527: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18528: } else {
18529: $typeselectform = '<select name="type" size="1"';
18530: if ($onchange) {
18531: $typeselectform .= ' onchange="'.$onchange.'"';
18532: }
18533: $typeselectform .= '>'."\n";
1.1237 raeburn 18534: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18535: my $shown;
18536: if ($posstype eq 'Placement') {
18537: $shown = &mt('Placement Test');
18538: } else {
18539: $shown = &mt($posstype);
18540: }
1.1181 raeburn 18541: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18542: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18543: }
18544: $typeselectform.="</select>";
18545: }
18546:
18547: my ($cloneableonlyform,$cloneabletitle);
18548: if (exists($filter->{'cloneableonly'})) {
18549: my $cloneableon = '';
18550: my $cloneableoff = ' checked="checked"';
18551: if ($filter->{'cloneableonly'}) {
18552: $cloneableon = $cloneableoff;
18553: $cloneableoff = '';
18554: }
18555: $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>';
18556: if ($formname eq 'ccrs') {
1.1187 bisitz 18557: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18558: } else {
18559: $cloneabletitle = &mt('Cloneable by you');
18560: }
18561: }
18562: my $officialjs;
18563: if ($crstype eq 'Course') {
18564: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18565: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18566: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18567: if ($codedom) {
1.1181 raeburn 18568: $officialjs = 1;
18569: ($instcodeform,$jscript,$$numtitlesref) =
18570: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18571: $officialjs,$codetitlesref);
18572: if ($jscript) {
1.1182 raeburn 18573: $jscript = '<script type="text/javascript">'."\n".
18574: '// <![CDATA['."\n".
18575: $jscript."\n".
18576: '// ]]>'."\n".
18577: '</script>'."\n";
1.1181 raeburn 18578: }
18579: }
18580: if ($instcodeform eq '') {
18581: $instcodeform =
18582: '<input type="text" name="instcodefilter" size="10" value="'.
18583: $list->{'instcodefilter'}.'" />';
18584: $instcodetitle = $lt{'ins'};
18585: } else {
18586: $instcodetitle = $lt{'inc'};
18587: }
18588: if ($fixeddom) {
18589: $instcodetitle .= '<br />('.$codedom.')';
18590: }
18591: }
18592: }
18593: my $output = qq|
18594: <form method="post" name="filterpicker" action="$action">
18595: <input type="hidden" name="form" value="$formname" />
18596: |;
18597: if ($formname eq 'modifycourse') {
18598: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18599: '<input type="hidden" name="prevphase" value="'.
18600: $prevphase.'" />'."\n";
1.1198 musolffc 18601: } elsif ($formname eq 'quotacheck') {
18602: $output .= qq|
18603: <input type="hidden" name="sortby" value="" />
18604: <input type="hidden" name="sortorder" value="" />
18605: |;
18606: } else {
1.1181 raeburn 18607: my $name_input;
18608: if ($cnameelement ne '') {
18609: $name_input = '<input type="hidden" name="cnameelement" value="'.
18610: $cnameelement.'" />';
18611: }
18612: $output .= qq|
1.1182 raeburn 18613: <input type="hidden" name="cnumelement" value="$cnumelement" />
18614: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18615: $name_input
18616: $roleelement
18617: $multelement
18618: $typeelement
18619: |;
18620: if ($formname eq 'portform') {
18621: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18622: }
18623: }
18624: if ($fixeddom) {
18625: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18626: }
18627: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18628: if ($sincefilterform) {
18629: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18630: .$sincefilterform
18631: .&Apache::lonhtmlcommon::row_closure();
18632: }
18633: if ($createdfilterform) {
18634: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18635: .$createdfilterform
18636: .&Apache::lonhtmlcommon::row_closure();
18637: }
18638: if ($domainselectform) {
18639: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18640: .$domainselectform
18641: .&Apache::lonhtmlcommon::row_closure();
18642: }
18643: if ($typeselectform) {
18644: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18645: $output .= $typeselectform;
18646: } else {
18647: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18648: .$typeselectform
18649: .&Apache::lonhtmlcommon::row_closure();
18650: }
18651: }
18652: if ($instcodeform) {
18653: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18654: .$instcodeform
18655: .&Apache::lonhtmlcommon::row_closure();
18656: }
18657: if (exists($filter->{'ownerfilter'})) {
18658: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18659: '<table><tr><td>'.&mt('Username').'<br />'.
18660: '<input type="text" name="ownerfilter" size="20" value="'.
18661: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18662: $ownerdomselectform.'</td></tr></table>'.
18663: &Apache::lonhtmlcommon::row_closure();
18664: }
18665: if (exists($filter->{'personfilter'})) {
18666: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18667: '<table><tr><td>'.&mt('Username').'<br />'.
18668: '<input type="text" name="personfilter" size="20" value="'.
18669: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18670: $persondomselectform.'</td></tr></table>'.
18671: &Apache::lonhtmlcommon::row_closure();
18672: }
18673: if (exists($filter->{'coursefilter'})) {
18674: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18675: .'<input type="text" name="coursefilter" size="25" value="'
18676: .$list->{'coursefilter'}.'" />'
18677: .&Apache::lonhtmlcommon::row_closure();
18678: }
18679: if ($cloneableonlyform) {
18680: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18681: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18682: }
18683: if (exists($filter->{'descriptfilter'})) {
18684: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18685: .'<input type="text" name="descriptfilter" size="40" value="'
18686: .$list->{'descriptfilter'}.'" />'
18687: .&Apache::lonhtmlcommon::row_closure(1);
18688: }
18689: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18690: '<input type="hidden" name="updater" value="" />'."\n".
18691: '<input type="submit" name="gosearch" value="'.
18692: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18693: return $jscript.$clonewarning.$output;
18694: }
18695:
18696: =pod
18697:
18698: =item * &timebased_select_form()
18699:
1.1182 raeburn 18700: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18701: filter e.g., Course Activity, Course Created, when searching for courses
18702: or communities
18703:
18704: Inputs:
18705:
18706: item - name of form element (sincefilter or createdfilter)
18707:
18708: filter - anonymous hash of criteria and their values
18709:
18710: Returns: HTML for a select box contained a blank, then six time selections,
18711: with value set in incoming form variables currently selected.
18712:
18713: Side Effects: None
18714:
18715: =cut
18716:
18717: sub timebased_select_form {
18718: my ($item,$filter) = @_;
18719: if (ref($filter) eq 'HASH') {
18720: $filter->{$item} =~ s/[^\d-]//g;
18721: if (!$filter->{$item}) { $filter->{$item}=-1; }
18722: return &select_form(
18723: $filter->{$item},
18724: $item,
18725: { '-1' => '',
18726: '86400' => &mt('today'),
18727: '604800' => &mt('last week'),
18728: '2592000' => &mt('last month'),
18729: '7776000' => &mt('last three months'),
18730: '15552000' => &mt('last six months'),
18731: '31104000' => &mt('last year'),
18732: 'select_form_order' =>
18733: ['-1','86400','604800','2592000','7776000',
18734: '15552000','31104000']});
18735: }
18736: }
18737:
18738: =pod
18739:
18740: =item * &js_changer()
18741:
18742: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18743: when course type or domain is changed, and also to hide 'Searching ...' on
18744: page load completion for page showing search result.
1.1181 raeburn 18745:
18746: Inputs: None
18747:
1.1183 raeburn 18748: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18749:
18750: Side Effects: None
18751:
18752: =cut
18753:
18754: sub js_changer {
18755: return <<ENDJS;
18756: <script type="text/javascript">
18757: // <![CDATA[
18758: function updateFilters(caller) {
18759: if (typeof(caller) != "undefined") {
18760: document.filterpicker.updater.value = caller.name;
18761: }
18762: document.filterpicker.submit();
18763: }
1.1183 raeburn 18764:
18765: function hideSearching() {
18766: if (document.getElementById('searching')) {
18767: document.getElementById('searching').style.display = 'none';
18768: }
18769: return;
18770: }
18771:
1.1181 raeburn 18772: // ]]>
18773: </script>
18774:
18775: ENDJS
18776: }
18777:
18778: =pod
18779:
1.1182 raeburn 18780: =item * &search_courses()
18781:
18782: Process selected filters form course search form and pass to lonnet::courseiddump
18783: to retrieve a hash for which keys are courseIDs which match the selected filters.
18784:
18785: Inputs:
18786:
18787: dom - domain being searched
18788:
18789: type - course type ('Course' or 'Community' or '.' if any).
18790:
18791: filter - anonymous hash of criteria and their values
18792:
18793: numtitles - for institutional codes - number of categories
18794:
18795: cloneruname - optional username of new course owner
18796:
18797: clonerudom - optional domain of new course owner
18798:
1.1221 raeburn 18799: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18800: (used when DC is using course creation form)
18801:
18802: codetitles - reference to array of titles of components in institutional codes (official courses).
18803:
1.1221 raeburn 18804: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18805: (and so can clone automatically)
18806:
18807: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18808:
18809: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18810: courses to clone
1.1182 raeburn 18811:
18812: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18813:
18814:
18815: Side Effects: None
18816:
18817: =cut
18818:
18819:
18820: sub search_courses {
1.1221 raeburn 18821: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18822: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18823: my (%courses,%showcourses,$cloner);
18824: if (($filter->{'ownerfilter'} ne '') ||
18825: ($filter->{'ownerdomfilter'} ne '')) {
18826: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18827: $filter->{'ownerdomfilter'};
18828: }
18829: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18830: if (!$filter->{$item}) {
18831: $filter->{$item}='.';
18832: }
18833: }
18834: my $now = time;
18835: my $timefilter =
18836: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18837: my ($createdbefore,$createdafter);
18838: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18839: $createdbefore = $now;
18840: $createdafter = $now-$filter->{'createdfilter'};
18841: }
18842: my ($instcodefilter,$regexpok);
18843: if ($numtitles) {
18844: if ($env{'form.official'} eq 'on') {
18845: $instcodefilter =
18846: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18847: $regexpok = 1;
18848: } elsif ($env{'form.official'} eq 'off') {
18849: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18850: unless ($instcodefilter eq '') {
18851: $regexpok = -1;
18852: }
18853: }
18854: } else {
18855: $instcodefilter = $filter->{'instcodefilter'};
18856: }
18857: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18858: if ($type eq '') { $type = '.'; }
18859:
18860: if (($clonerudom ne '') && ($cloneruname ne '')) {
18861: $cloner = $cloneruname.':'.$clonerudom;
18862: }
18863: %courses = &Apache::lonnet::courseiddump($dom,
18864: $filter->{'descriptfilter'},
18865: $timefilter,
18866: $instcodefilter,
18867: $filter->{'combownerfilter'},
18868: $filter->{'coursefilter'},
18869: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18870: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18871: $filter->{'cloneableonly'},
18872: $createdbefore,$createdafter,undef,
1.1221 raeburn 18873: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18874: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18875: my $ccrole;
18876: if ($type eq 'Community') {
18877: $ccrole = 'co';
18878: } else {
18879: $ccrole = 'cc';
18880: }
18881: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18882: $filter->{'persondomfilter'},
18883: 'userroles',undef,
18884: [$ccrole,'in','ad','ep','ta','cr'],
18885: $dom);
18886: foreach my $role (keys(%rolehash)) {
18887: my ($cnum,$cdom,$courserole) = split(':',$role);
18888: my $cid = $cdom.'_'.$cnum;
18889: if (exists($courses{$cid})) {
18890: if (ref($courses{$cid}) eq 'HASH') {
18891: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18892: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18893: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18894: }
18895: } else {
18896: $courses{$cid}{roles} = [$courserole];
18897: }
18898: $showcourses{$cid} = $courses{$cid};
18899: }
18900: }
18901: }
18902: %courses = %showcourses;
18903: }
18904: return %courses;
18905: }
18906:
18907: =pod
18908:
1.1181 raeburn 18909: =back
18910:
1.1207 raeburn 18911: =head1 Routines for version requirements for current course.
18912:
18913: =over 4
18914:
18915: =item * &check_release_required()
18916:
18917: Compares required LON-CAPA version with version on server, and
18918: if required version is newer looks for a server with the required version.
18919:
18920: Looks first at servers in user's owen domain; if none suitable, looks at
18921: servers in course's domain are permitted to host sessions for user's domain.
18922:
18923: Inputs:
18924:
18925: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18926:
18927: $courseid - Course ID of current course
18928:
18929: $rolecode - User's current role in course (for switchserver query string).
18930:
18931: $required - LON-CAPA version needed by course (format: Major.Minor).
18932:
18933:
18934: Returns:
18935:
18936: $switchserver - query string tp append to /adm/switchserver call (if
18937: current server's LON-CAPA version is too old.
18938:
18939: $warning - Message is displayed if no suitable server could be found.
18940:
18941: =cut
18942:
18943: sub check_release_required {
18944: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18945: my ($switchserver,$warning);
18946: if ($required ne '') {
18947: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18948: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18949: if ($reqdmajor ne '' && $reqdminor ne '') {
18950: my $otherserver;
18951: if (($major eq '' && $minor eq '') ||
18952: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18953: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18954: my $switchlcrev =
18955: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18956: $userdomserver);
18957: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18958: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18959: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18960: my $cdom = $env{'course.'.$courseid.'.domain'};
18961: if ($cdom ne $env{'user.domain'}) {
18962: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18963: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18964: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18965: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18966: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18967: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18968: my $canhost =
18969: &Apache::lonnet::can_host_session($env{'user.domain'},
18970: $coursedomserver,
18971: $remoterev,
18972: $udomdefaults{'remotesessions'},
18973: $defdomdefaults{'hostedsessions'});
18974:
18975: if ($canhost) {
18976: $otherserver = $coursedomserver;
18977: } else {
18978: $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.");
18979: }
18980: } else {
18981: $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).");
18982: }
18983: } else {
18984: $otherserver = $userdomserver;
18985: }
18986: }
18987: if ($otherserver ne '') {
18988: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18989: }
18990: }
18991: }
18992: return ($switchserver,$warning);
18993: }
18994:
18995: =pod
18996:
18997: =item * &check_release_result()
18998:
18999: Inputs:
19000:
19001: $switchwarning - Warning message if no suitable server found to host session.
19002:
19003: $switchserver - query string to append to /adm/switchserver containing lonHostID
19004: and current role.
19005:
19006: Returns: HTML to display with information about requirement to switch server.
19007: Either displaying warning with link to Roles/Courses screen or
19008: display link to switchserver.
19009:
1.1181 raeburn 19010: =cut
19011:
1.1207 raeburn 19012: sub check_release_result {
19013: my ($switchwarning,$switchserver) = @_;
19014: my $output = &start_page('Selected course unavailable on this server').
19015: '<p class="LC_warning">';
19016: if ($switchwarning) {
19017: $output .= $switchwarning.'<br /><a href="/adm/roles">';
19018: if (&show_course()) {
19019: $output .= &mt('Display courses');
19020: } else {
19021: $output .= &mt('Display roles');
19022: }
19023: $output .= '</a>';
19024: } elsif ($switchserver) {
19025: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
19026: '<br />'.
19027: '<a href="/adm/switchserver?'.$switchserver.'">'.
19028: &mt('Switch Server').
19029: '</a>';
19030: }
19031: $output .= '</p>'.&end_page();
19032: return $output;
19033: }
19034:
19035: =pod
19036:
19037: =item * &needs_coursereinit()
19038:
19039: Determine if course contents stored for user's session needs to be
19040: refreshed, because content has changed since "Big Hash" last tied.
19041:
19042: Check for change is made if time last checked is more than 10 minutes ago
19043: (by default).
19044:
19045: Inputs:
19046:
19047: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
19048:
19049: $interval (optional) - Time which may elapse (in s) between last check for content
19050: change in current course. (default: 600 s).
19051:
19052: Returns: an array; first element is:
19053:
19054: =over 4
19055:
19056: 'switch' - if content updates mean user's session
19057: needs to be switched to a server running a newer LON-CAPA version
19058:
19059: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
19060: on current server hosting user's session
19061:
19062: '' - if no action required.
19063:
19064: =back
19065:
19066: If first item element is 'switch':
19067:
19068: second item is $switchwarning - Warning message if no suitable server found to host session.
19069:
19070: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
19071: and current role.
19072:
19073: otherwise: no other elements returned.
19074:
19075: =back
19076:
19077: =cut
19078:
19079: sub needs_coursereinit {
19080: my ($loncaparev,$interval) = @_;
19081: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
19082: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19083: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19084: my $now = time;
19085: if ($interval eq '') {
19086: $interval = 600;
19087: }
19088: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19089: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19090: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19091: if ($blocked) {
19092: return ();
19093: }
1.1391 raeburn 19094: my $update;
19095: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19096: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19097: if ($lastmainchange > $env{'request.course.tied'}) {
19098: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19099: if ($needswitch) {
19100: return ('switch',$switchwarning,$switchserver);
19101: }
19102: $update = 'main';
19103: }
19104: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19105: if ($update) {
19106: $update = 'both';
19107: } else {
19108: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19109: if ($needswitch) {
19110: return ('switch',$switchwarning,$switchserver);
19111: } else {
19112: $update = 'supp';
1.1207 raeburn 19113: }
19114: }
1.1391 raeburn 19115: }
1.1453 raeburn 19116: return ($update);
1.1391 raeburn 19117: }
19118: return ();
19119: }
19120:
19121: sub switch_for_update {
19122: my ($loncaparev,$cdom,$cnum) = @_;
19123: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19124: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19125: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19126: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19127: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19128: $curr_reqd_hash{'internal.releaserequired'}});
19129: my ($switchserver,$switchwarning) =
19130: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19131: $curr_reqd_hash{'internal.releaserequired'});
19132: if ($switchwarning ne '' || $switchserver ne '') {
19133: return ('switch',$switchwarning,$switchserver);
19134: }
1.1207 raeburn 19135: }
19136: }
19137: return ();
19138: }
1.1181 raeburn 19139:
1.1083 raeburn 19140: sub update_content_constraints {
1.1395 raeburn 19141: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19142: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19143: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19144: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19145: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19146: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19147: if ($item eq 'resourcetag') {
19148: if ($name eq 'responsetype') {
19149: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19150: }
1.1307 raeburn 19151: } elsif ($item eq 'course') {
19152: if ($name eq 'courserestype') {
19153: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19154: }
1.1083 raeburn 19155: }
19156: }
19157: my $navmap = Apache::lonnavmaps::navmap->new();
19158: if (defined($navmap)) {
1.1307 raeburn 19159: my (%allresponses,%allcrsrestypes);
19160: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19161: if ($res->is_tool()) {
19162: if ($allcrsrestypes{'exttool'}) {
19163: $allcrsrestypes{'exttool'} ++;
19164: } else {
19165: $allcrsrestypes{'exttool'} = 1;
19166: }
19167: next;
19168: }
1.1083 raeburn 19169: my %responses = $res->responseTypes();
19170: foreach my $key (keys(%responses)) {
19171: next unless(exists($checkresponsetypes{$key}));
19172: $allresponses{$key} += $responses{$key};
19173: }
19174: }
19175: foreach my $key (keys(%allresponses)) {
19176: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19177: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19178: ($reqdmajor,$reqdminor) = ($major,$minor);
19179: }
19180: }
1.1307 raeburn 19181: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19182: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19183: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19184: ($reqdmajor,$reqdminor) = ($major,$minor);
19185: }
19186: }
1.1083 raeburn 19187: undef($navmap);
19188: }
1.1391 raeburn 19189: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19190: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19191: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19192: ($reqdmajor,$reqdminor) = ($major,$minor);
19193: }
19194: }
1.1083 raeburn 19195: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19196: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19197: }
19198: return;
19199: }
19200:
1.1110 raeburn 19201: sub allmaps_incourse {
19202: my ($cdom,$cnum,$chome,$cid) = @_;
19203: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19204: $cid = $env{'request.course.id'};
19205: $cdom = $env{'course.'.$cid.'.domain'};
19206: $cnum = $env{'course.'.$cid.'.num'};
19207: $chome = $env{'course.'.$cid.'.home'};
19208: }
19209: my %allmaps = ();
19210: my $lastchange =
19211: &Apache::lonnet::get_coursechange($cdom,$cnum);
19212: if ($lastchange > $env{'request.course.tied'}) {
19213: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19214: unless ($ferr) {
1.1395 raeburn 19215: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19216: }
19217: }
19218: my $navmap = Apache::lonnavmaps::navmap->new();
19219: if (defined($navmap)) {
19220: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19221: $allmaps{$res->src()} = 1;
19222: }
19223: }
19224: return \%allmaps;
19225: }
19226:
1.1083 raeburn 19227: sub parse_supplemental_title {
19228: my ($title) = @_;
19229:
19230: my ($foldertitle,$renametitle);
19231: if ($title =~ /&&&/) {
19232: $title = &HTML::Entites::decode($title);
19233: }
19234: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19235: $renametitle=$4;
19236: my ($time,$uname,$udom) = ($1,$2,$3);
19237: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19238: my $name = &plainname($uname,$udom);
19239: $name = &HTML::Entities::encode($name,'"<>&\'');
19240: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19241: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19242: if ($foldertitle ne '') {
1.1401 raeburn 19243: $title .= ': <br />'.$foldertitle;
19244: }
1.1083 raeburn 19245: }
19246: if (wantarray) {
19247: return ($title,$foldertitle,$renametitle);
19248: }
19249: return $title;
19250: }
19251:
1.1395 raeburn 19252: sub get_supplemental {
19253: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19254: my $hashid=$cnum.':'.$cdom;
19255: my ($supplemental,$cached,$set_httprefs);
19256: unless ($ignorecache) {
19257: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19258: }
19259: unless (defined($cached)) {
19260: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19261: unless ($chome eq 'no_host') {
19262: my @order = @LONCAPA::map::order;
19263: my @resources = @LONCAPA::map::resources;
19264: my @resparms = @LONCAPA::map::resparms;
19265: my @zombies = @LONCAPA::map::zombies;
19266: my ($errors,%ids,%hidden);
19267: $errors =
19268: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19269: $errors,$possdel,\%ids,\%hidden);
19270: @LONCAPA::map::order = @order;
19271: @LONCAPA::map::resources = @resources;
19272: @LONCAPA::map::resparms = @resparms;
19273: @LONCAPA::map::zombies = @zombies;
19274: $set_httprefs = 1;
19275: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19276: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19277: }
19278: $supplemental = {
19279: ids => \%ids,
19280: hidden => \%hidden,
19281: };
19282: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19283: }
19284: }
19285: return ($supplemental,$set_httprefs);
19286: }
19287:
1.1143 raeburn 19288: sub recurse_supplemental {
1.1391 raeburn 19289: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19290: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19291: my $mapnum;
19292: if ($suppmap eq 'supplemental.sequence') {
19293: $mapnum = 0;
19294: } else {
19295: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19296: }
1.1143 raeburn 19297: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19298: if ($fatal) {
19299: $errors ++;
19300: } else {
1.1389 raeburn 19301: my @order = @LONCAPA::map::order;
19302: if (@order > 0) {
19303: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19304: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19305: foreach my $idx (@order) {
19306: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19307: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19308: my $id = $mapnum.':'.$idx;
19309: push(@{$suppids->{$src}},$id);
19310: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19311: $hiddensupp->{$id} = 1;
19312: }
1.1146 raeburn 19313: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19314: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19315: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19316: } else {
1.1391 raeburn 19317: my $allowed;
19318: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19319: $allowed = 1;
19320: } elsif ($possdel) {
19321: foreach my $item (@{$suppids->{$src}}) {
19322: next if ($item eq $id);
19323: unless ($hiddensupp->{$item}) {
19324: $allowed = 1;
19325: last;
19326: }
19327: }
19328: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19329: &Apache::lonnet::delenv('httpref.'.$src);
19330: }
19331: }
19332: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19333: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19334: }
1.1143 raeburn 19335: }
19336: }
19337: }
19338: }
19339: }
19340: }
1.1391 raeburn 19341: return $errors;
19342: }
19343:
19344: sub set_supp_httprefs {
19345: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19346: if (ref($supplemental) eq 'HASH') {
19347: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19348: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19349: next if ($src =~ /\.sequence$/);
19350: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19351: my $allowed;
19352: if ($env{'request.role.adv'}) {
19353: $allowed = 1;
19354: } else {
19355: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19356: unless ($supplemental->{'hidden'}->{$id}) {
19357: $allowed = 1;
19358: last;
19359: }
19360: }
19361: }
19362: if (exists($env{'httpref.'.$src})) {
19363: if ($possdel) {
19364: unless ($allowed) {
19365: &Apache::lonnet::delenv('httpref.'.$src);
19366: }
19367: }
19368: } elsif ($allowed) {
19369: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19370: }
19371: }
19372: }
19373: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19374: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19375: }
19376: }
19377: }
19378: }
19379:
19380: sub get_supp_parameter {
19381: my ($resparm,$name)=@_;
19382: return if ($resparm eq '');
19383: my $value=undef;
19384: my $ptype=undef;
19385: foreach (split('&&&',$resparm)) {
19386: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19387: if ($thisname eq $name) {
19388: $value=$thisvalue;
19389: $ptype=$thistype;
19390: }
19391: }
19392: return $value;
1.1143 raeburn 19393: }
19394:
1.1101 raeburn 19395: sub symb_to_docspath {
1.1267 raeburn 19396: my ($symb,$navmapref) = @_;
19397: return unless ($symb && ref($navmapref));
1.1101 raeburn 19398: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19399: if ($resurl=~/\.(sequence|page)$/) {
19400: $mapurl=$resurl;
19401: } elsif ($resurl eq 'adm/navmaps') {
19402: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19403: }
19404: my $mapresobj;
1.1267 raeburn 19405: unless (ref($$navmapref)) {
19406: $$navmapref = Apache::lonnavmaps::navmap->new();
19407: }
19408: if (ref($$navmapref)) {
19409: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19410: }
19411: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19412: my $type=$2;
19413: my $path;
19414: if (ref($mapresobj)) {
19415: my $pcslist = $mapresobj->map_hierarchy();
19416: if ($pcslist ne '') {
19417: foreach my $pc (split(/,/,$pcslist)) {
19418: next if ($pc <= 1);
1.1267 raeburn 19419: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19420: if (ref($res)) {
19421: my $thisurl = $res->src();
19422: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19423: my $thistitle = $res->title();
19424: $path .= '&'.
19425: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19426: &escape($thistitle).
1.1101 raeburn 19427: ':'.$res->randompick().
19428: ':'.$res->randomout().
19429: ':'.$res->encrypted().
19430: ':'.$res->randomorder().
19431: ':'.$res->is_page();
19432: }
19433: }
19434: }
19435: $path =~ s/^\&//;
19436: my $maptitle = $mapresobj->title();
19437: if ($mapurl eq 'default') {
1.1129 raeburn 19438: $maptitle = 'Main Content';
1.1101 raeburn 19439: }
19440: $path .= (($path ne '')? '&' : '').
19441: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19442: &escape($maptitle).
1.1101 raeburn 19443: ':'.$mapresobj->randompick().
19444: ':'.$mapresobj->randomout().
19445: ':'.$mapresobj->encrypted().
19446: ':'.$mapresobj->randomorder().
19447: ':'.$mapresobj->is_page();
19448: } else {
19449: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19450: my $ispage = (($type eq 'page')? 1 : '');
19451: if ($mapurl eq 'default') {
1.1129 raeburn 19452: $maptitle = 'Main Content';
1.1101 raeburn 19453: }
19454: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19455: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19456: }
19457: unless ($mapurl eq 'default') {
19458: $path = 'default&'.
1.1146 raeburn 19459: &escape('Main Content').
1.1101 raeburn 19460: ':::::&'.$path;
19461: }
19462: return $path;
19463: }
19464:
1.1393 raeburn 19465: sub validate_folderpath {
19466: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19467: if ($env{'form.folderpath'} ne '') {
19468: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19469: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19470: for (my $i=0; $i<@items; $i++) {
19471: my $odd = $i%2;
19472: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19473: $badpath = 1;
1.1394 raeburn 19474: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19475: my $idx = $i-1;
1.1394 raeburn 19476: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19477: my $esc_name = $1;
19478: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19479: $supppath .= '&'.$esc_name;
19480: $changed = 1;
19481: } else {
19482: $supppath .= '&'.$items[$i];
19483: }
19484: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19485: $changed = 1;
1.1393 raeburn 19486: my $is_hidden;
19487: unless ($got_supp) {
1.1395 raeburn 19488: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19489: if (ref($supplemental) eq 'HASH') {
19490: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19491: %supphidden = %{$supplemental->{'hidden'}};
19492: }
19493: if (ref($supplemental->{'ids'}) eq 'HASH') {
19494: %suppids = %{$supplemental->{'ids'}};
19495: }
19496: }
19497: $got_supp = 1;
19498: }
19499: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19500: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19501: if ($supphidden{$mapid}) {
19502: $is_hidden = 1;
19503: }
19504: }
1.1394 raeburn 19505: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19506: } else {
19507: $supppath .= '&'.$items[$i];
1.1393 raeburn 19508: }
19509: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19510: $badpath = 1;
1.1394 raeburn 19511: } elsif ($supplementalflag) {
1.1393 raeburn 19512: $supppath .= '&'.$items[$i];
19513: }
19514: last if ($badpath);
19515: }
19516: if ($badpath) {
19517: delete($env{'form.folderpath'});
1.1394 raeburn 19518: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19519: $supppath =~ s/^\&//;
19520: $env{'form.folderpath'} = $supppath;
19521: }
19522: }
19523: return;
19524: }
19525:
1.1094 raeburn 19526: sub captcha_display {
1.1327 raeburn 19527: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19528: my ($output,$error);
1.1234 raeburn 19529: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19530: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19531: if ($captcha eq 'original') {
1.1094 raeburn 19532: $output = &create_captcha();
19533: unless ($output) {
1.1172 raeburn 19534: $error = 'captcha';
1.1094 raeburn 19535: }
19536: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19537: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19538: unless ($output) {
1.1172 raeburn 19539: $error = 'recaptcha';
1.1094 raeburn 19540: }
19541: }
1.1234 raeburn 19542: return ($output,$error,$captcha,$version);
1.1094 raeburn 19543: }
19544:
19545: sub captcha_response {
1.1327 raeburn 19546: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19547: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19548: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19549: if ($captcha eq 'original') {
1.1094 raeburn 19550: ($captcha_chk,$captcha_error) = &check_captcha();
19551: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19552: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19553: } else {
19554: $captcha_chk = 1;
19555: }
19556: return ($captcha_chk,$captcha_error);
19557: }
19558:
19559: sub get_captcha_config {
1.1327 raeburn 19560: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19561: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19562: my $hostname = &Apache::lonnet::hostname($lonhost);
19563: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19564: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19565: if ($context eq 'usercreation') {
19566: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19567: if (ref($domconfig{$context}) eq 'HASH') {
19568: $hashtocheck = $domconfig{$context}{'cancreate'};
19569: if (ref($hashtocheck) eq 'HASH') {
19570: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19571: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19572: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19573: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19574: }
19575: if ($privkey && $pubkey) {
19576: $captcha = 'recaptcha';
1.1234 raeburn 19577: $version = $hashtocheck->{'recaptchaversion'};
19578: if ($version ne '2') {
19579: $version = 1;
19580: }
1.1095 raeburn 19581: } else {
19582: $captcha = 'original';
19583: }
19584: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19585: $captcha = 'original';
19586: }
1.1094 raeburn 19587: }
1.1095 raeburn 19588: } else {
19589: $captcha = 'captcha';
19590: }
19591: } elsif ($context eq 'login') {
19592: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19593: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19594: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19595: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19596: if ($privkey && $pubkey) {
19597: $captcha = 'recaptcha';
1.1234 raeburn 19598: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19599: if ($version ne '2') {
19600: $version = 1;
19601: }
1.1095 raeburn 19602: } else {
19603: $captcha = 'original';
1.1094 raeburn 19604: }
1.1095 raeburn 19605: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19606: $captcha = 'original';
1.1094 raeburn 19607: }
1.1327 raeburn 19608: } elsif ($context eq 'passwords') {
19609: if ($dom_in_effect) {
19610: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19611: if ($passwdconf{'captcha'} eq 'recaptcha') {
19612: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19613: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19614: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19615: }
19616: if ($privkey && $pubkey) {
19617: $captcha = 'recaptcha';
19618: $version = $passwdconf{'recaptchaversion'};
19619: if ($version ne '2') {
19620: $version = 1;
19621: }
19622: } else {
19623: $captcha = 'original';
19624: }
19625: } elsif ($passwdconf{'captcha'} ne 'notused') {
19626: $captcha = 'original';
19627: }
19628: }
19629: }
1.1234 raeburn 19630: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19631: }
19632:
19633: sub create_captcha {
19634: my %captcha_params = &captcha_settings();
19635: my ($output,$maxtries,$tries) = ('',10,0);
19636: while ($tries < $maxtries) {
19637: $tries ++;
19638: my $captcha = Authen::Captcha->new (
19639: output_folder => $captcha_params{'output_dir'},
19640: data_folder => $captcha_params{'db_dir'},
19641: );
19642: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19643:
19644: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19645: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19646: '<span class="LC_nobreak">'.
1.1453 raeburn 19647: '<label>'.&mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19648: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1453 raeburn 19649: '</label></span><br />'.
1.1176 raeburn 19650: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19651: last;
19652: }
19653: }
1.1323 raeburn 19654: if ($output eq '') {
19655: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19656: }
1.1094 raeburn 19657: return $output;
19658: }
19659:
19660: sub captcha_settings {
19661: my %captcha_params = (
19662: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19663: www_output_dir => "/captchaspool",
19664: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19665: numchars => '5',
19666: );
19667: return %captcha_params;
19668: }
19669:
19670: sub check_captcha {
19671: my ($captcha_chk,$captcha_error);
19672: my $code = $env{'form.code'};
19673: my $md5sum = $env{'form.crypt'};
19674: my %captcha_params = &captcha_settings();
19675: my $captcha = Authen::Captcha->new(
19676: output_folder => $captcha_params{'output_dir'},
19677: data_folder => $captcha_params{'db_dir'},
19678: );
1.1109 raeburn 19679: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19680: my %captcha_hash = (
19681: 0 => 'Code not checked (file error)',
19682: -1 => 'Failed: code expired',
19683: -2 => 'Failed: invalid code (not in database)',
19684: -3 => 'Failed: invalid code (code does not match crypt)',
19685: );
19686: if ($captcha_chk != 1) {
19687: $captcha_error = $captcha_hash{$captcha_chk}
19688: }
19689: return ($captcha_chk,$captcha_error);
19690: }
19691:
19692: sub create_recaptcha {
1.1234 raeburn 19693: my ($pubkey,$version) = @_;
19694: if ($version >= 2) {
1.1367 raeburn 19695: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19696: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19697: } else {
19698: my $use_ssl;
19699: if ($ENV{'SERVER_PORT'} == 443) {
19700: $use_ssl = 1;
19701: }
19702: my $captcha = Captcha::reCAPTCHA->new;
19703: return $captcha->get_options_setter({theme => 'white'})."\n".
19704: $captcha->get_html($pubkey,undef,$use_ssl).
19705: &mt('If the text is hard to read, [_1] will replace them.',
19706: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19707: '<br /><br />';
19708: }
1.1094 raeburn 19709: }
19710:
19711: sub check_recaptcha {
1.1234 raeburn 19712: my ($privkey,$version) = @_;
1.1094 raeburn 19713: my $captcha_chk;
1.1350 raeburn 19714: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19715: if ($version >= 2) {
19716: my %info = (
19717: secret => $privkey,
19718: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19719: remoteip => $ip,
1.1234 raeburn 19720: );
1.1280 raeburn 19721: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19722: $request->content(join('&',map {
19723: my $name = escape($_);
19724: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19725: ? join("&$name=", map {escape($_) } @{$info{$_}})
19726: : &escape($info{$_}) );
19727: } keys(%info)));
19728: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19729: if ($response->is_success) {
19730: my $data = JSON::DWIW->from_json($response->decoded_content);
19731: if (ref($data) eq 'HASH') {
19732: if ($data->{'success'}) {
19733: $captcha_chk = 1;
19734: }
19735: }
19736: }
19737: } else {
19738: my $captcha = Captcha::reCAPTCHA->new;
19739: my $captcha_result =
19740: $captcha->check_answer(
19741: $privkey,
1.1350 raeburn 19742: $ip,
1.1234 raeburn 19743: $env{'form.recaptcha_challenge_field'},
19744: $env{'form.recaptcha_response_field'},
19745: );
19746: if ($captcha_result->{is_valid}) {
19747: $captcha_chk = 1;
19748: }
1.1094 raeburn 19749: }
19750: return $captcha_chk;
19751: }
19752:
1.1174 raeburn 19753: sub emailusername_info {
1.1244 raeburn 19754: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19755: my %titles = &Apache::lonlocal::texthash (
19756: lastname => 'Last Name',
19757: firstname => 'First Name',
19758: institution => 'School/college/university',
19759: location => "School's city, state/province, country",
19760: web => "School's web address",
19761: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19762: id => 'Student/Employee ID',
1.1174 raeburn 19763: );
19764: return (\@fields,\%titles);
19765: }
19766:
1.1161 raeburn 19767: sub cleanup_html {
19768: my ($incoming) = @_;
19769: my $outgoing;
19770: if ($incoming ne '') {
19771: $outgoing = $incoming;
19772: $outgoing =~ s/;/;/g;
19773: $outgoing =~ s/\#/#/g;
19774: $outgoing =~ s/\&/&/g;
19775: $outgoing =~ s/</</g;
19776: $outgoing =~ s/>/>/g;
19777: $outgoing =~ s/\(/(/g;
19778: $outgoing =~ s/\)/)/g;
19779: $outgoing =~ s/"/"/g;
19780: $outgoing =~ s/'/'/g;
19781: $outgoing =~ s/\$/$/g;
19782: $outgoing =~ s{/}{/}g;
19783: $outgoing =~ s/=/=/g;
19784: $outgoing =~ s/\\/\/g
19785: }
19786: return $outgoing;
19787: }
19788:
1.1190 musolffc 19789: # Checks for critical messages and returns a redirect url if one exists.
19790: # $interval indicates how often to check for messages.
1.1282 raeburn 19791: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19792: sub critical_redirect {
1.1282 raeburn 19793: my ($interval,$context) = @_;
1.1356 raeburn 19794: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19795: return ();
19796: }
1.1190 musolffc 19797: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19798: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19799: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19800: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19801: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19802: if ($blocked) {
19803: my $checkrole = "cm./$cdom/$cnum";
19804: if ($env{'request.course.sec'} ne '') {
19805: $checkrole .= "/$env{'request.course.sec'}";
19806: }
19807: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19808: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19809: return;
19810: }
19811: }
19812: }
1.1190 musolffc 19813: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19814: $env{'user.name'});
19815: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19816: my $redirecturl;
1.1190 musolffc 19817: if ($what[0]) {
1.1356 raeburn 19818: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19819: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19820: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19821: return (1, $url);
1.1190 musolffc 19822: }
1.1191 raeburn 19823: }
19824: }
19825: return ();
1.1190 musolffc 19826: }
19827:
1.1174 raeburn 19828: # Use:
19829: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19830: #
19831: ##################################################
19832: # password associated functions #
19833: ##################################################
19834: sub des_keys {
19835: # Make a new key for DES encryption.
19836: # Each key has two parts which are returned separately.
19837: # Please note: Each key must be passed through the &hex function
19838: # before it is output to the web browser. The hex versions cannot
19839: # be used to decrypt.
19840: my @hexstr=('0','1','2','3','4','5','6','7',
19841: '8','9','a','b','c','d','e','f');
19842: my $lkey='';
19843: for (0..7) {
19844: $lkey.=$hexstr[rand(15)];
19845: }
19846: my $ukey='';
19847: for (0..7) {
19848: $ukey.=$hexstr[rand(15)];
19849: }
19850: return ($lkey,$ukey);
19851: }
19852:
19853: sub des_decrypt {
19854: my ($key,$cyphertext) = @_;
19855: my $keybin=pack("H16",$key);
19856: my $cypher;
19857: if ($Crypt::DES::VERSION>=2.03) {
19858: $cypher=new Crypt::DES $keybin;
19859: } else {
19860: $cypher=new DES $keybin;
19861: }
1.1233 raeburn 19862: my $plaintext='';
19863: my $cypherlength = length($cyphertext);
19864: my $numchunks = int($cypherlength/32);
19865: for (my $j=0; $j<$numchunks; $j++) {
19866: my $start = $j*32;
19867: my $cypherblock = substr($cyphertext,$start,32);
19868: my $chunk =
19869: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19870: $chunk .=
19871: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19872: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19873: $plaintext .= $chunk;
19874: }
1.1174 raeburn 19875: return $plaintext;
19876: }
19877:
1.1344 raeburn 19878: sub get_requested_shorturls {
1.1309 raeburn 19879: my ($cdom,$cnum,$navmap) = @_;
19880: return unless (ref($navmap));
1.1344 raeburn 19881: my ($numnew,$errors);
1.1309 raeburn 19882: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19883: if (@toshorten) {
19884: my (%maps,%resources,%titles);
19885: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19886: 'shorturls',$cdom,$cnum);
19887: if (keys(%resources)) {
1.1344 raeburn 19888: my %tocreate;
1.1309 raeburn 19889: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19890: my $symb = $resources{$item};
19891: if ($symb) {
19892: $tocreate{$cnum.'&'.$symb} = 1;
19893: }
19894: }
1.1344 raeburn 19895: if (keys(%tocreate)) {
19896: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19897: \%tocreate);
19898: }
1.1309 raeburn 19899: }
1.1344 raeburn 19900: }
19901: return ($numnew,$errors);
19902: }
19903:
19904: sub make_short_symbs {
19905: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19906: my ($numnew,@errors);
19907: if (ref($tocreateref) eq 'HASH') {
19908: my %tocreate = %{$tocreateref};
1.1309 raeburn 19909: if (keys(%tocreate)) {
19910: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19911: my $su = Short::URL->new(no_vowels => 1);
19912: my $init = '';
19913: my (%newunique,%addcourse,%courseonly,%failed);
19914: # get lock on tiny db
19915: my $now = time;
1.1344 raeburn 19916: if ($lockuser eq '') {
19917: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19918: }
1.1309 raeburn 19919: my $lockhash = {
1.1344 raeburn 19920: "lock\0$now" => $lockuser,
1.1309 raeburn 19921: };
19922: my $tries = 0;
19923: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19924: my ($code,$error);
19925: while (($gotlock ne 'ok') && ($tries<3)) {
19926: $tries ++;
19927: sleep 1;
1.1319 raeburn 19928: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19929: }
19930: if ($gotlock eq 'ok') {
19931: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19932: \%addcourse,\%courseonly,\%failed);
19933: if (keys(%failed)) {
19934: my $numfailed = scalar(keys(%failed));
19935: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19936: }
19937: if (keys(%newunique)) {
19938: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19939: if ($putres eq 'ok') {
19940: $numnew = scalar(keys(%newunique));
19941: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19942: unless ($newputres eq 'ok') {
19943: push(@errors,&mt('error: could not store course look-up of short URLs'));
19944: }
19945: } else {
19946: push(@errors,&mt('error: could not store unique six character URLs'));
19947: }
19948: }
19949: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19950: unless ($dellockres eq 'ok') {
19951: push(@errors,&mt('error: could not release lockfile'));
19952: }
19953: } else {
19954: push(@errors,&mt('error: could not obtain lockfile'));
19955: }
19956: if (keys(%courseonly)) {
19957: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19958: if ($result ne 'ok') {
19959: push(@errors,&mt('error: could not update course look-up of short URLs'));
19960: }
19961: }
19962: }
19963: }
19964: return ($numnew,\@errors);
19965: }
19966:
19967: sub shorten_symbs {
19968: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19969: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19970: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19971: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19972: my (%possibles,%collisions);
19973: foreach my $key (keys(%{$tocreate})) {
19974: my $num = String::CRC32::crc32($key);
19975: my $tiny = $su->encode($num,$init);
19976: if ($tiny) {
19977: $possibles{$tiny} = $key;
19978: }
19979: }
19980: if (!$init) {
19981: $init = 1;
19982: } else {
19983: $init ++;
19984: }
19985: if (keys(%possibles)) {
19986: my @posstiny = keys(%possibles);
19987: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19988: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19989: if (keys(%currtiny)) {
19990: foreach my $key (keys(%currtiny)) {
19991: next if ($currtiny{$key} eq '');
19992: if ($currtiny{$key} eq $possibles{$key}) {
19993: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19994: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19995: $courseonly->{$tsymb} = $key;
19996: }
19997: } else {
19998: $collisions{$possibles{$key}} = 1;
19999: }
20000: delete($possibles{$key});
20001: }
20002: }
20003: foreach my $key (keys(%possibles)) {
20004: $newunique->{$key} = $possibles{$key};
20005: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
20006: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
20007: $addcourse->{$tsymb} = $key;
20008: }
20009: }
20010: }
20011: if (keys(%collisions)) {
20012: if ($init <5) {
20013: if (!$init) {
20014: $init = 1;
20015: } else {
20016: $init ++;
20017: }
20018: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
20019: $newunique,$addcourse,$courseonly,$failed);
20020: } else {
20021: foreach my $key (keys(%collisions)) {
20022: $failed->{$key} = 1;
20023: }
20024: }
20025: }
20026: return $init;
20027: }
20028:
1.1328 raeburn 20029: sub is_nonframeable {
1.1329 raeburn 20030: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
20031: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 20032: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 20033:
20034: $remprotocol = lc($remprotocol);
20035: $remhost = lc($remhost);
20036: my $remport = 80;
20037: if ($remprotocol eq 'https') {
20038: $remport = 443;
20039: }
1.1330 raeburn 20040: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 20041: if ($cached) {
20042: unless ($nocache) {
20043: if ($result) {
20044: return 1;
20045: } else {
20046: return 0;
20047: }
20048: }
20049: }
1.1328 raeburn 20050: my $uselink;
20051: my $request = new HTTP::Request('HEAD',$url);
20052: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
20053: if ($response->is_success()) {
20054: my $secpolicy = lc($response->header('content-security-policy'));
20055: my $xframeop = lc($response->header('x-frame-options'));
20056: $secpolicy =~ s/^\s+|\s+$//g;
20057: $xframeop =~ s/^\s+|\s+$//g;
20058: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 20059: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 20060: my ($origin,$protocol,$port);
20061: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
20062: $port = $ENV{'SERVER_PORT'};
20063: } else {
20064: $port = 80;
20065: }
20066: if ($absolute eq '') {
20067: $protocol = 'http:';
20068: if ($port == 443) {
20069: $protocol = 'https:';
20070: }
20071: $origin = $protocol.'//'.lc($hostname);
20072: } else {
20073: $origin = lc($absolute);
20074: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
20075: }
20076: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
20077: my $framepolicy = $1;
20078: $framepolicy =~ s/^\s+|\s+$//g;
20079: my @policies = split(/\s+/,$framepolicy);
20080: if (@policies) {
20081: if (grep(/^\Q'none'\E$/,@policies)) {
20082: $uselink = 1;
20083: } else {
20084: $uselink = 1;
20085: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20086: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20087: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20088: undef($uselink);
20089: }
20090: if ($uselink) {
20091: if (grep(/^\Q'self'\E$/,@policies)) {
20092: if (($origin ne '') && ($remotehost eq $origin)) {
20093: undef($uselink);
20094: }
20095: }
20096: }
20097: if ($uselink) {
20098: my @possok;
20099: if ($ip ne '') {
20100: push(@possok,$ip);
20101: }
20102: my $hoststr = '';
20103: foreach my $part (reverse(split(/\./,$hostname))) {
20104: if ($hoststr eq '') {
20105: $hoststr = $part;
20106: } else {
20107: $hoststr = "$part.$hoststr";
20108: }
20109: if ($hoststr eq $hostname) {
20110: push(@possok,$hostname);
20111: } else {
20112: push(@possok,"*.$hoststr");
20113: }
20114: }
20115: if (@possok) {
20116: foreach my $poss (@possok) {
20117: last if (!$uselink);
20118: foreach my $policy (@policies) {
20119: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20120: undef($uselink);
20121: last;
20122: }
20123: }
20124: }
20125: }
20126: }
20127: }
20128: }
20129: } elsif ($xframeop ne '') {
20130: $uselink = 1;
20131: my @policies = split(/\s*,\s*/,$xframeop);
20132: if (@policies) {
20133: unless (grep(/^deny$/,@policies)) {
20134: if ($origin ne '') {
20135: if (grep(/^sameorigin$/,@policies)) {
20136: if ($remotehost eq $origin) {
20137: undef($uselink);
20138: }
20139: }
20140: if ($uselink) {
20141: foreach my $policy (@policies) {
20142: if ($policy =~ /^allow-from\s*(.+)$/) {
20143: my $allowfrom = $1;
20144: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20145: undef($uselink);
20146: last;
20147: }
20148: }
20149: }
20150: }
20151: }
20152: }
20153: }
20154: }
20155: }
20156: }
1.1329 raeburn 20157: if ($nocache) {
20158: if ($cached) {
20159: my $devalidate;
20160: if ($uselink && !$result) {
20161: $devalidate = 1;
20162: } elsif (!$uselink && $result) {
20163: $devalidate = 1;
20164: }
20165: if ($devalidate) {
20166: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20167: }
20168: }
20169: } else {
20170: if ($uselink) {
20171: $result = 1;
20172: } else {
20173: $result = 0;
20174: }
20175: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20176: }
1.1328 raeburn 20177: return $uselink;
20178: }
20179:
1.1359 raeburn 20180: sub page_menu {
20181: my ($menucolls,$menunum) = @_;
20182: my %menu;
20183: foreach my $item (split(/;/,$menucolls)) {
20184: my ($num,$value) = split(/\%/,$item);
20185: if ($num eq $menunum) {
20186: my @entries = split(/\&/,$value);
20187: foreach my $entry (@entries) {
20188: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20189: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20190: $menu{$name} = $fields;
20191: } else {
20192: my @shown;
20193: if ($fields =~ /,/) {
20194: @shown = split(/,/,$fields);
20195: } else {
20196: @shown = ($fields);
20197: }
20198: if (@shown) {
20199: foreach my $field (@shown) {
20200: next if ($field eq '');
20201: $menu{$field} = 1;
20202: }
20203: }
20204: }
20205: }
20206: }
20207: }
20208: return %menu;
20209: }
20210:
1.112 bowersj2 20211: 1;
20212: __END__;
1.41 ng 20213:
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