Annotation of loncom/interface/loncommon.pm, revision 1.1431
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.1431 ! raeburn 4: # $Id: loncommon.pm,v 1.1430 2024/04/14 18:45:57 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.1383 raeburn 64: use Apache::lonnavmaps();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.1108 raeburn 70: use Apache::lonuserutils();
1.1110 raeburn 71: use Apache::lonuserstate();
1.1182 raeburn 72: use Apache::courseclassifier();
1.479 albertel 73: use LONCAPA qw(:DEFAULT :match);
1.1409 raeburn 74: use LONCAPA::ltiutils;
1.1280 raeburn 75: use LONCAPA::LWPReq;
1.1395 raeburn 76: use LONCAPA::map();
1.1328 raeburn 77: use HTTP::Request;
1.657 raeburn 78: use DateTime::TimeZone;
1.1241 raeburn 79: use DateTime::Locale;
1.1220 raeburn 80: use Encode();
1.1091 foxr 81: use Text::Aspell;
1.1094 raeburn 82: use Authen::Captcha;
83: use Captcha::reCAPTCHA;
1.1234 raeburn 84: use JSON::DWIW;
1.1174 raeburn 85: use Crypt::DES;
86: use DynaLoader; # for Crypt::DES version
1.1223 musolffc 87: use MIME::Lite;
88: use MIME::Types;
1.1292 raeburn 89: use File::Copy();
1.1300 raeburn 90: use File::Path();
1.1309 raeburn 91: use String::CRC32();
92: use Short::URL();
1.117 www 93:
1.517 raeburn 94: # ---------------------------------------------- Designs
95: use vars qw(%defaultdesign);
96:
1.22 www 97: my $readit;
98:
1.517 raeburn 99:
1.157 matthew 100: ##
101: ## Global Variables
102: ##
1.46 matthew 103:
1.643 foxr 104:
105: # ----------------------------------------------- SSI with retries:
106: #
107:
108: =pod
109:
1.648 raeburn 110: =head1 Server Side include with retries:
1.643 foxr 111:
112: =over 4
113:
1.648 raeburn 114: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 115:
116: Performs an ssi with some number of retries. Retries continue either
117: until the result is ok or until the retry count supplied by the
118: caller is exhausted.
119:
120: Inputs:
1.648 raeburn 121:
122: =over 4
123:
1.643 foxr 124: resource - Identifies the resource to insert.
1.648 raeburn 125:
1.643 foxr 126: retries - Count of the number of retries allowed.
1.648 raeburn 127:
1.643 foxr 128: form - Hash that identifies the rendering options.
129:
1.648 raeburn 130: =back
131:
132: Returns:
133:
134: =over 4
135:
1.643 foxr 136: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 137:
1.643 foxr 138: response - The response from the last attempt (which may or may not have been successful.
139:
1.648 raeburn 140: =back
141:
142: =back
143:
1.643 foxr 144: =cut
145:
146: sub ssi_with_retries {
147: my ($resource, $retries, %form) = @_;
148:
149:
150: my $ok = 0; # True if we got a good response.
151: my $content;
152: my $response;
153:
154: # Try to get the ssi done. within the retries count:
155:
156: do {
157: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
158: $ok = $response->is_success;
1.650 www 159: if (!$ok) {
160: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
161: }
1.643 foxr 162: $retries--;
163: } while (!$ok && ($retries > 0));
164:
165: if (!$ok) {
166: $content = ''; # On error return an empty content.
167: }
168: return ($content, $response);
169:
170: }
171:
172:
173:
1.20 www 174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 175: my %language;
1.124 www 176: my %supported_language;
1.1088 foxr 177: my %supported_codes;
1.1048 foxr 178: my %latex_language; # For choosing hyphenation in <transl..>
179: my %latex_language_bykey; # for choosing hyphenation from metadata
1.12 harris41 180: my %cprtag;
1.192 taceyjo1 181: my %scprtag;
1.351 www 182: my %fe; my %fd; my %fm;
1.41 ng 183: my %category_extensions;
1.12 harris41 184:
1.46 matthew 185: # ---------------------------------------------- Thesaurus variables
1.144 matthew 186: #
187: # %Keywords:
188: # A hash used by &keyword to determine if a word is considered a keyword.
189: # $thesaurus_db_file
190: # Scalar containing the full path to the thesaurus database.
1.46 matthew 191:
192: my %Keywords;
193: my $thesaurus_db_file;
194:
1.144 matthew 195: #
196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
197: # thesaurus.tab, and filecategories.tab.
198: #
1.18 www 199: BEGIN {
1.46 matthew 200: # Variable initialization
201: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
202: #
1.22 www 203: unless ($readit) {
1.12 harris41 204: # ------------------------------------------------------------------- languages
205: {
1.158 raeburn 206: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
207: '/language.tab';
1.1317 raeburn 208: if ( open(my $fh,'<',$langtabfile) ) {
1.356 albertel 209: while (my $line = <$fh>) {
210: next if ($line=~/^\#/);
211: chomp($line);
1.1088 foxr 212: my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158 raeburn 213: $language{$key}=$val.' - '.$enc;
214: if ($sup) {
215: $supported_language{$key}=$sup;
1.1088 foxr 216: $supported_codes{$key} = $code;
1.158 raeburn 217: }
1.1048 foxr 218: if ($latex) {
219: $latex_language_bykey{$key} = $latex;
1.1088 foxr 220: $latex_language{$code} = $latex;
1.1048 foxr 221: }
1.158 raeburn 222: }
223: close($fh);
224: }
1.12 harris41 225: }
226: # ------------------------------------------------------------------ copyrights
227: {
1.158 raeburn 228: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
229: '/copyright.tab';
1.1317 raeburn 230: if ( open (my $fh,'<',$copyrightfile) ) {
1.356 albertel 231: while (my $line = <$fh>) {
232: next if ($line=~/^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 235: $cprtag{$key}=$val;
236: }
237: close($fh);
238: }
1.12 harris41 239: }
1.351 www 240: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 241: {
242: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
243: '/source_copyright.tab';
1.1317 raeburn 244: if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 249: $scprtag{$key}=$val;
250: }
251: close($fh);
252: }
253: }
1.63 www 254:
1.517 raeburn 255: # -------------------------------------------------------------- default domain designs
1.63 www 256: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 257: my $designfile = $designdir.'/default.tab';
1.1317 raeburn 258: if ( open (my $fh,'<',$designfile) ) {
1.517 raeburn 259: while (my $line = <$fh>) {
260: next if ($line =~ /^\#/);
261: chomp($line);
262: my ($key,$val)=(split(/\=/,$line));
263: if ($val) { $defaultdesign{$key}=$val; }
264: }
265: close($fh);
1.63 www 266: }
267:
1.15 harris41 268: # ------------------------------------------------------------- file categories
269: {
1.158 raeburn 270: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
271: '/filecategories.tab';
1.1317 raeburn 272: if ( open (my $fh,'<',$categoryfile) ) {
1.356 albertel 273: while (my $line = <$fh>) {
274: next if ($line =~ /^\#/);
275: chomp($line);
276: my ($extension,$category)=(split(/\s+/,$line,2));
1.1263 raeburn 277: push(@{$category_extensions{lc($category)}},$extension);
1.158 raeburn 278: }
279: close($fh);
280: }
281:
1.15 harris41 282: }
1.12 harris41 283: # ------------------------------------------------------------------ file types
284: {
1.158 raeburn 285: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
286: '/filetypes.tab';
1.1317 raeburn 287: if ( open (my $fh,'<',$typesfile) ) {
1.356 albertel 288: while (my $line = <$fh>) {
289: next if ($line =~ /^\#/);
290: chomp($line);
291: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 292: if ($descr ne '') {
293: $fe{$ending}=lc($emb);
294: $fd{$ending}=$descr;
1.351 www 295: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 296: }
297: }
298: close($fh);
299: }
1.12 harris41 300: }
1.22 www 301: &Apache::lonnet::logthis(
1.705 tempelho 302: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 303: $readit=1;
1.46 matthew 304: } # end of unless($readit)
1.32 matthew 305:
306: }
1.112 bowersj2 307:
1.42 matthew 308: ###############################################################
309: ## HTML and Javascript Helper Functions ##
310: ###############################################################
311:
312: =pod
313:
1.112 bowersj2 314: =head1 HTML and Javascript Functions
1.42 matthew 315:
1.112 bowersj2 316: =over 4
317:
1.648 raeburn 318: =item * &browser_and_searcher_javascript()
1.112 bowersj2 319:
320: X<browsing, javascript>X<searching, javascript>Returns a string
321: containing javascript with two functions, C<openbrowser> and
322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
323: tags.
1.42 matthew 324:
1.648 raeburn 325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 326:
327: inputs: formname, elementname, only, omit
328:
329: formname and elementname indicate the name of the html form and name of
330: the element that the results of the browsing selection are to be placed in.
331:
332: Specifying 'only' will restrict the browser to displaying only files
1.185 www 333: with the given extension. Can be a comma separated list.
1.42 matthew 334:
335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 336: with the given extension. Can be a comma separated list.
1.42 matthew 337:
1.648 raeburn 338: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 339:
340: Inputs: formname, elementname
341:
342: formname and elementname specify the name of the html form and the name
343: of the element the selection from the search results will be placed in.
1.542 raeburn 344:
1.42 matthew 345: =cut
346:
347: sub browser_and_searcher_javascript {
1.199 albertel 348: my ($mode)=@_;
349: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 350: my $resurl=&escape_single(&lastresurl());
1.42 matthew 351: return <<END;
1.219 albertel 352: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 353: var editbrowser = null;
1.135 albertel 354: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 355: var url = '$resurl/?';
1.42 matthew 356: if (editbrowser == null) {
357: url += 'launch=1&';
358: }
359: url += 'catalogmode=interactive&';
1.199 albertel 360: url += 'mode=$mode&';
1.611 albertel 361: url += 'inhibitmenu=yes&';
1.42 matthew 362: url += 'form=' + formname + '&';
363: if (only != null) {
364: url += 'only=' + only + '&';
1.217 albertel 365: } else {
366: url += 'only=&';
367: }
1.42 matthew 368: if (omit != null) {
369: url += 'omit=' + omit + '&';
1.217 albertel 370: } else {
371: url += 'omit=&';
372: }
1.135 albertel 373: if (titleelement != null) {
374: url += 'titleelement=' + titleelement + '&';
1.217 albertel 375: } else {
376: url += 'titleelement=&';
377: }
1.42 matthew 378: url += 'element=' + elementname + '';
379: var title = 'Browser';
1.435 albertel 380: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 381: options += ',width=700,height=600';
382: editbrowser = open(url,title,options,'1');
383: editbrowser.focus();
384: }
385: var editsearcher;
1.135 albertel 386: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 387: var url = '/adm/searchcat?';
388: if (editsearcher == null) {
389: url += 'launch=1&';
390: }
391: url += 'catalogmode=interactive&';
1.199 albertel 392: url += 'mode=$mode&';
1.42 matthew 393: url += 'form=' + formname + '&';
1.135 albertel 394: if (titleelement != null) {
395: url += 'titleelement=' + titleelement + '&';
1.217 albertel 396: } else {
397: url += 'titleelement=&';
398: }
1.42 matthew 399: url += 'element=' + elementname + '';
400: var title = 'Search';
1.435 albertel 401: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 402: options += ',width=700,height=600';
403: editsearcher = open(url,title,options,'1');
404: editsearcher.focus();
405: }
1.219 albertel 406: // END LON-CAPA Internal -->
1.42 matthew 407: END
1.170 www 408: }
409:
410: sub lastresurl {
1.258 albertel 411: if ($env{'environment.lastresurl'}) {
412: return $env{'environment.lastresurl'}
1.170 www 413: } else {
414: return '/res';
415: }
416: }
417:
418: sub storeresurl {
419: my $resurl=&Apache::lonnet::clutter(shift);
420: unless ($resurl=~/^\/res/) { return 0; }
421: $resurl=~s/\/$//;
422: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 423: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 424: return 1;
1.42 matthew 425: }
426:
1.74 www 427: sub studentbrowser_javascript {
1.111 www 428: unless (
1.258 albertel 429: (($env{'request.course.id'}) &&
1.302 albertel 430: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
431: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
432: '/'.$env{'request.course.sec'})
433: ))
1.258 albertel 434: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 435: ) { return ''; }
1.74 www 436: return (<<'ENDSTDBRW');
1.776 bisitz 437: <script type="text/javascript" language="Javascript">
1.824 bisitz 438: // <![CDATA[
1.74 www 439: var stdeditbrowser;
1.1413 raeburn 440: function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74 www 441: var url = '/adm/pickstudent?';
442: var filter;
1.558 albertel 443: if (!ignorefilter) {
444: eval('filter=document.'+formname+'.'+uname+'.value;');
445: }
1.74 www 446: if (filter != null) {
447: if (filter != '') {
448: url += 'filter='+filter+'&';
449: }
450: }
451: url += 'form=' + formname + '&unameelement='+uname+
1.999 www 452: '&udomelement='+udom+
453: '&clicker='+clicker;
1.111 www 454: if (roleflag) { url+="&roles=1"; }
1.1337 raeburn 455: if (courseadv == 'condition') {
456: if (document.getElementById('courseadv')) {
457: courseadv = document.getElementById('courseadv').value;
458: }
459: }
460: if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413 raeburn 461: if (uident !== '') { url+="&identelement="+uident; }
1.102 www 462: var title = 'Student_Browser';
1.74 www 463: var options = 'scrollbars=1,resizable=1,menubar=0';
464: options += ',width=700,height=600';
465: stdeditbrowser = open(url,title,options,'1');
466: stdeditbrowser.focus();
467: }
1.824 bisitz 468: // ]]>
1.74 www 469: </script>
470: ENDSTDBRW
471: }
1.42 matthew 472:
1.1003 www 473: sub resourcebrowser_javascript {
474: unless ($env{'request.course.id'}) { return ''; }
1.1004 www 475: return (<<'ENDRESBRW');
1.1003 www 476: <script type="text/javascript" language="Javascript">
477: // <![CDATA[
478: var reseditbrowser;
1.1004 www 479: function openresbrowser(formname,reslink) {
1.1005 www 480: var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003 www 481: var title = 'Resource_Browser';
482: var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005 www 483: options += ',width=700,height=500';
1.1004 www 484: reseditbrowser = open(url,title,options,'1');
485: reseditbrowser.focus();
1.1003 www 486: }
487: // ]]>
488: </script>
1.1004 www 489: ENDRESBRW
1.1003 www 490: }
491:
1.74 www 492: sub selectstudent_link {
1.1413 raeburn 493: my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999 www 494: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
495: &Apache::lonhtmlcommon::entity_encode($unameele)."','".
496: &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258 albertel 497: if ($env{'request.course.id'}) {
1.302 albertel 498: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
499: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
500: '/'.$env{'request.course.sec'})) {
1.111 www 501: return '';
502: }
1.999 www 503: $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337 raeburn 504: if ($courseadv eq 'only') {
505: $callargs .= ",'',1,'$courseadv'";
506: } elsif ($courseadv eq 'none') {
507: $callargs .= ",'','','$courseadv'";
508: } elsif ($courseadv eq 'condition') {
509: $callargs .= ",'','','$courseadv'";
1.1413 raeburn 510: } elsif ($identelem ne '') {
511: $callargs .= ",'','',''";
512: }
513: if ($identelem ne '') {
514: $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793 raeburn 515: }
516: return '<span class="LC_nobreak">'.
517: '<a href="javascript:openstdbrowser('.$callargs.');">'.
518: &mt('Select User').'</a></span>';
1.74 www 519: }
1.258 albertel 520: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012 www 521: $callargs .= ",'',1";
1.793 raeburn 522: return '<span class="LC_nobreak">'.
523: '<a href="javascript:openstdbrowser('.$callargs.');">'.
524: &mt('Select User').'</a></span>';
1.111 www 525: }
526: return '';
1.91 www 527: }
528:
1.1004 www 529: sub selectresource_link {
530: my ($form,$reslink,$arg)=@_;
531:
532: my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
533: &Apache::lonhtmlcommon::entity_encode($reslink)."'";
534: unless ($env{'request.course.id'}) { return $arg; }
535: return '<span class="LC_nobreak">'.
536: '<a href="javascript:openresbrowser('.$callargs.');">'.
537: $arg.'</a></span>';
538: }
539:
540:
541:
1.653 raeburn 542: sub authorbrowser_javascript {
543: return <<"ENDAUTHORBRW";
1.776 bisitz 544: <script type="text/javascript" language="JavaScript">
1.824 bisitz 545: // <![CDATA[
1.653 raeburn 546: var stdeditbrowser;
547:
548: function openauthorbrowser(formname,udom) {
549: var url = '/adm/pickauthor?';
550: url += 'form='+formname+'&roledom='+udom;
551: var title = 'Author_Browser';
552: var options = 'scrollbars=1,resizable=1,menubar=0';
553: options += ',width=700,height=600';
554: stdeditbrowser = open(url,title,options,'1');
555: stdeditbrowser.focus();
556: }
557:
1.824 bisitz 558: // ]]>
1.653 raeburn 559: </script>
560: ENDAUTHORBRW
561: }
562:
1.91 www 563: sub coursebrowser_javascript {
1.1116 raeburn 564: my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221 raeburn 565: $credits_element,$instcode) = @_;
1.932 raeburn 566: my $wintitle = 'Course_Browser';
1.931 raeburn 567: if ($crstype eq 'Community') {
1.932 raeburn 568: $wintitle = 'Community_Browser';
1.909 raeburn 569: }
1.876 raeburn 570: my $id_functions = &javascript_index_functions();
571: my $output = '
1.776 bisitz 572: <script type="text/javascript" language="JavaScript">
1.824 bisitz 573: // <![CDATA[
1.468 raeburn 574: var stdeditbrowser;'."\n";
1.876 raeburn 575:
576: $output .= <<"ENDSTDBRW";
1.909 raeburn 577: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91 www 578: var url = '/adm/pickcourse?';
1.895 raeburn 579: var formid = getFormIdByName(formname);
1.876 raeburn 580: var domainfilter = getDomainFromSelectbox(formname,udom);
1.128 albertel 581: if (domainfilter != null) {
582: if (domainfilter != '') {
583: url += 'domainfilter='+domainfilter+'&';
584: }
585: }
1.91 www 586: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 587: '&cdomelement='+udom+
588: '&cnameelement='+desc;
1.468 raeburn 589: if (extra_element !=null && extra_element != '') {
1.594 raeburn 590: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 591: url += '&roleelement='+extra_element;
592: if (domainfilter == null || domainfilter == '') {
593: url += '&domainfilter='+extra_element;
594: }
1.234 raeburn 595: }
1.468 raeburn 596: else {
597: if (formname == 'portform') {
598: url += '&setroles='+extra_element;
1.800 raeburn 599: } else {
600: if (formname == 'rules') {
601: url += '&fixeddom='+extra_element;
602: }
1.468 raeburn 603: }
604: }
1.230 raeburn 605: }
1.909 raeburn 606: if (type != null && type != '') {
607: url += '&type='+type;
608: }
609: if (type_elem != null && type_elem != '') {
610: url += '&typeelement='+type_elem;
611: }
1.872 raeburn 612: if (formname == 'ccrs') {
613: var ownername = document.forms[formid].ccuname.value;
614: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238 raeburn 615: url += '&cloner='+ownername+':'+ownerdom;
616: if (type == 'Course') {
617: url += '&crscode='+document.forms[formid].crscode.value;
618: }
1.1221 raeburn 619: }
620: if (formname == 'requestcrs') {
621: url += '&crsdom=$domainfilter&crscode=$instcode';
1.872 raeburn 622: }
1.293 raeburn 623: if (multflag !=null && multflag != '') {
624: url += '&multiple='+multflag;
625: }
1.909 raeburn 626: var title = '$wintitle';
1.91 www 627: var options = 'scrollbars=1,resizable=1,menubar=0';
628: options += ',width=700,height=600';
629: stdeditbrowser = open(url,title,options,'1');
630: stdeditbrowser.focus();
631: }
1.876 raeburn 632: $id_functions
633: ENDSTDBRW
1.1116 raeburn 634: if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
635: $output .= &setsec_javascript($sec_element,$formname,$role_element,
636: $credits_element);
1.876 raeburn 637: }
638: $output .= '
639: // ]]>
640: </script>';
641: return $output;
642: }
643:
644: sub javascript_index_functions {
645: return <<"ENDJS";
646:
647: function getFormIdByName(formname) {
648: for (var i=0;i<document.forms.length;i++) {
649: if (document.forms[i].name == formname) {
650: return i;
651: }
652: }
653: return -1;
654: }
655:
656: function getIndexByName(formid,item) {
657: for (var i=0;i<document.forms[formid].elements.length;i++) {
658: if (document.forms[formid].elements[i].name == item) {
659: return i;
660: }
661: }
662: return -1;
663: }
1.468 raeburn 664:
1.876 raeburn 665: function getDomainFromSelectbox(formname,udom) {
666: var userdom;
667: var formid = getFormIdByName(formname);
668: if (formid > -1) {
669: var domid = getIndexByName(formid,udom);
670: if (domid > -1) {
671: if (document.forms[formid].elements[domid].type == 'select-one') {
672: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
673: }
674: if (document.forms[formid].elements[domid].type == 'hidden') {
675: userdom=document.forms[formid].elements[domid].value;
1.468 raeburn 676: }
677: }
678: }
1.876 raeburn 679: return userdom;
680: }
681:
682: ENDJS
1.468 raeburn 683:
1.876 raeburn 684: }
685:
1.1017 raeburn 686: sub javascript_array_indexof {
1.1018 raeburn 687: return <<ENDJS;
1.1017 raeburn 688: <script type="text/javascript" language="JavaScript">
689: // <![CDATA[
690:
691: if (!Array.prototype.indexOf) {
692: Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
693: "use strict";
694: if (this === void 0 || this === null) {
695: throw new TypeError();
696: }
697: var t = Object(this);
698: var len = t.length >>> 0;
699: if (len === 0) {
700: return -1;
701: }
702: var n = 0;
703: if (arguments.length > 0) {
704: n = Number(arguments[1]);
1.1088 foxr 705: if (n !== n) { // shortcut for verifying if it is NaN
1.1017 raeburn 706: n = 0;
707: } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
708: n = (n > 0 || -1) * Math.floor(Math.abs(n));
709: }
710: }
711: if (n >= len) {
712: return -1;
713: }
714: var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
715: for (; k < len; k++) {
716: if (k in t && t[k] === searchElement) {
717: return k;
718: }
719: }
720: return -1;
721: }
722: }
723:
724: // ]]>
725: </script>
726:
727: ENDJS
728:
729: }
730:
1.876 raeburn 731: sub userbrowser_javascript {
732: my $id_functions = &javascript_index_functions();
733: return <<"ENDUSERBRW";
734:
1.888 raeburn 735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876 raeburn 736: var url = '/adm/pickuser?';
737: var userdom = getDomainFromSelectbox(formname,udom);
738: if (userdom != null) {
739: if (userdom != '') {
740: url += 'srchdom='+userdom+'&';
741: }
742: }
743: url += 'form=' + formname + '&unameelement='+uname+
744: '&udomelement='+udom+
745: '&ulastelement='+ulast+
746: '&ufirstelement='+ufirst+
747: '&uemailelement='+uemail+
1.881 raeburn 748: '&hideudomelement='+hideudom+
749: '&coursedom='+crsdom;
1.888 raeburn 750: if ((caller != null) && (caller != undefined)) {
751: url += '&caller='+caller;
752: }
1.876 raeburn 753: var title = 'User_Browser';
754: var options = 'scrollbars=1,resizable=1,menubar=0';
755: options += ',width=700,height=600';
756: var stdeditbrowser = open(url,title,options,'1');
757: stdeditbrowser.focus();
758: }
759:
1.888 raeburn 760: function fix_domain (formname,udom,origdom,uname) {
1.876 raeburn 761: var formid = getFormIdByName(formname);
762: if (formid > -1) {
1.888 raeburn 763: var unameid = getIndexByName(formid,uname);
1.876 raeburn 764: var domid = getIndexByName(formid,udom);
765: var hidedomid = getIndexByName(formid,origdom);
766: if (hidedomid > -1) {
767: var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888 raeburn 768: var unameval = document.forms[formid].elements[unameid].value;
769: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
770: if (domid > -1) {
771: var slct = document.forms[formid].elements[domid];
772: if (slct.type == 'select-one') {
773: var i;
774: for (i=0;i<slct.length;i++) {
775: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
776: }
777: }
778: if (slct.type == 'hidden') {
779: slct.value = fixeddom;
1.876 raeburn 780: }
781: }
1.468 raeburn 782: }
783: }
784: }
1.876 raeburn 785: return;
786: }
787:
788: $id_functions
789: ENDUSERBRW
1.468 raeburn 790: }
791:
792: sub setsec_javascript {
1.1116 raeburn 793: my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905 raeburn 794: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
795: $communityrolestr);
796: if ($role_element ne '') {
797: my @allroles = ('st','ta','ep','in','ad');
798: foreach my $crstype ('Course','Community') {
799: if ($crstype eq 'Community') {
800: foreach my $role (@allroles) {
801: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
802: }
803: push(@communityrolenames,&Apache::lonnet::plaintext('co'));
804: } else {
805: foreach my $role (@allroles) {
806: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
807: }
808: push(@courserolenames,&Apache::lonnet::plaintext('cc'));
809: }
810: }
811: $rolestr = '"'.join('","',@allroles).'"';
812: $courserolestr = '"'.join('","',@courserolenames).'"';
813: $communityrolestr = '"'.join('","',@communityrolenames).'"';
814: }
1.468 raeburn 815: my $setsections = qq|
816: function setSect(sectionlist) {
1.629 raeburn 817: var sectionsArray = new Array();
818: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
819: sectionsArray = sectionlist.split(",");
820: }
1.468 raeburn 821: var numSections = sectionsArray.length;
822: document.$formname.$sec_element.length = 0;
823: if (numSections == 0) {
824: document.$formname.$sec_element.multiple=false;
825: document.$formname.$sec_element.size=1;
826: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
827: } else {
828: if (numSections == 1) {
829: document.$formname.$sec_element.multiple=false;
830: document.$formname.$sec_element.size=1;
831: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
832: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
833: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
834: } else {
835: for (var i=0; i<numSections; i++) {
836: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
837: }
838: document.$formname.$sec_element.multiple=true
839: if (numSections < 3) {
840: document.$formname.$sec_element.size=numSections;
841: } else {
842: document.$formname.$sec_element.size=3;
843: }
844: document.$formname.$sec_element.options[0].selected = false
845: }
846: }
1.91 www 847: }
1.905 raeburn 848:
849: function setRole(crstype) {
1.468 raeburn 850: |;
1.905 raeburn 851: if ($role_element eq '') {
852: $setsections .= ' return;
853: }
854: ';
855: } else {
856: $setsections .= qq|
857: var elementLength = document.$formname.$role_element.length;
858: var allroles = Array($rolestr);
859: var courserolenames = Array($courserolestr);
860: var communityrolenames = Array($communityrolestr);
861: if (elementLength != undefined) {
862: if (document.$formname.$role_element.options[5].value == 'cc') {
863: if (crstype == 'Course') {
864: return;
865: } else {
866: allroles[5] = 'co';
867: for (var i=0; i<6; i++) {
868: document.$formname.$role_element.options[i].value = allroles[i];
869: document.$formname.$role_element.options[i].text = communityrolenames[i];
870: }
871: }
872: } else {
873: if (crstype == 'Community') {
874: return;
875: } else {
876: allroles[5] = 'cc';
877: for (var i=0; i<6; i++) {
878: document.$formname.$role_element.options[i].value = allroles[i];
879: document.$formname.$role_element.options[i].text = courserolenames[i];
880: }
881: }
882: }
883: }
884: return;
885: }
886: |;
887: }
1.1116 raeburn 888: if ($credits_element) {
889: $setsections .= qq|
890: function setCredits(defaultcredits) {
891: document.$formname.$credits_element.value = defaultcredits;
892: return;
893: }
894: |;
895: }
1.468 raeburn 896: return $setsections;
897: }
898:
1.91 www 899: sub selectcourse_link {
1.909 raeburn 900: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
901: $typeelement) = @_;
902: my $type = $selecttype;
1.871 raeburn 903: my $linktext = &mt('Select Course');
904: if ($selecttype eq 'Community') {
1.909 raeburn 905: $linktext = &mt('Select Community');
1.1239 raeburn 906: } elsif ($selecttype eq 'Placement') {
907: $linktext = &mt('Select Placement Test');
1.906 raeburn 908: } elsif ($selecttype eq 'Course/Community') {
909: $linktext = &mt('Select Course/Community');
1.909 raeburn 910: $type = '';
1.1019 raeburn 911: } elsif ($selecttype eq 'Select') {
912: $linktext = &mt('Select');
913: $type = '';
1.871 raeburn 914: }
1.787 bisitz 915: return '<span class="LC_nobreak">'
916: ."<a href='"
917: .'javascript:opencrsbrowser("'.$form.'","'.$unameele
918: .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909 raeburn 919: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871 raeburn 920: ."'>".$linktext.'</a>'
1.787 bisitz 921: .'</span>';
1.74 www 922: }
1.42 matthew 923:
1.653 raeburn 924: sub selectauthor_link {
925: my ($form,$udom)=@_;
926: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
927: &mt('Select Author').'</a>';
928: }
929:
1.876 raeburn 930: sub selectuser_link {
1.881 raeburn 931: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888 raeburn 932: $coursedom,$linktext,$caller) = @_;
1.876 raeburn 933: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888 raeburn 934: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881 raeburn 935: ');">'.$linktext.'</a>';
1.876 raeburn 936: }
937:
1.273 raeburn 938: sub check_uncheck_jscript {
939: my $jscript = <<"ENDSCRT";
940: function checkAll(field) {
941: if (field.length > 0) {
942: for (i = 0; i < field.length; i++) {
1.1093 raeburn 943: if (!field[i].disabled) {
944: field[i].checked = true;
945: }
1.273 raeburn 946: }
947: } else {
1.1093 raeburn 948: if (!field.disabled) {
949: field.checked = true;
950: }
1.273 raeburn 951: }
952: }
953:
954: function uncheckAll(field) {
955: if (field.length > 0) {
956: for (i = 0; i < field.length; i++) {
957: field[i].checked = false ;
1.543 albertel 958: }
959: } else {
1.273 raeburn 960: field.checked = false ;
961: }
962: }
963: ENDSCRT
964: return $jscript;
965: }
966:
1.656 www 967: sub select_timezone {
1.1387 raeburn 968: my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
969: my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659 raeburn 970: if ($includeempty) {
971: $output .= '<option value=""';
972: if (($selected eq '') || ($selected eq 'local')) {
973: $output .= ' selected="selected" ';
974: }
975: $output .= '> </option>';
976: }
1.657 raeburn 977: my @timezones = DateTime::TimeZone->all_names;
978: foreach my $tzone (@timezones) {
979: $output.= '<option value="'.$tzone.'"';
980: if ($tzone eq $selected) {
981: $output.=' selected="selected"';
982: }
983: $output.=">$tzone</option>\n";
1.656 www 984: }
985: $output.="</select>";
986: return $output;
987: }
1.273 raeburn 988:
1.687 raeburn 989: sub select_datelocale {
1.1256 raeburn 990: my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
991: my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687 raeburn 992: if ($includeempty) {
993: $output .= '<option value=""';
994: if ($selected eq '') {
995: $output .= ' selected="selected" ';
996: }
997: $output .= '> </option>';
998: }
1.1241 raeburn 999: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 1000: my (@possibles,%locale_names);
1.1241 raeburn 1001: my @locales = DateTime::Locale->ids();
1002: foreach my $id (@locales) {
1003: if ($id ne '') {
1004: my ($en_terr,$native_terr);
1005: my $loc = DateTime::Locale->load($id);
1006: if (ref($loc)) {
1007: $en_terr = $loc->name();
1008: $native_terr = $loc->native_name();
1.687 raeburn 1009: if (grep(/^en$/,@languages) || !@languages) {
1010: if ($en_terr ne '') {
1011: $locale_names{$id} = '('.$en_terr.')';
1012: } elsif ($native_terr ne '') {
1013: $locale_names{$id} = $native_terr;
1014: }
1015: } else {
1016: if ($native_terr ne '') {
1017: $locale_names{$id} = $native_terr.' ';
1018: } elsif ($en_terr ne '') {
1019: $locale_names{$id} = '('.$en_terr.')';
1020: }
1021: }
1.1220 raeburn 1022: $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241 raeburn 1023: push(@possibles,$id);
1024: }
1.687 raeburn 1025: }
1026: }
1027: foreach my $item (sort(@possibles)) {
1028: $output.= '<option value="'.$item.'"';
1029: if ($item eq $selected) {
1030: $output.=' selected="selected"';
1031: }
1032: $output.=">$item";
1033: if ($locale_names{$item} ne '') {
1.1220 raeburn 1034: $output.=' '.$locale_names{$item};
1.687 raeburn 1035: }
1036: $output.="</option>\n";
1037: }
1038: $output.="</select>";
1039: return $output;
1040: }
1041:
1.792 raeburn 1042: sub select_language {
1.1256 raeburn 1043: my ($name,$selected,$includeempty,$noedit) = @_;
1.792 raeburn 1044: my %langchoices;
1045: if ($includeempty) {
1.1117 raeburn 1046: %langchoices = ('' => 'No language preference');
1.792 raeburn 1047: }
1048: foreach my $id (&languageids()) {
1049: my $code = &supportedlanguagecode($id);
1050: if ($code) {
1051: $langchoices{$code} = &plainlanguagedescription($id);
1052: }
1053: }
1.1117 raeburn 1054: %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256 raeburn 1055: return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792 raeburn 1056: }
1057:
1.42 matthew 1058: =pod
1.36 matthew 1059:
1.1088 foxr 1060:
1061: =item * &list_languages()
1062:
1063: Returns an array reference that is suitable for use in language prompters.
1064: Each array element is itself a two element array. The first element
1065: is the language code. The second element a descsriptiuon of the
1066: language itself. This is suitable for use in e.g.
1067: &Apache::edit::select_arg (once dereferenced that is).
1068:
1069: =cut
1070:
1071: sub list_languages {
1072: my @lang_choices;
1073:
1074: foreach my $id (&languageids()) {
1075: my $code = &supportedlanguagecode($id);
1076: if ($code) {
1077: my $selector = $supported_codes{$id};
1078: my $description = &plainlanguagedescription($id);
1.1263 raeburn 1079: push(@lang_choices, [$selector, $description]);
1.1088 foxr 1080: }
1081: }
1082: return \@lang_choices;
1083: }
1084:
1085: =pod
1086:
1.648 raeburn 1087: =item * &linked_select_forms(...)
1.36 matthew 1088:
1089: linked_select_forms returns a string containing a <script></script> block
1090: and html for two <select> menus. The select menus will be linked in that
1091: changing the value of the first menu will result in new values being placed
1092: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 1093: order unless a defined order is provided.
1.36 matthew 1094:
1095: linked_select_forms takes the following ordered inputs:
1096:
1097: =over 4
1098:
1.112 bowersj2 1099: =item * $formname, the name of the <form> tag
1.36 matthew 1100:
1.112 bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 1102:
1.112 bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36 matthew 1104:
1.112 bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 1106:
1.112 bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 1108:
1.112 bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 1110:
1.609 raeburn 1111: =item * $menuorder, the order of values in the first menu
1112:
1.1115 raeburn 1113: =item * $onchangefirst, additional javascript call to execute for an onchange
1114: event for the first <select> tag
1115:
1116: =item * $onchangesecond, additional javascript call to execute for an onchange
1117: event for the second <select> tag
1118:
1.1245 raeburn 1119: =item * $suffix, to differentiate separate uses of select2data javascript
1120: objects in a page.
1121:
1.41 ng 1122: =back
1123:
1.36 matthew 1124: Below is an example of such a hash. Only the 'text', 'default', and
1125: 'select2' keys must appear as stated. keys(%menu) are the possible
1126: values for the first select menu. The text that coincides with the
1.41 ng 1127: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 1128: and text for the second menu are given in the hash pointed to by
1129: $menu{$choice1}->{'select2'}.
1130:
1.112 bowersj2 1131: my %menu = ( A1 => { text =>"Choice A1" ,
1132: default => "B3",
1133: select2 => {
1134: B1 => "Choice B1",
1135: B2 => "Choice B2",
1136: B3 => "Choice B3",
1137: B4 => "Choice B4"
1.609 raeburn 1138: },
1139: order => ['B4','B3','B1','B2'],
1.112 bowersj2 1140: },
1141: A2 => { text =>"Choice A2" ,
1142: default => "C2",
1143: select2 => {
1144: C1 => "Choice C1",
1145: C2 => "Choice C2",
1146: C3 => "Choice C3"
1.609 raeburn 1147: },
1148: order => ['C2','C1','C3'],
1.112 bowersj2 1149: },
1150: A3 => { text =>"Choice A3" ,
1151: default => "D6",
1152: select2 => {
1153: D1 => "Choice D1",
1154: D2 => "Choice D2",
1155: D3 => "Choice D3",
1156: D4 => "Choice D4",
1157: D5 => "Choice D5",
1158: D6 => "Choice D6",
1159: D7 => "Choice D7"
1.609 raeburn 1160: },
1161: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 1162: }
1163: );
1.36 matthew 1164:
1165: =cut
1166:
1167: sub linked_select_forms {
1168: my ($formname,
1169: $middletext,
1170: $firstdefault,
1171: $firstselectname,
1172: $secondselectname,
1.609 raeburn 1173: $hashref,
1174: $menuorder,
1.1115 raeburn 1175: $onchangefirst,
1.1245 raeburn 1176: $onchangesecond,
1177: $suffix
1.36 matthew 1178: ) = @_;
1179: my $second = "document.$formname.$secondselectname";
1180: my $first = "document.$formname.$firstselectname";
1181: # output the javascript to do the changing
1182: my $result = '';
1.776 bisitz 1183: $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824 bisitz 1184: $result.="// <![CDATA[\n";
1.1245 raeburn 1185: $result.="var select2data${suffix} = new Object();\n";
1.36 matthew 1186: $" = '","';
1187: my $debug = '';
1188: foreach my $s1 (sort(keys(%$hashref))) {
1.1245 raeburn 1189: $result.="select2data${suffix}['d_$s1'] = new Object();\n";
1190: $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36 matthew 1191: $hashref->{$s1}->{'default'}."');\n";
1.1245 raeburn 1192: $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36 matthew 1193: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 1194: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
1195: @s2values = @{$hashref->{$s1}->{'order'}};
1196: }
1.36 matthew 1197: $result.="\"@s2values\");\n";
1.1245 raeburn 1198: $result.="select2data${suffix}['d_$s1'].texts = new Array(";
1.36 matthew 1199: my @s2texts;
1200: foreach my $value (@s2values) {
1.1263 raeburn 1201: push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36 matthew 1202: }
1203: $result.="\"@s2texts\");\n";
1204: }
1205: $"=' ';
1206: $result.= <<"END";
1207:
1.1245 raeburn 1208: function select1${suffix}_changed() {
1.36 matthew 1209: // Determine new choice
1.1245 raeburn 1210: var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36 matthew 1211: // update select2
1.1245 raeburn 1212: var values = select2data${suffix}[newvalue].values;
1213: var texts = select2data${suffix}[newvalue].texts;
1214: var select2def = select2data${suffix}[newvalue].def;
1.36 matthew 1215: var i;
1216: // out with the old
1.1245 raeburn 1217: $second.options.length = 0;
1218: // in with the new
1.36 matthew 1219: for (i=0;i<values.length; i++) {
1220: $second.options[i] = new Option(values[i]);
1.143 matthew 1221: $second.options[i].value = values[i];
1.36 matthew 1222: $second.options[i].text = texts[i];
1223: if (values[i] == select2def) {
1224: $second.options[i].selected = true;
1225: }
1226: }
1227: }
1.824 bisitz 1228: // ]]>
1.36 matthew 1229: </script>
1230: END
1231: # output the initial values for the selection lists
1.1245 raeburn 1232: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609 raeburn 1233: my @order = sort(keys(%{$hashref}));
1234: if (ref($menuorder) eq 'ARRAY') {
1235: @order = @{$menuorder};
1236: }
1237: foreach my $value (@order) {
1.36 matthew 1238: $result.=" <option value=\"$value\" ";
1.253 albertel 1239: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 1240: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 1241: }
1242: $result .= "</select>\n";
1.1400 raeburn 1243: my %select2;
1244: if (ref($hashref->{$firstdefault}) eq 'HASH') {
1245: if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
1246: %select2 = %{$hashref->{$firstdefault}->{'select2'}};
1247: }
1248: }
1.36 matthew 1249: $result .= $middletext;
1.1115 raeburn 1250: $result .= "<select size=\"1\" name=\"$secondselectname\"";
1251: if ($onchangesecond) {
1252: $result .= ' onchange="'.$onchangesecond.'"';
1253: }
1254: $result .= ">\n";
1.36 matthew 1255: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 1256:
1257: my @secondorder = sort(keys(%select2));
1258: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
1259: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
1260: }
1261: foreach my $value (@secondorder) {
1.36 matthew 1262: $result.=" <option value=\"$value\" ";
1.253 albertel 1263: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 1264: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 1265: }
1266: $result .= "</select>\n";
1267: # return $debug;
1268: return $result;
1269: } # end of sub linked_select_forms {
1270:
1.45 matthew 1271: =pod
1.44 bowersj2 1272:
1.1381 raeburn 1273: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44 bowersj2 1274:
1.112 bowersj2 1275: Returns a string corresponding to an HTML link to the given help
1276: $topic, where $topic corresponds to the name of a .tex file in
1277: /home/httpd/html/adm/help/tex, with underscores replaced by
1278: spaces.
1279:
1280: $text will optionally be linked to the same topic, allowing you to
1281: link text in addition to the graphic. If you do not want to link
1282: text, but wish to specify one of the later parameters, pass an
1283: empty string.
1284:
1285: $stayOnPage is a value that will be interpreted as a boolean. If true,
1286: the link will not open a new window. If false, the link will open
1287: a new window using Javascript. (Default is false.)
1288:
1289: $width and $height are optional numerical parameters that will
1290: override the width and height of the popped up window, which may
1.973 raeburn 1291: be useful for certain help topics with big pictures included.
1292:
1293: $imgid is the id of the img tag used for the help icon. This may be
1294: used in a javascript call to switch the image src. See
1295: lonhtmlcommon::htmlareaselectactive() for an example.
1.44 bowersj2 1296:
1.1381 raeburn 1297: $links_target will optionally be set to a target (_top, _parent or _self).
1298:
1.44 bowersj2 1299: =cut
1300:
1301: sub help_open_topic {
1.1381 raeburn 1302: my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48 bowersj2 1303: $text = "" if (not defined $text);
1.44 bowersj2 1304: $stayOnPage = 0 if (not defined $stayOnPage);
1.1033 www 1305: $width = 500 if (not defined $width);
1.44 bowersj2 1306: $height = 400 if (not defined $height);
1307: my $filename = $topic;
1308: $filename =~ s/ /_/g;
1309:
1.48 bowersj2 1310: my $template = "";
1311: my $link;
1.572 banghart 1312:
1.159 www 1313: $topic=~s/\W/\_/g;
1.44 bowersj2 1314:
1.572 banghart 1315: if (!$stayOnPage) {
1.1033 www 1316: $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037 www 1317: } elsif ($stayOnPage eq 'popup') {
1318: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 1319: } else {
1.48 bowersj2 1320: $link = "/adm/help/${filename}.hlp";
1321: }
1322:
1323: # Add the text
1.1314 raeburn 1324: my $target = ' target="_top"';
1.1381 raeburn 1325: if ($links_target) {
1326: $target = ' target="'.$links_target.'"';
1327: } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1328: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1329: $target = '';
1.1378 raeburn 1330: }
1.1380 raeburn 1331: if ($text ne "") {
1.763 bisitz 1332: $template.='<span class="LC_help_open_topic">'
1.1314 raeburn 1333: .'<a'.$target.' href="'.$link.'">'
1.763 bisitz 1334: .$text.'</a>';
1.48 bowersj2 1335: }
1336:
1.763 bisitz 1337: # (Always) Add the graphic
1.179 matthew 1338: my $title = &mt('Online Help');
1.667 raeburn 1339: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973 raeburn 1340: if ($imgid ne '') {
1341: $imgid = ' id="'.$imgid.'"';
1342: }
1.1314 raeburn 1343: $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763 bisitz 1344: .'<img src="'.$helpicon.'" border="0"'
1345: .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973 raeburn 1346: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid
1.763 bisitz 1347: .' /></a>';
1348: if ($text ne "") {
1349: $template.='</span>';
1350: }
1.44 bowersj2 1351: return $template;
1352:
1.106 bowersj2 1353: }
1354:
1355: # This is a quicky function for Latex cheatsheet editing, since it
1356: # appears in at least four places
1357: sub helpLatexCheatsheet {
1.1037 www 1358: my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732 raeburn 1359: my $out;
1.106 bowersj2 1360: my $addOther = '';
1.732 raeburn 1361: if ($topic) {
1.1037 www 1362: $addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763 bisitz 1363: }
1364: $out = '<span>' # Start cheatsheet
1365: .$addOther
1366: .'<span>'
1.1037 www 1367: .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1368: .'</span> <span>'
1.1037 www 1369: .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763 bisitz 1370: .'</span>';
1.732 raeburn 1371: unless ($not_author) {
1.1186 kruse 1372: $out .= '<span>'
1373: .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1374: .'</span> <span>'
1.1424 raeburn 1375: .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763 bisitz 1376: .'</span>';
1.732 raeburn 1377: }
1.763 bisitz 1378: $out .= '</span>'; # End cheatsheet
1.732 raeburn 1379: return $out;
1.172 www 1380: }
1381:
1.430 albertel 1382: sub general_help {
1383: my $helptopic='Student_Intro';
1384: if ($env{'request.role'}=~/^(ca|au)/) {
1385: $helptopic='Authoring_Intro';
1.907 raeburn 1386: } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430 albertel 1387: $helptopic='Course_Coordination_Intro';
1.672 raeburn 1388: } elsif ($env{'request.role'}=~/^dc/) {
1389: $helptopic='Domain_Coordination_Intro';
1.430 albertel 1390: }
1391: return $helptopic;
1392: }
1393:
1394: sub update_help_link {
1395: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
1396: my $origurl = $ENV{'REQUEST_URI'};
1397: $origurl=~s|^/~|/priv/|;
1398: my $timestamp = time;
1399: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
1400: $$datum = &escape($$datum);
1401: }
1402:
1403: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1404: my $output .= <<"ENDOUTPUT";
1405: <script type="text/javascript">
1.824 bisitz 1406: // <![CDATA[
1.430 albertel 1407: banner_link = '$banner_link';
1.824 bisitz 1408: // ]]>
1.430 albertel 1409: </script>
1410: ENDOUTPUT
1411: return $output;
1412: }
1413:
1414: # now just updates the help link and generates a blue icon
1.193 raeburn 1415: sub help_open_menu {
1.1381 raeburn 1416: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target)
1.552 banghart 1417: = @_;
1.949 droeschl 1418: $stayOnPage = 1;
1.430 albertel 1419: my $output;
1420: if ($component_help) {
1421: if (!$text) {
1422: $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381 raeburn 1423: $width,$height,'',$links_target);
1.430 albertel 1424: } else {
1425: my $help_text;
1426: $help_text=&unescape($topic);
1427: $output='<table><tr><td>'.
1428: &help_open_topic($component_help,$help_text,$stayOnPage,
1.1381 raeburn 1429: $width,$height,'',$links_target).'</td></tr></table>';
1.430 albertel 1430: }
1431: }
1432: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1433: return $output.$banner_link;
1434: }
1435:
1436: sub top_nav_help {
1.1369 raeburn 1437: my ($text,$linkattr) = @_;
1.436 albertel 1438: $text = &mt($text);
1.949 droeschl 1439: my $stay_on_page = 1;
1440:
1.1168 raeburn 1441: my ($link,$banner_link);
1442: unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
1443: $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1444: : "javascript:helpMenu('open')";
1445: $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1446: }
1.201 raeburn 1447: my $title = &mt('Get help');
1.1168 raeburn 1448: if ($link) {
1449: return <<"END";
1.436 albertel 1450: $banner_link
1.1369 raeburn 1451: <a href="$link" title="$title" $linkattr>$text</a>
1.436 albertel 1452: END
1.1168 raeburn 1453: } else {
1454: return ' '.$text.' ';
1455: }
1.436 albertel 1456: }
1457:
1458: sub help_menu_js {
1.1154 raeburn 1459: my ($httphost) = @_;
1.949 droeschl 1460: my $stayOnPage = 1;
1.436 albertel 1461: my $width = 620;
1462: my $height = 600;
1.430 albertel 1463: my $helptopic=&general_help();
1.1154 raeburn 1464: my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1465: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1466: my $start_page =
1467: &Apache::loncommon::start_page('Help Menu', undef,
1468: {'frameset' => 1,
1469: 'js_ready' => 1,
1.1154 raeburn 1470: 'use_absolute' => $httphost,
1.331 albertel 1471: 'add_entries' => {
1.1168 raeburn 1472: 'border' => '0',
1.579 raeburn 1473: 'rows' => "110,*",},});
1.331 albertel 1474: my $end_page =
1475: &Apache::loncommon::end_page({'frameset' => 1,
1476: 'js_ready' => 1,});
1477:
1.436 albertel 1478: my $template .= <<"ENDTEMPLATE";
1479: <script type="text/javascript">
1.877 bisitz 1480: // <![CDATA[
1.253 albertel 1481: // <!-- BEGIN LON-CAPA Internal
1.430 albertel 1482: var banner_link = '';
1.243 raeburn 1483: function helpMenu(target) {
1484: var caller = this;
1485: if (target == 'open') {
1486: var newWindow = null;
1487: try {
1.262 albertel 1488: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1489: }
1490: catch(error) {
1491: writeHelp(caller);
1492: return;
1493: }
1494: if (newWindow) {
1495: caller = newWindow;
1496: }
1.193 raeburn 1497: }
1.243 raeburn 1498: writeHelp(caller);
1499: return;
1500: }
1501: function writeHelp(caller) {
1.1168 raeburn 1502: caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
1503: caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
1504: caller.document.close();
1505: caller.focus();
1.193 raeburn 1506: }
1.877 bisitz 1507: // END LON-CAPA Internal -->
1.253 albertel 1508: // ]]>
1.436 albertel 1509: </script>
1.193 raeburn 1510: ENDTEMPLATE
1511: return $template;
1512: }
1513:
1.172 www 1514: sub help_open_bug {
1515: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1516: unless ($env{'user.adv'}) { return ''; }
1.172 www 1517: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1518: $text = "" if (not defined $text);
1519: $stayOnPage=1;
1.184 albertel 1520: $width = 600 if (not defined $width);
1521: $height = 600 if (not defined $height);
1.172 www 1522:
1523: $topic=~s/\W+/\+/g;
1524: my $link='';
1525: my $template='';
1.379 albertel 1526: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1527: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1528: if (!$stayOnPage)
1529: {
1530: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1531: }
1532: else
1533: {
1534: $link = $url;
1535: }
1.1314 raeburn 1536:
1.1382 raeburn 1537: my $target = '_top';
1538: if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
1539: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1540: $target = '_blank';
1.1378 raeburn 1541: }
1.1382 raeburn 1542:
1.172 www 1543: # Add the text
1544: if ($text ne "")
1545: {
1546: $template .=
1547: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382 raeburn 1548: "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1549: }
1550:
1551: # Add the graphic
1.179 matthew 1552: my $title = &mt('Report a Bug');
1.215 albertel 1553: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1554: $template .= <<"ENDTEMPLATE";
1.1382 raeburn 1555: <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1556: ENDTEMPLATE
1557: if ($text ne '') { $template.='</td></tr></table>' };
1558: return $template;
1559:
1560: }
1561:
1562: sub help_open_faq {
1563: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1564: unless ($env{'user.adv'}) { return ''; }
1.172 www 1565: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1566: $text = "" if (not defined $text);
1567: $stayOnPage=1;
1568: $width = 350 if (not defined $width);
1569: $height = 400 if (not defined $height);
1570:
1571: $topic=~s/\W+/\+/g;
1572: my $link='';
1573: my $template='';
1574: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1575: if (!$stayOnPage)
1576: {
1577: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1578: }
1579: else
1580: {
1581: $link = $url;
1582: }
1583:
1584: # Add the text
1585: if ($text ne "")
1586: {
1587: $template .=
1.173 www 1588: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1589: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1590: }
1591:
1592: # Add the graphic
1.179 matthew 1593: my $title = &mt('View the FAQ');
1.215 albertel 1594: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1595: $template .= <<"ENDTEMPLATE";
1.436 albertel 1596: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1597: ENDTEMPLATE
1598: if ($text ne '') { $template.='</td></tr></table>' };
1599: return $template;
1600:
1.44 bowersj2 1601: }
1.37 matthew 1602:
1.180 matthew 1603: ###############################################################
1604: ###############################################################
1605:
1.45 matthew 1606: =pod
1607:
1.648 raeburn 1608: =item * &change_content_javascript():
1.256 matthew 1609:
1610: This and the next function allow you to create small sections of an
1611: otherwise static HTML page that you can update on the fly with
1612: Javascript, even in Netscape 4.
1613:
1614: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1615: must be written to the HTML page once. It will prove the Javascript
1616: function "change(name, content)". Calling the change function with the
1617: name of the section
1618: you want to update, matching the name passed to C<changable_area>, and
1619: the new content you want to put in there, will put the content into
1620: that area.
1621:
1622: B<Note>: Netscape 4 only reserves enough space for the changable area
1623: to contain room for the original contents. You need to "make space"
1624: for whatever changes you wish to make, and be B<sure> to check your
1625: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1626: it's adequate for updating a one-line status display, but little more.
1627: This script will set the space to 100% width, so you only need to
1628: worry about height in Netscape 4.
1629:
1630: Modern browsers are much less limiting, and if you can commit to the
1631: user not using Netscape 4, this feature may be used freely with
1632: pretty much any HTML.
1633:
1634: =cut
1635:
1636: sub change_content_javascript {
1637: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1638: if ($env{'browser.type'} eq 'netscape' &&
1639: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1640: return (<<NETSCAPE4);
1641: function change(name, content) {
1642: doc = document.layers[name+"___escape"].layers[0].document;
1643: doc.open();
1644: doc.write(content);
1645: doc.close();
1646: }
1647: NETSCAPE4
1648: } else {
1649: # Otherwise, we need to use semi-standards-compliant code
1650: # (technically, "innerHTML" isn't standard but the equivalent
1651: # is really scary, and every useful browser supports it
1652: return (<<DOMBASED);
1653: function change(name, content) {
1654: element = document.getElementById(name);
1655: element.innerHTML = content;
1656: }
1657: DOMBASED
1658: }
1659: }
1660:
1661: =pod
1662:
1.648 raeburn 1663: =item * &changable_area($name,$origContent):
1.256 matthew 1664:
1665: This provides a "changable area" that can be modified on the fly via
1666: the Javascript code provided in C<change_content_javascript>. $name is
1667: the name you will use to reference the area later; do not repeat the
1668: same name on a given HTML page more then once. $origContent is what
1669: the area will originally contain, which can be left blank.
1670:
1671: =cut
1672:
1673: sub changable_area {
1674: my ($name, $origContent) = @_;
1675:
1.258 albertel 1676: if ($env{'browser.type'} eq 'netscape' &&
1677: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1678: # If this is netscape 4, we need to use the Layer tag
1679: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1680: } else {
1681: return "<span id='$name'>$origContent</span>";
1682: }
1683: }
1684:
1685: =pod
1686:
1.648 raeburn 1687: =item * &viewport_geometry_js
1.590 raeburn 1688:
1689: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1690:
1691: =cut
1692:
1693:
1694: sub viewport_geometry_js {
1695: return <<"GEOMETRY";
1696: var Geometry = {};
1697: function init_geometry() {
1698: if (Geometry.init) { return };
1699: Geometry.init=1;
1700: if (window.innerHeight) {
1701: Geometry.getViewportHeight = function() { return window.innerHeight; };
1702: Geometry.getViewportWidth = function() { return window.innerWidth; };
1703: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1704: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1705: }
1706: else if (document.documentElement && document.documentElement.clientHeight) {
1707: Geometry.getViewportHeight =
1708: function() { return document.documentElement.clientHeight; };
1709: Geometry.getViewportWidth =
1710: function() { return document.documentElement.clientWidth; };
1711:
1712: Geometry.getHorizontalScroll =
1713: function() { return document.documentElement.scrollLeft; };
1714: Geometry.getVerticalScroll =
1715: function() { return document.documentElement.scrollTop; };
1716: }
1717: else if (document.body.clientHeight) {
1718: Geometry.getViewportHeight =
1719: function() { return document.body.clientHeight; };
1720: Geometry.getViewportWidth =
1721: function() { return document.body.clientWidth; };
1722: Geometry.getHorizontalScroll =
1723: function() { return document.body.scrollLeft; };
1724: Geometry.getVerticalScroll =
1725: function() { return document.body.scrollTop; };
1726: }
1727: }
1728:
1729: GEOMETRY
1730: }
1731:
1732: =pod
1733:
1.648 raeburn 1734: =item * &viewport_size_js()
1.590 raeburn 1735:
1736: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1737:
1738: =cut
1739:
1740: sub viewport_size_js {
1741: my $geometry = &viewport_geometry_js();
1742: return <<"DIMS";
1743:
1744: $geometry
1745:
1746: function getViewportDims(width,height) {
1747: init_geometry();
1748: width.value = Geometry.getViewportWidth();
1749: height.value = Geometry.getViewportHeight();
1750: return;
1751: }
1752:
1753: DIMS
1754: }
1755:
1756: =pod
1757:
1.648 raeburn 1758: =item * &resize_textarea_js()
1.565 albertel 1759:
1760: emits the needed javascript to resize a textarea to be as big as possible
1761:
1762: creates a function resize_textrea that takes two IDs first should be
1763: the id of the element to resize, second should be the id of a div that
1764: surrounds everything that comes after the textarea, this routine needs
1765: to be attached to the <body> for the onload and onresize events.
1766:
1767: =cut
1768:
1769: sub resize_textarea_js {
1.590 raeburn 1770: my $geometry = &viewport_geometry_js();
1.565 albertel 1771: return <<"RESIZE";
1772: <script type="text/javascript">
1.824 bisitz 1773: // <![CDATA[
1.590 raeburn 1774: $geometry
1.565 albertel 1775:
1.588 albertel 1776: function getX(element) {
1777: var x = 0;
1778: while (element) {
1779: x += element.offsetLeft;
1780: element = element.offsetParent;
1781: }
1782: return x;
1783: }
1784: function getY(element) {
1785: var y = 0;
1786: while (element) {
1787: y += element.offsetTop;
1788: element = element.offsetParent;
1789: }
1790: return y;
1791: }
1792:
1793:
1.565 albertel 1794: function resize_textarea(textarea_id,bottom_id) {
1795: init_geometry();
1796: var textarea = document.getElementById(textarea_id);
1797: //alert(textarea);
1798:
1.588 albertel 1799: var textarea_top = getY(textarea);
1.565 albertel 1800: var textarea_height = textarea.offsetHeight;
1801: var bottom = document.getElementById(bottom_id);
1.588 albertel 1802: var bottom_top = getY(bottom);
1.565 albertel 1803: var bottom_height = bottom.offsetHeight;
1804: var window_height = Geometry.getViewportHeight();
1.588 albertel 1805: var fudge = 23;
1.565 albertel 1806: var new_height = window_height-fudge-textarea_top-bottom_height;
1807: if (new_height < 300) {
1808: new_height = 300;
1809: }
1810: textarea.style.height=new_height+'px';
1811: }
1.824 bisitz 1812: // ]]>
1.565 albertel 1813: </script>
1814: RESIZE
1815:
1816: }
1817:
1.1205 golterma 1818: sub colorfuleditor_js {
1.1248 raeburn 1819: my $browse_or_search;
1820: my $respath;
1821: my ($cnum,$cdom) = &crsauthor_url();
1822: if ($cnum) {
1823: $respath = "/res/$cdom/$cnum/";
1824: my %js_lt = &Apache::lonlocal::texthash(
1825: sunm => 'Sub-directory name',
1826: save => 'Save page to make this permanent',
1827: );
1828: &js_escape(\%js_lt);
1.1400 raeburn 1829: my $showfile_js = &show_crsfiles_js();
1.1248 raeburn 1830: $browse_or_search = <<"END";
1831:
1.1400 raeburn 1832: $showfile_js
1833:
1.1248 raeburn 1834: function toggleChooser(form,element,titleid,only,search) {
1835: var disp = 'none';
1836: if (document.getElementById('chooser_'+element)) {
1837: var curr = document.getElementById('chooser_'+element).style.display;
1838: if (curr == 'none') {
1839: disp='inline';
1840: if (form.elements['chooser_'+element].length) {
1841: for (var i=0; i<form.elements['chooser_'+element].length; i++) {
1842: form.elements['chooser_'+element][i].checked = false;
1843: }
1844: }
1845: toggleResImport(form,element);
1846: }
1847: document.getElementById('chooser_'+element).style.display = disp;
1.1400 raeburn 1848: var dirsel = '';
1849: var filesel = '';
1850: if (document.getElementById('chooser_'+element+'_crsres')) {
1851: var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
1852: if (currcrsres == 'none') {
1853: dirsel = 'coursepath_'+element;
1854: var filesel = 'coursefile_'+element;
1855: var include;
1856: if (document.getElementById('crsres_include_'+element)) {
1857: include = document.getElementById('crsres_include_'+element).value;
1858: }
1.1402 raeburn 1859: populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400 raeburn 1860: }
1861: }
1862: if (document.getElementById('chooser_'+element+'_upload')) {
1863: var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
1864: if (currcrsupload == 'none') {
1865: dirsel = 'crsauthorpath_'+element;
1866: filesel = '';
1.1402 raeburn 1867: populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400 raeburn 1868: }
1869: }
1.1248 raeburn 1870: }
1871: }
1872:
1.1400 raeburn 1873: function toggleCrsFile(form,element) {
1.1248 raeburn 1874: if (document.getElementById('chooser_'+element+'_crsres')) {
1875: var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
1876: if (curr == 'none') {
1.1400 raeburn 1877: if (document.getElementById('coursepath_'+element)) {
1878: var numdirs;
1879: if (document.getElementById('coursepath_'+element).length) {
1880: numdirs = document.getElementById('coursepath_'+element).length;
1881: }
1.1402 raeburn 1882: if ((document.getElementById('hascrsres_'+element)) &&
1883: (document.getElementById('nocrsres_'+element))) {
1884: if (numdirs) {
1885: document.getElementById('hascrsres_'+element).style.display='inline-block';
1886: document.getElementById('nocrsres_'+element).style.display='none';
1887: } else {
1888: document.getElementById('hascrsres_'+element).style.display='none';
1889: document.getElementById('nocrsres_'+element).style.display='inline-block';
1890: }
1891: }
1.1248 raeburn 1892: form.elements['coursepath_'+element].selectedIndex = 0;
1893: if (numdirs > 1) {
1.1400 raeburn 1894: var selelem = form.elements['coursefile_'+element];
1895: var i, len = selelem.options.length -1;
1896: if (len >=0) {
1897: for (i = len; i >= 0; i--) {
1898: selelem.remove(i);
1899: }
1900: selelem.options[0] = new Option('','');
1901: }
1.1248 raeburn 1902: }
1903: }
1.1400 raeburn 1904: }
1.1248 raeburn 1905: document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
1906: }
1907: if (document.getElementById('chooser_'+element+'_upload')) {
1908: document.getElementById('chooser_'+element+'_upload').style.display = 'none';
1909: if (document.getElementById('uploadcrsres_'+element)) {
1910: document.getElementById('uploadcrsres_'+element).value = '';
1911: }
1912: }
1913: return;
1914: }
1915:
1.1400 raeburn 1916: function toggleCrsUpload(form,element) {
1.1248 raeburn 1917: if (document.getElementById('chooser_'+element+'_crsres')) {
1918: document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
1919: }
1920: if (document.getElementById('chooser_'+element+'_upload')) {
1921: var curr = document.getElementById('chooser_'+element+'_upload').style.display;
1922: if (curr == 'none') {
1.1400 raeburn 1923: form.elements['newsubdir_'+element][0].checked = true;
1924: toggleNewsubdir(form,element);
1925: document.getElementById('chooser_'+element+'_upload').style.display = 'block';
1926: if (document.getElementById('uploadcrsres_'+element)) {
1927: document.getElementById('uploadcrsres_'+element).value = '';
1.1248 raeburn 1928: }
1929: }
1930: }
1931: return;
1932: }
1933:
1934: function toggleResImport(form,element) {
1935: var choices = new Array('crsres','upload');
1936: for (var i=0; i<choices.length; i++) {
1937: if (document.getElementById('chooser_'+element+'_'+choices[i])) {
1938: document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
1939: }
1940: }
1941: }
1942:
1943: function toggleNewsubdir(form,element) {
1944: var newsub = form.elements['newsubdir_'+element];
1945: if (newsub) {
1946: if (newsub.length) {
1947: for (var j=0; j<newsub.length; j++) {
1948: if (newsub[j].checked) {
1949: if (document.getElementById('newsubdirname_'+element)) {
1950: if (newsub[j].value == '1') {
1951: document.getElementById('newsubdirname_'+element).type = "text";
1952: if (document.getElementById('newsubdir_'+element)) {
1953: document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
1954: }
1955: } else {
1956: document.getElementById('newsubdirname_'+element).type = "hidden";
1957: document.getElementById('newsubdirname_'+element).value = "";
1958: document.getElementById('newsubdir_'+element).innerHTML = "";
1959: }
1960: }
1961: break;
1962: }
1963: }
1964: }
1965: }
1966: }
1967:
1968: function updateCrsFile(form,element) {
1969: var directory = form.elements['coursepath_'+element];
1970: var filename = form.elements['coursefile_'+element];
1971: var path = directory.options[directory.selectedIndex].value;
1972: var file = filename.options[filename.selectedIndex].value;
1.1400 raeburn 1973: if (file != '') {
1974: form.elements[element].value = '$respath';
1975: if (path == '/') {
1976: form.elements[element].value += file;
1977: } else {
1978: form.elements[element].value += path+'/'+file;
1979: }
1980: unClean();
1981: if (document.getElementById('previewimg_'+element)) {
1982: document.getElementById('previewimg_'+element).src = form.elements[element].value;
1983: var newsrc = document.getElementById('previewimg_'+element).src;
1984: }
1985: if (document.getElementById('showimg_'+element)) {
1986: document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
1987: }
1.1248 raeburn 1988: }
1989: toggleChooser(form,element);
1990: return;
1991: }
1992:
1993: function uploadDone(suffix,name) {
1994: if (name) {
1995: document.forms["lonhomework"].elements[suffix].value = name;
1996: unClean();
1997: toggleChooser(document.forms["lonhomework"],suffix);
1998: }
1999: }
2000:
2001: \$(document).ready(function(){
2002:
2003: \$(document).delegate('form :submit', 'click', function( event ) {
2004: if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
2005: var buttonId = this.id;
2006: var suffix = buttonId.toString();
2007: suffix = suffix.replace(/^crsupload_/,'');
2008: event.preventDefault();
2009: document.lonhomework.target = 'crsupload_target_'+suffix;
2010: document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
2011: \$(this.form).submit();
2012: document.lonhomework.target = '';
2013: if (document.getElementById('crsuploadto_'+suffix)) {
2014: document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
2015: }
2016: return false;
2017: }
2018: });
2019: });
2020: END
2021: }
1.1205 golterma 2022: return <<"COLORFULEDIT"
2023: <script type="text/javascript">
2024: // <![CDATA[>
2025: function fold_box(curDepth, lastresource){
2026:
2027: // we need a list because there can be several blocks you need to fold in one tag
2028: var block = document.getElementsByName('foldblock_'+curDepth);
2029: // but there is only one folding button per tag
2030: var foldbutton = document.getElementById('folding_btn_'+curDepth);
2031:
2032: if(block.item(0).style.display == 'none'){
2033:
2034: foldbutton.value = '@{[&mt("Hide")]}';
2035: for (i = 0; i < block.length; i++){
2036: block.item(i).style.display = '';
2037: }
2038: }else{
2039:
2040: foldbutton.value = '@{[&mt("Show")]}';
2041: for (i = 0; i < block.length; i++){
2042: // block.item(i).style.visibility = 'collapse';
2043: block.item(i).style.display = 'none';
2044: }
2045: };
2046: saveState(lastresource);
2047: }
2048:
2049: function saveState (lastresource) {
2050:
2051: var tag_list = getTagList();
2052: if(tag_list != null){
2053: var timestamp = new Date().getTime();
2054: var key = lastresource;
2055:
2056: // the value pattern is: 'time;key1,value1;key2,value2; ... '
2057: // starting with timestamp
2058: var value = timestamp+';';
2059:
2060: // building the list of key-value pairs
2061: for(var i = 0; i < tag_list.length; i++){
2062: value += tag_list[i]+',';
2063: value += document.getElementsByName(tag_list[i])[0].style.display+';';
2064: }
2065:
2066: // only iterate whole storage if nothing to override
2067: if(localStorage.getItem(key) == null){
2068:
2069: // prevent storage from growing large
2070: if(localStorage.length > 50){
2071: var regex_getTimestamp = /^(?:\d)+;/;
2072: var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
2073: var oldest_key;
2074:
2075: for(var i = 1; i < localStorage.length; i++){
2076: if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
2077: oldest_key = localStorage.key(i);
2078: oldest_timestamp = regex_getTimestamp.exec(oldest_key);
2079: }
2080: }
2081: localStorage.removeItem(oldest_key);
2082: }
2083: }
2084: localStorage.setItem(key,value);
2085: }
2086: }
2087:
2088: // restore folding status of blocks (on page load)
2089: function restoreState (lastresource) {
2090: if(localStorage.getItem(lastresource) != null){
2091: var key = lastresource;
2092: var value = localStorage.getItem(key);
2093: var regex_delTimestamp = /^\d+;/;
2094:
2095: value.replace(regex_delTimestamp, '');
2096:
2097: var valueArr = value.split(';');
2098: var pairs;
2099: var elements;
2100: for (var i = 0; i < valueArr.length; i++){
2101: pairs = valueArr[i].split(',');
2102: elements = document.getElementsByName(pairs[0]);
2103:
2104: for (var j = 0; j < elements.length; j++){
2105: elements[j].style.display = pairs[1];
2106: if (pairs[1] == "none"){
2107: var regex_id = /([_\\d]+)\$/;
2108: regex_id.exec(pairs[0]);
2109: document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
2110: }
2111: }
2112: }
2113: }
2114: }
2115:
2116: function getTagList () {
2117:
2118: var stringToSearch = document.lonhomework.innerHTML;
2119:
2120: var ret = new Array();
2121: var regex_findBlock = /(foldblock_.*?)"/g;
2122: var tag_list = stringToSearch.match(regex_findBlock);
2123:
2124: if(tag_list != null){
2125: for(var i = 0; i < tag_list.length; i++){
2126: ret.push(tag_list[i].replace(/"/, ''));
2127: }
2128: }
2129: return ret;
2130: }
2131:
2132: function saveScrollPosition (resource) {
2133: var tag_list = getTagList();
2134:
2135: // we dont always want to jump to the first block
2136: // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
2137: if(\$(window).scrollTop() > 170){
2138: if(tag_list != null){
2139: var result;
2140: for(var i = 0; i < tag_list.length; i++){
2141: if(isElementInViewport(tag_list[i])){
2142: result += tag_list[i]+';';
2143: }
2144: }
2145: sessionStorage.setItem('anchor_'+resource, result);
2146: }
2147: } else {
2148: // we dont need to save zero, just delete the item to leave everything tidy
2149: sessionStorage.removeItem('anchor_'+resource);
2150: }
2151: }
2152:
2153: function restoreScrollPosition(resource){
2154:
2155: var elem = sessionStorage.getItem('anchor_'+resource);
2156: if(elem != null){
2157: var tag_list = elem.split(';');
2158: var elem_list;
2159:
2160: for(var i = 0; i < tag_list.length; i++){
2161: elem_list = document.getElementsByName(tag_list[i]);
2162:
2163: if(elem_list.length > 0){
2164: elem = elem_list[0];
2165: break;
2166: }
2167: }
2168: elem.scrollIntoView();
2169: }
2170: }
2171:
2172: function isElementInViewport(el) {
2173:
2174: // change to last element instead of first
2175: var elem = document.getElementsByName(el);
2176: var rect = elem[0].getBoundingClientRect();
2177:
2178: return (
2179: rect.top >= 0 &&
2180: rect.left >= 0 &&
2181: rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
2182: rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
2183: );
2184: }
2185:
2186: function autosize(depth){
2187: var cmInst = window['cm'+depth];
2188: var fitsizeButton = document.getElementById('fitsize'+depth);
2189:
2190: // is fixed size, switching to dynamic
2191: if (sessionStorage.getItem("autosized_"+depth) == null) {
2192: cmInst.setSize("","auto");
2193: fitsizeButton.value = "@{[&mt('Fixed size')]}";
2194: sessionStorage.setItem("autosized_"+depth, "yes");
2195:
2196: // is dynamic size, switching to fixed
2197: } else {
2198: cmInst.setSize("","300px");
2199: fitsizeButton.value = "@{[&mt('Dynamic size')]}";
2200: sessionStorage.removeItem("autosized_"+depth);
2201: }
2202: }
2203:
1.1248 raeburn 2204: $browse_or_search
1.1205 golterma 2205:
2206: // ]]>
2207: </script>
2208: COLORFULEDIT
2209: }
2210:
2211: sub xmleditor_js {
2212: return <<XMLEDIT
2213: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
2214: <script type="text/javascript">
2215: // <![CDATA[>
2216:
2217: function saveScrollPosition (resource) {
2218:
2219: var scrollPos = \$(window).scrollTop();
2220: sessionStorage.setItem(resource,scrollPos);
2221: }
2222:
2223: function restoreScrollPosition(resource){
2224:
2225: var scrollPos = sessionStorage.getItem(resource);
2226: \$(window).scrollTop(scrollPos);
2227: }
2228:
2229: // unless internet explorer
2230: if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
2231:
2232: \$(document).ready(function() {
2233: \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
2234: });
2235: }
2236:
2237: // inserts text at cursor position into codemirror (xml editor only)
2238: function insertText(text){
2239: cm.focus();
2240: var curPos = cm.getCursor();
2241: cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
2242: }
2243: // ]]>
2244: </script>
2245: XMLEDIT
2246: }
2247:
2248: sub insert_folding_button {
2249: my $curDepth = $Apache::lonxml::curdepth;
2250: my $lastresource = $env{'request.ambiguous'};
2251:
2252: return "<input type=\"button\" id=\"folding_btn_$curDepth\"
2253: value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
2254: }
2255:
1.1248 raeburn 2256: sub crsauthor_url {
2257: my ($url) = @_;
2258: if ($url eq '') {
2259: $url = $ENV{'REQUEST_URI'};
2260: }
2261: my ($cnum,$cdom);
2262: if ($env{'request.course.id'}) {
2263: my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
2264: if ($audom ne '' && $auname ne '') {
2265: if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
2266: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
2267: $cnum = $auname;
2268: $cdom = $audom;
2269: }
2270: }
2271: }
2272: return ($cnum,$cdom);
2273: }
2274:
2275: sub import_crsauthor_form {
1.1400 raeburn 2276: my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248 raeburn 2277: return (0) unless ($env{'request.course.id'});
2278: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
2279: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
2280: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
2281: return (0) unless (($cnum ne '') && ($cdom ne ''));
2282: my @ids=&Apache::lonnet::current_machine_ids();
1.1400 raeburn 2283: my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402 raeburn 2284:
1.1248 raeburn 2285: if (grep(/^\Q$crshome\E$/,@ids)) {
2286: $is_home = 1;
2287: }
1.1400 raeburn 2288: $toppath = "/priv/$cdom/$cnum";
2289: my $nonemptydir = 1;
2290: my $js_only;
2291: if ($only) {
2292: map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
2293: $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
2294: }
2295: $exclude = &Apache::lonnet::priv_exclude();
1.1402 raeburn 2296: &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400 raeburn 2297: my $numdirs = scalar(keys(%files));
1.1248 raeburn 2298: my %lt = &Apache::lonlocal::texthash (
2299: fnam => 'Filename',
2300: dire => 'Directory',
1.1400 raeburn 2301: se => 'Select',
1.1248 raeburn 2302: );
1.1402 raeburn 2303: $output = $lt{'dire'}.': '.
1.1400 raeburn 2304: '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402 raeburn 2305: 'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400 raeburn 2306: '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402 raeburn 2307: if ($files{'/'}) {
2308: $output .= '<option value="/">/</option>'."\n";
2309: }
1.1400 raeburn 2310: foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402 raeburn 2311: next if ($key eq '/');
1.1400 raeburn 2312: $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
2313: }
2314: $output .= '</select><br />'."\n".
1.1402 raeburn 2315: $lt{'fnam'}.': <select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400 raeburn 2316: '<option value="" selected="selected"></option>'."\n".
1.1402 raeburn 2317: '</select>'."\n".
2318: '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400 raeburn 2319: return ($numdirs,$output);
2320: }
2321:
2322: sub show_crsfiles_js {
2323: my $excluderef = &Apache::lonnet::priv_exclude();
2324: my $se = &js_escape(&mt('Select'));
2325: my $exclude;
2326: if (ref($excluderef) eq 'HASH') {
2327: $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
2328: }
2329: my $js = <<"END";
2330:
2331:
1.1402 raeburn 2332: function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400 raeburn 2333: var relpath = '';
2334: if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2335: var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
2336: if (currdir == '') {
2337: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2338: selelem = form.elements[filesel];
2339: var j, numfiles = selelem.options.length -1;
2340: if (numfiles >=0) {
2341: for (j = numfiles; j >= 0; j--) {
2342: selelem.remove(j);
2343: }
2344: }
2345: if (selelem.options.length == 0) {
2346: selelem.options[selelem.options.length] = new Option('','');
2347: selelem.selectedIndex = 0;
1.1248 raeburn 2348: }
2349: }
1.1400 raeburn 2350: return;
2351: } else {
2352: relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248 raeburn 2353: }
2354: }
1.1400 raeburn 2355: var http = new XMLHttpRequest();
2356: var url = "/adm/courseauthor";
2357: var crsrole = "$env{'request.role'}";
2358: var exclude = '';
2359: if (exc) {
2360: exclude = '$exclude';
2361: }
1.1402 raeburn 2362: var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400 raeburn 2363: http.open("POST", url, true);
2364: http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
2365: http.onreadystatechange = function() {
2366: if (http.readyState == 4 && http.status == 200) {
2367: var data = JSON.parse(http.responseText);
2368: var selelem;
2369: if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
2370: if (Array.isArray(data.dirs)) {
2371: selelem = form.elements[dirsel];
2372: var i, numdirs = selelem.options.length -1;
2373: if (numdirs >=0) {
2374: for (i = numdirs; i >= 0; i--) {
2375: selelem.remove(i);
2376: }
2377: }
2378: var len = data.dirs.length;
2379: if (len) {
1.1402 raeburn 2380: selelem.options[selelem.options.length] = new Option('$se','');
1.1400 raeburn 2381: var j;
2382: for (j = 0; j < len; j++) {
2383: selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
2384: }
2385: selelem.selectedIndex = 0;
2386: }
2387: if (!setfile) {
2388: if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2389: selelem = form.elements[filesel];
2390: var j, numfiles = selelem.options.length -1;
2391: if (numfiles >=0) {
2392: for (j = numfiles; j >= 0; j--) {
2393: selelem.remove(j);
2394: }
2395: }
2396: if (selelem.options.length == 0) {
2397: selelem.options[selelem.options.length] = new Option('','');
2398: selelem.selectedIndex = 0;
2399: }
2400: }
2401: }
2402: }
2403: }
2404: if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
2405: selelem = form.elements[filesel];
2406: var i, numfiles = selelem.options.length -1;
2407: if (numfiles >=0) {
2408: for (i = numfiles; i >= 0; i--) {
2409: selelem.remove(i);
2410: }
2411: }
2412: var x;
2413: for (x in data.files) {
2414: if (Array.isArray(data.files[x])) {
2415: if (data.files[x].length > 1) {
2416: selelem.options[selelem.options.length] = new Option('$se','');
2417: }
2418: var len = data.files[x].length;
2419: if (len) {
2420: var k;
2421: for (k = 0; k < len; k++) {
2422: selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
2423: }
2424: selelem.selectedIndex = 0;
2425: }
2426: }
2427: }
2428: if (selelem.options.length == 0) {
2429: selelem.options[selelem.options.length] = new Option('','');
2430: selelem.selectedIndex = 0;
2431: }
1.1248 raeburn 2432: }
2433: }
2434: }
1.1400 raeburn 2435: http.send(params);
1.1248 raeburn 2436: }
1.1400 raeburn 2437: END
1.1248 raeburn 2438: }
2439:
1.1426 raeburn 2440: sub crsauthor_rights {
2441: my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
2442: my $sourcerights = "$path/$rightsfile";
2443: my $now = time;
2444: if (!-e $sourcerights) {
2445: my $cid = $cdom.'_'.$cnum;
2446: if (!-e "$docroot/priv/$cdom") {
2447: mkdir("$docroot/priv/$cdom",0755);
2448: }
2449: if (!-e "$docroot/priv/$cdom/$cnum") {
2450: mkdir("$docroot/priv/$cdom/$cnum",0755);
2451: }
2452: if (open(my $fh,">$sourcerights")) {
2453: print $fh <<END;
2454: <accessrule effect="deny" realm="" type="course" role="" />
2455: <accessrule effect="allow" realm="$cid" type="course" role="" />
2456: END
2457: close($fh);
2458: }
2459: }
2460: if (!-e "$sourcerights.meta") {
2461: if (open(my $fh,">$sourcerights.meta")) {
2462: my $author=$env{'environment.firstname'}.' '.
2463: $env{'environment.middlename'}.' '.
2464: $env{'environment.lastname'}.' '.
2465: $env{'environment.generation'};
2466: $author =~ s/\s+$//;
2467: print $fh <<"END";
2468:
2469: <abstract></abstract>
2470: <author>$author</author>
2471: <authorspace>$cnum:$cdom</authorspace>
2472: <copyright>private</copyright>
2473: <creationdate>$now</creationdate>
2474: <customdistributionfile></customdistributionfile>
2475: <dependencies></dependencies>
2476: <domain>$cdom</domain>
2477: <highestgradelevel>0</highestgradelevel>
2478: <keywords></keywords>
2479: <language>notset </language>
2480: <lastrevisiondate>$now</lastrevisiondate>
2481: <lowestgradelevel>0</lowestgradelevel>
2482: <mime>rights</mime>
2483: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
2484: <notes></notes>
2485: <obsolete></obsolete>
2486: <obsoletereplacement></obsoletereplacement>
2487: <owner>$cnum:$cdom</owner>
2488: <rule>deny:::course,allow:$cid::course</rule>
2489: <sourceavail></sourceavail>
2490: <standards></standards>
2491: <subject></subject>
2492: <title>Course Authoring Rights</title>
2493: END
2494: close($fh);
2495: }
2496: }
2497: return;
2498: }
2499:
1.565 albertel 2500: =pod
2501:
1.1420 raeburn 2502: =item * &iframe_wrapper_headjs()
2503:
1.1425 raeburn 2504: emits javascript containing two global vars to facilitate handling of resizing
2505: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
2506: with standard LON-CAPA menus.
2507:
2508: =cut
2509:
1.1420 raeburn 2510: #
2511: # Where iframe is in use, if window.onload() executes before the custom resize function
2512: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
2513: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
2514: # do not obscure the Functions menu.
2515: #
2516:
2517: sub iframe_wrapper_headjs {
2518: return <<"ENDJS";
2519: <script type="text/javascript">
2520: // <![CDATA[
2521: var LCnotready = 0;
2522: var LCresizedef = 0;
2523: // ]]>
2524: </script>
2525:
2526: ENDJS
2527:
2528: }
2529:
2530: =pod
2531:
2532: =item * &iframe_wrapper_resizejs()
2533:
1.1425 raeburn 2534: emits javascript used to handle resizing for a page containing
2535: an iframe, to ensure that the iframe does not obscure any
2536: standard LON-CAPA menu items.
2537:
2538: =back
2539:
2540: =cut
2541:
1.1420 raeburn 2542: #
2543: # jQuery to use when iframe is in use and a page resize occurs.
2544: # This script will ensure that the iframe does not obscure any
2545: # standard LON-CAPA inline menus (primary, secondary, and/or
2546: # breadcrumbs and Functions menus. Expects javascript from
2547: # &iframe_wrapper_headjs() to be in head portion of the web page,
2548: # e.g., by inclusion in second arg passed to &start_page().
2549: #
2550:
2551: sub iframe_wrapper_resizejs {
2552: my $offset = 5;
2553: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
2554: if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
2555: $offset = 0;
2556: }
2557: return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
2558: \$(document).ready( function() {
2559: \$(window).unbind('resize').resize(function(){
2560: var header = null;
2561: var offset = $offset;
2562: var height = 0;
2563: var hdrtop = 0;
1.1421 raeburn 2564: if (\$('div.LC_menus_content:first').length) {
2565: if (\$('div.LC_menus_content:first').hasClass ("shown")) {
2566: header = \$('div.LC_menus_content:first');
1.1423 raeburn 2567: offset = 12;
1.1421 raeburn 2568: }
2569: } else if (\$('div.LC_head_subbox:first').length) {
1.1420 raeburn 2570: header = \$('div.LC_head_subbox:first');
2571: offset = 9;
2572: } else {
2573: if (\$('#LC_breadcrumbs').length) {
2574: header = \$('#LC_breadcrumbs');
2575: }
2576: }
2577: if (header != null && header.length) {
2578: height = header.height();
2579: hdrtop = header.position().top;
2580: }
2581: var pos = height + hdrtop + offset;
2582: \$('.LC_iframecontainer').css('top', pos);
2583: });
2584: LCresizedef = 1;
2585: if (LCnotready == 1) {
2586: LCnotready = 0;
2587: \$(window).trigger('resize');
2588: }
2589: });
2590: window.onload = function(){
2591: if (LCresizedef) {
2592: LCnotready = 0;
2593: \$(window).trigger('resize');
2594: } else {
2595: LCnotready = 1;
2596: }
2597: };
2598: SCRIPT
2599:
2600: }
2601:
2602: =pod
2603:
1.256 matthew 2604: =head1 Excel and CSV file utility routines
2605:
2606: =cut
2607:
2608: ###############################################################
2609: ###############################################################
2610:
2611: =pod
2612:
1.1162 raeburn 2613: =over 4
2614:
1.648 raeburn 2615: =item * &csv_translate($text)
1.37 matthew 2616:
1.185 www 2617: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 2618: format.
2619:
2620: =cut
2621:
1.180 matthew 2622: ###############################################################
2623: ###############################################################
1.37 matthew 2624: sub csv_translate {
2625: my $text = shift;
2626: $text =~ s/\"/\"\"/g;
1.209 albertel 2627: $text =~ s/\n/ /g;
1.37 matthew 2628: return $text;
2629: }
1.180 matthew 2630:
2631: ###############################################################
2632: ###############################################################
2633:
2634: =pod
2635:
1.648 raeburn 2636: =item * &define_excel_formats()
1.180 matthew 2637:
2638: Define some commonly used Excel cell formats.
2639:
2640: Currently supported formats:
2641:
2642: =over 4
2643:
2644: =item header
2645:
2646: =item bold
2647:
2648: =item h1
2649:
2650: =item h2
2651:
2652: =item h3
2653:
1.256 matthew 2654: =item h4
2655:
2656: =item i
2657:
1.180 matthew 2658: =item date
2659:
2660: =back
2661:
2662: Inputs: $workbook
2663:
2664: Returns: $format, a hash reference.
2665:
1.1057 foxr 2666:
1.180 matthew 2667: =cut
2668:
2669: ###############################################################
2670: ###############################################################
2671: sub define_excel_formats {
2672: my ($workbook) = @_;
2673: my $format;
2674: $format->{'header'} = $workbook->add_format(bold => 1,
2675: bottom => 1,
2676: align => 'center');
2677: $format->{'bold'} = $workbook->add_format(bold=>1);
2678: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
2679: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
2680: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 2681: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 2682: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 2683: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 2684: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 2685: return $format;
2686: }
2687:
2688: ###############################################################
2689: ###############################################################
1.113 bowersj2 2690:
2691: =pod
2692:
1.648 raeburn 2693: =item * &create_workbook()
1.255 matthew 2694:
2695: Create an Excel worksheet. If it fails, output message on the
2696: request object and return undefs.
2697:
2698: Inputs: Apache request object
2699:
2700: Returns (undef) on failure,
2701: Excel worksheet object, scalar with filename, and formats
2702: from &Apache::loncommon::define_excel_formats on success
2703:
2704: =cut
2705:
2706: ###############################################################
2707: ###############################################################
2708: sub create_workbook {
2709: my ($r) = @_;
2710: #
2711: # Create the excel spreadsheet
2712: my $filename = '/prtspool/'.
1.258 albertel 2713: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 2714: time.'_'.rand(1000000000).'.xls';
2715: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
2716: if (! defined($workbook)) {
2717: $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928 bisitz 2718: $r->print(
2719: '<p class="LC_error">'
2720: .&mt('Problems occurred in creating the new Excel file.')
2721: .' '.&mt('This error has been logged.')
2722: .' '.&mt('Please alert your LON-CAPA administrator.')
2723: .'</p>'
2724: );
1.255 matthew 2725: return (undef);
2726: }
2727: #
1.1014 foxr 2728: $workbook->set_tempdir(LONCAPA::tempdir());
1.255 matthew 2729: #
2730: my $format = &Apache::loncommon::define_excel_formats($workbook);
2731: return ($workbook,$filename,$format);
2732: }
2733:
2734: ###############################################################
2735: ###############################################################
2736:
2737: =pod
2738:
1.648 raeburn 2739: =item * &create_text_file()
1.113 bowersj2 2740:
1.542 raeburn 2741: Create a file to write to and eventually make available to the user.
1.256 matthew 2742: If file creation fails, outputs an error message on the request object and
2743: return undefs.
1.113 bowersj2 2744:
1.256 matthew 2745: Inputs: Apache request object, and file suffix
1.113 bowersj2 2746:
1.256 matthew 2747: Returns (undef) on failure,
2748: Filehandle and filename on success.
1.113 bowersj2 2749:
2750: =cut
2751:
1.256 matthew 2752: ###############################################################
2753: ###############################################################
2754: sub create_text_file {
2755: my ($r,$suffix) = @_;
2756: if (! defined($suffix)) { $suffix = 'txt'; };
2757: my $fh;
2758: my $filename = '/prtspool/'.
1.258 albertel 2759: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 2760: time.'_'.rand(1000000000).'.'.$suffix;
2761: $fh = Apache::File->new('>/home/httpd'.$filename);
2762: if (! defined($fh)) {
2763: $r->log_error("Couldn't open $filename for output $!");
1.928 bisitz 2764: $r->print(
2765: '<p class="LC_error">'
2766: .&mt('Problems occurred in creating the output file.')
2767: .' '.&mt('This error has been logged.')
2768: .' '.&mt('Please alert your LON-CAPA administrator.')
2769: .'</p>'
2770: );
1.113 bowersj2 2771: }
1.256 matthew 2772: return ($fh,$filename)
1.113 bowersj2 2773: }
2774:
2775:
1.256 matthew 2776: =pod
1.113 bowersj2 2777:
2778: =back
2779:
2780: =cut
1.37 matthew 2781:
2782: ###############################################################
1.33 matthew 2783: ## Home server <option> list generating code ##
2784: ###############################################################
1.35 matthew 2785:
1.169 www 2786: # ------------------------------------------
2787:
2788: sub domain_select {
1.1289 raeburn 2789: my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
2790: my @possdoms;
2791: if (ref($incdoms) eq 'ARRAY') {
2792: @possdoms = @{$incdoms};
2793: } else {
2794: @possdoms = &Apache::lonnet::all_domains();
2795: }
2796:
1.169 www 2797: my %domains=map {
1.514 albertel 2798: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.1289 raeburn 2799: } @possdoms;
2800:
2801: if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
2802: foreach my $dom (@{$excdoms}) {
2803: delete($domains{$dom});
2804: }
2805: }
2806:
1.169 www 2807: if ($multiple) {
2808: $domains{''}=&mt('Any domain');
1.550 albertel 2809: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 2810: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 2811: } else {
1.550 albertel 2812: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970 raeburn 2813: return &select_form($name,$value,\%domains);
1.169 www 2814: }
2815: }
2816:
1.282 albertel 2817: #-------------------------------------------
2818:
2819: =pod
2820:
1.519 raeburn 2821: =head1 Routines for form select boxes
2822:
2823: =over 4
2824:
1.648 raeburn 2825: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 2826:
2827: Returns a string containing a <select> element int multiple mode
2828:
2829:
2830: Args:
2831: $name - name of the <select> element
1.506 raeburn 2832: $value - scalar or array ref of values that should already be selected
1.282 albertel 2833: $size - number of rows long the select element is
1.283 albertel 2834: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 2835: (shown text should already have been &mt())
1.506 raeburn 2836: $order - (optional) array ref of the order to show the elements in
1.283 albertel 2837:
1.282 albertel 2838: =cut
2839:
2840: #-------------------------------------------
1.169 www 2841: sub multiple_select_form {
1.284 albertel 2842: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 2843: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
2844: my $output='';
1.191 matthew 2845: if (! defined($size)) {
2846: $size = 4;
1.283 albertel 2847: if (scalar(keys(%$hash))<4) {
2848: $size = scalar(keys(%$hash));
1.191 matthew 2849: }
2850: }
1.734 bisitz 2851: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 2852: my @order;
1.506 raeburn 2853: if (ref($order) eq 'ARRAY') {
2854: @order = @{$order};
2855: } else {
2856: @order = sort(keys(%$hash));
1.501 banghart 2857: }
2858: if (exists($$hash{'select_form_order'})) {
2859: @order = @{$$hash{'select_form_order'}};
2860: }
2861:
1.284 albertel 2862: foreach my $key (@order) {
1.356 albertel 2863: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 2864: $output.='selected="selected" ' if ($selected{$key});
2865: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 2866: }
2867: $output.="</select>\n";
2868: return $output;
2869: }
2870:
1.88 www 2871: #-------------------------------------------
2872:
2873: =pod
2874:
1.1254 raeburn 2875: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88 www 2876:
2877: Returns a string containing a <select name='$name' size='1'> form to
1.970 raeburn 2878: allow a user to select options from a ref to a hash containing:
2879: option_name => displayed text. An optional $onchange can include
1.1254 raeburn 2880: a javascript onchange item, e.g., onchange="this.form.submit();".
2881: An optional arg -- $readonly -- if true will cause the select form
2882: to be disabled, e.g., for the case where an instructor has a section-
2883: specific role, and is viewing/modifying parameters.
1.970 raeburn 2884:
1.88 www 2885: See lonrights.pm for an example invocation and use.
2886:
2887: =cut
2888:
2889: #-------------------------------------------
2890: sub select_form {
1.1228 raeburn 2891: my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970 raeburn 2892: return unless (ref($hashref) eq 'HASH');
2893: if ($onchange) {
2894: $onchange = ' onchange="'.$onchange.'"';
2895: }
1.1228 raeburn 2896: my $disabled;
2897: if ($readonly) {
2898: $disabled = ' disabled="disabled"';
2899: }
2900: my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128 albertel 2901: my @keys;
1.970 raeburn 2902: if (exists($hashref->{'select_form_order'})) {
2903: @keys=@{$hashref->{'select_form_order'}};
1.128 albertel 2904: } else {
1.970 raeburn 2905: @keys=sort(keys(%{$hashref}));
1.128 albertel 2906: }
1.356 albertel 2907: foreach my $key (@keys) {
2908: $selectform.=
2909: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
2910: ($key eq $def ? 'selected="selected" ' : '').
1.970 raeburn 2911: ">".$hashref->{$key}."</option>\n";
1.88 www 2912: }
2913: $selectform.="</select>";
2914: return $selectform;
2915: }
2916:
1.475 www 2917: # For display filters
2918:
2919: sub display_filter {
1.1074 raeburn 2920: my ($context) = @_;
1.475 www 2921: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 2922: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074 raeburn 2923: my $phraseinput = 'hidden';
2924: my $includeinput = 'hidden';
2925: my ($checked,$includetypestext);
2926: if ($env{'form.displayfilter'} eq 'containing') {
2927: $phraseinput = 'text';
2928: if ($context eq 'parmslog') {
2929: $includeinput = 'checkbox';
2930: if ($env{'form.includetypes'}) {
2931: $checked = ' checked="checked"';
2932: }
2933: $includetypestext = &mt('Include parameter types');
2934: }
2935: } else {
2936: $includetypestext = ' ';
2937: }
2938: my ($additional,$secondid,$thirdid);
2939: if ($context eq 'parmslog') {
2940: $additional =
2941: '<label><input type="'.$includeinput.'" name="includetypes"'.
2942: $checked.' name="includetypes" value="1" id="includetypes" />'.
2943: ' <span id="includetypestext">'.$includetypestext.'</span>'.
2944: '</label>';
2945: $secondid = 'includetypes';
2946: $thirdid = 'includetypestext';
2947: }
2948: my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
2949: '$secondid','$thirdid')";
2950: return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403 raeburn 2951: &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475 www 2952: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 2953: '</label></span> <span class="LC_nobreak">'.
1.1074 raeburn 2954: &mt('Filter: [_1]',
1.477 www 2955: &select_form($env{'form.displayfilter'},
2956: 'displayfilter',
1.970 raeburn 2957: {'currentfolder' => 'Current folder/page',
1.477 www 2958: 'containing' => 'Containing phrase',
1.1074 raeburn 2959: 'none' => 'None'},$onchange)).' '.
2960: '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
2961: &HTML::Entities::encode($env{'form.containingphrase'}).
2962: '" />'.$additional;
2963: }
2964:
2965: sub display_filter_js {
2966: my $includetext = &mt('Include parameter types');
2967: return <<"ENDJS";
2968:
2969: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
2970: var firstType = 'hidden';
2971: if (setter.options[setter.selectedIndex].value == 'containing') {
2972: firstType = 'text';
2973: }
2974: firstObject = document.getElementById(firstid);
2975: if (typeof(firstObject) == 'object') {
2976: if (firstObject.type != firstType) {
2977: changeInputType(firstObject,firstType);
2978: }
2979: }
2980: if (context == 'parmslog') {
2981: var secondType = 'hidden';
2982: if (firstType == 'text') {
2983: secondType = 'checkbox';
2984: }
2985: secondObject = document.getElementById(secondid);
2986: if (typeof(secondObject) == 'object') {
2987: if (secondObject.type != secondType) {
2988: changeInputType(secondObject,secondType);
2989: }
2990: }
2991: var textItem = document.getElementById(thirdid);
2992: var currtext = textItem.innerHTML;
2993: var newtext;
2994: if (firstType == 'text') {
2995: newtext = '$includetext';
2996: } else {
2997: newtext = ' ';
2998: }
2999: if (currtext != newtext) {
3000: textItem.innerHTML = newtext;
3001: }
3002: }
3003: return;
3004: }
3005:
3006: function changeInputType(oldObject,newType) {
3007: var newObject = document.createElement('input');
3008: newObject.type = newType;
3009: if (oldObject.size) {
3010: newObject.size = oldObject.size;
3011: }
3012: if (oldObject.value) {
3013: newObject.value = oldObject.value;
3014: }
3015: if (oldObject.name) {
3016: newObject.name = oldObject.name;
3017: }
3018: if (oldObject.id) {
3019: newObject.id = oldObject.id;
3020: }
3021: oldObject.parentNode.replaceChild(newObject,oldObject);
3022: return;
3023: }
3024:
3025: ENDJS
1.475 www 3026: }
3027:
1.167 www 3028: sub gradeleveldescription {
3029: my $gradelevel=shift;
3030: my %gradelevels=(0 => 'Not specified',
3031: 1 => 'Grade 1',
3032: 2 => 'Grade 2',
3033: 3 => 'Grade 3',
3034: 4 => 'Grade 4',
3035: 5 => 'Grade 5',
3036: 6 => 'Grade 6',
3037: 7 => 'Grade 7',
3038: 8 => 'Grade 8',
3039: 9 => 'Grade 9',
3040: 10 => 'Grade 10',
3041: 11 => 'Grade 11',
3042: 12 => 'Grade 12',
3043: 13 => 'Grade 13',
3044: 14 => '100 Level',
3045: 15 => '200 Level',
3046: 16 => '300 Level',
3047: 17 => '400 Level',
3048: 18 => 'Graduate Level');
3049: return &mt($gradelevels{$gradelevel});
3050: }
3051:
1.163 www 3052: sub select_level_form {
3053: my ($deflevel,$name)=@_;
3054: unless ($deflevel) { $deflevel=0; }
1.167 www 3055: my $selectform = "<select name=\"$name\" size=\"1\">\n";
3056: for (my $i=0; $i<=18; $i++) {
3057: $selectform.="<option value=\"$i\" ".
1.253 albertel 3058: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 3059: ">".&gradeleveldescription($i)."</option>\n";
3060: }
3061: $selectform.="</select>";
3062: return $selectform;
1.163 www 3063: }
1.167 www 3064:
1.35 matthew 3065: #-------------------------------------------
3066:
1.45 matthew 3067: =pod
3068:
1.1256 raeburn 3069: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35 matthew 3070:
3071: Returns a string containing a <select name='$name' size='1'> form to
3072: allow a user to select the domain to preform an operation in.
3073: See loncreateuser.pm for an example invocation and use.
3074:
1.90 www 3075: If the $includeempty flag is set, it also includes an empty choice ("no domain
3076: selected");
3077:
1.743 raeburn 3078: If the $showdomdesc flag is set, the domain name is followed by the domain description.
3079:
1.910 raeburn 3080: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
3081:
1.1121 raeburn 3082: The optional $incdoms is a reference to an array of domains which will be the only available options.
3083:
3084: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563 raeburn 3085:
1.1256 raeburn 3086: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
3087:
1.35 matthew 3088: =cut
3089:
3090: #-------------------------------------------
1.34 matthew 3091: sub select_dom_form {
1.1256 raeburn 3092: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872 raeburn 3093: if ($onchange) {
1.874 raeburn 3094: $onchange = ' onchange="'.$onchange.'"';
1.743 raeburn 3095: }
1.1256 raeburn 3096: if ($disabled) {
3097: $disabled = ' disabled="disabled"';
3098: }
1.1121 raeburn 3099: my (@domains,%exclude);
1.910 raeburn 3100: if (ref($incdoms) eq 'ARRAY') {
3101: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
3102: } else {
3103: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
3104: }
1.90 www 3105: if ($includeempty) { @domains=('',@domains); }
1.1121 raeburn 3106: if (ref($excdoms) eq 'ARRAY') {
3107: map { $exclude{$_} = 1; } @{$excdoms};
3108: }
1.1256 raeburn 3109: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356 albertel 3110: foreach my $dom (@domains) {
1.1121 raeburn 3111: next if ($exclude{$dom});
1.356 albertel 3112: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 3113: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
3114: if ($showdomdesc) {
3115: if ($dom ne '') {
3116: my $domdesc = &Apache::lonnet::domain($dom,'description');
3117: if ($domdesc ne '') {
3118: $selectdomain .= ' ('.$domdesc.')';
3119: }
3120: }
3121: }
3122: $selectdomain .= "</option>\n";
1.34 matthew 3123: }
3124: $selectdomain.="</select>";
3125: return $selectdomain;
3126: }
3127:
1.35 matthew 3128: #-------------------------------------------
3129:
1.45 matthew 3130: =pod
3131:
1.648 raeburn 3132: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 3133:
1.586 raeburn 3134: input: 4 arguments (two required, two optional) -
3135: $domain - domain of new user
3136: $name - name of form element
3137: $default - Value of 'default' causes a default item to be first
3138: option, and selected by default.
3139: $hide - Value of 'hide' causes hiding of the name of the server,
3140: if 1 server found, or default, if 0 found.
1.594 raeburn 3141: output: returns 2 items:
1.586 raeburn 3142: (a) form element which contains either:
3143: (i) <select name="$name">
3144: <option value="$hostid1">$hostid $servers{$hostid}</option>
3145: <option value="$hostid2">$hostid $servers{$hostid}</option>
3146: </select>
3147: form item if there are multiple library servers in $domain, or
3148: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
3149: if there is only one library server in $domain.
3150:
3151: (b) number of library servers found.
3152:
3153: See loncreateuser.pm for example of use.
1.35 matthew 3154:
3155: =cut
3156:
3157: #-------------------------------------------
1.586 raeburn 3158: sub home_server_form_item {
3159: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 3160: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 3161: my $result;
3162: my $numlib = keys(%servers);
3163: if ($numlib > 1) {
3164: $result .= '<select name="'.$name.'" />'."\n";
3165: if ($default) {
1.804 bisitz 3166: $result .= '<option value="default" selected="selected">'.&mt('default').
1.586 raeburn 3167: '</option>'."\n";
3168: }
3169: foreach my $hostid (sort(keys(%servers))) {
3170: $result.= '<option value="'.$hostid.'">'.
3171: $hostid.' '.$servers{$hostid}."</option>\n";
3172: }
3173: $result .= '</select>'."\n";
3174: } elsif ($numlib == 1) {
3175: my $hostid;
3176: foreach my $item (keys(%servers)) {
3177: $hostid = $item;
3178: }
3179: $result .= '<input type="hidden" name="'.$name.'" value="'.
3180: $hostid.'" />';
3181: if (!$hide) {
3182: $result .= $hostid.' '.$servers{$hostid};
3183: }
3184: $result .= "\n";
3185: } elsif ($default) {
3186: $result .= '<input type="hidden" name="'.$name.
3187: '" value="default" />';
3188: if (!$hide) {
3189: $result .= &mt('default');
3190: }
3191: $result .= "\n";
1.33 matthew 3192: }
1.586 raeburn 3193: return ($result,$numlib);
1.33 matthew 3194: }
1.112 bowersj2 3195:
3196: =pod
3197:
1.534 albertel 3198: =back
3199:
1.112 bowersj2 3200: =cut
1.87 matthew 3201:
3202: ###############################################################
1.112 bowersj2 3203: ## Decoding User Agent ##
1.87 matthew 3204: ###############################################################
3205:
3206: =pod
3207:
1.112 bowersj2 3208: =head1 Decoding the User Agent
3209:
3210: =over 4
3211:
3212: =item * &decode_user_agent()
1.87 matthew 3213:
3214: Inputs: $r
3215:
3216: Outputs:
3217:
3218: =over 4
3219:
1.112 bowersj2 3220: =item * $httpbrowser
1.87 matthew 3221:
1.112 bowersj2 3222: =item * $clientbrowser
1.87 matthew 3223:
1.112 bowersj2 3224: =item * $clientversion
1.87 matthew 3225:
1.112 bowersj2 3226: =item * $clientmathml
1.87 matthew 3227:
1.112 bowersj2 3228: =item * $clientunicode
1.87 matthew 3229:
1.112 bowersj2 3230: =item * $clientos
1.87 matthew 3231:
1.1137 raeburn 3232: =item * $clientmobile
3233:
1.1141 raeburn 3234: =item * $clientinfo
3235:
1.1194 raeburn 3236: =item * $clientosversion
3237:
1.87 matthew 3238: =back
3239:
1.157 matthew 3240: =back
3241:
1.87 matthew 3242: =cut
3243:
3244: ###############################################################
3245: ###############################################################
3246: sub decode_user_agent {
1.247 albertel 3247: my ($r)=@_;
1.87 matthew 3248: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
3249: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
3250: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 3251: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 3252: my $clientbrowser='unknown';
3253: my $clientversion='0';
3254: my $clientmathml='';
3255: my $clientunicode='0';
1.1137 raeburn 3256: my $clientmobile=0;
1.1194 raeburn 3257: my $clientosversion='';
1.87 matthew 3258: for (my $i=0;$i<=$#browsertype;$i++) {
1.1193 raeburn 3259: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87 matthew 3260: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
3261: $clientbrowser=$bname;
3262: $httpbrowser=~/$vreg/i;
3263: $clientversion=$1;
3264: $clientmathml=($clientversion>=$minv);
3265: $clientunicode=($clientversion>=$univ);
3266: }
3267: }
3268: my $clientos='unknown';
1.1141 raeburn 3269: my $clientinfo;
1.87 matthew 3270: if (($httpbrowser=~/linux/i) ||
3271: ($httpbrowser=~/unix/i) ||
3272: ($httpbrowser=~/ux/i) ||
3273: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
3274: if (($httpbrowser=~/vax/i) ||
3275: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
3276: if ($httpbrowser=~/next/i) { $clientos='next'; }
3277: if (($httpbrowser=~/mac/i) ||
3278: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194 raeburn 3279: if ($httpbrowser=~/win/i) {
3280: $clientos='win';
3281: if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
3282: $clientosversion = $1;
3283: }
3284: }
1.87 matthew 3285: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137 raeburn 3286: if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
3287: $clientmobile=lc($1);
3288: }
1.1141 raeburn 3289: if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
3290: $clientinfo = 'firefox-'.$1;
3291: } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
3292: $clientinfo = 'chromeframe-'.$1;
3293: }
1.87 matthew 3294: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194 raeburn 3295: $clientunicode,$clientos,$clientmobile,$clientinfo,
3296: $clientosversion);
1.87 matthew 3297: }
3298:
1.32 matthew 3299: ###############################################################
3300: ## Authentication changing form generation subroutines ##
3301: ###############################################################
3302: ##
3303: ## All of the authform_xxxxxxx subroutines take their inputs in a
3304: ## hash, and have reasonable default values.
3305: ##
3306: ## formname = the name given in the <form> tag.
1.35 matthew 3307: #-------------------------------------------
3308:
1.45 matthew 3309: =pod
3310:
1.112 bowersj2 3311: =head1 Authentication Routines
3312:
3313: =over 4
3314:
1.648 raeburn 3315: =item * &authform_xxxxxx()
1.35 matthew 3316:
3317: The authform_xxxxxx subroutines provide javascript and html forms which
3318: handle some of the conveniences required for authentication forms.
3319: This is not an optimal method, but it works.
3320:
3321: =over 4
3322:
1.112 bowersj2 3323: =item * authform_header
1.35 matthew 3324:
1.112 bowersj2 3325: =item * authform_authorwarning
1.35 matthew 3326:
1.112 bowersj2 3327: =item * authform_nochange
1.35 matthew 3328:
1.112 bowersj2 3329: =item * authform_kerberos
1.35 matthew 3330:
1.112 bowersj2 3331: =item * authform_internal
1.35 matthew 3332:
1.112 bowersj2 3333: =item * authform_filesystem
1.35 matthew 3334:
1.1310 raeburn 3335: =item * authform_lti
3336:
1.35 matthew 3337: =back
3338:
1.648 raeburn 3339: See loncreateuser.pm for invocation and use examples.
1.157 matthew 3340:
1.35 matthew 3341: =cut
3342:
3343: #-------------------------------------------
1.32 matthew 3344: sub authform_header{
3345: my %in = (
3346: formname => 'cu',
1.80 albertel 3347: kerb_def_dom => '',
1.32 matthew 3348: @_,
3349: );
3350: $in{'formname'} = 'document.' . $in{'formname'};
3351: my $result='';
1.80 albertel 3352:
3353: #---------------------------------------------- Code for upper case translation
3354: my $Javascript_toUpperCase;
3355: unless ($in{kerb_def_dom}) {
3356: $Javascript_toUpperCase =<<"END";
3357: switch (choice) {
3358: case 'krb': currentform.elements[choicearg].value =
3359: currentform.elements[choicearg].value.toUpperCase();
3360: break;
3361: default:
3362: }
3363: END
3364: } else {
3365: $Javascript_toUpperCase = "";
3366: }
3367:
1.165 raeburn 3368: my $radioval = "'nochange'";
1.591 raeburn 3369: if (defined($in{'curr_authtype'})) {
3370: if ($in{'curr_authtype'} ne '') {
3371: $radioval = "'".$in{'curr_authtype'}."arg'";
3372: }
1.174 matthew 3373: }
1.165 raeburn 3374: my $argfield = 'null';
1.591 raeburn 3375: if (defined($in{'mode'})) {
1.165 raeburn 3376: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 3377: if (defined($in{'curr_autharg'})) {
3378: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 3379: $argfield = "'$in{'curr_autharg'}'";
3380: }
3381: }
3382: }
3383: }
3384:
1.32 matthew 3385: $result.=<<"END";
3386: var current = new Object();
1.165 raeburn 3387: current.radiovalue = $radioval;
3388: current.argfield = $argfield;
1.32 matthew 3389:
3390: function changed_radio(choice,currentform) {
3391: var choicearg = choice + 'arg';
3392: // If a radio button in changed, we need to change the argfield
3393: if (current.radiovalue != choice) {
3394: current.radiovalue = choice;
3395: if (current.argfield != null) {
3396: currentform.elements[current.argfield].value = '';
3397: }
3398: if (choice == 'nochange') {
3399: current.argfield = null;
3400: } else {
3401: current.argfield = choicearg;
3402: switch(choice) {
3403: case 'krb':
3404: currentform.elements[current.argfield].value =
3405: "$in{'kerb_def_dom'}";
3406: break;
3407: default:
3408: break;
3409: }
3410: }
3411: }
3412: return;
3413: }
1.22 www 3414:
1.32 matthew 3415: function changed_text(choice,currentform) {
3416: var choicearg = choice + 'arg';
3417: if (currentform.elements[choicearg].value !='') {
1.80 albertel 3418: $Javascript_toUpperCase
1.32 matthew 3419: // clear old field
3420: if ((current.argfield != choicearg) && (current.argfield != null)) {
3421: currentform.elements[current.argfield].value = '';
3422: }
3423: current.argfield = choicearg;
3424: }
3425: set_auth_radio_buttons(choice,currentform);
3426: return;
1.20 www 3427: }
1.32 matthew 3428:
3429: function set_auth_radio_buttons(newvalue,currentform) {
1.986 raeburn 3430: var numauthchoices = currentform.login.length;
3431: if (typeof numauthchoices == "undefined") {
3432: return;
3433: }
1.32 matthew 3434: var i=0;
1.986 raeburn 3435: while (i < numauthchoices) {
1.32 matthew 3436: if (currentform.login[i].value == newvalue) { break; }
3437: i++;
3438: }
1.986 raeburn 3439: if (i == numauthchoices) {
1.32 matthew 3440: return;
3441: }
3442: current.radiovalue = newvalue;
3443: currentform.login[i].checked = true;
3444: return;
3445: }
3446: END
3447: return $result;
3448: }
3449:
1.1106 raeburn 3450: sub authform_authorwarning {
1.32 matthew 3451: my $result='';
1.144 matthew 3452: $result='<i>'.
3453: &mt('As a general rule, only authors or co-authors should be '.
3454: 'filesystem authenticated '.
3455: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 3456: return $result;
3457: }
3458:
1.1106 raeburn 3459: sub authform_nochange {
1.32 matthew 3460: my %in = (
3461: formname => 'document.cu',
3462: kerb_def_dom => 'MSU.EDU',
3463: @_,
3464: );
1.1106 raeburn 3465: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586 raeburn 3466: my $result;
1.1104 raeburn 3467: if (!$authnum) {
1.1105 raeburn 3468: $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586 raeburn 3469: } else {
3470: $result = '<label>'.&mt('[_1] Do not change login data',
3471: '<input type="radio" name="login" value="nochange" '.
3472: 'checked="checked" onclick="'.
1.281 albertel 3473: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
3474: '</label>';
1.586 raeburn 3475: }
1.32 matthew 3476: return $result;
3477: }
3478:
1.591 raeburn 3479: sub authform_kerberos {
1.32 matthew 3480: my %in = (
3481: formname => 'document.cu',
3482: kerb_def_dom => 'MSU.EDU',
1.80 albertel 3483: kerb_def_auth => 'krb4',
1.32 matthew 3484: @_,
3485: );
1.586 raeburn 3486: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259 raeburn 3487: $autharg,$jscall,$disabled);
1.1106 raeburn 3488: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 3489: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 3490: $check5 = ' checked="checked"';
1.80 albertel 3491: } else {
1.772 bisitz 3492: $check4 = ' checked="checked"';
1.80 albertel 3493: }
1.1259 raeburn 3494: if ($in{'readonly'}) {
3495: $disabled = ' disabled="disabled"';
3496: }
1.165 raeburn 3497: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 3498: if (defined($in{'curr_authtype'})) {
3499: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 3500: $krbcheck = ' checked="checked"';
1.623 raeburn 3501: if (defined($in{'mode'})) {
3502: if ($in{'mode'} eq 'modifyuser') {
3503: $krbcheck = '';
3504: }
3505: }
1.591 raeburn 3506: if (defined($in{'curr_kerb_ver'})) {
3507: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 3508: $check5 = ' checked="checked"';
1.591 raeburn 3509: $check4 = '';
3510: } else {
1.772 bisitz 3511: $check4 = ' checked="checked"';
1.591 raeburn 3512: $check5 = '';
3513: }
1.586 raeburn 3514: }
1.591 raeburn 3515: if (defined($in{'curr_autharg'})) {
1.165 raeburn 3516: $krbarg = $in{'curr_autharg'};
3517: }
1.586 raeburn 3518: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 3519: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3520: $result =
3521: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
3522: $in{'curr_autharg'},$krbver);
3523: } else {
3524: $result =
3525: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
3526: }
3527: return $result;
3528: }
3529: }
3530: } else {
3531: if ($authnum == 1) {
1.784 bisitz 3532: $authtype = '<input type="hidden" name="login" value="krb" />';
1.165 raeburn 3533: }
3534: }
1.586 raeburn 3535: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
3536: return;
1.587 raeburn 3537: } elsif ($authtype eq '') {
1.591 raeburn 3538: if (defined($in{'mode'})) {
1.587 raeburn 3539: if ($in{'mode'} eq 'modifycourse') {
3540: if ($authnum == 1) {
1.1259 raeburn 3541: $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587 raeburn 3542: }
3543: }
3544: }
1.586 raeburn 3545: }
3546: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
3547: if ($authtype eq '') {
3548: $authtype = '<input type="radio" name="login" value="krb" '.
3549: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259 raeburn 3550: $krbcheck.$disabled.' />';
1.586 raeburn 3551: }
3552: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106 raeburn 3553: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586 raeburn 3554: $in{'curr_authtype'} eq 'krb5') ||
1.1106 raeburn 3555: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586 raeburn 3556: $in{'curr_authtype'} eq 'krb4')) {
3557: $result .= &mt
1.144 matthew 3558: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 3559: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 3560: '<label>'.$authtype,
1.281 albertel 3561: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 3562: 'value="'.$krbarg.'" '.
1.1259 raeburn 3563: 'onchange="'.$jscall.'"'.$disabled.' />',
3564: '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
3565: '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281 albertel 3566: '</label>');
1.586 raeburn 3567: } elsif ($can_assign{'krb4'}) {
3568: $result .= &mt
3569: ('[_1] Kerberos authenticated with domain [_2] '.
3570: '[_3] Version 4 [_4]',
3571: '<label>'.$authtype,
3572: '</label><input type="text" size="10" name="krbarg" '.
3573: 'value="'.$krbarg.'" '.
1.1259 raeburn 3574: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3575: '<label><input type="hidden" name="krbver" value="4" />',
3576: '</label>');
3577: } elsif ($can_assign{'krb5'}) {
3578: $result .= &mt
3579: ('[_1] Kerberos authenticated with domain [_2] '.
3580: '[_3] Version 5 [_4]',
3581: '<label>'.$authtype,
3582: '</label><input type="text" size="10" name="krbarg" '.
3583: 'value="'.$krbarg.'" '.
1.1259 raeburn 3584: 'onchange="'.$jscall.'"'.$disabled.' />',
1.586 raeburn 3585: '<label><input type="hidden" name="krbver" value="5" />',
3586: '</label>');
3587: }
1.32 matthew 3588: return $result;
3589: }
3590:
1.1106 raeburn 3591: sub authform_internal {
1.586 raeburn 3592: my %in = (
1.32 matthew 3593: formname => 'document.cu',
3594: kerb_def_dom => 'MSU.EDU',
3595: @_,
3596: );
1.1259 raeburn 3597: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3598: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3599: if ($in{'readonly'}) {
3600: $disabled = ' disabled="disabled"';
3601: }
1.591 raeburn 3602: if (defined($in{'curr_authtype'})) {
3603: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 3604: if ($can_assign{'int'}) {
1.772 bisitz 3605: $intcheck = 'checked="checked" ';
1.623 raeburn 3606: if (defined($in{'mode'})) {
3607: if ($in{'mode'} eq 'modifyuser') {
3608: $intcheck = '';
3609: }
3610: }
1.591 raeburn 3611: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3612: $intarg = $in{'curr_autharg'};
3613: }
3614: } else {
3615: $result = &mt('Currently internally authenticated.');
3616: return $result;
1.165 raeburn 3617: }
3618: }
1.586 raeburn 3619: } else {
3620: if ($authnum == 1) {
1.784 bisitz 3621: $authtype = '<input type="hidden" name="login" value="int" />';
1.586 raeburn 3622: }
3623: }
3624: if (!$can_assign{'int'}) {
3625: return;
1.587 raeburn 3626: } elsif ($authtype eq '') {
1.591 raeburn 3627: if (defined($in{'mode'})) {
1.587 raeburn 3628: if ($in{'mode'} eq 'modifycourse') {
3629: if ($authnum == 1) {
1.1259 raeburn 3630: $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587 raeburn 3631: }
3632: }
3633: }
1.165 raeburn 3634: }
1.586 raeburn 3635: $jscall = "javascript:changed_radio('int',$in{'formname'});";
3636: if ($authtype eq '') {
3637: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259 raeburn 3638: ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3639: }
1.605 bisitz 3640: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259 raeburn 3641: $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3642: $result = &mt
1.144 matthew 3643: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 3644: '<label>'.$authtype,'</label>'.$autharg);
1.1259 raeburn 3645: $result.='<label><input type="checkbox" name="visible" onclick="if (this.checked) { this.form.intarg.type='."'text'".' } else { this.form.intarg.type='."'password'".' }"'.$disabled.' />'.&mt('Visible input').'</label>';
1.32 matthew 3646: return $result;
3647: }
3648:
1.1104 raeburn 3649: sub authform_local {
1.32 matthew 3650: my %in = (
3651: formname => 'document.cu',
3652: kerb_def_dom => 'MSU.EDU',
3653: @_,
3654: );
1.1259 raeburn 3655: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3656: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3657: if ($in{'readonly'}) {
3658: $disabled = ' disabled="disabled"';
3659: }
1.591 raeburn 3660: if (defined($in{'curr_authtype'})) {
3661: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 3662: if ($can_assign{'loc'}) {
1.772 bisitz 3663: $loccheck = 'checked="checked" ';
1.623 raeburn 3664: if (defined($in{'mode'})) {
3665: if ($in{'mode'} eq 'modifyuser') {
3666: $loccheck = '';
3667: }
3668: }
1.591 raeburn 3669: if (defined($in{'curr_autharg'})) {
1.586 raeburn 3670: $locarg = $in{'curr_autharg'};
3671: }
3672: } else {
3673: $result = &mt('Currently using local (institutional) authentication.');
3674: return $result;
1.165 raeburn 3675: }
3676: }
1.586 raeburn 3677: } else {
3678: if ($authnum == 1) {
1.784 bisitz 3679: $authtype = '<input type="hidden" name="login" value="loc" />';
1.586 raeburn 3680: }
3681: }
3682: if (!$can_assign{'loc'}) {
3683: return;
1.587 raeburn 3684: } elsif ($authtype eq '') {
1.591 raeburn 3685: if (defined($in{'mode'})) {
1.587 raeburn 3686: if ($in{'mode'} eq 'modifycourse') {
3687: if ($authnum == 1) {
1.1259 raeburn 3688: $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587 raeburn 3689: }
3690: }
3691: }
1.165 raeburn 3692: }
1.586 raeburn 3693: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
3694: if ($authtype eq '') {
3695: $authtype = '<input type="radio" name="login" value="loc" '.
3696: $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3697: $jscall.'"'.$disabled.' />';
1.586 raeburn 3698: }
3699: $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259 raeburn 3700: $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3701: $result = &mt('[_1] Local Authentication with argument [_2]',
3702: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 3703: return $result;
3704: }
3705:
1.1106 raeburn 3706: sub authform_filesystem {
1.32 matthew 3707: my %in = (
3708: formname => 'document.cu',
3709: kerb_def_dom => 'MSU.EDU',
3710: @_,
3711: );
1.1259 raeburn 3712: my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106 raeburn 3713: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259 raeburn 3714: if ($in{'readonly'}) {
3715: $disabled = ' disabled="disabled"';
3716: }
1.591 raeburn 3717: if (defined($in{'curr_authtype'})) {
3718: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 3719: if ($can_assign{'fsys'}) {
1.772 bisitz 3720: $fsyscheck = 'checked="checked" ';
1.623 raeburn 3721: if (defined($in{'mode'})) {
3722: if ($in{'mode'} eq 'modifyuser') {
3723: $fsyscheck = '';
3724: }
3725: }
1.586 raeburn 3726: } else {
3727: $result = &mt('Currently Filesystem Authenticated.');
3728: return $result;
1.1259 raeburn 3729: }
1.586 raeburn 3730: }
3731: } else {
3732: if ($authnum == 1) {
1.784 bisitz 3733: $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586 raeburn 3734: }
3735: }
3736: if (!$can_assign{'fsys'}) {
3737: return;
1.587 raeburn 3738: } elsif ($authtype eq '') {
1.591 raeburn 3739: if (defined($in{'mode'})) {
1.587 raeburn 3740: if ($in{'mode'} eq 'modifycourse') {
3741: if ($authnum == 1) {
1.1259 raeburn 3742: $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587 raeburn 3743: }
3744: }
3745: }
1.586 raeburn 3746: }
3747: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
3748: if ($authtype eq '') {
3749: $authtype = '<input type="radio" name="login" value="fsys" '.
3750: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259 raeburn 3751: $jscall.'"'.$disabled.' />';
1.586 raeburn 3752: }
1.1310 raeburn 3753: $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259 raeburn 3754: ' onchange="'.$jscall.'"'.$disabled.' />';
1.586 raeburn 3755: $result = &mt
1.144 matthew 3756: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310 raeburn 3757: '<label>'.$authtype,'</label>'.$autharg);
3758: return $result;
3759: }
3760:
3761: sub authform_lti {
3762: my %in = (
3763: formname => 'document.cu',
3764: kerb_def_dom => 'MSU.EDU',
3765: @_,
3766: );
3767: my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
3768: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
3769: if ($in{'readonly'}) {
3770: $disabled = ' disabled="disabled"';
3771: }
3772: if (defined($in{'curr_authtype'})) {
3773: if ($in{'curr_authtype'} eq 'lti') {
3774: if ($can_assign{'lti'}) {
3775: $lticheck = 'checked="checked" ';
3776: if (defined($in{'mode'})) {
3777: if ($in{'mode'} eq 'modifyuser') {
3778: $lticheck = '';
3779: }
3780: }
3781: } else {
3782: $result = &mt('Currently LTI Authenticated.');
3783: return $result;
3784: }
3785: }
3786: } else {
3787: if ($authnum == 1) {
3788: $authtype = '<input type="hidden" name="login" value="lti" />';
3789: }
3790: }
3791: if (!$can_assign{'lti'}) {
3792: return;
3793: } elsif ($authtype eq '') {
3794: if (defined($in{'mode'})) {
3795: if ($in{'mode'} eq 'modifycourse') {
3796: if ($authnum == 1) {
3797: $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
3798: }
3799: }
3800: }
3801: }
3802: $jscall = "javascript:changed_radio('lti',$in{'formname'});";
3803: if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
3804: $authtype = '<input type="radio" name="login" value="lti" '.
3805: $lticheck.' onchange="'.$jscall.'" onclick="'.
3806: $jscall.'"'.$disabled.' />';
3807: }
3808: $autharg = '<input type="hidden" name="ltiarg" value="" />';
3809: if ($authtype) {
3810: $result = &mt('[_1] LTI Authenticated',
3811: '<label>'.$authtype.'</label>'.$autharg);
3812: } else {
3813: $result = '<b>'.&mt('LTI Authenticated').'</b>'.
3814: $autharg;
3815: }
1.32 matthew 3816: return $result;
3817: }
3818:
1.586 raeburn 3819: sub get_assignable_auth {
3820: my ($dom) = @_;
3821: if ($dom eq '') {
3822: $dom = $env{'request.role.domain'};
3823: }
3824: my %can_assign = (
3825: krb4 => 1,
3826: krb5 => 1,
3827: int => 1,
3828: loc => 1,
1.1310 raeburn 3829: lti => 1,
1.586 raeburn 3830: );
3831: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
3832: if (ref($domconfig{'usercreation'}) eq 'HASH') {
3833: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
3834: my $authhash = $domconfig{'usercreation'}{'authtypes'};
3835: my $context;
3836: if ($env{'request.role'} =~ /^au/) {
3837: $context = 'author';
1.1259 raeburn 3838: } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586 raeburn 3839: $context = 'domain';
3840: } elsif ($env{'request.course.id'}) {
3841: $context = 'course';
3842: }
3843: if ($context) {
3844: if (ref($authhash->{$context}) eq 'HASH') {
3845: %can_assign = %{$authhash->{$context}};
3846: }
3847: }
3848: }
3849: }
3850: my $authnum = 0;
3851: foreach my $key (keys(%can_assign)) {
3852: if ($can_assign{$key}) {
3853: $authnum ++;
3854: }
3855: }
3856: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
3857: $authnum --;
3858: }
3859: return ($authnum,%can_assign);
3860: }
3861:
1.1331 raeburn 3862: sub check_passwd_rules {
3863: my ($domain,$plainpass) = @_;
3864: my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3865: my ($min,$max,@chars,@brokerule,$warning);
1.1333 raeburn 3866: $min = $Apache::lonnet::passwdmin;
1.1331 raeburn 3867: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3868: if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333 raeburn 3869: if ($passwdconf{'min'} > $min) {
3870: $min = $passwdconf{'min'};
3871: }
1.1331 raeburn 3872: }
3873: if ($passwdconf{'max'} =~ /^\d+$/) {
3874: $max = $passwdconf{'max'};
3875: }
3876: @chars = @{$passwdconf{'chars'}};
3877: }
3878: if (($min) && (length($plainpass) < $min)) {
3879: push(@brokerule,'min');
3880: }
3881: if (($max) && (length($plainpass) > $max)) {
3882: push(@brokerule,'max');
3883: }
3884: if (@chars) {
3885: my %rules;
3886: map { $rules{$_} = 1; } @chars;
3887: if ($rules{'uc'}) {
3888: unless ($plainpass =~ /[A-Z]/) {
3889: push(@brokerule,'uc');
3890: }
3891: }
3892: if ($rules{'lc'}) {
1.1332 raeburn 3893: unless ($plainpass =~ /[a-z]/) {
1.1331 raeburn 3894: push(@brokerule,'lc');
3895: }
3896: }
3897: if ($rules{'num'}) {
3898: unless ($plainpass =~ /\d/) {
3899: push(@brokerule,'num');
3900: }
3901: }
3902: if ($rules{'spec'}) {
3903: unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
3904: push(@brokerule,'spec');
3905: }
3906: }
3907: }
3908: if (@brokerule) {
3909: my %rulenames = &Apache::lonlocal::texthash(
3910: uc => 'At least one upper case letter',
3911: lc => 'At least one lower case letter',
3912: num => 'At least one number',
3913: spec => 'At least one non-alphanumeric',
3914: );
3915: $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3916: $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
3917: $rulenames{'num'} .= ': 0123456789';
3918: $rulenames{'spec'} .= ': !"\#$%&\'()*+,-./:;<=>?@[\]^_\`{|}~';
3919: $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
3920: $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
3921: $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336 raeburn 3922: foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331 raeburn 3923: if (grep(/^$rule$/,@brokerule)) {
3924: $warning .= '<li>'.$rulenames{$rule}.'</li>';
3925: }
3926: }
3927: $warning .= '</ul>';
3928: }
1.1332 raeburn 3929: if (wantarray) {
3930: return @brokerule;
3931: }
1.1331 raeburn 3932: return $warning;
3933: }
3934:
1.1376 raeburn 3935: sub passwd_validation_js {
1.1377 raeburn 3936: my ($currpasswdval,$domain,$context,$id) = @_;
3937: my (%passwdconf,$alertmsg);
3938: if ($context eq 'linkprot') {
3939: my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
3940: if (ref($domconfig{'ltisec'}) eq 'HASH') {
3941: if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
3942: %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
3943: }
3944: }
3945: if ($id eq 'add') {
3946: $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
3947: } elsif ($id =~ /^\d+$/) {
3948: my $pos = $id+1;
3949: $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
3950: } else {
3951: $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
3952: }
3953: } else {
3954: %passwdconf = &Apache::lonnet::get_passwdconf($domain);
3955: $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
3956: }
1.1376 raeburn 3957: my ($min,$max,@chars,$numrules,$intargjs,%alert);
3958: $numrules = 0;
3959: $min = $Apache::lonnet::passwdmin;
3960: if (ref($passwdconf{'chars'}) eq 'ARRAY') {
3961: if ($passwdconf{'min'} =~ /^\d+$/) {
3962: if ($passwdconf{'min'} > $min) {
3963: $min = $passwdconf{'min'};
3964: }
3965: }
3966: if ($passwdconf{'max'} =~ /^\d+$/) {
3967: $max = $passwdconf{'max'};
3968: $numrules ++;
3969: }
3970: @chars = @{$passwdconf{'chars'}};
3971: if (@chars) {
3972: $numrules ++;
3973: }
3974: }
3975: if ($min > 0) {
3976: $numrules ++;
3977: }
3978: if (($min > 0) || ($max ne '') || (@chars > 0)) {
3979: if ($min) {
3980: $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
3981: }
3982: if ($max) {
3983: $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
3984: }
3985: my (@charalerts,@charrules);
3986: if (@chars) {
3987: if (grep(/^uc$/,@chars)) {
3988: push(@charalerts,&mt('contain at least one upper case letter'));
3989: push(@charrules,'uc');
3990: }
3991: if (grep(/^lc$/,@chars)) {
3992: push(@charalerts,&mt('contain at least one lower case letter'));
3993: push(@charrules,'lc');
3994: }
3995: if (grep(/^num$/,@chars)) {
3996: push(@charalerts,&mt('contain at least one number'));
3997: push(@charrules,'num');
3998: }
3999: if (grep(/^spec$/,@chars)) {
4000: push(@charalerts,&mt('contain at least one non-alphanumeric'));
4001: push(@charrules,'spec');
4002: }
4003: }
4004: $intargjs = qq| var rulesmsg = '';\n|.
4005: qq| var currpwval = $currpasswdval;\n|;
4006: if ($min) {
4007: $intargjs .= qq|
4008: if (currpwval.length < $min) {
4009: rulesmsg += ' - $alert{min}';
4010: }
4011: |;
4012: }
4013: if ($max) {
4014: $intargjs .= qq|
4015: if (currpwval.length > $max) {
4016: rulesmsg += ' - $alert{max}';
4017: }
4018: |;
4019: }
4020: if (@chars > 0) {
4021: my $charrulestr = '"'.join('","',@charrules).'"';
4022: my $charalertstr = '"'.join('","',@charalerts).'"';
4023: $intargjs .= qq| var brokerules = new Array();\n|.
4024: qq| var charrules = new Array($charrulestr);\n|.
4025: qq| var charalerts = new Array($charalertstr);\n|;
4026: my %rules;
4027: map { $rules{$_} = 1; } @chars;
4028: if ($rules{'uc'}) {
4029: $intargjs .= qq|
4030: var ucRegExp = /[A-Z]/;
4031: if (!ucRegExp.test(currpwval)) {
4032: brokerules.push('uc');
4033: }
4034: |;
4035: }
4036: if ($rules{'lc'}) {
4037: $intargjs .= qq|
4038: var lcRegExp = /[a-z]/;
4039: if (!lcRegExp.test(currpwval)) {
4040: brokerules.push('lc');
4041: }
4042: |;
4043: }
4044: if ($rules{'num'}) {
4045: $intargjs .= qq|
4046: var numRegExp = /[0-9]/;
4047: if (!numRegExp.test(currpwval)) {
4048: brokerules.push('num');
4049: }
4050: |;
4051: }
4052: if ($rules{'spec'}) {
4053: $intargjs .= q|
4054: var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
4055: if (!specRegExp.test(currpwval)) {
4056: brokerules.push('spec');
4057: }
4058: |;
4059: }
4060: $intargjs .= qq|
4061: if (brokerules.length > 0) {
4062: for (var i=0; i<brokerules.length; i++) {
4063: for (var j=0; j<charrules.length; j++) {
4064: if (brokerules[i] == charrules[j]) {
4065: rulesmsg += ' - '+charalerts[j]+'\\n';
4066: break;
4067: }
4068: }
4069: }
4070: }
4071: |;
4072: }
4073: $intargjs .= qq|
4074: if (rulesmsg != '') {
4075: rulesmsg = '$alertmsg'+rulesmsg;
4076: alert(rulesmsg);
4077: return false;
4078: }
4079: |;
4080: }
4081: return ($numrules,$intargjs);
4082: }
4083:
1.80 albertel 4084: ###############################################################
4085: ## Get Kerberos Defaults for Domain ##
4086: ###############################################################
4087: ##
4088: ## Returns default kerberos version and an associated argument
4089: ## as listed in file domain.tab. If not listed, provides
4090: ## appropriate default domain and kerberos version.
4091: ##
4092: #-------------------------------------------
4093:
4094: =pod
4095:
1.648 raeburn 4096: =item * &get_kerberos_defaults()
1.80 albertel 4097:
4098: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 4099: version and domain. If not found, it defaults to version 4 and the
4100: domain of the server.
1.80 albertel 4101:
1.648 raeburn 4102: =over 4
4103:
1.80 albertel 4104: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
4105:
1.648 raeburn 4106: =back
4107:
4108: =back
4109:
1.80 albertel 4110: =cut
4111:
4112: #-------------------------------------------
4113: sub get_kerberos_defaults {
4114: my $domain=shift;
1.641 raeburn 4115: my ($krbdef,$krbdefdom);
4116: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
4117: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
4118: $krbdef = $domdefaults{'auth_def'};
4119: $krbdefdom = $domdefaults{'auth_arg_def'};
4120: } else {
1.80 albertel 4121: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
4122: my $krbdefdom=$1;
4123: $krbdefdom=~tr/a-z/A-Z/;
4124: $krbdef = "krb4";
4125: }
4126: return ($krbdef,$krbdefdom);
4127: }
1.112 bowersj2 4128:
1.32 matthew 4129:
1.46 matthew 4130: ###############################################################
4131: ## Thesaurus Functions ##
4132: ###############################################################
1.20 www 4133:
1.46 matthew 4134: =pod
1.20 www 4135:
1.112 bowersj2 4136: =head1 Thesaurus Functions
4137:
4138: =over 4
4139:
1.648 raeburn 4140: =item * &initialize_keywords()
1.46 matthew 4141:
4142: Initializes the package variable %Keywords if it is empty. Uses the
4143: package variable $thesaurus_db_file.
4144:
4145: =cut
4146:
4147: ###################################################
4148:
4149: sub initialize_keywords {
4150: return 1 if (scalar keys(%Keywords));
4151: # If we are here, %Keywords is empty, so fill it up
4152: # Make sure the file we need exists...
4153: if (! -e $thesaurus_db_file) {
4154: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
4155: " failed because it does not exist");
4156: return 0;
4157: }
4158: # Set up the hash as a database
4159: my %thesaurus_db;
4160: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4161: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4162: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
4163: $thesaurus_db_file);
4164: return 0;
4165: }
4166: # Get the average number of appearances of a word.
4167: my $avecount = $thesaurus_db{'average.count'};
4168: # Put keywords (those that appear > average) into %Keywords
4169: while (my ($word,$data)=each (%thesaurus_db)) {
4170: my ($count,undef) = split /:/,$data;
4171: $Keywords{$word}++ if ($count > $avecount);
4172: }
4173: untie %thesaurus_db;
4174: # Remove special values from %Keywords.
1.356 albertel 4175: foreach my $value ('total.count','average.count') {
4176: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 4177: }
1.46 matthew 4178: return 1;
4179: }
4180:
4181: ###################################################
4182:
4183: =pod
4184:
1.648 raeburn 4185: =item * &keyword($word)
1.46 matthew 4186:
4187: Returns true if $word is a keyword. A keyword is a word that appears more
4188: than the average number of times in the thesaurus database. Calls
4189: &initialize_keywords
4190:
4191: =cut
4192:
4193: ###################################################
1.20 www 4194:
4195: sub keyword {
1.46 matthew 4196: return if (!&initialize_keywords());
4197: my $word=lc(shift());
4198: $word=~s/\W//g;
4199: return exists($Keywords{$word});
1.20 www 4200: }
1.46 matthew 4201:
4202: ###############################################################
4203:
4204: =pod
1.20 www 4205:
1.648 raeburn 4206: =item * &get_related_words()
1.46 matthew 4207:
1.160 matthew 4208: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 4209: an array of words. If the keyword is not in the thesaurus, an empty array
4210: will be returned. The order of the words returned is determined by the
4211: database which holds them.
4212:
4213: Uses global $thesaurus_db_file.
4214:
1.1057 foxr 4215:
1.46 matthew 4216: =cut
4217:
4218: ###############################################################
4219: sub get_related_words {
4220: my $keyword = shift;
4221: my %thesaurus_db;
4222: if (! -e $thesaurus_db_file) {
4223: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
4224: "failed because the file does not exist");
4225: return ();
4226: }
4227: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 4228: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 4229: return ();
4230: }
4231: my @Words=();
1.429 www 4232: my $count=0;
1.46 matthew 4233: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 4234: # The first element is the number of times
4235: # the word appears. We do not need it now.
1.429 www 4236: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
4237: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
4238: my $threshold=$mostfrequentcount/10;
4239: foreach my $possibleword (@RelatedWords) {
4240: my ($word,$wordcount)=split(/\,/,$possibleword);
4241: if ($wordcount>$threshold) {
4242: push(@Words,$word);
4243: $count++;
4244: if ($count>10) { last; }
4245: }
1.20 www 4246: }
4247: }
1.46 matthew 4248: untie %thesaurus_db;
4249: return @Words;
1.14 harris41 4250: }
1.1090 foxr 4251: ###############################################################
4252: #
4253: # Spell checking
4254: #
4255:
4256: =pod
4257:
1.1142 raeburn 4258: =back
4259:
1.1090 foxr 4260: =head1 Spell checking
4261:
4262: =over 4
4263:
4264: =item * &check_spelling($wordlist $language)
4265:
4266: Takes a string containing words and feeds it to an external
4267: spellcheck program via a pipeline. Returns a string containing
4268: them mis-spelled words.
4269:
4270: Parameters:
4271:
4272: =over 4
4273:
4274: =item - $wordlist
4275:
4276: String that will be fed into the spellcheck program.
4277:
4278: =item - $language
4279:
4280: Language string that specifies the language for which the spell
4281: check will be performed.
4282:
4283: =back
4284:
4285: =back
4286:
4287: Note: This sub assumes that aspell is installed.
4288:
4289:
4290: =cut
4291:
1.46 matthew 4292:
1.1090 foxr 4293: sub check_spelling {
4294: my ($wordlist, $language) = @_;
1.1091 foxr 4295: my @misspellings;
4296:
4297: # Generate the speller and set the langauge.
4298: # if explicitly selected:
1.1090 foxr 4299:
1.1091 foxr 4300: my $speller = Text::Aspell->new;
1.1090 foxr 4301: if ($language) {
1.1091 foxr 4302: $speller->set_option('lang', $language);
1.1090 foxr 4303: }
4304:
1.1091 foxr 4305: # Turn the word list into an array of words by splittingon whitespace
1.1090 foxr 4306:
1.1091 foxr 4307: my @words = split(/\s+/, $wordlist);
1.1090 foxr 4308:
1.1091 foxr 4309: foreach my $word (@words) {
4310: if(! $speller->check($word)) {
4311: push(@misspellings, $word);
1.1090 foxr 4312: }
4313: }
1.1091 foxr 4314: return join(' ', @misspellings);
4315:
1.1090 foxr 4316: }
4317:
1.61 www 4318: # -------------------------------------------------------------- Plaintext name
1.81 albertel 4319: =pod
4320:
1.112 bowersj2 4321: =head1 User Name Functions
4322:
4323: =over 4
4324:
1.648 raeburn 4325: =item * &plainname($uname,$udom,$first)
1.81 albertel 4326:
1.112 bowersj2 4327: Takes a users logon name and returns it as a string in
1.226 albertel 4328: "first middle last generation" form
4329: if $first is set to 'lastname' then it returns it as
4330: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 4331:
4332: =cut
1.61 www 4333:
1.295 www 4334:
1.81 albertel 4335: ###############################################################
1.61 www 4336: sub plainname {
1.226 albertel 4337: my ($uname,$udom,$first)=@_;
1.537 albertel 4338: return if (!defined($uname) || !defined($udom));
1.295 www 4339: my %names=&getnames($uname,$udom);
1.226 albertel 4340: my $name=&Apache::lonnet::format_name($names{'firstname'},
4341: $names{'middlename'},
4342: $names{'lastname'},
4343: $names{'generation'},$first);
4344: $name=~s/^\s+//;
1.62 www 4345: $name=~s/\s+$//;
4346: $name=~s/\s+/ /g;
1.353 albertel 4347: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 4348: return $name;
1.61 www 4349: }
1.66 www 4350:
4351: # -------------------------------------------------------------------- Nickname
1.81 albertel 4352: =pod
4353:
1.648 raeburn 4354: =item * &nickname($uname,$udom)
1.81 albertel 4355:
4356: Gets a users name and returns it as a string as
4357:
4358: ""nickname""
1.66 www 4359:
1.81 albertel 4360: if the user has a nickname or
4361:
4362: "first middle last generation"
4363:
4364: if the user does not
4365:
4366: =cut
1.66 www 4367:
4368: sub nickname {
4369: my ($uname,$udom)=@_;
1.537 albertel 4370: return if (!defined($uname) || !defined($udom));
1.295 www 4371: my %names=&getnames($uname,$udom);
1.68 albertel 4372: my $name=$names{'nickname'};
1.66 www 4373: if ($name) {
4374: $name='"'.$name.'"';
4375: } else {
4376: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
4377: $names{'lastname'}.' '.$names{'generation'};
4378: $name=~s/\s+$//;
4379: $name=~s/\s+/ /g;
4380: }
4381: return $name;
4382: }
4383:
1.295 www 4384: sub getnames {
4385: my ($uname,$udom)=@_;
1.537 albertel 4386: return if (!defined($uname) || !defined($udom));
1.433 albertel 4387: if ($udom eq 'public' && $uname eq 'public') {
4388: return ('lastname' => &mt('Public'));
4389: }
1.295 www 4390: my $id=$uname.':'.$udom;
4391: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
4392: if ($cached) {
4393: return %{$names};
4394: } else {
4395: my %loadnames=&Apache::lonnet::get('environment',
4396: ['firstname','middlename','lastname','generation','nickname'],
4397: $udom,$uname);
4398: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
4399: return %loadnames;
4400: }
4401: }
1.61 www 4402:
1.542 raeburn 4403: # -------------------------------------------------------------------- getemails
1.648 raeburn 4404:
1.542 raeburn 4405: =pod
4406:
1.648 raeburn 4407: =item * &getemails($uname,$udom)
1.542 raeburn 4408:
4409: Gets a user's email information and returns it as a hash with keys:
4410: notification, critnotification, permanentemail
4411:
4412: For notification and critnotification, values are comma-separated lists
1.648 raeburn 4413: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 4414:
1.648 raeburn 4415:
1.542 raeburn 4416: =cut
4417:
1.648 raeburn 4418:
1.466 albertel 4419: sub getemails {
4420: my ($uname,$udom)=@_;
4421: if ($udom eq 'public' && $uname eq 'public') {
4422: return;
4423: }
1.467 www 4424: if (!$udom) { $udom=$env{'user.domain'}; }
4425: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 4426: my $id=$uname.':'.$udom;
4427: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
4428: if ($cached) {
4429: return %{$names};
4430: } else {
4431: my %loadnames=&Apache::lonnet::get('environment',
4432: ['notification','critnotification',
4433: 'permanentemail'],
4434: $udom,$uname);
4435: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
4436: return %loadnames;
4437: }
4438: }
4439:
1.551 albertel 4440: sub flush_email_cache {
4441: my ($uname,$udom)=@_;
4442: if (!$udom) { $udom =$env{'user.domain'}; }
4443: if (!$uname) { $uname=$env{'user.name'}; }
4444: return if ($udom eq 'public' && $uname eq 'public');
4445: my $id=$uname.':'.$udom;
4446: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
4447: }
4448:
1.728 raeburn 4449: # -------------------------------------------------------------------- getlangs
4450:
4451: =pod
4452:
4453: =item * &getlangs($uname,$udom)
4454:
4455: Gets a user's language preference and returns it as a hash with key:
4456: language.
4457:
4458: =cut
4459:
4460:
4461: sub getlangs {
4462: my ($uname,$udom) = @_;
4463: if (!$udom) { $udom =$env{'user.domain'}; }
4464: if (!$uname) { $uname=$env{'user.name'}; }
4465: my $id=$uname.':'.$udom;
4466: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
4467: if ($cached) {
4468: return %{$langs};
4469: } else {
4470: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
4471: $udom,$uname);
4472: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
4473: return %loadlangs;
4474: }
4475: }
4476:
4477: sub flush_langs_cache {
4478: my ($uname,$udom)=@_;
4479: if (!$udom) { $udom =$env{'user.domain'}; }
4480: if (!$uname) { $uname=$env{'user.name'}; }
4481: return if ($udom eq 'public' && $uname eq 'public');
4482: my $id=$uname.':'.$udom;
4483: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
4484: }
4485:
1.61 www 4486: # ------------------------------------------------------------------ Screenname
1.81 albertel 4487:
4488: =pod
4489:
1.648 raeburn 4490: =item * &screenname($uname,$udom)
1.81 albertel 4491:
4492: Gets a users screenname and returns it as a string
4493:
4494: =cut
1.61 www 4495:
4496: sub screenname {
4497: my ($uname,$udom)=@_;
1.258 albertel 4498: if ($uname eq $env{'user.name'} &&
4499: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 4500: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 4501: return $names{'screenname'};
1.62 www 4502: }
4503:
1.212 albertel 4504:
1.802 bisitz 4505: # ------------------------------------------------------------- Confirm Wrapper
4506: =pod
4507:
1.1142 raeburn 4508: =item * &confirmwrapper($message)
1.802 bisitz 4509:
4510: Wrap messages about completion of operation in box
4511:
4512: =cut
4513:
4514: sub confirmwrapper {
4515: my ($message)=@_;
4516: if ($message) {
4517: return "\n".'<div class="LC_confirm_box">'."\n"
4518: .$message."\n"
4519: .'</div>'."\n";
4520: } else {
4521: return $message;
4522: }
4523: }
4524:
1.62 www 4525: # ------------------------------------------------------------- Message Wrapper
4526:
4527: sub messagewrapper {
1.369 www 4528: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 4529: return
1.441 albertel 4530: '<a href="/adm/email?compose=individual&'.
4531: 'recname='.$username.'&recdom='.$domain.
4532: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 4533: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 4534: }
1.802 bisitz 4535:
1.74 www 4536: # --------------------------------------------------------------- Notes Wrapper
4537:
4538: sub noteswrapper {
4539: my ($link,$un,$do)=@_;
4540: return
1.896 amueller 4541: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 4542: }
1.802 bisitz 4543:
1.62 www 4544: # ------------------------------------------------------------- Aboutme Wrapper
4545:
4546: sub aboutmewrapper {
1.1070 raeburn 4547: my ($link,$username,$domain,$target,$class)=@_;
1.447 raeburn 4548: if (!defined($username) && !defined($domain)) {
4549: return;
4550: }
1.1096 raeburn 4551: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070 raeburn 4552: ($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 4553: }
4554:
4555: # ------------------------------------------------------------ Syllabus Wrapper
4556:
4557: sub syllabuswrapper {
1.707 bisitz 4558: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 4559: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 4560: }
1.14 harris41 4561:
1.1397 raeburn 4562: # -----------------------------------------------------------------------------
4563:
1.1396 raeburn 4564: sub aboutme_on {
4565: my ($uname,$udom)=@_;
4566: unless ($uname) { $uname=$env{'user.name'}; }
4567: unless ($udom) { $udom=$env{'user.domain'}; }
4568: return if ($udom eq 'public' && $uname eq 'public');
4569: my $hashkey=$uname.':'.$udom;
4570: my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
4571: if ($cached) {
4572: return $aboutme;
4573: }
4574: $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
4575: &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
4576: return $aboutme;
4577: }
4578:
4579: sub devalidate_aboutme_cache {
4580: my ($uname,$udom)=@_;
4581: if (!$udom) { $udom =$env{'user.domain'}; }
4582: if (!$uname) { $uname=$env{'user.name'}; }
4583: return if ($udom eq 'public' && $uname eq 'public');
4584: my $id=$uname.':'.$udom;
4585: &Apache::lonnet::devalidate_cache_new('aboutme',$id);
4586: }
4587:
1.208 matthew 4588: sub track_student_link {
1.887 raeburn 4589: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268 albertel 4590: my $link ="/adm/trackstudent?";
1.208 matthew 4591: my $title = 'View recent activity';
4592: if (defined($sname) && $sname !~ /^\s*$/ &&
4593: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 4594: $link .= "selected_student=$sname:$sdom";
1.208 matthew 4595: $title .= ' of this student';
1.268 albertel 4596: }
1.208 matthew 4597: if (defined($target) && $target !~ /^\s*$/) {
4598: $target = qq{target="$target"};
4599: } else {
4600: $target = '';
4601: }
1.268 albertel 4602: if ($start) { $link.='&start='.$start; }
1.887 raeburn 4603: if ($only_body) { $link .= '&only_body=1'; }
1.554 albertel 4604: $title = &mt($title);
4605: $linktext = &mt($linktext);
1.448 albertel 4606: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
4607: &help_open_topic('View_recent_activity');
1.208 matthew 4608: }
4609:
1.781 raeburn 4610: sub slot_reservations_link {
4611: my ($linktext,$sname,$sdom,$target) = @_;
4612: my $link ="/adm/slotrequest?command=showresv&origin=aboutme";
4613: my $title = 'View slot reservation history';
4614: if (defined($sname) && $sname !~ /^\s*$/ &&
4615: defined($sdom) && $sdom !~ /^\s*$/) {
4616: $link .= "&uname=$sname&udom=$sdom";
4617: $title .= ' of this student';
4618: }
4619: if (defined($target) && $target !~ /^\s*$/) {
4620: $target = qq{target="$target"};
4621: } else {
4622: $target = '';
4623: }
4624: $title = &mt($title);
4625: $linktext = &mt($linktext);
4626: return qq{<a href="$link" title="$title" $target>$linktext</a>};
4627: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
4628:
4629: }
4630:
1.508 www 4631: # ===================================================== Display a student photo
4632:
4633:
1.509 albertel 4634: sub student_image_tag {
1.508 www 4635: my ($domain,$user)=@_;
4636: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
4637: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
4638: return '<img src="'.$imgsrc.'" align="right" />';
4639: } else {
4640: return '';
4641: }
4642: }
4643:
1.112 bowersj2 4644: =pod
4645:
4646: =back
4647:
4648: =head1 Access .tab File Data
4649:
4650: =over 4
4651:
1.648 raeburn 4652: =item * &languageids()
1.112 bowersj2 4653:
4654: returns list of all language ids
4655:
4656: =cut
4657:
1.14 harris41 4658: sub languageids {
1.16 harris41 4659: return sort(keys(%language));
1.14 harris41 4660: }
4661:
1.112 bowersj2 4662: =pod
4663:
1.648 raeburn 4664: =item * &languagedescription()
1.112 bowersj2 4665:
4666: returns description of a specified language id
4667:
4668: =cut
4669:
1.14 harris41 4670: sub languagedescription {
1.125 www 4671: my $code=shift;
4672: return ($supported_language{$code}?'* ':'').
4673: $language{$code}.
1.126 www 4674: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 4675: }
4676:
1.1048 foxr 4677: =pod
4678:
4679: =item * &plainlanguagedescription
4680:
4681: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
4682: and the language character encoding (e.g. ISO) separated by a ' - ' string.
4683:
4684: =cut
4685:
1.145 www 4686: sub plainlanguagedescription {
4687: my $code=shift;
4688: return $language{$code};
4689: }
4690:
1.1048 foxr 4691: =pod
4692:
4693: =item * &supportedlanguagecode
4694:
4695: Returns the supported language code (e.g. sptutf maps to pt) given a language
4696: code.
4697:
4698: =cut
4699:
1.145 www 4700: sub supportedlanguagecode {
4701: my $code=shift;
4702: return $supported_language{$code};
1.97 www 4703: }
4704:
1.112 bowersj2 4705: =pod
4706:
1.1048 foxr 4707: =item * &latexlanguage()
4708:
4709: Given a language key code returns the correspondnig language to use
4710: to select the correct hyphenation on LaTeX printouts. This is undef if there
4711: is no supported hyphenation for the language code.
4712:
4713: =cut
4714:
4715: sub latexlanguage {
4716: my $code = shift;
4717: return $latex_language{$code};
4718: }
4719:
4720: =pod
4721:
4722: =item * &latexhyphenation()
4723:
4724: Same as above but what's supplied is the language as it might be stored
4725: in the metadata.
4726:
4727: =cut
4728:
4729: sub latexhyphenation {
4730: my $key = shift;
4731: return $latex_language_bykey{$key};
4732: }
4733:
4734: =pod
4735:
1.648 raeburn 4736: =item * ©rightids()
1.112 bowersj2 4737:
4738: returns list of all copyrights
4739:
4740: =cut
4741:
4742: sub copyrightids {
4743: return sort(keys(%cprtag));
4744: }
4745:
4746: =pod
4747:
1.648 raeburn 4748: =item * ©rightdescription()
1.112 bowersj2 4749:
4750: returns description of a specified copyright id
4751:
4752: =cut
4753:
4754: sub copyrightdescription {
1.166 www 4755: return &mt($cprtag{shift(@_)});
1.112 bowersj2 4756: }
1.197 matthew 4757:
4758: =pod
4759:
1.648 raeburn 4760: =item * &source_copyrightids()
1.192 taceyjo1 4761:
4762: returns list of all source copyrights
4763:
4764: =cut
4765:
4766: sub source_copyrightids {
4767: return sort(keys(%scprtag));
4768: }
4769:
4770: =pod
4771:
1.648 raeburn 4772: =item * &source_copyrightdescription()
1.192 taceyjo1 4773:
4774: returns description of a specified source copyright id
4775:
4776: =cut
4777:
4778: sub source_copyrightdescription {
4779: return &mt($scprtag{shift(@_)});
4780: }
1.112 bowersj2 4781:
4782: =pod
4783:
1.648 raeburn 4784: =item * &filecategories()
1.112 bowersj2 4785:
4786: returns list of all file categories
4787:
4788: =cut
4789:
4790: sub filecategories {
4791: return sort(keys(%category_extensions));
4792: }
4793:
4794: =pod
4795:
1.648 raeburn 4796: =item * &filecategorytypes()
1.112 bowersj2 4797:
4798: returns list of file types belonging to a given file
4799: category
4800:
4801: =cut
4802:
4803: sub filecategorytypes {
1.356 albertel 4804: my ($cat) = @_;
1.1248 raeburn 4805: if (ref($category_extensions{lc($cat)}) eq 'ARRAY') {
4806: return @{$category_extensions{lc($cat)}};
4807: } else {
4808: return ();
4809: }
1.112 bowersj2 4810: }
4811:
4812: =pod
4813:
1.648 raeburn 4814: =item * &fileembstyle()
1.112 bowersj2 4815:
4816: returns embedding style for a specified file type
4817:
4818: =cut
4819:
4820: sub fileembstyle {
4821: return $fe{lc(shift(@_))};
1.169 www 4822: }
4823:
1.351 www 4824: sub filemimetype {
4825: return $fm{lc(shift(@_))};
4826: }
4827:
1.169 www 4828:
4829: sub filecategoryselect {
4830: my ($name,$value)=@_;
1.189 matthew 4831: return &select_form($value,$name,
1.970 raeburn 4832: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112 bowersj2 4833: }
4834:
4835: =pod
4836:
1.648 raeburn 4837: =item * &filedescription()
1.112 bowersj2 4838:
4839: returns description for a specified file type
4840:
4841: =cut
4842:
4843: sub filedescription {
1.188 matthew 4844: my $file_description = $fd{lc(shift())};
4845: $file_description =~ s:([\[\]]):~$1:g;
4846: return &mt($file_description);
1.112 bowersj2 4847: }
4848:
4849: =pod
4850:
1.648 raeburn 4851: =item * &filedescriptionex()
1.112 bowersj2 4852:
4853: returns description for a specified file type with
4854: extra formatting
4855:
4856: =cut
4857:
4858: sub filedescriptionex {
4859: my $ex=shift;
1.188 matthew 4860: my $file_description = $fd{lc($ex)};
4861: $file_description =~ s:([\[\]]):~$1:g;
4862: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 4863: }
4864:
4865: # End of .tab access
4866: =pod
4867:
4868: =back
4869:
4870: =cut
4871:
4872: # ------------------------------------------------------------------ File Types
4873: sub fileextensions {
4874: return sort(keys(%fe));
4875: }
4876:
1.97 www 4877: # ----------------------------------------------------------- Display Languages
4878: # returns a hash with all desired display languages
4879: #
4880:
4881: sub display_languages {
4882: my %languages=();
1.695 raeburn 4883: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 4884: $languages{$lang}=1;
1.97 www 4885: }
4886: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 4887: if ($env{'form.displaylanguage'}) {
1.356 albertel 4888: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
4889: $languages{$lang}=1;
1.97 www 4890: }
4891: }
4892: return %languages;
1.14 harris41 4893: }
4894:
1.582 albertel 4895: sub languages {
4896: my ($possible_langs) = @_;
1.695 raeburn 4897: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 4898: if (!ref($possible_langs)) {
4899: if( wantarray ) {
4900: return @preferred_langs;
4901: } else {
4902: return $preferred_langs[0];
4903: }
4904: }
4905: my %possibilities = map { $_ => 1 } (@$possible_langs);
4906: my @preferred_possibilities;
4907: foreach my $preferred_lang (@preferred_langs) {
4908: if (exists($possibilities{$preferred_lang})) {
4909: push(@preferred_possibilities, $preferred_lang);
4910: }
4911: }
4912: if( wantarray ) {
4913: return @preferred_possibilities;
4914: }
4915: return $preferred_possibilities[0];
4916: }
4917:
1.742 raeburn 4918: sub user_lang {
4919: my ($touname,$toudom,$fromcid) = @_;
4920: my @userlangs;
4921: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
4922: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
4923: $env{'course.'.$fromcid.'.languages'}));
4924: } else {
4925: my %langhash = &getlangs($touname,$toudom);
4926: if ($langhash{'languages'} ne '') {
4927: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
4928: } else {
4929: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
4930: if ($domdefs{'lang_def'} ne '') {
4931: @userlangs = ($domdefs{'lang_def'});
4932: }
4933: }
4934: }
4935: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
4936: my $user_lh = Apache::localize->get_handle(@languages);
4937: return $user_lh;
4938: }
4939:
4940:
1.112 bowersj2 4941: ###############################################################
4942: ## Student Answer Attempts ##
4943: ###############################################################
4944:
4945: =pod
4946:
4947: =head1 Alternate Problem Views
4948:
4949: =over 4
4950:
1.648 raeburn 4951: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199 raeburn 4952: $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112 bowersj2 4953:
4954: Return string with previous attempt on problem. Arguments:
4955:
4956: =over 4
4957:
4958: =item * $symb: Problem, including path
4959:
4960: =item * $username: username of the desired student
4961:
4962: =item * $domain: domain of the desired student
1.14 harris41 4963:
1.112 bowersj2 4964: =item * $course: Course ID
1.14 harris41 4965:
1.112 bowersj2 4966: =item * $getattempt: Leave blank for all attempts, otherwise put
4967: something
1.14 harris41 4968:
1.112 bowersj2 4969: =item * $regexp: if string matches this regexp, the string will be
4970: sent to $gradesub
1.14 harris41 4971:
1.112 bowersj2 4972: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 4973:
1.1199 raeburn 4974: =item * $usec: section of the desired student
4975:
4976: =item * $identifier: counter for student (multiple students one problem) or
4977: problem (one student; whole sequence).
4978:
1.112 bowersj2 4979: =back
1.14 harris41 4980:
1.112 bowersj2 4981: The output string is a table containing all desired attempts, if any.
1.16 harris41 4982:
1.112 bowersj2 4983: =cut
1.1 albertel 4984:
4985: sub get_previous_attempt {
1.1199 raeburn 4986: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1 albertel 4987: my $prevattempts='';
1.43 ng 4988: no strict 'refs';
1.1 albertel 4989: if ($symb) {
1.3 albertel 4990: my (%returnhash)=
4991: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 4992: if ($returnhash{'version'}) {
4993: my %lasthash=();
4994: my $version;
4995: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212 raeburn 4996: foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
4997: if ($key =~ /\.rawrndseed$/) {
4998: my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
4999: $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
5000: } else {
5001: $lasthash{$key}=$returnhash{$version.':'.$key};
5002: }
1.19 harris41 5003: }
1.1 albertel 5004: }
1.596 albertel 5005: $prevattempts=&start_data_table().&start_data_table_header_row();
5006: $prevattempts.='<th>'.&mt('History').'</th>';
1.1199 raeburn 5007: my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945 raeburn 5008: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356 albertel 5009: foreach my $key (sort(keys(%lasthash))) {
5010: my ($ign,@parts) = split(/\./,$key);
1.41 ng 5011: if ($#parts > 0) {
1.31 albertel 5012: my $data=$parts[-1];
1.989 raeburn 5013: next if ($data eq 'foilorder');
1.31 albertel 5014: pop(@parts);
1.1010 www 5015: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.945 raeburn 5016: if ($data eq 'type') {
5017: unless ($showsurv) {
5018: my $id = join(',',@parts);
5019: $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978 raeburn 5020: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
5021: $lasthidden{$ign.'.'.$id} = 1;
5022: }
1.945 raeburn 5023: }
1.1199 raeburn 5024: if ($identifier ne '') {
5025: my $id = join(',',@parts);
5026: if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
5027: $domain,$username,$usec,undef,$course) =~ /^no/) {
5028: $hidestatus{$ign.'.'.$id} = 1;
5029: }
5030: }
5031: } elsif ($data eq 'regrader') {
5032: if (($identifier ne '') && (@parts)) {
1.1200 raeburn 5033: my $id = join(',',@parts);
5034: $regraded{$ign.'.'.$id} = 1;
1.1199 raeburn 5035: }
1.1010 www 5036: }
1.31 albertel 5037: } else {
1.41 ng 5038: if ($#parts == 0) {
5039: $prevattempts.='<th>'.$parts[0].'</th>';
5040: } else {
5041: $prevattempts.='<th>'.$ign.'</th>';
5042: }
1.31 albertel 5043: }
1.16 harris41 5044: }
1.596 albertel 5045: $prevattempts.=&end_data_table_header_row();
1.40 ng 5046: if ($getattempt eq '') {
1.1199 raeburn 5047: my (%solved,%resets,%probstatus);
1.1200 raeburn 5048: if (($identifier ne '') && (keys(%regraded) > 0)) {
5049: for ($version=1;$version<=$returnhash{'version'};$version++) {
5050: foreach my $id (keys(%regraded)) {
5051: if (($returnhash{$version.':'.$id.'.regrader'}) &&
5052: ($returnhash{$version.':'.$id.'.tries'} eq '') &&
5053: ($returnhash{$version.':'.$id.'.award'} eq '')) {
5054: push(@{$resets{$id}},$version);
1.1199 raeburn 5055: }
5056: }
5057: }
1.1200 raeburn 5058: }
5059: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199 raeburn 5060: my (@hidden,@unsolved);
1.945 raeburn 5061: if (%typeparts) {
5062: foreach my $id (keys(%typeparts)) {
1.1199 raeburn 5063: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
5064: ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945 raeburn 5065: push(@hidden,$id);
1.1199 raeburn 5066: } elsif ($identifier ne '') {
5067: unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
5068: ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
5069: ($hidestatus{$id})) {
1.1200 raeburn 5070: next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199 raeburn 5071: if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
5072: push(@{$solved{$id}},$version);
5073: } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
5074: (ref($solved{$id}) eq 'ARRAY')) {
5075: my $skip;
5076: if (ref($resets{$id}) eq 'ARRAY') {
5077: foreach my $reset (@{$resets{$id}}) {
5078: if ($reset > $solved{$id}[-1]) {
5079: $skip=1;
5080: last;
5081: }
5082: }
5083: }
5084: unless ($skip) {
5085: my ($ign,$partslist) = split(/\./,$id,2);
5086: push(@unsolved,$partslist);
5087: }
5088: }
5089: }
1.945 raeburn 5090: }
5091: }
5092: }
5093: $prevattempts.=&start_data_table_row().
1.1199 raeburn 5094: '<td>'.&mt('Transaction [_1]',$version);
5095: if (@unsolved) {
5096: $prevattempts .= '<span class="LC_nobreak"><label>'.
5097: '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
5098: &mt('Hide').'</label></span>';
5099: }
5100: $prevattempts .= '</td>';
1.945 raeburn 5101: if (@hidden) {
5102: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5103: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5104: my $hide;
5105: foreach my $id (@hidden) {
5106: if ($key =~ /^\Q$id\E/) {
5107: $hide = 1;
5108: last;
5109: }
5110: }
5111: if ($hide) {
5112: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5113: if (($data eq 'award') || ($data eq 'awarddetail')) {
5114: my $value = &format_previous_attempt_value($key,
5115: $returnhash{$version.':'.$key});
1.1173 kruse 5116: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5117: } else {
5118: $prevattempts.='<td> </td>';
5119: }
5120: } else {
5121: if ($key =~ /\./) {
1.1212 raeburn 5122: my $value = $returnhash{$version.':'.$key};
5123: if ($key =~ /\.rndseed$/) {
5124: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5125: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5126: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5127: }
5128: }
5129: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5130: ' </td>';
1.945 raeburn 5131: } else {
5132: $prevattempts.='<td> </td>';
5133: }
5134: }
5135: }
5136: } else {
5137: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5138: next if ($key =~ /\.foilorder$/);
1.1212 raeburn 5139: my $value = $returnhash{$version.':'.$key};
5140: if ($key =~ /\.rndseed$/) {
5141: my ($id) = ($key =~ /^(.+)\.[^.]+$/);
5142: if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
5143: $value = $returnhash{$version.':'.$id.'.rawrndseed'};
5144: }
5145: }
5146: $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
5147: ' </td>';
1.945 raeburn 5148: }
5149: }
5150: $prevattempts.=&end_data_table_row();
1.40 ng 5151: }
1.1 albertel 5152: }
1.945 raeburn 5153: my @currhidden = keys(%lasthidden);
1.596 albertel 5154: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 5155: foreach my $key (sort(keys(%lasthash))) {
1.989 raeburn 5156: next if ($key =~ /\.foilorder$/);
1.945 raeburn 5157: if (%typeparts) {
5158: my $hidden;
5159: foreach my $id (@currhidden) {
5160: if ($key =~ /^\Q$id\E/) {
5161: $hidden = 1;
5162: last;
5163: }
5164: }
5165: if ($hidden) {
5166: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
5167: if (($data eq 'award') || ($data eq 'awarddetail')) {
5168: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5169: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5170: $value = &$gradesub($value);
5171: }
1.1173 kruse 5172: $prevattempts.='<td>'. $value.' </td>';
1.945 raeburn 5173: } else {
5174: $prevattempts.='<td> </td>';
5175: }
5176: } else {
5177: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5178: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5179: $value = &$gradesub($value);
5180: }
1.1173 kruse 5181: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5182: }
5183: } else {
5184: my $value = &format_previous_attempt_value($key,$lasthash{$key});
5185: if ($key =~/$regexp$/ && (defined &$gradesub)) {
5186: $value = &$gradesub($value);
5187: }
1.1173 kruse 5188: $prevattempts.='<td>'.$value.' </td>';
1.945 raeburn 5189: }
1.16 harris41 5190: }
1.596 albertel 5191: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 5192: } else {
1.1305 raeburn 5193: my $msg;
5194: if ($symb =~ /ext\.tool$/) {
5195: $msg = &mt('No grade passed back.');
5196: } else {
5197: $msg = &mt('Nothing submitted - no attempts.');
5198: }
1.596 albertel 5199: $prevattempts=
5200: &start_data_table().&start_data_table_row().
1.1305 raeburn 5201: '<td>'.$msg.'</td>'.
1.596 albertel 5202: &end_data_table_row().&end_data_table();
1.1 albertel 5203: }
5204: } else {
1.596 albertel 5205: $prevattempts=
5206: &start_data_table().&start_data_table_row().
5207: '<td>'.&mt('No data.').'</td>'.
5208: &end_data_table_row().&end_data_table();
1.1 albertel 5209: }
1.10 albertel 5210: }
5211:
1.581 albertel 5212: sub format_previous_attempt_value {
5213: my ($key,$value) = @_;
1.1011 www 5214: if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173 kruse 5215: $value = &Apache::lonlocal::locallocaltime($value);
1.581 albertel 5216: } elsif (ref($value) eq 'ARRAY') {
1.1173 kruse 5217: $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988 raeburn 5218: } elsif ($key =~ /answerstring$/) {
5219: my %answers = &Apache::lonnet::str2hash($value);
1.1173 kruse 5220: my @answer = %answers;
5221: %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988 raeburn 5222: my @anskeys = sort(keys(%answers));
5223: if (@anskeys == 1) {
5224: my $answer = $answers{$anskeys[0]};
1.1001 raeburn 5225: if ($answer =~ m{\0}) {
5226: $answer =~ s{\0}{,}g;
1.988 raeburn 5227: }
5228: my $tag_internal_answer_name = 'INTERNAL';
5229: if ($anskeys[0] eq $tag_internal_answer_name) {
5230: $value = $answer;
5231: } else {
5232: $value = $anskeys[0].'='.$answer;
5233: }
5234: } else {
5235: foreach my $ans (@anskeys) {
5236: my $answer = $answers{$ans};
1.1001 raeburn 5237: if ($answer =~ m{\0}) {
5238: $answer =~ s{\0}{,}g;
1.988 raeburn 5239: }
5240: $value .= $ans.'='.$answer.'<br />';;
5241: }
5242: }
1.581 albertel 5243: } else {
1.1173 kruse 5244: $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581 albertel 5245: }
5246: return $value;
5247: }
5248:
5249:
1.107 albertel 5250: sub relative_to_absolute {
5251: my ($url,$output)=@_;
5252: my $parser=HTML::TokeParser->new(\$output);
5253: my $token;
5254: my $thisdir=$url;
5255: my @rlinks=();
5256: while ($token=$parser->get_token) {
5257: if ($token->[0] eq 'S') {
5258: if ($token->[1] eq 'a') {
5259: if ($token->[2]->{'href'}) {
5260: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
5261: }
5262: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
5263: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
5264: } elsif ($token->[1] eq 'base') {
5265: $thisdir=$token->[2]->{'href'};
5266: }
5267: }
5268: }
5269: $thisdir=~s-/[^/]*$--;
1.356 albertel 5270: foreach my $link (@rlinks) {
1.726 raeburn 5271: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 5272: ($link=~/^\//) ||
5273: ($link=~/^javascript:/i) ||
5274: ($link=~/^mailto:/i) ||
5275: ($link=~/^\#/)) {
5276: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
5277: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 5278: }
5279: }
5280: # -------------------------------------------------- Deal with Applet codebases
5281: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
5282: return $output;
5283: }
5284:
1.112 bowersj2 5285: =pod
5286:
1.648 raeburn 5287: =item * &get_student_view()
1.112 bowersj2 5288:
5289: show a snapshot of what student was looking at
5290:
5291: =cut
5292:
1.10 albertel 5293: sub get_student_view {
1.186 albertel 5294: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 5295: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5296: my (%form);
1.10 albertel 5297: my @elements=('symb','courseid','domain','username');
5298: foreach my $element (@elements) {
1.186 albertel 5299: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5300: }
1.186 albertel 5301: if (defined($moreenv)) {
5302: %form=(%form,%{$moreenv});
5303: }
1.236 albertel 5304: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 5305: $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306 raeburn 5306: if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
5307: $feedurl =~ s{^/adm/wrapper}{};
5308: }
1.650 www 5309: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 5310: $userview=~s/\<body[^\>]*\>//gi;
5311: $userview=~s/\<\/body\>//gi;
5312: $userview=~s/\<html\>//gi;
5313: $userview=~s/\<\/html\>//gi;
5314: $userview=~s/\<head\>//gi;
5315: $userview=~s/\<\/head\>//gi;
5316: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 5317: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 5318: if (wantarray) {
5319: return ($userview,$response);
5320: } else {
5321: return $userview;
5322: }
5323: }
5324:
5325: sub get_student_view_with_retries {
5326: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
5327:
5328: my $ok = 0; # True if we got a good response.
5329: my $content;
5330: my $response;
5331:
5332: # Try to get the student_view done. within the retries count:
5333:
5334: do {
5335: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
5336: $ok = $response->is_success;
5337: if (!$ok) {
5338: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
5339: }
5340: $retries--;
5341: } while (!$ok && ($retries > 0));
5342:
5343: if (!$ok) {
5344: $content = ''; # On error return an empty content.
5345: }
1.651 www 5346: if (wantarray) {
5347: return ($content, $response);
5348: } else {
5349: return $content;
5350: }
1.11 albertel 5351: }
5352:
1.1349 raeburn 5353: sub css_links {
5354: my ($currsymb,$level) = @_;
5355: my ($links,@symbs,%cssrefs,%httpref);
5356: if ($level eq 'map') {
5357: my $navmap = Apache::lonnavmaps::navmap->new();
5358: if (ref($navmap)) {
5359: my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
5360: my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
5361: foreach my $res (@resources) {
5362: if (ref($res) && $res->symb()) {
5363: push(@symbs,$res->symb());
5364: }
5365: }
5366: }
5367: } else {
5368: @symbs = ($currsymb);
5369: }
5370: foreach my $symb (@symbs) {
5371: my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
5372: if ($css_href =~ /\S/) {
5373: unless ($css_href =~ m{https?://}) {
5374: my $url = (&Apache::lonnet::decode_symb($symb))[-1];
5375: my $proburl = &Apache::lonnet::clutter($url);
5376: my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
5377: unless ($css_href =~ m{^/}) {
5378: $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
5379: }
5380: if ($css_href =~ m{^/(res|uploaded)/}) {
5381: unless (($httpref{'httpref.'.$css_href}) ||
5382: (&Apache::lonnet::is_on_map($css_href))) {
5383: my $thisurl = $proburl;
5384: if ($env{'httpref.'.$proburl}) {
5385: $thisurl = $env{'httpref.'.$proburl};
5386: }
5387: $httpref{'httpref.'.$css_href} = $thisurl;
5388: }
5389: }
5390: }
5391: $cssrefs{$css_href} = 1;
5392: }
5393: }
5394: if (keys(%httpref)) {
5395: &Apache::lonnet::appenv(\%httpref);
5396: }
5397: if (keys(%cssrefs)) {
5398: foreach my $css_href (keys(%cssrefs)) {
5399: next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
5400: $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
5401: }
5402: }
5403: return $links;
5404: }
5405:
1.112 bowersj2 5406: =pod
5407:
1.648 raeburn 5408: =item * &get_student_answers()
1.112 bowersj2 5409:
5410: show a snapshot of how student was answering problem
5411:
5412: =cut
5413:
1.11 albertel 5414: sub get_student_answers {
1.100 sakharuk 5415: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 5416: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 5417: my (%moreenv);
1.11 albertel 5418: my @elements=('symb','courseid','domain','username');
5419: foreach my $element (@elements) {
1.186 albertel 5420: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 5421: }
1.186 albertel 5422: $moreenv{'grade_target'}='answer';
5423: %moreenv=(%form,%moreenv);
1.497 raeburn 5424: $feedurl = &Apache::lonnet::clutter($feedurl);
5425: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 5426: return $userview;
1.1 albertel 5427: }
1.116 albertel 5428:
5429: =pod
5430:
5431: =item * &submlink()
5432:
1.242 albertel 5433: Inputs: $text $uname $udom $symb $target
1.116 albertel 5434:
5435: Returns: A link to grades.pm such as to see the SUBM view of a student
5436:
5437: =cut
5438:
5439: ###############################################
5440: sub submlink {
1.242 albertel 5441: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 5442: if (!($uname && $udom)) {
5443: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5444: &Apache::lonnet::whichuser($symb);
1.116 albertel 5445: if (!$symb) { $symb=$cursymb; }
5446: }
1.254 matthew 5447: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5448: $symb=&escape($symb);
1.960 bisitz 5449: if ($target) { $target=" target=\"$target\""; }
5450: return
5451: '<a href="/adm/grades?command=submission'.
5452: '&symb='.$symb.
5453: '&student='.$uname.
5454: '&userdom='.$udom.'"'.
5455: $target.'>'.$text.'</a>';
1.242 albertel 5456: }
5457: ##############################################
5458:
5459: =pod
5460:
5461: =item * &pgrdlink()
5462:
5463: Inputs: $text $uname $udom $symb $target
5464:
5465: Returns: A link to grades.pm such as to see the PGRD view of a student
5466:
5467: =cut
5468:
5469: ###############################################
5470: sub pgrdlink {
5471: my $link=&submlink(@_);
5472: $link=~s/(&command=submission)/$1&showgrading=yes/;
5473: return $link;
5474: }
5475: ##############################################
5476:
5477: =pod
5478:
5479: =item * &pprmlink()
5480:
5481: Inputs: $text $uname $udom $symb $target
5482:
5483: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 5484: student and a specific resource
1.242 albertel 5485:
5486: =cut
5487:
5488: ###############################################
5489: sub pprmlink {
5490: my ($text,$uname,$udom,$symb,$target)=@_;
5491: if (!($uname && $udom)) {
5492: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 5493: &Apache::lonnet::whichuser($symb);
1.242 albertel 5494: if (!$symb) { $symb=$cursymb; }
5495: }
1.254 matthew 5496: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 5497: $symb=&escape($symb);
1.242 albertel 5498: if ($target) { $target="target=\"$target\""; }
1.595 albertel 5499: return '<a href="/adm/parmset?command=set&'.
5500: 'symb='.$symb.'&uname='.$uname.
5501: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 5502: }
5503: ##############################################
1.37 matthew 5504:
1.112 bowersj2 5505: =pod
5506:
5507: =back
5508:
5509: =cut
5510:
1.37 matthew 5511: ###############################################
1.51 www 5512:
5513:
5514: sub timehash {
1.687 raeburn 5515: my ($thistime) = @_;
5516: my $timezone = &Apache::lonlocal::gettimezone();
5517: my $dt = DateTime->from_epoch(epoch => $thistime)
5518: ->set_time_zone($timezone);
5519: my $wday = $dt->day_of_week();
5520: if ($wday == 7) { $wday = 0; }
5521: return ( 'second' => $dt->second(),
5522: 'minute' => $dt->minute(),
5523: 'hour' => $dt->hour(),
5524: 'day' => $dt->day_of_month(),
5525: 'month' => $dt->month(),
5526: 'year' => $dt->year(),
5527: 'weekday' => $wday,
5528: 'dayyear' => $dt->day_of_year(),
5529: 'dlsav' => $dt->is_dst() );
1.51 www 5530: }
5531:
1.370 www 5532: sub utc_string {
5533: my ($date)=@_;
1.371 www 5534: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 5535: }
5536:
1.51 www 5537: sub maketime {
5538: my %th=@_;
1.687 raeburn 5539: my ($epoch_time,$timezone,$dt);
5540: $timezone = &Apache::lonlocal::gettimezone();
5541: eval {
5542: $dt = DateTime->new( year => $th{'year'},
5543: month => $th{'month'},
5544: day => $th{'day'},
5545: hour => $th{'hour'},
5546: minute => $th{'minute'},
5547: second => $th{'second'},
5548: time_zone => $timezone,
5549: );
5550: };
5551: if (!$@) {
5552: $epoch_time = $dt->epoch;
5553: if ($epoch_time) {
5554: return $epoch_time;
5555: }
5556: }
1.51 www 5557: return POSIX::mktime(
5558: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 5559: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 5560: }
5561:
5562: #########################################
1.51 www 5563:
5564: sub findallcourses {
1.482 raeburn 5565: my ($roles,$uname,$udom) = @_;
1.355 albertel 5566: my %roles;
5567: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 5568: my %courses;
1.51 www 5569: my $now=time;
1.482 raeburn 5570: if (!defined($uname)) {
5571: $uname = $env{'user.name'};
5572: }
5573: if (!defined($udom)) {
5574: $udom = $env{'user.domain'};
5575: }
5576: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073 raeburn 5577: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482 raeburn 5578: if (!%roles) {
5579: %roles = (
5580: cc => 1,
1.907 raeburn 5581: co => 1,
1.482 raeburn 5582: in => 1,
5583: ep => 1,
5584: ta => 1,
5585: cr => 1,
5586: st => 1,
5587: );
5588: }
5589: foreach my $entry (keys(%roleshash)) {
5590: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
5591: if ($trole =~ /^cr/) {
5592: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
5593: } else {
5594: next if (!exists($roles{$trole}));
5595: }
5596: if ($tend) {
5597: next if ($tend < $now);
5598: }
5599: if ($tstart) {
5600: next if ($tstart > $now);
5601: }
1.1058 raeburn 5602: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482 raeburn 5603: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058 raeburn 5604: my $value = $trole.'/'.$cdom.'/';
1.482 raeburn 5605: if ($secpart eq '') {
5606: ($cnum,$role) = split(/_/,$cnumpart);
5607: $sec = 'none';
1.1058 raeburn 5608: $value .= $cnum.'/';
1.482 raeburn 5609: } else {
5610: $cnum = $cnumpart;
5611: ($sec,$role) = split(/_/,$secpart);
1.1058 raeburn 5612: $value .= $cnum.'/'.$sec;
5613: }
5614: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5615: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5616: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5617: }
5618: } else {
5619: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490 raeburn 5620: }
1.482 raeburn 5621: }
5622: } else {
5623: foreach my $key (keys(%env)) {
1.483 albertel 5624: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
5625: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 5626: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
5627: next if ($role eq 'ca' || $role eq 'aa');
5628: next if (%roles && !exists($roles{$role}));
5629: my ($starttime,$endtime)=split(/\./,$env{$key});
5630: my $active=1;
5631: if ($starttime) {
5632: if ($now<$starttime) { $active=0; }
5633: }
5634: if ($endtime) {
5635: if ($now>$endtime) { $active=0; }
5636: }
5637: if ($active) {
1.1058 raeburn 5638: my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482 raeburn 5639: if ($sec eq '') {
5640: $sec = 'none';
1.1058 raeburn 5641: } else {
5642: $value .= $sec;
5643: }
5644: if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
5645: unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
5646: push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
5647: }
5648: } else {
5649: @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482 raeburn 5650: }
1.474 raeburn 5651: }
5652: }
1.51 www 5653: }
5654: }
1.474 raeburn 5655: return %courses;
1.51 www 5656: }
1.37 matthew 5657:
1.54 www 5658: ###############################################
1.474 raeburn 5659:
5660: sub blockcheck {
1.1372 raeburn 5661: my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
5662: unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
5663: my ($has_evb,$check_ipaccess);
5664: my $dom = $env{'user.domain'};
5665: if ($env{'request.course.id'}) {
5666: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5667: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5668: my $checkrole = "cm./$cdom/$cnum";
5669: my $sec = $env{'request.course.sec'};
5670: if ($sec ne '') {
5671: $checkrole .= "/$sec";
5672: }
5673: if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
5674: ($env{'request.role'} !~ /^st/)) {
5675: $has_evb = 1;
5676: }
5677: unless ($has_evb) {
5678: if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
5679: ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
5680: if ($udom eq $cdom) {
5681: $check_ipaccess = 1;
5682: }
5683: }
5684: }
1.1375 raeburn 5685: } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
5686: ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
5687: my $checkrole;
5688: if ($env{'request.role.domain'} eq '') {
5689: $checkrole = "cm./$env{'user.domain'}/";
5690: } else {
5691: $checkrole = "cm./$env{'request.role.domain'}/";
5692: }
5693: if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
5694: $has_evb = 1;
5695: }
1.1372 raeburn 5696: }
5697: unless ($has_evb || $check_ipaccess) {
5698: my @machinedoms = &Apache::lonnet::current_machine_domains();
5699: if (($dom eq 'public') && ($activity eq 'port')) {
5700: $dom = $udom;
5701: }
5702: if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
5703: $check_ipaccess = 1;
5704: } else {
5705: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
5706: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
5707: my $prim = &Apache::lonnet::domain($dom,'primary');
5708: my $intdom = &Apache::lonnet::internet_dom($prim);
5709: if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
5710: if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
5711: $check_ipaccess = 1;
5712: }
5713: }
5714: }
5715: }
5716: if ($check_ipaccess) {
5717: my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
5718: unless (defined($cached)) {
5719: my %domconfig =
5720: &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
5721: $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
5722: }
5723: if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
5724: foreach my $id (keys(%{$ipaccessref})) {
5725: if (ref($ipaccessref->{$id}) eq 'HASH') {
5726: my $range = $ipaccessref->{$id}->{'ip'};
5727: if ($range) {
5728: if (&Apache::lonnet::ip_match($clientip,$range)) {
5729: if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
5730: if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
5731: return ('','','',$id,$dom);
5732: last;
5733: }
5734: }
5735: }
5736: }
5737: }
5738: }
5739: }
5740: }
1.1373 raeburn 5741: if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5742: return ();
5743: }
1.1372 raeburn 5744: }
1.1189 raeburn 5745: if (defined($udom) && defined($uname)) {
5746: # If uname and udom are for a course, check for blocks in the course.
5747: if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
5748: my ($startblock,$endblock,$triggerblock) =
1.1347 raeburn 5749: &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189 raeburn 5750: return ($startblock,$endblock,$triggerblock);
5751: }
5752: } else {
1.490 raeburn 5753: $udom = $env{'user.domain'};
5754: $uname = $env{'user.name'};
5755: }
5756:
1.502 raeburn 5757: my $startblock = 0;
5758: my $endblock = 0;
1.1062 raeburn 5759: my $triggerblock = '';
1.1373 raeburn 5760: my %live_courses;
5761: unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
5762: %live_courses = &findallcourses(undef,$uname,$udom);
5763: }
1.474 raeburn 5764:
1.490 raeburn 5765: # If uname is for a user, and activity is course-specific, i.e.,
5766: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 5767:
1.490 raeburn 5768: if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282 raeburn 5769: $activity eq 'groups' || $activity eq 'printout' ||
1.1346 raeburn 5770: $activity eq 'search' || $activity eq 'reinit' ||
5771: $activity eq 'alert') &&
1.1189 raeburn 5772: ($env{'request.course.id'})) {
1.490 raeburn 5773: foreach my $key (keys(%live_courses)) {
5774: if ($key ne $env{'request.course.id'}) {
5775: delete($live_courses{$key});
5776: }
5777: }
5778: }
5779:
5780: my $otheruser = 0;
5781: my %own_courses;
5782: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
5783: # Resource belongs to user other than current user.
5784: $otheruser = 1;
5785: # Gather courses for current user
5786: %own_courses =
5787: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
5788: }
5789:
5790: # Gather active course roles - course coordinator, instructor,
5791: # exam proctor, ta, student, or custom role.
1.474 raeburn 5792:
5793: foreach my $course (keys(%live_courses)) {
1.482 raeburn 5794: my ($cdom,$cnum);
5795: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
5796: $cdom = $env{'course.'.$course.'.domain'};
5797: $cnum = $env{'course.'.$course.'.num'};
5798: } else {
1.490 raeburn 5799: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 5800: }
5801: my $no_ownblock = 0;
5802: my $no_userblock = 0;
1.533 raeburn 5803: if ($otheruser && $activity ne 'com') {
1.490 raeburn 5804: # Check if current user has 'evb' priv for this
5805: if (defined($own_courses{$course})) {
5806: foreach my $sec (keys(%{$own_courses{$course}})) {
5807: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
5808: if ($sec ne 'none') {
5809: $checkrole .= '/'.$sec;
5810: }
5811: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5812: $no_ownblock = 1;
5813: last;
5814: }
5815: }
5816: }
5817: # if they have 'evb' priv and are currently not playing student
5818: next if (($no_ownblock) &&
5819: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
5820: }
1.474 raeburn 5821: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 5822: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 5823: if ($sec ne 'none') {
1.482 raeburn 5824: $checkrole .= '/'.$sec;
1.474 raeburn 5825: }
1.490 raeburn 5826: if ($otheruser) {
5827: # Resource belongs to user other than current user.
5828: # Assemble privs for that user, and check for 'evb' priv.
1.1058 raeburn 5829: my (%allroles,%userroles);
5830: if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
5831: foreach my $entry (@{$live_courses{$course}{$sec}}) {
5832: my ($trole,$tdom,$tnum,$tsec);
5833: if ($entry =~ /^cr/) {
5834: ($trole,$tdom,$tnum,$tsec) =
5835: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
5836: } else {
5837: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
5838: }
5839: my ($spec,$area,$trest);
5840: $area = '/'.$tdom.'/'.$tnum;
5841: $trest = $tnum;
5842: if ($tsec ne '') {
5843: $area .= '/'.$tsec;
5844: $trest .= '/'.$tsec;
5845: }
5846: $spec = $trole.'.'.$area;
5847: if ($trole =~ /^cr/) {
5848: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
5849: $tdom,$spec,$trest,$area);
5850: } else {
5851: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
5852: $tdom,$spec,$trest,$area);
5853: }
5854: }
1.1276 raeburn 5855: my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058 raeburn 5856: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
5857: if ($1) {
5858: $no_userblock = 1;
5859: last;
5860: }
1.486 raeburn 5861: }
5862: }
1.490 raeburn 5863: } else {
5864: # Resource belongs to current user
5865: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 5866: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
5867: $no_ownblock = 1;
5868: last;
5869: }
1.474 raeburn 5870: }
5871: }
5872: # if they have the evb priv and are currently not playing student
1.482 raeburn 5873: next if (($no_ownblock) &&
1.491 albertel 5874: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 5875: next if ($no_userblock);
1.474 raeburn 5876:
1.1303 raeburn 5877: # Retrieve blocking times and identity of blocker for course
1.490 raeburn 5878: # of specified user, unless user has 'evb' privilege.
1.1284 raeburn 5879:
1.1062 raeburn 5880: my ($start,$end,$trigger) =
1.1347 raeburn 5881: &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502 raeburn 5882: if (($start != 0) &&
5883: (($startblock == 0) || ($startblock > $start))) {
5884: $startblock = $start;
1.1062 raeburn 5885: if ($trigger ne '') {
5886: $triggerblock = $trigger;
5887: }
1.502 raeburn 5888: }
5889: if (($end != 0) &&
5890: (($endblock == 0) || ($endblock < $end))) {
5891: $endblock = $end;
1.1062 raeburn 5892: if ($trigger ne '') {
5893: $triggerblock = $trigger;
5894: }
1.502 raeburn 5895: }
1.490 raeburn 5896: }
1.1062 raeburn 5897: return ($startblock,$endblock,$triggerblock);
1.490 raeburn 5898: }
5899:
5900: sub get_blocks {
1.1347 raeburn 5901: my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490 raeburn 5902: my $startblock = 0;
5903: my $endblock = 0;
1.1062 raeburn 5904: my $triggerblock = '';
1.490 raeburn 5905: my $course = $cdom.'_'.$cnum;
5906: $setters->{$course} = {};
5907: $setters->{$course}{'staff'} = [];
5908: $setters->{$course}{'times'} = [];
1.1062 raeburn 5909: $setters->{$course}{'triggers'} = [];
5910: my (@blockers,%triggered);
5911: my $now = time;
5912: my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
5913: if ($activity eq 'docs') {
1.1348 raeburn 5914: my ($blocked,$nosymbcache,$noenccheck);
1.1347 raeburn 5915: if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
5916: $blocked = 1;
5917: $nosymbcache = 1;
1.1348 raeburn 5918: $noenccheck = 1;
1.1347 raeburn 5919: }
1.1348 raeburn 5920: @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062 raeburn 5921: foreach my $block (@blockers) {
5922: if ($block =~ /^firstaccess____(.+)$/) {
5923: my $item = $1;
5924: my $type = 'map';
5925: my $timersymb = $item;
5926: if ($item eq 'course') {
5927: $type = 'course';
5928: } elsif ($item =~ /___\d+___/) {
5929: $type = 'resource';
5930: } else {
5931: $timersymb = &Apache::lonnet::symbread($item);
5932: }
5933: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5934: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5935: $triggered{$block} = {
5936: start => $start,
5937: end => $end,
5938: type => $type,
5939: };
5940: }
5941: }
5942: } else {
5943: foreach my $block (keys(%commblocks)) {
5944: if ($block =~ m/^(\d+)____(\d+)$/) {
5945: my ($start,$end) = ($1,$2);
5946: if ($start <= time && $end >= time) {
5947: if (ref($commblocks{$block}) eq 'HASH') {
5948: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5949: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5950: unless(grep(/^\Q$block\E$/,@blockers)) {
5951: push(@blockers,$block);
5952: }
5953: }
5954: }
5955: }
5956: }
5957: } elsif ($block =~ /^firstaccess____(.+)$/) {
5958: my $item = $1;
5959: my $timersymb = $item;
5960: my $type = 'map';
5961: if ($item eq 'course') {
5962: $type = 'course';
5963: } elsif ($item =~ /___\d+___/) {
5964: $type = 'resource';
5965: } else {
5966: $timersymb = &Apache::lonnet::symbread($item);
5967: }
5968: my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
5969: my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
5970: if ($start && $end) {
5971: if (($start <= time) && ($end >= time)) {
1.1281 raeburn 5972: if (ref($commblocks{$block}) eq 'HASH') {
5973: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
5974: if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
5975: unless(grep(/^\Q$block\E$/,@blockers)) {
5976: push(@blockers,$block);
5977: $triggered{$block} = {
5978: start => $start,
5979: end => $end,
5980: type => $type,
5981: };
5982: }
5983: }
5984: }
1.1062 raeburn 5985: }
5986: }
1.490 raeburn 5987: }
1.1062 raeburn 5988: }
5989: }
5990: }
5991: foreach my $blocker (@blockers) {
5992: my ($staff_name,$staff_dom,$title,$blocks) =
5993: &parse_block_record($commblocks{$blocker});
5994: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
5995: my ($start,$end,$triggertype);
5996: if ($blocker =~ m/^(\d+)____(\d+)$/) {
5997: ($start,$end) = ($1,$2);
5998: } elsif (ref($triggered{$blocker}) eq 'HASH') {
5999: $start = $triggered{$blocker}{'start'};
6000: $end = $triggered{$blocker}{'end'};
6001: $triggertype = $triggered{$blocker}{'type'};
6002: }
6003: if ($start) {
6004: push(@{$$setters{$course}{'times'}}, [$start,$end]);
6005: if ($triggertype) {
6006: push(@{$$setters{$course}{'triggers'}},$triggertype);
6007: } else {
6008: push(@{$$setters{$course}{'triggers'}},0);
6009: }
6010: if ( ($startblock == 0) || ($startblock > $start) ) {
6011: $startblock = $start;
6012: if ($triggertype) {
6013: $triggerblock = $blocker;
1.474 raeburn 6014: }
6015: }
1.1062 raeburn 6016: if ( ($endblock == 0) || ($endblock < $end) ) {
6017: $endblock = $end;
6018: if ($triggertype) {
6019: $triggerblock = $blocker;
6020: }
6021: }
1.474 raeburn 6022: }
6023: }
1.1062 raeburn 6024: return ($startblock,$endblock,$triggerblock);
1.474 raeburn 6025: }
6026:
6027: sub parse_block_record {
6028: my ($record) = @_;
6029: my ($setuname,$setudom,$title,$blocks);
6030: if (ref($record) eq 'HASH') {
6031: ($setuname,$setudom) = split(/:/,$record->{'setter'});
6032: $title = &unescape($record->{'event'});
6033: $blocks = $record->{'blocks'};
6034: } else {
6035: my @data = split(/:/,$record,3);
6036: if (scalar(@data) eq 2) {
6037: $title = $data[1];
6038: ($setuname,$setudom) = split(/@/,$data[0]);
6039: } else {
6040: ($setuname,$setudom,$title) = @data;
6041: }
6042: $blocks = { 'com' => 'on' };
6043: }
6044: return ($setuname,$setudom,$title,$blocks);
6045: }
6046:
1.854 kalberla 6047: sub blocking_status {
1.1372 raeburn 6048: my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061 raeburn 6049: my %setters;
1.890 droeschl 6050:
1.1061 raeburn 6051: # check for active blocking
1.1372 raeburn 6052: if ($clientip eq '') {
6053: $clientip = &Apache::lonnet::get_requestor_ip();
6054: }
6055: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
6056: &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062 raeburn 6057: my $blocked = 0;
1.1372 raeburn 6058: if (($startblock && $endblock) || ($by_ip)) {
1.1062 raeburn 6059: $blocked = 1;
6060: }
1.890 droeschl 6061:
1.1061 raeburn 6062: # caller just wants to know whether a block is active
6063: if (!wantarray) { return $blocked; }
6064:
6065: # build a link to a popup window containing the details
6066: my $querystring = "?activity=$activity";
1.1351 raeburn 6067: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
6068: if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232 raeburn 6069: $querystring .= "&udom=$udom" if ($udom =~ /^$match_domain$/);
6070: $querystring .= "&uname=$uname" if ($uname =~ /^$match_username$/);
1.1062 raeburn 6071: } elsif ($activity eq 'docs') {
1.1347 raeburn 6072: my $showurl = &Apache::lonenc::check_encrypt($url);
6073: $querystring .= '&url='.&HTML::Entities::encode($showurl,'\'&"<>');
6074: if ($symb) {
6075: my $showsymb = &Apache::lonenc::check_encrypt($symb);
6076: $querystring .= '&symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
6077: }
1.1062 raeburn 6078: }
1.1061 raeburn 6079:
6080: my $output .= <<'END_MYBLOCK';
6081: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
6082: var options = "width=" + w + ",height=" + h + ",";
6083: options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
6084: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
6085: var newWin = window.open(url, wdwName, options);
6086: newWin.focus();
6087: }
1.890 droeschl 6088: END_MYBLOCK
1.854 kalberla 6089:
1.1061 raeburn 6090: $output = Apache::lonhtmlcommon::scripttag($output);
1.890 droeschl 6091:
1.1061 raeburn 6092: my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062 raeburn 6093: my $text = &mt('Communication Blocked');
1.1217 raeburn 6094: my $class = 'LC_comblock';
1.1062 raeburn 6095: if ($activity eq 'docs') {
6096: $text = &mt('Content Access Blocked');
1.1217 raeburn 6097: $class = '';
1.1063 raeburn 6098: } elsif ($activity eq 'printout') {
6099: $text = &mt('Printing Blocked');
1.1232 raeburn 6100: } elsif ($activity eq 'passwd') {
6101: $text = &mt('Password Changing Blocked');
1.1345 raeburn 6102: } elsif ($activity eq 'grades') {
6103: $text = &mt('Gradebook Blocked');
1.1346 raeburn 6104: } elsif ($activity eq 'search') {
6105: $text = &mt('Search Blocked');
1.1282 raeburn 6106: } elsif ($activity eq 'alert') {
6107: $text = &mt('Checking Critical Messages Blocked');
6108: } elsif ($activity eq 'reinit') {
6109: $text = &mt('Checking Course Update Blocked');
1.1351 raeburn 6110: } elsif ($activity eq 'about') {
6111: $text = &mt('Access to User Information Pages Blocked');
1.1373 raeburn 6112: } elsif ($activity eq 'wishlist') {
6113: $text = &mt('Access to Stored Links Blocked');
6114: } elsif ($activity eq 'annotate') {
6115: $text = &mt('Access to Annotations Blocked');
1.1062 raeburn 6116: }
1.1061 raeburn 6117: $output .= <<"END_BLOCK";
1.1217 raeburn 6118: <div class='$class'>
1.869 kalberla 6119: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6120: title='$text'>
6121: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869 kalberla 6122: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890 droeschl 6123: title='$text'>$text</a>
1.867 kalberla 6124: </div>
6125:
6126: END_BLOCK
1.474 raeburn 6127:
1.1061 raeburn 6128: return ($blocked, $output);
1.854 kalberla 6129: }
1.490 raeburn 6130:
1.60 matthew 6131: ###############################################
6132:
1.682 raeburn 6133: sub check_ip_acc {
1.1201 raeburn 6134: my ($acc,$clientip)=@_;
1.682 raeburn 6135: &Apache::lonxml::debug("acc is $acc");
6136: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
6137: return 1;
6138: }
1.1339 raeburn 6139: my ($ip,$allowed);
6140: if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
6141: ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
6142: $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
6143: } else {
1.1350 raeburn 6144: my $remote_ip = &Apache::lonnet::get_requestor_ip();
6145: $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339 raeburn 6146: }
1.682 raeburn 6147:
6148: my $name;
1.1219 raeburn 6149: my %access = (
6150: allowfrom => 1,
6151: denyfrom => 0,
6152: );
6153: my @allows;
6154: my @denies;
6155: foreach my $item (split(',',$acc)) {
6156: $item =~ s/^\s*//;
6157: $item =~ s/\s*$//;
6158: my $pattern;
6159: if ($item =~ /^\!(.+)$/) {
6160: push(@denies,$1);
6161: } else {
6162: push(@allows,$item);
6163: }
6164: }
6165: my $numdenies = scalar(@denies);
6166: my $numallows = scalar(@allows);
6167: my $count = 0;
6168: foreach my $pattern (@denies,@allows) {
6169: $count ++;
6170: my $acctype = 'allowfrom';
6171: if ($count <= $numdenies) {
6172: $acctype = 'denyfrom';
6173: }
1.682 raeburn 6174: if ($pattern =~ /\*$/) {
6175: #35.8.*
6176: $pattern=~s/\*//;
1.1219 raeburn 6177: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6178: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
6179: #35.8.3.[34-56]
6180: my $low=$2;
6181: my $high=$3;
6182: $pattern=$1;
6183: if ($ip =~ /^\Q$pattern\E/) {
6184: my $last=(split(/\./,$ip))[3];
1.1219 raeburn 6185: if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682 raeburn 6186: }
6187: } elsif ($pattern =~ /^\*/) {
6188: #*.msu.edu
6189: $pattern=~s/\*//;
6190: if (!defined($name)) {
6191: use Socket;
6192: my $netaddr=inet_aton($ip);
6193: ($name)=gethostbyaddr($netaddr,AF_INET);
6194: }
1.1219 raeburn 6195: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682 raeburn 6196: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
6197: #127.0.0.1
1.1219 raeburn 6198: if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682 raeburn 6199: } else {
6200: #some.name.com
6201: if (!defined($name)) {
6202: use Socket;
6203: my $netaddr=inet_aton($ip);
6204: ($name)=gethostbyaddr($netaddr,AF_INET);
6205: }
1.1219 raeburn 6206: if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
6207: }
6208: if ($allowed =~ /^(0|1)$/) { last; }
6209: }
6210: if ($allowed eq '') {
6211: if ($numdenies && !$numallows) {
6212: $allowed = 1;
6213: } else {
6214: $allowed = 0;
1.682 raeburn 6215: }
6216: }
6217: return $allowed;
6218: }
6219:
6220: ###############################################
6221:
1.60 matthew 6222: =pod
6223:
1.112 bowersj2 6224: =head1 Domain Template Functions
6225:
6226: =over 4
6227:
6228: =item * &determinedomain()
1.60 matthew 6229:
6230: Inputs: $domain (usually will be undef)
6231:
1.63 www 6232: Returns: Determines which domain should be used for designs
1.60 matthew 6233:
6234: =cut
1.54 www 6235:
1.60 matthew 6236: ###############################################
1.63 www 6237: sub determinedomain {
6238: my $domain=shift;
1.531 albertel 6239: if (! $domain) {
1.60 matthew 6240: # Determine domain if we have not been given one
1.893 raeburn 6241: $domain = &Apache::lonnet::default_login_domain();
1.258 albertel 6242: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
6243: if ($env{'request.role.domain'}) {
6244: $domain=$env{'request.role.domain'};
1.60 matthew 6245: }
6246: }
1.63 www 6247: return $domain;
6248: }
6249: ###############################################
1.517 raeburn 6250:
1.518 albertel 6251: sub devalidate_domconfig_cache {
6252: my ($udom)=@_;
6253: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
6254: }
6255:
6256: # ---------------------- Get domain configuration for a domain
6257: sub get_domainconf {
6258: my ($udom) = @_;
6259: my $cachetime=1800;
6260: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
6261: if (defined($cached)) { return %{$result}; }
6262:
6263: my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948 raeburn 6264: ['login','rolecolors','autoenroll'],$udom);
1.632 raeburn 6265: my (%designhash,%legacy);
1.518 albertel 6266: if (keys(%domconfig) > 0) {
6267: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 6268: if (keys(%{$domconfig{'login'}})) {
6269: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 6270: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208 raeburn 6271: if (($key eq 'loginvia') || ($key eq 'headtag')) {
6272: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6273: foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
6274: if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
6275: if ($key eq 'loginvia') {
6276: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
6277: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
6278: $designhash{$udom.'.login.loginvia'} = $server;
6279: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
6280:
6281: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
6282: } else {
6283: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
6284: }
1.948 raeburn 6285: }
1.1208 raeburn 6286: } elsif ($key eq 'headtag') {
6287: if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
6288: $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948 raeburn 6289: }
1.946 raeburn 6290: }
1.1208 raeburn 6291: if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
6292: $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
6293: }
1.946 raeburn 6294: }
6295: }
6296: }
1.1366 raeburn 6297: } elsif ($key eq 'saml') {
6298: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
6299: foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
6300: if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
6301: $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386 raeburn 6302: foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366 raeburn 6303: $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
6304: }
6305: }
6306: }
6307: }
1.946 raeburn 6308: } else {
6309: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
6310: $designhash{$udom.'.login.'.$key.'_'.$img} =
6311: $domconfig{'login'}{$key}{$img};
6312: }
1.699 raeburn 6313: }
6314: } else {
6315: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
6316: }
1.632 raeburn 6317: }
6318: } else {
6319: $legacy{'login'} = 1;
1.518 albertel 6320: }
1.632 raeburn 6321: } else {
6322: $legacy{'login'} = 1;
1.518 albertel 6323: }
6324: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 6325: if (keys(%{$domconfig{'rolecolors'}})) {
6326: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
6327: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
6328: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
6329: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
6330: }
1.518 albertel 6331: }
6332: }
1.632 raeburn 6333: } else {
6334: $legacy{'rolecolors'} = 1;
1.518 albertel 6335: }
1.632 raeburn 6336: } else {
6337: $legacy{'rolecolors'} = 1;
1.518 albertel 6338: }
1.948 raeburn 6339: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6340: if ($domconfig{'autoenroll'}{'co-owners'}) {
6341: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
6342: }
6343: }
1.632 raeburn 6344: if (keys(%legacy) > 0) {
6345: my %legacyhash = &get_legacy_domconf($udom);
6346: foreach my $item (keys(%legacyhash)) {
6347: if ($item =~ /^\Q$udom\E\.login/) {
6348: if ($legacy{'login'}) {
6349: $designhash{$item} = $legacyhash{$item};
6350: }
6351: } else {
6352: if ($legacy{'rolecolors'}) {
6353: $designhash{$item} = $legacyhash{$item};
6354: }
1.518 albertel 6355: }
6356: }
6357: }
1.632 raeburn 6358: } else {
6359: %designhash = &get_legacy_domconf($udom);
1.518 albertel 6360: }
6361: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
6362: $cachetime);
6363: return %designhash;
6364: }
6365:
1.632 raeburn 6366: sub get_legacy_domconf {
6367: my ($udom) = @_;
6368: my %legacyhash;
6369: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
6370: my $designfile = $designdir.'/'.$udom.'.tab';
6371: if (-e $designfile) {
1.1317 raeburn 6372: if ( open (my $fh,'<',$designfile) ) {
1.632 raeburn 6373: while (my $line = <$fh>) {
6374: next if ($line =~ /^\#/);
6375: chomp($line);
6376: my ($key,$val)=(split(/\=/,$line));
6377: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
6378: }
6379: close($fh);
6380: }
6381: }
1.1026 raeburn 6382: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632 raeburn 6383: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
6384: }
6385: return %legacyhash;
6386: }
6387:
1.63 www 6388: =pod
6389:
1.112 bowersj2 6390: =item * &domainlogo()
1.63 www 6391:
6392: Inputs: $domain (usually will be undef)
6393:
6394: Returns: A link to a domain logo, if the domain logo exists.
6395: If the domain logo does not exist, a description of the domain.
6396:
6397: =cut
1.112 bowersj2 6398:
1.63 www 6399: ###############################################
6400: sub domainlogo {
1.517 raeburn 6401: my $domain = &determinedomain(shift);
1.518 albertel 6402: my %designhash = &get_domainconf($domain);
1.517 raeburn 6403: # See if there is a logo
6404: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 6405: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 6406: if ($imgsrc =~ m{^/(adm|res)/}) {
6407: if ($imgsrc =~ m{^/res/}) {
6408: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
6409: &Apache::lonnet::repcopy($local_name);
6410: }
6411: $imgsrc = &lonhttpdurl($imgsrc);
1.1374 raeburn 6412: }
6413: my $alttext = $domain;
6414: if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
6415: $alttext = $designhash{$domain.'.login.alttext_domlogo'};
6416: }
6417: return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514 albertel 6418: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
6419: return &Apache::lonnet::domain($domain,'description');
1.59 www 6420: } else {
1.60 matthew 6421: return '';
1.59 www 6422: }
6423: }
1.63 www 6424: ##############################################
6425:
6426: =pod
6427:
1.112 bowersj2 6428: =item * &designparm()
1.63 www 6429:
6430: Inputs: $which parameter; $domain (usually will be undef)
6431:
6432: Returns: value of designparamter $which
6433:
6434: =cut
1.112 bowersj2 6435:
1.397 albertel 6436:
1.400 albertel 6437: ##############################################
1.397 albertel 6438: sub designparm {
6439: my ($which,$domain)=@_;
6440: if (exists($env{'environment.color.'.$which})) {
1.817 bisitz 6441: return $env{'environment.color.'.$which};
1.96 www 6442: }
1.63 www 6443: $domain=&determinedomain($domain);
1.1016 raeburn 6444: my %domdesign;
6445: unless ($domain eq 'public') {
6446: %domdesign = &get_domainconf($domain);
6447: }
1.520 raeburn 6448: my $output;
1.517 raeburn 6449: if ($domdesign{$domain.'.'.$which} ne '') {
1.817 bisitz 6450: $output = $domdesign{$domain.'.'.$which};
1.63 www 6451: } else {
1.520 raeburn 6452: $output = $defaultdesign{$which};
6453: }
6454: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 6455: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 6456: if ($output =~ m{^/(adm|res)/}) {
1.817 bisitz 6457: if ($output =~ m{^/res/}) {
6458: my $local_name = &Apache::lonnet::filelocation('',$output);
6459: &Apache::lonnet::repcopy($local_name);
6460: }
1.520 raeburn 6461: $output = &lonhttpdurl($output);
6462: }
1.63 www 6463: }
1.520 raeburn 6464: return $output;
1.63 www 6465: }
1.59 www 6466:
1.822 bisitz 6467: ##############################################
6468: =pod
6469:
1.832 bisitz 6470: =item * &authorspace()
6471:
1.1028 raeburn 6472: Inputs: $url (usually will be undef).
1.832 bisitz 6473:
1.1132 raeburn 6474: Returns: Path to Authoring Space containing the resource or
1.1028 raeburn 6475: directory being viewed (or for which action is being taken).
6476: If $url is provided, and begins /priv/<domain>/<uname>
6477: the path will be that portion of the $context argument.
6478: Otherwise the path will be for the author space of the current
6479: user when the current role is author, or for that of the
6480: co-author/assistant co-author space when the current role
6481: is co-author or assistant co-author.
1.832 bisitz 6482:
6483: =cut
6484:
6485: sub authorspace {
1.1028 raeburn 6486: my ($url) = @_;
6487: if ($url ne '') {
6488: if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
6489: return $1;
6490: }
6491: }
1.832 bisitz 6492: my $caname = '';
1.1024 www 6493: my $cadom = '';
1.1028 raeburn 6494: if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024 www 6495: ($cadom,$caname) =
1.832 bisitz 6496: ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028 raeburn 6497: } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832 bisitz 6498: $caname = $env{'user.name'};
1.1024 www 6499: $cadom = $env{'user.domain'};
1.832 bisitz 6500: }
1.1028 raeburn 6501: if (($caname ne '') && ($cadom ne '')) {
6502: return "/priv/$cadom/$caname/";
6503: }
6504: return;
1.832 bisitz 6505: }
6506:
6507: ##############################################
6508: =pod
6509:
1.822 bisitz 6510: =item * &head_subbox()
6511:
6512: Inputs: $content (contains HTML code with page functions, etc.)
6513:
6514: Returns: HTML div with $content
6515: To be included in page header
6516:
6517: =cut
6518:
6519: sub head_subbox {
6520: my ($content)=@_;
6521: my $output =
1.993 raeburn 6522: '<div class="LC_head_subbox">'
1.822 bisitz 6523: .$content
6524: .'</div>'
6525: }
6526:
6527: ##############################################
6528: =pod
6529:
6530: =item * &CSTR_pageheader()
6531:
1.1026 raeburn 6532: Input: (optional) filename from which breadcrumb trail is built.
6533: In most cases no input as needed, as $env{'request.filename'}
6534: is appropriate for use in building the breadcrumb trail.
1.1379 raeburn 6535: frameset flag
6536: If page header is being requested for use in a frameset, then
6537: the second (option) argument -- frameset will be true, and
6538: the target attribute set for links should be target="_parent".
1.1407 raeburn 6539: If $title is supplied as the thitd arg, that will be used to
6540: the left of the breadcrumbs tail for the current path.
1.822 bisitz 6541:
6542: Returns: HTML div with CSTR path and recent box
1.1132 raeburn 6543: To be included on Authoring Space pages
1.822 bisitz 6544:
6545: =cut
6546:
6547: sub CSTR_pageheader {
1.1407 raeburn 6548: my ($trailfile,$frameset,$title) = @_;
1.1026 raeburn 6549: if ($trailfile eq '') {
6550: $trailfile = $env{'request.filename'};
6551: }
6552:
6553: # this is for resources; directories have customtitle, and crumbs
6554: # and select recent are created in lonpubdir.pm
6555:
6556: my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022 www 6557: my ($udom,$uname,$thisdisfn)=
1.1113 raeburn 6558: ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026 raeburn 6559: my $formaction = "/priv/$udom/$uname/$thisdisfn";
6560: $formaction =~ s{/+}{/}g;
1.822 bisitz 6561:
6562: my $parentpath = '';
6563: my $lastitem = '';
6564: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
6565: $parentpath = $1;
6566: $lastitem = $2;
6567: } else {
6568: $lastitem = $thisdisfn;
6569: }
1.921 bisitz 6570:
1.1406 raeburn 6571: my $crsauthor;
1.1246 raeburn 6572: if (($env{'request.course.id'}) &&
6573: ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247 raeburn 6574: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246 raeburn 6575: $crsauthor = 1;
1.1406 raeburn 6576: if ($title eq '') {
6577: $title = &mt('Course Authoring Space');
6578: }
6579: } elsif ($title eq '') {
1.1246 raeburn 6580: $title = &mt('Authoring Space');
6581: }
6582:
1.1379 raeburn 6583: my ($target,$crumbtarget) = (' target="_top"','_top');
6584: if ($frameset) {
6585: $target = ' target="_parent"';
6586: $crumbtarget = '_parent';
6587: } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314 raeburn 6588: $target = '';
6589: $crumbtarget = '';
1.1379 raeburn 6590: } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378 raeburn 6591: $target = ' target="'.$env{'request.deeplink.target'}.'"';
6592: $crumbtarget = $env{'request.deeplink.target'};
6593: }
1.1313 raeburn 6594:
1.921 bisitz 6595: my $output =
1.1407 raeburn 6596: '<div>'
1.822 bisitz 6597: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246 raeburn 6598: .'<b>'.$title.'</b> '
1.1314 raeburn 6599: .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
6600: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921 bisitz 6601:
6602: if ($lastitem) {
6603: $output .=
6604: '<span class="LC_filename">'
6605: .$lastitem
6606: .'</span>';
6607: }
1.1245 raeburn 6608:
1.1246 raeburn 6609: if ($crsauthor) {
1.1379 raeburn 6610: $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6611: } else {
6612: $output .=
6613: '<br />'
1.1314 raeburn 6614: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246 raeburn 6615: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
6616: .'</form>'
1.1379 raeburn 6617: .&Apache::lonmenu::constspaceform($frameset);
1.1246 raeburn 6618: }
1.1407 raeburn 6619: $output .= '</div>';
1.921 bisitz 6620:
6621: return $output;
1.822 bisitz 6622: }
6623:
1.1419 raeburn 6624: ##############################################
6625: =pod
6626:
6627: =item * &nocodemirror()
6628:
6629: Input: None
6630:
6631: Returns: 1 if CodeMirror is deactivated based on
6632: user's preference, or domain default,
6633: if user indicated use of default.
6634:
6635: =cut
6636:
1.1416 raeburn 6637: sub nocodemirror {
6638: my $nocodem = $env{'environment.nocodemirror'};
6639: unless ($nocodem) {
6640: my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
6641: if ($domdefs{'nocodemirror'}) {
6642: $nocodem = 'yes';
6643: }
6644: }
1.1417 raeburn 6645: if ($nocodem eq 'yes') {
6646: return 1;
6647: }
6648: return;
1.1416 raeburn 6649: }
6650:
1.1419 raeburn 6651: ##############################################
6652: =pod
6653:
6654: =item * &permitted_editors()
6655:
1.1422 raeburn 6656: Input: $uri (optional)
1.1419 raeburn 6657:
6658: Returns: %editors hash in which keys are editors
1.1429 raeburn 6659: permitted in current Authoring Space,
6660: or in current course for web pages
6661: created in a course.
6662:
1.1419 raeburn 6663: Value for each key is 1. Possible keys
1.1429 raeburn 6664: are: edit, xml, and daxe.
6665:
6666: For a regular Authoring Space, if no specific
1.1419 raeburn 6667: set of editors has been set for the Author
6668: who owns the Authoring Space, then the
6669: domain default will be used. If no domain
6670: default has been set, then the keys will be
6671: edit and xml.
6672:
1.1429 raeburn 6673: For a course author, or for web pages created
6674: in a course, if no specific set of editors has
6675: been set for the course, then the domain
6676: course default will be used. If no domain
6677: course default has been set, then the keys
6678: will be edit and xml.
6679:
1.1419 raeburn 6680: =cut
6681:
1.1418 raeburn 6682: sub permitted_editors {
1.1422 raeburn 6683: my ($uri) = @_;
1.1429 raeburn 6684: my ($is_author,$is_coauthor,$is_course,$auname,$audom,%editors);
1.1418 raeburn 6685: if ($env{'request.role'} =~ m{^au\./}) {
6686: $is_author = 1;
6687: } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
6688: ($audom,$auname) = ($1,$2);
6689: if (($audom ne '') && ($auname ne '')) {
6690: if (($env{'user.domain'} eq $audom) &&
6691: ($env{'user.name'} eq $auname)) {
6692: $is_author = 1;
6693: } else {
6694: $is_coauthor = 1;
6695: }
6696: }
6697: } elsif ($env{'request.course.id'}) {
1.1429 raeburn 6698: my ($cdom,$cnum);
6699: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6700: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6701: if (($env{'request.editurl'} =~ m{^/priv/\Q$cdom/$cnum\E/}) ||
1.1430 raeburn 6702: ($env{'request.editurl'} =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}) ||
6703: ($uri =~ m{^/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/})) {
1.1429 raeburn 6704: $is_course = 1;
6705: } elsif ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
1.1418 raeburn 6706: ($audom,$auname) = ($1,$2);
6707: } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
6708: ($audom,$auname) = ($1,$2);
1.1422 raeburn 6709: } elsif (($uri eq '/daxesave') &&
1.1429 raeburn 6710: (($env{'form.path'} =~ m{^/daxeopen/priv/\Q$cdom/$cnum\E/}) ||
6711: ($env{'form.path'} =~ m{^/daxeopen/uploaded/\Q$cdom/$cnum\E/(docs|supplemental)/}))) {
6712: $is_course = 1;
6713: } elsif (($uri eq '/daxesave') &&
1.1422 raeburn 6714: ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
6715: ($audom,$auname) = ($1,$2);
1.1418 raeburn 6716: }
1.1429 raeburn 6717: unless ($is_course) {
6718: if (($audom ne '') && ($auname ne '')) {
6719: if (($env{'user.domain'} eq $audom) &&
6720: ($env{'user.name'} eq $auname)) {
6721: $is_author = 1;
6722: } else {
6723: $is_coauthor = 1;
6724: }
1.1418 raeburn 6725: }
6726: }
6727: }
6728: if ($is_author) {
6729: if (exists($env{'environment.editors'})) {
6730: map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
6731: } else {
6732: %editors = ( edit => 1,
6733: xml => 1,
6734: );
6735: }
6736: } elsif ($is_coauthor) {
6737: if (exists($env{"environment.internal.editors./$audom/$auname"})) {
6738: map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
6739: } else {
6740: %editors = ( edit => 1,
6741: xml => 1,
6742: );
6743: }
1.1429 raeburn 6744: } elsif ($is_course) {
6745: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.crseditors'})) {
6746: map { $editors{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.internal.crseditors'});
6747: } else {
6748: my %domdefaults = &Apache::lonnet::get_domain_defaults($env{'course.'.$env{'request.course.id'}.'.domain'});
6749: if (exists($domdefaults{'crseditors'})) {
6750: map { $editors{$_} = 1; } split(/,/,$domdefaults{'crseditors'});
6751: } else {
6752: %editors = ( edit => 1,
6753: xml => 1,
6754: );
6755: }
6756: }
1.1418 raeburn 6757: } else {
6758: %editors = ( edit => 1,
6759: xml => 1,
6760: );
6761: }
6762: return %editors;
6763: }
6764:
1.60 matthew 6765: ###############################################
6766: ###############################################
6767:
6768: =pod
6769:
1.112 bowersj2 6770: =back
6771:
1.549 albertel 6772: =head1 HTML Helpers
1.112 bowersj2 6773:
6774: =over 4
6775:
6776: =item * &bodytag()
1.60 matthew 6777:
6778: Returns a uniform header for LON-CAPA web pages.
6779:
6780: Inputs:
6781:
1.112 bowersj2 6782: =over 4
6783:
6784: =item * $title, A title to be displayed on the page.
6785:
6786: =item * $function, the current role (can be undef).
6787:
6788: =item * $addentries, extra parameters for the <body> tag.
6789:
6790: =item * $bodyonly, if defined, only return the <body> tag.
6791:
6792: =item * $domain, if defined, force a given domain.
6793:
6794: =item * $forcereg, if page should register as content page (relevant for
1.86 www 6795: text interface only)
1.60 matthew 6796:
1.814 bisitz 6797: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
6798: navigational links
1.317 albertel 6799:
1.338 albertel 6800: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
6801:
1.460 albertel 6802: =item * $args, optional argument valid values are
6803: no_auto_mt_title -> prevents &mt()ing the title arg
1.1274 raeburn 6804: use_absolute -> for external resource or syllabus, this will
6805: contain https://<hostname> if server uses
6806: https (as per hosts.tab), but request is for http
6807: hostname -> hostname, from $r->hostname().
1.460 albertel 6808:
1.1096 raeburn 6809: =item * $advtoolsref, optional argument, ref to an array containing
6810: inlineremote items to be added in "Functions" menu below
6811: breadcrumbs.
6812:
1.1316 raeburn 6813: =item * $ltiscope, optional argument, will be one of: resource, map or
6814: course, if LON-CAPA is in LTI Provider context. Value is
6815: the scope of use, i.e., launch was for access to a single, a map
6816: or the entire course.
6817:
6818: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
6819: context, this will contain the URL for the landing item in
6820: the course, after launch from an LTI Consumer
6821:
1.1318 raeburn 6822: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
6823: context, this will contain a reference to hash of items
6824: to be included in the page header and/or inline menu.
6825:
1.1385 raeburn 6826: =item * $menucoll, optional argument, if specific menu collection is in
6827: effect, either set as the default for the course, or set for
6828: the deeplink paramater for $env{'request.deeplink.login'}
6829: then $menucoll will be the number of that collection.
6830:
6831: =item * $menuref, optional argument, reference to a hash, containing the
6832: menu options included for the menu in effect, based on the
6833: configuration for the numbered menu collection in use.
6834:
6835: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
6836: within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
6837: if so, $showncrumbsref is set there to 1, and will propagate back
6838: via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
6839: being called a second time.
6840:
1.112 bowersj2 6841: =back
6842:
1.60 matthew 6843: Returns: A uniform header for LON-CAPA web pages.
6844: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
6845: If $bodyonly is undef or zero, an html string containing a <body> tag and
6846: other decorations will be returned.
6847:
6848: =cut
6849:
1.54 www 6850: sub bodytag {
1.831 bisitz 6851: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359 raeburn 6852: $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385 raeburn 6853: $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339 albertel 6854:
1.954 raeburn 6855: my $public;
6856: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
6857: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
6858: $public = 1;
6859: }
1.460 albertel 6860: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154 raeburn 6861: my $httphost = $args->{'use_absolute'};
1.1274 raeburn 6862: my $hostname = $args->{'hostname'};
1.339 albertel 6863:
1.183 matthew 6864: $function = &get_users_function() if (!$function);
1.339 albertel 6865: my $img = &designparm($function.'.img',$domain);
6866: my $font = &designparm($function.'.font',$domain);
6867: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
6868:
1.803 bisitz 6869: my %design = ( 'style' => 'margin-top: 0',
1.535 albertel 6870: 'bgcolor' => $pgbg,
1.339 albertel 6871: 'text' => $font,
6872: 'alink' => &designparm($function.'.alink',$domain),
6873: 'vlink' => &designparm($function.'.vlink',$domain),
6874: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 6875: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 6876:
1.63 www 6877: # role and realm
1.1178 raeburn 6878: my ($role,$realm) = split(m{\./},$env{'request.role'},2);
6879: if ($realm) {
6880: $realm = '/'.$realm;
6881: }
1.1357 raeburn 6882: if ($role eq 'ca') {
1.479 albertel 6883: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 6884: $realm = &plainname($rname,$rdom);
1.378 raeburn 6885: }
1.55 www 6886: # realm
1.1357 raeburn 6887: my ($cid,$sec);
1.258 albertel 6888: if ($env{'request.course.id'}) {
1.1357 raeburn 6889: $cid = $env{'request.course.id'};
6890: if ($env{'request.course.sec'}) {
6891: $sec = $env{'request.course.sec'};
6892: }
6893: } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
6894: if (&Apache::lonnet::is_course($1,$2)) {
6895: $cid = $1.'_'.$2;
6896: $sec = $3;
6897: }
6898: }
6899: if ($cid) {
1.378 raeburn 6900: if ($env{'request.role'} !~ /^cr/) {
6901: $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257 raeburn 6902: } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269 raeburn 6903: if ($env{'request.role.desc'}) {
6904: $role = $env{'request.role.desc'};
6905: } else {
6906: $role = &mt('Helpdesk[_1]',' '.$2);
6907: }
1.1257 raeburn 6908: } else {
6909: $role = (split(/\//,$role,4))[-1];
1.378 raeburn 6910: }
1.1357 raeburn 6911: if ($sec) {
6912: $role .= (' 'x2).'- '.&mt('section:').' '.$sec;
1.898 raeburn 6913: }
1.1357 raeburn 6914: $realm = $env{'course.'.$cid.'.description'};
1.378 raeburn 6915: } else {
6916: $role = &Apache::lonnet::plaintext($role);
1.54 www 6917: }
1.433 albertel 6918:
1.359 albertel 6919: if (!$realm) { $realm=' '; }
1.330 albertel 6920:
1.438 albertel 6921: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 6922:
1.101 www 6923: # construct main body tag
1.359 albertel 6924: my $bodytag = "<body $extra_body_attr>".
1.1235 raeburn 6925: &Apache::lontexconvert::init_math_support();
1.252 albertel 6926:
1.1131 raeburn 6927: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6928:
1.1130 raeburn 6929: if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60 matthew 6930: return $bodytag;
1.1130 raeburn 6931: }
1.359 albertel 6932:
1.954 raeburn 6933: if ($public) {
1.433 albertel 6934: undef($role);
6935: }
1.1318 raeburn 6936:
1.1359 raeburn 6937: my $showcrstitle = 1;
1.1357 raeburn 6938: if (($cid) && ($env{'request.lti.login'})) {
1.1318 raeburn 6939: if (ref($ltimenu) eq 'HASH') {
6940: unless ($ltimenu->{'role'}) {
6941: undef($role);
6942: }
6943: unless ($ltimenu->{'coursetitle'}) {
6944: $realm=' ';
1.1359 raeburn 6945: $showcrstitle = 0;
6946: }
6947: }
6948: } elsif (($cid) && ($menucoll)) {
6949: if (ref($menuref) eq 'HASH') {
6950: unless ($menuref->{'role'}) {
6951: undef($role);
6952: }
6953: unless ($menuref->{'crs'}) {
6954: $realm=' ';
6955: $showcrstitle = 0;
1.1318 raeburn 6956: }
6957: }
6958: }
6959:
1.762 bisitz 6960: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 6961: #
6962: # Extra info if you are the DC
6963: my $dc_info = '';
1.1359 raeburn 6964: if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357 raeburn 6965: (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917 raeburn 6966: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 6967: $dc_info =~ s/\s+$//;
1.359 albertel 6968: }
6969:
1.1237 raeburn 6970: my $crstype;
1.1357 raeburn 6971: if ($cid) {
6972: $crstype = $env{'course.'.$cid.'.type'};
1.1237 raeburn 6973: } elsif ($args->{'crstype'}) {
6974: $crstype = $args->{'crstype'};
6975: }
6976: if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
6977: undef($role);
6978: } else {
1.1242 raeburn 6979: $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237 raeburn 6980: }
1.853 droeschl 6981:
1.903 droeschl 6982: if ($env{'request.state'} eq 'construct') { $forcereg=1; }
6983:
6984: # if ($env{'request.state'} eq 'construct') {
6985: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
6986: # }
6987:
1.1130 raeburn 6988: $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154 raeburn 6989: Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359 albertel 6990:
1.1427 raeburn 6991: my $collapsible;
1.1423 raeburn 6992: if ($args->{'collapsible_header'} ne '') {
1.1427 raeburn 6993: $collapsible = 1;
6994: my ($menustate,$tiptext,$divclass);
6995: if ($args->{'start_collapsed'}) {
6996: $menustate = 'collapsed';
6997: $tiptext = 'display';
6998: $divclass = 'hidden';
6999: } else {
7000: $menustate = 'expanded';
7001: $tiptext = 'hide';
7002: $divclass = 'shown';
7003: }
7004: my $alttext = &mt('menu state: '.$menustate);
7005: my $tooltip = &mt($tiptext.' standard menus');
1.1421 raeburn 7006: $bodytag .= <<"END";
7007: <div id="LC_expandingContainer" style="display:inline;">
7008: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
1.1427 raeburn 7009: <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>
7010: <div class="LC_menus_content $divclass">
1.1421 raeburn 7011: END
7012: }
1.1318 raeburn 7013: unless ($args->{'no_primary_menu'}) {
1.1369 raeburn 7014: my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380 raeburn 7015: $args->{'links_disabled'},
1.1421 raeburn 7016: $args->{'links_target'},
1.1427 raeburn 7017: $collapsible);
1.359 albertel 7018:
1.1318 raeburn 7019: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
7020: if ($dc_info) {
7021: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
7022: }
7023: $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
7024: <em>$realm</em> $dc_info</div>|;
7025: return $bodytag;
7026: }
1.894 droeschl 7027:
1.1318 raeburn 7028: unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
7029: $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
7030: }
1.916 droeschl 7031:
1.1318 raeburn 7032: $bodytag .= $right;
1.852 droeschl 7033:
1.1318 raeburn 7034: if ($dc_info) {
7035: $dc_info = &dc_courseid_toggle($dc_info);
7036: }
7037: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917 raeburn 7038: }
1.916 droeschl 7039:
1.1169 raeburn 7040: #if directed to not display the secondary menu, don't.
1.1168 raeburn 7041: if ($args->{'no_secondary_menu'}) {
7042: return $bodytag;
7043: }
1.1169 raeburn 7044: #don't show menus for public users
1.954 raeburn 7045: if (!$public){
1.1318 raeburn 7046: unless ($args->{'no_inline_menu'}) {
7047: $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359 raeburn 7048: $args->{'no_primary_menu'},
1.1369 raeburn 7049: $menucoll,$menuref,
1.1380 raeburn 7050: $args->{'links_disabled'},
7051: $args->{'links_target'});
1.1318 raeburn 7052: }
1.903 droeschl 7053: $bodytag .= Apache::lonmenu::serverform();
1.920 raeburn 7054: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
7055: if ($env{'request.state'} eq 'construct') {
1.962 droeschl 7056: $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385 raeburn 7057: $args->{'bread_crumbs'},'','',$hostname,
7058: $ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7059: } elsif ($forcereg) {
7060: $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385 raeburn 7061: $args->{'group'},$args->{'hide_buttons'},
7062: $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096 raeburn 7063: } else {
7064: $bodytag .=
7065: &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
7066: $forcereg,$args->{'group'},
7067: $args->{'bread_crumbs'},
1.1274 raeburn 7068: $advtoolsref,'',$hostname);
1.920 raeburn 7069: }
1.903 droeschl 7070: }else{
7071: # this is to seperate menu from content when there's no secondary
7072: # menu. Especially needed for public accessible ressources.
7073: $bodytag .= '<hr style="clear:both" />';
7074: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.235 raeburn 7075: }
1.1423 raeburn 7076: if ($args->{'collapsible_header'} ne '') {
7077: $bodytag .= $args->{'collapsible_header'}.
7078: '<div id="LC_collapsible_separator"></div>'.
1.1421 raeburn 7079: '</div></div>';
7080: }
1.235 raeburn 7081: return $bodytag;
1.182 matthew 7082: }
7083:
1.917 raeburn 7084: sub dc_courseid_toggle {
7085: my ($dc_info) = @_;
1.980 raeburn 7086: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069 raeburn 7087: '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917 raeburn 7088: &mt('(More ...)').'</a></span>'.
7089: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
7090: }
7091:
1.330 albertel 7092: sub make_attr_string {
7093: my ($register,$attr_ref) = @_;
7094:
7095: if ($attr_ref && !ref($attr_ref)) {
7096: die("addentries Must be a hash ref ".
7097: join(':',caller(1))." ".
7098: join(':',caller(0))." ");
7099: }
7100:
7101: if ($register) {
1.339 albertel 7102: my ($on_load,$on_unload);
7103: foreach my $key (keys(%{$attr_ref})) {
7104: if (lc($key) eq 'onload') {
7105: $on_load.=$attr_ref->{$key}.';';
7106: delete($attr_ref->{$key});
7107:
7108: } elsif (lc($key) eq 'onunload') {
7109: $on_unload.=$attr_ref->{$key}.';';
7110: delete($attr_ref->{$key});
7111: }
7112: }
1.953 droeschl 7113: $attr_ref->{'onload'} = $on_load;
7114: $attr_ref->{'onunload'}= $on_unload;
1.330 albertel 7115: }
1.339 albertel 7116:
1.330 albertel 7117: my $attr_string;
1.1159 raeburn 7118: foreach my $attr (sort(keys(%$attr_ref))) {
1.330 albertel 7119: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
7120: }
7121: return $attr_string;
7122: }
7123:
7124:
1.182 matthew 7125: ###############################################
1.251 albertel 7126: ###############################################
7127:
7128: =pod
7129:
7130: =item * &endbodytag()
7131:
7132: Returns a uniform footer for LON-CAPA web pages.
7133:
1.635 raeburn 7134: Inputs: 1 - optional reference to an args hash
7135: If in the hash, key for noredirectlink has a value which evaluates to true,
7136: a 'Continue' link is not displayed if the page contains an
7137: internal redirect in the <head></head> section,
7138: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 7139:
7140: =cut
7141:
7142: sub endbodytag {
1.635 raeburn 7143: my ($args) = @_;
1.1080 raeburn 7144: my $endbodytag;
7145: unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
7146: $endbodytag='</body>';
7147: }
1.315 albertel 7148: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 7149: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386 raeburn 7150: my ($endbodyjs,$idattr);
7151: if ($env{'internal.head.to_opener'}) {
7152: my $linkid = 'LC_continue_link';
7153: $idattr = ' id="'.$linkid.'"';
7154: my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
7155: $endbodyjs=<<ENDJS;
7156: <script type="text/javascript">
7157: // <![CDATA[
7158: function ebFunction(evt) {
7159: evt.preventDefault();
7160: var dest = '$redirect_for_js';
7161: if (window.opener != null && !window.opener.closed) {
7162: window.opener.location.href=dest;
7163: window.close();
7164: } else {
7165: window.location.href=dest;
7166: }
7167: return false;
7168: }
7169:
7170: \$(document).ready(function () {
7171: if (document.getElementById('$linkid')) {
7172: var clickelem = document.getElementById('$linkid');
7173: clickelem.addEventListener('click',ebFunction,false);
7174: }
7175: });
7176: // ]]>
7177: </script>
7178: ENDJS
7179: }
1.635 raeburn 7180: $endbodytag=
1.1386 raeburn 7181: "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635 raeburn 7182: &mt('Continue').'</a>'.
7183: $endbodytag;
7184: }
1.315 albertel 7185: }
1.1411 raeburn 7186: if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
7187: $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
7188: }
1.251 albertel 7189: return $endbodytag;
7190: }
7191:
1.352 albertel 7192: =pod
7193:
7194: =item * &standard_css()
7195:
7196: Returns a style sheet
7197:
7198: Inputs: (all optional)
7199: domain -> force to color decorate a page for a specific
7200: domain
7201: function -> force usage of a specific rolish color scheme
7202: bgcolor -> override the default page bgcolor
7203:
7204: =cut
7205:
1.343 albertel 7206: sub standard_css {
1.345 albertel 7207: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 7208: $function = &get_users_function() if (!$function);
7209: my $img = &designparm($function.'.img', $domain);
7210: my $tabbg = &designparm($function.'.tabbg', $domain);
7211: my $font = &designparm($function.'.font', $domain);
1.801 tempelho 7212: my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791 tempelho 7213: #second colour for later usage
1.345 albertel 7214: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 7215: my $pgbg_or_bgcolor =
7216: $bgcolor ||
1.352 albertel 7217: &designparm($function.'.pgbg', $domain);
1.382 albertel 7218: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 7219: my $alink = &designparm($function.'.alink', $domain);
7220: my $vlink = &designparm($function.'.vlink', $domain);
7221: my $link = &designparm($function.'.link', $domain);
7222:
1.602 albertel 7223: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 7224: my $mono = 'monospace';
1.850 bisitz 7225: my $data_table_head = $sidebg;
7226: my $data_table_light = '#FAFAFA';
1.1060 bisitz 7227: my $data_table_dark = '#E0E0E0';
1.470 banghart 7228: my $data_table_darker = '#CCCCCC';
1.349 albertel 7229: my $data_table_highlight = '#FFFF00';
1.352 albertel 7230: my $mail_new = '#FFBB77';
7231: my $mail_new_hover = '#DD9955';
7232: my $mail_read = '#BBBB77';
7233: my $mail_read_hover = '#999944';
7234: my $mail_replied = '#AAAA88';
7235: my $mail_replied_hover = '#888855';
7236: my $mail_other = '#99BBBB';
7237: my $mail_other_hover = '#669999';
1.391 albertel 7238: my $table_header = '#DDDDDD';
1.489 raeburn 7239: my $feedback_link_bg = '#BBBBBB';
1.911 bisitz 7240: my $lg_border_color = '#C8C8C8';
1.952 onken 7241: my $button_hover = '#BF2317';
1.392 albertel 7242:
1.608 albertel 7243: my $border = ($env{'browser.type'} eq 'explorer' ||
1.911 bisitz 7244: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px'
7245: : '0 3px 0 4px';
1.448 albertel 7246:
1.523 albertel 7247:
1.343 albertel 7248: return <<END;
1.947 droeschl 7249:
7250: /* needed for iframe to allow 100% height in FF */
7251: body, html {
7252: margin: 0;
7253: padding: 0 0.5%;
7254: height: 99%; /* to avoid scrollbars */
7255: }
7256:
1.795 www 7257: body {
1.911 bisitz 7258: font-family: $sans;
7259: line-height:130%;
7260: font-size:0.83em;
7261: color:$font;
1.795 www 7262: }
7263:
1.959 onken 7264: a:focus,
7265: a:focus img {
1.795 www 7266: color: red;
7267: }
1.698 harmsja 7268:
1.911 bisitz 7269: form, .inline {
7270: display: inline;
1.795 www 7271: }
1.721 harmsja 7272:
1.1421 raeburn 7273: .LC_menus_content.shown{
1.1428 raeburn 7274: display: block;
1.1421 raeburn 7275: }
7276:
7277: .LC_menus_content.hidden {
7278: display: none;
7279: }
7280:
1.795 www 7281: .LC_right {
1.911 bisitz 7282: text-align:right;
1.795 www 7283: }
7284:
7285: .LC_middle {
1.911 bisitz 7286: vertical-align:middle;
1.795 www 7287: }
1.721 harmsja 7288:
1.1130 raeburn 7289: .LC_floatleft {
7290: float: left;
7291: }
7292:
7293: .LC_floatright {
7294: float: right;
7295: }
7296:
1.911 bisitz 7297: .LC_400Box {
7298: width:400px;
7299: }
1.721 harmsja 7300:
1.1421 raeburn 7301: #LC_collapsible_separator {
7302: border: 1px solid black;
7303: width: 99.9%;
7304: height: 0px;
7305: }
7306:
1.947 droeschl 7307: .LC_iframecontainer {
7308: width: 98%;
7309: margin: 0;
7310: position: fixed;
7311: top: 8.5em;
7312: bottom: 0;
7313: }
7314:
7315: .LC_iframecontainer iframe{
7316: border: none;
7317: width: 100%;
7318: height: 100%;
7319: }
7320:
1.778 bisitz 7321: .LC_filename {
7322: font-family: $mono;
7323: white-space:pre;
1.921 bisitz 7324: font-size: 120%;
1.778 bisitz 7325: }
7326:
7327: .LC_fileicon {
7328: border: none;
7329: height: 1.3em;
7330: vertical-align: text-bottom;
7331: margin-right: 0.3em;
7332: text-decoration:none;
7333: }
7334:
1.1008 www 7335: .LC_setting {
7336: text-decoration:underline;
7337: }
7338:
1.350 albertel 7339: .LC_error {
7340: color: red;
7341: }
1.795 www 7342:
1.1097 bisitz 7343: .LC_warning {
7344: color: darkorange;
7345: }
7346:
1.457 albertel 7347: .LC_diff_removed {
1.733 bisitz 7348: color: red;
1.394 albertel 7349: }
1.532 albertel 7350:
7351: .LC_info,
1.457 albertel 7352: .LC_success,
7353: .LC_diff_added {
1.350 albertel 7354: color: green;
7355: }
1.795 www 7356:
1.802 bisitz 7357: div.LC_confirm_box {
7358: background-color: #FAFAFA;
7359: border: 1px solid $lg_border_color;
7360: margin-right: 0;
7361: padding: 5px;
7362: }
7363:
7364: div.LC_confirm_box .LC_error img,
7365: div.LC_confirm_box .LC_success img {
7366: vertical-align: middle;
7367: }
7368:
1.1242 raeburn 7369: .LC_maxwidth {
7370: max-width: 100%;
7371: height: auto;
7372: }
7373:
1.1243 raeburn 7374: .LC_textsize_mobile {
7375: \@media only screen and (max-device-width: 480px) {
7376: -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
7377: }
7378: }
7379:
1.440 albertel 7380: .LC_icon {
1.771 droeschl 7381: border: none;
1.790 droeschl 7382: vertical-align: middle;
1.771 droeschl 7383: }
7384:
1.543 albertel 7385: .LC_docs_spacer {
7386: width: 25px;
7387: height: 1px;
1.771 droeschl 7388: border: none;
1.543 albertel 7389: }
1.346 albertel 7390:
1.532 albertel 7391: .LC_internal_info {
1.735 bisitz 7392: color: #999999;
1.532 albertel 7393: }
7394:
1.794 www 7395: .LC_discussion {
1.1050 www 7396: background: $data_table_dark;
1.911 bisitz 7397: border: 1px solid black;
7398: margin: 2px;
1.794 www 7399: }
7400:
7401: .LC_disc_action_left {
1.1050 www 7402: background: $sidebg;
1.911 bisitz 7403: text-align: left;
1.1050 www 7404: padding: 4px;
7405: margin: 2px;
1.794 www 7406: }
7407:
7408: .LC_disc_action_right {
1.1050 www 7409: background: $sidebg;
1.911 bisitz 7410: text-align: right;
1.1050 www 7411: padding: 4px;
7412: margin: 2px;
1.794 www 7413: }
7414:
7415: .LC_disc_new_item {
1.911 bisitz 7416: background: white;
7417: border: 2px solid red;
1.1050 www 7418: margin: 4px;
7419: padding: 4px;
1.794 www 7420: }
7421:
7422: .LC_disc_old_item {
1.911 bisitz 7423: background: white;
1.1050 www 7424: margin: 4px;
7425: padding: 4px;
1.794 www 7426: }
7427:
1.458 albertel 7428: table.LC_pastsubmission {
7429: border: 1px solid black;
7430: margin: 2px;
7431: }
7432:
1.924 bisitz 7433: table#LC_menubuttons {
1.345 albertel 7434: width: 100%;
7435: background: $pgbg;
1.392 albertel 7436: border: 2px;
1.402 albertel 7437: border-collapse: separate;
1.803 bisitz 7438: padding: 0;
1.345 albertel 7439: }
1.392 albertel 7440:
1.801 tempelho 7441: table#LC_title_bar a {
7442: color: $fontmenu;
7443: }
1.836 bisitz 7444:
1.807 droeschl 7445: table#LC_title_bar {
1.819 tempelho 7446: clear: both;
1.836 bisitz 7447: display: none;
1.807 droeschl 7448: }
7449:
1.795 www 7450: table#LC_title_bar,
1.933 droeschl 7451: table.LC_breadcrumbs, /* obsolete? */
1.393 albertel 7452: table#LC_title_bar.LC_with_remote {
1.359 albertel 7453: width: 100%;
1.392 albertel 7454: border-color: $pgbg;
7455: border-style: solid;
7456: border-width: $border;
1.379 albertel 7457: background: $pgbg;
1.801 tempelho 7458: color: $fontmenu;
1.392 albertel 7459: border-collapse: collapse;
1.803 bisitz 7460: padding: 0;
1.819 tempelho 7461: margin: 0;
1.359 albertel 7462: }
1.795 www 7463:
1.933 droeschl 7464: ul.LC_breadcrumb_tools_outerlist {
1.913 droeschl 7465: margin: 0;
7466: padding: 0;
1.933 droeschl 7467: position: relative;
7468: list-style: none;
1.913 droeschl 7469: }
1.933 droeschl 7470: ul.LC_breadcrumb_tools_outerlist li {
1.913 droeschl 7471: display: inline;
7472: }
1.933 droeschl 7473:
7474: .LC_breadcrumb_tools_navigation {
1.913 droeschl 7475: padding: 0;
1.933 droeschl 7476: margin: 0;
7477: float: left;
1.913 droeschl 7478: }
1.933 droeschl 7479: .LC_breadcrumb_tools_tools {
7480: padding: 0;
7481: margin: 0;
1.913 droeschl 7482: float: right;
7483: }
7484:
1.1240 raeburn 7485: .LC_placement_prog {
7486: padding-right: 20px;
7487: font-weight: bold;
7488: font-size: 90%;
7489: }
7490:
1.359 albertel 7491: table#LC_title_bar td {
7492: background: $tabbg;
7493: }
1.795 www 7494:
1.911 bisitz 7495: table#LC_menubuttons img {
1.803 bisitz 7496: border: none;
1.346 albertel 7497: }
1.795 www 7498:
1.842 droeschl 7499: .LC_breadcrumbs_component {
1.911 bisitz 7500: float: right;
7501: margin: 0 1em;
1.357 albertel 7502: }
1.842 droeschl 7503: .LC_breadcrumbs_component img {
1.911 bisitz 7504: vertical-align: middle;
1.777 tempelho 7505: }
1.795 www 7506:
1.1243 raeburn 7507: .LC_breadcrumbs_hoverable {
7508: background: $sidebg;
7509: }
7510:
1.383 albertel 7511: td.LC_table_cell_checkbox {
7512: text-align: center;
7513: }
1.795 www 7514:
7515: .LC_fontsize_small {
1.911 bisitz 7516: font-size: 70%;
1.705 tempelho 7517: }
7518:
1.844 bisitz 7519: #LC_breadcrumbs {
1.911 bisitz 7520: clear:both;
7521: background: $sidebg;
7522: border-bottom: 1px solid $lg_border_color;
7523: line-height: 2.5em;
1.933 droeschl 7524: overflow: hidden;
1.911 bisitz 7525: margin: 0;
7526: padding: 0;
1.995 raeburn 7527: text-align: left;
1.819 tempelho 7528: }
1.862 bisitz 7529:
1.1098 bisitz 7530: .LC_head_subbox, .LC_actionbox {
1.911 bisitz 7531: clear:both;
7532: background: #F8F8F8; /* $sidebg; */
1.915 droeschl 7533: border: 1px solid $sidebg;
1.1098 bisitz 7534: margin: 0 0 10px 0;
1.966 bisitz 7535: padding: 3px;
1.995 raeburn 7536: text-align: left;
1.822 bisitz 7537: }
7538:
1.795 www 7539: .LC_fontsize_medium {
1.911 bisitz 7540: font-size: 85%;
1.705 tempelho 7541: }
7542:
1.795 www 7543: .LC_fontsize_large {
1.911 bisitz 7544: font-size: 120%;
1.705 tempelho 7545: }
7546:
1.346 albertel 7547: .LC_menubuttons_inline_text {
7548: color: $font;
1.698 harmsja 7549: font-size: 90%;
1.701 harmsja 7550: padding-left:3px;
1.346 albertel 7551: }
7552:
1.934 droeschl 7553: .LC_menubuttons_inline_text img{
7554: vertical-align: middle;
7555: }
7556:
1.1051 www 7557: li.LC_menubuttons_inline_text img {
1.951 onken 7558: cursor:pointer;
1.1002 droeschl 7559: text-decoration: none;
1.951 onken 7560: }
7561:
1.526 www 7562: .LC_menubuttons_link {
7563: text-decoration: none;
7564: }
1.795 www 7565:
1.522 albertel 7566: .LC_menubuttons_category {
1.521 www 7567: color: $font;
1.526 www 7568: background: $pgbg;
1.521 www 7569: font-size: larger;
7570: font-weight: bold;
7571: }
7572:
1.346 albertel 7573: td.LC_menubuttons_text {
1.911 bisitz 7574: color: $font;
1.346 albertel 7575: }
1.706 harmsja 7576:
1.346 albertel 7577: .LC_current_location {
7578: background: $tabbg;
7579: }
1.795 www 7580:
1.1286 raeburn 7581: td.LC_zero_height {
7582: line-height: 0;
7583: cellpadding: 0;
7584: }
7585:
1.938 bisitz 7586: table.LC_data_table {
1.347 albertel 7587: border: 1px solid #000000;
1.402 albertel 7588: border-collapse: separate;
1.426 albertel 7589: border-spacing: 1px;
1.610 albertel 7590: background: $pgbg;
1.347 albertel 7591: }
1.795 www 7592:
1.422 albertel 7593: .LC_data_table_dense {
7594: font-size: small;
7595: }
1.795 www 7596:
1.507 raeburn 7597: table.LC_nested_outer {
7598: border: 1px solid #000000;
1.589 raeburn 7599: border-collapse: collapse;
1.803 bisitz 7600: border-spacing: 0;
1.507 raeburn 7601: width: 100%;
7602: }
1.795 www 7603:
1.879 raeburn 7604: table.LC_innerpickbox,
1.507 raeburn 7605: table.LC_nested {
1.803 bisitz 7606: border: none;
1.589 raeburn 7607: border-collapse: collapse;
1.803 bisitz 7608: border-spacing: 0;
1.507 raeburn 7609: width: 100%;
7610: }
1.795 www 7611:
1.911 bisitz 7612: table.LC_data_table tr th,
7613: table.LC_calendar tr th,
1.879 raeburn 7614: table.LC_prior_tries tr th,
7615: table.LC_innerpickbox tr th {
1.349 albertel 7616: font-weight: bold;
7617: background-color: $data_table_head;
1.801 tempelho 7618: color:$fontmenu;
1.701 harmsja 7619: font-size:90%;
1.347 albertel 7620: }
1.795 www 7621:
1.879 raeburn 7622: table.LC_innerpickbox tr th,
7623: table.LC_innerpickbox tr td {
7624: vertical-align: top;
7625: }
7626:
1.711 raeburn 7627: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 7628: background-color: #CCCCCC;
1.711 raeburn 7629: font-weight: bold;
7630: text-align: left;
7631: }
1.795 www 7632:
1.912 bisitz 7633: table.LC_data_table tr.LC_odd_row > td {
7634: background-color: $data_table_light;
7635: padding: 2px;
7636: vertical-align: top;
7637: }
7638:
1.809 bisitz 7639: table.LC_pick_box tr > td.LC_odd_row {
1.349 albertel 7640: background-color: $data_table_light;
1.912 bisitz 7641: vertical-align: top;
7642: }
7643:
7644: table.LC_data_table tr.LC_even_row > td {
7645: background-color: $data_table_dark;
1.425 albertel 7646: padding: 2px;
1.900 bisitz 7647: vertical-align: top;
1.347 albertel 7648: }
1.795 www 7649:
1.809 bisitz 7650: table.LC_pick_box tr > td.LC_even_row {
1.349 albertel 7651: background-color: $data_table_dark;
1.900 bisitz 7652: vertical-align: top;
1.347 albertel 7653: }
1.795 www 7654:
1.425 albertel 7655: table.LC_data_table tr.LC_data_table_highlight td {
7656: background-color: $data_table_darker;
7657: }
1.795 www 7658:
1.639 raeburn 7659: table.LC_data_table tr td.LC_leftcol_header {
7660: background-color: $data_table_head;
7661: font-weight: bold;
7662: }
1.795 www 7663:
1.451 albertel 7664: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 7665: table.LC_nested tr.LC_empty_row td {
1.421 albertel 7666: font-weight: bold;
7667: font-style: italic;
7668: text-align: center;
7669: padding: 8px;
1.347 albertel 7670: }
1.795 www 7671:
1.1114 raeburn 7672: table.LC_data_table tr.LC_empty_row td,
7673: table.LC_data_table tr.LC_footer_row td {
1.940 bisitz 7674: background-color: $sidebg;
7675: }
7676:
7677: table.LC_nested tr.LC_empty_row td {
7678: background-color: #FFFFFF;
7679: }
7680:
1.890 droeschl 7681: table.LC_caption {
7682: }
7683:
1.507 raeburn 7684: table.LC_nested tr.LC_empty_row td {
1.465 albertel 7685: padding: 4ex
7686: }
1.795 www 7687:
1.507 raeburn 7688: table.LC_nested_outer tr th {
7689: font-weight: bold;
1.801 tempelho 7690: color:$fontmenu;
1.507 raeburn 7691: background-color: $data_table_head;
1.701 harmsja 7692: font-size: small;
1.507 raeburn 7693: border-bottom: 1px solid #000000;
7694: }
1.795 www 7695:
1.507 raeburn 7696: table.LC_nested_outer tr td.LC_subheader {
7697: background-color: $data_table_head;
7698: font-weight: bold;
7699: font-size: small;
7700: border-bottom: 1px solid #000000;
7701: text-align: right;
1.451 albertel 7702: }
1.795 www 7703:
1.507 raeburn 7704: table.LC_nested tr.LC_info_row td {
1.735 bisitz 7705: background-color: #CCCCCC;
1.451 albertel 7706: font-weight: bold;
7707: font-size: small;
1.507 raeburn 7708: text-align: center;
7709: }
1.795 www 7710:
1.589 raeburn 7711: table.LC_nested tr.LC_info_row td.LC_left_item,
7712: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 7713: text-align: left;
1.451 albertel 7714: }
1.795 www 7715:
1.507 raeburn 7716: table.LC_nested td {
1.735 bisitz 7717: background-color: #FFFFFF;
1.451 albertel 7718: font-size: small;
1.507 raeburn 7719: }
1.795 www 7720:
1.507 raeburn 7721: table.LC_nested_outer tr th.LC_right_item,
7722: table.LC_nested tr.LC_info_row td.LC_right_item,
7723: table.LC_nested tr.LC_odd_row td.LC_right_item,
7724: table.LC_nested tr td.LC_right_item {
1.451 albertel 7725: text-align: right;
7726: }
7727:
1.507 raeburn 7728: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 7729: background-color: #EEEEEE;
1.451 albertel 7730: }
7731:
1.473 raeburn 7732: table.LC_createuser {
7733: }
7734:
7735: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 7736: font-size: small;
1.473 raeburn 7737: }
7738:
7739: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 7740: background-color: #CCCCCC;
1.473 raeburn 7741: font-weight: bold;
7742: text-align: center;
7743: }
7744:
1.349 albertel 7745: table.LC_calendar {
7746: border: 1px solid #000000;
7747: border-collapse: collapse;
1.917 raeburn 7748: width: 98%;
1.349 albertel 7749: }
1.795 www 7750:
1.349 albertel 7751: table.LC_calendar_pickdate {
7752: font-size: xx-small;
7753: }
1.795 www 7754:
1.349 albertel 7755: table.LC_calendar tr td {
7756: border: 1px solid #000000;
7757: vertical-align: top;
1.917 raeburn 7758: width: 14%;
1.349 albertel 7759: }
1.795 www 7760:
1.349 albertel 7761: table.LC_calendar tr td.LC_calendar_day_empty {
7762: background-color: $data_table_dark;
7763: }
1.795 www 7764:
1.779 bisitz 7765: table.LC_calendar tr td.LC_calendar_day_current {
7766: background-color: $data_table_highlight;
1.777 tempelho 7767: }
1.795 www 7768:
1.938 bisitz 7769: table.LC_data_table tr td.LC_mail_new {
1.349 albertel 7770: background-color: $mail_new;
7771: }
1.795 www 7772:
1.938 bisitz 7773: table.LC_data_table tr.LC_mail_new:hover {
1.349 albertel 7774: background-color: $mail_new_hover;
7775: }
1.795 www 7776:
1.938 bisitz 7777: table.LC_data_table tr td.LC_mail_read {
1.349 albertel 7778: background-color: $mail_read;
7779: }
1.795 www 7780:
1.938 bisitz 7781: /*
7782: table.LC_data_table tr.LC_mail_read:hover {
1.349 albertel 7783: background-color: $mail_read_hover;
7784: }
1.938 bisitz 7785: */
1.795 www 7786:
1.938 bisitz 7787: table.LC_data_table tr td.LC_mail_replied {
1.349 albertel 7788: background-color: $mail_replied;
7789: }
1.795 www 7790:
1.938 bisitz 7791: /*
7792: table.LC_data_table tr.LC_mail_replied:hover {
1.349 albertel 7793: background-color: $mail_replied_hover;
7794: }
1.938 bisitz 7795: */
1.795 www 7796:
1.938 bisitz 7797: table.LC_data_table tr td.LC_mail_other {
1.349 albertel 7798: background-color: $mail_other;
7799: }
1.795 www 7800:
1.938 bisitz 7801: /*
7802: table.LC_data_table tr.LC_mail_other:hover {
1.349 albertel 7803: background-color: $mail_other_hover;
7804: }
1.938 bisitz 7805: */
1.494 raeburn 7806:
1.777 tempelho 7807: table.LC_data_table tr > td.LC_browser_file,
7808: table.LC_data_table tr > td.LC_browser_file_published {
1.899 bisitz 7809: background: #AAEE77;
1.389 albertel 7810: }
1.795 www 7811:
1.777 tempelho 7812: table.LC_data_table tr > td.LC_browser_file_locked,
7813: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 7814: background: #FFAA99;
1.387 albertel 7815: }
1.795 www 7816:
1.777 tempelho 7817: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899 bisitz 7818: background: #888888;
1.779 bisitz 7819: }
1.795 www 7820:
1.777 tempelho 7821: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 bisitz 7822: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899 bisitz 7823: background: #F8F866;
1.777 tempelho 7824: }
1.795 www 7825:
1.696 bisitz 7826: table.LC_data_table tr.LC_browser_folder > td {
1.899 bisitz 7827: background: #E0E8FF;
1.387 albertel 7828: }
1.696 bisitz 7829:
1.707 bisitz 7830: table.LC_data_table tr > td.LC_roles_is {
1.911 bisitz 7831: /* background: #77FF77; */
1.707 bisitz 7832: }
1.795 www 7833:
1.707 bisitz 7834: table.LC_data_table tr > td.LC_roles_future {
1.939 bisitz 7835: border-right: 8px solid #FFFF77;
1.707 bisitz 7836: }
1.795 www 7837:
1.707 bisitz 7838: table.LC_data_table tr > td.LC_roles_will {
1.939 bisitz 7839: border-right: 8px solid #FFAA77;
1.707 bisitz 7840: }
1.795 www 7841:
1.707 bisitz 7842: table.LC_data_table tr > td.LC_roles_expired {
1.939 bisitz 7843: border-right: 8px solid #FF7777;
1.707 bisitz 7844: }
1.795 www 7845:
1.707 bisitz 7846: table.LC_data_table tr > td.LC_roles_will_not {
1.939 bisitz 7847: border-right: 8px solid #AAFF77;
1.707 bisitz 7848: }
1.795 www 7849:
1.707 bisitz 7850: table.LC_data_table tr > td.LC_roles_selected {
1.939 bisitz 7851: border-right: 8px solid #11CC55;
1.707 bisitz 7852: }
7853:
1.388 albertel 7854: span.LC_current_location {
1.701 harmsja 7855: font-size:larger;
1.388 albertel 7856: background: $pgbg;
7857: }
1.387 albertel 7858:
1.1029 www 7859: span.LC_current_nav_location {
7860: font-weight:bold;
7861: background: $sidebg;
7862: }
7863:
1.395 albertel 7864: span.LC_parm_menu_item {
7865: font-size: larger;
7866: }
1.795 www 7867:
1.395 albertel 7868: span.LC_parm_scope_all {
7869: color: red;
7870: }
1.795 www 7871:
1.395 albertel 7872: span.LC_parm_scope_folder {
7873: color: green;
7874: }
1.795 www 7875:
1.395 albertel 7876: span.LC_parm_scope_resource {
7877: color: orange;
7878: }
1.795 www 7879:
1.395 albertel 7880: span.LC_parm_part {
7881: color: blue;
7882: }
1.795 www 7883:
1.911 bisitz 7884: span.LC_parm_folder,
7885: span.LC_parm_symb {
1.395 albertel 7886: font-size: x-small;
7887: font-family: $mono;
7888: color: #AAAAAA;
7889: }
7890:
1.977 bisitz 7891: ul.LC_parm_parmlist li {
7892: display: inline-block;
7893: padding: 0.3em 0.8em;
7894: vertical-align: top;
7895: width: 150px;
7896: border-top:1px solid $lg_border_color;
7897: }
7898:
1.795 www 7899: td.LC_parm_overview_level_menu,
7900: td.LC_parm_overview_map_menu,
7901: td.LC_parm_overview_parm_selectors,
7902: td.LC_parm_overview_restrictions {
1.396 albertel 7903: border: 1px solid black;
7904: border-collapse: collapse;
7905: }
1.795 www 7906:
1.1285 raeburn 7907: span.LC_parm_recursive,
7908: td.LC_parm_recursive {
7909: font-weight: bold;
7910: font-size: smaller;
7911: }
7912:
1.396 albertel 7913: table.LC_parm_overview_restrictions td {
7914: border-width: 1px 4px 1px 4px;
7915: border-style: solid;
7916: border-color: $pgbg;
7917: text-align: center;
7918: }
1.795 www 7919:
1.396 albertel 7920: table.LC_parm_overview_restrictions th {
7921: background: $tabbg;
7922: border-width: 1px 4px 1px 4px;
7923: border-style: solid;
7924: border-color: $pgbg;
7925: }
1.795 www 7926:
1.398 albertel 7927: table#LC_helpmenu {
1.803 bisitz 7928: border: none;
1.398 albertel 7929: height: 55px;
1.803 bisitz 7930: border-spacing: 0;
1.398 albertel 7931: }
7932:
7933: table#LC_helpmenu fieldset legend {
7934: font-size: larger;
7935: }
1.795 www 7936:
1.397 albertel 7937: table#LC_helpmenu_links {
7938: width: 100%;
7939: border: 1px solid black;
7940: background: $pgbg;
1.803 bisitz 7941: padding: 0;
1.397 albertel 7942: border-spacing: 1px;
7943: }
1.795 www 7944:
1.397 albertel 7945: table#LC_helpmenu_links tr td {
7946: padding: 1px;
7947: background: $tabbg;
1.399 albertel 7948: text-align: center;
7949: font-weight: bold;
1.397 albertel 7950: }
1.396 albertel 7951:
1.795 www 7952: table#LC_helpmenu_links a:link,
7953: table#LC_helpmenu_links a:visited,
1.397 albertel 7954: table#LC_helpmenu_links a:active {
7955: text-decoration: none;
7956: color: $font;
7957: }
1.795 www 7958:
1.397 albertel 7959: table#LC_helpmenu_links a:hover {
7960: text-decoration: underline;
7961: color: $vlink;
7962: }
1.396 albertel 7963:
1.417 albertel 7964: .LC_chrt_popup_exists {
7965: border: 1px solid #339933;
7966: margin: -1px;
7967: }
1.795 www 7968:
1.417 albertel 7969: .LC_chrt_popup_up {
7970: border: 1px solid yellow;
7971: margin: -1px;
7972: }
1.795 www 7973:
1.417 albertel 7974: .LC_chrt_popup {
7975: border: 1px solid #8888FF;
7976: background: #CCCCFF;
7977: }
1.795 www 7978:
1.421 albertel 7979: table.LC_pick_box {
7980: border-collapse: separate;
7981: background: white;
7982: border: 1px solid black;
7983: border-spacing: 1px;
7984: }
1.795 www 7985:
1.421 albertel 7986: table.LC_pick_box td.LC_pick_box_title {
1.850 bisitz 7987: background: $sidebg;
1.421 albertel 7988: font-weight: bold;
1.900 bisitz 7989: text-align: left;
1.740 bisitz 7990: vertical-align: top;
1.421 albertel 7991: width: 184px;
7992: padding: 8px;
7993: }
1.795 www 7994:
1.579 raeburn 7995: table.LC_pick_box td.LC_pick_box_value {
7996: text-align: left;
7997: padding: 8px;
7998: }
1.795 www 7999:
1.579 raeburn 8000: table.LC_pick_box td.LC_pick_box_select {
8001: text-align: left;
8002: padding: 8px;
8003: }
1.795 www 8004:
1.424 albertel 8005: table.LC_pick_box td.LC_pick_box_separator {
1.803 bisitz 8006: padding: 0;
1.421 albertel 8007: height: 1px;
8008: background: black;
8009: }
1.795 www 8010:
1.421 albertel 8011: table.LC_pick_box td.LC_pick_box_submit {
8012: text-align: right;
8013: }
1.795 www 8014:
1.579 raeburn 8015: table.LC_pick_box td.LC_evenrow_value {
8016: text-align: left;
8017: padding: 8px;
8018: background-color: $data_table_light;
8019: }
1.795 www 8020:
1.579 raeburn 8021: table.LC_pick_box td.LC_oddrow_value {
8022: text-align: left;
8023: padding: 8px;
8024: background-color: $data_table_light;
8025: }
1.795 www 8026:
1.579 raeburn 8027: span.LC_helpform_receipt_cat {
8028: font-weight: bold;
8029: }
1.795 www 8030:
1.424 albertel 8031: table.LC_group_priv_box {
8032: background: white;
8033: border: 1px solid black;
8034: border-spacing: 1px;
8035: }
1.795 www 8036:
1.424 albertel 8037: table.LC_group_priv_box td.LC_pick_box_title {
8038: background: $tabbg;
8039: font-weight: bold;
8040: text-align: right;
8041: width: 184px;
8042: }
1.795 www 8043:
1.424 albertel 8044: table.LC_group_priv_box td.LC_groups_fixed {
8045: background: $data_table_light;
8046: text-align: center;
8047: }
1.795 www 8048:
1.424 albertel 8049: table.LC_group_priv_box td.LC_groups_optional {
8050: background: $data_table_dark;
8051: text-align: center;
8052: }
1.795 www 8053:
1.424 albertel 8054: table.LC_group_priv_box td.LC_groups_functionality {
8055: background: $data_table_darker;
8056: text-align: center;
8057: font-weight: bold;
8058: }
1.795 www 8059:
1.424 albertel 8060: table.LC_group_priv td {
8061: text-align: left;
1.803 bisitz 8062: padding: 0;
1.424 albertel 8063: }
8064:
8065: .LC_navbuttons {
8066: margin: 2ex 0ex 2ex 0ex;
8067: }
1.795 www 8068:
1.423 albertel 8069: .LC_topic_bar {
8070: font-weight: bold;
8071: background: $tabbg;
1.918 wenzelju 8072: margin: 1em 0em 1em 2em;
1.805 bisitz 8073: padding: 3px;
1.918 wenzelju 8074: font-size: 1.2em;
1.423 albertel 8075: }
1.795 www 8076:
1.423 albertel 8077: .LC_topic_bar span {
1.918 wenzelju 8078: left: 0.5em;
8079: position: absolute;
1.423 albertel 8080: vertical-align: middle;
1.918 wenzelju 8081: font-size: 1.2em;
1.423 albertel 8082: }
1.795 www 8083:
1.423 albertel 8084: table.LC_course_group_status {
8085: margin: 20px;
8086: }
1.795 www 8087:
1.423 albertel 8088: table.LC_status_selector td {
8089: vertical-align: top;
8090: text-align: center;
1.424 albertel 8091: padding: 4px;
8092: }
1.795 www 8093:
1.599 albertel 8094: div.LC_feedback_link {
1.616 albertel 8095: clear: both;
1.829 kalberla 8096: background: $sidebg;
1.779 bisitz 8097: width: 100%;
1.829 kalberla 8098: padding-bottom: 10px;
8099: border: 1px $tabbg solid;
1.833 kalberla 8100: height: 22px;
8101: line-height: 22px;
8102: padding-top: 5px;
8103: }
8104:
8105: div.LC_feedback_link img {
8106: height: 22px;
1.867 kalberla 8107: vertical-align:middle;
1.829 kalberla 8108: }
8109:
1.911 bisitz 8110: div.LC_feedback_link a {
1.829 kalberla 8111: text-decoration: none;
1.489 raeburn 8112: }
1.795 www 8113:
1.867 kalberla 8114: div.LC_comblock {
1.911 bisitz 8115: display:inline;
1.867 kalberla 8116: color:$font;
8117: font-size:90%;
8118: }
8119:
8120: div.LC_feedback_link div.LC_comblock {
8121: padding-left:5px;
8122: }
8123:
8124: div.LC_feedback_link div.LC_comblock a {
8125: color:$font;
8126: }
8127:
1.489 raeburn 8128: span.LC_feedback_link {
1.858 bisitz 8129: /* background: $feedback_link_bg; */
1.599 albertel 8130: font-size: larger;
8131: }
1.795 www 8132:
1.599 albertel 8133: span.LC_message_link {
1.858 bisitz 8134: /* background: $feedback_link_bg; */
1.599 albertel 8135: font-size: larger;
8136: position: absolute;
8137: right: 1em;
1.489 raeburn 8138: }
1.421 albertel 8139:
1.515 albertel 8140: table.LC_prior_tries {
1.524 albertel 8141: border: 1px solid #000000;
8142: border-collapse: separate;
8143: border-spacing: 1px;
1.515 albertel 8144: }
1.523 albertel 8145:
1.515 albertel 8146: table.LC_prior_tries td {
1.524 albertel 8147: padding: 2px;
1.515 albertel 8148: }
1.523 albertel 8149:
8150: .LC_answer_correct {
1.795 www 8151: background: lightgreen;
8152: color: darkgreen;
8153: padding: 6px;
1.523 albertel 8154: }
1.795 www 8155:
1.523 albertel 8156: .LC_answer_charged_try {
1.797 www 8157: background: #FFAAAA;
1.795 www 8158: color: darkred;
8159: padding: 6px;
1.523 albertel 8160: }
1.795 www 8161:
1.779 bisitz 8162: .LC_answer_not_charged_try,
1.523 albertel 8163: .LC_answer_no_grade,
8164: .LC_answer_late {
1.795 www 8165: background: lightyellow;
1.523 albertel 8166: color: black;
1.795 www 8167: padding: 6px;
1.523 albertel 8168: }
1.795 www 8169:
1.523 albertel 8170: .LC_answer_previous {
1.795 www 8171: background: lightblue;
8172: color: darkblue;
8173: padding: 6px;
1.523 albertel 8174: }
1.795 www 8175:
1.779 bisitz 8176: .LC_answer_no_message {
1.777 tempelho 8177: background: #FFFFFF;
8178: color: black;
1.795 www 8179: padding: 6px;
1.779 bisitz 8180: }
1.795 www 8181:
1.1334 raeburn 8182: .LC_answer_unknown,
8183: .LC_answer_warning {
1.779 bisitz 8184: background: orange;
8185: color: black;
1.795 www 8186: padding: 6px;
1.777 tempelho 8187: }
1.795 www 8188:
1.529 albertel 8189: span.LC_prior_numerical,
8190: span.LC_prior_string,
8191: span.LC_prior_custom,
8192: span.LC_prior_reaction,
8193: span.LC_prior_math {
1.925 bisitz 8194: font-family: $mono;
1.523 albertel 8195: white-space: pre;
8196: }
8197:
1.525 albertel 8198: span.LC_prior_string {
1.925 bisitz 8199: font-family: $mono;
1.525 albertel 8200: white-space: pre;
8201: }
8202:
1.523 albertel 8203: table.LC_prior_option {
8204: width: 100%;
8205: border-collapse: collapse;
8206: }
1.795 www 8207:
1.911 bisitz 8208: table.LC_prior_rank,
1.795 www 8209: table.LC_prior_match {
1.528 albertel 8210: border-collapse: collapse;
8211: }
1.795 www 8212:
1.528 albertel 8213: table.LC_prior_option tr td,
8214: table.LC_prior_rank tr td,
8215: table.LC_prior_match tr td {
1.524 albertel 8216: border: 1px solid #000000;
1.515 albertel 8217: }
8218:
1.855 bisitz 8219: .LC_nobreak {
1.544 albertel 8220: white-space: nowrap;
1.519 raeburn 8221: }
8222:
1.576 raeburn 8223: span.LC_cusr_emph {
8224: font-style: italic;
8225: }
8226:
1.633 raeburn 8227: span.LC_cusr_subheading {
8228: font-weight: normal;
8229: font-size: 85%;
8230: }
8231:
1.861 bisitz 8232: div.LC_docs_entry_move {
1.859 bisitz 8233: border: 1px solid #BBBBBB;
1.545 albertel 8234: background: #DDDDDD;
1.861 bisitz 8235: width: 22px;
1.859 bisitz 8236: padding: 1px;
8237: margin: 0;
1.545 albertel 8238: }
8239:
1.861 bisitz 8240: table.LC_data_table tr > td.LC_docs_entry_commands,
8241: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545 albertel 8242: font-size: x-small;
8243: }
1.795 www 8244:
1.861 bisitz 8245: .LC_docs_entry_parameter {
8246: white-space: nowrap;
8247: }
8248:
1.544 albertel 8249: .LC_docs_copy {
1.545 albertel 8250: color: #000099;
1.544 albertel 8251: }
1.795 www 8252:
1.544 albertel 8253: .LC_docs_cut {
1.545 albertel 8254: color: #550044;
1.544 albertel 8255: }
1.795 www 8256:
1.544 albertel 8257: .LC_docs_rename {
1.545 albertel 8258: color: #009900;
1.544 albertel 8259: }
1.795 www 8260:
1.544 albertel 8261: .LC_docs_remove {
1.545 albertel 8262: color: #990000;
8263: }
8264:
1.1284 raeburn 8265: .LC_docs_alias {
8266: color: #440055;
8267: }
8268:
1.1286 raeburn 8269: .LC_domprefs_email,
1.1284 raeburn 8270: .LC_docs_alias_name,
1.547 albertel 8271: .LC_docs_reinit_warn,
8272: .LC_docs_ext_edit {
8273: font-size: x-small;
8274: }
8275:
1.545 albertel 8276: table.LC_docs_adddocs td,
8277: table.LC_docs_adddocs th {
8278: border: 1px solid #BBBBBB;
8279: padding: 4px;
8280: background: #DDDDDD;
1.543 albertel 8281: }
8282:
1.584 albertel 8283: table.LC_sty_begin {
8284: background: #BBFFBB;
8285: }
1.795 www 8286:
1.584 albertel 8287: table.LC_sty_end {
8288: background: #FFBBBB;
8289: }
8290:
1.589 raeburn 8291: table.LC_double_column {
1.803 bisitz 8292: border-width: 0;
1.589 raeburn 8293: border-collapse: collapse;
8294: width: 100%;
8295: padding: 2px;
8296: }
8297:
8298: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 8299: top: 2px;
1.589 raeburn 8300: left: 2px;
8301: width: 47%;
8302: vertical-align: top;
8303: }
8304:
8305: table.LC_double_column tr td.LC_right_col {
8306: top: 2px;
1.779 bisitz 8307: right: 2px;
1.589 raeburn 8308: width: 47%;
8309: vertical-align: top;
8310: }
8311:
1.591 raeburn 8312: div.LC_left_float {
8313: float: left;
8314: padding-right: 5%;
1.597 albertel 8315: padding-bottom: 4px;
1.591 raeburn 8316: }
8317:
8318: div.LC_clear_float_header {
1.597 albertel 8319: padding-bottom: 2px;
1.591 raeburn 8320: }
8321:
8322: div.LC_clear_float_footer {
1.597 albertel 8323: padding-top: 10px;
1.591 raeburn 8324: clear: both;
8325: }
8326:
1.597 albertel 8327: div.LC_grade_show_user {
1.941 bisitz 8328: /* border-left: 5px solid $sidebg; */
8329: border-top: 5px solid #000000;
8330: margin: 50px 0 0 0;
1.936 bisitz 8331: padding: 15px 0 5px 10px;
1.597 albertel 8332: }
1.795 www 8333:
1.936 bisitz 8334: div.LC_grade_show_user_odd_row {
1.941 bisitz 8335: /* border-left: 5px solid #000000; */
8336: }
8337:
8338: div.LC_grade_show_user div.LC_Box {
8339: margin-right: 50px;
1.597 albertel 8340: }
8341:
8342: div.LC_grade_submissions,
8343: div.LC_grade_message_center,
1.936 bisitz 8344: div.LC_grade_info_links {
1.597 albertel 8345: margin: 5px;
8346: width: 99%;
8347: background: #FFFFFF;
8348: }
1.795 www 8349:
1.597 albertel 8350: div.LC_grade_submissions_header,
1.936 bisitz 8351: div.LC_grade_message_center_header {
1.705 tempelho 8352: font-weight: bold;
8353: font-size: large;
1.597 albertel 8354: }
1.795 www 8355:
1.597 albertel 8356: div.LC_grade_submissions_body,
1.936 bisitz 8357: div.LC_grade_message_center_body {
1.597 albertel 8358: border: 1px solid black;
8359: width: 99%;
8360: background: #FFFFFF;
8361: }
1.795 www 8362:
1.613 albertel 8363: table.LC_scantron_action {
8364: width: 100%;
8365: }
1.795 www 8366:
1.613 albertel 8367: table.LC_scantron_action tr th {
1.698 harmsja 8368: font-weight:bold;
8369: font-style:normal;
1.613 albertel 8370: }
1.795 www 8371:
1.779 bisitz 8372: .LC_edit_problem_header,
1.614 albertel 8373: div.LC_edit_problem_footer {
1.705 tempelho 8374: font-weight: normal;
8375: font-size: medium;
1.602 albertel 8376: margin: 2px;
1.1060 bisitz 8377: background-color: $sidebg;
1.600 albertel 8378: }
1.795 www 8379:
1.600 albertel 8380: div.LC_edit_problem_header,
1.602 albertel 8381: div.LC_edit_problem_header div,
1.614 albertel 8382: div.LC_edit_problem_footer,
8383: div.LC_edit_problem_footer div,
1.602 albertel 8384: div.LC_edit_problem_editxml_header,
8385: div.LC_edit_problem_editxml_header div {
1.1205 golterma 8386: z-index: 100;
1.600 albertel 8387: }
1.795 www 8388:
1.600 albertel 8389: div.LC_edit_problem_header_title {
1.705 tempelho 8390: font-weight: bold;
8391: font-size: larger;
1.602 albertel 8392: background: $tabbg;
8393: padding: 3px;
1.1060 bisitz 8394: margin: 0 0 5px 0;
1.602 albertel 8395: }
1.795 www 8396:
1.602 albertel 8397: table.LC_edit_problem_header_title {
8398: width: 100%;
1.600 albertel 8399: background: $tabbg;
1.602 albertel 8400: }
8401:
1.1205 golterma 8402: div.LC_edit_actionbar {
8403: background-color: $sidebg;
1.1218 droeschl 8404: margin: 0;
8405: padding: 0;
8406: line-height: 200%;
1.602 albertel 8407: }
1.795 www 8408:
1.1218 droeschl 8409: div.LC_edit_actionbar div{
8410: padding: 0;
8411: margin: 0;
8412: display: inline-block;
1.600 albertel 8413: }
1.795 www 8414:
1.1124 bisitz 8415: .LC_edit_opt {
8416: padding-left: 1em;
8417: white-space: nowrap;
8418: }
8419:
1.1152 golterma 8420: .LC_edit_problem_latexhelper{
8421: text-align: right;
8422: }
8423:
8424: #LC_edit_problem_colorful div{
8425: margin-left: 40px;
8426: }
8427:
1.1205 golterma 8428: #LC_edit_problem_codemirror div{
8429: margin-left: 0px;
8430: }
8431:
1.911 bisitz 8432: img.stift {
1.803 bisitz 8433: border-width: 0;
8434: vertical-align: middle;
1.677 riegler 8435: }
1.680 riegler 8436:
1.923 bisitz 8437: table td.LC_mainmenu_col_fieldset {
1.680 riegler 8438: vertical-align: top;
1.777 tempelho 8439: }
1.795 www 8440:
1.716 raeburn 8441: div.LC_createcourse {
1.911 bisitz 8442: margin: 10px 10px 10px 10px;
1.716 raeburn 8443: }
8444:
1.917 raeburn 8445: .LC_dccid {
1.1130 raeburn 8446: float: right;
1.917 raeburn 8447: margin: 0.2em 0 0 0;
8448: padding: 0;
8449: font-size: 90%;
8450: display:none;
8451: }
8452:
1.897 wenzelju 8453: ol.LC_primary_menu a:hover,
1.721 harmsja 8454: ol#LC_MenuBreadcrumbs a:hover,
8455: ol#LC_PathBreadcrumbs a:hover,
1.897 wenzelju 8456: ul#LC_secondary_menu a:hover,
1.721 harmsja 8457: .LC_FormSectionClearButton input:hover
1.795 www 8458: ul.LC_TabContent li:hover a {
1.952 onken 8459: color:$button_hover;
1.911 bisitz 8460: text-decoration:none;
1.693 droeschl 8461: }
8462:
1.779 bisitz 8463: h1 {
1.911 bisitz 8464: padding: 0;
8465: line-height:130%;
1.693 droeschl 8466: }
1.698 harmsja 8467:
1.911 bisitz 8468: h2,
8469: h3,
8470: h4,
8471: h5,
8472: h6 {
8473: margin: 5px 0 5px 0;
8474: padding: 0;
8475: line-height:130%;
1.693 droeschl 8476: }
1.795 www 8477:
8478: .LC_hcell {
1.911 bisitz 8479: padding:3px 15px 3px 15px;
8480: margin: 0;
8481: background-color:$tabbg;
8482: color:$fontmenu;
8483: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 8484: }
1.795 www 8485:
1.840 bisitz 8486: .LC_Box > .LC_hcell {
1.911 bisitz 8487: margin: 0 -10px 10px -10px;
1.835 bisitz 8488: }
8489:
1.721 harmsja 8490: .LC_noBorder {
1.911 bisitz 8491: border: 0;
1.698 harmsja 8492: }
1.693 droeschl 8493:
1.721 harmsja 8494: .LC_FormSectionClearButton input {
1.911 bisitz 8495: background-color:transparent;
8496: border: none;
8497: cursor:pointer;
8498: text-decoration:underline;
1.693 droeschl 8499: }
1.763 bisitz 8500:
8501: .LC_help_open_topic {
1.911 bisitz 8502: color: #FFFFFF;
8503: background-color: #EEEEFF;
8504: margin: 1px;
8505: padding: 4px;
8506: border: 1px solid #000033;
8507: white-space: nowrap;
8508: /* vertical-align: middle; */
1.759 neumanie 8509: }
1.693 droeschl 8510:
1.911 bisitz 8511: dl,
8512: ul,
8513: div,
8514: fieldset {
8515: margin: 10px 10px 10px 0;
8516: /* overflow: hidden; */
1.693 droeschl 8517: }
1.795 www 8518:
1.1404 raeburn 8519: fieldset#LC_selectuser {
8520: margin: 0;
8521: padding: 0;
8522: }
8523:
1.1211 raeburn 8524: article.geogebraweb div {
8525: margin: 0;
8526: }
8527:
1.838 bisitz 8528: fieldset > legend {
1.911 bisitz 8529: font-weight: bold;
8530: padding: 0 5px 0 5px;
1.838 bisitz 8531: }
8532:
1.813 bisitz 8533: #LC_nav_bar {
1.911 bisitz 8534: float: left;
1.995 raeburn 8535: background-color: $pgbg_or_bgcolor;
1.966 bisitz 8536: margin: 0 0 2px 0;
1.807 droeschl 8537: }
8538:
1.916 droeschl 8539: #LC_realm {
8540: margin: 0.2em 0 0 0;
8541: padding: 0;
8542: font-weight: bold;
8543: text-align: center;
1.995 raeburn 8544: background-color: $pgbg_or_bgcolor;
1.916 droeschl 8545: }
8546:
1.911 bisitz 8547: #LC_nav_bar em {
8548: font-weight: bold;
8549: font-style: normal;
1.807 droeschl 8550: }
8551:
1.897 wenzelju 8552: ol.LC_primary_menu {
1.934 droeschl 8553: margin: 0;
1.1076 raeburn 8554: padding: 0;
1.807 droeschl 8555: }
8556:
1.852 droeschl 8557: ol#LC_PathBreadcrumbs {
1.911 bisitz 8558: margin: 0;
1.693 droeschl 8559: }
8560:
1.897 wenzelju 8561: ol.LC_primary_menu li {
1.1076 raeburn 8562: color: RGB(80, 80, 80);
8563: vertical-align: middle;
8564: text-align: left;
8565: list-style: none;
1.1205 golterma 8566: position: relative;
1.1076 raeburn 8567: float: left;
1.1205 golterma 8568: z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
8569: line-height: 1.5em;
1.1076 raeburn 8570: }
8571:
1.1205 golterma 8572: ol.LC_primary_menu li a,
8573: ol.LC_primary_menu li p {
1.1076 raeburn 8574: display: block;
8575: margin: 0;
8576: padding: 0 5px 0 10px;
8577: text-decoration: none;
8578: }
8579:
1.1205 golterma 8580: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
8581: display: inline-block;
8582: width: 95%;
8583: text-align: left;
8584: }
8585:
8586: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
8587: display: inline-block;
8588: width: 5%;
8589: float: right;
8590: text-align: right;
8591: font-size: 70%;
8592: }
8593:
8594: ol.LC_primary_menu ul {
1.1076 raeburn 8595: display: none;
1.1205 golterma 8596: width: 15em;
1.1076 raeburn 8597: background-color: $data_table_light;
1.1205 golterma 8598: position: absolute;
8599: top: 100%;
1.1076 raeburn 8600: }
8601:
1.1205 golterma 8602: ol.LC_primary_menu ul ul {
8603: left: 100%;
8604: top: 0;
8605: }
8606:
8607: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076 raeburn 8608: display: block;
8609: position: absolute;
8610: margin: 0;
8611: padding: 0;
1.1078 raeburn 8612: z-index: 2;
1.1076 raeburn 8613: }
8614:
8615: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205 golterma 8616: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076 raeburn 8617: font-size: 90%;
1.911 bisitz 8618: vertical-align: top;
1.1076 raeburn 8619: float: none;
1.1079 raeburn 8620: border-left: 1px solid black;
8621: border-right: 1px solid black;
1.1205 golterma 8622: /* A dark bottom border to visualize different menu options;
8623: overwritten in the create_submenu routine for the last border-bottom of the menu */
8624: border-bottom: 1px solid $data_table_dark;
1.1076 raeburn 8625: }
8626:
1.1205 golterma 8627: ol.LC_primary_menu li li p:hover {
8628: color:$button_hover;
8629: text-decoration:none;
8630: background-color:$data_table_dark;
1.1076 raeburn 8631: }
8632:
8633: ol.LC_primary_menu li li a:hover {
8634: color:$button_hover;
8635: background-color:$data_table_dark;
1.693 droeschl 8636: }
8637:
1.1205 golterma 8638: /* Font-size equal to the size of the predecessors*/
8639: ol.LC_primary_menu li:hover li li {
8640: font-size: 100%;
8641: }
8642:
1.897 wenzelju 8643: ol.LC_primary_menu li img {
1.911 bisitz 8644: vertical-align: bottom;
1.934 droeschl 8645: height: 1.1em;
1.1077 raeburn 8646: margin: 0.2em 0 0 0;
1.693 droeschl 8647: }
8648:
1.897 wenzelju 8649: ol.LC_primary_menu a {
1.911 bisitz 8650: color: RGB(80, 80, 80);
8651: text-decoration: none;
1.693 droeschl 8652: }
1.795 www 8653:
1.949 droeschl 8654: ol.LC_primary_menu a.LC_new_message {
8655: font-weight:bold;
8656: color: darkred;
8657: }
8658:
1.975 raeburn 8659: ol.LC_docs_parameters {
8660: margin-left: 0;
8661: padding: 0;
8662: list-style: none;
8663: }
8664:
8665: ol.LC_docs_parameters li {
8666: margin: 0;
8667: padding-right: 20px;
8668: display: inline;
8669: }
8670:
1.976 raeburn 8671: ol.LC_docs_parameters li:before {
8672: content: "\\002022 \\0020";
8673: }
8674:
8675: li.LC_docs_parameters_title {
8676: font-weight: bold;
8677: }
8678:
8679: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
8680: content: "";
8681: }
8682:
1.897 wenzelju 8683: ul#LC_secondary_menu {
1.1107 raeburn 8684: clear: right;
1.911 bisitz 8685: color: $fontmenu;
8686: background: $tabbg;
8687: list-style: none;
8688: padding: 0;
8689: margin: 0;
8690: width: 100%;
1.995 raeburn 8691: text-align: left;
1.1107 raeburn 8692: float: left;
1.808 droeschl 8693: }
8694:
1.897 wenzelju 8695: ul#LC_secondary_menu li {
1.911 bisitz 8696: font-weight: bold;
8697: line-height: 1.8em;
1.1107 raeburn 8698: border-right: 1px solid black;
8699: float: left;
8700: }
8701:
8702: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
8703: background-color: $data_table_light;
8704: }
8705:
8706: ul#LC_secondary_menu li a {
1.911 bisitz 8707: padding: 0 0.8em;
1.1107 raeburn 8708: }
8709:
8710: ul#LC_secondary_menu li ul {
8711: display: none;
8712: }
8713:
8714: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
8715: display: block;
8716: position: absolute;
8717: margin: 0;
8718: padding: 0;
8719: list-style:none;
8720: float: none;
8721: background-color: $data_table_light;
8722: z-index: 2;
8723: margin-left: -1px;
8724: }
8725:
8726: ul#LC_secondary_menu li ul li {
8727: font-size: 90%;
8728: vertical-align: top;
8729: border-left: 1px solid black;
1.911 bisitz 8730: border-right: 1px solid black;
1.1119 raeburn 8731: background-color: $data_table_light;
1.1107 raeburn 8732: list-style:none;
8733: float: none;
8734: }
8735:
8736: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
8737: background-color: $data_table_dark;
1.807 droeschl 8738: }
8739:
1.847 tempelho 8740: ul.LC_TabContent {
1.911 bisitz 8741: display:block;
8742: background: $sidebg;
8743: border-bottom: solid 1px $lg_border_color;
8744: list-style:none;
1.1020 raeburn 8745: margin: -1px -10px 0 -10px;
1.911 bisitz 8746: padding: 0;
1.693 droeschl 8747: }
8748:
1.795 www 8749: ul.LC_TabContent li,
8750: ul.LC_TabContentBigger li {
1.911 bisitz 8751: float:left;
1.741 harmsja 8752: }
1.795 www 8753:
1.897 wenzelju 8754: ul#LC_secondary_menu li a {
1.911 bisitz 8755: color: $fontmenu;
8756: text-decoration: none;
1.693 droeschl 8757: }
1.795 www 8758:
1.721 harmsja 8759: ul.LC_TabContent {
1.952 onken 8760: min-height:20px;
1.721 harmsja 8761: }
1.795 www 8762:
8763: ul.LC_TabContent li {
1.911 bisitz 8764: vertical-align:middle;
1.959 onken 8765: padding: 0 16px 0 10px;
1.911 bisitz 8766: background-color:$tabbg;
8767: border-bottom:solid 1px $lg_border_color;
1.1020 raeburn 8768: border-left: solid 1px $font;
1.721 harmsja 8769: }
1.795 www 8770:
1.847 tempelho 8771: ul.LC_TabContent .right {
1.911 bisitz 8772: float:right;
1.847 tempelho 8773: }
8774:
1.911 bisitz 8775: ul.LC_TabContent li a,
8776: ul.LC_TabContent li {
8777: color:rgb(47,47,47);
8778: text-decoration:none;
8779: font-size:95%;
8780: font-weight:bold;
1.952 onken 8781: min-height:20px;
8782: }
8783:
1.959 onken 8784: ul.LC_TabContent li a:hover,
8785: ul.LC_TabContent li a:focus {
1.952 onken 8786: color: $button_hover;
1.959 onken 8787: background:none;
8788: outline:none;
1.952 onken 8789: }
8790:
8791: ul.LC_TabContent li:hover {
8792: color: $button_hover;
8793: cursor:pointer;
1.721 harmsja 8794: }
1.795 www 8795:
1.911 bisitz 8796: ul.LC_TabContent li.active {
1.952 onken 8797: color: $font;
1.911 bisitz 8798: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952 onken 8799: border-bottom:solid 1px #FFFFFF;
8800: cursor: default;
1.744 ehlerst 8801: }
1.795 www 8802:
1.959 onken 8803: ul.LC_TabContent li.active a {
8804: color:$font;
8805: background:#FFFFFF;
8806: outline: none;
8807: }
1.1047 raeburn 8808:
8809: ul.LC_TabContent li.goback {
8810: float: left;
8811: border-left: none;
8812: }
8813:
1.870 tempelho 8814: #maincoursedoc {
1.911 bisitz 8815: clear:both;
1.870 tempelho 8816: }
8817:
8818: ul.LC_TabContentBigger {
1.911 bisitz 8819: display:block;
8820: list-style:none;
8821: padding: 0;
1.870 tempelho 8822: }
8823:
1.795 www 8824: ul.LC_TabContentBigger li {
1.911 bisitz 8825: vertical-align:bottom;
8826: height: 30px;
8827: font-size:110%;
8828: font-weight:bold;
8829: color: #737373;
1.841 tempelho 8830: }
8831:
1.957 onken 8832: ul.LC_TabContentBigger li.active {
8833: position: relative;
8834: top: 1px;
8835: }
8836:
1.870 tempelho 8837: ul.LC_TabContentBigger li a {
1.911 bisitz 8838: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
8839: height: 30px;
8840: line-height: 30px;
8841: text-align: center;
8842: display: block;
8843: text-decoration: none;
1.958 onken 8844: outline: none;
1.741 harmsja 8845: }
1.795 www 8846:
1.870 tempelho 8847: ul.LC_TabContentBigger li.active a {
1.911 bisitz 8848: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
8849: color:$font;
1.744 ehlerst 8850: }
1.795 www 8851:
1.870 tempelho 8852: ul.LC_TabContentBigger li b {
1.911 bisitz 8853: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
8854: display: block;
8855: float: left;
8856: padding: 0 30px;
1.957 onken 8857: border-bottom: 1px solid $lg_border_color;
1.870 tempelho 8858: }
8859:
1.956 onken 8860: ul.LC_TabContentBigger li:hover b {
8861: color:$button_hover;
8862: }
8863:
1.870 tempelho 8864: ul.LC_TabContentBigger li.active b {
1.911 bisitz 8865: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
8866: color:$font;
1.957 onken 8867: border: 0;
1.741 harmsja 8868: }
1.693 droeschl 8869:
1.870 tempelho 8870:
1.862 bisitz 8871: ul.LC_CourseBreadcrumbs {
8872: background: $sidebg;
1.1020 raeburn 8873: height: 2em;
1.862 bisitz 8874: padding-left: 10px;
1.1020 raeburn 8875: margin: 0;
1.862 bisitz 8876: list-style-position: inside;
8877: }
8878:
1.911 bisitz 8879: ol#LC_MenuBreadcrumbs,
1.862 bisitz 8880: ol#LC_PathBreadcrumbs {
1.911 bisitz 8881: padding-left: 10px;
8882: margin: 0;
1.933 droeschl 8883: height: 2.5em; /* equal to #LC_breadcrumbs line-height */
1.693 droeschl 8884: }
8885:
1.911 bisitz 8886: ol#LC_MenuBreadcrumbs li,
8887: ol#LC_PathBreadcrumbs li,
1.862 bisitz 8888: ul.LC_CourseBreadcrumbs li {
1.911 bisitz 8889: display: inline;
1.933 droeschl 8890: white-space: normal;
1.693 droeschl 8891: }
8892:
1.823 bisitz 8893: ol#LC_MenuBreadcrumbs li a,
1.862 bisitz 8894: ul.LC_CourseBreadcrumbs li a {
1.911 bisitz 8895: text-decoration: none;
8896: font-size:90%;
1.693 droeschl 8897: }
1.795 www 8898:
1.969 droeschl 8899: ol#LC_MenuBreadcrumbs h1 {
8900: display: inline;
8901: font-size: 90%;
8902: line-height: 2.5em;
8903: margin: 0;
8904: padding: 0;
8905: }
8906:
1.795 www 8907: ol#LC_PathBreadcrumbs li a {
1.911 bisitz 8908: text-decoration:none;
8909: font-size:100%;
8910: font-weight:bold;
1.693 droeschl 8911: }
1.795 www 8912:
1.840 bisitz 8913: .LC_Box {
1.911 bisitz 8914: border: solid 1px $lg_border_color;
8915: padding: 0 10px 10px 10px;
1.746 neumanie 8916: }
1.795 www 8917:
1.1020 raeburn 8918: .LC_DocsBox {
8919: border: solid 1px $lg_border_color;
8920: padding: 0 0 10px 10px;
8921: }
8922:
1.795 www 8923: .LC_AboutMe_Image {
1.911 bisitz 8924: float:left;
8925: margin-right:10px;
1.747 neumanie 8926: }
1.795 www 8927:
8928: .LC_Clear_AboutMe_Image {
1.911 bisitz 8929: clear:left;
1.747 neumanie 8930: }
1.795 www 8931:
1.721 harmsja 8932: dl.LC_ListStyleClean dt {
1.911 bisitz 8933: padding-right: 5px;
8934: display: table-header-group;
1.693 droeschl 8935: }
8936:
1.721 harmsja 8937: dl.LC_ListStyleClean dd {
1.911 bisitz 8938: display: table-row;
1.693 droeschl 8939: }
8940:
1.721 harmsja 8941: .LC_ListStyleClean,
8942: .LC_ListStyleSimple,
8943: .LC_ListStyleNormal,
1.795 www 8944: .LC_ListStyleSpecial {
1.911 bisitz 8945: /* display:block; */
8946: list-style-position: inside;
8947: list-style-type: none;
8948: overflow: hidden;
8949: padding: 0;
1.693 droeschl 8950: }
8951:
1.721 harmsja 8952: .LC_ListStyleSimple li,
8953: .LC_ListStyleSimple dd,
8954: .LC_ListStyleNormal li,
8955: .LC_ListStyleNormal dd,
8956: .LC_ListStyleSpecial li,
1.795 www 8957: .LC_ListStyleSpecial dd {
1.911 bisitz 8958: margin: 0;
8959: padding: 5px 5px 5px 10px;
8960: clear: both;
1.693 droeschl 8961: }
8962:
1.721 harmsja 8963: .LC_ListStyleClean li,
8964: .LC_ListStyleClean dd {
1.911 bisitz 8965: padding-top: 0;
8966: padding-bottom: 0;
1.693 droeschl 8967: }
8968:
1.721 harmsja 8969: .LC_ListStyleSimple dd,
1.795 www 8970: .LC_ListStyleSimple li {
1.911 bisitz 8971: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 8972: }
8973:
1.721 harmsja 8974: .LC_ListStyleSpecial li,
8975: .LC_ListStyleSpecial dd {
1.911 bisitz 8976: list-style-type: none;
8977: background-color: RGB(220, 220, 220);
8978: margin-bottom: 4px;
1.693 droeschl 8979: }
8980:
1.721 harmsja 8981: table.LC_SimpleTable {
1.911 bisitz 8982: margin:5px;
8983: border:solid 1px $lg_border_color;
1.795 www 8984: }
1.693 droeschl 8985:
1.721 harmsja 8986: table.LC_SimpleTable tr {
1.911 bisitz 8987: padding: 0;
8988: border:solid 1px $lg_border_color;
1.693 droeschl 8989: }
1.795 www 8990:
8991: table.LC_SimpleTable thead {
1.911 bisitz 8992: background:rgb(220,220,220);
1.693 droeschl 8993: }
8994:
1.721 harmsja 8995: div.LC_columnSection {
1.911 bisitz 8996: display: block;
8997: clear: both;
8998: overflow: hidden;
8999: margin: 0;
1.693 droeschl 9000: }
9001:
1.721 harmsja 9002: div.LC_columnSection>* {
1.911 bisitz 9003: float: left;
9004: margin: 10px 20px 10px 0;
9005: overflow:hidden;
1.693 droeschl 9006: }
1.721 harmsja 9007:
1.795 www 9008: table em {
1.911 bisitz 9009: font-weight: bold;
9010: font-style: normal;
1.748 schulted 9011: }
1.795 www 9012:
1.779 bisitz 9013: table.LC_tableBrowseRes,
1.795 www 9014: table.LC_tableOfContent {
1.911 bisitz 9015: border:none;
9016: border-spacing: 1px;
9017: padding: 3px;
9018: background-color: #FFFFFF;
9019: font-size: 90%;
1.753 droeschl 9020: }
1.789 droeschl 9021:
1.911 bisitz 9022: table.LC_tableOfContent {
9023: border-collapse: collapse;
1.789 droeschl 9024: }
9025:
1.771 droeschl 9026: table.LC_tableBrowseRes a,
1.768 schulted 9027: table.LC_tableOfContent a {
1.911 bisitz 9028: background-color: transparent;
9029: text-decoration: none;
1.753 droeschl 9030: }
9031:
1.795 www 9032: table.LC_tableOfContent img {
1.911 bisitz 9033: border: none;
9034: height: 1.3em;
9035: vertical-align: text-bottom;
9036: margin-right: 0.3em;
1.753 droeschl 9037: }
1.757 schulted 9038:
1.795 www 9039: a#LC_content_toolbar_firsthomework {
1.911 bisitz 9040: background-image:url(/res/adm/pages/open-first-problem.gif);
1.774 ehlerst 9041: }
9042:
1.795 www 9043: a#LC_content_toolbar_everything {
1.911 bisitz 9044: background-image:url(/res/adm/pages/show-all.gif);
1.774 ehlerst 9045: }
9046:
1.795 www 9047: a#LC_content_toolbar_uncompleted {
1.911 bisitz 9048: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774 ehlerst 9049: }
9050:
1.795 www 9051: #LC_content_toolbar_clearbubbles {
1.911 bisitz 9052: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774 ehlerst 9053: }
9054:
1.795 www 9055: a#LC_content_toolbar_changefolder {
1.911 bisitz 9056: background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757 schulted 9057: }
9058:
1.795 www 9059: a#LC_content_toolbar_changefolder_toggled {
1.911 bisitz 9060: background-image:url(/res/adm/pages/open-all-folders.gif);
1.757 schulted 9061: }
9062:
1.1043 raeburn 9063: a#LC_content_toolbar_edittoplevel {
9064: background-image:url(/res/adm/pages/edittoplevel.gif);
9065: }
9066:
1.1384 raeburn 9067: a#LC_content_toolbar_printout {
9068: background-image:url(/res/adm/pages/printout.gif);
9069: }
9070:
1.795 www 9071: ul#LC_toolbar li a:hover {
1.911 bisitz 9072: background-position: bottom center;
1.757 schulted 9073: }
9074:
1.795 www 9075: ul#LC_toolbar {
1.911 bisitz 9076: padding: 0;
9077: margin: 2px;
9078: list-style:none;
9079: position:relative;
9080: background-color:white;
1.1082 raeburn 9081: overflow: auto;
1.757 schulted 9082: }
9083:
1.795 www 9084: ul#LC_toolbar li {
1.911 bisitz 9085: border:1px solid white;
9086: padding: 0;
9087: margin: 0;
9088: float: left;
9089: display:inline;
9090: vertical-align:middle;
1.1082 raeburn 9091: white-space: nowrap;
1.911 bisitz 9092: }
1.757 schulted 9093:
1.783 amueller 9094:
1.795 www 9095: a.LC_toolbarItem {
1.911 bisitz 9096: display:block;
9097: padding: 0;
9098: margin: 0;
9099: height: 32px;
9100: width: 32px;
9101: color:white;
9102: border: none;
9103: background-repeat:no-repeat;
9104: background-color:transparent;
1.757 schulted 9105: }
9106:
1.915 droeschl 9107: ul.LC_funclist {
9108: margin: 0;
9109: padding: 0.5em 1em 0.5em 0;
9110: }
9111:
1.933 droeschl 9112: ul.LC_funclist > li:first-child {
9113: font-weight:bold;
9114: margin-left:0.8em;
9115: }
9116:
1.915 droeschl 9117: ul.LC_funclist + ul.LC_funclist {
9118: /*
9119: left border as a seperator if we have more than
9120: one list
9121: */
9122: border-left: 1px solid $sidebg;
9123: /*
9124: this hides the left border behind the border of the
9125: outer box if element is wrapped to the next 'line'
9126: */
9127: margin-left: -1px;
9128: }
9129:
1.843 bisitz 9130: ul.LC_funclist li {
1.915 droeschl 9131: display: inline;
1.782 bisitz 9132: white-space: nowrap;
1.915 droeschl 9133: margin: 0 0 0 25px;
9134: line-height: 150%;
1.782 bisitz 9135: }
9136:
1.974 wenzelju 9137: .LC_hidden {
9138: display: none;
9139: }
9140:
1.1030 www 9141: .LCmodal-overlay {
9142: position:fixed;
9143: top:0;
9144: right:0;
9145: bottom:0;
9146: left:0;
9147: height:100%;
9148: width:100%;
9149: margin:0;
9150: padding:0;
9151: background:#999;
9152: opacity:.75;
9153: filter: alpha(opacity=75);
9154: -moz-opacity: 0.75;
9155: z-index:101;
9156: }
9157:
9158: * html .LCmodal-overlay {
9159: position: absolute;
9160: height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
9161: }
9162:
9163: .LCmodal-window {
9164: position:fixed;
9165: top:50%;
9166: left:50%;
9167: margin:0;
9168: padding:0;
9169: z-index:102;
9170: }
9171:
9172: * html .LCmodal-window {
9173: position:absolute;
9174: }
9175:
9176: .LCclose-window {
9177: position:absolute;
9178: width:32px;
9179: height:32px;
9180: right:8px;
9181: top:8px;
9182: background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
9183: text-indent:-99999px;
9184: overflow:hidden;
9185: cursor:pointer;
9186: }
9187:
1.1369 raeburn 9188: .LCisDisabled {
9189: cursor: not-allowed;
9190: opacity: 0.5;
9191: }
9192:
9193: a[aria-disabled="true"] {
9194: color: currentColor;
9195: display: inline-block; /* For IE11/ MS Edge bug */
9196: pointer-events: none;
9197: text-decoration: none;
9198: }
9199:
1.1335 raeburn 9200: pre.LC_wordwrap {
9201: white-space: pre-wrap;
9202: white-space: -moz-pre-wrap;
9203: white-space: -pre-wrap;
9204: white-space: -o-pre-wrap;
9205: word-wrap: break-word;
9206: }
9207:
1.1100 raeburn 9208: /*
1.1231 damieng 9209: styles used for response display
9210: */
9211: div.LC_radiofoil, div.LC_rankfoil {
9212: margin: .5em 0em .5em 0em;
9213: }
9214: table.LC_itemgroup {
9215: margin-top: 1em;
9216: }
9217:
9218: /*
1.1100 raeburn 9219: styles used by TTH when "Default set of options to pass to tth/m
9220: when converting TeX" in course settings has been set
9221:
9222: option passed: -t
9223:
9224: */
9225:
9226: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
9227: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
9228: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
9229: td div.norm {line-height:normal;}
9230:
9231: /*
9232: option passed -y3
9233: */
9234:
9235: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
9236: span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
9237: span.overacc1 {position: relative; left: .6em; top: -1.2ex;}
9238:
1.1230 damieng 9239: /*
9240: sections with roles, for content only
9241: */
9242: section[class^="role-"] {
9243: padding-left: 10px;
9244: padding-right: 5px;
9245: margin-top: 8px;
9246: margin-bottom: 8px;
9247: border: 1px solid #2A4;
9248: border-radius: 5px;
9249: box-shadow: 0px 1px 1px #BBB;
9250: }
9251: section[class^="role-"]>h1 {
9252: position: relative;
9253: margin: 0px;
9254: padding-top: 10px;
9255: padding-left: 40px;
9256: }
9257: section[class^="role-"]>h1:before {
9258: position: absolute;
9259: left: -5px;
9260: top: 5px;
9261: }
9262: section.role-activity>h1:before {
9263: content:url('/adm/daxe/images/section_icons/activity.png');
9264: }
9265: section.role-advice>h1:before {
9266: content:url('/adm/daxe/images/section_icons/advice.png');
9267: }
9268: section.role-bibliography>h1:before {
9269: content:url('/adm/daxe/images/section_icons/bibliography.png');
9270: }
9271: section.role-citation>h1:before {
9272: content:url('/adm/daxe/images/section_icons/citation.png');
9273: }
9274: section.role-conclusion>h1:before {
9275: content:url('/adm/daxe/images/section_icons/conclusion.png');
9276: }
9277: section.role-definition>h1:before {
9278: content:url('/adm/daxe/images/section_icons/definition.png');
9279: }
9280: section.role-demonstration>h1:before {
9281: content:url('/adm/daxe/images/section_icons/demonstration.png');
9282: }
9283: section.role-example>h1:before {
9284: content:url('/adm/daxe/images/section_icons/example.png');
9285: }
9286: section.role-explanation>h1:before {
9287: content:url('/adm/daxe/images/section_icons/explanation.png');
9288: }
9289: section.role-introduction>h1:before {
9290: content:url('/adm/daxe/images/section_icons/introduction.png');
9291: }
9292: section.role-method>h1:before {
9293: content:url('/adm/daxe/images/section_icons/method.png');
9294: }
9295: section.role-more_information>h1:before {
9296: content:url('/adm/daxe/images/section_icons/more_information.png');
9297: }
9298: section.role-objectives>h1:before {
9299: content:url('/adm/daxe/images/section_icons/objectives.png');
9300: }
9301: section.role-prerequisites>h1:before {
9302: content:url('/adm/daxe/images/section_icons/prerequisites.png');
9303: }
9304: section.role-remark>h1:before {
9305: content:url('/adm/daxe/images/section_icons/remark.png');
9306: }
9307: section.role-reminder>h1:before {
9308: content:url('/adm/daxe/images/section_icons/reminder.png');
9309: }
9310: section.role-summary>h1:before {
9311: content:url('/adm/daxe/images/section_icons/summary.png');
9312: }
9313: section.role-syntax>h1:before {
9314: content:url('/adm/daxe/images/section_icons/syntax.png');
9315: }
9316: section.role-warning>h1:before {
9317: content:url('/adm/daxe/images/section_icons/warning.png');
9318: }
9319:
1.1269 raeburn 9320: #LC_minitab_header {
9321: float:left;
9322: width:100%;
9323: background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
9324: font-size:93%;
9325: line-height:normal;
9326: margin: 0.5em 0 0.5em 0;
9327: }
9328: #LC_minitab_header ul {
9329: margin:0;
9330: padding:10px 10px 0;
9331: list-style:none;
9332: }
9333: #LC_minitab_header li {
9334: float:left;
9335: background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
9336: margin:0;
9337: padding:0 0 0 9px;
9338: }
9339: #LC_minitab_header a {
9340: display:block;
9341: background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
9342: padding:5px 15px 4px 6px;
9343: }
9344: #LC_minitab_header #LC_current_minitab {
9345: background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
9346: }
9347: #LC_minitab_header #LC_current_minitab a {
9348: background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
9349: padding-bottom:5px;
9350: }
9351:
9352:
1.343 albertel 9353: END
9354: }
9355:
1.306 albertel 9356: =pod
9357:
9358: =item * &headtag()
9359:
9360: Returns a uniform footer for LON-CAPA web pages.
9361:
1.307 albertel 9362: Inputs: $title - optional title for the head
9363: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 9364: $args - optional arguments
1.319 albertel 9365: force_register - if is true call registerurl so the remote is
9366: informed
1.415 albertel 9367: redirect -> array ref of
9368: 1- seconds before redirect occurs
9369: 2- url to redirect to
9370: 3- whether the side effect should occur
1.315 albertel 9371: (side effect of setting
9372: $env{'internal.head.redirect'} to the url
1.1386 raeburn 9373: redirected to)
9374: 4- whether the redirect target should be
9375: the opener of the current (pop-up)
9376: window (side effect of setting
9377: $env{'internal.head.to_opener'} to
9378: 1, if true.
1.1388 raeburn 9379: 5- whether encrypt check should be skipped
1.352 albertel 9380: domain -> force to color decorate a page for a specific
9381: domain
9382: function -> force usage of a specific rolish color scheme
9383: bgcolor -> override the default page bgcolor
1.460 albertel 9384: no_auto_mt_title
9385: -> prevent &mt()ing the title arg
1.464 albertel 9386:
1.306 albertel 9387: =cut
9388:
9389: sub headtag {
1.313 albertel 9390: my ($title,$head_extra,$args) = @_;
1.306 albertel 9391:
1.363 albertel 9392: my $function = $args->{'function'} || &get_users_function();
9393: my $domain = $args->{'domain'} || &determinedomain();
9394: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.1154 raeburn 9395: my $httphost = $args->{'use_absolute'};
1.418 albertel 9396: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 9397: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 9398: #time(),
1.418 albertel 9399: $env{'environment.color.timestamp'},
1.363 albertel 9400: $function,$domain,$bgcolor);
9401:
1.369 www 9402: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 9403:
1.308 albertel 9404: my $result =
9405: '<head>'.
1.1160 raeburn 9406: &font_settings($args);
1.319 albertel 9407:
1.1188 raeburn 9408: my $inhibitprint;
9409: if ($args->{'print_suppress'}) {
9410: $inhibitprint = &print_suppression();
9411: }
1.1064 raeburn 9412:
1.461 albertel 9413: if (!$args->{'frameset'}) {
9414: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
9415: }
1.962 droeschl 9416: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
9417: $result .= Apache::lonxml::display_title();
1.319 albertel 9418: }
1.436 albertel 9419: if (!$args->{'no_nav_bar'}
9420: && !$args->{'only_body'}
9421: && !$args->{'frameset'}) {
1.1154 raeburn 9422: $result .= &help_menu_js($httphost);
1.1032 www 9423: $result.=&modal_window();
1.1038 www 9424: $result.=&togglebox_script();
1.1034 www 9425: $result.=&wishlist_window();
1.1041 www 9426: $result.=&LCprogressbarUpdate_script();
1.1034 www 9427: } else {
9428: if ($args->{'add_modal'}) {
9429: $result.=&modal_window();
9430: }
9431: if ($args->{'add_wishlist'}) {
9432: $result.=&wishlist_window();
9433: }
1.1038 www 9434: if ($args->{'add_togglebox'}) {
9435: $result.=&togglebox_script();
9436: }
1.1041 www 9437: if ($args->{'add_progressbar'}) {
9438: $result.=&LCprogressbarUpdate_script();
9439: }
1.436 albertel 9440: }
1.314 albertel 9441: if (ref($args->{'redirect'})) {
1.1388 raeburn 9442: my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
9443: if (!$skip_enc_check) {
9444: $url = &Apache::lonenc::check_encrypt($url);
9445: }
1.414 albertel 9446: if (!$inhibit_continue) {
9447: $env{'internal.head.redirect'} = $url;
9448: }
1.1386 raeburn 9449: $result.=<<"ADDMETA";
1.313 albertel 9450: <meta http-equiv="pragma" content="no-cache" />
1.1386 raeburn 9451: ADDMETA
9452: if ($to_opener) {
9453: $env{'internal.head.to_opener'} = 1;
9454: my $dest = &js_escape($url);
9455: my $timeout = int($time * 1000);
9456: $result .=<<"ENDJS";
9457: <script type="text/javascript">
9458: // <![CDATA[
9459: function LC_To_Opener() {
9460: var dest = '$dest';
9461: if (dest != '') {
9462: if (window.opener != null && !window.opener.closed) {
9463: window.opener.location.href=dest;
9464: window.close();
9465: } else {
9466: window.location.href=dest;
9467: }
9468: }
9469: }
9470: \$(document).ready(function () {
9471: setTimeout('LC_To_Opener()',$timeout);
9472: });
9473: // ]]>
9474: </script>
9475: ENDJS
9476: } else {
9477: $result.=<<"ADDMETA";
1.344 albertel 9478: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 9479: ADDMETA
1.1386 raeburn 9480: }
1.1210 raeburn 9481: } else {
9482: unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
9483: my $requrl = $env{'request.uri'};
9484: if ($requrl eq '') {
9485: $requrl = $ENV{'REQUEST_URI'};
9486: $requrl =~ s/\?.+$//;
9487: }
9488: unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
9489: (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
9490: ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
9491: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
9492: unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
9493: my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340 raeburn 9494: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352 raeburn 9495: my ($offload,$offloadoth);
1.1210 raeburn 9496: if (ref($domdefs{'offloadnow'}) eq 'HASH') {
9497: if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340 raeburn 9498: $offload = 1;
1.1353 raeburn 9499: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9500: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9501: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9502: $offloadoth = 1;
9503: $dom_in_use = $env{'user.domain'};
9504: }
9505: }
1.1340 raeburn 9506: }
9507: }
9508: unless ($offload) {
9509: if (ref($domdefs{'offloadoth'}) eq 'HASH') {
9510: if ($domdefs{'offloadoth'}{$lonhost}) {
9511: if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
9512: (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
9513: unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
9514: $offload = 1;
1.1352 raeburn 9515: $offloadoth = 1;
1.1340 raeburn 9516: $dom_in_use = $env{'user.domain'};
9517: }
1.1210 raeburn 9518: }
1.1340 raeburn 9519: }
9520: }
9521: }
9522: if ($offload) {
1.1358 raeburn 9523: my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352 raeburn 9524: if (($newserver eq '') && ($offloadoth)) {
9525: my @domains = &Apache::lonnet::current_machine_domains();
9526: if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) {
9527: ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
9528: }
9529: }
1.1340 raeburn 9530: if (($newserver) && ($newserver ne $lonhost)) {
9531: my $numsec = 5;
9532: my $timeout = $numsec * 1000;
9533: my ($newurl,$locknum,%locks,$msg);
9534: if ($env{'request.role.adv'}) {
9535: ($locknum,%locks) = &Apache::lonnet::get_locks();
9536: }
9537: my $disable_submit = 0;
9538: if ($requrl =~ /$LONCAPA::assess_re/) {
9539: $disable_submit = 1;
9540: }
9541: if ($locknum) {
9542: my @lockinfo = sort(values(%locks));
1.1354 raeburn 9543: $msg = &mt('Once the following tasks are complete:')." \n".
1.1340 raeburn 9544: join(", ",sort(values(%locks)))."\n";
9545: if (&show_course()) {
9546: $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
9547: } else {
9548: $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210 raeburn 9549: }
1.1340 raeburn 9550: } else {
9551: if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
9552: $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
9553: }
9554: $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
9555: $newurl = '/adm/switchserver?otherserver='.$newserver;
9556: if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
9557: $newurl .= '&role='.$env{'request.role'};
9558: }
9559: if ($env{'request.symb'}) {
9560: my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
9561: if ($shownsymb =~ m{^/enc/}) {
9562: my $reqdmajor = 2;
9563: my $reqdminor = 11;
9564: my $reqdsubminor = 3;
9565: my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
9566: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
9567: my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
9568: if (($major eq '' && $minor eq '') ||
9569: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
9570: (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
9571: ($reqdsubminor > $subminor))))) {
9572: undef($shownsymb);
9573: }
1.1210 raeburn 9574: }
1.1340 raeburn 9575: if ($shownsymb) {
9576: &js_escape(\$shownsymb);
9577: $newurl .= '&symb='.$shownsymb;
1.1210 raeburn 9578: }
1.1340 raeburn 9579: } else {
9580: my $shownurl = &Apache::lonenc::check_encrypt($requrl);
9581: &js_escape(\$shownurl);
9582: $newurl .= '&origurl='.$shownurl;
1.1210 raeburn 9583: }
1.1340 raeburn 9584: }
9585: &js_escape(\$msg);
9586: $result.=<<OFFLOAD
1.1210 raeburn 9587: <meta http-equiv="pragma" content="no-cache" />
9588: <script type="text/javascript">
1.1215 raeburn 9589: // <![CDATA[
1.1210 raeburn 9590: function LC_Offload_Now() {
9591: var dest = "$newurl";
9592: if (dest != '') {
9593: window.location.href="$newurl";
9594: }
9595: }
1.1214 raeburn 9596: \$(document).ready(function () {
9597: window.alert('$msg');
9598: if ($disable_submit) {
1.1210 raeburn 9599: \$(".LC_hwk_submit").prop("disabled", true);
9600: \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214 raeburn 9601: }
9602: setTimeout('LC_Offload_Now()', $timeout);
9603: });
1.1215 raeburn 9604: // ]]>
1.1210 raeburn 9605: </script>
9606: OFFLOAD
9607: }
9608: }
9609: }
9610: }
9611: }
1.313 albertel 9612: }
1.306 albertel 9613: if (!defined($title)) {
9614: $title = 'The LearningOnline Network with CAPA';
9615: }
1.460 albertel 9616: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
9617: $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168 raeburn 9618: .'<link rel="stylesheet" type="text/css" href="'.$url.'"';
9619: if (!$args->{'frameset'}) {
9620: $result .= ' /';
9621: }
9622: $result .= '>'
1.1064 raeburn 9623: .$inhibitprint
1.414 albertel 9624: .$head_extra;
1.1242 raeburn 9625: my $clientmobile;
9626: if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
9627: (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
9628: } else {
9629: $clientmobile = $env{'browser.mobile'};
9630: }
9631: if ($clientmobile) {
1.1137 raeburn 9632: $result .= '
9633: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
9634: <meta name="apple-mobile-web-app-capable" content="yes" />';
9635: }
1.1278 raeburn 9636: $result .= '<meta name="google" content="notranslate" />'."\n";
1.962 droeschl 9637: return $result.'</head>';
1.306 albertel 9638: }
9639:
9640: =pod
9641:
1.340 albertel 9642: =item * &font_settings()
9643:
9644: Returns neccessary <meta> to set the proper encoding
9645:
1.1160 raeburn 9646: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340 albertel 9647:
9648: =cut
9649:
9650: sub font_settings {
1.1160 raeburn 9651: my ($args) = @_;
1.340 albertel 9652: my $headerstring='';
1.1160 raeburn 9653: if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
9654: ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168 raeburn 9655: $headerstring.=
9656: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
9657: if (!$args->{'frameset'}) {
9658: $headerstring.= ' /';
9659: }
9660: $headerstring .= '>'."\n";
1.340 albertel 9661: }
9662: return $headerstring;
9663: }
9664:
1.341 albertel 9665: =pod
9666:
1.1064 raeburn 9667: =item * &print_suppression()
9668:
9669: In course context returns css which causes the body to be blank when media="print",
9670: if printout generation is unavailable for the current resource.
9671:
9672: This could be because:
9673:
9674: (a) printstartdate is in the future
9675:
9676: (b) printenddate is in the past
9677:
9678: (c) there is an active exam block with "printout"
9679: functionality blocked
9680:
9681: Users with pav, pfo or evb privileges are exempt.
9682:
9683: Inputs: none
9684:
9685: =cut
9686:
9687:
9688: sub print_suppression {
9689: my $noprint;
9690: if ($env{'request.course.id'}) {
9691: my $scope = $env{'request.course.id'};
9692: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9693: (&Apache::lonnet::allowed('pfo',$scope))) {
9694: return;
9695: }
9696: if ($env{'request.course.sec'} ne '') {
9697: $scope .= "/$env{'request.course.sec'}";
9698: if ((&Apache::lonnet::allowed('pav',$scope)) ||
9699: (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065 raeburn 9700: return;
1.1064 raeburn 9701: }
9702: }
9703: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9704: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 9705: my $clientip = &Apache::lonnet::get_requestor_ip();
9706: my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064 raeburn 9707: if ($blocked) {
9708: my $checkrole = "cm./$cdom/$cnum";
9709: if ($env{'request.course.sec'} ne '') {
9710: $checkrole .= "/$env{'request.course.sec'}";
9711: }
9712: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
9713: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
9714: $noprint = 1;
9715: }
9716: }
9717: unless ($noprint) {
9718: my $symb = &Apache::lonnet::symbread();
9719: if ($symb ne '') {
9720: my $navmap = Apache::lonnavmaps::navmap->new();
9721: if (ref($navmap)) {
9722: my $res = $navmap->getBySymb($symb);
9723: if (ref($res)) {
9724: if (!$res->resprintable()) {
9725: $noprint = 1;
9726: }
9727: }
9728: }
9729: }
9730: }
9731: if ($noprint) {
9732: return <<"ENDSTYLE";
9733: <style type="text/css" media="print">
9734: body { display:none }
9735: </style>
9736: ENDSTYLE
9737: }
9738: }
9739: return;
9740: }
9741:
9742: =pod
9743:
1.341 albertel 9744: =item * &xml_begin()
9745:
9746: Returns the needed doctype and <html>
9747:
9748: Inputs: none
9749:
9750: =cut
9751:
9752: sub xml_begin {
1.1168 raeburn 9753: my ($is_frameset) = @_;
1.341 albertel 9754: my $output='';
9755:
9756: if ($env{'browser.mathml'}) {
9757: $output='<?xml version="1.0"?>'
9758: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
9759: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
9760:
9761: # .'<!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">] >'
9762: .'<!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">'
9763: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
9764: .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168 raeburn 9765: } elsif ($is_frameset) {
9766: $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
9767: '<html>'."\n";
1.341 albertel 9768: } else {
1.1168 raeburn 9769: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
9770: '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341 albertel 9771: }
9772: return $output;
9773: }
1.340 albertel 9774:
9775: =pod
9776:
1.306 albertel 9777: =item * &start_page()
9778:
9779: Returns a complete <html> .. <body> section for LON-CAPA web pages.
9780:
1.648 raeburn 9781: Inputs:
9782:
9783: =over 4
9784:
9785: $title - optional title for the page
9786:
9787: $head_extra - optional extra HTML to incude inside the <head>
9788:
9789: $args - additional optional args supported are:
9790:
9791: =over 8
9792:
9793: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 9794: arg on
1.814 bisitz 9795: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on
1.648 raeburn 9796: add_entries -> additional attributes to add to the <body>
9797: domain -> force to color decorate a page for a
1.317 albertel 9798: specific domain
1.648 raeburn 9799: function -> force usage of a specific rolish color
1.317 albertel 9800: scheme
1.648 raeburn 9801: redirect -> see &headtag()
9802: bgcolor -> override the default page bg color
9803: js_ready -> return a string ready for being used in
1.317 albertel 9804: a javascript writeln
1.648 raeburn 9805: html_encode -> return a string ready for being used in
1.320 albertel 9806: a html attribute
1.648 raeburn 9807: force_register -> if is true will turn on the &bodytag()
1.317 albertel 9808: $forcereg arg
1.648 raeburn 9809: frameset -> if true will start with a <frameset>
1.330 albertel 9810: rather than <body>
1.648 raeburn 9811: skip_phases -> hash ref of
1.338 albertel 9812: head -> skip the <html><head> generation
9813: body -> skip all <body> generation
1.648 raeburn 9814: no_auto_mt_title -> prevent &mt()ing the title arg
1.867 kalberla 9815: bread_crumbs -> Array containing breadcrumbs
1.983 raeburn 9816: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs
1.1272 raeburn 9817: bread_crumbs_nomenu -> if true will pass false as the value of $menulink
9818: to lonhtmlcommon::breadcrumbs
1.1096 raeburn 9819: group -> includes the current group, if page is for a
1.1274 raeburn 9820: specific group
9821: use_absolute -> for request for external resource or syllabus, this
9822: will contain https://<hostname> if server uses
9823: https (as per hosts.tab), but request is for http
9824: hostname -> hostname, originally from $r->hostname(), (optional).
1.1369 raeburn 9825: links_disabled -> Links in primary and secondary menus are disabled
9826: (Can enable them once page has loaded - see lonroles.pm
9827: for an example).
1.1380 raeburn 9828: links_target -> Target for links, e.g., _parent (optional).
1.361 albertel 9829:
1.648 raeburn 9830: =back
1.460 albertel 9831:
1.648 raeburn 9832: =back
1.562 albertel 9833:
1.306 albertel 9834: =cut
9835:
9836: sub start_page {
1.309 albertel 9837: my ($title,$head_extra,$args) = @_;
1.318 albertel 9838: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319 albertel 9839:
1.315 albertel 9840: $env{'internal.start_page'}++;
1.1359 raeburn 9841: my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964 droeschl 9842:
1.338 albertel 9843: if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168 raeburn 9844: $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338 albertel 9845: }
1.1316 raeburn 9846:
9847: if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318 raeburn 9848: if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
9849: unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
9850: $args->{'no_primary_menu'} = 1;
9851: }
9852: unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
9853: $args->{'no_inline_menu'} = 1;
9854: }
9855: if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
9856: map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
9857: }
9858: } else {
9859: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9860: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
9861: if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
9862: unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
9863: $args->{'no_primary_menu'} = 1;
9864: }
9865: unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
9866: $args->{'no_inline_menu'} = 1;
9867: }
9868: if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
9869: map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
9870: }
9871: }
9872: }
1.1316 raeburn 9873: ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
9874: $env{'course.'.$env{'request.course.id'}.'.domain'},
9875: $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359 raeburn 9876: } elsif ($env{'request.course.id'}) {
9877: my $expiretime=600;
9878: if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
9879: &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
9880: }
9881: my ($deeplinkmenu,$menuref);
9882: ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
9883: if ($menucoll) {
9884: if (ref($menuref) eq 'HASH') {
9885: %menu = %{$menuref};
9886: }
9887: if ($menu{'top'} eq 'n') {
9888: $args->{'no_primary_menu'} = 1;
9889: }
9890: if ($menu{'inline'} eq 'n') {
9891: unless (&Apache::lonnet::allowed('opa')) {
9892: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9893: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9894: my $crstype = &course_type();
9895: my $now = time;
9896: my $ccrole;
9897: if ($crstype eq 'Community') {
9898: $ccrole = 'co';
9899: } else {
9900: $ccrole = 'cc';
9901: }
9902: if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
9903: my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
9904: if ((($start) && ($start<0)) ||
9905: (($end) && ($end<$now)) ||
9906: (($start) && ($now<$start))) {
9907: $args->{'no_inline_menu'} = 1;
9908: }
9909: } else {
9910: $args->{'no_inline_menu'} = 1;
9911: }
9912: }
9913: }
9914: }
1.1316 raeburn 9915: }
1.1359 raeburn 9916:
1.1385 raeburn 9917: my $showncrumbs;
1.338 albertel 9918: if (! exists($args->{'skip_phases'}{'body'}) ) {
9919: if ($args->{'frameset'}) {
9920: my $attr_string = &make_attr_string($args->{'force_register'},
9921: $args->{'add_entries'});
9922: $result .= "\n<frameset $attr_string>\n";
1.831 bisitz 9923: } else {
9924: $result .=
9925: &bodytag($title,
9926: $args->{'function'}, $args->{'add_entries'},
9927: $args->{'only_body'}, $args->{'domain'},
9928: $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096 raeburn 9929: $args->{'bgcolor'}, $args,
1.1385 raeburn 9930: \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
9931: \%menu,\$showncrumbs);
1.831 bisitz 9932: }
1.330 albertel 9933: }
1.338 albertel 9934:
1.315 albertel 9935: if ($args->{'js_ready'}) {
1.713 kaisler 9936: $result = &js_ready($result);
1.315 albertel 9937: }
1.320 albertel 9938: if ($args->{'html_encode'}) {
1.713 kaisler 9939: $result = &html_encode($result);
9940: }
9941:
1.813 bisitz 9942: # Preparation for new and consistent functionlist at top of screen
9943: # if ($args->{'functionlist'}) {
9944: # $result .= &build_functionlist();
9945: #}
9946:
1.964 droeschl 9947: # Don't add anything more if only_body wanted or in const space
9948: return $result if $args->{'only_body'}
9949: || $env{'request.state'} eq 'construct';
1.813 bisitz 9950:
9951: #Breadcrumbs
1.758 kaisler 9952: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385 raeburn 9953: unless ($showncrumbs) {
1.758 kaisler 9954: &Apache::lonhtmlcommon::clear_breadcrumbs();
9955: #if any br links exists, add them to the breadcrumbs
9956: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
9957: foreach my $crumb (@{$args->{'bread_crumbs'}}){
9958: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
9959: }
9960: }
1.1096 raeburn 9961: # if @advtools array contains items add then to the breadcrumbs
9962: if (@advtools > 0) {
9963: &Apache::lonmenu::advtools_crumbs(@advtools);
9964: }
1.1272 raeburn 9965: my $menulink;
9966: # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
9967: if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312 raeburn 9968: ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272 raeburn 9969: ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
9970: ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
9971: (!$env{'request.role.adv'}))) {
9972: $menulink = 0;
9973: } else {
9974: undef($menulink);
9975: }
1.1385 raeburn 9976: my $linkprotout;
9977: if ($env{'request.deeplink.login'}) {
9978: my $linkprotout = &Apache::lonmenu::linkprot_exit();
9979: if ($linkprotout) {
9980: &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
9981: }
9982: }
1.758 kaisler 9983: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
9984: if(exists($args->{'bread_crumbs_component'})){
1.1272 raeburn 9985: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237 raeburn 9986: } else {
1.1272 raeburn 9987: $result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758 kaisler 9988: }
1.1385 raeburn 9989: }
1.320 albertel 9990: }
1.315 albertel 9991: return $result;
1.306 albertel 9992: }
9993:
9994: sub end_page {
1.315 albertel 9995: my ($args) = @_;
9996: $env{'internal.end_page'}++;
1.330 albertel 9997: my $result;
1.335 albertel 9998: if ($args->{'discussion'}) {
9999: my ($target,$parser);
10000: if (ref($args->{'discussion'})) {
10001: ($target,$parser) =($args->{'discussion'}{'target'},
10002: $args->{'discussion'}{'parser'});
10003: }
10004: $result .= &Apache::lonxml::xmlend($target,$parser);
10005: }
1.330 albertel 10006: if ($args->{'frameset'}) {
10007: $result .= '</frameset>';
10008: } else {
1.635 raeburn 10009: $result .= &endbodytag($args);
1.330 albertel 10010: }
1.1080 raeburn 10011: unless ($args->{'notbody'}) {
10012: $result .= "\n</html>";
10013: }
1.330 albertel 10014:
1.315 albertel 10015: if ($args->{'js_ready'}) {
1.317 albertel 10016: $result = &js_ready($result);
1.315 albertel 10017: }
1.335 albertel 10018:
1.320 albertel 10019: if ($args->{'html_encode'}) {
10020: $result = &html_encode($result);
10021: }
1.335 albertel 10022:
1.315 albertel 10023: return $result;
10024: }
10025:
1.1359 raeburn 10026: sub menucoll_in_effect {
10027: my ($menucoll,$deeplinkmenu,%menu);
10028: if ($env{'request.course.id'}) {
10029: $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362 raeburn 10030: if ($env{'request.deeplink.login'}) {
1.1370 raeburn 10031: my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362 raeburn 10032: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10033: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10034: if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
10035: if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
10036: my $navmap = Apache::lonnavmaps::navmap->new();
10037: if (ref($navmap)) {
10038: $deeplink = $navmap->get_mapparam(undef,
10039: &Apache::lonnet::declutter($env{'request.noversionuri'}),
10040: '0.deeplink');
1.1370 raeburn 10041: } else {
10042: $check_login_symb = 1;
1.1362 raeburn 10043: }
10044: } else {
1.1370 raeburn 10045: my $symb = &Apache::lonnet::symbread();
10046: if ($symb) {
10047: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
10048: } else {
10049: $check_login_symb = 1;
10050: }
1.1362 raeburn 10051: }
10052: } else {
1.1370 raeburn 10053: $check_login_symb = 1;
10054: }
10055: if ($check_login_symb) {
1.1362 raeburn 10056: $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
10057: if ($deeplink_symb =~ /\.(page|sequence)$/) {
10058: my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
10059: my $navmap = Apache::lonnavmaps::navmap->new();
10060: if (ref($navmap)) {
10061: $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
10062: }
10063: } else {
10064: $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
10065: }
10066: }
1.1359 raeburn 10067: if ($deeplink ne '') {
1.1378 raeburn 10068: my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359 raeburn 10069: if ($display =~ /^\d+$/) {
10070: $deeplinkmenu = 1;
10071: $menucoll = $display;
10072: }
10073: }
10074: }
10075: if ($menucoll) {
10076: %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
10077: }
10078: }
10079: return ($menucoll,$deeplinkmenu,\%menu);
10080: }
10081:
1.1362 raeburn 10082: sub deeplink_login_symb {
10083: my ($cnum,$cdom) = @_;
10084: my $login_symb;
10085: if ($env{'request.deeplink.login'}) {
1.1364 raeburn 10086: $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
10087: }
10088: return $login_symb;
10089: }
10090:
10091: sub symb_from_tinyurl {
10092: my ($url,$cnum,$cdom) = @_;
10093: if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
10094: my $key = $1;
10095: my ($tinyurl,$login);
10096: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
10097: if (defined($cached)) {
10098: $tinyurl = $result;
10099: } else {
10100: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
10101: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
10102: if ($currtiny{$key} ne '') {
10103: $tinyurl = $currtiny{$key};
10104: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362 raeburn 10105: }
1.1364 raeburn 10106: }
10107: if ($tinyurl ne '') {
10108: my ($cnumreq,$symb) = split(/\&/,$tinyurl);
10109: if (wantarray) {
10110: return ($cnumreq,$symb);
10111: } elsif ($cnumreq eq $cnum) {
10112: return $symb;
1.1362 raeburn 10113: }
10114: }
10115: }
1.1364 raeburn 10116: if (wantarray) {
10117: return ();
10118: } else {
10119: return;
10120: }
1.1362 raeburn 10121: }
10122:
1.1405 raeburn 10123: sub usable_exttools {
10124: my %tooltypes;
10125: if ($env{'request.course.id'}) {
10126: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
10127: if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
10128: %tooltypes = (
10129: crs => 1,
10130: dom => 1,
10131: );
10132: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
10133: $tooltypes{'crs'} = 1;
10134: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
10135: $tooltypes{'dom'} = 1;
10136: }
10137: } else {
10138: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10139: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10140: my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
10141: if ($crstype eq '') {
10142: $crstype = 'course';
10143: }
10144: if ($crstype eq 'course') {
10145: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
10146: $crstype = 'official';
10147: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
10148: $crstype = 'textbook';
10149: } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
10150: $crstype = 'lti';
10151: } else {
10152: $crstype = 'unofficial';
10153: }
10154: }
10155: my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
10156: if ($domdefaults{$crstype.'domexttool'}) {
10157: $tooltypes{'dom'} = 1;
10158: }
10159: if ($domdefaults{$crstype.'exttool'}) {
10160: $tooltypes{'crs'} = 1;
10161: }
10162: }
10163: }
10164: return %tooltypes;
10165: }
10166:
1.1034 www 10167: sub wishlist_window {
10168: return(<<'ENDWISHLIST');
1.1046 raeburn 10169: <script type="text/javascript">
1.1034 www 10170: // <![CDATA[
10171: // <!-- BEGIN LON-CAPA Internal
10172: function set_wishlistlink(title, path) {
10173: if (!title) {
10174: title = document.title;
10175: title = title.replace(/^LON-CAPA /,'');
10176: }
1.1175 raeburn 10177: title = encodeURIComponent(title);
1.1203 raeburn 10178: title = title.replace("'","\\\'");
1.1034 www 10179: if (!path) {
10180: path = location.pathname;
10181: }
1.1175 raeburn 10182: path = encodeURIComponent(path);
1.1203 raeburn 10183: path = path.replace("'","\\\'");
1.1034 www 10184: Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
10185: 'wishlistNewLink','width=560,height=350,scrollbars=0');
10186: }
10187: // END LON-CAPA Internal -->
10188: // ]]>
10189: </script>
10190: ENDWISHLIST
10191: }
10192:
1.1030 www 10193: sub modal_window {
10194: return(<<'ENDMODAL');
1.1046 raeburn 10195: <script type="text/javascript">
1.1030 www 10196: // <![CDATA[
10197: // <!-- BEGIN LON-CAPA Internal
10198: var modalWindow = {
10199: parent:"body",
10200: windowId:null,
10201: content:null,
10202: width:null,
10203: height:null,
10204: close:function()
10205: {
10206: $(".LCmodal-window").remove();
10207: $(".LCmodal-overlay").remove();
10208: },
10209: open:function()
10210: {
10211: var modal = "";
10212: modal += "<div class=\"LCmodal-overlay\"></div>";
10213: 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;\">";
10214: modal += this.content;
10215: modal += "</div>";
10216:
10217: $(this.parent).append(modal);
10218:
10219: $(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
10220: $(".LCclose-window").click(function(){modalWindow.close();});
10221: $(".LCmodal-overlay").click(function(){modalWindow.close();});
10222: }
10223: };
1.1140 raeburn 10224: var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030 www 10225: {
1.1266 raeburn 10226: source = source.replace(/'/g,"'");
1.1030 www 10227: modalWindow.windowId = "myModal";
10228: modalWindow.width = width;
10229: modalWindow.height = height;
1.1196 raeburn 10230: modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030 www 10231: modalWindow.open();
1.1208 raeburn 10232: };
1.1030 www 10233: // END LON-CAPA Internal -->
10234: // ]]>
10235: </script>
10236: ENDMODAL
10237: }
10238:
10239: sub modal_link {
1.1140 raeburn 10240: my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030 www 10241: unless ($width) { $width=480; }
10242: unless ($height) { $height=400; }
1.1031 www 10243: unless ($scrolling) { $scrolling='yes'; }
1.1140 raeburn 10244: unless ($transparency) { $transparency='true'; }
10245:
1.1074 raeburn 10246: my $target_attr;
10247: if (defined($target)) {
10248: $target_attr = 'target="'.$target.'"';
10249: }
10250: return <<"ENDLINK";
1.1336 raeburn 10251: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074 raeburn 10252: ENDLINK
1.1030 www 10253: }
10254:
1.1032 www 10255: sub modal_adhoc_script {
1.1365 raeburn 10256: my ($funcname,$width,$height,$content,$possmathjax)=@_;
10257: my $mathjax;
10258: if ($possmathjax) {
10259: $mathjax = <<'ENDJAX';
10260: if (typeof MathJax == 'object') {
10261: MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
10262: }
10263: ENDJAX
10264: }
1.1032 www 10265: return (<<ENDADHOC);
1.1046 raeburn 10266: <script type="text/javascript">
1.1032 www 10267: // <![CDATA[
10268: var $funcname = function()
10269: {
10270: modalWindow.windowId = "myModal";
10271: modalWindow.width = $width;
10272: modalWindow.height = $height;
10273: modalWindow.content = '$content';
10274: modalWindow.open();
1.1365 raeburn 10275: $mathjax
1.1032 www 10276: };
10277: // ]]>
10278: </script>
10279: ENDADHOC
10280: }
10281:
1.1041 www 10282: sub modal_adhoc_inner {
1.1365 raeburn 10283: my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041 www 10284: my $innerwidth=$width-20;
10285: $content=&js_ready(
1.1140 raeburn 10286: &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
10287: &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
10288: $content.
1.1041 www 10289: &end_scrollbox().
1.1140 raeburn 10290: &end_page()
1.1041 www 10291: );
1.1365 raeburn 10292: return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041 www 10293: }
10294:
10295: sub modal_adhoc_window {
1.1365 raeburn 10296: my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
10297: return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041 www 10298: "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
10299: }
10300:
10301: sub modal_adhoc_launch {
10302: my ($funcname,$width,$height,$content)=@_;
10303: return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
10304: <script type="text/javascript">
10305: // <![CDATA[
10306: $funcname();
10307: // ]]>
10308: </script>
10309: ENDLAUNCH
10310: }
10311:
10312: sub modal_adhoc_close {
10313: return (<<ENDCLOSE);
10314: <script type="text/javascript">
10315: // <![CDATA[
10316: modalWindow.close();
10317: // ]]>
10318: </script>
10319: ENDCLOSE
10320: }
10321:
1.1038 www 10322: sub togglebox_script {
10323: return(<<ENDTOGGLE);
10324: <script type="text/javascript">
10325: // <![CDATA[
10326: function LCtoggleDisplay(id,hidetext,showtext) {
10327: link = document.getElementById(id + "link").childNodes[0];
10328: with (document.getElementById(id).style) {
10329: if (display == "none" ) {
10330: display = "inline";
10331: link.nodeValue = hidetext;
10332: } else {
10333: display = "none";
10334: link.nodeValue = showtext;
10335: }
10336: }
10337: }
10338: // ]]>
10339: </script>
10340: ENDTOGGLE
10341: }
10342:
1.1039 www 10343: sub start_togglebox {
10344: my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
10345: unless ($heading) { $heading=''; } else { $heading.=' '; }
10346: unless ($showtext) { $showtext=&mt('show'); }
10347: unless ($hidetext) { $hidetext=&mt('hide'); }
10348: unless ($headerbg) { $headerbg='#FFFFFF'; }
10349: return &start_data_table().
10350: &start_data_table_header_row().
10351: '<td bgcolor="'.$headerbg.'">'.$heading.
10352: '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
10353: $showtext.'\')">'.$showtext.'</a>]</td>'.
10354: &end_data_table_header_row().
10355: '<tr id="'.$id.'" style="display:none""><td>';
10356: }
10357:
10358: sub end_togglebox {
10359: return '</td></tr>'.&end_data_table();
10360: }
10361:
1.1041 www 10362: sub LCprogressbar_script {
1.1302 raeburn 10363: my ($id,$number_to_do)=@_;
10364: if ($number_to_do) {
10365: return(<<ENDPROGRESS);
1.1041 www 10366: <script type="text/javascript">
10367: // <![CDATA[
1.1045 www 10368: \$('#progressbar$id').progressbar({
1.1041 www 10369: value: 0,
10370: change: function(event, ui) {
10371: var newVal = \$(this).progressbar('option', 'value');
10372: \$('.pblabel', this).text(LCprogressTxt);
10373: }
10374: });
10375: // ]]>
10376: </script>
10377: ENDPROGRESS
1.1302 raeburn 10378: } else {
10379: return(<<ENDPROGRESS);
10380: <script type="text/javascript">
10381: // <![CDATA[
10382: \$('#progressbar$id').progressbar({
10383: value: false,
10384: create: function(event, ui) {
10385: \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
10386: \$('.ui-progressbar-overlay', this).css({'margin':'0'});
10387: }
10388: });
10389: // ]]>
10390: </script>
10391: ENDPROGRESS
10392: }
1.1041 www 10393: }
10394:
10395: sub LCprogressbarUpdate_script {
10396: return(<<ENDPROGRESSUPDATE);
10397: <style type="text/css">
10398: .ui-progressbar { position:relative; }
1.1302 raeburn 10399: .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 10400: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
10401: </style>
10402: <script type="text/javascript">
10403: // <![CDATA[
1.1045 www 10404: var LCprogressTxt='---';
10405:
1.1302 raeburn 10406: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041 www 10407: LCprogressTxt=progresstext;
1.1302 raeburn 10408: if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
10409: \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
10410: } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301 raeburn 10411: \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
10412: } else {
10413: \$('#progressbar'+id).progressbar('value',percent);
10414: }
1.1041 www 10415: }
10416: // ]]>
10417: </script>
10418: ENDPROGRESSUPDATE
10419: }
10420:
1.1042 www 10421: my $LClastpercent;
1.1045 www 10422: my $LCidcnt;
10423: my $LCcurrentid;
1.1042 www 10424:
1.1041 www 10425: sub LCprogressbar {
1.1302 raeburn 10426: my ($r,$number_to_do,$preamble)=@_;
1.1042 www 10427: $LClastpercent=0;
1.1045 www 10428: $LCidcnt++;
10429: $LCcurrentid=$$.'_'.$LCidcnt;
1.1302 raeburn 10430: my ($starting,$content);
10431: if ($number_to_do) {
10432: $starting=&mt('Starting');
10433: $content=(<<ENDPROGBAR);
10434: $preamble
1.1045 www 10435: <div id="progressbar$LCcurrentid">
1.1041 www 10436: <span class="pblabel">$starting</span>
10437: </div>
10438: ENDPROGBAR
1.1302 raeburn 10439: } else {
10440: $starting=&mt('Loading...');
10441: $LClastpercent='false';
10442: $content=(<<ENDPROGBAR);
10443: $preamble
10444: <div id="progressbar$LCcurrentid">
10445: <div class="progress-label">$starting</div>
10446: </div>
10447: ENDPROGBAR
10448: }
10449: &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041 www 10450: }
10451:
10452: sub LCprogressbarUpdate {
1.1302 raeburn 10453: my ($r,$val,$text,$number_to_do)=@_;
10454: if ($number_to_do) {
10455: unless ($val) {
10456: if ($LClastpercent) {
10457: $val=$LClastpercent;
10458: } else {
10459: $val=0;
10460: }
10461: }
10462: if ($val<0) { $val=0; }
10463: if ($val>100) { $val=0; }
10464: $LClastpercent=$val;
10465: unless ($text) { $text=$val.'%'; }
10466: } else {
10467: $val = 'false';
1.1042 www 10468: }
1.1041 www 10469: $text=&js_ready($text);
1.1044 www 10470: &r_print($r,<<ENDUPDATE);
1.1041 www 10471: <script type="text/javascript">
10472: // <![CDATA[
1.1302 raeburn 10473: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041 www 10474: // ]]>
10475: </script>
10476: ENDUPDATE
1.1035 www 10477: }
10478:
1.1042 www 10479: sub LCprogressbarClose {
10480: my ($r)=@_;
10481: $LClastpercent=0;
1.1044 www 10482: &r_print($r,<<ENDCLOSE);
1.1042 www 10483: <script type="text/javascript">
10484: // <![CDATA[
1.1045 www 10485: \$("#progressbar$LCcurrentid").hide('slow');
1.1042 www 10486: // ]]>
10487: </script>
10488: ENDCLOSE
1.1044 www 10489: }
10490:
10491: sub r_print {
10492: my ($r,$to_print)=@_;
10493: if ($r) {
10494: $r->print($to_print);
10495: $r->rflush();
10496: } else {
10497: print($to_print);
10498: }
1.1042 www 10499: }
10500:
1.320 albertel 10501: sub html_encode {
10502: my ($result) = @_;
10503:
1.322 albertel 10504: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 10505:
10506: return $result;
10507: }
1.1044 www 10508:
1.317 albertel 10509: sub js_ready {
10510: my ($result) = @_;
10511:
1.323 albertel 10512: $result =~ s/[\n\r]/ /xmsg;
10513: $result =~ s/\\/\\\\/xmsg;
10514: $result =~ s/'/\\'/xmsg;
1.372 albertel 10515: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 10516:
10517: return $result;
10518: }
10519:
1.315 albertel 10520: sub validate_page {
10521: if ( exists($env{'internal.start_page'})
1.316 albertel 10522: && $env{'internal.start_page'} > 1) {
10523: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 10524: $env{'internal.start_page'}.' '.
1.316 albertel 10525: $ENV{'request.filename'});
1.315 albertel 10526: }
10527: if ( exists($env{'internal.end_page'})
1.316 albertel 10528: && $env{'internal.end_page'} > 1) {
10529: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 10530: $env{'internal.end_page'}.' '.
1.316 albertel 10531: $env{'request.filename'});
1.315 albertel 10532: }
10533: if ( exists($env{'internal.start_page'})
10534: && ! exists($env{'internal.end_page'})) {
1.316 albertel 10535: &Apache::lonnet::logthis('start_page called without end_page '.
10536: $env{'request.filename'});
1.315 albertel 10537: }
10538: if ( ! exists($env{'internal.start_page'})
10539: && exists($env{'internal.end_page'})) {
1.316 albertel 10540: &Apache::lonnet::logthis('end_page called without start_page'.
10541: $env{'request.filename'});
1.315 albertel 10542: }
1.306 albertel 10543: }
1.315 albertel 10544:
1.996 www 10545:
10546: sub start_scrollbox {
1.1140 raeburn 10547: my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998 raeburn 10548: unless ($outerwidth) { $outerwidth='520px'; }
10549: unless ($width) { $width='500px'; }
10550: unless ($height) { $height='200px'; }
1.1075 raeburn 10551: my ($table_id,$div_id,$tdcol);
1.1018 raeburn 10552: if ($id ne '') {
1.1140 raeburn 10553: $table_id = ' id="table_'.$id.'"';
1.1137 raeburn 10554: $div_id = ' id="div_'.$id.'"';
1.1018 raeburn 10555: }
1.1075 raeburn 10556: if ($bgcolor ne '') {
10557: $tdcol = "background-color: $bgcolor;";
10558: }
1.1137 raeburn 10559: my $nicescroll_js;
10560: if ($env{'browser.mobile'}) {
1.1140 raeburn 10561: $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
10562: }
10563: return <<"END";
10564: $nicescroll_js
10565:
10566: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
10567: <div style="overflow:auto; width:$width; height:$height;"$div_id>
10568: END
10569: }
10570:
10571: sub end_scrollbox {
10572: return '</div></td></tr></table>';
10573: }
10574:
10575: sub nicescroll_javascript {
10576: my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
10577: my %options;
10578: if (ref($cursor) eq 'HASH') {
10579: %options = %{$cursor};
10580: }
10581: unless ($options{'railalign'} =~ /^left|right$/) {
10582: $options{'railalign'} = 'left';
10583: }
10584: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
10585: my $function = &get_users_function();
10586: $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138 raeburn 10587: unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140 raeburn 10588: $options{'cursorcolor'} = '#00F';
1.1138 raeburn 10589: }
1.1140 raeburn 10590: }
10591: if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
10592: unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138 raeburn 10593: $options{'cursoropacity'}='1.0';
10594: }
1.1140 raeburn 10595: } else {
10596: $options{'cursoropacity'}='1.0';
10597: }
10598: if ($options{'cursorfixedheight'} eq 'none') {
10599: delete($options{'cursorfixedheight'});
10600: } else {
10601: unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
10602: }
10603: unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
10604: delete($options{'railoffset'});
10605: }
10606: my @niceoptions;
10607: while (my($key,$value) = each(%options)) {
10608: if ($value =~ /^\{.+\}$/) {
10609: push(@niceoptions,$key.':'.$value);
1.1138 raeburn 10610: } else {
1.1140 raeburn 10611: push(@niceoptions,$key.':"'.$value.'"');
1.1138 raeburn 10612: }
1.1140 raeburn 10613: }
10614: my $nicescroll_js = '
1.1137 raeburn 10615: $(document).ready(
1.1140 raeburn 10616: function() {
10617: $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
10618: }
1.1137 raeburn 10619: );
10620: ';
1.1140 raeburn 10621: if ($framecheck) {
10622: $nicescroll_js .= '
10623: function expand_div(caller) {
10624: if (top === self) {
10625: document.getElementById("'.$id.'").style.width = "auto";
10626: document.getElementById("'.$id.'").style.height = "auto";
10627: } else {
10628: try {
10629: if (parent.frames) {
10630: if (parent.frames.length > 1) {
10631: var framesrc = parent.frames[1].location.href;
10632: var currsrc = framesrc.replace(/\#.*$/,"");
10633: if ((caller == "search") || (currsrc == "'.$location.'")) {
10634: document.getElementById("'.$id.'").style.width = "auto";
10635: document.getElementById("'.$id.'").style.height = "auto";
10636: }
10637: }
10638: }
10639: } catch (e) {
10640: return;
10641: }
1.1137 raeburn 10642: }
1.1140 raeburn 10643: return;
1.996 www 10644: }
1.1140 raeburn 10645: ';
10646: }
10647: if ($needjsready) {
10648: $nicescroll_js = '
10649: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
10650: } else {
10651: $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
10652: }
10653: return $nicescroll_js;
1.996 www 10654: }
10655:
1.318 albertel 10656: sub simple_error_page {
1.1150 bisitz 10657: my ($r,$title,$msg,$args) = @_;
1.1304 raeburn 10658: my %displayargs;
1.1151 raeburn 10659: if (ref($args) eq 'HASH') {
10660: if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304 raeburn 10661: if ($args->{'only_body'}) {
10662: $displayargs{'only_body'} = 1;
10663: }
10664: if ($args->{'no_nav_bar'}) {
10665: $displayargs{'no_nav_bar'} = 1;
10666: }
1.1151 raeburn 10667: } else {
10668: $msg = &mt($msg);
10669: }
1.1150 bisitz 10670:
1.318 albertel 10671: my $page =
1.1304 raeburn 10672: &Apache::loncommon::start_page($title,'',\%displayargs).
1.1150 bisitz 10673: '<p class="LC_error">'.$msg.'</p>'.
1.318 albertel 10674: &Apache::loncommon::end_page();
10675: if (ref($r)) {
10676: $r->print($page);
1.327 albertel 10677: return;
1.318 albertel 10678: }
10679: return $page;
10680: }
1.347 albertel 10681:
10682: {
1.610 albertel 10683: my @row_count;
1.961 onken 10684:
10685: sub start_data_table_count {
10686: unshift(@row_count, 0);
10687: return;
10688: }
10689:
10690: sub end_data_table_count {
10691: shift(@row_count);
10692: return;
10693: }
10694:
1.347 albertel 10695: sub start_data_table {
1.1018 raeburn 10696: my ($add_class,$id) = @_;
1.422 albertel 10697: my $css_class = (join(' ','LC_data_table',$add_class));
1.1018 raeburn 10698: my $table_id;
10699: if (defined($id)) {
10700: $table_id = ' id="'.$id.'"';
10701: }
1.961 onken 10702: &start_data_table_count();
1.1018 raeburn 10703: return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347 albertel 10704: }
10705:
10706: sub end_data_table {
1.961 onken 10707: &end_data_table_count();
1.389 albertel 10708: return '</table>'."\n";;
1.347 albertel 10709: }
10710:
10711: sub start_data_table_row {
1.974 wenzelju 10712: my ($add_class, $id) = @_;
1.610 albertel 10713: $row_count[0]++;
10714: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900 bisitz 10715: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974 wenzelju 10716: $id = (' id="'.$id.'"') unless ($id eq '');
10717: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347 albertel 10718: }
1.471 banghart 10719:
10720: sub continue_data_table_row {
1.974 wenzelju 10721: my ($add_class, $id) = @_;
1.610 albertel 10722: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974 wenzelju 10723: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
10724: $id = (' id="'.$id.'"') unless ($id eq '');
10725: return '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471 banghart 10726: }
1.347 albertel 10727:
10728: sub end_data_table_row {
1.389 albertel 10729: return '</tr>'."\n";;
1.347 albertel 10730: }
1.367 www 10731:
1.421 albertel 10732: sub start_data_table_empty_row {
1.707 bisitz 10733: # $row_count[0]++;
1.421 albertel 10734: return '<tr class="LC_empty_row" >'."\n";;
10735: }
10736:
10737: sub end_data_table_empty_row {
10738: return '</tr>'."\n";;
10739: }
10740:
1.367 www 10741: sub start_data_table_header_row {
1.389 albertel 10742: return '<tr class="LC_header_row">'."\n";;
1.367 www 10743: }
10744:
10745: sub end_data_table_header_row {
1.389 albertel 10746: return '</tr>'."\n";;
1.367 www 10747: }
1.890 droeschl 10748:
10749: sub data_table_caption {
10750: my $caption = shift;
10751: return "<caption class=\"LC_caption\">$caption</caption>";
10752: }
1.347 albertel 10753: }
10754:
1.548 albertel 10755: =pod
10756:
10757: =item * &inhibit_menu_check($arg)
10758:
10759: Checks for a inhibitmenu state and generates output to preserve it
10760:
10761: Inputs: $arg - can be any of
10762: - undef - in which case the return value is a string
10763: to add into arguments list of a uri
10764: - 'input' - in which case the return value is a HTML
10765: <form> <input> field of type hidden to
10766: preserve the value
10767: - a url - in which case the return value is the url with
10768: the neccesary cgi args added to preserve the
10769: inhibitmenu state
10770: - a ref to a url - no return value, but the string is
10771: updated to include the neccessary cgi
10772: args to preserve the inhibitmenu state
10773:
10774: =cut
10775:
10776: sub inhibit_menu_check {
10777: my ($arg) = @_;
10778: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
10779: if ($arg eq 'input') {
10780: if ($env{'form.inhibitmenu'}) {
10781: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
10782: } else {
10783: return
10784: }
10785: }
10786: if ($env{'form.inhibitmenu'}) {
10787: if (ref($arg)) {
10788: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10789: } elsif ($arg eq '') {
10790: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
10791: } else {
10792: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
10793: }
10794: }
10795: if (!ref($arg)) {
10796: return $arg;
10797: }
10798: }
10799:
1.251 albertel 10800: ###############################################
1.182 matthew 10801:
10802: =pod
10803:
1.549 albertel 10804: =back
10805:
10806: =head1 User Information Routines
10807:
10808: =over 4
10809:
1.405 albertel 10810: =item * &get_users_function()
1.182 matthew 10811:
10812: Used by &bodytag to determine the current users primary role.
10813: Returns either 'student','coordinator','admin', or 'author'.
10814:
10815: =cut
10816:
10817: ###############################################
10818: sub get_users_function {
1.815 tempelho 10819: my $function = 'norole';
1.818 tempelho 10820: if ($env{'request.role'}=~/^(st)/) {
10821: $function='student';
10822: }
1.907 raeburn 10823: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182 matthew 10824: $function='coordinator';
10825: }
1.258 albertel 10826: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 10827: $function='admin';
10828: }
1.826 bisitz 10829: if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025 raeburn 10830: ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182 matthew 10831: $function='author';
10832: }
10833: return $function;
1.54 www 10834: }
1.99 www 10835:
10836: ###############################################
10837:
1.233 raeburn 10838: =pod
10839:
1.821 raeburn 10840: =item * &show_course()
10841:
10842: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
10843: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
10844:
10845: Inputs:
10846: None
10847:
10848: Outputs:
10849: Scalar: 1 if 'Course' to be used, 0 otherwise.
10850:
10851: =cut
10852:
10853: ###############################################
10854: sub show_course {
1.1408 raeburn 10855: my ($udom,$uname) = @_;
10856: if (($udom ne '') && ($uname ne '')) {
10857: if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410 raeburn 10858: if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408 raeburn 10859: return 0;
10860: } else {
10861: return 1;
10862: }
10863: }
10864: }
1.821 raeburn 10865: my $course = !$env{'user.adv'};
10866: if (!$env{'user.adv'}) {
10867: foreach my $env (keys(%env)) {
10868: next if ($env !~ m/^user\.priv\./);
10869: if ($env !~ m/^user\.priv\.(?:st|cm)/) {
10870: $course = 0;
10871: last;
10872: }
10873: }
10874: }
10875: return $course;
10876: }
10877:
10878: ###############################################
10879:
10880: =pod
10881:
1.542 raeburn 10882: =item * &check_user_status()
1.274 raeburn 10883:
10884: Determines current status of supplied role for a
10885: specific user. Roles can be active, previous or future.
10886:
10887: Inputs:
10888: user's domain, user's username, course's domain,
1.375 raeburn 10889: course's number, optional section ID.
1.274 raeburn 10890:
10891: Outputs:
10892: role status: active, previous or future.
10893:
10894: =cut
10895:
10896: sub check_user_status {
1.412 raeburn 10897: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073 raeburn 10898: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202 raeburn 10899: my @uroles = keys(%userinfo);
1.274 raeburn 10900: my $srchstr;
10901: my $active_chk = 'none';
1.412 raeburn 10902: my $now = time;
1.274 raeburn 10903: if (@uroles > 0) {
1.908 raeburn 10904: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 10905: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
10906: } else {
1.412 raeburn 10907: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
10908: }
10909: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 10910: my $role_end = 0;
10911: my $role_start = 0;
10912: $active_chk = 'active';
1.412 raeburn 10913: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
10914: $role_end = $1;
10915: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
10916: $role_start = $1;
1.274 raeburn 10917: }
10918: }
10919: if ($role_start > 0) {
1.412 raeburn 10920: if ($now < $role_start) {
1.274 raeburn 10921: $active_chk = 'future';
10922: }
10923: }
10924: if ($role_end > 0) {
1.412 raeburn 10925: if ($now > $role_end) {
1.274 raeburn 10926: $active_chk = 'previous';
10927: }
10928: }
10929: }
10930: }
10931: return $active_chk;
10932: }
10933:
10934: ###############################################
10935:
10936: =pod
10937:
1.405 albertel 10938: =item * &get_sections()
1.233 raeburn 10939:
10940: Determines all the sections for a course including
10941: sections with students and sections containing other roles.
1.419 raeburn 10942: Incoming parameters:
10943:
10944: 1. domain
10945: 2. course number
10946: 3. reference to array containing roles for which sections should
10947: be gathered (optional).
10948: 4. reference to array containing status types for which sections
10949: should be gathered (optional).
10950:
10951: If the third argument is undefined, sections are gathered for any role.
10952: If the fourth argument is undefined, sections are gathered for any status.
10953: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 10954:
1.374 raeburn 10955: Returns section hash (keys are section IDs, values are
10956: number of users in each section), subject to the
1.419 raeburn 10957: optional roles filter, optional status filter
1.233 raeburn 10958:
10959: =cut
10960:
10961: ###############################################
10962: sub get_sections {
1.419 raeburn 10963: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 10964: if (!defined($cdom) || !defined($cnum)) {
10965: my $cid = $env{'request.course.id'};
10966:
10967: return if (!defined($cid));
10968:
10969: $cdom = $env{'course.'.$cid.'.domain'};
10970: $cnum = $env{'course.'.$cid.'.num'};
10971: }
10972:
10973: my %sectioncount;
1.419 raeburn 10974: my $now = time;
1.240 albertel 10975:
1.1118 raeburn 10976: my $check_students = 1;
10977: my $only_students = 0;
10978: if (ref($possible_roles) eq 'ARRAY') {
10979: if (grep(/^st$/,@{$possible_roles})) {
10980: if (@{$possible_roles} == 1) {
10981: $only_students = 1;
10982: }
10983: } else {
10984: $check_students = 0;
10985: }
10986: }
10987:
10988: if ($check_students) {
1.276 albertel 10989: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 10990: my $sec_index = &Apache::loncoursedata::CL_SECTION();
10991: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 10992: my $start_index = &Apache::loncoursedata::CL_START();
10993: my $end_index = &Apache::loncoursedata::CL_END();
10994: my $status;
1.366 albertel 10995: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 10996: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
10997: $data->[$status_index],
10998: $data->[$start_index],
10999: $data->[$end_index]);
11000: if ($stu_status eq 'Active') {
11001: $status = 'active';
11002: } elsif ($end < $now) {
11003: $status = 'previous';
11004: } elsif ($start > $now) {
11005: $status = 'future';
11006: }
11007: if ($section ne '-1' && $section !~ /^\s*$/) {
11008: if ((!defined($possible_status)) || (($status ne '') &&
11009: (grep/^\Q$status\E$/,@{$possible_status}))) {
11010: $sectioncount{$section}++;
11011: }
1.240 albertel 11012: }
11013: }
11014: }
1.1118 raeburn 11015: if ($only_students) {
11016: return %sectioncount;
11017: }
1.240 albertel 11018: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11019: foreach my $user (sort(keys(%courseroles))) {
11020: if ($user !~ /^(\w{2})/) { next; }
11021: my ($role) = ($user =~ /^(\w{2})/);
11022: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 11023: my ($section,$status);
1.240 albertel 11024: if ($role eq 'cr' &&
11025: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
11026: $section=$1;
11027: }
11028: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
11029: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 11030: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
11031: if ($end == -1 && $start == -1) {
11032: next; #deleted role
11033: }
11034: if (!defined($possible_status)) {
11035: $sectioncount{$section}++;
11036: } else {
11037: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
11038: $status = 'active';
11039: } elsif ($end < $now) {
11040: $status = 'future';
11041: } elsif ($start > $now) {
11042: $status = 'previous';
11043: }
11044: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
11045: $sectioncount{$section}++;
11046: }
11047: }
1.233 raeburn 11048: }
1.366 albertel 11049: return %sectioncount;
1.233 raeburn 11050: }
11051:
1.274 raeburn 11052: ###############################################
1.294 raeburn 11053:
11054: =pod
1.405 albertel 11055:
11056: =item * &get_course_users()
11057:
1.275 raeburn 11058: Retrieves usernames:domains for users in the specified course
11059: with specific role(s), and access status.
11060:
11061: Incoming parameters:
1.277 albertel 11062: 1. course domain
11063: 2. course number
11064: 3. access status: users must have - either active,
1.275 raeburn 11065: previous, future, or all.
1.277 albertel 11066: 4. reference to array of permissible roles
1.288 raeburn 11067: 5. reference to array of section restrictions (optional)
11068: 6. reference to results object (hash of hashes).
11069: 7. reference to optional userdata hash
1.609 raeburn 11070: 8. reference to optional statushash
1.630 raeburn 11071: 9. flag if privileged users (except those set to unhide in
11072: course settings) should be excluded
1.609 raeburn 11073: Keys of top level results hash are roles.
1.275 raeburn 11074: Keys of inner hashes are username:domain, with
11075: values set to access type.
1.288 raeburn 11076: Optional userdata hash returns an array with arguments in the
11077: same order as loncoursedata::get_classlist() for student data.
11078:
1.609 raeburn 11079: Optional statushash returns
11080:
1.288 raeburn 11081: Entries for end, start, section and status are blank because
11082: of the possibility of multiple values for non-student roles.
11083:
1.275 raeburn 11084: =cut
1.405 albertel 11085:
1.275 raeburn 11086: ###############################################
1.405 albertel 11087:
1.275 raeburn 11088: sub get_course_users {
1.630 raeburn 11089: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 11090: my %idx = ();
1.419 raeburn 11091: my %seclists;
1.288 raeburn 11092:
11093: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
11094: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
11095: $idx{end} = &Apache::loncoursedata::CL_END();
11096: $idx{start} = &Apache::loncoursedata::CL_START();
11097: $idx{id} = &Apache::loncoursedata::CL_ID();
11098: $idx{section} = &Apache::loncoursedata::CL_SECTION();
11099: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
11100: $idx{status} = &Apache::loncoursedata::CL_STATUS();
11101:
1.290 albertel 11102: if (grep(/^st$/,@{$roles})) {
1.276 albertel 11103: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 11104: my $now = time;
1.277 albertel 11105: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 11106: my $match = 0;
1.412 raeburn 11107: my $secmatch = 0;
1.419 raeburn 11108: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 11109: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 11110: if ($section eq '') {
11111: $section = 'none';
11112: }
1.291 albertel 11113: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11114: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11115: $secmatch = 1;
11116: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 11117: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11118: $secmatch = 1;
11119: }
11120: } else {
1.419 raeburn 11121: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 11122: $secmatch = 1;
11123: }
1.290 albertel 11124: }
1.412 raeburn 11125: if (!$secmatch) {
11126: next;
11127: }
1.419 raeburn 11128: }
1.275 raeburn 11129: if (defined($$types{'active'})) {
1.288 raeburn 11130: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 11131: push(@{$$users{st}{$student}},'active');
1.288 raeburn 11132: $match = 1;
1.275 raeburn 11133: }
11134: }
11135: if (defined($$types{'previous'})) {
1.609 raeburn 11136: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 11137: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 11138: $match = 1;
1.275 raeburn 11139: }
11140: }
11141: if (defined($$types{'future'})) {
1.609 raeburn 11142: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 11143: push(@{$$users{st}{$student}},'future');
1.288 raeburn 11144: $match = 1;
1.275 raeburn 11145: }
11146: }
1.609 raeburn 11147: if ($match) {
11148: push(@{$seclists{$student}},$section);
11149: if (ref($userdata) eq 'HASH') {
11150: $$userdata{$student} = $$classlist{$student};
11151: }
11152: if (ref($statushash) eq 'HASH') {
11153: $statushash->{$student}{'st'}{$section} = $status;
11154: }
1.288 raeburn 11155: }
1.275 raeburn 11156: }
11157: }
1.412 raeburn 11158: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 11159: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11160: my $now = time;
1.609 raeburn 11161: my %displaystatus = ( previous => 'Expired',
11162: active => 'Active',
11163: future => 'Future',
11164: );
1.1121 raeburn 11165: my (%nothide,@possdoms);
1.630 raeburn 11166: if ($hidepriv) {
11167: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
11168: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
11169: if ($user !~ /:/) {
11170: $nothide{join(':',split(/[\@]/,$user))}=1;
11171: } else {
11172: $nothide{$user} = 1;
11173: }
11174: }
1.1121 raeburn 11175: my @possdoms = ($cdom);
11176: if ($coursehash{'checkforpriv'}) {
11177: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
11178: }
1.630 raeburn 11179: }
1.439 raeburn 11180: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 11181: my $match = 0;
1.412 raeburn 11182: my $secmatch = 0;
1.439 raeburn 11183: my $status;
1.412 raeburn 11184: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 11185: $user =~ s/:$//;
1.439 raeburn 11186: my ($end,$start) = split(/:/,$coursepersonnel{$person});
11187: if ($end == -1 || $start == -1) {
11188: next;
11189: }
11190: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
11191: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 11192: my ($uname,$udom) = split(/:/,$user);
11193: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 11194: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 11195: $secmatch = 1;
11196: } elsif ($usec eq '') {
1.420 albertel 11197: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 11198: $secmatch = 1;
11199: }
11200: } else {
11201: if (grep(/^\Q$usec\E$/,@{$sections})) {
11202: $secmatch = 1;
11203: }
11204: }
11205: if (!$secmatch) {
11206: next;
11207: }
1.288 raeburn 11208: }
1.419 raeburn 11209: if ($usec eq '') {
11210: $usec = 'none';
11211: }
1.275 raeburn 11212: if ($uname ne '' && $udom ne '') {
1.630 raeburn 11213: if ($hidepriv) {
1.1121 raeburn 11214: if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630 raeburn 11215: (!$nothide{$uname.':'.$udom})) {
11216: next;
11217: }
11218: }
1.503 raeburn 11219: if ($end > 0 && $end < $now) {
1.439 raeburn 11220: $status = 'previous';
11221: } elsif ($start > $now) {
11222: $status = 'future';
11223: } else {
11224: $status = 'active';
11225: }
1.277 albertel 11226: foreach my $type (keys(%{$types})) {
1.275 raeburn 11227: if ($status eq $type) {
1.420 albertel 11228: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 11229: push(@{$$users{$role}{$user}},$type);
11230: }
1.288 raeburn 11231: $match = 1;
11232: }
11233: }
1.419 raeburn 11234: if (($match) && (ref($userdata) eq 'HASH')) {
11235: if (!exists($$userdata{$uname.':'.$udom})) {
11236: &get_user_info($udom,$uname,\%idx,$userdata);
11237: }
1.420 albertel 11238: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 11239: push(@{$seclists{$uname.':'.$udom}},$usec);
11240: }
1.609 raeburn 11241: if (ref($statushash) eq 'HASH') {
11242: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
11243: }
1.275 raeburn 11244: }
11245: }
11246: }
11247: }
1.290 albertel 11248: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 11249: if ((defined($cdom)) && (defined($cnum))) {
11250: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
11251: if ( defined($csettings{'internal.courseowner'}) ) {
11252: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 11253: next if ($owner eq '');
11254: my ($ownername,$ownerdom);
11255: if ($owner =~ /^([^:]+):([^:]+)$/) {
11256: $ownername = $1;
11257: $ownerdom = $2;
11258: } else {
11259: $ownername = $owner;
11260: $ownerdom = $cdom;
11261: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 11262: }
11263: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 11264: if (defined($userdata) &&
1.609 raeburn 11265: !exists($$userdata{$owner})) {
11266: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
11267: if (!grep(/^none$/,@{$seclists{$owner}})) {
11268: push(@{$seclists{$owner}},'none');
11269: }
11270: if (ref($statushash) eq 'HASH') {
11271: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 11272: }
1.290 albertel 11273: }
1.279 raeburn 11274: }
11275: }
11276: }
1.419 raeburn 11277: foreach my $user (keys(%seclists)) {
11278: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
11279: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
11280: }
1.275 raeburn 11281: }
11282: return;
11283: }
11284:
1.288 raeburn 11285: sub get_user_info {
11286: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 11287: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
11288: &plainname($uname,$udom,'lastname');
1.291 albertel 11289: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 11290: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 11291: my %idhash = &Apache::lonnet::idrget($udom,($uname));
11292: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 11293: return;
11294: }
1.275 raeburn 11295:
1.472 raeburn 11296: ###############################################
11297:
11298: =pod
11299:
11300: =item * &get_user_quota()
11301:
1.1134 raeburn 11302: Retrieves quota assigned for storage of user files.
11303: Default is to report quota for portfolio files.
1.472 raeburn 11304:
11305: Incoming parameters:
11306: 1. user's username
11307: 2. user's domain
1.1134 raeburn 11308: 3. quota name - portfolio, author, or course
1.1136 raeburn 11309: (if no quota name provided, defaults to portfolio).
1.1237 raeburn 11310: 4. crstype - official, unofficial, textbook, placement or community,
11311: if quota name is course
1.472 raeburn 11312:
11313: Returns:
1.1163 raeburn 11314: 1. Disk quota (in MB) assigned to student.
1.536 raeburn 11315: 2. (Optional) Type of setting: custom or default
11316: (individually assigned or default for user's
11317: institutional status).
11318: 3. (Optional) - User's institutional status (e.g., faculty, staff
11319: or student - types as defined in localenroll::inst_usertypes
11320: for user's domain, which determines default quota for user.
11321: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 11322:
11323: If a value has been stored in the user's environment,
1.536 raeburn 11324: it will return that, otherwise it returns the maximal default
1.1134 raeburn 11325: defined for the user's institutional status(es) in the domain.
1.472 raeburn 11326:
11327: =cut
11328:
11329: ###############################################
11330:
11331:
11332: sub get_user_quota {
1.1136 raeburn 11333: my ($uname,$udom,$quotaname,$crstype) = @_;
1.536 raeburn 11334: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 11335: if (!defined($udom)) {
11336: $udom = $env{'user.domain'};
11337: }
11338: if (!defined($uname)) {
11339: $uname = $env{'user.name'};
11340: }
11341: if (($udom eq '' || $uname eq '') ||
11342: ($udom eq 'public') && ($uname eq 'public')) {
11343: $quota = 0;
1.536 raeburn 11344: $quotatype = 'default';
11345: $defquota = 0;
1.472 raeburn 11346: } else {
1.536 raeburn 11347: my $inststatus;
1.1134 raeburn 11348: if ($quotaname eq 'course') {
11349: if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
11350: ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
11351: $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
11352: } else {
11353: my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
11354: $quota = $cenv{'internal.uploadquota'};
11355: }
1.536 raeburn 11356: } else {
1.1134 raeburn 11357: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
11358: if ($quotaname eq 'author') {
11359: $quota = $env{'environment.authorquota'};
11360: } else {
11361: $quota = $env{'environment.portfolioquota'};
11362: }
11363: $inststatus = $env{'environment.inststatus'};
11364: } else {
11365: my %userenv =
11366: &Apache::lonnet::get('environment',['portfolioquota',
11367: 'authorquota','inststatus'],$udom,$uname);
11368: my ($tmp) = keys(%userenv);
11369: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
11370: if ($quotaname eq 'author') {
11371: $quota = $userenv{'authorquota'};
11372: } else {
11373: $quota = $userenv{'portfolioquota'};
11374: }
11375: $inststatus = $userenv{'inststatus'};
11376: } else {
11377: undef(%userenv);
11378: }
11379: }
11380: }
11381: if ($quota eq '' || wantarray) {
11382: if ($quotaname eq 'course') {
11383: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165 raeburn 11384: if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
1.1237 raeburn 11385: ($crstype eq 'community') || ($crstype eq 'textbook') ||
11386: ($crstype eq 'placement')) {
1.1136 raeburn 11387: $defquota = $domdefs{$crstype.'quota'};
11388: }
11389: if ($defquota eq '') {
11390: $defquota = 500;
11391: }
1.1134 raeburn 11392: } else {
11393: ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
11394: }
11395: if ($quota eq '') {
11396: $quota = $defquota;
11397: $quotatype = 'default';
11398: } else {
11399: $quotatype = 'custom';
11400: }
1.472 raeburn 11401: }
11402: }
1.536 raeburn 11403: if (wantarray) {
11404: return ($quota,$quotatype,$settingstatus,$defquota);
11405: } else {
11406: return $quota;
11407: }
1.472 raeburn 11408: }
11409:
11410: ###############################################
11411:
11412: =pod
11413:
11414: =item * &default_quota()
11415:
1.536 raeburn 11416: Retrieves default quota assigned for storage of user portfolio files,
11417: given an (optional) user's institutional status.
1.472 raeburn 11418:
11419: Incoming parameters:
1.1142 raeburn 11420:
1.472 raeburn 11421: 1. domain
1.536 raeburn 11422: 2. (Optional) institutional status(es). This is a : separated list of
11423: status types (e.g., faculty, staff, student etc.)
11424: which apply to the user for whom the default is being retrieved.
11425: If the institutional status string in undefined, the domain
1.1134 raeburn 11426: default quota will be returned.
11427: 3. quota name - portfolio, author, or course
11428: (if no quota name provided, defaults to portfolio).
1.472 raeburn 11429:
11430: Returns:
1.1142 raeburn 11431:
1.1163 raeburn 11432: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536 raeburn 11433: 2. (Optional) institutional type which determined the value of the
11434: default quota.
1.472 raeburn 11435:
11436: If a value has been stored in the domain's configuration db,
11437: it will return that, otherwise it returns 20 (for backwards
11438: compatibility with domains which have not set up a configuration
1.1163 raeburn 11439: db file; the original statically defined portfolio quota was 20 MB).
1.472 raeburn 11440:
1.536 raeburn 11441: If the user's status includes multiple types (e.g., staff and student),
11442: the largest default quota which applies to the user determines the
11443: default quota returned.
11444:
1.472 raeburn 11445: =cut
11446:
11447: ###############################################
11448:
11449:
11450: sub default_quota {
1.1134 raeburn 11451: my ($udom,$inststatus,$quotaname) = @_;
1.536 raeburn 11452: my ($defquota,$settingstatus);
11453: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 11454: ['quotas'],$udom);
1.1134 raeburn 11455: my $key = 'defaultquota';
11456: if ($quotaname eq 'author') {
11457: $key = 'authorquota';
11458: }
1.622 raeburn 11459: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 11460: if ($inststatus ne '') {
1.765 raeburn 11461: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 11462: foreach my $item (@statuses) {
1.1134 raeburn 11463: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11464: if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711 raeburn 11465: if ($defquota eq '') {
1.1134 raeburn 11466: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11467: $settingstatus = $item;
1.1134 raeburn 11468: } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
11469: $defquota = $quotahash{'quotas'}{$key}{$item};
1.711 raeburn 11470: $settingstatus = $item;
11471: }
11472: }
1.1134 raeburn 11473: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11474: if ($quotahash{'quotas'}{$item} ne '') {
11475: if ($defquota eq '') {
11476: $defquota = $quotahash{'quotas'}{$item};
11477: $settingstatus = $item;
11478: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
11479: $defquota = $quotahash{'quotas'}{$item};
11480: $settingstatus = $item;
11481: }
1.536 raeburn 11482: }
11483: }
11484: }
11485: }
11486: if ($defquota eq '') {
1.1134 raeburn 11487: if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
11488: $defquota = $quotahash{'quotas'}{$key}{'default'};
11489: } elsif ($key eq 'defaultquota') {
1.711 raeburn 11490: $defquota = $quotahash{'quotas'}{'default'};
11491: }
1.536 raeburn 11492: $settingstatus = 'default';
1.1139 raeburn 11493: if ($defquota eq '') {
11494: if ($quotaname eq 'author') {
11495: $defquota = 500;
11496: }
11497: }
1.536 raeburn 11498: }
11499: } else {
11500: $settingstatus = 'default';
1.1134 raeburn 11501: if ($quotaname eq 'author') {
11502: $defquota = 500;
11503: } else {
11504: $defquota = 20;
11505: }
1.536 raeburn 11506: }
11507: if (wantarray) {
11508: return ($defquota,$settingstatus);
1.472 raeburn 11509: } else {
1.536 raeburn 11510: return $defquota;
1.472 raeburn 11511: }
11512: }
11513:
1.1135 raeburn 11514: ###############################################
11515:
11516: =pod
11517:
1.1136 raeburn 11518: =item * &excess_filesize_warning()
1.1135 raeburn 11519:
11520: Returns warning message if upload of file to authoring space, or copying
1.1136 raeburn 11521: of existing file within authoring space will cause quota for the authoring
1.1146 raeburn 11522: space to be exceeded.
1.1136 raeburn 11523:
11524: Same, if upload of a file directly to a course/community via Course Editor
1.1137 raeburn 11525: will cause quota for uploaded content for the course to be exceeded.
1.1135 raeburn 11526:
1.1165 raeburn 11527: Inputs: 7
1.1136 raeburn 11528: 1. username or coursenum
1.1135 raeburn 11529: 2. domain
1.1136 raeburn 11530: 3. context ('author' or 'course')
1.1135 raeburn 11531: 4. filename of file for which action is being requested
11532: 5. filesize (kB) of file
11533: 6. action being taken: copy or upload.
1.1237 raeburn 11534: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135 raeburn 11535:
11536: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142 raeburn 11537: otherwise return null.
11538:
11539: =back
1.1135 raeburn 11540:
11541: =cut
11542:
1.1136 raeburn 11543: sub excess_filesize_warning {
1.1165 raeburn 11544: my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136 raeburn 11545: my $current_disk_usage = 0;
1.1165 raeburn 11546: my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136 raeburn 11547: if ($context eq 'author') {
11548: my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
11549: $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
11550: } else {
11551: foreach my $subdir ('docs','supplemental') {
11552: $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
11553: }
11554: }
1.1135 raeburn 11555: $disk_quota = int($disk_quota * 1000);
11556: if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179 bisitz 11557: return '<p class="LC_warning">'.
1.1135 raeburn 11558: &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179 bisitz 11559: '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
11560: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135 raeburn 11561: $disk_quota,$current_disk_usage).
11562: '</p>';
11563: }
11564: return;
11565: }
11566:
11567: ###############################################
11568:
11569:
1.1136 raeburn 11570:
11571:
1.384 raeburn 11572: sub get_secgrprole_info {
11573: my ($cdom,$cnum,$needroles,$type) = @_;
11574: my %sections_count = &get_sections($cdom,$cnum);
11575: my @sections = (sort {$a <=> $b} keys(%sections_count));
11576: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
11577: my @groups = sort(keys(%curr_groups));
11578: my $allroles = [];
11579: my $rolehash;
11580: my $accesshash = {
11581: active => 'Currently has access',
11582: future => 'Will have future access',
11583: previous => 'Previously had access',
11584: };
11585: if ($needroles) {
11586: $rolehash = {'all' => 'all'};
1.385 albertel 11587: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
11588: if (&Apache::lonnet::error(%user_roles)) {
11589: undef(%user_roles);
11590: }
11591: foreach my $item (keys(%user_roles)) {
1.384 raeburn 11592: my ($role)=split(/\:/,$item,2);
11593: if ($role eq 'cr') { next; }
11594: if ($role =~ /^cr/) {
11595: $$rolehash{$role} = (split('/',$role))[3];
11596: } else {
11597: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
11598: }
11599: }
11600: foreach my $key (sort(keys(%{$rolehash}))) {
11601: push(@{$allroles},$key);
11602: }
11603: push (@{$allroles},'st');
11604: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
11605: }
11606: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
11607: }
11608:
1.555 raeburn 11609: sub user_picker {
1.1279 raeburn 11610: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555 raeburn 11611: my $currdom = $dom;
1.1253 raeburn 11612: my @alldoms = &Apache::lonnet::all_domains();
11613: if (@alldoms == 1) {
11614: my %domsrch = &Apache::lonnet::get_dom('configuration',
11615: ['directorysrch'],$alldoms[0]);
11616: my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
11617: my $showdom = $domdesc;
11618: if ($showdom eq '') {
11619: $showdom = $dom;
11620: }
11621: if (ref($domsrch{'directorysrch'}) eq 'HASH') {
11622: if ((!$domsrch{'directorysrch'}{'available'}) &&
11623: ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
11624: return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
11625: }
11626: }
11627: }
1.555 raeburn 11628: my %curr_selected = (
11629: srchin => 'dom',
1.580 raeburn 11630: srchby => 'lastname',
1.555 raeburn 11631: );
11632: my $srchterm;
1.625 raeburn 11633: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 11634: if ($srch->{'srchby'} ne '') {
11635: $curr_selected{'srchby'} = $srch->{'srchby'};
11636: }
11637: if ($srch->{'srchin'} ne '') {
11638: $curr_selected{'srchin'} = $srch->{'srchin'};
11639: }
11640: if ($srch->{'srchtype'} ne '') {
11641: $curr_selected{'srchtype'} = $srch->{'srchtype'};
11642: }
11643: if ($srch->{'srchdomain'} ne '') {
11644: $currdom = $srch->{'srchdomain'};
11645: }
11646: $srchterm = $srch->{'srchterm'};
11647: }
1.1222 damieng 11648: my %html_lt=&Apache::lonlocal::texthash(
1.573 raeburn 11649: 'usr' => 'Search criteria',
1.563 raeburn 11650: 'doma' => 'Domain/institution to search',
1.558 albertel 11651: 'uname' => 'username',
11652: 'lastname' => 'last name',
1.555 raeburn 11653: 'lastfirst' => 'last name, first name',
1.558 albertel 11654: 'crs' => 'in this course',
1.576 raeburn 11655: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 11656: 'alc' => 'all LON-CAPA',
1.573 raeburn 11657: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 11658: 'exact' => 'is',
11659: 'contains' => 'contains',
1.569 raeburn 11660: 'begins' => 'begins with',
1.1222 damieng 11661: );
11662: my %js_lt=&Apache::lonlocal::texthash(
1.571 raeburn 11663: 'youm' => "You must include some text to search for.",
11664: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
11665: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
11666: 'yomc' => "You must choose a domain when using an institutional directory search.",
11667: 'ymcd' => "You must choose a domain when using a domain search.",
11668: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
11669: 'whse' => "When searching by last,first you must include at least one character in the first name.",
11670: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 11671: );
1.1222 damieng 11672: &html_escape(\%html_lt);
11673: &js_escape(\%js_lt);
1.1255 raeburn 11674: my $domform;
1.1277 raeburn 11675: my $allow_blank = 1;
1.1255 raeburn 11676: if ($fixeddom) {
1.1277 raeburn 11677: $allow_blank = 0;
11678: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255 raeburn 11679: } else {
1.1287 raeburn 11680: my $defdom = $env{'request.role.domain'};
1.1288 raeburn 11681: my ($trusted,$untrusted);
1.1287 raeburn 11682: if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288 raeburn 11683: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287 raeburn 11684: } elsif ($context eq 'author') {
1.1288 raeburn 11685: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287 raeburn 11686: } elsif ($context eq 'domain') {
1.1288 raeburn 11687: ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287 raeburn 11688: }
1.1288 raeburn 11689: $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255 raeburn 11690: }
1.563 raeburn 11691: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 11692:
11693: my @srchins = ('crs','dom','alc','instd');
11694:
11695: foreach my $option (@srchins) {
11696: # FIXME 'alc' option unavailable until
11697: # loncreateuser::print_user_query_page()
11698: # has been completed.
11699: next if ($option eq 'alc');
1.880 raeburn 11700: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));
1.555 raeburn 11701: next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279 raeburn 11702: next if (($option eq 'instd') && ($noinstd));
1.563 raeburn 11703: if ($curr_selected{'srchin'} eq $option) {
11704: $srchinsel .= '
1.1222 damieng 11705: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563 raeburn 11706: } else {
11707: $srchinsel .= '
1.1222 damieng 11708: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563 raeburn 11709: }
1.555 raeburn 11710: }
1.563 raeburn 11711: $srchinsel .= "\n </select>\n";
1.555 raeburn 11712:
11713: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 11714: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 11715: if ($curr_selected{'srchby'} eq $option) {
11716: $srchbysel .= '
1.1222 damieng 11717: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11718: } else {
11719: $srchbysel .= '
1.1222 damieng 11720: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11721: }
11722: }
11723: $srchbysel .= "\n </select>\n";
11724:
11725: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 11726: foreach my $option ('begins','contains','exact') {
1.555 raeburn 11727: if ($curr_selected{'srchtype'} eq $option) {
11728: $srchtypesel .= '
1.1222 damieng 11729: <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555 raeburn 11730: } else {
11731: $srchtypesel .= '
1.1222 damieng 11732: <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555 raeburn 11733: }
11734: }
11735: $srchtypesel .= "\n </select>\n";
11736:
1.558 albertel 11737: my ($newuserscript,$new_user_create);
1.994 raeburn 11738: my $context_dom = $env{'request.role.domain'};
11739: if ($context eq 'requestcrs') {
11740: if ($env{'form.coursedom'} ne '') {
11741: $context_dom = $env{'form.coursedom'};
11742: }
11743: }
1.556 raeburn 11744: if ($forcenewuser) {
1.576 raeburn 11745: if (ref($srch) eq 'HASH') {
1.994 raeburn 11746: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627 raeburn 11747: if ($cancreate) {
11748: $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>';
11749: } else {
1.799 bisitz 11750: my $helplink = 'javascript:helpMenu('."'display'".')';
1.627 raeburn 11751: my %usertypetext = (
11752: official => 'institutional',
11753: unofficial => 'non-institutional',
11754: );
1.799 bisitz 11755: $new_user_create = '<p class="LC_warning">'
11756: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
11757: .' '
11758: .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
11759: ,'<a href="'.$helplink.'">','</a>')
11760: .'</p><br />';
1.627 raeburn 11761: }
1.576 raeburn 11762: }
11763: }
11764:
1.556 raeburn 11765: $newuserscript = <<"ENDSCRIPT";
11766:
1.570 raeburn 11767: function setSearch(createnew,callingForm) {
1.556 raeburn 11768: if (createnew == 1) {
1.570 raeburn 11769: for (var i=0; i<callingForm.srchby.length; i++) {
11770: if (callingForm.srchby.options[i].value == 'uname') {
11771: callingForm.srchby.selectedIndex = i;
1.556 raeburn 11772: }
11773: }
1.570 raeburn 11774: for (var i=0; i<callingForm.srchin.length; i++) {
11775: if ( callingForm.srchin.options[i].value == 'dom') {
11776: callingForm.srchin.selectedIndex = i;
1.556 raeburn 11777: }
11778: }
1.570 raeburn 11779: for (var i=0; i<callingForm.srchtype.length; i++) {
11780: if (callingForm.srchtype.options[i].value == 'exact') {
11781: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 11782: }
11783: }
1.570 raeburn 11784: for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994 raeburn 11785: if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570 raeburn 11786: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 11787: }
11788: }
11789: }
11790: }
11791: ENDSCRIPT
1.558 albertel 11792:
1.556 raeburn 11793: }
11794:
1.555 raeburn 11795: my $output = <<"END_BLOCK";
1.556 raeburn 11796: <script type="text/javascript">
1.824 bisitz 11797: // <![CDATA[
1.570 raeburn 11798: function validateEntry(callingForm) {
1.558 albertel 11799:
1.556 raeburn 11800: var checkok = 1;
1.558 albertel 11801: var srchin;
1.570 raeburn 11802: for (var i=0; i<callingForm.srchin.length; i++) {
11803: if ( callingForm.srchin[i].checked ) {
11804: srchin = callingForm.srchin[i].value;
1.558 albertel 11805: }
11806: }
11807:
1.570 raeburn 11808: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
11809: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
11810: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
11811: var srchterm = callingForm.srchterm.value;
11812: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 11813: var msg = "";
11814:
11815: if (srchterm == "") {
11816: checkok = 0;
1.1222 damieng 11817: msg += "$js_lt{'youm'}\\n";
1.556 raeburn 11818: }
11819:
1.569 raeburn 11820: if (srchtype== 'begins') {
11821: if (srchterm.length < 2) {
11822: checkok = 0;
1.1222 damieng 11823: msg += "$js_lt{'thte'}\\n";
1.569 raeburn 11824: }
11825: }
11826:
1.556 raeburn 11827: if (srchtype== 'contains') {
11828: if (srchterm.length < 3) {
11829: checkok = 0;
1.1222 damieng 11830: msg += "$js_lt{'thet'}\\n";
1.556 raeburn 11831: }
11832: }
11833: if (srchin == 'instd') {
11834: if (srchdomain == '') {
11835: checkok = 0;
1.1222 damieng 11836: msg += "$js_lt{'yomc'}\\n";
1.556 raeburn 11837: }
11838: }
11839: if (srchin == 'dom') {
11840: if (srchdomain == '') {
11841: checkok = 0;
1.1222 damieng 11842: msg += "$js_lt{'ymcd'}\\n";
1.556 raeburn 11843: }
11844: }
11845: if (srchby == 'lastfirst') {
11846: if (srchterm.indexOf(",") == -1) {
11847: checkok = 0;
1.1222 damieng 11848: msg += "$js_lt{'whus'}\\n";
1.556 raeburn 11849: }
11850: if (srchterm.indexOf(",") == srchterm.length -1) {
11851: checkok = 0;
1.1222 damieng 11852: msg += "$js_lt{'whse'}\\n";
1.556 raeburn 11853: }
11854: }
11855: if (checkok == 0) {
1.1222 damieng 11856: alert("$js_lt{'thfo'}\\n"+msg);
1.556 raeburn 11857: return;
11858: }
11859: if (checkok == 1) {
1.570 raeburn 11860: callingForm.submit();
1.556 raeburn 11861: }
11862: }
11863:
11864: $newuserscript
11865:
1.824 bisitz 11866: // ]]>
1.556 raeburn 11867: </script>
1.558 albertel 11868:
11869: $new_user_create
11870:
1.555 raeburn 11871: END_BLOCK
1.558 albertel 11872:
1.876 raeburn 11873: $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222 damieng 11874: &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876 raeburn 11875: $domform.
11876: &Apache::lonhtmlcommon::row_closure().
1.1222 damieng 11877: &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876 raeburn 11878: $srchbysel.
11879: $srchtypesel.
11880: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
11881: $srchinsel.
11882: &Apache::lonhtmlcommon::row_closure(1).
11883: &Apache::lonhtmlcommon::end_pick_box().
11884: '<br />';
1.1253 raeburn 11885: return ($output,1);
1.555 raeburn 11886: }
11887:
1.612 raeburn 11888: sub user_rule_check {
1.615 raeburn 11889: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226 raeburn 11890: my ($response,%inst_response);
1.612 raeburn 11891: if (ref($usershash) eq 'HASH') {
1.1226 raeburn 11892: if (keys(%{$usershash}) > 1) {
11893: my (%by_username,%by_id,%userdoms);
11894: my $checkid;
11895: if (ref($checks) eq 'HASH') {
11896: if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
11897: $checkid = 1;
11898: }
11899: }
11900: foreach my $user (keys(%{$usershash})) {
11901: my ($uname,$udom) = split(/:/,$user);
11902: if ($checkid) {
11903: if (ref($usershash->{$user}) eq 'HASH') {
11904: if ($usershash->{$user}->{'id'} ne '') {
1.1227 raeburn 11905: $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
1.1226 raeburn 11906: $userdoms{$udom} = 1;
1.1227 raeburn 11907: if (ref($inst_results) eq 'HASH') {
11908: $inst_results->{$uname.':'.$udom} = {};
11909: }
1.1226 raeburn 11910: }
11911: }
11912: } else {
11913: $by_username{$udom}{$uname} = 1;
11914: $userdoms{$udom} = 1;
1.1227 raeburn 11915: if (ref($inst_results) eq 'HASH') {
11916: $inst_results->{$uname.':'.$udom} = {};
11917: }
1.1226 raeburn 11918: }
11919: }
11920: foreach my $udom (keys(%userdoms)) {
11921: if (!$got_rules->{$udom}) {
11922: my %domconfig = &Apache::lonnet::get_dom('configuration',
11923: ['usercreation'],$udom);
11924: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11925: foreach my $item ('username','id') {
11926: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227 raeburn 11927: $$curr_rules{$udom}{$item} =
11928: $domconfig{'usercreation'}{$item.'_rule'};
1.1226 raeburn 11929: }
11930: }
11931: }
11932: $got_rules->{$udom} = 1;
11933: }
1.612 raeburn 11934: }
1.1226 raeburn 11935: if ($checkid) {
11936: foreach my $udom (keys(%by_id)) {
11937: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
11938: if ($outcome eq 'ok') {
1.1227 raeburn 11939: foreach my $id (keys(%{$by_id{$udom}})) {
11940: my $uname = $by_id{$udom}{$id};
11941: $inst_response{$uname.':'.$udom} = $outcome;
11942: }
1.1226 raeburn 11943: if (ref($results) eq 'HASH') {
11944: foreach my $uname (keys(%{$results})) {
1.1227 raeburn 11945: if (exists($inst_response{$uname.':'.$udom})) {
11946: $inst_response{$uname.':'.$udom} = $outcome;
11947: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11948: }
1.1226 raeburn 11949: }
11950: }
11951: }
1.612 raeburn 11952: }
1.615 raeburn 11953: } else {
1.1226 raeburn 11954: foreach my $udom (keys(%by_username)) {
11955: my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
11956: if ($outcome eq 'ok') {
1.1227 raeburn 11957: foreach my $uname (keys(%{$by_username{$udom}})) {
11958: $inst_response{$uname.':'.$udom} = $outcome;
11959: }
1.1226 raeburn 11960: if (ref($results) eq 'HASH') {
11961: foreach my $uname (keys(%{$results})) {
11962: $inst_results->{$uname.':'.$udom} = $results->{$uname};
11963: }
11964: }
11965: }
11966: }
1.612 raeburn 11967: }
1.1226 raeburn 11968: } elsif (keys(%{$usershash}) == 1) {
11969: my $user = (keys(%{$usershash}))[0];
11970: my ($uname,$udom) = split(/:/,$user);
11971: if (($udom ne '') && ($uname ne '')) {
11972: if (ref($usershash->{$user}) eq 'HASH') {
11973: if (ref($checks) eq 'HASH') {
11974: if (defined($checks->{'username'})) {
11975: ($inst_response{$user},%{$inst_results->{$user}}) =
11976: &Apache::lonnet::get_instuser($udom,$uname);
11977: } elsif (defined($checks->{'id'})) {
11978: if ($usershash->{$user}->{'id'} ne '') {
11979: ($inst_response{$user},%{$inst_results->{$user}}) =
11980: &Apache::lonnet::get_instuser($udom,undef,
11981: $usershash->{$user}->{'id'});
11982: } else {
11983: ($inst_response{$user},%{$inst_results->{$user}}) =
11984: &Apache::lonnet::get_instuser($udom,$uname);
11985: }
1.585 raeburn 11986: }
1.1226 raeburn 11987: } else {
11988: ($inst_response{$user},%{$inst_results->{$user}}) =
11989: &Apache::lonnet::get_instuser($udom,$uname);
11990: return;
11991: }
11992: if (!$got_rules->{$udom}) {
11993: my %domconfig = &Apache::lonnet::get_dom('configuration',
11994: ['usercreation'],$udom);
11995: if (ref($domconfig{'usercreation'}) eq 'HASH') {
11996: foreach my $item ('username','id') {
11997: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
11998: $$curr_rules{$udom}{$item} =
11999: $domconfig{'usercreation'}{$item.'_rule'};
12000: }
12001: }
12002: }
12003: $got_rules->{$udom} = 1;
1.585 raeburn 12004: }
12005: }
1.1226 raeburn 12006: } else {
12007: return;
12008: }
12009: } else {
12010: return;
12011: }
12012: foreach my $user (keys(%{$usershash})) {
12013: my ($uname,$udom) = split(/:/,$user);
12014: next if (($udom eq '') || ($uname eq ''));
12015: my $id;
1.1227 raeburn 12016: if (ref($inst_results) eq 'HASH') {
12017: if (ref($inst_results->{$user}) eq 'HASH') {
12018: $id = $inst_results->{$user}->{'id'};
12019: }
12020: }
12021: if ($id eq '') {
12022: if (ref($usershash->{$user})) {
12023: $id = $usershash->{$user}->{'id'};
12024: }
1.585 raeburn 12025: }
1.612 raeburn 12026: foreach my $item (keys(%{$checks})) {
12027: if (ref($$curr_rules{$udom}) eq 'HASH') {
12028: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
12029: if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226 raeburn 12030: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
12031: $$curr_rules{$udom}{$item});
1.612 raeburn 12032: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
12033: if ($rule_check{$rule}) {
12034: $$rulematch{$user}{$item} = $rule;
1.1226 raeburn 12035: if ($inst_response{$user} eq 'ok') {
1.615 raeburn 12036: if (ref($inst_results) eq 'HASH') {
12037: if (ref($inst_results->{$user}) eq 'HASH') {
12038: if (keys(%{$inst_results->{$user}}) == 0) {
12039: $$alerts{$item}{$udom}{$uname} = 1;
1.1227 raeburn 12040: } elsif ($item eq 'id') {
12041: if ($inst_results->{$user}->{'id'} eq '') {
12042: $$alerts{$item}{$udom}{$uname} = 1;
12043: }
1.615 raeburn 12044: }
1.612 raeburn 12045: }
12046: }
1.615 raeburn 12047: }
12048: last;
1.585 raeburn 12049: }
12050: }
12051: }
12052: }
12053: }
12054: }
12055: }
12056: }
1.612 raeburn 12057: return;
12058: }
12059:
12060: sub user_rule_formats {
12061: my ($domain,$domdesc,$curr_rules,$check) = @_;
12062: my %text = (
12063: 'username' => 'Usernames',
12064: 'id' => 'IDs',
12065: );
12066: my $output;
12067: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
12068: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
12069: if (@{$ruleorder} > 0) {
1.1102 raeburn 12070: $output = '<br />'.
12071: &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
12072: '<span class="LC_cusr_emph">','</span>',$domdesc).
12073: ' <ul>';
1.612 raeburn 12074: foreach my $rule (@{$ruleorder}) {
12075: if (ref($curr_rules) eq 'ARRAY') {
12076: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
12077: if (ref($rules->{$rule}) eq 'HASH') {
12078: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
12079: $rules->{$rule}{'desc'}.'</li>';
12080: }
12081: }
12082: }
12083: }
12084: $output .= '</ul>';
12085: }
12086: }
12087: return $output;
12088: }
12089:
12090: sub instrule_disallow_msg {
1.615 raeburn 12091: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 12092: my $response;
12093: my %text = (
12094: item => 'username',
12095: items => 'usernames',
12096: match => 'matches',
12097: do => 'does',
12098: action => 'a username',
12099: one => 'one',
12100: );
12101: if ($count > 1) {
12102: $text{'item'} = 'usernames';
12103: $text{'match'} ='match';
12104: $text{'do'} = 'do';
12105: $text{'action'} = 'usernames',
12106: $text{'one'} = 'ones';
12107: }
12108: if ($checkitem eq 'id') {
12109: $text{'items'} = 'IDs';
12110: $text{'item'} = 'ID';
12111: $text{'action'} = 'an ID';
1.615 raeburn 12112: if ($count > 1) {
12113: $text{'item'} = 'IDs';
12114: $text{'action'} = 'IDs';
12115: }
1.612 raeburn 12116: }
1.674 bisitz 12117: $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 12118: if ($mode eq 'upload') {
12119: if ($checkitem eq 'username') {
12120: $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'}.");
12121: } elsif ($checkitem eq 'id') {
1.674 bisitz 12122: $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 12123: }
1.669 raeburn 12124: } elsif ($mode eq 'selfcreate') {
12125: if ($checkitem eq 'id') {
12126: $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.");
12127: }
1.615 raeburn 12128: } else {
12129: if ($checkitem eq 'username') {
12130: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
12131: } elsif ($checkitem eq 'id') {
12132: $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.");
12133: }
1.612 raeburn 12134: }
12135: return $response;
1.585 raeburn 12136: }
12137:
1.624 raeburn 12138: sub personal_data_fieldtitles {
12139: my %fieldtitles = &Apache::lonlocal::texthash (
12140: id => 'Student/Employee ID',
12141: permanentemail => 'E-mail address',
12142: lastname => 'Last Name',
12143: firstname => 'First Name',
12144: middlename => 'Middle Name',
12145: generation => 'Generation',
12146: gen => 'Generation',
1.765 raeburn 12147: inststatus => 'Affiliation',
1.624 raeburn 12148: );
12149: return %fieldtitles;
12150: }
12151:
1.642 raeburn 12152: sub sorted_inst_types {
12153: my ($dom) = @_;
1.1185 raeburn 12154: my ($usertypes,$order);
12155: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
12156: if (ref($domdefaults{'inststatus'}) eq 'HASH') {
12157: $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
12158: $order = $domdefaults{'inststatus'}{'inststatusorder'};
12159: } else {
12160: ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
12161: }
1.642 raeburn 12162: my $othertitle = &mt('All users');
12163: if ($env{'request.course.id'}) {
1.668 raeburn 12164: $othertitle = &mt('Any users');
1.642 raeburn 12165: }
12166: my @types;
12167: if (ref($order) eq 'ARRAY') {
12168: @types = @{$order};
12169: }
12170: if (@types == 0) {
12171: if (ref($usertypes) eq 'HASH') {
12172: @types = sort(keys(%{$usertypes}));
12173: }
12174: }
12175: if (keys(%{$usertypes}) > 0) {
12176: $othertitle = &mt('Other users');
12177: }
12178: return ($othertitle,$usertypes,\@types);
12179: }
12180:
1.645 raeburn 12181: sub get_institutional_codes {
1.1361 raeburn 12182: my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645 raeburn 12183: # Get complete list of course sections to update
12184: my @currsections = ();
12185: my @currxlists = ();
1.1361 raeburn 12186: my (%unclutteredsec,%unclutteredlcsec);
1.645 raeburn 12187: my $coursecode = $$settings{'internal.coursecode'};
1.1361 raeburn 12188: my $crskey = $crs.':'.$coursecode;
12189: @{$unclutteredsec{$crskey}} = ();
12190: @{$unclutteredlcsec{$crskey}} = ();
1.645 raeburn 12191:
12192: if ($$settings{'internal.sectionnums'} ne '') {
12193: @currsections = split(/,/,$$settings{'internal.sectionnums'});
12194: }
12195:
12196: if ($$settings{'internal.crosslistings'} ne '') {
12197: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
12198: }
12199:
12200: if (@currxlists > 0) {
1.1361 raeburn 12201: foreach my $xl (@currxlists) {
12202: if ($xl =~ /^([^:]+):(\w*)$/) {
1.645 raeburn 12203: unless (grep/^$1$/,@{$allcourses}) {
1.1263 raeburn 12204: push(@{$allcourses},$1);
1.645 raeburn 12205: $$LC_code{$1} = $2;
12206: }
12207: }
12208: }
12209: }
1.1361 raeburn 12210:
1.645 raeburn 12211: if (@currsections > 0) {
1.1361 raeburn 12212: foreach my $sec (@currsections) {
12213: if ($sec =~ m/^(\w+):(\w*)$/ ) {
12214: my $instsec = $1;
1.645 raeburn 12215: my $lc_sec = $2;
1.1361 raeburn 12216: unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
12217: push(@{$unclutteredsec{$crskey}},$instsec);
12218: push(@{$unclutteredlcsec{$crskey}},$lc_sec);
12219: }
12220: }
12221: }
12222: }
12223:
12224: if (@{$unclutteredsec{$crskey}} > 0) {
12225: my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
12226: if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
12227: for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
12228: my $sec = $coursecode.$formattedsec{$crskey}[$i];
12229: unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263 raeburn 12230: push(@{$allcourses},$sec);
1.1361 raeburn 12231: $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645 raeburn 12232: }
12233: }
12234: }
12235: }
12236: return;
12237: }
12238:
1.971 raeburn 12239: sub get_standard_codeitems {
12240: return ('Year','Semester','Department','Number','Section');
12241: }
12242:
1.112 bowersj2 12243: =pod
12244:
1.780 raeburn 12245: =head1 Slot Helpers
12246:
12247: =over 4
12248:
12249: =item * sorted_slots()
12250:
1.1040 raeburn 12251: Sorts an array of slot names in order of an optional sort key,
12252: default sort is by slot start time (earliest first).
1.780 raeburn 12253:
12254: Inputs:
12255:
12256: =over 4
12257:
12258: slotsarr - Reference to array of unsorted slot names.
12259:
12260: slots - Reference to hash of hash, where outer hash keys are slot names.
12261:
1.1040 raeburn 12262: sortkey - Name of key in inner hash to be sorted on (e.g., starttime).
12263:
1.549 albertel 12264: =back
12265:
1.780 raeburn 12266: Returns:
12267:
12268: =over 4
12269:
1.1040 raeburn 12270: sorted - An array of slot names sorted by a specified sort key
12271: (default sort key is start time of the slot).
1.780 raeburn 12272:
12273: =back
12274:
12275: =cut
12276:
12277:
12278: sub sorted_slots {
1.1040 raeburn 12279: my ($slotsarr,$slots,$sortkey) = @_;
12280: if ($sortkey eq '') {
12281: $sortkey = 'starttime';
12282: }
1.780 raeburn 12283: my @sorted;
12284: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
12285: @sorted =
12286: sort {
12287: if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040 raeburn 12288: return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780 raeburn 12289: }
12290: if (ref($slots->{$a})) { return -1;}
12291: if (ref($slots->{$b})) { return 1;}
12292: return 0;
12293: } @{$slotsarr};
12294: }
12295: return @sorted;
12296: }
12297:
1.1040 raeburn 12298: =pod
12299:
12300: =item * get_future_slots()
12301:
12302: Inputs:
12303:
12304: =over 4
12305:
12306: cnum - course number
12307:
12308: cdom - course domain
12309:
12310: now - current UNIX time
12311:
12312: symb - optional symb
12313:
12314: =back
12315:
12316: Returns:
12317:
12318: =over 4
12319:
12320: sorted_reservable - ref to array of student_schedulable slots currently
12321: reservable, ordered by end date of reservation period.
12322:
12323: reservable_now - ref to hash of student_schedulable slots currently
12324: reservable.
12325:
12326: Keys in inner hash are:
12327: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12328: (b) endreserve: end date of reservation period.
12329: (c) uniqueperiod: start,end dates when slot is to be uniquely
12330: selected.
1.1040 raeburn 12331:
12332: sorted_future - ref to array of student_schedulable slots reservable in
12333: the future, ordered by start date of reservation period.
12334:
12335: future_reservable - ref to hash of student_schedulable slots reservable
12336: in the future.
12337:
12338: Keys in inner hash are:
12339: (a) symb: either blank or symb to which slot use is restricted.
1.1250 raeburn 12340: (b) startreserve: start date of reservation period.
12341: (c) uniqueperiod: start,end dates when slot is to be uniquely
12342: selected.
1.1040 raeburn 12343:
12344: =back
12345:
12346: =cut
12347:
12348: sub get_future_slots {
12349: my ($cnum,$cdom,$now,$symb) = @_;
1.1229 raeburn 12350: my $map;
12351: if ($symb) {
12352: ($map) = &Apache::lonnet::decode_symb($symb);
12353: }
1.1040 raeburn 12354: my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
12355: my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
12356: foreach my $slot (keys(%slots)) {
12357: next unless($slots{$slot}->{'type'} eq 'schedulable_student');
12358: if ($symb) {
1.1229 raeburn 12359: if ($slots{$slot}->{'symb'} ne '') {
12360: my $canuse;
12361: my %oksymbs;
12362: my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
12363: map { $oksymbs{$_} = 1; } @slotsymbs;
12364: if ($oksymbs{$symb}) {
12365: $canuse = 1;
12366: } else {
12367: foreach my $item (@slotsymbs) {
12368: if ($item =~ /\.(page|sequence)$/) {
12369: (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
12370: if (($map ne '') && ($map eq $sloturl)) {
12371: $canuse = 1;
12372: last;
12373: }
12374: }
12375: }
12376: }
12377: next unless ($canuse);
12378: }
1.1040 raeburn 12379: }
12380: if (($slots{$slot}->{'starttime'} > $now) &&
12381: ($slots{$slot}->{'endtime'} > $now)) {
12382: if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
12383: my $userallowed = 0;
12384: if ($slots{$slot}->{'allowedsections'}) {
12385: my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
12386: if (!defined($env{'request.role.sec'})
12387: && grep(/^No section assigned$/,@allowed_sec)) {
12388: $userallowed=1;
12389: } else {
12390: if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
12391: $userallowed=1;
12392: }
12393: }
12394: unless ($userallowed) {
12395: if (defined($env{'request.course.groups'})) {
12396: my @groups = split(/:/,$env{'request.course.groups'});
12397: foreach my $group (@groups) {
12398: if (grep(/^\Q$group\E$/,@allowed_sec)) {
12399: $userallowed=1;
12400: last;
12401: }
12402: }
12403: }
12404: }
12405: }
12406: if ($slots{$slot}->{'allowedusers'}) {
12407: my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
12408: my $user = $env{'user.name'}.':'.$env{'user.domain'};
12409: if (grep(/^\Q$user\E$/,@allowed_users)) {
12410: $userallowed = 1;
12411: }
12412: }
12413: next unless($userallowed);
12414: }
12415: my $startreserve = $slots{$slot}->{'startreserve'};
12416: my $endreserve = $slots{$slot}->{'endreserve'};
12417: my $symb = $slots{$slot}->{'symb'};
1.1250 raeburn 12418: my $uniqueperiod;
12419: if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
12420: $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
12421: }
1.1040 raeburn 12422: if (($startreserve < $now) &&
12423: (!$endreserve || $endreserve > $now)) {
12424: my $lastres = $endreserve;
12425: if (!$lastres) {
12426: $lastres = $slots{$slot}->{'starttime'};
12427: }
12428: $reservable_now{$slot} = {
12429: symb => $symb,
1.1250 raeburn 12430: endreserve => $lastres,
12431: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12432: };
12433: } elsif (($startreserve > $now) &&
12434: (!$endreserve || $endreserve > $startreserve)) {
12435: $future_reservable{$slot} = {
12436: symb => $symb,
1.1250 raeburn 12437: startreserve => $startreserve,
12438: uniqueperiod => $uniqueperiod,
1.1040 raeburn 12439: };
12440: }
12441: }
12442: }
12443: my @unsorted_reservable = keys(%reservable_now);
12444: if (@unsorted_reservable > 0) {
12445: @sorted_reservable =
12446: &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
12447: }
12448: my @unsorted_future = keys(%future_reservable);
12449: if (@unsorted_future > 0) {
12450: @sorted_future =
12451: &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
12452: }
12453: return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
12454: }
1.780 raeburn 12455:
12456: =pod
12457:
1.1057 foxr 12458: =back
12459:
1.549 albertel 12460: =head1 HTTP Helpers
12461:
12462: =over 4
12463:
1.648 raeburn 12464: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 12465:
1.258 albertel 12466: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 12467: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 12468: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 12469:
12470: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
12471: $possible_names is an ref to an array of form element names. As an example:
12472: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 12473: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 12474:
12475: =cut
1.1 albertel 12476:
1.6 albertel 12477: sub get_unprocessed_cgi {
1.25 albertel 12478: my ($query,$possible_names)= @_;
1.26 matthew 12479: # $Apache::lonxml::debug=1;
1.356 albertel 12480: foreach my $pair (split(/&/,$query)) {
12481: my ($name, $value) = split(/=/,$pair);
1.369 www 12482: $name = &unescape($name);
1.25 albertel 12483: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
12484: $value =~ tr/+/ /;
12485: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 12486: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 12487: }
1.16 harris41 12488: }
1.6 albertel 12489: }
12490:
1.112 bowersj2 12491: =pod
12492:
1.648 raeburn 12493: =item * &cacheheader()
1.112 bowersj2 12494:
12495: returns cache-controlling header code
12496:
12497: =cut
12498:
1.7 albertel 12499: sub cacheheader {
1.258 albertel 12500: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 12501: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
12502: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 12503: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
12504: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 12505: return $output;
1.7 albertel 12506: }
12507:
1.112 bowersj2 12508: =pod
12509:
1.648 raeburn 12510: =item * &no_cache($r)
1.112 bowersj2 12511:
12512: specifies header code to not have cache
12513:
12514: =cut
12515:
1.9 albertel 12516: sub no_cache {
1.216 albertel 12517: my ($r) = @_;
12518: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 12519: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 12520: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
12521: $r->no_cache(1);
12522: $r->header_out("Expires" => $date);
12523: $r->header_out("Pragma" => "no-cache");
1.123 www 12524: }
12525:
12526: sub content_type {
1.181 albertel 12527: my ($r,$type,$charset) = @_;
1.299 foxr 12528: if ($r) {
12529: # Note that printout.pl calls this with undef for $r.
12530: &no_cache($r);
12531: }
1.258 albertel 12532: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 12533: unless ($charset) {
12534: $charset=&Apache::lonlocal::current_encoding;
12535: }
12536: if ($charset) { $type.='; charset='.$charset; }
12537: if ($r) {
12538: $r->content_type($type);
12539: } else {
12540: print("Content-type: $type\n\n");
12541: }
1.9 albertel 12542: }
1.25 albertel 12543:
1.112 bowersj2 12544: =pod
12545:
1.648 raeburn 12546: =item * &add_to_env($name,$value)
1.112 bowersj2 12547:
1.258 albertel 12548: adds $name to the %env hash with value
1.112 bowersj2 12549: $value, if $name already exists, the entry is converted to an array
12550: reference and $value is added to the array.
12551:
12552: =cut
12553:
1.25 albertel 12554: sub add_to_env {
12555: my ($name,$value)=@_;
1.258 albertel 12556: if (defined($env{$name})) {
12557: if (ref($env{$name})) {
1.25 albertel 12558: #already have multiple values
1.258 albertel 12559: push(@{ $env{$name} },$value);
1.25 albertel 12560: } else {
12561: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 12562: my $first=$env{$name};
12563: undef($env{$name});
12564: push(@{ $env{$name} },$first,$value);
1.25 albertel 12565: }
12566: } else {
1.258 albertel 12567: $env{$name}=$value;
1.25 albertel 12568: }
1.31 albertel 12569: }
1.149 albertel 12570:
12571: =pod
12572:
1.648 raeburn 12573: =item * &get_env_multiple($name)
1.149 albertel 12574:
1.258 albertel 12575: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 12576: values may be defined and end up as an array ref.
12577:
12578: returns an array of values
12579:
12580: =cut
12581:
12582: sub get_env_multiple {
12583: my ($name) = @_;
12584: my @values;
1.258 albertel 12585: if (defined($env{$name})) {
1.149 albertel 12586: # exists is it an array
1.258 albertel 12587: if (ref($env{$name})) {
12588: @values=@{ $env{$name} };
1.149 albertel 12589: } else {
1.258 albertel 12590: $values[0]=$env{$name};
1.149 albertel 12591: }
12592: }
12593: return(@values);
12594: }
12595:
1.1249 damieng 12596: # Looks at given dependencies, and returns something depending on the context.
12597: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
12598: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
12599: # For all other contexts, returns ($output, $counter, $numpathchg).
12600: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
12601: # $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.
12602: # $numpathchg: integer with the number of cleaned up dependency paths.
12603: # \%existing: hash reference clean path -> 1 only for existing dependencies.
12604: # \%mapping: hash reference clean path -> original path for all dependencies.
12605: # @param {string} actionurl - The path to the handler, indicative of the context.
12606: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
12607: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
12608: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
12609: # @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)
12610: # @return {Array} - array depending on the context (not a reference)
1.660 raeburn 12611: sub ask_for_embedded_content {
1.1249 damieng 12612: # NOTE: documentation was added afterwards, it could be wrong
1.660 raeburn 12613: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071 raeburn 12614: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085 raeburn 12615: %currsubfile,%unused,$rem);
1.1071 raeburn 12616: my $counter = 0;
12617: my $numnew = 0;
1.987 raeburn 12618: my $numremref = 0;
12619: my $numinvalid = 0;
12620: my $numpathchg = 0;
12621: my $numexisting = 0;
1.1071 raeburn 12622: my $numunused = 0;
12623: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156 raeburn 12624: $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071 raeburn 12625: my $heading = &mt('Upload embedded files');
12626: my $buttontext = &mt('Upload');
12627:
1.1249 damieng 12628: # fills these variables based on the context:
12629: # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
12630: # $path, $fileloc, $title, $rem, $filename
1.1085 raeburn 12631: if ($env{'request.course.id'}) {
1.1123 raeburn 12632: if ($actionurl eq '/adm/dependencies') {
12633: $navmap = Apache::lonnavmaps::navmap->new();
12634: }
12635: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12636: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085 raeburn 12637: }
1.1123 raeburn 12638: if (($actionurl eq '/adm/portfolio') ||
12639: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984 raeburn 12640: my $current_path='/';
12641: if ($env{'form.currentpath'}) {
12642: $current_path = $env{'form.currentpath'};
12643: }
12644: if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123 raeburn 12645: $udom = $cdom;
12646: $uname = $cnum;
1.984 raeburn 12647: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
12648: } else {
12649: $udom = $env{'user.domain'};
12650: $uname = $env{'user.name'};
12651: $url = '/userfiles/portfolio';
12652: }
1.987 raeburn 12653: $toplevel = $url.'/';
1.984 raeburn 12654: $url .= $current_path;
12655: $getpropath = 1;
1.987 raeburn 12656: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
12657: ($actionurl eq '/adm/imsimport')) {
1.1022 www 12658: my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026 raeburn 12659: $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987 raeburn 12660: $toplevel = $url;
1.984 raeburn 12661: if ($rest ne '') {
1.987 raeburn 12662: $url .= $rest;
12663: }
12664: } elsif ($actionurl eq '/adm/coursedocs') {
12665: if (ref($args) eq 'HASH') {
1.1071 raeburn 12666: $url = $args->{'docs_url'};
12667: $toplevel = $url;
1.1084 raeburn 12668: if ($args->{'context'} eq 'paste') {
12669: ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
12670: ($path) =
12671: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12672: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12673: $fileloc =~ s{^/}{};
12674: }
1.1071 raeburn 12675: }
1.1084 raeburn 12676: } elsif ($actionurl eq '/adm/dependencies') {
1.1071 raeburn 12677: if ($env{'request.course.id'} ne '') {
12678: if (ref($args) eq 'HASH') {
12679: $url = $args->{'docs_url'};
12680: $title = $args->{'docs_title'};
1.1126 raeburn 12681: $toplevel = $url;
12682: unless ($toplevel =~ m{^/}) {
12683: $toplevel = "/$url";
12684: }
1.1085 raeburn 12685: ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126 raeburn 12686: if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
12687: $path = $1;
12688: } else {
12689: ($path) =
12690: ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
12691: }
1.1195 raeburn 12692: if ($toplevel=~/^\/*(uploaded|editupload)/) {
12693: $fileloc = $toplevel;
12694: $fileloc=~ s/^\s*(\S+)\s*$/$1/;
12695: my ($udom,$uname,$fname) =
12696: ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
12697: $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
12698: } else {
12699: $fileloc = &Apache::lonnet::filelocation('',$toplevel);
12700: }
1.1071 raeburn 12701: $fileloc =~ s{^/}{};
12702: ($filename) = ($fileloc =~ m{.+/([^/]+)$});
12703: $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
12704: }
1.987 raeburn 12705: }
1.1123 raeburn 12706: } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12707: $udom = $cdom;
12708: $uname = $cnum;
12709: $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
12710: $toplevel = $url;
12711: $path = $url;
12712: $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
12713: $fileloc =~ s{^/}{};
1.987 raeburn 12714: }
1.1249 damieng 12715:
12716: # parses the dependency paths to get some info
12717: # fills $newfiles, $mapping, $subdependencies, $dependencies
12718: # $newfiles: hash URL -> 1 for new files or external URLs
12719: # (will be completed later)
12720: # $mapping:
12721: # for external URLs: external URL -> external URL
12722: # for relative paths: clean path -> original path
12723: # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
12724: # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126 raeburn 12725: foreach my $file (keys(%{$allfiles})) {
12726: my $embed_file;
12727: if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
12728: $embed_file = $1;
12729: } else {
12730: $embed_file = $file;
12731: }
1.1158 raeburn 12732: my ($absolutepath,$cleaned_file);
12733: if ($embed_file =~ m{^\w+://}) {
12734: $cleaned_file = $embed_file;
1.1147 raeburn 12735: $newfiles{$cleaned_file} = 1;
12736: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12737: } else {
1.1158 raeburn 12738: $cleaned_file = &clean_path($embed_file);
1.987 raeburn 12739: if ($embed_file =~ m{^/}) {
12740: $absolutepath = $embed_file;
12741: }
1.1147 raeburn 12742: if ($cleaned_file =~ m{/}) {
12743: my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987 raeburn 12744: $path = &check_for_traversal($path,$url,$toplevel);
12745: my $item = $fname;
12746: if ($path ne '') {
12747: $item = $path.'/'.$fname;
12748: $subdependencies{$path}{$fname} = 1;
12749: } else {
12750: $dependencies{$item} = 1;
12751: }
12752: if ($absolutepath) {
12753: $mapping{$item} = $absolutepath;
12754: } else {
12755: $mapping{$item} = $embed_file;
12756: }
12757: } else {
12758: $dependencies{$embed_file} = 1;
12759: if ($absolutepath) {
1.1147 raeburn 12760: $mapping{$cleaned_file} = $absolutepath;
1.987 raeburn 12761: } else {
1.1147 raeburn 12762: $mapping{$cleaned_file} = $embed_file;
1.987 raeburn 12763: }
12764: }
1.984 raeburn 12765: }
12766: }
1.1249 damieng 12767:
12768: # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
12769: # and lists
12770: # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
12771: # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
12772: # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
12773: # the path had to be cleaned up
12774: # $existing: hash clean path -> 1 if the file exists
12775: # $numexisting: number of keys in $existing
12776: # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
12777: # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
12778: # dependency subdirectories that are
12779: # not listed as dependencies, with some exceptions using $rem
1.1071 raeburn 12780: my $dirptr = 16384;
1.984 raeburn 12781: foreach my $path (keys(%subdependencies)) {
1.1071 raeburn 12782: $currsubfile{$path} = {};
1.1123 raeburn 12783: if (($actionurl eq '/adm/portfolio') ||
12784: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12785: my ($sublistref,$listerror) =
12786: &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
12787: if (ref($sublistref) eq 'ARRAY') {
12788: foreach my $line (@{$sublistref}) {
12789: my ($file_name,$rest) = split(/\&/,$line,2);
1.1071 raeburn 12790: $currsubfile{$path}{$file_name} = 1;
1.1021 raeburn 12791: }
1.984 raeburn 12792: }
1.987 raeburn 12793: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12794: if (opendir(my $dir,$url.'/'.$path)) {
12795: my @subdir_list = grep(!/^\./,readdir($dir));
1.1071 raeburn 12796: map {$currsubfile{$path}{$_} = 1;} @subdir_list;
12797: }
1.1084 raeburn 12798: } elsif (($actionurl eq '/adm/dependencies') ||
12799: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12800: ($args->{'context'} eq 'paste')) ||
12801: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12802: if ($env{'request.course.id'} ne '') {
1.1123 raeburn 12803: my $dir;
12804: if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
12805: $dir = $fileloc;
12806: } else {
12807: ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12808: }
1.1071 raeburn 12809: if ($dir ne '') {
12810: my ($sublistref,$listerror) =
12811: &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
12812: if (ref($sublistref) eq 'ARRAY') {
12813: foreach my $line (@{$sublistref}) {
12814: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
12815: undef,$mtime)=split(/\&/,$line,12);
12816: unless (($testdir&$dirptr) ||
12817: ($file_name =~ /^\.\.?$/)) {
12818: $currsubfile{$path}{$file_name} = [$size,$mtime];
12819: }
12820: }
12821: }
12822: }
1.984 raeburn 12823: }
12824: }
12825: foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071 raeburn 12826: if (exists($currsubfile{$path}{$file})) {
1.987 raeburn 12827: my $item = $path.'/'.$file;
12828: unless ($mapping{$item} eq $item) {
12829: $pathchanges{$item} = 1;
12830: }
12831: $existing{$item} = 1;
12832: $numexisting ++;
12833: } else {
12834: $newfiles{$path.'/'.$file} = 1;
1.984 raeburn 12835: }
12836: }
1.1071 raeburn 12837: if ($actionurl eq '/adm/dependencies') {
12838: foreach my $path (keys(%currsubfile)) {
12839: if (ref($currsubfile{$path}) eq 'HASH') {
12840: foreach my $file (keys(%{$currsubfile{$path}})) {
12841: unless ($subdependencies{$path}{$file}) {
1.1085 raeburn 12842: next if (($rem ne '') &&
12843: (($env{"httpref.$rem"."$path/$file"} ne '') ||
12844: (ref($navmap) &&
12845: (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
12846: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12847: ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071 raeburn 12848: $unused{$path.'/'.$file} = 1;
12849: }
12850: }
12851: }
12852: }
12853: }
1.984 raeburn 12854: }
1.1249 damieng 12855:
12856: # fills $currfile, hash file name -> 1 or [$size,$mtime]
12857: # for files in $url or $fileloc (target directory) in some contexts
1.987 raeburn 12858: my %currfile;
1.1123 raeburn 12859: if (($actionurl eq '/adm/portfolio') ||
12860: ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021 raeburn 12861: my ($dirlistref,$listerror) =
12862: &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
12863: if (ref($dirlistref) eq 'ARRAY') {
12864: foreach my $line (@{$dirlistref}) {
12865: my ($file_name,$rest) = split(/\&/,$line,2);
12866: $currfile{$file_name} = 1;
12867: }
1.984 raeburn 12868: }
1.987 raeburn 12869: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984 raeburn 12870: if (opendir(my $dir,$url)) {
1.987 raeburn 12871: my @dir_list = grep(!/^\./,readdir($dir));
1.984 raeburn 12872: map {$currfile{$_} = 1;} @dir_list;
12873: }
1.1084 raeburn 12874: } elsif (($actionurl eq '/adm/dependencies') ||
12875: (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123 raeburn 12876: ($args->{'context'} eq 'paste')) ||
12877: ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071 raeburn 12878: if ($env{'request.course.id'} ne '') {
12879: my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
12880: if ($dir ne '') {
12881: my ($dirlistref,$listerror) =
12882: &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
12883: if (ref($dirlistref) eq 'ARRAY') {
12884: foreach my $line (@{$dirlistref}) {
12885: my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
12886: $size,undef,$mtime)=split(/\&/,$line,12);
12887: unless (($testdir&$dirptr) ||
12888: ($file_name =~ /^\.\.?$/)) {
12889: $currfile{$file_name} = [$size,$mtime];
12890: }
12891: }
12892: }
12893: }
12894: }
1.984 raeburn 12895: }
1.1249 damieng 12896: # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
12897: # are not in subdirectories, using $currfile
1.984 raeburn 12898: foreach my $file (keys(%dependencies)) {
1.1071 raeburn 12899: if (exists($currfile{$file})) {
1.987 raeburn 12900: unless ($mapping{$file} eq $file) {
12901: $pathchanges{$file} = 1;
12902: }
12903: $existing{$file} = 1;
12904: $numexisting ++;
12905: } else {
1.984 raeburn 12906: $newfiles{$file} = 1;
12907: }
12908: }
1.1071 raeburn 12909: foreach my $file (keys(%currfile)) {
12910: unless (($file eq $filename) ||
12911: ($file eq $filename.'.bak') ||
12912: ($dependencies{$file})) {
1.1085 raeburn 12913: if ($actionurl eq '/adm/dependencies') {
1.1126 raeburn 12914: unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
12915: next if (($rem ne '') &&
12916: (($env{"httpref.$rem".$file} ne '') ||
12917: (ref($navmap) &&
12918: (($navmap->getResourceByUrl($rem.$file) ne '') ||
12919: (($file =~ /^(.*\.s?html?)\.bak$/i) &&
12920: ($navmap->getResourceByUrl($rem.$1)))))));
12921: }
1.1085 raeburn 12922: }
1.1071 raeburn 12923: $unused{$file} = 1;
12924: }
12925: }
1.1249 damieng 12926:
12927: # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084 raeburn 12928: if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
12929: ($args->{'context'} eq 'paste')) {
12930: $counter = scalar(keys(%existing));
12931: $numpathchg = scalar(keys(%pathchanges));
1.1123 raeburn 12932: return ($output,$counter,$numpathchg,\%existing);
12933: } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
12934: (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
12935: $counter = scalar(keys(%existing));
12936: $numpathchg = scalar(keys(%pathchanges));
12937: return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084 raeburn 12938: }
1.1249 damieng 12939:
12940: # returns HTML otherwise, with dependency results and to ask for more uploads
12941:
12942: # $upload_output: missing dependencies (with upload form)
12943: # $modify_output: uploaded dependencies (in use)
12944: # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984 raeburn 12945: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071 raeburn 12946: if ($actionurl eq '/adm/dependencies') {
12947: next if ($embed_file =~ m{^\w+://});
12948: }
1.660 raeburn 12949: $upload_output .= &start_data_table_row().
1.1123 raeburn 12950: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
1.1071 raeburn 12951: '<span class="LC_filename">'.$embed_file.'</span>';
1.987 raeburn 12952: unless ($mapping{$embed_file} eq $embed_file) {
1.1123 raeburn 12953: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
12954: &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987 raeburn 12955: }
1.1123 raeburn 12956: $upload_output .= '</td>';
1.1071 raeburn 12957: if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) {
1.1123 raeburn 12958: $upload_output.='<td align="right">'.
12959: '<span class="LC_info LC_fontsize_medium">'.
12960: &mt("URL points to web address").'</span>';
1.987 raeburn 12961: $numremref++;
1.660 raeburn 12962: } elsif ($args->{'error_on_invalid_names'}
12963: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123 raeburn 12964: $upload_output.='<td align="right"><span class="LC_warning">'.
12965: &mt('Invalid characters').'</span>';
1.987 raeburn 12966: $numinvalid++;
1.660 raeburn 12967: } else {
1.1123 raeburn 12968: $upload_output .= '<td>'.
12969: &embedded_file_element('upload_embedded',$counter,
1.987 raeburn 12970: $embed_file,\%mapping,
1.1071 raeburn 12971: $allfiles,$codebase,'upload');
12972: $counter ++;
12973: $numnew ++;
1.987 raeburn 12974: }
12975: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
12976: }
12977: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071 raeburn 12978: if ($actionurl eq '/adm/dependencies') {
12979: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
12980: $modify_output .= &start_data_table_row().
12981: '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
12982: '<img src="'.&icon($embed_file).'" border="0" />'.
12983: ' <span class="LC_filename">'.$embed_file.'</span></a></td>'.
12984: '<td>'.$size.'</td>'.
12985: '<td>'.$mtime.'</td>'.
12986: '<td><label><input type="checkbox" name="mod_upload_dep" '.
12987: 'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
12988: $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
12989: '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
12990: &embedded_file_element('upload_embedded',$counter,
12991: $embed_file,\%mapping,
12992: $allfiles,$codebase,'modify').
12993: '</div></td>'.
12994: &end_data_table_row()."\n";
12995: $counter ++;
12996: } else {
12997: $upload_output .= &start_data_table_row().
1.1123 raeburn 12998: '<td valign="top"><img src="'.&icon($embed_file).'" /> '.
12999: '<span class="LC_filename">'.$embed_file.'</span></td>'.
13000: '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071 raeburn 13001: &Apache::loncommon::end_data_table_row()."\n";
13002: }
13003: }
13004: my $delidx = $counter;
13005: foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
13006: my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
13007: $delete_output .= &start_data_table_row().
13008: '<td><img src="'.&icon($oldfile).'" />'.
13009: ' <span class="LC_filename">'.$oldfile.'</span></td>'.
13010: '<td>'.$size.'</td>'.
13011: '<td>'.$mtime.'</td>'.
13012: '<td><label><input type="checkbox" name="del_upload_dep" '.
13013: ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
13014: &embedded_file_element('upload_embedded',$delidx,
13015: $oldfile,\%mapping,$allfiles,
13016: $codebase,'delete').'</td>'.
13017: &end_data_table_row()."\n";
13018: $numunused ++;
13019: $delidx ++;
1.987 raeburn 13020: }
13021: if ($upload_output) {
13022: $upload_output = &start_data_table().
13023: $upload_output.
13024: &end_data_table()."\n";
13025: }
1.1071 raeburn 13026: if ($modify_output) {
13027: $modify_output = &start_data_table().
13028: &start_data_table_header_row().
13029: '<th>'.&mt('File').'</th>'.
13030: '<th>'.&mt('Size (KB)').'</th>'.
13031: '<th>'.&mt('Modified').'</th>'.
13032: '<th>'.&mt('Upload replacement?').'</th>'.
13033: &end_data_table_header_row().
13034: $modify_output.
13035: &end_data_table()."\n";
13036: }
13037: if ($delete_output) {
13038: $delete_output = &start_data_table().
13039: &start_data_table_header_row().
13040: '<th>'.&mt('File').'</th>'.
13041: '<th>'.&mt('Size (KB)').'</th>'.
13042: '<th>'.&mt('Modified').'</th>'.
13043: '<th>'.&mt('Delete?').'</th>'.
13044: &end_data_table_header_row().
13045: $delete_output.
13046: &end_data_table()."\n";
13047: }
1.987 raeburn 13048: my $applies = 0;
13049: if ($numremref) {
13050: $applies ++;
13051: }
13052: if ($numinvalid) {
13053: $applies ++;
13054: }
13055: if ($numexisting) {
13056: $applies ++;
13057: }
1.1071 raeburn 13058: if ($counter || $numunused) {
1.987 raeburn 13059: $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
13060: ' method="post" enctype="multipart/form-data">'."\n".
1.1071 raeburn 13061: $state.'<h3>'.$heading.'</h3>';
13062: if ($actionurl eq '/adm/dependencies') {
13063: if ($numnew) {
13064: $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
13065: '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
13066: $upload_output.'<br />'."\n";
13067: }
13068: if ($numexisting) {
13069: $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
13070: '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
13071: $modify_output.'<br />'."\n";
13072: $buttontext = &mt('Save changes');
13073: }
13074: if ($numunused) {
13075: $output .= '<h4>'.&mt('Unused files').'</h4>'.
13076: '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
13077: $delete_output.'<br />'."\n";
13078: $buttontext = &mt('Save changes');
13079: }
13080: } else {
13081: $output .= $upload_output.'<br />'."\n";
13082: }
13083: $output .= '<input type ="hidden" name="number_embedded_items" value="'.
13084: $counter.'" />'."\n";
13085: if ($actionurl eq '/adm/dependencies') {
13086: $output .= '<input type ="hidden" name="number_newemb_items" value="'.
13087: $numnew.'" />'."\n";
13088: } elsif ($actionurl eq '') {
1.987 raeburn 13089: $output .= '<input type="hidden" name="phase" value="three" />';
13090: }
13091: } elsif ($applies) {
13092: $output = '<b>'.&mt('Referenced files').'</b>:<br />';
13093: if ($applies > 1) {
13094: $output .=
1.1123 raeburn 13095: &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987 raeburn 13096: if ($numremref) {
13097: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
13098: }
13099: if ($numinvalid) {
13100: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
13101: }
13102: if ($numexisting) {
13103: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
13104: }
13105: $output .= '</ul><br />';
13106: } elsif ($numremref) {
13107: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
13108: } elsif ($numinvalid) {
13109: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
13110: } elsif ($numexisting) {
13111: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
13112: }
13113: $output .= $upload_output.'<br />';
13114: }
13115: my ($pathchange_output,$chgcount);
1.1071 raeburn 13116: $chgcount = $counter;
1.987 raeburn 13117: if (keys(%pathchanges) > 0) {
13118: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071 raeburn 13119: if ($counter) {
1.987 raeburn 13120: $output .= &embedded_file_element('pathchange',$chgcount,
13121: $embed_file,\%mapping,
1.1071 raeburn 13122: $allfiles,$codebase,'change');
1.987 raeburn 13123: } else {
13124: $pathchange_output .=
13125: &start_data_table_row().
13126: '<td><input type ="checkbox" name="namechange" value="'.
13127: $chgcount.'" checked="checked" /></td>'.
13128: '<td>'.$mapping{$embed_file}.'</td>'.
13129: '<td>'.$embed_file.
13130: &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071 raeburn 13131: \%mapping,$allfiles,$codebase,'change').
1.987 raeburn 13132: '</td>'.&end_data_table_row();
1.660 raeburn 13133: }
1.987 raeburn 13134: $numpathchg ++;
13135: $chgcount ++;
1.660 raeburn 13136: }
13137: }
1.1127 raeburn 13138: if (($counter) || ($numunused)) {
1.987 raeburn 13139: if ($numpathchg) {
13140: $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
13141: $numpathchg.'" />'."\n";
13142: }
13143: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
13144: ($actionurl eq '/adm/imsimport')) {
13145: $output .= '<input type="hidden" name="phase" value="three" />'."\n";
13146: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
13147: $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071 raeburn 13148: } elsif ($actionurl eq '/adm/dependencies') {
13149: $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987 raeburn 13150: }
1.1123 raeburn 13151: $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987 raeburn 13152: } elsif ($numpathchg) {
13153: my %pathchange = ();
13154: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
13155: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13156: $output .= '<p>'.&mt('or').'</p>';
1.1123 raeburn 13157: }
1.987 raeburn 13158: }
1.1071 raeburn 13159: return ($output,$counter,$numpathchg);
1.987 raeburn 13160: }
13161:
1.1147 raeburn 13162: =pod
13163:
13164: =item * clean_path($name)
13165:
13166: Performs clean-up of directories, subdirectories and filename in an
13167: embedded object, referenced in an HTML file which is being uploaded
13168: to a course or portfolio, where
13169: "Upload embedded images/multimedia files if HTML file" checkbox was
13170: checked.
13171:
13172: Clean-up is similar to replacements in lonnet::clean_filename()
13173: except each / between sub-directory and next level is preserved.
13174:
13175: =cut
13176:
13177: sub clean_path {
13178: my ($embed_file) = @_;
13179: $embed_file =~s{^/+}{};
13180: my @contents;
13181: if ($embed_file =~ m{/}) {
13182: @contents = split(/\//,$embed_file);
13183: } else {
13184: @contents = ($embed_file);
13185: }
13186: my $lastidx = scalar(@contents)-1;
13187: for (my $i=0; $i<=$lastidx; $i++) {
13188: $contents[$i]=~s{\\}{/}g;
13189: $contents[$i]=~s/\s+/\_/g;
13190: $contents[$i]=~s{[^/\w\.\-]}{}g;
13191: if ($i == $lastidx) {
13192: $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
13193: }
13194: }
13195: if ($lastidx > 0) {
13196: return join('/',@contents);
13197: } else {
13198: return $contents[0];
13199: }
13200: }
13201:
1.987 raeburn 13202: sub embedded_file_element {
1.1071 raeburn 13203: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987 raeburn 13204: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
13205: (ref($codebase) eq 'HASH'));
13206: my $output;
1.1071 raeburn 13207: if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987 raeburn 13208: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
13209: }
13210: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
13211: &escape($embed_file).'" />';
13212: unless (($context eq 'upload_embedded') &&
13213: ($mapping->{$embed_file} eq $embed_file)) {
13214: $output .='
13215: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
13216: }
13217: my $attrib;
13218: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
13219: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
13220: }
13221: $output .=
13222: "\n\t\t".
13223: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
13224: $attrib.'" />';
13225: if (exists($codebase->{$mapping->{$embed_file}})) {
13226: $output .=
13227: "\n\t\t".
13228: '<input name="codebase_'.$num.'" type="hidden" value="'.
13229: &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984 raeburn 13230: }
1.987 raeburn 13231: return $output;
1.660 raeburn 13232: }
13233:
1.1071 raeburn 13234: sub get_dependency_details {
13235: my ($currfile,$currsubfile,$embed_file) = @_;
13236: my ($size,$mtime,$showsize,$showmtime);
13237: if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
13238: if ($embed_file =~ m{/}) {
13239: my ($path,$fname) = split(/\//,$embed_file);
13240: if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
13241: ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
13242: }
13243: } else {
13244: if (ref($currfile->{$embed_file}) eq 'ARRAY') {
13245: ($size,$mtime) = @{$currfile->{$embed_file}};
13246: }
13247: }
13248: $showsize = $size/1024.0;
13249: $showsize = sprintf("%.1f",$showsize);
13250: if ($mtime > 0) {
13251: $showmtime = &Apache::lonlocal::locallocaltime($mtime);
13252: }
13253: }
13254: return ($showsize,$showmtime);
13255: }
13256:
13257: sub ask_embedded_js {
13258: return <<"END";
13259: <script type="text/javascript"">
13260: // <![CDATA[
13261: function toggleBrowse(counter) {
13262: var chkboxid = document.getElementById('mod_upload_dep_'+counter);
13263: var fileid = document.getElementById('embedded_item_'+counter);
13264: var uploaddivid = document.getElementById('moduploaddep_'+counter);
13265: if (chkboxid.checked == true) {
13266: uploaddivid.style.display='block';
13267: } else {
13268: uploaddivid.style.display='none';
13269: fileid.value = '';
13270: }
13271: }
13272: // ]]>
13273: </script>
13274:
13275: END
13276: }
13277:
1.661 raeburn 13278: sub upload_embedded {
13279: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987 raeburn 13280: $current_disk_usage,$hiddenstate,$actionurl) = @_;
13281: my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661 raeburn 13282: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
13283: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
13284: my $orig_uploaded_filename =
13285: $env{'form.embedded_item_'.$i.'.filename'};
1.987 raeburn 13286: foreach my $type ('orig','ref','attrib','codebase') {
13287: if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
13288: $env{'form.embedded_'.$type.'_'.$i} =
13289: &unescape($env{'form.embedded_'.$type.'_'.$i});
13290: }
13291: }
1.661 raeburn 13292: my ($path,$fname) =
13293: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
13294: # no path, whole string is fname
13295: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
13296: $fname = &Apache::lonnet::clean_filename($fname);
13297: # See if there is anything left
13298: next if ($fname eq '');
13299:
13300: # Check if file already exists as a file or directory.
13301: my ($state,$msg);
13302: if ($context eq 'portfolio') {
13303: my $port_path = $dirpath;
13304: if ($group ne '') {
13305: $port_path = "groups/$group/$port_path";
13306: }
1.987 raeburn 13307: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
13308: $fname,$group,'embedded_item_'.$i,
1.661 raeburn 13309: $dir_root,$port_path,$disk_quota,
13310: $current_disk_usage,$uname,$udom);
13311: if ($state eq 'will_exceed_quota'
1.984 raeburn 13312: || $state eq 'file_locked') {
1.661 raeburn 13313: $output .= $msg;
13314: next;
13315: }
13316: } elsif (($context eq 'author') || ($context eq 'testbank')) {
13317: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
13318: if ($state eq 'exists') {
13319: $output .= $msg;
13320: next;
13321: }
13322: }
13323: # Check if extension is valid
13324: if (($fname =~ /\.(\w+)$/) &&
13325: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155 bisitz 13326: $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
13327: .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661 raeburn 13328: next;
13329: } elsif (($fname =~ /\.(\w+)$/) &&
13330: (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987 raeburn 13331: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661 raeburn 13332: next;
13333: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120 bisitz 13334: $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 13335: next;
13336: }
13337: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123 raeburn 13338: my $subdir = $path;
13339: $subdir =~ s{/+$}{};
1.661 raeburn 13340: if ($context eq 'portfolio') {
1.984 raeburn 13341: my $result;
13342: if ($state eq 'existingfile') {
13343: $result=
13344: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123 raeburn 13345: $dirpath.$env{'form.currentpath'}.$subdir);
1.661 raeburn 13346: } else {
1.984 raeburn 13347: $result=
13348: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987 raeburn 13349: $dirpath.
1.1123 raeburn 13350: $env{'form.currentpath'}.$subdir);
1.984 raeburn 13351: if ($result !~ m|^/uploaded/|) {
13352: $output .= '<span class="LC_error">'
13353: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13354: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13355: .'</span><br />';
13356: next;
13357: } else {
1.987 raeburn 13358: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13359: $path.$fname.'</span>').'<br />';
1.984 raeburn 13360: }
1.661 raeburn 13361: }
1.1123 raeburn 13362: } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126 raeburn 13363: my $extendedsubdir = $dirpath.'/'.$subdir;
13364: $extendedsubdir =~ s{/+$}{};
1.987 raeburn 13365: my $result =
1.1126 raeburn 13366: &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987 raeburn 13367: if ($result !~ m|^/uploaded/|) {
13368: $output .= '<span class="LC_error">'
13369: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
13370: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
13371: .'</span><br />';
13372: next;
13373: } else {
13374: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13375: $path.$fname.'</span>').'<br />';
1.1125 raeburn 13376: if ($context eq 'syllabus') {
13377: &Apache::lonnet::make_public_indefinitely($result);
13378: }
1.987 raeburn 13379: }
1.661 raeburn 13380: } else {
13381: # Save the file
13382: my $target = $env{'form.embedded_item_'.$i};
13383: my $fullpath = $dir_root.$dirpath.'/'.$path;
13384: my $dest = $fullpath.$fname;
13385: my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027 raeburn 13386: my @parts=split(/\//,"$dirpath/$path");
1.661 raeburn 13387: my $count;
13388: my $filepath = $dir_root;
1.1027 raeburn 13389: foreach my $subdir (@parts) {
13390: $filepath .= "/$subdir";
13391: if (!-e $filepath) {
1.661 raeburn 13392: mkdir($filepath,0770);
13393: }
13394: }
13395: my $fh;
13396: if (!open($fh,'>'.$dest)) {
13397: &Apache::lonnet::logthis('Failed to create '.$dest);
13398: $output .= '<span class="LC_error">'.
1.1071 raeburn 13399: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
13400: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13401: '</span><br />';
13402: } else {
13403: if (!print $fh $env{'form.embedded_item_'.$i}) {
13404: &Apache::lonnet::logthis('Failed to write to '.$dest);
13405: $output .= '<span class="LC_error">'.
1.1071 raeburn 13406: &mt('An error occurred while writing the file [_1] for embedded element [_2].',
13407: $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661 raeburn 13408: '</span><br />';
13409: } else {
1.987 raeburn 13410: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
13411: $url.'</span>').'<br />';
13412: unless ($context eq 'testbank') {
13413: $footer .= &mt('View embedded file: [_1]',
13414: '<a href="'.$url.'">'.$fname.'</a>').'<br />';
13415: }
13416: }
13417: close($fh);
13418: }
13419: }
13420: if ($env{'form.embedded_ref_'.$i}) {
13421: $pathchange{$i} = 1;
13422: }
13423: }
13424: if ($output) {
13425: $output = '<p>'.$output.'</p>';
13426: }
13427: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
13428: $returnflag = 'ok';
1.1071 raeburn 13429: my $numpathchgs = scalar(keys(%pathchange));
13430: if ($numpathchgs > 0) {
1.987 raeburn 13431: if ($context eq 'portfolio') {
13432: $output .= '<p>'.&mt('or').'</p>';
13433: } elsif ($context eq 'testbank') {
1.1071 raeburn 13434: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
13435: '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987 raeburn 13436: $returnflag = 'modify_orightml';
13437: }
13438: }
1.1071 raeburn 13439: return ($output.$footer,$returnflag,$numpathchgs);
1.987 raeburn 13440: }
13441:
13442: sub modify_html_form {
13443: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
13444: my $end = 0;
13445: my $modifyform;
13446: if ($context eq 'upload_embedded') {
13447: return unless (ref($pathchange) eq 'HASH');
13448: if ($env{'form.number_embedded_items'}) {
13449: $end += $env{'form.number_embedded_items'};
13450: }
13451: if ($env{'form.number_pathchange_items'}) {
13452: $end += $env{'form.number_pathchange_items'};
13453: }
13454: if ($end) {
13455: for (my $i=0; $i<$end; $i++) {
13456: if ($i < $env{'form.number_embedded_items'}) {
13457: next unless($pathchange->{$i});
13458: }
13459: $modifyform .=
13460: &start_data_table_row().
13461: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
13462: 'checked="checked" /></td>'.
13463: '<td>'.$env{'form.embedded_ref_'.$i}.
13464: '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
13465: &escape($env{'form.embedded_ref_'.$i}).'" />'.
13466: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
13467: &escape($env{'form.embedded_codebase_'.$i}).'" />'.
13468: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
13469: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
13470: '<td>'.$env{'form.embedded_orig_'.$i}.
13471: '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
13472: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
13473: &end_data_table_row();
1.1071 raeburn 13474: }
1.987 raeburn 13475: }
13476: } else {
13477: $modifyform = $pathchgtable;
13478: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
13479: $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
13480: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
13481: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
13482: }
13483: }
13484: if ($modifyform) {
1.1071 raeburn 13485: if ($actionurl eq '/adm/dependencies') {
13486: $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
13487: }
1.987 raeburn 13488: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
13489: '<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".
13490: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
13491: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
13492: '</ol></p>'."\n".'<p>'.
13493: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
13494: '<form method="post" name="refchanger" action="'.$actionurl.'">'.
13495: &start_data_table()."\n".
13496: &start_data_table_header_row().
13497: '<th>'.&mt('Change?').'</th>'.
13498: '<th>'.&mt('Current reference').'</th>'.
13499: '<th>'.&mt('Required reference').'</th>'.
13500: &end_data_table_header_row()."\n".
13501: $modifyform.
13502: &end_data_table().'<br />'."\n".$hiddenstate.
13503: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
13504: '</form>'."\n";
13505: }
13506: return;
13507: }
13508:
13509: sub modify_html_refs {
1.1123 raeburn 13510: my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987 raeburn 13511: my $container;
13512: if ($context eq 'portfolio') {
13513: $container = $env{'form.container'};
13514: } elsif ($context eq 'coursedoc') {
13515: $container = $env{'form.primaryurl'};
1.1071 raeburn 13516: } elsif ($context eq 'manage_dependencies') {
13517: (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
13518: $container = "/$container";
1.1123 raeburn 13519: } elsif ($context eq 'syllabus') {
13520: $container = $url;
1.987 raeburn 13521: } else {
1.1027 raeburn 13522: $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987 raeburn 13523: }
13524: my (%allfiles,%codebase,$output,$content);
13525: my @changes = &get_env_multiple('form.namechange');
1.1126 raeburn 13526: unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071 raeburn 13527: if (wantarray) {
13528: return ('',0,0);
13529: } else {
13530: return;
13531: }
13532: }
13533: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13534: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071 raeburn 13535: unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
13536: if (wantarray) {
13537: return ('',0,0);
13538: } else {
13539: return;
13540: }
13541: }
1.987 raeburn 13542: $content = &Apache::lonnet::getfile($container);
1.1071 raeburn 13543: if ($content eq '-1') {
13544: if (wantarray) {
13545: return ('',0,0);
13546: } else {
13547: return;
13548: }
13549: }
1.987 raeburn 13550: } else {
1.1071 raeburn 13551: unless ($container =~ /^\Q$dir_root\E/) {
13552: if (wantarray) {
13553: return ('',0,0);
13554: } else {
13555: return;
13556: }
13557: }
1.1317 raeburn 13558: if (open(my $fh,'<',$container)) {
1.987 raeburn 13559: $content = join('', <$fh>);
13560: close($fh);
13561: } else {
1.1071 raeburn 13562: if (wantarray) {
13563: return ('',0,0);
13564: } else {
13565: return;
13566: }
1.987 raeburn 13567: }
13568: }
13569: my ($count,$codebasecount) = (0,0);
13570: my $mm = new File::MMagic;
13571: my $mime_type = $mm->checktype_contents($content);
13572: if ($mime_type eq 'text/html') {
13573: my $parse_result =
13574: &Apache::lonnet::extract_embedded_items($container,\%allfiles,
13575: \%codebase,\$content);
13576: if ($parse_result eq 'ok') {
13577: foreach my $i (@changes) {
13578: my $orig = &unescape($env{'form.embedded_orig_'.$i});
13579: my $ref = &unescape($env{'form.embedded_ref_'.$i});
13580: if ($allfiles{$ref}) {
13581: my $newname = $orig;
13582: my ($attrib_regexp,$codebase);
1.1006 raeburn 13583: $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987 raeburn 13584: if ($attrib_regexp =~ /:/) {
13585: $attrib_regexp =~ s/\:/|/g;
13586: }
13587: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13588: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13589: $count += $numchg;
1.1123 raeburn 13590: $allfiles{$newname} = $allfiles{$ref};
1.1148 raeburn 13591: delete($allfiles{$ref});
1.987 raeburn 13592: }
13593: if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006 raeburn 13594: $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987 raeburn 13595: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
13596: $codebasecount ++;
13597: }
13598: }
13599: }
1.1123 raeburn 13600: my $skiprewrites;
1.987 raeburn 13601: if ($count || $codebasecount) {
13602: my $saveresult;
1.1071 raeburn 13603: if (($context eq 'portfolio') || ($context eq 'coursedoc') ||
1.1123 raeburn 13604: ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987 raeburn 13605: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13606: if ($url eq $container) {
13607: my ($fname) = ($container =~ m{/([^/]+)$});
13608: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13609: $count,'<span class="LC_filename">'.
1.1071 raeburn 13610: $fname.'</span>').'</p>';
1.987 raeburn 13611: } else {
13612: $output = '<p class="LC_error">'.
13613: &mt('Error: update failed for: [_1].',
13614: '<span class="LC_filename">'.
13615: $container.'</span>').'</p>';
13616: }
1.1123 raeburn 13617: if ($context eq 'syllabus') {
13618: unless ($saveresult eq 'ok') {
13619: $skiprewrites = 1;
13620: }
13621: }
1.987 raeburn 13622: } else {
1.1317 raeburn 13623: if (open(my $fh,'>',$container)) {
1.987 raeburn 13624: print $fh $content;
13625: close($fh);
13626: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
13627: $count,'<span class="LC_filename">'.
13628: $container.'</span>').'</p>';
1.661 raeburn 13629: } else {
1.987 raeburn 13630: $output = '<p class="LC_error">'.
13631: &mt('Error: could not update [_1].',
13632: '<span class="LC_filename">'.
13633: $container.'</span>').'</p>';
1.661 raeburn 13634: }
13635: }
13636: }
1.1123 raeburn 13637: if (($context eq 'syllabus') && (!$skiprewrites)) {
13638: my ($actionurl,$state);
13639: $actionurl = "/public/$udom/$uname/syllabus";
13640: my ($ignore,$num,$numpathchanges,$existing,$mapping) =
13641: &ask_for_embedded_content($actionurl,$state,\%allfiles,
13642: \%codebase,
13643: {'context' => 'rewrites',
13644: 'ignore_remote_references' => 1,});
13645: if (ref($mapping) eq 'HASH') {
13646: my $rewrites = 0;
13647: foreach my $key (keys(%{$mapping})) {
13648: next if ($key =~ m{^https?://});
13649: my $ref = $mapping->{$key};
13650: my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
13651: my $attrib;
13652: if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
13653: $attrib = join('|',@{$allfiles{$mapping->{$key}}});
13654: }
13655: if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
13656: my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
13657: $rewrites += $numchg;
13658: }
13659: }
13660: if ($rewrites) {
13661: my $saveresult;
13662: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
13663: if ($url eq $container) {
13664: my ($fname) = ($container =~ m{/([^/]+)$});
13665: $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
13666: $count,'<span class="LC_filename">'.
13667: $fname.'</span>').'</p>';
13668: } else {
13669: $output .= '<p class="LC_error">'.
13670: &mt('Error: could not update links in [_1].',
13671: '<span class="LC_filename">'.
13672: $container.'</span>').'</p>';
13673:
13674: }
13675: }
13676: }
13677: }
1.987 raeburn 13678: } else {
13679: &logthis('Failed to parse '.$container.
13680: ' to modify references: '.$parse_result);
1.661 raeburn 13681: }
13682: }
1.1071 raeburn 13683: if (wantarray) {
13684: return ($output,$count,$codebasecount);
13685: } else {
13686: return $output;
13687: }
1.661 raeburn 13688: }
13689:
13690: sub check_for_existing {
13691: my ($path,$fname,$element) = @_;
13692: my ($state,$msg);
13693: if (-d $path.'/'.$fname) {
13694: $state = 'exists';
13695: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13696: } elsif (-e $path.'/'.$fname) {
13697: $state = 'exists';
13698: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
13699: }
13700: if ($state eq 'exists') {
13701: $msg = '<span class="LC_error">'.$msg.'</span><br />';
13702: }
13703: return ($state,$msg);
13704: }
13705:
13706: sub check_for_upload {
13707: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
13708: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985 raeburn 13709: my $filesize = length($env{'form.'.$element});
13710: if (!$filesize) {
13711: my $msg = '<span class="LC_error">'.
13712: &mt('Unable to upload [_1]. (size = [_2] bytes)',
13713: '<span class="LC_filename">'.$fname.'</span>',
13714: $filesize).'<br />'.
1.1007 raeburn 13715: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985 raeburn 13716: '</span>';
13717: return ('zero_bytes',$msg);
13718: }
13719: $filesize = $filesize/1000; #express in k (1024?)
1.661 raeburn 13720: my $getpropath = 1;
1.1021 raeburn 13721: my ($dirlistref,$listerror) =
13722: &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661 raeburn 13723: my $found_file = 0;
13724: my $locked_file = 0;
1.991 raeburn 13725: my @lockers;
13726: my $navmap;
13727: if ($env{'request.course.id'}) {
13728: $navmap = Apache::lonnavmaps::navmap->new();
13729: }
1.1021 raeburn 13730: if (ref($dirlistref) eq 'ARRAY') {
13731: foreach my $line (@{$dirlistref}) {
13732: my ($file_name,$rest)=split(/\&/,$line,2);
13733: if ($file_name eq $fname){
13734: $file_name = $path.$file_name;
13735: if ($group ne '') {
13736: $file_name = $group.$file_name;
13737: }
13738: $found_file = 1;
13739: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
13740: foreach my $lock (@lockers) {
13741: if (ref($lock) eq 'ARRAY') {
13742: my ($symb,$crsid) = @{$lock};
13743: if ($crsid eq $env{'request.course.id'}) {
13744: if (ref($navmap)) {
13745: my $res = $navmap->getBySymb($symb);
13746: foreach my $part (@{$res->parts()}) {
13747: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
13748: unless (($slot_status == $res->RESERVED) ||
13749: ($slot_status == $res->RESERVED_LOCATION)) {
13750: $locked_file = 1;
13751: }
1.991 raeburn 13752: }
1.1021 raeburn 13753: } else {
13754: $locked_file = 1;
1.991 raeburn 13755: }
13756: } else {
13757: $locked_file = 1;
13758: }
13759: }
1.1021 raeburn 13760: }
13761: } else {
13762: my @info = split(/\&/,$rest);
13763: my $currsize = $info[6]/1000;
13764: if ($currsize < $filesize) {
13765: my $extra = $filesize - $currsize;
13766: if (($current_disk_usage + $extra) > $disk_quota) {
1.1179 bisitz 13767: my $msg = '<p class="LC_warning">'.
1.1021 raeburn 13768: &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 13769: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
13770: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
13771: $disk_quota,$current_disk_usage).'</p>';
1.1021 raeburn 13772: return ('will_exceed_quota',$msg);
13773: }
1.984 raeburn 13774: }
13775: }
1.661 raeburn 13776: }
13777: }
13778: }
13779: if (($current_disk_usage + $filesize) > $disk_quota){
1.1179 bisitz 13780: my $msg = '<p class="LC_warning">'.
13781: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184 raeburn 13782: '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661 raeburn 13783: return ('will_exceed_quota',$msg);
13784: } elsif ($found_file) {
13785: if ($locked_file) {
1.1179 bisitz 13786: my $msg = '<p class="LC_warning">';
1.661 raeburn 13787: $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 13788: $msg .= '</p>';
1.661 raeburn 13789: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
13790: return ('file_locked',$msg);
13791: } else {
1.1179 bisitz 13792: my $msg = '<p class="LC_error">';
1.984 raeburn 13793: $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 13794: $msg .= '</p>';
1.984 raeburn 13795: return ('existingfile',$msg);
1.661 raeburn 13796: }
13797: }
13798: }
13799:
1.987 raeburn 13800: sub check_for_traversal {
13801: my ($path,$url,$toplevel) = @_;
13802: my @parts=split(/\//,$path);
13803: my $cleanpath;
13804: my $fullpath = $url;
13805: for (my $i=0;$i<@parts;$i++) {
13806: next if ($parts[$i] eq '.');
13807: if ($parts[$i] eq '..') {
13808: $fullpath =~ s{([^/]+/)$}{};
13809: } else {
13810: $fullpath .= $parts[$i].'/';
13811: }
13812: }
13813: if ($fullpath =~ /^\Q$url\E(.*)$/) {
13814: $cleanpath = $1;
13815: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
13816: my $curr_toprel = $1;
13817: my @parts = split(/\//,$curr_toprel);
13818: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
13819: my @urlparts = split(/\//,$url_toprel);
13820: my $doubledots;
13821: my $startdiff = -1;
13822: for (my $i=0; $i<@urlparts; $i++) {
13823: if ($startdiff == -1) {
13824: unless ($urlparts[$i] eq $parts[$i]) {
13825: $startdiff = $i;
13826: $doubledots .= '../';
13827: }
13828: } else {
13829: $doubledots .= '../';
13830: }
13831: }
13832: if ($startdiff > -1) {
13833: $cleanpath = $doubledots;
13834: for (my $i=$startdiff; $i<@parts; $i++) {
13835: $cleanpath .= $parts[$i].'/';
13836: }
13837: }
13838: }
13839: $cleanpath =~ s{(/)$}{};
13840: return $cleanpath;
13841: }
1.31 albertel 13842:
1.1053 raeburn 13843: sub is_archive_file {
13844: my ($mimetype) = @_;
13845: if (($mimetype eq 'application/octet-stream') ||
13846: ($mimetype eq 'application/x-stuffit') ||
13847: ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
13848: return 1;
13849: }
13850: return;
13851: }
13852:
13853: sub decompress_form {
1.1065 raeburn 13854: my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053 raeburn 13855: my %lt = &Apache::lonlocal::texthash (
13856: this => 'This file is an archive file.',
1.1067 raeburn 13857: camt => 'This file is a Camtasia archive file.',
1.1065 raeburn 13858: itsc => 'Its contents are as follows:',
1.1053 raeburn 13859: youm => 'You may wish to extract its contents.',
13860: extr => 'Extract contents',
1.1067 raeburn 13861: auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
13862: proa => 'Process automatically?',
1.1053 raeburn 13863: yes => 'Yes',
13864: no => 'No',
1.1067 raeburn 13865: fold => 'Title for folder containing movie',
13866: movi => 'Title for page containing embedded movie',
1.1053 raeburn 13867: );
1.1065 raeburn 13868: my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067 raeburn 13869: my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065 raeburn 13870: my $info = &list_archive_contents($fileloc,\@paths);
13871: if (@paths) {
13872: foreach my $path (@paths) {
13873: $path =~ s{^/}{};
1.1067 raeburn 13874: if ($path =~ m{^([^/]+)/$}) {
13875: $topdir = $1;
13876: }
1.1065 raeburn 13877: if ($path =~ m{^([^/]+)/}) {
13878: $toplevel{$1} = $path;
13879: } else {
13880: $toplevel{$path} = $path;
13881: }
13882: }
13883: }
1.1067 raeburn 13884: if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164 raeburn 13885: my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067 raeburn 13886: "$topdir/media/",
13887: "$topdir/media/$topdir.mp4",
13888: "$topdir/media/FirstFrame.png",
13889: "$topdir/media/player.swf",
13890: "$topdir/media/swfobject.js",
13891: "$topdir/media/expressInstall.swf");
1.1197 raeburn 13892: my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164 raeburn 13893: "$topdir/$topdir.mp4",
13894: "$topdir/$topdir\_config.xml",
13895: "$topdir/$topdir\_controller.swf",
13896: "$topdir/$topdir\_embed.css",
13897: "$topdir/$topdir\_First_Frame.png",
13898: "$topdir/$topdir\_player.html",
13899: "$topdir/$topdir\_Thumbnails.png",
13900: "$topdir/playerProductInstall.swf",
13901: "$topdir/scripts/",
13902: "$topdir/scripts/config_xml.js",
13903: "$topdir/scripts/handlebars.js",
13904: "$topdir/scripts/jquery-1.7.1.min.js",
13905: "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
13906: "$topdir/scripts/modernizr.js",
13907: "$topdir/scripts/player-min.js",
13908: "$topdir/scripts/swfobject.js",
13909: "$topdir/skins/",
13910: "$topdir/skins/configuration_express.xml",
13911: "$topdir/skins/express_show/",
13912: "$topdir/skins/express_show/player-min.css",
13913: "$topdir/skins/express_show/spritesheet.png");
1.1197 raeburn 13914: my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
13915: "$topdir/$topdir.mp4",
13916: "$topdir/$topdir\_config.xml",
13917: "$topdir/$topdir\_controller.swf",
13918: "$topdir/$topdir\_embed.css",
13919: "$topdir/$topdir\_First_Frame.png",
13920: "$topdir/$topdir\_player.html",
13921: "$topdir/$topdir\_Thumbnails.png",
13922: "$topdir/playerProductInstall.swf",
13923: "$topdir/scripts/",
13924: "$topdir/scripts/config_xml.js",
13925: "$topdir/scripts/techsmith-smart-player.min.js",
13926: "$topdir/skins/",
13927: "$topdir/skins/configuration_express.xml",
13928: "$topdir/skins/express_show/",
13929: "$topdir/skins/express_show/spritesheet.min.css",
13930: "$topdir/skins/express_show/spritesheet.png",
13931: "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164 raeburn 13932: my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067 raeburn 13933: if (@diffs == 0) {
1.1164 raeburn 13934: $is_camtasia = 6;
13935: } else {
1.1197 raeburn 13936: @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164 raeburn 13937: if (@diffs == 0) {
13938: $is_camtasia = 8;
1.1197 raeburn 13939: } else {
13940: @diffs = &compare_arrays(\@paths,\@camtasia8_4);
13941: if (@diffs == 0) {
13942: $is_camtasia = 8;
13943: }
1.1164 raeburn 13944: }
1.1067 raeburn 13945: }
13946: }
13947: my $output;
13948: if ($is_camtasia) {
13949: $output = <<"ENDCAM";
13950: <script type="text/javascript" language="Javascript">
13951: // <![CDATA[
13952:
13953: function camtasiaToggle() {
13954: for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
13955: if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164 raeburn 13956: if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067 raeburn 13957: document.getElementById('camtasia_titles').style.display='block';
13958: } else {
13959: document.getElementById('camtasia_titles').style.display='none';
13960: }
13961: }
13962: }
13963: return;
13964: }
13965:
13966: // ]]>
13967: </script>
13968: <p>$lt{'camt'}</p>
13969: ENDCAM
1.1065 raeburn 13970: } else {
1.1067 raeburn 13971: $output = '<p>'.$lt{'this'};
13972: if ($info eq '') {
13973: $output .= ' '.$lt{'youm'}.'</p>'."\n";
13974: } else {
13975: $output .= ' '.$lt{'itsc'}.'</p>'."\n".
13976: '<div><pre>'.$info.'</pre></div>';
13977: }
1.1065 raeburn 13978: }
1.1067 raeburn 13979: $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065 raeburn 13980: my $duplicates;
13981: my $num = 0;
13982: if (ref($dirlist) eq 'ARRAY') {
13983: foreach my $item (@{$dirlist}) {
13984: if (ref($item) eq 'ARRAY') {
13985: if (exists($toplevel{$item->[0]})) {
13986: $duplicates .=
13987: &start_data_table_row().
13988: '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
13989: 'value="0" checked="checked" />'.&mt('No').'</label>'.
13990: ' <label><input type="radio" name="archive_overwrite_'.$num.'" '.
13991: 'value="1" />'.&mt('Yes').'</label>'.
13992: '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
13993: '<td>'.$item->[0].'</td>';
13994: if ($item->[2]) {
13995: $duplicates .= '<td>'.&mt('Directory').'</td>';
13996: } else {
13997: $duplicates .= '<td>'.&mt('File').'</td>';
13998: }
13999: $duplicates .= '<td>'.$item->[3].'</td>'.
14000: '<td>'.
14001: &Apache::lonlocal::locallocaltime($item->[4]).
14002: '</td>'.
14003: &end_data_table_row();
14004: $num ++;
14005: }
14006: }
14007: }
14008: }
14009: my $itemcount;
14010: if (@paths > 0) {
14011: $itemcount = scalar(@paths);
14012: } else {
14013: $itemcount = 1;
14014: }
1.1067 raeburn 14015: if ($is_camtasia) {
14016: $output .= $lt{'auto'}.'<br />'.
14017: '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164 raeburn 14018: '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067 raeburn 14019: $lt{'yes'}.'</label> <label>'.
14020: '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
14021: $lt{'no'}.'</label></span><br />'.
14022: '<div id="camtasia_titles" style="display:block">'.
14023: &Apache::lonhtmlcommon::start_pick_box().
14024: &Apache::lonhtmlcommon::row_title($lt{'fold'}).
14025: '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
14026: &Apache::lonhtmlcommon::row_closure().
14027: &Apache::lonhtmlcommon::row_title($lt{'movi'}).
14028: '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
14029: &Apache::lonhtmlcommon::row_closure(1).
14030: &Apache::lonhtmlcommon::end_pick_box().
14031: '</div>';
14032: }
1.1065 raeburn 14033: $output .=
14034: '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067 raeburn 14035: '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
14036: "\n";
1.1065 raeburn 14037: if ($duplicates ne '') {
14038: $output .= '<p><span class="LC_warning">'.
14039: &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.
14040: &start_data_table().
14041: &start_data_table_header_row().
14042: '<th>'.&mt('Overwrite?').'</th>'.
14043: '<th>'.&mt('Name').'</th>'.
14044: '<th>'.&mt('Type').'</th>'.
14045: '<th>'.&mt('Size').'</th>'.
14046: '<th>'.&mt('Last modified').'</th>'.
14047: &end_data_table_header_row().
14048: $duplicates.
14049: &end_data_table().
14050: '</p>';
14051: }
1.1067 raeburn 14052: $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053 raeburn 14053: if (ref($hiddenelements) eq 'HASH') {
14054: foreach my $hidden (sort(keys(%{$hiddenelements}))) {
14055: $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
14056: }
14057: }
14058: $output .= <<"END";
1.1067 raeburn 14059: <br />
1.1053 raeburn 14060: <input type="submit" name="decompress" value="$lt{'extr'}" />
14061: </form>
14062: $noextract
14063: END
14064: return $output;
14065: }
14066:
1.1065 raeburn 14067: sub decompression_utility {
14068: my ($program) = @_;
14069: my @utilities = ('tar','gunzip','bunzip2','unzip');
14070: my $location;
14071: if (grep(/^\Q$program\E$/,@utilities)) {
14072: foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
14073: '/usr/sbin/') {
14074: if (-x $dir.$program) {
14075: $location = $dir.$program;
14076: last;
14077: }
14078: }
14079: }
14080: return $location;
14081: }
14082:
14083: sub list_archive_contents {
14084: my ($file,$pathsref) = @_;
14085: my (@cmd,$output);
14086: my $needsregexp;
14087: if ($file =~ /\.zip$/) {
14088: @cmd = (&decompression_utility('unzip'),"-l");
14089: $needsregexp = 1;
14090: } elsif (($file =~ m/\.tar\.gz$/) ||
14091: ($file =~ /\.tgz$/)) {
14092: @cmd = (&decompression_utility('tar'),"-ztf");
14093: } elsif ($file =~ /\.tar\.bz2$/) {
14094: @cmd = (&decompression_utility('tar'),"-jtf");
14095: } elsif ($file =~ m|\.tar$|) {
14096: @cmd = (&decompression_utility('tar'),"-tf");
14097: }
14098: if (@cmd) {
14099: undef($!);
14100: undef($@);
14101: if (open(my $fh,"-|", @cmd, $file)) {
14102: while (my $line = <$fh>) {
14103: $output .= $line;
14104: chomp($line);
14105: my $item;
14106: if ($needsregexp) {
14107: ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/);
14108: } else {
14109: $item = $line;
14110: }
14111: if ($item ne '') {
14112: unless (grep(/^\Q$item\E$/,@{$pathsref})) {
14113: push(@{$pathsref},$item);
14114: }
14115: }
14116: }
14117: close($fh);
14118: }
14119: }
14120: return $output;
14121: }
14122:
1.1053 raeburn 14123: sub decompress_uploaded_file {
14124: my ($file,$dir) = @_;
14125: &Apache::lonnet::appenv({'cgi.file' => $file});
14126: &Apache::lonnet::appenv({'cgi.dir' => $dir});
14127: my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
14128: my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
14129: my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
14130: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
14131: my $decompressed = $env{'cgi.decompressed'};
14132: &Apache::lonnet::delenv('cgi.file');
14133: &Apache::lonnet::delenv('cgi.dir');
14134: &Apache::lonnet::delenv('cgi.decompressed');
14135: return ($decompressed,$result);
14136: }
14137:
1.1055 raeburn 14138: sub process_decompression {
14139: my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292 raeburn 14140: unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
14141: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14142: &mt('Unexpected file path.').'</p>'."\n";
14143: }
14144: unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
14145: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14146: &mt('Unexpected course context.').'</p>'."\n";
14147: }
1.1293 raeburn 14148: unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292 raeburn 14149: return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14150: &mt('Filename contained unexpected characters.').'</p>'."\n";
14151: }
1.1055 raeburn 14152: my ($dir,$error,$warning,$output);
1.1180 raeburn 14153: if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120 bisitz 14154: $error = &mt('Filename not a supported archive file type.').
14155: '<br />'.&mt('Filename should end with one of: [_1].',
1.1055 raeburn 14156: '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
14157: } else {
14158: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14159: if ($docuhome eq 'no_host') {
14160: $error = &mt('Could not determine home server for course.');
14161: } else {
14162: my @ids=&Apache::lonnet::current_machine_ids();
14163: my $currdir = "$dir_root/$destination";
14164: if (grep(/^\Q$docuhome\E$/,@ids)) {
14165: $dir = &LONCAPA::propath($docudom,$docuname).
14166: "$dir_root/$destination";
14167: } else {
14168: $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
14169: "$dir_root/$docudom/$docuname/$destination";
14170: unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
14171: $error = &mt('Archive file not found.');
14172: }
14173: }
1.1065 raeburn 14174: my (@to_overwrite,@to_skip);
14175: if ($env{'form.archive_overwrite_total'} > 0) {
14176: my $total = $env{'form.archive_overwrite_total'};
14177: for (my $i=0; $i<$total; $i++) {
14178: if ($env{'form.archive_overwrite_'.$i} == 1) {
14179: push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
14180: } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
14181: push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
14182: }
14183: }
14184: }
14185: my $numskip = scalar(@to_skip);
1.1292 raeburn 14186: my $numoverwrite = scalar(@to_overwrite);
14187: if (($numskip) && (!$numoverwrite)) {
1.1065 raeburn 14188: $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');
14189: } elsif ($dir eq '') {
1.1055 raeburn 14190: $error = &mt('Directory containing archive file unavailable.');
14191: } elsif (!$error) {
1.1065 raeburn 14192: my ($decompressed,$display);
1.1292 raeburn 14193: if (($numskip) || ($numoverwrite)) {
1.1065 raeburn 14194: my $tempdir = time.'_'.$$.int(rand(10000));
14195: mkdir("$dir/$tempdir",0755);
1.1292 raeburn 14196: if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
14197: ($decompressed,$display) =
14198: &decompress_uploaded_file($file,"$dir/$tempdir");
14199: foreach my $item (@to_skip) {
14200: if (($item ne '') && ($item !~ /\.\./)) {
14201: if (-f "$dir/$tempdir/$item") {
14202: unlink("$dir/$tempdir/$item");
14203: } elsif (-d "$dir/$tempdir/$item") {
1.1300 raeburn 14204: &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292 raeburn 14205: }
14206: }
14207: }
14208: foreach my $item (@to_overwrite) {
14209: if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
14210: if (($item ne '') && ($item !~ /\.\./)) {
14211: if (-f "$dir/$item") {
14212: unlink("$dir/$item");
14213: } elsif (-d "$dir/$item") {
1.1300 raeburn 14214: &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292 raeburn 14215: }
14216: &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
14217: }
1.1065 raeburn 14218: }
14219: }
1.1292 raeburn 14220: if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300 raeburn 14221: &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292 raeburn 14222: }
1.1065 raeburn 14223: }
14224: } else {
14225: ($decompressed,$display) =
14226: &decompress_uploaded_file($file,$dir);
14227: }
1.1055 raeburn 14228: if ($decompressed eq 'ok') {
1.1065 raeburn 14229: $output = '<p class="LC_info">'.
14230: &mt('Files extracted successfully from archive.').
14231: '</p>'."\n";
1.1055 raeburn 14232: my ($warning,$result,@contents);
14233: my ($newdirlistref,$newlisterror) =
14234: &Apache::lonnet::dirlist($currdir,$docudom,
14235: $docuname,1);
14236: my (%is_dir,%changes,@newitems);
14237: my $dirptr = 16384;
1.1065 raeburn 14238: if (ref($newdirlistref) eq 'ARRAY') {
1.1055 raeburn 14239: foreach my $dir_line (@{$newdirlistref}) {
14240: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292 raeburn 14241: unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055 raeburn 14242: push(@newitems,$item);
14243: if ($dirptr&$testdir) {
14244: $is_dir{$item} = 1;
14245: }
14246: $changes{$item} = 1;
14247: }
14248: }
14249: }
14250: if (keys(%changes) > 0) {
14251: foreach my $item (sort(@newitems)) {
14252: if ($changes{$item}) {
14253: push(@contents,$item);
14254: }
14255: }
14256: }
14257: if (@contents > 0) {
1.1067 raeburn 14258: my $wantform;
14259: unless ($env{'form.autoextract_camtasia'}) {
14260: $wantform = 1;
14261: }
1.1056 raeburn 14262: my (%children,%parent,%dirorder,%titles);
1.1055 raeburn 14263: my ($count,$datatable) = &get_extracted($docudom,$docuname,
14264: $currdir,\%is_dir,
14265: \%children,\%parent,
1.1056 raeburn 14266: \@contents,\%dirorder,
14267: \%titles,$wantform);
1.1055 raeburn 14268: if ($datatable ne '') {
14269: $output .= &archive_options_form('decompressed',$datatable,
14270: $count,$hiddenelem);
1.1065 raeburn 14271: my $startcount = 6;
1.1055 raeburn 14272: $output .= &archive_javascript($startcount,$count,
1.1056 raeburn 14273: \%titles,\%children);
1.1055 raeburn 14274: }
1.1067 raeburn 14275: if ($env{'form.autoextract_camtasia'}) {
1.1164 raeburn 14276: my $version = $env{'form.autoextract_camtasia'};
1.1067 raeburn 14277: my %displayed;
14278: my $total = 1;
14279: $env{'form.archive_directory'} = [];
14280: foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
14281: my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
14282: $path =~ s{/$}{};
14283: my $item;
14284: if ($path ne '') {
14285: $item = "$path/$titles{$i}";
14286: } else {
14287: $item = $titles{$i};
14288: }
14289: $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
14290: if ($item eq $contents[0]) {
14291: push(@{$env{'form.archive_directory'}},$i);
14292: $env{'form.archive_'.$i} = 'display';
14293: $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
14294: $displayed{'folder'} = $i;
1.1164 raeburn 14295: } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
14296: (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067 raeburn 14297: $env{'form.archive_'.$i} = 'display';
14298: $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
14299: $displayed{'web'} = $i;
14300: } else {
1.1164 raeburn 14301: if ((($item eq "$contents[0]/media") && ($version == 6)) ||
14302: ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
14303: ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067 raeburn 14304: push(@{$env{'form.archive_directory'}},$i);
14305: }
14306: $env{'form.archive_'.$i} = 'dependency';
14307: }
14308: $total ++;
14309: }
14310: for (my $i=1; $i<$total; $i++) {
14311: next if ($i == $displayed{'web'});
14312: next if ($i == $displayed{'folder'});
14313: $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
14314: }
14315: $env{'form.phase'} = 'decompress_cleanup';
14316: $env{'form.archivedelete'} = 1;
14317: $env{'form.archive_count'} = $total-1;
14318: $output .=
14319: &process_extracted_files('coursedocs',$docudom,
14320: $docuname,$destination,
14321: $dir_root,$hiddenelem);
14322: }
1.1055 raeburn 14323: } else {
14324: $warning = &mt('No new items extracted from archive file.');
14325: }
14326: } else {
14327: $output = $display;
14328: $error = &mt('An error occurred during extraction from the archive file.');
14329: }
14330: }
14331: }
14332: }
14333: if ($error) {
14334: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
14335: $error.'</p>'."\n";
14336: }
14337: if ($warning) {
14338: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
14339: }
14340: return $output;
14341: }
14342:
14343: sub get_extracted {
1.1056 raeburn 14344: my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
14345: $titles,$wantform) = @_;
1.1055 raeburn 14346: my $count = 0;
14347: my $depth = 0;
14348: my $datatable;
1.1056 raeburn 14349: my @hierarchy;
1.1055 raeburn 14350: return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056 raeburn 14351: (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
14352: (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055 raeburn 14353: foreach my $item (@{$contents}) {
14354: $count ++;
1.1056 raeburn 14355: @{$dirorder->{$count}} = @hierarchy;
14356: $titles->{$count} = $item;
1.1055 raeburn 14357: &archive_hierarchy($depth,$count,$parent,$children);
14358: if ($wantform) {
14359: $datatable .= &archive_row($is_dir->{$item},$item,
14360: $currdir,$depth,$count);
14361: }
14362: if ($is_dir->{$item}) {
14363: $depth ++;
1.1056 raeburn 14364: push(@hierarchy,$count);
14365: $parent->{$depth} = $count;
1.1055 raeburn 14366: $datatable .=
14367: &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056 raeburn 14368: \$depth,\$count,\@hierarchy,$dirorder,
14369: $children,$parent,$titles,$wantform);
1.1055 raeburn 14370: $depth --;
1.1056 raeburn 14371: pop(@hierarchy);
1.1055 raeburn 14372: }
14373: }
14374: return ($count,$datatable);
14375: }
14376:
14377: sub recurse_extracted_archive {
1.1056 raeburn 14378: my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
14379: $children,$parent,$titles,$wantform) = @_;
1.1055 raeburn 14380: my $result='';
1.1056 raeburn 14381: unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
14382: (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
14383: (ref($dirorder) eq 'HASH')) {
1.1055 raeburn 14384: return $result;
14385: }
14386: my $dirptr = 16384;
14387: my ($newdirlistref,$newlisterror) =
14388: &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
14389: if (ref($newdirlistref) eq 'ARRAY') {
14390: foreach my $dir_line (@{$newdirlistref}) {
14391: my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
14392: unless ($item =~ /^\.+$/) {
14393: $$count ++;
1.1056 raeburn 14394: @{$dirorder->{$$count}} = @{$hierarchy};
14395: $titles->{$$count} = $item;
1.1055 raeburn 14396: &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056 raeburn 14397:
1.1055 raeburn 14398: my $is_dir;
14399: if ($dirptr&$testdir) {
14400: $is_dir = 1;
14401: }
14402: if ($wantform) {
14403: $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
14404: }
14405: if ($is_dir) {
14406: $$depth ++;
1.1056 raeburn 14407: push(@{$hierarchy},$$count);
14408: $parent->{$$depth} = $$count;
1.1055 raeburn 14409: $result .=
14410: &recurse_extracted_archive("$currdir/$item",$docudom,
14411: $docuname,$depth,$count,
1.1056 raeburn 14412: $hierarchy,$dirorder,$children,
14413: $parent,$titles,$wantform);
1.1055 raeburn 14414: $$depth --;
1.1056 raeburn 14415: pop(@{$hierarchy});
1.1055 raeburn 14416: }
14417: }
14418: }
14419: }
14420: return $result;
14421: }
14422:
14423: sub archive_hierarchy {
14424: my ($depth,$count,$parent,$children) =@_;
14425: if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
14426: if (exists($parent->{$depth})) {
14427: $children->{$parent->{$depth}} .= $count.':';
14428: }
14429: }
14430: return;
14431: }
14432:
14433: sub archive_row {
14434: my ($is_dir,$item,$currdir,$depth,$count) = @_;
14435: my ($name) = ($item =~ m{([^/]+)$});
14436: my %choices = &Apache::lonlocal::texthash (
1.1059 raeburn 14437: 'display' => 'Add as file',
1.1055 raeburn 14438: 'dependency' => 'Include as dependency',
14439: 'discard' => 'Discard',
14440: );
14441: if ($is_dir) {
1.1059 raeburn 14442: $choices{'display'} = &mt('Add as folder');
1.1055 raeburn 14443: }
1.1056 raeburn 14444: my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
14445: my $offset = 0;
1.1055 raeburn 14446: foreach my $action ('display','dependency','discard') {
1.1056 raeburn 14447: $offset ++;
1.1065 raeburn 14448: if ($action ne 'display') {
14449: $offset ++;
14450: }
1.1055 raeburn 14451: $output .= '<td><span class="LC_nobreak">'.
14452: '<label><input type="radio" name="archive_'.$count.
14453: '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
14454: my $text = $choices{$action};
14455: if ($is_dir) {
14456: $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
14457: if ($action eq 'display') {
1.1059 raeburn 14458: $text = &mt('Add as folder');
1.1055 raeburn 14459: }
1.1056 raeburn 14460: } else {
14461: $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
14462:
14463: }
14464: $output .= ' /> '.$choices{$action}.'</label></span>';
14465: if ($action eq 'dependency') {
14466: $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
14467: &mt('Used by:').' <select name="archive_dependent_on_'.$count.'" '.
14468: 'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
14469: '<option value=""></option>'."\n".
14470: '</select>'."\n".
14471: '</div>';
1.1059 raeburn 14472: } elsif ($action eq 'display') {
14473: $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
14474: &mt('Title:').' <input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
14475: '</div>';
1.1055 raeburn 14476: }
1.1056 raeburn 14477: $output .= '</td>';
1.1055 raeburn 14478: }
14479: $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
14480: &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.(' ' x 2);
14481: for (my $i=0; $i<$depth; $i++) {
14482: $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
14483: }
14484: if ($is_dir) {
14485: $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n".
14486: '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
14487: } else {
14488: $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
14489: }
14490: $output .= ' '.$name.'</td>'."\n".
14491: &end_data_table_row();
14492: return $output;
14493: }
14494:
14495: sub archive_options_form {
1.1065 raeburn 14496: my ($form,$display,$count,$hiddenelem) = @_;
14497: my %lt = &Apache::lonlocal::texthash(
14498: perm => 'Permanently remove archive file?',
14499: hows => 'How should each extracted item be incorporated in the course?',
14500: cont => 'Content actions for all',
14501: addf => 'Add as folder/file',
14502: incd => 'Include as dependency for a displayed file',
14503: disc => 'Discard',
14504: no => 'No',
14505: yes => 'Yes',
14506: save => 'Save',
14507: );
14508: my $output = <<"END";
14509: <form name="$form" method="post" action="">
14510: <p><span class="LC_nobreak">$lt{'perm'}
14511: <label>
14512: <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
14513: </label>
14514:
14515: <label>
14516: <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
14517: </span>
14518: </p>
14519: <input type="hidden" name="phase" value="decompress_cleanup" />
14520: <br />$lt{'hows'}
14521: <div class="LC_columnSection">
14522: <fieldset>
14523: <legend>$lt{'cont'}</legend>
14524: <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" />
14525: <input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
14526: <input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
14527: </fieldset>
14528: </div>
14529: END
14530: return $output.
1.1055 raeburn 14531: &start_data_table()."\n".
1.1065 raeburn 14532: $display."\n".
1.1055 raeburn 14533: &end_data_table()."\n".
14534: '<input type="hidden" name="archive_count" value="'.$count.'" />'.
14535: $hiddenelem.
1.1065 raeburn 14536: '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055 raeburn 14537: '</form>';
14538: }
14539:
14540: sub archive_javascript {
1.1056 raeburn 14541: my ($startcount,$numitems,$titles,$children) = @_;
14542: return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059 raeburn 14543: my $maintitle = $env{'form.comment'};
1.1055 raeburn 14544: my $scripttag = <<START;
14545: <script type="text/javascript">
14546: // <![CDATA[
14547:
14548: function checkAll(form,prefix) {
14549: var idstr = new RegExp("^archive_"+prefix+"_\\\\d+\$");
14550: for (var i=0; i < form.elements.length; i++) {
14551: var id = form.elements[i].id;
14552: if ((id != '') && (id != undefined)) {
14553: if (idstr.test(id)) {
14554: if (form.elements[i].type == 'radio') {
14555: form.elements[i].checked = true;
1.1056 raeburn 14556: var nostart = i-$startcount;
1.1059 raeburn 14557: var offset = nostart%7;
14558: var count = (nostart-offset)/7;
1.1056 raeburn 14559: dependencyCheck(form,count,offset);
1.1055 raeburn 14560: }
14561: }
14562: }
14563: }
14564: }
14565:
14566: function propagateCheck(form,count) {
14567: if (count > 0) {
1.1059 raeburn 14568: var startelement = $startcount + ((count-1) * 7);
14569: for (var j=1; j<6; j++) {
14570: if ((j != 2) && (j != 4)) {
1.1056 raeburn 14571: var item = startelement + j;
14572: if (form.elements[item].type == 'radio') {
14573: if (form.elements[item].checked) {
14574: containerCheck(form,count,j);
14575: break;
14576: }
1.1055 raeburn 14577: }
14578: }
14579: }
14580: }
14581: }
14582:
14583: numitems = $numitems
1.1056 raeburn 14584: var titles = new Array(numitems);
14585: var parents = new Array(numitems);
1.1055 raeburn 14586: for (var i=0; i<numitems; i++) {
1.1056 raeburn 14587: parents[i] = new Array;
1.1055 raeburn 14588: }
1.1059 raeburn 14589: var maintitle = '$maintitle';
1.1055 raeburn 14590:
14591: START
14592:
1.1056 raeburn 14593: foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
14594: my @contents = split(/:/,$children->{$container});
1.1055 raeburn 14595: for (my $i=0; $i<@contents; $i ++) {
14596: $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
14597: }
14598: }
14599:
1.1056 raeburn 14600: foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
14601: $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
14602: }
14603:
1.1055 raeburn 14604: $scripttag .= <<END;
14605:
14606: function containerCheck(form,count,offset) {
14607: if (count > 0) {
1.1056 raeburn 14608: dependencyCheck(form,count,offset);
1.1059 raeburn 14609: var item = (offset+$startcount)+7*(count-1);
1.1055 raeburn 14610: form.elements[item].checked = true;
14611: if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
14612: if (parents[count].length > 0) {
14613: for (var j=0; j<parents[count].length; j++) {
1.1056 raeburn 14614: containerCheck(form,parents[count][j],offset);
14615: }
14616: }
14617: }
14618: }
14619: }
14620:
14621: function dependencyCheck(form,count,offset) {
14622: if (count > 0) {
1.1059 raeburn 14623: var chosen = (offset+$startcount)+7*(count-1);
14624: var depitem = $startcount + ((count-1) * 7) + 4;
1.1056 raeburn 14625: var currtype = form.elements[depitem].type;
14626: if (form.elements[chosen].value == 'dependency') {
14627: document.getElementById('arc_depon_'+count).style.display='block';
14628: form.elements[depitem].options.length = 0;
14629: form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085 raeburn 14630: for (var i=1; i<=numitems; i++) {
14631: if (i == count) {
14632: continue;
14633: }
1.1059 raeburn 14634: var startelement = $startcount + (i-1) * 7;
14635: for (var j=1; j<6; j++) {
14636: if ((j != 2) && (j!= 4)) {
1.1056 raeburn 14637: var item = startelement + j;
14638: if (form.elements[item].type == 'radio') {
14639: if (form.elements[item].checked) {
14640: if (form.elements[item].value == 'display') {
14641: var n = form.elements[depitem].options.length;
14642: form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
14643: }
14644: }
14645: }
14646: }
14647: }
14648: }
14649: } else {
14650: document.getElementById('arc_depon_'+count).style.display='none';
14651: form.elements[depitem].options.length = 0;
14652: form.elements[depitem].options[0] = new Option('Select','',true,true);
14653: }
1.1059 raeburn 14654: titleCheck(form,count,offset);
1.1056 raeburn 14655: }
14656: }
14657:
14658: function propagateSelect(form,count,offset) {
14659: if (count > 0) {
1.1065 raeburn 14660: var item = (1+offset+$startcount)+7*(count-1);
1.1056 raeburn 14661: var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
14662: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14663: if (parents[count].length > 0) {
14664: for (var j=0; j<parents[count].length; j++) {
14665: containerSelect(form,parents[count][j],offset,picked);
1.1055 raeburn 14666: }
14667: }
14668: }
14669: }
14670: }
1.1056 raeburn 14671:
14672: function containerSelect(form,count,offset,picked) {
14673: if (count > 0) {
1.1065 raeburn 14674: var item = (offset+$startcount)+7*(count-1);
1.1056 raeburn 14675: if (form.elements[item].type == 'radio') {
14676: if (form.elements[item].value == 'dependency') {
14677: if (form.elements[item+1].type == 'select-one') {
14678: for (var i=0; i<form.elements[item+1].options.length; i++) {
14679: if (form.elements[item+1].options[i].value == picked) {
14680: form.elements[item+1].selectedIndex = i;
14681: break;
14682: }
14683: }
14684: }
14685: if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
14686: if (parents[count].length > 0) {
14687: for (var j=0; j<parents[count].length; j++) {
14688: containerSelect(form,parents[count][j],offset,picked);
14689: }
14690: }
14691: }
14692: }
14693: }
14694: }
14695: }
14696:
1.1059 raeburn 14697: function titleCheck(form,count,offset) {
14698: if (count > 0) {
14699: var chosen = (offset+$startcount)+7*(count-1);
14700: var depitem = $startcount + ((count-1) * 7) + 2;
14701: var currtype = form.elements[depitem].type;
14702: if (form.elements[chosen].value == 'display') {
14703: document.getElementById('arc_title_'+count).style.display='block';
14704: if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
14705: document.getElementById('archive_title_'+count).value=maintitle;
14706: }
14707: } else {
14708: document.getElementById('arc_title_'+count).style.display='none';
14709: if (currtype == 'text') {
14710: document.getElementById('archive_title_'+count).value='';
14711: }
14712: }
14713: }
14714: return;
14715: }
14716:
1.1055 raeburn 14717: // ]]>
14718: </script>
14719: END
14720: return $scripttag;
14721: }
14722:
14723: sub process_extracted_files {
1.1067 raeburn 14724: my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055 raeburn 14725: my $numitems = $env{'form.archive_count'};
1.1294 raeburn 14726: return if ((!$numitems) || ($numitems =~ /\D/));
1.1055 raeburn 14727: my @ids=&Apache::lonnet::current_machine_ids();
14728: my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067 raeburn 14729: %folders,%containers,%mapinner,%prompttofetch);
1.1055 raeburn 14730: my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
14731: if (grep(/^\Q$docuhome\E$/,@ids)) {
14732: $prefix = &LONCAPA::propath($docudom,$docuname);
14733: $pathtocheck = "$dir_root/$destination";
14734: $dir = $dir_root;
14735: $ishome = 1;
14736: } else {
14737: $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
14738: $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294 raeburn 14739: $dir = "$dir_root/$docudom/$docuname";
1.1055 raeburn 14740: }
14741: my $currdir = "$dir_root/$destination";
14742: (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
14743: if ($env{'form.folderpath'}) {
14744: my @items = split('&',$env{'form.folderpath'});
14745: $folders{'0'} = $items[-2];
1.1099 raeburn 14746: if ($env{'form.folderpath'} =~ /\:1$/) {
14747: $containers{'0'}='page';
14748: } else {
14749: $containers{'0'}='sequence';
14750: }
1.1055 raeburn 14751: }
14752: my @archdirs = &get_env_multiple('form.archive_directory');
14753: if ($numitems) {
14754: for (my $i=1; $i<=$numitems; $i++) {
14755: my $path = $env{'form.archive_content_'.$i};
14756: if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
14757: my $item = $1;
14758: $toplevelitems{$item} = $i;
14759: if (grep(/^\Q$i\E$/,@archdirs)) {
14760: $is_dir{$item} = 1;
14761: }
14762: }
14763: }
14764: }
1.1067 raeburn 14765: my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055 raeburn 14766: if (keys(%toplevelitems) > 0) {
14767: my @contents = sort(keys(%toplevelitems));
1.1056 raeburn 14768: (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
14769: \%parent,\@contents,\%dirorder,\%titles);
1.1055 raeburn 14770: }
1.1066 raeburn 14771: my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055 raeburn 14772: if ($numitems) {
14773: for (my $i=1; $i<=$numitems; $i++) {
1.1086 raeburn 14774: next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055 raeburn 14775: my $path = $env{'form.archive_content_'.$i};
14776: if ($path =~ /^\Q$pathtocheck\E/) {
14777: if ($env{'form.archive_'.$i} eq 'discard') {
14778: if ($prefix ne '' && $path ne '') {
14779: if (-e $prefix.$path) {
1.1066 raeburn 14780: if ((@archdirs > 0) &&
14781: (grep(/^\Q$i\E$/,@archdirs))) {
14782: $todeletedir{$prefix.$path} = 1;
14783: } else {
14784: $todelete{$prefix.$path} = 1;
14785: }
1.1055 raeburn 14786: }
14787: }
14788: } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059 raeburn 14789: my ($docstitle,$title,$url,$outer);
1.1055 raeburn 14790: ($title) = ($path =~ m{/([^/]+)$});
1.1059 raeburn 14791: $docstitle = $env{'form.archive_title_'.$i};
14792: if ($docstitle eq '') {
14793: $docstitle = $title;
14794: }
1.1055 raeburn 14795: $outer = 0;
1.1056 raeburn 14796: if (ref($dirorder{$i}) eq 'ARRAY') {
14797: if (@{$dirorder{$i}} > 0) {
14798: foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055 raeburn 14799: if ($env{'form.archive_'.$item} eq 'display') {
14800: $outer = $item;
14801: last;
14802: }
14803: }
14804: }
14805: }
14806: my ($errtext,$fatal) =
14807: &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
14808: '/'.$folders{$outer}.'.'.
14809: $containers{$outer});
14810: next if ($fatal);
14811: if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
14812: if ($context eq 'coursedocs') {
1.1056 raeburn 14813: $mapinner{$i} = time;
1.1055 raeburn 14814: $folders{$i} = 'default_'.$mapinner{$i};
14815: $containers{$i} = 'sequence';
14816: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14817: $folders{$i}.'.'.$containers{$i};
14818: my $newidx = &LONCAPA::map::getresidx();
14819: $LONCAPA::map::resources[$newidx]=
1.1059 raeburn 14820: $docstitle.':'.$url.':false:normal:res';
1.1055 raeburn 14821: push(@LONCAPA::map::order,$newidx);
14822: my ($outtext,$errtext) =
14823: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14824: $docuname.'/'.$folders{$outer}.
1.1087 raeburn 14825: '.'.$containers{$outer},1,1);
1.1056 raeburn 14826: $newseqid{$i} = $newidx;
1.1067 raeburn 14827: unless ($errtext) {
1.1294 raeburn 14828: $result .= '<li>'.&mt('Folder: [_1] added to course',
14829: &HTML::Entities::encode($docstitle,'<>&"')).
14830: '</li>'."\n";
1.1067 raeburn 14831: }
1.1055 raeburn 14832: }
14833: } else {
14834: if ($context eq 'coursedocs') {
14835: my $newidx=&LONCAPA::map::getresidx();
14836: my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
14837: $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
14838: $title;
1.1392 raeburn 14839: if (($outer !~ /\D/) &&
14840: (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
14841: ($newidx !~ /\D/)) {
1.1294 raeburn 14842: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
14843: mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
14844: }
14845: if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14846: mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
14847: }
14848: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
14849: if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
14850: $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
14851: unless ($ishome) {
14852: my $fetch = "$newdest{$i}/$title";
14853: $fetch =~ s/^\Q$prefix$dir\E//;
14854: $prompttofetch{$fetch} = 1;
14855: }
1.1292 raeburn 14856: }
1.1067 raeburn 14857: }
1.1294 raeburn 14858: $LONCAPA::map::resources[$newidx]=
14859: $docstitle.':'.$url.':false:normal:res';
14860: push(@LONCAPA::map::order, $newidx);
14861: my ($outtext,$errtext)=
14862: &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
14863: $docuname.'/'.$folders{$outer}.
14864: '.'.$containers{$outer},1,1);
14865: unless ($errtext) {
14866: if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
14867: $result .= '<li>'.&mt('File: [_1] added to course',
14868: &HTML::Entities::encode($docstitle,'<>&"')).
14869: '</li>'."\n";
14870: }
1.1067 raeburn 14871: }
1.1294 raeburn 14872: } else {
14873: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14874: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296 raeburn 14875: }
1.1055 raeburn 14876: }
14877: }
1.1086 raeburn 14878: }
14879: } else {
1.1294 raeburn 14880: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
14881: &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1086 raeburn 14882: }
14883: }
14884: for (my $i=1; $i<=$numitems; $i++) {
14885: next unless ($env{'form.archive_'.$i} eq 'dependency');
14886: my $path = $env{'form.archive_content_'.$i};
14887: if ($path =~ /^\Q$pathtocheck\E/) {
14888: my ($title) = ($path =~ m{/([^/]+)$});
14889: $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
14890: if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
14891: if (ref($dirorder{$i}) eq 'ARRAY') {
14892: my ($itemidx,$fullpath,$relpath);
14893: if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
14894: my $container = $dirorder{$referrer{$i}}->[-1];
1.1056 raeburn 14895: for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086 raeburn 14896: if ($dirorder{$i}->[$j] eq $container) {
14897: $itemidx = $j;
1.1056 raeburn 14898: }
14899: }
1.1086 raeburn 14900: }
14901: if ($itemidx eq '') {
14902: $itemidx = 0;
14903: }
14904: if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
14905: if ($mapinner{$referrer{$i}}) {
14906: $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
14907: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14908: if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14909: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14910: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14911: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14912: if (!-e $fullpath) {
14913: mkdir($fullpath,0755);
1.1056 raeburn 14914: }
14915: }
1.1086 raeburn 14916: } else {
14917: last;
1.1056 raeburn 14918: }
1.1086 raeburn 14919: }
14920: }
14921: } elsif ($newdest{$referrer{$i}}) {
14922: $fullpath = $newdest{$referrer{$i}};
14923: for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
14924: if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
14925: $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
14926: last;
14927: } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
14928: unless (defined($newseqid{$dirorder{$i}->[$j]})) {
14929: $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
14930: $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
14931: if (!-e $fullpath) {
14932: mkdir($fullpath,0755);
1.1056 raeburn 14933: }
14934: }
1.1086 raeburn 14935: } else {
14936: last;
1.1056 raeburn 14937: }
1.1055 raeburn 14938: }
14939: }
1.1086 raeburn 14940: if ($fullpath ne '') {
14941: if (-e "$prefix$path") {
1.1292 raeburn 14942: unless (rename("$prefix$path","$fullpath/$title")) {
14943: $warning .= &mt('Failed to rename dependency').'<br />';
14944: }
1.1086 raeburn 14945: }
14946: if (-e "$fullpath/$title") {
14947: my $showpath;
14948: if ($relpath ne '') {
14949: $showpath = "$relpath/$title";
14950: } else {
14951: $showpath = "/$title";
14952: }
1.1294 raeburn 14953: $result .= '<li>'.&mt('[_1] included as a dependency',
14954: &HTML::Entities::encode($showpath,'<>&"')).
14955: '</li>'."\n";
1.1292 raeburn 14956: unless ($ishome) {
14957: my $fetch = "$fullpath/$title";
14958: $fetch =~ s/^\Q$prefix$dir\E//;
14959: $prompttofetch{$fetch} = 1;
14960: }
1.1086 raeburn 14961: }
14962: }
1.1055 raeburn 14963: }
1.1086 raeburn 14964: } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
14965: $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294 raeburn 14966: &HTML::Entities::encode($path,'<>&"'),
14967: &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
14968: '<br />';
1.1055 raeburn 14969: }
14970: } else {
1.1294 raeburn 14971: $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296 raeburn 14972: &HTML::Entities::encode($path)).'<br />';
1.1055 raeburn 14973: }
14974: }
14975: if (keys(%todelete)) {
14976: foreach my $key (keys(%todelete)) {
14977: unlink($key);
1.1066 raeburn 14978: }
14979: }
14980: if (keys(%todeletedir)) {
14981: foreach my $key (keys(%todeletedir)) {
14982: rmdir($key);
14983: }
14984: }
14985: foreach my $dir (sort(keys(%is_dir))) {
14986: if (($pathtocheck ne '') && ($dir ne '')) {
14987: &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055 raeburn 14988: }
14989: }
1.1067 raeburn 14990: if ($result ne '') {
14991: $output .= '<ul>'."\n".
14992: $result."\n".
14993: '</ul>';
14994: }
14995: unless ($ishome) {
14996: my $replicationfail;
14997: foreach my $item (keys(%prompttofetch)) {
14998: my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
14999: unless ($fetchresult eq 'ok') {
15000: $replicationfail .= '<li>'.$item.'</li>'."\n";
15001: }
15002: }
15003: if ($replicationfail) {
15004: $output .= '<p class="LC_error">'.
15005: &mt('Course home server failed to retrieve:').'<ul>'.
15006: $replicationfail.
15007: '</ul></p>';
15008: }
15009: }
1.1055 raeburn 15010: } else {
15011: $warning = &mt('No items found in archive.');
15012: }
15013: if ($error) {
15014: $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
15015: $error.'</p>'."\n";
15016: }
15017: if ($warning) {
15018: $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
15019: }
15020: return $output;
15021: }
15022:
1.1066 raeburn 15023: sub cleanup_empty_dirs {
15024: my ($path) = @_;
15025: if (($path ne '') && (-d $path)) {
15026: if (opendir(my $dirh,$path)) {
15027: my @dircontents = grep(!/^\./,readdir($dirh));
15028: my $numitems = 0;
15029: foreach my $item (@dircontents) {
15030: if (-d "$path/$item") {
1.1111 raeburn 15031: &cleanup_empty_dirs("$path/$item");
1.1066 raeburn 15032: if (-e "$path/$item") {
15033: $numitems ++;
15034: }
15035: } else {
15036: $numitems ++;
15037: }
15038: }
15039: if ($numitems == 0) {
15040: rmdir($path);
15041: }
15042: closedir($dirh);
15043: }
15044: }
15045: return;
15046: }
15047:
1.41 ng 15048: =pod
1.45 matthew 15049:
1.1162 raeburn 15050: =item * &get_folder_hierarchy()
1.1068 raeburn 15051:
15052: Provides hierarchy of names of folders/sub-folders containing the current
15053: item,
15054:
15055: Inputs: 3
15056: - $navmap - navmaps object
15057:
15058: - $map - url for map (either the trigger itself, or map containing
15059: the resource, which is the trigger).
15060:
15061: - $showitem - 1 => show title for map itself; 0 => do not show.
15062:
15063: Outputs: 1 @pathitems - array of folder/subfolder names.
15064:
15065: =cut
15066:
15067: sub get_folder_hierarchy {
15068: my ($navmap,$map,$showitem) = @_;
15069: my @pathitems;
15070: if (ref($navmap)) {
15071: my $mapres = $navmap->getResourceByUrl($map);
15072: if (ref($mapres)) {
15073: my $pcslist = $mapres->map_hierarchy();
15074: if ($pcslist ne '') {
15075: my @pcs = split(/,/,$pcslist);
15076: foreach my $pc (@pcs) {
15077: if ($pc == 1) {
1.1129 raeburn 15078: push(@pathitems,&mt('Main Content'));
1.1068 raeburn 15079: } else {
15080: my $res = $navmap->getByMapPc($pc);
15081: if (ref($res)) {
15082: my $title = $res->compTitle();
15083: $title =~ s/\W+/_/g;
15084: if ($title ne '') {
15085: push(@pathitems,$title);
15086: }
15087: }
15088: }
15089: }
15090: }
1.1071 raeburn 15091: if ($showitem) {
15092: if ($mapres->{ID} eq '0.0') {
1.1129 raeburn 15093: push(@pathitems,&mt('Main Content'));
1.1071 raeburn 15094: } else {
15095: my $maptitle = $mapres->compTitle();
15096: $maptitle =~ s/\W+/_/g;
15097: if ($maptitle ne '') {
15098: push(@pathitems,$maptitle);
15099: }
1.1068 raeburn 15100: }
15101: }
15102: }
15103: }
15104: return @pathitems;
15105: }
15106:
15107: =pod
15108:
1.1015 raeburn 15109: =item * &get_turnedin_filepath()
15110:
15111: Determines path in a user's portfolio file for storage of files uploaded
15112: to a specific essayresponse or dropbox item.
15113:
15114: Inputs: 3 required + 1 optional.
15115: $symb is symb for resource, $uname and $udom are for current user (required).
15116: $caller is optional (can be "submission", if routine is called when storing
15117: an upoaded file when "Submit Answer" button was pressed).
15118:
15119: Returns array containing $path and $multiresp.
15120: $path is path in portfolio. $multiresp is 1 if this resource contains more
15121: than one file upload item. Callers of routine should append partid as a
15122: subdirectory to $path in cases where $multiresp is 1.
15123:
15124: Called by: homework/essayresponse.pm and homework/structuretags.pm
15125:
15126: =cut
15127:
15128: sub get_turnedin_filepath {
15129: my ($symb,$uname,$udom,$caller) = @_;
15130: my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
15131: my $turnindir;
15132: my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
15133: $turnindir = $userhash{'turnindir'};
15134: my ($path,$multiresp);
15135: if ($turnindir eq '') {
15136: if ($caller eq 'submission') {
15137: $turnindir = &mt('turned in');
15138: $turnindir =~ s/\W+/_/g;
15139: my %newhash = (
15140: 'turnindir' => $turnindir,
15141: );
15142: &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
15143: }
15144: }
15145: if ($turnindir ne '') {
15146: $path = '/'.$turnindir.'/';
15147: my ($multipart,$turnin,@pathitems);
15148: my $navmap = Apache::lonnavmaps::navmap->new();
15149: if (defined($navmap)) {
15150: my $mapres = $navmap->getResourceByUrl($map);
15151: if (ref($mapres)) {
15152: my $pcslist = $mapres->map_hierarchy();
15153: if ($pcslist ne '') {
15154: foreach my $pc (split(/,/,$pcslist)) {
15155: my $res = $navmap->getByMapPc($pc);
15156: if (ref($res)) {
15157: my $title = $res->compTitle();
15158: $title =~ s/\W+/_/g;
15159: if ($title ne '') {
1.1149 raeburn 15160: if (($pc > 1) && (length($title) > 12)) {
15161: $title = substr($title,0,12);
15162: }
1.1015 raeburn 15163: push(@pathitems,$title);
15164: }
15165: }
15166: }
15167: }
15168: my $maptitle = $mapres->compTitle();
15169: $maptitle =~ s/\W+/_/g;
15170: if ($maptitle ne '') {
1.1149 raeburn 15171: if (length($maptitle) > 12) {
15172: $maptitle = substr($maptitle,0,12);
15173: }
1.1015 raeburn 15174: push(@pathitems,$maptitle);
15175: }
15176: unless ($env{'request.state'} eq 'construct') {
15177: my $res = $navmap->getBySymb($symb);
15178: if (ref($res)) {
15179: my $partlist = $res->parts();
15180: my $totaluploads = 0;
15181: if (ref($partlist) eq 'ARRAY') {
15182: foreach my $part (@{$partlist}) {
15183: my @types = $res->responseType($part);
15184: my @ids = $res->responseIds($part);
15185: for (my $i=0; $i < scalar(@ids); $i++) {
15186: if ($types[$i] eq 'essay') {
15187: my $partid = $part.'_'.$ids[$i];
15188: if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
15189: $totaluploads ++;
15190: }
15191: }
15192: }
15193: }
15194: if ($totaluploads > 1) {
15195: $multiresp = 1;
15196: }
15197: }
15198: }
15199: }
15200: } else {
15201: return;
15202: }
15203: } else {
15204: return;
15205: }
15206: my $restitle=&Apache::lonnet::gettitle($symb);
15207: $restitle =~ s/\W+/_/g;
15208: if ($restitle eq '') {
15209: $restitle = ($resurl =~ m{/[^/]+$});
15210: if ($restitle eq '') {
15211: $restitle = time;
15212: }
15213: }
1.1149 raeburn 15214: if (length($restitle) > 12) {
15215: $restitle = substr($restitle,0,12);
15216: }
1.1015 raeburn 15217: push(@pathitems,$restitle);
15218: $path .= join('/',@pathitems);
15219: }
15220: return ($path,$multiresp);
15221: }
15222:
15223: =pod
15224:
1.464 albertel 15225: =back
1.41 ng 15226:
1.112 bowersj2 15227: =head1 CSV Upload/Handling functions
1.38 albertel 15228:
1.41 ng 15229: =over 4
15230:
1.648 raeburn 15231: =item * &upfile_store($r)
1.41 ng 15232:
15233: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 15234: needs $env{'form.upfile'}
1.41 ng 15235: returns $datatoken to be put into hidden field
15236:
15237: =cut
1.31 albertel 15238:
15239: sub upfile_store {
15240: my $r=shift;
1.258 albertel 15241: $env{'form.upfile'}=~s/\r/\n/gs;
15242: $env{'form.upfile'}=~s/\f/\n/gs;
15243: $env{'form.upfile'}=~s/\n+/\n/gs;
15244: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 15245:
1.1299 raeburn 15246: my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
15247: '_enroll_'.$env{'request.course.id'}.'_'.
15248: time.'_'.$$);
15249: return if ($datatoken eq '');
15250:
1.31 albertel 15251: {
1.158 raeburn 15252: my $datafile = $r->dir_config('lonDaemons').
15253: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15254: if ( open(my $fh,'>',$datafile) ) {
1.258 albertel 15255: print $fh $env{'form.upfile'};
1.158 raeburn 15256: close($fh);
15257: }
1.31 albertel 15258: }
15259: return $datatoken;
15260: }
15261:
1.56 matthew 15262: =pod
15263:
1.1290 raeburn 15264: =item * &load_tmp_file($r,$datatoken)
1.41 ng 15265:
15266: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290 raeburn 15267: $datatoken is the name to assign to the temporary file.
1.258 albertel 15268: sets $env{'form.upfile'} to the contents of the file
1.41 ng 15269:
15270: =cut
1.31 albertel 15271:
15272: sub load_tmp_file {
1.1290 raeburn 15273: my ($r,$datatoken) = @_;
15274: return if ($datatoken eq '');
1.31 albertel 15275: my @studentdata=();
15276: {
1.158 raeburn 15277: my $studentfile = $r->dir_config('lonDaemons').
1.1290 raeburn 15278: '/tmp/'.$datatoken.'.tmp';
1.1317 raeburn 15279: if ( open(my $fh,'<',$studentfile) ) {
1.158 raeburn 15280: @studentdata=<$fh>;
15281: close($fh);
15282: }
1.31 albertel 15283: }
1.258 albertel 15284: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 15285: }
15286:
1.1290 raeburn 15287: sub valid_datatoken {
15288: my ($datatoken) = @_;
1.1325 raeburn 15289: if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290 raeburn 15290: return $datatoken;
15291: }
15292: return;
15293: }
15294:
1.56 matthew 15295: =pod
15296:
1.648 raeburn 15297: =item * &upfile_record_sep()
1.41 ng 15298:
15299: Separate uploaded file into records
15300: returns array of records,
1.258 albertel 15301: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 15302:
15303: =cut
1.31 albertel 15304:
15305: sub upfile_record_sep {
1.258 albertel 15306: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 15307: } else {
1.248 albertel 15308: my @records;
1.258 albertel 15309: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 15310: if ($line=~/^\s*$/) { next; }
15311: push(@records,$line);
15312: }
15313: return @records;
1.31 albertel 15314: }
15315: }
15316:
1.56 matthew 15317: =pod
15318:
1.648 raeburn 15319: =item * &record_sep($record)
1.41 ng 15320:
1.258 albertel 15321: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 15322:
15323: =cut
15324:
1.263 www 15325: sub takeleft {
15326: my $index=shift;
15327: return substr('0000'.$index,-4,4);
15328: }
15329:
1.31 albertel 15330: sub record_sep {
15331: my $record=shift;
15332: my %components=();
1.258 albertel 15333: if ($env{'form.upfiletype'} eq 'xml') {
15334: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 15335: my $i=0;
1.356 albertel 15336: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 15337: $field=~s/^(\"|\')//;
15338: $field=~s/(\"|\')$//;
1.263 www 15339: $components{&takeleft($i)}=$field;
1.31 albertel 15340: $i++;
15341: }
1.258 albertel 15342: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 15343: my $i=0;
1.356 albertel 15344: foreach my $field (split(/\t/,$record)) {
1.31 albertel 15345: $field=~s/^(\"|\')//;
15346: $field=~s/(\"|\')$//;
1.263 www 15347: $components{&takeleft($i)}=$field;
1.31 albertel 15348: $i++;
15349: }
15350: } else {
1.561 www 15351: my $separator=',';
1.480 banghart 15352: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 15353: $separator=';';
1.480 banghart 15354: }
1.31 albertel 15355: my $i=0;
1.561 www 15356: # the character we are looking for to indicate the end of a quote or a record
15357: my $looking_for=$separator;
15358: # do not add the characters to the fields
15359: my $ignore=0;
15360: # we just encountered a separator (or the beginning of the record)
15361: my $just_found_separator=1;
15362: # store the field we are working on here
15363: my $field='';
15364: # work our way through all characters in record
15365: foreach my $character ($record=~/(.)/g) {
15366: if ($character eq $looking_for) {
15367: if ($character ne $separator) {
15368: # Found the end of a quote, again looking for separator
15369: $looking_for=$separator;
15370: $ignore=1;
15371: } else {
15372: # Found a separator, store away what we got
15373: $components{&takeleft($i)}=$field;
15374: $i++;
15375: $just_found_separator=1;
15376: $ignore=0;
15377: $field='';
15378: }
15379: next;
15380: }
15381: # single or double quotation marks after a separator indicate beginning of a quote
15382: # we are now looking for the end of the quote and need to ignore separators
15383: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
15384: $looking_for=$character;
15385: next;
15386: }
15387: # ignore would be true after we reached the end of a quote
15388: if ($ignore) { next; }
15389: if (($just_found_separator) && ($character=~/\s/)) { next; }
15390: $field.=$character;
15391: $just_found_separator=0;
1.31 albertel 15392: }
1.561 www 15393: # catch the very last entry, since we never encountered the separator
15394: $components{&takeleft($i)}=$field;
1.31 albertel 15395: }
15396: return %components;
15397: }
15398:
1.144 matthew 15399: ######################################################
15400: ######################################################
15401:
1.56 matthew 15402: =pod
15403:
1.648 raeburn 15404: =item * &upfile_select_html()
1.41 ng 15405:
1.144 matthew 15406: Return HTML code to select a file from the users machine and specify
15407: the file type.
1.41 ng 15408:
15409: =cut
15410:
1.144 matthew 15411: ######################################################
15412: ######################################################
1.31 albertel 15413: sub upfile_select_html {
1.144 matthew 15414: my %Types = (
15415: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 15416: semisv => &mt('Semicolon separated values'),
1.144 matthew 15417: space => &mt('Space separated'),
15418: tab => &mt('Tabulator separated'),
15419: # xml => &mt('HTML/XML'),
15420: );
15421: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 15422: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 15423: foreach my $type (sort(keys(%Types))) {
15424: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
15425: }
15426: $Str .= "</select>\n";
15427: return $Str;
1.31 albertel 15428: }
15429:
1.301 albertel 15430: sub get_samples {
15431: my ($records,$toget) = @_;
15432: my @samples=({});
15433: my $got=0;
15434: foreach my $rec (@$records) {
15435: my %temp = &record_sep($rec);
15436: if (! grep(/\S/, values(%temp))) { next; }
15437: if (%temp) {
15438: $samples[$got]=\%temp;
15439: $got++;
15440: if ($got == $toget) { last; }
15441: }
15442: }
15443: return \@samples;
15444: }
15445:
1.144 matthew 15446: ######################################################
15447: ######################################################
15448:
1.56 matthew 15449: =pod
15450:
1.648 raeburn 15451: =item * &csv_print_samples($r,$records)
1.41 ng 15452:
15453: Prints a table of sample values from each column uploaded $r is an
15454: Apache Request ref, $records is an arrayref from
15455: &Apache::loncommon::upfile_record_sep
15456:
15457: =cut
15458:
1.144 matthew 15459: ######################################################
15460: ######################################################
1.31 albertel 15461: sub csv_print_samples {
15462: my ($r,$records) = @_;
1.662 bisitz 15463: my $samples = &get_samples($records,5);
1.301 albertel 15464:
1.594 raeburn 15465: $r->print(&mt('Samples').'<br />'.&start_data_table().
15466: &start_data_table_header_row());
1.356 albertel 15467: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.845 bisitz 15468: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 15469: $r->print(&end_data_table_header_row());
1.301 albertel 15470: foreach my $hash (@$samples) {
1.594 raeburn 15471: $r->print(&start_data_table_row());
1.356 albertel 15472: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 15473: $r->print('<td>');
1.356 albertel 15474: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 15475: $r->print('</td>');
15476: }
1.594 raeburn 15477: $r->print(&end_data_table_row());
1.31 albertel 15478: }
1.594 raeburn 15479: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 15480: }
15481:
1.144 matthew 15482: ######################################################
15483: ######################################################
15484:
1.56 matthew 15485: =pod
15486:
1.648 raeburn 15487: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 15488:
15489: Prints a table to create associations between values and table columns.
1.144 matthew 15490:
1.41 ng 15491: $r is an Apache Request ref,
15492: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 15493: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 15494:
15495: =cut
15496:
1.144 matthew 15497: ######################################################
15498: ######################################################
1.31 albertel 15499: sub csv_print_select_table {
15500: my ($r,$records,$d) = @_;
1.301 albertel 15501: my $i=0;
15502: my $samples = &get_samples($records,1);
1.144 matthew 15503: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 15504: &start_data_table().&start_data_table_header_row().
1.144 matthew 15505: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 15506: '<th>'.&mt('Column').'</th>'.
15507: &end_data_table_header_row()."\n");
1.356 albertel 15508: foreach my $array_ref (@$d) {
15509: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 15510: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 15511:
1.875 bisitz 15512: $r->print('<td><select name="f'.$i.'"'.
1.32 matthew 15513: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 15514: $r->print('<option value="none"></option>');
1.356 albertel 15515: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
15516: $r->print('<option value="'.$sample.'"'.
15517: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 15518: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 15519: }
1.594 raeburn 15520: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 15521: $i++;
15522: }
1.594 raeburn 15523: $r->print(&end_data_table());
1.31 albertel 15524: $i--;
15525: return $i;
15526: }
1.56 matthew 15527:
1.144 matthew 15528: ######################################################
15529: ######################################################
15530:
1.56 matthew 15531: =pod
1.31 albertel 15532:
1.648 raeburn 15533: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 15534:
15535: Prints a table of sample values from the upload and can make associate samples to internal names.
15536:
15537: $r is an Apache Request ref,
15538: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
15539: $d is an array of 2 element arrays (internal name, displayed name)
15540:
15541: =cut
15542:
1.144 matthew 15543: ######################################################
15544: ######################################################
1.31 albertel 15545: sub csv_samples_select_table {
15546: my ($r,$records,$d) = @_;
15547: my $i=0;
1.144 matthew 15548: #
1.662 bisitz 15549: my $max_samples = 5;
15550: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 15551: $r->print(&start_data_table().
15552: &start_data_table_header_row().'<th>'.
15553: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
15554: &end_data_table_header_row());
1.301 albertel 15555:
15556: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 15557: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 15558: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 15559: foreach my $option (@$d) {
15560: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 15561: $r->print('<option value="'.$value.'"'.
1.253 albertel 15562: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 15563: $display.'</option>');
1.31 albertel 15564: }
15565: $r->print('</select></td><td>');
1.662 bisitz 15566: foreach my $line (0..($max_samples-1)) {
1.301 albertel 15567: if (defined($samples->[$line]{$key})) {
15568: $r->print($samples->[$line]{$key}."<br />\n");
15569: }
15570: }
1.594 raeburn 15571: $r->print('</td>'.&end_data_table_row());
1.31 albertel 15572: $i++;
15573: }
1.594 raeburn 15574: $r->print(&end_data_table());
1.31 albertel 15575: $i--;
15576: return($i);
1.115 matthew 15577: }
15578:
1.144 matthew 15579: ######################################################
15580: ######################################################
15581:
1.115 matthew 15582: =pod
15583:
1.648 raeburn 15584: =item * &clean_excel_name($name)
1.115 matthew 15585:
15586: Returns a replacement for $name which does not contain any illegal characters.
15587:
15588: =cut
15589:
1.144 matthew 15590: ######################################################
15591: ######################################################
1.115 matthew 15592: sub clean_excel_name {
15593: my ($name) = @_;
15594: $name =~ s/[:\*\?\/\\]//g;
15595: if (length($name) > 31) {
15596: $name = substr($name,0,31);
15597: }
15598: return $name;
1.25 albertel 15599: }
1.84 albertel 15600:
1.85 albertel 15601: =pod
15602:
1.648 raeburn 15603: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 15604:
15605: Returns either 1 or undef
15606:
15607: 1 if the part is to be hidden, undef if it is to be shown
15608:
15609: Arguments are:
15610:
15611: $id the id of the part to be checked
15612: $symb, optional the symb of the resource to check
15613: $udom, optional the domain of the user to check for
15614: $uname, optional the username of the user to check for
15615:
15616: =cut
1.84 albertel 15617:
15618: sub check_if_partid_hidden {
15619: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 15620: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 15621: $symb,$udom,$uname);
1.141 albertel 15622: my $truth=1;
15623: #if the string starts with !, then the list is the list to show not hide
15624: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 15625: my @hiddenlist=split(/,/,$hiddenparts);
15626: foreach my $checkid (@hiddenlist) {
1.141 albertel 15627: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 15628: }
1.141 albertel 15629: return !$truth;
1.84 albertel 15630: }
1.127 matthew 15631:
1.138 matthew 15632:
15633: ############################################################
15634: ############################################################
15635:
15636: =pod
15637:
1.157 matthew 15638: =back
15639:
1.138 matthew 15640: =head1 cgi-bin script and graphing routines
15641:
1.157 matthew 15642: =over 4
15643:
1.648 raeburn 15644: =item * &get_cgi_id()
1.138 matthew 15645:
15646: Inputs: none
15647:
15648: Returns an id which can be used to pass environment variables
15649: to various cgi-bin scripts. These environment variables will
15650: be removed from the users environment after a given time by
15651: the routine &Apache::lonnet::transfer_profile_to_env.
15652:
15653: =cut
15654:
15655: ############################################################
15656: ############################################################
1.152 albertel 15657: my $uniq=0;
1.136 matthew 15658: sub get_cgi_id {
1.154 albertel 15659: $uniq=($uniq+1)%100000;
1.280 albertel 15660: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 15661: }
15662:
1.127 matthew 15663: ############################################################
15664: ############################################################
15665:
15666: =pod
15667:
1.648 raeburn 15668: =item * &DrawBarGraph()
1.127 matthew 15669:
1.138 matthew 15670: Facilitates the plotting of data in a (stacked) bar graph.
15671: Puts plot definition data into the users environment in order for
15672: graph.png to plot it. Returns an <img> tag for the plot.
15673: The bars on the plot are labeled '1','2',...,'n'.
15674:
15675: Inputs:
15676:
15677: =over 4
15678:
15679: =item $Title: string, the title of the plot
15680:
15681: =item $xlabel: string, text describing the X-axis of the plot
15682:
15683: =item $ylabel: string, text describing the Y-axis of the plot
15684:
15685: =item $Max: scalar, the maximum Y value to use in the plot
15686: If $Max is < any data point, the graph will not be rendered.
15687:
1.140 matthew 15688: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 15689: they are plotted. If undefined, default values will be used.
15690:
1.178 matthew 15691: =item $labels: array ref holding the labels to use on the x-axis for the bars.
15692:
1.138 matthew 15693: =item @Values: An array of array references. Each array reference holds data
15694: to be plotted in a stacked bar chart.
15695:
1.239 matthew 15696: =item If the final element of @Values is a hash reference the key/value
15697: pairs will be added to the graph definition.
15698:
1.138 matthew 15699: =back
15700:
15701: Returns:
15702:
15703: An <img> tag which references graph.png and the appropriate identifying
15704: information for the plot.
15705:
1.127 matthew 15706: =cut
15707:
15708: ############################################################
15709: ############################################################
1.134 matthew 15710: sub DrawBarGraph {
1.178 matthew 15711: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 15712: #
15713: if (! defined($colors)) {
15714: $colors = ['#33ff00',
15715: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
15716: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
15717: ];
15718: }
1.228 matthew 15719: my $extra_settings = {};
15720: if (ref($Values[-1]) eq 'HASH') {
15721: $extra_settings = pop(@Values);
15722: }
1.127 matthew 15723: #
1.136 matthew 15724: my $identifier = &get_cgi_id();
15725: my $id = 'cgi.'.$identifier;
1.129 matthew 15726: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 15727: return '';
15728: }
1.225 matthew 15729: #
15730: my @Labels;
15731: if (defined($labels)) {
15732: @Labels = @$labels;
15733: } else {
15734: for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263 raeburn 15735: push(@Labels,$i+1);
1.225 matthew 15736: }
15737: }
15738: #
1.129 matthew 15739: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 15740: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 15741: my %ValuesHash;
15742: my $NumSets=1;
15743: foreach my $array (@Values) {
15744: next if (! ref($array));
1.136 matthew 15745: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 15746: join(',',@$array);
1.129 matthew 15747: }
1.127 matthew 15748: #
1.136 matthew 15749: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 15750: if ($NumBars < 3) {
15751: $width = 120+$NumBars*32;
1.220 matthew 15752: $xskip = 1;
1.225 matthew 15753: $bar_width = 30;
15754: } elsif ($NumBars < 5) {
15755: $width = 120+$NumBars*20;
15756: $xskip = 1;
15757: $bar_width = 20;
1.220 matthew 15758: } elsif ($NumBars < 10) {
1.136 matthew 15759: $width = 120+$NumBars*15;
15760: $xskip = 1;
15761: $bar_width = 15;
15762: } elsif ($NumBars <= 25) {
15763: $width = 120+$NumBars*11;
15764: $xskip = 5;
15765: $bar_width = 8;
15766: } elsif ($NumBars <= 50) {
15767: $width = 120+$NumBars*8;
15768: $xskip = 5;
15769: $bar_width = 4;
15770: } else {
15771: $width = 120+$NumBars*8;
15772: $xskip = 5;
15773: $bar_width = 4;
15774: }
15775: #
1.137 matthew 15776: $Max = 1 if ($Max < 1);
15777: if ( int($Max) < $Max ) {
15778: $Max++;
15779: $Max = int($Max);
15780: }
1.127 matthew 15781: $Title = '' if (! defined($Title));
15782: $xlabel = '' if (! defined($xlabel));
15783: $ylabel = '' if (! defined($ylabel));
1.369 www 15784: $ValuesHash{$id.'.title'} = &escape($Title);
15785: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
15786: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 15787: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 15788: $ValuesHash{$id.'.NumBars'} = $NumBars;
15789: $ValuesHash{$id.'.NumSets'} = $NumSets;
15790: $ValuesHash{$id.'.PlotType'} = 'bar';
15791: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15792: $ValuesHash{$id.'.height'} = $height;
15793: $ValuesHash{$id.'.width'} = $width;
15794: $ValuesHash{$id.'.xskip'} = $xskip;
15795: $ValuesHash{$id.'.bar_width'} = $bar_width;
15796: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 15797: #
1.228 matthew 15798: # Deal with other parameters
15799: while (my ($key,$value) = each(%$extra_settings)) {
15800: $ValuesHash{$id.'.'.$key} = $value;
15801: }
15802: #
1.646 raeburn 15803: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 15804: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15805: }
15806:
15807: ############################################################
15808: ############################################################
15809:
15810: =pod
15811:
1.648 raeburn 15812: =item * &DrawXYGraph()
1.137 matthew 15813:
1.138 matthew 15814: Facilitates the plotting of data in an XY graph.
15815: Puts plot definition data into the users environment in order for
15816: graph.png to plot it. Returns an <img> tag for the plot.
15817:
15818: Inputs:
15819:
15820: =over 4
15821:
15822: =item $Title: string, the title of the plot
15823:
15824: =item $xlabel: string, text describing the X-axis of the plot
15825:
15826: =item $ylabel: string, text describing the Y-axis of the plot
15827:
15828: =item $Max: scalar, the maximum Y value to use in the plot
15829: If $Max is < any data point, the graph will not be rendered.
15830:
15831: =item $colors: Array ref containing the hex color codes for the data to be
15832: plotted in. If undefined, default values will be used.
15833:
15834: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15835:
15836: =item $Ydata: Array ref containing Array refs.
1.185 www 15837: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 15838:
15839: =item %Values: hash indicating or overriding any default values which are
15840: passed to graph.png.
15841: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15842:
15843: =back
15844:
15845: Returns:
15846:
15847: An <img> tag which references graph.png and the appropriate identifying
15848: information for the plot.
15849:
1.137 matthew 15850: =cut
15851:
15852: ############################################################
15853: ############################################################
15854: sub DrawXYGraph {
15855: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
15856: #
15857: # Create the identifier for the graph
15858: my $identifier = &get_cgi_id();
15859: my $id = 'cgi.'.$identifier;
15860: #
15861: $Title = '' if (! defined($Title));
15862: $xlabel = '' if (! defined($xlabel));
15863: $ylabel = '' if (! defined($ylabel));
15864: my %ValuesHash =
15865: (
1.369 www 15866: $id.'.title' => &escape($Title),
15867: $id.'.xlabel' => &escape($xlabel),
15868: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 15869: $id.'.y_max_value'=> $Max,
15870: $id.'.labels' => join(',',@$Xlabels),
15871: $id.'.PlotType' => 'XY',
15872: );
15873: #
15874: if (defined($colors) && ref($colors) eq 'ARRAY') {
15875: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15876: }
15877: #
15878: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
15879: return '';
15880: }
15881: my $NumSets=1;
1.138 matthew 15882: foreach my $array (@{$Ydata}){
1.137 matthew 15883: next if (! ref($array));
15884: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
15885: }
1.138 matthew 15886: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 15887: #
15888: # Deal with other parameters
15889: while (my ($key,$value) = each(%Values)) {
15890: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 15891: }
15892: #
1.646 raeburn 15893: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 15894: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
15895: }
15896:
15897: ############################################################
15898: ############################################################
15899:
15900: =pod
15901:
1.648 raeburn 15902: =item * &DrawXYYGraph()
1.138 matthew 15903:
15904: Facilitates the plotting of data in an XY graph with two Y axes.
15905: Puts plot definition data into the users environment in order for
15906: graph.png to plot it. Returns an <img> tag for the plot.
15907:
15908: Inputs:
15909:
15910: =over 4
15911:
15912: =item $Title: string, the title of the plot
15913:
15914: =item $xlabel: string, text describing the X-axis of the plot
15915:
15916: =item $ylabel: string, text describing the Y-axis of the plot
15917:
15918: =item $colors: Array ref containing the hex color codes for the data to be
15919: plotted in. If undefined, default values will be used.
15920:
15921: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
15922:
15923: =item $Ydata1: The first data set
15924:
15925: =item $Min1: The minimum value of the left Y-axis
15926:
15927: =item $Max1: The maximum value of the left Y-axis
15928:
15929: =item $Ydata2: The second data set
15930:
15931: =item $Min2: The minimum value of the right Y-axis
15932:
15933: =item $Max2: The maximum value of the left Y-axis
15934:
15935: =item %Values: hash indicating or overriding any default values which are
15936: passed to graph.png.
15937: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
15938:
15939: =back
15940:
15941: Returns:
15942:
15943: An <img> tag which references graph.png and the appropriate identifying
15944: information for the plot.
1.136 matthew 15945:
15946: =cut
15947:
15948: ############################################################
15949: ############################################################
1.137 matthew 15950: sub DrawXYYGraph {
15951: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
15952: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 15953: #
15954: # Create the identifier for the graph
15955: my $identifier = &get_cgi_id();
15956: my $id = 'cgi.'.$identifier;
15957: #
15958: $Title = '' if (! defined($Title));
15959: $xlabel = '' if (! defined($xlabel));
15960: $ylabel = '' if (! defined($ylabel));
15961: my %ValuesHash =
15962: (
1.369 www 15963: $id.'.title' => &escape($Title),
15964: $id.'.xlabel' => &escape($xlabel),
15965: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 15966: $id.'.labels' => join(',',@$Xlabels),
15967: $id.'.PlotType' => 'XY',
15968: $id.'.NumSets' => 2,
1.137 matthew 15969: $id.'.two_axes' => 1,
15970: $id.'.y1_max_value' => $Max1,
15971: $id.'.y1_min_value' => $Min1,
15972: $id.'.y2_max_value' => $Max2,
15973: $id.'.y2_min_value' => $Min2,
1.136 matthew 15974: );
15975: #
1.137 matthew 15976: if (defined($colors) && ref($colors) eq 'ARRAY') {
15977: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
15978: }
15979: #
15980: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
15981: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 15982: return '';
15983: }
15984: my $NumSets=1;
1.137 matthew 15985: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 15986: next if (! ref($array));
15987: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 15988: }
15989: #
15990: # Deal with other parameters
15991: while (my ($key,$value) = each(%Values)) {
15992: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 15993: }
15994: #
1.646 raeburn 15995: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 15996: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 15997: }
15998:
15999: ############################################################
16000: ############################################################
16001:
16002: =pod
16003:
1.157 matthew 16004: =back
16005:
1.139 matthew 16006: =head1 Statistics helper routines?
16007:
16008: Bad place for them but what the hell.
16009:
1.157 matthew 16010: =over 4
16011:
1.648 raeburn 16012: =item * &chartlink()
1.139 matthew 16013:
16014: Returns a link to the chart for a specific student.
16015:
16016: Inputs:
16017:
16018: =over 4
16019:
16020: =item $linktext: The text of the link
16021:
16022: =item $sname: The students username
16023:
16024: =item $sdomain: The students domain
16025:
16026: =back
16027:
1.157 matthew 16028: =back
16029:
1.139 matthew 16030: =cut
16031:
16032: ############################################################
16033: ############################################################
16034: sub chartlink {
16035: my ($linktext, $sname, $sdomain) = @_;
16036: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 16037: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 16038: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 16039: '">'.$linktext.'</a>';
1.153 matthew 16040: }
16041:
16042: #######################################################
16043: #######################################################
16044:
16045: =pod
16046:
16047: =head1 Course Environment Routines
1.157 matthew 16048:
16049: =over 4
1.153 matthew 16050:
1.648 raeburn 16051: =item * &restore_course_settings()
1.153 matthew 16052:
1.648 raeburn 16053: =item * &store_course_settings()
1.153 matthew 16054:
16055: Restores/Store indicated form parameters from the course environment.
16056: Will not overwrite existing values of the form parameters.
16057:
16058: Inputs:
16059: a scalar describing the data (e.g. 'chart', 'problem_analysis')
16060:
16061: a hash ref describing the data to be stored. For example:
16062:
16063: %Save_Parameters = ('Status' => 'scalar',
16064: 'chartoutputmode' => 'scalar',
16065: 'chartoutputdata' => 'scalar',
16066: 'Section' => 'array',
1.373 raeburn 16067: 'Group' => 'array',
1.153 matthew 16068: 'StudentData' => 'array',
16069: 'Maps' => 'array');
16070:
16071: Returns: both routines return nothing
16072:
1.631 raeburn 16073: =back
16074:
1.153 matthew 16075: =cut
16076:
16077: #######################################################
16078: #######################################################
16079: sub store_course_settings {
1.496 albertel 16080: return &store_settings($env{'request.course.id'},@_);
16081: }
16082:
16083: sub store_settings {
1.153 matthew 16084: # save to the environment
16085: # appenv the same items, just to be safe
1.300 albertel 16086: my $udom = $env{'user.domain'};
16087: my $uname = $env{'user.name'};
1.496 albertel 16088: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16089: my %SaveHash;
16090: my %AppHash;
16091: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 16092: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 16093: my $envname = 'environment.'.$basename;
1.258 albertel 16094: if (exists($env{'form.'.$setting})) {
1.153 matthew 16095: # Save this value away
16096: if ($type eq 'scalar' &&
1.258 albertel 16097: (! exists($env{$envname}) ||
16098: $env{$envname} ne $env{'form.'.$setting})) {
16099: $SaveHash{$basename} = $env{'form.'.$setting};
16100: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 16101: } elsif ($type eq 'array') {
16102: my $stored_form;
1.258 albertel 16103: if (ref($env{'form.'.$setting})) {
1.153 matthew 16104: $stored_form = join(',',
16105: map {
1.369 www 16106: &escape($_);
1.258 albertel 16107: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 16108: } else {
16109: $stored_form =
1.369 www 16110: &escape($env{'form.'.$setting});
1.153 matthew 16111: }
16112: # Determine if the array contents are the same.
1.258 albertel 16113: if ($stored_form ne $env{$envname}) {
1.153 matthew 16114: $SaveHash{$basename} = $stored_form;
16115: $AppHash{$envname} = $stored_form;
16116: }
16117: }
16118: }
16119: }
16120: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 16121: $udom,$uname);
1.153 matthew 16122: if ($put_result !~ /^(ok|delayed)/) {
16123: &Apache::lonnet::logthis('unable to save form parameters, '.
16124: 'got error:'.$put_result);
16125: }
16126: # Make sure these settings stick around in this session, too
1.646 raeburn 16127: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 16128: return;
16129: }
16130:
16131: sub restore_course_settings {
1.499 albertel 16132: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 16133: }
16134:
16135: sub restore_settings {
16136: my ($context,$prefix,$Settings) = @_;
1.153 matthew 16137: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 16138: next if (exists($env{'form.'.$setting}));
1.496 albertel 16139: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 16140: '.'.$setting;
1.258 albertel 16141: if (exists($env{$envname})) {
1.153 matthew 16142: if ($type eq 'scalar') {
1.258 albertel 16143: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 16144: } elsif ($type eq 'array') {
1.258 albertel 16145: $env{'form.'.$setting} = [
1.153 matthew 16146: map {
1.369 www 16147: &unescape($_);
1.258 albertel 16148: } split(',',$env{$envname})
1.153 matthew 16149: ];
16150: }
16151: }
16152: }
1.127 matthew 16153: }
16154:
1.618 raeburn 16155: #######################################################
16156: #######################################################
16157:
16158: =pod
16159:
16160: =head1 Domain E-mail Routines
16161:
16162: =over 4
16163:
1.648 raeburn 16164: =item * &build_recipient_list()
1.618 raeburn 16165:
1.1144 raeburn 16166: Build recipient lists for following types of e-mail:
1.766 raeburn 16167: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144 raeburn 16168: (d) Help requests, (e) Course requests needing approval, (f) loncapa
16169: module change checking, student/employee ID conflict checks, as
16170: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
16171: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618 raeburn 16172:
16173: Inputs:
1.619 raeburn 16174: defmail (scalar - email address of default recipient),
1.1144 raeburn 16175: mailing type (scalar: errormail, packagesmail, helpdeskmail,
16176: requestsmail, updatesmail, or idconflictsmail).
16177:
1.619 raeburn 16178: defdom (domain for which to retrieve configuration settings),
1.1144 raeburn 16179:
1.619 raeburn 16180: origmail (scalar - email address of recipient from loncapa.conf,
1.1297 raeburn 16181: i.e., predates configuration by DC via domainprefs.pm
16182:
16183: $requname username of requester (if mailing type is helpdeskmail)
16184:
16185: $requdom domain of requester (if mailing type is helpdeskmail)
16186:
16187: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
16188:
1.618 raeburn 16189:
1.655 raeburn 16190: Returns: comma separated list of addresses to which to send e-mail.
16191:
16192: =back
1.618 raeburn 16193:
16194: =cut
16195:
16196: ############################################################
16197: ############################################################
16198: sub build_recipient_list {
1.1297 raeburn 16199: my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618 raeburn 16200: my @recipients;
1.1270 raeburn 16201: my ($otheremails,$lastresort,$allbcc,$addtext);
1.618 raeburn 16202: my %domconfig =
1.1270 raeburn 16203: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618 raeburn 16204: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 16205: if (exists($domconfig{'contacts'}{$mailing})) {
16206: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
16207: my @contacts = ('adminemail','supportemail');
16208: foreach my $item (@contacts) {
16209: if ($domconfig{'contacts'}{$mailing}{$item}) {
16210: my $addr = $domconfig{'contacts'}{$item};
16211: if (!grep(/^\Q$addr\E$/,@recipients)) {
16212: push(@recipients,$addr);
16213: }
1.619 raeburn 16214: }
1.1270 raeburn 16215: }
16216: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
16217: if ($mailing eq 'helpdeskmail') {
16218: if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
16219: my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
16220: my @ok_bccs;
16221: foreach my $bcc (@bccs) {
16222: $bcc =~ s/^\s+//g;
16223: $bcc =~ s/\s+$//g;
16224: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16225: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16226: push(@ok_bccs,$bcc);
16227: }
16228: }
16229: }
16230: if (@ok_bccs > 0) {
16231: $allbcc = join(', ',@ok_bccs);
16232: }
16233: }
16234: $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618 raeburn 16235: }
16236: }
1.766 raeburn 16237: } elsif ($origmail ne '') {
1.1270 raeburn 16238: $lastresort = $origmail;
1.618 raeburn 16239: }
1.1297 raeburn 16240: if ($mailing eq 'helpdeskmail') {
16241: if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
16242: (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
16243: my ($inststatus,$inststatus_checked);
16244: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
16245: ($env{'user.domain'} ne 'public')) {
16246: $inststatus_checked = 1;
16247: $inststatus = $env{'environment.inststatus'};
16248: }
16249: unless ($inststatus_checked) {
16250: if (($requname ne '') && ($requdom ne '')) {
16251: if (($requname =~ /^$match_username$/) &&
16252: ($requdom =~ /^$match_domain$/) &&
16253: (&Apache::lonnet::domain($requdom))) {
16254: my $requhome = &Apache::lonnet::homeserver($requname,
16255: $requdom);
16256: unless ($requhome eq 'no_host') {
16257: my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
16258: $inststatus = $userenv{'inststatus'};
16259: $inststatus_checked = 1;
16260: }
16261: }
16262: }
16263: }
16264: unless ($inststatus_checked) {
16265: if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
16266: my %srch = (srchby => 'email',
16267: srchdomain => $defdom,
16268: srchterm => $reqemail,
16269: srchtype => 'exact');
16270: my %srch_results = &Apache::lonnet::usersearch(\%srch);
16271: foreach my $uname (keys(%srch_results)) {
16272: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16273: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16274: $inststatus_checked = 1;
16275: last;
16276: }
16277: }
16278: unless ($inststatus_checked) {
16279: my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
16280: if ($dirsrchres eq 'ok') {
16281: foreach my $uname (keys(%srch_results)) {
16282: if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
16283: $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
16284: $inststatus_checked = 1;
16285: last;
16286: }
16287: }
16288: }
16289: }
16290: }
16291: }
16292: if ($inststatus ne '') {
16293: foreach my $status (split(/\:/,$inststatus)) {
16294: if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
16295: my @contacts = ('adminemail','supportemail');
16296: foreach my $item (@contacts) {
16297: if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
16298: my $addr = $domconfig{'contacts'}{'overrides'}{$status};
16299: if (!grep(/^\Q$addr\E$/,@recipients)) {
16300: push(@recipients,$addr);
16301: }
16302: }
16303: }
16304: $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
16305: if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
16306: my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
16307: my @ok_bccs;
16308: foreach my $bcc (@bccs) {
16309: $bcc =~ s/^\s+//g;
16310: $bcc =~ s/\s+$//g;
16311: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16312: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16313: push(@ok_bccs,$bcc);
16314: }
16315: }
16316: }
16317: if (@ok_bccs > 0) {
16318: $allbcc = join(', ',@ok_bccs);
16319: }
16320: }
16321: $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
16322: last;
16323: }
16324: }
16325: }
16326: }
16327: }
1.619 raeburn 16328: } elsif ($origmail ne '') {
1.1270 raeburn 16329: $lastresort = $origmail;
16330: }
1.1297 raeburn 16331: if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270 raeburn 16332: unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
16333: my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
16334: my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
16335: my %what = (
16336: perlvar => 1,
16337: );
16338: my $primary = &Apache::lonnet::domain($defdom,'primary');
16339: if ($primary) {
16340: my $gotaddr;
16341: my ($result,$returnhash) =
16342: &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
16343: if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
16344: if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
16345: $lastresort = $returnhash->{'lonSupportEMail'};
16346: $gotaddr = 1;
16347: }
16348: }
16349: unless ($gotaddr) {
16350: my $uintdom = &Apache::lonnet::internet_dom($primary);
16351: my $intdom = &Apache::lonnet::internet_dom($lonhost);
16352: unless ($uintdom eq $intdom) {
16353: my %domconfig =
16354: &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
16355: if (ref($domconfig{'contacts'}) eq 'HASH') {
16356: if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
16357: my @contacts = ('adminemail','supportemail');
16358: foreach my $item (@contacts) {
16359: if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
16360: my $addr = $domconfig{'contacts'}{$item};
16361: if (!grep(/^\Q$addr\E$/,@recipients)) {
16362: push(@recipients,$addr);
16363: }
16364: }
16365: }
16366: if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
16367: $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
16368: }
16369: if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
16370: my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
16371: my @ok_bccs;
16372: foreach my $bcc (@bccs) {
16373: $bcc =~ s/^\s+//g;
16374: $bcc =~ s/\s+$//g;
16375: if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
16376: if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
16377: push(@ok_bccs,$bcc);
16378: }
16379: }
16380: }
16381: if (@ok_bccs > 0) {
16382: $allbcc = join(', ',@ok_bccs);
16383: }
16384: }
16385: $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
16386: }
16387: }
16388: }
16389: }
16390: }
16391: }
1.618 raeburn 16392: }
1.688 raeburn 16393: if (defined($defmail)) {
16394: if ($defmail ne '') {
16395: push(@recipients,$defmail);
16396: }
1.618 raeburn 16397: }
16398: if ($otheremails) {
1.619 raeburn 16399: my @others;
16400: if ($otheremails =~ /,/) {
16401: @others = split(/,/,$otheremails);
1.618 raeburn 16402: } else {
1.619 raeburn 16403: push(@others,$otheremails);
16404: }
16405: foreach my $addr (@others) {
16406: if (!grep(/^\Q$addr\E$/,@recipients)) {
16407: push(@recipients,$addr);
16408: }
1.618 raeburn 16409: }
16410: }
1.1298 raeburn 16411: if ($mailing eq 'helpdeskmail') {
1.1270 raeburn 16412: if ((!@recipients) && ($lastresort ne '')) {
16413: push(@recipients,$lastresort);
16414: }
16415: } elsif ($lastresort ne '') {
16416: if (!grep(/^\Q$lastresort\E$/,@recipients)) {
16417: push(@recipients,$lastresort);
16418: }
16419: }
1.1271 raeburn 16420: my $recipientlist = join(',',@recipients);
1.1270 raeburn 16421: if (wantarray) {
16422: return ($recipientlist,$allbcc,$addtext);
16423: } else {
16424: return $recipientlist;
16425: }
1.618 raeburn 16426: }
16427:
1.127 matthew 16428: ############################################################
16429: ############################################################
1.154 albertel 16430:
1.655 raeburn 16431: =pod
16432:
1.1224 musolffc 16433: =over 4
16434:
1.1223 musolffc 16435: =item * &mime_email()
16436:
16437: Sends an email with a possible attachment
16438:
16439: Inputs:
16440:
16441: =over 4
16442:
16443: from - Sender's email address
16444:
1.1343 raeburn 16445: replyto - Reply-To email address
16446:
1.1223 musolffc 16447: to - Email address of recipient
16448:
16449: subject - Subject of email
16450:
16451: body - Body of email
16452:
16453: cc_string - Carbon copy email address
16454:
16455: bcc - Blind carbon copy email address
16456:
16457: attachment_path - Path of file to be attached
16458:
16459: file_name - Name of file to be attached
16460:
16461: attachment_text - The body of an attachment of type "TEXT"
16462:
16463: =back
16464:
16465: =back
16466:
16467: =cut
16468:
16469: ############################################################
16470: ############################################################
16471:
16472: sub mime_email {
1.1343 raeburn 16473: my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path,
16474: $file_name,$attachment_text) = @_;
16475:
1.1223 musolffc 16476: my $msg = MIME::Lite->new(
16477: From => $from,
16478: To => $to,
16479: Subject => $subject,
16480: Type =>'TEXT',
16481: Data => $body,
16482: );
1.1343 raeburn 16483: if ($replyto ne '') {
16484: $msg->add("Reply-To" => $replyto);
16485: }
1.1223 musolffc 16486: if ($cc_string ne '') {
16487: $msg->add("Cc" => $cc_string);
16488: }
16489: if ($bcc ne '') {
16490: $msg->add("Bcc" => $bcc);
16491: }
16492: $msg->attr("content-type" => "text/plain");
16493: $msg->attr("content-type.charset" => "UTF-8");
16494: # Attach file if given
16495: if ($attachment_path) {
16496: unless ($file_name) {
16497: if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
16498: }
16499: my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
16500: $msg->attach(Type => $type,
16501: Path => $attachment_path,
16502: Filename => $file_name
16503: );
16504: # Otherwise attach text if given
16505: } elsif ($attachment_text) {
16506: $msg->attach(Type => 'TEXT',
16507: Data => $attachment_text);
16508: }
16509: # Send it
16510: $msg->send('sendmail');
16511: }
16512:
16513: ############################################################
16514: ############################################################
16515:
16516: =pod
16517:
1.655 raeburn 16518: =head1 Course Catalog Routines
16519:
16520: =over 4
16521:
16522: =item * &gather_categories()
16523:
16524: Converts category definitions - keys of categories hash stored in
16525: coursecategories in configuration.db on the primary library server in a
16526: domain - to an array. Also generates javascript and idx hash used to
16527: generate Domain Coordinator interface for editing Course Categories.
16528:
16529: Inputs:
1.663 raeburn 16530:
1.655 raeburn 16531: categories (reference to hash of category definitions).
1.663 raeburn 16532:
1.655 raeburn 16533: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16534: categories and subcategories).
1.663 raeburn 16535:
1.655 raeburn 16536: idx (reference to hash of counters used in Domain Coordinator interface for
16537: editing Course Categories).
1.663 raeburn 16538:
1.655 raeburn 16539: jsarray (reference to array of categories used to create Javascript arrays for
16540: Domain Coordinator interface for editing Course Categories).
16541:
16542: Returns: nothing
16543:
16544: Side effects: populates cats, idx and jsarray.
16545:
16546: =cut
16547:
16548: sub gather_categories {
16549: my ($categories,$cats,$idx,$jsarray) = @_;
16550: my %counters;
16551: my $num = 0;
16552: foreach my $item (keys(%{$categories})) {
16553: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
16554: if ($container eq '' && $depth == 0) {
16555: $cats->[$depth][$categories->{$item}] = $cat;
16556: } else {
16557: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
16558: }
16559: my ($escitem,$tail) = split(/:/,$item,2);
16560: if ($counters{$tail} eq '') {
16561: $counters{$tail} = $num;
16562: $num ++;
16563: }
16564: if (ref($idx) eq 'HASH') {
16565: $idx->{$item} = $counters{$tail};
16566: }
16567: if (ref($jsarray) eq 'ARRAY') {
16568: push(@{$jsarray->[$counters{$tail}]},$item);
16569: }
16570: }
16571: return;
16572: }
16573:
16574: =pod
16575:
16576: =item * &extract_categories()
16577:
16578: Used to generate breadcrumb trails for course categories.
16579:
16580: Inputs:
1.663 raeburn 16581:
1.655 raeburn 16582: categories (reference to hash of category definitions).
1.663 raeburn 16583:
1.655 raeburn 16584: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16585: categories and subcategories).
1.663 raeburn 16586:
1.655 raeburn 16587: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 16588:
1.655 raeburn 16589: allitems (reference to hash - key is category key
16590: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16591:
1.655 raeburn 16592: idx (reference to hash of counters used in Domain Coordinator interface for
16593: editing Course Categories).
1.663 raeburn 16594:
1.655 raeburn 16595: jsarray (reference to array of categories used to create Javascript arrays for
16596: Domain Coordinator interface for editing Course Categories).
16597:
1.665 raeburn 16598: subcats (reference to hash of arrays containing all subcategories within each
16599: category, -recursive)
16600:
1.1321 raeburn 16601: maxd (reference to hash used to hold max depth for all top-level categories).
16602:
1.655 raeburn 16603: Returns: nothing
16604:
16605: Side effects: populates trails and allitems hash references.
16606:
16607: =cut
16608:
16609: sub extract_categories {
1.1321 raeburn 16610: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655 raeburn 16611: if (ref($categories) eq 'HASH') {
16612: &gather_categories($categories,$cats,$idx,$jsarray);
16613: if (ref($cats->[0]) eq 'ARRAY') {
16614: for (my $i=0; $i<@{$cats->[0]}; $i++) {
16615: my $name = $cats->[0][$i];
16616: my $item = &escape($name).'::0';
16617: my $trailstr;
16618: if ($name eq 'instcode') {
16619: $trailstr = &mt('Official courses (with institutional codes)');
1.919 raeburn 16620: } elsif ($name eq 'communities') {
16621: $trailstr = &mt('Communities');
1.1239 raeburn 16622: } elsif ($name eq 'placement') {
16623: $trailstr = &mt('Placement Tests');
1.655 raeburn 16624: } else {
16625: $trailstr = $name;
16626: }
16627: if ($allitems->{$item} eq '') {
16628: push(@{$trails},$trailstr);
16629: $allitems->{$item} = scalar(@{$trails})-1;
16630: }
16631: my @parents = ($name);
16632: if (ref($cats->[1]{$name}) eq 'ARRAY') {
16633: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
16634: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 16635: if (ref($subcats) eq 'HASH') {
16636: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
16637: }
1.1321 raeburn 16638: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665 raeburn 16639: }
16640: } else {
16641: if (ref($subcats) eq 'HASH') {
16642: $subcats->{$item} = [];
1.655 raeburn 16643: }
1.1321 raeburn 16644: if (ref($maxd) eq 'HASH') {
16645: $maxd->{$name} = 1;
16646: }
1.655 raeburn 16647: }
16648: }
16649: }
16650: }
16651: return;
16652: }
16653:
16654: =pod
16655:
1.1162 raeburn 16656: =item * &recurse_categories()
1.655 raeburn 16657:
16658: Recursively used to generate breadcrumb trails for course categories.
16659:
16660: Inputs:
1.663 raeburn 16661:
1.655 raeburn 16662: cats (reference to array of arrays/hashes which encapsulates hierarchy of
16663: categories and subcategories).
1.663 raeburn 16664:
1.655 raeburn 16665: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 16666:
16667: category (current course category, for which breadcrumb trail is being generated).
16668:
16669: trails (reference to array of breadcrumb trails for each category).
16670:
1.655 raeburn 16671: allitems (reference to hash - key is category key
16672: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 16673:
1.655 raeburn 16674: parents (array containing containers directories for current category,
16675: back to top level).
16676:
16677: Returns: nothing
16678:
16679: Side effects: populates trails and allitems hash references
16680:
16681: =cut
16682:
16683: sub recurse_categories {
1.1321 raeburn 16684: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655 raeburn 16685: my $shallower = $depth - 1;
16686: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
16687: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
16688: my $name = $cats->[$depth]{$category}[$k];
16689: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16690: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16691: if ($allitems->{$item} eq '') {
16692: push(@{$trails},$trailstr);
16693: $allitems->{$item} = scalar(@{$trails})-1;
16694: }
16695: my $deeper = $depth+1;
16696: push(@{$parents},$category);
1.665 raeburn 16697: if (ref($subcats) eq 'HASH') {
16698: my $subcat = &escape($name).':'.$category.':'.$depth;
16699: for (my $j=@{$parents}; $j>=0; $j--) {
16700: my $higher;
16701: if ($j > 0) {
16702: $higher = &escape($parents->[$j]).':'.
16703: &escape($parents->[$j-1]).':'.$j;
16704: } else {
16705: $higher = &escape($parents->[$j]).'::'.$j;
16706: }
16707: push(@{$subcats->{$higher}},$subcat);
16708: }
16709: }
16710: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321 raeburn 16711: $subcats,$maxd);
1.655 raeburn 16712: pop(@{$parents});
16713: }
16714: } else {
16715: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321 raeburn 16716: my $trailstr = join(' » ',(@{$parents},$category));
1.655 raeburn 16717: if ($allitems->{$item} eq '') {
16718: push(@{$trails},$trailstr);
16719: $allitems->{$item} = scalar(@{$trails})-1;
16720: }
1.1321 raeburn 16721: if (ref($maxd) eq 'HASH') {
16722: if ($depth > $maxd->{$parents->[0]}) {
16723: $maxd->{$parents->[0]} = $depth;
16724: }
16725: }
1.655 raeburn 16726: }
16727: return;
16728: }
16729:
1.663 raeburn 16730: =pod
16731:
1.1162 raeburn 16732: =item * &assign_categories_table()
1.663 raeburn 16733:
16734: Create a datatable for display of hierarchical categories in a domain,
16735: with checkboxes to allow a course to be categorized.
16736:
16737: Inputs:
16738:
16739: cathash - reference to hash of categories defined for the domain (from
16740: configuration.db)
16741:
16742: currcat - scalar with an & separated list of categories assigned to a course.
16743:
1.919 raeburn 16744: type - scalar contains course type (Course or Community).
16745:
1.1260 raeburn 16746: disabled - scalar (optional) contains disabled="disabled" if input elements are
16747: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16748:
1.663 raeburn 16749: Returns: $output (markup to be displayed)
16750:
16751: =cut
16752:
16753: sub assign_categories_table {
1.1259 raeburn 16754: my ($cathash,$currcat,$type,$disabled) = @_;
1.663 raeburn 16755: my $output;
16756: if (ref($cathash) eq 'HASH') {
1.1321 raeburn 16757: my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
16758: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663 raeburn 16759: $maxdepth = scalar(@cats);
16760: if (@cats > 0) {
16761: my $itemcount = 0;
16762: if (ref($cats[0]) eq 'ARRAY') {
16763: my @currcategories;
16764: if ($currcat ne '') {
16765: @currcategories = split('&',$currcat);
16766: }
1.919 raeburn 16767: my $table;
1.663 raeburn 16768: for (my $i=0; $i<@{$cats[0]}; $i++) {
16769: my $parent = $cats[0][$i];
1.919 raeburn 16770: next if ($parent eq 'instcode');
16771: if ($type eq 'Community') {
16772: next unless ($parent eq 'communities');
1.1239 raeburn 16773: } elsif ($type eq 'Placement') {
16774: next unless ($parent eq 'placement');
1.919 raeburn 16775: } else {
1.1239 raeburn 16776: next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919 raeburn 16777: }
1.663 raeburn 16778: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
16779: my $item = &escape($parent).'::0';
16780: my $checked = '';
16781: if (@currcategories > 0) {
16782: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 16783: $checked = ' checked="checked"';
1.663 raeburn 16784: }
16785: }
1.919 raeburn 16786: my $parent_title = $parent;
16787: if ($parent eq 'communities') {
16788: $parent_title = &mt('Communities');
1.1239 raeburn 16789: } elsif ($parent eq 'placement') {
16790: $parent_title = &mt('Placement Tests');
1.919 raeburn 16791: }
16792: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
16793: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16794: $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919 raeburn 16795: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 16796: my $depth = 1;
16797: push(@path,$parent);
1.1259 raeburn 16798: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663 raeburn 16799: pop(@path);
1.919 raeburn 16800: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663 raeburn 16801: $itemcount ++;
16802: }
1.919 raeburn 16803: if ($itemcount) {
16804: $output = &Apache::loncommon::start_data_table().
16805: $table.
16806: &Apache::loncommon::end_data_table();
16807: }
1.663 raeburn 16808: }
16809: }
16810: }
16811: return $output;
16812: }
16813:
16814: =pod
16815:
1.1162 raeburn 16816: =item * &assign_category_rows()
1.663 raeburn 16817:
16818: Create a datatable row for display of nested categories in a domain,
16819: with checkboxes to allow a course to be categorized,called recursively.
16820:
16821: Inputs:
16822:
16823: itemcount - track row number for alternating colors
16824:
16825: cats - reference to array of arrays/hashes which encapsulates hierarchy of
16826: categories and subcategories.
16827:
16828: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
16829:
16830: parent - parent of current category item
16831:
16832: path - Array containing all categories back up through the hierarchy from the
16833: current category to the top level.
16834:
16835: currcategories - reference to array of current categories assigned to the course
16836:
1.1260 raeburn 16837: disabled - scalar (optional) contains disabled="disabled" if input elements are
16838: to be readonly (e.g., Domain Helpdesk role viewing course settings).
16839:
1.663 raeburn 16840: Returns: $output (markup to be displayed).
16841:
16842: =cut
16843:
16844: sub assign_category_rows {
1.1259 raeburn 16845: my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663 raeburn 16846: my ($text,$name,$item,$chgstr);
16847: if (ref($cats) eq 'ARRAY') {
16848: my $maxdepth = scalar(@{$cats});
16849: if (ref($cats->[$depth]) eq 'HASH') {
16850: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
16851: my $numchildren = @{$cats->[$depth]{$parent}};
16852: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145 raeburn 16853: $text .= '<td><table class="LC_data_table">';
1.663 raeburn 16854: for (my $j=0; $j<$numchildren; $j++) {
16855: $name = $cats->[$depth]{$parent}[$j];
16856: $item = &escape($name).':'.&escape($parent).':'.$depth;
16857: my $deeper = $depth+1;
16858: my $checked = '';
16859: if (ref($currcategories) eq 'ARRAY') {
16860: if (@{$currcategories} > 0) {
16861: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 16862: $checked = ' checked="checked"';
1.663 raeburn 16863: }
16864: }
16865: }
1.664 raeburn 16866: $text .= '<tr><td><span class="LC_nobreak"><label>'.
16867: '<input type="checkbox" name="usecategory" value="'.
1.1259 raeburn 16868: $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675 raeburn 16869: '<input type="hidden" name="catname" value="'.$name.'" />'.
16870: '</td><td>';
1.663 raeburn 16871: if (ref($path) eq 'ARRAY') {
16872: push(@{$path},$name);
1.1259 raeburn 16873: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663 raeburn 16874: pop(@{$path});
16875: }
16876: $text .= '</td></tr>';
16877: }
16878: $text .= '</table></td>';
16879: }
16880: }
16881: }
16882: return $text;
16883: }
16884:
1.1181 raeburn 16885: =pod
16886:
16887: =back
16888:
16889: =cut
16890:
1.655 raeburn 16891: ############################################################
16892: ############################################################
16893:
16894:
1.443 albertel 16895: sub commit_customrole {
1.1408 raeburn 16896: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399 raeburn 16897: my $result = &Apache::lonnet::assigncustomrole(
1.1408 raeburn 16898: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
16899: $context,$othdomby,$requester);
1.630 raeburn 16900: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 16901: ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399 raeburn 16902: ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
16903: if (wantarray) {
16904: return ($output,$result);
16905: } else {
16906: return $output;
16907: }
1.443 albertel 16908: }
16909:
16910: sub commit_standardrole {
1.1408 raeburn 16911: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
16912: $othdomby,$requester) = @_;
1.1399 raeburn 16913: my ($output,$logmsg,$linefeed,$result);
1.541 raeburn 16914: if ($context eq 'auto') {
16915: $linefeed = "\n";
16916: } else {
16917: $linefeed = "<br />\n";
16918: }
1.443 albertel 16919: if ($three eq 'st') {
1.1399 raeburn 16920: $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408 raeburn 16921: $one,$two,$sec,$context,$credits,$othdomby,
16922: $requester);
1.541 raeburn 16923: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 16924: ($result eq 'unknown_course') || ($result eq 'refused')) {
16925: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 16926: } else {
1.541 raeburn 16927: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 16928: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16929: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
16930: if ($context eq 'auto') {
16931: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
16932: } else {
16933: $output .= '<b>'.$result.'</b>'.$linefeed.
16934: &mt('Add to classlist').': <b>ok</b>';
16935: }
16936: $output .= $linefeed;
1.443 albertel 16937: }
16938: } else {
16939: $output = &mt('Assigning').' '.$three.' in '.$url.
16940: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 16941: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408 raeburn 16942: $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
16943: '','',$context,$othdomby,$requester);
1.541 raeburn 16944: if ($context eq 'auto') {
16945: $output .= $result.$linefeed;
16946: } else {
16947: $output .= '<b>'.$result.'</b>'.$linefeed;
16948: }
1.443 albertel 16949: }
1.1399 raeburn 16950: if (wantarray) {
16951: return ($output,$result);
16952: } else {
16953: return $output;
16954: }
1.443 albertel 16955: }
16956:
16957: sub commit_studentrole {
1.1116 raeburn 16958: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408 raeburn 16959: $credits,$othdomby,$requester) = @_;
1.626 raeburn 16960: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 16961: if ($context eq 'auto') {
16962: $linefeed = "\n";
16963: } else {
16964: $linefeed = '<br />'."\n";
16965: }
1.443 albertel 16966: if (defined($one) && defined($two)) {
16967: my $cid=$one.'_'.$two;
16968: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
16969: my $secchange = 0;
16970: my $expire_role_result;
16971: my $modify_section_result;
1.628 raeburn 16972: if ($oldsec ne '-1') {
16973: if ($oldsec ne $sec) {
1.443 albertel 16974: $secchange = 1;
1.628 raeburn 16975: my $now = time;
1.443 albertel 16976: my $uurl='/'.$cid;
16977: $uurl=~s/\_/\//g;
16978: if ($oldsec) {
16979: $uurl.='/'.$oldsec;
16980: }
1.626 raeburn 16981: $oldsecurl = $uurl;
1.628 raeburn 16982: $expire_role_result =
1.1408 raeburn 16983: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
16984: '','','',$context,$othdomby,$requester);
16985: if ($env{'request.course.sec'} ne '') {
1.628 raeburn 16986: if ($expire_role_result eq 'refused') {
16987: my @roles = ('st');
16988: my @statuses = ('previous');
16989: my @roledoms = ($one);
16990: my $withsec = 1;
16991: my %roleshash =
16992: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
16993: \@statuses,\@roles,\@roledoms,$withsec);
16994: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
16995: my ($oldstart,$oldend) =
16996: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
16997: if ($oldend > 0 && $oldend <= $now) {
16998: $expire_role_result = 'ok';
16999: }
17000: }
17001: }
17002: }
1.443 albertel 17003: $result = $expire_role_result;
17004: }
17005: }
17006: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116 raeburn 17007: $modify_section_result =
17008: &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
17009: undef,undef,undef,$sec,
17010: $end,$start,'','',$cid,
1.1408 raeburn 17011: '',$context,$credits,'',
17012: $othdomby,$requester);
1.443 albertel 17013: if ($modify_section_result =~ /^ok/) {
17014: if ($secchange == 1) {
1.628 raeburn 17015: if ($sec eq '') {
17016: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
17017: } else {
17018: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
17019: }
1.443 albertel 17020: } elsif ($oldsec eq '-1') {
1.628 raeburn 17021: if ($sec eq '') {
17022: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
17023: } else {
17024: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17025: }
1.443 albertel 17026: } else {
1.628 raeburn 17027: if ($sec eq '') {
17028: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
17029: } else {
17030: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
17031: }
1.443 albertel 17032: }
17033: } else {
1.1115 raeburn 17034: if ($secchange) {
1.628 raeburn 17035: $$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;
17036: } else {
17037: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
17038: }
1.443 albertel 17039: }
17040: $result = $modify_section_result;
17041: } elsif ($secchange == 1) {
1.628 raeburn 17042: if ($oldsec eq '') {
1.1103 raeburn 17043: $$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 17044: } else {
17045: $$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;
17046: }
1.626 raeburn 17047: if ($expire_role_result eq 'refused') {
17048: my $newsecurl = '/'.$cid;
17049: $newsecurl =~ s/\_/\//g;
17050: if ($sec ne '') {
17051: $newsecurl.='/'.$sec;
17052: }
17053: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
17054: if ($sec eq '') {
17055: $$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;
17056: } else {
17057: $$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;
17058: }
17059: }
17060: }
1.443 albertel 17061: }
17062: } else {
1.626 raeburn 17063: $$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 17064: $result = "error: incomplete course id\n";
17065: }
17066: return $result;
17067: }
17068:
1.1108 raeburn 17069: sub show_role_extent {
17070: my ($scope,$context,$role) = @_;
17071: $scope =~ s{^/}{};
17072: my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
17073: push(@courseroles,'co');
17074: my @authorroles = &Apache::lonuserutils::roles_by_context('author');
17075: if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
17076: $scope =~ s{/}{_};
17077: return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
17078: } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
17079: my ($audom,$auname) = split(/\//,$scope);
17080: return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
17081: &Apache::loncommon::plainname($auname,$audom).'</span>');
17082: } else {
17083: $scope =~ s{/$}{};
17084: return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
17085: &Apache::lonnet::domain($scope,'description').'</span>');
17086: }
17087: }
17088:
1.443 albertel 17089: ############################################################
17090: ############################################################
17091:
1.566 albertel 17092: sub check_clone {
1.578 raeburn 17093: my ($args,$linefeed) = @_;
1.566 albertel 17094: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
17095: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
17096: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344 raeburn 17097: my $clonetitle;
17098: my @clonemsg;
1.566 albertel 17099: my $can_clone = 0;
1.944 raeburn 17100: my $lctype = lc($args->{'crstype'});
1.908 raeburn 17101: if ($lctype ne 'community') {
17102: $lctype = 'course';
17103: }
1.566 albertel 17104: if ($clonehome eq 'no_host') {
1.944 raeburn 17105: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17106: push(@clonemsg,({
17107: mt => 'No new community created.',
17108: args => [],
17109: },
17110: {
17111: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
17112: args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
17113: }));
1.908 raeburn 17114: } else {
1.1344 raeburn 17115: push(@clonemsg,({
17116: mt => 'No new course created.',
17117: args => [],
17118: },
17119: {
17120: mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
17121: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17122: }));
17123: }
1.566 albertel 17124: } else {
17125: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344 raeburn 17126: $clonetitle = $clonedesc{'description'};
1.944 raeburn 17127: if ($args->{'crstype'} eq 'Community') {
1.908 raeburn 17128: if ($clonedesc{'type'} ne 'Community') {
1.1344 raeburn 17129: push(@clonemsg,({
17130: mt => 'No new community created.',
17131: args => [],
17132: },
17133: {
17134: mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
17135: args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
17136: }));
17137: return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908 raeburn 17138: }
17139: }
1.1262 raeburn 17140: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882 raeburn 17141: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566 albertel 17142: $can_clone = 1;
17143: } else {
1.1221 raeburn 17144: my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566 albertel 17145: $args->{'clonedomain'},$args->{'clonecourse'});
1.1221 raeburn 17146: if ($clonehash{'cloners'} eq '') {
17147: my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
17148: if ($domdefs{'canclone'}) {
17149: unless ($domdefs{'canclone'} eq 'none') {
17150: if ($domdefs{'canclone'} eq 'domain') {
17151: if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
17152: $can_clone = 1;
17153: }
17154: } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17155: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
17156: if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
17157: $clonehash{'internal.coursecode'},$args->{'crscode'})) {
17158: $can_clone = 1;
17159: }
17160: }
17161: }
17162: }
1.578 raeburn 17163: } else {
1.1221 raeburn 17164: my @cloners = split(/,/,$clonehash{'cloners'});
17165: if (grep(/^\*$/,@cloners)) {
1.942 raeburn 17166: $can_clone = 1;
1.1221 raeburn 17167: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942 raeburn 17168: $can_clone = 1;
1.1225 raeburn 17169: } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
17170: $can_clone = 1;
1.1221 raeburn 17171: }
17172: unless ($can_clone) {
1.1225 raeburn 17173: if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
17174: ($args->{'clonedomain'} eq $args->{'course_domain'})) {
1.1221 raeburn 17175: my (%gotdomdefaults,%gotcodedefaults);
17176: foreach my $cloner (@cloners) {
17177: if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
17178: ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
17179: my (%codedefaults,@code_order);
17180: if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
17181: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
17182: %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
17183: }
17184: if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
17185: @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
17186: }
17187: } else {
17188: &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
17189: \%codedefaults,
17190: \@code_order);
17191: $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
17192: $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
17193: }
17194: if (@code_order > 0) {
17195: if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
17196: $cloner,$clonehash{'internal.coursecode'},
17197: $args->{'crscode'})) {
17198: $can_clone = 1;
17199: last;
17200: }
17201: }
17202: }
17203: }
17204: }
1.1225 raeburn 17205: }
17206: }
17207: unless ($can_clone) {
17208: my $ccrole = 'cc';
17209: if ($args->{'crstype'} eq 'Community') {
17210: $ccrole = 'co';
17211: }
17212: my %roleshash =
17213: &Apache::lonnet::get_my_roles($args->{'ccuname'},
17214: $args->{'ccdomain'},
17215: 'userroles',['active'],[$ccrole],
17216: [$args->{'clonedomain'}]);
17217: if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
17218: $can_clone = 1;
17219: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
17220: $args->{'ccuname'},$args->{'ccdomain'})) {
17221: $can_clone = 1;
1.1221 raeburn 17222: }
17223: }
17224: unless ($can_clone) {
17225: if ($args->{'crstype'} eq 'Community') {
1.1344 raeburn 17226: push(@clonemsg,({
17227: mt => 'No new community created.',
17228: args => [],
17229: },
17230: {
17231: 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]).',
17232: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17233: }));
1.942 raeburn 17234: } else {
1.1344 raeburn 17235: push(@clonemsg,({
17236: mt => 'No new course created.',
17237: args => [],
17238: },
17239: {
17240: 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]).',
17241: args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
17242: }));
1.1221 raeburn 17243: }
1.566 albertel 17244: }
1.578 raeburn 17245: }
1.566 albertel 17246: }
1.1344 raeburn 17247: return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17248: }
17249:
1.444 albertel 17250: sub construct_course {
1.1262 raeburn 17251: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344 raeburn 17252: $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
17253: my ($outcome,$msgref,$clonemsgref);
1.541 raeburn 17254: my $linefeed = '<br />'."\n";
17255: if ($context eq 'auto') {
17256: $linefeed = "\n";
17257: }
1.566 albertel 17258:
17259: #
17260: # Are we cloning?
17261: #
1.1344 raeburn 17262: my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566 albertel 17263: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344 raeburn 17264: ($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566 albertel 17265: if (!$can_clone) {
1.1344 raeburn 17266: return (0,$outcome,$clonemsgref);
1.566 albertel 17267: }
17268: }
17269:
1.444 albertel 17270: #
17271: # Open course
17272: #
1.1239 raeburn 17273: my $showncrstype;
17274: if ($args->{'crstype'} eq 'Placement') {
17275: $showncrstype = 'placement test';
17276: } else {
17277: $showncrstype = lc($args->{'crstype'});
17278: }
1.444 albertel 17279: my %cenv=();
17280: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
17281: $args->{'cdescr'},
17282: $args->{'curl'},
17283: $args->{'course_home'},
17284: $args->{'nonstandard'},
17285: $args->{'crscode'},
17286: $args->{'ccuname'}.':'.
17287: $args->{'ccdomain'},
1.882 raeburn 17288: $args->{'crstype'},
1.1344 raeburn 17289: $cnum,$context,$category,
17290: $callercontext);
1.444 albertel 17291:
17292: # Note: The testing routines depend on this being output; see
17293: # Utils::Course. This needs to at least be output as a comment
17294: # if anyone ever decides to not show this, and Utils::Course::new
17295: # will need to be suitably modified.
1.1344 raeburn 17296: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17297: $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17298: } else {
17299: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
17300: }
1.943 raeburn 17301: if ($$courseid =~ /^error:/) {
1.1344 raeburn 17302: return (0,$outcome,$clonemsgref);
1.943 raeburn 17303: }
17304:
1.444 albertel 17305: #
17306: # Check if created correctly
17307: #
1.479 albertel 17308: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 17309: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943 raeburn 17310: if ($crsuhome eq 'no_host') {
1.1344 raeburn 17311: if (($callercontext eq 'auto') && ($user_lh ne '')) {
17312: $outcome .= &mt_user($user_lh,
17313: 'Course creation failed, unrecognized course home server.');
17314: } else {
17315: $outcome .= &mt('Course creation failed, unrecognized course home server.');
17316: }
17317: $outcome .= $linefeed;
17318: return (0,$outcome,$clonemsgref);
1.943 raeburn 17319: }
1.541 raeburn 17320: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 17321:
1.444 albertel 17322: #
1.566 albertel 17323: # Do the cloning
17324: #
1.1344 raeburn 17325: my @clonemsg;
1.566 albertel 17326: if ($can_clone && $cloneid) {
1.1344 raeburn 17327: push(@clonemsg,
17328: {
17329: mt => 'Created [_1] by cloning from [_2]',
17330: args => [$showncrstype,$clonetitle],
17331: });
1.566 albertel 17332: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 17333: # Copy all files
1.1344 raeburn 17334: my @info =
17335: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
17336: $args->{'dateshift'},$args->{'crscode'},
17337: $args->{'ccuname'}.':'.$args->{'ccdomain'},
17338: $args->{'tinyurls'});
17339: if (@info) {
17340: push(@clonemsg,@info);
17341: }
1.444 albertel 17342: # Restore URL
1.566 albertel 17343: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 17344: # Restore title
1.566 albertel 17345: $cenv{'description'}=$oldcenv{'description'};
1.955 raeburn 17346: # Restore creation date, creator and creation context.
17347: $cenv{'internal.created'}=$oldcenv{'internal.created'};
17348: $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
17349: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444 albertel 17350: # Mark as cloned
1.566 albertel 17351: $cenv{'clonedfrom'}=$cloneid;
1.638 www 17352: # Need to clone grading mode
17353: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
17354: $cenv{'grading'}=$newenv{'grading'};
17355: # Do not clone these environment entries
17356: &Apache::lonnet::del('environment',
17357: ['default_enrollment_start_date',
17358: 'default_enrollment_end_date',
17359: 'question.email',
17360: 'policy.email',
17361: 'comment.email',
17362: 'pch.users.denied',
1.725 raeburn 17363: 'plc.users.denied',
17364: 'hidefromcat',
1.1121 raeburn 17365: 'checkforpriv',
1.1355 raeburn 17366: 'categories'],
1.638 www 17367: $$crsudom,$$crsunum);
1.1170 raeburn 17368: if ($args->{'textbook'}) {
17369: $cenv{'internal.textbook'} = $args->{'textbook'};
17370: }
1.444 albertel 17371: }
1.566 albertel 17372:
1.444 albertel 17373: #
17374: # Set environment (will override cloned, if existing)
17375: #
17376: my @sections = ();
17377: my @xlists = ();
17378: if ($args->{'crstype'}) {
17379: $cenv{'type'}=$args->{'crstype'};
17380: }
1.1371 raeburn 17381: if ($args->{'lti'}) {
17382: $cenv{'internal.lti'}=$args->{'lti'};
17383: }
1.444 albertel 17384: if ($args->{'crsid'}) {
17385: $cenv{'courseid'}=$args->{'crsid'};
17386: }
17387: if ($args->{'crscode'}) {
17388: $cenv{'internal.coursecode'}=$args->{'crscode'};
17389: }
17390: if ($args->{'crsquota'} ne '') {
17391: $cenv{'internal.coursequota'}=$args->{'crsquota'};
17392: } else {
17393: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
17394: }
17395: if ($args->{'ccuname'}) {
17396: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
17397: ':'.$args->{'ccdomain'};
17398: } else {
17399: $cenv{'internal.courseowner'} = $args->{'curruser'};
17400: }
1.1116 raeburn 17401: if ($args->{'defaultcredits'}) {
17402: $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
17403: }
1.444 albertel 17404: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412 raeburn 17405: my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444 albertel 17406: if ($args->{'crssections'}) {
17407: $cenv{'internal.sectionnums'} = '';
17408: if ($args->{'crssections'} =~ m/,/) {
17409: @sections = split/,/,$args->{'crssections'};
17410: } else {
17411: $sections[0] = $args->{'crssections'};
17412: }
17413: if (@sections > 0) {
17414: foreach my $item (@sections) {
17415: my ($sec,$gp) = split/:/,$item;
17416: my $class = $args->{'crscode'}.$sec;
17417: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
17418: $cenv{'internal.sectionnums'} .= $item.',';
1.1412 raeburn 17419: if ($addcheck eq 'ok') {
17420: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17421: push(@oklcsecs,$gp);
17422: }
17423: } else {
1.1263 raeburn 17424: push(@badclasses,$class);
1.444 albertel 17425: }
17426: }
17427: $cenv{'internal.sectionnums'} =~ s/,$//;
17428: }
17429: }
17430: # do not hide course coordinator from staff listing,
17431: # even if privileged
17432: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121 raeburn 17433: # add course coordinator's domain to domains to check for privileged users
17434: # if different to course domain
17435: if ($$crsudom ne $args->{'ccdomain'}) {
17436: $cenv{'checkforpriv'} = $args->{'ccdomain'};
17437: }
1.444 albertel 17438: # add crosslistings
17439: if ($args->{'crsxlist'}) {
17440: $cenv{'internal.crosslistings'}='';
17441: if ($args->{'crsxlist'} =~ m/,/) {
17442: @xlists = split/,/,$args->{'crsxlist'};
17443: } else {
17444: $xlists[0] = $args->{'crsxlist'};
17445: }
17446: if (@xlists > 0) {
17447: foreach my $item (@xlists) {
17448: my ($xl,$gp) = split/:/,$item;
17449: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
17450: $cenv{'internal.crosslistings'} .= $item.',';
1.1412 raeburn 17451: if ($addcheck eq 'ok') {
17452: unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
17453: push(@oklcsecs,$gp);
17454: }
17455: } else {
1.1263 raeburn 17456: push(@badclasses,$xl);
1.444 albertel 17457: }
17458: }
17459: $cenv{'internal.crosslistings'} =~ s/,$//;
17460: }
17461: }
17462: if ($args->{'autoadds'}) {
17463: $cenv{'internal.autoadds'}=$args->{'autoadds'};
17464: }
17465: if ($args->{'autodrops'}) {
17466: $cenv{'internal.autodrops'}=$args->{'autodrops'};
17467: }
17468: # check for notification of enrollment changes
17469: my @notified = ();
17470: if ($args->{'notify_owner'}) {
17471: if ($args->{'ccuname'} ne '') {
17472: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
17473: }
17474: }
17475: if ($args->{'notify_dc'}) {
17476: if ($uname ne '') {
1.630 raeburn 17477: push(@notified,$uname.':'.$udom);
1.444 albertel 17478: }
17479: }
17480: if (@notified > 0) {
17481: my $notifylist;
17482: if (@notified > 1) {
17483: $notifylist = join(',',@notified);
17484: } else {
17485: $notifylist = $notified[0];
17486: }
17487: $cenv{'internal.notifylist'} = $notifylist;
17488: }
17489: if (@badclasses > 0) {
17490: my %lt=&Apache::lonlocal::texthash(
1.1264 raeburn 17491: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
17492: 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
17493: 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444 albertel 17494: );
1.1264 raeburn 17495: my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
17496: &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 17497: if ($context eq 'auto') {
17498: $outcome .= $badclass_msg.$linefeed;
1.1261 raeburn 17499: } else {
1.566 albertel 17500: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261 raeburn 17501: }
17502: foreach my $item (@badclasses) {
1.541 raeburn 17503: if ($context eq 'auto') {
1.1261 raeburn 17504: $outcome .= " - $item\n";
1.541 raeburn 17505: } else {
1.1261 raeburn 17506: $outcome .= "<li>$item</li>\n";
1.541 raeburn 17507: }
1.1261 raeburn 17508: }
17509: if ($context eq 'auto') {
17510: $outcome .= $linefeed;
17511: } else {
17512: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 17513: }
1.444 albertel 17514: }
17515: if ($args->{'no_end_date'}) {
17516: $args->{'endaccess'} = 0;
17517: }
1.1412 raeburn 17518: # If an official course with institutional sections is created by cloning
17519: # an existing course, section-specific hiding of course totals in student's
17520: # view of grades as copied from cloned course, will be checked for valid
17521: # sections.
17522: if (($can_clone && $cloneid) &&
17523: ($cenv{'internal.coursecode'} ne '') &&
17524: ($cenv{'grading'} eq 'standard') &&
17525: ($cenv{'hidetotals'} ne '') &&
17526: ($cenv{'hidetotals'} ne 'all')) {
17527: my @hidesecs;
17528: my $deletehidetotals;
17529: if (@oklcsecs) {
17530: foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
17531: if (grep(/^\Q$sec$/,@oklcsecs)) {
17532: push(@hidesecs,$sec);
17533: }
17534: }
17535: if (@hidesecs) {
17536: $cenv{'hidetotals'} = join(',',@hidesecs);
17537: } else {
17538: $deletehidetotals = 1;
17539: }
17540: } else {
17541: $deletehidetotals = 1;
17542: }
17543: if ($deletehidetotals) {
17544: delete($cenv{'hidetotals'});
17545: &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
17546: }
17547: }
1.444 albertel 17548: $cenv{'internal.autostart'}=$args->{'enrollstart'};
17549: $cenv{'internal.autoend'}=$args->{'enrollend'};
17550: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
17551: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
17552: if ($args->{'showphotos'}) {
17553: $cenv{'internal.showphotos'}=$args->{'showphotos'};
17554: }
17555: $cenv{'internal.authtype'} = $args->{'authtype'};
17556: $cenv{'internal.autharg'} = $args->{'autharg'};
17557: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
17558: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 17559: 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');
17560: if ($context eq 'auto') {
17561: $outcome .= $krb_msg;
17562: } else {
1.566 albertel 17563: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 17564: }
17565: $outcome .= $linefeed;
1.444 albertel 17566: }
17567: }
17568: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
17569: if ($args->{'setpolicy'}) {
17570: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17571: }
17572: if ($args->{'setcontent'}) {
17573: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17574: }
1.1251 raeburn 17575: if ($args->{'setcomment'}) {
17576: $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
17577: }
1.444 albertel 17578: }
17579: if ($args->{'reshome'}) {
17580: $cenv{'reshome'}=$args->{'reshome'}.'/';
17581: $cenv{'reshome'}=~s/\/+$/\//;
17582: }
17583: #
17584: # course has keyed access
17585: #
17586: if ($args->{'setkeys'}) {
17587: $cenv{'keyaccess'}='yes';
17588: }
17589: # if specified, key authority is not course, but user
17590: # only active if keyaccess is yes
17591: if ($args->{'keyauth'}) {
1.487 albertel 17592: my ($user,$domain) = split(':',$args->{'keyauth'});
17593: $user = &LONCAPA::clean_username($user);
17594: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 17595: if ($user ne '' && $domain ne '') {
1.487 albertel 17596: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 17597: }
17598: }
17599:
1.1166 raeburn 17600: #
1.1167 raeburn 17601: # generate and store uniquecode (available to course requester), if course should have one.
1.1166 raeburn 17602: #
17603: if ($args->{'uniquecode'}) {
17604: my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
17605: if ($code) {
17606: $cenv{'internal.uniquecode'} = $code;
1.1167 raeburn 17607: my %crsinfo =
17608: &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
17609: if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
17610: $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
17611: my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
17612: }
1.1166 raeburn 17613: if (ref($coderef)) {
17614: $$coderef = $code;
17615: }
17616: }
17617: }
17618:
1.444 albertel 17619: if ($args->{'disresdis'}) {
17620: $cenv{'pch.roles.denied'}='st';
17621: }
17622: if ($args->{'disablechat'}) {
17623: $cenv{'plc.roles.denied'}='st';
17624: }
17625:
17626: # Record we've not yet viewed the Course Initialization Helper for this
17627: # course
17628: $cenv{'course.helper.not.run'} = 1;
17629: #
17630: # Use new Randomseed
17631: #
17632: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
17633: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
17634: #
17635: # The encryption code and receipt prefix for this course
17636: #
17637: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
17638: $cenv{'internal.encpref'}=100+int(9*rand(99));
17639: #
17640: # By default, use standard grading
17641: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
17642:
1.541 raeburn 17643: $outcome .= $linefeed.&mt('Setting environment').': '.
17644: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17645: #
17646: # Open all assignments
17647: #
17648: if ($args->{'openall'}) {
1.1341 raeburn 17649: my $opendate = time;
17650: if ($args->{'openallfrom'} =~ /^\d+$/) {
17651: $opendate = $args->{'openallfrom'};
17652: }
1.444 albertel 17653: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341 raeburn 17654: my %storecontent = ($storeunder => $opendate,
1.444 albertel 17655: $storeunder.'.type' => 'date_start');
1.1341 raeburn 17656: $outcome .= &mt('All assignments open starting [_1]',
17657: &Apache::lonlocal::locallocaltime($opendate)).': '.
17658: &Apache::lonnet::cput
17659: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 17660: }
17661: #
17662: # Set first page
17663: #
17664: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
17665: || ($cloneid)) {
17666: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 17667:
17668: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
17669: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
17670:
1.444 albertel 17671: $outcome .= ($fatal?$errtext:'read ok').' - ';
17672: my $title; my $url;
17673: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 17674: $title=&mt('Syllabus');
1.444 albertel 17675: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
17676: } else {
1.963 raeburn 17677: $title=&mt('Table of Contents');
1.444 albertel 17678: $url='/adm/navmaps';
17679: }
1.445 albertel 17680:
17681: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
17682: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
17683:
17684: if ($errtext) { $fatal=2; }
1.541 raeburn 17685: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 17686: }
1.566 albertel 17687:
1.1237 raeburn 17688: #
17689: # Set params for Placement Tests
17690: #
1.1239 raeburn 17691: if ($args->{'crstype'} eq 'Placement') {
17692: my %storecontent;
17693: my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
17694: my %defaults = (
17695: buttonshide => { value => 'yes',
17696: type => 'string_yesno',},
17697: type => { value => 'randomizetry',
17698: type => 'string_questiontype',},
17699: maxtries => { value => 1,
17700: type => 'int_pos',},
17701: problemstatus => { value => 'no',
17702: type => 'string_problemstatus',},
17703: );
17704: foreach my $key (keys(%defaults)) {
17705: $storecontent{$prefix.$key} = $defaults{$key}{'value'};
17706: $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
17707: }
1.1237 raeburn 17708: &Apache::lonnet::cput
17709: ('resourcedata',\%storecontent,$$crsudom,$$crsunum);
17710: }
17711:
1.1344 raeburn 17712: return (1,$outcome,\@clonemsg);
1.444 albertel 17713: }
17714:
1.1166 raeburn 17715: sub make_unique_code {
17716: my ($cdom,$cnum) = @_;
17717: # get lock on uniquecodes db
17718: my $lockhash = {
17719: $cnum."\0".'uniquecodes' => $env{'user.name'}.
17720: ':'.$env{'user.domain'},
17721: };
17722: my $tries = 0;
17723: my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17724: my ($code,$error);
17725:
17726: while (($gotlock ne 'ok') && ($tries<3)) {
17727: $tries ++;
17728: sleep 1;
17729: $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
17730: }
17731: if ($gotlock eq 'ok') {
17732: my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
17733: my $gotcode;
17734: my $attempts = 0;
17735: while ((!$gotcode) && ($attempts < 100)) {
17736: $code = &generate_code();
17737: if (!exists($currcodes{$code})) {
17738: $gotcode = 1;
17739: unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
17740: $error = 'nostore';
17741: }
17742: }
17743: $attempts ++;
17744: }
17745: my @del_lock = ($cnum."\0".'uniquecodes');
17746: my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
17747: } else {
17748: $error = 'nolock';
17749: }
17750: return ($code,$error);
17751: }
17752:
17753: sub generate_code {
17754: my $code;
17755: my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
17756: for (my $i=0; $i<6; $i++) {
17757: my $lettnum = int (rand 2);
17758: my $item = '';
17759: if ($lettnum) {
17760: $item = $letts[int( rand(18) )];
17761: } else {
17762: $item = 1+int( rand(8) );
17763: }
17764: $code .= $item;
17765: }
17766: return $code;
17767: }
17768:
1.444 albertel 17769: ############################################################
17770: ############################################################
17771:
1.1237 raeburn 17772: # Community, Course and Placement Test
1.378 raeburn 17773: sub course_type {
17774: my ($cid) = @_;
17775: if (!defined($cid)) {
17776: $cid = $env{'request.course.id'};
17777: }
1.404 albertel 17778: if (defined($env{'course.'.$cid.'.type'})) {
17779: return $env{'course.'.$cid.'.type'};
1.378 raeburn 17780: } else {
17781: return 'Course';
1.377 raeburn 17782: }
17783: }
1.156 albertel 17784:
1.406 raeburn 17785: sub group_term {
17786: my $crstype = &course_type();
17787: my %names = (
17788: 'Course' => 'group',
1.865 raeburn 17789: 'Community' => 'group',
1.1237 raeburn 17790: 'Placement' => 'group',
1.406 raeburn 17791: );
17792: return $names{$crstype};
17793: }
17794:
1.902 raeburn 17795: sub course_types {
1.1310 raeburn 17796: my @types = ('official','unofficial','community','textbook','placement','lti');
1.902 raeburn 17797: my %typename = (
17798: official => 'Official course',
17799: unofficial => 'Unofficial course',
17800: community => 'Community',
1.1165 raeburn 17801: textbook => 'Textbook course',
1.1237 raeburn 17802: placement => 'Placement test',
1.1310 raeburn 17803: lti => 'LTI provider',
1.902 raeburn 17804: );
17805: return (\@types,\%typename);
17806: }
17807:
1.156 albertel 17808: sub icon {
17809: my ($file)=@_;
1.505 albertel 17810: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 17811: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 17812: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 17813: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
17814: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
17815: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17816: $curfext.".gif") {
17817: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
17818: $curfext.".gif";
17819: }
17820: }
1.249 albertel 17821: return &lonhttpdurl($iconname);
1.154 albertel 17822: }
1.84 albertel 17823:
1.575 albertel 17824: sub lonhttpdurl {
1.692 www 17825: #
17826: # Had been used for "small fry" static images on separate port 8080.
17827: # Modify here if lightweight http functionality desired again.
17828: # Currently eliminated due to increasing firewall issues.
17829: #
1.575 albertel 17830: my ($url)=@_;
1.692 www 17831: return $url;
1.215 albertel 17832: }
17833:
1.213 albertel 17834: sub connection_aborted {
17835: my ($r)=@_;
17836: $r->print(" ");$r->rflush();
17837: my $c = $r->connection;
17838: return $c->aborted();
17839: }
17840:
1.221 foxr 17841: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 17842: # strings as 'strings'.
17843: sub escape_single {
1.221 foxr 17844: my ($input) = @_;
1.223 albertel 17845: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 17846: $input =~ s/\'/\\\'/g; # Esacpe the 's....
17847: return $input;
17848: }
1.223 albertel 17849:
1.222 foxr 17850: # Same as escape_single, but escape's "'s This
17851: # can be used for "strings"
17852: sub escape_double {
17853: my ($input) = @_;
17854: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
17855: $input =~ s/\"/\\\"/g; # Esacpe the "s....
17856: return $input;
17857: }
1.223 albertel 17858:
1.222 foxr 17859: # Escapes the last element of a full URL.
17860: sub escape_url {
17861: my ($url) = @_;
1.238 raeburn 17862: my @urlslices = split(/\//, $url,-1);
1.369 www 17863: my $lastitem = &escape(pop(@urlslices));
1.1203 raeburn 17864: return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222 foxr 17865: }
1.462 albertel 17866:
1.820 raeburn 17867: sub compare_arrays {
17868: my ($arrayref1,$arrayref2) = @_;
17869: my (@difference,%count);
17870: @difference = ();
17871: %count = ();
17872: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
17873: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
17874: foreach my $element (keys(%count)) {
17875: if ($count{$element} == 1) {
17876: push(@difference,$element);
17877: }
17878: }
17879: }
17880: return @difference;
17881: }
17882:
1.1322 raeburn 17883: sub lon_status_items {
17884: my %defaults = (
17885: E => 100,
17886: W => 4,
17887: N => 1,
1.1324 raeburn 17888: U => 5,
1.1322 raeburn 17889: threshold => 200,
17890: sysmail => 2500,
17891: );
17892: my %names = (
17893: E => 'Errors',
17894: W => 'Warnings',
17895: N => 'Notices',
1.1324 raeburn 17896: U => 'Unsent',
1.1322 raeburn 17897: );
17898: return (\%defaults,\%names);
17899: }
17900:
1.817 bisitz 17901: # -------------------------------------------------------- Initialize user login
1.462 albertel 17902: sub init_user_environment {
1.463 albertel 17903: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 17904: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
17905:
17906: my $public=($username eq 'public' && $domain eq 'public');
17907:
1.1415 raeburn 17908: my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
17909: $coauthorenv);
1.462 albertel 17910: my $now=time;
17911:
17912: if ($public) {
17913: my $max_public=100;
17914: my $oldest;
17915: my $oldest_time=0;
17916: for(my $next=1;$next<=$max_public;$next++) {
17917: if (-e $lonids."/publicuser_$next.id") {
17918: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
17919: if ($mtime<$oldest_time || !$oldest_time) {
17920: $oldest_time=$mtime;
17921: $oldest=$next;
17922: }
17923: } else {
17924: $cookie="publicuser_$next";
17925: last;
17926: }
17927: }
17928: if (!$cookie) { $cookie="publicuser_$oldest"; }
17929: } else {
1.1275 raeburn 17930: # See if old ID present, if so, remove if this isn't a robot,
17931: # killing any existing non-robot sessions
1.463 albertel 17932: if (!$args->{'robot'}) {
17933: opendir(DIR,$lonids);
17934: while ($filename=readdir(DIR)) {
17935: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320 raeburn 17936: if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
17937: &GDBM_READER(),0640)) {
1.1295 raeburn 17938: my $linkedfile;
1.1320 raeburn 17939: if (exists($oldenv{'user.linkedenv'})) {
17940: $linkedfile = $oldenv{'user.linkedenv'};
1.1295 raeburn 17941: }
1.1320 raeburn 17942: untie(%oldenv);
17943: if (unlink("$lonids/$filename")) {
17944: if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
17945: if (-l "$lonids/$linkedfile.id") {
17946: unlink("$lonids/$linkedfile.id");
17947: }
1.1295 raeburn 17948: }
17949: }
17950: } else {
17951: unlink($lonids.'/'.$filename);
17952: }
1.463 albertel 17953: }
1.462 albertel 17954: }
1.463 albertel 17955: closedir(DIR);
1.1204 raeburn 17956: # If there is a undeleted lockfile for the user's paste buffer remove it.
17957: my $namespace = 'nohist_courseeditor';
17958: my $lockingkey = 'paste'."\0".'locked_num';
17959: my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
17960: $domain,$username);
17961: if (exists($lockhash{$lockingkey})) {
17962: my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
17963: unless ($delresult eq 'ok') {
17964: &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
17965: }
17966: }
1.462 albertel 17967: }
17968: # Give them a new cookie
1.463 albertel 17969: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 17970: : $now.$$.int(rand(10000)));
1.463 albertel 17971: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 17972:
17973: # Initialize roles
17974:
1.1414 raeburn 17975: ($userroles,$firstaccenv,$timerintenv,$coauthorenv) =
1.1062 raeburn 17976: &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462 albertel 17977: }
17978: # ------------------------------------ Check browser type and MathML capability
17979:
1.1194 raeburn 17980: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
17981: $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462 albertel 17982:
17983: # ------------------------------------------------------------- Get environment
17984:
17985: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
17986: my ($tmp) = keys(%userenv);
1.1275 raeburn 17987: if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462 albertel 17988: undef(%userenv);
17989: }
17990: if (($userenv{'interface'}) && (!$form->{'interface'})) {
17991: $form->{'interface'}=$userenv{'interface'};
17992: }
17993: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
17994:
17995: # --------------- Do not trust query string to be put directly into environment
1.817 bisitz 17996: foreach my $option ('interface','localpath','localres') {
17997: $form->{$option}=~s/[\n\r\=]//gs;
1.462 albertel 17998: }
17999: # --------------------------------------------------------- Write first profile
18000:
18001: {
1.1350 raeburn 18002: my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462 albertel 18003: my %initial_env =
18004: ("user.name" => $username,
18005: "user.domain" => $domain,
18006: "user.home" => $authhost,
18007: "browser.type" => $clientbrowser,
18008: "browser.version" => $clientversion,
18009: "browser.mathml" => $clientmathml,
18010: "browser.unicode" => $clientunicode,
18011: "browser.os" => $clientos,
1.1137 raeburn 18012: "browser.mobile" => $clientmobile,
1.1141 raeburn 18013: "browser.info" => $clientinfo,
1.1194 raeburn 18014: "browser.osversion" => $clientosversion,
1.462 albertel 18015: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
18016: "request.course.fn" => '',
18017: "request.course.uri" => '',
18018: "request.course.sec" => '',
18019: "request.role" => 'cm',
18020: "request.role.adv" => $env{'user.adv'},
1.1350 raeburn 18021: "request.host" => $ip,);
1.462 albertel 18022:
18023: if ($form->{'localpath'}) {
18024: $initial_env{"browser.localpath"} = $form->{'localpath'};
18025: $initial_env{"browser.localres"} = $form->{'localres'};
18026: }
18027:
18028: if ($form->{'interface'}) {
18029: $form->{'interface'}=~s/\W//gs;
18030: $initial_env{"browser.interface"} = $form->{'interface'};
18031: $env{'browser.interface'}=$form->{'interface'};
18032: }
18033:
1.1157 raeburn 18034: if ($form->{'iptoken'}) {
18035: my $lonhost = $r->dir_config('lonHostID');
18036: $initial_env{"user.noloadbalance"} = $lonhost;
18037: $env{'user.noloadbalance'} = $lonhost;
18038: }
18039:
1.1268 raeburn 18040: if ($form->{'noloadbalance'}) {
18041: my @hosts = &Apache::lonnet::current_machine_ids();
18042: my $hosthere = $form->{'noloadbalance'};
18043: if (grep(/^\Q$hosthere\E$/,@hosts)) {
18044: $initial_env{"user.noloadbalance"} = $hosthere;
18045: $env{'user.noloadbalance'} = $hosthere;
18046: }
18047: }
18048:
1.1016 raeburn 18049: unless ($domain eq 'public') {
1.1273 raeburn 18050: my %is_adv = ( is_adv => $env{'user.adv'} );
18051: my %domdef = &Apache::lonnet::get_domain_defaults($domain);
18052:
1.1414 raeburn 18053: foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
18054: $userenv{'availabletools.'.$tool} =
1.1273 raeburn 18055: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
18056: undef,\%userenv,\%domdef,\%is_adv);
18057: }
1.980 raeburn 18058:
1.1311 raeburn 18059: foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273 raeburn 18060: $userenv{'canrequest.'.$crstype} =
18061: &Apache::lonnet::usertools_access($username,$domain,$crstype,
18062: 'reload','requestcourses',
18063: \%userenv,\%domdef,\%is_adv);
18064: }
1.724 raeburn 18065:
1.1418 raeburn 18066: if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
18067: (exists($userroles->{"user.role.au./$domain/"}))) {
18068: if ($userenv{'authoreditors'}) {
18069: $userenv{'editors'} = $userenv{'authoreditors'};
18070: } elsif ($domdef{'editors'} ne '') {
18071: $userenv{'editors'} = $domdef{'editors'};
18072: } else {
18073: $userenv{'editors'} = 'edit,xml';
18074: }
1.1431 ! raeburn 18075: if ($userenv{'authorarchive'}) {
! 18076: $userenv{'canarchive'} = 1;
! 18077: } elsif (($userenv{'authorarchive'} eq '') &&
! 18078: ($domdef{'archive'})) {
! 18079: $userenv{'canarchive'} = 1;
! 18080: }
1.1418 raeburn 18081: }
18082:
1.1273 raeburn 18083: $userenv{'canrequest.author'} =
18084: &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
18085: 'reload','requestauthor',
1.980 raeburn 18086: \%userenv,\%domdef,\%is_adv);
1.1273 raeburn 18087: my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
18088: $domain,$username);
18089: my $reqstatus = $reqauthor{'author_status'};
18090: if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
18091: if (ref($reqauthor{'author'}) eq 'HASH') {
18092: $userenv{'requestauthorqueued'} = $reqstatus.':'.
18093: $reqauthor{'author'}{'timestamp'};
18094: }
1.1092 raeburn 18095: }
1.1287 raeburn 18096: my ($types,$typename) = &course_types();
18097: if (ref($types) eq 'ARRAY') {
18098: my @options = ('approval','validate','autolimit');
18099: my $optregex = join('|',@options);
18100: my (%willtrust,%trustchecked);
18101: foreach my $type (@{$types}) {
18102: my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
18103: if ($dom_str ne '') {
18104: my $updatedstr = '';
18105: my @possdomains = split(',',$dom_str);
18106: foreach my $entry (@possdomains) {
18107: my ($extdom,$extopt) = split(':',$entry);
18108: unless ($trustchecked{$extdom}) {
18109: $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
18110: $trustchecked{$extdom} = 1;
18111: }
18112: if ($willtrust{$extdom}) {
18113: $updatedstr .= $entry.',';
18114: }
18115: }
18116: $updatedstr =~ s/,$//;
18117: if ($updatedstr) {
18118: $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
18119: } else {
18120: delete($userenv{'reqcrsotherdom.'.$type});
18121: }
18122: }
18123: }
18124: }
1.1092 raeburn 18125: }
1.462 albertel 18126: $env{'user.environment'} = "$lonids/$cookie.id";
1.1062 raeburn 18127:
1.462 albertel 18128: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
18129: &GDBM_WRCREAT(),0640)) {
18130: &_add_to_env(\%disk_env,\%initial_env);
18131: &_add_to_env(\%disk_env,\%userenv,'environment.');
18132: &_add_to_env(\%disk_env,$userroles);
1.1062 raeburn 18133: if (ref($firstaccenv) eq 'HASH') {
18134: &_add_to_env(\%disk_env,$firstaccenv);
18135: }
18136: if (ref($timerintenv) eq 'HASH') {
18137: &_add_to_env(\%disk_env,$timerintenv);
18138: }
1.1414 raeburn 18139: if (ref($coauthorenv) eq 'HASH') {
18140: if (keys(%{$coauthorenv})) {
18141: &_add_to_env(\%disk_env,$coauthorenv);
18142: }
18143: }
1.463 albertel 18144: if (ref($args->{'extra_env'})) {
18145: &_add_to_env(\%disk_env,$args->{'extra_env'});
18146: }
1.462 albertel 18147: untie(%disk_env);
18148: } else {
1.705 tempelho 18149: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
18150: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 18151: return 'error: '.$!;
18152: }
18153: }
18154: $env{'request.role'}='cm';
18155: $env{'request.role.adv'}=$env{'user.adv'};
18156: $env{'browser.type'}=$clientbrowser;
18157:
18158: return $cookie;
18159:
18160: }
18161:
18162: sub _add_to_env {
18163: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 18164: if (ref($env_data) eq 'HASH') {
18165: while (my ($key,$value) = each(%$env_data)) {
18166: $idf->{$prefix.$key} = $value;
18167: $env{$prefix.$key} = $value;
18168: }
1.462 albertel 18169: }
18170: }
18171:
1.685 tempelho 18172: # --- Get the symbolic name of a problem and the url
18173: sub get_symb {
18174: my ($request,$silent) = @_;
1.726 raeburn 18175: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 18176: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
18177: if ($symb eq '') {
18178: if (!$silent) {
1.1071 raeburn 18179: if (ref($request)) {
18180: $request->print("Unable to handle ambiguous references:$url:.");
18181: }
1.685 tempelho 18182: return ();
18183: }
18184: }
18185: &Apache::lonenc::check_decrypt(\$symb);
18186: return ($symb);
18187: }
18188:
18189: # --------------------------------------------------------------Get annotation
18190:
18191: sub get_annotation {
18192: my ($symb,$enc) = @_;
18193:
18194: my $key = $symb;
18195: if (!$enc) {
18196: $key =
18197: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
18198: }
18199: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
18200: return $annotation{$key};
18201: }
18202:
18203: sub clean_symb {
1.731 raeburn 18204: my ($symb,$delete_enc) = @_;
1.685 tempelho 18205:
18206: &Apache::lonenc::check_decrypt(\$symb);
18207: my $enc = $env{'request.enc'};
1.731 raeburn 18208: if ($delete_enc) {
1.730 raeburn 18209: delete($env{'request.enc'});
18210: }
1.685 tempelho 18211:
18212: return ($symb,$enc);
18213: }
1.462 albertel 18214:
1.1181 raeburn 18215: ############################################################
18216: ############################################################
18217:
18218: =pod
18219:
18220: =head1 Routines for building display used to search for courses
18221:
18222:
18223: =over 4
18224:
18225: =item * &build_filters()
18226:
18227: Create markup for a table used to set filters to use when selecting
1.1182 raeburn 18228: courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
18229: and quotacheck.pl
18230:
1.1181 raeburn 18231:
18232: Inputs:
18233:
18234: filterlist - anonymous array of fields to include as potential filters
18235:
18236: crstype - course type
18237:
18238: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
18239: to pop-open a course selector (will contain "extra element").
18240:
18241: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
18242:
18243: filter - anonymous hash of criteria and their values
18244:
18245: action - form action
18246:
18247: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
18248:
1.1182 raeburn 18249: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181 raeburn 18250:
18251: cloneruname - username of owner of new course who wants to clone
18252:
18253: clonerudom - domain of owner of new course who wants to clone
18254:
18255: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
18256:
18257: codetitlesref - reference to array of titles of components in institutional codes (official courses)
18258:
18259: codedom - domain
18260:
18261: formname - value of form element named "form".
18262:
18263: fixeddom - domain, if fixed.
18264:
18265: prevphase - value to assign to form element named "phase" when going back to the previous screen
18266:
18267: cnameelement - name of form element in form on opener page which will receive title of selected course
18268:
18269: cnumelement - name of form element in form on opener page which will receive courseID of selected course
18270:
18271: cdomelement - name of form element in form on opener page which will receive domain of selected course
18272:
18273: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
18274:
18275: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
18276:
18277: clonewarning - warning message about missing information for intended course owner when DC creates a course
18278:
1.1182 raeburn 18279:
1.1181 raeburn 18280: Returns: $output - HTML for display of search criteria, and hidden form elements.
18281:
1.1182 raeburn 18282:
1.1181 raeburn 18283: Side Effects: None
18284:
18285: =cut
18286:
18287: # ---------------------------------------------- search for courses based on last activity etc.
18288:
18289: sub build_filters {
18290: my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
18291: $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
18292: $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
18293: $cnameelement,$cnumelement,$cdomelement,$setroles,
18294: $clonetext,$clonewarning) = @_;
1.1182 raeburn 18295: my ($list,$jscript);
1.1181 raeburn 18296: my $onchange = 'javascript:updateFilters(this)';
18297: my ($domainselectform,$sincefilterform,$createdfilterform,
18298: $ownerdomselectform,$persondomselectform,$instcodeform,
18299: $typeselectform,$instcodetitle);
18300: if ($formname eq '') {
18301: $formname = $caller;
18302: }
18303: foreach my $item (@{$filterlist}) {
18304: unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
18305: ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
18306: if ($item eq 'domainfilter') {
18307: $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
18308: } elsif ($item eq 'coursefilter') {
18309: $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
18310: } elsif ($item eq 'ownerfilter') {
18311: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18312: } elsif ($item eq 'ownerdomfilter') {
18313: $filter->{'ownerdomfilter'} =
18314: &LONCAPA::clean_domain($filter->{$item});
18315: $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
18316: 'ownerdomfilter',1);
18317: } elsif ($item eq 'personfilter') {
18318: $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
18319: } elsif ($item eq 'persondomfilter') {
18320: $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
18321: 'persondomfilter',1);
18322: } else {
18323: $filter->{$item} =~ s/\W//g;
18324: }
18325: if (!$filter->{$item}) {
18326: $filter->{$item} = '';
18327: }
18328: }
18329: if ($item eq 'domainfilter') {
18330: my $allow_blank = 1;
18331: if ($formname eq 'portform') {
18332: $allow_blank=0;
18333: } elsif ($formname eq 'studentform') {
18334: $allow_blank=0;
18335: }
18336: if ($fixeddom) {
18337: $domainselectform = '<input type="hidden" name="domainfilter"'.
18338: ' value="'.$codedom.'" />'.
18339: &Apache::lonnet::domain($codedom,'description');
18340: } else {
18341: $domainselectform = &select_dom_form($filter->{$item},
18342: 'domainfilter',
18343: $allow_blank,'',$onchange);
18344: }
18345: } else {
18346: $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
18347: }
18348: }
18349:
18350: # last course activity filter and selection
18351: $sincefilterform = &timebased_select_form('sincefilter',$filter);
18352:
18353: # course created filter and selection
18354: if (exists($filter->{'createdfilter'})) {
18355: $createdfilterform = &timebased_select_form('createdfilter',$filter);
18356: }
18357:
1.1239 raeburn 18358: my $prefix = $crstype;
18359: if ($crstype eq 'Placement') {
18360: $prefix = 'Placement Test'
18361: }
1.1181 raeburn 18362: my %lt = &Apache::lonlocal::texthash(
1.1239 raeburn 18363: 'cac' => "$prefix Activity",
18364: 'ccr' => "$prefix Created",
18365: 'cde' => "$prefix Title",
18366: 'cdo' => "$prefix Domain",
1.1181 raeburn 18367: 'ins' => 'Institutional Code',
18368: 'inc' => 'Institutional Categorization',
1.1239 raeburn 18369: 'cow' => "$prefix Owner/Co-owner",
18370: 'cop' => "$prefix Personnel Includes",
1.1181 raeburn 18371: 'cog' => 'Type',
18372: );
18373:
18374: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18375: my $typeval = 'Course';
18376: if ($crstype eq 'Community') {
18377: $typeval = 'Community';
1.1239 raeburn 18378: } elsif ($crstype eq 'Placement') {
18379: $typeval = 'Placement';
1.1181 raeburn 18380: }
18381: $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
18382: } else {
18383: $typeselectform = '<select name="type" size="1"';
18384: if ($onchange) {
18385: $typeselectform .= ' onchange="'.$onchange.'"';
18386: }
18387: $typeselectform .= '>'."\n";
1.1237 raeburn 18388: foreach my $posstype ('Course','Community','Placement') {
1.1239 raeburn 18389: my $shown;
18390: if ($posstype eq 'Placement') {
18391: $shown = &mt('Placement Test');
18392: } else {
18393: $shown = &mt($posstype);
18394: }
1.1181 raeburn 18395: $typeselectform.='<option value="'.$posstype.'"'.
1.1239 raeburn 18396: ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181 raeburn 18397: }
18398: $typeselectform.="</select>";
18399: }
18400:
18401: my ($cloneableonlyform,$cloneabletitle);
18402: if (exists($filter->{'cloneableonly'})) {
18403: my $cloneableon = '';
18404: my $cloneableoff = ' checked="checked"';
18405: if ($filter->{'cloneableonly'}) {
18406: $cloneableon = $cloneableoff;
18407: $cloneableoff = '';
18408: }
18409: $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>';
18410: if ($formname eq 'ccrs') {
1.1187 bisitz 18411: $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181 raeburn 18412: } else {
18413: $cloneabletitle = &mt('Cloneable by you');
18414: }
18415: }
18416: my $officialjs;
18417: if ($crstype eq 'Course') {
18418: if (exists($filter->{'instcodefilter'})) {
1.1182 raeburn 18419: # if (($fixeddom) || ($formname eq 'requestcrs') ||
18420: # ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
18421: if ($codedom) {
1.1181 raeburn 18422: $officialjs = 1;
18423: ($instcodeform,$jscript,$$numtitlesref) =
18424: &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
18425: $officialjs,$codetitlesref);
18426: if ($jscript) {
1.1182 raeburn 18427: $jscript = '<script type="text/javascript">'."\n".
18428: '// <![CDATA['."\n".
18429: $jscript."\n".
18430: '// ]]>'."\n".
18431: '</script>'."\n";
1.1181 raeburn 18432: }
18433: }
18434: if ($instcodeform eq '') {
18435: $instcodeform =
18436: '<input type="text" name="instcodefilter" size="10" value="'.
18437: $list->{'instcodefilter'}.'" />';
18438: $instcodetitle = $lt{'ins'};
18439: } else {
18440: $instcodetitle = $lt{'inc'};
18441: }
18442: if ($fixeddom) {
18443: $instcodetitle .= '<br />('.$codedom.')';
18444: }
18445: }
18446: }
18447: my $output = qq|
18448: <form method="post" name="filterpicker" action="$action">
18449: <input type="hidden" name="form" value="$formname" />
18450: |;
18451: if ($formname eq 'modifycourse') {
18452: $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
18453: '<input type="hidden" name="prevphase" value="'.
18454: $prevphase.'" />'."\n";
1.1198 musolffc 18455: } elsif ($formname eq 'quotacheck') {
18456: $output .= qq|
18457: <input type="hidden" name="sortby" value="" />
18458: <input type="hidden" name="sortorder" value="" />
18459: |;
18460: } else {
1.1181 raeburn 18461: my $name_input;
18462: if ($cnameelement ne '') {
18463: $name_input = '<input type="hidden" name="cnameelement" value="'.
18464: $cnameelement.'" />';
18465: }
18466: $output .= qq|
1.1182 raeburn 18467: <input type="hidden" name="cnumelement" value="$cnumelement" />
18468: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181 raeburn 18469: $name_input
18470: $roleelement
18471: $multelement
18472: $typeelement
18473: |;
18474: if ($formname eq 'portform') {
18475: $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
18476: }
18477: }
18478: if ($fixeddom) {
18479: $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
18480: }
18481: $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
18482: if ($sincefilterform) {
18483: $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
18484: .$sincefilterform
18485: .&Apache::lonhtmlcommon::row_closure();
18486: }
18487: if ($createdfilterform) {
18488: $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
18489: .$createdfilterform
18490: .&Apache::lonhtmlcommon::row_closure();
18491: }
18492: if ($domainselectform) {
18493: $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
18494: .$domainselectform
18495: .&Apache::lonhtmlcommon::row_closure();
18496: }
18497: if ($typeselectform) {
18498: if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
18499: $output .= $typeselectform;
18500: } else {
18501: $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
18502: .$typeselectform
18503: .&Apache::lonhtmlcommon::row_closure();
18504: }
18505: }
18506: if ($instcodeform) {
18507: $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
18508: .$instcodeform
18509: .&Apache::lonhtmlcommon::row_closure();
18510: }
18511: if (exists($filter->{'ownerfilter'})) {
18512: $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
18513: '<table><tr><td>'.&mt('Username').'<br />'.
18514: '<input type="text" name="ownerfilter" size="20" value="'.
18515: $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18516: $ownerdomselectform.'</td></tr></table>'.
18517: &Apache::lonhtmlcommon::row_closure();
18518: }
18519: if (exists($filter->{'personfilter'})) {
18520: $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
18521: '<table><tr><td>'.&mt('Username').'<br />'.
18522: '<input type="text" name="personfilter" size="20" value="'.
18523: $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
18524: $persondomselectform.'</td></tr></table>'.
18525: &Apache::lonhtmlcommon::row_closure();
18526: }
18527: if (exists($filter->{'coursefilter'})) {
18528: $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
18529: .'<input type="text" name="coursefilter" size="25" value="'
18530: .$list->{'coursefilter'}.'" />'
18531: .&Apache::lonhtmlcommon::row_closure();
18532: }
18533: if ($cloneableonlyform) {
18534: $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
18535: $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
18536: }
18537: if (exists($filter->{'descriptfilter'})) {
18538: $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
18539: .'<input type="text" name="descriptfilter" size="40" value="'
18540: .$list->{'descriptfilter'}.'" />'
18541: .&Apache::lonhtmlcommon::row_closure(1);
18542: }
18543: $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
18544: '<input type="hidden" name="updater" value="" />'."\n".
18545: '<input type="submit" name="gosearch" value="'.
18546: &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
18547: return $jscript.$clonewarning.$output;
18548: }
18549:
18550: =pod
18551:
18552: =item * &timebased_select_form()
18553:
1.1182 raeburn 18554: Create markup for a dropdown list used to select a time-based
1.1181 raeburn 18555: filter e.g., Course Activity, Course Created, when searching for courses
18556: or communities
18557:
18558: Inputs:
18559:
18560: item - name of form element (sincefilter or createdfilter)
18561:
18562: filter - anonymous hash of criteria and their values
18563:
18564: Returns: HTML for a select box contained a blank, then six time selections,
18565: with value set in incoming form variables currently selected.
18566:
18567: Side Effects: None
18568:
18569: =cut
18570:
18571: sub timebased_select_form {
18572: my ($item,$filter) = @_;
18573: if (ref($filter) eq 'HASH') {
18574: $filter->{$item} =~ s/[^\d-]//g;
18575: if (!$filter->{$item}) { $filter->{$item}=-1; }
18576: return &select_form(
18577: $filter->{$item},
18578: $item,
18579: { '-1' => '',
18580: '86400' => &mt('today'),
18581: '604800' => &mt('last week'),
18582: '2592000' => &mt('last month'),
18583: '7776000' => &mt('last three months'),
18584: '15552000' => &mt('last six months'),
18585: '31104000' => &mt('last year'),
18586: 'select_form_order' =>
18587: ['-1','86400','604800','2592000','7776000',
18588: '15552000','31104000']});
18589: }
18590: }
18591:
18592: =pod
18593:
18594: =item * &js_changer()
18595:
18596: Create script tag containing Javascript used to submit course search form
1.1183 raeburn 18597: when course type or domain is changed, and also to hide 'Searching ...' on
18598: page load completion for page showing search result.
1.1181 raeburn 18599:
18600: Inputs: None
18601:
1.1183 raeburn 18602: Returns: markup containing updateFilters() and hideSearching() javascript functions.
1.1181 raeburn 18603:
18604: Side Effects: None
18605:
18606: =cut
18607:
18608: sub js_changer {
18609: return <<ENDJS;
18610: <script type="text/javascript">
18611: // <![CDATA[
18612: function updateFilters(caller) {
18613: if (typeof(caller) != "undefined") {
18614: document.filterpicker.updater.value = caller.name;
18615: }
18616: document.filterpicker.submit();
18617: }
1.1183 raeburn 18618:
18619: function hideSearching() {
18620: if (document.getElementById('searching')) {
18621: document.getElementById('searching').style.display = 'none';
18622: }
18623: return;
18624: }
18625:
1.1181 raeburn 18626: // ]]>
18627: </script>
18628:
18629: ENDJS
18630: }
18631:
18632: =pod
18633:
1.1182 raeburn 18634: =item * &search_courses()
18635:
18636: Process selected filters form course search form and pass to lonnet::courseiddump
18637: to retrieve a hash for which keys are courseIDs which match the selected filters.
18638:
18639: Inputs:
18640:
18641: dom - domain being searched
18642:
18643: type - course type ('Course' or 'Community' or '.' if any).
18644:
18645: filter - anonymous hash of criteria and their values
18646:
18647: numtitles - for institutional codes - number of categories
18648:
18649: cloneruname - optional username of new course owner
18650:
18651: clonerudom - optional domain of new course owner
18652:
1.1221 raeburn 18653: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1182 raeburn 18654: (used when DC is using course creation form)
18655:
18656: codetitles - reference to array of titles of components in institutional codes (official courses).
18657:
1.1221 raeburn 18658: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
18659: (and so can clone automatically)
18660:
18661: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
18662:
18663: reqinstcode - institutional code of new course, where search_courses is used to identify potential
18664: courses to clone
1.1182 raeburn 18665:
18666: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
18667:
18668:
18669: Side Effects: None
18670:
18671: =cut
18672:
18673:
18674: sub search_courses {
1.1221 raeburn 18675: my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
18676: $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182 raeburn 18677: my (%courses,%showcourses,$cloner);
18678: if (($filter->{'ownerfilter'} ne '') ||
18679: ($filter->{'ownerdomfilter'} ne '')) {
18680: $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
18681: $filter->{'ownerdomfilter'};
18682: }
18683: foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
18684: if (!$filter->{$item}) {
18685: $filter->{$item}='.';
18686: }
18687: }
18688: my $now = time;
18689: my $timefilter =
18690: ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
18691: my ($createdbefore,$createdafter);
18692: if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
18693: $createdbefore = $now;
18694: $createdafter = $now-$filter->{'createdfilter'};
18695: }
18696: my ($instcodefilter,$regexpok);
18697: if ($numtitles) {
18698: if ($env{'form.official'} eq 'on') {
18699: $instcodefilter =
18700: &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18701: $regexpok = 1;
18702: } elsif ($env{'form.official'} eq 'off') {
18703: $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
18704: unless ($instcodefilter eq '') {
18705: $regexpok = -1;
18706: }
18707: }
18708: } else {
18709: $instcodefilter = $filter->{'instcodefilter'};
18710: }
18711: if ($instcodefilter eq '') { $instcodefilter = '.'; }
18712: if ($type eq '') { $type = '.'; }
18713:
18714: if (($clonerudom ne '') && ($cloneruname ne '')) {
18715: $cloner = $cloneruname.':'.$clonerudom;
18716: }
18717: %courses = &Apache::lonnet::courseiddump($dom,
18718: $filter->{'descriptfilter'},
18719: $timefilter,
18720: $instcodefilter,
18721: $filter->{'combownerfilter'},
18722: $filter->{'coursefilter'},
18723: undef,undef,$type,$regexpok,undef,undef,
1.1221 raeburn 18724: undef,undef,$cloner,$cc_clone,
1.1182 raeburn 18725: $filter->{'cloneableonly'},
18726: $createdbefore,$createdafter,undef,
1.1221 raeburn 18727: $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182 raeburn 18728: if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
18729: my $ccrole;
18730: if ($type eq 'Community') {
18731: $ccrole = 'co';
18732: } else {
18733: $ccrole = 'cc';
18734: }
18735: my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
18736: $filter->{'persondomfilter'},
18737: 'userroles',undef,
18738: [$ccrole,'in','ad','ep','ta','cr'],
18739: $dom);
18740: foreach my $role (keys(%rolehash)) {
18741: my ($cnum,$cdom,$courserole) = split(':',$role);
18742: my $cid = $cdom.'_'.$cnum;
18743: if (exists($courses{$cid})) {
18744: if (ref($courses{$cid}) eq 'HASH') {
18745: if (ref($courses{$cid}{roles}) eq 'ARRAY') {
18746: if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263 raeburn 18747: push(@{$courses{$cid}{roles}},$courserole);
1.1182 raeburn 18748: }
18749: } else {
18750: $courses{$cid}{roles} = [$courserole];
18751: }
18752: $showcourses{$cid} = $courses{$cid};
18753: }
18754: }
18755: }
18756: %courses = %showcourses;
18757: }
18758: return %courses;
18759: }
18760:
18761: =pod
18762:
1.1181 raeburn 18763: =back
18764:
1.1207 raeburn 18765: =head1 Routines for version requirements for current course.
18766:
18767: =over 4
18768:
18769: =item * &check_release_required()
18770:
18771: Compares required LON-CAPA version with version on server, and
18772: if required version is newer looks for a server with the required version.
18773:
18774: Looks first at servers in user's owen domain; if none suitable, looks at
18775: servers in course's domain are permitted to host sessions for user's domain.
18776:
18777: Inputs:
18778:
18779: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18780:
18781: $courseid - Course ID of current course
18782:
18783: $rolecode - User's current role in course (for switchserver query string).
18784:
18785: $required - LON-CAPA version needed by course (format: Major.Minor).
18786:
18787:
18788: Returns:
18789:
18790: $switchserver - query string tp append to /adm/switchserver call (if
18791: current server's LON-CAPA version is too old.
18792:
18793: $warning - Message is displayed if no suitable server could be found.
18794:
18795: =cut
18796:
18797: sub check_release_required {
18798: my ($loncaparev,$courseid,$rolecode,$required) = @_;
18799: my ($switchserver,$warning);
18800: if ($required ne '') {
18801: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
18802: my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18803: if ($reqdmajor ne '' && $reqdminor ne '') {
18804: my $otherserver;
18805: if (($major eq '' && $minor eq '') ||
18806: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
18807: my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
18808: my $switchlcrev =
18809: &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
18810: $userdomserver);
18811: my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
18812: if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
18813: (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
18814: my $cdom = $env{'course.'.$courseid.'.domain'};
18815: if ($cdom ne $env{'user.domain'}) {
18816: my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
18817: my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
18818: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
18819: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
18820: my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
18821: my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
18822: my $canhost =
18823: &Apache::lonnet::can_host_session($env{'user.domain'},
18824: $coursedomserver,
18825: $remoterev,
18826: $udomdefaults{'remotesessions'},
18827: $defdomdefaults{'hostedsessions'});
18828:
18829: if ($canhost) {
18830: $otherserver = $coursedomserver;
18831: } else {
18832: $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.");
18833: }
18834: } else {
18835: $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).");
18836: }
18837: } else {
18838: $otherserver = $userdomserver;
18839: }
18840: }
18841: if ($otherserver ne '') {
18842: $switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
18843: }
18844: }
18845: }
18846: return ($switchserver,$warning);
18847: }
18848:
18849: =pod
18850:
18851: =item * &check_release_result()
18852:
18853: Inputs:
18854:
18855: $switchwarning - Warning message if no suitable server found to host session.
18856:
18857: $switchserver - query string to append to /adm/switchserver containing lonHostID
18858: and current role.
18859:
18860: Returns: HTML to display with information about requirement to switch server.
18861: Either displaying warning with link to Roles/Courses screen or
18862: display link to switchserver.
18863:
1.1181 raeburn 18864: =cut
18865:
1.1207 raeburn 18866: sub check_release_result {
18867: my ($switchwarning,$switchserver) = @_;
18868: my $output = &start_page('Selected course unavailable on this server').
18869: '<p class="LC_warning">';
18870: if ($switchwarning) {
18871: $output .= $switchwarning.'<br /><a href="/adm/roles">';
18872: if (&show_course()) {
18873: $output .= &mt('Display courses');
18874: } else {
18875: $output .= &mt('Display roles');
18876: }
18877: $output .= '</a>';
18878: } elsif ($switchserver) {
18879: $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
18880: '<br />'.
18881: '<a href="/adm/switchserver?'.$switchserver.'">'.
18882: &mt('Switch Server').
18883: '</a>';
18884: }
18885: $output .= '</p>'.&end_page();
18886: return $output;
18887: }
18888:
18889: =pod
18890:
18891: =item * &needs_coursereinit()
18892:
18893: Determine if course contents stored for user's session needs to be
18894: refreshed, because content has changed since "Big Hash" last tied.
18895:
18896: Check for change is made if time last checked is more than 10 minutes ago
18897: (by default).
18898:
18899: Inputs:
18900:
18901: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
18902:
18903: $interval (optional) - Time which may elapse (in s) between last check for content
18904: change in current course. (default: 600 s).
18905:
18906: Returns: an array; first element is:
18907:
18908: =over 4
18909:
18910: 'switch' - if content updates mean user's session
18911: needs to be switched to a server running a newer LON-CAPA version
18912:
18913: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
18914: on current server hosting user's session
18915:
18916: '' - if no action required.
18917:
18918: =back
18919:
18920: If first item element is 'switch':
18921:
18922: second item is $switchwarning - Warning message if no suitable server found to host session.
18923:
18924: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
18925: and current role.
18926:
18927: otherwise: no other elements returned.
18928:
18929: =back
18930:
18931: =cut
18932:
18933: sub needs_coursereinit {
18934: my ($loncaparev,$interval) = @_;
18935: return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
18936: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
18937: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
18938: my $now = time;
18939: if ($interval eq '') {
18940: $interval = 600;
18941: }
18942: if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282 raeburn 18943: &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372 raeburn 18944: my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 18945: if ($blocked) {
18946: return ();
18947: }
1.1391 raeburn 18948: my $update;
18949: my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
18950: my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
18951: if ($lastmainchange > $env{'request.course.tied'}) {
18952: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18953: if ($needswitch) {
18954: return ('switch',$switchwarning,$switchserver);
18955: }
18956: $update = 'main';
18957: }
18958: if ($lastsuppchange > $env{'request.course.suppupdated'}) {
18959: if ($update) {
18960: $update = 'both';
18961: } else {
18962: my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
18963: if ($needswitch) {
18964: return ('switch',$switchwarning,$switchserver);
18965: } else {
18966: $update = 'supp';
1.1207 raeburn 18967: }
18968: }
1.1391 raeburn 18969: return ($update);
18970: }
18971: }
18972: return ();
18973: }
18974:
18975: sub switch_for_update {
18976: my ($loncaparev,$cdom,$cnum) = @_;
18977: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18978: if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
18979: my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
18980: if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
18981: &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
18982: $curr_reqd_hash{'internal.releaserequired'}});
18983: my ($switchserver,$switchwarning) =
18984: &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
18985: $curr_reqd_hash{'internal.releaserequired'});
18986: if ($switchwarning ne '' || $switchserver ne '') {
18987: return ('switch',$switchwarning,$switchserver);
18988: }
1.1207 raeburn 18989: }
18990: }
18991: return ();
18992: }
1.1181 raeburn 18993:
1.1083 raeburn 18994: sub update_content_constraints {
1.1395 raeburn 18995: my ($cdom,$cnum,$chome,$cid) = @_;
1.1083 raeburn 18996: my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
18997: my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307 raeburn 18998: my (%checkresponsetypes,%checkcrsrestypes);
1.1083 raeburn 18999: foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236 raeburn 19000: my ($item,$name,$value) = split(/:/,$key);
1.1083 raeburn 19001: if ($item eq 'resourcetag') {
19002: if ($name eq 'responsetype') {
19003: $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
19004: }
1.1307 raeburn 19005: } elsif ($item eq 'course') {
19006: if ($name eq 'courserestype') {
19007: $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
19008: }
1.1083 raeburn 19009: }
19010: }
19011: my $navmap = Apache::lonnavmaps::navmap->new();
19012: if (defined($navmap)) {
1.1307 raeburn 19013: my (%allresponses,%allcrsrestypes);
19014: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
19015: if ($res->is_tool()) {
19016: if ($allcrsrestypes{'exttool'}) {
19017: $allcrsrestypes{'exttool'} ++;
19018: } else {
19019: $allcrsrestypes{'exttool'} = 1;
19020: }
19021: next;
19022: }
1.1083 raeburn 19023: my %responses = $res->responseTypes();
19024: foreach my $key (keys(%responses)) {
19025: next unless(exists($checkresponsetypes{$key}));
19026: $allresponses{$key} += $responses{$key};
19027: }
19028: }
19029: foreach my $key (keys(%allresponses)) {
19030: my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
19031: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19032: ($reqdmajor,$reqdminor) = ($major,$minor);
19033: }
19034: }
1.1307 raeburn 19035: foreach my $key (keys(%allcrsrestypes)) {
1.1308 raeburn 19036: my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307 raeburn 19037: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19038: ($reqdmajor,$reqdminor) = ($major,$minor);
19039: }
19040: }
1.1083 raeburn 19041: undef($navmap);
19042: }
1.1391 raeburn 19043: if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308 raeburn 19044: my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
19045: if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
19046: ($reqdmajor,$reqdminor) = ($major,$minor);
19047: }
19048: }
1.1083 raeburn 19049: unless (($reqdmajor eq '') && ($reqdminor eq '')) {
19050: &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
19051: }
19052: return;
19053: }
19054:
1.1110 raeburn 19055: sub allmaps_incourse {
19056: my ($cdom,$cnum,$chome,$cid) = @_;
19057: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
19058: $cid = $env{'request.course.id'};
19059: $cdom = $env{'course.'.$cid.'.domain'};
19060: $cnum = $env{'course.'.$cid.'.num'};
19061: $chome = $env{'course.'.$cid.'.home'};
19062: }
19063: my %allmaps = ();
19064: my $lastchange =
19065: &Apache::lonnet::get_coursechange($cdom,$cnum);
19066: if ($lastchange > $env{'request.course.tied'}) {
19067: my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
19068: unless ($ferr) {
1.1395 raeburn 19069: &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110 raeburn 19070: }
19071: }
19072: my $navmap = Apache::lonnavmaps::navmap->new();
19073: if (defined($navmap)) {
19074: foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
19075: $allmaps{$res->src()} = 1;
19076: }
19077: }
19078: return \%allmaps;
19079: }
19080:
1.1083 raeburn 19081: sub parse_supplemental_title {
19082: my ($title) = @_;
19083:
19084: my ($foldertitle,$renametitle);
19085: if ($title =~ /&&&/) {
19086: $title = &HTML::Entites::decode($title);
19087: }
19088: if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
19089: $renametitle=$4;
19090: my ($time,$uname,$udom) = ($1,$2,$3);
19091: $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
19092: my $name = &plainname($uname,$udom);
19093: $name = &HTML::Entities::encode($name,'"<>&\'');
19094: $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401 raeburn 19095: $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402 raeburn 19096: if ($foldertitle ne '') {
1.1401 raeburn 19097: $title .= ': <br />'.$foldertitle;
19098: }
1.1083 raeburn 19099: }
19100: if (wantarray) {
19101: return ($title,$foldertitle,$renametitle);
19102: }
19103: return $title;
19104: }
19105:
1.1395 raeburn 19106: sub get_supplemental {
19107: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
19108: my $hashid=$cnum.':'.$cdom;
19109: my ($supplemental,$cached,$set_httprefs);
19110: unless ($ignorecache) {
19111: ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
19112: }
19113: unless (defined($cached)) {
19114: my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
19115: unless ($chome eq 'no_host') {
19116: my @order = @LONCAPA::map::order;
19117: my @resources = @LONCAPA::map::resources;
19118: my @resparms = @LONCAPA::map::resparms;
19119: my @zombies = @LONCAPA::map::zombies;
19120: my ($errors,%ids,%hidden);
19121: $errors =
19122: &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
19123: $errors,$possdel,\%ids,\%hidden);
19124: @LONCAPA::map::order = @order;
19125: @LONCAPA::map::resources = @resources;
19126: @LONCAPA::map::resparms = @resparms;
19127: @LONCAPA::map::zombies = @zombies;
19128: $set_httprefs = 1;
19129: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19130: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19131: }
19132: $supplemental = {
19133: ids => \%ids,
19134: hidden => \%hidden,
19135: };
19136: &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
19137: }
19138: }
19139: return ($supplemental,$set_httprefs);
19140: }
19141:
1.1143 raeburn 19142: sub recurse_supplemental {
1.1391 raeburn 19143: my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
19144: if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
19145: my $mapnum;
19146: if ($suppmap eq 'supplemental.sequence') {
19147: $mapnum = 0;
19148: } else {
19149: ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
19150: }
1.1143 raeburn 19151: my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
19152: if ($fatal) {
19153: $errors ++;
19154: } else {
1.1389 raeburn 19155: my @order = @LONCAPA::map::order;
19156: if (@order > 0) {
19157: my @resources = @LONCAPA::map::resources;
1.1391 raeburn 19158: my @resparms = @LONCAPA::map::resparms;
1.1389 raeburn 19159: foreach my $idx (@order) {
19160: my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143 raeburn 19161: if (($src ne '') && ($status eq 'res')) {
1.1391 raeburn 19162: my $id = $mapnum.':'.$idx;
19163: push(@{$suppids->{$src}},$id);
19164: if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
19165: $hiddensupp->{$id} = 1;
19166: }
1.1146 raeburn 19167: if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391 raeburn 19168: $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
19169: $hiddensupp,$hiddensupp->{$id});
1.1143 raeburn 19170: } else {
1.1391 raeburn 19171: my $allowed;
19172: if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
19173: $allowed = 1;
19174: } elsif ($possdel) {
19175: foreach my $item (@{$suppids->{$src}}) {
19176: next if ($item eq $id);
19177: unless ($hiddensupp->{$item}) {
19178: $allowed = 1;
19179: last;
19180: }
19181: }
19182: if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
19183: &Apache::lonnet::delenv('httpref.'.$src);
19184: }
19185: }
19186: if ($allowed && (!exists($env{'httpref.'.$src}))) {
19187: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308 raeburn 19188: }
1.1143 raeburn 19189: }
19190: }
19191: }
19192: }
19193: }
19194: }
1.1391 raeburn 19195: return $errors;
19196: }
19197:
19198: sub set_supp_httprefs {
19199: my ($cnum,$cdom,$supplemental,$possdel) = @_;
19200: if (ref($supplemental) eq 'HASH') {
19201: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
19202: foreach my $src (keys(%{$supplemental->{'ids'}})) {
19203: next if ($src =~ /\.sequence$/);
19204: if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
19205: my $allowed;
19206: if ($env{'request.role.adv'}) {
19207: $allowed = 1;
19208: } else {
19209: foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
19210: unless ($supplemental->{'hidden'}->{$id}) {
19211: $allowed = 1;
19212: last;
19213: }
19214: }
19215: }
19216: if (exists($env{'httpref.'.$src})) {
19217: if ($possdel) {
19218: unless ($allowed) {
19219: &Apache::lonnet::delenv('httpref.'.$src);
19220: }
19221: }
19222: } elsif ($allowed) {
19223: &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
19224: }
19225: }
19226: }
19227: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
19228: &Apache::lonnet::appenv({'request.course.suppupdated' => time});
19229: }
19230: }
19231: }
19232: }
19233:
19234: sub get_supp_parameter {
19235: my ($resparm,$name)=@_;
19236: return if ($resparm eq '');
19237: my $value=undef;
19238: my $ptype=undef;
19239: foreach (split('&&&',$resparm)) {
19240: my ($thistype,$thisname,$thisvalue)=split('___',$_);
19241: if ($thisname eq $name) {
19242: $value=$thisvalue;
19243: $ptype=$thistype;
19244: }
19245: }
19246: return $value;
1.1143 raeburn 19247: }
19248:
1.1101 raeburn 19249: sub symb_to_docspath {
1.1267 raeburn 19250: my ($symb,$navmapref) = @_;
19251: return unless ($symb && ref($navmapref));
1.1101 raeburn 19252: my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
19253: if ($resurl=~/\.(sequence|page)$/) {
19254: $mapurl=$resurl;
19255: } elsif ($resurl eq 'adm/navmaps') {
19256: $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
19257: }
19258: my $mapresobj;
1.1267 raeburn 19259: unless (ref($$navmapref)) {
19260: $$navmapref = Apache::lonnavmaps::navmap->new();
19261: }
19262: if (ref($$navmapref)) {
19263: $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101 raeburn 19264: }
19265: $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
19266: my $type=$2;
19267: my $path;
19268: if (ref($mapresobj)) {
19269: my $pcslist = $mapresobj->map_hierarchy();
19270: if ($pcslist ne '') {
19271: foreach my $pc (split(/,/,$pcslist)) {
19272: next if ($pc <= 1);
1.1267 raeburn 19273: my $res = $$navmapref->getByMapPc($pc);
1.1101 raeburn 19274: if (ref($res)) {
19275: my $thisurl = $res->src();
19276: $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
19277: my $thistitle = $res->title();
19278: $path .= '&'.
19279: &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146 raeburn 19280: &escape($thistitle).
1.1101 raeburn 19281: ':'.$res->randompick().
19282: ':'.$res->randomout().
19283: ':'.$res->encrypted().
19284: ':'.$res->randomorder().
19285: ':'.$res->is_page();
19286: }
19287: }
19288: }
19289: $path =~ s/^\&//;
19290: my $maptitle = $mapresobj->title();
19291: if ($mapurl eq 'default') {
1.1129 raeburn 19292: $maptitle = 'Main Content';
1.1101 raeburn 19293: }
19294: $path .= (($path ne '')? '&' : '').
19295: &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19296: &escape($maptitle).
1.1101 raeburn 19297: ':'.$mapresobj->randompick().
19298: ':'.$mapresobj->randomout().
19299: ':'.$mapresobj->encrypted().
19300: ':'.$mapresobj->randomorder().
19301: ':'.$mapresobj->is_page();
19302: } else {
19303: my $maptitle = &Apache::lonnet::gettitle($mapurl);
19304: my $ispage = (($type eq 'page')? 1 : '');
19305: if ($mapurl eq 'default') {
1.1129 raeburn 19306: $maptitle = 'Main Content';
1.1101 raeburn 19307: }
19308: $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146 raeburn 19309: &escape($maptitle).':::::'.$ispage;
1.1101 raeburn 19310: }
19311: unless ($mapurl eq 'default') {
19312: $path = 'default&'.
1.1146 raeburn 19313: &escape('Main Content').
1.1101 raeburn 19314: ':::::&'.$path;
19315: }
19316: return $path;
19317: }
19318:
1.1393 raeburn 19319: sub validate_folderpath {
19320: my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
19321: if ($env{'form.folderpath'} ne '') {
19322: my @items = split(/\&/,$env{'form.folderpath'});
1.1394 raeburn 19323: my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393 raeburn 19324: for (my $i=0; $i<@items; $i++) {
19325: my $odd = $i%2;
19326: if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
19327: $badpath = 1;
1.1394 raeburn 19328: } elsif ($odd && $supplementalflag) {
1.1393 raeburn 19329: my $idx = $i-1;
1.1394 raeburn 19330: if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
19331: my $esc_name = $1;
19332: if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
19333: $supppath .= '&'.$esc_name;
19334: $changed = 1;
19335: } else {
19336: $supppath .= '&'.$items[$i];
19337: }
19338: } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
19339: $changed = 1;
1.1393 raeburn 19340: my $is_hidden;
19341: unless ($got_supp) {
1.1395 raeburn 19342: my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393 raeburn 19343: if (ref($supplemental) eq 'HASH') {
19344: if (ref($supplemental->{'hidden'}) eq 'HASH') {
19345: %supphidden = %{$supplemental->{'hidden'}};
19346: }
19347: if (ref($supplemental->{'ids'}) eq 'HASH') {
19348: %suppids = %{$supplemental->{'ids'}};
19349: }
19350: }
19351: $got_supp = 1;
19352: }
19353: if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
19354: my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
19355: if ($supphidden{$mapid}) {
19356: $is_hidden = 1;
19357: }
19358: }
1.1394 raeburn 19359: $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
19360: } else {
19361: $supppath .= '&'.$items[$i];
1.1393 raeburn 19362: }
19363: } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
19364: $badpath = 1;
1.1394 raeburn 19365: } elsif ($supplementalflag) {
1.1393 raeburn 19366: $supppath .= '&'.$items[$i];
19367: }
19368: last if ($badpath);
19369: }
19370: if ($badpath) {
19371: delete($env{'form.folderpath'});
1.1394 raeburn 19372: } elsif ($changed && $supplementalflag) {
1.1393 raeburn 19373: $supppath =~ s/^\&//;
19374: $env{'form.folderpath'} = $supppath;
19375: }
19376: }
19377: return;
19378: }
19379:
1.1094 raeburn 19380: sub captcha_display {
1.1327 raeburn 19381: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19382: my ($output,$error);
1.1234 raeburn 19383: my ($captcha,$pubkey,$privkey,$version) =
1.1327 raeburn 19384: &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19385: if ($captcha eq 'original') {
1.1094 raeburn 19386: $output = &create_captcha();
19387: unless ($output) {
1.1172 raeburn 19388: $error = 'captcha';
1.1094 raeburn 19389: }
19390: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19391: $output = &create_recaptcha($pubkey,$version);
1.1094 raeburn 19392: unless ($output) {
1.1172 raeburn 19393: $error = 'recaptcha';
1.1094 raeburn 19394: }
19395: }
1.1234 raeburn 19396: return ($output,$error,$captcha,$version);
1.1094 raeburn 19397: }
19398:
19399: sub captcha_response {
1.1327 raeburn 19400: my ($context,$lonhost,$defdom) = @_;
1.1094 raeburn 19401: my ($captcha_chk,$captcha_error);
1.1327 raeburn 19402: my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095 raeburn 19403: if ($captcha eq 'original') {
1.1094 raeburn 19404: ($captcha_chk,$captcha_error) = &check_captcha();
19405: } elsif ($captcha eq 'recaptcha') {
1.1234 raeburn 19406: $captcha_chk = &check_recaptcha($privkey,$version);
1.1094 raeburn 19407: } else {
19408: $captcha_chk = 1;
19409: }
19410: return ($captcha_chk,$captcha_error);
19411: }
19412:
19413: sub get_captcha_config {
1.1327 raeburn 19414: my ($context,$lonhost,$dom_in_effect) = @_;
1.1234 raeburn 19415: my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094 raeburn 19416: my $hostname = &Apache::lonnet::hostname($lonhost);
19417: my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
19418: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095 raeburn 19419: if ($context eq 'usercreation') {
19420: my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
19421: if (ref($domconfig{$context}) eq 'HASH') {
19422: $hashtocheck = $domconfig{$context}{'cancreate'};
19423: if (ref($hashtocheck) eq 'HASH') {
19424: if ($hashtocheck->{'captcha'} eq 'recaptcha') {
19425: if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
19426: $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
19427: $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
19428: }
19429: if ($privkey && $pubkey) {
19430: $captcha = 'recaptcha';
1.1234 raeburn 19431: $version = $hashtocheck->{'recaptchaversion'};
19432: if ($version ne '2') {
19433: $version = 1;
19434: }
1.1095 raeburn 19435: } else {
19436: $captcha = 'original';
19437: }
19438: } elsif ($hashtocheck->{'captcha'} ne 'notused') {
19439: $captcha = 'original';
19440: }
1.1094 raeburn 19441: }
1.1095 raeburn 19442: } else {
19443: $captcha = 'captcha';
19444: }
19445: } elsif ($context eq 'login') {
19446: my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
19447: if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
19448: $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
19449: $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094 raeburn 19450: if ($privkey && $pubkey) {
19451: $captcha = 'recaptcha';
1.1234 raeburn 19452: $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
19453: if ($version ne '2') {
19454: $version = 1;
19455: }
1.1095 raeburn 19456: } else {
19457: $captcha = 'original';
1.1094 raeburn 19458: }
1.1095 raeburn 19459: } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
19460: $captcha = 'original';
1.1094 raeburn 19461: }
1.1327 raeburn 19462: } elsif ($context eq 'passwords') {
19463: if ($dom_in_effect) {
19464: my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
19465: if ($passwdconf{'captcha'} eq 'recaptcha') {
19466: if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
19467: $pubkey = $passwdconf{'recaptchakeys'}{'public'};
19468: $privkey = $passwdconf{'recaptchakeys'}{'private'};
19469: }
19470: if ($privkey && $pubkey) {
19471: $captcha = 'recaptcha';
19472: $version = $passwdconf{'recaptchaversion'};
19473: if ($version ne '2') {
19474: $version = 1;
19475: }
19476: } else {
19477: $captcha = 'original';
19478: }
19479: } elsif ($passwdconf{'captcha'} ne 'notused') {
19480: $captcha = 'original';
19481: }
19482: }
19483: }
1.1234 raeburn 19484: return ($captcha,$pubkey,$privkey,$version);
1.1094 raeburn 19485: }
19486:
19487: sub create_captcha {
19488: my %captcha_params = &captcha_settings();
19489: my ($output,$maxtries,$tries) = ('',10,0);
19490: while ($tries < $maxtries) {
19491: $tries ++;
19492: my $captcha = Authen::Captcha->new (
19493: output_folder => $captcha_params{'output_dir'},
19494: data_folder => $captcha_params{'db_dir'},
19495: );
19496: my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
19497:
19498: if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
19499: $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367 raeburn 19500: '<span class="LC_nobreak">'.
1.1094 raeburn 19501: &mt('Type in the letters/numbers shown below').' '.
1.1390 raeburn 19502: '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367 raeburn 19503: '</span><br />'.
1.1176 raeburn 19504: '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094 raeburn 19505: last;
19506: }
19507: }
1.1323 raeburn 19508: if ($output eq '') {
19509: &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
19510: }
1.1094 raeburn 19511: return $output;
19512: }
19513:
19514: sub captcha_settings {
19515: my %captcha_params = (
19516: output_dir => $Apache::lonnet::perlvar{'lonCaptchaDir'},
19517: www_output_dir => "/captchaspool",
19518: db_dir => $Apache::lonnet::perlvar{'lonCaptchaDb'},
19519: numchars => '5',
19520: );
19521: return %captcha_params;
19522: }
19523:
19524: sub check_captcha {
19525: my ($captcha_chk,$captcha_error);
19526: my $code = $env{'form.code'};
19527: my $md5sum = $env{'form.crypt'};
19528: my %captcha_params = &captcha_settings();
19529: my $captcha = Authen::Captcha->new(
19530: output_folder => $captcha_params{'output_dir'},
19531: data_folder => $captcha_params{'db_dir'},
19532: );
1.1109 raeburn 19533: $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094 raeburn 19534: my %captcha_hash = (
19535: 0 => 'Code not checked (file error)',
19536: -1 => 'Failed: code expired',
19537: -2 => 'Failed: invalid code (not in database)',
19538: -3 => 'Failed: invalid code (code does not match crypt)',
19539: );
19540: if ($captcha_chk != 1) {
19541: $captcha_error = $captcha_hash{$captcha_chk}
19542: }
19543: return ($captcha_chk,$captcha_error);
19544: }
19545:
19546: sub create_recaptcha {
1.1234 raeburn 19547: my ($pubkey,$version) = @_;
19548: if ($version >= 2) {
1.1367 raeburn 19549: return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
19550: '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234 raeburn 19551: } else {
19552: my $use_ssl;
19553: if ($ENV{'SERVER_PORT'} == 443) {
19554: $use_ssl = 1;
19555: }
19556: my $captcha = Captcha::reCAPTCHA->new;
19557: return $captcha->get_options_setter({theme => 'white'})."\n".
19558: $captcha->get_html($pubkey,undef,$use_ssl).
19559: &mt('If the text is hard to read, [_1] will replace them.',
19560: '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
19561: '<br /><br />';
19562: }
1.1094 raeburn 19563: }
19564:
19565: sub check_recaptcha {
1.1234 raeburn 19566: my ($privkey,$version) = @_;
1.1094 raeburn 19567: my $captcha_chk;
1.1350 raeburn 19568: my $ip = &Apache::lonnet::get_requestor_ip();
1.1234 raeburn 19569: if ($version >= 2) {
19570: my %info = (
19571: secret => $privkey,
19572: response => $env{'form.g-recaptcha-response'},
1.1350 raeburn 19573: remoteip => $ip,
1.1234 raeburn 19574: );
1.1280 raeburn 19575: my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
19576: $request->content(join('&',map {
19577: my $name = escape($_);
19578: "$name=" . ( ref($info{$_}) eq 'ARRAY'
19579: ? join("&$name=", map {escape($_) } @{$info{$_}})
19580: : &escape($info{$_}) );
19581: } keys(%info)));
19582: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234 raeburn 19583: if ($response->is_success) {
19584: my $data = JSON::DWIW->from_json($response->decoded_content);
19585: if (ref($data) eq 'HASH') {
19586: if ($data->{'success'}) {
19587: $captcha_chk = 1;
19588: }
19589: }
19590: }
19591: } else {
19592: my $captcha = Captcha::reCAPTCHA->new;
19593: my $captcha_result =
19594: $captcha->check_answer(
19595: $privkey,
1.1350 raeburn 19596: $ip,
1.1234 raeburn 19597: $env{'form.recaptcha_challenge_field'},
19598: $env{'form.recaptcha_response_field'},
19599: );
19600: if ($captcha_result->{is_valid}) {
19601: $captcha_chk = 1;
19602: }
1.1094 raeburn 19603: }
19604: return $captcha_chk;
19605: }
19606:
1.1174 raeburn 19607: sub emailusername_info {
1.1244 raeburn 19608: my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174 raeburn 19609: my %titles = &Apache::lonlocal::texthash (
19610: lastname => 'Last Name',
19611: firstname => 'First Name',
19612: institution => 'School/college/university',
19613: location => "School's city, state/province, country",
19614: web => "School's web address",
19615: officialemail => 'E-mail address at institution (if different)',
1.1244 raeburn 19616: id => 'Student/Employee ID',
1.1174 raeburn 19617: );
19618: return (\@fields,\%titles);
19619: }
19620:
1.1161 raeburn 19621: sub cleanup_html {
19622: my ($incoming) = @_;
19623: my $outgoing;
19624: if ($incoming ne '') {
19625: $outgoing = $incoming;
19626: $outgoing =~ s/;/;/g;
19627: $outgoing =~ s/\#/#/g;
19628: $outgoing =~ s/\&/&/g;
19629: $outgoing =~ s/</</g;
19630: $outgoing =~ s/>/>/g;
19631: $outgoing =~ s/\(/(/g;
19632: $outgoing =~ s/\)/)/g;
19633: $outgoing =~ s/"/"/g;
19634: $outgoing =~ s/'/'/g;
19635: $outgoing =~ s/\$/$/g;
19636: $outgoing =~ s{/}{/}g;
19637: $outgoing =~ s/=/=/g;
19638: $outgoing =~ s/\\/\/g
19639: }
19640: return $outgoing;
19641: }
19642:
1.1190 musolffc 19643: # Checks for critical messages and returns a redirect url if one exists.
19644: # $interval indicates how often to check for messages.
1.1282 raeburn 19645: # $context is the calling context -- roles, grades, contents, menu or flip.
1.1190 musolffc 19646: sub critical_redirect {
1.1282 raeburn 19647: my ($interval,$context) = @_;
1.1356 raeburn 19648: unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
19649: return ();
19650: }
1.1190 musolffc 19651: if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282 raeburn 19652: if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
19653: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
19654: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372 raeburn 19655: my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282 raeburn 19656: if ($blocked) {
19657: my $checkrole = "cm./$cdom/$cnum";
19658: if ($env{'request.course.sec'} ne '') {
19659: $checkrole .= "/$env{'request.course.sec'}";
19660: }
19661: unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
19662: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
19663: return;
19664: }
19665: }
19666: }
1.1190 musolffc 19667: my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
19668: $env{'user.name'});
19669: &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191 raeburn 19670: my $redirecturl;
1.1190 musolffc 19671: if ($what[0]) {
1.1356 raeburn 19672: if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190 musolffc 19673: $redirecturl='/adm/email?critical=display';
1.1191 raeburn 19674: my $url=&Apache::lonnet::absolute_url().$redirecturl;
19675: return (1, $url);
1.1190 musolffc 19676: }
1.1191 raeburn 19677: }
19678: }
19679: return ();
1.1190 musolffc 19680: }
19681:
1.1174 raeburn 19682: # Use:
19683: # my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
19684: #
19685: ##################################################
19686: # password associated functions #
19687: ##################################################
19688: sub des_keys {
19689: # Make a new key for DES encryption.
19690: # Each key has two parts which are returned separately.
19691: # Please note: Each key must be passed through the &hex function
19692: # before it is output to the web browser. The hex versions cannot
19693: # be used to decrypt.
19694: my @hexstr=('0','1','2','3','4','5','6','7',
19695: '8','9','a','b','c','d','e','f');
19696: my $lkey='';
19697: for (0..7) {
19698: $lkey.=$hexstr[rand(15)];
19699: }
19700: my $ukey='';
19701: for (0..7) {
19702: $ukey.=$hexstr[rand(15)];
19703: }
19704: return ($lkey,$ukey);
19705: }
19706:
19707: sub des_decrypt {
19708: my ($key,$cyphertext) = @_;
19709: my $keybin=pack("H16",$key);
19710: my $cypher;
19711: if ($Crypt::DES::VERSION>=2.03) {
19712: $cypher=new Crypt::DES $keybin;
19713: } else {
19714: $cypher=new DES $keybin;
19715: }
1.1233 raeburn 19716: my $plaintext='';
19717: my $cypherlength = length($cyphertext);
19718: my $numchunks = int($cypherlength/32);
19719: for (my $j=0; $j<$numchunks; $j++) {
19720: my $start = $j*32;
19721: my $cypherblock = substr($cyphertext,$start,32);
19722: my $chunk =
19723: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
19724: $chunk .=
19725: $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
19726: $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
19727: $plaintext .= $chunk;
19728: }
1.1174 raeburn 19729: return $plaintext;
19730: }
19731:
1.1344 raeburn 19732: sub get_requested_shorturls {
1.1309 raeburn 19733: my ($cdom,$cnum,$navmap) = @_;
19734: return unless (ref($navmap));
1.1344 raeburn 19735: my ($numnew,$errors);
1.1309 raeburn 19736: my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
19737: if (@toshorten) {
19738: my (%maps,%resources,%titles);
19739: &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
19740: 'shorturls',$cdom,$cnum);
19741: if (keys(%resources)) {
1.1344 raeburn 19742: my %tocreate;
1.1309 raeburn 19743: foreach my $item (sort {$a <=> $b} (@toshorten)) {
19744: my $symb = $resources{$item};
19745: if ($symb) {
19746: $tocreate{$cnum.'&'.$symb} = 1;
19747: }
19748: }
1.1344 raeburn 19749: if (keys(%tocreate)) {
19750: ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
19751: \%tocreate);
19752: }
1.1309 raeburn 19753: }
1.1344 raeburn 19754: }
19755: return ($numnew,$errors);
19756: }
19757:
19758: sub make_short_symbs {
19759: my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
19760: my ($numnew,@errors);
19761: if (ref($tocreateref) eq 'HASH') {
19762: my %tocreate = %{$tocreateref};
1.1309 raeburn 19763: if (keys(%tocreate)) {
19764: my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
19765: my $su = Short::URL->new(no_vowels => 1);
19766: my $init = '';
19767: my (%newunique,%addcourse,%courseonly,%failed);
19768: # get lock on tiny db
19769: my $now = time;
1.1344 raeburn 19770: if ($lockuser eq '') {
19771: $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
19772: }
1.1309 raeburn 19773: my $lockhash = {
1.1344 raeburn 19774: "lock\0$now" => $lockuser,
1.1309 raeburn 19775: };
19776: my $tries = 0;
19777: my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
19778: my ($code,$error);
19779: while (($gotlock ne 'ok') && ($tries<3)) {
19780: $tries ++;
19781: sleep 1;
1.1319 raeburn 19782: $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309 raeburn 19783: }
19784: if ($gotlock eq 'ok') {
19785: $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
19786: \%addcourse,\%courseonly,\%failed);
19787: if (keys(%failed)) {
19788: my $numfailed = scalar(keys(%failed));
19789: push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
19790: }
19791: if (keys(%newunique)) {
19792: my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
19793: if ($putres eq 'ok') {
19794: $numnew = scalar(keys(%newunique));
19795: my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
19796: unless ($newputres eq 'ok') {
19797: push(@errors,&mt('error: could not store course look-up of short URLs'));
19798: }
19799: } else {
19800: push(@errors,&mt('error: could not store unique six character URLs'));
19801: }
19802: }
19803: my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
19804: unless ($dellockres eq 'ok') {
19805: push(@errors,&mt('error: could not release lockfile'));
19806: }
19807: } else {
19808: push(@errors,&mt('error: could not obtain lockfile'));
19809: }
19810: if (keys(%courseonly)) {
19811: my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
19812: if ($result ne 'ok') {
19813: push(@errors,&mt('error: could not update course look-up of short URLs'));
19814: }
19815: }
19816: }
19817: }
19818: return ($numnew,\@errors);
19819: }
19820:
19821: sub shorten_symbs {
19822: my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
19823: return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
19824: (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
19825: (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
19826: my (%possibles,%collisions);
19827: foreach my $key (keys(%{$tocreate})) {
19828: my $num = String::CRC32::crc32($key);
19829: my $tiny = $su->encode($num,$init);
19830: if ($tiny) {
19831: $possibles{$tiny} = $key;
19832: }
19833: }
19834: if (!$init) {
19835: $init = 1;
19836: } else {
19837: $init ++;
19838: }
19839: if (keys(%possibles)) {
19840: my @posstiny = keys(%possibles);
19841: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
19842: my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
19843: if (keys(%currtiny)) {
19844: foreach my $key (keys(%currtiny)) {
19845: next if ($currtiny{$key} eq '');
19846: if ($currtiny{$key} eq $possibles{$key}) {
19847: my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
19848: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19849: $courseonly->{$tsymb} = $key;
19850: }
19851: } else {
19852: $collisions{$possibles{$key}} = 1;
19853: }
19854: delete($possibles{$key});
19855: }
19856: }
19857: foreach my $key (keys(%possibles)) {
19858: $newunique->{$key} = $possibles{$key};
19859: my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
19860: unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
19861: $addcourse->{$tsymb} = $key;
19862: }
19863: }
19864: }
19865: if (keys(%collisions)) {
19866: if ($init <5) {
19867: if (!$init) {
19868: $init = 1;
19869: } else {
19870: $init ++;
19871: }
19872: $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
19873: $newunique,$addcourse,$courseonly,$failed);
19874: } else {
19875: foreach my $key (keys(%collisions)) {
19876: $failed->{$key} = 1;
19877: }
19878: }
19879: }
19880: return $init;
19881: }
19882:
1.1328 raeburn 19883: sub is_nonframeable {
1.1329 raeburn 19884: my ($url,$absolute,$hostname,$ip,$nocache) = @_;
19885: my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330 raeburn 19886: return if (($remprotocol eq '') || ($remhost eq ''));
1.1329 raeburn 19887:
19888: $remprotocol = lc($remprotocol);
19889: $remhost = lc($remhost);
19890: my $remport = 80;
19891: if ($remprotocol eq 'https') {
19892: $remport = 443;
19893: }
1.1330 raeburn 19894: my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329 raeburn 19895: if ($cached) {
19896: unless ($nocache) {
19897: if ($result) {
19898: return 1;
19899: } else {
19900: return 0;
19901: }
19902: }
19903: }
1.1328 raeburn 19904: my $uselink;
19905: my $request = new HTTP::Request('HEAD',$url);
19906: my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
19907: if ($response->is_success()) {
19908: my $secpolicy = lc($response->header('content-security-policy'));
19909: my $xframeop = lc($response->header('x-frame-options'));
19910: $secpolicy =~ s/^\s+|\s+$//g;
19911: $xframeop =~ s/^\s+|\s+$//g;
19912: if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329 raeburn 19913: my $remotehost = $remprotocol.'://'.$remhost;
1.1328 raeburn 19914: my ($origin,$protocol,$port);
19915: if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
19916: $port = $ENV{'SERVER_PORT'};
19917: } else {
19918: $port = 80;
19919: }
19920: if ($absolute eq '') {
19921: $protocol = 'http:';
19922: if ($port == 443) {
19923: $protocol = 'https:';
19924: }
19925: $origin = $protocol.'//'.lc($hostname);
19926: } else {
19927: $origin = lc($absolute);
19928: ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
19929: }
19930: if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
19931: my $framepolicy = $1;
19932: $framepolicy =~ s/^\s+|\s+$//g;
19933: my @policies = split(/\s+/,$framepolicy);
19934: if (@policies) {
19935: if (grep(/^\Q'none'\E$/,@policies)) {
19936: $uselink = 1;
19937: } else {
19938: $uselink = 1;
19939: if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
19940: (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
19941: (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
19942: undef($uselink);
19943: }
19944: if ($uselink) {
19945: if (grep(/^\Q'self'\E$/,@policies)) {
19946: if (($origin ne '') && ($remotehost eq $origin)) {
19947: undef($uselink);
19948: }
19949: }
19950: }
19951: if ($uselink) {
19952: my @possok;
19953: if ($ip ne '') {
19954: push(@possok,$ip);
19955: }
19956: my $hoststr = '';
19957: foreach my $part (reverse(split(/\./,$hostname))) {
19958: if ($hoststr eq '') {
19959: $hoststr = $part;
19960: } else {
19961: $hoststr = "$part.$hoststr";
19962: }
19963: if ($hoststr eq $hostname) {
19964: push(@possok,$hostname);
19965: } else {
19966: push(@possok,"*.$hoststr");
19967: }
19968: }
19969: if (@possok) {
19970: foreach my $poss (@possok) {
19971: last if (!$uselink);
19972: foreach my $policy (@policies) {
19973: if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
19974: undef($uselink);
19975: last;
19976: }
19977: }
19978: }
19979: }
19980: }
19981: }
19982: }
19983: } elsif ($xframeop ne '') {
19984: $uselink = 1;
19985: my @policies = split(/\s*,\s*/,$xframeop);
19986: if (@policies) {
19987: unless (grep(/^deny$/,@policies)) {
19988: if ($origin ne '') {
19989: if (grep(/^sameorigin$/,@policies)) {
19990: if ($remotehost eq $origin) {
19991: undef($uselink);
19992: }
19993: }
19994: if ($uselink) {
19995: foreach my $policy (@policies) {
19996: if ($policy =~ /^allow-from\s*(.+)$/) {
19997: my $allowfrom = $1;
19998: if (($allowfrom ne '') && ($allowfrom eq $origin)) {
19999: undef($uselink);
20000: last;
20001: }
20002: }
20003: }
20004: }
20005: }
20006: }
20007: }
20008: }
20009: }
20010: }
1.1329 raeburn 20011: if ($nocache) {
20012: if ($cached) {
20013: my $devalidate;
20014: if ($uselink && !$result) {
20015: $devalidate = 1;
20016: } elsif (!$uselink && $result) {
20017: $devalidate = 1;
20018: }
20019: if ($devalidate) {
20020: &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
20021: }
20022: }
20023: } else {
20024: if ($uselink) {
20025: $result = 1;
20026: } else {
20027: $result = 0;
20028: }
20029: &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
20030: }
1.1328 raeburn 20031: return $uselink;
20032: }
20033:
1.1359 raeburn 20034: sub page_menu {
20035: my ($menucolls,$menunum) = @_;
20036: my %menu;
20037: foreach my $item (split(/;/,$menucolls)) {
20038: my ($num,$value) = split(/\%/,$item);
20039: if ($num eq $menunum) {
20040: my @entries = split(/\&/,$value);
20041: foreach my $entry (@entries) {
20042: my ($name,$fields) = split(/=/,$entry);
1.1368 raeburn 20043: if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359 raeburn 20044: $menu{$name} = $fields;
20045: } else {
20046: my @shown;
20047: if ($fields =~ /,/) {
20048: @shown = split(/,/,$fields);
20049: } else {
20050: @shown = ($fields);
20051: }
20052: if (@shown) {
20053: foreach my $field (@shown) {
20054: next if ($field eq '');
20055: $menu{$field} = 1;
20056: }
20057: }
20058: }
20059: }
20060: }
20061: }
20062: return %menu;
20063: }
20064:
1.112 bowersj2 20065: 1;
20066: __END__;
1.41 ng 20067:
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