Annotation of loncom/interface/loncommon.pm, revision 1.1460
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1460 ! raeburn 4: # $Id: loncommon.pm,v 1.1459 2025/02/20 03:05:34 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";
7042: <div id="LC_expandingContainer" style="display:inline;">
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.458 albertel 7509: table.LC_pastsubmission {
7510: border: 1px solid black;
7511: margin: 2px;
7512: }
7513:
1.924 bisitz 7514: table#LC_menubuttons {
1.345 albertel 7515: width: 100%;
7516: background: $pgbg;
1.392 albertel 7517: border: 2px;
1.402 albertel 7518: border-collapse: separate;
1.803 bisitz 7519: padding: 0;
1.345 albertel 7520: }
1.392 albertel 7521:
1.801 tempelho 7522: table#LC_title_bar a {
7523: color: $fontmenu;
7524: }
1.836 bisitz 7525:
1.807 droeschl 7526: table#LC_title_bar {
1.819 tempelho 7527: clear: both;
1.836 bisitz 7528: display: none;
1.807 droeschl 7529: }
7530:
1.795 www 7531: table#LC_title_bar,
1.933 droeschl 7532: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7533: table#LC_title_bar.LC_with_remote {
1.359 albertel 7534: width: 100%;
1.392 albertel 7535: border-color: $pgbg;
7536: border-style: solid;
7537: border-width: $border;
1.379 albertel 7538: background: $pgbg;
1.801 tempelho 7539: color: $fontmenu;
1.392 albertel 7540: border-collapse: collapse;
1.803 bisitz 7541: padding: 0;
1.819 tempelho 7542: margin: 0;
1.359 albertel 7543: }
1.795 www 7544:
1.933 droeschl 7545: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7546: margin: 0;
7547: padding: 0;
1.933 droeschl 7548: position: relative;
7549: list-style: none;
1.913 droeschl 7550: }
1.933 droeschl 7551: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7552: display: inline;
7553: }
1.933 droeschl 7554:
7555: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7556: padding: 0;
1.933 droeschl 7557: margin: 0;
7558: float: left;
1.913 droeschl 7559: }
1.933 droeschl 7560: .LC_breadcrumb_tools_tools {
7561: padding: 0;
7562: margin: 0;
1.913 droeschl 7563: float: right;
7564: }
7565:
1.1240 raeburn 7566: .LC_placement_prog {
7567: padding-right: 20px;
7568: font-weight: bold;
7569: font-size: 90%;
7570: }
7571:
1.359 albertel 7572: table#LC_title_bar td {
7573: background: $tabbg;
7574: }
1.795 www 7575:
1.911 bisitz 7576: table#LC_menubuttons img {
1.803 bisitz 7577: border: none;
1.346 albertel 7578: }
1.795 www 7579:
1.842 droeschl 7580: .LC_breadcrumbs_component {
1.911 bisitz 7581: float: right;
7582: margin: 0 1em;
1.357 albertel 7583: }
1.842 droeschl 7584: .LC_breadcrumbs_component img {
1.911 bisitz 7585: vertical-align: middle;
1.777 tempelho 7586: }
1.795 www 7587:
1.1243 raeburn 7588: .LC_breadcrumbs_hoverable {
7589: background: $sidebg;
7590: }
7591:
1.383 albertel 7592: td.LC_table_cell_checkbox {
7593: text-align: center;
7594: }
1.795 www 7595:
7596: .LC_fontsize_small {
1.911 bisitz 7597: font-size: 70%;
1.705 tempelho 7598: }
7599:
1.844 bisitz 7600: #LC_breadcrumbs {
1.911 bisitz 7601: clear:both;
7602: background: $sidebg;
7603: border-bottom: 1px solid $lg_border_color;
7604: line-height: 2.5em;
1.933 droeschl 7605: overflow: hidden;
1.911 bisitz 7606: margin: 0;
7607: padding: 0;
1.995 raeburn 7608: text-align: left;
1.819 tempelho 7609: }
1.862 bisitz 7610:
1.1098 bisitz 7611: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7612: clear:both;
7613: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7614: border: 1px solid $sidebg;
1.1098 bisitz 7615: margin: 0 0 10px 0;
1.966 bisitz 7616: padding: 3px;
1.995 raeburn 7617: text-align: left;
1.822 bisitz 7618: }
7619:
1.795 www 7620: .LC_fontsize_medium {
1.911 bisitz 7621: font-size: 85%;
1.705 tempelho 7622: }
7623:
1.795 www 7624: .LC_fontsize_large {
1.911 bisitz 7625: font-size: 120%;
1.705 tempelho 7626: }
7627:
1.346 albertel 7628: .LC_menubuttons_inline_text {
7629: color: $font;
1.698 harmsja 7630: font-size: 90%;
1.701 harmsja 7631: padding-left:3px;
1.346 albertel 7632: }
7633:
1.934 droeschl 7634: .LC_menubuttons_inline_text img{
7635: vertical-align: middle;
7636: }
7637:
1.1051 www 7638: li.LC_menubuttons_inline_text img {
1.951 onken 7639: cursor:pointer;
1.1002 droeschl 7640: text-decoration: none;
1.951 onken 7641: }
7642:
1.526 www 7643: .LC_menubuttons_link {
7644: text-decoration: none;
7645: }
1.795 www 7646:
1.522 albertel 7647: .LC_menubuttons_category {
1.521 www 7648: color: $font;
1.526 www 7649: background: $pgbg;
1.521 www 7650: font-size: larger;
7651: font-weight: bold;
7652: }
7653:
1.346 albertel 7654: td.LC_menubuttons_text {
1.911 bisitz 7655: color: $font;
1.346 albertel 7656: }
1.706 harmsja 7657:
1.346 albertel 7658: .LC_current_location {
7659: background: $tabbg;
7660: }
1.795 www 7661:
1.1286 raeburn 7662: td.LC_zero_height {
7663: line-height: 0;
7664: cellpadding: 0;
7665: }
7666:
1.938 bisitz 7667: table.LC_data_table {
1.347 albertel 7668: border: 1px solid #000000;
1.402 albertel 7669: border-collapse: separate;
1.426 albertel 7670: border-spacing: 1px;
1.610 albertel 7671: background: $pgbg;
1.347 albertel 7672: }
1.795 www 7673:
1.422 albertel 7674: .LC_data_table_dense {
7675: font-size: small;
7676: }
1.795 www 7677:
1.507 raeburn 7678: table.LC_nested_outer {
7679: border: 1px solid #000000;
1.589 raeburn 7680: border-collapse: collapse;
1.803 bisitz 7681: border-spacing: 0;
1.507 raeburn 7682: width: 100%;
7683: }
1.795 www 7684:
1.879 raeburn 7685: table.LC_innerpickbox,
1.507 raeburn 7686: table.LC_nested {
1.803 bisitz 7687: border: none;
1.589 raeburn 7688: border-collapse: collapse;
1.803 bisitz 7689: border-spacing: 0;
1.507 raeburn 7690: width: 100%;
7691: }
1.795 www 7692:
1.911 bisitz 7693: table.LC_data_table tr th,
7694: table.LC_calendar tr th,
1.879 raeburn 7695: table.LC_prior_tries tr th,
7696: table.LC_innerpickbox tr th {
1.349 albertel 7697: font-weight: bold;
7698: background-color: $data_table_head;
1.801 tempelho 7699: color:$fontmenu;
1.701 harmsja 7700: font-size:90%;
1.347 albertel 7701: }
1.795 www 7702:
1.879 raeburn 7703: table.LC_innerpickbox tr th,
7704: table.LC_innerpickbox tr td {
7705: vertical-align: top;
7706: }
7707:
1.711 raeburn 7708: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7709: background-color: #CCCCCC;
1.711 raeburn 7710: font-weight: bold;
7711: text-align: left;
7712: }
1.795 www 7713:
1.912 bisitz 7714: table.LC_data_table tr.LC_odd_row > td {
7715: background-color: $data_table_light;
7716: padding: 2px;
7717: vertical-align: top;
7718: }
7719:
1.809 bisitz 7720: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7721: background-color: $data_table_light;
1.912 bisitz 7722: vertical-align: top;
7723: }
7724:
7725: table.LC_data_table tr.LC_even_row > td {
7726: background-color: $data_table_dark;
1.425 albertel 7727: padding: 2px;
1.900 bisitz 7728: vertical-align: top;
1.347 albertel 7729: }
1.795 www 7730:
1.809 bisitz 7731: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7732: background-color: $data_table_dark;
1.900 bisitz 7733: vertical-align: top;
1.347 albertel 7734: }
1.795 www 7735:
1.425 albertel 7736: table.LC_data_table tr.LC_data_table_highlight td {
7737: background-color: $data_table_darker;
7738: }
1.795 www 7739:
1.639 raeburn 7740: table.LC_data_table tr td.LC_leftcol_header {
7741: background-color: $data_table_head;
7742: font-weight: bold;
7743: }
1.795 www 7744:
1.451 albertel 7745: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7746: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7747: font-weight: bold;
7748: font-style: italic;
7749: text-align: center;
7750: padding: 8px;
1.347 albertel 7751: }
1.795 www 7752:
1.1114 raeburn 7753: table.LC_data_table tr.LC_empty_row td,
7754: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7755: background-color: $sidebg;
7756: }
7757:
7758: table.LC_nested tr.LC_empty_row td {
7759: background-color: #FFFFFF;
7760: }
7761:
1.890 droeschl 7762: table.LC_caption {
7763: }
7764:
1.507 raeburn 7765: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7766: padding: 4ex
7767: }
1.795 www 7768:
1.507 raeburn 7769: table.LC_nested_outer tr th {
7770: font-weight: bold;
1.801 tempelho 7771: color:$fontmenu;
1.507 raeburn 7772: background-color: $data_table_head;
1.701 harmsja 7773: font-size: small;
1.507 raeburn 7774: border-bottom: 1px solid #000000;
7775: }
1.795 www 7776:
1.507 raeburn 7777: table.LC_nested_outer tr td.LC_subheader {
7778: background-color: $data_table_head;
7779: font-weight: bold;
7780: font-size: small;
7781: border-bottom: 1px solid #000000;
7782: text-align: right;
1.451 albertel 7783: }
1.795 www 7784:
1.507 raeburn 7785: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7786: background-color: #CCCCCC;
1.451 albertel 7787: font-weight: bold;
7788: font-size: small;
1.507 raeburn 7789: text-align: center;
7790: }
1.795 www 7791:
1.589 raeburn 7792: table.LC_nested tr.LC_info_row td.LC_left_item,
7793: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7794: text-align: left;
1.451 albertel 7795: }
1.795 www 7796:
1.507 raeburn 7797: table.LC_nested td {
1.735 bisitz 7798: background-color: #FFFFFF;
1.451 albertel 7799: font-size: small;
1.507 raeburn 7800: }
1.795 www 7801:
1.507 raeburn 7802: table.LC_nested_outer tr th.LC_right_item,
7803: table.LC_nested tr.LC_info_row td.LC_right_item,
7804: table.LC_nested tr.LC_odd_row td.LC_right_item,
7805: table.LC_nested tr td.LC_right_item {
1.451 albertel 7806: text-align: right;
7807: }
7808:
1.507 raeburn 7809: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7810: background-color: #EEEEEE;
1.451 albertel 7811: }
7812:
1.473 raeburn 7813: table.LC_createuser {
7814: }
7815:
7816: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7817: font-size: small;
1.473 raeburn 7818: }
7819:
7820: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7821: background-color: #CCCCCC;
1.473 raeburn 7822: font-weight: bold;
7823: text-align: center;
7824: }
7825:
1.349 albertel 7826: table.LC_calendar {
7827: border: 1px solid #000000;
7828: border-collapse: collapse;
1.917 raeburn 7829: width: 98%;
1.349 albertel 7830: }
1.795 www 7831:
1.349 albertel 7832: table.LC_calendar_pickdate {
7833: font-size: xx-small;
7834: }
1.795 www 7835:
1.349 albertel 7836: table.LC_calendar tr td {
7837: border: 1px solid #000000;
7838: vertical-align: top;
1.917 raeburn 7839: width: 14%;
1.349 albertel 7840: }
1.795 www 7841:
1.349 albertel 7842: table.LC_calendar tr td.LC_calendar_day_empty {
7843: background-color: $data_table_dark;
7844: }
1.795 www 7845:
1.779 bisitz 7846: table.LC_calendar tr td.LC_calendar_day_current {
7847: background-color: $data_table_highlight;
1.777 tempelho 7848: }
1.795 www 7849:
1.938 bisitz 7850: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7851: background-color: $mail_new;
7852: }
1.795 www 7853:
1.938 bisitz 7854: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7855: background-color: $mail_new_hover;
7856: }
1.795 www 7857:
1.938 bisitz 7858: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7859: background-color: $mail_read;
7860: }
1.795 www 7861:
1.938 bisitz 7862: /*
7863: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7864: background-color: $mail_read_hover;
7865: }
1.938 bisitz 7866: */
1.795 www 7867:
1.938 bisitz 7868: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7869: background-color: $mail_replied;
7870: }
1.795 www 7871:
1.938 bisitz 7872: /*
7873: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7874: background-color: $mail_replied_hover;
7875: }
1.938 bisitz 7876: */
1.795 www 7877:
1.938 bisitz 7878: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7879: background-color: $mail_other;
7880: }
1.795 www 7881:
1.938 bisitz 7882: /*
7883: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7884: background-color: $mail_other_hover;
7885: }
1.938 bisitz 7886: */
1.494 raeburn 7887:
1.777 tempelho 7888: table.LC_data_table tr > td.LC_browser_file,
7889: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7890: background: #AAEE77;
1.389 albertel 7891: }
1.795 www 7892:
1.777 tempelho 7893: table.LC_data_table tr > td.LC_browser_file_locked,
7894: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7895: background: #FFAA99;
1.387 albertel 7896: }
1.795 www 7897:
1.777 tempelho 7898: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7899: background: #888888;
1.779 bisitz 7900: }
1.795 www 7901:
1.777 tempelho 7902: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7903: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7904: background: #F8F866;
1.777 tempelho 7905: }
1.795 www 7906:
1.696 bisitz 7907: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7908: background: #E0E8FF;
1.387 albertel 7909: }
1.696 bisitz 7910:
1.707 bisitz 7911: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7912: /* background: #77FF77; */
1.707 bisitz 7913: }
1.795 www 7914:
1.707 bisitz 7915: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7916: border-right: 8px solid #FFFF77;
1.707 bisitz 7917: }
1.795 www 7918:
1.707 bisitz 7919: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7920: border-right: 8px solid #FFAA77;
1.707 bisitz 7921: }
1.795 www 7922:
1.707 bisitz 7923: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7924: border-right: 8px solid #FF7777;
1.707 bisitz 7925: }
1.795 www 7926:
1.707 bisitz 7927: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7928: border-right: 8px solid #AAFF77;
1.707 bisitz 7929: }
1.795 www 7930:
1.707 bisitz 7931: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7932: border-right: 8px solid #11CC55;
1.707 bisitz 7933: }
7934:
1.388 albertel 7935: span.LC_current_location {
1.701 harmsja 7936: font-size:larger;
1.388 albertel 7937: background: $pgbg;
7938: }
1.387 albertel 7939:
1.1029 www 7940: span.LC_current_nav_location {
7941: font-weight:bold;
7942: background: $sidebg;
7943: }
7944:
1.395 albertel 7945: span.LC_parm_menu_item {
7946: font-size: larger;
7947: }
1.795 www 7948:
1.395 albertel 7949: span.LC_parm_scope_all {
7950: color: red;
7951: }
1.795 www 7952:
1.395 albertel 7953: span.LC_parm_scope_folder {
7954: color: green;
7955: }
1.795 www 7956:
1.395 albertel 7957: span.LC_parm_scope_resource {
7958: color: orange;
7959: }
1.795 www 7960:
1.395 albertel 7961: span.LC_parm_part {
7962: color: blue;
7963: }
1.795 www 7964:
1.911 bisitz 7965: span.LC_parm_folder,
7966: span.LC_parm_symb {
1.395 albertel 7967: font-size: x-small;
7968: font-family: $mono;
7969: color: #AAAAAA;
7970: }
7971:
1.977 bisitz 7972: ul.LC_parm_parmlist li {
7973: display: inline-block;
7974: padding: 0.3em 0.8em;
7975: vertical-align: top;
7976: width: 150px;
7977: border-top:1px solid $lg_border_color;
7978: }
7979:
1.795 www 7980: td.LC_parm_overview_level_menu,
7981: td.LC_parm_overview_map_menu,
7982: td.LC_parm_overview_parm_selectors,
7983: td.LC_parm_overview_restrictions {
1.396 albertel 7984: border: 1px solid black;
7985: border-collapse: collapse;
7986: }
1.795 www 7987:
1.1285 raeburn 7988: span.LC_parm_recursive,
7989: td.LC_parm_recursive {
7990: font-weight: bold;
7991: font-size: smaller;
7992: }
7993:
1.396 albertel 7994: table.LC_parm_overview_restrictions td {
7995: border-width: 1px 4px 1px 4px;
7996: border-style: solid;
7997: border-color: $pgbg;
7998: text-align: center;
7999: }
1.795 www 8000:
1.396 albertel 8001: table.LC_parm_overview_restrictions th {
8002: background: $tabbg;
8003: border-width: 1px 4px 1px 4px;
8004: border-style: solid;
8005: border-color: $pgbg;
8006: }
1.795 www 8007:
1.1459 raeburn 8008: h1.LC_helpmenu {
8009: display: inline;
8010: font-size: 100%;
8011: font-weight: normal;
8012: line-height: 1em;
8013: margin: 0;
8014: padding: 0;
8015: border: 0;
1.398 albertel 8016: }
1.795 www 8017:
1.1456 raeburn 8018: .LC_helpdesk_headbox {
8019: border: 2px groove threedface;
8020: padding: 1em;
8021: }
8022:
8023: h1.LC_helpdesk_legend {
8024: float: left;
8025: margin: -1.7em 0 0;
8026: padding: 0 .5em;
1.397 albertel 8027: background: $pgbg;
1.1456 raeburn 8028: font-size: 1em;
8029: font-weight: bold;
8030: }
8031:
8032: h1.LC_helpdesk_title {
8033: display: inline;
8034: font-size: 1em;
8035: line-height: 2.5em;
8036: margin: 0;
1.803 bisitz 8037: padding: 0;
1.1456 raeburn 8038: vertical-align: bottom;
1.397 albertel 8039: }
1.795 www 8040:
1.1456 raeburn 8041: .LC_helpdesk_links {
8042: border: 1px solid black;
8043: padding: 3px;
1.397 albertel 8044: background: $tabbg;
1.399 albertel 8045: text-align: center;
8046: font-weight: bold;
1.1456 raeburn 8047: display: inline;
8048: margin-right: -6px;
8049: }
8050:
8051: .LC_helpdesk_img,
8052: .LC_helpdesk_text {
8053: padding: 0;
8054: margin: 0;
8055: border: 0;
8056: display: inline;
1.397 albertel 8057: }
1.396 albertel 8058:
1.1456 raeburn 8059: .LC_helpdesk_img a:link,
8060: .LC_helpdesk_img a:visited,
8061: .LC_helpdesk_img a:active,
8062: .LC_helpdesk_text a:link,
8063: .LC_helpdesk_text a:visited,
8064: .LC_helpdesk_text a:active {
1.397 albertel 8065: text-decoration: none;
8066: color: $font;
8067: }
1.795 www 8068:
1.1456 raeburn 8069: div.LC_helpdesk_text a:hover {
1.397 albertel 8070: text-decoration: underline;
8071: color: $vlink;
8072: }
1.396 albertel 8073:
1.417 albertel 8074: .LC_chrt_popup_exists {
8075: border: 1px solid #339933;
8076: margin: -1px;
8077: }
1.795 www 8078:
1.417 albertel 8079: .LC_chrt_popup_up {
8080: border: 1px solid yellow;
8081: margin: -1px;
8082: }
1.795 www 8083:
1.417 albertel 8084: .LC_chrt_popup {
8085: border: 1px solid #8888FF;
8086: background: #CCCCFF;
8087: }
1.795 www 8088:
1.421 albertel 8089: table.LC_pick_box {
8090: border-collapse: separate;
8091: background: white;
8092: border: 1px solid black;
8093: border-spacing: 1px;
8094: }
1.795 www 8095:
1.1454 raeburn 8096: table.LC_pick_box th.LC_pick_box_title {
1.850 bisitz 8097: background: $sidebg;
1.421 albertel 8098: font-weight: bold;
1.900 bisitz 8099: text-align: left;
1.740 bisitz 8100: vertical-align: top;
1.421 albertel 8101: width: 184px;
8102: padding: 8px;
8103: }
1.795 www 8104:
1.579 raeburn 8105: table.LC_pick_box td.LC_pick_box_value {
8106: text-align: left;
8107: padding: 8px;
8108: }
1.795 www 8109:
1.579 raeburn 8110: table.LC_pick_box td.LC_pick_box_select {
8111: text-align: left;
8112: padding: 8px;
8113: }
1.795 www 8114:
1.424 albertel 8115: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8116: padding: 0;
1.421 albertel 8117: height: 1px;
8118: background: black;
8119: }
1.795 www 8120:
1.421 albertel 8121: table.LC_pick_box td.LC_pick_box_submit {
8122: text-align: right;
8123: }
1.795 www 8124:
1.579 raeburn 8125: table.LC_pick_box td.LC_evenrow_value {
8126: text-align: left;
8127: padding: 8px;
8128: background-color: $data_table_light;
8129: }
1.795 www 8130:
1.579 raeburn 8131: table.LC_pick_box td.LC_oddrow_value {
8132: text-align: left;
8133: padding: 8px;
8134: background-color: $data_table_light;
8135: }
1.795 www 8136:
1.579 raeburn 8137: span.LC_helpform_receipt_cat {
8138: font-weight: bold;
8139: }
1.795 www 8140:
1.424 albertel 8141: table.LC_group_priv_box {
8142: background: white;
8143: border: 1px solid black;
8144: border-spacing: 1px;
8145: }
1.795 www 8146:
1.424 albertel 8147: table.LC_group_priv_box td.LC_pick_box_title {
8148: background: $tabbg;
8149: font-weight: bold;
8150: text-align: right;
8151: width: 184px;
8152: }
1.795 www 8153:
1.424 albertel 8154: table.LC_group_priv_box td.LC_groups_fixed {
8155: background: $data_table_light;
8156: text-align: center;
8157: }
1.795 www 8158:
1.424 albertel 8159: table.LC_group_priv_box td.LC_groups_optional {
8160: background: $data_table_dark;
8161: text-align: center;
8162: }
1.795 www 8163:
1.424 albertel 8164: table.LC_group_priv_box td.LC_groups_functionality {
8165: background: $data_table_darker;
8166: text-align: center;
8167: font-weight: bold;
8168: }
1.795 www 8169:
1.424 albertel 8170: table.LC_group_priv td {
8171: text-align: left;
1.803 bisitz 8172: padding: 0;
1.424 albertel 8173: }
8174:
8175: .LC_navbuttons {
8176: margin: 2ex 0ex 2ex 0ex;
8177: }
1.795 www 8178:
1.423 albertel 8179: .LC_topic_bar {
8180: font-weight: bold;
8181: background: $tabbg;
1.918 wenzelju 8182: margin: 1em 0em 1em 2em;
1.805 bisitz 8183: padding: 3px;
1.918 wenzelju 8184: font-size: 1.2em;
1.423 albertel 8185: }
1.795 www 8186:
1.423 albertel 8187: .LC_topic_bar span {
1.918 wenzelju 8188: left: 0.5em;
8189: position: absolute;
1.423 albertel 8190: vertical-align: middle;
1.918 wenzelju 8191: font-size: 1.2em;
1.423 albertel 8192: }
1.795 www 8193:
1.423 albertel 8194: table.LC_course_group_status {
8195: margin: 20px;
8196: }
1.795 www 8197:
1.423 albertel 8198: table.LC_status_selector td {
8199: vertical-align: top;
8200: text-align: center;
1.424 albertel 8201: padding: 4px;
8202: }
1.795 www 8203:
1.599 albertel 8204: div.LC_feedback_link {
1.616 albertel 8205: clear: both;
1.829 kalberla 8206: background: $sidebg;
1.779 bisitz 8207: width: 100%;
1.829 kalberla 8208: padding-bottom: 10px;
8209: border: 1px $tabbg solid;
1.833 kalberla 8210: height: 22px;
8211: line-height: 22px;
8212: padding-top: 5px;
8213: }
8214:
8215: div.LC_feedback_link img {
8216: height: 22px;
1.867 kalberla 8217: vertical-align:middle;
1.829 kalberla 8218: }
8219:
1.911 bisitz 8220: div.LC_feedback_link a {
1.829 kalberla 8221: text-decoration: none;
1.489 raeburn 8222: }
1.795 www 8223:
1.867 kalberla 8224: div.LC_comblock {
1.911 bisitz 8225: display:inline;
1.867 kalberla 8226: color:$font;
8227: font-size:90%;
8228: }
8229:
8230: div.LC_feedback_link div.LC_comblock {
8231: padding-left:5px;
8232: }
8233:
8234: div.LC_feedback_link div.LC_comblock a {
8235: color:$font;
8236: }
8237:
1.489 raeburn 8238: span.LC_feedback_link {
1.858 bisitz 8239: /* background: $feedback_link_bg; */
1.599 albertel 8240: font-size: larger;
8241: }
1.795 www 8242:
1.599 albertel 8243: span.LC_message_link {
1.858 bisitz 8244: /* background: $feedback_link_bg; */
1.599 albertel 8245: font-size: larger;
8246: position: absolute;
8247: right: 1em;
1.489 raeburn 8248: }
1.421 albertel 8249:
1.515 albertel 8250: table.LC_prior_tries {
1.524 albertel 8251: border: 1px solid #000000;
8252: border-collapse: separate;
8253: border-spacing: 1px;
1.515 albertel 8254: }
1.523 albertel 8255:
1.515 albertel 8256: table.LC_prior_tries td {
1.524 albertel 8257: padding: 2px;
1.515 albertel 8258: }
1.523 albertel 8259:
8260: .LC_answer_correct {
1.795 www 8261: background: lightgreen;
8262: color: darkgreen;
8263: padding: 6px;
1.523 albertel 8264: }
1.795 www 8265:
1.523 albertel 8266: .LC_answer_charged_try {
1.797 www 8267: background: #FFAAAA;
1.795 www 8268: color: darkred;
8269: padding: 6px;
1.523 albertel 8270: }
1.795 www 8271:
1.779 bisitz 8272: .LC_answer_not_charged_try,
1.523 albertel 8273: .LC_answer_no_grade,
8274: .LC_answer_late {
1.795 www 8275: background: lightyellow;
1.523 albertel 8276: color: black;
1.795 www 8277: padding: 6px;
1.523 albertel 8278: }
1.795 www 8279:
1.523 albertel 8280: .LC_answer_previous {
1.795 www 8281: background: lightblue;
8282: color: darkblue;
8283: padding: 6px;
1.523 albertel 8284: }
1.795 www 8285:
1.779 bisitz 8286: .LC_answer_no_message {
1.777 tempelho 8287: background: #FFFFFF;
8288: color: black;
1.795 www 8289: padding: 6px;
1.779 bisitz 8290: }
1.795 www 8291:
1.1334 raeburn 8292: .LC_answer_unknown,
8293: .LC_answer_warning {
1.779 bisitz 8294: background: orange;
8295: color: black;
1.795 www 8296: padding: 6px;
1.777 tempelho 8297: }
1.795 www 8298:
1.1446 raeburn 8299: .LC_prob_status {
1.1447 raeburn 8300: margin-top: 5px;
1.1446 raeburn 8301: padding-top: 0;
8302: padding-left: 0;
8303: padding-bottom: 0;
8304: padding-right: 5px;
8305: }
8306:
1.1448 raeburn 8307: .LC_mail_actions {
8308: float: left;
8309: padding: 0;
8310: margin: 6px;
8311: }
8312:
8313: .LC_vertical_line {
8314: width: 1px;
8315: background-color: black;
8316: height: 4em;
8317: float: left;
8318: margin: 0;
8319: padding: 0;
8320: }
8321:
1.529 albertel 8322: span.LC_prior_numerical,
8323: span.LC_prior_string,
8324: span.LC_prior_custom,
8325: span.LC_prior_reaction,
8326: span.LC_prior_math {
1.925 bisitz 8327: font-family: $mono;
1.523 albertel 8328: white-space: pre;
8329: }
8330:
1.525 albertel 8331: span.LC_prior_string {
1.925 bisitz 8332: font-family: $mono;
1.525 albertel 8333: white-space: pre;
8334: }
8335:
1.523 albertel 8336: table.LC_prior_option {
8337: width: 100%;
8338: border-collapse: collapse;
8339: }
1.795 www 8340:
1.911 bisitz 8341: table.LC_prior_rank,
1.795 www 8342: table.LC_prior_match {
1.528 albertel 8343: border-collapse: collapse;
8344: }
1.795 www 8345:
1.528 albertel 8346: table.LC_prior_option tr td,
8347: table.LC_prior_rank tr td,
8348: table.LC_prior_match tr td {
1.524 albertel 8349: border: 1px solid #000000;
1.515 albertel 8350: }
8351:
1.855 bisitz 8352: .LC_nobreak {
1.544 albertel 8353: white-space: nowrap;
1.519 raeburn 8354: }
8355:
1.576 raeburn 8356: span.LC_cusr_emph {
8357: font-style: italic;
8358: }
8359:
1.633 raeburn 8360: span.LC_cusr_subheading {
8361: font-weight: normal;
8362: font-size: 85%;
8363: }
8364:
1.861 bisitz 8365: div.LC_docs_entry_move {
1.859 bisitz 8366: border: 1px solid #BBBBBB;
1.545 albertel 8367: background: #DDDDDD;
1.861 bisitz 8368: width: 22px;
1.859 bisitz 8369: padding: 1px;
8370: margin: 0;
1.545 albertel 8371: }
8372:
1.861 bisitz 8373: table.LC_data_table tr > td.LC_docs_entry_commands,
8374: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8375: font-size: x-small;
8376: }
1.795 www 8377:
1.861 bisitz 8378: .LC_docs_entry_parameter {
8379: white-space: nowrap;
8380: }
8381:
1.544 albertel 8382: .LC_docs_copy {
1.545 albertel 8383: color: #000099;
1.544 albertel 8384: }
1.795 www 8385:
1.544 albertel 8386: .LC_docs_cut {
1.545 albertel 8387: color: #550044;
1.544 albertel 8388: }
1.795 www 8389:
1.544 albertel 8390: .LC_docs_rename {
1.545 albertel 8391: color: #009900;
1.544 albertel 8392: }
1.795 www 8393:
1.544 albertel 8394: .LC_docs_remove {
1.545 albertel 8395: color: #990000;
8396: }
8397:
1.1284 raeburn 8398: .LC_docs_alias {
8399: color: #440055;
8400: }
8401:
1.1286 raeburn 8402: .LC_domprefs_email,
1.1284 raeburn 8403: .LC_docs_alias_name,
1.547 albertel 8404: .LC_docs_reinit_warn,
8405: .LC_docs_ext_edit {
8406: font-size: x-small;
8407: }
8408:
1.545 albertel 8409: table.LC_docs_adddocs td,
8410: table.LC_docs_adddocs th {
8411: border: 1px solid #BBBBBB;
8412: padding: 4px;
8413: background: #DDDDDD;
1.543 albertel 8414: }
8415:
1.584 albertel 8416: table.LC_sty_begin {
8417: background: #BBFFBB;
8418: }
1.795 www 8419:
1.584 albertel 8420: table.LC_sty_end {
8421: background: #FFBBBB;
8422: }
8423:
1.589 raeburn 8424: table.LC_double_column {
1.803 bisitz 8425: border-width: 0;
1.589 raeburn 8426: border-collapse: collapse;
8427: width: 100%;
8428: padding: 2px;
8429: }
8430:
8431: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8432: top: 2px;
1.589 raeburn 8433: left: 2px;
8434: width: 47%;
8435: vertical-align: top;
8436: }
8437:
8438: table.LC_double_column tr td.LC_right_col {
8439: top: 2px;
1.779 bisitz 8440: right: 2px;
1.589 raeburn 8441: width: 47%;
8442: vertical-align: top;
8443: }
8444:
1.591 raeburn 8445: div.LC_left_float {
8446: float: left;
8447: padding-right: 5%;
1.597 albertel 8448: padding-bottom: 4px;
1.591 raeburn 8449: }
8450:
8451: div.LC_clear_float_header {
1.597 albertel 8452: padding-bottom: 2px;
1.591 raeburn 8453: }
8454:
8455: div.LC_clear_float_footer {
1.597 albertel 8456: padding-top: 10px;
1.591 raeburn 8457: clear: both;
8458: }
8459:
1.597 albertel 8460: div.LC_grade_show_user {
1.941 bisitz 8461: /* border-left: 5px solid $sidebg; */
8462: border-top: 5px solid #000000;
8463: margin: 50px 0 0 0;
1.936 bisitz 8464: padding: 15px 0 5px 10px;
1.597 albertel 8465: }
1.795 www 8466:
1.936 bisitz 8467: div.LC_grade_show_user_odd_row {
1.941 bisitz 8468: /* border-left: 5px solid #000000; */
8469: }
8470:
8471: div.LC_grade_show_user div.LC_Box {
8472: margin-right: 50px;
1.597 albertel 8473: }
8474:
8475: div.LC_grade_submissions,
8476: div.LC_grade_message_center,
1.936 bisitz 8477: div.LC_grade_info_links {
1.597 albertel 8478: margin: 5px;
8479: width: 99%;
8480: background: #FFFFFF;
8481: }
1.795 www 8482:
1.597 albertel 8483: div.LC_grade_submissions_header,
1.936 bisitz 8484: div.LC_grade_message_center_header {
1.705 tempelho 8485: font-weight: bold;
8486: font-size: large;
1.597 albertel 8487: }
1.795 www 8488:
1.597 albertel 8489: div.LC_grade_submissions_body,
1.936 bisitz 8490: div.LC_grade_message_center_body {
1.597 albertel 8491: border: 1px solid black;
8492: width: 99%;
8493: background: #FFFFFF;
8494: }
1.795 www 8495:
1.613 albertel 8496: table.LC_scantron_action {
8497: width: 100%;
8498: }
1.795 www 8499:
1.613 albertel 8500: table.LC_scantron_action tr th {
1.698 harmsja 8501: font-weight:bold;
8502: font-style:normal;
1.613 albertel 8503: }
1.795 www 8504:
1.779 bisitz 8505: .LC_edit_problem_header,
1.614 albertel 8506: div.LC_edit_problem_footer {
1.705 tempelho 8507: font-weight: normal;
8508: font-size: medium;
1.602 albertel 8509: margin: 2px;
1.1060 bisitz 8510: background-color: $sidebg;
1.600 albertel 8511: }
1.795 www 8512:
1.600 albertel 8513: div.LC_edit_problem_header,
1.602 albertel 8514: div.LC_edit_problem_header div,
1.614 albertel 8515: div.LC_edit_problem_footer,
8516: div.LC_edit_problem_footer div,
1.602 albertel 8517: div.LC_edit_problem_editxml_header,
8518: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8519: z-index: 100;
1.600 albertel 8520: }
1.795 www 8521:
1.600 albertel 8522: div.LC_edit_problem_header_title {
1.705 tempelho 8523: font-weight: bold;
8524: font-size: larger;
1.602 albertel 8525: background: $tabbg;
8526: padding: 3px;
1.1060 bisitz 8527: margin: 0 0 5px 0;
1.602 albertel 8528: }
1.795 www 8529:
1.602 albertel 8530: table.LC_edit_problem_header_title {
8531: width: 100%;
1.600 albertel 8532: background: $tabbg;
1.602 albertel 8533: }
8534:
1.1205 golterma 8535: div.LC_edit_actionbar {
8536: background-color: $sidebg;
1.1218 droeschl 8537: margin: 0;
8538: padding: 0;
8539: line-height: 200%;
1.602 albertel 8540: }
1.795 www 8541:
1.1218 droeschl 8542: div.LC_edit_actionbar div{
8543: padding: 0;
8544: margin: 0;
8545: display: inline-block;
1.600 albertel 8546: }
1.795 www 8547:
1.1124 bisitz 8548: .LC_edit_opt {
8549: padding-left: 1em;
8550: white-space: nowrap;
8551: }
8552:
1.1152 golterma 8553: .LC_edit_problem_latexhelper{
8554: text-align: right;
8555: }
8556:
8557: #LC_edit_problem_colorful div{
8558: margin-left: 40px;
8559: }
8560:
1.1205 golterma 8561: #LC_edit_problem_codemirror div{
8562: margin-left: 0px;
8563: }
8564:
1.911 bisitz 8565: img.stift {
1.803 bisitz 8566: border-width: 0;
8567: vertical-align: middle;
1.677 riegler 8568: }
1.680 riegler 8569:
1.1460 ! raeburn 8570: div.LC_mainmenu {
! 8571: margin: 3px 2px 2px 1px;
! 8572: float: left;
1.777 tempelho 8573: }
1.795 www 8574:
1.716 raeburn 8575: div.LC_createcourse {
1.911 bisitz 8576: margin: 10px 10px 10px 10px;
1.716 raeburn 8577: }
8578:
1.917 raeburn 8579: .LC_dccid {
1.1130 raeburn 8580: float: right;
1.917 raeburn 8581: margin: 0.2em 0 0 0;
8582: padding: 0;
8583: font-size: 90%;
8584: display:none;
8585: }
8586:
1.897 wenzelju 8587: ol.LC_primary_menu a:hover,
1.721 harmsja 8588: ol#LC_MenuBreadcrumbs a:hover,
8589: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8590: ul#LC_secondary_menu a:hover,
1.721 harmsja 8591: .LC_FormSectionClearButton input:hover
1.795 www 8592: ul.LC_TabContent li:hover a {
1.952 onken 8593: color:$button_hover;
1.911 bisitz 8594: text-decoration:none;
1.693 droeschl 8595: }
8596:
1.779 bisitz 8597: h1 {
1.911 bisitz 8598: padding: 0;
8599: line-height:130%;
1.693 droeschl 8600: }
1.698 harmsja 8601:
1.911 bisitz 8602: h2,
8603: h3,
8604: h4,
8605: h5,
8606: h6 {
8607: margin: 5px 0 5px 0;
8608: padding: 0;
8609: line-height:130%;
1.693 droeschl 8610: }
1.795 www 8611:
8612: .LC_hcell {
1.911 bisitz 8613: padding:3px 15px 3px 15px;
8614: margin: 0;
8615: background-color:$tabbg;
8616: color:$fontmenu;
8617: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8618: }
1.795 www 8619:
1.840 bisitz 8620: .LC_Box > .LC_hcell {
1.911 bisitz 8621: margin: 0 -10px 10px -10px;
1.835 bisitz 8622: }
8623:
1.721 harmsja 8624: .LC_noBorder {
1.911 bisitz 8625: border: 0;
1.698 harmsja 8626: }
1.693 droeschl 8627:
1.721 harmsja 8628: .LC_FormSectionClearButton input {
1.911 bisitz 8629: background-color:transparent;
8630: border: none;
8631: cursor:pointer;
8632: text-decoration:underline;
1.693 droeschl 8633: }
1.763 bisitz 8634:
8635: .LC_help_open_topic {
1.911 bisitz 8636: color: #FFFFFF;
8637: background-color: #EEEEFF;
8638: margin: 1px;
8639: padding: 4px;
8640: border: 1px solid #000033;
8641: white-space: nowrap;
8642: /* vertical-align: middle; */
1.759 neumanie 8643: }
1.693 droeschl 8644:
1.911 bisitz 8645: dl,
8646: ul,
8647: div,
8648: fieldset {
8649: margin: 10px 10px 10px 0;
8650: /* overflow: hidden; */
1.693 droeschl 8651: }
1.795 www 8652:
1.1404 raeburn 8653: fieldset#LC_selectuser {
1.1460 ! raeburn 8654: margin: -1px 0 0 0;
! 8655: padding: 0;
! 8656: border: 0;
1.1404 raeburn 8657: }
8658:
1.1211 raeburn 8659: article.geogebraweb div {
8660: margin: 0;
8661: }
8662:
1.838 bisitz 8663: fieldset > legend {
1.911 bisitz 8664: font-weight: bold;
8665: padding: 0 5px 0 5px;
1.838 bisitz 8666: }
8667:
1.813 bisitz 8668: #LC_nav_bar {
1.911 bisitz 8669: float: left;
1.995 raeburn 8670: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8671: margin: 0 0 2px 0;
1.807 droeschl 8672: }
8673:
1.916 droeschl 8674: #LC_realm {
8675: margin: 0.2em 0 0 0;
8676: padding: 0;
8677: font-weight: bold;
8678: text-align: center;
1.995 raeburn 8679: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8680: }
8681:
1.911 bisitz 8682: #LC_nav_bar em {
8683: font-weight: bold;
8684: font-style: normal;
1.807 droeschl 8685: }
8686:
1.897 wenzelju 8687: ol.LC_primary_menu {
1.934 droeschl 8688: margin: 0;
1.1076 raeburn 8689: padding: 0;
1.807 droeschl 8690: }
8691:
1.852 droeschl 8692: ol#LC_PathBreadcrumbs {
1.911 bisitz 8693: margin: 0;
1.693 droeschl 8694: }
8695:
1.897 wenzelju 8696: ol.LC_primary_menu li {
1.1076 raeburn 8697: color: RGB(80, 80, 80);
8698: vertical-align: middle;
8699: text-align: left;
8700: list-style: none;
1.1205 golterma 8701: position: relative;
1.1076 raeburn 8702: float: left;
1.1205 golterma 8703: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8704: line-height: 1.5em;
1.1076 raeburn 8705: }
8706:
1.1205 golterma 8707: ol.LC_primary_menu li a,
8708: ol.LC_primary_menu li p {
1.1076 raeburn 8709: display: block;
8710: margin: 0;
8711: padding: 0 5px 0 10px;
8712: text-decoration: none;
8713: }
8714:
1.1205 golterma 8715: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8716: display: inline-block;
8717: width: 95%;
8718: text-align: left;
8719: }
8720:
8721: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8722: display: inline-block;
8723: width: 5%;
8724: float: right;
8725: text-align: right;
8726: font-size: 70%;
8727: }
8728:
8729: ol.LC_primary_menu ul {
1.1076 raeburn 8730: display: none;
1.1205 golterma 8731: width: 15em;
1.1076 raeburn 8732: background-color: $data_table_light;
1.1205 golterma 8733: position: absolute;
8734: top: 100%;
1.1076 raeburn 8735: }
8736:
1.1205 golterma 8737: ol.LC_primary_menu ul ul {
8738: left: 100%;
8739: top: 0;
8740: }
8741:
8742: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8743: display: block;
8744: position: absolute;
8745: margin: 0;
8746: padding: 0;
1.1078 raeburn 8747: z-index: 2;
1.1076 raeburn 8748: }
8749:
8750: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8751: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8752: font-size: 90%;
1.911 bisitz 8753: vertical-align: top;
1.1076 raeburn 8754: float: none;
1.1079 raeburn 8755: border-left: 1px solid black;
8756: border-right: 1px solid black;
1.1205 golterma 8757: /* A dark bottom border to visualize different menu options;
8758: overwritten in the create_submenu routine for the last border-bottom of the menu */
8759: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8760: }
8761:
1.1205 golterma 8762: ol.LC_primary_menu li li p:hover {
8763: color:$button_hover;
8764: text-decoration:none;
8765: background-color:$data_table_dark;
1.1076 raeburn 8766: }
8767:
8768: ol.LC_primary_menu li li a:hover {
8769: color:$button_hover;
8770: background-color:$data_table_dark;
1.693 droeschl 8771: }
8772:
1.1205 golterma 8773: /* Font-size equal to the size of the predecessors*/
8774: ol.LC_primary_menu li:hover li li {
8775: font-size: 100%;
8776: }
8777:
1.897 wenzelju 8778: ol.LC_primary_menu li img {
1.911 bisitz 8779: vertical-align: bottom;
1.934 droeschl 8780: height: 1.1em;
1.1077 raeburn 8781: margin: 0.2em 0 0 0;
1.693 droeschl 8782: }
8783:
1.897 wenzelju 8784: ol.LC_primary_menu a {
1.911 bisitz 8785: color: RGB(80, 80, 80);
8786: text-decoration: none;
1.693 droeschl 8787: }
1.795 www 8788:
1.949 droeschl 8789: ol.LC_primary_menu a.LC_new_message {
8790: font-weight:bold;
8791: color: darkred;
8792: }
8793:
1.975 raeburn 8794: ol.LC_docs_parameters {
8795: margin-left: 0;
8796: padding: 0;
8797: list-style: none;
8798: }
8799:
8800: ol.LC_docs_parameters li {
8801: margin: 0;
8802: padding-right: 20px;
8803: display: inline;
8804: }
8805:
1.976 raeburn 8806: ol.LC_docs_parameters li:before {
8807: content: "\\002022 \\0020";
8808: }
8809:
8810: li.LC_docs_parameters_title {
8811: font-weight: bold;
8812: }
8813:
8814: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8815: content: "";
8816: }
8817:
1.897 wenzelju 8818: ul#LC_secondary_menu {
1.1107 raeburn 8819: clear: right;
1.911 bisitz 8820: color: $fontmenu;
8821: background: $tabbg;
8822: list-style: none;
8823: padding: 0;
8824: margin: 0;
8825: width: 100%;
1.995 raeburn 8826: text-align: left;
1.1107 raeburn 8827: float: left;
1.808 droeschl 8828: }
8829:
1.897 wenzelju 8830: ul#LC_secondary_menu li {
1.911 bisitz 8831: font-weight: bold;
8832: line-height: 1.8em;
1.1107 raeburn 8833: border-right: 1px solid black;
8834: float: left;
8835: }
8836:
8837: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8838: background-color: $data_table_light;
8839: }
8840:
8841: ul#LC_secondary_menu li a {
1.911 bisitz 8842: padding: 0 0.8em;
1.1107 raeburn 8843: }
8844:
8845: ul#LC_secondary_menu li ul {
8846: display: none;
8847: }
8848:
8849: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8850: display: block;
8851: position: absolute;
8852: margin: 0;
8853: padding: 0;
8854: list-style:none;
8855: float: none;
8856: background-color: $data_table_light;
8857: z-index: 2;
8858: margin-left: -1px;
8859: }
8860:
8861: ul#LC_secondary_menu li ul li {
8862: font-size: 90%;
8863: vertical-align: top;
8864: border-left: 1px solid black;
1.911 bisitz 8865: border-right: 1px solid black;
1.1119 raeburn 8866: background-color: $data_table_light;
1.1107 raeburn 8867: list-style:none;
8868: float: none;
8869: }
8870:
8871: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8872: background-color: $data_table_dark;
1.807 droeschl 8873: }
8874:
1.847 tempelho 8875: ul.LC_TabContent {
1.911 bisitz 8876: display:block;
8877: background: $sidebg;
8878: border-bottom: solid 1px $lg_border_color;
8879: list-style:none;
1.1020 raeburn 8880: margin: -1px -10px 0 -10px;
1.911 bisitz 8881: padding: 0;
1.693 droeschl 8882: }
8883:
1.795 www 8884: ul.LC_TabContent li,
8885: ul.LC_TabContentBigger li {
1.911 bisitz 8886: float:left;
1.741 harmsja 8887: }
1.795 www 8888:
1.897 wenzelju 8889: ul#LC_secondary_menu li a {
1.911 bisitz 8890: color: $fontmenu;
8891: text-decoration: none;
1.693 droeschl 8892: }
1.795 www 8893:
1.721 harmsja 8894: ul.LC_TabContent {
1.952 onken 8895: min-height:20px;
1.721 harmsja 8896: }
1.795 www 8897:
8898: ul.LC_TabContent li {
1.911 bisitz 8899: vertical-align:middle;
1.959 onken 8900: padding: 0 16px 0 10px;
1.911 bisitz 8901: background-color:$tabbg;
8902: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8903: border-left: solid 1px $font;
1.721 harmsja 8904: }
1.795 www 8905:
1.847 tempelho 8906: ul.LC_TabContent .right {
1.911 bisitz 8907: float:right;
1.847 tempelho 8908: }
8909:
1.911 bisitz 8910: ul.LC_TabContent li a,
8911: ul.LC_TabContent li {
8912: color:rgb(47,47,47);
8913: text-decoration:none;
8914: font-size:95%;
8915: font-weight:bold;
1.952 onken 8916: min-height:20px;
8917: }
8918:
1.959 onken 8919: ul.LC_TabContent li a:hover,
8920: ul.LC_TabContent li a:focus {
1.952 onken 8921: color: $button_hover;
1.959 onken 8922: background:none;
8923: outline:none;
1.952 onken 8924: }
8925:
8926: ul.LC_TabContent li:hover {
8927: color: $button_hover;
8928: cursor:pointer;
1.721 harmsja 8929: }
1.795 www 8930:
1.911 bisitz 8931: ul.LC_TabContent li.active {
1.952 onken 8932: color: $font;
1.911 bisitz 8933: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8934: border-bottom:solid 1px #FFFFFF;
8935: cursor: default;
1.744 ehlerst 8936: }
1.795 www 8937:
1.959 onken 8938: ul.LC_TabContent li.active a {
8939: color:$font;
8940: background:#FFFFFF;
8941: outline: none;
8942: }
1.1047 raeburn 8943:
8944: ul.LC_TabContent li.goback {
8945: float: left;
8946: border-left: none;
8947: }
8948:
1.870 tempelho 8949: #maincoursedoc {
1.911 bisitz 8950: clear:both;
1.870 tempelho 8951: }
8952:
8953: ul.LC_TabContentBigger {
1.911 bisitz 8954: display:block;
8955: list-style:none;
8956: padding: 0;
1.870 tempelho 8957: }
8958:
1.795 www 8959: ul.LC_TabContentBigger li {
1.911 bisitz 8960: vertical-align:bottom;
8961: height: 30px;
8962: font-size:110%;
8963: font-weight:bold;
8964: color: #737373;
1.841 tempelho 8965: }
8966:
1.957 onken 8967: ul.LC_TabContentBigger li.active {
8968: position: relative;
8969: top: 1px;
8970: }
8971:
1.870 tempelho 8972: ul.LC_TabContentBigger li a {
1.911 bisitz 8973: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8974: height: 30px;
8975: line-height: 30px;
8976: text-align: center;
8977: display: block;
8978: text-decoration: none;
1.958 onken 8979: outline: none;
1.741 harmsja 8980: }
1.795 www 8981:
1.870 tempelho 8982: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8983: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8984: color:$font;
1.744 ehlerst 8985: }
1.795 www 8986:
1.870 tempelho 8987: ul.LC_TabContentBigger li b {
1.911 bisitz 8988: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8989: display: block;
8990: float: left;
8991: padding: 0 30px;
1.957 onken 8992: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8993: }
8994:
1.956 onken 8995: ul.LC_TabContentBigger li:hover b {
8996: color:$button_hover;
8997: }
8998:
1.870 tempelho 8999: ul.LC_TabContentBigger li.active b {
1.911 bisitz 9000: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
9001: color:$font;
1.957 onken 9002: border: 0;
1.741 harmsja 9003: }
1.693 droeschl 9004:
1.870 tempelho 9005:
1.862 bisitz 9006: ul.LC_CourseBreadcrumbs {
9007: background: $sidebg;
1.1020 raeburn 9008: height: 2em;
1.862 bisitz 9009: padding-left: 10px;
1.1020 raeburn 9010: margin: 0;
1.862 bisitz 9011: list-style-position: inside;
9012: }
9013:
1.911 bisitz 9014: ol#LC_MenuBreadcrumbs,
1.862 bisitz 9015: ol#LC_PathBreadcrumbs {
1.911 bisitz 9016: padding-left: 10px;
9017: margin: 0;
1.933 droeschl 9018: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 9019: }
9020:
1.911 bisitz 9021: ol#LC_MenuBreadcrumbs li,
9022: ol#LC_PathBreadcrumbs li,
1.862 bisitz 9023: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 9024: display: inline;
1.933 droeschl 9025: white-space: normal;
1.693 droeschl 9026: }
9027:
1.823 bisitz 9028: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 9029: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 9030: text-decoration: none;
9031: font-size:90%;
1.693 droeschl 9032: }
1.795 www 9033:
1.969 droeschl 9034: ol#LC_MenuBreadcrumbs h1 {
9035: display: inline;
9036: font-size: 90%;
9037: line-height: 2.5em;
9038: margin: 0;
9039: padding: 0;
9040: }
9041:
1.795 www 9042: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 9043: text-decoration:none;
9044: font-size:100%;
9045: font-weight:bold;
1.693 droeschl 9046: }
1.795 www 9047:
1.840 bisitz 9048: .LC_Box {
1.911 bisitz 9049: border: solid 1px $lg_border_color;
9050: padding: 0 10px 10px 10px;
1.746 neumanie 9051: }
1.795 www 9052:
1.1020 raeburn 9053: .LC_DocsBox {
9054: border: solid 1px $lg_border_color;
9055: padding: 0 0 10px 10px;
9056: }
9057:
1.795 www 9058: .LC_AboutMe_Image {
1.911 bisitz 9059: float:left;
9060: margin-right:10px;
1.747 neumanie 9061: }
1.795 www 9062:
9063: .LC_Clear_AboutMe_Image {
1.911 bisitz 9064: clear:left;
1.747 neumanie 9065: }
1.795 www 9066:
1.721 harmsja 9067: dl.LC_ListStyleClean dt {
1.911 bisitz 9068: padding-right: 5px;
9069: display: table-header-group;
1.693 droeschl 9070: }
9071:
1.721 harmsja 9072: dl.LC_ListStyleClean dd {
1.911 bisitz 9073: display: table-row;
1.693 droeschl 9074: }
9075:
1.721 harmsja 9076: .LC_ListStyleClean,
9077: .LC_ListStyleSimple,
9078: .LC_ListStyleNormal,
1.795 www 9079: .LC_ListStyleSpecial {
1.911 bisitz 9080: /* display:block; */
9081: list-style-position: inside;
9082: list-style-type: none;
9083: overflow: hidden;
9084: padding: 0;
1.693 droeschl 9085: }
9086:
1.721 harmsja 9087: .LC_ListStyleSimple li,
9088: .LC_ListStyleSimple dd,
9089: .LC_ListStyleNormal li,
9090: .LC_ListStyleNormal dd,
9091: .LC_ListStyleSpecial li,
1.795 www 9092: .LC_ListStyleSpecial dd {
1.911 bisitz 9093: margin: 0;
9094: padding: 5px 5px 5px 10px;
9095: clear: both;
1.693 droeschl 9096: }
9097:
1.721 harmsja 9098: .LC_ListStyleClean li,
9099: .LC_ListStyleClean dd {
1.911 bisitz 9100: padding-top: 0;
9101: padding-bottom: 0;
1.693 droeschl 9102: }
9103:
1.721 harmsja 9104: .LC_ListStyleSimple dd,
1.795 www 9105: .LC_ListStyleSimple li {
1.911 bisitz 9106: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 9107: }
9108:
1.721 harmsja 9109: .LC_ListStyleSpecial li,
9110: .LC_ListStyleSpecial dd {
1.911 bisitz 9111: list-style-type: none;
9112: background-color: RGB(220, 220, 220);
9113: margin-bottom: 4px;
1.693 droeschl 9114: }
9115:
1.721 harmsja 9116: table.LC_SimpleTable {
1.911 bisitz 9117: margin:5px;
9118: border:solid 1px $lg_border_color;
1.795 www 9119: }
1.693 droeschl 9120:
1.721 harmsja 9121: table.LC_SimpleTable tr {
1.911 bisitz 9122: padding: 0;
9123: border:solid 1px $lg_border_color;
1.693 droeschl 9124: }
1.795 www 9125:
9126: table.LC_SimpleTable thead {
1.911 bisitz 9127: background:rgb(220,220,220);
1.693 droeschl 9128: }
9129:
1.721 harmsja 9130: div.LC_columnSection {
1.911 bisitz 9131: display: block;
9132: clear: both;
9133: overflow: hidden;
9134: margin: 0;
1.693 droeschl 9135: }
9136:
1.721 harmsja 9137: div.LC_columnSection>* {
1.911 bisitz 9138: float: left;
9139: margin: 10px 20px 10px 0;
9140: overflow:hidden;
1.693 droeschl 9141: }
1.721 harmsja 9142:
1.795 www 9143: table em {
1.911 bisitz 9144: font-weight: bold;
9145: font-style: normal;
1.748 schulted 9146: }
1.795 www 9147:
1.779 bisitz 9148: table.LC_tableBrowseRes,
1.795 www 9149: table.LC_tableOfContent {
1.911 bisitz 9150: border:none;
9151: border-spacing: 1px;
9152: padding: 3px;
9153: background-color: #FFFFFF;
9154: font-size: 90%;
1.753 droeschl 9155: }
1.789 droeschl 9156:
1.911 bisitz 9157: table.LC_tableOfContent {
9158: border-collapse: collapse;
1.789 droeschl 9159: }
9160:
1.771 droeschl 9161: table.LC_tableBrowseRes a,
1.768 schulted 9162: table.LC_tableOfContent a {
1.911 bisitz 9163: background-color: transparent;
9164: text-decoration: none;
1.753 droeschl 9165: }
9166:
1.795 www 9167: table.LC_tableOfContent img {
1.911 bisitz 9168: border: none;
9169: height: 1.3em;
9170: vertical-align: text-bottom;
9171: margin-right: 0.3em;
1.753 droeschl 9172: }
1.757 schulted 9173:
1.795 www 9174: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9175: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9176: }
9177:
1.795 www 9178: a#LC_content_toolbar_everything {
1.911 bisitz 9179: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9180: }
9181:
1.795 www 9182: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9183: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9184: }
9185:
1.795 www 9186: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9187: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9188: }
9189:
1.795 www 9190: a#LC_content_toolbar_changefolder {
1.911 bisitz 9191: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9192: }
9193:
1.795 www 9194: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9195: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9196: }
9197:
1.1043 raeburn 9198: a#LC_content_toolbar_edittoplevel {
9199: background-image:url(/res/adm/pages/edittoplevel.gif);
9200: }
9201:
1.1384 raeburn 9202: a#LC_content_toolbar_printout {
9203: background-image:url(/res/adm/pages/printout.gif);
9204: }
9205:
1.795 www 9206: ul#LC_toolbar li a:hover {
1.911 bisitz 9207: background-position: bottom center;
1.757 schulted 9208: }
9209:
1.795 www 9210: ul#LC_toolbar {
1.911 bisitz 9211: padding: 0;
9212: margin: 2px;
9213: list-style:none;
1.1449 raeburn 9214: display:inline;
1.911 bisitz 9215: background-color:white;
1.1082 raeburn 9216: overflow: auto;
1.757 schulted 9217: }
9218:
1.795 www 9219: ul#LC_toolbar li {
1.911 bisitz 9220: border:1px solid white;
9221: padding: 0;
9222: margin: 0;
9223: float: left;
9224: display:inline;
9225: vertical-align:middle;
1.1082 raeburn 9226: white-space: nowrap;
1.911 bisitz 9227: }
1.757 schulted 9228:
1.783 amueller 9229:
1.795 www 9230: a.LC_toolbarItem {
1.911 bisitz 9231: display:block;
9232: padding: 0;
9233: margin: 0;
9234: height: 32px;
9235: width: 32px;
9236: color:white;
9237: border: none;
9238: background-repeat:no-repeat;
9239: background-color:transparent;
1.757 schulted 9240: }
9241:
1.1449 raeburn 9242: .LC_navtools {
9243: display: inline-block;
9244: padding: 0;
9245: margin: 2px;
9246: vertical-align: middle;
9247: }
9248:
1.915 droeschl 9249: ul.LC_funclist {
9250: margin: 0;
9251: padding: 0.5em 1em 0.5em 0;
9252: }
9253:
1.933 droeschl 9254: ul.LC_funclist > li:first-child {
9255: font-weight:bold;
9256: margin-left:0.8em;
9257: }
9258:
1.915 droeschl 9259: ul.LC_funclist + ul.LC_funclist {
9260: /*
9261: left border as a seperator if we have more than
9262: one list
9263: */
9264: border-left: 1px solid $sidebg;
9265: /*
9266: this hides the left border behind the border of the
9267: outer box if element is wrapped to the next 'line'
9268: */
9269: margin-left: -1px;
9270: }
9271:
1.843 bisitz 9272: ul.LC_funclist li {
1.915 droeschl 9273: display: inline;
1.782 bisitz 9274: white-space: nowrap;
1.915 droeschl 9275: margin: 0 0 0 25px;
9276: line-height: 150%;
1.782 bisitz 9277: }
9278:
1.974 wenzelju 9279: .LC_hidden {
9280: display: none;
9281: }
9282:
1.1030 www 9283: .LCmodal-overlay {
9284: position:fixed;
9285: top:0;
9286: right:0;
9287: bottom:0;
9288: left:0;
9289: height:100%;
9290: width:100%;
9291: margin:0;
9292: padding:0;
9293: background:#999;
9294: opacity:.75;
9295: filter: alpha(opacity=75);
9296: -moz-opacity: 0.75;
9297: z-index:101;
9298: }
9299:
9300: * html .LCmodal-overlay {
9301: position: absolute;
9302: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9303: }
9304:
9305: .LCmodal-window {
9306: position:fixed;
9307: top:50%;
9308: left:50%;
9309: margin:0;
9310: padding:0;
9311: z-index:102;
9312: }
9313:
9314: * html .LCmodal-window {
9315: position:absolute;
9316: }
9317:
9318: .LCclose-window {
9319: position:absolute;
9320: width:32px;
9321: height:32px;
9322: right:8px;
9323: top:8px;
9324: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9325: text-indent:-99999px;
9326: overflow:hidden;
9327: cursor:pointer;
9328: }
9329:
1.1369 raeburn 9330: .LCisDisabled {
9331: cursor: not-allowed;
9332: opacity: 0.5;
9333: }
9334:
9335: a[aria-disabled="true"] {
9336: color: currentColor;
9337: display: inline-block; /* For IE11/ MS Edge bug */
9338: pointer-events: none;
9339: text-decoration: none;
9340: }
9341:
1.1335 raeburn 9342: pre.LC_wordwrap {
9343: white-space: pre-wrap;
9344: white-space: -moz-pre-wrap;
9345: white-space: -pre-wrap;
9346: white-space: -o-pre-wrap;
9347: word-wrap: break-word;
9348: }
9349:
1.1100 raeburn 9350: /*
1.1231 damieng 9351: styles used for response display
9352: */
9353: div.LC_radiofoil, div.LC_rankfoil {
9354: margin: .5em 0em .5em 0em;
9355: }
9356: table.LC_itemgroup {
9357: margin-top: 1em;
9358: }
9359:
9360: /*
1.1100 raeburn 9361: styles used by TTH when "Default set of options to pass to tth/m
9362: when converting TeX" in course settings has been set
9363:
9364: option passed: -t
9365:
9366: */
9367:
9368: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9369: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9370: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9371: td div.norm {line-height:normal;}
9372:
9373: /*
9374: option passed -y3
9375: */
9376:
9377: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9378: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9379: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9380:
1.1230 damieng 9381: /*
9382: sections with roles, for content only
9383: */
9384: section[class^="role-"] {
9385: padding-left: 10px;
9386: padding-right: 5px;
9387: margin-top: 8px;
9388: margin-bottom: 8px;
9389: border: 1px solid #2A4;
9390: border-radius: 5px;
9391: box-shadow: 0px 1px 1px #BBB;
9392: }
9393: section[class^="role-"]>h1 {
9394: position: relative;
9395: margin: 0px;
9396: padding-top: 10px;
9397: padding-left: 40px;
9398: }
9399: section[class^="role-"]>h1:before {
9400: position: absolute;
9401: left: -5px;
9402: top: 5px;
9403: }
9404: section.role-activity>h1:before {
9405: content:url('/adm/daxe/images/section_icons/activity.png');
9406: }
9407: section.role-advice>h1:before {
9408: content:url('/adm/daxe/images/section_icons/advice.png');
9409: }
9410: section.role-bibliography>h1:before {
9411: content:url('/adm/daxe/images/section_icons/bibliography.png');
9412: }
9413: section.role-citation>h1:before {
9414: content:url('/adm/daxe/images/section_icons/citation.png');
9415: }
9416: section.role-conclusion>h1:before {
9417: content:url('/adm/daxe/images/section_icons/conclusion.png');
9418: }
9419: section.role-definition>h1:before {
9420: content:url('/adm/daxe/images/section_icons/definition.png');
9421: }
9422: section.role-demonstration>h1:before {
9423: content:url('/adm/daxe/images/section_icons/demonstration.png');
9424: }
9425: section.role-example>h1:before {
9426: content:url('/adm/daxe/images/section_icons/example.png');
9427: }
9428: section.role-explanation>h1:before {
9429: content:url('/adm/daxe/images/section_icons/explanation.png');
9430: }
9431: section.role-introduction>h1:before {
9432: content:url('/adm/daxe/images/section_icons/introduction.png');
9433: }
9434: section.role-method>h1:before {
9435: content:url('/adm/daxe/images/section_icons/method.png');
9436: }
9437: section.role-more_information>h1:before {
9438: content:url('/adm/daxe/images/section_icons/more_information.png');
9439: }
9440: section.role-objectives>h1:before {
9441: content:url('/adm/daxe/images/section_icons/objectives.png');
9442: }
9443: section.role-prerequisites>h1:before {
9444: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9445: }
9446: section.role-remark>h1:before {
9447: content:url('/adm/daxe/images/section_icons/remark.png');
9448: }
9449: section.role-reminder>h1:before {
9450: content:url('/adm/daxe/images/section_icons/reminder.png');
9451: }
9452: section.role-summary>h1:before {
9453: content:url('/adm/daxe/images/section_icons/summary.png');
9454: }
9455: section.role-syntax>h1:before {
9456: content:url('/adm/daxe/images/section_icons/syntax.png');
9457: }
9458: section.role-warning>h1:before {
9459: content:url('/adm/daxe/images/section_icons/warning.png');
9460: }
9461:
1.1269 raeburn 9462: #LC_minitab_header {
9463: float:left;
9464: width:100%;
9465: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9466: font-size:93%;
9467: line-height:normal;
9468: margin: 0.5em 0 0.5em 0;
9469: }
9470: #LC_minitab_header ul {
9471: margin:0;
9472: padding:10px 10px 0;
9473: list-style:none;
9474: }
9475: #LC_minitab_header li {
9476: float:left;
9477: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9478: margin:0;
9479: padding:0 0 0 9px;
9480: }
9481: #LC_minitab_header a {
9482: display:block;
9483: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9484: padding:5px 15px 4px 6px;
9485: }
9486: #LC_minitab_header #LC_current_minitab {
9487: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9488: }
9489: #LC_minitab_header #LC_current_minitab a {
9490: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9491: padding-bottom:5px;
9492: }
9493:
9494:
1.343 albertel 9495: END
9496: }
9497:
1.306 albertel 9498: =pod
9499:
9500: =item * &headtag()
9501:
9502: Returns a uniform footer for LON-CAPA web pages.
9503:
1.307 albertel 9504: Inputs: $title - optional title for the head
9505: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9506: $args - optional arguments
1.319 albertel 9507: force_register - if is true call registerurl so the remote is
9508: informed
1.415 albertel 9509: redirect -> array ref of
9510: 1- seconds before redirect occurs
9511: 2- url to redirect to
9512: 3- whether the side effect should occur
1.315 albertel 9513: (side effect of setting
9514: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9515: redirected to)
9516: 4- whether the redirect target should be
9517: the opener of the current (pop-up)
9518: window (side effect of setting
9519: $env{'internal.head.to_opener'} to
9520: 1, if true.
1.1388 raeburn 9521: 5- whether encrypt check should be skipped
1.352 albertel 9522: domain -> force to color decorate a page for a specific
9523: domain
9524: function -> force usage of a specific rolish color scheme
9525: bgcolor -> override the default page bgcolor
1.460 albertel 9526: no_auto_mt_title
9527: -> prevent &mt()ing the title arg
1.464 albertel 9528:
1.306 albertel 9529: =cut
9530:
9531: sub headtag {
1.313 albertel 9532: my ($title,$head_extra,$args) = @_;
1.306 albertel 9533:
1.363 albertel 9534: my $function = $args->{'function'} || &get_users_function();
9535: my $domain = $args->{'domain'} || &determinedomain();
9536: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9537: my $httphost = $args->{'use_absolute'};
1.418 albertel 9538: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9539: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9540: #time(),
1.418 albertel 9541: $env{'environment.color.timestamp'},
1.363 albertel 9542: $function,$domain,$bgcolor);
9543:
1.369 www 9544: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9545:
1.308 albertel 9546: my $result =
9547: '<head>'.
1.1160 raeburn 9548: &font_settings($args);
1.319 albertel 9549:
1.1188 raeburn 9550: my $inhibitprint;
9551: if ($args->{'print_suppress'}) {
9552: $inhibitprint = &print_suppression();
9553: }
1.1064 raeburn 9554:
1.1439 raeburn 9555: if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461 albertel 9556: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9557: }
1.962 droeschl 9558: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9559: $result .= Apache::lonxml::display_title();
1.319 albertel 9560: }
1.436 albertel 9561: if (!$args->{'no_nav_bar'}
9562: && !$args->{'only_body'}
1.1438 raeburn 9563: && !$args->{'frameset'}
9564: && !$args->{'switchserver'}) {
1.1154 raeburn 9565: $result .= &help_menu_js($httphost);
1.1032 www 9566: $result.=&modal_window();
1.1038 www 9567: $result.=&togglebox_script();
1.1034 www 9568: $result.=&wishlist_window();
1.1041 www 9569: $result.=&LCprogressbarUpdate_script();
1.1034 www 9570: } else {
9571: if ($args->{'add_modal'}) {
9572: $result.=&modal_window();
9573: }
9574: if ($args->{'add_wishlist'}) {
9575: $result.=&wishlist_window();
9576: }
1.1038 www 9577: if ($args->{'add_togglebox'}) {
9578: $result.=&togglebox_script();
9579: }
1.1041 www 9580: if ($args->{'add_progressbar'}) {
9581: $result.=&LCprogressbarUpdate_script();
9582: }
1.436 albertel 9583: }
1.314 albertel 9584: if (ref($args->{'redirect'})) {
1.1388 raeburn 9585: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9586: if (!$skip_enc_check) {
9587: $url = &Apache::lonenc::check_encrypt($url);
9588: }
1.414 albertel 9589: if (!$inhibit_continue) {
9590: $env{'internal.head.redirect'} = $url;
9591: }
1.1386 raeburn 9592: $result.=<<"ADDMETA";
1.313 albertel 9593: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9594: ADDMETA
9595: if ($to_opener) {
9596: $env{'internal.head.to_opener'} = 1;
9597: my $dest = &js_escape($url);
9598: my $timeout = int($time * 1000);
9599: $result .=<<"ENDJS";
9600: <script type="text/javascript">
9601: // <![CDATA[
9602: function LC_To_Opener() {
9603: var dest = '$dest';
9604: if (dest != '') {
9605: if (window.opener != null && !window.opener.closed) {
9606: window.opener.location.href=dest;
9607: window.close();
9608: } else {
9609: window.location.href=dest;
9610: }
9611: }
9612: }
9613: \$(document).ready(function () {
9614: setTimeout('LC_To_Opener()',$timeout);
9615: });
9616: // ]]>
9617: </script>
9618: ENDJS
9619: } else {
9620: $result.=<<"ADDMETA";
1.344 albertel 9621: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9622: ADDMETA
1.1386 raeburn 9623: }
1.1210 raeburn 9624: } else {
9625: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9626: my $requrl = $env{'request.uri'};
9627: if ($requrl eq '') {
9628: $requrl = $ENV{'REQUEST_URI'};
9629: $requrl =~ s/\?.+$//;
9630: }
9631: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9632: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9633: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9634: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9635: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9636: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9637: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9638: my ($offload,$offloadoth);
1.1210 raeburn 9639: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9640: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9641: $offload = 1;
1.1353 raeburn 9642: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9643: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9644: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9645: $offloadoth = 1;
9646: $dom_in_use = $env{'user.domain'};
9647: }
9648: }
1.1340 raeburn 9649: }
9650: }
9651: unless ($offload) {
9652: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9653: if ($domdefs{'offloadoth'}{$lonhost}) {
9654: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9655: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9656: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9657: $offload = 1;
1.1352 raeburn 9658: $offloadoth = 1;
1.1340 raeburn 9659: $dom_in_use = $env{'user.domain'};
9660: }
1.1210 raeburn 9661: }
1.1340 raeburn 9662: }
9663: }
9664: }
9665: if ($offload) {
1.1358 raeburn 9666: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9667: if (($newserver eq '') && ($offloadoth)) {
9668: my @domains = &Apache::lonnet::current_machine_domains();
9669: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9670: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9671: }
9672: }
1.1340 raeburn 9673: if (($newserver) && ($newserver ne $lonhost)) {
9674: my $numsec = 5;
9675: my $timeout = $numsec * 1000;
9676: my ($newurl,$locknum,%locks,$msg);
9677: if ($env{'request.role.adv'}) {
9678: ($locknum,%locks) = &Apache::lonnet::get_locks();
9679: }
9680: my $disable_submit = 0;
9681: if ($requrl =~ /$LONCAPA::assess_re/) {
9682: $disable_submit = 1;
9683: }
9684: if ($locknum) {
9685: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9686: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9687: join(", ",sort(values(%locks)))."\n";
9688: if (&show_course()) {
9689: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9690: } else {
9691: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9692: }
1.1340 raeburn 9693: } else {
9694: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9695: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9696: }
9697: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9698: $newurl = '/adm/switchserver?otherserver='.$newserver;
9699: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9700: $newurl .= '&role='.$env{'request.role'};
9701: }
9702: if ($env{'request.symb'}) {
9703: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9704: if ($shownsymb =~ m{^/enc/}) {
9705: my $reqdmajor = 2;
9706: my $reqdminor = 11;
9707: my $reqdsubminor = 3;
9708: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9709: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9710: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9711: if (($major eq '' && $minor eq '') ||
9712: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9713: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9714: ($reqdsubminor > $subminor))))) {
9715: undef($shownsymb);
9716: }
1.1210 raeburn 9717: }
1.1340 raeburn 9718: if ($shownsymb) {
9719: &js_escape(\$shownsymb);
9720: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9721: }
1.1340 raeburn 9722: } else {
9723: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9724: &js_escape(\$shownurl);
9725: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9726: }
1.1340 raeburn 9727: }
9728: &js_escape(\$msg);
9729: $result.=<<OFFLOAD
1.1210 raeburn 9730: <meta http-equiv="pragma" content="no-cache" />
9731: <script type="text/javascript">
1.1215 raeburn 9732: // <![CDATA[
1.1210 raeburn 9733: function LC_Offload_Now() {
9734: var dest = "$newurl";
9735: if (dest != '') {
9736: window.location.href="$newurl";
9737: }
9738: }
1.1214 raeburn 9739: \$(document).ready(function () {
9740: window.alert('$msg');
9741: if ($disable_submit) {
1.1210 raeburn 9742: \$(".LC_hwk_submit").prop("disabled", true);
9743: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9744: }
9745: setTimeout('LC_Offload_Now()', $timeout);
9746: });
1.1215 raeburn 9747: // ]]>
1.1210 raeburn 9748: </script>
9749: OFFLOAD
9750: }
9751: }
9752: }
9753: }
9754: }
1.313 albertel 9755: }
1.306 albertel 9756: if (!defined($title)) {
9757: $title = 'The LearningOnline Network with CAPA';
9758: }
1.460 albertel 9759: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1432 raeburn 9760: if ($title =~ /^LON-CAPA\s+/) {
9761: $result .= '<title> '.$title.'</title>';
9762: } else {
9763: $result .= '<title> LON-CAPA '.$title.'</title>';
9764: }
9765: $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1168 raeburn 9766: if (!$args->{'frameset'}) {
9767: $result .= ' /';
9768: }
9769: $result .= '>'
1.1064 raeburn 9770: .$inhibitprint
1.414 albertel 9771: .$head_extra;
1.1242 raeburn 9772: my $clientmobile;
9773: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9774: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9775: } else {
9776: $clientmobile = $env{'browser.mobile'};
9777: }
9778: if ($clientmobile) {
1.1137 raeburn 9779: $result .= '
1.1435 raeburn 9780: <meta name="viewport" content="width=device-width, initial-scale=1.0">
1.1137 raeburn 9781: <meta name="apple-mobile-web-app-capable" content="yes" />';
9782: }
1.1455 raeburn 9783: $result .= '<meta name="google" content="notranslate"';
9784: if (!$args->{'frameset'}) {
9785: $result .= ' /';
9786: }
9787: $result .= '>'."\n";
1.962 droeschl 9788: return $result.'</head>';
1.306 albertel 9789: }
9790:
9791: =pod
9792:
1.340 albertel 9793: =item * &font_settings()
9794:
9795: Returns neccessary <meta> to set the proper encoding
9796:
1.1160 raeburn 9797: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9798:
9799: =cut
9800:
9801: sub font_settings {
1.1160 raeburn 9802: my ($args) = @_;
1.340 albertel 9803: my $headerstring='';
1.1160 raeburn 9804: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9805: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9806: $headerstring.=
9807: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9808: if (!$args->{'frameset'}) {
9809: $headerstring.= ' /';
9810: }
9811: $headerstring .= '>'."\n";
1.340 albertel 9812: }
9813: return $headerstring;
9814: }
9815:
1.341 albertel 9816: =pod
9817:
1.1064 raeburn 9818: =item * &print_suppression()
9819:
9820: In course context returns css which causes the body to be blank when media="print",
9821: if printout generation is unavailable for the current resource.
9822:
9823: This could be because:
9824:
9825: (a) printstartdate is in the future
9826:
9827: (b) printenddate is in the past
9828:
9829: (c) there is an active exam block with "printout"
9830: functionality blocked
9831:
9832: Users with pav, pfo or evb privileges are exempt.
9833:
9834: Inputs: none
9835:
9836: =cut
9837:
9838:
9839: sub print_suppression {
9840: my $noprint;
9841: if ($env{'request.course.id'}) {
9842: my $scope = $env{'request.course.id'};
9843: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9844: (&Apache::lonnet::allowed('pfo',$scope))) {
9845: return;
9846: }
9847: if ($env{'request.course.sec'} ne '') {
9848: $scope .= "/$env{'request.course.sec'}";
9849: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9850: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9851: return;
1.1064 raeburn 9852: }
9853: }
9854: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9855: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9856: my $clientip = &Apache::lonnet::get_requestor_ip();
9857: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9858: if ($blocked) {
9859: my $checkrole = "cm./$cdom/$cnum";
9860: if ($env{'request.course.sec'} ne '') {
9861: $checkrole .= "/$env{'request.course.sec'}";
9862: }
9863: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9864: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9865: $noprint = 1;
9866: }
9867: }
9868: unless ($noprint) {
9869: my $symb = &Apache::lonnet::symbread();
9870: if ($symb ne '') {
9871: my $navmap = Apache::lonnavmaps::navmap->new();
9872: if (ref($navmap)) {
9873: my $res = $navmap->getBySymb($symb);
9874: if (ref($res)) {
9875: if (!$res->resprintable()) {
9876: $noprint = 1;
9877: }
9878: }
9879: }
9880: }
9881: }
9882: if ($noprint) {
9883: return <<"ENDSTYLE";
9884: <style type="text/css" media="print">
9885: body { display:none }
9886: </style>
9887: ENDSTYLE
9888: }
9889: }
9890: return;
9891: }
9892:
9893: =pod
9894:
1.341 albertel 9895: =item * &xml_begin()
9896:
9897: Returns the needed doctype and <html>
9898:
9899: Inputs: none
9900:
9901: =cut
9902:
9903: sub xml_begin {
1.1168 raeburn 9904: my ($is_frameset) = @_;
1.341 albertel 9905: my $output='';
9906:
9907: if ($env{'browser.mathml'}) {
9908: $output='<?xml version="1.0"?>'
9909: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9910: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9911:
9912: # .'<!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">] >'
9913: .'<!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">'
9914: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9915: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9916: } elsif ($is_frameset) {
9917: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
1.1459 raeburn 9918: '<html lang="en">'."\n";
1.341 albertel 9919: } else {
1.1168 raeburn 9920: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9921: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9922: }
9923: return $output;
9924: }
1.340 albertel 9925:
9926: =pod
9927:
1.306 albertel 9928: =item * &start_page()
9929:
9930: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9931:
1.648 raeburn 9932: Inputs:
9933:
9934: =over 4
9935:
9936: $title - optional title for the page
9937:
9938: $head_extra - optional extra HTML to incude inside the <head>
9939:
9940: $args - additional optional args supported are:
9941:
9942: =over 8
9943:
9944: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9945: arg on
1.814 bisitz 9946: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9947: add_entries -> additional attributes to add to the <body>
9948: domain -> force to color decorate a page for a
1.317 albertel 9949: specific domain
1.648 raeburn 9950: function -> force usage of a specific rolish color
1.317 albertel 9951: scheme
1.648 raeburn 9952: redirect -> see &headtag()
9953: bgcolor -> override the default page bg color
9954: js_ready -> return a string ready for being used in
1.317 albertel 9955: a javascript writeln
1.648 raeburn 9956: html_encode -> return a string ready for being used in
1.320 albertel 9957: a html attribute
1.648 raeburn 9958: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9959: $forcereg arg
1.648 raeburn 9960: frameset -> if true will start with a <frameset>
1.330 albertel 9961: rather than <body>
1.648 raeburn 9962: skip_phases -> hash ref of
1.338 albertel 9963: head -> skip the <html><head> generation
9964: body -> skip all <body> generation
1.648 raeburn 9965: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9966: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9967: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1437 raeburn 9968: bread_crumbs_style -> breadcrumbs are contained within <div id="LC_breadcrumbs">,
9969: and &standard_css() contains CSS for #LC_breadcrumbs, if you want
9970: to override those values, or add to them, specify the value to
9971: include in the style attribute to include in the div tag by using
9972: bread_crumbs_style (e.g., overflow: visible)
1.1272 raeburn 9973: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9974: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9975: group -> includes the current group, if page is for a
1.1274 raeburn 9976: specific group
9977: use_absolute -> for request for external resource or syllabus, this
9978: will contain https://<hostname> if server uses
9979: https (as per hosts.tab), but request is for http
9980: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9981: links_disabled -> Links in primary and secondary menus are disabled
9982: (Can enable them once page has loaded - see lonroles.pm
9983: for an example).
1.1380 raeburn 9984: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9985:
1.648 raeburn 9986: =back
1.460 albertel 9987:
1.648 raeburn 9988: =back
1.562 albertel 9989:
1.306 albertel 9990: =cut
9991:
9992: sub start_page {
1.309 albertel 9993: my ($title,$head_extra,$args) = @_;
1.318 albertel 9994: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9995:
1.315 albertel 9996: $env{'internal.start_page'}++;
1.1359 raeburn 9997: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9998:
1.338 albertel 9999: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 10000: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 10001: }
1.1316 raeburn 10002:
10003: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 10004: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
10005: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
10006: $args->{'no_primary_menu'} = 1;
10007: }
10008: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
10009: $args->{'no_inline_menu'} = 1;
10010: }
10011: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
10012: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
10013: }
10014: } else {
10015: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10016: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
10017: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
10018: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
10019: $args->{'no_primary_menu'} = 1;
10020: }
10021: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
10022: $args->{'no_inline_menu'} = 1;
10023: }
10024: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
10025: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
10026: }
10027: }
10028: }
1.1316 raeburn 10029: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
10030: $env{'course.'.$env{'request.course.id'}.'.domain'},
10031: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 10032: } elsif ($env{'request.course.id'}) {
10033: my $expiretime=600;
10034: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
10035: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
10036: }
10037: my ($deeplinkmenu,$menuref);
10038: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
10039: if ($menucoll) {
10040: if (ref($menuref) eq 'HASH') {
10041: %menu = %{$menuref};
10042: }
10043: if ($menu{'top'} eq 'n') {
10044: $args->{'no_primary_menu'} = 1;
10045: }
10046: if ($menu{'inline'} eq 'n') {
10047: unless (&Apache::lonnet::allowed('opa')) {
10048: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10049: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10050: my $crstype = &course_type();
10051: my $now = time;
10052: my $ccrole;
10053: if ($crstype eq 'Community') {
10054: $ccrole = 'co';
10055: } else {
10056: $ccrole = 'cc';
10057: }
10058: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
10059: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
10060: if ((($start) && ($start<0)) ||
10061: (($end) && ($end<$now)) ||
10062: (($start) && ($now<$start))) {
10063: $args->{'no_inline_menu'} = 1;
10064: }
10065: } else {
10066: $args->{'no_inline_menu'} = 1;
10067: }
10068: }
10069: }
10070: }
1.1316 raeburn 10071: }
1.1359 raeburn 10072:
1.1385 raeburn 10073: my $showncrumbs;
1.338 albertel 10074: if (! exists($args->{'skip_phases'}{'body'}) ) {
10075: if ($args->{'frameset'}) {
10076: my $attr_string = &make_attr_string($args->{'force_register'},
10077: $args->{'add_entries'});
10078: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 10079: } else {
10080: $result .=
10081: &bodytag($title,
10082: $args->{'function'}, $args->{'add_entries'},
10083: $args->{'only_body'}, $args->{'domain'},
10084: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 10085: $args->{'bgcolor'}, $args,
1.1385 raeburn 10086: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
10087: \%menu,\$showncrumbs);
1.831 bisitz 10088: }
1.330 albertel 10089: }
1.338 albertel 10090:
1.315 albertel 10091: if ($args->{'js_ready'}) {
1.713 kaisler 10092: $result = &js_ready($result);
1.315 albertel 10093: }
1.320 albertel 10094: if ($args->{'html_encode'}) {
1.713 kaisler 10095: $result = &html_encode($result);
10096: }
10097:
1.813 bisitz 10098: # Preparation for new and consistent functionlist at top of screen
10099: # if ($args->{'functionlist'}) {
10100: # $result .= &build_functionlist();
10101: #}
10102:
1.964 droeschl 10103: # Don't add anything more if only_body wanted or in const space
10104: return $result if $args->{'only_body'}
10105: || $env{'request.state'} eq 'construct';
1.813 bisitz 10106:
10107: #Breadcrumbs
1.758 kaisler 10108: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 10109: unless ($showncrumbs) {
1.758 kaisler 10110: &Apache::lonhtmlcommon::clear_breadcrumbs();
10111: #if any br links exists, add them to the breadcrumbs
10112: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
10113: foreach my $crumb (@{$args->{'bread_crumbs'}}){
10114: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
10115: }
10116: }
1.1096 raeburn 10117: # if @advtools array contains items add then to the breadcrumbs
10118: if (@advtools > 0) {
10119: &Apache::lonmenu::advtools_crumbs(@advtools);
10120: }
1.1272 raeburn 10121: my $menulink;
10122: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
10123: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 10124: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 10125: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
10126: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
10127: (!$env{'request.role.adv'}))) {
10128: $menulink = 0;
10129: } else {
10130: undef($menulink);
10131: }
1.1385 raeburn 10132: my $linkprotout;
10133: if ($env{'request.deeplink.login'}) {
10134: my $linkprotout = &Apache::lonmenu::linkprot_exit();
10135: if ($linkprotout) {
10136: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
10137: }
10138: }
1.758 kaisler 10139: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
10140: if(exists($args->{'bread_crumbs_component'})){
1.1437 raeburn 10141: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},
10142: '',$menulink,'',
10143: $args->{'bread_crumbs_style'});
1.1237 raeburn 10144: } else {
1.1437 raeburn 10145: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink,'',
10146: $args->{'bread_crumbs_style'});
1.758 kaisler 10147: }
1.1385 raeburn 10148: }
1.320 albertel 10149: }
1.315 albertel 10150: return $result;
1.306 albertel 10151: }
10152:
10153: sub end_page {
1.315 albertel 10154: my ($args) = @_;
10155: $env{'internal.end_page'}++;
1.330 albertel 10156: my $result;
1.335 albertel 10157: if ($args->{'discussion'}) {
10158: my ($target,$parser);
10159: if (ref($args->{'discussion'})) {
10160: ($target,$parser) =($args->{'discussion'}{'target'},
10161: $args->{'discussion'}{'parser'});
10162: }
10163: $result .= &Apache::lonxml::xmlend($target,$parser);
10164: }
1.330 albertel 10165: if ($args->{'frameset'}) {
10166: $result .= '</frameset>';
10167: } else {
1.635 raeburn 10168: $result .= &endbodytag($args);
1.330 albertel 10169: }
1.1080 raeburn 10170: unless ($args->{'notbody'}) {
10171: $result .= "\n</html>";
10172: }
1.330 albertel 10173:
1.315 albertel 10174: if ($args->{'js_ready'}) {
1.317 albertel 10175: $result = &js_ready($result);
1.315 albertel 10176: }
1.335 albertel 10177:
1.320 albertel 10178: if ($args->{'html_encode'}) {
10179: $result = &html_encode($result);
10180: }
1.335 albertel 10181:
1.315 albertel 10182: return $result;
10183: }
10184:
1.1359 raeburn 10185: sub menucoll_in_effect {
10186: my ($menucoll,$deeplinkmenu,%menu);
10187: if ($env{'request.course.id'}) {
10188: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10189: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10190: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10191: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10192: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10193: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10194: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10195: my $navmap = Apache::lonnavmaps::navmap->new();
10196: if (ref($navmap)) {
10197: $deeplink = $navmap->get_mapparam(undef,
10198: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10199: '0.deeplink');
1.1370 raeburn 10200: } else {
10201: $check_login_symb = 1;
1.1362 raeburn 10202: }
10203: } else {
1.1370 raeburn 10204: my $symb = &Apache::lonnet::symbread();
10205: if ($symb) {
10206: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10207: } else {
10208: $check_login_symb = 1;
10209: }
1.1362 raeburn 10210: }
10211: } else {
1.1370 raeburn 10212: $check_login_symb = 1;
10213: }
10214: if ($check_login_symb) {
1.1362 raeburn 10215: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10216: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10217: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10218: my $navmap = Apache::lonnavmaps::navmap->new();
10219: if (ref($navmap)) {
10220: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10221: }
10222: } else {
10223: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10224: }
10225: }
1.1359 raeburn 10226: if ($deeplink ne '') {
1.1378 raeburn 10227: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10228: if ($display =~ /^\d+$/) {
10229: $deeplinkmenu = 1;
10230: $menucoll = $display;
10231: }
10232: }
10233: }
10234: if ($menucoll) {
10235: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10236: }
10237: }
10238: return ($menucoll,$deeplinkmenu,\%menu);
10239: }
10240:
1.1362 raeburn 10241: sub deeplink_login_symb {
10242: my ($cnum,$cdom) = @_;
10243: my $login_symb;
10244: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10245: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10246: }
10247: return $login_symb;
10248: }
10249:
10250: sub symb_from_tinyurl {
10251: my ($url,$cnum,$cdom) = @_;
10252: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10253: my $key = $1;
10254: my ($tinyurl,$login);
10255: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10256: if (defined($cached)) {
10257: $tinyurl = $result;
10258: } else {
10259: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10260: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10261: if ($currtiny{$key} ne '') {
10262: $tinyurl = $currtiny{$key};
10263: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10264: }
1.1364 raeburn 10265: }
10266: if ($tinyurl ne '') {
10267: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10268: if (wantarray) {
10269: return ($cnumreq,$symb);
10270: } elsif ($cnumreq eq $cnum) {
10271: return $symb;
1.1362 raeburn 10272: }
10273: }
10274: }
1.1364 raeburn 10275: if (wantarray) {
10276: return ();
10277: } else {
10278: return;
10279: }
1.1362 raeburn 10280: }
10281:
1.1405 raeburn 10282: sub usable_exttools {
10283: my %tooltypes;
10284: if ($env{'request.course.id'}) {
10285: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10286: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10287: %tooltypes = (
10288: crs => 1,
10289: dom => 1,
10290: );
10291: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10292: $tooltypes{'crs'} = 1;
10293: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10294: $tooltypes{'dom'} = 1;
10295: }
10296: } else {
10297: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10298: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10299: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10300: if ($crstype eq '') {
10301: $crstype = 'course';
10302: }
10303: if ($crstype eq 'course') {
10304: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10305: $crstype = 'official';
10306: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10307: $crstype = 'textbook';
10308: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10309: $crstype = 'lti';
10310: } else {
10311: $crstype = 'unofficial';
10312: }
10313: }
10314: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10315: if ($domdefaults{$crstype.'domexttool'}) {
10316: $tooltypes{'dom'} = 1;
10317: }
10318: if ($domdefaults{$crstype.'exttool'}) {
10319: $tooltypes{'crs'} = 1;
10320: }
10321: }
10322: }
10323: return %tooltypes;
10324: }
10325:
1.1034 www 10326: sub wishlist_window {
10327: return(<<'ENDWISHLIST');
1.1046 raeburn 10328: <script type="text/javascript">
1.1034 www 10329: // <![CDATA[
10330: // <!-- BEGIN LON-CAPA Internal
10331: function set_wishlistlink(title, path) {
10332: if (!title) {
10333: title = document.title;
10334: title = title.replace(/^LON-CAPA /,'');
10335: }
1.1175 raeburn 10336: title = encodeURIComponent(title);
1.1203 raeburn 10337: title = title.replace("'","\\\'");
1.1034 www 10338: if (!path) {
10339: path = location.pathname;
10340: }
1.1175 raeburn 10341: path = encodeURIComponent(path);
1.1203 raeburn 10342: path = path.replace("'","\\\'");
1.1034 www 10343: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10344: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10345: }
10346: // END LON-CAPA Internal -->
10347: // ]]>
10348: </script>
10349: ENDWISHLIST
10350: }
10351:
1.1030 www 10352: sub modal_window {
10353: return(<<'ENDMODAL');
1.1046 raeburn 10354: <script type="text/javascript">
1.1030 www 10355: // <![CDATA[
10356: // <!-- BEGIN LON-CAPA Internal
10357: var modalWindow = {
10358: parent:"body",
10359: windowId:null,
10360: content:null,
10361: width:null,
10362: height:null,
10363: close:function()
10364: {
10365: $(".LCmodal-window").remove();
10366: $(".LCmodal-overlay").remove();
10367: },
10368: open:function()
10369: {
10370: var modal = "";
10371: modal += "<div class=\"LCmodal-overlay\"></div>";
10372: 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;\">";
10373: modal += this.content;
10374: modal += "</div>";
10375:
10376: $(this.parent).append(modal);
10377:
10378: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10379: $(".LCclose-window").click(function(){modalWindow.close();});
10380: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10381: }
10382: };
1.1140 raeburn 10383: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10384: {
1.1266 raeburn 10385: source = source.replace(/'/g,"'");
1.1030 www 10386: modalWindow.windowId = "myModal";
10387: modalWindow.width = width;
10388: modalWindow.height = height;
1.1196 raeburn 10389: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10390: modalWindow.open();
1.1208 raeburn 10391: };
1.1030 www 10392: // END LON-CAPA Internal -->
10393: // ]]>
10394: </script>
10395: ENDMODAL
10396: }
10397:
10398: sub modal_link {
1.1140 raeburn 10399: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10400: unless ($width) { $width=480; }
10401: unless ($height) { $height=400; }
1.1031 www 10402: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10403: unless ($transparency) { $transparency='true'; }
10404:
1.1074 raeburn 10405: my $target_attr;
10406: if (defined($target)) {
10407: $target_attr = 'target="'.$target.'"';
10408: }
10409: return <<"ENDLINK";
1.1336 raeburn 10410: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10411: ENDLINK
1.1030 www 10412: }
10413:
1.1032 www 10414: sub modal_adhoc_script {
1.1365 raeburn 10415: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10416: my $mathjax;
10417: if ($possmathjax) {
10418: $mathjax = <<'ENDJAX';
10419: if (typeof MathJax == 'object') {
10420: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10421: }
10422: ENDJAX
10423: }
1.1032 www 10424: return (<<ENDADHOC);
1.1046 raeburn 10425: <script type="text/javascript">
1.1032 www 10426: // <![CDATA[
10427: var $funcname = function()
10428: {
10429: modalWindow.windowId = "myModal";
10430: modalWindow.width = $width;
10431: modalWindow.height = $height;
10432: modalWindow.content = '$content';
10433: modalWindow.open();
1.1365 raeburn 10434: $mathjax
1.1032 www 10435: };
10436: // ]]>
10437: </script>
10438: ENDADHOC
10439: }
10440:
1.1041 www 10441: sub modal_adhoc_inner {
1.1365 raeburn 10442: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10443: my $innerwidth=$width-20;
10444: $content=&js_ready(
1.1140 raeburn 10445: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10446: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10447: $content.
1.1041 www 10448: &end_scrollbox().
1.1140 raeburn 10449: &end_page()
1.1041 www 10450: );
1.1365 raeburn 10451: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10452: }
10453:
10454: sub modal_adhoc_window {
1.1365 raeburn 10455: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10456: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10457: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10458: }
10459:
10460: sub modal_adhoc_launch {
10461: my ($funcname,$width,$height,$content)=@_;
10462: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10463: <script type="text/javascript">
10464: // <![CDATA[
10465: $funcname();
10466: // ]]>
10467: </script>
10468: ENDLAUNCH
10469: }
10470:
10471: sub modal_adhoc_close {
10472: return (<<ENDCLOSE);
10473: <script type="text/javascript">
10474: // <![CDATA[
10475: modalWindow.close();
10476: // ]]>
10477: </script>
10478: ENDCLOSE
10479: }
10480:
1.1038 www 10481: sub togglebox_script {
10482: return(<<ENDTOGGLE);
10483: <script type="text/javascript">
10484: // <![CDATA[
10485: function LCtoggleDisplay(id,hidetext,showtext) {
10486: link = document.getElementById(id + "link").childNodes[0];
10487: with (document.getElementById(id).style) {
10488: if (display == "none" ) {
10489: display = "inline";
10490: link.nodeValue = hidetext;
10491: } else {
10492: display = "none";
10493: link.nodeValue = showtext;
10494: }
10495: }
10496: }
10497: // ]]>
10498: </script>
10499: ENDTOGGLE
10500: }
10501:
1.1039 www 10502: sub start_togglebox {
10503: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10504: unless ($heading) { $heading=''; } else { $heading.=' '; }
10505: unless ($showtext) { $showtext=&mt('show'); }
10506: unless ($hidetext) { $hidetext=&mt('hide'); }
10507: unless ($headerbg) { $headerbg='#FFFFFF'; }
10508: return &start_data_table().
10509: &start_data_table_header_row().
10510: '<td bgcolor="'.$headerbg.'">'.$heading.
10511: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10512: $showtext.'\')">'.$showtext.'</a>]</td>'.
10513: &end_data_table_header_row().
10514: '<tr id="'.$id.'" style="display:none""><td>';
10515: }
10516:
10517: sub end_togglebox {
10518: return '</td></tr>'.&end_data_table();
10519: }
10520:
1.1041 www 10521: sub LCprogressbar_script {
1.1302 raeburn 10522: my ($id,$number_to_do)=@_;
10523: if ($number_to_do) {
10524: return(<<ENDPROGRESS);
1.1041 www 10525: <script type="text/javascript">
10526: // <![CDATA[
1.1045 www 10527: \$('#progressbar$id').progressbar({
1.1041 www 10528: value: 0,
10529: change: function(event, ui) {
10530: var newVal = \$(this).progressbar('option', 'value');
10531: \$('.pblabel', this).text(LCprogressTxt);
10532: }
10533: });
10534: // ]]>
10535: </script>
10536: ENDPROGRESS
1.1302 raeburn 10537: } else {
10538: return(<<ENDPROGRESS);
10539: <script type="text/javascript">
10540: // <![CDATA[
10541: \$('#progressbar$id').progressbar({
10542: value: false,
10543: create: function(event, ui) {
10544: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10545: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10546: }
10547: });
10548: // ]]>
10549: </script>
10550: ENDPROGRESS
10551: }
1.1041 www 10552: }
10553:
10554: sub LCprogressbarUpdate_script {
10555: return(<<ENDPROGRESSUPDATE);
10556: <style type="text/css">
10557: .ui-progressbar { position:relative; }
1.1302 raeburn 10558: .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 10559: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10560: </style>
10561: <script type="text/javascript">
10562: // <![CDATA[
1.1045 www 10563: var LCprogressTxt='---';
10564:
1.1302 raeburn 10565: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10566: LCprogressTxt=progresstext;
1.1302 raeburn 10567: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10568: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10569: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10570: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10571: } else {
10572: \$('#progressbar'+id).progressbar('value',percent);
10573: }
1.1041 www 10574: }
10575: // ]]>
10576: </script>
10577: ENDPROGRESSUPDATE
10578: }
10579:
1.1042 www 10580: my $LClastpercent;
1.1045 www 10581: my $LCidcnt;
10582: my $LCcurrentid;
1.1042 www 10583:
1.1041 www 10584: sub LCprogressbar {
1.1302 raeburn 10585: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10586: $LClastpercent=0;
1.1045 www 10587: $LCidcnt++;
10588: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10589: my ($starting,$content);
10590: if ($number_to_do) {
10591: $starting=&mt('Starting');
10592: $content=(<<ENDPROGBAR);
10593: $preamble
1.1045 www 10594: <div id="progressbar$LCcurrentid">
1.1041 www 10595: <span class="pblabel">$starting</span>
10596: </div>
10597: ENDPROGBAR
1.1302 raeburn 10598: } else {
10599: $starting=&mt('Loading...');
10600: $LClastpercent='false';
10601: $content=(<<ENDPROGBAR);
10602: $preamble
10603: <div id="progressbar$LCcurrentid">
10604: <div class="progress-label">$starting</div>
10605: </div>
10606: ENDPROGBAR
10607: }
10608: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10609: }
10610:
10611: sub LCprogressbarUpdate {
1.1302 raeburn 10612: my ($r,$val,$text,$number_to_do)=@_;
10613: if ($number_to_do) {
10614: unless ($val) {
10615: if ($LClastpercent) {
10616: $val=$LClastpercent;
10617: } else {
10618: $val=0;
10619: }
10620: }
10621: if ($val<0) { $val=0; }
10622: if ($val>100) { $val=0; }
10623: $LClastpercent=$val;
10624: unless ($text) { $text=$val.'%'; }
10625: } else {
10626: $val = 'false';
1.1042 www 10627: }
1.1041 www 10628: $text=&js_ready($text);
1.1044 www 10629: &r_print($r,<<ENDUPDATE);
1.1041 www 10630: <script type="text/javascript">
10631: // <![CDATA[
1.1302 raeburn 10632: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10633: // ]]>
10634: </script>
10635: ENDUPDATE
1.1035 www 10636: }
10637:
1.1042 www 10638: sub LCprogressbarClose {
10639: my ($r)=@_;
10640: $LClastpercent=0;
1.1044 www 10641: &r_print($r,<<ENDCLOSE);
1.1042 www 10642: <script type="text/javascript">
10643: // <![CDATA[
1.1045 www 10644: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10645: // ]]>
10646: </script>
10647: ENDCLOSE
1.1044 www 10648: }
10649:
10650: sub r_print {
10651: my ($r,$to_print)=@_;
10652: if ($r) {
10653: $r->print($to_print);
10654: $r->rflush();
10655: } else {
10656: print($to_print);
10657: }
1.1042 www 10658: }
10659:
1.320 albertel 10660: sub html_encode {
10661: my ($result) = @_;
10662:
1.322 albertel 10663: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10664:
10665: return $result;
10666: }
1.1044 www 10667:
1.317 albertel 10668: sub js_ready {
10669: my ($result) = @_;
10670:
1.323 albertel 10671: $result =~ s/[\n\r]/ /xmsg;
10672: $result =~ s/\\/\\\\/xmsg;
10673: $result =~ s/'/\\'/xmsg;
1.372 albertel 10674: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10675:
10676: return $result;
10677: }
10678:
1.315 albertel 10679: sub validate_page {
10680: if ( exists($env{'internal.start_page'})
1.316 albertel 10681: && $env{'internal.start_page'} > 1) {
10682: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10683: $env{'internal.start_page'}.' '.
1.316 albertel 10684: $ENV{'request.filename'});
1.315 albertel 10685: }
10686: if ( exists($env{'internal.end_page'})
1.316 albertel 10687: && $env{'internal.end_page'} > 1) {
10688: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10689: $env{'internal.end_page'}.' '.
1.316 albertel 10690: $env{'request.filename'});
1.315 albertel 10691: }
10692: if ( exists($env{'internal.start_page'})
10693: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10694: &Apache::lonnet::logthis('start_page called without end_page '.
10695: $env{'request.filename'});
1.315 albertel 10696: }
10697: if ( ! exists($env{'internal.start_page'})
10698: && exists($env{'internal.end_page'})) {
1.316 albertel 10699: &Apache::lonnet::logthis('end_page called without start_page'.
10700: $env{'request.filename'});
1.315 albertel 10701: }
1.306 albertel 10702: }
1.315 albertel 10703:
1.996 www 10704:
10705: sub start_scrollbox {
1.1140 raeburn 10706: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10707: unless ($outerwidth) { $outerwidth='520px'; }
10708: unless ($width) { $width='500px'; }
10709: unless ($height) { $height='200px'; }
1.1075 raeburn 10710: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10711: if ($id ne '') {
1.1140 raeburn 10712: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10713: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10714: }
1.1075 raeburn 10715: if ($bgcolor ne '') {
10716: $tdcol = "background-color: $bgcolor;";
10717: }
1.1137 raeburn 10718: my $nicescroll_js;
10719: if ($env{'browser.mobile'}) {
1.1140 raeburn 10720: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10721: }
10722: return <<"END";
10723: $nicescroll_js
10724:
10725: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10726: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10727: END
10728: }
10729:
10730: sub end_scrollbox {
10731: return '</div></td></tr></table>';
10732: }
10733:
10734: sub nicescroll_javascript {
10735: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10736: my %options;
10737: if (ref($cursor) eq 'HASH') {
10738: %options = %{$cursor};
10739: }
10740: unless ($options{'railalign'} =~ /^left|right$/) {
10741: $options{'railalign'} = 'left';
10742: }
10743: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10744: my $function = &get_users_function();
10745: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10746: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10747: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10748: }
1.1140 raeburn 10749: }
10750: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10751: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10752: $options{'cursoropacity'}='1.0';
10753: }
1.1140 raeburn 10754: } else {
10755: $options{'cursoropacity'}='1.0';
10756: }
10757: if ($options{'cursorfixedheight'} eq 'none') {
10758: delete($options{'cursorfixedheight'});
10759: } else {
10760: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10761: }
10762: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10763: delete($options{'railoffset'});
10764: }
10765: my @niceoptions;
10766: while (my($key,$value) = each(%options)) {
10767: if ($value =~ /^\{.+\}$/) {
10768: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10769: } else {
1.1140 raeburn 10770: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10771: }
1.1140 raeburn 10772: }
10773: my $nicescroll_js = '
1.1137 raeburn 10774: $(document).ready(
1.1140 raeburn 10775: function() {
10776: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10777: }
1.1137 raeburn 10778: );
10779: ';
1.1140 raeburn 10780: if ($framecheck) {
10781: $nicescroll_js .= '
10782: function expand_div(caller) {
10783: if (top === self) {
10784: document.getElementById("'.$id.'").style.width = "auto";
10785: document.getElementById("'.$id.'").style.height = "auto";
10786: } else {
10787: try {
10788: if (parent.frames) {
10789: if (parent.frames.length > 1) {
10790: var framesrc = parent.frames[1].location.href;
10791: var currsrc = framesrc.replace(/\#.*$/,"");
10792: if ((caller == "search") || (currsrc == "'.$location.'")) {
10793: document.getElementById("'.$id.'").style.width = "auto";
10794: document.getElementById("'.$id.'").style.height = "auto";
10795: }
10796: }
10797: }
10798: } catch (e) {
10799: return;
10800: }
1.1137 raeburn 10801: }
1.1140 raeburn 10802: return;
1.996 www 10803: }
1.1140 raeburn 10804: ';
10805: }
10806: if ($needjsready) {
10807: $nicescroll_js = '
10808: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10809: } else {
10810: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10811: }
10812: return $nicescroll_js;
1.996 www 10813: }
10814:
1.318 albertel 10815: sub simple_error_page {
1.1150 bisitz 10816: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10817: my %displayargs;
1.1151 raeburn 10818: if (ref($args) eq 'HASH') {
10819: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10820: if ($args->{'only_body'}) {
10821: $displayargs{'only_body'} = 1;
10822: }
10823: if ($args->{'no_nav_bar'}) {
10824: $displayargs{'no_nav_bar'} = 1;
10825: }
1.1151 raeburn 10826: } else {
10827: $msg = &mt($msg);
10828: }
1.1150 bisitz 10829:
1.318 albertel 10830: my $page =
1.1459 raeburn 10831: &Apache::loncommon::start_page($title,'',\%displayargs)."\n".
1.1460 ! raeburn 10832: '<div class="LC_landmark" style="clear:both" role="main">'.
1.1150 bisitz 10833: '<p class="LC_error">'.$msg.'</p>'.
1.1459 raeburn 10834: '</div>'.
1.318 albertel 10835: &Apache::loncommon::end_page();
10836: if (ref($r)) {
10837: $r->print($page);
1.327 albertel 10838: return;
1.318 albertel 10839: }
10840: return $page;
10841: }
1.347 albertel 10842:
10843: {
1.610 albertel 10844: my @row_count;
1.961 onken 10845:
10846: sub start_data_table_count {
10847: unshift(@row_count, 0);
10848: return;
10849: }
10850:
10851: sub end_data_table_count {
10852: shift(@row_count);
10853: return;
10854: }
10855:
1.347 albertel 10856: sub start_data_table {
1.1018 raeburn 10857: my ($add_class,$id) = @_;
1.422 albertel 10858: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10859: my $table_id;
10860: if (defined($id)) {
10861: $table_id = ' id="'.$id.'"';
10862: }
1.961 onken 10863: &start_data_table_count();
1.1018 raeburn 10864: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10865: }
10866:
10867: sub end_data_table {
1.961 onken 10868: &end_data_table_count();
1.389 albertel 10869: return '</table>'."\n";;
1.347 albertel 10870: }
10871:
10872: sub start_data_table_row {
1.974 wenzelju 10873: my ($add_class, $id) = @_;
1.610 albertel 10874: $row_count[0]++;
10875: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10876: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10877: $id = (' id="'.$id.'"') unless ($id eq '');
10878: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10879: }
1.471 banghart 10880:
10881: sub continue_data_table_row {
1.974 wenzelju 10882: my ($add_class, $id) = @_;
1.610 albertel 10883: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10884: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10885: $id = (' id="'.$id.'"') unless ($id eq '');
10886: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10887: }
1.347 albertel 10888:
10889: sub end_data_table_row {
1.389 albertel 10890: return '</tr>'."\n";;
1.347 albertel 10891: }
1.367 www 10892:
1.421 albertel 10893: sub start_data_table_empty_row {
1.707 bisitz 10894: # $row_count[0]++;
1.421 albertel 10895: return '<tr class="LC_empty_row" >'."\n";;
10896: }
10897:
10898: sub end_data_table_empty_row {
10899: return '</tr>'."\n";;
10900: }
10901:
1.367 www 10902: sub start_data_table_header_row {
1.389 albertel 10903: return '<tr class="LC_header_row">'."\n";;
1.367 www 10904: }
10905:
10906: sub end_data_table_header_row {
1.389 albertel 10907: return '</tr>'."\n";;
1.367 www 10908: }
1.890 droeschl 10909:
10910: sub data_table_caption {
10911: my $caption = shift;
10912: return "<caption class=\"LC_caption\">$caption</caption>";
10913: }
1.347 albertel 10914: }
10915:
1.548 albertel 10916: =pod
10917:
10918: =item * &inhibit_menu_check($arg)
10919:
10920: Checks for a inhibitmenu state and generates output to preserve it
10921:
10922: Inputs: $arg - can be any of
10923: - undef - in which case the return value is a string
10924: to add into arguments list of a uri
10925: - 'input' - in which case the return value is a HTML
10926: <form> <input> field of type hidden to
10927: preserve the value
10928: - a url - in which case the return value is the url with
10929: the neccesary cgi args added to preserve the
10930: inhibitmenu state
10931: - a ref to a url - no return value, but the string is
10932: updated to include the neccessary cgi
10933: args to preserve the inhibitmenu state
10934:
10935: =cut
10936:
10937: sub inhibit_menu_check {
10938: my ($arg) = @_;
10939: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10940: if ($arg eq 'input') {
10941: if ($env{'form.inhibitmenu'}) {
10942: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10943: } else {
10944: return
10945: }
10946: }
10947: if ($env{'form.inhibitmenu'}) {
10948: if (ref($arg)) {
10949: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10950: } elsif ($arg eq '') {
10951: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10952: } else {
10953: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10954: }
10955: }
10956: if (!ref($arg)) {
10957: return $arg;
10958: }
10959: }
10960:
1.251 albertel 10961: ###############################################
1.182 matthew 10962:
10963: =pod
10964:
1.549 albertel 10965: =back
10966:
10967: =head1 User Information Routines
10968:
10969: =over 4
10970:
1.405 albertel 10971: =item * &get_users_function()
1.182 matthew 10972:
10973: Used by &bodytag to determine the current users primary role.
10974: Returns either 'student','coordinator','admin', or 'author'.
10975:
10976: =cut
10977:
10978: ###############################################
10979: sub get_users_function {
1.815 tempelho 10980: my $function = 'norole';
1.818 tempelho 10981: if ($env{'request.role'}=~/^(st)/) {
10982: $function='student';
10983: }
1.907 raeburn 10984: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10985: $function='coordinator';
10986: }
1.258 albertel 10987: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10988: $function='admin';
10989: }
1.826 bisitz 10990: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10991: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10992: $function='author';
10993: }
10994: return $function;
1.54 www 10995: }
1.99 www 10996:
10997: ###############################################
10998:
1.233 raeburn 10999: =pod
11000:
1.821 raeburn 11001: =item * &show_course()
11002:
11003: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
11004: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
11005:
11006: Inputs:
11007: None
11008:
11009: Outputs:
11010: Scalar: 1 if 'Course' to be used, 0 otherwise.
11011:
11012: =cut
11013:
11014: ###############################################
11015: sub show_course {
1.1408 raeburn 11016: my ($udom,$uname) = @_;
11017: if (($udom ne '') && ($uname ne '')) {
11018: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 11019: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 11020: return 0;
11021: } else {
11022: return 1;
11023: }
11024: }
11025: }
1.821 raeburn 11026: my $course = !$env{'user.adv'};
11027: if (!$env{'user.adv'}) {
11028: foreach my $env (keys(%env)) {
11029: next if ($env !~ m/^user\.priv\./);
11030: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
11031: $course = 0;
11032: last;
11033: }
11034: }
11035: }
11036: return $course;
11037: }
11038:
11039: ###############################################
11040:
11041: =pod
11042:
1.542 raeburn 11043: =item * &check_user_status()
1.274 raeburn 11044:
11045: Determines current status of supplied role for a
11046: specific user. Roles can be active, previous or future.
11047:
11048: Inputs:
11049: user's domain, user's username, course's domain,
1.375 raeburn 11050: course's number, optional section ID.
1.274 raeburn 11051:
11052: Outputs:
11053: role status: active, previous or future.
11054:
11055: =cut
11056:
11057: sub check_user_status {
1.412 raeburn 11058: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 11059: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 11060: my @uroles = keys(%userinfo);
1.274 raeburn 11061: my $srchstr;
11062: my $active_chk = 'none';
1.412 raeburn 11063: my $now = time;
1.274 raeburn 11064: if (@uroles > 0) {
1.908 raeburn 11065: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 11066: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
11067: } else {
1.412 raeburn 11068: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
11069: }
11070: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 11071: my $role_end = 0;
11072: my $role_start = 0;
11073: $active_chk = 'active';
1.412 raeburn 11074: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
11075: $role_end = $1;
11076: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
11077: $role_start = $1;
1.274 raeburn 11078: }
11079: }
11080: if ($role_start > 0) {
1.412 raeburn 11081: if ($now < $role_start) {
1.274 raeburn 11082: $active_chk = 'future';
11083: }
11084: }
11085: if ($role_end > 0) {
1.412 raeburn 11086: if ($now > $role_end) {
1.274 raeburn 11087: $active_chk = 'previous';
11088: }
11089: }
11090: }
11091: }
11092: return $active_chk;
11093: }
11094:
11095: ###############################################
11096:
11097: =pod
11098:
1.405 albertel 11099: =item * &get_sections()
1.233 raeburn 11100:
11101: Determines all the sections for a course including
11102: sections with students and sections containing other roles.
1.419 raeburn 11103: Incoming parameters:
11104:
11105: 1. domain
11106: 2. course number
11107: 3. reference to array containing roles for which sections should
11108: be gathered (optional).
11109: 4. reference to array containing status types for which sections
11110: should be gathered (optional).
11111:
11112: If the third argument is undefined, sections are gathered for any role.
11113: If the fourth argument is undefined, sections are gathered for any status.
11114: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 11115:
1.374 raeburn 11116: Returns section hash (keys are section IDs, values are
11117: number of users in each section), subject to the
1.419 raeburn 11118: optional roles filter, optional status filter
1.233 raeburn 11119:
11120: =cut
11121:
11122: ###############################################
11123: sub get_sections {
1.419 raeburn 11124: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 11125: if (!defined($cdom) || !defined($cnum)) {
11126: my $cid = $env{'request.course.id'};
11127:
11128: return if (!defined($cid));
11129:
11130: $cdom = $env{'course.'.$cid.'.domain'};
11131: $cnum = $env{'course.'.$cid.'.num'};
11132: }
11133:
11134: my %sectioncount;
1.419 raeburn 11135: my $now = time;
1.240 albertel 11136:
1.1118 raeburn 11137: my $check_students = 1;
11138: my $only_students = 0;
11139: if (ref($possible_roles) eq 'ARRAY') {
11140: if (grep(/^st$/,@{$possible_roles})) {
11141: if (@{$possible_roles} == 1) {
11142: $only_students = 1;
11143: }
11144: } else {
11145: $check_students = 0;
11146: }
11147: }
11148:
11149: if ($check_students) {
1.276 albertel 11150: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 11151: my $sec_index = &Apache::loncoursedata::CL_SECTION();
11152: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 11153: my $start_index = &Apache::loncoursedata::CL_START();
11154: my $end_index = &Apache::loncoursedata::CL_END();
11155: my $status;
1.366 albertel 11156: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 11157: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
11158: $data->[$status_index],
11159: $data->[$start_index],
11160: $data->[$end_index]);
11161: if ($stu_status eq 'Active') {
11162: $status = 'active';
11163: } elsif ($end < $now) {
11164: $status = 'previous';
11165: } elsif ($start > $now) {
11166: $status = 'future';
11167: }
11168: if ($section ne '-1' && $section !~ /^\s*$/) {
11169: if ((!defined($possible_status)) || (($status ne '') &&
11170: (grep/^\Q$status\E$/,@{$possible_status}))) {
11171: $sectioncount{$section}++;
11172: }
1.240 albertel 11173: }
11174: }
11175: }
1.1118 raeburn 11176: if ($only_students) {
11177: return %sectioncount;
11178: }
1.240 albertel 11179: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11180: foreach my $user (sort(keys(%courseroles))) {
11181: if ($user !~ /^(\w{2})/) { next; }
11182: my ($role) = ($user =~ /^(\w{2})/);
11183: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11184: my ($section,$status);
1.240 albertel 11185: if ($role eq 'cr' &&
11186: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11187: $section=$1;
11188: }
11189: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11190: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11191: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11192: if ($end == -1 && $start == -1) {
11193: next; #deleted role
11194: }
11195: if (!defined($possible_status)) {
11196: $sectioncount{$section}++;
11197: } else {
11198: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11199: $status = 'active';
11200: } elsif ($end < $now) {
11201: $status = 'future';
11202: } elsif ($start > $now) {
11203: $status = 'previous';
11204: }
11205: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11206: $sectioncount{$section}++;
11207: }
11208: }
1.233 raeburn 11209: }
1.366 albertel 11210: return %sectioncount;
1.233 raeburn 11211: }
11212:
1.274 raeburn 11213: ###############################################
1.294 raeburn 11214:
11215: =pod
1.405 albertel 11216:
11217: =item * &get_course_users()
11218:
1.275 raeburn 11219: Retrieves usernames:domains for users in the specified course
11220: with specific role(s), and access status.
11221:
11222: Incoming parameters:
1.277 albertel 11223: 1. course domain
11224: 2. course number
11225: 3. access status: users must have - either active,
1.275 raeburn 11226: previous, future, or all.
1.277 albertel 11227: 4. reference to array of permissible roles
1.288 raeburn 11228: 5. reference to array of section restrictions (optional)
11229: 6. reference to results object (hash of hashes).
11230: 7. reference to optional userdata hash
1.609 raeburn 11231: 8. reference to optional statushash
1.630 raeburn 11232: 9. flag if privileged users (except those set to unhide in
11233: course settings) should be excluded
1.609 raeburn 11234: Keys of top level results hash are roles.
1.275 raeburn 11235: Keys of inner hashes are username:domain, with
11236: values set to access type.
1.288 raeburn 11237: Optional userdata hash returns an array with arguments in the
11238: same order as loncoursedata::get_classlist() for student data.
11239:
1.609 raeburn 11240: Optional statushash returns
11241:
1.288 raeburn 11242: Entries for end, start, section and status are blank because
11243: of the possibility of multiple values for non-student roles.
11244:
1.275 raeburn 11245: =cut
1.405 albertel 11246:
1.275 raeburn 11247: ###############################################
1.405 albertel 11248:
1.275 raeburn 11249: sub get_course_users {
1.630 raeburn 11250: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11251: my %idx = ();
1.419 raeburn 11252: my %seclists;
1.288 raeburn 11253:
11254: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11255: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11256: $idx{end} = &Apache::loncoursedata::CL_END();
11257: $idx{start} = &Apache::loncoursedata::CL_START();
11258: $idx{id} = &Apache::loncoursedata::CL_ID();
11259: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11260: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11261: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11262:
1.290 albertel 11263: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11264: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11265: my $now = time;
1.277 albertel 11266: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11267: my $match = 0;
1.412 raeburn 11268: my $secmatch = 0;
1.419 raeburn 11269: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11270: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11271: if ($section eq '') {
11272: $section = 'none';
11273: }
1.291 albertel 11274: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11275: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11276: $secmatch = 1;
11277: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11278: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11279: $secmatch = 1;
11280: }
11281: } else {
1.419 raeburn 11282: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11283: $secmatch = 1;
11284: }
1.290 albertel 11285: }
1.412 raeburn 11286: if (!$secmatch) {
11287: next;
11288: }
1.419 raeburn 11289: }
1.275 raeburn 11290: if (defined($$types{'active'})) {
1.288 raeburn 11291: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11292: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11293: $match = 1;
1.275 raeburn 11294: }
11295: }
11296: if (defined($$types{'previous'})) {
1.609 raeburn 11297: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11298: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11299: $match = 1;
1.275 raeburn 11300: }
11301: }
11302: if (defined($$types{'future'})) {
1.609 raeburn 11303: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11304: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11305: $match = 1;
1.275 raeburn 11306: }
11307: }
1.609 raeburn 11308: if ($match) {
11309: push(@{$seclists{$student}},$section);
11310: if (ref($userdata) eq 'HASH') {
11311: $$userdata{$student} = $$classlist{$student};
11312: }
11313: if (ref($statushash) eq 'HASH') {
11314: $statushash->{$student}{'st'}{$section} = $status;
11315: }
1.288 raeburn 11316: }
1.275 raeburn 11317: }
11318: }
1.412 raeburn 11319: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11320: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11321: my $now = time;
1.609 raeburn 11322: my %displaystatus = ( previous => 'Expired',
11323: active => 'Active',
11324: future => 'Future',
11325: );
1.1121 raeburn 11326: my (%nothide,@possdoms);
1.630 raeburn 11327: if ($hidepriv) {
11328: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11329: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11330: if ($user !~ /:/) {
11331: $nothide{join(':',split(/[\@]/,$user))}=1;
11332: } else {
11333: $nothide{$user} = 1;
11334: }
11335: }
1.1121 raeburn 11336: my @possdoms = ($cdom);
11337: if ($coursehash{'checkforpriv'}) {
11338: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11339: }
1.630 raeburn 11340: }
1.439 raeburn 11341: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11342: my $match = 0;
1.412 raeburn 11343: my $secmatch = 0;
1.439 raeburn 11344: my $status;
1.412 raeburn 11345: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11346: $user =~ s/:$//;
1.439 raeburn 11347: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11348: if ($end == -1 || $start == -1) {
11349: next;
11350: }
11351: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11352: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11353: my ($uname,$udom) = split(/:/,$user);
11354: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11355: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11356: $secmatch = 1;
11357: } elsif ($usec eq '') {
1.420 albertel 11358: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11359: $secmatch = 1;
11360: }
11361: } else {
11362: if (grep(/^\Q$usec\E$/,@{$sections})) {
11363: $secmatch = 1;
11364: }
11365: }
11366: if (!$secmatch) {
11367: next;
11368: }
1.288 raeburn 11369: }
1.419 raeburn 11370: if ($usec eq '') {
11371: $usec = 'none';
11372: }
1.275 raeburn 11373: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11374: if ($hidepriv) {
1.1121 raeburn 11375: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11376: (!$nothide{$uname.':'.$udom})) {
11377: next;
11378: }
11379: }
1.503 raeburn 11380: if ($end > 0 && $end < $now) {
1.439 raeburn 11381: $status = 'previous';
11382: } elsif ($start > $now) {
11383: $status = 'future';
11384: } else {
11385: $status = 'active';
11386: }
1.277 albertel 11387: foreach my $type (keys(%{$types})) {
1.275 raeburn 11388: if ($status eq $type) {
1.420 albertel 11389: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11390: push(@{$$users{$role}{$user}},$type);
11391: }
1.288 raeburn 11392: $match = 1;
11393: }
11394: }
1.419 raeburn 11395: if (($match) && (ref($userdata) eq 'HASH')) {
11396: if (!exists($$userdata{$uname.':'.$udom})) {
11397: &get_user_info($udom,$uname,\%idx,$userdata);
11398: }
1.420 albertel 11399: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11400: push(@{$seclists{$uname.':'.$udom}},$usec);
11401: }
1.609 raeburn 11402: if (ref($statushash) eq 'HASH') {
11403: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11404: }
1.275 raeburn 11405: }
11406: }
11407: }
11408: }
1.290 albertel 11409: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11410: if ((defined($cdom)) && (defined($cnum))) {
11411: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11412: if ( defined($csettings{'internal.courseowner'}) ) {
11413: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11414: next if ($owner eq '');
11415: my ($ownername,$ownerdom);
11416: if ($owner =~ /^([^:]+):([^:]+)$/) {
11417: $ownername = $1;
11418: $ownerdom = $2;
11419: } else {
11420: $ownername = $owner;
11421: $ownerdom = $cdom;
11422: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11423: }
11424: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11425: if (defined($userdata) &&
1.609 raeburn 11426: !exists($$userdata{$owner})) {
11427: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11428: if (!grep(/^none$/,@{$seclists{$owner}})) {
11429: push(@{$seclists{$owner}},'none');
11430: }
11431: if (ref($statushash) eq 'HASH') {
11432: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11433: }
1.290 albertel 11434: }
1.279 raeburn 11435: }
11436: }
11437: }
1.419 raeburn 11438: foreach my $user (keys(%seclists)) {
11439: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11440: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11441: }
1.275 raeburn 11442: }
11443: return;
11444: }
11445:
1.288 raeburn 11446: sub get_user_info {
11447: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11448: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11449: &plainname($uname,$udom,'lastname');
1.291 albertel 11450: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11451: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11452: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11453: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11454: return;
11455: }
1.275 raeburn 11456:
1.472 raeburn 11457: ###############################################
11458:
11459: =pod
11460:
11461: =item * &get_user_quota()
11462:
1.1134 raeburn 11463: Retrieves quota assigned for storage of user files.
11464: Default is to report quota for portfolio files.
1.472 raeburn 11465:
11466: Incoming parameters:
11467: 1. user's username
11468: 2. user's domain
1.1134 raeburn 11469: 3. quota name - portfolio, author, or course
1.1136 raeburn 11470: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11471: 4. crstype - official, unofficial, textbook, placement or community,
11472: if quota name is course
1.472 raeburn 11473:
11474: Returns:
1.1163 raeburn 11475: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11476: 2. (Optional) Type of setting: custom or default
11477: (individually assigned or default for user's
11478: institutional status).
11479: 3. (Optional) - User's institutional status (e.g., faculty, staff
11480: or student - types as defined in localenroll::inst_usertypes
11481: for user's domain, which determines default quota for user.
11482: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11483:
11484: If a value has been stored in the user's environment,
1.536 raeburn 11485: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11486: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11487:
11488: =cut
11489:
11490: ###############################################
11491:
11492:
11493: sub get_user_quota {
1.1136 raeburn 11494: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11495: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11496: if (!defined($udom)) {
11497: $udom = $env{'user.domain'};
11498: }
11499: if (!defined($uname)) {
11500: $uname = $env{'user.name'};
11501: }
11502: if (($udom eq '' || $uname eq '') ||
11503: ($udom eq 'public') && ($uname eq 'public')) {
11504: $quota = 0;
1.536 raeburn 11505: $quotatype = 'default';
11506: $defquota = 0;
1.472 raeburn 11507: } else {
1.536 raeburn 11508: my $inststatus;
1.1134 raeburn 11509: if ($quotaname eq 'course') {
11510: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11511: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11512: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11513: } else {
11514: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11515: $quota = $cenv{'internal.uploadquota'};
11516: }
1.536 raeburn 11517: } else {
1.1134 raeburn 11518: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11519: if ($quotaname eq 'author') {
11520: $quota = $env{'environment.authorquota'};
11521: } else {
11522: $quota = $env{'environment.portfolioquota'};
11523: }
11524: $inststatus = $env{'environment.inststatus'};
11525: } else {
11526: my %userenv =
11527: &Apache::lonnet::get('environment',['portfolioquota',
11528: 'authorquota','inststatus'],$udom,$uname);
11529: my ($tmp) = keys(%userenv);
11530: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11531: if ($quotaname eq 'author') {
11532: $quota = $userenv{'authorquota'};
11533: } else {
11534: $quota = $userenv{'portfolioquota'};
11535: }
11536: $inststatus = $userenv{'inststatus'};
11537: } else {
11538: undef(%userenv);
11539: }
11540: }
11541: }
11542: if ($quota eq '' || wantarray) {
11543: if ($quotaname eq 'course') {
11544: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11545: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11546: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11547: ($crstype eq 'placement')) {
1.1136 raeburn 11548: $defquota = $domdefs{$crstype.'quota'};
11549: }
11550: if ($defquota eq '') {
11551: $defquota = 500;
11552: }
1.1134 raeburn 11553: } else {
11554: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11555: }
11556: if ($quota eq '') {
11557: $quota = $defquota;
11558: $quotatype = 'default';
11559: } else {
11560: $quotatype = 'custom';
11561: }
1.472 raeburn 11562: }
11563: }
1.536 raeburn 11564: if (wantarray) {
11565: return ($quota,$quotatype,$settingstatus,$defquota);
11566: } else {
11567: return $quota;
11568: }
1.472 raeburn 11569: }
11570:
11571: ###############################################
11572:
11573: =pod
11574:
11575: =item * &default_quota()
11576:
1.536 raeburn 11577: Retrieves default quota assigned for storage of user portfolio files,
11578: given an (optional) user's institutional status.
1.472 raeburn 11579:
11580: Incoming parameters:
1.1142 raeburn 11581:
1.472 raeburn 11582: 1. domain
1.536 raeburn 11583: 2. (Optional) institutional status(es). This is a : separated list of
11584: status types (e.g., faculty, staff, student etc.)
11585: which apply to the user for whom the default is being retrieved.
11586: If the institutional status string in undefined, the domain
1.1134 raeburn 11587: default quota will be returned.
11588: 3. quota name - portfolio, author, or course
11589: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11590:
11591: Returns:
1.1142 raeburn 11592:
1.1163 raeburn 11593: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11594: 2. (Optional) institutional type which determined the value of the
11595: default quota.
1.472 raeburn 11596:
11597: If a value has been stored in the domain's configuration db,
11598: it will return that, otherwise it returns 20 (for backwards
11599: compatibility with domains which have not set up a configuration
1.1163 raeburn 11600: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11601:
1.536 raeburn 11602: If the user's status includes multiple types (e.g., staff and student),
11603: the largest default quota which applies to the user determines the
11604: default quota returned.
11605:
1.472 raeburn 11606: =cut
11607:
11608: ###############################################
11609:
11610:
11611: sub default_quota {
1.1134 raeburn 11612: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11613: my ($defquota,$settingstatus);
11614: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11615: ['quotas'],$udom);
1.1134 raeburn 11616: my $key = 'defaultquota';
11617: if ($quotaname eq 'author') {
11618: $key = 'authorquota';
11619: }
1.622 raeburn 11620: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11621: if ($inststatus ne '') {
1.765 raeburn 11622: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11623: foreach my $item (@statuses) {
1.1134 raeburn 11624: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11625: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11626: if ($defquota eq '') {
1.1134 raeburn 11627: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11628: $settingstatus = $item;
1.1134 raeburn 11629: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11630: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11631: $settingstatus = $item;
11632: }
11633: }
1.1134 raeburn 11634: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11635: if ($quotahash{'quotas'}{$item} ne '') {
11636: if ($defquota eq '') {
11637: $defquota = $quotahash{'quotas'}{$item};
11638: $settingstatus = $item;
11639: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11640: $defquota = $quotahash{'quotas'}{$item};
11641: $settingstatus = $item;
11642: }
1.536 raeburn 11643: }
11644: }
11645: }
11646: }
11647: if ($defquota eq '') {
1.1134 raeburn 11648: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11649: $defquota = $quotahash{'quotas'}{$key}{'default'};
11650: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11651: $defquota = $quotahash{'quotas'}{'default'};
11652: }
1.536 raeburn 11653: $settingstatus = 'default';
1.1139 raeburn 11654: if ($defquota eq '') {
11655: if ($quotaname eq 'author') {
11656: $defquota = 500;
11657: }
11658: }
1.536 raeburn 11659: }
11660: } else {
11661: $settingstatus = 'default';
1.1134 raeburn 11662: if ($quotaname eq 'author') {
11663: $defquota = 500;
11664: } else {
11665: $defquota = 20;
11666: }
1.536 raeburn 11667: }
11668: if (wantarray) {
11669: return ($defquota,$settingstatus);
1.472 raeburn 11670: } else {
1.536 raeburn 11671: return $defquota;
1.472 raeburn 11672: }
11673: }
11674:
1.1135 raeburn 11675: ###############################################
11676:
11677: =pod
11678:
1.1136 raeburn 11679: =item * &excess_filesize_warning()
1.1135 raeburn 11680:
11681: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11682: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11683: space to be exceeded.
1.1136 raeburn 11684:
11685: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11686: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11687:
1.1165 raeburn 11688: Inputs: 7
1.1136 raeburn 11689: 1. username or coursenum
1.1135 raeburn 11690: 2. domain
1.1136 raeburn 11691: 3. context ('author' or 'course')
1.1135 raeburn 11692: 4. filename of file for which action is being requested
11693: 5. filesize (kB) of file
11694: 6. action being taken: copy or upload.
1.1237 raeburn 11695: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11696:
11697: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11698: otherwise return null.
11699:
11700: =back
1.1135 raeburn 11701:
11702: =cut
11703:
1.1136 raeburn 11704: sub excess_filesize_warning {
1.1165 raeburn 11705: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11706: my $current_disk_usage = 0;
1.1165 raeburn 11707: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11708: if ($context eq 'author') {
11709: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11710: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11711: } else {
11712: foreach my $subdir ('docs','supplemental') {
11713: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11714: }
11715: }
1.1135 raeburn 11716: $disk_quota = int($disk_quota * 1000);
11717: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11718: return '<p class="LC_warning">'.
1.1135 raeburn 11719: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11720: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11721: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11722: $disk_quota,$current_disk_usage).
11723: '</p>';
11724: }
11725: return;
11726: }
11727:
11728: ###############################################
11729:
11730:
1.1136 raeburn 11731:
11732:
1.384 raeburn 11733: sub get_secgrprole_info {
11734: my ($cdom,$cnum,$needroles,$type) = @_;
11735: my %sections_count = &get_sections($cdom,$cnum);
11736: my @sections = (sort {$a <=> $b} keys(%sections_count));
11737: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11738: my @groups = sort(keys(%curr_groups));
11739: my $allroles = [];
11740: my $rolehash;
11741: my $accesshash = {
11742: active => 'Currently has access',
11743: future => 'Will have future access',
11744: previous => 'Previously had access',
11745: };
11746: if ($needroles) {
11747: $rolehash = {'all' => 'all'};
1.385 albertel 11748: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11749: if (&Apache::lonnet::error(%user_roles)) {
11750: undef(%user_roles);
11751: }
11752: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11753: my ($role)=split(/\:/,$item,2);
11754: if ($role eq 'cr') { next; }
11755: if ($role =~ /^cr/) {
11756: $$rolehash{$role} = (split('/',$role))[3];
11757: } else {
11758: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11759: }
11760: }
11761: foreach my $key (sort(keys(%{$rolehash}))) {
11762: push(@{$allroles},$key);
11763: }
11764: push (@{$allroles},'st');
11765: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11766: }
11767: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11768: }
11769:
1.555 raeburn 11770: sub user_picker {
1.1279 raeburn 11771: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11772: my $currdom = $dom;
1.1253 raeburn 11773: my @alldoms = &Apache::lonnet::all_domains();
11774: if (@alldoms == 1) {
11775: my %domsrch = &Apache::lonnet::get_dom('configuration',
11776: ['directorysrch'],$alldoms[0]);
11777: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11778: my $showdom = $domdesc;
11779: if ($showdom eq '') {
11780: $showdom = $dom;
11781: }
11782: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11783: if ((!$domsrch{'directorysrch'}{'available'}) &&
11784: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11785: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11786: }
11787: }
11788: }
1.555 raeburn 11789: my %curr_selected = (
11790: srchin => 'dom',
1.580 raeburn 11791: srchby => 'lastname',
1.555 raeburn 11792: );
11793: my $srchterm;
1.625 raeburn 11794: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11795: if ($srch->{'srchby'} ne '') {
11796: $curr_selected{'srchby'} = $srch->{'srchby'};
11797: }
11798: if ($srch->{'srchin'} ne '') {
11799: $curr_selected{'srchin'} = $srch->{'srchin'};
11800: }
11801: if ($srch->{'srchtype'} ne '') {
11802: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11803: }
11804: if ($srch->{'srchdomain'} ne '') {
11805: $currdom = $srch->{'srchdomain'};
11806: }
11807: $srchterm = $srch->{'srchterm'};
11808: }
1.1222 damieng 11809: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11810: 'usr' => 'Search criteria',
1.563 raeburn 11811: 'doma' => 'Domain/institution to search',
1.558 albertel 11812: 'uname' => 'username',
11813: 'lastname' => 'last name',
1.555 raeburn 11814: 'lastfirst' => 'last name, first name',
1.558 albertel 11815: 'crs' => 'in this course',
1.576 raeburn 11816: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11817: 'alc' => 'all LON-CAPA',
1.573 raeburn 11818: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11819: 'exact' => 'is',
11820: 'contains' => 'contains',
1.569 raeburn 11821: 'begins' => 'begins with',
1.1222 damieng 11822: );
11823: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11824: 'youm' => "You must include some text to search for.",
11825: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11826: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11827: 'yomc' => "You must choose a domain when using an institutional directory search.",
11828: 'ymcd' => "You must choose a domain when using a domain search.",
11829: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11830: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11831: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11832: );
1.1222 damieng 11833: &html_escape(\%html_lt);
11834: &js_escape(\%js_lt);
1.1255 raeburn 11835: my $domform;
1.1277 raeburn 11836: my $allow_blank = 1;
1.1255 raeburn 11837: if ($fixeddom) {
1.1277 raeburn 11838: $allow_blank = 0;
11839: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11840: } else {
1.1287 raeburn 11841: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11842: my ($trusted,$untrusted);
1.1287 raeburn 11843: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11844: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11845: } elsif ($context eq 'author') {
1.1288 raeburn 11846: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11847: } elsif ($context eq 'domain') {
1.1288 raeburn 11848: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11849: }
1.1288 raeburn 11850: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11851: }
1.563 raeburn 11852: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11853:
11854: my @srchins = ('crs','dom','alc','instd');
11855:
11856: foreach my $option (@srchins) {
11857: # FIXME 'alc' option unavailable until
11858: # loncreateuser::print_user_query_page()
11859: # has been completed.
11860: next if ($option eq 'alc');
1.880 raeburn 11861: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11862: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11863: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11864: if ($curr_selected{'srchin'} eq $option) {
11865: $srchinsel .= '
1.1222 damieng 11866: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11867: } else {
11868: $srchinsel .= '
1.1222 damieng 11869: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11870: }
1.555 raeburn 11871: }
1.563 raeburn 11872: $srchinsel .= "\n </select>\n";
1.555 raeburn 11873:
11874: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11875: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11876: if ($curr_selected{'srchby'} eq $option) {
11877: $srchbysel .= '
1.1222 damieng 11878: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11879: } else {
11880: $srchbysel .= '
1.1222 damieng 11881: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11882: }
11883: }
11884: $srchbysel .= "\n </select>\n";
11885:
11886: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11887: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11888: if ($curr_selected{'srchtype'} eq $option) {
11889: $srchtypesel .= '
1.1222 damieng 11890: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11891: } else {
11892: $srchtypesel .= '
1.1222 damieng 11893: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11894: }
11895: }
11896: $srchtypesel .= "\n </select>\n";
11897:
1.558 albertel 11898: my ($newuserscript,$new_user_create);
1.994 raeburn 11899: my $context_dom = $env{'request.role.domain'};
11900: if ($context eq 'requestcrs') {
11901: if ($env{'form.coursedom'} ne '') {
11902: $context_dom = $env{'form.coursedom'};
11903: }
11904: }
1.556 raeburn 11905: if ($forcenewuser) {
1.576 raeburn 11906: if (ref($srch) eq 'HASH') {
1.994 raeburn 11907: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11908: if ($cancreate) {
11909: $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>';
11910: } else {
1.799 bisitz 11911: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11912: my %usertypetext = (
11913: official => 'institutional',
11914: unofficial => 'non-institutional',
11915: );
1.799 bisitz 11916: $new_user_create = '<p class="LC_warning">'
11917: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11918: .' '
11919: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11920: ,'<a href="'.$helplink.'">','</a>')
11921: .'</p><br />';
1.627 raeburn 11922: }
1.576 raeburn 11923: }
11924: }
11925:
1.556 raeburn 11926: $newuserscript = <<"ENDSCRIPT";
11927:
1.570 raeburn 11928: function setSearch(createnew,callingForm) {
1.556 raeburn 11929: if (createnew == 1) {
1.570 raeburn 11930: for (var i=0; i<callingForm.srchby.length; i++) {
11931: if (callingForm.srchby.options[i].value == 'uname') {
11932: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11933: }
11934: }
1.570 raeburn 11935: for (var i=0; i<callingForm.srchin.length; i++) {
11936: if ( callingForm.srchin.options[i].value == 'dom') {
11937: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11938: }
11939: }
1.570 raeburn 11940: for (var i=0; i<callingForm.srchtype.length; i++) {
11941: if (callingForm.srchtype.options[i].value == 'exact') {
11942: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11943: }
11944: }
1.570 raeburn 11945: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11946: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11947: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11948: }
11949: }
11950: }
11951: }
11952: ENDSCRIPT
1.558 albertel 11953:
1.556 raeburn 11954: }
11955:
1.555 raeburn 11956: my $output = <<"END_BLOCK";
1.556 raeburn 11957: <script type="text/javascript">
1.824 bisitz 11958: // <![CDATA[
1.570 raeburn 11959: function validateEntry(callingForm) {
1.558 albertel 11960:
1.556 raeburn 11961: var checkok = 1;
1.558 albertel 11962: var srchin;
1.570 raeburn 11963: for (var i=0; i<callingForm.srchin.length; i++) {
11964: if ( callingForm.srchin[i].checked ) {
11965: srchin = callingForm.srchin[i].value;
1.558 albertel 11966: }
11967: }
11968:
1.570 raeburn 11969: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11970: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11971: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11972: var srchterm = callingForm.srchterm.value;
11973: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11974: var msg = "";
11975:
11976: if (srchterm == "") {
11977: checkok = 0;
1.1222 damieng 11978: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11979: }
11980:
1.569 raeburn 11981: if (srchtype== 'begins') {
11982: if (srchterm.length < 2) {
11983: checkok = 0;
1.1222 damieng 11984: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11985: }
11986: }
11987:
1.556 raeburn 11988: if (srchtype== 'contains') {
11989: if (srchterm.length < 3) {
11990: checkok = 0;
1.1222 damieng 11991: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11992: }
11993: }
11994: if (srchin == 'instd') {
11995: if (srchdomain == '') {
11996: checkok = 0;
1.1222 damieng 11997: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11998: }
11999: }
12000: if (srchin == 'dom') {
12001: if (srchdomain == '') {
12002: checkok = 0;
1.1222 damieng 12003: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 12004: }
12005: }
12006: if (srchby == 'lastfirst') {
12007: if (srchterm.indexOf(",") == -1) {
12008: checkok = 0;
1.1222 damieng 12009: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 12010: }
12011: if (srchterm.indexOf(",") == srchterm.length -1) {
12012: checkok = 0;
1.1222 damieng 12013: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 12014: }
12015: }
12016: if (checkok == 0) {
1.1222 damieng 12017: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 12018: return;
12019: }
12020: if (checkok == 1) {
1.570 raeburn 12021: callingForm.submit();
1.556 raeburn 12022: }
12023: }
12024:
12025: $newuserscript
12026:
1.824 bisitz 12027: // ]]>
1.556 raeburn 12028: </script>
1.558 albertel 12029:
12030: $new_user_create
12031:
1.555 raeburn 12032: END_BLOCK
1.558 albertel 12033:
1.876 raeburn 12034: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 12035: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 12036: $domform.
12037: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 12038: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 12039: $srchbysel.
12040: $srchtypesel.
12041: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
12042: $srchinsel.
12043: &Apache::lonhtmlcommon::row_closure(1).
12044: &Apache::lonhtmlcommon::end_pick_box().
12045: '<br />';
1.1253 raeburn 12046: return ($output,1);
1.555 raeburn 12047: }
12048:
1.612 raeburn 12049: sub user_rule_check {
1.615 raeburn 12050: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 12051: my ($response,%inst_response);
1.612 raeburn 12052: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 12053: if (keys(%{$usershash}) > 1) {
12054: my (%by_username,%by_id,%userdoms);
12055: my $checkid;
12056: if (ref($checks) eq 'HASH') {
12057: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
12058: $checkid = 1;
12059: }
12060: }
12061: foreach my $user (keys(%{$usershash})) {
12062: my ($uname,$udom) = split(/:/,$user);
12063: if ($checkid) {
12064: if (ref($usershash->{$user}) eq 'HASH') {
12065: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 12066: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 12067: $userdoms{$udom} = 1;
1.1227 raeburn 12068: if (ref($inst_results) eq 'HASH') {
12069: $inst_results->{$uname.':'.$udom} = {};
12070: }
1.1226 raeburn 12071: }
12072: }
12073: } else {
12074: $by_username{$udom}{$uname} = 1;
12075: $userdoms{$udom} = 1;
1.1227 raeburn 12076: if (ref($inst_results) eq 'HASH') {
12077: $inst_results->{$uname.':'.$udom} = {};
12078: }
1.1226 raeburn 12079: }
12080: }
12081: foreach my $udom (keys(%userdoms)) {
12082: if (!$got_rules->{$udom}) {
12083: my %domconfig = &Apache::lonnet::get_dom('configuration',
12084: ['usercreation'],$udom);
12085: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12086: foreach my $item ('username','id') {
12087: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 12088: $$curr_rules{$udom}{$item} =
12089: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 12090: }
12091: }
12092: }
12093: $got_rules->{$udom} = 1;
12094: }
1.612 raeburn 12095: }
1.1226 raeburn 12096: if ($checkid) {
12097: foreach my $udom (keys(%by_id)) {
12098: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
12099: if ($outcome eq 'ok') {
1.1227 raeburn 12100: foreach my $id (keys(%{$by_id{$udom}})) {
12101: my $uname = $by_id{$udom}{$id};
12102: $inst_response{$uname.':'.$udom} = $outcome;
12103: }
1.1226 raeburn 12104: if (ref($results) eq 'HASH') {
12105: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 12106: if (exists($inst_response{$uname.':'.$udom})) {
12107: $inst_response{$uname.':'.$udom} = $outcome;
12108: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12109: }
1.1226 raeburn 12110: }
12111: }
12112: }
1.612 raeburn 12113: }
1.615 raeburn 12114: } else {
1.1226 raeburn 12115: foreach my $udom (keys(%by_username)) {
12116: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
12117: if ($outcome eq 'ok') {
1.1227 raeburn 12118: foreach my $uname (keys(%{$by_username{$udom}})) {
12119: $inst_response{$uname.':'.$udom} = $outcome;
12120: }
1.1226 raeburn 12121: if (ref($results) eq 'HASH') {
12122: foreach my $uname (keys(%{$results})) {
12123: $inst_results->{$uname.':'.$udom} = $results->{$uname};
12124: }
12125: }
12126: }
12127: }
1.612 raeburn 12128: }
1.1226 raeburn 12129: } elsif (keys(%{$usershash}) == 1) {
12130: my $user = (keys(%{$usershash}))[0];
12131: my ($uname,$udom) = split(/:/,$user);
12132: if (($udom ne '') && ($uname ne '')) {
12133: if (ref($usershash->{$user}) eq 'HASH') {
12134: if (ref($checks) eq 'HASH') {
12135: if (defined($checks->{'username'})) {
12136: ($inst_response{$user},%{$inst_results->{$user}}) =
12137: &Apache::lonnet::get_instuser($udom,$uname);
12138: } elsif (defined($checks->{'id'})) {
12139: if ($usershash->{$user}->{'id'} ne '') {
12140: ($inst_response{$user},%{$inst_results->{$user}}) =
12141: &Apache::lonnet::get_instuser($udom,undef,
12142: $usershash->{$user}->{'id'});
12143: } else {
12144: ($inst_response{$user},%{$inst_results->{$user}}) =
12145: &Apache::lonnet::get_instuser($udom,$uname);
12146: }
1.585 raeburn 12147: }
1.1226 raeburn 12148: } else {
12149: ($inst_response{$user},%{$inst_results->{$user}}) =
12150: &Apache::lonnet::get_instuser($udom,$uname);
12151: return;
12152: }
12153: if (!$got_rules->{$udom}) {
12154: my %domconfig = &Apache::lonnet::get_dom('configuration',
12155: ['usercreation'],$udom);
12156: if (ref($domconfig{'usercreation'}) eq 'HASH') {
12157: foreach my $item ('username','id') {
12158: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
12159: $$curr_rules{$udom}{$item} =
12160: $domconfig{'usercreation'}{$item.'_rule'};
12161: }
12162: }
12163: }
12164: $got_rules->{$udom} = 1;
1.585 raeburn 12165: }
12166: }
1.1226 raeburn 12167: } else {
12168: return;
12169: }
12170: } else {
12171: return;
12172: }
12173: foreach my $user (keys(%{$usershash})) {
12174: my ($uname,$udom) = split(/:/,$user);
12175: next if (($udom eq '') || ($uname eq ''));
12176: my $id;
1.1227 raeburn 12177: if (ref($inst_results) eq 'HASH') {
12178: if (ref($inst_results->{$user}) eq 'HASH') {
12179: $id = $inst_results->{$user}->{'id'};
12180: }
12181: }
12182: if ($id eq '') {
12183: if (ref($usershash->{$user})) {
12184: $id = $usershash->{$user}->{'id'};
12185: }
1.585 raeburn 12186: }
1.612 raeburn 12187: foreach my $item (keys(%{$checks})) {
12188: if (ref($$curr_rules{$udom}) eq 'HASH') {
12189: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12190: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12191: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12192: $$curr_rules{$udom}{$item});
1.612 raeburn 12193: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12194: if ($rule_check{$rule}) {
12195: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12196: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12197: if (ref($inst_results) eq 'HASH') {
12198: if (ref($inst_results->{$user}) eq 'HASH') {
12199: if (keys(%{$inst_results->{$user}}) == 0) {
12200: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12201: } elsif ($item eq 'id') {
12202: if ($inst_results->{$user}->{'id'} eq '') {
12203: $$alerts{$item}{$udom}{$uname} = 1;
12204: }
1.615 raeburn 12205: }
1.612 raeburn 12206: }
12207: }
1.615 raeburn 12208: }
12209: last;
1.585 raeburn 12210: }
12211: }
12212: }
12213: }
12214: }
12215: }
12216: }
12217: }
1.612 raeburn 12218: return;
12219: }
12220:
12221: sub user_rule_formats {
12222: my ($domain,$domdesc,$curr_rules,$check) = @_;
12223: my %text = (
12224: 'username' => 'Usernames',
12225: 'id' => 'IDs',
12226: );
12227: my $output;
12228: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12229: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12230: if (@{$ruleorder} > 0) {
1.1102 raeburn 12231: $output = '<br />'.
12232: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12233: '<span class="LC_cusr_emph">','</span>',$domdesc).
12234: ' <ul>';
1.612 raeburn 12235: foreach my $rule (@{$ruleorder}) {
12236: if (ref($curr_rules) eq 'ARRAY') {
12237: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12238: if (ref($rules->{$rule}) eq 'HASH') {
12239: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12240: $rules->{$rule}{'desc'}.'</li>';
12241: }
12242: }
12243: }
12244: }
12245: $output .= '</ul>';
12246: }
12247: }
12248: return $output;
12249: }
12250:
12251: sub instrule_disallow_msg {
1.615 raeburn 12252: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12253: my $response;
12254: my %text = (
12255: item => 'username',
12256: items => 'usernames',
12257: match => 'matches',
12258: do => 'does',
12259: action => 'a username',
12260: one => 'one',
12261: );
12262: if ($count > 1) {
12263: $text{'item'} = 'usernames';
12264: $text{'match'} ='match';
12265: $text{'do'} = 'do';
12266: $text{'action'} = 'usernames',
12267: $text{'one'} = 'ones';
12268: }
12269: if ($checkitem eq 'id') {
12270: $text{'items'} = 'IDs';
12271: $text{'item'} = 'ID';
12272: $text{'action'} = 'an ID';
1.615 raeburn 12273: if ($count > 1) {
12274: $text{'item'} = 'IDs';
12275: $text{'action'} = 'IDs';
12276: }
1.612 raeburn 12277: }
1.674 bisitz 12278: $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 12279: if ($mode eq 'upload') {
12280: if ($checkitem eq 'username') {
12281: $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'}.");
12282: } elsif ($checkitem eq 'id') {
1.674 bisitz 12283: $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 12284: }
1.669 raeburn 12285: } elsif ($mode eq 'selfcreate') {
12286: if ($checkitem eq 'id') {
12287: $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.");
12288: }
1.615 raeburn 12289: } else {
12290: if ($checkitem eq 'username') {
12291: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12292: } elsif ($checkitem eq 'id') {
12293: $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.");
12294: }
1.612 raeburn 12295: }
12296: return $response;
1.585 raeburn 12297: }
12298:
1.624 raeburn 12299: sub personal_data_fieldtitles {
12300: my %fieldtitles = &Apache::lonlocal::texthash (
12301: id => 'Student/Employee ID',
12302: permanentemail => 'E-mail address',
12303: lastname => 'Last Name',
12304: firstname => 'First Name',
12305: middlename => 'Middle Name',
12306: generation => 'Generation',
12307: gen => 'Generation',
1.765 raeburn 12308: inststatus => 'Affiliation',
1.624 raeburn 12309: );
12310: return %fieldtitles;
12311: }
12312:
1.642 raeburn 12313: sub sorted_inst_types {
12314: my ($dom) = @_;
1.1185 raeburn 12315: my ($usertypes,$order);
12316: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12317: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12318: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12319: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12320: } else {
12321: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12322: }
1.642 raeburn 12323: my $othertitle = &mt('All users');
12324: if ($env{'request.course.id'}) {
1.668 raeburn 12325: $othertitle = &mt('Any users');
1.642 raeburn 12326: }
12327: my @types;
12328: if (ref($order) eq 'ARRAY') {
12329: @types = @{$order};
12330: }
12331: if (@types == 0) {
12332: if (ref($usertypes) eq 'HASH') {
12333: @types = sort(keys(%{$usertypes}));
12334: }
12335: }
12336: if (keys(%{$usertypes}) > 0) {
12337: $othertitle = &mt('Other users');
12338: }
12339: return ($othertitle,$usertypes,\@types);
12340: }
12341:
1.645 raeburn 12342: sub get_institutional_codes {
1.1361 raeburn 12343: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12344: # Get complete list of course sections to update
12345: my @currsections = ();
12346: my @currxlists = ();
1.1361 raeburn 12347: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12348: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12349: my $crskey = $crs.':'.$coursecode;
12350: @{$unclutteredsec{$crskey}} = ();
12351: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12352:
12353: if ($$settings{'internal.sectionnums'} ne '') {
12354: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12355: }
12356:
12357: if ($$settings{'internal.crosslistings'} ne '') {
12358: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12359: }
12360:
12361: if (@currxlists > 0) {
1.1361 raeburn 12362: foreach my $xl (@currxlists) {
12363: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12364: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12365: push(@{$allcourses},$1);
1.645 raeburn 12366: $$LC_code{$1} = $2;
12367: }
12368: }
12369: }
12370: }
1.1361 raeburn 12371:
1.645 raeburn 12372: if (@currsections > 0) {
1.1361 raeburn 12373: foreach my $sec (@currsections) {
12374: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12375: my $instsec = $1;
1.645 raeburn 12376: my $lc_sec = $2;
1.1361 raeburn 12377: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12378: push(@{$unclutteredsec{$crskey}},$instsec);
12379: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12380: }
12381: }
12382: }
12383: }
12384:
12385: if (@{$unclutteredsec{$crskey}} > 0) {
12386: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12387: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12388: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12389: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12390: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12391: push(@{$allcourses},$sec);
1.1361 raeburn 12392: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12393: }
12394: }
12395: }
12396: }
12397: return;
12398: }
12399:
1.971 raeburn 12400: sub get_standard_codeitems {
12401: return ('Year','Semester','Department','Number','Section');
12402: }
12403:
1.112 bowersj2 12404: =pod
12405:
1.780 raeburn 12406: =head1 Slot Helpers
12407:
12408: =over 4
12409:
12410: =item * sorted_slots()
12411:
1.1040 raeburn 12412: Sorts an array of slot names in order of an optional sort key,
12413: default sort is by slot start time (earliest first).
1.780 raeburn 12414:
12415: Inputs:
12416:
12417: =over 4
12418:
12419: slotsarr - Reference to array of unsorted slot names.
12420:
12421: slots - Reference to hash of hash, where outer hash keys are slot names.
12422:
1.1040 raeburn 12423: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12424:
1.549 albertel 12425: =back
12426:
1.780 raeburn 12427: Returns:
12428:
12429: =over 4
12430:
1.1040 raeburn 12431: sorted - An array of slot names sorted by a specified sort key
12432: (default sort key is start time of the slot).
1.780 raeburn 12433:
12434: =back
12435:
12436: =cut
12437:
12438:
12439: sub sorted_slots {
1.1040 raeburn 12440: my ($slotsarr,$slots,$sortkey) = @_;
12441: if ($sortkey eq '') {
12442: $sortkey = 'starttime';
12443: }
1.780 raeburn 12444: my @sorted;
12445: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12446: @sorted =
12447: sort {
12448: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12449: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12450: }
12451: if (ref($slots->{$a})) { return -1;}
12452: if (ref($slots->{$b})) { return 1;}
12453: return 0;
12454: } @{$slotsarr};
12455: }
12456: return @sorted;
12457: }
12458:
1.1040 raeburn 12459: =pod
12460:
12461: =item * get_future_slots()
12462:
12463: Inputs:
12464:
12465: =over 4
12466:
12467: cnum - course number
12468:
12469: cdom - course domain
12470:
12471: now - current UNIX time
12472:
12473: symb - optional symb
12474:
12475: =back
12476:
12477: Returns:
12478:
12479: =over 4
12480:
12481: sorted_reservable - ref to array of student_schedulable slots currently
12482: reservable, ordered by end date of reservation period.
12483:
12484: reservable_now - ref to hash of student_schedulable slots currently
12485: reservable.
12486:
12487: Keys in inner hash are:
12488: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12489: (b) endreserve: end date of reservation period.
12490: (c) uniqueperiod: start,end dates when slot is to be uniquely
12491: selected.
1.1040 raeburn 12492:
12493: sorted_future - ref to array of student_schedulable slots reservable in
12494: the future, ordered by start date of reservation period.
12495:
12496: future_reservable - ref to hash of student_schedulable slots reservable
12497: in the future.
12498:
12499: Keys in inner hash are:
12500: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12501: (b) startreserve: start date of reservation period.
12502: (c) uniqueperiod: start,end dates when slot is to be uniquely
12503: selected.
1.1040 raeburn 12504:
12505: =back
12506:
12507: =cut
12508:
12509: sub get_future_slots {
12510: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12511: my $map;
12512: if ($symb) {
12513: ($map) = &Apache::lonnet::decode_symb($symb);
12514: }
1.1040 raeburn 12515: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12516: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12517: foreach my $slot (keys(%slots)) {
12518: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12519: if ($symb) {
1.1229 raeburn 12520: if ($slots{$slot}->{'symb'} ne '') {
12521: my $canuse;
12522: my %oksymbs;
12523: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12524: map { $oksymbs{$_} = 1; } @slotsymbs;
12525: if ($oksymbs{$symb}) {
12526: $canuse = 1;
12527: } else {
12528: foreach my $item (@slotsymbs) {
12529: if ($item =~ /\.(page|sequence)$/) {
12530: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12531: if (($map ne '') && ($map eq $sloturl)) {
12532: $canuse = 1;
12533: last;
12534: }
12535: }
12536: }
12537: }
12538: next unless ($canuse);
12539: }
1.1040 raeburn 12540: }
12541: if (($slots{$slot}->{'starttime'} > $now) &&
12542: ($slots{$slot}->{'endtime'} > $now)) {
12543: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12544: my $userallowed = 0;
12545: if ($slots{$slot}->{'allowedsections'}) {
12546: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12547: if (!defined($env{'request.role.sec'})
12548: && grep(/^No section assigned$/,@allowed_sec)) {
12549: $userallowed=1;
12550: } else {
12551: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12552: $userallowed=1;
12553: }
12554: }
12555: unless ($userallowed) {
12556: if (defined($env{'request.course.groups'})) {
12557: my @groups = split(/:/,$env{'request.course.groups'});
12558: foreach my $group (@groups) {
12559: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12560: $userallowed=1;
12561: last;
12562: }
12563: }
12564: }
12565: }
12566: }
12567: if ($slots{$slot}->{'allowedusers'}) {
12568: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12569: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12570: if (grep(/^\Q$user\E$/,@allowed_users)) {
12571: $userallowed = 1;
12572: }
12573: }
12574: next unless($userallowed);
12575: }
12576: my $startreserve = $slots{$slot}->{'startreserve'};
12577: my $endreserve = $slots{$slot}->{'endreserve'};
12578: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12579: my $uniqueperiod;
12580: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12581: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12582: }
1.1040 raeburn 12583: if (($startreserve < $now) &&
12584: (!$endreserve || $endreserve > $now)) {
12585: my $lastres = $endreserve;
12586: if (!$lastres) {
12587: $lastres = $slots{$slot}->{'starttime'};
12588: }
12589: $reservable_now{$slot} = {
12590: symb => $symb,
1.1250 raeburn 12591: endreserve => $lastres,
12592: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12593: };
12594: } elsif (($startreserve > $now) &&
12595: (!$endreserve || $endreserve > $startreserve)) {
12596: $future_reservable{$slot} = {
12597: symb => $symb,
1.1250 raeburn 12598: startreserve => $startreserve,
12599: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12600: };
12601: }
12602: }
12603: }
12604: my @unsorted_reservable = keys(%reservable_now);
12605: if (@unsorted_reservable > 0) {
12606: @sorted_reservable =
12607: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12608: }
12609: my @unsorted_future = keys(%future_reservable);
12610: if (@unsorted_future > 0) {
12611: @sorted_future =
12612: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12613: }
12614: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12615: }
1.780 raeburn 12616:
12617: =pod
12618:
1.1057 foxr 12619: =back
12620:
1.549 albertel 12621: =head1 HTTP Helpers
12622:
12623: =over 4
12624:
1.648 raeburn 12625: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12626:
1.258 albertel 12627: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12628: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12629: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12630:
12631: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12632: $possible_names is an ref to an array of form element names. As an example:
12633: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12634: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12635:
12636: =cut
1.1 albertel 12637:
1.6 albertel 12638: sub get_unprocessed_cgi {
1.25 albertel 12639: my ($query,$possible_names)= @_;
1.26 matthew 12640: # $Apache::lonxml::debug=1;
1.356 albertel 12641: foreach my $pair (split(/&/,$query)) {
12642: my ($name, $value) = split(/=/,$pair);
1.369 www 12643: $name = &unescape($name);
1.25 albertel 12644: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12645: $value =~ tr/+/ /;
12646: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12647: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12648: }
1.16 harris41 12649: }
1.6 albertel 12650: }
12651:
1.112 bowersj2 12652: =pod
12653:
1.648 raeburn 12654: =item * &cacheheader()
1.112 bowersj2 12655:
12656: returns cache-controlling header code
12657:
12658: =cut
12659:
1.7 albertel 12660: sub cacheheader {
1.258 albertel 12661: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12662: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12663: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12664: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12665: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12666: return $output;
1.7 albertel 12667: }
12668:
1.112 bowersj2 12669: =pod
12670:
1.648 raeburn 12671: =item * &no_cache($r)
1.112 bowersj2 12672:
12673: specifies header code to not have cache
12674:
12675: =cut
12676:
1.9 albertel 12677: sub no_cache {
1.216 albertel 12678: my ($r) = @_;
12679: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12680: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12681: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12682: $r->no_cache(1);
12683: $r->header_out("Expires" => $date);
12684: $r->header_out("Pragma" => "no-cache");
1.123 www 12685: }
12686:
12687: sub content_type {
1.181 albertel 12688: my ($r,$type,$charset) = @_;
1.299 foxr 12689: if ($r) {
12690: # Note that printout.pl calls this with undef for $r.
12691: &no_cache($r);
12692: }
1.258 albertel 12693: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12694: unless ($charset) {
12695: $charset=&Apache::lonlocal::current_encoding;
12696: }
12697: if ($charset) { $type.='; charset='.$charset; }
12698: if ($r) {
12699: $r->content_type($type);
12700: } else {
12701: print("Content-type: $type\n\n");
12702: }
1.9 albertel 12703: }
1.25 albertel 12704:
1.112 bowersj2 12705: =pod
12706:
1.648 raeburn 12707: =item * &add_to_env($name,$value)
1.112 bowersj2 12708:
1.258 albertel 12709: adds $name to the %env hash with value
1.112 bowersj2 12710: $value, if $name already exists, the entry is converted to an array
12711: reference and $value is added to the array.
12712:
12713: =cut
12714:
1.25 albertel 12715: sub add_to_env {
12716: my ($name,$value)=@_;
1.258 albertel 12717: if (defined($env{$name})) {
12718: if (ref($env{$name})) {
1.25 albertel 12719: #already have multiple values
1.258 albertel 12720: push(@{ $env{$name} },$value);
1.25 albertel 12721: } else {
12722: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12723: my $first=$env{$name};
12724: undef($env{$name});
12725: push(@{ $env{$name} },$first,$value);
1.25 albertel 12726: }
12727: } else {
1.258 albertel 12728: $env{$name}=$value;
1.25 albertel 12729: }
1.31 albertel 12730: }
1.149 albertel 12731:
12732: =pod
12733:
1.648 raeburn 12734: =item * &get_env_multiple($name)
1.149 albertel 12735:
1.258 albertel 12736: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12737: values may be defined and end up as an array ref.
12738:
12739: returns an array of values
12740:
12741: =cut
12742:
12743: sub get_env_multiple {
12744: my ($name) = @_;
12745: my @values;
1.258 albertel 12746: if (defined($env{$name})) {
1.149 albertel 12747: # exists is it an array
1.258 albertel 12748: if (ref($env{$name})) {
12749: @values=@{ $env{$name} };
1.149 albertel 12750: } else {
1.258 albertel 12751: $values[0]=$env{$name};
1.149 albertel 12752: }
12753: }
12754: return(@values);
12755: }
12756:
1.1249 damieng 12757: # Looks at given dependencies, and returns something depending on the context.
12758: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12759: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12760: # For all other contexts, returns ($output, $counter, $numpathchg).
12761: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12762: # $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.
12763: # $numpathchg: integer with the number of cleaned up dependency paths.
12764: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12765: # \%mapping: hash reference clean path -> original path for all dependencies.
12766: # @param {string} actionurl - The path to the handler, indicative of the context.
12767: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12768: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12769: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12770: # @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)
12771: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12772: sub ask_for_embedded_content {
1.1249 damieng 12773: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12774: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12775: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12776: %currsubfile,%unused,$rem);
1.1071 raeburn 12777: my $counter = 0;
12778: my $numnew = 0;
1.987 raeburn 12779: my $numremref = 0;
12780: my $numinvalid = 0;
12781: my $numpathchg = 0;
12782: my $numexisting = 0;
1.1071 raeburn 12783: my $numunused = 0;
12784: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12785: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12786: my $heading = &mt('Upload embedded files');
12787: my $buttontext = &mt('Upload');
12788:
1.1249 damieng 12789: # fills these variables based on the context:
12790: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12791: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12792: if ($env{'request.course.id'}) {
1.1123 raeburn 12793: if ($actionurl eq '/adm/dependencies') {
12794: $navmap = Apache::lonnavmaps::navmap->new();
12795: }
12796: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12797: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12798: }
1.1123 raeburn 12799: if (($actionurl eq '/adm/portfolio') ||
12800: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12801: my $current_path='/';
12802: if ($env{'form.currentpath'}) {
12803: $current_path = $env{'form.currentpath'};
12804: }
12805: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12806: $udom = $cdom;
12807: $uname = $cnum;
1.984 raeburn 12808: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12809: } else {
12810: $udom = $env{'user.domain'};
12811: $uname = $env{'user.name'};
12812: $url = '/userfiles/portfolio';
12813: }
1.987 raeburn 12814: $toplevel = $url.'/';
1.984 raeburn 12815: $url .= $current_path;
12816: $getpropath = 1;
1.987 raeburn 12817: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12818: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12819: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12820: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12821: $toplevel = $url;
1.984 raeburn 12822: if ($rest ne '') {
1.987 raeburn 12823: $url .= $rest;
12824: }
12825: } elsif ($actionurl eq '/adm/coursedocs') {
12826: if (ref($args) eq 'HASH') {
1.1071 raeburn 12827: $url = $args->{'docs_url'};
12828: $toplevel = $url;
1.1084 raeburn 12829: if ($args->{'context'} eq 'paste') {
12830: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12831: ($path) =
12832: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12833: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12834: $fileloc =~ s{^/}{};
12835: }
1.1071 raeburn 12836: }
1.1084 raeburn 12837: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12838: if ($env{'request.course.id'} ne '') {
12839: if (ref($args) eq 'HASH') {
12840: $url = $args->{'docs_url'};
12841: $title = $args->{'docs_title'};
1.1126 raeburn 12842: $toplevel = $url;
12843: unless ($toplevel =~ m{^/}) {
12844: $toplevel = "/$url";
12845: }
1.1085 raeburn 12846: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12847: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12848: $path = $1;
12849: } else {
12850: ($path) =
12851: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12852: }
1.1195 raeburn 12853: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12854: $fileloc = $toplevel;
12855: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12856: my ($udom,$uname,$fname) =
12857: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12858: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12859: } else {
12860: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12861: }
1.1071 raeburn 12862: $fileloc =~ s{^/}{};
12863: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12864: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12865: }
1.987 raeburn 12866: }
1.1123 raeburn 12867: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12868: $udom = $cdom;
12869: $uname = $cnum;
12870: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12871: $toplevel = $url;
12872: $path = $url;
12873: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12874: $fileloc =~ s{^/}{};
1.987 raeburn 12875: }
1.1249 damieng 12876:
12877: # parses the dependency paths to get some info
12878: # fills $newfiles, $mapping, $subdependencies, $dependencies
12879: # $newfiles: hash URL -> 1 for new files or external URLs
12880: # (will be completed later)
12881: # $mapping:
12882: # for external URLs: external URL -> external URL
12883: # for relative paths: clean path -> original path
12884: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12885: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12886: foreach my $file (keys(%{$allfiles})) {
12887: my $embed_file;
12888: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12889: $embed_file = $1;
12890: } else {
12891: $embed_file = $file;
12892: }
1.1158 raeburn 12893: my ($absolutepath,$cleaned_file);
12894: if ($embed_file =~ m{^\w+://}) {
12895: $cleaned_file = $embed_file;
1.1147 raeburn 12896: $newfiles{$cleaned_file} = 1;
12897: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12898: } else {
1.1158 raeburn 12899: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12900: if ($embed_file =~ m{^/}) {
12901: $absolutepath = $embed_file;
12902: }
1.1147 raeburn 12903: if ($cleaned_file =~ m{/}) {
12904: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12905: $path = &check_for_traversal($path,$url,$toplevel);
12906: my $item = $fname;
12907: if ($path ne '') {
12908: $item = $path.'/'.$fname;
12909: $subdependencies{$path}{$fname} = 1;
12910: } else {
12911: $dependencies{$item} = 1;
12912: }
12913: if ($absolutepath) {
12914: $mapping{$item} = $absolutepath;
12915: } else {
12916: $mapping{$item} = $embed_file;
12917: }
12918: } else {
12919: $dependencies{$embed_file} = 1;
12920: if ($absolutepath) {
1.1147 raeburn 12921: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12922: } else {
1.1147 raeburn 12923: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12924: }
12925: }
1.984 raeburn 12926: }
12927: }
1.1249 damieng 12928:
12929: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12930: # and lists
12931: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12932: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12933: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12934: # the path had to be cleaned up
12935: # $existing: hash clean path -> 1 if the file exists
12936: # $numexisting: number of keys in $existing
12937: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12938: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12939: # dependency subdirectories that are
12940: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12941: my $dirptr = 16384;
1.984 raeburn 12942: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12943: $currsubfile{$path} = {};
1.1123 raeburn 12944: if (($actionurl eq '/adm/portfolio') ||
12945: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12946: my ($sublistref,$listerror) =
12947: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12948: if (ref($sublistref) eq 'ARRAY') {
12949: foreach my $line (@{$sublistref}) {
12950: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12951: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12952: }
1.984 raeburn 12953: }
1.987 raeburn 12954: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12955: if (opendir(my $dir,$url.'/'.$path)) {
12956: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12957: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12958: }
1.1084 raeburn 12959: } elsif (($actionurl eq '/adm/dependencies') ||
12960: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12961: ($args->{'context'} eq 'paste')) ||
12962: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12963: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12964: my $dir;
12965: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12966: $dir = $fileloc;
12967: } else {
12968: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12969: }
1.1071 raeburn 12970: if ($dir ne '') {
12971: my ($sublistref,$listerror) =
12972: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12973: if (ref($sublistref) eq 'ARRAY') {
12974: foreach my $line (@{$sublistref}) {
12975: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12976: undef,$mtime)=split(/\&/,$line,12);
12977: unless (($testdir&$dirptr) ||
12978: ($file_name =~ /^\.\.?$/)) {
12979: $currsubfile{$path}{$file_name} = [$size,$mtime];
12980: }
12981: }
12982: }
12983: }
1.984 raeburn 12984: }
12985: }
12986: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12987: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12988: my $item = $path.'/'.$file;
12989: unless ($mapping{$item} eq $item) {
12990: $pathchanges{$item} = 1;
12991: }
12992: $existing{$item} = 1;
12993: $numexisting ++;
12994: } else {
12995: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12996: }
12997: }
1.1071 raeburn 12998: if ($actionurl eq '/adm/dependencies') {
12999: foreach my $path (keys(%currsubfile)) {
13000: if (ref($currsubfile{$path}) eq 'HASH') {
13001: foreach my $file (keys(%{$currsubfile{$path}})) {
13002: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 13003: next if (($rem ne '') &&
13004: (($env{"httpref.$rem"."$path/$file"} ne '') ||
13005: (ref($navmap) &&
13006: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
13007: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13008: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 13009: $unused{$path.'/'.$file} = 1;
13010: }
13011: }
13012: }
13013: }
13014: }
1.984 raeburn 13015: }
1.1249 damieng 13016:
13017: # fills $currfile, hash file name -> 1 or [$size,$mtime]
13018: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 13019: my %currfile;
1.1123 raeburn 13020: if (($actionurl eq '/adm/portfolio') ||
13021: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 13022: my ($dirlistref,$listerror) =
13023: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
13024: if (ref($dirlistref) eq 'ARRAY') {
13025: foreach my $line (@{$dirlistref}) {
13026: my ($file_name,$rest) = split(/\&/,$line,2);
13027: $currfile{$file_name} = 1;
13028: }
1.984 raeburn 13029: }
1.987 raeburn 13030: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 13031: if (opendir(my $dir,$url)) {
1.987 raeburn 13032: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 13033: map {$currfile{$_} = 1;} @dir_list;
13034: }
1.1084 raeburn 13035: } elsif (($actionurl eq '/adm/dependencies') ||
13036: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 13037: ($args->{'context'} eq 'paste')) ||
13038: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 13039: if ($env{'request.course.id'} ne '') {
13040: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
13041: if ($dir ne '') {
13042: my ($dirlistref,$listerror) =
13043: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
13044: if (ref($dirlistref) eq 'ARRAY') {
13045: foreach my $line (@{$dirlistref}) {
13046: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
13047: $size,undef,$mtime)=split(/\&/,$line,12);
13048: unless (($testdir&$dirptr) ||
13049: ($file_name =~ /^\.\.?$/)) {
13050: $currfile{$file_name} = [$size,$mtime];
13051: }
13052: }
13053: }
13054: }
13055: }
1.984 raeburn 13056: }
1.1249 damieng 13057: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
13058: # are not in subdirectories, using $currfile
1.984 raeburn 13059: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 13060: if (exists($currfile{$file})) {
1.987 raeburn 13061: unless ($mapping{$file} eq $file) {
13062: $pathchanges{$file} = 1;
13063: }
13064: $existing{$file} = 1;
13065: $numexisting ++;
13066: } else {
1.984 raeburn 13067: $newfiles{$file} = 1;
13068: }
13069: }
1.1071 raeburn 13070: foreach my $file (keys(%currfile)) {
13071: unless (($file eq $filename) ||
13072: ($file eq $filename.'.bak') ||
13073: ($dependencies{$file})) {
1.1085 raeburn 13074: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 13075: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
13076: next if (($rem ne '') &&
13077: (($env{"httpref.$rem".$file} ne '') ||
13078: (ref($navmap) &&
13079: (($navmap->getResourceByUrl($rem.$file) ne '') ||
13080: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
13081: ($navmap->getResourceByUrl($rem.$1)))))));
13082: }
1.1085 raeburn 13083: }
1.1071 raeburn 13084: $unused{$file} = 1;
13085: }
13086: }
1.1249 damieng 13087:
13088: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 13089: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
13090: ($args->{'context'} eq 'paste')) {
13091: $counter = scalar(keys(%existing));
13092: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 13093: return ($output,$counter,$numpathchg,\%existing);
13094: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
13095: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
13096: $counter = scalar(keys(%existing));
13097: $numpathchg = scalar(keys(%pathchanges));
13098: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 13099: }
1.1249 damieng 13100:
13101: # returns HTML otherwise, with dependency results and to ask for more uploads
13102:
13103: # $upload_output: missing dependencies (with upload form)
13104: # $modify_output: uploaded dependencies (in use)
13105: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 13106: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 13107: if ($actionurl eq '/adm/dependencies') {
13108: next if ($embed_file =~ m{^\w+://});
13109: }
1.660 raeburn 13110: $upload_output .= &start_data_table_row().
1.1123 raeburn 13111: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 13112: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 13113: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 13114: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
13115: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 13116: }
1.1123 raeburn 13117: $upload_output .= '</td>';
1.1071 raeburn 13118: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 13119: $upload_output.='<td align="right">'.
13120: '<span class="LC_info LC_fontsize_medium">'.
13121: &mt("URL points to web address").'</span>';
1.987 raeburn 13122: $numremref++;
1.660 raeburn 13123: } elsif ($args->{'error_on_invalid_names'}
13124: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 13125: $upload_output.='<td align="right"><span class="LC_warning">'.
13126: &mt('Invalid characters').'</span>';
1.987 raeburn 13127: $numinvalid++;
1.660 raeburn 13128: } else {
1.1123 raeburn 13129: $upload_output .= '<td>'.
13130: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 13131: $embed_file,\%mapping,
1.1071 raeburn 13132: $allfiles,$codebase,'upload');
13133: $counter ++;
13134: $numnew ++;
1.987 raeburn 13135: }
13136: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
13137: }
13138: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 13139: if ($actionurl eq '/adm/dependencies') {
13140: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
13141: $modify_output .= &start_data_table_row().
13142: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
13143: '<img src="'.&icon($embed_file).'" border="0" />'.
13144: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
13145: '<td>'.$size.'</td>'.
13146: '<td>'.$mtime.'</td>'.
13147: '<td><label><input type="checkbox" name="mod_upload_dep" '.
13148: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
13149: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
13150: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
13151: &embedded_file_element('upload_embedded',$counter,
13152: $embed_file,\%mapping,
13153: $allfiles,$codebase,'modify').
13154: '</div></td>'.
13155: &end_data_table_row()."\n";
13156: $counter ++;
13157: } else {
13158: $upload_output .= &start_data_table_row().
1.1123 raeburn 13159: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
13160: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13161: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13162: &Apache::loncommon::end_data_table_row()."\n";
13163: }
13164: }
13165: my $delidx = $counter;
13166: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13167: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13168: $delete_output .= &start_data_table_row().
13169: '<td><img src="'.&icon($oldfile).'" />'.
13170: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13171: '<td>'.$size.'</td>'.
13172: '<td>'.$mtime.'</td>'.
13173: '<td><label><input type="checkbox" name="del_upload_dep" '.
13174: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13175: &embedded_file_element('upload_embedded',$delidx,
13176: $oldfile,\%mapping,$allfiles,
13177: $codebase,'delete').'</td>'.
13178: &end_data_table_row()."\n";
13179: $numunused ++;
13180: $delidx ++;
1.987 raeburn 13181: }
13182: if ($upload_output) {
13183: $upload_output = &start_data_table().
13184: $upload_output.
13185: &end_data_table()."\n";
13186: }
1.1071 raeburn 13187: if ($modify_output) {
13188: $modify_output = &start_data_table().
13189: &start_data_table_header_row().
13190: '<th>'.&mt('File').'</th>'.
13191: '<th>'.&mt('Size (KB)').'</th>'.
13192: '<th>'.&mt('Modified').'</th>'.
13193: '<th>'.&mt('Upload replacement?').'</th>'.
13194: &end_data_table_header_row().
13195: $modify_output.
13196: &end_data_table()."\n";
13197: }
13198: if ($delete_output) {
13199: $delete_output = &start_data_table().
13200: &start_data_table_header_row().
13201: '<th>'.&mt('File').'</th>'.
13202: '<th>'.&mt('Size (KB)').'</th>'.
13203: '<th>'.&mt('Modified').'</th>'.
13204: '<th>'.&mt('Delete?').'</th>'.
13205: &end_data_table_header_row().
13206: $delete_output.
13207: &end_data_table()."\n";
13208: }
1.987 raeburn 13209: my $applies = 0;
13210: if ($numremref) {
13211: $applies ++;
13212: }
13213: if ($numinvalid) {
13214: $applies ++;
13215: }
13216: if ($numexisting) {
13217: $applies ++;
13218: }
1.1071 raeburn 13219: if ($counter || $numunused) {
1.987 raeburn 13220: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13221: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13222: $state.'<h3>'.$heading.'</h3>';
13223: if ($actionurl eq '/adm/dependencies') {
13224: if ($numnew) {
13225: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13226: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13227: $upload_output.'<br />'."\n";
13228: }
13229: if ($numexisting) {
13230: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13231: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13232: $modify_output.'<br />'."\n";
13233: $buttontext = &mt('Save changes');
13234: }
13235: if ($numunused) {
13236: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13237: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13238: $delete_output.'<br />'."\n";
13239: $buttontext = &mt('Save changes');
13240: }
13241: } else {
13242: $output .= $upload_output.'<br />'."\n";
13243: }
13244: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13245: $counter.'" />'."\n";
13246: if ($actionurl eq '/adm/dependencies') {
13247: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13248: $numnew.'" />'."\n";
13249: } elsif ($actionurl eq '') {
1.987 raeburn 13250: $output .= '<input type="hidden" name="phase" value="three" />';
13251: }
13252: } elsif ($applies) {
13253: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13254: if ($applies > 1) {
13255: $output .=
1.1123 raeburn 13256: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13257: if ($numremref) {
13258: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13259: }
13260: if ($numinvalid) {
13261: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13262: }
13263: if ($numexisting) {
13264: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13265: }
13266: $output .= '</ul><br />';
13267: } elsif ($numremref) {
13268: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13269: } elsif ($numinvalid) {
13270: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13271: } elsif ($numexisting) {
13272: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13273: }
13274: $output .= $upload_output.'<br />';
13275: }
13276: my ($pathchange_output,$chgcount);
1.1071 raeburn 13277: $chgcount = $counter;
1.987 raeburn 13278: if (keys(%pathchanges) > 0) {
13279: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13280: if ($counter) {
1.987 raeburn 13281: $output .= &embedded_file_element('pathchange',$chgcount,
13282: $embed_file,\%mapping,
1.1071 raeburn 13283: $allfiles,$codebase,'change');
1.987 raeburn 13284: } else {
13285: $pathchange_output .=
13286: &start_data_table_row().
13287: '<td><input type ="checkbox" name="namechange" value="'.
13288: $chgcount.'" checked="checked" /></td>'.
13289: '<td>'.$mapping{$embed_file}.'</td>'.
13290: '<td>'.$embed_file.
13291: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13292: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13293: '</td>'.&end_data_table_row();
1.660 raeburn 13294: }
1.987 raeburn 13295: $numpathchg ++;
13296: $chgcount ++;
1.660 raeburn 13297: }
13298: }
1.1127 raeburn 13299: if (($counter) || ($numunused)) {
1.987 raeburn 13300: if ($numpathchg) {
13301: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13302: $numpathchg.'" />'."\n";
13303: }
13304: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13305: ($actionurl eq '/adm/imsimport')) {
13306: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13307: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13308: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13309: } elsif ($actionurl eq '/adm/dependencies') {
13310: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13311: }
1.1123 raeburn 13312: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13313: } elsif ($numpathchg) {
13314: my %pathchange = ();
13315: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13316: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13317: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13318: }
1.987 raeburn 13319: }
1.1071 raeburn 13320: return ($output,$counter,$numpathchg);
1.987 raeburn 13321: }
13322:
1.1147 raeburn 13323: =pod
13324:
13325: =item * clean_path($name)
13326:
13327: Performs clean-up of directories, subdirectories and filename in an
13328: embedded object, referenced in an HTML file which is being uploaded
13329: to a course or portfolio, where
13330: "Upload embedded images/multimedia files if HTML file" checkbox was
13331: checked.
13332:
13333: Clean-up is similar to replacements in lonnet::clean_filename()
13334: except each / between sub-directory and next level is preserved.
13335:
13336: =cut
13337:
13338: sub clean_path {
13339: my ($embed_file) = @_;
13340: $embed_file =~s{^/+}{};
13341: my @contents;
13342: if ($embed_file =~ m{/}) {
13343: @contents = split(/\//,$embed_file);
13344: } else {
13345: @contents = ($embed_file);
13346: }
13347: my $lastidx = scalar(@contents)-1;
13348: for (my $i=0; $i<=$lastidx; $i++) {
13349: $contents[$i]=~s{\\}{/}g;
13350: $contents[$i]=~s/\s+/\_/g;
13351: $contents[$i]=~s{[^/\w\.\-]}{}g;
13352: if ($i == $lastidx) {
13353: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13354: }
13355: }
13356: if ($lastidx > 0) {
13357: return join('/',@contents);
13358: } else {
13359: return $contents[0];
13360: }
13361: }
13362:
1.987 raeburn 13363: sub embedded_file_element {
1.1071 raeburn 13364: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13365: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13366: (ref($codebase) eq 'HASH'));
13367: my $output;
1.1071 raeburn 13368: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13369: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13370: }
13371: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13372: &escape($embed_file).'" />';
13373: unless (($context eq 'upload_embedded') &&
13374: ($mapping->{$embed_file} eq $embed_file)) {
13375: $output .='
13376: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13377: }
13378: my $attrib;
13379: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13380: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13381: }
13382: $output .=
13383: "\n\t\t".
13384: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13385: $attrib.'" />';
13386: if (exists($codebase->{$mapping->{$embed_file}})) {
13387: $output .=
13388: "\n\t\t".
13389: '<input name="codebase_'.$num.'" type="hidden" value="'.
13390: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13391: }
1.987 raeburn 13392: return $output;
1.660 raeburn 13393: }
13394:
1.1071 raeburn 13395: sub get_dependency_details {
13396: my ($currfile,$currsubfile,$embed_file) = @_;
13397: my ($size,$mtime,$showsize,$showmtime);
13398: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13399: if ($embed_file =~ m{/}) {
13400: my ($path,$fname) = split(/\//,$embed_file);
13401: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13402: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13403: }
13404: } else {
13405: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13406: ($size,$mtime) = @{$currfile->{$embed_file}};
13407: }
13408: }
13409: $showsize = $size/1024.0;
13410: $showsize = sprintf("%.1f",$showsize);
13411: if ($mtime > 0) {
13412: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13413: }
13414: }
13415: return ($showsize,$showmtime);
13416: }
13417:
13418: sub ask_embedded_js {
13419: return <<"END";
13420: <script type="text/javascript"">
13421: // <![CDATA[
13422: function toggleBrowse(counter) {
13423: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13424: var fileid = document.getElementById('embedded_item_'+counter);
13425: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13426: if (chkboxid.checked == true) {
13427: uploaddivid.style.display='block';
13428: } else {
13429: uploaddivid.style.display='none';
13430: fileid.value = '';
13431: }
13432: }
13433: // ]]>
13434: </script>
13435:
13436: END
13437: }
13438:
1.661 raeburn 13439: sub upload_embedded {
13440: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13441: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13442: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13443: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13444: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13445: my $orig_uploaded_filename =
13446: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13447: foreach my $type ('orig','ref','attrib','codebase') {
13448: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13449: $env{'form.embedded_'.$type.'_'.$i} =
13450: &unescape($env{'form.embedded_'.$type.'_'.$i});
13451: }
13452: }
1.661 raeburn 13453: my ($path,$fname) =
13454: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13455: # no path, whole string is fname
13456: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13457: $fname = &Apache::lonnet::clean_filename($fname);
13458: # See if there is anything left
13459: next if ($fname eq '');
13460:
13461: # Check if file already exists as a file or directory.
13462: my ($state,$msg);
13463: if ($context eq 'portfolio') {
13464: my $port_path = $dirpath;
13465: if ($group ne '') {
13466: $port_path = "groups/$group/$port_path";
13467: }
1.987 raeburn 13468: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13469: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13470: $dir_root,$port_path,$disk_quota,
13471: $current_disk_usage,$uname,$udom);
13472: if ($state eq 'will_exceed_quota'
1.984 raeburn 13473: || $state eq 'file_locked') {
1.661 raeburn 13474: $output .= $msg;
13475: next;
13476: }
13477: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13478: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13479: if ($state eq 'exists') {
13480: $output .= $msg;
13481: next;
13482: }
13483: }
13484: # Check if extension is valid
13485: if (($fname =~ /\.(\w+)$/) &&
13486: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13487: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13488: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13489: next;
13490: } elsif (($fname =~ /\.(\w+)$/) &&
13491: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13492: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13493: next;
13494: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13495: $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 13496: next;
13497: }
13498: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13499: my $subdir = $path;
13500: $subdir =~ s{/+$}{};
1.661 raeburn 13501: if ($context eq 'portfolio') {
1.984 raeburn 13502: my $result;
13503: if ($state eq 'existingfile') {
13504: $result=
13505: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13506: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13507: } else {
1.984 raeburn 13508: $result=
13509: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13510: $dirpath.
1.1123 raeburn 13511: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13512: if ($result !~ m|^/uploaded/|) {
13513: $output .= '<span class="LC_error">'
13514: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13515: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13516: .'</span><br />';
13517: next;
13518: } else {
1.987 raeburn 13519: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13520: $path.$fname.'</span>').'<br />';
1.984 raeburn 13521: }
1.661 raeburn 13522: }
1.1123 raeburn 13523: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13524: my $extendedsubdir = $dirpath.'/'.$subdir;
13525: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13526: my $result =
1.1126 raeburn 13527: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13528: if ($result !~ m|^/uploaded/|) {
13529: $output .= '<span class="LC_error">'
13530: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13531: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13532: .'</span><br />';
13533: next;
13534: } else {
13535: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13536: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13537: if ($context eq 'syllabus') {
13538: &Apache::lonnet::make_public_indefinitely($result);
13539: }
1.987 raeburn 13540: }
1.661 raeburn 13541: } else {
13542: # Save the file
13543: my $target = $env{'form.embedded_item_'.$i};
13544: my $fullpath = $dir_root.$dirpath.'/'.$path;
13545: my $dest = $fullpath.$fname;
13546: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13547: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13548: my $count;
13549: my $filepath = $dir_root;
1.1027 raeburn 13550: foreach my $subdir (@parts) {
13551: $filepath .= "/$subdir";
13552: if (!-e $filepath) {
1.661 raeburn 13553: mkdir($filepath,0770);
13554: }
13555: }
13556: my $fh;
13557: if (!open($fh,'>'.$dest)) {
13558: &Apache::lonnet::logthis('Failed to create '.$dest);
13559: $output .= '<span class="LC_error">'.
1.1071 raeburn 13560: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13561: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13562: '</span><br />';
13563: } else {
13564: if (!print $fh $env{'form.embedded_item_'.$i}) {
13565: &Apache::lonnet::logthis('Failed to write to '.$dest);
13566: $output .= '<span class="LC_error">'.
1.1071 raeburn 13567: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13568: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13569: '</span><br />';
13570: } else {
1.987 raeburn 13571: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13572: $url.'</span>').'<br />';
13573: unless ($context eq 'testbank') {
13574: $footer .= &mt('View embedded file: [_1]',
13575: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13576: }
13577: }
13578: close($fh);
13579: }
13580: }
13581: if ($env{'form.embedded_ref_'.$i}) {
13582: $pathchange{$i} = 1;
13583: }
13584: }
13585: if ($output) {
13586: $output = '<p>'.$output.'</p>';
13587: }
13588: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13589: $returnflag = 'ok';
1.1071 raeburn 13590: my $numpathchgs = scalar(keys(%pathchange));
13591: if ($numpathchgs > 0) {
1.987 raeburn 13592: if ($context eq 'portfolio') {
13593: $output .= '<p>'.&mt('or').'</p>';
13594: } elsif ($context eq 'testbank') {
1.1071 raeburn 13595: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13596: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13597: $returnflag = 'modify_orightml';
13598: }
13599: }
1.1071 raeburn 13600: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13601: }
13602:
13603: sub modify_html_form {
13604: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13605: my $end = 0;
13606: my $modifyform;
13607: if ($context eq 'upload_embedded') {
13608: return unless (ref($pathchange) eq 'HASH');
13609: if ($env{'form.number_embedded_items'}) {
13610: $end += $env{'form.number_embedded_items'};
13611: }
13612: if ($env{'form.number_pathchange_items'}) {
13613: $end += $env{'form.number_pathchange_items'};
13614: }
13615: if ($end) {
13616: for (my $i=0; $i<$end; $i++) {
13617: if ($i < $env{'form.number_embedded_items'}) {
13618: next unless($pathchange->{$i});
13619: }
13620: $modifyform .=
13621: &start_data_table_row().
13622: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13623: 'checked="checked" /></td>'.
13624: '<td>'.$env{'form.embedded_ref_'.$i}.
13625: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13626: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13627: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13628: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13629: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13630: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13631: '<td>'.$env{'form.embedded_orig_'.$i}.
13632: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13633: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13634: &end_data_table_row();
1.1071 raeburn 13635: }
1.987 raeburn 13636: }
13637: } else {
13638: $modifyform = $pathchgtable;
13639: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13640: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13641: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13642: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13643: }
13644: }
13645: if ($modifyform) {
1.1071 raeburn 13646: if ($actionurl eq '/adm/dependencies') {
13647: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13648: }
1.987 raeburn 13649: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13650: '<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".
13651: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13652: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13653: '</ol></p>'."\n".'<p>'.
13654: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13655: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13656: &start_data_table()."\n".
13657: &start_data_table_header_row().
13658: '<th>'.&mt('Change?').'</th>'.
13659: '<th>'.&mt('Current reference').'</th>'.
13660: '<th>'.&mt('Required reference').'</th>'.
13661: &end_data_table_header_row()."\n".
13662: $modifyform.
13663: &end_data_table().'<br />'."\n".$hiddenstate.
13664: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13665: '</form>'."\n";
13666: }
13667: return;
13668: }
13669:
13670: sub modify_html_refs {
1.1123 raeburn 13671: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13672: my $container;
13673: if ($context eq 'portfolio') {
13674: $container = $env{'form.container'};
13675: } elsif ($context eq 'coursedoc') {
13676: $container = $env{'form.primaryurl'};
1.1071 raeburn 13677: } elsif ($context eq 'manage_dependencies') {
13678: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13679: $container = "/$container";
1.1123 raeburn 13680: } elsif ($context eq 'syllabus') {
13681: $container = $url;
1.987 raeburn 13682: } else {
1.1027 raeburn 13683: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13684: }
13685: my (%allfiles,%codebase,$output,$content);
13686: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13687: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13688: if (wantarray) {
13689: return ('',0,0);
13690: } else {
13691: return;
13692: }
13693: }
13694: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13695: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13696: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13697: if (wantarray) {
13698: return ('',0,0);
13699: } else {
13700: return;
13701: }
13702: }
1.987 raeburn 13703: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13704: if ($content eq '-1') {
13705: if (wantarray) {
13706: return ('',0,0);
13707: } else {
13708: return;
13709: }
13710: }
1.987 raeburn 13711: } else {
1.1071 raeburn 13712: unless ($container =~ /^\Q$dir_root\E/) {
13713: if (wantarray) {
13714: return ('',0,0);
13715: } else {
13716: return;
13717: }
13718: }
1.1317 raeburn 13719: if (open(my $fh,'<',$container)) {
1.987 raeburn 13720: $content = join('', <$fh>);
13721: close($fh);
13722: } else {
1.1071 raeburn 13723: if (wantarray) {
13724: return ('',0,0);
13725: } else {
13726: return;
13727: }
1.987 raeburn 13728: }
13729: }
13730: my ($count,$codebasecount) = (0,0);
13731: my $mm = new File::MMagic;
13732: my $mime_type = $mm->checktype_contents($content);
13733: if ($mime_type eq 'text/html') {
13734: my $parse_result =
13735: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13736: \%codebase,\$content);
13737: if ($parse_result eq 'ok') {
13738: foreach my $i (@changes) {
13739: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13740: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13741: if ($allfiles{$ref}) {
13742: my $newname = $orig;
13743: my ($attrib_regexp,$codebase);
1.1006 raeburn 13744: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13745: if ($attrib_regexp =~ /:/) {
13746: $attrib_regexp =~ s/\:/|/g;
13747: }
13748: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13749: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13750: $count += $numchg;
1.1123 raeburn 13751: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13752: delete($allfiles{$ref});
1.987 raeburn 13753: }
13754: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13755: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13756: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13757: $codebasecount ++;
13758: }
13759: }
13760: }
1.1123 raeburn 13761: my $skiprewrites;
1.987 raeburn 13762: if ($count || $codebasecount) {
13763: my $saveresult;
1.1071 raeburn 13764: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13765: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13766: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13767: if ($url eq $container) {
13768: my ($fname) = ($container =~ m{/([^/]+)$});
13769: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13770: $count,'<span class="LC_filename">'.
1.1071 raeburn 13771: $fname.'</span>').'</p>';
1.987 raeburn 13772: } else {
13773: $output = '<p class="LC_error">'.
13774: &mt('Error: update failed for: [_1].',
13775: '<span class="LC_filename">'.
13776: $container.'</span>').'</p>';
13777: }
1.1123 raeburn 13778: if ($context eq 'syllabus') {
13779: unless ($saveresult eq 'ok') {
13780: $skiprewrites = 1;
13781: }
13782: }
1.987 raeburn 13783: } else {
1.1317 raeburn 13784: if (open(my $fh,'>',$container)) {
1.987 raeburn 13785: print $fh $content;
13786: close($fh);
13787: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13788: $count,'<span class="LC_filename">'.
13789: $container.'</span>').'</p>';
1.661 raeburn 13790: } else {
1.987 raeburn 13791: $output = '<p class="LC_error">'.
13792: &mt('Error: could not update [_1].',
13793: '<span class="LC_filename">'.
13794: $container.'</span>').'</p>';
1.661 raeburn 13795: }
13796: }
13797: }
1.1123 raeburn 13798: if (($context eq 'syllabus') && (!$skiprewrites)) {
13799: my ($actionurl,$state);
13800: $actionurl = "/public/$udom/$uname/syllabus";
13801: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13802: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13803: \%codebase,
13804: {'context' => 'rewrites',
13805: 'ignore_remote_references' => 1,});
13806: if (ref($mapping) eq 'HASH') {
13807: my $rewrites = 0;
13808: foreach my $key (keys(%{$mapping})) {
13809: next if ($key =~ m{^https?://});
13810: my $ref = $mapping->{$key};
13811: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13812: my $attrib;
13813: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13814: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13815: }
13816: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13817: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13818: $rewrites += $numchg;
13819: }
13820: }
13821: if ($rewrites) {
13822: my $saveresult;
13823: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13824: if ($url eq $container) {
13825: my ($fname) = ($container =~ m{/([^/]+)$});
13826: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13827: $count,'<span class="LC_filename">'.
13828: $fname.'</span>').'</p>';
13829: } else {
13830: $output .= '<p class="LC_error">'.
13831: &mt('Error: could not update links in [_1].',
13832: '<span class="LC_filename">'.
13833: $container.'</span>').'</p>';
13834:
13835: }
13836: }
13837: }
13838: }
1.987 raeburn 13839: } else {
13840: &logthis('Failed to parse '.$container.
13841: ' to modify references: '.$parse_result);
1.661 raeburn 13842: }
13843: }
1.1071 raeburn 13844: if (wantarray) {
13845: return ($output,$count,$codebasecount);
13846: } else {
13847: return $output;
13848: }
1.661 raeburn 13849: }
13850:
13851: sub check_for_existing {
13852: my ($path,$fname,$element) = @_;
13853: my ($state,$msg);
13854: if (-d $path.'/'.$fname) {
13855: $state = 'exists';
13856: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13857: } elsif (-e $path.'/'.$fname) {
13858: $state = 'exists';
13859: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13860: }
13861: if ($state eq 'exists') {
13862: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13863: }
13864: return ($state,$msg);
13865: }
13866:
13867: sub check_for_upload {
13868: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13869: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13870: my $filesize = length($env{'form.'.$element});
13871: if (!$filesize) {
13872: my $msg = '<span class="LC_error">'.
13873: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13874: '<span class="LC_filename">'.$fname.'</span>',
13875: $filesize).'<br />'.
1.1007 raeburn 13876: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13877: '</span>';
13878: return ('zero_bytes',$msg);
13879: }
13880: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13881: my $getpropath = 1;
1.1021 raeburn 13882: my ($dirlistref,$listerror) =
13883: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13884: my $found_file = 0;
13885: my $locked_file = 0;
1.991 raeburn 13886: my @lockers;
13887: my $navmap;
13888: if ($env{'request.course.id'}) {
13889: $navmap = Apache::lonnavmaps::navmap->new();
13890: }
1.1021 raeburn 13891: if (ref($dirlistref) eq 'ARRAY') {
13892: foreach my $line (@{$dirlistref}) {
13893: my ($file_name,$rest)=split(/\&/,$line,2);
13894: if ($file_name eq $fname){
13895: $file_name = $path.$file_name;
13896: if ($group ne '') {
13897: $file_name = $group.$file_name;
13898: }
13899: $found_file = 1;
13900: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13901: foreach my $lock (@lockers) {
13902: if (ref($lock) eq 'ARRAY') {
13903: my ($symb,$crsid) = @{$lock};
13904: if ($crsid eq $env{'request.course.id'}) {
13905: if (ref($navmap)) {
13906: my $res = $navmap->getBySymb($symb);
13907: foreach my $part (@{$res->parts()}) {
13908: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13909: unless (($slot_status == $res->RESERVED) ||
13910: ($slot_status == $res->RESERVED_LOCATION)) {
13911: $locked_file = 1;
13912: }
1.991 raeburn 13913: }
1.1021 raeburn 13914: } else {
13915: $locked_file = 1;
1.991 raeburn 13916: }
13917: } else {
13918: $locked_file = 1;
13919: }
13920: }
1.1021 raeburn 13921: }
13922: } else {
13923: my @info = split(/\&/,$rest);
13924: my $currsize = $info[6]/1000;
13925: if ($currsize < $filesize) {
13926: my $extra = $filesize - $currsize;
13927: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13928: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13929: &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 13930: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13931: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13932: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13933: return ('will_exceed_quota',$msg);
13934: }
1.984 raeburn 13935: }
13936: }
1.661 raeburn 13937: }
13938: }
13939: }
13940: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13941: my $msg = '<p class="LC_warning">'.
13942: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13943: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13944: return ('will_exceed_quota',$msg);
13945: } elsif ($found_file) {
13946: if ($locked_file) {
1.1179 bisitz 13947: my $msg = '<p class="LC_warning">';
1.661 raeburn 13948: $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 13949: $msg .= '</p>';
1.661 raeburn 13950: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13951: return ('file_locked',$msg);
13952: } else {
1.1179 bisitz 13953: my $msg = '<p class="LC_error">';
1.984 raeburn 13954: $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 13955: $msg .= '</p>';
1.984 raeburn 13956: return ('existingfile',$msg);
1.661 raeburn 13957: }
13958: }
13959: }
13960:
1.987 raeburn 13961: sub check_for_traversal {
13962: my ($path,$url,$toplevel) = @_;
13963: my @parts=split(/\//,$path);
13964: my $cleanpath;
13965: my $fullpath = $url;
13966: for (my $i=0;$i<@parts;$i++) {
13967: next if ($parts[$i] eq '.');
13968: if ($parts[$i] eq '..') {
13969: $fullpath =~ s{([^/]+/)$}{};
13970: } else {
13971: $fullpath .= $parts[$i].'/';
13972: }
13973: }
13974: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13975: $cleanpath = $1;
13976: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13977: my $curr_toprel = $1;
13978: my @parts = split(/\//,$curr_toprel);
13979: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13980: my @urlparts = split(/\//,$url_toprel);
13981: my $doubledots;
13982: my $startdiff = -1;
13983: for (my $i=0; $i<@urlparts; $i++) {
13984: if ($startdiff == -1) {
13985: unless ($urlparts[$i] eq $parts[$i]) {
13986: $startdiff = $i;
13987: $doubledots .= '../';
13988: }
13989: } else {
13990: $doubledots .= '../';
13991: }
13992: }
13993: if ($startdiff > -1) {
13994: $cleanpath = $doubledots;
13995: for (my $i=$startdiff; $i<@parts; $i++) {
13996: $cleanpath .= $parts[$i].'/';
13997: }
13998: }
13999: }
14000: $cleanpath =~ s{(/)$}{};
14001: return $cleanpath;
14002: }
1.31 albertel 14003:
1.1053 raeburn 14004: sub is_archive_file {
14005: my ($mimetype) = @_;
14006: if (($mimetype eq 'application/octet-stream') ||
14007: ($mimetype eq 'application/x-stuffit') ||
14008: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
14009: return 1;
14010: }
14011: return;
14012: }
14013:
14014: sub decompress_form {
1.1065 raeburn 14015: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 14016: my %lt = &Apache::lonlocal::texthash (
14017: this => 'This file is an archive file.',
1.1067 raeburn 14018: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 14019: itsc => 'Its contents are as follows:',
1.1053 raeburn 14020: youm => 'You may wish to extract its contents.',
14021: extr => 'Extract contents',
1.1067 raeburn 14022: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
14023: proa => 'Process automatically?',
1.1053 raeburn 14024: yes => 'Yes',
14025: no => 'No',
1.1067 raeburn 14026: fold => 'Title for folder containing movie',
14027: movi => 'Title for page containing embedded movie',
1.1053 raeburn 14028: );
1.1065 raeburn 14029: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 14030: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 14031: my $info = &list_archive_contents($fileloc,\@paths);
14032: if (@paths) {
14033: foreach my $path (@paths) {
14034: $path =~ s{^/}{};
1.1067 raeburn 14035: if ($path =~ m{^([^/]+)/$}) {
14036: $topdir = $1;
14037: }
1.1065 raeburn 14038: if ($path =~ m{^([^/]+)/}) {
14039: $toplevel{$1} = $path;
14040: } else {
14041: $toplevel{$path} = $path;
14042: }
14043: }
14044: }
1.1067 raeburn 14045: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 14046: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 14047: "$topdir/media/",
14048: "$topdir/media/$topdir.mp4",
14049: "$topdir/media/FirstFrame.png",
14050: "$topdir/media/player.swf",
14051: "$topdir/media/swfobject.js",
14052: "$topdir/media/expressInstall.swf");
1.1197 raeburn 14053: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 14054: "$topdir/$topdir.mp4",
14055: "$topdir/$topdir\_config.xml",
14056: "$topdir/$topdir\_controller.swf",
14057: "$topdir/$topdir\_embed.css",
14058: "$topdir/$topdir\_First_Frame.png",
14059: "$topdir/$topdir\_player.html",
14060: "$topdir/$topdir\_Thumbnails.png",
14061: "$topdir/playerProductInstall.swf",
14062: "$topdir/scripts/",
14063: "$topdir/scripts/config_xml.js",
14064: "$topdir/scripts/handlebars.js",
14065: "$topdir/scripts/jquery-1.7.1.min.js",
14066: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
14067: "$topdir/scripts/modernizr.js",
14068: "$topdir/scripts/player-min.js",
14069: "$topdir/scripts/swfobject.js",
14070: "$topdir/skins/",
14071: "$topdir/skins/configuration_express.xml",
14072: "$topdir/skins/express_show/",
14073: "$topdir/skins/express_show/player-min.css",
14074: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 14075: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
14076: "$topdir/$topdir.mp4",
14077: "$topdir/$topdir\_config.xml",
14078: "$topdir/$topdir\_controller.swf",
14079: "$topdir/$topdir\_embed.css",
14080: "$topdir/$topdir\_First_Frame.png",
14081: "$topdir/$topdir\_player.html",
14082: "$topdir/$topdir\_Thumbnails.png",
14083: "$topdir/playerProductInstall.swf",
14084: "$topdir/scripts/",
14085: "$topdir/scripts/config_xml.js",
14086: "$topdir/scripts/techsmith-smart-player.min.js",
14087: "$topdir/skins/",
14088: "$topdir/skins/configuration_express.xml",
14089: "$topdir/skins/express_show/",
14090: "$topdir/skins/express_show/spritesheet.min.css",
14091: "$topdir/skins/express_show/spritesheet.png",
14092: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 14093: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 14094: if (@diffs == 0) {
1.1164 raeburn 14095: $is_camtasia = 6;
14096: } else {
1.1197 raeburn 14097: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 14098: if (@diffs == 0) {
14099: $is_camtasia = 8;
1.1197 raeburn 14100: } else {
14101: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
14102: if (@diffs == 0) {
14103: $is_camtasia = 8;
14104: }
1.1164 raeburn 14105: }
1.1067 raeburn 14106: }
14107: }
14108: my $output;
14109: if ($is_camtasia) {
14110: $output = <<"ENDCAM";
14111: <script type="text/javascript" language="Javascript">
14112: // <![CDATA[
14113:
14114: function camtasiaToggle() {
14115: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
14116: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 14117: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 14118: document.getElementById('camtasia_titles').style.display='block';
14119: } else {
14120: document.getElementById('camtasia_titles').style.display='none';
14121: }
14122: }
14123: }
14124: return;
14125: }
14126:
14127: // ]]>
14128: </script>
14129: <p>$lt{'camt'}</p>
14130: ENDCAM
1.1065 raeburn 14131: } else {
1.1067 raeburn 14132: $output = '<p>'.$lt{'this'};
14133: if ($info eq '') {
14134: $output .= ' '.$lt{'youm'}.'</p>'."\n";
14135: } else {
14136: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
14137: '<div><pre>'.$info.'</pre></div>';
14138: }
1.1065 raeburn 14139: }
1.1067 raeburn 14140: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 14141: my $duplicates;
14142: my $num = 0;
14143: if (ref($dirlist) eq 'ARRAY') {
14144: foreach my $item (@{$dirlist}) {
14145: if (ref($item) eq 'ARRAY') {
14146: if (exists($toplevel{$item->[0]})) {
14147: $duplicates .=
14148: &start_data_table_row().
14149: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
14150: 'value="0" checked="checked" />'.&mt('No').'</label>'.
14151: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
14152: 'value="1" />'.&mt('Yes').'</label>'.
14153: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
14154: '<td>'.$item->[0].'</td>';
14155: if ($item->[2]) {
14156: $duplicates .= '<td>'.&mt('Directory').'</td>';
14157: } else {
14158: $duplicates .= '<td>'.&mt('File').'</td>';
14159: }
14160: $duplicates .= '<td>'.$item->[3].'</td>'.
14161: '<td>'.
14162: &Apache::lonlocal::locallocaltime($item->[4]).
14163: '</td>'.
14164: &end_data_table_row();
14165: $num ++;
14166: }
14167: }
14168: }
14169: }
14170: my $itemcount;
14171: if (@paths > 0) {
14172: $itemcount = scalar(@paths);
14173: } else {
14174: $itemcount = 1;
14175: }
1.1067 raeburn 14176: if ($is_camtasia) {
14177: $output .= $lt{'auto'}.'<br />'.
14178: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14179: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14180: $lt{'yes'}.'</label> <label>'.
14181: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14182: $lt{'no'}.'</label></span><br />'.
14183: '<div id="camtasia_titles" style="display:block">'.
14184: &Apache::lonhtmlcommon::start_pick_box().
14185: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14186: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14187: &Apache::lonhtmlcommon::row_closure().
14188: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14189: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14190: &Apache::lonhtmlcommon::row_closure(1).
14191: &Apache::lonhtmlcommon::end_pick_box().
14192: '</div>';
14193: }
1.1065 raeburn 14194: $output .=
14195: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14196: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14197: "\n";
1.1065 raeburn 14198: if ($duplicates ne '') {
14199: $output .= '<p><span class="LC_warning">'.
14200: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14201: &start_data_table().
14202: &start_data_table_header_row().
14203: '<th>'.&mt('Overwrite?').'</th>'.
14204: '<th>'.&mt('Name').'</th>'.
14205: '<th>'.&mt('Type').'</th>'.
14206: '<th>'.&mt('Size').'</th>'.
14207: '<th>'.&mt('Last modified').'</th>'.
14208: &end_data_table_header_row().
14209: $duplicates.
14210: &end_data_table().
14211: '</p>';
14212: }
1.1067 raeburn 14213: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14214: if (ref($hiddenelements) eq 'HASH') {
14215: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14216: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14217: }
14218: }
14219: $output .= <<"END";
1.1067 raeburn 14220: <br />
1.1053 raeburn 14221: <input type="submit" name="decompress" value="$lt{'extr'}" />
14222: </form>
14223: $noextract
14224: END
14225: return $output;
14226: }
14227:
1.1065 raeburn 14228: sub decompression_utility {
14229: my ($program) = @_;
14230: my @utilities = ('tar','gunzip','bunzip2','unzip');
14231: my $location;
14232: if (grep(/^\Q$program\E$/,@utilities)) {
14233: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14234: '/usr/sbin/') {
14235: if (-x $dir.$program) {
14236: $location = $dir.$program;
14237: last;
14238: }
14239: }
14240: }
14241: return $location;
14242: }
14243:
14244: sub list_archive_contents {
14245: my ($file,$pathsref) = @_;
14246: my (@cmd,$output);
14247: my $needsregexp;
14248: if ($file =~ /\.zip$/) {
14249: @cmd = (&decompression_utility('unzip'),"-l");
14250: $needsregexp = 1;
14251: } elsif (($file =~ m/\.tar\.gz$/) ||
14252: ($file =~ /\.tgz$/)) {
14253: @cmd = (&decompression_utility('tar'),"-ztf");
14254: } elsif ($file =~ /\.tar\.bz2$/) {
14255: @cmd = (&decompression_utility('tar'),"-jtf");
14256: } elsif ($file =~ m|\.tar$|) {
14257: @cmd = (&decompression_utility('tar'),"-tf");
14258: }
14259: if (@cmd) {
14260: undef($!);
14261: undef($@);
14262: if (open(my $fh,"-|", @cmd, $file)) {
14263: while (my $line = <$fh>) {
14264: $output .= $line;
14265: chomp($line);
14266: my $item;
14267: if ($needsregexp) {
14268: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14269: } else {
14270: $item = $line;
14271: }
14272: if ($item ne '') {
14273: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14274: push(@{$pathsref},$item);
14275: }
14276: }
14277: }
14278: close($fh);
14279: }
14280: }
14281: return $output;
14282: }
14283:
1.1053 raeburn 14284: sub decompress_uploaded_file {
14285: my ($file,$dir) = @_;
14286: &Apache::lonnet::appenv({'cgi.file' => $file});
14287: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14288: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14289: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14290: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14291: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14292: my $decompressed = $env{'cgi.decompressed'};
14293: &Apache::lonnet::delenv('cgi.file');
14294: &Apache::lonnet::delenv('cgi.dir');
14295: &Apache::lonnet::delenv('cgi.decompressed');
14296: return ($decompressed,$result);
14297: }
14298:
1.1055 raeburn 14299: sub process_decompression {
14300: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14301: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14302: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14303: &mt('Unexpected file path.').'</p>'."\n";
14304: }
14305: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14306: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14307: &mt('Unexpected course context.').'</p>'."\n";
14308: }
1.1293 raeburn 14309: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14310: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14311: &mt('Filename contained unexpected characters.').'</p>'."\n";
14312: }
1.1055 raeburn 14313: my ($dir,$error,$warning,$output);
1.1180 raeburn 14314: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14315: $error = &mt('Filename not a supported archive file type.').
14316: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14317: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14318: } else {
14319: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14320: if ($docuhome eq 'no_host') {
14321: $error = &mt('Could not determine home server for course.');
14322: } else {
14323: my @ids=&Apache::lonnet::current_machine_ids();
14324: my $currdir = "$dir_root/$destination";
14325: if (grep(/^\Q$docuhome\E$/,@ids)) {
14326: $dir = &LONCAPA::propath($docudom,$docuname).
14327: "$dir_root/$destination";
14328: } else {
14329: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14330: "$dir_root/$docudom/$docuname/$destination";
14331: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14332: $error = &mt('Archive file not found.');
14333: }
14334: }
1.1065 raeburn 14335: my (@to_overwrite,@to_skip);
14336: if ($env{'form.archive_overwrite_total'} > 0) {
14337: my $total = $env{'form.archive_overwrite_total'};
14338: for (my $i=0; $i<$total; $i++) {
14339: if ($env{'form.archive_overwrite_'.$i} == 1) {
14340: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14341: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14342: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14343: }
14344: }
14345: }
14346: my $numskip = scalar(@to_skip);
1.1292 raeburn 14347: my $numoverwrite = scalar(@to_overwrite);
14348: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14349: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14350: } elsif ($dir eq '') {
1.1055 raeburn 14351: $error = &mt('Directory containing archive file unavailable.');
14352: } elsif (!$error) {
1.1065 raeburn 14353: my ($decompressed,$display);
1.1292 raeburn 14354: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14355: my $tempdir = time.'_'.$$.int(rand(10000));
14356: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14357: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14358: ($decompressed,$display) =
14359: &decompress_uploaded_file($file,"$dir/$tempdir");
14360: foreach my $item (@to_skip) {
14361: if (($item ne '') && ($item !~ /\.\./)) {
14362: if (-f "$dir/$tempdir/$item") {
14363: unlink("$dir/$tempdir/$item");
14364: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14365: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14366: }
14367: }
14368: }
14369: foreach my $item (@to_overwrite) {
14370: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14371: if (($item ne '') && ($item !~ /\.\./)) {
14372: if (-f "$dir/$item") {
14373: unlink("$dir/$item");
14374: } elsif (-d "$dir/$item") {
1.1300 raeburn 14375: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14376: }
14377: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14378: }
1.1065 raeburn 14379: }
14380: }
1.1292 raeburn 14381: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14382: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14383: }
1.1065 raeburn 14384: }
14385: } else {
14386: ($decompressed,$display) =
14387: &decompress_uploaded_file($file,$dir);
14388: }
1.1055 raeburn 14389: if ($decompressed eq 'ok') {
1.1065 raeburn 14390: $output = '<p class="LC_info">'.
14391: &mt('Files extracted successfully from archive.').
14392: '</p>'."\n";
1.1055 raeburn 14393: my ($warning,$result,@contents);
14394: my ($newdirlistref,$newlisterror) =
14395: &Apache::lonnet::dirlist($currdir,$docudom,
14396: $docuname,1);
14397: my (%is_dir,%changes,@newitems);
14398: my $dirptr = 16384;
1.1065 raeburn 14399: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14400: foreach my $dir_line (@{$newdirlistref}) {
14401: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14402: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14403: push(@newitems,$item);
14404: if ($dirptr&$testdir) {
14405: $is_dir{$item} = 1;
14406: }
14407: $changes{$item} = 1;
14408: }
14409: }
14410: }
14411: if (keys(%changes) > 0) {
14412: foreach my $item (sort(@newitems)) {
14413: if ($changes{$item}) {
14414: push(@contents,$item);
14415: }
14416: }
14417: }
14418: if (@contents > 0) {
1.1067 raeburn 14419: my $wantform;
14420: unless ($env{'form.autoextract_camtasia'}) {
14421: $wantform = 1;
14422: }
1.1056 raeburn 14423: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14424: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14425: $currdir,\%is_dir,
14426: \%children,\%parent,
1.1056 raeburn 14427: \@contents,\%dirorder,
14428: \%titles,$wantform);
1.1055 raeburn 14429: if ($datatable ne '') {
14430: $output .= &archive_options_form('decompressed',$datatable,
14431: $count,$hiddenelem);
1.1065 raeburn 14432: my $startcount = 6;
1.1055 raeburn 14433: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14434: \%titles,\%children);
1.1055 raeburn 14435: }
1.1067 raeburn 14436: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14437: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14438: my %displayed;
14439: my $total = 1;
14440: $env{'form.archive_directory'} = [];
14441: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14442: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14443: $path =~ s{/$}{};
14444: my $item;
14445: if ($path ne '') {
14446: $item = "$path/$titles{$i}";
14447: } else {
14448: $item = $titles{$i};
14449: }
14450: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14451: if ($item eq $contents[0]) {
14452: push(@{$env{'form.archive_directory'}},$i);
14453: $env{'form.archive_'.$i} = 'display';
14454: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14455: $displayed{'folder'} = $i;
1.1164 raeburn 14456: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14457: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14458: $env{'form.archive_'.$i} = 'display';
14459: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14460: $displayed{'web'} = $i;
14461: } else {
1.1164 raeburn 14462: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14463: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14464: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14465: push(@{$env{'form.archive_directory'}},$i);
14466: }
14467: $env{'form.archive_'.$i} = 'dependency';
14468: }
14469: $total ++;
14470: }
14471: for (my $i=1; $i<$total; $i++) {
14472: next if ($i == $displayed{'web'});
14473: next if ($i == $displayed{'folder'});
14474: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14475: }
14476: $env{'form.phase'} = 'decompress_cleanup';
14477: $env{'form.archivedelete'} = 1;
14478: $env{'form.archive_count'} = $total-1;
14479: $output .=
14480: &process_extracted_files('coursedocs',$docudom,
14481: $docuname,$destination,
14482: $dir_root,$hiddenelem);
14483: }
1.1055 raeburn 14484: } else {
14485: $warning = &mt('No new items extracted from archive file.');
14486: }
14487: } else {
14488: $output = $display;
14489: $error = &mt('An error occurred during extraction from the archive file.');
14490: }
14491: }
14492: }
14493: }
14494: if ($error) {
14495: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14496: $error.'</p>'."\n";
14497: }
14498: if ($warning) {
14499: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14500: }
14501: return $output;
14502: }
14503:
14504: sub get_extracted {
1.1056 raeburn 14505: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14506: $titles,$wantform) = @_;
1.1055 raeburn 14507: my $count = 0;
14508: my $depth = 0;
14509: my $datatable;
1.1056 raeburn 14510: my @hierarchy;
1.1055 raeburn 14511: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14512: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14513: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14514: foreach my $item (@{$contents}) {
14515: $count ++;
1.1056 raeburn 14516: @{$dirorder->{$count}} = @hierarchy;
14517: $titles->{$count} = $item;
1.1055 raeburn 14518: &archive_hierarchy($depth,$count,$parent,$children);
14519: if ($wantform) {
14520: $datatable .= &archive_row($is_dir->{$item},$item,
14521: $currdir,$depth,$count);
14522: }
14523: if ($is_dir->{$item}) {
14524: $depth ++;
1.1056 raeburn 14525: push(@hierarchy,$count);
14526: $parent->{$depth} = $count;
1.1055 raeburn 14527: $datatable .=
14528: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14529: \$depth,\$count,\@hierarchy,$dirorder,
14530: $children,$parent,$titles,$wantform);
1.1055 raeburn 14531: $depth --;
1.1056 raeburn 14532: pop(@hierarchy);
1.1055 raeburn 14533: }
14534: }
14535: return ($count,$datatable);
14536: }
14537:
14538: sub recurse_extracted_archive {
1.1056 raeburn 14539: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14540: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14541: my $result='';
1.1056 raeburn 14542: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14543: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14544: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14545: return $result;
14546: }
14547: my $dirptr = 16384;
14548: my ($newdirlistref,$newlisterror) =
14549: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14550: if (ref($newdirlistref) eq 'ARRAY') {
14551: foreach my $dir_line (@{$newdirlistref}) {
14552: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14553: unless ($item =~ /^\.+$/) {
14554: $$count ++;
1.1056 raeburn 14555: @{$dirorder->{$$count}} = @{$hierarchy};
14556: $titles->{$$count} = $item;
1.1055 raeburn 14557: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14558:
1.1055 raeburn 14559: my $is_dir;
14560: if ($dirptr&$testdir) {
14561: $is_dir = 1;
14562: }
14563: if ($wantform) {
14564: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14565: }
14566: if ($is_dir) {
14567: $$depth ++;
1.1056 raeburn 14568: push(@{$hierarchy},$$count);
14569: $parent->{$$depth} = $$count;
1.1055 raeburn 14570: $result .=
14571: &recurse_extracted_archive("$currdir/$item",$docudom,
14572: $docuname,$depth,$count,
1.1056 raeburn 14573: $hierarchy,$dirorder,$children,
14574: $parent,$titles,$wantform);
1.1055 raeburn 14575: $$depth --;
1.1056 raeburn 14576: pop(@{$hierarchy});
1.1055 raeburn 14577: }
14578: }
14579: }
14580: }
14581: return $result;
14582: }
14583:
14584: sub archive_hierarchy {
14585: my ($depth,$count,$parent,$children) =@_;
14586: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14587: if (exists($parent->{$depth})) {
14588: $children->{$parent->{$depth}} .= $count.':';
14589: }
14590: }
14591: return;
14592: }
14593:
14594: sub archive_row {
14595: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14596: my ($name) = ($item =~ m{([^/]+)$});
14597: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14598: 'display' => 'Add as file',
1.1055 raeburn 14599: 'dependency' => 'Include as dependency',
14600: 'discard' => 'Discard',
14601: );
14602: if ($is_dir) {
1.1059 raeburn 14603: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14604: }
1.1056 raeburn 14605: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14606: my $offset = 0;
1.1055 raeburn 14607: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14608: $offset ++;
1.1065 raeburn 14609: if ($action ne 'display') {
14610: $offset ++;
14611: }
1.1055 raeburn 14612: $output .= '<td><span class="LC_nobreak">'.
14613: '<label><input type="radio" name="archive_'.$count.
14614: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14615: my $text = $choices{$action};
14616: if ($is_dir) {
14617: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14618: if ($action eq 'display') {
1.1059 raeburn 14619: $text = &mt('Add as folder');
1.1055 raeburn 14620: }
1.1056 raeburn 14621: } else {
14622: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14623:
14624: }
14625: $output .= ' /> '.$choices{$action}.'</label></span>';
14626: if ($action eq 'dependency') {
14627: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14628: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14629: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14630: '<option value=""></option>'."\n".
14631: '</select>'."\n".
14632: '</div>';
1.1059 raeburn 14633: } elsif ($action eq 'display') {
14634: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14635: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14636: '</div>';
1.1055 raeburn 14637: }
1.1056 raeburn 14638: $output .= '</td>';
1.1055 raeburn 14639: }
14640: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14641: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14642: for (my $i=0; $i<$depth; $i++) {
14643: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14644: }
14645: if ($is_dir) {
14646: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14647: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14648: } else {
14649: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14650: }
14651: $output .= ' '.$name.'</td>'."\n".
14652: &end_data_table_row();
14653: return $output;
14654: }
14655:
14656: sub archive_options_form {
1.1065 raeburn 14657: my ($form,$display,$count,$hiddenelem) = @_;
14658: my %lt = &Apache::lonlocal::texthash(
14659: perm => 'Permanently remove archive file?',
14660: hows => 'How should each extracted item be incorporated in the course?',
14661: cont => 'Content actions for all',
14662: addf => 'Add as folder/file',
14663: incd => 'Include as dependency for a displayed file',
14664: disc => 'Discard',
14665: no => 'No',
14666: yes => 'Yes',
14667: save => 'Save',
14668: );
14669: my $output = <<"END";
14670: <form name="$form" method="post" action="">
14671: <p><span class="LC_nobreak">$lt{'perm'}
14672: <label>
14673: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14674: </label>
14675:
14676: <label>
14677: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14678: </span>
14679: </p>
14680: <input type="hidden" name="phase" value="decompress_cleanup" />
14681: <br />$lt{'hows'}
14682: <div class="LC_columnSection">
14683: <fieldset>
14684: <legend>$lt{'cont'}</legend>
14685: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14686: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14687: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14688: </fieldset>
14689: </div>
14690: END
14691: return $output.
1.1055 raeburn 14692: &start_data_table()."\n".
1.1065 raeburn 14693: $display."\n".
1.1055 raeburn 14694: &end_data_table()."\n".
14695: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14696: $hiddenelem.
1.1065 raeburn 14697: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14698: '</form>';
14699: }
14700:
14701: sub archive_javascript {
1.1056 raeburn 14702: my ($startcount,$numitems,$titles,$children) = @_;
14703: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14704: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14705: my $scripttag = <<START;
14706: <script type="text/javascript">
14707: // <![CDATA[
14708:
14709: function checkAll(form,prefix) {
14710: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14711: for (var i=0; i < form.elements.length; i++) {
14712: var id = form.elements[i].id;
14713: if ((id != '') && (id != undefined)) {
14714: if (idstr.test(id)) {
14715: if (form.elements[i].type == 'radio') {
14716: form.elements[i].checked = true;
1.1056 raeburn 14717: var nostart = i-$startcount;
1.1059 raeburn 14718: var offset = nostart%7;
14719: var count = (nostart-offset)/7;
1.1056 raeburn 14720: dependencyCheck(form,count,offset);
1.1055 raeburn 14721: }
14722: }
14723: }
14724: }
14725: }
14726:
14727: function propagateCheck(form,count) {
14728: if (count > 0) {
1.1059 raeburn 14729: var startelement = $startcount + ((count-1) * 7);
14730: for (var j=1; j<6; j++) {
14731: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14732: var item = startelement + j;
14733: if (form.elements[item].type == 'radio') {
14734: if (form.elements[item].checked) {
14735: containerCheck(form,count,j);
14736: break;
14737: }
1.1055 raeburn 14738: }
14739: }
14740: }
14741: }
14742: }
14743:
14744: numitems = $numitems
1.1056 raeburn 14745: var titles = new Array(numitems);
14746: var parents = new Array(numitems);
1.1055 raeburn 14747: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14748: parents[i] = new Array;
1.1055 raeburn 14749: }
1.1059 raeburn 14750: var maintitle = '$maintitle';
1.1055 raeburn 14751:
14752: START
14753:
1.1056 raeburn 14754: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14755: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14756: for (my $i=0; $i<@contents; $i ++) {
14757: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14758: }
14759: }
14760:
1.1056 raeburn 14761: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14762: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14763: }
14764:
1.1055 raeburn 14765: $scripttag .= <<END;
14766:
14767: function containerCheck(form,count,offset) {
14768: if (count > 0) {
1.1056 raeburn 14769: dependencyCheck(form,count,offset);
1.1059 raeburn 14770: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14771: form.elements[item].checked = true;
14772: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14773: if (parents[count].length > 0) {
14774: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14775: containerCheck(form,parents[count][j],offset);
14776: }
14777: }
14778: }
14779: }
14780: }
14781:
14782: function dependencyCheck(form,count,offset) {
14783: if (count > 0) {
1.1059 raeburn 14784: var chosen = (offset+$startcount)+7*(count-1);
14785: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14786: var currtype = form.elements[depitem].type;
14787: if (form.elements[chosen].value == 'dependency') {
14788: document.getElementById('arc_depon_'+count).style.display='block';
14789: form.elements[depitem].options.length = 0;
14790: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14791: for (var i=1; i<=numitems; i++) {
14792: if (i == count) {
14793: continue;
14794: }
1.1059 raeburn 14795: var startelement = $startcount + (i-1) * 7;
14796: for (var j=1; j<6; j++) {
14797: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14798: var item = startelement + j;
14799: if (form.elements[item].type == 'radio') {
14800: if (form.elements[item].checked) {
14801: if (form.elements[item].value == 'display') {
14802: var n = form.elements[depitem].options.length;
14803: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14804: }
14805: }
14806: }
14807: }
14808: }
14809: }
14810: } else {
14811: document.getElementById('arc_depon_'+count).style.display='none';
14812: form.elements[depitem].options.length = 0;
14813: form.elements[depitem].options[0] = new Option('Select','',true,true);
14814: }
1.1059 raeburn 14815: titleCheck(form,count,offset);
1.1056 raeburn 14816: }
14817: }
14818:
14819: function propagateSelect(form,count,offset) {
14820: if (count > 0) {
1.1065 raeburn 14821: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14822: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14823: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14824: if (parents[count].length > 0) {
14825: for (var j=0; j<parents[count].length; j++) {
14826: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14827: }
14828: }
14829: }
14830: }
14831: }
1.1056 raeburn 14832:
14833: function containerSelect(form,count,offset,picked) {
14834: if (count > 0) {
1.1065 raeburn 14835: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14836: if (form.elements[item].type == 'radio') {
14837: if (form.elements[item].value == 'dependency') {
14838: if (form.elements[item+1].type == 'select-one') {
14839: for (var i=0; i<form.elements[item+1].options.length; i++) {
14840: if (form.elements[item+1].options[i].value == picked) {
14841: form.elements[item+1].selectedIndex = i;
14842: break;
14843: }
14844: }
14845: }
14846: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14847: if (parents[count].length > 0) {
14848: for (var j=0; j<parents[count].length; j++) {
14849: containerSelect(form,parents[count][j],offset,picked);
14850: }
14851: }
14852: }
14853: }
14854: }
14855: }
14856: }
14857:
1.1059 raeburn 14858: function titleCheck(form,count,offset) {
14859: if (count > 0) {
14860: var chosen = (offset+$startcount)+7*(count-1);
14861: var depitem = $startcount + ((count-1) * 7) + 2;
14862: var currtype = form.elements[depitem].type;
14863: if (form.elements[chosen].value == 'display') {
14864: document.getElementById('arc_title_'+count).style.display='block';
14865: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14866: document.getElementById('archive_title_'+count).value=maintitle;
14867: }
14868: } else {
14869: document.getElementById('arc_title_'+count).style.display='none';
14870: if (currtype == 'text') {
14871: document.getElementById('archive_title_'+count).value='';
14872: }
14873: }
14874: }
14875: return;
14876: }
14877:
1.1055 raeburn 14878: // ]]>
14879: </script>
14880: END
14881: return $scripttag;
14882: }
14883:
14884: sub process_extracted_files {
1.1067 raeburn 14885: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14886: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14887: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14888: my @ids=&Apache::lonnet::current_machine_ids();
14889: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14890: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14891: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14892: if (grep(/^\Q$docuhome\E$/,@ids)) {
14893: $prefix = &LONCAPA::propath($docudom,$docuname);
14894: $pathtocheck = "$dir_root/$destination";
14895: $dir = $dir_root;
14896: $ishome = 1;
14897: } else {
14898: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14899: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14900: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14901: }
14902: my $currdir = "$dir_root/$destination";
14903: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14904: if ($env{'form.folderpath'}) {
14905: my @items = split('&',$env{'form.folderpath'});
14906: $folders{'0'} = $items[-2];
1.1099 raeburn 14907: if ($env{'form.folderpath'} =~ /\:1$/) {
14908: $containers{'0'}='page';
14909: } else {
14910: $containers{'0'}='sequence';
14911: }
1.1055 raeburn 14912: }
14913: my @archdirs = &get_env_multiple('form.archive_directory');
14914: if ($numitems) {
14915: for (my $i=1; $i<=$numitems; $i++) {
14916: my $path = $env{'form.archive_content_'.$i};
14917: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14918: my $item = $1;
14919: $toplevelitems{$item} = $i;
14920: if (grep(/^\Q$i\E$/,@archdirs)) {
14921: $is_dir{$item} = 1;
14922: }
14923: }
14924: }
14925: }
1.1067 raeburn 14926: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14927: if (keys(%toplevelitems) > 0) {
14928: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14929: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14930: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14931: }
1.1066 raeburn 14932: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14933: if ($numitems) {
14934: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14935: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14936: my $path = $env{'form.archive_content_'.$i};
14937: if ($path =~ /^\Q$pathtocheck\E/) {
14938: if ($env{'form.archive_'.$i} eq 'discard') {
14939: if ($prefix ne '' && $path ne '') {
14940: if (-e $prefix.$path) {
1.1066 raeburn 14941: if ((@archdirs > 0) &&
14942: (grep(/^\Q$i\E$/,@archdirs))) {
14943: $todeletedir{$prefix.$path} = 1;
14944: } else {
14945: $todelete{$prefix.$path} = 1;
14946: }
1.1055 raeburn 14947: }
14948: }
14949: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14950: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14951: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14952: $docstitle = $env{'form.archive_title_'.$i};
14953: if ($docstitle eq '') {
14954: $docstitle = $title;
14955: }
1.1055 raeburn 14956: $outer = 0;
1.1056 raeburn 14957: if (ref($dirorder{$i}) eq 'ARRAY') {
14958: if (@{$dirorder{$i}} > 0) {
14959: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14960: if ($env{'form.archive_'.$item} eq 'display') {
14961: $outer = $item;
14962: last;
14963: }
14964: }
14965: }
14966: }
14967: my ($errtext,$fatal) =
14968: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14969: '/'.$folders{$outer}.'.'.
14970: $containers{$outer});
14971: next if ($fatal);
14972: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14973: if ($context eq 'coursedocs') {
1.1056 raeburn 14974: $mapinner{$i} = time;
1.1055 raeburn 14975: $folders{$i} = 'default_'.$mapinner{$i};
14976: $containers{$i} = 'sequence';
14977: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14978: $folders{$i}.'.'.$containers{$i};
14979: my $newidx = &LONCAPA::map::getresidx();
14980: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14981: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14982: push(@LONCAPA::map::order,$newidx);
14983: my ($outtext,$errtext) =
14984: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14985: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14986: '.'.$containers{$outer},1,1);
1.1056 raeburn 14987: $newseqid{$i} = $newidx;
1.1067 raeburn 14988: unless ($errtext) {
1.1294 raeburn 14989: $result .= '<li>'.&mt('Folder: [_1] added to course',
14990: &HTML::Entities::encode($docstitle,'<>&"')).
14991: '</li>'."\n";
1.1067 raeburn 14992: }
1.1055 raeburn 14993: }
14994: } else {
14995: if ($context eq 'coursedocs') {
14996: my $newidx=&LONCAPA::map::getresidx();
14997: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14998: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14999: $title;
1.1392 raeburn 15000: if (($outer !~ /\D/) &&
15001: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
15002: ($newidx !~ /\D/)) {
1.1294 raeburn 15003: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
15004: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
15005: }
15006: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
15007: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
15008: }
15009: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
15010: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
15011: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
15012: unless ($ishome) {
15013: my $fetch = "$newdest{$i}/$title";
15014: $fetch =~ s/^\Q$prefix$dir\E//;
15015: $prompttofetch{$fetch} = 1;
15016: }
1.1292 raeburn 15017: }
1.1067 raeburn 15018: }
1.1294 raeburn 15019: $LONCAPA::map::resources[$newidx]=
15020: $docstitle.':'.$url.':false:normal:res';
15021: push(@LONCAPA::map::order, $newidx);
15022: my ($outtext,$errtext)=
15023: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
15024: $docuname.'/'.$folders{$outer}.
15025: '.'.$containers{$outer},1,1);
15026: unless ($errtext) {
15027: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
15028: $result .= '<li>'.&mt('File: [_1] added to course',
15029: &HTML::Entities::encode($docstitle,'<>&"')).
15030: '</li>'."\n";
15031: }
1.1067 raeburn 15032: }
1.1294 raeburn 15033: } else {
15034: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
15035: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 15036: }
1.1055 raeburn 15037: }
15038: }
1.1086 raeburn 15039: }
15040: } else {
1.1294 raeburn 15041: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
15042: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 15043: }
15044: }
15045: for (my $i=1; $i<=$numitems; $i++) {
15046: next unless ($env{'form.archive_'.$i} eq 'dependency');
15047: my $path = $env{'form.archive_content_'.$i};
15048: if ($path =~ /^\Q$pathtocheck\E/) {
15049: my ($title) = ($path =~ m{/([^/]+)$});
15050: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
15051: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
15052: if (ref($dirorder{$i}) eq 'ARRAY') {
15053: my ($itemidx,$fullpath,$relpath);
15054: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
15055: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 15056: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 15057: if ($dirorder{$i}->[$j] eq $container) {
15058: $itemidx = $j;
1.1056 raeburn 15059: }
15060: }
1.1086 raeburn 15061: }
15062: if ($itemidx eq '') {
15063: $itemidx = 0;
15064: }
15065: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
15066: if ($mapinner{$referrer{$i}}) {
15067: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
15068: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15069: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15070: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15071: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15072: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15073: if (!-e $fullpath) {
15074: mkdir($fullpath,0755);
1.1056 raeburn 15075: }
15076: }
1.1086 raeburn 15077: } else {
15078: last;
1.1056 raeburn 15079: }
1.1086 raeburn 15080: }
15081: }
15082: } elsif ($newdest{$referrer{$i}}) {
15083: $fullpath = $newdest{$referrer{$i}};
15084: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
15085: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
15086: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
15087: last;
15088: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
15089: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
15090: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
15091: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
15092: if (!-e $fullpath) {
15093: mkdir($fullpath,0755);
1.1056 raeburn 15094: }
15095: }
1.1086 raeburn 15096: } else {
15097: last;
1.1056 raeburn 15098: }
1.1055 raeburn 15099: }
15100: }
1.1086 raeburn 15101: if ($fullpath ne '') {
15102: if (-e "$prefix$path") {
1.1292 raeburn 15103: unless (rename("$prefix$path","$fullpath/$title")) {
15104: $warning .= &mt('Failed to rename dependency').'<br />';
15105: }
1.1086 raeburn 15106: }
15107: if (-e "$fullpath/$title") {
15108: my $showpath;
15109: if ($relpath ne '') {
15110: $showpath = "$relpath/$title";
15111: } else {
15112: $showpath = "/$title";
15113: }
1.1294 raeburn 15114: $result .= '<li>'.&mt('[_1] included as a dependency',
15115: &HTML::Entities::encode($showpath,'<>&"')).
15116: '</li>'."\n";
1.1292 raeburn 15117: unless ($ishome) {
15118: my $fetch = "$fullpath/$title";
15119: $fetch =~ s/^\Q$prefix$dir\E//;
15120: $prompttofetch{$fetch} = 1;
15121: }
1.1086 raeburn 15122: }
15123: }
1.1055 raeburn 15124: }
1.1086 raeburn 15125: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
15126: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 15127: &HTML::Entities::encode($path,'<>&"'),
15128: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
15129: '<br />';
1.1055 raeburn 15130: }
15131: } else {
1.1294 raeburn 15132: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 15133: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 15134: }
15135: }
15136: if (keys(%todelete)) {
15137: foreach my $key (keys(%todelete)) {
15138: unlink($key);
1.1066 raeburn 15139: }
15140: }
15141: if (keys(%todeletedir)) {
15142: foreach my $key (keys(%todeletedir)) {
15143: rmdir($key);
15144: }
15145: }
15146: foreach my $dir (sort(keys(%is_dir))) {
15147: if (($pathtocheck ne '') && ($dir ne '')) {
15148: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 15149: }
15150: }
1.1067 raeburn 15151: if ($result ne '') {
15152: $output .= '<ul>'."\n".
15153: $result."\n".
15154: '</ul>';
15155: }
15156: unless ($ishome) {
15157: my $replicationfail;
15158: foreach my $item (keys(%prompttofetch)) {
15159: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
15160: unless ($fetchresult eq 'ok') {
15161: $replicationfail .= '<li>'.$item.'</li>'."\n";
15162: }
15163: }
15164: if ($replicationfail) {
15165: $output .= '<p class="LC_error">'.
15166: &mt('Course home server failed to retrieve:').'<ul>'.
15167: $replicationfail.
15168: '</ul></p>';
15169: }
15170: }
1.1055 raeburn 15171: } else {
15172: $warning = &mt('No items found in archive.');
15173: }
15174: if ($error) {
15175: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15176: $error.'</p>'."\n";
15177: }
15178: if ($warning) {
15179: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15180: }
15181: return $output;
15182: }
15183:
1.1066 raeburn 15184: sub cleanup_empty_dirs {
15185: my ($path) = @_;
15186: if (($path ne '') && (-d $path)) {
15187: if (opendir(my $dirh,$path)) {
15188: my @dircontents = grep(!/^\./,readdir($dirh));
15189: my $numitems = 0;
15190: foreach my $item (@dircontents) {
15191: if (-d "$path/$item") {
1.1111 raeburn 15192: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15193: if (-e "$path/$item") {
15194: $numitems ++;
15195: }
15196: } else {
15197: $numitems ++;
15198: }
15199: }
15200: if ($numitems == 0) {
15201: rmdir($path);
15202: }
15203: closedir($dirh);
15204: }
15205: }
15206: return;
15207: }
15208:
1.41 ng 15209: =pod
1.45 matthew 15210:
1.1162 raeburn 15211: =item * &get_folder_hierarchy()
1.1068 raeburn 15212:
15213: Provides hierarchy of names of folders/sub-folders containing the current
15214: item,
15215:
15216: Inputs: 3
15217: - $navmap - navmaps object
15218:
15219: - $map - url for map (either the trigger itself, or map containing
15220: the resource, which is the trigger).
15221:
15222: - $showitem - 1 => show title for map itself; 0 => do not show.
15223:
15224: Outputs: 1 @pathitems - array of folder/subfolder names.
15225:
15226: =cut
15227:
15228: sub get_folder_hierarchy {
15229: my ($navmap,$map,$showitem) = @_;
15230: my @pathitems;
15231: if (ref($navmap)) {
15232: my $mapres = $navmap->getResourceByUrl($map);
15233: if (ref($mapres)) {
15234: my $pcslist = $mapres->map_hierarchy();
15235: if ($pcslist ne '') {
15236: my @pcs = split(/,/,$pcslist);
15237: foreach my $pc (@pcs) {
15238: if ($pc == 1) {
1.1129 raeburn 15239: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15240: } else {
15241: my $res = $navmap->getByMapPc($pc);
15242: if (ref($res)) {
15243: my $title = $res->compTitle();
15244: $title =~ s/\W+/_/g;
15245: if ($title ne '') {
15246: push(@pathitems,$title);
15247: }
15248: }
15249: }
15250: }
15251: }
1.1071 raeburn 15252: if ($showitem) {
15253: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15254: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15255: } else {
15256: my $maptitle = $mapres->compTitle();
15257: $maptitle =~ s/\W+/_/g;
15258: if ($maptitle ne '') {
15259: push(@pathitems,$maptitle);
15260: }
1.1068 raeburn 15261: }
15262: }
15263: }
15264: }
15265: return @pathitems;
15266: }
15267:
15268: =pod
15269:
1.1015 raeburn 15270: =item * &get_turnedin_filepath()
15271:
15272: Determines path in a user's portfolio file for storage of files uploaded
15273: to a specific essayresponse or dropbox item.
15274:
15275: Inputs: 3 required + 1 optional.
15276: $symb is symb for resource, $uname and $udom are for current user (required).
15277: $caller is optional (can be "submission", if routine is called when storing
15278: an upoaded file when "Submit Answer" button was pressed).
15279:
15280: Returns array containing $path and $multiresp.
15281: $path is path in portfolio. $multiresp is 1 if this resource contains more
15282: than one file upload item. Callers of routine should append partid as a
15283: subdirectory to $path in cases where $multiresp is 1.
15284:
15285: Called by: homework/essayresponse.pm and homework/structuretags.pm
15286:
15287: =cut
15288:
15289: sub get_turnedin_filepath {
15290: my ($symb,$uname,$udom,$caller) = @_;
15291: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15292: my $turnindir;
15293: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15294: $turnindir = $userhash{'turnindir'};
15295: my ($path,$multiresp);
15296: if ($turnindir eq '') {
15297: if ($caller eq 'submission') {
15298: $turnindir = &mt('turned in');
15299: $turnindir =~ s/\W+/_/g;
15300: my %newhash = (
15301: 'turnindir' => $turnindir,
15302: );
15303: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15304: }
15305: }
15306: if ($turnindir ne '') {
15307: $path = '/'.$turnindir.'/';
15308: my ($multipart,$turnin,@pathitems);
15309: my $navmap = Apache::lonnavmaps::navmap->new();
15310: if (defined($navmap)) {
15311: my $mapres = $navmap->getResourceByUrl($map);
15312: if (ref($mapres)) {
15313: my $pcslist = $mapres->map_hierarchy();
15314: if ($pcslist ne '') {
15315: foreach my $pc (split(/,/,$pcslist)) {
15316: my $res = $navmap->getByMapPc($pc);
15317: if (ref($res)) {
15318: my $title = $res->compTitle();
15319: $title =~ s/\W+/_/g;
15320: if ($title ne '') {
1.1149 raeburn 15321: if (($pc > 1) && (length($title) > 12)) {
15322: $title = substr($title,0,12);
15323: }
1.1015 raeburn 15324: push(@pathitems,$title);
15325: }
15326: }
15327: }
15328: }
15329: my $maptitle = $mapres->compTitle();
15330: $maptitle =~ s/\W+/_/g;
15331: if ($maptitle ne '') {
1.1149 raeburn 15332: if (length($maptitle) > 12) {
15333: $maptitle = substr($maptitle,0,12);
15334: }
1.1015 raeburn 15335: push(@pathitems,$maptitle);
15336: }
15337: unless ($env{'request.state'} eq 'construct') {
15338: my $res = $navmap->getBySymb($symb);
15339: if (ref($res)) {
15340: my $partlist = $res->parts();
15341: my $totaluploads = 0;
15342: if (ref($partlist) eq 'ARRAY') {
15343: foreach my $part (@{$partlist}) {
15344: my @types = $res->responseType($part);
15345: my @ids = $res->responseIds($part);
15346: for (my $i=0; $i < scalar(@ids); $i++) {
15347: if ($types[$i] eq 'essay') {
15348: my $partid = $part.'_'.$ids[$i];
15349: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15350: $totaluploads ++;
15351: }
15352: }
15353: }
15354: }
15355: if ($totaluploads > 1) {
15356: $multiresp = 1;
15357: }
15358: }
15359: }
15360: }
15361: } else {
15362: return;
15363: }
15364: } else {
15365: return;
15366: }
15367: my $restitle=&Apache::lonnet::gettitle($symb);
15368: $restitle =~ s/\W+/_/g;
15369: if ($restitle eq '') {
15370: $restitle = ($resurl =~ m{/[^/]+$});
15371: if ($restitle eq '') {
15372: $restitle = time;
15373: }
15374: }
1.1149 raeburn 15375: if (length($restitle) > 12) {
15376: $restitle = substr($restitle,0,12);
15377: }
1.1015 raeburn 15378: push(@pathitems,$restitle);
15379: $path .= join('/',@pathitems);
15380: }
15381: return ($path,$multiresp);
15382: }
15383:
15384: =pod
15385:
1.464 albertel 15386: =back
1.41 ng 15387:
1.112 bowersj2 15388: =head1 CSV Upload/Handling functions
1.38 albertel 15389:
1.41 ng 15390: =over 4
15391:
1.648 raeburn 15392: =item * &upfile_store($r)
1.41 ng 15393:
15394: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15395: needs $env{'form.upfile'}
1.41 ng 15396: returns $datatoken to be put into hidden field
15397:
15398: =cut
1.31 albertel 15399:
15400: sub upfile_store {
15401: my $r=shift;
1.258 albertel 15402: $env{'form.upfile'}=~s/\r/\n/gs;
15403: $env{'form.upfile'}=~s/\f/\n/gs;
15404: $env{'form.upfile'}=~s/\n+/\n/gs;
15405: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15406:
1.1299 raeburn 15407: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15408: '_enroll_'.$env{'request.course.id'}.'_'.
15409: time.'_'.$$);
15410: return if ($datatoken eq '');
15411:
1.31 albertel 15412: {
1.158 raeburn 15413: my $datafile = $r->dir_config('lonDaemons').
15414: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15415: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15416: print $fh $env{'form.upfile'};
1.158 raeburn 15417: close($fh);
15418: }
1.31 albertel 15419: }
15420: return $datatoken;
15421: }
15422:
1.56 matthew 15423: =pod
15424:
1.1290 raeburn 15425: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15426:
15427: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15428: $datatoken is the name to assign to the temporary file.
1.258 albertel 15429: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15430:
15431: =cut
1.31 albertel 15432:
15433: sub load_tmp_file {
1.1290 raeburn 15434: my ($r,$datatoken) = @_;
15435: return if ($datatoken eq '');
1.31 albertel 15436: my @studentdata=();
15437: {
1.158 raeburn 15438: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15439: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15440: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15441: @studentdata=<$fh>;
15442: close($fh);
15443: }
1.31 albertel 15444: }
1.258 albertel 15445: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15446: }
15447:
1.1290 raeburn 15448: sub valid_datatoken {
15449: my ($datatoken) = @_;
1.1325 raeburn 15450: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15451: return $datatoken;
15452: }
15453: return;
15454: }
15455:
1.56 matthew 15456: =pod
15457:
1.648 raeburn 15458: =item * &upfile_record_sep()
1.41 ng 15459:
15460: Separate uploaded file into records
15461: returns array of records,
1.258 albertel 15462: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15463:
15464: =cut
1.31 albertel 15465:
15466: sub upfile_record_sep {
1.258 albertel 15467: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15468: } else {
1.248 albertel 15469: my @records;
1.258 albertel 15470: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15471: if ($line=~/^\s*$/) { next; }
15472: push(@records,$line);
15473: }
15474: return @records;
1.31 albertel 15475: }
15476: }
15477:
1.56 matthew 15478: =pod
15479:
1.648 raeburn 15480: =item * &record_sep($record)
1.41 ng 15481:
1.258 albertel 15482: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15483:
15484: =cut
15485:
1.263 www 15486: sub takeleft {
15487: my $index=shift;
15488: return substr('0000'.$index,-4,4);
15489: }
15490:
1.31 albertel 15491: sub record_sep {
15492: my $record=shift;
15493: my %components=();
1.258 albertel 15494: if ($env{'form.upfiletype'} eq 'xml') {
15495: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15496: my $i=0;
1.356 albertel 15497: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15498: $field=~s/^(\"|\')//;
15499: $field=~s/(\"|\')$//;
1.263 www 15500: $components{&takeleft($i)}=$field;
1.31 albertel 15501: $i++;
15502: }
1.258 albertel 15503: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15504: my $i=0;
1.356 albertel 15505: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15506: $field=~s/^(\"|\')//;
15507: $field=~s/(\"|\')$//;
1.263 www 15508: $components{&takeleft($i)}=$field;
1.31 albertel 15509: $i++;
15510: }
15511: } else {
1.561 www 15512: my $separator=',';
1.480 banghart 15513: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15514: $separator=';';
1.480 banghart 15515: }
1.31 albertel 15516: my $i=0;
1.561 www 15517: # the character we are looking for to indicate the end of a quote or a record
15518: my $looking_for=$separator;
15519: # do not add the characters to the fields
15520: my $ignore=0;
15521: # we just encountered a separator (or the beginning of the record)
15522: my $just_found_separator=1;
15523: # store the field we are working on here
15524: my $field='';
15525: # work our way through all characters in record
15526: foreach my $character ($record=~/(.)/g) {
15527: if ($character eq $looking_for) {
15528: if ($character ne $separator) {
15529: # Found the end of a quote, again looking for separator
15530: $looking_for=$separator;
15531: $ignore=1;
15532: } else {
15533: # Found a separator, store away what we got
15534: $components{&takeleft($i)}=$field;
15535: $i++;
15536: $just_found_separator=1;
15537: $ignore=0;
15538: $field='';
15539: }
15540: next;
15541: }
15542: # single or double quotation marks after a separator indicate beginning of a quote
15543: # we are now looking for the end of the quote and need to ignore separators
15544: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15545: $looking_for=$character;
15546: next;
15547: }
15548: # ignore would be true after we reached the end of a quote
15549: if ($ignore) { next; }
15550: if (($just_found_separator) && ($character=~/\s/)) { next; }
15551: $field.=$character;
15552: $just_found_separator=0;
1.31 albertel 15553: }
1.561 www 15554: # catch the very last entry, since we never encountered the separator
15555: $components{&takeleft($i)}=$field;
1.31 albertel 15556: }
15557: return %components;
15558: }
15559:
1.144 matthew 15560: ######################################################
15561: ######################################################
15562:
1.56 matthew 15563: =pod
15564:
1.648 raeburn 15565: =item * &upfile_select_html()
1.41 ng 15566:
1.144 matthew 15567: Return HTML code to select a file from the users machine and specify
15568: the file type.
1.41 ng 15569:
15570: =cut
15571:
1.144 matthew 15572: ######################################################
15573: ######################################################
1.31 albertel 15574: sub upfile_select_html {
1.144 matthew 15575: my %Types = (
15576: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15577: semisv => &mt('Semicolon separated values'),
1.144 matthew 15578: space => &mt('Space separated'),
15579: tab => &mt('Tabulator separated'),
15580: # xml => &mt('HTML/XML'),
15581: );
15582: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15583: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15584: foreach my $type (sort(keys(%Types))) {
15585: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15586: }
15587: $Str .= "</select>\n";
15588: return $Str;
1.31 albertel 15589: }
15590:
1.301 albertel 15591: sub get_samples {
15592: my ($records,$toget) = @_;
15593: my @samples=({});
15594: my $got=0;
15595: foreach my $rec (@$records) {
15596: my %temp = &record_sep($rec);
15597: if (! grep(/\S/, values(%temp))) { next; }
15598: if (%temp) {
15599: $samples[$got]=\%temp;
15600: $got++;
15601: if ($got == $toget) { last; }
15602: }
15603: }
15604: return \@samples;
15605: }
15606:
1.144 matthew 15607: ######################################################
15608: ######################################################
15609:
1.56 matthew 15610: =pod
15611:
1.648 raeburn 15612: =item * &csv_print_samples($r,$records)
1.41 ng 15613:
15614: Prints a table of sample values from each column uploaded $r is an
15615: Apache Request ref, $records is an arrayref from
15616: &Apache::loncommon::upfile_record_sep
15617:
15618: =cut
15619:
1.144 matthew 15620: ######################################################
15621: ######################################################
1.31 albertel 15622: sub csv_print_samples {
15623: my ($r,$records) = @_;
1.662 bisitz 15624: my $samples = &get_samples($records,5);
1.301 albertel 15625:
1.594 raeburn 15626: $r->print(&mt('Samples').'<br />'.&start_data_table().
15627: &start_data_table_header_row());
1.356 albertel 15628: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15629: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15630: $r->print(&end_data_table_header_row());
1.301 albertel 15631: foreach my $hash (@$samples) {
1.594 raeburn 15632: $r->print(&start_data_table_row());
1.356 albertel 15633: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15634: $r->print('<td>');
1.356 albertel 15635: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15636: $r->print('</td>');
15637: }
1.594 raeburn 15638: $r->print(&end_data_table_row());
1.31 albertel 15639: }
1.594 raeburn 15640: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15641: }
15642:
1.144 matthew 15643: ######################################################
15644: ######################################################
15645:
1.56 matthew 15646: =pod
15647:
1.648 raeburn 15648: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15649:
15650: Prints a table to create associations between values and table columns.
1.144 matthew 15651:
1.41 ng 15652: $r is an Apache Request ref,
15653: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15654: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15655:
15656: =cut
15657:
1.144 matthew 15658: ######################################################
15659: ######################################################
1.31 albertel 15660: sub csv_print_select_table {
15661: my ($r,$records,$d) = @_;
1.301 albertel 15662: my $i=0;
15663: my $samples = &get_samples($records,1);
1.144 matthew 15664: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15665: &start_data_table().&start_data_table_header_row().
1.144 matthew 15666: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15667: '<th>'.&mt('Column').'</th>'.
15668: &end_data_table_header_row()."\n");
1.356 albertel 15669: foreach my $array_ref (@$d) {
15670: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15671: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15672:
1.875 bisitz 15673: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15674: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15675: $r->print('<option value="none"></option>');
1.356 albertel 15676: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15677: $r->print('<option value="'.$sample.'"'.
15678: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15679: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15680: }
1.594 raeburn 15681: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15682: $i++;
15683: }
1.594 raeburn 15684: $r->print(&end_data_table());
1.31 albertel 15685: $i--;
15686: return $i;
15687: }
1.56 matthew 15688:
1.144 matthew 15689: ######################################################
15690: ######################################################
15691:
1.56 matthew 15692: =pod
1.31 albertel 15693:
1.648 raeburn 15694: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15695:
15696: Prints a table of sample values from the upload and can make associate samples to internal names.
15697:
15698: $r is an Apache Request ref,
15699: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15700: $d is an array of 2 element arrays (internal name, displayed name)
15701:
15702: =cut
15703:
1.144 matthew 15704: ######################################################
15705: ######################################################
1.31 albertel 15706: sub csv_samples_select_table {
15707: my ($r,$records,$d) = @_;
15708: my $i=0;
1.144 matthew 15709: #
1.662 bisitz 15710: my $max_samples = 5;
15711: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15712: $r->print(&start_data_table().
15713: &start_data_table_header_row().'<th>'.
15714: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15715: &end_data_table_header_row());
1.301 albertel 15716:
15717: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15718: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15719: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15720: foreach my $option (@$d) {
15721: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15722: $r->print('<option value="'.$value.'"'.
1.253 albertel 15723: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15724: $display.'</option>');
1.31 albertel 15725: }
15726: $r->print('</select></td><td>');
1.662 bisitz 15727: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15728: if (defined($samples->[$line]{$key})) {
15729: $r->print($samples->[$line]{$key}."<br />\n");
15730: }
15731: }
1.594 raeburn 15732: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15733: $i++;
15734: }
1.594 raeburn 15735: $r->print(&end_data_table());
1.31 albertel 15736: $i--;
15737: return($i);
1.115 matthew 15738: }
15739:
1.144 matthew 15740: ######################################################
15741: ######################################################
15742:
1.115 matthew 15743: =pod
15744:
1.648 raeburn 15745: =item * &clean_excel_name($name)
1.115 matthew 15746:
15747: Returns a replacement for $name which does not contain any illegal characters.
15748:
15749: =cut
15750:
1.144 matthew 15751: ######################################################
15752: ######################################################
1.115 matthew 15753: sub clean_excel_name {
15754: my ($name) = @_;
15755: $name =~ s/[:\*\?\/\\]//g;
15756: if (length($name) > 31) {
15757: $name = substr($name,0,31);
15758: }
15759: return $name;
1.25 albertel 15760: }
1.84 albertel 15761:
1.85 albertel 15762: =pod
15763:
1.648 raeburn 15764: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15765:
15766: Returns either 1 or undef
15767:
15768: 1 if the part is to be hidden, undef if it is to be shown
15769:
15770: Arguments are:
15771:
15772: $id the id of the part to be checked
15773: $symb, optional the symb of the resource to check
15774: $udom, optional the domain of the user to check for
15775: $uname, optional the username of the user to check for
15776:
15777: =cut
1.84 albertel 15778:
15779: sub check_if_partid_hidden {
15780: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15781: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15782: $symb,$udom,$uname);
1.141 albertel 15783: my $truth=1;
15784: #if the string starts with !, then the list is the list to show not hide
15785: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15786: my @hiddenlist=split(/,/,$hiddenparts);
15787: foreach my $checkid (@hiddenlist) {
1.141 albertel 15788: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15789: }
1.141 albertel 15790: return !$truth;
1.84 albertel 15791: }
1.127 matthew 15792:
1.138 matthew 15793:
15794: ############################################################
15795: ############################################################
15796:
15797: =pod
15798:
1.157 matthew 15799: =back
15800:
1.138 matthew 15801: =head1 cgi-bin script and graphing routines
15802:
1.157 matthew 15803: =over 4
15804:
1.648 raeburn 15805: =item * &get_cgi_id()
1.138 matthew 15806:
15807: Inputs: none
15808:
15809: Returns an id which can be used to pass environment variables
15810: to various cgi-bin scripts. These environment variables will
15811: be removed from the users environment after a given time by
15812: the routine &Apache::lonnet::transfer_profile_to_env.
15813:
15814: =cut
15815:
15816: ############################################################
15817: ############################################################
1.152 albertel 15818: my $uniq=0;
1.136 matthew 15819: sub get_cgi_id {
1.154 albertel 15820: $uniq=($uniq+1)%100000;
1.280 albertel 15821: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15822: }
15823:
1.127 matthew 15824: ############################################################
15825: ############################################################
15826:
15827: =pod
15828:
1.648 raeburn 15829: =item * &DrawBarGraph()
1.127 matthew 15830:
1.138 matthew 15831: Facilitates the plotting of data in a (stacked) bar graph.
15832: Puts plot definition data into the users environment in order for
15833: graph.png to plot it. Returns an <img> tag for the plot.
15834: The bars on the plot are labeled '1','2',...,'n'.
15835:
15836: Inputs:
15837:
15838: =over 4
15839:
15840: =item $Title: string, the title of the plot
15841:
15842: =item $xlabel: string, text describing the X-axis of the plot
15843:
15844: =item $ylabel: string, text describing the Y-axis of the plot
15845:
15846: =item $Max: scalar, the maximum Y value to use in the plot
15847: If $Max is < any data point, the graph will not be rendered.
15848:
1.140 matthew 15849: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15850: they are plotted. If undefined, default values will be used.
15851:
1.178 matthew 15852: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15853:
1.138 matthew 15854: =item @Values: An array of array references. Each array reference holds data
15855: to be plotted in a stacked bar chart.
15856:
1.239 matthew 15857: =item If the final element of @Values is a hash reference the key/value
15858: pairs will be added to the graph definition.
15859:
1.138 matthew 15860: =back
15861:
15862: Returns:
15863:
15864: An <img> tag which references graph.png and the appropriate identifying
15865: information for the plot.
15866:
1.127 matthew 15867: =cut
15868:
15869: ############################################################
15870: ############################################################
1.134 matthew 15871: sub DrawBarGraph {
1.178 matthew 15872: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15873: #
15874: if (! defined($colors)) {
15875: $colors = ['#33ff00',
15876: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15877: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15878: ];
15879: }
1.228 matthew 15880: my $extra_settings = {};
15881: if (ref($Values[-1]) eq 'HASH') {
15882: $extra_settings = pop(@Values);
15883: }
1.127 matthew 15884: #
1.136 matthew 15885: my $identifier = &get_cgi_id();
15886: my $id = 'cgi.'.$identifier;
1.129 matthew 15887: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15888: return '';
15889: }
1.225 matthew 15890: #
15891: my @Labels;
15892: if (defined($labels)) {
15893: @Labels = @$labels;
15894: } else {
15895: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15896: push(@Labels,$i+1);
1.225 matthew 15897: }
15898: }
15899: #
1.129 matthew 15900: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15901: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15902: my %ValuesHash;
15903: my $NumSets=1;
15904: foreach my $array (@Values) {
15905: next if (! ref($array));
1.136 matthew 15906: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15907: join(',',@$array);
1.129 matthew 15908: }
1.127 matthew 15909: #
1.136 matthew 15910: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15911: if ($NumBars < 3) {
15912: $width = 120+$NumBars*32;
1.220 matthew 15913: $xskip = 1;
1.225 matthew 15914: $bar_width = 30;
15915: } elsif ($NumBars < 5) {
15916: $width = 120+$NumBars*20;
15917: $xskip = 1;
15918: $bar_width = 20;
1.220 matthew 15919: } elsif ($NumBars < 10) {
1.136 matthew 15920: $width = 120+$NumBars*15;
15921: $xskip = 1;
15922: $bar_width = 15;
15923: } elsif ($NumBars <= 25) {
15924: $width = 120+$NumBars*11;
15925: $xskip = 5;
15926: $bar_width = 8;
15927: } elsif ($NumBars <= 50) {
15928: $width = 120+$NumBars*8;
15929: $xskip = 5;
15930: $bar_width = 4;
15931: } else {
15932: $width = 120+$NumBars*8;
15933: $xskip = 5;
15934: $bar_width = 4;
15935: }
15936: #
1.137 matthew 15937: $Max = 1 if ($Max < 1);
15938: if ( int($Max) < $Max ) {
15939: $Max++;
15940: $Max = int($Max);
15941: }
1.127 matthew 15942: $Title = '' if (! defined($Title));
15943: $xlabel = '' if (! defined($xlabel));
15944: $ylabel = '' if (! defined($ylabel));
1.369 www 15945: $ValuesHash{$id.'.title'} = &escape($Title);
15946: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15947: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15948: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15949: $ValuesHash{$id.'.NumBars'} = $NumBars;
15950: $ValuesHash{$id.'.NumSets'} = $NumSets;
15951: $ValuesHash{$id.'.PlotType'} = 'bar';
15952: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15953: $ValuesHash{$id.'.height'} = $height;
15954: $ValuesHash{$id.'.width'} = $width;
15955: $ValuesHash{$id.'.xskip'} = $xskip;
15956: $ValuesHash{$id.'.bar_width'} = $bar_width;
15957: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15958: #
1.228 matthew 15959: # Deal with other parameters
15960: while (my ($key,$value) = each(%$extra_settings)) {
15961: $ValuesHash{$id.'.'.$key} = $value;
15962: }
15963: #
1.646 raeburn 15964: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15965: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15966: }
15967:
15968: ############################################################
15969: ############################################################
15970:
15971: =pod
15972:
1.648 raeburn 15973: =item * &DrawXYGraph()
1.137 matthew 15974:
1.138 matthew 15975: Facilitates the plotting of data in an XY graph.
15976: Puts plot definition data into the users environment in order for
15977: graph.png to plot it. Returns an <img> tag for the plot.
15978:
15979: Inputs:
15980:
15981: =over 4
15982:
15983: =item $Title: string, the title of the plot
15984:
15985: =item $xlabel: string, text describing the X-axis of the plot
15986:
15987: =item $ylabel: string, text describing the Y-axis of the plot
15988:
15989: =item $Max: scalar, the maximum Y value to use in the plot
15990: If $Max is < any data point, the graph will not be rendered.
15991:
15992: =item $colors: Array ref containing the hex color codes for the data to be
15993: plotted in. If undefined, default values will be used.
15994:
15995: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15996:
15997: =item $Ydata: Array ref containing Array refs.
1.185 www 15998: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15999:
16000: =item %Values: hash indicating or overriding any default values which are
16001: passed to graph.png.
16002: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16003:
16004: =back
16005:
16006: Returns:
16007:
16008: An <img> tag which references graph.png and the appropriate identifying
16009: information for the plot.
16010:
1.137 matthew 16011: =cut
16012:
16013: ############################################################
16014: ############################################################
16015: sub DrawXYGraph {
16016: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
16017: #
16018: # Create the identifier for the graph
16019: my $identifier = &get_cgi_id();
16020: my $id = 'cgi.'.$identifier;
16021: #
16022: $Title = '' if (! defined($Title));
16023: $xlabel = '' if (! defined($xlabel));
16024: $ylabel = '' if (! defined($ylabel));
16025: my %ValuesHash =
16026: (
1.369 www 16027: $id.'.title' => &escape($Title),
16028: $id.'.xlabel' => &escape($xlabel),
16029: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 16030: $id.'.y_max_value'=> $Max,
16031: $id.'.labels' => join(',',@$Xlabels),
16032: $id.'.PlotType' => 'XY',
16033: );
16034: #
16035: if (defined($colors) && ref($colors) eq 'ARRAY') {
16036: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16037: }
16038: #
16039: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
16040: return '';
16041: }
16042: my $NumSets=1;
1.138 matthew 16043: foreach my $array (@{$Ydata}){
1.137 matthew 16044: next if (! ref($array));
16045: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
16046: }
1.138 matthew 16047: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 16048: #
16049: # Deal with other parameters
16050: while (my ($key,$value) = each(%Values)) {
16051: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 16052: }
16053: #
1.646 raeburn 16054: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 16055: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
16056: }
16057:
16058: ############################################################
16059: ############################################################
16060:
16061: =pod
16062:
1.648 raeburn 16063: =item * &DrawXYYGraph()
1.138 matthew 16064:
16065: Facilitates the plotting of data in an XY graph with two Y axes.
16066: Puts plot definition data into the users environment in order for
16067: graph.png to plot it. Returns an <img> tag for the plot.
16068:
16069: Inputs:
16070:
16071: =over 4
16072:
16073: =item $Title: string, the title of the plot
16074:
16075: =item $xlabel: string, text describing the X-axis of the plot
16076:
16077: =item $ylabel: string, text describing the Y-axis of the plot
16078:
16079: =item $colors: Array ref containing the hex color codes for the data to be
16080: plotted in. If undefined, default values will be used.
16081:
16082: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
16083:
16084: =item $Ydata1: The first data set
16085:
16086: =item $Min1: The minimum value of the left Y-axis
16087:
16088: =item $Max1: The maximum value of the left Y-axis
16089:
16090: =item $Ydata2: The second data set
16091:
16092: =item $Min2: The minimum value of the right Y-axis
16093:
16094: =item $Max2: The maximum value of the left Y-axis
16095:
16096: =item %Values: hash indicating or overriding any default values which are
16097: passed to graph.png.
16098: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
16099:
16100: =back
16101:
16102: Returns:
16103:
16104: An <img> tag which references graph.png and the appropriate identifying
16105: information for the plot.
1.136 matthew 16106:
16107: =cut
16108:
16109: ############################################################
16110: ############################################################
1.137 matthew 16111: sub DrawXYYGraph {
16112: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
16113: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 16114: #
16115: # Create the identifier for the graph
16116: my $identifier = &get_cgi_id();
16117: my $id = 'cgi.'.$identifier;
16118: #
16119: $Title = '' if (! defined($Title));
16120: $xlabel = '' if (! defined($xlabel));
16121: $ylabel = '' if (! defined($ylabel));
16122: my %ValuesHash =
16123: (
1.369 www 16124: $id.'.title' => &escape($Title),
16125: $id.'.xlabel' => &escape($xlabel),
16126: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 16127: $id.'.labels' => join(',',@$Xlabels),
16128: $id.'.PlotType' => 'XY',
16129: $id.'.NumSets' => 2,
1.137 matthew 16130: $id.'.two_axes' => 1,
16131: $id.'.y1_max_value' => $Max1,
16132: $id.'.y1_min_value' => $Min1,
16133: $id.'.y2_max_value' => $Max2,
16134: $id.'.y2_min_value' => $Min2,
1.136 matthew 16135: );
16136: #
1.137 matthew 16137: if (defined($colors) && ref($colors) eq 'ARRAY') {
16138: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
16139: }
16140: #
16141: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
16142: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 16143: return '';
16144: }
16145: my $NumSets=1;
1.137 matthew 16146: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 16147: next if (! ref($array));
16148: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 16149: }
16150: #
16151: # Deal with other parameters
16152: while (my ($key,$value) = each(%Values)) {
16153: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 16154: }
16155: #
1.646 raeburn 16156: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 16157: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 16158: }
16159:
16160: ############################################################
16161: ############################################################
16162:
16163: =pod
16164:
1.157 matthew 16165: =back
16166:
1.139 matthew 16167: =head1 Statistics helper routines?
16168:
16169: Bad place for them but what the hell.
16170:
1.157 matthew 16171: =over 4
16172:
1.648 raeburn 16173: =item * &chartlink()
1.139 matthew 16174:
16175: Returns a link to the chart for a specific student.
16176:
16177: Inputs:
16178:
16179: =over 4
16180:
16181: =item $linktext: The text of the link
16182:
16183: =item $sname: The students username
16184:
16185: =item $sdomain: The students domain
16186:
16187: =back
16188:
1.157 matthew 16189: =back
16190:
1.139 matthew 16191: =cut
16192:
16193: ############################################################
16194: ############################################################
16195: sub chartlink {
16196: my ($linktext, $sname, $sdomain) = @_;
16197: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16198: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16199: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16200: '">'.$linktext.'</a>';
1.153 matthew 16201: }
16202:
16203: #######################################################
16204: #######################################################
16205:
16206: =pod
16207:
16208: =head1 Course Environment Routines
1.157 matthew 16209:
16210: =over 4
1.153 matthew 16211:
1.648 raeburn 16212: =item * &restore_course_settings()
1.153 matthew 16213:
1.648 raeburn 16214: =item * &store_course_settings()
1.153 matthew 16215:
16216: Restores/Store indicated form parameters from the course environment.
16217: Will not overwrite existing values of the form parameters.
16218:
16219: Inputs:
16220: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16221:
16222: a hash ref describing the data to be stored. For example:
16223:
16224: %Save_Parameters = ('Status' => 'scalar',
16225: 'chartoutputmode' => 'scalar',
16226: 'chartoutputdata' => 'scalar',
16227: 'Section' => 'array',
1.373 raeburn 16228: 'Group' => 'array',
1.153 matthew 16229: 'StudentData' => 'array',
16230: 'Maps' => 'array');
16231:
16232: Returns: both routines return nothing
16233:
1.631 raeburn 16234: =back
16235:
1.153 matthew 16236: =cut
16237:
16238: #######################################################
16239: #######################################################
16240: sub store_course_settings {
1.496 albertel 16241: return &store_settings($env{'request.course.id'},@_);
16242: }
16243:
16244: sub store_settings {
1.153 matthew 16245: # save to the environment
16246: # appenv the same items, just to be safe
1.300 albertel 16247: my $udom = $env{'user.domain'};
16248: my $uname = $env{'user.name'};
1.496 albertel 16249: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16250: my %SaveHash;
16251: my %AppHash;
16252: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16253: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16254: my $envname = 'environment.'.$basename;
1.258 albertel 16255: if (exists($env{'form.'.$setting})) {
1.153 matthew 16256: # Save this value away
16257: if ($type eq 'scalar' &&
1.258 albertel 16258: (! exists($env{$envname}) ||
16259: $env{$envname} ne $env{'form.'.$setting})) {
16260: $SaveHash{$basename} = $env{'form.'.$setting};
16261: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16262: } elsif ($type eq 'array') {
16263: my $stored_form;
1.258 albertel 16264: if (ref($env{'form.'.$setting})) {
1.153 matthew 16265: $stored_form = join(',',
16266: map {
1.369 www 16267: &escape($_);
1.258 albertel 16268: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16269: } else {
16270: $stored_form =
1.369 www 16271: &escape($env{'form.'.$setting});
1.153 matthew 16272: }
16273: # Determine if the array contents are the same.
1.258 albertel 16274: if ($stored_form ne $env{$envname}) {
1.153 matthew 16275: $SaveHash{$basename} = $stored_form;
16276: $AppHash{$envname} = $stored_form;
16277: }
16278: }
16279: }
16280: }
16281: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16282: $udom,$uname);
1.153 matthew 16283: if ($put_result !~ /^(ok|delayed)/) {
16284: &Apache::lonnet::logthis('unable to save form parameters, '.
16285: 'got error:'.$put_result);
16286: }
16287: # Make sure these settings stick around in this session, too
1.646 raeburn 16288: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16289: return;
16290: }
16291:
16292: sub restore_course_settings {
1.499 albertel 16293: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16294: }
16295:
16296: sub restore_settings {
16297: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16298: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16299: next if (exists($env{'form.'.$setting}));
1.496 albertel 16300: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16301: '.'.$setting;
1.258 albertel 16302: if (exists($env{$envname})) {
1.153 matthew 16303: if ($type eq 'scalar') {
1.258 albertel 16304: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16305: } elsif ($type eq 'array') {
1.258 albertel 16306: $env{'form.'.$setting} = [
1.153 matthew 16307: map {
1.369 www 16308: &unescape($_);
1.258 albertel 16309: } split(',',$env{$envname})
1.153 matthew 16310: ];
16311: }
16312: }
16313: }
1.127 matthew 16314: }
16315:
1.618 raeburn 16316: #######################################################
16317: #######################################################
16318:
16319: =pod
16320:
16321: =head1 Domain E-mail Routines
16322:
16323: =over 4
16324:
1.648 raeburn 16325: =item * &build_recipient_list()
1.618 raeburn 16326:
1.1144 raeburn 16327: Build recipient lists for following types of e-mail:
1.766 raeburn 16328: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16329: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16330: module change checking, student/employee ID conflict checks, as
16331: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16332: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16333:
16334: Inputs:
1.619 raeburn 16335: defmail (scalar - email address of default recipient),
1.1144 raeburn 16336: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16337: requestsmail, updatesmail, or idconflictsmail).
16338:
1.619 raeburn 16339: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16340:
1.619 raeburn 16341: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16342: i.e., predates configuration by DC via domainprefs.pm
16343:
16344: $requname username of requester (if mailing type is helpdeskmail)
16345:
16346: $requdom domain of requester (if mailing type is helpdeskmail)
16347:
16348: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16349:
1.618 raeburn 16350:
1.655 raeburn 16351: Returns: comma separated list of addresses to which to send e-mail.
16352:
16353: =back
1.618 raeburn 16354:
16355: =cut
16356:
16357: ############################################################
16358: ############################################################
16359: sub build_recipient_list {
1.1297 raeburn 16360: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16361: my @recipients;
1.1270 raeburn 16362: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16363: my %domconfig =
1.1270 raeburn 16364: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16365: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16366: if (exists($domconfig{'contacts'}{$mailing})) {
16367: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16368: my @contacts = ('adminemail','supportemail');
16369: foreach my $item (@contacts) {
16370: if ($domconfig{'contacts'}{$mailing}{$item}) {
16371: my $addr = $domconfig{'contacts'}{$item};
16372: if (!grep(/^\Q$addr\E$/,@recipients)) {
16373: push(@recipients,$addr);
16374: }
1.619 raeburn 16375: }
1.1270 raeburn 16376: }
16377: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16378: if ($mailing eq 'helpdeskmail') {
16379: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16380: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16381: my @ok_bccs;
16382: foreach my $bcc (@bccs) {
16383: $bcc =~ s/^\s+//g;
16384: $bcc =~ s/\s+$//g;
16385: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16386: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16387: push(@ok_bccs,$bcc);
16388: }
16389: }
16390: }
16391: if (@ok_bccs > 0) {
16392: $allbcc = join(', ',@ok_bccs);
16393: }
16394: }
16395: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16396: }
16397: }
1.766 raeburn 16398: } elsif ($origmail ne '') {
1.1270 raeburn 16399: $lastresort = $origmail;
1.618 raeburn 16400: }
1.1297 raeburn 16401: if ($mailing eq 'helpdeskmail') {
16402: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16403: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16404: my ($inststatus,$inststatus_checked);
16405: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16406: ($env{'user.domain'} ne 'public')) {
16407: $inststatus_checked = 1;
16408: $inststatus = $env{'environment.inststatus'};
16409: }
16410: unless ($inststatus_checked) {
16411: if (($requname ne '') && ($requdom ne '')) {
16412: if (($requname =~ /^$match_username$/) &&
16413: ($requdom =~ /^$match_domain$/) &&
16414: (&Apache::lonnet::domain($requdom))) {
16415: my $requhome = &Apache::lonnet::homeserver($requname,
16416: $requdom);
16417: unless ($requhome eq 'no_host') {
16418: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16419: $inststatus = $userenv{'inststatus'};
16420: $inststatus_checked = 1;
16421: }
16422: }
16423: }
16424: }
16425: unless ($inststatus_checked) {
16426: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16427: my %srch = (srchby => 'email',
16428: srchdomain => $defdom,
16429: srchterm => $reqemail,
16430: srchtype => 'exact');
16431: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16432: foreach my $uname (keys(%srch_results)) {
16433: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16434: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16435: $inststatus_checked = 1;
16436: last;
16437: }
16438: }
16439: unless ($inststatus_checked) {
16440: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16441: if ($dirsrchres eq 'ok') {
16442: foreach my $uname (keys(%srch_results)) {
16443: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16444: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16445: $inststatus_checked = 1;
16446: last;
16447: }
16448: }
16449: }
16450: }
16451: }
16452: }
16453: if ($inststatus ne '') {
16454: foreach my $status (split(/\:/,$inststatus)) {
16455: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16456: my @contacts = ('adminemail','supportemail');
16457: foreach my $item (@contacts) {
16458: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16459: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16460: if (!grep(/^\Q$addr\E$/,@recipients)) {
16461: push(@recipients,$addr);
16462: }
16463: }
16464: }
16465: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16466: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16467: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16468: my @ok_bccs;
16469: foreach my $bcc (@bccs) {
16470: $bcc =~ s/^\s+//g;
16471: $bcc =~ s/\s+$//g;
16472: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16473: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16474: push(@ok_bccs,$bcc);
16475: }
16476: }
16477: }
16478: if (@ok_bccs > 0) {
16479: $allbcc = join(', ',@ok_bccs);
16480: }
16481: }
16482: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16483: last;
16484: }
16485: }
16486: }
16487: }
16488: }
1.619 raeburn 16489: } elsif ($origmail ne '') {
1.1270 raeburn 16490: $lastresort = $origmail;
16491: }
1.1297 raeburn 16492: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16493: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16494: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16495: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16496: my %what = (
16497: perlvar => 1,
16498: );
16499: my $primary = &Apache::lonnet::domain($defdom,'primary');
16500: if ($primary) {
16501: my $gotaddr;
16502: my ($result,$returnhash) =
16503: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16504: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16505: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16506: $lastresort = $returnhash->{'lonSupportEMail'};
16507: $gotaddr = 1;
16508: }
16509: }
16510: unless ($gotaddr) {
16511: my $uintdom = &Apache::lonnet::internet_dom($primary);
16512: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16513: unless ($uintdom eq $intdom) {
16514: my %domconfig =
16515: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16516: if (ref($domconfig{'contacts'}) eq 'HASH') {
16517: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16518: my @contacts = ('adminemail','supportemail');
16519: foreach my $item (@contacts) {
16520: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16521: my $addr = $domconfig{'contacts'}{$item};
16522: if (!grep(/^\Q$addr\E$/,@recipients)) {
16523: push(@recipients,$addr);
16524: }
16525: }
16526: }
16527: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16528: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16529: }
16530: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16531: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16532: my @ok_bccs;
16533: foreach my $bcc (@bccs) {
16534: $bcc =~ s/^\s+//g;
16535: $bcc =~ s/\s+$//g;
16536: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16537: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16538: push(@ok_bccs,$bcc);
16539: }
16540: }
16541: }
16542: if (@ok_bccs > 0) {
16543: $allbcc = join(', ',@ok_bccs);
16544: }
16545: }
16546: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16547: }
16548: }
16549: }
16550: }
16551: }
16552: }
1.618 raeburn 16553: }
1.688 raeburn 16554: if (defined($defmail)) {
16555: if ($defmail ne '') {
16556: push(@recipients,$defmail);
16557: }
1.618 raeburn 16558: }
16559: if ($otheremails) {
1.619 raeburn 16560: my @others;
16561: if ($otheremails =~ /,/) {
16562: @others = split(/,/,$otheremails);
1.618 raeburn 16563: } else {
1.619 raeburn 16564: push(@others,$otheremails);
16565: }
16566: foreach my $addr (@others) {
16567: if (!grep(/^\Q$addr\E$/,@recipients)) {
16568: push(@recipients,$addr);
16569: }
1.618 raeburn 16570: }
16571: }
1.1298 raeburn 16572: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16573: if ((!@recipients) && ($lastresort ne '')) {
16574: push(@recipients,$lastresort);
16575: }
16576: } elsif ($lastresort ne '') {
16577: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16578: push(@recipients,$lastresort);
16579: }
16580: }
1.1271 raeburn 16581: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16582: if (wantarray) {
16583: return ($recipientlist,$allbcc,$addtext);
16584: } else {
16585: return $recipientlist;
16586: }
1.618 raeburn 16587: }
16588:
1.127 matthew 16589: ############################################################
16590: ############################################################
1.154 albertel 16591:
1.655 raeburn 16592: =pod
16593:
1.1224 musolffc 16594: =over 4
16595:
1.1223 musolffc 16596: =item * &mime_email()
16597:
16598: Sends an email with a possible attachment
16599:
16600: Inputs:
16601:
16602: =over 4
16603:
16604: from - Sender's email address
16605:
1.1343 raeburn 16606: replyto - Reply-To email address
16607:
1.1223 musolffc 16608: to - Email address of recipient
16609:
16610: subject - Subject of email
16611:
16612: body - Body of email
16613:
16614: cc_string - Carbon copy email address
16615:
16616: bcc - Blind carbon copy email address
16617:
16618: attachment_path - Path of file to be attached
16619:
16620: file_name - Name of file to be attached
16621:
16622: attachment_text - The body of an attachment of type "TEXT"
16623:
16624: =back
16625:
16626: =back
16627:
16628: =cut
16629:
16630: ############################################################
16631: ############################################################
16632:
16633: sub mime_email {
1.1343 raeburn 16634: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16635: $file_name,$attachment_text) = @_;
16636:
1.1223 musolffc 16637: my $msg = MIME::Lite->new(
16638: From => $from,
16639: To => $to,
16640: Subject => $subject,
16641: Type =>'TEXT',
16642: Data => $body,
16643: );
1.1343 raeburn 16644: if ($replyto ne '') {
16645: $msg->add("Reply-To" => $replyto);
16646: }
1.1223 musolffc 16647: if ($cc_string ne '') {
16648: $msg->add("Cc" => $cc_string);
16649: }
16650: if ($bcc ne '') {
16651: $msg->add("Bcc" => $bcc);
16652: }
16653: $msg->attr("content-type" => "text/plain");
16654: $msg->attr("content-type.charset" => "UTF-8");
16655: # Attach file if given
16656: if ($attachment_path) {
16657: unless ($file_name) {
16658: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16659: }
16660: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16661: $msg->attach(Type => $type,
16662: Path => $attachment_path,
16663: Filename => $file_name
16664: );
16665: # Otherwise attach text if given
16666: } elsif ($attachment_text) {
16667: $msg->attach(Type => 'TEXT',
16668: Data => $attachment_text);
16669: }
16670: # Send it
16671: $msg->send('sendmail');
16672: }
16673:
16674: ############################################################
16675: ############################################################
16676:
16677: =pod
16678:
1.655 raeburn 16679: =head1 Course Catalog Routines
16680:
16681: =over 4
16682:
16683: =item * &gather_categories()
16684:
16685: Converts category definitions - keys of categories hash stored in
16686: coursecategories in configuration.db on the primary library server in a
16687: domain - to an array. Also generates javascript and idx hash used to
16688: generate Domain Coordinator interface for editing Course Categories.
16689:
16690: Inputs:
1.663 raeburn 16691:
1.655 raeburn 16692: categories (reference to hash of category definitions).
1.663 raeburn 16693:
1.655 raeburn 16694: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16695: categories and subcategories).
1.663 raeburn 16696:
1.655 raeburn 16697: idx (reference to hash of counters used in Domain Coordinator interface for
16698: editing Course Categories).
1.663 raeburn 16699:
1.655 raeburn 16700: jsarray (reference to array of categories used to create Javascript arrays for
16701: Domain Coordinator interface for editing Course Categories).
16702:
16703: Returns: nothing
16704:
16705: Side effects: populates cats, idx and jsarray.
16706:
16707: =cut
16708:
16709: sub gather_categories {
16710: my ($categories,$cats,$idx,$jsarray) = @_;
16711: my %counters;
16712: my $num = 0;
16713: foreach my $item (keys(%{$categories})) {
16714: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16715: if ($container eq '' && $depth == 0) {
16716: $cats->[$depth][$categories->{$item}] = $cat;
16717: } else {
16718: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16719: }
16720: my ($escitem,$tail) = split(/:/,$item,2);
16721: if ($counters{$tail} eq '') {
16722: $counters{$tail} = $num;
16723: $num ++;
16724: }
16725: if (ref($idx) eq 'HASH') {
16726: $idx->{$item} = $counters{$tail};
16727: }
16728: if (ref($jsarray) eq 'ARRAY') {
16729: push(@{$jsarray->[$counters{$tail}]},$item);
16730: }
16731: }
16732: return;
16733: }
16734:
16735: =pod
16736:
16737: =item * &extract_categories()
16738:
16739: Used to generate breadcrumb trails for course categories.
16740:
16741: Inputs:
1.663 raeburn 16742:
1.655 raeburn 16743: categories (reference to hash of category definitions).
1.663 raeburn 16744:
1.655 raeburn 16745: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16746: categories and subcategories).
1.663 raeburn 16747:
1.655 raeburn 16748: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16749:
1.655 raeburn 16750: allitems (reference to hash - key is category key
16751: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16752:
1.655 raeburn 16753: idx (reference to hash of counters used in Domain Coordinator interface for
16754: editing Course Categories).
1.663 raeburn 16755:
1.655 raeburn 16756: jsarray (reference to array of categories used to create Javascript arrays for
16757: Domain Coordinator interface for editing Course Categories).
16758:
1.665 raeburn 16759: subcats (reference to hash of arrays containing all subcategories within each
16760: category, -recursive)
16761:
1.1321 raeburn 16762: maxd (reference to hash used to hold max depth for all top-level categories).
16763:
1.655 raeburn 16764: Returns: nothing
16765:
16766: Side effects: populates trails and allitems hash references.
16767:
16768: =cut
16769:
16770: sub extract_categories {
1.1321 raeburn 16771: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16772: if (ref($categories) eq 'HASH') {
16773: &gather_categories($categories,$cats,$idx,$jsarray);
16774: if (ref($cats->[0]) eq 'ARRAY') {
16775: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16776: my $name = $cats->[0][$i];
16777: my $item = &escape($name).'::0';
16778: my $trailstr;
16779: if ($name eq 'instcode') {
16780: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16781: } elsif ($name eq 'communities') {
16782: $trailstr = &mt('Communities');
1.1239 raeburn 16783: } elsif ($name eq 'placement') {
16784: $trailstr = &mt('Placement Tests');
1.655 raeburn 16785: } else {
16786: $trailstr = $name;
16787: }
16788: if ($allitems->{$item} eq '') {
16789: push(@{$trails},$trailstr);
16790: $allitems->{$item} = scalar(@{$trails})-1;
16791: }
16792: my @parents = ($name);
16793: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16794: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16795: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16796: if (ref($subcats) eq 'HASH') {
16797: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16798: }
1.1321 raeburn 16799: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16800: }
16801: } else {
16802: if (ref($subcats) eq 'HASH') {
16803: $subcats->{$item} = [];
1.655 raeburn 16804: }
1.1321 raeburn 16805: if (ref($maxd) eq 'HASH') {
16806: $maxd->{$name} = 1;
16807: }
1.655 raeburn 16808: }
16809: }
16810: }
16811: }
16812: return;
16813: }
16814:
16815: =pod
16816:
1.1162 raeburn 16817: =item * &recurse_categories()
1.655 raeburn 16818:
16819: Recursively used to generate breadcrumb trails for course categories.
16820:
16821: Inputs:
1.663 raeburn 16822:
1.655 raeburn 16823: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16824: categories and subcategories).
1.663 raeburn 16825:
1.655 raeburn 16826: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16827:
16828: category (current course category, for which breadcrumb trail is being generated).
16829:
16830: trails (reference to array of breadcrumb trails for each category).
16831:
1.655 raeburn 16832: allitems (reference to hash - key is category key
16833: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16834:
1.655 raeburn 16835: parents (array containing containers directories for current category,
16836: back to top level).
16837:
16838: Returns: nothing
16839:
16840: Side effects: populates trails and allitems hash references
16841:
16842: =cut
16843:
16844: sub recurse_categories {
1.1321 raeburn 16845: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16846: my $shallower = $depth - 1;
16847: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16848: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16849: my $name = $cats->[$depth]{$category}[$k];
16850: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16851: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16852: if ($allitems->{$item} eq '') {
16853: push(@{$trails},$trailstr);
16854: $allitems->{$item} = scalar(@{$trails})-1;
16855: }
16856: my $deeper = $depth+1;
16857: push(@{$parents},$category);
1.665 raeburn 16858: if (ref($subcats) eq 'HASH') {
16859: my $subcat = &escape($name).':'.$category.':'.$depth;
16860: for (my $j=@{$parents}; $j>=0; $j--) {
16861: my $higher;
16862: if ($j > 0) {
16863: $higher = &escape($parents->[$j]).':'.
16864: &escape($parents->[$j-1]).':'.$j;
16865: } else {
16866: $higher = &escape($parents->[$j]).'::'.$j;
16867: }
16868: push(@{$subcats->{$higher}},$subcat);
16869: }
16870: }
16871: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16872: $subcats,$maxd);
1.655 raeburn 16873: pop(@{$parents});
16874: }
16875: } else {
16876: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16877: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16878: if ($allitems->{$item} eq '') {
16879: push(@{$trails},$trailstr);
16880: $allitems->{$item} = scalar(@{$trails})-1;
16881: }
1.1321 raeburn 16882: if (ref($maxd) eq 'HASH') {
16883: if ($depth > $maxd->{$parents->[0]}) {
16884: $maxd->{$parents->[0]} = $depth;
16885: }
16886: }
1.655 raeburn 16887: }
16888: return;
16889: }
16890:
1.663 raeburn 16891: =pod
16892:
1.1162 raeburn 16893: =item * &assign_categories_table()
1.663 raeburn 16894:
16895: Create a datatable for display of hierarchical categories in a domain,
16896: with checkboxes to allow a course to be categorized.
16897:
16898: Inputs:
16899:
16900: cathash - reference to hash of categories defined for the domain (from
16901: configuration.db)
16902:
16903: currcat - scalar with an & separated list of categories assigned to a course.
16904:
1.919 raeburn 16905: type - scalar contains course type (Course or Community).
16906:
1.1260 raeburn 16907: disabled - scalar (optional) contains disabled="disabled" if input elements are
16908: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16909:
1.663 raeburn 16910: Returns: $output (markup to be displayed)
16911:
16912: =cut
16913:
16914: sub assign_categories_table {
1.1259 raeburn 16915: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16916: my $output;
16917: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16918: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16919: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16920: $maxdepth = scalar(@cats);
16921: if (@cats > 0) {
16922: my $itemcount = 0;
16923: if (ref($cats[0]) eq 'ARRAY') {
16924: my @currcategories;
16925: if ($currcat ne '') {
16926: @currcategories = split('&',$currcat);
16927: }
1.919 raeburn 16928: my $table;
1.663 raeburn 16929: for (my $i=0; $i<@{$cats[0]}; $i++) {
16930: my $parent = $cats[0][$i];
1.919 raeburn 16931: next if ($parent eq 'instcode');
16932: if ($type eq 'Community') {
16933: next unless ($parent eq 'communities');
1.1239 raeburn 16934: } elsif ($type eq 'Placement') {
16935: next unless ($parent eq 'placement');
1.919 raeburn 16936: } else {
1.1239 raeburn 16937: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16938: }
1.663 raeburn 16939: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16940: my $item = &escape($parent).'::0';
16941: my $checked = '';
16942: if (@currcategories > 0) {
16943: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16944: $checked = ' checked="checked"';
1.663 raeburn 16945: }
16946: }
1.919 raeburn 16947: my $parent_title = $parent;
16948: if ($parent eq 'communities') {
16949: $parent_title = &mt('Communities');
1.1239 raeburn 16950: } elsif ($parent eq 'placement') {
16951: $parent_title = &mt('Placement Tests');
1.919 raeburn 16952: }
16953: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16954: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16955: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16956: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16957: my $depth = 1;
16958: push(@path,$parent);
1.1259 raeburn 16959: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16960: pop(@path);
1.919 raeburn 16961: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16962: $itemcount ++;
16963: }
1.919 raeburn 16964: if ($itemcount) {
16965: $output = &Apache::loncommon::start_data_table().
16966: $table.
16967: &Apache::loncommon::end_data_table();
16968: }
1.663 raeburn 16969: }
16970: }
16971: }
16972: return $output;
16973: }
16974:
16975: =pod
16976:
1.1162 raeburn 16977: =item * &assign_category_rows()
1.663 raeburn 16978:
16979: Create a datatable row for display of nested categories in a domain,
16980: with checkboxes to allow a course to be categorized,called recursively.
16981:
16982: Inputs:
16983:
16984: itemcount - track row number for alternating colors
16985:
16986: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16987: categories and subcategories.
16988:
16989: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16990:
16991: parent - parent of current category item
16992:
16993: path - Array containing all categories back up through the hierarchy from the
16994: current category to the top level.
16995:
16996: currcategories - reference to array of current categories assigned to the course
16997:
1.1260 raeburn 16998: disabled - scalar (optional) contains disabled="disabled" if input elements are
16999: to be readonly (e.g., Domain Helpdesk role viewing course settings).
17000:
1.663 raeburn 17001: Returns: $output (markup to be displayed).
17002:
17003: =cut
17004:
17005: sub assign_category_rows {
1.1259 raeburn 17006: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 17007: my ($text,$name,$item,$chgstr);
17008: if (ref($cats) eq 'ARRAY') {
17009: my $maxdepth = scalar(@{$cats});
17010: if (ref($cats->[$depth]) eq 'HASH') {
17011: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
17012: my $numchildren = @{$cats->[$depth]{$parent}};
17013: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 17014: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 17015: for (my $j=0; $j<$numchildren; $j++) {
17016: $name = $cats->[$depth]{$parent}[$j];
17017: $item = &escape($name).':'.&escape($parent).':'.$depth;
17018: my $deeper = $depth+1;
17019: my $checked = '';
17020: if (ref($currcategories) eq 'ARRAY') {
17021: if (@{$currcategories} > 0) {
17022: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 17023: $checked = ' checked="checked"';
1.663 raeburn 17024: }
17025: }
17026: }
1.664 raeburn 17027: $text .= '<tr><td><span class="LC_nobreak"><label>'.
17028: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 17029: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 17030: '<input type="hidden" name="catname" value="'.$name.'" />'.
17031: '</td><td>';
1.663 raeburn 17032: if (ref($path) eq 'ARRAY') {
17033: push(@{$path},$name);
1.1259 raeburn 17034: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 17035: pop(@{$path});
17036: }
17037: $text .= '</td></tr>';
17038: }
17039: $text .= '</table></td>';
17040: }
17041: }
17042: }
17043: return $text;
17044: }
17045:
1.1181 raeburn 17046: =pod
17047:
17048: =back
17049:
17050: =cut
17051:
1.655 raeburn 17052: ############################################################
17053: ############################################################
17054:
17055:
1.443 albertel 17056: sub commit_customrole {
1.1408 raeburn 17057: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 17058: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 17059: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
17060: $context,$othdomby,$requester);
1.630 raeburn 17061: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 17062: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 17063: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
17064: if (wantarray) {
17065: return ($output,$result);
17066: } else {
17067: return $output;
17068: }
1.443 albertel 17069: }
17070:
17071: sub commit_standardrole {
1.1408 raeburn 17072: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
17073: $othdomby,$requester) = @_;
1.1399 raeburn 17074: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 17075: if ($context eq 'auto') {
17076: $linefeed = "\n";
17077: } else {
17078: $linefeed = "<br />\n";
17079: }
1.443 albertel 17080: if ($three eq 'st') {
1.1399 raeburn 17081: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 17082: $one,$two,$sec,$context,$credits,$othdomby,
17083: $requester);
1.541 raeburn 17084: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 17085: ($result eq 'unknown_course') || ($result eq 'refused')) {
17086: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 17087: } else {
1.541 raeburn 17088: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 17089: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17090: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
17091: if ($context eq 'auto') {
17092: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
17093: } else {
17094: $output .= '<b>'.$result.'</b>'.$linefeed.
17095: &mt('Add to classlist').': <b>ok</b>';
17096: }
17097: $output .= $linefeed;
1.443 albertel 17098: }
17099: } else {
17100: $output = &mt('Assigning').' '.$three.' in '.$url.
17101: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 17102: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 17103: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
17104: '','',$context,$othdomby,$requester);
1.541 raeburn 17105: if ($context eq 'auto') {
17106: $output .= $result.$linefeed;
17107: } else {
17108: $output .= '<b>'.$result.'</b>'.$linefeed;
17109: }
1.443 albertel 17110: }
1.1399 raeburn 17111: if (wantarray) {
17112: return ($output,$result);
17113: } else {
17114: return $output;
17115: }
1.443 albertel 17116: }
17117:
17118: sub commit_studentrole {
1.1116 raeburn 17119: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 17120: $credits,$othdomby,$requester) = @_;
1.626 raeburn 17121: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 17122: if ($context eq 'auto') {
17123: $linefeed = "\n";
17124: } else {
17125: $linefeed = '<br />'."\n";
17126: }
1.443 albertel 17127: if (defined($one) && defined($two)) {
17128: my $cid=$one.'_'.$two;
17129: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
17130: my $secchange = 0;
17131: my $expire_role_result;
17132: my $modify_section_result;
1.628 raeburn 17133: if ($oldsec ne '-1') {
17134: if ($oldsec ne $sec) {
1.443 albertel 17135: $secchange = 1;
1.628 raeburn 17136: my $now = time;
1.443 albertel 17137: my $uurl='/'.$cid;
17138: $uurl=~s/\_/\//g;
17139: if ($oldsec) {
17140: $uurl.='/'.$oldsec;
17141: }
1.626 raeburn 17142: $oldsecurl = $uurl;
1.628 raeburn 17143: $expire_role_result =
1.1408 raeburn 17144: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
17145: '','','',$context,$othdomby,$requester);
17146: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 17147: if ($expire_role_result eq 'refused') {
17148: my @roles = ('st');
17149: my @statuses = ('previous');
17150: my @roledoms = ($one);
17151: my $withsec = 1;
17152: my %roleshash =
17153: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
17154: \@statuses,\@roles,\@roledoms,$withsec);
17155: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
17156: my ($oldstart,$oldend) =
17157: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
17158: if ($oldend > 0 && $oldend <= $now) {
17159: $expire_role_result = 'ok';
17160: }
17161: }
17162: }
17163: }
1.443 albertel 17164: $result = $expire_role_result;
17165: }
17166: }
17167: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17168: $modify_section_result =
17169: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17170: undef,undef,undef,$sec,
17171: $end,$start,'','',$cid,
1.1408 raeburn 17172: '',$context,$credits,'',
17173: $othdomby,$requester);
1.443 albertel 17174: if ($modify_section_result =~ /^ok/) {
17175: if ($secchange == 1) {
1.628 raeburn 17176: if ($sec eq '') {
17177: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17178: } else {
17179: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17180: }
1.443 albertel 17181: } elsif ($oldsec eq '-1') {
1.628 raeburn 17182: if ($sec eq '') {
17183: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17184: } else {
17185: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17186: }
1.443 albertel 17187: } else {
1.628 raeburn 17188: if ($sec eq '') {
17189: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17190: } else {
17191: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17192: }
1.443 albertel 17193: }
17194: } else {
1.1115 raeburn 17195: if ($secchange) {
1.628 raeburn 17196: $$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;
17197: } else {
17198: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17199: }
1.443 albertel 17200: }
17201: $result = $modify_section_result;
17202: } elsif ($secchange == 1) {
1.628 raeburn 17203: if ($oldsec eq '') {
1.1103 raeburn 17204: $$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 17205: } else {
17206: $$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;
17207: }
1.626 raeburn 17208: if ($expire_role_result eq 'refused') {
17209: my $newsecurl = '/'.$cid;
17210: $newsecurl =~ s/\_/\//g;
17211: if ($sec ne '') {
17212: $newsecurl.='/'.$sec;
17213: }
17214: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17215: if ($sec eq '') {
17216: $$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;
17217: } else {
17218: $$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;
17219: }
17220: }
17221: }
1.443 albertel 17222: }
17223: } else {
1.626 raeburn 17224: $$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 17225: $result = "error: incomplete course id\n";
17226: }
17227: return $result;
17228: }
17229:
1.1108 raeburn 17230: sub show_role_extent {
17231: my ($scope,$context,$role) = @_;
17232: $scope =~ s{^/}{};
17233: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17234: push(@courseroles,'co');
17235: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17236: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17237: $scope =~ s{/}{_};
17238: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17239: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17240: my ($audom,$auname) = split(/\//,$scope);
17241: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17242: &Apache::loncommon::plainname($auname,$audom).'</span>');
17243: } else {
17244: $scope =~ s{/$}{};
17245: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17246: &Apache::lonnet::domain($scope,'description').'</span>');
17247: }
17248: }
17249:
1.443 albertel 17250: ############################################################
17251: ############################################################
17252:
1.566 albertel 17253: sub check_clone {
1.578 raeburn 17254: my ($args,$linefeed) = @_;
1.566 albertel 17255: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17256: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17257: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17258: my $clonetitle;
17259: my @clonemsg;
1.566 albertel 17260: my $can_clone = 0;
1.944 raeburn 17261: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17262: if ($lctype ne 'community') {
17263: $lctype = 'course';
17264: }
1.566 albertel 17265: if ($clonehome eq 'no_host') {
1.944 raeburn 17266: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17267: push(@clonemsg,({
17268: mt => 'No new community created.',
17269: args => [],
17270: },
17271: {
17272: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17273: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17274: }));
1.908 raeburn 17275: } else {
1.1344 raeburn 17276: push(@clonemsg,({
17277: mt => 'No new course created.',
17278: args => [],
17279: },
17280: {
17281: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17282: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17283: }));
17284: }
1.566 albertel 17285: } else {
17286: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17287: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17288: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17289: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17290: push(@clonemsg,({
17291: mt => 'No new community created.',
17292: args => [],
17293: },
17294: {
17295: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17296: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17297: }));
17298: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17299: }
17300: }
1.1262 raeburn 17301: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17302: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17303: $can_clone = 1;
17304: } else {
1.1221 raeburn 17305: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17306: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17307: if ($clonehash{'cloners'} eq '') {
17308: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17309: if ($domdefs{'canclone'}) {
17310: unless ($domdefs{'canclone'} eq 'none') {
17311: if ($domdefs{'canclone'} eq 'domain') {
17312: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17313: $can_clone = 1;
17314: }
17315: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17316: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17317: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17318: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17319: $can_clone = 1;
17320: }
17321: }
17322: }
17323: }
1.578 raeburn 17324: } else {
1.1221 raeburn 17325: my @cloners = split(/,/,$clonehash{'cloners'});
17326: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17327: $can_clone = 1;
1.1221 raeburn 17328: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17329: $can_clone = 1;
1.1225 raeburn 17330: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17331: $can_clone = 1;
1.1221 raeburn 17332: }
17333: unless ($can_clone) {
1.1225 raeburn 17334: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17335: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17336: my (%gotdomdefaults,%gotcodedefaults);
17337: foreach my $cloner (@cloners) {
17338: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17339: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17340: my (%codedefaults,@code_order);
17341: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17342: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17343: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17344: }
17345: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17346: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17347: }
17348: } else {
17349: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17350: \%codedefaults,
17351: \@code_order);
17352: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17353: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17354: }
17355: if (@code_order > 0) {
17356: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17357: $cloner,$clonehash{'internal.coursecode'},
17358: $args->{'crscode'})) {
17359: $can_clone = 1;
17360: last;
17361: }
17362: }
17363: }
17364: }
17365: }
1.1225 raeburn 17366: }
17367: }
17368: unless ($can_clone) {
17369: my $ccrole = 'cc';
17370: if ($args->{'crstype'} eq 'Community') {
17371: $ccrole = 'co';
17372: }
17373: my %roleshash =
17374: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17375: $args->{'ccdomain'},
17376: 'userroles',['active'],[$ccrole],
17377: [$args->{'clonedomain'}]);
17378: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17379: $can_clone = 1;
17380: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17381: $args->{'ccuname'},$args->{'ccdomain'})) {
17382: $can_clone = 1;
1.1221 raeburn 17383: }
17384: }
17385: unless ($can_clone) {
17386: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17387: push(@clonemsg,({
17388: mt => 'No new community created.',
17389: args => [],
17390: },
17391: {
17392: 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]).',
17393: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17394: }));
1.942 raeburn 17395: } else {
1.1344 raeburn 17396: push(@clonemsg,({
17397: mt => 'No new course created.',
17398: args => [],
17399: },
17400: {
17401: 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]).',
17402: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17403: }));
1.1221 raeburn 17404: }
1.566 albertel 17405: }
1.578 raeburn 17406: }
1.566 albertel 17407: }
1.1344 raeburn 17408: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17409: }
17410:
1.444 albertel 17411: sub construct_course {
1.1262 raeburn 17412: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17413: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17414: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17415: my $linefeed = '<br />'."\n";
17416: if ($context eq 'auto') {
17417: $linefeed = "\n";
17418: }
1.566 albertel 17419:
17420: #
17421: # Are we cloning?
17422: #
1.1344 raeburn 17423: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17424: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17425: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17426: if (!$can_clone) {
1.1344 raeburn 17427: return (0,$outcome,$clonemsgref);
1.566 albertel 17428: }
17429: }
17430:
1.444 albertel 17431: #
17432: # Open course
17433: #
1.1239 raeburn 17434: my $showncrstype;
17435: if ($args->{'crstype'} eq 'Placement') {
17436: $showncrstype = 'placement test';
17437: } else {
17438: $showncrstype = lc($args->{'crstype'});
17439: }
1.444 albertel 17440: my %cenv=();
17441: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17442: $args->{'cdescr'},
17443: $args->{'curl'},
17444: $args->{'course_home'},
17445: $args->{'nonstandard'},
17446: $args->{'crscode'},
17447: $args->{'ccuname'}.':'.
17448: $args->{'ccdomain'},
1.882 raeburn 17449: $args->{'crstype'},
1.1344 raeburn 17450: $cnum,$context,$category,
17451: $callercontext);
1.444 albertel 17452:
17453: # Note: The testing routines depend on this being output; see
17454: # Utils::Course. This needs to at least be output as a comment
17455: # if anyone ever decides to not show this, and Utils::Course::new
17456: # will need to be suitably modified.
1.1344 raeburn 17457: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17458: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17459: } else {
17460: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17461: }
1.943 raeburn 17462: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17463: return (0,$outcome,$clonemsgref);
1.943 raeburn 17464: }
17465:
1.444 albertel 17466: #
17467: # Check if created correctly
17468: #
1.479 albertel 17469: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17470: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17471: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17472: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17473: $outcome .= &mt_user($user_lh,
17474: 'Course creation failed, unrecognized course home server.');
17475: } else {
17476: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17477: }
17478: $outcome .= $linefeed;
17479: return (0,$outcome,$clonemsgref);
1.943 raeburn 17480: }
1.541 raeburn 17481: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17482:
1.444 albertel 17483: #
1.566 albertel 17484: # Do the cloning
17485: #
1.1344 raeburn 17486: my @clonemsg;
1.566 albertel 17487: if ($can_clone && $cloneid) {
1.1344 raeburn 17488: push(@clonemsg,
17489: {
17490: mt => 'Created [_1] by cloning from [_2]',
17491: args => [$showncrstype,$clonetitle],
17492: });
1.566 albertel 17493: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17494: # Copy all files
1.1344 raeburn 17495: my @info =
17496: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17497: $args->{'dateshift'},$args->{'crscode'},
17498: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17499: $args->{'tinyurls'});
17500: if (@info) {
17501: push(@clonemsg,@info);
17502: }
1.444 albertel 17503: # Restore URL
1.566 albertel 17504: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17505: # Restore title
1.566 albertel 17506: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17507: # Restore creation date, creator and creation context.
17508: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17509: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17510: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17511: # Mark as cloned
1.566 albertel 17512: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17513: # Need to clone grading mode
17514: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17515: $cenv{'grading'}=$newenv{'grading'};
17516: # Do not clone these environment entries
17517: &Apache::lonnet::del('environment',
17518: ['default_enrollment_start_date',
17519: 'default_enrollment_end_date',
17520: 'question.email',
17521: 'policy.email',
17522: 'comment.email',
17523: 'pch.users.denied',
1.725 raeburn 17524: 'plc.users.denied',
17525: 'hidefromcat',
1.1121 raeburn 17526: 'checkforpriv',
1.1355 raeburn 17527: 'categories'],
1.638 www 17528: $$crsudom,$$crsunum);
1.1170 raeburn 17529: if ($args->{'textbook'}) {
17530: $cenv{'internal.textbook'} = $args->{'textbook'};
17531: }
1.444 albertel 17532: }
1.566 albertel 17533:
1.444 albertel 17534: #
17535: # Set environment (will override cloned, if existing)
17536: #
17537: my @sections = ();
17538: my @xlists = ();
17539: if ($args->{'crstype'}) {
17540: $cenv{'type'}=$args->{'crstype'};
17541: }
1.1371 raeburn 17542: if ($args->{'lti'}) {
17543: $cenv{'internal.lti'}=$args->{'lti'};
17544: }
1.444 albertel 17545: if ($args->{'crsid'}) {
17546: $cenv{'courseid'}=$args->{'crsid'};
17547: }
17548: if ($args->{'crscode'}) {
17549: $cenv{'internal.coursecode'}=$args->{'crscode'};
17550: }
17551: if ($args->{'crsquota'} ne '') {
17552: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17553: } else {
17554: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17555: }
17556: if ($args->{'ccuname'}) {
17557: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17558: ':'.$args->{'ccdomain'};
17559: } else {
17560: $cenv{'internal.courseowner'} = $args->{'curruser'};
17561: }
1.1116 raeburn 17562: if ($args->{'defaultcredits'}) {
17563: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17564: }
1.444 albertel 17565: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17566: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17567: if ($args->{'crssections'}) {
17568: $cenv{'internal.sectionnums'} = '';
17569: if ($args->{'crssections'} =~ m/,/) {
17570: @sections = split/,/,$args->{'crssections'};
17571: } else {
17572: $sections[0] = $args->{'crssections'};
17573: }
17574: if (@sections > 0) {
17575: foreach my $item (@sections) {
17576: my ($sec,$gp) = split/:/,$item;
17577: my $class = $args->{'crscode'}.$sec;
17578: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17579: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17580: if ($addcheck eq 'ok') {
17581: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17582: push(@oklcsecs,$gp);
17583: }
17584: } else {
1.1263 raeburn 17585: push(@badclasses,$class);
1.444 albertel 17586: }
17587: }
17588: $cenv{'internal.sectionnums'} =~ s/,$//;
17589: }
17590: }
17591: # do not hide course coordinator from staff listing,
17592: # even if privileged
17593: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17594: # add course coordinator's domain to domains to check for privileged users
17595: # if different to course domain
17596: if ($$crsudom ne $args->{'ccdomain'}) {
17597: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17598: }
1.444 albertel 17599: # add crosslistings
17600: if ($args->{'crsxlist'}) {
17601: $cenv{'internal.crosslistings'}='';
17602: if ($args->{'crsxlist'} =~ m/,/) {
17603: @xlists = split/,/,$args->{'crsxlist'};
17604: } else {
17605: $xlists[0] = $args->{'crsxlist'};
17606: }
17607: if (@xlists > 0) {
17608: foreach my $item (@xlists) {
17609: my ($xl,$gp) = split/:/,$item;
17610: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17611: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17612: if ($addcheck eq 'ok') {
17613: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17614: push(@oklcsecs,$gp);
17615: }
17616: } else {
1.1263 raeburn 17617: push(@badclasses,$xl);
1.444 albertel 17618: }
17619: }
17620: $cenv{'internal.crosslistings'} =~ s/,$//;
17621: }
17622: }
17623: if ($args->{'autoadds'}) {
17624: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17625: }
17626: if ($args->{'autodrops'}) {
17627: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17628: }
17629: # check for notification of enrollment changes
17630: my @notified = ();
17631: if ($args->{'notify_owner'}) {
17632: if ($args->{'ccuname'} ne '') {
17633: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17634: }
17635: }
17636: if ($args->{'notify_dc'}) {
17637: if ($uname ne '') {
1.630 raeburn 17638: push(@notified,$uname.':'.$udom);
1.444 albertel 17639: }
17640: }
17641: if (@notified > 0) {
17642: my $notifylist;
17643: if (@notified > 1) {
17644: $notifylist = join(',',@notified);
17645: } else {
17646: $notifylist = $notified[0];
17647: }
17648: $cenv{'internal.notifylist'} = $notifylist;
17649: }
17650: if (@badclasses > 0) {
17651: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17652: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17653: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17654: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17655: );
1.1264 raeburn 17656: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17657: &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 17658: if ($context eq 'auto') {
17659: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17660: } else {
1.566 albertel 17661: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17662: }
17663: foreach my $item (@badclasses) {
1.541 raeburn 17664: if ($context eq 'auto') {
1.1261 raeburn 17665: $outcome .= " - $item\n";
1.541 raeburn 17666: } else {
1.1261 raeburn 17667: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17668: }
1.1261 raeburn 17669: }
17670: if ($context eq 'auto') {
17671: $outcome .= $linefeed;
17672: } else {
17673: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17674: }
1.444 albertel 17675: }
17676: if ($args->{'no_end_date'}) {
17677: $args->{'endaccess'} = 0;
17678: }
1.1412 raeburn 17679: # If an official course with institutional sections is created by cloning
17680: # an existing course, section-specific hiding of course totals in student's
17681: # view of grades as copied from cloned course, will be checked for valid
17682: # sections.
17683: if (($can_clone && $cloneid) &&
17684: ($cenv{'internal.coursecode'} ne '') &&
17685: ($cenv{'grading'} eq 'standard') &&
17686: ($cenv{'hidetotals'} ne '') &&
17687: ($cenv{'hidetotals'} ne 'all')) {
17688: my @hidesecs;
17689: my $deletehidetotals;
17690: if (@oklcsecs) {
17691: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17692: if (grep(/^\Q$sec$/,@oklcsecs)) {
17693: push(@hidesecs,$sec);
17694: }
17695: }
17696: if (@hidesecs) {
17697: $cenv{'hidetotals'} = join(',',@hidesecs);
17698: } else {
17699: $deletehidetotals = 1;
17700: }
17701: } else {
17702: $deletehidetotals = 1;
17703: }
17704: if ($deletehidetotals) {
17705: delete($cenv{'hidetotals'});
17706: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17707: }
17708: }
1.444 albertel 17709: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17710: $cenv{'internal.autoend'}=$args->{'enrollend'};
17711: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17712: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17713: if ($args->{'showphotos'}) {
17714: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17715: }
17716: $cenv{'internal.authtype'} = $args->{'authtype'};
17717: $cenv{'internal.autharg'} = $args->{'autharg'};
17718: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17719: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17720: 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');
17721: if ($context eq 'auto') {
17722: $outcome .= $krb_msg;
17723: } else {
1.566 albertel 17724: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17725: }
17726: $outcome .= $linefeed;
1.444 albertel 17727: }
17728: }
17729: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17730: if ($args->{'setpolicy'}) {
17731: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17732: }
17733: if ($args->{'setcontent'}) {
17734: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17735: }
1.1251 raeburn 17736: if ($args->{'setcomment'}) {
17737: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17738: }
1.444 albertel 17739: }
17740: if ($args->{'reshome'}) {
17741: $cenv{'reshome'}=$args->{'reshome'}.'/';
17742: $cenv{'reshome'}=~s/\/+$/\//;
17743: }
17744: #
17745: # course has keyed access
17746: #
17747: if ($args->{'setkeys'}) {
17748: $cenv{'keyaccess'}='yes';
17749: }
17750: # if specified, key authority is not course, but user
17751: # only active if keyaccess is yes
17752: if ($args->{'keyauth'}) {
1.487 albertel 17753: my ($user,$domain) = split(':',$args->{'keyauth'});
17754: $user = &LONCAPA::clean_username($user);
17755: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17756: if ($user ne '' && $domain ne '') {
1.487 albertel 17757: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17758: }
17759: }
17760:
1.1166 raeburn 17761: #
1.1167 raeburn 17762: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17763: #
17764: if ($args->{'uniquecode'}) {
17765: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17766: if ($code) {
17767: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17768: my %crsinfo =
17769: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17770: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17771: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17772: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17773: }
1.1166 raeburn 17774: if (ref($coderef)) {
17775: $$coderef = $code;
17776: }
17777: }
17778: }
17779:
1.444 albertel 17780: if ($args->{'disresdis'}) {
17781: $cenv{'pch.roles.denied'}='st';
17782: }
17783: if ($args->{'disablechat'}) {
17784: $cenv{'plc.roles.denied'}='st';
17785: }
17786:
17787: # Record we've not yet viewed the Course Initialization Helper for this
17788: # course
17789: $cenv{'course.helper.not.run'} = 1;
17790: #
17791: # Use new Randomseed
17792: #
17793: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17794: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17795: #
17796: # The encryption code and receipt prefix for this course
17797: #
17798: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17799: $cenv{'internal.encpref'}=100+int(9*rand(99));
17800: #
17801: # By default, use standard grading
17802: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17803:
1.541 raeburn 17804: $outcome .= $linefeed.&mt('Setting environment').': '.
17805: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17806: #
17807: # Open all assignments
17808: #
17809: if ($args->{'openall'}) {
1.1341 raeburn 17810: my $opendate = time;
17811: if ($args->{'openallfrom'} =~ /^\d+$/) {
17812: $opendate = $args->{'openallfrom'};
17813: }
1.444 albertel 17814: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17815: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17816: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17817: $outcome .= &mt('All assignments open starting [_1]',
17818: &Apache::lonlocal::locallocaltime($opendate)).': '.
17819: &Apache::lonnet::cput
17820: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17821: }
17822: #
17823: # Set first page
17824: #
17825: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17826: || ($cloneid)) {
17827: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17828:
17829: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17830: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17831:
1.444 albertel 17832: $outcome .= ($fatal?$errtext:'read ok').' - ';
17833: my $title; my $url;
17834: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17835: $title=&mt('Syllabus');
1.444 albertel 17836: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17837: } else {
1.963 raeburn 17838: $title=&mt('Table of Contents');
1.444 albertel 17839: $url='/adm/navmaps';
17840: }
1.445 albertel 17841:
17842: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17843: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17844:
17845: if ($errtext) { $fatal=2; }
1.541 raeburn 17846: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17847: }
1.566 albertel 17848:
1.1237 raeburn 17849: #
17850: # Set params for Placement Tests
17851: #
1.1239 raeburn 17852: if ($args->{'crstype'} eq 'Placement') {
17853: my %storecontent;
17854: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17855: my %defaults = (
17856: buttonshide => { value => 'yes',
17857: type => 'string_yesno',},
17858: type => { value => 'randomizetry',
17859: type => 'string_questiontype',},
17860: maxtries => { value => 1,
17861: type => 'int_pos',},
17862: problemstatus => { value => 'no',
17863: type => 'string_problemstatus',},
17864: );
17865: foreach my $key (keys(%defaults)) {
17866: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17867: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17868: }
1.1237 raeburn 17869: &Apache::lonnet::cput
17870: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17871: }
17872:
1.1344 raeburn 17873: return (1,$outcome,\@clonemsg);
1.444 albertel 17874: }
17875:
1.1166 raeburn 17876: sub make_unique_code {
17877: my ($cdom,$cnum) = @_;
17878: # get lock on uniquecodes db
17879: my $lockhash = {
17880: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17881: ':'.$env{'user.domain'},
17882: };
17883: my $tries = 0;
17884: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17885: my ($code,$error);
17886:
17887: while (($gotlock ne 'ok') && ($tries<3)) {
17888: $tries ++;
17889: sleep 1;
17890: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17891: }
17892: if ($gotlock eq 'ok') {
17893: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17894: my $gotcode;
17895: my $attempts = 0;
17896: while ((!$gotcode) && ($attempts < 100)) {
17897: $code = &generate_code();
17898: if (!exists($currcodes{$code})) {
17899: $gotcode = 1;
17900: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17901: $error = 'nostore';
17902: }
17903: }
17904: $attempts ++;
17905: }
17906: my @del_lock = ($cnum."\0".'uniquecodes');
17907: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17908: } else {
17909: $error = 'nolock';
17910: }
17911: return ($code,$error);
17912: }
17913:
17914: sub generate_code {
17915: my $code;
17916: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17917: for (my $i=0; $i<6; $i++) {
17918: my $lettnum = int (rand 2);
17919: my $item = '';
17920: if ($lettnum) {
17921: $item = $letts[int( rand(18) )];
17922: } else {
17923: $item = 1+int( rand(8) );
17924: }
17925: $code .= $item;
17926: }
17927: return $code;
17928: }
17929:
1.444 albertel 17930: ############################################################
17931: ############################################################
17932:
1.1237 raeburn 17933: # Community, Course and Placement Test
1.378 raeburn 17934: sub course_type {
17935: my ($cid) = @_;
17936: if (!defined($cid)) {
17937: $cid = $env{'request.course.id'};
17938: }
1.404 albertel 17939: if (defined($env{'course.'.$cid.'.type'})) {
17940: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17941: } else {
17942: return 'Course';
1.377 raeburn 17943: }
17944: }
1.156 albertel 17945:
1.406 raeburn 17946: sub group_term {
17947: my $crstype = &course_type();
17948: my %names = (
17949: 'Course' => 'group',
1.865 raeburn 17950: 'Community' => 'group',
1.1237 raeburn 17951: 'Placement' => 'group',
1.406 raeburn 17952: );
17953: return $names{$crstype};
17954: }
17955:
1.902 raeburn 17956: sub course_types {
1.1310 raeburn 17957: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17958: my %typename = (
17959: official => 'Official course',
17960: unofficial => 'Unofficial course',
17961: community => 'Community',
1.1165 raeburn 17962: textbook => 'Textbook course',
1.1237 raeburn 17963: placement => 'Placement test',
1.1310 raeburn 17964: lti => 'LTI provider',
1.902 raeburn 17965: );
17966: return (\@types,\%typename);
17967: }
17968:
1.156 albertel 17969: sub icon {
17970: my ($file)=@_;
1.505 albertel 17971: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17972: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17973: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17974: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17975: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17976: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17977: $curfext.".gif") {
17978: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17979: $curfext.".gif";
17980: }
17981: }
1.249 albertel 17982: return &lonhttpdurl($iconname);
1.154 albertel 17983: }
1.84 albertel 17984:
1.575 albertel 17985: sub lonhttpdurl {
1.692 www 17986: #
17987: # Had been used for "small fry" static images on separate port 8080.
17988: # Modify here if lightweight http functionality desired again.
17989: # Currently eliminated due to increasing firewall issues.
17990: #
1.575 albertel 17991: my ($url)=@_;
1.692 www 17992: return $url;
1.215 albertel 17993: }
17994:
1.213 albertel 17995: sub connection_aborted {
17996: my ($r)=@_;
17997: $r->print(" ");$r->rflush();
17998: my $c = $r->connection;
17999: return $c->aborted();
18000: }
18001:
1.221 foxr 18002: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 18003: # strings as 'strings'.
18004: sub escape_single {
1.221 foxr 18005: my ($input) = @_;
1.223 albertel 18006: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 18007: $input =~ s/\'/\\\'/g; # Esacpe the 's....
18008: return $input;
18009: }
1.223 albertel 18010:
1.222 foxr 18011: # Same as escape_single, but escape's "'s This
18012: # can be used for "strings"
18013: sub escape_double {
18014: my ($input) = @_;
18015: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
18016: $input =~ s/\"/\\\"/g; # Esacpe the "s....
18017: return $input;
18018: }
1.223 albertel 18019:
1.222 foxr 18020: # Escapes the last element of a full URL.
18021: sub escape_url {
18022: my ($url) = @_;
1.238 raeburn 18023: my @urlslices = split(/\//, $url,-1);
1.369 www 18024: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 18025: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 18026: }
1.462 albertel 18027:
1.820 raeburn 18028: sub compare_arrays {
18029: my ($arrayref1,$arrayref2) = @_;
18030: my (@difference,%count);
18031: @difference = ();
18032: %count = ();
18033: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
18034: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
18035: foreach my $element (keys(%count)) {
18036: if ($count{$element} == 1) {
18037: push(@difference,$element);
18038: }
18039: }
18040: }
18041: return @difference;
18042: }
18043:
1.1322 raeburn 18044: sub lon_status_items {
18045: my %defaults = (
18046: E => 100,
18047: W => 4,
18048: N => 1,
1.1324 raeburn 18049: U => 5,
1.1322 raeburn 18050: threshold => 200,
18051: sysmail => 2500,
18052: );
18053: my %names = (
18054: E => 'Errors',
18055: W => 'Warnings',
18056: N => 'Notices',
1.1324 raeburn 18057: U => 'Unsent',
1.1322 raeburn 18058: );
18059: return (\%defaults,\%names);
18060: }
18061:
1.817 bisitz 18062: # -------------------------------------------------------- Initialize user login
1.462 albertel 18063: sub init_user_environment {
1.463 albertel 18064: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 18065: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
18066:
18067: my $public=($username eq 'public' && $domain eq 'public');
18068:
1.1415 raeburn 18069: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
18070: $coauthorenv);
1.462 albertel 18071: my $now=time;
18072:
18073: if ($public) {
18074: my $max_public=100;
18075: my $oldest;
18076: my $oldest_time=0;
18077: for(my $next=1;$next<=$max_public;$next++) {
18078: if (-e $lonids."/publicuser_$next.id") {
18079: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
18080: if ($mtime<$oldest_time || !$oldest_time) {
18081: $oldest_time=$mtime;
18082: $oldest=$next;
18083: }
18084: } else {
18085: $cookie="publicuser_$next";
18086: last;
18087: }
18088: }
18089: if (!$cookie) { $cookie="publicuser_$oldest"; }
18090: } else {
1.1275 raeburn 18091: # See if old ID present, if so, remove if this isn't a robot,
18092: # killing any existing non-robot sessions
1.463 albertel 18093: if (!$args->{'robot'}) {
18094: opendir(DIR,$lonids);
18095: while ($filename=readdir(DIR)) {
18096: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 18097: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
18098: &GDBM_READER(),0640)) {
1.1295 raeburn 18099: my $linkedfile;
1.1320 raeburn 18100: if (exists($oldenv{'user.linkedenv'})) {
18101: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 18102: }
1.1320 raeburn 18103: untie(%oldenv);
18104: if (unlink("$lonids/$filename")) {
18105: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
18106: if (-l "$lonids/$linkedfile.id") {
18107: unlink("$lonids/$linkedfile.id");
18108: }
1.1295 raeburn 18109: }
18110: }
18111: } else {
18112: unlink($lonids.'/'.$filename);
18113: }
1.463 albertel 18114: }
1.462 albertel 18115: }
1.463 albertel 18116: closedir(DIR);
1.1204 raeburn 18117: # If there is a undeleted lockfile for the user's paste buffer remove it.
18118: my $namespace = 'nohist_courseeditor';
18119: my $lockingkey = 'paste'."\0".'locked_num';
18120: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
18121: $domain,$username);
18122: if (exists($lockhash{$lockingkey})) {
18123: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
18124: unless ($delresult eq 'ok') {
18125: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
18126: }
18127: }
1.462 albertel 18128: }
18129: # Give them a new cookie
1.463 albertel 18130: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 18131: : $now.$$.int(rand(10000)));
1.463 albertel 18132: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 18133:
18134: # Initialize roles
18135:
1.1414 raeburn 18136: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 18137: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 18138: }
18139: # ------------------------------------ Check browser type and MathML capability
18140:
1.1194 raeburn 18141: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
18142: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 18143:
18144: # ------------------------------------------------------------- Get environment
18145:
18146: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
18147: my ($tmp) = keys(%userenv);
1.1275 raeburn 18148: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 18149: undef(%userenv);
18150: }
18151: if (($userenv{'interface'}) && (!$form->{'interface'})) {
18152: $form->{'interface'}=$userenv{'interface'};
18153: }
18154: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
18155:
18156: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 18157: foreach my $option ('interface','localpath','localres') {
18158: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 18159: }
18160: # --------------------------------------------------------- Write first profile
18161:
18162: {
1.1350 raeburn 18163: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18164: my %initial_env =
18165: ("user.name" => $username,
18166: "user.domain" => $domain,
18167: "user.home" => $authhost,
18168: "browser.type" => $clientbrowser,
18169: "browser.version" => $clientversion,
18170: "browser.mathml" => $clientmathml,
18171: "browser.unicode" => $clientunicode,
18172: "browser.os" => $clientos,
1.1137 raeburn 18173: "browser.mobile" => $clientmobile,
1.1141 raeburn 18174: "browser.info" => $clientinfo,
1.1194 raeburn 18175: "browser.osversion" => $clientosversion,
1.462 albertel 18176: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18177: "request.course.fn" => '',
18178: "request.course.uri" => '',
18179: "request.course.sec" => '',
18180: "request.role" => 'cm',
18181: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18182: "request.host" => $ip,);
1.462 albertel 18183:
18184: if ($form->{'localpath'}) {
18185: $initial_env{"browser.localpath"} = $form->{'localpath'};
18186: $initial_env{"browser.localres"} = $form->{'localres'};
18187: }
18188:
18189: if ($form->{'interface'}) {
18190: $form->{'interface'}=~s/\W//gs;
18191: $initial_env{"browser.interface"} = $form->{'interface'};
18192: $env{'browser.interface'}=$form->{'interface'};
18193: }
18194:
1.1157 raeburn 18195: if ($form->{'iptoken'}) {
18196: my $lonhost = $r->dir_config('lonHostID');
18197: $initial_env{"user.noloadbalance"} = $lonhost;
18198: $env{'user.noloadbalance'} = $lonhost;
18199: }
18200:
1.1268 raeburn 18201: if ($form->{'noloadbalance'}) {
18202: my @hosts = &Apache::lonnet::current_machine_ids();
18203: my $hosthere = $form->{'noloadbalance'};
18204: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18205: $initial_env{"user.noloadbalance"} = $hosthere;
18206: $env{'user.noloadbalance'} = $hosthere;
18207: }
18208: }
18209:
1.1016 raeburn 18210: unless ($domain eq 'public') {
1.1273 raeburn 18211: my %is_adv = ( is_adv => $env{'user.adv'} );
18212: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18213:
1.1414 raeburn 18214: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18215: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18216: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18217: undef,\%userenv,\%domdef,\%is_adv);
18218: }
1.980 raeburn 18219:
1.1311 raeburn 18220: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18221: $userenv{'canrequest.'.$crstype} =
18222: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18223: 'reload','requestcourses',
18224: \%userenv,\%domdef,\%is_adv);
18225: }
1.724 raeburn 18226:
1.1418 raeburn 18227: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18228: (exists($userroles->{"user.role.au./$domain/"}))) {
18229: if ($userenv{'authoreditors'}) {
18230: $userenv{'editors'} = $userenv{'authoreditors'};
18231: } elsif ($domdef{'editors'} ne '') {
18232: $userenv{'editors'} = $domdef{'editors'};
18233: } else {
18234: $userenv{'editors'} = 'edit,xml';
18235: }
1.1431 raeburn 18236: if ($userenv{'authorarchive'}) {
18237: $userenv{'canarchive'} = 1;
18238: } elsif (($userenv{'authorarchive'} eq '') &&
18239: ($domdef{'archive'})) {
18240: $userenv{'canarchive'} = 1;
18241: }
1.1418 raeburn 18242: }
18243:
1.1273 raeburn 18244: $userenv{'canrequest.author'} =
18245: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18246: 'reload','requestauthor',
1.980 raeburn 18247: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18248: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18249: $domain,$username);
18250: my $reqstatus = $reqauthor{'author_status'};
18251: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18252: if (ref($reqauthor{'author'}) eq 'HASH') {
18253: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18254: $reqauthor{'author'}{'timestamp'};
18255: }
1.1092 raeburn 18256: }
1.1287 raeburn 18257: my ($types,$typename) = &course_types();
18258: if (ref($types) eq 'ARRAY') {
18259: my @options = ('approval','validate','autolimit');
18260: my $optregex = join('|',@options);
18261: my (%willtrust,%trustchecked);
18262: foreach my $type (@{$types}) {
18263: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18264: if ($dom_str ne '') {
18265: my $updatedstr = '';
18266: my @possdomains = split(',',$dom_str);
18267: foreach my $entry (@possdomains) {
18268: my ($extdom,$extopt) = split(':',$entry);
18269: unless ($trustchecked{$extdom}) {
18270: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18271: $trustchecked{$extdom} = 1;
18272: }
18273: if ($willtrust{$extdom}) {
18274: $updatedstr .= $entry.',';
18275: }
18276: }
18277: $updatedstr =~ s/,$//;
18278: if ($updatedstr) {
18279: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18280: } else {
18281: delete($userenv{'reqcrsotherdom.'.$type});
18282: }
18283: }
18284: }
18285: }
1.1092 raeburn 18286: }
1.462 albertel 18287: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18288:
1.462 albertel 18289: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18290: &GDBM_WRCREAT(),0640)) {
18291: &_add_to_env(\%disk_env,\%initial_env);
18292: &_add_to_env(\%disk_env,\%userenv,'environment.');
18293: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18294: if (ref($firstaccenv) eq 'HASH') {
18295: &_add_to_env(\%disk_env,$firstaccenv);
18296: }
18297: if (ref($timerintenv) eq 'HASH') {
18298: &_add_to_env(\%disk_env,$timerintenv);
18299: }
1.1414 raeburn 18300: if (ref($coauthorenv) eq 'HASH') {
18301: if (keys(%{$coauthorenv})) {
18302: &_add_to_env(\%disk_env,$coauthorenv);
18303: }
18304: }
1.463 albertel 18305: if (ref($args->{'extra_env'})) {
18306: &_add_to_env(\%disk_env,$args->{'extra_env'});
18307: }
1.462 albertel 18308: untie(%disk_env);
18309: } else {
1.705 tempelho 18310: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18311: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18312: return 'error: '.$!;
18313: }
18314: }
18315: $env{'request.role'}='cm';
18316: $env{'request.role.adv'}=$env{'user.adv'};
18317: $env{'browser.type'}=$clientbrowser;
18318:
18319: return $cookie;
18320:
18321: }
18322:
18323: sub _add_to_env {
18324: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18325: if (ref($env_data) eq 'HASH') {
18326: while (my ($key,$value) = each(%$env_data)) {
18327: $idf->{$prefix.$key} = $value;
18328: $env{$prefix.$key} = $value;
18329: }
1.462 albertel 18330: }
18331: }
18332:
1.685 tempelho 18333: # --- Get the symbolic name of a problem and the url
18334: sub get_symb {
18335: my ($request,$silent) = @_;
1.726 raeburn 18336: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18337: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18338: if ($symb eq '') {
18339: if (!$silent) {
1.1071 raeburn 18340: if (ref($request)) {
18341: $request->print("Unable to handle ambiguous references:$url:.");
18342: }
1.685 tempelho 18343: return ();
18344: }
18345: }
18346: &Apache::lonenc::check_decrypt(\$symb);
18347: return ($symb);
18348: }
18349:
18350: # --------------------------------------------------------------Get annotation
18351:
18352: sub get_annotation {
18353: my ($symb,$enc) = @_;
18354:
18355: my $key = $symb;
18356: if (!$enc) {
18357: $key =
18358: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18359: }
18360: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18361: return $annotation{$key};
18362: }
18363:
18364: sub clean_symb {
1.731 raeburn 18365: my ($symb,$delete_enc) = @_;
1.685 tempelho 18366:
18367: &Apache::lonenc::check_decrypt(\$symb);
18368: my $enc = $env{'request.enc'};
1.731 raeburn 18369: if ($delete_enc) {
1.730 raeburn 18370: delete($env{'request.enc'});
18371: }
1.685 tempelho 18372:
18373: return ($symb,$enc);
18374: }
1.462 albertel 18375:
1.1181 raeburn 18376: ############################################################
18377: ############################################################
18378:
18379: =pod
18380:
18381: =head1 Routines for building display used to search for courses
18382:
18383:
18384: =over 4
18385:
18386: =item * &build_filters()
18387:
18388: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18389: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18390: and quotacheck.pl
18391:
1.1181 raeburn 18392:
18393: Inputs:
18394:
18395: filterlist - anonymous array of fields to include as potential filters
18396:
18397: crstype - course type
18398:
18399: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18400: to pop-open a course selector (will contain "extra element").
18401:
18402: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18403:
18404: filter - anonymous hash of criteria and their values
18405:
18406: action - form action
18407:
18408: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18409:
1.1182 raeburn 18410: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18411:
18412: cloneruname - username of owner of new course who wants to clone
18413:
18414: clonerudom - domain of owner of new course who wants to clone
18415:
18416: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18417:
18418: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18419:
18420: codedom - domain
18421:
18422: formname - value of form element named "form".
18423:
18424: fixeddom - domain, if fixed.
18425:
18426: prevphase - value to assign to form element named "phase" when going back to the previous screen
18427:
18428: cnameelement - name of form element in form on opener page which will receive title of selected course
18429:
18430: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18431:
18432: cdomelement - name of form element in form on opener page which will receive domain of selected course
18433:
18434: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18435:
18436: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18437:
18438: clonewarning - warning message about missing information for intended course owner when DC creates a course
18439:
1.1182 raeburn 18440:
1.1181 raeburn 18441: Returns: $output - HTML for display of search criteria, and hidden form elements.
18442:
1.1182 raeburn 18443:
1.1181 raeburn 18444: Side Effects: None
18445:
18446: =cut
18447:
18448: # ---------------------------------------------- search for courses based on last activity etc.
18449:
18450: sub build_filters {
18451: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18452: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18453: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18454: $cnameelement,$cnumelement,$cdomelement,$setroles,
18455: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18456: my ($list,$jscript);
1.1181 raeburn 18457: my $onchange = 'javascript:updateFilters(this)';
18458: my ($domainselectform,$sincefilterform,$createdfilterform,
18459: $ownerdomselectform,$persondomselectform,$instcodeform,
18460: $typeselectform,$instcodetitle);
18461: if ($formname eq '') {
18462: $formname = $caller;
18463: }
18464: foreach my $item (@{$filterlist}) {
18465: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18466: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18467: if ($item eq 'domainfilter') {
18468: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18469: } elsif ($item eq 'coursefilter') {
18470: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18471: } elsif ($item eq 'ownerfilter') {
18472: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18473: } elsif ($item eq 'ownerdomfilter') {
18474: $filter->{'ownerdomfilter'} =
18475: &LONCAPA::clean_domain($filter->{$item});
18476: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18477: 'ownerdomfilter',1);
18478: } elsif ($item eq 'personfilter') {
18479: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18480: } elsif ($item eq 'persondomfilter') {
18481: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18482: 'persondomfilter',1);
18483: } else {
18484: $filter->{$item} =~ s/\W//g;
18485: }
18486: if (!$filter->{$item}) {
18487: $filter->{$item} = '';
18488: }
18489: }
18490: if ($item eq 'domainfilter') {
18491: my $allow_blank = 1;
18492: if ($formname eq 'portform') {
18493: $allow_blank=0;
18494: } elsif ($formname eq 'studentform') {
18495: $allow_blank=0;
18496: }
18497: if ($fixeddom) {
18498: $domainselectform = '<input type="hidden" name="domainfilter"'.
18499: ' value="'.$codedom.'" />'.
18500: &Apache::lonnet::domain($codedom,'description');
18501: } else {
18502: $domainselectform = &select_dom_form($filter->{$item},
18503: 'domainfilter',
18504: $allow_blank,'',$onchange);
18505: }
18506: } else {
18507: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18508: }
18509: }
18510:
18511: # last course activity filter and selection
18512: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18513:
18514: # course created filter and selection
18515: if (exists($filter->{'createdfilter'})) {
18516: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18517: }
18518:
1.1239 raeburn 18519: my $prefix = $crstype;
18520: if ($crstype eq 'Placement') {
18521: $prefix = 'Placement Test'
18522: }
1.1181 raeburn 18523: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18524: 'cac' => "$prefix Activity",
18525: 'ccr' => "$prefix Created",
18526: 'cde' => "$prefix Title",
18527: 'cdo' => "$prefix Domain",
1.1181 raeburn 18528: 'ins' => 'Institutional Code',
18529: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18530: 'cow' => "$prefix Owner/Co-owner",
18531: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18532: 'cog' => 'Type',
18533: );
18534:
18535: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18536: my $typeval = 'Course';
18537: if ($crstype eq 'Community') {
18538: $typeval = 'Community';
1.1239 raeburn 18539: } elsif ($crstype eq 'Placement') {
18540: $typeval = 'Placement';
1.1181 raeburn 18541: }
18542: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18543: } else {
18544: $typeselectform = '<select name="type" size="1"';
18545: if ($onchange) {
18546: $typeselectform .= ' onchange="'.$onchange.'"';
18547: }
18548: $typeselectform .= '>'."\n";
1.1237 raeburn 18549: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18550: my $shown;
18551: if ($posstype eq 'Placement') {
18552: $shown = &mt('Placement Test');
18553: } else {
18554: $shown = &mt($posstype);
18555: }
1.1181 raeburn 18556: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18557: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18558: }
18559: $typeselectform.="</select>";
18560: }
18561:
18562: my ($cloneableonlyform,$cloneabletitle);
18563: if (exists($filter->{'cloneableonly'})) {
18564: my $cloneableon = '';
18565: my $cloneableoff = ' checked="checked"';
18566: if ($filter->{'cloneableonly'}) {
18567: $cloneableon = $cloneableoff;
18568: $cloneableoff = '';
18569: }
18570: $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>';
18571: if ($formname eq 'ccrs') {
1.1187 bisitz 18572: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18573: } else {
18574: $cloneabletitle = &mt('Cloneable by you');
18575: }
18576: }
18577: my $officialjs;
18578: if ($crstype eq 'Course') {
18579: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18580: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18581: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18582: if ($codedom) {
1.1181 raeburn 18583: $officialjs = 1;
18584: ($instcodeform,$jscript,$$numtitlesref) =
18585: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18586: $officialjs,$codetitlesref);
18587: if ($jscript) {
1.1182 raeburn 18588: $jscript = '<script type="text/javascript">'."\n".
18589: '// <![CDATA['."\n".
18590: $jscript."\n".
18591: '// ]]>'."\n".
18592: '</script>'."\n";
1.1181 raeburn 18593: }
18594: }
18595: if ($instcodeform eq '') {
18596: $instcodeform =
18597: '<input type="text" name="instcodefilter" size="10" value="'.
18598: $list->{'instcodefilter'}.'" />';
18599: $instcodetitle = $lt{'ins'};
18600: } else {
18601: $instcodetitle = $lt{'inc'};
18602: }
18603: if ($fixeddom) {
18604: $instcodetitle .= '<br />('.$codedom.')';
18605: }
18606: }
18607: }
18608: my $output = qq|
18609: <form method="post" name="filterpicker" action="$action">
18610: <input type="hidden" name="form" value="$formname" />
18611: |;
18612: if ($formname eq 'modifycourse') {
18613: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18614: '<input type="hidden" name="prevphase" value="'.
18615: $prevphase.'" />'."\n";
1.1198 musolffc 18616: } elsif ($formname eq 'quotacheck') {
18617: $output .= qq|
18618: <input type="hidden" name="sortby" value="" />
18619: <input type="hidden" name="sortorder" value="" />
18620: |;
18621: } else {
1.1181 raeburn 18622: my $name_input;
18623: if ($cnameelement ne '') {
18624: $name_input = '<input type="hidden" name="cnameelement" value="'.
18625: $cnameelement.'" />';
18626: }
18627: $output .= qq|
1.1182 raeburn 18628: <input type="hidden" name="cnumelement" value="$cnumelement" />
18629: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18630: $name_input
18631: $roleelement
18632: $multelement
18633: $typeelement
18634: |;
18635: if ($formname eq 'portform') {
18636: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18637: }
18638: }
18639: if ($fixeddom) {
18640: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18641: }
18642: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18643: if ($sincefilterform) {
18644: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18645: .$sincefilterform
18646: .&Apache::lonhtmlcommon::row_closure();
18647: }
18648: if ($createdfilterform) {
18649: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18650: .$createdfilterform
18651: .&Apache::lonhtmlcommon::row_closure();
18652: }
18653: if ($domainselectform) {
18654: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18655: .$domainselectform
18656: .&Apache::lonhtmlcommon::row_closure();
18657: }
18658: if ($typeselectform) {
18659: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18660: $output .= $typeselectform;
18661: } else {
18662: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18663: .$typeselectform
18664: .&Apache::lonhtmlcommon::row_closure();
18665: }
18666: }
18667: if ($instcodeform) {
18668: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18669: .$instcodeform
18670: .&Apache::lonhtmlcommon::row_closure();
18671: }
18672: if (exists($filter->{'ownerfilter'})) {
18673: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18674: '<table><tr><td>'.&mt('Username').'<br />'.
18675: '<input type="text" name="ownerfilter" size="20" value="'.
18676: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18677: $ownerdomselectform.'</td></tr></table>'.
18678: &Apache::lonhtmlcommon::row_closure();
18679: }
18680: if (exists($filter->{'personfilter'})) {
18681: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18682: '<table><tr><td>'.&mt('Username').'<br />'.
18683: '<input type="text" name="personfilter" size="20" value="'.
18684: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18685: $persondomselectform.'</td></tr></table>'.
18686: &Apache::lonhtmlcommon::row_closure();
18687: }
18688: if (exists($filter->{'coursefilter'})) {
18689: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18690: .'<input type="text" name="coursefilter" size="25" value="'
18691: .$list->{'coursefilter'}.'" />'
18692: .&Apache::lonhtmlcommon::row_closure();
18693: }
18694: if ($cloneableonlyform) {
18695: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18696: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18697: }
18698: if (exists($filter->{'descriptfilter'})) {
18699: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18700: .'<input type="text" name="descriptfilter" size="40" value="'
18701: .$list->{'descriptfilter'}.'" />'
18702: .&Apache::lonhtmlcommon::row_closure(1);
18703: }
18704: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18705: '<input type="hidden" name="updater" value="" />'."\n".
18706: '<input type="submit" name="gosearch" value="'.
18707: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18708: return $jscript.$clonewarning.$output;
18709: }
18710:
18711: =pod
18712:
18713: =item * &timebased_select_form()
18714:
1.1182 raeburn 18715: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18716: filter e.g., Course Activity, Course Created, when searching for courses
18717: or communities
18718:
18719: Inputs:
18720:
18721: item - name of form element (sincefilter or createdfilter)
18722:
18723: filter - anonymous hash of criteria and their values
18724:
18725: Returns: HTML for a select box contained a blank, then six time selections,
18726: with value set in incoming form variables currently selected.
18727:
18728: Side Effects: None
18729:
18730: =cut
18731:
18732: sub timebased_select_form {
18733: my ($item,$filter) = @_;
18734: if (ref($filter) eq 'HASH') {
18735: $filter->{$item} =~ s/[^\d-]//g;
18736: if (!$filter->{$item}) { $filter->{$item}=-1; }
18737: return &select_form(
18738: $filter->{$item},
18739: $item,
18740: { '-1' => '',
18741: '86400' => &mt('today'),
18742: '604800' => &mt('last week'),
18743: '2592000' => &mt('last month'),
18744: '7776000' => &mt('last three months'),
18745: '15552000' => &mt('last six months'),
18746: '31104000' => &mt('last year'),
18747: 'select_form_order' =>
18748: ['-1','86400','604800','2592000','7776000',
18749: '15552000','31104000']});
18750: }
18751: }
18752:
18753: =pod
18754:
18755: =item * &js_changer()
18756:
18757: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18758: when course type or domain is changed, and also to hide 'Searching ...' on
18759: page load completion for page showing search result.
1.1181 raeburn 18760:
18761: Inputs: None
18762:
1.1183 raeburn 18763: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18764:
18765: Side Effects: None
18766:
18767: =cut
18768:
18769: sub js_changer {
18770: return <<ENDJS;
18771: <script type="text/javascript">
18772: // <![CDATA[
18773: function updateFilters(caller) {
18774: if (typeof(caller) != "undefined") {
18775: document.filterpicker.updater.value = caller.name;
18776: }
18777: document.filterpicker.submit();
18778: }
1.1183 raeburn 18779:
18780: function hideSearching() {
18781: if (document.getElementById('searching')) {
18782: document.getElementById('searching').style.display = 'none';
18783: }
18784: return;
18785: }
18786:
1.1181 raeburn 18787: // ]]>
18788: </script>
18789:
18790: ENDJS
18791: }
18792:
18793: =pod
18794:
1.1182 raeburn 18795: =item * &search_courses()
18796:
18797: Process selected filters form course search form and pass to lonnet::courseiddump
18798: to retrieve a hash for which keys are courseIDs which match the selected filters.
18799:
18800: Inputs:
18801:
18802: dom - domain being searched
18803:
18804: type - course type ('Course' or 'Community' or '.' if any).
18805:
18806: filter - anonymous hash of criteria and their values
18807:
18808: numtitles - for institutional codes - number of categories
18809:
18810: cloneruname - optional username of new course owner
18811:
18812: clonerudom - optional domain of new course owner
18813:
1.1221 raeburn 18814: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18815: (used when DC is using course creation form)
18816:
18817: codetitles - reference to array of titles of components in institutional codes (official courses).
18818:
1.1221 raeburn 18819: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18820: (and so can clone automatically)
18821:
18822: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18823:
18824: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18825: courses to clone
1.1182 raeburn 18826:
18827: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18828:
18829:
18830: Side Effects: None
18831:
18832: =cut
18833:
18834:
18835: sub search_courses {
1.1221 raeburn 18836: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18837: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18838: my (%courses,%showcourses,$cloner);
18839: if (($filter->{'ownerfilter'} ne '') ||
18840: ($filter->{'ownerdomfilter'} ne '')) {
18841: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18842: $filter->{'ownerdomfilter'};
18843: }
18844: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18845: if (!$filter->{$item}) {
18846: $filter->{$item}='.';
18847: }
18848: }
18849: my $now = time;
18850: my $timefilter =
18851: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18852: my ($createdbefore,$createdafter);
18853: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18854: $createdbefore = $now;
18855: $createdafter = $now-$filter->{'createdfilter'};
18856: }
18857: my ($instcodefilter,$regexpok);
18858: if ($numtitles) {
18859: if ($env{'form.official'} eq 'on') {
18860: $instcodefilter =
18861: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18862: $regexpok = 1;
18863: } elsif ($env{'form.official'} eq 'off') {
18864: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18865: unless ($instcodefilter eq '') {
18866: $regexpok = -1;
18867: }
18868: }
18869: } else {
18870: $instcodefilter = $filter->{'instcodefilter'};
18871: }
18872: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18873: if ($type eq '') { $type = '.'; }
18874:
18875: if (($clonerudom ne '') && ($cloneruname ne '')) {
18876: $cloner = $cloneruname.':'.$clonerudom;
18877: }
18878: %courses = &Apache::lonnet::courseiddump($dom,
18879: $filter->{'descriptfilter'},
18880: $timefilter,
18881: $instcodefilter,
18882: $filter->{'combownerfilter'},
18883: $filter->{'coursefilter'},
18884: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18885: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18886: $filter->{'cloneableonly'},
18887: $createdbefore,$createdafter,undef,
1.1221 raeburn 18888: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18889: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18890: my $ccrole;
18891: if ($type eq 'Community') {
18892: $ccrole = 'co';
18893: } else {
18894: $ccrole = 'cc';
18895: }
18896: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18897: $filter->{'persondomfilter'},
18898: 'userroles',undef,
18899: [$ccrole,'in','ad','ep','ta','cr'],
18900: $dom);
18901: foreach my $role (keys(%rolehash)) {
18902: my ($cnum,$cdom,$courserole) = split(':',$role);
18903: my $cid = $cdom.'_'.$cnum;
18904: if (exists($courses{$cid})) {
18905: if (ref($courses{$cid}) eq 'HASH') {
18906: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18907: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18908: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18909: }
18910: } else {
18911: $courses{$cid}{roles} = [$courserole];
18912: }
18913: $showcourses{$cid} = $courses{$cid};
18914: }
18915: }
18916: }
18917: %courses = %showcourses;
18918: }
18919: return %courses;
18920: }
18921:
18922: =pod
18923:
1.1181 raeburn 18924: =back
18925:
1.1207 raeburn 18926: =head1 Routines for version requirements for current course.
18927:
18928: =over 4
18929:
18930: =item * &check_release_required()
18931:
18932: Compares required LON-CAPA version with version on server, and
18933: if required version is newer looks for a server with the required version.
18934:
18935: Looks first at servers in user's owen domain; if none suitable, looks at
18936: servers in course's domain are permitted to host sessions for user's domain.
18937:
18938: Inputs:
18939:
18940: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18941:
18942: $courseid - Course ID of current course
18943:
18944: $rolecode - User's current role in course (for switchserver query string).
18945:
18946: $required - LON-CAPA version needed by course (format: Major.Minor).
18947:
18948:
18949: Returns:
18950:
18951: $switchserver - query string tp append to /adm/switchserver call (if
18952: current server's LON-CAPA version is too old.
18953:
18954: $warning - Message is displayed if no suitable server could be found.
18955:
18956: =cut
18957:
18958: sub check_release_required {
18959: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18960: my ($switchserver,$warning);
18961: if ($required ne '') {
18962: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18963: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18964: if ($reqdmajor ne '' && $reqdminor ne '') {
18965: my $otherserver;
18966: if (($major eq '' && $minor eq '') ||
18967: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18968: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18969: my $switchlcrev =
18970: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18971: $userdomserver);
18972: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18973: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18974: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18975: my $cdom = $env{'course.'.$courseid.'.domain'};
18976: if ($cdom ne $env{'user.domain'}) {
18977: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18978: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18979: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18980: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18981: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18982: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18983: my $canhost =
18984: &Apache::lonnet::can_host_session($env{'user.domain'},
18985: $coursedomserver,
18986: $remoterev,
18987: $udomdefaults{'remotesessions'},
18988: $defdomdefaults{'hostedsessions'});
18989:
18990: if ($canhost) {
18991: $otherserver = $coursedomserver;
18992: } else {
18993: $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.");
18994: }
18995: } else {
18996: $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).");
18997: }
18998: } else {
18999: $otherserver = $userdomserver;
19000: }
19001: }
19002: if ($otherserver ne '') {
19003: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
19004: }
19005: }
19006: }
19007: return ($switchserver,$warning);
19008: }
19009:
19010: =pod
19011:
19012: =item * &check_release_result()
19013:
19014: Inputs:
19015:
19016: $switchwarning - Warning message if no suitable server found to host session.
19017:
19018: $switchserver - query string to append to /adm/switchserver containing lonHostID
19019: and current role.
19020:
19021: Returns: HTML to display with information about requirement to switch server.
19022: Either displaying warning with link to Roles/Courses screen or
19023: display link to switchserver.
19024:
1.1181 raeburn 19025: =cut
19026:
1.1207 raeburn 19027: sub check_release_result {
19028: my ($switchwarning,$switchserver) = @_;
19029: my $output = &start_page('Selected course unavailable on this server').
19030: '<p class="LC_warning">';
19031: if ($switchwarning) {
19032: $output .= $switchwarning.'<br /><a href="/adm/roles">';
19033: if (&show_course()) {
19034: $output .= &mt('Display courses');
19035: } else {
19036: $output .= &mt('Display roles');
19037: }
19038: $output .= '</a>';
19039: } elsif ($switchserver) {
19040: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
19041: '<br />'.
19042: '<a href="/adm/switchserver?'.$switchserver.'">'.
19043: &mt('Switch Server').
19044: '</a>';
19045: }
19046: $output .= '</p>'.&end_page();
19047: return $output;
19048: }
19049:
19050: =pod
19051:
19052: =item * &needs_coursereinit()
19053:
19054: Determine if course contents stored for user's session needs to be
19055: refreshed, because content has changed since "Big Hash" last tied.
19056:
19057: Check for change is made if time last checked is more than 10 minutes ago
19058: (by default).
19059:
19060: Inputs:
19061:
19062: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
19063:
19064: $interval (optional) - Time which may elapse (in s) between last check for content
19065: change in current course. (default: 600 s).
19066:
19067: Returns: an array; first element is:
19068:
19069: =over 4
19070:
19071: 'switch' - if content updates mean user's session
19072: needs to be switched to a server running a newer LON-CAPA version
19073:
19074: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
19075: on current server hosting user's session
19076:
19077: '' - if no action required.
19078:
19079: =back
19080:
19081: If first item element is 'switch':
19082:
19083: second item is $switchwarning - Warning message if no suitable server found to host session.
19084:
19085: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
19086: and current role.
19087:
19088: otherwise: no other elements returned.
19089:
19090: =back
19091:
19092: =cut
19093:
19094: sub needs_coursereinit {
19095: my ($loncaparev,$interval) = @_;
19096: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
19097: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19098: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
19099: my $now = time;
19100: if ($interval eq '') {
19101: $interval = 600;
19102: }
19103: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 19104: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 19105: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19106: if ($blocked) {
19107: return ();
19108: }
1.1391 raeburn 19109: my $update;
19110: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
19111: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
19112: if ($lastmainchange > $env{'request.course.tied'}) {
19113: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19114: if ($needswitch) {
19115: return ('switch',$switchwarning,$switchserver);
19116: }
19117: $update = 'main';
19118: }
19119: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
19120: if ($update) {
19121: $update = 'both';
19122: } else {
19123: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
19124: if ($needswitch) {
19125: return ('switch',$switchwarning,$switchserver);
19126: } else {
19127: $update = 'supp';
1.1207 raeburn 19128: }
19129: }
1.1391 raeburn 19130: }
1.1453 raeburn 19131: return ($update);
1.1391 raeburn 19132: }
19133: return ();
19134: }
19135:
19136: sub switch_for_update {
19137: my ($loncaparev,$cdom,$cnum) = @_;
19138: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19139: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
19140: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
19141: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
19142: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
19143: $curr_reqd_hash{'internal.releaserequired'}});
19144: my ($switchserver,$switchwarning) =
19145: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
19146: $curr_reqd_hash{'internal.releaserequired'});
19147: if ($switchwarning ne '' || $switchserver ne '') {
19148: return ('switch',$switchwarning,$switchserver);
19149: }
1.1207 raeburn 19150: }
19151: }
19152: return ();
19153: }
1.1181 raeburn 19154:
1.1083 raeburn 19155: sub update_content_constraints {
1.1395 raeburn 19156: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 19157: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
19158: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 19159: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 19160: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19161: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19162: if ($item eq 'resourcetag') {
19163: if ($name eq 'responsetype') {
19164: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19165: }
1.1307 raeburn 19166: } elsif ($item eq 'course') {
19167: if ($name eq 'courserestype') {
19168: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19169: }
1.1083 raeburn 19170: }
19171: }
19172: my $navmap = Apache::lonnavmaps::navmap->new();
19173: if (defined($navmap)) {
1.1307 raeburn 19174: my (%allresponses,%allcrsrestypes);
19175: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19176: if ($res->is_tool()) {
19177: if ($allcrsrestypes{'exttool'}) {
19178: $allcrsrestypes{'exttool'} ++;
19179: } else {
19180: $allcrsrestypes{'exttool'} = 1;
19181: }
19182: next;
19183: }
1.1083 raeburn 19184: my %responses = $res->responseTypes();
19185: foreach my $key (keys(%responses)) {
19186: next unless(exists($checkresponsetypes{$key}));
19187: $allresponses{$key} += $responses{$key};
19188: }
19189: }
19190: foreach my $key (keys(%allresponses)) {
19191: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19192: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19193: ($reqdmajor,$reqdminor) = ($major,$minor);
19194: }
19195: }
1.1307 raeburn 19196: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19197: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19198: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19199: ($reqdmajor,$reqdminor) = ($major,$minor);
19200: }
19201: }
1.1083 raeburn 19202: undef($navmap);
19203: }
1.1391 raeburn 19204: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19205: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19206: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19207: ($reqdmajor,$reqdminor) = ($major,$minor);
19208: }
19209: }
1.1083 raeburn 19210: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19211: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19212: }
19213: return;
19214: }
19215:
1.1110 raeburn 19216: sub allmaps_incourse {
19217: my ($cdom,$cnum,$chome,$cid) = @_;
19218: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19219: $cid = $env{'request.course.id'};
19220: $cdom = $env{'course.'.$cid.'.domain'};
19221: $cnum = $env{'course.'.$cid.'.num'};
19222: $chome = $env{'course.'.$cid.'.home'};
19223: }
19224: my %allmaps = ();
19225: my $lastchange =
19226: &Apache::lonnet::get_coursechange($cdom,$cnum);
19227: if ($lastchange > $env{'request.course.tied'}) {
19228: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19229: unless ($ferr) {
1.1395 raeburn 19230: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19231: }
19232: }
19233: my $navmap = Apache::lonnavmaps::navmap->new();
19234: if (defined($navmap)) {
19235: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19236: $allmaps{$res->src()} = 1;
19237: }
19238: }
19239: return \%allmaps;
19240: }
19241:
1.1083 raeburn 19242: sub parse_supplemental_title {
19243: my ($title) = @_;
19244:
19245: my ($foldertitle,$renametitle);
19246: if ($title =~ /&&&/) {
19247: $title = &HTML::Entites::decode($title);
19248: }
19249: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19250: $renametitle=$4;
19251: my ($time,$uname,$udom) = ($1,$2,$3);
19252: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19253: my $name = &plainname($uname,$udom);
19254: $name = &HTML::Entities::encode($name,'"<>&\'');
19255: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19256: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19257: if ($foldertitle ne '') {
1.1401 raeburn 19258: $title .= ': <br />'.$foldertitle;
19259: }
1.1083 raeburn 19260: }
19261: if (wantarray) {
19262: return ($title,$foldertitle,$renametitle);
19263: }
19264: return $title;
19265: }
19266:
1.1395 raeburn 19267: sub get_supplemental {
19268: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19269: my $hashid=$cnum.':'.$cdom;
19270: my ($supplemental,$cached,$set_httprefs);
19271: unless ($ignorecache) {
19272: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19273: }
19274: unless (defined($cached)) {
19275: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19276: unless ($chome eq 'no_host') {
19277: my @order = @LONCAPA::map::order;
19278: my @resources = @LONCAPA::map::resources;
19279: my @resparms = @LONCAPA::map::resparms;
19280: my @zombies = @LONCAPA::map::zombies;
19281: my ($errors,%ids,%hidden);
19282: $errors =
19283: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19284: $errors,$possdel,\%ids,\%hidden);
19285: @LONCAPA::map::order = @order;
19286: @LONCAPA::map::resources = @resources;
19287: @LONCAPA::map::resparms = @resparms;
19288: @LONCAPA::map::zombies = @zombies;
19289: $set_httprefs = 1;
19290: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19291: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19292: }
19293: $supplemental = {
19294: ids => \%ids,
19295: hidden => \%hidden,
19296: };
19297: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19298: }
19299: }
19300: return ($supplemental,$set_httprefs);
19301: }
19302:
1.1143 raeburn 19303: sub recurse_supplemental {
1.1391 raeburn 19304: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19305: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19306: my $mapnum;
19307: if ($suppmap eq 'supplemental.sequence') {
19308: $mapnum = 0;
19309: } else {
19310: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19311: }
1.1143 raeburn 19312: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19313: if ($fatal) {
19314: $errors ++;
19315: } else {
1.1389 raeburn 19316: my @order = @LONCAPA::map::order;
19317: if (@order > 0) {
19318: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19319: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19320: foreach my $idx (@order) {
19321: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19322: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19323: my $id = $mapnum.':'.$idx;
19324: push(@{$suppids->{$src}},$id);
19325: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19326: $hiddensupp->{$id} = 1;
19327: }
1.1146 raeburn 19328: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19329: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19330: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19331: } else {
1.1391 raeburn 19332: my $allowed;
19333: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19334: $allowed = 1;
19335: } elsif ($possdel) {
19336: foreach my $item (@{$suppids->{$src}}) {
19337: next if ($item eq $id);
19338: unless ($hiddensupp->{$item}) {
19339: $allowed = 1;
19340: last;
19341: }
19342: }
19343: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19344: &Apache::lonnet::delenv('httpref.'.$src);
19345: }
19346: }
19347: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19348: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19349: }
1.1143 raeburn 19350: }
19351: }
19352: }
19353: }
19354: }
19355: }
1.1391 raeburn 19356: return $errors;
19357: }
19358:
19359: sub set_supp_httprefs {
19360: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19361: if (ref($supplemental) eq 'HASH') {
19362: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19363: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19364: next if ($src =~ /\.sequence$/);
19365: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19366: my $allowed;
19367: if ($env{'request.role.adv'}) {
19368: $allowed = 1;
19369: } else {
19370: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19371: unless ($supplemental->{'hidden'}->{$id}) {
19372: $allowed = 1;
19373: last;
19374: }
19375: }
19376: }
19377: if (exists($env{'httpref.'.$src})) {
19378: if ($possdel) {
19379: unless ($allowed) {
19380: &Apache::lonnet::delenv('httpref.'.$src);
19381: }
19382: }
19383: } elsif ($allowed) {
19384: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19385: }
19386: }
19387: }
19388: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19389: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19390: }
19391: }
19392: }
19393: }
19394:
19395: sub get_supp_parameter {
19396: my ($resparm,$name)=@_;
19397: return if ($resparm eq '');
19398: my $value=undef;
19399: my $ptype=undef;
19400: foreach (split('&&&',$resparm)) {
19401: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19402: if ($thisname eq $name) {
19403: $value=$thisvalue;
19404: $ptype=$thistype;
19405: }
19406: }
19407: return $value;
1.1143 raeburn 19408: }
19409:
1.1101 raeburn 19410: sub symb_to_docspath {
1.1267 raeburn 19411: my ($symb,$navmapref) = @_;
19412: return unless ($symb && ref($navmapref));
1.1101 raeburn 19413: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19414: if ($resurl=~/\.(sequence|page)$/) {
19415: $mapurl=$resurl;
19416: } elsif ($resurl eq 'adm/navmaps') {
19417: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19418: }
19419: my $mapresobj;
1.1267 raeburn 19420: unless (ref($$navmapref)) {
19421: $$navmapref = Apache::lonnavmaps::navmap->new();
19422: }
19423: if (ref($$navmapref)) {
19424: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19425: }
19426: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19427: my $type=$2;
19428: my $path;
19429: if (ref($mapresobj)) {
19430: my $pcslist = $mapresobj->map_hierarchy();
19431: if ($pcslist ne '') {
19432: foreach my $pc (split(/,/,$pcslist)) {
19433: next if ($pc <= 1);
1.1267 raeburn 19434: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19435: if (ref($res)) {
19436: my $thisurl = $res->src();
19437: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19438: my $thistitle = $res->title();
19439: $path .= '&'.
19440: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19441: &escape($thistitle).
1.1101 raeburn 19442: ':'.$res->randompick().
19443: ':'.$res->randomout().
19444: ':'.$res->encrypted().
19445: ':'.$res->randomorder().
19446: ':'.$res->is_page();
19447: }
19448: }
19449: }
19450: $path =~ s/^\&//;
19451: my $maptitle = $mapresobj->title();
19452: if ($mapurl eq 'default') {
1.1129 raeburn 19453: $maptitle = 'Main Content';
1.1101 raeburn 19454: }
19455: $path .= (($path ne '')? '&' : '').
19456: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19457: &escape($maptitle).
1.1101 raeburn 19458: ':'.$mapresobj->randompick().
19459: ':'.$mapresobj->randomout().
19460: ':'.$mapresobj->encrypted().
19461: ':'.$mapresobj->randomorder().
19462: ':'.$mapresobj->is_page();
19463: } else {
19464: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19465: my $ispage = (($type eq 'page')? 1 : '');
19466: if ($mapurl eq 'default') {
1.1129 raeburn 19467: $maptitle = 'Main Content';
1.1101 raeburn 19468: }
19469: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19470: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19471: }
19472: unless ($mapurl eq 'default') {
19473: $path = 'default&'.
1.1146 raeburn 19474: &escape('Main Content').
1.1101 raeburn 19475: ':::::&'.$path;
19476: }
19477: return $path;
19478: }
19479:
1.1393 raeburn 19480: sub validate_folderpath {
19481: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19482: if ($env{'form.folderpath'} ne '') {
19483: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19484: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19485: for (my $i=0; $i<@items; $i++) {
19486: my $odd = $i%2;
19487: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19488: $badpath = 1;
1.1394 raeburn 19489: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19490: my $idx = $i-1;
1.1394 raeburn 19491: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19492: my $esc_name = $1;
19493: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19494: $supppath .= '&'.$esc_name;
19495: $changed = 1;
19496: } else {
19497: $supppath .= '&'.$items[$i];
19498: }
19499: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19500: $changed = 1;
1.1393 raeburn 19501: my $is_hidden;
19502: unless ($got_supp) {
1.1395 raeburn 19503: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19504: if (ref($supplemental) eq 'HASH') {
19505: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19506: %supphidden = %{$supplemental->{'hidden'}};
19507: }
19508: if (ref($supplemental->{'ids'}) eq 'HASH') {
19509: %suppids = %{$supplemental->{'ids'}};
19510: }
19511: }
19512: $got_supp = 1;
19513: }
19514: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19515: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19516: if ($supphidden{$mapid}) {
19517: $is_hidden = 1;
19518: }
19519: }
1.1394 raeburn 19520: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19521: } else {
19522: $supppath .= '&'.$items[$i];
1.1393 raeburn 19523: }
19524: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19525: $badpath = 1;
1.1394 raeburn 19526: } elsif ($supplementalflag) {
1.1393 raeburn 19527: $supppath .= '&'.$items[$i];
19528: }
19529: last if ($badpath);
19530: }
19531: if ($badpath) {
19532: delete($env{'form.folderpath'});
1.1394 raeburn 19533: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19534: $supppath =~ s/^\&//;
19535: $env{'form.folderpath'} = $supppath;
19536: }
19537: }
19538: return;
19539: }
19540:
1.1094 raeburn 19541: sub captcha_display {
1.1327 raeburn 19542: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19543: my ($output,$error);
1.1234 raeburn 19544: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19545: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19546: if ($captcha eq 'original') {
1.1094 raeburn 19547: $output = &create_captcha();
19548: unless ($output) {
1.1172 raeburn 19549: $error = 'captcha';
1.1094 raeburn 19550: }
19551: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19552: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19553: unless ($output) {
1.1172 raeburn 19554: $error = 'recaptcha';
1.1094 raeburn 19555: }
19556: }
1.1234 raeburn 19557: return ($output,$error,$captcha,$version);
1.1094 raeburn 19558: }
19559:
19560: sub captcha_response {
1.1327 raeburn 19561: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19562: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19563: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19564: if ($captcha eq 'original') {
1.1094 raeburn 19565: ($captcha_chk,$captcha_error) = &check_captcha();
19566: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19567: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19568: } else {
19569: $captcha_chk = 1;
19570: }
19571: return ($captcha_chk,$captcha_error);
19572: }
19573:
19574: sub get_captcha_config {
1.1327 raeburn 19575: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19576: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19577: my $hostname = &Apache::lonnet::hostname($lonhost);
19578: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19579: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19580: if ($context eq 'usercreation') {
19581: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19582: if (ref($domconfig{$context}) eq 'HASH') {
19583: $hashtocheck = $domconfig{$context}{'cancreate'};
19584: if (ref($hashtocheck) eq 'HASH') {
19585: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19586: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19587: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19588: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19589: }
19590: if ($privkey && $pubkey) {
19591: $captcha = 'recaptcha';
1.1234 raeburn 19592: $version = $hashtocheck->{'recaptchaversion'};
19593: if ($version ne '2') {
19594: $version = 1;
19595: }
1.1095 raeburn 19596: } else {
19597: $captcha = 'original';
19598: }
19599: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19600: $captcha = 'original';
19601: }
1.1094 raeburn 19602: }
1.1095 raeburn 19603: } else {
19604: $captcha = 'captcha';
19605: }
19606: } elsif ($context eq 'login') {
19607: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19608: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19609: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19610: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19611: if ($privkey && $pubkey) {
19612: $captcha = 'recaptcha';
1.1234 raeburn 19613: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19614: if ($version ne '2') {
19615: $version = 1;
19616: }
1.1095 raeburn 19617: } else {
19618: $captcha = 'original';
1.1094 raeburn 19619: }
1.1095 raeburn 19620: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19621: $captcha = 'original';
1.1094 raeburn 19622: }
1.1327 raeburn 19623: } elsif ($context eq 'passwords') {
19624: if ($dom_in_effect) {
19625: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19626: if ($passwdconf{'captcha'} eq 'recaptcha') {
19627: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19628: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19629: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19630: }
19631: if ($privkey && $pubkey) {
19632: $captcha = 'recaptcha';
19633: $version = $passwdconf{'recaptchaversion'};
19634: if ($version ne '2') {
19635: $version = 1;
19636: }
19637: } else {
19638: $captcha = 'original';
19639: }
19640: } elsif ($passwdconf{'captcha'} ne 'notused') {
19641: $captcha = 'original';
19642: }
19643: }
19644: }
1.1234 raeburn 19645: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19646: }
19647:
19648: sub create_captcha {
19649: my %captcha_params = &captcha_settings();
19650: my ($output,$maxtries,$tries) = ('',10,0);
19651: while ($tries < $maxtries) {
19652: $tries ++;
19653: my $captcha = Authen::Captcha->new (
19654: output_folder => $captcha_params{'output_dir'},
19655: data_folder => $captcha_params{'db_dir'},
19656: );
19657: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19658:
19659: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19660: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19661: '<span class="LC_nobreak">'.
1.1453 raeburn 19662: '<label>'.&mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19663: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1453 raeburn 19664: '</label></span><br />'.
1.1176 raeburn 19665: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19666: last;
19667: }
19668: }
1.1323 raeburn 19669: if ($output eq '') {
19670: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19671: }
1.1094 raeburn 19672: return $output;
19673: }
19674:
19675: sub captcha_settings {
19676: my %captcha_params = (
19677: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19678: www_output_dir => "/captchaspool",
19679: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19680: numchars => '5',
19681: );
19682: return %captcha_params;
19683: }
19684:
19685: sub check_captcha {
19686: my ($captcha_chk,$captcha_error);
19687: my $code = $env{'form.code'};
19688: my $md5sum = $env{'form.crypt'};
19689: my %captcha_params = &captcha_settings();
19690: my $captcha = Authen::Captcha->new(
19691: output_folder => $captcha_params{'output_dir'},
19692: data_folder => $captcha_params{'db_dir'},
19693: );
1.1109 raeburn 19694: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19695: my %captcha_hash = (
19696: 0 => 'Code not checked (file error)',
19697: -1 => 'Failed: code expired',
19698: -2 => 'Failed: invalid code (not in database)',
19699: -3 => 'Failed: invalid code (code does not match crypt)',
19700: );
19701: if ($captcha_chk != 1) {
19702: $captcha_error = $captcha_hash{$captcha_chk}
19703: }
19704: return ($captcha_chk,$captcha_error);
19705: }
19706:
19707: sub create_recaptcha {
1.1234 raeburn 19708: my ($pubkey,$version) = @_;
19709: if ($version >= 2) {
1.1367 raeburn 19710: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19711: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19712: } else {
19713: my $use_ssl;
19714: if ($ENV{'SERVER_PORT'} == 443) {
19715: $use_ssl = 1;
19716: }
19717: my $captcha = Captcha::reCAPTCHA->new;
19718: return $captcha->get_options_setter({theme => 'white'})."\n".
19719: $captcha->get_html($pubkey,undef,$use_ssl).
19720: &mt('If the text is hard to read, [_1] will replace them.',
19721: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19722: '<br /><br />';
19723: }
1.1094 raeburn 19724: }
19725:
19726: sub check_recaptcha {
1.1234 raeburn 19727: my ($privkey,$version) = @_;
1.1094 raeburn 19728: my $captcha_chk;
1.1350 raeburn 19729: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19730: if ($version >= 2) {
19731: my %info = (
19732: secret => $privkey,
19733: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19734: remoteip => $ip,
1.1234 raeburn 19735: );
1.1280 raeburn 19736: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19737: $request->content(join('&',map {
19738: my $name = escape($_);
19739: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19740: ? join("&$name=", map {escape($_) } @{$info{$_}})
19741: : &escape($info{$_}) );
19742: } keys(%info)));
19743: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19744: if ($response->is_success) {
19745: my $data = JSON::DWIW->from_json($response->decoded_content);
19746: if (ref($data) eq 'HASH') {
19747: if ($data->{'success'}) {
19748: $captcha_chk = 1;
19749: }
19750: }
19751: }
19752: } else {
19753: my $captcha = Captcha::reCAPTCHA->new;
19754: my $captcha_result =
19755: $captcha->check_answer(
19756: $privkey,
1.1350 raeburn 19757: $ip,
1.1234 raeburn 19758: $env{'form.recaptcha_challenge_field'},
19759: $env{'form.recaptcha_response_field'},
19760: );
19761: if ($captcha_result->{is_valid}) {
19762: $captcha_chk = 1;
19763: }
1.1094 raeburn 19764: }
19765: return $captcha_chk;
19766: }
19767:
1.1174 raeburn 19768: sub emailusername_info {
1.1244 raeburn 19769: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19770: my %titles = &Apache::lonlocal::texthash (
19771: lastname => 'Last Name',
19772: firstname => 'First Name',
19773: institution => 'School/college/university',
19774: location => "School's city, state/province, country",
19775: web => "School's web address",
19776: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19777: id => 'Student/Employee ID',
1.1174 raeburn 19778: );
19779: return (\@fields,\%titles);
19780: }
19781:
1.1161 raeburn 19782: sub cleanup_html {
19783: my ($incoming) = @_;
19784: my $outgoing;
19785: if ($incoming ne '') {
19786: $outgoing = $incoming;
19787: $outgoing =~ s/;/;/g;
19788: $outgoing =~ s/\#/#/g;
19789: $outgoing =~ s/\&/&/g;
19790: $outgoing =~ s/</</g;
19791: $outgoing =~ s/>/>/g;
19792: $outgoing =~ s/\(/(/g;
19793: $outgoing =~ s/\)/)/g;
19794: $outgoing =~ s/"/"/g;
19795: $outgoing =~ s/'/'/g;
19796: $outgoing =~ s/\$/$/g;
19797: $outgoing =~ s{/}{/}g;
19798: $outgoing =~ s/=/=/g;
19799: $outgoing =~ s/\\/\/g
19800: }
19801: return $outgoing;
19802: }
19803:
1.1190 musolffc 19804: # Checks for critical messages and returns a redirect url if one exists.
19805: # $interval indicates how often to check for messages.
1.1282 raeburn 19806: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19807: sub critical_redirect {
1.1282 raeburn 19808: my ($interval,$context) = @_;
1.1356 raeburn 19809: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19810: return ();
19811: }
1.1190 musolffc 19812: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19813: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19814: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19815: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19816: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19817: if ($blocked) {
19818: my $checkrole = "cm./$cdom/$cnum";
19819: if ($env{'request.course.sec'} ne '') {
19820: $checkrole .= "/$env{'request.course.sec'}";
19821: }
19822: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19823: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19824: return;
19825: }
19826: }
19827: }
1.1190 musolffc 19828: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19829: $env{'user.name'});
19830: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19831: my $redirecturl;
1.1190 musolffc 19832: if ($what[0]) {
1.1356 raeburn 19833: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19834: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19835: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19836: return (1, $url);
1.1190 musolffc 19837: }
1.1191 raeburn 19838: }
19839: }
19840: return ();
1.1190 musolffc 19841: }
19842:
1.1174 raeburn 19843: # Use:
19844: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19845: #
19846: ##################################################
19847: # password associated functions #
19848: ##################################################
19849: sub des_keys {
19850: # Make a new key for DES encryption.
19851: # Each key has two parts which are returned separately.
19852: # Please note: Each key must be passed through the &hex function
19853: # before it is output to the web browser. The hex versions cannot
19854: # be used to decrypt.
19855: my @hexstr=('0','1','2','3','4','5','6','7',
19856: '8','9','a','b','c','d','e','f');
19857: my $lkey='';
19858: for (0..7) {
19859: $lkey.=$hexstr[rand(15)];
19860: }
19861: my $ukey='';
19862: for (0..7) {
19863: $ukey.=$hexstr[rand(15)];
19864: }
19865: return ($lkey,$ukey);
19866: }
19867:
19868: sub des_decrypt {
19869: my ($key,$cyphertext) = @_;
19870: my $keybin=pack("H16",$key);
19871: my $cypher;
19872: if ($Crypt::DES::VERSION>=2.03) {
19873: $cypher=new Crypt::DES $keybin;
19874: } else {
19875: $cypher=new DES $keybin;
19876: }
1.1233 raeburn 19877: my $plaintext='';
19878: my $cypherlength = length($cyphertext);
19879: my $numchunks = int($cypherlength/32);
19880: for (my $j=0; $j<$numchunks; $j++) {
19881: my $start = $j*32;
19882: my $cypherblock = substr($cyphertext,$start,32);
19883: my $chunk =
19884: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19885: $chunk .=
19886: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19887: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19888: $plaintext .= $chunk;
19889: }
1.1174 raeburn 19890: return $plaintext;
19891: }
19892:
1.1344 raeburn 19893: sub get_requested_shorturls {
1.1309 raeburn 19894: my ($cdom,$cnum,$navmap) = @_;
19895: return unless (ref($navmap));
1.1344 raeburn 19896: my ($numnew,$errors);
1.1309 raeburn 19897: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19898: if (@toshorten) {
19899: my (%maps,%resources,%titles);
19900: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19901: 'shorturls',$cdom,$cnum);
19902: if (keys(%resources)) {
1.1344 raeburn 19903: my %tocreate;
1.1309 raeburn 19904: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19905: my $symb = $resources{$item};
19906: if ($symb) {
19907: $tocreate{$cnum.'&'.$symb} = 1;
19908: }
19909: }
1.1344 raeburn 19910: if (keys(%tocreate)) {
19911: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19912: \%tocreate);
19913: }
1.1309 raeburn 19914: }
1.1344 raeburn 19915: }
19916: return ($numnew,$errors);
19917: }
19918:
19919: sub make_short_symbs {
19920: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19921: my ($numnew,@errors);
19922: if (ref($tocreateref) eq 'HASH') {
19923: my %tocreate = %{$tocreateref};
1.1309 raeburn 19924: if (keys(%tocreate)) {
19925: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19926: my $su = Short::URL->new(no_vowels => 1);
19927: my $init = '';
19928: my (%newunique,%addcourse,%courseonly,%failed);
19929: # get lock on tiny db
19930: my $now = time;
1.1344 raeburn 19931: if ($lockuser eq '') {
19932: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19933: }
1.1309 raeburn 19934: my $lockhash = {
1.1344 raeburn 19935: "lock\0$now" => $lockuser,
1.1309 raeburn 19936: };
19937: my $tries = 0;
19938: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19939: my ($code,$error);
19940: while (($gotlock ne 'ok') && ($tries<3)) {
19941: $tries ++;
19942: sleep 1;
1.1319 raeburn 19943: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19944: }
19945: if ($gotlock eq 'ok') {
19946: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19947: \%addcourse,\%courseonly,\%failed);
19948: if (keys(%failed)) {
19949: my $numfailed = scalar(keys(%failed));
19950: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19951: }
19952: if (keys(%newunique)) {
19953: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19954: if ($putres eq 'ok') {
19955: $numnew = scalar(keys(%newunique));
19956: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19957: unless ($newputres eq 'ok') {
19958: push(@errors,&mt('error: could not store course look-up of short URLs'));
19959: }
19960: } else {
19961: push(@errors,&mt('error: could not store unique six character URLs'));
19962: }
19963: }
19964: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19965: unless ($dellockres eq 'ok') {
19966: push(@errors,&mt('error: could not release lockfile'));
19967: }
19968: } else {
19969: push(@errors,&mt('error: could not obtain lockfile'));
19970: }
19971: if (keys(%courseonly)) {
19972: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19973: if ($result ne 'ok') {
19974: push(@errors,&mt('error: could not update course look-up of short URLs'));
19975: }
19976: }
19977: }
19978: }
19979: return ($numnew,\@errors);
19980: }
19981:
19982: sub shorten_symbs {
19983: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19984: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19985: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19986: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19987: my (%possibles,%collisions);
19988: foreach my $key (keys(%{$tocreate})) {
19989: my $num = String::CRC32::crc32($key);
19990: my $tiny = $su->encode($num,$init);
19991: if ($tiny) {
19992: $possibles{$tiny} = $key;
19993: }
19994: }
19995: if (!$init) {
19996: $init = 1;
19997: } else {
19998: $init ++;
19999: }
20000: if (keys(%possibles)) {
20001: my @posstiny = keys(%possibles);
20002: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
20003: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
20004: if (keys(%currtiny)) {
20005: foreach my $key (keys(%currtiny)) {
20006: next if ($currtiny{$key} eq '');
20007: if ($currtiny{$key} eq $possibles{$key}) {
20008: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
20009: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
20010: $courseonly->{$tsymb} = $key;
20011: }
20012: } else {
20013: $collisions{$possibles{$key}} = 1;
20014: }
20015: delete($possibles{$key});
20016: }
20017: }
20018: foreach my $key (keys(%possibles)) {
20019: $newunique->{$key} = $possibles{$key};
20020: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
20021: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
20022: $addcourse->{$tsymb} = $key;
20023: }
20024: }
20025: }
20026: if (keys(%collisions)) {
20027: if ($init <5) {
20028: if (!$init) {
20029: $init = 1;
20030: } else {
20031: $init ++;
20032: }
20033: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
20034: $newunique,$addcourse,$courseonly,$failed);
20035: } else {
20036: foreach my $key (keys(%collisions)) {
20037: $failed->{$key} = 1;
20038: }
20039: }
20040: }
20041: return $init;
20042: }
20043:
1.1328 raeburn 20044: sub is_nonframeable {
1.1329 raeburn 20045: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
20046: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 20047: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 20048:
20049: $remprotocol = lc($remprotocol);
20050: $remhost = lc($remhost);
20051: my $remport = 80;
20052: if ($remprotocol eq 'https') {
20053: $remport = 443;
20054: }
1.1330 raeburn 20055: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 20056: if ($cached) {
20057: unless ($nocache) {
20058: if ($result) {
20059: return 1;
20060: } else {
20061: return 0;
20062: }
20063: }
20064: }
1.1328 raeburn 20065: my $uselink;
20066: my $request = new HTTP::Request('HEAD',$url);
20067: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
20068: if ($response->is_success()) {
20069: my $secpolicy = lc($response->header('content-security-policy'));
20070: my $xframeop = lc($response->header('x-frame-options'));
20071: $secpolicy =~ s/^\s+|\s+$//g;
20072: $xframeop =~ s/^\s+|\s+$//g;
20073: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 20074: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 20075: my ($origin,$protocol,$port);
20076: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
20077: $port = $ENV{'SERVER_PORT'};
20078: } else {
20079: $port = 80;
20080: }
20081: if ($absolute eq '') {
20082: $protocol = 'http:';
20083: if ($port == 443) {
20084: $protocol = 'https:';
20085: }
20086: $origin = $protocol.'//'.lc($hostname);
20087: } else {
20088: $origin = lc($absolute);
20089: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
20090: }
20091: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
20092: my $framepolicy = $1;
20093: $framepolicy =~ s/^\s+|\s+$//g;
20094: my @policies = split(/\s+/,$framepolicy);
20095: if (@policies) {
20096: if (grep(/^\Q'none'\E$/,@policies)) {
20097: $uselink = 1;
20098: } else {
20099: $uselink = 1;
20100: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
20101: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
20102: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
20103: undef($uselink);
20104: }
20105: if ($uselink) {
20106: if (grep(/^\Q'self'\E$/,@policies)) {
20107: if (($origin ne '') && ($remotehost eq $origin)) {
20108: undef($uselink);
20109: }
20110: }
20111: }
20112: if ($uselink) {
20113: my @possok;
20114: if ($ip ne '') {
20115: push(@possok,$ip);
20116: }
20117: my $hoststr = '';
20118: foreach my $part (reverse(split(/\./,$hostname))) {
20119: if ($hoststr eq '') {
20120: $hoststr = $part;
20121: } else {
20122: $hoststr = "$part.$hoststr";
20123: }
20124: if ($hoststr eq $hostname) {
20125: push(@possok,$hostname);
20126: } else {
20127: push(@possok,"*.$hoststr");
20128: }
20129: }
20130: if (@possok) {
20131: foreach my $poss (@possok) {
20132: last if (!$uselink);
20133: foreach my $policy (@policies) {
20134: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
20135: undef($uselink);
20136: last;
20137: }
20138: }
20139: }
20140: }
20141: }
20142: }
20143: }
20144: } elsif ($xframeop ne '') {
20145: $uselink = 1;
20146: my @policies = split(/\s*,\s*/,$xframeop);
20147: if (@policies) {
20148: unless (grep(/^deny$/,@policies)) {
20149: if ($origin ne '') {
20150: if (grep(/^sameorigin$/,@policies)) {
20151: if ($remotehost eq $origin) {
20152: undef($uselink);
20153: }
20154: }
20155: if ($uselink) {
20156: foreach my $policy (@policies) {
20157: if ($policy =~ /^allow-from\s*(.+)$/) {
20158: my $allowfrom = $1;
20159: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
20160: undef($uselink);
20161: last;
20162: }
20163: }
20164: }
20165: }
20166: }
20167: }
20168: }
20169: }
20170: }
20171: }
1.1329 raeburn 20172: if ($nocache) {
20173: if ($cached) {
20174: my $devalidate;
20175: if ($uselink && !$result) {
20176: $devalidate = 1;
20177: } elsif (!$uselink && $result) {
20178: $devalidate = 1;
20179: }
20180: if ($devalidate) {
20181: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20182: }
20183: }
20184: } else {
20185: if ($uselink) {
20186: $result = 1;
20187: } else {
20188: $result = 0;
20189: }
20190: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20191: }
1.1328 raeburn 20192: return $uselink;
20193: }
20194:
1.1359 raeburn 20195: sub page_menu {
20196: my ($menucolls,$menunum) = @_;
20197: my %menu;
20198: foreach my $item (split(/;/,$menucolls)) {
20199: my ($num,$value) = split(/\%/,$item);
20200: if ($num eq $menunum) {
20201: my @entries = split(/\&/,$value);
20202: foreach my $entry (@entries) {
20203: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20204: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20205: $menu{$name} = $fields;
20206: } else {
20207: my @shown;
20208: if ($fields =~ /,/) {
20209: @shown = split(/,/,$fields);
20210: } else {
20211: @shown = ($fields);
20212: }
20213: if (@shown) {
20214: foreach my $field (@shown) {
20215: next if ($field eq '');
20216: $menu{$field} = 1;
20217: }
20218: }
20219: }
20220: }
20221: }
20222: }
20223: return %menu;
20224: }
20225:
1.112 bowersj2 20226: 1;
20227: __END__;
1.41 ng 20228:
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