Annotation of loncom/interface/loncommon.pm, revision 1.1468
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1468 ! raeburn 4: # $Id: loncommon.pm,v 1.1467 2025/03/01 17:20:16 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.1383 raeburn 64: use Apache::lonnavmaps();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1409 raeburn 74: use LONCAPA::ltiutils;
1.1280 raeburn 75: use LONCAPA::LWPReq;
1.1395 raeburn 76: use LONCAPA::map();
1.1328 raeburn 77: use HTTP::Request;
1.657 raeburn 78: use DateTime::TimeZone;
1.1241 raeburn 79: use DateTime::Locale;
1.1220 raeburn 80: use Encode();
1.1091 foxr 81: use Text::Aspell;
1.1094 raeburn 82: use Authen::Captcha;
83: use Captcha::reCAPTCHA;
1.1234 raeburn 84: use JSON::DWIW;
1.1174 raeburn 85: use Crypt::DES;
86: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 87: use MIME::Lite;
88: use MIME::Types;
1.1292 raeburn 89: use File::Copy();
1.1300 raeburn 90: use File::Path();
1.1309 raeburn 91: use String::CRC32();
92: use Short::URL();
1.117 www 93:
1.517 raeburn 94: # ---------------------------------------------- Designs
95: use vars qw(%defaultdesign);
96:
1.22 www 97: my $readit;
98:
1.517 raeburn 99:
1.157 matthew 100: ##
101: ## Global Variables
102: ##
1.46 matthew 103:
1.643 foxr 104:
105: # ----------------------------------------------- SSI with retries:
106: #
107:
108: =pod
109:
1.648 raeburn 110: =head1 Server Side include with retries:
1.643 foxr 111:
112: =over 4
113:
1.648 raeburn 114: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 115:
116: Performs an ssi with some number of retries. Retries continue either
117: until the result is ok or until the retry count supplied by the
118: caller is exhausted.
119:
120: Inputs:
1.648 raeburn 121:
122: =over 4
123:
1.643 foxr 124: resource - Identifies the resource to insert.
1.648 raeburn 125:
1.643 foxr 126: retries - Count of the number of retries allowed.
1.648 raeburn 127:
1.643 foxr 128: form - Hash that identifies the rendering options.
129:
1.648 raeburn 130: =back
131:
132: Returns:
133:
134: =over 4
135:
1.643 foxr 136: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 137:
1.643 foxr 138: response - The response from the last attempt (which may or may not have been successful.
139:
1.648 raeburn 140: =back
141:
142: =back
143:
1.643 foxr 144: =cut
145:
146: sub ssi_with_retries {
147: my ($resource, $retries, %form) = @_;
148:
149:
150: my $ok = 0; # True if we got a good response.
151: my $content;
152: my $response;
153:
154: # Try to get the ssi done. within the retries count:
155:
156: do {
157: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
158: $ok = $response->is_success;
1.650 www 159: if (!$ok) {
160: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
161: }
1.643 foxr 162: $retries--;
163: } while (!$ok && ($retries > 0));
164:
165: if (!$ok) {
166: $content = ''; # On error return an empty content.
167: }
168: return ($content, $response);
169:
170: }
171:
172:
173:
1.20 www 174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 175: my %language;
1.124 www 176: my %supported_language;
1.1088 foxr 177: my %supported_codes;
1.1048 foxr 178: my %latex_language; # For choosing hyphenation in <transl..>
179: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 180: my %cprtag;
1.192 taceyjo1 181: my %scprtag;
1.351 www 182: my %fe; my %fd; my %fm;
1.41 ng 183: my %category_extensions;
1.12 harris41 184:
1.46 matthew 185: # ---------------------------------------------- Thesaurus variables
1.144 matthew 186: #
187: # %Keywords:
188: # A hash used by &keyword to determine if a word is considered a keyword.
189: # $thesaurus_db_file
190: # Scalar containing the full path to the thesaurus database.
1.46 matthew 191:
192: my %Keywords;
193: my $thesaurus_db_file;
194:
1.144 matthew 195: #
196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
197: # thesaurus.tab, and filecategories.tab.
198: #
1.18 www 199: BEGIN {
1.46 matthew 200: # Variable initialization
201: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
202: #
1.22 www 203: unless ($readit) {
1.12 harris41 204: # ------------------------------------------------------------------- languages
205: {
1.158 raeburn 206: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
207: '/language.tab';
1.1317 raeburn 208: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
1.1088 foxr 212: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 213: $language{$key}=$val.' - '.$enc;
214: if ($sup) {
215: $supported_language{$key}=$sup;
1.1088 foxr 216: $supported_codes{$key} = $code;
1.158 raeburn 217: }
1.1048 foxr 218: if ($latex) {
219: $latex_language_bykey{$key} = $latex;
1.1088 foxr 220: $latex_language{$code} = $latex;
1.1048 foxr 221: }
1.158 raeburn 222: }
223: close($fh);
224: }
1.12 harris41 225: }
226: # ------------------------------------------------------------------ copyrights
227: {
1.158 raeburn 228: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/copyright.tab';
1.1317 raeburn 230: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line=~/^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 235: $cprtag{$key}=$val;
236: }
237: close($fh);
238: }
1.12 harris41 239: }
1.351 www 240: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 241: {
242: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
243: '/source_copyright.tab';
1.1317 raeburn 244: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 249: $scprtag{$key}=$val;
250: }
251: close($fh);
252: }
253: }
1.63 www 254:
1.517 raeburn 255: # -------------------------------------------------------------- default domain designs
1.63 www 256: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 257: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 258: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($key,$val)=(split(/\=/,$line));
263: if ($val) { $defaultdesign{$key}=$val; }
264: }
265: close($fh);
1.63 www 266: }
267:
1.15 harris41 268: # ------------------------------------------------------------- file categories
269: {
1.158 raeburn 270: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filecategories.tab';
1.1317 raeburn 272: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 277: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 278: }
279: close($fh);
280: }
281:
1.15 harris41 282: }
1.12 harris41 283: # ------------------------------------------------------------------ file types
284: {
1.158 raeburn 285: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
286: '/filetypes.tab';
1.1317 raeburn 287: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 288: while (my $line = <$fh>) {
289: next if ($line =~ /^\#/);
290: chomp($line);
291: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 292: if ($descr ne '') {
293: $fe{$ending}=lc($emb);
294: $fd{$ending}=$descr;
1.351 www 295: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 296: }
297: }
298: close($fh);
299: }
1.12 harris41 300: }
1.22 www 301: &Apache::lonnet::logthis(
1.705 tempelho 302: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 303: $readit=1;
1.46 matthew 304: } # end of unless($readit)
1.32 matthew 305:
306: }
1.112 bowersj2 307:
1.42 matthew 308: ###############################################################
309: ## HTML and Javascript Helper Functions ##
310: ###############################################################
311:
312: =pod
313:
1.112 bowersj2 314: =head1 HTML and Javascript Functions
1.42 matthew 315:
1.112 bowersj2 316: =over 4
317:
1.648 raeburn 318: =item * &browser_and_searcher_javascript()
1.112 bowersj2 319:
320: X<browsing, javascript>X<searching, javascript>Returns a string
321: containing javascript with two functions, C<openbrowser> and
322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
323: tags.
1.42 matthew 324:
1.648 raeburn 325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 326:
327: inputs: formname, elementname, only, omit
328:
329: formname and elementname indicate the name of the html form and name of
330: the element that the results of the browsing selection are to be placed in.
331:
332: Specifying 'only' will restrict the browser to displaying only files
1.185 www 333: with the given extension. Can be a comma separated list.
1.42 matthew 334:
335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 336: with the given extension. Can be a comma separated list.
1.42 matthew 337:
1.648 raeburn 338: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 339:
340: Inputs: formname, elementname
341:
342: formname and elementname specify the name of the html form and the name
343: of the element the selection from the search results will be placed in.
1.542 raeburn 344:
1.42 matthew 345: =cut
346:
347: sub browser_and_searcher_javascript {
1.199 albertel 348: my ($mode)=@_;
349: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 350: my $resurl=&escape_single(&lastresurl());
1.42 matthew 351: return <<END;
1.219 albertel 352: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 353: var editbrowser = null;
1.135 albertel 354: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 355: var url = '$resurl/?';
1.42 matthew 356: if (editbrowser == null) {
357: url += 'launch=1&';
358: }
359: url += 'catalogmode=interactive&';
1.199 albertel 360: url += 'mode=$mode&';
1.611 albertel 361: url += 'inhibitmenu=yes&';
1.42 matthew 362: url += 'form=' + formname + '&';
363: if (only != null) {
364: url += 'only=' + only + '&';
1.217 albertel 365: } else {
366: url += 'only=&';
367: }
1.42 matthew 368: if (omit != null) {
369: url += 'omit=' + omit + '&';
1.217 albertel 370: } else {
371: url += 'omit=&';
372: }
1.135 albertel 373: if (titleelement != null) {
374: url += 'titleelement=' + titleelement + '&';
1.217 albertel 375: } else {
376: url += 'titleelement=&';
377: }
1.42 matthew 378: url += 'element=' + elementname + '';
379: var title = 'Browser';
1.435 albertel 380: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 381: options += ',width=700,height=600';
382: editbrowser = open(url,title,options,'1');
383: editbrowser.focus();
384: }
385: var editsearcher;
1.135 albertel 386: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 387: var url = '/adm/searchcat?';
388: if (editsearcher == null) {
389: url += 'launch=1&';
390: }
391: url += 'catalogmode=interactive&';
1.199 albertel 392: url += 'mode=$mode&';
1.42 matthew 393: url += 'form=' + formname + '&';
1.135 albertel 394: if (titleelement != null) {
395: url += 'titleelement=' + titleelement + '&';
1.217 albertel 396: } else {
397: url += 'titleelement=&';
398: }
1.42 matthew 399: url += 'element=' + elementname + '';
400: var title = 'Search';
1.435 albertel 401: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 402: options += ',width=700,height=600';
403: editsearcher = open(url,title,options,'1');
404: editsearcher.focus();
405: }
1.219 albertel 406: // END LON-CAPA Internal -->
1.42 matthew 407: END
1.170 www 408: }
409:
410: sub lastresurl {
1.258 albertel 411: if ($env{'environment.lastresurl'}) {
412: return $env{'environment.lastresurl'}
1.170 www 413: } else {
414: return '/res';
415: }
416: }
417:
418: sub storeresurl {
419: my $resurl=&Apache::lonnet::clutter(shift);
420: unless ($resurl=~/^\/res/) { return 0; }
421: $resurl=~s/\/$//;
422: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 423: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 424: return 1;
1.42 matthew 425: }
426:
1.74 www 427: sub studentbrowser_javascript {
1.111 www 428: unless (
1.258 albertel 429: (($env{'request.course.id'}) &&
1.302 albertel 430: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
431: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
432: '/'.$env{'request.course.sec'})
433: ))
1.258 albertel 434: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 435: ) { return ''; }
1.74 www 436: return (<<'ENDSTDBRW');
1.776 bisitz 437: <script type="text/javascript" language="Javascript">
1.824 bisitz 438: // <![CDATA[
1.74 www 439: var stdeditbrowser;
1.1413 raeburn 440: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74 www 441: var url = '/adm/pickstudent?';
442: var filter;
1.558 albertel 443: if (!ignorefilter) {
444: eval('filter=document.'+formname+'.'+uname+'.value;');
445: }
1.74 www 446: if (filter != null) {
447: if (filter != '') {
448: url += 'filter='+filter+'&';
449: }
450: }
451: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 452: '&udomelement='+udom+
453: '&clicker='+clicker;
1.111 www 454: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 455: if (courseadv == 'condition') {
456: if (document.getElementById('courseadv')) {
457: courseadv = document.getElementById('courseadv').value;
458: }
459: }
460: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413 raeburn 461: if (uident !== '') { url+="&identelement="+uident; }
1.102 www 462: var title = 'Student_Browser';
1.74 www 463: var options = 'scrollbars=1,resizable=1,menubar=0';
464: options += ',width=700,height=600';
465: stdeditbrowser = open(url,title,options,'1');
466: stdeditbrowser.focus();
467: }
1.824 bisitz 468: // ]]>
1.74 www 469: </script>
470: ENDSTDBRW
471: }
1.42 matthew 472:
1.1003 www 473: sub resourcebrowser_javascript {
474: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 475: return (<<'ENDRESBRW');
1.1003 www 476: <script type="text/javascript" language="Javascript">
477: // <![CDATA[
478: var reseditbrowser;
1.1004 www 479: function openresbrowser(formname,reslink) {
1.1005 www 480: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 481: var title = 'Resource_Browser';
482: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 483: options += ',width=700,height=500';
1.1004 www 484: reseditbrowser = open(url,title,options,'1');
485: reseditbrowser.focus();
1.1003 www 486: }
487: // ]]>
488: </script>
1.1004 www 489: ENDRESBRW
1.1003 www 490: }
491:
1.74 www 492: sub selectstudent_link {
1.1413 raeburn 493: my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999 www 494: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
495: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
496: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 497: if ($env{'request.course.id'}) {
1.302 albertel 498: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
499: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
500: '/'.$env{'request.course.sec'})) {
1.111 www 501: return '';
502: }
1.999 www 503: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 504: if ($courseadv eq 'only') {
505: $callargs .= ",'',1,'$courseadv'";
506: } elsif ($courseadv eq 'none') {
507: $callargs .= ",'','','$courseadv'";
508: } elsif ($courseadv eq 'condition') {
509: $callargs .= ",'','','$courseadv'";
1.1413 raeburn 510: } elsif ($identelem ne '') {
511: $callargs .= ",'','',''";
512: }
513: if ($identelem ne '') {
514: $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793 raeburn 515: }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openstdbrowser('.$callargs.');">'.
518: &mt('Select User').'</a></span>';
1.74 www 519: }
1.258 albertel 520: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 521: $callargs .= ",'',1";
1.793 raeburn 522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openstdbrowser('.$callargs.');">'.
524: &mt('Select User').'</a></span>';
1.111 www 525: }
526: return '';
1.91 www 527: }
528:
1.1004 www 529: sub selectresource_link {
530: my ($form,$reslink,$arg)=@_;
531:
532: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
533: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
534: unless ($env{'request.course.id'}) { return $arg; }
535: return '<span class="LC_nobreak">'.
536: '<a href="javascript:openresbrowser('.$callargs.');">'.
537: $arg.'</a></span>';
538: }
539:
540:
541:
1.653 raeburn 542: sub authorbrowser_javascript {
543: return <<"ENDAUTHORBRW";
1.776 bisitz 544: <script type="text/javascript" language="JavaScript">
1.824 bisitz 545: // <![CDATA[
1.653 raeburn 546: var stdeditbrowser;
547:
548: function openauthorbrowser(formname,udom) {
549: var url = '/adm/pickauthor?';
550: url += 'form='+formname+'&roledom='+udom;
551: var title = 'Author_Browser';
552: var options = 'scrollbars=1,resizable=1,menubar=0';
553: options += ',width=700,height=600';
554: stdeditbrowser = open(url,title,options,'1');
555: stdeditbrowser.focus();
556: }
557:
1.824 bisitz 558: // ]]>
1.653 raeburn 559: </script>
560: ENDAUTHORBRW
561: }
562:
1.91 www 563: sub coursebrowser_javascript {
1.1116 raeburn 564: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 565: $credits_element,$instcode) = @_;
1.932 raeburn 566: my $wintitle = 'Course_Browser';
1.931 raeburn 567: if ($crstype eq 'Community') {
1.932 raeburn 568: $wintitle = 'Community_Browser';
1.909 raeburn 569: }
1.876 raeburn 570: my $id_functions = &javascript_index_functions();
571: my $output = '
1.776 bisitz 572: <script type="text/javascript" language="JavaScript">
1.824 bisitz 573: // <![CDATA[
1.468 raeburn 574: var stdeditbrowser;'."\n";
1.876 raeburn 575:
576: $output .= <<"ENDSTDBRW";
1.909 raeburn 577: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 578: var url = '/adm/pickcourse?';
1.895 raeburn 579: var formid = getFormIdByName(formname);
1.876 raeburn 580: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 581: if (domainfilter != null) {
582: if (domainfilter != '') {
583: url += 'domainfilter='+domainfilter+'&';
584: }
585: }
1.91 www 586: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 587: '&cdomelement='+udom+
588: '&cnameelement='+desc;
1.468 raeburn 589: if (extra_element !=null && extra_element != '') {
1.594 raeburn 590: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 591: url += '&roleelement='+extra_element;
592: if (domainfilter == null || domainfilter == '') {
593: url += '&domainfilter='+extra_element;
594: }
1.234 raeburn 595: }
1.468 raeburn 596: else {
597: if (formname == 'portform') {
598: url += '&setroles='+extra_element;
1.800 raeburn 599: } else {
600: if (formname == 'rules') {
601: url += '&fixeddom='+extra_element;
602: }
1.468 raeburn 603: }
604: }
1.230 raeburn 605: }
1.909 raeburn 606: if (type != null && type != '') {
607: url += '&type='+type;
608: }
609: if (type_elem != null && type_elem != '') {
610: url += '&typeelement='+type_elem;
611: }
1.872 raeburn 612: if (formname == 'ccrs') {
613: var ownername = document.forms[formid].ccuname.value;
614: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 615: url += '&cloner='+ownername+':'+ownerdom;
616: if (type == 'Course') {
617: url += '&crscode='+document.forms[formid].crscode.value;
618: }
1.1221 raeburn 619: }
620: if (formname == 'requestcrs') {
621: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 622: }
1.293 raeburn 623: if (multflag !=null && multflag != '') {
624: url += '&multiple='+multflag;
625: }
1.909 raeburn 626: var title = '$wintitle';
1.91 www 627: var options = 'scrollbars=1,resizable=1,menubar=0';
628: options += ',width=700,height=600';
629: stdeditbrowser = open(url,title,options,'1');
630: stdeditbrowser.focus();
631: }
1.876 raeburn 632: $id_functions
633: ENDSTDBRW
1.1116 raeburn 634: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
635: $output .= &setsec_javascript($sec_element,$formname,$role_element,
636: $credits_element);
1.876 raeburn 637: }
638: $output .= '
639: // ]]>
640: </script>';
641: return $output;
642: }
643:
644: sub javascript_index_functions {
645: return <<"ENDJS";
646:
647: function getFormIdByName(formname) {
648: for (var i=0;i<document.forms.length;i++) {
649: if (document.forms[i].name == formname) {
650: return i;
651: }
652: }
653: return -1;
654: }
655:
656: function getIndexByName(formid,item) {
657: for (var i=0;i<document.forms[formid].elements.length;i++) {
658: if (document.forms[formid].elements[i].name == item) {
659: return i;
660: }
661: }
662: return -1;
663: }
1.468 raeburn 664:
1.876 raeburn 665: function getDomainFromSelectbox(formname,udom) {
666: var userdom;
667: var formid = getFormIdByName(formname);
668: if (formid > -1) {
669: var domid = getIndexByName(formid,udom);
670: if (domid > -1) {
671: if (document.forms[formid].elements[domid].type == 'select-one') {
672: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
673: }
674: if (document.forms[formid].elements[domid].type == 'hidden') {
675: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 676: }
677: }
678: }
1.876 raeburn 679: return userdom;
680: }
681:
682: ENDJS
1.468 raeburn 683:
1.876 raeburn 684: }
685:
1.1017 raeburn 686: sub javascript_array_indexof {
1.1018 raeburn 687: return <<ENDJS;
1.1017 raeburn 688: <script type="text/javascript" language="JavaScript">
689: // <![CDATA[
690:
691: if (!Array.prototype.indexOf) {
692: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
693: "use strict";
694: if (this === void 0 || this === null) {
695: throw new TypeError();
696: }
697: var t = Object(this);
698: var len = t.length >>> 0;
699: if (len === 0) {
700: return -1;
701: }
702: var n = 0;
703: if (arguments.length > 0) {
704: n = Number(arguments[1]);
1.1088 foxr 705: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 706: n = 0;
707: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
708: n = (n > 0 || -1) * Math.floor(Math.abs(n));
709: }
710: }
711: if (n >= len) {
712: return -1;
713: }
714: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
715: for (; k < len; k++) {
716: if (k in t && t[k] === searchElement) {
717: return k;
718: }
719: }
720: return -1;
721: }
722: }
723:
724: // ]]>
725: </script>
726:
727: ENDJS
728:
729: }
730:
1.876 raeburn 731: sub userbrowser_javascript {
732: my $id_functions = &javascript_index_functions();
733: return <<"ENDUSERBRW";
734:
1.888 raeburn 735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 736: var url = '/adm/pickuser?';
737: var userdom = getDomainFromSelectbox(formname,udom);
738: if (userdom != null) {
739: if (userdom != '') {
740: url += 'srchdom='+userdom+'&';
741: }
742: }
743: url += 'form=' + formname + '&unameelement='+uname+
744: '&udomelement='+udom+
745: '&ulastelement='+ulast+
746: '&ufirstelement='+ufirst+
747: '&uemailelement='+uemail+
1.881 raeburn 748: '&hideudomelement='+hideudom+
749: '&coursedom='+crsdom;
1.888 raeburn 750: if ((caller != null) && (caller != undefined)) {
751: url += '&caller='+caller;
752: }
1.876 raeburn 753: var title = 'User_Browser';
754: var options = 'scrollbars=1,resizable=1,menubar=0';
755: options += ',width=700,height=600';
756: var stdeditbrowser = open(url,title,options,'1');
757: stdeditbrowser.focus();
758: }
759:
1.888 raeburn 760: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 761: var formid = getFormIdByName(formname);
762: if (formid > -1) {
1.888 raeburn 763: var unameid = getIndexByName(formid,uname);
1.876 raeburn 764: var domid = getIndexByName(formid,udom);
765: var hidedomid = getIndexByName(formid,origdom);
766: if (hidedomid > -1) {
767: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 768: var unameval = document.forms[formid].elements[unameid].value;
769: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
770: if (domid > -1) {
771: var slct = document.forms[formid].elements[domid];
772: if (slct.type == 'select-one') {
773: var i;
774: for (i=0;i<slct.length;i++) {
775: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
776: }
777: }
778: if (slct.type == 'hidden') {
779: slct.value = fixeddom;
1.876 raeburn 780: }
781: }
1.468 raeburn 782: }
783: }
784: }
1.876 raeburn 785: return;
786: }
787:
788: $id_functions
789: ENDUSERBRW
1.468 raeburn 790: }
791:
792: sub setsec_javascript {
1.1116 raeburn 793: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 794: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
795: $communityrolestr);
796: if ($role_element ne '') {
797: my @allroles = ('st','ta','ep','in','ad');
798: foreach my $crstype ('Course','Community') {
799: if ($crstype eq 'Community') {
800: foreach my $role (@allroles) {
801: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
802: }
803: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
804: } else {
805: foreach my $role (@allroles) {
806: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
807: }
808: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
809: }
810: }
811: $rolestr = '"'.join('","',@allroles).'"';
812: $courserolestr = '"'.join('","',@courserolenames).'"';
813: $communityrolestr = '"'.join('","',@communityrolenames).'"';
814: }
1.468 raeburn 815: my $setsections = qq|
816: function setSect(sectionlist) {
1.629 raeburn 817: var sectionsArray = new Array();
818: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
819: sectionsArray = sectionlist.split(",");
820: }
1.468 raeburn 821: var numSections = sectionsArray.length;
822: document.$formname.$sec_element.length = 0;
823: if (numSections == 0) {
824: document.$formname.$sec_element.multiple=false;
825: document.$formname.$sec_element.size=1;
826: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
827: } else {
828: if (numSections == 1) {
829: document.$formname.$sec_element.multiple=false;
830: document.$formname.$sec_element.size=1;
831: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
832: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
833: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
834: } else {
835: for (var i=0; i<numSections; i++) {
836: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
837: }
838: document.$formname.$sec_element.multiple=true
839: if (numSections < 3) {
840: document.$formname.$sec_element.size=numSections;
841: } else {
842: document.$formname.$sec_element.size=3;
843: }
844: document.$formname.$sec_element.options[0].selected = false
845: }
846: }
1.91 www 847: }
1.905 raeburn 848:
849: function setRole(crstype) {
1.468 raeburn 850: |;
1.905 raeburn 851: if ($role_element eq '') {
852: $setsections .= ' return;
853: }
854: ';
855: } else {
856: $setsections .= qq|
857: var elementLength = document.$formname.$role_element.length;
858: var allroles = Array($rolestr);
859: var courserolenames = Array($courserolestr);
860: var communityrolenames = Array($communityrolestr);
861: if (elementLength != undefined) {
862: if (document.$formname.$role_element.options[5].value == 'cc') {
863: if (crstype == 'Course') {
864: return;
865: } else {
866: allroles[5] = 'co';
867: for (var i=0; i<6; i++) {
868: document.$formname.$role_element.options[i].value = allroles[i];
869: document.$formname.$role_element.options[i].text = communityrolenames[i];
870: }
871: }
872: } else {
873: if (crstype == 'Community') {
874: return;
875: } else {
876: allroles[5] = 'cc';
877: for (var i=0; i<6; i++) {
878: document.$formname.$role_element.options[i].value = allroles[i];
879: document.$formname.$role_element.options[i].text = courserolenames[i];
880: }
881: }
882: }
883: }
884: return;
885: }
886: |;
887: }
1.1116 raeburn 888: if ($credits_element) {
889: $setsections .= qq|
890: function setCredits(defaultcredits) {
891: document.$formname.$credits_element.value = defaultcredits;
892: return;
893: }
894: |;
895: }
1.468 raeburn 896: return $setsections;
897: }
898:
1.91 www 899: sub selectcourse_link {
1.909 raeburn 900: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
901: $typeelement) = @_;
902: my $type = $selecttype;
1.871 raeburn 903: my $linktext = &mt('Select Course');
904: if ($selecttype eq 'Community') {
1.909 raeburn 905: $linktext = &mt('Select Community');
1.1239 raeburn 906: } elsif ($selecttype eq 'Placement') {
907: $linktext = &mt('Select Placement Test');
1.906 raeburn 908: } elsif ($selecttype eq 'Course/Community') {
909: $linktext = &mt('Select Course/Community');
1.909 raeburn 910: $type = '';
1.1019 raeburn 911: } elsif ($selecttype eq 'Select') {
912: $linktext = &mt('Select');
913: $type = '';
1.871 raeburn 914: }
1.787 bisitz 915: return '<span class="LC_nobreak">'
916: ."<a href='"
917: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
918: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 919: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 920: ."'>".$linktext.'</a>'
1.787 bisitz 921: .'</span>';
1.74 www 922: }
1.42 matthew 923:
1.653 raeburn 924: sub selectauthor_link {
925: my ($form,$udom)=@_;
926: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
927: &mt('Select Author').'</a>';
928: }
929:
1.876 raeburn 930: sub selectuser_link {
1.881 raeburn 931: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 932: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 933: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 934: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 935: ');">'.$linktext.'</a>';
1.876 raeburn 936: }
937:
1.273 raeburn 938: sub check_uncheck_jscript {
939: my $jscript = <<"ENDSCRT";
940: function checkAll(field) {
941: if (field.length > 0) {
942: for (i = 0; i < field.length; i++) {
1.1093 raeburn 943: if (!field[i].disabled) {
944: field[i].checked = true;
945: }
1.273 raeburn 946: }
947: } else {
1.1093 raeburn 948: if (!field.disabled) {
949: field.checked = true;
950: }
1.273 raeburn 951: }
952: }
953:
954: function uncheckAll(field) {
955: if (field.length > 0) {
956: for (i = 0; i < field.length; i++) {
957: field[i].checked = false ;
1.543 albertel 958: }
959: } else {
1.273 raeburn 960: field.checked = false ;
961: }
962: }
963: ENDSCRT
964: return $jscript;
965: }
966:
1.656 www 967: sub select_timezone {
1.1387 raeburn 968: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
969: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 970: if ($includeempty) {
971: $output .= '<option value=""';
972: if (($selected eq '') || ($selected eq 'local')) {
973: $output .= ' selected="selected" ';
974: }
975: $output .= '> </option>';
976: }
1.657 raeburn 977: my @timezones = DateTime::TimeZone->all_names;
978: foreach my $tzone (@timezones) {
979: $output.= '<option value="'.$tzone.'"';
980: if ($tzone eq $selected) {
981: $output.=' selected="selected"';
982: }
983: $output.=">$tzone</option>\n";
1.656 www 984: }
985: $output.="</select>";
986: return $output;
987: }
1.273 raeburn 988:
1.687 raeburn 989: sub select_datelocale {
1.1256 raeburn 990: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
991: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 992: if ($includeempty) {
993: $output .= '<option value=""';
994: if ($selected eq '') {
995: $output .= ' selected="selected" ';
996: }
997: $output .= '> </option>';
998: }
1.1241 raeburn 999: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 1000: my (@possibles,%locale_names);
1.1241 raeburn 1001: my @locales = DateTime::Locale->ids();
1002: foreach my $id (@locales) {
1003: if ($id ne '') {
1004: my ($en_terr,$native_terr);
1005: my $loc = DateTime::Locale->load($id);
1006: if (ref($loc)) {
1007: $en_terr = $loc->name();
1008: $native_terr = $loc->native_name();
1.687 raeburn 1009: if (grep(/^en$/,@languages) || !@languages) {
1010: if ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: } elsif ($native_terr ne '') {
1013: $locale_names{$id} = $native_terr;
1014: }
1015: } else {
1016: if ($native_terr ne '') {
1017: $locale_names{$id} = $native_terr.' ';
1018: } elsif ($en_terr ne '') {
1019: $locale_names{$id} = '('.$en_terr.')';
1020: }
1021: }
1.1220 raeburn 1022: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1023: push(@possibles,$id);
1024: }
1.687 raeburn 1025: }
1026: }
1027: foreach my $item (sort(@possibles)) {
1028: $output.= '<option value="'.$item.'"';
1029: if ($item eq $selected) {
1030: $output.=' selected="selected"';
1031: }
1032: $output.=">$item";
1033: if ($locale_names{$item} ne '') {
1.1220 raeburn 1034: $output.=' '.$locale_names{$item};
1.687 raeburn 1035: }
1036: $output.="</option>\n";
1037: }
1038: $output.="</select>";
1039: return $output;
1040: }
1041:
1.792 raeburn 1042: sub select_language {
1.1256 raeburn 1043: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1044: my %langchoices;
1045: if ($includeempty) {
1.1117 raeburn 1046: %langchoices = ('' => 'No language preference');
1.792 raeburn 1047: }
1048: foreach my $id (&languageids()) {
1049: my $code = &supportedlanguagecode($id);
1050: if ($code) {
1051: $langchoices{$code} = &plainlanguagedescription($id);
1052: }
1053: }
1.1117 raeburn 1054: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1055: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1056: }
1057:
1.42 matthew 1058: =pod
1.36 matthew 1059:
1.1088 foxr 1060:
1061: =item * &list_languages()
1062:
1063: Returns an array reference that is suitable for use in language prompters.
1064: Each array element is itself a two element array. The first element
1065: is the language code. The second element a descsriptiuon of the
1066: language itself. This is suitable for use in e.g.
1067: &Apache::edit::select_arg (once dereferenced that is).
1068:
1069: =cut
1070:
1071: sub list_languages {
1072: my @lang_choices;
1073:
1074: foreach my $id (&languageids()) {
1075: my $code = &supportedlanguagecode($id);
1076: if ($code) {
1077: my $selector = $supported_codes{$id};
1078: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1079: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1080: }
1081: }
1082: return \@lang_choices;
1083: }
1084:
1085: =pod
1086:
1.648 raeburn 1087: =item * &linked_select_forms(...)
1.36 matthew 1088:
1089: linked_select_forms returns a string containing a <script></script> block
1090: and html for two <select> menus. The select menus will be linked in that
1091: changing the value of the first menu will result in new values being placed
1092: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1093: order unless a defined order is provided.
1.36 matthew 1094:
1095: linked_select_forms takes the following ordered inputs:
1096:
1097: =over 4
1098:
1.112 bowersj2 1099: =item * $formname, the name of the <form> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1102:
1.112 bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36 matthew 1104:
1.112 bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1106:
1.112 bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1108:
1.112 bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1110:
1.609 raeburn 1111: =item * $menuorder, the order of values in the first menu
1112:
1.1115 raeburn 1113: =item * $onchangefirst, additional javascript call to execute for an onchange
1114: event for the first <select> tag
1115:
1116: =item * $onchangesecond, additional javascript call to execute for an onchange
1117: event for the second <select> tag
1118:
1.1245 raeburn 1119: =item * $suffix, to differentiate separate uses of select2data javascript
1120: objects in a page.
1121:
1.41 ng 1122: =back
1123:
1.36 matthew 1124: Below is an example of such a hash. Only the 'text', 'default', and
1125: 'select2' keys must appear as stated. keys(%menu) are the possible
1126: values for the first select menu. The text that coincides with the
1.41 ng 1127: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1128: and text for the second menu are given in the hash pointed to by
1129: $menu{$choice1}->{'select2'}.
1130:
1.112 bowersj2 1131: my %menu = ( A1 => { text =>"Choice A1" ,
1132: default => "B3",
1133: select2 => {
1134: B1 => "Choice B1",
1135: B2 => "Choice B2",
1136: B3 => "Choice B3",
1137: B4 => "Choice B4"
1.609 raeburn 1138: },
1139: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1140: },
1141: A2 => { text =>"Choice A2" ,
1142: default => "C2",
1143: select2 => {
1144: C1 => "Choice C1",
1145: C2 => "Choice C2",
1146: C3 => "Choice C3"
1.609 raeburn 1147: },
1148: order => ['C2','C1','C3'],
1.112 bowersj2 1149: },
1150: A3 => { text =>"Choice A3" ,
1151: default => "D6",
1152: select2 => {
1153: D1 => "Choice D1",
1154: D2 => "Choice D2",
1155: D3 => "Choice D3",
1156: D4 => "Choice D4",
1157: D5 => "Choice D5",
1158: D6 => "Choice D6",
1159: D7 => "Choice D7"
1.609 raeburn 1160: },
1161: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1162: }
1163: );
1.36 matthew 1164:
1165: =cut
1166:
1167: sub linked_select_forms {
1168: my ($formname,
1169: $middletext,
1170: $firstdefault,
1171: $firstselectname,
1172: $secondselectname,
1.609 raeburn 1173: $hashref,
1174: $menuorder,
1.1115 raeburn 1175: $onchangefirst,
1.1245 raeburn 1176: $onchangesecond,
1.1450 raeburn 1177: $suffix,
1178: $haslabel
1.36 matthew 1179: ) = @_;
1180: my $second = "document.$formname.$secondselectname";
1181: my $first = "document.$formname.$firstselectname";
1182: # output the javascript to do the changing
1183: my $result = '';
1.776 bisitz 1184: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1185: $result.="// <![CDATA[\n";
1.1245 raeburn 1186: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1187: $" = '","';
1188: my $debug = '';
1189: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1190: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1191: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1192: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1193: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1194: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1195: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1196: @s2values = @{$hashref->{$s1}->{'order'}};
1197: }
1.36 matthew 1198: $result.="\"@s2values\");\n";
1.1245 raeburn 1199: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1200: my @s2texts;
1201: foreach my $value (@s2values) {
1.1263 raeburn 1202: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1203: }
1204: $result.="\"@s2texts\");\n";
1205: }
1206: $"=' ';
1207: $result.= <<"END";
1208:
1.1245 raeburn 1209: function select1${suffix}_changed() {
1.36 matthew 1210: // Determine new choice
1.1245 raeburn 1211: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1212: // update select2
1.1245 raeburn 1213: var values = select2data${suffix}[newvalue].values;
1214: var texts = select2data${suffix}[newvalue].texts;
1215: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1216: var i;
1217: // out with the old
1.1245 raeburn 1218: $second.options.length = 0;
1219: // in with the new
1.36 matthew 1220: for (i=0;i<values.length; i++) {
1221: $second.options[i] = new Option(values[i]);
1.143 matthew 1222: $second.options[i].value = values[i];
1.36 matthew 1223: $second.options[i].text = texts[i];
1224: if (values[i] == select2def) {
1225: $second.options[i].selected = true;
1226: }
1227: }
1228: }
1.824 bisitz 1229: // ]]>
1.36 matthew 1230: </script>
1231: END
1232: # output the initial values for the selection lists
1.1245 raeburn 1233: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1234: my @order = sort(keys(%{$hashref}));
1235: if (ref($menuorder) eq 'ARRAY') {
1236: @order = @{$menuorder};
1237: }
1238: foreach my $value (@order) {
1.36 matthew 1239: $result.=" <option value=\"$value\" ";
1.253 albertel 1240: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1241: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1242: }
1243: $result .= "</select>\n";
1.1450 raeburn 1244: if ($haslabel) {
1245: $result .= '</label>';
1246: }
1.1400 raeburn 1247: my %select2;
1248: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1249: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1250: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1251: }
1252: }
1.1450 raeburn 1253: if ($middletext ne '') {
1.1452 raeburn 1254: $result .= '<label>'.$middletext;
1.1450 raeburn 1255: }
1.1115 raeburn 1256: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1257: if ($onchangesecond) {
1258: $result .= ' onchange="'.$onchangesecond.'"';
1259: }
1260: $result .= ">\n";
1.36 matthew 1261: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1262:
1263: my @secondorder = sort(keys(%select2));
1264: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1265: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1266: }
1267: foreach my $value (@secondorder) {
1.36 matthew 1268: $result.=" <option value=\"$value\" ";
1.253 albertel 1269: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1270: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1271: }
1272: $result .= "</select>\n";
1.1450 raeburn 1273: if ($middletext ne '') {
1274: $result .= '</label>';
1275: }
1.36 matthew 1276: # return $debug;
1277: return $result;
1278: } # end of sub linked_select_forms {
1279:
1.45 matthew 1280: =pod
1.44 bowersj2 1281:
1.1381 raeburn 1282: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1283:
1.112 bowersj2 1284: Returns a string corresponding to an HTML link to the given help
1285: $topic, where $topic corresponds to the name of a .tex file in
1286: /home/httpd/html/adm/help/tex, with underscores replaced by
1287: spaces.
1288:
1289: $text will optionally be linked to the same topic, allowing you to
1290: link text in addition to the graphic. If you do not want to link
1291: text, but wish to specify one of the later parameters, pass an
1292: empty string.
1293:
1294: $stayOnPage is a value that will be interpreted as a boolean. If true,
1295: the link will not open a new window. If false, the link will open
1296: a new window using Javascript. (Default is false.)
1297:
1298: $width and $height are optional numerical parameters that will
1299: override the width and height of the popped up window, which may
1.973 raeburn 1300: be useful for certain help topics with big pictures included.
1301:
1302: $imgid is the id of the img tag used for the help icon. This may be
1303: used in a javascript call to switch the image src. See
1304: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1305:
1.1381 raeburn 1306: $links_target will optionally be set to a target (_top, _parent or _self).
1307:
1.44 bowersj2 1308: =cut
1309:
1310: sub help_open_topic {
1.1381 raeburn 1311: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1312: $text = "" if (not defined $text);
1.44 bowersj2 1313: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1314: $width = 500 if (not defined $width);
1.44 bowersj2 1315: $height = 400 if (not defined $height);
1316: my $filename = $topic;
1317: $filename =~ s/ /_/g;
1318:
1.48 bowersj2 1319: my $template = "";
1320: my $link;
1.572 banghart 1321:
1.159 www 1322: $topic=~s/\W/\_/g;
1.44 bowersj2 1323:
1.572 banghart 1324: if (!$stayOnPage) {
1.1033 www 1325: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1326: } elsif ($stayOnPage eq 'popup') {
1327: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1328: } else {
1.48 bowersj2 1329: $link = "/adm/help/${filename}.hlp";
1330: }
1331:
1332: # Add the text
1.1314 raeburn 1333: my $target = ' target="_top"';
1.1381 raeburn 1334: if ($links_target) {
1335: $target = ' target="'.$links_target.'"';
1336: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1337: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1338: $target = '';
1.1378 raeburn 1339: }
1.1380 raeburn 1340: if ($text ne "") {
1.763 bisitz 1341: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1342: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1343: .$text.'</a>';
1.48 bowersj2 1344: }
1345:
1.763 bisitz 1346: # (Always) Add the graphic
1.179 matthew 1347: my $title = &mt('Online Help');
1.667 raeburn 1348: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1349: if ($imgid ne '') {
1350: $imgid = ' id="'.$imgid.'"';
1351: }
1.1314 raeburn 1352: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1353: .'<img src="'.$helpicon.'" border="0"'
1354: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1355: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1356: .' /></a>';
1357: if ($text ne "") {
1358: $template.='</span>';
1359: }
1.44 bowersj2 1360: return $template;
1361:
1.106 bowersj2 1362: }
1363:
1364: # This is a quicky function for Latex cheatsheet editing, since it
1365: # appears in at least four places
1366: sub helpLatexCheatsheet {
1.1037 www 1367: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1368: my $out;
1.106 bowersj2 1369: my $addOther = '';
1.732 raeburn 1370: if ($topic) {
1.1037 www 1371: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1372: }
1373: $out = '<span>' # Start cheatsheet
1374: .$addOther
1375: .'<span>'
1.1037 www 1376: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1377: .'</span> <span>'
1.1037 www 1378: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1379: .'</span>';
1.732 raeburn 1380: unless ($not_author) {
1.1186 kruse 1381: $out .= '<span>'
1382: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1383: .'</span> <span>'
1.1424 raeburn 1384: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763 bisitz 1385: .'</span>';
1.732 raeburn 1386: }
1.763 bisitz 1387: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1388: return $out;
1.172 www 1389: }
1390:
1.430 albertel 1391: sub general_help {
1392: my $helptopic='Student_Intro';
1393: if ($env{'request.role'}=~/^(ca|au)/) {
1394: $helptopic='Authoring_Intro';
1.907 raeburn 1395: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1396: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1397: } elsif ($env{'request.role'}=~/^dc/) {
1398: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1399: }
1400: return $helptopic;
1401: }
1402:
1403: sub update_help_link {
1404: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1405: my $origurl = $ENV{'REQUEST_URI'};
1406: $origurl=~s|^/~|/priv/|;
1407: my $timestamp = time;
1408: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1409: $$datum = &escape($$datum);
1410: }
1411:
1412: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1413: my $output .= <<"ENDOUTPUT";
1414: <script type="text/javascript">
1.824 bisitz 1415: // <![CDATA[
1.430 albertel 1416: banner_link = '$banner_link';
1.824 bisitz 1417: // ]]>
1.430 albertel 1418: </script>
1419: ENDOUTPUT
1420: return $output;
1421: }
1422:
1423: # now just updates the help link and generates a blue icon
1.193 raeburn 1424: sub help_open_menu {
1.1381 raeburn 1425: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1426: = @_;
1.949 droeschl 1427: $stayOnPage = 1;
1.430 albertel 1428: my $output;
1429: if ($component_help) {
1430: if (!$text) {
1431: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1432: $width,$height,'',$links_target);
1.430 albertel 1433: } else {
1434: my $help_text;
1435: $help_text=&unescape($topic);
1436: $output='<table><tr><td>'.
1437: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1438: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1439: }
1440: }
1441: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1442: return $output.$banner_link;
1443: }
1444:
1445: sub top_nav_help {
1.1369 raeburn 1446: my ($text,$linkattr) = @_;
1.436 albertel 1447: $text = &mt($text);
1.949 droeschl 1448: my $stay_on_page = 1;
1449:
1.1168 raeburn 1450: my ($link,$banner_link);
1451: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1452: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1453: : "javascript:helpMenu('open')";
1454: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1455: }
1.201 raeburn 1456: my $title = &mt('Get help');
1.1168 raeburn 1457: if ($link) {
1458: return <<"END";
1.436 albertel 1459: $banner_link
1.1369 raeburn 1460: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1461: END
1.1168 raeburn 1462: } else {
1.1459 raeburn 1463: return ' <h1 class="LC_helpmenu">'.$text.'</h1> ';
1.1168 raeburn 1464: }
1.436 albertel 1465: }
1466:
1467: sub help_menu_js {
1.1154 raeburn 1468: my ($httphost) = @_;
1.949 droeschl 1469: my $stayOnPage = 1;
1.436 albertel 1470: my $width = 620;
1471: my $height = 600;
1.430 albertel 1472: my $helptopic=&general_help();
1.1154 raeburn 1473: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1474: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.1459 raeburn 1475: my $bannertitle = &mt('Help Menu');
1476: &js_escape(\$bannertitle);
1477: my $bodytitle = &mt('Documentation');
1478: &js_escape(\$bodytitle);
1.331 albertel 1479: my $start_page =
1480: &Apache::loncommon::start_page('Help Menu', undef,
1481: {'frameset' => 1,
1482: 'js_ready' => 1,
1.1154 raeburn 1483: 'use_absolute' => $httphost,
1.331 albertel 1484: 'add_entries' => {
1.1168 raeburn 1485: 'border' => '0',
1.579 raeburn 1486: 'rows' => "110,*",},});
1.331 albertel 1487: my $end_page =
1488: &Apache::loncommon::end_page({'frameset' => 1,
1489: 'js_ready' => 1,});
1.436 albertel 1490: my $template .= <<"ENDTEMPLATE";
1491: <script type="text/javascript">
1.877 bisitz 1492: // <![CDATA[
1.253 albertel 1493: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1494: var banner_link = '';
1.243 raeburn 1495: function helpMenu(target) {
1496: var caller = this;
1497: if (target == 'open') {
1498: var newWindow = null;
1499: try {
1.262 albertel 1500: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1501: }
1502: catch(error) {
1503: writeHelp(caller);
1504: return;
1505: }
1506: if (newWindow) {
1507: caller = newWindow;
1508: }
1.193 raeburn 1509: }
1.243 raeburn 1510: writeHelp(caller);
1511: return;
1512: }
1513: function writeHelp(caller) {
1.1459 raeburn 1514: caller.document.writeln('$start_page\\n<frame name="bannerframe" title="$bannertitle" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1515: caller.document.writeln('<frame name="bodyframe" title="$bodytitle" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1.1168 raeburn 1516: caller.document.close();
1517: caller.focus();
1.193 raeburn 1518: }
1.877 bisitz 1519: // END LON-CAPA Internal -->
1.253 albertel 1520: // ]]>
1.436 albertel 1521: </script>
1.193 raeburn 1522: ENDTEMPLATE
1523: return $template;
1524: }
1525:
1.172 www 1526: sub help_open_bug {
1527: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1528: unless ($env{'user.adv'}) { return ''; }
1.172 www 1529: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1530: $text = "" if (not defined $text);
1531: $stayOnPage=1;
1.184 albertel 1532: $width = 600 if (not defined $width);
1533: $height = 600 if (not defined $height);
1.172 www 1534:
1535: $topic=~s/\W+/\+/g;
1536: my $link='';
1537: my $template='';
1.379 albertel 1538: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1539: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1540: if (!$stayOnPage)
1541: {
1542: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1543: }
1544: else
1545: {
1546: $link = $url;
1547: }
1.1314 raeburn 1548:
1.1382 raeburn 1549: my $target = '_top';
1550: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1551: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1552: $target = '_blank';
1.1378 raeburn 1553: }
1.1382 raeburn 1554:
1.172 www 1555: # Add the text
1556: if ($text ne "")
1557: {
1558: $template .=
1559: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1560: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1561: }
1562:
1563: # Add the graphic
1.179 matthew 1564: my $title = &mt('Report a Bug');
1.215 albertel 1565: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1566: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1567: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1568: ENDTEMPLATE
1569: if ($text ne '') { $template.='</td></tr></table>' };
1570: return $template;
1571:
1572: }
1573:
1574: sub help_open_faq {
1575: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1576: unless ($env{'user.adv'}) { return ''; }
1.172 www 1577: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1578: $text = "" if (not defined $text);
1579: $stayOnPage=1;
1580: $width = 350 if (not defined $width);
1581: $height = 400 if (not defined $height);
1582:
1583: $topic=~s/\W+/\+/g;
1584: my $link='';
1585: my $template='';
1586: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1587: if (!$stayOnPage)
1588: {
1589: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1590: }
1591: else
1592: {
1593: $link = $url;
1594: }
1595:
1596: # Add the text
1597: if ($text ne "")
1598: {
1599: $template .=
1.173 www 1600: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1601: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1602: }
1603:
1604: # Add the graphic
1.179 matthew 1605: my $title = &mt('View the FAQ');
1.215 albertel 1606: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1607: $template .= <<"ENDTEMPLATE";
1.436 albertel 1608: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1609: ENDTEMPLATE
1610: if ($text ne '') { $template.='</td></tr></table>' };
1611: return $template;
1612:
1.44 bowersj2 1613: }
1.37 matthew 1614:
1.180 matthew 1615: ###############################################################
1616: ###############################################################
1617:
1.45 matthew 1618: =pod
1619:
1.648 raeburn 1620: =item * &change_content_javascript():
1.256 matthew 1621:
1622: This and the next function allow you to create small sections of an
1623: otherwise static HTML page that you can update on the fly with
1624: Javascript, even in Netscape 4.
1625:
1626: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1627: must be written to the HTML page once. It will prove the Javascript
1628: function "change(name, content)". Calling the change function with the
1629: name of the section
1630: you want to update, matching the name passed to C<changable_area>, and
1631: the new content you want to put in there, will put the content into
1632: that area.
1633:
1634: B<Note>: Netscape 4 only reserves enough space for the changable area
1635: to contain room for the original contents. You need to "make space"
1636: for whatever changes you wish to make, and be B<sure> to check your
1637: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1638: it's adequate for updating a one-line status display, but little more.
1639: This script will set the space to 100% width, so you only need to
1640: worry about height in Netscape 4.
1641:
1642: Modern browsers are much less limiting, and if you can commit to the
1643: user not using Netscape 4, this feature may be used freely with
1644: pretty much any HTML.
1645:
1646: =cut
1647:
1648: sub change_content_javascript {
1649: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1650: if ($env{'browser.type'} eq 'netscape' &&
1651: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1652: return (<<NETSCAPE4);
1653: function change(name, content) {
1654: doc = document.layers[name+"___escape"].layers[0].document;
1655: doc.open();
1656: doc.write(content);
1657: doc.close();
1658: }
1659: NETSCAPE4
1660: } else {
1661: # Otherwise, we need to use semi-standards-compliant code
1662: # (technically, "innerHTML" isn't standard but the equivalent
1663: # is really scary, and every useful browser supports it
1664: return (<<DOMBASED);
1665: function change(name, content) {
1666: element = document.getElementById(name);
1667: element.innerHTML = content;
1668: }
1669: DOMBASED
1670: }
1671: }
1672:
1673: =pod
1674:
1.648 raeburn 1675: =item * &changable_area($name,$origContent):
1.256 matthew 1676:
1677: This provides a "changable area" that can be modified on the fly via
1678: the Javascript code provided in C<change_content_javascript>. $name is
1679: the name you will use to reference the area later; do not repeat the
1680: same name on a given HTML page more then once. $origContent is what
1681: the area will originally contain, which can be left blank.
1682:
1683: =cut
1684:
1685: sub changable_area {
1686: my ($name, $origContent) = @_;
1687:
1.258 albertel 1688: if ($env{'browser.type'} eq 'netscape' &&
1689: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1690: # If this is netscape 4, we need to use the Layer tag
1691: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1692: } else {
1693: return "<span id='$name'>$origContent</span>";
1694: }
1695: }
1696:
1697: =pod
1698:
1.648 raeburn 1699: =item * &viewport_geometry_js
1.590 raeburn 1700:
1701: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1702:
1703: =cut
1704:
1705:
1706: sub viewport_geometry_js {
1707: return <<"GEOMETRY";
1708: var Geometry = {};
1709: function init_geometry() {
1710: if (Geometry.init) { return };
1711: Geometry.init=1;
1712: if (window.innerHeight) {
1713: Geometry.getViewportHeight = function() { return window.innerHeight; };
1714: Geometry.getViewportWidth = function() { return window.innerWidth; };
1715: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1716: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1717: }
1718: else if (document.documentElement && document.documentElement.clientHeight) {
1719: Geometry.getViewportHeight =
1720: function() { return document.documentElement.clientHeight; };
1721: Geometry.getViewportWidth =
1722: function() { return document.documentElement.clientWidth; };
1723:
1724: Geometry.getHorizontalScroll =
1725: function() { return document.documentElement.scrollLeft; };
1726: Geometry.getVerticalScroll =
1727: function() { return document.documentElement.scrollTop; };
1728: }
1729: else if (document.body.clientHeight) {
1730: Geometry.getViewportHeight =
1731: function() { return document.body.clientHeight; };
1732: Geometry.getViewportWidth =
1733: function() { return document.body.clientWidth; };
1734: Geometry.getHorizontalScroll =
1735: function() { return document.body.scrollLeft; };
1736: Geometry.getVerticalScroll =
1737: function() { return document.body.scrollTop; };
1738: }
1739: }
1740:
1741: GEOMETRY
1742: }
1743:
1744: =pod
1745:
1.648 raeburn 1746: =item * &viewport_size_js()
1.590 raeburn 1747:
1748: 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.
1749:
1750: =cut
1751:
1752: sub viewport_size_js {
1753: my $geometry = &viewport_geometry_js();
1754: return <<"DIMS";
1755:
1756: $geometry
1757:
1758: function getViewportDims(width,height) {
1759: init_geometry();
1760: width.value = Geometry.getViewportWidth();
1761: height.value = Geometry.getViewportHeight();
1762: return;
1763: }
1764:
1765: DIMS
1766: }
1767:
1768: =pod
1769:
1.648 raeburn 1770: =item * &resize_textarea_js()
1.565 albertel 1771:
1772: emits the needed javascript to resize a textarea to be as big as possible
1773:
1774: creates a function resize_textrea that takes two IDs first should be
1775: the id of the element to resize, second should be the id of a div that
1776: surrounds everything that comes after the textarea, this routine needs
1777: to be attached to the <body> for the onload and onresize events.
1778:
1779: =cut
1780:
1781: sub resize_textarea_js {
1.590 raeburn 1782: my $geometry = &viewport_geometry_js();
1.565 albertel 1783: return <<"RESIZE";
1784: <script type="text/javascript">
1.824 bisitz 1785: // <![CDATA[
1.590 raeburn 1786: $geometry
1.565 albertel 1787:
1.588 albertel 1788: function getX(element) {
1789: var x = 0;
1790: while (element) {
1791: x += element.offsetLeft;
1792: element = element.offsetParent;
1793: }
1794: return x;
1795: }
1796: function getY(element) {
1797: var y = 0;
1798: while (element) {
1799: y += element.offsetTop;
1800: element = element.offsetParent;
1801: }
1802: return y;
1803: }
1804:
1805:
1.565 albertel 1806: function resize_textarea(textarea_id,bottom_id) {
1807: init_geometry();
1808: var textarea = document.getElementById(textarea_id);
1809: //alert(textarea);
1810:
1.588 albertel 1811: var textarea_top = getY(textarea);
1.565 albertel 1812: var textarea_height = textarea.offsetHeight;
1813: var bottom = document.getElementById(bottom_id);
1.588 albertel 1814: var bottom_top = getY(bottom);
1.565 albertel 1815: var bottom_height = bottom.offsetHeight;
1816: var window_height = Geometry.getViewportHeight();
1.588 albertel 1817: var fudge = 23;
1.565 albertel 1818: var new_height = window_height-fudge-textarea_top-bottom_height;
1819: if (new_height < 300) {
1820: new_height = 300;
1821: }
1822: textarea.style.height=new_height+'px';
1823: }
1.824 bisitz 1824: // ]]>
1.565 albertel 1825: </script>
1826: RESIZE
1827:
1828: }
1829:
1.1205 golterma 1830: sub colorfuleditor_js {
1.1248 raeburn 1831: my $browse_or_search;
1832: my $respath;
1833: my ($cnum,$cdom) = &crsauthor_url();
1834: if ($cnum) {
1835: $respath = "/res/$cdom/$cnum/";
1836: my %js_lt = &Apache::lonlocal::texthash(
1837: sunm => 'Sub-directory name',
1838: save => 'Save page to make this permanent',
1839: );
1840: &js_escape(\%js_lt);
1.1400 raeburn 1841: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1842: $browse_or_search = <<"END";
1843:
1.1400 raeburn 1844: $showfile_js
1845:
1.1248 raeburn 1846: function toggleChooser(form,element,titleid,only,search) {
1847: var disp = 'none';
1848: if (document.getElementById('chooser_'+element)) {
1849: var curr = document.getElementById('chooser_'+element).style.display;
1850: if (curr == 'none') {
1851: disp='inline';
1852: if (form.elements['chooser_'+element].length) {
1853: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1854: form.elements['chooser_'+element][i].checked = false;
1855: }
1856: }
1857: toggleResImport(form,element);
1858: }
1859: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1860: var dirsel = '';
1861: var filesel = '';
1862: if (document.getElementById('chooser_'+element+'_crsres')) {
1863: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1864: if (currcrsres == 'none') {
1865: dirsel = 'coursepath_'+element;
1866: var filesel = 'coursefile_'+element;
1867: var include;
1868: if (document.getElementById('crsres_include_'+element)) {
1869: include = document.getElementById('crsres_include_'+element).value;
1870: }
1.1402 raeburn 1871: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1872: }
1873: }
1874: if (document.getElementById('chooser_'+element+'_upload')) {
1875: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1876: if (currcrsupload == 'none') {
1877: dirsel = 'crsauthorpath_'+element;
1878: filesel = '';
1.1402 raeburn 1879: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1880: }
1881: }
1.1248 raeburn 1882: }
1883: }
1884:
1.1400 raeburn 1885: function toggleCrsFile(form,element) {
1.1248 raeburn 1886: if (document.getElementById('chooser_'+element+'_crsres')) {
1887: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1888: if (curr == 'none') {
1.1400 raeburn 1889: if (document.getElementById('coursepath_'+element)) {
1890: var numdirs;
1891: if (document.getElementById('coursepath_'+element).length) {
1892: numdirs = document.getElementById('coursepath_'+element).length;
1893: }
1.1402 raeburn 1894: if ((document.getElementById('hascrsres_'+element)) &&
1895: (document.getElementById('nocrsres_'+element))) {
1896: if (numdirs) {
1897: document.getElementById('hascrsres_'+element).style.display='inline-block';
1898: document.getElementById('nocrsres_'+element).style.display='none';
1899: } else {
1900: document.getElementById('hascrsres_'+element).style.display='none';
1901: document.getElementById('nocrsres_'+element).style.display='inline-block';
1902: }
1903: }
1.1248 raeburn 1904: form.elements['coursepath_'+element].selectedIndex = 0;
1905: if (numdirs > 1) {
1.1400 raeburn 1906: var selelem = form.elements['coursefile_'+element];
1907: var i, len = selelem.options.length -1;
1908: if (len >=0) {
1909: for (i = len; i >= 0; i--) {
1910: selelem.remove(i);
1911: }
1912: selelem.options[0] = new Option('','');
1913: }
1.1248 raeburn 1914: }
1915: }
1.1400 raeburn 1916: }
1.1248 raeburn 1917: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1918: }
1919: if (document.getElementById('chooser_'+element+'_upload')) {
1920: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1921: if (document.getElementById('uploadcrsres_'+element)) {
1922: document.getElementById('uploadcrsres_'+element).value = '';
1923: }
1924: }
1925: return;
1926: }
1927:
1.1400 raeburn 1928: function toggleCrsUpload(form,element) {
1.1248 raeburn 1929: if (document.getElementById('chooser_'+element+'_crsres')) {
1930: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1931: }
1932: if (document.getElementById('chooser_'+element+'_upload')) {
1933: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1934: if (curr == 'none') {
1.1400 raeburn 1935: form.elements['newsubdir_'+element][0].checked = true;
1936: toggleNewsubdir(form,element);
1937: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1938: if (document.getElementById('uploadcrsres_'+element)) {
1939: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1940: }
1941: }
1942: }
1943: return;
1944: }
1945:
1946: function toggleResImport(form,element) {
1947: var choices = new Array('crsres','upload');
1948: for (var i=0; i<choices.length; i++) {
1949: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1950: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1951: }
1952: }
1953: }
1954:
1955: function toggleNewsubdir(form,element) {
1956: var newsub = form.elements['newsubdir_'+element];
1957: if (newsub) {
1958: if (newsub.length) {
1959: for (var j=0; j<newsub.length; j++) {
1960: if (newsub[j].checked) {
1961: if (document.getElementById('newsubdirname_'+element)) {
1962: if (newsub[j].value == '1') {
1963: document.getElementById('newsubdirname_'+element).type = "text";
1964: if (document.getElementById('newsubdir_'+element)) {
1965: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1966: }
1967: } else {
1968: document.getElementById('newsubdirname_'+element).type = "hidden";
1969: document.getElementById('newsubdirname_'+element).value = "";
1970: document.getElementById('newsubdir_'+element).innerHTML = "";
1971: }
1972: }
1973: break;
1974: }
1975: }
1976: }
1977: }
1978: }
1979:
1980: function updateCrsFile(form,element) {
1981: var directory = form.elements['coursepath_'+element];
1982: var filename = form.elements['coursefile_'+element];
1983: var path = directory.options[directory.selectedIndex].value;
1984: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1985: if (file != '') {
1986: form.elements[element].value = '$respath';
1987: if (path == '/') {
1988: form.elements[element].value += file;
1989: } else {
1990: form.elements[element].value += path+'/'+file;
1991: }
1992: unClean();
1993: if (document.getElementById('previewimg_'+element)) {
1994: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1995: var newsrc = document.getElementById('previewimg_'+element).src;
1996: }
1997: if (document.getElementById('showimg_'+element)) {
1998: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1999: }
1.1248 raeburn 2000: }
2001: toggleChooser(form,element);
2002: return;
2003: }
2004:
2005: function uploadDone(suffix,name) {
2006: if (name) {
2007: document.forms["lonhomework"].elements[suffix].value = name;
2008: unClean();
2009: toggleChooser(document.forms["lonhomework"],suffix);
2010: }
2011: }
2012:
2013: \$(document).ready(function(){
2014:
2015: \$(document).delegate('form :submit', 'click', function( event ) {
2016: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2017: var buttonId = this.id;
2018: var suffix = buttonId.toString();
2019: suffix = suffix.replace(/^crsupload_/,'');
2020: event.preventDefault();
2021: document.lonhomework.target = 'crsupload_target_'+suffix;
2022: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2023: \$(this.form).submit();
2024: document.lonhomework.target = '';
2025: if (document.getElementById('crsuploadto_'+suffix)) {
2026: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2027: }
2028: return false;
2029: }
2030: });
2031: });
2032: END
2033: }
1.1205 golterma 2034: return <<"COLORFULEDIT"
2035: <script type="text/javascript">
2036: // <![CDATA[>
2037: function fold_box(curDepth, lastresource){
2038:
2039: // we need a list because there can be several blocks you need to fold in one tag
2040: var block = document.getElementsByName('foldblock_'+curDepth);
2041: // but there is only one folding button per tag
2042: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2043:
2044: if(block.item(0).style.display == 'none'){
2045:
2046: foldbutton.value = '@{[&mt("Hide")]}';
2047: for (i = 0; i < block.length; i++){
2048: block.item(i).style.display = '';
2049: }
2050: }else{
2051:
2052: foldbutton.value = '@{[&mt("Show")]}';
2053: for (i = 0; i < block.length; i++){
2054: // block.item(i).style.visibility = 'collapse';
2055: block.item(i).style.display = 'none';
2056: }
2057: };
2058: saveState(lastresource);
2059: }
2060:
2061: function saveState (lastresource) {
2062:
2063: var tag_list = getTagList();
2064: if(tag_list != null){
2065: var timestamp = new Date().getTime();
2066: var key = lastresource;
2067:
2068: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2069: // starting with timestamp
2070: var value = timestamp+';';
2071:
2072: // building the list of key-value pairs
2073: for(var i = 0; i < tag_list.length; i++){
2074: value += tag_list[i]+',';
2075: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2076: }
2077:
2078: // only iterate whole storage if nothing to override
2079: if(localStorage.getItem(key) == null){
2080:
2081: // prevent storage from growing large
2082: if(localStorage.length > 50){
2083: var regex_getTimestamp = /^(?:\d)+;/;
2084: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2085: var oldest_key;
2086:
2087: for(var i = 1; i < localStorage.length; i++){
2088: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2089: oldest_key = localStorage.key(i);
2090: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2091: }
2092: }
2093: localStorage.removeItem(oldest_key);
2094: }
2095: }
2096: localStorage.setItem(key,value);
2097: }
2098: }
2099:
2100: // restore folding status of blocks (on page load)
2101: function restoreState (lastresource) {
2102: if(localStorage.getItem(lastresource) != null){
2103: var key = lastresource;
2104: var value = localStorage.getItem(key);
2105: var regex_delTimestamp = /^\d+;/;
2106:
2107: value.replace(regex_delTimestamp, '');
2108:
2109: var valueArr = value.split(';');
2110: var pairs;
2111: var elements;
2112: for (var i = 0; i < valueArr.length; i++){
2113: pairs = valueArr[i].split(',');
2114: elements = document.getElementsByName(pairs[0]);
2115:
2116: for (var j = 0; j < elements.length; j++){
2117: elements[j].style.display = pairs[1];
2118: if (pairs[1] == "none"){
2119: var regex_id = /([_\\d]+)\$/;
2120: regex_id.exec(pairs[0]);
2121: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2122: }
2123: }
2124: }
2125: }
2126: }
2127:
2128: function getTagList () {
2129:
2130: var stringToSearch = document.lonhomework.innerHTML;
2131:
2132: var ret = new Array();
2133: var regex_findBlock = /(foldblock_.*?)"/g;
2134: var tag_list = stringToSearch.match(regex_findBlock);
2135:
2136: if(tag_list != null){
2137: for(var i = 0; i < tag_list.length; i++){
2138: ret.push(tag_list[i].replace(/"/, ''));
2139: }
2140: }
2141: return ret;
2142: }
2143:
2144: function saveScrollPosition (resource) {
2145: var tag_list = getTagList();
2146:
2147: // we dont always want to jump to the first block
2148: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2149: if(\$(window).scrollTop() > 170){
2150: if(tag_list != null){
2151: var result;
2152: for(var i = 0; i < tag_list.length; i++){
2153: if(isElementInViewport(tag_list[i])){
2154: result += tag_list[i]+';';
2155: }
2156: }
2157: sessionStorage.setItem('anchor_'+resource, result);
2158: }
2159: } else {
2160: // we dont need to save zero, just delete the item to leave everything tidy
2161: sessionStorage.removeItem('anchor_'+resource);
2162: }
2163: }
2164:
2165: function restoreScrollPosition(resource){
2166:
2167: var elem = sessionStorage.getItem('anchor_'+resource);
2168: if(elem != null){
2169: var tag_list = elem.split(';');
2170: var elem_list;
2171:
2172: for(var i = 0; i < tag_list.length; i++){
2173: elem_list = document.getElementsByName(tag_list[i]);
2174:
2175: if(elem_list.length > 0){
2176: elem = elem_list[0];
2177: break;
2178: }
2179: }
2180: elem.scrollIntoView();
2181: }
2182: }
2183:
2184: function isElementInViewport(el) {
2185:
2186: // change to last element instead of first
2187: var elem = document.getElementsByName(el);
2188: var rect = elem[0].getBoundingClientRect();
2189:
2190: return (
2191: rect.top >= 0 &&
2192: rect.left >= 0 &&
2193: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2194: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2195: );
2196: }
2197:
2198: function autosize(depth){
2199: var cmInst = window['cm'+depth];
2200: var fitsizeButton = document.getElementById('fitsize'+depth);
2201:
2202: // is fixed size, switching to dynamic
2203: if (sessionStorage.getItem("autosized_"+depth) == null) {
2204: cmInst.setSize("","auto");
2205: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2206: sessionStorage.setItem("autosized_"+depth, "yes");
2207:
2208: // is dynamic size, switching to fixed
2209: } else {
2210: cmInst.setSize("","300px");
2211: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2212: sessionStorage.removeItem("autosized_"+depth);
2213: }
2214: }
2215:
1.1248 raeburn 2216: $browse_or_search
1.1205 golterma 2217:
2218: // ]]>
2219: </script>
2220: COLORFULEDIT
2221: }
2222:
2223: sub xmleditor_js {
2224: return <<XMLEDIT
2225: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2226: <script type="text/javascript">
2227: // <![CDATA[>
2228:
2229: function saveScrollPosition (resource) {
2230:
2231: var scrollPos = \$(window).scrollTop();
2232: sessionStorage.setItem(resource,scrollPos);
2233: }
2234:
2235: function restoreScrollPosition(resource){
2236:
2237: var scrollPos = sessionStorage.getItem(resource);
2238: \$(window).scrollTop(scrollPos);
2239: }
2240:
2241: // unless internet explorer
2242: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2243:
2244: \$(document).ready(function() {
2245: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2246: });
2247: }
2248:
2249: // inserts text at cursor position into codemirror (xml editor only)
2250: function insertText(text){
2251: cm.focus();
2252: var curPos = cm.getCursor();
2253: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2254: }
2255: // ]]>
2256: </script>
2257: XMLEDIT
2258: }
2259:
2260: sub insert_folding_button {
2261: my $curDepth = $Apache::lonxml::curdepth;
2262: my $lastresource = $env{'request.ambiguous'};
2263:
2264: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2265: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2266: }
2267:
1.1248 raeburn 2268: sub crsauthor_url {
2269: my ($url) = @_;
2270: if ($url eq '') {
2271: $url = $ENV{'REQUEST_URI'};
2272: }
2273: my ($cnum,$cdom);
2274: if ($env{'request.course.id'}) {
2275: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2276: if ($audom ne '' && $auname ne '') {
2277: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2278: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2279: $cnum = $auname;
2280: $cdom = $audom;
2281: }
2282: }
2283: }
2284: return ($cnum,$cdom);
2285: }
2286:
2287: sub import_crsauthor_form {
1.1400 raeburn 2288: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2289: return (0) unless ($env{'request.course.id'});
2290: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2291: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2292: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2293: return (0) unless (($cnum ne '') && ($cdom ne ''));
2294: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2295: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2296:
1.1248 raeburn 2297: if (grep(/^\Q$crshome\E$/,@ids)) {
2298: $is_home = 1;
2299: }
1.1400 raeburn 2300: $toppath = "/priv/$cdom/$cnum";
2301: my $nonemptydir = 1;
2302: my $js_only;
2303: if ($only) {
2304: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2305: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2306: }
2307: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2308: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2309: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2310: my %lt = &Apache::lonlocal::texthash (
2311: fnam => 'Filename',
2312: dire => 'Directory',
1.1400 raeburn 2313: se => 'Select',
1.1248 raeburn 2314: );
1.1450 raeburn 2315: $output = '<label>'.$lt{'dire'}.': '.
1.1400 raeburn 2316: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2317: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2318: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2319: if ($files{'/'}) {
2320: $output .= '<option value="/">/</option>'."\n";
2321: }
1.1400 raeburn 2322: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2323: next if ($key eq '/');
1.1400 raeburn 2324: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2325: }
1.1450 raeburn 2326: $output .= '</select></label><br /><label>'."\n".
1.1402 raeburn 2327: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2328: '<option value="" selected="selected"></option>'."\n".
1.1450 raeburn 2329: '</select></label>'."\n".
1.1402 raeburn 2330: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2331: return ($numdirs,$output);
2332: }
2333:
2334: sub show_crsfiles_js {
2335: my $excluderef = &Apache::lonnet::priv_exclude();
2336: my $se = &js_escape(&mt('Select'));
2337: my $exclude;
2338: if (ref($excluderef) eq 'HASH') {
2339: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2340: }
2341: my $js = <<"END";
2342:
2343:
1.1402 raeburn 2344: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2345: var relpath = '';
2346: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2347: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2348: if (currdir == '') {
2349: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2350: selelem = form.elements[filesel];
2351: var j, numfiles = selelem.options.length -1;
2352: if (numfiles >=0) {
2353: for (j = numfiles; j >= 0; j--) {
2354: selelem.remove(j);
2355: }
2356: }
2357: if (selelem.options.length == 0) {
2358: selelem.options[selelem.options.length] = new Option('','');
2359: selelem.selectedIndex = 0;
1.1248 raeburn 2360: }
2361: }
1.1400 raeburn 2362: return;
2363: } else {
2364: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2365: }
2366: }
1.1400 raeburn 2367: var http = new XMLHttpRequest();
2368: var url = "/adm/courseauthor";
2369: var crsrole = "$env{'request.role'}";
2370: var exclude = '';
2371: if (exc) {
2372: exclude = '$exclude';
2373: }
1.1402 raeburn 2374: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2375: http.open("POST", url, true);
2376: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2377: http.onreadystatechange = function() {
2378: if (http.readyState == 4 && http.status == 200) {
2379: var data = JSON.parse(http.responseText);
2380: var selelem;
2381: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2382: if (Array.isArray(data.dirs)) {
2383: selelem = form.elements[dirsel];
2384: var i, numdirs = selelem.options.length -1;
2385: if (numdirs >=0) {
2386: for (i = numdirs; i >= 0; i--) {
2387: selelem.remove(i);
2388: }
2389: }
2390: var len = data.dirs.length;
2391: if (len) {
1.1402 raeburn 2392: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2393: var j;
2394: for (j = 0; j < len; j++) {
2395: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2396: }
2397: selelem.selectedIndex = 0;
2398: }
2399: if (!setfile) {
2400: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2401: selelem = form.elements[filesel];
2402: var j, numfiles = selelem.options.length -1;
2403: if (numfiles >=0) {
2404: for (j = numfiles; j >= 0; j--) {
2405: selelem.remove(j);
2406: }
2407: }
2408: if (selelem.options.length == 0) {
2409: selelem.options[selelem.options.length] = new Option('','');
2410: selelem.selectedIndex = 0;
2411: }
2412: }
2413: }
2414: }
2415: }
2416: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2417: selelem = form.elements[filesel];
2418: var i, numfiles = selelem.options.length -1;
2419: if (numfiles >=0) {
2420: for (i = numfiles; i >= 0; i--) {
2421: selelem.remove(i);
2422: }
2423: }
2424: var x;
2425: for (x in data.files) {
2426: if (Array.isArray(data.files[x])) {
2427: if (data.files[x].length > 1) {
2428: selelem.options[selelem.options.length] = new Option('$se','');
2429: }
2430: var len = data.files[x].length;
2431: if (len) {
2432: var k;
2433: for (k = 0; k < len; k++) {
2434: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2435: }
2436: selelem.selectedIndex = 0;
2437: }
2438: }
2439: }
2440: if (selelem.options.length == 0) {
2441: selelem.options[selelem.options.length] = new Option('','');
2442: selelem.selectedIndex = 0;
2443: }
1.1248 raeburn 2444: }
2445: }
2446: }
1.1400 raeburn 2447: http.send(params);
1.1248 raeburn 2448: }
1.1400 raeburn 2449: END
1.1248 raeburn 2450: }
2451:
1.1426 raeburn 2452: sub crsauthor_rights {
2453: my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
2454: my $sourcerights = "$path/$rightsfile";
2455: my $now = time;
2456: if (!-e $sourcerights) {
2457: my $cid = $cdom.'_'.$cnum;
2458: if (!-e "$docroot/priv/$cdom") {
2459: mkdir("$docroot/priv/$cdom",0755);
2460: }
2461: if (!-e "$docroot/priv/$cdom/$cnum") {
2462: mkdir("$docroot/priv/$cdom/$cnum",0755);
2463: }
2464: if (open(my $fh,">$sourcerights")) {
2465: print $fh <<END;
2466: <accessrule effect="deny" realm="" type="course" role="" />
2467: <accessrule effect="allow" realm="$cid" type="course" role="" />
2468: END
2469: close($fh);
2470: }
2471: }
2472: if (!-e "$sourcerights.meta") {
2473: if (open(my $fh,">$sourcerights.meta")) {
2474: my $author=$env{'environment.firstname'}.' '.
2475: $env{'environment.middlename'}.' '.
2476: $env{'environment.lastname'}.' '.
2477: $env{'environment.generation'};
2478: $author =~ s/\s+$//;
2479: print $fh <<"END";
2480:
2481: <abstract></abstract>
2482: <author>$author</author>
2483: <authorspace>$cnum:$cdom</authorspace>
2484: <copyright>private</copyright>
2485: <creationdate>$now</creationdate>
2486: <customdistributionfile></customdistributionfile>
2487: <dependencies></dependencies>
2488: <domain>$cdom</domain>
2489: <highestgradelevel>0</highestgradelevel>
2490: <keywords></keywords>
1.1445 raeburn 2491: <language>notset</language>
1.1426 raeburn 2492: <lastrevisiondate>$now</lastrevisiondate>
2493: <lowestgradelevel>0</lowestgradelevel>
2494: <mime>rights</mime>
2495: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
2496: <notes></notes>
2497: <obsolete></obsolete>
2498: <obsoletereplacement></obsoletereplacement>
2499: <owner>$cnum:$cdom</owner>
2500: <rule>deny:::course,allow:$cid::course</rule>
2501: <sourceavail></sourceavail>
2502: <standards></standards>
2503: <subject></subject>
2504: <title>Course Authoring Rights</title>
2505: END
2506: close($fh);
2507: }
2508: }
2509: return;
2510: }
2511:
1.565 albertel 2512: =pod
2513:
1.1420 raeburn 2514: =item * &iframe_wrapper_headjs()
2515:
1.1425 raeburn 2516: emits javascript containing two global vars to facilitate handling of resizing
2517: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
2518: with standard LON-CAPA menus.
2519:
2520: =cut
2521:
1.1420 raeburn 2522: #
2523: # Where iframe is in use, if window.onload() executes before the custom resize function
2524: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
2525: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
2526: # do not obscure the Functions menu.
2527: #
2528:
2529: sub iframe_wrapper_headjs {
2530: return <<"ENDJS";
2531: <script type="text/javascript">
2532: // <![CDATA[
2533: var LCnotready = 0;
2534: var LCresizedef = 0;
2535: // ]]>
2536: </script>
2537:
2538: ENDJS
2539:
2540: }
2541:
2542: =pod
2543:
2544: =item * &iframe_wrapper_resizejs()
2545:
1.1425 raeburn 2546: emits javascript used to handle resizing for a page containing
2547: an iframe, to ensure that the iframe does not obscure any
2548: standard LON-CAPA menu items.
2549:
2550: =back
2551:
2552: =cut
2553:
1.1420 raeburn 2554: #
2555: # jQuery to use when iframe is in use and a page resize occurs.
2556: # This script will ensure that the iframe does not obscure any
2557: # standard LON-CAPA inline menus (primary, secondary, and/or
2558: # breadcrumbs and Functions menus. Expects javascript from
2559: # &iframe_wrapper_headjs() to be in head portion of the web page,
2560: # e.g., by inclusion in second arg passed to &start_page().
2561: #
2562:
2563: sub iframe_wrapper_resizejs {
2564: my $offset = 5;
2565: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
2566: if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
2567: $offset = 0;
2568: }
2569: return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
2570: \$(document).ready( function() {
2571: \$(window).unbind('resize').resize(function(){
2572: var header = null;
2573: var offset = $offset;
2574: var height = 0;
2575: var hdrtop = 0;
1.1421 raeburn 2576: if (\$('div.LC_menus_content:first').length) {
2577: if (\$('div.LC_menus_content:first').hasClass ("shown")) {
2578: header = \$('div.LC_menus_content:first');
1.1423 raeburn 2579: offset = 12;
1.1421 raeburn 2580: }
2581: } else if (\$('div.LC_head_subbox:first').length) {
1.1420 raeburn 2582: header = \$('div.LC_head_subbox:first');
2583: offset = 9;
2584: } else {
2585: if (\$('#LC_breadcrumbs').length) {
2586: header = \$('#LC_breadcrumbs');
2587: }
2588: }
2589: if (header != null && header.length) {
2590: height = header.height();
2591: hdrtop = header.position().top;
2592: }
2593: var pos = height + hdrtop + offset;
2594: \$('.LC_iframecontainer').css('top', pos);
2595: });
2596: LCresizedef = 1;
2597: if (LCnotready == 1) {
2598: LCnotready = 0;
2599: \$(window).trigger('resize');
2600: }
2601: });
2602: window.onload = function(){
2603: if (LCresizedef) {
2604: LCnotready = 0;
2605: \$(window).trigger('resize');
2606: } else {
2607: LCnotready = 1;
2608: }
2609: };
2610: SCRIPT
2611:
2612: }
2613:
2614: =pod
2615:
1.256 matthew 2616: =head1 Excel and CSV file utility routines
2617:
2618: =cut
2619:
2620: ###############################################################
2621: ###############################################################
2622:
2623: =pod
2624:
1.1162 raeburn 2625: =over 4
2626:
1.648 raeburn 2627: =item * &csv_translate($text)
1.37 matthew 2628:
1.185 www 2629: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2630: format.
2631:
2632: =cut
2633:
1.180 matthew 2634: ###############################################################
2635: ###############################################################
1.37 matthew 2636: sub csv_translate {
2637: my $text = shift;
2638: $text =~ s/\"/\"\"/g;
1.209 albertel 2639: $text =~ s/\n/ /g;
1.37 matthew 2640: return $text;
2641: }
1.180 matthew 2642:
2643: ###############################################################
2644: ###############################################################
2645:
2646: =pod
2647:
1.648 raeburn 2648: =item * &define_excel_formats()
1.180 matthew 2649:
2650: Define some commonly used Excel cell formats.
2651:
2652: Currently supported formats:
2653:
2654: =over 4
2655:
2656: =item header
2657:
2658: =item bold
2659:
2660: =item h1
2661:
2662: =item h2
2663:
2664: =item h3
2665:
1.256 matthew 2666: =item h4
2667:
2668: =item i
2669:
1.180 matthew 2670: =item date
2671:
2672: =back
2673:
2674: Inputs: $workbook
2675:
2676: Returns: $format, a hash reference.
2677:
1.1057 foxr 2678:
1.180 matthew 2679: =cut
2680:
2681: ###############################################################
2682: ###############################################################
2683: sub define_excel_formats {
2684: my ($workbook) = @_;
2685: my $format;
2686: $format->{'header'} = $workbook->add_format(bold => 1,
2687: bottom => 1,
2688: align => 'center');
2689: $format->{'bold'} = $workbook->add_format(bold=>1);
2690: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2691: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2692: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2693: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2694: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2695: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2696: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2697: return $format;
2698: }
2699:
2700: ###############################################################
2701: ###############################################################
1.113 bowersj2 2702:
2703: =pod
2704:
1.648 raeburn 2705: =item * &create_workbook()
1.255 matthew 2706:
2707: Create an Excel worksheet. If it fails, output message on the
2708: request object and return undefs.
2709:
2710: Inputs: Apache request object
2711:
2712: Returns (undef) on failure,
2713: Excel worksheet object, scalar with filename, and formats
2714: from &Apache::loncommon::define_excel_formats on success
2715:
2716: =cut
2717:
2718: ###############################################################
2719: ###############################################################
2720: sub create_workbook {
2721: my ($r) = @_;
2722: #
2723: # Create the excel spreadsheet
2724: my $filename = '/prtspool/'.
1.258 albertel 2725: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2726: time.'_'.rand(1000000000).'.xls';
2727: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2728: if (! defined($workbook)) {
2729: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2730: $r->print(
2731: '<p class="LC_error">'
2732: .&mt('Problems occurred in creating the new Excel file.')
2733: .' '.&mt('This error has been logged.')
2734: .' '.&mt('Please alert your LON-CAPA administrator.')
2735: .'</p>'
2736: );
1.255 matthew 2737: return (undef);
2738: }
2739: #
1.1014 foxr 2740: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2741: #
2742: my $format = &Apache::loncommon::define_excel_formats($workbook);
2743: return ($workbook,$filename,$format);
2744: }
2745:
2746: ###############################################################
2747: ###############################################################
2748:
2749: =pod
2750:
1.648 raeburn 2751: =item * &create_text_file()
1.113 bowersj2 2752:
1.542 raeburn 2753: Create a file to write to and eventually make available to the user.
1.256 matthew 2754: If file creation fails, outputs an error message on the request object and
2755: return undefs.
1.113 bowersj2 2756:
1.256 matthew 2757: Inputs: Apache request object, and file suffix
1.113 bowersj2 2758:
1.256 matthew 2759: Returns (undef) on failure,
2760: Filehandle and filename on success.
1.113 bowersj2 2761:
2762: =cut
2763:
1.256 matthew 2764: ###############################################################
2765: ###############################################################
2766: sub create_text_file {
2767: my ($r,$suffix) = @_;
2768: if (! defined($suffix)) { $suffix = 'txt'; };
2769: my $fh;
2770: my $filename = '/prtspool/'.
1.258 albertel 2771: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2772: time.'_'.rand(1000000000).'.'.$suffix;
2773: $fh = Apache::File->new('>/home/httpd'.$filename);
2774: if (! defined($fh)) {
2775: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2776: $r->print(
2777: '<p class="LC_error">'
2778: .&mt('Problems occurred in creating the output file.')
2779: .' '.&mt('This error has been logged.')
2780: .' '.&mt('Please alert your LON-CAPA administrator.')
2781: .'</p>'
2782: );
1.113 bowersj2 2783: }
1.256 matthew 2784: return ($fh,$filename)
1.113 bowersj2 2785: }
2786:
2787:
1.256 matthew 2788: =pod
1.113 bowersj2 2789:
2790: =back
2791:
2792: =cut
1.37 matthew 2793:
2794: ###############################################################
1.33 matthew 2795: ## Home server <option> list generating code ##
2796: ###############################################################
1.35 matthew 2797:
1.169 www 2798: # ------------------------------------------
2799:
2800: sub domain_select {
1.1289 raeburn 2801: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2802: my @possdoms;
2803: if (ref($incdoms) eq 'ARRAY') {
2804: @possdoms = @{$incdoms};
2805: } else {
2806: @possdoms = &Apache::lonnet::all_domains();
2807: }
2808:
1.169 www 2809: my %domains=map {
1.514 albertel 2810: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2811: } @possdoms;
2812:
2813: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2814: foreach my $dom (@{$excdoms}) {
2815: delete($domains{$dom});
2816: }
2817: }
2818:
1.169 www 2819: if ($multiple) {
2820: $domains{''}=&mt('Any domain');
1.550 albertel 2821: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2822: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2823: } else {
1.550 albertel 2824: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2825: return &select_form($name,$value,\%domains);
1.169 www 2826: }
2827: }
2828:
1.282 albertel 2829: #-------------------------------------------
2830:
2831: =pod
2832:
1.519 raeburn 2833: =head1 Routines for form select boxes
2834:
2835: =over 4
2836:
1.648 raeburn 2837: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2838:
2839: Returns a string containing a <select> element int multiple mode
2840:
2841:
2842: Args:
2843: $name - name of the <select> element
1.506 raeburn 2844: $value - scalar or array ref of values that should already be selected
1.282 albertel 2845: $size - number of rows long the select element is
1.283 albertel 2846: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2847: (shown text should already have been &mt())
1.506 raeburn 2848: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2849:
1.282 albertel 2850: =cut
2851:
2852: #-------------------------------------------
1.169 www 2853: sub multiple_select_form {
1.284 albertel 2854: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2855: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2856: my $output='';
1.191 matthew 2857: if (! defined($size)) {
2858: $size = 4;
1.283 albertel 2859: if (scalar(keys(%$hash))<4) {
2860: $size = scalar(keys(%$hash));
1.191 matthew 2861: }
2862: }
1.734 bisitz 2863: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2864: my @order;
1.506 raeburn 2865: if (ref($order) eq 'ARRAY') {
2866: @order = @{$order};
2867: } else {
2868: @order = sort(keys(%$hash));
1.501 banghart 2869: }
2870: if (exists($$hash{'select_form_order'})) {
2871: @order = @{$$hash{'select_form_order'}};
2872: }
2873:
1.284 albertel 2874: foreach my $key (@order) {
1.356 albertel 2875: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2876: $output.='selected="selected" ' if ($selected{$key});
2877: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2878: }
2879: $output.="</select>\n";
2880: return $output;
2881: }
2882:
1.88 www 2883: #-------------------------------------------
2884:
2885: =pod
2886:
1.1254 raeburn 2887: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2888:
2889: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2890: allow a user to select options from a ref to a hash containing:
2891: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2892: a javascript onchange item, e.g., onchange="this.form.submit();".
2893: An optional arg -- $readonly -- if true will cause the select form
2894: to be disabled, e.g., for the case where an instructor has a section-
2895: specific role, and is viewing/modifying parameters.
1.970 raeburn 2896:
1.88 www 2897: See lonrights.pm for an example invocation and use.
2898:
2899: =cut
2900:
2901: #-------------------------------------------
2902: sub select_form {
1.1228 raeburn 2903: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2904: return unless (ref($hashref) eq 'HASH');
2905: if ($onchange) {
2906: $onchange = ' onchange="'.$onchange.'"';
2907: }
1.1228 raeburn 2908: my $disabled;
2909: if ($readonly) {
2910: $disabled = ' disabled="disabled"';
2911: }
2912: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2913: my @keys;
1.970 raeburn 2914: if (exists($hashref->{'select_form_order'})) {
2915: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2916: } else {
1.970 raeburn 2917: @keys=sort(keys(%{$hashref}));
1.128 albertel 2918: }
1.356 albertel 2919: foreach my $key (@keys) {
2920: $selectform.=
2921: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2922: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2923: ">".$hashref->{$key}."</option>\n";
1.88 www 2924: }
2925: $selectform.="</select>";
2926: return $selectform;
2927: }
2928:
1.475 www 2929: # For display filters
2930:
2931: sub display_filter {
1.1074 raeburn 2932: my ($context) = @_;
1.475 www 2933: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2934: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2935: my $phraseinput = 'hidden';
2936: my $includeinput = 'hidden';
2937: my ($checked,$includetypestext);
2938: if ($env{'form.displayfilter'} eq 'containing') {
2939: $phraseinput = 'text';
2940: if ($context eq 'parmslog') {
2941: $includeinput = 'checkbox';
2942: if ($env{'form.includetypes'}) {
2943: $checked = ' checked="checked"';
2944: }
2945: $includetypestext = &mt('Include parameter types');
2946: }
2947: } else {
2948: $includetypestext = ' ';
2949: }
2950: my ($additional,$secondid,$thirdid);
2951: if ($context eq 'parmslog') {
2952: $additional =
2953: '<label><input type="'.$includeinput.'" name="includetypes"'.
2954: $checked.' name="includetypes" value="1" id="includetypes" />'.
2955: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2956: '</label>';
2957: $secondid = 'includetypes';
2958: $thirdid = 'includetypestext';
2959: }
2960: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2961: '$secondid','$thirdid')";
2962: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2963: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2964: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2965: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2966: &mt('Filter: [_1]',
1.477 www 2967: &select_form($env{'form.displayfilter'},
2968: 'displayfilter',
1.970 raeburn 2969: {'currentfolder' => 'Current folder/page',
1.477 www 2970: 'containing' => 'Containing phrase',
1.1074 raeburn 2971: 'none' => 'None'},$onchange)).' '.
2972: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2973: &HTML::Entities::encode($env{'form.containingphrase'}).
2974: '" />'.$additional;
2975: }
2976:
2977: sub display_filter_js {
2978: my $includetext = &mt('Include parameter types');
2979: return <<"ENDJS";
2980:
2981: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2982: var firstType = 'hidden';
2983: if (setter.options[setter.selectedIndex].value == 'containing') {
2984: firstType = 'text';
2985: }
2986: firstObject = document.getElementById(firstid);
2987: if (typeof(firstObject) == 'object') {
2988: if (firstObject.type != firstType) {
2989: changeInputType(firstObject,firstType);
2990: }
2991: }
2992: if (context == 'parmslog') {
2993: var secondType = 'hidden';
2994: if (firstType == 'text') {
2995: secondType = 'checkbox';
2996: }
2997: secondObject = document.getElementById(secondid);
2998: if (typeof(secondObject) == 'object') {
2999: if (secondObject.type != secondType) {
3000: changeInputType(secondObject,secondType);
3001: }
3002: }
3003: var textItem = document.getElementById(thirdid);
3004: var currtext = textItem.innerHTML;
3005: var newtext;
3006: if (firstType == 'text') {
3007: newtext = '$includetext';
3008: } else {
3009: newtext = ' ';
3010: }
3011: if (currtext != newtext) {
3012: textItem.innerHTML = newtext;
3013: }
3014: }
3015: return;
3016: }
3017:
3018: function changeInputType(oldObject,newType) {
3019: var newObject = document.createElement('input');
3020: newObject.type = newType;
3021: if (oldObject.size) {
3022: newObject.size = oldObject.size;
3023: }
3024: if (oldObject.value) {
3025: newObject.value = oldObject.value;
3026: }
3027: if (oldObject.name) {
3028: newObject.name = oldObject.name;
3029: }
3030: if (oldObject.id) {
3031: newObject.id = oldObject.id;
3032: }
3033: oldObject.parentNode.replaceChild(newObject,oldObject);
3034: return;
3035: }
3036:
3037: ENDJS
1.475 www 3038: }
3039:
1.167 www 3040: sub gradeleveldescription {
3041: my $gradelevel=shift;
3042: my %gradelevels=(0 => 'Not specified',
3043: 1 => 'Grade 1',
3044: 2 => 'Grade 2',
3045: 3 => 'Grade 3',
3046: 4 => 'Grade 4',
3047: 5 => 'Grade 5',
3048: 6 => 'Grade 6',
3049: 7 => 'Grade 7',
3050: 8 => 'Grade 8',
3051: 9 => 'Grade 9',
3052: 10 => 'Grade 10',
3053: 11 => 'Grade 11',
3054: 12 => 'Grade 12',
3055: 13 => 'Grade 13',
3056: 14 => '100 Level',
3057: 15 => '200 Level',
3058: 16 => '300 Level',
3059: 17 => '400 Level',
3060: 18 => 'Graduate Level');
3061: return &mt($gradelevels{$gradelevel});
3062: }
3063:
1.163 www 3064: sub select_level_form {
3065: my ($deflevel,$name)=@_;
3066: unless ($deflevel) { $deflevel=0; }
1.167 www 3067: my $selectform = "<select name=\"$name\" size=\"1\">\n";
3068: for (my $i=0; $i<=18; $i++) {
3069: $selectform.="<option value=\"$i\" ".
1.253 albertel 3070: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 3071: ">".&gradeleveldescription($i)."</option>\n";
3072: }
3073: $selectform.="</select>";
3074: return $selectform;
1.163 www 3075: }
1.167 www 3076:
1.35 matthew 3077: #-------------------------------------------
3078:
1.45 matthew 3079: =pod
3080:
1.1453 raeburn 3081: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled,$id)
1.35 matthew 3082:
3083: Returns a string containing a <select name='$name' size='1'> form to
3084: allow a user to select the domain to preform an operation in.
3085: See loncreateuser.pm for an example invocation and use.
3086:
1.90 www 3087: If the $includeempty flag is set, it also includes an empty choice ("no domain
3088: selected");
3089:
1.743 raeburn 3090: If the $showdomdesc flag is set, the domain name is followed by the domain description.
3091:
1.910 raeburn 3092: 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.
3093:
1.1121 raeburn 3094: The optional $incdoms is a reference to an array of domains which will be the only available options.
3095:
3096: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 3097:
1.1256 raeburn 3098: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
3099:
1.1453 raeburn 3100: The option $id argument is the value (if any) to set as the (unique) id attribute for the select tag.
3101:
1.35 matthew 3102: =cut
3103:
3104: #-------------------------------------------
1.34 matthew 3105: sub select_dom_form {
1.1453 raeburn 3106: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled,$id) = @_;
1.872 raeburn 3107: if ($onchange) {
1.874 raeburn 3108: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 3109: }
1.1256 raeburn 3110: if ($disabled) {
3111: $disabled = ' disabled="disabled"';
3112: }
1.1453 raeburn 3113: if ($id ne '') {
3114: $id = ' id="'.$id.'"';
3115: }
1.1121 raeburn 3116: my (@domains,%exclude);
1.910 raeburn 3117: if (ref($incdoms) eq 'ARRAY') {
3118: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
3119: } else {
3120: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
3121: }
1.90 www 3122: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 3123: if (ref($excdoms) eq 'ARRAY') {
3124: map { $exclude{$_} = 1; } @{$excdoms};
3125: }
1.1453 raeburn 3126: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled$id>\n";
1.356 albertel 3127: foreach my $dom (@domains) {
1.1121 raeburn 3128: next if ($exclude{$dom});
1.356 albertel 3129: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 3130: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
3131: if ($showdomdesc) {
3132: if ($dom ne '') {
3133: my $domdesc = &Apache::lonnet::domain($dom,'description');
3134: if ($domdesc ne '') {
3135: $selectdomain .= ' ('.$domdesc.')';
3136: }
3137: }
3138: }
3139: $selectdomain .= "</option>\n";
1.34 matthew 3140: }
3141: $selectdomain.="</select>";
3142: return $selectdomain;
3143: }
3144:
1.35 matthew 3145: #-------------------------------------------
3146:
1.45 matthew 3147: =pod
3148:
1.648 raeburn 3149: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 3150:
1.586 raeburn 3151: input: 4 arguments (two required, two optional) -
3152: $domain - domain of new user
3153: $name - name of form element
3154: $default - Value of 'default' causes a default item to be first
3155: option, and selected by default.
3156: $hide - Value of 'hide' causes hiding of the name of the server,
3157: if 1 server found, or default, if 0 found.
1.594 raeburn 3158: output: returns 2 items:
1.586 raeburn 3159: (a) form element which contains either:
3160: (i) <select name="$name">
3161: <option value="$hostid1">$hostid $servers{$hostid}</option>
3162: <option value="$hostid2">$hostid $servers{$hostid}</option>
3163: </select>
3164: form item if there are multiple library servers in $domain, or
3165: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
3166: if there is only one library server in $domain.
3167:
3168: (b) number of library servers found.
3169:
3170: See loncreateuser.pm for example of use.
1.35 matthew 3171:
3172: =cut
3173:
3174: #-------------------------------------------
1.586 raeburn 3175: sub home_server_form_item {
3176: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 3177: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 3178: my $result;
3179: my $numlib = keys(%servers);
3180: if ($numlib > 1) {
3181: $result .= '<select name="'.$name.'" />'."\n";
3182: if ($default) {
1.804 bisitz 3183: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3184: '</option>'."\n";
3185: }
3186: foreach my $hostid (sort(keys(%servers))) {
3187: $result.= '<option value="'.$hostid.'">'.
3188: $hostid.' '.$servers{$hostid}."</option>\n";
3189: }
3190: $result .= '</select>'."\n";
3191: } elsif ($numlib == 1) {
3192: my $hostid;
3193: foreach my $item (keys(%servers)) {
3194: $hostid = $item;
3195: }
3196: $result .= '<input type="hidden" name="'.$name.'" value="'.
3197: $hostid.'" />';
3198: if (!$hide) {
3199: $result .= $hostid.' '.$servers{$hostid};
3200: }
3201: $result .= "\n";
3202: } elsif ($default) {
3203: $result .= '<input type="hidden" name="'.$name.
3204: '" value="default" />';
3205: if (!$hide) {
3206: $result .= &mt('default');
3207: }
3208: $result .= "\n";
1.33 matthew 3209: }
1.586 raeburn 3210: return ($result,$numlib);
1.33 matthew 3211: }
1.112 bowersj2 3212:
3213: =pod
3214:
1.534 albertel 3215: =back
3216:
1.112 bowersj2 3217: =cut
1.87 matthew 3218:
3219: ###############################################################
1.112 bowersj2 3220: ## Decoding User Agent ##
1.87 matthew 3221: ###############################################################
3222:
3223: =pod
3224:
1.112 bowersj2 3225: =head1 Decoding the User Agent
3226:
3227: =over 4
3228:
3229: =item * &decode_user_agent()
1.87 matthew 3230:
3231: Inputs: $r
3232:
3233: Outputs:
3234:
3235: =over 4
3236:
1.112 bowersj2 3237: =item * $httpbrowser
1.87 matthew 3238:
1.112 bowersj2 3239: =item * $clientbrowser
1.87 matthew 3240:
1.112 bowersj2 3241: =item * $clientversion
1.87 matthew 3242:
1.112 bowersj2 3243: =item * $clientmathml
1.87 matthew 3244:
1.112 bowersj2 3245: =item * $clientunicode
1.87 matthew 3246:
1.112 bowersj2 3247: =item * $clientos
1.87 matthew 3248:
1.1137 raeburn 3249: =item * $clientmobile
3250:
1.1141 raeburn 3251: =item * $clientinfo
3252:
1.1194 raeburn 3253: =item * $clientosversion
3254:
1.87 matthew 3255: =back
3256:
1.157 matthew 3257: =back
3258:
1.87 matthew 3259: =cut
3260:
3261: ###############################################################
3262: ###############################################################
3263: sub decode_user_agent {
1.247 albertel 3264: my ($r)=@_;
1.87 matthew 3265: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3266: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3267: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3268: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3269: my $clientbrowser='unknown';
3270: my $clientversion='0';
3271: my $clientmathml='';
3272: my $clientunicode='0';
1.1137 raeburn 3273: my $clientmobile=0;
1.1194 raeburn 3274: my $clientosversion='';
1.87 matthew 3275: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3276: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3277: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3278: $clientbrowser=$bname;
3279: $httpbrowser=~/$vreg/i;
3280: $clientversion=$1;
3281: $clientmathml=($clientversion>=$minv);
3282: $clientunicode=($clientversion>=$univ);
3283: }
3284: }
3285: my $clientos='unknown';
1.1141 raeburn 3286: my $clientinfo;
1.87 matthew 3287: if (($httpbrowser=~/linux/i) ||
3288: ($httpbrowser=~/unix/i) ||
3289: ($httpbrowser=~/ux/i) ||
3290: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3291: if (($httpbrowser=~/vax/i) ||
3292: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3293: if ($httpbrowser=~/next/i) { $clientos='next'; }
3294: if (($httpbrowser=~/mac/i) ||
3295: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3296: if ($httpbrowser=~/win/i) {
3297: $clientos='win';
3298: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3299: $clientosversion = $1;
3300: }
3301: }
1.87 matthew 3302: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3303: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3304: $clientmobile=lc($1);
3305: }
1.1141 raeburn 3306: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3307: $clientinfo = 'firefox-'.$1;
3308: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3309: $clientinfo = 'chromeframe-'.$1;
3310: }
1.87 matthew 3311: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3312: $clientunicode,$clientos,$clientmobile,$clientinfo,
3313: $clientosversion);
1.87 matthew 3314: }
3315:
1.32 matthew 3316: ###############################################################
3317: ## Authentication changing form generation subroutines ##
3318: ###############################################################
3319: ##
3320: ## All of the authform_xxxxxxx subroutines take their inputs in a
3321: ## hash, and have reasonable default values.
3322: ##
3323: ## formname = the name given in the <form> tag.
1.35 matthew 3324: #-------------------------------------------
3325:
1.45 matthew 3326: =pod
3327:
1.112 bowersj2 3328: =head1 Authentication Routines
3329:
3330: =over 4
3331:
1.648 raeburn 3332: =item * &authform_xxxxxx()
1.35 matthew 3333:
3334: The authform_xxxxxx subroutines provide javascript and html forms which
3335: handle some of the conveniences required for authentication forms.
3336: This is not an optimal method, but it works.
3337:
3338: =over 4
3339:
1.112 bowersj2 3340: =item * authform_header
1.35 matthew 3341:
1.112 bowersj2 3342: =item * authform_authorwarning
1.35 matthew 3343:
1.112 bowersj2 3344: =item * authform_nochange
1.35 matthew 3345:
1.112 bowersj2 3346: =item * authform_kerberos
1.35 matthew 3347:
1.112 bowersj2 3348: =item * authform_internal
1.35 matthew 3349:
1.112 bowersj2 3350: =item * authform_filesystem
1.35 matthew 3351:
1.1310 raeburn 3352: =item * authform_lti
3353:
1.35 matthew 3354: =back
3355:
1.648 raeburn 3356: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3357:
1.35 matthew 3358: =cut
3359:
3360: #-------------------------------------------
1.32 matthew 3361: sub authform_header{
3362: my %in = (
3363: formname => 'cu',
1.80 albertel 3364: kerb_def_dom => '',
1.32 matthew 3365: @_,
3366: );
3367: $in{'formname'} = 'document.' . $in{'formname'};
3368: my $result='';
1.80 albertel 3369:
3370: #---------------------------------------------- Code for upper case translation
3371: my $Javascript_toUpperCase;
3372: unless ($in{kerb_def_dom}) {
3373: $Javascript_toUpperCase =<<"END";
3374: switch (choice) {
3375: case 'krb': currentform.elements[choicearg].value =
3376: currentform.elements[choicearg].value.toUpperCase();
3377: break;
3378: default:
3379: }
3380: END
3381: } else {
3382: $Javascript_toUpperCase = "";
3383: }
3384:
1.165 raeburn 3385: my $radioval = "'nochange'";
1.591 raeburn 3386: if (defined($in{'curr_authtype'})) {
3387: if ($in{'curr_authtype'} ne '') {
3388: $radioval = "'".$in{'curr_authtype'}."arg'";
3389: }
1.174 matthew 3390: }
1.165 raeburn 3391: my $argfield = 'null';
1.591 raeburn 3392: if (defined($in{'mode'})) {
1.165 raeburn 3393: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3394: if (defined($in{'curr_autharg'})) {
3395: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3396: $argfield = "'$in{'curr_autharg'}'";
3397: }
3398: }
3399: }
3400: }
3401:
1.32 matthew 3402: $result.=<<"END";
3403: var current = new Object();
1.165 raeburn 3404: current.radiovalue = $radioval;
3405: current.argfield = $argfield;
1.32 matthew 3406:
3407: function changed_radio(choice,currentform) {
3408: var choicearg = choice + 'arg';
3409: // If a radio button in changed, we need to change the argfield
3410: if (current.radiovalue != choice) {
3411: current.radiovalue = choice;
3412: if (current.argfield != null) {
3413: currentform.elements[current.argfield].value = '';
3414: }
3415: if (choice == 'nochange') {
3416: current.argfield = null;
3417: } else {
3418: current.argfield = choicearg;
3419: switch(choice) {
3420: case 'krb':
3421: currentform.elements[current.argfield].value =
3422: "$in{'kerb_def_dom'}";
3423: break;
3424: default:
3425: break;
3426: }
3427: }
3428: }
3429: return;
3430: }
1.22 www 3431:
1.32 matthew 3432: function changed_text(choice,currentform) {
3433: var choicearg = choice + 'arg';
3434: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3435: $Javascript_toUpperCase
1.32 matthew 3436: // clear old field
3437: if ((current.argfield != choicearg) && (current.argfield != null)) {
3438: currentform.elements[current.argfield].value = '';
3439: }
3440: current.argfield = choicearg;
3441: }
3442: set_auth_radio_buttons(choice,currentform);
3443: return;
1.20 www 3444: }
1.32 matthew 3445:
3446: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3447: var numauthchoices = currentform.login.length;
3448: if (typeof numauthchoices == "undefined") {
3449: return;
3450: }
1.32 matthew 3451: var i=0;
1.986 raeburn 3452: while (i < numauthchoices) {
1.32 matthew 3453: if (currentform.login[i].value == newvalue) { break; }
3454: i++;
3455: }
1.986 raeburn 3456: if (i == numauthchoices) {
1.32 matthew 3457: return;
3458: }
3459: current.radiovalue = newvalue;
3460: currentform.login[i].checked = true;
3461: return;
3462: }
3463: END
3464: return $result;
3465: }
3466:
1.1106 raeburn 3467: sub authform_authorwarning {
1.32 matthew 3468: my $result='';
1.144 matthew 3469: $result='<i>'.
3470: &mt('As a general rule, only authors or co-authors should be '.
3471: 'filesystem authenticated '.
3472: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3473: return $result;
3474: }
3475:
1.1106 raeburn 3476: sub authform_nochange {
1.32 matthew 3477: my %in = (
3478: formname => 'document.cu',
3479: kerb_def_dom => 'MSU.EDU',
3480: @_,
3481: );
1.1106 raeburn 3482: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3483: my $result;
1.1104 raeburn 3484: if (!$authnum) {
1.1105 raeburn 3485: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3486: } else {
3487: $result = '<label>'.&mt('[_1] Do not change login data',
3488: '<input type="radio" name="login" value="nochange" '.
3489: 'checked="checked" onclick="'.
1.281 albertel 3490: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3491: '</label>';
1.586 raeburn 3492: }
1.32 matthew 3493: return $result;
3494: }
3495:
1.591 raeburn 3496: sub authform_kerberos {
1.32 matthew 3497: my %in = (
3498: formname => 'document.cu',
3499: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3500: kerb_def_auth => 'krb4',
1.32 matthew 3501: @_,
3502: );
1.586 raeburn 3503: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3504: $autharg,$jscall,$disabled);
1.1106 raeburn 3505: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3506: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3507: $check5 = ' checked="checked"';
1.80 albertel 3508: } else {
1.772 bisitz 3509: $check4 = ' checked="checked"';
1.80 albertel 3510: }
1.1259 raeburn 3511: if ($in{'readonly'}) {
3512: $disabled = ' disabled="disabled"';
3513: }
1.165 raeburn 3514: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3515: if (defined($in{'curr_authtype'})) {
3516: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3517: $krbcheck = ' checked="checked"';
1.623 raeburn 3518: if (defined($in{'mode'})) {
3519: if ($in{'mode'} eq 'modifyuser') {
3520: $krbcheck = '';
3521: }
3522: }
1.591 raeburn 3523: if (defined($in{'curr_kerb_ver'})) {
3524: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3525: $check5 = ' checked="checked"';
1.591 raeburn 3526: $check4 = '';
3527: } else {
1.772 bisitz 3528: $check4 = ' checked="checked"';
1.591 raeburn 3529: $check5 = '';
3530: }
1.586 raeburn 3531: }
1.591 raeburn 3532: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3533: $krbarg = $in{'curr_autharg'};
3534: }
1.586 raeburn 3535: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3536: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3537: $result =
3538: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3539: $in{'curr_autharg'},$krbver);
3540: } else {
3541: $result =
3542: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3543: }
3544: return $result;
3545: }
3546: }
3547: } else {
3548: if ($authnum == 1) {
1.784 bisitz 3549: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3550: }
3551: }
1.586 raeburn 3552: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3553: return;
1.587 raeburn 3554: } elsif ($authtype eq '') {
1.591 raeburn 3555: if (defined($in{'mode'})) {
1.587 raeburn 3556: if ($in{'mode'} eq 'modifycourse') {
3557: if ($authnum == 1) {
1.1259 raeburn 3558: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3559: }
3560: }
3561: }
1.586 raeburn 3562: }
3563: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3564: if ($authtype eq '') {
3565: $authtype = '<input type="radio" name="login" value="krb" '.
3566: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3567: $krbcheck.$disabled.' />';
1.586 raeburn 3568: }
3569: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3570: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3571: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3572: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3573: $in{'curr_authtype'} eq 'krb4')) {
3574: $result .= &mt
1.144 matthew 3575: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3576: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3577: '<label>'.$authtype,
1.281 albertel 3578: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3579: 'value="'.$krbarg.'" '.
1.1259 raeburn 3580: 'onchange="'.$jscall.'"'.$disabled.' />',
3581: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3582: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3583: '</label>');
1.586 raeburn 3584: } elsif ($can_assign{'krb4'}) {
3585: $result .= &mt
3586: ('[_1] Kerberos authenticated with domain [_2] '.
3587: '[_3] Version 4 [_4]',
3588: '<label>'.$authtype,
3589: '</label><input type="text" size="10" name="krbarg" '.
3590: 'value="'.$krbarg.'" '.
1.1259 raeburn 3591: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3592: '<label><input type="hidden" name="krbver" value="4" />',
3593: '</label>');
3594: } elsif ($can_assign{'krb5'}) {
3595: $result .= &mt
3596: ('[_1] Kerberos authenticated with domain [_2] '.
3597: '[_3] Version 5 [_4]',
3598: '<label>'.$authtype,
3599: '</label><input type="text" size="10" name="krbarg" '.
3600: 'value="'.$krbarg.'" '.
1.1259 raeburn 3601: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3602: '<label><input type="hidden" name="krbver" value="5" />',
3603: '</label>');
3604: }
1.32 matthew 3605: return $result;
3606: }
3607:
1.1106 raeburn 3608: sub authform_internal {
1.586 raeburn 3609: my %in = (
1.32 matthew 3610: formname => 'document.cu',
3611: kerb_def_dom => 'MSU.EDU',
3612: @_,
3613: );
1.1259 raeburn 3614: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3615: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3616: if ($in{'readonly'}) {
3617: $disabled = ' disabled="disabled"';
3618: }
1.591 raeburn 3619: if (defined($in{'curr_authtype'})) {
3620: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3621: if ($can_assign{'int'}) {
1.772 bisitz 3622: $intcheck = 'checked="checked" ';
1.623 raeburn 3623: if (defined($in{'mode'})) {
3624: if ($in{'mode'} eq 'modifyuser') {
3625: $intcheck = '';
3626: }
3627: }
1.591 raeburn 3628: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3629: $intarg = $in{'curr_autharg'};
3630: }
3631: } else {
3632: $result = &mt('Currently internally authenticated.');
3633: return $result;
1.165 raeburn 3634: }
3635: }
1.586 raeburn 3636: } else {
3637: if ($authnum == 1) {
1.784 bisitz 3638: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3639: }
3640: }
3641: if (!$can_assign{'int'}) {
3642: return;
1.587 raeburn 3643: } elsif ($authtype eq '') {
1.591 raeburn 3644: if (defined($in{'mode'})) {
1.587 raeburn 3645: if ($in{'mode'} eq 'modifycourse') {
3646: if ($authnum == 1) {
1.1259 raeburn 3647: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3648: }
3649: }
3650: }
1.165 raeburn 3651: }
1.586 raeburn 3652: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3653: if ($authtype eq '') {
3654: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3655: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3656: }
1.605 bisitz 3657: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3658: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3659: $result = &mt
1.144 matthew 3660: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3661: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3662: $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 3663: return $result;
3664: }
3665:
1.1104 raeburn 3666: sub authform_local {
1.32 matthew 3667: my %in = (
3668: formname => 'document.cu',
3669: kerb_def_dom => 'MSU.EDU',
3670: @_,
3671: );
1.1259 raeburn 3672: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3673: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3674: if ($in{'readonly'}) {
3675: $disabled = ' disabled="disabled"';
3676: }
1.591 raeburn 3677: if (defined($in{'curr_authtype'})) {
3678: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3679: if ($can_assign{'loc'}) {
1.772 bisitz 3680: $loccheck = 'checked="checked" ';
1.623 raeburn 3681: if (defined($in{'mode'})) {
3682: if ($in{'mode'} eq 'modifyuser') {
3683: $loccheck = '';
3684: }
3685: }
1.591 raeburn 3686: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3687: $locarg = $in{'curr_autharg'};
3688: }
3689: } else {
3690: $result = &mt('Currently using local (institutional) authentication.');
3691: return $result;
1.165 raeburn 3692: }
3693: }
1.586 raeburn 3694: } else {
3695: if ($authnum == 1) {
1.784 bisitz 3696: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3697: }
3698: }
3699: if (!$can_assign{'loc'}) {
3700: return;
1.587 raeburn 3701: } elsif ($authtype eq '') {
1.591 raeburn 3702: if (defined($in{'mode'})) {
1.587 raeburn 3703: if ($in{'mode'} eq 'modifycourse') {
3704: if ($authnum == 1) {
1.1259 raeburn 3705: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3706: }
3707: }
3708: }
1.165 raeburn 3709: }
1.586 raeburn 3710: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3711: if ($authtype eq '') {
3712: $authtype = '<input type="radio" name="login" value="loc" '.
3713: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3714: $jscall.'"'.$disabled.' />';
1.586 raeburn 3715: }
3716: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3717: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3718: $result = &mt('[_1] Local Authentication with argument [_2]',
3719: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3720: return $result;
3721: }
3722:
1.1106 raeburn 3723: sub authform_filesystem {
1.32 matthew 3724: my %in = (
3725: formname => 'document.cu',
3726: kerb_def_dom => 'MSU.EDU',
3727: @_,
3728: );
1.1259 raeburn 3729: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3730: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3731: if ($in{'readonly'}) {
3732: $disabled = ' disabled="disabled"';
3733: }
1.591 raeburn 3734: if (defined($in{'curr_authtype'})) {
3735: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3736: if ($can_assign{'fsys'}) {
1.772 bisitz 3737: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3738: if (defined($in{'mode'})) {
3739: if ($in{'mode'} eq 'modifyuser') {
3740: $fsyscheck = '';
3741: }
3742: }
1.586 raeburn 3743: } else {
3744: $result = &mt('Currently Filesystem Authenticated.');
3745: return $result;
1.1259 raeburn 3746: }
1.586 raeburn 3747: }
3748: } else {
3749: if ($authnum == 1) {
1.784 bisitz 3750: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3751: }
3752: }
3753: if (!$can_assign{'fsys'}) {
3754: return;
1.587 raeburn 3755: } elsif ($authtype eq '') {
1.591 raeburn 3756: if (defined($in{'mode'})) {
1.587 raeburn 3757: if ($in{'mode'} eq 'modifycourse') {
3758: if ($authnum == 1) {
1.1259 raeburn 3759: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3760: }
3761: }
3762: }
1.586 raeburn 3763: }
3764: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3765: if ($authtype eq '') {
3766: $authtype = '<input type="radio" name="login" value="fsys" '.
3767: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3768: $jscall.'"'.$disabled.' />';
1.586 raeburn 3769: }
1.1310 raeburn 3770: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3771: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3772: $result = &mt
1.144 matthew 3773: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3774: '<label>'.$authtype,'</label>'.$autharg);
3775: return $result;
3776: }
3777:
3778: sub authform_lti {
3779: my %in = (
3780: formname => 'document.cu',
3781: kerb_def_dom => 'MSU.EDU',
3782: @_,
3783: );
3784: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3785: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3786: if ($in{'readonly'}) {
3787: $disabled = ' disabled="disabled"';
3788: }
3789: if (defined($in{'curr_authtype'})) {
3790: if ($in{'curr_authtype'} eq 'lti') {
3791: if ($can_assign{'lti'}) {
3792: $lticheck = 'checked="checked" ';
3793: if (defined($in{'mode'})) {
3794: if ($in{'mode'} eq 'modifyuser') {
3795: $lticheck = '';
3796: }
3797: }
3798: } else {
3799: $result = &mt('Currently LTI Authenticated.');
3800: return $result;
3801: }
3802: }
3803: } else {
3804: if ($authnum == 1) {
3805: $authtype = '<input type="hidden" name="login" value="lti" />';
3806: }
3807: }
3808: if (!$can_assign{'lti'}) {
3809: return;
3810: } elsif ($authtype eq '') {
3811: if (defined($in{'mode'})) {
3812: if ($in{'mode'} eq 'modifycourse') {
3813: if ($authnum == 1) {
3814: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3815: }
3816: }
3817: }
3818: }
3819: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3820: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3821: $authtype = '<input type="radio" name="login" value="lti" '.
3822: $lticheck.' onchange="'.$jscall.'" onclick="'.
3823: $jscall.'"'.$disabled.' />';
3824: }
3825: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3826: if ($authtype) {
3827: $result = &mt('[_1] LTI Authenticated',
3828: '<label>'.$authtype.'</label>'.$autharg);
3829: } else {
3830: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3831: $autharg;
3832: }
1.32 matthew 3833: return $result;
3834: }
3835:
1.586 raeburn 3836: sub get_assignable_auth {
3837: my ($dom) = @_;
3838: if ($dom eq '') {
3839: $dom = $env{'request.role.domain'};
3840: }
3841: my %can_assign = (
3842: krb4 => 1,
3843: krb5 => 1,
3844: int => 1,
3845: loc => 1,
1.1310 raeburn 3846: lti => 1,
1.586 raeburn 3847: );
3848: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3849: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3850: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3851: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3852: my $context;
3853: if ($env{'request.role'} =~ /^au/) {
3854: $context = 'author';
1.1259 raeburn 3855: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3856: $context = 'domain';
3857: } elsif ($env{'request.course.id'}) {
3858: $context = 'course';
3859: }
3860: if ($context) {
3861: if (ref($authhash->{$context}) eq 'HASH') {
3862: %can_assign = %{$authhash->{$context}};
3863: }
3864: }
3865: }
3866: }
3867: my $authnum = 0;
3868: foreach my $key (keys(%can_assign)) {
3869: if ($can_assign{$key}) {
3870: $authnum ++;
3871: }
3872: }
3873: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3874: $authnum --;
3875: }
3876: return ($authnum,%can_assign);
3877: }
3878:
1.1331 raeburn 3879: sub check_passwd_rules {
3880: my ($domain,$plainpass) = @_;
3881: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3882: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3883: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3884: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3885: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3886: if ($passwdconf{'min'} > $min) {
3887: $min = $passwdconf{'min'};
3888: }
1.1331 raeburn 3889: }
3890: if ($passwdconf{'max'} =~ /^\d+$/) {
3891: $max = $passwdconf{'max'};
3892: }
3893: @chars = @{$passwdconf{'chars'}};
3894: }
3895: if (($min) && (length($plainpass) < $min)) {
3896: push(@brokerule,'min');
3897: }
3898: if (($max) && (length($plainpass) > $max)) {
3899: push(@brokerule,'max');
3900: }
3901: if (@chars) {
3902: my %rules;
3903: map { $rules{$_} = 1; } @chars;
3904: if ($rules{'uc'}) {
3905: unless ($plainpass =~ /[A-Z]/) {
3906: push(@brokerule,'uc');
3907: }
3908: }
3909: if ($rules{'lc'}) {
1.1332 raeburn 3910: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3911: push(@brokerule,'lc');
3912: }
3913: }
3914: if ($rules{'num'}) {
3915: unless ($plainpass =~ /\d/) {
3916: push(@brokerule,'num');
3917: }
3918: }
3919: if ($rules{'spec'}) {
3920: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3921: push(@brokerule,'spec');
3922: }
3923: }
3924: }
3925: if (@brokerule) {
3926: my %rulenames = &Apache::lonlocal::texthash(
3927: uc => 'At least one upper case letter',
3928: lc => 'At least one lower case letter',
3929: num => 'At least one number',
3930: spec => 'At least one non-alphanumeric',
3931: );
3932: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3933: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3934: $rulenames{'num'} .= ': 0123456789';
3935: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3936: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3937: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3938: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3939: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3940: if (grep(/^$rule$/,@brokerule)) {
3941: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3942: }
3943: }
3944: $warning .= '</ul>';
3945: }
1.1332 raeburn 3946: if (wantarray) {
3947: return @brokerule;
3948: }
1.1331 raeburn 3949: return $warning;
3950: }
3951:
1.1376 raeburn 3952: sub passwd_validation_js {
1.1377 raeburn 3953: my ($currpasswdval,$domain,$context,$id) = @_;
3954: my (%passwdconf,$alertmsg);
3955: if ($context eq 'linkprot') {
3956: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3957: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3958: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3959: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3960: }
3961: }
3962: if ($id eq 'add') {
3963: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3964: } elsif ($id =~ /^\d+$/) {
3965: my $pos = $id+1;
3966: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3967: } else {
3968: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3969: }
1.1434 raeburn 3970: } elsif ($context eq 'ltitools') {
3971: my %domconfig = &Apache::lonnet::get_dom('configuration',['toolsec'],$domain);
3972: if (ref($domconfig{'toolsec'}) eq 'HASH') {
3973: if (ref($domconfig{'toolsec'}{'rules'}) eq 'HASH') {
3974: %passwdconf = %{$domconfig{'toolsec'}{'rules'}};
3975: }
3976: }
3977: if ($id eq 'add') {
3978: $alertmsg = &mt('Secret for added external tool did not satisfy requirement(s):').'\n\n';
3979: } elsif ($id =~ /^\d+$/) {
3980: my $pos = $id+1;
3981: $alertmsg = &mt('Secret for external tool [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3982: } else {
3983: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3984: }
1.1377 raeburn 3985: } else {
3986: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3987: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3988: }
1.1376 raeburn 3989: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3990: $numrules = 0;
3991: $min = $Apache::lonnet::passwdmin;
3992: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3993: if ($passwdconf{'min'} =~ /^\d+$/) {
3994: if ($passwdconf{'min'} > $min) {
3995: $min = $passwdconf{'min'};
3996: }
3997: }
3998: if ($passwdconf{'max'} =~ /^\d+$/) {
3999: $max = $passwdconf{'max'};
4000: $numrules ++;
4001: }
4002: @chars = @{$passwdconf{'chars'}};
4003: if (@chars) {
4004: $numrules ++;
4005: }
4006: }
4007: if ($min > 0) {
4008: $numrules ++;
4009: }
4010: if (($min > 0) || ($max ne '') || (@chars > 0)) {
4011: if ($min) {
4012: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
4013: }
4014: if ($max) {
4015: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
4016: }
4017: my (@charalerts,@charrules);
4018: if (@chars) {
4019: if (grep(/^uc$/,@chars)) {
4020: push(@charalerts,&mt('contain at least one upper case letter'));
4021: push(@charrules,'uc');
4022: }
4023: if (grep(/^lc$/,@chars)) {
4024: push(@charalerts,&mt('contain at least one lower case letter'));
4025: push(@charrules,'lc');
4026: }
4027: if (grep(/^num$/,@chars)) {
4028: push(@charalerts,&mt('contain at least one number'));
4029: push(@charrules,'num');
4030: }
4031: if (grep(/^spec$/,@chars)) {
4032: push(@charalerts,&mt('contain at least one non-alphanumeric'));
4033: push(@charrules,'spec');
4034: }
4035: }
4036: $intargjs = qq| var rulesmsg = '';\n|.
4037: qq| var currpwval = $currpasswdval;\n|;
4038: if ($min) {
4039: $intargjs .= qq|
4040: if (currpwval.length < $min) {
4041: rulesmsg += ' - $alert{min}';
4042: }
4043: |;
4044: }
4045: if ($max) {
4046: $intargjs .= qq|
4047: if (currpwval.length > $max) {
4048: rulesmsg += ' - $alert{max}';
4049: }
4050: |;
4051: }
4052: if (@chars > 0) {
4053: my $charrulestr = '"'.join('","',@charrules).'"';
4054: my $charalertstr = '"'.join('","',@charalerts).'"';
4055: $intargjs .= qq| var brokerules = new Array();\n|.
4056: qq| var charrules = new Array($charrulestr);\n|.
4057: qq| var charalerts = new Array($charalertstr);\n|;
4058: my %rules;
4059: map { $rules{$_} = 1; } @chars;
4060: if ($rules{'uc'}) {
4061: $intargjs .= qq|
4062: var ucRegExp = /[A-Z]/;
4063: if (!ucRegExp.test(currpwval)) {
4064: brokerules.push('uc');
4065: }
4066: |;
4067: }
4068: if ($rules{'lc'}) {
4069: $intargjs .= qq|
4070: var lcRegExp = /[a-z]/;
4071: if (!lcRegExp.test(currpwval)) {
4072: brokerules.push('lc');
4073: }
4074: |;
4075: }
4076: if ($rules{'num'}) {
4077: $intargjs .= qq|
4078: var numRegExp = /[0-9]/;
4079: if (!numRegExp.test(currpwval)) {
4080: brokerules.push('num');
4081: }
4082: |;
4083: }
4084: if ($rules{'spec'}) {
4085: $intargjs .= q|
4086: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
4087: if (!specRegExp.test(currpwval)) {
4088: brokerules.push('spec');
4089: }
4090: |;
4091: }
4092: $intargjs .= qq|
4093: if (brokerules.length > 0) {
4094: for (var i=0; i<brokerules.length; i++) {
4095: for (var j=0; j<charrules.length; j++) {
4096: if (brokerules[i] == charrules[j]) {
4097: rulesmsg += ' - '+charalerts[j]+'\\n';
4098: break;
4099: }
4100: }
4101: }
4102: }
4103: |;
4104: }
4105: $intargjs .= qq|
4106: if (rulesmsg != '') {
4107: rulesmsg = '$alertmsg'+rulesmsg;
4108: alert(rulesmsg);
4109: return false;
4110: }
4111: |;
4112: }
4113: return ($numrules,$intargjs);
4114: }
4115:
1.80 albertel 4116: ###############################################################
4117: ## Get Kerberos Defaults for Domain ##
4118: ###############################################################
4119: ##
4120: ## Returns default kerberos version and an associated argument
4121: ## as listed in file domain.tab. If not listed, provides
4122: ## appropriate default domain and kerberos version.
4123: ##
4124: #-------------------------------------------
4125:
4126: =pod
4127:
1.648 raeburn 4128: =item * &get_kerberos_defaults()
1.80 albertel 4129:
4130: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 4131: version and domain. If not found, it defaults to version 4 and the
4132: domain of the server.
1.80 albertel 4133:
1.648 raeburn 4134: =over 4
4135:
1.80 albertel 4136: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
4137:
1.648 raeburn 4138: =back
4139:
4140: =back
4141:
1.80 albertel 4142: =cut
4143:
4144: #-------------------------------------------
4145: sub get_kerberos_defaults {
4146: my $domain=shift;
1.641 raeburn 4147: my ($krbdef,$krbdefdom);
4148: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
4149: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
4150: $krbdef = $domdefaults{'auth_def'};
4151: $krbdefdom = $domdefaults{'auth_arg_def'};
4152: } else {
1.80 albertel 4153: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
4154: my $krbdefdom=$1;
4155: $krbdefdom=~tr/a-z/A-Z/;
4156: $krbdef = "krb4";
4157: }
4158: return ($krbdef,$krbdefdom);
4159: }
1.112 bowersj2 4160:
1.32 matthew 4161:
1.46 matthew 4162: ###############################################################
4163: ## Thesaurus Functions ##
4164: ###############################################################
1.20 www 4165:
1.46 matthew 4166: =pod
1.20 www 4167:
1.112 bowersj2 4168: =head1 Thesaurus Functions
4169:
4170: =over 4
4171:
1.648 raeburn 4172: =item * &initialize_keywords()
1.46 matthew 4173:
4174: Initializes the package variable %Keywords if it is empty. Uses the
4175: package variable $thesaurus_db_file.
4176:
4177: =cut
4178:
4179: ###################################################
4180:
4181: sub initialize_keywords {
4182: return 1 if (scalar keys(%Keywords));
4183: # If we are here, %Keywords is empty, so fill it up
4184: # Make sure the file we need exists...
4185: if (! -e $thesaurus_db_file) {
4186: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
4187: " failed because it does not exist");
4188: return 0;
4189: }
4190: # Set up the hash as a database
4191: my %thesaurus_db;
4192: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4193: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4194: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
4195: $thesaurus_db_file);
4196: return 0;
4197: }
4198: # Get the average number of appearances of a word.
4199: my $avecount = $thesaurus_db{'average.count'};
4200: # Put keywords (those that appear > average) into %Keywords
4201: while (my ($word,$data)=each (%thesaurus_db)) {
4202: my ($count,undef) = split /:/,$data;
4203: $Keywords{$word}++ if ($count > $avecount);
4204: }
4205: untie %thesaurus_db;
4206: # Remove special values from %Keywords.
1.356 albertel 4207: foreach my $value ('total.count','average.count') {
4208: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4209: }
1.46 matthew 4210: return 1;
4211: }
4212:
4213: ###################################################
4214:
4215: =pod
4216:
1.648 raeburn 4217: =item * &keyword($word)
1.46 matthew 4218:
4219: Returns true if $word is a keyword. A keyword is a word that appears more
4220: than the average number of times in the thesaurus database. Calls
4221: &initialize_keywords
4222:
4223: =cut
4224:
4225: ###################################################
1.20 www 4226:
4227: sub keyword {
1.46 matthew 4228: return if (!&initialize_keywords());
4229: my $word=lc(shift());
4230: $word=~s/\W//g;
4231: return exists($Keywords{$word});
1.20 www 4232: }
1.46 matthew 4233:
4234: ###############################################################
4235:
4236: =pod
1.20 www 4237:
1.648 raeburn 4238: =item * &get_related_words()
1.46 matthew 4239:
1.160 matthew 4240: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4241: an array of words. If the keyword is not in the thesaurus, an empty array
4242: will be returned. The order of the words returned is determined by the
4243: database which holds them.
4244:
4245: Uses global $thesaurus_db_file.
4246:
1.1057 foxr 4247:
1.46 matthew 4248: =cut
4249:
4250: ###############################################################
4251: sub get_related_words {
4252: my $keyword = shift;
4253: my %thesaurus_db;
4254: if (! -e $thesaurus_db_file) {
4255: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4256: "failed because the file does not exist");
4257: return ();
4258: }
4259: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4260: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4261: return ();
4262: }
4263: my @Words=();
1.429 www 4264: my $count=0;
1.46 matthew 4265: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4266: # The first element is the number of times
4267: # the word appears. We do not need it now.
1.429 www 4268: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4269: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4270: my $threshold=$mostfrequentcount/10;
4271: foreach my $possibleword (@RelatedWords) {
4272: my ($word,$wordcount)=split(/\,/,$possibleword);
4273: if ($wordcount>$threshold) {
4274: push(@Words,$word);
4275: $count++;
4276: if ($count>10) { last; }
4277: }
1.20 www 4278: }
4279: }
1.46 matthew 4280: untie %thesaurus_db;
4281: return @Words;
1.14 harris41 4282: }
1.1090 foxr 4283: ###############################################################
4284: #
4285: # Spell checking
4286: #
4287:
4288: =pod
4289:
1.1142 raeburn 4290: =back
4291:
1.1090 foxr 4292: =head1 Spell checking
4293:
4294: =over 4
4295:
4296: =item * &check_spelling($wordlist $language)
4297:
4298: Takes a string containing words and feeds it to an external
4299: spellcheck program via a pipeline. Returns a string containing
4300: them mis-spelled words.
4301:
4302: Parameters:
4303:
4304: =over 4
4305:
4306: =item - $wordlist
4307:
4308: String that will be fed into the spellcheck program.
4309:
4310: =item - $language
4311:
4312: Language string that specifies the language for which the spell
4313: check will be performed.
4314:
4315: =back
4316:
4317: =back
4318:
4319: Note: This sub assumes that aspell is installed.
4320:
4321:
4322: =cut
4323:
1.46 matthew 4324:
1.1090 foxr 4325: sub check_spelling {
4326: my ($wordlist, $language) = @_;
1.1091 foxr 4327: my @misspellings;
4328:
4329: # Generate the speller and set the langauge.
4330: # if explicitly selected:
1.1090 foxr 4331:
1.1091 foxr 4332: my $speller = Text::Aspell->new;
1.1090 foxr 4333: if ($language) {
1.1091 foxr 4334: $speller->set_option('lang', $language);
1.1090 foxr 4335: }
4336:
1.1091 foxr 4337: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4338:
1.1091 foxr 4339: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4340:
1.1091 foxr 4341: foreach my $word (@words) {
4342: if(! $speller->check($word)) {
4343: push(@misspellings, $word);
1.1090 foxr 4344: }
4345: }
1.1091 foxr 4346: return join(' ', @misspellings);
4347:
1.1090 foxr 4348: }
4349:
1.61 www 4350: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4351: =pod
4352:
1.112 bowersj2 4353: =head1 User Name Functions
4354:
4355: =over 4
4356:
1.648 raeburn 4357: =item * &plainname($uname,$udom,$first)
1.81 albertel 4358:
1.112 bowersj2 4359: Takes a users logon name and returns it as a string in
1.226 albertel 4360: "first middle last generation" form
4361: if $first is set to 'lastname' then it returns it as
4362: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4363:
4364: =cut
1.61 www 4365:
1.295 www 4366:
1.81 albertel 4367: ###############################################################
1.61 www 4368: sub plainname {
1.226 albertel 4369: my ($uname,$udom,$first)=@_;
1.537 albertel 4370: return if (!defined($uname) || !defined($udom));
1.295 www 4371: my %names=&getnames($uname,$udom);
1.226 albertel 4372: my $name=&Apache::lonnet::format_name($names{'firstname'},
4373: $names{'middlename'},
4374: $names{'lastname'},
4375: $names{'generation'},$first);
4376: $name=~s/^\s+//;
1.62 www 4377: $name=~s/\s+$//;
4378: $name=~s/\s+/ /g;
1.353 albertel 4379: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4380: return $name;
1.61 www 4381: }
1.66 www 4382:
4383: # -------------------------------------------------------------------- Nickname
1.81 albertel 4384: =pod
4385:
1.648 raeburn 4386: =item * &nickname($uname,$udom)
1.81 albertel 4387:
4388: Gets a users name and returns it as a string as
4389:
4390: ""nickname""
1.66 www 4391:
1.81 albertel 4392: if the user has a nickname or
4393:
4394: "first middle last generation"
4395:
4396: if the user does not
4397:
4398: =cut
1.66 www 4399:
4400: sub nickname {
4401: my ($uname,$udom)=@_;
1.537 albertel 4402: return if (!defined($uname) || !defined($udom));
1.295 www 4403: my %names=&getnames($uname,$udom);
1.68 albertel 4404: my $name=$names{'nickname'};
1.66 www 4405: if ($name) {
4406: $name='"'.$name.'"';
4407: } else {
4408: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4409: $names{'lastname'}.' '.$names{'generation'};
4410: $name=~s/\s+$//;
4411: $name=~s/\s+/ /g;
4412: }
4413: return $name;
4414: }
4415:
1.295 www 4416: sub getnames {
4417: my ($uname,$udom)=@_;
1.537 albertel 4418: return if (!defined($uname) || !defined($udom));
1.433 albertel 4419: if ($udom eq 'public' && $uname eq 'public') {
4420: return ('lastname' => &mt('Public'));
4421: }
1.295 www 4422: my $id=$uname.':'.$udom;
4423: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4424: if ($cached) {
4425: return %{$names};
4426: } else {
4427: my %loadnames=&Apache::lonnet::get('environment',
4428: ['firstname','middlename','lastname','generation','nickname'],
4429: $udom,$uname);
4430: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4431: return %loadnames;
4432: }
4433: }
1.61 www 4434:
1.542 raeburn 4435: # -------------------------------------------------------------------- getemails
1.648 raeburn 4436:
1.542 raeburn 4437: =pod
4438:
1.648 raeburn 4439: =item * &getemails($uname,$udom)
1.542 raeburn 4440:
4441: Gets a user's email information and returns it as a hash with keys:
4442: notification, critnotification, permanentemail
4443:
4444: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4445: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4446:
1.648 raeburn 4447:
1.542 raeburn 4448: =cut
4449:
1.648 raeburn 4450:
1.466 albertel 4451: sub getemails {
4452: my ($uname,$udom)=@_;
4453: if ($udom eq 'public' && $uname eq 'public') {
4454: return;
4455: }
1.467 www 4456: if (!$udom) { $udom=$env{'user.domain'}; }
4457: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4458: my $id=$uname.':'.$udom;
4459: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4460: if ($cached) {
4461: return %{$names};
4462: } else {
4463: my %loadnames=&Apache::lonnet::get('environment',
4464: ['notification','critnotification',
4465: 'permanentemail'],
4466: $udom,$uname);
4467: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4468: return %loadnames;
4469: }
4470: }
4471:
1.551 albertel 4472: sub flush_email_cache {
4473: my ($uname,$udom)=@_;
4474: if (!$udom) { $udom =$env{'user.domain'}; }
4475: if (!$uname) { $uname=$env{'user.name'}; }
4476: return if ($udom eq 'public' && $uname eq 'public');
4477: my $id=$uname.':'.$udom;
4478: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4479: }
4480:
1.728 raeburn 4481: # -------------------------------------------------------------------- getlangs
4482:
4483: =pod
4484:
4485: =item * &getlangs($uname,$udom)
4486:
4487: Gets a user's language preference and returns it as a hash with key:
4488: language.
4489:
4490: =cut
4491:
4492:
4493: sub getlangs {
4494: my ($uname,$udom) = @_;
4495: if (!$udom) { $udom =$env{'user.domain'}; }
4496: if (!$uname) { $uname=$env{'user.name'}; }
4497: my $id=$uname.':'.$udom;
4498: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4499: if ($cached) {
4500: return %{$langs};
4501: } else {
4502: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4503: $udom,$uname);
4504: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4505: return %loadlangs;
4506: }
4507: }
4508:
4509: sub flush_langs_cache {
4510: my ($uname,$udom)=@_;
4511: if (!$udom) { $udom =$env{'user.domain'}; }
4512: if (!$uname) { $uname=$env{'user.name'}; }
4513: return if ($udom eq 'public' && $uname eq 'public');
4514: my $id=$uname.':'.$udom;
4515: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4516: }
4517:
1.61 www 4518: # ------------------------------------------------------------------ Screenname
1.81 albertel 4519:
4520: =pod
4521:
1.648 raeburn 4522: =item * &screenname($uname,$udom)
1.81 albertel 4523:
4524: Gets a users screenname and returns it as a string
4525:
4526: =cut
1.61 www 4527:
4528: sub screenname {
4529: my ($uname,$udom)=@_;
1.258 albertel 4530: if ($uname eq $env{'user.name'} &&
4531: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4532: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4533: return $names{'screenname'};
1.62 www 4534: }
4535:
1.212 albertel 4536:
1.802 bisitz 4537: # ------------------------------------------------------------- Confirm Wrapper
4538: =pod
4539:
1.1142 raeburn 4540: =item * &confirmwrapper($message)
1.802 bisitz 4541:
4542: Wrap messages about completion of operation in box
4543:
4544: =cut
4545:
4546: sub confirmwrapper {
4547: my ($message)=@_;
4548: if ($message) {
4549: return "\n".'<div class="LC_confirm_box">'."\n"
4550: .$message."\n"
4551: .'</div>'."\n";
4552: } else {
4553: return $message;
4554: }
4555: }
4556:
1.62 www 4557: # ------------------------------------------------------------- Message Wrapper
4558:
4559: sub messagewrapper {
1.369 www 4560: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4561: return
1.441 albertel 4562: '<a href="/adm/email?compose=individual&'.
4563: 'recname='.$username.'&recdom='.$domain.
4564: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4565: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4566: }
1.802 bisitz 4567:
1.74 www 4568: # --------------------------------------------------------------- Notes Wrapper
4569:
4570: sub noteswrapper {
4571: my ($link,$un,$do)=@_;
4572: return
1.896 amueller 4573: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4574: }
1.802 bisitz 4575:
1.62 www 4576: # ------------------------------------------------------------- Aboutme Wrapper
4577:
4578: sub aboutmewrapper {
1.1070 raeburn 4579: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4580: if (!defined($username) && !defined($domain)) {
4581: return;
4582: }
1.1096 raeburn 4583: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4584: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4585: }
4586:
4587: # ------------------------------------------------------------ Syllabus Wrapper
4588:
4589: sub syllabuswrapper {
1.707 bisitz 4590: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4591: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4592: }
1.14 harris41 4593:
1.1397 raeburn 4594: # -----------------------------------------------------------------------------
4595:
1.1396 raeburn 4596: sub aboutme_on {
4597: my ($uname,$udom)=@_;
4598: unless ($uname) { $uname=$env{'user.name'}; }
4599: unless ($udom) { $udom=$env{'user.domain'}; }
4600: return if ($udom eq 'public' && $uname eq 'public');
4601: my $hashkey=$uname.':'.$udom;
4602: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4603: if ($cached) {
4604: return $aboutme;
4605: }
4606: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4607: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4608: return $aboutme;
4609: }
4610:
4611: sub devalidate_aboutme_cache {
4612: my ($uname,$udom)=@_;
4613: if (!$udom) { $udom =$env{'user.domain'}; }
4614: if (!$uname) { $uname=$env{'user.name'}; }
4615: return if ($udom eq 'public' && $uname eq 'public');
4616: my $id=$uname.':'.$udom;
4617: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4618: }
4619:
1.208 matthew 4620: sub track_student_link {
1.887 raeburn 4621: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4622: my $link ="/adm/trackstudent?";
1.208 matthew 4623: my $title = 'View recent activity';
4624: if (defined($sname) && $sname !~ /^\s*$/ &&
4625: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4626: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4627: $title .= ' of this student';
1.268 albertel 4628: }
1.208 matthew 4629: if (defined($target) && $target !~ /^\s*$/) {
4630: $target = qq{target="$target"};
4631: } else {
4632: $target = '';
4633: }
1.268 albertel 4634: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4635: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4636: $title = &mt($title);
4637: $linktext = &mt($linktext);
1.448 albertel 4638: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4639: &help_open_topic('View_recent_activity');
1.208 matthew 4640: }
4641:
1.781 raeburn 4642: sub slot_reservations_link {
4643: my ($linktext,$sname,$sdom,$target) = @_;
4644: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4645: my $title = 'View slot reservation history';
4646: if (defined($sname) && $sname !~ /^\s*$/ &&
4647: defined($sdom) && $sdom !~ /^\s*$/) {
4648: $link .= "&uname=$sname&udom=$sdom";
4649: $title .= ' of this student';
4650: }
4651: if (defined($target) && $target !~ /^\s*$/) {
4652: $target = qq{target="$target"};
4653: } else {
4654: $target = '';
4655: }
4656: $title = &mt($title);
4657: $linktext = &mt($linktext);
4658: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4659: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4660:
4661: }
4662:
1.508 www 4663: # ===================================================== Display a student photo
4664:
4665:
1.509 albertel 4666: sub student_image_tag {
1.508 www 4667: my ($domain,$user)=@_;
4668: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4669: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4670: return '<img src="'.$imgsrc.'" align="right" />';
4671: } else {
4672: return '';
4673: }
4674: }
4675:
1.112 bowersj2 4676: =pod
4677:
4678: =back
4679:
4680: =head1 Access .tab File Data
4681:
4682: =over 4
4683:
1.648 raeburn 4684: =item * &languageids()
1.112 bowersj2 4685:
4686: returns list of all language ids
4687:
4688: =cut
4689:
1.14 harris41 4690: sub languageids {
1.16 harris41 4691: return sort(keys(%language));
1.14 harris41 4692: }
4693:
1.112 bowersj2 4694: =pod
4695:
1.648 raeburn 4696: =item * &languagedescription()
1.112 bowersj2 4697:
4698: returns description of a specified language id
4699:
4700: =cut
4701:
1.14 harris41 4702: sub languagedescription {
1.125 www 4703: my $code=shift;
4704: return ($supported_language{$code}?'* ':'').
4705: $language{$code}.
1.126 www 4706: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4707: }
4708:
1.1048 foxr 4709: =pod
4710:
4711: =item * &plainlanguagedescription
4712:
4713: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4714: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4715:
4716: =cut
4717:
1.145 www 4718: sub plainlanguagedescription {
4719: my $code=shift;
4720: return $language{$code};
4721: }
4722:
1.1048 foxr 4723: =pod
4724:
4725: =item * &supportedlanguagecode
4726:
4727: Returns the supported language code (e.g. sptutf maps to pt) given a language
4728: code.
4729:
4730: =cut
4731:
1.145 www 4732: sub supportedlanguagecode {
4733: my $code=shift;
4734: return $supported_language{$code};
1.97 www 4735: }
4736:
1.112 bowersj2 4737: =pod
4738:
1.1048 foxr 4739: =item * &latexlanguage()
4740:
4741: Given a language key code returns the correspondnig language to use
4742: to select the correct hyphenation on LaTeX printouts. This is undef if there
4743: is no supported hyphenation for the language code.
4744:
4745: =cut
4746:
4747: sub latexlanguage {
4748: my $code = shift;
4749: return $latex_language{$code};
4750: }
4751:
4752: =pod
4753:
4754: =item * &latexhyphenation()
4755:
4756: Same as above but what's supplied is the language as it might be stored
4757: in the metadata.
4758:
4759: =cut
4760:
4761: sub latexhyphenation {
4762: my $key = shift;
4763: return $latex_language_bykey{$key};
4764: }
4765:
4766: =pod
4767:
1.648 raeburn 4768: =item * ©rightids()
1.112 bowersj2 4769:
4770: returns list of all copyrights
4771:
4772: =cut
4773:
4774: sub copyrightids {
4775: return sort(keys(%cprtag));
4776: }
4777:
4778: =pod
4779:
1.648 raeburn 4780: =item * ©rightdescription()
1.112 bowersj2 4781:
4782: returns description of a specified copyright id
4783:
4784: =cut
4785:
4786: sub copyrightdescription {
1.166 www 4787: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4788: }
1.197 matthew 4789:
4790: =pod
4791:
1.648 raeburn 4792: =item * &source_copyrightids()
1.192 taceyjo1 4793:
4794: returns list of all source copyrights
4795:
4796: =cut
4797:
4798: sub source_copyrightids {
4799: return sort(keys(%scprtag));
4800: }
4801:
4802: =pod
4803:
1.648 raeburn 4804: =item * &source_copyrightdescription()
1.192 taceyjo1 4805:
4806: returns description of a specified source copyright id
4807:
4808: =cut
4809:
4810: sub source_copyrightdescription {
4811: return &mt($scprtag{shift(@_)});
4812: }
1.112 bowersj2 4813:
4814: =pod
4815:
1.648 raeburn 4816: =item * &filecategories()
1.112 bowersj2 4817:
4818: returns list of all file categories
4819:
4820: =cut
4821:
4822: sub filecategories {
4823: return sort(keys(%category_extensions));
4824: }
4825:
4826: =pod
4827:
1.648 raeburn 4828: =item * &filecategorytypes()
1.112 bowersj2 4829:
4830: returns list of file types belonging to a given file
4831: category
4832:
4833: =cut
4834:
4835: sub filecategorytypes {
1.356 albertel 4836: my ($cat) = @_;
1.1248 raeburn 4837: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4838: return @{$category_extensions{lc($cat)}};
4839: } else {
4840: return ();
4841: }
1.112 bowersj2 4842: }
4843:
4844: =pod
4845:
1.648 raeburn 4846: =item * &fileembstyle()
1.112 bowersj2 4847:
4848: returns embedding style for a specified file type
4849:
4850: =cut
4851:
4852: sub fileembstyle {
4853: return $fe{lc(shift(@_))};
1.169 www 4854: }
4855:
1.351 www 4856: sub filemimetype {
4857: return $fm{lc(shift(@_))};
4858: }
4859:
1.169 www 4860:
4861: sub filecategoryselect {
4862: my ($name,$value)=@_;
1.189 matthew 4863: return &select_form($value,$name,
1.970 raeburn 4864: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4865: }
4866:
4867: =pod
4868:
1.648 raeburn 4869: =item * &filedescription()
1.112 bowersj2 4870:
4871: returns description for a specified file type
4872:
4873: =cut
4874:
4875: sub filedescription {
1.188 matthew 4876: my $file_description = $fd{lc(shift())};
4877: $file_description =~ s:([\[\]]):~$1:g;
4878: return &mt($file_description);
1.112 bowersj2 4879: }
4880:
4881: =pod
4882:
1.648 raeburn 4883: =item * &filedescriptionex()
1.112 bowersj2 4884:
4885: returns description for a specified file type with
4886: extra formatting
4887:
4888: =cut
4889:
4890: sub filedescriptionex {
4891: my $ex=shift;
1.188 matthew 4892: my $file_description = $fd{lc($ex)};
4893: $file_description =~ s:([\[\]]):~$1:g;
4894: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4895: }
4896:
4897: # End of .tab access
4898: =pod
4899:
4900: =back
4901:
4902: =cut
4903:
4904: # ------------------------------------------------------------------ File Types
4905: sub fileextensions {
4906: return sort(keys(%fe));
4907: }
4908:
1.97 www 4909: # ----------------------------------------------------------- Display Languages
4910: # returns a hash with all desired display languages
4911: #
4912:
4913: sub display_languages {
4914: my %languages=();
1.695 raeburn 4915: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4916: $languages{$lang}=1;
1.97 www 4917: }
4918: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4919: if ($env{'form.displaylanguage'}) {
1.356 albertel 4920: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4921: $languages{$lang}=1;
1.97 www 4922: }
4923: }
4924: return %languages;
1.14 harris41 4925: }
4926:
1.582 albertel 4927: sub languages {
4928: my ($possible_langs) = @_;
1.695 raeburn 4929: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4930: if (!ref($possible_langs)) {
4931: if( wantarray ) {
4932: return @preferred_langs;
4933: } else {
4934: return $preferred_langs[0];
4935: }
4936: }
4937: my %possibilities = map { $_ => 1 } (@$possible_langs);
4938: my @preferred_possibilities;
4939: foreach my $preferred_lang (@preferred_langs) {
4940: if (exists($possibilities{$preferred_lang})) {
4941: push(@preferred_possibilities, $preferred_lang);
4942: }
4943: }
4944: if( wantarray ) {
4945: return @preferred_possibilities;
4946: }
4947: return $preferred_possibilities[0];
4948: }
4949:
1.742 raeburn 4950: sub user_lang {
4951: my ($touname,$toudom,$fromcid) = @_;
4952: my @userlangs;
4953: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4954: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4955: $env{'course.'.$fromcid.'.languages'}));
4956: } else {
4957: my %langhash = &getlangs($touname,$toudom);
4958: if ($langhash{'languages'} ne '') {
4959: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4960: } else {
4961: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4962: if ($domdefs{'lang_def'} ne '') {
4963: @userlangs = ($domdefs{'lang_def'});
4964: }
4965: }
4966: }
4967: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4968: my $user_lh = Apache::localize->get_handle(@languages);
4969: return $user_lh;
4970: }
4971:
4972:
1.112 bowersj2 4973: ###############################################################
4974: ## Student Answer Attempts ##
4975: ###############################################################
4976:
4977: =pod
4978:
4979: =head1 Alternate Problem Views
4980:
4981: =over 4
4982:
1.648 raeburn 4983: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4984: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4985:
4986: Return string with previous attempt on problem. Arguments:
4987:
4988: =over 4
4989:
4990: =item * $symb: Problem, including path
4991:
4992: =item * $username: username of the desired student
4993:
4994: =item * $domain: domain of the desired student
1.14 harris41 4995:
1.112 bowersj2 4996: =item * $course: Course ID
1.14 harris41 4997:
1.112 bowersj2 4998: =item * $getattempt: Leave blank for all attempts, otherwise put
4999: something
1.14 harris41 5000:
1.112 bowersj2 5001: =item * $regexp: if string matches this regexp, the string will be
5002: sent to $gradesub
1.14 harris41 5003:
1.112 bowersj2 5004: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 5005:
1.1199 raeburn 5006: =item * $usec: section of the desired student
5007:
5008: =item * $identifier: counter for student (multiple students one problem) or
5009: problem (one student; whole sequence).
5010:
1.112 bowersj2 5011: =back
1.14 harris41 5012:
1.112 bowersj2 5013: The output string is a table containing all desired attempts, if any.
1.16 harris41 5014:
1.112 bowersj2 5015: =cut
1.1 albertel 5016:
5017: sub get_previous_attempt {
1.1199 raeburn 5018: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 5019: my $prevattempts='';
1.43 ng 5020: no strict 'refs';
1.1 albertel 5021: if ($symb) {
1.3 albertel 5022: my (%returnhash)=
5023: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 5024: if ($returnhash{'version'}) {
5025: my %lasthash=();
5026: my $version;
5027: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 5028: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
5029: if ($key =~ /\.rawrndseed$/) {
5030: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
5031: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
5032: } else {
5033: $lasthash{$key}=$returnhash{$version.':'.$key};
5034: }
1.19 harris41 5035: }
1.1 albertel 5036: }
1.596 albertel 5037: $prevattempts=&start_data_table().&start_data_table_header_row();
5038: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 5039: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 5040: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 5041: foreach my $key (sort(keys(%lasthash))) {
5042: my ($ign,@parts) = split(/\./,$key);
1.41 ng 5043: if ($#parts > 0) {
1.31 albertel 5044: my $data=$parts[-1];
1.989 raeburn 5045: next if ($data eq 'foilorder');
1.31 albertel 5046: pop(@parts);
1.1010 www 5047: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 5048: if ($data eq 'type') {
5049: unless ($showsurv) {
5050: my $id = join(',',@parts);
5051: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 5052: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
5053: $lasthidden{$ign.'.'.$id} = 1;
5054: }
1.945 raeburn 5055: }
1.1199 raeburn 5056: if ($identifier ne '') {
5057: my $id = join(',',@parts);
5058: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
5059: $domain,$username,$usec,undef,$course) =~ /^no/) {
5060: $hidestatus{$ign.'.'.$id} = 1;
5061: }
5062: }
5063: } elsif ($data eq 'regrader') {
5064: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 5065: my $id = join(',',@parts);
5066: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 5067: }
1.1010 www 5068: }
1.31 albertel 5069: } else {
1.41 ng 5070: if ($#parts == 0) {
5071: $prevattempts.='<th>'.$parts[0].'</th>';
5072: } else {
5073: $prevattempts.='<th>'.$ign.'</th>';
5074: }
1.31 albertel 5075: }
1.16 harris41 5076: }
1.596 albertel 5077: $prevattempts.=&end_data_table_header_row();
1.40 ng 5078: if ($getattempt eq '') {
1.1199 raeburn 5079: my (%solved,%resets,%probstatus);
1.1200 raeburn 5080: if (($identifier ne '') && (keys(%regraded) > 0)) {
5081: for ($version=1;$version<=$returnhash{'version'};$version++) {
5082: foreach my $id (keys(%regraded)) {
5083: if (($returnhash{$version.':'.$id.'.regrader'}) &&
5084: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
5085: ($returnhash{$version.':'.$id.'.award'} eq '')) {
5086: push(@{$resets{$id}},$version);
1.1199 raeburn 5087: }
5088: }
5089: }
1.1200 raeburn 5090: }
5091: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 5092: my (@hidden,@unsolved);
1.945 raeburn 5093: if (%typeparts) {
5094: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 5095: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
5096: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 5097: push(@hidden,$id);
1.1199 raeburn 5098: } elsif ($identifier ne '') {
5099: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
5100: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
5101: ($hidestatus{$id})) {
1.1200 raeburn 5102: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 5103: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
5104: push(@{$solved{$id}},$version);
5105: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
5106: (ref($solved{$id}) eq 'ARRAY')) {
5107: my $skip;
5108: if (ref($resets{$id}) eq 'ARRAY') {
5109: foreach my $reset (@{$resets{$id}}) {
5110: if ($reset > $solved{$id}[-1]) {
5111: $skip=1;
5112: last;
5113: }
5114: }
5115: }
5116: unless ($skip) {
5117: my ($ign,$partslist) = split(/\./,$id,2);
5118: push(@unsolved,$partslist);
5119: }
5120: }
5121: }
1.945 raeburn 5122: }
5123: }
5124: }
5125: $prevattempts.=&start_data_table_row().
1.1199 raeburn 5126: '<td>'.&mt('Transaction [_1]',$version);
5127: if (@unsolved) {
5128: $prevattempts .= '<span class="LC_nobreak"><label>'.
5129: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
5130: &mt('Hide').'</label></span>';
5131: }
5132: $prevattempts .= '</td>';
1.945 raeburn 5133: if (@hidden) {
5134: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5135: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5136: my $hide;
5137: foreach my $id (@hidden) {
5138: if ($key =~ /^\Q$id\E/) {
5139: $hide = 1;
5140: last;
5141: }
5142: }
5143: if ($hide) {
5144: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5145: if (($data eq 'award') || ($data eq 'awarddetail')) {
5146: my $value = &format_previous_attempt_value($key,
5147: $returnhash{$version.':'.$key});
1.1173 kruse 5148: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5149: } else {
5150: $prevattempts.='<td> </td>';
5151: }
5152: } else {
5153: if ($key =~ /\./) {
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: } else {
5164: $prevattempts.='<td> </td>';
5165: }
5166: }
5167: }
5168: } else {
5169: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5170: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 5171: my $value = $returnhash{$version.':'.$key};
5172: if ($key =~ /\.rndseed$/) {
5173: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5174: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5175: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5176: }
5177: }
5178: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5179: ' </td>';
1.945 raeburn 5180: }
5181: }
5182: $prevattempts.=&end_data_table_row();
1.40 ng 5183: }
1.1 albertel 5184: }
1.945 raeburn 5185: my @currhidden = keys(%lasthidden);
1.596 albertel 5186: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 5187: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5188: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5189: if (%typeparts) {
5190: my $hidden;
5191: foreach my $id (@currhidden) {
5192: if ($key =~ /^\Q$id\E/) {
5193: $hidden = 1;
5194: last;
5195: }
5196: }
5197: if ($hidden) {
5198: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5199: if (($data eq 'award') || ($data eq 'awarddetail')) {
5200: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5201: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5202: $value = &$gradesub($value);
5203: }
1.1173 kruse 5204: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5205: } else {
5206: $prevattempts.='<td> </td>';
5207: }
5208: } else {
5209: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5210: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5211: $value = &$gradesub($value);
5212: }
1.1173 kruse 5213: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5214: }
5215: } else {
5216: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5217: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5218: $value = &$gradesub($value);
5219: }
1.1173 kruse 5220: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5221: }
1.16 harris41 5222: }
1.596 albertel 5223: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5224: } else {
1.1305 raeburn 5225: my $msg;
5226: if ($symb =~ /ext\.tool$/) {
5227: $msg = &mt('No grade passed back.');
5228: } else {
5229: $msg = &mt('Nothing submitted - no attempts.');
5230: }
1.596 albertel 5231: $prevattempts=
5232: &start_data_table().&start_data_table_row().
1.1305 raeburn 5233: '<td>'.$msg.'</td>'.
1.596 albertel 5234: &end_data_table_row().&end_data_table();
1.1 albertel 5235: }
5236: } else {
1.596 albertel 5237: $prevattempts=
5238: &start_data_table().&start_data_table_row().
5239: '<td>'.&mt('No data.').'</td>'.
5240: &end_data_table_row().&end_data_table();
1.1 albertel 5241: }
1.10 albertel 5242: }
5243:
1.581 albertel 5244: sub format_previous_attempt_value {
5245: my ($key,$value) = @_;
1.1011 www 5246: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5247: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5248: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5249: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5250: } elsif ($key =~ /answerstring$/) {
5251: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5252: my @answer = %answers;
5253: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5254: my @anskeys = sort(keys(%answers));
5255: if (@anskeys == 1) {
5256: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5257: if ($answer =~ m{\0}) {
5258: $answer =~ s{\0}{,}g;
1.988 raeburn 5259: }
5260: my $tag_internal_answer_name = 'INTERNAL';
5261: if ($anskeys[0] eq $tag_internal_answer_name) {
5262: $value = $answer;
5263: } else {
5264: $value = $anskeys[0].'='.$answer;
5265: }
5266: } else {
5267: foreach my $ans (@anskeys) {
5268: my $answer = $answers{$ans};
1.1001 raeburn 5269: if ($answer =~ m{\0}) {
5270: $answer =~ s{\0}{,}g;
1.988 raeburn 5271: }
5272: $value .= $ans.'='.$answer.'<br />';;
5273: }
5274: }
1.581 albertel 5275: } else {
1.1173 kruse 5276: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5277: }
5278: return $value;
5279: }
5280:
5281:
1.107 albertel 5282: sub relative_to_absolute {
5283: my ($url,$output)=@_;
5284: my $parser=HTML::TokeParser->new(\$output);
5285: my $token;
5286: my $thisdir=$url;
5287: my @rlinks=();
5288: while ($token=$parser->get_token) {
5289: if ($token->[0] eq 'S') {
5290: if ($token->[1] eq 'a') {
5291: if ($token->[2]->{'href'}) {
5292: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5293: }
5294: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5295: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5296: } elsif ($token->[1] eq 'base') {
5297: $thisdir=$token->[2]->{'href'};
5298: }
5299: }
5300: }
5301: $thisdir=~s-/[^/]*$--;
1.356 albertel 5302: foreach my $link (@rlinks) {
1.726 raeburn 5303: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5304: ($link=~/^\//) ||
5305: ($link=~/^javascript:/i) ||
5306: ($link=~/^mailto:/i) ||
5307: ($link=~/^\#/)) {
5308: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5309: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5310: }
5311: }
5312: # -------------------------------------------------- Deal with Applet codebases
5313: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5314: return $output;
5315: }
5316:
1.112 bowersj2 5317: =pod
5318:
1.648 raeburn 5319: =item * &get_student_view()
1.112 bowersj2 5320:
5321: show a snapshot of what student was looking at
5322:
5323: =cut
5324:
1.10 albertel 5325: sub get_student_view {
1.186 albertel 5326: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5327: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5328: my (%form);
1.10 albertel 5329: my @elements=('symb','courseid','domain','username');
5330: foreach my $element (@elements) {
1.186 albertel 5331: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5332: }
1.186 albertel 5333: if (defined($moreenv)) {
5334: %form=(%form,%{$moreenv});
5335: }
1.236 albertel 5336: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5337: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5338: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5339: $feedurl =~ s{^/adm/wrapper}{};
5340: }
1.650 www 5341: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5342: $userview=~s/\<body[^\>]*\>//gi;
5343: $userview=~s/\<\/body\>//gi;
5344: $userview=~s/\<html\>//gi;
5345: $userview=~s/\<\/html\>//gi;
5346: $userview=~s/\<head\>//gi;
5347: $userview=~s/\<\/head\>//gi;
1.1460 raeburn 5348: $userview=~s/\Q<div class="LC_landmark" role="main"\E/<div class="LC_landmark"/;
1.11 albertel 5349: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5350: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5351: if (wantarray) {
5352: return ($userview,$response);
5353: } else {
5354: return $userview;
5355: }
5356: }
5357:
5358: sub get_student_view_with_retries {
5359: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5360:
5361: my $ok = 0; # True if we got a good response.
5362: my $content;
5363: my $response;
5364:
5365: # Try to get the student_view done. within the retries count:
5366:
5367: do {
5368: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5369: $ok = $response->is_success;
5370: if (!$ok) {
5371: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5372: }
5373: $retries--;
5374: } while (!$ok && ($retries > 0));
5375:
5376: if (!$ok) {
5377: $content = ''; # On error return an empty content.
5378: }
1.651 www 5379: if (wantarray) {
5380: return ($content, $response);
5381: } else {
5382: return $content;
5383: }
1.11 albertel 5384: }
5385:
1.1349 raeburn 5386: sub css_links {
5387: my ($currsymb,$level) = @_;
5388: my ($links,@symbs,%cssrefs,%httpref);
5389: if ($level eq 'map') {
5390: my $navmap = Apache::lonnavmaps::navmap->new();
5391: if (ref($navmap)) {
5392: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5393: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5394: foreach my $res (@resources) {
5395: if (ref($res) && $res->symb()) {
5396: push(@symbs,$res->symb());
5397: }
5398: }
5399: }
5400: } else {
5401: @symbs = ($currsymb);
5402: }
5403: foreach my $symb (@symbs) {
5404: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5405: if ($css_href =~ /\S/) {
5406: unless ($css_href =~ m{https?://}) {
5407: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5408: my $proburl = &Apache::lonnet::clutter($url);
5409: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5410: unless ($css_href =~ m{^/}) {
5411: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5412: }
5413: if ($css_href =~ m{^/(res|uploaded)/}) {
5414: unless (($httpref{'httpref.'.$css_href}) ||
5415: (&Apache::lonnet::is_on_map($css_href))) {
5416: my $thisurl = $proburl;
5417: if ($env{'httpref.'.$proburl}) {
5418: $thisurl = $env{'httpref.'.$proburl};
5419: }
5420: $httpref{'httpref.'.$css_href} = $thisurl;
5421: }
5422: }
5423: }
5424: $cssrefs{$css_href} = 1;
5425: }
5426: }
5427: if (keys(%httpref)) {
5428: &Apache::lonnet::appenv(\%httpref);
5429: }
5430: if (keys(%cssrefs)) {
5431: foreach my $css_href (keys(%cssrefs)) {
5432: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5433: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5434: }
5435: }
5436: return $links;
5437: }
5438:
1.112 bowersj2 5439: =pod
5440:
1.648 raeburn 5441: =item * &get_student_answers()
1.112 bowersj2 5442:
5443: show a snapshot of how student was answering problem
5444:
5445: =cut
5446:
1.11 albertel 5447: sub get_student_answers {
1.100 sakharuk 5448: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5449: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5450: my (%moreenv);
1.11 albertel 5451: my @elements=('symb','courseid','domain','username');
5452: foreach my $element (@elements) {
1.186 albertel 5453: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5454: }
1.186 albertel 5455: $moreenv{'grade_target'}='answer';
5456: %moreenv=(%form,%moreenv);
1.497 raeburn 5457: $feedurl = &Apache::lonnet::clutter($feedurl);
5458: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5459: return $userview;
1.1 albertel 5460: }
1.116 albertel 5461:
5462: =pod
5463:
5464: =item * &submlink()
5465:
1.242 albertel 5466: Inputs: $text $uname $udom $symb $target
1.116 albertel 5467:
5468: Returns: A link to grades.pm such as to see the SUBM view of a student
5469:
5470: =cut
5471:
5472: ###############################################
5473: sub submlink {
1.242 albertel 5474: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5475: if (!($uname && $udom)) {
5476: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5477: &Apache::lonnet::whichuser($symb);
1.116 albertel 5478: if (!$symb) { $symb=$cursymb; }
5479: }
1.254 matthew 5480: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5481: $symb=&escape($symb);
1.960 bisitz 5482: if ($target) { $target=" target=\"$target\""; }
5483: return
5484: '<a href="/adm/grades?command=submission'.
5485: '&symb='.$symb.
5486: '&student='.$uname.
5487: '&userdom='.$udom.'"'.
5488: $target.'>'.$text.'</a>';
1.242 albertel 5489: }
5490: ##############################################
5491:
5492: =pod
5493:
5494: =item * &pgrdlink()
5495:
5496: Inputs: $text $uname $udom $symb $target
5497:
5498: Returns: A link to grades.pm such as to see the PGRD view of a student
5499:
5500: =cut
5501:
5502: ###############################################
5503: sub pgrdlink {
5504: my $link=&submlink(@_);
5505: $link=~s/(&command=submission)/$1&showgrading=yes/;
5506: return $link;
5507: }
5508: ##############################################
5509:
5510: =pod
5511:
5512: =item * &pprmlink()
5513:
5514: Inputs: $text $uname $udom $symb $target
5515:
5516: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5517: student and a specific resource
1.242 albertel 5518:
5519: =cut
5520:
5521: ###############################################
5522: sub pprmlink {
5523: my ($text,$uname,$udom,$symb,$target)=@_;
5524: if (!($uname && $udom)) {
5525: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5526: &Apache::lonnet::whichuser($symb);
1.242 albertel 5527: if (!$symb) { $symb=$cursymb; }
5528: }
1.254 matthew 5529: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5530: $symb=&escape($symb);
1.242 albertel 5531: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5532: return '<a href="/adm/parmset?command=set&'.
5533: 'symb='.$symb.'&uname='.$uname.
5534: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5535: }
5536: ##############################################
1.37 matthew 5537:
1.112 bowersj2 5538: =pod
5539:
5540: =back
5541:
5542: =cut
5543:
1.37 matthew 5544: ###############################################
1.51 www 5545:
5546:
5547: sub timehash {
1.687 raeburn 5548: my ($thistime) = @_;
5549: my $timezone = &Apache::lonlocal::gettimezone();
5550: my $dt = DateTime->from_epoch(epoch => $thistime)
5551: ->set_time_zone($timezone);
5552: my $wday = $dt->day_of_week();
5553: if ($wday == 7) { $wday = 0; }
5554: return ( 'second' => $dt->second(),
5555: 'minute' => $dt->minute(),
5556: 'hour' => $dt->hour(),
5557: 'day' => $dt->day_of_month(),
5558: 'month' => $dt->month(),
5559: 'year' => $dt->year(),
5560: 'weekday' => $wday,
5561: 'dayyear' => $dt->day_of_year(),
5562: 'dlsav' => $dt->is_dst() );
1.51 www 5563: }
5564:
1.370 www 5565: sub utc_string {
5566: my ($date)=@_;
1.371 www 5567: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5568: }
5569:
1.51 www 5570: sub maketime {
5571: my %th=@_;
1.687 raeburn 5572: my ($epoch_time,$timezone,$dt);
5573: $timezone = &Apache::lonlocal::gettimezone();
5574: eval {
5575: $dt = DateTime->new( year => $th{'year'},
5576: month => $th{'month'},
5577: day => $th{'day'},
5578: hour => $th{'hour'},
5579: minute => $th{'minute'},
5580: second => $th{'second'},
5581: time_zone => $timezone,
5582: );
5583: };
5584: if (!$@) {
5585: $epoch_time = $dt->epoch;
5586: if ($epoch_time) {
5587: return $epoch_time;
5588: }
5589: }
1.51 www 5590: return POSIX::mktime(
5591: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5592: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5593: }
5594:
5595: #########################################
1.51 www 5596:
5597: sub findallcourses {
1.482 raeburn 5598: my ($roles,$uname,$udom) = @_;
1.355 albertel 5599: my %roles;
5600: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5601: my %courses;
1.51 www 5602: my $now=time;
1.482 raeburn 5603: if (!defined($uname)) {
5604: $uname = $env{'user.name'};
5605: }
5606: if (!defined($udom)) {
5607: $udom = $env{'user.domain'};
5608: }
5609: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5610: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5611: if (!%roles) {
5612: %roles = (
5613: cc => 1,
1.907 raeburn 5614: co => 1,
1.482 raeburn 5615: in => 1,
5616: ep => 1,
5617: ta => 1,
5618: cr => 1,
5619: st => 1,
5620: );
5621: }
5622: foreach my $entry (keys(%roleshash)) {
5623: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5624: if ($trole =~ /^cr/) {
5625: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5626: } else {
5627: next if (!exists($roles{$trole}));
5628: }
5629: if ($tend) {
5630: next if ($tend < $now);
5631: }
5632: if ($tstart) {
5633: next if ($tstart > $now);
5634: }
1.1058 raeburn 5635: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5636: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5637: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5638: if ($secpart eq '') {
5639: ($cnum,$role) = split(/_/,$cnumpart);
5640: $sec = 'none';
1.1058 raeburn 5641: $value .= $cnum.'/';
1.482 raeburn 5642: } else {
5643: $cnum = $cnumpart;
5644: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5645: $value .= $cnum.'/'.$sec;
5646: }
5647: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5648: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5649: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5650: }
5651: } else {
5652: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5653: }
1.482 raeburn 5654: }
5655: } else {
5656: foreach my $key (keys(%env)) {
1.483 albertel 5657: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5658: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5659: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5660: next if ($role eq 'ca' || $role eq 'aa');
5661: next if (%roles && !exists($roles{$role}));
5662: my ($starttime,$endtime)=split(/\./,$env{$key});
5663: my $active=1;
5664: if ($starttime) {
5665: if ($now<$starttime) { $active=0; }
5666: }
5667: if ($endtime) {
5668: if ($now>$endtime) { $active=0; }
5669: }
5670: if ($active) {
1.1058 raeburn 5671: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5672: if ($sec eq '') {
5673: $sec = 'none';
1.1058 raeburn 5674: } else {
5675: $value .= $sec;
5676: }
5677: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5678: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5679: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5680: }
5681: } else {
5682: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5683: }
1.474 raeburn 5684: }
5685: }
1.51 www 5686: }
5687: }
1.474 raeburn 5688: return %courses;
1.51 www 5689: }
1.37 matthew 5690:
1.54 www 5691: ###############################################
1.474 raeburn 5692:
5693: sub blockcheck {
1.1372 raeburn 5694: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5695: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5696: my ($has_evb,$check_ipaccess);
5697: my $dom = $env{'user.domain'};
5698: if ($env{'request.course.id'}) {
5699: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5700: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5701: my $checkrole = "cm./$cdom/$cnum";
5702: my $sec = $env{'request.course.sec'};
5703: if ($sec ne '') {
5704: $checkrole .= "/$sec";
5705: }
5706: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5707: ($env{'request.role'} !~ /^st/)) {
5708: $has_evb = 1;
5709: }
5710: unless ($has_evb) {
5711: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
1.1444 raeburn 5712: ($activity eq 'index') || ($activity eq 'boards') || ($activity eq 'groups') ||
5713: ($activity eq 'chat')) {
1.1372 raeburn 5714: if ($udom eq $cdom) {
5715: $check_ipaccess = 1;
5716: }
5717: }
5718: }
1.1375 raeburn 5719: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5720: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5721: my $checkrole;
5722: if ($env{'request.role.domain'} eq '') {
5723: $checkrole = "cm./$env{'user.domain'}/";
5724: } else {
5725: $checkrole = "cm./$env{'request.role.domain'}/";
5726: }
5727: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5728: $has_evb = 1;
5729: }
1.1372 raeburn 5730: }
5731: unless ($has_evb || $check_ipaccess) {
5732: my @machinedoms = &Apache::lonnet::current_machine_domains();
5733: if (($dom eq 'public') && ($activity eq 'port')) {
5734: $dom = $udom;
5735: }
5736: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5737: $check_ipaccess = 1;
5738: } else {
5739: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5740: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5741: my $prim = &Apache::lonnet::domain($dom,'primary');
5742: my $intdom = &Apache::lonnet::internet_dom($prim);
5743: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5744: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5745: $check_ipaccess = 1;
5746: }
5747: }
5748: }
5749: }
5750: if ($check_ipaccess) {
5751: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5752: unless (defined($cached)) {
5753: my %domconfig =
5754: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5755: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5756: }
5757: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5758: foreach my $id (keys(%{$ipaccessref})) {
5759: if (ref($ipaccessref->{$id}) eq 'HASH') {
5760: my $range = $ipaccessref->{$id}->{'ip'};
5761: if ($range) {
5762: if (&Apache::lonnet::ip_match($clientip,$range)) {
5763: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5764: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5765: return ('','','',$id,$dom);
5766: last;
5767: }
5768: }
5769: }
5770: }
5771: }
5772: }
5773: }
5774: }
1.1373 raeburn 5775: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5776: return ();
5777: }
1.1372 raeburn 5778: }
1.1189 raeburn 5779: if (defined($udom) && defined($uname)) {
5780: # If uname and udom are for a course, check for blocks in the course.
5781: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5782: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5783: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5784: return ($startblock,$endblock,$triggerblock);
5785: }
5786: } else {
1.490 raeburn 5787: $udom = $env{'user.domain'};
5788: $uname = $env{'user.name'};
5789: }
5790:
1.502 raeburn 5791: my $startblock = 0;
5792: my $endblock = 0;
1.1062 raeburn 5793: my $triggerblock = '';
1.1373 raeburn 5794: my %live_courses;
5795: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5796: %live_courses = &findallcourses(undef,$uname,$udom);
5797: }
1.474 raeburn 5798:
1.490 raeburn 5799: # If uname is for a user, and activity is course-specific, i.e.,
5800: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5801:
1.490 raeburn 5802: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5803: $activity eq 'groups' || $activity eq 'printout' ||
1.1444 raeburn 5804: $activity eq 'search' || $activity eq 'index' ||
5805: $activity eq 'reinit' || $activity eq 'alert') &&
1.1189 raeburn 5806: ($env{'request.course.id'})) {
1.490 raeburn 5807: foreach my $key (keys(%live_courses)) {
5808: if ($key ne $env{'request.course.id'}) {
5809: delete($live_courses{$key});
5810: }
5811: }
5812: }
5813:
5814: my $otheruser = 0;
5815: my %own_courses;
5816: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5817: # Resource belongs to user other than current user.
5818: $otheruser = 1;
5819: # Gather courses for current user
5820: %own_courses =
5821: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5822: }
5823:
5824: # Gather active course roles - course coordinator, instructor,
5825: # exam proctor, ta, student, or custom role.
1.474 raeburn 5826:
5827: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5828: my ($cdom,$cnum);
5829: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5830: $cdom = $env{'course.'.$course.'.domain'};
5831: $cnum = $env{'course.'.$course.'.num'};
5832: } else {
1.490 raeburn 5833: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5834: }
5835: my $no_ownblock = 0;
5836: my $no_userblock = 0;
1.533 raeburn 5837: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5838: # Check if current user has 'evb' priv for this
5839: if (defined($own_courses{$course})) {
5840: foreach my $sec (keys(%{$own_courses{$course}})) {
5841: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5842: if ($sec ne 'none') {
5843: $checkrole .= '/'.$sec;
5844: }
5845: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5846: $no_ownblock = 1;
5847: last;
5848: }
5849: }
5850: }
5851: # if they have 'evb' priv and are currently not playing student
5852: next if (($no_ownblock) &&
5853: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5854: }
1.474 raeburn 5855: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5856: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5857: if ($sec ne 'none') {
1.482 raeburn 5858: $checkrole .= '/'.$sec;
1.474 raeburn 5859: }
1.490 raeburn 5860: if ($otheruser) {
5861: # Resource belongs to user other than current user.
5862: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5863: my (%allroles,%userroles);
5864: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5865: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5866: my ($trole,$tdom,$tnum,$tsec);
5867: if ($entry =~ /^cr/) {
5868: ($trole,$tdom,$tnum,$tsec) =
5869: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5870: } else {
5871: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5872: }
5873: my ($spec,$area,$trest);
5874: $area = '/'.$tdom.'/'.$tnum;
5875: $trest = $tnum;
5876: if ($tsec ne '') {
5877: $area .= '/'.$tsec;
5878: $trest .= '/'.$tsec;
5879: }
5880: $spec = $trole.'.'.$area;
5881: if ($trole =~ /^cr/) {
5882: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5883: $tdom,$spec,$trest,$area);
5884: } else {
5885: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5886: $tdom,$spec,$trest,$area);
5887: }
5888: }
1.1276 raeburn 5889: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5890: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5891: if ($1) {
5892: $no_userblock = 1;
5893: last;
5894: }
1.486 raeburn 5895: }
5896: }
1.490 raeburn 5897: } else {
5898: # Resource belongs to current user
5899: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5900: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5901: $no_ownblock = 1;
5902: last;
5903: }
1.474 raeburn 5904: }
5905: }
5906: # if they have the evb priv and are currently not playing student
1.482 raeburn 5907: next if (($no_ownblock) &&
1.491 albertel 5908: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5909: next if ($no_userblock);
1.474 raeburn 5910:
1.1303 raeburn 5911: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5912: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5913:
1.1062 raeburn 5914: my ($start,$end,$trigger) =
1.1347 raeburn 5915: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5916: if (($start != 0) &&
5917: (($startblock == 0) || ($startblock > $start))) {
5918: $startblock = $start;
1.1062 raeburn 5919: if ($trigger ne '') {
5920: $triggerblock = $trigger;
5921: }
1.502 raeburn 5922: }
5923: if (($end != 0) &&
5924: (($endblock == 0) || ($endblock < $end))) {
5925: $endblock = $end;
1.1062 raeburn 5926: if ($trigger ne '') {
5927: $triggerblock = $trigger;
5928: }
1.502 raeburn 5929: }
1.490 raeburn 5930: }
1.1062 raeburn 5931: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5932: }
5933:
5934: sub get_blocks {
1.1347 raeburn 5935: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5936: my $startblock = 0;
5937: my $endblock = 0;
1.1062 raeburn 5938: my $triggerblock = '';
1.490 raeburn 5939: my $course = $cdom.'_'.$cnum;
5940: $setters->{$course} = {};
5941: $setters->{$course}{'staff'} = [];
5942: $setters->{$course}{'times'} = [];
1.1062 raeburn 5943: $setters->{$course}{'triggers'} = [];
5944: my (@blockers,%triggered);
5945: my $now = time;
5946: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5947: if ($activity eq 'docs') {
1.1348 raeburn 5948: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5949: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5950: $blocked = 1;
5951: $nosymbcache = 1;
1.1348 raeburn 5952: $noenccheck = 1;
1.1347 raeburn 5953: }
1.1348 raeburn 5954: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5955: foreach my $block (@blockers) {
5956: if ($block =~ /^firstaccess____(.+)$/) {
5957: my $item = $1;
5958: my $type = 'map';
5959: my $timersymb = $item;
5960: if ($item eq 'course') {
5961: $type = 'course';
5962: } elsif ($item =~ /___\d+___/) {
5963: $type = 'resource';
5964: } else {
5965: $timersymb = &Apache::lonnet::symbread($item);
5966: }
5967: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5968: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5969: $triggered{$block} = {
5970: start => $start,
5971: end => $end,
5972: type => $type,
5973: };
5974: }
5975: }
5976: } else {
5977: foreach my $block (keys(%commblocks)) {
5978: if ($block =~ m/^(\d+)____(\d+)$/) {
5979: my ($start,$end) = ($1,$2);
5980: if ($start <= time && $end >= time) {
5981: if (ref($commblocks{$block}) eq 'HASH') {
5982: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5983: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5984: unless(grep(/^\Q$block\E$/,@blockers)) {
5985: push(@blockers,$block);
5986: }
5987: }
5988: }
5989: }
5990: }
5991: } elsif ($block =~ /^firstaccess____(.+)$/) {
5992: my $item = $1;
5993: my $timersymb = $item;
5994: my $type = 'map';
5995: if ($item eq 'course') {
5996: $type = 'course';
5997: } elsif ($item =~ /___\d+___/) {
5998: $type = 'resource';
5999: } else {
6000: $timersymb = &Apache::lonnet::symbread($item);
6001: }
6002: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
6003: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
6004: if ($start && $end) {
6005: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 6006: if (ref($commblocks{$block}) eq 'HASH') {
6007: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
6008: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
6009: unless(grep(/^\Q$block\E$/,@blockers)) {
6010: push(@blockers,$block);
6011: $triggered{$block} = {
6012: start => $start,
6013: end => $end,
6014: type => $type,
6015: };
6016: }
6017: }
6018: }
1.1062 raeburn 6019: }
6020: }
1.490 raeburn 6021: }
1.1062 raeburn 6022: }
6023: }
6024: }
6025: foreach my $blocker (@blockers) {
6026: my ($staff_name,$staff_dom,$title,$blocks) =
6027: &parse_block_record($commblocks{$blocker});
6028: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
6029: my ($start,$end,$triggertype);
6030: if ($blocker =~ m/^(\d+)____(\d+)$/) {
6031: ($start,$end) = ($1,$2);
6032: } elsif (ref($triggered{$blocker}) eq 'HASH') {
6033: $start = $triggered{$blocker}{'start'};
6034: $end = $triggered{$blocker}{'end'};
6035: $triggertype = $triggered{$blocker}{'type'};
6036: }
6037: if ($start) {
6038: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6039: if ($triggertype) {
6040: push(@{$$setters{$course}{'triggers'}},$triggertype);
6041: } else {
6042: push(@{$$setters{$course}{'triggers'}},0);
6043: }
6044: if ( ($startblock == 0) || ($startblock > $start) ) {
6045: $startblock = $start;
6046: if ($triggertype) {
6047: $triggerblock = $blocker;
1.474 raeburn 6048: }
6049: }
1.1062 raeburn 6050: if ( ($endblock == 0) || ($endblock < $end) ) {
6051: $endblock = $end;
6052: if ($triggertype) {
6053: $triggerblock = $blocker;
6054: }
6055: }
1.474 raeburn 6056: }
6057: }
1.1062 raeburn 6058: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6059: }
6060:
6061: sub parse_block_record {
6062: my ($record) = @_;
6063: my ($setuname,$setudom,$title,$blocks);
6064: if (ref($record) eq 'HASH') {
6065: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6066: $title = &unescape($record->{'event'});
6067: $blocks = $record->{'blocks'};
6068: } else {
6069: my @data = split(/:/,$record,3);
6070: if (scalar(@data) eq 2) {
6071: $title = $data[1];
6072: ($setuname,$setudom) = split(/@/,$data[0]);
6073: } else {
6074: ($setuname,$setudom,$title) = @data;
6075: }
6076: $blocks = { 'com' => 'on' };
6077: }
6078: return ($setuname,$setudom,$title,$blocks);
6079: }
6080:
1.854 kalberla 6081: sub blocking_status {
1.1372 raeburn 6082: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6083: my %setters;
1.890 droeschl 6084:
1.1061 raeburn 6085: # check for active blocking
1.1372 raeburn 6086: if ($clientip eq '') {
6087: $clientip = &Apache::lonnet::get_requestor_ip();
6088: }
6089: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6090: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6091: my $blocked = 0;
1.1372 raeburn 6092: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6093: $blocked = 1;
6094: }
1.890 droeschl 6095:
1.1061 raeburn 6096: # caller just wants to know whether a block is active
6097: if (!wantarray) { return $blocked; }
6098:
6099: # build a link to a popup window containing the details
6100: my $querystring = "?activity=$activity";
1.1351 raeburn 6101: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6102: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6103: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6104: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6105: } elsif ($activity eq 'docs') {
1.1347 raeburn 6106: my $showurl = &Apache::lonenc::check_encrypt($url);
6107: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6108: if ($symb) {
6109: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6110: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6111: }
1.1062 raeburn 6112: }
1.1061 raeburn 6113:
6114: my $output .= <<'END_MYBLOCK';
6115: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6116: var options = "width=" + w + ",height=" + h + ",";
6117: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6118: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6119: var newWin = window.open(url, wdwName, options);
6120: newWin.focus();
6121: }
1.890 droeschl 6122: END_MYBLOCK
1.854 kalberla 6123:
1.1061 raeburn 6124: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6125:
1.1061 raeburn 6126: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6127: my $text = &mt('Communication Blocked');
1.1217 raeburn 6128: my $class = 'LC_comblock';
1.1062 raeburn 6129: if ($activity eq 'docs') {
6130: $text = &mt('Content Access Blocked');
1.1217 raeburn 6131: $class = '';
1.1063 raeburn 6132: } elsif ($activity eq 'printout') {
6133: $text = &mt('Printing Blocked');
1.1232 raeburn 6134: } elsif ($activity eq 'passwd') {
6135: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6136: } elsif ($activity eq 'grades') {
6137: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6138: } elsif ($activity eq 'search') {
6139: $text = &mt('Search Blocked');
1.1444 raeburn 6140: } elsif ($activity eq 'index') {
6141: $text = &mt('Content Index Blocked');
1.1282 raeburn 6142: } elsif ($activity eq 'alert') {
6143: $text = &mt('Checking Critical Messages Blocked');
6144: } elsif ($activity eq 'reinit') {
6145: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6146: } elsif ($activity eq 'about') {
6147: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6148: } elsif ($activity eq 'wishlist') {
6149: $text = &mt('Access to Stored Links Blocked');
6150: } elsif ($activity eq 'annotate') {
6151: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6152: }
1.1061 raeburn 6153: $output .= <<"END_BLOCK";
1.1217 raeburn 6154: <div class='$class'>
1.869 kalberla 6155: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6156: title='$text'>
6157: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6158: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6159: title='$text'>$text</a>
1.867 kalberla 6160: </div>
6161:
6162: END_BLOCK
1.474 raeburn 6163:
1.1061 raeburn 6164: return ($blocked, $output);
1.854 kalberla 6165: }
1.490 raeburn 6166:
1.60 matthew 6167: ###############################################
6168:
1.682 raeburn 6169: sub check_ip_acc {
1.1201 raeburn 6170: my ($acc,$clientip)=@_;
1.682 raeburn 6171: &Apache::lonxml::debug("acc is $acc");
6172: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6173: return 1;
6174: }
1.1339 raeburn 6175: my ($ip,$allowed);
6176: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6177: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6178: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6179: } else {
1.1350 raeburn 6180: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6181: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6182: }
1.682 raeburn 6183:
6184: my $name;
1.1219 raeburn 6185: my %access = (
6186: allowfrom => 1,
6187: denyfrom => 0,
6188: );
6189: my @allows;
6190: my @denies;
6191: foreach my $item (split(',',$acc)) {
6192: $item =~ s/^\s*//;
6193: $item =~ s/\s*$//;
6194: my $pattern;
6195: if ($item =~ /^\!(.+)$/) {
6196: push(@denies,$1);
6197: } else {
6198: push(@allows,$item);
6199: }
6200: }
6201: my $numdenies = scalar(@denies);
6202: my $numallows = scalar(@allows);
6203: my $count = 0;
6204: foreach my $pattern (@denies,@allows) {
6205: $count ++;
6206: my $acctype = 'allowfrom';
6207: if ($count <= $numdenies) {
6208: $acctype = 'denyfrom';
6209: }
1.682 raeburn 6210: if ($pattern =~ /\*$/) {
6211: #35.8.*
6212: $pattern=~s/\*//;
1.1219 raeburn 6213: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6214: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6215: #35.8.3.[34-56]
6216: my $low=$2;
6217: my $high=$3;
6218: $pattern=$1;
6219: if ($ip =~ /^\Q$pattern\E/) {
6220: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6221: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6222: }
6223: } elsif ($pattern =~ /^\*/) {
6224: #*.msu.edu
6225: $pattern=~s/\*//;
6226: if (!defined($name)) {
6227: use Socket;
6228: my $netaddr=inet_aton($ip);
6229: ($name)=gethostbyaddr($netaddr,AF_INET);
6230: }
1.1219 raeburn 6231: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6232: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6233: #127.0.0.1
1.1219 raeburn 6234: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6235: } else {
6236: #some.name.com
6237: if (!defined($name)) {
6238: use Socket;
6239: my $netaddr=inet_aton($ip);
6240: ($name)=gethostbyaddr($netaddr,AF_INET);
6241: }
1.1219 raeburn 6242: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6243: }
6244: if ($allowed =~ /^(0|1)$/) { last; }
6245: }
6246: if ($allowed eq '') {
6247: if ($numdenies && !$numallows) {
6248: $allowed = 1;
6249: } else {
6250: $allowed = 0;
1.682 raeburn 6251: }
6252: }
6253: return $allowed;
6254: }
6255:
6256: ###############################################
6257:
1.60 matthew 6258: =pod
6259:
1.112 bowersj2 6260: =head1 Domain Template Functions
6261:
6262: =over 4
6263:
6264: =item * &determinedomain()
1.60 matthew 6265:
6266: Inputs: $domain (usually will be undef)
6267:
1.63 www 6268: Returns: Determines which domain should be used for designs
1.60 matthew 6269:
6270: =cut
1.54 www 6271:
1.60 matthew 6272: ###############################################
1.63 www 6273: sub determinedomain {
6274: my $domain=shift;
1.531 albertel 6275: if (! $domain) {
1.60 matthew 6276: # Determine domain if we have not been given one
1.893 raeburn 6277: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6278: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6279: if ($env{'request.role.domain'}) {
6280: $domain=$env{'request.role.domain'};
1.60 matthew 6281: }
6282: }
1.63 www 6283: return $domain;
6284: }
6285: ###############################################
1.517 raeburn 6286:
1.518 albertel 6287: sub devalidate_domconfig_cache {
6288: my ($udom)=@_;
6289: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6290: }
6291:
6292: # ---------------------- Get domain configuration for a domain
6293: sub get_domainconf {
6294: my ($udom) = @_;
6295: my $cachetime=1800;
6296: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6297: if (defined($cached)) { return %{$result}; }
6298:
6299: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6300: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6301: my (%designhash,%legacy);
1.518 albertel 6302: if (keys(%domconfig) > 0) {
6303: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6304: if (keys(%{$domconfig{'login'}})) {
6305: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6306: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6307: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6308: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6309: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6310: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6311: if ($key eq 'loginvia') {
6312: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6313: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6314: $designhash{$udom.'.login.loginvia'} = $server;
6315: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6316:
6317: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6318: } else {
6319: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6320: }
1.948 raeburn 6321: }
1.1208 raeburn 6322: } elsif ($key eq 'headtag') {
6323: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6324: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6325: }
1.946 raeburn 6326: }
1.1208 raeburn 6327: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6328: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6329: }
1.946 raeburn 6330: }
6331: }
6332: }
1.1366 raeburn 6333: } elsif ($key eq 'saml') {
6334: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6335: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6336: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6337: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6338: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6339: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6340: }
6341: }
6342: }
6343: }
1.946 raeburn 6344: } else {
6345: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6346: $designhash{$udom.'.login.'.$key.'_'.$img} =
6347: $domconfig{'login'}{$key}{$img};
6348: }
1.699 raeburn 6349: }
6350: } else {
6351: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6352: }
1.632 raeburn 6353: }
6354: } else {
6355: $legacy{'login'} = 1;
1.518 albertel 6356: }
1.632 raeburn 6357: } else {
6358: $legacy{'login'} = 1;
1.518 albertel 6359: }
6360: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6361: if (keys(%{$domconfig{'rolecolors'}})) {
6362: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6363: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6364: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6365: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6366: }
1.518 albertel 6367: }
6368: }
1.632 raeburn 6369: } else {
6370: $legacy{'rolecolors'} = 1;
1.518 albertel 6371: }
1.632 raeburn 6372: } else {
6373: $legacy{'rolecolors'} = 1;
1.518 albertel 6374: }
1.948 raeburn 6375: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6376: if ($domconfig{'autoenroll'}{'co-owners'}) {
6377: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6378: }
6379: }
1.632 raeburn 6380: if (keys(%legacy) > 0) {
6381: my %legacyhash = &get_legacy_domconf($udom);
6382: foreach my $item (keys(%legacyhash)) {
6383: if ($item =~ /^\Q$udom\E\.login/) {
6384: if ($legacy{'login'}) {
6385: $designhash{$item} = $legacyhash{$item};
6386: }
6387: } else {
6388: if ($legacy{'rolecolors'}) {
6389: $designhash{$item} = $legacyhash{$item};
6390: }
1.518 albertel 6391: }
6392: }
6393: }
1.632 raeburn 6394: } else {
6395: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6396: }
6397: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6398: $cachetime);
6399: return %designhash;
6400: }
6401:
1.632 raeburn 6402: sub get_legacy_domconf {
6403: my ($udom) = @_;
6404: my %legacyhash;
6405: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6406: my $designfile = $designdir.'/'.$udom.'.tab';
6407: if (-e $designfile) {
1.1317 raeburn 6408: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6409: while (my $line = <$fh>) {
6410: next if ($line =~ /^\#/);
6411: chomp($line);
6412: my ($key,$val)=(split(/\=/,$line));
6413: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6414: }
6415: close($fh);
6416: }
6417: }
1.1026 raeburn 6418: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6419: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6420: }
6421: return %legacyhash;
6422: }
6423:
1.63 www 6424: =pod
6425:
1.112 bowersj2 6426: =item * &domainlogo()
1.63 www 6427:
6428: Inputs: $domain (usually will be undef)
6429:
6430: Returns: A link to a domain logo, if the domain logo exists.
6431: If the domain logo does not exist, a description of the domain.
6432:
6433: =cut
1.112 bowersj2 6434:
1.63 www 6435: ###############################################
6436: sub domainlogo {
1.517 raeburn 6437: my $domain = &determinedomain(shift);
1.518 albertel 6438: my %designhash = &get_domainconf($domain);
1.517 raeburn 6439: # See if there is a logo
6440: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6441: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6442: if ($imgsrc =~ m{^/(adm|res)/}) {
6443: if ($imgsrc =~ m{^/res/}) {
6444: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6445: &Apache::lonnet::repcopy($local_name);
6446: }
6447: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6448: }
6449: my $alttext = $domain;
6450: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6451: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6452: }
6453: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6454: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6455: return &Apache::lonnet::domain($domain,'description');
1.59 www 6456: } else {
1.60 matthew 6457: return '';
1.59 www 6458: }
6459: }
1.63 www 6460: ##############################################
6461:
6462: =pod
6463:
1.112 bowersj2 6464: =item * &designparm()
1.63 www 6465:
6466: Inputs: $which parameter; $domain (usually will be undef)
6467:
6468: Returns: value of designparamter $which
6469:
6470: =cut
1.112 bowersj2 6471:
1.397 albertel 6472:
1.400 albertel 6473: ##############################################
1.397 albertel 6474: sub designparm {
6475: my ($which,$domain)=@_;
6476: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6477: return $env{'environment.color.'.$which};
1.96 www 6478: }
1.63 www 6479: $domain=&determinedomain($domain);
1.1016 raeburn 6480: my %domdesign;
6481: unless ($domain eq 'public') {
6482: %domdesign = &get_domainconf($domain);
6483: }
1.520 raeburn 6484: my $output;
1.517 raeburn 6485: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6486: $output = $domdesign{$domain.'.'.$which};
1.63 www 6487: } else {
1.520 raeburn 6488: $output = $defaultdesign{$which};
6489: }
6490: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6491: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6492: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6493: if ($output =~ m{^/res/}) {
6494: my $local_name = &Apache::lonnet::filelocation('',$output);
6495: &Apache::lonnet::repcopy($local_name);
6496: }
1.520 raeburn 6497: $output = &lonhttpdurl($output);
6498: }
1.63 www 6499: }
1.520 raeburn 6500: return $output;
1.63 www 6501: }
1.59 www 6502:
1.822 bisitz 6503: ##############################################
6504: =pod
6505:
1.832 bisitz 6506: =item * &authorspace()
6507:
1.1028 raeburn 6508: Inputs: $url (usually will be undef).
1.832 bisitz 6509:
1.1132 raeburn 6510: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6511: directory being viewed (or for which action is being taken).
6512: If $url is provided, and begins /priv/<domain>/<uname>
6513: the path will be that portion of the $context argument.
6514: Otherwise the path will be for the author space of the current
6515: user when the current role is author, or for that of the
6516: co-author/assistant co-author space when the current role
6517: is co-author or assistant co-author.
1.832 bisitz 6518:
6519: =cut
6520:
6521: sub authorspace {
1.1028 raeburn 6522: my ($url) = @_;
6523: if ($url ne '') {
6524: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6525: return $1;
6526: }
6527: }
1.832 bisitz 6528: my $caname = '';
1.1024 www 6529: my $cadom = '';
1.1028 raeburn 6530: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6531: ($cadom,$caname) =
1.832 bisitz 6532: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6533: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6534: $caname = $env{'user.name'};
1.1024 www 6535: $cadom = $env{'user.domain'};
1.832 bisitz 6536: }
1.1028 raeburn 6537: if (($caname ne '') && ($cadom ne '')) {
6538: return "/priv/$cadom/$caname/";
6539: }
6540: return;
1.832 bisitz 6541: }
6542:
6543: ##############################################
6544: =pod
6545:
1.822 bisitz 6546: =item * &head_subbox()
6547:
6548: Inputs: $content (contains HTML code with page functions, etc.)
6549:
6550: Returns: HTML div with $content
6551: To be included in page header
6552:
6553: =cut
6554:
6555: sub head_subbox {
6556: my ($content)=@_;
6557: my $output =
1.993 raeburn 6558: '<div class="LC_head_subbox">'
1.822 bisitz 6559: .$content
6560: .'</div>'
6561: }
6562:
6563: ##############################################
6564: =pod
6565:
6566: =item * &CSTR_pageheader()
6567:
1.1026 raeburn 6568: Input: (optional) filename from which breadcrumb trail is built.
6569: In most cases no input as needed, as $env{'request.filename'}
6570: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6571: frameset flag
6572: If page header is being requested for use in a frameset, then
6573: the second (option) argument -- frameset will be true, and
6574: the target attribute set for links should be target="_parent".
1.1433 raeburn 6575: If $title is supplied as the third arg, that will be used to
1.1407 raeburn 6576: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6577:
6578: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6579: To be included on Authoring Space pages
1.822 bisitz 6580:
6581: =cut
6582:
6583: sub CSTR_pageheader {
1.1407 raeburn 6584: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6585: if ($trailfile eq '') {
6586: $trailfile = $env{'request.filename'};
6587: }
6588:
6589: # this is for resources; directories have customtitle, and crumbs
6590: # and select recent are created in lonpubdir.pm
6591:
6592: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6593: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6594: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6595: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6596: $formaction =~ s{/+}{/}g;
1.822 bisitz 6597:
6598: my $parentpath = '';
6599: my $lastitem = '';
6600: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6601: $parentpath = $1;
6602: $lastitem = $2;
6603: } else {
6604: $lastitem = $thisdisfn;
6605: }
1.921 bisitz 6606:
1.1406 raeburn 6607: my $crsauthor;
1.1246 raeburn 6608: if (($env{'request.course.id'}) &&
6609: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6610: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6611: $crsauthor = 1;
1.1406 raeburn 6612: if ($title eq '') {
6613: $title = &mt('Course Authoring Space');
6614: }
6615: } elsif ($title eq '') {
1.1246 raeburn 6616: $title = &mt('Authoring Space');
6617: }
6618:
1.1379 raeburn 6619: my ($target,$crumbtarget) = (' target="_top"','_top');
6620: if ($frameset) {
6621: $target = ' target="_parent"';
6622: $crumbtarget = '_parent';
6623: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6624: $target = '';
6625: $crumbtarget = '';
1.1379 raeburn 6626: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6627: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6628: $crumbtarget = $env{'request.deeplink.target'};
6629: }
1.1313 raeburn 6630:
1.921 bisitz 6631: my $output =
1.1407 raeburn 6632: '<div>'
1.822 bisitz 6633: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6634: .'<b>'.$title.'</b> '
1.1314 raeburn 6635: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6636: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6637:
6638: if ($lastitem) {
6639: $output .=
6640: '<span class="LC_filename">'
6641: .$lastitem
6642: .'</span>';
6643: }
1.1245 raeburn 6644:
1.1246 raeburn 6645: if ($crsauthor) {
1.1379 raeburn 6646: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6647: } else {
6648: $output .=
6649: '<br />'
1.1314 raeburn 6650: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6651: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6652: .'</form>'
1.1379 raeburn 6653: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6654: }
1.1407 raeburn 6655: $output .= '</div>';
1.921 bisitz 6656:
6657: return $output;
1.822 bisitz 6658: }
6659:
1.1419 raeburn 6660: ##############################################
6661: =pod
6662:
6663: =item * &nocodemirror()
6664:
6665: Input: None
6666:
6667: Returns: 1 if CodeMirror is deactivated based on
6668: user's preference, or domain default,
6669: if user indicated use of default.
6670:
6671: =cut
6672:
1.1416 raeburn 6673: sub nocodemirror {
6674: my $nocodem = $env{'environment.nocodemirror'};
6675: unless ($nocodem) {
6676: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6677: if ($domdefs{'nocodemirror'}) {
6678: $nocodem = 'yes';
6679: }
6680: }
1.1417 raeburn 6681: if ($nocodem eq 'yes') {
6682: return 1;
6683: }
6684: return;
1.1416 raeburn 6685: }
6686:
1.1419 raeburn 6687: ##############################################
6688: =pod
6689:
6690: =item * &permitted_editors()
6691:
1.1422 raeburn 6692: Input: $uri (optional)
1.1419 raeburn 6693:
6694: Returns: %editors hash in which keys are editors
1.1429 raeburn 6695: permitted in current Authoring Space,
6696: or in current course for web pages
6697: created in a course.
6698:
1.1419 raeburn 6699: Value for each key is 1. Possible keys
1.1429 raeburn 6700: are: edit, xml, and daxe.
6701:
6702: For a regular Authoring Space, if no specific
1.1419 raeburn 6703: set of editors has been set for the Author
6704: who owns the Authoring Space, then the
6705: domain default will be used. If no domain
6706: default has been set, then the keys will be
6707: edit and xml.
6708:
1.1429 raeburn 6709: For a course author, or for web pages created
6710: in a course, if no specific set of editors has
6711: been set for the course, then the domain
6712: course default will be used. If no domain
6713: course default has been set, then the keys
6714: will be edit and xml.
6715:
1.1419 raeburn 6716: =cut
6717:
1.1418 raeburn 6718: sub permitted_editors {
1.1422 raeburn 6719: my ($uri) = @_;
1.1429 raeburn 6720: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6721: if ($env{'request.role'} =~ m{^au\./}) {
6722: $is_author = 1;
6723: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6724: ($audom,$auname) = ($1,$2);
6725: if (($audom ne '') && ($auname ne '')) {
6726: if (($env{'user.domain'} eq $audom) &&
6727: ($env{'user.name'} eq $auname)) {
6728: $is_author = 1;
6729: } else {
6730: $is_coauthor = 1;
6731: }
6732: }
6733: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6734: my ($cdom,$cnum);
6735: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6736: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6737: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6738: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6739: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6740: $is_course = 1;
6741: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6742: ($audom,$auname) = ($1,$2);
6743: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6744: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6745: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6746: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6747: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6748: $is_course = 1;
6749: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6750: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6751: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6752: }
1.1429 raeburn 6753: unless ($is_course) {
6754: if (($audom ne '') && ($auname ne '')) {
6755: if (($env{'user.domain'} eq $audom) &&
6756: ($env{'user.name'} eq $auname)) {
6757: $is_author = 1;
6758: } else {
6759: $is_coauthor = 1;
6760: }
1.1418 raeburn 6761: }
6762: }
6763: }
6764: if ($is_author) {
6765: if (exists($env{'environment.editors'})) {
6766: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6767: } else {
6768: %editors = ( edit => 1,
6769: xml => 1,
6770: );
6771: }
6772: } elsif ($is_coauthor) {
6773: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6774: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6775: } else {
6776: %editors = ( edit => 1,
6777: xml => 1,
6778: );
6779: }
1.1429 raeburn 6780: } elsif ($is_course) {
6781: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6782: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6783: } else {
6784: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6785: if (exists($domdefaults{'crseditors'})) {
6786: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6787: } else {
6788: %editors = ( edit => 1,
6789: xml => 1,
6790: );
6791: }
6792: }
1.1418 raeburn 6793: } else {
6794: %editors = ( edit => 1,
6795: xml => 1,
6796: );
6797: }
6798: return %editors;
6799: }
6800:
1.60 matthew 6801: ###############################################
6802: ###############################################
6803:
6804: =pod
6805:
1.112 bowersj2 6806: =back
6807:
1.549 albertel 6808: =head1 HTML Helpers
1.112 bowersj2 6809:
6810: =over 4
6811:
6812: =item * &bodytag()
1.60 matthew 6813:
6814: Returns a uniform header for LON-CAPA web pages.
6815:
6816: Inputs:
6817:
1.112 bowersj2 6818: =over 4
6819:
6820: =item * $title, A title to be displayed on the page.
6821:
6822: =item * $function, the current role (can be undef).
6823:
6824: =item * $addentries, extra parameters for the <body> tag.
6825:
6826: =item * $bodyonly, if defined, only return the <body> tag.
6827:
6828: =item * $domain, if defined, force a given domain.
6829:
6830: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6831: text interface only)
1.60 matthew 6832:
1.814 bisitz 6833: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6834: navigational links
1.317 albertel 6835:
1.338 albertel 6836: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6837:
1.460 albertel 6838: =item * $args, optional argument valid values are
6839: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6840: use_absolute -> for external resource or syllabus, this will
6841: contain https://<hostname> if server uses
6842: https (as per hosts.tab), but request is for http
6843: hostname -> hostname, from $r->hostname().
1.460 albertel 6844:
1.1096 raeburn 6845: =item * $advtoolsref, optional argument, ref to an array containing
6846: inlineremote items to be added in "Functions" menu below
6847: breadcrumbs.
6848:
1.1316 raeburn 6849: =item * $ltiscope, optional argument, will be one of: resource, map or
6850: course, if LON-CAPA is in LTI Provider context. Value is
6851: the scope of use, i.e., launch was for access to a single, a map
6852: or the entire course.
6853:
6854: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6855: context, this will contain the URL for the landing item in
6856: the course, after launch from an LTI Consumer
6857:
1.1318 raeburn 6858: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6859: context, this will contain a reference to hash of items
6860: to be included in the page header and/or inline menu.
6861:
1.1385 raeburn 6862: =item * $menucoll, optional argument, if specific menu collection is in
6863: effect, either set as the default for the course, or set for
6864: the deeplink paramater for $env{'request.deeplink.login'}
6865: then $menucoll will be the number of that collection.
6866:
6867: =item * $menuref, optional argument, reference to a hash, containing the
6868: menu options included for the menu in effect, based on the
6869: configuration for the numbered menu collection in use.
6870:
6871: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6872: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6873: if so, $showncrumbsref is set there to 1, and will propagate back
6874: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6875: being called a second time.
6876:
1.112 bowersj2 6877: =back
6878:
1.60 matthew 6879: Returns: A uniform header for LON-CAPA web pages.
6880: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6881: If $bodyonly is undef or zero, an html string containing a <body> tag and
6882: other decorations will be returned.
6883:
6884: =cut
6885:
1.54 www 6886: sub bodytag {
1.831 bisitz 6887: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6888: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6889: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6890:
1.954 raeburn 6891: my $public;
6892: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6893: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6894: $public = 1;
6895: }
1.460 albertel 6896: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6897: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6898: my $hostname = $args->{'hostname'};
1.339 albertel 6899:
1.183 matthew 6900: $function = &get_users_function() if (!$function);
1.339 albertel 6901: my $font = &designparm($function.'.font',$domain);
6902: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6903:
1.803 bisitz 6904: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6905: 'bgcolor' => $pgbg,
1.339 albertel 6906: 'text' => $font,
6907: 'alink' => &designparm($function.'.alink',$domain),
6908: 'vlink' => &designparm($function.'.vlink',$domain),
6909: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6910: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6911:
1.63 www 6912: # role and realm
1.1178 raeburn 6913: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6914: if ($realm) {
6915: $realm = '/'.$realm;
6916: }
1.1357 raeburn 6917: if ($role eq 'ca') {
1.479 albertel 6918: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6919: $realm = &plainname($rname,$rdom);
1.378 raeburn 6920: }
1.55 www 6921: # realm
1.1357 raeburn 6922: my ($cid,$sec);
1.258 albertel 6923: if ($env{'request.course.id'}) {
1.1357 raeburn 6924: $cid = $env{'request.course.id'};
6925: if ($env{'request.course.sec'}) {
6926: $sec = $env{'request.course.sec'};
6927: }
6928: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6929: if (&Apache::lonnet::is_course($1,$2)) {
6930: $cid = $1.'_'.$2;
6931: $sec = $3;
6932: }
6933: }
6934: if ($cid) {
1.378 raeburn 6935: if ($env{'request.role'} !~ /^cr/) {
6936: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6937: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6938: if ($env{'request.role.desc'}) {
6939: $role = $env{'request.role.desc'};
6940: } else {
6941: $role = &mt('Helpdesk[_1]',' '.$2);
6942: }
1.1257 raeburn 6943: } else {
6944: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6945: }
1.1357 raeburn 6946: if ($sec) {
6947: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6948: }
1.1357 raeburn 6949: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6950: } else {
6951: $role = &Apache::lonnet::plaintext($role);
1.54 www 6952: }
1.433 albertel 6953:
1.438 albertel 6954: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6955:
1.101 www 6956: # construct main body tag
1.359 albertel 6957: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6958: &Apache::lontexconvert::init_math_support();
1.252 albertel 6959:
1.1131 raeburn 6960: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6961:
1.1130 raeburn 6962: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6963: return $bodytag;
1.1130 raeburn 6964: }
1.359 albertel 6965:
1.954 raeburn 6966: if ($public) {
1.433 albertel 6967: undef($role);
6968: }
1.1318 raeburn 6969:
1.1359 raeburn 6970: my $showcrstitle = 1;
1.1357 raeburn 6971: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6972: if (ref($ltimenu) eq 'HASH') {
6973: unless ($ltimenu->{'role'}) {
6974: undef($role);
6975: }
6976: unless ($ltimenu->{'coursetitle'}) {
1.1359 raeburn 6977: $showcrstitle = 0;
6978: }
6979: }
6980: } elsif (($cid) && ($menucoll)) {
6981: if (ref($menuref) eq 'HASH') {
6982: unless ($menuref->{'role'}) {
6983: undef($role);
6984: }
6985: unless ($menuref->{'crs'}) {
6986: $showcrstitle = 0;
1.1318 raeburn 6987: }
6988: }
6989: }
6990:
1.762 bisitz 6991: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6992: #
6993: # Extra info if you are the DC
6994: my $dc_info = '';
1.1359 raeburn 6995: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6996: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6997: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6998: $dc_info =~ s/\s+$//;
1.359 albertel 6999: }
7000:
1.1237 raeburn 7001: my $crstype;
1.1357 raeburn 7002: if ($cid) {
7003: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 7004: } elsif ($args->{'crstype'}) {
7005: $crstype = $args->{'crstype'};
7006: }
7007: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
7008: undef($role);
7009: } else {
1.1242 raeburn 7010: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 7011: }
1.853 droeschl 7012:
1.903 droeschl 7013: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
7014:
7015: # if ($env{'request.state'} eq 'construct') {
7016: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
7017: # }
7018:
1.1440 raeburn 7019: my $need_endlcint;
7020: unless ($args->{'switchserver'}) {
7021: $bodytag .= Apache::lonhtmlcommon::scripttag(
7022: Apache::lonmenu::utilityfunctions($httphost), 'start');
7023: $need_endlcint = 1;
7024: }
1.359 albertel 7025:
1.1427 raeburn 7026: my $collapsible;
1.1423 raeburn 7027: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 7028: $collapsible = 1;
7029: my ($menustate,$tiptext,$divclass);
7030: if ($args->{'start_collapsed'}) {
7031: $menustate = 'collapsed';
7032: $tiptext = 'display';
7033: $divclass = 'hidden';
7034: } else {
7035: $menustate = 'expanded';
7036: $tiptext = 'hide';
7037: $divclass = 'shown';
7038: }
7039: my $alttext = &mt('menu state: '.$menustate);
7040: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7041: $bodytag .= <<"END";
1.1461 raeburn 7042: <div id="LC_expandingContainer" style="display:inline;" role="navigation">
1.1421 raeburn 7043: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7044: <a href="#" style="text-decoration:none;"><img class="LC_collapsible_indicator" alt="$alttext" title="$tooltip" src="/res/adm/pages/$menustate.png" style="border:0;margin:0;padding:0;max-width:100%;height:auto" /></a></div>
7045: <div class="LC_menus_content $divclass">
1.1421 raeburn 7046: END
7047: }
1.1318 raeburn 7048: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7049: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7050: $args->{'links_disabled'},
1.1421 raeburn 7051: $args->{'links_target'},
1.1427 raeburn 7052: $collapsible);
1.1454 raeburn 7053: my $labeltext = &HTML::Entities::encode(&mt('Primary links'));
1.1318 raeburn 7054: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7055: if ($dc_info) {
7056: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7057: }
1.1456 raeburn 7058: $bodytag .= qq|<div id="LC_nav_bar" role="navigation" aria-label="$labeltext">$left $role</div>|;
1.1454 raeburn 7059: unless (($realm eq '') && ($dc_info eq '')) {
7060: $bodytag .= qq|<div id="LC_realm" role="complementary"><em>$realm</em> $dc_info</div>|;
7061: }
1.1440 raeburn 7062: if ($need_endlcint) {
7063: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7064: }
1.1318 raeburn 7065: return $bodytag;
7066: }
1.894 droeschl 7067:
1.1457 raeburn 7068: $bodytag .= '<div class="LC_landmark" style="margin: 3px 0 0 0;" role="navigation" aria-label="'.$labeltext.'">';
1.1318 raeburn 7069: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7070: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7071: }
1.916 droeschl 7072:
1.1454 raeburn 7073: $bodytag .= $right.'</div>';
1.852 droeschl 7074:
1.1318 raeburn 7075: if ($dc_info) {
7076: $dc_info = &dc_courseid_toggle($dc_info);
7077: }
1.1454 raeburn 7078: unless (($realm eq '') && ($dc_info eq '')) {
1.1457 raeburn 7079: $bodytag .= qq|<div id="LC_realm" role="complementary">$realm $dc_info</div>|;
1.1454 raeburn 7080: }
1.1457 raeburn 7081: $bodytag .= qq|<div style="clear: both; margin: 5px 0 0 0;"></div>|;
1.917 raeburn 7082: }
1.916 droeschl 7083:
1.1169 raeburn 7084: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7085: if ($args->{'no_secondary_menu'}) {
1.1440 raeburn 7086: if ($need_endlcint) {
7087: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7088: }
1.1168 raeburn 7089: return $bodytag;
7090: }
1.1169 raeburn 7091: #don't show menus for public users
1.954 raeburn 7092: if (!$public){
1.1318 raeburn 7093: unless ($args->{'no_inline_menu'}) {
1.1459 raeburn 7094: $bodytag .= '<div class="LC_landmark" role="navigation" aria-label="Secondary Links">'.
7095: Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7096: $args->{'no_primary_menu'},
1.1369 raeburn 7097: $menucoll,$menuref,
1.1380 raeburn 7098: $args->{'links_disabled'},
1.1459 raeburn 7099: $args->{'links_target'}).
1.1460 raeburn 7100: '</div>';
1.1318 raeburn 7101: }
1.903 droeschl 7102: $bodytag .= Apache::lonmenu::serverform();
1.1440 raeburn 7103: if ($need_endlcint) {
7104: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7105: }
1.920 raeburn 7106: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7107: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7108: $args->{'bread_crumbs'},'','',$hostname,
7109: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7110: } elsif ($forcereg) {
7111: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7112: $args->{'group'},$args->{'hide_buttons'},
7113: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7114: } else {
1.1459 raeburn 7115: $bodytag .=
1.1096 raeburn 7116: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7117: $forcereg,$args->{'group'},
7118: $args->{'bread_crumbs'},
1.1274 raeburn 7119: $advtoolsref,'',$hostname);
1.920 raeburn 7120: }
1.1440 raeburn 7121: } else {
7122: # this is to separate menu from content when there's no secondary
1.1441 raeburn 7123: # menu. Especially needed for publicly accessible resources.
1.1459 raeburn 7124: $bodytag .= '<hr style="clear:both" role="complementary" />';
1.1440 raeburn 7125: if ($need_endlcint) {
7126: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7127: }
1.235 raeburn 7128: }
1.1423 raeburn 7129: if ($args->{'collapsible_header'} ne '') {
7130: $bodytag .= $args->{'collapsible_header'}.
7131: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7132: '</div></div>';
7133: }
1.235 raeburn 7134: return $bodytag;
1.182 matthew 7135: }
7136:
1.917 raeburn 7137: sub dc_courseid_toggle {
7138: my ($dc_info) = @_;
1.980 raeburn 7139: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7140: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7141: &mt('(More ...)').'</a></span>'.
7142: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7143: }
7144:
1.330 albertel 7145: sub make_attr_string {
7146: my ($register,$attr_ref) = @_;
7147:
7148: if ($attr_ref && !ref($attr_ref)) {
7149: die("addentries Must be a hash ref ".
7150: join(':',caller(1))." ".
7151: join(':',caller(0))." ");
7152: }
7153:
7154: if ($register) {
1.339 albertel 7155: my ($on_load,$on_unload);
7156: foreach my $key (keys(%{$attr_ref})) {
7157: if (lc($key) eq 'onload') {
7158: $on_load.=$attr_ref->{$key}.';';
7159: delete($attr_ref->{$key});
7160:
7161: } elsif (lc($key) eq 'onunload') {
7162: $on_unload.=$attr_ref->{$key}.';';
7163: delete($attr_ref->{$key});
7164: }
7165: }
1.953 droeschl 7166: $attr_ref->{'onload'} = $on_load;
7167: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7168: }
1.339 albertel 7169:
1.330 albertel 7170: my $attr_string;
1.1159 raeburn 7171: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7172: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7173: }
7174: return $attr_string;
7175: }
7176:
7177:
1.182 matthew 7178: ###############################################
1.251 albertel 7179: ###############################################
7180:
7181: =pod
7182:
7183: =item * &endbodytag()
7184:
7185: Returns a uniform footer for LON-CAPA web pages.
7186:
1.635 raeburn 7187: Inputs: 1 - optional reference to an args hash
7188: If in the hash, key for noredirectlink has a value which evaluates to true,
7189: a 'Continue' link is not displayed if the page contains an
7190: internal redirect in the <head></head> section,
7191: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7192:
7193: =cut
7194:
7195: sub endbodytag {
1.635 raeburn 7196: my ($args) = @_;
1.1080 raeburn 7197: my $endbodytag;
7198: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7199: $endbodytag='</body>';
7200: }
1.315 albertel 7201: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7202: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7203: my ($endbodyjs,$idattr);
7204: if ($env{'internal.head.to_opener'}) {
7205: my $linkid = 'LC_continue_link';
7206: $idattr = ' id="'.$linkid.'"';
7207: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7208: $endbodyjs=<<ENDJS;
7209: <script type="text/javascript">
7210: // <![CDATA[
7211: function ebFunction(evt) {
7212: evt.preventDefault();
7213: var dest = '$redirect_for_js';
7214: if (window.opener != null && !window.opener.closed) {
7215: window.opener.location.href=dest;
7216: window.close();
7217: } else {
7218: window.location.href=dest;
7219: }
7220: return false;
7221: }
7222:
7223: \$(document).ready(function () {
7224: if (document.getElementById('$linkid')) {
7225: var clickelem = document.getElementById('$linkid');
7226: clickelem.addEventListener('click',ebFunction,false);
7227: }
7228: });
7229: // ]]>
7230: </script>
7231: ENDJS
7232: }
1.635 raeburn 7233: $endbodytag=
1.1386 raeburn 7234: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7235: &mt('Continue').'</a>'.
7236: $endbodytag;
7237: }
1.315 albertel 7238: }
1.1411 raeburn 7239: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7240: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7241: }
1.251 albertel 7242: return $endbodytag;
7243: }
7244:
1.352 albertel 7245: =pod
7246:
7247: =item * &standard_css()
7248:
7249: Returns a style sheet
7250:
7251: Inputs: (all optional)
7252: domain -> force to color decorate a page for a specific
7253: domain
7254: function -> force usage of a specific rolish color scheme
7255: bgcolor -> override the default page bgcolor
7256:
7257: =cut
7258:
1.343 albertel 7259: sub standard_css {
1.345 albertel 7260: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7261: $function = &get_users_function() if (!$function);
7262: my $tabbg = &designparm($function.'.tabbg', $domain);
7263: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7264: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7265: #second colour for later usage
1.345 albertel 7266: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7267: my $pgbg_or_bgcolor =
7268: $bgcolor ||
1.352 albertel 7269: &designparm($function.'.pgbg', $domain);
1.382 albertel 7270: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7271: my $alink = &designparm($function.'.alink', $domain);
7272: my $vlink = &designparm($function.'.vlink', $domain);
7273: my $link = &designparm($function.'.link', $domain);
7274:
1.602 albertel 7275: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7276: my $mono = 'monospace';
1.850 bisitz 7277: my $data_table_head = $sidebg;
7278: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7279: my $data_table_dark = '#E0E0E0';
1.470 banghart 7280: my $data_table_darker = '#CCCCCC';
1.349 albertel 7281: my $data_table_highlight = '#FFFF00';
1.352 albertel 7282: my $mail_new = '#FFBB77';
7283: my $mail_new_hover = '#DD9955';
7284: my $mail_read = '#BBBB77';
7285: my $mail_read_hover = '#999944';
7286: my $mail_replied = '#AAAA88';
7287: my $mail_replied_hover = '#888855';
7288: my $mail_other = '#99BBBB';
7289: my $mail_other_hover = '#669999';
1.391 albertel 7290: my $table_header = '#DDDDDD';
1.489 raeburn 7291: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7292: my $lg_border_color = '#C8C8C8';
1.952 onken 7293: my $button_hover = '#BF2317';
1.392 albertel 7294:
1.608 albertel 7295: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7296: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7297: : '0 3px 0 4px';
1.448 albertel 7298:
1.523 albertel 7299:
1.343 albertel 7300: return <<END;
1.947 droeschl 7301:
7302: /* needed for iframe to allow 100% height in FF */
7303: body, html {
7304: margin: 0;
7305: padding: 0 0.5%;
7306: height: 99%; /* to avoid scrollbars */
7307: }
7308:
1.795 www 7309: body {
1.911 bisitz 7310: font-family: $sans;
7311: line-height:130%;
7312: font-size:0.83em;
7313: color:$font;
1.1436 raeburn 7314: background-color: $pgbg_or_bgcolor;
1.795 www 7315: }
7316:
1.959 onken 7317: a:focus,
7318: a:focus img {
1.795 www 7319: color: red;
7320: }
1.698 harmsja 7321:
1.911 bisitz 7322: form, .inline {
7323: display: inline;
1.795 www 7324: }
1.721 harmsja 7325:
1.1453 raeburn 7326: .LC_landmark {
7327: margin: 0;
7328: padding: 0;
7329: border: none;
7330: }
7331:
1.1443 raeburn 7332: .LC_visually_hidden:not(:focus):not(:active) {
7333: clip-path: inset(50%);
7334: height: 1px;
7335: overflow: hidden;
7336: position: absolute;
7337: white-space: nowrap;
7338: width: 1px;
7339: display: inline;
7340: }
7341:
1.1453 raeburn 7342: .LC_heading_2 {
7343: font-size: 1.17em;
7344: }
7345:
1.1458 raeburn 7346: .LC_heading_3 {
7347: font-size: 1.0em;
7348: }
7349:
1.1421 raeburn 7350: .LC_menus_content.shown{
1.1428 raeburn 7351: display: block;
1.1421 raeburn 7352: }
7353:
7354: .LC_menus_content.hidden {
7355: display: none;
7356: }
7357:
1.795 www 7358: .LC_right {
1.911 bisitz 7359: text-align:right;
1.795 www 7360: }
7361:
1.1449 raeburn 7362: .LC_center {
7363: text-align:center;
7364: }
7365:
1.795 www 7366: .LC_middle {
1.911 bisitz 7367: vertical-align:middle;
1.795 www 7368: }
1.721 harmsja 7369:
1.1130 raeburn 7370: .LC_floatleft {
7371: float: left;
7372: }
7373:
7374: .LC_floatright {
7375: float: right;
7376: }
7377:
1.911 bisitz 7378: .LC_400Box {
7379: width:400px;
7380: }
1.721 harmsja 7381:
1.1421 raeburn 7382: #LC_collapsible_separator {
7383: border: 1px solid black;
7384: width: 99.9%;
7385: height: 0px;
7386: }
7387:
1.947 droeschl 7388: .LC_iframecontainer {
7389: width: 98%;
7390: margin: 0;
7391: position: fixed;
7392: top: 8.5em;
7393: bottom: 0;
7394: }
7395:
7396: .LC_iframecontainer iframe{
7397: border: none;
7398: width: 100%;
7399: height: 100%;
7400: }
7401:
1.778 bisitz 7402: .LC_filename {
7403: font-family: $mono;
7404: white-space:pre;
1.921 bisitz 7405: font-size: 120%;
1.778 bisitz 7406: }
7407:
7408: .LC_fileicon {
7409: border: none;
7410: height: 1.3em;
7411: vertical-align: text-bottom;
7412: margin-right: 0.3em;
7413: text-decoration:none;
7414: }
7415:
1.1008 www 7416: .LC_setting {
7417: text-decoration:underline;
7418: }
7419:
1.350 albertel 7420: .LC_error {
7421: color: red;
7422: }
1.795 www 7423:
1.1097 bisitz 7424: .LC_warning {
7425: color: darkorange;
7426: }
7427:
1.457 albertel 7428: .LC_diff_removed {
1.733 bisitz 7429: color: red;
1.394 albertel 7430: }
1.532 albertel 7431:
7432: .LC_info,
1.457 albertel 7433: .LC_success,
7434: .LC_diff_added {
1.350 albertel 7435: color: green;
7436: }
1.795 www 7437:
1.802 bisitz 7438: div.LC_confirm_box {
7439: background-color: #FAFAFA;
7440: border: 1px solid $lg_border_color;
7441: margin-right: 0;
7442: padding: 5px;
7443: }
7444:
7445: div.LC_confirm_box .LC_error img,
7446: div.LC_confirm_box .LC_success img {
7447: vertical-align: middle;
7448: }
7449:
1.1242 raeburn 7450: .LC_maxwidth {
7451: max-width: 100%;
7452: height: auto;
7453: }
7454:
1.1243 raeburn 7455: .LC_textsize_mobile {
7456: \@media only screen and (max-device-width: 480px) {
7457: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7458: }
7459: }
7460:
1.440 albertel 7461: .LC_icon {
1.771 droeschl 7462: border: none;
1.790 droeschl 7463: vertical-align: middle;
1.771 droeschl 7464: }
7465:
1.543 albertel 7466: .LC_docs_spacer {
7467: width: 25px;
7468: height: 1px;
1.771 droeschl 7469: border: none;
1.543 albertel 7470: }
1.346 albertel 7471:
1.532 albertel 7472: .LC_internal_info {
1.735 bisitz 7473: color: #999999;
1.532 albertel 7474: }
7475:
1.794 www 7476: .LC_discussion {
1.1050 www 7477: background: $data_table_dark;
1.911 bisitz 7478: border: 1px solid black;
7479: margin: 2px;
1.794 www 7480: }
7481:
7482: .LC_disc_action_left {
1.1050 www 7483: background: $sidebg;
1.911 bisitz 7484: text-align: left;
1.1050 www 7485: padding: 4px;
7486: margin: 2px;
1.794 www 7487: }
7488:
7489: .LC_disc_action_right {
1.1050 www 7490: background: $sidebg;
1.911 bisitz 7491: text-align: right;
1.1050 www 7492: padding: 4px;
7493: margin: 2px;
1.794 www 7494: }
7495:
7496: .LC_disc_new_item {
1.911 bisitz 7497: background: white;
7498: border: 2px solid red;
1.1050 www 7499: margin: 4px;
7500: padding: 4px;
1.794 www 7501: }
7502:
7503: .LC_disc_old_item {
1.911 bisitz 7504: background: white;
1.1050 www 7505: margin: 4px;
7506: padding: 4px;
1.794 www 7507: }
7508:
1.1468 ! raeburn 7509: .LC_pastsubmission {
1.458 albertel 7510: border: 1px solid black;
7511: margin: 2px;
1.1468 ! raeburn 7512: padding: 2px;
1.458 albertel 7513: }
7514:
1.924 bisitz 7515: table#LC_menubuttons {
1.345 albertel 7516: width: 100%;
7517: background: $pgbg;
1.392 albertel 7518: border: 2px;
1.402 albertel 7519: border-collapse: separate;
1.803 bisitz 7520: padding: 0;
1.345 albertel 7521: }
1.392 albertel 7522:
1.801 tempelho 7523: table#LC_title_bar a {
7524: color: $fontmenu;
7525: }
1.836 bisitz 7526:
1.807 droeschl 7527: table#LC_title_bar {
1.819 tempelho 7528: clear: both;
1.836 bisitz 7529: display: none;
1.807 droeschl 7530: }
7531:
1.795 www 7532: table#LC_title_bar,
1.933 droeschl 7533: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7534: table#LC_title_bar.LC_with_remote {
1.359 albertel 7535: width: 100%;
1.392 albertel 7536: border-color: $pgbg;
7537: border-style: solid;
7538: border-width: $border;
1.379 albertel 7539: background: $pgbg;
1.801 tempelho 7540: color: $fontmenu;
1.392 albertel 7541: border-collapse: collapse;
1.803 bisitz 7542: padding: 0;
1.819 tempelho 7543: margin: 0;
1.359 albertel 7544: }
1.795 www 7545:
1.933 droeschl 7546: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7547: margin: 0;
7548: padding: 0;
1.933 droeschl 7549: position: relative;
7550: list-style: none;
1.913 droeschl 7551: }
1.933 droeschl 7552: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7553: display: inline;
7554: }
1.933 droeschl 7555:
7556: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7557: padding: 0;
1.933 droeschl 7558: margin: 0;
7559: float: left;
1.913 droeschl 7560: }
1.933 droeschl 7561: .LC_breadcrumb_tools_tools {
7562: padding: 0;
7563: margin: 0;
1.913 droeschl 7564: float: right;
7565: }
7566:
1.1240 raeburn 7567: .LC_placement_prog {
7568: padding-right: 20px;
7569: font-weight: bold;
7570: font-size: 90%;
7571: }
7572:
1.359 albertel 7573: table#LC_title_bar td {
7574: background: $tabbg;
7575: }
1.795 www 7576:
1.911 bisitz 7577: table#LC_menubuttons img {
1.803 bisitz 7578: border: none;
1.346 albertel 7579: }
1.795 www 7580:
1.842 droeschl 7581: .LC_breadcrumbs_component {
1.911 bisitz 7582: float: right;
7583: margin: 0 1em;
1.357 albertel 7584: }
1.842 droeschl 7585: .LC_breadcrumbs_component img {
1.911 bisitz 7586: vertical-align: middle;
1.777 tempelho 7587: }
1.795 www 7588:
1.1243 raeburn 7589: .LC_breadcrumbs_hoverable {
7590: background: $sidebg;
7591: }
7592:
1.383 albertel 7593: td.LC_table_cell_checkbox {
7594: text-align: center;
7595: }
1.795 www 7596:
7597: .LC_fontsize_small {
1.911 bisitz 7598: font-size: 70%;
1.705 tempelho 7599: }
7600:
1.844 bisitz 7601: #LC_breadcrumbs {
1.911 bisitz 7602: clear:both;
7603: background: $sidebg;
7604: border-bottom: 1px solid $lg_border_color;
7605: line-height: 2.5em;
1.933 droeschl 7606: overflow: hidden;
1.911 bisitz 7607: margin: 0;
7608: padding: 0;
1.995 raeburn 7609: text-align: left;
1.819 tempelho 7610: }
1.862 bisitz 7611:
1.1098 bisitz 7612: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7613: clear:both;
7614: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7615: border: 1px solid $sidebg;
1.1098 bisitz 7616: margin: 0 0 10px 0;
1.966 bisitz 7617: padding: 3px;
1.995 raeburn 7618: text-align: left;
1.822 bisitz 7619: }
7620:
1.795 www 7621: .LC_fontsize_medium {
1.911 bisitz 7622: font-size: 85%;
1.705 tempelho 7623: }
7624:
1.795 www 7625: .LC_fontsize_large {
1.911 bisitz 7626: font-size: 120%;
1.705 tempelho 7627: }
7628:
1.346 albertel 7629: .LC_menubuttons_inline_text {
7630: color: $font;
1.698 harmsja 7631: font-size: 90%;
1.701 harmsja 7632: padding-left:3px;
1.346 albertel 7633: }
7634:
1.934 droeschl 7635: .LC_menubuttons_inline_text img{
7636: vertical-align: middle;
7637: }
7638:
1.1051 www 7639: li.LC_menubuttons_inline_text img {
1.951 onken 7640: cursor:pointer;
1.1002 droeschl 7641: text-decoration: none;
1.951 onken 7642: }
7643:
1.526 www 7644: .LC_menubuttons_link {
7645: text-decoration: none;
7646: }
1.795 www 7647:
1.522 albertel 7648: .LC_menubuttons_category {
1.521 www 7649: color: $font;
1.526 www 7650: background: $pgbg;
1.521 www 7651: font-size: larger;
7652: font-weight: bold;
7653: }
7654:
1.346 albertel 7655: td.LC_menubuttons_text {
1.911 bisitz 7656: color: $font;
1.346 albertel 7657: }
1.706 harmsja 7658:
1.346 albertel 7659: .LC_current_location {
7660: background: $tabbg;
7661: }
1.795 www 7662:
1.1286 raeburn 7663: td.LC_zero_height {
7664: line-height: 0;
7665: cellpadding: 0;
7666: }
7667:
1.938 bisitz 7668: table.LC_data_table {
1.347 albertel 7669: border: 1px solid #000000;
1.402 albertel 7670: border-collapse: separate;
1.426 albertel 7671: border-spacing: 1px;
1.610 albertel 7672: background: $pgbg;
1.347 albertel 7673: }
1.795 www 7674:
1.422 albertel 7675: .LC_data_table_dense {
7676: font-size: small;
7677: }
1.795 www 7678:
1.507 raeburn 7679: table.LC_nested_outer {
7680: border: 1px solid #000000;
1.589 raeburn 7681: border-collapse: collapse;
1.803 bisitz 7682: border-spacing: 0;
1.507 raeburn 7683: width: 100%;
7684: }
1.795 www 7685:
1.879 raeburn 7686: table.LC_innerpickbox,
1.507 raeburn 7687: table.LC_nested {
1.803 bisitz 7688: border: none;
1.589 raeburn 7689: border-collapse: collapse;
1.803 bisitz 7690: border-spacing: 0;
1.507 raeburn 7691: width: 100%;
7692: }
1.795 www 7693:
1.911 bisitz 7694: table.LC_data_table tr th,
7695: table.LC_calendar tr th,
1.879 raeburn 7696: table.LC_prior_tries tr th,
7697: table.LC_innerpickbox tr th {
1.349 albertel 7698: font-weight: bold;
7699: background-color: $data_table_head;
1.801 tempelho 7700: color:$fontmenu;
1.701 harmsja 7701: font-size:90%;
1.347 albertel 7702: }
1.795 www 7703:
1.879 raeburn 7704: table.LC_innerpickbox tr th,
7705: table.LC_innerpickbox tr td {
7706: vertical-align: top;
7707: }
7708:
1.711 raeburn 7709: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7710: background-color: #CCCCCC;
1.711 raeburn 7711: font-weight: bold;
7712: text-align: left;
7713: }
1.795 www 7714:
1.912 bisitz 7715: table.LC_data_table tr.LC_odd_row > td {
7716: background-color: $data_table_light;
7717: padding: 2px;
7718: vertical-align: top;
7719: }
7720:
1.809 bisitz 7721: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7722: background-color: $data_table_light;
1.912 bisitz 7723: vertical-align: top;
7724: }
7725:
7726: table.LC_data_table tr.LC_even_row > td {
7727: background-color: $data_table_dark;
1.425 albertel 7728: padding: 2px;
1.900 bisitz 7729: vertical-align: top;
1.347 albertel 7730: }
1.795 www 7731:
1.809 bisitz 7732: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7733: background-color: $data_table_dark;
1.900 bisitz 7734: vertical-align: top;
1.347 albertel 7735: }
1.795 www 7736:
1.425 albertel 7737: table.LC_data_table tr.LC_data_table_highlight td {
7738: background-color: $data_table_darker;
7739: }
1.795 www 7740:
1.639 raeburn 7741: table.LC_data_table tr td.LC_leftcol_header {
7742: background-color: $data_table_head;
7743: font-weight: bold;
7744: }
1.795 www 7745:
1.451 albertel 7746: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7747: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7748: font-weight: bold;
7749: font-style: italic;
7750: text-align: center;
7751: padding: 8px;
1.347 albertel 7752: }
1.795 www 7753:
1.1114 raeburn 7754: table.LC_data_table tr.LC_empty_row td,
7755: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7756: background-color: $sidebg;
7757: }
7758:
7759: table.LC_nested tr.LC_empty_row td {
7760: background-color: #FFFFFF;
7761: }
7762:
1.890 droeschl 7763: table.LC_caption {
7764: }
7765:
1.507 raeburn 7766: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7767: padding: 4ex
7768: }
1.795 www 7769:
1.507 raeburn 7770: table.LC_nested_outer tr th {
7771: font-weight: bold;
1.801 tempelho 7772: color:$fontmenu;
1.507 raeburn 7773: background-color: $data_table_head;
1.701 harmsja 7774: font-size: small;
1.507 raeburn 7775: border-bottom: 1px solid #000000;
7776: }
1.795 www 7777:
1.507 raeburn 7778: table.LC_nested_outer tr td.LC_subheader {
7779: background-color: $data_table_head;
7780: font-weight: bold;
7781: font-size: small;
7782: border-bottom: 1px solid #000000;
7783: text-align: right;
1.451 albertel 7784: }
1.795 www 7785:
1.507 raeburn 7786: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7787: background-color: #CCCCCC;
1.451 albertel 7788: font-weight: bold;
7789: font-size: small;
1.507 raeburn 7790: text-align: center;
7791: }
1.795 www 7792:
1.589 raeburn 7793: table.LC_nested tr.LC_info_row td.LC_left_item,
7794: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7795: text-align: left;
1.451 albertel 7796: }
1.795 www 7797:
1.507 raeburn 7798: table.LC_nested td {
1.735 bisitz 7799: background-color: #FFFFFF;
1.451 albertel 7800: font-size: small;
1.507 raeburn 7801: }
1.795 www 7802:
1.507 raeburn 7803: table.LC_nested_outer tr th.LC_right_item,
7804: table.LC_nested tr.LC_info_row td.LC_right_item,
7805: table.LC_nested tr.LC_odd_row td.LC_right_item,
7806: table.LC_nested tr td.LC_right_item {
1.451 albertel 7807: text-align: right;
7808: }
7809:
1.507 raeburn 7810: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7811: background-color: #EEEEEE;
1.451 albertel 7812: }
7813:
1.473 raeburn 7814: table.LC_createuser {
7815: }
7816:
7817: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7818: font-size: small;
1.473 raeburn 7819: }
7820:
7821: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7822: background-color: #CCCCCC;
1.473 raeburn 7823: font-weight: bold;
7824: text-align: center;
7825: }
7826:
1.349 albertel 7827: table.LC_calendar {
7828: border: 1px solid #000000;
7829: border-collapse: collapse;
1.917 raeburn 7830: width: 98%;
1.349 albertel 7831: }
1.795 www 7832:
1.349 albertel 7833: table.LC_calendar_pickdate {
7834: font-size: xx-small;
7835: }
1.795 www 7836:
1.349 albertel 7837: table.LC_calendar tr td {
7838: border: 1px solid #000000;
7839: vertical-align: top;
1.917 raeburn 7840: width: 14%;
1.349 albertel 7841: }
1.795 www 7842:
1.349 albertel 7843: table.LC_calendar tr td.LC_calendar_day_empty {
7844: background-color: $data_table_dark;
7845: }
1.795 www 7846:
1.779 bisitz 7847: table.LC_calendar tr td.LC_calendar_day_current {
7848: background-color: $data_table_highlight;
1.777 tempelho 7849: }
1.795 www 7850:
1.938 bisitz 7851: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7852: background-color: $mail_new;
7853: }
1.795 www 7854:
1.938 bisitz 7855: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7856: background-color: $mail_new_hover;
7857: }
1.795 www 7858:
1.938 bisitz 7859: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7860: background-color: $mail_read;
7861: }
1.795 www 7862:
1.938 bisitz 7863: /*
7864: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7865: background-color: $mail_read_hover;
7866: }
1.938 bisitz 7867: */
1.795 www 7868:
1.938 bisitz 7869: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7870: background-color: $mail_replied;
7871: }
1.795 www 7872:
1.938 bisitz 7873: /*
7874: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7875: background-color: $mail_replied_hover;
7876: }
1.938 bisitz 7877: */
1.795 www 7878:
1.938 bisitz 7879: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7880: background-color: $mail_other;
7881: }
1.795 www 7882:
1.938 bisitz 7883: /*
7884: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7885: background-color: $mail_other_hover;
7886: }
1.938 bisitz 7887: */
1.494 raeburn 7888:
1.777 tempelho 7889: table.LC_data_table tr > td.LC_browser_file,
7890: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7891: background: #AAEE77;
1.389 albertel 7892: }
1.795 www 7893:
1.777 tempelho 7894: table.LC_data_table tr > td.LC_browser_file_locked,
7895: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7896: background: #FFAA99;
1.387 albertel 7897: }
1.795 www 7898:
1.777 tempelho 7899: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7900: background: #888888;
1.779 bisitz 7901: }
1.795 www 7902:
1.777 tempelho 7903: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7904: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7905: background: #F8F866;
1.777 tempelho 7906: }
1.795 www 7907:
1.696 bisitz 7908: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7909: background: #E0E8FF;
1.387 albertel 7910: }
1.696 bisitz 7911:
1.707 bisitz 7912: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7913: /* background: #77FF77; */
1.707 bisitz 7914: }
1.795 www 7915:
1.707 bisitz 7916: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7917: border-right: 8px solid #FFFF77;
1.707 bisitz 7918: }
1.795 www 7919:
1.707 bisitz 7920: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7921: border-right: 8px solid #FFAA77;
1.707 bisitz 7922: }
1.795 www 7923:
1.707 bisitz 7924: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7925: border-right: 8px solid #FF7777;
1.707 bisitz 7926: }
1.795 www 7927:
1.707 bisitz 7928: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7929: border-right: 8px solid #AAFF77;
1.707 bisitz 7930: }
1.795 www 7931:
1.707 bisitz 7932: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7933: border-right: 8px solid #11CC55;
1.707 bisitz 7934: }
7935:
1.388 albertel 7936: span.LC_current_location {
1.701 harmsja 7937: font-size:larger;
1.388 albertel 7938: background: $pgbg;
7939: }
1.387 albertel 7940:
1.1029 www 7941: span.LC_current_nav_location {
7942: font-weight:bold;
7943: background: $sidebg;
7944: }
7945:
1.395 albertel 7946: span.LC_parm_menu_item {
7947: font-size: larger;
7948: }
1.795 www 7949:
1.395 albertel 7950: span.LC_parm_scope_all {
7951: color: red;
7952: }
1.795 www 7953:
1.395 albertel 7954: span.LC_parm_scope_folder {
7955: color: green;
7956: }
1.795 www 7957:
1.395 albertel 7958: span.LC_parm_scope_resource {
7959: color: orange;
7960: }
1.795 www 7961:
1.395 albertel 7962: span.LC_parm_part {
7963: color: blue;
7964: }
1.795 www 7965:
1.911 bisitz 7966: span.LC_parm_folder,
7967: span.LC_parm_symb {
1.395 albertel 7968: font-size: x-small;
7969: font-family: $mono;
7970: color: #AAAAAA;
7971: }
7972:
1.977 bisitz 7973: ul.LC_parm_parmlist li {
7974: display: inline-block;
7975: padding: 0.3em 0.8em;
7976: vertical-align: top;
7977: width: 150px;
7978: border-top:1px solid $lg_border_color;
7979: }
7980:
1.795 www 7981: td.LC_parm_overview_level_menu,
7982: td.LC_parm_overview_map_menu,
7983: td.LC_parm_overview_parm_selectors,
7984: td.LC_parm_overview_restrictions {
1.396 albertel 7985: border: 1px solid black;
7986: border-collapse: collapse;
7987: }
1.795 www 7988:
1.1285 raeburn 7989: span.LC_parm_recursive,
7990: td.LC_parm_recursive {
7991: font-weight: bold;
7992: font-size: smaller;
7993: }
7994:
1.396 albertel 7995: table.LC_parm_overview_restrictions td {
7996: border-width: 1px 4px 1px 4px;
7997: border-style: solid;
7998: border-color: $pgbg;
7999: text-align: center;
8000: }
1.795 www 8001:
1.396 albertel 8002: table.LC_parm_overview_restrictions th {
8003: background: $tabbg;
8004: border-width: 1px 4px 1px 4px;
8005: border-style: solid;
8006: border-color: $pgbg;
8007: }
1.795 www 8008:
1.1459 raeburn 8009: h1.LC_helpmenu {
8010: display: inline;
8011: font-size: 100%;
8012: font-weight: normal;
8013: line-height: 1em;
8014: margin: 0;
8015: padding: 0;
8016: border: 0;
1.398 albertel 8017: }
1.795 www 8018:
1.1456 raeburn 8019: .LC_helpdesk_headbox {
8020: border: 2px groove threedface;
8021: padding: 1em;
8022: }
8023:
8024: h1.LC_helpdesk_legend {
8025: float: left;
8026: margin: -1.7em 0 0;
8027: padding: 0 .5em;
1.397 albertel 8028: background: $pgbg;
1.1456 raeburn 8029: font-size: 1em;
8030: font-weight: bold;
8031: }
8032:
8033: h1.LC_helpdesk_title {
8034: display: inline;
8035: font-size: 1em;
8036: line-height: 2.5em;
8037: margin: 0;
1.803 bisitz 8038: padding: 0;
1.1456 raeburn 8039: vertical-align: bottom;
1.397 albertel 8040: }
1.795 www 8041:
1.1456 raeburn 8042: .LC_helpdesk_links {
8043: border: 1px solid black;
8044: padding: 3px;
1.397 albertel 8045: background: $tabbg;
1.399 albertel 8046: text-align: center;
8047: font-weight: bold;
1.1456 raeburn 8048: display: inline;
8049: margin-right: -6px;
8050: }
8051:
8052: .LC_helpdesk_img,
8053: .LC_helpdesk_text {
8054: padding: 0;
8055: margin: 0;
8056: border: 0;
8057: display: inline;
1.397 albertel 8058: }
1.396 albertel 8059:
1.1456 raeburn 8060: .LC_helpdesk_img a:link,
8061: .LC_helpdesk_img a:visited,
8062: .LC_helpdesk_img a:active,
8063: .LC_helpdesk_text a:link,
8064: .LC_helpdesk_text a:visited,
8065: .LC_helpdesk_text a:active {
1.397 albertel 8066: text-decoration: none;
8067: color: $font;
8068: }
1.795 www 8069:
1.1456 raeburn 8070: div.LC_helpdesk_text a:hover {
1.397 albertel 8071: text-decoration: underline;
8072: color: $vlink;
8073: }
1.396 albertel 8074:
1.417 albertel 8075: .LC_chrt_popup_exists {
8076: border: 1px solid #339933;
8077: margin: -1px;
8078: }
1.795 www 8079:
1.417 albertel 8080: .LC_chrt_popup_up {
8081: border: 1px solid yellow;
8082: margin: -1px;
8083: }
1.795 www 8084:
1.417 albertel 8085: .LC_chrt_popup {
8086: border: 1px solid #8888FF;
8087: background: #CCCCFF;
8088: }
1.795 www 8089:
1.421 albertel 8090: table.LC_pick_box {
8091: border-collapse: separate;
8092: background: white;
8093: border: 1px solid black;
8094: border-spacing: 1px;
8095: }
1.795 www 8096:
1.1454 raeburn 8097: table.LC_pick_box th.LC_pick_box_title {
1.850 bisitz 8098: background: $sidebg;
1.421 albertel 8099: font-weight: bold;
1.900 bisitz 8100: text-align: left;
1.740 bisitz 8101: vertical-align: top;
1.421 albertel 8102: width: 184px;
8103: padding: 8px;
8104: }
1.795 www 8105:
1.579 raeburn 8106: table.LC_pick_box td.LC_pick_box_value {
8107: text-align: left;
8108: padding: 8px;
8109: }
1.795 www 8110:
1.579 raeburn 8111: table.LC_pick_box td.LC_pick_box_select {
8112: text-align: left;
8113: padding: 8px;
8114: }
1.795 www 8115:
1.424 albertel 8116: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8117: padding: 0;
1.421 albertel 8118: height: 1px;
8119: background: black;
8120: }
1.795 www 8121:
1.421 albertel 8122: table.LC_pick_box td.LC_pick_box_submit {
8123: text-align: right;
8124: }
1.795 www 8125:
1.579 raeburn 8126: table.LC_pick_box td.LC_evenrow_value {
8127: text-align: left;
8128: padding: 8px;
8129: background-color: $data_table_light;
8130: }
1.795 www 8131:
1.579 raeburn 8132: table.LC_pick_box td.LC_oddrow_value {
8133: text-align: left;
8134: padding: 8px;
8135: background-color: $data_table_light;
8136: }
1.795 www 8137:
1.579 raeburn 8138: span.LC_helpform_receipt_cat {
8139: font-weight: bold;
8140: }
1.795 www 8141:
1.424 albertel 8142: table.LC_group_priv_box {
8143: background: white;
8144: border: 1px solid black;
8145: border-spacing: 1px;
8146: }
1.795 www 8147:
1.424 albertel 8148: table.LC_group_priv_box td.LC_pick_box_title {
8149: background: $tabbg;
8150: font-weight: bold;
8151: text-align: right;
8152: width: 184px;
8153: }
1.795 www 8154:
1.424 albertel 8155: table.LC_group_priv_box td.LC_groups_fixed {
8156: background: $data_table_light;
8157: text-align: center;
8158: }
1.795 www 8159:
1.424 albertel 8160: table.LC_group_priv_box td.LC_groups_optional {
8161: background: $data_table_dark;
8162: text-align: center;
8163: }
1.795 www 8164:
1.424 albertel 8165: table.LC_group_priv_box td.LC_groups_functionality {
8166: background: $data_table_darker;
8167: text-align: center;
8168: font-weight: bold;
8169: }
1.795 www 8170:
1.424 albertel 8171: table.LC_group_priv td {
8172: text-align: left;
1.803 bisitz 8173: padding: 0;
1.424 albertel 8174: }
8175:
8176: .LC_navbuttons {
8177: margin: 2ex 0ex 2ex 0ex;
8178: }
1.795 www 8179:
1.423 albertel 8180: .LC_topic_bar {
8181: font-weight: bold;
8182: background: $tabbg;
1.918 wenzelju 8183: margin: 1em 0em 1em 2em;
1.805 bisitz 8184: padding: 3px;
1.918 wenzelju 8185: font-size: 1.2em;
1.423 albertel 8186: }
1.795 www 8187:
1.423 albertel 8188: .LC_topic_bar span {
1.918 wenzelju 8189: left: 0.5em;
8190: position: absolute;
1.423 albertel 8191: vertical-align: middle;
1.918 wenzelju 8192: font-size: 1.2em;
1.423 albertel 8193: }
1.795 www 8194:
1.423 albertel 8195: table.LC_course_group_status {
8196: margin: 20px;
8197: }
1.795 www 8198:
1.423 albertel 8199: table.LC_status_selector td {
8200: vertical-align: top;
8201: text-align: center;
1.424 albertel 8202: padding: 4px;
8203: }
1.795 www 8204:
1.599 albertel 8205: div.LC_feedback_link {
1.616 albertel 8206: clear: both;
1.829 kalberla 8207: background: $sidebg;
1.779 bisitz 8208: width: 100%;
1.829 kalberla 8209: padding-bottom: 10px;
8210: border: 1px $tabbg solid;
1.833 kalberla 8211: height: 22px;
8212: line-height: 22px;
8213: padding-top: 5px;
8214: }
8215:
8216: div.LC_feedback_link img {
8217: height: 22px;
1.867 kalberla 8218: vertical-align:middle;
1.829 kalberla 8219: }
8220:
1.911 bisitz 8221: div.LC_feedback_link a {
1.829 kalberla 8222: text-decoration: none;
1.489 raeburn 8223: }
1.795 www 8224:
1.867 kalberla 8225: div.LC_comblock {
1.911 bisitz 8226: display:inline;
1.867 kalberla 8227: color:$font;
8228: font-size:90%;
8229: }
8230:
8231: div.LC_feedback_link div.LC_comblock {
8232: padding-left:5px;
8233: }
8234:
8235: div.LC_feedback_link div.LC_comblock a {
8236: color:$font;
8237: }
8238:
1.489 raeburn 8239: span.LC_feedback_link {
1.858 bisitz 8240: /* background: $feedback_link_bg; */
1.599 albertel 8241: font-size: larger;
8242: }
1.795 www 8243:
1.599 albertel 8244: span.LC_message_link {
1.858 bisitz 8245: /* background: $feedback_link_bg; */
1.599 albertel 8246: font-size: larger;
8247: position: absolute;
8248: right: 1em;
1.489 raeburn 8249: }
1.421 albertel 8250:
1.515 albertel 8251: table.LC_prior_tries {
1.524 albertel 8252: border: 1px solid #000000;
8253: border-collapse: separate;
8254: border-spacing: 1px;
1.515 albertel 8255: }
1.523 albertel 8256:
1.515 albertel 8257: table.LC_prior_tries td {
1.524 albertel 8258: padding: 2px;
1.515 albertel 8259: }
1.523 albertel 8260:
8261: .LC_answer_correct {
1.795 www 8262: background: lightgreen;
8263: color: darkgreen;
8264: padding: 6px;
1.523 albertel 8265: }
1.795 www 8266:
1.523 albertel 8267: .LC_answer_charged_try {
1.797 www 8268: background: #FFAAAA;
1.795 www 8269: color: darkred;
8270: padding: 6px;
1.523 albertel 8271: }
1.795 www 8272:
1.779 bisitz 8273: .LC_answer_not_charged_try,
1.523 albertel 8274: .LC_answer_no_grade,
8275: .LC_answer_late {
1.795 www 8276: background: lightyellow;
1.523 albertel 8277: color: black;
1.795 www 8278: padding: 6px;
1.523 albertel 8279: }
1.795 www 8280:
1.523 albertel 8281: .LC_answer_previous {
1.795 www 8282: background: lightblue;
8283: color: darkblue;
8284: padding: 6px;
1.523 albertel 8285: }
1.795 www 8286:
1.779 bisitz 8287: .LC_answer_no_message {
1.777 tempelho 8288: background: #FFFFFF;
8289: color: black;
1.795 www 8290: padding: 6px;
1.779 bisitz 8291: }
1.795 www 8292:
1.1334 raeburn 8293: .LC_answer_unknown,
8294: .LC_answer_warning {
1.779 bisitz 8295: background: orange;
8296: color: black;
1.795 www 8297: padding: 6px;
1.777 tempelho 8298: }
1.795 www 8299:
1.1467 raeburn 8300: span.LC_prob_status {
8301: margin: 5px 0 0 0;
8302: padding: 0 5px 0 0;
8303: vertical-align: middle;
8304: }
8305:
8306: div.LC_prob_status_outer {
8307: display: inline-block;
8308: margin: -5px 0 0 0;
8309: padding: 0;
8310: }
8311:
8312: div.LC_prob_status_inner {
8313: display: inline-block;
8314: margin: 0 5px 0 0;
8315: padding: 5px;
1.1446 raeburn 8316: }
8317:
1.1468 ! raeburn 8318: caption.LC_filesub_status {
! 8319: text-align: left;
! 8320: font-weight: bold;
! 8321: }
! 8322:
1.1448 raeburn 8323: .LC_mail_actions {
8324: float: left;
8325: padding: 0;
8326: margin: 6px;
8327: }
8328:
8329: .LC_vertical_line {
8330: width: 1px;
8331: background-color: black;
8332: height: 4em;
8333: float: left;
8334: margin: 0;
8335: padding: 0;
8336: }
8337:
1.529 albertel 8338: span.LC_prior_numerical,
8339: span.LC_prior_string,
8340: span.LC_prior_custom,
8341: span.LC_prior_reaction,
8342: span.LC_prior_math {
1.925 bisitz 8343: font-family: $mono;
1.523 albertel 8344: white-space: pre;
8345: }
8346:
1.525 albertel 8347: span.LC_prior_string {
1.925 bisitz 8348: font-family: $mono;
1.525 albertel 8349: white-space: pre;
8350: }
8351:
1.523 albertel 8352: table.LC_prior_option {
8353: width: 100%;
8354: border-collapse: collapse;
8355: }
1.795 www 8356:
1.911 bisitz 8357: table.LC_prior_rank,
1.795 www 8358: table.LC_prior_match {
1.528 albertel 8359: border-collapse: collapse;
8360: }
1.795 www 8361:
1.528 albertel 8362: table.LC_prior_option tr td,
8363: table.LC_prior_rank tr td,
8364: table.LC_prior_match tr td {
1.524 albertel 8365: border: 1px solid #000000;
1.515 albertel 8366: }
8367:
1.855 bisitz 8368: .LC_nobreak {
1.544 albertel 8369: white-space: nowrap;
1.519 raeburn 8370: }
8371:
1.576 raeburn 8372: span.LC_cusr_emph {
8373: font-style: italic;
8374: }
8375:
1.633 raeburn 8376: span.LC_cusr_subheading {
8377: font-weight: normal;
8378: font-size: 85%;
8379: }
8380:
1.861 bisitz 8381: div.LC_docs_entry_move {
1.859 bisitz 8382: border: 1px solid #BBBBBB;
1.545 albertel 8383: background: #DDDDDD;
1.861 bisitz 8384: width: 22px;
1.859 bisitz 8385: padding: 1px;
8386: margin: 0;
1.545 albertel 8387: }
8388:
1.861 bisitz 8389: table.LC_data_table tr > td.LC_docs_entry_commands,
8390: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8391: font-size: x-small;
8392: }
1.795 www 8393:
1.861 bisitz 8394: .LC_docs_entry_parameter {
8395: white-space: nowrap;
8396: }
8397:
1.544 albertel 8398: .LC_docs_copy {
1.545 albertel 8399: color: #000099;
1.544 albertel 8400: }
1.795 www 8401:
1.544 albertel 8402: .LC_docs_cut {
1.545 albertel 8403: color: #550044;
1.544 albertel 8404: }
1.795 www 8405:
1.544 albertel 8406: .LC_docs_rename {
1.545 albertel 8407: color: #009900;
1.544 albertel 8408: }
1.795 www 8409:
1.544 albertel 8410: .LC_docs_remove {
1.545 albertel 8411: color: #990000;
8412: }
8413:
1.1284 raeburn 8414: .LC_docs_alias {
8415: color: #440055;
8416: }
8417:
1.1286 raeburn 8418: .LC_domprefs_email,
1.1284 raeburn 8419: .LC_docs_alias_name,
1.547 albertel 8420: .LC_docs_reinit_warn,
8421: .LC_docs_ext_edit {
8422: font-size: x-small;
8423: }
8424:
1.545 albertel 8425: table.LC_docs_adddocs td,
8426: table.LC_docs_adddocs th {
8427: border: 1px solid #BBBBBB;
8428: padding: 4px;
8429: background: #DDDDDD;
1.543 albertel 8430: }
8431:
1.584 albertel 8432: table.LC_sty_begin {
8433: background: #BBFFBB;
8434: }
1.795 www 8435:
1.584 albertel 8436: table.LC_sty_end {
8437: background: #FFBBBB;
8438: }
8439:
1.589 raeburn 8440: table.LC_double_column {
1.803 bisitz 8441: border-width: 0;
1.589 raeburn 8442: border-collapse: collapse;
8443: width: 100%;
8444: padding: 2px;
8445: }
8446:
8447: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8448: top: 2px;
1.589 raeburn 8449: left: 2px;
8450: width: 47%;
8451: vertical-align: top;
8452: }
8453:
8454: table.LC_double_column tr td.LC_right_col {
8455: top: 2px;
1.779 bisitz 8456: right: 2px;
1.589 raeburn 8457: width: 47%;
8458: vertical-align: top;
8459: }
8460:
1.591 raeburn 8461: div.LC_left_float {
8462: float: left;
8463: padding-right: 5%;
1.597 albertel 8464: padding-bottom: 4px;
1.591 raeburn 8465: }
8466:
8467: div.LC_clear_float_header {
1.597 albertel 8468: padding-bottom: 2px;
1.591 raeburn 8469: }
8470:
8471: div.LC_clear_float_footer {
1.597 albertel 8472: padding-top: 10px;
1.591 raeburn 8473: clear: both;
8474: }
8475:
1.597 albertel 8476: div.LC_grade_show_user {
1.941 bisitz 8477: /* border-left: 5px solid $sidebg; */
8478: border-top: 5px solid #000000;
8479: margin: 50px 0 0 0;
1.936 bisitz 8480: padding: 15px 0 5px 10px;
1.597 albertel 8481: }
1.795 www 8482:
1.936 bisitz 8483: div.LC_grade_show_user_odd_row {
1.941 bisitz 8484: /* border-left: 5px solid #000000; */
8485: }
8486:
8487: div.LC_grade_show_user div.LC_Box {
8488: margin-right: 50px;
1.597 albertel 8489: }
8490:
1.1461 raeburn 8491: div.LC_grade_show_user div.LC_Box table tr th {
8492: font-weight: normal;
8493: }
8494:
1.597 albertel 8495: div.LC_grade_submissions,
8496: div.LC_grade_message_center,
1.936 bisitz 8497: div.LC_grade_info_links {
1.597 albertel 8498: margin: 5px;
8499: width: 99%;
8500: background: #FFFFFF;
8501: }
1.795 www 8502:
1.597 albertel 8503: div.LC_grade_submissions_header,
1.936 bisitz 8504: div.LC_grade_message_center_header {
1.705 tempelho 8505: font-weight: bold;
8506: font-size: large;
1.597 albertel 8507: }
1.795 www 8508:
1.597 albertel 8509: div.LC_grade_submissions_body,
1.936 bisitz 8510: div.LC_grade_message_center_body {
1.597 albertel 8511: border: 1px solid black;
8512: width: 99%;
8513: background: #FFFFFF;
8514: }
1.795 www 8515:
1.613 albertel 8516: table.LC_scantron_action {
8517: width: 100%;
8518: }
1.795 www 8519:
1.613 albertel 8520: table.LC_scantron_action tr th {
1.698 harmsja 8521: font-weight:bold;
8522: font-style:normal;
1.613 albertel 8523: }
1.795 www 8524:
1.1461 raeburn 8525: div.LC_edit_problem_daxe_header {
8526: padding: 3px;
8527: background: $tabbg;
8528: z-index: 100;
8529: }
8530:
1.779 bisitz 8531: .LC_edit_problem_header,
1.614 albertel 8532: div.LC_edit_problem_footer {
1.705 tempelho 8533: font-weight: normal;
8534: font-size: medium;
1.602 albertel 8535: margin: 2px;
1.1060 bisitz 8536: background-color: $sidebg;
1.600 albertel 8537: }
1.795 www 8538:
1.600 albertel 8539: div.LC_edit_problem_header,
1.602 albertel 8540: div.LC_edit_problem_header div,
1.614 albertel 8541: div.LC_edit_problem_footer,
8542: div.LC_edit_problem_footer div,
1.602 albertel 8543: div.LC_edit_problem_editxml_header,
8544: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8545: z-index: 100;
1.600 albertel 8546: }
1.795 www 8547:
1.600 albertel 8548: div.LC_edit_problem_header_title {
1.705 tempelho 8549: font-weight: bold;
8550: font-size: larger;
1.602 albertel 8551: background: $tabbg;
8552: padding: 3px;
1.1060 bisitz 8553: margin: 0 0 5px 0;
1.602 albertel 8554: }
1.795 www 8555:
1.602 albertel 8556: table.LC_edit_problem_header_title {
8557: width: 100%;
1.600 albertel 8558: background: $tabbg;
1.602 albertel 8559: }
8560:
1.1205 golterma 8561: div.LC_edit_actionbar {
8562: background-color: $sidebg;
1.1218 droeschl 8563: margin: 0;
8564: padding: 0;
8565: line-height: 200%;
1.602 albertel 8566: }
1.795 www 8567:
1.1218 droeschl 8568: div.LC_edit_actionbar div{
8569: padding: 0;
8570: margin: 0;
8571: display: inline-block;
1.600 albertel 8572: }
1.795 www 8573:
1.1124 bisitz 8574: .LC_edit_opt {
8575: padding-left: 1em;
8576: white-space: nowrap;
8577: }
8578:
1.1152 golterma 8579: .LC_edit_problem_latexhelper{
8580: text-align: right;
8581: }
8582:
8583: #LC_edit_problem_colorful div{
8584: margin-left: 40px;
8585: }
8586:
1.1205 golterma 8587: #LC_edit_problem_codemirror div{
8588: margin-left: 0px;
8589: }
8590:
1.911 bisitz 8591: img.stift {
1.803 bisitz 8592: border-width: 0;
8593: vertical-align: middle;
1.677 riegler 8594: }
1.680 riegler 8595:
1.1460 raeburn 8596: div.LC_mainmenu {
8597: margin: 3px 2px 2px 1px;
8598: float: left;
1.777 tempelho 8599: }
1.795 www 8600:
1.716 raeburn 8601: div.LC_createcourse {
1.911 bisitz 8602: margin: 10px 10px 10px 10px;
1.716 raeburn 8603: }
8604:
1.917 raeburn 8605: .LC_dccid {
1.1130 raeburn 8606: float: right;
1.917 raeburn 8607: margin: 0.2em 0 0 0;
8608: padding: 0;
8609: font-size: 90%;
8610: display:none;
8611: }
8612:
1.897 wenzelju 8613: ol.LC_primary_menu a:hover,
1.721 harmsja 8614: ol#LC_MenuBreadcrumbs a:hover,
8615: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8616: ul#LC_secondary_menu a:hover,
1.721 harmsja 8617: .LC_FormSectionClearButton input:hover
1.795 www 8618: ul.LC_TabContent li:hover a {
1.952 onken 8619: color:$button_hover;
1.911 bisitz 8620: text-decoration:none;
1.693 droeschl 8621: }
8622:
1.779 bisitz 8623: h1 {
1.911 bisitz 8624: padding: 0;
8625: line-height:130%;
1.693 droeschl 8626: }
1.698 harmsja 8627:
1.911 bisitz 8628: h2,
8629: h3,
8630: h4,
8631: h5,
8632: h6 {
8633: margin: 5px 0 5px 0;
8634: padding: 0;
8635: line-height:130%;
1.693 droeschl 8636: }
1.795 www 8637:
8638: .LC_hcell {
1.911 bisitz 8639: padding:3px 15px 3px 15px;
8640: margin: 0;
8641: background-color:$tabbg;
8642: color:$fontmenu;
8643: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8644: }
1.795 www 8645:
1.840 bisitz 8646: .LC_Box > .LC_hcell {
1.911 bisitz 8647: margin: 0 -10px 10px -10px;
1.835 bisitz 8648: }
8649:
1.721 harmsja 8650: .LC_noBorder {
1.911 bisitz 8651: border: 0;
1.698 harmsja 8652: }
1.693 droeschl 8653:
1.721 harmsja 8654: .LC_FormSectionClearButton input {
1.911 bisitz 8655: background-color:transparent;
8656: border: none;
8657: cursor:pointer;
8658: text-decoration:underline;
1.693 droeschl 8659: }
1.763 bisitz 8660:
8661: .LC_help_open_topic {
1.911 bisitz 8662: color: #FFFFFF;
8663: background-color: #EEEEFF;
8664: margin: 1px;
8665: padding: 4px;
8666: border: 1px solid #000033;
8667: white-space: nowrap;
8668: /* vertical-align: middle; */
1.759 neumanie 8669: }
1.693 droeschl 8670:
1.911 bisitz 8671: dl,
8672: ul,
8673: div,
8674: fieldset {
8675: margin: 10px 10px 10px 0;
8676: /* overflow: hidden; */
1.693 droeschl 8677: }
1.795 www 8678:
1.1404 raeburn 8679: fieldset#LC_selectuser {
1.1460 raeburn 8680: margin: -1px 0 0 0;
8681: padding: 0;
8682: border: 0;
1.1404 raeburn 8683: }
8684:
1.1211 raeburn 8685: article.geogebraweb div {
8686: margin: 0;
8687: }
8688:
1.838 bisitz 8689: fieldset > legend {
1.911 bisitz 8690: font-weight: bold;
8691: padding: 0 5px 0 5px;
1.838 bisitz 8692: }
8693:
1.813 bisitz 8694: #LC_nav_bar {
1.911 bisitz 8695: float: left;
1.995 raeburn 8696: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8697: margin: 0 0 2px 0;
1.807 droeschl 8698: }
8699:
1.916 droeschl 8700: #LC_realm {
8701: margin: 0.2em 0 0 0;
8702: padding: 0;
8703: font-weight: bold;
8704: text-align: center;
1.995 raeburn 8705: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8706: }
8707:
1.911 bisitz 8708: #LC_nav_bar em {
8709: font-weight: bold;
8710: font-style: normal;
1.807 droeschl 8711: }
8712:
1.897 wenzelju 8713: ol.LC_primary_menu {
1.934 droeschl 8714: margin: 0;
1.1076 raeburn 8715: padding: 0;
1.807 droeschl 8716: }
8717:
1.852 droeschl 8718: ol#LC_PathBreadcrumbs {
1.911 bisitz 8719: margin: 0;
1.693 droeschl 8720: }
8721:
1.897 wenzelju 8722: ol.LC_primary_menu li {
1.1076 raeburn 8723: color: RGB(80, 80, 80);
8724: vertical-align: middle;
8725: text-align: left;
8726: list-style: none;
1.1205 golterma 8727: position: relative;
1.1076 raeburn 8728: float: left;
1.1205 golterma 8729: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8730: line-height: 1.5em;
1.1076 raeburn 8731: }
8732:
1.1205 golterma 8733: ol.LC_primary_menu li a,
8734: ol.LC_primary_menu li p {
1.1076 raeburn 8735: display: block;
8736: margin: 0;
8737: padding: 0 5px 0 10px;
8738: text-decoration: none;
8739: }
8740:
1.1205 golterma 8741: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8742: display: inline-block;
8743: width: 95%;
8744: text-align: left;
8745: }
8746:
8747: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8748: display: inline-block;
8749: width: 5%;
8750: float: right;
8751: text-align: right;
8752: font-size: 70%;
8753: }
8754:
8755: ol.LC_primary_menu ul {
1.1076 raeburn 8756: display: none;
1.1205 golterma 8757: width: 15em;
1.1076 raeburn 8758: background-color: $data_table_light;
1.1205 golterma 8759: position: absolute;
8760: top: 100%;
1.1076 raeburn 8761: }
8762:
1.1205 golterma 8763: ol.LC_primary_menu ul ul {
8764: left: 100%;
8765: top: 0;
8766: }
8767:
8768: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8769: display: block;
8770: position: absolute;
8771: margin: 0;
8772: padding: 0;
1.1078 raeburn 8773: z-index: 2;
1.1076 raeburn 8774: }
8775:
8776: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8777: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8778: font-size: 90%;
1.911 bisitz 8779: vertical-align: top;
1.1076 raeburn 8780: float: none;
1.1079 raeburn 8781: border-left: 1px solid black;
8782: border-right: 1px solid black;
1.1205 golterma 8783: /* A dark bottom border to visualize different menu options;
8784: overwritten in the create_submenu routine for the last border-bottom of the menu */
8785: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8786: }
8787:
1.1205 golterma 8788: ol.LC_primary_menu li li p:hover {
8789: color:$button_hover;
8790: text-decoration:none;
8791: background-color:$data_table_dark;
1.1076 raeburn 8792: }
8793:
8794: ol.LC_primary_menu li li a:hover {
8795: color:$button_hover;
8796: background-color:$data_table_dark;
1.693 droeschl 8797: }
8798:
1.1205 golterma 8799: /* Font-size equal to the size of the predecessors*/
8800: ol.LC_primary_menu li:hover li li {
8801: font-size: 100%;
8802: }
8803:
1.897 wenzelju 8804: ol.LC_primary_menu li img {
1.911 bisitz 8805: vertical-align: bottom;
1.934 droeschl 8806: height: 1.1em;
1.1077 raeburn 8807: margin: 0.2em 0 0 0;
1.693 droeschl 8808: }
8809:
1.897 wenzelju 8810: ol.LC_primary_menu a {
1.911 bisitz 8811: color: RGB(80, 80, 80);
8812: text-decoration: none;
1.693 droeschl 8813: }
1.795 www 8814:
1.949 droeschl 8815: ol.LC_primary_menu a.LC_new_message {
8816: font-weight:bold;
8817: color: darkred;
8818: }
8819:
1.975 raeburn 8820: ol.LC_docs_parameters {
8821: margin-left: 0;
8822: padding: 0;
8823: list-style: none;
8824: }
8825:
8826: ol.LC_docs_parameters li {
8827: margin: 0;
8828: padding-right: 20px;
8829: display: inline;
8830: }
8831:
1.976 raeburn 8832: ol.LC_docs_parameters li:before {
8833: content: "\\002022 \\0020";
8834: }
8835:
8836: li.LC_docs_parameters_title {
8837: font-weight: bold;
8838: }
8839:
8840: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8841: content: "";
8842: }
8843:
1.897 wenzelju 8844: ul#LC_secondary_menu {
1.1107 raeburn 8845: clear: right;
1.911 bisitz 8846: color: $fontmenu;
8847: background: $tabbg;
8848: list-style: none;
8849: padding: 0;
8850: margin: 0;
8851: width: 100%;
1.995 raeburn 8852: text-align: left;
1.1107 raeburn 8853: float: left;
1.808 droeschl 8854: }
8855:
1.897 wenzelju 8856: ul#LC_secondary_menu li {
1.911 bisitz 8857: font-weight: bold;
8858: line-height: 1.8em;
1.1107 raeburn 8859: border-right: 1px solid black;
8860: float: left;
8861: }
8862:
8863: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8864: background-color: $data_table_light;
8865: }
8866:
8867: ul#LC_secondary_menu li a {
1.911 bisitz 8868: padding: 0 0.8em;
1.1107 raeburn 8869: }
8870:
8871: ul#LC_secondary_menu li ul {
8872: display: none;
8873: }
8874:
8875: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8876: display: block;
8877: position: absolute;
8878: margin: 0;
8879: padding: 0;
8880: list-style:none;
8881: float: none;
8882: background-color: $data_table_light;
8883: z-index: 2;
8884: margin-left: -1px;
8885: }
8886:
8887: ul#LC_secondary_menu li ul li {
8888: font-size: 90%;
8889: vertical-align: top;
8890: border-left: 1px solid black;
1.911 bisitz 8891: border-right: 1px solid black;
1.1119 raeburn 8892: background-color: $data_table_light;
1.1107 raeburn 8893: list-style:none;
8894: float: none;
8895: }
8896:
8897: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8898: background-color: $data_table_dark;
1.807 droeschl 8899: }
8900:
1.847 tempelho 8901: ul.LC_TabContent {
1.911 bisitz 8902: display:block;
8903: background: $sidebg;
8904: border-bottom: solid 1px $lg_border_color;
8905: list-style:none;
1.1020 raeburn 8906: margin: -1px -10px 0 -10px;
1.911 bisitz 8907: padding: 0;
1.693 droeschl 8908: }
8909:
1.795 www 8910: ul.LC_TabContent li,
8911: ul.LC_TabContentBigger li {
1.911 bisitz 8912: float:left;
1.741 harmsja 8913: }
1.795 www 8914:
1.897 wenzelju 8915: ul#LC_secondary_menu li a {
1.911 bisitz 8916: color: $fontmenu;
8917: text-decoration: none;
1.693 droeschl 8918: }
1.795 www 8919:
1.721 harmsja 8920: ul.LC_TabContent {
1.952 onken 8921: min-height:20px;
1.721 harmsja 8922: }
1.795 www 8923:
8924: ul.LC_TabContent li {
1.911 bisitz 8925: vertical-align:middle;
1.959 onken 8926: padding: 0 16px 0 10px;
1.911 bisitz 8927: background-color:$tabbg;
8928: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8929: border-left: solid 1px $font;
1.721 harmsja 8930: }
1.795 www 8931:
1.847 tempelho 8932: ul.LC_TabContent .right {
1.911 bisitz 8933: float:right;
1.847 tempelho 8934: }
8935:
1.911 bisitz 8936: ul.LC_TabContent li a,
8937: ul.LC_TabContent li {
8938: color:rgb(47,47,47);
8939: text-decoration:none;
8940: font-size:95%;
8941: font-weight:bold;
1.952 onken 8942: min-height:20px;
8943: }
8944:
1.959 onken 8945: ul.LC_TabContent li a:hover,
8946: ul.LC_TabContent li a:focus {
1.952 onken 8947: color: $button_hover;
1.959 onken 8948: background:none;
8949: outline:none;
1.952 onken 8950: }
8951:
8952: ul.LC_TabContent li:hover {
8953: color: $button_hover;
8954: cursor:pointer;
1.721 harmsja 8955: }
1.795 www 8956:
1.911 bisitz 8957: ul.LC_TabContent li.active {
1.952 onken 8958: color: $font;
1.911 bisitz 8959: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8960: border-bottom:solid 1px #FFFFFF;
8961: cursor: default;
1.744 ehlerst 8962: }
1.795 www 8963:
1.959 onken 8964: ul.LC_TabContent li.active a {
8965: color:$font;
8966: background:#FFFFFF;
8967: outline: none;
8968: }
1.1047 raeburn 8969:
8970: ul.LC_TabContent li.goback {
8971: float: left;
8972: border-left: none;
8973: }
8974:
1.870 tempelho 8975: #maincoursedoc {
1.911 bisitz 8976: clear:both;
1.870 tempelho 8977: }
8978:
8979: ul.LC_TabContentBigger {
1.911 bisitz 8980: display:block;
8981: list-style:none;
8982: padding: 0;
1.870 tempelho 8983: }
8984:
1.795 www 8985: ul.LC_TabContentBigger li {
1.911 bisitz 8986: vertical-align:bottom;
8987: height: 30px;
8988: font-size:110%;
8989: font-weight:bold;
8990: color: #737373;
1.841 tempelho 8991: }
8992:
1.957 onken 8993: ul.LC_TabContentBigger li.active {
8994: position: relative;
8995: top: 1px;
8996: }
8997:
1.870 tempelho 8998: ul.LC_TabContentBigger li a {
1.911 bisitz 8999: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
9000: height: 30px;
9001: line-height: 30px;
9002: text-align: center;
9003: display: block;
9004: text-decoration: none;
1.958 onken 9005: outline: none;
1.741 harmsja 9006: }
1.795 www 9007:
1.870 tempelho 9008: ul.LC_TabContentBigger li.active a {
1.911 bisitz 9009: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
9010: color:$font;
1.744 ehlerst 9011: }
1.795 www 9012:
1.870 tempelho 9013: ul.LC_TabContentBigger li b {
1.911 bisitz 9014: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
9015: display: block;
9016: float: left;
9017: padding: 0 30px;
1.957 onken 9018: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 9019: }
9020:
1.956 onken 9021: ul.LC_TabContentBigger li:hover b {
9022: color:$button_hover;
9023: }
9024:
1.870 tempelho 9025: ul.LC_TabContentBigger li.active b {
1.911 bisitz 9026: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
9027: color:$font;
1.957 onken 9028: border: 0;
1.741 harmsja 9029: }
1.693 droeschl 9030:
1.870 tempelho 9031:
1.862 bisitz 9032: ul.LC_CourseBreadcrumbs {
9033: background: $sidebg;
1.1020 raeburn 9034: height: 2em;
1.862 bisitz 9035: padding-left: 10px;
1.1020 raeburn 9036: margin: 0;
1.862 bisitz 9037: list-style-position: inside;
9038: }
9039:
1.911 bisitz 9040: ol#LC_MenuBreadcrumbs,
1.862 bisitz 9041: ol#LC_PathBreadcrumbs {
1.911 bisitz 9042: padding-left: 10px;
9043: margin: 0;
1.933 droeschl 9044: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 9045: }
9046:
1.911 bisitz 9047: ol#LC_MenuBreadcrumbs li,
9048: ol#LC_PathBreadcrumbs li,
1.862 bisitz 9049: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 9050: display: inline;
1.933 droeschl 9051: white-space: normal;
1.693 droeschl 9052: }
9053:
1.823 bisitz 9054: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 9055: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 9056: text-decoration: none;
9057: font-size:90%;
1.693 droeschl 9058: }
1.795 www 9059:
1.969 droeschl 9060: ol#LC_MenuBreadcrumbs h1 {
9061: display: inline;
9062: font-size: 90%;
9063: line-height: 2.5em;
9064: margin: 0;
9065: padding: 0;
9066: }
9067:
1.795 www 9068: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 9069: text-decoration:none;
9070: font-size:100%;
9071: font-weight:bold;
1.693 droeschl 9072: }
1.795 www 9073:
1.840 bisitz 9074: .LC_Box {
1.911 bisitz 9075: border: solid 1px $lg_border_color;
9076: padding: 0 10px 10px 10px;
1.746 neumanie 9077: }
1.795 www 9078:
1.1020 raeburn 9079: .LC_DocsBox {
9080: border: solid 1px $lg_border_color;
9081: padding: 0 0 10px 10px;
9082: }
9083:
1.795 www 9084: .LC_AboutMe_Image {
1.911 bisitz 9085: float:left;
9086: margin-right:10px;
1.747 neumanie 9087: }
1.795 www 9088:
9089: .LC_Clear_AboutMe_Image {
1.911 bisitz 9090: clear:left;
1.747 neumanie 9091: }
1.795 www 9092:
1.721 harmsja 9093: dl.LC_ListStyleClean dt {
1.911 bisitz 9094: padding-right: 5px;
9095: display: table-header-group;
1.693 droeschl 9096: }
9097:
1.721 harmsja 9098: dl.LC_ListStyleClean dd {
1.911 bisitz 9099: display: table-row;
1.693 droeschl 9100: }
9101:
1.721 harmsja 9102: .LC_ListStyleClean,
9103: .LC_ListStyleSimple,
9104: .LC_ListStyleNormal,
1.795 www 9105: .LC_ListStyleSpecial {
1.911 bisitz 9106: /* display:block; */
9107: list-style-position: inside;
9108: list-style-type: none;
9109: overflow: hidden;
9110: padding: 0;
1.693 droeschl 9111: }
9112:
1.721 harmsja 9113: .LC_ListStyleSimple li,
9114: .LC_ListStyleSimple dd,
9115: .LC_ListStyleNormal li,
9116: .LC_ListStyleNormal dd,
9117: .LC_ListStyleSpecial li,
1.795 www 9118: .LC_ListStyleSpecial dd {
1.911 bisitz 9119: margin: 0;
9120: padding: 5px 5px 5px 10px;
9121: clear: both;
1.693 droeschl 9122: }
9123:
1.721 harmsja 9124: .LC_ListStyleClean li,
9125: .LC_ListStyleClean dd {
1.911 bisitz 9126: padding-top: 0;
9127: padding-bottom: 0;
1.693 droeschl 9128: }
9129:
1.721 harmsja 9130: .LC_ListStyleSimple dd,
1.795 www 9131: .LC_ListStyleSimple li {
1.911 bisitz 9132: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9133: }
9134:
1.721 harmsja 9135: .LC_ListStyleSpecial li,
9136: .LC_ListStyleSpecial dd {
1.911 bisitz 9137: list-style-type: none;
9138: background-color: RGB(220, 220, 220);
9139: margin-bottom: 4px;
1.693 droeschl 9140: }
9141:
1.721 harmsja 9142: table.LC_SimpleTable {
1.911 bisitz 9143: margin:5px;
9144: border:solid 1px $lg_border_color;
1.795 www 9145: }
1.693 droeschl 9146:
1.721 harmsja 9147: table.LC_SimpleTable tr {
1.911 bisitz 9148: padding: 0;
9149: border:solid 1px $lg_border_color;
1.693 droeschl 9150: }
1.795 www 9151:
9152: table.LC_SimpleTable thead {
1.911 bisitz 9153: background:rgb(220,220,220);
1.693 droeschl 9154: }
9155:
1.721 harmsja 9156: div.LC_columnSection {
1.911 bisitz 9157: display: block;
9158: clear: both;
9159: overflow: hidden;
9160: margin: 0;
1.693 droeschl 9161: }
9162:
1.721 harmsja 9163: div.LC_columnSection>* {
1.911 bisitz 9164: float: left;
9165: margin: 10px 20px 10px 0;
9166: overflow:hidden;
1.693 droeschl 9167: }
1.721 harmsja 9168:
1.795 www 9169: table em {
1.911 bisitz 9170: font-weight: bold;
9171: font-style: normal;
1.748 schulted 9172: }
1.795 www 9173:
1.779 bisitz 9174: table.LC_tableBrowseRes,
1.795 www 9175: table.LC_tableOfContent {
1.911 bisitz 9176: border:none;
9177: border-spacing: 1px;
9178: padding: 3px;
9179: background-color: #FFFFFF;
9180: font-size: 90%;
1.753 droeschl 9181: }
1.789 droeschl 9182:
1.911 bisitz 9183: table.LC_tableOfContent {
9184: border-collapse: collapse;
1.789 droeschl 9185: }
9186:
1.771 droeschl 9187: table.LC_tableBrowseRes a,
1.768 schulted 9188: table.LC_tableOfContent a {
1.911 bisitz 9189: background-color: transparent;
9190: text-decoration: none;
1.753 droeschl 9191: }
9192:
1.795 www 9193: table.LC_tableOfContent img {
1.911 bisitz 9194: border: none;
9195: height: 1.3em;
9196: vertical-align: text-bottom;
9197: margin-right: 0.3em;
1.753 droeschl 9198: }
1.757 schulted 9199:
1.795 www 9200: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9201: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9202: }
9203:
1.795 www 9204: a#LC_content_toolbar_everything {
1.911 bisitz 9205: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9206: }
9207:
1.795 www 9208: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9209: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9210: }
9211:
1.795 www 9212: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9213: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9214: }
9215:
1.795 www 9216: a#LC_content_toolbar_changefolder {
1.911 bisitz 9217: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9218: }
9219:
1.795 www 9220: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9221: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9222: }
9223:
1.1043 raeburn 9224: a#LC_content_toolbar_edittoplevel {
9225: background-image:url(/res/adm/pages/edittoplevel.gif);
9226: }
9227:
1.1384 raeburn 9228: a#LC_content_toolbar_printout {
9229: background-image:url(/res/adm/pages/printout.gif);
9230: }
9231:
1.795 www 9232: ul#LC_toolbar li a:hover {
1.911 bisitz 9233: background-position: bottom center;
1.757 schulted 9234: }
9235:
1.795 www 9236: ul#LC_toolbar {
1.911 bisitz 9237: padding: 0;
9238: margin: 2px;
9239: list-style:none;
1.1449 raeburn 9240: display:inline;
1.911 bisitz 9241: background-color:white;
1.1082 raeburn 9242: overflow: auto;
1.757 schulted 9243: }
9244:
1.795 www 9245: ul#LC_toolbar li {
1.911 bisitz 9246: border:1px solid white;
9247: padding: 0;
9248: margin: 0;
9249: float: left;
9250: display:inline;
9251: vertical-align:middle;
1.1082 raeburn 9252: white-space: nowrap;
1.911 bisitz 9253: }
1.757 schulted 9254:
1.783 amueller 9255:
1.795 www 9256: a.LC_toolbarItem {
1.911 bisitz 9257: display:block;
9258: padding: 0;
9259: margin: 0;
9260: height: 32px;
9261: width: 32px;
9262: color:white;
9263: border: none;
9264: background-repeat:no-repeat;
9265: background-color:transparent;
1.757 schulted 9266: }
9267:
1.1449 raeburn 9268: .LC_navtools {
9269: display: inline-block;
9270: padding: 0;
9271: margin: 2px;
9272: vertical-align: middle;
9273: }
9274:
1.915 droeschl 9275: ul.LC_funclist {
9276: margin: 0;
9277: padding: 0.5em 1em 0.5em 0;
9278: }
9279:
1.933 droeschl 9280: ul.LC_funclist > li:first-child {
9281: font-weight:bold;
9282: margin-left:0.8em;
9283: }
9284:
1.915 droeschl 9285: ul.LC_funclist + ul.LC_funclist {
9286: /*
9287: left border as a seperator if we have more than
9288: one list
9289: */
9290: border-left: 1px solid $sidebg;
9291: /*
9292: this hides the left border behind the border of the
9293: outer box if element is wrapped to the next 'line'
9294: */
9295: margin-left: -1px;
9296: }
9297:
1.843 bisitz 9298: ul.LC_funclist li {
1.915 droeschl 9299: display: inline;
1.782 bisitz 9300: white-space: nowrap;
1.915 droeschl 9301: margin: 0 0 0 25px;
9302: line-height: 150%;
1.782 bisitz 9303: }
9304:
1.974 wenzelju 9305: .LC_hidden {
9306: display: none;
9307: }
9308:
1.1030 www 9309: .LCmodal-overlay {
9310: position:fixed;
9311: top:0;
9312: right:0;
9313: bottom:0;
9314: left:0;
9315: height:100%;
9316: width:100%;
9317: margin:0;
9318: padding:0;
9319: background:#999;
9320: opacity:.75;
9321: filter: alpha(opacity=75);
9322: -moz-opacity: 0.75;
9323: z-index:101;
9324: }
9325:
9326: * html .LCmodal-overlay {
9327: position: absolute;
9328: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9329: }
9330:
9331: .LCmodal-window {
9332: position:fixed;
9333: top:50%;
9334: left:50%;
9335: margin:0;
9336: padding:0;
9337: z-index:102;
9338: }
9339:
9340: * html .LCmodal-window {
9341: position:absolute;
9342: }
9343:
9344: .LCclose-window {
9345: position:absolute;
9346: width:32px;
9347: height:32px;
9348: right:8px;
9349: top:8px;
9350: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9351: text-indent:-99999px;
9352: overflow:hidden;
9353: cursor:pointer;
9354: }
9355:
1.1369 raeburn 9356: .LCisDisabled {
9357: cursor: not-allowed;
9358: opacity: 0.5;
9359: }
9360:
9361: a[aria-disabled="true"] {
9362: color: currentColor;
9363: display: inline-block; /* For IE11/ MS Edge bug */
9364: pointer-events: none;
9365: text-decoration: none;
9366: }
9367:
1.1335 raeburn 9368: pre.LC_wordwrap {
9369: white-space: pre-wrap;
9370: white-space: -moz-pre-wrap;
9371: white-space: -pre-wrap;
9372: white-space: -o-pre-wrap;
9373: word-wrap: break-word;
9374: }
9375:
1.1100 raeburn 9376: /*
1.1231 damieng 9377: styles used for response display
9378: */
1.1464 raeburn 9379: div.LC_radiofoil, div.LC_rankfoil, div.LC_optionfoil, div.LC_matchfoil, div.LC_login_links {
1.1231 damieng 9380: margin: .5em 0em .5em 0em;
9381: }
9382: table.LC_itemgroup {
9383: margin-top: 1em;
9384: }
9385:
1.1462 raeburn 9386: table.LC_itemgroup tr th {
9387: font-weight: normal;
9388: }
9389:
9390: fieldset.LC_webbubbles {
9391: margin: 2px 0 0 0;
9392: padding: 0;
9393: border: 0;
9394: }
9395:
9396: ul.LC_webbubbles {
9397: list-style: none;
9398: padding: 0;
9399: margin: 0;
9400: text-align: left;
9401: float: left;
9402: }
9403:
9404: ul.LC_webbubbles li {
9405: line-height: 1.8em;
9406: border: 1px solid black;
9407: padding: 0 2px 0 5px;
9408: margin: 0 0 0 -1px;
9409: float: left;
9410: }
9411:
1.1231 damieng 9412: /*
1.1100 raeburn 9413: styles used by TTH when "Default set of options to pass to tth/m
9414: when converting TeX" in course settings has been set
9415:
9416: option passed: -t
9417:
9418: */
9419:
9420: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9421: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9422: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9423: td div.norm {line-height:normal;}
9424:
9425: /*
9426: option passed -y3
9427: */
9428:
9429: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9430: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9431: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9432:
1.1230 damieng 9433: /*
9434: sections with roles, for content only
9435: */
9436: section[class^="role-"] {
9437: padding-left: 10px;
9438: padding-right: 5px;
9439: margin-top: 8px;
9440: margin-bottom: 8px;
9441: border: 1px solid #2A4;
9442: border-radius: 5px;
9443: box-shadow: 0px 1px 1px #BBB;
9444: }
9445: section[class^="role-"]>h1 {
9446: position: relative;
9447: margin: 0px;
9448: padding-top: 10px;
9449: padding-left: 40px;
9450: }
9451: section[class^="role-"]>h1:before {
9452: position: absolute;
9453: left: -5px;
9454: top: 5px;
9455: }
9456: section.role-activity>h1:before {
9457: content:url('/adm/daxe/images/section_icons/activity.png');
9458: }
9459: section.role-advice>h1:before {
9460: content:url('/adm/daxe/images/section_icons/advice.png');
9461: }
9462: section.role-bibliography>h1:before {
9463: content:url('/adm/daxe/images/section_icons/bibliography.png');
9464: }
9465: section.role-citation>h1:before {
9466: content:url('/adm/daxe/images/section_icons/citation.png');
9467: }
9468: section.role-conclusion>h1:before {
9469: content:url('/adm/daxe/images/section_icons/conclusion.png');
9470: }
9471: section.role-definition>h1:before {
9472: content:url('/adm/daxe/images/section_icons/definition.png');
9473: }
9474: section.role-demonstration>h1:before {
9475: content:url('/adm/daxe/images/section_icons/demonstration.png');
9476: }
9477: section.role-example>h1:before {
9478: content:url('/adm/daxe/images/section_icons/example.png');
9479: }
9480: section.role-explanation>h1:before {
9481: content:url('/adm/daxe/images/section_icons/explanation.png');
9482: }
9483: section.role-introduction>h1:before {
9484: content:url('/adm/daxe/images/section_icons/introduction.png');
9485: }
9486: section.role-method>h1:before {
9487: content:url('/adm/daxe/images/section_icons/method.png');
9488: }
9489: section.role-more_information>h1:before {
9490: content:url('/adm/daxe/images/section_icons/more_information.png');
9491: }
9492: section.role-objectives>h1:before {
9493: content:url('/adm/daxe/images/section_icons/objectives.png');
9494: }
9495: section.role-prerequisites>h1:before {
9496: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9497: }
9498: section.role-remark>h1:before {
9499: content:url('/adm/daxe/images/section_icons/remark.png');
9500: }
9501: section.role-reminder>h1:before {
9502: content:url('/adm/daxe/images/section_icons/reminder.png');
9503: }
9504: section.role-summary>h1:before {
9505: content:url('/adm/daxe/images/section_icons/summary.png');
9506: }
9507: section.role-syntax>h1:before {
9508: content:url('/adm/daxe/images/section_icons/syntax.png');
9509: }
9510: section.role-warning>h1:before {
9511: content:url('/adm/daxe/images/section_icons/warning.png');
9512: }
9513:
1.1269 raeburn 9514: #LC_minitab_header {
9515: float:left;
9516: width:100%;
9517: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9518: font-size:93%;
9519: line-height:normal;
9520: margin: 0.5em 0 0.5em 0;
9521: }
9522: #LC_minitab_header ul {
9523: margin:0;
9524: padding:10px 10px 0;
9525: list-style:none;
9526: }
9527: #LC_minitab_header li {
9528: float:left;
9529: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9530: margin:0;
9531: padding:0 0 0 9px;
9532: }
9533: #LC_minitab_header a {
9534: display:block;
9535: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9536: padding:5px 15px 4px 6px;
9537: }
9538: #LC_minitab_header #LC_current_minitab {
9539: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9540: }
9541: #LC_minitab_header #LC_current_minitab a {
9542: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9543: padding-bottom:5px;
9544: }
9545:
9546:
1.343 albertel 9547: END
9548: }
9549:
1.306 albertel 9550: =pod
9551:
9552: =item * &headtag()
9553:
9554: Returns a uniform footer for LON-CAPA web pages.
9555:
1.307 albertel 9556: Inputs: $title - optional title for the head
9557: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9558: $args - optional arguments
1.319 albertel 9559: force_register - if is true call registerurl so the remote is
9560: informed
1.415 albertel 9561: redirect -> array ref of
9562: 1- seconds before redirect occurs
9563: 2- url to redirect to
9564: 3- whether the side effect should occur
1.315 albertel 9565: (side effect of setting
9566: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9567: redirected to)
9568: 4- whether the redirect target should be
9569: the opener of the current (pop-up)
9570: window (side effect of setting
9571: $env{'internal.head.to_opener'} to
9572: 1, if true.
1.1388 raeburn 9573: 5- whether encrypt check should be skipped
1.352 albertel 9574: domain -> force to color decorate a page for a specific
9575: domain
9576: function -> force usage of a specific rolish color scheme
9577: bgcolor -> override the default page bgcolor
1.460 albertel 9578: no_auto_mt_title
9579: -> prevent &mt()ing the title arg
1.464 albertel 9580:
1.306 albertel 9581: =cut
9582:
9583: sub headtag {
1.313 albertel 9584: my ($title,$head_extra,$args) = @_;
1.306 albertel 9585:
1.363 albertel 9586: my $function = $args->{'function'} || &get_users_function();
9587: my $domain = $args->{'domain'} || &determinedomain();
9588: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9589: my $httphost = $args->{'use_absolute'};
1.418 albertel 9590: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9591: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9592: #time(),
1.418 albertel 9593: $env{'environment.color.timestamp'},
1.363 albertel 9594: $function,$domain,$bgcolor);
9595:
1.369 www 9596: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9597:
1.308 albertel 9598: my $result =
9599: '<head>'.
1.1160 raeburn 9600: &font_settings($args);
1.319 albertel 9601:
1.1188 raeburn 9602: my $inhibitprint;
9603: if ($args->{'print_suppress'}) {
9604: $inhibitprint = &print_suppression();
9605: }
1.1064 raeburn 9606:
1.1439 raeburn 9607: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9608: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9609: }
1.962 droeschl 9610: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9611: $result .= Apache::lonxml::display_title();
1.319 albertel 9612: }
1.436 albertel 9613: if (!$args->{'no_nav_bar'}
9614: && !$args->{'only_body'}
1.1438 raeburn 9615: && !$args->{'frameset'}
9616: && !$args->{'switchserver'}) {
1.1154 raeburn 9617: $result .= &help_menu_js($httphost);
1.1032 www 9618: $result.=&modal_window();
1.1038 www 9619: $result.=&togglebox_script();
1.1034 www 9620: $result.=&wishlist_window();
1.1041 www 9621: $result.=&LCprogressbarUpdate_script();
1.1034 www 9622: } else {
9623: if ($args->{'add_modal'}) {
9624: $result.=&modal_window();
9625: }
9626: if ($args->{'add_wishlist'}) {
9627: $result.=&wishlist_window();
9628: }
1.1038 www 9629: if ($args->{'add_togglebox'}) {
9630: $result.=&togglebox_script();
9631: }
1.1041 www 9632: if ($args->{'add_progressbar'}) {
9633: $result.=&LCprogressbarUpdate_script();
9634: }
1.436 albertel 9635: }
1.314 albertel 9636: if (ref($args->{'redirect'})) {
1.1388 raeburn 9637: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9638: if (!$skip_enc_check) {
9639: $url = &Apache::lonenc::check_encrypt($url);
9640: }
1.414 albertel 9641: if (!$inhibit_continue) {
9642: $env{'internal.head.redirect'} = $url;
9643: }
1.1386 raeburn 9644: $result.=<<"ADDMETA";
1.313 albertel 9645: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9646: ADDMETA
9647: if ($to_opener) {
9648: $env{'internal.head.to_opener'} = 1;
9649: my $dest = &js_escape($url);
9650: my $timeout = int($time * 1000);
9651: $result .=<<"ENDJS";
9652: <script type="text/javascript">
9653: // <![CDATA[
9654: function LC_To_Opener() {
9655: var dest = '$dest';
9656: if (dest != '') {
9657: if (window.opener != null && !window.opener.closed) {
9658: window.opener.location.href=dest;
9659: window.close();
9660: } else {
9661: window.location.href=dest;
9662: }
9663: }
9664: }
9665: \$(document).ready(function () {
9666: setTimeout('LC_To_Opener()',$timeout);
9667: });
9668: // ]]>
9669: </script>
9670: ENDJS
9671: } else {
9672: $result.=<<"ADDMETA";
1.344 albertel 9673: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9674: ADDMETA
1.1386 raeburn 9675: }
1.1210 raeburn 9676: } else {
9677: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9678: my $requrl = $env{'request.uri'};
9679: if ($requrl eq '') {
9680: $requrl = $ENV{'REQUEST_URI'};
9681: $requrl =~ s/\?.+$//;
9682: }
9683: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9684: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9685: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9686: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9687: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9688: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9689: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9690: my ($offload,$offloadoth);
1.1210 raeburn 9691: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9692: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9693: $offload = 1;
1.1353 raeburn 9694: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9695: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9696: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9697: $offloadoth = 1;
9698: $dom_in_use = $env{'user.domain'};
9699: }
9700: }
1.1340 raeburn 9701: }
9702: }
9703: unless ($offload) {
9704: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9705: if ($domdefs{'offloadoth'}{$lonhost}) {
9706: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9707: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9708: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9709: $offload = 1;
1.1352 raeburn 9710: $offloadoth = 1;
1.1340 raeburn 9711: $dom_in_use = $env{'user.domain'};
9712: }
1.1210 raeburn 9713: }
1.1340 raeburn 9714: }
9715: }
9716: }
9717: if ($offload) {
1.1358 raeburn 9718: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9719: if (($newserver eq '') && ($offloadoth)) {
9720: my @domains = &Apache::lonnet::current_machine_domains();
9721: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9722: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9723: }
9724: }
1.1340 raeburn 9725: if (($newserver) && ($newserver ne $lonhost)) {
9726: my $numsec = 5;
9727: my $timeout = $numsec * 1000;
9728: my ($newurl,$locknum,%locks,$msg);
9729: if ($env{'request.role.adv'}) {
9730: ($locknum,%locks) = &Apache::lonnet::get_locks();
9731: }
9732: my $disable_submit = 0;
9733: if ($requrl =~ /$LONCAPA::assess_re/) {
9734: $disable_submit = 1;
9735: }
9736: if ($locknum) {
9737: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9738: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9739: join(", ",sort(values(%locks)))."\n";
9740: if (&show_course()) {
9741: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9742: } else {
9743: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9744: }
1.1340 raeburn 9745: } else {
9746: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9747: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9748: }
9749: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9750: $newurl = '/adm/switchserver?otherserver='.$newserver;
9751: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9752: $newurl .= '&role='.$env{'request.role'};
9753: }
9754: if ($env{'request.symb'}) {
9755: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9756: if ($shownsymb =~ m{^/enc/}) {
9757: my $reqdmajor = 2;
9758: my $reqdminor = 11;
9759: my $reqdsubminor = 3;
9760: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9761: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9762: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9763: if (($major eq '' && $minor eq '') ||
9764: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9765: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9766: ($reqdsubminor > $subminor))))) {
9767: undef($shownsymb);
9768: }
1.1210 raeburn 9769: }
1.1340 raeburn 9770: if ($shownsymb) {
9771: &js_escape(\$shownsymb);
9772: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9773: }
1.1340 raeburn 9774: } else {
9775: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9776: &js_escape(\$shownurl);
9777: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9778: }
1.1340 raeburn 9779: }
9780: &js_escape(\$msg);
9781: $result.=<<OFFLOAD
1.1210 raeburn 9782: <meta http-equiv="pragma" content="no-cache" />
9783: <script type="text/javascript">
1.1215 raeburn 9784: // <![CDATA[
1.1210 raeburn 9785: function LC_Offload_Now() {
9786: var dest = "$newurl";
9787: if (dest != '') {
9788: window.location.href="$newurl";
9789: }
9790: }
1.1214 raeburn 9791: \$(document).ready(function () {
9792: window.alert('$msg');
9793: if ($disable_submit) {
1.1210 raeburn 9794: \$(".LC_hwk_submit").prop("disabled", true);
9795: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9796: }
9797: setTimeout('LC_Offload_Now()', $timeout);
9798: });
1.1215 raeburn 9799: // ]]>
1.1210 raeburn 9800: </script>
9801: OFFLOAD
9802: }
9803: }
9804: }
9805: }
9806: }
1.313 albertel 9807: }
1.306 albertel 9808: if (!defined($title)) {
9809: $title = 'The LearningOnline Network with CAPA';
9810: }
1.460 albertel 9811: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9812: if ($title =~ /^LON-CAPA\s+/) {
9813: $result .= '<title> '.$title.'</title>';
9814: } else {
9815: $result .= '<title> LON-CAPA '.$title.'</title>';
9816: }
9817: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9818: if (!$args->{'frameset'}) {
9819: $result .= ' /';
9820: }
9821: $result .= '>'
1.1064 raeburn 9822: .$inhibitprint
1.414 albertel 9823: .$head_extra;
1.1242 raeburn 9824: my $clientmobile;
9825: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9826: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9827: } else {
9828: $clientmobile = $env{'browser.mobile'};
9829: }
9830: if ($clientmobile) {
1.1137 raeburn 9831: $result .= '
1.1435 raeburn 9832: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9833: <meta name="apple-mobile-web-app-capable" content="yes" />';
9834: }
1.1455 raeburn 9835: $result .= '<meta name="google" content="notranslate"';
9836: if (!$args->{'frameset'}) {
9837: $result .= ' /';
9838: }
9839: $result .= '>'."\n";
1.962 droeschl 9840: return $result.'</head>';
1.306 albertel 9841: }
9842:
9843: =pod
9844:
1.340 albertel 9845: =item * &font_settings()
9846:
9847: Returns neccessary <meta> to set the proper encoding
9848:
1.1160 raeburn 9849: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9850:
9851: =cut
9852:
9853: sub font_settings {
1.1160 raeburn 9854: my ($args) = @_;
1.340 albertel 9855: my $headerstring='';
1.1160 raeburn 9856: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9857: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9858: $headerstring.=
9859: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9860: if (!$args->{'frameset'}) {
9861: $headerstring.= ' /';
9862: }
9863: $headerstring .= '>'."\n";
1.340 albertel 9864: }
9865: return $headerstring;
9866: }
9867:
1.341 albertel 9868: =pod
9869:
1.1064 raeburn 9870: =item * &print_suppression()
9871:
9872: In course context returns css which causes the body to be blank when media="print",
9873: if printout generation is unavailable for the current resource.
9874:
9875: This could be because:
9876:
9877: (a) printstartdate is in the future
9878:
9879: (b) printenddate is in the past
9880:
9881: (c) there is an active exam block with "printout"
9882: functionality blocked
9883:
9884: Users with pav, pfo or evb privileges are exempt.
9885:
9886: Inputs: none
9887:
9888: =cut
9889:
9890:
9891: sub print_suppression {
9892: my $noprint;
9893: if ($env{'request.course.id'}) {
9894: my $scope = $env{'request.course.id'};
9895: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9896: (&Apache::lonnet::allowed('pfo',$scope))) {
9897: return;
9898: }
9899: if ($env{'request.course.sec'} ne '') {
9900: $scope .= "/$env{'request.course.sec'}";
9901: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9902: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9903: return;
1.1064 raeburn 9904: }
9905: }
9906: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9907: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9908: my $clientip = &Apache::lonnet::get_requestor_ip();
9909: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9910: if ($blocked) {
9911: my $checkrole = "cm./$cdom/$cnum";
9912: if ($env{'request.course.sec'} ne '') {
9913: $checkrole .= "/$env{'request.course.sec'}";
9914: }
9915: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9916: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9917: $noprint = 1;
9918: }
9919: }
9920: unless ($noprint) {
9921: my $symb = &Apache::lonnet::symbread();
9922: if ($symb ne '') {
9923: my $navmap = Apache::lonnavmaps::navmap->new();
9924: if (ref($navmap)) {
9925: my $res = $navmap->getBySymb($symb);
9926: if (ref($res)) {
9927: if (!$res->resprintable()) {
9928: $noprint = 1;
9929: }
9930: }
9931: }
9932: }
9933: }
9934: if ($noprint) {
9935: return <<"ENDSTYLE";
9936: <style type="text/css" media="print">
9937: body { display:none }
9938: </style>
9939: ENDSTYLE
9940: }
9941: }
9942: return;
9943: }
9944:
9945: =pod
9946:
1.341 albertel 9947: =item * &xml_begin()
9948:
9949: Returns the needed doctype and <html>
9950:
9951: Inputs: none
9952:
9953: =cut
9954:
9955: sub xml_begin {
1.1168 raeburn 9956: my ($is_frameset) = @_;
1.341 albertel 9957: my $output='';
9958:
9959: if ($env{'browser.mathml'}) {
9960: $output='<?xml version="1.0"?>'
9961: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9962: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9963:
9964: # .'<!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">] >'
9965: .'<!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">'
9966: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9967: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9968: } elsif ($is_frameset) {
9969: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
1.1459 raeburn 9970: '<html lang="en">'."\n";
1.341 albertel 9971: } else {
1.1168 raeburn 9972: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9973: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9974: }
9975: return $output;
9976: }
1.340 albertel 9977:
9978: =pod
9979:
1.306 albertel 9980: =item * &start_page()
9981:
9982: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9983:
1.648 raeburn 9984: Inputs:
9985:
9986: =over 4
9987:
9988: $title - optional title for the page
9989:
9990: $head_extra - optional extra HTML to incude inside the <head>
9991:
9992: $args - additional optional args supported are:
9993:
9994: =over 8
9995:
9996: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9997: arg on
1.814 bisitz 9998: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9999: add_entries -> additional attributes to add to the <body>
10000: domain -> force to color decorate a page for a
1.317 albertel 10001: specific domain
1.648 raeburn 10002: function -> force usage of a specific rolish color
1.317 albertel 10003: scheme
1.648 raeburn 10004: redirect -> see &headtag()
10005: bgcolor -> override the default page bg color
10006: js_ready -> return a string ready for being used in
1.317 albertel 10007: a javascript writeln
1.648 raeburn 10008: html_encode -> return a string ready for being used in
1.320 albertel 10009: a html attribute
1.648 raeburn 10010: force_register -> if is true will turn on the &bodytag()
1.317 albertel 10011: $forcereg arg
1.648 raeburn 10012: frameset -> if true will start with a <frameset>
1.330 albertel 10013: rather than <body>
1.648 raeburn 10014: skip_phases -> hash ref of
1.338 albertel 10015: head -> skip the <html><head> generation
10016: body -> skip all <body> generation
1.648 raeburn 10017: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 10018: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 10019: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 10020: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
10021: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
10022: to override those values, or add to them, specify the value to
10023: include in the style attribute to include in the div tag by using
10024: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 10025: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
10026: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 10027: group -> includes the current group, if page is for a
1.1274 raeburn 10028: specific group
10029: use_absolute -> for request for external resource or syllabus, this
10030: will contain https://<hostname> if server uses
10031: https (as per hosts.tab), but request is for http
10032: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 10033: links_disabled -> Links in primary and secondary menus are disabled
10034: (Can enable them once page has loaded - see lonroles.pm
10035: for an example).
1.1380 raeburn 10036: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 10037:
1.648 raeburn 10038: =back
1.460 albertel 10039:
1.648 raeburn 10040: =back
1.562 albertel 10041:
1.306 albertel 10042: =cut
10043:
10044: sub start_page {
1.309 albertel 10045: my ($title,$head_extra,$args) = @_;
1.318 albertel 10046: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 10047:
1.315 albertel 10048: $env{'internal.start_page'}++;
1.1359 raeburn 10049: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 10050:
1.338 albertel 10051: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 10052: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 10053: }
1.1316 raeburn 10054:
10055: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 10056: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
10057: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
10058: $args->{'no_primary_menu'} = 1;
10059: }
10060: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
10061: $args->{'no_inline_menu'} = 1;
10062: }
10063: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
10064: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
10065: }
10066: } else {
10067: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10068: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
10069: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
10070: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
10071: $args->{'no_primary_menu'} = 1;
10072: }
10073: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
10074: $args->{'no_inline_menu'} = 1;
10075: }
10076: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
10077: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
10078: }
10079: }
10080: }
1.1316 raeburn 10081: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
10082: $env{'course.'.$env{'request.course.id'}.'.domain'},
10083: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 10084: } elsif ($env{'request.course.id'}) {
10085: my $expiretime=600;
10086: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
10087: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
10088: }
10089: my ($deeplinkmenu,$menuref);
10090: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
10091: if ($menucoll) {
10092: if (ref($menuref) eq 'HASH') {
10093: %menu = %{$menuref};
10094: }
10095: if ($menu{'top'} eq 'n') {
10096: $args->{'no_primary_menu'} = 1;
10097: }
10098: if ($menu{'inline'} eq 'n') {
10099: unless (&Apache::lonnet::allowed('opa')) {
10100: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10101: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10102: my $crstype = &course_type();
10103: my $now = time;
10104: my $ccrole;
10105: if ($crstype eq 'Community') {
10106: $ccrole = 'co';
10107: } else {
10108: $ccrole = 'cc';
10109: }
10110: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
10111: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
10112: if ((($start) && ($start<0)) ||
10113: (($end) && ($end<$now)) ||
10114: (($start) && ($now<$start))) {
10115: $args->{'no_inline_menu'} = 1;
10116: }
10117: } else {
10118: $args->{'no_inline_menu'} = 1;
10119: }
10120: }
10121: }
10122: }
1.1316 raeburn 10123: }
1.1359 raeburn 10124:
1.1385 raeburn 10125: my $showncrumbs;
1.338 albertel 10126: if (! exists($args->{'skip_phases'}{'body'}) ) {
10127: if ($args->{'frameset'}) {
10128: my $attr_string = &make_attr_string($args->{'force_register'},
10129: $args->{'add_entries'});
10130: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 10131: } else {
10132: $result .=
10133: &bodytag($title,
10134: $args->{'function'}, $args->{'add_entries'},
10135: $args->{'only_body'}, $args->{'domain'},
10136: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 10137: $args->{'bgcolor'}, $args,
1.1385 raeburn 10138: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
10139: \%menu,\$showncrumbs);
1.831 bisitz 10140: }
1.330 albertel 10141: }
1.338 albertel 10142:
1.315 albertel 10143: if ($args->{'js_ready'}) {
1.713 kaisler 10144: $result = &js_ready($result);
1.315 albertel 10145: }
1.320 albertel 10146: if ($args->{'html_encode'}) {
1.713 kaisler 10147: $result = &html_encode($result);
10148: }
10149:
1.813 bisitz 10150: # Preparation for new and consistent functionlist at top of screen
10151: # if ($args->{'functionlist'}) {
10152: # $result .= &build_functionlist();
10153: #}
10154:
1.964 droeschl 10155: # Don't add anything more if only_body wanted or in const space
10156: return $result if $args->{'only_body'}
10157: || $env{'request.state'} eq 'construct';
1.813 bisitz 10158:
10159: #Breadcrumbs
1.758 kaisler 10160: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10161: unless ($showncrumbs) {
1.758 kaisler 10162: &Apache::lonhtmlcommon::clear_breadcrumbs();
10163: #if any br links exists, add them to the breadcrumbs
10164: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10165: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10166: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10167: }
10168: }
1.1096 raeburn 10169: # if @advtools array contains items add then to the breadcrumbs
10170: if (@advtools > 0) {
10171: &Apache::lonmenu::advtools_crumbs(@advtools);
10172: }
1.1272 raeburn 10173: my $menulink;
10174: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10175: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10176: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10177: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10178: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10179: (!$env{'request.role.adv'}))) {
10180: $menulink = 0;
10181: } else {
10182: undef($menulink);
10183: }
1.1385 raeburn 10184: my $linkprotout;
10185: if ($env{'request.deeplink.login'}) {
10186: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10187: if ($linkprotout) {
10188: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10189: }
10190: }
1.758 kaisler 10191: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10192: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10193: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10194: '',$menulink,'',
10195: $args->{'bread_crumbs_style'});
1.1237 raeburn 10196: } else {
1.1437 raeburn 10197: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10198: $args->{'bread_crumbs_style'});
1.758 kaisler 10199: }
1.1385 raeburn 10200: }
1.320 albertel 10201: }
1.315 albertel 10202: return $result;
1.306 albertel 10203: }
10204:
10205: sub end_page {
1.315 albertel 10206: my ($args) = @_;
10207: $env{'internal.end_page'}++;
1.330 albertel 10208: my $result;
1.335 albertel 10209: if ($args->{'discussion'}) {
10210: my ($target,$parser);
10211: if (ref($args->{'discussion'})) {
10212: ($target,$parser) =($args->{'discussion'}{'target'},
10213: $args->{'discussion'}{'parser'});
10214: }
10215: $result .= &Apache::lonxml::xmlend($target,$parser);
10216: }
1.330 albertel 10217: if ($args->{'frameset'}) {
10218: $result .= '</frameset>';
10219: } else {
1.635 raeburn 10220: $result .= &endbodytag($args);
1.330 albertel 10221: }
1.1080 raeburn 10222: unless ($args->{'notbody'}) {
10223: $result .= "\n</html>";
10224: }
1.330 albertel 10225:
1.315 albertel 10226: if ($args->{'js_ready'}) {
1.317 albertel 10227: $result = &js_ready($result);
1.315 albertel 10228: }
1.335 albertel 10229:
1.320 albertel 10230: if ($args->{'html_encode'}) {
10231: $result = &html_encode($result);
10232: }
1.335 albertel 10233:
1.315 albertel 10234: return $result;
10235: }
10236:
1.1359 raeburn 10237: sub menucoll_in_effect {
10238: my ($menucoll,$deeplinkmenu,%menu);
10239: if ($env{'request.course.id'}) {
10240: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10241: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10242: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10243: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10244: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10245: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10246: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10247: my $navmap = Apache::lonnavmaps::navmap->new();
10248: if (ref($navmap)) {
10249: $deeplink = $navmap->get_mapparam(undef,
10250: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10251: '0.deeplink');
1.1370 raeburn 10252: } else {
10253: $check_login_symb = 1;
1.1362 raeburn 10254: }
10255: } else {
1.1370 raeburn 10256: my $symb = &Apache::lonnet::symbread();
10257: if ($symb) {
10258: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10259: } else {
10260: $check_login_symb = 1;
10261: }
1.1362 raeburn 10262: }
10263: } else {
1.1370 raeburn 10264: $check_login_symb = 1;
10265: }
10266: if ($check_login_symb) {
1.1362 raeburn 10267: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10268: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10269: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10270: my $navmap = Apache::lonnavmaps::navmap->new();
10271: if (ref($navmap)) {
10272: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10273: }
10274: } else {
10275: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10276: }
10277: }
1.1359 raeburn 10278: if ($deeplink ne '') {
1.1378 raeburn 10279: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10280: if ($display =~ /^\d+$/) {
10281: $deeplinkmenu = 1;
10282: $menucoll = $display;
10283: }
10284: }
10285: }
10286: if ($menucoll) {
10287: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10288: }
10289: }
10290: return ($menucoll,$deeplinkmenu,\%menu);
10291: }
10292:
1.1362 raeburn 10293: sub deeplink_login_symb {
10294: my ($cnum,$cdom) = @_;
10295: my $login_symb;
10296: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10297: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10298: }
10299: return $login_symb;
10300: }
10301:
10302: sub symb_from_tinyurl {
10303: my ($url,$cnum,$cdom) = @_;
10304: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10305: my $key = $1;
10306: my ($tinyurl,$login);
10307: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10308: if (defined($cached)) {
10309: $tinyurl = $result;
10310: } else {
10311: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10312: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10313: if ($currtiny{$key} ne '') {
10314: $tinyurl = $currtiny{$key};
10315: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10316: }
1.1364 raeburn 10317: }
10318: if ($tinyurl ne '') {
10319: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10320: if (wantarray) {
10321: return ($cnumreq,$symb);
10322: } elsif ($cnumreq eq $cnum) {
10323: return $symb;
1.1362 raeburn 10324: }
10325: }
10326: }
1.1364 raeburn 10327: if (wantarray) {
10328: return ();
10329: } else {
10330: return;
10331: }
1.1362 raeburn 10332: }
10333:
1.1405 raeburn 10334: sub usable_exttools {
10335: my %tooltypes;
10336: if ($env{'request.course.id'}) {
10337: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10338: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10339: %tooltypes = (
10340: crs => 1,
10341: dom => 1,
10342: );
10343: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10344: $tooltypes{'crs'} = 1;
10345: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10346: $tooltypes{'dom'} = 1;
10347: }
10348: } else {
10349: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10350: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10351: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10352: if ($crstype eq '') {
10353: $crstype = 'course';
10354: }
10355: if ($crstype eq 'course') {
10356: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10357: $crstype = 'official';
10358: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10359: $crstype = 'textbook';
10360: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10361: $crstype = 'lti';
10362: } else {
10363: $crstype = 'unofficial';
10364: }
10365: }
10366: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10367: if ($domdefaults{$crstype.'domexttool'}) {
10368: $tooltypes{'dom'} = 1;
10369: }
10370: if ($domdefaults{$crstype.'exttool'}) {
10371: $tooltypes{'crs'} = 1;
10372: }
10373: }
10374: }
10375: return %tooltypes;
10376: }
10377:
1.1034 www 10378: sub wishlist_window {
10379: return(<<'ENDWISHLIST');
1.1046 raeburn 10380: <script type="text/javascript">
1.1034 www 10381: // <![CDATA[
10382: // <!-- BEGIN LON-CAPA Internal
10383: function set_wishlistlink(title, path) {
10384: if (!title) {
10385: title = document.title;
10386: title = title.replace(/^LON-CAPA /,'');
10387: }
1.1175 raeburn 10388: title = encodeURIComponent(title);
1.1203 raeburn 10389: title = title.replace("'","\\\'");
1.1034 www 10390: if (!path) {
10391: path = location.pathname;
10392: }
1.1175 raeburn 10393: path = encodeURIComponent(path);
1.1203 raeburn 10394: path = path.replace("'","\\\'");
1.1034 www 10395: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10396: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10397: }
10398: // END LON-CAPA Internal -->
10399: // ]]>
10400: </script>
10401: ENDWISHLIST
10402: }
10403:
1.1030 www 10404: sub modal_window {
10405: return(<<'ENDMODAL');
1.1046 raeburn 10406: <script type="text/javascript">
1.1030 www 10407: // <![CDATA[
10408: // <!-- BEGIN LON-CAPA Internal
10409: var modalWindow = {
10410: parent:"body",
10411: windowId:null,
10412: content:null,
10413: width:null,
10414: height:null,
10415: close:function()
10416: {
10417: $(".LCmodal-window").remove();
10418: $(".LCmodal-overlay").remove();
10419: },
10420: open:function()
10421: {
10422: var modal = "";
10423: modal += "<div class=\"LCmodal-overlay\"></div>";
10424: 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;\">";
10425: modal += this.content;
10426: modal += "</div>";
10427:
10428: $(this.parent).append(modal);
10429:
10430: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10431: $(".LCclose-window").click(function(){modalWindow.close();});
10432: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10433: }
10434: };
1.1140 raeburn 10435: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10436: {
1.1266 raeburn 10437: source = source.replace(/'/g,"'");
1.1030 www 10438: modalWindow.windowId = "myModal";
10439: modalWindow.width = width;
10440: modalWindow.height = height;
1.1196 raeburn 10441: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10442: modalWindow.open();
1.1208 raeburn 10443: };
1.1030 www 10444: // END LON-CAPA Internal -->
10445: // ]]>
10446: </script>
10447: ENDMODAL
10448: }
10449:
10450: sub modal_link {
1.1140 raeburn 10451: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10452: unless ($width) { $width=480; }
10453: unless ($height) { $height=400; }
1.1031 www 10454: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10455: unless ($transparency) { $transparency='true'; }
10456:
1.1074 raeburn 10457: my $target_attr;
10458: if (defined($target)) {
10459: $target_attr = 'target="'.$target.'"';
10460: }
10461: return <<"ENDLINK";
1.1336 raeburn 10462: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10463: ENDLINK
1.1030 www 10464: }
10465:
1.1032 www 10466: sub modal_adhoc_script {
1.1365 raeburn 10467: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10468: my $mathjax;
10469: if ($possmathjax) {
10470: $mathjax = <<'ENDJAX';
10471: if (typeof MathJax == 'object') {
10472: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10473: }
10474: ENDJAX
10475: }
1.1032 www 10476: return (<<ENDADHOC);
1.1046 raeburn 10477: <script type="text/javascript">
1.1032 www 10478: // <![CDATA[
10479: var $funcname = function()
10480: {
10481: modalWindow.windowId = "myModal";
10482: modalWindow.width = $width;
10483: modalWindow.height = $height;
10484: modalWindow.content = '$content';
10485: modalWindow.open();
1.1365 raeburn 10486: $mathjax
1.1032 www 10487: };
10488: // ]]>
10489: </script>
10490: ENDADHOC
10491: }
10492:
1.1041 www 10493: sub modal_adhoc_inner {
1.1365 raeburn 10494: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10495: my $innerwidth=$width-20;
10496: $content=&js_ready(
1.1140 raeburn 10497: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10498: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10499: $content.
1.1041 www 10500: &end_scrollbox().
1.1140 raeburn 10501: &end_page()
1.1041 www 10502: );
1.1365 raeburn 10503: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10504: }
10505:
10506: sub modal_adhoc_window {
1.1365 raeburn 10507: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10508: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10509: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10510: }
10511:
10512: sub modal_adhoc_launch {
10513: my ($funcname,$width,$height,$content)=@_;
10514: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10515: <script type="text/javascript">
10516: // <![CDATA[
10517: $funcname();
10518: // ]]>
10519: </script>
10520: ENDLAUNCH
10521: }
10522:
10523: sub modal_adhoc_close {
10524: return (<<ENDCLOSE);
10525: <script type="text/javascript">
10526: // <![CDATA[
10527: modalWindow.close();
10528: // ]]>
10529: </script>
10530: ENDCLOSE
10531: }
10532:
1.1038 www 10533: sub togglebox_script {
10534: return(<<ENDTOGGLE);
10535: <script type="text/javascript">
10536: // <![CDATA[
10537: function LCtoggleDisplay(id,hidetext,showtext) {
10538: link = document.getElementById(id + "link").childNodes[0];
10539: with (document.getElementById(id).style) {
10540: if (display == "none" ) {
10541: display = "inline";
10542: link.nodeValue = hidetext;
10543: } else {
10544: display = "none";
10545: link.nodeValue = showtext;
10546: }
10547: }
10548: }
10549: // ]]>
10550: </script>
10551: ENDTOGGLE
10552: }
10553:
1.1039 www 10554: sub start_togglebox {
10555: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10556: unless ($heading) { $heading=''; } else { $heading.=' '; }
10557: unless ($showtext) { $showtext=&mt('show'); }
10558: unless ($hidetext) { $hidetext=&mt('hide'); }
10559: unless ($headerbg) { $headerbg='#FFFFFF'; }
10560: return &start_data_table().
10561: &start_data_table_header_row().
10562: '<td bgcolor="'.$headerbg.'">'.$heading.
10563: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10564: $showtext.'\')">'.$showtext.'</a>]</td>'.
10565: &end_data_table_header_row().
10566: '<tr id="'.$id.'" style="display:none""><td>';
10567: }
10568:
10569: sub end_togglebox {
10570: return '</td></tr>'.&end_data_table();
10571: }
10572:
1.1041 www 10573: sub LCprogressbar_script {
1.1302 raeburn 10574: my ($id,$number_to_do)=@_;
10575: if ($number_to_do) {
10576: return(<<ENDPROGRESS);
1.1041 www 10577: <script type="text/javascript">
10578: // <![CDATA[
1.1045 www 10579: \$('#progressbar$id').progressbar({
1.1041 www 10580: value: 0,
10581: change: function(event, ui) {
10582: var newVal = \$(this).progressbar('option', 'value');
10583: \$('.pblabel', this).text(LCprogressTxt);
10584: }
10585: });
10586: // ]]>
10587: </script>
10588: ENDPROGRESS
1.1302 raeburn 10589: } else {
10590: return(<<ENDPROGRESS);
10591: <script type="text/javascript">
10592: // <![CDATA[
10593: \$('#progressbar$id').progressbar({
10594: value: false,
10595: create: function(event, ui) {
10596: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10597: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10598: }
10599: });
10600: // ]]>
10601: </script>
10602: ENDPROGRESS
10603: }
1.1041 www 10604: }
10605:
10606: sub LCprogressbarUpdate_script {
10607: return(<<ENDPROGRESSUPDATE);
10608: <style type="text/css">
10609: .ui-progressbar { position:relative; }
1.1302 raeburn 10610: .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 10611: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10612: </style>
10613: <script type="text/javascript">
10614: // <![CDATA[
1.1045 www 10615: var LCprogressTxt='---';
10616:
1.1302 raeburn 10617: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10618: LCprogressTxt=progresstext;
1.1302 raeburn 10619: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10620: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10621: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10622: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10623: } else {
10624: \$('#progressbar'+id).progressbar('value',percent);
10625: }
1.1041 www 10626: }
10627: // ]]>
10628: </script>
10629: ENDPROGRESSUPDATE
10630: }
10631:
1.1042 www 10632: my $LClastpercent;
1.1045 www 10633: my $LCidcnt;
10634: my $LCcurrentid;
1.1042 www 10635:
1.1041 www 10636: sub LCprogressbar {
1.1302 raeburn 10637: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10638: $LClastpercent=0;
1.1045 www 10639: $LCidcnt++;
10640: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10641: my ($starting,$content);
10642: if ($number_to_do) {
10643: $starting=&mt('Starting');
10644: $content=(<<ENDPROGBAR);
10645: $preamble
1.1045 www 10646: <div id="progressbar$LCcurrentid">
1.1041 www 10647: <span class="pblabel">$starting</span>
10648: </div>
10649: ENDPROGBAR
1.1302 raeburn 10650: } else {
10651: $starting=&mt('Loading...');
10652: $LClastpercent='false';
10653: $content=(<<ENDPROGBAR);
10654: $preamble
10655: <div id="progressbar$LCcurrentid">
10656: <div class="progress-label">$starting</div>
10657: </div>
10658: ENDPROGBAR
10659: }
10660: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10661: }
10662:
10663: sub LCprogressbarUpdate {
1.1302 raeburn 10664: my ($r,$val,$text,$number_to_do)=@_;
10665: if ($number_to_do) {
10666: unless ($val) {
10667: if ($LClastpercent) {
10668: $val=$LClastpercent;
10669: } else {
10670: $val=0;
10671: }
10672: }
10673: if ($val<0) { $val=0; }
10674: if ($val>100) { $val=0; }
10675: $LClastpercent=$val;
10676: unless ($text) { $text=$val.'%'; }
10677: } else {
10678: $val = 'false';
1.1042 www 10679: }
1.1041 www 10680: $text=&js_ready($text);
1.1044 www 10681: &r_print($r,<<ENDUPDATE);
1.1041 www 10682: <script type="text/javascript">
10683: // <![CDATA[
1.1302 raeburn 10684: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10685: // ]]>
10686: </script>
10687: ENDUPDATE
1.1035 www 10688: }
10689:
1.1042 www 10690: sub LCprogressbarClose {
10691: my ($r)=@_;
10692: $LClastpercent=0;
1.1044 www 10693: &r_print($r,<<ENDCLOSE);
1.1042 www 10694: <script type="text/javascript">
10695: // <![CDATA[
1.1045 www 10696: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10697: // ]]>
10698: </script>
10699: ENDCLOSE
1.1044 www 10700: }
10701:
10702: sub r_print {
10703: my ($r,$to_print)=@_;
10704: if ($r) {
10705: $r->print($to_print);
10706: $r->rflush();
10707: } else {
10708: print($to_print);
10709: }
1.1042 www 10710: }
10711:
1.320 albertel 10712: sub html_encode {
10713: my ($result) = @_;
10714:
1.322 albertel 10715: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10716:
10717: return $result;
10718: }
1.1044 www 10719:
1.317 albertel 10720: sub js_ready {
10721: my ($result) = @_;
10722:
1.323 albertel 10723: $result =~ s/[\n\r]/ /xmsg;
10724: $result =~ s/\\/\\\\/xmsg;
10725: $result =~ s/'/\\'/xmsg;
1.372 albertel 10726: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10727:
10728: return $result;
10729: }
10730:
1.315 albertel 10731: sub validate_page {
10732: if ( exists($env{'internal.start_page'})
1.316 albertel 10733: && $env{'internal.start_page'} > 1) {
10734: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10735: $env{'internal.start_page'}.' '.
1.316 albertel 10736: $ENV{'request.filename'});
1.315 albertel 10737: }
10738: if ( exists($env{'internal.end_page'})
1.316 albertel 10739: && $env{'internal.end_page'} > 1) {
10740: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10741: $env{'internal.end_page'}.' '.
1.316 albertel 10742: $env{'request.filename'});
1.315 albertel 10743: }
10744: if ( exists($env{'internal.start_page'})
10745: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10746: &Apache::lonnet::logthis('start_page called without end_page '.
10747: $env{'request.filename'});
1.315 albertel 10748: }
10749: if ( ! exists($env{'internal.start_page'})
10750: && exists($env{'internal.end_page'})) {
1.316 albertel 10751: &Apache::lonnet::logthis('end_page called without start_page'.
10752: $env{'request.filename'});
1.315 albertel 10753: }
1.306 albertel 10754: }
1.315 albertel 10755:
1.996 www 10756:
10757: sub start_scrollbox {
1.1140 raeburn 10758: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10759: unless ($outerwidth) { $outerwidth='520px'; }
10760: unless ($width) { $width='500px'; }
10761: unless ($height) { $height='200px'; }
1.1075 raeburn 10762: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10763: if ($id ne '') {
1.1140 raeburn 10764: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10765: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10766: }
1.1075 raeburn 10767: if ($bgcolor ne '') {
10768: $tdcol = "background-color: $bgcolor;";
10769: }
1.1137 raeburn 10770: my $nicescroll_js;
10771: if ($env{'browser.mobile'}) {
1.1140 raeburn 10772: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10773: }
10774: return <<"END";
10775: $nicescroll_js
10776:
10777: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10778: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10779: END
10780: }
10781:
10782: sub end_scrollbox {
10783: return '</div></td></tr></table>';
10784: }
10785:
10786: sub nicescroll_javascript {
10787: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10788: my %options;
10789: if (ref($cursor) eq 'HASH') {
10790: %options = %{$cursor};
10791: }
10792: unless ($options{'railalign'} =~ /^left|right$/) {
10793: $options{'railalign'} = 'left';
10794: }
10795: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10796: my $function = &get_users_function();
10797: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10798: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10799: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10800: }
1.1140 raeburn 10801: }
10802: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10803: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10804: $options{'cursoropacity'}='1.0';
10805: }
1.1140 raeburn 10806: } else {
10807: $options{'cursoropacity'}='1.0';
10808: }
10809: if ($options{'cursorfixedheight'} eq 'none') {
10810: delete($options{'cursorfixedheight'});
10811: } else {
10812: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10813: }
10814: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10815: delete($options{'railoffset'});
10816: }
10817: my @niceoptions;
10818: while (my($key,$value) = each(%options)) {
10819: if ($value =~ /^\{.+\}$/) {
10820: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10821: } else {
1.1140 raeburn 10822: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10823: }
1.1140 raeburn 10824: }
10825: my $nicescroll_js = '
1.1137 raeburn 10826: $(document).ready(
1.1140 raeburn 10827: function() {
10828: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10829: }
1.1137 raeburn 10830: );
10831: ';
1.1140 raeburn 10832: if ($framecheck) {
10833: $nicescroll_js .= '
10834: function expand_div(caller) {
10835: if (top === self) {
10836: document.getElementById("'.$id.'").style.width = "auto";
10837: document.getElementById("'.$id.'").style.height = "auto";
10838: } else {
10839: try {
10840: if (parent.frames) {
10841: if (parent.frames.length > 1) {
10842: var framesrc = parent.frames[1].location.href;
10843: var currsrc = framesrc.replace(/\#.*$/,"");
10844: if ((caller == "search") || (currsrc == "'.$location.'")) {
10845: document.getElementById("'.$id.'").style.width = "auto";
10846: document.getElementById("'.$id.'").style.height = "auto";
10847: }
10848: }
10849: }
10850: } catch (e) {
10851: return;
10852: }
1.1137 raeburn 10853: }
1.1140 raeburn 10854: return;
1.996 www 10855: }
1.1140 raeburn 10856: ';
10857: }
10858: if ($needjsready) {
10859: $nicescroll_js = '
10860: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10861: } else {
10862: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10863: }
10864: return $nicescroll_js;
1.996 www 10865: }
10866:
1.318 albertel 10867: sub simple_error_page {
1.1150 bisitz 10868: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10869: my %displayargs;
1.1151 raeburn 10870: if (ref($args) eq 'HASH') {
10871: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10872: if ($args->{'only_body'}) {
10873: $displayargs{'only_body'} = 1;
10874: }
10875: if ($args->{'no_nav_bar'}) {
10876: $displayargs{'no_nav_bar'} = 1;
10877: }
1.1151 raeburn 10878: } else {
10879: $msg = &mt($msg);
10880: }
1.1150 bisitz 10881:
1.318 albertel 10882: my $page =
1.1459 raeburn 10883: &Apache::loncommon::start_page($title,'',\%displayargs)."\n".
1.1460 raeburn 10884: '<div class="LC_landmark" style="clear:both" role="main">'.
1.1150 bisitz 10885: '<p class="LC_error">'.$msg.'</p>'.
1.1459 raeburn 10886: '</div>'.
1.318 albertel 10887: &Apache::loncommon::end_page();
10888: if (ref($r)) {
10889: $r->print($page);
1.327 albertel 10890: return;
1.318 albertel 10891: }
10892: return $page;
10893: }
1.347 albertel 10894:
10895: {
1.610 albertel 10896: my @row_count;
1.961 onken 10897:
10898: sub start_data_table_count {
10899: unshift(@row_count, 0);
10900: return;
10901: }
10902:
10903: sub end_data_table_count {
10904: shift(@row_count);
10905: return;
10906: }
10907:
1.1466 raeburn 10908: sub set_data_table_count {
10909: my ($count) = @_;
10910: unshift(@row_count,$count);
10911: }
10912:
1.347 albertel 10913: sub start_data_table {
1.1018 raeburn 10914: my ($add_class,$id) = @_;
1.422 albertel 10915: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10916: my $table_id;
10917: if (defined($id)) {
10918: $table_id = ' id="'.$id.'"';
10919: }
1.961 onken 10920: &start_data_table_count();
1.1018 raeburn 10921: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10922: }
10923:
10924: sub end_data_table {
1.961 onken 10925: &end_data_table_count();
1.389 albertel 10926: return '</table>'."\n";;
1.347 albertel 10927: }
10928:
10929: sub start_data_table_row {
1.974 wenzelju 10930: my ($add_class, $id) = @_;
1.610 albertel 10931: $row_count[0]++;
10932: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10933: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10934: $id = (' id="'.$id.'"') unless ($id eq '');
10935: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10936: }
1.471 banghart 10937:
10938: sub continue_data_table_row {
1.974 wenzelju 10939: my ($add_class, $id) = @_;
1.610 albertel 10940: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10941: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10942: $id = (' id="'.$id.'"') unless ($id eq '');
10943: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10944: }
1.347 albertel 10945:
10946: sub end_data_table_row {
1.389 albertel 10947: return '</tr>'."\n";;
1.347 albertel 10948: }
1.367 www 10949:
1.421 albertel 10950: sub start_data_table_empty_row {
1.707 bisitz 10951: # $row_count[0]++;
1.421 albertel 10952: return '<tr class="LC_empty_row" >'."\n";;
10953: }
10954:
10955: sub end_data_table_empty_row {
10956: return '</tr>'."\n";;
10957: }
10958:
1.367 www 10959: sub start_data_table_header_row {
1.1465 raeburn 10960: my ($add_class,$id) = @_;
10961: my $css_class = 'LC_header_row';
10962: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10963: $id = (' id="'.$id.'"') unless ($id eq '');
10964: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.367 www 10965: }
10966:
10967: sub end_data_table_header_row {
1.389 albertel 10968: return '</tr>'."\n";;
1.367 www 10969: }
1.890 droeschl 10970:
10971: sub data_table_caption {
1.1468 ! raeburn 10972: my ($caption,$css_class) = @_;
! 10973: return "<caption class=\"LC_caption $css_class\">$caption</caption>";
1.890 droeschl 10974: }
1.347 albertel 10975: }
10976:
1.548 albertel 10977: =pod
10978:
10979: =item * &inhibit_menu_check($arg)
10980:
10981: Checks for a inhibitmenu state and generates output to preserve it
10982:
10983: Inputs: $arg - can be any of
10984: - undef - in which case the return value is a string
10985: to add into arguments list of a uri
10986: - 'input' - in which case the return value is a HTML
10987: <form> <input> field of type hidden to
10988: preserve the value
10989: - a url - in which case the return value is the url with
10990: the neccesary cgi args added to preserve the
10991: inhibitmenu state
10992: - a ref to a url - no return value, but the string is
10993: updated to include the neccessary cgi
10994: args to preserve the inhibitmenu state
10995:
10996: =cut
10997:
10998: sub inhibit_menu_check {
10999: my ($arg) = @_;
11000: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
11001: if ($arg eq 'input') {
11002: if ($env{'form.inhibitmenu'}) {
11003: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
11004: } else {
11005: return
11006: }
11007: }
11008: if ($env{'form.inhibitmenu'}) {
11009: if (ref($arg)) {
11010: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
11011: } elsif ($arg eq '') {
11012: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
11013: } else {
11014: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
11015: }
11016: }
11017: if (!ref($arg)) {
11018: return $arg;
11019: }
11020: }
11021:
1.251 albertel 11022: ###############################################
1.182 matthew 11023:
11024: =pod
11025:
1.549 albertel 11026: =back
11027:
11028: =head1 User Information Routines
11029:
11030: =over 4
11031:
1.405 albertel 11032: =item * &get_users_function()
1.182 matthew 11033:
11034: Used by &bodytag to determine the current users primary role.
11035: Returns either 'student','coordinator','admin', or 'author'.
11036:
11037: =cut
11038:
11039: ###############################################
11040: sub get_users_function {
1.815 tempelho 11041: my $function = 'norole';
1.818 tempelho 11042: if ($env{'request.role'}=~/^(st)/) {
11043: $function='student';
11044: }
1.907 raeburn 11045: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 11046: $function='coordinator';
11047: }
1.258 albertel 11048: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 11049: $function='admin';
11050: }
1.826 bisitz 11051: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 11052: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 11053: $function='author';
11054: }
11055: return $function;
1.54 www 11056: }
1.99 www 11057:
11058: ###############################################
11059:
1.233 raeburn 11060: =pod
11061:
1.821 raeburn 11062: =item * &show_course()
11063:
11064: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
11065: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
11066:
11067: Inputs:
11068: None
11069:
11070: Outputs:
11071: Scalar: 1 if 'Course' to be used, 0 otherwise.
11072:
11073: =cut
11074:
11075: ###############################################
11076: sub show_course {
1.1408 raeburn 11077: my ($udom,$uname) = @_;
11078: if (($udom ne '') && ($uname ne '')) {
11079: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 11080: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 11081: return 0;
11082: } else {
11083: return 1;
11084: }
11085: }
11086: }
1.821 raeburn 11087: my $course = !$env{'user.adv'};
11088: if (!$env{'user.adv'}) {
11089: foreach my $env (keys(%env)) {
11090: next if ($env !~ m/^user\.priv\./);
11091: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
11092: $course = 0;
11093: last;
11094: }
11095: }
11096: }
11097: return $course;
11098: }
11099:
11100: ###############################################
11101:
11102: =pod
11103:
1.542 raeburn 11104: =item * &check_user_status()
1.274 raeburn 11105:
11106: Determines current status of supplied role for a
11107: specific user. Roles can be active, previous or future.
11108:
11109: Inputs:
11110: user's domain, user's username, course's domain,
1.375 raeburn 11111: course's number, optional section ID.
1.274 raeburn 11112:
11113: Outputs:
11114: role status: active, previous or future.
11115:
11116: =cut
11117:
11118: sub check_user_status {
1.412 raeburn 11119: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 11120: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 11121: my @uroles = keys(%userinfo);
1.274 raeburn 11122: my $srchstr;
11123: my $active_chk = 'none';
1.412 raeburn 11124: my $now = time;
1.274 raeburn 11125: if (@uroles > 0) {
1.908 raeburn 11126: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 11127: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
11128: } else {
1.412 raeburn 11129: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
11130: }
11131: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 11132: my $role_end = 0;
11133: my $role_start = 0;
11134: $active_chk = 'active';
1.412 raeburn 11135: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
11136: $role_end = $1;
11137: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
11138: $role_start = $1;
1.274 raeburn 11139: }
11140: }
11141: if ($role_start > 0) {
1.412 raeburn 11142: if ($now < $role_start) {
1.274 raeburn 11143: $active_chk = 'future';
11144: }
11145: }
11146: if ($role_end > 0) {
1.412 raeburn 11147: if ($now > $role_end) {
1.274 raeburn 11148: $active_chk = 'previous';
11149: }
11150: }
11151: }
11152: }
11153: return $active_chk;
11154: }
11155:
11156: ###############################################
11157:
11158: =pod
11159:
1.405 albertel 11160: =item * &get_sections()
1.233 raeburn 11161:
11162: Determines all the sections for a course including
11163: sections with students and sections containing other roles.
1.419 raeburn 11164: Incoming parameters:
11165:
11166: 1. domain
11167: 2. course number
11168: 3. reference to array containing roles for which sections should
11169: be gathered (optional).
11170: 4. reference to array containing status types for which sections
11171: should be gathered (optional).
11172:
11173: If the third argument is undefined, sections are gathered for any role.
11174: If the fourth argument is undefined, sections are gathered for any status.
11175: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11176:
1.374 raeburn 11177: Returns section hash (keys are section IDs, values are
11178: number of users in each section), subject to the
1.419 raeburn 11179: optional roles filter, optional status filter
1.233 raeburn 11180:
11181: =cut
11182:
11183: ###############################################
11184: sub get_sections {
1.419 raeburn 11185: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11186: if (!defined($cdom) || !defined($cnum)) {
11187: my $cid = $env{'request.course.id'};
11188:
11189: return if (!defined($cid));
11190:
11191: $cdom = $env{'course.'.$cid.'.domain'};
11192: $cnum = $env{'course.'.$cid.'.num'};
11193: }
11194:
11195: my %sectioncount;
1.419 raeburn 11196: my $now = time;
1.240 albertel 11197:
1.1118 raeburn 11198: my $check_students = 1;
11199: my $only_students = 0;
11200: if (ref($possible_roles) eq 'ARRAY') {
11201: if (grep(/^st$/,@{$possible_roles})) {
11202: if (@{$possible_roles} == 1) {
11203: $only_students = 1;
11204: }
11205: } else {
11206: $check_students = 0;
11207: }
11208: }
11209:
11210: if ($check_students) {
1.276 albertel 11211: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11212: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11213: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11214: my $start_index = &Apache::loncoursedata::CL_START();
11215: my $end_index = &Apache::loncoursedata::CL_END();
11216: my $status;
1.366 albertel 11217: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11218: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11219: $data->[$status_index],
11220: $data->[$start_index],
11221: $data->[$end_index]);
11222: if ($stu_status eq 'Active') {
11223: $status = 'active';
11224: } elsif ($end < $now) {
11225: $status = 'previous';
11226: } elsif ($start > $now) {
11227: $status = 'future';
11228: }
11229: if ($section ne '-1' && $section !~ /^\s*$/) {
11230: if ((!defined($possible_status)) || (($status ne '') &&
11231: (grep/^\Q$status\E$/,@{$possible_status}))) {
11232: $sectioncount{$section}++;
11233: }
1.240 albertel 11234: }
11235: }
11236: }
1.1118 raeburn 11237: if ($only_students) {
11238: return %sectioncount;
11239: }
1.240 albertel 11240: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11241: foreach my $user (sort(keys(%courseroles))) {
11242: if ($user !~ /^(\w{2})/) { next; }
11243: my ($role) = ($user =~ /^(\w{2})/);
11244: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11245: my ($section,$status);
1.240 albertel 11246: if ($role eq 'cr' &&
11247: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11248: $section=$1;
11249: }
11250: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11251: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11252: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11253: if ($end == -1 && $start == -1) {
11254: next; #deleted role
11255: }
11256: if (!defined($possible_status)) {
11257: $sectioncount{$section}++;
11258: } else {
11259: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11260: $status = 'active';
11261: } elsif ($end < $now) {
11262: $status = 'future';
11263: } elsif ($start > $now) {
11264: $status = 'previous';
11265: }
11266: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11267: $sectioncount{$section}++;
11268: }
11269: }
1.233 raeburn 11270: }
1.366 albertel 11271: return %sectioncount;
1.233 raeburn 11272: }
11273:
1.274 raeburn 11274: ###############################################
1.294 raeburn 11275:
11276: =pod
1.405 albertel 11277:
11278: =item * &get_course_users()
11279:
1.275 raeburn 11280: Retrieves usernames:domains for users in the specified course
11281: with specific role(s), and access status.
11282:
11283: Incoming parameters:
1.277 albertel 11284: 1. course domain
11285: 2. course number
11286: 3. access status: users must have - either active,
1.275 raeburn 11287: previous, future, or all.
1.277 albertel 11288: 4. reference to array of permissible roles
1.288 raeburn 11289: 5. reference to array of section restrictions (optional)
11290: 6. reference to results object (hash of hashes).
11291: 7. reference to optional userdata hash
1.609 raeburn 11292: 8. reference to optional statushash
1.630 raeburn 11293: 9. flag if privileged users (except those set to unhide in
11294: course settings) should be excluded
1.609 raeburn 11295: Keys of top level results hash are roles.
1.275 raeburn 11296: Keys of inner hashes are username:domain, with
11297: values set to access type.
1.288 raeburn 11298: Optional userdata hash returns an array with arguments in the
11299: same order as loncoursedata::get_classlist() for student data.
11300:
1.609 raeburn 11301: Optional statushash returns
11302:
1.288 raeburn 11303: Entries for end, start, section and status are blank because
11304: of the possibility of multiple values for non-student roles.
11305:
1.275 raeburn 11306: =cut
1.405 albertel 11307:
1.275 raeburn 11308: ###############################################
1.405 albertel 11309:
1.275 raeburn 11310: sub get_course_users {
1.630 raeburn 11311: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11312: my %idx = ();
1.419 raeburn 11313: my %seclists;
1.288 raeburn 11314:
11315: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11316: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11317: $idx{end} = &Apache::loncoursedata::CL_END();
11318: $idx{start} = &Apache::loncoursedata::CL_START();
11319: $idx{id} = &Apache::loncoursedata::CL_ID();
11320: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11321: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11322: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11323:
1.290 albertel 11324: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11325: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11326: my $now = time;
1.277 albertel 11327: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11328: my $match = 0;
1.412 raeburn 11329: my $secmatch = 0;
1.419 raeburn 11330: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11331: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11332: if ($section eq '') {
11333: $section = 'none';
11334: }
1.291 albertel 11335: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11336: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11337: $secmatch = 1;
11338: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11339: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11340: $secmatch = 1;
11341: }
11342: } else {
1.419 raeburn 11343: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11344: $secmatch = 1;
11345: }
1.290 albertel 11346: }
1.412 raeburn 11347: if (!$secmatch) {
11348: next;
11349: }
1.419 raeburn 11350: }
1.275 raeburn 11351: if (defined($$types{'active'})) {
1.288 raeburn 11352: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11353: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11354: $match = 1;
1.275 raeburn 11355: }
11356: }
11357: if (defined($$types{'previous'})) {
1.609 raeburn 11358: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11359: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11360: $match = 1;
1.275 raeburn 11361: }
11362: }
11363: if (defined($$types{'future'})) {
1.609 raeburn 11364: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11365: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11366: $match = 1;
1.275 raeburn 11367: }
11368: }
1.609 raeburn 11369: if ($match) {
11370: push(@{$seclists{$student}},$section);
11371: if (ref($userdata) eq 'HASH') {
11372: $$userdata{$student} = $$classlist{$student};
11373: }
11374: if (ref($statushash) eq 'HASH') {
11375: $statushash->{$student}{'st'}{$section} = $status;
11376: }
1.288 raeburn 11377: }
1.275 raeburn 11378: }
11379: }
1.412 raeburn 11380: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11381: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11382: my $now = time;
1.609 raeburn 11383: my %displaystatus = ( previous => 'Expired',
11384: active => 'Active',
11385: future => 'Future',
11386: );
1.1121 raeburn 11387: my (%nothide,@possdoms);
1.630 raeburn 11388: if ($hidepriv) {
11389: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11390: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11391: if ($user !~ /:/) {
11392: $nothide{join(':',split(/[\@]/,$user))}=1;
11393: } else {
11394: $nothide{$user} = 1;
11395: }
11396: }
1.1121 raeburn 11397: my @possdoms = ($cdom);
11398: if ($coursehash{'checkforpriv'}) {
11399: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11400: }
1.630 raeburn 11401: }
1.439 raeburn 11402: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11403: my $match = 0;
1.412 raeburn 11404: my $secmatch = 0;
1.439 raeburn 11405: my $status;
1.412 raeburn 11406: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11407: $user =~ s/:$//;
1.439 raeburn 11408: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11409: if ($end == -1 || $start == -1) {
11410: next;
11411: }
11412: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11413: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11414: my ($uname,$udom) = split(/:/,$user);
11415: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11416: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11417: $secmatch = 1;
11418: } elsif ($usec eq '') {
1.420 albertel 11419: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11420: $secmatch = 1;
11421: }
11422: } else {
11423: if (grep(/^\Q$usec\E$/,@{$sections})) {
11424: $secmatch = 1;
11425: }
11426: }
11427: if (!$secmatch) {
11428: next;
11429: }
1.288 raeburn 11430: }
1.419 raeburn 11431: if ($usec eq '') {
11432: $usec = 'none';
11433: }
1.275 raeburn 11434: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11435: if ($hidepriv) {
1.1121 raeburn 11436: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11437: (!$nothide{$uname.':'.$udom})) {
11438: next;
11439: }
11440: }
1.503 raeburn 11441: if ($end > 0 && $end < $now) {
1.439 raeburn 11442: $status = 'previous';
11443: } elsif ($start > $now) {
11444: $status = 'future';
11445: } else {
11446: $status = 'active';
11447: }
1.277 albertel 11448: foreach my $type (keys(%{$types})) {
1.275 raeburn 11449: if ($status eq $type) {
1.420 albertel 11450: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11451: push(@{$$users{$role}{$user}},$type);
11452: }
1.288 raeburn 11453: $match = 1;
11454: }
11455: }
1.419 raeburn 11456: if (($match) && (ref($userdata) eq 'HASH')) {
11457: if (!exists($$userdata{$uname.':'.$udom})) {
11458: &get_user_info($udom,$uname,\%idx,$userdata);
11459: }
1.420 albertel 11460: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11461: push(@{$seclists{$uname.':'.$udom}},$usec);
11462: }
1.609 raeburn 11463: if (ref($statushash) eq 'HASH') {
11464: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11465: }
1.275 raeburn 11466: }
11467: }
11468: }
11469: }
1.290 albertel 11470: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11471: if ((defined($cdom)) && (defined($cnum))) {
11472: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11473: if ( defined($csettings{'internal.courseowner'}) ) {
11474: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11475: next if ($owner eq '');
11476: my ($ownername,$ownerdom);
11477: if ($owner =~ /^([^:]+):([^:]+)$/) {
11478: $ownername = $1;
11479: $ownerdom = $2;
11480: } else {
11481: $ownername = $owner;
11482: $ownerdom = $cdom;
11483: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11484: }
11485: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11486: if (defined($userdata) &&
1.609 raeburn 11487: !exists($$userdata{$owner})) {
11488: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11489: if (!grep(/^none$/,@{$seclists{$owner}})) {
11490: push(@{$seclists{$owner}},'none');
11491: }
11492: if (ref($statushash) eq 'HASH') {
11493: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11494: }
1.290 albertel 11495: }
1.279 raeburn 11496: }
11497: }
11498: }
1.419 raeburn 11499: foreach my $user (keys(%seclists)) {
11500: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11501: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11502: }
1.275 raeburn 11503: }
11504: return;
11505: }
11506:
1.288 raeburn 11507: sub get_user_info {
11508: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11509: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11510: &plainname($uname,$udom,'lastname');
1.291 albertel 11511: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11512: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11513: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11514: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11515: return;
11516: }
1.275 raeburn 11517:
1.472 raeburn 11518: ###############################################
11519:
11520: =pod
11521:
11522: =item * &get_user_quota()
11523:
1.1134 raeburn 11524: Retrieves quota assigned for storage of user files.
11525: Default is to report quota for portfolio files.
1.472 raeburn 11526:
11527: Incoming parameters:
11528: 1. user's username
11529: 2. user's domain
1.1134 raeburn 11530: 3. quota name - portfolio, author, or course
1.1136 raeburn 11531: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11532: 4. crstype - official, unofficial, textbook, placement or community,
11533: if quota name is course
1.472 raeburn 11534:
11535: Returns:
1.1163 raeburn 11536: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11537: 2. (Optional) Type of setting: custom or default
11538: (individually assigned or default for user's
11539: institutional status).
11540: 3. (Optional) - User's institutional status (e.g., faculty, staff
11541: or student - types as defined in localenroll::inst_usertypes
11542: for user's domain, which determines default quota for user.
11543: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11544:
11545: If a value has been stored in the user's environment,
1.536 raeburn 11546: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11547: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11548:
11549: =cut
11550:
11551: ###############################################
11552:
11553:
11554: sub get_user_quota {
1.1136 raeburn 11555: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11556: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11557: if (!defined($udom)) {
11558: $udom = $env{'user.domain'};
11559: }
11560: if (!defined($uname)) {
11561: $uname = $env{'user.name'};
11562: }
11563: if (($udom eq '' || $uname eq '') ||
11564: ($udom eq 'public') && ($uname eq 'public')) {
11565: $quota = 0;
1.536 raeburn 11566: $quotatype = 'default';
11567: $defquota = 0;
1.472 raeburn 11568: } else {
1.536 raeburn 11569: my $inststatus;
1.1134 raeburn 11570: if ($quotaname eq 'course') {
11571: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11572: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11573: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11574: } else {
11575: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11576: $quota = $cenv{'internal.uploadquota'};
11577: }
1.536 raeburn 11578: } else {
1.1134 raeburn 11579: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11580: if ($quotaname eq 'author') {
11581: $quota = $env{'environment.authorquota'};
11582: } else {
11583: $quota = $env{'environment.portfolioquota'};
11584: }
11585: $inststatus = $env{'environment.inststatus'};
11586: } else {
11587: my %userenv =
11588: &Apache::lonnet::get('environment',['portfolioquota',
11589: 'authorquota','inststatus'],$udom,$uname);
11590: my ($tmp) = keys(%userenv);
11591: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11592: if ($quotaname eq 'author') {
11593: $quota = $userenv{'authorquota'};
11594: } else {
11595: $quota = $userenv{'portfolioquota'};
11596: }
11597: $inststatus = $userenv{'inststatus'};
11598: } else {
11599: undef(%userenv);
11600: }
11601: }
11602: }
11603: if ($quota eq '' || wantarray) {
11604: if ($quotaname eq 'course') {
11605: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11606: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11607: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11608: ($crstype eq 'placement')) {
1.1136 raeburn 11609: $defquota = $domdefs{$crstype.'quota'};
11610: }
11611: if ($defquota eq '') {
11612: $defquota = 500;
11613: }
1.1134 raeburn 11614: } else {
11615: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11616: }
11617: if ($quota eq '') {
11618: $quota = $defquota;
11619: $quotatype = 'default';
11620: } else {
11621: $quotatype = 'custom';
11622: }
1.472 raeburn 11623: }
11624: }
1.536 raeburn 11625: if (wantarray) {
11626: return ($quota,$quotatype,$settingstatus,$defquota);
11627: } else {
11628: return $quota;
11629: }
1.472 raeburn 11630: }
11631:
11632: ###############################################
11633:
11634: =pod
11635:
11636: =item * &default_quota()
11637:
1.536 raeburn 11638: Retrieves default quota assigned for storage of user portfolio files,
11639: given an (optional) user's institutional status.
1.472 raeburn 11640:
11641: Incoming parameters:
1.1142 raeburn 11642:
1.472 raeburn 11643: 1. domain
1.536 raeburn 11644: 2. (Optional) institutional status(es). This is a : separated list of
11645: status types (e.g., faculty, staff, student etc.)
11646: which apply to the user for whom the default is being retrieved.
11647: If the institutional status string in undefined, the domain
1.1134 raeburn 11648: default quota will be returned.
11649: 3. quota name - portfolio, author, or course
11650: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11651:
11652: Returns:
1.1142 raeburn 11653:
1.1163 raeburn 11654: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11655: 2. (Optional) institutional type which determined the value of the
11656: default quota.
1.472 raeburn 11657:
11658: If a value has been stored in the domain's configuration db,
11659: it will return that, otherwise it returns 20 (for backwards
11660: compatibility with domains which have not set up a configuration
1.1163 raeburn 11661: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11662:
1.536 raeburn 11663: If the user's status includes multiple types (e.g., staff and student),
11664: the largest default quota which applies to the user determines the
11665: default quota returned.
11666:
1.472 raeburn 11667: =cut
11668:
11669: ###############################################
11670:
11671:
11672: sub default_quota {
1.1134 raeburn 11673: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11674: my ($defquota,$settingstatus);
11675: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11676: ['quotas'],$udom);
1.1134 raeburn 11677: my $key = 'defaultquota';
11678: if ($quotaname eq 'author') {
11679: $key = 'authorquota';
11680: }
1.622 raeburn 11681: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11682: if ($inststatus ne '') {
1.765 raeburn 11683: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11684: foreach my $item (@statuses) {
1.1134 raeburn 11685: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11686: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11687: if ($defquota eq '') {
1.1134 raeburn 11688: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11689: $settingstatus = $item;
1.1134 raeburn 11690: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11691: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11692: $settingstatus = $item;
11693: }
11694: }
1.1134 raeburn 11695: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11696: if ($quotahash{'quotas'}{$item} ne '') {
11697: if ($defquota eq '') {
11698: $defquota = $quotahash{'quotas'}{$item};
11699: $settingstatus = $item;
11700: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11701: $defquota = $quotahash{'quotas'}{$item};
11702: $settingstatus = $item;
11703: }
1.536 raeburn 11704: }
11705: }
11706: }
11707: }
11708: if ($defquota eq '') {
1.1134 raeburn 11709: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11710: $defquota = $quotahash{'quotas'}{$key}{'default'};
11711: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11712: $defquota = $quotahash{'quotas'}{'default'};
11713: }
1.536 raeburn 11714: $settingstatus = 'default';
1.1139 raeburn 11715: if ($defquota eq '') {
11716: if ($quotaname eq 'author') {
11717: $defquota = 500;
11718: }
11719: }
1.536 raeburn 11720: }
11721: } else {
11722: $settingstatus = 'default';
1.1134 raeburn 11723: if ($quotaname eq 'author') {
11724: $defquota = 500;
11725: } else {
11726: $defquota = 20;
11727: }
1.536 raeburn 11728: }
11729: if (wantarray) {
11730: return ($defquota,$settingstatus);
1.472 raeburn 11731: } else {
1.536 raeburn 11732: return $defquota;
1.472 raeburn 11733: }
11734: }
11735:
1.1135 raeburn 11736: ###############################################
11737:
11738: =pod
11739:
1.1136 raeburn 11740: =item * &excess_filesize_warning()
1.1135 raeburn 11741:
11742: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11743: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11744: space to be exceeded.
1.1136 raeburn 11745:
11746: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11747: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11748:
1.1165 raeburn 11749: Inputs: 7
1.1136 raeburn 11750: 1. username or coursenum
1.1135 raeburn 11751: 2. domain
1.1136 raeburn 11752: 3. context ('author' or 'course')
1.1135 raeburn 11753: 4. filename of file for which action is being requested
11754: 5. filesize (kB) of file
11755: 6. action being taken: copy or upload.
1.1237 raeburn 11756: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11757:
11758: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11759: otherwise return null.
11760:
11761: =back
1.1135 raeburn 11762:
11763: =cut
11764:
1.1136 raeburn 11765: sub excess_filesize_warning {
1.1165 raeburn 11766: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11767: my $current_disk_usage = 0;
1.1165 raeburn 11768: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11769: if ($context eq 'author') {
11770: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11771: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11772: } else {
11773: foreach my $subdir ('docs','supplemental') {
11774: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11775: }
11776: }
1.1135 raeburn 11777: $disk_quota = int($disk_quota * 1000);
11778: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11779: return '<p class="LC_warning">'.
1.1135 raeburn 11780: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11781: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11782: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11783: $disk_quota,$current_disk_usage).
11784: '</p>';
11785: }
11786: return;
11787: }
11788:
11789: ###############################################
11790:
11791:
1.1136 raeburn 11792:
11793:
1.384 raeburn 11794: sub get_secgrprole_info {
11795: my ($cdom,$cnum,$needroles,$type) = @_;
11796: my %sections_count = &get_sections($cdom,$cnum);
11797: my @sections = (sort {$a <=> $b} keys(%sections_count));
11798: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11799: my @groups = sort(keys(%curr_groups));
11800: my $allroles = [];
11801: my $rolehash;
11802: my $accesshash = {
11803: active => 'Currently has access',
11804: future => 'Will have future access',
11805: previous => 'Previously had access',
11806: };
11807: if ($needroles) {
11808: $rolehash = {'all' => 'all'};
1.385 albertel 11809: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11810: if (&Apache::lonnet::error(%user_roles)) {
11811: undef(%user_roles);
11812: }
11813: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11814: my ($role)=split(/\:/,$item,2);
11815: if ($role eq 'cr') { next; }
11816: if ($role =~ /^cr/) {
11817: $$rolehash{$role} = (split('/',$role))[3];
11818: } else {
11819: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11820: }
11821: }
11822: foreach my $key (sort(keys(%{$rolehash}))) {
11823: push(@{$allroles},$key);
11824: }
11825: push (@{$allroles},'st');
11826: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11827: }
11828: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11829: }
11830:
1.555 raeburn 11831: sub user_picker {
1.1279 raeburn 11832: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11833: my $currdom = $dom;
1.1253 raeburn 11834: my @alldoms = &Apache::lonnet::all_domains();
11835: if (@alldoms == 1) {
11836: my %domsrch = &Apache::lonnet::get_dom('configuration',
11837: ['directorysrch'],$alldoms[0]);
11838: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11839: my $showdom = $domdesc;
11840: if ($showdom eq '') {
11841: $showdom = $dom;
11842: }
11843: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11844: if ((!$domsrch{'directorysrch'}{'available'}) &&
11845: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11846: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11847: }
11848: }
11849: }
1.555 raeburn 11850: my %curr_selected = (
11851: srchin => 'dom',
1.580 raeburn 11852: srchby => 'lastname',
1.555 raeburn 11853: );
11854: my $srchterm;
1.625 raeburn 11855: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11856: if ($srch->{'srchby'} ne '') {
11857: $curr_selected{'srchby'} = $srch->{'srchby'};
11858: }
11859: if ($srch->{'srchin'} ne '') {
11860: $curr_selected{'srchin'} = $srch->{'srchin'};
11861: }
11862: if ($srch->{'srchtype'} ne '') {
11863: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11864: }
11865: if ($srch->{'srchdomain'} ne '') {
11866: $currdom = $srch->{'srchdomain'};
11867: }
11868: $srchterm = $srch->{'srchterm'};
11869: }
1.1222 damieng 11870: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11871: 'usr' => 'Search criteria',
1.563 raeburn 11872: 'doma' => 'Domain/institution to search',
1.558 albertel 11873: 'uname' => 'username',
11874: 'lastname' => 'last name',
1.555 raeburn 11875: 'lastfirst' => 'last name, first name',
1.558 albertel 11876: 'crs' => 'in this course',
1.576 raeburn 11877: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11878: 'alc' => 'all LON-CAPA',
1.573 raeburn 11879: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11880: 'exact' => 'is',
11881: 'contains' => 'contains',
1.569 raeburn 11882: 'begins' => 'begins with',
1.1222 damieng 11883: );
11884: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11885: 'youm' => "You must include some text to search for.",
11886: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11887: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11888: 'yomc' => "You must choose a domain when using an institutional directory search.",
11889: 'ymcd' => "You must choose a domain when using a domain search.",
11890: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11891: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11892: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11893: );
1.1222 damieng 11894: &html_escape(\%html_lt);
11895: &js_escape(\%js_lt);
1.1255 raeburn 11896: my $domform;
1.1277 raeburn 11897: my $allow_blank = 1;
1.1255 raeburn 11898: if ($fixeddom) {
1.1277 raeburn 11899: $allow_blank = 0;
11900: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11901: } else {
1.1287 raeburn 11902: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11903: my ($trusted,$untrusted);
1.1287 raeburn 11904: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11905: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11906: } elsif ($context eq 'author') {
1.1288 raeburn 11907: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11908: } elsif ($context eq 'domain') {
1.1288 raeburn 11909: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11910: }
1.1288 raeburn 11911: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11912: }
1.563 raeburn 11913: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11914:
11915: my @srchins = ('crs','dom','alc','instd');
11916:
11917: foreach my $option (@srchins) {
11918: # FIXME 'alc' option unavailable until
11919: # loncreateuser::print_user_query_page()
11920: # has been completed.
11921: next if ($option eq 'alc');
1.880 raeburn 11922: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11923: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11924: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11925: if ($curr_selected{'srchin'} eq $option) {
11926: $srchinsel .= '
1.1222 damieng 11927: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11928: } else {
11929: $srchinsel .= '
1.1222 damieng 11930: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11931: }
1.555 raeburn 11932: }
1.563 raeburn 11933: $srchinsel .= "\n </select>\n";
1.555 raeburn 11934:
11935: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11936: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11937: if ($curr_selected{'srchby'} eq $option) {
11938: $srchbysel .= '
1.1222 damieng 11939: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11940: } else {
11941: $srchbysel .= '
1.1222 damieng 11942: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11943: }
11944: }
11945: $srchbysel .= "\n </select>\n";
11946:
11947: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11948: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11949: if ($curr_selected{'srchtype'} eq $option) {
11950: $srchtypesel .= '
1.1222 damieng 11951: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11952: } else {
11953: $srchtypesel .= '
1.1222 damieng 11954: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11955: }
11956: }
11957: $srchtypesel .= "\n </select>\n";
11958:
1.558 albertel 11959: my ($newuserscript,$new_user_create);
1.994 raeburn 11960: my $context_dom = $env{'request.role.domain'};
11961: if ($context eq 'requestcrs') {
11962: if ($env{'form.coursedom'} ne '') {
11963: $context_dom = $env{'form.coursedom'};
11964: }
11965: }
1.556 raeburn 11966: if ($forcenewuser) {
1.576 raeburn 11967: if (ref($srch) eq 'HASH') {
1.994 raeburn 11968: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11969: if ($cancreate) {
11970: $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>';
11971: } else {
1.799 bisitz 11972: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11973: my %usertypetext = (
11974: official => 'institutional',
11975: unofficial => 'non-institutional',
11976: );
1.799 bisitz 11977: $new_user_create = '<p class="LC_warning">'
11978: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11979: .' '
11980: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11981: ,'<a href="'.$helplink.'">','</a>')
11982: .'</p><br />';
1.627 raeburn 11983: }
1.576 raeburn 11984: }
11985: }
11986:
1.556 raeburn 11987: $newuserscript = <<"ENDSCRIPT";
11988:
1.570 raeburn 11989: function setSearch(createnew,callingForm) {
1.556 raeburn 11990: if (createnew == 1) {
1.570 raeburn 11991: for (var i=0; i<callingForm.srchby.length; i++) {
11992: if (callingForm.srchby.options[i].value == 'uname') {
11993: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11994: }
11995: }
1.570 raeburn 11996: for (var i=0; i<callingForm.srchin.length; i++) {
11997: if ( callingForm.srchin.options[i].value == 'dom') {
11998: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11999: }
12000: }
1.570 raeburn 12001: for (var i=0; i<callingForm.srchtype.length; i++) {
12002: if (callingForm.srchtype.options[i].value == 'exact') {
12003: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 12004: }
12005: }
1.570 raeburn 12006: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 12007: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 12008: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 12009: }
12010: }
12011: }
12012: }
12013: ENDSCRIPT
1.558 albertel 12014:
1.556 raeburn 12015: }
12016:
1.555 raeburn 12017: my $output = <<"END_BLOCK";
1.556 raeburn 12018: <script type="text/javascript">
1.824 bisitz 12019: // <![CDATA[
1.570 raeburn 12020: function validateEntry(callingForm) {
1.558 albertel 12021:
1.556 raeburn 12022: var checkok = 1;
1.558 albertel 12023: var srchin;
1.570 raeburn 12024: for (var i=0; i<callingForm.srchin.length; i++) {
12025: if ( callingForm.srchin[i].checked ) {
12026: srchin = callingForm.srchin[i].value;
1.558 albertel 12027: }
12028: }
12029:
1.570 raeburn 12030: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
12031: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
12032: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
12033: var srchterm = callingForm.srchterm.value;
12034: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 12035: var msg = "";
12036:
12037: if (srchterm == "") {
12038: checkok = 0;
1.1222 damieng 12039: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 12040: }
12041:
1.569 raeburn 12042: if (srchtype== 'begins') {
12043: if (srchterm.length < 2) {
12044: checkok = 0;
1.1222 damieng 12045: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 12046: }
12047: }
12048:
1.556 raeburn 12049: if (srchtype== 'contains') {
12050: if (srchterm.length < 3) {
12051: checkok = 0;
1.1222 damieng 12052: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 12053: }
12054: }
12055: if (srchin == 'instd') {
12056: if (srchdomain == '') {
12057: checkok = 0;
1.1222 damieng 12058: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 12059: }
12060: }
12061: if (srchin == 'dom') {
12062: if (srchdomain == '') {
12063: checkok = 0;
1.1222 damieng 12064: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 12065: }
12066: }
12067: if (srchby == 'lastfirst') {
12068: if (srchterm.indexOf(",") == -1) {
12069: checkok = 0;
1.1222 damieng 12070: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 12071: }
12072: if (srchterm.indexOf(",") == srchterm.length -1) {
12073: checkok = 0;
1.1222 damieng 12074: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 12075: }
12076: }
12077: if (checkok == 0) {
1.1222 damieng 12078: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 12079: return;
12080: }
12081: if (checkok == 1) {
1.570 raeburn 12082: callingForm.submit();
1.556 raeburn 12083: }
12084: }
12085:
12086: $newuserscript
12087:
1.824 bisitz 12088: // ]]>
1.556 raeburn 12089: </script>
1.558 albertel 12090:
12091: $new_user_create
12092:
1.555 raeburn 12093: END_BLOCK
1.558 albertel 12094:
1.876 raeburn 12095: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 12096: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 12097: $domform.
12098: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 12099: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 12100: $srchbysel.
12101: $srchtypesel.
12102: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
12103: $srchinsel.
12104: &Apache::lonhtmlcommon::row_closure(1).
12105: &Apache::lonhtmlcommon::end_pick_box().
12106: '<br />';
1.1253 raeburn 12107: return ($output,1);
1.555 raeburn 12108: }
12109:
1.612 raeburn 12110: sub user_rule_check {
1.615 raeburn 12111: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 12112: my ($response,%inst_response);
1.612 raeburn 12113: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 12114: if (keys(%{$usershash}) > 1) {
12115: my (%by_username,%by_id,%userdoms);
12116: my $checkid;
12117: if (ref($checks) eq 'HASH') {
12118: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
12119: $checkid = 1;
12120: }
12121: }
12122: foreach my $user (keys(%{$usershash})) {
12123: my ($uname,$udom) = split(/:/,$user);
12124: if ($checkid) {
12125: if (ref($usershash->{$user}) eq 'HASH') {
12126: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 12127: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 12128: $userdoms{$udom} = 1;
1.1227 raeburn 12129: if (ref($inst_results) eq 'HASH') {
12130: $inst_results->{$uname.':'.$udom} = {};
12131: }
1.1226 raeburn 12132: }
12133: }
12134: } else {
12135: $by_username{$udom}{$uname} = 1;
12136: $userdoms{$udom} = 1;
1.1227 raeburn 12137: if (ref($inst_results) eq 'HASH') {
12138: $inst_results->{$uname.':'.$udom} = {};
12139: }
1.1226 raeburn 12140: }
12141: }
12142: foreach my $udom (keys(%userdoms)) {
12143: if (!$got_rules->{$udom}) {
12144: my %domconfig = &Apache::lonnet::get_dom('configuration',
12145: ['usercreation'],$udom);
12146: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12147: foreach my $item ('username','id') {
12148: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 12149: $$curr_rules{$udom}{$item} =
12150: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 12151: }
12152: }
12153: }
12154: $got_rules->{$udom} = 1;
12155: }
1.612 raeburn 12156: }
1.1226 raeburn 12157: if ($checkid) {
12158: foreach my $udom (keys(%by_id)) {
12159: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12160: if ($outcome eq 'ok') {
1.1227 raeburn 12161: foreach my $id (keys(%{$by_id{$udom}})) {
12162: my $uname = $by_id{$udom}{$id};
12163: $inst_response{$uname.':'.$udom} = $outcome;
12164: }
1.1226 raeburn 12165: if (ref($results) eq 'HASH') {
12166: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12167: if (exists($inst_response{$uname.':'.$udom})) {
12168: $inst_response{$uname.':'.$udom} = $outcome;
12169: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12170: }
1.1226 raeburn 12171: }
12172: }
12173: }
1.612 raeburn 12174: }
1.615 raeburn 12175: } else {
1.1226 raeburn 12176: foreach my $udom (keys(%by_username)) {
12177: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12178: if ($outcome eq 'ok') {
1.1227 raeburn 12179: foreach my $uname (keys(%{$by_username{$udom}})) {
12180: $inst_response{$uname.':'.$udom} = $outcome;
12181: }
1.1226 raeburn 12182: if (ref($results) eq 'HASH') {
12183: foreach my $uname (keys(%{$results})) {
12184: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12185: }
12186: }
12187: }
12188: }
1.612 raeburn 12189: }
1.1226 raeburn 12190: } elsif (keys(%{$usershash}) == 1) {
12191: my $user = (keys(%{$usershash}))[0];
12192: my ($uname,$udom) = split(/:/,$user);
12193: if (($udom ne '') && ($uname ne '')) {
12194: if (ref($usershash->{$user}) eq 'HASH') {
12195: if (ref($checks) eq 'HASH') {
12196: if (defined($checks->{'username'})) {
12197: ($inst_response{$user},%{$inst_results->{$user}}) =
12198: &Apache::lonnet::get_instuser($udom,$uname);
12199: } elsif (defined($checks->{'id'})) {
12200: if ($usershash->{$user}->{'id'} ne '') {
12201: ($inst_response{$user},%{$inst_results->{$user}}) =
12202: &Apache::lonnet::get_instuser($udom,undef,
12203: $usershash->{$user}->{'id'});
12204: } else {
12205: ($inst_response{$user},%{$inst_results->{$user}}) =
12206: &Apache::lonnet::get_instuser($udom,$uname);
12207: }
1.585 raeburn 12208: }
1.1226 raeburn 12209: } else {
12210: ($inst_response{$user},%{$inst_results->{$user}}) =
12211: &Apache::lonnet::get_instuser($udom,$uname);
12212: return;
12213: }
12214: if (!$got_rules->{$udom}) {
12215: my %domconfig = &Apache::lonnet::get_dom('configuration',
12216: ['usercreation'],$udom);
12217: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12218: foreach my $item ('username','id') {
12219: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12220: $$curr_rules{$udom}{$item} =
12221: $domconfig{'usercreation'}{$item.'_rule'};
12222: }
12223: }
12224: }
12225: $got_rules->{$udom} = 1;
1.585 raeburn 12226: }
12227: }
1.1226 raeburn 12228: } else {
12229: return;
12230: }
12231: } else {
12232: return;
12233: }
12234: foreach my $user (keys(%{$usershash})) {
12235: my ($uname,$udom) = split(/:/,$user);
12236: next if (($udom eq '') || ($uname eq ''));
12237: my $id;
1.1227 raeburn 12238: if (ref($inst_results) eq 'HASH') {
12239: if (ref($inst_results->{$user}) eq 'HASH') {
12240: $id = $inst_results->{$user}->{'id'};
12241: }
12242: }
12243: if ($id eq '') {
12244: if (ref($usershash->{$user})) {
12245: $id = $usershash->{$user}->{'id'};
12246: }
1.585 raeburn 12247: }
1.612 raeburn 12248: foreach my $item (keys(%{$checks})) {
12249: if (ref($$curr_rules{$udom}) eq 'HASH') {
12250: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12251: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12252: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12253: $$curr_rules{$udom}{$item});
1.612 raeburn 12254: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12255: if ($rule_check{$rule}) {
12256: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12257: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12258: if (ref($inst_results) eq 'HASH') {
12259: if (ref($inst_results->{$user}) eq 'HASH') {
12260: if (keys(%{$inst_results->{$user}}) == 0) {
12261: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12262: } elsif ($item eq 'id') {
12263: if ($inst_results->{$user}->{'id'} eq '') {
12264: $$alerts{$item}{$udom}{$uname} = 1;
12265: }
1.615 raeburn 12266: }
1.612 raeburn 12267: }
12268: }
1.615 raeburn 12269: }
12270: last;
1.585 raeburn 12271: }
12272: }
12273: }
12274: }
12275: }
12276: }
12277: }
12278: }
1.612 raeburn 12279: return;
12280: }
12281:
12282: sub user_rule_formats {
12283: my ($domain,$domdesc,$curr_rules,$check) = @_;
12284: my %text = (
12285: 'username' => 'Usernames',
12286: 'id' => 'IDs',
12287: );
12288: my $output;
12289: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12290: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12291: if (@{$ruleorder} > 0) {
1.1102 raeburn 12292: $output = '<br />'.
12293: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12294: '<span class="LC_cusr_emph">','</span>',$domdesc).
12295: ' <ul>';
1.612 raeburn 12296: foreach my $rule (@{$ruleorder}) {
12297: if (ref($curr_rules) eq 'ARRAY') {
12298: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12299: if (ref($rules->{$rule}) eq 'HASH') {
12300: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12301: $rules->{$rule}{'desc'}.'</li>';
12302: }
12303: }
12304: }
12305: }
12306: $output .= '</ul>';
12307: }
12308: }
12309: return $output;
12310: }
12311:
12312: sub instrule_disallow_msg {
1.615 raeburn 12313: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12314: my $response;
12315: my %text = (
12316: item => 'username',
12317: items => 'usernames',
12318: match => 'matches',
12319: do => 'does',
12320: action => 'a username',
12321: one => 'one',
12322: );
12323: if ($count > 1) {
12324: $text{'item'} = 'usernames';
12325: $text{'match'} ='match';
12326: $text{'do'} = 'do';
12327: $text{'action'} = 'usernames',
12328: $text{'one'} = 'ones';
12329: }
12330: if ($checkitem eq 'id') {
12331: $text{'items'} = 'IDs';
12332: $text{'item'} = 'ID';
12333: $text{'action'} = 'an ID';
1.615 raeburn 12334: if ($count > 1) {
12335: $text{'item'} = 'IDs';
12336: $text{'action'} = 'IDs';
12337: }
1.612 raeburn 12338: }
1.674 bisitz 12339: $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 12340: if ($mode eq 'upload') {
12341: if ($checkitem eq 'username') {
12342: $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'}.");
12343: } elsif ($checkitem eq 'id') {
1.674 bisitz 12344: $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 12345: }
1.669 raeburn 12346: } elsif ($mode eq 'selfcreate') {
12347: if ($checkitem eq 'id') {
12348: $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.");
12349: }
1.615 raeburn 12350: } else {
12351: if ($checkitem eq 'username') {
12352: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12353: } elsif ($checkitem eq 'id') {
12354: $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.");
12355: }
1.612 raeburn 12356: }
12357: return $response;
1.585 raeburn 12358: }
12359:
1.624 raeburn 12360: sub personal_data_fieldtitles {
12361: my %fieldtitles = &Apache::lonlocal::texthash (
12362: id => 'Student/Employee ID',
12363: permanentemail => 'E-mail address',
12364: lastname => 'Last Name',
12365: firstname => 'First Name',
12366: middlename => 'Middle Name',
12367: generation => 'Generation',
12368: gen => 'Generation',
1.765 raeburn 12369: inststatus => 'Affiliation',
1.624 raeburn 12370: );
12371: return %fieldtitles;
12372: }
12373:
1.642 raeburn 12374: sub sorted_inst_types {
12375: my ($dom) = @_;
1.1185 raeburn 12376: my ($usertypes,$order);
12377: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12378: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12379: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12380: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12381: } else {
12382: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12383: }
1.642 raeburn 12384: my $othertitle = &mt('All users');
12385: if ($env{'request.course.id'}) {
1.668 raeburn 12386: $othertitle = &mt('Any users');
1.642 raeburn 12387: }
12388: my @types;
12389: if (ref($order) eq 'ARRAY') {
12390: @types = @{$order};
12391: }
12392: if (@types == 0) {
12393: if (ref($usertypes) eq 'HASH') {
12394: @types = sort(keys(%{$usertypes}));
12395: }
12396: }
12397: if (keys(%{$usertypes}) > 0) {
12398: $othertitle = &mt('Other users');
12399: }
12400: return ($othertitle,$usertypes,\@types);
12401: }
12402:
1.645 raeburn 12403: sub get_institutional_codes {
1.1361 raeburn 12404: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12405: # Get complete list of course sections to update
12406: my @currsections = ();
12407: my @currxlists = ();
1.1361 raeburn 12408: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12409: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12410: my $crskey = $crs.':'.$coursecode;
12411: @{$unclutteredsec{$crskey}} = ();
12412: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12413:
12414: if ($$settings{'internal.sectionnums'} ne '') {
12415: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12416: }
12417:
12418: if ($$settings{'internal.crosslistings'} ne '') {
12419: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12420: }
12421:
12422: if (@currxlists > 0) {
1.1361 raeburn 12423: foreach my $xl (@currxlists) {
12424: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12425: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12426: push(@{$allcourses},$1);
1.645 raeburn 12427: $$LC_code{$1} = $2;
12428: }
12429: }
12430: }
12431: }
1.1361 raeburn 12432:
1.645 raeburn 12433: if (@currsections > 0) {
1.1361 raeburn 12434: foreach my $sec (@currsections) {
12435: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12436: my $instsec = $1;
1.645 raeburn 12437: my $lc_sec = $2;
1.1361 raeburn 12438: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12439: push(@{$unclutteredsec{$crskey}},$instsec);
12440: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12441: }
12442: }
12443: }
12444: }
12445:
12446: if (@{$unclutteredsec{$crskey}} > 0) {
12447: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12448: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12449: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12450: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12451: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12452: push(@{$allcourses},$sec);
1.1361 raeburn 12453: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12454: }
12455: }
12456: }
12457: }
12458: return;
12459: }
12460:
1.971 raeburn 12461: sub get_standard_codeitems {
12462: return ('Year','Semester','Department','Number','Section');
12463: }
12464:
1.112 bowersj2 12465: =pod
12466:
1.780 raeburn 12467: =head1 Slot Helpers
12468:
12469: =over 4
12470:
12471: =item * sorted_slots()
12472:
1.1040 raeburn 12473: Sorts an array of slot names in order of an optional sort key,
12474: default sort is by slot start time (earliest first).
1.780 raeburn 12475:
12476: Inputs:
12477:
12478: =over 4
12479:
12480: slotsarr - Reference to array of unsorted slot names.
12481:
12482: slots - Reference to hash of hash, where outer hash keys are slot names.
12483:
1.1040 raeburn 12484: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12485:
1.549 albertel 12486: =back
12487:
1.780 raeburn 12488: Returns:
12489:
12490: =over 4
12491:
1.1040 raeburn 12492: sorted - An array of slot names sorted by a specified sort key
12493: (default sort key is start time of the slot).
1.780 raeburn 12494:
12495: =back
12496:
12497: =cut
12498:
12499:
12500: sub sorted_slots {
1.1040 raeburn 12501: my ($slotsarr,$slots,$sortkey) = @_;
12502: if ($sortkey eq '') {
12503: $sortkey = 'starttime';
12504: }
1.780 raeburn 12505: my @sorted;
12506: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12507: @sorted =
12508: sort {
12509: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12510: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12511: }
12512: if (ref($slots->{$a})) { return -1;}
12513: if (ref($slots->{$b})) { return 1;}
12514: return 0;
12515: } @{$slotsarr};
12516: }
12517: return @sorted;
12518: }
12519:
1.1040 raeburn 12520: =pod
12521:
12522: =item * get_future_slots()
12523:
12524: Inputs:
12525:
12526: =over 4
12527:
12528: cnum - course number
12529:
12530: cdom - course domain
12531:
12532: now - current UNIX time
12533:
12534: symb - optional symb
12535:
12536: =back
12537:
12538: Returns:
12539:
12540: =over 4
12541:
12542: sorted_reservable - ref to array of student_schedulable slots currently
12543: reservable, ordered by end date of reservation period.
12544:
12545: reservable_now - ref to hash of student_schedulable slots currently
12546: reservable.
12547:
12548: Keys in inner hash are:
12549: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12550: (b) endreserve: end date of reservation period.
12551: (c) uniqueperiod: start,end dates when slot is to be uniquely
12552: selected.
1.1040 raeburn 12553:
12554: sorted_future - ref to array of student_schedulable slots reservable in
12555: the future, ordered by start date of reservation period.
12556:
12557: future_reservable - ref to hash of student_schedulable slots reservable
12558: in the future.
12559:
12560: Keys in inner hash are:
12561: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12562: (b) startreserve: start date of reservation period.
12563: (c) uniqueperiod: start,end dates when slot is to be uniquely
12564: selected.
1.1040 raeburn 12565:
12566: =back
12567:
12568: =cut
12569:
12570: sub get_future_slots {
12571: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12572: my $map;
12573: if ($symb) {
12574: ($map) = &Apache::lonnet::decode_symb($symb);
12575: }
1.1040 raeburn 12576: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12577: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12578: foreach my $slot (keys(%slots)) {
12579: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12580: if ($symb) {
1.1229 raeburn 12581: if ($slots{$slot}->{'symb'} ne '') {
12582: my $canuse;
12583: my %oksymbs;
12584: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12585: map { $oksymbs{$_} = 1; } @slotsymbs;
12586: if ($oksymbs{$symb}) {
12587: $canuse = 1;
12588: } else {
12589: foreach my $item (@slotsymbs) {
12590: if ($item =~ /\.(page|sequence)$/) {
12591: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12592: if (($map ne '') && ($map eq $sloturl)) {
12593: $canuse = 1;
12594: last;
12595: }
12596: }
12597: }
12598: }
12599: next unless ($canuse);
12600: }
1.1040 raeburn 12601: }
12602: if (($slots{$slot}->{'starttime'} > $now) &&
12603: ($slots{$slot}->{'endtime'} > $now)) {
12604: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12605: my $userallowed = 0;
12606: if ($slots{$slot}->{'allowedsections'}) {
12607: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12608: if (!defined($env{'request.role.sec'})
12609: && grep(/^No section assigned$/,@allowed_sec)) {
12610: $userallowed=1;
12611: } else {
12612: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12613: $userallowed=1;
12614: }
12615: }
12616: unless ($userallowed) {
12617: if (defined($env{'request.course.groups'})) {
12618: my @groups = split(/:/,$env{'request.course.groups'});
12619: foreach my $group (@groups) {
12620: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12621: $userallowed=1;
12622: last;
12623: }
12624: }
12625: }
12626: }
12627: }
12628: if ($slots{$slot}->{'allowedusers'}) {
12629: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12630: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12631: if (grep(/^\Q$user\E$/,@allowed_users)) {
12632: $userallowed = 1;
12633: }
12634: }
12635: next unless($userallowed);
12636: }
12637: my $startreserve = $slots{$slot}->{'startreserve'};
12638: my $endreserve = $slots{$slot}->{'endreserve'};
12639: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12640: my $uniqueperiod;
12641: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12642: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12643: }
1.1040 raeburn 12644: if (($startreserve < $now) &&
12645: (!$endreserve || $endreserve > $now)) {
12646: my $lastres = $endreserve;
12647: if (!$lastres) {
12648: $lastres = $slots{$slot}->{'starttime'};
12649: }
12650: $reservable_now{$slot} = {
12651: symb => $symb,
1.1250 raeburn 12652: endreserve => $lastres,
12653: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12654: };
12655: } elsif (($startreserve > $now) &&
12656: (!$endreserve || $endreserve > $startreserve)) {
12657: $future_reservable{$slot} = {
12658: symb => $symb,
1.1250 raeburn 12659: startreserve => $startreserve,
12660: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12661: };
12662: }
12663: }
12664: }
12665: my @unsorted_reservable = keys(%reservable_now);
12666: if (@unsorted_reservable > 0) {
12667: @sorted_reservable =
12668: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12669: }
12670: my @unsorted_future = keys(%future_reservable);
12671: if (@unsorted_future > 0) {
12672: @sorted_future =
12673: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12674: }
12675: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12676: }
1.780 raeburn 12677:
12678: =pod
12679:
1.1057 foxr 12680: =back
12681:
1.549 albertel 12682: =head1 HTTP Helpers
12683:
12684: =over 4
12685:
1.648 raeburn 12686: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12687:
1.258 albertel 12688: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12689: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12690: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12691:
12692: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12693: $possible_names is an ref to an array of form element names. As an example:
12694: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12695: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12696:
12697: =cut
1.1 albertel 12698:
1.6 albertel 12699: sub get_unprocessed_cgi {
1.25 albertel 12700: my ($query,$possible_names)= @_;
1.26 matthew 12701: # $Apache::lonxml::debug=1;
1.356 albertel 12702: foreach my $pair (split(/&/,$query)) {
12703: my ($name, $value) = split(/=/,$pair);
1.369 www 12704: $name = &unescape($name);
1.25 albertel 12705: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12706: $value =~ tr/+/ /;
12707: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12708: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12709: }
1.16 harris41 12710: }
1.6 albertel 12711: }
12712:
1.112 bowersj2 12713: =pod
12714:
1.648 raeburn 12715: =item * &cacheheader()
1.112 bowersj2 12716:
12717: returns cache-controlling header code
12718:
12719: =cut
12720:
1.7 albertel 12721: sub cacheheader {
1.258 albertel 12722: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12723: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12724: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12725: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12726: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12727: return $output;
1.7 albertel 12728: }
12729:
1.112 bowersj2 12730: =pod
12731:
1.648 raeburn 12732: =item * &no_cache($r)
1.112 bowersj2 12733:
12734: specifies header code to not have cache
12735:
12736: =cut
12737:
1.9 albertel 12738: sub no_cache {
1.216 albertel 12739: my ($r) = @_;
12740: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12741: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12742: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12743: $r->no_cache(1);
12744: $r->header_out("Expires" => $date);
12745: $r->header_out("Pragma" => "no-cache");
1.123 www 12746: }
12747:
12748: sub content_type {
1.181 albertel 12749: my ($r,$type,$charset) = @_;
1.299 foxr 12750: if ($r) {
12751: # Note that printout.pl calls this with undef for $r.
12752: &no_cache($r);
12753: }
1.258 albertel 12754: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12755: unless ($charset) {
12756: $charset=&Apache::lonlocal::current_encoding;
12757: }
12758: if ($charset) { $type.='; charset='.$charset; }
12759: if ($r) {
12760: $r->content_type($type);
12761: } else {
12762: print("Content-type: $type\n\n");
12763: }
1.9 albertel 12764: }
1.25 albertel 12765:
1.112 bowersj2 12766: =pod
12767:
1.648 raeburn 12768: =item * &add_to_env($name,$value)
1.112 bowersj2 12769:
1.258 albertel 12770: adds $name to the %env hash with value
1.112 bowersj2 12771: $value, if $name already exists, the entry is converted to an array
12772: reference and $value is added to the array.
12773:
12774: =cut
12775:
1.25 albertel 12776: sub add_to_env {
12777: my ($name,$value)=@_;
1.258 albertel 12778: if (defined($env{$name})) {
12779: if (ref($env{$name})) {
1.25 albertel 12780: #already have multiple values
1.258 albertel 12781: push(@{ $env{$name} },$value);
1.25 albertel 12782: } else {
12783: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12784: my $first=$env{$name};
12785: undef($env{$name});
12786: push(@{ $env{$name} },$first,$value);
1.25 albertel 12787: }
12788: } else {
1.258 albertel 12789: $env{$name}=$value;
1.25 albertel 12790: }
1.31 albertel 12791: }
1.149 albertel 12792:
12793: =pod
12794:
1.648 raeburn 12795: =item * &get_env_multiple($name)
1.149 albertel 12796:
1.258 albertel 12797: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12798: values may be defined and end up as an array ref.
12799:
12800: returns an array of values
12801:
12802: =cut
12803:
12804: sub get_env_multiple {
12805: my ($name) = @_;
12806: my @values;
1.258 albertel 12807: if (defined($env{$name})) {
1.149 albertel 12808: # exists is it an array
1.258 albertel 12809: if (ref($env{$name})) {
12810: @values=@{ $env{$name} };
1.149 albertel 12811: } else {
1.258 albertel 12812: $values[0]=$env{$name};
1.149 albertel 12813: }
12814: }
12815: return(@values);
12816: }
12817:
1.1249 damieng 12818: # Looks at given dependencies, and returns something depending on the context.
12819: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12820: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12821: # For all other contexts, returns ($output, $counter, $numpathchg).
12822: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12823: # $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.
12824: # $numpathchg: integer with the number of cleaned up dependency paths.
12825: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12826: # \%mapping: hash reference clean path -> original path for all dependencies.
12827: # @param {string} actionurl - The path to the handler, indicative of the context.
12828: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12829: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12830: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12831: # @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)
12832: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12833: sub ask_for_embedded_content {
1.1249 damieng 12834: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12835: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12836: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12837: %currsubfile,%unused,$rem);
1.1071 raeburn 12838: my $counter = 0;
12839: my $numnew = 0;
1.987 raeburn 12840: my $numremref = 0;
12841: my $numinvalid = 0;
12842: my $numpathchg = 0;
12843: my $numexisting = 0;
1.1071 raeburn 12844: my $numunused = 0;
12845: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12846: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12847: my $heading = &mt('Upload embedded files');
12848: my $buttontext = &mt('Upload');
12849:
1.1249 damieng 12850: # fills these variables based on the context:
12851: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12852: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12853: if ($env{'request.course.id'}) {
1.1123 raeburn 12854: if ($actionurl eq '/adm/dependencies') {
12855: $navmap = Apache::lonnavmaps::navmap->new();
12856: }
12857: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12858: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12859: }
1.1123 raeburn 12860: if (($actionurl eq '/adm/portfolio') ||
12861: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12862: my $current_path='/';
12863: if ($env{'form.currentpath'}) {
12864: $current_path = $env{'form.currentpath'};
12865: }
12866: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12867: $udom = $cdom;
12868: $uname = $cnum;
1.984 raeburn 12869: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12870: } else {
12871: $udom = $env{'user.domain'};
12872: $uname = $env{'user.name'};
12873: $url = '/userfiles/portfolio';
12874: }
1.987 raeburn 12875: $toplevel = $url.'/';
1.984 raeburn 12876: $url .= $current_path;
12877: $getpropath = 1;
1.987 raeburn 12878: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12879: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12880: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12881: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12882: $toplevel = $url;
1.984 raeburn 12883: if ($rest ne '') {
1.987 raeburn 12884: $url .= $rest;
12885: }
12886: } elsif ($actionurl eq '/adm/coursedocs') {
12887: if (ref($args) eq 'HASH') {
1.1071 raeburn 12888: $url = $args->{'docs_url'};
12889: $toplevel = $url;
1.1084 raeburn 12890: if ($args->{'context'} eq 'paste') {
12891: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12892: ($path) =
12893: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12894: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12895: $fileloc =~ s{^/}{};
12896: }
1.1071 raeburn 12897: }
1.1084 raeburn 12898: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12899: if ($env{'request.course.id'} ne '') {
12900: if (ref($args) eq 'HASH') {
12901: $url = $args->{'docs_url'};
12902: $title = $args->{'docs_title'};
1.1126 raeburn 12903: $toplevel = $url;
12904: unless ($toplevel =~ m{^/}) {
12905: $toplevel = "/$url";
12906: }
1.1085 raeburn 12907: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12908: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12909: $path = $1;
12910: } else {
12911: ($path) =
12912: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12913: }
1.1195 raeburn 12914: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12915: $fileloc = $toplevel;
12916: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12917: my ($udom,$uname,$fname) =
12918: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12919: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12920: } else {
12921: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12922: }
1.1071 raeburn 12923: $fileloc =~ s{^/}{};
12924: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12925: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12926: }
1.987 raeburn 12927: }
1.1123 raeburn 12928: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12929: $udom = $cdom;
12930: $uname = $cnum;
12931: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12932: $toplevel = $url;
12933: $path = $url;
12934: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12935: $fileloc =~ s{^/}{};
1.987 raeburn 12936: }
1.1249 damieng 12937:
12938: # parses the dependency paths to get some info
12939: # fills $newfiles, $mapping, $subdependencies, $dependencies
12940: # $newfiles: hash URL -> 1 for new files or external URLs
12941: # (will be completed later)
12942: # $mapping:
12943: # for external URLs: external URL -> external URL
12944: # for relative paths: clean path -> original path
12945: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12946: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12947: foreach my $file (keys(%{$allfiles})) {
12948: my $embed_file;
12949: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12950: $embed_file = $1;
12951: } else {
12952: $embed_file = $file;
12953: }
1.1158 raeburn 12954: my ($absolutepath,$cleaned_file);
12955: if ($embed_file =~ m{^\w+://}) {
12956: $cleaned_file = $embed_file;
1.1147 raeburn 12957: $newfiles{$cleaned_file} = 1;
12958: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12959: } else {
1.1158 raeburn 12960: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12961: if ($embed_file =~ m{^/}) {
12962: $absolutepath = $embed_file;
12963: }
1.1147 raeburn 12964: if ($cleaned_file =~ m{/}) {
12965: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12966: $path = &check_for_traversal($path,$url,$toplevel);
12967: my $item = $fname;
12968: if ($path ne '') {
12969: $item = $path.'/'.$fname;
12970: $subdependencies{$path}{$fname} = 1;
12971: } else {
12972: $dependencies{$item} = 1;
12973: }
12974: if ($absolutepath) {
12975: $mapping{$item} = $absolutepath;
12976: } else {
12977: $mapping{$item} = $embed_file;
12978: }
12979: } else {
12980: $dependencies{$embed_file} = 1;
12981: if ($absolutepath) {
1.1147 raeburn 12982: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12983: } else {
1.1147 raeburn 12984: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12985: }
12986: }
1.984 raeburn 12987: }
12988: }
1.1249 damieng 12989:
12990: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12991: # and lists
12992: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12993: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12994: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12995: # the path had to be cleaned up
12996: # $existing: hash clean path -> 1 if the file exists
12997: # $numexisting: number of keys in $existing
12998: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12999: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
13000: # dependency subdirectories that are
13001: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 13002: my $dirptr = 16384;
1.984 raeburn 13003: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 13004: $currsubfile{$path} = {};
1.1123 raeburn 13005: if (($actionurl eq '/adm/portfolio') ||
13006: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 13007: my ($sublistref,$listerror) =
13008: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
13009: if (ref($sublistref) eq 'ARRAY') {
13010: foreach my $line (@{$sublistref}) {
13011: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 13012: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 13013: }
1.984 raeburn 13014: }
1.987 raeburn 13015: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 13016: if (opendir(my $dir,$url.'/'.$path)) {
13017: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 13018: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
13019: }
1.1084 raeburn 13020: } elsif (($actionurl eq '/adm/dependencies') ||
13021: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 13022: ($args->{'context'} eq 'paste')) ||
13023: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 13024: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 13025: my $dir;
13026: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
13027: $dir = $fileloc;
13028: } else {
13029: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
13030: }
1.1071 raeburn 13031: if ($dir ne '') {
13032: my ($sublistref,$listerror) =
13033: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
13034: if (ref($sublistref) eq 'ARRAY') {
13035: foreach my $line (@{$sublistref}) {
13036: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
13037: undef,$mtime)=split(/\&/,$line,12);
13038: unless (($testdir&$dirptr) ||
13039: ($file_name =~ /^\.\.?$/)) {
13040: $currsubfile{$path}{$file_name} = [$size,$mtime];
13041: }
13042: }
13043: }
13044: }
1.984 raeburn 13045: }
13046: }
13047: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 13048: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 13049: my $item = $path.'/'.$file;
13050: unless ($mapping{$item} eq $item) {
13051: $pathchanges{$item} = 1;
13052: }
13053: $existing{$item} = 1;
13054: $numexisting ++;
13055: } else {
13056: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 13057: }
13058: }
1.1071 raeburn 13059: if ($actionurl eq '/adm/dependencies') {
13060: foreach my $path (keys(%currsubfile)) {
13061: if (ref($currsubfile{$path}) eq 'HASH') {
13062: foreach my $file (keys(%{$currsubfile{$path}})) {
13063: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 13064: next if (($rem ne '') &&
13065: (($env{"httpref.$rem"."$path/$file"} ne '') ||
13066: (ref($navmap) &&
13067: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
13068: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13069: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 13070: $unused{$path.'/'.$file} = 1;
13071: }
13072: }
13073: }
13074: }
13075: }
1.984 raeburn 13076: }
1.1249 damieng 13077:
13078: # fills $currfile, hash file name -> 1 or [$size,$mtime]
13079: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 13080: my %currfile;
1.1123 raeburn 13081: if (($actionurl eq '/adm/portfolio') ||
13082: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 13083: my ($dirlistref,$listerror) =
13084: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
13085: if (ref($dirlistref) eq 'ARRAY') {
13086: foreach my $line (@{$dirlistref}) {
13087: my ($file_name,$rest) = split(/\&/,$line,2);
13088: $currfile{$file_name} = 1;
13089: }
1.984 raeburn 13090: }
1.987 raeburn 13091: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 13092: if (opendir(my $dir,$url)) {
1.987 raeburn 13093: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 13094: map {$currfile{$_} = 1;} @dir_list;
13095: }
1.1084 raeburn 13096: } elsif (($actionurl eq '/adm/dependencies') ||
13097: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 13098: ($args->{'context'} eq 'paste')) ||
13099: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 13100: if ($env{'request.course.id'} ne '') {
13101: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
13102: if ($dir ne '') {
13103: my ($dirlistref,$listerror) =
13104: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
13105: if (ref($dirlistref) eq 'ARRAY') {
13106: foreach my $line (@{$dirlistref}) {
13107: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
13108: $size,undef,$mtime)=split(/\&/,$line,12);
13109: unless (($testdir&$dirptr) ||
13110: ($file_name =~ /^\.\.?$/)) {
13111: $currfile{$file_name} = [$size,$mtime];
13112: }
13113: }
13114: }
13115: }
13116: }
1.984 raeburn 13117: }
1.1249 damieng 13118: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
13119: # are not in subdirectories, using $currfile
1.984 raeburn 13120: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 13121: if (exists($currfile{$file})) {
1.987 raeburn 13122: unless ($mapping{$file} eq $file) {
13123: $pathchanges{$file} = 1;
13124: }
13125: $existing{$file} = 1;
13126: $numexisting ++;
13127: } else {
1.984 raeburn 13128: $newfiles{$file} = 1;
13129: }
13130: }
1.1071 raeburn 13131: foreach my $file (keys(%currfile)) {
13132: unless (($file eq $filename) ||
13133: ($file eq $filename.'.bak') ||
13134: ($dependencies{$file})) {
1.1085 raeburn 13135: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 13136: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
13137: next if (($rem ne '') &&
13138: (($env{"httpref.$rem".$file} ne '') ||
13139: (ref($navmap) &&
13140: (($navmap->getResourceByUrl($rem.$file) ne '') ||
13141: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13142: ($navmap->getResourceByUrl($rem.$1)))))));
13143: }
1.1085 raeburn 13144: }
1.1071 raeburn 13145: $unused{$file} = 1;
13146: }
13147: }
1.1249 damieng 13148:
13149: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 13150: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
13151: ($args->{'context'} eq 'paste')) {
13152: $counter = scalar(keys(%existing));
13153: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 13154: return ($output,$counter,$numpathchg,\%existing);
13155: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
13156: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
13157: $counter = scalar(keys(%existing));
13158: $numpathchg = scalar(keys(%pathchanges));
13159: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13160: }
1.1249 damieng 13161:
13162: # returns HTML otherwise, with dependency results and to ask for more uploads
13163:
13164: # $upload_output: missing dependencies (with upload form)
13165: # $modify_output: uploaded dependencies (in use)
13166: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13167: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13168: if ($actionurl eq '/adm/dependencies') {
13169: next if ($embed_file =~ m{^\w+://});
13170: }
1.660 raeburn 13171: $upload_output .= &start_data_table_row().
1.1123 raeburn 13172: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13173: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13174: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13175: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13176: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13177: }
1.1123 raeburn 13178: $upload_output .= '</td>';
1.1071 raeburn 13179: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13180: $upload_output.='<td align="right">'.
13181: '<span class="LC_info LC_fontsize_medium">'.
13182: &mt("URL points to web address").'</span>';
1.987 raeburn 13183: $numremref++;
1.660 raeburn 13184: } elsif ($args->{'error_on_invalid_names'}
13185: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13186: $upload_output.='<td align="right"><span class="LC_warning">'.
13187: &mt('Invalid characters').'</span>';
1.987 raeburn 13188: $numinvalid++;
1.660 raeburn 13189: } else {
1.1123 raeburn 13190: $upload_output .= '<td>'.
13191: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13192: $embed_file,\%mapping,
1.1071 raeburn 13193: $allfiles,$codebase,'upload');
13194: $counter ++;
13195: $numnew ++;
1.987 raeburn 13196: }
13197: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13198: }
13199: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13200: if ($actionurl eq '/adm/dependencies') {
13201: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13202: $modify_output .= &start_data_table_row().
13203: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13204: '<img src="'.&icon($embed_file).'" border="0" />'.
13205: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13206: '<td>'.$size.'</td>'.
13207: '<td>'.$mtime.'</td>'.
13208: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13209: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13210: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13211: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13212: &embedded_file_element('upload_embedded',$counter,
13213: $embed_file,\%mapping,
13214: $allfiles,$codebase,'modify').
13215: '</div></td>'.
13216: &end_data_table_row()."\n";
13217: $counter ++;
13218: } else {
13219: $upload_output .= &start_data_table_row().
1.1123 raeburn 13220: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13221: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13222: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13223: &Apache::loncommon::end_data_table_row()."\n";
13224: }
13225: }
13226: my $delidx = $counter;
13227: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13228: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13229: $delete_output .= &start_data_table_row().
13230: '<td><img src="'.&icon($oldfile).'" />'.
13231: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13232: '<td>'.$size.'</td>'.
13233: '<td>'.$mtime.'</td>'.
13234: '<td><label><input type="checkbox" name="del_upload_dep" '.
13235: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13236: &embedded_file_element('upload_embedded',$delidx,
13237: $oldfile,\%mapping,$allfiles,
13238: $codebase,'delete').'</td>'.
13239: &end_data_table_row()."\n";
13240: $numunused ++;
13241: $delidx ++;
1.987 raeburn 13242: }
13243: if ($upload_output) {
13244: $upload_output = &start_data_table().
13245: $upload_output.
13246: &end_data_table()."\n";
13247: }
1.1071 raeburn 13248: if ($modify_output) {
13249: $modify_output = &start_data_table().
13250: &start_data_table_header_row().
13251: '<th>'.&mt('File').'</th>'.
13252: '<th>'.&mt('Size (KB)').'</th>'.
13253: '<th>'.&mt('Modified').'</th>'.
13254: '<th>'.&mt('Upload replacement?').'</th>'.
13255: &end_data_table_header_row().
13256: $modify_output.
13257: &end_data_table()."\n";
13258: }
13259: if ($delete_output) {
13260: $delete_output = &start_data_table().
13261: &start_data_table_header_row().
13262: '<th>'.&mt('File').'</th>'.
13263: '<th>'.&mt('Size (KB)').'</th>'.
13264: '<th>'.&mt('Modified').'</th>'.
13265: '<th>'.&mt('Delete?').'</th>'.
13266: &end_data_table_header_row().
13267: $delete_output.
13268: &end_data_table()."\n";
13269: }
1.987 raeburn 13270: my $applies = 0;
13271: if ($numremref) {
13272: $applies ++;
13273: }
13274: if ($numinvalid) {
13275: $applies ++;
13276: }
13277: if ($numexisting) {
13278: $applies ++;
13279: }
1.1071 raeburn 13280: if ($counter || $numunused) {
1.987 raeburn 13281: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13282: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13283: $state.'<h3>'.$heading.'</h3>';
13284: if ($actionurl eq '/adm/dependencies') {
13285: if ($numnew) {
13286: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13287: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13288: $upload_output.'<br />'."\n";
13289: }
13290: if ($numexisting) {
13291: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13292: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13293: $modify_output.'<br />'."\n";
13294: $buttontext = &mt('Save changes');
13295: }
13296: if ($numunused) {
13297: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13298: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13299: $delete_output.'<br />'."\n";
13300: $buttontext = &mt('Save changes');
13301: }
13302: } else {
13303: $output .= $upload_output.'<br />'."\n";
13304: }
13305: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13306: $counter.'" />'."\n";
13307: if ($actionurl eq '/adm/dependencies') {
13308: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13309: $numnew.'" />'."\n";
13310: } elsif ($actionurl eq '') {
1.987 raeburn 13311: $output .= '<input type="hidden" name="phase" value="three" />';
13312: }
13313: } elsif ($applies) {
13314: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13315: if ($applies > 1) {
13316: $output .=
1.1123 raeburn 13317: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13318: if ($numremref) {
13319: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13320: }
13321: if ($numinvalid) {
13322: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13323: }
13324: if ($numexisting) {
13325: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13326: }
13327: $output .= '</ul><br />';
13328: } elsif ($numremref) {
13329: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13330: } elsif ($numinvalid) {
13331: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13332: } elsif ($numexisting) {
13333: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13334: }
13335: $output .= $upload_output.'<br />';
13336: }
13337: my ($pathchange_output,$chgcount);
1.1071 raeburn 13338: $chgcount = $counter;
1.987 raeburn 13339: if (keys(%pathchanges) > 0) {
13340: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13341: if ($counter) {
1.987 raeburn 13342: $output .= &embedded_file_element('pathchange',$chgcount,
13343: $embed_file,\%mapping,
1.1071 raeburn 13344: $allfiles,$codebase,'change');
1.987 raeburn 13345: } else {
13346: $pathchange_output .=
13347: &start_data_table_row().
13348: '<td><input type ="checkbox" name="namechange" value="'.
13349: $chgcount.'" checked="checked" /></td>'.
13350: '<td>'.$mapping{$embed_file}.'</td>'.
13351: '<td>'.$embed_file.
13352: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13353: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13354: '</td>'.&end_data_table_row();
1.660 raeburn 13355: }
1.987 raeburn 13356: $numpathchg ++;
13357: $chgcount ++;
1.660 raeburn 13358: }
13359: }
1.1127 raeburn 13360: if (($counter) || ($numunused)) {
1.987 raeburn 13361: if ($numpathchg) {
13362: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13363: $numpathchg.'" />'."\n";
13364: }
13365: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13366: ($actionurl eq '/adm/imsimport')) {
13367: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13368: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13369: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13370: } elsif ($actionurl eq '/adm/dependencies') {
13371: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13372: }
1.1123 raeburn 13373: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13374: } elsif ($numpathchg) {
13375: my %pathchange = ();
13376: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13377: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13378: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13379: }
1.987 raeburn 13380: }
1.1071 raeburn 13381: return ($output,$counter,$numpathchg);
1.987 raeburn 13382: }
13383:
1.1147 raeburn 13384: =pod
13385:
13386: =item * clean_path($name)
13387:
13388: Performs clean-up of directories, subdirectories and filename in an
13389: embedded object, referenced in an HTML file which is being uploaded
13390: to a course or portfolio, where
13391: "Upload embedded images/multimedia files if HTML file" checkbox was
13392: checked.
13393:
13394: Clean-up is similar to replacements in lonnet::clean_filename()
13395: except each / between sub-directory and next level is preserved.
13396:
13397: =cut
13398:
13399: sub clean_path {
13400: my ($embed_file) = @_;
13401: $embed_file =~s{^/+}{};
13402: my @contents;
13403: if ($embed_file =~ m{/}) {
13404: @contents = split(/\//,$embed_file);
13405: } else {
13406: @contents = ($embed_file);
13407: }
13408: my $lastidx = scalar(@contents)-1;
13409: for (my $i=0; $i<=$lastidx; $i++) {
13410: $contents[$i]=~s{\\}{/}g;
13411: $contents[$i]=~s/\s+/\_/g;
13412: $contents[$i]=~s{[^/\w\.\-]}{}g;
13413: if ($i == $lastidx) {
13414: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13415: }
13416: }
13417: if ($lastidx > 0) {
13418: return join('/',@contents);
13419: } else {
13420: return $contents[0];
13421: }
13422: }
13423:
1.987 raeburn 13424: sub embedded_file_element {
1.1071 raeburn 13425: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13426: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13427: (ref($codebase) eq 'HASH'));
13428: my $output;
1.1071 raeburn 13429: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13430: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13431: }
13432: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13433: &escape($embed_file).'" />';
13434: unless (($context eq 'upload_embedded') &&
13435: ($mapping->{$embed_file} eq $embed_file)) {
13436: $output .='
13437: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13438: }
13439: my $attrib;
13440: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13441: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13442: }
13443: $output .=
13444: "\n\t\t".
13445: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13446: $attrib.'" />';
13447: if (exists($codebase->{$mapping->{$embed_file}})) {
13448: $output .=
13449: "\n\t\t".
13450: '<input name="codebase_'.$num.'" type="hidden" value="'.
13451: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13452: }
1.987 raeburn 13453: return $output;
1.660 raeburn 13454: }
13455:
1.1071 raeburn 13456: sub get_dependency_details {
13457: my ($currfile,$currsubfile,$embed_file) = @_;
13458: my ($size,$mtime,$showsize,$showmtime);
13459: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13460: if ($embed_file =~ m{/}) {
13461: my ($path,$fname) = split(/\//,$embed_file);
13462: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13463: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13464: }
13465: } else {
13466: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13467: ($size,$mtime) = @{$currfile->{$embed_file}};
13468: }
13469: }
13470: $showsize = $size/1024.0;
13471: $showsize = sprintf("%.1f",$showsize);
13472: if ($mtime > 0) {
13473: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13474: }
13475: }
13476: return ($showsize,$showmtime);
13477: }
13478:
13479: sub ask_embedded_js {
13480: return <<"END";
13481: <script type="text/javascript"">
13482: // <![CDATA[
13483: function toggleBrowse(counter) {
13484: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13485: var fileid = document.getElementById('embedded_item_'+counter);
13486: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13487: if (chkboxid.checked == true) {
13488: uploaddivid.style.display='block';
13489: } else {
13490: uploaddivid.style.display='none';
13491: fileid.value = '';
13492: }
13493: }
13494: // ]]>
13495: </script>
13496:
13497: END
13498: }
13499:
1.661 raeburn 13500: sub upload_embedded {
13501: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13502: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13503: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13504: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13505: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13506: my $orig_uploaded_filename =
13507: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13508: foreach my $type ('orig','ref','attrib','codebase') {
13509: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13510: $env{'form.embedded_'.$type.'_'.$i} =
13511: &unescape($env{'form.embedded_'.$type.'_'.$i});
13512: }
13513: }
1.661 raeburn 13514: my ($path,$fname) =
13515: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13516: # no path, whole string is fname
13517: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13518: $fname = &Apache::lonnet::clean_filename($fname);
13519: # See if there is anything left
13520: next if ($fname eq '');
13521:
13522: # Check if file already exists as a file or directory.
13523: my ($state,$msg);
13524: if ($context eq 'portfolio') {
13525: my $port_path = $dirpath;
13526: if ($group ne '') {
13527: $port_path = "groups/$group/$port_path";
13528: }
1.987 raeburn 13529: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13530: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13531: $dir_root,$port_path,$disk_quota,
13532: $current_disk_usage,$uname,$udom);
13533: if ($state eq 'will_exceed_quota'
1.984 raeburn 13534: || $state eq 'file_locked') {
1.661 raeburn 13535: $output .= $msg;
13536: next;
13537: }
13538: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13539: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13540: if ($state eq 'exists') {
13541: $output .= $msg;
13542: next;
13543: }
13544: }
13545: # Check if extension is valid
13546: if (($fname =~ /\.(\w+)$/) &&
13547: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13548: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13549: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13550: next;
13551: } elsif (($fname =~ /\.(\w+)$/) &&
13552: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13553: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13554: next;
13555: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13556: $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 13557: next;
13558: }
13559: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13560: my $subdir = $path;
13561: $subdir =~ s{/+$}{};
1.661 raeburn 13562: if ($context eq 'portfolio') {
1.984 raeburn 13563: my $result;
13564: if ($state eq 'existingfile') {
13565: $result=
13566: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13567: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13568: } else {
1.984 raeburn 13569: $result=
13570: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13571: $dirpath.
1.1123 raeburn 13572: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13573: if ($result !~ m|^/uploaded/|) {
13574: $output .= '<span class="LC_error">'
13575: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13576: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13577: .'</span><br />';
13578: next;
13579: } else {
1.987 raeburn 13580: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13581: $path.$fname.'</span>').'<br />';
1.984 raeburn 13582: }
1.661 raeburn 13583: }
1.1123 raeburn 13584: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13585: my $extendedsubdir = $dirpath.'/'.$subdir;
13586: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13587: my $result =
1.1126 raeburn 13588: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13589: if ($result !~ m|^/uploaded/|) {
13590: $output .= '<span class="LC_error">'
13591: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13592: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13593: .'</span><br />';
13594: next;
13595: } else {
13596: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13597: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13598: if ($context eq 'syllabus') {
13599: &Apache::lonnet::make_public_indefinitely($result);
13600: }
1.987 raeburn 13601: }
1.661 raeburn 13602: } else {
13603: # Save the file
13604: my $target = $env{'form.embedded_item_'.$i};
13605: my $fullpath = $dir_root.$dirpath.'/'.$path;
13606: my $dest = $fullpath.$fname;
13607: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13608: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13609: my $count;
13610: my $filepath = $dir_root;
1.1027 raeburn 13611: foreach my $subdir (@parts) {
13612: $filepath .= "/$subdir";
13613: if (!-e $filepath) {
1.661 raeburn 13614: mkdir($filepath,0770);
13615: }
13616: }
13617: my $fh;
13618: if (!open($fh,'>'.$dest)) {
13619: &Apache::lonnet::logthis('Failed to create '.$dest);
13620: $output .= '<span class="LC_error">'.
1.1071 raeburn 13621: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13622: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13623: '</span><br />';
13624: } else {
13625: if (!print $fh $env{'form.embedded_item_'.$i}) {
13626: &Apache::lonnet::logthis('Failed to write to '.$dest);
13627: $output .= '<span class="LC_error">'.
1.1071 raeburn 13628: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13629: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13630: '</span><br />';
13631: } else {
1.987 raeburn 13632: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13633: $url.'</span>').'<br />';
13634: unless ($context eq 'testbank') {
13635: $footer .= &mt('View embedded file: [_1]',
13636: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13637: }
13638: }
13639: close($fh);
13640: }
13641: }
13642: if ($env{'form.embedded_ref_'.$i}) {
13643: $pathchange{$i} = 1;
13644: }
13645: }
13646: if ($output) {
13647: $output = '<p>'.$output.'</p>';
13648: }
13649: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13650: $returnflag = 'ok';
1.1071 raeburn 13651: my $numpathchgs = scalar(keys(%pathchange));
13652: if ($numpathchgs > 0) {
1.987 raeburn 13653: if ($context eq 'portfolio') {
13654: $output .= '<p>'.&mt('or').'</p>';
13655: } elsif ($context eq 'testbank') {
1.1071 raeburn 13656: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13657: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13658: $returnflag = 'modify_orightml';
13659: }
13660: }
1.1071 raeburn 13661: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13662: }
13663:
13664: sub modify_html_form {
13665: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13666: my $end = 0;
13667: my $modifyform;
13668: if ($context eq 'upload_embedded') {
13669: return unless (ref($pathchange) eq 'HASH');
13670: if ($env{'form.number_embedded_items'}) {
13671: $end += $env{'form.number_embedded_items'};
13672: }
13673: if ($env{'form.number_pathchange_items'}) {
13674: $end += $env{'form.number_pathchange_items'};
13675: }
13676: if ($end) {
13677: for (my $i=0; $i<$end; $i++) {
13678: if ($i < $env{'form.number_embedded_items'}) {
13679: next unless($pathchange->{$i});
13680: }
13681: $modifyform .=
13682: &start_data_table_row().
13683: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13684: 'checked="checked" /></td>'.
13685: '<td>'.$env{'form.embedded_ref_'.$i}.
13686: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13687: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13688: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13689: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13690: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13691: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13692: '<td>'.$env{'form.embedded_orig_'.$i}.
13693: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13694: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13695: &end_data_table_row();
1.1071 raeburn 13696: }
1.987 raeburn 13697: }
13698: } else {
13699: $modifyform = $pathchgtable;
13700: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13701: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13702: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13703: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13704: }
13705: }
13706: if ($modifyform) {
1.1071 raeburn 13707: if ($actionurl eq '/adm/dependencies') {
13708: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13709: }
1.987 raeburn 13710: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13711: '<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".
13712: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13713: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13714: '</ol></p>'."\n".'<p>'.
13715: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13716: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13717: &start_data_table()."\n".
13718: &start_data_table_header_row().
13719: '<th>'.&mt('Change?').'</th>'.
13720: '<th>'.&mt('Current reference').'</th>'.
13721: '<th>'.&mt('Required reference').'</th>'.
13722: &end_data_table_header_row()."\n".
13723: $modifyform.
13724: &end_data_table().'<br />'."\n".$hiddenstate.
13725: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13726: '</form>'."\n";
13727: }
13728: return;
13729: }
13730:
13731: sub modify_html_refs {
1.1123 raeburn 13732: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13733: my $container;
13734: if ($context eq 'portfolio') {
13735: $container = $env{'form.container'};
13736: } elsif ($context eq 'coursedoc') {
13737: $container = $env{'form.primaryurl'};
1.1071 raeburn 13738: } elsif ($context eq 'manage_dependencies') {
13739: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13740: $container = "/$container";
1.1123 raeburn 13741: } elsif ($context eq 'syllabus') {
13742: $container = $url;
1.987 raeburn 13743: } else {
1.1027 raeburn 13744: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13745: }
13746: my (%allfiles,%codebase,$output,$content);
13747: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13748: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13749: if (wantarray) {
13750: return ('',0,0);
13751: } else {
13752: return;
13753: }
13754: }
13755: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13756: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13757: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13758: if (wantarray) {
13759: return ('',0,0);
13760: } else {
13761: return;
13762: }
13763: }
1.987 raeburn 13764: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13765: if ($content eq '-1') {
13766: if (wantarray) {
13767: return ('',0,0);
13768: } else {
13769: return;
13770: }
13771: }
1.987 raeburn 13772: } else {
1.1071 raeburn 13773: unless ($container =~ /^\Q$dir_root\E/) {
13774: if (wantarray) {
13775: return ('',0,0);
13776: } else {
13777: return;
13778: }
13779: }
1.1317 raeburn 13780: if (open(my $fh,'<',$container)) {
1.987 raeburn 13781: $content = join('', <$fh>);
13782: close($fh);
13783: } else {
1.1071 raeburn 13784: if (wantarray) {
13785: return ('',0,0);
13786: } else {
13787: return;
13788: }
1.987 raeburn 13789: }
13790: }
13791: my ($count,$codebasecount) = (0,0);
13792: my $mm = new File::MMagic;
13793: my $mime_type = $mm->checktype_contents($content);
13794: if ($mime_type eq 'text/html') {
13795: my $parse_result =
13796: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13797: \%codebase,\$content);
13798: if ($parse_result eq 'ok') {
13799: foreach my $i (@changes) {
13800: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13801: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13802: if ($allfiles{$ref}) {
13803: my $newname = $orig;
13804: my ($attrib_regexp,$codebase);
1.1006 raeburn 13805: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13806: if ($attrib_regexp =~ /:/) {
13807: $attrib_regexp =~ s/\:/|/g;
13808: }
13809: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13810: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13811: $count += $numchg;
1.1123 raeburn 13812: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13813: delete($allfiles{$ref});
1.987 raeburn 13814: }
13815: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13816: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13817: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13818: $codebasecount ++;
13819: }
13820: }
13821: }
1.1123 raeburn 13822: my $skiprewrites;
1.987 raeburn 13823: if ($count || $codebasecount) {
13824: my $saveresult;
1.1071 raeburn 13825: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13826: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13827: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13828: if ($url eq $container) {
13829: my ($fname) = ($container =~ m{/([^/]+)$});
13830: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13831: $count,'<span class="LC_filename">'.
1.1071 raeburn 13832: $fname.'</span>').'</p>';
1.987 raeburn 13833: } else {
13834: $output = '<p class="LC_error">'.
13835: &mt('Error: update failed for: [_1].',
13836: '<span class="LC_filename">'.
13837: $container.'</span>').'</p>';
13838: }
1.1123 raeburn 13839: if ($context eq 'syllabus') {
13840: unless ($saveresult eq 'ok') {
13841: $skiprewrites = 1;
13842: }
13843: }
1.987 raeburn 13844: } else {
1.1317 raeburn 13845: if (open(my $fh,'>',$container)) {
1.987 raeburn 13846: print $fh $content;
13847: close($fh);
13848: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13849: $count,'<span class="LC_filename">'.
13850: $container.'</span>').'</p>';
1.661 raeburn 13851: } else {
1.987 raeburn 13852: $output = '<p class="LC_error">'.
13853: &mt('Error: could not update [_1].',
13854: '<span class="LC_filename">'.
13855: $container.'</span>').'</p>';
1.661 raeburn 13856: }
13857: }
13858: }
1.1123 raeburn 13859: if (($context eq 'syllabus') && (!$skiprewrites)) {
13860: my ($actionurl,$state);
13861: $actionurl = "/public/$udom/$uname/syllabus";
13862: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13863: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13864: \%codebase,
13865: {'context' => 'rewrites',
13866: 'ignore_remote_references' => 1,});
13867: if (ref($mapping) eq 'HASH') {
13868: my $rewrites = 0;
13869: foreach my $key (keys(%{$mapping})) {
13870: next if ($key =~ m{^https?://});
13871: my $ref = $mapping->{$key};
13872: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13873: my $attrib;
13874: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13875: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13876: }
13877: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13878: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13879: $rewrites += $numchg;
13880: }
13881: }
13882: if ($rewrites) {
13883: my $saveresult;
13884: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13885: if ($url eq $container) {
13886: my ($fname) = ($container =~ m{/([^/]+)$});
13887: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13888: $count,'<span class="LC_filename">'.
13889: $fname.'</span>').'</p>';
13890: } else {
13891: $output .= '<p class="LC_error">'.
13892: &mt('Error: could not update links in [_1].',
13893: '<span class="LC_filename">'.
13894: $container.'</span>').'</p>';
13895:
13896: }
13897: }
13898: }
13899: }
1.987 raeburn 13900: } else {
13901: &logthis('Failed to parse '.$container.
13902: ' to modify references: '.$parse_result);
1.661 raeburn 13903: }
13904: }
1.1071 raeburn 13905: if (wantarray) {
13906: return ($output,$count,$codebasecount);
13907: } else {
13908: return $output;
13909: }
1.661 raeburn 13910: }
13911:
13912: sub check_for_existing {
13913: my ($path,$fname,$element) = @_;
13914: my ($state,$msg);
13915: if (-d $path.'/'.$fname) {
13916: $state = 'exists';
13917: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13918: } elsif (-e $path.'/'.$fname) {
13919: $state = 'exists';
13920: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13921: }
13922: if ($state eq 'exists') {
13923: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13924: }
13925: return ($state,$msg);
13926: }
13927:
13928: sub check_for_upload {
13929: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13930: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13931: my $filesize = length($env{'form.'.$element});
13932: if (!$filesize) {
13933: my $msg = '<span class="LC_error">'.
13934: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13935: '<span class="LC_filename">'.$fname.'</span>',
13936: $filesize).'<br />'.
1.1007 raeburn 13937: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13938: '</span>';
13939: return ('zero_bytes',$msg);
13940: }
13941: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13942: my $getpropath = 1;
1.1021 raeburn 13943: my ($dirlistref,$listerror) =
13944: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13945: my $found_file = 0;
13946: my $locked_file = 0;
1.991 raeburn 13947: my @lockers;
13948: my $navmap;
13949: if ($env{'request.course.id'}) {
13950: $navmap = Apache::lonnavmaps::navmap->new();
13951: }
1.1021 raeburn 13952: if (ref($dirlistref) eq 'ARRAY') {
13953: foreach my $line (@{$dirlistref}) {
13954: my ($file_name,$rest)=split(/\&/,$line,2);
13955: if ($file_name eq $fname){
13956: $file_name = $path.$file_name;
13957: if ($group ne '') {
13958: $file_name = $group.$file_name;
13959: }
13960: $found_file = 1;
13961: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13962: foreach my $lock (@lockers) {
13963: if (ref($lock) eq 'ARRAY') {
13964: my ($symb,$crsid) = @{$lock};
13965: if ($crsid eq $env{'request.course.id'}) {
13966: if (ref($navmap)) {
13967: my $res = $navmap->getBySymb($symb);
13968: foreach my $part (@{$res->parts()}) {
13969: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13970: unless (($slot_status == $res->RESERVED) ||
13971: ($slot_status == $res->RESERVED_LOCATION)) {
13972: $locked_file = 1;
13973: }
1.991 raeburn 13974: }
1.1021 raeburn 13975: } else {
13976: $locked_file = 1;
1.991 raeburn 13977: }
13978: } else {
13979: $locked_file = 1;
13980: }
13981: }
1.1021 raeburn 13982: }
13983: } else {
13984: my @info = split(/\&/,$rest);
13985: my $currsize = $info[6]/1000;
13986: if ($currsize < $filesize) {
13987: my $extra = $filesize - $currsize;
13988: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13989: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13990: &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 13991: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13992: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13993: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13994: return ('will_exceed_quota',$msg);
13995: }
1.984 raeburn 13996: }
13997: }
1.661 raeburn 13998: }
13999: }
14000: }
14001: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 14002: my $msg = '<p class="LC_warning">'.
14003: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 14004: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 14005: return ('will_exceed_quota',$msg);
14006: } elsif ($found_file) {
14007: if ($locked_file) {
1.1179 bisitz 14008: my $msg = '<p class="LC_warning">';
1.661 raeburn 14009: $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 14010: $msg .= '</p>';
1.661 raeburn 14011: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
14012: return ('file_locked',$msg);
14013: } else {
1.1179 bisitz 14014: my $msg = '<p class="LC_error">';
1.984 raeburn 14015: $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 14016: $msg .= '</p>';
1.984 raeburn 14017: return ('existingfile',$msg);
1.661 raeburn 14018: }
14019: }
14020: }
14021:
1.987 raeburn 14022: sub check_for_traversal {
14023: my ($path,$url,$toplevel) = @_;
14024: my @parts=split(/\//,$path);
14025: my $cleanpath;
14026: my $fullpath = $url;
14027: for (my $i=0;$i<@parts;$i++) {
14028: next if ($parts[$i] eq '.');
14029: if ($parts[$i] eq '..') {
14030: $fullpath =~ s{([^/]+/)$}{};
14031: } else {
14032: $fullpath .= $parts[$i].'/';
14033: }
14034: }
14035: if ($fullpath =~ /^\Q$url\E(.*)$/) {
14036: $cleanpath = $1;
14037: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
14038: my $curr_toprel = $1;
14039: my @parts = split(/\//,$curr_toprel);
14040: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
14041: my @urlparts = split(/\//,$url_toprel);
14042: my $doubledots;
14043: my $startdiff = -1;
14044: for (my $i=0; $i<@urlparts; $i++) {
14045: if ($startdiff == -1) {
14046: unless ($urlparts[$i] eq $parts[$i]) {
14047: $startdiff = $i;
14048: $doubledots .= '../';
14049: }
14050: } else {
14051: $doubledots .= '../';
14052: }
14053: }
14054: if ($startdiff > -1) {
14055: $cleanpath = $doubledots;
14056: for (my $i=$startdiff; $i<@parts; $i++) {
14057: $cleanpath .= $parts[$i].'/';
14058: }
14059: }
14060: }
14061: $cleanpath =~ s{(/)$}{};
14062: return $cleanpath;
14063: }
1.31 albertel 14064:
1.1053 raeburn 14065: sub is_archive_file {
14066: my ($mimetype) = @_;
14067: if (($mimetype eq 'application/octet-stream') ||
14068: ($mimetype eq 'application/x-stuffit') ||
14069: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
14070: return 1;
14071: }
14072: return;
14073: }
14074:
14075: sub decompress_form {
1.1065 raeburn 14076: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 14077: my %lt = &Apache::lonlocal::texthash (
14078: this => 'This file is an archive file.',
1.1067 raeburn 14079: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 14080: itsc => 'Its contents are as follows:',
1.1053 raeburn 14081: youm => 'You may wish to extract its contents.',
14082: extr => 'Extract contents',
1.1067 raeburn 14083: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
14084: proa => 'Process automatically?',
1.1053 raeburn 14085: yes => 'Yes',
14086: no => 'No',
1.1067 raeburn 14087: fold => 'Title for folder containing movie',
14088: movi => 'Title for page containing embedded movie',
1.1053 raeburn 14089: );
1.1065 raeburn 14090: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 14091: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 14092: my $info = &list_archive_contents($fileloc,\@paths);
14093: if (@paths) {
14094: foreach my $path (@paths) {
14095: $path =~ s{^/}{};
1.1067 raeburn 14096: if ($path =~ m{^([^/]+)/$}) {
14097: $topdir = $1;
14098: }
1.1065 raeburn 14099: if ($path =~ m{^([^/]+)/}) {
14100: $toplevel{$1} = $path;
14101: } else {
14102: $toplevel{$path} = $path;
14103: }
14104: }
14105: }
1.1067 raeburn 14106: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 14107: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 14108: "$topdir/media/",
14109: "$topdir/media/$topdir.mp4",
14110: "$topdir/media/FirstFrame.png",
14111: "$topdir/media/player.swf",
14112: "$topdir/media/swfobject.js",
14113: "$topdir/media/expressInstall.swf");
1.1197 raeburn 14114: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 14115: "$topdir/$topdir.mp4",
14116: "$topdir/$topdir\_config.xml",
14117: "$topdir/$topdir\_controller.swf",
14118: "$topdir/$topdir\_embed.css",
14119: "$topdir/$topdir\_First_Frame.png",
14120: "$topdir/$topdir\_player.html",
14121: "$topdir/$topdir\_Thumbnails.png",
14122: "$topdir/playerProductInstall.swf",
14123: "$topdir/scripts/",
14124: "$topdir/scripts/config_xml.js",
14125: "$topdir/scripts/handlebars.js",
14126: "$topdir/scripts/jquery-1.7.1.min.js",
14127: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
14128: "$topdir/scripts/modernizr.js",
14129: "$topdir/scripts/player-min.js",
14130: "$topdir/scripts/swfobject.js",
14131: "$topdir/skins/",
14132: "$topdir/skins/configuration_express.xml",
14133: "$topdir/skins/express_show/",
14134: "$topdir/skins/express_show/player-min.css",
14135: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 14136: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
14137: "$topdir/$topdir.mp4",
14138: "$topdir/$topdir\_config.xml",
14139: "$topdir/$topdir\_controller.swf",
14140: "$topdir/$topdir\_embed.css",
14141: "$topdir/$topdir\_First_Frame.png",
14142: "$topdir/$topdir\_player.html",
14143: "$topdir/$topdir\_Thumbnails.png",
14144: "$topdir/playerProductInstall.swf",
14145: "$topdir/scripts/",
14146: "$topdir/scripts/config_xml.js",
14147: "$topdir/scripts/techsmith-smart-player.min.js",
14148: "$topdir/skins/",
14149: "$topdir/skins/configuration_express.xml",
14150: "$topdir/skins/express_show/",
14151: "$topdir/skins/express_show/spritesheet.min.css",
14152: "$topdir/skins/express_show/spritesheet.png",
14153: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 14154: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 14155: if (@diffs == 0) {
1.1164 raeburn 14156: $is_camtasia = 6;
14157: } else {
1.1197 raeburn 14158: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 14159: if (@diffs == 0) {
14160: $is_camtasia = 8;
1.1197 raeburn 14161: } else {
14162: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14163: if (@diffs == 0) {
14164: $is_camtasia = 8;
14165: }
1.1164 raeburn 14166: }
1.1067 raeburn 14167: }
14168: }
14169: my $output;
14170: if ($is_camtasia) {
14171: $output = <<"ENDCAM";
14172: <script type="text/javascript" language="Javascript">
14173: // <![CDATA[
14174:
14175: function camtasiaToggle() {
14176: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14177: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14178: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14179: document.getElementById('camtasia_titles').style.display='block';
14180: } else {
14181: document.getElementById('camtasia_titles').style.display='none';
14182: }
14183: }
14184: }
14185: return;
14186: }
14187:
14188: // ]]>
14189: </script>
14190: <p>$lt{'camt'}</p>
14191: ENDCAM
1.1065 raeburn 14192: } else {
1.1067 raeburn 14193: $output = '<p>'.$lt{'this'};
14194: if ($info eq '') {
14195: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14196: } else {
14197: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14198: '<div><pre>'.$info.'</pre></div>';
14199: }
1.1065 raeburn 14200: }
1.1067 raeburn 14201: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14202: my $duplicates;
14203: my $num = 0;
14204: if (ref($dirlist) eq 'ARRAY') {
14205: foreach my $item (@{$dirlist}) {
14206: if (ref($item) eq 'ARRAY') {
14207: if (exists($toplevel{$item->[0]})) {
14208: $duplicates .=
14209: &start_data_table_row().
14210: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14211: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14212: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14213: 'value="1" />'.&mt('Yes').'</label>'.
14214: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14215: '<td>'.$item->[0].'</td>';
14216: if ($item->[2]) {
14217: $duplicates .= '<td>'.&mt('Directory').'</td>';
14218: } else {
14219: $duplicates .= '<td>'.&mt('File').'</td>';
14220: }
14221: $duplicates .= '<td>'.$item->[3].'</td>'.
14222: '<td>'.
14223: &Apache::lonlocal::locallocaltime($item->[4]).
14224: '</td>'.
14225: &end_data_table_row();
14226: $num ++;
14227: }
14228: }
14229: }
14230: }
14231: my $itemcount;
14232: if (@paths > 0) {
14233: $itemcount = scalar(@paths);
14234: } else {
14235: $itemcount = 1;
14236: }
1.1067 raeburn 14237: if ($is_camtasia) {
14238: $output .= $lt{'auto'}.'<br />'.
14239: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14240: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14241: $lt{'yes'}.'</label> <label>'.
14242: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14243: $lt{'no'}.'</label></span><br />'.
14244: '<div id="camtasia_titles" style="display:block">'.
14245: &Apache::lonhtmlcommon::start_pick_box().
14246: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14247: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14248: &Apache::lonhtmlcommon::row_closure().
14249: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14250: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14251: &Apache::lonhtmlcommon::row_closure(1).
14252: &Apache::lonhtmlcommon::end_pick_box().
14253: '</div>';
14254: }
1.1065 raeburn 14255: $output .=
14256: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14257: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14258: "\n";
1.1065 raeburn 14259: if ($duplicates ne '') {
14260: $output .= '<p><span class="LC_warning">'.
14261: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14262: &start_data_table().
14263: &start_data_table_header_row().
14264: '<th>'.&mt('Overwrite?').'</th>'.
14265: '<th>'.&mt('Name').'</th>'.
14266: '<th>'.&mt('Type').'</th>'.
14267: '<th>'.&mt('Size').'</th>'.
14268: '<th>'.&mt('Last modified').'</th>'.
14269: &end_data_table_header_row().
14270: $duplicates.
14271: &end_data_table().
14272: '</p>';
14273: }
1.1067 raeburn 14274: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14275: if (ref($hiddenelements) eq 'HASH') {
14276: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14277: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14278: }
14279: }
14280: $output .= <<"END";
1.1067 raeburn 14281: <br />
1.1053 raeburn 14282: <input type="submit" name="decompress" value="$lt{'extr'}" />
14283: </form>
14284: $noextract
14285: END
14286: return $output;
14287: }
14288:
1.1065 raeburn 14289: sub decompression_utility {
14290: my ($program) = @_;
14291: my @utilities = ('tar','gunzip','bunzip2','unzip');
14292: my $location;
14293: if (grep(/^\Q$program\E$/,@utilities)) {
14294: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14295: '/usr/sbin/') {
14296: if (-x $dir.$program) {
14297: $location = $dir.$program;
14298: last;
14299: }
14300: }
14301: }
14302: return $location;
14303: }
14304:
14305: sub list_archive_contents {
14306: my ($file,$pathsref) = @_;
14307: my (@cmd,$output);
14308: my $needsregexp;
14309: if ($file =~ /\.zip$/) {
14310: @cmd = (&decompression_utility('unzip'),"-l");
14311: $needsregexp = 1;
14312: } elsif (($file =~ m/\.tar\.gz$/) ||
14313: ($file =~ /\.tgz$/)) {
14314: @cmd = (&decompression_utility('tar'),"-ztf");
14315: } elsif ($file =~ /\.tar\.bz2$/) {
14316: @cmd = (&decompression_utility('tar'),"-jtf");
14317: } elsif ($file =~ m|\.tar$|) {
14318: @cmd = (&decompression_utility('tar'),"-tf");
14319: }
14320: if (@cmd) {
14321: undef($!);
14322: undef($@);
14323: if (open(my $fh,"-|", @cmd, $file)) {
14324: while (my $line = <$fh>) {
14325: $output .= $line;
14326: chomp($line);
14327: my $item;
14328: if ($needsregexp) {
14329: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14330: } else {
14331: $item = $line;
14332: }
14333: if ($item ne '') {
14334: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14335: push(@{$pathsref},$item);
14336: }
14337: }
14338: }
14339: close($fh);
14340: }
14341: }
14342: return $output;
14343: }
14344:
1.1053 raeburn 14345: sub decompress_uploaded_file {
14346: my ($file,$dir) = @_;
14347: &Apache::lonnet::appenv({'cgi.file' => $file});
14348: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14349: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14350: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14351: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14352: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14353: my $decompressed = $env{'cgi.decompressed'};
14354: &Apache::lonnet::delenv('cgi.file');
14355: &Apache::lonnet::delenv('cgi.dir');
14356: &Apache::lonnet::delenv('cgi.decompressed');
14357: return ($decompressed,$result);
14358: }
14359:
1.1055 raeburn 14360: sub process_decompression {
14361: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14362: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14363: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14364: &mt('Unexpected file path.').'</p>'."\n";
14365: }
14366: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14367: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14368: &mt('Unexpected course context.').'</p>'."\n";
14369: }
1.1293 raeburn 14370: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14371: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14372: &mt('Filename contained unexpected characters.').'</p>'."\n";
14373: }
1.1055 raeburn 14374: my ($dir,$error,$warning,$output);
1.1180 raeburn 14375: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14376: $error = &mt('Filename not a supported archive file type.').
14377: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14378: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14379: } else {
14380: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14381: if ($docuhome eq 'no_host') {
14382: $error = &mt('Could not determine home server for course.');
14383: } else {
14384: my @ids=&Apache::lonnet::current_machine_ids();
14385: my $currdir = "$dir_root/$destination";
14386: if (grep(/^\Q$docuhome\E$/,@ids)) {
14387: $dir = &LONCAPA::propath($docudom,$docuname).
14388: "$dir_root/$destination";
14389: } else {
14390: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14391: "$dir_root/$docudom/$docuname/$destination";
14392: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14393: $error = &mt('Archive file not found.');
14394: }
14395: }
1.1065 raeburn 14396: my (@to_overwrite,@to_skip);
14397: if ($env{'form.archive_overwrite_total'} > 0) {
14398: my $total = $env{'form.archive_overwrite_total'};
14399: for (my $i=0; $i<$total; $i++) {
14400: if ($env{'form.archive_overwrite_'.$i} == 1) {
14401: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14402: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14403: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14404: }
14405: }
14406: }
14407: my $numskip = scalar(@to_skip);
1.1292 raeburn 14408: my $numoverwrite = scalar(@to_overwrite);
14409: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14410: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14411: } elsif ($dir eq '') {
1.1055 raeburn 14412: $error = &mt('Directory containing archive file unavailable.');
14413: } elsif (!$error) {
1.1065 raeburn 14414: my ($decompressed,$display);
1.1292 raeburn 14415: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14416: my $tempdir = time.'_'.$$.int(rand(10000));
14417: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14418: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14419: ($decompressed,$display) =
14420: &decompress_uploaded_file($file,"$dir/$tempdir");
14421: foreach my $item (@to_skip) {
14422: if (($item ne '') && ($item !~ /\.\./)) {
14423: if (-f "$dir/$tempdir/$item") {
14424: unlink("$dir/$tempdir/$item");
14425: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14426: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14427: }
14428: }
14429: }
14430: foreach my $item (@to_overwrite) {
14431: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14432: if (($item ne '') && ($item !~ /\.\./)) {
14433: if (-f "$dir/$item") {
14434: unlink("$dir/$item");
14435: } elsif (-d "$dir/$item") {
1.1300 raeburn 14436: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14437: }
14438: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14439: }
1.1065 raeburn 14440: }
14441: }
1.1292 raeburn 14442: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14443: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14444: }
1.1065 raeburn 14445: }
14446: } else {
14447: ($decompressed,$display) =
14448: &decompress_uploaded_file($file,$dir);
14449: }
1.1055 raeburn 14450: if ($decompressed eq 'ok') {
1.1065 raeburn 14451: $output = '<p class="LC_info">'.
14452: &mt('Files extracted successfully from archive.').
14453: '</p>'."\n";
1.1055 raeburn 14454: my ($warning,$result,@contents);
14455: my ($newdirlistref,$newlisterror) =
14456: &Apache::lonnet::dirlist($currdir,$docudom,
14457: $docuname,1);
14458: my (%is_dir,%changes,@newitems);
14459: my $dirptr = 16384;
1.1065 raeburn 14460: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14461: foreach my $dir_line (@{$newdirlistref}) {
14462: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14463: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14464: push(@newitems,$item);
14465: if ($dirptr&$testdir) {
14466: $is_dir{$item} = 1;
14467: }
14468: $changes{$item} = 1;
14469: }
14470: }
14471: }
14472: if (keys(%changes) > 0) {
14473: foreach my $item (sort(@newitems)) {
14474: if ($changes{$item}) {
14475: push(@contents,$item);
14476: }
14477: }
14478: }
14479: if (@contents > 0) {
1.1067 raeburn 14480: my $wantform;
14481: unless ($env{'form.autoextract_camtasia'}) {
14482: $wantform = 1;
14483: }
1.1056 raeburn 14484: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14485: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14486: $currdir,\%is_dir,
14487: \%children,\%parent,
1.1056 raeburn 14488: \@contents,\%dirorder,
14489: \%titles,$wantform);
1.1055 raeburn 14490: if ($datatable ne '') {
14491: $output .= &archive_options_form('decompressed',$datatable,
14492: $count,$hiddenelem);
1.1065 raeburn 14493: my $startcount = 6;
1.1055 raeburn 14494: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14495: \%titles,\%children);
1.1055 raeburn 14496: }
1.1067 raeburn 14497: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14498: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14499: my %displayed;
14500: my $total = 1;
14501: $env{'form.archive_directory'} = [];
14502: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14503: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14504: $path =~ s{/$}{};
14505: my $item;
14506: if ($path ne '') {
14507: $item = "$path/$titles{$i}";
14508: } else {
14509: $item = $titles{$i};
14510: }
14511: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14512: if ($item eq $contents[0]) {
14513: push(@{$env{'form.archive_directory'}},$i);
14514: $env{'form.archive_'.$i} = 'display';
14515: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14516: $displayed{'folder'} = $i;
1.1164 raeburn 14517: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14518: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14519: $env{'form.archive_'.$i} = 'display';
14520: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14521: $displayed{'web'} = $i;
14522: } else {
1.1164 raeburn 14523: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14524: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14525: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14526: push(@{$env{'form.archive_directory'}},$i);
14527: }
14528: $env{'form.archive_'.$i} = 'dependency';
14529: }
14530: $total ++;
14531: }
14532: for (my $i=1; $i<$total; $i++) {
14533: next if ($i == $displayed{'web'});
14534: next if ($i == $displayed{'folder'});
14535: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14536: }
14537: $env{'form.phase'} = 'decompress_cleanup';
14538: $env{'form.archivedelete'} = 1;
14539: $env{'form.archive_count'} = $total-1;
14540: $output .=
14541: &process_extracted_files('coursedocs',$docudom,
14542: $docuname,$destination,
14543: $dir_root,$hiddenelem);
14544: }
1.1055 raeburn 14545: } else {
14546: $warning = &mt('No new items extracted from archive file.');
14547: }
14548: } else {
14549: $output = $display;
14550: $error = &mt('An error occurred during extraction from the archive file.');
14551: }
14552: }
14553: }
14554: }
14555: if ($error) {
14556: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14557: $error.'</p>'."\n";
14558: }
14559: if ($warning) {
14560: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14561: }
14562: return $output;
14563: }
14564:
14565: sub get_extracted {
1.1056 raeburn 14566: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14567: $titles,$wantform) = @_;
1.1055 raeburn 14568: my $count = 0;
14569: my $depth = 0;
14570: my $datatable;
1.1056 raeburn 14571: my @hierarchy;
1.1055 raeburn 14572: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14573: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14574: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14575: foreach my $item (@{$contents}) {
14576: $count ++;
1.1056 raeburn 14577: @{$dirorder->{$count}} = @hierarchy;
14578: $titles->{$count} = $item;
1.1055 raeburn 14579: &archive_hierarchy($depth,$count,$parent,$children);
14580: if ($wantform) {
14581: $datatable .= &archive_row($is_dir->{$item},$item,
14582: $currdir,$depth,$count);
14583: }
14584: if ($is_dir->{$item}) {
14585: $depth ++;
1.1056 raeburn 14586: push(@hierarchy,$count);
14587: $parent->{$depth} = $count;
1.1055 raeburn 14588: $datatable .=
14589: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14590: \$depth,\$count,\@hierarchy,$dirorder,
14591: $children,$parent,$titles,$wantform);
1.1055 raeburn 14592: $depth --;
1.1056 raeburn 14593: pop(@hierarchy);
1.1055 raeburn 14594: }
14595: }
14596: return ($count,$datatable);
14597: }
14598:
14599: sub recurse_extracted_archive {
1.1056 raeburn 14600: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14601: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14602: my $result='';
1.1056 raeburn 14603: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14604: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14605: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14606: return $result;
14607: }
14608: my $dirptr = 16384;
14609: my ($newdirlistref,$newlisterror) =
14610: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14611: if (ref($newdirlistref) eq 'ARRAY') {
14612: foreach my $dir_line (@{$newdirlistref}) {
14613: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14614: unless ($item =~ /^\.+$/) {
14615: $$count ++;
1.1056 raeburn 14616: @{$dirorder->{$$count}} = @{$hierarchy};
14617: $titles->{$$count} = $item;
1.1055 raeburn 14618: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14619:
1.1055 raeburn 14620: my $is_dir;
14621: if ($dirptr&$testdir) {
14622: $is_dir = 1;
14623: }
14624: if ($wantform) {
14625: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14626: }
14627: if ($is_dir) {
14628: $$depth ++;
1.1056 raeburn 14629: push(@{$hierarchy},$$count);
14630: $parent->{$$depth} = $$count;
1.1055 raeburn 14631: $result .=
14632: &recurse_extracted_archive("$currdir/$item",$docudom,
14633: $docuname,$depth,$count,
1.1056 raeburn 14634: $hierarchy,$dirorder,$children,
14635: $parent,$titles,$wantform);
1.1055 raeburn 14636: $$depth --;
1.1056 raeburn 14637: pop(@{$hierarchy});
1.1055 raeburn 14638: }
14639: }
14640: }
14641: }
14642: return $result;
14643: }
14644:
14645: sub archive_hierarchy {
14646: my ($depth,$count,$parent,$children) =@_;
14647: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14648: if (exists($parent->{$depth})) {
14649: $children->{$parent->{$depth}} .= $count.':';
14650: }
14651: }
14652: return;
14653: }
14654:
14655: sub archive_row {
14656: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14657: my ($name) = ($item =~ m{([^/]+)$});
14658: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14659: 'display' => 'Add as file',
1.1055 raeburn 14660: 'dependency' => 'Include as dependency',
14661: 'discard' => 'Discard',
14662: );
14663: if ($is_dir) {
1.1059 raeburn 14664: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14665: }
1.1056 raeburn 14666: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14667: my $offset = 0;
1.1055 raeburn 14668: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14669: $offset ++;
1.1065 raeburn 14670: if ($action ne 'display') {
14671: $offset ++;
14672: }
1.1055 raeburn 14673: $output .= '<td><span class="LC_nobreak">'.
14674: '<label><input type="radio" name="archive_'.$count.
14675: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14676: my $text = $choices{$action};
14677: if ($is_dir) {
14678: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14679: if ($action eq 'display') {
1.1059 raeburn 14680: $text = &mt('Add as folder');
1.1055 raeburn 14681: }
1.1056 raeburn 14682: } else {
14683: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14684:
14685: }
14686: $output .= ' /> '.$choices{$action}.'</label></span>';
14687: if ($action eq 'dependency') {
14688: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14689: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14690: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14691: '<option value=""></option>'."\n".
14692: '</select>'."\n".
14693: '</div>';
1.1059 raeburn 14694: } elsif ($action eq 'display') {
14695: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14696: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14697: '</div>';
1.1055 raeburn 14698: }
1.1056 raeburn 14699: $output .= '</td>';
1.1055 raeburn 14700: }
14701: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14702: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14703: for (my $i=0; $i<$depth; $i++) {
14704: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14705: }
14706: if ($is_dir) {
14707: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14708: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14709: } else {
14710: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14711: }
14712: $output .= ' '.$name.'</td>'."\n".
14713: &end_data_table_row();
14714: return $output;
14715: }
14716:
14717: sub archive_options_form {
1.1065 raeburn 14718: my ($form,$display,$count,$hiddenelem) = @_;
14719: my %lt = &Apache::lonlocal::texthash(
14720: perm => 'Permanently remove archive file?',
14721: hows => 'How should each extracted item be incorporated in the course?',
14722: cont => 'Content actions for all',
14723: addf => 'Add as folder/file',
14724: incd => 'Include as dependency for a displayed file',
14725: disc => 'Discard',
14726: no => 'No',
14727: yes => 'Yes',
14728: save => 'Save',
14729: );
14730: my $output = <<"END";
14731: <form name="$form" method="post" action="">
14732: <p><span class="LC_nobreak">$lt{'perm'}
14733: <label>
14734: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14735: </label>
14736:
14737: <label>
14738: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14739: </span>
14740: </p>
14741: <input type="hidden" name="phase" value="decompress_cleanup" />
14742: <br />$lt{'hows'}
14743: <div class="LC_columnSection">
14744: <fieldset>
14745: <legend>$lt{'cont'}</legend>
14746: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14747: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14748: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14749: </fieldset>
14750: </div>
14751: END
14752: return $output.
1.1055 raeburn 14753: &start_data_table()."\n".
1.1065 raeburn 14754: $display."\n".
1.1055 raeburn 14755: &end_data_table()."\n".
14756: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14757: $hiddenelem.
1.1065 raeburn 14758: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14759: '</form>';
14760: }
14761:
14762: sub archive_javascript {
1.1056 raeburn 14763: my ($startcount,$numitems,$titles,$children) = @_;
14764: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14765: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14766: my $scripttag = <<START;
14767: <script type="text/javascript">
14768: // <![CDATA[
14769:
14770: function checkAll(form,prefix) {
14771: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14772: for (var i=0; i < form.elements.length; i++) {
14773: var id = form.elements[i].id;
14774: if ((id != '') && (id != undefined)) {
14775: if (idstr.test(id)) {
14776: if (form.elements[i].type == 'radio') {
14777: form.elements[i].checked = true;
1.1056 raeburn 14778: var nostart = i-$startcount;
1.1059 raeburn 14779: var offset = nostart%7;
14780: var count = (nostart-offset)/7;
1.1056 raeburn 14781: dependencyCheck(form,count,offset);
1.1055 raeburn 14782: }
14783: }
14784: }
14785: }
14786: }
14787:
14788: function propagateCheck(form,count) {
14789: if (count > 0) {
1.1059 raeburn 14790: var startelement = $startcount + ((count-1) * 7);
14791: for (var j=1; j<6; j++) {
14792: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14793: var item = startelement + j;
14794: if (form.elements[item].type == 'radio') {
14795: if (form.elements[item].checked) {
14796: containerCheck(form,count,j);
14797: break;
14798: }
1.1055 raeburn 14799: }
14800: }
14801: }
14802: }
14803: }
14804:
14805: numitems = $numitems
1.1056 raeburn 14806: var titles = new Array(numitems);
14807: var parents = new Array(numitems);
1.1055 raeburn 14808: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14809: parents[i] = new Array;
1.1055 raeburn 14810: }
1.1059 raeburn 14811: var maintitle = '$maintitle';
1.1055 raeburn 14812:
14813: START
14814:
1.1056 raeburn 14815: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14816: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14817: for (my $i=0; $i<@contents; $i ++) {
14818: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14819: }
14820: }
14821:
1.1056 raeburn 14822: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14823: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14824: }
14825:
1.1055 raeburn 14826: $scripttag .= <<END;
14827:
14828: function containerCheck(form,count,offset) {
14829: if (count > 0) {
1.1056 raeburn 14830: dependencyCheck(form,count,offset);
1.1059 raeburn 14831: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14832: form.elements[item].checked = true;
14833: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14834: if (parents[count].length > 0) {
14835: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14836: containerCheck(form,parents[count][j],offset);
14837: }
14838: }
14839: }
14840: }
14841: }
14842:
14843: function dependencyCheck(form,count,offset) {
14844: if (count > 0) {
1.1059 raeburn 14845: var chosen = (offset+$startcount)+7*(count-1);
14846: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14847: var currtype = form.elements[depitem].type;
14848: if (form.elements[chosen].value == 'dependency') {
14849: document.getElementById('arc_depon_'+count).style.display='block';
14850: form.elements[depitem].options.length = 0;
14851: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14852: for (var i=1; i<=numitems; i++) {
14853: if (i == count) {
14854: continue;
14855: }
1.1059 raeburn 14856: var startelement = $startcount + (i-1) * 7;
14857: for (var j=1; j<6; j++) {
14858: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14859: var item = startelement + j;
14860: if (form.elements[item].type == 'radio') {
14861: if (form.elements[item].checked) {
14862: if (form.elements[item].value == 'display') {
14863: var n = form.elements[depitem].options.length;
14864: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14865: }
14866: }
14867: }
14868: }
14869: }
14870: }
14871: } else {
14872: document.getElementById('arc_depon_'+count).style.display='none';
14873: form.elements[depitem].options.length = 0;
14874: form.elements[depitem].options[0] = new Option('Select','',true,true);
14875: }
1.1059 raeburn 14876: titleCheck(form,count,offset);
1.1056 raeburn 14877: }
14878: }
14879:
14880: function propagateSelect(form,count,offset) {
14881: if (count > 0) {
1.1065 raeburn 14882: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14883: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14884: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14885: if (parents[count].length > 0) {
14886: for (var j=0; j<parents[count].length; j++) {
14887: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14888: }
14889: }
14890: }
14891: }
14892: }
1.1056 raeburn 14893:
14894: function containerSelect(form,count,offset,picked) {
14895: if (count > 0) {
1.1065 raeburn 14896: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14897: if (form.elements[item].type == 'radio') {
14898: if (form.elements[item].value == 'dependency') {
14899: if (form.elements[item+1].type == 'select-one') {
14900: for (var i=0; i<form.elements[item+1].options.length; i++) {
14901: if (form.elements[item+1].options[i].value == picked) {
14902: form.elements[item+1].selectedIndex = i;
14903: break;
14904: }
14905: }
14906: }
14907: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14908: if (parents[count].length > 0) {
14909: for (var j=0; j<parents[count].length; j++) {
14910: containerSelect(form,parents[count][j],offset,picked);
14911: }
14912: }
14913: }
14914: }
14915: }
14916: }
14917: }
14918:
1.1059 raeburn 14919: function titleCheck(form,count,offset) {
14920: if (count > 0) {
14921: var chosen = (offset+$startcount)+7*(count-1);
14922: var depitem = $startcount + ((count-1) * 7) + 2;
14923: var currtype = form.elements[depitem].type;
14924: if (form.elements[chosen].value == 'display') {
14925: document.getElementById('arc_title_'+count).style.display='block';
14926: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14927: document.getElementById('archive_title_'+count).value=maintitle;
14928: }
14929: } else {
14930: document.getElementById('arc_title_'+count).style.display='none';
14931: if (currtype == 'text') {
14932: document.getElementById('archive_title_'+count).value='';
14933: }
14934: }
14935: }
14936: return;
14937: }
14938:
1.1055 raeburn 14939: // ]]>
14940: </script>
14941: END
14942: return $scripttag;
14943: }
14944:
14945: sub process_extracted_files {
1.1067 raeburn 14946: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14947: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14948: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14949: my @ids=&Apache::lonnet::current_machine_ids();
14950: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14951: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14952: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14953: if (grep(/^\Q$docuhome\E$/,@ids)) {
14954: $prefix = &LONCAPA::propath($docudom,$docuname);
14955: $pathtocheck = "$dir_root/$destination";
14956: $dir = $dir_root;
14957: $ishome = 1;
14958: } else {
14959: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14960: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14961: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14962: }
14963: my $currdir = "$dir_root/$destination";
14964: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14965: if ($env{'form.folderpath'}) {
14966: my @items = split('&',$env{'form.folderpath'});
14967: $folders{'0'} = $items[-2];
1.1099 raeburn 14968: if ($env{'form.folderpath'} =~ /\:1$/) {
14969: $containers{'0'}='page';
14970: } else {
14971: $containers{'0'}='sequence';
14972: }
1.1055 raeburn 14973: }
14974: my @archdirs = &get_env_multiple('form.archive_directory');
14975: if ($numitems) {
14976: for (my $i=1; $i<=$numitems; $i++) {
14977: my $path = $env{'form.archive_content_'.$i};
14978: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14979: my $item = $1;
14980: $toplevelitems{$item} = $i;
14981: if (grep(/^\Q$i\E$/,@archdirs)) {
14982: $is_dir{$item} = 1;
14983: }
14984: }
14985: }
14986: }
1.1067 raeburn 14987: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14988: if (keys(%toplevelitems) > 0) {
14989: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14990: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14991: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14992: }
1.1066 raeburn 14993: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14994: if ($numitems) {
14995: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14996: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14997: my $path = $env{'form.archive_content_'.$i};
14998: if ($path =~ /^\Q$pathtocheck\E/) {
14999: if ($env{'form.archive_'.$i} eq 'discard') {
15000: if ($prefix ne '' && $path ne '') {
15001: if (-e $prefix.$path) {
1.1066 raeburn 15002: if ((@archdirs > 0) &&
15003: (grep(/^\Q$i\E$/,@archdirs))) {
15004: $todeletedir{$prefix.$path} = 1;
15005: } else {
15006: $todelete{$prefix.$path} = 1;
15007: }
1.1055 raeburn 15008: }
15009: }
15010: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 15011: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 15012: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 15013: $docstitle = $env{'form.archive_title_'.$i};
15014: if ($docstitle eq '') {
15015: $docstitle = $title;
15016: }
1.1055 raeburn 15017: $outer = 0;
1.1056 raeburn 15018: if (ref($dirorder{$i}) eq 'ARRAY') {
15019: if (@{$dirorder{$i}} > 0) {
15020: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 15021: if ($env{'form.archive_'.$item} eq 'display') {
15022: $outer = $item;
15023: last;
15024: }
15025: }
15026: }
15027: }
15028: my ($errtext,$fatal) =
15029: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
15030: '/'.$folders{$outer}.'.'.
15031: $containers{$outer});
15032: next if ($fatal);
15033: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
15034: if ($context eq 'coursedocs') {
1.1056 raeburn 15035: $mapinner{$i} = time;
1.1055 raeburn 15036: $folders{$i} = 'default_'.$mapinner{$i};
15037: $containers{$i} = 'sequence';
15038: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
15039: $folders{$i}.'.'.$containers{$i};
15040: my $newidx = &LONCAPA::map::getresidx();
15041: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 15042: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 15043: push(@LONCAPA::map::order,$newidx);
15044: my ($outtext,$errtext) =
15045: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
15046: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 15047: '.'.$containers{$outer},1,1);
1.1056 raeburn 15048: $newseqid{$i} = $newidx;
1.1067 raeburn 15049: unless ($errtext) {
1.1294 raeburn 15050: $result .= '<li>'.&mt('Folder: [_1] added to course',
15051: &HTML::Entities::encode($docstitle,'<>&"')).
15052: '</li>'."\n";
1.1067 raeburn 15053: }
1.1055 raeburn 15054: }
15055: } else {
15056: if ($context eq 'coursedocs') {
15057: my $newidx=&LONCAPA::map::getresidx();
15058: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
15059: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
15060: $title;
1.1392 raeburn 15061: if (($outer !~ /\D/) &&
15062: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
15063: ($newidx !~ /\D/)) {
1.1294 raeburn 15064: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
15065: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
15066: }
15067: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
15068: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
15069: }
15070: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
15071: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
15072: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
15073: unless ($ishome) {
15074: my $fetch = "$newdest{$i}/$title";
15075: $fetch =~ s/^\Q$prefix$dir\E//;
15076: $prompttofetch{$fetch} = 1;
15077: }
1.1292 raeburn 15078: }
1.1067 raeburn 15079: }
1.1294 raeburn 15080: $LONCAPA::map::resources[$newidx]=
15081: $docstitle.':'.$url.':false:normal:res';
15082: push(@LONCAPA::map::order, $newidx);
15083: my ($outtext,$errtext)=
15084: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
15085: $docuname.'/'.$folders{$outer}.
15086: '.'.$containers{$outer},1,1);
15087: unless ($errtext) {
15088: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
15089: $result .= '<li>'.&mt('File: [_1] added to course',
15090: &HTML::Entities::encode($docstitle,'<>&"')).
15091: '</li>'."\n";
15092: }
1.1067 raeburn 15093: }
1.1294 raeburn 15094: } else {
15095: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
15096: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 15097: }
1.1055 raeburn 15098: }
15099: }
1.1086 raeburn 15100: }
15101: } else {
1.1294 raeburn 15102: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
15103: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 15104: }
15105: }
15106: for (my $i=1; $i<=$numitems; $i++) {
15107: next unless ($env{'form.archive_'.$i} eq 'dependency');
15108: my $path = $env{'form.archive_content_'.$i};
15109: if ($path =~ /^\Q$pathtocheck\E/) {
15110: my ($title) = ($path =~ m{/([^/]+)$});
15111: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
15112: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
15113: if (ref($dirorder{$i}) eq 'ARRAY') {
15114: my ($itemidx,$fullpath,$relpath);
15115: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
15116: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 15117: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 15118: if ($dirorder{$i}->[$j] eq $container) {
15119: $itemidx = $j;
1.1056 raeburn 15120: }
15121: }
1.1086 raeburn 15122: }
15123: if ($itemidx eq '') {
15124: $itemidx = 0;
15125: }
15126: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
15127: if ($mapinner{$referrer{$i}}) {
15128: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
15129: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15130: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15131: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15132: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15133: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15134: if (!-e $fullpath) {
15135: mkdir($fullpath,0755);
1.1056 raeburn 15136: }
15137: }
1.1086 raeburn 15138: } else {
15139: last;
1.1056 raeburn 15140: }
1.1086 raeburn 15141: }
15142: }
15143: } elsif ($newdest{$referrer{$i}}) {
15144: $fullpath = $newdest{$referrer{$i}};
15145: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15146: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
15147: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
15148: last;
15149: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15150: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15151: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15152: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15153: if (!-e $fullpath) {
15154: mkdir($fullpath,0755);
1.1056 raeburn 15155: }
15156: }
1.1086 raeburn 15157: } else {
15158: last;
1.1056 raeburn 15159: }
1.1055 raeburn 15160: }
15161: }
1.1086 raeburn 15162: if ($fullpath ne '') {
15163: if (-e "$prefix$path") {
1.1292 raeburn 15164: unless (rename("$prefix$path","$fullpath/$title")) {
15165: $warning .= &mt('Failed to rename dependency').'<br />';
15166: }
1.1086 raeburn 15167: }
15168: if (-e "$fullpath/$title") {
15169: my $showpath;
15170: if ($relpath ne '') {
15171: $showpath = "$relpath/$title";
15172: } else {
15173: $showpath = "/$title";
15174: }
1.1294 raeburn 15175: $result .= '<li>'.&mt('[_1] included as a dependency',
15176: &HTML::Entities::encode($showpath,'<>&"')).
15177: '</li>'."\n";
1.1292 raeburn 15178: unless ($ishome) {
15179: my $fetch = "$fullpath/$title";
15180: $fetch =~ s/^\Q$prefix$dir\E//;
15181: $prompttofetch{$fetch} = 1;
15182: }
1.1086 raeburn 15183: }
15184: }
1.1055 raeburn 15185: }
1.1086 raeburn 15186: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15187: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15188: &HTML::Entities::encode($path,'<>&"'),
15189: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15190: '<br />';
1.1055 raeburn 15191: }
15192: } else {
1.1294 raeburn 15193: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15194: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15195: }
15196: }
15197: if (keys(%todelete)) {
15198: foreach my $key (keys(%todelete)) {
15199: unlink($key);
1.1066 raeburn 15200: }
15201: }
15202: if (keys(%todeletedir)) {
15203: foreach my $key (keys(%todeletedir)) {
15204: rmdir($key);
15205: }
15206: }
15207: foreach my $dir (sort(keys(%is_dir))) {
15208: if (($pathtocheck ne '') && ($dir ne '')) {
15209: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15210: }
15211: }
1.1067 raeburn 15212: if ($result ne '') {
15213: $output .= '<ul>'."\n".
15214: $result."\n".
15215: '</ul>';
15216: }
15217: unless ($ishome) {
15218: my $replicationfail;
15219: foreach my $item (keys(%prompttofetch)) {
15220: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15221: unless ($fetchresult eq 'ok') {
15222: $replicationfail .= '<li>'.$item.'</li>'."\n";
15223: }
15224: }
15225: if ($replicationfail) {
15226: $output .= '<p class="LC_error">'.
15227: &mt('Course home server failed to retrieve:').'<ul>'.
15228: $replicationfail.
15229: '</ul></p>';
15230: }
15231: }
1.1055 raeburn 15232: } else {
15233: $warning = &mt('No items found in archive.');
15234: }
15235: if ($error) {
15236: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15237: $error.'</p>'."\n";
15238: }
15239: if ($warning) {
15240: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15241: }
15242: return $output;
15243: }
15244:
1.1066 raeburn 15245: sub cleanup_empty_dirs {
15246: my ($path) = @_;
15247: if (($path ne '') && (-d $path)) {
15248: if (opendir(my $dirh,$path)) {
15249: my @dircontents = grep(!/^\./,readdir($dirh));
15250: my $numitems = 0;
15251: foreach my $item (@dircontents) {
15252: if (-d "$path/$item") {
1.1111 raeburn 15253: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15254: if (-e "$path/$item") {
15255: $numitems ++;
15256: }
15257: } else {
15258: $numitems ++;
15259: }
15260: }
15261: if ($numitems == 0) {
15262: rmdir($path);
15263: }
15264: closedir($dirh);
15265: }
15266: }
15267: return;
15268: }
15269:
1.41 ng 15270: =pod
1.45 matthew 15271:
1.1162 raeburn 15272: =item * &get_folder_hierarchy()
1.1068 raeburn 15273:
15274: Provides hierarchy of names of folders/sub-folders containing the current
15275: item,
15276:
15277: Inputs: 3
15278: - $navmap - navmaps object
15279:
15280: - $map - url for map (either the trigger itself, or map containing
15281: the resource, which is the trigger).
15282:
15283: - $showitem - 1 => show title for map itself; 0 => do not show.
15284:
15285: Outputs: 1 @pathitems - array of folder/subfolder names.
15286:
15287: =cut
15288:
15289: sub get_folder_hierarchy {
15290: my ($navmap,$map,$showitem) = @_;
15291: my @pathitems;
15292: if (ref($navmap)) {
15293: my $mapres = $navmap->getResourceByUrl($map);
15294: if (ref($mapres)) {
15295: my $pcslist = $mapres->map_hierarchy();
15296: if ($pcslist ne '') {
15297: my @pcs = split(/,/,$pcslist);
15298: foreach my $pc (@pcs) {
15299: if ($pc == 1) {
1.1129 raeburn 15300: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15301: } else {
15302: my $res = $navmap->getByMapPc($pc);
15303: if (ref($res)) {
15304: my $title = $res->compTitle();
15305: $title =~ s/\W+/_/g;
15306: if ($title ne '') {
15307: push(@pathitems,$title);
15308: }
15309: }
15310: }
15311: }
15312: }
1.1071 raeburn 15313: if ($showitem) {
15314: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15315: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15316: } else {
15317: my $maptitle = $mapres->compTitle();
15318: $maptitle =~ s/\W+/_/g;
15319: if ($maptitle ne '') {
15320: push(@pathitems,$maptitle);
15321: }
1.1068 raeburn 15322: }
15323: }
15324: }
15325: }
15326: return @pathitems;
15327: }
15328:
15329: =pod
15330:
1.1015 raeburn 15331: =item * &get_turnedin_filepath()
15332:
15333: Determines path in a user's portfolio file for storage of files uploaded
15334: to a specific essayresponse or dropbox item.
15335:
15336: Inputs: 3 required + 1 optional.
15337: $symb is symb for resource, $uname and $udom are for current user (required).
15338: $caller is optional (can be "submission", if routine is called when storing
15339: an upoaded file when "Submit Answer" button was pressed).
15340:
15341: Returns array containing $path and $multiresp.
15342: $path is path in portfolio. $multiresp is 1 if this resource contains more
15343: than one file upload item. Callers of routine should append partid as a
15344: subdirectory to $path in cases where $multiresp is 1.
15345:
15346: Called by: homework/essayresponse.pm and homework/structuretags.pm
15347:
15348: =cut
15349:
15350: sub get_turnedin_filepath {
15351: my ($symb,$uname,$udom,$caller) = @_;
15352: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15353: my $turnindir;
15354: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15355: $turnindir = $userhash{'turnindir'};
15356: my ($path,$multiresp);
15357: if ($turnindir eq '') {
15358: if ($caller eq 'submission') {
15359: $turnindir = &mt('turned in');
15360: $turnindir =~ s/\W+/_/g;
15361: my %newhash = (
15362: 'turnindir' => $turnindir,
15363: );
15364: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15365: }
15366: }
15367: if ($turnindir ne '') {
15368: $path = '/'.$turnindir.'/';
15369: my ($multipart,$turnin,@pathitems);
15370: my $navmap = Apache::lonnavmaps::navmap->new();
15371: if (defined($navmap)) {
15372: my $mapres = $navmap->getResourceByUrl($map);
15373: if (ref($mapres)) {
15374: my $pcslist = $mapres->map_hierarchy();
15375: if ($pcslist ne '') {
15376: foreach my $pc (split(/,/,$pcslist)) {
15377: my $res = $navmap->getByMapPc($pc);
15378: if (ref($res)) {
15379: my $title = $res->compTitle();
15380: $title =~ s/\W+/_/g;
15381: if ($title ne '') {
1.1149 raeburn 15382: if (($pc > 1) && (length($title) > 12)) {
15383: $title = substr($title,0,12);
15384: }
1.1015 raeburn 15385: push(@pathitems,$title);
15386: }
15387: }
15388: }
15389: }
15390: my $maptitle = $mapres->compTitle();
15391: $maptitle =~ s/\W+/_/g;
15392: if ($maptitle ne '') {
1.1149 raeburn 15393: if (length($maptitle) > 12) {
15394: $maptitle = substr($maptitle,0,12);
15395: }
1.1015 raeburn 15396: push(@pathitems,$maptitle);
15397: }
15398: unless ($env{'request.state'} eq 'construct') {
15399: my $res = $navmap->getBySymb($symb);
15400: if (ref($res)) {
15401: my $partlist = $res->parts();
15402: my $totaluploads = 0;
15403: if (ref($partlist) eq 'ARRAY') {
15404: foreach my $part (@{$partlist}) {
15405: my @types = $res->responseType($part);
15406: my @ids = $res->responseIds($part);
15407: for (my $i=0; $i < scalar(@ids); $i++) {
15408: if ($types[$i] eq 'essay') {
15409: my $partid = $part.'_'.$ids[$i];
15410: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15411: $totaluploads ++;
15412: }
15413: }
15414: }
15415: }
15416: if ($totaluploads > 1) {
15417: $multiresp = 1;
15418: }
15419: }
15420: }
15421: }
15422: } else {
15423: return;
15424: }
15425: } else {
15426: return;
15427: }
15428: my $restitle=&Apache::lonnet::gettitle($symb);
15429: $restitle =~ s/\W+/_/g;
15430: if ($restitle eq '') {
15431: $restitle = ($resurl =~ m{/[^/]+$});
15432: if ($restitle eq '') {
15433: $restitle = time;
15434: }
15435: }
1.1149 raeburn 15436: if (length($restitle) > 12) {
15437: $restitle = substr($restitle,0,12);
15438: }
1.1015 raeburn 15439: push(@pathitems,$restitle);
15440: $path .= join('/',@pathitems);
15441: }
15442: return ($path,$multiresp);
15443: }
15444:
15445: =pod
15446:
1.464 albertel 15447: =back
1.41 ng 15448:
1.112 bowersj2 15449: =head1 CSV Upload/Handling functions
1.38 albertel 15450:
1.41 ng 15451: =over 4
15452:
1.648 raeburn 15453: =item * &upfile_store($r)
1.41 ng 15454:
15455: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15456: needs $env{'form.upfile'}
1.41 ng 15457: returns $datatoken to be put into hidden field
15458:
15459: =cut
1.31 albertel 15460:
15461: sub upfile_store {
15462: my $r=shift;
1.258 albertel 15463: $env{'form.upfile'}=~s/\r/\n/gs;
15464: $env{'form.upfile'}=~s/\f/\n/gs;
15465: $env{'form.upfile'}=~s/\n+/\n/gs;
15466: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15467:
1.1299 raeburn 15468: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15469: '_enroll_'.$env{'request.course.id'}.'_'.
15470: time.'_'.$$);
15471: return if ($datatoken eq '');
15472:
1.31 albertel 15473: {
1.158 raeburn 15474: my $datafile = $r->dir_config('lonDaemons').
15475: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15476: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15477: print $fh $env{'form.upfile'};
1.158 raeburn 15478: close($fh);
15479: }
1.31 albertel 15480: }
15481: return $datatoken;
15482: }
15483:
1.56 matthew 15484: =pod
15485:
1.1290 raeburn 15486: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15487:
15488: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15489: $datatoken is the name to assign to the temporary file.
1.258 albertel 15490: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15491:
15492: =cut
1.31 albertel 15493:
15494: sub load_tmp_file {
1.1290 raeburn 15495: my ($r,$datatoken) = @_;
15496: return if ($datatoken eq '');
1.31 albertel 15497: my @studentdata=();
15498: {
1.158 raeburn 15499: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15500: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15501: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15502: @studentdata=<$fh>;
15503: close($fh);
15504: }
1.31 albertel 15505: }
1.258 albertel 15506: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15507: }
15508:
1.1290 raeburn 15509: sub valid_datatoken {
15510: my ($datatoken) = @_;
1.1325 raeburn 15511: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15512: return $datatoken;
15513: }
15514: return;
15515: }
15516:
1.56 matthew 15517: =pod
15518:
1.648 raeburn 15519: =item * &upfile_record_sep()
1.41 ng 15520:
15521: Separate uploaded file into records
15522: returns array of records,
1.258 albertel 15523: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15524:
15525: =cut
1.31 albertel 15526:
15527: sub upfile_record_sep {
1.258 albertel 15528: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15529: } else {
1.248 albertel 15530: my @records;
1.258 albertel 15531: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15532: if ($line=~/^\s*$/) { next; }
15533: push(@records,$line);
15534: }
15535: return @records;
1.31 albertel 15536: }
15537: }
15538:
1.56 matthew 15539: =pod
15540:
1.648 raeburn 15541: =item * &record_sep($record)
1.41 ng 15542:
1.258 albertel 15543: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15544:
15545: =cut
15546:
1.263 www 15547: sub takeleft {
15548: my $index=shift;
15549: return substr('0000'.$index,-4,4);
15550: }
15551:
1.31 albertel 15552: sub record_sep {
15553: my $record=shift;
15554: my %components=();
1.258 albertel 15555: if ($env{'form.upfiletype'} eq 'xml') {
15556: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15557: my $i=0;
1.356 albertel 15558: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15559: $field=~s/^(\"|\')//;
15560: $field=~s/(\"|\')$//;
1.263 www 15561: $components{&takeleft($i)}=$field;
1.31 albertel 15562: $i++;
15563: }
1.258 albertel 15564: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15565: my $i=0;
1.356 albertel 15566: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15567: $field=~s/^(\"|\')//;
15568: $field=~s/(\"|\')$//;
1.263 www 15569: $components{&takeleft($i)}=$field;
1.31 albertel 15570: $i++;
15571: }
15572: } else {
1.561 www 15573: my $separator=',';
1.480 banghart 15574: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15575: $separator=';';
1.480 banghart 15576: }
1.31 albertel 15577: my $i=0;
1.561 www 15578: # the character we are looking for to indicate the end of a quote or a record
15579: my $looking_for=$separator;
15580: # do not add the characters to the fields
15581: my $ignore=0;
15582: # we just encountered a separator (or the beginning of the record)
15583: my $just_found_separator=1;
15584: # store the field we are working on here
15585: my $field='';
15586: # work our way through all characters in record
15587: foreach my $character ($record=~/(.)/g) {
15588: if ($character eq $looking_for) {
15589: if ($character ne $separator) {
15590: # Found the end of a quote, again looking for separator
15591: $looking_for=$separator;
15592: $ignore=1;
15593: } else {
15594: # Found a separator, store away what we got
15595: $components{&takeleft($i)}=$field;
15596: $i++;
15597: $just_found_separator=1;
15598: $ignore=0;
15599: $field='';
15600: }
15601: next;
15602: }
15603: # single or double quotation marks after a separator indicate beginning of a quote
15604: # we are now looking for the end of the quote and need to ignore separators
15605: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15606: $looking_for=$character;
15607: next;
15608: }
15609: # ignore would be true after we reached the end of a quote
15610: if ($ignore) { next; }
15611: if (($just_found_separator) && ($character=~/\s/)) { next; }
15612: $field.=$character;
15613: $just_found_separator=0;
1.31 albertel 15614: }
1.561 www 15615: # catch the very last entry, since we never encountered the separator
15616: $components{&takeleft($i)}=$field;
1.31 albertel 15617: }
15618: return %components;
15619: }
15620:
1.144 matthew 15621: ######################################################
15622: ######################################################
15623:
1.56 matthew 15624: =pod
15625:
1.648 raeburn 15626: =item * &upfile_select_html()
1.41 ng 15627:
1.144 matthew 15628: Return HTML code to select a file from the users machine and specify
15629: the file type.
1.41 ng 15630:
15631: =cut
15632:
1.144 matthew 15633: ######################################################
15634: ######################################################
1.31 albertel 15635: sub upfile_select_html {
1.144 matthew 15636: my %Types = (
15637: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15638: semisv => &mt('Semicolon separated values'),
1.144 matthew 15639: space => &mt('Space separated'),
15640: tab => &mt('Tabulator separated'),
15641: # xml => &mt('HTML/XML'),
15642: );
15643: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15644: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15645: foreach my $type (sort(keys(%Types))) {
15646: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15647: }
15648: $Str .= "</select>\n";
15649: return $Str;
1.31 albertel 15650: }
15651:
1.301 albertel 15652: sub get_samples {
15653: my ($records,$toget) = @_;
15654: my @samples=({});
15655: my $got=0;
15656: foreach my $rec (@$records) {
15657: my %temp = &record_sep($rec);
15658: if (! grep(/\S/, values(%temp))) { next; }
15659: if (%temp) {
15660: $samples[$got]=\%temp;
15661: $got++;
15662: if ($got == $toget) { last; }
15663: }
15664: }
15665: return \@samples;
15666: }
15667:
1.144 matthew 15668: ######################################################
15669: ######################################################
15670:
1.56 matthew 15671: =pod
15672:
1.648 raeburn 15673: =item * &csv_print_samples($r,$records)
1.41 ng 15674:
15675: Prints a table of sample values from each column uploaded $r is an
15676: Apache Request ref, $records is an arrayref from
15677: &Apache::loncommon::upfile_record_sep
15678:
15679: =cut
15680:
1.144 matthew 15681: ######################################################
15682: ######################################################
1.31 albertel 15683: sub csv_print_samples {
15684: my ($r,$records) = @_;
1.662 bisitz 15685: my $samples = &get_samples($records,5);
1.301 albertel 15686:
1.594 raeburn 15687: $r->print(&mt('Samples').'<br />'.&start_data_table().
15688: &start_data_table_header_row());
1.356 albertel 15689: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15690: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15691: $r->print(&end_data_table_header_row());
1.301 albertel 15692: foreach my $hash (@$samples) {
1.594 raeburn 15693: $r->print(&start_data_table_row());
1.356 albertel 15694: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15695: $r->print('<td>');
1.356 albertel 15696: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15697: $r->print('</td>');
15698: }
1.594 raeburn 15699: $r->print(&end_data_table_row());
1.31 albertel 15700: }
1.594 raeburn 15701: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15702: }
15703:
1.144 matthew 15704: ######################################################
15705: ######################################################
15706:
1.56 matthew 15707: =pod
15708:
1.648 raeburn 15709: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15710:
15711: Prints a table to create associations between values and table columns.
1.144 matthew 15712:
1.41 ng 15713: $r is an Apache Request ref,
15714: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15715: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15716:
15717: =cut
15718:
1.144 matthew 15719: ######################################################
15720: ######################################################
1.31 albertel 15721: sub csv_print_select_table {
15722: my ($r,$records,$d) = @_;
1.301 albertel 15723: my $i=0;
15724: my $samples = &get_samples($records,1);
1.144 matthew 15725: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15726: &start_data_table().&start_data_table_header_row().
1.144 matthew 15727: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15728: '<th>'.&mt('Column').'</th>'.
15729: &end_data_table_header_row()."\n");
1.356 albertel 15730: foreach my $array_ref (@$d) {
15731: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15732: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15733:
1.875 bisitz 15734: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15735: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15736: $r->print('<option value="none"></option>');
1.356 albertel 15737: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15738: $r->print('<option value="'.$sample.'"'.
15739: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15740: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15741: }
1.594 raeburn 15742: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15743: $i++;
15744: }
1.594 raeburn 15745: $r->print(&end_data_table());
1.31 albertel 15746: $i--;
15747: return $i;
15748: }
1.56 matthew 15749:
1.144 matthew 15750: ######################################################
15751: ######################################################
15752:
1.56 matthew 15753: =pod
1.31 albertel 15754:
1.648 raeburn 15755: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15756:
15757: Prints a table of sample values from the upload and can make associate samples to internal names.
15758:
15759: $r is an Apache Request ref,
15760: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15761: $d is an array of 2 element arrays (internal name, displayed name)
15762:
15763: =cut
15764:
1.144 matthew 15765: ######################################################
15766: ######################################################
1.31 albertel 15767: sub csv_samples_select_table {
15768: my ($r,$records,$d) = @_;
15769: my $i=0;
1.144 matthew 15770: #
1.662 bisitz 15771: my $max_samples = 5;
15772: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15773: $r->print(&start_data_table().
15774: &start_data_table_header_row().'<th>'.
15775: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15776: &end_data_table_header_row());
1.301 albertel 15777:
15778: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15779: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15780: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15781: foreach my $option (@$d) {
15782: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15783: $r->print('<option value="'.$value.'"'.
1.253 albertel 15784: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15785: $display.'</option>');
1.31 albertel 15786: }
15787: $r->print('</select></td><td>');
1.662 bisitz 15788: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15789: if (defined($samples->[$line]{$key})) {
15790: $r->print($samples->[$line]{$key}."<br />\n");
15791: }
15792: }
1.594 raeburn 15793: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15794: $i++;
15795: }
1.594 raeburn 15796: $r->print(&end_data_table());
1.31 albertel 15797: $i--;
15798: return($i);
1.115 matthew 15799: }
15800:
1.144 matthew 15801: ######################################################
15802: ######################################################
15803:
1.115 matthew 15804: =pod
15805:
1.648 raeburn 15806: =item * &clean_excel_name($name)
1.115 matthew 15807:
15808: Returns a replacement for $name which does not contain any illegal characters.
15809:
15810: =cut
15811:
1.144 matthew 15812: ######################################################
15813: ######################################################
1.115 matthew 15814: sub clean_excel_name {
15815: my ($name) = @_;
15816: $name =~ s/[:\*\?\/\\]//g;
15817: if (length($name) > 31) {
15818: $name = substr($name,0,31);
15819: }
15820: return $name;
1.25 albertel 15821: }
1.84 albertel 15822:
1.85 albertel 15823: =pod
15824:
1.648 raeburn 15825: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15826:
15827: Returns either 1 or undef
15828:
15829: 1 if the part is to be hidden, undef if it is to be shown
15830:
15831: Arguments are:
15832:
15833: $id the id of the part to be checked
15834: $symb, optional the symb of the resource to check
15835: $udom, optional the domain of the user to check for
15836: $uname, optional the username of the user to check for
15837:
15838: =cut
1.84 albertel 15839:
15840: sub check_if_partid_hidden {
15841: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15842: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15843: $symb,$udom,$uname);
1.141 albertel 15844: my $truth=1;
15845: #if the string starts with !, then the list is the list to show not hide
15846: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15847: my @hiddenlist=split(/,/,$hiddenparts);
15848: foreach my $checkid (@hiddenlist) {
1.141 albertel 15849: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15850: }
1.141 albertel 15851: return !$truth;
1.84 albertel 15852: }
1.127 matthew 15853:
1.138 matthew 15854:
15855: ############################################################
15856: ############################################################
15857:
15858: =pod
15859:
1.157 matthew 15860: =back
15861:
1.138 matthew 15862: =head1 cgi-bin script and graphing routines
15863:
1.157 matthew 15864: =over 4
15865:
1.648 raeburn 15866: =item * &get_cgi_id()
1.138 matthew 15867:
15868: Inputs: none
15869:
15870: Returns an id which can be used to pass environment variables
15871: to various cgi-bin scripts. These environment variables will
15872: be removed from the users environment after a given time by
15873: the routine &Apache::lonnet::transfer_profile_to_env.
15874:
15875: =cut
15876:
15877: ############################################################
15878: ############################################################
1.152 albertel 15879: my $uniq=0;
1.136 matthew 15880: sub get_cgi_id {
1.154 albertel 15881: $uniq=($uniq+1)%100000;
1.280 albertel 15882: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15883: }
15884:
1.127 matthew 15885: ############################################################
15886: ############################################################
15887:
15888: =pod
15889:
1.648 raeburn 15890: =item * &DrawBarGraph()
1.127 matthew 15891:
1.138 matthew 15892: Facilitates the plotting of data in a (stacked) bar graph.
15893: Puts plot definition data into the users environment in order for
15894: graph.png to plot it. Returns an <img> tag for the plot.
15895: The bars on the plot are labeled '1','2',...,'n'.
15896:
15897: Inputs:
15898:
15899: =over 4
15900:
15901: =item $Title: string, the title of the plot
15902:
15903: =item $xlabel: string, text describing the X-axis of the plot
15904:
15905: =item $ylabel: string, text describing the Y-axis of the plot
15906:
15907: =item $Max: scalar, the maximum Y value to use in the plot
15908: If $Max is < any data point, the graph will not be rendered.
15909:
1.140 matthew 15910: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15911: they are plotted. If undefined, default values will be used.
15912:
1.178 matthew 15913: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15914:
1.138 matthew 15915: =item @Values: An array of array references. Each array reference holds data
15916: to be plotted in a stacked bar chart.
15917:
1.239 matthew 15918: =item If the final element of @Values is a hash reference the key/value
15919: pairs will be added to the graph definition.
15920:
1.138 matthew 15921: =back
15922:
15923: Returns:
15924:
15925: An <img> tag which references graph.png and the appropriate identifying
15926: information for the plot.
15927:
1.127 matthew 15928: =cut
15929:
15930: ############################################################
15931: ############################################################
1.134 matthew 15932: sub DrawBarGraph {
1.178 matthew 15933: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15934: #
15935: if (! defined($colors)) {
15936: $colors = ['#33ff00',
15937: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15938: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15939: ];
15940: }
1.228 matthew 15941: my $extra_settings = {};
15942: if (ref($Values[-1]) eq 'HASH') {
15943: $extra_settings = pop(@Values);
15944: }
1.127 matthew 15945: #
1.136 matthew 15946: my $identifier = &get_cgi_id();
15947: my $id = 'cgi.'.$identifier;
1.129 matthew 15948: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15949: return '';
15950: }
1.225 matthew 15951: #
15952: my @Labels;
15953: if (defined($labels)) {
15954: @Labels = @$labels;
15955: } else {
15956: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15957: push(@Labels,$i+1);
1.225 matthew 15958: }
15959: }
15960: #
1.129 matthew 15961: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15962: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15963: my %ValuesHash;
15964: my $NumSets=1;
15965: foreach my $array (@Values) {
15966: next if (! ref($array));
1.136 matthew 15967: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15968: join(',',@$array);
1.129 matthew 15969: }
1.127 matthew 15970: #
1.136 matthew 15971: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15972: if ($NumBars < 3) {
15973: $width = 120+$NumBars*32;
1.220 matthew 15974: $xskip = 1;
1.225 matthew 15975: $bar_width = 30;
15976: } elsif ($NumBars < 5) {
15977: $width = 120+$NumBars*20;
15978: $xskip = 1;
15979: $bar_width = 20;
1.220 matthew 15980: } elsif ($NumBars < 10) {
1.136 matthew 15981: $width = 120+$NumBars*15;
15982: $xskip = 1;
15983: $bar_width = 15;
15984: } elsif ($NumBars <= 25) {
15985: $width = 120+$NumBars*11;
15986: $xskip = 5;
15987: $bar_width = 8;
15988: } elsif ($NumBars <= 50) {
15989: $width = 120+$NumBars*8;
15990: $xskip = 5;
15991: $bar_width = 4;
15992: } else {
15993: $width = 120+$NumBars*8;
15994: $xskip = 5;
15995: $bar_width = 4;
15996: }
15997: #
1.137 matthew 15998: $Max = 1 if ($Max < 1);
15999: if ( int($Max) < $Max ) {
16000: $Max++;
16001: $Max = int($Max);
16002: }
1.127 matthew 16003: $Title = '' if (! defined($Title));
16004: $xlabel = '' if (! defined($xlabel));
16005: $ylabel = '' if (! defined($ylabel));
1.369 www 16006: $ValuesHash{$id.'.title'} = &escape($Title);
16007: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
16008: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 16009: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 16010: $ValuesHash{$id.'.NumBars'} = $NumBars;
16011: $ValuesHash{$id.'.NumSets'} = $NumSets;
16012: $ValuesHash{$id.'.PlotType'} = 'bar';
16013: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16014: $ValuesHash{$id.'.height'} = $height;
16015: $ValuesHash{$id.'.width'} = $width;
16016: $ValuesHash{$id.'.xskip'} = $xskip;
16017: $ValuesHash{$id.'.bar_width'} = $bar_width;
16018: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 16019: #
1.228 matthew 16020: # Deal with other parameters
16021: while (my ($key,$value) = each(%$extra_settings)) {
16022: $ValuesHash{$id.'.'.$key} = $value;
16023: }
16024: #
1.646 raeburn 16025: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 16026: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
16027: }
16028:
16029: ############################################################
16030: ############################################################
16031:
16032: =pod
16033:
1.648 raeburn 16034: =item * &DrawXYGraph()
1.137 matthew 16035:
1.138 matthew 16036: Facilitates the plotting of data in an XY graph.
16037: Puts plot definition data into the users environment in order for
16038: graph.png to plot it. Returns an <img> tag for the plot.
16039:
16040: Inputs:
16041:
16042: =over 4
16043:
16044: =item $Title: string, the title of the plot
16045:
16046: =item $xlabel: string, text describing the X-axis of the plot
16047:
16048: =item $ylabel: string, text describing the Y-axis of the plot
16049:
16050: =item $Max: scalar, the maximum Y value to use in the plot
16051: If $Max is < any data point, the graph will not be rendered.
16052:
16053: =item $colors: Array ref containing the hex color codes for the data to be
16054: plotted in. If undefined, default values will be used.
16055:
16056: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
16057:
16058: =item $Ydata: Array ref containing Array refs.
1.185 www 16059: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 16060:
16061: =item %Values: hash indicating or overriding any default values which are
16062: passed to graph.png.
16063: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16064:
16065: =back
16066:
16067: Returns:
16068:
16069: An <img> tag which references graph.png and the appropriate identifying
16070: information for the plot.
16071:
1.137 matthew 16072: =cut
16073:
16074: ############################################################
16075: ############################################################
16076: sub DrawXYGraph {
16077: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
16078: #
16079: # Create the identifier for the graph
16080: my $identifier = &get_cgi_id();
16081: my $id = 'cgi.'.$identifier;
16082: #
16083: $Title = '' if (! defined($Title));
16084: $xlabel = '' if (! defined($xlabel));
16085: $ylabel = '' if (! defined($ylabel));
16086: my %ValuesHash =
16087: (
1.369 www 16088: $id.'.title' => &escape($Title),
16089: $id.'.xlabel' => &escape($xlabel),
16090: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 16091: $id.'.y_max_value'=> $Max,
16092: $id.'.labels' => join(',',@$Xlabels),
16093: $id.'.PlotType' => 'XY',
16094: );
16095: #
16096: if (defined($colors) && ref($colors) eq 'ARRAY') {
16097: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16098: }
16099: #
16100: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
16101: return '';
16102: }
16103: my $NumSets=1;
1.138 matthew 16104: foreach my $array (@{$Ydata}){
1.137 matthew 16105: next if (! ref($array));
16106: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
16107: }
1.138 matthew 16108: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 16109: #
16110: # Deal with other parameters
16111: while (my ($key,$value) = each(%Values)) {
16112: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 16113: }
16114: #
1.646 raeburn 16115: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 16116: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
16117: }
16118:
16119: ############################################################
16120: ############################################################
16121:
16122: =pod
16123:
1.648 raeburn 16124: =item * &DrawXYYGraph()
1.138 matthew 16125:
16126: Facilitates the plotting of data in an XY graph with two Y axes.
16127: Puts plot definition data into the users environment in order for
16128: graph.png to plot it. Returns an <img> tag for the plot.
16129:
16130: Inputs:
16131:
16132: =over 4
16133:
16134: =item $Title: string, the title of the plot
16135:
16136: =item $xlabel: string, text describing the X-axis of the plot
16137:
16138: =item $ylabel: string, text describing the Y-axis of the plot
16139:
16140: =item $colors: Array ref containing the hex color codes for the data to be
16141: plotted in. If undefined, default values will be used.
16142:
16143: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
16144:
16145: =item $Ydata1: The first data set
16146:
16147: =item $Min1: The minimum value of the left Y-axis
16148:
16149: =item $Max1: The maximum value of the left Y-axis
16150:
16151: =item $Ydata2: The second data set
16152:
16153: =item $Min2: The minimum value of the right Y-axis
16154:
16155: =item $Max2: The maximum value of the left Y-axis
16156:
16157: =item %Values: hash indicating or overriding any default values which are
16158: passed to graph.png.
16159: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16160:
16161: =back
16162:
16163: Returns:
16164:
16165: An <img> tag which references graph.png and the appropriate identifying
16166: information for the plot.
1.136 matthew 16167:
16168: =cut
16169:
16170: ############################################################
16171: ############################################################
1.137 matthew 16172: sub DrawXYYGraph {
16173: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16174: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16175: #
16176: # Create the identifier for the graph
16177: my $identifier = &get_cgi_id();
16178: my $id = 'cgi.'.$identifier;
16179: #
16180: $Title = '' if (! defined($Title));
16181: $xlabel = '' if (! defined($xlabel));
16182: $ylabel = '' if (! defined($ylabel));
16183: my %ValuesHash =
16184: (
1.369 www 16185: $id.'.title' => &escape($Title),
16186: $id.'.xlabel' => &escape($xlabel),
16187: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16188: $id.'.labels' => join(',',@$Xlabels),
16189: $id.'.PlotType' => 'XY',
16190: $id.'.NumSets' => 2,
1.137 matthew 16191: $id.'.two_axes' => 1,
16192: $id.'.y1_max_value' => $Max1,
16193: $id.'.y1_min_value' => $Min1,
16194: $id.'.y2_max_value' => $Max2,
16195: $id.'.y2_min_value' => $Min2,
1.136 matthew 16196: );
16197: #
1.137 matthew 16198: if (defined($colors) && ref($colors) eq 'ARRAY') {
16199: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16200: }
16201: #
16202: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16203: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16204: return '';
16205: }
16206: my $NumSets=1;
1.137 matthew 16207: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16208: next if (! ref($array));
16209: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16210: }
16211: #
16212: # Deal with other parameters
16213: while (my ($key,$value) = each(%Values)) {
16214: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16215: }
16216: #
1.646 raeburn 16217: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16218: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16219: }
16220:
16221: ############################################################
16222: ############################################################
16223:
16224: =pod
16225:
1.157 matthew 16226: =back
16227:
1.139 matthew 16228: =head1 Statistics helper routines?
16229:
16230: Bad place for them but what the hell.
16231:
1.157 matthew 16232: =over 4
16233:
1.648 raeburn 16234: =item * &chartlink()
1.139 matthew 16235:
16236: Returns a link to the chart for a specific student.
16237:
16238: Inputs:
16239:
16240: =over 4
16241:
16242: =item $linktext: The text of the link
16243:
16244: =item $sname: The students username
16245:
16246: =item $sdomain: The students domain
16247:
16248: =back
16249:
1.157 matthew 16250: =back
16251:
1.139 matthew 16252: =cut
16253:
16254: ############################################################
16255: ############################################################
16256: sub chartlink {
16257: my ($linktext, $sname, $sdomain) = @_;
16258: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16259: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16260: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16261: '">'.$linktext.'</a>';
1.153 matthew 16262: }
16263:
16264: #######################################################
16265: #######################################################
16266:
16267: =pod
16268:
16269: =head1 Course Environment Routines
1.157 matthew 16270:
16271: =over 4
1.153 matthew 16272:
1.648 raeburn 16273: =item * &restore_course_settings()
1.153 matthew 16274:
1.648 raeburn 16275: =item * &store_course_settings()
1.153 matthew 16276:
16277: Restores/Store indicated form parameters from the course environment.
16278: Will not overwrite existing values of the form parameters.
16279:
16280: Inputs:
16281: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16282:
16283: a hash ref describing the data to be stored. For example:
16284:
16285: %Save_Parameters = ('Status' => 'scalar',
16286: 'chartoutputmode' => 'scalar',
16287: 'chartoutputdata' => 'scalar',
16288: 'Section' => 'array',
1.373 raeburn 16289: 'Group' => 'array',
1.153 matthew 16290: 'StudentData' => 'array',
16291: 'Maps' => 'array');
16292:
16293: Returns: both routines return nothing
16294:
1.631 raeburn 16295: =back
16296:
1.153 matthew 16297: =cut
16298:
16299: #######################################################
16300: #######################################################
16301: sub store_course_settings {
1.496 albertel 16302: return &store_settings($env{'request.course.id'},@_);
16303: }
16304:
16305: sub store_settings {
1.153 matthew 16306: # save to the environment
16307: # appenv the same items, just to be safe
1.300 albertel 16308: my $udom = $env{'user.domain'};
16309: my $uname = $env{'user.name'};
1.496 albertel 16310: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16311: my %SaveHash;
16312: my %AppHash;
16313: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16314: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16315: my $envname = 'environment.'.$basename;
1.258 albertel 16316: if (exists($env{'form.'.$setting})) {
1.153 matthew 16317: # Save this value away
16318: if ($type eq 'scalar' &&
1.258 albertel 16319: (! exists($env{$envname}) ||
16320: $env{$envname} ne $env{'form.'.$setting})) {
16321: $SaveHash{$basename} = $env{'form.'.$setting};
16322: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16323: } elsif ($type eq 'array') {
16324: my $stored_form;
1.258 albertel 16325: if (ref($env{'form.'.$setting})) {
1.153 matthew 16326: $stored_form = join(',',
16327: map {
1.369 www 16328: &escape($_);
1.258 albertel 16329: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16330: } else {
16331: $stored_form =
1.369 www 16332: &escape($env{'form.'.$setting});
1.153 matthew 16333: }
16334: # Determine if the array contents are the same.
1.258 albertel 16335: if ($stored_form ne $env{$envname}) {
1.153 matthew 16336: $SaveHash{$basename} = $stored_form;
16337: $AppHash{$envname} = $stored_form;
16338: }
16339: }
16340: }
16341: }
16342: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16343: $udom,$uname);
1.153 matthew 16344: if ($put_result !~ /^(ok|delayed)/) {
16345: &Apache::lonnet::logthis('unable to save form parameters, '.
16346: 'got error:'.$put_result);
16347: }
16348: # Make sure these settings stick around in this session, too
1.646 raeburn 16349: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16350: return;
16351: }
16352:
16353: sub restore_course_settings {
1.499 albertel 16354: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16355: }
16356:
16357: sub restore_settings {
16358: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16359: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16360: next if (exists($env{'form.'.$setting}));
1.496 albertel 16361: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16362: '.'.$setting;
1.258 albertel 16363: if (exists($env{$envname})) {
1.153 matthew 16364: if ($type eq 'scalar') {
1.258 albertel 16365: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16366: } elsif ($type eq 'array') {
1.258 albertel 16367: $env{'form.'.$setting} = [
1.153 matthew 16368: map {
1.369 www 16369: &unescape($_);
1.258 albertel 16370: } split(',',$env{$envname})
1.153 matthew 16371: ];
16372: }
16373: }
16374: }
1.127 matthew 16375: }
16376:
1.618 raeburn 16377: #######################################################
16378: #######################################################
16379:
16380: =pod
16381:
16382: =head1 Domain E-mail Routines
16383:
16384: =over 4
16385:
1.648 raeburn 16386: =item * &build_recipient_list()
1.618 raeburn 16387:
1.1144 raeburn 16388: Build recipient lists for following types of e-mail:
1.766 raeburn 16389: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16390: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16391: module change checking, student/employee ID conflict checks, as
16392: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16393: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16394:
16395: Inputs:
1.619 raeburn 16396: defmail (scalar - email address of default recipient),
1.1144 raeburn 16397: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16398: requestsmail, updatesmail, or idconflictsmail).
16399:
1.619 raeburn 16400: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16401:
1.619 raeburn 16402: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16403: i.e., predates configuration by DC via domainprefs.pm
16404:
16405: $requname username of requester (if mailing type is helpdeskmail)
16406:
16407: $requdom domain of requester (if mailing type is helpdeskmail)
16408:
16409: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16410:
1.618 raeburn 16411:
1.655 raeburn 16412: Returns: comma separated list of addresses to which to send e-mail.
16413:
16414: =back
1.618 raeburn 16415:
16416: =cut
16417:
16418: ############################################################
16419: ############################################################
16420: sub build_recipient_list {
1.1297 raeburn 16421: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16422: my @recipients;
1.1270 raeburn 16423: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16424: my %domconfig =
1.1270 raeburn 16425: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16426: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16427: if (exists($domconfig{'contacts'}{$mailing})) {
16428: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16429: my @contacts = ('adminemail','supportemail');
16430: foreach my $item (@contacts) {
16431: if ($domconfig{'contacts'}{$mailing}{$item}) {
16432: my $addr = $domconfig{'contacts'}{$item};
16433: if (!grep(/^\Q$addr\E$/,@recipients)) {
16434: push(@recipients,$addr);
16435: }
1.619 raeburn 16436: }
1.1270 raeburn 16437: }
16438: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16439: if ($mailing eq 'helpdeskmail') {
16440: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16441: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16442: my @ok_bccs;
16443: foreach my $bcc (@bccs) {
16444: $bcc =~ s/^\s+//g;
16445: $bcc =~ s/\s+$//g;
16446: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16447: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16448: push(@ok_bccs,$bcc);
16449: }
16450: }
16451: }
16452: if (@ok_bccs > 0) {
16453: $allbcc = join(', ',@ok_bccs);
16454: }
16455: }
16456: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16457: }
16458: }
1.766 raeburn 16459: } elsif ($origmail ne '') {
1.1270 raeburn 16460: $lastresort = $origmail;
1.618 raeburn 16461: }
1.1297 raeburn 16462: if ($mailing eq 'helpdeskmail') {
16463: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16464: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16465: my ($inststatus,$inststatus_checked);
16466: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16467: ($env{'user.domain'} ne 'public')) {
16468: $inststatus_checked = 1;
16469: $inststatus = $env{'environment.inststatus'};
16470: }
16471: unless ($inststatus_checked) {
16472: if (($requname ne '') && ($requdom ne '')) {
16473: if (($requname =~ /^$match_username$/) &&
16474: ($requdom =~ /^$match_domain$/) &&
16475: (&Apache::lonnet::domain($requdom))) {
16476: my $requhome = &Apache::lonnet::homeserver($requname,
16477: $requdom);
16478: unless ($requhome eq 'no_host') {
16479: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16480: $inststatus = $userenv{'inststatus'};
16481: $inststatus_checked = 1;
16482: }
16483: }
16484: }
16485: }
16486: unless ($inststatus_checked) {
16487: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16488: my %srch = (srchby => 'email',
16489: srchdomain => $defdom,
16490: srchterm => $reqemail,
16491: srchtype => 'exact');
16492: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16493: foreach my $uname (keys(%srch_results)) {
16494: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16495: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16496: $inststatus_checked = 1;
16497: last;
16498: }
16499: }
16500: unless ($inststatus_checked) {
16501: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16502: if ($dirsrchres eq 'ok') {
16503: foreach my $uname (keys(%srch_results)) {
16504: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16505: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16506: $inststatus_checked = 1;
16507: last;
16508: }
16509: }
16510: }
16511: }
16512: }
16513: }
16514: if ($inststatus ne '') {
16515: foreach my $status (split(/\:/,$inststatus)) {
16516: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16517: my @contacts = ('adminemail','supportemail');
16518: foreach my $item (@contacts) {
16519: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16520: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16521: if (!grep(/^\Q$addr\E$/,@recipients)) {
16522: push(@recipients,$addr);
16523: }
16524: }
16525: }
16526: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16527: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16528: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16529: my @ok_bccs;
16530: foreach my $bcc (@bccs) {
16531: $bcc =~ s/^\s+//g;
16532: $bcc =~ s/\s+$//g;
16533: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16534: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16535: push(@ok_bccs,$bcc);
16536: }
16537: }
16538: }
16539: if (@ok_bccs > 0) {
16540: $allbcc = join(', ',@ok_bccs);
16541: }
16542: }
16543: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16544: last;
16545: }
16546: }
16547: }
16548: }
16549: }
1.619 raeburn 16550: } elsif ($origmail ne '') {
1.1270 raeburn 16551: $lastresort = $origmail;
16552: }
1.1297 raeburn 16553: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16554: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16555: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16556: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16557: my %what = (
16558: perlvar => 1,
16559: );
16560: my $primary = &Apache::lonnet::domain($defdom,'primary');
16561: if ($primary) {
16562: my $gotaddr;
16563: my ($result,$returnhash) =
16564: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16565: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16566: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16567: $lastresort = $returnhash->{'lonSupportEMail'};
16568: $gotaddr = 1;
16569: }
16570: }
16571: unless ($gotaddr) {
16572: my $uintdom = &Apache::lonnet::internet_dom($primary);
16573: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16574: unless ($uintdom eq $intdom) {
16575: my %domconfig =
16576: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16577: if (ref($domconfig{'contacts'}) eq 'HASH') {
16578: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16579: my @contacts = ('adminemail','supportemail');
16580: foreach my $item (@contacts) {
16581: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16582: my $addr = $domconfig{'contacts'}{$item};
16583: if (!grep(/^\Q$addr\E$/,@recipients)) {
16584: push(@recipients,$addr);
16585: }
16586: }
16587: }
16588: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16589: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16590: }
16591: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16592: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16593: my @ok_bccs;
16594: foreach my $bcc (@bccs) {
16595: $bcc =~ s/^\s+//g;
16596: $bcc =~ s/\s+$//g;
16597: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16598: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16599: push(@ok_bccs,$bcc);
16600: }
16601: }
16602: }
16603: if (@ok_bccs > 0) {
16604: $allbcc = join(', ',@ok_bccs);
16605: }
16606: }
16607: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16608: }
16609: }
16610: }
16611: }
16612: }
16613: }
1.618 raeburn 16614: }
1.688 raeburn 16615: if (defined($defmail)) {
16616: if ($defmail ne '') {
16617: push(@recipients,$defmail);
16618: }
1.618 raeburn 16619: }
16620: if ($otheremails) {
1.619 raeburn 16621: my @others;
16622: if ($otheremails =~ /,/) {
16623: @others = split(/,/,$otheremails);
1.618 raeburn 16624: } else {
1.619 raeburn 16625: push(@others,$otheremails);
16626: }
16627: foreach my $addr (@others) {
16628: if (!grep(/^\Q$addr\E$/,@recipients)) {
16629: push(@recipients,$addr);
16630: }
1.618 raeburn 16631: }
16632: }
1.1298 raeburn 16633: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16634: if ((!@recipients) && ($lastresort ne '')) {
16635: push(@recipients,$lastresort);
16636: }
16637: } elsif ($lastresort ne '') {
16638: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16639: push(@recipients,$lastresort);
16640: }
16641: }
1.1271 raeburn 16642: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16643: if (wantarray) {
16644: return ($recipientlist,$allbcc,$addtext);
16645: } else {
16646: return $recipientlist;
16647: }
1.618 raeburn 16648: }
16649:
1.127 matthew 16650: ############################################################
16651: ############################################################
1.154 albertel 16652:
1.655 raeburn 16653: =pod
16654:
1.1224 musolffc 16655: =over 4
16656:
1.1223 musolffc 16657: =item * &mime_email()
16658:
16659: Sends an email with a possible attachment
16660:
16661: Inputs:
16662:
16663: =over 4
16664:
16665: from - Sender's email address
16666:
1.1343 raeburn 16667: replyto - Reply-To email address
16668:
1.1223 musolffc 16669: to - Email address of recipient
16670:
16671: subject - Subject of email
16672:
16673: body - Body of email
16674:
16675: cc_string - Carbon copy email address
16676:
16677: bcc - Blind carbon copy email address
16678:
16679: attachment_path - Path of file to be attached
16680:
16681: file_name - Name of file to be attached
16682:
16683: attachment_text - The body of an attachment of type "TEXT"
16684:
16685: =back
16686:
16687: =back
16688:
16689: =cut
16690:
16691: ############################################################
16692: ############################################################
16693:
16694: sub mime_email {
1.1343 raeburn 16695: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16696: $file_name,$attachment_text) = @_;
16697:
1.1223 musolffc 16698: my $msg = MIME::Lite->new(
16699: From => $from,
16700: To => $to,
16701: Subject => $subject,
16702: Type =>'TEXT',
16703: Data => $body,
16704: );
1.1343 raeburn 16705: if ($replyto ne '') {
16706: $msg->add("Reply-To" => $replyto);
16707: }
1.1223 musolffc 16708: if ($cc_string ne '') {
16709: $msg->add("Cc" => $cc_string);
16710: }
16711: if ($bcc ne '') {
16712: $msg->add("Bcc" => $bcc);
16713: }
16714: $msg->attr("content-type" => "text/plain");
16715: $msg->attr("content-type.charset" => "UTF-8");
16716: # Attach file if given
16717: if ($attachment_path) {
16718: unless ($file_name) {
16719: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16720: }
16721: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16722: $msg->attach(Type => $type,
16723: Path => $attachment_path,
16724: Filename => $file_name
16725: );
16726: # Otherwise attach text if given
16727: } elsif ($attachment_text) {
16728: $msg->attach(Type => 'TEXT',
16729: Data => $attachment_text);
16730: }
16731: # Send it
16732: $msg->send('sendmail');
16733: }
16734:
16735: ############################################################
16736: ############################################################
16737:
16738: =pod
16739:
1.655 raeburn 16740: =head1 Course Catalog Routines
16741:
16742: =over 4
16743:
16744: =item * &gather_categories()
16745:
16746: Converts category definitions - keys of categories hash stored in
16747: coursecategories in configuration.db on the primary library server in a
16748: domain - to an array. Also generates javascript and idx hash used to
16749: generate Domain Coordinator interface for editing Course Categories.
16750:
16751: Inputs:
1.663 raeburn 16752:
1.655 raeburn 16753: categories (reference to hash of category definitions).
1.663 raeburn 16754:
1.655 raeburn 16755: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16756: categories and subcategories).
1.663 raeburn 16757:
1.655 raeburn 16758: idx (reference to hash of counters used in Domain Coordinator interface for
16759: editing Course Categories).
1.663 raeburn 16760:
1.655 raeburn 16761: jsarray (reference to array of categories used to create Javascript arrays for
16762: Domain Coordinator interface for editing Course Categories).
16763:
16764: Returns: nothing
16765:
16766: Side effects: populates cats, idx and jsarray.
16767:
16768: =cut
16769:
16770: sub gather_categories {
16771: my ($categories,$cats,$idx,$jsarray) = @_;
16772: my %counters;
16773: my $num = 0;
16774: foreach my $item (keys(%{$categories})) {
16775: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16776: if ($container eq '' && $depth == 0) {
16777: $cats->[$depth][$categories->{$item}] = $cat;
16778: } else {
16779: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16780: }
16781: my ($escitem,$tail) = split(/:/,$item,2);
16782: if ($counters{$tail} eq '') {
16783: $counters{$tail} = $num;
16784: $num ++;
16785: }
16786: if (ref($idx) eq 'HASH') {
16787: $idx->{$item} = $counters{$tail};
16788: }
16789: if (ref($jsarray) eq 'ARRAY') {
16790: push(@{$jsarray->[$counters{$tail}]},$item);
16791: }
16792: }
16793: return;
16794: }
16795:
16796: =pod
16797:
16798: =item * &extract_categories()
16799:
16800: Used to generate breadcrumb trails for course categories.
16801:
16802: Inputs:
1.663 raeburn 16803:
1.655 raeburn 16804: categories (reference to hash of category definitions).
1.663 raeburn 16805:
1.655 raeburn 16806: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16807: categories and subcategories).
1.663 raeburn 16808:
1.655 raeburn 16809: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16810:
1.655 raeburn 16811: allitems (reference to hash - key is category key
16812: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16813:
1.655 raeburn 16814: idx (reference to hash of counters used in Domain Coordinator interface for
16815: editing Course Categories).
1.663 raeburn 16816:
1.655 raeburn 16817: jsarray (reference to array of categories used to create Javascript arrays for
16818: Domain Coordinator interface for editing Course Categories).
16819:
1.665 raeburn 16820: subcats (reference to hash of arrays containing all subcategories within each
16821: category, -recursive)
16822:
1.1321 raeburn 16823: maxd (reference to hash used to hold max depth for all top-level categories).
16824:
1.655 raeburn 16825: Returns: nothing
16826:
16827: Side effects: populates trails and allitems hash references.
16828:
16829: =cut
16830:
16831: sub extract_categories {
1.1321 raeburn 16832: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16833: if (ref($categories) eq 'HASH') {
16834: &gather_categories($categories,$cats,$idx,$jsarray);
16835: if (ref($cats->[0]) eq 'ARRAY') {
16836: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16837: my $name = $cats->[0][$i];
16838: my $item = &escape($name).'::0';
16839: my $trailstr;
16840: if ($name eq 'instcode') {
16841: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16842: } elsif ($name eq 'communities') {
16843: $trailstr = &mt('Communities');
1.1239 raeburn 16844: } elsif ($name eq 'placement') {
16845: $trailstr = &mt('Placement Tests');
1.655 raeburn 16846: } else {
16847: $trailstr = $name;
16848: }
16849: if ($allitems->{$item} eq '') {
16850: push(@{$trails},$trailstr);
16851: $allitems->{$item} = scalar(@{$trails})-1;
16852: }
16853: my @parents = ($name);
16854: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16855: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16856: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16857: if (ref($subcats) eq 'HASH') {
16858: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16859: }
1.1321 raeburn 16860: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16861: }
16862: } else {
16863: if (ref($subcats) eq 'HASH') {
16864: $subcats->{$item} = [];
1.655 raeburn 16865: }
1.1321 raeburn 16866: if (ref($maxd) eq 'HASH') {
16867: $maxd->{$name} = 1;
16868: }
1.655 raeburn 16869: }
16870: }
16871: }
16872: }
16873: return;
16874: }
16875:
16876: =pod
16877:
1.1162 raeburn 16878: =item * &recurse_categories()
1.655 raeburn 16879:
16880: Recursively used to generate breadcrumb trails for course categories.
16881:
16882: Inputs:
1.663 raeburn 16883:
1.655 raeburn 16884: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16885: categories and subcategories).
1.663 raeburn 16886:
1.655 raeburn 16887: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16888:
16889: category (current course category, for which breadcrumb trail is being generated).
16890:
16891: trails (reference to array of breadcrumb trails for each category).
16892:
1.655 raeburn 16893: allitems (reference to hash - key is category key
16894: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16895:
1.655 raeburn 16896: parents (array containing containers directories for current category,
16897: back to top level).
16898:
16899: Returns: nothing
16900:
16901: Side effects: populates trails and allitems hash references
16902:
16903: =cut
16904:
16905: sub recurse_categories {
1.1321 raeburn 16906: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16907: my $shallower = $depth - 1;
16908: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16909: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16910: my $name = $cats->[$depth]{$category}[$k];
16911: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16912: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16913: if ($allitems->{$item} eq '') {
16914: push(@{$trails},$trailstr);
16915: $allitems->{$item} = scalar(@{$trails})-1;
16916: }
16917: my $deeper = $depth+1;
16918: push(@{$parents},$category);
1.665 raeburn 16919: if (ref($subcats) eq 'HASH') {
16920: my $subcat = &escape($name).':'.$category.':'.$depth;
16921: for (my $j=@{$parents}; $j>=0; $j--) {
16922: my $higher;
16923: if ($j > 0) {
16924: $higher = &escape($parents->[$j]).':'.
16925: &escape($parents->[$j-1]).':'.$j;
16926: } else {
16927: $higher = &escape($parents->[$j]).'::'.$j;
16928: }
16929: push(@{$subcats->{$higher}},$subcat);
16930: }
16931: }
16932: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16933: $subcats,$maxd);
1.655 raeburn 16934: pop(@{$parents});
16935: }
16936: } else {
16937: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16938: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16939: if ($allitems->{$item} eq '') {
16940: push(@{$trails},$trailstr);
16941: $allitems->{$item} = scalar(@{$trails})-1;
16942: }
1.1321 raeburn 16943: if (ref($maxd) eq 'HASH') {
16944: if ($depth > $maxd->{$parents->[0]}) {
16945: $maxd->{$parents->[0]} = $depth;
16946: }
16947: }
1.655 raeburn 16948: }
16949: return;
16950: }
16951:
1.663 raeburn 16952: =pod
16953:
1.1162 raeburn 16954: =item * &assign_categories_table()
1.663 raeburn 16955:
16956: Create a datatable for display of hierarchical categories in a domain,
16957: with checkboxes to allow a course to be categorized.
16958:
16959: Inputs:
16960:
16961: cathash - reference to hash of categories defined for the domain (from
16962: configuration.db)
16963:
16964: currcat - scalar with an & separated list of categories assigned to a course.
16965:
1.919 raeburn 16966: type - scalar contains course type (Course or Community).
16967:
1.1260 raeburn 16968: disabled - scalar (optional) contains disabled="disabled" if input elements are
16969: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16970:
1.663 raeburn 16971: Returns: $output (markup to be displayed)
16972:
16973: =cut
16974:
16975: sub assign_categories_table {
1.1259 raeburn 16976: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16977: my $output;
16978: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16979: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16980: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16981: $maxdepth = scalar(@cats);
16982: if (@cats > 0) {
16983: my $itemcount = 0;
16984: if (ref($cats[0]) eq 'ARRAY') {
16985: my @currcategories;
16986: if ($currcat ne '') {
16987: @currcategories = split('&',$currcat);
16988: }
1.919 raeburn 16989: my $table;
1.663 raeburn 16990: for (my $i=0; $i<@{$cats[0]}; $i++) {
16991: my $parent = $cats[0][$i];
1.919 raeburn 16992: next if ($parent eq 'instcode');
16993: if ($type eq 'Community') {
16994: next unless ($parent eq 'communities');
1.1239 raeburn 16995: } elsif ($type eq 'Placement') {
16996: next unless ($parent eq 'placement');
1.919 raeburn 16997: } else {
1.1239 raeburn 16998: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16999: }
1.663 raeburn 17000: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
17001: my $item = &escape($parent).'::0';
17002: my $checked = '';
17003: if (@currcategories > 0) {
17004: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 17005: $checked = ' checked="checked"';
1.663 raeburn 17006: }
17007: }
1.919 raeburn 17008: my $parent_title = $parent;
17009: if ($parent eq 'communities') {
17010: $parent_title = &mt('Communities');
1.1239 raeburn 17011: } elsif ($parent eq 'placement') {
17012: $parent_title = &mt('Placement Tests');
1.919 raeburn 17013: }
17014: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
17015: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 17016: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 17017: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 17018: my $depth = 1;
17019: push(@path,$parent);
1.1259 raeburn 17020: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 17021: pop(@path);
1.919 raeburn 17022: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 17023: $itemcount ++;
17024: }
1.919 raeburn 17025: if ($itemcount) {
17026: $output = &Apache::loncommon::start_data_table().
17027: $table.
17028: &Apache::loncommon::end_data_table();
17029: }
1.663 raeburn 17030: }
17031: }
17032: }
17033: return $output;
17034: }
17035:
17036: =pod
17037:
1.1162 raeburn 17038: =item * &assign_category_rows()
1.663 raeburn 17039:
17040: Create a datatable row for display of nested categories in a domain,
17041: with checkboxes to allow a course to be categorized,called recursively.
17042:
17043: Inputs:
17044:
17045: itemcount - track row number for alternating colors
17046:
17047: cats - reference to array of arrays/hashes which encapsulates hierarchy of
17048: categories and subcategories.
17049:
17050: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
17051:
17052: parent - parent of current category item
17053:
17054: path - Array containing all categories back up through the hierarchy from the
17055: current category to the top level.
17056:
17057: currcategories - reference to array of current categories assigned to the course
17058:
1.1260 raeburn 17059: disabled - scalar (optional) contains disabled="disabled" if input elements are
17060: to be readonly (e.g., Domain Helpdesk role viewing course settings).
17061:
1.663 raeburn 17062: Returns: $output (markup to be displayed).
17063:
17064: =cut
17065:
17066: sub assign_category_rows {
1.1259 raeburn 17067: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 17068: my ($text,$name,$item,$chgstr);
17069: if (ref($cats) eq 'ARRAY') {
17070: my $maxdepth = scalar(@{$cats});
17071: if (ref($cats->[$depth]) eq 'HASH') {
17072: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
17073: my $numchildren = @{$cats->[$depth]{$parent}};
17074: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 17075: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 17076: for (my $j=0; $j<$numchildren; $j++) {
17077: $name = $cats->[$depth]{$parent}[$j];
17078: $item = &escape($name).':'.&escape($parent).':'.$depth;
17079: my $deeper = $depth+1;
17080: my $checked = '';
17081: if (ref($currcategories) eq 'ARRAY') {
17082: if (@{$currcategories} > 0) {
17083: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 17084: $checked = ' checked="checked"';
1.663 raeburn 17085: }
17086: }
17087: }
1.664 raeburn 17088: $text .= '<tr><td><span class="LC_nobreak"><label>'.
17089: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 17090: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 17091: '<input type="hidden" name="catname" value="'.$name.'" />'.
17092: '</td><td>';
1.663 raeburn 17093: if (ref($path) eq 'ARRAY') {
17094: push(@{$path},$name);
1.1259 raeburn 17095: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 17096: pop(@{$path});
17097: }
17098: $text .= '</td></tr>';
17099: }
17100: $text .= '</table></td>';
17101: }
17102: }
17103: }
17104: return $text;
17105: }
17106:
1.1181 raeburn 17107: =pod
17108:
17109: =back
17110:
17111: =cut
17112:
1.655 raeburn 17113: ############################################################
17114: ############################################################
17115:
17116:
1.443 albertel 17117: sub commit_customrole {
1.1408 raeburn 17118: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 17119: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 17120: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
17121: $context,$othdomby,$requester);
1.630 raeburn 17122: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 17123: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 17124: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
17125: if (wantarray) {
17126: return ($output,$result);
17127: } else {
17128: return $output;
17129: }
1.443 albertel 17130: }
17131:
17132: sub commit_standardrole {
1.1408 raeburn 17133: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
17134: $othdomby,$requester) = @_;
1.1399 raeburn 17135: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 17136: if ($context eq 'auto') {
17137: $linefeed = "\n";
17138: } else {
17139: $linefeed = "<br />\n";
17140: }
1.443 albertel 17141: if ($three eq 'st') {
1.1399 raeburn 17142: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 17143: $one,$two,$sec,$context,$credits,$othdomby,
17144: $requester);
1.541 raeburn 17145: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 17146: ($result eq 'unknown_course') || ($result eq 'refused')) {
17147: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 17148: } else {
1.541 raeburn 17149: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 17150: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17151: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
17152: if ($context eq 'auto') {
17153: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
17154: } else {
17155: $output .= '<b>'.$result.'</b>'.$linefeed.
17156: &mt('Add to classlist').': <b>ok</b>';
17157: }
17158: $output .= $linefeed;
1.443 albertel 17159: }
17160: } else {
17161: $output = &mt('Assigning').' '.$three.' in '.$url.
17162: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17163: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17164: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17165: '','',$context,$othdomby,$requester);
1.541 raeburn 17166: if ($context eq 'auto') {
17167: $output .= $result.$linefeed;
17168: } else {
17169: $output .= '<b>'.$result.'</b>'.$linefeed;
17170: }
1.443 albertel 17171: }
1.1399 raeburn 17172: if (wantarray) {
17173: return ($output,$result);
17174: } else {
17175: return $output;
17176: }
1.443 albertel 17177: }
17178:
17179: sub commit_studentrole {
1.1116 raeburn 17180: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17181: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17182: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17183: if ($context eq 'auto') {
17184: $linefeed = "\n";
17185: } else {
17186: $linefeed = '<br />'."\n";
17187: }
1.443 albertel 17188: if (defined($one) && defined($two)) {
17189: my $cid=$one.'_'.$two;
17190: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17191: my $secchange = 0;
17192: my $expire_role_result;
17193: my $modify_section_result;
1.628 raeburn 17194: if ($oldsec ne '-1') {
17195: if ($oldsec ne $sec) {
1.443 albertel 17196: $secchange = 1;
1.628 raeburn 17197: my $now = time;
1.443 albertel 17198: my $uurl='/'.$cid;
17199: $uurl=~s/\_/\//g;
17200: if ($oldsec) {
17201: $uurl.='/'.$oldsec;
17202: }
1.626 raeburn 17203: $oldsecurl = $uurl;
1.628 raeburn 17204: $expire_role_result =
1.1408 raeburn 17205: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17206: '','','',$context,$othdomby,$requester);
17207: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17208: if ($expire_role_result eq 'refused') {
17209: my @roles = ('st');
17210: my @statuses = ('previous');
17211: my @roledoms = ($one);
17212: my $withsec = 1;
17213: my %roleshash =
17214: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17215: \@statuses,\@roles,\@roledoms,$withsec);
17216: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17217: my ($oldstart,$oldend) =
17218: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17219: if ($oldend > 0 && $oldend <= $now) {
17220: $expire_role_result = 'ok';
17221: }
17222: }
17223: }
17224: }
1.443 albertel 17225: $result = $expire_role_result;
17226: }
17227: }
17228: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17229: $modify_section_result =
17230: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17231: undef,undef,undef,$sec,
17232: $end,$start,'','',$cid,
1.1408 raeburn 17233: '',$context,$credits,'',
17234: $othdomby,$requester);
1.443 albertel 17235: if ($modify_section_result =~ /^ok/) {
17236: if ($secchange == 1) {
1.628 raeburn 17237: if ($sec eq '') {
17238: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17239: } else {
17240: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17241: }
1.443 albertel 17242: } elsif ($oldsec eq '-1') {
1.628 raeburn 17243: if ($sec eq '') {
17244: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17245: } else {
17246: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17247: }
1.443 albertel 17248: } else {
1.628 raeburn 17249: if ($sec eq '') {
17250: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17251: } else {
17252: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17253: }
1.443 albertel 17254: }
17255: } else {
1.1115 raeburn 17256: if ($secchange) {
1.628 raeburn 17257: $$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;
17258: } else {
17259: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17260: }
1.443 albertel 17261: }
17262: $result = $modify_section_result;
17263: } elsif ($secchange == 1) {
1.628 raeburn 17264: if ($oldsec eq '') {
1.1103 raeburn 17265: $$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 17266: } else {
17267: $$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;
17268: }
1.626 raeburn 17269: if ($expire_role_result eq 'refused') {
17270: my $newsecurl = '/'.$cid;
17271: $newsecurl =~ s/\_/\//g;
17272: if ($sec ne '') {
17273: $newsecurl.='/'.$sec;
17274: }
17275: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17276: if ($sec eq '') {
17277: $$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;
17278: } else {
17279: $$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;
17280: }
17281: }
17282: }
1.443 albertel 17283: }
17284: } else {
1.626 raeburn 17285: $$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 17286: $result = "error: incomplete course id\n";
17287: }
17288: return $result;
17289: }
17290:
1.1108 raeburn 17291: sub show_role_extent {
17292: my ($scope,$context,$role) = @_;
17293: $scope =~ s{^/}{};
17294: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17295: push(@courseroles,'co');
17296: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17297: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17298: $scope =~ s{/}{_};
17299: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17300: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17301: my ($audom,$auname) = split(/\//,$scope);
17302: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17303: &Apache::loncommon::plainname($auname,$audom).'</span>');
17304: } else {
17305: $scope =~ s{/$}{};
17306: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17307: &Apache::lonnet::domain($scope,'description').'</span>');
17308: }
17309: }
17310:
1.443 albertel 17311: ############################################################
17312: ############################################################
17313:
1.566 albertel 17314: sub check_clone {
1.578 raeburn 17315: my ($args,$linefeed) = @_;
1.566 albertel 17316: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17317: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17318: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17319: my $clonetitle;
17320: my @clonemsg;
1.566 albertel 17321: my $can_clone = 0;
1.944 raeburn 17322: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17323: if ($lctype ne 'community') {
17324: $lctype = 'course';
17325: }
1.566 albertel 17326: if ($clonehome eq 'no_host') {
1.944 raeburn 17327: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17328: push(@clonemsg,({
17329: mt => 'No new community created.',
17330: args => [],
17331: },
17332: {
17333: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17334: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17335: }));
1.908 raeburn 17336: } else {
1.1344 raeburn 17337: push(@clonemsg,({
17338: mt => 'No new course created.',
17339: args => [],
17340: },
17341: {
17342: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17343: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17344: }));
17345: }
1.566 albertel 17346: } else {
17347: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17348: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17349: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17350: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17351: push(@clonemsg,({
17352: mt => 'No new community created.',
17353: args => [],
17354: },
17355: {
17356: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17357: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17358: }));
17359: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17360: }
17361: }
1.1262 raeburn 17362: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17363: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17364: $can_clone = 1;
17365: } else {
1.1221 raeburn 17366: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17367: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17368: if ($clonehash{'cloners'} eq '') {
17369: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17370: if ($domdefs{'canclone'}) {
17371: unless ($domdefs{'canclone'} eq 'none') {
17372: if ($domdefs{'canclone'} eq 'domain') {
17373: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17374: $can_clone = 1;
17375: }
17376: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17377: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17378: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17379: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17380: $can_clone = 1;
17381: }
17382: }
17383: }
17384: }
1.578 raeburn 17385: } else {
1.1221 raeburn 17386: my @cloners = split(/,/,$clonehash{'cloners'});
17387: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17388: $can_clone = 1;
1.1221 raeburn 17389: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17390: $can_clone = 1;
1.1225 raeburn 17391: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17392: $can_clone = 1;
1.1221 raeburn 17393: }
17394: unless ($can_clone) {
1.1225 raeburn 17395: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17396: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17397: my (%gotdomdefaults,%gotcodedefaults);
17398: foreach my $cloner (@cloners) {
17399: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17400: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17401: my (%codedefaults,@code_order);
17402: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17403: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17404: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17405: }
17406: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17407: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17408: }
17409: } else {
17410: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17411: \%codedefaults,
17412: \@code_order);
17413: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17414: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17415: }
17416: if (@code_order > 0) {
17417: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17418: $cloner,$clonehash{'internal.coursecode'},
17419: $args->{'crscode'})) {
17420: $can_clone = 1;
17421: last;
17422: }
17423: }
17424: }
17425: }
17426: }
1.1225 raeburn 17427: }
17428: }
17429: unless ($can_clone) {
17430: my $ccrole = 'cc';
17431: if ($args->{'crstype'} eq 'Community') {
17432: $ccrole = 'co';
17433: }
17434: my %roleshash =
17435: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17436: $args->{'ccdomain'},
17437: 'userroles',['active'],[$ccrole],
17438: [$args->{'clonedomain'}]);
17439: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17440: $can_clone = 1;
17441: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17442: $args->{'ccuname'},$args->{'ccdomain'})) {
17443: $can_clone = 1;
1.1221 raeburn 17444: }
17445: }
17446: unless ($can_clone) {
17447: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17448: push(@clonemsg,({
17449: mt => 'No new community created.',
17450: args => [],
17451: },
17452: {
17453: 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]).',
17454: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17455: }));
1.942 raeburn 17456: } else {
1.1344 raeburn 17457: push(@clonemsg,({
17458: mt => 'No new course created.',
17459: args => [],
17460: },
17461: {
17462: 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]).',
17463: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17464: }));
1.1221 raeburn 17465: }
1.566 albertel 17466: }
1.578 raeburn 17467: }
1.566 albertel 17468: }
1.1344 raeburn 17469: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17470: }
17471:
1.444 albertel 17472: sub construct_course {
1.1262 raeburn 17473: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17474: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17475: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17476: my $linefeed = '<br />'."\n";
17477: if ($context eq 'auto') {
17478: $linefeed = "\n";
17479: }
1.566 albertel 17480:
17481: #
17482: # Are we cloning?
17483: #
1.1344 raeburn 17484: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17485: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17486: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17487: if (!$can_clone) {
1.1344 raeburn 17488: return (0,$outcome,$clonemsgref);
1.566 albertel 17489: }
17490: }
17491:
1.444 albertel 17492: #
17493: # Open course
17494: #
1.1239 raeburn 17495: my $showncrstype;
17496: if ($args->{'crstype'} eq 'Placement') {
17497: $showncrstype = 'placement test';
17498: } else {
17499: $showncrstype = lc($args->{'crstype'});
17500: }
1.444 albertel 17501: my %cenv=();
17502: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17503: $args->{'cdescr'},
17504: $args->{'curl'},
17505: $args->{'course_home'},
17506: $args->{'nonstandard'},
17507: $args->{'crscode'},
17508: $args->{'ccuname'}.':'.
17509: $args->{'ccdomain'},
1.882 raeburn 17510: $args->{'crstype'},
1.1344 raeburn 17511: $cnum,$context,$category,
17512: $callercontext);
1.444 albertel 17513:
17514: # Note: The testing routines depend on this being output; see
17515: # Utils::Course. This needs to at least be output as a comment
17516: # if anyone ever decides to not show this, and Utils::Course::new
17517: # will need to be suitably modified.
1.1344 raeburn 17518: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17519: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17520: } else {
17521: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17522: }
1.943 raeburn 17523: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17524: return (0,$outcome,$clonemsgref);
1.943 raeburn 17525: }
17526:
1.444 albertel 17527: #
17528: # Check if created correctly
17529: #
1.479 albertel 17530: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17531: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17532: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17533: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17534: $outcome .= &mt_user($user_lh,
17535: 'Course creation failed, unrecognized course home server.');
17536: } else {
17537: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17538: }
17539: $outcome .= $linefeed;
17540: return (0,$outcome,$clonemsgref);
1.943 raeburn 17541: }
1.541 raeburn 17542: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17543:
1.444 albertel 17544: #
1.566 albertel 17545: # Do the cloning
17546: #
1.1344 raeburn 17547: my @clonemsg;
1.566 albertel 17548: if ($can_clone && $cloneid) {
1.1344 raeburn 17549: push(@clonemsg,
17550: {
17551: mt => 'Created [_1] by cloning from [_2]',
17552: args => [$showncrstype,$clonetitle],
17553: });
1.566 albertel 17554: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17555: # Copy all files
1.1344 raeburn 17556: my @info =
17557: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17558: $args->{'dateshift'},$args->{'crscode'},
17559: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17560: $args->{'tinyurls'});
17561: if (@info) {
17562: push(@clonemsg,@info);
17563: }
1.444 albertel 17564: # Restore URL
1.566 albertel 17565: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17566: # Restore title
1.566 albertel 17567: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17568: # Restore creation date, creator and creation context.
17569: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17570: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17571: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17572: # Mark as cloned
1.566 albertel 17573: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17574: # Need to clone grading mode
17575: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17576: $cenv{'grading'}=$newenv{'grading'};
17577: # Do not clone these environment entries
17578: &Apache::lonnet::del('environment',
17579: ['default_enrollment_start_date',
17580: 'default_enrollment_end_date',
17581: 'question.email',
17582: 'policy.email',
17583: 'comment.email',
17584: 'pch.users.denied',
1.725 raeburn 17585: 'plc.users.denied',
17586: 'hidefromcat',
1.1121 raeburn 17587: 'checkforpriv',
1.1355 raeburn 17588: 'categories'],
1.638 www 17589: $$crsudom,$$crsunum);
1.1170 raeburn 17590: if ($args->{'textbook'}) {
17591: $cenv{'internal.textbook'} = $args->{'textbook'};
17592: }
1.444 albertel 17593: }
1.566 albertel 17594:
1.444 albertel 17595: #
17596: # Set environment (will override cloned, if existing)
17597: #
17598: my @sections = ();
17599: my @xlists = ();
17600: if ($args->{'crstype'}) {
17601: $cenv{'type'}=$args->{'crstype'};
17602: }
1.1371 raeburn 17603: if ($args->{'lti'}) {
17604: $cenv{'internal.lti'}=$args->{'lti'};
17605: }
1.444 albertel 17606: if ($args->{'crsid'}) {
17607: $cenv{'courseid'}=$args->{'crsid'};
17608: }
17609: if ($args->{'crscode'}) {
17610: $cenv{'internal.coursecode'}=$args->{'crscode'};
17611: }
17612: if ($args->{'crsquota'} ne '') {
17613: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17614: } else {
17615: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17616: }
17617: if ($args->{'ccuname'}) {
17618: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17619: ':'.$args->{'ccdomain'};
17620: } else {
17621: $cenv{'internal.courseowner'} = $args->{'curruser'};
17622: }
1.1116 raeburn 17623: if ($args->{'defaultcredits'}) {
17624: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17625: }
1.444 albertel 17626: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17627: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17628: if ($args->{'crssections'}) {
17629: $cenv{'internal.sectionnums'} = '';
17630: if ($args->{'crssections'} =~ m/,/) {
17631: @sections = split/,/,$args->{'crssections'};
17632: } else {
17633: $sections[0] = $args->{'crssections'};
17634: }
17635: if (@sections > 0) {
17636: foreach my $item (@sections) {
17637: my ($sec,$gp) = split/:/,$item;
17638: my $class = $args->{'crscode'}.$sec;
17639: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17640: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17641: if ($addcheck eq 'ok') {
17642: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17643: push(@oklcsecs,$gp);
17644: }
17645: } else {
1.1263 raeburn 17646: push(@badclasses,$class);
1.444 albertel 17647: }
17648: }
17649: $cenv{'internal.sectionnums'} =~ s/,$//;
17650: }
17651: }
17652: # do not hide course coordinator from staff listing,
17653: # even if privileged
17654: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17655: # add course coordinator's domain to domains to check for privileged users
17656: # if different to course domain
17657: if ($$crsudom ne $args->{'ccdomain'}) {
17658: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17659: }
1.444 albertel 17660: # add crosslistings
17661: if ($args->{'crsxlist'}) {
17662: $cenv{'internal.crosslistings'}='';
17663: if ($args->{'crsxlist'} =~ m/,/) {
17664: @xlists = split/,/,$args->{'crsxlist'};
17665: } else {
17666: $xlists[0] = $args->{'crsxlist'};
17667: }
17668: if (@xlists > 0) {
17669: foreach my $item (@xlists) {
17670: my ($xl,$gp) = split/:/,$item;
17671: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17672: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17673: if ($addcheck eq 'ok') {
17674: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17675: push(@oklcsecs,$gp);
17676: }
17677: } else {
1.1263 raeburn 17678: push(@badclasses,$xl);
1.444 albertel 17679: }
17680: }
17681: $cenv{'internal.crosslistings'} =~ s/,$//;
17682: }
17683: }
17684: if ($args->{'autoadds'}) {
17685: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17686: }
17687: if ($args->{'autodrops'}) {
17688: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17689: }
17690: # check for notification of enrollment changes
17691: my @notified = ();
17692: if ($args->{'notify_owner'}) {
17693: if ($args->{'ccuname'} ne '') {
17694: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17695: }
17696: }
17697: if ($args->{'notify_dc'}) {
17698: if ($uname ne '') {
1.630 raeburn 17699: push(@notified,$uname.':'.$udom);
1.444 albertel 17700: }
17701: }
17702: if (@notified > 0) {
17703: my $notifylist;
17704: if (@notified > 1) {
17705: $notifylist = join(',',@notified);
17706: } else {
17707: $notifylist = $notified[0];
17708: }
17709: $cenv{'internal.notifylist'} = $notifylist;
17710: }
17711: if (@badclasses > 0) {
17712: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17713: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17714: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17715: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17716: );
1.1264 raeburn 17717: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17718: &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 17719: if ($context eq 'auto') {
17720: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17721: } else {
1.566 albertel 17722: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17723: }
17724: foreach my $item (@badclasses) {
1.541 raeburn 17725: if ($context eq 'auto') {
1.1261 raeburn 17726: $outcome .= " - $item\n";
1.541 raeburn 17727: } else {
1.1261 raeburn 17728: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17729: }
1.1261 raeburn 17730: }
17731: if ($context eq 'auto') {
17732: $outcome .= $linefeed;
17733: } else {
17734: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17735: }
1.444 albertel 17736: }
17737: if ($args->{'no_end_date'}) {
17738: $args->{'endaccess'} = 0;
17739: }
1.1412 raeburn 17740: # If an official course with institutional sections is created by cloning
17741: # an existing course, section-specific hiding of course totals in student's
17742: # view of grades as copied from cloned course, will be checked for valid
17743: # sections.
17744: if (($can_clone && $cloneid) &&
17745: ($cenv{'internal.coursecode'} ne '') &&
17746: ($cenv{'grading'} eq 'standard') &&
17747: ($cenv{'hidetotals'} ne '') &&
17748: ($cenv{'hidetotals'} ne 'all')) {
17749: my @hidesecs;
17750: my $deletehidetotals;
17751: if (@oklcsecs) {
17752: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17753: if (grep(/^\Q$sec$/,@oklcsecs)) {
17754: push(@hidesecs,$sec);
17755: }
17756: }
17757: if (@hidesecs) {
17758: $cenv{'hidetotals'} = join(',',@hidesecs);
17759: } else {
17760: $deletehidetotals = 1;
17761: }
17762: } else {
17763: $deletehidetotals = 1;
17764: }
17765: if ($deletehidetotals) {
17766: delete($cenv{'hidetotals'});
17767: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17768: }
17769: }
1.444 albertel 17770: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17771: $cenv{'internal.autoend'}=$args->{'enrollend'};
17772: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17773: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17774: if ($args->{'showphotos'}) {
17775: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17776: }
17777: $cenv{'internal.authtype'} = $args->{'authtype'};
17778: $cenv{'internal.autharg'} = $args->{'autharg'};
17779: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17780: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17781: 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');
17782: if ($context eq 'auto') {
17783: $outcome .= $krb_msg;
17784: } else {
1.566 albertel 17785: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17786: }
17787: $outcome .= $linefeed;
1.444 albertel 17788: }
17789: }
17790: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17791: if ($args->{'setpolicy'}) {
17792: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17793: }
17794: if ($args->{'setcontent'}) {
17795: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17796: }
1.1251 raeburn 17797: if ($args->{'setcomment'}) {
17798: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17799: }
1.444 albertel 17800: }
17801: if ($args->{'reshome'}) {
17802: $cenv{'reshome'}=$args->{'reshome'}.'/';
17803: $cenv{'reshome'}=~s/\/+$/\//;
17804: }
17805: #
17806: # course has keyed access
17807: #
17808: if ($args->{'setkeys'}) {
17809: $cenv{'keyaccess'}='yes';
17810: }
17811: # if specified, key authority is not course, but user
17812: # only active if keyaccess is yes
17813: if ($args->{'keyauth'}) {
1.487 albertel 17814: my ($user,$domain) = split(':',$args->{'keyauth'});
17815: $user = &LONCAPA::clean_username($user);
17816: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17817: if ($user ne '' && $domain ne '') {
1.487 albertel 17818: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17819: }
17820: }
17821:
1.1166 raeburn 17822: #
1.1167 raeburn 17823: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17824: #
17825: if ($args->{'uniquecode'}) {
17826: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17827: if ($code) {
17828: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17829: my %crsinfo =
17830: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17831: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17832: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17833: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17834: }
1.1166 raeburn 17835: if (ref($coderef)) {
17836: $$coderef = $code;
17837: }
17838: }
17839: }
17840:
1.444 albertel 17841: if ($args->{'disresdis'}) {
17842: $cenv{'pch.roles.denied'}='st';
17843: }
17844: if ($args->{'disablechat'}) {
17845: $cenv{'plc.roles.denied'}='st';
17846: }
17847:
17848: # Record we've not yet viewed the Course Initialization Helper for this
17849: # course
17850: $cenv{'course.helper.not.run'} = 1;
17851: #
17852: # Use new Randomseed
17853: #
17854: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17855: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17856: #
17857: # The encryption code and receipt prefix for this course
17858: #
17859: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17860: $cenv{'internal.encpref'}=100+int(9*rand(99));
17861: #
17862: # By default, use standard grading
17863: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17864:
1.541 raeburn 17865: $outcome .= $linefeed.&mt('Setting environment').': '.
17866: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17867: #
17868: # Open all assignments
17869: #
17870: if ($args->{'openall'}) {
1.1341 raeburn 17871: my $opendate = time;
17872: if ($args->{'openallfrom'} =~ /^\d+$/) {
17873: $opendate = $args->{'openallfrom'};
17874: }
1.444 albertel 17875: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17876: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17877: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17878: $outcome .= &mt('All assignments open starting [_1]',
17879: &Apache::lonlocal::locallocaltime($opendate)).': '.
17880: &Apache::lonnet::cput
17881: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17882: }
17883: #
17884: # Set first page
17885: #
17886: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17887: || ($cloneid)) {
17888: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17889:
17890: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17891: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17892:
1.444 albertel 17893: $outcome .= ($fatal?$errtext:'read ok').' - ';
17894: my $title; my $url;
17895: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17896: $title=&mt('Syllabus');
1.444 albertel 17897: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17898: } else {
1.963 raeburn 17899: $title=&mt('Table of Contents');
1.444 albertel 17900: $url='/adm/navmaps';
17901: }
1.445 albertel 17902:
17903: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17904: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17905:
17906: if ($errtext) { $fatal=2; }
1.541 raeburn 17907: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17908: }
1.566 albertel 17909:
1.1237 raeburn 17910: #
17911: # Set params for Placement Tests
17912: #
1.1239 raeburn 17913: if ($args->{'crstype'} eq 'Placement') {
17914: my %storecontent;
17915: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17916: my %defaults = (
17917: buttonshide => { value => 'yes',
17918: type => 'string_yesno',},
17919: type => { value => 'randomizetry',
17920: type => 'string_questiontype',},
17921: maxtries => { value => 1,
17922: type => 'int_pos',},
17923: problemstatus => { value => 'no',
17924: type => 'string_problemstatus',},
17925: );
17926: foreach my $key (keys(%defaults)) {
17927: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17928: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17929: }
1.1237 raeburn 17930: &Apache::lonnet::cput
17931: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17932: }
17933:
1.1344 raeburn 17934: return (1,$outcome,\@clonemsg);
1.444 albertel 17935: }
17936:
1.1166 raeburn 17937: sub make_unique_code {
17938: my ($cdom,$cnum) = @_;
17939: # get lock on uniquecodes db
17940: my $lockhash = {
17941: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17942: ':'.$env{'user.domain'},
17943: };
17944: my $tries = 0;
17945: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17946: my ($code,$error);
17947:
17948: while (($gotlock ne 'ok') && ($tries<3)) {
17949: $tries ++;
17950: sleep 1;
17951: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17952: }
17953: if ($gotlock eq 'ok') {
17954: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17955: my $gotcode;
17956: my $attempts = 0;
17957: while ((!$gotcode) && ($attempts < 100)) {
17958: $code = &generate_code();
17959: if (!exists($currcodes{$code})) {
17960: $gotcode = 1;
17961: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17962: $error = 'nostore';
17963: }
17964: }
17965: $attempts ++;
17966: }
17967: my @del_lock = ($cnum."\0".'uniquecodes');
17968: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17969: } else {
17970: $error = 'nolock';
17971: }
17972: return ($code,$error);
17973: }
17974:
17975: sub generate_code {
17976: my $code;
17977: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17978: for (my $i=0; $i<6; $i++) {
17979: my $lettnum = int (rand 2);
17980: my $item = '';
17981: if ($lettnum) {
17982: $item = $letts[int( rand(18) )];
17983: } else {
17984: $item = 1+int( rand(8) );
17985: }
17986: $code .= $item;
17987: }
17988: return $code;
17989: }
17990:
1.444 albertel 17991: ############################################################
17992: ############################################################
17993:
1.1237 raeburn 17994: # Community, Course and Placement Test
1.378 raeburn 17995: sub course_type {
17996: my ($cid) = @_;
17997: if (!defined($cid)) {
17998: $cid = $env{'request.course.id'};
17999: }
1.404 albertel 18000: if (defined($env{'course.'.$cid.'.type'})) {
18001: return $env{'course.'.$cid.'.type'};
1.378 raeburn 18002: } else {
18003: return 'Course';
1.377 raeburn 18004: }
18005: }
1.156 albertel 18006:
1.406 raeburn 18007: sub group_term {
18008: my $crstype = &course_type();
18009: my %names = (
18010: 'Course' => 'group',
1.865 raeburn 18011: 'Community' => 'group',
1.1237 raeburn 18012: 'Placement' => 'group',
1.406 raeburn 18013: );
18014: return $names{$crstype};
18015: }
18016:
1.902 raeburn 18017: sub course_types {
1.1310 raeburn 18018: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 18019: my %typename = (
18020: official => 'Official course',
18021: unofficial => 'Unofficial course',
18022: community => 'Community',
1.1165 raeburn 18023: textbook => 'Textbook course',
1.1237 raeburn 18024: placement => 'Placement test',
1.1310 raeburn 18025: lti => 'LTI provider',
1.902 raeburn 18026: );
18027: return (\@types,\%typename);
18028: }
18029:
1.156 albertel 18030: sub icon {
18031: my ($file)=@_;
1.505 albertel 18032: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 18033: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 18034: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 18035: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
18036: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
18037: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
18038: $curfext.".gif") {
18039: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
18040: $curfext.".gif";
18041: }
18042: }
1.249 albertel 18043: return &lonhttpdurl($iconname);
1.154 albertel 18044: }
1.84 albertel 18045:
1.575 albertel 18046: sub lonhttpdurl {
1.692 www 18047: #
18048: # Had been used for "small fry" static images on separate port 8080.
18049: # Modify here if lightweight http functionality desired again.
18050: # Currently eliminated due to increasing firewall issues.
18051: #
1.575 albertel 18052: my ($url)=@_;
1.692 www 18053: return $url;
1.215 albertel 18054: }
18055:
1.213 albertel 18056: sub connection_aborted {
18057: my ($r)=@_;
18058: $r->print(" ");$r->rflush();
18059: my $c = $r->connection;
18060: return $c->aborted();
18061: }
18062:
1.221 foxr 18063: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 18064: # strings as 'strings'.
18065: sub escape_single {
1.221 foxr 18066: my ($input) = @_;
1.223 albertel 18067: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 18068: $input =~ s/\'/\\\'/g; # Esacpe the 's....
18069: return $input;
18070: }
1.223 albertel 18071:
1.222 foxr 18072: # Same as escape_single, but escape's "'s This
18073: # can be used for "strings"
18074: sub escape_double {
18075: my ($input) = @_;
18076: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
18077: $input =~ s/\"/\\\"/g; # Esacpe the "s....
18078: return $input;
18079: }
1.223 albertel 18080:
1.222 foxr 18081: # Escapes the last element of a full URL.
18082: sub escape_url {
18083: my ($url) = @_;
1.238 raeburn 18084: my @urlslices = split(/\//, $url,-1);
1.369 www 18085: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 18086: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 18087: }
1.462 albertel 18088:
1.820 raeburn 18089: sub compare_arrays {
18090: my ($arrayref1,$arrayref2) = @_;
18091: my (@difference,%count);
18092: @difference = ();
18093: %count = ();
18094: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
18095: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
18096: foreach my $element (keys(%count)) {
18097: if ($count{$element} == 1) {
18098: push(@difference,$element);
18099: }
18100: }
18101: }
18102: return @difference;
18103: }
18104:
1.1322 raeburn 18105: sub lon_status_items {
18106: my %defaults = (
18107: E => 100,
18108: W => 4,
18109: N => 1,
1.1324 raeburn 18110: U => 5,
1.1322 raeburn 18111: threshold => 200,
18112: sysmail => 2500,
18113: );
18114: my %names = (
18115: E => 'Errors',
18116: W => 'Warnings',
18117: N => 'Notices',
1.1324 raeburn 18118: U => 'Unsent',
1.1322 raeburn 18119: );
18120: return (\%defaults,\%names);
18121: }
18122:
1.817 bisitz 18123: # -------------------------------------------------------- Initialize user login
1.462 albertel 18124: sub init_user_environment {
1.463 albertel 18125: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 18126: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
18127:
18128: my $public=($username eq 'public' && $domain eq 'public');
18129:
1.1415 raeburn 18130: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
18131: $coauthorenv);
1.462 albertel 18132: my $now=time;
18133:
18134: if ($public) {
18135: my $max_public=100;
18136: my $oldest;
18137: my $oldest_time=0;
18138: for(my $next=1;$next<=$max_public;$next++) {
18139: if (-e $lonids."/publicuser_$next.id") {
18140: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
18141: if ($mtime<$oldest_time || !$oldest_time) {
18142: $oldest_time=$mtime;
18143: $oldest=$next;
18144: }
18145: } else {
18146: $cookie="publicuser_$next";
18147: last;
18148: }
18149: }
18150: if (!$cookie) { $cookie="publicuser_$oldest"; }
18151: } else {
1.1275 raeburn 18152: # See if old ID present, if so, remove if this isn't a robot,
18153: # killing any existing non-robot sessions
1.463 albertel 18154: if (!$args->{'robot'}) {
18155: opendir(DIR,$lonids);
18156: while ($filename=readdir(DIR)) {
18157: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 18158: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
18159: &GDBM_READER(),0640)) {
1.1295 raeburn 18160: my $linkedfile;
1.1320 raeburn 18161: if (exists($oldenv{'user.linkedenv'})) {
18162: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18163: }
1.1320 raeburn 18164: untie(%oldenv);
18165: if (unlink("$lonids/$filename")) {
18166: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18167: if (-l "$lonids/$linkedfile.id") {
18168: unlink("$lonids/$linkedfile.id");
18169: }
1.1295 raeburn 18170: }
18171: }
18172: } else {
18173: unlink($lonids.'/'.$filename);
18174: }
1.463 albertel 18175: }
1.462 albertel 18176: }
1.463 albertel 18177: closedir(DIR);
1.1204 raeburn 18178: # If there is a undeleted lockfile for the user's paste buffer remove it.
18179: my $namespace = 'nohist_courseeditor';
18180: my $lockingkey = 'paste'."\0".'locked_num';
18181: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18182: $domain,$username);
18183: if (exists($lockhash{$lockingkey})) {
18184: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18185: unless ($delresult eq 'ok') {
18186: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18187: }
18188: }
1.462 albertel 18189: }
18190: # Give them a new cookie
1.463 albertel 18191: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18192: : $now.$$.int(rand(10000)));
1.463 albertel 18193: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18194:
18195: # Initialize roles
18196:
1.1414 raeburn 18197: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18198: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18199: }
18200: # ------------------------------------ Check browser type and MathML capability
18201:
1.1194 raeburn 18202: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18203: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18204:
18205: # ------------------------------------------------------------- Get environment
18206:
18207: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18208: my ($tmp) = keys(%userenv);
1.1275 raeburn 18209: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18210: undef(%userenv);
18211: }
18212: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18213: $form->{'interface'}=$userenv{'interface'};
18214: }
18215: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18216:
18217: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18218: foreach my $option ('interface','localpath','localres') {
18219: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18220: }
18221: # --------------------------------------------------------- Write first profile
18222:
18223: {
1.1350 raeburn 18224: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18225: my %initial_env =
18226: ("user.name" => $username,
18227: "user.domain" => $domain,
18228: "user.home" => $authhost,
18229: "browser.type" => $clientbrowser,
18230: "browser.version" => $clientversion,
18231: "browser.mathml" => $clientmathml,
18232: "browser.unicode" => $clientunicode,
18233: "browser.os" => $clientos,
1.1137 raeburn 18234: "browser.mobile" => $clientmobile,
1.1141 raeburn 18235: "browser.info" => $clientinfo,
1.1194 raeburn 18236: "browser.osversion" => $clientosversion,
1.462 albertel 18237: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18238: "request.course.fn" => '',
18239: "request.course.uri" => '',
18240: "request.course.sec" => '',
18241: "request.role" => 'cm',
18242: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18243: "request.host" => $ip,);
1.462 albertel 18244:
18245: if ($form->{'localpath'}) {
18246: $initial_env{"browser.localpath"} = $form->{'localpath'};
18247: $initial_env{"browser.localres"} = $form->{'localres'};
18248: }
18249:
18250: if ($form->{'interface'}) {
18251: $form->{'interface'}=~s/\W//gs;
18252: $initial_env{"browser.interface"} = $form->{'interface'};
18253: $env{'browser.interface'}=$form->{'interface'};
18254: }
18255:
1.1157 raeburn 18256: if ($form->{'iptoken'}) {
18257: my $lonhost = $r->dir_config('lonHostID');
18258: $initial_env{"user.noloadbalance"} = $lonhost;
18259: $env{'user.noloadbalance'} = $lonhost;
18260: }
18261:
1.1268 raeburn 18262: if ($form->{'noloadbalance'}) {
18263: my @hosts = &Apache::lonnet::current_machine_ids();
18264: my $hosthere = $form->{'noloadbalance'};
18265: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18266: $initial_env{"user.noloadbalance"} = $hosthere;
18267: $env{'user.noloadbalance'} = $hosthere;
18268: }
18269: }
18270:
1.1016 raeburn 18271: unless ($domain eq 'public') {
1.1273 raeburn 18272: my %is_adv = ( is_adv => $env{'user.adv'} );
18273: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18274:
1.1414 raeburn 18275: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18276: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18277: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18278: undef,\%userenv,\%domdef,\%is_adv);
18279: }
1.980 raeburn 18280:
1.1311 raeburn 18281: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18282: $userenv{'canrequest.'.$crstype} =
18283: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18284: 'reload','requestcourses',
18285: \%userenv,\%domdef,\%is_adv);
18286: }
1.724 raeburn 18287:
1.1418 raeburn 18288: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18289: (exists($userroles->{"user.role.au./$domain/"}))) {
18290: if ($userenv{'authoreditors'}) {
18291: $userenv{'editors'} = $userenv{'authoreditors'};
18292: } elsif ($domdef{'editors'} ne '') {
18293: $userenv{'editors'} = $domdef{'editors'};
18294: } else {
18295: $userenv{'editors'} = 'edit,xml';
18296: }
1.1431 raeburn 18297: if ($userenv{'authorarchive'}) {
18298: $userenv{'canarchive'} = 1;
18299: } elsif (($userenv{'authorarchive'} eq '') &&
18300: ($domdef{'archive'})) {
18301: $userenv{'canarchive'} = 1;
18302: }
1.1418 raeburn 18303: }
18304:
1.1273 raeburn 18305: $userenv{'canrequest.author'} =
18306: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18307: 'reload','requestauthor',
1.980 raeburn 18308: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18309: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18310: $domain,$username);
18311: my $reqstatus = $reqauthor{'author_status'};
18312: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18313: if (ref($reqauthor{'author'}) eq 'HASH') {
18314: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18315: $reqauthor{'author'}{'timestamp'};
18316: }
1.1092 raeburn 18317: }
1.1287 raeburn 18318: my ($types,$typename) = &course_types();
18319: if (ref($types) eq 'ARRAY') {
18320: my @options = ('approval','validate','autolimit');
18321: my $optregex = join('|',@options);
18322: my (%willtrust,%trustchecked);
18323: foreach my $type (@{$types}) {
18324: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18325: if ($dom_str ne '') {
18326: my $updatedstr = '';
18327: my @possdomains = split(',',$dom_str);
18328: foreach my $entry (@possdomains) {
18329: my ($extdom,$extopt) = split(':',$entry);
18330: unless ($trustchecked{$extdom}) {
18331: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18332: $trustchecked{$extdom} = 1;
18333: }
18334: if ($willtrust{$extdom}) {
18335: $updatedstr .= $entry.',';
18336: }
18337: }
18338: $updatedstr =~ s/,$//;
18339: if ($updatedstr) {
18340: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18341: } else {
18342: delete($userenv{'reqcrsotherdom.'.$type});
18343: }
18344: }
18345: }
18346: }
1.1092 raeburn 18347: }
1.462 albertel 18348: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18349:
1.462 albertel 18350: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18351: &GDBM_WRCREAT(),0640)) {
18352: &_add_to_env(\%disk_env,\%initial_env);
18353: &_add_to_env(\%disk_env,\%userenv,'environment.');
18354: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18355: if (ref($firstaccenv) eq 'HASH') {
18356: &_add_to_env(\%disk_env,$firstaccenv);
18357: }
18358: if (ref($timerintenv) eq 'HASH') {
18359: &_add_to_env(\%disk_env,$timerintenv);
18360: }
1.1414 raeburn 18361: if (ref($coauthorenv) eq 'HASH') {
18362: if (keys(%{$coauthorenv})) {
18363: &_add_to_env(\%disk_env,$coauthorenv);
18364: }
18365: }
1.463 albertel 18366: if (ref($args->{'extra_env'})) {
18367: &_add_to_env(\%disk_env,$args->{'extra_env'});
18368: }
1.462 albertel 18369: untie(%disk_env);
18370: } else {
1.705 tempelho 18371: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18372: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18373: return 'error: '.$!;
18374: }
18375: }
18376: $env{'request.role'}='cm';
18377: $env{'request.role.adv'}=$env{'user.adv'};
18378: $env{'browser.type'}=$clientbrowser;
18379:
18380: return $cookie;
18381:
18382: }
18383:
18384: sub _add_to_env {
18385: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18386: if (ref($env_data) eq 'HASH') {
18387: while (my ($key,$value) = each(%$env_data)) {
18388: $idf->{$prefix.$key} = $value;
18389: $env{$prefix.$key} = $value;
18390: }
1.462 albertel 18391: }
18392: }
18393:
1.685 tempelho 18394: # --- Get the symbolic name of a problem and the url
18395: sub get_symb {
18396: my ($request,$silent) = @_;
1.726 raeburn 18397: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18398: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18399: if ($symb eq '') {
18400: if (!$silent) {
1.1071 raeburn 18401: if (ref($request)) {
18402: $request->print("Unable to handle ambiguous references:$url:.");
18403: }
1.685 tempelho 18404: return ();
18405: }
18406: }
18407: &Apache::lonenc::check_decrypt(\$symb);
18408: return ($symb);
18409: }
18410:
18411: # --------------------------------------------------------------Get annotation
18412:
18413: sub get_annotation {
18414: my ($symb,$enc) = @_;
18415:
18416: my $key = $symb;
18417: if (!$enc) {
18418: $key =
18419: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18420: }
18421: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18422: return $annotation{$key};
18423: }
18424:
18425: sub clean_symb {
1.731 raeburn 18426: my ($symb,$delete_enc) = @_;
1.685 tempelho 18427:
18428: &Apache::lonenc::check_decrypt(\$symb);
18429: my $enc = $env{'request.enc'};
1.731 raeburn 18430: if ($delete_enc) {
1.730 raeburn 18431: delete($env{'request.enc'});
18432: }
1.685 tempelho 18433:
18434: return ($symb,$enc);
18435: }
1.462 albertel 18436:
1.1181 raeburn 18437: ############################################################
18438: ############################################################
18439:
18440: =pod
18441:
18442: =head1 Routines for building display used to search for courses
18443:
18444:
18445: =over 4
18446:
18447: =item * &build_filters()
18448:
18449: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18450: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18451: and quotacheck.pl
18452:
1.1181 raeburn 18453:
18454: Inputs:
18455:
18456: filterlist - anonymous array of fields to include as potential filters
18457:
18458: crstype - course type
18459:
18460: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18461: to pop-open a course selector (will contain "extra element").
18462:
18463: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18464:
18465: filter - anonymous hash of criteria and their values
18466:
18467: action - form action
18468:
18469: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18470:
1.1182 raeburn 18471: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18472:
18473: cloneruname - username of owner of new course who wants to clone
18474:
18475: clonerudom - domain of owner of new course who wants to clone
18476:
18477: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18478:
18479: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18480:
18481: codedom - domain
18482:
18483: formname - value of form element named "form".
18484:
18485: fixeddom - domain, if fixed.
18486:
18487: prevphase - value to assign to form element named "phase" when going back to the previous screen
18488:
18489: cnameelement - name of form element in form on opener page which will receive title of selected course
18490:
18491: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18492:
18493: cdomelement - name of form element in form on opener page which will receive domain of selected course
18494:
18495: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18496:
18497: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18498:
18499: clonewarning - warning message about missing information for intended course owner when DC creates a course
18500:
1.1182 raeburn 18501:
1.1181 raeburn 18502: Returns: $output - HTML for display of search criteria, and hidden form elements.
18503:
1.1182 raeburn 18504:
1.1181 raeburn 18505: Side Effects: None
18506:
18507: =cut
18508:
18509: # ---------------------------------------------- search for courses based on last activity etc.
18510:
18511: sub build_filters {
18512: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18513: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18514: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18515: $cnameelement,$cnumelement,$cdomelement,$setroles,
18516: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18517: my ($list,$jscript);
1.1181 raeburn 18518: my $onchange = 'javascript:updateFilters(this)';
18519: my ($domainselectform,$sincefilterform,$createdfilterform,
18520: $ownerdomselectform,$persondomselectform,$instcodeform,
18521: $typeselectform,$instcodetitle);
18522: if ($formname eq '') {
18523: $formname = $caller;
18524: }
18525: foreach my $item (@{$filterlist}) {
18526: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18527: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18528: if ($item eq 'domainfilter') {
18529: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18530: } elsif ($item eq 'coursefilter') {
18531: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18532: } elsif ($item eq 'ownerfilter') {
18533: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18534: } elsif ($item eq 'ownerdomfilter') {
18535: $filter->{'ownerdomfilter'} =
18536: &LONCAPA::clean_domain($filter->{$item});
18537: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18538: 'ownerdomfilter',1);
18539: } elsif ($item eq 'personfilter') {
18540: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18541: } elsif ($item eq 'persondomfilter') {
18542: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18543: 'persondomfilter',1);
18544: } else {
18545: $filter->{$item} =~ s/\W//g;
18546: }
18547: if (!$filter->{$item}) {
18548: $filter->{$item} = '';
18549: }
18550: }
18551: if ($item eq 'domainfilter') {
18552: my $allow_blank = 1;
18553: if ($formname eq 'portform') {
18554: $allow_blank=0;
18555: } elsif ($formname eq 'studentform') {
18556: $allow_blank=0;
18557: }
18558: if ($fixeddom) {
18559: $domainselectform = '<input type="hidden" name="domainfilter"'.
18560: ' value="'.$codedom.'" />'.
18561: &Apache::lonnet::domain($codedom,'description');
18562: } else {
18563: $domainselectform = &select_dom_form($filter->{$item},
18564: 'domainfilter',
18565: $allow_blank,'',$onchange);
18566: }
18567: } else {
18568: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18569: }
18570: }
18571:
18572: # last course activity filter and selection
18573: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18574:
18575: # course created filter and selection
18576: if (exists($filter->{'createdfilter'})) {
18577: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18578: }
18579:
1.1239 raeburn 18580: my $prefix = $crstype;
18581: if ($crstype eq 'Placement') {
18582: $prefix = 'Placement Test'
18583: }
1.1181 raeburn 18584: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18585: 'cac' => "$prefix Activity",
18586: 'ccr' => "$prefix Created",
18587: 'cde' => "$prefix Title",
18588: 'cdo' => "$prefix Domain",
1.1181 raeburn 18589: 'ins' => 'Institutional Code',
18590: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18591: 'cow' => "$prefix Owner/Co-owner",
18592: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18593: 'cog' => 'Type',
18594: );
18595:
18596: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18597: my $typeval = 'Course';
18598: if ($crstype eq 'Community') {
18599: $typeval = 'Community';
1.1239 raeburn 18600: } elsif ($crstype eq 'Placement') {
18601: $typeval = 'Placement';
1.1181 raeburn 18602: }
18603: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18604: } else {
18605: $typeselectform = '<select name="type" size="1"';
18606: if ($onchange) {
18607: $typeselectform .= ' onchange="'.$onchange.'"';
18608: }
18609: $typeselectform .= '>'."\n";
1.1237 raeburn 18610: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18611: my $shown;
18612: if ($posstype eq 'Placement') {
18613: $shown = &mt('Placement Test');
18614: } else {
18615: $shown = &mt($posstype);
18616: }
1.1181 raeburn 18617: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18618: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18619: }
18620: $typeselectform.="</select>";
18621: }
18622:
18623: my ($cloneableonlyform,$cloneabletitle);
18624: if (exists($filter->{'cloneableonly'})) {
18625: my $cloneableon = '';
18626: my $cloneableoff = ' checked="checked"';
18627: if ($filter->{'cloneableonly'}) {
18628: $cloneableon = $cloneableoff;
18629: $cloneableoff = '';
18630: }
18631: $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>';
18632: if ($formname eq 'ccrs') {
1.1187 bisitz 18633: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18634: } else {
18635: $cloneabletitle = &mt('Cloneable by you');
18636: }
18637: }
18638: my $officialjs;
18639: if ($crstype eq 'Course') {
18640: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18641: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18642: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18643: if ($codedom) {
1.1181 raeburn 18644: $officialjs = 1;
18645: ($instcodeform,$jscript,$$numtitlesref) =
18646: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18647: $officialjs,$codetitlesref);
18648: if ($jscript) {
1.1182 raeburn 18649: $jscript = '<script type="text/javascript">'."\n".
18650: '// <![CDATA['."\n".
18651: $jscript."\n".
18652: '// ]]>'."\n".
18653: '</script>'."\n";
1.1181 raeburn 18654: }
18655: }
18656: if ($instcodeform eq '') {
18657: $instcodeform =
18658: '<input type="text" name="instcodefilter" size="10" value="'.
18659: $list->{'instcodefilter'}.'" />';
18660: $instcodetitle = $lt{'ins'};
18661: } else {
18662: $instcodetitle = $lt{'inc'};
18663: }
18664: if ($fixeddom) {
18665: $instcodetitle .= '<br />('.$codedom.')';
18666: }
18667: }
18668: }
18669: my $output = qq|
18670: <form method="post" name="filterpicker" action="$action">
18671: <input type="hidden" name="form" value="$formname" />
18672: |;
18673: if ($formname eq 'modifycourse') {
18674: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18675: '<input type="hidden" name="prevphase" value="'.
18676: $prevphase.'" />'."\n";
1.1198 musolffc 18677: } elsif ($formname eq 'quotacheck') {
18678: $output .= qq|
18679: <input type="hidden" name="sortby" value="" />
18680: <input type="hidden" name="sortorder" value="" />
18681: |;
18682: } else {
1.1181 raeburn 18683: my $name_input;
18684: if ($cnameelement ne '') {
18685: $name_input = '<input type="hidden" name="cnameelement" value="'.
18686: $cnameelement.'" />';
18687: }
18688: $output .= qq|
1.1182 raeburn 18689: <input type="hidden" name="cnumelement" value="$cnumelement" />
18690: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18691: $name_input
18692: $roleelement
18693: $multelement
18694: $typeelement
18695: |;
18696: if ($formname eq 'portform') {
18697: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18698: }
18699: }
18700: if ($fixeddom) {
18701: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18702: }
18703: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18704: if ($sincefilterform) {
18705: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18706: .$sincefilterform
18707: .&Apache::lonhtmlcommon::row_closure();
18708: }
18709: if ($createdfilterform) {
18710: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18711: .$createdfilterform
18712: .&Apache::lonhtmlcommon::row_closure();
18713: }
18714: if ($domainselectform) {
18715: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18716: .$domainselectform
18717: .&Apache::lonhtmlcommon::row_closure();
18718: }
18719: if ($typeselectform) {
18720: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18721: $output .= $typeselectform;
18722: } else {
18723: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18724: .$typeselectform
18725: .&Apache::lonhtmlcommon::row_closure();
18726: }
18727: }
18728: if ($instcodeform) {
18729: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18730: .$instcodeform
18731: .&Apache::lonhtmlcommon::row_closure();
18732: }
18733: if (exists($filter->{'ownerfilter'})) {
18734: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18735: '<table><tr><td>'.&mt('Username').'<br />'.
18736: '<input type="text" name="ownerfilter" size="20" value="'.
18737: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18738: $ownerdomselectform.'</td></tr></table>'.
18739: &Apache::lonhtmlcommon::row_closure();
18740: }
18741: if (exists($filter->{'personfilter'})) {
18742: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18743: '<table><tr><td>'.&mt('Username').'<br />'.
18744: '<input type="text" name="personfilter" size="20" value="'.
18745: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18746: $persondomselectform.'</td></tr></table>'.
18747: &Apache::lonhtmlcommon::row_closure();
18748: }
18749: if (exists($filter->{'coursefilter'})) {
18750: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18751: .'<input type="text" name="coursefilter" size="25" value="'
18752: .$list->{'coursefilter'}.'" />'
18753: .&Apache::lonhtmlcommon::row_closure();
18754: }
18755: if ($cloneableonlyform) {
18756: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18757: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18758: }
18759: if (exists($filter->{'descriptfilter'})) {
18760: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18761: .'<input type="text" name="descriptfilter" size="40" value="'
18762: .$list->{'descriptfilter'}.'" />'
18763: .&Apache::lonhtmlcommon::row_closure(1);
18764: }
18765: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18766: '<input type="hidden" name="updater" value="" />'."\n".
18767: '<input type="submit" name="gosearch" value="'.
18768: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18769: return $jscript.$clonewarning.$output;
18770: }
18771:
18772: =pod
18773:
18774: =item * &timebased_select_form()
18775:
1.1182 raeburn 18776: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18777: filter e.g., Course Activity, Course Created, when searching for courses
18778: or communities
18779:
18780: Inputs:
18781:
18782: item - name of form element (sincefilter or createdfilter)
18783:
18784: filter - anonymous hash of criteria and their values
18785:
18786: Returns: HTML for a select box contained a blank, then six time selections,
18787: with value set in incoming form variables currently selected.
18788:
18789: Side Effects: None
18790:
18791: =cut
18792:
18793: sub timebased_select_form {
18794: my ($item,$filter) = @_;
18795: if (ref($filter) eq 'HASH') {
18796: $filter->{$item} =~ s/[^\d-]//g;
18797: if (!$filter->{$item}) { $filter->{$item}=-1; }
18798: return &select_form(
18799: $filter->{$item},
18800: $item,
18801: { '-1' => '',
18802: '86400' => &mt('today'),
18803: '604800' => &mt('last week'),
18804: '2592000' => &mt('last month'),
18805: '7776000' => &mt('last three months'),
18806: '15552000' => &mt('last six months'),
18807: '31104000' => &mt('last year'),
18808: 'select_form_order' =>
18809: ['-1','86400','604800','2592000','7776000',
18810: '15552000','31104000']});
18811: }
18812: }
18813:
18814: =pod
18815:
18816: =item * &js_changer()
18817:
18818: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18819: when course type or domain is changed, and also to hide 'Searching ...' on
18820: page load completion for page showing search result.
1.1181 raeburn 18821:
18822: Inputs: None
18823:
1.1183 raeburn 18824: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18825:
18826: Side Effects: None
18827:
18828: =cut
18829:
18830: sub js_changer {
18831: return <<ENDJS;
18832: <script type="text/javascript">
18833: // <![CDATA[
18834: function updateFilters(caller) {
18835: if (typeof(caller) != "undefined") {
18836: document.filterpicker.updater.value = caller.name;
18837: }
18838: document.filterpicker.submit();
18839: }
1.1183 raeburn 18840:
18841: function hideSearching() {
18842: if (document.getElementById('searching')) {
18843: document.getElementById('searching').style.display = 'none';
18844: }
18845: return;
18846: }
18847:
1.1181 raeburn 18848: // ]]>
18849: </script>
18850:
18851: ENDJS
18852: }
18853:
18854: =pod
18855:
1.1182 raeburn 18856: =item * &search_courses()
18857:
18858: Process selected filters form course search form and pass to lonnet::courseiddump
18859: to retrieve a hash for which keys are courseIDs which match the selected filters.
18860:
18861: Inputs:
18862:
18863: dom - domain being searched
18864:
18865: type - course type ('Course' or 'Community' or '.' if any).
18866:
18867: filter - anonymous hash of criteria and their values
18868:
18869: numtitles - for institutional codes - number of categories
18870:
18871: cloneruname - optional username of new course owner
18872:
18873: clonerudom - optional domain of new course owner
18874:
1.1221 raeburn 18875: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18876: (used when DC is using course creation form)
18877:
18878: codetitles - reference to array of titles of components in institutional codes (official courses).
18879:
1.1221 raeburn 18880: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18881: (and so can clone automatically)
18882:
18883: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18884:
18885: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18886: courses to clone
1.1182 raeburn 18887:
18888: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18889:
18890:
18891: Side Effects: None
18892:
18893: =cut
18894:
18895:
18896: sub search_courses {
1.1221 raeburn 18897: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18898: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18899: my (%courses,%showcourses,$cloner);
18900: if (($filter->{'ownerfilter'} ne '') ||
18901: ($filter->{'ownerdomfilter'} ne '')) {
18902: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18903: $filter->{'ownerdomfilter'};
18904: }
18905: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18906: if (!$filter->{$item}) {
18907: $filter->{$item}='.';
18908: }
18909: }
18910: my $now = time;
18911: my $timefilter =
18912: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18913: my ($createdbefore,$createdafter);
18914: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18915: $createdbefore = $now;
18916: $createdafter = $now-$filter->{'createdfilter'};
18917: }
18918: my ($instcodefilter,$regexpok);
18919: if ($numtitles) {
18920: if ($env{'form.official'} eq 'on') {
18921: $instcodefilter =
18922: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18923: $regexpok = 1;
18924: } elsif ($env{'form.official'} eq 'off') {
18925: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18926: unless ($instcodefilter eq '') {
18927: $regexpok = -1;
18928: }
18929: }
18930: } else {
18931: $instcodefilter = $filter->{'instcodefilter'};
18932: }
18933: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18934: if ($type eq '') { $type = '.'; }
18935:
18936: if (($clonerudom ne '') && ($cloneruname ne '')) {
18937: $cloner = $cloneruname.':'.$clonerudom;
18938: }
18939: %courses = &Apache::lonnet::courseiddump($dom,
18940: $filter->{'descriptfilter'},
18941: $timefilter,
18942: $instcodefilter,
18943: $filter->{'combownerfilter'},
18944: $filter->{'coursefilter'},
18945: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18946: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18947: $filter->{'cloneableonly'},
18948: $createdbefore,$createdafter,undef,
1.1221 raeburn 18949: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18950: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18951: my $ccrole;
18952: if ($type eq 'Community') {
18953: $ccrole = 'co';
18954: } else {
18955: $ccrole = 'cc';
18956: }
18957: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18958: $filter->{'persondomfilter'},
18959: 'userroles',undef,
18960: [$ccrole,'in','ad','ep','ta','cr'],
18961: $dom);
18962: foreach my $role (keys(%rolehash)) {
18963: my ($cnum,$cdom,$courserole) = split(':',$role);
18964: my $cid = $cdom.'_'.$cnum;
18965: if (exists($courses{$cid})) {
18966: if (ref($courses{$cid}) eq 'HASH') {
18967: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18968: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18969: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18970: }
18971: } else {
18972: $courses{$cid}{roles} = [$courserole];
18973: }
18974: $showcourses{$cid} = $courses{$cid};
18975: }
18976: }
18977: }
18978: %courses = %showcourses;
18979: }
18980: return %courses;
18981: }
18982:
18983: =pod
18984:
1.1181 raeburn 18985: =back
18986:
1.1207 raeburn 18987: =head1 Routines for version requirements for current course.
18988:
18989: =over 4
18990:
18991: =item * &check_release_required()
18992:
18993: Compares required LON-CAPA version with version on server, and
18994: if required version is newer looks for a server with the required version.
18995:
18996: Looks first at servers in user's owen domain; if none suitable, looks at
18997: servers in course's domain are permitted to host sessions for user's domain.
18998:
18999: Inputs:
19000:
19001: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
19002:
19003: $courseid - Course ID of current course
19004:
19005: $rolecode - User's current role in course (for switchserver query string).
19006:
19007: $required - LON-CAPA version needed by course (format: Major.Minor).
19008:
19009:
19010: Returns:
19011:
19012: $switchserver - query string tp append to /adm/switchserver call (if
19013: current server's LON-CAPA version is too old.
19014:
19015: $warning - Message is displayed if no suitable server could be found.
19016:
19017: =cut
19018:
19019: sub check_release_required {
19020: my ($loncaparev,$courseid,$rolecode,$required) = @_;
19021: my ($switchserver,$warning);
19022: if ($required ne '') {
19023: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
19024: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
19025: if ($reqdmajor ne '' && $reqdminor ne '') {
19026: my $otherserver;
19027: if (($major eq '' && $minor eq '') ||
19028: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
19029: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
19030: my $switchlcrev =
19031: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
19032: $userdomserver);
19033: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
19034: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
19035: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
19036: my $cdom = $env{'course.'.$courseid.'.domain'};
19037: if ($cdom ne $env{'user.domain'}) {
19038: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
19039: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
19040: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
19041: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
19042: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
19043: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
19044: my $canhost =
19045: &Apache::lonnet::can_host_session($env{'user.domain'},
19046: $coursedomserver,
19047: $remoterev,
19048: $udomdefaults{'remotesessions'},
19049: $defdomdefaults{'hostedsessions'});
19050:
19051: if ($canhost) {
19052: $otherserver = $coursedomserver;
19053: } else {
19054: $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.");
19055: }
19056: } else {
19057: $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).");
19058: }
19059: } else {
19060: $otherserver = $userdomserver;
19061: }
19062: }
19063: if ($otherserver ne '') {
19064: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
19065: }
19066: }
19067: }
19068: return ($switchserver,$warning);
19069: }
19070:
19071: =pod
19072:
19073: =item * &check_release_result()
19074:
19075: Inputs:
19076:
19077: $switchwarning - Warning message if no suitable server found to host session.
19078:
19079: $switchserver - query string to append to /adm/switchserver containing lonHostID
19080: and current role.
19081:
19082: Returns: HTML to display with information about requirement to switch server.
19083: Either displaying warning with link to Roles/Courses screen or
19084: display link to switchserver.
19085:
1.1181 raeburn 19086: =cut
19087:
1.1207 raeburn 19088: sub check_release_result {
19089: my ($switchwarning,$switchserver) = @_;
19090: my $output = &start_page('Selected course unavailable on this server').
1.1463 raeburn 19091: '<div class="LC_landmark" role="main"><p class="LC_warning">';
1.1207 raeburn 19092: if ($switchwarning) {
19093: $output .= $switchwarning.'<br /><a href="/adm/roles">';
19094: if (&show_course()) {
19095: $output .= &mt('Display courses');
19096: } else {
19097: $output .= &mt('Display roles');
19098: }
19099: $output .= '</a>';
19100: } elsif ($switchserver) {
19101: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
19102: '<br />'.
19103: '<a href="/adm/switchserver?'.$switchserver.'">'.
19104: &mt('Switch Server').
19105: '</a>';
19106: }
1.1463 raeburn 19107: $output .= '</p></div>'.&end_page();
1.1207 raeburn 19108: return $output;
19109: }
19110:
19111: =pod
19112:
19113: =item * &needs_coursereinit()
19114:
19115: Determine if course contents stored for user's session needs to be
19116: refreshed, because content has changed since "Big Hash" last tied.
19117:
19118: Check for change is made if time last checked is more than 10 minutes ago
19119: (by default).
19120:
19121: Inputs:
19122:
19123: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
19124:
19125: $interval (optional) - Time which may elapse (in s) between last check for content
19126: change in current course. (default: 600 s).
19127:
19128: Returns: an array; first element is:
19129:
19130: =over 4
19131:
19132: 'switch' - if content updates mean user's session
19133: needs to be switched to a server running a newer LON-CAPA version
19134:
19135: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
19136: on current server hosting user's session
19137:
19138: '' - if no action required.
19139:
19140: =back
19141:
19142: If first item element is 'switch':
19143:
19144: second item is $switchwarning - Warning message if no suitable server found to host session.
19145:
19146: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
19147: and current role.
19148:
19149: otherwise: no other elements returned.
19150:
19151: =back
19152:
19153: =cut
19154:
19155: sub needs_coursereinit {
19156: my ($loncaparev,$interval) = @_;
19157: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
19158: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19159: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19160: my $now = time;
19161: if ($interval eq '') {
19162: $interval = 600;
19163: }
19164: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19165: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19166: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19167: if ($blocked) {
19168: return ();
19169: }
1.1391 raeburn 19170: my $update;
19171: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19172: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19173: if ($lastmainchange > $env{'request.course.tied'}) {
19174: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19175: if ($needswitch) {
19176: return ('switch',$switchwarning,$switchserver);
19177: }
19178: $update = 'main';
19179: }
19180: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19181: if ($update) {
19182: $update = 'both';
19183: } else {
19184: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19185: if ($needswitch) {
19186: return ('switch',$switchwarning,$switchserver);
19187: } else {
19188: $update = 'supp';
1.1207 raeburn 19189: }
19190: }
1.1391 raeburn 19191: }
1.1453 raeburn 19192: return ($update);
1.1391 raeburn 19193: }
19194: return ();
19195: }
19196:
19197: sub switch_for_update {
19198: my ($loncaparev,$cdom,$cnum) = @_;
19199: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19200: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19201: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19202: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19203: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19204: $curr_reqd_hash{'internal.releaserequired'}});
19205: my ($switchserver,$switchwarning) =
19206: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19207: $curr_reqd_hash{'internal.releaserequired'});
19208: if ($switchwarning ne '' || $switchserver ne '') {
19209: return ('switch',$switchwarning,$switchserver);
19210: }
1.1207 raeburn 19211: }
19212: }
19213: return ();
19214: }
1.1181 raeburn 19215:
1.1083 raeburn 19216: sub update_content_constraints {
1.1395 raeburn 19217: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19218: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19219: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19220: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19221: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19222: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19223: if ($item eq 'resourcetag') {
19224: if ($name eq 'responsetype') {
19225: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19226: }
1.1307 raeburn 19227: } elsif ($item eq 'course') {
19228: if ($name eq 'courserestype') {
19229: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19230: }
1.1083 raeburn 19231: }
19232: }
19233: my $navmap = Apache::lonnavmaps::navmap->new();
19234: if (defined($navmap)) {
1.1307 raeburn 19235: my (%allresponses,%allcrsrestypes);
19236: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19237: if ($res->is_tool()) {
19238: if ($allcrsrestypes{'exttool'}) {
19239: $allcrsrestypes{'exttool'} ++;
19240: } else {
19241: $allcrsrestypes{'exttool'} = 1;
19242: }
19243: next;
19244: }
1.1083 raeburn 19245: my %responses = $res->responseTypes();
19246: foreach my $key (keys(%responses)) {
19247: next unless(exists($checkresponsetypes{$key}));
19248: $allresponses{$key} += $responses{$key};
19249: }
19250: }
19251: foreach my $key (keys(%allresponses)) {
19252: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19253: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19254: ($reqdmajor,$reqdminor) = ($major,$minor);
19255: }
19256: }
1.1307 raeburn 19257: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19258: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19259: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19260: ($reqdmajor,$reqdminor) = ($major,$minor);
19261: }
19262: }
1.1083 raeburn 19263: undef($navmap);
19264: }
1.1391 raeburn 19265: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19266: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19267: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19268: ($reqdmajor,$reqdminor) = ($major,$minor);
19269: }
19270: }
1.1083 raeburn 19271: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19272: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19273: }
19274: return;
19275: }
19276:
1.1110 raeburn 19277: sub allmaps_incourse {
19278: my ($cdom,$cnum,$chome,$cid) = @_;
19279: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19280: $cid = $env{'request.course.id'};
19281: $cdom = $env{'course.'.$cid.'.domain'};
19282: $cnum = $env{'course.'.$cid.'.num'};
19283: $chome = $env{'course.'.$cid.'.home'};
19284: }
19285: my %allmaps = ();
19286: my $lastchange =
19287: &Apache::lonnet::get_coursechange($cdom,$cnum);
19288: if ($lastchange > $env{'request.course.tied'}) {
19289: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19290: unless ($ferr) {
1.1395 raeburn 19291: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19292: }
19293: }
19294: my $navmap = Apache::lonnavmaps::navmap->new();
19295: if (defined($navmap)) {
19296: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19297: $allmaps{$res->src()} = 1;
19298: }
19299: }
19300: return \%allmaps;
19301: }
19302:
1.1083 raeburn 19303: sub parse_supplemental_title {
19304: my ($title) = @_;
19305:
19306: my ($foldertitle,$renametitle);
19307: if ($title =~ /&&&/) {
19308: $title = &HTML::Entites::decode($title);
19309: }
19310: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19311: $renametitle=$4;
19312: my ($time,$uname,$udom) = ($1,$2,$3);
19313: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19314: my $name = &plainname($uname,$udom);
19315: $name = &HTML::Entities::encode($name,'"<>&\'');
19316: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19317: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19318: if ($foldertitle ne '') {
1.1401 raeburn 19319: $title .= ': <br />'.$foldertitle;
19320: }
1.1083 raeburn 19321: }
19322: if (wantarray) {
19323: return ($title,$foldertitle,$renametitle);
19324: }
19325: return $title;
19326: }
19327:
1.1395 raeburn 19328: sub get_supplemental {
19329: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19330: my $hashid=$cnum.':'.$cdom;
19331: my ($supplemental,$cached,$set_httprefs);
19332: unless ($ignorecache) {
19333: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19334: }
19335: unless (defined($cached)) {
19336: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19337: unless ($chome eq 'no_host') {
19338: my @order = @LONCAPA::map::order;
19339: my @resources = @LONCAPA::map::resources;
19340: my @resparms = @LONCAPA::map::resparms;
19341: my @zombies = @LONCAPA::map::zombies;
19342: my ($errors,%ids,%hidden);
19343: $errors =
19344: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19345: $errors,$possdel,\%ids,\%hidden);
19346: @LONCAPA::map::order = @order;
19347: @LONCAPA::map::resources = @resources;
19348: @LONCAPA::map::resparms = @resparms;
19349: @LONCAPA::map::zombies = @zombies;
19350: $set_httprefs = 1;
19351: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19352: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19353: }
19354: $supplemental = {
19355: ids => \%ids,
19356: hidden => \%hidden,
19357: };
19358: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19359: }
19360: }
19361: return ($supplemental,$set_httprefs);
19362: }
19363:
1.1143 raeburn 19364: sub recurse_supplemental {
1.1391 raeburn 19365: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19366: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19367: my $mapnum;
19368: if ($suppmap eq 'supplemental.sequence') {
19369: $mapnum = 0;
19370: } else {
19371: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19372: }
1.1143 raeburn 19373: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19374: if ($fatal) {
19375: $errors ++;
19376: } else {
1.1389 raeburn 19377: my @order = @LONCAPA::map::order;
19378: if (@order > 0) {
19379: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19380: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19381: foreach my $idx (@order) {
19382: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19383: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19384: my $id = $mapnum.':'.$idx;
19385: push(@{$suppids->{$src}},$id);
19386: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19387: $hiddensupp->{$id} = 1;
19388: }
1.1146 raeburn 19389: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19390: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19391: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19392: } else {
1.1391 raeburn 19393: my $allowed;
19394: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19395: $allowed = 1;
19396: } elsif ($possdel) {
19397: foreach my $item (@{$suppids->{$src}}) {
19398: next if ($item eq $id);
19399: unless ($hiddensupp->{$item}) {
19400: $allowed = 1;
19401: last;
19402: }
19403: }
19404: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19405: &Apache::lonnet::delenv('httpref.'.$src);
19406: }
19407: }
19408: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19409: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19410: }
1.1143 raeburn 19411: }
19412: }
19413: }
19414: }
19415: }
19416: }
1.1391 raeburn 19417: return $errors;
19418: }
19419:
19420: sub set_supp_httprefs {
19421: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19422: if (ref($supplemental) eq 'HASH') {
19423: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19424: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19425: next if ($src =~ /\.sequence$/);
19426: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19427: my $allowed;
19428: if ($env{'request.role.adv'}) {
19429: $allowed = 1;
19430: } else {
19431: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19432: unless ($supplemental->{'hidden'}->{$id}) {
19433: $allowed = 1;
19434: last;
19435: }
19436: }
19437: }
19438: if (exists($env{'httpref.'.$src})) {
19439: if ($possdel) {
19440: unless ($allowed) {
19441: &Apache::lonnet::delenv('httpref.'.$src);
19442: }
19443: }
19444: } elsif ($allowed) {
19445: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19446: }
19447: }
19448: }
19449: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19450: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19451: }
19452: }
19453: }
19454: }
19455:
19456: sub get_supp_parameter {
19457: my ($resparm,$name)=@_;
19458: return if ($resparm eq '');
19459: my $value=undef;
19460: my $ptype=undef;
19461: foreach (split('&&&',$resparm)) {
19462: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19463: if ($thisname eq $name) {
19464: $value=$thisvalue;
19465: $ptype=$thistype;
19466: }
19467: }
19468: return $value;
1.1143 raeburn 19469: }
19470:
1.1101 raeburn 19471: sub symb_to_docspath {
1.1267 raeburn 19472: my ($symb,$navmapref) = @_;
19473: return unless ($symb && ref($navmapref));
1.1101 raeburn 19474: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19475: if ($resurl=~/\.(sequence|page)$/) {
19476: $mapurl=$resurl;
19477: } elsif ($resurl eq 'adm/navmaps') {
19478: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19479: }
19480: my $mapresobj;
1.1267 raeburn 19481: unless (ref($$navmapref)) {
19482: $$navmapref = Apache::lonnavmaps::navmap->new();
19483: }
19484: if (ref($$navmapref)) {
19485: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19486: }
19487: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19488: my $type=$2;
19489: my $path;
19490: if (ref($mapresobj)) {
19491: my $pcslist = $mapresobj->map_hierarchy();
19492: if ($pcslist ne '') {
19493: foreach my $pc (split(/,/,$pcslist)) {
19494: next if ($pc <= 1);
1.1267 raeburn 19495: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19496: if (ref($res)) {
19497: my $thisurl = $res->src();
19498: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19499: my $thistitle = $res->title();
19500: $path .= '&'.
19501: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19502: &escape($thistitle).
1.1101 raeburn 19503: ':'.$res->randompick().
19504: ':'.$res->randomout().
19505: ':'.$res->encrypted().
19506: ':'.$res->randomorder().
19507: ':'.$res->is_page();
19508: }
19509: }
19510: }
19511: $path =~ s/^\&//;
19512: my $maptitle = $mapresobj->title();
19513: if ($mapurl eq 'default') {
1.1129 raeburn 19514: $maptitle = 'Main Content';
1.1101 raeburn 19515: }
19516: $path .= (($path ne '')? '&' : '').
19517: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19518: &escape($maptitle).
1.1101 raeburn 19519: ':'.$mapresobj->randompick().
19520: ':'.$mapresobj->randomout().
19521: ':'.$mapresobj->encrypted().
19522: ':'.$mapresobj->randomorder().
19523: ':'.$mapresobj->is_page();
19524: } else {
19525: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19526: my $ispage = (($type eq 'page')? 1 : '');
19527: if ($mapurl eq 'default') {
1.1129 raeburn 19528: $maptitle = 'Main Content';
1.1101 raeburn 19529: }
19530: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19531: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19532: }
19533: unless ($mapurl eq 'default') {
19534: $path = 'default&'.
1.1146 raeburn 19535: &escape('Main Content').
1.1101 raeburn 19536: ':::::&'.$path;
19537: }
19538: return $path;
19539: }
19540:
1.1393 raeburn 19541: sub validate_folderpath {
19542: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19543: if ($env{'form.folderpath'} ne '') {
19544: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19545: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19546: for (my $i=0; $i<@items; $i++) {
19547: my $odd = $i%2;
19548: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19549: $badpath = 1;
1.1394 raeburn 19550: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19551: my $idx = $i-1;
1.1394 raeburn 19552: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19553: my $esc_name = $1;
19554: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19555: $supppath .= '&'.$esc_name;
19556: $changed = 1;
19557: } else {
19558: $supppath .= '&'.$items[$i];
19559: }
19560: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19561: $changed = 1;
1.1393 raeburn 19562: my $is_hidden;
19563: unless ($got_supp) {
1.1395 raeburn 19564: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19565: if (ref($supplemental) eq 'HASH') {
19566: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19567: %supphidden = %{$supplemental->{'hidden'}};
19568: }
19569: if (ref($supplemental->{'ids'}) eq 'HASH') {
19570: %suppids = %{$supplemental->{'ids'}};
19571: }
19572: }
19573: $got_supp = 1;
19574: }
19575: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19576: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19577: if ($supphidden{$mapid}) {
19578: $is_hidden = 1;
19579: }
19580: }
1.1394 raeburn 19581: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19582: } else {
19583: $supppath .= '&'.$items[$i];
1.1393 raeburn 19584: }
19585: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19586: $badpath = 1;
1.1394 raeburn 19587: } elsif ($supplementalflag) {
1.1393 raeburn 19588: $supppath .= '&'.$items[$i];
19589: }
19590: last if ($badpath);
19591: }
19592: if ($badpath) {
19593: delete($env{'form.folderpath'});
1.1394 raeburn 19594: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19595: $supppath =~ s/^\&//;
19596: $env{'form.folderpath'} = $supppath;
19597: }
19598: }
19599: return;
19600: }
19601:
1.1094 raeburn 19602: sub captcha_display {
1.1327 raeburn 19603: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19604: my ($output,$error);
1.1234 raeburn 19605: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19606: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19607: if ($captcha eq 'original') {
1.1094 raeburn 19608: $output = &create_captcha();
19609: unless ($output) {
1.1172 raeburn 19610: $error = 'captcha';
1.1094 raeburn 19611: }
19612: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19613: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19614: unless ($output) {
1.1172 raeburn 19615: $error = 'recaptcha';
1.1094 raeburn 19616: }
19617: }
1.1234 raeburn 19618: return ($output,$error,$captcha,$version);
1.1094 raeburn 19619: }
19620:
19621: sub captcha_response {
1.1327 raeburn 19622: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19623: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19624: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19625: if ($captcha eq 'original') {
1.1094 raeburn 19626: ($captcha_chk,$captcha_error) = &check_captcha();
19627: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19628: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19629: } else {
19630: $captcha_chk = 1;
19631: }
19632: return ($captcha_chk,$captcha_error);
19633: }
19634:
19635: sub get_captcha_config {
1.1327 raeburn 19636: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19637: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19638: my $hostname = &Apache::lonnet::hostname($lonhost);
19639: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19640: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19641: if ($context eq 'usercreation') {
19642: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19643: if (ref($domconfig{$context}) eq 'HASH') {
19644: $hashtocheck = $domconfig{$context}{'cancreate'};
19645: if (ref($hashtocheck) eq 'HASH') {
19646: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19647: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19648: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19649: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19650: }
19651: if ($privkey && $pubkey) {
19652: $captcha = 'recaptcha';
1.1234 raeburn 19653: $version = $hashtocheck->{'recaptchaversion'};
19654: if ($version ne '2') {
19655: $version = 1;
19656: }
1.1095 raeburn 19657: } else {
19658: $captcha = 'original';
19659: }
19660: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19661: $captcha = 'original';
19662: }
1.1094 raeburn 19663: }
1.1095 raeburn 19664: } else {
19665: $captcha = 'captcha';
19666: }
19667: } elsif ($context eq 'login') {
19668: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19669: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19670: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19671: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19672: if ($privkey && $pubkey) {
19673: $captcha = 'recaptcha';
1.1234 raeburn 19674: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19675: if ($version ne '2') {
19676: $version = 1;
19677: }
1.1095 raeburn 19678: } else {
19679: $captcha = 'original';
1.1094 raeburn 19680: }
1.1095 raeburn 19681: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19682: $captcha = 'original';
1.1094 raeburn 19683: }
1.1327 raeburn 19684: } elsif ($context eq 'passwords') {
19685: if ($dom_in_effect) {
19686: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19687: if ($passwdconf{'captcha'} eq 'recaptcha') {
19688: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19689: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19690: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19691: }
19692: if ($privkey && $pubkey) {
19693: $captcha = 'recaptcha';
19694: $version = $passwdconf{'recaptchaversion'};
19695: if ($version ne '2') {
19696: $version = 1;
19697: }
19698: } else {
19699: $captcha = 'original';
19700: }
19701: } elsif ($passwdconf{'captcha'} ne 'notused') {
19702: $captcha = 'original';
19703: }
19704: }
19705: }
1.1234 raeburn 19706: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19707: }
19708:
19709: sub create_captcha {
19710: my %captcha_params = &captcha_settings();
19711: my ($output,$maxtries,$tries) = ('',10,0);
19712: while ($tries < $maxtries) {
19713: $tries ++;
19714: my $captcha = Authen::Captcha->new (
19715: output_folder => $captcha_params{'output_dir'},
19716: data_folder => $captcha_params{'db_dir'},
19717: );
19718: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19719:
19720: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19721: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19722: '<span class="LC_nobreak">'.
1.1453 raeburn 19723: '<label>'.&mt('Type in the letters/numbers shown below').' '.
1.1463 raeburn 19724: '<input type="text" size="5" name="code" value="" autocomplete="new-password" aria-required="true" />'.
1.1453 raeburn 19725: '</label></span><br />'.
1.1176 raeburn 19726: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19727: last;
19728: }
19729: }
1.1323 raeburn 19730: if ($output eq '') {
19731: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19732: }
1.1094 raeburn 19733: return $output;
19734: }
19735:
19736: sub captcha_settings {
19737: my %captcha_params = (
19738: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19739: www_output_dir => "/captchaspool",
19740: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19741: numchars => '5',
19742: );
19743: return %captcha_params;
19744: }
19745:
19746: sub check_captcha {
19747: my ($captcha_chk,$captcha_error);
19748: my $code = $env{'form.code'};
19749: my $md5sum = $env{'form.crypt'};
19750: my %captcha_params = &captcha_settings();
19751: my $captcha = Authen::Captcha->new(
19752: output_folder => $captcha_params{'output_dir'},
19753: data_folder => $captcha_params{'db_dir'},
19754: );
1.1109 raeburn 19755: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19756: my %captcha_hash = (
19757: 0 => 'Code not checked (file error)',
19758: -1 => 'Failed: code expired',
19759: -2 => 'Failed: invalid code (not in database)',
19760: -3 => 'Failed: invalid code (code does not match crypt)',
19761: );
19762: if ($captcha_chk != 1) {
19763: $captcha_error = $captcha_hash{$captcha_chk}
19764: }
19765: return ($captcha_chk,$captcha_error);
19766: }
19767:
19768: sub create_recaptcha {
1.1234 raeburn 19769: my ($pubkey,$version) = @_;
19770: if ($version >= 2) {
1.1367 raeburn 19771: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19772: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19773: } else {
19774: my $use_ssl;
19775: if ($ENV{'SERVER_PORT'} == 443) {
19776: $use_ssl = 1;
19777: }
19778: my $captcha = Captcha::reCAPTCHA->new;
19779: return $captcha->get_options_setter({theme => 'white'})."\n".
19780: $captcha->get_html($pubkey,undef,$use_ssl).
19781: &mt('If the text is hard to read, [_1] will replace them.',
19782: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19783: '<br /><br />';
19784: }
1.1094 raeburn 19785: }
19786:
19787: sub check_recaptcha {
1.1234 raeburn 19788: my ($privkey,$version) = @_;
1.1094 raeburn 19789: my $captcha_chk;
1.1350 raeburn 19790: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19791: if ($version >= 2) {
19792: my %info = (
19793: secret => $privkey,
19794: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19795: remoteip => $ip,
1.1234 raeburn 19796: );
1.1280 raeburn 19797: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19798: $request->content(join('&',map {
19799: my $name = escape($_);
19800: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19801: ? join("&$name=", map {escape($_) } @{$info{$_}})
19802: : &escape($info{$_}) );
19803: } keys(%info)));
19804: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19805: if ($response->is_success) {
19806: my $data = JSON::DWIW->from_json($response->decoded_content);
19807: if (ref($data) eq 'HASH') {
19808: if ($data->{'success'}) {
19809: $captcha_chk = 1;
19810: }
19811: }
19812: }
19813: } else {
19814: my $captcha = Captcha::reCAPTCHA->new;
19815: my $captcha_result =
19816: $captcha->check_answer(
19817: $privkey,
1.1350 raeburn 19818: $ip,
1.1234 raeburn 19819: $env{'form.recaptcha_challenge_field'},
19820: $env{'form.recaptcha_response_field'},
19821: );
19822: if ($captcha_result->{is_valid}) {
19823: $captcha_chk = 1;
19824: }
1.1094 raeburn 19825: }
19826: return $captcha_chk;
19827: }
19828:
1.1174 raeburn 19829: sub emailusername_info {
1.1244 raeburn 19830: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19831: my %titles = &Apache::lonlocal::texthash (
19832: lastname => 'Last Name',
19833: firstname => 'First Name',
19834: institution => 'School/college/university',
19835: location => "School's city, state/province, country",
19836: web => "School's web address",
19837: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19838: id => 'Student/Employee ID',
1.1174 raeburn 19839: );
19840: return (\@fields,\%titles);
19841: }
19842:
1.1161 raeburn 19843: sub cleanup_html {
19844: my ($incoming) = @_;
19845: my $outgoing;
19846: if ($incoming ne '') {
19847: $outgoing = $incoming;
19848: $outgoing =~ s/;/;/g;
19849: $outgoing =~ s/\#/#/g;
19850: $outgoing =~ s/\&/&/g;
19851: $outgoing =~ s/</</g;
19852: $outgoing =~ s/>/>/g;
19853: $outgoing =~ s/\(/(/g;
19854: $outgoing =~ s/\)/)/g;
19855: $outgoing =~ s/"/"/g;
19856: $outgoing =~ s/'/'/g;
19857: $outgoing =~ s/\$/$/g;
19858: $outgoing =~ s{/}{/}g;
19859: $outgoing =~ s/=/=/g;
19860: $outgoing =~ s/\\/\/g
19861: }
19862: return $outgoing;
19863: }
19864:
1.1190 musolffc 19865: # Checks for critical messages and returns a redirect url if one exists.
19866: # $interval indicates how often to check for messages.
1.1282 raeburn 19867: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19868: sub critical_redirect {
1.1282 raeburn 19869: my ($interval,$context) = @_;
1.1356 raeburn 19870: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19871: return ();
19872: }
1.1190 musolffc 19873: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19874: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19875: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19876: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19877: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19878: if ($blocked) {
19879: my $checkrole = "cm./$cdom/$cnum";
19880: if ($env{'request.course.sec'} ne '') {
19881: $checkrole .= "/$env{'request.course.sec'}";
19882: }
19883: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19884: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19885: return;
19886: }
19887: }
19888: }
1.1190 musolffc 19889: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19890: $env{'user.name'});
19891: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19892: my $redirecturl;
1.1190 musolffc 19893: if ($what[0]) {
1.1356 raeburn 19894: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19895: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19896: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19897: return (1, $url);
1.1190 musolffc 19898: }
1.1191 raeburn 19899: }
19900: }
19901: return ();
1.1190 musolffc 19902: }
19903:
1.1174 raeburn 19904: # Use:
19905: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19906: #
19907: ##################################################
19908: # password associated functions #
19909: ##################################################
19910: sub des_keys {
19911: # Make a new key for DES encryption.
19912: # Each key has two parts which are returned separately.
19913: # Please note: Each key must be passed through the &hex function
19914: # before it is output to the web browser. The hex versions cannot
19915: # be used to decrypt.
19916: my @hexstr=('0','1','2','3','4','5','6','7',
19917: '8','9','a','b','c','d','e','f');
19918: my $lkey='';
19919: for (0..7) {
19920: $lkey.=$hexstr[rand(15)];
19921: }
19922: my $ukey='';
19923: for (0..7) {
19924: $ukey.=$hexstr[rand(15)];
19925: }
19926: return ($lkey,$ukey);
19927: }
19928:
19929: sub des_decrypt {
19930: my ($key,$cyphertext) = @_;
19931: my $keybin=pack("H16",$key);
19932: my $cypher;
19933: if ($Crypt::DES::VERSION>=2.03) {
19934: $cypher=new Crypt::DES $keybin;
19935: } else {
19936: $cypher=new DES $keybin;
19937: }
1.1233 raeburn 19938: my $plaintext='';
19939: my $cypherlength = length($cyphertext);
19940: my $numchunks = int($cypherlength/32);
19941: for (my $j=0; $j<$numchunks; $j++) {
19942: my $start = $j*32;
19943: my $cypherblock = substr($cyphertext,$start,32);
19944: my $chunk =
19945: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19946: $chunk .=
19947: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19948: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19949: $plaintext .= $chunk;
19950: }
1.1174 raeburn 19951: return $plaintext;
19952: }
19953:
1.1344 raeburn 19954: sub get_requested_shorturls {
1.1309 raeburn 19955: my ($cdom,$cnum,$navmap) = @_;
19956: return unless (ref($navmap));
1.1344 raeburn 19957: my ($numnew,$errors);
1.1309 raeburn 19958: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19959: if (@toshorten) {
19960: my (%maps,%resources,%titles);
19961: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19962: 'shorturls',$cdom,$cnum);
19963: if (keys(%resources)) {
1.1344 raeburn 19964: my %tocreate;
1.1309 raeburn 19965: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19966: my $symb = $resources{$item};
19967: if ($symb) {
19968: $tocreate{$cnum.'&'.$symb} = 1;
19969: }
19970: }
1.1344 raeburn 19971: if (keys(%tocreate)) {
19972: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19973: \%tocreate);
19974: }
1.1309 raeburn 19975: }
1.1344 raeburn 19976: }
19977: return ($numnew,$errors);
19978: }
19979:
19980: sub make_short_symbs {
19981: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19982: my ($numnew,@errors);
19983: if (ref($tocreateref) eq 'HASH') {
19984: my %tocreate = %{$tocreateref};
1.1309 raeburn 19985: if (keys(%tocreate)) {
19986: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19987: my $su = Short::URL->new(no_vowels => 1);
19988: my $init = '';
19989: my (%newunique,%addcourse,%courseonly,%failed);
19990: # get lock on tiny db
19991: my $now = time;
1.1344 raeburn 19992: if ($lockuser eq '') {
19993: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19994: }
1.1309 raeburn 19995: my $lockhash = {
1.1344 raeburn 19996: "lock\0$now" => $lockuser,
1.1309 raeburn 19997: };
19998: my $tries = 0;
19999: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
20000: my ($code,$error);
20001: while (($gotlock ne 'ok') && ($tries<3)) {
20002: $tries ++;
20003: sleep 1;
1.1319 raeburn 20004: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 20005: }
20006: if ($gotlock eq 'ok') {
20007: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
20008: \%addcourse,\%courseonly,\%failed);
20009: if (keys(%failed)) {
20010: my $numfailed = scalar(keys(%failed));
20011: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
20012: }
20013: if (keys(%newunique)) {
20014: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
20015: if ($putres eq 'ok') {
20016: $numnew = scalar(keys(%newunique));
20017: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
20018: unless ($newputres eq 'ok') {
20019: push(@errors,&mt('error: could not store course look-up of short URLs'));
20020: }
20021: } else {
20022: push(@errors,&mt('error: could not store unique six character URLs'));
20023: }
20024: }
20025: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
20026: unless ($dellockres eq 'ok') {
20027: push(@errors,&mt('error: could not release lockfile'));
20028: }
20029: } else {
20030: push(@errors,&mt('error: could not obtain lockfile'));
20031: }
20032: if (keys(%courseonly)) {
20033: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
20034: if ($result ne 'ok') {
20035: push(@errors,&mt('error: could not update course look-up of short URLs'));
20036: }
20037: }
20038: }
20039: }
20040: return ($numnew,\@errors);
20041: }
20042:
20043: sub shorten_symbs {
20044: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
20045: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
20046: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
20047: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
20048: my (%possibles,%collisions);
20049: foreach my $key (keys(%{$tocreate})) {
20050: my $num = String::CRC32::crc32($key);
20051: my $tiny = $su->encode($num,$init);
20052: if ($tiny) {
20053: $possibles{$tiny} = $key;
20054: }
20055: }
20056: if (!$init) {
20057: $init = 1;
20058: } else {
20059: $init ++;
20060: }
20061: if (keys(%possibles)) {
20062: my @posstiny = keys(%possibles);
20063: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
20064: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
20065: if (keys(%currtiny)) {
20066: foreach my $key (keys(%currtiny)) {
20067: next if ($currtiny{$key} eq '');
20068: if ($currtiny{$key} eq $possibles{$key}) {
20069: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
20070: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
20071: $courseonly->{$tsymb} = $key;
20072: }
20073: } else {
20074: $collisions{$possibles{$key}} = 1;
20075: }
20076: delete($possibles{$key});
20077: }
20078: }
20079: foreach my $key (keys(%possibles)) {
20080: $newunique->{$key} = $possibles{$key};
20081: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
20082: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
20083: $addcourse->{$tsymb} = $key;
20084: }
20085: }
20086: }
20087: if (keys(%collisions)) {
20088: if ($init <5) {
20089: if (!$init) {
20090: $init = 1;
20091: } else {
20092: $init ++;
20093: }
20094: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
20095: $newunique,$addcourse,$courseonly,$failed);
20096: } else {
20097: foreach my $key (keys(%collisions)) {
20098: $failed->{$key} = 1;
20099: }
20100: }
20101: }
20102: return $init;
20103: }
20104:
1.1328 raeburn 20105: sub is_nonframeable {
1.1329 raeburn 20106: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
20107: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 20108: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 20109:
20110: $remprotocol = lc($remprotocol);
20111: $remhost = lc($remhost);
20112: my $remport = 80;
20113: if ($remprotocol eq 'https') {
20114: $remport = 443;
20115: }
1.1330 raeburn 20116: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 20117: if ($cached) {
20118: unless ($nocache) {
20119: if ($result) {
20120: return 1;
20121: } else {
20122: return 0;
20123: }
20124: }
20125: }
1.1328 raeburn 20126: my $uselink;
20127: my $request = new HTTP::Request('HEAD',$url);
20128: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
20129: if ($response->is_success()) {
20130: my $secpolicy = lc($response->header('content-security-policy'));
20131: my $xframeop = lc($response->header('x-frame-options'));
20132: $secpolicy =~ s/^\s+|\s+$//g;
20133: $xframeop =~ s/^\s+|\s+$//g;
20134: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 20135: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 20136: my ($origin,$protocol,$port);
20137: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
20138: $port = $ENV{'SERVER_PORT'};
20139: } else {
20140: $port = 80;
20141: }
20142: if ($absolute eq '') {
20143: $protocol = 'http:';
20144: if ($port == 443) {
20145: $protocol = 'https:';
20146: }
20147: $origin = $protocol.'//'.lc($hostname);
20148: } else {
20149: $origin = lc($absolute);
20150: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
20151: }
20152: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
20153: my $framepolicy = $1;
20154: $framepolicy =~ s/^\s+|\s+$//g;
20155: my @policies = split(/\s+/,$framepolicy);
20156: if (@policies) {
20157: if (grep(/^\Q'none'\E$/,@policies)) {
20158: $uselink = 1;
20159: } else {
20160: $uselink = 1;
20161: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20162: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20163: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20164: undef($uselink);
20165: }
20166: if ($uselink) {
20167: if (grep(/^\Q'self'\E$/,@policies)) {
20168: if (($origin ne '') && ($remotehost eq $origin)) {
20169: undef($uselink);
20170: }
20171: }
20172: }
20173: if ($uselink) {
20174: my @possok;
20175: if ($ip ne '') {
20176: push(@possok,$ip);
20177: }
20178: my $hoststr = '';
20179: foreach my $part (reverse(split(/\./,$hostname))) {
20180: if ($hoststr eq '') {
20181: $hoststr = $part;
20182: } else {
20183: $hoststr = "$part.$hoststr";
20184: }
20185: if ($hoststr eq $hostname) {
20186: push(@possok,$hostname);
20187: } else {
20188: push(@possok,"*.$hoststr");
20189: }
20190: }
20191: if (@possok) {
20192: foreach my $poss (@possok) {
20193: last if (!$uselink);
20194: foreach my $policy (@policies) {
20195: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20196: undef($uselink);
20197: last;
20198: }
20199: }
20200: }
20201: }
20202: }
20203: }
20204: }
20205: } elsif ($xframeop ne '') {
20206: $uselink = 1;
20207: my @policies = split(/\s*,\s*/,$xframeop);
20208: if (@policies) {
20209: unless (grep(/^deny$/,@policies)) {
20210: if ($origin ne '') {
20211: if (grep(/^sameorigin$/,@policies)) {
20212: if ($remotehost eq $origin) {
20213: undef($uselink);
20214: }
20215: }
20216: if ($uselink) {
20217: foreach my $policy (@policies) {
20218: if ($policy =~ /^allow-from\s*(.+)$/) {
20219: my $allowfrom = $1;
20220: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20221: undef($uselink);
20222: last;
20223: }
20224: }
20225: }
20226: }
20227: }
20228: }
20229: }
20230: }
20231: }
20232: }
1.1329 raeburn 20233: if ($nocache) {
20234: if ($cached) {
20235: my $devalidate;
20236: if ($uselink && !$result) {
20237: $devalidate = 1;
20238: } elsif (!$uselink && $result) {
20239: $devalidate = 1;
20240: }
20241: if ($devalidate) {
20242: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20243: }
20244: }
20245: } else {
20246: if ($uselink) {
20247: $result = 1;
20248: } else {
20249: $result = 0;
20250: }
20251: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20252: }
1.1328 raeburn 20253: return $uselink;
20254: }
20255:
1.1359 raeburn 20256: sub page_menu {
20257: my ($menucolls,$menunum) = @_;
20258: my %menu;
20259: foreach my $item (split(/;/,$menucolls)) {
20260: my ($num,$value) = split(/\%/,$item);
20261: if ($num eq $menunum) {
20262: my @entries = split(/\&/,$value);
20263: foreach my $entry (@entries) {
20264: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20265: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20266: $menu{$name} = $fields;
20267: } else {
20268: my @shown;
20269: if ($fields =~ /,/) {
20270: @shown = split(/,/,$fields);
20271: } else {
20272: @shown = ($fields);
20273: }
20274: if (@shown) {
20275: foreach my $field (@shown) {
20276: next if ($field eq '');
20277: $menu{$field} = 1;
20278: }
20279: }
20280: }
20281: }
20282: }
20283: }
20284: return %menu;
20285: }
20286:
1.112 bowersj2 20287: 1;
20288: __END__;
1.41 ng 20289:
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