Annotation of loncom/interface/loncommon.pm, revision 1.1448
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1448 ! raeburn 4: # $Id: loncommon.pm,v 1.1447 2025/01/26 07:17:02 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.1448 ! raeburn 8238: .LC_mail_actions {
! 8239: float: left;
! 8240: padding: 0;
! 8241: margin: 6px;
! 8242: }
! 8243:
! 8244: .LC_vertical_line {
! 8245: width: 1px;
! 8246: background-color: black;
! 8247: height: 4em;
! 8248: float: left;
! 8249: margin: 0;
! 8250: padding: 0;
! 8251: }
! 8252:
1.529 albertel 8253: span.LC_prior_numerical,
8254: span.LC_prior_string,
8255: span.LC_prior_custom,
8256: span.LC_prior_reaction,
8257: span.LC_prior_math {
1.925 bisitz 8258: font-family: $mono;
1.523 albertel 8259: white-space: pre;
8260: }
8261:
1.525 albertel 8262: span.LC_prior_string {
1.925 bisitz 8263: font-family: $mono;
1.525 albertel 8264: white-space: pre;
8265: }
8266:
1.523 albertel 8267: table.LC_prior_option {
8268: width: 100%;
8269: border-collapse: collapse;
8270: }
1.795 www 8271:
1.911 bisitz 8272: table.LC_prior_rank,
1.795 www 8273: table.LC_prior_match {
1.528 albertel 8274: border-collapse: collapse;
8275: }
1.795 www 8276:
1.528 albertel 8277: table.LC_prior_option tr td,
8278: table.LC_prior_rank tr td,
8279: table.LC_prior_match tr td {
1.524 albertel 8280: border: 1px solid #000000;
1.515 albertel 8281: }
8282:
1.855 bisitz 8283: .LC_nobreak {
1.544 albertel 8284: white-space: nowrap;
1.519 raeburn 8285: }
8286:
1.576 raeburn 8287: span.LC_cusr_emph {
8288: font-style: italic;
8289: }
8290:
1.633 raeburn 8291: span.LC_cusr_subheading {
8292: font-weight: normal;
8293: font-size: 85%;
8294: }
8295:
1.861 bisitz 8296: div.LC_docs_entry_move {
1.859 bisitz 8297: border: 1px solid #BBBBBB;
1.545 albertel 8298: background: #DDDDDD;
1.861 bisitz 8299: width: 22px;
1.859 bisitz 8300: padding: 1px;
8301: margin: 0;
1.545 albertel 8302: }
8303:
1.861 bisitz 8304: table.LC_data_table tr > td.LC_docs_entry_commands,
8305: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8306: font-size: x-small;
8307: }
1.795 www 8308:
1.861 bisitz 8309: .LC_docs_entry_parameter {
8310: white-space: nowrap;
8311: }
8312:
1.544 albertel 8313: .LC_docs_copy {
1.545 albertel 8314: color: #000099;
1.544 albertel 8315: }
1.795 www 8316:
1.544 albertel 8317: .LC_docs_cut {
1.545 albertel 8318: color: #550044;
1.544 albertel 8319: }
1.795 www 8320:
1.544 albertel 8321: .LC_docs_rename {
1.545 albertel 8322: color: #009900;
1.544 albertel 8323: }
1.795 www 8324:
1.544 albertel 8325: .LC_docs_remove {
1.545 albertel 8326: color: #990000;
8327: }
8328:
1.1284 raeburn 8329: .LC_docs_alias {
8330: color: #440055;
8331: }
8332:
1.1286 raeburn 8333: .LC_domprefs_email,
1.1284 raeburn 8334: .LC_docs_alias_name,
1.547 albertel 8335: .LC_docs_reinit_warn,
8336: .LC_docs_ext_edit {
8337: font-size: x-small;
8338: }
8339:
1.545 albertel 8340: table.LC_docs_adddocs td,
8341: table.LC_docs_adddocs th {
8342: border: 1px solid #BBBBBB;
8343: padding: 4px;
8344: background: #DDDDDD;
1.543 albertel 8345: }
8346:
1.584 albertel 8347: table.LC_sty_begin {
8348: background: #BBFFBB;
8349: }
1.795 www 8350:
1.584 albertel 8351: table.LC_sty_end {
8352: background: #FFBBBB;
8353: }
8354:
1.589 raeburn 8355: table.LC_double_column {
1.803 bisitz 8356: border-width: 0;
1.589 raeburn 8357: border-collapse: collapse;
8358: width: 100%;
8359: padding: 2px;
8360: }
8361:
8362: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8363: top: 2px;
1.589 raeburn 8364: left: 2px;
8365: width: 47%;
8366: vertical-align: top;
8367: }
8368:
8369: table.LC_double_column tr td.LC_right_col {
8370: top: 2px;
1.779 bisitz 8371: right: 2px;
1.589 raeburn 8372: width: 47%;
8373: vertical-align: top;
8374: }
8375:
1.591 raeburn 8376: div.LC_left_float {
8377: float: left;
8378: padding-right: 5%;
1.597 albertel 8379: padding-bottom: 4px;
1.591 raeburn 8380: }
8381:
8382: div.LC_clear_float_header {
1.597 albertel 8383: padding-bottom: 2px;
1.591 raeburn 8384: }
8385:
8386: div.LC_clear_float_footer {
1.597 albertel 8387: padding-top: 10px;
1.591 raeburn 8388: clear: both;
8389: }
8390:
1.597 albertel 8391: div.LC_grade_show_user {
1.941 bisitz 8392: /* border-left: 5px solid $sidebg; */
8393: border-top: 5px solid #000000;
8394: margin: 50px 0 0 0;
1.936 bisitz 8395: padding: 15px 0 5px 10px;
1.597 albertel 8396: }
1.795 www 8397:
1.936 bisitz 8398: div.LC_grade_show_user_odd_row {
1.941 bisitz 8399: /* border-left: 5px solid #000000; */
8400: }
8401:
8402: div.LC_grade_show_user div.LC_Box {
8403: margin-right: 50px;
1.597 albertel 8404: }
8405:
8406: div.LC_grade_submissions,
8407: div.LC_grade_message_center,
1.936 bisitz 8408: div.LC_grade_info_links {
1.597 albertel 8409: margin: 5px;
8410: width: 99%;
8411: background: #FFFFFF;
8412: }
1.795 www 8413:
1.597 albertel 8414: div.LC_grade_submissions_header,
1.936 bisitz 8415: div.LC_grade_message_center_header {
1.705 tempelho 8416: font-weight: bold;
8417: font-size: large;
1.597 albertel 8418: }
1.795 www 8419:
1.597 albertel 8420: div.LC_grade_submissions_body,
1.936 bisitz 8421: div.LC_grade_message_center_body {
1.597 albertel 8422: border: 1px solid black;
8423: width: 99%;
8424: background: #FFFFFF;
8425: }
1.795 www 8426:
1.613 albertel 8427: table.LC_scantron_action {
8428: width: 100%;
8429: }
1.795 www 8430:
1.613 albertel 8431: table.LC_scantron_action tr th {
1.698 harmsja 8432: font-weight:bold;
8433: font-style:normal;
1.613 albertel 8434: }
1.795 www 8435:
1.779 bisitz 8436: .LC_edit_problem_header,
1.614 albertel 8437: div.LC_edit_problem_footer {
1.705 tempelho 8438: font-weight: normal;
8439: font-size: medium;
1.602 albertel 8440: margin: 2px;
1.1060 bisitz 8441: background-color: $sidebg;
1.600 albertel 8442: }
1.795 www 8443:
1.600 albertel 8444: div.LC_edit_problem_header,
1.602 albertel 8445: div.LC_edit_problem_header div,
1.614 albertel 8446: div.LC_edit_problem_footer,
8447: div.LC_edit_problem_footer div,
1.602 albertel 8448: div.LC_edit_problem_editxml_header,
8449: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8450: z-index: 100;
1.600 albertel 8451: }
1.795 www 8452:
1.600 albertel 8453: div.LC_edit_problem_header_title {
1.705 tempelho 8454: font-weight: bold;
8455: font-size: larger;
1.602 albertel 8456: background: $tabbg;
8457: padding: 3px;
1.1060 bisitz 8458: margin: 0 0 5px 0;
1.602 albertel 8459: }
1.795 www 8460:
1.602 albertel 8461: table.LC_edit_problem_header_title {
8462: width: 100%;
1.600 albertel 8463: background: $tabbg;
1.602 albertel 8464: }
8465:
1.1205 golterma 8466: div.LC_edit_actionbar {
8467: background-color: $sidebg;
1.1218 droeschl 8468: margin: 0;
8469: padding: 0;
8470: line-height: 200%;
1.602 albertel 8471: }
1.795 www 8472:
1.1218 droeschl 8473: div.LC_edit_actionbar div{
8474: padding: 0;
8475: margin: 0;
8476: display: inline-block;
1.600 albertel 8477: }
1.795 www 8478:
1.1124 bisitz 8479: .LC_edit_opt {
8480: padding-left: 1em;
8481: white-space: nowrap;
8482: }
8483:
1.1152 golterma 8484: .LC_edit_problem_latexhelper{
8485: text-align: right;
8486: }
8487:
8488: #LC_edit_problem_colorful div{
8489: margin-left: 40px;
8490: }
8491:
1.1205 golterma 8492: #LC_edit_problem_codemirror div{
8493: margin-left: 0px;
8494: }
8495:
1.911 bisitz 8496: img.stift {
1.803 bisitz 8497: border-width: 0;
8498: vertical-align: middle;
1.677 riegler 8499: }
1.680 riegler 8500:
1.923 bisitz 8501: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8502: vertical-align: top;
1.777 tempelho 8503: }
1.795 www 8504:
1.716 raeburn 8505: div.LC_createcourse {
1.911 bisitz 8506: margin: 10px 10px 10px 10px;
1.716 raeburn 8507: }
8508:
1.917 raeburn 8509: .LC_dccid {
1.1130 raeburn 8510: float: right;
1.917 raeburn 8511: margin: 0.2em 0 0 0;
8512: padding: 0;
8513: font-size: 90%;
8514: display:none;
8515: }
8516:
1.897 wenzelju 8517: ol.LC_primary_menu a:hover,
1.721 harmsja 8518: ol#LC_MenuBreadcrumbs a:hover,
8519: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8520: ul#LC_secondary_menu a:hover,
1.721 harmsja 8521: .LC_FormSectionClearButton input:hover
1.795 www 8522: ul.LC_TabContent li:hover a {
1.952 onken 8523: color:$button_hover;
1.911 bisitz 8524: text-decoration:none;
1.693 droeschl 8525: }
8526:
1.779 bisitz 8527: h1 {
1.911 bisitz 8528: padding: 0;
8529: line-height:130%;
1.693 droeschl 8530: }
1.698 harmsja 8531:
1.911 bisitz 8532: h2,
8533: h3,
8534: h4,
8535: h5,
8536: h6 {
8537: margin: 5px 0 5px 0;
8538: padding: 0;
8539: line-height:130%;
1.693 droeschl 8540: }
1.795 www 8541:
8542: .LC_hcell {
1.911 bisitz 8543: padding:3px 15px 3px 15px;
8544: margin: 0;
8545: background-color:$tabbg;
8546: color:$fontmenu;
8547: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8548: }
1.795 www 8549:
1.840 bisitz 8550: .LC_Box > .LC_hcell {
1.911 bisitz 8551: margin: 0 -10px 10px -10px;
1.835 bisitz 8552: }
8553:
1.721 harmsja 8554: .LC_noBorder {
1.911 bisitz 8555: border: 0;
1.698 harmsja 8556: }
1.693 droeschl 8557:
1.721 harmsja 8558: .LC_FormSectionClearButton input {
1.911 bisitz 8559: background-color:transparent;
8560: border: none;
8561: cursor:pointer;
8562: text-decoration:underline;
1.693 droeschl 8563: }
1.763 bisitz 8564:
8565: .LC_help_open_topic {
1.911 bisitz 8566: color: #FFFFFF;
8567: background-color: #EEEEFF;
8568: margin: 1px;
8569: padding: 4px;
8570: border: 1px solid #000033;
8571: white-space: nowrap;
8572: /* vertical-align: middle; */
1.759 neumanie 8573: }
1.693 droeschl 8574:
1.911 bisitz 8575: dl,
8576: ul,
8577: div,
8578: fieldset {
8579: margin: 10px 10px 10px 0;
8580: /* overflow: hidden; */
1.693 droeschl 8581: }
1.795 www 8582:
1.1404 raeburn 8583: fieldset#LC_selectuser {
8584: margin: 0;
8585: padding: 0;
8586: }
8587:
1.1211 raeburn 8588: article.geogebraweb div {
8589: margin: 0;
8590: }
8591:
1.838 bisitz 8592: fieldset > legend {
1.911 bisitz 8593: font-weight: bold;
8594: padding: 0 5px 0 5px;
1.838 bisitz 8595: }
8596:
1.813 bisitz 8597: #LC_nav_bar {
1.911 bisitz 8598: float: left;
1.995 raeburn 8599: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8600: margin: 0 0 2px 0;
1.807 droeschl 8601: }
8602:
1.916 droeschl 8603: #LC_realm {
8604: margin: 0.2em 0 0 0;
8605: padding: 0;
8606: font-weight: bold;
8607: text-align: center;
1.995 raeburn 8608: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8609: }
8610:
1.911 bisitz 8611: #LC_nav_bar em {
8612: font-weight: bold;
8613: font-style: normal;
1.807 droeschl 8614: }
8615:
1.897 wenzelju 8616: ol.LC_primary_menu {
1.934 droeschl 8617: margin: 0;
1.1076 raeburn 8618: padding: 0;
1.807 droeschl 8619: }
8620:
1.852 droeschl 8621: ol#LC_PathBreadcrumbs {
1.911 bisitz 8622: margin: 0;
1.693 droeschl 8623: }
8624:
1.897 wenzelju 8625: ol.LC_primary_menu li {
1.1076 raeburn 8626: color: RGB(80, 80, 80);
8627: vertical-align: middle;
8628: text-align: left;
8629: list-style: none;
1.1205 golterma 8630: position: relative;
1.1076 raeburn 8631: float: left;
1.1205 golterma 8632: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8633: line-height: 1.5em;
1.1076 raeburn 8634: }
8635:
1.1205 golterma 8636: ol.LC_primary_menu li a,
8637: ol.LC_primary_menu li p {
1.1076 raeburn 8638: display: block;
8639: margin: 0;
8640: padding: 0 5px 0 10px;
8641: text-decoration: none;
8642: }
8643:
1.1205 golterma 8644: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8645: display: inline-block;
8646: width: 95%;
8647: text-align: left;
8648: }
8649:
8650: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8651: display: inline-block;
8652: width: 5%;
8653: float: right;
8654: text-align: right;
8655: font-size: 70%;
8656: }
8657:
8658: ol.LC_primary_menu ul {
1.1076 raeburn 8659: display: none;
1.1205 golterma 8660: width: 15em;
1.1076 raeburn 8661: background-color: $data_table_light;
1.1205 golterma 8662: position: absolute;
8663: top: 100%;
1.1076 raeburn 8664: }
8665:
1.1205 golterma 8666: ol.LC_primary_menu ul ul {
8667: left: 100%;
8668: top: 0;
8669: }
8670:
8671: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8672: display: block;
8673: position: absolute;
8674: margin: 0;
8675: padding: 0;
1.1078 raeburn 8676: z-index: 2;
1.1076 raeburn 8677: }
8678:
8679: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8680: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8681: font-size: 90%;
1.911 bisitz 8682: vertical-align: top;
1.1076 raeburn 8683: float: none;
1.1079 raeburn 8684: border-left: 1px solid black;
8685: border-right: 1px solid black;
1.1205 golterma 8686: /* A dark bottom border to visualize different menu options;
8687: overwritten in the create_submenu routine for the last border-bottom of the menu */
8688: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8689: }
8690:
1.1205 golterma 8691: ol.LC_primary_menu li li p:hover {
8692: color:$button_hover;
8693: text-decoration:none;
8694: background-color:$data_table_dark;
1.1076 raeburn 8695: }
8696:
8697: ol.LC_primary_menu li li a:hover {
8698: color:$button_hover;
8699: background-color:$data_table_dark;
1.693 droeschl 8700: }
8701:
1.1205 golterma 8702: /* Font-size equal to the size of the predecessors*/
8703: ol.LC_primary_menu li:hover li li {
8704: font-size: 100%;
8705: }
8706:
1.897 wenzelju 8707: ol.LC_primary_menu li img {
1.911 bisitz 8708: vertical-align: bottom;
1.934 droeschl 8709: height: 1.1em;
1.1077 raeburn 8710: margin: 0.2em 0 0 0;
1.693 droeschl 8711: }
8712:
1.897 wenzelju 8713: ol.LC_primary_menu a {
1.911 bisitz 8714: color: RGB(80, 80, 80);
8715: text-decoration: none;
1.693 droeschl 8716: }
1.795 www 8717:
1.949 droeschl 8718: ol.LC_primary_menu a.LC_new_message {
8719: font-weight:bold;
8720: color: darkred;
8721: }
8722:
1.975 raeburn 8723: ol.LC_docs_parameters {
8724: margin-left: 0;
8725: padding: 0;
8726: list-style: none;
8727: }
8728:
8729: ol.LC_docs_parameters li {
8730: margin: 0;
8731: padding-right: 20px;
8732: display: inline;
8733: }
8734:
1.976 raeburn 8735: ol.LC_docs_parameters li:before {
8736: content: "\\002022 \\0020";
8737: }
8738:
8739: li.LC_docs_parameters_title {
8740: font-weight: bold;
8741: }
8742:
8743: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8744: content: "";
8745: }
8746:
1.897 wenzelju 8747: ul#LC_secondary_menu {
1.1107 raeburn 8748: clear: right;
1.911 bisitz 8749: color: $fontmenu;
8750: background: $tabbg;
8751: list-style: none;
8752: padding: 0;
8753: margin: 0;
8754: width: 100%;
1.995 raeburn 8755: text-align: left;
1.1107 raeburn 8756: float: left;
1.808 droeschl 8757: }
8758:
1.897 wenzelju 8759: ul#LC_secondary_menu li {
1.911 bisitz 8760: font-weight: bold;
8761: line-height: 1.8em;
1.1107 raeburn 8762: border-right: 1px solid black;
8763: float: left;
8764: }
8765:
8766: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8767: background-color: $data_table_light;
8768: }
8769:
8770: ul#LC_secondary_menu li a {
1.911 bisitz 8771: padding: 0 0.8em;
1.1107 raeburn 8772: }
8773:
8774: ul#LC_secondary_menu li ul {
8775: display: none;
8776: }
8777:
8778: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8779: display: block;
8780: position: absolute;
8781: margin: 0;
8782: padding: 0;
8783: list-style:none;
8784: float: none;
8785: background-color: $data_table_light;
8786: z-index: 2;
8787: margin-left: -1px;
8788: }
8789:
8790: ul#LC_secondary_menu li ul li {
8791: font-size: 90%;
8792: vertical-align: top;
8793: border-left: 1px solid black;
1.911 bisitz 8794: border-right: 1px solid black;
1.1119 raeburn 8795: background-color: $data_table_light;
1.1107 raeburn 8796: list-style:none;
8797: float: none;
8798: }
8799:
8800: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8801: background-color: $data_table_dark;
1.807 droeschl 8802: }
8803:
1.847 tempelho 8804: ul.LC_TabContent {
1.911 bisitz 8805: display:block;
8806: background: $sidebg;
8807: border-bottom: solid 1px $lg_border_color;
8808: list-style:none;
1.1020 raeburn 8809: margin: -1px -10px 0 -10px;
1.911 bisitz 8810: padding: 0;
1.693 droeschl 8811: }
8812:
1.795 www 8813: ul.LC_TabContent li,
8814: ul.LC_TabContentBigger li {
1.911 bisitz 8815: float:left;
1.741 harmsja 8816: }
1.795 www 8817:
1.897 wenzelju 8818: ul#LC_secondary_menu li a {
1.911 bisitz 8819: color: $fontmenu;
8820: text-decoration: none;
1.693 droeschl 8821: }
1.795 www 8822:
1.721 harmsja 8823: ul.LC_TabContent {
1.952 onken 8824: min-height:20px;
1.721 harmsja 8825: }
1.795 www 8826:
8827: ul.LC_TabContent li {
1.911 bisitz 8828: vertical-align:middle;
1.959 onken 8829: padding: 0 16px 0 10px;
1.911 bisitz 8830: background-color:$tabbg;
8831: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8832: border-left: solid 1px $font;
1.721 harmsja 8833: }
1.795 www 8834:
1.847 tempelho 8835: ul.LC_TabContent .right {
1.911 bisitz 8836: float:right;
1.847 tempelho 8837: }
8838:
1.911 bisitz 8839: ul.LC_TabContent li a,
8840: ul.LC_TabContent li {
8841: color:rgb(47,47,47);
8842: text-decoration:none;
8843: font-size:95%;
8844: font-weight:bold;
1.952 onken 8845: min-height:20px;
8846: }
8847:
1.959 onken 8848: ul.LC_TabContent li a:hover,
8849: ul.LC_TabContent li a:focus {
1.952 onken 8850: color: $button_hover;
1.959 onken 8851: background:none;
8852: outline:none;
1.952 onken 8853: }
8854:
8855: ul.LC_TabContent li:hover {
8856: color: $button_hover;
8857: cursor:pointer;
1.721 harmsja 8858: }
1.795 www 8859:
1.911 bisitz 8860: ul.LC_TabContent li.active {
1.952 onken 8861: color: $font;
1.911 bisitz 8862: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8863: border-bottom:solid 1px #FFFFFF;
8864: cursor: default;
1.744 ehlerst 8865: }
1.795 www 8866:
1.959 onken 8867: ul.LC_TabContent li.active a {
8868: color:$font;
8869: background:#FFFFFF;
8870: outline: none;
8871: }
1.1047 raeburn 8872:
8873: ul.LC_TabContent li.goback {
8874: float: left;
8875: border-left: none;
8876: }
8877:
1.870 tempelho 8878: #maincoursedoc {
1.911 bisitz 8879: clear:both;
1.870 tempelho 8880: }
8881:
8882: ul.LC_TabContentBigger {
1.911 bisitz 8883: display:block;
8884: list-style:none;
8885: padding: 0;
1.870 tempelho 8886: }
8887:
1.795 www 8888: ul.LC_TabContentBigger li {
1.911 bisitz 8889: vertical-align:bottom;
8890: height: 30px;
8891: font-size:110%;
8892: font-weight:bold;
8893: color: #737373;
1.841 tempelho 8894: }
8895:
1.957 onken 8896: ul.LC_TabContentBigger li.active {
8897: position: relative;
8898: top: 1px;
8899: }
8900:
1.870 tempelho 8901: ul.LC_TabContentBigger li a {
1.911 bisitz 8902: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8903: height: 30px;
8904: line-height: 30px;
8905: text-align: center;
8906: display: block;
8907: text-decoration: none;
1.958 onken 8908: outline: none;
1.741 harmsja 8909: }
1.795 www 8910:
1.870 tempelho 8911: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8912: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8913: color:$font;
1.744 ehlerst 8914: }
1.795 www 8915:
1.870 tempelho 8916: ul.LC_TabContentBigger li b {
1.911 bisitz 8917: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8918: display: block;
8919: float: left;
8920: padding: 0 30px;
1.957 onken 8921: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8922: }
8923:
1.956 onken 8924: ul.LC_TabContentBigger li:hover b {
8925: color:$button_hover;
8926: }
8927:
1.870 tempelho 8928: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8929: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8930: color:$font;
1.957 onken 8931: border: 0;
1.741 harmsja 8932: }
1.693 droeschl 8933:
1.870 tempelho 8934:
1.862 bisitz 8935: ul.LC_CourseBreadcrumbs {
8936: background: $sidebg;
1.1020 raeburn 8937: height: 2em;
1.862 bisitz 8938: padding-left: 10px;
1.1020 raeburn 8939: margin: 0;
1.862 bisitz 8940: list-style-position: inside;
8941: }
8942:
1.911 bisitz 8943: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8944: ol#LC_PathBreadcrumbs {
1.911 bisitz 8945: padding-left: 10px;
8946: margin: 0;
1.933 droeschl 8947: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8948: }
8949:
1.911 bisitz 8950: ol#LC_MenuBreadcrumbs li,
8951: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8952: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8953: display: inline;
1.933 droeschl 8954: white-space: normal;
1.693 droeschl 8955: }
8956:
1.823 bisitz 8957: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8958: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8959: text-decoration: none;
8960: font-size:90%;
1.693 droeschl 8961: }
1.795 www 8962:
1.969 droeschl 8963: ol#LC_MenuBreadcrumbs h1 {
8964: display: inline;
8965: font-size: 90%;
8966: line-height: 2.5em;
8967: margin: 0;
8968: padding: 0;
8969: }
8970:
1.795 www 8971: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8972: text-decoration:none;
8973: font-size:100%;
8974: font-weight:bold;
1.693 droeschl 8975: }
1.795 www 8976:
1.840 bisitz 8977: .LC_Box {
1.911 bisitz 8978: border: solid 1px $lg_border_color;
8979: padding: 0 10px 10px 10px;
1.746 neumanie 8980: }
1.795 www 8981:
1.1020 raeburn 8982: .LC_DocsBox {
8983: border: solid 1px $lg_border_color;
8984: padding: 0 0 10px 10px;
8985: }
8986:
1.795 www 8987: .LC_AboutMe_Image {
1.911 bisitz 8988: float:left;
8989: margin-right:10px;
1.747 neumanie 8990: }
1.795 www 8991:
8992: .LC_Clear_AboutMe_Image {
1.911 bisitz 8993: clear:left;
1.747 neumanie 8994: }
1.795 www 8995:
1.721 harmsja 8996: dl.LC_ListStyleClean dt {
1.911 bisitz 8997: padding-right: 5px;
8998: display: table-header-group;
1.693 droeschl 8999: }
9000:
1.721 harmsja 9001: dl.LC_ListStyleClean dd {
1.911 bisitz 9002: display: table-row;
1.693 droeschl 9003: }
9004:
1.721 harmsja 9005: .LC_ListStyleClean,
9006: .LC_ListStyleSimple,
9007: .LC_ListStyleNormal,
1.795 www 9008: .LC_ListStyleSpecial {
1.911 bisitz 9009: /* display:block; */
9010: list-style-position: inside;
9011: list-style-type: none;
9012: overflow: hidden;
9013: padding: 0;
1.693 droeschl 9014: }
9015:
1.721 harmsja 9016: .LC_ListStyleSimple li,
9017: .LC_ListStyleSimple dd,
9018: .LC_ListStyleNormal li,
9019: .LC_ListStyleNormal dd,
9020: .LC_ListStyleSpecial li,
1.795 www 9021: .LC_ListStyleSpecial dd {
1.911 bisitz 9022: margin: 0;
9023: padding: 5px 5px 5px 10px;
9024: clear: both;
1.693 droeschl 9025: }
9026:
1.721 harmsja 9027: .LC_ListStyleClean li,
9028: .LC_ListStyleClean dd {
1.911 bisitz 9029: padding-top: 0;
9030: padding-bottom: 0;
1.693 droeschl 9031: }
9032:
1.721 harmsja 9033: .LC_ListStyleSimple dd,
1.795 www 9034: .LC_ListStyleSimple li {
1.911 bisitz 9035: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9036: }
9037:
1.721 harmsja 9038: .LC_ListStyleSpecial li,
9039: .LC_ListStyleSpecial dd {
1.911 bisitz 9040: list-style-type: none;
9041: background-color: RGB(220, 220, 220);
9042: margin-bottom: 4px;
1.693 droeschl 9043: }
9044:
1.721 harmsja 9045: table.LC_SimpleTable {
1.911 bisitz 9046: margin:5px;
9047: border:solid 1px $lg_border_color;
1.795 www 9048: }
1.693 droeschl 9049:
1.721 harmsja 9050: table.LC_SimpleTable tr {
1.911 bisitz 9051: padding: 0;
9052: border:solid 1px $lg_border_color;
1.693 droeschl 9053: }
1.795 www 9054:
9055: table.LC_SimpleTable thead {
1.911 bisitz 9056: background:rgb(220,220,220);
1.693 droeschl 9057: }
9058:
1.721 harmsja 9059: div.LC_columnSection {
1.911 bisitz 9060: display: block;
9061: clear: both;
9062: overflow: hidden;
9063: margin: 0;
1.693 droeschl 9064: }
9065:
1.721 harmsja 9066: div.LC_columnSection>* {
1.911 bisitz 9067: float: left;
9068: margin: 10px 20px 10px 0;
9069: overflow:hidden;
1.693 droeschl 9070: }
1.721 harmsja 9071:
1.795 www 9072: table em {
1.911 bisitz 9073: font-weight: bold;
9074: font-style: normal;
1.748 schulted 9075: }
1.795 www 9076:
1.779 bisitz 9077: table.LC_tableBrowseRes,
1.795 www 9078: table.LC_tableOfContent {
1.911 bisitz 9079: border:none;
9080: border-spacing: 1px;
9081: padding: 3px;
9082: background-color: #FFFFFF;
9083: font-size: 90%;
1.753 droeschl 9084: }
1.789 droeschl 9085:
1.911 bisitz 9086: table.LC_tableOfContent {
9087: border-collapse: collapse;
1.789 droeschl 9088: }
9089:
1.771 droeschl 9090: table.LC_tableBrowseRes a,
1.768 schulted 9091: table.LC_tableOfContent a {
1.911 bisitz 9092: background-color: transparent;
9093: text-decoration: none;
1.753 droeschl 9094: }
9095:
1.795 www 9096: table.LC_tableOfContent img {
1.911 bisitz 9097: border: none;
9098: height: 1.3em;
9099: vertical-align: text-bottom;
9100: margin-right: 0.3em;
1.753 droeschl 9101: }
1.757 schulted 9102:
1.795 www 9103: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9104: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9105: }
9106:
1.795 www 9107: a#LC_content_toolbar_everything {
1.911 bisitz 9108: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9109: }
9110:
1.795 www 9111: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9112: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9113: }
9114:
1.795 www 9115: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9116: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9117: }
9118:
1.795 www 9119: a#LC_content_toolbar_changefolder {
1.911 bisitz 9120: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9121: }
9122:
1.795 www 9123: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9124: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9125: }
9126:
1.1043 raeburn 9127: a#LC_content_toolbar_edittoplevel {
9128: background-image:url(/res/adm/pages/edittoplevel.gif);
9129: }
9130:
1.1384 raeburn 9131: a#LC_content_toolbar_printout {
9132: background-image:url(/res/adm/pages/printout.gif);
9133: }
9134:
1.795 www 9135: ul#LC_toolbar li a:hover {
1.911 bisitz 9136: background-position: bottom center;
1.757 schulted 9137: }
9138:
1.795 www 9139: ul#LC_toolbar {
1.911 bisitz 9140: padding: 0;
9141: margin: 2px;
9142: list-style:none;
9143: position:relative;
9144: background-color:white;
1.1082 raeburn 9145: overflow: auto;
1.757 schulted 9146: }
9147:
1.795 www 9148: ul#LC_toolbar li {
1.911 bisitz 9149: border:1px solid white;
9150: padding: 0;
9151: margin: 0;
9152: float: left;
9153: display:inline;
9154: vertical-align:middle;
1.1082 raeburn 9155: white-space: nowrap;
1.911 bisitz 9156: }
1.757 schulted 9157:
1.783 amueller 9158:
1.795 www 9159: a.LC_toolbarItem {
1.911 bisitz 9160: display:block;
9161: padding: 0;
9162: margin: 0;
9163: height: 32px;
9164: width: 32px;
9165: color:white;
9166: border: none;
9167: background-repeat:no-repeat;
9168: background-color:transparent;
1.757 schulted 9169: }
9170:
1.915 droeschl 9171: ul.LC_funclist {
9172: margin: 0;
9173: padding: 0.5em 1em 0.5em 0;
9174: }
9175:
1.933 droeschl 9176: ul.LC_funclist > li:first-child {
9177: font-weight:bold;
9178: margin-left:0.8em;
9179: }
9180:
1.915 droeschl 9181: ul.LC_funclist + ul.LC_funclist {
9182: /*
9183: left border as a seperator if we have more than
9184: one list
9185: */
9186: border-left: 1px solid $sidebg;
9187: /*
9188: this hides the left border behind the border of the
9189: outer box if element is wrapped to the next 'line'
9190: */
9191: margin-left: -1px;
9192: }
9193:
1.843 bisitz 9194: ul.LC_funclist li {
1.915 droeschl 9195: display: inline;
1.782 bisitz 9196: white-space: nowrap;
1.915 droeschl 9197: margin: 0 0 0 25px;
9198: line-height: 150%;
1.782 bisitz 9199: }
9200:
1.974 wenzelju 9201: .LC_hidden {
9202: display: none;
9203: }
9204:
1.1030 www 9205: .LCmodal-overlay {
9206: position:fixed;
9207: top:0;
9208: right:0;
9209: bottom:0;
9210: left:0;
9211: height:100%;
9212: width:100%;
9213: margin:0;
9214: padding:0;
9215: background:#999;
9216: opacity:.75;
9217: filter: alpha(opacity=75);
9218: -moz-opacity: 0.75;
9219: z-index:101;
9220: }
9221:
9222: * html .LCmodal-overlay {
9223: position: absolute;
9224: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9225: }
9226:
9227: .LCmodal-window {
9228: position:fixed;
9229: top:50%;
9230: left:50%;
9231: margin:0;
9232: padding:0;
9233: z-index:102;
9234: }
9235:
9236: * html .LCmodal-window {
9237: position:absolute;
9238: }
9239:
9240: .LCclose-window {
9241: position:absolute;
9242: width:32px;
9243: height:32px;
9244: right:8px;
9245: top:8px;
9246: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9247: text-indent:-99999px;
9248: overflow:hidden;
9249: cursor:pointer;
9250: }
9251:
1.1369 raeburn 9252: .LCisDisabled {
9253: cursor: not-allowed;
9254: opacity: 0.5;
9255: }
9256:
9257: a[aria-disabled="true"] {
9258: color: currentColor;
9259: display: inline-block; /* For IE11/ MS Edge bug */
9260: pointer-events: none;
9261: text-decoration: none;
9262: }
9263:
1.1335 raeburn 9264: pre.LC_wordwrap {
9265: white-space: pre-wrap;
9266: white-space: -moz-pre-wrap;
9267: white-space: -pre-wrap;
9268: white-space: -o-pre-wrap;
9269: word-wrap: break-word;
9270: }
9271:
1.1100 raeburn 9272: /*
1.1231 damieng 9273: styles used for response display
9274: */
9275: div.LC_radiofoil, div.LC_rankfoil {
9276: margin: .5em 0em .5em 0em;
9277: }
9278: table.LC_itemgroup {
9279: margin-top: 1em;
9280: }
9281:
9282: /*
1.1100 raeburn 9283: styles used by TTH when "Default set of options to pass to tth/m
9284: when converting TeX" in course settings has been set
9285:
9286: option passed: -t
9287:
9288: */
9289:
9290: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9291: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9292: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9293: td div.norm {line-height:normal;}
9294:
9295: /*
9296: option passed -y3
9297: */
9298:
9299: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9300: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9301: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9302:
1.1230 damieng 9303: /*
9304: sections with roles, for content only
9305: */
9306: section[class^="role-"] {
9307: padding-left: 10px;
9308: padding-right: 5px;
9309: margin-top: 8px;
9310: margin-bottom: 8px;
9311: border: 1px solid #2A4;
9312: border-radius: 5px;
9313: box-shadow: 0px 1px 1px #BBB;
9314: }
9315: section[class^="role-"]>h1 {
9316: position: relative;
9317: margin: 0px;
9318: padding-top: 10px;
9319: padding-left: 40px;
9320: }
9321: section[class^="role-"]>h1:before {
9322: position: absolute;
9323: left: -5px;
9324: top: 5px;
9325: }
9326: section.role-activity>h1:before {
9327: content:url('/adm/daxe/images/section_icons/activity.png');
9328: }
9329: section.role-advice>h1:before {
9330: content:url('/adm/daxe/images/section_icons/advice.png');
9331: }
9332: section.role-bibliography>h1:before {
9333: content:url('/adm/daxe/images/section_icons/bibliography.png');
9334: }
9335: section.role-citation>h1:before {
9336: content:url('/adm/daxe/images/section_icons/citation.png');
9337: }
9338: section.role-conclusion>h1:before {
9339: content:url('/adm/daxe/images/section_icons/conclusion.png');
9340: }
9341: section.role-definition>h1:before {
9342: content:url('/adm/daxe/images/section_icons/definition.png');
9343: }
9344: section.role-demonstration>h1:before {
9345: content:url('/adm/daxe/images/section_icons/demonstration.png');
9346: }
9347: section.role-example>h1:before {
9348: content:url('/adm/daxe/images/section_icons/example.png');
9349: }
9350: section.role-explanation>h1:before {
9351: content:url('/adm/daxe/images/section_icons/explanation.png');
9352: }
9353: section.role-introduction>h1:before {
9354: content:url('/adm/daxe/images/section_icons/introduction.png');
9355: }
9356: section.role-method>h1:before {
9357: content:url('/adm/daxe/images/section_icons/method.png');
9358: }
9359: section.role-more_information>h1:before {
9360: content:url('/adm/daxe/images/section_icons/more_information.png');
9361: }
9362: section.role-objectives>h1:before {
9363: content:url('/adm/daxe/images/section_icons/objectives.png');
9364: }
9365: section.role-prerequisites>h1:before {
9366: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9367: }
9368: section.role-remark>h1:before {
9369: content:url('/adm/daxe/images/section_icons/remark.png');
9370: }
9371: section.role-reminder>h1:before {
9372: content:url('/adm/daxe/images/section_icons/reminder.png');
9373: }
9374: section.role-summary>h1:before {
9375: content:url('/adm/daxe/images/section_icons/summary.png');
9376: }
9377: section.role-syntax>h1:before {
9378: content:url('/adm/daxe/images/section_icons/syntax.png');
9379: }
9380: section.role-warning>h1:before {
9381: content:url('/adm/daxe/images/section_icons/warning.png');
9382: }
9383:
1.1269 raeburn 9384: #LC_minitab_header {
9385: float:left;
9386: width:100%;
9387: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9388: font-size:93%;
9389: line-height:normal;
9390: margin: 0.5em 0 0.5em 0;
9391: }
9392: #LC_minitab_header ul {
9393: margin:0;
9394: padding:10px 10px 0;
9395: list-style:none;
9396: }
9397: #LC_minitab_header li {
9398: float:left;
9399: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9400: margin:0;
9401: padding:0 0 0 9px;
9402: }
9403: #LC_minitab_header a {
9404: display:block;
9405: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9406: padding:5px 15px 4px 6px;
9407: }
9408: #LC_minitab_header #LC_current_minitab {
9409: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9410: }
9411: #LC_minitab_header #LC_current_minitab a {
9412: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9413: padding-bottom:5px;
9414: }
9415:
9416:
1.343 albertel 9417: END
9418: }
9419:
1.306 albertel 9420: =pod
9421:
9422: =item * &headtag()
9423:
9424: Returns a uniform footer for LON-CAPA web pages.
9425:
1.307 albertel 9426: Inputs: $title - optional title for the head
9427: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9428: $args - optional arguments
1.319 albertel 9429: force_register - if is true call registerurl so the remote is
9430: informed
1.415 albertel 9431: redirect -> array ref of
9432: 1- seconds before redirect occurs
9433: 2- url to redirect to
9434: 3- whether the side effect should occur
1.315 albertel 9435: (side effect of setting
9436: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9437: redirected to)
9438: 4- whether the redirect target should be
9439: the opener of the current (pop-up)
9440: window (side effect of setting
9441: $env{'internal.head.to_opener'} to
9442: 1, if true.
1.1388 raeburn 9443: 5- whether encrypt check should be skipped
1.352 albertel 9444: domain -> force to color decorate a page for a specific
9445: domain
9446: function -> force usage of a specific rolish color scheme
9447: bgcolor -> override the default page bgcolor
1.460 albertel 9448: no_auto_mt_title
9449: -> prevent &mt()ing the title arg
1.464 albertel 9450:
1.306 albertel 9451: =cut
9452:
9453: sub headtag {
1.313 albertel 9454: my ($title,$head_extra,$args) = @_;
1.306 albertel 9455:
1.363 albertel 9456: my $function = $args->{'function'} || &get_users_function();
9457: my $domain = $args->{'domain'} || &determinedomain();
9458: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9459: my $httphost = $args->{'use_absolute'};
1.418 albertel 9460: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9461: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9462: #time(),
1.418 albertel 9463: $env{'environment.color.timestamp'},
1.363 albertel 9464: $function,$domain,$bgcolor);
9465:
1.369 www 9466: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9467:
1.308 albertel 9468: my $result =
9469: '<head>'.
1.1160 raeburn 9470: &font_settings($args);
1.319 albertel 9471:
1.1188 raeburn 9472: my $inhibitprint;
9473: if ($args->{'print_suppress'}) {
9474: $inhibitprint = &print_suppression();
9475: }
1.1064 raeburn 9476:
1.1439 raeburn 9477: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9478: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9479: }
1.962 droeschl 9480: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9481: $result .= Apache::lonxml::display_title();
1.319 albertel 9482: }
1.436 albertel 9483: if (!$args->{'no_nav_bar'}
9484: && !$args->{'only_body'}
1.1438 raeburn 9485: && !$args->{'frameset'}
9486: && !$args->{'switchserver'}) {
1.1154 raeburn 9487: $result .= &help_menu_js($httphost);
1.1032 www 9488: $result.=&modal_window();
1.1038 www 9489: $result.=&togglebox_script();
1.1034 www 9490: $result.=&wishlist_window();
1.1041 www 9491: $result.=&LCprogressbarUpdate_script();
1.1034 www 9492: } else {
9493: if ($args->{'add_modal'}) {
9494: $result.=&modal_window();
9495: }
9496: if ($args->{'add_wishlist'}) {
9497: $result.=&wishlist_window();
9498: }
1.1038 www 9499: if ($args->{'add_togglebox'}) {
9500: $result.=&togglebox_script();
9501: }
1.1041 www 9502: if ($args->{'add_progressbar'}) {
9503: $result.=&LCprogressbarUpdate_script();
9504: }
1.436 albertel 9505: }
1.314 albertel 9506: if (ref($args->{'redirect'})) {
1.1388 raeburn 9507: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9508: if (!$skip_enc_check) {
9509: $url = &Apache::lonenc::check_encrypt($url);
9510: }
1.414 albertel 9511: if (!$inhibit_continue) {
9512: $env{'internal.head.redirect'} = $url;
9513: }
1.1386 raeburn 9514: $result.=<<"ADDMETA";
1.313 albertel 9515: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9516: ADDMETA
9517: if ($to_opener) {
9518: $env{'internal.head.to_opener'} = 1;
9519: my $dest = &js_escape($url);
9520: my $timeout = int($time * 1000);
9521: $result .=<<"ENDJS";
9522: <script type="text/javascript">
9523: // <![CDATA[
9524: function LC_To_Opener() {
9525: var dest = '$dest';
9526: if (dest != '') {
9527: if (window.opener != null && !window.opener.closed) {
9528: window.opener.location.href=dest;
9529: window.close();
9530: } else {
9531: window.location.href=dest;
9532: }
9533: }
9534: }
9535: \$(document).ready(function () {
9536: setTimeout('LC_To_Opener()',$timeout);
9537: });
9538: // ]]>
9539: </script>
9540: ENDJS
9541: } else {
9542: $result.=<<"ADDMETA";
1.344 albertel 9543: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9544: ADDMETA
1.1386 raeburn 9545: }
1.1210 raeburn 9546: } else {
9547: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9548: my $requrl = $env{'request.uri'};
9549: if ($requrl eq '') {
9550: $requrl = $ENV{'REQUEST_URI'};
9551: $requrl =~ s/\?.+$//;
9552: }
9553: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9554: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9555: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9556: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9557: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9558: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9559: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9560: my ($offload,$offloadoth);
1.1210 raeburn 9561: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9562: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9563: $offload = 1;
1.1353 raeburn 9564: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9565: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9566: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9567: $offloadoth = 1;
9568: $dom_in_use = $env{'user.domain'};
9569: }
9570: }
1.1340 raeburn 9571: }
9572: }
9573: unless ($offload) {
9574: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9575: if ($domdefs{'offloadoth'}{$lonhost}) {
9576: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9577: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9578: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9579: $offload = 1;
1.1352 raeburn 9580: $offloadoth = 1;
1.1340 raeburn 9581: $dom_in_use = $env{'user.domain'};
9582: }
1.1210 raeburn 9583: }
1.1340 raeburn 9584: }
9585: }
9586: }
9587: if ($offload) {
1.1358 raeburn 9588: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9589: if (($newserver eq '') && ($offloadoth)) {
9590: my @domains = &Apache::lonnet::current_machine_domains();
9591: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9592: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9593: }
9594: }
1.1340 raeburn 9595: if (($newserver) && ($newserver ne $lonhost)) {
9596: my $numsec = 5;
9597: my $timeout = $numsec * 1000;
9598: my ($newurl,$locknum,%locks,$msg);
9599: if ($env{'request.role.adv'}) {
9600: ($locknum,%locks) = &Apache::lonnet::get_locks();
9601: }
9602: my $disable_submit = 0;
9603: if ($requrl =~ /$LONCAPA::assess_re/) {
9604: $disable_submit = 1;
9605: }
9606: if ($locknum) {
9607: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9608: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9609: join(", ",sort(values(%locks)))."\n";
9610: if (&show_course()) {
9611: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9612: } else {
9613: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9614: }
1.1340 raeburn 9615: } else {
9616: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9617: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9618: }
9619: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9620: $newurl = '/adm/switchserver?otherserver='.$newserver;
9621: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9622: $newurl .= '&role='.$env{'request.role'};
9623: }
9624: if ($env{'request.symb'}) {
9625: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9626: if ($shownsymb =~ m{^/enc/}) {
9627: my $reqdmajor = 2;
9628: my $reqdminor = 11;
9629: my $reqdsubminor = 3;
9630: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9631: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9632: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9633: if (($major eq '' && $minor eq '') ||
9634: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9635: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9636: ($reqdsubminor > $subminor))))) {
9637: undef($shownsymb);
9638: }
1.1210 raeburn 9639: }
1.1340 raeburn 9640: if ($shownsymb) {
9641: &js_escape(\$shownsymb);
9642: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9643: }
1.1340 raeburn 9644: } else {
9645: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9646: &js_escape(\$shownurl);
9647: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9648: }
1.1340 raeburn 9649: }
9650: &js_escape(\$msg);
9651: $result.=<<OFFLOAD
1.1210 raeburn 9652: <meta http-equiv="pragma" content="no-cache" />
9653: <script type="text/javascript">
1.1215 raeburn 9654: // <![CDATA[
1.1210 raeburn 9655: function LC_Offload_Now() {
9656: var dest = "$newurl";
9657: if (dest != '') {
9658: window.location.href="$newurl";
9659: }
9660: }
1.1214 raeburn 9661: \$(document).ready(function () {
9662: window.alert('$msg');
9663: if ($disable_submit) {
1.1210 raeburn 9664: \$(".LC_hwk_submit").prop("disabled", true);
9665: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9666: }
9667: setTimeout('LC_Offload_Now()', $timeout);
9668: });
1.1215 raeburn 9669: // ]]>
1.1210 raeburn 9670: </script>
9671: OFFLOAD
9672: }
9673: }
9674: }
9675: }
9676: }
1.313 albertel 9677: }
1.306 albertel 9678: if (!defined($title)) {
9679: $title = 'The LearningOnline Network with CAPA';
9680: }
1.460 albertel 9681: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9682: if ($title =~ /^LON-CAPA\s+/) {
9683: $result .= '<title> '.$title.'</title>';
9684: } else {
9685: $result .= '<title> LON-CAPA '.$title.'</title>';
9686: }
9687: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9688: if (!$args->{'frameset'}) {
9689: $result .= ' /';
9690: }
9691: $result .= '>'
1.1064 raeburn 9692: .$inhibitprint
1.414 albertel 9693: .$head_extra;
1.1242 raeburn 9694: my $clientmobile;
9695: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9696: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9697: } else {
9698: $clientmobile = $env{'browser.mobile'};
9699: }
9700: if ($clientmobile) {
1.1137 raeburn 9701: $result .= '
1.1435 raeburn 9702: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9703: <meta name="apple-mobile-web-app-capable" content="yes" />';
9704: }
1.1278 raeburn 9705: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9706: return $result.'</head>';
1.306 albertel 9707: }
9708:
9709: =pod
9710:
1.340 albertel 9711: =item * &font_settings()
9712:
9713: Returns neccessary <meta> to set the proper encoding
9714:
1.1160 raeburn 9715: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9716:
9717: =cut
9718:
9719: sub font_settings {
1.1160 raeburn 9720: my ($args) = @_;
1.340 albertel 9721: my $headerstring='';
1.1160 raeburn 9722: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9723: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9724: $headerstring.=
9725: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9726: if (!$args->{'frameset'}) {
9727: $headerstring.= ' /';
9728: }
9729: $headerstring .= '>'."\n";
1.340 albertel 9730: }
9731: return $headerstring;
9732: }
9733:
1.341 albertel 9734: =pod
9735:
1.1064 raeburn 9736: =item * &print_suppression()
9737:
9738: In course context returns css which causes the body to be blank when media="print",
9739: if printout generation is unavailable for the current resource.
9740:
9741: This could be because:
9742:
9743: (a) printstartdate is in the future
9744:
9745: (b) printenddate is in the past
9746:
9747: (c) there is an active exam block with "printout"
9748: functionality blocked
9749:
9750: Users with pav, pfo or evb privileges are exempt.
9751:
9752: Inputs: none
9753:
9754: =cut
9755:
9756:
9757: sub print_suppression {
9758: my $noprint;
9759: if ($env{'request.course.id'}) {
9760: my $scope = $env{'request.course.id'};
9761: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9762: (&Apache::lonnet::allowed('pfo',$scope))) {
9763: return;
9764: }
9765: if ($env{'request.course.sec'} ne '') {
9766: $scope .= "/$env{'request.course.sec'}";
9767: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9768: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9769: return;
1.1064 raeburn 9770: }
9771: }
9772: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9773: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9774: my $clientip = &Apache::lonnet::get_requestor_ip();
9775: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9776: if ($blocked) {
9777: my $checkrole = "cm./$cdom/$cnum";
9778: if ($env{'request.course.sec'} ne '') {
9779: $checkrole .= "/$env{'request.course.sec'}";
9780: }
9781: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9782: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9783: $noprint = 1;
9784: }
9785: }
9786: unless ($noprint) {
9787: my $symb = &Apache::lonnet::symbread();
9788: if ($symb ne '') {
9789: my $navmap = Apache::lonnavmaps::navmap->new();
9790: if (ref($navmap)) {
9791: my $res = $navmap->getBySymb($symb);
9792: if (ref($res)) {
9793: if (!$res->resprintable()) {
9794: $noprint = 1;
9795: }
9796: }
9797: }
9798: }
9799: }
9800: if ($noprint) {
9801: return <<"ENDSTYLE";
9802: <style type="text/css" media="print">
9803: body { display:none }
9804: </style>
9805: ENDSTYLE
9806: }
9807: }
9808: return;
9809: }
9810:
9811: =pod
9812:
1.341 albertel 9813: =item * &xml_begin()
9814:
9815: Returns the needed doctype and <html>
9816:
9817: Inputs: none
9818:
9819: =cut
9820:
9821: sub xml_begin {
1.1168 raeburn 9822: my ($is_frameset) = @_;
1.341 albertel 9823: my $output='';
9824:
9825: if ($env{'browser.mathml'}) {
9826: $output='<?xml version="1.0"?>'
9827: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9828: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9829:
9830: # .'<!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">] >'
9831: .'<!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">'
9832: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9833: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9834: } elsif ($is_frameset) {
9835: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9836: '<html>'."\n";
1.341 albertel 9837: } else {
1.1168 raeburn 9838: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9839: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9840: }
9841: return $output;
9842: }
1.340 albertel 9843:
9844: =pod
9845:
1.306 albertel 9846: =item * &start_page()
9847:
9848: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9849:
1.648 raeburn 9850: Inputs:
9851:
9852: =over 4
9853:
9854: $title - optional title for the page
9855:
9856: $head_extra - optional extra HTML to incude inside the <head>
9857:
9858: $args - additional optional args supported are:
9859:
9860: =over 8
9861:
9862: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9863: arg on
1.814 bisitz 9864: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9865: add_entries -> additional attributes to add to the <body>
9866: domain -> force to color decorate a page for a
1.317 albertel 9867: specific domain
1.648 raeburn 9868: function -> force usage of a specific rolish color
1.317 albertel 9869: scheme
1.648 raeburn 9870: redirect -> see &headtag()
9871: bgcolor -> override the default page bg color
9872: js_ready -> return a string ready for being used in
1.317 albertel 9873: a javascript writeln
1.648 raeburn 9874: html_encode -> return a string ready for being used in
1.320 albertel 9875: a html attribute
1.648 raeburn 9876: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9877: $forcereg arg
1.648 raeburn 9878: frameset -> if true will start with a <frameset>
1.330 albertel 9879: rather than <body>
1.648 raeburn 9880: skip_phases -> hash ref of
1.338 albertel 9881: head -> skip the <html><head> generation
9882: body -> skip all <body> generation
1.648 raeburn 9883: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9884: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9885: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9886: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9887: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9888: to override those values, or add to them, specify the value to
9889: include in the style attribute to include in the div tag by using
9890: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9891: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9892: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9893: group -> includes the current group, if page is for a
1.1274 raeburn 9894: specific group
9895: use_absolute -> for request for external resource or syllabus, this
9896: will contain https://<hostname> if server uses
9897: https (as per hosts.tab), but request is for http
9898: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9899: links_disabled -> Links in primary and secondary menus are disabled
9900: (Can enable them once page has loaded - see lonroles.pm
9901: for an example).
1.1380 raeburn 9902: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9903:
1.648 raeburn 9904: =back
1.460 albertel 9905:
1.648 raeburn 9906: =back
1.562 albertel 9907:
1.306 albertel 9908: =cut
9909:
9910: sub start_page {
1.309 albertel 9911: my ($title,$head_extra,$args) = @_;
1.318 albertel 9912: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9913:
1.315 albertel 9914: $env{'internal.start_page'}++;
1.1359 raeburn 9915: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9916:
1.338 albertel 9917: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9918: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9919: }
1.1316 raeburn 9920:
9921: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9922: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9923: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9924: $args->{'no_primary_menu'} = 1;
9925: }
9926: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9927: $args->{'no_inline_menu'} = 1;
9928: }
9929: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9930: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9931: }
9932: } else {
9933: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9934: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9935: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9936: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9937: $args->{'no_primary_menu'} = 1;
9938: }
9939: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9940: $args->{'no_inline_menu'} = 1;
9941: }
9942: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9943: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9944: }
9945: }
9946: }
1.1316 raeburn 9947: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9948: $env{'course.'.$env{'request.course.id'}.'.domain'},
9949: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9950: } elsif ($env{'request.course.id'}) {
9951: my $expiretime=600;
9952: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9953: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9954: }
9955: my ($deeplinkmenu,$menuref);
9956: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9957: if ($menucoll) {
9958: if (ref($menuref) eq 'HASH') {
9959: %menu = %{$menuref};
9960: }
9961: if ($menu{'top'} eq 'n') {
9962: $args->{'no_primary_menu'} = 1;
9963: }
9964: if ($menu{'inline'} eq 'n') {
9965: unless (&Apache::lonnet::allowed('opa')) {
9966: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9967: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9968: my $crstype = &course_type();
9969: my $now = time;
9970: my $ccrole;
9971: if ($crstype eq 'Community') {
9972: $ccrole = 'co';
9973: } else {
9974: $ccrole = 'cc';
9975: }
9976: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9977: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9978: if ((($start) && ($start<0)) ||
9979: (($end) && ($end<$now)) ||
9980: (($start) && ($now<$start))) {
9981: $args->{'no_inline_menu'} = 1;
9982: }
9983: } else {
9984: $args->{'no_inline_menu'} = 1;
9985: }
9986: }
9987: }
9988: }
1.1316 raeburn 9989: }
1.1359 raeburn 9990:
1.1385 raeburn 9991: my $showncrumbs;
1.338 albertel 9992: if (! exists($args->{'skip_phases'}{'body'}) ) {
9993: if ($args->{'frameset'}) {
9994: my $attr_string = &make_attr_string($args->{'force_register'},
9995: $args->{'add_entries'});
9996: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9997: } else {
9998: $result .=
9999: &bodytag($title,
10000: $args->{'function'}, $args->{'add_entries'},
10001: $args->{'only_body'}, $args->{'domain'},
10002: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 10003: $args->{'bgcolor'}, $args,
1.1385 raeburn 10004: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
10005: \%menu,\$showncrumbs);
1.831 bisitz 10006: }
1.330 albertel 10007: }
1.338 albertel 10008:
1.315 albertel 10009: if ($args->{'js_ready'}) {
1.713 kaisler 10010: $result = &js_ready($result);
1.315 albertel 10011: }
1.320 albertel 10012: if ($args->{'html_encode'}) {
1.713 kaisler 10013: $result = &html_encode($result);
10014: }
10015:
1.813 bisitz 10016: # Preparation for new and consistent functionlist at top of screen
10017: # if ($args->{'functionlist'}) {
10018: # $result .= &build_functionlist();
10019: #}
10020:
1.964 droeschl 10021: # Don't add anything more if only_body wanted or in const space
10022: return $result if $args->{'only_body'}
10023: || $env{'request.state'} eq 'construct';
1.813 bisitz 10024:
10025: #Breadcrumbs
1.758 kaisler 10026: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10027: unless ($showncrumbs) {
1.758 kaisler 10028: &Apache::lonhtmlcommon::clear_breadcrumbs();
10029: #if any br links exists, add them to the breadcrumbs
10030: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10031: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10032: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10033: }
10034: }
1.1096 raeburn 10035: # if @advtools array contains items add then to the breadcrumbs
10036: if (@advtools > 0) {
10037: &Apache::lonmenu::advtools_crumbs(@advtools);
10038: }
1.1272 raeburn 10039: my $menulink;
10040: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10041: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10042: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10043: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10044: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10045: (!$env{'request.role.adv'}))) {
10046: $menulink = 0;
10047: } else {
10048: undef($menulink);
10049: }
1.1385 raeburn 10050: my $linkprotout;
10051: if ($env{'request.deeplink.login'}) {
10052: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10053: if ($linkprotout) {
10054: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10055: }
10056: }
1.758 kaisler 10057: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10058: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10059: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10060: '',$menulink,'',
10061: $args->{'bread_crumbs_style'});
1.1237 raeburn 10062: } else {
1.1437 raeburn 10063: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10064: $args->{'bread_crumbs_style'});
1.758 kaisler 10065: }
1.1385 raeburn 10066: }
1.320 albertel 10067: }
1.315 albertel 10068: return $result;
1.306 albertel 10069: }
10070:
10071: sub end_page {
1.315 albertel 10072: my ($args) = @_;
10073: $env{'internal.end_page'}++;
1.330 albertel 10074: my $result;
1.335 albertel 10075: if ($args->{'discussion'}) {
10076: my ($target,$parser);
10077: if (ref($args->{'discussion'})) {
10078: ($target,$parser) =($args->{'discussion'}{'target'},
10079: $args->{'discussion'}{'parser'});
10080: }
10081: $result .= &Apache::lonxml::xmlend($target,$parser);
10082: }
1.330 albertel 10083: if ($args->{'frameset'}) {
10084: $result .= '</frameset>';
10085: } else {
1.635 raeburn 10086: $result .= &endbodytag($args);
1.330 albertel 10087: }
1.1080 raeburn 10088: unless ($args->{'notbody'}) {
10089: $result .= "\n</html>";
10090: }
1.330 albertel 10091:
1.315 albertel 10092: if ($args->{'js_ready'}) {
1.317 albertel 10093: $result = &js_ready($result);
1.315 albertel 10094: }
1.335 albertel 10095:
1.320 albertel 10096: if ($args->{'html_encode'}) {
10097: $result = &html_encode($result);
10098: }
1.335 albertel 10099:
1.315 albertel 10100: return $result;
10101: }
10102:
1.1359 raeburn 10103: sub menucoll_in_effect {
10104: my ($menucoll,$deeplinkmenu,%menu);
10105: if ($env{'request.course.id'}) {
10106: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10107: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10108: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10109: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10110: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10111: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10112: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10113: my $navmap = Apache::lonnavmaps::navmap->new();
10114: if (ref($navmap)) {
10115: $deeplink = $navmap->get_mapparam(undef,
10116: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10117: '0.deeplink');
1.1370 raeburn 10118: } else {
10119: $check_login_symb = 1;
1.1362 raeburn 10120: }
10121: } else {
1.1370 raeburn 10122: my $symb = &Apache::lonnet::symbread();
10123: if ($symb) {
10124: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10125: } else {
10126: $check_login_symb = 1;
10127: }
1.1362 raeburn 10128: }
10129: } else {
1.1370 raeburn 10130: $check_login_symb = 1;
10131: }
10132: if ($check_login_symb) {
1.1362 raeburn 10133: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10134: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10135: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10136: my $navmap = Apache::lonnavmaps::navmap->new();
10137: if (ref($navmap)) {
10138: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10139: }
10140: } else {
10141: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10142: }
10143: }
1.1359 raeburn 10144: if ($deeplink ne '') {
1.1378 raeburn 10145: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10146: if ($display =~ /^\d+$/) {
10147: $deeplinkmenu = 1;
10148: $menucoll = $display;
10149: }
10150: }
10151: }
10152: if ($menucoll) {
10153: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10154: }
10155: }
10156: return ($menucoll,$deeplinkmenu,\%menu);
10157: }
10158:
1.1362 raeburn 10159: sub deeplink_login_symb {
10160: my ($cnum,$cdom) = @_;
10161: my $login_symb;
10162: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10163: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10164: }
10165: return $login_symb;
10166: }
10167:
10168: sub symb_from_tinyurl {
10169: my ($url,$cnum,$cdom) = @_;
10170: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10171: my $key = $1;
10172: my ($tinyurl,$login);
10173: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10174: if (defined($cached)) {
10175: $tinyurl = $result;
10176: } else {
10177: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10178: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10179: if ($currtiny{$key} ne '') {
10180: $tinyurl = $currtiny{$key};
10181: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10182: }
1.1364 raeburn 10183: }
10184: if ($tinyurl ne '') {
10185: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10186: if (wantarray) {
10187: return ($cnumreq,$symb);
10188: } elsif ($cnumreq eq $cnum) {
10189: return $symb;
1.1362 raeburn 10190: }
10191: }
10192: }
1.1364 raeburn 10193: if (wantarray) {
10194: return ();
10195: } else {
10196: return;
10197: }
1.1362 raeburn 10198: }
10199:
1.1405 raeburn 10200: sub usable_exttools {
10201: my %tooltypes;
10202: if ($env{'request.course.id'}) {
10203: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10204: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10205: %tooltypes = (
10206: crs => 1,
10207: dom => 1,
10208: );
10209: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10210: $tooltypes{'crs'} = 1;
10211: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10212: $tooltypes{'dom'} = 1;
10213: }
10214: } else {
10215: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10216: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10217: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10218: if ($crstype eq '') {
10219: $crstype = 'course';
10220: }
10221: if ($crstype eq 'course') {
10222: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10223: $crstype = 'official';
10224: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10225: $crstype = 'textbook';
10226: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10227: $crstype = 'lti';
10228: } else {
10229: $crstype = 'unofficial';
10230: }
10231: }
10232: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10233: if ($domdefaults{$crstype.'domexttool'}) {
10234: $tooltypes{'dom'} = 1;
10235: }
10236: if ($domdefaults{$crstype.'exttool'}) {
10237: $tooltypes{'crs'} = 1;
10238: }
10239: }
10240: }
10241: return %tooltypes;
10242: }
10243:
1.1034 www 10244: sub wishlist_window {
10245: return(<<'ENDWISHLIST');
1.1046 raeburn 10246: <script type="text/javascript">
1.1034 www 10247: // <![CDATA[
10248: // <!-- BEGIN LON-CAPA Internal
10249: function set_wishlistlink(title, path) {
10250: if (!title) {
10251: title = document.title;
10252: title = title.replace(/^LON-CAPA /,'');
10253: }
1.1175 raeburn 10254: title = encodeURIComponent(title);
1.1203 raeburn 10255: title = title.replace("'","\\\'");
1.1034 www 10256: if (!path) {
10257: path = location.pathname;
10258: }
1.1175 raeburn 10259: path = encodeURIComponent(path);
1.1203 raeburn 10260: path = path.replace("'","\\\'");
1.1034 www 10261: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10262: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10263: }
10264: // END LON-CAPA Internal -->
10265: // ]]>
10266: </script>
10267: ENDWISHLIST
10268: }
10269:
1.1030 www 10270: sub modal_window {
10271: return(<<'ENDMODAL');
1.1046 raeburn 10272: <script type="text/javascript">
1.1030 www 10273: // <![CDATA[
10274: // <!-- BEGIN LON-CAPA Internal
10275: var modalWindow = {
10276: parent:"body",
10277: windowId:null,
10278: content:null,
10279: width:null,
10280: height:null,
10281: close:function()
10282: {
10283: $(".LCmodal-window").remove();
10284: $(".LCmodal-overlay").remove();
10285: },
10286: open:function()
10287: {
10288: var modal = "";
10289: modal += "<div class=\"LCmodal-overlay\"></div>";
10290: 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;\">";
10291: modal += this.content;
10292: modal += "</div>";
10293:
10294: $(this.parent).append(modal);
10295:
10296: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10297: $(".LCclose-window").click(function(){modalWindow.close();});
10298: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10299: }
10300: };
1.1140 raeburn 10301: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10302: {
1.1266 raeburn 10303: source = source.replace(/'/g,"'");
1.1030 www 10304: modalWindow.windowId = "myModal";
10305: modalWindow.width = width;
10306: modalWindow.height = height;
1.1196 raeburn 10307: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10308: modalWindow.open();
1.1208 raeburn 10309: };
1.1030 www 10310: // END LON-CAPA Internal -->
10311: // ]]>
10312: </script>
10313: ENDMODAL
10314: }
10315:
10316: sub modal_link {
1.1140 raeburn 10317: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10318: unless ($width) { $width=480; }
10319: unless ($height) { $height=400; }
1.1031 www 10320: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10321: unless ($transparency) { $transparency='true'; }
10322:
1.1074 raeburn 10323: my $target_attr;
10324: if (defined($target)) {
10325: $target_attr = 'target="'.$target.'"';
10326: }
10327: return <<"ENDLINK";
1.1336 raeburn 10328: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10329: ENDLINK
1.1030 www 10330: }
10331:
1.1032 www 10332: sub modal_adhoc_script {
1.1365 raeburn 10333: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10334: my $mathjax;
10335: if ($possmathjax) {
10336: $mathjax = <<'ENDJAX';
10337: if (typeof MathJax == 'object') {
10338: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10339: }
10340: ENDJAX
10341: }
1.1032 www 10342: return (<<ENDADHOC);
1.1046 raeburn 10343: <script type="text/javascript">
1.1032 www 10344: // <![CDATA[
10345: var $funcname = function()
10346: {
10347: modalWindow.windowId = "myModal";
10348: modalWindow.width = $width;
10349: modalWindow.height = $height;
10350: modalWindow.content = '$content';
10351: modalWindow.open();
1.1365 raeburn 10352: $mathjax
1.1032 www 10353: };
10354: // ]]>
10355: </script>
10356: ENDADHOC
10357: }
10358:
1.1041 www 10359: sub modal_adhoc_inner {
1.1365 raeburn 10360: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10361: my $innerwidth=$width-20;
10362: $content=&js_ready(
1.1140 raeburn 10363: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10364: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10365: $content.
1.1041 www 10366: &end_scrollbox().
1.1140 raeburn 10367: &end_page()
1.1041 www 10368: );
1.1365 raeburn 10369: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10370: }
10371:
10372: sub modal_adhoc_window {
1.1365 raeburn 10373: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10374: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10375: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10376: }
10377:
10378: sub modal_adhoc_launch {
10379: my ($funcname,$width,$height,$content)=@_;
10380: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10381: <script type="text/javascript">
10382: // <![CDATA[
10383: $funcname();
10384: // ]]>
10385: </script>
10386: ENDLAUNCH
10387: }
10388:
10389: sub modal_adhoc_close {
10390: return (<<ENDCLOSE);
10391: <script type="text/javascript">
10392: // <![CDATA[
10393: modalWindow.close();
10394: // ]]>
10395: </script>
10396: ENDCLOSE
10397: }
10398:
1.1038 www 10399: sub togglebox_script {
10400: return(<<ENDTOGGLE);
10401: <script type="text/javascript">
10402: // <![CDATA[
10403: function LCtoggleDisplay(id,hidetext,showtext) {
10404: link = document.getElementById(id + "link").childNodes[0];
10405: with (document.getElementById(id).style) {
10406: if (display == "none" ) {
10407: display = "inline";
10408: link.nodeValue = hidetext;
10409: } else {
10410: display = "none";
10411: link.nodeValue = showtext;
10412: }
10413: }
10414: }
10415: // ]]>
10416: </script>
10417: ENDTOGGLE
10418: }
10419:
1.1039 www 10420: sub start_togglebox {
10421: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10422: unless ($heading) { $heading=''; } else { $heading.=' '; }
10423: unless ($showtext) { $showtext=&mt('show'); }
10424: unless ($hidetext) { $hidetext=&mt('hide'); }
10425: unless ($headerbg) { $headerbg='#FFFFFF'; }
10426: return &start_data_table().
10427: &start_data_table_header_row().
10428: '<td bgcolor="'.$headerbg.'">'.$heading.
10429: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10430: $showtext.'\')">'.$showtext.'</a>]</td>'.
10431: &end_data_table_header_row().
10432: '<tr id="'.$id.'" style="display:none""><td>';
10433: }
10434:
10435: sub end_togglebox {
10436: return '</td></tr>'.&end_data_table();
10437: }
10438:
1.1041 www 10439: sub LCprogressbar_script {
1.1302 raeburn 10440: my ($id,$number_to_do)=@_;
10441: if ($number_to_do) {
10442: return(<<ENDPROGRESS);
1.1041 www 10443: <script type="text/javascript">
10444: // <![CDATA[
1.1045 www 10445: \$('#progressbar$id').progressbar({
1.1041 www 10446: value: 0,
10447: change: function(event, ui) {
10448: var newVal = \$(this).progressbar('option', 'value');
10449: \$('.pblabel', this).text(LCprogressTxt);
10450: }
10451: });
10452: // ]]>
10453: </script>
10454: ENDPROGRESS
1.1302 raeburn 10455: } else {
10456: return(<<ENDPROGRESS);
10457: <script type="text/javascript">
10458: // <![CDATA[
10459: \$('#progressbar$id').progressbar({
10460: value: false,
10461: create: function(event, ui) {
10462: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10463: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10464: }
10465: });
10466: // ]]>
10467: </script>
10468: ENDPROGRESS
10469: }
1.1041 www 10470: }
10471:
10472: sub LCprogressbarUpdate_script {
10473: return(<<ENDPROGRESSUPDATE);
10474: <style type="text/css">
10475: .ui-progressbar { position:relative; }
1.1302 raeburn 10476: .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 10477: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10478: </style>
10479: <script type="text/javascript">
10480: // <![CDATA[
1.1045 www 10481: var LCprogressTxt='---';
10482:
1.1302 raeburn 10483: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10484: LCprogressTxt=progresstext;
1.1302 raeburn 10485: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10486: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10487: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10488: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10489: } else {
10490: \$('#progressbar'+id).progressbar('value',percent);
10491: }
1.1041 www 10492: }
10493: // ]]>
10494: </script>
10495: ENDPROGRESSUPDATE
10496: }
10497:
1.1042 www 10498: my $LClastpercent;
1.1045 www 10499: my $LCidcnt;
10500: my $LCcurrentid;
1.1042 www 10501:
1.1041 www 10502: sub LCprogressbar {
1.1302 raeburn 10503: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10504: $LClastpercent=0;
1.1045 www 10505: $LCidcnt++;
10506: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10507: my ($starting,$content);
10508: if ($number_to_do) {
10509: $starting=&mt('Starting');
10510: $content=(<<ENDPROGBAR);
10511: $preamble
1.1045 www 10512: <div id="progressbar$LCcurrentid">
1.1041 www 10513: <span class="pblabel">$starting</span>
10514: </div>
10515: ENDPROGBAR
1.1302 raeburn 10516: } else {
10517: $starting=&mt('Loading...');
10518: $LClastpercent='false';
10519: $content=(<<ENDPROGBAR);
10520: $preamble
10521: <div id="progressbar$LCcurrentid">
10522: <div class="progress-label">$starting</div>
10523: </div>
10524: ENDPROGBAR
10525: }
10526: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10527: }
10528:
10529: sub LCprogressbarUpdate {
1.1302 raeburn 10530: my ($r,$val,$text,$number_to_do)=@_;
10531: if ($number_to_do) {
10532: unless ($val) {
10533: if ($LClastpercent) {
10534: $val=$LClastpercent;
10535: } else {
10536: $val=0;
10537: }
10538: }
10539: if ($val<0) { $val=0; }
10540: if ($val>100) { $val=0; }
10541: $LClastpercent=$val;
10542: unless ($text) { $text=$val.'%'; }
10543: } else {
10544: $val = 'false';
1.1042 www 10545: }
1.1041 www 10546: $text=&js_ready($text);
1.1044 www 10547: &r_print($r,<<ENDUPDATE);
1.1041 www 10548: <script type="text/javascript">
10549: // <![CDATA[
1.1302 raeburn 10550: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10551: // ]]>
10552: </script>
10553: ENDUPDATE
1.1035 www 10554: }
10555:
1.1042 www 10556: sub LCprogressbarClose {
10557: my ($r)=@_;
10558: $LClastpercent=0;
1.1044 www 10559: &r_print($r,<<ENDCLOSE);
1.1042 www 10560: <script type="text/javascript">
10561: // <![CDATA[
1.1045 www 10562: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10563: // ]]>
10564: </script>
10565: ENDCLOSE
1.1044 www 10566: }
10567:
10568: sub r_print {
10569: my ($r,$to_print)=@_;
10570: if ($r) {
10571: $r->print($to_print);
10572: $r->rflush();
10573: } else {
10574: print($to_print);
10575: }
1.1042 www 10576: }
10577:
1.320 albertel 10578: sub html_encode {
10579: my ($result) = @_;
10580:
1.322 albertel 10581: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10582:
10583: return $result;
10584: }
1.1044 www 10585:
1.317 albertel 10586: sub js_ready {
10587: my ($result) = @_;
10588:
1.323 albertel 10589: $result =~ s/[\n\r]/ /xmsg;
10590: $result =~ s/\\/\\\\/xmsg;
10591: $result =~ s/'/\\'/xmsg;
1.372 albertel 10592: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10593:
10594: return $result;
10595: }
10596:
1.315 albertel 10597: sub validate_page {
10598: if ( exists($env{'internal.start_page'})
1.316 albertel 10599: && $env{'internal.start_page'} > 1) {
10600: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10601: $env{'internal.start_page'}.' '.
1.316 albertel 10602: $ENV{'request.filename'});
1.315 albertel 10603: }
10604: if ( exists($env{'internal.end_page'})
1.316 albertel 10605: && $env{'internal.end_page'} > 1) {
10606: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10607: $env{'internal.end_page'}.' '.
1.316 albertel 10608: $env{'request.filename'});
1.315 albertel 10609: }
10610: if ( exists($env{'internal.start_page'})
10611: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10612: &Apache::lonnet::logthis('start_page called without end_page '.
10613: $env{'request.filename'});
1.315 albertel 10614: }
10615: if ( ! exists($env{'internal.start_page'})
10616: && exists($env{'internal.end_page'})) {
1.316 albertel 10617: &Apache::lonnet::logthis('end_page called without start_page'.
10618: $env{'request.filename'});
1.315 albertel 10619: }
1.306 albertel 10620: }
1.315 albertel 10621:
1.996 www 10622:
10623: sub start_scrollbox {
1.1140 raeburn 10624: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10625: unless ($outerwidth) { $outerwidth='520px'; }
10626: unless ($width) { $width='500px'; }
10627: unless ($height) { $height='200px'; }
1.1075 raeburn 10628: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10629: if ($id ne '') {
1.1140 raeburn 10630: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10631: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10632: }
1.1075 raeburn 10633: if ($bgcolor ne '') {
10634: $tdcol = "background-color: $bgcolor;";
10635: }
1.1137 raeburn 10636: my $nicescroll_js;
10637: if ($env{'browser.mobile'}) {
1.1140 raeburn 10638: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10639: }
10640: return <<"END";
10641: $nicescroll_js
10642:
10643: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10644: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10645: END
10646: }
10647:
10648: sub end_scrollbox {
10649: return '</div></td></tr></table>';
10650: }
10651:
10652: sub nicescroll_javascript {
10653: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10654: my %options;
10655: if (ref($cursor) eq 'HASH') {
10656: %options = %{$cursor};
10657: }
10658: unless ($options{'railalign'} =~ /^left|right$/) {
10659: $options{'railalign'} = 'left';
10660: }
10661: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10662: my $function = &get_users_function();
10663: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10664: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10665: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10666: }
1.1140 raeburn 10667: }
10668: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10669: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10670: $options{'cursoropacity'}='1.0';
10671: }
1.1140 raeburn 10672: } else {
10673: $options{'cursoropacity'}='1.0';
10674: }
10675: if ($options{'cursorfixedheight'} eq 'none') {
10676: delete($options{'cursorfixedheight'});
10677: } else {
10678: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10679: }
10680: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10681: delete($options{'railoffset'});
10682: }
10683: my @niceoptions;
10684: while (my($key,$value) = each(%options)) {
10685: if ($value =~ /^\{.+\}$/) {
10686: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10687: } else {
1.1140 raeburn 10688: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10689: }
1.1140 raeburn 10690: }
10691: my $nicescroll_js = '
1.1137 raeburn 10692: $(document).ready(
1.1140 raeburn 10693: function() {
10694: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10695: }
1.1137 raeburn 10696: );
10697: ';
1.1140 raeburn 10698: if ($framecheck) {
10699: $nicescroll_js .= '
10700: function expand_div(caller) {
10701: if (top === self) {
10702: document.getElementById("'.$id.'").style.width = "auto";
10703: document.getElementById("'.$id.'").style.height = "auto";
10704: } else {
10705: try {
10706: if (parent.frames) {
10707: if (parent.frames.length > 1) {
10708: var framesrc = parent.frames[1].location.href;
10709: var currsrc = framesrc.replace(/\#.*$/,"");
10710: if ((caller == "search") || (currsrc == "'.$location.'")) {
10711: document.getElementById("'.$id.'").style.width = "auto";
10712: document.getElementById("'.$id.'").style.height = "auto";
10713: }
10714: }
10715: }
10716: } catch (e) {
10717: return;
10718: }
1.1137 raeburn 10719: }
1.1140 raeburn 10720: return;
1.996 www 10721: }
1.1140 raeburn 10722: ';
10723: }
10724: if ($needjsready) {
10725: $nicescroll_js = '
10726: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10727: } else {
10728: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10729: }
10730: return $nicescroll_js;
1.996 www 10731: }
10732:
1.318 albertel 10733: sub simple_error_page {
1.1150 bisitz 10734: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10735: my %displayargs;
1.1151 raeburn 10736: if (ref($args) eq 'HASH') {
10737: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10738: if ($args->{'only_body'}) {
10739: $displayargs{'only_body'} = 1;
10740: }
10741: if ($args->{'no_nav_bar'}) {
10742: $displayargs{'no_nav_bar'} = 1;
10743: }
1.1151 raeburn 10744: } else {
10745: $msg = &mt($msg);
10746: }
1.1150 bisitz 10747:
1.318 albertel 10748: my $page =
1.1304 raeburn 10749: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10750: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10751: &Apache::loncommon::end_page();
10752: if (ref($r)) {
10753: $r->print($page);
1.327 albertel 10754: return;
1.318 albertel 10755: }
10756: return $page;
10757: }
1.347 albertel 10758:
10759: {
1.610 albertel 10760: my @row_count;
1.961 onken 10761:
10762: sub start_data_table_count {
10763: unshift(@row_count, 0);
10764: return;
10765: }
10766:
10767: sub end_data_table_count {
10768: shift(@row_count);
10769: return;
10770: }
10771:
1.347 albertel 10772: sub start_data_table {
1.1018 raeburn 10773: my ($add_class,$id) = @_;
1.422 albertel 10774: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10775: my $table_id;
10776: if (defined($id)) {
10777: $table_id = ' id="'.$id.'"';
10778: }
1.961 onken 10779: &start_data_table_count();
1.1018 raeburn 10780: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10781: }
10782:
10783: sub end_data_table {
1.961 onken 10784: &end_data_table_count();
1.389 albertel 10785: return '</table>'."\n";;
1.347 albertel 10786: }
10787:
10788: sub start_data_table_row {
1.974 wenzelju 10789: my ($add_class, $id) = @_;
1.610 albertel 10790: $row_count[0]++;
10791: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10792: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10793: $id = (' id="'.$id.'"') unless ($id eq '');
10794: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10795: }
1.471 banghart 10796:
10797: sub continue_data_table_row {
1.974 wenzelju 10798: my ($add_class, $id) = @_;
1.610 albertel 10799: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10800: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10801: $id = (' id="'.$id.'"') unless ($id eq '');
10802: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10803: }
1.347 albertel 10804:
10805: sub end_data_table_row {
1.389 albertel 10806: return '</tr>'."\n";;
1.347 albertel 10807: }
1.367 www 10808:
1.421 albertel 10809: sub start_data_table_empty_row {
1.707 bisitz 10810: # $row_count[0]++;
1.421 albertel 10811: return '<tr class="LC_empty_row" >'."\n";;
10812: }
10813:
10814: sub end_data_table_empty_row {
10815: return '</tr>'."\n";;
10816: }
10817:
1.367 www 10818: sub start_data_table_header_row {
1.389 albertel 10819: return '<tr class="LC_header_row">'."\n";;
1.367 www 10820: }
10821:
10822: sub end_data_table_header_row {
1.389 albertel 10823: return '</tr>'."\n";;
1.367 www 10824: }
1.890 droeschl 10825:
10826: sub data_table_caption {
10827: my $caption = shift;
10828: return "<caption class=\"LC_caption\">$caption</caption>";
10829: }
1.347 albertel 10830: }
10831:
1.548 albertel 10832: =pod
10833:
10834: =item * &inhibit_menu_check($arg)
10835:
10836: Checks for a inhibitmenu state and generates output to preserve it
10837:
10838: Inputs: $arg - can be any of
10839: - undef - in which case the return value is a string
10840: to add into arguments list of a uri
10841: - 'input' - in which case the return value is a HTML
10842: <form> <input> field of type hidden to
10843: preserve the value
10844: - a url - in which case the return value is the url with
10845: the neccesary cgi args added to preserve the
10846: inhibitmenu state
10847: - a ref to a url - no return value, but the string is
10848: updated to include the neccessary cgi
10849: args to preserve the inhibitmenu state
10850:
10851: =cut
10852:
10853: sub inhibit_menu_check {
10854: my ($arg) = @_;
10855: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10856: if ($arg eq 'input') {
10857: if ($env{'form.inhibitmenu'}) {
10858: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10859: } else {
10860: return
10861: }
10862: }
10863: if ($env{'form.inhibitmenu'}) {
10864: if (ref($arg)) {
10865: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10866: } elsif ($arg eq '') {
10867: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10868: } else {
10869: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10870: }
10871: }
10872: if (!ref($arg)) {
10873: return $arg;
10874: }
10875: }
10876:
1.251 albertel 10877: ###############################################
1.182 matthew 10878:
10879: =pod
10880:
1.549 albertel 10881: =back
10882:
10883: =head1 User Information Routines
10884:
10885: =over 4
10886:
1.405 albertel 10887: =item * &get_users_function()
1.182 matthew 10888:
10889: Used by &bodytag to determine the current users primary role.
10890: Returns either 'student','coordinator','admin', or 'author'.
10891:
10892: =cut
10893:
10894: ###############################################
10895: sub get_users_function {
1.815 tempelho 10896: my $function = 'norole';
1.818 tempelho 10897: if ($env{'request.role'}=~/^(st)/) {
10898: $function='student';
10899: }
1.907 raeburn 10900: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10901: $function='coordinator';
10902: }
1.258 albertel 10903: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10904: $function='admin';
10905: }
1.826 bisitz 10906: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10907: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10908: $function='author';
10909: }
10910: return $function;
1.54 www 10911: }
1.99 www 10912:
10913: ###############################################
10914:
1.233 raeburn 10915: =pod
10916:
1.821 raeburn 10917: =item * &show_course()
10918:
10919: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10920: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10921:
10922: Inputs:
10923: None
10924:
10925: Outputs:
10926: Scalar: 1 if 'Course' to be used, 0 otherwise.
10927:
10928: =cut
10929:
10930: ###############################################
10931: sub show_course {
1.1408 raeburn 10932: my ($udom,$uname) = @_;
10933: if (($udom ne '') && ($uname ne '')) {
10934: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10935: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10936: return 0;
10937: } else {
10938: return 1;
10939: }
10940: }
10941: }
1.821 raeburn 10942: my $course = !$env{'user.adv'};
10943: if (!$env{'user.adv'}) {
10944: foreach my $env (keys(%env)) {
10945: next if ($env !~ m/^user\.priv\./);
10946: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10947: $course = 0;
10948: last;
10949: }
10950: }
10951: }
10952: return $course;
10953: }
10954:
10955: ###############################################
10956:
10957: =pod
10958:
1.542 raeburn 10959: =item * &check_user_status()
1.274 raeburn 10960:
10961: Determines current status of supplied role for a
10962: specific user. Roles can be active, previous or future.
10963:
10964: Inputs:
10965: user's domain, user's username, course's domain,
1.375 raeburn 10966: course's number, optional section ID.
1.274 raeburn 10967:
10968: Outputs:
10969: role status: active, previous or future.
10970:
10971: =cut
10972:
10973: sub check_user_status {
1.412 raeburn 10974: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10975: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10976: my @uroles = keys(%userinfo);
1.274 raeburn 10977: my $srchstr;
10978: my $active_chk = 'none';
1.412 raeburn 10979: my $now = time;
1.274 raeburn 10980: if (@uroles > 0) {
1.908 raeburn 10981: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10982: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10983: } else {
1.412 raeburn 10984: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10985: }
10986: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10987: my $role_end = 0;
10988: my $role_start = 0;
10989: $active_chk = 'active';
1.412 raeburn 10990: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10991: $role_end = $1;
10992: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10993: $role_start = $1;
1.274 raeburn 10994: }
10995: }
10996: if ($role_start > 0) {
1.412 raeburn 10997: if ($now < $role_start) {
1.274 raeburn 10998: $active_chk = 'future';
10999: }
11000: }
11001: if ($role_end > 0) {
1.412 raeburn 11002: if ($now > $role_end) {
1.274 raeburn 11003: $active_chk = 'previous';
11004: }
11005: }
11006: }
11007: }
11008: return $active_chk;
11009: }
11010:
11011: ###############################################
11012:
11013: =pod
11014:
1.405 albertel 11015: =item * &get_sections()
1.233 raeburn 11016:
11017: Determines all the sections for a course including
11018: sections with students and sections containing other roles.
1.419 raeburn 11019: Incoming parameters:
11020:
11021: 1. domain
11022: 2. course number
11023: 3. reference to array containing roles for which sections should
11024: be gathered (optional).
11025: 4. reference to array containing status types for which sections
11026: should be gathered (optional).
11027:
11028: If the third argument is undefined, sections are gathered for any role.
11029: If the fourth argument is undefined, sections are gathered for any status.
11030: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11031:
1.374 raeburn 11032: Returns section hash (keys are section IDs, values are
11033: number of users in each section), subject to the
1.419 raeburn 11034: optional roles filter, optional status filter
1.233 raeburn 11035:
11036: =cut
11037:
11038: ###############################################
11039: sub get_sections {
1.419 raeburn 11040: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11041: if (!defined($cdom) || !defined($cnum)) {
11042: my $cid = $env{'request.course.id'};
11043:
11044: return if (!defined($cid));
11045:
11046: $cdom = $env{'course.'.$cid.'.domain'};
11047: $cnum = $env{'course.'.$cid.'.num'};
11048: }
11049:
11050: my %sectioncount;
1.419 raeburn 11051: my $now = time;
1.240 albertel 11052:
1.1118 raeburn 11053: my $check_students = 1;
11054: my $only_students = 0;
11055: if (ref($possible_roles) eq 'ARRAY') {
11056: if (grep(/^st$/,@{$possible_roles})) {
11057: if (@{$possible_roles} == 1) {
11058: $only_students = 1;
11059: }
11060: } else {
11061: $check_students = 0;
11062: }
11063: }
11064:
11065: if ($check_students) {
1.276 albertel 11066: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11067: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11068: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11069: my $start_index = &Apache::loncoursedata::CL_START();
11070: my $end_index = &Apache::loncoursedata::CL_END();
11071: my $status;
1.366 albertel 11072: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11073: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11074: $data->[$status_index],
11075: $data->[$start_index],
11076: $data->[$end_index]);
11077: if ($stu_status eq 'Active') {
11078: $status = 'active';
11079: } elsif ($end < $now) {
11080: $status = 'previous';
11081: } elsif ($start > $now) {
11082: $status = 'future';
11083: }
11084: if ($section ne '-1' && $section !~ /^\s*$/) {
11085: if ((!defined($possible_status)) || (($status ne '') &&
11086: (grep/^\Q$status\E$/,@{$possible_status}))) {
11087: $sectioncount{$section}++;
11088: }
1.240 albertel 11089: }
11090: }
11091: }
1.1118 raeburn 11092: if ($only_students) {
11093: return %sectioncount;
11094: }
1.240 albertel 11095: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11096: foreach my $user (sort(keys(%courseroles))) {
11097: if ($user !~ /^(\w{2})/) { next; }
11098: my ($role) = ($user =~ /^(\w{2})/);
11099: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11100: my ($section,$status);
1.240 albertel 11101: if ($role eq 'cr' &&
11102: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11103: $section=$1;
11104: }
11105: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11106: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11107: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11108: if ($end == -1 && $start == -1) {
11109: next; #deleted role
11110: }
11111: if (!defined($possible_status)) {
11112: $sectioncount{$section}++;
11113: } else {
11114: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11115: $status = 'active';
11116: } elsif ($end < $now) {
11117: $status = 'future';
11118: } elsif ($start > $now) {
11119: $status = 'previous';
11120: }
11121: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11122: $sectioncount{$section}++;
11123: }
11124: }
1.233 raeburn 11125: }
1.366 albertel 11126: return %sectioncount;
1.233 raeburn 11127: }
11128:
1.274 raeburn 11129: ###############################################
1.294 raeburn 11130:
11131: =pod
1.405 albertel 11132:
11133: =item * &get_course_users()
11134:
1.275 raeburn 11135: Retrieves usernames:domains for users in the specified course
11136: with specific role(s), and access status.
11137:
11138: Incoming parameters:
1.277 albertel 11139: 1. course domain
11140: 2. course number
11141: 3. access status: users must have - either active,
1.275 raeburn 11142: previous, future, or all.
1.277 albertel 11143: 4. reference to array of permissible roles
1.288 raeburn 11144: 5. reference to array of section restrictions (optional)
11145: 6. reference to results object (hash of hashes).
11146: 7. reference to optional userdata hash
1.609 raeburn 11147: 8. reference to optional statushash
1.630 raeburn 11148: 9. flag if privileged users (except those set to unhide in
11149: course settings) should be excluded
1.609 raeburn 11150: Keys of top level results hash are roles.
1.275 raeburn 11151: Keys of inner hashes are username:domain, with
11152: values set to access type.
1.288 raeburn 11153: Optional userdata hash returns an array with arguments in the
11154: same order as loncoursedata::get_classlist() for student data.
11155:
1.609 raeburn 11156: Optional statushash returns
11157:
1.288 raeburn 11158: Entries for end, start, section and status are blank because
11159: of the possibility of multiple values for non-student roles.
11160:
1.275 raeburn 11161: =cut
1.405 albertel 11162:
1.275 raeburn 11163: ###############################################
1.405 albertel 11164:
1.275 raeburn 11165: sub get_course_users {
1.630 raeburn 11166: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11167: my %idx = ();
1.419 raeburn 11168: my %seclists;
1.288 raeburn 11169:
11170: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11171: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11172: $idx{end} = &Apache::loncoursedata::CL_END();
11173: $idx{start} = &Apache::loncoursedata::CL_START();
11174: $idx{id} = &Apache::loncoursedata::CL_ID();
11175: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11176: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11177: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11178:
1.290 albertel 11179: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11180: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11181: my $now = time;
1.277 albertel 11182: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11183: my $match = 0;
1.412 raeburn 11184: my $secmatch = 0;
1.419 raeburn 11185: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11186: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11187: if ($section eq '') {
11188: $section = 'none';
11189: }
1.291 albertel 11190: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11191: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11192: $secmatch = 1;
11193: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11194: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11195: $secmatch = 1;
11196: }
11197: } else {
1.419 raeburn 11198: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11199: $secmatch = 1;
11200: }
1.290 albertel 11201: }
1.412 raeburn 11202: if (!$secmatch) {
11203: next;
11204: }
1.419 raeburn 11205: }
1.275 raeburn 11206: if (defined($$types{'active'})) {
1.288 raeburn 11207: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11208: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11209: $match = 1;
1.275 raeburn 11210: }
11211: }
11212: if (defined($$types{'previous'})) {
1.609 raeburn 11213: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11214: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11215: $match = 1;
1.275 raeburn 11216: }
11217: }
11218: if (defined($$types{'future'})) {
1.609 raeburn 11219: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11220: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11221: $match = 1;
1.275 raeburn 11222: }
11223: }
1.609 raeburn 11224: if ($match) {
11225: push(@{$seclists{$student}},$section);
11226: if (ref($userdata) eq 'HASH') {
11227: $$userdata{$student} = $$classlist{$student};
11228: }
11229: if (ref($statushash) eq 'HASH') {
11230: $statushash->{$student}{'st'}{$section} = $status;
11231: }
1.288 raeburn 11232: }
1.275 raeburn 11233: }
11234: }
1.412 raeburn 11235: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11236: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11237: my $now = time;
1.609 raeburn 11238: my %displaystatus = ( previous => 'Expired',
11239: active => 'Active',
11240: future => 'Future',
11241: );
1.1121 raeburn 11242: my (%nothide,@possdoms);
1.630 raeburn 11243: if ($hidepriv) {
11244: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11245: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11246: if ($user !~ /:/) {
11247: $nothide{join(':',split(/[\@]/,$user))}=1;
11248: } else {
11249: $nothide{$user} = 1;
11250: }
11251: }
1.1121 raeburn 11252: my @possdoms = ($cdom);
11253: if ($coursehash{'checkforpriv'}) {
11254: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11255: }
1.630 raeburn 11256: }
1.439 raeburn 11257: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11258: my $match = 0;
1.412 raeburn 11259: my $secmatch = 0;
1.439 raeburn 11260: my $status;
1.412 raeburn 11261: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11262: $user =~ s/:$//;
1.439 raeburn 11263: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11264: if ($end == -1 || $start == -1) {
11265: next;
11266: }
11267: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11268: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11269: my ($uname,$udom) = split(/:/,$user);
11270: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11271: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11272: $secmatch = 1;
11273: } elsif ($usec eq '') {
1.420 albertel 11274: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11275: $secmatch = 1;
11276: }
11277: } else {
11278: if (grep(/^\Q$usec\E$/,@{$sections})) {
11279: $secmatch = 1;
11280: }
11281: }
11282: if (!$secmatch) {
11283: next;
11284: }
1.288 raeburn 11285: }
1.419 raeburn 11286: if ($usec eq '') {
11287: $usec = 'none';
11288: }
1.275 raeburn 11289: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11290: if ($hidepriv) {
1.1121 raeburn 11291: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11292: (!$nothide{$uname.':'.$udom})) {
11293: next;
11294: }
11295: }
1.503 raeburn 11296: if ($end > 0 && $end < $now) {
1.439 raeburn 11297: $status = 'previous';
11298: } elsif ($start > $now) {
11299: $status = 'future';
11300: } else {
11301: $status = 'active';
11302: }
1.277 albertel 11303: foreach my $type (keys(%{$types})) {
1.275 raeburn 11304: if ($status eq $type) {
1.420 albertel 11305: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11306: push(@{$$users{$role}{$user}},$type);
11307: }
1.288 raeburn 11308: $match = 1;
11309: }
11310: }
1.419 raeburn 11311: if (($match) && (ref($userdata) eq 'HASH')) {
11312: if (!exists($$userdata{$uname.':'.$udom})) {
11313: &get_user_info($udom,$uname,\%idx,$userdata);
11314: }
1.420 albertel 11315: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11316: push(@{$seclists{$uname.':'.$udom}},$usec);
11317: }
1.609 raeburn 11318: if (ref($statushash) eq 'HASH') {
11319: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11320: }
1.275 raeburn 11321: }
11322: }
11323: }
11324: }
1.290 albertel 11325: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11326: if ((defined($cdom)) && (defined($cnum))) {
11327: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11328: if ( defined($csettings{'internal.courseowner'}) ) {
11329: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11330: next if ($owner eq '');
11331: my ($ownername,$ownerdom);
11332: if ($owner =~ /^([^:]+):([^:]+)$/) {
11333: $ownername = $1;
11334: $ownerdom = $2;
11335: } else {
11336: $ownername = $owner;
11337: $ownerdom = $cdom;
11338: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11339: }
11340: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11341: if (defined($userdata) &&
1.609 raeburn 11342: !exists($$userdata{$owner})) {
11343: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11344: if (!grep(/^none$/,@{$seclists{$owner}})) {
11345: push(@{$seclists{$owner}},'none');
11346: }
11347: if (ref($statushash) eq 'HASH') {
11348: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11349: }
1.290 albertel 11350: }
1.279 raeburn 11351: }
11352: }
11353: }
1.419 raeburn 11354: foreach my $user (keys(%seclists)) {
11355: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11356: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11357: }
1.275 raeburn 11358: }
11359: return;
11360: }
11361:
1.288 raeburn 11362: sub get_user_info {
11363: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11364: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11365: &plainname($uname,$udom,'lastname');
1.291 albertel 11366: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11367: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11368: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11369: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11370: return;
11371: }
1.275 raeburn 11372:
1.472 raeburn 11373: ###############################################
11374:
11375: =pod
11376:
11377: =item * &get_user_quota()
11378:
1.1134 raeburn 11379: Retrieves quota assigned for storage of user files.
11380: Default is to report quota for portfolio files.
1.472 raeburn 11381:
11382: Incoming parameters:
11383: 1. user's username
11384: 2. user's domain
1.1134 raeburn 11385: 3. quota name - portfolio, author, or course
1.1136 raeburn 11386: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11387: 4. crstype - official, unofficial, textbook, placement or community,
11388: if quota name is course
1.472 raeburn 11389:
11390: Returns:
1.1163 raeburn 11391: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11392: 2. (Optional) Type of setting: custom or default
11393: (individually assigned or default for user's
11394: institutional status).
11395: 3. (Optional) - User's institutional status (e.g., faculty, staff
11396: or student - types as defined in localenroll::inst_usertypes
11397: for user's domain, which determines default quota for user.
11398: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11399:
11400: If a value has been stored in the user's environment,
1.536 raeburn 11401: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11402: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11403:
11404: =cut
11405:
11406: ###############################################
11407:
11408:
11409: sub get_user_quota {
1.1136 raeburn 11410: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11411: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11412: if (!defined($udom)) {
11413: $udom = $env{'user.domain'};
11414: }
11415: if (!defined($uname)) {
11416: $uname = $env{'user.name'};
11417: }
11418: if (($udom eq '' || $uname eq '') ||
11419: ($udom eq 'public') && ($uname eq 'public')) {
11420: $quota = 0;
1.536 raeburn 11421: $quotatype = 'default';
11422: $defquota = 0;
1.472 raeburn 11423: } else {
1.536 raeburn 11424: my $inststatus;
1.1134 raeburn 11425: if ($quotaname eq 'course') {
11426: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11427: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11428: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11429: } else {
11430: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11431: $quota = $cenv{'internal.uploadquota'};
11432: }
1.536 raeburn 11433: } else {
1.1134 raeburn 11434: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11435: if ($quotaname eq 'author') {
11436: $quota = $env{'environment.authorquota'};
11437: } else {
11438: $quota = $env{'environment.portfolioquota'};
11439: }
11440: $inststatus = $env{'environment.inststatus'};
11441: } else {
11442: my %userenv =
11443: &Apache::lonnet::get('environment',['portfolioquota',
11444: 'authorquota','inststatus'],$udom,$uname);
11445: my ($tmp) = keys(%userenv);
11446: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11447: if ($quotaname eq 'author') {
11448: $quota = $userenv{'authorquota'};
11449: } else {
11450: $quota = $userenv{'portfolioquota'};
11451: }
11452: $inststatus = $userenv{'inststatus'};
11453: } else {
11454: undef(%userenv);
11455: }
11456: }
11457: }
11458: if ($quota eq '' || wantarray) {
11459: if ($quotaname eq 'course') {
11460: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11461: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11462: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11463: ($crstype eq 'placement')) {
1.1136 raeburn 11464: $defquota = $domdefs{$crstype.'quota'};
11465: }
11466: if ($defquota eq '') {
11467: $defquota = 500;
11468: }
1.1134 raeburn 11469: } else {
11470: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11471: }
11472: if ($quota eq '') {
11473: $quota = $defquota;
11474: $quotatype = 'default';
11475: } else {
11476: $quotatype = 'custom';
11477: }
1.472 raeburn 11478: }
11479: }
1.536 raeburn 11480: if (wantarray) {
11481: return ($quota,$quotatype,$settingstatus,$defquota);
11482: } else {
11483: return $quota;
11484: }
1.472 raeburn 11485: }
11486:
11487: ###############################################
11488:
11489: =pod
11490:
11491: =item * &default_quota()
11492:
1.536 raeburn 11493: Retrieves default quota assigned for storage of user portfolio files,
11494: given an (optional) user's institutional status.
1.472 raeburn 11495:
11496: Incoming parameters:
1.1142 raeburn 11497:
1.472 raeburn 11498: 1. domain
1.536 raeburn 11499: 2. (Optional) institutional status(es). This is a : separated list of
11500: status types (e.g., faculty, staff, student etc.)
11501: which apply to the user for whom the default is being retrieved.
11502: If the institutional status string in undefined, the domain
1.1134 raeburn 11503: default quota will be returned.
11504: 3. quota name - portfolio, author, or course
11505: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11506:
11507: Returns:
1.1142 raeburn 11508:
1.1163 raeburn 11509: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11510: 2. (Optional) institutional type which determined the value of the
11511: default quota.
1.472 raeburn 11512:
11513: If a value has been stored in the domain's configuration db,
11514: it will return that, otherwise it returns 20 (for backwards
11515: compatibility with domains which have not set up a configuration
1.1163 raeburn 11516: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11517:
1.536 raeburn 11518: If the user's status includes multiple types (e.g., staff and student),
11519: the largest default quota which applies to the user determines the
11520: default quota returned.
11521:
1.472 raeburn 11522: =cut
11523:
11524: ###############################################
11525:
11526:
11527: sub default_quota {
1.1134 raeburn 11528: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11529: my ($defquota,$settingstatus);
11530: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11531: ['quotas'],$udom);
1.1134 raeburn 11532: my $key = 'defaultquota';
11533: if ($quotaname eq 'author') {
11534: $key = 'authorquota';
11535: }
1.622 raeburn 11536: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11537: if ($inststatus ne '') {
1.765 raeburn 11538: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11539: foreach my $item (@statuses) {
1.1134 raeburn 11540: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11541: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11542: if ($defquota eq '') {
1.1134 raeburn 11543: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11544: $settingstatus = $item;
1.1134 raeburn 11545: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11546: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11547: $settingstatus = $item;
11548: }
11549: }
1.1134 raeburn 11550: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11551: if ($quotahash{'quotas'}{$item} ne '') {
11552: if ($defquota eq '') {
11553: $defquota = $quotahash{'quotas'}{$item};
11554: $settingstatus = $item;
11555: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11556: $defquota = $quotahash{'quotas'}{$item};
11557: $settingstatus = $item;
11558: }
1.536 raeburn 11559: }
11560: }
11561: }
11562: }
11563: if ($defquota eq '') {
1.1134 raeburn 11564: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11565: $defquota = $quotahash{'quotas'}{$key}{'default'};
11566: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11567: $defquota = $quotahash{'quotas'}{'default'};
11568: }
1.536 raeburn 11569: $settingstatus = 'default';
1.1139 raeburn 11570: if ($defquota eq '') {
11571: if ($quotaname eq 'author') {
11572: $defquota = 500;
11573: }
11574: }
1.536 raeburn 11575: }
11576: } else {
11577: $settingstatus = 'default';
1.1134 raeburn 11578: if ($quotaname eq 'author') {
11579: $defquota = 500;
11580: } else {
11581: $defquota = 20;
11582: }
1.536 raeburn 11583: }
11584: if (wantarray) {
11585: return ($defquota,$settingstatus);
1.472 raeburn 11586: } else {
1.536 raeburn 11587: return $defquota;
1.472 raeburn 11588: }
11589: }
11590:
1.1135 raeburn 11591: ###############################################
11592:
11593: =pod
11594:
1.1136 raeburn 11595: =item * &excess_filesize_warning()
1.1135 raeburn 11596:
11597: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11598: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11599: space to be exceeded.
1.1136 raeburn 11600:
11601: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11602: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11603:
1.1165 raeburn 11604: Inputs: 7
1.1136 raeburn 11605: 1. username or coursenum
1.1135 raeburn 11606: 2. domain
1.1136 raeburn 11607: 3. context ('author' or 'course')
1.1135 raeburn 11608: 4. filename of file for which action is being requested
11609: 5. filesize (kB) of file
11610: 6. action being taken: copy or upload.
1.1237 raeburn 11611: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11612:
11613: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11614: otherwise return null.
11615:
11616: =back
1.1135 raeburn 11617:
11618: =cut
11619:
1.1136 raeburn 11620: sub excess_filesize_warning {
1.1165 raeburn 11621: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11622: my $current_disk_usage = 0;
1.1165 raeburn 11623: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11624: if ($context eq 'author') {
11625: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11626: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11627: } else {
11628: foreach my $subdir ('docs','supplemental') {
11629: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11630: }
11631: }
1.1135 raeburn 11632: $disk_quota = int($disk_quota * 1000);
11633: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11634: return '<p class="LC_warning">'.
1.1135 raeburn 11635: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11636: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11637: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11638: $disk_quota,$current_disk_usage).
11639: '</p>';
11640: }
11641: return;
11642: }
11643:
11644: ###############################################
11645:
11646:
1.1136 raeburn 11647:
11648:
1.384 raeburn 11649: sub get_secgrprole_info {
11650: my ($cdom,$cnum,$needroles,$type) = @_;
11651: my %sections_count = &get_sections($cdom,$cnum);
11652: my @sections = (sort {$a <=> $b} keys(%sections_count));
11653: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11654: my @groups = sort(keys(%curr_groups));
11655: my $allroles = [];
11656: my $rolehash;
11657: my $accesshash = {
11658: active => 'Currently has access',
11659: future => 'Will have future access',
11660: previous => 'Previously had access',
11661: };
11662: if ($needroles) {
11663: $rolehash = {'all' => 'all'};
1.385 albertel 11664: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11665: if (&Apache::lonnet::error(%user_roles)) {
11666: undef(%user_roles);
11667: }
11668: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11669: my ($role)=split(/\:/,$item,2);
11670: if ($role eq 'cr') { next; }
11671: if ($role =~ /^cr/) {
11672: $$rolehash{$role} = (split('/',$role))[3];
11673: } else {
11674: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11675: }
11676: }
11677: foreach my $key (sort(keys(%{$rolehash}))) {
11678: push(@{$allroles},$key);
11679: }
11680: push (@{$allroles},'st');
11681: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11682: }
11683: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11684: }
11685:
1.555 raeburn 11686: sub user_picker {
1.1279 raeburn 11687: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11688: my $currdom = $dom;
1.1253 raeburn 11689: my @alldoms = &Apache::lonnet::all_domains();
11690: if (@alldoms == 1) {
11691: my %domsrch = &Apache::lonnet::get_dom('configuration',
11692: ['directorysrch'],$alldoms[0]);
11693: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11694: my $showdom = $domdesc;
11695: if ($showdom eq '') {
11696: $showdom = $dom;
11697: }
11698: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11699: if ((!$domsrch{'directorysrch'}{'available'}) &&
11700: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11701: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11702: }
11703: }
11704: }
1.555 raeburn 11705: my %curr_selected = (
11706: srchin => 'dom',
1.580 raeburn 11707: srchby => 'lastname',
1.555 raeburn 11708: );
11709: my $srchterm;
1.625 raeburn 11710: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11711: if ($srch->{'srchby'} ne '') {
11712: $curr_selected{'srchby'} = $srch->{'srchby'};
11713: }
11714: if ($srch->{'srchin'} ne '') {
11715: $curr_selected{'srchin'} = $srch->{'srchin'};
11716: }
11717: if ($srch->{'srchtype'} ne '') {
11718: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11719: }
11720: if ($srch->{'srchdomain'} ne '') {
11721: $currdom = $srch->{'srchdomain'};
11722: }
11723: $srchterm = $srch->{'srchterm'};
11724: }
1.1222 damieng 11725: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11726: 'usr' => 'Search criteria',
1.563 raeburn 11727: 'doma' => 'Domain/institution to search',
1.558 albertel 11728: 'uname' => 'username',
11729: 'lastname' => 'last name',
1.555 raeburn 11730: 'lastfirst' => 'last name, first name',
1.558 albertel 11731: 'crs' => 'in this course',
1.576 raeburn 11732: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11733: 'alc' => 'all LON-CAPA',
1.573 raeburn 11734: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11735: 'exact' => 'is',
11736: 'contains' => 'contains',
1.569 raeburn 11737: 'begins' => 'begins with',
1.1222 damieng 11738: );
11739: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11740: 'youm' => "You must include some text to search for.",
11741: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11742: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11743: 'yomc' => "You must choose a domain when using an institutional directory search.",
11744: 'ymcd' => "You must choose a domain when using a domain search.",
11745: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11746: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11747: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11748: );
1.1222 damieng 11749: &html_escape(\%html_lt);
11750: &js_escape(\%js_lt);
1.1255 raeburn 11751: my $domform;
1.1277 raeburn 11752: my $allow_blank = 1;
1.1255 raeburn 11753: if ($fixeddom) {
1.1277 raeburn 11754: $allow_blank = 0;
11755: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11756: } else {
1.1287 raeburn 11757: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11758: my ($trusted,$untrusted);
1.1287 raeburn 11759: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11760: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11761: } elsif ($context eq 'author') {
1.1288 raeburn 11762: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11763: } elsif ($context eq 'domain') {
1.1288 raeburn 11764: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11765: }
1.1288 raeburn 11766: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11767: }
1.563 raeburn 11768: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11769:
11770: my @srchins = ('crs','dom','alc','instd');
11771:
11772: foreach my $option (@srchins) {
11773: # FIXME 'alc' option unavailable until
11774: # loncreateuser::print_user_query_page()
11775: # has been completed.
11776: next if ($option eq 'alc');
1.880 raeburn 11777: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11778: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11779: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11780: if ($curr_selected{'srchin'} eq $option) {
11781: $srchinsel .= '
1.1222 damieng 11782: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11783: } else {
11784: $srchinsel .= '
1.1222 damieng 11785: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11786: }
1.555 raeburn 11787: }
1.563 raeburn 11788: $srchinsel .= "\n </select>\n";
1.555 raeburn 11789:
11790: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11791: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11792: if ($curr_selected{'srchby'} eq $option) {
11793: $srchbysel .= '
1.1222 damieng 11794: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11795: } else {
11796: $srchbysel .= '
1.1222 damieng 11797: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11798: }
11799: }
11800: $srchbysel .= "\n </select>\n";
11801:
11802: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11803: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11804: if ($curr_selected{'srchtype'} eq $option) {
11805: $srchtypesel .= '
1.1222 damieng 11806: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11807: } else {
11808: $srchtypesel .= '
1.1222 damieng 11809: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11810: }
11811: }
11812: $srchtypesel .= "\n </select>\n";
11813:
1.558 albertel 11814: my ($newuserscript,$new_user_create);
1.994 raeburn 11815: my $context_dom = $env{'request.role.domain'};
11816: if ($context eq 'requestcrs') {
11817: if ($env{'form.coursedom'} ne '') {
11818: $context_dom = $env{'form.coursedom'};
11819: }
11820: }
1.556 raeburn 11821: if ($forcenewuser) {
1.576 raeburn 11822: if (ref($srch) eq 'HASH') {
1.994 raeburn 11823: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11824: if ($cancreate) {
11825: $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>';
11826: } else {
1.799 bisitz 11827: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11828: my %usertypetext = (
11829: official => 'institutional',
11830: unofficial => 'non-institutional',
11831: );
1.799 bisitz 11832: $new_user_create = '<p class="LC_warning">'
11833: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11834: .' '
11835: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11836: ,'<a href="'.$helplink.'">','</a>')
11837: .'</p><br />';
1.627 raeburn 11838: }
1.576 raeburn 11839: }
11840: }
11841:
1.556 raeburn 11842: $newuserscript = <<"ENDSCRIPT";
11843:
1.570 raeburn 11844: function setSearch(createnew,callingForm) {
1.556 raeburn 11845: if (createnew == 1) {
1.570 raeburn 11846: for (var i=0; i<callingForm.srchby.length; i++) {
11847: if (callingForm.srchby.options[i].value == 'uname') {
11848: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11849: }
11850: }
1.570 raeburn 11851: for (var i=0; i<callingForm.srchin.length; i++) {
11852: if ( callingForm.srchin.options[i].value == 'dom') {
11853: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11854: }
11855: }
1.570 raeburn 11856: for (var i=0; i<callingForm.srchtype.length; i++) {
11857: if (callingForm.srchtype.options[i].value == 'exact') {
11858: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11859: }
11860: }
1.570 raeburn 11861: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11862: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11863: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11864: }
11865: }
11866: }
11867: }
11868: ENDSCRIPT
1.558 albertel 11869:
1.556 raeburn 11870: }
11871:
1.555 raeburn 11872: my $output = <<"END_BLOCK";
1.556 raeburn 11873: <script type="text/javascript">
1.824 bisitz 11874: // <![CDATA[
1.570 raeburn 11875: function validateEntry(callingForm) {
1.558 albertel 11876:
1.556 raeburn 11877: var checkok = 1;
1.558 albertel 11878: var srchin;
1.570 raeburn 11879: for (var i=0; i<callingForm.srchin.length; i++) {
11880: if ( callingForm.srchin[i].checked ) {
11881: srchin = callingForm.srchin[i].value;
1.558 albertel 11882: }
11883: }
11884:
1.570 raeburn 11885: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11886: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11887: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11888: var srchterm = callingForm.srchterm.value;
11889: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11890: var msg = "";
11891:
11892: if (srchterm == "") {
11893: checkok = 0;
1.1222 damieng 11894: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11895: }
11896:
1.569 raeburn 11897: if (srchtype== 'begins') {
11898: if (srchterm.length < 2) {
11899: checkok = 0;
1.1222 damieng 11900: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11901: }
11902: }
11903:
1.556 raeburn 11904: if (srchtype== 'contains') {
11905: if (srchterm.length < 3) {
11906: checkok = 0;
1.1222 damieng 11907: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11908: }
11909: }
11910: if (srchin == 'instd') {
11911: if (srchdomain == '') {
11912: checkok = 0;
1.1222 damieng 11913: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11914: }
11915: }
11916: if (srchin == 'dom') {
11917: if (srchdomain == '') {
11918: checkok = 0;
1.1222 damieng 11919: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11920: }
11921: }
11922: if (srchby == 'lastfirst') {
11923: if (srchterm.indexOf(",") == -1) {
11924: checkok = 0;
1.1222 damieng 11925: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11926: }
11927: if (srchterm.indexOf(",") == srchterm.length -1) {
11928: checkok = 0;
1.1222 damieng 11929: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11930: }
11931: }
11932: if (checkok == 0) {
1.1222 damieng 11933: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11934: return;
11935: }
11936: if (checkok == 1) {
1.570 raeburn 11937: callingForm.submit();
1.556 raeburn 11938: }
11939: }
11940:
11941: $newuserscript
11942:
1.824 bisitz 11943: // ]]>
1.556 raeburn 11944: </script>
1.558 albertel 11945:
11946: $new_user_create
11947:
1.555 raeburn 11948: END_BLOCK
1.558 albertel 11949:
1.876 raeburn 11950: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11951: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11952: $domform.
11953: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11954: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11955: $srchbysel.
11956: $srchtypesel.
11957: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11958: $srchinsel.
11959: &Apache::lonhtmlcommon::row_closure(1).
11960: &Apache::lonhtmlcommon::end_pick_box().
11961: '<br />';
1.1253 raeburn 11962: return ($output,1);
1.555 raeburn 11963: }
11964:
1.612 raeburn 11965: sub user_rule_check {
1.615 raeburn 11966: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11967: my ($response,%inst_response);
1.612 raeburn 11968: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11969: if (keys(%{$usershash}) > 1) {
11970: my (%by_username,%by_id,%userdoms);
11971: my $checkid;
11972: if (ref($checks) eq 'HASH') {
11973: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11974: $checkid = 1;
11975: }
11976: }
11977: foreach my $user (keys(%{$usershash})) {
11978: my ($uname,$udom) = split(/:/,$user);
11979: if ($checkid) {
11980: if (ref($usershash->{$user}) eq 'HASH') {
11981: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11982: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11983: $userdoms{$udom} = 1;
1.1227 raeburn 11984: if (ref($inst_results) eq 'HASH') {
11985: $inst_results->{$uname.':'.$udom} = {};
11986: }
1.1226 raeburn 11987: }
11988: }
11989: } else {
11990: $by_username{$udom}{$uname} = 1;
11991: $userdoms{$udom} = 1;
1.1227 raeburn 11992: if (ref($inst_results) eq 'HASH') {
11993: $inst_results->{$uname.':'.$udom} = {};
11994: }
1.1226 raeburn 11995: }
11996: }
11997: foreach my $udom (keys(%userdoms)) {
11998: if (!$got_rules->{$udom}) {
11999: my %domconfig = &Apache::lonnet::get_dom('configuration',
12000: ['usercreation'],$udom);
12001: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12002: foreach my $item ('username','id') {
12003: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 12004: $$curr_rules{$udom}{$item} =
12005: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 12006: }
12007: }
12008: }
12009: $got_rules->{$udom} = 1;
12010: }
1.612 raeburn 12011: }
1.1226 raeburn 12012: if ($checkid) {
12013: foreach my $udom (keys(%by_id)) {
12014: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12015: if ($outcome eq 'ok') {
1.1227 raeburn 12016: foreach my $id (keys(%{$by_id{$udom}})) {
12017: my $uname = $by_id{$udom}{$id};
12018: $inst_response{$uname.':'.$udom} = $outcome;
12019: }
1.1226 raeburn 12020: if (ref($results) eq 'HASH') {
12021: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12022: if (exists($inst_response{$uname.':'.$udom})) {
12023: $inst_response{$uname.':'.$udom} = $outcome;
12024: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12025: }
1.1226 raeburn 12026: }
12027: }
12028: }
1.612 raeburn 12029: }
1.615 raeburn 12030: } else {
1.1226 raeburn 12031: foreach my $udom (keys(%by_username)) {
12032: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12033: if ($outcome eq 'ok') {
1.1227 raeburn 12034: foreach my $uname (keys(%{$by_username{$udom}})) {
12035: $inst_response{$uname.':'.$udom} = $outcome;
12036: }
1.1226 raeburn 12037: if (ref($results) eq 'HASH') {
12038: foreach my $uname (keys(%{$results})) {
12039: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12040: }
12041: }
12042: }
12043: }
1.612 raeburn 12044: }
1.1226 raeburn 12045: } elsif (keys(%{$usershash}) == 1) {
12046: my $user = (keys(%{$usershash}))[0];
12047: my ($uname,$udom) = split(/:/,$user);
12048: if (($udom ne '') && ($uname ne '')) {
12049: if (ref($usershash->{$user}) eq 'HASH') {
12050: if (ref($checks) eq 'HASH') {
12051: if (defined($checks->{'username'})) {
12052: ($inst_response{$user},%{$inst_results->{$user}}) =
12053: &Apache::lonnet::get_instuser($udom,$uname);
12054: } elsif (defined($checks->{'id'})) {
12055: if ($usershash->{$user}->{'id'} ne '') {
12056: ($inst_response{$user},%{$inst_results->{$user}}) =
12057: &Apache::lonnet::get_instuser($udom,undef,
12058: $usershash->{$user}->{'id'});
12059: } else {
12060: ($inst_response{$user},%{$inst_results->{$user}}) =
12061: &Apache::lonnet::get_instuser($udom,$uname);
12062: }
1.585 raeburn 12063: }
1.1226 raeburn 12064: } else {
12065: ($inst_response{$user},%{$inst_results->{$user}}) =
12066: &Apache::lonnet::get_instuser($udom,$uname);
12067: return;
12068: }
12069: if (!$got_rules->{$udom}) {
12070: my %domconfig = &Apache::lonnet::get_dom('configuration',
12071: ['usercreation'],$udom);
12072: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12073: foreach my $item ('username','id') {
12074: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12075: $$curr_rules{$udom}{$item} =
12076: $domconfig{'usercreation'}{$item.'_rule'};
12077: }
12078: }
12079: }
12080: $got_rules->{$udom} = 1;
1.585 raeburn 12081: }
12082: }
1.1226 raeburn 12083: } else {
12084: return;
12085: }
12086: } else {
12087: return;
12088: }
12089: foreach my $user (keys(%{$usershash})) {
12090: my ($uname,$udom) = split(/:/,$user);
12091: next if (($udom eq '') || ($uname eq ''));
12092: my $id;
1.1227 raeburn 12093: if (ref($inst_results) eq 'HASH') {
12094: if (ref($inst_results->{$user}) eq 'HASH') {
12095: $id = $inst_results->{$user}->{'id'};
12096: }
12097: }
12098: if ($id eq '') {
12099: if (ref($usershash->{$user})) {
12100: $id = $usershash->{$user}->{'id'};
12101: }
1.585 raeburn 12102: }
1.612 raeburn 12103: foreach my $item (keys(%{$checks})) {
12104: if (ref($$curr_rules{$udom}) eq 'HASH') {
12105: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12106: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12107: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12108: $$curr_rules{$udom}{$item});
1.612 raeburn 12109: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12110: if ($rule_check{$rule}) {
12111: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12112: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12113: if (ref($inst_results) eq 'HASH') {
12114: if (ref($inst_results->{$user}) eq 'HASH') {
12115: if (keys(%{$inst_results->{$user}}) == 0) {
12116: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12117: } elsif ($item eq 'id') {
12118: if ($inst_results->{$user}->{'id'} eq '') {
12119: $$alerts{$item}{$udom}{$uname} = 1;
12120: }
1.615 raeburn 12121: }
1.612 raeburn 12122: }
12123: }
1.615 raeburn 12124: }
12125: last;
1.585 raeburn 12126: }
12127: }
12128: }
12129: }
12130: }
12131: }
12132: }
12133: }
1.612 raeburn 12134: return;
12135: }
12136:
12137: sub user_rule_formats {
12138: my ($domain,$domdesc,$curr_rules,$check) = @_;
12139: my %text = (
12140: 'username' => 'Usernames',
12141: 'id' => 'IDs',
12142: );
12143: my $output;
12144: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12145: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12146: if (@{$ruleorder} > 0) {
1.1102 raeburn 12147: $output = '<br />'.
12148: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12149: '<span class="LC_cusr_emph">','</span>',$domdesc).
12150: ' <ul>';
1.612 raeburn 12151: foreach my $rule (@{$ruleorder}) {
12152: if (ref($curr_rules) eq 'ARRAY') {
12153: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12154: if (ref($rules->{$rule}) eq 'HASH') {
12155: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12156: $rules->{$rule}{'desc'}.'</li>';
12157: }
12158: }
12159: }
12160: }
12161: $output .= '</ul>';
12162: }
12163: }
12164: return $output;
12165: }
12166:
12167: sub instrule_disallow_msg {
1.615 raeburn 12168: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12169: my $response;
12170: my %text = (
12171: item => 'username',
12172: items => 'usernames',
12173: match => 'matches',
12174: do => 'does',
12175: action => 'a username',
12176: one => 'one',
12177: );
12178: if ($count > 1) {
12179: $text{'item'} = 'usernames';
12180: $text{'match'} ='match';
12181: $text{'do'} = 'do';
12182: $text{'action'} = 'usernames',
12183: $text{'one'} = 'ones';
12184: }
12185: if ($checkitem eq 'id') {
12186: $text{'items'} = 'IDs';
12187: $text{'item'} = 'ID';
12188: $text{'action'} = 'an ID';
1.615 raeburn 12189: if ($count > 1) {
12190: $text{'item'} = 'IDs';
12191: $text{'action'} = 'IDs';
12192: }
1.612 raeburn 12193: }
1.674 bisitz 12194: $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 12195: if ($mode eq 'upload') {
12196: if ($checkitem eq 'username') {
12197: $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'}.");
12198: } elsif ($checkitem eq 'id') {
1.674 bisitz 12199: $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 12200: }
1.669 raeburn 12201: } elsif ($mode eq 'selfcreate') {
12202: if ($checkitem eq 'id') {
12203: $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.");
12204: }
1.615 raeburn 12205: } else {
12206: if ($checkitem eq 'username') {
12207: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12208: } elsif ($checkitem eq 'id') {
12209: $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.");
12210: }
1.612 raeburn 12211: }
12212: return $response;
1.585 raeburn 12213: }
12214:
1.624 raeburn 12215: sub personal_data_fieldtitles {
12216: my %fieldtitles = &Apache::lonlocal::texthash (
12217: id => 'Student/Employee ID',
12218: permanentemail => 'E-mail address',
12219: lastname => 'Last Name',
12220: firstname => 'First Name',
12221: middlename => 'Middle Name',
12222: generation => 'Generation',
12223: gen => 'Generation',
1.765 raeburn 12224: inststatus => 'Affiliation',
1.624 raeburn 12225: );
12226: return %fieldtitles;
12227: }
12228:
1.642 raeburn 12229: sub sorted_inst_types {
12230: my ($dom) = @_;
1.1185 raeburn 12231: my ($usertypes,$order);
12232: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12233: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12234: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12235: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12236: } else {
12237: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12238: }
1.642 raeburn 12239: my $othertitle = &mt('All users');
12240: if ($env{'request.course.id'}) {
1.668 raeburn 12241: $othertitle = &mt('Any users');
1.642 raeburn 12242: }
12243: my @types;
12244: if (ref($order) eq 'ARRAY') {
12245: @types = @{$order};
12246: }
12247: if (@types == 0) {
12248: if (ref($usertypes) eq 'HASH') {
12249: @types = sort(keys(%{$usertypes}));
12250: }
12251: }
12252: if (keys(%{$usertypes}) > 0) {
12253: $othertitle = &mt('Other users');
12254: }
12255: return ($othertitle,$usertypes,\@types);
12256: }
12257:
1.645 raeburn 12258: sub get_institutional_codes {
1.1361 raeburn 12259: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12260: # Get complete list of course sections to update
12261: my @currsections = ();
12262: my @currxlists = ();
1.1361 raeburn 12263: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12264: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12265: my $crskey = $crs.':'.$coursecode;
12266: @{$unclutteredsec{$crskey}} = ();
12267: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12268:
12269: if ($$settings{'internal.sectionnums'} ne '') {
12270: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12271: }
12272:
12273: if ($$settings{'internal.crosslistings'} ne '') {
12274: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12275: }
12276:
12277: if (@currxlists > 0) {
1.1361 raeburn 12278: foreach my $xl (@currxlists) {
12279: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12280: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12281: push(@{$allcourses},$1);
1.645 raeburn 12282: $$LC_code{$1} = $2;
12283: }
12284: }
12285: }
12286: }
1.1361 raeburn 12287:
1.645 raeburn 12288: if (@currsections > 0) {
1.1361 raeburn 12289: foreach my $sec (@currsections) {
12290: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12291: my $instsec = $1;
1.645 raeburn 12292: my $lc_sec = $2;
1.1361 raeburn 12293: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12294: push(@{$unclutteredsec{$crskey}},$instsec);
12295: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12296: }
12297: }
12298: }
12299: }
12300:
12301: if (@{$unclutteredsec{$crskey}} > 0) {
12302: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12303: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12304: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12305: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12306: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12307: push(@{$allcourses},$sec);
1.1361 raeburn 12308: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12309: }
12310: }
12311: }
12312: }
12313: return;
12314: }
12315:
1.971 raeburn 12316: sub get_standard_codeitems {
12317: return ('Year','Semester','Department','Number','Section');
12318: }
12319:
1.112 bowersj2 12320: =pod
12321:
1.780 raeburn 12322: =head1 Slot Helpers
12323:
12324: =over 4
12325:
12326: =item * sorted_slots()
12327:
1.1040 raeburn 12328: Sorts an array of slot names in order of an optional sort key,
12329: default sort is by slot start time (earliest first).
1.780 raeburn 12330:
12331: Inputs:
12332:
12333: =over 4
12334:
12335: slotsarr - Reference to array of unsorted slot names.
12336:
12337: slots - Reference to hash of hash, where outer hash keys are slot names.
12338:
1.1040 raeburn 12339: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12340:
1.549 albertel 12341: =back
12342:
1.780 raeburn 12343: Returns:
12344:
12345: =over 4
12346:
1.1040 raeburn 12347: sorted - An array of slot names sorted by a specified sort key
12348: (default sort key is start time of the slot).
1.780 raeburn 12349:
12350: =back
12351:
12352: =cut
12353:
12354:
12355: sub sorted_slots {
1.1040 raeburn 12356: my ($slotsarr,$slots,$sortkey) = @_;
12357: if ($sortkey eq '') {
12358: $sortkey = 'starttime';
12359: }
1.780 raeburn 12360: my @sorted;
12361: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12362: @sorted =
12363: sort {
12364: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12365: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12366: }
12367: if (ref($slots->{$a})) { return -1;}
12368: if (ref($slots->{$b})) { return 1;}
12369: return 0;
12370: } @{$slotsarr};
12371: }
12372: return @sorted;
12373: }
12374:
1.1040 raeburn 12375: =pod
12376:
12377: =item * get_future_slots()
12378:
12379: Inputs:
12380:
12381: =over 4
12382:
12383: cnum - course number
12384:
12385: cdom - course domain
12386:
12387: now - current UNIX time
12388:
12389: symb - optional symb
12390:
12391: =back
12392:
12393: Returns:
12394:
12395: =over 4
12396:
12397: sorted_reservable - ref to array of student_schedulable slots currently
12398: reservable, ordered by end date of reservation period.
12399:
12400: reservable_now - ref to hash of student_schedulable slots currently
12401: reservable.
12402:
12403: Keys in inner hash are:
12404: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12405: (b) endreserve: end date of reservation period.
12406: (c) uniqueperiod: start,end dates when slot is to be uniquely
12407: selected.
1.1040 raeburn 12408:
12409: sorted_future - ref to array of student_schedulable slots reservable in
12410: the future, ordered by start date of reservation period.
12411:
12412: future_reservable - ref to hash of student_schedulable slots reservable
12413: in the future.
12414:
12415: Keys in inner hash are:
12416: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12417: (b) startreserve: start date of reservation period.
12418: (c) uniqueperiod: start,end dates when slot is to be uniquely
12419: selected.
1.1040 raeburn 12420:
12421: =back
12422:
12423: =cut
12424:
12425: sub get_future_slots {
12426: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12427: my $map;
12428: if ($symb) {
12429: ($map) = &Apache::lonnet::decode_symb($symb);
12430: }
1.1040 raeburn 12431: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12432: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12433: foreach my $slot (keys(%slots)) {
12434: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12435: if ($symb) {
1.1229 raeburn 12436: if ($slots{$slot}->{'symb'} ne '') {
12437: my $canuse;
12438: my %oksymbs;
12439: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12440: map { $oksymbs{$_} = 1; } @slotsymbs;
12441: if ($oksymbs{$symb}) {
12442: $canuse = 1;
12443: } else {
12444: foreach my $item (@slotsymbs) {
12445: if ($item =~ /\.(page|sequence)$/) {
12446: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12447: if (($map ne '') && ($map eq $sloturl)) {
12448: $canuse = 1;
12449: last;
12450: }
12451: }
12452: }
12453: }
12454: next unless ($canuse);
12455: }
1.1040 raeburn 12456: }
12457: if (($slots{$slot}->{'starttime'} > $now) &&
12458: ($slots{$slot}->{'endtime'} > $now)) {
12459: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12460: my $userallowed = 0;
12461: if ($slots{$slot}->{'allowedsections'}) {
12462: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12463: if (!defined($env{'request.role.sec'})
12464: && grep(/^No section assigned$/,@allowed_sec)) {
12465: $userallowed=1;
12466: } else {
12467: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12468: $userallowed=1;
12469: }
12470: }
12471: unless ($userallowed) {
12472: if (defined($env{'request.course.groups'})) {
12473: my @groups = split(/:/,$env{'request.course.groups'});
12474: foreach my $group (@groups) {
12475: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12476: $userallowed=1;
12477: last;
12478: }
12479: }
12480: }
12481: }
12482: }
12483: if ($slots{$slot}->{'allowedusers'}) {
12484: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12485: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12486: if (grep(/^\Q$user\E$/,@allowed_users)) {
12487: $userallowed = 1;
12488: }
12489: }
12490: next unless($userallowed);
12491: }
12492: my $startreserve = $slots{$slot}->{'startreserve'};
12493: my $endreserve = $slots{$slot}->{'endreserve'};
12494: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12495: my $uniqueperiod;
12496: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12497: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12498: }
1.1040 raeburn 12499: if (($startreserve < $now) &&
12500: (!$endreserve || $endreserve > $now)) {
12501: my $lastres = $endreserve;
12502: if (!$lastres) {
12503: $lastres = $slots{$slot}->{'starttime'};
12504: }
12505: $reservable_now{$slot} = {
12506: symb => $symb,
1.1250 raeburn 12507: endreserve => $lastres,
12508: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12509: };
12510: } elsif (($startreserve > $now) &&
12511: (!$endreserve || $endreserve > $startreserve)) {
12512: $future_reservable{$slot} = {
12513: symb => $symb,
1.1250 raeburn 12514: startreserve => $startreserve,
12515: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12516: };
12517: }
12518: }
12519: }
12520: my @unsorted_reservable = keys(%reservable_now);
12521: if (@unsorted_reservable > 0) {
12522: @sorted_reservable =
12523: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12524: }
12525: my @unsorted_future = keys(%future_reservable);
12526: if (@unsorted_future > 0) {
12527: @sorted_future =
12528: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12529: }
12530: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12531: }
1.780 raeburn 12532:
12533: =pod
12534:
1.1057 foxr 12535: =back
12536:
1.549 albertel 12537: =head1 HTTP Helpers
12538:
12539: =over 4
12540:
1.648 raeburn 12541: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12542:
1.258 albertel 12543: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12544: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12545: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12546:
12547: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12548: $possible_names is an ref to an array of form element names. As an example:
12549: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12550: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12551:
12552: =cut
1.1 albertel 12553:
1.6 albertel 12554: sub get_unprocessed_cgi {
1.25 albertel 12555: my ($query,$possible_names)= @_;
1.26 matthew 12556: # $Apache::lonxml::debug=1;
1.356 albertel 12557: foreach my $pair (split(/&/,$query)) {
12558: my ($name, $value) = split(/=/,$pair);
1.369 www 12559: $name = &unescape($name);
1.25 albertel 12560: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12561: $value =~ tr/+/ /;
12562: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12563: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12564: }
1.16 harris41 12565: }
1.6 albertel 12566: }
12567:
1.112 bowersj2 12568: =pod
12569:
1.648 raeburn 12570: =item * &cacheheader()
1.112 bowersj2 12571:
12572: returns cache-controlling header code
12573:
12574: =cut
12575:
1.7 albertel 12576: sub cacheheader {
1.258 albertel 12577: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12578: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12579: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12580: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12581: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12582: return $output;
1.7 albertel 12583: }
12584:
1.112 bowersj2 12585: =pod
12586:
1.648 raeburn 12587: =item * &no_cache($r)
1.112 bowersj2 12588:
12589: specifies header code to not have cache
12590:
12591: =cut
12592:
1.9 albertel 12593: sub no_cache {
1.216 albertel 12594: my ($r) = @_;
12595: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12596: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12597: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12598: $r->no_cache(1);
12599: $r->header_out("Expires" => $date);
12600: $r->header_out("Pragma" => "no-cache");
1.123 www 12601: }
12602:
12603: sub content_type {
1.181 albertel 12604: my ($r,$type,$charset) = @_;
1.299 foxr 12605: if ($r) {
12606: # Note that printout.pl calls this with undef for $r.
12607: &no_cache($r);
12608: }
1.258 albertel 12609: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12610: unless ($charset) {
12611: $charset=&Apache::lonlocal::current_encoding;
12612: }
12613: if ($charset) { $type.='; charset='.$charset; }
12614: if ($r) {
12615: $r->content_type($type);
12616: } else {
12617: print("Content-type: $type\n\n");
12618: }
1.9 albertel 12619: }
1.25 albertel 12620:
1.112 bowersj2 12621: =pod
12622:
1.648 raeburn 12623: =item * &add_to_env($name,$value)
1.112 bowersj2 12624:
1.258 albertel 12625: adds $name to the %env hash with value
1.112 bowersj2 12626: $value, if $name already exists, the entry is converted to an array
12627: reference and $value is added to the array.
12628:
12629: =cut
12630:
1.25 albertel 12631: sub add_to_env {
12632: my ($name,$value)=@_;
1.258 albertel 12633: if (defined($env{$name})) {
12634: if (ref($env{$name})) {
1.25 albertel 12635: #already have multiple values
1.258 albertel 12636: push(@{ $env{$name} },$value);
1.25 albertel 12637: } else {
12638: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12639: my $first=$env{$name};
12640: undef($env{$name});
12641: push(@{ $env{$name} },$first,$value);
1.25 albertel 12642: }
12643: } else {
1.258 albertel 12644: $env{$name}=$value;
1.25 albertel 12645: }
1.31 albertel 12646: }
1.149 albertel 12647:
12648: =pod
12649:
1.648 raeburn 12650: =item * &get_env_multiple($name)
1.149 albertel 12651:
1.258 albertel 12652: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12653: values may be defined and end up as an array ref.
12654:
12655: returns an array of values
12656:
12657: =cut
12658:
12659: sub get_env_multiple {
12660: my ($name) = @_;
12661: my @values;
1.258 albertel 12662: if (defined($env{$name})) {
1.149 albertel 12663: # exists is it an array
1.258 albertel 12664: if (ref($env{$name})) {
12665: @values=@{ $env{$name} };
1.149 albertel 12666: } else {
1.258 albertel 12667: $values[0]=$env{$name};
1.149 albertel 12668: }
12669: }
12670: return(@values);
12671: }
12672:
1.1249 damieng 12673: # Looks at given dependencies, and returns something depending on the context.
12674: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12675: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12676: # For all other contexts, returns ($output, $counter, $numpathchg).
12677: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12678: # $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.
12679: # $numpathchg: integer with the number of cleaned up dependency paths.
12680: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12681: # \%mapping: hash reference clean path -> original path for all dependencies.
12682: # @param {string} actionurl - The path to the handler, indicative of the context.
12683: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12684: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12685: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12686: # @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)
12687: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12688: sub ask_for_embedded_content {
1.1249 damieng 12689: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12690: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12691: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12692: %currsubfile,%unused,$rem);
1.1071 raeburn 12693: my $counter = 0;
12694: my $numnew = 0;
1.987 raeburn 12695: my $numremref = 0;
12696: my $numinvalid = 0;
12697: my $numpathchg = 0;
12698: my $numexisting = 0;
1.1071 raeburn 12699: my $numunused = 0;
12700: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12701: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12702: my $heading = &mt('Upload embedded files');
12703: my $buttontext = &mt('Upload');
12704:
1.1249 damieng 12705: # fills these variables based on the context:
12706: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12707: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12708: if ($env{'request.course.id'}) {
1.1123 raeburn 12709: if ($actionurl eq '/adm/dependencies') {
12710: $navmap = Apache::lonnavmaps::navmap->new();
12711: }
12712: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12713: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12714: }
1.1123 raeburn 12715: if (($actionurl eq '/adm/portfolio') ||
12716: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12717: my $current_path='/';
12718: if ($env{'form.currentpath'}) {
12719: $current_path = $env{'form.currentpath'};
12720: }
12721: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12722: $udom = $cdom;
12723: $uname = $cnum;
1.984 raeburn 12724: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12725: } else {
12726: $udom = $env{'user.domain'};
12727: $uname = $env{'user.name'};
12728: $url = '/userfiles/portfolio';
12729: }
1.987 raeburn 12730: $toplevel = $url.'/';
1.984 raeburn 12731: $url .= $current_path;
12732: $getpropath = 1;
1.987 raeburn 12733: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12734: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12735: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12736: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12737: $toplevel = $url;
1.984 raeburn 12738: if ($rest ne '') {
1.987 raeburn 12739: $url .= $rest;
12740: }
12741: } elsif ($actionurl eq '/adm/coursedocs') {
12742: if (ref($args) eq 'HASH') {
1.1071 raeburn 12743: $url = $args->{'docs_url'};
12744: $toplevel = $url;
1.1084 raeburn 12745: if ($args->{'context'} eq 'paste') {
12746: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12747: ($path) =
12748: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12749: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12750: $fileloc =~ s{^/}{};
12751: }
1.1071 raeburn 12752: }
1.1084 raeburn 12753: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12754: if ($env{'request.course.id'} ne '') {
12755: if (ref($args) eq 'HASH') {
12756: $url = $args->{'docs_url'};
12757: $title = $args->{'docs_title'};
1.1126 raeburn 12758: $toplevel = $url;
12759: unless ($toplevel =~ m{^/}) {
12760: $toplevel = "/$url";
12761: }
1.1085 raeburn 12762: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12763: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12764: $path = $1;
12765: } else {
12766: ($path) =
12767: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12768: }
1.1195 raeburn 12769: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12770: $fileloc = $toplevel;
12771: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12772: my ($udom,$uname,$fname) =
12773: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12774: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12775: } else {
12776: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12777: }
1.1071 raeburn 12778: $fileloc =~ s{^/}{};
12779: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12780: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12781: }
1.987 raeburn 12782: }
1.1123 raeburn 12783: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12784: $udom = $cdom;
12785: $uname = $cnum;
12786: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12787: $toplevel = $url;
12788: $path = $url;
12789: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12790: $fileloc =~ s{^/}{};
1.987 raeburn 12791: }
1.1249 damieng 12792:
12793: # parses the dependency paths to get some info
12794: # fills $newfiles, $mapping, $subdependencies, $dependencies
12795: # $newfiles: hash URL -> 1 for new files or external URLs
12796: # (will be completed later)
12797: # $mapping:
12798: # for external URLs: external URL -> external URL
12799: # for relative paths: clean path -> original path
12800: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12801: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12802: foreach my $file (keys(%{$allfiles})) {
12803: my $embed_file;
12804: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12805: $embed_file = $1;
12806: } else {
12807: $embed_file = $file;
12808: }
1.1158 raeburn 12809: my ($absolutepath,$cleaned_file);
12810: if ($embed_file =~ m{^\w+://}) {
12811: $cleaned_file = $embed_file;
1.1147 raeburn 12812: $newfiles{$cleaned_file} = 1;
12813: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12814: } else {
1.1158 raeburn 12815: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12816: if ($embed_file =~ m{^/}) {
12817: $absolutepath = $embed_file;
12818: }
1.1147 raeburn 12819: if ($cleaned_file =~ m{/}) {
12820: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12821: $path = &check_for_traversal($path,$url,$toplevel);
12822: my $item = $fname;
12823: if ($path ne '') {
12824: $item = $path.'/'.$fname;
12825: $subdependencies{$path}{$fname} = 1;
12826: } else {
12827: $dependencies{$item} = 1;
12828: }
12829: if ($absolutepath) {
12830: $mapping{$item} = $absolutepath;
12831: } else {
12832: $mapping{$item} = $embed_file;
12833: }
12834: } else {
12835: $dependencies{$embed_file} = 1;
12836: if ($absolutepath) {
1.1147 raeburn 12837: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12838: } else {
1.1147 raeburn 12839: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12840: }
12841: }
1.984 raeburn 12842: }
12843: }
1.1249 damieng 12844:
12845: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12846: # and lists
12847: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12848: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12849: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12850: # the path had to be cleaned up
12851: # $existing: hash clean path -> 1 if the file exists
12852: # $numexisting: number of keys in $existing
12853: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12854: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12855: # dependency subdirectories that are
12856: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12857: my $dirptr = 16384;
1.984 raeburn 12858: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12859: $currsubfile{$path} = {};
1.1123 raeburn 12860: if (($actionurl eq '/adm/portfolio') ||
12861: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12862: my ($sublistref,$listerror) =
12863: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12864: if (ref($sublistref) eq 'ARRAY') {
12865: foreach my $line (@{$sublistref}) {
12866: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12867: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12868: }
1.984 raeburn 12869: }
1.987 raeburn 12870: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12871: if (opendir(my $dir,$url.'/'.$path)) {
12872: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12873: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12874: }
1.1084 raeburn 12875: } elsif (($actionurl eq '/adm/dependencies') ||
12876: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12877: ($args->{'context'} eq 'paste')) ||
12878: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12879: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12880: my $dir;
12881: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12882: $dir = $fileloc;
12883: } else {
12884: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12885: }
1.1071 raeburn 12886: if ($dir ne '') {
12887: my ($sublistref,$listerror) =
12888: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12889: if (ref($sublistref) eq 'ARRAY') {
12890: foreach my $line (@{$sublistref}) {
12891: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12892: undef,$mtime)=split(/\&/,$line,12);
12893: unless (($testdir&$dirptr) ||
12894: ($file_name =~ /^\.\.?$/)) {
12895: $currsubfile{$path}{$file_name} = [$size,$mtime];
12896: }
12897: }
12898: }
12899: }
1.984 raeburn 12900: }
12901: }
12902: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12903: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12904: my $item = $path.'/'.$file;
12905: unless ($mapping{$item} eq $item) {
12906: $pathchanges{$item} = 1;
12907: }
12908: $existing{$item} = 1;
12909: $numexisting ++;
12910: } else {
12911: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12912: }
12913: }
1.1071 raeburn 12914: if ($actionurl eq '/adm/dependencies') {
12915: foreach my $path (keys(%currsubfile)) {
12916: if (ref($currsubfile{$path}) eq 'HASH') {
12917: foreach my $file (keys(%{$currsubfile{$path}})) {
12918: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12919: next if (($rem ne '') &&
12920: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12921: (ref($navmap) &&
12922: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12923: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12924: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12925: $unused{$path.'/'.$file} = 1;
12926: }
12927: }
12928: }
12929: }
12930: }
1.984 raeburn 12931: }
1.1249 damieng 12932:
12933: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12934: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12935: my %currfile;
1.1123 raeburn 12936: if (($actionurl eq '/adm/portfolio') ||
12937: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12938: my ($dirlistref,$listerror) =
12939: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12940: if (ref($dirlistref) eq 'ARRAY') {
12941: foreach my $line (@{$dirlistref}) {
12942: my ($file_name,$rest) = split(/\&/,$line,2);
12943: $currfile{$file_name} = 1;
12944: }
1.984 raeburn 12945: }
1.987 raeburn 12946: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12947: if (opendir(my $dir,$url)) {
1.987 raeburn 12948: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12949: map {$currfile{$_} = 1;} @dir_list;
12950: }
1.1084 raeburn 12951: } elsif (($actionurl eq '/adm/dependencies') ||
12952: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12953: ($args->{'context'} eq 'paste')) ||
12954: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12955: if ($env{'request.course.id'} ne '') {
12956: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12957: if ($dir ne '') {
12958: my ($dirlistref,$listerror) =
12959: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12960: if (ref($dirlistref) eq 'ARRAY') {
12961: foreach my $line (@{$dirlistref}) {
12962: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12963: $size,undef,$mtime)=split(/\&/,$line,12);
12964: unless (($testdir&$dirptr) ||
12965: ($file_name =~ /^\.\.?$/)) {
12966: $currfile{$file_name} = [$size,$mtime];
12967: }
12968: }
12969: }
12970: }
12971: }
1.984 raeburn 12972: }
1.1249 damieng 12973: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12974: # are not in subdirectories, using $currfile
1.984 raeburn 12975: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12976: if (exists($currfile{$file})) {
1.987 raeburn 12977: unless ($mapping{$file} eq $file) {
12978: $pathchanges{$file} = 1;
12979: }
12980: $existing{$file} = 1;
12981: $numexisting ++;
12982: } else {
1.984 raeburn 12983: $newfiles{$file} = 1;
12984: }
12985: }
1.1071 raeburn 12986: foreach my $file (keys(%currfile)) {
12987: unless (($file eq $filename) ||
12988: ($file eq $filename.'.bak') ||
12989: ($dependencies{$file})) {
1.1085 raeburn 12990: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12991: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12992: next if (($rem ne '') &&
12993: (($env{"httpref.$rem".$file} ne '') ||
12994: (ref($navmap) &&
12995: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12996: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12997: ($navmap->getResourceByUrl($rem.$1)))))));
12998: }
1.1085 raeburn 12999: }
1.1071 raeburn 13000: $unused{$file} = 1;
13001: }
13002: }
1.1249 damieng 13003:
13004: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 13005: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
13006: ($args->{'context'} eq 'paste')) {
13007: $counter = scalar(keys(%existing));
13008: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 13009: return ($output,$counter,$numpathchg,\%existing);
13010: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
13011: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
13012: $counter = scalar(keys(%existing));
13013: $numpathchg = scalar(keys(%pathchanges));
13014: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13015: }
1.1249 damieng 13016:
13017: # returns HTML otherwise, with dependency results and to ask for more uploads
13018:
13019: # $upload_output: missing dependencies (with upload form)
13020: # $modify_output: uploaded dependencies (in use)
13021: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13022: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13023: if ($actionurl eq '/adm/dependencies') {
13024: next if ($embed_file =~ m{^\w+://});
13025: }
1.660 raeburn 13026: $upload_output .= &start_data_table_row().
1.1123 raeburn 13027: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13028: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13029: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13030: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13031: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13032: }
1.1123 raeburn 13033: $upload_output .= '</td>';
1.1071 raeburn 13034: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13035: $upload_output.='<td align="right">'.
13036: '<span class="LC_info LC_fontsize_medium">'.
13037: &mt("URL points to web address").'</span>';
1.987 raeburn 13038: $numremref++;
1.660 raeburn 13039: } elsif ($args->{'error_on_invalid_names'}
13040: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13041: $upload_output.='<td align="right"><span class="LC_warning">'.
13042: &mt('Invalid characters').'</span>';
1.987 raeburn 13043: $numinvalid++;
1.660 raeburn 13044: } else {
1.1123 raeburn 13045: $upload_output .= '<td>'.
13046: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13047: $embed_file,\%mapping,
1.1071 raeburn 13048: $allfiles,$codebase,'upload');
13049: $counter ++;
13050: $numnew ++;
1.987 raeburn 13051: }
13052: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13053: }
13054: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13055: if ($actionurl eq '/adm/dependencies') {
13056: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13057: $modify_output .= &start_data_table_row().
13058: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13059: '<img src="'.&icon($embed_file).'" border="0" />'.
13060: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13061: '<td>'.$size.'</td>'.
13062: '<td>'.$mtime.'</td>'.
13063: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13064: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13065: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13066: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13067: &embedded_file_element('upload_embedded',$counter,
13068: $embed_file,\%mapping,
13069: $allfiles,$codebase,'modify').
13070: '</div></td>'.
13071: &end_data_table_row()."\n";
13072: $counter ++;
13073: } else {
13074: $upload_output .= &start_data_table_row().
1.1123 raeburn 13075: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13076: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13077: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13078: &Apache::loncommon::end_data_table_row()."\n";
13079: }
13080: }
13081: my $delidx = $counter;
13082: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13083: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13084: $delete_output .= &start_data_table_row().
13085: '<td><img src="'.&icon($oldfile).'" />'.
13086: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13087: '<td>'.$size.'</td>'.
13088: '<td>'.$mtime.'</td>'.
13089: '<td><label><input type="checkbox" name="del_upload_dep" '.
13090: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13091: &embedded_file_element('upload_embedded',$delidx,
13092: $oldfile,\%mapping,$allfiles,
13093: $codebase,'delete').'</td>'.
13094: &end_data_table_row()."\n";
13095: $numunused ++;
13096: $delidx ++;
1.987 raeburn 13097: }
13098: if ($upload_output) {
13099: $upload_output = &start_data_table().
13100: $upload_output.
13101: &end_data_table()."\n";
13102: }
1.1071 raeburn 13103: if ($modify_output) {
13104: $modify_output = &start_data_table().
13105: &start_data_table_header_row().
13106: '<th>'.&mt('File').'</th>'.
13107: '<th>'.&mt('Size (KB)').'</th>'.
13108: '<th>'.&mt('Modified').'</th>'.
13109: '<th>'.&mt('Upload replacement?').'</th>'.
13110: &end_data_table_header_row().
13111: $modify_output.
13112: &end_data_table()."\n";
13113: }
13114: if ($delete_output) {
13115: $delete_output = &start_data_table().
13116: &start_data_table_header_row().
13117: '<th>'.&mt('File').'</th>'.
13118: '<th>'.&mt('Size (KB)').'</th>'.
13119: '<th>'.&mt('Modified').'</th>'.
13120: '<th>'.&mt('Delete?').'</th>'.
13121: &end_data_table_header_row().
13122: $delete_output.
13123: &end_data_table()."\n";
13124: }
1.987 raeburn 13125: my $applies = 0;
13126: if ($numremref) {
13127: $applies ++;
13128: }
13129: if ($numinvalid) {
13130: $applies ++;
13131: }
13132: if ($numexisting) {
13133: $applies ++;
13134: }
1.1071 raeburn 13135: if ($counter || $numunused) {
1.987 raeburn 13136: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13137: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13138: $state.'<h3>'.$heading.'</h3>';
13139: if ($actionurl eq '/adm/dependencies') {
13140: if ($numnew) {
13141: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13142: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13143: $upload_output.'<br />'."\n";
13144: }
13145: if ($numexisting) {
13146: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13147: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13148: $modify_output.'<br />'."\n";
13149: $buttontext = &mt('Save changes');
13150: }
13151: if ($numunused) {
13152: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13153: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13154: $delete_output.'<br />'."\n";
13155: $buttontext = &mt('Save changes');
13156: }
13157: } else {
13158: $output .= $upload_output.'<br />'."\n";
13159: }
13160: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13161: $counter.'" />'."\n";
13162: if ($actionurl eq '/adm/dependencies') {
13163: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13164: $numnew.'" />'."\n";
13165: } elsif ($actionurl eq '') {
1.987 raeburn 13166: $output .= '<input type="hidden" name="phase" value="three" />';
13167: }
13168: } elsif ($applies) {
13169: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13170: if ($applies > 1) {
13171: $output .=
1.1123 raeburn 13172: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13173: if ($numremref) {
13174: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13175: }
13176: if ($numinvalid) {
13177: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13178: }
13179: if ($numexisting) {
13180: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13181: }
13182: $output .= '</ul><br />';
13183: } elsif ($numremref) {
13184: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13185: } elsif ($numinvalid) {
13186: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13187: } elsif ($numexisting) {
13188: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13189: }
13190: $output .= $upload_output.'<br />';
13191: }
13192: my ($pathchange_output,$chgcount);
1.1071 raeburn 13193: $chgcount = $counter;
1.987 raeburn 13194: if (keys(%pathchanges) > 0) {
13195: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13196: if ($counter) {
1.987 raeburn 13197: $output .= &embedded_file_element('pathchange',$chgcount,
13198: $embed_file,\%mapping,
1.1071 raeburn 13199: $allfiles,$codebase,'change');
1.987 raeburn 13200: } else {
13201: $pathchange_output .=
13202: &start_data_table_row().
13203: '<td><input type ="checkbox" name="namechange" value="'.
13204: $chgcount.'" checked="checked" /></td>'.
13205: '<td>'.$mapping{$embed_file}.'</td>'.
13206: '<td>'.$embed_file.
13207: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13208: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13209: '</td>'.&end_data_table_row();
1.660 raeburn 13210: }
1.987 raeburn 13211: $numpathchg ++;
13212: $chgcount ++;
1.660 raeburn 13213: }
13214: }
1.1127 raeburn 13215: if (($counter) || ($numunused)) {
1.987 raeburn 13216: if ($numpathchg) {
13217: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13218: $numpathchg.'" />'."\n";
13219: }
13220: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13221: ($actionurl eq '/adm/imsimport')) {
13222: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13223: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13224: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13225: } elsif ($actionurl eq '/adm/dependencies') {
13226: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13227: }
1.1123 raeburn 13228: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13229: } elsif ($numpathchg) {
13230: my %pathchange = ();
13231: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13232: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13233: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13234: }
1.987 raeburn 13235: }
1.1071 raeburn 13236: return ($output,$counter,$numpathchg);
1.987 raeburn 13237: }
13238:
1.1147 raeburn 13239: =pod
13240:
13241: =item * clean_path($name)
13242:
13243: Performs clean-up of directories, subdirectories and filename in an
13244: embedded object, referenced in an HTML file which is being uploaded
13245: to a course or portfolio, where
13246: "Upload embedded images/multimedia files if HTML file" checkbox was
13247: checked.
13248:
13249: Clean-up is similar to replacements in lonnet::clean_filename()
13250: except each / between sub-directory and next level is preserved.
13251:
13252: =cut
13253:
13254: sub clean_path {
13255: my ($embed_file) = @_;
13256: $embed_file =~s{^/+}{};
13257: my @contents;
13258: if ($embed_file =~ m{/}) {
13259: @contents = split(/\//,$embed_file);
13260: } else {
13261: @contents = ($embed_file);
13262: }
13263: my $lastidx = scalar(@contents)-1;
13264: for (my $i=0; $i<=$lastidx; $i++) {
13265: $contents[$i]=~s{\\}{/}g;
13266: $contents[$i]=~s/\s+/\_/g;
13267: $contents[$i]=~s{[^/\w\.\-]}{}g;
13268: if ($i == $lastidx) {
13269: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13270: }
13271: }
13272: if ($lastidx > 0) {
13273: return join('/',@contents);
13274: } else {
13275: return $contents[0];
13276: }
13277: }
13278:
1.987 raeburn 13279: sub embedded_file_element {
1.1071 raeburn 13280: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13281: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13282: (ref($codebase) eq 'HASH'));
13283: my $output;
1.1071 raeburn 13284: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13285: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13286: }
13287: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13288: &escape($embed_file).'" />';
13289: unless (($context eq 'upload_embedded') &&
13290: ($mapping->{$embed_file} eq $embed_file)) {
13291: $output .='
13292: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13293: }
13294: my $attrib;
13295: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13296: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13297: }
13298: $output .=
13299: "\n\t\t".
13300: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13301: $attrib.'" />';
13302: if (exists($codebase->{$mapping->{$embed_file}})) {
13303: $output .=
13304: "\n\t\t".
13305: '<input name="codebase_'.$num.'" type="hidden" value="'.
13306: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13307: }
1.987 raeburn 13308: return $output;
1.660 raeburn 13309: }
13310:
1.1071 raeburn 13311: sub get_dependency_details {
13312: my ($currfile,$currsubfile,$embed_file) = @_;
13313: my ($size,$mtime,$showsize,$showmtime);
13314: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13315: if ($embed_file =~ m{/}) {
13316: my ($path,$fname) = split(/\//,$embed_file);
13317: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13318: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13319: }
13320: } else {
13321: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13322: ($size,$mtime) = @{$currfile->{$embed_file}};
13323: }
13324: }
13325: $showsize = $size/1024.0;
13326: $showsize = sprintf("%.1f",$showsize);
13327: if ($mtime > 0) {
13328: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13329: }
13330: }
13331: return ($showsize,$showmtime);
13332: }
13333:
13334: sub ask_embedded_js {
13335: return <<"END";
13336: <script type="text/javascript"">
13337: // <![CDATA[
13338: function toggleBrowse(counter) {
13339: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13340: var fileid = document.getElementById('embedded_item_'+counter);
13341: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13342: if (chkboxid.checked == true) {
13343: uploaddivid.style.display='block';
13344: } else {
13345: uploaddivid.style.display='none';
13346: fileid.value = '';
13347: }
13348: }
13349: // ]]>
13350: </script>
13351:
13352: END
13353: }
13354:
1.661 raeburn 13355: sub upload_embedded {
13356: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13357: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13358: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13359: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13360: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13361: my $orig_uploaded_filename =
13362: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13363: foreach my $type ('orig','ref','attrib','codebase') {
13364: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13365: $env{'form.embedded_'.$type.'_'.$i} =
13366: &unescape($env{'form.embedded_'.$type.'_'.$i});
13367: }
13368: }
1.661 raeburn 13369: my ($path,$fname) =
13370: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13371: # no path, whole string is fname
13372: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13373: $fname = &Apache::lonnet::clean_filename($fname);
13374: # See if there is anything left
13375: next if ($fname eq '');
13376:
13377: # Check if file already exists as a file or directory.
13378: my ($state,$msg);
13379: if ($context eq 'portfolio') {
13380: my $port_path = $dirpath;
13381: if ($group ne '') {
13382: $port_path = "groups/$group/$port_path";
13383: }
1.987 raeburn 13384: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13385: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13386: $dir_root,$port_path,$disk_quota,
13387: $current_disk_usage,$uname,$udom);
13388: if ($state eq 'will_exceed_quota'
1.984 raeburn 13389: || $state eq 'file_locked') {
1.661 raeburn 13390: $output .= $msg;
13391: next;
13392: }
13393: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13394: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13395: if ($state eq 'exists') {
13396: $output .= $msg;
13397: next;
13398: }
13399: }
13400: # Check if extension is valid
13401: if (($fname =~ /\.(\w+)$/) &&
13402: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13403: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13404: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13405: next;
13406: } elsif (($fname =~ /\.(\w+)$/) &&
13407: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13408: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13409: next;
13410: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13411: $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 13412: next;
13413: }
13414: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13415: my $subdir = $path;
13416: $subdir =~ s{/+$}{};
1.661 raeburn 13417: if ($context eq 'portfolio') {
1.984 raeburn 13418: my $result;
13419: if ($state eq 'existingfile') {
13420: $result=
13421: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13422: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13423: } else {
1.984 raeburn 13424: $result=
13425: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13426: $dirpath.
1.1123 raeburn 13427: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13428: if ($result !~ m|^/uploaded/|) {
13429: $output .= '<span class="LC_error">'
13430: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13431: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13432: .'</span><br />';
13433: next;
13434: } else {
1.987 raeburn 13435: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13436: $path.$fname.'</span>').'<br />';
1.984 raeburn 13437: }
1.661 raeburn 13438: }
1.1123 raeburn 13439: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13440: my $extendedsubdir = $dirpath.'/'.$subdir;
13441: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13442: my $result =
1.1126 raeburn 13443: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13444: if ($result !~ m|^/uploaded/|) {
13445: $output .= '<span class="LC_error">'
13446: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13447: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13448: .'</span><br />';
13449: next;
13450: } else {
13451: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13452: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13453: if ($context eq 'syllabus') {
13454: &Apache::lonnet::make_public_indefinitely($result);
13455: }
1.987 raeburn 13456: }
1.661 raeburn 13457: } else {
13458: # Save the file
13459: my $target = $env{'form.embedded_item_'.$i};
13460: my $fullpath = $dir_root.$dirpath.'/'.$path;
13461: my $dest = $fullpath.$fname;
13462: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13463: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13464: my $count;
13465: my $filepath = $dir_root;
1.1027 raeburn 13466: foreach my $subdir (@parts) {
13467: $filepath .= "/$subdir";
13468: if (!-e $filepath) {
1.661 raeburn 13469: mkdir($filepath,0770);
13470: }
13471: }
13472: my $fh;
13473: if (!open($fh,'>'.$dest)) {
13474: &Apache::lonnet::logthis('Failed to create '.$dest);
13475: $output .= '<span class="LC_error">'.
1.1071 raeburn 13476: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13477: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13478: '</span><br />';
13479: } else {
13480: if (!print $fh $env{'form.embedded_item_'.$i}) {
13481: &Apache::lonnet::logthis('Failed to write to '.$dest);
13482: $output .= '<span class="LC_error">'.
1.1071 raeburn 13483: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13484: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13485: '</span><br />';
13486: } else {
1.987 raeburn 13487: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13488: $url.'</span>').'<br />';
13489: unless ($context eq 'testbank') {
13490: $footer .= &mt('View embedded file: [_1]',
13491: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13492: }
13493: }
13494: close($fh);
13495: }
13496: }
13497: if ($env{'form.embedded_ref_'.$i}) {
13498: $pathchange{$i} = 1;
13499: }
13500: }
13501: if ($output) {
13502: $output = '<p>'.$output.'</p>';
13503: }
13504: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13505: $returnflag = 'ok';
1.1071 raeburn 13506: my $numpathchgs = scalar(keys(%pathchange));
13507: if ($numpathchgs > 0) {
1.987 raeburn 13508: if ($context eq 'portfolio') {
13509: $output .= '<p>'.&mt('or').'</p>';
13510: } elsif ($context eq 'testbank') {
1.1071 raeburn 13511: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13512: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13513: $returnflag = 'modify_orightml';
13514: }
13515: }
1.1071 raeburn 13516: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13517: }
13518:
13519: sub modify_html_form {
13520: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13521: my $end = 0;
13522: my $modifyform;
13523: if ($context eq 'upload_embedded') {
13524: return unless (ref($pathchange) eq 'HASH');
13525: if ($env{'form.number_embedded_items'}) {
13526: $end += $env{'form.number_embedded_items'};
13527: }
13528: if ($env{'form.number_pathchange_items'}) {
13529: $end += $env{'form.number_pathchange_items'};
13530: }
13531: if ($end) {
13532: for (my $i=0; $i<$end; $i++) {
13533: if ($i < $env{'form.number_embedded_items'}) {
13534: next unless($pathchange->{$i});
13535: }
13536: $modifyform .=
13537: &start_data_table_row().
13538: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13539: 'checked="checked" /></td>'.
13540: '<td>'.$env{'form.embedded_ref_'.$i}.
13541: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13542: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13543: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13544: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13545: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13546: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13547: '<td>'.$env{'form.embedded_orig_'.$i}.
13548: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13549: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13550: &end_data_table_row();
1.1071 raeburn 13551: }
1.987 raeburn 13552: }
13553: } else {
13554: $modifyform = $pathchgtable;
13555: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13556: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13557: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13558: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13559: }
13560: }
13561: if ($modifyform) {
1.1071 raeburn 13562: if ($actionurl eq '/adm/dependencies') {
13563: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13564: }
1.987 raeburn 13565: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13566: '<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".
13567: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13568: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13569: '</ol></p>'."\n".'<p>'.
13570: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13571: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13572: &start_data_table()."\n".
13573: &start_data_table_header_row().
13574: '<th>'.&mt('Change?').'</th>'.
13575: '<th>'.&mt('Current reference').'</th>'.
13576: '<th>'.&mt('Required reference').'</th>'.
13577: &end_data_table_header_row()."\n".
13578: $modifyform.
13579: &end_data_table().'<br />'."\n".$hiddenstate.
13580: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13581: '</form>'."\n";
13582: }
13583: return;
13584: }
13585:
13586: sub modify_html_refs {
1.1123 raeburn 13587: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13588: my $container;
13589: if ($context eq 'portfolio') {
13590: $container = $env{'form.container'};
13591: } elsif ($context eq 'coursedoc') {
13592: $container = $env{'form.primaryurl'};
1.1071 raeburn 13593: } elsif ($context eq 'manage_dependencies') {
13594: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13595: $container = "/$container";
1.1123 raeburn 13596: } elsif ($context eq 'syllabus') {
13597: $container = $url;
1.987 raeburn 13598: } else {
1.1027 raeburn 13599: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13600: }
13601: my (%allfiles,%codebase,$output,$content);
13602: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13603: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13604: if (wantarray) {
13605: return ('',0,0);
13606: } else {
13607: return;
13608: }
13609: }
13610: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13611: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13612: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13613: if (wantarray) {
13614: return ('',0,0);
13615: } else {
13616: return;
13617: }
13618: }
1.987 raeburn 13619: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13620: if ($content eq '-1') {
13621: if (wantarray) {
13622: return ('',0,0);
13623: } else {
13624: return;
13625: }
13626: }
1.987 raeburn 13627: } else {
1.1071 raeburn 13628: unless ($container =~ /^\Q$dir_root\E/) {
13629: if (wantarray) {
13630: return ('',0,0);
13631: } else {
13632: return;
13633: }
13634: }
1.1317 raeburn 13635: if (open(my $fh,'<',$container)) {
1.987 raeburn 13636: $content = join('', <$fh>);
13637: close($fh);
13638: } else {
1.1071 raeburn 13639: if (wantarray) {
13640: return ('',0,0);
13641: } else {
13642: return;
13643: }
1.987 raeburn 13644: }
13645: }
13646: my ($count,$codebasecount) = (0,0);
13647: my $mm = new File::MMagic;
13648: my $mime_type = $mm->checktype_contents($content);
13649: if ($mime_type eq 'text/html') {
13650: my $parse_result =
13651: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13652: \%codebase,\$content);
13653: if ($parse_result eq 'ok') {
13654: foreach my $i (@changes) {
13655: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13656: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13657: if ($allfiles{$ref}) {
13658: my $newname = $orig;
13659: my ($attrib_regexp,$codebase);
1.1006 raeburn 13660: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13661: if ($attrib_regexp =~ /:/) {
13662: $attrib_regexp =~ s/\:/|/g;
13663: }
13664: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13665: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13666: $count += $numchg;
1.1123 raeburn 13667: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13668: delete($allfiles{$ref});
1.987 raeburn 13669: }
13670: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13671: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13672: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13673: $codebasecount ++;
13674: }
13675: }
13676: }
1.1123 raeburn 13677: my $skiprewrites;
1.987 raeburn 13678: if ($count || $codebasecount) {
13679: my $saveresult;
1.1071 raeburn 13680: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13681: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13682: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13683: if ($url eq $container) {
13684: my ($fname) = ($container =~ m{/([^/]+)$});
13685: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13686: $count,'<span class="LC_filename">'.
1.1071 raeburn 13687: $fname.'</span>').'</p>';
1.987 raeburn 13688: } else {
13689: $output = '<p class="LC_error">'.
13690: &mt('Error: update failed for: [_1].',
13691: '<span class="LC_filename">'.
13692: $container.'</span>').'</p>';
13693: }
1.1123 raeburn 13694: if ($context eq 'syllabus') {
13695: unless ($saveresult eq 'ok') {
13696: $skiprewrites = 1;
13697: }
13698: }
1.987 raeburn 13699: } else {
1.1317 raeburn 13700: if (open(my $fh,'>',$container)) {
1.987 raeburn 13701: print $fh $content;
13702: close($fh);
13703: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13704: $count,'<span class="LC_filename">'.
13705: $container.'</span>').'</p>';
1.661 raeburn 13706: } else {
1.987 raeburn 13707: $output = '<p class="LC_error">'.
13708: &mt('Error: could not update [_1].',
13709: '<span class="LC_filename">'.
13710: $container.'</span>').'</p>';
1.661 raeburn 13711: }
13712: }
13713: }
1.1123 raeburn 13714: if (($context eq 'syllabus') && (!$skiprewrites)) {
13715: my ($actionurl,$state);
13716: $actionurl = "/public/$udom/$uname/syllabus";
13717: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13718: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13719: \%codebase,
13720: {'context' => 'rewrites',
13721: 'ignore_remote_references' => 1,});
13722: if (ref($mapping) eq 'HASH') {
13723: my $rewrites = 0;
13724: foreach my $key (keys(%{$mapping})) {
13725: next if ($key =~ m{^https?://});
13726: my $ref = $mapping->{$key};
13727: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13728: my $attrib;
13729: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13730: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13731: }
13732: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13733: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13734: $rewrites += $numchg;
13735: }
13736: }
13737: if ($rewrites) {
13738: my $saveresult;
13739: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13740: if ($url eq $container) {
13741: my ($fname) = ($container =~ m{/([^/]+)$});
13742: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13743: $count,'<span class="LC_filename">'.
13744: $fname.'</span>').'</p>';
13745: } else {
13746: $output .= '<p class="LC_error">'.
13747: &mt('Error: could not update links in [_1].',
13748: '<span class="LC_filename">'.
13749: $container.'</span>').'</p>';
13750:
13751: }
13752: }
13753: }
13754: }
1.987 raeburn 13755: } else {
13756: &logthis('Failed to parse '.$container.
13757: ' to modify references: '.$parse_result);
1.661 raeburn 13758: }
13759: }
1.1071 raeburn 13760: if (wantarray) {
13761: return ($output,$count,$codebasecount);
13762: } else {
13763: return $output;
13764: }
1.661 raeburn 13765: }
13766:
13767: sub check_for_existing {
13768: my ($path,$fname,$element) = @_;
13769: my ($state,$msg);
13770: if (-d $path.'/'.$fname) {
13771: $state = 'exists';
13772: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13773: } elsif (-e $path.'/'.$fname) {
13774: $state = 'exists';
13775: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13776: }
13777: if ($state eq 'exists') {
13778: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13779: }
13780: return ($state,$msg);
13781: }
13782:
13783: sub check_for_upload {
13784: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13785: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13786: my $filesize = length($env{'form.'.$element});
13787: if (!$filesize) {
13788: my $msg = '<span class="LC_error">'.
13789: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13790: '<span class="LC_filename">'.$fname.'</span>',
13791: $filesize).'<br />'.
1.1007 raeburn 13792: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13793: '</span>';
13794: return ('zero_bytes',$msg);
13795: }
13796: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13797: my $getpropath = 1;
1.1021 raeburn 13798: my ($dirlistref,$listerror) =
13799: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13800: my $found_file = 0;
13801: my $locked_file = 0;
1.991 raeburn 13802: my @lockers;
13803: my $navmap;
13804: if ($env{'request.course.id'}) {
13805: $navmap = Apache::lonnavmaps::navmap->new();
13806: }
1.1021 raeburn 13807: if (ref($dirlistref) eq 'ARRAY') {
13808: foreach my $line (@{$dirlistref}) {
13809: my ($file_name,$rest)=split(/\&/,$line,2);
13810: if ($file_name eq $fname){
13811: $file_name = $path.$file_name;
13812: if ($group ne '') {
13813: $file_name = $group.$file_name;
13814: }
13815: $found_file = 1;
13816: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13817: foreach my $lock (@lockers) {
13818: if (ref($lock) eq 'ARRAY') {
13819: my ($symb,$crsid) = @{$lock};
13820: if ($crsid eq $env{'request.course.id'}) {
13821: if (ref($navmap)) {
13822: my $res = $navmap->getBySymb($symb);
13823: foreach my $part (@{$res->parts()}) {
13824: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13825: unless (($slot_status == $res->RESERVED) ||
13826: ($slot_status == $res->RESERVED_LOCATION)) {
13827: $locked_file = 1;
13828: }
1.991 raeburn 13829: }
1.1021 raeburn 13830: } else {
13831: $locked_file = 1;
1.991 raeburn 13832: }
13833: } else {
13834: $locked_file = 1;
13835: }
13836: }
1.1021 raeburn 13837: }
13838: } else {
13839: my @info = split(/\&/,$rest);
13840: my $currsize = $info[6]/1000;
13841: if ($currsize < $filesize) {
13842: my $extra = $filesize - $currsize;
13843: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13844: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13845: &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 13846: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13847: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13848: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13849: return ('will_exceed_quota',$msg);
13850: }
1.984 raeburn 13851: }
13852: }
1.661 raeburn 13853: }
13854: }
13855: }
13856: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13857: my $msg = '<p class="LC_warning">'.
13858: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13859: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13860: return ('will_exceed_quota',$msg);
13861: } elsif ($found_file) {
13862: if ($locked_file) {
1.1179 bisitz 13863: my $msg = '<p class="LC_warning">';
1.661 raeburn 13864: $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 13865: $msg .= '</p>';
1.661 raeburn 13866: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13867: return ('file_locked',$msg);
13868: } else {
1.1179 bisitz 13869: my $msg = '<p class="LC_error">';
1.984 raeburn 13870: $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 13871: $msg .= '</p>';
1.984 raeburn 13872: return ('existingfile',$msg);
1.661 raeburn 13873: }
13874: }
13875: }
13876:
1.987 raeburn 13877: sub check_for_traversal {
13878: my ($path,$url,$toplevel) = @_;
13879: my @parts=split(/\//,$path);
13880: my $cleanpath;
13881: my $fullpath = $url;
13882: for (my $i=0;$i<@parts;$i++) {
13883: next if ($parts[$i] eq '.');
13884: if ($parts[$i] eq '..') {
13885: $fullpath =~ s{([^/]+/)$}{};
13886: } else {
13887: $fullpath .= $parts[$i].'/';
13888: }
13889: }
13890: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13891: $cleanpath = $1;
13892: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13893: my $curr_toprel = $1;
13894: my @parts = split(/\//,$curr_toprel);
13895: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13896: my @urlparts = split(/\//,$url_toprel);
13897: my $doubledots;
13898: my $startdiff = -1;
13899: for (my $i=0; $i<@urlparts; $i++) {
13900: if ($startdiff == -1) {
13901: unless ($urlparts[$i] eq $parts[$i]) {
13902: $startdiff = $i;
13903: $doubledots .= '../';
13904: }
13905: } else {
13906: $doubledots .= '../';
13907: }
13908: }
13909: if ($startdiff > -1) {
13910: $cleanpath = $doubledots;
13911: for (my $i=$startdiff; $i<@parts; $i++) {
13912: $cleanpath .= $parts[$i].'/';
13913: }
13914: }
13915: }
13916: $cleanpath =~ s{(/)$}{};
13917: return $cleanpath;
13918: }
1.31 albertel 13919:
1.1053 raeburn 13920: sub is_archive_file {
13921: my ($mimetype) = @_;
13922: if (($mimetype eq 'application/octet-stream') ||
13923: ($mimetype eq 'application/x-stuffit') ||
13924: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13925: return 1;
13926: }
13927: return;
13928: }
13929:
13930: sub decompress_form {
1.1065 raeburn 13931: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13932: my %lt = &Apache::lonlocal::texthash (
13933: this => 'This file is an archive file.',
1.1067 raeburn 13934: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13935: itsc => 'Its contents are as follows:',
1.1053 raeburn 13936: youm => 'You may wish to extract its contents.',
13937: extr => 'Extract contents',
1.1067 raeburn 13938: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13939: proa => 'Process automatically?',
1.1053 raeburn 13940: yes => 'Yes',
13941: no => 'No',
1.1067 raeburn 13942: fold => 'Title for folder containing movie',
13943: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13944: );
1.1065 raeburn 13945: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13946: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13947: my $info = &list_archive_contents($fileloc,\@paths);
13948: if (@paths) {
13949: foreach my $path (@paths) {
13950: $path =~ s{^/}{};
1.1067 raeburn 13951: if ($path =~ m{^([^/]+)/$}) {
13952: $topdir = $1;
13953: }
1.1065 raeburn 13954: if ($path =~ m{^([^/]+)/}) {
13955: $toplevel{$1} = $path;
13956: } else {
13957: $toplevel{$path} = $path;
13958: }
13959: }
13960: }
1.1067 raeburn 13961: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13962: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13963: "$topdir/media/",
13964: "$topdir/media/$topdir.mp4",
13965: "$topdir/media/FirstFrame.png",
13966: "$topdir/media/player.swf",
13967: "$topdir/media/swfobject.js",
13968: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13969: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13970: "$topdir/$topdir.mp4",
13971: "$topdir/$topdir\_config.xml",
13972: "$topdir/$topdir\_controller.swf",
13973: "$topdir/$topdir\_embed.css",
13974: "$topdir/$topdir\_First_Frame.png",
13975: "$topdir/$topdir\_player.html",
13976: "$topdir/$topdir\_Thumbnails.png",
13977: "$topdir/playerProductInstall.swf",
13978: "$topdir/scripts/",
13979: "$topdir/scripts/config_xml.js",
13980: "$topdir/scripts/handlebars.js",
13981: "$topdir/scripts/jquery-1.7.1.min.js",
13982: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13983: "$topdir/scripts/modernizr.js",
13984: "$topdir/scripts/player-min.js",
13985: "$topdir/scripts/swfobject.js",
13986: "$topdir/skins/",
13987: "$topdir/skins/configuration_express.xml",
13988: "$topdir/skins/express_show/",
13989: "$topdir/skins/express_show/player-min.css",
13990: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13991: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13992: "$topdir/$topdir.mp4",
13993: "$topdir/$topdir\_config.xml",
13994: "$topdir/$topdir\_controller.swf",
13995: "$topdir/$topdir\_embed.css",
13996: "$topdir/$topdir\_First_Frame.png",
13997: "$topdir/$topdir\_player.html",
13998: "$topdir/$topdir\_Thumbnails.png",
13999: "$topdir/playerProductInstall.swf",
14000: "$topdir/scripts/",
14001: "$topdir/scripts/config_xml.js",
14002: "$topdir/scripts/techsmith-smart-player.min.js",
14003: "$topdir/skins/",
14004: "$topdir/skins/configuration_express.xml",
14005: "$topdir/skins/express_show/",
14006: "$topdir/skins/express_show/spritesheet.min.css",
14007: "$topdir/skins/express_show/spritesheet.png",
14008: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 14009: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 14010: if (@diffs == 0) {
1.1164 raeburn 14011: $is_camtasia = 6;
14012: } else {
1.1197 raeburn 14013: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 14014: if (@diffs == 0) {
14015: $is_camtasia = 8;
1.1197 raeburn 14016: } else {
14017: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14018: if (@diffs == 0) {
14019: $is_camtasia = 8;
14020: }
1.1164 raeburn 14021: }
1.1067 raeburn 14022: }
14023: }
14024: my $output;
14025: if ($is_camtasia) {
14026: $output = <<"ENDCAM";
14027: <script type="text/javascript" language="Javascript">
14028: // <![CDATA[
14029:
14030: function camtasiaToggle() {
14031: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14032: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14033: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14034: document.getElementById('camtasia_titles').style.display='block';
14035: } else {
14036: document.getElementById('camtasia_titles').style.display='none';
14037: }
14038: }
14039: }
14040: return;
14041: }
14042:
14043: // ]]>
14044: </script>
14045: <p>$lt{'camt'}</p>
14046: ENDCAM
1.1065 raeburn 14047: } else {
1.1067 raeburn 14048: $output = '<p>'.$lt{'this'};
14049: if ($info eq '') {
14050: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14051: } else {
14052: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14053: '<div><pre>'.$info.'</pre></div>';
14054: }
1.1065 raeburn 14055: }
1.1067 raeburn 14056: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14057: my $duplicates;
14058: my $num = 0;
14059: if (ref($dirlist) eq 'ARRAY') {
14060: foreach my $item (@{$dirlist}) {
14061: if (ref($item) eq 'ARRAY') {
14062: if (exists($toplevel{$item->[0]})) {
14063: $duplicates .=
14064: &start_data_table_row().
14065: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14066: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14067: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14068: 'value="1" />'.&mt('Yes').'</label>'.
14069: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14070: '<td>'.$item->[0].'</td>';
14071: if ($item->[2]) {
14072: $duplicates .= '<td>'.&mt('Directory').'</td>';
14073: } else {
14074: $duplicates .= '<td>'.&mt('File').'</td>';
14075: }
14076: $duplicates .= '<td>'.$item->[3].'</td>'.
14077: '<td>'.
14078: &Apache::lonlocal::locallocaltime($item->[4]).
14079: '</td>'.
14080: &end_data_table_row();
14081: $num ++;
14082: }
14083: }
14084: }
14085: }
14086: my $itemcount;
14087: if (@paths > 0) {
14088: $itemcount = scalar(@paths);
14089: } else {
14090: $itemcount = 1;
14091: }
1.1067 raeburn 14092: if ($is_camtasia) {
14093: $output .= $lt{'auto'}.'<br />'.
14094: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14095: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14096: $lt{'yes'}.'</label> <label>'.
14097: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14098: $lt{'no'}.'</label></span><br />'.
14099: '<div id="camtasia_titles" style="display:block">'.
14100: &Apache::lonhtmlcommon::start_pick_box().
14101: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14102: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14103: &Apache::lonhtmlcommon::row_closure().
14104: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14105: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14106: &Apache::lonhtmlcommon::row_closure(1).
14107: &Apache::lonhtmlcommon::end_pick_box().
14108: '</div>';
14109: }
1.1065 raeburn 14110: $output .=
14111: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14112: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14113: "\n";
1.1065 raeburn 14114: if ($duplicates ne '') {
14115: $output .= '<p><span class="LC_warning">'.
14116: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14117: &start_data_table().
14118: &start_data_table_header_row().
14119: '<th>'.&mt('Overwrite?').'</th>'.
14120: '<th>'.&mt('Name').'</th>'.
14121: '<th>'.&mt('Type').'</th>'.
14122: '<th>'.&mt('Size').'</th>'.
14123: '<th>'.&mt('Last modified').'</th>'.
14124: &end_data_table_header_row().
14125: $duplicates.
14126: &end_data_table().
14127: '</p>';
14128: }
1.1067 raeburn 14129: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14130: if (ref($hiddenelements) eq 'HASH') {
14131: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14132: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14133: }
14134: }
14135: $output .= <<"END";
1.1067 raeburn 14136: <br />
1.1053 raeburn 14137: <input type="submit" name="decompress" value="$lt{'extr'}" />
14138: </form>
14139: $noextract
14140: END
14141: return $output;
14142: }
14143:
1.1065 raeburn 14144: sub decompression_utility {
14145: my ($program) = @_;
14146: my @utilities = ('tar','gunzip','bunzip2','unzip');
14147: my $location;
14148: if (grep(/^\Q$program\E$/,@utilities)) {
14149: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14150: '/usr/sbin/') {
14151: if (-x $dir.$program) {
14152: $location = $dir.$program;
14153: last;
14154: }
14155: }
14156: }
14157: return $location;
14158: }
14159:
14160: sub list_archive_contents {
14161: my ($file,$pathsref) = @_;
14162: my (@cmd,$output);
14163: my $needsregexp;
14164: if ($file =~ /\.zip$/) {
14165: @cmd = (&decompression_utility('unzip'),"-l");
14166: $needsregexp = 1;
14167: } elsif (($file =~ m/\.tar\.gz$/) ||
14168: ($file =~ /\.tgz$/)) {
14169: @cmd = (&decompression_utility('tar'),"-ztf");
14170: } elsif ($file =~ /\.tar\.bz2$/) {
14171: @cmd = (&decompression_utility('tar'),"-jtf");
14172: } elsif ($file =~ m|\.tar$|) {
14173: @cmd = (&decompression_utility('tar'),"-tf");
14174: }
14175: if (@cmd) {
14176: undef($!);
14177: undef($@);
14178: if (open(my $fh,"-|", @cmd, $file)) {
14179: while (my $line = <$fh>) {
14180: $output .= $line;
14181: chomp($line);
14182: my $item;
14183: if ($needsregexp) {
14184: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14185: } else {
14186: $item = $line;
14187: }
14188: if ($item ne '') {
14189: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14190: push(@{$pathsref},$item);
14191: }
14192: }
14193: }
14194: close($fh);
14195: }
14196: }
14197: return $output;
14198: }
14199:
1.1053 raeburn 14200: sub decompress_uploaded_file {
14201: my ($file,$dir) = @_;
14202: &Apache::lonnet::appenv({'cgi.file' => $file});
14203: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14204: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14205: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14206: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14207: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14208: my $decompressed = $env{'cgi.decompressed'};
14209: &Apache::lonnet::delenv('cgi.file');
14210: &Apache::lonnet::delenv('cgi.dir');
14211: &Apache::lonnet::delenv('cgi.decompressed');
14212: return ($decompressed,$result);
14213: }
14214:
1.1055 raeburn 14215: sub process_decompression {
14216: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14217: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14218: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14219: &mt('Unexpected file path.').'</p>'."\n";
14220: }
14221: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14222: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14223: &mt('Unexpected course context.').'</p>'."\n";
14224: }
1.1293 raeburn 14225: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14226: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14227: &mt('Filename contained unexpected characters.').'</p>'."\n";
14228: }
1.1055 raeburn 14229: my ($dir,$error,$warning,$output);
1.1180 raeburn 14230: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14231: $error = &mt('Filename not a supported archive file type.').
14232: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14233: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14234: } else {
14235: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14236: if ($docuhome eq 'no_host') {
14237: $error = &mt('Could not determine home server for course.');
14238: } else {
14239: my @ids=&Apache::lonnet::current_machine_ids();
14240: my $currdir = "$dir_root/$destination";
14241: if (grep(/^\Q$docuhome\E$/,@ids)) {
14242: $dir = &LONCAPA::propath($docudom,$docuname).
14243: "$dir_root/$destination";
14244: } else {
14245: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14246: "$dir_root/$docudom/$docuname/$destination";
14247: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14248: $error = &mt('Archive file not found.');
14249: }
14250: }
1.1065 raeburn 14251: my (@to_overwrite,@to_skip);
14252: if ($env{'form.archive_overwrite_total'} > 0) {
14253: my $total = $env{'form.archive_overwrite_total'};
14254: for (my $i=0; $i<$total; $i++) {
14255: if ($env{'form.archive_overwrite_'.$i} == 1) {
14256: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14257: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14258: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14259: }
14260: }
14261: }
14262: my $numskip = scalar(@to_skip);
1.1292 raeburn 14263: my $numoverwrite = scalar(@to_overwrite);
14264: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14265: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14266: } elsif ($dir eq '') {
1.1055 raeburn 14267: $error = &mt('Directory containing archive file unavailable.');
14268: } elsif (!$error) {
1.1065 raeburn 14269: my ($decompressed,$display);
1.1292 raeburn 14270: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14271: my $tempdir = time.'_'.$$.int(rand(10000));
14272: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14273: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14274: ($decompressed,$display) =
14275: &decompress_uploaded_file($file,"$dir/$tempdir");
14276: foreach my $item (@to_skip) {
14277: if (($item ne '') && ($item !~ /\.\./)) {
14278: if (-f "$dir/$tempdir/$item") {
14279: unlink("$dir/$tempdir/$item");
14280: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14281: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14282: }
14283: }
14284: }
14285: foreach my $item (@to_overwrite) {
14286: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14287: if (($item ne '') && ($item !~ /\.\./)) {
14288: if (-f "$dir/$item") {
14289: unlink("$dir/$item");
14290: } elsif (-d "$dir/$item") {
1.1300 raeburn 14291: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14292: }
14293: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14294: }
1.1065 raeburn 14295: }
14296: }
1.1292 raeburn 14297: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14298: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14299: }
1.1065 raeburn 14300: }
14301: } else {
14302: ($decompressed,$display) =
14303: &decompress_uploaded_file($file,$dir);
14304: }
1.1055 raeburn 14305: if ($decompressed eq 'ok') {
1.1065 raeburn 14306: $output = '<p class="LC_info">'.
14307: &mt('Files extracted successfully from archive.').
14308: '</p>'."\n";
1.1055 raeburn 14309: my ($warning,$result,@contents);
14310: my ($newdirlistref,$newlisterror) =
14311: &Apache::lonnet::dirlist($currdir,$docudom,
14312: $docuname,1);
14313: my (%is_dir,%changes,@newitems);
14314: my $dirptr = 16384;
1.1065 raeburn 14315: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14316: foreach my $dir_line (@{$newdirlistref}) {
14317: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14318: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14319: push(@newitems,$item);
14320: if ($dirptr&$testdir) {
14321: $is_dir{$item} = 1;
14322: }
14323: $changes{$item} = 1;
14324: }
14325: }
14326: }
14327: if (keys(%changes) > 0) {
14328: foreach my $item (sort(@newitems)) {
14329: if ($changes{$item}) {
14330: push(@contents,$item);
14331: }
14332: }
14333: }
14334: if (@contents > 0) {
1.1067 raeburn 14335: my $wantform;
14336: unless ($env{'form.autoextract_camtasia'}) {
14337: $wantform = 1;
14338: }
1.1056 raeburn 14339: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14340: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14341: $currdir,\%is_dir,
14342: \%children,\%parent,
1.1056 raeburn 14343: \@contents,\%dirorder,
14344: \%titles,$wantform);
1.1055 raeburn 14345: if ($datatable ne '') {
14346: $output .= &archive_options_form('decompressed',$datatable,
14347: $count,$hiddenelem);
1.1065 raeburn 14348: my $startcount = 6;
1.1055 raeburn 14349: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14350: \%titles,\%children);
1.1055 raeburn 14351: }
1.1067 raeburn 14352: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14353: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14354: my %displayed;
14355: my $total = 1;
14356: $env{'form.archive_directory'} = [];
14357: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14358: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14359: $path =~ s{/$}{};
14360: my $item;
14361: if ($path ne '') {
14362: $item = "$path/$titles{$i}";
14363: } else {
14364: $item = $titles{$i};
14365: }
14366: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14367: if ($item eq $contents[0]) {
14368: push(@{$env{'form.archive_directory'}},$i);
14369: $env{'form.archive_'.$i} = 'display';
14370: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14371: $displayed{'folder'} = $i;
1.1164 raeburn 14372: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14373: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14374: $env{'form.archive_'.$i} = 'display';
14375: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14376: $displayed{'web'} = $i;
14377: } else {
1.1164 raeburn 14378: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14379: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14380: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14381: push(@{$env{'form.archive_directory'}},$i);
14382: }
14383: $env{'form.archive_'.$i} = 'dependency';
14384: }
14385: $total ++;
14386: }
14387: for (my $i=1; $i<$total; $i++) {
14388: next if ($i == $displayed{'web'});
14389: next if ($i == $displayed{'folder'});
14390: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14391: }
14392: $env{'form.phase'} = 'decompress_cleanup';
14393: $env{'form.archivedelete'} = 1;
14394: $env{'form.archive_count'} = $total-1;
14395: $output .=
14396: &process_extracted_files('coursedocs',$docudom,
14397: $docuname,$destination,
14398: $dir_root,$hiddenelem);
14399: }
1.1055 raeburn 14400: } else {
14401: $warning = &mt('No new items extracted from archive file.');
14402: }
14403: } else {
14404: $output = $display;
14405: $error = &mt('An error occurred during extraction from the archive file.');
14406: }
14407: }
14408: }
14409: }
14410: if ($error) {
14411: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14412: $error.'</p>'."\n";
14413: }
14414: if ($warning) {
14415: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14416: }
14417: return $output;
14418: }
14419:
14420: sub get_extracted {
1.1056 raeburn 14421: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14422: $titles,$wantform) = @_;
1.1055 raeburn 14423: my $count = 0;
14424: my $depth = 0;
14425: my $datatable;
1.1056 raeburn 14426: my @hierarchy;
1.1055 raeburn 14427: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14428: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14429: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14430: foreach my $item (@{$contents}) {
14431: $count ++;
1.1056 raeburn 14432: @{$dirorder->{$count}} = @hierarchy;
14433: $titles->{$count} = $item;
1.1055 raeburn 14434: &archive_hierarchy($depth,$count,$parent,$children);
14435: if ($wantform) {
14436: $datatable .= &archive_row($is_dir->{$item},$item,
14437: $currdir,$depth,$count);
14438: }
14439: if ($is_dir->{$item}) {
14440: $depth ++;
1.1056 raeburn 14441: push(@hierarchy,$count);
14442: $parent->{$depth} = $count;
1.1055 raeburn 14443: $datatable .=
14444: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14445: \$depth,\$count,\@hierarchy,$dirorder,
14446: $children,$parent,$titles,$wantform);
1.1055 raeburn 14447: $depth --;
1.1056 raeburn 14448: pop(@hierarchy);
1.1055 raeburn 14449: }
14450: }
14451: return ($count,$datatable);
14452: }
14453:
14454: sub recurse_extracted_archive {
1.1056 raeburn 14455: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14456: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14457: my $result='';
1.1056 raeburn 14458: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14459: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14460: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14461: return $result;
14462: }
14463: my $dirptr = 16384;
14464: my ($newdirlistref,$newlisterror) =
14465: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14466: if (ref($newdirlistref) eq 'ARRAY') {
14467: foreach my $dir_line (@{$newdirlistref}) {
14468: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14469: unless ($item =~ /^\.+$/) {
14470: $$count ++;
1.1056 raeburn 14471: @{$dirorder->{$$count}} = @{$hierarchy};
14472: $titles->{$$count} = $item;
1.1055 raeburn 14473: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14474:
1.1055 raeburn 14475: my $is_dir;
14476: if ($dirptr&$testdir) {
14477: $is_dir = 1;
14478: }
14479: if ($wantform) {
14480: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14481: }
14482: if ($is_dir) {
14483: $$depth ++;
1.1056 raeburn 14484: push(@{$hierarchy},$$count);
14485: $parent->{$$depth} = $$count;
1.1055 raeburn 14486: $result .=
14487: &recurse_extracted_archive("$currdir/$item",$docudom,
14488: $docuname,$depth,$count,
1.1056 raeburn 14489: $hierarchy,$dirorder,$children,
14490: $parent,$titles,$wantform);
1.1055 raeburn 14491: $$depth --;
1.1056 raeburn 14492: pop(@{$hierarchy});
1.1055 raeburn 14493: }
14494: }
14495: }
14496: }
14497: return $result;
14498: }
14499:
14500: sub archive_hierarchy {
14501: my ($depth,$count,$parent,$children) =@_;
14502: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14503: if (exists($parent->{$depth})) {
14504: $children->{$parent->{$depth}} .= $count.':';
14505: }
14506: }
14507: return;
14508: }
14509:
14510: sub archive_row {
14511: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14512: my ($name) = ($item =~ m{([^/]+)$});
14513: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14514: 'display' => 'Add as file',
1.1055 raeburn 14515: 'dependency' => 'Include as dependency',
14516: 'discard' => 'Discard',
14517: );
14518: if ($is_dir) {
1.1059 raeburn 14519: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14520: }
1.1056 raeburn 14521: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14522: my $offset = 0;
1.1055 raeburn 14523: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14524: $offset ++;
1.1065 raeburn 14525: if ($action ne 'display') {
14526: $offset ++;
14527: }
1.1055 raeburn 14528: $output .= '<td><span class="LC_nobreak">'.
14529: '<label><input type="radio" name="archive_'.$count.
14530: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14531: my $text = $choices{$action};
14532: if ($is_dir) {
14533: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14534: if ($action eq 'display') {
1.1059 raeburn 14535: $text = &mt('Add as folder');
1.1055 raeburn 14536: }
1.1056 raeburn 14537: } else {
14538: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14539:
14540: }
14541: $output .= ' /> '.$choices{$action}.'</label></span>';
14542: if ($action eq 'dependency') {
14543: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14544: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14545: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14546: '<option value=""></option>'."\n".
14547: '</select>'."\n".
14548: '</div>';
1.1059 raeburn 14549: } elsif ($action eq 'display') {
14550: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14551: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14552: '</div>';
1.1055 raeburn 14553: }
1.1056 raeburn 14554: $output .= '</td>';
1.1055 raeburn 14555: }
14556: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14557: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14558: for (my $i=0; $i<$depth; $i++) {
14559: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14560: }
14561: if ($is_dir) {
14562: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14563: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14564: } else {
14565: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14566: }
14567: $output .= ' '.$name.'</td>'."\n".
14568: &end_data_table_row();
14569: return $output;
14570: }
14571:
14572: sub archive_options_form {
1.1065 raeburn 14573: my ($form,$display,$count,$hiddenelem) = @_;
14574: my %lt = &Apache::lonlocal::texthash(
14575: perm => 'Permanently remove archive file?',
14576: hows => 'How should each extracted item be incorporated in the course?',
14577: cont => 'Content actions for all',
14578: addf => 'Add as folder/file',
14579: incd => 'Include as dependency for a displayed file',
14580: disc => 'Discard',
14581: no => 'No',
14582: yes => 'Yes',
14583: save => 'Save',
14584: );
14585: my $output = <<"END";
14586: <form name="$form" method="post" action="">
14587: <p><span class="LC_nobreak">$lt{'perm'}
14588: <label>
14589: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14590: </label>
14591:
14592: <label>
14593: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14594: </span>
14595: </p>
14596: <input type="hidden" name="phase" value="decompress_cleanup" />
14597: <br />$lt{'hows'}
14598: <div class="LC_columnSection">
14599: <fieldset>
14600: <legend>$lt{'cont'}</legend>
14601: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14602: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14603: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14604: </fieldset>
14605: </div>
14606: END
14607: return $output.
1.1055 raeburn 14608: &start_data_table()."\n".
1.1065 raeburn 14609: $display."\n".
1.1055 raeburn 14610: &end_data_table()."\n".
14611: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14612: $hiddenelem.
1.1065 raeburn 14613: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14614: '</form>';
14615: }
14616:
14617: sub archive_javascript {
1.1056 raeburn 14618: my ($startcount,$numitems,$titles,$children) = @_;
14619: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14620: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14621: my $scripttag = <<START;
14622: <script type="text/javascript">
14623: // <![CDATA[
14624:
14625: function checkAll(form,prefix) {
14626: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14627: for (var i=0; i < form.elements.length; i++) {
14628: var id = form.elements[i].id;
14629: if ((id != '') && (id != undefined)) {
14630: if (idstr.test(id)) {
14631: if (form.elements[i].type == 'radio') {
14632: form.elements[i].checked = true;
1.1056 raeburn 14633: var nostart = i-$startcount;
1.1059 raeburn 14634: var offset = nostart%7;
14635: var count = (nostart-offset)/7;
1.1056 raeburn 14636: dependencyCheck(form,count,offset);
1.1055 raeburn 14637: }
14638: }
14639: }
14640: }
14641: }
14642:
14643: function propagateCheck(form,count) {
14644: if (count > 0) {
1.1059 raeburn 14645: var startelement = $startcount + ((count-1) * 7);
14646: for (var j=1; j<6; j++) {
14647: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14648: var item = startelement + j;
14649: if (form.elements[item].type == 'radio') {
14650: if (form.elements[item].checked) {
14651: containerCheck(form,count,j);
14652: break;
14653: }
1.1055 raeburn 14654: }
14655: }
14656: }
14657: }
14658: }
14659:
14660: numitems = $numitems
1.1056 raeburn 14661: var titles = new Array(numitems);
14662: var parents = new Array(numitems);
1.1055 raeburn 14663: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14664: parents[i] = new Array;
1.1055 raeburn 14665: }
1.1059 raeburn 14666: var maintitle = '$maintitle';
1.1055 raeburn 14667:
14668: START
14669:
1.1056 raeburn 14670: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14671: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14672: for (my $i=0; $i<@contents; $i ++) {
14673: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14674: }
14675: }
14676:
1.1056 raeburn 14677: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14678: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14679: }
14680:
1.1055 raeburn 14681: $scripttag .= <<END;
14682:
14683: function containerCheck(form,count,offset) {
14684: if (count > 0) {
1.1056 raeburn 14685: dependencyCheck(form,count,offset);
1.1059 raeburn 14686: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14687: form.elements[item].checked = true;
14688: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14689: if (parents[count].length > 0) {
14690: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14691: containerCheck(form,parents[count][j],offset);
14692: }
14693: }
14694: }
14695: }
14696: }
14697:
14698: function dependencyCheck(form,count,offset) {
14699: if (count > 0) {
1.1059 raeburn 14700: var chosen = (offset+$startcount)+7*(count-1);
14701: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14702: var currtype = form.elements[depitem].type;
14703: if (form.elements[chosen].value == 'dependency') {
14704: document.getElementById('arc_depon_'+count).style.display='block';
14705: form.elements[depitem].options.length = 0;
14706: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14707: for (var i=1; i<=numitems; i++) {
14708: if (i == count) {
14709: continue;
14710: }
1.1059 raeburn 14711: var startelement = $startcount + (i-1) * 7;
14712: for (var j=1; j<6; j++) {
14713: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14714: var item = startelement + j;
14715: if (form.elements[item].type == 'radio') {
14716: if (form.elements[item].checked) {
14717: if (form.elements[item].value == 'display') {
14718: var n = form.elements[depitem].options.length;
14719: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14720: }
14721: }
14722: }
14723: }
14724: }
14725: }
14726: } else {
14727: document.getElementById('arc_depon_'+count).style.display='none';
14728: form.elements[depitem].options.length = 0;
14729: form.elements[depitem].options[0] = new Option('Select','',true,true);
14730: }
1.1059 raeburn 14731: titleCheck(form,count,offset);
1.1056 raeburn 14732: }
14733: }
14734:
14735: function propagateSelect(form,count,offset) {
14736: if (count > 0) {
1.1065 raeburn 14737: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14738: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14739: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14740: if (parents[count].length > 0) {
14741: for (var j=0; j<parents[count].length; j++) {
14742: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14743: }
14744: }
14745: }
14746: }
14747: }
1.1056 raeburn 14748:
14749: function containerSelect(form,count,offset,picked) {
14750: if (count > 0) {
1.1065 raeburn 14751: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14752: if (form.elements[item].type == 'radio') {
14753: if (form.elements[item].value == 'dependency') {
14754: if (form.elements[item+1].type == 'select-one') {
14755: for (var i=0; i<form.elements[item+1].options.length; i++) {
14756: if (form.elements[item+1].options[i].value == picked) {
14757: form.elements[item+1].selectedIndex = i;
14758: break;
14759: }
14760: }
14761: }
14762: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14763: if (parents[count].length > 0) {
14764: for (var j=0; j<parents[count].length; j++) {
14765: containerSelect(form,parents[count][j],offset,picked);
14766: }
14767: }
14768: }
14769: }
14770: }
14771: }
14772: }
14773:
1.1059 raeburn 14774: function titleCheck(form,count,offset) {
14775: if (count > 0) {
14776: var chosen = (offset+$startcount)+7*(count-1);
14777: var depitem = $startcount + ((count-1) * 7) + 2;
14778: var currtype = form.elements[depitem].type;
14779: if (form.elements[chosen].value == 'display') {
14780: document.getElementById('arc_title_'+count).style.display='block';
14781: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14782: document.getElementById('archive_title_'+count).value=maintitle;
14783: }
14784: } else {
14785: document.getElementById('arc_title_'+count).style.display='none';
14786: if (currtype == 'text') {
14787: document.getElementById('archive_title_'+count).value='';
14788: }
14789: }
14790: }
14791: return;
14792: }
14793:
1.1055 raeburn 14794: // ]]>
14795: </script>
14796: END
14797: return $scripttag;
14798: }
14799:
14800: sub process_extracted_files {
1.1067 raeburn 14801: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14802: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14803: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14804: my @ids=&Apache::lonnet::current_machine_ids();
14805: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14806: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14807: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14808: if (grep(/^\Q$docuhome\E$/,@ids)) {
14809: $prefix = &LONCAPA::propath($docudom,$docuname);
14810: $pathtocheck = "$dir_root/$destination";
14811: $dir = $dir_root;
14812: $ishome = 1;
14813: } else {
14814: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14815: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14816: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14817: }
14818: my $currdir = "$dir_root/$destination";
14819: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14820: if ($env{'form.folderpath'}) {
14821: my @items = split('&',$env{'form.folderpath'});
14822: $folders{'0'} = $items[-2];
1.1099 raeburn 14823: if ($env{'form.folderpath'} =~ /\:1$/) {
14824: $containers{'0'}='page';
14825: } else {
14826: $containers{'0'}='sequence';
14827: }
1.1055 raeburn 14828: }
14829: my @archdirs = &get_env_multiple('form.archive_directory');
14830: if ($numitems) {
14831: for (my $i=1; $i<=$numitems; $i++) {
14832: my $path = $env{'form.archive_content_'.$i};
14833: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14834: my $item = $1;
14835: $toplevelitems{$item} = $i;
14836: if (grep(/^\Q$i\E$/,@archdirs)) {
14837: $is_dir{$item} = 1;
14838: }
14839: }
14840: }
14841: }
1.1067 raeburn 14842: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14843: if (keys(%toplevelitems) > 0) {
14844: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14845: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14846: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14847: }
1.1066 raeburn 14848: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14849: if ($numitems) {
14850: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14851: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14852: my $path = $env{'form.archive_content_'.$i};
14853: if ($path =~ /^\Q$pathtocheck\E/) {
14854: if ($env{'form.archive_'.$i} eq 'discard') {
14855: if ($prefix ne '' && $path ne '') {
14856: if (-e $prefix.$path) {
1.1066 raeburn 14857: if ((@archdirs > 0) &&
14858: (grep(/^\Q$i\E$/,@archdirs))) {
14859: $todeletedir{$prefix.$path} = 1;
14860: } else {
14861: $todelete{$prefix.$path} = 1;
14862: }
1.1055 raeburn 14863: }
14864: }
14865: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14866: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14867: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14868: $docstitle = $env{'form.archive_title_'.$i};
14869: if ($docstitle eq '') {
14870: $docstitle = $title;
14871: }
1.1055 raeburn 14872: $outer = 0;
1.1056 raeburn 14873: if (ref($dirorder{$i}) eq 'ARRAY') {
14874: if (@{$dirorder{$i}} > 0) {
14875: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14876: if ($env{'form.archive_'.$item} eq 'display') {
14877: $outer = $item;
14878: last;
14879: }
14880: }
14881: }
14882: }
14883: my ($errtext,$fatal) =
14884: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14885: '/'.$folders{$outer}.'.'.
14886: $containers{$outer});
14887: next if ($fatal);
14888: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14889: if ($context eq 'coursedocs') {
1.1056 raeburn 14890: $mapinner{$i} = time;
1.1055 raeburn 14891: $folders{$i} = 'default_'.$mapinner{$i};
14892: $containers{$i} = 'sequence';
14893: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14894: $folders{$i}.'.'.$containers{$i};
14895: my $newidx = &LONCAPA::map::getresidx();
14896: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14897: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14898: push(@LONCAPA::map::order,$newidx);
14899: my ($outtext,$errtext) =
14900: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14901: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14902: '.'.$containers{$outer},1,1);
1.1056 raeburn 14903: $newseqid{$i} = $newidx;
1.1067 raeburn 14904: unless ($errtext) {
1.1294 raeburn 14905: $result .= '<li>'.&mt('Folder: [_1] added to course',
14906: &HTML::Entities::encode($docstitle,'<>&"')).
14907: '</li>'."\n";
1.1067 raeburn 14908: }
1.1055 raeburn 14909: }
14910: } else {
14911: if ($context eq 'coursedocs') {
14912: my $newidx=&LONCAPA::map::getresidx();
14913: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14914: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14915: $title;
1.1392 raeburn 14916: if (($outer !~ /\D/) &&
14917: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14918: ($newidx !~ /\D/)) {
1.1294 raeburn 14919: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14920: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14921: }
14922: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14923: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14924: }
14925: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14926: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14927: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14928: unless ($ishome) {
14929: my $fetch = "$newdest{$i}/$title";
14930: $fetch =~ s/^\Q$prefix$dir\E//;
14931: $prompttofetch{$fetch} = 1;
14932: }
1.1292 raeburn 14933: }
1.1067 raeburn 14934: }
1.1294 raeburn 14935: $LONCAPA::map::resources[$newidx]=
14936: $docstitle.':'.$url.':false:normal:res';
14937: push(@LONCAPA::map::order, $newidx);
14938: my ($outtext,$errtext)=
14939: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14940: $docuname.'/'.$folders{$outer}.
14941: '.'.$containers{$outer},1,1);
14942: unless ($errtext) {
14943: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14944: $result .= '<li>'.&mt('File: [_1] added to course',
14945: &HTML::Entities::encode($docstitle,'<>&"')).
14946: '</li>'."\n";
14947: }
1.1067 raeburn 14948: }
1.1294 raeburn 14949: } else {
14950: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14951: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14952: }
1.1055 raeburn 14953: }
14954: }
1.1086 raeburn 14955: }
14956: } else {
1.1294 raeburn 14957: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14958: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14959: }
14960: }
14961: for (my $i=1; $i<=$numitems; $i++) {
14962: next unless ($env{'form.archive_'.$i} eq 'dependency');
14963: my $path = $env{'form.archive_content_'.$i};
14964: if ($path =~ /^\Q$pathtocheck\E/) {
14965: my ($title) = ($path =~ m{/([^/]+)$});
14966: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14967: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14968: if (ref($dirorder{$i}) eq 'ARRAY') {
14969: my ($itemidx,$fullpath,$relpath);
14970: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14971: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14972: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14973: if ($dirorder{$i}->[$j] eq $container) {
14974: $itemidx = $j;
1.1056 raeburn 14975: }
14976: }
1.1086 raeburn 14977: }
14978: if ($itemidx eq '') {
14979: $itemidx = 0;
14980: }
14981: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14982: if ($mapinner{$referrer{$i}}) {
14983: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14984: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14985: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14986: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14987: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14988: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14989: if (!-e $fullpath) {
14990: mkdir($fullpath,0755);
1.1056 raeburn 14991: }
14992: }
1.1086 raeburn 14993: } else {
14994: last;
1.1056 raeburn 14995: }
1.1086 raeburn 14996: }
14997: }
14998: } elsif ($newdest{$referrer{$i}}) {
14999: $fullpath = $newdest{$referrer{$i}};
15000: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15001: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
15002: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
15003: last;
15004: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15005: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15006: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15007: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15008: if (!-e $fullpath) {
15009: mkdir($fullpath,0755);
1.1056 raeburn 15010: }
15011: }
1.1086 raeburn 15012: } else {
15013: last;
1.1056 raeburn 15014: }
1.1055 raeburn 15015: }
15016: }
1.1086 raeburn 15017: if ($fullpath ne '') {
15018: if (-e "$prefix$path") {
1.1292 raeburn 15019: unless (rename("$prefix$path","$fullpath/$title")) {
15020: $warning .= &mt('Failed to rename dependency').'<br />';
15021: }
1.1086 raeburn 15022: }
15023: if (-e "$fullpath/$title") {
15024: my $showpath;
15025: if ($relpath ne '') {
15026: $showpath = "$relpath/$title";
15027: } else {
15028: $showpath = "/$title";
15029: }
1.1294 raeburn 15030: $result .= '<li>'.&mt('[_1] included as a dependency',
15031: &HTML::Entities::encode($showpath,'<>&"')).
15032: '</li>'."\n";
1.1292 raeburn 15033: unless ($ishome) {
15034: my $fetch = "$fullpath/$title";
15035: $fetch =~ s/^\Q$prefix$dir\E//;
15036: $prompttofetch{$fetch} = 1;
15037: }
1.1086 raeburn 15038: }
15039: }
1.1055 raeburn 15040: }
1.1086 raeburn 15041: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15042: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15043: &HTML::Entities::encode($path,'<>&"'),
15044: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15045: '<br />';
1.1055 raeburn 15046: }
15047: } else {
1.1294 raeburn 15048: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15049: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15050: }
15051: }
15052: if (keys(%todelete)) {
15053: foreach my $key (keys(%todelete)) {
15054: unlink($key);
1.1066 raeburn 15055: }
15056: }
15057: if (keys(%todeletedir)) {
15058: foreach my $key (keys(%todeletedir)) {
15059: rmdir($key);
15060: }
15061: }
15062: foreach my $dir (sort(keys(%is_dir))) {
15063: if (($pathtocheck ne '') && ($dir ne '')) {
15064: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15065: }
15066: }
1.1067 raeburn 15067: if ($result ne '') {
15068: $output .= '<ul>'."\n".
15069: $result."\n".
15070: '</ul>';
15071: }
15072: unless ($ishome) {
15073: my $replicationfail;
15074: foreach my $item (keys(%prompttofetch)) {
15075: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15076: unless ($fetchresult eq 'ok') {
15077: $replicationfail .= '<li>'.$item.'</li>'."\n";
15078: }
15079: }
15080: if ($replicationfail) {
15081: $output .= '<p class="LC_error">'.
15082: &mt('Course home server failed to retrieve:').'<ul>'.
15083: $replicationfail.
15084: '</ul></p>';
15085: }
15086: }
1.1055 raeburn 15087: } else {
15088: $warning = &mt('No items found in archive.');
15089: }
15090: if ($error) {
15091: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15092: $error.'</p>'."\n";
15093: }
15094: if ($warning) {
15095: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15096: }
15097: return $output;
15098: }
15099:
1.1066 raeburn 15100: sub cleanup_empty_dirs {
15101: my ($path) = @_;
15102: if (($path ne '') && (-d $path)) {
15103: if (opendir(my $dirh,$path)) {
15104: my @dircontents = grep(!/^\./,readdir($dirh));
15105: my $numitems = 0;
15106: foreach my $item (@dircontents) {
15107: if (-d "$path/$item") {
1.1111 raeburn 15108: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15109: if (-e "$path/$item") {
15110: $numitems ++;
15111: }
15112: } else {
15113: $numitems ++;
15114: }
15115: }
15116: if ($numitems == 0) {
15117: rmdir($path);
15118: }
15119: closedir($dirh);
15120: }
15121: }
15122: return;
15123: }
15124:
1.41 ng 15125: =pod
1.45 matthew 15126:
1.1162 raeburn 15127: =item * &get_folder_hierarchy()
1.1068 raeburn 15128:
15129: Provides hierarchy of names of folders/sub-folders containing the current
15130: item,
15131:
15132: Inputs: 3
15133: - $navmap - navmaps object
15134:
15135: - $map - url for map (either the trigger itself, or map containing
15136: the resource, which is the trigger).
15137:
15138: - $showitem - 1 => show title for map itself; 0 => do not show.
15139:
15140: Outputs: 1 @pathitems - array of folder/subfolder names.
15141:
15142: =cut
15143:
15144: sub get_folder_hierarchy {
15145: my ($navmap,$map,$showitem) = @_;
15146: my @pathitems;
15147: if (ref($navmap)) {
15148: my $mapres = $navmap->getResourceByUrl($map);
15149: if (ref($mapres)) {
15150: my $pcslist = $mapres->map_hierarchy();
15151: if ($pcslist ne '') {
15152: my @pcs = split(/,/,$pcslist);
15153: foreach my $pc (@pcs) {
15154: if ($pc == 1) {
1.1129 raeburn 15155: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15156: } else {
15157: my $res = $navmap->getByMapPc($pc);
15158: if (ref($res)) {
15159: my $title = $res->compTitle();
15160: $title =~ s/\W+/_/g;
15161: if ($title ne '') {
15162: push(@pathitems,$title);
15163: }
15164: }
15165: }
15166: }
15167: }
1.1071 raeburn 15168: if ($showitem) {
15169: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15170: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15171: } else {
15172: my $maptitle = $mapres->compTitle();
15173: $maptitle =~ s/\W+/_/g;
15174: if ($maptitle ne '') {
15175: push(@pathitems,$maptitle);
15176: }
1.1068 raeburn 15177: }
15178: }
15179: }
15180: }
15181: return @pathitems;
15182: }
15183:
15184: =pod
15185:
1.1015 raeburn 15186: =item * &get_turnedin_filepath()
15187:
15188: Determines path in a user's portfolio file for storage of files uploaded
15189: to a specific essayresponse or dropbox item.
15190:
15191: Inputs: 3 required + 1 optional.
15192: $symb is symb for resource, $uname and $udom are for current user (required).
15193: $caller is optional (can be "submission", if routine is called when storing
15194: an upoaded file when "Submit Answer" button was pressed).
15195:
15196: Returns array containing $path and $multiresp.
15197: $path is path in portfolio. $multiresp is 1 if this resource contains more
15198: than one file upload item. Callers of routine should append partid as a
15199: subdirectory to $path in cases where $multiresp is 1.
15200:
15201: Called by: homework/essayresponse.pm and homework/structuretags.pm
15202:
15203: =cut
15204:
15205: sub get_turnedin_filepath {
15206: my ($symb,$uname,$udom,$caller) = @_;
15207: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15208: my $turnindir;
15209: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15210: $turnindir = $userhash{'turnindir'};
15211: my ($path,$multiresp);
15212: if ($turnindir eq '') {
15213: if ($caller eq 'submission') {
15214: $turnindir = &mt('turned in');
15215: $turnindir =~ s/\W+/_/g;
15216: my %newhash = (
15217: 'turnindir' => $turnindir,
15218: );
15219: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15220: }
15221: }
15222: if ($turnindir ne '') {
15223: $path = '/'.$turnindir.'/';
15224: my ($multipart,$turnin,@pathitems);
15225: my $navmap = Apache::lonnavmaps::navmap->new();
15226: if (defined($navmap)) {
15227: my $mapres = $navmap->getResourceByUrl($map);
15228: if (ref($mapres)) {
15229: my $pcslist = $mapres->map_hierarchy();
15230: if ($pcslist ne '') {
15231: foreach my $pc (split(/,/,$pcslist)) {
15232: my $res = $navmap->getByMapPc($pc);
15233: if (ref($res)) {
15234: my $title = $res->compTitle();
15235: $title =~ s/\W+/_/g;
15236: if ($title ne '') {
1.1149 raeburn 15237: if (($pc > 1) && (length($title) > 12)) {
15238: $title = substr($title,0,12);
15239: }
1.1015 raeburn 15240: push(@pathitems,$title);
15241: }
15242: }
15243: }
15244: }
15245: my $maptitle = $mapres->compTitle();
15246: $maptitle =~ s/\W+/_/g;
15247: if ($maptitle ne '') {
1.1149 raeburn 15248: if (length($maptitle) > 12) {
15249: $maptitle = substr($maptitle,0,12);
15250: }
1.1015 raeburn 15251: push(@pathitems,$maptitle);
15252: }
15253: unless ($env{'request.state'} eq 'construct') {
15254: my $res = $navmap->getBySymb($symb);
15255: if (ref($res)) {
15256: my $partlist = $res->parts();
15257: my $totaluploads = 0;
15258: if (ref($partlist) eq 'ARRAY') {
15259: foreach my $part (@{$partlist}) {
15260: my @types = $res->responseType($part);
15261: my @ids = $res->responseIds($part);
15262: for (my $i=0; $i < scalar(@ids); $i++) {
15263: if ($types[$i] eq 'essay') {
15264: my $partid = $part.'_'.$ids[$i];
15265: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15266: $totaluploads ++;
15267: }
15268: }
15269: }
15270: }
15271: if ($totaluploads > 1) {
15272: $multiresp = 1;
15273: }
15274: }
15275: }
15276: }
15277: } else {
15278: return;
15279: }
15280: } else {
15281: return;
15282: }
15283: my $restitle=&Apache::lonnet::gettitle($symb);
15284: $restitle =~ s/\W+/_/g;
15285: if ($restitle eq '') {
15286: $restitle = ($resurl =~ m{/[^/]+$});
15287: if ($restitle eq '') {
15288: $restitle = time;
15289: }
15290: }
1.1149 raeburn 15291: if (length($restitle) > 12) {
15292: $restitle = substr($restitle,0,12);
15293: }
1.1015 raeburn 15294: push(@pathitems,$restitle);
15295: $path .= join('/',@pathitems);
15296: }
15297: return ($path,$multiresp);
15298: }
15299:
15300: =pod
15301:
1.464 albertel 15302: =back
1.41 ng 15303:
1.112 bowersj2 15304: =head1 CSV Upload/Handling functions
1.38 albertel 15305:
1.41 ng 15306: =over 4
15307:
1.648 raeburn 15308: =item * &upfile_store($r)
1.41 ng 15309:
15310: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15311: needs $env{'form.upfile'}
1.41 ng 15312: returns $datatoken to be put into hidden field
15313:
15314: =cut
1.31 albertel 15315:
15316: sub upfile_store {
15317: my $r=shift;
1.258 albertel 15318: $env{'form.upfile'}=~s/\r/\n/gs;
15319: $env{'form.upfile'}=~s/\f/\n/gs;
15320: $env{'form.upfile'}=~s/\n+/\n/gs;
15321: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15322:
1.1299 raeburn 15323: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15324: '_enroll_'.$env{'request.course.id'}.'_'.
15325: time.'_'.$$);
15326: return if ($datatoken eq '');
15327:
1.31 albertel 15328: {
1.158 raeburn 15329: my $datafile = $r->dir_config('lonDaemons').
15330: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15331: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15332: print $fh $env{'form.upfile'};
1.158 raeburn 15333: close($fh);
15334: }
1.31 albertel 15335: }
15336: return $datatoken;
15337: }
15338:
1.56 matthew 15339: =pod
15340:
1.1290 raeburn 15341: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15342:
15343: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15344: $datatoken is the name to assign to the temporary file.
1.258 albertel 15345: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15346:
15347: =cut
1.31 albertel 15348:
15349: sub load_tmp_file {
1.1290 raeburn 15350: my ($r,$datatoken) = @_;
15351: return if ($datatoken eq '');
1.31 albertel 15352: my @studentdata=();
15353: {
1.158 raeburn 15354: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15355: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15356: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15357: @studentdata=<$fh>;
15358: close($fh);
15359: }
1.31 albertel 15360: }
1.258 albertel 15361: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15362: }
15363:
1.1290 raeburn 15364: sub valid_datatoken {
15365: my ($datatoken) = @_;
1.1325 raeburn 15366: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15367: return $datatoken;
15368: }
15369: return;
15370: }
15371:
1.56 matthew 15372: =pod
15373:
1.648 raeburn 15374: =item * &upfile_record_sep()
1.41 ng 15375:
15376: Separate uploaded file into records
15377: returns array of records,
1.258 albertel 15378: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15379:
15380: =cut
1.31 albertel 15381:
15382: sub upfile_record_sep {
1.258 albertel 15383: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15384: } else {
1.248 albertel 15385: my @records;
1.258 albertel 15386: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15387: if ($line=~/^\s*$/) { next; }
15388: push(@records,$line);
15389: }
15390: return @records;
1.31 albertel 15391: }
15392: }
15393:
1.56 matthew 15394: =pod
15395:
1.648 raeburn 15396: =item * &record_sep($record)
1.41 ng 15397:
1.258 albertel 15398: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15399:
15400: =cut
15401:
1.263 www 15402: sub takeleft {
15403: my $index=shift;
15404: return substr('0000'.$index,-4,4);
15405: }
15406:
1.31 albertel 15407: sub record_sep {
15408: my $record=shift;
15409: my %components=();
1.258 albertel 15410: if ($env{'form.upfiletype'} eq 'xml') {
15411: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15412: my $i=0;
1.356 albertel 15413: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15414: $field=~s/^(\"|\')//;
15415: $field=~s/(\"|\')$//;
1.263 www 15416: $components{&takeleft($i)}=$field;
1.31 albertel 15417: $i++;
15418: }
1.258 albertel 15419: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15420: my $i=0;
1.356 albertel 15421: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15422: $field=~s/^(\"|\')//;
15423: $field=~s/(\"|\')$//;
1.263 www 15424: $components{&takeleft($i)}=$field;
1.31 albertel 15425: $i++;
15426: }
15427: } else {
1.561 www 15428: my $separator=',';
1.480 banghart 15429: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15430: $separator=';';
1.480 banghart 15431: }
1.31 albertel 15432: my $i=0;
1.561 www 15433: # the character we are looking for to indicate the end of a quote or a record
15434: my $looking_for=$separator;
15435: # do not add the characters to the fields
15436: my $ignore=0;
15437: # we just encountered a separator (or the beginning of the record)
15438: my $just_found_separator=1;
15439: # store the field we are working on here
15440: my $field='';
15441: # work our way through all characters in record
15442: foreach my $character ($record=~/(.)/g) {
15443: if ($character eq $looking_for) {
15444: if ($character ne $separator) {
15445: # Found the end of a quote, again looking for separator
15446: $looking_for=$separator;
15447: $ignore=1;
15448: } else {
15449: # Found a separator, store away what we got
15450: $components{&takeleft($i)}=$field;
15451: $i++;
15452: $just_found_separator=1;
15453: $ignore=0;
15454: $field='';
15455: }
15456: next;
15457: }
15458: # single or double quotation marks after a separator indicate beginning of a quote
15459: # we are now looking for the end of the quote and need to ignore separators
15460: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15461: $looking_for=$character;
15462: next;
15463: }
15464: # ignore would be true after we reached the end of a quote
15465: if ($ignore) { next; }
15466: if (($just_found_separator) && ($character=~/\s/)) { next; }
15467: $field.=$character;
15468: $just_found_separator=0;
1.31 albertel 15469: }
1.561 www 15470: # catch the very last entry, since we never encountered the separator
15471: $components{&takeleft($i)}=$field;
1.31 albertel 15472: }
15473: return %components;
15474: }
15475:
1.144 matthew 15476: ######################################################
15477: ######################################################
15478:
1.56 matthew 15479: =pod
15480:
1.648 raeburn 15481: =item * &upfile_select_html()
1.41 ng 15482:
1.144 matthew 15483: Return HTML code to select a file from the users machine and specify
15484: the file type.
1.41 ng 15485:
15486: =cut
15487:
1.144 matthew 15488: ######################################################
15489: ######################################################
1.31 albertel 15490: sub upfile_select_html {
1.144 matthew 15491: my %Types = (
15492: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15493: semisv => &mt('Semicolon separated values'),
1.144 matthew 15494: space => &mt('Space separated'),
15495: tab => &mt('Tabulator separated'),
15496: # xml => &mt('HTML/XML'),
15497: );
15498: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15499: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15500: foreach my $type (sort(keys(%Types))) {
15501: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15502: }
15503: $Str .= "</select>\n";
15504: return $Str;
1.31 albertel 15505: }
15506:
1.301 albertel 15507: sub get_samples {
15508: my ($records,$toget) = @_;
15509: my @samples=({});
15510: my $got=0;
15511: foreach my $rec (@$records) {
15512: my %temp = &record_sep($rec);
15513: if (! grep(/\S/, values(%temp))) { next; }
15514: if (%temp) {
15515: $samples[$got]=\%temp;
15516: $got++;
15517: if ($got == $toget) { last; }
15518: }
15519: }
15520: return \@samples;
15521: }
15522:
1.144 matthew 15523: ######################################################
15524: ######################################################
15525:
1.56 matthew 15526: =pod
15527:
1.648 raeburn 15528: =item * &csv_print_samples($r,$records)
1.41 ng 15529:
15530: Prints a table of sample values from each column uploaded $r is an
15531: Apache Request ref, $records is an arrayref from
15532: &Apache::loncommon::upfile_record_sep
15533:
15534: =cut
15535:
1.144 matthew 15536: ######################################################
15537: ######################################################
1.31 albertel 15538: sub csv_print_samples {
15539: my ($r,$records) = @_;
1.662 bisitz 15540: my $samples = &get_samples($records,5);
1.301 albertel 15541:
1.594 raeburn 15542: $r->print(&mt('Samples').'<br />'.&start_data_table().
15543: &start_data_table_header_row());
1.356 albertel 15544: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15545: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15546: $r->print(&end_data_table_header_row());
1.301 albertel 15547: foreach my $hash (@$samples) {
1.594 raeburn 15548: $r->print(&start_data_table_row());
1.356 albertel 15549: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15550: $r->print('<td>');
1.356 albertel 15551: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15552: $r->print('</td>');
15553: }
1.594 raeburn 15554: $r->print(&end_data_table_row());
1.31 albertel 15555: }
1.594 raeburn 15556: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15557: }
15558:
1.144 matthew 15559: ######################################################
15560: ######################################################
15561:
1.56 matthew 15562: =pod
15563:
1.648 raeburn 15564: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15565:
15566: Prints a table to create associations between values and table columns.
1.144 matthew 15567:
1.41 ng 15568: $r is an Apache Request ref,
15569: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15570: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15571:
15572: =cut
15573:
1.144 matthew 15574: ######################################################
15575: ######################################################
1.31 albertel 15576: sub csv_print_select_table {
15577: my ($r,$records,$d) = @_;
1.301 albertel 15578: my $i=0;
15579: my $samples = &get_samples($records,1);
1.144 matthew 15580: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15581: &start_data_table().&start_data_table_header_row().
1.144 matthew 15582: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15583: '<th>'.&mt('Column').'</th>'.
15584: &end_data_table_header_row()."\n");
1.356 albertel 15585: foreach my $array_ref (@$d) {
15586: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15587: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15588:
1.875 bisitz 15589: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15590: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15591: $r->print('<option value="none"></option>');
1.356 albertel 15592: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15593: $r->print('<option value="'.$sample.'"'.
15594: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15595: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15596: }
1.594 raeburn 15597: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15598: $i++;
15599: }
1.594 raeburn 15600: $r->print(&end_data_table());
1.31 albertel 15601: $i--;
15602: return $i;
15603: }
1.56 matthew 15604:
1.144 matthew 15605: ######################################################
15606: ######################################################
15607:
1.56 matthew 15608: =pod
1.31 albertel 15609:
1.648 raeburn 15610: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15611:
15612: Prints a table of sample values from the upload and can make associate samples to internal names.
15613:
15614: $r is an Apache Request ref,
15615: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15616: $d is an array of 2 element arrays (internal name, displayed name)
15617:
15618: =cut
15619:
1.144 matthew 15620: ######################################################
15621: ######################################################
1.31 albertel 15622: sub csv_samples_select_table {
15623: my ($r,$records,$d) = @_;
15624: my $i=0;
1.144 matthew 15625: #
1.662 bisitz 15626: my $max_samples = 5;
15627: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15628: $r->print(&start_data_table().
15629: &start_data_table_header_row().'<th>'.
15630: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15631: &end_data_table_header_row());
1.301 albertel 15632:
15633: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15634: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15635: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15636: foreach my $option (@$d) {
15637: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15638: $r->print('<option value="'.$value.'"'.
1.253 albertel 15639: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15640: $display.'</option>');
1.31 albertel 15641: }
15642: $r->print('</select></td><td>');
1.662 bisitz 15643: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15644: if (defined($samples->[$line]{$key})) {
15645: $r->print($samples->[$line]{$key}."<br />\n");
15646: }
15647: }
1.594 raeburn 15648: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15649: $i++;
15650: }
1.594 raeburn 15651: $r->print(&end_data_table());
1.31 albertel 15652: $i--;
15653: return($i);
1.115 matthew 15654: }
15655:
1.144 matthew 15656: ######################################################
15657: ######################################################
15658:
1.115 matthew 15659: =pod
15660:
1.648 raeburn 15661: =item * &clean_excel_name($name)
1.115 matthew 15662:
15663: Returns a replacement for $name which does not contain any illegal characters.
15664:
15665: =cut
15666:
1.144 matthew 15667: ######################################################
15668: ######################################################
1.115 matthew 15669: sub clean_excel_name {
15670: my ($name) = @_;
15671: $name =~ s/[:\*\?\/\\]//g;
15672: if (length($name) > 31) {
15673: $name = substr($name,0,31);
15674: }
15675: return $name;
1.25 albertel 15676: }
1.84 albertel 15677:
1.85 albertel 15678: =pod
15679:
1.648 raeburn 15680: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15681:
15682: Returns either 1 or undef
15683:
15684: 1 if the part is to be hidden, undef if it is to be shown
15685:
15686: Arguments are:
15687:
15688: $id the id of the part to be checked
15689: $symb, optional the symb of the resource to check
15690: $udom, optional the domain of the user to check for
15691: $uname, optional the username of the user to check for
15692:
15693: =cut
1.84 albertel 15694:
15695: sub check_if_partid_hidden {
15696: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15697: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15698: $symb,$udom,$uname);
1.141 albertel 15699: my $truth=1;
15700: #if the string starts with !, then the list is the list to show not hide
15701: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15702: my @hiddenlist=split(/,/,$hiddenparts);
15703: foreach my $checkid (@hiddenlist) {
1.141 albertel 15704: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15705: }
1.141 albertel 15706: return !$truth;
1.84 albertel 15707: }
1.127 matthew 15708:
1.138 matthew 15709:
15710: ############################################################
15711: ############################################################
15712:
15713: =pod
15714:
1.157 matthew 15715: =back
15716:
1.138 matthew 15717: =head1 cgi-bin script and graphing routines
15718:
1.157 matthew 15719: =over 4
15720:
1.648 raeburn 15721: =item * &get_cgi_id()
1.138 matthew 15722:
15723: Inputs: none
15724:
15725: Returns an id which can be used to pass environment variables
15726: to various cgi-bin scripts. These environment variables will
15727: be removed from the users environment after a given time by
15728: the routine &Apache::lonnet::transfer_profile_to_env.
15729:
15730: =cut
15731:
15732: ############################################################
15733: ############################################################
1.152 albertel 15734: my $uniq=0;
1.136 matthew 15735: sub get_cgi_id {
1.154 albertel 15736: $uniq=($uniq+1)%100000;
1.280 albertel 15737: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15738: }
15739:
1.127 matthew 15740: ############################################################
15741: ############################################################
15742:
15743: =pod
15744:
1.648 raeburn 15745: =item * &DrawBarGraph()
1.127 matthew 15746:
1.138 matthew 15747: Facilitates the plotting of data in a (stacked) bar graph.
15748: Puts plot definition data into the users environment in order for
15749: graph.png to plot it. Returns an <img> tag for the plot.
15750: The bars on the plot are labeled '1','2',...,'n'.
15751:
15752: Inputs:
15753:
15754: =over 4
15755:
15756: =item $Title: string, the title of the plot
15757:
15758: =item $xlabel: string, text describing the X-axis of the plot
15759:
15760: =item $ylabel: string, text describing the Y-axis of the plot
15761:
15762: =item $Max: scalar, the maximum Y value to use in the plot
15763: If $Max is < any data point, the graph will not be rendered.
15764:
1.140 matthew 15765: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15766: they are plotted. If undefined, default values will be used.
15767:
1.178 matthew 15768: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15769:
1.138 matthew 15770: =item @Values: An array of array references. Each array reference holds data
15771: to be plotted in a stacked bar chart.
15772:
1.239 matthew 15773: =item If the final element of @Values is a hash reference the key/value
15774: pairs will be added to the graph definition.
15775:
1.138 matthew 15776: =back
15777:
15778: Returns:
15779:
15780: An <img> tag which references graph.png and the appropriate identifying
15781: information for the plot.
15782:
1.127 matthew 15783: =cut
15784:
15785: ############################################################
15786: ############################################################
1.134 matthew 15787: sub DrawBarGraph {
1.178 matthew 15788: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15789: #
15790: if (! defined($colors)) {
15791: $colors = ['#33ff00',
15792: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15793: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15794: ];
15795: }
1.228 matthew 15796: my $extra_settings = {};
15797: if (ref($Values[-1]) eq 'HASH') {
15798: $extra_settings = pop(@Values);
15799: }
1.127 matthew 15800: #
1.136 matthew 15801: my $identifier = &get_cgi_id();
15802: my $id = 'cgi.'.$identifier;
1.129 matthew 15803: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15804: return '';
15805: }
1.225 matthew 15806: #
15807: my @Labels;
15808: if (defined($labels)) {
15809: @Labels = @$labels;
15810: } else {
15811: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15812: push(@Labels,$i+1);
1.225 matthew 15813: }
15814: }
15815: #
1.129 matthew 15816: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15817: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15818: my %ValuesHash;
15819: my $NumSets=1;
15820: foreach my $array (@Values) {
15821: next if (! ref($array));
1.136 matthew 15822: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15823: join(',',@$array);
1.129 matthew 15824: }
1.127 matthew 15825: #
1.136 matthew 15826: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15827: if ($NumBars < 3) {
15828: $width = 120+$NumBars*32;
1.220 matthew 15829: $xskip = 1;
1.225 matthew 15830: $bar_width = 30;
15831: } elsif ($NumBars < 5) {
15832: $width = 120+$NumBars*20;
15833: $xskip = 1;
15834: $bar_width = 20;
1.220 matthew 15835: } elsif ($NumBars < 10) {
1.136 matthew 15836: $width = 120+$NumBars*15;
15837: $xskip = 1;
15838: $bar_width = 15;
15839: } elsif ($NumBars <= 25) {
15840: $width = 120+$NumBars*11;
15841: $xskip = 5;
15842: $bar_width = 8;
15843: } elsif ($NumBars <= 50) {
15844: $width = 120+$NumBars*8;
15845: $xskip = 5;
15846: $bar_width = 4;
15847: } else {
15848: $width = 120+$NumBars*8;
15849: $xskip = 5;
15850: $bar_width = 4;
15851: }
15852: #
1.137 matthew 15853: $Max = 1 if ($Max < 1);
15854: if ( int($Max) < $Max ) {
15855: $Max++;
15856: $Max = int($Max);
15857: }
1.127 matthew 15858: $Title = '' if (! defined($Title));
15859: $xlabel = '' if (! defined($xlabel));
15860: $ylabel = '' if (! defined($ylabel));
1.369 www 15861: $ValuesHash{$id.'.title'} = &escape($Title);
15862: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15863: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15864: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15865: $ValuesHash{$id.'.NumBars'} = $NumBars;
15866: $ValuesHash{$id.'.NumSets'} = $NumSets;
15867: $ValuesHash{$id.'.PlotType'} = 'bar';
15868: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15869: $ValuesHash{$id.'.height'} = $height;
15870: $ValuesHash{$id.'.width'} = $width;
15871: $ValuesHash{$id.'.xskip'} = $xskip;
15872: $ValuesHash{$id.'.bar_width'} = $bar_width;
15873: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15874: #
1.228 matthew 15875: # Deal with other parameters
15876: while (my ($key,$value) = each(%$extra_settings)) {
15877: $ValuesHash{$id.'.'.$key} = $value;
15878: }
15879: #
1.646 raeburn 15880: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15881: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15882: }
15883:
15884: ############################################################
15885: ############################################################
15886:
15887: =pod
15888:
1.648 raeburn 15889: =item * &DrawXYGraph()
1.137 matthew 15890:
1.138 matthew 15891: Facilitates the plotting of data in an XY graph.
15892: Puts plot definition data into the users environment in order for
15893: graph.png to plot it. Returns an <img> tag for the plot.
15894:
15895: Inputs:
15896:
15897: =over 4
15898:
15899: =item $Title: string, the title of the plot
15900:
15901: =item $xlabel: string, text describing the X-axis of the plot
15902:
15903: =item $ylabel: string, text describing the Y-axis of the plot
15904:
15905: =item $Max: scalar, the maximum Y value to use in the plot
15906: If $Max is < any data point, the graph will not be rendered.
15907:
15908: =item $colors: Array ref containing the hex color codes for the data to be
15909: plotted in. If undefined, default values will be used.
15910:
15911: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15912:
15913: =item $Ydata: Array ref containing Array refs.
1.185 www 15914: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15915:
15916: =item %Values: hash indicating or overriding any default values which are
15917: passed to graph.png.
15918: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15919:
15920: =back
15921:
15922: Returns:
15923:
15924: An <img> tag which references graph.png and the appropriate identifying
15925: information for the plot.
15926:
1.137 matthew 15927: =cut
15928:
15929: ############################################################
15930: ############################################################
15931: sub DrawXYGraph {
15932: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15933: #
15934: # Create the identifier for the graph
15935: my $identifier = &get_cgi_id();
15936: my $id = 'cgi.'.$identifier;
15937: #
15938: $Title = '' if (! defined($Title));
15939: $xlabel = '' if (! defined($xlabel));
15940: $ylabel = '' if (! defined($ylabel));
15941: my %ValuesHash =
15942: (
1.369 www 15943: $id.'.title' => &escape($Title),
15944: $id.'.xlabel' => &escape($xlabel),
15945: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15946: $id.'.y_max_value'=> $Max,
15947: $id.'.labels' => join(',',@$Xlabels),
15948: $id.'.PlotType' => 'XY',
15949: );
15950: #
15951: if (defined($colors) && ref($colors) eq 'ARRAY') {
15952: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15953: }
15954: #
15955: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15956: return '';
15957: }
15958: my $NumSets=1;
1.138 matthew 15959: foreach my $array (@{$Ydata}){
1.137 matthew 15960: next if (! ref($array));
15961: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15962: }
1.138 matthew 15963: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15964: #
15965: # Deal with other parameters
15966: while (my ($key,$value) = each(%Values)) {
15967: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15968: }
15969: #
1.646 raeburn 15970: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15971: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15972: }
15973:
15974: ############################################################
15975: ############################################################
15976:
15977: =pod
15978:
1.648 raeburn 15979: =item * &DrawXYYGraph()
1.138 matthew 15980:
15981: Facilitates the plotting of data in an XY graph with two Y axes.
15982: Puts plot definition data into the users environment in order for
15983: graph.png to plot it. Returns an <img> tag for the plot.
15984:
15985: Inputs:
15986:
15987: =over 4
15988:
15989: =item $Title: string, the title of the plot
15990:
15991: =item $xlabel: string, text describing the X-axis of the plot
15992:
15993: =item $ylabel: string, text describing the Y-axis of the plot
15994:
15995: =item $colors: Array ref containing the hex color codes for the data to be
15996: plotted in. If undefined, default values will be used.
15997:
15998: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15999:
16000: =item $Ydata1: The first data set
16001:
16002: =item $Min1: The minimum value of the left Y-axis
16003:
16004: =item $Max1: The maximum value of the left Y-axis
16005:
16006: =item $Ydata2: The second data set
16007:
16008: =item $Min2: The minimum value of the right Y-axis
16009:
16010: =item $Max2: The maximum value of the left Y-axis
16011:
16012: =item %Values: hash indicating or overriding any default values which are
16013: passed to graph.png.
16014: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16015:
16016: =back
16017:
16018: Returns:
16019:
16020: An <img> tag which references graph.png and the appropriate identifying
16021: information for the plot.
1.136 matthew 16022:
16023: =cut
16024:
16025: ############################################################
16026: ############################################################
1.137 matthew 16027: sub DrawXYYGraph {
16028: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16029: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16030: #
16031: # Create the identifier for the graph
16032: my $identifier = &get_cgi_id();
16033: my $id = 'cgi.'.$identifier;
16034: #
16035: $Title = '' if (! defined($Title));
16036: $xlabel = '' if (! defined($xlabel));
16037: $ylabel = '' if (! defined($ylabel));
16038: my %ValuesHash =
16039: (
1.369 www 16040: $id.'.title' => &escape($Title),
16041: $id.'.xlabel' => &escape($xlabel),
16042: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16043: $id.'.labels' => join(',',@$Xlabels),
16044: $id.'.PlotType' => 'XY',
16045: $id.'.NumSets' => 2,
1.137 matthew 16046: $id.'.two_axes' => 1,
16047: $id.'.y1_max_value' => $Max1,
16048: $id.'.y1_min_value' => $Min1,
16049: $id.'.y2_max_value' => $Max2,
16050: $id.'.y2_min_value' => $Min2,
1.136 matthew 16051: );
16052: #
1.137 matthew 16053: if (defined($colors) && ref($colors) eq 'ARRAY') {
16054: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16055: }
16056: #
16057: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16058: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16059: return '';
16060: }
16061: my $NumSets=1;
1.137 matthew 16062: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16063: next if (! ref($array));
16064: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16065: }
16066: #
16067: # Deal with other parameters
16068: while (my ($key,$value) = each(%Values)) {
16069: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16070: }
16071: #
1.646 raeburn 16072: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16073: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16074: }
16075:
16076: ############################################################
16077: ############################################################
16078:
16079: =pod
16080:
1.157 matthew 16081: =back
16082:
1.139 matthew 16083: =head1 Statistics helper routines?
16084:
16085: Bad place for them but what the hell.
16086:
1.157 matthew 16087: =over 4
16088:
1.648 raeburn 16089: =item * &chartlink()
1.139 matthew 16090:
16091: Returns a link to the chart for a specific student.
16092:
16093: Inputs:
16094:
16095: =over 4
16096:
16097: =item $linktext: The text of the link
16098:
16099: =item $sname: The students username
16100:
16101: =item $sdomain: The students domain
16102:
16103: =back
16104:
1.157 matthew 16105: =back
16106:
1.139 matthew 16107: =cut
16108:
16109: ############################################################
16110: ############################################################
16111: sub chartlink {
16112: my ($linktext, $sname, $sdomain) = @_;
16113: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16114: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16115: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16116: '">'.$linktext.'</a>';
1.153 matthew 16117: }
16118:
16119: #######################################################
16120: #######################################################
16121:
16122: =pod
16123:
16124: =head1 Course Environment Routines
1.157 matthew 16125:
16126: =over 4
1.153 matthew 16127:
1.648 raeburn 16128: =item * &restore_course_settings()
1.153 matthew 16129:
1.648 raeburn 16130: =item * &store_course_settings()
1.153 matthew 16131:
16132: Restores/Store indicated form parameters from the course environment.
16133: Will not overwrite existing values of the form parameters.
16134:
16135: Inputs:
16136: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16137:
16138: a hash ref describing the data to be stored. For example:
16139:
16140: %Save_Parameters = ('Status' => 'scalar',
16141: 'chartoutputmode' => 'scalar',
16142: 'chartoutputdata' => 'scalar',
16143: 'Section' => 'array',
1.373 raeburn 16144: 'Group' => 'array',
1.153 matthew 16145: 'StudentData' => 'array',
16146: 'Maps' => 'array');
16147:
16148: Returns: both routines return nothing
16149:
1.631 raeburn 16150: =back
16151:
1.153 matthew 16152: =cut
16153:
16154: #######################################################
16155: #######################################################
16156: sub store_course_settings {
1.496 albertel 16157: return &store_settings($env{'request.course.id'},@_);
16158: }
16159:
16160: sub store_settings {
1.153 matthew 16161: # save to the environment
16162: # appenv the same items, just to be safe
1.300 albertel 16163: my $udom = $env{'user.domain'};
16164: my $uname = $env{'user.name'};
1.496 albertel 16165: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16166: my %SaveHash;
16167: my %AppHash;
16168: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16169: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16170: my $envname = 'environment.'.$basename;
1.258 albertel 16171: if (exists($env{'form.'.$setting})) {
1.153 matthew 16172: # Save this value away
16173: if ($type eq 'scalar' &&
1.258 albertel 16174: (! exists($env{$envname}) ||
16175: $env{$envname} ne $env{'form.'.$setting})) {
16176: $SaveHash{$basename} = $env{'form.'.$setting};
16177: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16178: } elsif ($type eq 'array') {
16179: my $stored_form;
1.258 albertel 16180: if (ref($env{'form.'.$setting})) {
1.153 matthew 16181: $stored_form = join(',',
16182: map {
1.369 www 16183: &escape($_);
1.258 albertel 16184: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16185: } else {
16186: $stored_form =
1.369 www 16187: &escape($env{'form.'.$setting});
1.153 matthew 16188: }
16189: # Determine if the array contents are the same.
1.258 albertel 16190: if ($stored_form ne $env{$envname}) {
1.153 matthew 16191: $SaveHash{$basename} = $stored_form;
16192: $AppHash{$envname} = $stored_form;
16193: }
16194: }
16195: }
16196: }
16197: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16198: $udom,$uname);
1.153 matthew 16199: if ($put_result !~ /^(ok|delayed)/) {
16200: &Apache::lonnet::logthis('unable to save form parameters, '.
16201: 'got error:'.$put_result);
16202: }
16203: # Make sure these settings stick around in this session, too
1.646 raeburn 16204: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16205: return;
16206: }
16207:
16208: sub restore_course_settings {
1.499 albertel 16209: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16210: }
16211:
16212: sub restore_settings {
16213: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16214: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16215: next if (exists($env{'form.'.$setting}));
1.496 albertel 16216: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16217: '.'.$setting;
1.258 albertel 16218: if (exists($env{$envname})) {
1.153 matthew 16219: if ($type eq 'scalar') {
1.258 albertel 16220: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16221: } elsif ($type eq 'array') {
1.258 albertel 16222: $env{'form.'.$setting} = [
1.153 matthew 16223: map {
1.369 www 16224: &unescape($_);
1.258 albertel 16225: } split(',',$env{$envname})
1.153 matthew 16226: ];
16227: }
16228: }
16229: }
1.127 matthew 16230: }
16231:
1.618 raeburn 16232: #######################################################
16233: #######################################################
16234:
16235: =pod
16236:
16237: =head1 Domain E-mail Routines
16238:
16239: =over 4
16240:
1.648 raeburn 16241: =item * &build_recipient_list()
1.618 raeburn 16242:
1.1144 raeburn 16243: Build recipient lists for following types of e-mail:
1.766 raeburn 16244: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16245: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16246: module change checking, student/employee ID conflict checks, as
16247: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16248: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16249:
16250: Inputs:
1.619 raeburn 16251: defmail (scalar - email address of default recipient),
1.1144 raeburn 16252: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16253: requestsmail, updatesmail, or idconflictsmail).
16254:
1.619 raeburn 16255: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16256:
1.619 raeburn 16257: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16258: i.e., predates configuration by DC via domainprefs.pm
16259:
16260: $requname username of requester (if mailing type is helpdeskmail)
16261:
16262: $requdom domain of requester (if mailing type is helpdeskmail)
16263:
16264: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16265:
1.618 raeburn 16266:
1.655 raeburn 16267: Returns: comma separated list of addresses to which to send e-mail.
16268:
16269: =back
1.618 raeburn 16270:
16271: =cut
16272:
16273: ############################################################
16274: ############################################################
16275: sub build_recipient_list {
1.1297 raeburn 16276: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16277: my @recipients;
1.1270 raeburn 16278: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16279: my %domconfig =
1.1270 raeburn 16280: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16281: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16282: if (exists($domconfig{'contacts'}{$mailing})) {
16283: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16284: my @contacts = ('adminemail','supportemail');
16285: foreach my $item (@contacts) {
16286: if ($domconfig{'contacts'}{$mailing}{$item}) {
16287: my $addr = $domconfig{'contacts'}{$item};
16288: if (!grep(/^\Q$addr\E$/,@recipients)) {
16289: push(@recipients,$addr);
16290: }
1.619 raeburn 16291: }
1.1270 raeburn 16292: }
16293: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16294: if ($mailing eq 'helpdeskmail') {
16295: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16296: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16297: my @ok_bccs;
16298: foreach my $bcc (@bccs) {
16299: $bcc =~ s/^\s+//g;
16300: $bcc =~ s/\s+$//g;
16301: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16302: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16303: push(@ok_bccs,$bcc);
16304: }
16305: }
16306: }
16307: if (@ok_bccs > 0) {
16308: $allbcc = join(', ',@ok_bccs);
16309: }
16310: }
16311: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16312: }
16313: }
1.766 raeburn 16314: } elsif ($origmail ne '') {
1.1270 raeburn 16315: $lastresort = $origmail;
1.618 raeburn 16316: }
1.1297 raeburn 16317: if ($mailing eq 'helpdeskmail') {
16318: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16319: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16320: my ($inststatus,$inststatus_checked);
16321: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16322: ($env{'user.domain'} ne 'public')) {
16323: $inststatus_checked = 1;
16324: $inststatus = $env{'environment.inststatus'};
16325: }
16326: unless ($inststatus_checked) {
16327: if (($requname ne '') && ($requdom ne '')) {
16328: if (($requname =~ /^$match_username$/) &&
16329: ($requdom =~ /^$match_domain$/) &&
16330: (&Apache::lonnet::domain($requdom))) {
16331: my $requhome = &Apache::lonnet::homeserver($requname,
16332: $requdom);
16333: unless ($requhome eq 'no_host') {
16334: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16335: $inststatus = $userenv{'inststatus'};
16336: $inststatus_checked = 1;
16337: }
16338: }
16339: }
16340: }
16341: unless ($inststatus_checked) {
16342: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16343: my %srch = (srchby => 'email',
16344: srchdomain => $defdom,
16345: srchterm => $reqemail,
16346: srchtype => 'exact');
16347: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16348: foreach my $uname (keys(%srch_results)) {
16349: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16350: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16351: $inststatus_checked = 1;
16352: last;
16353: }
16354: }
16355: unless ($inststatus_checked) {
16356: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16357: if ($dirsrchres eq 'ok') {
16358: foreach my $uname (keys(%srch_results)) {
16359: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16360: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16361: $inststatus_checked = 1;
16362: last;
16363: }
16364: }
16365: }
16366: }
16367: }
16368: }
16369: if ($inststatus ne '') {
16370: foreach my $status (split(/\:/,$inststatus)) {
16371: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16372: my @contacts = ('adminemail','supportemail');
16373: foreach my $item (@contacts) {
16374: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16375: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16376: if (!grep(/^\Q$addr\E$/,@recipients)) {
16377: push(@recipients,$addr);
16378: }
16379: }
16380: }
16381: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16382: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16383: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16384: my @ok_bccs;
16385: foreach my $bcc (@bccs) {
16386: $bcc =~ s/^\s+//g;
16387: $bcc =~ s/\s+$//g;
16388: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16389: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16390: push(@ok_bccs,$bcc);
16391: }
16392: }
16393: }
16394: if (@ok_bccs > 0) {
16395: $allbcc = join(', ',@ok_bccs);
16396: }
16397: }
16398: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16399: last;
16400: }
16401: }
16402: }
16403: }
16404: }
1.619 raeburn 16405: } elsif ($origmail ne '') {
1.1270 raeburn 16406: $lastresort = $origmail;
16407: }
1.1297 raeburn 16408: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16409: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16410: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16411: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16412: my %what = (
16413: perlvar => 1,
16414: );
16415: my $primary = &Apache::lonnet::domain($defdom,'primary');
16416: if ($primary) {
16417: my $gotaddr;
16418: my ($result,$returnhash) =
16419: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16420: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16421: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16422: $lastresort = $returnhash->{'lonSupportEMail'};
16423: $gotaddr = 1;
16424: }
16425: }
16426: unless ($gotaddr) {
16427: my $uintdom = &Apache::lonnet::internet_dom($primary);
16428: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16429: unless ($uintdom eq $intdom) {
16430: my %domconfig =
16431: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16432: if (ref($domconfig{'contacts'}) eq 'HASH') {
16433: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16434: my @contacts = ('adminemail','supportemail');
16435: foreach my $item (@contacts) {
16436: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16437: my $addr = $domconfig{'contacts'}{$item};
16438: if (!grep(/^\Q$addr\E$/,@recipients)) {
16439: push(@recipients,$addr);
16440: }
16441: }
16442: }
16443: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16444: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16445: }
16446: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16447: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16448: my @ok_bccs;
16449: foreach my $bcc (@bccs) {
16450: $bcc =~ s/^\s+//g;
16451: $bcc =~ s/\s+$//g;
16452: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16453: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16454: push(@ok_bccs,$bcc);
16455: }
16456: }
16457: }
16458: if (@ok_bccs > 0) {
16459: $allbcc = join(', ',@ok_bccs);
16460: }
16461: }
16462: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16463: }
16464: }
16465: }
16466: }
16467: }
16468: }
1.618 raeburn 16469: }
1.688 raeburn 16470: if (defined($defmail)) {
16471: if ($defmail ne '') {
16472: push(@recipients,$defmail);
16473: }
1.618 raeburn 16474: }
16475: if ($otheremails) {
1.619 raeburn 16476: my @others;
16477: if ($otheremails =~ /,/) {
16478: @others = split(/,/,$otheremails);
1.618 raeburn 16479: } else {
1.619 raeburn 16480: push(@others,$otheremails);
16481: }
16482: foreach my $addr (@others) {
16483: if (!grep(/^\Q$addr\E$/,@recipients)) {
16484: push(@recipients,$addr);
16485: }
1.618 raeburn 16486: }
16487: }
1.1298 raeburn 16488: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16489: if ((!@recipients) && ($lastresort ne '')) {
16490: push(@recipients,$lastresort);
16491: }
16492: } elsif ($lastresort ne '') {
16493: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16494: push(@recipients,$lastresort);
16495: }
16496: }
1.1271 raeburn 16497: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16498: if (wantarray) {
16499: return ($recipientlist,$allbcc,$addtext);
16500: } else {
16501: return $recipientlist;
16502: }
1.618 raeburn 16503: }
16504:
1.127 matthew 16505: ############################################################
16506: ############################################################
1.154 albertel 16507:
1.655 raeburn 16508: =pod
16509:
1.1224 musolffc 16510: =over 4
16511:
1.1223 musolffc 16512: =item * &mime_email()
16513:
16514: Sends an email with a possible attachment
16515:
16516: Inputs:
16517:
16518: =over 4
16519:
16520: from - Sender's email address
16521:
1.1343 raeburn 16522: replyto - Reply-To email address
16523:
1.1223 musolffc 16524: to - Email address of recipient
16525:
16526: subject - Subject of email
16527:
16528: body - Body of email
16529:
16530: cc_string - Carbon copy email address
16531:
16532: bcc - Blind carbon copy email address
16533:
16534: attachment_path - Path of file to be attached
16535:
16536: file_name - Name of file to be attached
16537:
16538: attachment_text - The body of an attachment of type "TEXT"
16539:
16540: =back
16541:
16542: =back
16543:
16544: =cut
16545:
16546: ############################################################
16547: ############################################################
16548:
16549: sub mime_email {
1.1343 raeburn 16550: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16551: $file_name,$attachment_text) = @_;
16552:
1.1223 musolffc 16553: my $msg = MIME::Lite->new(
16554: From => $from,
16555: To => $to,
16556: Subject => $subject,
16557: Type =>'TEXT',
16558: Data => $body,
16559: );
1.1343 raeburn 16560: if ($replyto ne '') {
16561: $msg->add("Reply-To" => $replyto);
16562: }
1.1223 musolffc 16563: if ($cc_string ne '') {
16564: $msg->add("Cc" => $cc_string);
16565: }
16566: if ($bcc ne '') {
16567: $msg->add("Bcc" => $bcc);
16568: }
16569: $msg->attr("content-type" => "text/plain");
16570: $msg->attr("content-type.charset" => "UTF-8");
16571: # Attach file if given
16572: if ($attachment_path) {
16573: unless ($file_name) {
16574: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16575: }
16576: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16577: $msg->attach(Type => $type,
16578: Path => $attachment_path,
16579: Filename => $file_name
16580: );
16581: # Otherwise attach text if given
16582: } elsif ($attachment_text) {
16583: $msg->attach(Type => 'TEXT',
16584: Data => $attachment_text);
16585: }
16586: # Send it
16587: $msg->send('sendmail');
16588: }
16589:
16590: ############################################################
16591: ############################################################
16592:
16593: =pod
16594:
1.655 raeburn 16595: =head1 Course Catalog Routines
16596:
16597: =over 4
16598:
16599: =item * &gather_categories()
16600:
16601: Converts category definitions - keys of categories hash stored in
16602: coursecategories in configuration.db on the primary library server in a
16603: domain - to an array. Also generates javascript and idx hash used to
16604: generate Domain Coordinator interface for editing Course Categories.
16605:
16606: Inputs:
1.663 raeburn 16607:
1.655 raeburn 16608: categories (reference to hash of category definitions).
1.663 raeburn 16609:
1.655 raeburn 16610: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16611: categories and subcategories).
1.663 raeburn 16612:
1.655 raeburn 16613: idx (reference to hash of counters used in Domain Coordinator interface for
16614: editing Course Categories).
1.663 raeburn 16615:
1.655 raeburn 16616: jsarray (reference to array of categories used to create Javascript arrays for
16617: Domain Coordinator interface for editing Course Categories).
16618:
16619: Returns: nothing
16620:
16621: Side effects: populates cats, idx and jsarray.
16622:
16623: =cut
16624:
16625: sub gather_categories {
16626: my ($categories,$cats,$idx,$jsarray) = @_;
16627: my %counters;
16628: my $num = 0;
16629: foreach my $item (keys(%{$categories})) {
16630: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16631: if ($container eq '' && $depth == 0) {
16632: $cats->[$depth][$categories->{$item}] = $cat;
16633: } else {
16634: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16635: }
16636: my ($escitem,$tail) = split(/:/,$item,2);
16637: if ($counters{$tail} eq '') {
16638: $counters{$tail} = $num;
16639: $num ++;
16640: }
16641: if (ref($idx) eq 'HASH') {
16642: $idx->{$item} = $counters{$tail};
16643: }
16644: if (ref($jsarray) eq 'ARRAY') {
16645: push(@{$jsarray->[$counters{$tail}]},$item);
16646: }
16647: }
16648: return;
16649: }
16650:
16651: =pod
16652:
16653: =item * &extract_categories()
16654:
16655: Used to generate breadcrumb trails for course categories.
16656:
16657: Inputs:
1.663 raeburn 16658:
1.655 raeburn 16659: categories (reference to hash of category definitions).
1.663 raeburn 16660:
1.655 raeburn 16661: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16662: categories and subcategories).
1.663 raeburn 16663:
1.655 raeburn 16664: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16665:
1.655 raeburn 16666: allitems (reference to hash - key is category key
16667: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16668:
1.655 raeburn 16669: idx (reference to hash of counters used in Domain Coordinator interface for
16670: editing Course Categories).
1.663 raeburn 16671:
1.655 raeburn 16672: jsarray (reference to array of categories used to create Javascript arrays for
16673: Domain Coordinator interface for editing Course Categories).
16674:
1.665 raeburn 16675: subcats (reference to hash of arrays containing all subcategories within each
16676: category, -recursive)
16677:
1.1321 raeburn 16678: maxd (reference to hash used to hold max depth for all top-level categories).
16679:
1.655 raeburn 16680: Returns: nothing
16681:
16682: Side effects: populates trails and allitems hash references.
16683:
16684: =cut
16685:
16686: sub extract_categories {
1.1321 raeburn 16687: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16688: if (ref($categories) eq 'HASH') {
16689: &gather_categories($categories,$cats,$idx,$jsarray);
16690: if (ref($cats->[0]) eq 'ARRAY') {
16691: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16692: my $name = $cats->[0][$i];
16693: my $item = &escape($name).'::0';
16694: my $trailstr;
16695: if ($name eq 'instcode') {
16696: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16697: } elsif ($name eq 'communities') {
16698: $trailstr = &mt('Communities');
1.1239 raeburn 16699: } elsif ($name eq 'placement') {
16700: $trailstr = &mt('Placement Tests');
1.655 raeburn 16701: } else {
16702: $trailstr = $name;
16703: }
16704: if ($allitems->{$item} eq '') {
16705: push(@{$trails},$trailstr);
16706: $allitems->{$item} = scalar(@{$trails})-1;
16707: }
16708: my @parents = ($name);
16709: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16710: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16711: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16712: if (ref($subcats) eq 'HASH') {
16713: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16714: }
1.1321 raeburn 16715: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16716: }
16717: } else {
16718: if (ref($subcats) eq 'HASH') {
16719: $subcats->{$item} = [];
1.655 raeburn 16720: }
1.1321 raeburn 16721: if (ref($maxd) eq 'HASH') {
16722: $maxd->{$name} = 1;
16723: }
1.655 raeburn 16724: }
16725: }
16726: }
16727: }
16728: return;
16729: }
16730:
16731: =pod
16732:
1.1162 raeburn 16733: =item * &recurse_categories()
1.655 raeburn 16734:
16735: Recursively used to generate breadcrumb trails for course categories.
16736:
16737: Inputs:
1.663 raeburn 16738:
1.655 raeburn 16739: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16740: categories and subcategories).
1.663 raeburn 16741:
1.655 raeburn 16742: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16743:
16744: category (current course category, for which breadcrumb trail is being generated).
16745:
16746: trails (reference to array of breadcrumb trails for each category).
16747:
1.655 raeburn 16748: allitems (reference to hash - key is category key
16749: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16750:
1.655 raeburn 16751: parents (array containing containers directories for current category,
16752: back to top level).
16753:
16754: Returns: nothing
16755:
16756: Side effects: populates trails and allitems hash references
16757:
16758: =cut
16759:
16760: sub recurse_categories {
1.1321 raeburn 16761: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16762: my $shallower = $depth - 1;
16763: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16764: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16765: my $name = $cats->[$depth]{$category}[$k];
16766: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16767: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16768: if ($allitems->{$item} eq '') {
16769: push(@{$trails},$trailstr);
16770: $allitems->{$item} = scalar(@{$trails})-1;
16771: }
16772: my $deeper = $depth+1;
16773: push(@{$parents},$category);
1.665 raeburn 16774: if (ref($subcats) eq 'HASH') {
16775: my $subcat = &escape($name).':'.$category.':'.$depth;
16776: for (my $j=@{$parents}; $j>=0; $j--) {
16777: my $higher;
16778: if ($j > 0) {
16779: $higher = &escape($parents->[$j]).':'.
16780: &escape($parents->[$j-1]).':'.$j;
16781: } else {
16782: $higher = &escape($parents->[$j]).'::'.$j;
16783: }
16784: push(@{$subcats->{$higher}},$subcat);
16785: }
16786: }
16787: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16788: $subcats,$maxd);
1.655 raeburn 16789: pop(@{$parents});
16790: }
16791: } else {
16792: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16793: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16794: if ($allitems->{$item} eq '') {
16795: push(@{$trails},$trailstr);
16796: $allitems->{$item} = scalar(@{$trails})-1;
16797: }
1.1321 raeburn 16798: if (ref($maxd) eq 'HASH') {
16799: if ($depth > $maxd->{$parents->[0]}) {
16800: $maxd->{$parents->[0]} = $depth;
16801: }
16802: }
1.655 raeburn 16803: }
16804: return;
16805: }
16806:
1.663 raeburn 16807: =pod
16808:
1.1162 raeburn 16809: =item * &assign_categories_table()
1.663 raeburn 16810:
16811: Create a datatable for display of hierarchical categories in a domain,
16812: with checkboxes to allow a course to be categorized.
16813:
16814: Inputs:
16815:
16816: cathash - reference to hash of categories defined for the domain (from
16817: configuration.db)
16818:
16819: currcat - scalar with an & separated list of categories assigned to a course.
16820:
1.919 raeburn 16821: type - scalar contains course type (Course or Community).
16822:
1.1260 raeburn 16823: disabled - scalar (optional) contains disabled="disabled" if input elements are
16824: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16825:
1.663 raeburn 16826: Returns: $output (markup to be displayed)
16827:
16828: =cut
16829:
16830: sub assign_categories_table {
1.1259 raeburn 16831: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16832: my $output;
16833: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16834: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16835: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16836: $maxdepth = scalar(@cats);
16837: if (@cats > 0) {
16838: my $itemcount = 0;
16839: if (ref($cats[0]) eq 'ARRAY') {
16840: my @currcategories;
16841: if ($currcat ne '') {
16842: @currcategories = split('&',$currcat);
16843: }
1.919 raeburn 16844: my $table;
1.663 raeburn 16845: for (my $i=0; $i<@{$cats[0]}; $i++) {
16846: my $parent = $cats[0][$i];
1.919 raeburn 16847: next if ($parent eq 'instcode');
16848: if ($type eq 'Community') {
16849: next unless ($parent eq 'communities');
1.1239 raeburn 16850: } elsif ($type eq 'Placement') {
16851: next unless ($parent eq 'placement');
1.919 raeburn 16852: } else {
1.1239 raeburn 16853: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16854: }
1.663 raeburn 16855: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16856: my $item = &escape($parent).'::0';
16857: my $checked = '';
16858: if (@currcategories > 0) {
16859: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16860: $checked = ' checked="checked"';
1.663 raeburn 16861: }
16862: }
1.919 raeburn 16863: my $parent_title = $parent;
16864: if ($parent eq 'communities') {
16865: $parent_title = &mt('Communities');
1.1239 raeburn 16866: } elsif ($parent eq 'placement') {
16867: $parent_title = &mt('Placement Tests');
1.919 raeburn 16868: }
16869: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16870: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16871: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16872: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16873: my $depth = 1;
16874: push(@path,$parent);
1.1259 raeburn 16875: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16876: pop(@path);
1.919 raeburn 16877: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16878: $itemcount ++;
16879: }
1.919 raeburn 16880: if ($itemcount) {
16881: $output = &Apache::loncommon::start_data_table().
16882: $table.
16883: &Apache::loncommon::end_data_table();
16884: }
1.663 raeburn 16885: }
16886: }
16887: }
16888: return $output;
16889: }
16890:
16891: =pod
16892:
1.1162 raeburn 16893: =item * &assign_category_rows()
1.663 raeburn 16894:
16895: Create a datatable row for display of nested categories in a domain,
16896: with checkboxes to allow a course to be categorized,called recursively.
16897:
16898: Inputs:
16899:
16900: itemcount - track row number for alternating colors
16901:
16902: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16903: categories and subcategories.
16904:
16905: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16906:
16907: parent - parent of current category item
16908:
16909: path - Array containing all categories back up through the hierarchy from the
16910: current category to the top level.
16911:
16912: currcategories - reference to array of current categories assigned to the course
16913:
1.1260 raeburn 16914: disabled - scalar (optional) contains disabled="disabled" if input elements are
16915: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16916:
1.663 raeburn 16917: Returns: $output (markup to be displayed).
16918:
16919: =cut
16920:
16921: sub assign_category_rows {
1.1259 raeburn 16922: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16923: my ($text,$name,$item,$chgstr);
16924: if (ref($cats) eq 'ARRAY') {
16925: my $maxdepth = scalar(@{$cats});
16926: if (ref($cats->[$depth]) eq 'HASH') {
16927: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16928: my $numchildren = @{$cats->[$depth]{$parent}};
16929: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16930: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16931: for (my $j=0; $j<$numchildren; $j++) {
16932: $name = $cats->[$depth]{$parent}[$j];
16933: $item = &escape($name).':'.&escape($parent).':'.$depth;
16934: my $deeper = $depth+1;
16935: my $checked = '';
16936: if (ref($currcategories) eq 'ARRAY') {
16937: if (@{$currcategories} > 0) {
16938: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16939: $checked = ' checked="checked"';
1.663 raeburn 16940: }
16941: }
16942: }
1.664 raeburn 16943: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16944: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16945: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16946: '<input type="hidden" name="catname" value="'.$name.'" />'.
16947: '</td><td>';
1.663 raeburn 16948: if (ref($path) eq 'ARRAY') {
16949: push(@{$path},$name);
1.1259 raeburn 16950: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16951: pop(@{$path});
16952: }
16953: $text .= '</td></tr>';
16954: }
16955: $text .= '</table></td>';
16956: }
16957: }
16958: }
16959: return $text;
16960: }
16961:
1.1181 raeburn 16962: =pod
16963:
16964: =back
16965:
16966: =cut
16967:
1.655 raeburn 16968: ############################################################
16969: ############################################################
16970:
16971:
1.443 albertel 16972: sub commit_customrole {
1.1408 raeburn 16973: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16974: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16975: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16976: $context,$othdomby,$requester);
1.630 raeburn 16977: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16978: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16979: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16980: if (wantarray) {
16981: return ($output,$result);
16982: } else {
16983: return $output;
16984: }
1.443 albertel 16985: }
16986:
16987: sub commit_standardrole {
1.1408 raeburn 16988: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16989: $othdomby,$requester) = @_;
1.1399 raeburn 16990: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16991: if ($context eq 'auto') {
16992: $linefeed = "\n";
16993: } else {
16994: $linefeed = "<br />\n";
16995: }
1.443 albertel 16996: if ($three eq 'st') {
1.1399 raeburn 16997: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16998: $one,$two,$sec,$context,$credits,$othdomby,
16999: $requester);
1.541 raeburn 17000: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 17001: ($result eq 'unknown_course') || ($result eq 'refused')) {
17002: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 17003: } else {
1.541 raeburn 17004: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 17005: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17006: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
17007: if ($context eq 'auto') {
17008: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
17009: } else {
17010: $output .= '<b>'.$result.'</b>'.$linefeed.
17011: &mt('Add to classlist').': <b>ok</b>';
17012: }
17013: $output .= $linefeed;
1.443 albertel 17014: }
17015: } else {
17016: $output = &mt('Assigning').' '.$three.' in '.$url.
17017: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17018: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17019: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17020: '','',$context,$othdomby,$requester);
1.541 raeburn 17021: if ($context eq 'auto') {
17022: $output .= $result.$linefeed;
17023: } else {
17024: $output .= '<b>'.$result.'</b>'.$linefeed;
17025: }
1.443 albertel 17026: }
1.1399 raeburn 17027: if (wantarray) {
17028: return ($output,$result);
17029: } else {
17030: return $output;
17031: }
1.443 albertel 17032: }
17033:
17034: sub commit_studentrole {
1.1116 raeburn 17035: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17036: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17037: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17038: if ($context eq 'auto') {
17039: $linefeed = "\n";
17040: } else {
17041: $linefeed = '<br />'."\n";
17042: }
1.443 albertel 17043: if (defined($one) && defined($two)) {
17044: my $cid=$one.'_'.$two;
17045: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17046: my $secchange = 0;
17047: my $expire_role_result;
17048: my $modify_section_result;
1.628 raeburn 17049: if ($oldsec ne '-1') {
17050: if ($oldsec ne $sec) {
1.443 albertel 17051: $secchange = 1;
1.628 raeburn 17052: my $now = time;
1.443 albertel 17053: my $uurl='/'.$cid;
17054: $uurl=~s/\_/\//g;
17055: if ($oldsec) {
17056: $uurl.='/'.$oldsec;
17057: }
1.626 raeburn 17058: $oldsecurl = $uurl;
1.628 raeburn 17059: $expire_role_result =
1.1408 raeburn 17060: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17061: '','','',$context,$othdomby,$requester);
17062: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17063: if ($expire_role_result eq 'refused') {
17064: my @roles = ('st');
17065: my @statuses = ('previous');
17066: my @roledoms = ($one);
17067: my $withsec = 1;
17068: my %roleshash =
17069: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17070: \@statuses,\@roles,\@roledoms,$withsec);
17071: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17072: my ($oldstart,$oldend) =
17073: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17074: if ($oldend > 0 && $oldend <= $now) {
17075: $expire_role_result = 'ok';
17076: }
17077: }
17078: }
17079: }
1.443 albertel 17080: $result = $expire_role_result;
17081: }
17082: }
17083: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17084: $modify_section_result =
17085: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17086: undef,undef,undef,$sec,
17087: $end,$start,'','',$cid,
1.1408 raeburn 17088: '',$context,$credits,'',
17089: $othdomby,$requester);
1.443 albertel 17090: if ($modify_section_result =~ /^ok/) {
17091: if ($secchange == 1) {
1.628 raeburn 17092: if ($sec eq '') {
17093: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17094: } else {
17095: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17096: }
1.443 albertel 17097: } elsif ($oldsec eq '-1') {
1.628 raeburn 17098: if ($sec eq '') {
17099: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17100: } else {
17101: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17102: }
1.443 albertel 17103: } else {
1.628 raeburn 17104: if ($sec eq '') {
17105: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17106: } else {
17107: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17108: }
1.443 albertel 17109: }
17110: } else {
1.1115 raeburn 17111: if ($secchange) {
1.628 raeburn 17112: $$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;
17113: } else {
17114: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17115: }
1.443 albertel 17116: }
17117: $result = $modify_section_result;
17118: } elsif ($secchange == 1) {
1.628 raeburn 17119: if ($oldsec eq '') {
1.1103 raeburn 17120: $$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 17121: } else {
17122: $$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;
17123: }
1.626 raeburn 17124: if ($expire_role_result eq 'refused') {
17125: my $newsecurl = '/'.$cid;
17126: $newsecurl =~ s/\_/\//g;
17127: if ($sec ne '') {
17128: $newsecurl.='/'.$sec;
17129: }
17130: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17131: if ($sec eq '') {
17132: $$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;
17133: } else {
17134: $$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;
17135: }
17136: }
17137: }
1.443 albertel 17138: }
17139: } else {
1.626 raeburn 17140: $$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 17141: $result = "error: incomplete course id\n";
17142: }
17143: return $result;
17144: }
17145:
1.1108 raeburn 17146: sub show_role_extent {
17147: my ($scope,$context,$role) = @_;
17148: $scope =~ s{^/}{};
17149: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17150: push(@courseroles,'co');
17151: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17152: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17153: $scope =~ s{/}{_};
17154: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17155: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17156: my ($audom,$auname) = split(/\//,$scope);
17157: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17158: &Apache::loncommon::plainname($auname,$audom).'</span>');
17159: } else {
17160: $scope =~ s{/$}{};
17161: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17162: &Apache::lonnet::domain($scope,'description').'</span>');
17163: }
17164: }
17165:
1.443 albertel 17166: ############################################################
17167: ############################################################
17168:
1.566 albertel 17169: sub check_clone {
1.578 raeburn 17170: my ($args,$linefeed) = @_;
1.566 albertel 17171: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17172: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17173: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17174: my $clonetitle;
17175: my @clonemsg;
1.566 albertel 17176: my $can_clone = 0;
1.944 raeburn 17177: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17178: if ($lctype ne 'community') {
17179: $lctype = 'course';
17180: }
1.566 albertel 17181: if ($clonehome eq 'no_host') {
1.944 raeburn 17182: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17183: push(@clonemsg,({
17184: mt => 'No new community created.',
17185: args => [],
17186: },
17187: {
17188: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17189: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17190: }));
1.908 raeburn 17191: } else {
1.1344 raeburn 17192: push(@clonemsg,({
17193: mt => 'No new course created.',
17194: args => [],
17195: },
17196: {
17197: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17198: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17199: }));
17200: }
1.566 albertel 17201: } else {
17202: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17203: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17204: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17205: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17206: push(@clonemsg,({
17207: mt => 'No new community created.',
17208: args => [],
17209: },
17210: {
17211: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17212: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17213: }));
17214: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17215: }
17216: }
1.1262 raeburn 17217: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17218: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17219: $can_clone = 1;
17220: } else {
1.1221 raeburn 17221: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17222: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17223: if ($clonehash{'cloners'} eq '') {
17224: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17225: if ($domdefs{'canclone'}) {
17226: unless ($domdefs{'canclone'} eq 'none') {
17227: if ($domdefs{'canclone'} eq 'domain') {
17228: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17229: $can_clone = 1;
17230: }
17231: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17232: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17233: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17234: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17235: $can_clone = 1;
17236: }
17237: }
17238: }
17239: }
1.578 raeburn 17240: } else {
1.1221 raeburn 17241: my @cloners = split(/,/,$clonehash{'cloners'});
17242: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17243: $can_clone = 1;
1.1221 raeburn 17244: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17245: $can_clone = 1;
1.1225 raeburn 17246: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17247: $can_clone = 1;
1.1221 raeburn 17248: }
17249: unless ($can_clone) {
1.1225 raeburn 17250: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17251: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17252: my (%gotdomdefaults,%gotcodedefaults);
17253: foreach my $cloner (@cloners) {
17254: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17255: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17256: my (%codedefaults,@code_order);
17257: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17258: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17259: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17260: }
17261: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17262: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17263: }
17264: } else {
17265: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17266: \%codedefaults,
17267: \@code_order);
17268: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17269: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17270: }
17271: if (@code_order > 0) {
17272: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17273: $cloner,$clonehash{'internal.coursecode'},
17274: $args->{'crscode'})) {
17275: $can_clone = 1;
17276: last;
17277: }
17278: }
17279: }
17280: }
17281: }
1.1225 raeburn 17282: }
17283: }
17284: unless ($can_clone) {
17285: my $ccrole = 'cc';
17286: if ($args->{'crstype'} eq 'Community') {
17287: $ccrole = 'co';
17288: }
17289: my %roleshash =
17290: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17291: $args->{'ccdomain'},
17292: 'userroles',['active'],[$ccrole],
17293: [$args->{'clonedomain'}]);
17294: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17295: $can_clone = 1;
17296: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17297: $args->{'ccuname'},$args->{'ccdomain'})) {
17298: $can_clone = 1;
1.1221 raeburn 17299: }
17300: }
17301: unless ($can_clone) {
17302: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17303: push(@clonemsg,({
17304: mt => 'No new community created.',
17305: args => [],
17306: },
17307: {
17308: 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]).',
17309: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17310: }));
1.942 raeburn 17311: } else {
1.1344 raeburn 17312: push(@clonemsg,({
17313: mt => 'No new course created.',
17314: args => [],
17315: },
17316: {
17317: 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]).',
17318: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17319: }));
1.1221 raeburn 17320: }
1.566 albertel 17321: }
1.578 raeburn 17322: }
1.566 albertel 17323: }
1.1344 raeburn 17324: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17325: }
17326:
1.444 albertel 17327: sub construct_course {
1.1262 raeburn 17328: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17329: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17330: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17331: my $linefeed = '<br />'."\n";
17332: if ($context eq 'auto') {
17333: $linefeed = "\n";
17334: }
1.566 albertel 17335:
17336: #
17337: # Are we cloning?
17338: #
1.1344 raeburn 17339: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17340: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17341: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17342: if (!$can_clone) {
1.1344 raeburn 17343: return (0,$outcome,$clonemsgref);
1.566 albertel 17344: }
17345: }
17346:
1.444 albertel 17347: #
17348: # Open course
17349: #
1.1239 raeburn 17350: my $showncrstype;
17351: if ($args->{'crstype'} eq 'Placement') {
17352: $showncrstype = 'placement test';
17353: } else {
17354: $showncrstype = lc($args->{'crstype'});
17355: }
1.444 albertel 17356: my %cenv=();
17357: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17358: $args->{'cdescr'},
17359: $args->{'curl'},
17360: $args->{'course_home'},
17361: $args->{'nonstandard'},
17362: $args->{'crscode'},
17363: $args->{'ccuname'}.':'.
17364: $args->{'ccdomain'},
1.882 raeburn 17365: $args->{'crstype'},
1.1344 raeburn 17366: $cnum,$context,$category,
17367: $callercontext);
1.444 albertel 17368:
17369: # Note: The testing routines depend on this being output; see
17370: # Utils::Course. This needs to at least be output as a comment
17371: # if anyone ever decides to not show this, and Utils::Course::new
17372: # will need to be suitably modified.
1.1344 raeburn 17373: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17374: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17375: } else {
17376: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17377: }
1.943 raeburn 17378: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17379: return (0,$outcome,$clonemsgref);
1.943 raeburn 17380: }
17381:
1.444 albertel 17382: #
17383: # Check if created correctly
17384: #
1.479 albertel 17385: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17386: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17387: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17388: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17389: $outcome .= &mt_user($user_lh,
17390: 'Course creation failed, unrecognized course home server.');
17391: } else {
17392: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17393: }
17394: $outcome .= $linefeed;
17395: return (0,$outcome,$clonemsgref);
1.943 raeburn 17396: }
1.541 raeburn 17397: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17398:
1.444 albertel 17399: #
1.566 albertel 17400: # Do the cloning
17401: #
1.1344 raeburn 17402: my @clonemsg;
1.566 albertel 17403: if ($can_clone && $cloneid) {
1.1344 raeburn 17404: push(@clonemsg,
17405: {
17406: mt => 'Created [_1] by cloning from [_2]',
17407: args => [$showncrstype,$clonetitle],
17408: });
1.566 albertel 17409: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17410: # Copy all files
1.1344 raeburn 17411: my @info =
17412: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17413: $args->{'dateshift'},$args->{'crscode'},
17414: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17415: $args->{'tinyurls'});
17416: if (@info) {
17417: push(@clonemsg,@info);
17418: }
1.444 albertel 17419: # Restore URL
1.566 albertel 17420: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17421: # Restore title
1.566 albertel 17422: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17423: # Restore creation date, creator and creation context.
17424: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17425: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17426: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17427: # Mark as cloned
1.566 albertel 17428: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17429: # Need to clone grading mode
17430: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17431: $cenv{'grading'}=$newenv{'grading'};
17432: # Do not clone these environment entries
17433: &Apache::lonnet::del('environment',
17434: ['default_enrollment_start_date',
17435: 'default_enrollment_end_date',
17436: 'question.email',
17437: 'policy.email',
17438: 'comment.email',
17439: 'pch.users.denied',
1.725 raeburn 17440: 'plc.users.denied',
17441: 'hidefromcat',
1.1121 raeburn 17442: 'checkforpriv',
1.1355 raeburn 17443: 'categories'],
1.638 www 17444: $$crsudom,$$crsunum);
1.1170 raeburn 17445: if ($args->{'textbook'}) {
17446: $cenv{'internal.textbook'} = $args->{'textbook'};
17447: }
1.444 albertel 17448: }
1.566 albertel 17449:
1.444 albertel 17450: #
17451: # Set environment (will override cloned, if existing)
17452: #
17453: my @sections = ();
17454: my @xlists = ();
17455: if ($args->{'crstype'}) {
17456: $cenv{'type'}=$args->{'crstype'};
17457: }
1.1371 raeburn 17458: if ($args->{'lti'}) {
17459: $cenv{'internal.lti'}=$args->{'lti'};
17460: }
1.444 albertel 17461: if ($args->{'crsid'}) {
17462: $cenv{'courseid'}=$args->{'crsid'};
17463: }
17464: if ($args->{'crscode'}) {
17465: $cenv{'internal.coursecode'}=$args->{'crscode'};
17466: }
17467: if ($args->{'crsquota'} ne '') {
17468: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17469: } else {
17470: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17471: }
17472: if ($args->{'ccuname'}) {
17473: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17474: ':'.$args->{'ccdomain'};
17475: } else {
17476: $cenv{'internal.courseowner'} = $args->{'curruser'};
17477: }
1.1116 raeburn 17478: if ($args->{'defaultcredits'}) {
17479: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17480: }
1.444 albertel 17481: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17482: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17483: if ($args->{'crssections'}) {
17484: $cenv{'internal.sectionnums'} = '';
17485: if ($args->{'crssections'} =~ m/,/) {
17486: @sections = split/,/,$args->{'crssections'};
17487: } else {
17488: $sections[0] = $args->{'crssections'};
17489: }
17490: if (@sections > 0) {
17491: foreach my $item (@sections) {
17492: my ($sec,$gp) = split/:/,$item;
17493: my $class = $args->{'crscode'}.$sec;
17494: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17495: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17496: if ($addcheck eq 'ok') {
17497: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17498: push(@oklcsecs,$gp);
17499: }
17500: } else {
1.1263 raeburn 17501: push(@badclasses,$class);
1.444 albertel 17502: }
17503: }
17504: $cenv{'internal.sectionnums'} =~ s/,$//;
17505: }
17506: }
17507: # do not hide course coordinator from staff listing,
17508: # even if privileged
17509: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17510: # add course coordinator's domain to domains to check for privileged users
17511: # if different to course domain
17512: if ($$crsudom ne $args->{'ccdomain'}) {
17513: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17514: }
1.444 albertel 17515: # add crosslistings
17516: if ($args->{'crsxlist'}) {
17517: $cenv{'internal.crosslistings'}='';
17518: if ($args->{'crsxlist'} =~ m/,/) {
17519: @xlists = split/,/,$args->{'crsxlist'};
17520: } else {
17521: $xlists[0] = $args->{'crsxlist'};
17522: }
17523: if (@xlists > 0) {
17524: foreach my $item (@xlists) {
17525: my ($xl,$gp) = split/:/,$item;
17526: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17527: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17528: if ($addcheck eq 'ok') {
17529: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17530: push(@oklcsecs,$gp);
17531: }
17532: } else {
1.1263 raeburn 17533: push(@badclasses,$xl);
1.444 albertel 17534: }
17535: }
17536: $cenv{'internal.crosslistings'} =~ s/,$//;
17537: }
17538: }
17539: if ($args->{'autoadds'}) {
17540: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17541: }
17542: if ($args->{'autodrops'}) {
17543: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17544: }
17545: # check for notification of enrollment changes
17546: my @notified = ();
17547: if ($args->{'notify_owner'}) {
17548: if ($args->{'ccuname'} ne '') {
17549: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17550: }
17551: }
17552: if ($args->{'notify_dc'}) {
17553: if ($uname ne '') {
1.630 raeburn 17554: push(@notified,$uname.':'.$udom);
1.444 albertel 17555: }
17556: }
17557: if (@notified > 0) {
17558: my $notifylist;
17559: if (@notified > 1) {
17560: $notifylist = join(',',@notified);
17561: } else {
17562: $notifylist = $notified[0];
17563: }
17564: $cenv{'internal.notifylist'} = $notifylist;
17565: }
17566: if (@badclasses > 0) {
17567: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17568: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17569: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17570: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17571: );
1.1264 raeburn 17572: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17573: &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 17574: if ($context eq 'auto') {
17575: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17576: } else {
1.566 albertel 17577: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17578: }
17579: foreach my $item (@badclasses) {
1.541 raeburn 17580: if ($context eq 'auto') {
1.1261 raeburn 17581: $outcome .= " - $item\n";
1.541 raeburn 17582: } else {
1.1261 raeburn 17583: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17584: }
1.1261 raeburn 17585: }
17586: if ($context eq 'auto') {
17587: $outcome .= $linefeed;
17588: } else {
17589: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17590: }
1.444 albertel 17591: }
17592: if ($args->{'no_end_date'}) {
17593: $args->{'endaccess'} = 0;
17594: }
1.1412 raeburn 17595: # If an official course with institutional sections is created by cloning
17596: # an existing course, section-specific hiding of course totals in student's
17597: # view of grades as copied from cloned course, will be checked for valid
17598: # sections.
17599: if (($can_clone && $cloneid) &&
17600: ($cenv{'internal.coursecode'} ne '') &&
17601: ($cenv{'grading'} eq 'standard') &&
17602: ($cenv{'hidetotals'} ne '') &&
17603: ($cenv{'hidetotals'} ne 'all')) {
17604: my @hidesecs;
17605: my $deletehidetotals;
17606: if (@oklcsecs) {
17607: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17608: if (grep(/^\Q$sec$/,@oklcsecs)) {
17609: push(@hidesecs,$sec);
17610: }
17611: }
17612: if (@hidesecs) {
17613: $cenv{'hidetotals'} = join(',',@hidesecs);
17614: } else {
17615: $deletehidetotals = 1;
17616: }
17617: } else {
17618: $deletehidetotals = 1;
17619: }
17620: if ($deletehidetotals) {
17621: delete($cenv{'hidetotals'});
17622: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17623: }
17624: }
1.444 albertel 17625: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17626: $cenv{'internal.autoend'}=$args->{'enrollend'};
17627: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17628: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17629: if ($args->{'showphotos'}) {
17630: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17631: }
17632: $cenv{'internal.authtype'} = $args->{'authtype'};
17633: $cenv{'internal.autharg'} = $args->{'autharg'};
17634: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17635: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17636: 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');
17637: if ($context eq 'auto') {
17638: $outcome .= $krb_msg;
17639: } else {
1.566 albertel 17640: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17641: }
17642: $outcome .= $linefeed;
1.444 albertel 17643: }
17644: }
17645: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17646: if ($args->{'setpolicy'}) {
17647: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17648: }
17649: if ($args->{'setcontent'}) {
17650: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17651: }
1.1251 raeburn 17652: if ($args->{'setcomment'}) {
17653: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17654: }
1.444 albertel 17655: }
17656: if ($args->{'reshome'}) {
17657: $cenv{'reshome'}=$args->{'reshome'}.'/';
17658: $cenv{'reshome'}=~s/\/+$/\//;
17659: }
17660: #
17661: # course has keyed access
17662: #
17663: if ($args->{'setkeys'}) {
17664: $cenv{'keyaccess'}='yes';
17665: }
17666: # if specified, key authority is not course, but user
17667: # only active if keyaccess is yes
17668: if ($args->{'keyauth'}) {
1.487 albertel 17669: my ($user,$domain) = split(':',$args->{'keyauth'});
17670: $user = &LONCAPA::clean_username($user);
17671: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17672: if ($user ne '' && $domain ne '') {
1.487 albertel 17673: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17674: }
17675: }
17676:
1.1166 raeburn 17677: #
1.1167 raeburn 17678: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17679: #
17680: if ($args->{'uniquecode'}) {
17681: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17682: if ($code) {
17683: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17684: my %crsinfo =
17685: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17686: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17687: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17688: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17689: }
1.1166 raeburn 17690: if (ref($coderef)) {
17691: $$coderef = $code;
17692: }
17693: }
17694: }
17695:
1.444 albertel 17696: if ($args->{'disresdis'}) {
17697: $cenv{'pch.roles.denied'}='st';
17698: }
17699: if ($args->{'disablechat'}) {
17700: $cenv{'plc.roles.denied'}='st';
17701: }
17702:
17703: # Record we've not yet viewed the Course Initialization Helper for this
17704: # course
17705: $cenv{'course.helper.not.run'} = 1;
17706: #
17707: # Use new Randomseed
17708: #
17709: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17710: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17711: #
17712: # The encryption code and receipt prefix for this course
17713: #
17714: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17715: $cenv{'internal.encpref'}=100+int(9*rand(99));
17716: #
17717: # By default, use standard grading
17718: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17719:
1.541 raeburn 17720: $outcome .= $linefeed.&mt('Setting environment').': '.
17721: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17722: #
17723: # Open all assignments
17724: #
17725: if ($args->{'openall'}) {
1.1341 raeburn 17726: my $opendate = time;
17727: if ($args->{'openallfrom'} =~ /^\d+$/) {
17728: $opendate = $args->{'openallfrom'};
17729: }
1.444 albertel 17730: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17731: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17732: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17733: $outcome .= &mt('All assignments open starting [_1]',
17734: &Apache::lonlocal::locallocaltime($opendate)).': '.
17735: &Apache::lonnet::cput
17736: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17737: }
17738: #
17739: # Set first page
17740: #
17741: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17742: || ($cloneid)) {
17743: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17744:
17745: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17746: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17747:
1.444 albertel 17748: $outcome .= ($fatal?$errtext:'read ok').' - ';
17749: my $title; my $url;
17750: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17751: $title=&mt('Syllabus');
1.444 albertel 17752: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17753: } else {
1.963 raeburn 17754: $title=&mt('Table of Contents');
1.444 albertel 17755: $url='/adm/navmaps';
17756: }
1.445 albertel 17757:
17758: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17759: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17760:
17761: if ($errtext) { $fatal=2; }
1.541 raeburn 17762: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17763: }
1.566 albertel 17764:
1.1237 raeburn 17765: #
17766: # Set params for Placement Tests
17767: #
1.1239 raeburn 17768: if ($args->{'crstype'} eq 'Placement') {
17769: my %storecontent;
17770: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17771: my %defaults = (
17772: buttonshide => { value => 'yes',
17773: type => 'string_yesno',},
17774: type => { value => 'randomizetry',
17775: type => 'string_questiontype',},
17776: maxtries => { value => 1,
17777: type => 'int_pos',},
17778: problemstatus => { value => 'no',
17779: type => 'string_problemstatus',},
17780: );
17781: foreach my $key (keys(%defaults)) {
17782: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17783: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17784: }
1.1237 raeburn 17785: &Apache::lonnet::cput
17786: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17787: }
17788:
1.1344 raeburn 17789: return (1,$outcome,\@clonemsg);
1.444 albertel 17790: }
17791:
1.1166 raeburn 17792: sub make_unique_code {
17793: my ($cdom,$cnum) = @_;
17794: # get lock on uniquecodes db
17795: my $lockhash = {
17796: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17797: ':'.$env{'user.domain'},
17798: };
17799: my $tries = 0;
17800: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17801: my ($code,$error);
17802:
17803: while (($gotlock ne 'ok') && ($tries<3)) {
17804: $tries ++;
17805: sleep 1;
17806: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17807: }
17808: if ($gotlock eq 'ok') {
17809: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17810: my $gotcode;
17811: my $attempts = 0;
17812: while ((!$gotcode) && ($attempts < 100)) {
17813: $code = &generate_code();
17814: if (!exists($currcodes{$code})) {
17815: $gotcode = 1;
17816: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17817: $error = 'nostore';
17818: }
17819: }
17820: $attempts ++;
17821: }
17822: my @del_lock = ($cnum."\0".'uniquecodes');
17823: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17824: } else {
17825: $error = 'nolock';
17826: }
17827: return ($code,$error);
17828: }
17829:
17830: sub generate_code {
17831: my $code;
17832: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17833: for (my $i=0; $i<6; $i++) {
17834: my $lettnum = int (rand 2);
17835: my $item = '';
17836: if ($lettnum) {
17837: $item = $letts[int( rand(18) )];
17838: } else {
17839: $item = 1+int( rand(8) );
17840: }
17841: $code .= $item;
17842: }
17843: return $code;
17844: }
17845:
1.444 albertel 17846: ############################################################
17847: ############################################################
17848:
1.1237 raeburn 17849: # Community, Course and Placement Test
1.378 raeburn 17850: sub course_type {
17851: my ($cid) = @_;
17852: if (!defined($cid)) {
17853: $cid = $env{'request.course.id'};
17854: }
1.404 albertel 17855: if (defined($env{'course.'.$cid.'.type'})) {
17856: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17857: } else {
17858: return 'Course';
1.377 raeburn 17859: }
17860: }
1.156 albertel 17861:
1.406 raeburn 17862: sub group_term {
17863: my $crstype = &course_type();
17864: my %names = (
17865: 'Course' => 'group',
1.865 raeburn 17866: 'Community' => 'group',
1.1237 raeburn 17867: 'Placement' => 'group',
1.406 raeburn 17868: );
17869: return $names{$crstype};
17870: }
17871:
1.902 raeburn 17872: sub course_types {
1.1310 raeburn 17873: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17874: my %typename = (
17875: official => 'Official course',
17876: unofficial => 'Unofficial course',
17877: community => 'Community',
1.1165 raeburn 17878: textbook => 'Textbook course',
1.1237 raeburn 17879: placement => 'Placement test',
1.1310 raeburn 17880: lti => 'LTI provider',
1.902 raeburn 17881: );
17882: return (\@types,\%typename);
17883: }
17884:
1.156 albertel 17885: sub icon {
17886: my ($file)=@_;
1.505 albertel 17887: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17888: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17889: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17890: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17891: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17892: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17893: $curfext.".gif") {
17894: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17895: $curfext.".gif";
17896: }
17897: }
1.249 albertel 17898: return &lonhttpdurl($iconname);
1.154 albertel 17899: }
1.84 albertel 17900:
1.575 albertel 17901: sub lonhttpdurl {
1.692 www 17902: #
17903: # Had been used for "small fry" static images on separate port 8080.
17904: # Modify here if lightweight http functionality desired again.
17905: # Currently eliminated due to increasing firewall issues.
17906: #
1.575 albertel 17907: my ($url)=@_;
1.692 www 17908: return $url;
1.215 albertel 17909: }
17910:
1.213 albertel 17911: sub connection_aborted {
17912: my ($r)=@_;
17913: $r->print(" ");$r->rflush();
17914: my $c = $r->connection;
17915: return $c->aborted();
17916: }
17917:
1.221 foxr 17918: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17919: # strings as 'strings'.
17920: sub escape_single {
1.221 foxr 17921: my ($input) = @_;
1.223 albertel 17922: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17923: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17924: return $input;
17925: }
1.223 albertel 17926:
1.222 foxr 17927: # Same as escape_single, but escape's "'s This
17928: # can be used for "strings"
17929: sub escape_double {
17930: my ($input) = @_;
17931: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17932: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17933: return $input;
17934: }
1.223 albertel 17935:
1.222 foxr 17936: # Escapes the last element of a full URL.
17937: sub escape_url {
17938: my ($url) = @_;
1.238 raeburn 17939: my @urlslices = split(/\//, $url,-1);
1.369 www 17940: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17941: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17942: }
1.462 albertel 17943:
1.820 raeburn 17944: sub compare_arrays {
17945: my ($arrayref1,$arrayref2) = @_;
17946: my (@difference,%count);
17947: @difference = ();
17948: %count = ();
17949: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17950: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17951: foreach my $element (keys(%count)) {
17952: if ($count{$element} == 1) {
17953: push(@difference,$element);
17954: }
17955: }
17956: }
17957: return @difference;
17958: }
17959:
1.1322 raeburn 17960: sub lon_status_items {
17961: my %defaults = (
17962: E => 100,
17963: W => 4,
17964: N => 1,
1.1324 raeburn 17965: U => 5,
1.1322 raeburn 17966: threshold => 200,
17967: sysmail => 2500,
17968: );
17969: my %names = (
17970: E => 'Errors',
17971: W => 'Warnings',
17972: N => 'Notices',
1.1324 raeburn 17973: U => 'Unsent',
1.1322 raeburn 17974: );
17975: return (\%defaults,\%names);
17976: }
17977:
1.817 bisitz 17978: # -------------------------------------------------------- Initialize user login
1.462 albertel 17979: sub init_user_environment {
1.463 albertel 17980: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17981: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17982:
17983: my $public=($username eq 'public' && $domain eq 'public');
17984:
1.1415 raeburn 17985: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17986: $coauthorenv);
1.462 albertel 17987: my $now=time;
17988:
17989: if ($public) {
17990: my $max_public=100;
17991: my $oldest;
17992: my $oldest_time=0;
17993: for(my $next=1;$next<=$max_public;$next++) {
17994: if (-e $lonids."/publicuser_$next.id") {
17995: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17996: if ($mtime<$oldest_time || !$oldest_time) {
17997: $oldest_time=$mtime;
17998: $oldest=$next;
17999: }
18000: } else {
18001: $cookie="publicuser_$next";
18002: last;
18003: }
18004: }
18005: if (!$cookie) { $cookie="publicuser_$oldest"; }
18006: } else {
1.1275 raeburn 18007: # See if old ID present, if so, remove if this isn't a robot,
18008: # killing any existing non-robot sessions
1.463 albertel 18009: if (!$args->{'robot'}) {
18010: opendir(DIR,$lonids);
18011: while ($filename=readdir(DIR)) {
18012: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 18013: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
18014: &GDBM_READER(),0640)) {
1.1295 raeburn 18015: my $linkedfile;
1.1320 raeburn 18016: if (exists($oldenv{'user.linkedenv'})) {
18017: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18018: }
1.1320 raeburn 18019: untie(%oldenv);
18020: if (unlink("$lonids/$filename")) {
18021: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18022: if (-l "$lonids/$linkedfile.id") {
18023: unlink("$lonids/$linkedfile.id");
18024: }
1.1295 raeburn 18025: }
18026: }
18027: } else {
18028: unlink($lonids.'/'.$filename);
18029: }
1.463 albertel 18030: }
1.462 albertel 18031: }
1.463 albertel 18032: closedir(DIR);
1.1204 raeburn 18033: # If there is a undeleted lockfile for the user's paste buffer remove it.
18034: my $namespace = 'nohist_courseeditor';
18035: my $lockingkey = 'paste'."\0".'locked_num';
18036: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18037: $domain,$username);
18038: if (exists($lockhash{$lockingkey})) {
18039: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18040: unless ($delresult eq 'ok') {
18041: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18042: }
18043: }
1.462 albertel 18044: }
18045: # Give them a new cookie
1.463 albertel 18046: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18047: : $now.$$.int(rand(10000)));
1.463 albertel 18048: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18049:
18050: # Initialize roles
18051:
1.1414 raeburn 18052: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18053: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18054: }
18055: # ------------------------------------ Check browser type and MathML capability
18056:
1.1194 raeburn 18057: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18058: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18059:
18060: # ------------------------------------------------------------- Get environment
18061:
18062: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18063: my ($tmp) = keys(%userenv);
1.1275 raeburn 18064: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18065: undef(%userenv);
18066: }
18067: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18068: $form->{'interface'}=$userenv{'interface'};
18069: }
18070: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18071:
18072: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18073: foreach my $option ('interface','localpath','localres') {
18074: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18075: }
18076: # --------------------------------------------------------- Write first profile
18077:
18078: {
1.1350 raeburn 18079: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18080: my %initial_env =
18081: ("user.name" => $username,
18082: "user.domain" => $domain,
18083: "user.home" => $authhost,
18084: "browser.type" => $clientbrowser,
18085: "browser.version" => $clientversion,
18086: "browser.mathml" => $clientmathml,
18087: "browser.unicode" => $clientunicode,
18088: "browser.os" => $clientos,
1.1137 raeburn 18089: "browser.mobile" => $clientmobile,
1.1141 raeburn 18090: "browser.info" => $clientinfo,
1.1194 raeburn 18091: "browser.osversion" => $clientosversion,
1.462 albertel 18092: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18093: "request.course.fn" => '',
18094: "request.course.uri" => '',
18095: "request.course.sec" => '',
18096: "request.role" => 'cm',
18097: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18098: "request.host" => $ip,);
1.462 albertel 18099:
18100: if ($form->{'localpath'}) {
18101: $initial_env{"browser.localpath"} = $form->{'localpath'};
18102: $initial_env{"browser.localres"} = $form->{'localres'};
18103: }
18104:
18105: if ($form->{'interface'}) {
18106: $form->{'interface'}=~s/\W//gs;
18107: $initial_env{"browser.interface"} = $form->{'interface'};
18108: $env{'browser.interface'}=$form->{'interface'};
18109: }
18110:
1.1157 raeburn 18111: if ($form->{'iptoken'}) {
18112: my $lonhost = $r->dir_config('lonHostID');
18113: $initial_env{"user.noloadbalance"} = $lonhost;
18114: $env{'user.noloadbalance'} = $lonhost;
18115: }
18116:
1.1268 raeburn 18117: if ($form->{'noloadbalance'}) {
18118: my @hosts = &Apache::lonnet::current_machine_ids();
18119: my $hosthere = $form->{'noloadbalance'};
18120: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18121: $initial_env{"user.noloadbalance"} = $hosthere;
18122: $env{'user.noloadbalance'} = $hosthere;
18123: }
18124: }
18125:
1.1016 raeburn 18126: unless ($domain eq 'public') {
1.1273 raeburn 18127: my %is_adv = ( is_adv => $env{'user.adv'} );
18128: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18129:
1.1414 raeburn 18130: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18131: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18132: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18133: undef,\%userenv,\%domdef,\%is_adv);
18134: }
1.980 raeburn 18135:
1.1311 raeburn 18136: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18137: $userenv{'canrequest.'.$crstype} =
18138: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18139: 'reload','requestcourses',
18140: \%userenv,\%domdef,\%is_adv);
18141: }
1.724 raeburn 18142:
1.1418 raeburn 18143: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18144: (exists($userroles->{"user.role.au./$domain/"}))) {
18145: if ($userenv{'authoreditors'}) {
18146: $userenv{'editors'} = $userenv{'authoreditors'};
18147: } elsif ($domdef{'editors'} ne '') {
18148: $userenv{'editors'} = $domdef{'editors'};
18149: } else {
18150: $userenv{'editors'} = 'edit,xml';
18151: }
1.1431 raeburn 18152: if ($userenv{'authorarchive'}) {
18153: $userenv{'canarchive'} = 1;
18154: } elsif (($userenv{'authorarchive'} eq '') &&
18155: ($domdef{'archive'})) {
18156: $userenv{'canarchive'} = 1;
18157: }
1.1418 raeburn 18158: }
18159:
1.1273 raeburn 18160: $userenv{'canrequest.author'} =
18161: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18162: 'reload','requestauthor',
1.980 raeburn 18163: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18164: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18165: $domain,$username);
18166: my $reqstatus = $reqauthor{'author_status'};
18167: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18168: if (ref($reqauthor{'author'}) eq 'HASH') {
18169: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18170: $reqauthor{'author'}{'timestamp'};
18171: }
1.1092 raeburn 18172: }
1.1287 raeburn 18173: my ($types,$typename) = &course_types();
18174: if (ref($types) eq 'ARRAY') {
18175: my @options = ('approval','validate','autolimit');
18176: my $optregex = join('|',@options);
18177: my (%willtrust,%trustchecked);
18178: foreach my $type (@{$types}) {
18179: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18180: if ($dom_str ne '') {
18181: my $updatedstr = '';
18182: my @possdomains = split(',',$dom_str);
18183: foreach my $entry (@possdomains) {
18184: my ($extdom,$extopt) = split(':',$entry);
18185: unless ($trustchecked{$extdom}) {
18186: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18187: $trustchecked{$extdom} = 1;
18188: }
18189: if ($willtrust{$extdom}) {
18190: $updatedstr .= $entry.',';
18191: }
18192: }
18193: $updatedstr =~ s/,$//;
18194: if ($updatedstr) {
18195: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18196: } else {
18197: delete($userenv{'reqcrsotherdom.'.$type});
18198: }
18199: }
18200: }
18201: }
1.1092 raeburn 18202: }
1.462 albertel 18203: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18204:
1.462 albertel 18205: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18206: &GDBM_WRCREAT(),0640)) {
18207: &_add_to_env(\%disk_env,\%initial_env);
18208: &_add_to_env(\%disk_env,\%userenv,'environment.');
18209: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18210: if (ref($firstaccenv) eq 'HASH') {
18211: &_add_to_env(\%disk_env,$firstaccenv);
18212: }
18213: if (ref($timerintenv) eq 'HASH') {
18214: &_add_to_env(\%disk_env,$timerintenv);
18215: }
1.1414 raeburn 18216: if (ref($coauthorenv) eq 'HASH') {
18217: if (keys(%{$coauthorenv})) {
18218: &_add_to_env(\%disk_env,$coauthorenv);
18219: }
18220: }
1.463 albertel 18221: if (ref($args->{'extra_env'})) {
18222: &_add_to_env(\%disk_env,$args->{'extra_env'});
18223: }
1.462 albertel 18224: untie(%disk_env);
18225: } else {
1.705 tempelho 18226: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18227: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18228: return 'error: '.$!;
18229: }
18230: }
18231: $env{'request.role'}='cm';
18232: $env{'request.role.adv'}=$env{'user.adv'};
18233: $env{'browser.type'}=$clientbrowser;
18234:
18235: return $cookie;
18236:
18237: }
18238:
18239: sub _add_to_env {
18240: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18241: if (ref($env_data) eq 'HASH') {
18242: while (my ($key,$value) = each(%$env_data)) {
18243: $idf->{$prefix.$key} = $value;
18244: $env{$prefix.$key} = $value;
18245: }
1.462 albertel 18246: }
18247: }
18248:
1.685 tempelho 18249: # --- Get the symbolic name of a problem and the url
18250: sub get_symb {
18251: my ($request,$silent) = @_;
1.726 raeburn 18252: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18253: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18254: if ($symb eq '') {
18255: if (!$silent) {
1.1071 raeburn 18256: if (ref($request)) {
18257: $request->print("Unable to handle ambiguous references:$url:.");
18258: }
1.685 tempelho 18259: return ();
18260: }
18261: }
18262: &Apache::lonenc::check_decrypt(\$symb);
18263: return ($symb);
18264: }
18265:
18266: # --------------------------------------------------------------Get annotation
18267:
18268: sub get_annotation {
18269: my ($symb,$enc) = @_;
18270:
18271: my $key = $symb;
18272: if (!$enc) {
18273: $key =
18274: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18275: }
18276: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18277: return $annotation{$key};
18278: }
18279:
18280: sub clean_symb {
1.731 raeburn 18281: my ($symb,$delete_enc) = @_;
1.685 tempelho 18282:
18283: &Apache::lonenc::check_decrypt(\$symb);
18284: my $enc = $env{'request.enc'};
1.731 raeburn 18285: if ($delete_enc) {
1.730 raeburn 18286: delete($env{'request.enc'});
18287: }
1.685 tempelho 18288:
18289: return ($symb,$enc);
18290: }
1.462 albertel 18291:
1.1181 raeburn 18292: ############################################################
18293: ############################################################
18294:
18295: =pod
18296:
18297: =head1 Routines for building display used to search for courses
18298:
18299:
18300: =over 4
18301:
18302: =item * &build_filters()
18303:
18304: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18305: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18306: and quotacheck.pl
18307:
1.1181 raeburn 18308:
18309: Inputs:
18310:
18311: filterlist - anonymous array of fields to include as potential filters
18312:
18313: crstype - course type
18314:
18315: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18316: to pop-open a course selector (will contain "extra element").
18317:
18318: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18319:
18320: filter - anonymous hash of criteria and their values
18321:
18322: action - form action
18323:
18324: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18325:
1.1182 raeburn 18326: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18327:
18328: cloneruname - username of owner of new course who wants to clone
18329:
18330: clonerudom - domain of owner of new course who wants to clone
18331:
18332: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18333:
18334: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18335:
18336: codedom - domain
18337:
18338: formname - value of form element named "form".
18339:
18340: fixeddom - domain, if fixed.
18341:
18342: prevphase - value to assign to form element named "phase" when going back to the previous screen
18343:
18344: cnameelement - name of form element in form on opener page which will receive title of selected course
18345:
18346: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18347:
18348: cdomelement - name of form element in form on opener page which will receive domain of selected course
18349:
18350: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18351:
18352: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18353:
18354: clonewarning - warning message about missing information for intended course owner when DC creates a course
18355:
1.1182 raeburn 18356:
1.1181 raeburn 18357: Returns: $output - HTML for display of search criteria, and hidden form elements.
18358:
1.1182 raeburn 18359:
1.1181 raeburn 18360: Side Effects: None
18361:
18362: =cut
18363:
18364: # ---------------------------------------------- search for courses based on last activity etc.
18365:
18366: sub build_filters {
18367: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18368: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18369: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18370: $cnameelement,$cnumelement,$cdomelement,$setroles,
18371: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18372: my ($list,$jscript);
1.1181 raeburn 18373: my $onchange = 'javascript:updateFilters(this)';
18374: my ($domainselectform,$sincefilterform,$createdfilterform,
18375: $ownerdomselectform,$persondomselectform,$instcodeform,
18376: $typeselectform,$instcodetitle);
18377: if ($formname eq '') {
18378: $formname = $caller;
18379: }
18380: foreach my $item (@{$filterlist}) {
18381: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18382: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18383: if ($item eq 'domainfilter') {
18384: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18385: } elsif ($item eq 'coursefilter') {
18386: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18387: } elsif ($item eq 'ownerfilter') {
18388: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18389: } elsif ($item eq 'ownerdomfilter') {
18390: $filter->{'ownerdomfilter'} =
18391: &LONCAPA::clean_domain($filter->{$item});
18392: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18393: 'ownerdomfilter',1);
18394: } elsif ($item eq 'personfilter') {
18395: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18396: } elsif ($item eq 'persondomfilter') {
18397: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18398: 'persondomfilter',1);
18399: } else {
18400: $filter->{$item} =~ s/\W//g;
18401: }
18402: if (!$filter->{$item}) {
18403: $filter->{$item} = '';
18404: }
18405: }
18406: if ($item eq 'domainfilter') {
18407: my $allow_blank = 1;
18408: if ($formname eq 'portform') {
18409: $allow_blank=0;
18410: } elsif ($formname eq 'studentform') {
18411: $allow_blank=0;
18412: }
18413: if ($fixeddom) {
18414: $domainselectform = '<input type="hidden" name="domainfilter"'.
18415: ' value="'.$codedom.'" />'.
18416: &Apache::lonnet::domain($codedom,'description');
18417: } else {
18418: $domainselectform = &select_dom_form($filter->{$item},
18419: 'domainfilter',
18420: $allow_blank,'',$onchange);
18421: }
18422: } else {
18423: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18424: }
18425: }
18426:
18427: # last course activity filter and selection
18428: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18429:
18430: # course created filter and selection
18431: if (exists($filter->{'createdfilter'})) {
18432: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18433: }
18434:
1.1239 raeburn 18435: my $prefix = $crstype;
18436: if ($crstype eq 'Placement') {
18437: $prefix = 'Placement Test'
18438: }
1.1181 raeburn 18439: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18440: 'cac' => "$prefix Activity",
18441: 'ccr' => "$prefix Created",
18442: 'cde' => "$prefix Title",
18443: 'cdo' => "$prefix Domain",
1.1181 raeburn 18444: 'ins' => 'Institutional Code',
18445: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18446: 'cow' => "$prefix Owner/Co-owner",
18447: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18448: 'cog' => 'Type',
18449: );
18450:
18451: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18452: my $typeval = 'Course';
18453: if ($crstype eq 'Community') {
18454: $typeval = 'Community';
1.1239 raeburn 18455: } elsif ($crstype eq 'Placement') {
18456: $typeval = 'Placement';
1.1181 raeburn 18457: }
18458: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18459: } else {
18460: $typeselectform = '<select name="type" size="1"';
18461: if ($onchange) {
18462: $typeselectform .= ' onchange="'.$onchange.'"';
18463: }
18464: $typeselectform .= '>'."\n";
1.1237 raeburn 18465: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18466: my $shown;
18467: if ($posstype eq 'Placement') {
18468: $shown = &mt('Placement Test');
18469: } else {
18470: $shown = &mt($posstype);
18471: }
1.1181 raeburn 18472: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18473: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18474: }
18475: $typeselectform.="</select>";
18476: }
18477:
18478: my ($cloneableonlyform,$cloneabletitle);
18479: if (exists($filter->{'cloneableonly'})) {
18480: my $cloneableon = '';
18481: my $cloneableoff = ' checked="checked"';
18482: if ($filter->{'cloneableonly'}) {
18483: $cloneableon = $cloneableoff;
18484: $cloneableoff = '';
18485: }
18486: $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>';
18487: if ($formname eq 'ccrs') {
1.1187 bisitz 18488: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18489: } else {
18490: $cloneabletitle = &mt('Cloneable by you');
18491: }
18492: }
18493: my $officialjs;
18494: if ($crstype eq 'Course') {
18495: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18496: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18497: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18498: if ($codedom) {
1.1181 raeburn 18499: $officialjs = 1;
18500: ($instcodeform,$jscript,$$numtitlesref) =
18501: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18502: $officialjs,$codetitlesref);
18503: if ($jscript) {
1.1182 raeburn 18504: $jscript = '<script type="text/javascript">'."\n".
18505: '// <![CDATA['."\n".
18506: $jscript."\n".
18507: '// ]]>'."\n".
18508: '</script>'."\n";
1.1181 raeburn 18509: }
18510: }
18511: if ($instcodeform eq '') {
18512: $instcodeform =
18513: '<input type="text" name="instcodefilter" size="10" value="'.
18514: $list->{'instcodefilter'}.'" />';
18515: $instcodetitle = $lt{'ins'};
18516: } else {
18517: $instcodetitle = $lt{'inc'};
18518: }
18519: if ($fixeddom) {
18520: $instcodetitle .= '<br />('.$codedom.')';
18521: }
18522: }
18523: }
18524: my $output = qq|
18525: <form method="post" name="filterpicker" action="$action">
18526: <input type="hidden" name="form" value="$formname" />
18527: |;
18528: if ($formname eq 'modifycourse') {
18529: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18530: '<input type="hidden" name="prevphase" value="'.
18531: $prevphase.'" />'."\n";
1.1198 musolffc 18532: } elsif ($formname eq 'quotacheck') {
18533: $output .= qq|
18534: <input type="hidden" name="sortby" value="" />
18535: <input type="hidden" name="sortorder" value="" />
18536: |;
18537: } else {
1.1181 raeburn 18538: my $name_input;
18539: if ($cnameelement ne '') {
18540: $name_input = '<input type="hidden" name="cnameelement" value="'.
18541: $cnameelement.'" />';
18542: }
18543: $output .= qq|
1.1182 raeburn 18544: <input type="hidden" name="cnumelement" value="$cnumelement" />
18545: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18546: $name_input
18547: $roleelement
18548: $multelement
18549: $typeelement
18550: |;
18551: if ($formname eq 'portform') {
18552: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18553: }
18554: }
18555: if ($fixeddom) {
18556: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18557: }
18558: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18559: if ($sincefilterform) {
18560: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18561: .$sincefilterform
18562: .&Apache::lonhtmlcommon::row_closure();
18563: }
18564: if ($createdfilterform) {
18565: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18566: .$createdfilterform
18567: .&Apache::lonhtmlcommon::row_closure();
18568: }
18569: if ($domainselectform) {
18570: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18571: .$domainselectform
18572: .&Apache::lonhtmlcommon::row_closure();
18573: }
18574: if ($typeselectform) {
18575: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18576: $output .= $typeselectform;
18577: } else {
18578: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18579: .$typeselectform
18580: .&Apache::lonhtmlcommon::row_closure();
18581: }
18582: }
18583: if ($instcodeform) {
18584: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18585: .$instcodeform
18586: .&Apache::lonhtmlcommon::row_closure();
18587: }
18588: if (exists($filter->{'ownerfilter'})) {
18589: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18590: '<table><tr><td>'.&mt('Username').'<br />'.
18591: '<input type="text" name="ownerfilter" size="20" value="'.
18592: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18593: $ownerdomselectform.'</td></tr></table>'.
18594: &Apache::lonhtmlcommon::row_closure();
18595: }
18596: if (exists($filter->{'personfilter'})) {
18597: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18598: '<table><tr><td>'.&mt('Username').'<br />'.
18599: '<input type="text" name="personfilter" size="20" value="'.
18600: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18601: $persondomselectform.'</td></tr></table>'.
18602: &Apache::lonhtmlcommon::row_closure();
18603: }
18604: if (exists($filter->{'coursefilter'})) {
18605: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18606: .'<input type="text" name="coursefilter" size="25" value="'
18607: .$list->{'coursefilter'}.'" />'
18608: .&Apache::lonhtmlcommon::row_closure();
18609: }
18610: if ($cloneableonlyform) {
18611: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18612: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18613: }
18614: if (exists($filter->{'descriptfilter'})) {
18615: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18616: .'<input type="text" name="descriptfilter" size="40" value="'
18617: .$list->{'descriptfilter'}.'" />'
18618: .&Apache::lonhtmlcommon::row_closure(1);
18619: }
18620: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18621: '<input type="hidden" name="updater" value="" />'."\n".
18622: '<input type="submit" name="gosearch" value="'.
18623: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18624: return $jscript.$clonewarning.$output;
18625: }
18626:
18627: =pod
18628:
18629: =item * &timebased_select_form()
18630:
1.1182 raeburn 18631: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18632: filter e.g., Course Activity, Course Created, when searching for courses
18633: or communities
18634:
18635: Inputs:
18636:
18637: item - name of form element (sincefilter or createdfilter)
18638:
18639: filter - anonymous hash of criteria and their values
18640:
18641: Returns: HTML for a select box contained a blank, then six time selections,
18642: with value set in incoming form variables currently selected.
18643:
18644: Side Effects: None
18645:
18646: =cut
18647:
18648: sub timebased_select_form {
18649: my ($item,$filter) = @_;
18650: if (ref($filter) eq 'HASH') {
18651: $filter->{$item} =~ s/[^\d-]//g;
18652: if (!$filter->{$item}) { $filter->{$item}=-1; }
18653: return &select_form(
18654: $filter->{$item},
18655: $item,
18656: { '-1' => '',
18657: '86400' => &mt('today'),
18658: '604800' => &mt('last week'),
18659: '2592000' => &mt('last month'),
18660: '7776000' => &mt('last three months'),
18661: '15552000' => &mt('last six months'),
18662: '31104000' => &mt('last year'),
18663: 'select_form_order' =>
18664: ['-1','86400','604800','2592000','7776000',
18665: '15552000','31104000']});
18666: }
18667: }
18668:
18669: =pod
18670:
18671: =item * &js_changer()
18672:
18673: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18674: when course type or domain is changed, and also to hide 'Searching ...' on
18675: page load completion for page showing search result.
1.1181 raeburn 18676:
18677: Inputs: None
18678:
1.1183 raeburn 18679: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18680:
18681: Side Effects: None
18682:
18683: =cut
18684:
18685: sub js_changer {
18686: return <<ENDJS;
18687: <script type="text/javascript">
18688: // <![CDATA[
18689: function updateFilters(caller) {
18690: if (typeof(caller) != "undefined") {
18691: document.filterpicker.updater.value = caller.name;
18692: }
18693: document.filterpicker.submit();
18694: }
1.1183 raeburn 18695:
18696: function hideSearching() {
18697: if (document.getElementById('searching')) {
18698: document.getElementById('searching').style.display = 'none';
18699: }
18700: return;
18701: }
18702:
1.1181 raeburn 18703: // ]]>
18704: </script>
18705:
18706: ENDJS
18707: }
18708:
18709: =pod
18710:
1.1182 raeburn 18711: =item * &search_courses()
18712:
18713: Process selected filters form course search form and pass to lonnet::courseiddump
18714: to retrieve a hash for which keys are courseIDs which match the selected filters.
18715:
18716: Inputs:
18717:
18718: dom - domain being searched
18719:
18720: type - course type ('Course' or 'Community' or '.' if any).
18721:
18722: filter - anonymous hash of criteria and their values
18723:
18724: numtitles - for institutional codes - number of categories
18725:
18726: cloneruname - optional username of new course owner
18727:
18728: clonerudom - optional domain of new course owner
18729:
1.1221 raeburn 18730: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18731: (used when DC is using course creation form)
18732:
18733: codetitles - reference to array of titles of components in institutional codes (official courses).
18734:
1.1221 raeburn 18735: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18736: (and so can clone automatically)
18737:
18738: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18739:
18740: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18741: courses to clone
1.1182 raeburn 18742:
18743: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18744:
18745:
18746: Side Effects: None
18747:
18748: =cut
18749:
18750:
18751: sub search_courses {
1.1221 raeburn 18752: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18753: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18754: my (%courses,%showcourses,$cloner);
18755: if (($filter->{'ownerfilter'} ne '') ||
18756: ($filter->{'ownerdomfilter'} ne '')) {
18757: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18758: $filter->{'ownerdomfilter'};
18759: }
18760: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18761: if (!$filter->{$item}) {
18762: $filter->{$item}='.';
18763: }
18764: }
18765: my $now = time;
18766: my $timefilter =
18767: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18768: my ($createdbefore,$createdafter);
18769: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18770: $createdbefore = $now;
18771: $createdafter = $now-$filter->{'createdfilter'};
18772: }
18773: my ($instcodefilter,$regexpok);
18774: if ($numtitles) {
18775: if ($env{'form.official'} eq 'on') {
18776: $instcodefilter =
18777: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18778: $regexpok = 1;
18779: } elsif ($env{'form.official'} eq 'off') {
18780: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18781: unless ($instcodefilter eq '') {
18782: $regexpok = -1;
18783: }
18784: }
18785: } else {
18786: $instcodefilter = $filter->{'instcodefilter'};
18787: }
18788: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18789: if ($type eq '') { $type = '.'; }
18790:
18791: if (($clonerudom ne '') && ($cloneruname ne '')) {
18792: $cloner = $cloneruname.':'.$clonerudom;
18793: }
18794: %courses = &Apache::lonnet::courseiddump($dom,
18795: $filter->{'descriptfilter'},
18796: $timefilter,
18797: $instcodefilter,
18798: $filter->{'combownerfilter'},
18799: $filter->{'coursefilter'},
18800: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18801: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18802: $filter->{'cloneableonly'},
18803: $createdbefore,$createdafter,undef,
1.1221 raeburn 18804: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18805: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18806: my $ccrole;
18807: if ($type eq 'Community') {
18808: $ccrole = 'co';
18809: } else {
18810: $ccrole = 'cc';
18811: }
18812: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18813: $filter->{'persondomfilter'},
18814: 'userroles',undef,
18815: [$ccrole,'in','ad','ep','ta','cr'],
18816: $dom);
18817: foreach my $role (keys(%rolehash)) {
18818: my ($cnum,$cdom,$courserole) = split(':',$role);
18819: my $cid = $cdom.'_'.$cnum;
18820: if (exists($courses{$cid})) {
18821: if (ref($courses{$cid}) eq 'HASH') {
18822: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18823: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18824: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18825: }
18826: } else {
18827: $courses{$cid}{roles} = [$courserole];
18828: }
18829: $showcourses{$cid} = $courses{$cid};
18830: }
18831: }
18832: }
18833: %courses = %showcourses;
18834: }
18835: return %courses;
18836: }
18837:
18838: =pod
18839:
1.1181 raeburn 18840: =back
18841:
1.1207 raeburn 18842: =head1 Routines for version requirements for current course.
18843:
18844: =over 4
18845:
18846: =item * &check_release_required()
18847:
18848: Compares required LON-CAPA version with version on server, and
18849: if required version is newer looks for a server with the required version.
18850:
18851: Looks first at servers in user's owen domain; if none suitable, looks at
18852: servers in course's domain are permitted to host sessions for user's domain.
18853:
18854: Inputs:
18855:
18856: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18857:
18858: $courseid - Course ID of current course
18859:
18860: $rolecode - User's current role in course (for switchserver query string).
18861:
18862: $required - LON-CAPA version needed by course (format: Major.Minor).
18863:
18864:
18865: Returns:
18866:
18867: $switchserver - query string tp append to /adm/switchserver call (if
18868: current server's LON-CAPA version is too old.
18869:
18870: $warning - Message is displayed if no suitable server could be found.
18871:
18872: =cut
18873:
18874: sub check_release_required {
18875: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18876: my ($switchserver,$warning);
18877: if ($required ne '') {
18878: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18879: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18880: if ($reqdmajor ne '' && $reqdminor ne '') {
18881: my $otherserver;
18882: if (($major eq '' && $minor eq '') ||
18883: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18884: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18885: my $switchlcrev =
18886: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18887: $userdomserver);
18888: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18889: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18890: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18891: my $cdom = $env{'course.'.$courseid.'.domain'};
18892: if ($cdom ne $env{'user.domain'}) {
18893: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18894: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18895: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18896: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18897: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18898: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18899: my $canhost =
18900: &Apache::lonnet::can_host_session($env{'user.domain'},
18901: $coursedomserver,
18902: $remoterev,
18903: $udomdefaults{'remotesessions'},
18904: $defdomdefaults{'hostedsessions'});
18905:
18906: if ($canhost) {
18907: $otherserver = $coursedomserver;
18908: } else {
18909: $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.");
18910: }
18911: } else {
18912: $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).");
18913: }
18914: } else {
18915: $otherserver = $userdomserver;
18916: }
18917: }
18918: if ($otherserver ne '') {
18919: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18920: }
18921: }
18922: }
18923: return ($switchserver,$warning);
18924: }
18925:
18926: =pod
18927:
18928: =item * &check_release_result()
18929:
18930: Inputs:
18931:
18932: $switchwarning - Warning message if no suitable server found to host session.
18933:
18934: $switchserver - query string to append to /adm/switchserver containing lonHostID
18935: and current role.
18936:
18937: Returns: HTML to display with information about requirement to switch server.
18938: Either displaying warning with link to Roles/Courses screen or
18939: display link to switchserver.
18940:
1.1181 raeburn 18941: =cut
18942:
1.1207 raeburn 18943: sub check_release_result {
18944: my ($switchwarning,$switchserver) = @_;
18945: my $output = &start_page('Selected course unavailable on this server').
18946: '<p class="LC_warning">';
18947: if ($switchwarning) {
18948: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18949: if (&show_course()) {
18950: $output .= &mt('Display courses');
18951: } else {
18952: $output .= &mt('Display roles');
18953: }
18954: $output .= '</a>';
18955: } elsif ($switchserver) {
18956: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18957: '<br />'.
18958: '<a href="/adm/switchserver?'.$switchserver.'">'.
18959: &mt('Switch Server').
18960: '</a>';
18961: }
18962: $output .= '</p>'.&end_page();
18963: return $output;
18964: }
18965:
18966: =pod
18967:
18968: =item * &needs_coursereinit()
18969:
18970: Determine if course contents stored for user's session needs to be
18971: refreshed, because content has changed since "Big Hash" last tied.
18972:
18973: Check for change is made if time last checked is more than 10 minutes ago
18974: (by default).
18975:
18976: Inputs:
18977:
18978: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18979:
18980: $interval (optional) - Time which may elapse (in s) between last check for content
18981: change in current course. (default: 600 s).
18982:
18983: Returns: an array; first element is:
18984:
18985: =over 4
18986:
18987: 'switch' - if content updates mean user's session
18988: needs to be switched to a server running a newer LON-CAPA version
18989:
18990: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18991: on current server hosting user's session
18992:
18993: '' - if no action required.
18994:
18995: =back
18996:
18997: If first item element is 'switch':
18998:
18999: second item is $switchwarning - Warning message if no suitable server found to host session.
19000:
19001: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
19002: and current role.
19003:
19004: otherwise: no other elements returned.
19005:
19006: =back
19007:
19008: =cut
19009:
19010: sub needs_coursereinit {
19011: my ($loncaparev,$interval) = @_;
19012: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
19013: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19014: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19015: my $now = time;
19016: if ($interval eq '') {
19017: $interval = 600;
19018: }
19019: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19020: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19021: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19022: if ($blocked) {
19023: return ();
19024: }
1.1391 raeburn 19025: my $update;
19026: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19027: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19028: if ($lastmainchange > $env{'request.course.tied'}) {
19029: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19030: if ($needswitch) {
19031: return ('switch',$switchwarning,$switchserver);
19032: }
19033: $update = 'main';
19034: }
19035: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19036: if ($update) {
19037: $update = 'both';
19038: } else {
19039: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19040: if ($needswitch) {
19041: return ('switch',$switchwarning,$switchserver);
19042: } else {
19043: $update = 'supp';
1.1207 raeburn 19044: }
19045: }
1.1391 raeburn 19046: return ($update);
19047: }
19048: }
19049: return ();
19050: }
19051:
19052: sub switch_for_update {
19053: my ($loncaparev,$cdom,$cnum) = @_;
19054: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19055: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19056: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19057: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19058: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19059: $curr_reqd_hash{'internal.releaserequired'}});
19060: my ($switchserver,$switchwarning) =
19061: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19062: $curr_reqd_hash{'internal.releaserequired'});
19063: if ($switchwarning ne '' || $switchserver ne '') {
19064: return ('switch',$switchwarning,$switchserver);
19065: }
1.1207 raeburn 19066: }
19067: }
19068: return ();
19069: }
1.1181 raeburn 19070:
1.1083 raeburn 19071: sub update_content_constraints {
1.1395 raeburn 19072: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19073: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19074: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19075: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19076: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19077: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19078: if ($item eq 'resourcetag') {
19079: if ($name eq 'responsetype') {
19080: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19081: }
1.1307 raeburn 19082: } elsif ($item eq 'course') {
19083: if ($name eq 'courserestype') {
19084: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19085: }
1.1083 raeburn 19086: }
19087: }
19088: my $navmap = Apache::lonnavmaps::navmap->new();
19089: if (defined($navmap)) {
1.1307 raeburn 19090: my (%allresponses,%allcrsrestypes);
19091: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19092: if ($res->is_tool()) {
19093: if ($allcrsrestypes{'exttool'}) {
19094: $allcrsrestypes{'exttool'} ++;
19095: } else {
19096: $allcrsrestypes{'exttool'} = 1;
19097: }
19098: next;
19099: }
1.1083 raeburn 19100: my %responses = $res->responseTypes();
19101: foreach my $key (keys(%responses)) {
19102: next unless(exists($checkresponsetypes{$key}));
19103: $allresponses{$key} += $responses{$key};
19104: }
19105: }
19106: foreach my $key (keys(%allresponses)) {
19107: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19108: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19109: ($reqdmajor,$reqdminor) = ($major,$minor);
19110: }
19111: }
1.1307 raeburn 19112: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19113: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19114: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19115: ($reqdmajor,$reqdminor) = ($major,$minor);
19116: }
19117: }
1.1083 raeburn 19118: undef($navmap);
19119: }
1.1391 raeburn 19120: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19121: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19122: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19123: ($reqdmajor,$reqdminor) = ($major,$minor);
19124: }
19125: }
1.1083 raeburn 19126: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19127: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19128: }
19129: return;
19130: }
19131:
1.1110 raeburn 19132: sub allmaps_incourse {
19133: my ($cdom,$cnum,$chome,$cid) = @_;
19134: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19135: $cid = $env{'request.course.id'};
19136: $cdom = $env{'course.'.$cid.'.domain'};
19137: $cnum = $env{'course.'.$cid.'.num'};
19138: $chome = $env{'course.'.$cid.'.home'};
19139: }
19140: my %allmaps = ();
19141: my $lastchange =
19142: &Apache::lonnet::get_coursechange($cdom,$cnum);
19143: if ($lastchange > $env{'request.course.tied'}) {
19144: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19145: unless ($ferr) {
1.1395 raeburn 19146: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19147: }
19148: }
19149: my $navmap = Apache::lonnavmaps::navmap->new();
19150: if (defined($navmap)) {
19151: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19152: $allmaps{$res->src()} = 1;
19153: }
19154: }
19155: return \%allmaps;
19156: }
19157:
1.1083 raeburn 19158: sub parse_supplemental_title {
19159: my ($title) = @_;
19160:
19161: my ($foldertitle,$renametitle);
19162: if ($title =~ /&&&/) {
19163: $title = &HTML::Entites::decode($title);
19164: }
19165: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19166: $renametitle=$4;
19167: my ($time,$uname,$udom) = ($1,$2,$3);
19168: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19169: my $name = &plainname($uname,$udom);
19170: $name = &HTML::Entities::encode($name,'"<>&\'');
19171: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19172: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19173: if ($foldertitle ne '') {
1.1401 raeburn 19174: $title .= ': <br />'.$foldertitle;
19175: }
1.1083 raeburn 19176: }
19177: if (wantarray) {
19178: return ($title,$foldertitle,$renametitle);
19179: }
19180: return $title;
19181: }
19182:
1.1395 raeburn 19183: sub get_supplemental {
19184: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19185: my $hashid=$cnum.':'.$cdom;
19186: my ($supplemental,$cached,$set_httprefs);
19187: unless ($ignorecache) {
19188: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19189: }
19190: unless (defined($cached)) {
19191: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19192: unless ($chome eq 'no_host') {
19193: my @order = @LONCAPA::map::order;
19194: my @resources = @LONCAPA::map::resources;
19195: my @resparms = @LONCAPA::map::resparms;
19196: my @zombies = @LONCAPA::map::zombies;
19197: my ($errors,%ids,%hidden);
19198: $errors =
19199: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19200: $errors,$possdel,\%ids,\%hidden);
19201: @LONCAPA::map::order = @order;
19202: @LONCAPA::map::resources = @resources;
19203: @LONCAPA::map::resparms = @resparms;
19204: @LONCAPA::map::zombies = @zombies;
19205: $set_httprefs = 1;
19206: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19207: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19208: }
19209: $supplemental = {
19210: ids => \%ids,
19211: hidden => \%hidden,
19212: };
19213: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19214: }
19215: }
19216: return ($supplemental,$set_httprefs);
19217: }
19218:
1.1143 raeburn 19219: sub recurse_supplemental {
1.1391 raeburn 19220: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19221: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19222: my $mapnum;
19223: if ($suppmap eq 'supplemental.sequence') {
19224: $mapnum = 0;
19225: } else {
19226: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19227: }
1.1143 raeburn 19228: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19229: if ($fatal) {
19230: $errors ++;
19231: } else {
1.1389 raeburn 19232: my @order = @LONCAPA::map::order;
19233: if (@order > 0) {
19234: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19235: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19236: foreach my $idx (@order) {
19237: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19238: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19239: my $id = $mapnum.':'.$idx;
19240: push(@{$suppids->{$src}},$id);
19241: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19242: $hiddensupp->{$id} = 1;
19243: }
1.1146 raeburn 19244: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19245: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19246: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19247: } else {
1.1391 raeburn 19248: my $allowed;
19249: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19250: $allowed = 1;
19251: } elsif ($possdel) {
19252: foreach my $item (@{$suppids->{$src}}) {
19253: next if ($item eq $id);
19254: unless ($hiddensupp->{$item}) {
19255: $allowed = 1;
19256: last;
19257: }
19258: }
19259: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19260: &Apache::lonnet::delenv('httpref.'.$src);
19261: }
19262: }
19263: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19264: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19265: }
1.1143 raeburn 19266: }
19267: }
19268: }
19269: }
19270: }
19271: }
1.1391 raeburn 19272: return $errors;
19273: }
19274:
19275: sub set_supp_httprefs {
19276: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19277: if (ref($supplemental) eq 'HASH') {
19278: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19279: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19280: next if ($src =~ /\.sequence$/);
19281: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19282: my $allowed;
19283: if ($env{'request.role.adv'}) {
19284: $allowed = 1;
19285: } else {
19286: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19287: unless ($supplemental->{'hidden'}->{$id}) {
19288: $allowed = 1;
19289: last;
19290: }
19291: }
19292: }
19293: if (exists($env{'httpref.'.$src})) {
19294: if ($possdel) {
19295: unless ($allowed) {
19296: &Apache::lonnet::delenv('httpref.'.$src);
19297: }
19298: }
19299: } elsif ($allowed) {
19300: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19301: }
19302: }
19303: }
19304: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19305: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19306: }
19307: }
19308: }
19309: }
19310:
19311: sub get_supp_parameter {
19312: my ($resparm,$name)=@_;
19313: return if ($resparm eq '');
19314: my $value=undef;
19315: my $ptype=undef;
19316: foreach (split('&&&',$resparm)) {
19317: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19318: if ($thisname eq $name) {
19319: $value=$thisvalue;
19320: $ptype=$thistype;
19321: }
19322: }
19323: return $value;
1.1143 raeburn 19324: }
19325:
1.1101 raeburn 19326: sub symb_to_docspath {
1.1267 raeburn 19327: my ($symb,$navmapref) = @_;
19328: return unless ($symb && ref($navmapref));
1.1101 raeburn 19329: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19330: if ($resurl=~/\.(sequence|page)$/) {
19331: $mapurl=$resurl;
19332: } elsif ($resurl eq 'adm/navmaps') {
19333: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19334: }
19335: my $mapresobj;
1.1267 raeburn 19336: unless (ref($$navmapref)) {
19337: $$navmapref = Apache::lonnavmaps::navmap->new();
19338: }
19339: if (ref($$navmapref)) {
19340: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19341: }
19342: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19343: my $type=$2;
19344: my $path;
19345: if (ref($mapresobj)) {
19346: my $pcslist = $mapresobj->map_hierarchy();
19347: if ($pcslist ne '') {
19348: foreach my $pc (split(/,/,$pcslist)) {
19349: next if ($pc <= 1);
1.1267 raeburn 19350: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19351: if (ref($res)) {
19352: my $thisurl = $res->src();
19353: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19354: my $thistitle = $res->title();
19355: $path .= '&'.
19356: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19357: &escape($thistitle).
1.1101 raeburn 19358: ':'.$res->randompick().
19359: ':'.$res->randomout().
19360: ':'.$res->encrypted().
19361: ':'.$res->randomorder().
19362: ':'.$res->is_page();
19363: }
19364: }
19365: }
19366: $path =~ s/^\&//;
19367: my $maptitle = $mapresobj->title();
19368: if ($mapurl eq 'default') {
1.1129 raeburn 19369: $maptitle = 'Main Content';
1.1101 raeburn 19370: }
19371: $path .= (($path ne '')? '&' : '').
19372: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19373: &escape($maptitle).
1.1101 raeburn 19374: ':'.$mapresobj->randompick().
19375: ':'.$mapresobj->randomout().
19376: ':'.$mapresobj->encrypted().
19377: ':'.$mapresobj->randomorder().
19378: ':'.$mapresobj->is_page();
19379: } else {
19380: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19381: my $ispage = (($type eq 'page')? 1 : '');
19382: if ($mapurl eq 'default') {
1.1129 raeburn 19383: $maptitle = 'Main Content';
1.1101 raeburn 19384: }
19385: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19386: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19387: }
19388: unless ($mapurl eq 'default') {
19389: $path = 'default&'.
1.1146 raeburn 19390: &escape('Main Content').
1.1101 raeburn 19391: ':::::&'.$path;
19392: }
19393: return $path;
19394: }
19395:
1.1393 raeburn 19396: sub validate_folderpath {
19397: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19398: if ($env{'form.folderpath'} ne '') {
19399: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19400: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19401: for (my $i=0; $i<@items; $i++) {
19402: my $odd = $i%2;
19403: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19404: $badpath = 1;
1.1394 raeburn 19405: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19406: my $idx = $i-1;
1.1394 raeburn 19407: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19408: my $esc_name = $1;
19409: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19410: $supppath .= '&'.$esc_name;
19411: $changed = 1;
19412: } else {
19413: $supppath .= '&'.$items[$i];
19414: }
19415: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19416: $changed = 1;
1.1393 raeburn 19417: my $is_hidden;
19418: unless ($got_supp) {
1.1395 raeburn 19419: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19420: if (ref($supplemental) eq 'HASH') {
19421: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19422: %supphidden = %{$supplemental->{'hidden'}};
19423: }
19424: if (ref($supplemental->{'ids'}) eq 'HASH') {
19425: %suppids = %{$supplemental->{'ids'}};
19426: }
19427: }
19428: $got_supp = 1;
19429: }
19430: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19431: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19432: if ($supphidden{$mapid}) {
19433: $is_hidden = 1;
19434: }
19435: }
1.1394 raeburn 19436: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19437: } else {
19438: $supppath .= '&'.$items[$i];
1.1393 raeburn 19439: }
19440: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19441: $badpath = 1;
1.1394 raeburn 19442: } elsif ($supplementalflag) {
1.1393 raeburn 19443: $supppath .= '&'.$items[$i];
19444: }
19445: last if ($badpath);
19446: }
19447: if ($badpath) {
19448: delete($env{'form.folderpath'});
1.1394 raeburn 19449: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19450: $supppath =~ s/^\&//;
19451: $env{'form.folderpath'} = $supppath;
19452: }
19453: }
19454: return;
19455: }
19456:
1.1094 raeburn 19457: sub captcha_display {
1.1327 raeburn 19458: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19459: my ($output,$error);
1.1234 raeburn 19460: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19461: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19462: if ($captcha eq 'original') {
1.1094 raeburn 19463: $output = &create_captcha();
19464: unless ($output) {
1.1172 raeburn 19465: $error = 'captcha';
1.1094 raeburn 19466: }
19467: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19468: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19469: unless ($output) {
1.1172 raeburn 19470: $error = 'recaptcha';
1.1094 raeburn 19471: }
19472: }
1.1234 raeburn 19473: return ($output,$error,$captcha,$version);
1.1094 raeburn 19474: }
19475:
19476: sub captcha_response {
1.1327 raeburn 19477: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19478: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19479: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19480: if ($captcha eq 'original') {
1.1094 raeburn 19481: ($captcha_chk,$captcha_error) = &check_captcha();
19482: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19483: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19484: } else {
19485: $captcha_chk = 1;
19486: }
19487: return ($captcha_chk,$captcha_error);
19488: }
19489:
19490: sub get_captcha_config {
1.1327 raeburn 19491: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19492: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19493: my $hostname = &Apache::lonnet::hostname($lonhost);
19494: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19495: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19496: if ($context eq 'usercreation') {
19497: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19498: if (ref($domconfig{$context}) eq 'HASH') {
19499: $hashtocheck = $domconfig{$context}{'cancreate'};
19500: if (ref($hashtocheck) eq 'HASH') {
19501: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19502: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19503: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19504: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19505: }
19506: if ($privkey && $pubkey) {
19507: $captcha = 'recaptcha';
1.1234 raeburn 19508: $version = $hashtocheck->{'recaptchaversion'};
19509: if ($version ne '2') {
19510: $version = 1;
19511: }
1.1095 raeburn 19512: } else {
19513: $captcha = 'original';
19514: }
19515: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19516: $captcha = 'original';
19517: }
1.1094 raeburn 19518: }
1.1095 raeburn 19519: } else {
19520: $captcha = 'captcha';
19521: }
19522: } elsif ($context eq 'login') {
19523: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19524: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19525: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19526: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19527: if ($privkey && $pubkey) {
19528: $captcha = 'recaptcha';
1.1234 raeburn 19529: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19530: if ($version ne '2') {
19531: $version = 1;
19532: }
1.1095 raeburn 19533: } else {
19534: $captcha = 'original';
1.1094 raeburn 19535: }
1.1095 raeburn 19536: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19537: $captcha = 'original';
1.1094 raeburn 19538: }
1.1327 raeburn 19539: } elsif ($context eq 'passwords') {
19540: if ($dom_in_effect) {
19541: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19542: if ($passwdconf{'captcha'} eq 'recaptcha') {
19543: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19544: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19545: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19546: }
19547: if ($privkey && $pubkey) {
19548: $captcha = 'recaptcha';
19549: $version = $passwdconf{'recaptchaversion'};
19550: if ($version ne '2') {
19551: $version = 1;
19552: }
19553: } else {
19554: $captcha = 'original';
19555: }
19556: } elsif ($passwdconf{'captcha'} ne 'notused') {
19557: $captcha = 'original';
19558: }
19559: }
19560: }
1.1234 raeburn 19561: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19562: }
19563:
19564: sub create_captcha {
19565: my %captcha_params = &captcha_settings();
19566: my ($output,$maxtries,$tries) = ('',10,0);
19567: while ($tries < $maxtries) {
19568: $tries ++;
19569: my $captcha = Authen::Captcha->new (
19570: output_folder => $captcha_params{'output_dir'},
19571: data_folder => $captcha_params{'db_dir'},
19572: );
19573: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19574:
19575: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19576: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19577: '<span class="LC_nobreak">'.
1.1094 raeburn 19578: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19579: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19580: '</span><br />'.
1.1176 raeburn 19581: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19582: last;
19583: }
19584: }
1.1323 raeburn 19585: if ($output eq '') {
19586: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19587: }
1.1094 raeburn 19588: return $output;
19589: }
19590:
19591: sub captcha_settings {
19592: my %captcha_params = (
19593: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19594: www_output_dir => "/captchaspool",
19595: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19596: numchars => '5',
19597: );
19598: return %captcha_params;
19599: }
19600:
19601: sub check_captcha {
19602: my ($captcha_chk,$captcha_error);
19603: my $code = $env{'form.code'};
19604: my $md5sum = $env{'form.crypt'};
19605: my %captcha_params = &captcha_settings();
19606: my $captcha = Authen::Captcha->new(
19607: output_folder => $captcha_params{'output_dir'},
19608: data_folder => $captcha_params{'db_dir'},
19609: );
1.1109 raeburn 19610: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19611: my %captcha_hash = (
19612: 0 => 'Code not checked (file error)',
19613: -1 => 'Failed: code expired',
19614: -2 => 'Failed: invalid code (not in database)',
19615: -3 => 'Failed: invalid code (code does not match crypt)',
19616: );
19617: if ($captcha_chk != 1) {
19618: $captcha_error = $captcha_hash{$captcha_chk}
19619: }
19620: return ($captcha_chk,$captcha_error);
19621: }
19622:
19623: sub create_recaptcha {
1.1234 raeburn 19624: my ($pubkey,$version) = @_;
19625: if ($version >= 2) {
1.1367 raeburn 19626: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19627: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19628: } else {
19629: my $use_ssl;
19630: if ($ENV{'SERVER_PORT'} == 443) {
19631: $use_ssl = 1;
19632: }
19633: my $captcha = Captcha::reCAPTCHA->new;
19634: return $captcha->get_options_setter({theme => 'white'})."\n".
19635: $captcha->get_html($pubkey,undef,$use_ssl).
19636: &mt('If the text is hard to read, [_1] will replace them.',
19637: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19638: '<br /><br />';
19639: }
1.1094 raeburn 19640: }
19641:
19642: sub check_recaptcha {
1.1234 raeburn 19643: my ($privkey,$version) = @_;
1.1094 raeburn 19644: my $captcha_chk;
1.1350 raeburn 19645: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19646: if ($version >= 2) {
19647: my %info = (
19648: secret => $privkey,
19649: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19650: remoteip => $ip,
1.1234 raeburn 19651: );
1.1280 raeburn 19652: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19653: $request->content(join('&',map {
19654: my $name = escape($_);
19655: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19656: ? join("&$name=", map {escape($_) } @{$info{$_}})
19657: : &escape($info{$_}) );
19658: } keys(%info)));
19659: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19660: if ($response->is_success) {
19661: my $data = JSON::DWIW->from_json($response->decoded_content);
19662: if (ref($data) eq 'HASH') {
19663: if ($data->{'success'}) {
19664: $captcha_chk = 1;
19665: }
19666: }
19667: }
19668: } else {
19669: my $captcha = Captcha::reCAPTCHA->new;
19670: my $captcha_result =
19671: $captcha->check_answer(
19672: $privkey,
1.1350 raeburn 19673: $ip,
1.1234 raeburn 19674: $env{'form.recaptcha_challenge_field'},
19675: $env{'form.recaptcha_response_field'},
19676: );
19677: if ($captcha_result->{is_valid}) {
19678: $captcha_chk = 1;
19679: }
1.1094 raeburn 19680: }
19681: return $captcha_chk;
19682: }
19683:
1.1174 raeburn 19684: sub emailusername_info {
1.1244 raeburn 19685: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19686: my %titles = &Apache::lonlocal::texthash (
19687: lastname => 'Last Name',
19688: firstname => 'First Name',
19689: institution => 'School/college/university',
19690: location => "School's city, state/province, country",
19691: web => "School's web address",
19692: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19693: id => 'Student/Employee ID',
1.1174 raeburn 19694: );
19695: return (\@fields,\%titles);
19696: }
19697:
1.1161 raeburn 19698: sub cleanup_html {
19699: my ($incoming) = @_;
19700: my $outgoing;
19701: if ($incoming ne '') {
19702: $outgoing = $incoming;
19703: $outgoing =~ s/;/;/g;
19704: $outgoing =~ s/\#/#/g;
19705: $outgoing =~ s/\&/&/g;
19706: $outgoing =~ s/</</g;
19707: $outgoing =~ s/>/>/g;
19708: $outgoing =~ s/\(/(/g;
19709: $outgoing =~ s/\)/)/g;
19710: $outgoing =~ s/"/"/g;
19711: $outgoing =~ s/'/'/g;
19712: $outgoing =~ s/\$/$/g;
19713: $outgoing =~ s{/}{/}g;
19714: $outgoing =~ s/=/=/g;
19715: $outgoing =~ s/\\/\/g
19716: }
19717: return $outgoing;
19718: }
19719:
1.1190 musolffc 19720: # Checks for critical messages and returns a redirect url if one exists.
19721: # $interval indicates how often to check for messages.
1.1282 raeburn 19722: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19723: sub critical_redirect {
1.1282 raeburn 19724: my ($interval,$context) = @_;
1.1356 raeburn 19725: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19726: return ();
19727: }
1.1190 musolffc 19728: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19729: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19730: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19731: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19732: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19733: if ($blocked) {
19734: my $checkrole = "cm./$cdom/$cnum";
19735: if ($env{'request.course.sec'} ne '') {
19736: $checkrole .= "/$env{'request.course.sec'}";
19737: }
19738: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19739: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19740: return;
19741: }
19742: }
19743: }
1.1190 musolffc 19744: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19745: $env{'user.name'});
19746: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19747: my $redirecturl;
1.1190 musolffc 19748: if ($what[0]) {
1.1356 raeburn 19749: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19750: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19751: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19752: return (1, $url);
1.1190 musolffc 19753: }
1.1191 raeburn 19754: }
19755: }
19756: return ();
1.1190 musolffc 19757: }
19758:
1.1174 raeburn 19759: # Use:
19760: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19761: #
19762: ##################################################
19763: # password associated functions #
19764: ##################################################
19765: sub des_keys {
19766: # Make a new key for DES encryption.
19767: # Each key has two parts which are returned separately.
19768: # Please note: Each key must be passed through the &hex function
19769: # before it is output to the web browser. The hex versions cannot
19770: # be used to decrypt.
19771: my @hexstr=('0','1','2','3','4','5','6','7',
19772: '8','9','a','b','c','d','e','f');
19773: my $lkey='';
19774: for (0..7) {
19775: $lkey.=$hexstr[rand(15)];
19776: }
19777: my $ukey='';
19778: for (0..7) {
19779: $ukey.=$hexstr[rand(15)];
19780: }
19781: return ($lkey,$ukey);
19782: }
19783:
19784: sub des_decrypt {
19785: my ($key,$cyphertext) = @_;
19786: my $keybin=pack("H16",$key);
19787: my $cypher;
19788: if ($Crypt::DES::VERSION>=2.03) {
19789: $cypher=new Crypt::DES $keybin;
19790: } else {
19791: $cypher=new DES $keybin;
19792: }
1.1233 raeburn 19793: my $plaintext='';
19794: my $cypherlength = length($cyphertext);
19795: my $numchunks = int($cypherlength/32);
19796: for (my $j=0; $j<$numchunks; $j++) {
19797: my $start = $j*32;
19798: my $cypherblock = substr($cyphertext,$start,32);
19799: my $chunk =
19800: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19801: $chunk .=
19802: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19803: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19804: $plaintext .= $chunk;
19805: }
1.1174 raeburn 19806: return $plaintext;
19807: }
19808:
1.1344 raeburn 19809: sub get_requested_shorturls {
1.1309 raeburn 19810: my ($cdom,$cnum,$navmap) = @_;
19811: return unless (ref($navmap));
1.1344 raeburn 19812: my ($numnew,$errors);
1.1309 raeburn 19813: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19814: if (@toshorten) {
19815: my (%maps,%resources,%titles);
19816: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19817: 'shorturls',$cdom,$cnum);
19818: if (keys(%resources)) {
1.1344 raeburn 19819: my %tocreate;
1.1309 raeburn 19820: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19821: my $symb = $resources{$item};
19822: if ($symb) {
19823: $tocreate{$cnum.'&'.$symb} = 1;
19824: }
19825: }
1.1344 raeburn 19826: if (keys(%tocreate)) {
19827: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19828: \%tocreate);
19829: }
1.1309 raeburn 19830: }
1.1344 raeburn 19831: }
19832: return ($numnew,$errors);
19833: }
19834:
19835: sub make_short_symbs {
19836: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19837: my ($numnew,@errors);
19838: if (ref($tocreateref) eq 'HASH') {
19839: my %tocreate = %{$tocreateref};
1.1309 raeburn 19840: if (keys(%tocreate)) {
19841: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19842: my $su = Short::URL->new(no_vowels => 1);
19843: my $init = '';
19844: my (%newunique,%addcourse,%courseonly,%failed);
19845: # get lock on tiny db
19846: my $now = time;
1.1344 raeburn 19847: if ($lockuser eq '') {
19848: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19849: }
1.1309 raeburn 19850: my $lockhash = {
1.1344 raeburn 19851: "lock\0$now" => $lockuser,
1.1309 raeburn 19852: };
19853: my $tries = 0;
19854: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19855: my ($code,$error);
19856: while (($gotlock ne 'ok') && ($tries<3)) {
19857: $tries ++;
19858: sleep 1;
1.1319 raeburn 19859: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19860: }
19861: if ($gotlock eq 'ok') {
19862: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19863: \%addcourse,\%courseonly,\%failed);
19864: if (keys(%failed)) {
19865: my $numfailed = scalar(keys(%failed));
19866: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19867: }
19868: if (keys(%newunique)) {
19869: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19870: if ($putres eq 'ok') {
19871: $numnew = scalar(keys(%newunique));
19872: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19873: unless ($newputres eq 'ok') {
19874: push(@errors,&mt('error: could not store course look-up of short URLs'));
19875: }
19876: } else {
19877: push(@errors,&mt('error: could not store unique six character URLs'));
19878: }
19879: }
19880: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19881: unless ($dellockres eq 'ok') {
19882: push(@errors,&mt('error: could not release lockfile'));
19883: }
19884: } else {
19885: push(@errors,&mt('error: could not obtain lockfile'));
19886: }
19887: if (keys(%courseonly)) {
19888: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19889: if ($result ne 'ok') {
19890: push(@errors,&mt('error: could not update course look-up of short URLs'));
19891: }
19892: }
19893: }
19894: }
19895: return ($numnew,\@errors);
19896: }
19897:
19898: sub shorten_symbs {
19899: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19900: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19901: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19902: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19903: my (%possibles,%collisions);
19904: foreach my $key (keys(%{$tocreate})) {
19905: my $num = String::CRC32::crc32($key);
19906: my $tiny = $su->encode($num,$init);
19907: if ($tiny) {
19908: $possibles{$tiny} = $key;
19909: }
19910: }
19911: if (!$init) {
19912: $init = 1;
19913: } else {
19914: $init ++;
19915: }
19916: if (keys(%possibles)) {
19917: my @posstiny = keys(%possibles);
19918: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19919: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19920: if (keys(%currtiny)) {
19921: foreach my $key (keys(%currtiny)) {
19922: next if ($currtiny{$key} eq '');
19923: if ($currtiny{$key} eq $possibles{$key}) {
19924: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19925: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19926: $courseonly->{$tsymb} = $key;
19927: }
19928: } else {
19929: $collisions{$possibles{$key}} = 1;
19930: }
19931: delete($possibles{$key});
19932: }
19933: }
19934: foreach my $key (keys(%possibles)) {
19935: $newunique->{$key} = $possibles{$key};
19936: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19937: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19938: $addcourse->{$tsymb} = $key;
19939: }
19940: }
19941: }
19942: if (keys(%collisions)) {
19943: if ($init <5) {
19944: if (!$init) {
19945: $init = 1;
19946: } else {
19947: $init ++;
19948: }
19949: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19950: $newunique,$addcourse,$courseonly,$failed);
19951: } else {
19952: foreach my $key (keys(%collisions)) {
19953: $failed->{$key} = 1;
19954: }
19955: }
19956: }
19957: return $init;
19958: }
19959:
1.1328 raeburn 19960: sub is_nonframeable {
1.1329 raeburn 19961: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19962: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19963: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19964:
19965: $remprotocol = lc($remprotocol);
19966: $remhost = lc($remhost);
19967: my $remport = 80;
19968: if ($remprotocol eq 'https') {
19969: $remport = 443;
19970: }
1.1330 raeburn 19971: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19972: if ($cached) {
19973: unless ($nocache) {
19974: if ($result) {
19975: return 1;
19976: } else {
19977: return 0;
19978: }
19979: }
19980: }
1.1328 raeburn 19981: my $uselink;
19982: my $request = new HTTP::Request('HEAD',$url);
19983: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19984: if ($response->is_success()) {
19985: my $secpolicy = lc($response->header('content-security-policy'));
19986: my $xframeop = lc($response->header('x-frame-options'));
19987: $secpolicy =~ s/^\s+|\s+$//g;
19988: $xframeop =~ s/^\s+|\s+$//g;
19989: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19990: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19991: my ($origin,$protocol,$port);
19992: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19993: $port = $ENV{'SERVER_PORT'};
19994: } else {
19995: $port = 80;
19996: }
19997: if ($absolute eq '') {
19998: $protocol = 'http:';
19999: if ($port == 443) {
20000: $protocol = 'https:';
20001: }
20002: $origin = $protocol.'//'.lc($hostname);
20003: } else {
20004: $origin = lc($absolute);
20005: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
20006: }
20007: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
20008: my $framepolicy = $1;
20009: $framepolicy =~ s/^\s+|\s+$//g;
20010: my @policies = split(/\s+/,$framepolicy);
20011: if (@policies) {
20012: if (grep(/^\Q'none'\E$/,@policies)) {
20013: $uselink = 1;
20014: } else {
20015: $uselink = 1;
20016: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20017: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20018: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20019: undef($uselink);
20020: }
20021: if ($uselink) {
20022: if (grep(/^\Q'self'\E$/,@policies)) {
20023: if (($origin ne '') && ($remotehost eq $origin)) {
20024: undef($uselink);
20025: }
20026: }
20027: }
20028: if ($uselink) {
20029: my @possok;
20030: if ($ip ne '') {
20031: push(@possok,$ip);
20032: }
20033: my $hoststr = '';
20034: foreach my $part (reverse(split(/\./,$hostname))) {
20035: if ($hoststr eq '') {
20036: $hoststr = $part;
20037: } else {
20038: $hoststr = "$part.$hoststr";
20039: }
20040: if ($hoststr eq $hostname) {
20041: push(@possok,$hostname);
20042: } else {
20043: push(@possok,"*.$hoststr");
20044: }
20045: }
20046: if (@possok) {
20047: foreach my $poss (@possok) {
20048: last if (!$uselink);
20049: foreach my $policy (@policies) {
20050: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20051: undef($uselink);
20052: last;
20053: }
20054: }
20055: }
20056: }
20057: }
20058: }
20059: }
20060: } elsif ($xframeop ne '') {
20061: $uselink = 1;
20062: my @policies = split(/\s*,\s*/,$xframeop);
20063: if (@policies) {
20064: unless (grep(/^deny$/,@policies)) {
20065: if ($origin ne '') {
20066: if (grep(/^sameorigin$/,@policies)) {
20067: if ($remotehost eq $origin) {
20068: undef($uselink);
20069: }
20070: }
20071: if ($uselink) {
20072: foreach my $policy (@policies) {
20073: if ($policy =~ /^allow-from\s*(.+)$/) {
20074: my $allowfrom = $1;
20075: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20076: undef($uselink);
20077: last;
20078: }
20079: }
20080: }
20081: }
20082: }
20083: }
20084: }
20085: }
20086: }
20087: }
1.1329 raeburn 20088: if ($nocache) {
20089: if ($cached) {
20090: my $devalidate;
20091: if ($uselink && !$result) {
20092: $devalidate = 1;
20093: } elsif (!$uselink && $result) {
20094: $devalidate = 1;
20095: }
20096: if ($devalidate) {
20097: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20098: }
20099: }
20100: } else {
20101: if ($uselink) {
20102: $result = 1;
20103: } else {
20104: $result = 0;
20105: }
20106: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20107: }
1.1328 raeburn 20108: return $uselink;
20109: }
20110:
1.1359 raeburn 20111: sub page_menu {
20112: my ($menucolls,$menunum) = @_;
20113: my %menu;
20114: foreach my $item (split(/;/,$menucolls)) {
20115: my ($num,$value) = split(/\%/,$item);
20116: if ($num eq $menunum) {
20117: my @entries = split(/\&/,$value);
20118: foreach my $entry (@entries) {
20119: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20120: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20121: $menu{$name} = $fields;
20122: } else {
20123: my @shown;
20124: if ($fields =~ /,/) {
20125: @shown = split(/,/,$fields);
20126: } else {
20127: @shown = ($fields);
20128: }
20129: if (@shown) {
20130: foreach my $field (@shown) {
20131: next if ($field eq '');
20132: $menu{$field} = 1;
20133: }
20134: }
20135: }
20136: }
20137: }
20138: }
20139: return %menu;
20140: }
20141:
1.112 bowersj2 20142: 1;
20143: __END__;
1.41 ng 20144:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncommon.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface