Annotation of loncom/interface/loncommon.pm, revision 1.1447
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1447 ! raeburn 4: # $Id: loncommon.pm,v 1.1446 2025/01/25 17:51:52 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.1383 raeburn 64: use Apache::lonnavmaps();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1409 raeburn 74: use LONCAPA::ltiutils;
1.1280 raeburn 75: use LONCAPA::LWPReq;
1.1395 raeburn 76: use LONCAPA::map();
1.1328 raeburn 77: use HTTP::Request;
1.657 raeburn 78: use DateTime::TimeZone;
1.1241 raeburn 79: use DateTime::Locale;
1.1220 raeburn 80: use Encode();
1.1091 foxr 81: use Text::Aspell;
1.1094 raeburn 82: use Authen::Captcha;
83: use Captcha::reCAPTCHA;
1.1234 raeburn 84: use JSON::DWIW;
1.1174 raeburn 85: use Crypt::DES;
86: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 87: use MIME::Lite;
88: use MIME::Types;
1.1292 raeburn 89: use File::Copy();
1.1300 raeburn 90: use File::Path();
1.1309 raeburn 91: use String::CRC32();
92: use Short::URL();
1.117 www 93:
1.517 raeburn 94: # ---------------------------------------------- Designs
95: use vars qw(%defaultdesign);
96:
1.22 www 97: my $readit;
98:
1.517 raeburn 99:
1.157 matthew 100: ##
101: ## Global Variables
102: ##
1.46 matthew 103:
1.643 foxr 104:
105: # ----------------------------------------------- SSI with retries:
106: #
107:
108: =pod
109:
1.648 raeburn 110: =head1 Server Side include with retries:
1.643 foxr 111:
112: =over 4
113:
1.648 raeburn 114: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 115:
116: Performs an ssi with some number of retries. Retries continue either
117: until the result is ok or until the retry count supplied by the
118: caller is exhausted.
119:
120: Inputs:
1.648 raeburn 121:
122: =over 4
123:
1.643 foxr 124: resource - Identifies the resource to insert.
1.648 raeburn 125:
1.643 foxr 126: retries - Count of the number of retries allowed.
1.648 raeburn 127:
1.643 foxr 128: form - Hash that identifies the rendering options.
129:
1.648 raeburn 130: =back
131:
132: Returns:
133:
134: =over 4
135:
1.643 foxr 136: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 137:
1.643 foxr 138: response - The response from the last attempt (which may or may not have been successful.
139:
1.648 raeburn 140: =back
141:
142: =back
143:
1.643 foxr 144: =cut
145:
146: sub ssi_with_retries {
147: my ($resource, $retries, %form) = @_;
148:
149:
150: my $ok = 0; # True if we got a good response.
151: my $content;
152: my $response;
153:
154: # Try to get the ssi done. within the retries count:
155:
156: do {
157: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
158: $ok = $response->is_success;
1.650 www 159: if (!$ok) {
160: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
161: }
1.643 foxr 162: $retries--;
163: } while (!$ok && ($retries > 0));
164:
165: if (!$ok) {
166: $content = ''; # On error return an empty content.
167: }
168: return ($content, $response);
169:
170: }
171:
172:
173:
1.20 www 174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 175: my %language;
1.124 www 176: my %supported_language;
1.1088 foxr 177: my %supported_codes;
1.1048 foxr 178: my %latex_language; # For choosing hyphenation in <transl..>
179: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 180: my %cprtag;
1.192 taceyjo1 181: my %scprtag;
1.351 www 182: my %fe; my %fd; my %fm;
1.41 ng 183: my %category_extensions;
1.12 harris41 184:
1.46 matthew 185: # ---------------------------------------------- Thesaurus variables
1.144 matthew 186: #
187: # %Keywords:
188: # A hash used by &keyword to determine if a word is considered a keyword.
189: # $thesaurus_db_file
190: # Scalar containing the full path to the thesaurus database.
1.46 matthew 191:
192: my %Keywords;
193: my $thesaurus_db_file;
194:
1.144 matthew 195: #
196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
197: # thesaurus.tab, and filecategories.tab.
198: #
1.18 www 199: BEGIN {
1.46 matthew 200: # Variable initialization
201: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
202: #
1.22 www 203: unless ($readit) {
1.12 harris41 204: # ------------------------------------------------------------------- languages
205: {
1.158 raeburn 206: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
207: '/language.tab';
1.1317 raeburn 208: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
1.1088 foxr 212: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 213: $language{$key}=$val.' - '.$enc;
214: if ($sup) {
215: $supported_language{$key}=$sup;
1.1088 foxr 216: $supported_codes{$key} = $code;
1.158 raeburn 217: }
1.1048 foxr 218: if ($latex) {
219: $latex_language_bykey{$key} = $latex;
1.1088 foxr 220: $latex_language{$code} = $latex;
1.1048 foxr 221: }
1.158 raeburn 222: }
223: close($fh);
224: }
1.12 harris41 225: }
226: # ------------------------------------------------------------------ copyrights
227: {
1.158 raeburn 228: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/copyright.tab';
1.1317 raeburn 230: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line=~/^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 235: $cprtag{$key}=$val;
236: }
237: close($fh);
238: }
1.12 harris41 239: }
1.351 www 240: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 241: {
242: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
243: '/source_copyright.tab';
1.1317 raeburn 244: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 249: $scprtag{$key}=$val;
250: }
251: close($fh);
252: }
253: }
1.63 www 254:
1.517 raeburn 255: # -------------------------------------------------------------- default domain designs
1.63 www 256: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 257: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 258: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($key,$val)=(split(/\=/,$line));
263: if ($val) { $defaultdesign{$key}=$val; }
264: }
265: close($fh);
1.63 www 266: }
267:
1.15 harris41 268: # ------------------------------------------------------------- file categories
269: {
1.158 raeburn 270: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filecategories.tab';
1.1317 raeburn 272: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 277: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 278: }
279: close($fh);
280: }
281:
1.15 harris41 282: }
1.12 harris41 283: # ------------------------------------------------------------------ file types
284: {
1.158 raeburn 285: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
286: '/filetypes.tab';
1.1317 raeburn 287: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 288: while (my $line = <$fh>) {
289: next if ($line =~ /^\#/);
290: chomp($line);
291: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 292: if ($descr ne '') {
293: $fe{$ending}=lc($emb);
294: $fd{$ending}=$descr;
1.351 www 295: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 296: }
297: }
298: close($fh);
299: }
1.12 harris41 300: }
1.22 www 301: &Apache::lonnet::logthis(
1.705 tempelho 302: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 303: $readit=1;
1.46 matthew 304: } # end of unless($readit)
1.32 matthew 305:
306: }
1.112 bowersj2 307:
1.42 matthew 308: ###############################################################
309: ## HTML and Javascript Helper Functions ##
310: ###############################################################
311:
312: =pod
313:
1.112 bowersj2 314: =head1 HTML and Javascript Functions
1.42 matthew 315:
1.112 bowersj2 316: =over 4
317:
1.648 raeburn 318: =item * &browser_and_searcher_javascript()
1.112 bowersj2 319:
320: X<browsing, javascript>X<searching, javascript>Returns a string
321: containing javascript with two functions, C<openbrowser> and
322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
323: tags.
1.42 matthew 324:
1.648 raeburn 325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 326:
327: inputs: formname, elementname, only, omit
328:
329: formname and elementname indicate the name of the html form and name of
330: the element that the results of the browsing selection are to be placed in.
331:
332: Specifying 'only' will restrict the browser to displaying only files
1.185 www 333: with the given extension. Can be a comma separated list.
1.42 matthew 334:
335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 336: with the given extension. Can be a comma separated list.
1.42 matthew 337:
1.648 raeburn 338: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 339:
340: Inputs: formname, elementname
341:
342: formname and elementname specify the name of the html form and the name
343: of the element the selection from the search results will be placed in.
1.542 raeburn 344:
1.42 matthew 345: =cut
346:
347: sub browser_and_searcher_javascript {
1.199 albertel 348: my ($mode)=@_;
349: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 350: my $resurl=&escape_single(&lastresurl());
1.42 matthew 351: return <<END;
1.219 albertel 352: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 353: var editbrowser = null;
1.135 albertel 354: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 355: var url = '$resurl/?';
1.42 matthew 356: if (editbrowser == null) {
357: url += 'launch=1&';
358: }
359: url += 'catalogmode=interactive&';
1.199 albertel 360: url += 'mode=$mode&';
1.611 albertel 361: url += 'inhibitmenu=yes&';
1.42 matthew 362: url += 'form=' + formname + '&';
363: if (only != null) {
364: url += 'only=' + only + '&';
1.217 albertel 365: } else {
366: url += 'only=&';
367: }
1.42 matthew 368: if (omit != null) {
369: url += 'omit=' + omit + '&';
1.217 albertel 370: } else {
371: url += 'omit=&';
372: }
1.135 albertel 373: if (titleelement != null) {
374: url += 'titleelement=' + titleelement + '&';
1.217 albertel 375: } else {
376: url += 'titleelement=&';
377: }
1.42 matthew 378: url += 'element=' + elementname + '';
379: var title = 'Browser';
1.435 albertel 380: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 381: options += ',width=700,height=600';
382: editbrowser = open(url,title,options,'1');
383: editbrowser.focus();
384: }
385: var editsearcher;
1.135 albertel 386: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 387: var url = '/adm/searchcat?';
388: if (editsearcher == null) {
389: url += 'launch=1&';
390: }
391: url += 'catalogmode=interactive&';
1.199 albertel 392: url += 'mode=$mode&';
1.42 matthew 393: url += 'form=' + formname + '&';
1.135 albertel 394: if (titleelement != null) {
395: url += 'titleelement=' + titleelement + '&';
1.217 albertel 396: } else {
397: url += 'titleelement=&';
398: }
1.42 matthew 399: url += 'element=' + elementname + '';
400: var title = 'Search';
1.435 albertel 401: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 402: options += ',width=700,height=600';
403: editsearcher = open(url,title,options,'1');
404: editsearcher.focus();
405: }
1.219 albertel 406: // END LON-CAPA Internal -->
1.42 matthew 407: END
1.170 www 408: }
409:
410: sub lastresurl {
1.258 albertel 411: if ($env{'environment.lastresurl'}) {
412: return $env{'environment.lastresurl'}
1.170 www 413: } else {
414: return '/res';
415: }
416: }
417:
418: sub storeresurl {
419: my $resurl=&Apache::lonnet::clutter(shift);
420: unless ($resurl=~/^\/res/) { return 0; }
421: $resurl=~s/\/$//;
422: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 423: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 424: return 1;
1.42 matthew 425: }
426:
1.74 www 427: sub studentbrowser_javascript {
1.111 www 428: unless (
1.258 albertel 429: (($env{'request.course.id'}) &&
1.302 albertel 430: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
431: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
432: '/'.$env{'request.course.sec'})
433: ))
1.258 albertel 434: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 435: ) { return ''; }
1.74 www 436: return (<<'ENDSTDBRW');
1.776 bisitz 437: <script type="text/javascript" language="Javascript">
1.824 bisitz 438: // <![CDATA[
1.74 www 439: var stdeditbrowser;
1.1413 raeburn 440: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74 www 441: var url = '/adm/pickstudent?';
442: var filter;
1.558 albertel 443: if (!ignorefilter) {
444: eval('filter=document.'+formname+'.'+uname+'.value;');
445: }
1.74 www 446: if (filter != null) {
447: if (filter != '') {
448: url += 'filter='+filter+'&';
449: }
450: }
451: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 452: '&udomelement='+udom+
453: '&clicker='+clicker;
1.111 www 454: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 455: if (courseadv == 'condition') {
456: if (document.getElementById('courseadv')) {
457: courseadv = document.getElementById('courseadv').value;
458: }
459: }
460: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413 raeburn 461: if (uident !== '') { url+="&identelement="+uident; }
1.102 www 462: var title = 'Student_Browser';
1.74 www 463: var options = 'scrollbars=1,resizable=1,menubar=0';
464: options += ',width=700,height=600';
465: stdeditbrowser = open(url,title,options,'1');
466: stdeditbrowser.focus();
467: }
1.824 bisitz 468: // ]]>
1.74 www 469: </script>
470: ENDSTDBRW
471: }
1.42 matthew 472:
1.1003 www 473: sub resourcebrowser_javascript {
474: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 475: return (<<'ENDRESBRW');
1.1003 www 476: <script type="text/javascript" language="Javascript">
477: // <![CDATA[
478: var reseditbrowser;
1.1004 www 479: function openresbrowser(formname,reslink) {
1.1005 www 480: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 481: var title = 'Resource_Browser';
482: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 483: options += ',width=700,height=500';
1.1004 www 484: reseditbrowser = open(url,title,options,'1');
485: reseditbrowser.focus();
1.1003 www 486: }
487: // ]]>
488: </script>
1.1004 www 489: ENDRESBRW
1.1003 www 490: }
491:
1.74 www 492: sub selectstudent_link {
1.1413 raeburn 493: my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999 www 494: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
495: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
496: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 497: if ($env{'request.course.id'}) {
1.302 albertel 498: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
499: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
500: '/'.$env{'request.course.sec'})) {
1.111 www 501: return '';
502: }
1.999 www 503: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 504: if ($courseadv eq 'only') {
505: $callargs .= ",'',1,'$courseadv'";
506: } elsif ($courseadv eq 'none') {
507: $callargs .= ",'','','$courseadv'";
508: } elsif ($courseadv eq 'condition') {
509: $callargs .= ",'','','$courseadv'";
1.1413 raeburn 510: } elsif ($identelem ne '') {
511: $callargs .= ",'','',''";
512: }
513: if ($identelem ne '') {
514: $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793 raeburn 515: }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openstdbrowser('.$callargs.');">'.
518: &mt('Select User').'</a></span>';
1.74 www 519: }
1.258 albertel 520: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 521: $callargs .= ",'',1";
1.793 raeburn 522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openstdbrowser('.$callargs.');">'.
524: &mt('Select User').'</a></span>';
1.111 www 525: }
526: return '';
1.91 www 527: }
528:
1.1004 www 529: sub selectresource_link {
530: my ($form,$reslink,$arg)=@_;
531:
532: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
533: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
534: unless ($env{'request.course.id'}) { return $arg; }
535: return '<span class="LC_nobreak">'.
536: '<a href="javascript:openresbrowser('.$callargs.');">'.
537: $arg.'</a></span>';
538: }
539:
540:
541:
1.653 raeburn 542: sub authorbrowser_javascript {
543: return <<"ENDAUTHORBRW";
1.776 bisitz 544: <script type="text/javascript" language="JavaScript">
1.824 bisitz 545: // <![CDATA[
1.653 raeburn 546: var stdeditbrowser;
547:
548: function openauthorbrowser(formname,udom) {
549: var url = '/adm/pickauthor?';
550: url += 'form='+formname+'&roledom='+udom;
551: var title = 'Author_Browser';
552: var options = 'scrollbars=1,resizable=1,menubar=0';
553: options += ',width=700,height=600';
554: stdeditbrowser = open(url,title,options,'1');
555: stdeditbrowser.focus();
556: }
557:
1.824 bisitz 558: // ]]>
1.653 raeburn 559: </script>
560: ENDAUTHORBRW
561: }
562:
1.91 www 563: sub coursebrowser_javascript {
1.1116 raeburn 564: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 565: $credits_element,$instcode) = @_;
1.932 raeburn 566: my $wintitle = 'Course_Browser';
1.931 raeburn 567: if ($crstype eq 'Community') {
1.932 raeburn 568: $wintitle = 'Community_Browser';
1.909 raeburn 569: }
1.876 raeburn 570: my $id_functions = &javascript_index_functions();
571: my $output = '
1.776 bisitz 572: <script type="text/javascript" language="JavaScript">
1.824 bisitz 573: // <![CDATA[
1.468 raeburn 574: var stdeditbrowser;'."\n";
1.876 raeburn 575:
576: $output .= <<"ENDSTDBRW";
1.909 raeburn 577: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 578: var url = '/adm/pickcourse?';
1.895 raeburn 579: var formid = getFormIdByName(formname);
1.876 raeburn 580: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 581: if (domainfilter != null) {
582: if (domainfilter != '') {
583: url += 'domainfilter='+domainfilter+'&';
584: }
585: }
1.91 www 586: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 587: '&cdomelement='+udom+
588: '&cnameelement='+desc;
1.468 raeburn 589: if (extra_element !=null && extra_element != '') {
1.594 raeburn 590: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 591: url += '&roleelement='+extra_element;
592: if (domainfilter == null || domainfilter == '') {
593: url += '&domainfilter='+extra_element;
594: }
1.234 raeburn 595: }
1.468 raeburn 596: else {
597: if (formname == 'portform') {
598: url += '&setroles='+extra_element;
1.800 raeburn 599: } else {
600: if (formname == 'rules') {
601: url += '&fixeddom='+extra_element;
602: }
1.468 raeburn 603: }
604: }
1.230 raeburn 605: }
1.909 raeburn 606: if (type != null && type != '') {
607: url += '&type='+type;
608: }
609: if (type_elem != null && type_elem != '') {
610: url += '&typeelement='+type_elem;
611: }
1.872 raeburn 612: if (formname == 'ccrs') {
613: var ownername = document.forms[formid].ccuname.value;
614: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 615: url += '&cloner='+ownername+':'+ownerdom;
616: if (type == 'Course') {
617: url += '&crscode='+document.forms[formid].crscode.value;
618: }
1.1221 raeburn 619: }
620: if (formname == 'requestcrs') {
621: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 622: }
1.293 raeburn 623: if (multflag !=null && multflag != '') {
624: url += '&multiple='+multflag;
625: }
1.909 raeburn 626: var title = '$wintitle';
1.91 www 627: var options = 'scrollbars=1,resizable=1,menubar=0';
628: options += ',width=700,height=600';
629: stdeditbrowser = open(url,title,options,'1');
630: stdeditbrowser.focus();
631: }
1.876 raeburn 632: $id_functions
633: ENDSTDBRW
1.1116 raeburn 634: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
635: $output .= &setsec_javascript($sec_element,$formname,$role_element,
636: $credits_element);
1.876 raeburn 637: }
638: $output .= '
639: // ]]>
640: </script>';
641: return $output;
642: }
643:
644: sub javascript_index_functions {
645: return <<"ENDJS";
646:
647: function getFormIdByName(formname) {
648: for (var i=0;i<document.forms.length;i++) {
649: if (document.forms[i].name == formname) {
650: return i;
651: }
652: }
653: return -1;
654: }
655:
656: function getIndexByName(formid,item) {
657: for (var i=0;i<document.forms[formid].elements.length;i++) {
658: if (document.forms[formid].elements[i].name == item) {
659: return i;
660: }
661: }
662: return -1;
663: }
1.468 raeburn 664:
1.876 raeburn 665: function getDomainFromSelectbox(formname,udom) {
666: var userdom;
667: var formid = getFormIdByName(formname);
668: if (formid > -1) {
669: var domid = getIndexByName(formid,udom);
670: if (domid > -1) {
671: if (document.forms[formid].elements[domid].type == 'select-one') {
672: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
673: }
674: if (document.forms[formid].elements[domid].type == 'hidden') {
675: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 676: }
677: }
678: }
1.876 raeburn 679: return userdom;
680: }
681:
682: ENDJS
1.468 raeburn 683:
1.876 raeburn 684: }
685:
1.1017 raeburn 686: sub javascript_array_indexof {
1.1018 raeburn 687: return <<ENDJS;
1.1017 raeburn 688: <script type="text/javascript" language="JavaScript">
689: // <![CDATA[
690:
691: if (!Array.prototype.indexOf) {
692: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
693: "use strict";
694: if (this === void 0 || this === null) {
695: throw new TypeError();
696: }
697: var t = Object(this);
698: var len = t.length >>> 0;
699: if (len === 0) {
700: return -1;
701: }
702: var n = 0;
703: if (arguments.length > 0) {
704: n = Number(arguments[1]);
1.1088 foxr 705: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 706: n = 0;
707: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
708: n = (n > 0 || -1) * Math.floor(Math.abs(n));
709: }
710: }
711: if (n >= len) {
712: return -1;
713: }
714: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
715: for (; k < len; k++) {
716: if (k in t && t[k] === searchElement) {
717: return k;
718: }
719: }
720: return -1;
721: }
722: }
723:
724: // ]]>
725: </script>
726:
727: ENDJS
728:
729: }
730:
1.876 raeburn 731: sub userbrowser_javascript {
732: my $id_functions = &javascript_index_functions();
733: return <<"ENDUSERBRW";
734:
1.888 raeburn 735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 736: var url = '/adm/pickuser?';
737: var userdom = getDomainFromSelectbox(formname,udom);
738: if (userdom != null) {
739: if (userdom != '') {
740: url += 'srchdom='+userdom+'&';
741: }
742: }
743: url += 'form=' + formname + '&unameelement='+uname+
744: '&udomelement='+udom+
745: '&ulastelement='+ulast+
746: '&ufirstelement='+ufirst+
747: '&uemailelement='+uemail+
1.881 raeburn 748: '&hideudomelement='+hideudom+
749: '&coursedom='+crsdom;
1.888 raeburn 750: if ((caller != null) && (caller != undefined)) {
751: url += '&caller='+caller;
752: }
1.876 raeburn 753: var title = 'User_Browser';
754: var options = 'scrollbars=1,resizable=1,menubar=0';
755: options += ',width=700,height=600';
756: var stdeditbrowser = open(url,title,options,'1');
757: stdeditbrowser.focus();
758: }
759:
1.888 raeburn 760: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 761: var formid = getFormIdByName(formname);
762: if (formid > -1) {
1.888 raeburn 763: var unameid = getIndexByName(formid,uname);
1.876 raeburn 764: var domid = getIndexByName(formid,udom);
765: var hidedomid = getIndexByName(formid,origdom);
766: if (hidedomid > -1) {
767: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 768: var unameval = document.forms[formid].elements[unameid].value;
769: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
770: if (domid > -1) {
771: var slct = document.forms[formid].elements[domid];
772: if (slct.type == 'select-one') {
773: var i;
774: for (i=0;i<slct.length;i++) {
775: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
776: }
777: }
778: if (slct.type == 'hidden') {
779: slct.value = fixeddom;
1.876 raeburn 780: }
781: }
1.468 raeburn 782: }
783: }
784: }
1.876 raeburn 785: return;
786: }
787:
788: $id_functions
789: ENDUSERBRW
1.468 raeburn 790: }
791:
792: sub setsec_javascript {
1.1116 raeburn 793: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 794: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
795: $communityrolestr);
796: if ($role_element ne '') {
797: my @allroles = ('st','ta','ep','in','ad');
798: foreach my $crstype ('Course','Community') {
799: if ($crstype eq 'Community') {
800: foreach my $role (@allroles) {
801: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
802: }
803: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
804: } else {
805: foreach my $role (@allroles) {
806: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
807: }
808: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
809: }
810: }
811: $rolestr = '"'.join('","',@allroles).'"';
812: $courserolestr = '"'.join('","',@courserolenames).'"';
813: $communityrolestr = '"'.join('","',@communityrolenames).'"';
814: }
1.468 raeburn 815: my $setsections = qq|
816: function setSect(sectionlist) {
1.629 raeburn 817: var sectionsArray = new Array();
818: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
819: sectionsArray = sectionlist.split(",");
820: }
1.468 raeburn 821: var numSections = sectionsArray.length;
822: document.$formname.$sec_element.length = 0;
823: if (numSections == 0) {
824: document.$formname.$sec_element.multiple=false;
825: document.$formname.$sec_element.size=1;
826: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
827: } else {
828: if (numSections == 1) {
829: document.$formname.$sec_element.multiple=false;
830: document.$formname.$sec_element.size=1;
831: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
832: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
833: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
834: } else {
835: for (var i=0; i<numSections; i++) {
836: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
837: }
838: document.$formname.$sec_element.multiple=true
839: if (numSections < 3) {
840: document.$formname.$sec_element.size=numSections;
841: } else {
842: document.$formname.$sec_element.size=3;
843: }
844: document.$formname.$sec_element.options[0].selected = false
845: }
846: }
1.91 www 847: }
1.905 raeburn 848:
849: function setRole(crstype) {
1.468 raeburn 850: |;
1.905 raeburn 851: if ($role_element eq '') {
852: $setsections .= ' return;
853: }
854: ';
855: } else {
856: $setsections .= qq|
857: var elementLength = document.$formname.$role_element.length;
858: var allroles = Array($rolestr);
859: var courserolenames = Array($courserolestr);
860: var communityrolenames = Array($communityrolestr);
861: if (elementLength != undefined) {
862: if (document.$formname.$role_element.options[5].value == 'cc') {
863: if (crstype == 'Course') {
864: return;
865: } else {
866: allroles[5] = 'co';
867: for (var i=0; i<6; i++) {
868: document.$formname.$role_element.options[i].value = allroles[i];
869: document.$formname.$role_element.options[i].text = communityrolenames[i];
870: }
871: }
872: } else {
873: if (crstype == 'Community') {
874: return;
875: } else {
876: allroles[5] = 'cc';
877: for (var i=0; i<6; i++) {
878: document.$formname.$role_element.options[i].value = allroles[i];
879: document.$formname.$role_element.options[i].text = courserolenames[i];
880: }
881: }
882: }
883: }
884: return;
885: }
886: |;
887: }
1.1116 raeburn 888: if ($credits_element) {
889: $setsections .= qq|
890: function setCredits(defaultcredits) {
891: document.$formname.$credits_element.value = defaultcredits;
892: return;
893: }
894: |;
895: }
1.468 raeburn 896: return $setsections;
897: }
898:
1.91 www 899: sub selectcourse_link {
1.909 raeburn 900: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
901: $typeelement) = @_;
902: my $type = $selecttype;
1.871 raeburn 903: my $linktext = &mt('Select Course');
904: if ($selecttype eq 'Community') {
1.909 raeburn 905: $linktext = &mt('Select Community');
1.1239 raeburn 906: } elsif ($selecttype eq 'Placement') {
907: $linktext = &mt('Select Placement Test');
1.906 raeburn 908: } elsif ($selecttype eq 'Course/Community') {
909: $linktext = &mt('Select Course/Community');
1.909 raeburn 910: $type = '';
1.1019 raeburn 911: } elsif ($selecttype eq 'Select') {
912: $linktext = &mt('Select');
913: $type = '';
1.871 raeburn 914: }
1.787 bisitz 915: return '<span class="LC_nobreak">'
916: ."<a href='"
917: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
918: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 919: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 920: ."'>".$linktext.'</a>'
1.787 bisitz 921: .'</span>';
1.74 www 922: }
1.42 matthew 923:
1.653 raeburn 924: sub selectauthor_link {
925: my ($form,$udom)=@_;
926: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
927: &mt('Select Author').'</a>';
928: }
929:
1.876 raeburn 930: sub selectuser_link {
1.881 raeburn 931: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 932: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 933: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 934: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 935: ');">'.$linktext.'</a>';
1.876 raeburn 936: }
937:
1.273 raeburn 938: sub check_uncheck_jscript {
939: my $jscript = <<"ENDSCRT";
940: function checkAll(field) {
941: if (field.length > 0) {
942: for (i = 0; i < field.length; i++) {
1.1093 raeburn 943: if (!field[i].disabled) {
944: field[i].checked = true;
945: }
1.273 raeburn 946: }
947: } else {
1.1093 raeburn 948: if (!field.disabled) {
949: field.checked = true;
950: }
1.273 raeburn 951: }
952: }
953:
954: function uncheckAll(field) {
955: if (field.length > 0) {
956: for (i = 0; i < field.length; i++) {
957: field[i].checked = false ;
1.543 albertel 958: }
959: } else {
1.273 raeburn 960: field.checked = false ;
961: }
962: }
963: ENDSCRT
964: return $jscript;
965: }
966:
1.656 www 967: sub select_timezone {
1.1387 raeburn 968: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
969: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 970: if ($includeempty) {
971: $output .= '<option value=""';
972: if (($selected eq '') || ($selected eq 'local')) {
973: $output .= ' selected="selected" ';
974: }
975: $output .= '> </option>';
976: }
1.657 raeburn 977: my @timezones = DateTime::TimeZone->all_names;
978: foreach my $tzone (@timezones) {
979: $output.= '<option value="'.$tzone.'"';
980: if ($tzone eq $selected) {
981: $output.=' selected="selected"';
982: }
983: $output.=">$tzone</option>\n";
1.656 www 984: }
985: $output.="</select>";
986: return $output;
987: }
1.273 raeburn 988:
1.687 raeburn 989: sub select_datelocale {
1.1256 raeburn 990: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
991: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 992: if ($includeempty) {
993: $output .= '<option value=""';
994: if ($selected eq '') {
995: $output .= ' selected="selected" ';
996: }
997: $output .= '> </option>';
998: }
1.1241 raeburn 999: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 1000: my (@possibles,%locale_names);
1.1241 raeburn 1001: my @locales = DateTime::Locale->ids();
1002: foreach my $id (@locales) {
1003: if ($id ne '') {
1004: my ($en_terr,$native_terr);
1005: my $loc = DateTime::Locale->load($id);
1006: if (ref($loc)) {
1007: $en_terr = $loc->name();
1008: $native_terr = $loc->native_name();
1.687 raeburn 1009: if (grep(/^en$/,@languages) || !@languages) {
1010: if ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: } elsif ($native_terr ne '') {
1013: $locale_names{$id} = $native_terr;
1014: }
1015: } else {
1016: if ($native_terr ne '') {
1017: $locale_names{$id} = $native_terr.' ';
1018: } elsif ($en_terr ne '') {
1019: $locale_names{$id} = '('.$en_terr.')';
1020: }
1021: }
1.1220 raeburn 1022: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1023: push(@possibles,$id);
1024: }
1.687 raeburn 1025: }
1026: }
1027: foreach my $item (sort(@possibles)) {
1028: $output.= '<option value="'.$item.'"';
1029: if ($item eq $selected) {
1030: $output.=' selected="selected"';
1031: }
1032: $output.=">$item";
1033: if ($locale_names{$item} ne '') {
1.1220 raeburn 1034: $output.=' '.$locale_names{$item};
1.687 raeburn 1035: }
1036: $output.="</option>\n";
1037: }
1038: $output.="</select>";
1039: return $output;
1040: }
1041:
1.792 raeburn 1042: sub select_language {
1.1256 raeburn 1043: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1044: my %langchoices;
1045: if ($includeempty) {
1.1117 raeburn 1046: %langchoices = ('' => 'No language preference');
1.792 raeburn 1047: }
1048: foreach my $id (&languageids()) {
1049: my $code = &supportedlanguagecode($id);
1050: if ($code) {
1051: $langchoices{$code} = &plainlanguagedescription($id);
1052: }
1053: }
1.1117 raeburn 1054: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1055: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1056: }
1057:
1.42 matthew 1058: =pod
1.36 matthew 1059:
1.1088 foxr 1060:
1061: =item * &list_languages()
1062:
1063: Returns an array reference that is suitable for use in language prompters.
1064: Each array element is itself a two element array. The first element
1065: is the language code. The second element a descsriptiuon of the
1066: language itself. This is suitable for use in e.g.
1067: &Apache::edit::select_arg (once dereferenced that is).
1068:
1069: =cut
1070:
1071: sub list_languages {
1072: my @lang_choices;
1073:
1074: foreach my $id (&languageids()) {
1075: my $code = &supportedlanguagecode($id);
1076: if ($code) {
1077: my $selector = $supported_codes{$id};
1078: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1079: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1080: }
1081: }
1082: return \@lang_choices;
1083: }
1084:
1085: =pod
1086:
1.648 raeburn 1087: =item * &linked_select_forms(...)
1.36 matthew 1088:
1089: linked_select_forms returns a string containing a <script></script> block
1090: and html for two <select> menus. The select menus will be linked in that
1091: changing the value of the first menu will result in new values being placed
1092: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1093: order unless a defined order is provided.
1.36 matthew 1094:
1095: linked_select_forms takes the following ordered inputs:
1096:
1097: =over 4
1098:
1.112 bowersj2 1099: =item * $formname, the name of the <form> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1102:
1.112 bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36 matthew 1104:
1.112 bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1106:
1.112 bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1108:
1.112 bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1110:
1.609 raeburn 1111: =item * $menuorder, the order of values in the first menu
1112:
1.1115 raeburn 1113: =item * $onchangefirst, additional javascript call to execute for an onchange
1114: event for the first <select> tag
1115:
1116: =item * $onchangesecond, additional javascript call to execute for an onchange
1117: event for the second <select> tag
1118:
1.1245 raeburn 1119: =item * $suffix, to differentiate separate uses of select2data javascript
1120: objects in a page.
1121:
1.41 ng 1122: =back
1123:
1.36 matthew 1124: Below is an example of such a hash. Only the 'text', 'default', and
1125: 'select2' keys must appear as stated. keys(%menu) are the possible
1126: values for the first select menu. The text that coincides with the
1.41 ng 1127: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1128: and text for the second menu are given in the hash pointed to by
1129: $menu{$choice1}->{'select2'}.
1130:
1.112 bowersj2 1131: my %menu = ( A1 => { text =>"Choice A1" ,
1132: default => "B3",
1133: select2 => {
1134: B1 => "Choice B1",
1135: B2 => "Choice B2",
1136: B3 => "Choice B3",
1137: B4 => "Choice B4"
1.609 raeburn 1138: },
1139: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1140: },
1141: A2 => { text =>"Choice A2" ,
1142: default => "C2",
1143: select2 => {
1144: C1 => "Choice C1",
1145: C2 => "Choice C2",
1146: C3 => "Choice C3"
1.609 raeburn 1147: },
1148: order => ['C2','C1','C3'],
1.112 bowersj2 1149: },
1150: A3 => { text =>"Choice A3" ,
1151: default => "D6",
1152: select2 => {
1153: D1 => "Choice D1",
1154: D2 => "Choice D2",
1155: D3 => "Choice D3",
1156: D4 => "Choice D4",
1157: D5 => "Choice D5",
1158: D6 => "Choice D6",
1159: D7 => "Choice D7"
1.609 raeburn 1160: },
1161: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1162: }
1163: );
1.36 matthew 1164:
1165: =cut
1166:
1167: sub linked_select_forms {
1168: my ($formname,
1169: $middletext,
1170: $firstdefault,
1171: $firstselectname,
1172: $secondselectname,
1.609 raeburn 1173: $hashref,
1174: $menuorder,
1.1115 raeburn 1175: $onchangefirst,
1.1245 raeburn 1176: $onchangesecond,
1177: $suffix
1.36 matthew 1178: ) = @_;
1179: my $second = "document.$formname.$secondselectname";
1180: my $first = "document.$formname.$firstselectname";
1181: # output the javascript to do the changing
1182: my $result = '';
1.776 bisitz 1183: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1184: $result.="// <![CDATA[\n";
1.1245 raeburn 1185: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1186: $" = '","';
1187: my $debug = '';
1188: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1189: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1190: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1191: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1192: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1193: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1194: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1195: @s2values = @{$hashref->{$s1}->{'order'}};
1196: }
1.36 matthew 1197: $result.="\"@s2values\");\n";
1.1245 raeburn 1198: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1199: my @s2texts;
1200: foreach my $value (@s2values) {
1.1263 raeburn 1201: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1202: }
1203: $result.="\"@s2texts\");\n";
1204: }
1205: $"=' ';
1206: $result.= <<"END";
1207:
1.1245 raeburn 1208: function select1${suffix}_changed() {
1.36 matthew 1209: // Determine new choice
1.1245 raeburn 1210: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1211: // update select2
1.1245 raeburn 1212: var values = select2data${suffix}[newvalue].values;
1213: var texts = select2data${suffix}[newvalue].texts;
1214: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1215: var i;
1216: // out with the old
1.1245 raeburn 1217: $second.options.length = 0;
1218: // in with the new
1.36 matthew 1219: for (i=0;i<values.length; i++) {
1220: $second.options[i] = new Option(values[i]);
1.143 matthew 1221: $second.options[i].value = values[i];
1.36 matthew 1222: $second.options[i].text = texts[i];
1223: if (values[i] == select2def) {
1224: $second.options[i].selected = true;
1225: }
1226: }
1227: }
1.824 bisitz 1228: // ]]>
1.36 matthew 1229: </script>
1230: END
1231: # output the initial values for the selection lists
1.1245 raeburn 1232: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1233: my @order = sort(keys(%{$hashref}));
1234: if (ref($menuorder) eq 'ARRAY') {
1235: @order = @{$menuorder};
1236: }
1237: foreach my $value (@order) {
1.36 matthew 1238: $result.=" <option value=\"$value\" ";
1.253 albertel 1239: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1240: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1241: }
1242: $result .= "</select>\n";
1.1400 raeburn 1243: my %select2;
1244: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1245: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1246: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1247: }
1248: }
1.36 matthew 1249: $result .= $middletext;
1.1115 raeburn 1250: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1251: if ($onchangesecond) {
1252: $result .= ' onchange="'.$onchangesecond.'"';
1253: }
1254: $result .= ">\n";
1.36 matthew 1255: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1256:
1257: my @secondorder = sort(keys(%select2));
1258: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1259: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1260: }
1261: foreach my $value (@secondorder) {
1.36 matthew 1262: $result.=" <option value=\"$value\" ";
1.253 albertel 1263: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1264: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1265: }
1266: $result .= "</select>\n";
1267: # return $debug;
1268: return $result;
1269: } # end of sub linked_select_forms {
1270:
1.45 matthew 1271: =pod
1.44 bowersj2 1272:
1.1381 raeburn 1273: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1274:
1.112 bowersj2 1275: Returns a string corresponding to an HTML link to the given help
1276: $topic, where $topic corresponds to the name of a .tex file in
1277: /home/httpd/html/adm/help/tex, with underscores replaced by
1278: spaces.
1279:
1280: $text will optionally be linked to the same topic, allowing you to
1281: link text in addition to the graphic. If you do not want to link
1282: text, but wish to specify one of the later parameters, pass an
1283: empty string.
1284:
1285: $stayOnPage is a value that will be interpreted as a boolean. If true,
1286: the link will not open a new window. If false, the link will open
1287: a new window using Javascript. (Default is false.)
1288:
1289: $width and $height are optional numerical parameters that will
1290: override the width and height of the popped up window, which may
1.973 raeburn 1291: be useful for certain help topics with big pictures included.
1292:
1293: $imgid is the id of the img tag used for the help icon. This may be
1294: used in a javascript call to switch the image src. See
1295: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1296:
1.1381 raeburn 1297: $links_target will optionally be set to a target (_top, _parent or _self).
1298:
1.44 bowersj2 1299: =cut
1300:
1301: sub help_open_topic {
1.1381 raeburn 1302: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1303: $text = "" if (not defined $text);
1.44 bowersj2 1304: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1305: $width = 500 if (not defined $width);
1.44 bowersj2 1306: $height = 400 if (not defined $height);
1307: my $filename = $topic;
1308: $filename =~ s/ /_/g;
1309:
1.48 bowersj2 1310: my $template = "";
1311: my $link;
1.572 banghart 1312:
1.159 www 1313: $topic=~s/\W/\_/g;
1.44 bowersj2 1314:
1.572 banghart 1315: if (!$stayOnPage) {
1.1033 www 1316: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1317: } elsif ($stayOnPage eq 'popup') {
1318: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1319: } else {
1.48 bowersj2 1320: $link = "/adm/help/${filename}.hlp";
1321: }
1322:
1323: # Add the text
1.1314 raeburn 1324: my $target = ' target="_top"';
1.1381 raeburn 1325: if ($links_target) {
1326: $target = ' target="'.$links_target.'"';
1327: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1328: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1329: $target = '';
1.1378 raeburn 1330: }
1.1380 raeburn 1331: if ($text ne "") {
1.763 bisitz 1332: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1333: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1334: .$text.'</a>';
1.48 bowersj2 1335: }
1336:
1.763 bisitz 1337: # (Always) Add the graphic
1.179 matthew 1338: my $title = &mt('Online Help');
1.667 raeburn 1339: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1340: if ($imgid ne '') {
1341: $imgid = ' id="'.$imgid.'"';
1342: }
1.1314 raeburn 1343: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1344: .'<img src="'.$helpicon.'" border="0"'
1345: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1346: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1347: .' /></a>';
1348: if ($text ne "") {
1349: $template.='</span>';
1350: }
1.44 bowersj2 1351: return $template;
1352:
1.106 bowersj2 1353: }
1354:
1355: # This is a quicky function for Latex cheatsheet editing, since it
1356: # appears in at least four places
1357: sub helpLatexCheatsheet {
1.1037 www 1358: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1359: my $out;
1.106 bowersj2 1360: my $addOther = '';
1.732 raeburn 1361: if ($topic) {
1.1037 www 1362: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1363: }
1364: $out = '<span>' # Start cheatsheet
1365: .$addOther
1366: .'<span>'
1.1037 www 1367: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1368: .'</span> <span>'
1.1037 www 1369: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1370: .'</span>';
1.732 raeburn 1371: unless ($not_author) {
1.1186 kruse 1372: $out .= '<span>'
1373: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1374: .'</span> <span>'
1.1424 raeburn 1375: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763 bisitz 1376: .'</span>';
1.732 raeburn 1377: }
1.763 bisitz 1378: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1379: return $out;
1.172 www 1380: }
1381:
1.430 albertel 1382: sub general_help {
1383: my $helptopic='Student_Intro';
1384: if ($env{'request.role'}=~/^(ca|au)/) {
1385: $helptopic='Authoring_Intro';
1.907 raeburn 1386: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1387: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1388: } elsif ($env{'request.role'}=~/^dc/) {
1389: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1390: }
1391: return $helptopic;
1392: }
1393:
1394: sub update_help_link {
1395: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1396: my $origurl = $ENV{'REQUEST_URI'};
1397: $origurl=~s|^/~|/priv/|;
1398: my $timestamp = time;
1399: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1400: $$datum = &escape($$datum);
1401: }
1402:
1403: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1404: my $output .= <<"ENDOUTPUT";
1405: <script type="text/javascript">
1.824 bisitz 1406: // <![CDATA[
1.430 albertel 1407: banner_link = '$banner_link';
1.824 bisitz 1408: // ]]>
1.430 albertel 1409: </script>
1410: ENDOUTPUT
1411: return $output;
1412: }
1413:
1414: # now just updates the help link and generates a blue icon
1.193 raeburn 1415: sub help_open_menu {
1.1381 raeburn 1416: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1417: = @_;
1.949 droeschl 1418: $stayOnPage = 1;
1.430 albertel 1419: my $output;
1420: if ($component_help) {
1421: if (!$text) {
1422: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1423: $width,$height,'',$links_target);
1.430 albertel 1424: } else {
1425: my $help_text;
1426: $help_text=&unescape($topic);
1427: $output='<table><tr><td>'.
1428: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1429: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1430: }
1431: }
1432: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1433: return $output.$banner_link;
1434: }
1435:
1436: sub top_nav_help {
1.1369 raeburn 1437: my ($text,$linkattr) = @_;
1.436 albertel 1438: $text = &mt($text);
1.949 droeschl 1439: my $stay_on_page = 1;
1440:
1.1168 raeburn 1441: my ($link,$banner_link);
1442: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1443: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1444: : "javascript:helpMenu('open')";
1445: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1446: }
1.201 raeburn 1447: my $title = &mt('Get help');
1.1168 raeburn 1448: if ($link) {
1449: return <<"END";
1.436 albertel 1450: $banner_link
1.1369 raeburn 1451: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1452: END
1.1168 raeburn 1453: } else {
1454: return ' '.$text.' ';
1455: }
1.436 albertel 1456: }
1457:
1458: sub help_menu_js {
1.1154 raeburn 1459: my ($httphost) = @_;
1.949 droeschl 1460: my $stayOnPage = 1;
1.436 albertel 1461: my $width = 620;
1462: my $height = 600;
1.430 albertel 1463: my $helptopic=&general_help();
1.1154 raeburn 1464: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1465: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1466: my $start_page =
1467: &Apache::loncommon::start_page('Help Menu', undef,
1468: {'frameset' => 1,
1469: 'js_ready' => 1,
1.1154 raeburn 1470: 'use_absolute' => $httphost,
1.331 albertel 1471: 'add_entries' => {
1.1168 raeburn 1472: 'border' => '0',
1.579 raeburn 1473: 'rows' => "110,*",},});
1.331 albertel 1474: my $end_page =
1475: &Apache::loncommon::end_page({'frameset' => 1,
1476: 'js_ready' => 1,});
1477:
1.436 albertel 1478: my $template .= <<"ENDTEMPLATE";
1479: <script type="text/javascript">
1.877 bisitz 1480: // <![CDATA[
1.253 albertel 1481: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1482: var banner_link = '';
1.243 raeburn 1483: function helpMenu(target) {
1484: var caller = this;
1485: if (target == 'open') {
1486: var newWindow = null;
1487: try {
1.262 albertel 1488: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1489: }
1490: catch(error) {
1491: writeHelp(caller);
1492: return;
1493: }
1494: if (newWindow) {
1495: caller = newWindow;
1496: }
1.193 raeburn 1497: }
1.243 raeburn 1498: writeHelp(caller);
1499: return;
1500: }
1501: function writeHelp(caller) {
1.1168 raeburn 1502: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1503: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1504: caller.document.close();
1505: caller.focus();
1.193 raeburn 1506: }
1.877 bisitz 1507: // END LON-CAPA Internal -->
1.253 albertel 1508: // ]]>
1.436 albertel 1509: </script>
1.193 raeburn 1510: ENDTEMPLATE
1511: return $template;
1512: }
1513:
1.172 www 1514: sub help_open_bug {
1515: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1516: unless ($env{'user.adv'}) { return ''; }
1.172 www 1517: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1518: $text = "" if (not defined $text);
1519: $stayOnPage=1;
1.184 albertel 1520: $width = 600 if (not defined $width);
1521: $height = 600 if (not defined $height);
1.172 www 1522:
1523: $topic=~s/\W+/\+/g;
1524: my $link='';
1525: my $template='';
1.379 albertel 1526: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1527: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1528: if (!$stayOnPage)
1529: {
1530: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1531: }
1532: else
1533: {
1534: $link = $url;
1535: }
1.1314 raeburn 1536:
1.1382 raeburn 1537: my $target = '_top';
1538: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1539: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1540: $target = '_blank';
1.1378 raeburn 1541: }
1.1382 raeburn 1542:
1.172 www 1543: # Add the text
1544: if ($text ne "")
1545: {
1546: $template .=
1547: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1548: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1549: }
1550:
1551: # Add the graphic
1.179 matthew 1552: my $title = &mt('Report a Bug');
1.215 albertel 1553: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1554: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1555: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1556: ENDTEMPLATE
1557: if ($text ne '') { $template.='</td></tr></table>' };
1558: return $template;
1559:
1560: }
1561:
1562: sub help_open_faq {
1563: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1564: unless ($env{'user.adv'}) { return ''; }
1.172 www 1565: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1566: $text = "" if (not defined $text);
1567: $stayOnPage=1;
1568: $width = 350 if (not defined $width);
1569: $height = 400 if (not defined $height);
1570:
1571: $topic=~s/\W+/\+/g;
1572: my $link='';
1573: my $template='';
1574: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1575: if (!$stayOnPage)
1576: {
1577: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1578: }
1579: else
1580: {
1581: $link = $url;
1582: }
1583:
1584: # Add the text
1585: if ($text ne "")
1586: {
1587: $template .=
1.173 www 1588: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1589: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1590: }
1591:
1592: # Add the graphic
1.179 matthew 1593: my $title = &mt('View the FAQ');
1.215 albertel 1594: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1595: $template .= <<"ENDTEMPLATE";
1.436 albertel 1596: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1597: ENDTEMPLATE
1598: if ($text ne '') { $template.='</td></tr></table>' };
1599: return $template;
1600:
1.44 bowersj2 1601: }
1.37 matthew 1602:
1.180 matthew 1603: ###############################################################
1604: ###############################################################
1605:
1.45 matthew 1606: =pod
1607:
1.648 raeburn 1608: =item * &change_content_javascript():
1.256 matthew 1609:
1610: This and the next function allow you to create small sections of an
1611: otherwise static HTML page that you can update on the fly with
1612: Javascript, even in Netscape 4.
1613:
1614: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1615: must be written to the HTML page once. It will prove the Javascript
1616: function "change(name, content)". Calling the change function with the
1617: name of the section
1618: you want to update, matching the name passed to C<changable_area>, and
1619: the new content you want to put in there, will put the content into
1620: that area.
1621:
1622: B<Note>: Netscape 4 only reserves enough space for the changable area
1623: to contain room for the original contents. You need to "make space"
1624: for whatever changes you wish to make, and be B<sure> to check your
1625: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1626: it's adequate for updating a one-line status display, but little more.
1627: This script will set the space to 100% width, so you only need to
1628: worry about height in Netscape 4.
1629:
1630: Modern browsers are much less limiting, and if you can commit to the
1631: user not using Netscape 4, this feature may be used freely with
1632: pretty much any HTML.
1633:
1634: =cut
1635:
1636: sub change_content_javascript {
1637: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1638: if ($env{'browser.type'} eq 'netscape' &&
1639: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1640: return (<<NETSCAPE4);
1641: function change(name, content) {
1642: doc = document.layers[name+"___escape"].layers[0].document;
1643: doc.open();
1644: doc.write(content);
1645: doc.close();
1646: }
1647: NETSCAPE4
1648: } else {
1649: # Otherwise, we need to use semi-standards-compliant code
1650: # (technically, "innerHTML" isn't standard but the equivalent
1651: # is really scary, and every useful browser supports it
1652: return (<<DOMBASED);
1653: function change(name, content) {
1654: element = document.getElementById(name);
1655: element.innerHTML = content;
1656: }
1657: DOMBASED
1658: }
1659: }
1660:
1661: =pod
1662:
1.648 raeburn 1663: =item * &changable_area($name,$origContent):
1.256 matthew 1664:
1665: This provides a "changable area" that can be modified on the fly via
1666: the Javascript code provided in C<change_content_javascript>. $name is
1667: the name you will use to reference the area later; do not repeat the
1668: same name on a given HTML page more then once. $origContent is what
1669: the area will originally contain, which can be left blank.
1670:
1671: =cut
1672:
1673: sub changable_area {
1674: my ($name, $origContent) = @_;
1675:
1.258 albertel 1676: if ($env{'browser.type'} eq 'netscape' &&
1677: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1678: # If this is netscape 4, we need to use the Layer tag
1679: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1680: } else {
1681: return "<span id='$name'>$origContent</span>";
1682: }
1683: }
1684:
1685: =pod
1686:
1.648 raeburn 1687: =item * &viewport_geometry_js
1.590 raeburn 1688:
1689: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1690:
1691: =cut
1692:
1693:
1694: sub viewport_geometry_js {
1695: return <<"GEOMETRY";
1696: var Geometry = {};
1697: function init_geometry() {
1698: if (Geometry.init) { return };
1699: Geometry.init=1;
1700: if (window.innerHeight) {
1701: Geometry.getViewportHeight = function() { return window.innerHeight; };
1702: Geometry.getViewportWidth = function() { return window.innerWidth; };
1703: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1704: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1705: }
1706: else if (document.documentElement && document.documentElement.clientHeight) {
1707: Geometry.getViewportHeight =
1708: function() { return document.documentElement.clientHeight; };
1709: Geometry.getViewportWidth =
1710: function() { return document.documentElement.clientWidth; };
1711:
1712: Geometry.getHorizontalScroll =
1713: function() { return document.documentElement.scrollLeft; };
1714: Geometry.getVerticalScroll =
1715: function() { return document.documentElement.scrollTop; };
1716: }
1717: else if (document.body.clientHeight) {
1718: Geometry.getViewportHeight =
1719: function() { return document.body.clientHeight; };
1720: Geometry.getViewportWidth =
1721: function() { return document.body.clientWidth; };
1722: Geometry.getHorizontalScroll =
1723: function() { return document.body.scrollLeft; };
1724: Geometry.getVerticalScroll =
1725: function() { return document.body.scrollTop; };
1726: }
1727: }
1728:
1729: GEOMETRY
1730: }
1731:
1732: =pod
1733:
1.648 raeburn 1734: =item * &viewport_size_js()
1.590 raeburn 1735:
1736: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1737:
1738: =cut
1739:
1740: sub viewport_size_js {
1741: my $geometry = &viewport_geometry_js();
1742: return <<"DIMS";
1743:
1744: $geometry
1745:
1746: function getViewportDims(width,height) {
1747: init_geometry();
1748: width.value = Geometry.getViewportWidth();
1749: height.value = Geometry.getViewportHeight();
1750: return;
1751: }
1752:
1753: DIMS
1754: }
1755:
1756: =pod
1757:
1.648 raeburn 1758: =item * &resize_textarea_js()
1.565 albertel 1759:
1760: emits the needed javascript to resize a textarea to be as big as possible
1761:
1762: creates a function resize_textrea that takes two IDs first should be
1763: the id of the element to resize, second should be the id of a div that
1764: surrounds everything that comes after the textarea, this routine needs
1765: to be attached to the <body> for the onload and onresize events.
1766:
1767: =cut
1768:
1769: sub resize_textarea_js {
1.590 raeburn 1770: my $geometry = &viewport_geometry_js();
1.565 albertel 1771: return <<"RESIZE";
1772: <script type="text/javascript">
1.824 bisitz 1773: // <![CDATA[
1.590 raeburn 1774: $geometry
1.565 albertel 1775:
1.588 albertel 1776: function getX(element) {
1777: var x = 0;
1778: while (element) {
1779: x += element.offsetLeft;
1780: element = element.offsetParent;
1781: }
1782: return x;
1783: }
1784: function getY(element) {
1785: var y = 0;
1786: while (element) {
1787: y += element.offsetTop;
1788: element = element.offsetParent;
1789: }
1790: return y;
1791: }
1792:
1793:
1.565 albertel 1794: function resize_textarea(textarea_id,bottom_id) {
1795: init_geometry();
1796: var textarea = document.getElementById(textarea_id);
1797: //alert(textarea);
1798:
1.588 albertel 1799: var textarea_top = getY(textarea);
1.565 albertel 1800: var textarea_height = textarea.offsetHeight;
1801: var bottom = document.getElementById(bottom_id);
1.588 albertel 1802: var bottom_top = getY(bottom);
1.565 albertel 1803: var bottom_height = bottom.offsetHeight;
1804: var window_height = Geometry.getViewportHeight();
1.588 albertel 1805: var fudge = 23;
1.565 albertel 1806: var new_height = window_height-fudge-textarea_top-bottom_height;
1807: if (new_height < 300) {
1808: new_height = 300;
1809: }
1810: textarea.style.height=new_height+'px';
1811: }
1.824 bisitz 1812: // ]]>
1.565 albertel 1813: </script>
1814: RESIZE
1815:
1816: }
1817:
1.1205 golterma 1818: sub colorfuleditor_js {
1.1248 raeburn 1819: my $browse_or_search;
1820: my $respath;
1821: my ($cnum,$cdom) = &crsauthor_url();
1822: if ($cnum) {
1823: $respath = "/res/$cdom/$cnum/";
1824: my %js_lt = &Apache::lonlocal::texthash(
1825: sunm => 'Sub-directory name',
1826: save => 'Save page to make this permanent',
1827: );
1828: &js_escape(\%js_lt);
1.1400 raeburn 1829: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1830: $browse_or_search = <<"END";
1831:
1.1400 raeburn 1832: $showfile_js
1833:
1.1248 raeburn 1834: function toggleChooser(form,element,titleid,only,search) {
1835: var disp = 'none';
1836: if (document.getElementById('chooser_'+element)) {
1837: var curr = document.getElementById('chooser_'+element).style.display;
1838: if (curr == 'none') {
1839: disp='inline';
1840: if (form.elements['chooser_'+element].length) {
1841: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1842: form.elements['chooser_'+element][i].checked = false;
1843: }
1844: }
1845: toggleResImport(form,element);
1846: }
1847: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1848: var dirsel = '';
1849: var filesel = '';
1850: if (document.getElementById('chooser_'+element+'_crsres')) {
1851: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1852: if (currcrsres == 'none') {
1853: dirsel = 'coursepath_'+element;
1854: var filesel = 'coursefile_'+element;
1855: var include;
1856: if (document.getElementById('crsres_include_'+element)) {
1857: include = document.getElementById('crsres_include_'+element).value;
1858: }
1.1402 raeburn 1859: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1860: }
1861: }
1862: if (document.getElementById('chooser_'+element+'_upload')) {
1863: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1864: if (currcrsupload == 'none') {
1865: dirsel = 'crsauthorpath_'+element;
1866: filesel = '';
1.1402 raeburn 1867: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1868: }
1869: }
1.1248 raeburn 1870: }
1871: }
1872:
1.1400 raeburn 1873: function toggleCrsFile(form,element) {
1.1248 raeburn 1874: if (document.getElementById('chooser_'+element+'_crsres')) {
1875: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1876: if (curr == 'none') {
1.1400 raeburn 1877: if (document.getElementById('coursepath_'+element)) {
1878: var numdirs;
1879: if (document.getElementById('coursepath_'+element).length) {
1880: numdirs = document.getElementById('coursepath_'+element).length;
1881: }
1.1402 raeburn 1882: if ((document.getElementById('hascrsres_'+element)) &&
1883: (document.getElementById('nocrsres_'+element))) {
1884: if (numdirs) {
1885: document.getElementById('hascrsres_'+element).style.display='inline-block';
1886: document.getElementById('nocrsres_'+element).style.display='none';
1887: } else {
1888: document.getElementById('hascrsres_'+element).style.display='none';
1889: document.getElementById('nocrsres_'+element).style.display='inline-block';
1890: }
1891: }
1.1248 raeburn 1892: form.elements['coursepath_'+element].selectedIndex = 0;
1893: if (numdirs > 1) {
1.1400 raeburn 1894: var selelem = form.elements['coursefile_'+element];
1895: var i, len = selelem.options.length -1;
1896: if (len >=0) {
1897: for (i = len; i >= 0; i--) {
1898: selelem.remove(i);
1899: }
1900: selelem.options[0] = new Option('','');
1901: }
1.1248 raeburn 1902: }
1903: }
1.1400 raeburn 1904: }
1.1248 raeburn 1905: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1906: }
1907: if (document.getElementById('chooser_'+element+'_upload')) {
1908: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1909: if (document.getElementById('uploadcrsres_'+element)) {
1910: document.getElementById('uploadcrsres_'+element).value = '';
1911: }
1912: }
1913: return;
1914: }
1915:
1.1400 raeburn 1916: function toggleCrsUpload(form,element) {
1.1248 raeburn 1917: if (document.getElementById('chooser_'+element+'_crsres')) {
1918: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1919: }
1920: if (document.getElementById('chooser_'+element+'_upload')) {
1921: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1922: if (curr == 'none') {
1.1400 raeburn 1923: form.elements['newsubdir_'+element][0].checked = true;
1924: toggleNewsubdir(form,element);
1925: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1926: if (document.getElementById('uploadcrsres_'+element)) {
1927: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1928: }
1929: }
1930: }
1931: return;
1932: }
1933:
1934: function toggleResImport(form,element) {
1935: var choices = new Array('crsres','upload');
1936: for (var i=0; i<choices.length; i++) {
1937: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1938: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1939: }
1940: }
1941: }
1942:
1943: function toggleNewsubdir(form,element) {
1944: var newsub = form.elements['newsubdir_'+element];
1945: if (newsub) {
1946: if (newsub.length) {
1947: for (var j=0; j<newsub.length; j++) {
1948: if (newsub[j].checked) {
1949: if (document.getElementById('newsubdirname_'+element)) {
1950: if (newsub[j].value == '1') {
1951: document.getElementById('newsubdirname_'+element).type = "text";
1952: if (document.getElementById('newsubdir_'+element)) {
1953: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1954: }
1955: } else {
1956: document.getElementById('newsubdirname_'+element).type = "hidden";
1957: document.getElementById('newsubdirname_'+element).value = "";
1958: document.getElementById('newsubdir_'+element).innerHTML = "";
1959: }
1960: }
1961: break;
1962: }
1963: }
1964: }
1965: }
1966: }
1967:
1968: function updateCrsFile(form,element) {
1969: var directory = form.elements['coursepath_'+element];
1970: var filename = form.elements['coursefile_'+element];
1971: var path = directory.options[directory.selectedIndex].value;
1972: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1973: if (file != '') {
1974: form.elements[element].value = '$respath';
1975: if (path == '/') {
1976: form.elements[element].value += file;
1977: } else {
1978: form.elements[element].value += path+'/'+file;
1979: }
1980: unClean();
1981: if (document.getElementById('previewimg_'+element)) {
1982: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1983: var newsrc = document.getElementById('previewimg_'+element).src;
1984: }
1985: if (document.getElementById('showimg_'+element)) {
1986: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1987: }
1.1248 raeburn 1988: }
1989: toggleChooser(form,element);
1990: return;
1991: }
1992:
1993: function uploadDone(suffix,name) {
1994: if (name) {
1995: document.forms["lonhomework"].elements[suffix].value = name;
1996: unClean();
1997: toggleChooser(document.forms["lonhomework"],suffix);
1998: }
1999: }
2000:
2001: \$(document).ready(function(){
2002:
2003: \$(document).delegate('form :submit', 'click', function( event ) {
2004: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2005: var buttonId = this.id;
2006: var suffix = buttonId.toString();
2007: suffix = suffix.replace(/^crsupload_/,'');
2008: event.preventDefault();
2009: document.lonhomework.target = 'crsupload_target_'+suffix;
2010: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2011: \$(this.form).submit();
2012: document.lonhomework.target = '';
2013: if (document.getElementById('crsuploadto_'+suffix)) {
2014: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2015: }
2016: return false;
2017: }
2018: });
2019: });
2020: END
2021: }
1.1205 golterma 2022: return <<"COLORFULEDIT"
2023: <script type="text/javascript">
2024: // <![CDATA[>
2025: function fold_box(curDepth, lastresource){
2026:
2027: // we need a list because there can be several blocks you need to fold in one tag
2028: var block = document.getElementsByName('foldblock_'+curDepth);
2029: // but there is only one folding button per tag
2030: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2031:
2032: if(block.item(0).style.display == 'none'){
2033:
2034: foldbutton.value = '@{[&mt("Hide")]}';
2035: for (i = 0; i < block.length; i++){
2036: block.item(i).style.display = '';
2037: }
2038: }else{
2039:
2040: foldbutton.value = '@{[&mt("Show")]}';
2041: for (i = 0; i < block.length; i++){
2042: // block.item(i).style.visibility = 'collapse';
2043: block.item(i).style.display = 'none';
2044: }
2045: };
2046: saveState(lastresource);
2047: }
2048:
2049: function saveState (lastresource) {
2050:
2051: var tag_list = getTagList();
2052: if(tag_list != null){
2053: var timestamp = new Date().getTime();
2054: var key = lastresource;
2055:
2056: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2057: // starting with timestamp
2058: var value = timestamp+';';
2059:
2060: // building the list of key-value pairs
2061: for(var i = 0; i < tag_list.length; i++){
2062: value += tag_list[i]+',';
2063: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2064: }
2065:
2066: // only iterate whole storage if nothing to override
2067: if(localStorage.getItem(key) == null){
2068:
2069: // prevent storage from growing large
2070: if(localStorage.length > 50){
2071: var regex_getTimestamp = /^(?:\d)+;/;
2072: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2073: var oldest_key;
2074:
2075: for(var i = 1; i < localStorage.length; i++){
2076: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2077: oldest_key = localStorage.key(i);
2078: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2079: }
2080: }
2081: localStorage.removeItem(oldest_key);
2082: }
2083: }
2084: localStorage.setItem(key,value);
2085: }
2086: }
2087:
2088: // restore folding status of blocks (on page load)
2089: function restoreState (lastresource) {
2090: if(localStorage.getItem(lastresource) != null){
2091: var key = lastresource;
2092: var value = localStorage.getItem(key);
2093: var regex_delTimestamp = /^\d+;/;
2094:
2095: value.replace(regex_delTimestamp, '');
2096:
2097: var valueArr = value.split(';');
2098: var pairs;
2099: var elements;
2100: for (var i = 0; i < valueArr.length; i++){
2101: pairs = valueArr[i].split(',');
2102: elements = document.getElementsByName(pairs[0]);
2103:
2104: for (var j = 0; j < elements.length; j++){
2105: elements[j].style.display = pairs[1];
2106: if (pairs[1] == "none"){
2107: var regex_id = /([_\\d]+)\$/;
2108: regex_id.exec(pairs[0]);
2109: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2110: }
2111: }
2112: }
2113: }
2114: }
2115:
2116: function getTagList () {
2117:
2118: var stringToSearch = document.lonhomework.innerHTML;
2119:
2120: var ret = new Array();
2121: var regex_findBlock = /(foldblock_.*?)"/g;
2122: var tag_list = stringToSearch.match(regex_findBlock);
2123:
2124: if(tag_list != null){
2125: for(var i = 0; i < tag_list.length; i++){
2126: ret.push(tag_list[i].replace(/"/, ''));
2127: }
2128: }
2129: return ret;
2130: }
2131:
2132: function saveScrollPosition (resource) {
2133: var tag_list = getTagList();
2134:
2135: // we dont always want to jump to the first block
2136: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2137: if(\$(window).scrollTop() > 170){
2138: if(tag_list != null){
2139: var result;
2140: for(var i = 0; i < tag_list.length; i++){
2141: if(isElementInViewport(tag_list[i])){
2142: result += tag_list[i]+';';
2143: }
2144: }
2145: sessionStorage.setItem('anchor_'+resource, result);
2146: }
2147: } else {
2148: // we dont need to save zero, just delete the item to leave everything tidy
2149: sessionStorage.removeItem('anchor_'+resource);
2150: }
2151: }
2152:
2153: function restoreScrollPosition(resource){
2154:
2155: var elem = sessionStorage.getItem('anchor_'+resource);
2156: if(elem != null){
2157: var tag_list = elem.split(';');
2158: var elem_list;
2159:
2160: for(var i = 0; i < tag_list.length; i++){
2161: elem_list = document.getElementsByName(tag_list[i]);
2162:
2163: if(elem_list.length > 0){
2164: elem = elem_list[0];
2165: break;
2166: }
2167: }
2168: elem.scrollIntoView();
2169: }
2170: }
2171:
2172: function isElementInViewport(el) {
2173:
2174: // change to last element instead of first
2175: var elem = document.getElementsByName(el);
2176: var rect = elem[0].getBoundingClientRect();
2177:
2178: return (
2179: rect.top >= 0 &&
2180: rect.left >= 0 &&
2181: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2182: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2183: );
2184: }
2185:
2186: function autosize(depth){
2187: var cmInst = window['cm'+depth];
2188: var fitsizeButton = document.getElementById('fitsize'+depth);
2189:
2190: // is fixed size, switching to dynamic
2191: if (sessionStorage.getItem("autosized_"+depth) == null) {
2192: cmInst.setSize("","auto");
2193: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2194: sessionStorage.setItem("autosized_"+depth, "yes");
2195:
2196: // is dynamic size, switching to fixed
2197: } else {
2198: cmInst.setSize("","300px");
2199: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2200: sessionStorage.removeItem("autosized_"+depth);
2201: }
2202: }
2203:
1.1248 raeburn 2204: $browse_or_search
1.1205 golterma 2205:
2206: // ]]>
2207: </script>
2208: COLORFULEDIT
2209: }
2210:
2211: sub xmleditor_js {
2212: return <<XMLEDIT
2213: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2214: <script type="text/javascript">
2215: // <![CDATA[>
2216:
2217: function saveScrollPosition (resource) {
2218:
2219: var scrollPos = \$(window).scrollTop();
2220: sessionStorage.setItem(resource,scrollPos);
2221: }
2222:
2223: function restoreScrollPosition(resource){
2224:
2225: var scrollPos = sessionStorage.getItem(resource);
2226: \$(window).scrollTop(scrollPos);
2227: }
2228:
2229: // unless internet explorer
2230: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2231:
2232: \$(document).ready(function() {
2233: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2234: });
2235: }
2236:
2237: // inserts text at cursor position into codemirror (xml editor only)
2238: function insertText(text){
2239: cm.focus();
2240: var curPos = cm.getCursor();
2241: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2242: }
2243: // ]]>
2244: </script>
2245: XMLEDIT
2246: }
2247:
2248: sub insert_folding_button {
2249: my $curDepth = $Apache::lonxml::curdepth;
2250: my $lastresource = $env{'request.ambiguous'};
2251:
2252: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2253: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2254: }
2255:
1.1248 raeburn 2256: sub crsauthor_url {
2257: my ($url) = @_;
2258: if ($url eq '') {
2259: $url = $ENV{'REQUEST_URI'};
2260: }
2261: my ($cnum,$cdom);
2262: if ($env{'request.course.id'}) {
2263: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2264: if ($audom ne '' && $auname ne '') {
2265: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2266: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2267: $cnum = $auname;
2268: $cdom = $audom;
2269: }
2270: }
2271: }
2272: return ($cnum,$cdom);
2273: }
2274:
2275: sub import_crsauthor_form {
1.1400 raeburn 2276: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2277: return (0) unless ($env{'request.course.id'});
2278: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2279: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2280: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2281: return (0) unless (($cnum ne '') && ($cdom ne ''));
2282: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2283: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2284:
1.1248 raeburn 2285: if (grep(/^\Q$crshome\E$/,@ids)) {
2286: $is_home = 1;
2287: }
1.1400 raeburn 2288: $toppath = "/priv/$cdom/$cnum";
2289: my $nonemptydir = 1;
2290: my $js_only;
2291: if ($only) {
2292: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2293: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2294: }
2295: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2296: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2297: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2298: my %lt = &Apache::lonlocal::texthash (
2299: fnam => 'Filename',
2300: dire => 'Directory',
1.1400 raeburn 2301: se => 'Select',
1.1248 raeburn 2302: );
1.1402 raeburn 2303: $output = $lt{'dire'}.': '.
1.1400 raeburn 2304: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2305: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2306: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2307: if ($files{'/'}) {
2308: $output .= '<option value="/">/</option>'."\n";
2309: }
1.1400 raeburn 2310: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2311: next if ($key eq '/');
1.1400 raeburn 2312: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2313: }
2314: $output .= '</select><br />'."\n".
1.1402 raeburn 2315: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2316: '<option value="" selected="selected"></option>'."\n".
1.1402 raeburn 2317: '</select>'."\n".
2318: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2319: return ($numdirs,$output);
2320: }
2321:
2322: sub show_crsfiles_js {
2323: my $excluderef = &Apache::lonnet::priv_exclude();
2324: my $se = &js_escape(&mt('Select'));
2325: my $exclude;
2326: if (ref($excluderef) eq 'HASH') {
2327: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2328: }
2329: my $js = <<"END";
2330:
2331:
1.1402 raeburn 2332: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2333: var relpath = '';
2334: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2335: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2336: if (currdir == '') {
2337: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2338: selelem = form.elements[filesel];
2339: var j, numfiles = selelem.options.length -1;
2340: if (numfiles >=0) {
2341: for (j = numfiles; j >= 0; j--) {
2342: selelem.remove(j);
2343: }
2344: }
2345: if (selelem.options.length == 0) {
2346: selelem.options[selelem.options.length] = new Option('','');
2347: selelem.selectedIndex = 0;
1.1248 raeburn 2348: }
2349: }
1.1400 raeburn 2350: return;
2351: } else {
2352: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2353: }
2354: }
1.1400 raeburn 2355: var http = new XMLHttpRequest();
2356: var url = "/adm/courseauthor";
2357: var crsrole = "$env{'request.role'}";
2358: var exclude = '';
2359: if (exc) {
2360: exclude = '$exclude';
2361: }
1.1402 raeburn 2362: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2363: http.open("POST", url, true);
2364: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2365: http.onreadystatechange = function() {
2366: if (http.readyState == 4 && http.status == 200) {
2367: var data = JSON.parse(http.responseText);
2368: var selelem;
2369: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2370: if (Array.isArray(data.dirs)) {
2371: selelem = form.elements[dirsel];
2372: var i, numdirs = selelem.options.length -1;
2373: if (numdirs >=0) {
2374: for (i = numdirs; i >= 0; i--) {
2375: selelem.remove(i);
2376: }
2377: }
2378: var len = data.dirs.length;
2379: if (len) {
1.1402 raeburn 2380: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2381: var j;
2382: for (j = 0; j < len; j++) {
2383: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2384: }
2385: selelem.selectedIndex = 0;
2386: }
2387: if (!setfile) {
2388: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2389: selelem = form.elements[filesel];
2390: var j, numfiles = selelem.options.length -1;
2391: if (numfiles >=0) {
2392: for (j = numfiles; j >= 0; j--) {
2393: selelem.remove(j);
2394: }
2395: }
2396: if (selelem.options.length == 0) {
2397: selelem.options[selelem.options.length] = new Option('','');
2398: selelem.selectedIndex = 0;
2399: }
2400: }
2401: }
2402: }
2403: }
2404: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2405: selelem = form.elements[filesel];
2406: var i, numfiles = selelem.options.length -1;
2407: if (numfiles >=0) {
2408: for (i = numfiles; i >= 0; i--) {
2409: selelem.remove(i);
2410: }
2411: }
2412: var x;
2413: for (x in data.files) {
2414: if (Array.isArray(data.files[x])) {
2415: if (data.files[x].length > 1) {
2416: selelem.options[selelem.options.length] = new Option('$se','');
2417: }
2418: var len = data.files[x].length;
2419: if (len) {
2420: var k;
2421: for (k = 0; k < len; k++) {
2422: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2423: }
2424: selelem.selectedIndex = 0;
2425: }
2426: }
2427: }
2428: if (selelem.options.length == 0) {
2429: selelem.options[selelem.options.length] = new Option('','');
2430: selelem.selectedIndex = 0;
2431: }
1.1248 raeburn 2432: }
2433: }
2434: }
1.1400 raeburn 2435: http.send(params);
1.1248 raeburn 2436: }
1.1400 raeburn 2437: END
1.1248 raeburn 2438: }
2439:
1.1426 raeburn 2440: sub crsauthor_rights {
2441: my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
2442: my $sourcerights = "$path/$rightsfile";
2443: my $now = time;
2444: if (!-e $sourcerights) {
2445: my $cid = $cdom.'_'.$cnum;
2446: if (!-e "$docroot/priv/$cdom") {
2447: mkdir("$docroot/priv/$cdom",0755);
2448: }
2449: if (!-e "$docroot/priv/$cdom/$cnum") {
2450: mkdir("$docroot/priv/$cdom/$cnum",0755);
2451: }
2452: if (open(my $fh,">$sourcerights")) {
2453: print $fh <<END;
2454: <accessrule effect="deny" realm="" type="course" role="" />
2455: <accessrule effect="allow" realm="$cid" type="course" role="" />
2456: END
2457: close($fh);
2458: }
2459: }
2460: if (!-e "$sourcerights.meta") {
2461: if (open(my $fh,">$sourcerights.meta")) {
2462: my $author=$env{'environment.firstname'}.' '.
2463: $env{'environment.middlename'}.' '.
2464: $env{'environment.lastname'}.' '.
2465: $env{'environment.generation'};
2466: $author =~ s/\s+$//;
2467: print $fh <<"END";
2468:
2469: <abstract></abstract>
2470: <author>$author</author>
2471: <authorspace>$cnum:$cdom</authorspace>
2472: <copyright>private</copyright>
2473: <creationdate>$now</creationdate>
2474: <customdistributionfile></customdistributionfile>
2475: <dependencies></dependencies>
2476: <domain>$cdom</domain>
2477: <highestgradelevel>0</highestgradelevel>
2478: <keywords></keywords>
1.1445 raeburn 2479: <language>notset</language>
1.1426 raeburn 2480: <lastrevisiondate>$now</lastrevisiondate>
2481: <lowestgradelevel>0</lowestgradelevel>
2482: <mime>rights</mime>
2483: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
2484: <notes></notes>
2485: <obsolete></obsolete>
2486: <obsoletereplacement></obsoletereplacement>
2487: <owner>$cnum:$cdom</owner>
2488: <rule>deny:::course,allow:$cid::course</rule>
2489: <sourceavail></sourceavail>
2490: <standards></standards>
2491: <subject></subject>
2492: <title>Course Authoring Rights</title>
2493: END
2494: close($fh);
2495: }
2496: }
2497: return;
2498: }
2499:
1.565 albertel 2500: =pod
2501:
1.1420 raeburn 2502: =item * &iframe_wrapper_headjs()
2503:
1.1425 raeburn 2504: emits javascript containing two global vars to facilitate handling of resizing
2505: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
2506: with standard LON-CAPA menus.
2507:
2508: =cut
2509:
1.1420 raeburn 2510: #
2511: # Where iframe is in use, if window.onload() executes before the custom resize function
2512: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
2513: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
2514: # do not obscure the Functions menu.
2515: #
2516:
2517: sub iframe_wrapper_headjs {
2518: return <<"ENDJS";
2519: <script type="text/javascript">
2520: // <![CDATA[
2521: var LCnotready = 0;
2522: var LCresizedef = 0;
2523: // ]]>
2524: </script>
2525:
2526: ENDJS
2527:
2528: }
2529:
2530: =pod
2531:
2532: =item * &iframe_wrapper_resizejs()
2533:
1.1425 raeburn 2534: emits javascript used to handle resizing for a page containing
2535: an iframe, to ensure that the iframe does not obscure any
2536: standard LON-CAPA menu items.
2537:
2538: =back
2539:
2540: =cut
2541:
1.1420 raeburn 2542: #
2543: # jQuery to use when iframe is in use and a page resize occurs.
2544: # This script will ensure that the iframe does not obscure any
2545: # standard LON-CAPA inline menus (primary, secondary, and/or
2546: # breadcrumbs and Functions menus. Expects javascript from
2547: # &iframe_wrapper_headjs() to be in head portion of the web page,
2548: # e.g., by inclusion in second arg passed to &start_page().
2549: #
2550:
2551: sub iframe_wrapper_resizejs {
2552: my $offset = 5;
2553: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
2554: if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
2555: $offset = 0;
2556: }
2557: return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
2558: \$(document).ready( function() {
2559: \$(window).unbind('resize').resize(function(){
2560: var header = null;
2561: var offset = $offset;
2562: var height = 0;
2563: var hdrtop = 0;
1.1421 raeburn 2564: if (\$('div.LC_menus_content:first').length) {
2565: if (\$('div.LC_menus_content:first').hasClass ("shown")) {
2566: header = \$('div.LC_menus_content:first');
1.1423 raeburn 2567: offset = 12;
1.1421 raeburn 2568: }
2569: } else if (\$('div.LC_head_subbox:first').length) {
1.1420 raeburn 2570: header = \$('div.LC_head_subbox:first');
2571: offset = 9;
2572: } else {
2573: if (\$('#LC_breadcrumbs').length) {
2574: header = \$('#LC_breadcrumbs');
2575: }
2576: }
2577: if (header != null && header.length) {
2578: height = header.height();
2579: hdrtop = header.position().top;
2580: }
2581: var pos = height + hdrtop + offset;
2582: \$('.LC_iframecontainer').css('top', pos);
2583: });
2584: LCresizedef = 1;
2585: if (LCnotready == 1) {
2586: LCnotready = 0;
2587: \$(window).trigger('resize');
2588: }
2589: });
2590: window.onload = function(){
2591: if (LCresizedef) {
2592: LCnotready = 0;
2593: \$(window).trigger('resize');
2594: } else {
2595: LCnotready = 1;
2596: }
2597: };
2598: SCRIPT
2599:
2600: }
2601:
2602: =pod
2603:
1.256 matthew 2604: =head1 Excel and CSV file utility routines
2605:
2606: =cut
2607:
2608: ###############################################################
2609: ###############################################################
2610:
2611: =pod
2612:
1.1162 raeburn 2613: =over 4
2614:
1.648 raeburn 2615: =item * &csv_translate($text)
1.37 matthew 2616:
1.185 www 2617: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2618: format.
2619:
2620: =cut
2621:
1.180 matthew 2622: ###############################################################
2623: ###############################################################
1.37 matthew 2624: sub csv_translate {
2625: my $text = shift;
2626: $text =~ s/\"/\"\"/g;
1.209 albertel 2627: $text =~ s/\n/ /g;
1.37 matthew 2628: return $text;
2629: }
1.180 matthew 2630:
2631: ###############################################################
2632: ###############################################################
2633:
2634: =pod
2635:
1.648 raeburn 2636: =item * &define_excel_formats()
1.180 matthew 2637:
2638: Define some commonly used Excel cell formats.
2639:
2640: Currently supported formats:
2641:
2642: =over 4
2643:
2644: =item header
2645:
2646: =item bold
2647:
2648: =item h1
2649:
2650: =item h2
2651:
2652: =item h3
2653:
1.256 matthew 2654: =item h4
2655:
2656: =item i
2657:
1.180 matthew 2658: =item date
2659:
2660: =back
2661:
2662: Inputs: $workbook
2663:
2664: Returns: $format, a hash reference.
2665:
1.1057 foxr 2666:
1.180 matthew 2667: =cut
2668:
2669: ###############################################################
2670: ###############################################################
2671: sub define_excel_formats {
2672: my ($workbook) = @_;
2673: my $format;
2674: $format->{'header'} = $workbook->add_format(bold => 1,
2675: bottom => 1,
2676: align => 'center');
2677: $format->{'bold'} = $workbook->add_format(bold=>1);
2678: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2679: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2680: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2681: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2682: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2683: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2684: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2685: return $format;
2686: }
2687:
2688: ###############################################################
2689: ###############################################################
1.113 bowersj2 2690:
2691: =pod
2692:
1.648 raeburn 2693: =item * &create_workbook()
1.255 matthew 2694:
2695: Create an Excel worksheet. If it fails, output message on the
2696: request object and return undefs.
2697:
2698: Inputs: Apache request object
2699:
2700: Returns (undef) on failure,
2701: Excel worksheet object, scalar with filename, and formats
2702: from &Apache::loncommon::define_excel_formats on success
2703:
2704: =cut
2705:
2706: ###############################################################
2707: ###############################################################
2708: sub create_workbook {
2709: my ($r) = @_;
2710: #
2711: # Create the excel spreadsheet
2712: my $filename = '/prtspool/'.
1.258 albertel 2713: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2714: time.'_'.rand(1000000000).'.xls';
2715: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2716: if (! defined($workbook)) {
2717: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2718: $r->print(
2719: '<p class="LC_error">'
2720: .&mt('Problems occurred in creating the new Excel file.')
2721: .' '.&mt('This error has been logged.')
2722: .' '.&mt('Please alert your LON-CAPA administrator.')
2723: .'</p>'
2724: );
1.255 matthew 2725: return (undef);
2726: }
2727: #
1.1014 foxr 2728: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2729: #
2730: my $format = &Apache::loncommon::define_excel_formats($workbook);
2731: return ($workbook,$filename,$format);
2732: }
2733:
2734: ###############################################################
2735: ###############################################################
2736:
2737: =pod
2738:
1.648 raeburn 2739: =item * &create_text_file()
1.113 bowersj2 2740:
1.542 raeburn 2741: Create a file to write to and eventually make available to the user.
1.256 matthew 2742: If file creation fails, outputs an error message on the request object and
2743: return undefs.
1.113 bowersj2 2744:
1.256 matthew 2745: Inputs: Apache request object, and file suffix
1.113 bowersj2 2746:
1.256 matthew 2747: Returns (undef) on failure,
2748: Filehandle and filename on success.
1.113 bowersj2 2749:
2750: =cut
2751:
1.256 matthew 2752: ###############################################################
2753: ###############################################################
2754: sub create_text_file {
2755: my ($r,$suffix) = @_;
2756: if (! defined($suffix)) { $suffix = 'txt'; };
2757: my $fh;
2758: my $filename = '/prtspool/'.
1.258 albertel 2759: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2760: time.'_'.rand(1000000000).'.'.$suffix;
2761: $fh = Apache::File->new('>/home/httpd'.$filename);
2762: if (! defined($fh)) {
2763: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2764: $r->print(
2765: '<p class="LC_error">'
2766: .&mt('Problems occurred in creating the output file.')
2767: .' '.&mt('This error has been logged.')
2768: .' '.&mt('Please alert your LON-CAPA administrator.')
2769: .'</p>'
2770: );
1.113 bowersj2 2771: }
1.256 matthew 2772: return ($fh,$filename)
1.113 bowersj2 2773: }
2774:
2775:
1.256 matthew 2776: =pod
1.113 bowersj2 2777:
2778: =back
2779:
2780: =cut
1.37 matthew 2781:
2782: ###############################################################
1.33 matthew 2783: ## Home server <option> list generating code ##
2784: ###############################################################
1.35 matthew 2785:
1.169 www 2786: # ------------------------------------------
2787:
2788: sub domain_select {
1.1289 raeburn 2789: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2790: my @possdoms;
2791: if (ref($incdoms) eq 'ARRAY') {
2792: @possdoms = @{$incdoms};
2793: } else {
2794: @possdoms = &Apache::lonnet::all_domains();
2795: }
2796:
1.169 www 2797: my %domains=map {
1.514 albertel 2798: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2799: } @possdoms;
2800:
2801: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2802: foreach my $dom (@{$excdoms}) {
2803: delete($domains{$dom});
2804: }
2805: }
2806:
1.169 www 2807: if ($multiple) {
2808: $domains{''}=&mt('Any domain');
1.550 albertel 2809: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2810: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2811: } else {
1.550 albertel 2812: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2813: return &select_form($name,$value,\%domains);
1.169 www 2814: }
2815: }
2816:
1.282 albertel 2817: #-------------------------------------------
2818:
2819: =pod
2820:
1.519 raeburn 2821: =head1 Routines for form select boxes
2822:
2823: =over 4
2824:
1.648 raeburn 2825: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2826:
2827: Returns a string containing a <select> element int multiple mode
2828:
2829:
2830: Args:
2831: $name - name of the <select> element
1.506 raeburn 2832: $value - scalar or array ref of values that should already be selected
1.282 albertel 2833: $size - number of rows long the select element is
1.283 albertel 2834: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2835: (shown text should already have been &mt())
1.506 raeburn 2836: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2837:
1.282 albertel 2838: =cut
2839:
2840: #-------------------------------------------
1.169 www 2841: sub multiple_select_form {
1.284 albertel 2842: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2843: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2844: my $output='';
1.191 matthew 2845: if (! defined($size)) {
2846: $size = 4;
1.283 albertel 2847: if (scalar(keys(%$hash))<4) {
2848: $size = scalar(keys(%$hash));
1.191 matthew 2849: }
2850: }
1.734 bisitz 2851: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2852: my @order;
1.506 raeburn 2853: if (ref($order) eq 'ARRAY') {
2854: @order = @{$order};
2855: } else {
2856: @order = sort(keys(%$hash));
1.501 banghart 2857: }
2858: if (exists($$hash{'select_form_order'})) {
2859: @order = @{$$hash{'select_form_order'}};
2860: }
2861:
1.284 albertel 2862: foreach my $key (@order) {
1.356 albertel 2863: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2864: $output.='selected="selected" ' if ($selected{$key});
2865: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2866: }
2867: $output.="</select>\n";
2868: return $output;
2869: }
2870:
1.88 www 2871: #-------------------------------------------
2872:
2873: =pod
2874:
1.1254 raeburn 2875: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2876:
2877: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2878: allow a user to select options from a ref to a hash containing:
2879: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2880: a javascript onchange item, e.g., onchange="this.form.submit();".
2881: An optional arg -- $readonly -- if true will cause the select form
2882: to be disabled, e.g., for the case where an instructor has a section-
2883: specific role, and is viewing/modifying parameters.
1.970 raeburn 2884:
1.88 www 2885: See lonrights.pm for an example invocation and use.
2886:
2887: =cut
2888:
2889: #-------------------------------------------
2890: sub select_form {
1.1228 raeburn 2891: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2892: return unless (ref($hashref) eq 'HASH');
2893: if ($onchange) {
2894: $onchange = ' onchange="'.$onchange.'"';
2895: }
1.1228 raeburn 2896: my $disabled;
2897: if ($readonly) {
2898: $disabled = ' disabled="disabled"';
2899: }
2900: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2901: my @keys;
1.970 raeburn 2902: if (exists($hashref->{'select_form_order'})) {
2903: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2904: } else {
1.970 raeburn 2905: @keys=sort(keys(%{$hashref}));
1.128 albertel 2906: }
1.356 albertel 2907: foreach my $key (@keys) {
2908: $selectform.=
2909: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2910: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2911: ">".$hashref->{$key}."</option>\n";
1.88 www 2912: }
2913: $selectform.="</select>";
2914: return $selectform;
2915: }
2916:
1.475 www 2917: # For display filters
2918:
2919: sub display_filter {
1.1074 raeburn 2920: my ($context) = @_;
1.475 www 2921: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2922: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2923: my $phraseinput = 'hidden';
2924: my $includeinput = 'hidden';
2925: my ($checked,$includetypestext);
2926: if ($env{'form.displayfilter'} eq 'containing') {
2927: $phraseinput = 'text';
2928: if ($context eq 'parmslog') {
2929: $includeinput = 'checkbox';
2930: if ($env{'form.includetypes'}) {
2931: $checked = ' checked="checked"';
2932: }
2933: $includetypestext = &mt('Include parameter types');
2934: }
2935: } else {
2936: $includetypestext = ' ';
2937: }
2938: my ($additional,$secondid,$thirdid);
2939: if ($context eq 'parmslog') {
2940: $additional =
2941: '<label><input type="'.$includeinput.'" name="includetypes"'.
2942: $checked.' name="includetypes" value="1" id="includetypes" />'.
2943: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2944: '</label>';
2945: $secondid = 'includetypes';
2946: $thirdid = 'includetypestext';
2947: }
2948: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2949: '$secondid','$thirdid')";
2950: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2951: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2952: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2953: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2954: &mt('Filter: [_1]',
1.477 www 2955: &select_form($env{'form.displayfilter'},
2956: 'displayfilter',
1.970 raeburn 2957: {'currentfolder' => 'Current folder/page',
1.477 www 2958: 'containing' => 'Containing phrase',
1.1074 raeburn 2959: 'none' => 'None'},$onchange)).' '.
2960: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2961: &HTML::Entities::encode($env{'form.containingphrase'}).
2962: '" />'.$additional;
2963: }
2964:
2965: sub display_filter_js {
2966: my $includetext = &mt('Include parameter types');
2967: return <<"ENDJS";
2968:
2969: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2970: var firstType = 'hidden';
2971: if (setter.options[setter.selectedIndex].value == 'containing') {
2972: firstType = 'text';
2973: }
2974: firstObject = document.getElementById(firstid);
2975: if (typeof(firstObject) == 'object') {
2976: if (firstObject.type != firstType) {
2977: changeInputType(firstObject,firstType);
2978: }
2979: }
2980: if (context == 'parmslog') {
2981: var secondType = 'hidden';
2982: if (firstType == 'text') {
2983: secondType = 'checkbox';
2984: }
2985: secondObject = document.getElementById(secondid);
2986: if (typeof(secondObject) == 'object') {
2987: if (secondObject.type != secondType) {
2988: changeInputType(secondObject,secondType);
2989: }
2990: }
2991: var textItem = document.getElementById(thirdid);
2992: var currtext = textItem.innerHTML;
2993: var newtext;
2994: if (firstType == 'text') {
2995: newtext = '$includetext';
2996: } else {
2997: newtext = ' ';
2998: }
2999: if (currtext != newtext) {
3000: textItem.innerHTML = newtext;
3001: }
3002: }
3003: return;
3004: }
3005:
3006: function changeInputType(oldObject,newType) {
3007: var newObject = document.createElement('input');
3008: newObject.type = newType;
3009: if (oldObject.size) {
3010: newObject.size = oldObject.size;
3011: }
3012: if (oldObject.value) {
3013: newObject.value = oldObject.value;
3014: }
3015: if (oldObject.name) {
3016: newObject.name = oldObject.name;
3017: }
3018: if (oldObject.id) {
3019: newObject.id = oldObject.id;
3020: }
3021: oldObject.parentNode.replaceChild(newObject,oldObject);
3022: return;
3023: }
3024:
3025: ENDJS
1.475 www 3026: }
3027:
1.167 www 3028: sub gradeleveldescription {
3029: my $gradelevel=shift;
3030: my %gradelevels=(0 => 'Not specified',
3031: 1 => 'Grade 1',
3032: 2 => 'Grade 2',
3033: 3 => 'Grade 3',
3034: 4 => 'Grade 4',
3035: 5 => 'Grade 5',
3036: 6 => 'Grade 6',
3037: 7 => 'Grade 7',
3038: 8 => 'Grade 8',
3039: 9 => 'Grade 9',
3040: 10 => 'Grade 10',
3041: 11 => 'Grade 11',
3042: 12 => 'Grade 12',
3043: 13 => 'Grade 13',
3044: 14 => '100 Level',
3045: 15 => '200 Level',
3046: 16 => '300 Level',
3047: 17 => '400 Level',
3048: 18 => 'Graduate Level');
3049: return &mt($gradelevels{$gradelevel});
3050: }
3051:
1.163 www 3052: sub select_level_form {
3053: my ($deflevel,$name)=@_;
3054: unless ($deflevel) { $deflevel=0; }
1.167 www 3055: my $selectform = "<select name=\"$name\" size=\"1\">\n";
3056: for (my $i=0; $i<=18; $i++) {
3057: $selectform.="<option value=\"$i\" ".
1.253 albertel 3058: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 3059: ">".&gradeleveldescription($i)."</option>\n";
3060: }
3061: $selectform.="</select>";
3062: return $selectform;
1.163 www 3063: }
1.167 www 3064:
1.35 matthew 3065: #-------------------------------------------
3066:
1.45 matthew 3067: =pod
3068:
1.1256 raeburn 3069: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 3070:
3071: Returns a string containing a <select name='$name' size='1'> form to
3072: allow a user to select the domain to preform an operation in.
3073: See loncreateuser.pm for an example invocation and use.
3074:
1.90 www 3075: If the $includeempty flag is set, it also includes an empty choice ("no domain
3076: selected");
3077:
1.743 raeburn 3078: If the $showdomdesc flag is set, the domain name is followed by the domain description.
3079:
1.910 raeburn 3080: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
3081:
1.1121 raeburn 3082: The optional $incdoms is a reference to an array of domains which will be the only available options.
3083:
3084: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 3085:
1.1256 raeburn 3086: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
3087:
1.35 matthew 3088: =cut
3089:
3090: #-------------------------------------------
1.34 matthew 3091: sub select_dom_form {
1.1256 raeburn 3092: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 3093: if ($onchange) {
1.874 raeburn 3094: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 3095: }
1.1256 raeburn 3096: if ($disabled) {
3097: $disabled = ' disabled="disabled"';
3098: }
1.1121 raeburn 3099: my (@domains,%exclude);
1.910 raeburn 3100: if (ref($incdoms) eq 'ARRAY') {
3101: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
3102: } else {
3103: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
3104: }
1.90 www 3105: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 3106: if (ref($excdoms) eq 'ARRAY') {
3107: map { $exclude{$_} = 1; } @{$excdoms};
3108: }
1.1256 raeburn 3109: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 3110: foreach my $dom (@domains) {
1.1121 raeburn 3111: next if ($exclude{$dom});
1.356 albertel 3112: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 3113: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
3114: if ($showdomdesc) {
3115: if ($dom ne '') {
3116: my $domdesc = &Apache::lonnet::domain($dom,'description');
3117: if ($domdesc ne '') {
3118: $selectdomain .= ' ('.$domdesc.')';
3119: }
3120: }
3121: }
3122: $selectdomain .= "</option>\n";
1.34 matthew 3123: }
3124: $selectdomain.="</select>";
3125: return $selectdomain;
3126: }
3127:
1.35 matthew 3128: #-------------------------------------------
3129:
1.45 matthew 3130: =pod
3131:
1.648 raeburn 3132: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 3133:
1.586 raeburn 3134: input: 4 arguments (two required, two optional) -
3135: $domain - domain of new user
3136: $name - name of form element
3137: $default - Value of 'default' causes a default item to be first
3138: option, and selected by default.
3139: $hide - Value of 'hide' causes hiding of the name of the server,
3140: if 1 server found, or default, if 0 found.
1.594 raeburn 3141: output: returns 2 items:
1.586 raeburn 3142: (a) form element which contains either:
3143: (i) <select name="$name">
3144: <option value="$hostid1">$hostid $servers{$hostid}</option>
3145: <option value="$hostid2">$hostid $servers{$hostid}</option>
3146: </select>
3147: form item if there are multiple library servers in $domain, or
3148: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
3149: if there is only one library server in $domain.
3150:
3151: (b) number of library servers found.
3152:
3153: See loncreateuser.pm for example of use.
1.35 matthew 3154:
3155: =cut
3156:
3157: #-------------------------------------------
1.586 raeburn 3158: sub home_server_form_item {
3159: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 3160: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 3161: my $result;
3162: my $numlib = keys(%servers);
3163: if ($numlib > 1) {
3164: $result .= '<select name="'.$name.'" />'."\n";
3165: if ($default) {
1.804 bisitz 3166: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3167: '</option>'."\n";
3168: }
3169: foreach my $hostid (sort(keys(%servers))) {
3170: $result.= '<option value="'.$hostid.'">'.
3171: $hostid.' '.$servers{$hostid}."</option>\n";
3172: }
3173: $result .= '</select>'."\n";
3174: } elsif ($numlib == 1) {
3175: my $hostid;
3176: foreach my $item (keys(%servers)) {
3177: $hostid = $item;
3178: }
3179: $result .= '<input type="hidden" name="'.$name.'" value="'.
3180: $hostid.'" />';
3181: if (!$hide) {
3182: $result .= $hostid.' '.$servers{$hostid};
3183: }
3184: $result .= "\n";
3185: } elsif ($default) {
3186: $result .= '<input type="hidden" name="'.$name.
3187: '" value="default" />';
3188: if (!$hide) {
3189: $result .= &mt('default');
3190: }
3191: $result .= "\n";
1.33 matthew 3192: }
1.586 raeburn 3193: return ($result,$numlib);
1.33 matthew 3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.534 albertel 3198: =back
3199:
1.112 bowersj2 3200: =cut
1.87 matthew 3201:
3202: ###############################################################
1.112 bowersj2 3203: ## Decoding User Agent ##
1.87 matthew 3204: ###############################################################
3205:
3206: =pod
3207:
1.112 bowersj2 3208: =head1 Decoding the User Agent
3209:
3210: =over 4
3211:
3212: =item * &decode_user_agent()
1.87 matthew 3213:
3214: Inputs: $r
3215:
3216: Outputs:
3217:
3218: =over 4
3219:
1.112 bowersj2 3220: =item * $httpbrowser
1.87 matthew 3221:
1.112 bowersj2 3222: =item * $clientbrowser
1.87 matthew 3223:
1.112 bowersj2 3224: =item * $clientversion
1.87 matthew 3225:
1.112 bowersj2 3226: =item * $clientmathml
1.87 matthew 3227:
1.112 bowersj2 3228: =item * $clientunicode
1.87 matthew 3229:
1.112 bowersj2 3230: =item * $clientos
1.87 matthew 3231:
1.1137 raeburn 3232: =item * $clientmobile
3233:
1.1141 raeburn 3234: =item * $clientinfo
3235:
1.1194 raeburn 3236: =item * $clientosversion
3237:
1.87 matthew 3238: =back
3239:
1.157 matthew 3240: =back
3241:
1.87 matthew 3242: =cut
3243:
3244: ###############################################################
3245: ###############################################################
3246: sub decode_user_agent {
1.247 albertel 3247: my ($r)=@_;
1.87 matthew 3248: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3249: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3250: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3251: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3252: my $clientbrowser='unknown';
3253: my $clientversion='0';
3254: my $clientmathml='';
3255: my $clientunicode='0';
1.1137 raeburn 3256: my $clientmobile=0;
1.1194 raeburn 3257: my $clientosversion='';
1.87 matthew 3258: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3259: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3260: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3261: $clientbrowser=$bname;
3262: $httpbrowser=~/$vreg/i;
3263: $clientversion=$1;
3264: $clientmathml=($clientversion>=$minv);
3265: $clientunicode=($clientversion>=$univ);
3266: }
3267: }
3268: my $clientos='unknown';
1.1141 raeburn 3269: my $clientinfo;
1.87 matthew 3270: if (($httpbrowser=~/linux/i) ||
3271: ($httpbrowser=~/unix/i) ||
3272: ($httpbrowser=~/ux/i) ||
3273: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3274: if (($httpbrowser=~/vax/i) ||
3275: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3276: if ($httpbrowser=~/next/i) { $clientos='next'; }
3277: if (($httpbrowser=~/mac/i) ||
3278: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3279: if ($httpbrowser=~/win/i) {
3280: $clientos='win';
3281: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3282: $clientosversion = $1;
3283: }
3284: }
1.87 matthew 3285: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3286: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3287: $clientmobile=lc($1);
3288: }
1.1141 raeburn 3289: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3290: $clientinfo = 'firefox-'.$1;
3291: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3292: $clientinfo = 'chromeframe-'.$1;
3293: }
1.87 matthew 3294: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3295: $clientunicode,$clientos,$clientmobile,$clientinfo,
3296: $clientosversion);
1.87 matthew 3297: }
3298:
1.32 matthew 3299: ###############################################################
3300: ## Authentication changing form generation subroutines ##
3301: ###############################################################
3302: ##
3303: ## All of the authform_xxxxxxx subroutines take their inputs in a
3304: ## hash, and have reasonable default values.
3305: ##
3306: ## formname = the name given in the <form> tag.
1.35 matthew 3307: #-------------------------------------------
3308:
1.45 matthew 3309: =pod
3310:
1.112 bowersj2 3311: =head1 Authentication Routines
3312:
3313: =over 4
3314:
1.648 raeburn 3315: =item * &authform_xxxxxx()
1.35 matthew 3316:
3317: The authform_xxxxxx subroutines provide javascript and html forms which
3318: handle some of the conveniences required for authentication forms.
3319: This is not an optimal method, but it works.
3320:
3321: =over 4
3322:
1.112 bowersj2 3323: =item * authform_header
1.35 matthew 3324:
1.112 bowersj2 3325: =item * authform_authorwarning
1.35 matthew 3326:
1.112 bowersj2 3327: =item * authform_nochange
1.35 matthew 3328:
1.112 bowersj2 3329: =item * authform_kerberos
1.35 matthew 3330:
1.112 bowersj2 3331: =item * authform_internal
1.35 matthew 3332:
1.112 bowersj2 3333: =item * authform_filesystem
1.35 matthew 3334:
1.1310 raeburn 3335: =item * authform_lti
3336:
1.35 matthew 3337: =back
3338:
1.648 raeburn 3339: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3340:
1.35 matthew 3341: =cut
3342:
3343: #-------------------------------------------
1.32 matthew 3344: sub authform_header{
3345: my %in = (
3346: formname => 'cu',
1.80 albertel 3347: kerb_def_dom => '',
1.32 matthew 3348: @_,
3349: );
3350: $in{'formname'} = 'document.' . $in{'formname'};
3351: my $result='';
1.80 albertel 3352:
3353: #---------------------------------------------- Code for upper case translation
3354: my $Javascript_toUpperCase;
3355: unless ($in{kerb_def_dom}) {
3356: $Javascript_toUpperCase =<<"END";
3357: switch (choice) {
3358: case 'krb': currentform.elements[choicearg].value =
3359: currentform.elements[choicearg].value.toUpperCase();
3360: break;
3361: default:
3362: }
3363: END
3364: } else {
3365: $Javascript_toUpperCase = "";
3366: }
3367:
1.165 raeburn 3368: my $radioval = "'nochange'";
1.591 raeburn 3369: if (defined($in{'curr_authtype'})) {
3370: if ($in{'curr_authtype'} ne '') {
3371: $radioval = "'".$in{'curr_authtype'}."arg'";
3372: }
1.174 matthew 3373: }
1.165 raeburn 3374: my $argfield = 'null';
1.591 raeburn 3375: if (defined($in{'mode'})) {
1.165 raeburn 3376: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3377: if (defined($in{'curr_autharg'})) {
3378: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3379: $argfield = "'$in{'curr_autharg'}'";
3380: }
3381: }
3382: }
3383: }
3384:
1.32 matthew 3385: $result.=<<"END";
3386: var current = new Object();
1.165 raeburn 3387: current.radiovalue = $radioval;
3388: current.argfield = $argfield;
1.32 matthew 3389:
3390: function changed_radio(choice,currentform) {
3391: var choicearg = choice + 'arg';
3392: // If a radio button in changed, we need to change the argfield
3393: if (current.radiovalue != choice) {
3394: current.radiovalue = choice;
3395: if (current.argfield != null) {
3396: currentform.elements[current.argfield].value = '';
3397: }
3398: if (choice == 'nochange') {
3399: current.argfield = null;
3400: } else {
3401: current.argfield = choicearg;
3402: switch(choice) {
3403: case 'krb':
3404: currentform.elements[current.argfield].value =
3405: "$in{'kerb_def_dom'}";
3406: break;
3407: default:
3408: break;
3409: }
3410: }
3411: }
3412: return;
3413: }
1.22 www 3414:
1.32 matthew 3415: function changed_text(choice,currentform) {
3416: var choicearg = choice + 'arg';
3417: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3418: $Javascript_toUpperCase
1.32 matthew 3419: // clear old field
3420: if ((current.argfield != choicearg) && (current.argfield != null)) {
3421: currentform.elements[current.argfield].value = '';
3422: }
3423: current.argfield = choicearg;
3424: }
3425: set_auth_radio_buttons(choice,currentform);
3426: return;
1.20 www 3427: }
1.32 matthew 3428:
3429: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3430: var numauthchoices = currentform.login.length;
3431: if (typeof numauthchoices == "undefined") {
3432: return;
3433: }
1.32 matthew 3434: var i=0;
1.986 raeburn 3435: while (i < numauthchoices) {
1.32 matthew 3436: if (currentform.login[i].value == newvalue) { break; }
3437: i++;
3438: }
1.986 raeburn 3439: if (i == numauthchoices) {
1.32 matthew 3440: return;
3441: }
3442: current.radiovalue = newvalue;
3443: currentform.login[i].checked = true;
3444: return;
3445: }
3446: END
3447: return $result;
3448: }
3449:
1.1106 raeburn 3450: sub authform_authorwarning {
1.32 matthew 3451: my $result='';
1.144 matthew 3452: $result='<i>'.
3453: &mt('As a general rule, only authors or co-authors should be '.
3454: 'filesystem authenticated '.
3455: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3456: return $result;
3457: }
3458:
1.1106 raeburn 3459: sub authform_nochange {
1.32 matthew 3460: my %in = (
3461: formname => 'document.cu',
3462: kerb_def_dom => 'MSU.EDU',
3463: @_,
3464: );
1.1106 raeburn 3465: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3466: my $result;
1.1104 raeburn 3467: if (!$authnum) {
1.1105 raeburn 3468: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3469: } else {
3470: $result = '<label>'.&mt('[_1] Do not change login data',
3471: '<input type="radio" name="login" value="nochange" '.
3472: 'checked="checked" onclick="'.
1.281 albertel 3473: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3474: '</label>';
1.586 raeburn 3475: }
1.32 matthew 3476: return $result;
3477: }
3478:
1.591 raeburn 3479: sub authform_kerberos {
1.32 matthew 3480: my %in = (
3481: formname => 'document.cu',
3482: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3483: kerb_def_auth => 'krb4',
1.32 matthew 3484: @_,
3485: );
1.586 raeburn 3486: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3487: $autharg,$jscall,$disabled);
1.1106 raeburn 3488: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3489: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3490: $check5 = ' checked="checked"';
1.80 albertel 3491: } else {
1.772 bisitz 3492: $check4 = ' checked="checked"';
1.80 albertel 3493: }
1.1259 raeburn 3494: if ($in{'readonly'}) {
3495: $disabled = ' disabled="disabled"';
3496: }
1.165 raeburn 3497: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3498: if (defined($in{'curr_authtype'})) {
3499: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3500: $krbcheck = ' checked="checked"';
1.623 raeburn 3501: if (defined($in{'mode'})) {
3502: if ($in{'mode'} eq 'modifyuser') {
3503: $krbcheck = '';
3504: }
3505: }
1.591 raeburn 3506: if (defined($in{'curr_kerb_ver'})) {
3507: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3508: $check5 = ' checked="checked"';
1.591 raeburn 3509: $check4 = '';
3510: } else {
1.772 bisitz 3511: $check4 = ' checked="checked"';
1.591 raeburn 3512: $check5 = '';
3513: }
1.586 raeburn 3514: }
1.591 raeburn 3515: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3516: $krbarg = $in{'curr_autharg'};
3517: }
1.586 raeburn 3518: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3519: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3520: $result =
3521: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3522: $in{'curr_autharg'},$krbver);
3523: } else {
3524: $result =
3525: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3526: }
3527: return $result;
3528: }
3529: }
3530: } else {
3531: if ($authnum == 1) {
1.784 bisitz 3532: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3533: }
3534: }
1.586 raeburn 3535: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3536: return;
1.587 raeburn 3537: } elsif ($authtype eq '') {
1.591 raeburn 3538: if (defined($in{'mode'})) {
1.587 raeburn 3539: if ($in{'mode'} eq 'modifycourse') {
3540: if ($authnum == 1) {
1.1259 raeburn 3541: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3542: }
3543: }
3544: }
1.586 raeburn 3545: }
3546: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3547: if ($authtype eq '') {
3548: $authtype = '<input type="radio" name="login" value="krb" '.
3549: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3550: $krbcheck.$disabled.' />';
1.586 raeburn 3551: }
3552: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3553: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3554: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3555: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3556: $in{'curr_authtype'} eq 'krb4')) {
3557: $result .= &mt
1.144 matthew 3558: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3559: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3560: '<label>'.$authtype,
1.281 albertel 3561: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3562: 'value="'.$krbarg.'" '.
1.1259 raeburn 3563: 'onchange="'.$jscall.'"'.$disabled.' />',
3564: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3565: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3566: '</label>');
1.586 raeburn 3567: } elsif ($can_assign{'krb4'}) {
3568: $result .= &mt
3569: ('[_1] Kerberos authenticated with domain [_2] '.
3570: '[_3] Version 4 [_4]',
3571: '<label>'.$authtype,
3572: '</label><input type="text" size="10" name="krbarg" '.
3573: 'value="'.$krbarg.'" '.
1.1259 raeburn 3574: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3575: '<label><input type="hidden" name="krbver" value="4" />',
3576: '</label>');
3577: } elsif ($can_assign{'krb5'}) {
3578: $result .= &mt
3579: ('[_1] Kerberos authenticated with domain [_2] '.
3580: '[_3] Version 5 [_4]',
3581: '<label>'.$authtype,
3582: '</label><input type="text" size="10" name="krbarg" '.
3583: 'value="'.$krbarg.'" '.
1.1259 raeburn 3584: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3585: '<label><input type="hidden" name="krbver" value="5" />',
3586: '</label>');
3587: }
1.32 matthew 3588: return $result;
3589: }
3590:
1.1106 raeburn 3591: sub authform_internal {
1.586 raeburn 3592: my %in = (
1.32 matthew 3593: formname => 'document.cu',
3594: kerb_def_dom => 'MSU.EDU',
3595: @_,
3596: );
1.1259 raeburn 3597: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3598: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3599: if ($in{'readonly'}) {
3600: $disabled = ' disabled="disabled"';
3601: }
1.591 raeburn 3602: if (defined($in{'curr_authtype'})) {
3603: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3604: if ($can_assign{'int'}) {
1.772 bisitz 3605: $intcheck = 'checked="checked" ';
1.623 raeburn 3606: if (defined($in{'mode'})) {
3607: if ($in{'mode'} eq 'modifyuser') {
3608: $intcheck = '';
3609: }
3610: }
1.591 raeburn 3611: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3612: $intarg = $in{'curr_autharg'};
3613: }
3614: } else {
3615: $result = &mt('Currently internally authenticated.');
3616: return $result;
1.165 raeburn 3617: }
3618: }
1.586 raeburn 3619: } else {
3620: if ($authnum == 1) {
1.784 bisitz 3621: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3622: }
3623: }
3624: if (!$can_assign{'int'}) {
3625: return;
1.587 raeburn 3626: } elsif ($authtype eq '') {
1.591 raeburn 3627: if (defined($in{'mode'})) {
1.587 raeburn 3628: if ($in{'mode'} eq 'modifycourse') {
3629: if ($authnum == 1) {
1.1259 raeburn 3630: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3631: }
3632: }
3633: }
1.165 raeburn 3634: }
1.586 raeburn 3635: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3636: if ($authtype eq '') {
3637: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3638: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3639: }
1.605 bisitz 3640: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3641: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3642: $result = &mt
1.144 matthew 3643: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3644: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3645: $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32 matthew 3646: return $result;
3647: }
3648:
1.1104 raeburn 3649: sub authform_local {
1.32 matthew 3650: my %in = (
3651: formname => 'document.cu',
3652: kerb_def_dom => 'MSU.EDU',
3653: @_,
3654: );
1.1259 raeburn 3655: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3656: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3657: if ($in{'readonly'}) {
3658: $disabled = ' disabled="disabled"';
3659: }
1.591 raeburn 3660: if (defined($in{'curr_authtype'})) {
3661: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3662: if ($can_assign{'loc'}) {
1.772 bisitz 3663: $loccheck = 'checked="checked" ';
1.623 raeburn 3664: if (defined($in{'mode'})) {
3665: if ($in{'mode'} eq 'modifyuser') {
3666: $loccheck = '';
3667: }
3668: }
1.591 raeburn 3669: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3670: $locarg = $in{'curr_autharg'};
3671: }
3672: } else {
3673: $result = &mt('Currently using local (institutional) authentication.');
3674: return $result;
1.165 raeburn 3675: }
3676: }
1.586 raeburn 3677: } else {
3678: if ($authnum == 1) {
1.784 bisitz 3679: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3680: }
3681: }
3682: if (!$can_assign{'loc'}) {
3683: return;
1.587 raeburn 3684: } elsif ($authtype eq '') {
1.591 raeburn 3685: if (defined($in{'mode'})) {
1.587 raeburn 3686: if ($in{'mode'} eq 'modifycourse') {
3687: if ($authnum == 1) {
1.1259 raeburn 3688: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3689: }
3690: }
3691: }
1.165 raeburn 3692: }
1.586 raeburn 3693: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3694: if ($authtype eq '') {
3695: $authtype = '<input type="radio" name="login" value="loc" '.
3696: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3697: $jscall.'"'.$disabled.' />';
1.586 raeburn 3698: }
3699: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3700: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3701: $result = &mt('[_1] Local Authentication with argument [_2]',
3702: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3703: return $result;
3704: }
3705:
1.1106 raeburn 3706: sub authform_filesystem {
1.32 matthew 3707: my %in = (
3708: formname => 'document.cu',
3709: kerb_def_dom => 'MSU.EDU',
3710: @_,
3711: );
1.1259 raeburn 3712: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3713: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3714: if ($in{'readonly'}) {
3715: $disabled = ' disabled="disabled"';
3716: }
1.591 raeburn 3717: if (defined($in{'curr_authtype'})) {
3718: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3719: if ($can_assign{'fsys'}) {
1.772 bisitz 3720: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3721: if (defined($in{'mode'})) {
3722: if ($in{'mode'} eq 'modifyuser') {
3723: $fsyscheck = '';
3724: }
3725: }
1.586 raeburn 3726: } else {
3727: $result = &mt('Currently Filesystem Authenticated.');
3728: return $result;
1.1259 raeburn 3729: }
1.586 raeburn 3730: }
3731: } else {
3732: if ($authnum == 1) {
1.784 bisitz 3733: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3734: }
3735: }
3736: if (!$can_assign{'fsys'}) {
3737: return;
1.587 raeburn 3738: } elsif ($authtype eq '') {
1.591 raeburn 3739: if (defined($in{'mode'})) {
1.587 raeburn 3740: if ($in{'mode'} eq 'modifycourse') {
3741: if ($authnum == 1) {
1.1259 raeburn 3742: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3743: }
3744: }
3745: }
1.586 raeburn 3746: }
3747: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3748: if ($authtype eq '') {
3749: $authtype = '<input type="radio" name="login" value="fsys" '.
3750: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3751: $jscall.'"'.$disabled.' />';
1.586 raeburn 3752: }
1.1310 raeburn 3753: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3754: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3755: $result = &mt
1.144 matthew 3756: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3757: '<label>'.$authtype,'</label>'.$autharg);
3758: return $result;
3759: }
3760:
3761: sub authform_lti {
3762: my %in = (
3763: formname => 'document.cu',
3764: kerb_def_dom => 'MSU.EDU',
3765: @_,
3766: );
3767: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3768: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3769: if ($in{'readonly'}) {
3770: $disabled = ' disabled="disabled"';
3771: }
3772: if (defined($in{'curr_authtype'})) {
3773: if ($in{'curr_authtype'} eq 'lti') {
3774: if ($can_assign{'lti'}) {
3775: $lticheck = 'checked="checked" ';
3776: if (defined($in{'mode'})) {
3777: if ($in{'mode'} eq 'modifyuser') {
3778: $lticheck = '';
3779: }
3780: }
3781: } else {
3782: $result = &mt('Currently LTI Authenticated.');
3783: return $result;
3784: }
3785: }
3786: } else {
3787: if ($authnum == 1) {
3788: $authtype = '<input type="hidden" name="login" value="lti" />';
3789: }
3790: }
3791: if (!$can_assign{'lti'}) {
3792: return;
3793: } elsif ($authtype eq '') {
3794: if (defined($in{'mode'})) {
3795: if ($in{'mode'} eq 'modifycourse') {
3796: if ($authnum == 1) {
3797: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3798: }
3799: }
3800: }
3801: }
3802: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3803: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3804: $authtype = '<input type="radio" name="login" value="lti" '.
3805: $lticheck.' onchange="'.$jscall.'" onclick="'.
3806: $jscall.'"'.$disabled.' />';
3807: }
3808: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3809: if ($authtype) {
3810: $result = &mt('[_1] LTI Authenticated',
3811: '<label>'.$authtype.'</label>'.$autharg);
3812: } else {
3813: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3814: $autharg;
3815: }
1.32 matthew 3816: return $result;
3817: }
3818:
1.586 raeburn 3819: sub get_assignable_auth {
3820: my ($dom) = @_;
3821: if ($dom eq '') {
3822: $dom = $env{'request.role.domain'};
3823: }
3824: my %can_assign = (
3825: krb4 => 1,
3826: krb5 => 1,
3827: int => 1,
3828: loc => 1,
1.1310 raeburn 3829: lti => 1,
1.586 raeburn 3830: );
3831: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3832: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3833: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3834: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3835: my $context;
3836: if ($env{'request.role'} =~ /^au/) {
3837: $context = 'author';
1.1259 raeburn 3838: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3839: $context = 'domain';
3840: } elsif ($env{'request.course.id'}) {
3841: $context = 'course';
3842: }
3843: if ($context) {
3844: if (ref($authhash->{$context}) eq 'HASH') {
3845: %can_assign = %{$authhash->{$context}};
3846: }
3847: }
3848: }
3849: }
3850: my $authnum = 0;
3851: foreach my $key (keys(%can_assign)) {
3852: if ($can_assign{$key}) {
3853: $authnum ++;
3854: }
3855: }
3856: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3857: $authnum --;
3858: }
3859: return ($authnum,%can_assign);
3860: }
3861:
1.1331 raeburn 3862: sub check_passwd_rules {
3863: my ($domain,$plainpass) = @_;
3864: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3865: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3866: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3867: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3868: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3869: if ($passwdconf{'min'} > $min) {
3870: $min = $passwdconf{'min'};
3871: }
1.1331 raeburn 3872: }
3873: if ($passwdconf{'max'} =~ /^\d+$/) {
3874: $max = $passwdconf{'max'};
3875: }
3876: @chars = @{$passwdconf{'chars'}};
3877: }
3878: if (($min) && (length($plainpass) < $min)) {
3879: push(@brokerule,'min');
3880: }
3881: if (($max) && (length($plainpass) > $max)) {
3882: push(@brokerule,'max');
3883: }
3884: if (@chars) {
3885: my %rules;
3886: map { $rules{$_} = 1; } @chars;
3887: if ($rules{'uc'}) {
3888: unless ($plainpass =~ /[A-Z]/) {
3889: push(@brokerule,'uc');
3890: }
3891: }
3892: if ($rules{'lc'}) {
1.1332 raeburn 3893: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3894: push(@brokerule,'lc');
3895: }
3896: }
3897: if ($rules{'num'}) {
3898: unless ($plainpass =~ /\d/) {
3899: push(@brokerule,'num');
3900: }
3901: }
3902: if ($rules{'spec'}) {
3903: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3904: push(@brokerule,'spec');
3905: }
3906: }
3907: }
3908: if (@brokerule) {
3909: my %rulenames = &Apache::lonlocal::texthash(
3910: uc => 'At least one upper case letter',
3911: lc => 'At least one lower case letter',
3912: num => 'At least one number',
3913: spec => 'At least one non-alphanumeric',
3914: );
3915: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3916: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3917: $rulenames{'num'} .= ': 0123456789';
3918: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3919: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3920: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3921: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3922: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3923: if (grep(/^$rule$/,@brokerule)) {
3924: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3925: }
3926: }
3927: $warning .= '</ul>';
3928: }
1.1332 raeburn 3929: if (wantarray) {
3930: return @brokerule;
3931: }
1.1331 raeburn 3932: return $warning;
3933: }
3934:
1.1376 raeburn 3935: sub passwd_validation_js {
1.1377 raeburn 3936: my ($currpasswdval,$domain,$context,$id) = @_;
3937: my (%passwdconf,$alertmsg);
3938: if ($context eq 'linkprot') {
3939: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3940: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3941: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3942: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3943: }
3944: }
3945: if ($id eq 'add') {
3946: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3947: } elsif ($id =~ /^\d+$/) {
3948: my $pos = $id+1;
3949: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3950: } else {
3951: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3952: }
1.1434 raeburn 3953: } elsif ($context eq 'ltitools') {
3954: my %domconfig = &Apache::lonnet::get_dom('configuration',['toolsec'],$domain);
3955: if (ref($domconfig{'toolsec'}) eq 'HASH') {
3956: if (ref($domconfig{'toolsec'}{'rules'}) eq 'HASH') {
3957: %passwdconf = %{$domconfig{'toolsec'}{'rules'}};
3958: }
3959: }
3960: if ($id eq 'add') {
3961: $alertmsg = &mt('Secret for added external tool did not satisfy requirement(s):').'\n\n';
3962: } elsif ($id =~ /^\d+$/) {
3963: my $pos = $id+1;
3964: $alertmsg = &mt('Secret for external tool [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3965: } else {
3966: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3967: }
1.1377 raeburn 3968: } else {
3969: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3970: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3971: }
1.1376 raeburn 3972: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3973: $numrules = 0;
3974: $min = $Apache::lonnet::passwdmin;
3975: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3976: if ($passwdconf{'min'} =~ /^\d+$/) {
3977: if ($passwdconf{'min'} > $min) {
3978: $min = $passwdconf{'min'};
3979: }
3980: }
3981: if ($passwdconf{'max'} =~ /^\d+$/) {
3982: $max = $passwdconf{'max'};
3983: $numrules ++;
3984: }
3985: @chars = @{$passwdconf{'chars'}};
3986: if (@chars) {
3987: $numrules ++;
3988: }
3989: }
3990: if ($min > 0) {
3991: $numrules ++;
3992: }
3993: if (($min > 0) || ($max ne '') || (@chars > 0)) {
3994: if ($min) {
3995: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3996: }
3997: if ($max) {
3998: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3999: }
4000: my (@charalerts,@charrules);
4001: if (@chars) {
4002: if (grep(/^uc$/,@chars)) {
4003: push(@charalerts,&mt('contain at least one upper case letter'));
4004: push(@charrules,'uc');
4005: }
4006: if (grep(/^lc$/,@chars)) {
4007: push(@charalerts,&mt('contain at least one lower case letter'));
4008: push(@charrules,'lc');
4009: }
4010: if (grep(/^num$/,@chars)) {
4011: push(@charalerts,&mt('contain at least one number'));
4012: push(@charrules,'num');
4013: }
4014: if (grep(/^spec$/,@chars)) {
4015: push(@charalerts,&mt('contain at least one non-alphanumeric'));
4016: push(@charrules,'spec');
4017: }
4018: }
4019: $intargjs = qq| var rulesmsg = '';\n|.
4020: qq| var currpwval = $currpasswdval;\n|;
4021: if ($min) {
4022: $intargjs .= qq|
4023: if (currpwval.length < $min) {
4024: rulesmsg += ' - $alert{min}';
4025: }
4026: |;
4027: }
4028: if ($max) {
4029: $intargjs .= qq|
4030: if (currpwval.length > $max) {
4031: rulesmsg += ' - $alert{max}';
4032: }
4033: |;
4034: }
4035: if (@chars > 0) {
4036: my $charrulestr = '"'.join('","',@charrules).'"';
4037: my $charalertstr = '"'.join('","',@charalerts).'"';
4038: $intargjs .= qq| var brokerules = new Array();\n|.
4039: qq| var charrules = new Array($charrulestr);\n|.
4040: qq| var charalerts = new Array($charalertstr);\n|;
4041: my %rules;
4042: map { $rules{$_} = 1; } @chars;
4043: if ($rules{'uc'}) {
4044: $intargjs .= qq|
4045: var ucRegExp = /[A-Z]/;
4046: if (!ucRegExp.test(currpwval)) {
4047: brokerules.push('uc');
4048: }
4049: |;
4050: }
4051: if ($rules{'lc'}) {
4052: $intargjs .= qq|
4053: var lcRegExp = /[a-z]/;
4054: if (!lcRegExp.test(currpwval)) {
4055: brokerules.push('lc');
4056: }
4057: |;
4058: }
4059: if ($rules{'num'}) {
4060: $intargjs .= qq|
4061: var numRegExp = /[0-9]/;
4062: if (!numRegExp.test(currpwval)) {
4063: brokerules.push('num');
4064: }
4065: |;
4066: }
4067: if ($rules{'spec'}) {
4068: $intargjs .= q|
4069: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
4070: if (!specRegExp.test(currpwval)) {
4071: brokerules.push('spec');
4072: }
4073: |;
4074: }
4075: $intargjs .= qq|
4076: if (brokerules.length > 0) {
4077: for (var i=0; i<brokerules.length; i++) {
4078: for (var j=0; j<charrules.length; j++) {
4079: if (brokerules[i] == charrules[j]) {
4080: rulesmsg += ' - '+charalerts[j]+'\\n';
4081: break;
4082: }
4083: }
4084: }
4085: }
4086: |;
4087: }
4088: $intargjs .= qq|
4089: if (rulesmsg != '') {
4090: rulesmsg = '$alertmsg'+rulesmsg;
4091: alert(rulesmsg);
4092: return false;
4093: }
4094: |;
4095: }
4096: return ($numrules,$intargjs);
4097: }
4098:
1.80 albertel 4099: ###############################################################
4100: ## Get Kerberos Defaults for Domain ##
4101: ###############################################################
4102: ##
4103: ## Returns default kerberos version and an associated argument
4104: ## as listed in file domain.tab. If not listed, provides
4105: ## appropriate default domain and kerberos version.
4106: ##
4107: #-------------------------------------------
4108:
4109: =pod
4110:
1.648 raeburn 4111: =item * &get_kerberos_defaults()
1.80 albertel 4112:
4113: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 4114: version and domain. If not found, it defaults to version 4 and the
4115: domain of the server.
1.80 albertel 4116:
1.648 raeburn 4117: =over 4
4118:
1.80 albertel 4119: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
4120:
1.648 raeburn 4121: =back
4122:
4123: =back
4124:
1.80 albertel 4125: =cut
4126:
4127: #-------------------------------------------
4128: sub get_kerberos_defaults {
4129: my $domain=shift;
1.641 raeburn 4130: my ($krbdef,$krbdefdom);
4131: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
4132: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
4133: $krbdef = $domdefaults{'auth_def'};
4134: $krbdefdom = $domdefaults{'auth_arg_def'};
4135: } else {
1.80 albertel 4136: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
4137: my $krbdefdom=$1;
4138: $krbdefdom=~tr/a-z/A-Z/;
4139: $krbdef = "krb4";
4140: }
4141: return ($krbdef,$krbdefdom);
4142: }
1.112 bowersj2 4143:
1.32 matthew 4144:
1.46 matthew 4145: ###############################################################
4146: ## Thesaurus Functions ##
4147: ###############################################################
1.20 www 4148:
1.46 matthew 4149: =pod
1.20 www 4150:
1.112 bowersj2 4151: =head1 Thesaurus Functions
4152:
4153: =over 4
4154:
1.648 raeburn 4155: =item * &initialize_keywords()
1.46 matthew 4156:
4157: Initializes the package variable %Keywords if it is empty. Uses the
4158: package variable $thesaurus_db_file.
4159:
4160: =cut
4161:
4162: ###################################################
4163:
4164: sub initialize_keywords {
4165: return 1 if (scalar keys(%Keywords));
4166: # If we are here, %Keywords is empty, so fill it up
4167: # Make sure the file we need exists...
4168: if (! -e $thesaurus_db_file) {
4169: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
4170: " failed because it does not exist");
4171: return 0;
4172: }
4173: # Set up the hash as a database
4174: my %thesaurus_db;
4175: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4176: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4177: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
4178: $thesaurus_db_file);
4179: return 0;
4180: }
4181: # Get the average number of appearances of a word.
4182: my $avecount = $thesaurus_db{'average.count'};
4183: # Put keywords (those that appear > average) into %Keywords
4184: while (my ($word,$data)=each (%thesaurus_db)) {
4185: my ($count,undef) = split /:/,$data;
4186: $Keywords{$word}++ if ($count > $avecount);
4187: }
4188: untie %thesaurus_db;
4189: # Remove special values from %Keywords.
1.356 albertel 4190: foreach my $value ('total.count','average.count') {
4191: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4192: }
1.46 matthew 4193: return 1;
4194: }
4195:
4196: ###################################################
4197:
4198: =pod
4199:
1.648 raeburn 4200: =item * &keyword($word)
1.46 matthew 4201:
4202: Returns true if $word is a keyword. A keyword is a word that appears more
4203: than the average number of times in the thesaurus database. Calls
4204: &initialize_keywords
4205:
4206: =cut
4207:
4208: ###################################################
1.20 www 4209:
4210: sub keyword {
1.46 matthew 4211: return if (!&initialize_keywords());
4212: my $word=lc(shift());
4213: $word=~s/\W//g;
4214: return exists($Keywords{$word});
1.20 www 4215: }
1.46 matthew 4216:
4217: ###############################################################
4218:
4219: =pod
1.20 www 4220:
1.648 raeburn 4221: =item * &get_related_words()
1.46 matthew 4222:
1.160 matthew 4223: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4224: an array of words. If the keyword is not in the thesaurus, an empty array
4225: will be returned. The order of the words returned is determined by the
4226: database which holds them.
4227:
4228: Uses global $thesaurus_db_file.
4229:
1.1057 foxr 4230:
1.46 matthew 4231: =cut
4232:
4233: ###############################################################
4234: sub get_related_words {
4235: my $keyword = shift;
4236: my %thesaurus_db;
4237: if (! -e $thesaurus_db_file) {
4238: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4239: "failed because the file does not exist");
4240: return ();
4241: }
4242: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4243: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4244: return ();
4245: }
4246: my @Words=();
1.429 www 4247: my $count=0;
1.46 matthew 4248: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4249: # The first element is the number of times
4250: # the word appears. We do not need it now.
1.429 www 4251: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4252: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4253: my $threshold=$mostfrequentcount/10;
4254: foreach my $possibleword (@RelatedWords) {
4255: my ($word,$wordcount)=split(/\,/,$possibleword);
4256: if ($wordcount>$threshold) {
4257: push(@Words,$word);
4258: $count++;
4259: if ($count>10) { last; }
4260: }
1.20 www 4261: }
4262: }
1.46 matthew 4263: untie %thesaurus_db;
4264: return @Words;
1.14 harris41 4265: }
1.1090 foxr 4266: ###############################################################
4267: #
4268: # Spell checking
4269: #
4270:
4271: =pod
4272:
1.1142 raeburn 4273: =back
4274:
1.1090 foxr 4275: =head1 Spell checking
4276:
4277: =over 4
4278:
4279: =item * &check_spelling($wordlist $language)
4280:
4281: Takes a string containing words and feeds it to an external
4282: spellcheck program via a pipeline. Returns a string containing
4283: them mis-spelled words.
4284:
4285: Parameters:
4286:
4287: =over 4
4288:
4289: =item - $wordlist
4290:
4291: String that will be fed into the spellcheck program.
4292:
4293: =item - $language
4294:
4295: Language string that specifies the language for which the spell
4296: check will be performed.
4297:
4298: =back
4299:
4300: =back
4301:
4302: Note: This sub assumes that aspell is installed.
4303:
4304:
4305: =cut
4306:
1.46 matthew 4307:
1.1090 foxr 4308: sub check_spelling {
4309: my ($wordlist, $language) = @_;
1.1091 foxr 4310: my @misspellings;
4311:
4312: # Generate the speller and set the langauge.
4313: # if explicitly selected:
1.1090 foxr 4314:
1.1091 foxr 4315: my $speller = Text::Aspell->new;
1.1090 foxr 4316: if ($language) {
1.1091 foxr 4317: $speller->set_option('lang', $language);
1.1090 foxr 4318: }
4319:
1.1091 foxr 4320: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4321:
1.1091 foxr 4322: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4323:
1.1091 foxr 4324: foreach my $word (@words) {
4325: if(! $speller->check($word)) {
4326: push(@misspellings, $word);
1.1090 foxr 4327: }
4328: }
1.1091 foxr 4329: return join(' ', @misspellings);
4330:
1.1090 foxr 4331: }
4332:
1.61 www 4333: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4334: =pod
4335:
1.112 bowersj2 4336: =head1 User Name Functions
4337:
4338: =over 4
4339:
1.648 raeburn 4340: =item * &plainname($uname,$udom,$first)
1.81 albertel 4341:
1.112 bowersj2 4342: Takes a users logon name and returns it as a string in
1.226 albertel 4343: "first middle last generation" form
4344: if $first is set to 'lastname' then it returns it as
4345: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4346:
4347: =cut
1.61 www 4348:
1.295 www 4349:
1.81 albertel 4350: ###############################################################
1.61 www 4351: sub plainname {
1.226 albertel 4352: my ($uname,$udom,$first)=@_;
1.537 albertel 4353: return if (!defined($uname) || !defined($udom));
1.295 www 4354: my %names=&getnames($uname,$udom);
1.226 albertel 4355: my $name=&Apache::lonnet::format_name($names{'firstname'},
4356: $names{'middlename'},
4357: $names{'lastname'},
4358: $names{'generation'},$first);
4359: $name=~s/^\s+//;
1.62 www 4360: $name=~s/\s+$//;
4361: $name=~s/\s+/ /g;
1.353 albertel 4362: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4363: return $name;
1.61 www 4364: }
1.66 www 4365:
4366: # -------------------------------------------------------------------- Nickname
1.81 albertel 4367: =pod
4368:
1.648 raeburn 4369: =item * &nickname($uname,$udom)
1.81 albertel 4370:
4371: Gets a users name and returns it as a string as
4372:
4373: ""nickname""
1.66 www 4374:
1.81 albertel 4375: if the user has a nickname or
4376:
4377: "first middle last generation"
4378:
4379: if the user does not
4380:
4381: =cut
1.66 www 4382:
4383: sub nickname {
4384: my ($uname,$udom)=@_;
1.537 albertel 4385: return if (!defined($uname) || !defined($udom));
1.295 www 4386: my %names=&getnames($uname,$udom);
1.68 albertel 4387: my $name=$names{'nickname'};
1.66 www 4388: if ($name) {
4389: $name='"'.$name.'"';
4390: } else {
4391: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4392: $names{'lastname'}.' '.$names{'generation'};
4393: $name=~s/\s+$//;
4394: $name=~s/\s+/ /g;
4395: }
4396: return $name;
4397: }
4398:
1.295 www 4399: sub getnames {
4400: my ($uname,$udom)=@_;
1.537 albertel 4401: return if (!defined($uname) || !defined($udom));
1.433 albertel 4402: if ($udom eq 'public' && $uname eq 'public') {
4403: return ('lastname' => &mt('Public'));
4404: }
1.295 www 4405: my $id=$uname.':'.$udom;
4406: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4407: if ($cached) {
4408: return %{$names};
4409: } else {
4410: my %loadnames=&Apache::lonnet::get('environment',
4411: ['firstname','middlename','lastname','generation','nickname'],
4412: $udom,$uname);
4413: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4414: return %loadnames;
4415: }
4416: }
1.61 www 4417:
1.542 raeburn 4418: # -------------------------------------------------------------------- getemails
1.648 raeburn 4419:
1.542 raeburn 4420: =pod
4421:
1.648 raeburn 4422: =item * &getemails($uname,$udom)
1.542 raeburn 4423:
4424: Gets a user's email information and returns it as a hash with keys:
4425: notification, critnotification, permanentemail
4426:
4427: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4428: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4429:
1.648 raeburn 4430:
1.542 raeburn 4431: =cut
4432:
1.648 raeburn 4433:
1.466 albertel 4434: sub getemails {
4435: my ($uname,$udom)=@_;
4436: if ($udom eq 'public' && $uname eq 'public') {
4437: return;
4438: }
1.467 www 4439: if (!$udom) { $udom=$env{'user.domain'}; }
4440: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4441: my $id=$uname.':'.$udom;
4442: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4443: if ($cached) {
4444: return %{$names};
4445: } else {
4446: my %loadnames=&Apache::lonnet::get('environment',
4447: ['notification','critnotification',
4448: 'permanentemail'],
4449: $udom,$uname);
4450: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4451: return %loadnames;
4452: }
4453: }
4454:
1.551 albertel 4455: sub flush_email_cache {
4456: my ($uname,$udom)=@_;
4457: if (!$udom) { $udom =$env{'user.domain'}; }
4458: if (!$uname) { $uname=$env{'user.name'}; }
4459: return if ($udom eq 'public' && $uname eq 'public');
4460: my $id=$uname.':'.$udom;
4461: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4462: }
4463:
1.728 raeburn 4464: # -------------------------------------------------------------------- getlangs
4465:
4466: =pod
4467:
4468: =item * &getlangs($uname,$udom)
4469:
4470: Gets a user's language preference and returns it as a hash with key:
4471: language.
4472:
4473: =cut
4474:
4475:
4476: sub getlangs {
4477: my ($uname,$udom) = @_;
4478: if (!$udom) { $udom =$env{'user.domain'}; }
4479: if (!$uname) { $uname=$env{'user.name'}; }
4480: my $id=$uname.':'.$udom;
4481: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4482: if ($cached) {
4483: return %{$langs};
4484: } else {
4485: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4486: $udom,$uname);
4487: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4488: return %loadlangs;
4489: }
4490: }
4491:
4492: sub flush_langs_cache {
4493: my ($uname,$udom)=@_;
4494: if (!$udom) { $udom =$env{'user.domain'}; }
4495: if (!$uname) { $uname=$env{'user.name'}; }
4496: return if ($udom eq 'public' && $uname eq 'public');
4497: my $id=$uname.':'.$udom;
4498: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4499: }
4500:
1.61 www 4501: # ------------------------------------------------------------------ Screenname
1.81 albertel 4502:
4503: =pod
4504:
1.648 raeburn 4505: =item * &screenname($uname,$udom)
1.81 albertel 4506:
4507: Gets a users screenname and returns it as a string
4508:
4509: =cut
1.61 www 4510:
4511: sub screenname {
4512: my ($uname,$udom)=@_;
1.258 albertel 4513: if ($uname eq $env{'user.name'} &&
4514: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4515: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4516: return $names{'screenname'};
1.62 www 4517: }
4518:
1.212 albertel 4519:
1.802 bisitz 4520: # ------------------------------------------------------------- Confirm Wrapper
4521: =pod
4522:
1.1142 raeburn 4523: =item * &confirmwrapper($message)
1.802 bisitz 4524:
4525: Wrap messages about completion of operation in box
4526:
4527: =cut
4528:
4529: sub confirmwrapper {
4530: my ($message)=@_;
4531: if ($message) {
4532: return "\n".'<div class="LC_confirm_box">'."\n"
4533: .$message."\n"
4534: .'</div>'."\n";
4535: } else {
4536: return $message;
4537: }
4538: }
4539:
1.62 www 4540: # ------------------------------------------------------------- Message Wrapper
4541:
4542: sub messagewrapper {
1.369 www 4543: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4544: return
1.441 albertel 4545: '<a href="/adm/email?compose=individual&'.
4546: 'recname='.$username.'&recdom='.$domain.
4547: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4548: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4549: }
1.802 bisitz 4550:
1.74 www 4551: # --------------------------------------------------------------- Notes Wrapper
4552:
4553: sub noteswrapper {
4554: my ($link,$un,$do)=@_;
4555: return
1.896 amueller 4556: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4557: }
1.802 bisitz 4558:
1.62 www 4559: # ------------------------------------------------------------- Aboutme Wrapper
4560:
4561: sub aboutmewrapper {
1.1070 raeburn 4562: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4563: if (!defined($username) && !defined($domain)) {
4564: return;
4565: }
1.1096 raeburn 4566: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4567: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4568: }
4569:
4570: # ------------------------------------------------------------ Syllabus Wrapper
4571:
4572: sub syllabuswrapper {
1.707 bisitz 4573: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4574: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4575: }
1.14 harris41 4576:
1.1397 raeburn 4577: # -----------------------------------------------------------------------------
4578:
1.1396 raeburn 4579: sub aboutme_on {
4580: my ($uname,$udom)=@_;
4581: unless ($uname) { $uname=$env{'user.name'}; }
4582: unless ($udom) { $udom=$env{'user.domain'}; }
4583: return if ($udom eq 'public' && $uname eq 'public');
4584: my $hashkey=$uname.':'.$udom;
4585: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4586: if ($cached) {
4587: return $aboutme;
4588: }
4589: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4590: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4591: return $aboutme;
4592: }
4593:
4594: sub devalidate_aboutme_cache {
4595: my ($uname,$udom)=@_;
4596: if (!$udom) { $udom =$env{'user.domain'}; }
4597: if (!$uname) { $uname=$env{'user.name'}; }
4598: return if ($udom eq 'public' && $uname eq 'public');
4599: my $id=$uname.':'.$udom;
4600: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4601: }
4602:
1.208 matthew 4603: sub track_student_link {
1.887 raeburn 4604: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4605: my $link ="/adm/trackstudent?";
1.208 matthew 4606: my $title = 'View recent activity';
4607: if (defined($sname) && $sname !~ /^\s*$/ &&
4608: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4609: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4610: $title .= ' of this student';
1.268 albertel 4611: }
1.208 matthew 4612: if (defined($target) && $target !~ /^\s*$/) {
4613: $target = qq{target="$target"};
4614: } else {
4615: $target = '';
4616: }
1.268 albertel 4617: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4618: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4619: $title = &mt($title);
4620: $linktext = &mt($linktext);
1.448 albertel 4621: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4622: &help_open_topic('View_recent_activity');
1.208 matthew 4623: }
4624:
1.781 raeburn 4625: sub slot_reservations_link {
4626: my ($linktext,$sname,$sdom,$target) = @_;
4627: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4628: my $title = 'View slot reservation history';
4629: if (defined($sname) && $sname !~ /^\s*$/ &&
4630: defined($sdom) && $sdom !~ /^\s*$/) {
4631: $link .= "&uname=$sname&udom=$sdom";
4632: $title .= ' of this student';
4633: }
4634: if (defined($target) && $target !~ /^\s*$/) {
4635: $target = qq{target="$target"};
4636: } else {
4637: $target = '';
4638: }
4639: $title = &mt($title);
4640: $linktext = &mt($linktext);
4641: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4642: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4643:
4644: }
4645:
1.508 www 4646: # ===================================================== Display a student photo
4647:
4648:
1.509 albertel 4649: sub student_image_tag {
1.508 www 4650: my ($domain,$user)=@_;
4651: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4652: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4653: return '<img src="'.$imgsrc.'" align="right" />';
4654: } else {
4655: return '';
4656: }
4657: }
4658:
1.112 bowersj2 4659: =pod
4660:
4661: =back
4662:
4663: =head1 Access .tab File Data
4664:
4665: =over 4
4666:
1.648 raeburn 4667: =item * &languageids()
1.112 bowersj2 4668:
4669: returns list of all language ids
4670:
4671: =cut
4672:
1.14 harris41 4673: sub languageids {
1.16 harris41 4674: return sort(keys(%language));
1.14 harris41 4675: }
4676:
1.112 bowersj2 4677: =pod
4678:
1.648 raeburn 4679: =item * &languagedescription()
1.112 bowersj2 4680:
4681: returns description of a specified language id
4682:
4683: =cut
4684:
1.14 harris41 4685: sub languagedescription {
1.125 www 4686: my $code=shift;
4687: return ($supported_language{$code}?'* ':'').
4688: $language{$code}.
1.126 www 4689: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4690: }
4691:
1.1048 foxr 4692: =pod
4693:
4694: =item * &plainlanguagedescription
4695:
4696: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4697: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4698:
4699: =cut
4700:
1.145 www 4701: sub plainlanguagedescription {
4702: my $code=shift;
4703: return $language{$code};
4704: }
4705:
1.1048 foxr 4706: =pod
4707:
4708: =item * &supportedlanguagecode
4709:
4710: Returns the supported language code (e.g. sptutf maps to pt) given a language
4711: code.
4712:
4713: =cut
4714:
1.145 www 4715: sub supportedlanguagecode {
4716: my $code=shift;
4717: return $supported_language{$code};
1.97 www 4718: }
4719:
1.112 bowersj2 4720: =pod
4721:
1.1048 foxr 4722: =item * &latexlanguage()
4723:
4724: Given a language key code returns the correspondnig language to use
4725: to select the correct hyphenation on LaTeX printouts. This is undef if there
4726: is no supported hyphenation for the language code.
4727:
4728: =cut
4729:
4730: sub latexlanguage {
4731: my $code = shift;
4732: return $latex_language{$code};
4733: }
4734:
4735: =pod
4736:
4737: =item * &latexhyphenation()
4738:
4739: Same as above but what's supplied is the language as it might be stored
4740: in the metadata.
4741:
4742: =cut
4743:
4744: sub latexhyphenation {
4745: my $key = shift;
4746: return $latex_language_bykey{$key};
4747: }
4748:
4749: =pod
4750:
1.648 raeburn 4751: =item * ©rightids()
1.112 bowersj2 4752:
4753: returns list of all copyrights
4754:
4755: =cut
4756:
4757: sub copyrightids {
4758: return sort(keys(%cprtag));
4759: }
4760:
4761: =pod
4762:
1.648 raeburn 4763: =item * ©rightdescription()
1.112 bowersj2 4764:
4765: returns description of a specified copyright id
4766:
4767: =cut
4768:
4769: sub copyrightdescription {
1.166 www 4770: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4771: }
1.197 matthew 4772:
4773: =pod
4774:
1.648 raeburn 4775: =item * &source_copyrightids()
1.192 taceyjo1 4776:
4777: returns list of all source copyrights
4778:
4779: =cut
4780:
4781: sub source_copyrightids {
4782: return sort(keys(%scprtag));
4783: }
4784:
4785: =pod
4786:
1.648 raeburn 4787: =item * &source_copyrightdescription()
1.192 taceyjo1 4788:
4789: returns description of a specified source copyright id
4790:
4791: =cut
4792:
4793: sub source_copyrightdescription {
4794: return &mt($scprtag{shift(@_)});
4795: }
1.112 bowersj2 4796:
4797: =pod
4798:
1.648 raeburn 4799: =item * &filecategories()
1.112 bowersj2 4800:
4801: returns list of all file categories
4802:
4803: =cut
4804:
4805: sub filecategories {
4806: return sort(keys(%category_extensions));
4807: }
4808:
4809: =pod
4810:
1.648 raeburn 4811: =item * &filecategorytypes()
1.112 bowersj2 4812:
4813: returns list of file types belonging to a given file
4814: category
4815:
4816: =cut
4817:
4818: sub filecategorytypes {
1.356 albertel 4819: my ($cat) = @_;
1.1248 raeburn 4820: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4821: return @{$category_extensions{lc($cat)}};
4822: } else {
4823: return ();
4824: }
1.112 bowersj2 4825: }
4826:
4827: =pod
4828:
1.648 raeburn 4829: =item * &fileembstyle()
1.112 bowersj2 4830:
4831: returns embedding style for a specified file type
4832:
4833: =cut
4834:
4835: sub fileembstyle {
4836: return $fe{lc(shift(@_))};
1.169 www 4837: }
4838:
1.351 www 4839: sub filemimetype {
4840: return $fm{lc(shift(@_))};
4841: }
4842:
1.169 www 4843:
4844: sub filecategoryselect {
4845: my ($name,$value)=@_;
1.189 matthew 4846: return &select_form($value,$name,
1.970 raeburn 4847: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4848: }
4849:
4850: =pod
4851:
1.648 raeburn 4852: =item * &filedescription()
1.112 bowersj2 4853:
4854: returns description for a specified file type
4855:
4856: =cut
4857:
4858: sub filedescription {
1.188 matthew 4859: my $file_description = $fd{lc(shift())};
4860: $file_description =~ s:([\[\]]):~$1:g;
4861: return &mt($file_description);
1.112 bowersj2 4862: }
4863:
4864: =pod
4865:
1.648 raeburn 4866: =item * &filedescriptionex()
1.112 bowersj2 4867:
4868: returns description for a specified file type with
4869: extra formatting
4870:
4871: =cut
4872:
4873: sub filedescriptionex {
4874: my $ex=shift;
1.188 matthew 4875: my $file_description = $fd{lc($ex)};
4876: $file_description =~ s:([\[\]]):~$1:g;
4877: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4878: }
4879:
4880: # End of .tab access
4881: =pod
4882:
4883: =back
4884:
4885: =cut
4886:
4887: # ------------------------------------------------------------------ File Types
4888: sub fileextensions {
4889: return sort(keys(%fe));
4890: }
4891:
1.97 www 4892: # ----------------------------------------------------------- Display Languages
4893: # returns a hash with all desired display languages
4894: #
4895:
4896: sub display_languages {
4897: my %languages=();
1.695 raeburn 4898: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4899: $languages{$lang}=1;
1.97 www 4900: }
4901: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4902: if ($env{'form.displaylanguage'}) {
1.356 albertel 4903: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4904: $languages{$lang}=1;
1.97 www 4905: }
4906: }
4907: return %languages;
1.14 harris41 4908: }
4909:
1.582 albertel 4910: sub languages {
4911: my ($possible_langs) = @_;
1.695 raeburn 4912: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4913: if (!ref($possible_langs)) {
4914: if( wantarray ) {
4915: return @preferred_langs;
4916: } else {
4917: return $preferred_langs[0];
4918: }
4919: }
4920: my %possibilities = map { $_ => 1 } (@$possible_langs);
4921: my @preferred_possibilities;
4922: foreach my $preferred_lang (@preferred_langs) {
4923: if (exists($possibilities{$preferred_lang})) {
4924: push(@preferred_possibilities, $preferred_lang);
4925: }
4926: }
4927: if( wantarray ) {
4928: return @preferred_possibilities;
4929: }
4930: return $preferred_possibilities[0];
4931: }
4932:
1.742 raeburn 4933: sub user_lang {
4934: my ($touname,$toudom,$fromcid) = @_;
4935: my @userlangs;
4936: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4937: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4938: $env{'course.'.$fromcid.'.languages'}));
4939: } else {
4940: my %langhash = &getlangs($touname,$toudom);
4941: if ($langhash{'languages'} ne '') {
4942: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4943: } else {
4944: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4945: if ($domdefs{'lang_def'} ne '') {
4946: @userlangs = ($domdefs{'lang_def'});
4947: }
4948: }
4949: }
4950: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4951: my $user_lh = Apache::localize->get_handle(@languages);
4952: return $user_lh;
4953: }
4954:
4955:
1.112 bowersj2 4956: ###############################################################
4957: ## Student Answer Attempts ##
4958: ###############################################################
4959:
4960: =pod
4961:
4962: =head1 Alternate Problem Views
4963:
4964: =over 4
4965:
1.648 raeburn 4966: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4967: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4968:
4969: Return string with previous attempt on problem. Arguments:
4970:
4971: =over 4
4972:
4973: =item * $symb: Problem, including path
4974:
4975: =item * $username: username of the desired student
4976:
4977: =item * $domain: domain of the desired student
1.14 harris41 4978:
1.112 bowersj2 4979: =item * $course: Course ID
1.14 harris41 4980:
1.112 bowersj2 4981: =item * $getattempt: Leave blank for all attempts, otherwise put
4982: something
1.14 harris41 4983:
1.112 bowersj2 4984: =item * $regexp: if string matches this regexp, the string will be
4985: sent to $gradesub
1.14 harris41 4986:
1.112 bowersj2 4987: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4988:
1.1199 raeburn 4989: =item * $usec: section of the desired student
4990:
4991: =item * $identifier: counter for student (multiple students one problem) or
4992: problem (one student; whole sequence).
4993:
1.112 bowersj2 4994: =back
1.14 harris41 4995:
1.112 bowersj2 4996: The output string is a table containing all desired attempts, if any.
1.16 harris41 4997:
1.112 bowersj2 4998: =cut
1.1 albertel 4999:
5000: sub get_previous_attempt {
1.1199 raeburn 5001: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 5002: my $prevattempts='';
1.43 ng 5003: no strict 'refs';
1.1 albertel 5004: if ($symb) {
1.3 albertel 5005: my (%returnhash)=
5006: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 5007: if ($returnhash{'version'}) {
5008: my %lasthash=();
5009: my $version;
5010: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 5011: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
5012: if ($key =~ /\.rawrndseed$/) {
5013: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
5014: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
5015: } else {
5016: $lasthash{$key}=$returnhash{$version.':'.$key};
5017: }
1.19 harris41 5018: }
1.1 albertel 5019: }
1.596 albertel 5020: $prevattempts=&start_data_table().&start_data_table_header_row();
5021: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 5022: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 5023: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 5024: foreach my $key (sort(keys(%lasthash))) {
5025: my ($ign,@parts) = split(/\./,$key);
1.41 ng 5026: if ($#parts > 0) {
1.31 albertel 5027: my $data=$parts[-1];
1.989 raeburn 5028: next if ($data eq 'foilorder');
1.31 albertel 5029: pop(@parts);
1.1010 www 5030: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 5031: if ($data eq 'type') {
5032: unless ($showsurv) {
5033: my $id = join(',',@parts);
5034: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 5035: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
5036: $lasthidden{$ign.'.'.$id} = 1;
5037: }
1.945 raeburn 5038: }
1.1199 raeburn 5039: if ($identifier ne '') {
5040: my $id = join(',',@parts);
5041: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
5042: $domain,$username,$usec,undef,$course) =~ /^no/) {
5043: $hidestatus{$ign.'.'.$id} = 1;
5044: }
5045: }
5046: } elsif ($data eq 'regrader') {
5047: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 5048: my $id = join(',',@parts);
5049: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 5050: }
1.1010 www 5051: }
1.31 albertel 5052: } else {
1.41 ng 5053: if ($#parts == 0) {
5054: $prevattempts.='<th>'.$parts[0].'</th>';
5055: } else {
5056: $prevattempts.='<th>'.$ign.'</th>';
5057: }
1.31 albertel 5058: }
1.16 harris41 5059: }
1.596 albertel 5060: $prevattempts.=&end_data_table_header_row();
1.40 ng 5061: if ($getattempt eq '') {
1.1199 raeburn 5062: my (%solved,%resets,%probstatus);
1.1200 raeburn 5063: if (($identifier ne '') && (keys(%regraded) > 0)) {
5064: for ($version=1;$version<=$returnhash{'version'};$version++) {
5065: foreach my $id (keys(%regraded)) {
5066: if (($returnhash{$version.':'.$id.'.regrader'}) &&
5067: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
5068: ($returnhash{$version.':'.$id.'.award'} eq '')) {
5069: push(@{$resets{$id}},$version);
1.1199 raeburn 5070: }
5071: }
5072: }
1.1200 raeburn 5073: }
5074: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 5075: my (@hidden,@unsolved);
1.945 raeburn 5076: if (%typeparts) {
5077: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 5078: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
5079: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 5080: push(@hidden,$id);
1.1199 raeburn 5081: } elsif ($identifier ne '') {
5082: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
5083: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
5084: ($hidestatus{$id})) {
1.1200 raeburn 5085: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 5086: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
5087: push(@{$solved{$id}},$version);
5088: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
5089: (ref($solved{$id}) eq 'ARRAY')) {
5090: my $skip;
5091: if (ref($resets{$id}) eq 'ARRAY') {
5092: foreach my $reset (@{$resets{$id}}) {
5093: if ($reset > $solved{$id}[-1]) {
5094: $skip=1;
5095: last;
5096: }
5097: }
5098: }
5099: unless ($skip) {
5100: my ($ign,$partslist) = split(/\./,$id,2);
5101: push(@unsolved,$partslist);
5102: }
5103: }
5104: }
1.945 raeburn 5105: }
5106: }
5107: }
5108: $prevattempts.=&start_data_table_row().
1.1199 raeburn 5109: '<td>'.&mt('Transaction [_1]',$version);
5110: if (@unsolved) {
5111: $prevattempts .= '<span class="LC_nobreak"><label>'.
5112: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
5113: &mt('Hide').'</label></span>';
5114: }
5115: $prevattempts .= '</td>';
1.945 raeburn 5116: if (@hidden) {
5117: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5118: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5119: my $hide;
5120: foreach my $id (@hidden) {
5121: if ($key =~ /^\Q$id\E/) {
5122: $hide = 1;
5123: last;
5124: }
5125: }
5126: if ($hide) {
5127: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5128: if (($data eq 'award') || ($data eq 'awarddetail')) {
5129: my $value = &format_previous_attempt_value($key,
5130: $returnhash{$version.':'.$key});
1.1173 kruse 5131: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5132: } else {
5133: $prevattempts.='<td> </td>';
5134: }
5135: } else {
5136: if ($key =~ /\./) {
1.1212 raeburn 5137: my $value = $returnhash{$version.':'.$key};
5138: if ($key =~ /\.rndseed$/) {
5139: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5140: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5141: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5142: }
5143: }
5144: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5145: ' </td>';
1.945 raeburn 5146: } else {
5147: $prevattempts.='<td> </td>';
5148: }
5149: }
5150: }
5151: } else {
5152: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5153: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 5154: my $value = $returnhash{$version.':'.$key};
5155: if ($key =~ /\.rndseed$/) {
5156: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5157: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5158: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5159: }
5160: }
5161: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5162: ' </td>';
1.945 raeburn 5163: }
5164: }
5165: $prevattempts.=&end_data_table_row();
1.40 ng 5166: }
1.1 albertel 5167: }
1.945 raeburn 5168: my @currhidden = keys(%lasthidden);
1.596 albertel 5169: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 5170: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5171: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5172: if (%typeparts) {
5173: my $hidden;
5174: foreach my $id (@currhidden) {
5175: if ($key =~ /^\Q$id\E/) {
5176: $hidden = 1;
5177: last;
5178: }
5179: }
5180: if ($hidden) {
5181: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5182: if (($data eq 'award') || ($data eq 'awarddetail')) {
5183: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5184: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5185: $value = &$gradesub($value);
5186: }
1.1173 kruse 5187: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5188: } else {
5189: $prevattempts.='<td> </td>';
5190: }
5191: } else {
5192: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5193: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5194: $value = &$gradesub($value);
5195: }
1.1173 kruse 5196: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5197: }
5198: } else {
5199: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5200: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5201: $value = &$gradesub($value);
5202: }
1.1173 kruse 5203: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5204: }
1.16 harris41 5205: }
1.596 albertel 5206: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5207: } else {
1.1305 raeburn 5208: my $msg;
5209: if ($symb =~ /ext\.tool$/) {
5210: $msg = &mt('No grade passed back.');
5211: } else {
5212: $msg = &mt('Nothing submitted - no attempts.');
5213: }
1.596 albertel 5214: $prevattempts=
5215: &start_data_table().&start_data_table_row().
1.1305 raeburn 5216: '<td>'.$msg.'</td>'.
1.596 albertel 5217: &end_data_table_row().&end_data_table();
1.1 albertel 5218: }
5219: } else {
1.596 albertel 5220: $prevattempts=
5221: &start_data_table().&start_data_table_row().
5222: '<td>'.&mt('No data.').'</td>'.
5223: &end_data_table_row().&end_data_table();
1.1 albertel 5224: }
1.10 albertel 5225: }
5226:
1.581 albertel 5227: sub format_previous_attempt_value {
5228: my ($key,$value) = @_;
1.1011 www 5229: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5230: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5231: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5232: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5233: } elsif ($key =~ /answerstring$/) {
5234: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5235: my @answer = %answers;
5236: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5237: my @anskeys = sort(keys(%answers));
5238: if (@anskeys == 1) {
5239: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5240: if ($answer =~ m{\0}) {
5241: $answer =~ s{\0}{,}g;
1.988 raeburn 5242: }
5243: my $tag_internal_answer_name = 'INTERNAL';
5244: if ($anskeys[0] eq $tag_internal_answer_name) {
5245: $value = $answer;
5246: } else {
5247: $value = $anskeys[0].'='.$answer;
5248: }
5249: } else {
5250: foreach my $ans (@anskeys) {
5251: my $answer = $answers{$ans};
1.1001 raeburn 5252: if ($answer =~ m{\0}) {
5253: $answer =~ s{\0}{,}g;
1.988 raeburn 5254: }
5255: $value .= $ans.'='.$answer.'<br />';;
5256: }
5257: }
1.581 albertel 5258: } else {
1.1173 kruse 5259: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5260: }
5261: return $value;
5262: }
5263:
5264:
1.107 albertel 5265: sub relative_to_absolute {
5266: my ($url,$output)=@_;
5267: my $parser=HTML::TokeParser->new(\$output);
5268: my $token;
5269: my $thisdir=$url;
5270: my @rlinks=();
5271: while ($token=$parser->get_token) {
5272: if ($token->[0] eq 'S') {
5273: if ($token->[1] eq 'a') {
5274: if ($token->[2]->{'href'}) {
5275: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5276: }
5277: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5278: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5279: } elsif ($token->[1] eq 'base') {
5280: $thisdir=$token->[2]->{'href'};
5281: }
5282: }
5283: }
5284: $thisdir=~s-/[^/]*$--;
1.356 albertel 5285: foreach my $link (@rlinks) {
1.726 raeburn 5286: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5287: ($link=~/^\//) ||
5288: ($link=~/^javascript:/i) ||
5289: ($link=~/^mailto:/i) ||
5290: ($link=~/^\#/)) {
5291: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5292: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5293: }
5294: }
5295: # -------------------------------------------------- Deal with Applet codebases
5296: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5297: return $output;
5298: }
5299:
1.112 bowersj2 5300: =pod
5301:
1.648 raeburn 5302: =item * &get_student_view()
1.112 bowersj2 5303:
5304: show a snapshot of what student was looking at
5305:
5306: =cut
5307:
1.10 albertel 5308: sub get_student_view {
1.186 albertel 5309: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5310: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5311: my (%form);
1.10 albertel 5312: my @elements=('symb','courseid','domain','username');
5313: foreach my $element (@elements) {
1.186 albertel 5314: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5315: }
1.186 albertel 5316: if (defined($moreenv)) {
5317: %form=(%form,%{$moreenv});
5318: }
1.236 albertel 5319: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5320: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5321: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5322: $feedurl =~ s{^/adm/wrapper}{};
5323: }
1.650 www 5324: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5325: $userview=~s/\<body[^\>]*\>//gi;
5326: $userview=~s/\<\/body\>//gi;
5327: $userview=~s/\<html\>//gi;
5328: $userview=~s/\<\/html\>//gi;
5329: $userview=~s/\<head\>//gi;
5330: $userview=~s/\<\/head\>//gi;
5331: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5332: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5333: if (wantarray) {
5334: return ($userview,$response);
5335: } else {
5336: return $userview;
5337: }
5338: }
5339:
5340: sub get_student_view_with_retries {
5341: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5342:
5343: my $ok = 0; # True if we got a good response.
5344: my $content;
5345: my $response;
5346:
5347: # Try to get the student_view done. within the retries count:
5348:
5349: do {
5350: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5351: $ok = $response->is_success;
5352: if (!$ok) {
5353: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5354: }
5355: $retries--;
5356: } while (!$ok && ($retries > 0));
5357:
5358: if (!$ok) {
5359: $content = ''; # On error return an empty content.
5360: }
1.651 www 5361: if (wantarray) {
5362: return ($content, $response);
5363: } else {
5364: return $content;
5365: }
1.11 albertel 5366: }
5367:
1.1349 raeburn 5368: sub css_links {
5369: my ($currsymb,$level) = @_;
5370: my ($links,@symbs,%cssrefs,%httpref);
5371: if ($level eq 'map') {
5372: my $navmap = Apache::lonnavmaps::navmap->new();
5373: if (ref($navmap)) {
5374: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5375: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5376: foreach my $res (@resources) {
5377: if (ref($res) && $res->symb()) {
5378: push(@symbs,$res->symb());
5379: }
5380: }
5381: }
5382: } else {
5383: @symbs = ($currsymb);
5384: }
5385: foreach my $symb (@symbs) {
5386: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5387: if ($css_href =~ /\S/) {
5388: unless ($css_href =~ m{https?://}) {
5389: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5390: my $proburl = &Apache::lonnet::clutter($url);
5391: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5392: unless ($css_href =~ m{^/}) {
5393: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5394: }
5395: if ($css_href =~ m{^/(res|uploaded)/}) {
5396: unless (($httpref{'httpref.'.$css_href}) ||
5397: (&Apache::lonnet::is_on_map($css_href))) {
5398: my $thisurl = $proburl;
5399: if ($env{'httpref.'.$proburl}) {
5400: $thisurl = $env{'httpref.'.$proburl};
5401: }
5402: $httpref{'httpref.'.$css_href} = $thisurl;
5403: }
5404: }
5405: }
5406: $cssrefs{$css_href} = 1;
5407: }
5408: }
5409: if (keys(%httpref)) {
5410: &Apache::lonnet::appenv(\%httpref);
5411: }
5412: if (keys(%cssrefs)) {
5413: foreach my $css_href (keys(%cssrefs)) {
5414: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5415: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5416: }
5417: }
5418: return $links;
5419: }
5420:
1.112 bowersj2 5421: =pod
5422:
1.648 raeburn 5423: =item * &get_student_answers()
1.112 bowersj2 5424:
5425: show a snapshot of how student was answering problem
5426:
5427: =cut
5428:
1.11 albertel 5429: sub get_student_answers {
1.100 sakharuk 5430: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5431: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5432: my (%moreenv);
1.11 albertel 5433: my @elements=('symb','courseid','domain','username');
5434: foreach my $element (@elements) {
1.186 albertel 5435: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5436: }
1.186 albertel 5437: $moreenv{'grade_target'}='answer';
5438: %moreenv=(%form,%moreenv);
1.497 raeburn 5439: $feedurl = &Apache::lonnet::clutter($feedurl);
5440: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5441: return $userview;
1.1 albertel 5442: }
1.116 albertel 5443:
5444: =pod
5445:
5446: =item * &submlink()
5447:
1.242 albertel 5448: Inputs: $text $uname $udom $symb $target
1.116 albertel 5449:
5450: Returns: A link to grades.pm such as to see the SUBM view of a student
5451:
5452: =cut
5453:
5454: ###############################################
5455: sub submlink {
1.242 albertel 5456: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5457: if (!($uname && $udom)) {
5458: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5459: &Apache::lonnet::whichuser($symb);
1.116 albertel 5460: if (!$symb) { $symb=$cursymb; }
5461: }
1.254 matthew 5462: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5463: $symb=&escape($symb);
1.960 bisitz 5464: if ($target) { $target=" target=\"$target\""; }
5465: return
5466: '<a href="/adm/grades?command=submission'.
5467: '&symb='.$symb.
5468: '&student='.$uname.
5469: '&userdom='.$udom.'"'.
5470: $target.'>'.$text.'</a>';
1.242 albertel 5471: }
5472: ##############################################
5473:
5474: =pod
5475:
5476: =item * &pgrdlink()
5477:
5478: Inputs: $text $uname $udom $symb $target
5479:
5480: Returns: A link to grades.pm such as to see the PGRD view of a student
5481:
5482: =cut
5483:
5484: ###############################################
5485: sub pgrdlink {
5486: my $link=&submlink(@_);
5487: $link=~s/(&command=submission)/$1&showgrading=yes/;
5488: return $link;
5489: }
5490: ##############################################
5491:
5492: =pod
5493:
5494: =item * &pprmlink()
5495:
5496: Inputs: $text $uname $udom $symb $target
5497:
5498: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5499: student and a specific resource
1.242 albertel 5500:
5501: =cut
5502:
5503: ###############################################
5504: sub pprmlink {
5505: my ($text,$uname,$udom,$symb,$target)=@_;
5506: if (!($uname && $udom)) {
5507: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5508: &Apache::lonnet::whichuser($symb);
1.242 albertel 5509: if (!$symb) { $symb=$cursymb; }
5510: }
1.254 matthew 5511: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5512: $symb=&escape($symb);
1.242 albertel 5513: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5514: return '<a href="/adm/parmset?command=set&'.
5515: 'symb='.$symb.'&uname='.$uname.
5516: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5517: }
5518: ##############################################
1.37 matthew 5519:
1.112 bowersj2 5520: =pod
5521:
5522: =back
5523:
5524: =cut
5525:
1.37 matthew 5526: ###############################################
1.51 www 5527:
5528:
5529: sub timehash {
1.687 raeburn 5530: my ($thistime) = @_;
5531: my $timezone = &Apache::lonlocal::gettimezone();
5532: my $dt = DateTime->from_epoch(epoch => $thistime)
5533: ->set_time_zone($timezone);
5534: my $wday = $dt->day_of_week();
5535: if ($wday == 7) { $wday = 0; }
5536: return ( 'second' => $dt->second(),
5537: 'minute' => $dt->minute(),
5538: 'hour' => $dt->hour(),
5539: 'day' => $dt->day_of_month(),
5540: 'month' => $dt->month(),
5541: 'year' => $dt->year(),
5542: 'weekday' => $wday,
5543: 'dayyear' => $dt->day_of_year(),
5544: 'dlsav' => $dt->is_dst() );
1.51 www 5545: }
5546:
1.370 www 5547: sub utc_string {
5548: my ($date)=@_;
1.371 www 5549: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5550: }
5551:
1.51 www 5552: sub maketime {
5553: my %th=@_;
1.687 raeburn 5554: my ($epoch_time,$timezone,$dt);
5555: $timezone = &Apache::lonlocal::gettimezone();
5556: eval {
5557: $dt = DateTime->new( year => $th{'year'},
5558: month => $th{'month'},
5559: day => $th{'day'},
5560: hour => $th{'hour'},
5561: minute => $th{'minute'},
5562: second => $th{'second'},
5563: time_zone => $timezone,
5564: );
5565: };
5566: if (!$@) {
5567: $epoch_time = $dt->epoch;
5568: if ($epoch_time) {
5569: return $epoch_time;
5570: }
5571: }
1.51 www 5572: return POSIX::mktime(
5573: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5574: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5575: }
5576:
5577: #########################################
1.51 www 5578:
5579: sub findallcourses {
1.482 raeburn 5580: my ($roles,$uname,$udom) = @_;
1.355 albertel 5581: my %roles;
5582: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5583: my %courses;
1.51 www 5584: my $now=time;
1.482 raeburn 5585: if (!defined($uname)) {
5586: $uname = $env{'user.name'};
5587: }
5588: if (!defined($udom)) {
5589: $udom = $env{'user.domain'};
5590: }
5591: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5592: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5593: if (!%roles) {
5594: %roles = (
5595: cc => 1,
1.907 raeburn 5596: co => 1,
1.482 raeburn 5597: in => 1,
5598: ep => 1,
5599: ta => 1,
5600: cr => 1,
5601: st => 1,
5602: );
5603: }
5604: foreach my $entry (keys(%roleshash)) {
5605: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5606: if ($trole =~ /^cr/) {
5607: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5608: } else {
5609: next if (!exists($roles{$trole}));
5610: }
5611: if ($tend) {
5612: next if ($tend < $now);
5613: }
5614: if ($tstart) {
5615: next if ($tstart > $now);
5616: }
1.1058 raeburn 5617: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5618: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5619: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5620: if ($secpart eq '') {
5621: ($cnum,$role) = split(/_/,$cnumpart);
5622: $sec = 'none';
1.1058 raeburn 5623: $value .= $cnum.'/';
1.482 raeburn 5624: } else {
5625: $cnum = $cnumpart;
5626: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5627: $value .= $cnum.'/'.$sec;
5628: }
5629: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5630: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5631: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5632: }
5633: } else {
5634: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5635: }
1.482 raeburn 5636: }
5637: } else {
5638: foreach my $key (keys(%env)) {
1.483 albertel 5639: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5640: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5641: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5642: next if ($role eq 'ca' || $role eq 'aa');
5643: next if (%roles && !exists($roles{$role}));
5644: my ($starttime,$endtime)=split(/\./,$env{$key});
5645: my $active=1;
5646: if ($starttime) {
5647: if ($now<$starttime) { $active=0; }
5648: }
5649: if ($endtime) {
5650: if ($now>$endtime) { $active=0; }
5651: }
5652: if ($active) {
1.1058 raeburn 5653: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5654: if ($sec eq '') {
5655: $sec = 'none';
1.1058 raeburn 5656: } else {
5657: $value .= $sec;
5658: }
5659: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5660: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5661: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5662: }
5663: } else {
5664: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5665: }
1.474 raeburn 5666: }
5667: }
1.51 www 5668: }
5669: }
1.474 raeburn 5670: return %courses;
1.51 www 5671: }
1.37 matthew 5672:
1.54 www 5673: ###############################################
1.474 raeburn 5674:
5675: sub blockcheck {
1.1372 raeburn 5676: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5677: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5678: my ($has_evb,$check_ipaccess);
5679: my $dom = $env{'user.domain'};
5680: if ($env{'request.course.id'}) {
5681: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5682: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5683: my $checkrole = "cm./$cdom/$cnum";
5684: my $sec = $env{'request.course.sec'};
5685: if ($sec ne '') {
5686: $checkrole .= "/$sec";
5687: }
5688: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5689: ($env{'request.role'} !~ /^st/)) {
5690: $has_evb = 1;
5691: }
5692: unless ($has_evb) {
5693: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
1.1444 raeburn 5694: ($activity eq 'index') || ($activity eq 'boards') || ($activity eq 'groups') ||
5695: ($activity eq 'chat')) {
1.1372 raeburn 5696: if ($udom eq $cdom) {
5697: $check_ipaccess = 1;
5698: }
5699: }
5700: }
1.1375 raeburn 5701: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5702: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5703: my $checkrole;
5704: if ($env{'request.role.domain'} eq '') {
5705: $checkrole = "cm./$env{'user.domain'}/";
5706: } else {
5707: $checkrole = "cm./$env{'request.role.domain'}/";
5708: }
5709: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5710: $has_evb = 1;
5711: }
1.1372 raeburn 5712: }
5713: unless ($has_evb || $check_ipaccess) {
5714: my @machinedoms = &Apache::lonnet::current_machine_domains();
5715: if (($dom eq 'public') && ($activity eq 'port')) {
5716: $dom = $udom;
5717: }
5718: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5719: $check_ipaccess = 1;
5720: } else {
5721: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5722: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5723: my $prim = &Apache::lonnet::domain($dom,'primary');
5724: my $intdom = &Apache::lonnet::internet_dom($prim);
5725: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5726: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5727: $check_ipaccess = 1;
5728: }
5729: }
5730: }
5731: }
5732: if ($check_ipaccess) {
5733: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5734: unless (defined($cached)) {
5735: my %domconfig =
5736: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5737: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5738: }
5739: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5740: foreach my $id (keys(%{$ipaccessref})) {
5741: if (ref($ipaccessref->{$id}) eq 'HASH') {
5742: my $range = $ipaccessref->{$id}->{'ip'};
5743: if ($range) {
5744: if (&Apache::lonnet::ip_match($clientip,$range)) {
5745: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5746: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5747: return ('','','',$id,$dom);
5748: last;
5749: }
5750: }
5751: }
5752: }
5753: }
5754: }
5755: }
5756: }
1.1373 raeburn 5757: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5758: return ();
5759: }
1.1372 raeburn 5760: }
1.1189 raeburn 5761: if (defined($udom) && defined($uname)) {
5762: # If uname and udom are for a course, check for blocks in the course.
5763: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5764: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5765: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5766: return ($startblock,$endblock,$triggerblock);
5767: }
5768: } else {
1.490 raeburn 5769: $udom = $env{'user.domain'};
5770: $uname = $env{'user.name'};
5771: }
5772:
1.502 raeburn 5773: my $startblock = 0;
5774: my $endblock = 0;
1.1062 raeburn 5775: my $triggerblock = '';
1.1373 raeburn 5776: my %live_courses;
5777: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5778: %live_courses = &findallcourses(undef,$uname,$udom);
5779: }
1.474 raeburn 5780:
1.490 raeburn 5781: # If uname is for a user, and activity is course-specific, i.e.,
5782: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5783:
1.490 raeburn 5784: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5785: $activity eq 'groups' || $activity eq 'printout' ||
1.1444 raeburn 5786: $activity eq 'search' || $activity eq 'index' ||
5787: $activity eq 'reinit' || $activity eq 'alert') &&
1.1189 raeburn 5788: ($env{'request.course.id'})) {
1.490 raeburn 5789: foreach my $key (keys(%live_courses)) {
5790: if ($key ne $env{'request.course.id'}) {
5791: delete($live_courses{$key});
5792: }
5793: }
5794: }
5795:
5796: my $otheruser = 0;
5797: my %own_courses;
5798: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5799: # Resource belongs to user other than current user.
5800: $otheruser = 1;
5801: # Gather courses for current user
5802: %own_courses =
5803: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5804: }
5805:
5806: # Gather active course roles - course coordinator, instructor,
5807: # exam proctor, ta, student, or custom role.
1.474 raeburn 5808:
5809: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5810: my ($cdom,$cnum);
5811: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5812: $cdom = $env{'course.'.$course.'.domain'};
5813: $cnum = $env{'course.'.$course.'.num'};
5814: } else {
1.490 raeburn 5815: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5816: }
5817: my $no_ownblock = 0;
5818: my $no_userblock = 0;
1.533 raeburn 5819: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5820: # Check if current user has 'evb' priv for this
5821: if (defined($own_courses{$course})) {
5822: foreach my $sec (keys(%{$own_courses{$course}})) {
5823: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5824: if ($sec ne 'none') {
5825: $checkrole .= '/'.$sec;
5826: }
5827: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5828: $no_ownblock = 1;
5829: last;
5830: }
5831: }
5832: }
5833: # if they have 'evb' priv and are currently not playing student
5834: next if (($no_ownblock) &&
5835: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5836: }
1.474 raeburn 5837: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5838: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5839: if ($sec ne 'none') {
1.482 raeburn 5840: $checkrole .= '/'.$sec;
1.474 raeburn 5841: }
1.490 raeburn 5842: if ($otheruser) {
5843: # Resource belongs to user other than current user.
5844: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5845: my (%allroles,%userroles);
5846: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5847: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5848: my ($trole,$tdom,$tnum,$tsec);
5849: if ($entry =~ /^cr/) {
5850: ($trole,$tdom,$tnum,$tsec) =
5851: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5852: } else {
5853: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5854: }
5855: my ($spec,$area,$trest);
5856: $area = '/'.$tdom.'/'.$tnum;
5857: $trest = $tnum;
5858: if ($tsec ne '') {
5859: $area .= '/'.$tsec;
5860: $trest .= '/'.$tsec;
5861: }
5862: $spec = $trole.'.'.$area;
5863: if ($trole =~ /^cr/) {
5864: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5865: $tdom,$spec,$trest,$area);
5866: } else {
5867: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5868: $tdom,$spec,$trest,$area);
5869: }
5870: }
1.1276 raeburn 5871: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5872: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5873: if ($1) {
5874: $no_userblock = 1;
5875: last;
5876: }
1.486 raeburn 5877: }
5878: }
1.490 raeburn 5879: } else {
5880: # Resource belongs to current user
5881: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5882: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5883: $no_ownblock = 1;
5884: last;
5885: }
1.474 raeburn 5886: }
5887: }
5888: # if they have the evb priv and are currently not playing student
1.482 raeburn 5889: next if (($no_ownblock) &&
1.491 albertel 5890: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5891: next if ($no_userblock);
1.474 raeburn 5892:
1.1303 raeburn 5893: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5894: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5895:
1.1062 raeburn 5896: my ($start,$end,$trigger) =
1.1347 raeburn 5897: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5898: if (($start != 0) &&
5899: (($startblock == 0) || ($startblock > $start))) {
5900: $startblock = $start;
1.1062 raeburn 5901: if ($trigger ne '') {
5902: $triggerblock = $trigger;
5903: }
1.502 raeburn 5904: }
5905: if (($end != 0) &&
5906: (($endblock == 0) || ($endblock < $end))) {
5907: $endblock = $end;
1.1062 raeburn 5908: if ($trigger ne '') {
5909: $triggerblock = $trigger;
5910: }
1.502 raeburn 5911: }
1.490 raeburn 5912: }
1.1062 raeburn 5913: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5914: }
5915:
5916: sub get_blocks {
1.1347 raeburn 5917: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5918: my $startblock = 0;
5919: my $endblock = 0;
1.1062 raeburn 5920: my $triggerblock = '';
1.490 raeburn 5921: my $course = $cdom.'_'.$cnum;
5922: $setters->{$course} = {};
5923: $setters->{$course}{'staff'} = [];
5924: $setters->{$course}{'times'} = [];
1.1062 raeburn 5925: $setters->{$course}{'triggers'} = [];
5926: my (@blockers,%triggered);
5927: my $now = time;
5928: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5929: if ($activity eq 'docs') {
1.1348 raeburn 5930: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5931: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5932: $blocked = 1;
5933: $nosymbcache = 1;
1.1348 raeburn 5934: $noenccheck = 1;
1.1347 raeburn 5935: }
1.1348 raeburn 5936: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5937: foreach my $block (@blockers) {
5938: if ($block =~ /^firstaccess____(.+)$/) {
5939: my $item = $1;
5940: my $type = 'map';
5941: my $timersymb = $item;
5942: if ($item eq 'course') {
5943: $type = 'course';
5944: } elsif ($item =~ /___\d+___/) {
5945: $type = 'resource';
5946: } else {
5947: $timersymb = &Apache::lonnet::symbread($item);
5948: }
5949: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5950: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5951: $triggered{$block} = {
5952: start => $start,
5953: end => $end,
5954: type => $type,
5955: };
5956: }
5957: }
5958: } else {
5959: foreach my $block (keys(%commblocks)) {
5960: if ($block =~ m/^(\d+)____(\d+)$/) {
5961: my ($start,$end) = ($1,$2);
5962: if ($start <= time && $end >= time) {
5963: if (ref($commblocks{$block}) eq 'HASH') {
5964: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5965: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5966: unless(grep(/^\Q$block\E$/,@blockers)) {
5967: push(@blockers,$block);
5968: }
5969: }
5970: }
5971: }
5972: }
5973: } elsif ($block =~ /^firstaccess____(.+)$/) {
5974: my $item = $1;
5975: my $timersymb = $item;
5976: my $type = 'map';
5977: if ($item eq 'course') {
5978: $type = 'course';
5979: } elsif ($item =~ /___\d+___/) {
5980: $type = 'resource';
5981: } else {
5982: $timersymb = &Apache::lonnet::symbread($item);
5983: }
5984: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5985: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5986: if ($start && $end) {
5987: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5988: if (ref($commblocks{$block}) eq 'HASH') {
5989: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5990: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5991: unless(grep(/^\Q$block\E$/,@blockers)) {
5992: push(@blockers,$block);
5993: $triggered{$block} = {
5994: start => $start,
5995: end => $end,
5996: type => $type,
5997: };
5998: }
5999: }
6000: }
1.1062 raeburn 6001: }
6002: }
1.490 raeburn 6003: }
1.1062 raeburn 6004: }
6005: }
6006: }
6007: foreach my $blocker (@blockers) {
6008: my ($staff_name,$staff_dom,$title,$blocks) =
6009: &parse_block_record($commblocks{$blocker});
6010: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
6011: my ($start,$end,$triggertype);
6012: if ($blocker =~ m/^(\d+)____(\d+)$/) {
6013: ($start,$end) = ($1,$2);
6014: } elsif (ref($triggered{$blocker}) eq 'HASH') {
6015: $start = $triggered{$blocker}{'start'};
6016: $end = $triggered{$blocker}{'end'};
6017: $triggertype = $triggered{$blocker}{'type'};
6018: }
6019: if ($start) {
6020: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6021: if ($triggertype) {
6022: push(@{$$setters{$course}{'triggers'}},$triggertype);
6023: } else {
6024: push(@{$$setters{$course}{'triggers'}},0);
6025: }
6026: if ( ($startblock == 0) || ($startblock > $start) ) {
6027: $startblock = $start;
6028: if ($triggertype) {
6029: $triggerblock = $blocker;
1.474 raeburn 6030: }
6031: }
1.1062 raeburn 6032: if ( ($endblock == 0) || ($endblock < $end) ) {
6033: $endblock = $end;
6034: if ($triggertype) {
6035: $triggerblock = $blocker;
6036: }
6037: }
1.474 raeburn 6038: }
6039: }
1.1062 raeburn 6040: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6041: }
6042:
6043: sub parse_block_record {
6044: my ($record) = @_;
6045: my ($setuname,$setudom,$title,$blocks);
6046: if (ref($record) eq 'HASH') {
6047: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6048: $title = &unescape($record->{'event'});
6049: $blocks = $record->{'blocks'};
6050: } else {
6051: my @data = split(/:/,$record,3);
6052: if (scalar(@data) eq 2) {
6053: $title = $data[1];
6054: ($setuname,$setudom) = split(/@/,$data[0]);
6055: } else {
6056: ($setuname,$setudom,$title) = @data;
6057: }
6058: $blocks = { 'com' => 'on' };
6059: }
6060: return ($setuname,$setudom,$title,$blocks);
6061: }
6062:
1.854 kalberla 6063: sub blocking_status {
1.1372 raeburn 6064: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6065: my %setters;
1.890 droeschl 6066:
1.1061 raeburn 6067: # check for active blocking
1.1372 raeburn 6068: if ($clientip eq '') {
6069: $clientip = &Apache::lonnet::get_requestor_ip();
6070: }
6071: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6072: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6073: my $blocked = 0;
1.1372 raeburn 6074: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6075: $blocked = 1;
6076: }
1.890 droeschl 6077:
1.1061 raeburn 6078: # caller just wants to know whether a block is active
6079: if (!wantarray) { return $blocked; }
6080:
6081: # build a link to a popup window containing the details
6082: my $querystring = "?activity=$activity";
1.1351 raeburn 6083: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6084: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6085: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6086: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6087: } elsif ($activity eq 'docs') {
1.1347 raeburn 6088: my $showurl = &Apache::lonenc::check_encrypt($url);
6089: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6090: if ($symb) {
6091: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6092: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6093: }
1.1062 raeburn 6094: }
1.1061 raeburn 6095:
6096: my $output .= <<'END_MYBLOCK';
6097: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6098: var options = "width=" + w + ",height=" + h + ",";
6099: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6100: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6101: var newWin = window.open(url, wdwName, options);
6102: newWin.focus();
6103: }
1.890 droeschl 6104: END_MYBLOCK
1.854 kalberla 6105:
1.1061 raeburn 6106: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6107:
1.1061 raeburn 6108: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6109: my $text = &mt('Communication Blocked');
1.1217 raeburn 6110: my $class = 'LC_comblock';
1.1062 raeburn 6111: if ($activity eq 'docs') {
6112: $text = &mt('Content Access Blocked');
1.1217 raeburn 6113: $class = '';
1.1063 raeburn 6114: } elsif ($activity eq 'printout') {
6115: $text = &mt('Printing Blocked');
1.1232 raeburn 6116: } elsif ($activity eq 'passwd') {
6117: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6118: } elsif ($activity eq 'grades') {
6119: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6120: } elsif ($activity eq 'search') {
6121: $text = &mt('Search Blocked');
1.1444 raeburn 6122: } elsif ($activity eq 'index') {
6123: $text = &mt('Content Index Blocked');
1.1282 raeburn 6124: } elsif ($activity eq 'alert') {
6125: $text = &mt('Checking Critical Messages Blocked');
6126: } elsif ($activity eq 'reinit') {
6127: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6128: } elsif ($activity eq 'about') {
6129: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6130: } elsif ($activity eq 'wishlist') {
6131: $text = &mt('Access to Stored Links Blocked');
6132: } elsif ($activity eq 'annotate') {
6133: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6134: }
1.1061 raeburn 6135: $output .= <<"END_BLOCK";
1.1217 raeburn 6136: <div class='$class'>
1.869 kalberla 6137: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6138: title='$text'>
6139: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6140: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6141: title='$text'>$text</a>
1.867 kalberla 6142: </div>
6143:
6144: END_BLOCK
1.474 raeburn 6145:
1.1061 raeburn 6146: return ($blocked, $output);
1.854 kalberla 6147: }
1.490 raeburn 6148:
1.60 matthew 6149: ###############################################
6150:
1.682 raeburn 6151: sub check_ip_acc {
1.1201 raeburn 6152: my ($acc,$clientip)=@_;
1.682 raeburn 6153: &Apache::lonxml::debug("acc is $acc");
6154: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6155: return 1;
6156: }
1.1339 raeburn 6157: my ($ip,$allowed);
6158: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6159: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6160: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6161: } else {
1.1350 raeburn 6162: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6163: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6164: }
1.682 raeburn 6165:
6166: my $name;
1.1219 raeburn 6167: my %access = (
6168: allowfrom => 1,
6169: denyfrom => 0,
6170: );
6171: my @allows;
6172: my @denies;
6173: foreach my $item (split(',',$acc)) {
6174: $item =~ s/^\s*//;
6175: $item =~ s/\s*$//;
6176: my $pattern;
6177: if ($item =~ /^\!(.+)$/) {
6178: push(@denies,$1);
6179: } else {
6180: push(@allows,$item);
6181: }
6182: }
6183: my $numdenies = scalar(@denies);
6184: my $numallows = scalar(@allows);
6185: my $count = 0;
6186: foreach my $pattern (@denies,@allows) {
6187: $count ++;
6188: my $acctype = 'allowfrom';
6189: if ($count <= $numdenies) {
6190: $acctype = 'denyfrom';
6191: }
1.682 raeburn 6192: if ($pattern =~ /\*$/) {
6193: #35.8.*
6194: $pattern=~s/\*//;
1.1219 raeburn 6195: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6196: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6197: #35.8.3.[34-56]
6198: my $low=$2;
6199: my $high=$3;
6200: $pattern=$1;
6201: if ($ip =~ /^\Q$pattern\E/) {
6202: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6203: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6204: }
6205: } elsif ($pattern =~ /^\*/) {
6206: #*.msu.edu
6207: $pattern=~s/\*//;
6208: if (!defined($name)) {
6209: use Socket;
6210: my $netaddr=inet_aton($ip);
6211: ($name)=gethostbyaddr($netaddr,AF_INET);
6212: }
1.1219 raeburn 6213: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6214: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6215: #127.0.0.1
1.1219 raeburn 6216: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6217: } else {
6218: #some.name.com
6219: if (!defined($name)) {
6220: use Socket;
6221: my $netaddr=inet_aton($ip);
6222: ($name)=gethostbyaddr($netaddr,AF_INET);
6223: }
1.1219 raeburn 6224: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6225: }
6226: if ($allowed =~ /^(0|1)$/) { last; }
6227: }
6228: if ($allowed eq '') {
6229: if ($numdenies && !$numallows) {
6230: $allowed = 1;
6231: } else {
6232: $allowed = 0;
1.682 raeburn 6233: }
6234: }
6235: return $allowed;
6236: }
6237:
6238: ###############################################
6239:
1.60 matthew 6240: =pod
6241:
1.112 bowersj2 6242: =head1 Domain Template Functions
6243:
6244: =over 4
6245:
6246: =item * &determinedomain()
1.60 matthew 6247:
6248: Inputs: $domain (usually will be undef)
6249:
1.63 www 6250: Returns: Determines which domain should be used for designs
1.60 matthew 6251:
6252: =cut
1.54 www 6253:
1.60 matthew 6254: ###############################################
1.63 www 6255: sub determinedomain {
6256: my $domain=shift;
1.531 albertel 6257: if (! $domain) {
1.60 matthew 6258: # Determine domain if we have not been given one
1.893 raeburn 6259: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6260: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6261: if ($env{'request.role.domain'}) {
6262: $domain=$env{'request.role.domain'};
1.60 matthew 6263: }
6264: }
1.63 www 6265: return $domain;
6266: }
6267: ###############################################
1.517 raeburn 6268:
1.518 albertel 6269: sub devalidate_domconfig_cache {
6270: my ($udom)=@_;
6271: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6272: }
6273:
6274: # ---------------------- Get domain configuration for a domain
6275: sub get_domainconf {
6276: my ($udom) = @_;
6277: my $cachetime=1800;
6278: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6279: if (defined($cached)) { return %{$result}; }
6280:
6281: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6282: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6283: my (%designhash,%legacy);
1.518 albertel 6284: if (keys(%domconfig) > 0) {
6285: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6286: if (keys(%{$domconfig{'login'}})) {
6287: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6288: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6289: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6290: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6291: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6292: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6293: if ($key eq 'loginvia') {
6294: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6295: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6296: $designhash{$udom.'.login.loginvia'} = $server;
6297: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6298:
6299: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6300: } else {
6301: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6302: }
1.948 raeburn 6303: }
1.1208 raeburn 6304: } elsif ($key eq 'headtag') {
6305: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6306: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6307: }
1.946 raeburn 6308: }
1.1208 raeburn 6309: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6310: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6311: }
1.946 raeburn 6312: }
6313: }
6314: }
1.1366 raeburn 6315: } elsif ($key eq 'saml') {
6316: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6317: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6318: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6319: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6320: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6321: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6322: }
6323: }
6324: }
6325: }
1.946 raeburn 6326: } else {
6327: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6328: $designhash{$udom.'.login.'.$key.'_'.$img} =
6329: $domconfig{'login'}{$key}{$img};
6330: }
1.699 raeburn 6331: }
6332: } else {
6333: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6334: }
1.632 raeburn 6335: }
6336: } else {
6337: $legacy{'login'} = 1;
1.518 albertel 6338: }
1.632 raeburn 6339: } else {
6340: $legacy{'login'} = 1;
1.518 albertel 6341: }
6342: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6343: if (keys(%{$domconfig{'rolecolors'}})) {
6344: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6345: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6346: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6347: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6348: }
1.518 albertel 6349: }
6350: }
1.632 raeburn 6351: } else {
6352: $legacy{'rolecolors'} = 1;
1.518 albertel 6353: }
1.632 raeburn 6354: } else {
6355: $legacy{'rolecolors'} = 1;
1.518 albertel 6356: }
1.948 raeburn 6357: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6358: if ($domconfig{'autoenroll'}{'co-owners'}) {
6359: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6360: }
6361: }
1.632 raeburn 6362: if (keys(%legacy) > 0) {
6363: my %legacyhash = &get_legacy_domconf($udom);
6364: foreach my $item (keys(%legacyhash)) {
6365: if ($item =~ /^\Q$udom\E\.login/) {
6366: if ($legacy{'login'}) {
6367: $designhash{$item} = $legacyhash{$item};
6368: }
6369: } else {
6370: if ($legacy{'rolecolors'}) {
6371: $designhash{$item} = $legacyhash{$item};
6372: }
1.518 albertel 6373: }
6374: }
6375: }
1.632 raeburn 6376: } else {
6377: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6378: }
6379: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6380: $cachetime);
6381: return %designhash;
6382: }
6383:
1.632 raeburn 6384: sub get_legacy_domconf {
6385: my ($udom) = @_;
6386: my %legacyhash;
6387: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6388: my $designfile = $designdir.'/'.$udom.'.tab';
6389: if (-e $designfile) {
1.1317 raeburn 6390: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6391: while (my $line = <$fh>) {
6392: next if ($line =~ /^\#/);
6393: chomp($line);
6394: my ($key,$val)=(split(/\=/,$line));
6395: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6396: }
6397: close($fh);
6398: }
6399: }
1.1026 raeburn 6400: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6401: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6402: }
6403: return %legacyhash;
6404: }
6405:
1.63 www 6406: =pod
6407:
1.112 bowersj2 6408: =item * &domainlogo()
1.63 www 6409:
6410: Inputs: $domain (usually will be undef)
6411:
6412: Returns: A link to a domain logo, if the domain logo exists.
6413: If the domain logo does not exist, a description of the domain.
6414:
6415: =cut
1.112 bowersj2 6416:
1.63 www 6417: ###############################################
6418: sub domainlogo {
1.517 raeburn 6419: my $domain = &determinedomain(shift);
1.518 albertel 6420: my %designhash = &get_domainconf($domain);
1.517 raeburn 6421: # See if there is a logo
6422: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6423: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6424: if ($imgsrc =~ m{^/(adm|res)/}) {
6425: if ($imgsrc =~ m{^/res/}) {
6426: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6427: &Apache::lonnet::repcopy($local_name);
6428: }
6429: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6430: }
6431: my $alttext = $domain;
6432: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6433: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6434: }
6435: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6436: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6437: return &Apache::lonnet::domain($domain,'description');
1.59 www 6438: } else {
1.60 matthew 6439: return '';
1.59 www 6440: }
6441: }
1.63 www 6442: ##############################################
6443:
6444: =pod
6445:
1.112 bowersj2 6446: =item * &designparm()
1.63 www 6447:
6448: Inputs: $which parameter; $domain (usually will be undef)
6449:
6450: Returns: value of designparamter $which
6451:
6452: =cut
1.112 bowersj2 6453:
1.397 albertel 6454:
1.400 albertel 6455: ##############################################
1.397 albertel 6456: sub designparm {
6457: my ($which,$domain)=@_;
6458: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6459: return $env{'environment.color.'.$which};
1.96 www 6460: }
1.63 www 6461: $domain=&determinedomain($domain);
1.1016 raeburn 6462: my %domdesign;
6463: unless ($domain eq 'public') {
6464: %domdesign = &get_domainconf($domain);
6465: }
1.520 raeburn 6466: my $output;
1.517 raeburn 6467: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6468: $output = $domdesign{$domain.'.'.$which};
1.63 www 6469: } else {
1.520 raeburn 6470: $output = $defaultdesign{$which};
6471: }
6472: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6473: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6474: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6475: if ($output =~ m{^/res/}) {
6476: my $local_name = &Apache::lonnet::filelocation('',$output);
6477: &Apache::lonnet::repcopy($local_name);
6478: }
1.520 raeburn 6479: $output = &lonhttpdurl($output);
6480: }
1.63 www 6481: }
1.520 raeburn 6482: return $output;
1.63 www 6483: }
1.59 www 6484:
1.822 bisitz 6485: ##############################################
6486: =pod
6487:
1.832 bisitz 6488: =item * &authorspace()
6489:
1.1028 raeburn 6490: Inputs: $url (usually will be undef).
1.832 bisitz 6491:
1.1132 raeburn 6492: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6493: directory being viewed (or for which action is being taken).
6494: If $url is provided, and begins /priv/<domain>/<uname>
6495: the path will be that portion of the $context argument.
6496: Otherwise the path will be for the author space of the current
6497: user when the current role is author, or for that of the
6498: co-author/assistant co-author space when the current role
6499: is co-author or assistant co-author.
1.832 bisitz 6500:
6501: =cut
6502:
6503: sub authorspace {
1.1028 raeburn 6504: my ($url) = @_;
6505: if ($url ne '') {
6506: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6507: return $1;
6508: }
6509: }
1.832 bisitz 6510: my $caname = '';
1.1024 www 6511: my $cadom = '';
1.1028 raeburn 6512: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6513: ($cadom,$caname) =
1.832 bisitz 6514: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6515: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6516: $caname = $env{'user.name'};
1.1024 www 6517: $cadom = $env{'user.domain'};
1.832 bisitz 6518: }
1.1028 raeburn 6519: if (($caname ne '') && ($cadom ne '')) {
6520: return "/priv/$cadom/$caname/";
6521: }
6522: return;
1.832 bisitz 6523: }
6524:
6525: ##############################################
6526: =pod
6527:
1.822 bisitz 6528: =item * &head_subbox()
6529:
6530: Inputs: $content (contains HTML code with page functions, etc.)
6531:
6532: Returns: HTML div with $content
6533: To be included in page header
6534:
6535: =cut
6536:
6537: sub head_subbox {
6538: my ($content)=@_;
6539: my $output =
1.993 raeburn 6540: '<div class="LC_head_subbox">'
1.822 bisitz 6541: .$content
6542: .'</div>'
6543: }
6544:
6545: ##############################################
6546: =pod
6547:
6548: =item * &CSTR_pageheader()
6549:
1.1026 raeburn 6550: Input: (optional) filename from which breadcrumb trail is built.
6551: In most cases no input as needed, as $env{'request.filename'}
6552: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6553: frameset flag
6554: If page header is being requested for use in a frameset, then
6555: the second (option) argument -- frameset will be true, and
6556: the target attribute set for links should be target="_parent".
1.1433 raeburn 6557: If $title is supplied as the third arg, that will be used to
1.1407 raeburn 6558: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6559:
6560: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6561: To be included on Authoring Space pages
1.822 bisitz 6562:
6563: =cut
6564:
6565: sub CSTR_pageheader {
1.1407 raeburn 6566: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6567: if ($trailfile eq '') {
6568: $trailfile = $env{'request.filename'};
6569: }
6570:
6571: # this is for resources; directories have customtitle, and crumbs
6572: # and select recent are created in lonpubdir.pm
6573:
6574: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6575: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6576: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6577: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6578: $formaction =~ s{/+}{/}g;
1.822 bisitz 6579:
6580: my $parentpath = '';
6581: my $lastitem = '';
6582: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6583: $parentpath = $1;
6584: $lastitem = $2;
6585: } else {
6586: $lastitem = $thisdisfn;
6587: }
1.921 bisitz 6588:
1.1406 raeburn 6589: my $crsauthor;
1.1246 raeburn 6590: if (($env{'request.course.id'}) &&
6591: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6592: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6593: $crsauthor = 1;
1.1406 raeburn 6594: if ($title eq '') {
6595: $title = &mt('Course Authoring Space');
6596: }
6597: } elsif ($title eq '') {
1.1246 raeburn 6598: $title = &mt('Authoring Space');
6599: }
6600:
1.1379 raeburn 6601: my ($target,$crumbtarget) = (' target="_top"','_top');
6602: if ($frameset) {
6603: $target = ' target="_parent"';
6604: $crumbtarget = '_parent';
6605: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6606: $target = '';
6607: $crumbtarget = '';
1.1379 raeburn 6608: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6609: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6610: $crumbtarget = $env{'request.deeplink.target'};
6611: }
1.1313 raeburn 6612:
1.921 bisitz 6613: my $output =
1.1407 raeburn 6614: '<div>'
1.822 bisitz 6615: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6616: .'<b>'.$title.'</b> '
1.1314 raeburn 6617: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6618: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6619:
6620: if ($lastitem) {
6621: $output .=
6622: '<span class="LC_filename">'
6623: .$lastitem
6624: .'</span>';
6625: }
1.1245 raeburn 6626:
1.1246 raeburn 6627: if ($crsauthor) {
1.1379 raeburn 6628: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6629: } else {
6630: $output .=
6631: '<br />'
1.1314 raeburn 6632: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6633: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6634: .'</form>'
1.1379 raeburn 6635: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6636: }
1.1407 raeburn 6637: $output .= '</div>';
1.921 bisitz 6638:
6639: return $output;
1.822 bisitz 6640: }
6641:
1.1419 raeburn 6642: ##############################################
6643: =pod
6644:
6645: =item * &nocodemirror()
6646:
6647: Input: None
6648:
6649: Returns: 1 if CodeMirror is deactivated based on
6650: user's preference, or domain default,
6651: if user indicated use of default.
6652:
6653: =cut
6654:
1.1416 raeburn 6655: sub nocodemirror {
6656: my $nocodem = $env{'environment.nocodemirror'};
6657: unless ($nocodem) {
6658: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6659: if ($domdefs{'nocodemirror'}) {
6660: $nocodem = 'yes';
6661: }
6662: }
1.1417 raeburn 6663: if ($nocodem eq 'yes') {
6664: return 1;
6665: }
6666: return;
1.1416 raeburn 6667: }
6668:
1.1419 raeburn 6669: ##############################################
6670: =pod
6671:
6672: =item * &permitted_editors()
6673:
1.1422 raeburn 6674: Input: $uri (optional)
1.1419 raeburn 6675:
6676: Returns: %editors hash in which keys are editors
1.1429 raeburn 6677: permitted in current Authoring Space,
6678: or in current course for web pages
6679: created in a course.
6680:
1.1419 raeburn 6681: Value for each key is 1. Possible keys
1.1429 raeburn 6682: are: edit, xml, and daxe.
6683:
6684: For a regular Authoring Space, if no specific
1.1419 raeburn 6685: set of editors has been set for the Author
6686: who owns the Authoring Space, then the
6687: domain default will be used. If no domain
6688: default has been set, then the keys will be
6689: edit and xml.
6690:
1.1429 raeburn 6691: For a course author, or for web pages created
6692: in a course, if no specific set of editors has
6693: been set for the course, then the domain
6694: course default will be used. If no domain
6695: course default has been set, then the keys
6696: will be edit and xml.
6697:
1.1419 raeburn 6698: =cut
6699:
1.1418 raeburn 6700: sub permitted_editors {
1.1422 raeburn 6701: my ($uri) = @_;
1.1429 raeburn 6702: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6703: if ($env{'request.role'} =~ m{^au\./}) {
6704: $is_author = 1;
6705: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6706: ($audom,$auname) = ($1,$2);
6707: if (($audom ne '') && ($auname ne '')) {
6708: if (($env{'user.domain'} eq $audom) &&
6709: ($env{'user.name'} eq $auname)) {
6710: $is_author = 1;
6711: } else {
6712: $is_coauthor = 1;
6713: }
6714: }
6715: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6716: my ($cdom,$cnum);
6717: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6718: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6719: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6720: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6721: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6722: $is_course = 1;
6723: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6724: ($audom,$auname) = ($1,$2);
6725: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6726: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6727: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6728: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6729: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6730: $is_course = 1;
6731: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6732: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6733: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6734: }
1.1429 raeburn 6735: unless ($is_course) {
6736: if (($audom ne '') && ($auname ne '')) {
6737: if (($env{'user.domain'} eq $audom) &&
6738: ($env{'user.name'} eq $auname)) {
6739: $is_author = 1;
6740: } else {
6741: $is_coauthor = 1;
6742: }
1.1418 raeburn 6743: }
6744: }
6745: }
6746: if ($is_author) {
6747: if (exists($env{'environment.editors'})) {
6748: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6749: } else {
6750: %editors = ( edit => 1,
6751: xml => 1,
6752: );
6753: }
6754: } elsif ($is_coauthor) {
6755: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6756: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6757: } else {
6758: %editors = ( edit => 1,
6759: xml => 1,
6760: );
6761: }
1.1429 raeburn 6762: } elsif ($is_course) {
6763: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6764: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6765: } else {
6766: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6767: if (exists($domdefaults{'crseditors'})) {
6768: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6769: } else {
6770: %editors = ( edit => 1,
6771: xml => 1,
6772: );
6773: }
6774: }
1.1418 raeburn 6775: } else {
6776: %editors = ( edit => 1,
6777: xml => 1,
6778: );
6779: }
6780: return %editors;
6781: }
6782:
1.60 matthew 6783: ###############################################
6784: ###############################################
6785:
6786: =pod
6787:
1.112 bowersj2 6788: =back
6789:
1.549 albertel 6790: =head1 HTML Helpers
1.112 bowersj2 6791:
6792: =over 4
6793:
6794: =item * &bodytag()
1.60 matthew 6795:
6796: Returns a uniform header for LON-CAPA web pages.
6797:
6798: Inputs:
6799:
1.112 bowersj2 6800: =over 4
6801:
6802: =item * $title, A title to be displayed on the page.
6803:
6804: =item * $function, the current role (can be undef).
6805:
6806: =item * $addentries, extra parameters for the <body> tag.
6807:
6808: =item * $bodyonly, if defined, only return the <body> tag.
6809:
6810: =item * $domain, if defined, force a given domain.
6811:
6812: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6813: text interface only)
1.60 matthew 6814:
1.814 bisitz 6815: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6816: navigational links
1.317 albertel 6817:
1.338 albertel 6818: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6819:
1.460 albertel 6820: =item * $args, optional argument valid values are
6821: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6822: use_absolute -> for external resource or syllabus, this will
6823: contain https://<hostname> if server uses
6824: https (as per hosts.tab), but request is for http
6825: hostname -> hostname, from $r->hostname().
1.460 albertel 6826:
1.1096 raeburn 6827: =item * $advtoolsref, optional argument, ref to an array containing
6828: inlineremote items to be added in "Functions" menu below
6829: breadcrumbs.
6830:
1.1316 raeburn 6831: =item * $ltiscope, optional argument, will be one of: resource, map or
6832: course, if LON-CAPA is in LTI Provider context. Value is
6833: the scope of use, i.e., launch was for access to a single, a map
6834: or the entire course.
6835:
6836: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6837: context, this will contain the URL for the landing item in
6838: the course, after launch from an LTI Consumer
6839:
1.1318 raeburn 6840: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6841: context, this will contain a reference to hash of items
6842: to be included in the page header and/or inline menu.
6843:
1.1385 raeburn 6844: =item * $menucoll, optional argument, if specific menu collection is in
6845: effect, either set as the default for the course, or set for
6846: the deeplink paramater for $env{'request.deeplink.login'}
6847: then $menucoll will be the number of that collection.
6848:
6849: =item * $menuref, optional argument, reference to a hash, containing the
6850: menu options included for the menu in effect, based on the
6851: configuration for the numbered menu collection in use.
6852:
6853: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6854: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6855: if so, $showncrumbsref is set there to 1, and will propagate back
6856: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6857: being called a second time.
6858:
1.112 bowersj2 6859: =back
6860:
1.60 matthew 6861: Returns: A uniform header for LON-CAPA web pages.
6862: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6863: If $bodyonly is undef or zero, an html string containing a <body> tag and
6864: other decorations will be returned.
6865:
6866: =cut
6867:
1.54 www 6868: sub bodytag {
1.831 bisitz 6869: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6870: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6871: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6872:
1.954 raeburn 6873: my $public;
6874: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6875: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6876: $public = 1;
6877: }
1.460 albertel 6878: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6879: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6880: my $hostname = $args->{'hostname'};
1.339 albertel 6881:
1.183 matthew 6882: $function = &get_users_function() if (!$function);
1.339 albertel 6883: my $font = &designparm($function.'.font',$domain);
6884: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6885:
1.803 bisitz 6886: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6887: 'bgcolor' => $pgbg,
1.339 albertel 6888: 'text' => $font,
6889: 'alink' => &designparm($function.'.alink',$domain),
6890: 'vlink' => &designparm($function.'.vlink',$domain),
6891: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6892: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6893:
1.63 www 6894: # role and realm
1.1178 raeburn 6895: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6896: if ($realm) {
6897: $realm = '/'.$realm;
6898: }
1.1357 raeburn 6899: if ($role eq 'ca') {
1.479 albertel 6900: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6901: $realm = &plainname($rname,$rdom);
1.378 raeburn 6902: }
1.55 www 6903: # realm
1.1357 raeburn 6904: my ($cid,$sec);
1.258 albertel 6905: if ($env{'request.course.id'}) {
1.1357 raeburn 6906: $cid = $env{'request.course.id'};
6907: if ($env{'request.course.sec'}) {
6908: $sec = $env{'request.course.sec'};
6909: }
6910: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6911: if (&Apache::lonnet::is_course($1,$2)) {
6912: $cid = $1.'_'.$2;
6913: $sec = $3;
6914: }
6915: }
6916: if ($cid) {
1.378 raeburn 6917: if ($env{'request.role'} !~ /^cr/) {
6918: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6919: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6920: if ($env{'request.role.desc'}) {
6921: $role = $env{'request.role.desc'};
6922: } else {
6923: $role = &mt('Helpdesk[_1]',' '.$2);
6924: }
1.1257 raeburn 6925: } else {
6926: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6927: }
1.1357 raeburn 6928: if ($sec) {
6929: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6930: }
1.1357 raeburn 6931: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6932: } else {
6933: $role = &Apache::lonnet::plaintext($role);
1.54 www 6934: }
1.433 albertel 6935:
1.359 albertel 6936: if (!$realm) { $realm=' '; }
1.330 albertel 6937:
1.438 albertel 6938: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6939:
1.101 www 6940: # construct main body tag
1.359 albertel 6941: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6942: &Apache::lontexconvert::init_math_support();
1.252 albertel 6943:
1.1131 raeburn 6944: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6945:
1.1130 raeburn 6946: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6947: return $bodytag;
1.1130 raeburn 6948: }
1.359 albertel 6949:
1.954 raeburn 6950: if ($public) {
1.433 albertel 6951: undef($role);
6952: }
1.1318 raeburn 6953:
1.1359 raeburn 6954: my $showcrstitle = 1;
1.1357 raeburn 6955: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6956: if (ref($ltimenu) eq 'HASH') {
6957: unless ($ltimenu->{'role'}) {
6958: undef($role);
6959: }
6960: unless ($ltimenu->{'coursetitle'}) {
6961: $realm=' ';
1.1359 raeburn 6962: $showcrstitle = 0;
6963: }
6964: }
6965: } elsif (($cid) && ($menucoll)) {
6966: if (ref($menuref) eq 'HASH') {
6967: unless ($menuref->{'role'}) {
6968: undef($role);
6969: }
6970: unless ($menuref->{'crs'}) {
6971: $realm=' ';
6972: $showcrstitle = 0;
1.1318 raeburn 6973: }
6974: }
6975: }
6976:
1.762 bisitz 6977: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6978: #
6979: # Extra info if you are the DC
6980: my $dc_info = '';
1.1359 raeburn 6981: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6982: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6983: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6984: $dc_info =~ s/\s+$//;
1.359 albertel 6985: }
6986:
1.1237 raeburn 6987: my $crstype;
1.1357 raeburn 6988: if ($cid) {
6989: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6990: } elsif ($args->{'crstype'}) {
6991: $crstype = $args->{'crstype'};
6992: }
6993: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6994: undef($role);
6995: } else {
1.1242 raeburn 6996: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6997: }
1.853 droeschl 6998:
1.903 droeschl 6999: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
7000:
7001: # if ($env{'request.state'} eq 'construct') {
7002: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7003: # }
7004:
1.1440 raeburn 7005: my $need_endlcint;
7006: unless ($args->{'switchserver'}) {
7007: $bodytag .= Apache::lonhtmlcommon::scripttag(
7008: Apache::lonmenu::utilityfunctions($httphost), 'start');
7009: $need_endlcint = 1;
7010: }
1.359 albertel 7011:
1.1427 raeburn 7012: my $collapsible;
1.1423 raeburn 7013: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7014: $collapsible = 1;
7015: my ($menustate,$tiptext,$divclass);
7016: if ($args->{'start_collapsed'}) {
7017: $menustate = 'collapsed';
7018: $tiptext = 'display';
7019: $divclass = 'hidden';
7020: } else {
7021: $menustate = 'expanded';
7022: $tiptext = 'hide';
7023: $divclass = 'shown';
7024: }
7025: my $alttext = &mt('menu state: '.$menustate);
7026: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7027: $bodytag .= <<"END";
7028: <div id="LC_expandingContainer" style="display:inline;">
7029: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7030: <a href="#" style="text-decoration:none;"><img class="LC_collapsible_indicator" alt="$alttext" title="$tooltip" src="/res/adm/pages/$menustate.png" style="border:0;margin:0;padding:0;max-width:100%;height:auto" /></a></div>
7031: <div class="LC_menus_content $divclass">
1.1421 raeburn 7032: END
7033: }
1.1318 raeburn 7034: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7035: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7036: $args->{'links_disabled'},
1.1421 raeburn 7037: $args->{'links_target'},
1.1427 raeburn 7038: $collapsible);
1.359 albertel 7039:
1.1318 raeburn 7040: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7041: if ($dc_info) {
7042: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7043: }
7044: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7045: <em>$realm</em> $dc_info</div>|;
1.1440 raeburn 7046: if ($need_endlcint) {
7047: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7048: }
1.1318 raeburn 7049: return $bodytag;
7050: }
1.894 droeschl 7051:
1.1318 raeburn 7052: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7053: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7054: }
1.916 droeschl 7055:
1.1318 raeburn 7056: $bodytag .= $right;
1.852 droeschl 7057:
1.1318 raeburn 7058: if ($dc_info) {
7059: $dc_info = &dc_courseid_toggle($dc_info);
7060: }
7061: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7062: }
1.916 droeschl 7063:
1.1169 raeburn 7064: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7065: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7066: if ($need_endlcint) {
7067: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7068: }
1.1168 raeburn 7069: return $bodytag;
7070: }
1.1169 raeburn 7071: #don't show menus for public users
1.954 raeburn 7072: if (!$public){
1.1318 raeburn 7073: unless ($args->{'no_inline_menu'}) {
7074: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7075: $args->{'no_primary_menu'},
1.1369 raeburn 7076: $menucoll,$menuref,
1.1380 raeburn 7077: $args->{'links_disabled'},
7078: $args->{'links_target'});
1.1318 raeburn 7079: }
1.903 droeschl 7080: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7081: if ($need_endlcint) {
7082: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7083: }
1.920 raeburn 7084: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7085: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7086: $args->{'bread_crumbs'},'','',$hostname,
7087: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7088: } elsif ($forcereg) {
7089: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7090: $args->{'group'},$args->{'hide_buttons'},
7091: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7092: } else {
7093: $bodytag .=
7094: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7095: $forcereg,$args->{'group'},
7096: $args->{'bread_crumbs'},
1.1274 raeburn 7097: $advtoolsref,'',$hostname);
1.920 raeburn 7098: }
1.1440 raeburn 7099: } else {
7100: # this is to separate menu from content when there's no secondary
1.1441 raeburn 7101: # menu. Especially needed for publicly accessible resources.
1.903 droeschl 7102: $bodytag .= '<hr style="clear:both" />';
1.1440 raeburn 7103: if ($need_endlcint) {
7104: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7105: }
1.235 raeburn 7106: }
1.1423 raeburn 7107: if ($args->{'collapsible_header'} ne '') {
7108: $bodytag .= $args->{'collapsible_header'}.
7109: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7110: '</div></div>';
7111: }
1.235 raeburn 7112: return $bodytag;
1.182 matthew 7113: }
7114:
1.917 raeburn 7115: sub dc_courseid_toggle {
7116: my ($dc_info) = @_;
1.980 raeburn 7117: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7118: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7119: &mt('(More ...)').'</a></span>'.
7120: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7121: }
7122:
1.330 albertel 7123: sub make_attr_string {
7124: my ($register,$attr_ref) = @_;
7125:
7126: if ($attr_ref && !ref($attr_ref)) {
7127: die("addentries Must be a hash ref ".
7128: join(':',caller(1))." ".
7129: join(':',caller(0))." ");
7130: }
7131:
7132: if ($register) {
1.339 albertel 7133: my ($on_load,$on_unload);
7134: foreach my $key (keys(%{$attr_ref})) {
7135: if (lc($key) eq 'onload') {
7136: $on_load.=$attr_ref->{$key}.';';
7137: delete($attr_ref->{$key});
7138:
7139: } elsif (lc($key) eq 'onunload') {
7140: $on_unload.=$attr_ref->{$key}.';';
7141: delete($attr_ref->{$key});
7142: }
7143: }
1.953 droeschl 7144: $attr_ref->{'onload'} = $on_load;
7145: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7146: }
1.339 albertel 7147:
1.330 albertel 7148: my $attr_string;
1.1159 raeburn 7149: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7150: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7151: }
7152: return $attr_string;
7153: }
7154:
7155:
1.182 matthew 7156: ###############################################
1.251 albertel 7157: ###############################################
7158:
7159: =pod
7160:
7161: =item * &endbodytag()
7162:
7163: Returns a uniform footer for LON-CAPA web pages.
7164:
1.635 raeburn 7165: Inputs: 1 - optional reference to an args hash
7166: If in the hash, key for noredirectlink has a value which evaluates to true,
7167: a 'Continue' link is not displayed if the page contains an
7168: internal redirect in the <head></head> section,
7169: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7170:
7171: =cut
7172:
7173: sub endbodytag {
1.635 raeburn 7174: my ($args) = @_;
1.1080 raeburn 7175: my $endbodytag;
7176: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7177: $endbodytag='</body>';
7178: }
1.315 albertel 7179: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7180: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7181: my ($endbodyjs,$idattr);
7182: if ($env{'internal.head.to_opener'}) {
7183: my $linkid = 'LC_continue_link';
7184: $idattr = ' id="'.$linkid.'"';
7185: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7186: $endbodyjs=<<ENDJS;
7187: <script type="text/javascript">
7188: // <![CDATA[
7189: function ebFunction(evt) {
7190: evt.preventDefault();
7191: var dest = '$redirect_for_js';
7192: if (window.opener != null && !window.opener.closed) {
7193: window.opener.location.href=dest;
7194: window.close();
7195: } else {
7196: window.location.href=dest;
7197: }
7198: return false;
7199: }
7200:
7201: \$(document).ready(function () {
7202: if (document.getElementById('$linkid')) {
7203: var clickelem = document.getElementById('$linkid');
7204: clickelem.addEventListener('click',ebFunction,false);
7205: }
7206: });
7207: // ]]>
7208: </script>
7209: ENDJS
7210: }
1.635 raeburn 7211: $endbodytag=
1.1386 raeburn 7212: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7213: &mt('Continue').'</a>'.
7214: $endbodytag;
7215: }
1.315 albertel 7216: }
1.1411 raeburn 7217: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7218: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7219: }
1.251 albertel 7220: return $endbodytag;
7221: }
7222:
1.352 albertel 7223: =pod
7224:
7225: =item * &standard_css()
7226:
7227: Returns a style sheet
7228:
7229: Inputs: (all optional)
7230: domain -> force to color decorate a page for a specific
7231: domain
7232: function -> force usage of a specific rolish color scheme
7233: bgcolor -> override the default page bgcolor
7234:
7235: =cut
7236:
1.343 albertel 7237: sub standard_css {
1.345 albertel 7238: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7239: $function = &get_users_function() if (!$function);
7240: my $tabbg = &designparm($function.'.tabbg', $domain);
7241: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7242: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7243: #second colour for later usage
1.345 albertel 7244: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7245: my $pgbg_or_bgcolor =
7246: $bgcolor ||
1.352 albertel 7247: &designparm($function.'.pgbg', $domain);
1.382 albertel 7248: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7249: my $alink = &designparm($function.'.alink', $domain);
7250: my $vlink = &designparm($function.'.vlink', $domain);
7251: my $link = &designparm($function.'.link', $domain);
7252:
1.602 albertel 7253: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7254: my $mono = 'monospace';
1.850 bisitz 7255: my $data_table_head = $sidebg;
7256: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7257: my $data_table_dark = '#E0E0E0';
1.470 banghart 7258: my $data_table_darker = '#CCCCCC';
1.349 albertel 7259: my $data_table_highlight = '#FFFF00';
1.352 albertel 7260: my $mail_new = '#FFBB77';
7261: my $mail_new_hover = '#DD9955';
7262: my $mail_read = '#BBBB77';
7263: my $mail_read_hover = '#999944';
7264: my $mail_replied = '#AAAA88';
7265: my $mail_replied_hover = '#888855';
7266: my $mail_other = '#99BBBB';
7267: my $mail_other_hover = '#669999';
1.391 albertel 7268: my $table_header = '#DDDDDD';
1.489 raeburn 7269: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7270: my $lg_border_color = '#C8C8C8';
1.952 onken 7271: my $button_hover = '#BF2317';
1.392 albertel 7272:
1.608 albertel 7273: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7274: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7275: : '0 3px 0 4px';
1.448 albertel 7276:
1.523 albertel 7277:
1.343 albertel 7278: return <<END;
1.947 droeschl 7279:
7280: /* needed for iframe to allow 100% height in FF */
7281: body, html {
7282: margin: 0;
7283: padding: 0 0.5%;
7284: height: 99%; /* to avoid scrollbars */
7285: }
7286:
1.795 www 7287: body {
1.911 bisitz 7288: font-family: $sans;
7289: line-height:130%;
7290: font-size:0.83em;
7291: color:$font;
1.1436 raeburn 7292: background-color: $pgbg_or_bgcolor;
1.795 www 7293: }
7294:
1.959 onken 7295: a:focus,
7296: a:focus img {
1.795 www 7297: color: red;
7298: }
1.698 harmsja 7299:
1.911 bisitz 7300: form, .inline {
7301: display: inline;
1.795 www 7302: }
1.721 harmsja 7303:
1.1443 raeburn 7304: .LC_visually_hidden:not(:focus):not(:active) {
7305: clip-path: inset(50%);
7306: height: 1px;
7307: overflow: hidden;
7308: position: absolute;
7309: white-space: nowrap;
7310: width: 1px;
7311: display: inline;
7312: }
7313:
1.1421 raeburn 7314: .LC_menus_content.shown{
1.1428 raeburn 7315: display: block;
1.1421 raeburn 7316: }
7317:
7318: .LC_menus_content.hidden {
7319: display: none;
7320: }
7321:
1.795 www 7322: .LC_right {
1.911 bisitz 7323: text-align:right;
1.795 www 7324: }
7325:
7326: .LC_middle {
1.911 bisitz 7327: vertical-align:middle;
1.795 www 7328: }
1.721 harmsja 7329:
1.1130 raeburn 7330: .LC_floatleft {
7331: float: left;
7332: }
7333:
7334: .LC_floatright {
7335: float: right;
7336: }
7337:
1.911 bisitz 7338: .LC_400Box {
7339: width:400px;
7340: }
1.721 harmsja 7341:
1.1421 raeburn 7342: #LC_collapsible_separator {
7343: border: 1px solid black;
7344: width: 99.9%;
7345: height: 0px;
7346: }
7347:
1.947 droeschl 7348: .LC_iframecontainer {
7349: width: 98%;
7350: margin: 0;
7351: position: fixed;
7352: top: 8.5em;
7353: bottom: 0;
7354: }
7355:
7356: .LC_iframecontainer iframe{
7357: border: none;
7358: width: 100%;
7359: height: 100%;
7360: }
7361:
1.778 bisitz 7362: .LC_filename {
7363: font-family: $mono;
7364: white-space:pre;
1.921 bisitz 7365: font-size: 120%;
1.778 bisitz 7366: }
7367:
7368: .LC_fileicon {
7369: border: none;
7370: height: 1.3em;
7371: vertical-align: text-bottom;
7372: margin-right: 0.3em;
7373: text-decoration:none;
7374: }
7375:
1.1008 www 7376: .LC_setting {
7377: text-decoration:underline;
7378: }
7379:
1.350 albertel 7380: .LC_error {
7381: color: red;
7382: }
1.795 www 7383:
1.1097 bisitz 7384: .LC_warning {
7385: color: darkorange;
7386: }
7387:
1.457 albertel 7388: .LC_diff_removed {
1.733 bisitz 7389: color: red;
1.394 albertel 7390: }
1.532 albertel 7391:
7392: .LC_info,
1.457 albertel 7393: .LC_success,
7394: .LC_diff_added {
1.350 albertel 7395: color: green;
7396: }
1.795 www 7397:
1.802 bisitz 7398: div.LC_confirm_box {
7399: background-color: #FAFAFA;
7400: border: 1px solid $lg_border_color;
7401: margin-right: 0;
7402: padding: 5px;
7403: }
7404:
7405: div.LC_confirm_box .LC_error img,
7406: div.LC_confirm_box .LC_success img {
7407: vertical-align: middle;
7408: }
7409:
1.1242 raeburn 7410: .LC_maxwidth {
7411: max-width: 100%;
7412: height: auto;
7413: }
7414:
1.1243 raeburn 7415: .LC_textsize_mobile {
7416: \@media only screen and (max-device-width: 480px) {
7417: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7418: }
7419: }
7420:
1.440 albertel 7421: .LC_icon {
1.771 droeschl 7422: border: none;
1.790 droeschl 7423: vertical-align: middle;
1.771 droeschl 7424: }
7425:
1.543 albertel 7426: .LC_docs_spacer {
7427: width: 25px;
7428: height: 1px;
1.771 droeschl 7429: border: none;
1.543 albertel 7430: }
1.346 albertel 7431:
1.532 albertel 7432: .LC_internal_info {
1.735 bisitz 7433: color: #999999;
1.532 albertel 7434: }
7435:
1.794 www 7436: .LC_discussion {
1.1050 www 7437: background: $data_table_dark;
1.911 bisitz 7438: border: 1px solid black;
7439: margin: 2px;
1.794 www 7440: }
7441:
7442: .LC_disc_action_left {
1.1050 www 7443: background: $sidebg;
1.911 bisitz 7444: text-align: left;
1.1050 www 7445: padding: 4px;
7446: margin: 2px;
1.794 www 7447: }
7448:
7449: .LC_disc_action_right {
1.1050 www 7450: background: $sidebg;
1.911 bisitz 7451: text-align: right;
1.1050 www 7452: padding: 4px;
7453: margin: 2px;
1.794 www 7454: }
7455:
7456: .LC_disc_new_item {
1.911 bisitz 7457: background: white;
7458: border: 2px solid red;
1.1050 www 7459: margin: 4px;
7460: padding: 4px;
1.794 www 7461: }
7462:
7463: .LC_disc_old_item {
1.911 bisitz 7464: background: white;
1.1050 www 7465: margin: 4px;
7466: padding: 4px;
1.794 www 7467: }
7468:
1.458 albertel 7469: table.LC_pastsubmission {
7470: border: 1px solid black;
7471: margin: 2px;
7472: }
7473:
1.924 bisitz 7474: table#LC_menubuttons {
1.345 albertel 7475: width: 100%;
7476: background: $pgbg;
1.392 albertel 7477: border: 2px;
1.402 albertel 7478: border-collapse: separate;
1.803 bisitz 7479: padding: 0;
1.345 albertel 7480: }
1.392 albertel 7481:
1.801 tempelho 7482: table#LC_title_bar a {
7483: color: $fontmenu;
7484: }
1.836 bisitz 7485:
1.807 droeschl 7486: table#LC_title_bar {
1.819 tempelho 7487: clear: both;
1.836 bisitz 7488: display: none;
1.807 droeschl 7489: }
7490:
1.795 www 7491: table#LC_title_bar,
1.933 droeschl 7492: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7493: table#LC_title_bar.LC_with_remote {
1.359 albertel 7494: width: 100%;
1.392 albertel 7495: border-color: $pgbg;
7496: border-style: solid;
7497: border-width: $border;
1.379 albertel 7498: background: $pgbg;
1.801 tempelho 7499: color: $fontmenu;
1.392 albertel 7500: border-collapse: collapse;
1.803 bisitz 7501: padding: 0;
1.819 tempelho 7502: margin: 0;
1.359 albertel 7503: }
1.795 www 7504:
1.933 droeschl 7505: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7506: margin: 0;
7507: padding: 0;
1.933 droeschl 7508: position: relative;
7509: list-style: none;
1.913 droeschl 7510: }
1.933 droeschl 7511: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7512: display: inline;
7513: }
1.933 droeschl 7514:
7515: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7516: padding: 0;
1.933 droeschl 7517: margin: 0;
7518: float: left;
1.913 droeschl 7519: }
1.933 droeschl 7520: .LC_breadcrumb_tools_tools {
7521: padding: 0;
7522: margin: 0;
1.913 droeschl 7523: float: right;
7524: }
7525:
1.1240 raeburn 7526: .LC_placement_prog {
7527: padding-right: 20px;
7528: font-weight: bold;
7529: font-size: 90%;
7530: }
7531:
1.359 albertel 7532: table#LC_title_bar td {
7533: background: $tabbg;
7534: }
1.795 www 7535:
1.911 bisitz 7536: table#LC_menubuttons img {
1.803 bisitz 7537: border: none;
1.346 albertel 7538: }
1.795 www 7539:
1.842 droeschl 7540: .LC_breadcrumbs_component {
1.911 bisitz 7541: float: right;
7542: margin: 0 1em;
1.357 albertel 7543: }
1.842 droeschl 7544: .LC_breadcrumbs_component img {
1.911 bisitz 7545: vertical-align: middle;
1.777 tempelho 7546: }
1.795 www 7547:
1.1243 raeburn 7548: .LC_breadcrumbs_hoverable {
7549: background: $sidebg;
7550: }
7551:
1.383 albertel 7552: td.LC_table_cell_checkbox {
7553: text-align: center;
7554: }
1.795 www 7555:
7556: .LC_fontsize_small {
1.911 bisitz 7557: font-size: 70%;
1.705 tempelho 7558: }
7559:
1.844 bisitz 7560: #LC_breadcrumbs {
1.911 bisitz 7561: clear:both;
7562: background: $sidebg;
7563: border-bottom: 1px solid $lg_border_color;
7564: line-height: 2.5em;
1.933 droeschl 7565: overflow: hidden;
1.911 bisitz 7566: margin: 0;
7567: padding: 0;
1.995 raeburn 7568: text-align: left;
1.819 tempelho 7569: }
1.862 bisitz 7570:
1.1098 bisitz 7571: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7572: clear:both;
7573: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7574: border: 1px solid $sidebg;
1.1098 bisitz 7575: margin: 0 0 10px 0;
1.966 bisitz 7576: padding: 3px;
1.995 raeburn 7577: text-align: left;
1.822 bisitz 7578: }
7579:
1.795 www 7580: .LC_fontsize_medium {
1.911 bisitz 7581: font-size: 85%;
1.705 tempelho 7582: }
7583:
1.795 www 7584: .LC_fontsize_large {
1.911 bisitz 7585: font-size: 120%;
1.705 tempelho 7586: }
7587:
1.346 albertel 7588: .LC_menubuttons_inline_text {
7589: color: $font;
1.698 harmsja 7590: font-size: 90%;
1.701 harmsja 7591: padding-left:3px;
1.346 albertel 7592: }
7593:
1.934 droeschl 7594: .LC_menubuttons_inline_text img{
7595: vertical-align: middle;
7596: }
7597:
1.1051 www 7598: li.LC_menubuttons_inline_text img {
1.951 onken 7599: cursor:pointer;
1.1002 droeschl 7600: text-decoration: none;
1.951 onken 7601: }
7602:
1.526 www 7603: .LC_menubuttons_link {
7604: text-decoration: none;
7605: }
1.795 www 7606:
1.522 albertel 7607: .LC_menubuttons_category {
1.521 www 7608: color: $font;
1.526 www 7609: background: $pgbg;
1.521 www 7610: font-size: larger;
7611: font-weight: bold;
7612: }
7613:
1.346 albertel 7614: td.LC_menubuttons_text {
1.911 bisitz 7615: color: $font;
1.346 albertel 7616: }
1.706 harmsja 7617:
1.346 albertel 7618: .LC_current_location {
7619: background: $tabbg;
7620: }
1.795 www 7621:
1.1286 raeburn 7622: td.LC_zero_height {
7623: line-height: 0;
7624: cellpadding: 0;
7625: }
7626:
1.938 bisitz 7627: table.LC_data_table {
1.347 albertel 7628: border: 1px solid #000000;
1.402 albertel 7629: border-collapse: separate;
1.426 albertel 7630: border-spacing: 1px;
1.610 albertel 7631: background: $pgbg;
1.347 albertel 7632: }
1.795 www 7633:
1.422 albertel 7634: .LC_data_table_dense {
7635: font-size: small;
7636: }
1.795 www 7637:
1.507 raeburn 7638: table.LC_nested_outer {
7639: border: 1px solid #000000;
1.589 raeburn 7640: border-collapse: collapse;
1.803 bisitz 7641: border-spacing: 0;
1.507 raeburn 7642: width: 100%;
7643: }
1.795 www 7644:
1.879 raeburn 7645: table.LC_innerpickbox,
1.507 raeburn 7646: table.LC_nested {
1.803 bisitz 7647: border: none;
1.589 raeburn 7648: border-collapse: collapse;
1.803 bisitz 7649: border-spacing: 0;
1.507 raeburn 7650: width: 100%;
7651: }
1.795 www 7652:
1.911 bisitz 7653: table.LC_data_table tr th,
7654: table.LC_calendar tr th,
1.879 raeburn 7655: table.LC_prior_tries tr th,
7656: table.LC_innerpickbox tr th {
1.349 albertel 7657: font-weight: bold;
7658: background-color: $data_table_head;
1.801 tempelho 7659: color:$fontmenu;
1.701 harmsja 7660: font-size:90%;
1.347 albertel 7661: }
1.795 www 7662:
1.879 raeburn 7663: table.LC_innerpickbox tr th,
7664: table.LC_innerpickbox tr td {
7665: vertical-align: top;
7666: }
7667:
1.711 raeburn 7668: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7669: background-color: #CCCCCC;
1.711 raeburn 7670: font-weight: bold;
7671: text-align: left;
7672: }
1.795 www 7673:
1.912 bisitz 7674: table.LC_data_table tr.LC_odd_row > td {
7675: background-color: $data_table_light;
7676: padding: 2px;
7677: vertical-align: top;
7678: }
7679:
1.809 bisitz 7680: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7681: background-color: $data_table_light;
1.912 bisitz 7682: vertical-align: top;
7683: }
7684:
7685: table.LC_data_table tr.LC_even_row > td {
7686: background-color: $data_table_dark;
1.425 albertel 7687: padding: 2px;
1.900 bisitz 7688: vertical-align: top;
1.347 albertel 7689: }
1.795 www 7690:
1.809 bisitz 7691: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7692: background-color: $data_table_dark;
1.900 bisitz 7693: vertical-align: top;
1.347 albertel 7694: }
1.795 www 7695:
1.425 albertel 7696: table.LC_data_table tr.LC_data_table_highlight td {
7697: background-color: $data_table_darker;
7698: }
1.795 www 7699:
1.639 raeburn 7700: table.LC_data_table tr td.LC_leftcol_header {
7701: background-color: $data_table_head;
7702: font-weight: bold;
7703: }
1.795 www 7704:
1.451 albertel 7705: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7706: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7707: font-weight: bold;
7708: font-style: italic;
7709: text-align: center;
7710: padding: 8px;
1.347 albertel 7711: }
1.795 www 7712:
1.1114 raeburn 7713: table.LC_data_table tr.LC_empty_row td,
7714: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7715: background-color: $sidebg;
7716: }
7717:
7718: table.LC_nested tr.LC_empty_row td {
7719: background-color: #FFFFFF;
7720: }
7721:
1.890 droeschl 7722: table.LC_caption {
7723: }
7724:
1.507 raeburn 7725: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7726: padding: 4ex
7727: }
1.795 www 7728:
1.507 raeburn 7729: table.LC_nested_outer tr th {
7730: font-weight: bold;
1.801 tempelho 7731: color:$fontmenu;
1.507 raeburn 7732: background-color: $data_table_head;
1.701 harmsja 7733: font-size: small;
1.507 raeburn 7734: border-bottom: 1px solid #000000;
7735: }
1.795 www 7736:
1.507 raeburn 7737: table.LC_nested_outer tr td.LC_subheader {
7738: background-color: $data_table_head;
7739: font-weight: bold;
7740: font-size: small;
7741: border-bottom: 1px solid #000000;
7742: text-align: right;
1.451 albertel 7743: }
1.795 www 7744:
1.507 raeburn 7745: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7746: background-color: #CCCCCC;
1.451 albertel 7747: font-weight: bold;
7748: font-size: small;
1.507 raeburn 7749: text-align: center;
7750: }
1.795 www 7751:
1.589 raeburn 7752: table.LC_nested tr.LC_info_row td.LC_left_item,
7753: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7754: text-align: left;
1.451 albertel 7755: }
1.795 www 7756:
1.507 raeburn 7757: table.LC_nested td {
1.735 bisitz 7758: background-color: #FFFFFF;
1.451 albertel 7759: font-size: small;
1.507 raeburn 7760: }
1.795 www 7761:
1.507 raeburn 7762: table.LC_nested_outer tr th.LC_right_item,
7763: table.LC_nested tr.LC_info_row td.LC_right_item,
7764: table.LC_nested tr.LC_odd_row td.LC_right_item,
7765: table.LC_nested tr td.LC_right_item {
1.451 albertel 7766: text-align: right;
7767: }
7768:
1.507 raeburn 7769: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7770: background-color: #EEEEEE;
1.451 albertel 7771: }
7772:
1.473 raeburn 7773: table.LC_createuser {
7774: }
7775:
7776: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7777: font-size: small;
1.473 raeburn 7778: }
7779:
7780: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7781: background-color: #CCCCCC;
1.473 raeburn 7782: font-weight: bold;
7783: text-align: center;
7784: }
7785:
1.349 albertel 7786: table.LC_calendar {
7787: border: 1px solid #000000;
7788: border-collapse: collapse;
1.917 raeburn 7789: width: 98%;
1.349 albertel 7790: }
1.795 www 7791:
1.349 albertel 7792: table.LC_calendar_pickdate {
7793: font-size: xx-small;
7794: }
1.795 www 7795:
1.349 albertel 7796: table.LC_calendar tr td {
7797: border: 1px solid #000000;
7798: vertical-align: top;
1.917 raeburn 7799: width: 14%;
1.349 albertel 7800: }
1.795 www 7801:
1.349 albertel 7802: table.LC_calendar tr td.LC_calendar_day_empty {
7803: background-color: $data_table_dark;
7804: }
1.795 www 7805:
1.779 bisitz 7806: table.LC_calendar tr td.LC_calendar_day_current {
7807: background-color: $data_table_highlight;
1.777 tempelho 7808: }
1.795 www 7809:
1.938 bisitz 7810: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7811: background-color: $mail_new;
7812: }
1.795 www 7813:
1.938 bisitz 7814: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7815: background-color: $mail_new_hover;
7816: }
1.795 www 7817:
1.938 bisitz 7818: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7819: background-color: $mail_read;
7820: }
1.795 www 7821:
1.938 bisitz 7822: /*
7823: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7824: background-color: $mail_read_hover;
7825: }
1.938 bisitz 7826: */
1.795 www 7827:
1.938 bisitz 7828: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7829: background-color: $mail_replied;
7830: }
1.795 www 7831:
1.938 bisitz 7832: /*
7833: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7834: background-color: $mail_replied_hover;
7835: }
1.938 bisitz 7836: */
1.795 www 7837:
1.938 bisitz 7838: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7839: background-color: $mail_other;
7840: }
1.795 www 7841:
1.938 bisitz 7842: /*
7843: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7844: background-color: $mail_other_hover;
7845: }
1.938 bisitz 7846: */
1.494 raeburn 7847:
1.777 tempelho 7848: table.LC_data_table tr > td.LC_browser_file,
7849: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7850: background: #AAEE77;
1.389 albertel 7851: }
1.795 www 7852:
1.777 tempelho 7853: table.LC_data_table tr > td.LC_browser_file_locked,
7854: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7855: background: #FFAA99;
1.387 albertel 7856: }
1.795 www 7857:
1.777 tempelho 7858: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7859: background: #888888;
1.779 bisitz 7860: }
1.795 www 7861:
1.777 tempelho 7862: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7863: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7864: background: #F8F866;
1.777 tempelho 7865: }
1.795 www 7866:
1.696 bisitz 7867: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7868: background: #E0E8FF;
1.387 albertel 7869: }
1.696 bisitz 7870:
1.707 bisitz 7871: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7872: /* background: #77FF77; */
1.707 bisitz 7873: }
1.795 www 7874:
1.707 bisitz 7875: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7876: border-right: 8px solid #FFFF77;
1.707 bisitz 7877: }
1.795 www 7878:
1.707 bisitz 7879: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7880: border-right: 8px solid #FFAA77;
1.707 bisitz 7881: }
1.795 www 7882:
1.707 bisitz 7883: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7884: border-right: 8px solid #FF7777;
1.707 bisitz 7885: }
1.795 www 7886:
1.707 bisitz 7887: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7888: border-right: 8px solid #AAFF77;
1.707 bisitz 7889: }
1.795 www 7890:
1.707 bisitz 7891: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7892: border-right: 8px solid #11CC55;
1.707 bisitz 7893: }
7894:
1.388 albertel 7895: span.LC_current_location {
1.701 harmsja 7896: font-size:larger;
1.388 albertel 7897: background: $pgbg;
7898: }
1.387 albertel 7899:
1.1029 www 7900: span.LC_current_nav_location {
7901: font-weight:bold;
7902: background: $sidebg;
7903: }
7904:
1.395 albertel 7905: span.LC_parm_menu_item {
7906: font-size: larger;
7907: }
1.795 www 7908:
1.395 albertel 7909: span.LC_parm_scope_all {
7910: color: red;
7911: }
1.795 www 7912:
1.395 albertel 7913: span.LC_parm_scope_folder {
7914: color: green;
7915: }
1.795 www 7916:
1.395 albertel 7917: span.LC_parm_scope_resource {
7918: color: orange;
7919: }
1.795 www 7920:
1.395 albertel 7921: span.LC_parm_part {
7922: color: blue;
7923: }
1.795 www 7924:
1.911 bisitz 7925: span.LC_parm_folder,
7926: span.LC_parm_symb {
1.395 albertel 7927: font-size: x-small;
7928: font-family: $mono;
7929: color: #AAAAAA;
7930: }
7931:
1.977 bisitz 7932: ul.LC_parm_parmlist li {
7933: display: inline-block;
7934: padding: 0.3em 0.8em;
7935: vertical-align: top;
7936: width: 150px;
7937: border-top:1px solid $lg_border_color;
7938: }
7939:
1.795 www 7940: td.LC_parm_overview_level_menu,
7941: td.LC_parm_overview_map_menu,
7942: td.LC_parm_overview_parm_selectors,
7943: td.LC_parm_overview_restrictions {
1.396 albertel 7944: border: 1px solid black;
7945: border-collapse: collapse;
7946: }
1.795 www 7947:
1.1285 raeburn 7948: span.LC_parm_recursive,
7949: td.LC_parm_recursive {
7950: font-weight: bold;
7951: font-size: smaller;
7952: }
7953:
1.396 albertel 7954: table.LC_parm_overview_restrictions td {
7955: border-width: 1px 4px 1px 4px;
7956: border-style: solid;
7957: border-color: $pgbg;
7958: text-align: center;
7959: }
1.795 www 7960:
1.396 albertel 7961: table.LC_parm_overview_restrictions th {
7962: background: $tabbg;
7963: border-width: 1px 4px 1px 4px;
7964: border-style: solid;
7965: border-color: $pgbg;
7966: }
1.795 www 7967:
1.398 albertel 7968: table#LC_helpmenu {
1.803 bisitz 7969: border: none;
1.398 albertel 7970: height: 55px;
1.803 bisitz 7971: border-spacing: 0;
1.398 albertel 7972: }
7973:
7974: table#LC_helpmenu fieldset legend {
7975: font-size: larger;
7976: }
1.795 www 7977:
1.397 albertel 7978: table#LC_helpmenu_links {
7979: width: 100%;
7980: border: 1px solid black;
7981: background: $pgbg;
1.803 bisitz 7982: padding: 0;
1.397 albertel 7983: border-spacing: 1px;
7984: }
1.795 www 7985:
1.397 albertel 7986: table#LC_helpmenu_links tr td {
7987: padding: 1px;
7988: background: $tabbg;
1.399 albertel 7989: text-align: center;
7990: font-weight: bold;
1.397 albertel 7991: }
1.396 albertel 7992:
1.795 www 7993: table#LC_helpmenu_links a:link,
7994: table#LC_helpmenu_links a:visited,
1.397 albertel 7995: table#LC_helpmenu_links a:active {
7996: text-decoration: none;
7997: color: $font;
7998: }
1.795 www 7999:
1.397 albertel 8000: table#LC_helpmenu_links a:hover {
8001: text-decoration: underline;
8002: color: $vlink;
8003: }
1.396 albertel 8004:
1.417 albertel 8005: .LC_chrt_popup_exists {
8006: border: 1px solid #339933;
8007: margin: -1px;
8008: }
1.795 www 8009:
1.417 albertel 8010: .LC_chrt_popup_up {
8011: border: 1px solid yellow;
8012: margin: -1px;
8013: }
1.795 www 8014:
1.417 albertel 8015: .LC_chrt_popup {
8016: border: 1px solid #8888FF;
8017: background: #CCCCFF;
8018: }
1.795 www 8019:
1.421 albertel 8020: table.LC_pick_box {
8021: border-collapse: separate;
8022: background: white;
8023: border: 1px solid black;
8024: border-spacing: 1px;
8025: }
1.795 www 8026:
1.421 albertel 8027: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 8028: background: $sidebg;
1.421 albertel 8029: font-weight: bold;
1.900 bisitz 8030: text-align: left;
1.740 bisitz 8031: vertical-align: top;
1.421 albertel 8032: width: 184px;
8033: padding: 8px;
8034: }
1.795 www 8035:
1.579 raeburn 8036: table.LC_pick_box td.LC_pick_box_value {
8037: text-align: left;
8038: padding: 8px;
8039: }
1.795 www 8040:
1.579 raeburn 8041: table.LC_pick_box td.LC_pick_box_select {
8042: text-align: left;
8043: padding: 8px;
8044: }
1.795 www 8045:
1.424 albertel 8046: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8047: padding: 0;
1.421 albertel 8048: height: 1px;
8049: background: black;
8050: }
1.795 www 8051:
1.421 albertel 8052: table.LC_pick_box td.LC_pick_box_submit {
8053: text-align: right;
8054: }
1.795 www 8055:
1.579 raeburn 8056: table.LC_pick_box td.LC_evenrow_value {
8057: text-align: left;
8058: padding: 8px;
8059: background-color: $data_table_light;
8060: }
1.795 www 8061:
1.579 raeburn 8062: table.LC_pick_box td.LC_oddrow_value {
8063: text-align: left;
8064: padding: 8px;
8065: background-color: $data_table_light;
8066: }
1.795 www 8067:
1.579 raeburn 8068: span.LC_helpform_receipt_cat {
8069: font-weight: bold;
8070: }
1.795 www 8071:
1.424 albertel 8072: table.LC_group_priv_box {
8073: background: white;
8074: border: 1px solid black;
8075: border-spacing: 1px;
8076: }
1.795 www 8077:
1.424 albertel 8078: table.LC_group_priv_box td.LC_pick_box_title {
8079: background: $tabbg;
8080: font-weight: bold;
8081: text-align: right;
8082: width: 184px;
8083: }
1.795 www 8084:
1.424 albertel 8085: table.LC_group_priv_box td.LC_groups_fixed {
8086: background: $data_table_light;
8087: text-align: center;
8088: }
1.795 www 8089:
1.424 albertel 8090: table.LC_group_priv_box td.LC_groups_optional {
8091: background: $data_table_dark;
8092: text-align: center;
8093: }
1.795 www 8094:
1.424 albertel 8095: table.LC_group_priv_box td.LC_groups_functionality {
8096: background: $data_table_darker;
8097: text-align: center;
8098: font-weight: bold;
8099: }
1.795 www 8100:
1.424 albertel 8101: table.LC_group_priv td {
8102: text-align: left;
1.803 bisitz 8103: padding: 0;
1.424 albertel 8104: }
8105:
8106: .LC_navbuttons {
8107: margin: 2ex 0ex 2ex 0ex;
8108: }
1.795 www 8109:
1.423 albertel 8110: .LC_topic_bar {
8111: font-weight: bold;
8112: background: $tabbg;
1.918 wenzelju 8113: margin: 1em 0em 1em 2em;
1.805 bisitz 8114: padding: 3px;
1.918 wenzelju 8115: font-size: 1.2em;
1.423 albertel 8116: }
1.795 www 8117:
1.423 albertel 8118: .LC_topic_bar span {
1.918 wenzelju 8119: left: 0.5em;
8120: position: absolute;
1.423 albertel 8121: vertical-align: middle;
1.918 wenzelju 8122: font-size: 1.2em;
1.423 albertel 8123: }
1.795 www 8124:
1.423 albertel 8125: table.LC_course_group_status {
8126: margin: 20px;
8127: }
1.795 www 8128:
1.423 albertel 8129: table.LC_status_selector td {
8130: vertical-align: top;
8131: text-align: center;
1.424 albertel 8132: padding: 4px;
8133: }
1.795 www 8134:
1.599 albertel 8135: div.LC_feedback_link {
1.616 albertel 8136: clear: both;
1.829 kalberla 8137: background: $sidebg;
1.779 bisitz 8138: width: 100%;
1.829 kalberla 8139: padding-bottom: 10px;
8140: border: 1px $tabbg solid;
1.833 kalberla 8141: height: 22px;
8142: line-height: 22px;
8143: padding-top: 5px;
8144: }
8145:
8146: div.LC_feedback_link img {
8147: height: 22px;
1.867 kalberla 8148: vertical-align:middle;
1.829 kalberla 8149: }
8150:
1.911 bisitz 8151: div.LC_feedback_link a {
1.829 kalberla 8152: text-decoration: none;
1.489 raeburn 8153: }
1.795 www 8154:
1.867 kalberla 8155: div.LC_comblock {
1.911 bisitz 8156: display:inline;
1.867 kalberla 8157: color:$font;
8158: font-size:90%;
8159: }
8160:
8161: div.LC_feedback_link div.LC_comblock {
8162: padding-left:5px;
8163: }
8164:
8165: div.LC_feedback_link div.LC_comblock a {
8166: color:$font;
8167: }
8168:
1.489 raeburn 8169: span.LC_feedback_link {
1.858 bisitz 8170: /* background: $feedback_link_bg; */
1.599 albertel 8171: font-size: larger;
8172: }
1.795 www 8173:
1.599 albertel 8174: span.LC_message_link {
1.858 bisitz 8175: /* background: $feedback_link_bg; */
1.599 albertel 8176: font-size: larger;
8177: position: absolute;
8178: right: 1em;
1.489 raeburn 8179: }
1.421 albertel 8180:
1.515 albertel 8181: table.LC_prior_tries {
1.524 albertel 8182: border: 1px solid #000000;
8183: border-collapse: separate;
8184: border-spacing: 1px;
1.515 albertel 8185: }
1.523 albertel 8186:
1.515 albertel 8187: table.LC_prior_tries td {
1.524 albertel 8188: padding: 2px;
1.515 albertel 8189: }
1.523 albertel 8190:
8191: .LC_answer_correct {
1.795 www 8192: background: lightgreen;
8193: color: darkgreen;
8194: padding: 6px;
1.523 albertel 8195: }
1.795 www 8196:
1.523 albertel 8197: .LC_answer_charged_try {
1.797 www 8198: background: #FFAAAA;
1.795 www 8199: color: darkred;
8200: padding: 6px;
1.523 albertel 8201: }
1.795 www 8202:
1.779 bisitz 8203: .LC_answer_not_charged_try,
1.523 albertel 8204: .LC_answer_no_grade,
8205: .LC_answer_late {
1.795 www 8206: background: lightyellow;
1.523 albertel 8207: color: black;
1.795 www 8208: padding: 6px;
1.523 albertel 8209: }
1.795 www 8210:
1.523 albertel 8211: .LC_answer_previous {
1.795 www 8212: background: lightblue;
8213: color: darkblue;
8214: padding: 6px;
1.523 albertel 8215: }
1.795 www 8216:
1.779 bisitz 8217: .LC_answer_no_message {
1.777 tempelho 8218: background: #FFFFFF;
8219: color: black;
1.795 www 8220: padding: 6px;
1.779 bisitz 8221: }
1.795 www 8222:
1.1334 raeburn 8223: .LC_answer_unknown,
8224: .LC_answer_warning {
1.779 bisitz 8225: background: orange;
8226: color: black;
1.795 www 8227: padding: 6px;
1.777 tempelho 8228: }
1.795 www 8229:
1.1446 raeburn 8230: .LC_prob_status {
1.1447 ! raeburn 8231: margin-top: 5px;
1.1446 raeburn 8232: padding-top: 0;
8233: padding-left: 0;
8234: padding-bottom: 0;
8235: padding-right: 5px;
8236: }
8237:
1.529 albertel 8238: span.LC_prior_numerical,
8239: span.LC_prior_string,
8240: span.LC_prior_custom,
8241: span.LC_prior_reaction,
8242: span.LC_prior_math {
1.925 bisitz 8243: font-family: $mono;
1.523 albertel 8244: white-space: pre;
8245: }
8246:
1.525 albertel 8247: span.LC_prior_string {
1.925 bisitz 8248: font-family: $mono;
1.525 albertel 8249: white-space: pre;
8250: }
8251:
1.523 albertel 8252: table.LC_prior_option {
8253: width: 100%;
8254: border-collapse: collapse;
8255: }
1.795 www 8256:
1.911 bisitz 8257: table.LC_prior_rank,
1.795 www 8258: table.LC_prior_match {
1.528 albertel 8259: border-collapse: collapse;
8260: }
1.795 www 8261:
1.528 albertel 8262: table.LC_prior_option tr td,
8263: table.LC_prior_rank tr td,
8264: table.LC_prior_match tr td {
1.524 albertel 8265: border: 1px solid #000000;
1.515 albertel 8266: }
8267:
1.855 bisitz 8268: .LC_nobreak {
1.544 albertel 8269: white-space: nowrap;
1.519 raeburn 8270: }
8271:
1.576 raeburn 8272: span.LC_cusr_emph {
8273: font-style: italic;
8274: }
8275:
1.633 raeburn 8276: span.LC_cusr_subheading {
8277: font-weight: normal;
8278: font-size: 85%;
8279: }
8280:
1.861 bisitz 8281: div.LC_docs_entry_move {
1.859 bisitz 8282: border: 1px solid #BBBBBB;
1.545 albertel 8283: background: #DDDDDD;
1.861 bisitz 8284: width: 22px;
1.859 bisitz 8285: padding: 1px;
8286: margin: 0;
1.545 albertel 8287: }
8288:
1.861 bisitz 8289: table.LC_data_table tr > td.LC_docs_entry_commands,
8290: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8291: font-size: x-small;
8292: }
1.795 www 8293:
1.861 bisitz 8294: .LC_docs_entry_parameter {
8295: white-space: nowrap;
8296: }
8297:
1.544 albertel 8298: .LC_docs_copy {
1.545 albertel 8299: color: #000099;
1.544 albertel 8300: }
1.795 www 8301:
1.544 albertel 8302: .LC_docs_cut {
1.545 albertel 8303: color: #550044;
1.544 albertel 8304: }
1.795 www 8305:
1.544 albertel 8306: .LC_docs_rename {
1.545 albertel 8307: color: #009900;
1.544 albertel 8308: }
1.795 www 8309:
1.544 albertel 8310: .LC_docs_remove {
1.545 albertel 8311: color: #990000;
8312: }
8313:
1.1284 raeburn 8314: .LC_docs_alias {
8315: color: #440055;
8316: }
8317:
1.1286 raeburn 8318: .LC_domprefs_email,
1.1284 raeburn 8319: .LC_docs_alias_name,
1.547 albertel 8320: .LC_docs_reinit_warn,
8321: .LC_docs_ext_edit {
8322: font-size: x-small;
8323: }
8324:
1.545 albertel 8325: table.LC_docs_adddocs td,
8326: table.LC_docs_adddocs th {
8327: border: 1px solid #BBBBBB;
8328: padding: 4px;
8329: background: #DDDDDD;
1.543 albertel 8330: }
8331:
1.584 albertel 8332: table.LC_sty_begin {
8333: background: #BBFFBB;
8334: }
1.795 www 8335:
1.584 albertel 8336: table.LC_sty_end {
8337: background: #FFBBBB;
8338: }
8339:
1.589 raeburn 8340: table.LC_double_column {
1.803 bisitz 8341: border-width: 0;
1.589 raeburn 8342: border-collapse: collapse;
8343: width: 100%;
8344: padding: 2px;
8345: }
8346:
8347: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8348: top: 2px;
1.589 raeburn 8349: left: 2px;
8350: width: 47%;
8351: vertical-align: top;
8352: }
8353:
8354: table.LC_double_column tr td.LC_right_col {
8355: top: 2px;
1.779 bisitz 8356: right: 2px;
1.589 raeburn 8357: width: 47%;
8358: vertical-align: top;
8359: }
8360:
1.591 raeburn 8361: div.LC_left_float {
8362: float: left;
8363: padding-right: 5%;
1.597 albertel 8364: padding-bottom: 4px;
1.591 raeburn 8365: }
8366:
8367: div.LC_clear_float_header {
1.597 albertel 8368: padding-bottom: 2px;
1.591 raeburn 8369: }
8370:
8371: div.LC_clear_float_footer {
1.597 albertel 8372: padding-top: 10px;
1.591 raeburn 8373: clear: both;
8374: }
8375:
1.597 albertel 8376: div.LC_grade_show_user {
1.941 bisitz 8377: /* border-left: 5px solid $sidebg; */
8378: border-top: 5px solid #000000;
8379: margin: 50px 0 0 0;
1.936 bisitz 8380: padding: 15px 0 5px 10px;
1.597 albertel 8381: }
1.795 www 8382:
1.936 bisitz 8383: div.LC_grade_show_user_odd_row {
1.941 bisitz 8384: /* border-left: 5px solid #000000; */
8385: }
8386:
8387: div.LC_grade_show_user div.LC_Box {
8388: margin-right: 50px;
1.597 albertel 8389: }
8390:
8391: div.LC_grade_submissions,
8392: div.LC_grade_message_center,
1.936 bisitz 8393: div.LC_grade_info_links {
1.597 albertel 8394: margin: 5px;
8395: width: 99%;
8396: background: #FFFFFF;
8397: }
1.795 www 8398:
1.597 albertel 8399: div.LC_grade_submissions_header,
1.936 bisitz 8400: div.LC_grade_message_center_header {
1.705 tempelho 8401: font-weight: bold;
8402: font-size: large;
1.597 albertel 8403: }
1.795 www 8404:
1.597 albertel 8405: div.LC_grade_submissions_body,
1.936 bisitz 8406: div.LC_grade_message_center_body {
1.597 albertel 8407: border: 1px solid black;
8408: width: 99%;
8409: background: #FFFFFF;
8410: }
1.795 www 8411:
1.613 albertel 8412: table.LC_scantron_action {
8413: width: 100%;
8414: }
1.795 www 8415:
1.613 albertel 8416: table.LC_scantron_action tr th {
1.698 harmsja 8417: font-weight:bold;
8418: font-style:normal;
1.613 albertel 8419: }
1.795 www 8420:
1.779 bisitz 8421: .LC_edit_problem_header,
1.614 albertel 8422: div.LC_edit_problem_footer {
1.705 tempelho 8423: font-weight: normal;
8424: font-size: medium;
1.602 albertel 8425: margin: 2px;
1.1060 bisitz 8426: background-color: $sidebg;
1.600 albertel 8427: }
1.795 www 8428:
1.600 albertel 8429: div.LC_edit_problem_header,
1.602 albertel 8430: div.LC_edit_problem_header div,
1.614 albertel 8431: div.LC_edit_problem_footer,
8432: div.LC_edit_problem_footer div,
1.602 albertel 8433: div.LC_edit_problem_editxml_header,
8434: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8435: z-index: 100;
1.600 albertel 8436: }
1.795 www 8437:
1.600 albertel 8438: div.LC_edit_problem_header_title {
1.705 tempelho 8439: font-weight: bold;
8440: font-size: larger;
1.602 albertel 8441: background: $tabbg;
8442: padding: 3px;
1.1060 bisitz 8443: margin: 0 0 5px 0;
1.602 albertel 8444: }
1.795 www 8445:
1.602 albertel 8446: table.LC_edit_problem_header_title {
8447: width: 100%;
1.600 albertel 8448: background: $tabbg;
1.602 albertel 8449: }
8450:
1.1205 golterma 8451: div.LC_edit_actionbar {
8452: background-color: $sidebg;
1.1218 droeschl 8453: margin: 0;
8454: padding: 0;
8455: line-height: 200%;
1.602 albertel 8456: }
1.795 www 8457:
1.1218 droeschl 8458: div.LC_edit_actionbar div{
8459: padding: 0;
8460: margin: 0;
8461: display: inline-block;
1.600 albertel 8462: }
1.795 www 8463:
1.1124 bisitz 8464: .LC_edit_opt {
8465: padding-left: 1em;
8466: white-space: nowrap;
8467: }
8468:
1.1152 golterma 8469: .LC_edit_problem_latexhelper{
8470: text-align: right;
8471: }
8472:
8473: #LC_edit_problem_colorful div{
8474: margin-left: 40px;
8475: }
8476:
1.1205 golterma 8477: #LC_edit_problem_codemirror div{
8478: margin-left: 0px;
8479: }
8480:
1.911 bisitz 8481: img.stift {
1.803 bisitz 8482: border-width: 0;
8483: vertical-align: middle;
1.677 riegler 8484: }
1.680 riegler 8485:
1.923 bisitz 8486: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8487: vertical-align: top;
1.777 tempelho 8488: }
1.795 www 8489:
1.716 raeburn 8490: div.LC_createcourse {
1.911 bisitz 8491: margin: 10px 10px 10px 10px;
1.716 raeburn 8492: }
8493:
1.917 raeburn 8494: .LC_dccid {
1.1130 raeburn 8495: float: right;
1.917 raeburn 8496: margin: 0.2em 0 0 0;
8497: padding: 0;
8498: font-size: 90%;
8499: display:none;
8500: }
8501:
1.897 wenzelju 8502: ol.LC_primary_menu a:hover,
1.721 harmsja 8503: ol#LC_MenuBreadcrumbs a:hover,
8504: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8505: ul#LC_secondary_menu a:hover,
1.721 harmsja 8506: .LC_FormSectionClearButton input:hover
1.795 www 8507: ul.LC_TabContent li:hover a {
1.952 onken 8508: color:$button_hover;
1.911 bisitz 8509: text-decoration:none;
1.693 droeschl 8510: }
8511:
1.779 bisitz 8512: h1 {
1.911 bisitz 8513: padding: 0;
8514: line-height:130%;
1.693 droeschl 8515: }
1.698 harmsja 8516:
1.911 bisitz 8517: h2,
8518: h3,
8519: h4,
8520: h5,
8521: h6 {
8522: margin: 5px 0 5px 0;
8523: padding: 0;
8524: line-height:130%;
1.693 droeschl 8525: }
1.795 www 8526:
8527: .LC_hcell {
1.911 bisitz 8528: padding:3px 15px 3px 15px;
8529: margin: 0;
8530: background-color:$tabbg;
8531: color:$fontmenu;
8532: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8533: }
1.795 www 8534:
1.840 bisitz 8535: .LC_Box > .LC_hcell {
1.911 bisitz 8536: margin: 0 -10px 10px -10px;
1.835 bisitz 8537: }
8538:
1.721 harmsja 8539: .LC_noBorder {
1.911 bisitz 8540: border: 0;
1.698 harmsja 8541: }
1.693 droeschl 8542:
1.721 harmsja 8543: .LC_FormSectionClearButton input {
1.911 bisitz 8544: background-color:transparent;
8545: border: none;
8546: cursor:pointer;
8547: text-decoration:underline;
1.693 droeschl 8548: }
1.763 bisitz 8549:
8550: .LC_help_open_topic {
1.911 bisitz 8551: color: #FFFFFF;
8552: background-color: #EEEEFF;
8553: margin: 1px;
8554: padding: 4px;
8555: border: 1px solid #000033;
8556: white-space: nowrap;
8557: /* vertical-align: middle; */
1.759 neumanie 8558: }
1.693 droeschl 8559:
1.911 bisitz 8560: dl,
8561: ul,
8562: div,
8563: fieldset {
8564: margin: 10px 10px 10px 0;
8565: /* overflow: hidden; */
1.693 droeschl 8566: }
1.795 www 8567:
1.1404 raeburn 8568: fieldset#LC_selectuser {
8569: margin: 0;
8570: padding: 0;
8571: }
8572:
1.1211 raeburn 8573: article.geogebraweb div {
8574: margin: 0;
8575: }
8576:
1.838 bisitz 8577: fieldset > legend {
1.911 bisitz 8578: font-weight: bold;
8579: padding: 0 5px 0 5px;
1.838 bisitz 8580: }
8581:
1.813 bisitz 8582: #LC_nav_bar {
1.911 bisitz 8583: float: left;
1.995 raeburn 8584: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8585: margin: 0 0 2px 0;
1.807 droeschl 8586: }
8587:
1.916 droeschl 8588: #LC_realm {
8589: margin: 0.2em 0 0 0;
8590: padding: 0;
8591: font-weight: bold;
8592: text-align: center;
1.995 raeburn 8593: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8594: }
8595:
1.911 bisitz 8596: #LC_nav_bar em {
8597: font-weight: bold;
8598: font-style: normal;
1.807 droeschl 8599: }
8600:
1.897 wenzelju 8601: ol.LC_primary_menu {
1.934 droeschl 8602: margin: 0;
1.1076 raeburn 8603: padding: 0;
1.807 droeschl 8604: }
8605:
1.852 droeschl 8606: ol#LC_PathBreadcrumbs {
1.911 bisitz 8607: margin: 0;
1.693 droeschl 8608: }
8609:
1.897 wenzelju 8610: ol.LC_primary_menu li {
1.1076 raeburn 8611: color: RGB(80, 80, 80);
8612: vertical-align: middle;
8613: text-align: left;
8614: list-style: none;
1.1205 golterma 8615: position: relative;
1.1076 raeburn 8616: float: left;
1.1205 golterma 8617: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8618: line-height: 1.5em;
1.1076 raeburn 8619: }
8620:
1.1205 golterma 8621: ol.LC_primary_menu li a,
8622: ol.LC_primary_menu li p {
1.1076 raeburn 8623: display: block;
8624: margin: 0;
8625: padding: 0 5px 0 10px;
8626: text-decoration: none;
8627: }
8628:
1.1205 golterma 8629: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8630: display: inline-block;
8631: width: 95%;
8632: text-align: left;
8633: }
8634:
8635: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8636: display: inline-block;
8637: width: 5%;
8638: float: right;
8639: text-align: right;
8640: font-size: 70%;
8641: }
8642:
8643: ol.LC_primary_menu ul {
1.1076 raeburn 8644: display: none;
1.1205 golterma 8645: width: 15em;
1.1076 raeburn 8646: background-color: $data_table_light;
1.1205 golterma 8647: position: absolute;
8648: top: 100%;
1.1076 raeburn 8649: }
8650:
1.1205 golterma 8651: ol.LC_primary_menu ul ul {
8652: left: 100%;
8653: top: 0;
8654: }
8655:
8656: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8657: display: block;
8658: position: absolute;
8659: margin: 0;
8660: padding: 0;
1.1078 raeburn 8661: z-index: 2;
1.1076 raeburn 8662: }
8663:
8664: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8665: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8666: font-size: 90%;
1.911 bisitz 8667: vertical-align: top;
1.1076 raeburn 8668: float: none;
1.1079 raeburn 8669: border-left: 1px solid black;
8670: border-right: 1px solid black;
1.1205 golterma 8671: /* A dark bottom border to visualize different menu options;
8672: overwritten in the create_submenu routine for the last border-bottom of the menu */
8673: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8674: }
8675:
1.1205 golterma 8676: ol.LC_primary_menu li li p:hover {
8677: color:$button_hover;
8678: text-decoration:none;
8679: background-color:$data_table_dark;
1.1076 raeburn 8680: }
8681:
8682: ol.LC_primary_menu li li a:hover {
8683: color:$button_hover;
8684: background-color:$data_table_dark;
1.693 droeschl 8685: }
8686:
1.1205 golterma 8687: /* Font-size equal to the size of the predecessors*/
8688: ol.LC_primary_menu li:hover li li {
8689: font-size: 100%;
8690: }
8691:
1.897 wenzelju 8692: ol.LC_primary_menu li img {
1.911 bisitz 8693: vertical-align: bottom;
1.934 droeschl 8694: height: 1.1em;
1.1077 raeburn 8695: margin: 0.2em 0 0 0;
1.693 droeschl 8696: }
8697:
1.897 wenzelju 8698: ol.LC_primary_menu a {
1.911 bisitz 8699: color: RGB(80, 80, 80);
8700: text-decoration: none;
1.693 droeschl 8701: }
1.795 www 8702:
1.949 droeschl 8703: ol.LC_primary_menu a.LC_new_message {
8704: font-weight:bold;
8705: color: darkred;
8706: }
8707:
1.975 raeburn 8708: ol.LC_docs_parameters {
8709: margin-left: 0;
8710: padding: 0;
8711: list-style: none;
8712: }
8713:
8714: ol.LC_docs_parameters li {
8715: margin: 0;
8716: padding-right: 20px;
8717: display: inline;
8718: }
8719:
1.976 raeburn 8720: ol.LC_docs_parameters li:before {
8721: content: "\\002022 \\0020";
8722: }
8723:
8724: li.LC_docs_parameters_title {
8725: font-weight: bold;
8726: }
8727:
8728: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8729: content: "";
8730: }
8731:
1.897 wenzelju 8732: ul#LC_secondary_menu {
1.1107 raeburn 8733: clear: right;
1.911 bisitz 8734: color: $fontmenu;
8735: background: $tabbg;
8736: list-style: none;
8737: padding: 0;
8738: margin: 0;
8739: width: 100%;
1.995 raeburn 8740: text-align: left;
1.1107 raeburn 8741: float: left;
1.808 droeschl 8742: }
8743:
1.897 wenzelju 8744: ul#LC_secondary_menu li {
1.911 bisitz 8745: font-weight: bold;
8746: line-height: 1.8em;
1.1107 raeburn 8747: border-right: 1px solid black;
8748: float: left;
8749: }
8750:
8751: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8752: background-color: $data_table_light;
8753: }
8754:
8755: ul#LC_secondary_menu li a {
1.911 bisitz 8756: padding: 0 0.8em;
1.1107 raeburn 8757: }
8758:
8759: ul#LC_secondary_menu li ul {
8760: display: none;
8761: }
8762:
8763: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8764: display: block;
8765: position: absolute;
8766: margin: 0;
8767: padding: 0;
8768: list-style:none;
8769: float: none;
8770: background-color: $data_table_light;
8771: z-index: 2;
8772: margin-left: -1px;
8773: }
8774:
8775: ul#LC_secondary_menu li ul li {
8776: font-size: 90%;
8777: vertical-align: top;
8778: border-left: 1px solid black;
1.911 bisitz 8779: border-right: 1px solid black;
1.1119 raeburn 8780: background-color: $data_table_light;
1.1107 raeburn 8781: list-style:none;
8782: float: none;
8783: }
8784:
8785: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8786: background-color: $data_table_dark;
1.807 droeschl 8787: }
8788:
1.847 tempelho 8789: ul.LC_TabContent {
1.911 bisitz 8790: display:block;
8791: background: $sidebg;
8792: border-bottom: solid 1px $lg_border_color;
8793: list-style:none;
1.1020 raeburn 8794: margin: -1px -10px 0 -10px;
1.911 bisitz 8795: padding: 0;
1.693 droeschl 8796: }
8797:
1.795 www 8798: ul.LC_TabContent li,
8799: ul.LC_TabContentBigger li {
1.911 bisitz 8800: float:left;
1.741 harmsja 8801: }
1.795 www 8802:
1.897 wenzelju 8803: ul#LC_secondary_menu li a {
1.911 bisitz 8804: color: $fontmenu;
8805: text-decoration: none;
1.693 droeschl 8806: }
1.795 www 8807:
1.721 harmsja 8808: ul.LC_TabContent {
1.952 onken 8809: min-height:20px;
1.721 harmsja 8810: }
1.795 www 8811:
8812: ul.LC_TabContent li {
1.911 bisitz 8813: vertical-align:middle;
1.959 onken 8814: padding: 0 16px 0 10px;
1.911 bisitz 8815: background-color:$tabbg;
8816: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8817: border-left: solid 1px $font;
1.721 harmsja 8818: }
1.795 www 8819:
1.847 tempelho 8820: ul.LC_TabContent .right {
1.911 bisitz 8821: float:right;
1.847 tempelho 8822: }
8823:
1.911 bisitz 8824: ul.LC_TabContent li a,
8825: ul.LC_TabContent li {
8826: color:rgb(47,47,47);
8827: text-decoration:none;
8828: font-size:95%;
8829: font-weight:bold;
1.952 onken 8830: min-height:20px;
8831: }
8832:
1.959 onken 8833: ul.LC_TabContent li a:hover,
8834: ul.LC_TabContent li a:focus {
1.952 onken 8835: color: $button_hover;
1.959 onken 8836: background:none;
8837: outline:none;
1.952 onken 8838: }
8839:
8840: ul.LC_TabContent li:hover {
8841: color: $button_hover;
8842: cursor:pointer;
1.721 harmsja 8843: }
1.795 www 8844:
1.911 bisitz 8845: ul.LC_TabContent li.active {
1.952 onken 8846: color: $font;
1.911 bisitz 8847: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8848: border-bottom:solid 1px #FFFFFF;
8849: cursor: default;
1.744 ehlerst 8850: }
1.795 www 8851:
1.959 onken 8852: ul.LC_TabContent li.active a {
8853: color:$font;
8854: background:#FFFFFF;
8855: outline: none;
8856: }
1.1047 raeburn 8857:
8858: ul.LC_TabContent li.goback {
8859: float: left;
8860: border-left: none;
8861: }
8862:
1.870 tempelho 8863: #maincoursedoc {
1.911 bisitz 8864: clear:both;
1.870 tempelho 8865: }
8866:
8867: ul.LC_TabContentBigger {
1.911 bisitz 8868: display:block;
8869: list-style:none;
8870: padding: 0;
1.870 tempelho 8871: }
8872:
1.795 www 8873: ul.LC_TabContentBigger li {
1.911 bisitz 8874: vertical-align:bottom;
8875: height: 30px;
8876: font-size:110%;
8877: font-weight:bold;
8878: color: #737373;
1.841 tempelho 8879: }
8880:
1.957 onken 8881: ul.LC_TabContentBigger li.active {
8882: position: relative;
8883: top: 1px;
8884: }
8885:
1.870 tempelho 8886: ul.LC_TabContentBigger li a {
1.911 bisitz 8887: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8888: height: 30px;
8889: line-height: 30px;
8890: text-align: center;
8891: display: block;
8892: text-decoration: none;
1.958 onken 8893: outline: none;
1.741 harmsja 8894: }
1.795 www 8895:
1.870 tempelho 8896: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8897: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8898: color:$font;
1.744 ehlerst 8899: }
1.795 www 8900:
1.870 tempelho 8901: ul.LC_TabContentBigger li b {
1.911 bisitz 8902: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8903: display: block;
8904: float: left;
8905: padding: 0 30px;
1.957 onken 8906: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8907: }
8908:
1.956 onken 8909: ul.LC_TabContentBigger li:hover b {
8910: color:$button_hover;
8911: }
8912:
1.870 tempelho 8913: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8914: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8915: color:$font;
1.957 onken 8916: border: 0;
1.741 harmsja 8917: }
1.693 droeschl 8918:
1.870 tempelho 8919:
1.862 bisitz 8920: ul.LC_CourseBreadcrumbs {
8921: background: $sidebg;
1.1020 raeburn 8922: height: 2em;
1.862 bisitz 8923: padding-left: 10px;
1.1020 raeburn 8924: margin: 0;
1.862 bisitz 8925: list-style-position: inside;
8926: }
8927:
1.911 bisitz 8928: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8929: ol#LC_PathBreadcrumbs {
1.911 bisitz 8930: padding-left: 10px;
8931: margin: 0;
1.933 droeschl 8932: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8933: }
8934:
1.911 bisitz 8935: ol#LC_MenuBreadcrumbs li,
8936: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8937: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8938: display: inline;
1.933 droeschl 8939: white-space: normal;
1.693 droeschl 8940: }
8941:
1.823 bisitz 8942: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8943: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8944: text-decoration: none;
8945: font-size:90%;
1.693 droeschl 8946: }
1.795 www 8947:
1.969 droeschl 8948: ol#LC_MenuBreadcrumbs h1 {
8949: display: inline;
8950: font-size: 90%;
8951: line-height: 2.5em;
8952: margin: 0;
8953: padding: 0;
8954: }
8955:
1.795 www 8956: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8957: text-decoration:none;
8958: font-size:100%;
8959: font-weight:bold;
1.693 droeschl 8960: }
1.795 www 8961:
1.840 bisitz 8962: .LC_Box {
1.911 bisitz 8963: border: solid 1px $lg_border_color;
8964: padding: 0 10px 10px 10px;
1.746 neumanie 8965: }
1.795 www 8966:
1.1020 raeburn 8967: .LC_DocsBox {
8968: border: solid 1px $lg_border_color;
8969: padding: 0 0 10px 10px;
8970: }
8971:
1.795 www 8972: .LC_AboutMe_Image {
1.911 bisitz 8973: float:left;
8974: margin-right:10px;
1.747 neumanie 8975: }
1.795 www 8976:
8977: .LC_Clear_AboutMe_Image {
1.911 bisitz 8978: clear:left;
1.747 neumanie 8979: }
1.795 www 8980:
1.721 harmsja 8981: dl.LC_ListStyleClean dt {
1.911 bisitz 8982: padding-right: 5px;
8983: display: table-header-group;
1.693 droeschl 8984: }
8985:
1.721 harmsja 8986: dl.LC_ListStyleClean dd {
1.911 bisitz 8987: display: table-row;
1.693 droeschl 8988: }
8989:
1.721 harmsja 8990: .LC_ListStyleClean,
8991: .LC_ListStyleSimple,
8992: .LC_ListStyleNormal,
1.795 www 8993: .LC_ListStyleSpecial {
1.911 bisitz 8994: /* display:block; */
8995: list-style-position: inside;
8996: list-style-type: none;
8997: overflow: hidden;
8998: padding: 0;
1.693 droeschl 8999: }
9000:
1.721 harmsja 9001: .LC_ListStyleSimple li,
9002: .LC_ListStyleSimple dd,
9003: .LC_ListStyleNormal li,
9004: .LC_ListStyleNormal dd,
9005: .LC_ListStyleSpecial li,
1.795 www 9006: .LC_ListStyleSpecial dd {
1.911 bisitz 9007: margin: 0;
9008: padding: 5px 5px 5px 10px;
9009: clear: both;
1.693 droeschl 9010: }
9011:
1.721 harmsja 9012: .LC_ListStyleClean li,
9013: .LC_ListStyleClean dd {
1.911 bisitz 9014: padding-top: 0;
9015: padding-bottom: 0;
1.693 droeschl 9016: }
9017:
1.721 harmsja 9018: .LC_ListStyleSimple dd,
1.795 www 9019: .LC_ListStyleSimple li {
1.911 bisitz 9020: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9021: }
9022:
1.721 harmsja 9023: .LC_ListStyleSpecial li,
9024: .LC_ListStyleSpecial dd {
1.911 bisitz 9025: list-style-type: none;
9026: background-color: RGB(220, 220, 220);
9027: margin-bottom: 4px;
1.693 droeschl 9028: }
9029:
1.721 harmsja 9030: table.LC_SimpleTable {
1.911 bisitz 9031: margin:5px;
9032: border:solid 1px $lg_border_color;
1.795 www 9033: }
1.693 droeschl 9034:
1.721 harmsja 9035: table.LC_SimpleTable tr {
1.911 bisitz 9036: padding: 0;
9037: border:solid 1px $lg_border_color;
1.693 droeschl 9038: }
1.795 www 9039:
9040: table.LC_SimpleTable thead {
1.911 bisitz 9041: background:rgb(220,220,220);
1.693 droeschl 9042: }
9043:
1.721 harmsja 9044: div.LC_columnSection {
1.911 bisitz 9045: display: block;
9046: clear: both;
9047: overflow: hidden;
9048: margin: 0;
1.693 droeschl 9049: }
9050:
1.721 harmsja 9051: div.LC_columnSection>* {
1.911 bisitz 9052: float: left;
9053: margin: 10px 20px 10px 0;
9054: overflow:hidden;
1.693 droeschl 9055: }
1.721 harmsja 9056:
1.795 www 9057: table em {
1.911 bisitz 9058: font-weight: bold;
9059: font-style: normal;
1.748 schulted 9060: }
1.795 www 9061:
1.779 bisitz 9062: table.LC_tableBrowseRes,
1.795 www 9063: table.LC_tableOfContent {
1.911 bisitz 9064: border:none;
9065: border-spacing: 1px;
9066: padding: 3px;
9067: background-color: #FFFFFF;
9068: font-size: 90%;
1.753 droeschl 9069: }
1.789 droeschl 9070:
1.911 bisitz 9071: table.LC_tableOfContent {
9072: border-collapse: collapse;
1.789 droeschl 9073: }
9074:
1.771 droeschl 9075: table.LC_tableBrowseRes a,
1.768 schulted 9076: table.LC_tableOfContent a {
1.911 bisitz 9077: background-color: transparent;
9078: text-decoration: none;
1.753 droeschl 9079: }
9080:
1.795 www 9081: table.LC_tableOfContent img {
1.911 bisitz 9082: border: none;
9083: height: 1.3em;
9084: vertical-align: text-bottom;
9085: margin-right: 0.3em;
1.753 droeschl 9086: }
1.757 schulted 9087:
1.795 www 9088: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9089: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9090: }
9091:
1.795 www 9092: a#LC_content_toolbar_everything {
1.911 bisitz 9093: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9094: }
9095:
1.795 www 9096: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9097: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9098: }
9099:
1.795 www 9100: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9101: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9102: }
9103:
1.795 www 9104: a#LC_content_toolbar_changefolder {
1.911 bisitz 9105: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9106: }
9107:
1.795 www 9108: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9109: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9110: }
9111:
1.1043 raeburn 9112: a#LC_content_toolbar_edittoplevel {
9113: background-image:url(/res/adm/pages/edittoplevel.gif);
9114: }
9115:
1.1384 raeburn 9116: a#LC_content_toolbar_printout {
9117: background-image:url(/res/adm/pages/printout.gif);
9118: }
9119:
1.795 www 9120: ul#LC_toolbar li a:hover {
1.911 bisitz 9121: background-position: bottom center;
1.757 schulted 9122: }
9123:
1.795 www 9124: ul#LC_toolbar {
1.911 bisitz 9125: padding: 0;
9126: margin: 2px;
9127: list-style:none;
9128: position:relative;
9129: background-color:white;
1.1082 raeburn 9130: overflow: auto;
1.757 schulted 9131: }
9132:
1.795 www 9133: ul#LC_toolbar li {
1.911 bisitz 9134: border:1px solid white;
9135: padding: 0;
9136: margin: 0;
9137: float: left;
9138: display:inline;
9139: vertical-align:middle;
1.1082 raeburn 9140: white-space: nowrap;
1.911 bisitz 9141: }
1.757 schulted 9142:
1.783 amueller 9143:
1.795 www 9144: a.LC_toolbarItem {
1.911 bisitz 9145: display:block;
9146: padding: 0;
9147: margin: 0;
9148: height: 32px;
9149: width: 32px;
9150: color:white;
9151: border: none;
9152: background-repeat:no-repeat;
9153: background-color:transparent;
1.757 schulted 9154: }
9155:
1.915 droeschl 9156: ul.LC_funclist {
9157: margin: 0;
9158: padding: 0.5em 1em 0.5em 0;
9159: }
9160:
1.933 droeschl 9161: ul.LC_funclist > li:first-child {
9162: font-weight:bold;
9163: margin-left:0.8em;
9164: }
9165:
1.915 droeschl 9166: ul.LC_funclist + ul.LC_funclist {
9167: /*
9168: left border as a seperator if we have more than
9169: one list
9170: */
9171: border-left: 1px solid $sidebg;
9172: /*
9173: this hides the left border behind the border of the
9174: outer box if element is wrapped to the next 'line'
9175: */
9176: margin-left: -1px;
9177: }
9178:
1.843 bisitz 9179: ul.LC_funclist li {
1.915 droeschl 9180: display: inline;
1.782 bisitz 9181: white-space: nowrap;
1.915 droeschl 9182: margin: 0 0 0 25px;
9183: line-height: 150%;
1.782 bisitz 9184: }
9185:
1.974 wenzelju 9186: .LC_hidden {
9187: display: none;
9188: }
9189:
1.1030 www 9190: .LCmodal-overlay {
9191: position:fixed;
9192: top:0;
9193: right:0;
9194: bottom:0;
9195: left:0;
9196: height:100%;
9197: width:100%;
9198: margin:0;
9199: padding:0;
9200: background:#999;
9201: opacity:.75;
9202: filter: alpha(opacity=75);
9203: -moz-opacity: 0.75;
9204: z-index:101;
9205: }
9206:
9207: * html .LCmodal-overlay {
9208: position: absolute;
9209: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9210: }
9211:
9212: .LCmodal-window {
9213: position:fixed;
9214: top:50%;
9215: left:50%;
9216: margin:0;
9217: padding:0;
9218: z-index:102;
9219: }
9220:
9221: * html .LCmodal-window {
9222: position:absolute;
9223: }
9224:
9225: .LCclose-window {
9226: position:absolute;
9227: width:32px;
9228: height:32px;
9229: right:8px;
9230: top:8px;
9231: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9232: text-indent:-99999px;
9233: overflow:hidden;
9234: cursor:pointer;
9235: }
9236:
1.1369 raeburn 9237: .LCisDisabled {
9238: cursor: not-allowed;
9239: opacity: 0.5;
9240: }
9241:
9242: a[aria-disabled="true"] {
9243: color: currentColor;
9244: display: inline-block; /* For IE11/ MS Edge bug */
9245: pointer-events: none;
9246: text-decoration: none;
9247: }
9248:
1.1335 raeburn 9249: pre.LC_wordwrap {
9250: white-space: pre-wrap;
9251: white-space: -moz-pre-wrap;
9252: white-space: -pre-wrap;
9253: white-space: -o-pre-wrap;
9254: word-wrap: break-word;
9255: }
9256:
1.1100 raeburn 9257: /*
1.1231 damieng 9258: styles used for response display
9259: */
9260: div.LC_radiofoil, div.LC_rankfoil {
9261: margin: .5em 0em .5em 0em;
9262: }
9263: table.LC_itemgroup {
9264: margin-top: 1em;
9265: }
9266:
9267: /*
1.1100 raeburn 9268: styles used by TTH when "Default set of options to pass to tth/m
9269: when converting TeX" in course settings has been set
9270:
9271: option passed: -t
9272:
9273: */
9274:
9275: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9276: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9277: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9278: td div.norm {line-height:normal;}
9279:
9280: /*
9281: option passed -y3
9282: */
9283:
9284: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9285: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9286: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9287:
1.1230 damieng 9288: /*
9289: sections with roles, for content only
9290: */
9291: section[class^="role-"] {
9292: padding-left: 10px;
9293: padding-right: 5px;
9294: margin-top: 8px;
9295: margin-bottom: 8px;
9296: border: 1px solid #2A4;
9297: border-radius: 5px;
9298: box-shadow: 0px 1px 1px #BBB;
9299: }
9300: section[class^="role-"]>h1 {
9301: position: relative;
9302: margin: 0px;
9303: padding-top: 10px;
9304: padding-left: 40px;
9305: }
9306: section[class^="role-"]>h1:before {
9307: position: absolute;
9308: left: -5px;
9309: top: 5px;
9310: }
9311: section.role-activity>h1:before {
9312: content:url('/adm/daxe/images/section_icons/activity.png');
9313: }
9314: section.role-advice>h1:before {
9315: content:url('/adm/daxe/images/section_icons/advice.png');
9316: }
9317: section.role-bibliography>h1:before {
9318: content:url('/adm/daxe/images/section_icons/bibliography.png');
9319: }
9320: section.role-citation>h1:before {
9321: content:url('/adm/daxe/images/section_icons/citation.png');
9322: }
9323: section.role-conclusion>h1:before {
9324: content:url('/adm/daxe/images/section_icons/conclusion.png');
9325: }
9326: section.role-definition>h1:before {
9327: content:url('/adm/daxe/images/section_icons/definition.png');
9328: }
9329: section.role-demonstration>h1:before {
9330: content:url('/adm/daxe/images/section_icons/demonstration.png');
9331: }
9332: section.role-example>h1:before {
9333: content:url('/adm/daxe/images/section_icons/example.png');
9334: }
9335: section.role-explanation>h1:before {
9336: content:url('/adm/daxe/images/section_icons/explanation.png');
9337: }
9338: section.role-introduction>h1:before {
9339: content:url('/adm/daxe/images/section_icons/introduction.png');
9340: }
9341: section.role-method>h1:before {
9342: content:url('/adm/daxe/images/section_icons/method.png');
9343: }
9344: section.role-more_information>h1:before {
9345: content:url('/adm/daxe/images/section_icons/more_information.png');
9346: }
9347: section.role-objectives>h1:before {
9348: content:url('/adm/daxe/images/section_icons/objectives.png');
9349: }
9350: section.role-prerequisites>h1:before {
9351: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9352: }
9353: section.role-remark>h1:before {
9354: content:url('/adm/daxe/images/section_icons/remark.png');
9355: }
9356: section.role-reminder>h1:before {
9357: content:url('/adm/daxe/images/section_icons/reminder.png');
9358: }
9359: section.role-summary>h1:before {
9360: content:url('/adm/daxe/images/section_icons/summary.png');
9361: }
9362: section.role-syntax>h1:before {
9363: content:url('/adm/daxe/images/section_icons/syntax.png');
9364: }
9365: section.role-warning>h1:before {
9366: content:url('/adm/daxe/images/section_icons/warning.png');
9367: }
9368:
1.1269 raeburn 9369: #LC_minitab_header {
9370: float:left;
9371: width:100%;
9372: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9373: font-size:93%;
9374: line-height:normal;
9375: margin: 0.5em 0 0.5em 0;
9376: }
9377: #LC_minitab_header ul {
9378: margin:0;
9379: padding:10px 10px 0;
9380: list-style:none;
9381: }
9382: #LC_minitab_header li {
9383: float:left;
9384: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9385: margin:0;
9386: padding:0 0 0 9px;
9387: }
9388: #LC_minitab_header a {
9389: display:block;
9390: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9391: padding:5px 15px 4px 6px;
9392: }
9393: #LC_minitab_header #LC_current_minitab {
9394: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9395: }
9396: #LC_minitab_header #LC_current_minitab a {
9397: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9398: padding-bottom:5px;
9399: }
9400:
9401:
1.343 albertel 9402: END
9403: }
9404:
1.306 albertel 9405: =pod
9406:
9407: =item * &headtag()
9408:
9409: Returns a uniform footer for LON-CAPA web pages.
9410:
1.307 albertel 9411: Inputs: $title - optional title for the head
9412: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9413: $args - optional arguments
1.319 albertel 9414: force_register - if is true call registerurl so the remote is
9415: informed
1.415 albertel 9416: redirect -> array ref of
9417: 1- seconds before redirect occurs
9418: 2- url to redirect to
9419: 3- whether the side effect should occur
1.315 albertel 9420: (side effect of setting
9421: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9422: redirected to)
9423: 4- whether the redirect target should be
9424: the opener of the current (pop-up)
9425: window (side effect of setting
9426: $env{'internal.head.to_opener'} to
9427: 1, if true.
1.1388 raeburn 9428: 5- whether encrypt check should be skipped
1.352 albertel 9429: domain -> force to color decorate a page for a specific
9430: domain
9431: function -> force usage of a specific rolish color scheme
9432: bgcolor -> override the default page bgcolor
1.460 albertel 9433: no_auto_mt_title
9434: -> prevent &mt()ing the title arg
1.464 albertel 9435:
1.306 albertel 9436: =cut
9437:
9438: sub headtag {
1.313 albertel 9439: my ($title,$head_extra,$args) = @_;
1.306 albertel 9440:
1.363 albertel 9441: my $function = $args->{'function'} || &get_users_function();
9442: my $domain = $args->{'domain'} || &determinedomain();
9443: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9444: my $httphost = $args->{'use_absolute'};
1.418 albertel 9445: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9446: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9447: #time(),
1.418 albertel 9448: $env{'environment.color.timestamp'},
1.363 albertel 9449: $function,$domain,$bgcolor);
9450:
1.369 www 9451: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9452:
1.308 albertel 9453: my $result =
9454: '<head>'.
1.1160 raeburn 9455: &font_settings($args);
1.319 albertel 9456:
1.1188 raeburn 9457: my $inhibitprint;
9458: if ($args->{'print_suppress'}) {
9459: $inhibitprint = &print_suppression();
9460: }
1.1064 raeburn 9461:
1.1439 raeburn 9462: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9463: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9464: }
1.962 droeschl 9465: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9466: $result .= Apache::lonxml::display_title();
1.319 albertel 9467: }
1.436 albertel 9468: if (!$args->{'no_nav_bar'}
9469: && !$args->{'only_body'}
1.1438 raeburn 9470: && !$args->{'frameset'}
9471: && !$args->{'switchserver'}) {
1.1154 raeburn 9472: $result .= &help_menu_js($httphost);
1.1032 www 9473: $result.=&modal_window();
1.1038 www 9474: $result.=&togglebox_script();
1.1034 www 9475: $result.=&wishlist_window();
1.1041 www 9476: $result.=&LCprogressbarUpdate_script();
1.1034 www 9477: } else {
9478: if ($args->{'add_modal'}) {
9479: $result.=&modal_window();
9480: }
9481: if ($args->{'add_wishlist'}) {
9482: $result.=&wishlist_window();
9483: }
1.1038 www 9484: if ($args->{'add_togglebox'}) {
9485: $result.=&togglebox_script();
9486: }
1.1041 www 9487: if ($args->{'add_progressbar'}) {
9488: $result.=&LCprogressbarUpdate_script();
9489: }
1.436 albertel 9490: }
1.314 albertel 9491: if (ref($args->{'redirect'})) {
1.1388 raeburn 9492: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9493: if (!$skip_enc_check) {
9494: $url = &Apache::lonenc::check_encrypt($url);
9495: }
1.414 albertel 9496: if (!$inhibit_continue) {
9497: $env{'internal.head.redirect'} = $url;
9498: }
1.1386 raeburn 9499: $result.=<<"ADDMETA";
1.313 albertel 9500: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9501: ADDMETA
9502: if ($to_opener) {
9503: $env{'internal.head.to_opener'} = 1;
9504: my $dest = &js_escape($url);
9505: my $timeout = int($time * 1000);
9506: $result .=<<"ENDJS";
9507: <script type="text/javascript">
9508: // <![CDATA[
9509: function LC_To_Opener() {
9510: var dest = '$dest';
9511: if (dest != '') {
9512: if (window.opener != null && !window.opener.closed) {
9513: window.opener.location.href=dest;
9514: window.close();
9515: } else {
9516: window.location.href=dest;
9517: }
9518: }
9519: }
9520: \$(document).ready(function () {
9521: setTimeout('LC_To_Opener()',$timeout);
9522: });
9523: // ]]>
9524: </script>
9525: ENDJS
9526: } else {
9527: $result.=<<"ADDMETA";
1.344 albertel 9528: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9529: ADDMETA
1.1386 raeburn 9530: }
1.1210 raeburn 9531: } else {
9532: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9533: my $requrl = $env{'request.uri'};
9534: if ($requrl eq '') {
9535: $requrl = $ENV{'REQUEST_URI'};
9536: $requrl =~ s/\?.+$//;
9537: }
9538: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9539: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9540: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9541: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9542: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9543: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9544: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9545: my ($offload,$offloadoth);
1.1210 raeburn 9546: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9547: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9548: $offload = 1;
1.1353 raeburn 9549: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9550: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9551: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9552: $offloadoth = 1;
9553: $dom_in_use = $env{'user.domain'};
9554: }
9555: }
1.1340 raeburn 9556: }
9557: }
9558: unless ($offload) {
9559: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9560: if ($domdefs{'offloadoth'}{$lonhost}) {
9561: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9562: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9563: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9564: $offload = 1;
1.1352 raeburn 9565: $offloadoth = 1;
1.1340 raeburn 9566: $dom_in_use = $env{'user.domain'};
9567: }
1.1210 raeburn 9568: }
1.1340 raeburn 9569: }
9570: }
9571: }
9572: if ($offload) {
1.1358 raeburn 9573: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9574: if (($newserver eq '') && ($offloadoth)) {
9575: my @domains = &Apache::lonnet::current_machine_domains();
9576: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9577: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9578: }
9579: }
1.1340 raeburn 9580: if (($newserver) && ($newserver ne $lonhost)) {
9581: my $numsec = 5;
9582: my $timeout = $numsec * 1000;
9583: my ($newurl,$locknum,%locks,$msg);
9584: if ($env{'request.role.adv'}) {
9585: ($locknum,%locks) = &Apache::lonnet::get_locks();
9586: }
9587: my $disable_submit = 0;
9588: if ($requrl =~ /$LONCAPA::assess_re/) {
9589: $disable_submit = 1;
9590: }
9591: if ($locknum) {
9592: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9593: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9594: join(", ",sort(values(%locks)))."\n";
9595: if (&show_course()) {
9596: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9597: } else {
9598: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9599: }
1.1340 raeburn 9600: } else {
9601: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9602: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9603: }
9604: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9605: $newurl = '/adm/switchserver?otherserver='.$newserver;
9606: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9607: $newurl .= '&role='.$env{'request.role'};
9608: }
9609: if ($env{'request.symb'}) {
9610: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9611: if ($shownsymb =~ m{^/enc/}) {
9612: my $reqdmajor = 2;
9613: my $reqdminor = 11;
9614: my $reqdsubminor = 3;
9615: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9616: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9617: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9618: if (($major eq '' && $minor eq '') ||
9619: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9620: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9621: ($reqdsubminor > $subminor))))) {
9622: undef($shownsymb);
9623: }
1.1210 raeburn 9624: }
1.1340 raeburn 9625: if ($shownsymb) {
9626: &js_escape(\$shownsymb);
9627: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9628: }
1.1340 raeburn 9629: } else {
9630: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9631: &js_escape(\$shownurl);
9632: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9633: }
1.1340 raeburn 9634: }
9635: &js_escape(\$msg);
9636: $result.=<<OFFLOAD
1.1210 raeburn 9637: <meta http-equiv="pragma" content="no-cache" />
9638: <script type="text/javascript">
1.1215 raeburn 9639: // <![CDATA[
1.1210 raeburn 9640: function LC_Offload_Now() {
9641: var dest = "$newurl";
9642: if (dest != '') {
9643: window.location.href="$newurl";
9644: }
9645: }
1.1214 raeburn 9646: \$(document).ready(function () {
9647: window.alert('$msg');
9648: if ($disable_submit) {
1.1210 raeburn 9649: \$(".LC_hwk_submit").prop("disabled", true);
9650: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9651: }
9652: setTimeout('LC_Offload_Now()', $timeout);
9653: });
1.1215 raeburn 9654: // ]]>
1.1210 raeburn 9655: </script>
9656: OFFLOAD
9657: }
9658: }
9659: }
9660: }
9661: }
1.313 albertel 9662: }
1.306 albertel 9663: if (!defined($title)) {
9664: $title = 'The LearningOnline Network with CAPA';
9665: }
1.460 albertel 9666: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9667: if ($title =~ /^LON-CAPA\s+/) {
9668: $result .= '<title> '.$title.'</title>';
9669: } else {
9670: $result .= '<title> LON-CAPA '.$title.'</title>';
9671: }
9672: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9673: if (!$args->{'frameset'}) {
9674: $result .= ' /';
9675: }
9676: $result .= '>'
1.1064 raeburn 9677: .$inhibitprint
1.414 albertel 9678: .$head_extra;
1.1242 raeburn 9679: my $clientmobile;
9680: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9681: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9682: } else {
9683: $clientmobile = $env{'browser.mobile'};
9684: }
9685: if ($clientmobile) {
1.1137 raeburn 9686: $result .= '
1.1435 raeburn 9687: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9688: <meta name="apple-mobile-web-app-capable" content="yes" />';
9689: }
1.1278 raeburn 9690: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9691: return $result.'</head>';
1.306 albertel 9692: }
9693:
9694: =pod
9695:
1.340 albertel 9696: =item * &font_settings()
9697:
9698: Returns neccessary <meta> to set the proper encoding
9699:
1.1160 raeburn 9700: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9701:
9702: =cut
9703:
9704: sub font_settings {
1.1160 raeburn 9705: my ($args) = @_;
1.340 albertel 9706: my $headerstring='';
1.1160 raeburn 9707: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9708: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9709: $headerstring.=
9710: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9711: if (!$args->{'frameset'}) {
9712: $headerstring.= ' /';
9713: }
9714: $headerstring .= '>'."\n";
1.340 albertel 9715: }
9716: return $headerstring;
9717: }
9718:
1.341 albertel 9719: =pod
9720:
1.1064 raeburn 9721: =item * &print_suppression()
9722:
9723: In course context returns css which causes the body to be blank when media="print",
9724: if printout generation is unavailable for the current resource.
9725:
9726: This could be because:
9727:
9728: (a) printstartdate is in the future
9729:
9730: (b) printenddate is in the past
9731:
9732: (c) there is an active exam block with "printout"
9733: functionality blocked
9734:
9735: Users with pav, pfo or evb privileges are exempt.
9736:
9737: Inputs: none
9738:
9739: =cut
9740:
9741:
9742: sub print_suppression {
9743: my $noprint;
9744: if ($env{'request.course.id'}) {
9745: my $scope = $env{'request.course.id'};
9746: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9747: (&Apache::lonnet::allowed('pfo',$scope))) {
9748: return;
9749: }
9750: if ($env{'request.course.sec'} ne '') {
9751: $scope .= "/$env{'request.course.sec'}";
9752: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9753: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9754: return;
1.1064 raeburn 9755: }
9756: }
9757: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9758: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9759: my $clientip = &Apache::lonnet::get_requestor_ip();
9760: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9761: if ($blocked) {
9762: my $checkrole = "cm./$cdom/$cnum";
9763: if ($env{'request.course.sec'} ne '') {
9764: $checkrole .= "/$env{'request.course.sec'}";
9765: }
9766: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9767: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9768: $noprint = 1;
9769: }
9770: }
9771: unless ($noprint) {
9772: my $symb = &Apache::lonnet::symbread();
9773: if ($symb ne '') {
9774: my $navmap = Apache::lonnavmaps::navmap->new();
9775: if (ref($navmap)) {
9776: my $res = $navmap->getBySymb($symb);
9777: if (ref($res)) {
9778: if (!$res->resprintable()) {
9779: $noprint = 1;
9780: }
9781: }
9782: }
9783: }
9784: }
9785: if ($noprint) {
9786: return <<"ENDSTYLE";
9787: <style type="text/css" media="print">
9788: body { display:none }
9789: </style>
9790: ENDSTYLE
9791: }
9792: }
9793: return;
9794: }
9795:
9796: =pod
9797:
1.341 albertel 9798: =item * &xml_begin()
9799:
9800: Returns the needed doctype and <html>
9801:
9802: Inputs: none
9803:
9804: =cut
9805:
9806: sub xml_begin {
1.1168 raeburn 9807: my ($is_frameset) = @_;
1.341 albertel 9808: my $output='';
9809:
9810: if ($env{'browser.mathml'}) {
9811: $output='<?xml version="1.0"?>'
9812: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9813: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9814:
9815: # .'<!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">] >'
9816: .'<!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">'
9817: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9818: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9819: } elsif ($is_frameset) {
9820: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9821: '<html>'."\n";
1.341 albertel 9822: } else {
1.1168 raeburn 9823: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9824: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9825: }
9826: return $output;
9827: }
1.340 albertel 9828:
9829: =pod
9830:
1.306 albertel 9831: =item * &start_page()
9832:
9833: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9834:
1.648 raeburn 9835: Inputs:
9836:
9837: =over 4
9838:
9839: $title - optional title for the page
9840:
9841: $head_extra - optional extra HTML to incude inside the <head>
9842:
9843: $args - additional optional args supported are:
9844:
9845: =over 8
9846:
9847: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9848: arg on
1.814 bisitz 9849: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9850: add_entries -> additional attributes to add to the <body>
9851: domain -> force to color decorate a page for a
1.317 albertel 9852: specific domain
1.648 raeburn 9853: function -> force usage of a specific rolish color
1.317 albertel 9854: scheme
1.648 raeburn 9855: redirect -> see &headtag()
9856: bgcolor -> override the default page bg color
9857: js_ready -> return a string ready for being used in
1.317 albertel 9858: a javascript writeln
1.648 raeburn 9859: html_encode -> return a string ready for being used in
1.320 albertel 9860: a html attribute
1.648 raeburn 9861: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9862: $forcereg arg
1.648 raeburn 9863: frameset -> if true will start with a <frameset>
1.330 albertel 9864: rather than <body>
1.648 raeburn 9865: skip_phases -> hash ref of
1.338 albertel 9866: head -> skip the <html><head> generation
9867: body -> skip all <body> generation
1.648 raeburn 9868: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9869: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9870: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9871: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9872: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9873: to override those values, or add to them, specify the value to
9874: include in the style attribute to include in the div tag by using
9875: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9876: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9877: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9878: group -> includes the current group, if page is for a
1.1274 raeburn 9879: specific group
9880: use_absolute -> for request for external resource or syllabus, this
9881: will contain https://<hostname> if server uses
9882: https (as per hosts.tab), but request is for http
9883: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9884: links_disabled -> Links in primary and secondary menus are disabled
9885: (Can enable them once page has loaded - see lonroles.pm
9886: for an example).
1.1380 raeburn 9887: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9888:
1.648 raeburn 9889: =back
1.460 albertel 9890:
1.648 raeburn 9891: =back
1.562 albertel 9892:
1.306 albertel 9893: =cut
9894:
9895: sub start_page {
1.309 albertel 9896: my ($title,$head_extra,$args) = @_;
1.318 albertel 9897: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9898:
1.315 albertel 9899: $env{'internal.start_page'}++;
1.1359 raeburn 9900: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9901:
1.338 albertel 9902: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9903: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9904: }
1.1316 raeburn 9905:
9906: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9907: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9908: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9909: $args->{'no_primary_menu'} = 1;
9910: }
9911: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9912: $args->{'no_inline_menu'} = 1;
9913: }
9914: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9915: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9916: }
9917: } else {
9918: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9919: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9920: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9921: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9922: $args->{'no_primary_menu'} = 1;
9923: }
9924: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9925: $args->{'no_inline_menu'} = 1;
9926: }
9927: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9928: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9929: }
9930: }
9931: }
1.1316 raeburn 9932: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9933: $env{'course.'.$env{'request.course.id'}.'.domain'},
9934: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9935: } elsif ($env{'request.course.id'}) {
9936: my $expiretime=600;
9937: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9938: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9939: }
9940: my ($deeplinkmenu,$menuref);
9941: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9942: if ($menucoll) {
9943: if (ref($menuref) eq 'HASH') {
9944: %menu = %{$menuref};
9945: }
9946: if ($menu{'top'} eq 'n') {
9947: $args->{'no_primary_menu'} = 1;
9948: }
9949: if ($menu{'inline'} eq 'n') {
9950: unless (&Apache::lonnet::allowed('opa')) {
9951: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9952: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9953: my $crstype = &course_type();
9954: my $now = time;
9955: my $ccrole;
9956: if ($crstype eq 'Community') {
9957: $ccrole = 'co';
9958: } else {
9959: $ccrole = 'cc';
9960: }
9961: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9962: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9963: if ((($start) && ($start<0)) ||
9964: (($end) && ($end<$now)) ||
9965: (($start) && ($now<$start))) {
9966: $args->{'no_inline_menu'} = 1;
9967: }
9968: } else {
9969: $args->{'no_inline_menu'} = 1;
9970: }
9971: }
9972: }
9973: }
1.1316 raeburn 9974: }
1.1359 raeburn 9975:
1.1385 raeburn 9976: my $showncrumbs;
1.338 albertel 9977: if (! exists($args->{'skip_phases'}{'body'}) ) {
9978: if ($args->{'frameset'}) {
9979: my $attr_string = &make_attr_string($args->{'force_register'},
9980: $args->{'add_entries'});
9981: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9982: } else {
9983: $result .=
9984: &bodytag($title,
9985: $args->{'function'}, $args->{'add_entries'},
9986: $args->{'only_body'}, $args->{'domain'},
9987: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9988: $args->{'bgcolor'}, $args,
1.1385 raeburn 9989: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9990: \%menu,\$showncrumbs);
1.831 bisitz 9991: }
1.330 albertel 9992: }
1.338 albertel 9993:
1.315 albertel 9994: if ($args->{'js_ready'}) {
1.713 kaisler 9995: $result = &js_ready($result);
1.315 albertel 9996: }
1.320 albertel 9997: if ($args->{'html_encode'}) {
1.713 kaisler 9998: $result = &html_encode($result);
9999: }
10000:
1.813 bisitz 10001: # Preparation for new and consistent functionlist at top of screen
10002: # if ($args->{'functionlist'}) {
10003: # $result .= &build_functionlist();
10004: #}
10005:
1.964 droeschl 10006: # Don't add anything more if only_body wanted or in const space
10007: return $result if $args->{'only_body'}
10008: || $env{'request.state'} eq 'construct';
1.813 bisitz 10009:
10010: #Breadcrumbs
1.758 kaisler 10011: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10012: unless ($showncrumbs) {
1.758 kaisler 10013: &Apache::lonhtmlcommon::clear_breadcrumbs();
10014: #if any br links exists, add them to the breadcrumbs
10015: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10016: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10017: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10018: }
10019: }
1.1096 raeburn 10020: # if @advtools array contains items add then to the breadcrumbs
10021: if (@advtools > 0) {
10022: &Apache::lonmenu::advtools_crumbs(@advtools);
10023: }
1.1272 raeburn 10024: my $menulink;
10025: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10026: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10027: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10028: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10029: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10030: (!$env{'request.role.adv'}))) {
10031: $menulink = 0;
10032: } else {
10033: undef($menulink);
10034: }
1.1385 raeburn 10035: my $linkprotout;
10036: if ($env{'request.deeplink.login'}) {
10037: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10038: if ($linkprotout) {
10039: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10040: }
10041: }
1.758 kaisler 10042: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10043: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10044: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10045: '',$menulink,'',
10046: $args->{'bread_crumbs_style'});
1.1237 raeburn 10047: } else {
1.1437 raeburn 10048: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10049: $args->{'bread_crumbs_style'});
1.758 kaisler 10050: }
1.1385 raeburn 10051: }
1.320 albertel 10052: }
1.315 albertel 10053: return $result;
1.306 albertel 10054: }
10055:
10056: sub end_page {
1.315 albertel 10057: my ($args) = @_;
10058: $env{'internal.end_page'}++;
1.330 albertel 10059: my $result;
1.335 albertel 10060: if ($args->{'discussion'}) {
10061: my ($target,$parser);
10062: if (ref($args->{'discussion'})) {
10063: ($target,$parser) =($args->{'discussion'}{'target'},
10064: $args->{'discussion'}{'parser'});
10065: }
10066: $result .= &Apache::lonxml::xmlend($target,$parser);
10067: }
1.330 albertel 10068: if ($args->{'frameset'}) {
10069: $result .= '</frameset>';
10070: } else {
1.635 raeburn 10071: $result .= &endbodytag($args);
1.330 albertel 10072: }
1.1080 raeburn 10073: unless ($args->{'notbody'}) {
10074: $result .= "\n</html>";
10075: }
1.330 albertel 10076:
1.315 albertel 10077: if ($args->{'js_ready'}) {
1.317 albertel 10078: $result = &js_ready($result);
1.315 albertel 10079: }
1.335 albertel 10080:
1.320 albertel 10081: if ($args->{'html_encode'}) {
10082: $result = &html_encode($result);
10083: }
1.335 albertel 10084:
1.315 albertel 10085: return $result;
10086: }
10087:
1.1359 raeburn 10088: sub menucoll_in_effect {
10089: my ($menucoll,$deeplinkmenu,%menu);
10090: if ($env{'request.course.id'}) {
10091: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10092: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10093: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10094: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10095: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10096: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10097: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10098: my $navmap = Apache::lonnavmaps::navmap->new();
10099: if (ref($navmap)) {
10100: $deeplink = $navmap->get_mapparam(undef,
10101: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10102: '0.deeplink');
1.1370 raeburn 10103: } else {
10104: $check_login_symb = 1;
1.1362 raeburn 10105: }
10106: } else {
1.1370 raeburn 10107: my $symb = &Apache::lonnet::symbread();
10108: if ($symb) {
10109: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10110: } else {
10111: $check_login_symb = 1;
10112: }
1.1362 raeburn 10113: }
10114: } else {
1.1370 raeburn 10115: $check_login_symb = 1;
10116: }
10117: if ($check_login_symb) {
1.1362 raeburn 10118: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10119: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10120: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10121: my $navmap = Apache::lonnavmaps::navmap->new();
10122: if (ref($navmap)) {
10123: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10124: }
10125: } else {
10126: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10127: }
10128: }
1.1359 raeburn 10129: if ($deeplink ne '') {
1.1378 raeburn 10130: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10131: if ($display =~ /^\d+$/) {
10132: $deeplinkmenu = 1;
10133: $menucoll = $display;
10134: }
10135: }
10136: }
10137: if ($menucoll) {
10138: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10139: }
10140: }
10141: return ($menucoll,$deeplinkmenu,\%menu);
10142: }
10143:
1.1362 raeburn 10144: sub deeplink_login_symb {
10145: my ($cnum,$cdom) = @_;
10146: my $login_symb;
10147: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10148: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10149: }
10150: return $login_symb;
10151: }
10152:
10153: sub symb_from_tinyurl {
10154: my ($url,$cnum,$cdom) = @_;
10155: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10156: my $key = $1;
10157: my ($tinyurl,$login);
10158: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10159: if (defined($cached)) {
10160: $tinyurl = $result;
10161: } else {
10162: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10163: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10164: if ($currtiny{$key} ne '') {
10165: $tinyurl = $currtiny{$key};
10166: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10167: }
1.1364 raeburn 10168: }
10169: if ($tinyurl ne '') {
10170: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10171: if (wantarray) {
10172: return ($cnumreq,$symb);
10173: } elsif ($cnumreq eq $cnum) {
10174: return $symb;
1.1362 raeburn 10175: }
10176: }
10177: }
1.1364 raeburn 10178: if (wantarray) {
10179: return ();
10180: } else {
10181: return;
10182: }
1.1362 raeburn 10183: }
10184:
1.1405 raeburn 10185: sub usable_exttools {
10186: my %tooltypes;
10187: if ($env{'request.course.id'}) {
10188: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10189: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10190: %tooltypes = (
10191: crs => 1,
10192: dom => 1,
10193: );
10194: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10195: $tooltypes{'crs'} = 1;
10196: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10197: $tooltypes{'dom'} = 1;
10198: }
10199: } else {
10200: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10201: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10202: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10203: if ($crstype eq '') {
10204: $crstype = 'course';
10205: }
10206: if ($crstype eq 'course') {
10207: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10208: $crstype = 'official';
10209: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10210: $crstype = 'textbook';
10211: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10212: $crstype = 'lti';
10213: } else {
10214: $crstype = 'unofficial';
10215: }
10216: }
10217: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10218: if ($domdefaults{$crstype.'domexttool'}) {
10219: $tooltypes{'dom'} = 1;
10220: }
10221: if ($domdefaults{$crstype.'exttool'}) {
10222: $tooltypes{'crs'} = 1;
10223: }
10224: }
10225: }
10226: return %tooltypes;
10227: }
10228:
1.1034 www 10229: sub wishlist_window {
10230: return(<<'ENDWISHLIST');
1.1046 raeburn 10231: <script type="text/javascript">
1.1034 www 10232: // <![CDATA[
10233: // <!-- BEGIN LON-CAPA Internal
10234: function set_wishlistlink(title, path) {
10235: if (!title) {
10236: title = document.title;
10237: title = title.replace(/^LON-CAPA /,'');
10238: }
1.1175 raeburn 10239: title = encodeURIComponent(title);
1.1203 raeburn 10240: title = title.replace("'","\\\'");
1.1034 www 10241: if (!path) {
10242: path = location.pathname;
10243: }
1.1175 raeburn 10244: path = encodeURIComponent(path);
1.1203 raeburn 10245: path = path.replace("'","\\\'");
1.1034 www 10246: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10247: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10248: }
10249: // END LON-CAPA Internal -->
10250: // ]]>
10251: </script>
10252: ENDWISHLIST
10253: }
10254:
1.1030 www 10255: sub modal_window {
10256: return(<<'ENDMODAL');
1.1046 raeburn 10257: <script type="text/javascript">
1.1030 www 10258: // <![CDATA[
10259: // <!-- BEGIN LON-CAPA Internal
10260: var modalWindow = {
10261: parent:"body",
10262: windowId:null,
10263: content:null,
10264: width:null,
10265: height:null,
10266: close:function()
10267: {
10268: $(".LCmodal-window").remove();
10269: $(".LCmodal-overlay").remove();
10270: },
10271: open:function()
10272: {
10273: var modal = "";
10274: modal += "<div class=\"LCmodal-overlay\"></div>";
10275: 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;\">";
10276: modal += this.content;
10277: modal += "</div>";
10278:
10279: $(this.parent).append(modal);
10280:
10281: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10282: $(".LCclose-window").click(function(){modalWindow.close();});
10283: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10284: }
10285: };
1.1140 raeburn 10286: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10287: {
1.1266 raeburn 10288: source = source.replace(/'/g,"'");
1.1030 www 10289: modalWindow.windowId = "myModal";
10290: modalWindow.width = width;
10291: modalWindow.height = height;
1.1196 raeburn 10292: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10293: modalWindow.open();
1.1208 raeburn 10294: };
1.1030 www 10295: // END LON-CAPA Internal -->
10296: // ]]>
10297: </script>
10298: ENDMODAL
10299: }
10300:
10301: sub modal_link {
1.1140 raeburn 10302: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10303: unless ($width) { $width=480; }
10304: unless ($height) { $height=400; }
1.1031 www 10305: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10306: unless ($transparency) { $transparency='true'; }
10307:
1.1074 raeburn 10308: my $target_attr;
10309: if (defined($target)) {
10310: $target_attr = 'target="'.$target.'"';
10311: }
10312: return <<"ENDLINK";
1.1336 raeburn 10313: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10314: ENDLINK
1.1030 www 10315: }
10316:
1.1032 www 10317: sub modal_adhoc_script {
1.1365 raeburn 10318: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10319: my $mathjax;
10320: if ($possmathjax) {
10321: $mathjax = <<'ENDJAX';
10322: if (typeof MathJax == 'object') {
10323: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10324: }
10325: ENDJAX
10326: }
1.1032 www 10327: return (<<ENDADHOC);
1.1046 raeburn 10328: <script type="text/javascript">
1.1032 www 10329: // <![CDATA[
10330: var $funcname = function()
10331: {
10332: modalWindow.windowId = "myModal";
10333: modalWindow.width = $width;
10334: modalWindow.height = $height;
10335: modalWindow.content = '$content';
10336: modalWindow.open();
1.1365 raeburn 10337: $mathjax
1.1032 www 10338: };
10339: // ]]>
10340: </script>
10341: ENDADHOC
10342: }
10343:
1.1041 www 10344: sub modal_adhoc_inner {
1.1365 raeburn 10345: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10346: my $innerwidth=$width-20;
10347: $content=&js_ready(
1.1140 raeburn 10348: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10349: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10350: $content.
1.1041 www 10351: &end_scrollbox().
1.1140 raeburn 10352: &end_page()
1.1041 www 10353: );
1.1365 raeburn 10354: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10355: }
10356:
10357: sub modal_adhoc_window {
1.1365 raeburn 10358: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10359: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10360: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10361: }
10362:
10363: sub modal_adhoc_launch {
10364: my ($funcname,$width,$height,$content)=@_;
10365: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10366: <script type="text/javascript">
10367: // <![CDATA[
10368: $funcname();
10369: // ]]>
10370: </script>
10371: ENDLAUNCH
10372: }
10373:
10374: sub modal_adhoc_close {
10375: return (<<ENDCLOSE);
10376: <script type="text/javascript">
10377: // <![CDATA[
10378: modalWindow.close();
10379: // ]]>
10380: </script>
10381: ENDCLOSE
10382: }
10383:
1.1038 www 10384: sub togglebox_script {
10385: return(<<ENDTOGGLE);
10386: <script type="text/javascript">
10387: // <![CDATA[
10388: function LCtoggleDisplay(id,hidetext,showtext) {
10389: link = document.getElementById(id + "link").childNodes[0];
10390: with (document.getElementById(id).style) {
10391: if (display == "none" ) {
10392: display = "inline";
10393: link.nodeValue = hidetext;
10394: } else {
10395: display = "none";
10396: link.nodeValue = showtext;
10397: }
10398: }
10399: }
10400: // ]]>
10401: </script>
10402: ENDTOGGLE
10403: }
10404:
1.1039 www 10405: sub start_togglebox {
10406: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10407: unless ($heading) { $heading=''; } else { $heading.=' '; }
10408: unless ($showtext) { $showtext=&mt('show'); }
10409: unless ($hidetext) { $hidetext=&mt('hide'); }
10410: unless ($headerbg) { $headerbg='#FFFFFF'; }
10411: return &start_data_table().
10412: &start_data_table_header_row().
10413: '<td bgcolor="'.$headerbg.'">'.$heading.
10414: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10415: $showtext.'\')">'.$showtext.'</a>]</td>'.
10416: &end_data_table_header_row().
10417: '<tr id="'.$id.'" style="display:none""><td>';
10418: }
10419:
10420: sub end_togglebox {
10421: return '</td></tr>'.&end_data_table();
10422: }
10423:
1.1041 www 10424: sub LCprogressbar_script {
1.1302 raeburn 10425: my ($id,$number_to_do)=@_;
10426: if ($number_to_do) {
10427: return(<<ENDPROGRESS);
1.1041 www 10428: <script type="text/javascript">
10429: // <![CDATA[
1.1045 www 10430: \$('#progressbar$id').progressbar({
1.1041 www 10431: value: 0,
10432: change: function(event, ui) {
10433: var newVal = \$(this).progressbar('option', 'value');
10434: \$('.pblabel', this).text(LCprogressTxt);
10435: }
10436: });
10437: // ]]>
10438: </script>
10439: ENDPROGRESS
1.1302 raeburn 10440: } else {
10441: return(<<ENDPROGRESS);
10442: <script type="text/javascript">
10443: // <![CDATA[
10444: \$('#progressbar$id').progressbar({
10445: value: false,
10446: create: function(event, ui) {
10447: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10448: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10449: }
10450: });
10451: // ]]>
10452: </script>
10453: ENDPROGRESS
10454: }
1.1041 www 10455: }
10456:
10457: sub LCprogressbarUpdate_script {
10458: return(<<ENDPROGRESSUPDATE);
10459: <style type="text/css">
10460: .ui-progressbar { position:relative; }
1.1302 raeburn 10461: .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 10462: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10463: </style>
10464: <script type="text/javascript">
10465: // <![CDATA[
1.1045 www 10466: var LCprogressTxt='---';
10467:
1.1302 raeburn 10468: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10469: LCprogressTxt=progresstext;
1.1302 raeburn 10470: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10471: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10472: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10473: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10474: } else {
10475: \$('#progressbar'+id).progressbar('value',percent);
10476: }
1.1041 www 10477: }
10478: // ]]>
10479: </script>
10480: ENDPROGRESSUPDATE
10481: }
10482:
1.1042 www 10483: my $LClastpercent;
1.1045 www 10484: my $LCidcnt;
10485: my $LCcurrentid;
1.1042 www 10486:
1.1041 www 10487: sub LCprogressbar {
1.1302 raeburn 10488: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10489: $LClastpercent=0;
1.1045 www 10490: $LCidcnt++;
10491: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10492: my ($starting,$content);
10493: if ($number_to_do) {
10494: $starting=&mt('Starting');
10495: $content=(<<ENDPROGBAR);
10496: $preamble
1.1045 www 10497: <div id="progressbar$LCcurrentid">
1.1041 www 10498: <span class="pblabel">$starting</span>
10499: </div>
10500: ENDPROGBAR
1.1302 raeburn 10501: } else {
10502: $starting=&mt('Loading...');
10503: $LClastpercent='false';
10504: $content=(<<ENDPROGBAR);
10505: $preamble
10506: <div id="progressbar$LCcurrentid">
10507: <div class="progress-label">$starting</div>
10508: </div>
10509: ENDPROGBAR
10510: }
10511: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10512: }
10513:
10514: sub LCprogressbarUpdate {
1.1302 raeburn 10515: my ($r,$val,$text,$number_to_do)=@_;
10516: if ($number_to_do) {
10517: unless ($val) {
10518: if ($LClastpercent) {
10519: $val=$LClastpercent;
10520: } else {
10521: $val=0;
10522: }
10523: }
10524: if ($val<0) { $val=0; }
10525: if ($val>100) { $val=0; }
10526: $LClastpercent=$val;
10527: unless ($text) { $text=$val.'%'; }
10528: } else {
10529: $val = 'false';
1.1042 www 10530: }
1.1041 www 10531: $text=&js_ready($text);
1.1044 www 10532: &r_print($r,<<ENDUPDATE);
1.1041 www 10533: <script type="text/javascript">
10534: // <![CDATA[
1.1302 raeburn 10535: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10536: // ]]>
10537: </script>
10538: ENDUPDATE
1.1035 www 10539: }
10540:
1.1042 www 10541: sub LCprogressbarClose {
10542: my ($r)=@_;
10543: $LClastpercent=0;
1.1044 www 10544: &r_print($r,<<ENDCLOSE);
1.1042 www 10545: <script type="text/javascript">
10546: // <![CDATA[
1.1045 www 10547: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10548: // ]]>
10549: </script>
10550: ENDCLOSE
1.1044 www 10551: }
10552:
10553: sub r_print {
10554: my ($r,$to_print)=@_;
10555: if ($r) {
10556: $r->print($to_print);
10557: $r->rflush();
10558: } else {
10559: print($to_print);
10560: }
1.1042 www 10561: }
10562:
1.320 albertel 10563: sub html_encode {
10564: my ($result) = @_;
10565:
1.322 albertel 10566: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10567:
10568: return $result;
10569: }
1.1044 www 10570:
1.317 albertel 10571: sub js_ready {
10572: my ($result) = @_;
10573:
1.323 albertel 10574: $result =~ s/[\n\r]/ /xmsg;
10575: $result =~ s/\\/\\\\/xmsg;
10576: $result =~ s/'/\\'/xmsg;
1.372 albertel 10577: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10578:
10579: return $result;
10580: }
10581:
1.315 albertel 10582: sub validate_page {
10583: if ( exists($env{'internal.start_page'})
1.316 albertel 10584: && $env{'internal.start_page'} > 1) {
10585: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10586: $env{'internal.start_page'}.' '.
1.316 albertel 10587: $ENV{'request.filename'});
1.315 albertel 10588: }
10589: if ( exists($env{'internal.end_page'})
1.316 albertel 10590: && $env{'internal.end_page'} > 1) {
10591: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10592: $env{'internal.end_page'}.' '.
1.316 albertel 10593: $env{'request.filename'});
1.315 albertel 10594: }
10595: if ( exists($env{'internal.start_page'})
10596: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10597: &Apache::lonnet::logthis('start_page called without end_page '.
10598: $env{'request.filename'});
1.315 albertel 10599: }
10600: if ( ! exists($env{'internal.start_page'})
10601: && exists($env{'internal.end_page'})) {
1.316 albertel 10602: &Apache::lonnet::logthis('end_page called without start_page'.
10603: $env{'request.filename'});
1.315 albertel 10604: }
1.306 albertel 10605: }
1.315 albertel 10606:
1.996 www 10607:
10608: sub start_scrollbox {
1.1140 raeburn 10609: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10610: unless ($outerwidth) { $outerwidth='520px'; }
10611: unless ($width) { $width='500px'; }
10612: unless ($height) { $height='200px'; }
1.1075 raeburn 10613: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10614: if ($id ne '') {
1.1140 raeburn 10615: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10616: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10617: }
1.1075 raeburn 10618: if ($bgcolor ne '') {
10619: $tdcol = "background-color: $bgcolor;";
10620: }
1.1137 raeburn 10621: my $nicescroll_js;
10622: if ($env{'browser.mobile'}) {
1.1140 raeburn 10623: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10624: }
10625: return <<"END";
10626: $nicescroll_js
10627:
10628: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10629: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10630: END
10631: }
10632:
10633: sub end_scrollbox {
10634: return '</div></td></tr></table>';
10635: }
10636:
10637: sub nicescroll_javascript {
10638: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10639: my %options;
10640: if (ref($cursor) eq 'HASH') {
10641: %options = %{$cursor};
10642: }
10643: unless ($options{'railalign'} =~ /^left|right$/) {
10644: $options{'railalign'} = 'left';
10645: }
10646: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10647: my $function = &get_users_function();
10648: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10649: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10650: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10651: }
1.1140 raeburn 10652: }
10653: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10654: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10655: $options{'cursoropacity'}='1.0';
10656: }
1.1140 raeburn 10657: } else {
10658: $options{'cursoropacity'}='1.0';
10659: }
10660: if ($options{'cursorfixedheight'} eq 'none') {
10661: delete($options{'cursorfixedheight'});
10662: } else {
10663: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10664: }
10665: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10666: delete($options{'railoffset'});
10667: }
10668: my @niceoptions;
10669: while (my($key,$value) = each(%options)) {
10670: if ($value =~ /^\{.+\}$/) {
10671: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10672: } else {
1.1140 raeburn 10673: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10674: }
1.1140 raeburn 10675: }
10676: my $nicescroll_js = '
1.1137 raeburn 10677: $(document).ready(
1.1140 raeburn 10678: function() {
10679: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10680: }
1.1137 raeburn 10681: );
10682: ';
1.1140 raeburn 10683: if ($framecheck) {
10684: $nicescroll_js .= '
10685: function expand_div(caller) {
10686: if (top === self) {
10687: document.getElementById("'.$id.'").style.width = "auto";
10688: document.getElementById("'.$id.'").style.height = "auto";
10689: } else {
10690: try {
10691: if (parent.frames) {
10692: if (parent.frames.length > 1) {
10693: var framesrc = parent.frames[1].location.href;
10694: var currsrc = framesrc.replace(/\#.*$/,"");
10695: if ((caller == "search") || (currsrc == "'.$location.'")) {
10696: document.getElementById("'.$id.'").style.width = "auto";
10697: document.getElementById("'.$id.'").style.height = "auto";
10698: }
10699: }
10700: }
10701: } catch (e) {
10702: return;
10703: }
1.1137 raeburn 10704: }
1.1140 raeburn 10705: return;
1.996 www 10706: }
1.1140 raeburn 10707: ';
10708: }
10709: if ($needjsready) {
10710: $nicescroll_js = '
10711: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10712: } else {
10713: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10714: }
10715: return $nicescroll_js;
1.996 www 10716: }
10717:
1.318 albertel 10718: sub simple_error_page {
1.1150 bisitz 10719: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10720: my %displayargs;
1.1151 raeburn 10721: if (ref($args) eq 'HASH') {
10722: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10723: if ($args->{'only_body'}) {
10724: $displayargs{'only_body'} = 1;
10725: }
10726: if ($args->{'no_nav_bar'}) {
10727: $displayargs{'no_nav_bar'} = 1;
10728: }
1.1151 raeburn 10729: } else {
10730: $msg = &mt($msg);
10731: }
1.1150 bisitz 10732:
1.318 albertel 10733: my $page =
1.1304 raeburn 10734: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10735: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10736: &Apache::loncommon::end_page();
10737: if (ref($r)) {
10738: $r->print($page);
1.327 albertel 10739: return;
1.318 albertel 10740: }
10741: return $page;
10742: }
1.347 albertel 10743:
10744: {
1.610 albertel 10745: my @row_count;
1.961 onken 10746:
10747: sub start_data_table_count {
10748: unshift(@row_count, 0);
10749: return;
10750: }
10751:
10752: sub end_data_table_count {
10753: shift(@row_count);
10754: return;
10755: }
10756:
1.347 albertel 10757: sub start_data_table {
1.1018 raeburn 10758: my ($add_class,$id) = @_;
1.422 albertel 10759: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10760: my $table_id;
10761: if (defined($id)) {
10762: $table_id = ' id="'.$id.'"';
10763: }
1.961 onken 10764: &start_data_table_count();
1.1018 raeburn 10765: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10766: }
10767:
10768: sub end_data_table {
1.961 onken 10769: &end_data_table_count();
1.389 albertel 10770: return '</table>'."\n";;
1.347 albertel 10771: }
10772:
10773: sub start_data_table_row {
1.974 wenzelju 10774: my ($add_class, $id) = @_;
1.610 albertel 10775: $row_count[0]++;
10776: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10777: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10778: $id = (' id="'.$id.'"') unless ($id eq '');
10779: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10780: }
1.471 banghart 10781:
10782: sub continue_data_table_row {
1.974 wenzelju 10783: my ($add_class, $id) = @_;
1.610 albertel 10784: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10785: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10786: $id = (' id="'.$id.'"') unless ($id eq '');
10787: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10788: }
1.347 albertel 10789:
10790: sub end_data_table_row {
1.389 albertel 10791: return '</tr>'."\n";;
1.347 albertel 10792: }
1.367 www 10793:
1.421 albertel 10794: sub start_data_table_empty_row {
1.707 bisitz 10795: # $row_count[0]++;
1.421 albertel 10796: return '<tr class="LC_empty_row" >'."\n";;
10797: }
10798:
10799: sub end_data_table_empty_row {
10800: return '</tr>'."\n";;
10801: }
10802:
1.367 www 10803: sub start_data_table_header_row {
1.389 albertel 10804: return '<tr class="LC_header_row">'."\n";;
1.367 www 10805: }
10806:
10807: sub end_data_table_header_row {
1.389 albertel 10808: return '</tr>'."\n";;
1.367 www 10809: }
1.890 droeschl 10810:
10811: sub data_table_caption {
10812: my $caption = shift;
10813: return "<caption class=\"LC_caption\">$caption</caption>";
10814: }
1.347 albertel 10815: }
10816:
1.548 albertel 10817: =pod
10818:
10819: =item * &inhibit_menu_check($arg)
10820:
10821: Checks for a inhibitmenu state and generates output to preserve it
10822:
10823: Inputs: $arg - can be any of
10824: - undef - in which case the return value is a string
10825: to add into arguments list of a uri
10826: - 'input' - in which case the return value is a HTML
10827: <form> <input> field of type hidden to
10828: preserve the value
10829: - a url - in which case the return value is the url with
10830: the neccesary cgi args added to preserve the
10831: inhibitmenu state
10832: - a ref to a url - no return value, but the string is
10833: updated to include the neccessary cgi
10834: args to preserve the inhibitmenu state
10835:
10836: =cut
10837:
10838: sub inhibit_menu_check {
10839: my ($arg) = @_;
10840: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10841: if ($arg eq 'input') {
10842: if ($env{'form.inhibitmenu'}) {
10843: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10844: } else {
10845: return
10846: }
10847: }
10848: if ($env{'form.inhibitmenu'}) {
10849: if (ref($arg)) {
10850: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10851: } elsif ($arg eq '') {
10852: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10853: } else {
10854: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10855: }
10856: }
10857: if (!ref($arg)) {
10858: return $arg;
10859: }
10860: }
10861:
1.251 albertel 10862: ###############################################
1.182 matthew 10863:
10864: =pod
10865:
1.549 albertel 10866: =back
10867:
10868: =head1 User Information Routines
10869:
10870: =over 4
10871:
1.405 albertel 10872: =item * &get_users_function()
1.182 matthew 10873:
10874: Used by &bodytag to determine the current users primary role.
10875: Returns either 'student','coordinator','admin', or 'author'.
10876:
10877: =cut
10878:
10879: ###############################################
10880: sub get_users_function {
1.815 tempelho 10881: my $function = 'norole';
1.818 tempelho 10882: if ($env{'request.role'}=~/^(st)/) {
10883: $function='student';
10884: }
1.907 raeburn 10885: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10886: $function='coordinator';
10887: }
1.258 albertel 10888: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10889: $function='admin';
10890: }
1.826 bisitz 10891: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10892: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10893: $function='author';
10894: }
10895: return $function;
1.54 www 10896: }
1.99 www 10897:
10898: ###############################################
10899:
1.233 raeburn 10900: =pod
10901:
1.821 raeburn 10902: =item * &show_course()
10903:
10904: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10905: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10906:
10907: Inputs:
10908: None
10909:
10910: Outputs:
10911: Scalar: 1 if 'Course' to be used, 0 otherwise.
10912:
10913: =cut
10914:
10915: ###############################################
10916: sub show_course {
1.1408 raeburn 10917: my ($udom,$uname) = @_;
10918: if (($udom ne '') && ($uname ne '')) {
10919: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10920: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10921: return 0;
10922: } else {
10923: return 1;
10924: }
10925: }
10926: }
1.821 raeburn 10927: my $course = !$env{'user.adv'};
10928: if (!$env{'user.adv'}) {
10929: foreach my $env (keys(%env)) {
10930: next if ($env !~ m/^user\.priv\./);
10931: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10932: $course = 0;
10933: last;
10934: }
10935: }
10936: }
10937: return $course;
10938: }
10939:
10940: ###############################################
10941:
10942: =pod
10943:
1.542 raeburn 10944: =item * &check_user_status()
1.274 raeburn 10945:
10946: Determines current status of supplied role for a
10947: specific user. Roles can be active, previous or future.
10948:
10949: Inputs:
10950: user's domain, user's username, course's domain,
1.375 raeburn 10951: course's number, optional section ID.
1.274 raeburn 10952:
10953: Outputs:
10954: role status: active, previous or future.
10955:
10956: =cut
10957:
10958: sub check_user_status {
1.412 raeburn 10959: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10960: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10961: my @uroles = keys(%userinfo);
1.274 raeburn 10962: my $srchstr;
10963: my $active_chk = 'none';
1.412 raeburn 10964: my $now = time;
1.274 raeburn 10965: if (@uroles > 0) {
1.908 raeburn 10966: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10967: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10968: } else {
1.412 raeburn 10969: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10970: }
10971: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10972: my $role_end = 0;
10973: my $role_start = 0;
10974: $active_chk = 'active';
1.412 raeburn 10975: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10976: $role_end = $1;
10977: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10978: $role_start = $1;
1.274 raeburn 10979: }
10980: }
10981: if ($role_start > 0) {
1.412 raeburn 10982: if ($now < $role_start) {
1.274 raeburn 10983: $active_chk = 'future';
10984: }
10985: }
10986: if ($role_end > 0) {
1.412 raeburn 10987: if ($now > $role_end) {
1.274 raeburn 10988: $active_chk = 'previous';
10989: }
10990: }
10991: }
10992: }
10993: return $active_chk;
10994: }
10995:
10996: ###############################################
10997:
10998: =pod
10999:
1.405 albertel 11000: =item * &get_sections()
1.233 raeburn 11001:
11002: Determines all the sections for a course including
11003: sections with students and sections containing other roles.
1.419 raeburn 11004: Incoming parameters:
11005:
11006: 1. domain
11007: 2. course number
11008: 3. reference to array containing roles for which sections should
11009: be gathered (optional).
11010: 4. reference to array containing status types for which sections
11011: should be gathered (optional).
11012:
11013: If the third argument is undefined, sections are gathered for any role.
11014: If the fourth argument is undefined, sections are gathered for any status.
11015: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11016:
1.374 raeburn 11017: Returns section hash (keys are section IDs, values are
11018: number of users in each section), subject to the
1.419 raeburn 11019: optional roles filter, optional status filter
1.233 raeburn 11020:
11021: =cut
11022:
11023: ###############################################
11024: sub get_sections {
1.419 raeburn 11025: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11026: if (!defined($cdom) || !defined($cnum)) {
11027: my $cid = $env{'request.course.id'};
11028:
11029: return if (!defined($cid));
11030:
11031: $cdom = $env{'course.'.$cid.'.domain'};
11032: $cnum = $env{'course.'.$cid.'.num'};
11033: }
11034:
11035: my %sectioncount;
1.419 raeburn 11036: my $now = time;
1.240 albertel 11037:
1.1118 raeburn 11038: my $check_students = 1;
11039: my $only_students = 0;
11040: if (ref($possible_roles) eq 'ARRAY') {
11041: if (grep(/^st$/,@{$possible_roles})) {
11042: if (@{$possible_roles} == 1) {
11043: $only_students = 1;
11044: }
11045: } else {
11046: $check_students = 0;
11047: }
11048: }
11049:
11050: if ($check_students) {
1.276 albertel 11051: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11052: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11053: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11054: my $start_index = &Apache::loncoursedata::CL_START();
11055: my $end_index = &Apache::loncoursedata::CL_END();
11056: my $status;
1.366 albertel 11057: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11058: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11059: $data->[$status_index],
11060: $data->[$start_index],
11061: $data->[$end_index]);
11062: if ($stu_status eq 'Active') {
11063: $status = 'active';
11064: } elsif ($end < $now) {
11065: $status = 'previous';
11066: } elsif ($start > $now) {
11067: $status = 'future';
11068: }
11069: if ($section ne '-1' && $section !~ /^\s*$/) {
11070: if ((!defined($possible_status)) || (($status ne '') &&
11071: (grep/^\Q$status\E$/,@{$possible_status}))) {
11072: $sectioncount{$section}++;
11073: }
1.240 albertel 11074: }
11075: }
11076: }
1.1118 raeburn 11077: if ($only_students) {
11078: return %sectioncount;
11079: }
1.240 albertel 11080: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11081: foreach my $user (sort(keys(%courseroles))) {
11082: if ($user !~ /^(\w{2})/) { next; }
11083: my ($role) = ($user =~ /^(\w{2})/);
11084: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11085: my ($section,$status);
1.240 albertel 11086: if ($role eq 'cr' &&
11087: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11088: $section=$1;
11089: }
11090: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11091: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11092: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11093: if ($end == -1 && $start == -1) {
11094: next; #deleted role
11095: }
11096: if (!defined($possible_status)) {
11097: $sectioncount{$section}++;
11098: } else {
11099: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11100: $status = 'active';
11101: } elsif ($end < $now) {
11102: $status = 'future';
11103: } elsif ($start > $now) {
11104: $status = 'previous';
11105: }
11106: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11107: $sectioncount{$section}++;
11108: }
11109: }
1.233 raeburn 11110: }
1.366 albertel 11111: return %sectioncount;
1.233 raeburn 11112: }
11113:
1.274 raeburn 11114: ###############################################
1.294 raeburn 11115:
11116: =pod
1.405 albertel 11117:
11118: =item * &get_course_users()
11119:
1.275 raeburn 11120: Retrieves usernames:domains for users in the specified course
11121: with specific role(s), and access status.
11122:
11123: Incoming parameters:
1.277 albertel 11124: 1. course domain
11125: 2. course number
11126: 3. access status: users must have - either active,
1.275 raeburn 11127: previous, future, or all.
1.277 albertel 11128: 4. reference to array of permissible roles
1.288 raeburn 11129: 5. reference to array of section restrictions (optional)
11130: 6. reference to results object (hash of hashes).
11131: 7. reference to optional userdata hash
1.609 raeburn 11132: 8. reference to optional statushash
1.630 raeburn 11133: 9. flag if privileged users (except those set to unhide in
11134: course settings) should be excluded
1.609 raeburn 11135: Keys of top level results hash are roles.
1.275 raeburn 11136: Keys of inner hashes are username:domain, with
11137: values set to access type.
1.288 raeburn 11138: Optional userdata hash returns an array with arguments in the
11139: same order as loncoursedata::get_classlist() for student data.
11140:
1.609 raeburn 11141: Optional statushash returns
11142:
1.288 raeburn 11143: Entries for end, start, section and status are blank because
11144: of the possibility of multiple values for non-student roles.
11145:
1.275 raeburn 11146: =cut
1.405 albertel 11147:
1.275 raeburn 11148: ###############################################
1.405 albertel 11149:
1.275 raeburn 11150: sub get_course_users {
1.630 raeburn 11151: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11152: my %idx = ();
1.419 raeburn 11153: my %seclists;
1.288 raeburn 11154:
11155: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11156: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11157: $idx{end} = &Apache::loncoursedata::CL_END();
11158: $idx{start} = &Apache::loncoursedata::CL_START();
11159: $idx{id} = &Apache::loncoursedata::CL_ID();
11160: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11161: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11162: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11163:
1.290 albertel 11164: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11165: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11166: my $now = time;
1.277 albertel 11167: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11168: my $match = 0;
1.412 raeburn 11169: my $secmatch = 0;
1.419 raeburn 11170: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11171: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11172: if ($section eq '') {
11173: $section = 'none';
11174: }
1.291 albertel 11175: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11176: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11177: $secmatch = 1;
11178: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11179: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11180: $secmatch = 1;
11181: }
11182: } else {
1.419 raeburn 11183: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11184: $secmatch = 1;
11185: }
1.290 albertel 11186: }
1.412 raeburn 11187: if (!$secmatch) {
11188: next;
11189: }
1.419 raeburn 11190: }
1.275 raeburn 11191: if (defined($$types{'active'})) {
1.288 raeburn 11192: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11193: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11194: $match = 1;
1.275 raeburn 11195: }
11196: }
11197: if (defined($$types{'previous'})) {
1.609 raeburn 11198: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11199: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11200: $match = 1;
1.275 raeburn 11201: }
11202: }
11203: if (defined($$types{'future'})) {
1.609 raeburn 11204: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11205: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11206: $match = 1;
1.275 raeburn 11207: }
11208: }
1.609 raeburn 11209: if ($match) {
11210: push(@{$seclists{$student}},$section);
11211: if (ref($userdata) eq 'HASH') {
11212: $$userdata{$student} = $$classlist{$student};
11213: }
11214: if (ref($statushash) eq 'HASH') {
11215: $statushash->{$student}{'st'}{$section} = $status;
11216: }
1.288 raeburn 11217: }
1.275 raeburn 11218: }
11219: }
1.412 raeburn 11220: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11221: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11222: my $now = time;
1.609 raeburn 11223: my %displaystatus = ( previous => 'Expired',
11224: active => 'Active',
11225: future => 'Future',
11226: );
1.1121 raeburn 11227: my (%nothide,@possdoms);
1.630 raeburn 11228: if ($hidepriv) {
11229: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11230: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11231: if ($user !~ /:/) {
11232: $nothide{join(':',split(/[\@]/,$user))}=1;
11233: } else {
11234: $nothide{$user} = 1;
11235: }
11236: }
1.1121 raeburn 11237: my @possdoms = ($cdom);
11238: if ($coursehash{'checkforpriv'}) {
11239: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11240: }
1.630 raeburn 11241: }
1.439 raeburn 11242: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11243: my $match = 0;
1.412 raeburn 11244: my $secmatch = 0;
1.439 raeburn 11245: my $status;
1.412 raeburn 11246: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11247: $user =~ s/:$//;
1.439 raeburn 11248: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11249: if ($end == -1 || $start == -1) {
11250: next;
11251: }
11252: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11253: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11254: my ($uname,$udom) = split(/:/,$user);
11255: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11256: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11257: $secmatch = 1;
11258: } elsif ($usec eq '') {
1.420 albertel 11259: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11260: $secmatch = 1;
11261: }
11262: } else {
11263: if (grep(/^\Q$usec\E$/,@{$sections})) {
11264: $secmatch = 1;
11265: }
11266: }
11267: if (!$secmatch) {
11268: next;
11269: }
1.288 raeburn 11270: }
1.419 raeburn 11271: if ($usec eq '') {
11272: $usec = 'none';
11273: }
1.275 raeburn 11274: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11275: if ($hidepriv) {
1.1121 raeburn 11276: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11277: (!$nothide{$uname.':'.$udom})) {
11278: next;
11279: }
11280: }
1.503 raeburn 11281: if ($end > 0 && $end < $now) {
1.439 raeburn 11282: $status = 'previous';
11283: } elsif ($start > $now) {
11284: $status = 'future';
11285: } else {
11286: $status = 'active';
11287: }
1.277 albertel 11288: foreach my $type (keys(%{$types})) {
1.275 raeburn 11289: if ($status eq $type) {
1.420 albertel 11290: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11291: push(@{$$users{$role}{$user}},$type);
11292: }
1.288 raeburn 11293: $match = 1;
11294: }
11295: }
1.419 raeburn 11296: if (($match) && (ref($userdata) eq 'HASH')) {
11297: if (!exists($$userdata{$uname.':'.$udom})) {
11298: &get_user_info($udom,$uname,\%idx,$userdata);
11299: }
1.420 albertel 11300: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11301: push(@{$seclists{$uname.':'.$udom}},$usec);
11302: }
1.609 raeburn 11303: if (ref($statushash) eq 'HASH') {
11304: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11305: }
1.275 raeburn 11306: }
11307: }
11308: }
11309: }
1.290 albertel 11310: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11311: if ((defined($cdom)) && (defined($cnum))) {
11312: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11313: if ( defined($csettings{'internal.courseowner'}) ) {
11314: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11315: next if ($owner eq '');
11316: my ($ownername,$ownerdom);
11317: if ($owner =~ /^([^:]+):([^:]+)$/) {
11318: $ownername = $1;
11319: $ownerdom = $2;
11320: } else {
11321: $ownername = $owner;
11322: $ownerdom = $cdom;
11323: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11324: }
11325: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11326: if (defined($userdata) &&
1.609 raeburn 11327: !exists($$userdata{$owner})) {
11328: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11329: if (!grep(/^none$/,@{$seclists{$owner}})) {
11330: push(@{$seclists{$owner}},'none');
11331: }
11332: if (ref($statushash) eq 'HASH') {
11333: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11334: }
1.290 albertel 11335: }
1.279 raeburn 11336: }
11337: }
11338: }
1.419 raeburn 11339: foreach my $user (keys(%seclists)) {
11340: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11341: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11342: }
1.275 raeburn 11343: }
11344: return;
11345: }
11346:
1.288 raeburn 11347: sub get_user_info {
11348: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11349: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11350: &plainname($uname,$udom,'lastname');
1.291 albertel 11351: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11352: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11353: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11354: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11355: return;
11356: }
1.275 raeburn 11357:
1.472 raeburn 11358: ###############################################
11359:
11360: =pod
11361:
11362: =item * &get_user_quota()
11363:
1.1134 raeburn 11364: Retrieves quota assigned for storage of user files.
11365: Default is to report quota for portfolio files.
1.472 raeburn 11366:
11367: Incoming parameters:
11368: 1. user's username
11369: 2. user's domain
1.1134 raeburn 11370: 3. quota name - portfolio, author, or course
1.1136 raeburn 11371: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11372: 4. crstype - official, unofficial, textbook, placement or community,
11373: if quota name is course
1.472 raeburn 11374:
11375: Returns:
1.1163 raeburn 11376: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11377: 2. (Optional) Type of setting: custom or default
11378: (individually assigned or default for user's
11379: institutional status).
11380: 3. (Optional) - User's institutional status (e.g., faculty, staff
11381: or student - types as defined in localenroll::inst_usertypes
11382: for user's domain, which determines default quota for user.
11383: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11384:
11385: If a value has been stored in the user's environment,
1.536 raeburn 11386: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11387: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11388:
11389: =cut
11390:
11391: ###############################################
11392:
11393:
11394: sub get_user_quota {
1.1136 raeburn 11395: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11396: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11397: if (!defined($udom)) {
11398: $udom = $env{'user.domain'};
11399: }
11400: if (!defined($uname)) {
11401: $uname = $env{'user.name'};
11402: }
11403: if (($udom eq '' || $uname eq '') ||
11404: ($udom eq 'public') && ($uname eq 'public')) {
11405: $quota = 0;
1.536 raeburn 11406: $quotatype = 'default';
11407: $defquota = 0;
1.472 raeburn 11408: } else {
1.536 raeburn 11409: my $inststatus;
1.1134 raeburn 11410: if ($quotaname eq 'course') {
11411: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11412: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11413: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11414: } else {
11415: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11416: $quota = $cenv{'internal.uploadquota'};
11417: }
1.536 raeburn 11418: } else {
1.1134 raeburn 11419: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11420: if ($quotaname eq 'author') {
11421: $quota = $env{'environment.authorquota'};
11422: } else {
11423: $quota = $env{'environment.portfolioquota'};
11424: }
11425: $inststatus = $env{'environment.inststatus'};
11426: } else {
11427: my %userenv =
11428: &Apache::lonnet::get('environment',['portfolioquota',
11429: 'authorquota','inststatus'],$udom,$uname);
11430: my ($tmp) = keys(%userenv);
11431: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11432: if ($quotaname eq 'author') {
11433: $quota = $userenv{'authorquota'};
11434: } else {
11435: $quota = $userenv{'portfolioquota'};
11436: }
11437: $inststatus = $userenv{'inststatus'};
11438: } else {
11439: undef(%userenv);
11440: }
11441: }
11442: }
11443: if ($quota eq '' || wantarray) {
11444: if ($quotaname eq 'course') {
11445: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11446: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11447: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11448: ($crstype eq 'placement')) {
1.1136 raeburn 11449: $defquota = $domdefs{$crstype.'quota'};
11450: }
11451: if ($defquota eq '') {
11452: $defquota = 500;
11453: }
1.1134 raeburn 11454: } else {
11455: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11456: }
11457: if ($quota eq '') {
11458: $quota = $defquota;
11459: $quotatype = 'default';
11460: } else {
11461: $quotatype = 'custom';
11462: }
1.472 raeburn 11463: }
11464: }
1.536 raeburn 11465: if (wantarray) {
11466: return ($quota,$quotatype,$settingstatus,$defquota);
11467: } else {
11468: return $quota;
11469: }
1.472 raeburn 11470: }
11471:
11472: ###############################################
11473:
11474: =pod
11475:
11476: =item * &default_quota()
11477:
1.536 raeburn 11478: Retrieves default quota assigned for storage of user portfolio files,
11479: given an (optional) user's institutional status.
1.472 raeburn 11480:
11481: Incoming parameters:
1.1142 raeburn 11482:
1.472 raeburn 11483: 1. domain
1.536 raeburn 11484: 2. (Optional) institutional status(es). This is a : separated list of
11485: status types (e.g., faculty, staff, student etc.)
11486: which apply to the user for whom the default is being retrieved.
11487: If the institutional status string in undefined, the domain
1.1134 raeburn 11488: default quota will be returned.
11489: 3. quota name - portfolio, author, or course
11490: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11491:
11492: Returns:
1.1142 raeburn 11493:
1.1163 raeburn 11494: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11495: 2. (Optional) institutional type which determined the value of the
11496: default quota.
1.472 raeburn 11497:
11498: If a value has been stored in the domain's configuration db,
11499: it will return that, otherwise it returns 20 (for backwards
11500: compatibility with domains which have not set up a configuration
1.1163 raeburn 11501: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11502:
1.536 raeburn 11503: If the user's status includes multiple types (e.g., staff and student),
11504: the largest default quota which applies to the user determines the
11505: default quota returned.
11506:
1.472 raeburn 11507: =cut
11508:
11509: ###############################################
11510:
11511:
11512: sub default_quota {
1.1134 raeburn 11513: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11514: my ($defquota,$settingstatus);
11515: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11516: ['quotas'],$udom);
1.1134 raeburn 11517: my $key = 'defaultquota';
11518: if ($quotaname eq 'author') {
11519: $key = 'authorquota';
11520: }
1.622 raeburn 11521: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11522: if ($inststatus ne '') {
1.765 raeburn 11523: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11524: foreach my $item (@statuses) {
1.1134 raeburn 11525: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11526: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11527: if ($defquota eq '') {
1.1134 raeburn 11528: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11529: $settingstatus = $item;
1.1134 raeburn 11530: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11531: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11532: $settingstatus = $item;
11533: }
11534: }
1.1134 raeburn 11535: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11536: if ($quotahash{'quotas'}{$item} ne '') {
11537: if ($defquota eq '') {
11538: $defquota = $quotahash{'quotas'}{$item};
11539: $settingstatus = $item;
11540: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11541: $defquota = $quotahash{'quotas'}{$item};
11542: $settingstatus = $item;
11543: }
1.536 raeburn 11544: }
11545: }
11546: }
11547: }
11548: if ($defquota eq '') {
1.1134 raeburn 11549: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11550: $defquota = $quotahash{'quotas'}{$key}{'default'};
11551: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11552: $defquota = $quotahash{'quotas'}{'default'};
11553: }
1.536 raeburn 11554: $settingstatus = 'default';
1.1139 raeburn 11555: if ($defquota eq '') {
11556: if ($quotaname eq 'author') {
11557: $defquota = 500;
11558: }
11559: }
1.536 raeburn 11560: }
11561: } else {
11562: $settingstatus = 'default';
1.1134 raeburn 11563: if ($quotaname eq 'author') {
11564: $defquota = 500;
11565: } else {
11566: $defquota = 20;
11567: }
1.536 raeburn 11568: }
11569: if (wantarray) {
11570: return ($defquota,$settingstatus);
1.472 raeburn 11571: } else {
1.536 raeburn 11572: return $defquota;
1.472 raeburn 11573: }
11574: }
11575:
1.1135 raeburn 11576: ###############################################
11577:
11578: =pod
11579:
1.1136 raeburn 11580: =item * &excess_filesize_warning()
1.1135 raeburn 11581:
11582: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11583: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11584: space to be exceeded.
1.1136 raeburn 11585:
11586: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11587: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11588:
1.1165 raeburn 11589: Inputs: 7
1.1136 raeburn 11590: 1. username or coursenum
1.1135 raeburn 11591: 2. domain
1.1136 raeburn 11592: 3. context ('author' or 'course')
1.1135 raeburn 11593: 4. filename of file for which action is being requested
11594: 5. filesize (kB) of file
11595: 6. action being taken: copy or upload.
1.1237 raeburn 11596: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11597:
11598: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11599: otherwise return null.
11600:
11601: =back
1.1135 raeburn 11602:
11603: =cut
11604:
1.1136 raeburn 11605: sub excess_filesize_warning {
1.1165 raeburn 11606: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11607: my $current_disk_usage = 0;
1.1165 raeburn 11608: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11609: if ($context eq 'author') {
11610: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11611: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11612: } else {
11613: foreach my $subdir ('docs','supplemental') {
11614: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11615: }
11616: }
1.1135 raeburn 11617: $disk_quota = int($disk_quota * 1000);
11618: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11619: return '<p class="LC_warning">'.
1.1135 raeburn 11620: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11621: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11622: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11623: $disk_quota,$current_disk_usage).
11624: '</p>';
11625: }
11626: return;
11627: }
11628:
11629: ###############################################
11630:
11631:
1.1136 raeburn 11632:
11633:
1.384 raeburn 11634: sub get_secgrprole_info {
11635: my ($cdom,$cnum,$needroles,$type) = @_;
11636: my %sections_count = &get_sections($cdom,$cnum);
11637: my @sections = (sort {$a <=> $b} keys(%sections_count));
11638: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11639: my @groups = sort(keys(%curr_groups));
11640: my $allroles = [];
11641: my $rolehash;
11642: my $accesshash = {
11643: active => 'Currently has access',
11644: future => 'Will have future access',
11645: previous => 'Previously had access',
11646: };
11647: if ($needroles) {
11648: $rolehash = {'all' => 'all'};
1.385 albertel 11649: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11650: if (&Apache::lonnet::error(%user_roles)) {
11651: undef(%user_roles);
11652: }
11653: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11654: my ($role)=split(/\:/,$item,2);
11655: if ($role eq 'cr') { next; }
11656: if ($role =~ /^cr/) {
11657: $$rolehash{$role} = (split('/',$role))[3];
11658: } else {
11659: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11660: }
11661: }
11662: foreach my $key (sort(keys(%{$rolehash}))) {
11663: push(@{$allroles},$key);
11664: }
11665: push (@{$allroles},'st');
11666: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11667: }
11668: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11669: }
11670:
1.555 raeburn 11671: sub user_picker {
1.1279 raeburn 11672: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11673: my $currdom = $dom;
1.1253 raeburn 11674: my @alldoms = &Apache::lonnet::all_domains();
11675: if (@alldoms == 1) {
11676: my %domsrch = &Apache::lonnet::get_dom('configuration',
11677: ['directorysrch'],$alldoms[0]);
11678: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11679: my $showdom = $domdesc;
11680: if ($showdom eq '') {
11681: $showdom = $dom;
11682: }
11683: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11684: if ((!$domsrch{'directorysrch'}{'available'}) &&
11685: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11686: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11687: }
11688: }
11689: }
1.555 raeburn 11690: my %curr_selected = (
11691: srchin => 'dom',
1.580 raeburn 11692: srchby => 'lastname',
1.555 raeburn 11693: );
11694: my $srchterm;
1.625 raeburn 11695: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11696: if ($srch->{'srchby'} ne '') {
11697: $curr_selected{'srchby'} = $srch->{'srchby'};
11698: }
11699: if ($srch->{'srchin'} ne '') {
11700: $curr_selected{'srchin'} = $srch->{'srchin'};
11701: }
11702: if ($srch->{'srchtype'} ne '') {
11703: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11704: }
11705: if ($srch->{'srchdomain'} ne '') {
11706: $currdom = $srch->{'srchdomain'};
11707: }
11708: $srchterm = $srch->{'srchterm'};
11709: }
1.1222 damieng 11710: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11711: 'usr' => 'Search criteria',
1.563 raeburn 11712: 'doma' => 'Domain/institution to search',
1.558 albertel 11713: 'uname' => 'username',
11714: 'lastname' => 'last name',
1.555 raeburn 11715: 'lastfirst' => 'last name, first name',
1.558 albertel 11716: 'crs' => 'in this course',
1.576 raeburn 11717: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11718: 'alc' => 'all LON-CAPA',
1.573 raeburn 11719: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11720: 'exact' => 'is',
11721: 'contains' => 'contains',
1.569 raeburn 11722: 'begins' => 'begins with',
1.1222 damieng 11723: );
11724: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11725: 'youm' => "You must include some text to search for.",
11726: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11727: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11728: 'yomc' => "You must choose a domain when using an institutional directory search.",
11729: 'ymcd' => "You must choose a domain when using a domain search.",
11730: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11731: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11732: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11733: );
1.1222 damieng 11734: &html_escape(\%html_lt);
11735: &js_escape(\%js_lt);
1.1255 raeburn 11736: my $domform;
1.1277 raeburn 11737: my $allow_blank = 1;
1.1255 raeburn 11738: if ($fixeddom) {
1.1277 raeburn 11739: $allow_blank = 0;
11740: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11741: } else {
1.1287 raeburn 11742: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11743: my ($trusted,$untrusted);
1.1287 raeburn 11744: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11745: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11746: } elsif ($context eq 'author') {
1.1288 raeburn 11747: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11748: } elsif ($context eq 'domain') {
1.1288 raeburn 11749: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11750: }
1.1288 raeburn 11751: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11752: }
1.563 raeburn 11753: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11754:
11755: my @srchins = ('crs','dom','alc','instd');
11756:
11757: foreach my $option (@srchins) {
11758: # FIXME 'alc' option unavailable until
11759: # loncreateuser::print_user_query_page()
11760: # has been completed.
11761: next if ($option eq 'alc');
1.880 raeburn 11762: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11763: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11764: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11765: if ($curr_selected{'srchin'} eq $option) {
11766: $srchinsel .= '
1.1222 damieng 11767: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11768: } else {
11769: $srchinsel .= '
1.1222 damieng 11770: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11771: }
1.555 raeburn 11772: }
1.563 raeburn 11773: $srchinsel .= "\n </select>\n";
1.555 raeburn 11774:
11775: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11776: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11777: if ($curr_selected{'srchby'} eq $option) {
11778: $srchbysel .= '
1.1222 damieng 11779: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11780: } else {
11781: $srchbysel .= '
1.1222 damieng 11782: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11783: }
11784: }
11785: $srchbysel .= "\n </select>\n";
11786:
11787: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11788: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11789: if ($curr_selected{'srchtype'} eq $option) {
11790: $srchtypesel .= '
1.1222 damieng 11791: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11792: } else {
11793: $srchtypesel .= '
1.1222 damieng 11794: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11795: }
11796: }
11797: $srchtypesel .= "\n </select>\n";
11798:
1.558 albertel 11799: my ($newuserscript,$new_user_create);
1.994 raeburn 11800: my $context_dom = $env{'request.role.domain'};
11801: if ($context eq 'requestcrs') {
11802: if ($env{'form.coursedom'} ne '') {
11803: $context_dom = $env{'form.coursedom'};
11804: }
11805: }
1.556 raeburn 11806: if ($forcenewuser) {
1.576 raeburn 11807: if (ref($srch) eq 'HASH') {
1.994 raeburn 11808: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11809: if ($cancreate) {
11810: $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>';
11811: } else {
1.799 bisitz 11812: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11813: my %usertypetext = (
11814: official => 'institutional',
11815: unofficial => 'non-institutional',
11816: );
1.799 bisitz 11817: $new_user_create = '<p class="LC_warning">'
11818: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11819: .' '
11820: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11821: ,'<a href="'.$helplink.'">','</a>')
11822: .'</p><br />';
1.627 raeburn 11823: }
1.576 raeburn 11824: }
11825: }
11826:
1.556 raeburn 11827: $newuserscript = <<"ENDSCRIPT";
11828:
1.570 raeburn 11829: function setSearch(createnew,callingForm) {
1.556 raeburn 11830: if (createnew == 1) {
1.570 raeburn 11831: for (var i=0; i<callingForm.srchby.length; i++) {
11832: if (callingForm.srchby.options[i].value == 'uname') {
11833: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11834: }
11835: }
1.570 raeburn 11836: for (var i=0; i<callingForm.srchin.length; i++) {
11837: if ( callingForm.srchin.options[i].value == 'dom') {
11838: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11839: }
11840: }
1.570 raeburn 11841: for (var i=0; i<callingForm.srchtype.length; i++) {
11842: if (callingForm.srchtype.options[i].value == 'exact') {
11843: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11844: }
11845: }
1.570 raeburn 11846: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11847: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11848: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11849: }
11850: }
11851: }
11852: }
11853: ENDSCRIPT
1.558 albertel 11854:
1.556 raeburn 11855: }
11856:
1.555 raeburn 11857: my $output = <<"END_BLOCK";
1.556 raeburn 11858: <script type="text/javascript">
1.824 bisitz 11859: // <![CDATA[
1.570 raeburn 11860: function validateEntry(callingForm) {
1.558 albertel 11861:
1.556 raeburn 11862: var checkok = 1;
1.558 albertel 11863: var srchin;
1.570 raeburn 11864: for (var i=0; i<callingForm.srchin.length; i++) {
11865: if ( callingForm.srchin[i].checked ) {
11866: srchin = callingForm.srchin[i].value;
1.558 albertel 11867: }
11868: }
11869:
1.570 raeburn 11870: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11871: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11872: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11873: var srchterm = callingForm.srchterm.value;
11874: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11875: var msg = "";
11876:
11877: if (srchterm == "") {
11878: checkok = 0;
1.1222 damieng 11879: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11880: }
11881:
1.569 raeburn 11882: if (srchtype== 'begins') {
11883: if (srchterm.length < 2) {
11884: checkok = 0;
1.1222 damieng 11885: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11886: }
11887: }
11888:
1.556 raeburn 11889: if (srchtype== 'contains') {
11890: if (srchterm.length < 3) {
11891: checkok = 0;
1.1222 damieng 11892: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11893: }
11894: }
11895: if (srchin == 'instd') {
11896: if (srchdomain == '') {
11897: checkok = 0;
1.1222 damieng 11898: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11899: }
11900: }
11901: if (srchin == 'dom') {
11902: if (srchdomain == '') {
11903: checkok = 0;
1.1222 damieng 11904: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11905: }
11906: }
11907: if (srchby == 'lastfirst') {
11908: if (srchterm.indexOf(",") == -1) {
11909: checkok = 0;
1.1222 damieng 11910: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11911: }
11912: if (srchterm.indexOf(",") == srchterm.length -1) {
11913: checkok = 0;
1.1222 damieng 11914: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11915: }
11916: }
11917: if (checkok == 0) {
1.1222 damieng 11918: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11919: return;
11920: }
11921: if (checkok == 1) {
1.570 raeburn 11922: callingForm.submit();
1.556 raeburn 11923: }
11924: }
11925:
11926: $newuserscript
11927:
1.824 bisitz 11928: // ]]>
1.556 raeburn 11929: </script>
1.558 albertel 11930:
11931: $new_user_create
11932:
1.555 raeburn 11933: END_BLOCK
1.558 albertel 11934:
1.876 raeburn 11935: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11936: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11937: $domform.
11938: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11939: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11940: $srchbysel.
11941: $srchtypesel.
11942: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11943: $srchinsel.
11944: &Apache::lonhtmlcommon::row_closure(1).
11945: &Apache::lonhtmlcommon::end_pick_box().
11946: '<br />';
1.1253 raeburn 11947: return ($output,1);
1.555 raeburn 11948: }
11949:
1.612 raeburn 11950: sub user_rule_check {
1.615 raeburn 11951: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11952: my ($response,%inst_response);
1.612 raeburn 11953: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11954: if (keys(%{$usershash}) > 1) {
11955: my (%by_username,%by_id,%userdoms);
11956: my $checkid;
11957: if (ref($checks) eq 'HASH') {
11958: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11959: $checkid = 1;
11960: }
11961: }
11962: foreach my $user (keys(%{$usershash})) {
11963: my ($uname,$udom) = split(/:/,$user);
11964: if ($checkid) {
11965: if (ref($usershash->{$user}) eq 'HASH') {
11966: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11967: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11968: $userdoms{$udom} = 1;
1.1227 raeburn 11969: if (ref($inst_results) eq 'HASH') {
11970: $inst_results->{$uname.':'.$udom} = {};
11971: }
1.1226 raeburn 11972: }
11973: }
11974: } else {
11975: $by_username{$udom}{$uname} = 1;
11976: $userdoms{$udom} = 1;
1.1227 raeburn 11977: if (ref($inst_results) eq 'HASH') {
11978: $inst_results->{$uname.':'.$udom} = {};
11979: }
1.1226 raeburn 11980: }
11981: }
11982: foreach my $udom (keys(%userdoms)) {
11983: if (!$got_rules->{$udom}) {
11984: my %domconfig = &Apache::lonnet::get_dom('configuration',
11985: ['usercreation'],$udom);
11986: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11987: foreach my $item ('username','id') {
11988: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11989: $$curr_rules{$udom}{$item} =
11990: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11991: }
11992: }
11993: }
11994: $got_rules->{$udom} = 1;
11995: }
1.612 raeburn 11996: }
1.1226 raeburn 11997: if ($checkid) {
11998: foreach my $udom (keys(%by_id)) {
11999: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12000: if ($outcome eq 'ok') {
1.1227 raeburn 12001: foreach my $id (keys(%{$by_id{$udom}})) {
12002: my $uname = $by_id{$udom}{$id};
12003: $inst_response{$uname.':'.$udom} = $outcome;
12004: }
1.1226 raeburn 12005: if (ref($results) eq 'HASH') {
12006: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12007: if (exists($inst_response{$uname.':'.$udom})) {
12008: $inst_response{$uname.':'.$udom} = $outcome;
12009: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12010: }
1.1226 raeburn 12011: }
12012: }
12013: }
1.612 raeburn 12014: }
1.615 raeburn 12015: } else {
1.1226 raeburn 12016: foreach my $udom (keys(%by_username)) {
12017: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12018: if ($outcome eq 'ok') {
1.1227 raeburn 12019: foreach my $uname (keys(%{$by_username{$udom}})) {
12020: $inst_response{$uname.':'.$udom} = $outcome;
12021: }
1.1226 raeburn 12022: if (ref($results) eq 'HASH') {
12023: foreach my $uname (keys(%{$results})) {
12024: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12025: }
12026: }
12027: }
12028: }
1.612 raeburn 12029: }
1.1226 raeburn 12030: } elsif (keys(%{$usershash}) == 1) {
12031: my $user = (keys(%{$usershash}))[0];
12032: my ($uname,$udom) = split(/:/,$user);
12033: if (($udom ne '') && ($uname ne '')) {
12034: if (ref($usershash->{$user}) eq 'HASH') {
12035: if (ref($checks) eq 'HASH') {
12036: if (defined($checks->{'username'})) {
12037: ($inst_response{$user},%{$inst_results->{$user}}) =
12038: &Apache::lonnet::get_instuser($udom,$uname);
12039: } elsif (defined($checks->{'id'})) {
12040: if ($usershash->{$user}->{'id'} ne '') {
12041: ($inst_response{$user},%{$inst_results->{$user}}) =
12042: &Apache::lonnet::get_instuser($udom,undef,
12043: $usershash->{$user}->{'id'});
12044: } else {
12045: ($inst_response{$user},%{$inst_results->{$user}}) =
12046: &Apache::lonnet::get_instuser($udom,$uname);
12047: }
1.585 raeburn 12048: }
1.1226 raeburn 12049: } else {
12050: ($inst_response{$user},%{$inst_results->{$user}}) =
12051: &Apache::lonnet::get_instuser($udom,$uname);
12052: return;
12053: }
12054: if (!$got_rules->{$udom}) {
12055: my %domconfig = &Apache::lonnet::get_dom('configuration',
12056: ['usercreation'],$udom);
12057: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12058: foreach my $item ('username','id') {
12059: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12060: $$curr_rules{$udom}{$item} =
12061: $domconfig{'usercreation'}{$item.'_rule'};
12062: }
12063: }
12064: }
12065: $got_rules->{$udom} = 1;
1.585 raeburn 12066: }
12067: }
1.1226 raeburn 12068: } else {
12069: return;
12070: }
12071: } else {
12072: return;
12073: }
12074: foreach my $user (keys(%{$usershash})) {
12075: my ($uname,$udom) = split(/:/,$user);
12076: next if (($udom eq '') || ($uname eq ''));
12077: my $id;
1.1227 raeburn 12078: if (ref($inst_results) eq 'HASH') {
12079: if (ref($inst_results->{$user}) eq 'HASH') {
12080: $id = $inst_results->{$user}->{'id'};
12081: }
12082: }
12083: if ($id eq '') {
12084: if (ref($usershash->{$user})) {
12085: $id = $usershash->{$user}->{'id'};
12086: }
1.585 raeburn 12087: }
1.612 raeburn 12088: foreach my $item (keys(%{$checks})) {
12089: if (ref($$curr_rules{$udom}) eq 'HASH') {
12090: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12091: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12092: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12093: $$curr_rules{$udom}{$item});
1.612 raeburn 12094: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12095: if ($rule_check{$rule}) {
12096: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12097: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12098: if (ref($inst_results) eq 'HASH') {
12099: if (ref($inst_results->{$user}) eq 'HASH') {
12100: if (keys(%{$inst_results->{$user}}) == 0) {
12101: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12102: } elsif ($item eq 'id') {
12103: if ($inst_results->{$user}->{'id'} eq '') {
12104: $$alerts{$item}{$udom}{$uname} = 1;
12105: }
1.615 raeburn 12106: }
1.612 raeburn 12107: }
12108: }
1.615 raeburn 12109: }
12110: last;
1.585 raeburn 12111: }
12112: }
12113: }
12114: }
12115: }
12116: }
12117: }
12118: }
1.612 raeburn 12119: return;
12120: }
12121:
12122: sub user_rule_formats {
12123: my ($domain,$domdesc,$curr_rules,$check) = @_;
12124: my %text = (
12125: 'username' => 'Usernames',
12126: 'id' => 'IDs',
12127: );
12128: my $output;
12129: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12130: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12131: if (@{$ruleorder} > 0) {
1.1102 raeburn 12132: $output = '<br />'.
12133: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12134: '<span class="LC_cusr_emph">','</span>',$domdesc).
12135: ' <ul>';
1.612 raeburn 12136: foreach my $rule (@{$ruleorder}) {
12137: if (ref($curr_rules) eq 'ARRAY') {
12138: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12139: if (ref($rules->{$rule}) eq 'HASH') {
12140: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12141: $rules->{$rule}{'desc'}.'</li>';
12142: }
12143: }
12144: }
12145: }
12146: $output .= '</ul>';
12147: }
12148: }
12149: return $output;
12150: }
12151:
12152: sub instrule_disallow_msg {
1.615 raeburn 12153: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12154: my $response;
12155: my %text = (
12156: item => 'username',
12157: items => 'usernames',
12158: match => 'matches',
12159: do => 'does',
12160: action => 'a username',
12161: one => 'one',
12162: );
12163: if ($count > 1) {
12164: $text{'item'} = 'usernames';
12165: $text{'match'} ='match';
12166: $text{'do'} = 'do';
12167: $text{'action'} = 'usernames',
12168: $text{'one'} = 'ones';
12169: }
12170: if ($checkitem eq 'id') {
12171: $text{'items'} = 'IDs';
12172: $text{'item'} = 'ID';
12173: $text{'action'} = 'an ID';
1.615 raeburn 12174: if ($count > 1) {
12175: $text{'item'} = 'IDs';
12176: $text{'action'} = 'IDs';
12177: }
1.612 raeburn 12178: }
1.674 bisitz 12179: $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 12180: if ($mode eq 'upload') {
12181: if ($checkitem eq 'username') {
12182: $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'}.");
12183: } elsif ($checkitem eq 'id') {
1.674 bisitz 12184: $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 12185: }
1.669 raeburn 12186: } elsif ($mode eq 'selfcreate') {
12187: if ($checkitem eq 'id') {
12188: $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.");
12189: }
1.615 raeburn 12190: } else {
12191: if ($checkitem eq 'username') {
12192: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12193: } elsif ($checkitem eq 'id') {
12194: $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.");
12195: }
1.612 raeburn 12196: }
12197: return $response;
1.585 raeburn 12198: }
12199:
1.624 raeburn 12200: sub personal_data_fieldtitles {
12201: my %fieldtitles = &Apache::lonlocal::texthash (
12202: id => 'Student/Employee ID',
12203: permanentemail => 'E-mail address',
12204: lastname => 'Last Name',
12205: firstname => 'First Name',
12206: middlename => 'Middle Name',
12207: generation => 'Generation',
12208: gen => 'Generation',
1.765 raeburn 12209: inststatus => 'Affiliation',
1.624 raeburn 12210: );
12211: return %fieldtitles;
12212: }
12213:
1.642 raeburn 12214: sub sorted_inst_types {
12215: my ($dom) = @_;
1.1185 raeburn 12216: my ($usertypes,$order);
12217: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12218: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12219: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12220: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12221: } else {
12222: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12223: }
1.642 raeburn 12224: my $othertitle = &mt('All users');
12225: if ($env{'request.course.id'}) {
1.668 raeburn 12226: $othertitle = &mt('Any users');
1.642 raeburn 12227: }
12228: my @types;
12229: if (ref($order) eq 'ARRAY') {
12230: @types = @{$order};
12231: }
12232: if (@types == 0) {
12233: if (ref($usertypes) eq 'HASH') {
12234: @types = sort(keys(%{$usertypes}));
12235: }
12236: }
12237: if (keys(%{$usertypes}) > 0) {
12238: $othertitle = &mt('Other users');
12239: }
12240: return ($othertitle,$usertypes,\@types);
12241: }
12242:
1.645 raeburn 12243: sub get_institutional_codes {
1.1361 raeburn 12244: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12245: # Get complete list of course sections to update
12246: my @currsections = ();
12247: my @currxlists = ();
1.1361 raeburn 12248: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12249: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12250: my $crskey = $crs.':'.$coursecode;
12251: @{$unclutteredsec{$crskey}} = ();
12252: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12253:
12254: if ($$settings{'internal.sectionnums'} ne '') {
12255: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12256: }
12257:
12258: if ($$settings{'internal.crosslistings'} ne '') {
12259: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12260: }
12261:
12262: if (@currxlists > 0) {
1.1361 raeburn 12263: foreach my $xl (@currxlists) {
12264: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12265: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12266: push(@{$allcourses},$1);
1.645 raeburn 12267: $$LC_code{$1} = $2;
12268: }
12269: }
12270: }
12271: }
1.1361 raeburn 12272:
1.645 raeburn 12273: if (@currsections > 0) {
1.1361 raeburn 12274: foreach my $sec (@currsections) {
12275: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12276: my $instsec = $1;
1.645 raeburn 12277: my $lc_sec = $2;
1.1361 raeburn 12278: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12279: push(@{$unclutteredsec{$crskey}},$instsec);
12280: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12281: }
12282: }
12283: }
12284: }
12285:
12286: if (@{$unclutteredsec{$crskey}} > 0) {
12287: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12288: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12289: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12290: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12291: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12292: push(@{$allcourses},$sec);
1.1361 raeburn 12293: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12294: }
12295: }
12296: }
12297: }
12298: return;
12299: }
12300:
1.971 raeburn 12301: sub get_standard_codeitems {
12302: return ('Year','Semester','Department','Number','Section');
12303: }
12304:
1.112 bowersj2 12305: =pod
12306:
1.780 raeburn 12307: =head1 Slot Helpers
12308:
12309: =over 4
12310:
12311: =item * sorted_slots()
12312:
1.1040 raeburn 12313: Sorts an array of slot names in order of an optional sort key,
12314: default sort is by slot start time (earliest first).
1.780 raeburn 12315:
12316: Inputs:
12317:
12318: =over 4
12319:
12320: slotsarr - Reference to array of unsorted slot names.
12321:
12322: slots - Reference to hash of hash, where outer hash keys are slot names.
12323:
1.1040 raeburn 12324: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12325:
1.549 albertel 12326: =back
12327:
1.780 raeburn 12328: Returns:
12329:
12330: =over 4
12331:
1.1040 raeburn 12332: sorted - An array of slot names sorted by a specified sort key
12333: (default sort key is start time of the slot).
1.780 raeburn 12334:
12335: =back
12336:
12337: =cut
12338:
12339:
12340: sub sorted_slots {
1.1040 raeburn 12341: my ($slotsarr,$slots,$sortkey) = @_;
12342: if ($sortkey eq '') {
12343: $sortkey = 'starttime';
12344: }
1.780 raeburn 12345: my @sorted;
12346: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12347: @sorted =
12348: sort {
12349: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12350: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12351: }
12352: if (ref($slots->{$a})) { return -1;}
12353: if (ref($slots->{$b})) { return 1;}
12354: return 0;
12355: } @{$slotsarr};
12356: }
12357: return @sorted;
12358: }
12359:
1.1040 raeburn 12360: =pod
12361:
12362: =item * get_future_slots()
12363:
12364: Inputs:
12365:
12366: =over 4
12367:
12368: cnum - course number
12369:
12370: cdom - course domain
12371:
12372: now - current UNIX time
12373:
12374: symb - optional symb
12375:
12376: =back
12377:
12378: Returns:
12379:
12380: =over 4
12381:
12382: sorted_reservable - ref to array of student_schedulable slots currently
12383: reservable, ordered by end date of reservation period.
12384:
12385: reservable_now - ref to hash of student_schedulable slots currently
12386: reservable.
12387:
12388: Keys in inner hash are:
12389: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12390: (b) endreserve: end date of reservation period.
12391: (c) uniqueperiod: start,end dates when slot is to be uniquely
12392: selected.
1.1040 raeburn 12393:
12394: sorted_future - ref to array of student_schedulable slots reservable in
12395: the future, ordered by start date of reservation period.
12396:
12397: future_reservable - ref to hash of student_schedulable slots reservable
12398: in the future.
12399:
12400: Keys in inner hash are:
12401: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12402: (b) startreserve: start date of reservation period.
12403: (c) uniqueperiod: start,end dates when slot is to be uniquely
12404: selected.
1.1040 raeburn 12405:
12406: =back
12407:
12408: =cut
12409:
12410: sub get_future_slots {
12411: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12412: my $map;
12413: if ($symb) {
12414: ($map) = &Apache::lonnet::decode_symb($symb);
12415: }
1.1040 raeburn 12416: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12417: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12418: foreach my $slot (keys(%slots)) {
12419: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12420: if ($symb) {
1.1229 raeburn 12421: if ($slots{$slot}->{'symb'} ne '') {
12422: my $canuse;
12423: my %oksymbs;
12424: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12425: map { $oksymbs{$_} = 1; } @slotsymbs;
12426: if ($oksymbs{$symb}) {
12427: $canuse = 1;
12428: } else {
12429: foreach my $item (@slotsymbs) {
12430: if ($item =~ /\.(page|sequence)$/) {
12431: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12432: if (($map ne '') && ($map eq $sloturl)) {
12433: $canuse = 1;
12434: last;
12435: }
12436: }
12437: }
12438: }
12439: next unless ($canuse);
12440: }
1.1040 raeburn 12441: }
12442: if (($slots{$slot}->{'starttime'} > $now) &&
12443: ($slots{$slot}->{'endtime'} > $now)) {
12444: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12445: my $userallowed = 0;
12446: if ($slots{$slot}->{'allowedsections'}) {
12447: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12448: if (!defined($env{'request.role.sec'})
12449: && grep(/^No section assigned$/,@allowed_sec)) {
12450: $userallowed=1;
12451: } else {
12452: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12453: $userallowed=1;
12454: }
12455: }
12456: unless ($userallowed) {
12457: if (defined($env{'request.course.groups'})) {
12458: my @groups = split(/:/,$env{'request.course.groups'});
12459: foreach my $group (@groups) {
12460: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12461: $userallowed=1;
12462: last;
12463: }
12464: }
12465: }
12466: }
12467: }
12468: if ($slots{$slot}->{'allowedusers'}) {
12469: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12470: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12471: if (grep(/^\Q$user\E$/,@allowed_users)) {
12472: $userallowed = 1;
12473: }
12474: }
12475: next unless($userallowed);
12476: }
12477: my $startreserve = $slots{$slot}->{'startreserve'};
12478: my $endreserve = $slots{$slot}->{'endreserve'};
12479: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12480: my $uniqueperiod;
12481: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12482: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12483: }
1.1040 raeburn 12484: if (($startreserve < $now) &&
12485: (!$endreserve || $endreserve > $now)) {
12486: my $lastres = $endreserve;
12487: if (!$lastres) {
12488: $lastres = $slots{$slot}->{'starttime'};
12489: }
12490: $reservable_now{$slot} = {
12491: symb => $symb,
1.1250 raeburn 12492: endreserve => $lastres,
12493: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12494: };
12495: } elsif (($startreserve > $now) &&
12496: (!$endreserve || $endreserve > $startreserve)) {
12497: $future_reservable{$slot} = {
12498: symb => $symb,
1.1250 raeburn 12499: startreserve => $startreserve,
12500: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12501: };
12502: }
12503: }
12504: }
12505: my @unsorted_reservable = keys(%reservable_now);
12506: if (@unsorted_reservable > 0) {
12507: @sorted_reservable =
12508: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12509: }
12510: my @unsorted_future = keys(%future_reservable);
12511: if (@unsorted_future > 0) {
12512: @sorted_future =
12513: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12514: }
12515: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12516: }
1.780 raeburn 12517:
12518: =pod
12519:
1.1057 foxr 12520: =back
12521:
1.549 albertel 12522: =head1 HTTP Helpers
12523:
12524: =over 4
12525:
1.648 raeburn 12526: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12527:
1.258 albertel 12528: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12529: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12530: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12531:
12532: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12533: $possible_names is an ref to an array of form element names. As an example:
12534: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12535: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12536:
12537: =cut
1.1 albertel 12538:
1.6 albertel 12539: sub get_unprocessed_cgi {
1.25 albertel 12540: my ($query,$possible_names)= @_;
1.26 matthew 12541: # $Apache::lonxml::debug=1;
1.356 albertel 12542: foreach my $pair (split(/&/,$query)) {
12543: my ($name, $value) = split(/=/,$pair);
1.369 www 12544: $name = &unescape($name);
1.25 albertel 12545: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12546: $value =~ tr/+/ /;
12547: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12548: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12549: }
1.16 harris41 12550: }
1.6 albertel 12551: }
12552:
1.112 bowersj2 12553: =pod
12554:
1.648 raeburn 12555: =item * &cacheheader()
1.112 bowersj2 12556:
12557: returns cache-controlling header code
12558:
12559: =cut
12560:
1.7 albertel 12561: sub cacheheader {
1.258 albertel 12562: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12563: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12564: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12565: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12566: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12567: return $output;
1.7 albertel 12568: }
12569:
1.112 bowersj2 12570: =pod
12571:
1.648 raeburn 12572: =item * &no_cache($r)
1.112 bowersj2 12573:
12574: specifies header code to not have cache
12575:
12576: =cut
12577:
1.9 albertel 12578: sub no_cache {
1.216 albertel 12579: my ($r) = @_;
12580: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12581: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12582: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12583: $r->no_cache(1);
12584: $r->header_out("Expires" => $date);
12585: $r->header_out("Pragma" => "no-cache");
1.123 www 12586: }
12587:
12588: sub content_type {
1.181 albertel 12589: my ($r,$type,$charset) = @_;
1.299 foxr 12590: if ($r) {
12591: # Note that printout.pl calls this with undef for $r.
12592: &no_cache($r);
12593: }
1.258 albertel 12594: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12595: unless ($charset) {
12596: $charset=&Apache::lonlocal::current_encoding;
12597: }
12598: if ($charset) { $type.='; charset='.$charset; }
12599: if ($r) {
12600: $r->content_type($type);
12601: } else {
12602: print("Content-type: $type\n\n");
12603: }
1.9 albertel 12604: }
1.25 albertel 12605:
1.112 bowersj2 12606: =pod
12607:
1.648 raeburn 12608: =item * &add_to_env($name,$value)
1.112 bowersj2 12609:
1.258 albertel 12610: adds $name to the %env hash with value
1.112 bowersj2 12611: $value, if $name already exists, the entry is converted to an array
12612: reference and $value is added to the array.
12613:
12614: =cut
12615:
1.25 albertel 12616: sub add_to_env {
12617: my ($name,$value)=@_;
1.258 albertel 12618: if (defined($env{$name})) {
12619: if (ref($env{$name})) {
1.25 albertel 12620: #already have multiple values
1.258 albertel 12621: push(@{ $env{$name} },$value);
1.25 albertel 12622: } else {
12623: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12624: my $first=$env{$name};
12625: undef($env{$name});
12626: push(@{ $env{$name} },$first,$value);
1.25 albertel 12627: }
12628: } else {
1.258 albertel 12629: $env{$name}=$value;
1.25 albertel 12630: }
1.31 albertel 12631: }
1.149 albertel 12632:
12633: =pod
12634:
1.648 raeburn 12635: =item * &get_env_multiple($name)
1.149 albertel 12636:
1.258 albertel 12637: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12638: values may be defined and end up as an array ref.
12639:
12640: returns an array of values
12641:
12642: =cut
12643:
12644: sub get_env_multiple {
12645: my ($name) = @_;
12646: my @values;
1.258 albertel 12647: if (defined($env{$name})) {
1.149 albertel 12648: # exists is it an array
1.258 albertel 12649: if (ref($env{$name})) {
12650: @values=@{ $env{$name} };
1.149 albertel 12651: } else {
1.258 albertel 12652: $values[0]=$env{$name};
1.149 albertel 12653: }
12654: }
12655: return(@values);
12656: }
12657:
1.1249 damieng 12658: # Looks at given dependencies, and returns something depending on the context.
12659: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12660: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12661: # For all other contexts, returns ($output, $counter, $numpathchg).
12662: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12663: # $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.
12664: # $numpathchg: integer with the number of cleaned up dependency paths.
12665: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12666: # \%mapping: hash reference clean path -> original path for all dependencies.
12667: # @param {string} actionurl - The path to the handler, indicative of the context.
12668: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12669: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12670: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12671: # @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)
12672: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12673: sub ask_for_embedded_content {
1.1249 damieng 12674: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12675: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12676: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12677: %currsubfile,%unused,$rem);
1.1071 raeburn 12678: my $counter = 0;
12679: my $numnew = 0;
1.987 raeburn 12680: my $numremref = 0;
12681: my $numinvalid = 0;
12682: my $numpathchg = 0;
12683: my $numexisting = 0;
1.1071 raeburn 12684: my $numunused = 0;
12685: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12686: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12687: my $heading = &mt('Upload embedded files');
12688: my $buttontext = &mt('Upload');
12689:
1.1249 damieng 12690: # fills these variables based on the context:
12691: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12692: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12693: if ($env{'request.course.id'}) {
1.1123 raeburn 12694: if ($actionurl eq '/adm/dependencies') {
12695: $navmap = Apache::lonnavmaps::navmap->new();
12696: }
12697: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12698: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12699: }
1.1123 raeburn 12700: if (($actionurl eq '/adm/portfolio') ||
12701: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12702: my $current_path='/';
12703: if ($env{'form.currentpath'}) {
12704: $current_path = $env{'form.currentpath'};
12705: }
12706: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12707: $udom = $cdom;
12708: $uname = $cnum;
1.984 raeburn 12709: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12710: } else {
12711: $udom = $env{'user.domain'};
12712: $uname = $env{'user.name'};
12713: $url = '/userfiles/portfolio';
12714: }
1.987 raeburn 12715: $toplevel = $url.'/';
1.984 raeburn 12716: $url .= $current_path;
12717: $getpropath = 1;
1.987 raeburn 12718: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12719: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12720: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12721: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12722: $toplevel = $url;
1.984 raeburn 12723: if ($rest ne '') {
1.987 raeburn 12724: $url .= $rest;
12725: }
12726: } elsif ($actionurl eq '/adm/coursedocs') {
12727: if (ref($args) eq 'HASH') {
1.1071 raeburn 12728: $url = $args->{'docs_url'};
12729: $toplevel = $url;
1.1084 raeburn 12730: if ($args->{'context'} eq 'paste') {
12731: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12732: ($path) =
12733: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12734: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12735: $fileloc =~ s{^/}{};
12736: }
1.1071 raeburn 12737: }
1.1084 raeburn 12738: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12739: if ($env{'request.course.id'} ne '') {
12740: if (ref($args) eq 'HASH') {
12741: $url = $args->{'docs_url'};
12742: $title = $args->{'docs_title'};
1.1126 raeburn 12743: $toplevel = $url;
12744: unless ($toplevel =~ m{^/}) {
12745: $toplevel = "/$url";
12746: }
1.1085 raeburn 12747: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12748: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12749: $path = $1;
12750: } else {
12751: ($path) =
12752: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12753: }
1.1195 raeburn 12754: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12755: $fileloc = $toplevel;
12756: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12757: my ($udom,$uname,$fname) =
12758: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12759: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12760: } else {
12761: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12762: }
1.1071 raeburn 12763: $fileloc =~ s{^/}{};
12764: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12765: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12766: }
1.987 raeburn 12767: }
1.1123 raeburn 12768: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12769: $udom = $cdom;
12770: $uname = $cnum;
12771: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12772: $toplevel = $url;
12773: $path = $url;
12774: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12775: $fileloc =~ s{^/}{};
1.987 raeburn 12776: }
1.1249 damieng 12777:
12778: # parses the dependency paths to get some info
12779: # fills $newfiles, $mapping, $subdependencies, $dependencies
12780: # $newfiles: hash URL -> 1 for new files or external URLs
12781: # (will be completed later)
12782: # $mapping:
12783: # for external URLs: external URL -> external URL
12784: # for relative paths: clean path -> original path
12785: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12786: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12787: foreach my $file (keys(%{$allfiles})) {
12788: my $embed_file;
12789: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12790: $embed_file = $1;
12791: } else {
12792: $embed_file = $file;
12793: }
1.1158 raeburn 12794: my ($absolutepath,$cleaned_file);
12795: if ($embed_file =~ m{^\w+://}) {
12796: $cleaned_file = $embed_file;
1.1147 raeburn 12797: $newfiles{$cleaned_file} = 1;
12798: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12799: } else {
1.1158 raeburn 12800: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12801: if ($embed_file =~ m{^/}) {
12802: $absolutepath = $embed_file;
12803: }
1.1147 raeburn 12804: if ($cleaned_file =~ m{/}) {
12805: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12806: $path = &check_for_traversal($path,$url,$toplevel);
12807: my $item = $fname;
12808: if ($path ne '') {
12809: $item = $path.'/'.$fname;
12810: $subdependencies{$path}{$fname} = 1;
12811: } else {
12812: $dependencies{$item} = 1;
12813: }
12814: if ($absolutepath) {
12815: $mapping{$item} = $absolutepath;
12816: } else {
12817: $mapping{$item} = $embed_file;
12818: }
12819: } else {
12820: $dependencies{$embed_file} = 1;
12821: if ($absolutepath) {
1.1147 raeburn 12822: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12823: } else {
1.1147 raeburn 12824: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12825: }
12826: }
1.984 raeburn 12827: }
12828: }
1.1249 damieng 12829:
12830: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12831: # and lists
12832: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12833: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12834: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12835: # the path had to be cleaned up
12836: # $existing: hash clean path -> 1 if the file exists
12837: # $numexisting: number of keys in $existing
12838: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12839: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12840: # dependency subdirectories that are
12841: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12842: my $dirptr = 16384;
1.984 raeburn 12843: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12844: $currsubfile{$path} = {};
1.1123 raeburn 12845: if (($actionurl eq '/adm/portfolio') ||
12846: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12847: my ($sublistref,$listerror) =
12848: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12849: if (ref($sublistref) eq 'ARRAY') {
12850: foreach my $line (@{$sublistref}) {
12851: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12852: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12853: }
1.984 raeburn 12854: }
1.987 raeburn 12855: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12856: if (opendir(my $dir,$url.'/'.$path)) {
12857: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12858: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12859: }
1.1084 raeburn 12860: } elsif (($actionurl eq '/adm/dependencies') ||
12861: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12862: ($args->{'context'} eq 'paste')) ||
12863: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12864: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12865: my $dir;
12866: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12867: $dir = $fileloc;
12868: } else {
12869: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12870: }
1.1071 raeburn 12871: if ($dir ne '') {
12872: my ($sublistref,$listerror) =
12873: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12874: if (ref($sublistref) eq 'ARRAY') {
12875: foreach my $line (@{$sublistref}) {
12876: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12877: undef,$mtime)=split(/\&/,$line,12);
12878: unless (($testdir&$dirptr) ||
12879: ($file_name =~ /^\.\.?$/)) {
12880: $currsubfile{$path}{$file_name} = [$size,$mtime];
12881: }
12882: }
12883: }
12884: }
1.984 raeburn 12885: }
12886: }
12887: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12888: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12889: my $item = $path.'/'.$file;
12890: unless ($mapping{$item} eq $item) {
12891: $pathchanges{$item} = 1;
12892: }
12893: $existing{$item} = 1;
12894: $numexisting ++;
12895: } else {
12896: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12897: }
12898: }
1.1071 raeburn 12899: if ($actionurl eq '/adm/dependencies') {
12900: foreach my $path (keys(%currsubfile)) {
12901: if (ref($currsubfile{$path}) eq 'HASH') {
12902: foreach my $file (keys(%{$currsubfile{$path}})) {
12903: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12904: next if (($rem ne '') &&
12905: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12906: (ref($navmap) &&
12907: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12908: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12909: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12910: $unused{$path.'/'.$file} = 1;
12911: }
12912: }
12913: }
12914: }
12915: }
1.984 raeburn 12916: }
1.1249 damieng 12917:
12918: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12919: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12920: my %currfile;
1.1123 raeburn 12921: if (($actionurl eq '/adm/portfolio') ||
12922: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12923: my ($dirlistref,$listerror) =
12924: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12925: if (ref($dirlistref) eq 'ARRAY') {
12926: foreach my $line (@{$dirlistref}) {
12927: my ($file_name,$rest) = split(/\&/,$line,2);
12928: $currfile{$file_name} = 1;
12929: }
1.984 raeburn 12930: }
1.987 raeburn 12931: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12932: if (opendir(my $dir,$url)) {
1.987 raeburn 12933: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12934: map {$currfile{$_} = 1;} @dir_list;
12935: }
1.1084 raeburn 12936: } elsif (($actionurl eq '/adm/dependencies') ||
12937: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12938: ($args->{'context'} eq 'paste')) ||
12939: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12940: if ($env{'request.course.id'} ne '') {
12941: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12942: if ($dir ne '') {
12943: my ($dirlistref,$listerror) =
12944: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12945: if (ref($dirlistref) eq 'ARRAY') {
12946: foreach my $line (@{$dirlistref}) {
12947: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12948: $size,undef,$mtime)=split(/\&/,$line,12);
12949: unless (($testdir&$dirptr) ||
12950: ($file_name =~ /^\.\.?$/)) {
12951: $currfile{$file_name} = [$size,$mtime];
12952: }
12953: }
12954: }
12955: }
12956: }
1.984 raeburn 12957: }
1.1249 damieng 12958: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12959: # are not in subdirectories, using $currfile
1.984 raeburn 12960: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12961: if (exists($currfile{$file})) {
1.987 raeburn 12962: unless ($mapping{$file} eq $file) {
12963: $pathchanges{$file} = 1;
12964: }
12965: $existing{$file} = 1;
12966: $numexisting ++;
12967: } else {
1.984 raeburn 12968: $newfiles{$file} = 1;
12969: }
12970: }
1.1071 raeburn 12971: foreach my $file (keys(%currfile)) {
12972: unless (($file eq $filename) ||
12973: ($file eq $filename.'.bak') ||
12974: ($dependencies{$file})) {
1.1085 raeburn 12975: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12976: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12977: next if (($rem ne '') &&
12978: (($env{"httpref.$rem".$file} ne '') ||
12979: (ref($navmap) &&
12980: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12981: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12982: ($navmap->getResourceByUrl($rem.$1)))))));
12983: }
1.1085 raeburn 12984: }
1.1071 raeburn 12985: $unused{$file} = 1;
12986: }
12987: }
1.1249 damieng 12988:
12989: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12990: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12991: ($args->{'context'} eq 'paste')) {
12992: $counter = scalar(keys(%existing));
12993: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12994: return ($output,$counter,$numpathchg,\%existing);
12995: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12996: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12997: $counter = scalar(keys(%existing));
12998: $numpathchg = scalar(keys(%pathchanges));
12999: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13000: }
1.1249 damieng 13001:
13002: # returns HTML otherwise, with dependency results and to ask for more uploads
13003:
13004: # $upload_output: missing dependencies (with upload form)
13005: # $modify_output: uploaded dependencies (in use)
13006: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13007: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13008: if ($actionurl eq '/adm/dependencies') {
13009: next if ($embed_file =~ m{^\w+://});
13010: }
1.660 raeburn 13011: $upload_output .= &start_data_table_row().
1.1123 raeburn 13012: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13013: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13014: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13015: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13016: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13017: }
1.1123 raeburn 13018: $upload_output .= '</td>';
1.1071 raeburn 13019: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13020: $upload_output.='<td align="right">'.
13021: '<span class="LC_info LC_fontsize_medium">'.
13022: &mt("URL points to web address").'</span>';
1.987 raeburn 13023: $numremref++;
1.660 raeburn 13024: } elsif ($args->{'error_on_invalid_names'}
13025: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13026: $upload_output.='<td align="right"><span class="LC_warning">'.
13027: &mt('Invalid characters').'</span>';
1.987 raeburn 13028: $numinvalid++;
1.660 raeburn 13029: } else {
1.1123 raeburn 13030: $upload_output .= '<td>'.
13031: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13032: $embed_file,\%mapping,
1.1071 raeburn 13033: $allfiles,$codebase,'upload');
13034: $counter ++;
13035: $numnew ++;
1.987 raeburn 13036: }
13037: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13038: }
13039: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13040: if ($actionurl eq '/adm/dependencies') {
13041: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13042: $modify_output .= &start_data_table_row().
13043: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13044: '<img src="'.&icon($embed_file).'" border="0" />'.
13045: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13046: '<td>'.$size.'</td>'.
13047: '<td>'.$mtime.'</td>'.
13048: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13049: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13050: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13051: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13052: &embedded_file_element('upload_embedded',$counter,
13053: $embed_file,\%mapping,
13054: $allfiles,$codebase,'modify').
13055: '</div></td>'.
13056: &end_data_table_row()."\n";
13057: $counter ++;
13058: } else {
13059: $upload_output .= &start_data_table_row().
1.1123 raeburn 13060: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13061: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13062: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13063: &Apache::loncommon::end_data_table_row()."\n";
13064: }
13065: }
13066: my $delidx = $counter;
13067: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13068: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13069: $delete_output .= &start_data_table_row().
13070: '<td><img src="'.&icon($oldfile).'" />'.
13071: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13072: '<td>'.$size.'</td>'.
13073: '<td>'.$mtime.'</td>'.
13074: '<td><label><input type="checkbox" name="del_upload_dep" '.
13075: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13076: &embedded_file_element('upload_embedded',$delidx,
13077: $oldfile,\%mapping,$allfiles,
13078: $codebase,'delete').'</td>'.
13079: &end_data_table_row()."\n";
13080: $numunused ++;
13081: $delidx ++;
1.987 raeburn 13082: }
13083: if ($upload_output) {
13084: $upload_output = &start_data_table().
13085: $upload_output.
13086: &end_data_table()."\n";
13087: }
1.1071 raeburn 13088: if ($modify_output) {
13089: $modify_output = &start_data_table().
13090: &start_data_table_header_row().
13091: '<th>'.&mt('File').'</th>'.
13092: '<th>'.&mt('Size (KB)').'</th>'.
13093: '<th>'.&mt('Modified').'</th>'.
13094: '<th>'.&mt('Upload replacement?').'</th>'.
13095: &end_data_table_header_row().
13096: $modify_output.
13097: &end_data_table()."\n";
13098: }
13099: if ($delete_output) {
13100: $delete_output = &start_data_table().
13101: &start_data_table_header_row().
13102: '<th>'.&mt('File').'</th>'.
13103: '<th>'.&mt('Size (KB)').'</th>'.
13104: '<th>'.&mt('Modified').'</th>'.
13105: '<th>'.&mt('Delete?').'</th>'.
13106: &end_data_table_header_row().
13107: $delete_output.
13108: &end_data_table()."\n";
13109: }
1.987 raeburn 13110: my $applies = 0;
13111: if ($numremref) {
13112: $applies ++;
13113: }
13114: if ($numinvalid) {
13115: $applies ++;
13116: }
13117: if ($numexisting) {
13118: $applies ++;
13119: }
1.1071 raeburn 13120: if ($counter || $numunused) {
1.987 raeburn 13121: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13122: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13123: $state.'<h3>'.$heading.'</h3>';
13124: if ($actionurl eq '/adm/dependencies') {
13125: if ($numnew) {
13126: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13127: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13128: $upload_output.'<br />'."\n";
13129: }
13130: if ($numexisting) {
13131: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13132: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13133: $modify_output.'<br />'."\n";
13134: $buttontext = &mt('Save changes');
13135: }
13136: if ($numunused) {
13137: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13138: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13139: $delete_output.'<br />'."\n";
13140: $buttontext = &mt('Save changes');
13141: }
13142: } else {
13143: $output .= $upload_output.'<br />'."\n";
13144: }
13145: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13146: $counter.'" />'."\n";
13147: if ($actionurl eq '/adm/dependencies') {
13148: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13149: $numnew.'" />'."\n";
13150: } elsif ($actionurl eq '') {
1.987 raeburn 13151: $output .= '<input type="hidden" name="phase" value="three" />';
13152: }
13153: } elsif ($applies) {
13154: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13155: if ($applies > 1) {
13156: $output .=
1.1123 raeburn 13157: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13158: if ($numremref) {
13159: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13160: }
13161: if ($numinvalid) {
13162: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13163: }
13164: if ($numexisting) {
13165: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13166: }
13167: $output .= '</ul><br />';
13168: } elsif ($numremref) {
13169: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13170: } elsif ($numinvalid) {
13171: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13172: } elsif ($numexisting) {
13173: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13174: }
13175: $output .= $upload_output.'<br />';
13176: }
13177: my ($pathchange_output,$chgcount);
1.1071 raeburn 13178: $chgcount = $counter;
1.987 raeburn 13179: if (keys(%pathchanges) > 0) {
13180: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13181: if ($counter) {
1.987 raeburn 13182: $output .= &embedded_file_element('pathchange',$chgcount,
13183: $embed_file,\%mapping,
1.1071 raeburn 13184: $allfiles,$codebase,'change');
1.987 raeburn 13185: } else {
13186: $pathchange_output .=
13187: &start_data_table_row().
13188: '<td><input type ="checkbox" name="namechange" value="'.
13189: $chgcount.'" checked="checked" /></td>'.
13190: '<td>'.$mapping{$embed_file}.'</td>'.
13191: '<td>'.$embed_file.
13192: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13193: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13194: '</td>'.&end_data_table_row();
1.660 raeburn 13195: }
1.987 raeburn 13196: $numpathchg ++;
13197: $chgcount ++;
1.660 raeburn 13198: }
13199: }
1.1127 raeburn 13200: if (($counter) || ($numunused)) {
1.987 raeburn 13201: if ($numpathchg) {
13202: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13203: $numpathchg.'" />'."\n";
13204: }
13205: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13206: ($actionurl eq '/adm/imsimport')) {
13207: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13208: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13209: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13210: } elsif ($actionurl eq '/adm/dependencies') {
13211: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13212: }
1.1123 raeburn 13213: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13214: } elsif ($numpathchg) {
13215: my %pathchange = ();
13216: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13217: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13218: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13219: }
1.987 raeburn 13220: }
1.1071 raeburn 13221: return ($output,$counter,$numpathchg);
1.987 raeburn 13222: }
13223:
1.1147 raeburn 13224: =pod
13225:
13226: =item * clean_path($name)
13227:
13228: Performs clean-up of directories, subdirectories and filename in an
13229: embedded object, referenced in an HTML file which is being uploaded
13230: to a course or portfolio, where
13231: "Upload embedded images/multimedia files if HTML file" checkbox was
13232: checked.
13233:
13234: Clean-up is similar to replacements in lonnet::clean_filename()
13235: except each / between sub-directory and next level is preserved.
13236:
13237: =cut
13238:
13239: sub clean_path {
13240: my ($embed_file) = @_;
13241: $embed_file =~s{^/+}{};
13242: my @contents;
13243: if ($embed_file =~ m{/}) {
13244: @contents = split(/\//,$embed_file);
13245: } else {
13246: @contents = ($embed_file);
13247: }
13248: my $lastidx = scalar(@contents)-1;
13249: for (my $i=0; $i<=$lastidx; $i++) {
13250: $contents[$i]=~s{\\}{/}g;
13251: $contents[$i]=~s/\s+/\_/g;
13252: $contents[$i]=~s{[^/\w\.\-]}{}g;
13253: if ($i == $lastidx) {
13254: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13255: }
13256: }
13257: if ($lastidx > 0) {
13258: return join('/',@contents);
13259: } else {
13260: return $contents[0];
13261: }
13262: }
13263:
1.987 raeburn 13264: sub embedded_file_element {
1.1071 raeburn 13265: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13266: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13267: (ref($codebase) eq 'HASH'));
13268: my $output;
1.1071 raeburn 13269: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13270: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13271: }
13272: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13273: &escape($embed_file).'" />';
13274: unless (($context eq 'upload_embedded') &&
13275: ($mapping->{$embed_file} eq $embed_file)) {
13276: $output .='
13277: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13278: }
13279: my $attrib;
13280: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13281: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13282: }
13283: $output .=
13284: "\n\t\t".
13285: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13286: $attrib.'" />';
13287: if (exists($codebase->{$mapping->{$embed_file}})) {
13288: $output .=
13289: "\n\t\t".
13290: '<input name="codebase_'.$num.'" type="hidden" value="'.
13291: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13292: }
1.987 raeburn 13293: return $output;
1.660 raeburn 13294: }
13295:
1.1071 raeburn 13296: sub get_dependency_details {
13297: my ($currfile,$currsubfile,$embed_file) = @_;
13298: my ($size,$mtime,$showsize,$showmtime);
13299: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13300: if ($embed_file =~ m{/}) {
13301: my ($path,$fname) = split(/\//,$embed_file);
13302: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13303: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13304: }
13305: } else {
13306: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13307: ($size,$mtime) = @{$currfile->{$embed_file}};
13308: }
13309: }
13310: $showsize = $size/1024.0;
13311: $showsize = sprintf("%.1f",$showsize);
13312: if ($mtime > 0) {
13313: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13314: }
13315: }
13316: return ($showsize,$showmtime);
13317: }
13318:
13319: sub ask_embedded_js {
13320: return <<"END";
13321: <script type="text/javascript"">
13322: // <![CDATA[
13323: function toggleBrowse(counter) {
13324: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13325: var fileid = document.getElementById('embedded_item_'+counter);
13326: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13327: if (chkboxid.checked == true) {
13328: uploaddivid.style.display='block';
13329: } else {
13330: uploaddivid.style.display='none';
13331: fileid.value = '';
13332: }
13333: }
13334: // ]]>
13335: </script>
13336:
13337: END
13338: }
13339:
1.661 raeburn 13340: sub upload_embedded {
13341: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13342: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13343: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13344: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13345: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13346: my $orig_uploaded_filename =
13347: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13348: foreach my $type ('orig','ref','attrib','codebase') {
13349: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13350: $env{'form.embedded_'.$type.'_'.$i} =
13351: &unescape($env{'form.embedded_'.$type.'_'.$i});
13352: }
13353: }
1.661 raeburn 13354: my ($path,$fname) =
13355: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13356: # no path, whole string is fname
13357: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13358: $fname = &Apache::lonnet::clean_filename($fname);
13359: # See if there is anything left
13360: next if ($fname eq '');
13361:
13362: # Check if file already exists as a file or directory.
13363: my ($state,$msg);
13364: if ($context eq 'portfolio') {
13365: my $port_path = $dirpath;
13366: if ($group ne '') {
13367: $port_path = "groups/$group/$port_path";
13368: }
1.987 raeburn 13369: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13370: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13371: $dir_root,$port_path,$disk_quota,
13372: $current_disk_usage,$uname,$udom);
13373: if ($state eq 'will_exceed_quota'
1.984 raeburn 13374: || $state eq 'file_locked') {
1.661 raeburn 13375: $output .= $msg;
13376: next;
13377: }
13378: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13379: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13380: if ($state eq 'exists') {
13381: $output .= $msg;
13382: next;
13383: }
13384: }
13385: # Check if extension is valid
13386: if (($fname =~ /\.(\w+)$/) &&
13387: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13388: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13389: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13390: next;
13391: } elsif (($fname =~ /\.(\w+)$/) &&
13392: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13393: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13394: next;
13395: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13396: $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 13397: next;
13398: }
13399: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13400: my $subdir = $path;
13401: $subdir =~ s{/+$}{};
1.661 raeburn 13402: if ($context eq 'portfolio') {
1.984 raeburn 13403: my $result;
13404: if ($state eq 'existingfile') {
13405: $result=
13406: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13407: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13408: } else {
1.984 raeburn 13409: $result=
13410: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13411: $dirpath.
1.1123 raeburn 13412: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13413: if ($result !~ m|^/uploaded/|) {
13414: $output .= '<span class="LC_error">'
13415: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13416: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13417: .'</span><br />';
13418: next;
13419: } else {
1.987 raeburn 13420: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13421: $path.$fname.'</span>').'<br />';
1.984 raeburn 13422: }
1.661 raeburn 13423: }
1.1123 raeburn 13424: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13425: my $extendedsubdir = $dirpath.'/'.$subdir;
13426: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13427: my $result =
1.1126 raeburn 13428: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13429: if ($result !~ m|^/uploaded/|) {
13430: $output .= '<span class="LC_error">'
13431: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13432: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13433: .'</span><br />';
13434: next;
13435: } else {
13436: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13437: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13438: if ($context eq 'syllabus') {
13439: &Apache::lonnet::make_public_indefinitely($result);
13440: }
1.987 raeburn 13441: }
1.661 raeburn 13442: } else {
13443: # Save the file
13444: my $target = $env{'form.embedded_item_'.$i};
13445: my $fullpath = $dir_root.$dirpath.'/'.$path;
13446: my $dest = $fullpath.$fname;
13447: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13448: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13449: my $count;
13450: my $filepath = $dir_root;
1.1027 raeburn 13451: foreach my $subdir (@parts) {
13452: $filepath .= "/$subdir";
13453: if (!-e $filepath) {
1.661 raeburn 13454: mkdir($filepath,0770);
13455: }
13456: }
13457: my $fh;
13458: if (!open($fh,'>'.$dest)) {
13459: &Apache::lonnet::logthis('Failed to create '.$dest);
13460: $output .= '<span class="LC_error">'.
1.1071 raeburn 13461: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13462: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13463: '</span><br />';
13464: } else {
13465: if (!print $fh $env{'form.embedded_item_'.$i}) {
13466: &Apache::lonnet::logthis('Failed to write to '.$dest);
13467: $output .= '<span class="LC_error">'.
1.1071 raeburn 13468: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13469: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13470: '</span><br />';
13471: } else {
1.987 raeburn 13472: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13473: $url.'</span>').'<br />';
13474: unless ($context eq 'testbank') {
13475: $footer .= &mt('View embedded file: [_1]',
13476: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13477: }
13478: }
13479: close($fh);
13480: }
13481: }
13482: if ($env{'form.embedded_ref_'.$i}) {
13483: $pathchange{$i} = 1;
13484: }
13485: }
13486: if ($output) {
13487: $output = '<p>'.$output.'</p>';
13488: }
13489: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13490: $returnflag = 'ok';
1.1071 raeburn 13491: my $numpathchgs = scalar(keys(%pathchange));
13492: if ($numpathchgs > 0) {
1.987 raeburn 13493: if ($context eq 'portfolio') {
13494: $output .= '<p>'.&mt('or').'</p>';
13495: } elsif ($context eq 'testbank') {
1.1071 raeburn 13496: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13497: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13498: $returnflag = 'modify_orightml';
13499: }
13500: }
1.1071 raeburn 13501: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13502: }
13503:
13504: sub modify_html_form {
13505: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13506: my $end = 0;
13507: my $modifyform;
13508: if ($context eq 'upload_embedded') {
13509: return unless (ref($pathchange) eq 'HASH');
13510: if ($env{'form.number_embedded_items'}) {
13511: $end += $env{'form.number_embedded_items'};
13512: }
13513: if ($env{'form.number_pathchange_items'}) {
13514: $end += $env{'form.number_pathchange_items'};
13515: }
13516: if ($end) {
13517: for (my $i=0; $i<$end; $i++) {
13518: if ($i < $env{'form.number_embedded_items'}) {
13519: next unless($pathchange->{$i});
13520: }
13521: $modifyform .=
13522: &start_data_table_row().
13523: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13524: 'checked="checked" /></td>'.
13525: '<td>'.$env{'form.embedded_ref_'.$i}.
13526: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13527: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13528: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13529: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13530: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13531: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13532: '<td>'.$env{'form.embedded_orig_'.$i}.
13533: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13534: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13535: &end_data_table_row();
1.1071 raeburn 13536: }
1.987 raeburn 13537: }
13538: } else {
13539: $modifyform = $pathchgtable;
13540: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13541: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13542: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13543: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13544: }
13545: }
13546: if ($modifyform) {
1.1071 raeburn 13547: if ($actionurl eq '/adm/dependencies') {
13548: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13549: }
1.987 raeburn 13550: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13551: '<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".
13552: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13553: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13554: '</ol></p>'."\n".'<p>'.
13555: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13556: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13557: &start_data_table()."\n".
13558: &start_data_table_header_row().
13559: '<th>'.&mt('Change?').'</th>'.
13560: '<th>'.&mt('Current reference').'</th>'.
13561: '<th>'.&mt('Required reference').'</th>'.
13562: &end_data_table_header_row()."\n".
13563: $modifyform.
13564: &end_data_table().'<br />'."\n".$hiddenstate.
13565: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13566: '</form>'."\n";
13567: }
13568: return;
13569: }
13570:
13571: sub modify_html_refs {
1.1123 raeburn 13572: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13573: my $container;
13574: if ($context eq 'portfolio') {
13575: $container = $env{'form.container'};
13576: } elsif ($context eq 'coursedoc') {
13577: $container = $env{'form.primaryurl'};
1.1071 raeburn 13578: } elsif ($context eq 'manage_dependencies') {
13579: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13580: $container = "/$container";
1.1123 raeburn 13581: } elsif ($context eq 'syllabus') {
13582: $container = $url;
1.987 raeburn 13583: } else {
1.1027 raeburn 13584: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13585: }
13586: my (%allfiles,%codebase,$output,$content);
13587: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13588: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13589: if (wantarray) {
13590: return ('',0,0);
13591: } else {
13592: return;
13593: }
13594: }
13595: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13596: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13597: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13598: if (wantarray) {
13599: return ('',0,0);
13600: } else {
13601: return;
13602: }
13603: }
1.987 raeburn 13604: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13605: if ($content eq '-1') {
13606: if (wantarray) {
13607: return ('',0,0);
13608: } else {
13609: return;
13610: }
13611: }
1.987 raeburn 13612: } else {
1.1071 raeburn 13613: unless ($container =~ /^\Q$dir_root\E/) {
13614: if (wantarray) {
13615: return ('',0,0);
13616: } else {
13617: return;
13618: }
13619: }
1.1317 raeburn 13620: if (open(my $fh,'<',$container)) {
1.987 raeburn 13621: $content = join('', <$fh>);
13622: close($fh);
13623: } else {
1.1071 raeburn 13624: if (wantarray) {
13625: return ('',0,0);
13626: } else {
13627: return;
13628: }
1.987 raeburn 13629: }
13630: }
13631: my ($count,$codebasecount) = (0,0);
13632: my $mm = new File::MMagic;
13633: my $mime_type = $mm->checktype_contents($content);
13634: if ($mime_type eq 'text/html') {
13635: my $parse_result =
13636: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13637: \%codebase,\$content);
13638: if ($parse_result eq 'ok') {
13639: foreach my $i (@changes) {
13640: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13641: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13642: if ($allfiles{$ref}) {
13643: my $newname = $orig;
13644: my ($attrib_regexp,$codebase);
1.1006 raeburn 13645: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13646: if ($attrib_regexp =~ /:/) {
13647: $attrib_regexp =~ s/\:/|/g;
13648: }
13649: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13650: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13651: $count += $numchg;
1.1123 raeburn 13652: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13653: delete($allfiles{$ref});
1.987 raeburn 13654: }
13655: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13656: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13657: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13658: $codebasecount ++;
13659: }
13660: }
13661: }
1.1123 raeburn 13662: my $skiprewrites;
1.987 raeburn 13663: if ($count || $codebasecount) {
13664: my $saveresult;
1.1071 raeburn 13665: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13666: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13667: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13668: if ($url eq $container) {
13669: my ($fname) = ($container =~ m{/([^/]+)$});
13670: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13671: $count,'<span class="LC_filename">'.
1.1071 raeburn 13672: $fname.'</span>').'</p>';
1.987 raeburn 13673: } else {
13674: $output = '<p class="LC_error">'.
13675: &mt('Error: update failed for: [_1].',
13676: '<span class="LC_filename">'.
13677: $container.'</span>').'</p>';
13678: }
1.1123 raeburn 13679: if ($context eq 'syllabus') {
13680: unless ($saveresult eq 'ok') {
13681: $skiprewrites = 1;
13682: }
13683: }
1.987 raeburn 13684: } else {
1.1317 raeburn 13685: if (open(my $fh,'>',$container)) {
1.987 raeburn 13686: print $fh $content;
13687: close($fh);
13688: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13689: $count,'<span class="LC_filename">'.
13690: $container.'</span>').'</p>';
1.661 raeburn 13691: } else {
1.987 raeburn 13692: $output = '<p class="LC_error">'.
13693: &mt('Error: could not update [_1].',
13694: '<span class="LC_filename">'.
13695: $container.'</span>').'</p>';
1.661 raeburn 13696: }
13697: }
13698: }
1.1123 raeburn 13699: if (($context eq 'syllabus') && (!$skiprewrites)) {
13700: my ($actionurl,$state);
13701: $actionurl = "/public/$udom/$uname/syllabus";
13702: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13703: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13704: \%codebase,
13705: {'context' => 'rewrites',
13706: 'ignore_remote_references' => 1,});
13707: if (ref($mapping) eq 'HASH') {
13708: my $rewrites = 0;
13709: foreach my $key (keys(%{$mapping})) {
13710: next if ($key =~ m{^https?://});
13711: my $ref = $mapping->{$key};
13712: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13713: my $attrib;
13714: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13715: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13716: }
13717: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13718: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13719: $rewrites += $numchg;
13720: }
13721: }
13722: if ($rewrites) {
13723: my $saveresult;
13724: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13725: if ($url eq $container) {
13726: my ($fname) = ($container =~ m{/([^/]+)$});
13727: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13728: $count,'<span class="LC_filename">'.
13729: $fname.'</span>').'</p>';
13730: } else {
13731: $output .= '<p class="LC_error">'.
13732: &mt('Error: could not update links in [_1].',
13733: '<span class="LC_filename">'.
13734: $container.'</span>').'</p>';
13735:
13736: }
13737: }
13738: }
13739: }
1.987 raeburn 13740: } else {
13741: &logthis('Failed to parse '.$container.
13742: ' to modify references: '.$parse_result);
1.661 raeburn 13743: }
13744: }
1.1071 raeburn 13745: if (wantarray) {
13746: return ($output,$count,$codebasecount);
13747: } else {
13748: return $output;
13749: }
1.661 raeburn 13750: }
13751:
13752: sub check_for_existing {
13753: my ($path,$fname,$element) = @_;
13754: my ($state,$msg);
13755: if (-d $path.'/'.$fname) {
13756: $state = 'exists';
13757: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13758: } elsif (-e $path.'/'.$fname) {
13759: $state = 'exists';
13760: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13761: }
13762: if ($state eq 'exists') {
13763: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13764: }
13765: return ($state,$msg);
13766: }
13767:
13768: sub check_for_upload {
13769: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13770: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13771: my $filesize = length($env{'form.'.$element});
13772: if (!$filesize) {
13773: my $msg = '<span class="LC_error">'.
13774: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13775: '<span class="LC_filename">'.$fname.'</span>',
13776: $filesize).'<br />'.
1.1007 raeburn 13777: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13778: '</span>';
13779: return ('zero_bytes',$msg);
13780: }
13781: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13782: my $getpropath = 1;
1.1021 raeburn 13783: my ($dirlistref,$listerror) =
13784: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13785: my $found_file = 0;
13786: my $locked_file = 0;
1.991 raeburn 13787: my @lockers;
13788: my $navmap;
13789: if ($env{'request.course.id'}) {
13790: $navmap = Apache::lonnavmaps::navmap->new();
13791: }
1.1021 raeburn 13792: if (ref($dirlistref) eq 'ARRAY') {
13793: foreach my $line (@{$dirlistref}) {
13794: my ($file_name,$rest)=split(/\&/,$line,2);
13795: if ($file_name eq $fname){
13796: $file_name = $path.$file_name;
13797: if ($group ne '') {
13798: $file_name = $group.$file_name;
13799: }
13800: $found_file = 1;
13801: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13802: foreach my $lock (@lockers) {
13803: if (ref($lock) eq 'ARRAY') {
13804: my ($symb,$crsid) = @{$lock};
13805: if ($crsid eq $env{'request.course.id'}) {
13806: if (ref($navmap)) {
13807: my $res = $navmap->getBySymb($symb);
13808: foreach my $part (@{$res->parts()}) {
13809: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13810: unless (($slot_status == $res->RESERVED) ||
13811: ($slot_status == $res->RESERVED_LOCATION)) {
13812: $locked_file = 1;
13813: }
1.991 raeburn 13814: }
1.1021 raeburn 13815: } else {
13816: $locked_file = 1;
1.991 raeburn 13817: }
13818: } else {
13819: $locked_file = 1;
13820: }
13821: }
1.1021 raeburn 13822: }
13823: } else {
13824: my @info = split(/\&/,$rest);
13825: my $currsize = $info[6]/1000;
13826: if ($currsize < $filesize) {
13827: my $extra = $filesize - $currsize;
13828: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13829: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13830: &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 13831: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13832: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13833: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13834: return ('will_exceed_quota',$msg);
13835: }
1.984 raeburn 13836: }
13837: }
1.661 raeburn 13838: }
13839: }
13840: }
13841: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13842: my $msg = '<p class="LC_warning">'.
13843: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13844: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13845: return ('will_exceed_quota',$msg);
13846: } elsif ($found_file) {
13847: if ($locked_file) {
1.1179 bisitz 13848: my $msg = '<p class="LC_warning">';
1.661 raeburn 13849: $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 13850: $msg .= '</p>';
1.661 raeburn 13851: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13852: return ('file_locked',$msg);
13853: } else {
1.1179 bisitz 13854: my $msg = '<p class="LC_error">';
1.984 raeburn 13855: $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 13856: $msg .= '</p>';
1.984 raeburn 13857: return ('existingfile',$msg);
1.661 raeburn 13858: }
13859: }
13860: }
13861:
1.987 raeburn 13862: sub check_for_traversal {
13863: my ($path,$url,$toplevel) = @_;
13864: my @parts=split(/\//,$path);
13865: my $cleanpath;
13866: my $fullpath = $url;
13867: for (my $i=0;$i<@parts;$i++) {
13868: next if ($parts[$i] eq '.');
13869: if ($parts[$i] eq '..') {
13870: $fullpath =~ s{([^/]+/)$}{};
13871: } else {
13872: $fullpath .= $parts[$i].'/';
13873: }
13874: }
13875: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13876: $cleanpath = $1;
13877: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13878: my $curr_toprel = $1;
13879: my @parts = split(/\//,$curr_toprel);
13880: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13881: my @urlparts = split(/\//,$url_toprel);
13882: my $doubledots;
13883: my $startdiff = -1;
13884: for (my $i=0; $i<@urlparts; $i++) {
13885: if ($startdiff == -1) {
13886: unless ($urlparts[$i] eq $parts[$i]) {
13887: $startdiff = $i;
13888: $doubledots .= '../';
13889: }
13890: } else {
13891: $doubledots .= '../';
13892: }
13893: }
13894: if ($startdiff > -1) {
13895: $cleanpath = $doubledots;
13896: for (my $i=$startdiff; $i<@parts; $i++) {
13897: $cleanpath .= $parts[$i].'/';
13898: }
13899: }
13900: }
13901: $cleanpath =~ s{(/)$}{};
13902: return $cleanpath;
13903: }
1.31 albertel 13904:
1.1053 raeburn 13905: sub is_archive_file {
13906: my ($mimetype) = @_;
13907: if (($mimetype eq 'application/octet-stream') ||
13908: ($mimetype eq 'application/x-stuffit') ||
13909: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13910: return 1;
13911: }
13912: return;
13913: }
13914:
13915: sub decompress_form {
1.1065 raeburn 13916: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13917: my %lt = &Apache::lonlocal::texthash (
13918: this => 'This file is an archive file.',
1.1067 raeburn 13919: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13920: itsc => 'Its contents are as follows:',
1.1053 raeburn 13921: youm => 'You may wish to extract its contents.',
13922: extr => 'Extract contents',
1.1067 raeburn 13923: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13924: proa => 'Process automatically?',
1.1053 raeburn 13925: yes => 'Yes',
13926: no => 'No',
1.1067 raeburn 13927: fold => 'Title for folder containing movie',
13928: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13929: );
1.1065 raeburn 13930: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13931: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13932: my $info = &list_archive_contents($fileloc,\@paths);
13933: if (@paths) {
13934: foreach my $path (@paths) {
13935: $path =~ s{^/}{};
1.1067 raeburn 13936: if ($path =~ m{^([^/]+)/$}) {
13937: $topdir = $1;
13938: }
1.1065 raeburn 13939: if ($path =~ m{^([^/]+)/}) {
13940: $toplevel{$1} = $path;
13941: } else {
13942: $toplevel{$path} = $path;
13943: }
13944: }
13945: }
1.1067 raeburn 13946: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13947: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13948: "$topdir/media/",
13949: "$topdir/media/$topdir.mp4",
13950: "$topdir/media/FirstFrame.png",
13951: "$topdir/media/player.swf",
13952: "$topdir/media/swfobject.js",
13953: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13954: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13955: "$topdir/$topdir.mp4",
13956: "$topdir/$topdir\_config.xml",
13957: "$topdir/$topdir\_controller.swf",
13958: "$topdir/$topdir\_embed.css",
13959: "$topdir/$topdir\_First_Frame.png",
13960: "$topdir/$topdir\_player.html",
13961: "$topdir/$topdir\_Thumbnails.png",
13962: "$topdir/playerProductInstall.swf",
13963: "$topdir/scripts/",
13964: "$topdir/scripts/config_xml.js",
13965: "$topdir/scripts/handlebars.js",
13966: "$topdir/scripts/jquery-1.7.1.min.js",
13967: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13968: "$topdir/scripts/modernizr.js",
13969: "$topdir/scripts/player-min.js",
13970: "$topdir/scripts/swfobject.js",
13971: "$topdir/skins/",
13972: "$topdir/skins/configuration_express.xml",
13973: "$topdir/skins/express_show/",
13974: "$topdir/skins/express_show/player-min.css",
13975: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13976: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13977: "$topdir/$topdir.mp4",
13978: "$topdir/$topdir\_config.xml",
13979: "$topdir/$topdir\_controller.swf",
13980: "$topdir/$topdir\_embed.css",
13981: "$topdir/$topdir\_First_Frame.png",
13982: "$topdir/$topdir\_player.html",
13983: "$topdir/$topdir\_Thumbnails.png",
13984: "$topdir/playerProductInstall.swf",
13985: "$topdir/scripts/",
13986: "$topdir/scripts/config_xml.js",
13987: "$topdir/scripts/techsmith-smart-player.min.js",
13988: "$topdir/skins/",
13989: "$topdir/skins/configuration_express.xml",
13990: "$topdir/skins/express_show/",
13991: "$topdir/skins/express_show/spritesheet.min.css",
13992: "$topdir/skins/express_show/spritesheet.png",
13993: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13994: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13995: if (@diffs == 0) {
1.1164 raeburn 13996: $is_camtasia = 6;
13997: } else {
1.1197 raeburn 13998: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13999: if (@diffs == 0) {
14000: $is_camtasia = 8;
1.1197 raeburn 14001: } else {
14002: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14003: if (@diffs == 0) {
14004: $is_camtasia = 8;
14005: }
1.1164 raeburn 14006: }
1.1067 raeburn 14007: }
14008: }
14009: my $output;
14010: if ($is_camtasia) {
14011: $output = <<"ENDCAM";
14012: <script type="text/javascript" language="Javascript">
14013: // <![CDATA[
14014:
14015: function camtasiaToggle() {
14016: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14017: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14018: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14019: document.getElementById('camtasia_titles').style.display='block';
14020: } else {
14021: document.getElementById('camtasia_titles').style.display='none';
14022: }
14023: }
14024: }
14025: return;
14026: }
14027:
14028: // ]]>
14029: </script>
14030: <p>$lt{'camt'}</p>
14031: ENDCAM
1.1065 raeburn 14032: } else {
1.1067 raeburn 14033: $output = '<p>'.$lt{'this'};
14034: if ($info eq '') {
14035: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14036: } else {
14037: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14038: '<div><pre>'.$info.'</pre></div>';
14039: }
1.1065 raeburn 14040: }
1.1067 raeburn 14041: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14042: my $duplicates;
14043: my $num = 0;
14044: if (ref($dirlist) eq 'ARRAY') {
14045: foreach my $item (@{$dirlist}) {
14046: if (ref($item) eq 'ARRAY') {
14047: if (exists($toplevel{$item->[0]})) {
14048: $duplicates .=
14049: &start_data_table_row().
14050: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14051: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14052: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14053: 'value="1" />'.&mt('Yes').'</label>'.
14054: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14055: '<td>'.$item->[0].'</td>';
14056: if ($item->[2]) {
14057: $duplicates .= '<td>'.&mt('Directory').'</td>';
14058: } else {
14059: $duplicates .= '<td>'.&mt('File').'</td>';
14060: }
14061: $duplicates .= '<td>'.$item->[3].'</td>'.
14062: '<td>'.
14063: &Apache::lonlocal::locallocaltime($item->[4]).
14064: '</td>'.
14065: &end_data_table_row();
14066: $num ++;
14067: }
14068: }
14069: }
14070: }
14071: my $itemcount;
14072: if (@paths > 0) {
14073: $itemcount = scalar(@paths);
14074: } else {
14075: $itemcount = 1;
14076: }
1.1067 raeburn 14077: if ($is_camtasia) {
14078: $output .= $lt{'auto'}.'<br />'.
14079: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14080: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14081: $lt{'yes'}.'</label> <label>'.
14082: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14083: $lt{'no'}.'</label></span><br />'.
14084: '<div id="camtasia_titles" style="display:block">'.
14085: &Apache::lonhtmlcommon::start_pick_box().
14086: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14087: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14088: &Apache::lonhtmlcommon::row_closure().
14089: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14090: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14091: &Apache::lonhtmlcommon::row_closure(1).
14092: &Apache::lonhtmlcommon::end_pick_box().
14093: '</div>';
14094: }
1.1065 raeburn 14095: $output .=
14096: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14097: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14098: "\n";
1.1065 raeburn 14099: if ($duplicates ne '') {
14100: $output .= '<p><span class="LC_warning">'.
14101: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14102: &start_data_table().
14103: &start_data_table_header_row().
14104: '<th>'.&mt('Overwrite?').'</th>'.
14105: '<th>'.&mt('Name').'</th>'.
14106: '<th>'.&mt('Type').'</th>'.
14107: '<th>'.&mt('Size').'</th>'.
14108: '<th>'.&mt('Last modified').'</th>'.
14109: &end_data_table_header_row().
14110: $duplicates.
14111: &end_data_table().
14112: '</p>';
14113: }
1.1067 raeburn 14114: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14115: if (ref($hiddenelements) eq 'HASH') {
14116: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14117: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14118: }
14119: }
14120: $output .= <<"END";
1.1067 raeburn 14121: <br />
1.1053 raeburn 14122: <input type="submit" name="decompress" value="$lt{'extr'}" />
14123: </form>
14124: $noextract
14125: END
14126: return $output;
14127: }
14128:
1.1065 raeburn 14129: sub decompression_utility {
14130: my ($program) = @_;
14131: my @utilities = ('tar','gunzip','bunzip2','unzip');
14132: my $location;
14133: if (grep(/^\Q$program\E$/,@utilities)) {
14134: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14135: '/usr/sbin/') {
14136: if (-x $dir.$program) {
14137: $location = $dir.$program;
14138: last;
14139: }
14140: }
14141: }
14142: return $location;
14143: }
14144:
14145: sub list_archive_contents {
14146: my ($file,$pathsref) = @_;
14147: my (@cmd,$output);
14148: my $needsregexp;
14149: if ($file =~ /\.zip$/) {
14150: @cmd = (&decompression_utility('unzip'),"-l");
14151: $needsregexp = 1;
14152: } elsif (($file =~ m/\.tar\.gz$/) ||
14153: ($file =~ /\.tgz$/)) {
14154: @cmd = (&decompression_utility('tar'),"-ztf");
14155: } elsif ($file =~ /\.tar\.bz2$/) {
14156: @cmd = (&decompression_utility('tar'),"-jtf");
14157: } elsif ($file =~ m|\.tar$|) {
14158: @cmd = (&decompression_utility('tar'),"-tf");
14159: }
14160: if (@cmd) {
14161: undef($!);
14162: undef($@);
14163: if (open(my $fh,"-|", @cmd, $file)) {
14164: while (my $line = <$fh>) {
14165: $output .= $line;
14166: chomp($line);
14167: my $item;
14168: if ($needsregexp) {
14169: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14170: } else {
14171: $item = $line;
14172: }
14173: if ($item ne '') {
14174: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14175: push(@{$pathsref},$item);
14176: }
14177: }
14178: }
14179: close($fh);
14180: }
14181: }
14182: return $output;
14183: }
14184:
1.1053 raeburn 14185: sub decompress_uploaded_file {
14186: my ($file,$dir) = @_;
14187: &Apache::lonnet::appenv({'cgi.file' => $file});
14188: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14189: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14190: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14191: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14192: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14193: my $decompressed = $env{'cgi.decompressed'};
14194: &Apache::lonnet::delenv('cgi.file');
14195: &Apache::lonnet::delenv('cgi.dir');
14196: &Apache::lonnet::delenv('cgi.decompressed');
14197: return ($decompressed,$result);
14198: }
14199:
1.1055 raeburn 14200: sub process_decompression {
14201: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14202: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14203: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14204: &mt('Unexpected file path.').'</p>'."\n";
14205: }
14206: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14207: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14208: &mt('Unexpected course context.').'</p>'."\n";
14209: }
1.1293 raeburn 14210: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14211: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14212: &mt('Filename contained unexpected characters.').'</p>'."\n";
14213: }
1.1055 raeburn 14214: my ($dir,$error,$warning,$output);
1.1180 raeburn 14215: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14216: $error = &mt('Filename not a supported archive file type.').
14217: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14218: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14219: } else {
14220: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14221: if ($docuhome eq 'no_host') {
14222: $error = &mt('Could not determine home server for course.');
14223: } else {
14224: my @ids=&Apache::lonnet::current_machine_ids();
14225: my $currdir = "$dir_root/$destination";
14226: if (grep(/^\Q$docuhome\E$/,@ids)) {
14227: $dir = &LONCAPA::propath($docudom,$docuname).
14228: "$dir_root/$destination";
14229: } else {
14230: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14231: "$dir_root/$docudom/$docuname/$destination";
14232: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14233: $error = &mt('Archive file not found.');
14234: }
14235: }
1.1065 raeburn 14236: my (@to_overwrite,@to_skip);
14237: if ($env{'form.archive_overwrite_total'} > 0) {
14238: my $total = $env{'form.archive_overwrite_total'};
14239: for (my $i=0; $i<$total; $i++) {
14240: if ($env{'form.archive_overwrite_'.$i} == 1) {
14241: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14242: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14243: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14244: }
14245: }
14246: }
14247: my $numskip = scalar(@to_skip);
1.1292 raeburn 14248: my $numoverwrite = scalar(@to_overwrite);
14249: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14250: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14251: } elsif ($dir eq '') {
1.1055 raeburn 14252: $error = &mt('Directory containing archive file unavailable.');
14253: } elsif (!$error) {
1.1065 raeburn 14254: my ($decompressed,$display);
1.1292 raeburn 14255: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14256: my $tempdir = time.'_'.$$.int(rand(10000));
14257: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14258: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14259: ($decompressed,$display) =
14260: &decompress_uploaded_file($file,"$dir/$tempdir");
14261: foreach my $item (@to_skip) {
14262: if (($item ne '') && ($item !~ /\.\./)) {
14263: if (-f "$dir/$tempdir/$item") {
14264: unlink("$dir/$tempdir/$item");
14265: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14266: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14267: }
14268: }
14269: }
14270: foreach my $item (@to_overwrite) {
14271: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14272: if (($item ne '') && ($item !~ /\.\./)) {
14273: if (-f "$dir/$item") {
14274: unlink("$dir/$item");
14275: } elsif (-d "$dir/$item") {
1.1300 raeburn 14276: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14277: }
14278: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14279: }
1.1065 raeburn 14280: }
14281: }
1.1292 raeburn 14282: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14283: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14284: }
1.1065 raeburn 14285: }
14286: } else {
14287: ($decompressed,$display) =
14288: &decompress_uploaded_file($file,$dir);
14289: }
1.1055 raeburn 14290: if ($decompressed eq 'ok') {
1.1065 raeburn 14291: $output = '<p class="LC_info">'.
14292: &mt('Files extracted successfully from archive.').
14293: '</p>'."\n";
1.1055 raeburn 14294: my ($warning,$result,@contents);
14295: my ($newdirlistref,$newlisterror) =
14296: &Apache::lonnet::dirlist($currdir,$docudom,
14297: $docuname,1);
14298: my (%is_dir,%changes,@newitems);
14299: my $dirptr = 16384;
1.1065 raeburn 14300: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14301: foreach my $dir_line (@{$newdirlistref}) {
14302: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14303: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14304: push(@newitems,$item);
14305: if ($dirptr&$testdir) {
14306: $is_dir{$item} = 1;
14307: }
14308: $changes{$item} = 1;
14309: }
14310: }
14311: }
14312: if (keys(%changes) > 0) {
14313: foreach my $item (sort(@newitems)) {
14314: if ($changes{$item}) {
14315: push(@contents,$item);
14316: }
14317: }
14318: }
14319: if (@contents > 0) {
1.1067 raeburn 14320: my $wantform;
14321: unless ($env{'form.autoextract_camtasia'}) {
14322: $wantform = 1;
14323: }
1.1056 raeburn 14324: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14325: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14326: $currdir,\%is_dir,
14327: \%children,\%parent,
1.1056 raeburn 14328: \@contents,\%dirorder,
14329: \%titles,$wantform);
1.1055 raeburn 14330: if ($datatable ne '') {
14331: $output .= &archive_options_form('decompressed',$datatable,
14332: $count,$hiddenelem);
1.1065 raeburn 14333: my $startcount = 6;
1.1055 raeburn 14334: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14335: \%titles,\%children);
1.1055 raeburn 14336: }
1.1067 raeburn 14337: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14338: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14339: my %displayed;
14340: my $total = 1;
14341: $env{'form.archive_directory'} = [];
14342: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14343: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14344: $path =~ s{/$}{};
14345: my $item;
14346: if ($path ne '') {
14347: $item = "$path/$titles{$i}";
14348: } else {
14349: $item = $titles{$i};
14350: }
14351: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14352: if ($item eq $contents[0]) {
14353: push(@{$env{'form.archive_directory'}},$i);
14354: $env{'form.archive_'.$i} = 'display';
14355: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14356: $displayed{'folder'} = $i;
1.1164 raeburn 14357: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14358: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14359: $env{'form.archive_'.$i} = 'display';
14360: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14361: $displayed{'web'} = $i;
14362: } else {
1.1164 raeburn 14363: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14364: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14365: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14366: push(@{$env{'form.archive_directory'}},$i);
14367: }
14368: $env{'form.archive_'.$i} = 'dependency';
14369: }
14370: $total ++;
14371: }
14372: for (my $i=1; $i<$total; $i++) {
14373: next if ($i == $displayed{'web'});
14374: next if ($i == $displayed{'folder'});
14375: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14376: }
14377: $env{'form.phase'} = 'decompress_cleanup';
14378: $env{'form.archivedelete'} = 1;
14379: $env{'form.archive_count'} = $total-1;
14380: $output .=
14381: &process_extracted_files('coursedocs',$docudom,
14382: $docuname,$destination,
14383: $dir_root,$hiddenelem);
14384: }
1.1055 raeburn 14385: } else {
14386: $warning = &mt('No new items extracted from archive file.');
14387: }
14388: } else {
14389: $output = $display;
14390: $error = &mt('An error occurred during extraction from the archive file.');
14391: }
14392: }
14393: }
14394: }
14395: if ($error) {
14396: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14397: $error.'</p>'."\n";
14398: }
14399: if ($warning) {
14400: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14401: }
14402: return $output;
14403: }
14404:
14405: sub get_extracted {
1.1056 raeburn 14406: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14407: $titles,$wantform) = @_;
1.1055 raeburn 14408: my $count = 0;
14409: my $depth = 0;
14410: my $datatable;
1.1056 raeburn 14411: my @hierarchy;
1.1055 raeburn 14412: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14413: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14414: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14415: foreach my $item (@{$contents}) {
14416: $count ++;
1.1056 raeburn 14417: @{$dirorder->{$count}} = @hierarchy;
14418: $titles->{$count} = $item;
1.1055 raeburn 14419: &archive_hierarchy($depth,$count,$parent,$children);
14420: if ($wantform) {
14421: $datatable .= &archive_row($is_dir->{$item},$item,
14422: $currdir,$depth,$count);
14423: }
14424: if ($is_dir->{$item}) {
14425: $depth ++;
1.1056 raeburn 14426: push(@hierarchy,$count);
14427: $parent->{$depth} = $count;
1.1055 raeburn 14428: $datatable .=
14429: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14430: \$depth,\$count,\@hierarchy,$dirorder,
14431: $children,$parent,$titles,$wantform);
1.1055 raeburn 14432: $depth --;
1.1056 raeburn 14433: pop(@hierarchy);
1.1055 raeburn 14434: }
14435: }
14436: return ($count,$datatable);
14437: }
14438:
14439: sub recurse_extracted_archive {
1.1056 raeburn 14440: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14441: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14442: my $result='';
1.1056 raeburn 14443: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14444: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14445: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14446: return $result;
14447: }
14448: my $dirptr = 16384;
14449: my ($newdirlistref,$newlisterror) =
14450: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14451: if (ref($newdirlistref) eq 'ARRAY') {
14452: foreach my $dir_line (@{$newdirlistref}) {
14453: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14454: unless ($item =~ /^\.+$/) {
14455: $$count ++;
1.1056 raeburn 14456: @{$dirorder->{$$count}} = @{$hierarchy};
14457: $titles->{$$count} = $item;
1.1055 raeburn 14458: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14459:
1.1055 raeburn 14460: my $is_dir;
14461: if ($dirptr&$testdir) {
14462: $is_dir = 1;
14463: }
14464: if ($wantform) {
14465: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14466: }
14467: if ($is_dir) {
14468: $$depth ++;
1.1056 raeburn 14469: push(@{$hierarchy},$$count);
14470: $parent->{$$depth} = $$count;
1.1055 raeburn 14471: $result .=
14472: &recurse_extracted_archive("$currdir/$item",$docudom,
14473: $docuname,$depth,$count,
1.1056 raeburn 14474: $hierarchy,$dirorder,$children,
14475: $parent,$titles,$wantform);
1.1055 raeburn 14476: $$depth --;
1.1056 raeburn 14477: pop(@{$hierarchy});
1.1055 raeburn 14478: }
14479: }
14480: }
14481: }
14482: return $result;
14483: }
14484:
14485: sub archive_hierarchy {
14486: my ($depth,$count,$parent,$children) =@_;
14487: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14488: if (exists($parent->{$depth})) {
14489: $children->{$parent->{$depth}} .= $count.':';
14490: }
14491: }
14492: return;
14493: }
14494:
14495: sub archive_row {
14496: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14497: my ($name) = ($item =~ m{([^/]+)$});
14498: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14499: 'display' => 'Add as file',
1.1055 raeburn 14500: 'dependency' => 'Include as dependency',
14501: 'discard' => 'Discard',
14502: );
14503: if ($is_dir) {
1.1059 raeburn 14504: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14505: }
1.1056 raeburn 14506: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14507: my $offset = 0;
1.1055 raeburn 14508: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14509: $offset ++;
1.1065 raeburn 14510: if ($action ne 'display') {
14511: $offset ++;
14512: }
1.1055 raeburn 14513: $output .= '<td><span class="LC_nobreak">'.
14514: '<label><input type="radio" name="archive_'.$count.
14515: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14516: my $text = $choices{$action};
14517: if ($is_dir) {
14518: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14519: if ($action eq 'display') {
1.1059 raeburn 14520: $text = &mt('Add as folder');
1.1055 raeburn 14521: }
1.1056 raeburn 14522: } else {
14523: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14524:
14525: }
14526: $output .= ' /> '.$choices{$action}.'</label></span>';
14527: if ($action eq 'dependency') {
14528: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14529: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14530: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14531: '<option value=""></option>'."\n".
14532: '</select>'."\n".
14533: '</div>';
1.1059 raeburn 14534: } elsif ($action eq 'display') {
14535: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14536: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14537: '</div>';
1.1055 raeburn 14538: }
1.1056 raeburn 14539: $output .= '</td>';
1.1055 raeburn 14540: }
14541: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14542: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14543: for (my $i=0; $i<$depth; $i++) {
14544: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14545: }
14546: if ($is_dir) {
14547: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14548: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14549: } else {
14550: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14551: }
14552: $output .= ' '.$name.'</td>'."\n".
14553: &end_data_table_row();
14554: return $output;
14555: }
14556:
14557: sub archive_options_form {
1.1065 raeburn 14558: my ($form,$display,$count,$hiddenelem) = @_;
14559: my %lt = &Apache::lonlocal::texthash(
14560: perm => 'Permanently remove archive file?',
14561: hows => 'How should each extracted item be incorporated in the course?',
14562: cont => 'Content actions for all',
14563: addf => 'Add as folder/file',
14564: incd => 'Include as dependency for a displayed file',
14565: disc => 'Discard',
14566: no => 'No',
14567: yes => 'Yes',
14568: save => 'Save',
14569: );
14570: my $output = <<"END";
14571: <form name="$form" method="post" action="">
14572: <p><span class="LC_nobreak">$lt{'perm'}
14573: <label>
14574: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14575: </label>
14576:
14577: <label>
14578: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14579: </span>
14580: </p>
14581: <input type="hidden" name="phase" value="decompress_cleanup" />
14582: <br />$lt{'hows'}
14583: <div class="LC_columnSection">
14584: <fieldset>
14585: <legend>$lt{'cont'}</legend>
14586: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14587: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14588: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14589: </fieldset>
14590: </div>
14591: END
14592: return $output.
1.1055 raeburn 14593: &start_data_table()."\n".
1.1065 raeburn 14594: $display."\n".
1.1055 raeburn 14595: &end_data_table()."\n".
14596: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14597: $hiddenelem.
1.1065 raeburn 14598: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14599: '</form>';
14600: }
14601:
14602: sub archive_javascript {
1.1056 raeburn 14603: my ($startcount,$numitems,$titles,$children) = @_;
14604: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14605: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14606: my $scripttag = <<START;
14607: <script type="text/javascript">
14608: // <![CDATA[
14609:
14610: function checkAll(form,prefix) {
14611: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14612: for (var i=0; i < form.elements.length; i++) {
14613: var id = form.elements[i].id;
14614: if ((id != '') && (id != undefined)) {
14615: if (idstr.test(id)) {
14616: if (form.elements[i].type == 'radio') {
14617: form.elements[i].checked = true;
1.1056 raeburn 14618: var nostart = i-$startcount;
1.1059 raeburn 14619: var offset = nostart%7;
14620: var count = (nostart-offset)/7;
1.1056 raeburn 14621: dependencyCheck(form,count,offset);
1.1055 raeburn 14622: }
14623: }
14624: }
14625: }
14626: }
14627:
14628: function propagateCheck(form,count) {
14629: if (count > 0) {
1.1059 raeburn 14630: var startelement = $startcount + ((count-1) * 7);
14631: for (var j=1; j<6; j++) {
14632: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14633: var item = startelement + j;
14634: if (form.elements[item].type == 'radio') {
14635: if (form.elements[item].checked) {
14636: containerCheck(form,count,j);
14637: break;
14638: }
1.1055 raeburn 14639: }
14640: }
14641: }
14642: }
14643: }
14644:
14645: numitems = $numitems
1.1056 raeburn 14646: var titles = new Array(numitems);
14647: var parents = new Array(numitems);
1.1055 raeburn 14648: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14649: parents[i] = new Array;
1.1055 raeburn 14650: }
1.1059 raeburn 14651: var maintitle = '$maintitle';
1.1055 raeburn 14652:
14653: START
14654:
1.1056 raeburn 14655: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14656: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14657: for (my $i=0; $i<@contents; $i ++) {
14658: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14659: }
14660: }
14661:
1.1056 raeburn 14662: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14663: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14664: }
14665:
1.1055 raeburn 14666: $scripttag .= <<END;
14667:
14668: function containerCheck(form,count,offset) {
14669: if (count > 0) {
1.1056 raeburn 14670: dependencyCheck(form,count,offset);
1.1059 raeburn 14671: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14672: form.elements[item].checked = true;
14673: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14674: if (parents[count].length > 0) {
14675: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14676: containerCheck(form,parents[count][j],offset);
14677: }
14678: }
14679: }
14680: }
14681: }
14682:
14683: function dependencyCheck(form,count,offset) {
14684: if (count > 0) {
1.1059 raeburn 14685: var chosen = (offset+$startcount)+7*(count-1);
14686: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14687: var currtype = form.elements[depitem].type;
14688: if (form.elements[chosen].value == 'dependency') {
14689: document.getElementById('arc_depon_'+count).style.display='block';
14690: form.elements[depitem].options.length = 0;
14691: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14692: for (var i=1; i<=numitems; i++) {
14693: if (i == count) {
14694: continue;
14695: }
1.1059 raeburn 14696: var startelement = $startcount + (i-1) * 7;
14697: for (var j=1; j<6; j++) {
14698: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14699: var item = startelement + j;
14700: if (form.elements[item].type == 'radio') {
14701: if (form.elements[item].checked) {
14702: if (form.elements[item].value == 'display') {
14703: var n = form.elements[depitem].options.length;
14704: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14705: }
14706: }
14707: }
14708: }
14709: }
14710: }
14711: } else {
14712: document.getElementById('arc_depon_'+count).style.display='none';
14713: form.elements[depitem].options.length = 0;
14714: form.elements[depitem].options[0] = new Option('Select','',true,true);
14715: }
1.1059 raeburn 14716: titleCheck(form,count,offset);
1.1056 raeburn 14717: }
14718: }
14719:
14720: function propagateSelect(form,count,offset) {
14721: if (count > 0) {
1.1065 raeburn 14722: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14723: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14724: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14725: if (parents[count].length > 0) {
14726: for (var j=0; j<parents[count].length; j++) {
14727: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14728: }
14729: }
14730: }
14731: }
14732: }
1.1056 raeburn 14733:
14734: function containerSelect(form,count,offset,picked) {
14735: if (count > 0) {
1.1065 raeburn 14736: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14737: if (form.elements[item].type == 'radio') {
14738: if (form.elements[item].value == 'dependency') {
14739: if (form.elements[item+1].type == 'select-one') {
14740: for (var i=0; i<form.elements[item+1].options.length; i++) {
14741: if (form.elements[item+1].options[i].value == picked) {
14742: form.elements[item+1].selectedIndex = i;
14743: break;
14744: }
14745: }
14746: }
14747: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14748: if (parents[count].length > 0) {
14749: for (var j=0; j<parents[count].length; j++) {
14750: containerSelect(form,parents[count][j],offset,picked);
14751: }
14752: }
14753: }
14754: }
14755: }
14756: }
14757: }
14758:
1.1059 raeburn 14759: function titleCheck(form,count,offset) {
14760: if (count > 0) {
14761: var chosen = (offset+$startcount)+7*(count-1);
14762: var depitem = $startcount + ((count-1) * 7) + 2;
14763: var currtype = form.elements[depitem].type;
14764: if (form.elements[chosen].value == 'display') {
14765: document.getElementById('arc_title_'+count).style.display='block';
14766: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14767: document.getElementById('archive_title_'+count).value=maintitle;
14768: }
14769: } else {
14770: document.getElementById('arc_title_'+count).style.display='none';
14771: if (currtype == 'text') {
14772: document.getElementById('archive_title_'+count).value='';
14773: }
14774: }
14775: }
14776: return;
14777: }
14778:
1.1055 raeburn 14779: // ]]>
14780: </script>
14781: END
14782: return $scripttag;
14783: }
14784:
14785: sub process_extracted_files {
1.1067 raeburn 14786: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14787: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14788: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14789: my @ids=&Apache::lonnet::current_machine_ids();
14790: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14791: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14792: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14793: if (grep(/^\Q$docuhome\E$/,@ids)) {
14794: $prefix = &LONCAPA::propath($docudom,$docuname);
14795: $pathtocheck = "$dir_root/$destination";
14796: $dir = $dir_root;
14797: $ishome = 1;
14798: } else {
14799: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14800: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14801: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14802: }
14803: my $currdir = "$dir_root/$destination";
14804: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14805: if ($env{'form.folderpath'}) {
14806: my @items = split('&',$env{'form.folderpath'});
14807: $folders{'0'} = $items[-2];
1.1099 raeburn 14808: if ($env{'form.folderpath'} =~ /\:1$/) {
14809: $containers{'0'}='page';
14810: } else {
14811: $containers{'0'}='sequence';
14812: }
1.1055 raeburn 14813: }
14814: my @archdirs = &get_env_multiple('form.archive_directory');
14815: if ($numitems) {
14816: for (my $i=1; $i<=$numitems; $i++) {
14817: my $path = $env{'form.archive_content_'.$i};
14818: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14819: my $item = $1;
14820: $toplevelitems{$item} = $i;
14821: if (grep(/^\Q$i\E$/,@archdirs)) {
14822: $is_dir{$item} = 1;
14823: }
14824: }
14825: }
14826: }
1.1067 raeburn 14827: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14828: if (keys(%toplevelitems) > 0) {
14829: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14830: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14831: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14832: }
1.1066 raeburn 14833: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14834: if ($numitems) {
14835: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14836: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14837: my $path = $env{'form.archive_content_'.$i};
14838: if ($path =~ /^\Q$pathtocheck\E/) {
14839: if ($env{'form.archive_'.$i} eq 'discard') {
14840: if ($prefix ne '' && $path ne '') {
14841: if (-e $prefix.$path) {
1.1066 raeburn 14842: if ((@archdirs > 0) &&
14843: (grep(/^\Q$i\E$/,@archdirs))) {
14844: $todeletedir{$prefix.$path} = 1;
14845: } else {
14846: $todelete{$prefix.$path} = 1;
14847: }
1.1055 raeburn 14848: }
14849: }
14850: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14851: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14852: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14853: $docstitle = $env{'form.archive_title_'.$i};
14854: if ($docstitle eq '') {
14855: $docstitle = $title;
14856: }
1.1055 raeburn 14857: $outer = 0;
1.1056 raeburn 14858: if (ref($dirorder{$i}) eq 'ARRAY') {
14859: if (@{$dirorder{$i}} > 0) {
14860: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14861: if ($env{'form.archive_'.$item} eq 'display') {
14862: $outer = $item;
14863: last;
14864: }
14865: }
14866: }
14867: }
14868: my ($errtext,$fatal) =
14869: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14870: '/'.$folders{$outer}.'.'.
14871: $containers{$outer});
14872: next if ($fatal);
14873: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14874: if ($context eq 'coursedocs') {
1.1056 raeburn 14875: $mapinner{$i} = time;
1.1055 raeburn 14876: $folders{$i} = 'default_'.$mapinner{$i};
14877: $containers{$i} = 'sequence';
14878: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14879: $folders{$i}.'.'.$containers{$i};
14880: my $newidx = &LONCAPA::map::getresidx();
14881: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14882: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14883: push(@LONCAPA::map::order,$newidx);
14884: my ($outtext,$errtext) =
14885: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14886: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14887: '.'.$containers{$outer},1,1);
1.1056 raeburn 14888: $newseqid{$i} = $newidx;
1.1067 raeburn 14889: unless ($errtext) {
1.1294 raeburn 14890: $result .= '<li>'.&mt('Folder: [_1] added to course',
14891: &HTML::Entities::encode($docstitle,'<>&"')).
14892: '</li>'."\n";
1.1067 raeburn 14893: }
1.1055 raeburn 14894: }
14895: } else {
14896: if ($context eq 'coursedocs') {
14897: my $newidx=&LONCAPA::map::getresidx();
14898: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14899: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14900: $title;
1.1392 raeburn 14901: if (($outer !~ /\D/) &&
14902: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14903: ($newidx !~ /\D/)) {
1.1294 raeburn 14904: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14905: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14906: }
14907: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14908: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14909: }
14910: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14911: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14912: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14913: unless ($ishome) {
14914: my $fetch = "$newdest{$i}/$title";
14915: $fetch =~ s/^\Q$prefix$dir\E//;
14916: $prompttofetch{$fetch} = 1;
14917: }
1.1292 raeburn 14918: }
1.1067 raeburn 14919: }
1.1294 raeburn 14920: $LONCAPA::map::resources[$newidx]=
14921: $docstitle.':'.$url.':false:normal:res';
14922: push(@LONCAPA::map::order, $newidx);
14923: my ($outtext,$errtext)=
14924: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14925: $docuname.'/'.$folders{$outer}.
14926: '.'.$containers{$outer},1,1);
14927: unless ($errtext) {
14928: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14929: $result .= '<li>'.&mt('File: [_1] added to course',
14930: &HTML::Entities::encode($docstitle,'<>&"')).
14931: '</li>'."\n";
14932: }
1.1067 raeburn 14933: }
1.1294 raeburn 14934: } else {
14935: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14936: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14937: }
1.1055 raeburn 14938: }
14939: }
1.1086 raeburn 14940: }
14941: } else {
1.1294 raeburn 14942: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14943: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14944: }
14945: }
14946: for (my $i=1; $i<=$numitems; $i++) {
14947: next unless ($env{'form.archive_'.$i} eq 'dependency');
14948: my $path = $env{'form.archive_content_'.$i};
14949: if ($path =~ /^\Q$pathtocheck\E/) {
14950: my ($title) = ($path =~ m{/([^/]+)$});
14951: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14952: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14953: if (ref($dirorder{$i}) eq 'ARRAY') {
14954: my ($itemidx,$fullpath,$relpath);
14955: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14956: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14957: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14958: if ($dirorder{$i}->[$j] eq $container) {
14959: $itemidx = $j;
1.1056 raeburn 14960: }
14961: }
1.1086 raeburn 14962: }
14963: if ($itemidx eq '') {
14964: $itemidx = 0;
14965: }
14966: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14967: if ($mapinner{$referrer{$i}}) {
14968: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14969: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14970: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14971: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14972: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14973: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14974: if (!-e $fullpath) {
14975: mkdir($fullpath,0755);
1.1056 raeburn 14976: }
14977: }
1.1086 raeburn 14978: } else {
14979: last;
1.1056 raeburn 14980: }
1.1086 raeburn 14981: }
14982: }
14983: } elsif ($newdest{$referrer{$i}}) {
14984: $fullpath = $newdest{$referrer{$i}};
14985: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14986: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14987: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14988: last;
14989: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14990: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14991: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14992: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14993: if (!-e $fullpath) {
14994: mkdir($fullpath,0755);
1.1056 raeburn 14995: }
14996: }
1.1086 raeburn 14997: } else {
14998: last;
1.1056 raeburn 14999: }
1.1055 raeburn 15000: }
15001: }
1.1086 raeburn 15002: if ($fullpath ne '') {
15003: if (-e "$prefix$path") {
1.1292 raeburn 15004: unless (rename("$prefix$path","$fullpath/$title")) {
15005: $warning .= &mt('Failed to rename dependency').'<br />';
15006: }
1.1086 raeburn 15007: }
15008: if (-e "$fullpath/$title") {
15009: my $showpath;
15010: if ($relpath ne '') {
15011: $showpath = "$relpath/$title";
15012: } else {
15013: $showpath = "/$title";
15014: }
1.1294 raeburn 15015: $result .= '<li>'.&mt('[_1] included as a dependency',
15016: &HTML::Entities::encode($showpath,'<>&"')).
15017: '</li>'."\n";
1.1292 raeburn 15018: unless ($ishome) {
15019: my $fetch = "$fullpath/$title";
15020: $fetch =~ s/^\Q$prefix$dir\E//;
15021: $prompttofetch{$fetch} = 1;
15022: }
1.1086 raeburn 15023: }
15024: }
1.1055 raeburn 15025: }
1.1086 raeburn 15026: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15027: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15028: &HTML::Entities::encode($path,'<>&"'),
15029: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15030: '<br />';
1.1055 raeburn 15031: }
15032: } else {
1.1294 raeburn 15033: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15034: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15035: }
15036: }
15037: if (keys(%todelete)) {
15038: foreach my $key (keys(%todelete)) {
15039: unlink($key);
1.1066 raeburn 15040: }
15041: }
15042: if (keys(%todeletedir)) {
15043: foreach my $key (keys(%todeletedir)) {
15044: rmdir($key);
15045: }
15046: }
15047: foreach my $dir (sort(keys(%is_dir))) {
15048: if (($pathtocheck ne '') && ($dir ne '')) {
15049: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15050: }
15051: }
1.1067 raeburn 15052: if ($result ne '') {
15053: $output .= '<ul>'."\n".
15054: $result."\n".
15055: '</ul>';
15056: }
15057: unless ($ishome) {
15058: my $replicationfail;
15059: foreach my $item (keys(%prompttofetch)) {
15060: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15061: unless ($fetchresult eq 'ok') {
15062: $replicationfail .= '<li>'.$item.'</li>'."\n";
15063: }
15064: }
15065: if ($replicationfail) {
15066: $output .= '<p class="LC_error">'.
15067: &mt('Course home server failed to retrieve:').'<ul>'.
15068: $replicationfail.
15069: '</ul></p>';
15070: }
15071: }
1.1055 raeburn 15072: } else {
15073: $warning = &mt('No items found in archive.');
15074: }
15075: if ($error) {
15076: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15077: $error.'</p>'."\n";
15078: }
15079: if ($warning) {
15080: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15081: }
15082: return $output;
15083: }
15084:
1.1066 raeburn 15085: sub cleanup_empty_dirs {
15086: my ($path) = @_;
15087: if (($path ne '') && (-d $path)) {
15088: if (opendir(my $dirh,$path)) {
15089: my @dircontents = grep(!/^\./,readdir($dirh));
15090: my $numitems = 0;
15091: foreach my $item (@dircontents) {
15092: if (-d "$path/$item") {
1.1111 raeburn 15093: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15094: if (-e "$path/$item") {
15095: $numitems ++;
15096: }
15097: } else {
15098: $numitems ++;
15099: }
15100: }
15101: if ($numitems == 0) {
15102: rmdir($path);
15103: }
15104: closedir($dirh);
15105: }
15106: }
15107: return;
15108: }
15109:
1.41 ng 15110: =pod
1.45 matthew 15111:
1.1162 raeburn 15112: =item * &get_folder_hierarchy()
1.1068 raeburn 15113:
15114: Provides hierarchy of names of folders/sub-folders containing the current
15115: item,
15116:
15117: Inputs: 3
15118: - $navmap - navmaps object
15119:
15120: - $map - url for map (either the trigger itself, or map containing
15121: the resource, which is the trigger).
15122:
15123: - $showitem - 1 => show title for map itself; 0 => do not show.
15124:
15125: Outputs: 1 @pathitems - array of folder/subfolder names.
15126:
15127: =cut
15128:
15129: sub get_folder_hierarchy {
15130: my ($navmap,$map,$showitem) = @_;
15131: my @pathitems;
15132: if (ref($navmap)) {
15133: my $mapres = $navmap->getResourceByUrl($map);
15134: if (ref($mapres)) {
15135: my $pcslist = $mapres->map_hierarchy();
15136: if ($pcslist ne '') {
15137: my @pcs = split(/,/,$pcslist);
15138: foreach my $pc (@pcs) {
15139: if ($pc == 1) {
1.1129 raeburn 15140: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15141: } else {
15142: my $res = $navmap->getByMapPc($pc);
15143: if (ref($res)) {
15144: my $title = $res->compTitle();
15145: $title =~ s/\W+/_/g;
15146: if ($title ne '') {
15147: push(@pathitems,$title);
15148: }
15149: }
15150: }
15151: }
15152: }
1.1071 raeburn 15153: if ($showitem) {
15154: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15155: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15156: } else {
15157: my $maptitle = $mapres->compTitle();
15158: $maptitle =~ s/\W+/_/g;
15159: if ($maptitle ne '') {
15160: push(@pathitems,$maptitle);
15161: }
1.1068 raeburn 15162: }
15163: }
15164: }
15165: }
15166: return @pathitems;
15167: }
15168:
15169: =pod
15170:
1.1015 raeburn 15171: =item * &get_turnedin_filepath()
15172:
15173: Determines path in a user's portfolio file for storage of files uploaded
15174: to a specific essayresponse or dropbox item.
15175:
15176: Inputs: 3 required + 1 optional.
15177: $symb is symb for resource, $uname and $udom are for current user (required).
15178: $caller is optional (can be "submission", if routine is called when storing
15179: an upoaded file when "Submit Answer" button was pressed).
15180:
15181: Returns array containing $path and $multiresp.
15182: $path is path in portfolio. $multiresp is 1 if this resource contains more
15183: than one file upload item. Callers of routine should append partid as a
15184: subdirectory to $path in cases where $multiresp is 1.
15185:
15186: Called by: homework/essayresponse.pm and homework/structuretags.pm
15187:
15188: =cut
15189:
15190: sub get_turnedin_filepath {
15191: my ($symb,$uname,$udom,$caller) = @_;
15192: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15193: my $turnindir;
15194: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15195: $turnindir = $userhash{'turnindir'};
15196: my ($path,$multiresp);
15197: if ($turnindir eq '') {
15198: if ($caller eq 'submission') {
15199: $turnindir = &mt('turned in');
15200: $turnindir =~ s/\W+/_/g;
15201: my %newhash = (
15202: 'turnindir' => $turnindir,
15203: );
15204: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15205: }
15206: }
15207: if ($turnindir ne '') {
15208: $path = '/'.$turnindir.'/';
15209: my ($multipart,$turnin,@pathitems);
15210: my $navmap = Apache::lonnavmaps::navmap->new();
15211: if (defined($navmap)) {
15212: my $mapres = $navmap->getResourceByUrl($map);
15213: if (ref($mapres)) {
15214: my $pcslist = $mapres->map_hierarchy();
15215: if ($pcslist ne '') {
15216: foreach my $pc (split(/,/,$pcslist)) {
15217: my $res = $navmap->getByMapPc($pc);
15218: if (ref($res)) {
15219: my $title = $res->compTitle();
15220: $title =~ s/\W+/_/g;
15221: if ($title ne '') {
1.1149 raeburn 15222: if (($pc > 1) && (length($title) > 12)) {
15223: $title = substr($title,0,12);
15224: }
1.1015 raeburn 15225: push(@pathitems,$title);
15226: }
15227: }
15228: }
15229: }
15230: my $maptitle = $mapres->compTitle();
15231: $maptitle =~ s/\W+/_/g;
15232: if ($maptitle ne '') {
1.1149 raeburn 15233: if (length($maptitle) > 12) {
15234: $maptitle = substr($maptitle,0,12);
15235: }
1.1015 raeburn 15236: push(@pathitems,$maptitle);
15237: }
15238: unless ($env{'request.state'} eq 'construct') {
15239: my $res = $navmap->getBySymb($symb);
15240: if (ref($res)) {
15241: my $partlist = $res->parts();
15242: my $totaluploads = 0;
15243: if (ref($partlist) eq 'ARRAY') {
15244: foreach my $part (@{$partlist}) {
15245: my @types = $res->responseType($part);
15246: my @ids = $res->responseIds($part);
15247: for (my $i=0; $i < scalar(@ids); $i++) {
15248: if ($types[$i] eq 'essay') {
15249: my $partid = $part.'_'.$ids[$i];
15250: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15251: $totaluploads ++;
15252: }
15253: }
15254: }
15255: }
15256: if ($totaluploads > 1) {
15257: $multiresp = 1;
15258: }
15259: }
15260: }
15261: }
15262: } else {
15263: return;
15264: }
15265: } else {
15266: return;
15267: }
15268: my $restitle=&Apache::lonnet::gettitle($symb);
15269: $restitle =~ s/\W+/_/g;
15270: if ($restitle eq '') {
15271: $restitle = ($resurl =~ m{/[^/]+$});
15272: if ($restitle eq '') {
15273: $restitle = time;
15274: }
15275: }
1.1149 raeburn 15276: if (length($restitle) > 12) {
15277: $restitle = substr($restitle,0,12);
15278: }
1.1015 raeburn 15279: push(@pathitems,$restitle);
15280: $path .= join('/',@pathitems);
15281: }
15282: return ($path,$multiresp);
15283: }
15284:
15285: =pod
15286:
1.464 albertel 15287: =back
1.41 ng 15288:
1.112 bowersj2 15289: =head1 CSV Upload/Handling functions
1.38 albertel 15290:
1.41 ng 15291: =over 4
15292:
1.648 raeburn 15293: =item * &upfile_store($r)
1.41 ng 15294:
15295: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15296: needs $env{'form.upfile'}
1.41 ng 15297: returns $datatoken to be put into hidden field
15298:
15299: =cut
1.31 albertel 15300:
15301: sub upfile_store {
15302: my $r=shift;
1.258 albertel 15303: $env{'form.upfile'}=~s/\r/\n/gs;
15304: $env{'form.upfile'}=~s/\f/\n/gs;
15305: $env{'form.upfile'}=~s/\n+/\n/gs;
15306: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15307:
1.1299 raeburn 15308: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15309: '_enroll_'.$env{'request.course.id'}.'_'.
15310: time.'_'.$$);
15311: return if ($datatoken eq '');
15312:
1.31 albertel 15313: {
1.158 raeburn 15314: my $datafile = $r->dir_config('lonDaemons').
15315: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15316: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15317: print $fh $env{'form.upfile'};
1.158 raeburn 15318: close($fh);
15319: }
1.31 albertel 15320: }
15321: return $datatoken;
15322: }
15323:
1.56 matthew 15324: =pod
15325:
1.1290 raeburn 15326: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15327:
15328: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15329: $datatoken is the name to assign to the temporary file.
1.258 albertel 15330: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15331:
15332: =cut
1.31 albertel 15333:
15334: sub load_tmp_file {
1.1290 raeburn 15335: my ($r,$datatoken) = @_;
15336: return if ($datatoken eq '');
1.31 albertel 15337: my @studentdata=();
15338: {
1.158 raeburn 15339: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15340: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15341: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15342: @studentdata=<$fh>;
15343: close($fh);
15344: }
1.31 albertel 15345: }
1.258 albertel 15346: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15347: }
15348:
1.1290 raeburn 15349: sub valid_datatoken {
15350: my ($datatoken) = @_;
1.1325 raeburn 15351: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15352: return $datatoken;
15353: }
15354: return;
15355: }
15356:
1.56 matthew 15357: =pod
15358:
1.648 raeburn 15359: =item * &upfile_record_sep()
1.41 ng 15360:
15361: Separate uploaded file into records
15362: returns array of records,
1.258 albertel 15363: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15364:
15365: =cut
1.31 albertel 15366:
15367: sub upfile_record_sep {
1.258 albertel 15368: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15369: } else {
1.248 albertel 15370: my @records;
1.258 albertel 15371: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15372: if ($line=~/^\s*$/) { next; }
15373: push(@records,$line);
15374: }
15375: return @records;
1.31 albertel 15376: }
15377: }
15378:
1.56 matthew 15379: =pod
15380:
1.648 raeburn 15381: =item * &record_sep($record)
1.41 ng 15382:
1.258 albertel 15383: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15384:
15385: =cut
15386:
1.263 www 15387: sub takeleft {
15388: my $index=shift;
15389: return substr('0000'.$index,-4,4);
15390: }
15391:
1.31 albertel 15392: sub record_sep {
15393: my $record=shift;
15394: my %components=();
1.258 albertel 15395: if ($env{'form.upfiletype'} eq 'xml') {
15396: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15397: my $i=0;
1.356 albertel 15398: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15399: $field=~s/^(\"|\')//;
15400: $field=~s/(\"|\')$//;
1.263 www 15401: $components{&takeleft($i)}=$field;
1.31 albertel 15402: $i++;
15403: }
1.258 albertel 15404: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15405: my $i=0;
1.356 albertel 15406: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15407: $field=~s/^(\"|\')//;
15408: $field=~s/(\"|\')$//;
1.263 www 15409: $components{&takeleft($i)}=$field;
1.31 albertel 15410: $i++;
15411: }
15412: } else {
1.561 www 15413: my $separator=',';
1.480 banghart 15414: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15415: $separator=';';
1.480 banghart 15416: }
1.31 albertel 15417: my $i=0;
1.561 www 15418: # the character we are looking for to indicate the end of a quote or a record
15419: my $looking_for=$separator;
15420: # do not add the characters to the fields
15421: my $ignore=0;
15422: # we just encountered a separator (or the beginning of the record)
15423: my $just_found_separator=1;
15424: # store the field we are working on here
15425: my $field='';
15426: # work our way through all characters in record
15427: foreach my $character ($record=~/(.)/g) {
15428: if ($character eq $looking_for) {
15429: if ($character ne $separator) {
15430: # Found the end of a quote, again looking for separator
15431: $looking_for=$separator;
15432: $ignore=1;
15433: } else {
15434: # Found a separator, store away what we got
15435: $components{&takeleft($i)}=$field;
15436: $i++;
15437: $just_found_separator=1;
15438: $ignore=0;
15439: $field='';
15440: }
15441: next;
15442: }
15443: # single or double quotation marks after a separator indicate beginning of a quote
15444: # we are now looking for the end of the quote and need to ignore separators
15445: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15446: $looking_for=$character;
15447: next;
15448: }
15449: # ignore would be true after we reached the end of a quote
15450: if ($ignore) { next; }
15451: if (($just_found_separator) && ($character=~/\s/)) { next; }
15452: $field.=$character;
15453: $just_found_separator=0;
1.31 albertel 15454: }
1.561 www 15455: # catch the very last entry, since we never encountered the separator
15456: $components{&takeleft($i)}=$field;
1.31 albertel 15457: }
15458: return %components;
15459: }
15460:
1.144 matthew 15461: ######################################################
15462: ######################################################
15463:
1.56 matthew 15464: =pod
15465:
1.648 raeburn 15466: =item * &upfile_select_html()
1.41 ng 15467:
1.144 matthew 15468: Return HTML code to select a file from the users machine and specify
15469: the file type.
1.41 ng 15470:
15471: =cut
15472:
1.144 matthew 15473: ######################################################
15474: ######################################################
1.31 albertel 15475: sub upfile_select_html {
1.144 matthew 15476: my %Types = (
15477: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15478: semisv => &mt('Semicolon separated values'),
1.144 matthew 15479: space => &mt('Space separated'),
15480: tab => &mt('Tabulator separated'),
15481: # xml => &mt('HTML/XML'),
15482: );
15483: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15484: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15485: foreach my $type (sort(keys(%Types))) {
15486: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15487: }
15488: $Str .= "</select>\n";
15489: return $Str;
1.31 albertel 15490: }
15491:
1.301 albertel 15492: sub get_samples {
15493: my ($records,$toget) = @_;
15494: my @samples=({});
15495: my $got=0;
15496: foreach my $rec (@$records) {
15497: my %temp = &record_sep($rec);
15498: if (! grep(/\S/, values(%temp))) { next; }
15499: if (%temp) {
15500: $samples[$got]=\%temp;
15501: $got++;
15502: if ($got == $toget) { last; }
15503: }
15504: }
15505: return \@samples;
15506: }
15507:
1.144 matthew 15508: ######################################################
15509: ######################################################
15510:
1.56 matthew 15511: =pod
15512:
1.648 raeburn 15513: =item * &csv_print_samples($r,$records)
1.41 ng 15514:
15515: Prints a table of sample values from each column uploaded $r is an
15516: Apache Request ref, $records is an arrayref from
15517: &Apache::loncommon::upfile_record_sep
15518:
15519: =cut
15520:
1.144 matthew 15521: ######################################################
15522: ######################################################
1.31 albertel 15523: sub csv_print_samples {
15524: my ($r,$records) = @_;
1.662 bisitz 15525: my $samples = &get_samples($records,5);
1.301 albertel 15526:
1.594 raeburn 15527: $r->print(&mt('Samples').'<br />'.&start_data_table().
15528: &start_data_table_header_row());
1.356 albertel 15529: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15530: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15531: $r->print(&end_data_table_header_row());
1.301 albertel 15532: foreach my $hash (@$samples) {
1.594 raeburn 15533: $r->print(&start_data_table_row());
1.356 albertel 15534: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15535: $r->print('<td>');
1.356 albertel 15536: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15537: $r->print('</td>');
15538: }
1.594 raeburn 15539: $r->print(&end_data_table_row());
1.31 albertel 15540: }
1.594 raeburn 15541: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15542: }
15543:
1.144 matthew 15544: ######################################################
15545: ######################################################
15546:
1.56 matthew 15547: =pod
15548:
1.648 raeburn 15549: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15550:
15551: Prints a table to create associations between values and table columns.
1.144 matthew 15552:
1.41 ng 15553: $r is an Apache Request ref,
15554: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15555: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15556:
15557: =cut
15558:
1.144 matthew 15559: ######################################################
15560: ######################################################
1.31 albertel 15561: sub csv_print_select_table {
15562: my ($r,$records,$d) = @_;
1.301 albertel 15563: my $i=0;
15564: my $samples = &get_samples($records,1);
1.144 matthew 15565: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15566: &start_data_table().&start_data_table_header_row().
1.144 matthew 15567: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15568: '<th>'.&mt('Column').'</th>'.
15569: &end_data_table_header_row()."\n");
1.356 albertel 15570: foreach my $array_ref (@$d) {
15571: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15572: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15573:
1.875 bisitz 15574: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15575: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15576: $r->print('<option value="none"></option>');
1.356 albertel 15577: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15578: $r->print('<option value="'.$sample.'"'.
15579: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15580: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15581: }
1.594 raeburn 15582: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15583: $i++;
15584: }
1.594 raeburn 15585: $r->print(&end_data_table());
1.31 albertel 15586: $i--;
15587: return $i;
15588: }
1.56 matthew 15589:
1.144 matthew 15590: ######################################################
15591: ######################################################
15592:
1.56 matthew 15593: =pod
1.31 albertel 15594:
1.648 raeburn 15595: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15596:
15597: Prints a table of sample values from the upload and can make associate samples to internal names.
15598:
15599: $r is an Apache Request ref,
15600: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15601: $d is an array of 2 element arrays (internal name, displayed name)
15602:
15603: =cut
15604:
1.144 matthew 15605: ######################################################
15606: ######################################################
1.31 albertel 15607: sub csv_samples_select_table {
15608: my ($r,$records,$d) = @_;
15609: my $i=0;
1.144 matthew 15610: #
1.662 bisitz 15611: my $max_samples = 5;
15612: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15613: $r->print(&start_data_table().
15614: &start_data_table_header_row().'<th>'.
15615: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15616: &end_data_table_header_row());
1.301 albertel 15617:
15618: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15619: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15620: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15621: foreach my $option (@$d) {
15622: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15623: $r->print('<option value="'.$value.'"'.
1.253 albertel 15624: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15625: $display.'</option>');
1.31 albertel 15626: }
15627: $r->print('</select></td><td>');
1.662 bisitz 15628: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15629: if (defined($samples->[$line]{$key})) {
15630: $r->print($samples->[$line]{$key}."<br />\n");
15631: }
15632: }
1.594 raeburn 15633: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15634: $i++;
15635: }
1.594 raeburn 15636: $r->print(&end_data_table());
1.31 albertel 15637: $i--;
15638: return($i);
1.115 matthew 15639: }
15640:
1.144 matthew 15641: ######################################################
15642: ######################################################
15643:
1.115 matthew 15644: =pod
15645:
1.648 raeburn 15646: =item * &clean_excel_name($name)
1.115 matthew 15647:
15648: Returns a replacement for $name which does not contain any illegal characters.
15649:
15650: =cut
15651:
1.144 matthew 15652: ######################################################
15653: ######################################################
1.115 matthew 15654: sub clean_excel_name {
15655: my ($name) = @_;
15656: $name =~ s/[:\*\?\/\\]//g;
15657: if (length($name) > 31) {
15658: $name = substr($name,0,31);
15659: }
15660: return $name;
1.25 albertel 15661: }
1.84 albertel 15662:
1.85 albertel 15663: =pod
15664:
1.648 raeburn 15665: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15666:
15667: Returns either 1 or undef
15668:
15669: 1 if the part is to be hidden, undef if it is to be shown
15670:
15671: Arguments are:
15672:
15673: $id the id of the part to be checked
15674: $symb, optional the symb of the resource to check
15675: $udom, optional the domain of the user to check for
15676: $uname, optional the username of the user to check for
15677:
15678: =cut
1.84 albertel 15679:
15680: sub check_if_partid_hidden {
15681: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15682: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15683: $symb,$udom,$uname);
1.141 albertel 15684: my $truth=1;
15685: #if the string starts with !, then the list is the list to show not hide
15686: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15687: my @hiddenlist=split(/,/,$hiddenparts);
15688: foreach my $checkid (@hiddenlist) {
1.141 albertel 15689: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15690: }
1.141 albertel 15691: return !$truth;
1.84 albertel 15692: }
1.127 matthew 15693:
1.138 matthew 15694:
15695: ############################################################
15696: ############################################################
15697:
15698: =pod
15699:
1.157 matthew 15700: =back
15701:
1.138 matthew 15702: =head1 cgi-bin script and graphing routines
15703:
1.157 matthew 15704: =over 4
15705:
1.648 raeburn 15706: =item * &get_cgi_id()
1.138 matthew 15707:
15708: Inputs: none
15709:
15710: Returns an id which can be used to pass environment variables
15711: to various cgi-bin scripts. These environment variables will
15712: be removed from the users environment after a given time by
15713: the routine &Apache::lonnet::transfer_profile_to_env.
15714:
15715: =cut
15716:
15717: ############################################################
15718: ############################################################
1.152 albertel 15719: my $uniq=0;
1.136 matthew 15720: sub get_cgi_id {
1.154 albertel 15721: $uniq=($uniq+1)%100000;
1.280 albertel 15722: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15723: }
15724:
1.127 matthew 15725: ############################################################
15726: ############################################################
15727:
15728: =pod
15729:
1.648 raeburn 15730: =item * &DrawBarGraph()
1.127 matthew 15731:
1.138 matthew 15732: Facilitates the plotting of data in a (stacked) bar graph.
15733: Puts plot definition data into the users environment in order for
15734: graph.png to plot it. Returns an <img> tag for the plot.
15735: The bars on the plot are labeled '1','2',...,'n'.
15736:
15737: Inputs:
15738:
15739: =over 4
15740:
15741: =item $Title: string, the title of the plot
15742:
15743: =item $xlabel: string, text describing the X-axis of the plot
15744:
15745: =item $ylabel: string, text describing the Y-axis of the plot
15746:
15747: =item $Max: scalar, the maximum Y value to use in the plot
15748: If $Max is < any data point, the graph will not be rendered.
15749:
1.140 matthew 15750: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15751: they are plotted. If undefined, default values will be used.
15752:
1.178 matthew 15753: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15754:
1.138 matthew 15755: =item @Values: An array of array references. Each array reference holds data
15756: to be plotted in a stacked bar chart.
15757:
1.239 matthew 15758: =item If the final element of @Values is a hash reference the key/value
15759: pairs will be added to the graph definition.
15760:
1.138 matthew 15761: =back
15762:
15763: Returns:
15764:
15765: An <img> tag which references graph.png and the appropriate identifying
15766: information for the plot.
15767:
1.127 matthew 15768: =cut
15769:
15770: ############################################################
15771: ############################################################
1.134 matthew 15772: sub DrawBarGraph {
1.178 matthew 15773: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15774: #
15775: if (! defined($colors)) {
15776: $colors = ['#33ff00',
15777: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15778: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15779: ];
15780: }
1.228 matthew 15781: my $extra_settings = {};
15782: if (ref($Values[-1]) eq 'HASH') {
15783: $extra_settings = pop(@Values);
15784: }
1.127 matthew 15785: #
1.136 matthew 15786: my $identifier = &get_cgi_id();
15787: my $id = 'cgi.'.$identifier;
1.129 matthew 15788: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15789: return '';
15790: }
1.225 matthew 15791: #
15792: my @Labels;
15793: if (defined($labels)) {
15794: @Labels = @$labels;
15795: } else {
15796: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15797: push(@Labels,$i+1);
1.225 matthew 15798: }
15799: }
15800: #
1.129 matthew 15801: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15802: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15803: my %ValuesHash;
15804: my $NumSets=1;
15805: foreach my $array (@Values) {
15806: next if (! ref($array));
1.136 matthew 15807: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15808: join(',',@$array);
1.129 matthew 15809: }
1.127 matthew 15810: #
1.136 matthew 15811: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15812: if ($NumBars < 3) {
15813: $width = 120+$NumBars*32;
1.220 matthew 15814: $xskip = 1;
1.225 matthew 15815: $bar_width = 30;
15816: } elsif ($NumBars < 5) {
15817: $width = 120+$NumBars*20;
15818: $xskip = 1;
15819: $bar_width = 20;
1.220 matthew 15820: } elsif ($NumBars < 10) {
1.136 matthew 15821: $width = 120+$NumBars*15;
15822: $xskip = 1;
15823: $bar_width = 15;
15824: } elsif ($NumBars <= 25) {
15825: $width = 120+$NumBars*11;
15826: $xskip = 5;
15827: $bar_width = 8;
15828: } elsif ($NumBars <= 50) {
15829: $width = 120+$NumBars*8;
15830: $xskip = 5;
15831: $bar_width = 4;
15832: } else {
15833: $width = 120+$NumBars*8;
15834: $xskip = 5;
15835: $bar_width = 4;
15836: }
15837: #
1.137 matthew 15838: $Max = 1 if ($Max < 1);
15839: if ( int($Max) < $Max ) {
15840: $Max++;
15841: $Max = int($Max);
15842: }
1.127 matthew 15843: $Title = '' if (! defined($Title));
15844: $xlabel = '' if (! defined($xlabel));
15845: $ylabel = '' if (! defined($ylabel));
1.369 www 15846: $ValuesHash{$id.'.title'} = &escape($Title);
15847: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15848: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15849: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15850: $ValuesHash{$id.'.NumBars'} = $NumBars;
15851: $ValuesHash{$id.'.NumSets'} = $NumSets;
15852: $ValuesHash{$id.'.PlotType'} = 'bar';
15853: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15854: $ValuesHash{$id.'.height'} = $height;
15855: $ValuesHash{$id.'.width'} = $width;
15856: $ValuesHash{$id.'.xskip'} = $xskip;
15857: $ValuesHash{$id.'.bar_width'} = $bar_width;
15858: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15859: #
1.228 matthew 15860: # Deal with other parameters
15861: while (my ($key,$value) = each(%$extra_settings)) {
15862: $ValuesHash{$id.'.'.$key} = $value;
15863: }
15864: #
1.646 raeburn 15865: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15866: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15867: }
15868:
15869: ############################################################
15870: ############################################################
15871:
15872: =pod
15873:
1.648 raeburn 15874: =item * &DrawXYGraph()
1.137 matthew 15875:
1.138 matthew 15876: Facilitates the plotting of data in an XY graph.
15877: Puts plot definition data into the users environment in order for
15878: graph.png to plot it. Returns an <img> tag for the plot.
15879:
15880: Inputs:
15881:
15882: =over 4
15883:
15884: =item $Title: string, the title of the plot
15885:
15886: =item $xlabel: string, text describing the X-axis of the plot
15887:
15888: =item $ylabel: string, text describing the Y-axis of the plot
15889:
15890: =item $Max: scalar, the maximum Y value to use in the plot
15891: If $Max is < any data point, the graph will not be rendered.
15892:
15893: =item $colors: Array ref containing the hex color codes for the data to be
15894: plotted in. If undefined, default values will be used.
15895:
15896: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15897:
15898: =item $Ydata: Array ref containing Array refs.
1.185 www 15899: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15900:
15901: =item %Values: hash indicating or overriding any default values which are
15902: passed to graph.png.
15903: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15904:
15905: =back
15906:
15907: Returns:
15908:
15909: An <img> tag which references graph.png and the appropriate identifying
15910: information for the plot.
15911:
1.137 matthew 15912: =cut
15913:
15914: ############################################################
15915: ############################################################
15916: sub DrawXYGraph {
15917: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15918: #
15919: # Create the identifier for the graph
15920: my $identifier = &get_cgi_id();
15921: my $id = 'cgi.'.$identifier;
15922: #
15923: $Title = '' if (! defined($Title));
15924: $xlabel = '' if (! defined($xlabel));
15925: $ylabel = '' if (! defined($ylabel));
15926: my %ValuesHash =
15927: (
1.369 www 15928: $id.'.title' => &escape($Title),
15929: $id.'.xlabel' => &escape($xlabel),
15930: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15931: $id.'.y_max_value'=> $Max,
15932: $id.'.labels' => join(',',@$Xlabels),
15933: $id.'.PlotType' => 'XY',
15934: );
15935: #
15936: if (defined($colors) && ref($colors) eq 'ARRAY') {
15937: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15938: }
15939: #
15940: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15941: return '';
15942: }
15943: my $NumSets=1;
1.138 matthew 15944: foreach my $array (@{$Ydata}){
1.137 matthew 15945: next if (! ref($array));
15946: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15947: }
1.138 matthew 15948: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15949: #
15950: # Deal with other parameters
15951: while (my ($key,$value) = each(%Values)) {
15952: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15953: }
15954: #
1.646 raeburn 15955: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15956: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15957: }
15958:
15959: ############################################################
15960: ############################################################
15961:
15962: =pod
15963:
1.648 raeburn 15964: =item * &DrawXYYGraph()
1.138 matthew 15965:
15966: Facilitates the plotting of data in an XY graph with two Y axes.
15967: Puts plot definition data into the users environment in order for
15968: graph.png to plot it. Returns an <img> tag for the plot.
15969:
15970: Inputs:
15971:
15972: =over 4
15973:
15974: =item $Title: string, the title of the plot
15975:
15976: =item $xlabel: string, text describing the X-axis of the plot
15977:
15978: =item $ylabel: string, text describing the Y-axis of the plot
15979:
15980: =item $colors: Array ref containing the hex color codes for the data to be
15981: plotted in. If undefined, default values will be used.
15982:
15983: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15984:
15985: =item $Ydata1: The first data set
15986:
15987: =item $Min1: The minimum value of the left Y-axis
15988:
15989: =item $Max1: The maximum value of the left Y-axis
15990:
15991: =item $Ydata2: The second data set
15992:
15993: =item $Min2: The minimum value of the right Y-axis
15994:
15995: =item $Max2: The maximum value of the left Y-axis
15996:
15997: =item %Values: hash indicating or overriding any default values which are
15998: passed to graph.png.
15999: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16000:
16001: =back
16002:
16003: Returns:
16004:
16005: An <img> tag which references graph.png and the appropriate identifying
16006: information for the plot.
1.136 matthew 16007:
16008: =cut
16009:
16010: ############################################################
16011: ############################################################
1.137 matthew 16012: sub DrawXYYGraph {
16013: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16014: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16015: #
16016: # Create the identifier for the graph
16017: my $identifier = &get_cgi_id();
16018: my $id = 'cgi.'.$identifier;
16019: #
16020: $Title = '' if (! defined($Title));
16021: $xlabel = '' if (! defined($xlabel));
16022: $ylabel = '' if (! defined($ylabel));
16023: my %ValuesHash =
16024: (
1.369 www 16025: $id.'.title' => &escape($Title),
16026: $id.'.xlabel' => &escape($xlabel),
16027: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16028: $id.'.labels' => join(',',@$Xlabels),
16029: $id.'.PlotType' => 'XY',
16030: $id.'.NumSets' => 2,
1.137 matthew 16031: $id.'.two_axes' => 1,
16032: $id.'.y1_max_value' => $Max1,
16033: $id.'.y1_min_value' => $Min1,
16034: $id.'.y2_max_value' => $Max2,
16035: $id.'.y2_min_value' => $Min2,
1.136 matthew 16036: );
16037: #
1.137 matthew 16038: if (defined($colors) && ref($colors) eq 'ARRAY') {
16039: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16040: }
16041: #
16042: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16043: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16044: return '';
16045: }
16046: my $NumSets=1;
1.137 matthew 16047: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16048: next if (! ref($array));
16049: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16050: }
16051: #
16052: # Deal with other parameters
16053: while (my ($key,$value) = each(%Values)) {
16054: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16055: }
16056: #
1.646 raeburn 16057: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16058: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16059: }
16060:
16061: ############################################################
16062: ############################################################
16063:
16064: =pod
16065:
1.157 matthew 16066: =back
16067:
1.139 matthew 16068: =head1 Statistics helper routines?
16069:
16070: Bad place for them but what the hell.
16071:
1.157 matthew 16072: =over 4
16073:
1.648 raeburn 16074: =item * &chartlink()
1.139 matthew 16075:
16076: Returns a link to the chart for a specific student.
16077:
16078: Inputs:
16079:
16080: =over 4
16081:
16082: =item $linktext: The text of the link
16083:
16084: =item $sname: The students username
16085:
16086: =item $sdomain: The students domain
16087:
16088: =back
16089:
1.157 matthew 16090: =back
16091:
1.139 matthew 16092: =cut
16093:
16094: ############################################################
16095: ############################################################
16096: sub chartlink {
16097: my ($linktext, $sname, $sdomain) = @_;
16098: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16099: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16100: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16101: '">'.$linktext.'</a>';
1.153 matthew 16102: }
16103:
16104: #######################################################
16105: #######################################################
16106:
16107: =pod
16108:
16109: =head1 Course Environment Routines
1.157 matthew 16110:
16111: =over 4
1.153 matthew 16112:
1.648 raeburn 16113: =item * &restore_course_settings()
1.153 matthew 16114:
1.648 raeburn 16115: =item * &store_course_settings()
1.153 matthew 16116:
16117: Restores/Store indicated form parameters from the course environment.
16118: Will not overwrite existing values of the form parameters.
16119:
16120: Inputs:
16121: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16122:
16123: a hash ref describing the data to be stored. For example:
16124:
16125: %Save_Parameters = ('Status' => 'scalar',
16126: 'chartoutputmode' => 'scalar',
16127: 'chartoutputdata' => 'scalar',
16128: 'Section' => 'array',
1.373 raeburn 16129: 'Group' => 'array',
1.153 matthew 16130: 'StudentData' => 'array',
16131: 'Maps' => 'array');
16132:
16133: Returns: both routines return nothing
16134:
1.631 raeburn 16135: =back
16136:
1.153 matthew 16137: =cut
16138:
16139: #######################################################
16140: #######################################################
16141: sub store_course_settings {
1.496 albertel 16142: return &store_settings($env{'request.course.id'},@_);
16143: }
16144:
16145: sub store_settings {
1.153 matthew 16146: # save to the environment
16147: # appenv the same items, just to be safe
1.300 albertel 16148: my $udom = $env{'user.domain'};
16149: my $uname = $env{'user.name'};
1.496 albertel 16150: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16151: my %SaveHash;
16152: my %AppHash;
16153: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16154: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16155: my $envname = 'environment.'.$basename;
1.258 albertel 16156: if (exists($env{'form.'.$setting})) {
1.153 matthew 16157: # Save this value away
16158: if ($type eq 'scalar' &&
1.258 albertel 16159: (! exists($env{$envname}) ||
16160: $env{$envname} ne $env{'form.'.$setting})) {
16161: $SaveHash{$basename} = $env{'form.'.$setting};
16162: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16163: } elsif ($type eq 'array') {
16164: my $stored_form;
1.258 albertel 16165: if (ref($env{'form.'.$setting})) {
1.153 matthew 16166: $stored_form = join(',',
16167: map {
1.369 www 16168: &escape($_);
1.258 albertel 16169: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16170: } else {
16171: $stored_form =
1.369 www 16172: &escape($env{'form.'.$setting});
1.153 matthew 16173: }
16174: # Determine if the array contents are the same.
1.258 albertel 16175: if ($stored_form ne $env{$envname}) {
1.153 matthew 16176: $SaveHash{$basename} = $stored_form;
16177: $AppHash{$envname} = $stored_form;
16178: }
16179: }
16180: }
16181: }
16182: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16183: $udom,$uname);
1.153 matthew 16184: if ($put_result !~ /^(ok|delayed)/) {
16185: &Apache::lonnet::logthis('unable to save form parameters, '.
16186: 'got error:'.$put_result);
16187: }
16188: # Make sure these settings stick around in this session, too
1.646 raeburn 16189: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16190: return;
16191: }
16192:
16193: sub restore_course_settings {
1.499 albertel 16194: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16195: }
16196:
16197: sub restore_settings {
16198: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16199: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16200: next if (exists($env{'form.'.$setting}));
1.496 albertel 16201: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16202: '.'.$setting;
1.258 albertel 16203: if (exists($env{$envname})) {
1.153 matthew 16204: if ($type eq 'scalar') {
1.258 albertel 16205: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16206: } elsif ($type eq 'array') {
1.258 albertel 16207: $env{'form.'.$setting} = [
1.153 matthew 16208: map {
1.369 www 16209: &unescape($_);
1.258 albertel 16210: } split(',',$env{$envname})
1.153 matthew 16211: ];
16212: }
16213: }
16214: }
1.127 matthew 16215: }
16216:
1.618 raeburn 16217: #######################################################
16218: #######################################################
16219:
16220: =pod
16221:
16222: =head1 Domain E-mail Routines
16223:
16224: =over 4
16225:
1.648 raeburn 16226: =item * &build_recipient_list()
1.618 raeburn 16227:
1.1144 raeburn 16228: Build recipient lists for following types of e-mail:
1.766 raeburn 16229: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16230: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16231: module change checking, student/employee ID conflict checks, as
16232: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16233: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16234:
16235: Inputs:
1.619 raeburn 16236: defmail (scalar - email address of default recipient),
1.1144 raeburn 16237: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16238: requestsmail, updatesmail, or idconflictsmail).
16239:
1.619 raeburn 16240: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16241:
1.619 raeburn 16242: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16243: i.e., predates configuration by DC via domainprefs.pm
16244:
16245: $requname username of requester (if mailing type is helpdeskmail)
16246:
16247: $requdom domain of requester (if mailing type is helpdeskmail)
16248:
16249: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16250:
1.618 raeburn 16251:
1.655 raeburn 16252: Returns: comma separated list of addresses to which to send e-mail.
16253:
16254: =back
1.618 raeburn 16255:
16256: =cut
16257:
16258: ############################################################
16259: ############################################################
16260: sub build_recipient_list {
1.1297 raeburn 16261: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16262: my @recipients;
1.1270 raeburn 16263: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16264: my %domconfig =
1.1270 raeburn 16265: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16266: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16267: if (exists($domconfig{'contacts'}{$mailing})) {
16268: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16269: my @contacts = ('adminemail','supportemail');
16270: foreach my $item (@contacts) {
16271: if ($domconfig{'contacts'}{$mailing}{$item}) {
16272: my $addr = $domconfig{'contacts'}{$item};
16273: if (!grep(/^\Q$addr\E$/,@recipients)) {
16274: push(@recipients,$addr);
16275: }
1.619 raeburn 16276: }
1.1270 raeburn 16277: }
16278: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16279: if ($mailing eq 'helpdeskmail') {
16280: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16281: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16282: my @ok_bccs;
16283: foreach my $bcc (@bccs) {
16284: $bcc =~ s/^\s+//g;
16285: $bcc =~ s/\s+$//g;
16286: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16287: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16288: push(@ok_bccs,$bcc);
16289: }
16290: }
16291: }
16292: if (@ok_bccs > 0) {
16293: $allbcc = join(', ',@ok_bccs);
16294: }
16295: }
16296: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16297: }
16298: }
1.766 raeburn 16299: } elsif ($origmail ne '') {
1.1270 raeburn 16300: $lastresort = $origmail;
1.618 raeburn 16301: }
1.1297 raeburn 16302: if ($mailing eq 'helpdeskmail') {
16303: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16304: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16305: my ($inststatus,$inststatus_checked);
16306: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16307: ($env{'user.domain'} ne 'public')) {
16308: $inststatus_checked = 1;
16309: $inststatus = $env{'environment.inststatus'};
16310: }
16311: unless ($inststatus_checked) {
16312: if (($requname ne '') && ($requdom ne '')) {
16313: if (($requname =~ /^$match_username$/) &&
16314: ($requdom =~ /^$match_domain$/) &&
16315: (&Apache::lonnet::domain($requdom))) {
16316: my $requhome = &Apache::lonnet::homeserver($requname,
16317: $requdom);
16318: unless ($requhome eq 'no_host') {
16319: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16320: $inststatus = $userenv{'inststatus'};
16321: $inststatus_checked = 1;
16322: }
16323: }
16324: }
16325: }
16326: unless ($inststatus_checked) {
16327: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16328: my %srch = (srchby => 'email',
16329: srchdomain => $defdom,
16330: srchterm => $reqemail,
16331: srchtype => 'exact');
16332: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16333: foreach my $uname (keys(%srch_results)) {
16334: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16335: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16336: $inststatus_checked = 1;
16337: last;
16338: }
16339: }
16340: unless ($inststatus_checked) {
16341: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16342: if ($dirsrchres eq 'ok') {
16343: foreach my $uname (keys(%srch_results)) {
16344: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16345: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16346: $inststatus_checked = 1;
16347: last;
16348: }
16349: }
16350: }
16351: }
16352: }
16353: }
16354: if ($inststatus ne '') {
16355: foreach my $status (split(/\:/,$inststatus)) {
16356: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16357: my @contacts = ('adminemail','supportemail');
16358: foreach my $item (@contacts) {
16359: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16360: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16361: if (!grep(/^\Q$addr\E$/,@recipients)) {
16362: push(@recipients,$addr);
16363: }
16364: }
16365: }
16366: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16367: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16368: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16369: my @ok_bccs;
16370: foreach my $bcc (@bccs) {
16371: $bcc =~ s/^\s+//g;
16372: $bcc =~ s/\s+$//g;
16373: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16374: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16375: push(@ok_bccs,$bcc);
16376: }
16377: }
16378: }
16379: if (@ok_bccs > 0) {
16380: $allbcc = join(', ',@ok_bccs);
16381: }
16382: }
16383: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16384: last;
16385: }
16386: }
16387: }
16388: }
16389: }
1.619 raeburn 16390: } elsif ($origmail ne '') {
1.1270 raeburn 16391: $lastresort = $origmail;
16392: }
1.1297 raeburn 16393: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16394: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16395: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16396: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16397: my %what = (
16398: perlvar => 1,
16399: );
16400: my $primary = &Apache::lonnet::domain($defdom,'primary');
16401: if ($primary) {
16402: my $gotaddr;
16403: my ($result,$returnhash) =
16404: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16405: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16406: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16407: $lastresort = $returnhash->{'lonSupportEMail'};
16408: $gotaddr = 1;
16409: }
16410: }
16411: unless ($gotaddr) {
16412: my $uintdom = &Apache::lonnet::internet_dom($primary);
16413: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16414: unless ($uintdom eq $intdom) {
16415: my %domconfig =
16416: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16417: if (ref($domconfig{'contacts'}) eq 'HASH') {
16418: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16419: my @contacts = ('adminemail','supportemail');
16420: foreach my $item (@contacts) {
16421: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16422: my $addr = $domconfig{'contacts'}{$item};
16423: if (!grep(/^\Q$addr\E$/,@recipients)) {
16424: push(@recipients,$addr);
16425: }
16426: }
16427: }
16428: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16429: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16430: }
16431: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16432: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16433: my @ok_bccs;
16434: foreach my $bcc (@bccs) {
16435: $bcc =~ s/^\s+//g;
16436: $bcc =~ s/\s+$//g;
16437: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16438: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16439: push(@ok_bccs,$bcc);
16440: }
16441: }
16442: }
16443: if (@ok_bccs > 0) {
16444: $allbcc = join(', ',@ok_bccs);
16445: }
16446: }
16447: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16448: }
16449: }
16450: }
16451: }
16452: }
16453: }
1.618 raeburn 16454: }
1.688 raeburn 16455: if (defined($defmail)) {
16456: if ($defmail ne '') {
16457: push(@recipients,$defmail);
16458: }
1.618 raeburn 16459: }
16460: if ($otheremails) {
1.619 raeburn 16461: my @others;
16462: if ($otheremails =~ /,/) {
16463: @others = split(/,/,$otheremails);
1.618 raeburn 16464: } else {
1.619 raeburn 16465: push(@others,$otheremails);
16466: }
16467: foreach my $addr (@others) {
16468: if (!grep(/^\Q$addr\E$/,@recipients)) {
16469: push(@recipients,$addr);
16470: }
1.618 raeburn 16471: }
16472: }
1.1298 raeburn 16473: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16474: if ((!@recipients) && ($lastresort ne '')) {
16475: push(@recipients,$lastresort);
16476: }
16477: } elsif ($lastresort ne '') {
16478: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16479: push(@recipients,$lastresort);
16480: }
16481: }
1.1271 raeburn 16482: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16483: if (wantarray) {
16484: return ($recipientlist,$allbcc,$addtext);
16485: } else {
16486: return $recipientlist;
16487: }
1.618 raeburn 16488: }
16489:
1.127 matthew 16490: ############################################################
16491: ############################################################
1.154 albertel 16492:
1.655 raeburn 16493: =pod
16494:
1.1224 musolffc 16495: =over 4
16496:
1.1223 musolffc 16497: =item * &mime_email()
16498:
16499: Sends an email with a possible attachment
16500:
16501: Inputs:
16502:
16503: =over 4
16504:
16505: from - Sender's email address
16506:
1.1343 raeburn 16507: replyto - Reply-To email address
16508:
1.1223 musolffc 16509: to - Email address of recipient
16510:
16511: subject - Subject of email
16512:
16513: body - Body of email
16514:
16515: cc_string - Carbon copy email address
16516:
16517: bcc - Blind carbon copy email address
16518:
16519: attachment_path - Path of file to be attached
16520:
16521: file_name - Name of file to be attached
16522:
16523: attachment_text - The body of an attachment of type "TEXT"
16524:
16525: =back
16526:
16527: =back
16528:
16529: =cut
16530:
16531: ############################################################
16532: ############################################################
16533:
16534: sub mime_email {
1.1343 raeburn 16535: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16536: $file_name,$attachment_text) = @_;
16537:
1.1223 musolffc 16538: my $msg = MIME::Lite->new(
16539: From => $from,
16540: To => $to,
16541: Subject => $subject,
16542: Type =>'TEXT',
16543: Data => $body,
16544: );
1.1343 raeburn 16545: if ($replyto ne '') {
16546: $msg->add("Reply-To" => $replyto);
16547: }
1.1223 musolffc 16548: if ($cc_string ne '') {
16549: $msg->add("Cc" => $cc_string);
16550: }
16551: if ($bcc ne '') {
16552: $msg->add("Bcc" => $bcc);
16553: }
16554: $msg->attr("content-type" => "text/plain");
16555: $msg->attr("content-type.charset" => "UTF-8");
16556: # Attach file if given
16557: if ($attachment_path) {
16558: unless ($file_name) {
16559: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16560: }
16561: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16562: $msg->attach(Type => $type,
16563: Path => $attachment_path,
16564: Filename => $file_name
16565: );
16566: # Otherwise attach text if given
16567: } elsif ($attachment_text) {
16568: $msg->attach(Type => 'TEXT',
16569: Data => $attachment_text);
16570: }
16571: # Send it
16572: $msg->send('sendmail');
16573: }
16574:
16575: ############################################################
16576: ############################################################
16577:
16578: =pod
16579:
1.655 raeburn 16580: =head1 Course Catalog Routines
16581:
16582: =over 4
16583:
16584: =item * &gather_categories()
16585:
16586: Converts category definitions - keys of categories hash stored in
16587: coursecategories in configuration.db on the primary library server in a
16588: domain - to an array. Also generates javascript and idx hash used to
16589: generate Domain Coordinator interface for editing Course Categories.
16590:
16591: Inputs:
1.663 raeburn 16592:
1.655 raeburn 16593: categories (reference to hash of category definitions).
1.663 raeburn 16594:
1.655 raeburn 16595: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16596: categories and subcategories).
1.663 raeburn 16597:
1.655 raeburn 16598: idx (reference to hash of counters used in Domain Coordinator interface for
16599: editing Course Categories).
1.663 raeburn 16600:
1.655 raeburn 16601: jsarray (reference to array of categories used to create Javascript arrays for
16602: Domain Coordinator interface for editing Course Categories).
16603:
16604: Returns: nothing
16605:
16606: Side effects: populates cats, idx and jsarray.
16607:
16608: =cut
16609:
16610: sub gather_categories {
16611: my ($categories,$cats,$idx,$jsarray) = @_;
16612: my %counters;
16613: my $num = 0;
16614: foreach my $item (keys(%{$categories})) {
16615: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16616: if ($container eq '' && $depth == 0) {
16617: $cats->[$depth][$categories->{$item}] = $cat;
16618: } else {
16619: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16620: }
16621: my ($escitem,$tail) = split(/:/,$item,2);
16622: if ($counters{$tail} eq '') {
16623: $counters{$tail} = $num;
16624: $num ++;
16625: }
16626: if (ref($idx) eq 'HASH') {
16627: $idx->{$item} = $counters{$tail};
16628: }
16629: if (ref($jsarray) eq 'ARRAY') {
16630: push(@{$jsarray->[$counters{$tail}]},$item);
16631: }
16632: }
16633: return;
16634: }
16635:
16636: =pod
16637:
16638: =item * &extract_categories()
16639:
16640: Used to generate breadcrumb trails for course categories.
16641:
16642: Inputs:
1.663 raeburn 16643:
1.655 raeburn 16644: categories (reference to hash of category definitions).
1.663 raeburn 16645:
1.655 raeburn 16646: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16647: categories and subcategories).
1.663 raeburn 16648:
1.655 raeburn 16649: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16650:
1.655 raeburn 16651: allitems (reference to hash - key is category key
16652: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16653:
1.655 raeburn 16654: idx (reference to hash of counters used in Domain Coordinator interface for
16655: editing Course Categories).
1.663 raeburn 16656:
1.655 raeburn 16657: jsarray (reference to array of categories used to create Javascript arrays for
16658: Domain Coordinator interface for editing Course Categories).
16659:
1.665 raeburn 16660: subcats (reference to hash of arrays containing all subcategories within each
16661: category, -recursive)
16662:
1.1321 raeburn 16663: maxd (reference to hash used to hold max depth for all top-level categories).
16664:
1.655 raeburn 16665: Returns: nothing
16666:
16667: Side effects: populates trails and allitems hash references.
16668:
16669: =cut
16670:
16671: sub extract_categories {
1.1321 raeburn 16672: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16673: if (ref($categories) eq 'HASH') {
16674: &gather_categories($categories,$cats,$idx,$jsarray);
16675: if (ref($cats->[0]) eq 'ARRAY') {
16676: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16677: my $name = $cats->[0][$i];
16678: my $item = &escape($name).'::0';
16679: my $trailstr;
16680: if ($name eq 'instcode') {
16681: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16682: } elsif ($name eq 'communities') {
16683: $trailstr = &mt('Communities');
1.1239 raeburn 16684: } elsif ($name eq 'placement') {
16685: $trailstr = &mt('Placement Tests');
1.655 raeburn 16686: } else {
16687: $trailstr = $name;
16688: }
16689: if ($allitems->{$item} eq '') {
16690: push(@{$trails},$trailstr);
16691: $allitems->{$item} = scalar(@{$trails})-1;
16692: }
16693: my @parents = ($name);
16694: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16695: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16696: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16697: if (ref($subcats) eq 'HASH') {
16698: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16699: }
1.1321 raeburn 16700: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16701: }
16702: } else {
16703: if (ref($subcats) eq 'HASH') {
16704: $subcats->{$item} = [];
1.655 raeburn 16705: }
1.1321 raeburn 16706: if (ref($maxd) eq 'HASH') {
16707: $maxd->{$name} = 1;
16708: }
1.655 raeburn 16709: }
16710: }
16711: }
16712: }
16713: return;
16714: }
16715:
16716: =pod
16717:
1.1162 raeburn 16718: =item * &recurse_categories()
1.655 raeburn 16719:
16720: Recursively used to generate breadcrumb trails for course categories.
16721:
16722: Inputs:
1.663 raeburn 16723:
1.655 raeburn 16724: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16725: categories and subcategories).
1.663 raeburn 16726:
1.655 raeburn 16727: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16728:
16729: category (current course category, for which breadcrumb trail is being generated).
16730:
16731: trails (reference to array of breadcrumb trails for each category).
16732:
1.655 raeburn 16733: allitems (reference to hash - key is category key
16734: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16735:
1.655 raeburn 16736: parents (array containing containers directories for current category,
16737: back to top level).
16738:
16739: Returns: nothing
16740:
16741: Side effects: populates trails and allitems hash references
16742:
16743: =cut
16744:
16745: sub recurse_categories {
1.1321 raeburn 16746: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16747: my $shallower = $depth - 1;
16748: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16749: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16750: my $name = $cats->[$depth]{$category}[$k];
16751: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16752: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16753: if ($allitems->{$item} eq '') {
16754: push(@{$trails},$trailstr);
16755: $allitems->{$item} = scalar(@{$trails})-1;
16756: }
16757: my $deeper = $depth+1;
16758: push(@{$parents},$category);
1.665 raeburn 16759: if (ref($subcats) eq 'HASH') {
16760: my $subcat = &escape($name).':'.$category.':'.$depth;
16761: for (my $j=@{$parents}; $j>=0; $j--) {
16762: my $higher;
16763: if ($j > 0) {
16764: $higher = &escape($parents->[$j]).':'.
16765: &escape($parents->[$j-1]).':'.$j;
16766: } else {
16767: $higher = &escape($parents->[$j]).'::'.$j;
16768: }
16769: push(@{$subcats->{$higher}},$subcat);
16770: }
16771: }
16772: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16773: $subcats,$maxd);
1.655 raeburn 16774: pop(@{$parents});
16775: }
16776: } else {
16777: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16778: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16779: if ($allitems->{$item} eq '') {
16780: push(@{$trails},$trailstr);
16781: $allitems->{$item} = scalar(@{$trails})-1;
16782: }
1.1321 raeburn 16783: if (ref($maxd) eq 'HASH') {
16784: if ($depth > $maxd->{$parents->[0]}) {
16785: $maxd->{$parents->[0]} = $depth;
16786: }
16787: }
1.655 raeburn 16788: }
16789: return;
16790: }
16791:
1.663 raeburn 16792: =pod
16793:
1.1162 raeburn 16794: =item * &assign_categories_table()
1.663 raeburn 16795:
16796: Create a datatable for display of hierarchical categories in a domain,
16797: with checkboxes to allow a course to be categorized.
16798:
16799: Inputs:
16800:
16801: cathash - reference to hash of categories defined for the domain (from
16802: configuration.db)
16803:
16804: currcat - scalar with an & separated list of categories assigned to a course.
16805:
1.919 raeburn 16806: type - scalar contains course type (Course or Community).
16807:
1.1260 raeburn 16808: disabled - scalar (optional) contains disabled="disabled" if input elements are
16809: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16810:
1.663 raeburn 16811: Returns: $output (markup to be displayed)
16812:
16813: =cut
16814:
16815: sub assign_categories_table {
1.1259 raeburn 16816: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16817: my $output;
16818: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16819: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16820: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16821: $maxdepth = scalar(@cats);
16822: if (@cats > 0) {
16823: my $itemcount = 0;
16824: if (ref($cats[0]) eq 'ARRAY') {
16825: my @currcategories;
16826: if ($currcat ne '') {
16827: @currcategories = split('&',$currcat);
16828: }
1.919 raeburn 16829: my $table;
1.663 raeburn 16830: for (my $i=0; $i<@{$cats[0]}; $i++) {
16831: my $parent = $cats[0][$i];
1.919 raeburn 16832: next if ($parent eq 'instcode');
16833: if ($type eq 'Community') {
16834: next unless ($parent eq 'communities');
1.1239 raeburn 16835: } elsif ($type eq 'Placement') {
16836: next unless ($parent eq 'placement');
1.919 raeburn 16837: } else {
1.1239 raeburn 16838: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16839: }
1.663 raeburn 16840: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16841: my $item = &escape($parent).'::0';
16842: my $checked = '';
16843: if (@currcategories > 0) {
16844: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16845: $checked = ' checked="checked"';
1.663 raeburn 16846: }
16847: }
1.919 raeburn 16848: my $parent_title = $parent;
16849: if ($parent eq 'communities') {
16850: $parent_title = &mt('Communities');
1.1239 raeburn 16851: } elsif ($parent eq 'placement') {
16852: $parent_title = &mt('Placement Tests');
1.919 raeburn 16853: }
16854: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16855: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16856: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16857: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16858: my $depth = 1;
16859: push(@path,$parent);
1.1259 raeburn 16860: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16861: pop(@path);
1.919 raeburn 16862: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16863: $itemcount ++;
16864: }
1.919 raeburn 16865: if ($itemcount) {
16866: $output = &Apache::loncommon::start_data_table().
16867: $table.
16868: &Apache::loncommon::end_data_table();
16869: }
1.663 raeburn 16870: }
16871: }
16872: }
16873: return $output;
16874: }
16875:
16876: =pod
16877:
1.1162 raeburn 16878: =item * &assign_category_rows()
1.663 raeburn 16879:
16880: Create a datatable row for display of nested categories in a domain,
16881: with checkboxes to allow a course to be categorized,called recursively.
16882:
16883: Inputs:
16884:
16885: itemcount - track row number for alternating colors
16886:
16887: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16888: categories and subcategories.
16889:
16890: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16891:
16892: parent - parent of current category item
16893:
16894: path - Array containing all categories back up through the hierarchy from the
16895: current category to the top level.
16896:
16897: currcategories - reference to array of current categories assigned to the course
16898:
1.1260 raeburn 16899: disabled - scalar (optional) contains disabled="disabled" if input elements are
16900: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16901:
1.663 raeburn 16902: Returns: $output (markup to be displayed).
16903:
16904: =cut
16905:
16906: sub assign_category_rows {
1.1259 raeburn 16907: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16908: my ($text,$name,$item,$chgstr);
16909: if (ref($cats) eq 'ARRAY') {
16910: my $maxdepth = scalar(@{$cats});
16911: if (ref($cats->[$depth]) eq 'HASH') {
16912: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16913: my $numchildren = @{$cats->[$depth]{$parent}};
16914: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16915: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16916: for (my $j=0; $j<$numchildren; $j++) {
16917: $name = $cats->[$depth]{$parent}[$j];
16918: $item = &escape($name).':'.&escape($parent).':'.$depth;
16919: my $deeper = $depth+1;
16920: my $checked = '';
16921: if (ref($currcategories) eq 'ARRAY') {
16922: if (@{$currcategories} > 0) {
16923: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16924: $checked = ' checked="checked"';
1.663 raeburn 16925: }
16926: }
16927: }
1.664 raeburn 16928: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16929: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16930: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16931: '<input type="hidden" name="catname" value="'.$name.'" />'.
16932: '</td><td>';
1.663 raeburn 16933: if (ref($path) eq 'ARRAY') {
16934: push(@{$path},$name);
1.1259 raeburn 16935: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16936: pop(@{$path});
16937: }
16938: $text .= '</td></tr>';
16939: }
16940: $text .= '</table></td>';
16941: }
16942: }
16943: }
16944: return $text;
16945: }
16946:
1.1181 raeburn 16947: =pod
16948:
16949: =back
16950:
16951: =cut
16952:
1.655 raeburn 16953: ############################################################
16954: ############################################################
16955:
16956:
1.443 albertel 16957: sub commit_customrole {
1.1408 raeburn 16958: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16959: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16960: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16961: $context,$othdomby,$requester);
1.630 raeburn 16962: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16963: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16964: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16965: if (wantarray) {
16966: return ($output,$result);
16967: } else {
16968: return $output;
16969: }
1.443 albertel 16970: }
16971:
16972: sub commit_standardrole {
1.1408 raeburn 16973: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16974: $othdomby,$requester) = @_;
1.1399 raeburn 16975: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16976: if ($context eq 'auto') {
16977: $linefeed = "\n";
16978: } else {
16979: $linefeed = "<br />\n";
16980: }
1.443 albertel 16981: if ($three eq 'st') {
1.1399 raeburn 16982: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16983: $one,$two,$sec,$context,$credits,$othdomby,
16984: $requester);
1.541 raeburn 16985: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16986: ($result eq 'unknown_course') || ($result eq 'refused')) {
16987: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16988: } else {
1.541 raeburn 16989: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16990: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16991: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16992: if ($context eq 'auto') {
16993: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16994: } else {
16995: $output .= '<b>'.$result.'</b>'.$linefeed.
16996: &mt('Add to classlist').': <b>ok</b>';
16997: }
16998: $output .= $linefeed;
1.443 albertel 16999: }
17000: } else {
17001: $output = &mt('Assigning').' '.$three.' in '.$url.
17002: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17003: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17004: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17005: '','',$context,$othdomby,$requester);
1.541 raeburn 17006: if ($context eq 'auto') {
17007: $output .= $result.$linefeed;
17008: } else {
17009: $output .= '<b>'.$result.'</b>'.$linefeed;
17010: }
1.443 albertel 17011: }
1.1399 raeburn 17012: if (wantarray) {
17013: return ($output,$result);
17014: } else {
17015: return $output;
17016: }
1.443 albertel 17017: }
17018:
17019: sub commit_studentrole {
1.1116 raeburn 17020: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17021: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17022: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17023: if ($context eq 'auto') {
17024: $linefeed = "\n";
17025: } else {
17026: $linefeed = '<br />'."\n";
17027: }
1.443 albertel 17028: if (defined($one) && defined($two)) {
17029: my $cid=$one.'_'.$two;
17030: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17031: my $secchange = 0;
17032: my $expire_role_result;
17033: my $modify_section_result;
1.628 raeburn 17034: if ($oldsec ne '-1') {
17035: if ($oldsec ne $sec) {
1.443 albertel 17036: $secchange = 1;
1.628 raeburn 17037: my $now = time;
1.443 albertel 17038: my $uurl='/'.$cid;
17039: $uurl=~s/\_/\//g;
17040: if ($oldsec) {
17041: $uurl.='/'.$oldsec;
17042: }
1.626 raeburn 17043: $oldsecurl = $uurl;
1.628 raeburn 17044: $expire_role_result =
1.1408 raeburn 17045: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17046: '','','',$context,$othdomby,$requester);
17047: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17048: if ($expire_role_result eq 'refused') {
17049: my @roles = ('st');
17050: my @statuses = ('previous');
17051: my @roledoms = ($one);
17052: my $withsec = 1;
17053: my %roleshash =
17054: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17055: \@statuses,\@roles,\@roledoms,$withsec);
17056: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17057: my ($oldstart,$oldend) =
17058: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17059: if ($oldend > 0 && $oldend <= $now) {
17060: $expire_role_result = 'ok';
17061: }
17062: }
17063: }
17064: }
1.443 albertel 17065: $result = $expire_role_result;
17066: }
17067: }
17068: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17069: $modify_section_result =
17070: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17071: undef,undef,undef,$sec,
17072: $end,$start,'','',$cid,
1.1408 raeburn 17073: '',$context,$credits,'',
17074: $othdomby,$requester);
1.443 albertel 17075: if ($modify_section_result =~ /^ok/) {
17076: if ($secchange == 1) {
1.628 raeburn 17077: if ($sec eq '') {
17078: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17079: } else {
17080: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17081: }
1.443 albertel 17082: } elsif ($oldsec eq '-1') {
1.628 raeburn 17083: if ($sec eq '') {
17084: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17085: } else {
17086: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17087: }
1.443 albertel 17088: } else {
1.628 raeburn 17089: if ($sec eq '') {
17090: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17091: } else {
17092: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17093: }
1.443 albertel 17094: }
17095: } else {
1.1115 raeburn 17096: if ($secchange) {
1.628 raeburn 17097: $$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;
17098: } else {
17099: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17100: }
1.443 albertel 17101: }
17102: $result = $modify_section_result;
17103: } elsif ($secchange == 1) {
1.628 raeburn 17104: if ($oldsec eq '') {
1.1103 raeburn 17105: $$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 17106: } else {
17107: $$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;
17108: }
1.626 raeburn 17109: if ($expire_role_result eq 'refused') {
17110: my $newsecurl = '/'.$cid;
17111: $newsecurl =~ s/\_/\//g;
17112: if ($sec ne '') {
17113: $newsecurl.='/'.$sec;
17114: }
17115: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17116: if ($sec eq '') {
17117: $$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;
17118: } else {
17119: $$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;
17120: }
17121: }
17122: }
1.443 albertel 17123: }
17124: } else {
1.626 raeburn 17125: $$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 17126: $result = "error: incomplete course id\n";
17127: }
17128: return $result;
17129: }
17130:
1.1108 raeburn 17131: sub show_role_extent {
17132: my ($scope,$context,$role) = @_;
17133: $scope =~ s{^/}{};
17134: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17135: push(@courseroles,'co');
17136: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17137: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17138: $scope =~ s{/}{_};
17139: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17140: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17141: my ($audom,$auname) = split(/\//,$scope);
17142: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17143: &Apache::loncommon::plainname($auname,$audom).'</span>');
17144: } else {
17145: $scope =~ s{/$}{};
17146: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17147: &Apache::lonnet::domain($scope,'description').'</span>');
17148: }
17149: }
17150:
1.443 albertel 17151: ############################################################
17152: ############################################################
17153:
1.566 albertel 17154: sub check_clone {
1.578 raeburn 17155: my ($args,$linefeed) = @_;
1.566 albertel 17156: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17157: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17158: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17159: my $clonetitle;
17160: my @clonemsg;
1.566 albertel 17161: my $can_clone = 0;
1.944 raeburn 17162: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17163: if ($lctype ne 'community') {
17164: $lctype = 'course';
17165: }
1.566 albertel 17166: if ($clonehome eq 'no_host') {
1.944 raeburn 17167: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17168: push(@clonemsg,({
17169: mt => 'No new community created.',
17170: args => [],
17171: },
17172: {
17173: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17174: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17175: }));
1.908 raeburn 17176: } else {
1.1344 raeburn 17177: push(@clonemsg,({
17178: mt => 'No new course created.',
17179: args => [],
17180: },
17181: {
17182: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17183: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17184: }));
17185: }
1.566 albertel 17186: } else {
17187: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17188: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17189: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17190: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17191: push(@clonemsg,({
17192: mt => 'No new community created.',
17193: args => [],
17194: },
17195: {
17196: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17197: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17198: }));
17199: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17200: }
17201: }
1.1262 raeburn 17202: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17203: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17204: $can_clone = 1;
17205: } else {
1.1221 raeburn 17206: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17207: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17208: if ($clonehash{'cloners'} eq '') {
17209: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17210: if ($domdefs{'canclone'}) {
17211: unless ($domdefs{'canclone'} eq 'none') {
17212: if ($domdefs{'canclone'} eq 'domain') {
17213: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17214: $can_clone = 1;
17215: }
17216: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17217: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17218: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17219: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17220: $can_clone = 1;
17221: }
17222: }
17223: }
17224: }
1.578 raeburn 17225: } else {
1.1221 raeburn 17226: my @cloners = split(/,/,$clonehash{'cloners'});
17227: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17228: $can_clone = 1;
1.1221 raeburn 17229: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17230: $can_clone = 1;
1.1225 raeburn 17231: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17232: $can_clone = 1;
1.1221 raeburn 17233: }
17234: unless ($can_clone) {
1.1225 raeburn 17235: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17236: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17237: my (%gotdomdefaults,%gotcodedefaults);
17238: foreach my $cloner (@cloners) {
17239: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17240: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17241: my (%codedefaults,@code_order);
17242: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17243: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17244: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17245: }
17246: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17247: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17248: }
17249: } else {
17250: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17251: \%codedefaults,
17252: \@code_order);
17253: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17254: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17255: }
17256: if (@code_order > 0) {
17257: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17258: $cloner,$clonehash{'internal.coursecode'},
17259: $args->{'crscode'})) {
17260: $can_clone = 1;
17261: last;
17262: }
17263: }
17264: }
17265: }
17266: }
1.1225 raeburn 17267: }
17268: }
17269: unless ($can_clone) {
17270: my $ccrole = 'cc';
17271: if ($args->{'crstype'} eq 'Community') {
17272: $ccrole = 'co';
17273: }
17274: my %roleshash =
17275: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17276: $args->{'ccdomain'},
17277: 'userroles',['active'],[$ccrole],
17278: [$args->{'clonedomain'}]);
17279: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17280: $can_clone = 1;
17281: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17282: $args->{'ccuname'},$args->{'ccdomain'})) {
17283: $can_clone = 1;
1.1221 raeburn 17284: }
17285: }
17286: unless ($can_clone) {
17287: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17288: push(@clonemsg,({
17289: mt => 'No new community created.',
17290: args => [],
17291: },
17292: {
17293: 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]).',
17294: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17295: }));
1.942 raeburn 17296: } else {
1.1344 raeburn 17297: push(@clonemsg,({
17298: mt => 'No new course created.',
17299: args => [],
17300: },
17301: {
17302: 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]).',
17303: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17304: }));
1.1221 raeburn 17305: }
1.566 albertel 17306: }
1.578 raeburn 17307: }
1.566 albertel 17308: }
1.1344 raeburn 17309: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17310: }
17311:
1.444 albertel 17312: sub construct_course {
1.1262 raeburn 17313: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17314: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17315: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17316: my $linefeed = '<br />'."\n";
17317: if ($context eq 'auto') {
17318: $linefeed = "\n";
17319: }
1.566 albertel 17320:
17321: #
17322: # Are we cloning?
17323: #
1.1344 raeburn 17324: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17325: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17326: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17327: if (!$can_clone) {
1.1344 raeburn 17328: return (0,$outcome,$clonemsgref);
1.566 albertel 17329: }
17330: }
17331:
1.444 albertel 17332: #
17333: # Open course
17334: #
1.1239 raeburn 17335: my $showncrstype;
17336: if ($args->{'crstype'} eq 'Placement') {
17337: $showncrstype = 'placement test';
17338: } else {
17339: $showncrstype = lc($args->{'crstype'});
17340: }
1.444 albertel 17341: my %cenv=();
17342: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17343: $args->{'cdescr'},
17344: $args->{'curl'},
17345: $args->{'course_home'},
17346: $args->{'nonstandard'},
17347: $args->{'crscode'},
17348: $args->{'ccuname'}.':'.
17349: $args->{'ccdomain'},
1.882 raeburn 17350: $args->{'crstype'},
1.1344 raeburn 17351: $cnum,$context,$category,
17352: $callercontext);
1.444 albertel 17353:
17354: # Note: The testing routines depend on this being output; see
17355: # Utils::Course. This needs to at least be output as a comment
17356: # if anyone ever decides to not show this, and Utils::Course::new
17357: # will need to be suitably modified.
1.1344 raeburn 17358: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17359: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17360: } else {
17361: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17362: }
1.943 raeburn 17363: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17364: return (0,$outcome,$clonemsgref);
1.943 raeburn 17365: }
17366:
1.444 albertel 17367: #
17368: # Check if created correctly
17369: #
1.479 albertel 17370: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17371: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17372: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17373: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17374: $outcome .= &mt_user($user_lh,
17375: 'Course creation failed, unrecognized course home server.');
17376: } else {
17377: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17378: }
17379: $outcome .= $linefeed;
17380: return (0,$outcome,$clonemsgref);
1.943 raeburn 17381: }
1.541 raeburn 17382: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17383:
1.444 albertel 17384: #
1.566 albertel 17385: # Do the cloning
17386: #
1.1344 raeburn 17387: my @clonemsg;
1.566 albertel 17388: if ($can_clone && $cloneid) {
1.1344 raeburn 17389: push(@clonemsg,
17390: {
17391: mt => 'Created [_1] by cloning from [_2]',
17392: args => [$showncrstype,$clonetitle],
17393: });
1.566 albertel 17394: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17395: # Copy all files
1.1344 raeburn 17396: my @info =
17397: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17398: $args->{'dateshift'},$args->{'crscode'},
17399: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17400: $args->{'tinyurls'});
17401: if (@info) {
17402: push(@clonemsg,@info);
17403: }
1.444 albertel 17404: # Restore URL
1.566 albertel 17405: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17406: # Restore title
1.566 albertel 17407: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17408: # Restore creation date, creator and creation context.
17409: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17410: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17411: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17412: # Mark as cloned
1.566 albertel 17413: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17414: # Need to clone grading mode
17415: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17416: $cenv{'grading'}=$newenv{'grading'};
17417: # Do not clone these environment entries
17418: &Apache::lonnet::del('environment',
17419: ['default_enrollment_start_date',
17420: 'default_enrollment_end_date',
17421: 'question.email',
17422: 'policy.email',
17423: 'comment.email',
17424: 'pch.users.denied',
1.725 raeburn 17425: 'plc.users.denied',
17426: 'hidefromcat',
1.1121 raeburn 17427: 'checkforpriv',
1.1355 raeburn 17428: 'categories'],
1.638 www 17429: $$crsudom,$$crsunum);
1.1170 raeburn 17430: if ($args->{'textbook'}) {
17431: $cenv{'internal.textbook'} = $args->{'textbook'};
17432: }
1.444 albertel 17433: }
1.566 albertel 17434:
1.444 albertel 17435: #
17436: # Set environment (will override cloned, if existing)
17437: #
17438: my @sections = ();
17439: my @xlists = ();
17440: if ($args->{'crstype'}) {
17441: $cenv{'type'}=$args->{'crstype'};
17442: }
1.1371 raeburn 17443: if ($args->{'lti'}) {
17444: $cenv{'internal.lti'}=$args->{'lti'};
17445: }
1.444 albertel 17446: if ($args->{'crsid'}) {
17447: $cenv{'courseid'}=$args->{'crsid'};
17448: }
17449: if ($args->{'crscode'}) {
17450: $cenv{'internal.coursecode'}=$args->{'crscode'};
17451: }
17452: if ($args->{'crsquota'} ne '') {
17453: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17454: } else {
17455: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17456: }
17457: if ($args->{'ccuname'}) {
17458: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17459: ':'.$args->{'ccdomain'};
17460: } else {
17461: $cenv{'internal.courseowner'} = $args->{'curruser'};
17462: }
1.1116 raeburn 17463: if ($args->{'defaultcredits'}) {
17464: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17465: }
1.444 albertel 17466: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17467: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17468: if ($args->{'crssections'}) {
17469: $cenv{'internal.sectionnums'} = '';
17470: if ($args->{'crssections'} =~ m/,/) {
17471: @sections = split/,/,$args->{'crssections'};
17472: } else {
17473: $sections[0] = $args->{'crssections'};
17474: }
17475: if (@sections > 0) {
17476: foreach my $item (@sections) {
17477: my ($sec,$gp) = split/:/,$item;
17478: my $class = $args->{'crscode'}.$sec;
17479: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17480: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17481: if ($addcheck eq 'ok') {
17482: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17483: push(@oklcsecs,$gp);
17484: }
17485: } else {
1.1263 raeburn 17486: push(@badclasses,$class);
1.444 albertel 17487: }
17488: }
17489: $cenv{'internal.sectionnums'} =~ s/,$//;
17490: }
17491: }
17492: # do not hide course coordinator from staff listing,
17493: # even if privileged
17494: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17495: # add course coordinator's domain to domains to check for privileged users
17496: # if different to course domain
17497: if ($$crsudom ne $args->{'ccdomain'}) {
17498: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17499: }
1.444 albertel 17500: # add crosslistings
17501: if ($args->{'crsxlist'}) {
17502: $cenv{'internal.crosslistings'}='';
17503: if ($args->{'crsxlist'} =~ m/,/) {
17504: @xlists = split/,/,$args->{'crsxlist'};
17505: } else {
17506: $xlists[0] = $args->{'crsxlist'};
17507: }
17508: if (@xlists > 0) {
17509: foreach my $item (@xlists) {
17510: my ($xl,$gp) = split/:/,$item;
17511: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17512: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17513: if ($addcheck eq 'ok') {
17514: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17515: push(@oklcsecs,$gp);
17516: }
17517: } else {
1.1263 raeburn 17518: push(@badclasses,$xl);
1.444 albertel 17519: }
17520: }
17521: $cenv{'internal.crosslistings'} =~ s/,$//;
17522: }
17523: }
17524: if ($args->{'autoadds'}) {
17525: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17526: }
17527: if ($args->{'autodrops'}) {
17528: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17529: }
17530: # check for notification of enrollment changes
17531: my @notified = ();
17532: if ($args->{'notify_owner'}) {
17533: if ($args->{'ccuname'} ne '') {
17534: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17535: }
17536: }
17537: if ($args->{'notify_dc'}) {
17538: if ($uname ne '') {
1.630 raeburn 17539: push(@notified,$uname.':'.$udom);
1.444 albertel 17540: }
17541: }
17542: if (@notified > 0) {
17543: my $notifylist;
17544: if (@notified > 1) {
17545: $notifylist = join(',',@notified);
17546: } else {
17547: $notifylist = $notified[0];
17548: }
17549: $cenv{'internal.notifylist'} = $notifylist;
17550: }
17551: if (@badclasses > 0) {
17552: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17553: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17554: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17555: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17556: );
1.1264 raeburn 17557: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17558: &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 17559: if ($context eq 'auto') {
17560: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17561: } else {
1.566 albertel 17562: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17563: }
17564: foreach my $item (@badclasses) {
1.541 raeburn 17565: if ($context eq 'auto') {
1.1261 raeburn 17566: $outcome .= " - $item\n";
1.541 raeburn 17567: } else {
1.1261 raeburn 17568: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17569: }
1.1261 raeburn 17570: }
17571: if ($context eq 'auto') {
17572: $outcome .= $linefeed;
17573: } else {
17574: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17575: }
1.444 albertel 17576: }
17577: if ($args->{'no_end_date'}) {
17578: $args->{'endaccess'} = 0;
17579: }
1.1412 raeburn 17580: # If an official course with institutional sections is created by cloning
17581: # an existing course, section-specific hiding of course totals in student's
17582: # view of grades as copied from cloned course, will be checked for valid
17583: # sections.
17584: if (($can_clone && $cloneid) &&
17585: ($cenv{'internal.coursecode'} ne '') &&
17586: ($cenv{'grading'} eq 'standard') &&
17587: ($cenv{'hidetotals'} ne '') &&
17588: ($cenv{'hidetotals'} ne 'all')) {
17589: my @hidesecs;
17590: my $deletehidetotals;
17591: if (@oklcsecs) {
17592: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17593: if (grep(/^\Q$sec$/,@oklcsecs)) {
17594: push(@hidesecs,$sec);
17595: }
17596: }
17597: if (@hidesecs) {
17598: $cenv{'hidetotals'} = join(',',@hidesecs);
17599: } else {
17600: $deletehidetotals = 1;
17601: }
17602: } else {
17603: $deletehidetotals = 1;
17604: }
17605: if ($deletehidetotals) {
17606: delete($cenv{'hidetotals'});
17607: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17608: }
17609: }
1.444 albertel 17610: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17611: $cenv{'internal.autoend'}=$args->{'enrollend'};
17612: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17613: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17614: if ($args->{'showphotos'}) {
17615: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17616: }
17617: $cenv{'internal.authtype'} = $args->{'authtype'};
17618: $cenv{'internal.autharg'} = $args->{'autharg'};
17619: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17620: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17621: 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');
17622: if ($context eq 'auto') {
17623: $outcome .= $krb_msg;
17624: } else {
1.566 albertel 17625: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17626: }
17627: $outcome .= $linefeed;
1.444 albertel 17628: }
17629: }
17630: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17631: if ($args->{'setpolicy'}) {
17632: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17633: }
17634: if ($args->{'setcontent'}) {
17635: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17636: }
1.1251 raeburn 17637: if ($args->{'setcomment'}) {
17638: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17639: }
1.444 albertel 17640: }
17641: if ($args->{'reshome'}) {
17642: $cenv{'reshome'}=$args->{'reshome'}.'/';
17643: $cenv{'reshome'}=~s/\/+$/\//;
17644: }
17645: #
17646: # course has keyed access
17647: #
17648: if ($args->{'setkeys'}) {
17649: $cenv{'keyaccess'}='yes';
17650: }
17651: # if specified, key authority is not course, but user
17652: # only active if keyaccess is yes
17653: if ($args->{'keyauth'}) {
1.487 albertel 17654: my ($user,$domain) = split(':',$args->{'keyauth'});
17655: $user = &LONCAPA::clean_username($user);
17656: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17657: if ($user ne '' && $domain ne '') {
1.487 albertel 17658: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17659: }
17660: }
17661:
1.1166 raeburn 17662: #
1.1167 raeburn 17663: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17664: #
17665: if ($args->{'uniquecode'}) {
17666: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17667: if ($code) {
17668: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17669: my %crsinfo =
17670: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17671: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17672: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17673: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17674: }
1.1166 raeburn 17675: if (ref($coderef)) {
17676: $$coderef = $code;
17677: }
17678: }
17679: }
17680:
1.444 albertel 17681: if ($args->{'disresdis'}) {
17682: $cenv{'pch.roles.denied'}='st';
17683: }
17684: if ($args->{'disablechat'}) {
17685: $cenv{'plc.roles.denied'}='st';
17686: }
17687:
17688: # Record we've not yet viewed the Course Initialization Helper for this
17689: # course
17690: $cenv{'course.helper.not.run'} = 1;
17691: #
17692: # Use new Randomseed
17693: #
17694: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17695: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17696: #
17697: # The encryption code and receipt prefix for this course
17698: #
17699: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17700: $cenv{'internal.encpref'}=100+int(9*rand(99));
17701: #
17702: # By default, use standard grading
17703: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17704:
1.541 raeburn 17705: $outcome .= $linefeed.&mt('Setting environment').': '.
17706: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17707: #
17708: # Open all assignments
17709: #
17710: if ($args->{'openall'}) {
1.1341 raeburn 17711: my $opendate = time;
17712: if ($args->{'openallfrom'} =~ /^\d+$/) {
17713: $opendate = $args->{'openallfrom'};
17714: }
1.444 albertel 17715: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17716: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17717: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17718: $outcome .= &mt('All assignments open starting [_1]',
17719: &Apache::lonlocal::locallocaltime($opendate)).': '.
17720: &Apache::lonnet::cput
17721: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17722: }
17723: #
17724: # Set first page
17725: #
17726: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17727: || ($cloneid)) {
17728: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17729:
17730: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17731: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17732:
1.444 albertel 17733: $outcome .= ($fatal?$errtext:'read ok').' - ';
17734: my $title; my $url;
17735: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17736: $title=&mt('Syllabus');
1.444 albertel 17737: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17738: } else {
1.963 raeburn 17739: $title=&mt('Table of Contents');
1.444 albertel 17740: $url='/adm/navmaps';
17741: }
1.445 albertel 17742:
17743: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17744: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17745:
17746: if ($errtext) { $fatal=2; }
1.541 raeburn 17747: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17748: }
1.566 albertel 17749:
1.1237 raeburn 17750: #
17751: # Set params for Placement Tests
17752: #
1.1239 raeburn 17753: if ($args->{'crstype'} eq 'Placement') {
17754: my %storecontent;
17755: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17756: my %defaults = (
17757: buttonshide => { value => 'yes',
17758: type => 'string_yesno',},
17759: type => { value => 'randomizetry',
17760: type => 'string_questiontype',},
17761: maxtries => { value => 1,
17762: type => 'int_pos',},
17763: problemstatus => { value => 'no',
17764: type => 'string_problemstatus',},
17765: );
17766: foreach my $key (keys(%defaults)) {
17767: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17768: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17769: }
1.1237 raeburn 17770: &Apache::lonnet::cput
17771: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17772: }
17773:
1.1344 raeburn 17774: return (1,$outcome,\@clonemsg);
1.444 albertel 17775: }
17776:
1.1166 raeburn 17777: sub make_unique_code {
17778: my ($cdom,$cnum) = @_;
17779: # get lock on uniquecodes db
17780: my $lockhash = {
17781: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17782: ':'.$env{'user.domain'},
17783: };
17784: my $tries = 0;
17785: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17786: my ($code,$error);
17787:
17788: while (($gotlock ne 'ok') && ($tries<3)) {
17789: $tries ++;
17790: sleep 1;
17791: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17792: }
17793: if ($gotlock eq 'ok') {
17794: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17795: my $gotcode;
17796: my $attempts = 0;
17797: while ((!$gotcode) && ($attempts < 100)) {
17798: $code = &generate_code();
17799: if (!exists($currcodes{$code})) {
17800: $gotcode = 1;
17801: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17802: $error = 'nostore';
17803: }
17804: }
17805: $attempts ++;
17806: }
17807: my @del_lock = ($cnum."\0".'uniquecodes');
17808: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17809: } else {
17810: $error = 'nolock';
17811: }
17812: return ($code,$error);
17813: }
17814:
17815: sub generate_code {
17816: my $code;
17817: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17818: for (my $i=0; $i<6; $i++) {
17819: my $lettnum = int (rand 2);
17820: my $item = '';
17821: if ($lettnum) {
17822: $item = $letts[int( rand(18) )];
17823: } else {
17824: $item = 1+int( rand(8) );
17825: }
17826: $code .= $item;
17827: }
17828: return $code;
17829: }
17830:
1.444 albertel 17831: ############################################################
17832: ############################################################
17833:
1.1237 raeburn 17834: # Community, Course and Placement Test
1.378 raeburn 17835: sub course_type {
17836: my ($cid) = @_;
17837: if (!defined($cid)) {
17838: $cid = $env{'request.course.id'};
17839: }
1.404 albertel 17840: if (defined($env{'course.'.$cid.'.type'})) {
17841: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17842: } else {
17843: return 'Course';
1.377 raeburn 17844: }
17845: }
1.156 albertel 17846:
1.406 raeburn 17847: sub group_term {
17848: my $crstype = &course_type();
17849: my %names = (
17850: 'Course' => 'group',
1.865 raeburn 17851: 'Community' => 'group',
1.1237 raeburn 17852: 'Placement' => 'group',
1.406 raeburn 17853: );
17854: return $names{$crstype};
17855: }
17856:
1.902 raeburn 17857: sub course_types {
1.1310 raeburn 17858: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17859: my %typename = (
17860: official => 'Official course',
17861: unofficial => 'Unofficial course',
17862: community => 'Community',
1.1165 raeburn 17863: textbook => 'Textbook course',
1.1237 raeburn 17864: placement => 'Placement test',
1.1310 raeburn 17865: lti => 'LTI provider',
1.902 raeburn 17866: );
17867: return (\@types,\%typename);
17868: }
17869:
1.156 albertel 17870: sub icon {
17871: my ($file)=@_;
1.505 albertel 17872: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17873: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17874: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17875: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17876: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17877: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17878: $curfext.".gif") {
17879: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17880: $curfext.".gif";
17881: }
17882: }
1.249 albertel 17883: return &lonhttpdurl($iconname);
1.154 albertel 17884: }
1.84 albertel 17885:
1.575 albertel 17886: sub lonhttpdurl {
1.692 www 17887: #
17888: # Had been used for "small fry" static images on separate port 8080.
17889: # Modify here if lightweight http functionality desired again.
17890: # Currently eliminated due to increasing firewall issues.
17891: #
1.575 albertel 17892: my ($url)=@_;
1.692 www 17893: return $url;
1.215 albertel 17894: }
17895:
1.213 albertel 17896: sub connection_aborted {
17897: my ($r)=@_;
17898: $r->print(" ");$r->rflush();
17899: my $c = $r->connection;
17900: return $c->aborted();
17901: }
17902:
1.221 foxr 17903: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17904: # strings as 'strings'.
17905: sub escape_single {
1.221 foxr 17906: my ($input) = @_;
1.223 albertel 17907: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17908: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17909: return $input;
17910: }
1.223 albertel 17911:
1.222 foxr 17912: # Same as escape_single, but escape's "'s This
17913: # can be used for "strings"
17914: sub escape_double {
17915: my ($input) = @_;
17916: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17917: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17918: return $input;
17919: }
1.223 albertel 17920:
1.222 foxr 17921: # Escapes the last element of a full URL.
17922: sub escape_url {
17923: my ($url) = @_;
1.238 raeburn 17924: my @urlslices = split(/\//, $url,-1);
1.369 www 17925: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17926: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17927: }
1.462 albertel 17928:
1.820 raeburn 17929: sub compare_arrays {
17930: my ($arrayref1,$arrayref2) = @_;
17931: my (@difference,%count);
17932: @difference = ();
17933: %count = ();
17934: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17935: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17936: foreach my $element (keys(%count)) {
17937: if ($count{$element} == 1) {
17938: push(@difference,$element);
17939: }
17940: }
17941: }
17942: return @difference;
17943: }
17944:
1.1322 raeburn 17945: sub lon_status_items {
17946: my %defaults = (
17947: E => 100,
17948: W => 4,
17949: N => 1,
1.1324 raeburn 17950: U => 5,
1.1322 raeburn 17951: threshold => 200,
17952: sysmail => 2500,
17953: );
17954: my %names = (
17955: E => 'Errors',
17956: W => 'Warnings',
17957: N => 'Notices',
1.1324 raeburn 17958: U => 'Unsent',
1.1322 raeburn 17959: );
17960: return (\%defaults,\%names);
17961: }
17962:
1.817 bisitz 17963: # -------------------------------------------------------- Initialize user login
1.462 albertel 17964: sub init_user_environment {
1.463 albertel 17965: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17966: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17967:
17968: my $public=($username eq 'public' && $domain eq 'public');
17969:
1.1415 raeburn 17970: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17971: $coauthorenv);
1.462 albertel 17972: my $now=time;
17973:
17974: if ($public) {
17975: my $max_public=100;
17976: my $oldest;
17977: my $oldest_time=0;
17978: for(my $next=1;$next<=$max_public;$next++) {
17979: if (-e $lonids."/publicuser_$next.id") {
17980: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17981: if ($mtime<$oldest_time || !$oldest_time) {
17982: $oldest_time=$mtime;
17983: $oldest=$next;
17984: }
17985: } else {
17986: $cookie="publicuser_$next";
17987: last;
17988: }
17989: }
17990: if (!$cookie) { $cookie="publicuser_$oldest"; }
17991: } else {
1.1275 raeburn 17992: # See if old ID present, if so, remove if this isn't a robot,
17993: # killing any existing non-robot sessions
1.463 albertel 17994: if (!$args->{'robot'}) {
17995: opendir(DIR,$lonids);
17996: while ($filename=readdir(DIR)) {
17997: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17998: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17999: &GDBM_READER(),0640)) {
1.1295 raeburn 18000: my $linkedfile;
1.1320 raeburn 18001: if (exists($oldenv{'user.linkedenv'})) {
18002: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18003: }
1.1320 raeburn 18004: untie(%oldenv);
18005: if (unlink("$lonids/$filename")) {
18006: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18007: if (-l "$lonids/$linkedfile.id") {
18008: unlink("$lonids/$linkedfile.id");
18009: }
1.1295 raeburn 18010: }
18011: }
18012: } else {
18013: unlink($lonids.'/'.$filename);
18014: }
1.463 albertel 18015: }
1.462 albertel 18016: }
1.463 albertel 18017: closedir(DIR);
1.1204 raeburn 18018: # If there is a undeleted lockfile for the user's paste buffer remove it.
18019: my $namespace = 'nohist_courseeditor';
18020: my $lockingkey = 'paste'."\0".'locked_num';
18021: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18022: $domain,$username);
18023: if (exists($lockhash{$lockingkey})) {
18024: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18025: unless ($delresult eq 'ok') {
18026: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18027: }
18028: }
1.462 albertel 18029: }
18030: # Give them a new cookie
1.463 albertel 18031: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18032: : $now.$$.int(rand(10000)));
1.463 albertel 18033: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18034:
18035: # Initialize roles
18036:
1.1414 raeburn 18037: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18038: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18039: }
18040: # ------------------------------------ Check browser type and MathML capability
18041:
1.1194 raeburn 18042: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18043: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18044:
18045: # ------------------------------------------------------------- Get environment
18046:
18047: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18048: my ($tmp) = keys(%userenv);
1.1275 raeburn 18049: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18050: undef(%userenv);
18051: }
18052: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18053: $form->{'interface'}=$userenv{'interface'};
18054: }
18055: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18056:
18057: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18058: foreach my $option ('interface','localpath','localres') {
18059: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18060: }
18061: # --------------------------------------------------------- Write first profile
18062:
18063: {
1.1350 raeburn 18064: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18065: my %initial_env =
18066: ("user.name" => $username,
18067: "user.domain" => $domain,
18068: "user.home" => $authhost,
18069: "browser.type" => $clientbrowser,
18070: "browser.version" => $clientversion,
18071: "browser.mathml" => $clientmathml,
18072: "browser.unicode" => $clientunicode,
18073: "browser.os" => $clientos,
1.1137 raeburn 18074: "browser.mobile" => $clientmobile,
1.1141 raeburn 18075: "browser.info" => $clientinfo,
1.1194 raeburn 18076: "browser.osversion" => $clientosversion,
1.462 albertel 18077: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18078: "request.course.fn" => '',
18079: "request.course.uri" => '',
18080: "request.course.sec" => '',
18081: "request.role" => 'cm',
18082: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18083: "request.host" => $ip,);
1.462 albertel 18084:
18085: if ($form->{'localpath'}) {
18086: $initial_env{"browser.localpath"} = $form->{'localpath'};
18087: $initial_env{"browser.localres"} = $form->{'localres'};
18088: }
18089:
18090: if ($form->{'interface'}) {
18091: $form->{'interface'}=~s/\W//gs;
18092: $initial_env{"browser.interface"} = $form->{'interface'};
18093: $env{'browser.interface'}=$form->{'interface'};
18094: }
18095:
1.1157 raeburn 18096: if ($form->{'iptoken'}) {
18097: my $lonhost = $r->dir_config('lonHostID');
18098: $initial_env{"user.noloadbalance"} = $lonhost;
18099: $env{'user.noloadbalance'} = $lonhost;
18100: }
18101:
1.1268 raeburn 18102: if ($form->{'noloadbalance'}) {
18103: my @hosts = &Apache::lonnet::current_machine_ids();
18104: my $hosthere = $form->{'noloadbalance'};
18105: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18106: $initial_env{"user.noloadbalance"} = $hosthere;
18107: $env{'user.noloadbalance'} = $hosthere;
18108: }
18109: }
18110:
1.1016 raeburn 18111: unless ($domain eq 'public') {
1.1273 raeburn 18112: my %is_adv = ( is_adv => $env{'user.adv'} );
18113: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18114:
1.1414 raeburn 18115: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18116: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18117: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18118: undef,\%userenv,\%domdef,\%is_adv);
18119: }
1.980 raeburn 18120:
1.1311 raeburn 18121: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18122: $userenv{'canrequest.'.$crstype} =
18123: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18124: 'reload','requestcourses',
18125: \%userenv,\%domdef,\%is_adv);
18126: }
1.724 raeburn 18127:
1.1418 raeburn 18128: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18129: (exists($userroles->{"user.role.au./$domain/"}))) {
18130: if ($userenv{'authoreditors'}) {
18131: $userenv{'editors'} = $userenv{'authoreditors'};
18132: } elsif ($domdef{'editors'} ne '') {
18133: $userenv{'editors'} = $domdef{'editors'};
18134: } else {
18135: $userenv{'editors'} = 'edit,xml';
18136: }
1.1431 raeburn 18137: if ($userenv{'authorarchive'}) {
18138: $userenv{'canarchive'} = 1;
18139: } elsif (($userenv{'authorarchive'} eq '') &&
18140: ($domdef{'archive'})) {
18141: $userenv{'canarchive'} = 1;
18142: }
1.1418 raeburn 18143: }
18144:
1.1273 raeburn 18145: $userenv{'canrequest.author'} =
18146: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18147: 'reload','requestauthor',
1.980 raeburn 18148: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18149: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18150: $domain,$username);
18151: my $reqstatus = $reqauthor{'author_status'};
18152: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18153: if (ref($reqauthor{'author'}) eq 'HASH') {
18154: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18155: $reqauthor{'author'}{'timestamp'};
18156: }
1.1092 raeburn 18157: }
1.1287 raeburn 18158: my ($types,$typename) = &course_types();
18159: if (ref($types) eq 'ARRAY') {
18160: my @options = ('approval','validate','autolimit');
18161: my $optregex = join('|',@options);
18162: my (%willtrust,%trustchecked);
18163: foreach my $type (@{$types}) {
18164: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18165: if ($dom_str ne '') {
18166: my $updatedstr = '';
18167: my @possdomains = split(',',$dom_str);
18168: foreach my $entry (@possdomains) {
18169: my ($extdom,$extopt) = split(':',$entry);
18170: unless ($trustchecked{$extdom}) {
18171: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18172: $trustchecked{$extdom} = 1;
18173: }
18174: if ($willtrust{$extdom}) {
18175: $updatedstr .= $entry.',';
18176: }
18177: }
18178: $updatedstr =~ s/,$//;
18179: if ($updatedstr) {
18180: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18181: } else {
18182: delete($userenv{'reqcrsotherdom.'.$type});
18183: }
18184: }
18185: }
18186: }
1.1092 raeburn 18187: }
1.462 albertel 18188: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18189:
1.462 albertel 18190: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18191: &GDBM_WRCREAT(),0640)) {
18192: &_add_to_env(\%disk_env,\%initial_env);
18193: &_add_to_env(\%disk_env,\%userenv,'environment.');
18194: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18195: if (ref($firstaccenv) eq 'HASH') {
18196: &_add_to_env(\%disk_env,$firstaccenv);
18197: }
18198: if (ref($timerintenv) eq 'HASH') {
18199: &_add_to_env(\%disk_env,$timerintenv);
18200: }
1.1414 raeburn 18201: if (ref($coauthorenv) eq 'HASH') {
18202: if (keys(%{$coauthorenv})) {
18203: &_add_to_env(\%disk_env,$coauthorenv);
18204: }
18205: }
1.463 albertel 18206: if (ref($args->{'extra_env'})) {
18207: &_add_to_env(\%disk_env,$args->{'extra_env'});
18208: }
1.462 albertel 18209: untie(%disk_env);
18210: } else {
1.705 tempelho 18211: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18212: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18213: return 'error: '.$!;
18214: }
18215: }
18216: $env{'request.role'}='cm';
18217: $env{'request.role.adv'}=$env{'user.adv'};
18218: $env{'browser.type'}=$clientbrowser;
18219:
18220: return $cookie;
18221:
18222: }
18223:
18224: sub _add_to_env {
18225: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18226: if (ref($env_data) eq 'HASH') {
18227: while (my ($key,$value) = each(%$env_data)) {
18228: $idf->{$prefix.$key} = $value;
18229: $env{$prefix.$key} = $value;
18230: }
1.462 albertel 18231: }
18232: }
18233:
1.685 tempelho 18234: # --- Get the symbolic name of a problem and the url
18235: sub get_symb {
18236: my ($request,$silent) = @_;
1.726 raeburn 18237: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18238: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18239: if ($symb eq '') {
18240: if (!$silent) {
1.1071 raeburn 18241: if (ref($request)) {
18242: $request->print("Unable to handle ambiguous references:$url:.");
18243: }
1.685 tempelho 18244: return ();
18245: }
18246: }
18247: &Apache::lonenc::check_decrypt(\$symb);
18248: return ($symb);
18249: }
18250:
18251: # --------------------------------------------------------------Get annotation
18252:
18253: sub get_annotation {
18254: my ($symb,$enc) = @_;
18255:
18256: my $key = $symb;
18257: if (!$enc) {
18258: $key =
18259: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18260: }
18261: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18262: return $annotation{$key};
18263: }
18264:
18265: sub clean_symb {
1.731 raeburn 18266: my ($symb,$delete_enc) = @_;
1.685 tempelho 18267:
18268: &Apache::lonenc::check_decrypt(\$symb);
18269: my $enc = $env{'request.enc'};
1.731 raeburn 18270: if ($delete_enc) {
1.730 raeburn 18271: delete($env{'request.enc'});
18272: }
1.685 tempelho 18273:
18274: return ($symb,$enc);
18275: }
1.462 albertel 18276:
1.1181 raeburn 18277: ############################################################
18278: ############################################################
18279:
18280: =pod
18281:
18282: =head1 Routines for building display used to search for courses
18283:
18284:
18285: =over 4
18286:
18287: =item * &build_filters()
18288:
18289: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18290: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18291: and quotacheck.pl
18292:
1.1181 raeburn 18293:
18294: Inputs:
18295:
18296: filterlist - anonymous array of fields to include as potential filters
18297:
18298: crstype - course type
18299:
18300: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18301: to pop-open a course selector (will contain "extra element").
18302:
18303: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18304:
18305: filter - anonymous hash of criteria and their values
18306:
18307: action - form action
18308:
18309: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18310:
1.1182 raeburn 18311: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18312:
18313: cloneruname - username of owner of new course who wants to clone
18314:
18315: clonerudom - domain of owner of new course who wants to clone
18316:
18317: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18318:
18319: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18320:
18321: codedom - domain
18322:
18323: formname - value of form element named "form".
18324:
18325: fixeddom - domain, if fixed.
18326:
18327: prevphase - value to assign to form element named "phase" when going back to the previous screen
18328:
18329: cnameelement - name of form element in form on opener page which will receive title of selected course
18330:
18331: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18332:
18333: cdomelement - name of form element in form on opener page which will receive domain of selected course
18334:
18335: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18336:
18337: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18338:
18339: clonewarning - warning message about missing information for intended course owner when DC creates a course
18340:
1.1182 raeburn 18341:
1.1181 raeburn 18342: Returns: $output - HTML for display of search criteria, and hidden form elements.
18343:
1.1182 raeburn 18344:
1.1181 raeburn 18345: Side Effects: None
18346:
18347: =cut
18348:
18349: # ---------------------------------------------- search for courses based on last activity etc.
18350:
18351: sub build_filters {
18352: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18353: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18354: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18355: $cnameelement,$cnumelement,$cdomelement,$setroles,
18356: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18357: my ($list,$jscript);
1.1181 raeburn 18358: my $onchange = 'javascript:updateFilters(this)';
18359: my ($domainselectform,$sincefilterform,$createdfilterform,
18360: $ownerdomselectform,$persondomselectform,$instcodeform,
18361: $typeselectform,$instcodetitle);
18362: if ($formname eq '') {
18363: $formname = $caller;
18364: }
18365: foreach my $item (@{$filterlist}) {
18366: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18367: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18368: if ($item eq 'domainfilter') {
18369: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18370: } elsif ($item eq 'coursefilter') {
18371: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18372: } elsif ($item eq 'ownerfilter') {
18373: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18374: } elsif ($item eq 'ownerdomfilter') {
18375: $filter->{'ownerdomfilter'} =
18376: &LONCAPA::clean_domain($filter->{$item});
18377: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18378: 'ownerdomfilter',1);
18379: } elsif ($item eq 'personfilter') {
18380: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18381: } elsif ($item eq 'persondomfilter') {
18382: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18383: 'persondomfilter',1);
18384: } else {
18385: $filter->{$item} =~ s/\W//g;
18386: }
18387: if (!$filter->{$item}) {
18388: $filter->{$item} = '';
18389: }
18390: }
18391: if ($item eq 'domainfilter') {
18392: my $allow_blank = 1;
18393: if ($formname eq 'portform') {
18394: $allow_blank=0;
18395: } elsif ($formname eq 'studentform') {
18396: $allow_blank=0;
18397: }
18398: if ($fixeddom) {
18399: $domainselectform = '<input type="hidden" name="domainfilter"'.
18400: ' value="'.$codedom.'" />'.
18401: &Apache::lonnet::domain($codedom,'description');
18402: } else {
18403: $domainselectform = &select_dom_form($filter->{$item},
18404: 'domainfilter',
18405: $allow_blank,'',$onchange);
18406: }
18407: } else {
18408: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18409: }
18410: }
18411:
18412: # last course activity filter and selection
18413: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18414:
18415: # course created filter and selection
18416: if (exists($filter->{'createdfilter'})) {
18417: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18418: }
18419:
1.1239 raeburn 18420: my $prefix = $crstype;
18421: if ($crstype eq 'Placement') {
18422: $prefix = 'Placement Test'
18423: }
1.1181 raeburn 18424: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18425: 'cac' => "$prefix Activity",
18426: 'ccr' => "$prefix Created",
18427: 'cde' => "$prefix Title",
18428: 'cdo' => "$prefix Domain",
1.1181 raeburn 18429: 'ins' => 'Institutional Code',
18430: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18431: 'cow' => "$prefix Owner/Co-owner",
18432: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18433: 'cog' => 'Type',
18434: );
18435:
18436: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18437: my $typeval = 'Course';
18438: if ($crstype eq 'Community') {
18439: $typeval = 'Community';
1.1239 raeburn 18440: } elsif ($crstype eq 'Placement') {
18441: $typeval = 'Placement';
1.1181 raeburn 18442: }
18443: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18444: } else {
18445: $typeselectform = '<select name="type" size="1"';
18446: if ($onchange) {
18447: $typeselectform .= ' onchange="'.$onchange.'"';
18448: }
18449: $typeselectform .= '>'."\n";
1.1237 raeburn 18450: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18451: my $shown;
18452: if ($posstype eq 'Placement') {
18453: $shown = &mt('Placement Test');
18454: } else {
18455: $shown = &mt($posstype);
18456: }
1.1181 raeburn 18457: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18458: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18459: }
18460: $typeselectform.="</select>";
18461: }
18462:
18463: my ($cloneableonlyform,$cloneabletitle);
18464: if (exists($filter->{'cloneableonly'})) {
18465: my $cloneableon = '';
18466: my $cloneableoff = ' checked="checked"';
18467: if ($filter->{'cloneableonly'}) {
18468: $cloneableon = $cloneableoff;
18469: $cloneableoff = '';
18470: }
18471: $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>';
18472: if ($formname eq 'ccrs') {
1.1187 bisitz 18473: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18474: } else {
18475: $cloneabletitle = &mt('Cloneable by you');
18476: }
18477: }
18478: my $officialjs;
18479: if ($crstype eq 'Course') {
18480: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18481: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18482: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18483: if ($codedom) {
1.1181 raeburn 18484: $officialjs = 1;
18485: ($instcodeform,$jscript,$$numtitlesref) =
18486: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18487: $officialjs,$codetitlesref);
18488: if ($jscript) {
1.1182 raeburn 18489: $jscript = '<script type="text/javascript">'."\n".
18490: '// <![CDATA['."\n".
18491: $jscript."\n".
18492: '// ]]>'."\n".
18493: '</script>'."\n";
1.1181 raeburn 18494: }
18495: }
18496: if ($instcodeform eq '') {
18497: $instcodeform =
18498: '<input type="text" name="instcodefilter" size="10" value="'.
18499: $list->{'instcodefilter'}.'" />';
18500: $instcodetitle = $lt{'ins'};
18501: } else {
18502: $instcodetitle = $lt{'inc'};
18503: }
18504: if ($fixeddom) {
18505: $instcodetitle .= '<br />('.$codedom.')';
18506: }
18507: }
18508: }
18509: my $output = qq|
18510: <form method="post" name="filterpicker" action="$action">
18511: <input type="hidden" name="form" value="$formname" />
18512: |;
18513: if ($formname eq 'modifycourse') {
18514: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18515: '<input type="hidden" name="prevphase" value="'.
18516: $prevphase.'" />'."\n";
1.1198 musolffc 18517: } elsif ($formname eq 'quotacheck') {
18518: $output .= qq|
18519: <input type="hidden" name="sortby" value="" />
18520: <input type="hidden" name="sortorder" value="" />
18521: |;
18522: } else {
1.1181 raeburn 18523: my $name_input;
18524: if ($cnameelement ne '') {
18525: $name_input = '<input type="hidden" name="cnameelement" value="'.
18526: $cnameelement.'" />';
18527: }
18528: $output .= qq|
1.1182 raeburn 18529: <input type="hidden" name="cnumelement" value="$cnumelement" />
18530: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18531: $name_input
18532: $roleelement
18533: $multelement
18534: $typeelement
18535: |;
18536: if ($formname eq 'portform') {
18537: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18538: }
18539: }
18540: if ($fixeddom) {
18541: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18542: }
18543: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18544: if ($sincefilterform) {
18545: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18546: .$sincefilterform
18547: .&Apache::lonhtmlcommon::row_closure();
18548: }
18549: if ($createdfilterform) {
18550: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18551: .$createdfilterform
18552: .&Apache::lonhtmlcommon::row_closure();
18553: }
18554: if ($domainselectform) {
18555: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18556: .$domainselectform
18557: .&Apache::lonhtmlcommon::row_closure();
18558: }
18559: if ($typeselectform) {
18560: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18561: $output .= $typeselectform;
18562: } else {
18563: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18564: .$typeselectform
18565: .&Apache::lonhtmlcommon::row_closure();
18566: }
18567: }
18568: if ($instcodeform) {
18569: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18570: .$instcodeform
18571: .&Apache::lonhtmlcommon::row_closure();
18572: }
18573: if (exists($filter->{'ownerfilter'})) {
18574: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18575: '<table><tr><td>'.&mt('Username').'<br />'.
18576: '<input type="text" name="ownerfilter" size="20" value="'.
18577: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18578: $ownerdomselectform.'</td></tr></table>'.
18579: &Apache::lonhtmlcommon::row_closure();
18580: }
18581: if (exists($filter->{'personfilter'})) {
18582: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18583: '<table><tr><td>'.&mt('Username').'<br />'.
18584: '<input type="text" name="personfilter" size="20" value="'.
18585: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18586: $persondomselectform.'</td></tr></table>'.
18587: &Apache::lonhtmlcommon::row_closure();
18588: }
18589: if (exists($filter->{'coursefilter'})) {
18590: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18591: .'<input type="text" name="coursefilter" size="25" value="'
18592: .$list->{'coursefilter'}.'" />'
18593: .&Apache::lonhtmlcommon::row_closure();
18594: }
18595: if ($cloneableonlyform) {
18596: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18597: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18598: }
18599: if (exists($filter->{'descriptfilter'})) {
18600: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18601: .'<input type="text" name="descriptfilter" size="40" value="'
18602: .$list->{'descriptfilter'}.'" />'
18603: .&Apache::lonhtmlcommon::row_closure(1);
18604: }
18605: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18606: '<input type="hidden" name="updater" value="" />'."\n".
18607: '<input type="submit" name="gosearch" value="'.
18608: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18609: return $jscript.$clonewarning.$output;
18610: }
18611:
18612: =pod
18613:
18614: =item * &timebased_select_form()
18615:
1.1182 raeburn 18616: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18617: filter e.g., Course Activity, Course Created, when searching for courses
18618: or communities
18619:
18620: Inputs:
18621:
18622: item - name of form element (sincefilter or createdfilter)
18623:
18624: filter - anonymous hash of criteria and their values
18625:
18626: Returns: HTML for a select box contained a blank, then six time selections,
18627: with value set in incoming form variables currently selected.
18628:
18629: Side Effects: None
18630:
18631: =cut
18632:
18633: sub timebased_select_form {
18634: my ($item,$filter) = @_;
18635: if (ref($filter) eq 'HASH') {
18636: $filter->{$item} =~ s/[^\d-]//g;
18637: if (!$filter->{$item}) { $filter->{$item}=-1; }
18638: return &select_form(
18639: $filter->{$item},
18640: $item,
18641: { '-1' => '',
18642: '86400' => &mt('today'),
18643: '604800' => &mt('last week'),
18644: '2592000' => &mt('last month'),
18645: '7776000' => &mt('last three months'),
18646: '15552000' => &mt('last six months'),
18647: '31104000' => &mt('last year'),
18648: 'select_form_order' =>
18649: ['-1','86400','604800','2592000','7776000',
18650: '15552000','31104000']});
18651: }
18652: }
18653:
18654: =pod
18655:
18656: =item * &js_changer()
18657:
18658: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18659: when course type or domain is changed, and also to hide 'Searching ...' on
18660: page load completion for page showing search result.
1.1181 raeburn 18661:
18662: Inputs: None
18663:
1.1183 raeburn 18664: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18665:
18666: Side Effects: None
18667:
18668: =cut
18669:
18670: sub js_changer {
18671: return <<ENDJS;
18672: <script type="text/javascript">
18673: // <![CDATA[
18674: function updateFilters(caller) {
18675: if (typeof(caller) != "undefined") {
18676: document.filterpicker.updater.value = caller.name;
18677: }
18678: document.filterpicker.submit();
18679: }
1.1183 raeburn 18680:
18681: function hideSearching() {
18682: if (document.getElementById('searching')) {
18683: document.getElementById('searching').style.display = 'none';
18684: }
18685: return;
18686: }
18687:
1.1181 raeburn 18688: // ]]>
18689: </script>
18690:
18691: ENDJS
18692: }
18693:
18694: =pod
18695:
1.1182 raeburn 18696: =item * &search_courses()
18697:
18698: Process selected filters form course search form and pass to lonnet::courseiddump
18699: to retrieve a hash for which keys are courseIDs which match the selected filters.
18700:
18701: Inputs:
18702:
18703: dom - domain being searched
18704:
18705: type - course type ('Course' or 'Community' or '.' if any).
18706:
18707: filter - anonymous hash of criteria and their values
18708:
18709: numtitles - for institutional codes - number of categories
18710:
18711: cloneruname - optional username of new course owner
18712:
18713: clonerudom - optional domain of new course owner
18714:
1.1221 raeburn 18715: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18716: (used when DC is using course creation form)
18717:
18718: codetitles - reference to array of titles of components in institutional codes (official courses).
18719:
1.1221 raeburn 18720: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18721: (and so can clone automatically)
18722:
18723: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18724:
18725: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18726: courses to clone
1.1182 raeburn 18727:
18728: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18729:
18730:
18731: Side Effects: None
18732:
18733: =cut
18734:
18735:
18736: sub search_courses {
1.1221 raeburn 18737: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18738: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18739: my (%courses,%showcourses,$cloner);
18740: if (($filter->{'ownerfilter'} ne '') ||
18741: ($filter->{'ownerdomfilter'} ne '')) {
18742: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18743: $filter->{'ownerdomfilter'};
18744: }
18745: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18746: if (!$filter->{$item}) {
18747: $filter->{$item}='.';
18748: }
18749: }
18750: my $now = time;
18751: my $timefilter =
18752: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18753: my ($createdbefore,$createdafter);
18754: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18755: $createdbefore = $now;
18756: $createdafter = $now-$filter->{'createdfilter'};
18757: }
18758: my ($instcodefilter,$regexpok);
18759: if ($numtitles) {
18760: if ($env{'form.official'} eq 'on') {
18761: $instcodefilter =
18762: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18763: $regexpok = 1;
18764: } elsif ($env{'form.official'} eq 'off') {
18765: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18766: unless ($instcodefilter eq '') {
18767: $regexpok = -1;
18768: }
18769: }
18770: } else {
18771: $instcodefilter = $filter->{'instcodefilter'};
18772: }
18773: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18774: if ($type eq '') { $type = '.'; }
18775:
18776: if (($clonerudom ne '') && ($cloneruname ne '')) {
18777: $cloner = $cloneruname.':'.$clonerudom;
18778: }
18779: %courses = &Apache::lonnet::courseiddump($dom,
18780: $filter->{'descriptfilter'},
18781: $timefilter,
18782: $instcodefilter,
18783: $filter->{'combownerfilter'},
18784: $filter->{'coursefilter'},
18785: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18786: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18787: $filter->{'cloneableonly'},
18788: $createdbefore,$createdafter,undef,
1.1221 raeburn 18789: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18790: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18791: my $ccrole;
18792: if ($type eq 'Community') {
18793: $ccrole = 'co';
18794: } else {
18795: $ccrole = 'cc';
18796: }
18797: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18798: $filter->{'persondomfilter'},
18799: 'userroles',undef,
18800: [$ccrole,'in','ad','ep','ta','cr'],
18801: $dom);
18802: foreach my $role (keys(%rolehash)) {
18803: my ($cnum,$cdom,$courserole) = split(':',$role);
18804: my $cid = $cdom.'_'.$cnum;
18805: if (exists($courses{$cid})) {
18806: if (ref($courses{$cid}) eq 'HASH') {
18807: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18808: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18809: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18810: }
18811: } else {
18812: $courses{$cid}{roles} = [$courserole];
18813: }
18814: $showcourses{$cid} = $courses{$cid};
18815: }
18816: }
18817: }
18818: %courses = %showcourses;
18819: }
18820: return %courses;
18821: }
18822:
18823: =pod
18824:
1.1181 raeburn 18825: =back
18826:
1.1207 raeburn 18827: =head1 Routines for version requirements for current course.
18828:
18829: =over 4
18830:
18831: =item * &check_release_required()
18832:
18833: Compares required LON-CAPA version with version on server, and
18834: if required version is newer looks for a server with the required version.
18835:
18836: Looks first at servers in user's owen domain; if none suitable, looks at
18837: servers in course's domain are permitted to host sessions for user's domain.
18838:
18839: Inputs:
18840:
18841: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18842:
18843: $courseid - Course ID of current course
18844:
18845: $rolecode - User's current role in course (for switchserver query string).
18846:
18847: $required - LON-CAPA version needed by course (format: Major.Minor).
18848:
18849:
18850: Returns:
18851:
18852: $switchserver - query string tp append to /adm/switchserver call (if
18853: current server's LON-CAPA version is too old.
18854:
18855: $warning - Message is displayed if no suitable server could be found.
18856:
18857: =cut
18858:
18859: sub check_release_required {
18860: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18861: my ($switchserver,$warning);
18862: if ($required ne '') {
18863: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18864: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18865: if ($reqdmajor ne '' && $reqdminor ne '') {
18866: my $otherserver;
18867: if (($major eq '' && $minor eq '') ||
18868: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18869: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18870: my $switchlcrev =
18871: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18872: $userdomserver);
18873: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18874: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18875: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18876: my $cdom = $env{'course.'.$courseid.'.domain'};
18877: if ($cdom ne $env{'user.domain'}) {
18878: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18879: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18880: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18881: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18882: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18883: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18884: my $canhost =
18885: &Apache::lonnet::can_host_session($env{'user.domain'},
18886: $coursedomserver,
18887: $remoterev,
18888: $udomdefaults{'remotesessions'},
18889: $defdomdefaults{'hostedsessions'});
18890:
18891: if ($canhost) {
18892: $otherserver = $coursedomserver;
18893: } else {
18894: $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.");
18895: }
18896: } else {
18897: $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).");
18898: }
18899: } else {
18900: $otherserver = $userdomserver;
18901: }
18902: }
18903: if ($otherserver ne '') {
18904: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18905: }
18906: }
18907: }
18908: return ($switchserver,$warning);
18909: }
18910:
18911: =pod
18912:
18913: =item * &check_release_result()
18914:
18915: Inputs:
18916:
18917: $switchwarning - Warning message if no suitable server found to host session.
18918:
18919: $switchserver - query string to append to /adm/switchserver containing lonHostID
18920: and current role.
18921:
18922: Returns: HTML to display with information about requirement to switch server.
18923: Either displaying warning with link to Roles/Courses screen or
18924: display link to switchserver.
18925:
1.1181 raeburn 18926: =cut
18927:
1.1207 raeburn 18928: sub check_release_result {
18929: my ($switchwarning,$switchserver) = @_;
18930: my $output = &start_page('Selected course unavailable on this server').
18931: '<p class="LC_warning">';
18932: if ($switchwarning) {
18933: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18934: if (&show_course()) {
18935: $output .= &mt('Display courses');
18936: } else {
18937: $output .= &mt('Display roles');
18938: }
18939: $output .= '</a>';
18940: } elsif ($switchserver) {
18941: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18942: '<br />'.
18943: '<a href="/adm/switchserver?'.$switchserver.'">'.
18944: &mt('Switch Server').
18945: '</a>';
18946: }
18947: $output .= '</p>'.&end_page();
18948: return $output;
18949: }
18950:
18951: =pod
18952:
18953: =item * &needs_coursereinit()
18954:
18955: Determine if course contents stored for user's session needs to be
18956: refreshed, because content has changed since "Big Hash" last tied.
18957:
18958: Check for change is made if time last checked is more than 10 minutes ago
18959: (by default).
18960:
18961: Inputs:
18962:
18963: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18964:
18965: $interval (optional) - Time which may elapse (in s) between last check for content
18966: change in current course. (default: 600 s).
18967:
18968: Returns: an array; first element is:
18969:
18970: =over 4
18971:
18972: 'switch' - if content updates mean user's session
18973: needs to be switched to a server running a newer LON-CAPA version
18974:
18975: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18976: on current server hosting user's session
18977:
18978: '' - if no action required.
18979:
18980: =back
18981:
18982: If first item element is 'switch':
18983:
18984: second item is $switchwarning - Warning message if no suitable server found to host session.
18985:
18986: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18987: and current role.
18988:
18989: otherwise: no other elements returned.
18990:
18991: =back
18992:
18993: =cut
18994:
18995: sub needs_coursereinit {
18996: my ($loncaparev,$interval) = @_;
18997: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18998: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18999: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19000: my $now = time;
19001: if ($interval eq '') {
19002: $interval = 600;
19003: }
19004: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19005: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19006: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19007: if ($blocked) {
19008: return ();
19009: }
1.1391 raeburn 19010: my $update;
19011: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19012: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19013: if ($lastmainchange > $env{'request.course.tied'}) {
19014: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19015: if ($needswitch) {
19016: return ('switch',$switchwarning,$switchserver);
19017: }
19018: $update = 'main';
19019: }
19020: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19021: if ($update) {
19022: $update = 'both';
19023: } else {
19024: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19025: if ($needswitch) {
19026: return ('switch',$switchwarning,$switchserver);
19027: } else {
19028: $update = 'supp';
1.1207 raeburn 19029: }
19030: }
1.1391 raeburn 19031: return ($update);
19032: }
19033: }
19034: return ();
19035: }
19036:
19037: sub switch_for_update {
19038: my ($loncaparev,$cdom,$cnum) = @_;
19039: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19040: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19041: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19042: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19043: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19044: $curr_reqd_hash{'internal.releaserequired'}});
19045: my ($switchserver,$switchwarning) =
19046: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19047: $curr_reqd_hash{'internal.releaserequired'});
19048: if ($switchwarning ne '' || $switchserver ne '') {
19049: return ('switch',$switchwarning,$switchserver);
19050: }
1.1207 raeburn 19051: }
19052: }
19053: return ();
19054: }
1.1181 raeburn 19055:
1.1083 raeburn 19056: sub update_content_constraints {
1.1395 raeburn 19057: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19058: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19059: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19060: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19061: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19062: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19063: if ($item eq 'resourcetag') {
19064: if ($name eq 'responsetype') {
19065: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19066: }
1.1307 raeburn 19067: } elsif ($item eq 'course') {
19068: if ($name eq 'courserestype') {
19069: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19070: }
1.1083 raeburn 19071: }
19072: }
19073: my $navmap = Apache::lonnavmaps::navmap->new();
19074: if (defined($navmap)) {
1.1307 raeburn 19075: my (%allresponses,%allcrsrestypes);
19076: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19077: if ($res->is_tool()) {
19078: if ($allcrsrestypes{'exttool'}) {
19079: $allcrsrestypes{'exttool'} ++;
19080: } else {
19081: $allcrsrestypes{'exttool'} = 1;
19082: }
19083: next;
19084: }
1.1083 raeburn 19085: my %responses = $res->responseTypes();
19086: foreach my $key (keys(%responses)) {
19087: next unless(exists($checkresponsetypes{$key}));
19088: $allresponses{$key} += $responses{$key};
19089: }
19090: }
19091: foreach my $key (keys(%allresponses)) {
19092: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19093: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19094: ($reqdmajor,$reqdminor) = ($major,$minor);
19095: }
19096: }
1.1307 raeburn 19097: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19098: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19099: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19100: ($reqdmajor,$reqdminor) = ($major,$minor);
19101: }
19102: }
1.1083 raeburn 19103: undef($navmap);
19104: }
1.1391 raeburn 19105: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19106: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19107: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19108: ($reqdmajor,$reqdminor) = ($major,$minor);
19109: }
19110: }
1.1083 raeburn 19111: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19112: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19113: }
19114: return;
19115: }
19116:
1.1110 raeburn 19117: sub allmaps_incourse {
19118: my ($cdom,$cnum,$chome,$cid) = @_;
19119: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19120: $cid = $env{'request.course.id'};
19121: $cdom = $env{'course.'.$cid.'.domain'};
19122: $cnum = $env{'course.'.$cid.'.num'};
19123: $chome = $env{'course.'.$cid.'.home'};
19124: }
19125: my %allmaps = ();
19126: my $lastchange =
19127: &Apache::lonnet::get_coursechange($cdom,$cnum);
19128: if ($lastchange > $env{'request.course.tied'}) {
19129: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19130: unless ($ferr) {
1.1395 raeburn 19131: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19132: }
19133: }
19134: my $navmap = Apache::lonnavmaps::navmap->new();
19135: if (defined($navmap)) {
19136: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19137: $allmaps{$res->src()} = 1;
19138: }
19139: }
19140: return \%allmaps;
19141: }
19142:
1.1083 raeburn 19143: sub parse_supplemental_title {
19144: my ($title) = @_;
19145:
19146: my ($foldertitle,$renametitle);
19147: if ($title =~ /&&&/) {
19148: $title = &HTML::Entites::decode($title);
19149: }
19150: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19151: $renametitle=$4;
19152: my ($time,$uname,$udom) = ($1,$2,$3);
19153: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19154: my $name = &plainname($uname,$udom);
19155: $name = &HTML::Entities::encode($name,'"<>&\'');
19156: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19157: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19158: if ($foldertitle ne '') {
1.1401 raeburn 19159: $title .= ': <br />'.$foldertitle;
19160: }
1.1083 raeburn 19161: }
19162: if (wantarray) {
19163: return ($title,$foldertitle,$renametitle);
19164: }
19165: return $title;
19166: }
19167:
1.1395 raeburn 19168: sub get_supplemental {
19169: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19170: my $hashid=$cnum.':'.$cdom;
19171: my ($supplemental,$cached,$set_httprefs);
19172: unless ($ignorecache) {
19173: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19174: }
19175: unless (defined($cached)) {
19176: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19177: unless ($chome eq 'no_host') {
19178: my @order = @LONCAPA::map::order;
19179: my @resources = @LONCAPA::map::resources;
19180: my @resparms = @LONCAPA::map::resparms;
19181: my @zombies = @LONCAPA::map::zombies;
19182: my ($errors,%ids,%hidden);
19183: $errors =
19184: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19185: $errors,$possdel,\%ids,\%hidden);
19186: @LONCAPA::map::order = @order;
19187: @LONCAPA::map::resources = @resources;
19188: @LONCAPA::map::resparms = @resparms;
19189: @LONCAPA::map::zombies = @zombies;
19190: $set_httprefs = 1;
19191: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19192: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19193: }
19194: $supplemental = {
19195: ids => \%ids,
19196: hidden => \%hidden,
19197: };
19198: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19199: }
19200: }
19201: return ($supplemental,$set_httprefs);
19202: }
19203:
1.1143 raeburn 19204: sub recurse_supplemental {
1.1391 raeburn 19205: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19206: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19207: my $mapnum;
19208: if ($suppmap eq 'supplemental.sequence') {
19209: $mapnum = 0;
19210: } else {
19211: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19212: }
1.1143 raeburn 19213: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19214: if ($fatal) {
19215: $errors ++;
19216: } else {
1.1389 raeburn 19217: my @order = @LONCAPA::map::order;
19218: if (@order > 0) {
19219: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19220: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19221: foreach my $idx (@order) {
19222: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19223: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19224: my $id = $mapnum.':'.$idx;
19225: push(@{$suppids->{$src}},$id);
19226: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19227: $hiddensupp->{$id} = 1;
19228: }
1.1146 raeburn 19229: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19230: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19231: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19232: } else {
1.1391 raeburn 19233: my $allowed;
19234: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19235: $allowed = 1;
19236: } elsif ($possdel) {
19237: foreach my $item (@{$suppids->{$src}}) {
19238: next if ($item eq $id);
19239: unless ($hiddensupp->{$item}) {
19240: $allowed = 1;
19241: last;
19242: }
19243: }
19244: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19245: &Apache::lonnet::delenv('httpref.'.$src);
19246: }
19247: }
19248: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19249: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19250: }
1.1143 raeburn 19251: }
19252: }
19253: }
19254: }
19255: }
19256: }
1.1391 raeburn 19257: return $errors;
19258: }
19259:
19260: sub set_supp_httprefs {
19261: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19262: if (ref($supplemental) eq 'HASH') {
19263: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19264: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19265: next if ($src =~ /\.sequence$/);
19266: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19267: my $allowed;
19268: if ($env{'request.role.adv'}) {
19269: $allowed = 1;
19270: } else {
19271: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19272: unless ($supplemental->{'hidden'}->{$id}) {
19273: $allowed = 1;
19274: last;
19275: }
19276: }
19277: }
19278: if (exists($env{'httpref.'.$src})) {
19279: if ($possdel) {
19280: unless ($allowed) {
19281: &Apache::lonnet::delenv('httpref.'.$src);
19282: }
19283: }
19284: } elsif ($allowed) {
19285: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19286: }
19287: }
19288: }
19289: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19290: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19291: }
19292: }
19293: }
19294: }
19295:
19296: sub get_supp_parameter {
19297: my ($resparm,$name)=@_;
19298: return if ($resparm eq '');
19299: my $value=undef;
19300: my $ptype=undef;
19301: foreach (split('&&&',$resparm)) {
19302: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19303: if ($thisname eq $name) {
19304: $value=$thisvalue;
19305: $ptype=$thistype;
19306: }
19307: }
19308: return $value;
1.1143 raeburn 19309: }
19310:
1.1101 raeburn 19311: sub symb_to_docspath {
1.1267 raeburn 19312: my ($symb,$navmapref) = @_;
19313: return unless ($symb && ref($navmapref));
1.1101 raeburn 19314: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19315: if ($resurl=~/\.(sequence|page)$/) {
19316: $mapurl=$resurl;
19317: } elsif ($resurl eq 'adm/navmaps') {
19318: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19319: }
19320: my $mapresobj;
1.1267 raeburn 19321: unless (ref($$navmapref)) {
19322: $$navmapref = Apache::lonnavmaps::navmap->new();
19323: }
19324: if (ref($$navmapref)) {
19325: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19326: }
19327: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19328: my $type=$2;
19329: my $path;
19330: if (ref($mapresobj)) {
19331: my $pcslist = $mapresobj->map_hierarchy();
19332: if ($pcslist ne '') {
19333: foreach my $pc (split(/,/,$pcslist)) {
19334: next if ($pc <= 1);
1.1267 raeburn 19335: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19336: if (ref($res)) {
19337: my $thisurl = $res->src();
19338: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19339: my $thistitle = $res->title();
19340: $path .= '&'.
19341: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19342: &escape($thistitle).
1.1101 raeburn 19343: ':'.$res->randompick().
19344: ':'.$res->randomout().
19345: ':'.$res->encrypted().
19346: ':'.$res->randomorder().
19347: ':'.$res->is_page();
19348: }
19349: }
19350: }
19351: $path =~ s/^\&//;
19352: my $maptitle = $mapresobj->title();
19353: if ($mapurl eq 'default') {
1.1129 raeburn 19354: $maptitle = 'Main Content';
1.1101 raeburn 19355: }
19356: $path .= (($path ne '')? '&' : '').
19357: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19358: &escape($maptitle).
1.1101 raeburn 19359: ':'.$mapresobj->randompick().
19360: ':'.$mapresobj->randomout().
19361: ':'.$mapresobj->encrypted().
19362: ':'.$mapresobj->randomorder().
19363: ':'.$mapresobj->is_page();
19364: } else {
19365: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19366: my $ispage = (($type eq 'page')? 1 : '');
19367: if ($mapurl eq 'default') {
1.1129 raeburn 19368: $maptitle = 'Main Content';
1.1101 raeburn 19369: }
19370: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19371: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19372: }
19373: unless ($mapurl eq 'default') {
19374: $path = 'default&'.
1.1146 raeburn 19375: &escape('Main Content').
1.1101 raeburn 19376: ':::::&'.$path;
19377: }
19378: return $path;
19379: }
19380:
1.1393 raeburn 19381: sub validate_folderpath {
19382: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19383: if ($env{'form.folderpath'} ne '') {
19384: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19385: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19386: for (my $i=0; $i<@items; $i++) {
19387: my $odd = $i%2;
19388: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19389: $badpath = 1;
1.1394 raeburn 19390: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19391: my $idx = $i-1;
1.1394 raeburn 19392: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19393: my $esc_name = $1;
19394: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19395: $supppath .= '&'.$esc_name;
19396: $changed = 1;
19397: } else {
19398: $supppath .= '&'.$items[$i];
19399: }
19400: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19401: $changed = 1;
1.1393 raeburn 19402: my $is_hidden;
19403: unless ($got_supp) {
1.1395 raeburn 19404: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19405: if (ref($supplemental) eq 'HASH') {
19406: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19407: %supphidden = %{$supplemental->{'hidden'}};
19408: }
19409: if (ref($supplemental->{'ids'}) eq 'HASH') {
19410: %suppids = %{$supplemental->{'ids'}};
19411: }
19412: }
19413: $got_supp = 1;
19414: }
19415: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19416: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19417: if ($supphidden{$mapid}) {
19418: $is_hidden = 1;
19419: }
19420: }
1.1394 raeburn 19421: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19422: } else {
19423: $supppath .= '&'.$items[$i];
1.1393 raeburn 19424: }
19425: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19426: $badpath = 1;
1.1394 raeburn 19427: } elsif ($supplementalflag) {
1.1393 raeburn 19428: $supppath .= '&'.$items[$i];
19429: }
19430: last if ($badpath);
19431: }
19432: if ($badpath) {
19433: delete($env{'form.folderpath'});
1.1394 raeburn 19434: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19435: $supppath =~ s/^\&//;
19436: $env{'form.folderpath'} = $supppath;
19437: }
19438: }
19439: return;
19440: }
19441:
1.1094 raeburn 19442: sub captcha_display {
1.1327 raeburn 19443: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19444: my ($output,$error);
1.1234 raeburn 19445: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19446: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19447: if ($captcha eq 'original') {
1.1094 raeburn 19448: $output = &create_captcha();
19449: unless ($output) {
1.1172 raeburn 19450: $error = 'captcha';
1.1094 raeburn 19451: }
19452: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19453: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19454: unless ($output) {
1.1172 raeburn 19455: $error = 'recaptcha';
1.1094 raeburn 19456: }
19457: }
1.1234 raeburn 19458: return ($output,$error,$captcha,$version);
1.1094 raeburn 19459: }
19460:
19461: sub captcha_response {
1.1327 raeburn 19462: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19463: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19464: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19465: if ($captcha eq 'original') {
1.1094 raeburn 19466: ($captcha_chk,$captcha_error) = &check_captcha();
19467: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19468: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19469: } else {
19470: $captcha_chk = 1;
19471: }
19472: return ($captcha_chk,$captcha_error);
19473: }
19474:
19475: sub get_captcha_config {
1.1327 raeburn 19476: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19477: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19478: my $hostname = &Apache::lonnet::hostname($lonhost);
19479: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19480: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19481: if ($context eq 'usercreation') {
19482: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19483: if (ref($domconfig{$context}) eq 'HASH') {
19484: $hashtocheck = $domconfig{$context}{'cancreate'};
19485: if (ref($hashtocheck) eq 'HASH') {
19486: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19487: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19488: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19489: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19490: }
19491: if ($privkey && $pubkey) {
19492: $captcha = 'recaptcha';
1.1234 raeburn 19493: $version = $hashtocheck->{'recaptchaversion'};
19494: if ($version ne '2') {
19495: $version = 1;
19496: }
1.1095 raeburn 19497: } else {
19498: $captcha = 'original';
19499: }
19500: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19501: $captcha = 'original';
19502: }
1.1094 raeburn 19503: }
1.1095 raeburn 19504: } else {
19505: $captcha = 'captcha';
19506: }
19507: } elsif ($context eq 'login') {
19508: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19509: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19510: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19511: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19512: if ($privkey && $pubkey) {
19513: $captcha = 'recaptcha';
1.1234 raeburn 19514: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19515: if ($version ne '2') {
19516: $version = 1;
19517: }
1.1095 raeburn 19518: } else {
19519: $captcha = 'original';
1.1094 raeburn 19520: }
1.1095 raeburn 19521: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19522: $captcha = 'original';
1.1094 raeburn 19523: }
1.1327 raeburn 19524: } elsif ($context eq 'passwords') {
19525: if ($dom_in_effect) {
19526: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19527: if ($passwdconf{'captcha'} eq 'recaptcha') {
19528: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19529: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19530: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19531: }
19532: if ($privkey && $pubkey) {
19533: $captcha = 'recaptcha';
19534: $version = $passwdconf{'recaptchaversion'};
19535: if ($version ne '2') {
19536: $version = 1;
19537: }
19538: } else {
19539: $captcha = 'original';
19540: }
19541: } elsif ($passwdconf{'captcha'} ne 'notused') {
19542: $captcha = 'original';
19543: }
19544: }
19545: }
1.1234 raeburn 19546: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19547: }
19548:
19549: sub create_captcha {
19550: my %captcha_params = &captcha_settings();
19551: my ($output,$maxtries,$tries) = ('',10,0);
19552: while ($tries < $maxtries) {
19553: $tries ++;
19554: my $captcha = Authen::Captcha->new (
19555: output_folder => $captcha_params{'output_dir'},
19556: data_folder => $captcha_params{'db_dir'},
19557: );
19558: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19559:
19560: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19561: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19562: '<span class="LC_nobreak">'.
1.1094 raeburn 19563: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19564: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19565: '</span><br />'.
1.1176 raeburn 19566: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19567: last;
19568: }
19569: }
1.1323 raeburn 19570: if ($output eq '') {
19571: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19572: }
1.1094 raeburn 19573: return $output;
19574: }
19575:
19576: sub captcha_settings {
19577: my %captcha_params = (
19578: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19579: www_output_dir => "/captchaspool",
19580: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19581: numchars => '5',
19582: );
19583: return %captcha_params;
19584: }
19585:
19586: sub check_captcha {
19587: my ($captcha_chk,$captcha_error);
19588: my $code = $env{'form.code'};
19589: my $md5sum = $env{'form.crypt'};
19590: my %captcha_params = &captcha_settings();
19591: my $captcha = Authen::Captcha->new(
19592: output_folder => $captcha_params{'output_dir'},
19593: data_folder => $captcha_params{'db_dir'},
19594: );
1.1109 raeburn 19595: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19596: my %captcha_hash = (
19597: 0 => 'Code not checked (file error)',
19598: -1 => 'Failed: code expired',
19599: -2 => 'Failed: invalid code (not in database)',
19600: -3 => 'Failed: invalid code (code does not match crypt)',
19601: );
19602: if ($captcha_chk != 1) {
19603: $captcha_error = $captcha_hash{$captcha_chk}
19604: }
19605: return ($captcha_chk,$captcha_error);
19606: }
19607:
19608: sub create_recaptcha {
1.1234 raeburn 19609: my ($pubkey,$version) = @_;
19610: if ($version >= 2) {
1.1367 raeburn 19611: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19612: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19613: } else {
19614: my $use_ssl;
19615: if ($ENV{'SERVER_PORT'} == 443) {
19616: $use_ssl = 1;
19617: }
19618: my $captcha = Captcha::reCAPTCHA->new;
19619: return $captcha->get_options_setter({theme => 'white'})."\n".
19620: $captcha->get_html($pubkey,undef,$use_ssl).
19621: &mt('If the text is hard to read, [_1] will replace them.',
19622: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19623: '<br /><br />';
19624: }
1.1094 raeburn 19625: }
19626:
19627: sub check_recaptcha {
1.1234 raeburn 19628: my ($privkey,$version) = @_;
1.1094 raeburn 19629: my $captcha_chk;
1.1350 raeburn 19630: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19631: if ($version >= 2) {
19632: my %info = (
19633: secret => $privkey,
19634: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19635: remoteip => $ip,
1.1234 raeburn 19636: );
1.1280 raeburn 19637: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19638: $request->content(join('&',map {
19639: my $name = escape($_);
19640: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19641: ? join("&$name=", map {escape($_) } @{$info{$_}})
19642: : &escape($info{$_}) );
19643: } keys(%info)));
19644: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19645: if ($response->is_success) {
19646: my $data = JSON::DWIW->from_json($response->decoded_content);
19647: if (ref($data) eq 'HASH') {
19648: if ($data->{'success'}) {
19649: $captcha_chk = 1;
19650: }
19651: }
19652: }
19653: } else {
19654: my $captcha = Captcha::reCAPTCHA->new;
19655: my $captcha_result =
19656: $captcha->check_answer(
19657: $privkey,
1.1350 raeburn 19658: $ip,
1.1234 raeburn 19659: $env{'form.recaptcha_challenge_field'},
19660: $env{'form.recaptcha_response_field'},
19661: );
19662: if ($captcha_result->{is_valid}) {
19663: $captcha_chk = 1;
19664: }
1.1094 raeburn 19665: }
19666: return $captcha_chk;
19667: }
19668:
1.1174 raeburn 19669: sub emailusername_info {
1.1244 raeburn 19670: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19671: my %titles = &Apache::lonlocal::texthash (
19672: lastname => 'Last Name',
19673: firstname => 'First Name',
19674: institution => 'School/college/university',
19675: location => "School's city, state/province, country",
19676: web => "School's web address",
19677: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19678: id => 'Student/Employee ID',
1.1174 raeburn 19679: );
19680: return (\@fields,\%titles);
19681: }
19682:
1.1161 raeburn 19683: sub cleanup_html {
19684: my ($incoming) = @_;
19685: my $outgoing;
19686: if ($incoming ne '') {
19687: $outgoing = $incoming;
19688: $outgoing =~ s/;/;/g;
19689: $outgoing =~ s/\#/#/g;
19690: $outgoing =~ s/\&/&/g;
19691: $outgoing =~ s/</</g;
19692: $outgoing =~ s/>/>/g;
19693: $outgoing =~ s/\(/(/g;
19694: $outgoing =~ s/\)/)/g;
19695: $outgoing =~ s/"/"/g;
19696: $outgoing =~ s/'/'/g;
19697: $outgoing =~ s/\$/$/g;
19698: $outgoing =~ s{/}{/}g;
19699: $outgoing =~ s/=/=/g;
19700: $outgoing =~ s/\\/\/g
19701: }
19702: return $outgoing;
19703: }
19704:
1.1190 musolffc 19705: # Checks for critical messages and returns a redirect url if one exists.
19706: # $interval indicates how often to check for messages.
1.1282 raeburn 19707: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19708: sub critical_redirect {
1.1282 raeburn 19709: my ($interval,$context) = @_;
1.1356 raeburn 19710: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19711: return ();
19712: }
1.1190 musolffc 19713: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19714: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19715: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19716: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19717: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19718: if ($blocked) {
19719: my $checkrole = "cm./$cdom/$cnum";
19720: if ($env{'request.course.sec'} ne '') {
19721: $checkrole .= "/$env{'request.course.sec'}";
19722: }
19723: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19724: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19725: return;
19726: }
19727: }
19728: }
1.1190 musolffc 19729: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19730: $env{'user.name'});
19731: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19732: my $redirecturl;
1.1190 musolffc 19733: if ($what[0]) {
1.1356 raeburn 19734: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19735: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19736: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19737: return (1, $url);
1.1190 musolffc 19738: }
1.1191 raeburn 19739: }
19740: }
19741: return ();
1.1190 musolffc 19742: }
19743:
1.1174 raeburn 19744: # Use:
19745: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19746: #
19747: ##################################################
19748: # password associated functions #
19749: ##################################################
19750: sub des_keys {
19751: # Make a new key for DES encryption.
19752: # Each key has two parts which are returned separately.
19753: # Please note: Each key must be passed through the &hex function
19754: # before it is output to the web browser. The hex versions cannot
19755: # be used to decrypt.
19756: my @hexstr=('0','1','2','3','4','5','6','7',
19757: '8','9','a','b','c','d','e','f');
19758: my $lkey='';
19759: for (0..7) {
19760: $lkey.=$hexstr[rand(15)];
19761: }
19762: my $ukey='';
19763: for (0..7) {
19764: $ukey.=$hexstr[rand(15)];
19765: }
19766: return ($lkey,$ukey);
19767: }
19768:
19769: sub des_decrypt {
19770: my ($key,$cyphertext) = @_;
19771: my $keybin=pack("H16",$key);
19772: my $cypher;
19773: if ($Crypt::DES::VERSION>=2.03) {
19774: $cypher=new Crypt::DES $keybin;
19775: } else {
19776: $cypher=new DES $keybin;
19777: }
1.1233 raeburn 19778: my $plaintext='';
19779: my $cypherlength = length($cyphertext);
19780: my $numchunks = int($cypherlength/32);
19781: for (my $j=0; $j<$numchunks; $j++) {
19782: my $start = $j*32;
19783: my $cypherblock = substr($cyphertext,$start,32);
19784: my $chunk =
19785: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19786: $chunk .=
19787: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19788: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19789: $plaintext .= $chunk;
19790: }
1.1174 raeburn 19791: return $plaintext;
19792: }
19793:
1.1344 raeburn 19794: sub get_requested_shorturls {
1.1309 raeburn 19795: my ($cdom,$cnum,$navmap) = @_;
19796: return unless (ref($navmap));
1.1344 raeburn 19797: my ($numnew,$errors);
1.1309 raeburn 19798: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19799: if (@toshorten) {
19800: my (%maps,%resources,%titles);
19801: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19802: 'shorturls',$cdom,$cnum);
19803: if (keys(%resources)) {
1.1344 raeburn 19804: my %tocreate;
1.1309 raeburn 19805: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19806: my $symb = $resources{$item};
19807: if ($symb) {
19808: $tocreate{$cnum.'&'.$symb} = 1;
19809: }
19810: }
1.1344 raeburn 19811: if (keys(%tocreate)) {
19812: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19813: \%tocreate);
19814: }
1.1309 raeburn 19815: }
1.1344 raeburn 19816: }
19817: return ($numnew,$errors);
19818: }
19819:
19820: sub make_short_symbs {
19821: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19822: my ($numnew,@errors);
19823: if (ref($tocreateref) eq 'HASH') {
19824: my %tocreate = %{$tocreateref};
1.1309 raeburn 19825: if (keys(%tocreate)) {
19826: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19827: my $su = Short::URL->new(no_vowels => 1);
19828: my $init = '';
19829: my (%newunique,%addcourse,%courseonly,%failed);
19830: # get lock on tiny db
19831: my $now = time;
1.1344 raeburn 19832: if ($lockuser eq '') {
19833: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19834: }
1.1309 raeburn 19835: my $lockhash = {
1.1344 raeburn 19836: "lock\0$now" => $lockuser,
1.1309 raeburn 19837: };
19838: my $tries = 0;
19839: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19840: my ($code,$error);
19841: while (($gotlock ne 'ok') && ($tries<3)) {
19842: $tries ++;
19843: sleep 1;
1.1319 raeburn 19844: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19845: }
19846: if ($gotlock eq 'ok') {
19847: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19848: \%addcourse,\%courseonly,\%failed);
19849: if (keys(%failed)) {
19850: my $numfailed = scalar(keys(%failed));
19851: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19852: }
19853: if (keys(%newunique)) {
19854: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19855: if ($putres eq 'ok') {
19856: $numnew = scalar(keys(%newunique));
19857: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19858: unless ($newputres eq 'ok') {
19859: push(@errors,&mt('error: could not store course look-up of short URLs'));
19860: }
19861: } else {
19862: push(@errors,&mt('error: could not store unique six character URLs'));
19863: }
19864: }
19865: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19866: unless ($dellockres eq 'ok') {
19867: push(@errors,&mt('error: could not release lockfile'));
19868: }
19869: } else {
19870: push(@errors,&mt('error: could not obtain lockfile'));
19871: }
19872: if (keys(%courseonly)) {
19873: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19874: if ($result ne 'ok') {
19875: push(@errors,&mt('error: could not update course look-up of short URLs'));
19876: }
19877: }
19878: }
19879: }
19880: return ($numnew,\@errors);
19881: }
19882:
19883: sub shorten_symbs {
19884: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19885: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19886: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19887: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19888: my (%possibles,%collisions);
19889: foreach my $key (keys(%{$tocreate})) {
19890: my $num = String::CRC32::crc32($key);
19891: my $tiny = $su->encode($num,$init);
19892: if ($tiny) {
19893: $possibles{$tiny} = $key;
19894: }
19895: }
19896: if (!$init) {
19897: $init = 1;
19898: } else {
19899: $init ++;
19900: }
19901: if (keys(%possibles)) {
19902: my @posstiny = keys(%possibles);
19903: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19904: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19905: if (keys(%currtiny)) {
19906: foreach my $key (keys(%currtiny)) {
19907: next if ($currtiny{$key} eq '');
19908: if ($currtiny{$key} eq $possibles{$key}) {
19909: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19910: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19911: $courseonly->{$tsymb} = $key;
19912: }
19913: } else {
19914: $collisions{$possibles{$key}} = 1;
19915: }
19916: delete($possibles{$key});
19917: }
19918: }
19919: foreach my $key (keys(%possibles)) {
19920: $newunique->{$key} = $possibles{$key};
19921: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19922: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19923: $addcourse->{$tsymb} = $key;
19924: }
19925: }
19926: }
19927: if (keys(%collisions)) {
19928: if ($init <5) {
19929: if (!$init) {
19930: $init = 1;
19931: } else {
19932: $init ++;
19933: }
19934: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19935: $newunique,$addcourse,$courseonly,$failed);
19936: } else {
19937: foreach my $key (keys(%collisions)) {
19938: $failed->{$key} = 1;
19939: }
19940: }
19941: }
19942: return $init;
19943: }
19944:
1.1328 raeburn 19945: sub is_nonframeable {
1.1329 raeburn 19946: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19947: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19948: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19949:
19950: $remprotocol = lc($remprotocol);
19951: $remhost = lc($remhost);
19952: my $remport = 80;
19953: if ($remprotocol eq 'https') {
19954: $remport = 443;
19955: }
1.1330 raeburn 19956: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19957: if ($cached) {
19958: unless ($nocache) {
19959: if ($result) {
19960: return 1;
19961: } else {
19962: return 0;
19963: }
19964: }
19965: }
1.1328 raeburn 19966: my $uselink;
19967: my $request = new HTTP::Request('HEAD',$url);
19968: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19969: if ($response->is_success()) {
19970: my $secpolicy = lc($response->header('content-security-policy'));
19971: my $xframeop = lc($response->header('x-frame-options'));
19972: $secpolicy =~ s/^\s+|\s+$//g;
19973: $xframeop =~ s/^\s+|\s+$//g;
19974: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19975: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19976: my ($origin,$protocol,$port);
19977: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19978: $port = $ENV{'SERVER_PORT'};
19979: } else {
19980: $port = 80;
19981: }
19982: if ($absolute eq '') {
19983: $protocol = 'http:';
19984: if ($port == 443) {
19985: $protocol = 'https:';
19986: }
19987: $origin = $protocol.'//'.lc($hostname);
19988: } else {
19989: $origin = lc($absolute);
19990: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19991: }
19992: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19993: my $framepolicy = $1;
19994: $framepolicy =~ s/^\s+|\s+$//g;
19995: my @policies = split(/\s+/,$framepolicy);
19996: if (@policies) {
19997: if (grep(/^\Q'none'\E$/,@policies)) {
19998: $uselink = 1;
19999: } else {
20000: $uselink = 1;
20001: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20002: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20003: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20004: undef($uselink);
20005: }
20006: if ($uselink) {
20007: if (grep(/^\Q'self'\E$/,@policies)) {
20008: if (($origin ne '') && ($remotehost eq $origin)) {
20009: undef($uselink);
20010: }
20011: }
20012: }
20013: if ($uselink) {
20014: my @possok;
20015: if ($ip ne '') {
20016: push(@possok,$ip);
20017: }
20018: my $hoststr = '';
20019: foreach my $part (reverse(split(/\./,$hostname))) {
20020: if ($hoststr eq '') {
20021: $hoststr = $part;
20022: } else {
20023: $hoststr = "$part.$hoststr";
20024: }
20025: if ($hoststr eq $hostname) {
20026: push(@possok,$hostname);
20027: } else {
20028: push(@possok,"*.$hoststr");
20029: }
20030: }
20031: if (@possok) {
20032: foreach my $poss (@possok) {
20033: last if (!$uselink);
20034: foreach my $policy (@policies) {
20035: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20036: undef($uselink);
20037: last;
20038: }
20039: }
20040: }
20041: }
20042: }
20043: }
20044: }
20045: } elsif ($xframeop ne '') {
20046: $uselink = 1;
20047: my @policies = split(/\s*,\s*/,$xframeop);
20048: if (@policies) {
20049: unless (grep(/^deny$/,@policies)) {
20050: if ($origin ne '') {
20051: if (grep(/^sameorigin$/,@policies)) {
20052: if ($remotehost eq $origin) {
20053: undef($uselink);
20054: }
20055: }
20056: if ($uselink) {
20057: foreach my $policy (@policies) {
20058: if ($policy =~ /^allow-from\s*(.+)$/) {
20059: my $allowfrom = $1;
20060: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20061: undef($uselink);
20062: last;
20063: }
20064: }
20065: }
20066: }
20067: }
20068: }
20069: }
20070: }
20071: }
20072: }
1.1329 raeburn 20073: if ($nocache) {
20074: if ($cached) {
20075: my $devalidate;
20076: if ($uselink && !$result) {
20077: $devalidate = 1;
20078: } elsif (!$uselink && $result) {
20079: $devalidate = 1;
20080: }
20081: if ($devalidate) {
20082: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20083: }
20084: }
20085: } else {
20086: if ($uselink) {
20087: $result = 1;
20088: } else {
20089: $result = 0;
20090: }
20091: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20092: }
1.1328 raeburn 20093: return $uselink;
20094: }
20095:
1.1359 raeburn 20096: sub page_menu {
20097: my ($menucolls,$menunum) = @_;
20098: my %menu;
20099: foreach my $item (split(/;/,$menucolls)) {
20100: my ($num,$value) = split(/\%/,$item);
20101: if ($num eq $menunum) {
20102: my @entries = split(/\&/,$value);
20103: foreach my $entry (@entries) {
20104: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20105: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20106: $menu{$name} = $fields;
20107: } else {
20108: my @shown;
20109: if ($fields =~ /,/) {
20110: @shown = split(/,/,$fields);
20111: } else {
20112: @shown = ($fields);
20113: }
20114: if (@shown) {
20115: foreach my $field (@shown) {
20116: next if ($field eq '');
20117: $menu{$field} = 1;
20118: }
20119: }
20120: }
20121: }
20122: }
20123: }
20124: return %menu;
20125: }
20126:
1.112 bowersj2 20127: 1;
20128: __END__;
1.41 ng 20129:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>